If you spot a problem with this page, click here to create a Bugzilla issue.

Quickly fork, edit online, and submit a pull request for this page. Requires a signed-in GitHub account. This works well for small changes. If you'd like to make larger changes you may want to consider using a local clone.

dmd.timetrace

Compilation time tracing, -ftime-trace.

The time trace profile is output in the Chrome Trace Event Format, described here: https://docs.google.com/document/d/1CvAClvFfyA5R-PhYUmn5OOQtYMH4h6I0nSsKchNAySU/preview

This file is originally from LDC (the LLVM D compiler).

Authors:

Johan Engelen, Max Haughton, Dennis Korpel

License:

Boost License 1.0

Source common/timetrace.d

Documentation https://dlang.org/phobos/dmd_common_timetrace.html

Coverage https://codecov.io/gh/dlang/dmd/src/master/compiler/src/dmd/timetrace.d

void initializeTimeTrace(uint timeGranularityUs, const(char)* processName);

Initialize time tracing functionality.

Must be called before any other calls to timeTrace functions.

Parameters:

uint `timeGranularityUs`	minimum event size in microseconds
const(char)* `processName`	name of this executable

void deinitializeTimeTrace();

Cleanup for time tracing functionality.

After this, no more calls to timeTrace functions can be made.

bool timeTraceProfilerEnabled();

Returns:

Whether time tracing is enabled.

void writeTimeTraceProfile(OutBuffer* buf);

Write all time tracing results so far to JSON, in the Chrome Trace Event Format.

Parameters:

OutBuffer* buf output buffer to write JSON into

void timeTraceBeginEvent(scope const(char)* name_ptr, scope const(char)* detail_ptr, Loc loc);

Start a new time trace event (C++ interface using upfront C-strings instead of lazy delegates)

Parameters:

const(char)* `name_ptr`	event name, visible in high level profile view
const(char)* `detail_ptr`	further details, visible when this event is selected
Loc `loc`	source location corresponding to this event

void timeTraceBeginEvent(TimeTraceEventType eventType);

Start a new time trace event

Details of the event will be passed as delegates to timeTraceEndEvent so they're only generated when the event is actually written.

Parameters:

TimeTraceEventType eventType what compilation stage the event belongs to (redundant with the eventType of timeTraceEndEvent but used by GDC)

void timeTraceEndEvent(TimeTraceEventType eventType); void timeTraceEndEvent(TimeTraceEventType eventType, Dsymbol sym, scope const(char)[] delegate() detail = null); void timeTraceEndEvent(TimeTraceEventType eventType, Expression e);

End a time tracing event, optionally updating the event name and details with a delegate. Delegates are used to prevent spending time on string generation when an event is too small to be generated anyway.

Parameters:

TimeTraceEventType `eventType`	what compilation stage the event belongs to
Dsymbol `sym`	Dsymbol which was analyzed, used to generate 'name' and 'detail'
Expression `e`	Expression which was analyzed, used to generate 'name' and 'detail'
const(char)[] delegate() `detail`	custom lazy string for 'detail' of event

enum TimeTraceEventType: int;

Identifies which compilation stage the event is associated to

Library Reference

dmd.timetrace