3 This file is part of builder
4 Copyright © 2006-2009 Mikko Rasa, Mikkosoft Productions
5 Distributed under the LGPL
9 #include <sys/utsname.h>
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"
39 #include "virtualtarget.h"
46 void update_hash(string &hash, const string &value)
48 for(unsigned i=0; i<value.size(); ++i)
49 hash[i%hash.size()]^=value[i];
55 Builder::Builder(int argc, char **argv):
69 create_makefile(false)
73 bool full_paths=false;
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 unsigned 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())
143 string sysname="native";
145 sysname=tolower(un.sysname);
147 native_arch=&archs.insert(ArchMap::value_type(sysname, Architecture(*this, sysname, true))).first->second;
148 native_arch->set_tool("CC", "gcc");
149 native_arch->set_tool("CXX", "g++");
150 native_arch->set_tool("LD", "gcc");
151 native_arch->set_tool("LXX", "g++");
152 native_arch->set_tool("AR", "ar");
154 load_build_file((FS::get_sys_data_dir(argv[0], "builder")/"builderrc").str());
155 load_build_file((FS::get_home_dir()/".builderrc").str());
158 current_arch=native_arch;
160 current_arch=&get_architecture(arch);
164 if(current_arch->is_native())
165 prefix=(FS::get_home_dir()/"local").str();
167 prefix=(FS::get_home_dir()/"local"/current_arch->get_name()).str();
170 prefix=FS::getcwd()/prfx;
172 warnings.push_back("all");
173 warnings.push_back("extra");
174 warnings.push_back("shadow");
175 warnings.push_back("pointer-arith");
176 warnings.push_back("error");
177 for(StringList::iterator i=cmdline_warn.begin(); i!=cmdline_warn.end(); ++i)
179 vector<string> warns=split(*i, ',');
180 warnings.insert(warnings.end(), warns.begin(), warns.end());
183 pkg_path.push_back(cwd/".");
184 pkg_path.push_back(cwd/"..");
189 for(PackageMap::iterator i=packages.begin(); i!=packages.end(); ++i)
191 for(TargetMap::iterator i=targets.begin(); i!=targets.end(); ++i)
198 if(load_build_file(cwd/build_file))
202 usage(0, "builder", false);
207 IO::print(IO::cerr, "No build info here.\n");
212 main_pkg->configure(cmdline_options, conf_all?2:1);
216 usage(0, "builder", false);
222 if(!conf_only && create_targets())
225 PackageList all_reqs=main_pkg->collect_requires();
231 IO::print("Building on %s, for %s\n", native_arch->get_name(), current_arch->get_name());
233 IO::print("%d active packages, %d targets\n", all_reqs.size(), targets.size());
236 for(PackageList::const_iterator i=all_reqs.begin(); i!=all_reqs.end(); ++i)
238 IO::print(" %s", (*i)->get_name());
239 if(dynamic_cast<SourcePackage *>(*i))
242 unsigned ood_count=0;
243 for(TargetMap::iterator j=targets.begin(); j!=targets.end(); ++j)
244 if(j->second->get_package()==*i)
247 if(j->second->get_rebuild())
252 IO::print(" (%d targets", count);
254 IO::print(", %d out-of-date", ood_count);
264 if(!problems.empty())
266 IO::print(IO::cerr, "The following problems were detected:\n");
267 for(ProblemList::iterator i=problems.begin(); i!=problems.end(); ++i)
268 IO::print(IO::cerr, " %s: %s\n", i->package, i->descr);
269 IO::print(IO::cerr, "Please fix them and try again.\n");
276 exit_code=do_clean();
278 exit_code=do_build();
283 Package *Builder::get_package(const string &name)
285 PackageMap::iterator i=packages.find(format("%s/%s", name, current_arch->get_name()));
286 if(i==packages.end())
287 i=packages.find(name);
288 if(i!=packages.end())
291 FS::Path path=get_package_location(name);
292 if(!path.empty() && !load_build_file(path/"Build"))
294 i=packages.find(name);
295 if(i!=packages.end())
299 // Package source not found - create a binary package
300 Package *pkg=BinaryPackage::from_pkgconfig(*this, name);
302 packages.insert(PackageMap::value_type(name, pkg));
305 problem(name, "not found");
310 Target *Builder::get_target(const string &n) const
312 // XXX Used for getting targets by path. get_target(const FS::Path &)?
313 TargetMap::const_iterator i=targets.find(n);
319 Target *Builder::get_header(const string &include, const FS::Path &from, const list<string> &path)
323 update_hash(hash, from.str());
324 for(list<string>::const_iterator i=path.begin(); i!=path.end(); ++i)
325 update_hash(hash, *i);
327 string id=hash+include;
328 TargetMap::iterator i=includes.find(id);
329 if(i!=includes.end())
332 static string cxx_ver;
336 argv.push_back(current_arch->get_tool("CXX"));
337 argv.push_back("--version");
338 cxx_ver=Regex("[0-9]\\.[0-9.]+").match(run_command(argv))[0].str;
339 while(!cxx_ver.empty() && !FS::is_dir(FS::Path("/usr/include/c++")/cxx_ver))
341 unsigned dot=cxx_ver.rfind('.');
342 if(dot==string::npos)
347 IO::print("C++ version is %s\n", cxx_ver);
350 string fn=include.substr(1);
352 IO::print("Looking for include %s from %s with path %s\n", fn, from, join(path.begin(), path.end()));
355 if(current_arch->is_native())
356 syspath.push_back("/usr/include");
358 syspath.push_back("/usr/"+current_arch->get_prefix()+"/include");
359 syspath.push_back((FS::Path("/usr/include/c++/")/cxx_ver).str());
363 tgt=get_header(FS::Path(from)/fn);
364 for(list<string>::const_iterator j=path.begin(); (!tgt && j!=path.end()); ++j)
365 tgt=get_header(cwd/ *j/fn);
366 for(list<string>::const_iterator j=syspath.begin(); (!tgt && j!=syspath.end()); ++j)
367 tgt=get_header(FS::Path(*j)/fn);
369 includes.insert(TargetMap::value_type(id, tgt));
374 Target *Builder::get_library(const string &lib, const list<string> &path, LibMode mode)
377 for(list<string>::const_iterator i=path.begin(); i!=path.end(); ++i)
378 update_hash(hash, *i);
380 string id=hash+string(1, mode)+lib;
381 TargetMap::iterator i=libraries.find(id);
382 if(i!=libraries.end())
386 if(current_arch->is_native())
388 syspath.push_back("/lib");
389 syspath.push_back("/usr/lib");
392 syspath.push_back("/usr/"+current_arch->get_prefix()+"/lib");
395 IO::print("Looking for library %s with path %s\n", lib, join(path.begin(), path.end()));
398 for(StringList::const_iterator j=path.begin(); (!tgt && j!=path.end()); ++j)
399 tgt=get_library(lib, cwd/ *j, mode);
400 for(StringList::iterator j=syspath.begin(); (!tgt && j!=syspath.end()); ++j)
401 tgt=get_library(lib, *j, mode);
403 libraries.insert(TargetMap::value_type(id, tgt));
408 const Architecture &Builder::get_architecture(const string &arch) const
410 ArchMap::const_iterator i=archs.find(arch);
412 throw KeyError("Unknown architecture", arch);
417 void Builder::apply_profile_template(Config &config, const string &pt) const
419 vector<string> parts=split(pt, '-');
421 for(vector<string>::iterator i=parts.begin(); i!=parts.end(); ++i)
423 ProfileTemplateMap::const_iterator j=profile_tmpl.find(*i);
424 if(j==profile_tmpl.end())
427 config.update(j->second);
431 void Builder::problem(const string &p, const string &d)
433 problems.push_back(Problem(p, d));
436 void Builder::add_target(Target *t)
438 targets.insert(TargetMap::value_type(t->get_name(), t));
439 new_tgts.push_back(t);
442 void Builder::usage(const char *reason, const char *argv0, bool brief)
445 IO::print(IO::cerr, "%s\n", reason);
448 IO::print(IO::cerr, "Usage: %s\n", usagemsg);
451 IO::print(IO::cerr, "Usage: %s [options] [<target> ...]\n\n", argv0);
452 IO::print(IO::cerr, "Options:\n");
453 IO::print(IO::cerr, helpmsg);
457 FS::Path Builder::get_package_location(const string &name)
460 IO::print("Looking for package %s\n", name);
462 // Try to get source directory with pkgconfig
464 argv.push_back("pkg-config");
465 argv.push_back("--variable=source");
466 argv.push_back(name);
468 IO::print("Running %s\n", join(argv.begin(), argv.end()));
469 string srcdir=strip(run_command(argv));
475 for(list<FS::Path>::const_iterator i=pkg_path.begin(); i!=pkg_path.end(); ++i)
477 list<string> files=list_files(*i);
478 for(list<string>::const_iterator j=files.begin(); j!=files.end(); ++j)
480 FS::Path full=*i / *j;
481 if(FS::exists(full/"Build"))
482 pkg_dirs.push_back(full);
486 IO::print("%d packages found in path\n", pkg_dirs.size());
489 bool msp=!name.compare(0, 3, "msp");
490 for(list<FS::Path>::const_iterator i=pkg_dirs.begin(); i!=pkg_dirs.end(); ++i)
492 string base=basename(*i);
493 unsigned dash=base.rfind('-');
495 if(!base.compare(0, dash, name))
497 else if(msp && !base.compare(0, dash-3, name, 3, string::npos))
504 int Builder::load_build_file(const FS::Path &fn)
508 IO::BufferedFile in(fn.str());
511 IO::print("Reading %s\n", fn);
513 DataFile::Parser parser(in, fn.str());
514 Loader loader(*this, fn.subpath(0, fn.size()-1));
517 catch(const IO::FileNotFound &)
525 int Builder::create_targets()
527 Target *world=new VirtualTarget(*this, "world");
529 Target *def_tgt=new VirtualTarget(*this, "default");
530 world->add_depend(def_tgt);
532 Target *install=new VirtualTarget(*this, "install");
533 world->add_depend(install);
535 Target *tarballs=new VirtualTarget(*this, "tarballs");
536 world->add_depend(tarballs);
538 PackageList all_reqs=main_pkg->collect_requires();
539 for(PackageList::iterator i=all_reqs.begin(); i!=all_reqs.end(); ++i)
541 SourcePackage *spkg=dynamic_cast<SourcePackage *>(*i);
545 const ComponentList &components=spkg->get_components();
546 for(ComponentList::const_iterator j=components.begin(); j!=components.end(); ++j)
549 if(spkg->get_install_flags()&(SourcePackage::LIB|SourcePackage::INCLUDE))
551 PkgConfig *pc=new PkgConfig(*this, *spkg);
552 install->add_depend(new Install(*this, *spkg, *pc));
555 tarballs->add_depend(new TarBall(*this, *spkg));
558 // Find dependencies until no new targets are created
559 while(!new_tgts.empty())
561 Target *tgt=new_tgts.front();
562 new_tgts.erase(new_tgts.begin());
564 if(!tgt->get_depends_ready())
565 new_tgts.push_back(tgt);
569 for(StringList::iterator i=what_if.begin(); i!=what_if.end(); ++i)
571 Target *tgt=get_target((cwd/ *i).str());
574 IO::print(IO::cerr, "Unknown what-if target %s\n", *i);
580 // Make the cmdline target depend on all targets mentioned on the command line
581 Target *cmdline=new VirtualTarget(*this, "cmdline");
582 bool build_world=false;
583 for(list<string>::iterator i=cmdline_targets.begin(); i!=cmdline_targets.end(); ++i)
585 Target *tgt=get_target(*i);
587 tgt=get_target((cwd/ *i).str());
590 IO::print("I don't know anything about %s\n", *i);
595 cmdline->add_depend(tgt);
598 /* If world is to be built, prepare cmdline. If not, add cmdline to world
599 and prepare world. I don't really like this, but it keeps the graph
602 XXX Could we skip preparing targets we are not interested in? */
607 world->add_depend(cmdline);
611 for(PackageMap::iterator i=packages.begin(); i!=packages.end(); ++i)
612 if(SourcePackage *spkg=dynamic_cast<SourcePackage *>(i->second))
613 spkg->get_deps_cache().save();
618 Target *Builder::get_header(const Msp::FS::Path &fn)
620 Target *tgt=get_target(fn.str());
625 tgt=new SystemHeader(*this, fn.str());
631 Target *Builder::get_library(const string &lib, const FS::Path &path, LibMode mode)
633 // Populate a list of candidate filenames
634 StringList candidates;
638 if(current_arch->get_name()=="win32")
640 candidates.push_back("lib"+lib+".dll");
641 candidates.push_back(lib+".dll");
644 candidates.push_back("lib"+lib+".so");
647 /* Static libraries are always considered, since sometimes shared versions
648 may not be available */
649 candidates.push_back("lib"+lib+".a");
650 if(current_arch->get_name()=="win32")
651 candidates.push_back("lib"+lib+".dll.a");
653 for(StringList::iterator i=candidates.begin(); i!=candidates.end(); ++i)
655 string full=(path/ *i).str();
656 Target *tgt=get_target(full);
660 Target *real_tgt=tgt;
661 if(Install *inst=dynamic_cast<Install *>(tgt))
662 real_tgt=&inst->get_source();
664 /* Ignore dynamic libraries from local packages unless library mode is
666 if(dynamic_cast<SharedLibrary *>(real_tgt) && mode!=DYNAMIC)
671 else if(FS::is_reg(full))
673 tgt=new SystemLibrary(*this, full);
681 int Builder::do_build()
683 Target *cmdline=get_target("cmdline");
685 unsigned total=cmdline->count_rebuild();
688 IO::print("Already up to date\n");
692 IO::print("Will build %d target%s\n", total, (total!=1 ? "s" : ""));
694 vector<Action *> actions;
703 if(actions.size()<jobs && !fail)
705 Target *tgt=cmdline->get_buildable_target();
708 Action *action=tgt->build();
710 actions.push_back(action);
713 IO::print("%d of %d target%s built\033[1G", count, total, (total!=1 ? "s" : ""));
715 else if(actions.empty())
719 Time::sleep(10*Time::msec);
721 for(unsigned i=0; i<actions.size();)
723 int status=actions[i]->check();
729 actions.erase(actions.begin()+i);
732 if(actions.empty() && fail)
743 IO::print("Build failed\n");
744 else if(show_progress)
745 IO::print("Build complete\n");
750 int Builder::do_clean()
752 // Cleaning doesn't care about ordering, so a simpler method can be used
754 set<Target *> clean_tgts;
756 queue.push_back(get_target("cmdline"));
758 while(!queue.empty())
760 Target *tgt=queue.front();
761 queue.erase(queue.begin());
763 if(tgt->get_buildable() && (tgt->get_package()==main_pkg || clean>=2))
764 clean_tgts.insert(tgt);
766 const TargetList &deps=tgt->get_depends();
767 for(TargetList::const_iterator i=deps.begin(); i!=deps.end(); ++i)
768 if(!clean_tgts.count(*i))
772 for(set<Target *>::iterator i=clean_tgts.begin(); i!=clean_tgts.end(); ++i)
773 if(FileTarget *ft=dynamic_cast<FileTarget *>(*i))
775 Action *action=new Unlink(*this, *ft);
776 while(action->check()<0) ;
783 void Builder::package_help()
785 const Config &config=main_pkg->get_config();
786 const Config::OptionMap &options=config.get_options();
788 IO::print("Required packages:\n ");
789 const PackageList &requires=main_pkg->get_requires();
790 for(PackageList::const_iterator i=requires.begin(); i!=requires.end(); ++i)
792 if(i!=requires.begin())
794 IO::print((*i)->get_name());
796 IO::print("\n\nPackage configuration:\n");
797 for(Config::OptionMap::const_iterator i=options.begin(); i!=options.end(); ++i)
799 const Config::Option &opt=i->second;
800 IO::print(" %s: %s (%s)", opt.name, opt.descr, opt.value);
801 if(opt.value!=opt.defv)
802 IO::print(" [%s]", opt.defv);
807 Application::RegApp<Builder> Builder::reg;
808 string Builder::usagemsg;
809 string Builder::helpmsg;
812 Builder::Loader::Loader(Builder &b, const FS::Path &s):
816 add("architecture", &Loader::architecture);
817 add("binary_package", &Loader::binpkg);
818 add("profile", &Loader::profile);
819 add("package", &Loader::package);
822 void Builder::Loader::architecture(const string &n)
824 Architecture arch(bld, n);
826 bld.archs.insert(ArchMap::value_type(n, arch));
829 void Builder::Loader::binpkg(const string &n)
831 BinaryPackage *pkg=new BinaryPackage(bld, n);
833 bld.packages.insert(PackageMap::value_type(n, pkg));
836 void Builder::Loader::profile(const string &n)
839 ProfileLoader ldr(prf);
841 bld.profile_tmpl.insert(ProfileTemplateMap::value_type(n, prf));
844 void Builder::Loader::package(const string &n)
846 SourcePackage *pkg=new SourcePackage(bld, n, src);
851 bld.packages.insert(PackageMap::value_type(n, pkg));
855 Builder::ProfileLoader::ProfileLoader(StringMap &p):
858 add("option", &ProfileLoader::option);
861 void Builder::ProfileLoader::option(const string &o, const string &v)
863 profile.insert(StringMap::value_type(o, v));