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>
16 #include "binarypackage.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"
26 #include "pkgconfiggenerator.h"
27 #include "sharedlibrary.h"
28 #include "sourcepackage.h"
31 #include "virtualtarget.h"
36 Builder::Builder(int argc, char **argv):
37 package_manager(*this),
39 native_arch(*this, string()),
53 create_makefile(false),
58 bool full_paths = false;
59 unsigned max_depth = 4;
63 bool no_externals = false;
66 list<string> log_channels;
67 string build_type_name;
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();
101 logger.enable_channel("summary");
102 logger.enable_channel("tasks");
106 logger.enable_channel("environment");
107 logger.enable_channel("packages");
108 logger.enable_channel("commands");
112 logger.enable_channel("files");
113 logger.enable_channel("auxcommands");
115 for(list<string>::const_iterator i=log_channels.begin(); i!=log_channels.end(); ++i)
117 vector<string> parts = split(*i, ',');
118 for(vector<string>::const_iterator j=parts.begin(); j!=parts.end(); ++j)
119 logger.enable_channel(*j);
122 if(!analyze_mode.empty())
124 analyzer = new Analyzer(*this);
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);
135 throw usage_error("Invalid analyze mode");
137 analyzer->set_max_depth(max_depth);
138 analyzer->set_full_paths(full_paths);
140 else if(!clean && !create_makefile)
143 const vector<string> &args = getopt.get_args();
144 for(vector<string>::const_iterator i=args.begin(); i!=args.end(); ++i)
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)));
150 cmdline_targets.push_back(*i);
153 if(cmdline_targets.empty())
154 cmdline_targets.push_back("default");
156 if(!work_dir.empty())
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"));
165 package_manager.set_no_externals(no_externals);
168 current_arch = &native_arch;
170 current_arch = new Architecture(*this, arch);
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)
181 if(current_arch->is_native())
182 prefix = (FS::get_home_dir()/"local").str();
184 prefix = (FS::get_home_dir()/"local"/current_arch->get_name()).str();
189 if(!temp_str.empty())
192 if(!build_type_name.empty())
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;
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));
213 for(TargetMap::iterator i=targets.begin(); i!=targets.end(); ++i)
220 FS::Path main_file = cwd/build_file;
221 if(!FS::exists(main_file))
225 usage(0, "builder", false);
230 IO::print(IO::cerr, "The file %s does not exist.\n", main_file);
235 load_build_file(main_file);
239 usage(0, "builder", false);
251 logger.log("environment", format("Building on %s, for %s%s", native_arch.get_name(),
252 current_arch->get_name(), (current_arch->is_native() ? " (native)" : "")));
253 logger.log("environment", format("Prefix is %s", prefix));
254 if(tempdir.is_absolute())
255 logger.log("environment", format("Temporary directory is %s", tempdir));
257 logger.log("environment", format("Using per-package temporary directory %s", tempdir));
259 logger.log("environment", format("Build type is %s", build_type->get_name()));
261 const PackageManager::PackageMap &packages = package_manager.get_packages();
262 list<string> package_details;
263 for(PackageManager::PackageMap::const_iterator i=packages.begin(); i!=packages.end(); ++i)
265 if(!i->second->is_prepared())
268 string line = i->second->get_name();
269 if(dynamic_cast<SourcePackage *>(i->second))
274 unsigned to_be_built = 0;
275 for(TargetMap::iterator j=targets.begin(); j!=targets.end(); ++j)
276 if(j->second->get_package()==i->second)
279 if(j->second->needs_rebuild())
284 line += format(" (%d targets", count);
286 line += format(", %d to be built", to_be_built);
291 package_details.push_back(line);
294 logger.log("summary", format("%d active packages, %d targets", package_details.size(), targets.size()));
295 for(list<string>::const_iterator i=package_details.begin(); i!=package_details.end(); ++i)
296 logger.log("packages", *i);
301 if(!problems.empty())
303 IO::print(IO::cerr, "The following problems were detected:\n");
304 for(ProblemList::iterator i=problems.begin(); i!=problems.end(); ++i)
305 IO::print(IO::cerr, " %s: %s\n", i->package, i->descr);
307 IO::print(IO::cerr, "Please fix them and try again.\n");
312 exit_code = do_clean();
314 exit_code = do_build();
319 Target *Builder::get_target(const string &n) const
321 TargetMap::const_iterator i = targets.find(n);
327 void Builder::problem(const string &p, const string &d)
329 problems.push_back(Problem(p, d));
332 void Builder::add_target(Target *t)
334 targets.insert(TargetMap::value_type(t->get_name(), t));
337 void Builder::add_primary_target(Target &t)
339 get_target("world")->add_dependency(t);
341 if(t.get_package()==main_pkg && t.get_component() && t.get_component()->is_default())
342 get_target("default")->add_dependency(t);
345 void Builder::add_installed_target(Target &t)
347 Target *inst_tgt = 0;
348 if(const Tool *tool = t.get_tool())
349 inst_tgt = tool->create_install(t);
351 inst_tgt = toolchain.get_tool("CP").create_target(t);
352 get_target("install")->add_dependency(*inst_tgt);
355 void Builder::usage(const char *reason, const char *argv0, bool brief)
358 IO::print(IO::cerr, "%s\n", reason);
361 IO::print(IO::cerr, "Usage: %s\n", usagemsg);
364 IO::print(IO::cerr, "Builder 1.0\n\n");
365 IO::print(IO::cerr, "Usage: %s [options] [<target> ...]\n\n", argv0);
366 IO::print(IO::cerr, "Options:\n");
367 IO::print(IO::cerr, helpmsg);
371 void Builder::load_build_file(const FS::Path &fn)
373 IO::BufferedFile in(fn.str());
375 logger.log("files", format("Reading %s", fn));
377 DataFile::Parser parser(in, fn.str());
378 Loader loader(*this);
382 bool Builder::prepare_build()
384 Target *world = new VirtualTarget(*this, "world");
386 Target *def_tgt = new VirtualTarget(*this, "default");
387 world->add_dependency(*def_tgt);
389 Target *install = new VirtualTarget(*this, "install");
390 world->add_dependency(*install);
392 Target *tarballs = new VirtualTarget(*this, "tarballs");
393 world->add_dependency(*tarballs);
397 // Make the cmdline target depend on all targets mentioned on the command line
398 Target *cmdline = new VirtualTarget(*this, "cmdline");
399 for(NameList::iterator i=cmdline_targets.begin(); i!=cmdline_targets.end(); ++i)
401 Target *tgt = get_target(*i);
403 tgt = vfs.get_target(*i);
405 tgt = vfs.get_target(cwd/ *i);
408 IO::print("I don't know anything about %s\n", *i);
412 cmdline->add_dependency(*tgt);
418 for(NameList::iterator i=what_if.begin(); i!=what_if.end(); ++i)
420 FileTarget *tgt = vfs.get_target(cwd/ *i);
423 IO::print(IO::cerr, "Unknown what-if target %s\n", *i);
431 for(TargetMap::iterator i=targets.begin(); i!=targets.end(); ++i)
432 if(i->second->is_buildable() && !i->second->needs_rebuild())
433 i->second->force_rebuild();
438 const PackageManager::PackageMap &packages = package_manager.get_packages();
439 for(PackageManager::PackageMap::const_iterator i=packages.begin(); i!=packages.end(); ++i)
440 i->second->save_caches();
446 int Builder::do_build()
448 Target *cmdline = get_target("cmdline");
451 for(map<string, Target *>::const_iterator i=targets.begin(); i!=targets.end(); ++i)
452 if(i->second->is_buildable() && i->second->needs_rebuild())
457 logger.log("summary", "Already up to date");
460 logger.log("summary", format("Will build %d target%s", total, (total!=1 ? "s" : "")));
462 vector<Task *> tasks;
468 bool starved = false;
472 if(tasks.size()<jobs && !fail && !starved)
474 Target *tgt = cmdline->get_buildable_target();
478 logger.log("tasks", format("%-4s %s", tgt->get_tool()->get_tag(), tgt->get_name()));
479 Task *task = tgt->build();
482 logger.log("commands", format("%s", task->get_command()));
485 task->signal_finished.emit(true);
491 tasks.push_back(task);
496 IO::print("%d of %d target%s built\033[1G", count, total, (total!=1 ? "s" : ""));
498 else if(tasks.empty())
504 Time::sleep(10*Time::msec);
506 for(unsigned i=0; i<tasks.size();)
509 if(jobs==1 || (tasks.size()==1 && starved))
510 status = tasks[i]->wait();
512 status = tasks[i]->check();
514 if(status!=Task::RUNNING)
519 tasks.erase(tasks.begin()+i);
520 if(status==Task::ERROR)
522 if(tasks.empty() && fail)
534 logger.log("summary", "Build failed");
535 else if(show_progress)
536 logger.log("summary", "Build complete");
540 const PackageManager::PackageMap &packages = package_manager.get_packages();
541 for(PackageManager::PackageMap::const_iterator i=packages.begin(); i!=packages.end(); ++i)
542 i->second->save_caches();
548 int Builder::do_clean()
550 // Cleaning doesn't care about ordering, so a simpler method can be used
552 set<Target *> clean_tgts;
553 list<Target *> queue;
554 queue.push_back(get_target("cmdline"));
556 while(!queue.empty())
558 Target *tgt = queue.front();
559 queue.erase(queue.begin());
561 if(tgt->is_buildable() && (tgt->get_package()==main_pkg || clean>=2))
562 clean_tgts.insert(tgt);
564 const Target::Dependencies &deps = tgt->get_dependencies();
565 for(list<Target *>::const_iterator i=deps.begin(); i!=deps.end(); ++i)
566 if(!clean_tgts.count(*i))
570 for(set<Target *>::iterator i=clean_tgts.begin(); i!=clean_tgts.end(); ++i)
572 logger.log("tasks", format("RM %s", (*i)->get_name()));
580 void Builder::package_help()
582 const Config &config = main_pkg->get_config();
583 const Config::OptionMap &options = config.get_options();
585 IO::print("Required packages:\n ");
586 const Package::Requirements &requires = main_pkg->get_required_packages();
587 for(Package::Requirements::const_iterator i=requires.begin(); i!=requires.end(); ++i)
589 if(i!=requires.begin())
591 IO::print((*i)->get_name());
593 IO::print("\n\nPackage configuration:\n");
594 for(Config::OptionMap::const_iterator i=options.begin(); i!=options.end(); ++i)
596 const Config::Option &opt = i->second;
597 IO::print(" %s: %s (%s)", opt.name, opt.description, opt.value);
598 if(opt.value!=opt.default_value)
599 IO::print(" [%s]", opt.default_value);
604 string Builder::usagemsg;
605 string Builder::helpmsg;
608 Builder::Loader::Loader(Builder &b):
609 DataFile::ObjectLoader<Builder>(b)
611 add("architecture", &Loader::architecture);
612 add("binary_package", &Loader::binpkg);
613 add("build_type", &Loader::build_type);
614 add("profile", &Loader::profile);
615 add("package", &Loader::package);
618 void Builder::Loader::architecture(const string &n)
620 if(obj.current_arch->match_name(n))
621 load_sub(*obj.current_arch);
624 void Builder::Loader::binpkg(const string &n)
626 BinaryPackage *pkg = new BinaryPackage(obj, n);
630 void Builder::Loader::build_type(const string &n)
634 BuildTypeMap::iterator i = obj.build_types.insert(BuildTypeMap::value_type(n, btype)).first;
636 obj.build_type = &i->second;
639 void Builder::Loader::profile(const string &)
641 IO::print("Profiles are deprecated\n");
644 void Builder::Loader::package(const string &n)
646 SourcePackage *pkg = new SourcePackage(obj, n, get_source());
650 if(obj.conf_all || pkg==obj.main_pkg)
651 load_sub(*pkg, obj.cmdline_options);
656 pkg->set_build_type(*obj.build_type);