// file : build/b.cxx -*- C++ -*- // copyright : Copyright (c) 2014-2015 Code Synthesis Ltd // license : MIT; see accompanying LICENSE file #include // tzset() #include // strerror() #include // getenv() #include // getuid() #include // uid_t #include // struct passwd, getpwuid() #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include using namespace std; namespace build { // Given an src_base directory, look for the project's src_root // based on the presence of known special files. Return empty // path if not found. // dir_path find_src_root (const dir_path& b) { for (dir_path d (b); !d.root () && d != home; d = d.directory ()) { if (is_src_root (d)) return d; } return dir_path (); } // The same but for out. Note that we also check whether a // directory happens to be src_root, in case this is an in- // tree build. // dir_path find_out_root (const dir_path& b, bool& src) { for (dir_path d (b); !d.root () && d != home; d = d.directory ()) { if ((src = is_src_root (d)) || is_out_root (d)) return d; } src = false; return dir_path (); } } #include #include //@@ tmp #include //@@ tmp #include #include //@@ tmp #include //@@ tmp #include #include using namespace build; int main (int argc, char* argv[]) { try { tracer trace ("main"); cl::argv_scanner scan (argc, argv, true); options ops (scan); // Version. // if (ops.version ()) { cout << "build2 0.0.0" << endl << "Copyright (c) 2014-2015 Code Synthesis Ltd" << endl << "This is free software released under the MIT license. " << endl; return 0; } // Help. // if (ops.help ()) { ostream& o (cout); o << "Usage: " << argv[0] << " [options] [variables] [buildspec]" << endl << "Options:" << endl; options::print_usage (o); return 0; } // Trace verbosity. // verb = ops.verbose () > 0 ? ops.verbose () : (ops.v () ? 1 : 0); // Initialize time conversion data that is used by localtime_r(). // tzset (); // Register modules. // modules["config"] = &config::init; modules["bin"] = &bin::init; modules["cxx"] = &cxx::init; modules["cli"] = &cli::init; // Register target types. // target_types.insert (file::static_type); target_types.insert (dir::static_type); target_types.insert (fsdir::static_type); target_types.insert (bin::obja::static_type); target_types.insert (bin::objso::static_type); target_types.insert (bin::obj::static_type); target_types.insert (bin::exe::static_type); target_types.insert (bin::liba::static_type); target_types.insert (bin::libso::static_type); target_types.insert (bin::lib::static_type); target_types.insert (cxx::h::static_type); target_types.insert (cxx::c::static_type); target_types.insert (cxx::cxx::static_type); target_types.insert (cxx::hxx::static_type); target_types.insert (cxx::ixx::static_type); target_types.insert (cxx::txx::static_type); // Register rules. // bin::obj_rule obj_rule; bin::lib_rule lib_rule; { using namespace bin; rules[default_id][typeid (obj)].emplace ("bin.obj", obj_rule); rules[update_id][typeid (obj)].emplace ("bin.obj", obj_rule); rules[clean_id][typeid (obj)].emplace ("bin.obj", obj_rule); rules[default_id][typeid (lib)].emplace ("bin.lib", lib_rule); rules[update_id][typeid (lib)].emplace ("bin.lib", lib_rule); rules[clean_id][typeid (lib)].emplace ("bin.lib", lib_rule); } cxx::compile cxx_compile; cxx::link cxx_link; { using namespace bin; rules[default_id][typeid (obja)].emplace ("cxx.gnu.compile", cxx_compile); rules[update_id][typeid (obja)].emplace ("cxx.gnu.compile", cxx_compile); rules[clean_id][typeid (obja)].emplace ("cxx.gnu.compile", cxx_compile); rules[default_id][typeid (objso)].emplace ("cxx.gnu.compile", cxx_compile); rules[update_id][typeid (objso)].emplace ("cxx.gnu.compile", cxx_compile); rules[clean_id][typeid (objso)].emplace ("cxx.gnu.compile", cxx_compile); rules[default_id][typeid (exe)].emplace ("cxx.gnu.link", cxx_link); rules[update_id][typeid (exe)].emplace ("cxx.gnu.link", cxx_link); rules[clean_id][typeid (exe)].emplace ("cxx.gnu.link", cxx_link); rules[default_id][typeid (liba)].emplace ("cxx.gnu.link", cxx_link); rules[update_id][typeid (liba)].emplace ("cxx.gnu.link", cxx_link); rules[clean_id][typeid (liba)].emplace ("cxx.gnu.link", cxx_link); rules[default_id][typeid (libso)].emplace ("cxx.gnu.link", cxx_link); rules[update_id][typeid (libso)].emplace ("cxx.gnu.link", cxx_link); rules[clean_id][typeid (libso)].emplace ("cxx.gnu.link", cxx_link); } dir_rule dir_r; rules[default_id][typeid (dir)].emplace ("dir", dir_r); rules[update_id][typeid (dir)].emplace ("dir", dir_r); rules[clean_id][typeid (dir)].emplace ("dir", dir_r); fsdir_rule fsdir_r; rules[default_id][typeid (fsdir)].emplace ("fsdir", fsdir_r); rules[update_id][typeid (fsdir)].emplace ("fsdir", fsdir_r); rules[clean_id][typeid (fsdir)].emplace ("fsdir", fsdir_r); file_rule file_r; rules[default_id][typeid (file)].emplace ("file", file_r); rules[update_id][typeid (file)].emplace ("file", file_r); rules[clean_id][typeid (file)].emplace ("file", file_r); // Figure out work and home directories. // work = dir_path::current (); if (const char* h = getenv ("HOME")) home = dir_path (h); else { struct passwd* pw (getpwuid (getuid ())); if (pw == nullptr) { const char* msg (strerror (errno)); fail << "unable to determine home directory: " << msg; } home = dir_path (pw->pw_dir); } if (verb >= 4) { trace << "work dir: " << work; trace << "home dir: " << home; } // Initialize the dependency state. // reset (); // Parse command line variables. They should come before the // buildspec. // int argi (1); for (; argi != argc; argi++) { const char* s (argv[argi]); istringstream is (s); is.exceptions (istringstream::failbit | istringstream::badbit); lexer l (is, ""); token t (l.next ()); if (t.type () == token_type::eos) continue; // Whitespace-only argument. // Unless this is a name followed by = or +=, assume it is // a start of the buildspec. // if (t.type () != token_type::name) break; token_type tt (l.next ().type ()); if (tt != token_type::equal && tt != token_type::plus_equal) break; parser p; t = p.parse_variable (l, *global_scope, t.name (), tt); if (t.type () != token_type::eos) fail << "unexpected " << t << " in variable " << s; } // Parse the buildspec. // buildspec bspec; { // Merge all the individual buildspec arguments into a single // string. Instead, we could also parse them individually ( // and merge the result). The benefit of doing it this way // is potentially better diagnostics (i.e., we could have // used , to give the idea about // which argument is invalid). // string s; for (; argi != argc;) { s += argv[argi]; if (++argi != argc) s += ' '; } istringstream is (s); is.exceptions (istringstream::failbit | istringstream::badbit); parser p; try { bspec = p.parse_buildspec (is, ""); } catch (const std::ios_base::failure&) { fail << "failed to parse buildspec string"; } } level4 ([&]{trace << "buildspec: " << bspec;}); if (bspec.empty ()) bspec.push_back (metaopspec ()); // Default meta-operation. for (metaopspec& ms: bspec) { if (ms.empty ()) ms.push_back (opspec ()); // Default operation. meta_operation_id mid (0); // Not yet translated. const meta_operation_info* mif (nullptr); bool lifted (false); // See below. for (opspec& os: ms) { const location l ("", 1, 0); //@@ TODO if (os.empty ()) // Default target: dir{}. os.push_back (targetspec (name ("dir", dir_path (), string ()))); operation_id oid (0); // Not yet translated. const operation_info* oif (nullptr); action act (0, 0); // Not yet initialized. // We do meta-operation and operation batches sequentially (no // parallelism). But multiple targets in an operation batch // can be done in parallel. // action_targets tgs; tgs.reserve (os.size ()); // If the previous operation was lifted to meta-operation, // end the meta-operation batch. // if (lifted) { if (mif->meta_operation_post != nullptr) mif->meta_operation_post (); level4 ([&]{trace << "end meta-operation batch " << mif->name << ", id " << static_cast (mid);}); mid = 0; lifted = false; } for (targetspec& ts: os) { name& tn (ts.name); // First figure out the out_base of this target. The logic // is as follows: if a directory was specified in any form, // then that's the out_base. Otherwise, we check if the name // value has a directory prefix. This has a good balance of // control and the expected result in most cases. // dir_path out_base (tn.dir); if (out_base.empty ()) { const string& v (tn.value); // Handle a few common cases as special: empty name, '.', // '..', as well as dir{foo/bar} (without trailing '/'). // This code must be consistent with target_type_map::find(). // if (v.empty () || v == "." || v == ".." || tn.type == "dir") out_base = dir_path (v); // // Otherwise, if this is a simple name, see if there is a // directory part in value. // else if (tn.type.empty ()) { // We cannot assume it is a valid filesystem name so we // will have to do the splitting manually. // path::size_type i (path::traits::rfind_separator (v)); if (i != string::npos) out_base = dir_path (v, i != 0 ? i : 1); // Special case: "/". } } if (out_base.relative ()) out_base = work / out_base; out_base.normalize (); // The order in which we determine the roots depends on whether // src_base was specified explicitly. There will also be a few // cases where we are guessing things that can turn out wrong. // Keep track of that so that we can issue more extensive // diagnostics for such cases. // bool guessing (false); dir_path src_root; dir_path out_root; dir_path& src_base (ts.src_base); // Update it in buildspec. if (!src_base.empty ()) { if (src_base.relative ()) src_base = work / src_base; src_base.normalize (); // If the src_base was explicitly specified, search for src_root. // src_root = find_src_root (src_base); // If not found, assume this is a simple project with src_root // being the same as src_base. // if (src_root.empty ()) { src_root = src_base; out_root = out_base; } else // Calculate out_root based on src_root/src_base. // out_root = out_base.directory (src_base.leaf (src_root)); } else { // If no src_base was explicitly specified, search for out_root. // bool src; out_root = find_out_root (out_base, src); // If not found (i.e., we have no idea where the roots are), // then this can mean two things: an in-tree build of a // simple project or a fresh out-of-tree build. To test for // the latter, try to find src_root starting from work. If // we can't, then assume it is the former case. // if (out_root.empty ()) { src_root = find_src_root (work); if (!src_root.empty ()) { src_base = work; if (src_root != src_base) { try { out_root = out_base.directory (src_base.leaf (src_root)); } catch (const invalid_path&) { fail << "out_base directory suffix does not match src_base" << info << "src_base is " << src_base << info << "src_root is " << src_root << info << "out_base is " << out_base << info << "consider explicitly specifying src_base " << "for " << tn; } } else out_root = out_base; } else src_root = src_base = out_root = out_base; guessing = true; } else if (src) src_root = out_root; } // Now we know out_root and, if it was explicitly specified // or the same as out_root, src_root. The next step is to // create the root scope and load the out_root bootstrap // files, if any. Note that we might already have done this // as a result of one of the preceding target processing. // // If we know src_root, set that variable as well. This could // be of use to the bootstrap file (other than src-root.build, // which, BTW, doesn't need to exist if src_root == out_root). // scope& rs (create_root (out_root, src_root)); bootstrap_out (rs); // See if the bootstrap process set/changed src_root. // { auto v (rs.assign ("src_root")); if (v) { // If we also have src_root specified by the user, make // sure they match. // const dir_path& p (v.as ()); if (src_root.empty ()) src_root = p; else if (src_root != p) fail << "bootstrapped src_root " << p << " does not match " << "specified " << src_root; } else { // Bootstrap didn't produce src_root. // if (src_root.empty ()) { // If it also wasn't explicitly specified, see if it is // the same as out_root. // if (is_src_root (out_root)) src_root = out_root; else { // If not, then assume we are running from src_base // and calculate src_root based on out_root/out_base. // src_base = work; src_root = src_base.directory (out_base.leaf (out_root)); guessing = true; } } v = src_root; } rs.src_path_ = &v.as (); } // At this stage we should have both roots and out_base figured // out. If src_base is still undetermined, calculate it. // if (src_base.empty ()) src_base = src_root / out_base.leaf (out_root); // Now that we have src_root, load the src_root bootstrap file, // if there is one. // bool bootstrapped (bootstrap_src (rs)); // Check that out_root that we have found is the innermost root // for this project. If it is not, then it means we are trying // to load a disfigured sub-project and that we do not support. // Why don't we support it? Because things are already complex // enough here. // if (auto v = rs.vars["subprojects"]) { for (const name& n: v.as ()) { // Should be a list of directories. // if (!n.type.empty () || !n.value.empty () || n.dir.empty ()) fail << "expected directory in subprojects variable " << "instead of " << n; if (out_base.sub (out_root / n.dir)) fail << tn << " is in a subproject of " << out_root << info << "explicitly specify src_base for this target"; } } // Create and bootstrap outer roots if any. Loading is done // by load_root_pre() (that would normally be called by the // meta-operation's load() callback below). // create_bootstrap_outer (rs); // The src bootstrap should have loaded all the modules that // may add new meta/operations. So at this stage they should // all be known. We store the combined action id in uint8_t; // see for details. // assert (rs.operations.size () <= 128); assert (rs.meta_operations.size () <= 128); // Since we now know all the names of meta-operations and // operations, "lift" names that we assumed (from buildspec // syntax) were operations but are actually meta-operations. // Also convert empty names (which means they weren't explicitly // specified) to the defaults and verify that all the names are // known. // { const auto& mn (ms.name); const auto& on (os.name); meta_operation_id m (0); operation_id o (0); if (!on.empty ()) { m = rs.meta_operations.find (on); if (m != 0) { if (!mn.empty ()) fail (l) << "nested meta-operation " << mn << '(' << on << ')'; if (!lifted) // If this is the first target. { // End the previous meta-operation batch if there was one // and start a new one. // if (mid != 0) { assert (oid == 0); if (mif->meta_operation_post != nullptr) mif->meta_operation_post (); level4 ([&]{trace << "end meta-operation batch " << mif->name << ", id " << static_cast (mid);}); mid = 0; } lifted = true; // Flag to also end it; see above. } } else { o = rs.operations.find (on); if (o == 0) { diag_record dr; dr << fail (l) << "unknown operation " << on; // If we guessed src_root and didn't load anything during // bootstrap, then this is probably a meta-operation that // would have been added by the module if src_root was // correct. // if (guessing && !bootstrapped) dr << info << "consider explicitly specifying src_base " << "for " << tn; } } } if (!mn.empty ()) { m = rs.meta_operations.find (mn); if (m == 0) { diag_record dr; dr << fail (l) << "unknown meta-operation " << mn; // Same idea as for the operation case above. // if (guessing && !bootstrapped) dr << info << "consider explicitly specifying src_base " << "for " << tn; } } // The default meta-operation is perform. The default // operation is assigned by the meta-operation below. // if (m == 0) m = perform_id; // If this is the first target in the meta-operation batch, // then set the batch meta-operation id. // if (mid == 0) { mid = m; mif = &rs.meta_operations[mid].get (); level4 ([&]{trace << "start meta-operation batch " << mif->name << ", id " << static_cast (mid);}); if (mif->meta_operation_pre != nullptr) mif->meta_operation_pre (); } // // Otherwise, check that all the targets in a meta-operation // batch have the same meta-operation implementation. // else { if (mid > rs.meta_operations.size () || // Not a valid index. mif != &rs.meta_operations[mid].get ()) // Not the same impl. fail (l) << "different meta-operation implementations " << "in a meta-operation batch"; } // If this is the first target in the operation batch, then set // the batch operation id. // if (oid == 0) { if (o == 0) o = default_id; oif = &rs.operations[o].get (); level4 ([&]{trace << "start operation batch " << oif->name << ", id " << static_cast (o);}); // Allow the meta-operation to translate the operation. // if (mif->operation_pre != nullptr) oid = mif->operation_pre (o); else // Otherwise translate default to update. oid = (o == default_id ? update_id : o); if (o != oid) { oif = &rs.operations[oid].get (); level4 ([&]{trace << "operation translated to " << oif->name << ", id " << static_cast (oid);}); } act = action (mid, oid); current_mif = mif; current_oif = oif; current_mode = oif->mode; current_rules = &rules[oid]; } // // Similar to meta-operations, check that all the targets in // an operation batch have the same operation implementation. // else { if (oid > rs.operations.size () || // Not a valid index. oif != &rs.operations[oid].get ()) // Not the same impl. fail (l) << "different operation implementations " << "in an operation batch"; } } if (verb >= 4) { trace << "target " << tn << ':'; trace << " out_base: " << out_base; trace << " src_base: " << src_base; trace << " out_root: " << out_root; trace << " src_root: " << src_root; } path bf (src_base / path ("buildfile")); // If we were guessing src_base, check that the buildfile // exists and if not, issue more detailed diagnostics. // if (guessing && !file_exists (bf)) fail << bf << " does not exist" << info << "consider explicitly specifying src_base " << "for " << tn; // Load the buildfile. // mif->load (bf, rs, out_base, src_base, l); // Next resolve and match the target. We don't want to start // building before we know how to for all the targets in this // operation batch. // { const string* e; const target_type* ti (target_types.find (tn, e)); if (ti == nullptr) fail (l) << "unknown target type " << tn.type; // If the directory is relative, assume it is relative to work // (must be consistent with how we derived out_base above). // dir_path& d (tn.dir); if (d.relative ()) d = work / d; d.normalize (); mif->match (act, rs, target_key {ti, &d, &tn.value, &e}, l, tgs); } } // Now execute the action on the list of targets. // mif->execute (act, tgs); if (mif->operation_post != nullptr) mif->operation_post (oid); level4 ([&]{trace << "end operation batch " << oif->name << ", id " << static_cast (oid);}); } if (mif->meta_operation_post != nullptr) mif->meta_operation_post (); level4 ([&]{trace << "end meta-operation batch " << mif->name << ", id " << static_cast (mid);}); } } catch (const failed&) { return 1; // Diagnostics has already been issued. } /* catch (const std::exception& e) { error << e.what (); return 1; } */ }