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