Builder wraps the build process: starting commands, updating status. More...

#include <build.h>

Public Member Functions
Node *	AddTarget (const std::string &name, std::string *err)

bool	AddTarget (Node target, std::string err)
	Add a target to the build, scanning dependencies.

bool	AlreadyUpToDate () const
	Returns true if the build targets are already up to date.

ExitStatus	Build (std::string *err)
	Run the build.

	Builder (State state, const BuildConfig &config, BuildLog build_log, DepsLog deps_log, DiskInterface disk_interface, Status *status, int64_t start_time_millis)

void	Cleanup ()
	Clean up after interrupted commands by deleting output files.

bool	FinishCommand (CommandRunner::Result result, std::string err)
	Update status ninja logs following a command termination.

ExitStatus	GetExitCode () const
	Returns ExitStatus or the exit code of the last failed job (doesn't need to be an enum value of ExitStatus)

bool	LoadDyndeps (Node node, std::string err)
	Load the dyndep information provided by the given node.

void	SetBuildLog (BuildLog *log)
	Used for tests.

void	SetJobserverClient (std::unique_ptr< Jobserver::Client > jobserver_client)
	Set Jobserver client instance for this builder.

bool	StartEdge (Edge edge, std::string err)

	~Builder ()

Public Attributes
std::unique_ptr< CommandRunner >	command_runner_

const BuildConfig &	config_

std::unique_ptr< Jobserver::Client >	jobserver_

Plan	plan_

State *	state_

Status *	status_

Private Types
typedef std::map< const Edge *, int >	RunningEdgeMap
	Map of running edge to time the edge started running.

Private Member Functions
	Builder (const Builder &other)

bool	ExtractDeps (CommandRunner::Result result, const std::string &deps_type, const std::string &deps_prefix, std::vector< Node > deps_nodes, std::string err)

void	operator= (const Builder &other)

void	SetFailureCode (ExitStatus code)

Private Attributes
DiskInterface *	disk_interface_

ExitStatus	exit_code_ = ExitSuccess
	Keep the global exit code for the build.

std::unique_ptr< Explanations >	explanations_

std::string	lock_file_path_

RunningEdgeMap	running_edges_

DependencyScan	scan_

int64_t	start_time_millis_
	Time the build started.

Detailed Description

Builder wraps the build process: starting commands, updating status.

Definition at line 197 of file build.h.

Member Typedef Documentation

◆ RunningEdgeMap

typedef std::map<const Edge*, int> Builder::RunningEdgeMap

private

Map of running edge to time the edge started running.

Definition at line 255 of file build.h.

Constructor & Destructor Documentation

◆ Builder() [1/2]

Builder::Builder	(	State *	state,
		const BuildConfig &	config,
		BuildLog *	build_log,
		DepsLog *	deps_log,
		DiskInterface *	disk_interface,
		Status *	status,
		int64_t	start_time_millis )

Definition at line 607 of file build.cc.

References config_, disk_interface_, explanations_, g_explaining, lock_file_path_, plan_, scan_, start_time_millis_, state_, and status_.

Referenced by Builder(), and operator=().

◆ ~Builder()

Builder::~Builder ( )

Definition at line 622 of file build.cc.

References Cleanup(), and status_.

◆ Builder() [2/2]

Builder::Builder ( const Builder & other )

private

References Builder().

Member Function Documentation

◆ AddTarget() [1/2]

Node * Builder::AddTarget	(	const std::string &	name,
		std::string *	err )

Referenced by BuildTest::RebuildTarget(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), and TestPhonyUseCase().

◆ AddTarget() [2/2]

bool Builder::AddTarget	(	Node *	target,
		std::string *	err )

Add a target to the build, scanning dependencies.

Returns: false on error.

◆ AlreadyUpToDate()

bool Builder::AlreadyUpToDate ( ) const

Returns true if the build targets are already up to date.

Definition at line 699 of file build.cc.

References plan_.

Referenced by Build(), BuildTest::RebuildTarget(), TEST_F(), TEST_F(), TEST_F(), and TestPhonyUseCase().

◆ Build()

ExitStatus Builder::Build ( std::string * err )

Run the build.

Returns ExitStatus or the exit code of the last failed job. It is an error to call this function when AlreadyUpToDate() is true.

Definition at line 703 of file build.cc.

References AlreadyUpToDate(), Cleanup(), command_runner_, config_, ExitFailure, ExitInterrupted, ExitSuccess, CommandRunner::factory(), FinishCommand(), Edge::GetBindingBool(), GetExitCode(), Edge::is_phony(), jobserver_, Plan::kEdgeSucceeded, plan_, scan_, SetFailureCode(), StartEdge(), CommandRunner::Result::status, status_, and CommandRunner::Result::success().

Referenced by BuildTest::RebuildTarget(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), and TestPhonyUseCase().

◆ Cleanup()

void Builder::Cleanup ( )

Clean up after interrupted commands by deleting output files.

Definition at line 627 of file build.cc.

References command_runner_, disk_interface_, lock_file_path_, and status_.

Referenced by Build(), and ~Builder().

◆ ExtractDeps()

bool Builder::ExtractDeps	(	CommandRunner::Result *	result,
		const std::string &	deps_type,
		const std::string &	deps_prefix,
		std::vector< Node * > *	deps_nodes,
		std::string *	err )

private

Definition at line 984 of file build.cc.

References CanonicalizePath(), config_, disk_interface_, CommandRunner::Result::edge, Fatal(), g_keep_depfile, Edge::GetUnescapedDepfile(), CLParser::includes_, DepfileParser::ins_, FileReader::NotFound, FileReader::Okay, FileReader::OtherError, CommandRunner::Result::output, CLParser::Parse(), DepfileParser::Parse(), and state_.

Referenced by FinishCommand().

◆ FinishCommand()

bool Builder::FinishCommand	(	CommandRunner::Result *	result,
		std::string *	err )

Update status ninja logs following a command termination.

Returns: false if the build can not proceed further due to a fatal error.

Definition at line 876 of file build.cc.

References Edge::command_start_time_, config_, disk_interface_, CommandRunner::Result::edge, ExitFailure, ExtractDeps(), g_keep_rsp, Edge::GetBinding(), Edge::GetBindingBool(), GetTimeMillis(), Edge::GetUnescapedRspfile(), Plan::kEdgeFailed, Plan::kEdgeSucceeded, METRIC_RECORD, CommandRunner::Result::output, Edge::outputs_, plan_, running_edges_, scan_, start_time_millis_, CommandRunner::Result::status, status_, and CommandRunner::Result::success().

Referenced by Build().

◆ GetExitCode()

ExitStatus Builder::GetExitCode ( ) const

inline

Returns ExitStatus or the exit code of the last failed job (doesn't need to be an enum value of ExitStatus)

Definition at line 247 of file build.h.

References exit_code_.

Referenced by Build().

◆ LoadDyndeps()

bool Builder::LoadDyndeps	(	Node *	node,
		std::string *	err )

Load the dyndep information provided by the given node.

Definition at line 1050 of file build.cc.

References plan_, and scan_.

◆ operator=()

void Builder::operator= ( const Builder & other )

private

References Builder().

◆ SetBuildLog()

void Builder::SetBuildLog ( BuildLog * log )

inline

Used for tests.

Definition at line 231 of file build.h.

References scan_.

◆ SetFailureCode()

void Builder::SetFailureCode ( ExitStatus code )

private

Definition at line 1063 of file build.cc.

References exit_code_, and ExitSuccess.

Referenced by Build().

◆ SetJobserverClient()

void Builder::SetJobserverClient ( std::unique_ptr< Jobserver::Client > jobserver_client )

inline

Set Jobserver client instance for this builder.

Definition at line 204 of file build.h.

References jobserver_.

◆ StartEdge()

bool Builder::StartEdge	(	Edge *	edge,
		std::string *	err )

Definition at line 823 of file build.cc.

References command_runner_, Edge::command_start_time_, config_, disk_interface_, Edge::EvaluateCommand(), Edge::GetBinding(), GetTimeMillis(), Edge::GetUnescapedDepfile(), Edge::GetUnescapedRspfile(), Edge::is_phony(), lock_file_path_, METRIC_RECORD, Edge::outputs_, running_edges_, start_time_millis_, and status_.

Referenced by Build().

Member Data Documentation

◆ command_runner_

std::unique_ptr<CommandRunner> Builder::command_runner_

Definition at line 242 of file build.h.

Referenced by Build(), Cleanup(), BuildTest::RebuildTarget(), StartEdge(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), and TestPhonyUseCase().

◆ config_

const BuildConfig& Builder::config_

Definition at line 239 of file build.h.

Referenced by Build(), Builder(), ExtractDeps(), FinishCommand(), and StartEdge().

◆ disk_interface_

DiskInterface* Builder::disk_interface_

private

Definition at line 262 of file build.h.

Referenced by Builder(), Cleanup(), ExtractDeps(), FinishCommand(), and StartEdge().

◆ exit_code_

ExitStatus Builder::exit_code_ = ExitSuccess

private

Keep the global exit code for the build.

Definition at line 270 of file build.h.

Referenced by GetExitCode(), and SetFailureCode().

◆ explanations_

std::unique_ptr<Explanations> Builder::explanations_

private

Definition at line 265 of file build.h.

Referenced by Builder().

◆ jobserver_

std::unique_ptr<Jobserver::Client> Builder::jobserver_

Definition at line 241 of file build.h.

Referenced by Build(), and SetJobserverClient().

◆ lock_file_path_

std::string Builder::lock_file_path_

private

Definition at line 261 of file build.h.

Referenced by Builder(), Cleanup(), and StartEdge().

◆ plan_

Plan Builder::plan_

Definition at line 240 of file build.h.

Referenced by AlreadyUpToDate(), Build(), Builder(), FinishCommand(), and LoadDyndeps().

◆ running_edges_

RunningEdgeMap Builder::running_edges_

private

Definition at line 256 of file build.h.

Referenced by FinishCommand(), and StartEdge().

◆ scan_

DependencyScan Builder::scan_

private

Definition at line 267 of file build.h.

Referenced by Build(), Builder(), FinishCommand(), LoadDyndeps(), and SetBuildLog().

◆ start_time_millis_

int64_t Builder::start_time_millis_

private

Time the build started.

Definition at line 259 of file build.h.

Referenced by Builder(), FinishCommand(), and StartEdge().

◆ state_

State* Builder::state_

Definition at line 238 of file build.h.

Referenced by Builder(), and ExtractDeps().

◆ status_

Status* Builder::status_

Definition at line 243 of file build.h.

Referenced by Build(), Builder(), Cleanup(), FinishCommand(), StartEdge(), and ~Builder().

The documentation for this struct was generated from the following files:

Public Member Functions

Public Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ RunningEdgeMap

Constructor & Destructor Documentation

◆ Builder() [1/2]

◆ ~Builder()

◆ Builder() [2/2]

Member Function Documentation

◆ AddTarget() [1/2]

◆ AddTarget() [2/2]

◆ AlreadyUpToDate()

◆ Build()

◆ Cleanup()

◆ ExtractDeps()

◆ FinishCommand()

◆ GetExitCode()

◆ LoadDyndeps()

◆ operator=()

◆ SetBuildLog()

◆ SetFailureCode()

◆ SetJobserverClient()

◆ StartEdge()

Member Data Documentation

◆ command_runner_

◆ config_

◆ disk_interface_

◆ exit_code_

◆ explanations_

◆ jobserver_

◆ lock_file_path_

◆ plan_

◆ running_edges_

◆ scan_

◆ start_time_millis_

◆ state_

◆ status_