Ninja: BuildLog Struct Reference

Ninja

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

#include <build_log.h>

Classes
struct	LogEntry

Public Types
typedef ExternalStringHashMap< LogEntry * >::Type	Entries

Public Member Functions
	BuildLog ()

void	Close ()

const Entries &	entries () const

bool	Load (const string &path, string *err)
	Load the on-disk log. More...

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

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

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

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

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

	~BuildLog ()

Private Attributes
Entries	entries_

FILE *	log_file_

bool	needs_recompaction_

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 42 of file build_log.h.

Member Typedef Documentation

◆ Entries

typedef ExternalStringHashMap<LogEntry*>::Type BuildLog::Entries

Definition at line 84 of file build_log.h.

Constructor & Destructor Documentation

◆ BuildLog()

BuildLog::BuildLog ( )

Definition at line 120 of file build_log.cc.

◆ ~BuildLog()

BuildLog::~BuildLog ( )

Definition at line 123 of file build_log.cc.

References Close().

Member Function Documentation

◆ Close()

void BuildLog::Close ( )

Definition at line 187 of file build_log.cc.

References log_file_.

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

◆ entries()

const Entries& BuildLog::entries ( ) const

inline

Definition at line 85 of file build_log.h.

◆ Load()

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

Load the on-disk log.

Definition at line 244 of file build_log.cc.

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

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

◆ LookupByOutput()

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

Lookup a previously-run command by its output path.

Definition at line 360 of file build_log.cc.

References entries_.

Referenced by DependencyScan::RecomputeOutputDirty().

◆ OpenForWrite()

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

Definition at line 127 of file build_log.cc.

References kCurrentVersion, kFileSignature, log_file_, needs_recompaction_, Recompact(), and SetCloseOnExec().

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

◆ Recompact()

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

Rewrite the known log entries, throwing away old data.

Definition at line 373 of file build_log.cc.

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

Referenced by OpenForWrite().

◆ RecordCommand()

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

Definition at line 156 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, BuildLog::LogEntry::output, Edge::outputs_, BuildLog::LogEntry::start_time, and WriteEntry().

Referenced by Builder::FinishCommand(), and WriteTestData().

◆ WriteEntry()

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

Serialize an entry into a log file.

Definition at line 367 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(), and RecordCommand().

Member Data Documentation

◆ entries_

Entries BuildLog::entries_

private

Definition at line 88 of file build_log.h.

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

◆ log_file_

FILE* BuildLog::log_file_

private

Definition at line 89 of file build_log.h.

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

◆ needs_recompaction_

bool BuildLog::needs_recompaction_

private

Definition at line 90 of file build_log.h.

Referenced by Load(), and OpenForWrite().

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