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 "mingwdlltool.h"
  25 #include "package.h"
  26 #include "pkgconfiggenerator.h"
  27 #include "sharedlibrary.h"
  28 #include "sourcepackage.h"
  29 #include "tar.h"
  30 #include "task.h"
  31 #include "virtualtarget.h"
  32
  33 using namespace std;
  34 using namespace Msp;
  35
  36 Builder::Builder(int argc, char **argv):
  37         package_manager(*this),
  38         native_arch(*this, string()),
  39         build_type(0),
  40         vfs(*this),
  41         build_graph(*this),
  42         analyzer(0),
  43         build(false),
  44         clean(0),
  45         dry_run(false),
  46         help(false),
  47         show_progress(false),
  48         build_file("Build"),
  49         jobs(1),
  50         conf_all(false),
  51         conf_only(false),
  52         build_all(false),
  53         create_makefile(false),
  54         tempdir("temp")
  55 {
  56         string analyze_mode;
  57         string work_dir;
  58         bool full_paths = false;
  59         unsigned max_depth = 4;
  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(Config::InputOptions::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         if(current_arch->get_system()=="windows")
 208                 toolchain.add_tool(new MingwDllTool(*this, *current_arch));
 209 }
 210
 211 Builder::~Builder()
 212 {
 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->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                         const BuildGraph::TargetMap &targets = build_graph.get_targets();
 274                         for(BuildGraph::TargetMap::const_iterator j=targets.begin(); j!=targets.end(); ++j)
 275                                 if(j->second->get_package()==i->second)
 276                                 {
 277                                         ++count;
 278                                         if(j->second->needs_rebuild())
 279                                                 ++to_be_built;
 280                                 }
 281                         if(count)
 282                         {
 283                                 line += format(" (%d targets", count);
 284                                 if(to_be_built)
 285                                         line += format(", %d to be built", to_be_built);
 286                                 line += ')';
 287                         }
 288                 }
 289
 290                 package_details.push_back(line);
 291         }
 292
 293         logger.log("summary", format("%d active packages, %d targets", package_details.size(), build_graph.get_targets().size()));
 294         for(list<string>::const_iterator i=package_details.begin(); i!=package_details.end(); ++i)
 295                 logger.log("packages", *i);
 296
 297         if(analyzer)
 298                 analyzer->analyze();
 299
 300         if(!problems.empty())
 301         {
 302                 IO::print(IO::cerr, "The following problems were detected:\n");
 303                 for(ProblemList::iterator i=problems.begin(); i!=problems.end(); ++i)
 304                         IO::print(IO::cerr, "  %s: %s\n", i->package, i->descr);
 305                 if(!analyzer)
 306                         IO::print(IO::cerr, "Please fix them and try again.\n");
 307                 return 1;
 308         }
 309
 310         if(clean)
 311                 exit_code = do_clean();
 312         if(build)
 313                 exit_code = do_build();
 314
 315         return exit_code;
 316 }
 317
 318 void Builder::problem(const string &p, const string &d)
 319 {
 320         problems.push_back(Problem(p, d));
 321 }
 322
 323 void Builder::usage(const char *reason, const char *argv0, bool brief)
 324 {
 325         if(reason)
 326                 IO::print(IO::cerr, "%s\n", reason);
 327
 328         if(brief)
 329                 IO::print(IO::cerr, "Usage: %s\n", usagemsg);
 330         else
 331         {
 332                 IO::print(IO::cerr, "Builder 1.0\n\n");
 333                 IO::print(IO::cerr, "Usage: %s [options] [<target> ...]\n\n", argv0);
 334                 IO::print(IO::cerr, "Options:\n");
 335                 IO::print(IO::cerr, helpmsg);
 336         }
 337 }
 338
 339 void Builder::load_build_file(const FS::Path &fn)
 340 {
 341         IO::BufferedFile in(fn.str());
 342
 343         logger.log("files", format("Reading %s", fn));
 344
 345         DataFile::Parser parser(in, fn.str());
 346         Loader loader(*this);
 347         loader.load(parser);
 348 }
 349
 350 bool Builder::prepare_build()
 351 {
 352         package_manager.get_main_package().prepare();
 353
 354         // Make the cmdline target depend on all targets mentioned on the command line
 355         Target *cmdline = new VirtualTarget(*this, "cmdline");
 356         for(NameList::iterator i=cmdline_targets.begin(); i!=cmdline_targets.end(); ++i)
 357         {
 358                 Target *tgt = build_graph.get_target(*i);
 359                 if(!tgt)
 360                         tgt = vfs.get_target(*i);
 361                 if(!tgt)
 362                         tgt = vfs.get_target(cwd/ *i);
 363                 if(!tgt)
 364                 {
 365                         IO::print("I don't know anything about %s\n", *i);
 366                         return false;
 367                 }
 368
 369                 cmdline->add_dependency(*tgt);
 370         }
 371
 372         cmdline->prepare();
 373
 374         // Apply what-ifs
 375         for(NameList::iterator i=what_if.begin(); i!=what_if.end(); ++i)
 376         {
 377                 FileTarget *tgt = vfs.get_target(cwd/ *i);
 378                 if(!tgt)
 379                 {
 380                         IO::print(IO::cerr, "Unknown what-if target %s\n", *i);
 381                         return false;
 382                 }
 383                 tgt->touch();
 384         }
 385
 386         if(build_all)
 387         {
 388                 for(TargetMap::iterator i=targets.begin(); i!=targets.end(); ++i)
 389                         if(i->second->is_buildable() && !i->second->needs_rebuild())
 390                                 i->second->force_rebuild();
 391         }
 392
 393         if(!dry_run)
 394         {
 395                 const PackageManager::PackageMap &packages = package_manager.get_packages();
 396                 for(PackageManager::PackageMap::const_iterator i=packages.begin(); i!=packages.end(); ++i)
 397                         i->second->save_caches();
 398         }
 399
 400         return true;
 401 }
 402
 403 int Builder::do_build()
 404 {
 405         Target *cmdline = build_graph.get_target("cmdline");
 406
 407         unsigned total = 0;
 408         const BuildGraph::TargetMap &targets = build_graph.get_targets();
 409         for(map<string, Target *>::const_iterator i=targets.begin(); i!=targets.end(); ++i)
 410                 if(i->second->is_buildable() && i->second->needs_rebuild())
 411                         ++total;
 412
 413         if(!total)
 414         {
 415                 logger.log("summary", "Already up to date");
 416                 return 0;
 417         }
 418         logger.log("summary", format("Will build %d target%s", total, (total!=1 ? "s" : "")));
 419
 420         vector<Task *> tasks;
 421
 422         unsigned count = 0;
 423
 424         bool fail = false;
 425         bool finish = false;
 426         bool starved = false;
 427
 428         while(!finish)
 429         {
 430                 if(tasks.size()<jobs && !fail && !starved)
 431                 {
 432                         Target *tgt = cmdline->get_buildable_target();
 433                         if(tgt)
 434                         {
 435                                 if(tgt->get_tool())
 436                                         logger.log("tasks", format("%-4s  %s", tgt->get_tool()->get_tag(), tgt->get_name()));
 437                                 Task *task = tgt->build();
 438                                 if(task)
 439                                 {
 440                                         logger.log("commands", format("%s", task->get_command()));
 441                                         if(dry_run)
 442                                         {
 443                                                 task->signal_finished.emit(true);
 444                                                 delete task;
 445                                         }
 446                                         else
 447                                         {
 448                                                 task->start();
 449                                                 tasks.push_back(task);
 450                                         }
 451                                 }
 452
 453                                 if(show_progress)
 454                                         IO::print("%d of %d target%s built\033[1G", count, total, (total!=1 ? "s" : ""));
 455                         }
 456                         else if(tasks.empty())
 457                                 finish = true;
 458                         else
 459                                 starved = true;
 460                 }
 461                 else
 462                         Time::sleep(10*Time::msec);
 463
 464                 for(unsigned i=0; i<tasks.size();)
 465                 {
 466                         Task::Status status;
 467                         if(jobs==1 || (tasks.size()==1 && starved))
 468                                 status = tasks[i]->wait();
 469                         else
 470                                 status = tasks[i]->check();
 471
 472                         if(status!=Task::RUNNING)
 473                         {
 474                                 ++count;
 475
 476                                 delete tasks[i];
 477                                 tasks.erase(tasks.begin()+i);
 478                                 if(status==Task::ERROR)
 479                                         fail = true;
 480                                 if(tasks.empty() && fail)
 481                                         finish = true;
 482                                 starved = false;
 483                         }
 484                         else
 485                                 ++i;
 486                 }
 487         }
 488
 489         if(show_progress)
 490                 IO::print("\033[K");
 491         if(fail)
 492                 logger.log("summary", "Build failed");
 493         else if(show_progress)
 494                 logger.log("summary", "Build complete");
 495
 496         if(!dry_run)
 497         {
 498                 const PackageManager::PackageMap &packages = package_manager.get_packages();
 499                 for(PackageManager::PackageMap::const_iterator i=packages.begin(); i!=packages.end(); ++i)
 500                         i->second->save_caches();
 501         }
 502
 503         return fail;
 504 }
 505
 506 int Builder::do_clean()
 507 {
 508         // Cleaning doesn't care about ordering, so a simpler method can be used
 509
 510         set<Target *> clean_tgts;
 511         list<Target *> queue;
 512         queue.push_back(build_graph.get_target("cmdline"));
 513
 514         while(!queue.empty())
 515         {
 516                 Target *tgt = queue.front();
 517                 queue.erase(queue.begin());
 518
 519                 if(tgt->is_buildable() && (tgt->get_package()==&package_manager.get_main_package() || clean>=2))
 520                         clean_tgts.insert(tgt);
 521
 522                 const Target::Dependencies &deps = tgt->get_dependencies();
 523                 for(list<Target *>::const_iterator i=deps.begin(); i!=deps.end(); ++i)
 524                         if(!clean_tgts.count(*i))
 525                                 queue.push_back(*i);
 526         }
 527
 528         for(set<Target *>::iterator i=clean_tgts.begin(); i!=clean_tgts.end(); ++i)
 529         {
 530                 logger.log("tasks", format("RM    %s", (*i)->get_name()));
 531                 if(!dry_run)
 532                         (*i)->clean();
 533         }
 534
 535         return 0;
 536 }
 537
 538 void Builder::package_help()
 539 {
 540         SourcePackage &main_pkg = dynamic_cast<SourcePackage &>(package_manager.get_main_package());
 541         const Config &config = main_pkg.get_config();
 542         const Config::OptionMap &options = config.get_options();
 543
 544         IO::print("Required packages:\n  ");
 545         const Package::Requirements &requires = main_pkg.get_required_packages();
 546         for(Package::Requirements::const_iterator i=requires.begin(); i!=requires.end(); ++i)
 547         {
 548                 if(i!=requires.begin())
 549                         IO::print(", ");
 550                 IO::print((*i)->get_name());
 551         }
 552         IO::print("\n\nPackage configuration:\n");
 553         for(Config::OptionMap::const_iterator i=options.begin(); i!=options.end(); ++i)
 554         {
 555                 const Config::Option &opt = i->second;
 556                 IO::print("  %s: %s (%s)", opt.name, opt.description, opt.value);
 557                 if(opt.value!=opt.default_value)
 558                         IO::print(" [%s]", opt.default_value);
 559                 IO::print("\n");
 560         }
 561 }
 562
 563 string Builder::usagemsg;
 564 string Builder::helpmsg;
 565
 566
 567 Builder::Loader::Loader(Builder &b):
 568         DataFile::ObjectLoader<Builder>(b)
 569 {
 570         add("architecture", &Loader::architecture);
 571         add("binary_package", &Loader::binpkg);
 572         add("build_type", &Loader::build_type);
 573         add("profile", &Loader::profile);
 574         add("package", &Loader::package);
 575 }
 576
 577 void Builder::Loader::architecture(const string &n)
 578 {
 579         if(obj.current_arch->match_name(n))
 580                 load_sub(*obj.current_arch);
 581 }
 582
 583 void Builder::Loader::binpkg(const string &n)
 584 {
 585         BinaryPackage *pkg = new BinaryPackage(obj, n);
 586         load_sub(*pkg);
 587 }
 588
 589 void Builder::Loader::build_type(const string &n)
 590 {
 591         BuildType btype(n);
 592         load_sub(btype);
 593         BuildTypeMap::iterator i = obj.build_types.insert(BuildTypeMap::value_type(n, btype)).first;
 594         if(!obj.build_type)
 595                 obj.build_type = &i->second;
 596 }
 597
 598 void Builder::Loader::profile(const string &)
 599 {
 600         IO::print("Profiles are deprecated\n");
 601 }
 602
 603 void Builder::Loader::package(const string &n)
 604 {
 605         SourcePackage *pkg = new SourcePackage(obj, n, get_source());
 606
 607         if(obj.conf_all || pkg==&obj.package_manager.get_main_package())
 608                 load_sub(*pkg, obj.cmdline_options);
 609         else
 610                 load_sub(*pkg);
 611
 612         if(obj.build_type)
 613                 pkg->set_build_type(*obj.build_type);
 614 }