4 #include <msp/core/error.h>
5 #include <msp/core/getopt.h>
6 #include <msp/parser/parser.h>
7 #include <msp/path/utils.h>
8 #include <msp/strings/utils.h>
9 #include <msp/time/units.h>
10 #include <msp/time/utils.h>
18 #include "pkgconfig.h"
19 #include "sharedlibrary.h"
20 #include "systemlibrary.h"
22 #include "virtualtarget.h"
27 Builder::Builder(int argc, char **argv):
40 create_makefile(false)
44 bool full_paths=false;
48 getopt.add_option('a', "analyze", analyze_mode, GetOpt::REQUIRED_ARG);
49 getopt.add_option('b', "build", build, GetOpt::NO_ARG);
50 getopt.add_option('c', "clean", clean, GetOpt::NO_ARG);
51 getopt.add_option('f', "file", build_file, GetOpt::REQUIRED_ARG);
52 getopt.add_option('h', "help", help, GetOpt::NO_ARG);
53 getopt.add_option('j', "jobs", jobs, GetOpt::REQUIRED_ARG);
54 getopt.add_option('n', "dry-run", dry_run, GetOpt::NO_ARG);
55 getopt.add_option('v', "verbose", verbose, GetOpt::NO_ARG);
56 getopt.add_option('A', "conf-all", conf_all, GetOpt::NO_ARG);
57 getopt.add_option('B', "build-all", build_all, GetOpt::NO_ARG);
58 getopt.add_option('C', "chdir", work_dir, GetOpt::REQUIRED_ARG);
59 getopt.add_option('W', "what-if", what_if, GetOpt::REQUIRED_ARG);
60 getopt.add_option( "chrome", chrome, GetOpt::NO_ARG);
61 getopt.add_option( "conf-only", conf_only, GetOpt::NO_ARG);
62 getopt.add_option( "full-paths", full_paths, GetOpt::NO_ARG);
63 //getopt.add_option( "makefile", create_makefile, GetOpt::NO_ARG);
64 getopt.add_option( "max-depth", max_depth, GetOpt::REQUIRED_ARG);
67 if(!analyze_mode.empty())
69 analyzer=new Analyzer(*this);
71 if(analyze_mode=="deps")
72 analyzer->set_mode(Analyzer::DEPS);
73 else if(analyze_mode=="alldeps")
74 analyzer->set_mode(Analyzer::ALLDEPS);
75 else if(analyze_mode=="rebuild")
76 analyzer->set_mode(Analyzer::REBUILD);
77 else if(analyze_mode=="rdeps")
78 analyzer->set_mode(Analyzer::RDEPS);
80 throw UsageError("Invalid analyze mode");
82 analyzer->set_max_depth(max_depth);
83 analyzer->set_full_paths(full_paths);
85 else if(!clean && !create_makefile)
88 const list<string> &args=getopt.get_args();
89 for(list<string>::const_iterator i=args.begin(); i!=args.end(); ++i)
91 unsigned equal=i->find('=');
92 if(equal!=string::npos)
93 cmdline_options.insert(StringMap::value_type(i->substr(0, equal), i->substr(equal+1)));
95 cmdline_targets.push_back(*i);
98 if(cmdline_targets.empty())
99 cmdline_targets.push_back("default");
101 if(!work_dir.empty())
102 chdir(work_dir.c_str());
106 archs.insert(StringMap::value_type("native", ""));
107 archs.insert(StringMap::value_type("arm", "arm-linux-gnu"));
108 archs.insert(StringMap::value_type("win32", "i586-mingw32msvc"));
110 StringMap &native_tools=tools.insert(ToolMap::value_type("native", StringMap())).first->second;
111 native_tools.insert(StringMap::value_type("CC", "gcc"));
112 native_tools.insert(StringMap::value_type("CXX", "g++"));
113 native_tools.insert(StringMap::value_type("LD", "gcc"));
114 native_tools.insert(StringMap::value_type("LDXX", "g++"));
115 native_tools.insert(StringMap::value_type("AR", "ar"));
117 StringMap &release_profile=profile_tmpl.insert(ProfileTemplateMap::value_type("release", StringMap())).first->second;
118 release_profile.insert(StringMap::value_type("optimize", "3"));
119 release_profile.insert(StringMap::value_type("outdir", "$profile"));
121 StringMap &debug_profile=profile_tmpl.insert(ProfileTemplateMap::value_type("debug", StringMap())).first->second;
122 debug_profile.insert(StringMap::value_type("debug", "1"));
123 debug_profile.insert(StringMap::value_type("outdir", "$profile"));
125 for(StringMap::iterator i=archs.begin(); i!=archs.end(); ++i)
127 if(i->first=="native")
130 StringMap &arch_profile=profile_tmpl.insert(ProfileTemplateMap::value_type(i->first, StringMap())).first->second;
131 arch_profile.insert(StringMap::value_type("arch", i->first));
132 arch_profile.insert(StringMap::value_type("prefix", "$HOME/local/$arch"));
133 arch_profile.insert(StringMap::value_type("outdir", "$profile"));
138 Gets a package with the specified name, possibly creating it.
140 @param n Package name
142 @return Pointer to the package, or 0 if the package could not be located
144 Package *Builder::get_package(const string &n)
146 PackageMap::iterator i=packages.find(n);
147 if(i!=packages.end())
150 // Try to get source directory with pkgconfig
152 argv.push_back("pkg-config");
153 argv.push_back("--variable=source");
155 string srcdir=strip(run_command(argv));
159 dirs.push_back(srcdir);
161 // Make some other guesses about the source directory
163 if(!dirname.compare(0, 3, "msp"))
165 dirs.push_back(cwd/dirname);
166 dirs.push_back(cwd/".."/dirname);
168 // Go through the candidate directories and look for a Build file
169 for(PathList::iterator j=dirs.begin(); j!=dirs.end(); ++j)
170 if(!load_build_file(*j/"Build"))
173 if(i!=packages.end())
178 // Package source not found - create a binary package
179 Package *pkg=Package::create(*this, n);
180 packages.insert(PackageMap::value_type(n, pkg));
182 new_pkgs.push_back(pkg);
188 Returns the target with the given name, or 0 if no such target exists.
190 Target *Builder::get_target(const string &n) const
192 TargetMap::const_iterator i=targets.find(n);
199 Tries to locate a header included from a given location and with a given include
200 path. Considers known targets as well as existing files. If a matching target
201 is not found but a file exists, a new SystemHeader target will be created and
204 Target *Builder::get_header(const string &include, const string &, const string &from, const list<string> &path)
207 update_hash(hash, from);
208 for(list<string>::const_iterator i=path.begin(); i!=path.end(); ++i)
209 update_hash(hash, *i);
211 string id=hash+include;
212 TargetMap::iterator i=includes.find(id);
213 if(i!=includes.end())
216 string fn=include.substr(1);
218 if(include[0]=='"' && (tgt=get_header(Path::Path(from)/fn)))
220 else if((tgt=get_header(Path::Path("/usr/include")/fn)))
222 //XXX Determine the C++ header location dynamically
223 else if((tgt=get_header(Path::Path("/usr/include/c++/4.1.2")/fn)))
227 for(list<string>::const_iterator j=path.begin(); (j!=path.end() && !tgt); ++j)
228 tgt=get_header(cwd/ *j/fn);
231 includes.insert(TargetMap::value_type(id, tgt));
237 Tries to locate a library with the given library path. Considers known targets
238 as well as existing files. If a matching target is not found but a file exists,
239 a new SystemLibrary target will be created and returned.
241 @param lib Name of the library to get (without "lib" prefix or extension)
242 @param path List of paths to search for the library
243 @param mode Shared / static mode
245 @return Some kind of library target, if a match was found
247 Target *Builder::get_library(const string &lib, const string &arch, const list<string> &path, LibMode mode)
250 for(list<string>::const_iterator i=path.begin(); i!=path.end(); ++i)
251 update_hash(hash, *i);
253 //XXX Incorporate mode into id
255 TargetMap::iterator i=libraries.find(id);
256 if(i!=libraries.end())
262 syspath.push_back("/lib");
263 syspath.push_back("/usr/lib");
266 syspath.push_back("/usr/"+get_arch_prefix(arch)+"/lib");
269 for(StringList::iterator j=syspath.begin(); (!tgt && j!=syspath.end()); ++j)
270 tgt=get_library(lib, arch, *j, mode);
271 for(StringList::const_iterator j=path.begin(); (!tgt && j!=path.end()); ++j)
272 tgt=get_library(lib, arch, cwd/ *j, mode);
274 libraries.insert(TargetMap::value_type(id, tgt));
279 const string &Builder::get_arch_prefix(const string &arch) const
281 StringMap::const_iterator i=archs.find(arch);
283 throw InvalidParameterValue("Unknown architecture");
288 string Builder::get_tool(const std::string &tool, const std::string &arch)
290 ToolMap::iterator i=tools.find(arch);
293 StringMap::iterator j=i->second.find(tool);
294 if(j!=i->second.end())
298 // Either the arch, or the tool within the arch was not found
299 i=tools.find("native");
300 StringMap::iterator j=i->second.find(tool);
301 if(j==i->second.end())
302 throw InvalidParameterValue("Unknown tool");
304 return get_arch_prefix(arch)+"-"+j->second;
307 void Builder::apply_profile_template(Config &config, const string &pt) const
309 vector<string> parts=split(pt, '-');
311 for(vector<string>::iterator i=parts.begin(); i!=parts.end(); ++i)
313 ProfileTemplateMap::const_iterator j=profile_tmpl.find(*i);
314 if(j==profile_tmpl.end())
317 config.update(j->second);
322 Adds a target to both the target map and the new target queue. Called from
325 void Builder::add_target(Target *t)
327 targets.insert(TargetMap::value_type(t->get_name(), t));
328 new_tgts.push_back(t);
333 if(load_build_file(cwd/build_file))
335 cerr<<"No build info here.\n";
339 default_pkg=packages.begin()->second;
341 while(!new_pkgs.empty())
343 Package *pkg=new_pkgs.front();
344 new_pkgs.erase(new_pkgs.begin());
348 default_pkg->configure(cmdline_options, conf_all?2:1);
352 usage(0, "builder", false);
359 for(PackageMap::iterator i=packages.begin(); i!=packages.end(); ++i)
364 else if(i->second->get_buildable() && i->second->get_arch()!=default_pkg->get_arch())
365 prob="wrong architecture ("+i->second->get_arch()+")";
367 problems.insert(StringMap::value_type(i->first, prob));
370 if(!problems.empty())
372 cerr<<"The following problems were detected:\n";
373 for(StringMap::iterator i=problems.begin(); i!=problems.end(); ++i)
374 cerr<<" "<<i->first<<": "<<i->second<<'\n';
375 cerr<<"Please fix them and try again.\n";
385 cout<<packages.size()<<" packages, "<<targets.size()<<" targets\n";
388 for(PackageMap::iterator i=packages.begin(); i!=packages.end(); ++i)
390 cout<<' '<<i->second->get_name();
391 if(i->second->get_buildable())
394 unsigned ood_count=0;
395 for(TargetMap::iterator j=targets.begin(); j!=targets.end(); ++j)
396 if(j->second->get_package()==i->second)
399 if(j->second->get_rebuild())
404 cout<<" ("<<count<<" targets";
406 cout<<", "<<ood_count<<" out-of-date";
419 exit_code=do_clean();
421 exit_code=do_build();
428 for(PackageMap::iterator i=packages.begin(); i!=packages.end(); ++i)
430 for(TargetMap::iterator i=targets.begin(); i!=targets.end(); ++i)
435 void Builder::usage(const char *reason, const char *argv0, bool brief)
441 cerr<<"Usage: "<<argv0<<" [-a|--analyze MODE] [-b|--build] [-c|--clean] [-f|--file FILE] [-h|--help] [-j|--jobs NUM] [-n||--dry-run] [-v|--verbose] [-A|--conf-all] [-B|--build-all] [-C|--chdir DIRECTORY] [-W|--what-if FILE] [--chrome] [--conf-only] [--full-paths] [--max-depth NUM] [<target> ...]";
445 "Usage: "<<argv0<<" [options] [<target> ...]\n"
448 " -a, --analyze MODE Perform analysis. MODE can be deps, alldeps or rebuild.\n"
449 " -b, --build Perform build even if doing analysis.\n"
450 " -c, --clean Clean buildable targets.\n"
451 " -f, --file FILE Read info from FILE instead of Build.\n"
452 " -h, --help Print this message.\n"
453 " -j, --jobs NUM Run NUM commands at once, whenever possible.\n"
454 " -n, --dry-run Don't actually do anything, only show what would be done.\n"
455 " -v, --verbose Print more information about what's going on.\n"
456 " -A, --conf-all Apply configuration to all packages.\n"
457 " -B, --build-all Build all targets unconditionally.\n"
458 " -C, --chdir DIR Change to DIR before doing anything else.\n"
459 " -W, --what-if FILE Pretend that FILE has changed.\n"
460 " --chrome Use extra chrome to print status.\n"
461 " --conf-only Stop after configuring packages.\n"
462 " --full-paths Output full paths in analysis.\n"
463 //" --makefile Create a makefile for this package.\n"
464 " --max-depth NUM Maximum depth to show in analysis.\n";
469 Loads the given build file.
471 @param fn Path to the file
473 @return 0 on success, -1 if the file could not be opened
475 int Builder::load_build_file(const Path::Path &fn)
477 ifstream in(fn.str().c_str());
481 Parser::Parser parser(in, fn.str());
482 Loader loader(*this, fn.subpath(0, fn.size()-1));
489 Creates targets for all packages and prepares them for building.
491 @return 0 if everything went ok, -1 if something bad happened and a build
492 shouldn't be attempted
494 int Builder::create_targets()
496 Target *world=new VirtualTarget(*this, "world");
498 Target *def_tgt=new VirtualTarget(*this, "default");
499 world->add_depend(def_tgt);
501 Target *install=new VirtualTarget(*this, "install");
502 world->add_depend(install);
504 for(PackageMap::iterator i=packages.begin(); i!=packages.end(); ++i)
508 if(!i->second->get_buildable())
511 const ComponentList &components=i->second->get_components();
512 for(ComponentList::const_iterator j=components.begin(); j!=components.end(); ++j)
515 if(i->second->get_install_flags()&(Package::LIB|Package::INCLUDE))
517 PkgConfig *pc=new PkgConfig(*this, *i->second);
518 install->add_depend(new Install(*this, *i->second, *pc));
522 // Find dependencies until no new targets are created
523 while(!new_tgts.empty())
525 Target *tgt=new_tgts.front();
526 new_tgts.erase(new_tgts.begin());
528 if(!tgt->get_depends_ready())
529 new_tgts.push_back(tgt);
533 for(StringList::iterator i=what_if.begin(); i!=what_if.end(); ++i)
535 Target *tgt=get_target((cwd/ *i).str());
538 cerr<<"Unknown what-if target "<<*i<<'\n';
544 // Make the cmdline target depend on all targets mentioned on the command line
545 Target *cmdline=new VirtualTarget(*this, "cmdline");
546 bool build_world=false;
547 for(list<string>::iterator i=cmdline_targets.begin(); i!=cmdline_targets.end(); ++i)
549 Target *tgt=get_target(*i);
551 tgt=get_target((cwd/ *i).str());
554 cerr<<"I don't know anything about "<<*i<<'\n';
559 cmdline->add_depend(tgt);
562 /* If world is to be built, prepare cmdline. If not, add cmdline to world
563 and prepare world. I don't really like this, but it keeps the graph
569 world->add_depend(cmdline);
577 Check if a header exists, either as a target or a file. Either an existing
578 target or a new SystemHeader target will be returned.
580 Target *Builder::get_header(const Msp::Path::Path &fn)
582 Target *tgt=get_target(fn.str());
587 tgt=new SystemHeader(*this, fn.str());
593 Target *Builder::get_library(const string &lib, const string &arch, const Path::Path &path, LibMode mode)
595 // Populate a list of candidate filenames
596 StringList candidates;
601 candidates.push_back("lib"+lib+".dll");
603 candidates.push_back("lib"+lib+".so");
606 /* Static libraries are always considered, since sometimes shared versions
607 may not be available */
608 candidates.push_back("lib"+lib+".a");
610 candidates.push_back("lib"+lib+".dll.a");
612 for(StringList::iterator i=candidates.begin(); i!=candidates.end(); ++i)
614 string full=(path/ *i).str();
615 Target *tgt=get_target(full);
619 Target *real_tgt=tgt;
620 if(dynamic_cast<Install *>(tgt))
621 real_tgt=real_tgt->get_depends().front();
623 /* Ignore dynamic libraries from local packages unless library mode is
625 if(dynamic_cast<SharedLibrary *>(real_tgt) && mode!=DYNAMIC)
630 else if(Path::exists(full))
632 tgt=new SystemLibrary(*this, full);
641 Updates a hash with a string. This is used from get_header and get_library.
643 void Builder::update_hash(string &hash, const string &value)
645 for(unsigned i=0; i<value.size(); ++i)
646 hash[i%hash.size()]^=value[i];
650 This function supervises the build process, starting new actions when slots
653 int Builder::do_build()
655 Target *cmdline=get_target("cmdline");
657 unsigned total=cmdline->count_rebuild();
660 cout<<"Already up to date\n";
663 cout<<"Will build "<<total<<" target(s)\n";
665 vector<Action *> actions;
668 cout<<"0 targets built\n";
676 if(actions.size()<jobs && !fail)
678 Target *tgt=cmdline->get_buildable_target();
681 Action *action=tgt->build();
683 actions.push_back(action);
685 else if(actions.empty())
689 Time::sleep(10*Time::msec);
691 for(unsigned i=0; i<actions.size();)
693 int status=actions[i]->check();
699 cout<<"\e["<<actions.size()+1<<'A';
700 cout<<count<<" targets built\n";
704 if(i<actions.size()-1)
705 cout<<"\e["<<actions.size()-i-1<<"B";
709 actions.erase(actions.begin()+i);
712 if(actions.empty() && fail)
721 cout<<"Build failed\n";
727 Cleans buildable targets. If clean is 1, cleans only this package. If
728 clean is 2 or greater, cleans all buildable packages.
730 int Builder::do_clean()
732 // Cleaning doesn't care about ordering, so a simpler method can be used
734 set<Target *> clean_tgts;
736 queue.push_back(get_target("cmdline"));
738 while(!queue.empty())
740 Target *tgt=queue.front();
741 queue.erase(queue.begin());
743 if(tgt->get_buildable() && (tgt->get_package()==default_pkg || clean>=2))
744 clean_tgts.insert(tgt);
746 const TargetList &deps=tgt->get_depends();
747 for(TargetList::const_iterator i=deps.begin(); i!=deps.end(); ++i)
748 if(!clean_tgts.count(*i))
752 for(set<Target *>::iterator i=clean_tgts.begin(); i!=clean_tgts.end(); ++i)
754 Action *action=new Unlink(*this, **i);
755 while(action->check()<0);
763 Prints out information about the default package.
765 void Builder::package_help()
767 const Config &config=default_pkg->get_config();
768 const Config::OptionMap &options=config.get_options();
770 cout<<"Required packages:\n ";
771 const PkgRefList &requires=default_pkg->get_requires();
772 for(PkgRefList::const_iterator i=requires.begin(); i!=requires.end(); ++i)
774 if(i!=requires.begin())
779 cout<<"Package configuration:\n";
780 for(Config::OptionMap::const_iterator i=options.begin(); i!=options.end(); ++i)
782 const Config::Option &opt=i->second;
783 cout<<" "<<opt.name<<": "<<opt.descr<<" ("<<opt.value<<") ["<<opt.defv<<"]\n";
787 Application::RegApp<Builder> Builder::reg;
789 Builder::Loader::Loader(Builder &b, const Path::Path &s):
793 add("package", &Loader::package);
796 void Builder::Loader::package(const string &n)
798 Package *pkg=new Package(bld, n, src);
800 bld.packages.insert(PackageMap::value_type(n, pkg));
801 bld.new_pkgs.push_back(pkg);