Store a log of every command ran for every build. More...

#include <build_log.h>

Classes
struct	LogEntry

Public Types
typedef ExternalStringHashMap< std::unique_ptr< LogEntry > >::Type	Entries

Public Member Functions
	BuildLog ()

void	Close ()

const Entries &	entries () const

LoadStatus	Load (const std::string &path, std::string *err)
	Load the on-disk log.

LogEntry *	LookupByOutput (const std::string &path)
	Lookup a previously-run command by its output path.

bool	OpenForWrite (const std::string &path, const BuildLogUser &user, std::string *err)
	Prepares writing to the log file without actually opening it - that will happen when/if it's needed.

bool	Recompact (const std::string &path, const BuildLogUser &user, std::string *err)
	Rewrite the known log entries, throwing away old data.

bool	RecordCommand (Edge *edge, int start_time, int end_time, TimeStamp mtime=0)

bool	Restat (StringPiece path, const DiskInterface &disk_interface, int output_count, char *outputs, std::string err)
	Restat all outputs in the log.

bool	WriteEntry (FILE *f, const LogEntry &entry)
	Serialize an entry into a log file.

	~BuildLog ()

Private Member Functions
bool	OpenForWriteIfNeeded ()
	Should be called before using log_file_.

Private Attributes
Entries	entries_

FILE *	log_file_ = nullptr

std::string	log_file_path_

bool	needs_recompaction_ = false

Detailed Description

Store a log of every command ran for every build.

It has a few uses:

1) (hashes of) command lines for existing output files, so we know when we need to rebuild due to the command changing 2) timing information, perhaps for generating reports 3) restat information

Definition at line 45 of file build_log.h.

Member Typedef Documentation

◆ Entries

typedef ExternalStringHashMap<std::unique_ptr<LogEntry>>::Type BuildLog::Entries

Definition at line 95 of file build_log.h.

Constructor & Destructor Documentation

◆ BuildLog()

BuildLog::BuildLog ( )

default

◆ ~BuildLog()

BuildLog::~BuildLog ( )

Definition at line 73 of file build_log.cc.

References Close().

Member Function Documentation

◆ Close()

void BuildLog::Close ( )

Definition at line 125 of file build_log.cc.

References log_file_, and OpenForWriteIfNeeded().

Referenced by Recompact(), Restat(), and ~BuildLog().

◆ entries()

const Entries & BuildLog::entries ( ) const

inline

Definition at line 96 of file build_log.h.

References entries_.

◆ Load()

LoadStatus BuildLog::Load	(	const std::string &	path,
		std::string *	err )

Load the on-disk log.

Definition at line 208 of file build_log.cc.

References BuildLog::LogEntry::command_hash, BuildLog::LogEntry::end_time, entries_, kCurrentVersion, kFileSignature, LOAD_ERROR, LOAD_NOT_FOUND, LOAD_SUCCESS, METRIC_RECORD, BuildLog::LogEntry::mtime, needs_recompaction_, BuildLog::LogEntry::output, platformAwareUnlink(), LineReader::ReadLine(), and BuildLog::LogEntry::start_time.

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

◆ LookupByOutput()

BuildLog::LogEntry * BuildLog::LookupByOutput ( const std::string & path )

Lookup a previously-run command by its output path.

Definition at line 327 of file build_log.cc.

References entries_.

Referenced by TEST_F(), and TEST_F().

◆ OpenForWrite()

bool BuildLog::OpenForWrite	(	const std::string &	path,
		const BuildLogUser &	user,
		std::string *	err )

Prepares writing to the log file without actually opening it - that will happen when/if it's needed.

Definition at line 77 of file build_log.cc.

References log_file_, log_file_path_, needs_recompaction_, and Recompact().

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

◆ OpenForWriteIfNeeded()

bool BuildLog::OpenForWriteIfNeeded ( )

private

Should be called before using log_file_.

When false is returned, errno will be set.

Definition at line 132 of file build_log.cc.

References kCurrentVersion, kFileSignature, log_file_, log_file_path_, and SetCloseOnExec().

Referenced by Close(), and RecordCommand().

◆ Recompact()

bool BuildLog::Recompact	(	const std::string &	path,
		const BuildLogUser &	user,
		std::string *	err )

Rewrite the known log entries, throwing away old data.

Definition at line 340 of file build_log.cc.

References Close(), entries_, BuildLogUser::IsPathDead(), kCurrentVersion, kFileSignature, METRIC_RECORD, platformAwareUnlink(), and WriteEntry().

Referenced by OpenForWrite().

◆ RecordCommand()

bool BuildLog::RecordCommand	(	Edge *	edge,
		int	start_time,
		int	end_time,
		TimeStamp	mtime = 0 )

Definition at line 90 of file build_log.cc.

References BuildLog::LogEntry::command_hash, BuildLog::LogEntry::end_time, entries_, Edge::EvaluateCommand(), BuildLog::LogEntry::HashCommand(), log_file_, BuildLog::LogEntry::mtime, OpenForWriteIfNeeded(), BuildLog::LogEntry::output, Edge::outputs_, BuildLog::LogEntry::start_time, and WriteEntry().

Referenced by WriteTestData().

◆ Restat()

bool BuildLog::Restat	(	StringPiece	path,
		const DiskInterface &	disk_interface,
		int	output_count,
		char **	outputs,
		std::string *	err )

Restat all outputs in the log.

Definition at line 389 of file build_log.cc.

References StringPiece::AsString(), Close(), entries_, kCurrentVersion, kFileSignature, METRIC_RECORD, platformAwareUnlink(), DiskInterface::Stat(), StringPiece::str_, and WriteEntry().

◆ WriteEntry()

bool BuildLog::WriteEntry	(	FILE *	f,
		const LogEntry &	entry )

Serialize an entry into a log file.

Definition at line 334 of file build_log.cc.

References BuildLog::LogEntry::command_hash, BuildLog::LogEntry::end_time, BuildLog::LogEntry::mtime, BuildLog::LogEntry::output, PRId64, PRIx64, and BuildLog::LogEntry::start_time.

Referenced by Recompact(), RecordCommand(), and Restat().

Member Data Documentation

◆ entries_

Entries BuildLog::entries_

private

Definition at line 103 of file build_log.h.

Referenced by entries(), Load(), LookupByOutput(), Recompact(), RecordCommand(), and Restat().

◆ log_file_

FILE* BuildLog::log_file_ = nullptr

private

Definition at line 104 of file build_log.h.

Referenced by Close(), OpenForWrite(), OpenForWriteIfNeeded(), and RecordCommand().

◆ log_file_path_

std::string BuildLog::log_file_path_

private

Definition at line 105 of file build_log.h.

Referenced by OpenForWrite(), and OpenForWriteIfNeeded().

◆ needs_recompaction_

bool BuildLog::needs_recompaction_ = false

private

Definition at line 106 of file build_log.h.

Referenced by Load(), and OpenForWrite().

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

Classes

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Entries

Constructor & Destructor Documentation

◆ BuildLog()

◆ ~BuildLog()

Member Function Documentation

◆ Close()

◆ entries()

◆ Load()

◆ LookupByOutput()

◆ OpenForWrite()

◆ OpenForWriteIfNeeded()

◆ Recompact()

◆ RecordCommand()

◆ Restat()

◆ WriteEntry()

Member Data Documentation

◆ entries_

◆ log_file_

◆ log_file_path_

◆ needs_recompaction_