| // Copyright 2011 Google Inc. All Rights Reserved. |
| // |
| // Licensed under the Apache License, Version 2.0 (the "License"); |
| // you may not use this file except in compliance with the License. |
| // You may obtain a copy of the License at |
| // |
| // http://www.apache.org/licenses/LICENSE-2.0 |
| // |
| // Unless required by applicable law or agreed to in writing, software |
| // distributed under the License is distributed on an "AS IS" BASIS, |
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| // See the License for the specific language governing permissions and |
| // limitations under the License. |
| |
| #ifndef NINJA_BUILD_H_ |
| #define NINJA_BUILD_H_ |
| |
| #include <cstdio> |
| #include <map> |
| #include <memory> |
| #include <queue> |
| #include <string> |
| #include <vector> |
| |
| #ifndef _WIN32 |
| #include <sys/resource.h> |
| #endif |
| |
| #include "depfile_parser.h" |
| #include "graph.h" // XXX needed for DependencyScan; should rearrange. |
| #include "exit_status.h" |
| #include "util.h" // int64_t |
| |
| struct BuildLog; |
| struct Builder; |
| struct DiskInterface; |
| struct Edge; |
| struct Node; |
| struct State; |
| struct Status; |
| |
| /// Plan stores the state of a build plan: what we intend to build, |
| /// which steps we're ready to execute. |
| struct Plan { |
| Plan(Builder* builder = NULL); |
| |
| /// Add a target to our plan (including all its dependencies). |
| /// Returns false if we don't need to build this target; may |
| /// fill in |err| with an error message if there's a problem. |
| bool AddTarget(Node* node, string* err); |
| |
| // Pop a ready edge off the queue of edges to build. |
| // Returns NULL if there's no work to do. |
| Edge* FindWork(); |
| |
| /// Returns true if there's more work to be done. |
| bool more_to_do() const { return wanted_edges_ > 0 && command_edges_ > 0; } |
| |
| /// Dumps the current state of the plan. |
| void Dump(); |
| |
| enum EdgeResult { |
| kEdgeFailed, |
| kEdgeSucceeded |
| }; |
| |
| /// Mark an edge as done building (whether it succeeded or failed). |
| /// If any of the edge's outputs are dyndep bindings of their dependents, |
| /// this loads dynamic dependencies from the nodes' paths. |
| /// Returns 'false' if loading dyndep info fails and 'true' otherwise. |
| bool EdgeFinished(Edge* edge, EdgeResult result, string* err); |
| |
| /// Clean the given node during the build. |
| /// Return false on error. |
| bool CleanNode(DependencyScan* scan, Node* node, string* err); |
| |
| /// Number of edges with commands to run. |
| int command_edge_count() const { return command_edges_; } |
| |
| /// Reset state. Clears want and ready sets. |
| void Reset(); |
| |
| /// Update the build plan to account for modifications made to the graph |
| /// by information loaded from a dyndep file. |
| bool DyndepsLoaded(DependencyScan* scan, Node* node, |
| const DyndepFile& ddf, string* err); |
| private: |
| bool RefreshDyndepDependents(DependencyScan* scan, Node* node, string* err); |
| void UnmarkDependents(Node* node, set<Node*>* dependents); |
| bool AddSubTarget(Node* node, Node* dependent, string* err, |
| set<Edge*>* dyndep_walk); |
| |
| /// Update plan with knowledge that the given node is up to date. |
| /// If the node is a dyndep binding on any of its dependents, this |
| /// loads dynamic dependencies from the node's path. |
| /// Returns 'false' if loading dyndep info fails and 'true' otherwise. |
| bool NodeFinished(Node* node, string* err); |
| |
| /// Enumerate possible steps we want for an edge. |
| enum Want |
| { |
| /// We do not want to build the edge, but we might want to build one of |
| /// its dependents. |
| kWantNothing, |
| /// We want to build the edge, but have not yet scheduled it. |
| kWantToStart, |
| /// We want to build the edge, have scheduled it, and are waiting |
| /// for it to complete. |
| kWantToFinish |
| }; |
| |
| void EdgeWanted(Edge* edge); |
| bool EdgeMaybeReady(map<Edge*, Want>::iterator want_e, string* err); |
| |
| /// Submits a ready edge as a candidate for execution. |
| /// The edge may be delayed from running, for example if it's a member of a |
| /// currently-full pool. |
| void ScheduleWork(map<Edge*, Want>::iterator want_e); |
| |
| /// Keep track of which edges we want to build in this plan. If this map does |
| /// not contain an entry for an edge, we do not want to build the entry or its |
| /// dependents. If it does contain an entry, the enumeration indicates what |
| /// we want for the edge. |
| map<Edge*, Want> want_; |
| |
| EdgeSet ready_; |
| |
| Builder* builder_; |
| |
| /// Total number of edges that have commands (not phony). |
| int command_edges_; |
| |
| /// Total remaining number of wanted edges. |
| int wanted_edges_; |
| }; |
| |
| /// CommandRunner is an interface that wraps running the build |
| /// subcommands. This allows tests to abstract out running commands. |
| /// RealCommandRunner is an implementation that actually runs commands. |
| struct CommandRunner { |
| virtual ~CommandRunner() {} |
| virtual bool CanRunMore() = 0; |
| virtual bool StartCommand(Edge* edge) = 0; |
| |
| /// The result of waiting for a command. |
| struct Result { |
| Result() : edge(NULL) {} |
| Edge* edge; |
| ExitStatus status; |
| #ifndef _WIN32 |
| struct rusage rusage; |
| #endif |
| string output; |
| bool success() const { return status == ExitSuccess; } |
| }; |
| /// Wait for a command to complete, or return false if interrupted. |
| virtual bool WaitForCommand(Result* result) = 0; |
| |
| virtual vector<Edge*> GetActiveEdges() { return vector<Edge*>(); } |
| virtual void Abort() {} |
| }; |
| |
| /// Options (e.g. verbosity, parallelism) passed to a build. |
| struct BuildConfig { |
| BuildConfig() : verbosity(NORMAL), dry_run(false), parallelism(1), |
| failures_allowed(1), max_load_average(-0.0f), |
| frontend(NULL), frontend_file(NULL), |
| missing_depfile_should_err(false), |
| uses_symlink_outputs(false), |
| undeclared_symlink_outputs_should_err(false), |
| uses_phony_outputs(false), |
| output_directory_should_err(false), |
| missing_output_file_should_err(false), |
| old_output_should_err(false), |
| pre_remove_output_files(false) {} |
| |
| enum Verbosity { |
| NORMAL, |
| QUIET, // No output -- used when testing. |
| VERBOSE |
| }; |
| Verbosity verbosity; |
| bool dry_run; |
| int parallelism; |
| int failures_allowed; |
| /// The maximum load average we must not exceed. A negative value |
| /// means that we do not have any limit. |
| double max_load_average; |
| DepfileParserOptions depfile_parser_options; |
| |
| /// Command to execute to handle build output |
| const char* frontend; |
| |
| /// File to write build output to |
| const char* frontend_file; |
| |
| /// Whether a missing depfile should warn or print an error. |
| bool missing_depfile_should_err; |
| |
| /// Whether Ninja should check that symlink outputs are declared in the |
| /// symlink_outputs variable |
| bool uses_symlink_outputs; |
| |
| /// Whether undeclared symlink outputs should print a warning or error out |
| bool undeclared_symlink_outputs_should_err; |
| |
| /// Whether the generator uses 'phony_output's |
| /// Controls the warnings below |
| bool uses_phony_outputs; |
| |
| /// Whether an output can be a directory |
| bool output_directory_should_err; |
| |
| /// Whether a missing output file should warn or print an error. |
| bool missing_output_file_should_err; |
| |
| /// Whether an output with an older timestamp than the inputs should |
| /// warn or print an error. |
| bool old_output_should_err; |
| |
| /// Whether to remove outputs before executing rule commands |
| bool pre_remove_output_files; |
| }; |
| |
| /// Builder wraps the build process: starting commands, updating status. |
| struct Builder { |
| Builder(State* state, const BuildConfig& config, |
| BuildLog* build_log, DepsLog* deps_log, |
| DiskInterface* disk_interface, Status* status, |
| int64_t start_time_millis); |
| ~Builder(); |
| |
| /// Clean up after interrupted commands by deleting output files. |
| void Cleanup(); |
| |
| /// Used by tests. |
| Node* AddTarget(const string& name, string* err); |
| |
| /// Add targets to the build, scanning dependencies. |
| /// @return false on error. |
| bool AddTargets(const std::vector<Node*>& targets, string* err); |
| |
| /// Returns true if the build targets are already up to date. |
| bool AlreadyUpToDate() const; |
| |
| /// Run the build. Returns false on error. |
| /// It is an error to call this function when AlreadyUpToDate() is true. |
| bool Build(string* err); |
| |
| bool StartEdge(Edge* edge, string* err); |
| |
| /// Update status ninja logs following a command termination. |
| /// @return false if the build can not proceed further due to a fatal error. |
| bool FinishCommand(CommandRunner::Result* result, string* err); |
| |
| /// Used for tests. |
| void SetBuildLog(BuildLog* log) { |
| scan_.set_build_log(log); |
| } |
| |
| /// Load the dyndep information provided by the given node. |
| bool LoadDyndeps(Node* node, string* err); |
| |
| State* state_; |
| const BuildConfig& config_; |
| Plan plan_; |
| #if __cplusplus < 201703L |
| auto_ptr<CommandRunner> command_runner_; |
| #else |
| unique_ptr<CommandRunner> command_runner_; // auto_ptr was removed in C++17. |
| #endif |
| Status* status_; |
| |
| private: |
| bool ExtractDeps(CommandRunner::Result* result, const string& deps_type, |
| const string& deps_prefix, vector<Node*>* deps_nodes, |
| string* err); |
| |
| /// Map of running edge to time the edge started running. |
| typedef map<Edge*, int> RunningEdgeMap; |
| RunningEdgeMap running_edges_; |
| |
| /// Time the build started. |
| int64_t start_time_millis_; |
| |
| DiskInterface* disk_interface_; |
| DependencyScan scan_; |
| |
| // Unimplemented copy ctor and operator= ensure we don't copy the auto_ptr. |
| Builder(const Builder &other); // DO NOT IMPLEMENT |
| void operator=(const Builder &other); // DO NOT IMPLEMENT |
| }; |
| |
| #endif // NINJA_BUILD_H_ |