3 #include <msp/progress.h>
4 #include <msp/core/error.h>
5 #include <msp/getopt++/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>
14 #include "executable.h"
18 #include "objectfile.h"
20 #include "pkgconfig.h"
21 #include "sharedlibrary.h"
22 #include "staticlibrary.h"
23 #include "systemlibrary.h"
24 #include "virtualtarget.h"
29 Builder::Builder(int argc, char **argv):
44 bool full_paths=false;
48 getopt.add_option('a', "analyze", analyze_mode, GetOpt::REQUIRED_ARG);
49 getopt.add_option('b', "build", do_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( "max-depth", max_depth, GetOpt::REQUIRED_ARG);
66 if(!analyze_mode.empty())
68 analyzer=new Analyzer(*this);
70 if(analyze_mode=="deps")
71 analyzer->set_mode(Analyzer::DEPS);
72 else if(analyze_mode=="alldeps")
73 analyzer->set_mode(Analyzer::ALLDEPS);
74 else if(analyze_mode=="rebuild")
75 analyzer->set_mode(Analyzer::REBUILD);
76 else if(analyze_mode=="rdeps")
77 analyzer->set_mode(Analyzer::RDEPS);
79 throw UsageError("Invalid analyze mode");
81 analyzer->set_max_depth(max_depth);
82 analyzer->set_full_paths(full_paths);
87 const list<string> &args=getopt.get_args();
88 for(list<string>::const_iterator i=args.begin(); i!=args.end(); ++i)
90 unsigned equal=i->find('=');
91 if(equal!=string::npos)
92 cmdline_options.insert(StringMap::value_type(i->substr(0, equal), i->substr(equal+1)));
94 cmdline_targets.push_back(*i);
97 if(cmdline_targets.empty())
98 cmdline_targets.push_back("default");
100 if(!work_dir.empty())
101 chdir(work_dir.c_str());
105 archs.insert(StringMap::value_type("native", ""));
106 archs.insert(StringMap::value_type("arm", "arm-linux-gnu-"));
107 archs.insert(StringMap::value_type("win32", "i586-mingw32msvc-"));
109 StringMap &native_tools=tools.insert(ToolMap::value_type("native", StringMap())).first->second;
110 native_tools.insert(StringMap::value_type("CC", "gcc"));
111 native_tools.insert(StringMap::value_type("CXX", "g++"));
112 native_tools.insert(StringMap::value_type("LD", "gcc"));
113 native_tools.insert(StringMap::value_type("LDXX", "g++"));
114 native_tools.insert(StringMap::value_type("AR", "ar"));
116 StringMap &release_profile=profile_tmpl.insert(ProfileTemplateMap::value_type("release", StringMap())).first->second;
117 release_profile.insert(StringMap::value_type("optimize", "3"));
118 release_profile.insert(StringMap::value_type("outdir", "$profile"));
120 StringMap &debug_profile=profile_tmpl.insert(ProfileTemplateMap::value_type("debug", StringMap())).first->second;
121 debug_profile.insert(StringMap::value_type("debug", "1"));
122 debug_profile.insert(StringMap::value_type("outdir", "$profile"));
124 for(StringMap::iterator i=archs.begin(); i!=archs.end(); ++i)
126 if(i->first=="native")
129 StringMap &arch_profile=profile_tmpl.insert(ProfileTemplateMap::value_type(i->first, StringMap())).first->second;
130 arch_profile.insert(StringMap::value_type("arch", i->first));
131 arch_profile.insert(StringMap::value_type("prefix", "$HOME/local/$arch"));
136 Gets a package with the specified name, possibly creating it.
138 @param n Package name
140 @return Pointer to the package, or 0 if the package could not be located
142 Package *Builder::get_package(const string &n)
144 PackageMap::iterator i=packages.find(n);
145 if(i!=packages.end())
148 // Try to get source directory with pkgconfig
150 argv.push_back("pkg-config");
151 argv.push_back("--variable=source");
153 string srcdir=strip(run_command(argv));
157 dirs.push_back(srcdir);
159 // Make some other guesses about the source directory
161 if(!dirname.compare(0, 3, "msp"))
163 dirs.push_back(cwd/dirname);
164 dirs.push_back(cwd/".."/dirname);
166 // Go through the candidate directories and look for a Build file
167 for(PathList::iterator j=dirs.begin(); j!=dirs.end(); ++j)
168 if(!load_build_file(*j/"Build"))
171 if(i!=packages.end())
176 // Package source not found - create a binary package
177 Package *pkg=Package::create(*this, n);
178 packages.insert(PackageMap::value_type(n, pkg));
180 new_pkgs.push_back(pkg);
186 Returns the target with the given name, or 0 if no such target exists.
188 Target *Builder::get_target(const string &n)
190 TargetMap::iterator i=targets.find(n);
197 Tries to locate a header included from a given location and with a given include
198 path. Considers known targets as well as existing files. If a matching target
199 is not found but a file exists, a new SystemHeader target will be created and
202 Target *Builder::get_header(const string &include, const string &from, const list<string> &path)
205 update_hash(hash, from);
206 for(list<string>::const_iterator i=path.begin(); i!=path.end(); ++i)
207 update_hash(hash, *i);
209 string id=hash+include;
210 TargetMap::iterator i=includes.find(id);
211 if(i!=includes.end())
214 string fn=include.substr(1);
216 if(include[0]=='"' && (tgt=get_header(Path::Path(from)/fn)))
218 else if((tgt=get_header(Path::Path("/usr/include")/fn)))
220 //XXX Determine the C++ header location dynamically
221 else if((tgt=get_header(Path::Path("/usr/include/c++/4.1.2")/fn)))
225 for(list<string>::const_iterator j=path.begin(); (j!=path.end() && !tgt); ++j)
226 tgt=get_header(cwd/ *j/fn);
229 includes.insert(TargetMap::value_type(id, tgt));
235 Tries to locate a library with the given library path. Considers known targets
236 as well as existing files. If a matching target is not found but a file exists,
237 a new SystemLibrary target will be created and returned.
239 @param lib Name of the library to get (without "lib" prefix or extension)
240 @param path List of paths to search for the library
241 @param mode Shared / static mode
243 @return Some kind of library target, if a match was found
245 Target *Builder::get_library(const string &lib, const list<string> &path, LibMode mode)
248 for(list<string>::const_iterator i=path.begin(); i!=path.end(); ++i)
249 update_hash(hash, *i);
251 //XXX Incorporate mode into id
253 TargetMap::iterator i=libraries.find(id);
254 if(i!=libraries.end())
258 if((tgt=get_library(lib, "/lib", mode)))
260 else if((tgt=get_library(lib, "/usr/lib", mode)))
264 for(list<string>::const_iterator j=path.begin(); (j!=path.end() && !tgt); ++j)
265 tgt=get_library(lib, cwd/ *j, mode);
268 libraries.insert(TargetMap::value_type(id, tgt));
273 const string &Builder::get_arch_prefix(const string &arch) const
275 StringMap::const_iterator i=archs.find(arch);
277 throw InvalidParameterValue("Unknown architecture");
282 string Builder::get_tool(const std::string &tool, const std::string &arch)
284 ToolMap::iterator i=tools.find(arch);
287 StringMap::iterator j=i->second.find(tool);
288 if(j!=i->second.end())
292 // Either the arch, or the tool within the arch was not found
293 i=tools.find("native");
294 StringMap::iterator j=i->second.find(tool);
295 if(j==i->second.end())
296 throw InvalidParameterValue("Unknown tool");
298 return get_arch_prefix(arch)+j->second;
301 void Builder::apply_profile_template(Config &config, const string &pt) const
303 vector<string> parts=split(pt, '-');
305 for(vector<string>::iterator i=parts.begin(); i!=parts.end(); ++i)
307 ProfileTemplateMap::const_iterator j=profile_tmpl.find(*i);
308 if(j==profile_tmpl.end())
311 config.update(j->second);
317 if(load_build_file(cwd/build_file))
319 cerr<<"No build info here.\n";
323 default_pkg=packages.begin()->second;
325 while(!new_pkgs.empty())
327 Package *pkg=new_pkgs.front();
328 new_pkgs.erase(new_pkgs.begin());
332 default_pkg->configure(cmdline_options, conf_all?2:1);
336 usage(0, "builder", false);
343 for(PackageMap::iterator i=packages.begin(); i!=packages.end(); ++i)
348 else if(i->second->get_buildable() && i->second->get_arch()!=default_pkg->get_arch())
349 prob="wrong architecture ("+i->second->get_arch()+")";
351 problems.insert(StringMap::value_type(i->first, prob));
354 if(!problems.empty())
356 cerr<<"The following problems were detected:\n";
357 for(StringMap::iterator i=problems.begin(); i!=problems.end(); ++i)
358 cerr<<" "<<i->first<<": "<<i->second<<'\n';
359 cerr<<"Please fix them and try again.\n";
369 cout<<packages.size()<<" packages, "<<targets.size()<<" targets\n";
372 for(PackageMap::iterator i=packages.begin(); i!=packages.end(); ++i)
374 cout<<' '<<i->second->get_name();
375 if(i->second->get_buildable())
378 unsigned ood_count=0;
379 for(TargetMap::iterator j=targets.begin(); j!=targets.end(); ++j)
380 if(j->second->get_package()==i->second)
383 if(j->second->get_rebuild())
388 cout<<" ("<<count<<" targets";
390 cout<<", "<<ood_count<<" out-of-date";
408 for(PackageMap::iterator i=packages.begin(); i!=packages.end(); ++i)
410 for(TargetMap::iterator i=targets.begin(); i!=targets.end(); ++i)
415 void Builder::usage(const char *reason, const char *argv0, bool brief)
421 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> ...]";
425 "Usage: "<<argv0<<" [options] [<target> ...]\n"
428 " -a, --analyze MODE Perform analysis. MODE can be deps, alldeps or rebuild.\n"
429 " -b, --build Perform build even if doing analysis.\n"
430 " -c, --clean Clean buildable targets.\n"
431 " -f, --file FILE Read info from FILE instead of Build.\n"
432 " -h, --help Print this message.\n"
433 " -j, --jobs NUM Run NUM commands at once, whenever possible.\n"
434 " -n, --dry-run Don't actually do anything, only show what would be done.\n"
435 " -v, --verbose Print more information about what's going on.\n"
436 " -A, --conf-all Apply configuration to all packages.\n"
437 " -B, --build-all Build all targets unconditionally.\n"
438 " -C, --chdir DIR Change to DIR before doing anything else.\n"
439 " -W, --what-if FILE Pretend that FILE has changed.\n"
440 " --chrome Use extra chrome to print status.\n"
441 " --conf-only Stop after configuring packages.\n"
442 " --full-paths Output full paths in analysis.\n"
443 " --max-depth NUM Maximum depth to show in analysis.\n";
448 Loads the given build file.
450 @param fn Path to the file
452 @return 0 on success, -1 if the file could not be opened
454 int Builder::load_build_file(const Path::Path &fn)
456 ifstream in(fn.str().c_str());
460 Parser::Parser parser(in, fn.str());
461 Loader loader(*this, fn.subpath(0, fn.size()-1));
468 Creates targets for all packages and prepares them for building.
470 @return 0 if everything went ok, -1 if something bad happened and a build
471 shouldn't be attempted
473 int Builder::create_targets()
475 Target *world=new VirtualTarget(*this, "world");
478 Target *def_tgt=new VirtualTarget(*this, "default");
480 world->add_depend(def_tgt);
482 Target *install=new VirtualTarget(*this, "install");
484 world->add_depend(install);
486 for(PackageMap::iterator i=packages.begin(); i!=packages.end(); ++i)
490 if(!i->second->get_buildable())
493 Path::Path inst_base;
494 if(i->second->get_buildable() && i->second->get_install_flags())
495 inst_base=i->second->get_prefix();
497 const ComponentList &components=i->second->get_components();
498 for(ComponentList::const_iterator j=components.begin(); j!=components.end(); ++j)
500 // Collect all files belonging to the component
502 const PathList &sources=j->get_sources();
503 for(PathList::const_iterator k=sources.begin(); k!=sources.end(); ++k)
507 if(S_ISDIR(st.st_mode))
509 list<string> sfiles=list_files(*k);
510 for(list<string>::iterator l=sfiles.begin(); l!=sfiles.end(); ++l)
511 files.push_back(*k / *l);
517 bool build_exe=j->get_type()!=Component::HEADERS;
519 list<ObjectFile *> objs;
520 for(PathList::iterator k=files.begin(); k!=files.end(); ++k)
522 string basename=(*k)[-1];
523 string ext=Path::splitext(basename).ext;
524 if((ext==".cpp" || ext==".c") && build_exe)
526 SourceFile *src=new SourceFile(*this, &*j, k->str());
530 ObjectFile *obj=new ObjectFile(*this, *j, *src);
536 Target *hdr=get_target(k->str());
539 hdr=new Header(*this, &*j, k->str());
543 // Install headers if requested
544 if(!j->get_install_headers().empty())
546 Path::Path inst_path=inst_base/"include"/j->get_install_headers()/basename;
547 Install *inst=new Install(*this, *i->second, *hdr, inst_path.str());
549 install->add_depend(inst);
557 StaticLibrary *slib=0;
558 if(j->get_type()==Component::LIBRARY)
560 exe=new SharedLibrary(*this, *j, objs);
561 slib=new StaticLibrary(*this, *j, objs);
565 exe=new Executable(*this, *j, objs);
568 if(i->second==default_pkg)
570 def_tgt->add_depend(exe);
571 if(slib) def_tgt->add_depend(slib);
575 world->add_depend(exe);
576 if(slib) world->add_depend(slib);
582 if(j->get_type()==Component::PROGRAM)
584 else if(j->get_type()==Component::LIBRARY)
586 if(!inst_dir.empty())
588 Install *inst=new Install(*this, *i->second, *exe, (inst_base/inst_dir/Path::basename(exe->get_name())).str());
590 install->add_depend(inst);
594 inst=new Install(*this, *i->second, *slib, (inst_base/inst_dir/Path::basename(slib->get_name())).str());
596 install->add_depend(inst);
603 if(i->second->get_install_flags()&(Package::LIB|Package::INCLUDE))
605 PkgConfig *pc=new PkgConfig(*this, *i->second);
607 Install *inst=new Install(*this, *i->second, *pc, (inst_base/"lib"/"pkgconfig"/Path::basename(pc->get_name())).str());
609 install->add_depend(inst);
613 // Find dependencies until no new targets are created
614 while(!new_tgts.empty())
616 Target *tgt=new_tgts.front();
617 new_tgts.erase(new_tgts.begin());
619 if(!tgt->get_depends_ready())
620 new_tgts.push_back(tgt);
624 for(StringList::iterator i=what_if.begin(); i!=what_if.end(); ++i)
626 Target *tgt=get_target((cwd/ *i).str());
629 cerr<<"Unknown what-if target "<<*i<<'\n';
635 // Make the cmdline target depend on all targets mentioned on the command line
636 Target *cmdline=new VirtualTarget(*this, "cmdline");
638 world->add_depend(cmdline);
639 for(list<string>::iterator i=cmdline_targets.begin(); i!=cmdline_targets.end(); ++i)
641 Target *tgt=get_target(*i);
643 tgt=get_target((cwd/ *i).str());
646 cerr<<"I don't know anything about "<<*i<<'\n';
649 cmdline->add_depend(tgt);
658 Check if a header exists, either as a target or a file. Either an existing
659 target or a new SystemHeader target will be returned.
661 Target *Builder::get_header(const Msp::Path::Path &fn)
663 Target *tgt=get_target(fn.str());
668 add_target(tgt=new SystemHeader(*this, fn.str()));
674 Target *Builder::get_library(const string &lib, const Path::Path &path, LibMode mode)
679 full=(path/("lib"+lib+".a")).str();
680 Target *tgt=get_target(full);
681 // Targets can only be associated with buildable packages (or no package at all)
682 if(tgt && (tgt->get_package() || mode==ALL_STATIC)) return tgt;
686 full=(path/("lib"+lib+".so")).str();
687 Target *tgt=get_target(full);
691 if(Path::exists(full))
693 Target *tgt=new SystemLibrary(*this, full);
702 Adds a target to both the target map and the new target queue.
704 void Builder::add_target(Target *t)
706 targets.insert(TargetMap::value_type(t->get_name(), t));
707 new_tgts.push_back(t);
711 Updates a hash with a string. This is used from get_header and get_library.
713 void Builder::update_hash(string &hash, const string &value)
715 for(unsigned i=0; i<value.size(); ++i)
716 hash[i%hash.size()]^=value[i];
720 This function supervises the build process, starting new actions when slots
725 Target *cmdline=get_target("cmdline");
727 unsigned total=cmdline->count_rebuild();
730 cout<<"Already up to date\n";
733 cout<<"Will build "<<total<<" target(s)\n";
735 vector<Action *> actions;
738 cout<<"0 targets built\n";
746 if(actions.size()<jobs && !fail)
748 Target *tgt=cmdline->get_buildable_target();
751 Action *action=tgt->build();
753 actions.push_back(action);
755 else if(actions.empty())
759 Time::sleep(10*Time::msec);
761 for(unsigned i=0; i<actions.size();)
763 int status=actions[i]->check();
769 cout<<"\e["<<actions.size()+1<<'A';
770 cout<<count<<" targets built\n";
774 if(i<actions.size()-1)
775 cout<<"\e["<<actions.size()-i-1<<"B";
779 actions.erase(actions.begin()+i);
782 if(actions.empty() && fail)
791 cout<<"Build failed\n";
797 Prints out information about the default package.
799 void Builder::package_help()
801 const Config &config=default_pkg->get_config();
802 const Config::OptionMap &options=config.get_options();
804 cout<<"Required packages:\n ";
805 const PkgRefList &requires=default_pkg->get_requires();
806 for(PkgRefList::const_iterator i=requires.begin(); i!=requires.end(); ++i)
808 if(i!=requires.begin())
813 cout<<"Package configuration:\n";
814 for(Config::OptionMap::const_iterator i=options.begin(); i!=options.end(); ++i)
816 const Config::Option &opt=i->second;
817 cout<<" "<<opt.name<<": "<<opt.descr<<" ("<<opt.value<<") ["<<opt.defv<<"]\n";
821 Application::RegApp<Builder> Builder::reg;
823 Builder::Loader::Loader(Builder &b, const Path::Path &s):
827 add("package", &Loader::package);
830 void Builder::Loader::package(const string &n)
832 Package *pkg=new Package(bld, n, src);
834 bld.packages.insert(PackageMap::value_type(n, pkg));
835 bld.new_pkgs.push_back(pkg);