OmniTrace Causal Profiling Defines

Macros

OmniTrace Causal Profiling Defines

Macros
#define	OMNITRACE_CAUSAL_ENABLED   1
#define	OMNITRACE_CAUSAL_LABEL   __FILE__ ":" OMNITRACE_CAUSAL_STR(__LINE__)
#define	OMNITRACE_CAUSAL_PROGRESS   omnitrace_user_progress(OMNITRACE_CAUSAL_LABEL);
#define	OMNITRACE_CAUSAL_PROGRESS_NAMED(LABEL)   omnitrace_user_progress(LABEL);
#define	OMNITRACE_CAUSAL_BEGIN(LABEL)   omnitrace_user_push_region(LABEL);
#define	OMNITRACE_CAUSAL_END(LABEL)   omnitrace_user_pop_region(LABEL);

Detailed Description

Macro Definition Documentation

◆ OMNITRACE_CAUSAL_BEGIN

#define OMNITRACE_CAUSAL_BEGIN

(

LABEL

)

omnitrace_user_push_region(LABEL);

Starts a latency progress point (region of interest) with user defined label. Each instance should use a unique label.

Definition at line 62 of file causal.h.

◆ OMNITRACE_CAUSAL_ENABLED

#define OMNITRACE_CAUSAL_ENABLED   1

Preprocessor switch to enable/disable instrumentation for causal profiling

Definition at line 36 of file causal.h.

◆ OMNITRACE_CAUSAL_END

#define OMNITRACE_CAUSAL_END

(

LABEL

)

omnitrace_user_pop_region(LABEL);

End the latency progress point (region of interest) for the matching user defined label.

Definition at line 67 of file causal.h.

◆ OMNITRACE_CAUSAL_LABEL

#define OMNITRACE_CAUSAL_LABEL   __FILE__ ":" OMNITRACE_CAUSAL_STR(__LINE__)

Default label for a causal progress point

Definition at line 48 of file causal.h.

◆ OMNITRACE_CAUSAL_PROGRESS

#define OMNITRACE_CAUSAL_PROGRESS   omnitrace_user_progress(OMNITRACE_CAUSAL_LABEL);

Adds a throughput progress point with label <file>:<line>

Definition at line 52 of file causal.h.

◆ OMNITRACE_CAUSAL_PROGRESS_NAMED

#define OMNITRACE_CAUSAL_PROGRESS_NAMED

(

LABEL

)

omnitrace_user_progress(LABEL);

Adds a throughput progress point with user defined label. Each instance should use a unique label.

Definition at line 57 of file causal.h.