source/builder.cpp

   1 #include <set>
   2 #include <msp/core/getopt.h>
   3 #include <msp/datafile/parser.h>
   4 #include <msp/fs/dir.h>
   5 #include <msp/fs/stat.h>
   6 #include <msp/fs/utils.h>
   7 #include <msp/io/buffered.h>
   8 #include <msp/io/file.h>
   9 #include <msp/io/print.h>
  10 #include <msp/strings/format.h>
  11 #include <msp/strings/regex.h>
  12 #include <msp/strings/utils.h>
  13 #include <msp/time/units.h>
  14 #include <msp/time/utils.h>
  15 #include "analyzer.h"
  16 #include "binarypackage.h"
  17 #include "builder.h"
  18 #include "copy.h"
  19 #include "gnuarchiver.h"
  20 #include "gnuccompiler.h"
  21 #include "gnucxxcompiler.h"
  22 #include "gnulinker.h"
  23 #include "installedfile.h"
  24 #include "package.h"
  25 #include "pkgconfiggenerator.h"
  26 #include "sharedlibrary.h"
  27 #include "sourcepackage.h"
  28 #include "tar.h"
  29 #include "task.h"
  30 #include "virtualtarget.h"
  31
  32 using namespace std;
  33 using namespace Msp;
  34
  35 Builder::Builder(int argc, char **argv):
  36         package_manager(*this),
  37         main_pkg(0),
  38         native_arch(*this, string()),
  39         build_type(0),
  40         vfs(*this),
  41         analyzer(0),
  42         build(false),
  43         clean(0),
  44         dry_run(false),
  45         help(false),
  46         show_progress(false),
  47         build_file("Build"),
  48         jobs(1),
  49         conf_all(false),
  50         conf_only(false),
  51         build_all(false),
  52         create_makefile(false),
  53         tempdir("temp")
  54 {
  55         string analyze_mode;
  56         string work_dir;
  57         bool full_paths = false;
  58         unsigned max_depth = 4;
  59         StringList cmdline_warn;
  60         string prfx;
  61         string temp_str;
  62         string arch;
  63         bool no_externals = false;
  64         unsigned verbose = 1;
  65         bool silent = false;
  66         list<string> log_channels;
  67         string build_type_name;
  68
  69         GetOpt getopt;
  70         getopt.add_option('a', "analyze",    analyze_mode,  GetOpt::REQUIRED_ARG).set_help("Perform dependency analysis.", "MODE");
  71         getopt.add_option('b', "build",      build,         GetOpt::NO_ARG).set_help("Perform build even if also doing something else.");
  72         getopt.add_option('c', "clean",      clean,         GetOpt::NO_ARG).set_help("Clean buildable targets.");
  73         getopt.add_option('f', "file",       build_file,    GetOpt::REQUIRED_ARG).set_help("Read build instructions from FILE.", "FILE");
  74         getopt.add_option('h', "help",       help,          GetOpt::NO_ARG).set_help("Print this message.");
  75         getopt.add_option('j', "jobs",       jobs,          GetOpt::REQUIRED_ARG).set_help("Run up to NUM tasks in parallel.", "NUM");
  76         getopt.add_option('l', "log",        log_channels,  GetOpt::REQUIRED_ARG).set_help("Enable listed log channels.", "LIST");
  77         getopt.add_option('n', "dry-run",    dry_run,       GetOpt::NO_ARG).set_help("Show what would be done without actually doing it.");
  78         getopt.add_option('s', "silent",     silent,        GetOpt::NO_ARG).set_help("Don't print any messages other than errors.");
  79         getopt.add_option('t', "build-type", build_type_name, GetOpt::REQUIRED_ARG).set_help("Set build type.", "TYPE");
  80         getopt.add_option('v', "verbose",    verbose,       GetOpt::NO_ARG).set_help("Print more information about what's going on.");
  81         getopt.add_option('x', "no-externals",  no_externals, GetOpt::NO_ARG).set_help("Do not load external source packages.");
  82         getopt.add_option('A', "conf-all",   conf_all,      GetOpt::NO_ARG).set_help("Apply configuration to all packages.");
  83         getopt.add_option('B', "build-all",  build_all,     GetOpt::NO_ARG).set_help("Build all targets unconditionally.");
  84         getopt.add_option('C', "chdir",      work_dir,      GetOpt::REQUIRED_ARG).set_help("Change to DIR before doing anything else.", "DIR");
  85         getopt.add_option('P', "progress",   show_progress, GetOpt::NO_ARG).set_help("Display progress while building.");
  86         getopt.add_option('W', "what-if",    what_if,       GetOpt::REQUIRED_ARG).set_help("Pretend that FILE has changed.", "FILE");
  87         getopt.add_option(     "arch",       arch,          GetOpt::REQUIRED_ARG).set_help("Build for architecture ARCH.", "ARCH");
  88         getopt.add_option(     "conf-only",  conf_only,     GetOpt::NO_ARG).set_help("Stop after configuring packages.");
  89         getopt.add_option(     "full-paths", full_paths,    GetOpt::NO_ARG).set_help("Output full paths in analysis.");
  90         getopt.add_option(     "max-depth",  max_depth,     GetOpt::REQUIRED_ARG).set_help("Show up to NUM levels in analysis.", "NUM");
  91         getopt.add_option(     "prefix",     prfx,          GetOpt::REQUIRED_ARG).set_help("Install things to DIR.", "DIR");
  92         getopt.add_option(     "tempdir",    temp_str,      GetOpt::REQUIRED_ARG).set_help("Store temporary files in DIR.", "DIR");
  93         usagemsg = getopt.generate_usage(argv[0])+" [<target> ...]";
  94         helpmsg = getopt.generate_help();
  95         getopt(argc, argv);
  96
  97         if(silent)
  98                 --verbose;
  99         if(verbose>=1)
 100         {
 101                 logger.enable_channel("summary");
 102                 logger.enable_channel("tasks");
 103         }
 104         if(verbose>=2)
 105         {
 106                 logger.enable_channel("environment");
 107                 logger.enable_channel("packages");
 108                 logger.enable_channel("commands");
 109         }
 110         if(verbose>=3)
 111         {
 112                 logger.enable_channel("files");
 113                 logger.enable_channel("auxcommands");
 114         }
 115         for(list<string>::const_iterator i=log_channels.begin(); i!=log_channels.end(); ++i)
 116         {
 117                 vector<string> parts = split(*i, ',');
 118                 for(vector<string>::const_iterator j=parts.begin(); j!=parts.end(); ++j)
 119                         logger.enable_channel(*j);
 120         }
 121
 122         if(!analyze_mode.empty())
 123         {
 124                 analyzer = new Analyzer(*this);
 125
 126                 if(analyze_mode=="deps")
 127                         analyzer->set_mode(Analyzer::DEPS);
 128                 else if(analyze_mode=="alldeps")
 129                         analyzer->set_mode(Analyzer::ALLDEPS);
 130                 else if(analyze_mode=="rebuild")
 131                         analyzer->set_mode(Analyzer::REBUILD);
 132                 else if(analyze_mode=="rdeps")
 133                         analyzer->set_mode(Analyzer::RDEPS);
 134                 else
 135                         throw usage_error("Invalid analyze mode");
 136
 137                 analyzer->set_max_depth(max_depth);
 138                 analyzer->set_full_paths(full_paths);
 139         }
 140         else if(!clean && !create_makefile)
 141                 build = true;
 142
 143         const vector<string> &args = getopt.get_args();
 144         for(vector<string>::const_iterator i=args.begin(); i!=args.end(); ++i)
 145         {
 146                 string::size_type equal = i->find('=');
 147                 if(equal!=string::npos)
 148                         cmdline_options.insert(StringMap::value_type(i->substr(0, equal), i->substr(equal+1)));
 149                 else
 150                         cmdline_targets.push_back(*i);
 151         }
 152
 153         if(cmdline_targets.empty())
 154                 cmdline_targets.push_back("default");
 155
 156         if(!work_dir.empty())
 157                 FS::chdir(work_dir);
 158
 159         cwd = FS::getcwd();
 160
 161         package_manager.append_package_path(cwd);
 162         package_manager.append_package_path(cwd/"..");
 163         package_manager.append_binary_package_path(FS::get_sys_data_dir(argv[0], "builder"));
 164
 165         package_manager.set_no_externals(no_externals);
 166
 167         if(arch.empty())
 168                 current_arch = &native_arch;
 169         else
 170                 current_arch = new Architecture(*this, arch);
 171
 172         list<FS::Path> start_files;
 173         start_files.push_back(FS::get_sys_data_dir(argv[0], "builder")/"builderrc");
 174         start_files.push_back(FS::get_user_data_dir("builder")/"rc");
 175         for(list<FS::Path>::const_iterator i=start_files.begin(); i!=start_files.end(); ++i)
 176                 if(FS::exists(*i))
 177                         load_build_file(*i);
 178
 179         if(prfx.empty())
 180         {
 181                 if(current_arch->is_native())
 182                         prefix = (FS::get_home_dir()/"local").str();
 183                 else
 184                         prefix = (FS::get_home_dir()/"local"/current_arch->get_name()).str();
 185         }
 186         else
 187                 prefix = cwd/prfx;
 188
 189         if(!temp_str.empty())
 190                 tempdir = temp_str;
 191
 192         if(!build_type_name.empty())
 193         {
 194                 BuildTypeMap::iterator i = build_types.find(build_type_name);
 195                 if(i==build_types.end())
 196                         throw usage_error("Unknown build type");
 197                 build_type = &i->second;
 198         }
 199
 200         toolchain.add_tool(new GnuCCompiler(*this, *current_arch));
 201         toolchain.add_tool(new GnuCxxCompiler(*this, *current_arch));
 202         toolchain.add_tool(new GnuLinker(*this, *current_arch));
 203         toolchain.add_tool(new GnuArchiver(*this, *current_arch));
 204         toolchain.add_tool(new Copy(*this));
 205         toolchain.add_tool(new Tar(*this));
 206         toolchain.add_tool(new PkgConfigGenerator(*this));
 207 }
 208
 209 Builder::~Builder()
 210 {
 211         for(TargetMap::iterator i=targets.begin(); i!=targets.end(); ++i)
 212                 delete i->second;
 213         delete analyzer;
 214 }
 215
 216 int Builder::main()
 217 {
 218         FS::Path main_file = cwd/build_file;
 219         if(!FS::exists(main_file))
 220         {
 221                 if(help)
 222                 {
 223                         usage(0, "builder", false);
 224                         return 0;
 225                 }
 226                 else
 227                 {
 228                         IO::print(IO::cerr, "The file %s does not exist.\n", main_file);
 229                         return 1;
 230                 }
 231         }
 232
 233         load_build_file(main_file);
 234
 235         if(help)
 236         {
 237                 usage(0, "builder", false);
 238                 IO::print("\n");
 239                 package_help();
 240                 return 0;
 241         }
 242
 243         if(!prepare_build())
 244                 return 1;
 245
 246         if(conf_only)
 247                 return 0;
 248
 249         logger.log("environment", format("Building on %s, for %s%s", native_arch.get_name(),
 250                 current_arch->get_name(), (current_arch->is_native() ? " (native)" : "")));
 251         logger.log("environment", format("Prefix is %s", prefix));
 252         if(tempdir.is_absolute())
 253                 logger.log("environment", format("Temporary directory is %s", tempdir));
 254         else
 255                 logger.log("environment", format("Using per-package temporary directory %s", tempdir));
 256         if(build_type)
 257                 logger.log("environment", format("Build type is %s", build_type->get_name()));
 258
 259         const PackageManager::PackageMap &packages = package_manager.get_packages();
 260         list<string> package_details;
 261         for(PackageManager::PackageMap::const_iterator i=packages.begin(); i!=packages.end(); ++i)
 262         {
 263                 if(!i->second || !i->second->is_prepared())
 264                         continue;
 265
 266                 string line = i->second->get_name();
 267                 if(dynamic_cast<SourcePackage *>(i->second))
 268                 {
 269                         line += '*';
 270
 271                         unsigned count = 0;
 272                         unsigned to_be_built = 0;
 273                         for(TargetMap::iterator j=targets.begin(); j!=targets.end(); ++j)
 274                                 if(j->second->get_package()==i->second)
 275                                 {
 276                                         ++count;
 277                                         if(j->second->needs_rebuild())
 278                                                 ++to_be_built;
 279                                 }
 280                         if(count)
 281                         {
 282                                 line += format(" (%d targets", count);
 283                                 if(to_be_built)
 284                                         line += format(", %d to be built", to_be_built);
 285                                 line += ')';
 286                         }
 287                 }
 288
 289                 package_details.push_back(line);
 290         }
 291
 292         logger.log("summary", format("%d active packages, %d targets", package_details.size(), targets.size()));
 293         for(list<string>::const_iterator i=package_details.begin(); i!=package_details.end(); ++i)
 294                 logger.log("packages", *i);
 295
 296         if(analyzer)
 297                 analyzer->analyze();
 298
 299         if(!problems.empty())
 300         {
 301                 IO::print(IO::cerr, "The following problems were detected:\n");
 302                 for(ProblemList::iterator i=problems.begin(); i!=problems.end(); ++i)
 303                         IO::print(IO::cerr, "  %s: %s\n", i->package, i->descr);
 304                 if(!analyzer)
 305                         IO::print(IO::cerr, "Please fix them and try again.\n");
 306                 return 1;
 307         }
 308
 309         if(clean)
 310                 exit_code = do_clean();
 311         if(build)
 312                 exit_code = do_build();
 313
 314         return exit_code;
 315 }
 316
 317 Target *Builder::get_target(const string &n) const
 318 {
 319         TargetMap::const_iterator i = targets.find(n);
 320         if(i!=targets.end())
 321                 return i->second;
 322         return 0;
 323 }
 324
 325 void Builder::problem(const string &p, const string &d)
 326 {
 327         problems.push_back(Problem(p, d));
 328 }
 329
 330 void Builder::add_target(Target *t)
 331 {
 332         targets.insert(TargetMap::value_type(t->get_name(), t));
 333 }
 334
 335 void Builder::add_primary_target(Target &t)
 336 {
 337         get_target("world")->add_dependency(t);
 338
 339         if(t.get_package()==main_pkg && t.get_component() && t.get_component()->is_default())
 340                 get_target("default")->add_dependency(t);
 341 }
 342
 343 void Builder::usage(const char *reason, const char *argv0, bool brief)
 344 {
 345         if(reason)
 346                 IO::print(IO::cerr, "%s\n", reason);
 347
 348         if(brief)
 349                 IO::print(IO::cerr, "Usage: %s\n", usagemsg);
 350         else
 351         {
 352                 IO::print(IO::cerr, "Builder 1.0\n\n");
 353                 IO::print(IO::cerr, "Usage: %s [options] [<target> ...]\n\n", argv0);
 354                 IO::print(IO::cerr, "Options:\n");
 355                 IO::print(IO::cerr, helpmsg);
 356         }
 357 }
 358
 359 void Builder::load_build_file(const FS::Path &fn)
 360 {
 361         IO::BufferedFile in(fn.str());
 362
 363         logger.log("files", format("Reading %s", fn));
 364
 365         DataFile::Parser parser(in, fn.str());
 366         Loader loader(*this);
 367         loader.load(parser);
 368 }
 369
 370 bool Builder::prepare_build()
 371 {
 372         Target *world = new VirtualTarget(*this, "world");
 373
 374         Target *def_tgt = new VirtualTarget(*this, "default");
 375         world->add_dependency(*def_tgt);
 376
 377         Target *install = new VirtualTarget(*this, "install");
 378         world->add_dependency(*install);
 379
 380         Target *tarballs = new VirtualTarget(*this, "tarballs");
 381         world->add_dependency(*tarballs);
 382
 383         main_pkg->prepare();
 384
 385         // Make the cmdline target depend on all targets mentioned on the command line
 386         Target *cmdline = new VirtualTarget(*this, "cmdline");
 387         for(list<string>::iterator i=cmdline_targets.begin(); i!=cmdline_targets.end(); ++i)
 388         {
 389                 Target *tgt = get_target(*i);
 390                 if(!tgt)
 391                         tgt = vfs.get_target(*i);
 392                 if(!tgt)
 393                         tgt = vfs.get_target(cwd/ *i);
 394                 if(!tgt)
 395                 {
 396                         IO::print("I don't know anything about %s\n", *i);
 397                         return false;
 398                 }
 399
 400                 cmdline->add_dependency(*tgt);
 401         }
 402
 403         cmdline->prepare();
 404
 405         // Apply what-ifs
 406         for(StringList::iterator i=what_if.begin(); i!=what_if.end(); ++i)
 407         {
 408                 FileTarget *tgt = vfs.get_target(cwd/ *i);
 409                 if(!tgt)
 410                 {
 411                         IO::print(IO::cerr, "Unknown what-if target %s\n", *i);
 412                         return false;
 413                 }
 414                 tgt->touch();
 415         }
 416
 417         if(build_all)
 418         {
 419                 for(TargetMap::iterator i=targets.begin(); i!=targets.end(); ++i)
 420                         if(i->second->is_buildable() && !i->second->needs_rebuild())
 421                                 i->second->force_rebuild();
 422         }
 423
 424         if(!dry_run)
 425         {
 426                 const PackageManager::PackageMap &packages = package_manager.get_packages();
 427                 for(PackageManager::PackageMap::const_iterator i=packages.begin(); i!=packages.end(); ++i)
 428                         i->second->save_caches();
 429         }
 430
 431         return true;
 432 }
 433
 434 int Builder::do_build()
 435 {
 436         Target *cmdline = get_target("cmdline");
 437
 438         unsigned total = 0;
 439         for(map<string, Target *>::const_iterator i=targets.begin(); i!=targets.end(); ++i)
 440                 if(i->second->is_buildable() && i->second->needs_rebuild())
 441                         ++total;
 442
 443         if(!total)
 444         {
 445                 logger.log("summary", "Already up to date");
 446                 return 0;
 447         }
 448         logger.log("summary", format("Will build %d target%s", total, (total!=1 ? "s" : "")));
 449
 450         vector<Task *> tasks;
 451
 452         unsigned count = 0;
 453
 454         bool fail = false;
 455         bool finish = false;
 456         bool starved = false;
 457
 458         while(!finish)
 459         {
 460                 if(tasks.size()<jobs && !fail && !starved)
 461                 {
 462                         Target *tgt = cmdline->get_buildable_target();
 463                         if(tgt)
 464                         {
 465                                 if(tgt->get_tool())
 466                                         logger.log("tasks", format("%-4s  %s", tgt->get_tool()->get_tag(), tgt->get_name()));
 467                                 Task *task = tgt->build();
 468                                 if(task)
 469                                 {
 470                                         logger.log("commands", format("%s", task->get_command()));
 471                                         if(dry_run)
 472                                         {
 473                                                 task->signal_finished.emit(true);
 474                                                 delete task;
 475                                         }
 476                                         else
 477                                         {
 478                                                 task->start();
 479                                                 tasks.push_back(task);
 480                                         }
 481                                 }
 482
 483                                 if(show_progress)
 484                                         IO::print("%d of %d target%s built\033[1G", count, total, (total!=1 ? "s" : ""));
 485                         }
 486                         else if(tasks.empty())
 487                                 finish = true;
 488                         else
 489                                 starved = true;
 490                 }
 491                 else
 492                         Time::sleep(10*Time::msec);
 493
 494                 for(unsigned i=0; i<tasks.size();)
 495                 {
 496                         Task::Status status;
 497                         if(jobs==1 || (tasks.size()==1 && starved))
 498                                 status = tasks[i]->wait();
 499                         else
 500                                 status = tasks[i]->check();
 501
 502                         if(status!=Task::RUNNING)
 503                         {
 504                                 ++count;
 505
 506                                 delete tasks[i];
 507                                 tasks.erase(tasks.begin()+i);
 508                                 if(status==Task::ERROR)
 509                                         fail = true;
 510                                 if(tasks.empty() && fail)
 511                                         finish = true;
 512                                 starved = false;
 513                         }
 514                         else
 515                                 ++i;
 516                 }
 517         }
 518
 519         if(show_progress)
 520                 IO::print("\033[K");
 521         if(fail)
 522                 logger.log("summary", "Build failed");
 523         else if(show_progress)
 524                 logger.log("summary", "Build complete");
 525
 526         if(!dry_run)
 527         {
 528                 const PackageManager::PackageMap &packages = package_manager.get_packages();
 529                 for(PackageManager::PackageMap::const_iterator i=packages.begin(); i!=packages.end(); ++i)
 530                         i->second->save_caches();
 531         }
 532
 533         return fail;
 534 }
 535
 536 int Builder::do_clean()
 537 {
 538         // Cleaning doesn't care about ordering, so a simpler method can be used
 539
 540         set<Target *> clean_tgts;
 541         list<Target *> queue;
 542         queue.push_back(get_target("cmdline"));
 543
 544         while(!queue.empty())
 545         {
 546                 Target *tgt = queue.front();
 547                 queue.erase(queue.begin());
 548
 549                 if(tgt->is_buildable() && (tgt->get_package()==main_pkg || clean>=2))
 550                         clean_tgts.insert(tgt);
 551
 552                 const Target::Dependencies &deps = tgt->get_dependencies();
 553                 for(list<Target *>::const_iterator i=deps.begin(); i!=deps.end(); ++i)
 554                         if(!clean_tgts.count(*i))
 555                                 queue.push_back(*i);
 556         }
 557
 558         for(set<Target *>::iterator i=clean_tgts.begin(); i!=clean_tgts.end(); ++i)
 559         {
 560                 logger.log("tasks", format("RM    %s", (*i)->get_name()));
 561                 if(!dry_run)
 562                         (*i)->clean();
 563         }
 564
 565         return 0;
 566 }
 567
 568 void Builder::package_help()
 569 {
 570         const Config &config = main_pkg->get_config();
 571         const Config::OptionMap &options = config.get_options();
 572
 573         IO::print("Required packages:\n  ");
 574         const PackageList &requires = main_pkg->get_required_packages();
 575         for(PackageList::const_iterator i=requires.begin(); i!=requires.end(); ++i)
 576         {
 577                 if(i!=requires.begin())
 578                         IO::print(", ");
 579                 IO::print((*i)->get_name());
 580         }
 581         IO::print("\n\nPackage configuration:\n");
 582         for(Config::OptionMap::const_iterator i=options.begin(); i!=options.end(); ++i)
 583         {
 584                 const Config::Option &opt = i->second;
 585                 IO::print("  %s: %s (%s)", opt.name, opt.description, opt.value);
 586                 if(opt.value!=opt.default_value)
 587                         IO::print(" [%s]", opt.default_value);
 588                 IO::print("\n");
 589         }
 590 }
 591
 592 string Builder::usagemsg;
 593 string Builder::helpmsg;
 594
 595
 596 Builder::Loader::Loader(Builder &b):
 597         DataFile::ObjectLoader<Builder>(b)
 598 {
 599         add("architecture", &Loader::architecture);
 600         add("binary_package", &Loader::binpkg);
 601         add("build_type", &Loader::build_type);
 602         add("profile", &Loader::profile);
 603         add("package", &Loader::package);
 604 }
 605
 606 void Builder::Loader::architecture(const string &n)
 607 {
 608         if(obj.current_arch->match_name(n))
 609                 load_sub(*obj.current_arch);
 610 }
 611
 612 void Builder::Loader::binpkg(const string &n)
 613 {
 614         BinaryPackage *pkg = new BinaryPackage(obj, n);
 615         load_sub(*pkg);
 616 }
 617
 618 void Builder::Loader::build_type(const string &n)
 619 {
 620         BuildType btype(n);
 621         load_sub(btype);
 622         BuildTypeMap::iterator i = obj.build_types.insert(BuildTypeMap::value_type(n, btype)).first;
 623         if(!obj.build_type)
 624                 obj.build_type = &i->second;
 625 }
 626
 627 void Builder::Loader::profile(const string &)
 628 {
 629         IO::print("Profiles are deprecated\n");
 630 }
 631
 632 void Builder::Loader::package(const string &n)
 633 {
 634         SourcePackage *pkg = new SourcePackage(obj, n, get_source());
 635         if(!obj.main_pkg)
 636                 obj.main_pkg = pkg;
 637
 638         if(obj.conf_all || pkg==obj.main_pkg)
 639                 load_sub(*pkg, obj.cmdline_options);
 640         else
 641                 load_sub(*pkg);
 642
 643         if(obj.build_type)
 644                 pkg->set_build_type(*obj.build_type);
 645 }