source/buildercli.cpp

   1 #include <msp/core/getopt.h>
   2 #include <msp/fs/dir.h>
   3 #include <msp/fs/stat.h>
   4 #include <msp/io/print.h>
   5 #include <msp/strings/format.h>
   6 #include <msp/strings/utils.h>
   7 #include "analyzer.h"
   8 #include "buildercli.h"
   9 #include "filetarget.h"
  10 #include "sourcepackage.h"
  11
  12 using namespace std;
  13 using namespace Msp;
  14
  15 BuilderCLI::BuilderCLI(int argc, char **argv):
  16         analyzer(0),
  17         build(false),
  18         clean(0),
  19         dry_run(false),
  20         help(false),
  21         show_progress(false),
  22         build_file("Build"),
  23         jobs(1),
  24         conf_all(false),
  25         conf_only(false),
  26         build_all(false),
  27         create_makefile(false)
  28 {
  29         string analyze_mode;
  30         string work_dir;
  31         bool full_paths = false;
  32         unsigned max_depth = 4;
  33         string prefix;
  34         string tempdir;
  35         string arch;
  36         bool no_externals = false;
  37         unsigned verbose = 1;
  38         bool silent = false;
  39         list<string> log_channels;
  40         string build_type;
  41
  42         GetOpt getopt;
  43         getopt.add_option('a', "analyze",    analyze_mode,  GetOpt::REQUIRED_ARG).set_help("Perform dependency analysis.", "MODE");
  44         getopt.add_option('b', "build",      build,         GetOpt::NO_ARG).set_help("Perform build even if also doing something else.");
  45         getopt.add_option('c', "clean",      clean,         GetOpt::NO_ARG).set_help("Clean buildable targets.");
  46         getopt.add_option('f', "file",       build_file,    GetOpt::REQUIRED_ARG).set_help("Read build instructions from FILE.", "FILE");
  47         getopt.add_option('h', "help",       help,          GetOpt::NO_ARG).set_help("Print this message.");
  48         getopt.add_option('j', "jobs",       jobs,          GetOpt::REQUIRED_ARG).set_help("Run up to NUM tasks in parallel.", "NUM");
  49         getopt.add_option('l', "log",        log_channels,  GetOpt::REQUIRED_ARG).set_help("Enable listed log channels.", "LIST");
  50         getopt.add_option('n', "dry-run",    dry_run,       GetOpt::NO_ARG).set_help("Show what would be done without actually doing it.");
  51         getopt.add_option('s', "silent",     silent,        GetOpt::NO_ARG).set_help("Don't print any messages other than errors.");
  52         getopt.add_option('t', "build-type", build_type,    GetOpt::REQUIRED_ARG).set_help("Set build type.", "TYPE");
  53         getopt.add_option('v', "verbose",    verbose,       GetOpt::NO_ARG).set_help("Print more information about what's going on.");
  54         getopt.add_option('x', "no-externals",no_externals, GetOpt::NO_ARG).set_help("Do not load external source packages.");
  55         getopt.add_option('A', "conf-all",   conf_all,      GetOpt::NO_ARG).set_help("Apply configuration to all packages.");
  56         getopt.add_option('B', "build-all",  build_all,     GetOpt::NO_ARG).set_help("Build all targets unconditionally.");
  57         getopt.add_option('C', "chdir",      work_dir,      GetOpt::REQUIRED_ARG).set_help("Change to DIR before doing anything else.", "DIR");
  58         getopt.add_option('P', "progress",   show_progress, GetOpt::NO_ARG).set_help("Display progress while building.");
  59         getopt.add_option('W', "what-if",    what_if,       GetOpt::REQUIRED_ARG).set_help("Pretend that FILE has changed.", "FILE");
  60         getopt.add_option(     "arch",       arch,          GetOpt::REQUIRED_ARG).set_help("Build for architecture ARCH.", "ARCH");
  61         getopt.add_option(     "conf-only",  conf_only,     GetOpt::NO_ARG).set_help("Stop after configuring packages.");
  62         getopt.add_option(     "full-paths", full_paths,    GetOpt::NO_ARG).set_help("Output full paths in analysis.");
  63         getopt.add_option(     "max-depth",  max_depth,     GetOpt::REQUIRED_ARG).set_help("Show up to NUM levels in analysis.", "NUM");
  64         getopt.add_option(     "prefix",     prefix,        GetOpt::REQUIRED_ARG).set_help("Install things to DIR.", "DIR");
  65         getopt.add_option(     "tempdir",    tempdir,       GetOpt::REQUIRED_ARG).set_help("Store temporary files in DIR.", "DIR");
  66         getopt.add_argument("target", cmdline_targets, GetOpt::OPTIONAL_ARG).set_help("Target(s) to build");
  67         getopt(argc, argv);
  68
  69         if(help)
  70         {
  71                 helpmsg = "Usage:\n  ";
  72                 helpmsg += getopt.generate_usage(argv[0], true);
  73                 helpmsg += "\n\n";
  74                 helpmsg += getopt.generate_help();
  75         }
  76
  77         if(silent)
  78                 --verbose;
  79         if(verbose>=1)
  80         {
  81                 logger.enable_channel("summary");
  82                 logger.enable_channel("tasks");
  83         }
  84         if(verbose>=2)
  85         {
  86                 logger.enable_channel("environment");
  87                 logger.enable_channel("packages");
  88                 logger.enable_channel("commands");
  89         }
  90         if(verbose>=3)
  91         {
  92                 logger.enable_channel("files");
  93                 logger.enable_channel("auxcommands");
  94         }
  95         for(list<string>::const_iterator i=log_channels.begin(); i!=log_channels.end(); ++i)
  96         {
  97                 vector<string> parts = split(*i, ',');
  98                 for(vector<string>::const_iterator j=parts.begin(); j!=parts.end(); ++j)
  99                         logger.enable_channel(*j);
 100         }
 101         builder.set_logger(&logger);
 102
 103         if(!analyze_mode.empty())
 104         {
 105                 analyzer = new Analyzer(builder);
 106
 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);
 115                 else
 116                         throw usage_error("Invalid analyze mode");
 117
 118                 analyzer->set_max_depth(max_depth);
 119                 analyzer->set_full_paths(full_paths);
 120         }
 121         else if(!clean && !create_makefile)
 122                 build = true;
 123
 124         const vector<string> &args = getopt.get_args();
 125         for(vector<string>::const_iterator i=args.begin(); i!=args.end(); ++i)
 126         {
 127                 string::size_type equal = i->find('=');
 128                 if(equal!=string::npos)
 129                         cmdline_options.insert(Config::InputOptions::value_type(i->substr(0, equal), i->substr(equal+1)));
 130                 else
 131                         cmdline_targets.push_back(*i);
 132         }
 133
 134         if(!work_dir.empty())
 135                 FS::chdir(work_dir);
 136
 137         cwd = FS::getcwd();
 138
 139         PackageManager &package_manager = builder.get_package_manager();
 140
 141         package_manager.append_package_path(cwd);
 142         package_manager.append_package_path(cwd/"..");
 143         package_manager.append_binary_package_path(FS::get_sys_data_dir(argv[0], "builder"));
 144
 145         package_manager.set_no_externals(no_externals);
 146
 147         builder.set_architecture(arch);
 148
 149         list<FS::Path> start_files;
 150         start_files.push_back(FS::get_sys_data_dir(argv[0], "builder")/"builderrc");
 151         start_files.push_back(FS::get_user_data_dir("builder")/"rc");
 152         for(list<FS::Path>::const_iterator i=start_files.begin(); i!=start_files.end(); ++i)
 153                 if(FS::exists(*i))
 154                         builder.load_build_file(*i);
 155
 156         if(!prefix.empty())
 157                 builder.set_prefix(cwd/prefix);
 158
 159         if(!tempdir.empty())
 160                 builder.set_temp_directory(tempdir);
 161
 162         if(!build_type.empty())
 163                 builder.set_build_type(build_type);
 164
 165         builder.add_default_tools();
 166 }
 167
 168 BuilderCLI::~BuilderCLI()
 169 {
 170         delete analyzer;
 171 }
 172
 173 int BuilderCLI::main()
 174 {
 175         FS::Path main_file = cwd/build_file;
 176         if(FS::exists(main_file))
 177                 builder.load_build_file(main_file, &cmdline_options, conf_all);
 178         else if(!help)
 179         {
 180                 IO::print(IO::cerr, "The file %s does not exist.\n", main_file);
 181                 return 1;
 182         }
 183
 184         if(help)
 185         {
 186                 IO::print("Builder 1.0\n"
 187                         "Copyright © 2006-2013  Mikkosoft Productions, Mikko Rasa\n"
 188                         "Licensed under the GPL\n\n"
 189                         "%s", helpmsg);
 190                 package_help();
 191                 return 0;
 192         }
 193
 194         if(!prepare_build())
 195                 return 1;
 196
 197         if(conf_only)
 198                 return 0;
 199
 200         const Architecture &native_arch = builder.get_native_arch();
 201         const Architecture &current_arch = builder.get_current_arch();
 202         logger.log("environment", format("Building on %s, for %s%s", native_arch.get_name(),
 203                 current_arch.get_name(), (current_arch.is_native() ? " (native)" : "")));
 204         logger.log("environment", format("Prefix is %s", builder.get_prefix()));
 205         const FS::Path &tempdir = builder.get_temp_directory();
 206         if(tempdir.is_absolute())
 207                 logger.log("environment", format("Temporary directory is %s", tempdir));
 208         else
 209                 logger.log("environment", format("Using per-package temporary directory %s", tempdir));
 210         const BuildType &build_type = builder.get_build_type();
 211         logger.log("environment", format("Build type is %s", build_type.get_name()));
 212
 213         BuildGraph &build_graph = builder.get_build_graph();
 214         PackageManager &package_manager = builder.get_package_manager();
 215         const PackageManager::PackageMap &packages = package_manager.get_packages();
 216         list<string> package_details;
 217         for(PackageManager::PackageMap::const_iterator i=packages.begin(); i!=packages.end(); ++i)
 218         {
 219                 if(!i->second->is_prepared())
 220                         continue;
 221
 222                 string line = i->second->get_name();
 223                 if(dynamic_cast<SourcePackage *>(i->second))
 224                 {
 225                         line += '*';
 226
 227                         unsigned count = 0;
 228                         unsigned to_be_built = 0;
 229                         const BuildGraph::TargetMap &targets = build_graph.get_targets();
 230                         for(BuildGraph::TargetMap::const_iterator j=targets.begin(); j!=targets.end(); ++j)
 231                                 if(j->second->get_package()==i->second)
 232                                 {
 233                                         ++count;
 234                                         if(j->second->needs_rebuild())
 235                                                 ++to_be_built;
 236                                 }
 237                         if(count)
 238                         {
 239                                 line += format(" (%d targets", count);
 240                                 if(to_be_built)
 241                                         line += format(", %d to be built", to_be_built);
 242                                 line += ')';
 243                         }
 244                 }
 245
 246                 package_details.push_back(line);
 247         }
 248
 249         logger.log("summary", format("%d active packages, %d targets", package_details.size(), build_graph.get_targets().size()));
 250         for(list<string>::const_iterator i=package_details.begin(); i!=package_details.end(); ++i)
 251                 logger.log("packages", *i);
 252
 253         if(analyzer)
 254                 analyzer->analyze();
 255
 256         const Builder::ProblemList &problems = builder.get_problems();
 257         if(!problems.empty())
 258         {
 259                 IO::print(IO::cerr, "The following problems were detected:\n");
 260                 for(Builder::ProblemList::const_iterator i=problems.begin(); i!=problems.end(); ++i)
 261                         IO::print(IO::cerr, "  %s: %s\n", i->package, i->descr);
 262                 if(!analyzer)
 263                         IO::print(IO::cerr, "Please fix them and try again.\n");
 264                 return 1;
 265         }
 266
 267         if(clean)
 268                 exit_code = builder.clean(clean>=2, dry_run);
 269         if(build)
 270                 exit_code = builder.build(jobs, dry_run, show_progress);
 271
 272         return exit_code;
 273 }
 274
 275 bool BuilderCLI::prepare_build()
 276 {
 277         /* XXX This is ugly; using the Builder class should not be this convoluted.
 278         But the command line targets and what ifs need to be set at certain points
 279         during preparation. */
 280         BuildGraph &build_graph = builder.get_build_graph();
 281         PackageManager &package_manager = builder.get_package_manager();
 282         VirtualFileSystem &vfs = builder.get_vfs();
 283
 284         package_manager.get_main_package().prepare();
 285
 286         // Add targets from command line as goals
 287         for(NameList::iterator i=cmdline_targets.begin(); i!=cmdline_targets.end(); ++i)
 288         {
 289                 Target *tgt = build_graph.get_target(*i);
 290                 if(!tgt)
 291                         tgt = vfs.get_target(*i);
 292                 if(!tgt)
 293                         tgt = vfs.get_target(cwd/ *i);
 294                 if(!tgt)
 295                 {
 296                         IO::print("I don't know anything about %s\n", *i);
 297                         return false;
 298                 }
 299
 300                 build_graph.add_goal(*tgt);
 301         }
 302
 303         build_graph.prepare();
 304
 305         // Apply what-ifs
 306         for(NameList::iterator i=what_if.begin(); i!=what_if.end(); ++i)
 307         {
 308                 FileTarget *tgt = vfs.get_target(cwd/ *i);
 309                 if(!tgt)
 310                 {
 311                         IO::print(IO::cerr, "Unknown what-if target %s\n", *i);
 312                         return false;
 313                 }
 314                 tgt->touch();
 315         }
 316
 317         if(build_all)
 318                 build_graph.force_full_rebuild();
 319
 320         if(!dry_run)
 321         {
 322                 const PackageManager::PackageMap &packages = package_manager.get_packages();
 323                 for(PackageManager::PackageMap::const_iterator i=packages.begin(); i!=packages.end(); ++i)
 324                         i->second->save_caches();
 325         }
 326
 327         return true;
 328 }
 329
 330 void BuilderCLI::package_help()
 331 {
 332         PackageManager &package_manager = builder.get_package_manager();
 333         if(package_manager.get_packages().empty())
 334                 return;
 335
 336         SourcePackage &main_pkg = dynamic_cast<SourcePackage &>(package_manager.get_main_package());
 337         const Config &config = main_pkg.get_config();
 338         const Config::OptionMap &options = config.get_options();
 339
 340         IO::print("\nRequired packages:\n  ");
 341         const Package::Requirements &requires = main_pkg.get_required_packages();
 342         for(Package::Requirements::const_iterator i=requires.begin(); i!=requires.end(); ++i)
 343         {
 344                 if(i!=requires.begin())
 345                         IO::print(", ");
 346                 IO::print((*i)->get_name());
 347         }
 348         IO::print("\n\nPackage configuration:\n");
 349         for(Config::OptionMap::const_iterator i=options.begin(); i!=options.end(); ++i)
 350         {
 351                 const Config::Option &opt = i->second;
 352                 IO::print("  %s: %s (%s)", opt.name, opt.description, opt.value);
 353                 if(opt.value!=opt.default_value)
 354                         IO::print(" [%s]", opt.default_value);
 355                 IO::print("\n");
 356         }
 357 }