3 This file is part of builder
4 Copyright © 2006-2010 Mikko Rasa, Mikkosoft Productions
5 Distributed under the LGPL
10 #include <msp/core/except.h>
11 #include <msp/core/getopt.h>
12 #include <msp/datafile/parser.h>
13 #include <msp/fs/dir.h>
14 #include <msp/fs/stat.h>
15 #include <msp/fs/utils.h>
16 #include <msp/io/buffered.h>
17 #include <msp/io/except.h>
18 #include <msp/io/file.h>
19 #include <msp/io/print.h>
20 #include <msp/strings/formatter.h>
21 #include <msp/strings/regex.h>
22 #include <msp/strings/utils.h>
23 #include <msp/time/units.h>
24 #include <msp/time/utils.h>
27 #include "binarypackage.h"
33 #include "pkgconfig.h"
34 #include "sharedlibrary.h"
35 #include "sourcepackage.h"
36 #include "systemlibrary.h"
38 #include "virtualtarget.h"
45 void update_hash(string &hash, const string &value)
47 for(unsigned i=0; i<value.size(); ++i)
48 hash[i%hash.size()] ^= value[i];
54 Builder::Builder(int argc, char **argv):
56 native_arch(*this, string()),
69 create_makefile(false)
73 bool full_paths = false;
74 unsigned max_depth = 5;
75 StringList cmdline_warn;
80 getopt.add_option('a', "analyze", analyze_mode, GetOpt::REQUIRED_ARG).set_help("Perform analysis. MODE can be deps, alldeps or rebuild.", "MODE");
81 getopt.add_option('b', "build", build, GetOpt::NO_ARG).set_help("Perform build even if doing analysis.");
82 getopt.add_option('c', "clean", clean, GetOpt::NO_ARG).set_help("Clean buildable targets.");
83 getopt.add_option('f', "file", build_file, GetOpt::REQUIRED_ARG).set_help("Read info from FILE instead of Build.", "FILE");
84 getopt.add_option('h', "help", help, GetOpt::NO_ARG).set_help("Print this message.");
85 getopt.add_option('j', "jobs", jobs, GetOpt::REQUIRED_ARG).set_help("Run NUM commands at once, whenever possible.", "NUM");
86 getopt.add_option('n', "dry-run", dry_run, GetOpt::NO_ARG).set_help("Don't actually do anything, only show what would be done.");
87 getopt.add_option('v', "verbose", verbose, GetOpt::NO_ARG).set_help("Print more information about what's going on.");
88 getopt.add_option('A', "conf-all", conf_all, GetOpt::NO_ARG).set_help("Apply configuration to all packages.");
89 getopt.add_option('B', "build-all", build_all, GetOpt::NO_ARG).set_help("Build all targets unconditionally.");
90 getopt.add_option('C', "chdir", work_dir, GetOpt::REQUIRED_ARG).set_help("Change to DIR before doing anything else.", "DIR");
91 getopt.add_option('P', "progress", show_progress, GetOpt::NO_ARG).set_help("Display progress while building.");
92 getopt.add_option('W', "what-if", what_if, GetOpt::REQUIRED_ARG).set_help("Pretend that FILE has changed.", "FILE");
93 getopt.add_option( "arch", arch, GetOpt::REQUIRED_ARG).set_help("Architecture to build for.", "ARCH");
94 getopt.add_option( "conf-only", conf_only, GetOpt::NO_ARG).set_help("Stop after configuring packages.");
95 getopt.add_option( "full-paths", full_paths, GetOpt::NO_ARG).set_help("Output full paths in analysis.");
96 getopt.add_option( "max-depth", max_depth, GetOpt::REQUIRED_ARG).set_help("Maximum depth to show in analysis.", "NUM");
97 getopt.add_option( "prefix", prfx, GetOpt::REQUIRED_ARG).set_help("Directory to install things to.", "DIR");
98 getopt.add_option( "warnings", cmdline_warn, GetOpt::REQUIRED_ARG).set_help("Compiler warnings to use.", "LIST");
99 usagemsg = getopt.generate_usage(argv[0])+" [<target> ...]";
100 helpmsg = getopt.generate_help();
103 if(!analyze_mode.empty())
105 analyzer = new Analyzer(*this);
107 if(analyze_mode=="deps")
108 analyzer->set_mode(Analyzer::DEPS);
109 else if(analyze_mode=="alldeps")
110 analyzer->set_mode(Analyzer::ALLDEPS);
111 else if(analyze_mode=="rebuild")
112 analyzer->set_mode(Analyzer::REBUILD);
113 else if(analyze_mode=="rdeps")
114 analyzer->set_mode(Analyzer::RDEPS);
116 throw UsageError("Invalid analyze mode");
118 analyzer->set_max_depth(max_depth);
119 analyzer->set_full_paths(full_paths);
121 else if(!clean && !create_makefile)
124 const vector<string> &args = getopt.get_args();
125 for(vector<string>::const_iterator i=args.begin(); i!=args.end(); ++i)
127 string::size_type equal = i->find('=');
128 if(equal!=string::npos)
129 cmdline_options.insert(StringMap::value_type(i->substr(0, equal), i->substr(equal+1)));
131 cmdline_targets.push_back(*i);
134 if(cmdline_targets.empty())
135 cmdline_targets.push_back("default");
137 if(!work_dir.empty())
142 native_arch.set_tool("CC", "gcc");
143 native_arch.set_tool("CXX", "g++");
144 native_arch.set_tool("LD", "gcc");
145 native_arch.set_tool("LXX", "g++");
146 native_arch.set_tool("AR", "ar");
148 load_build_file((FS::get_sys_data_dir(argv[0], "builder")/"builderrc").str());
149 load_build_file((FS::get_user_data_dir("builder")/"rc").str());
152 current_arch = &native_arch;
154 current_arch = new Architecture(*this, arch);
156 if(!current_arch->is_native())
158 for(StringMap::const_iterator i=cross_prefixes.begin(); i!=cross_prefixes.end(); ++i)
159 if(current_arch->match_name(i->first))
161 current_arch->set_cross_prefix(i->second);
168 if(current_arch->is_native())
169 prefix = (FS::get_home_dir()/"local").str();
171 prefix = (FS::get_home_dir()/"local"/current_arch->get_name()).str();
174 prefix = FS::getcwd()/prfx;
176 warnings.push_back("all");
177 warnings.push_back("extra");
178 warnings.push_back("shadow");
179 warnings.push_back("pointer-arith");
180 warnings.push_back("error");
181 for(StringList::iterator i=cmdline_warn.begin(); i!=cmdline_warn.end(); ++i)
183 vector<string> warns = split(*i, ',');
184 warnings.insert(warnings.end(), warns.begin(), warns.end());
187 pkg_path.push_back(cwd/".");
188 pkg_path.push_back(cwd/"..");
193 for(PackageMap::iterator i=packages.begin(); i!=packages.end(); ++i)
195 for(TargetMap::iterator i=targets.begin(); i!=targets.end(); ++i)
202 if(prefix.str()!="/usr")
204 FS::Path pcdir = prefix/"lib"/"pkgconfig";
205 if(const char *pcp = getenv("PKG_CONFIG_PATH"))
207 vector<string> path = split(pcp, ':');
209 for(vector<string>::const_iterator i=path.begin(); (!found && i!=path.end()); ++i)
210 found = (*i==pcdir.str());
213 path.push_back(pcdir.str());
214 setenv("PKG_CONFIG_PATH", join(path.begin(), path.end(), ":").c_str(), true);
218 setenv("PKG_CONFIG_PATH", pcdir.str().c_str(), true);
221 if(load_build_file(cwd/build_file))
225 usage(0, "builder", false);
230 IO::print(IO::cerr, "No build info here.\n");
235 main_pkg->configure(cmdline_options, conf_all?2:1);
239 usage(0, "builder", false);
245 if(!conf_only && create_targets())
248 PackageList all_reqs = main_pkg->collect_requires();
255 IO::print("Building on %s, for %s%s\n", native_arch.get_name(),
256 current_arch->get_name(), (current_arch->is_native() ? " (native)" : ""));
257 IO::print("Prefix is %s\n", prefix);
260 IO::print("%d active packages, %d targets\n", all_reqs.size(), targets.size());
263 for(PackageList::const_iterator i=all_reqs.begin(); i!=all_reqs.end(); ++i)
265 IO::print(" %s", (*i)->get_name());
266 if(dynamic_cast<SourcePackage *>(*i))
269 unsigned to_be_built = 0;
270 for(TargetMap::iterator j=targets.begin(); j!=targets.end(); ++j)
271 if(j->second->get_package()==*i)
274 if(j->second->get_rebuild())
279 IO::print(" (%d targets", count);
281 IO::print(", %d to be built", to_be_built);
291 if(!problems.empty())
293 IO::print(IO::cerr, "The following problems were detected:\n");
294 for(ProblemList::iterator i=problems.begin(); i!=problems.end(); ++i)
295 IO::print(IO::cerr, " %s: %s\n", i->package, i->descr);
297 IO::print(IO::cerr, "Please fix them and try again.\n");
302 exit_code = do_clean();
304 exit_code = do_build();
309 string Builder::run_pkgconfig(const string &pkg, const string &what)
312 argv.push_back("pkg-config");
313 if(what=="cflags" || what=="libs")
314 argv.push_back("--"+what);
315 else if(what=="flags")
317 argv.push_back("--cflags");
318 argv.push_back("--libs");
321 argv.push_back("--variable="+what);
325 IO::print("Running %s\n", join(argv.begin(), argv.end()));
328 string res = run_command(argv, &status);
330 throw Exception(format("pkg-config for package %s failed", pkg));
335 Package *Builder::get_package(const string &name)
337 PackageMap::iterator i = packages.find(format("%s/%s", name, current_arch->get_system()));
338 if(i==packages.end())
339 i = packages.find(name);
340 if(i!=packages.end())
343 FS::Path path = get_package_location(name);
344 if(!path.empty() && !load_build_file(path/"Build"))
346 i = packages.find(name);
347 if(i!=packages.end())
354 // Package source not found - create a binary package
355 pkg = BinaryPackage::from_pkgconfig(*this, name);
359 problem(name, "not found");
362 packages.insert(PackageMap::value_type(name, pkg));
367 Target *Builder::get_target(const string &n) const
369 // XXX Used for getting targets by path. get_target(const FS::Path &)?
370 TargetMap::const_iterator i = targets.find(n);
376 Target *Builder::get_header(const string &include, const FS::Path &from, const list<string> &path)
380 update_hash(hash, from.str());
381 for(list<string>::const_iterator i=path.begin(); i!=path.end(); ++i)
382 update_hash(hash, *i);
384 string id = hash+include;
385 TargetMap::iterator i = includes.find(id);
386 if(i!=includes.end())
389 static string cxx_ver;
393 argv.push_back(current_arch->get_tool("CXX"));
394 argv.push_back("--version");
395 if(RegMatch m = Regex("[0-9]\\.[0-9.]+").match(run_command(argv)))
398 while(!cxx_ver.empty() && !FS::is_dir(FS::Path("/usr/include/c++")/cxx_ver))
400 string::size_type dot = cxx_ver.rfind('.');
401 if(dot==string::npos)
406 IO::print("C++ version is %s\n", cxx_ver);
412 string fn = include.substr(1);
414 IO::print("Looking for include %s from %s with path %s\n", fn, from, join(path.begin(), path.end()));
417 if(current_arch->is_native())
418 syspath.push_back("/usr/include");
420 syspath.push_back("/usr/"+current_arch->get_cross_prefix()+"/include");
422 syspath.push_back((FS::Path("/usr/include/c++/")/cxx_ver).str());
426 tgt = get_header(FS::Path(from)/fn);
427 for(list<string>::const_iterator j=path.begin(); (!tgt && j!=path.end()); ++j)
428 tgt = get_header(cwd/ *j/fn);
429 for(list<string>::const_iterator j=syspath.begin(); (!tgt && j!=syspath.end()); ++j)
430 tgt = get_header(FS::Path(*j)/fn);
432 includes.insert(TargetMap::value_type(id, tgt));
437 Target *Builder::get_library(const string &lib, const list<string> &path, LibMode mode)
440 for(list<string>::const_iterator i=path.begin(); i!=path.end(); ++i)
441 update_hash(hash, *i);
443 string id = hash+string(1, mode)+lib;
444 TargetMap::iterator i = libraries.find(id);
445 if(i!=libraries.end())
449 if(current_arch->is_native())
451 syspath.push_back("/lib");
452 syspath.push_back("/usr/lib");
455 syspath.push_back("/usr/"+current_arch->get_cross_prefix()+"/lib");
458 IO::print("Looking for library %s with path %s\n", lib, join(path.begin(), path.end()));
461 for(StringList::const_iterator j=path.begin(); (!tgt && j!=path.end()); ++j)
462 tgt = get_library(lib, cwd/ *j, mode);
463 for(StringList::iterator j=syspath.begin(); (!tgt && j!=syspath.end()); ++j)
464 tgt = get_library(lib, *j, mode);
466 libraries.insert(TargetMap::value_type(id, tgt));
471 void Builder::apply_profile_template(Config &config, const string &pt) const
473 vector<string> parts = split(pt, '-');
475 for(vector<string>::iterator i=parts.begin(); i!=parts.end(); ++i)
477 ProfileTemplateMap::const_iterator j = profile_tmpl.find(*i);
478 if(j==profile_tmpl.end())
481 config.update(j->second);
485 void Builder::problem(const string &p, const string &d)
487 problems.push_back(Problem(p, d));
490 void Builder::add_target(FileTarget *t)
492 targets.insert(TargetMap::value_type(t->get_path().str(), t));
493 new_tgts.push_back(t);
496 void Builder::add_target(VirtualTarget *t)
498 targets.insert(TargetMap::value_type(t->get_name(), t));
499 new_tgts.push_back(t);
502 void Builder::usage(const char *reason, const char *argv0, bool brief)
505 IO::print(IO::cerr, "%s\n", reason);
508 IO::print(IO::cerr, "Usage: %s\n", usagemsg);
511 IO::print(IO::cerr, "Builder 1.0\n\n");
512 IO::print(IO::cerr, "Usage: %s [options] [<target> ...]\n\n", argv0);
513 IO::print(IO::cerr, "Options:\n");
514 IO::print(IO::cerr, helpmsg);
518 FS::Path Builder::get_package_location(const string &name)
521 IO::print("Looking for package %s\n", name);
525 // Try to get source directory with pkgconfig
526 string srcdir = strip(run_pkgconfig(name, "source"));
535 for(list<FS::Path>::const_iterator i=pkg_path.begin(); i!=pkg_path.end(); ++i)
537 list<string> files = list_files(*i);
538 for(list<string>::const_iterator j=files.begin(); j!=files.end(); ++j)
540 FS::Path full = *i / *j;
541 if(FS::exists(full/"Build"))
542 pkg_dirs.push_back(full);
546 IO::print("%d packages found in path\n", pkg_dirs.size());
549 bool msp = !name.compare(0, 3, "msp");
550 for(list<FS::Path>::const_iterator i=pkg_dirs.begin(); i!=pkg_dirs.end(); ++i)
552 string base = basename(*i);
553 unsigned dash = base.rfind('-');
555 if(!base.compare(0, dash, name))
557 else if(msp && !base.compare(0, dash-3, name, 3, string::npos))
564 int Builder::load_build_file(const FS::Path &fn)
568 IO::BufferedFile in(fn.str());
571 IO::print("Reading %s\n", fn);
573 DataFile::Parser parser(in, fn.str());
574 Loader loader(*this, fn.subpath(0, fn.size()-1));
577 catch(const IO::FileNotFound &)
585 int Builder::create_targets()
587 Target *world = new VirtualTarget(*this, "world");
589 Target *def_tgt = new VirtualTarget(*this, "default");
590 world->add_depend(def_tgt);
592 Target *install = new VirtualTarget(*this, "install");
593 world->add_depend(install);
595 Target *tarballs = new VirtualTarget(*this, "tarballs");
596 world->add_depend(tarballs);
598 PackageList all_reqs = main_pkg->collect_requires();
599 for(PackageList::iterator i=all_reqs.begin(); i!=all_reqs.end(); ++i)
601 SourcePackage *spkg = dynamic_cast<SourcePackage *>(*i);
605 const ComponentList &components = spkg->get_components();
606 for(ComponentList::const_iterator j=components.begin(); j!=components.end(); ++j)
609 if(spkg->get_install_flags()&(SourcePackage::LIB|SourcePackage::INCLUDE))
611 PkgConfig *pc = new PkgConfig(*this, *spkg);
612 install->add_depend(new Install(*this, *spkg, *pc));
616 // Find dependencies until no new targets are created
617 while(!new_tgts.empty())
619 Target *tgt = new_tgts.front();
620 new_tgts.erase(new_tgts.begin());
622 if(!tgt->get_depends_ready())
623 new_tgts.push_back(tgt);
627 for(StringList::iterator i=what_if.begin(); i!=what_if.end(); ++i)
629 FileTarget *tgt = dynamic_cast<FileTarget *>(get_target((cwd/ *i).str()));
632 IO::print(IO::cerr, "Unknown what-if target %s\n", *i);
638 // Make the cmdline target depend on all targets mentioned on the command line
639 Target *cmdline = new VirtualTarget(*this, "cmdline");
640 bool build_world = false;
641 for(list<string>::iterator i=cmdline_targets.begin(); i!=cmdline_targets.end(); ++i)
643 Target *tgt = get_target(*i);
645 tgt = get_target((cwd/ *i).str());
648 IO::print("I don't know anything about %s\n", *i);
653 cmdline->add_depend(tgt);
658 for(PackageMap::iterator i=packages.begin(); i!=packages.end(); ++i)
659 if(SourcePackage *spkg = dynamic_cast<SourcePackage *>(i->second))
660 spkg->get_deps_cache().save();
665 Target *Builder::get_header(const FS::Path &fn)
667 Target *tgt = get_target(fn.str());
672 tgt = new SystemHeader(*this, fn.str());
678 Target *Builder::get_library(const string &lib, const FS::Path &path, LibMode mode)
680 // Populate a list of candidate filenames
681 StringList candidates;
685 // XXX Should probably let the Architecture populate the list
686 if(current_arch->get_system()=="windows")
688 candidates.push_back("lib"+lib+".dll");
689 candidates.push_back(lib+".dll");
692 candidates.push_back("lib"+lib+".so");
695 /* Static libraries are always considered, since sometimes shared versions
696 may not be available */
697 candidates.push_back("lib"+lib+".a");
698 if(current_arch->get_system()=="windows")
699 candidates.push_back("lib"+lib+".dll.a");
701 for(StringList::iterator i=candidates.begin(); i!=candidates.end(); ++i)
703 string full = (path/ *i).str();
704 Target *tgt = get_target(full);
708 Target *real_tgt = tgt;
709 if(Install *inst = dynamic_cast<Install *>(tgt))
710 real_tgt = &inst->get_source();
712 /* Ignore dynamic libraries from local packages unless library mode is
714 if(dynamic_cast<SharedLibrary *>(real_tgt) && mode!=DYNAMIC)
719 else if(FS::is_reg(full))
721 tgt = new SystemLibrary(*this, full);
729 int Builder::do_build()
731 Target *cmdline = get_target("cmdline");
734 for(map<string, Target *>::const_iterator i=targets.begin(); i!=targets.end(); ++i)
735 if(i->second->is_buildable() && i->second->get_rebuild())
740 IO::print("Already up to date\n");
744 IO::print("Will build %d target%s\n", total, (total!=1 ? "s" : ""));
746 vector<Action *> actions;
755 if(actions.size()<jobs && !fail)
757 Target *tgt = cmdline->get_buildable_target();
760 Action *action = tgt->build();
762 actions.push_back(action);
765 IO::print("%d of %d target%s built\033[1G", count, total, (total!=1 ? "s" : ""));
767 else if(actions.empty())
771 Time::sleep(10*Time::msec);
773 for(unsigned i=0; i<actions.size();)
775 int status = actions[i]->check();
781 actions.erase(actions.begin()+i);
784 if(actions.empty() && fail)
795 IO::print("Build failed\n");
796 else if(show_progress)
797 IO::print("Build complete\n");
802 int Builder::do_clean()
804 // Cleaning doesn't care about ordering, so a simpler method can be used
806 set<Target *> clean_tgts;
808 queue.push_back(get_target("cmdline"));
810 while(!queue.empty())
812 Target *tgt = queue.front();
813 queue.erase(queue.begin());
815 if(tgt->is_buildable() && (tgt->get_package()==main_pkg || clean>=2))
816 clean_tgts.insert(tgt);
818 const TargetList &deps = tgt->get_depends();
819 for(TargetList::const_iterator i=deps.begin(); i!=deps.end(); ++i)
820 if(!clean_tgts.count(*i))
824 for(set<Target *>::iterator i=clean_tgts.begin(); i!=clean_tgts.end(); ++i)
825 if(FileTarget *ft = dynamic_cast<FileTarget *>(*i))
827 Action *action = new Unlink(*this, *ft);
828 while(action->check()<0) ;
835 void Builder::package_help()
837 const Config &config = main_pkg->get_config();
838 const Config::OptionMap &options = config.get_options();
840 IO::print("Required packages:\n ");
841 const PackageList &requires = main_pkg->get_requires();
842 for(PackageList::const_iterator i=requires.begin(); i!=requires.end(); ++i)
844 if(i!=requires.begin())
846 IO::print((*i)->get_name());
848 IO::print("\n\nPackage configuration:\n");
849 for(Config::OptionMap::const_iterator i=options.begin(); i!=options.end(); ++i)
851 const Config::Option &opt = i->second;
852 IO::print(" %s: %s (%s)", opt.name, opt.descr, opt.value);
853 if(opt.value!=opt.defv)
854 IO::print(" [%s]", opt.defv);
859 Application::RegApp<Builder> Builder::reg;
860 string Builder::usagemsg;
861 string Builder::helpmsg;
864 Builder::Loader::Loader(Builder &b, const FS::Path &s):
868 add("binary_package", &Loader::binpkg);
869 add("cross_prefix", &Loader::cross_prefix);
870 add("profile", &Loader::profile);
871 add("package", &Loader::package);
874 void Builder::Loader::binpkg(const string &n)
876 BinaryPackage *pkg = new BinaryPackage(bld, n);
878 bld.packages.insert(PackageMap::value_type(n, pkg));
881 void Builder::Loader::cross_prefix(const string &a, const string &p)
883 bld.cross_prefixes[a] = p;
886 void Builder::Loader::profile(const string &n)
889 ProfileLoader ldr(prf);
891 bld.profile_tmpl.insert(ProfileTemplateMap::value_type(n, prf));
894 void Builder::Loader::package(const string &n)
896 SourcePackage *pkg = new SourcePackage(bld, n, src);
901 bld.packages.insert(PackageMap::value_type(n, pkg));
905 Builder::ProfileLoader::ProfileLoader(StringMap &p):
908 add("option", &ProfileLoader::option);
911 void Builder::ProfileLoader::option(const string &o, const string &v)
913 profile.insert(StringMap::value_type(o, v));