3 This file is part of builder
4 Copyright © 2006-2007 Mikko Rasa, Mikkosoft Productions
5 Distributed under the LGPL
11 #include <msp/core/error.h>
12 #include <msp/core/getopt.h>
13 #include <msp/datafile/parser.h>
14 #include <msp/path/utils.h>
15 #include <msp/strings/utils.h>
16 #include <msp/time/units.h>
17 #include <msp/time/utils.h>
25 #include "pkgconfig.h"
26 #include "sharedlibrary.h"
27 #include "systemlibrary.h"
30 #include "virtualtarget.h"
35 Builder::Builder(int argc, char **argv):
48 create_makefile(false)
52 bool full_paths=false;
56 getopt.add_option('a', "analyze", analyze_mode, GetOpt::REQUIRED_ARG);
57 getopt.add_option('b', "build", build, GetOpt::NO_ARG);
58 getopt.add_option('c', "clean", clean, GetOpt::NO_ARG);
59 getopt.add_option('f', "file", build_file, GetOpt::REQUIRED_ARG);
60 getopt.add_option('h', "help", help, GetOpt::NO_ARG);
61 getopt.add_option('j', "jobs", jobs, GetOpt::REQUIRED_ARG);
62 getopt.add_option('n', "dry-run", dry_run, GetOpt::NO_ARG);
63 getopt.add_option('v', "verbose", verbose, GetOpt::NO_ARG);
64 getopt.add_option('A', "conf-all", conf_all, GetOpt::NO_ARG);
65 getopt.add_option('B', "build-all", build_all, GetOpt::NO_ARG);
66 getopt.add_option('C', "chdir", work_dir, GetOpt::REQUIRED_ARG);
67 getopt.add_option('W', "what-if", what_if, GetOpt::REQUIRED_ARG);
68 getopt.add_option( "chrome", chrome, GetOpt::NO_ARG);
69 getopt.add_option( "conf-only", conf_only, GetOpt::NO_ARG);
70 getopt.add_option( "full-paths", full_paths, GetOpt::NO_ARG);
71 //getopt.add_option( "makefile", create_makefile, GetOpt::NO_ARG);
72 getopt.add_option( "max-depth", max_depth, GetOpt::REQUIRED_ARG);
75 if(!analyze_mode.empty())
77 analyzer=new Analyzer(*this);
79 if(analyze_mode=="deps")
80 analyzer->set_mode(Analyzer::DEPS);
81 else if(analyze_mode=="alldeps")
82 analyzer->set_mode(Analyzer::ALLDEPS);
83 else if(analyze_mode=="rebuild")
84 analyzer->set_mode(Analyzer::REBUILD);
85 else if(analyze_mode=="rdeps")
86 analyzer->set_mode(Analyzer::RDEPS);
88 throw UsageError("Invalid analyze mode");
90 analyzer->set_max_depth(max_depth);
91 analyzer->set_full_paths(full_paths);
93 else if(!clean && !create_makefile)
96 const list<string> &args=getopt.get_args();
97 for(list<string>::const_iterator i=args.begin(); i!=args.end(); ++i)
99 unsigned equal=i->find('=');
100 if(equal!=string::npos)
101 cmdline_options.insert(StringMap::value_type(i->substr(0, equal), i->substr(equal+1)));
103 cmdline_targets.push_back(*i);
106 if(cmdline_targets.empty())
107 cmdline_targets.push_back("default");
109 if(!work_dir.empty())
110 chdir(work_dir.c_str());
114 archs.insert(StringMap::value_type("native", ""));
115 archs.insert(StringMap::value_type("arm", "arm-linux-gnu"));
116 archs.insert(StringMap::value_type("win32", "i586-mingw32msvc"));
118 StringMap &native_tools=tools.insert(ToolMap::value_type("native", StringMap())).first->second;
119 native_tools.insert(StringMap::value_type("CC", "gcc"));
120 native_tools.insert(StringMap::value_type("CXX", "g++"));
121 native_tools.insert(StringMap::value_type("LD", "gcc"));
122 native_tools.insert(StringMap::value_type("LDXX", "g++"));
123 native_tools.insert(StringMap::value_type("AR", "ar"));
125 StringMap &release_profile=profile_tmpl.insert(ProfileTemplateMap::value_type("release", StringMap())).first->second;
126 release_profile.insert(StringMap::value_type("optimize", "3"));
127 release_profile.insert(StringMap::value_type("outdir", "$profile"));
129 StringMap &debug_profile=profile_tmpl.insert(ProfileTemplateMap::value_type("debug", StringMap())).first->second;
130 debug_profile.insert(StringMap::value_type("debug", "1"));
131 debug_profile.insert(StringMap::value_type("outdir", "$profile"));
133 for(StringMap::iterator i=archs.begin(); i!=archs.end(); ++i)
135 if(i->first=="native")
138 StringMap &arch_profile=profile_tmpl.insert(ProfileTemplateMap::value_type(i->first, StringMap())).first->second;
139 arch_profile.insert(StringMap::value_type("arch", i->first));
140 arch_profile.insert(StringMap::value_type("prefix", "$HOME/local/$arch"));
141 arch_profile.insert(StringMap::value_type("outdir", "$profile"));
146 Gets a package with the specified name, possibly creating it.
148 @param n Package name
150 @return Pointer to the package, or 0 if the package could not be located
152 Package *Builder::get_package(const string &n)
154 PackageMap::iterator i=packages.find(n);
155 if(i!=packages.end())
158 // Try to get source directory with pkgconfig
160 argv.push_back("pkg-config");
161 argv.push_back("--variable=source");
163 string srcdir=strip(run_command(argv));
167 dirs.push_back(srcdir);
169 // Make some other guesses about the source directory
171 if(!dirname.compare(0, 3, "msp"))
173 dirs.push_back(cwd/dirname);
174 dirs.push_back(cwd/".."/dirname);
176 // Go through the candidate directories and look for a Build file
177 for(PathList::iterator j=dirs.begin(); j!=dirs.end(); ++j)
178 if(!load_build_file(*j/"Build"))
181 if(i!=packages.end())
186 // Package source not found - create a binary package
187 Package *pkg=Package::create(*this, n);
188 packages.insert(PackageMap::value_type(n, pkg));
190 new_pkgs.push_back(pkg);
196 Returns the target with the given name, or 0 if no such target exists.
198 Target *Builder::get_target(const string &n) const
200 TargetMap::const_iterator i=targets.find(n);
207 Tries to locate a header included from a given location and with a given include
208 path. Considers known targets as well as existing files. If a matching target
209 is not found but a file exists, a new SystemHeader target will be created and
212 Target *Builder::get_header(const string &include, const string &, const string &from, const list<string> &path)
215 update_hash(hash, from);
216 for(list<string>::const_iterator i=path.begin(); i!=path.end(); ++i)
217 update_hash(hash, *i);
219 string id=hash+include;
220 TargetMap::iterator i=includes.find(id);
221 if(i!=includes.end())
224 string fn=include.substr(1);
226 if(include[0]=='"' && (tgt=get_header(Path::Path(from)/fn)))
228 else if((tgt=get_header(Path::Path("/usr/include")/fn)))
230 //XXX Determine the C++ header location dynamically
231 else if((tgt=get_header(Path::Path("/usr/include/c++/4.1.2")/fn)))
235 for(list<string>::const_iterator j=path.begin(); (j!=path.end() && !tgt); ++j)
236 tgt=get_header(cwd/ *j/fn);
239 includes.insert(TargetMap::value_type(id, tgt));
245 Tries to locate a library with the given library path. Considers known targets
246 as well as existing files. If a matching target is not found but a file exists,
247 a new SystemLibrary target will be created and returned.
249 @param lib Name of the library to get (without "lib" prefix or extension)
250 @param path List of paths to search for the library
251 @param mode Shared / static mode
253 @return Some kind of library target, if a match was found
255 Target *Builder::get_library(const string &lib, const string &arch, const list<string> &path, LibMode mode)
258 for(list<string>::const_iterator i=path.begin(); i!=path.end(); ++i)
259 update_hash(hash, *i);
261 //XXX Incorporate mode into id
263 TargetMap::iterator i=libraries.find(id);
264 if(i!=libraries.end())
270 syspath.push_back("/lib");
271 syspath.push_back("/usr/lib");
274 syspath.push_back("/usr/"+get_arch_prefix(arch)+"/lib");
277 for(StringList::iterator j=syspath.begin(); (!tgt && j!=syspath.end()); ++j)
278 tgt=get_library(lib, arch, *j, mode);
279 for(StringList::const_iterator j=path.begin(); (!tgt && j!=path.end()); ++j)
280 tgt=get_library(lib, arch, cwd/ *j, mode);
282 libraries.insert(TargetMap::value_type(id, tgt));
287 const string &Builder::get_arch_prefix(const string &arch) const
289 StringMap::const_iterator i=archs.find(arch);
291 throw InvalidParameterValue("Unknown architecture");
296 string Builder::get_tool(const std::string &tool, const std::string &arch)
298 ToolMap::iterator i=tools.find(arch);
301 StringMap::iterator j=i->second.find(tool);
302 if(j!=i->second.end())
306 // Either the arch, or the tool within the arch was not found
307 i=tools.find("native");
308 StringMap::iterator j=i->second.find(tool);
309 if(j==i->second.end())
310 throw InvalidParameterValue("Unknown tool");
312 return get_arch_prefix(arch)+"-"+j->second;
315 void Builder::apply_profile_template(Config &config, const string &pt) const
317 vector<string> parts=split(pt, '-');
319 for(vector<string>::iterator i=parts.begin(); i!=parts.end(); ++i)
321 ProfileTemplateMap::const_iterator j=profile_tmpl.find(*i);
322 if(j==profile_tmpl.end())
325 config.update(j->second);
330 Adds a target to both the target map and the new target queue. Called from
333 void Builder::add_target(Target *t)
335 targets.insert(TargetMap::value_type(t->get_name(), t));
336 new_tgts.push_back(t);
341 if(load_build_file(cwd/build_file))
343 cerr<<"No build info here.\n";
347 default_pkg=packages.begin()->second;
349 while(!new_pkgs.empty())
351 Package *pkg=new_pkgs.front();
352 new_pkgs.erase(new_pkgs.begin());
356 default_pkg->configure(cmdline_options, conf_all?2:1);
360 usage(0, "builder", false);
367 for(PackageMap::iterator i=packages.begin(); i!=packages.end(); ++i)
372 else if(i->second->get_buildable() && i->second->get_arch()!=default_pkg->get_arch())
373 prob="wrong architecture ("+i->second->get_arch()+")";
375 problems.insert(StringMap::value_type(i->first, prob));
378 if(!problems.empty())
380 cerr<<"The following problems were detected:\n";
381 for(StringMap::iterator i=problems.begin(); i!=problems.end(); ++i)
382 cerr<<" "<<i->first<<": "<<i->second<<'\n';
383 cerr<<"Please fix them and try again.\n";
393 cout<<packages.size()<<" packages, "<<targets.size()<<" targets\n";
396 for(PackageMap::iterator i=packages.begin(); i!=packages.end(); ++i)
398 cout<<' '<<i->second->get_name();
399 if(i->second->get_buildable())
402 unsigned ood_count=0;
403 for(TargetMap::iterator j=targets.begin(); j!=targets.end(); ++j)
404 if(j->second->get_package()==i->second)
407 if(j->second->get_rebuild())
412 cout<<" ("<<count<<" targets";
414 cout<<", "<<ood_count<<" out-of-date";
427 exit_code=do_clean();
429 exit_code=do_build();
436 for(PackageMap::iterator i=packages.begin(); i!=packages.end(); ++i)
438 for(TargetMap::iterator i=targets.begin(); i!=targets.end(); ++i)
443 void Builder::usage(const char *reason, const char *argv0, bool brief)
449 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> ...]";
453 "Usage: "<<argv0<<" [options] [<target> ...]\n"
456 " -a, --analyze MODE Perform analysis. MODE can be deps, alldeps or rebuild.\n"
457 " -b, --build Perform build even if doing analysis.\n"
458 " -c, --clean Clean buildable targets.\n"
459 " -f, --file FILE Read info from FILE instead of Build.\n"
460 " -h, --help Print this message.\n"
461 " -j, --jobs NUM Run NUM commands at once, whenever possible.\n"
462 " -n, --dry-run Don't actually do anything, only show what would be done.\n"
463 " -v, --verbose Print more information about what's going on.\n"
464 " -A, --conf-all Apply configuration to all packages.\n"
465 " -B, --build-all Build all targets unconditionally.\n"
466 " -C, --chdir DIR Change to DIR before doing anything else.\n"
467 " -W, --what-if FILE Pretend that FILE has changed.\n"
468 " --chrome Use extra chrome to print status.\n"
469 " --conf-only Stop after configuring packages.\n"
470 " --full-paths Output full paths in analysis.\n"
471 //" --makefile Create a makefile for this package.\n"
472 " --max-depth NUM Maximum depth to show in analysis.\n";
477 Loads the given build file.
479 @param fn Path to the file
481 @return 0 on success, -1 if the file could not be opened
483 int Builder::load_build_file(const Path::Path &fn)
485 ifstream in(fn.str().c_str());
489 DataFile::Parser parser(in, fn.str());
490 Loader loader(*this, fn.subpath(0, fn.size()-1));
497 Creates targets for all packages and prepares them for building.
499 @return 0 if everything went ok, -1 if something bad happened and a build
500 shouldn't be attempted
502 int Builder::create_targets()
504 Target *world=new VirtualTarget(*this, "world");
506 Target *def_tgt=new VirtualTarget(*this, "default");
507 world->add_depend(def_tgt);
509 Target *install=new VirtualTarget(*this, "install");
510 world->add_depend(install);
512 Target *tarballs=new VirtualTarget(*this, "tarballs");
513 world->add_depend(tarballs);
515 for(PackageMap::iterator i=packages.begin(); i!=packages.end(); ++i)
519 if(!i->second->get_buildable())
522 const ComponentList &components=i->second->get_components();
523 for(ComponentList::const_iterator j=components.begin(); j!=components.end(); ++j)
526 if(i->second->get_install_flags()&(Package::LIB|Package::INCLUDE))
528 PkgConfig *pc=new PkgConfig(*this, *i->second);
529 install->add_depend(new Install(*this, *i->second, *pc));
532 tarballs->add_depend(new TarBall(*this, *i->second));
535 // Find dependencies until no new targets are created
536 while(!new_tgts.empty())
538 Target *tgt=new_tgts.front();
539 new_tgts.erase(new_tgts.begin());
541 if(!tgt->get_depends_ready())
542 new_tgts.push_back(tgt);
546 for(StringList::iterator i=what_if.begin(); i!=what_if.end(); ++i)
548 Target *tgt=get_target((cwd/ *i).str());
551 cerr<<"Unknown what-if target "<<*i<<'\n';
557 // Make the cmdline target depend on all targets mentioned on the command line
558 Target *cmdline=new VirtualTarget(*this, "cmdline");
559 bool build_world=false;
560 for(list<string>::iterator i=cmdline_targets.begin(); i!=cmdline_targets.end(); ++i)
562 Target *tgt=get_target(*i);
564 tgt=get_target((cwd/ *i).str());
567 cerr<<"I don't know anything about "<<*i<<'\n';
572 cmdline->add_depend(tgt);
575 /* If world is to be built, prepare cmdline. If not, add cmdline to world
576 and prepare world. I don't really like this, but it keeps the graph
582 world->add_depend(cmdline);
590 Check if a header exists, either as a target or a file. Either an existing
591 target or a new SystemHeader target will be returned.
593 Target *Builder::get_header(const Msp::Path::Path &fn)
595 Target *tgt=get_target(fn.str());
600 tgt=new SystemHeader(*this, fn.str());
606 Target *Builder::get_library(const string &lib, const string &arch, const Path::Path &path, LibMode mode)
608 // Populate a list of candidate filenames
609 StringList candidates;
614 candidates.push_back("lib"+lib+".dll");
616 candidates.push_back("lib"+lib+".so");
619 /* Static libraries are always considered, since sometimes shared versions
620 may not be available */
621 candidates.push_back("lib"+lib+".a");
623 candidates.push_back("lib"+lib+".dll.a");
625 for(StringList::iterator i=candidates.begin(); i!=candidates.end(); ++i)
627 string full=(path/ *i).str();
628 Target *tgt=get_target(full);
632 Target *real_tgt=tgt;
633 if(dynamic_cast<Install *>(tgt))
634 real_tgt=real_tgt->get_depends().front();
636 /* Ignore dynamic libraries from local packages unless library mode is
638 if(dynamic_cast<SharedLibrary *>(real_tgt) && mode!=DYNAMIC)
643 else if(Path::exists(full))
645 tgt=new SystemLibrary(*this, full);
654 Updates a hash with a string. This is used from get_header and get_library.
656 void Builder::update_hash(string &hash, const string &value)
658 for(unsigned i=0; i<value.size(); ++i)
659 hash[i%hash.size()]^=value[i];
663 This function supervises the build process, starting new actions when slots
666 int Builder::do_build()
668 Target *cmdline=get_target("cmdline");
670 unsigned total=cmdline->count_rebuild();
673 cout<<"Already up to date\n";
676 cout<<"Will build "<<total<<" target(s)\n";
678 vector<Action *> actions;
681 cout<<"0 targets built\n";
689 if(actions.size()<jobs && !fail)
691 Target *tgt=cmdline->get_buildable_target();
694 Action *action=tgt->build();
696 actions.push_back(action);
698 else if(actions.empty())
702 Time::sleep(10*Time::msec);
704 for(unsigned i=0; i<actions.size();)
706 int status=actions[i]->check();
712 cout<<"\e["<<actions.size()+1<<'A';
713 cout<<count<<" targets built\n";
717 if(i<actions.size()-1)
718 cout<<"\e["<<actions.size()-i-1<<"B";
722 actions.erase(actions.begin()+i);
725 if(actions.empty() && fail)
734 cout<<"Build failed\n";
740 Cleans buildable targets. If clean is 1, cleans only this package. If
741 clean is 2 or greater, cleans all buildable packages.
743 int Builder::do_clean()
745 // Cleaning doesn't care about ordering, so a simpler method can be used
747 set<Target *> clean_tgts;
749 queue.push_back(get_target("cmdline"));
751 while(!queue.empty())
753 Target *tgt=queue.front();
754 queue.erase(queue.begin());
756 if(tgt->get_buildable() && (tgt->get_package()==default_pkg || clean>=2))
757 clean_tgts.insert(tgt);
759 const TargetList &deps=tgt->get_depends();
760 for(TargetList::const_iterator i=deps.begin(); i!=deps.end(); ++i)
761 if(!clean_tgts.count(*i))
765 for(set<Target *>::iterator i=clean_tgts.begin(); i!=clean_tgts.end(); ++i)
767 Action *action=new Unlink(*this, **i);
768 while(action->check()<0);
776 Prints out information about the default package.
778 void Builder::package_help()
780 const Config &config=default_pkg->get_config();
781 const Config::OptionMap &options=config.get_options();
783 cout<<"Required packages:\n ";
784 const PkgRefList &requires=default_pkg->get_requires();
785 for(PkgRefList::const_iterator i=requires.begin(); i!=requires.end(); ++i)
787 if(i!=requires.begin())
792 cout<<"Package configuration:\n";
793 for(Config::OptionMap::const_iterator i=options.begin(); i!=options.end(); ++i)
795 const Config::Option &opt=i->second;
796 cout<<" "<<opt.name<<": "<<opt.descr<<" ("<<opt.value<<") ["<<opt.defv<<"]\n";
800 Application::RegApp<Builder> Builder::reg;
802 Builder::Loader::Loader(Builder &b, const Path::Path &s):
806 add("package", &Loader::package);
809 void Builder::Loader::package(const string &n)
811 Package *pkg=new Package(bld, n, src);
813 bld.packages.insert(PackageMap::value_type(n, pkg));
814 bld.new_pkgs.push_back(pkg);