Ninja
Classes | Public Types | Public Member Functions | Private Attributes | List of all members
BuildLog Struct Reference

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 Entriesentries () const
 
bool Load (const string &path, string *err)
 Load the on-disk log. More...
 
LogEntryLookupByOutput (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 restat_mtime=0)
 
void set_quiet (bool quiet)
 
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_
 
bool quiet_
 

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

Definition at line 85 of file build_log.h.

Constructor & Destructor Documentation

BuildLog::BuildLog ( )

Definition at line 104 of file build_log.cc.

BuildLog::~BuildLog ( )

Definition at line 107 of file build_log.cc.

References Close().

Member Function Documentation

void BuildLog::Close ( )

Definition at line 168 of file build_log.cc.

References log_file_.

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

const Entries& BuildLog::entries ( ) const
inline

Definition at line 86 of file build_log.h.

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

Lookup a previously-run command by its output path.

Definition at line 341 of file build_log.cc.

References entries_.

Referenced by DependencyScan::RecomputeOutputDirty().

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

Rewrite the known log entries, throwing away old data.

Definition at line 354 of file build_log.cc.

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

Referenced by OpenForWrite().

bool BuildLog::RecordCommand ( Edge edge,
int  start_time,
int  end_time,
TimeStamp  restat_mtime = 0 
)
void BuildLog::set_quiet ( bool  quiet)
inline

Definition at line 83 of file build_log.h.

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

Member Data Documentation

Entries BuildLog::entries_
private

Definition at line 89 of file build_log.h.

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

FILE* BuildLog::log_file_
private

Definition at line 90 of file build_log.h.

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

bool BuildLog::needs_recompaction_
private

Definition at line 91 of file build_log.h.

Referenced by Load(), and OpenForWrite().

bool BuildLog::quiet_
private

Definition at line 92 of file build_log.h.

Referenced by Recompact().


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