SimGrid 3.7.1
Scalable simulation of distributed systems
Functions
Tracing marks
TRACE

Functions to declare and create tracing marks. More...

Functions

void TRACE_declare_mark (const char *mark_type)
 Declare a new type for tracing mark.
void TRACE_mark (const char *mark_type, const char *mark_value)
 Create a new instance of a tracing mark type.
xbt_dynar_t TRACE_get_marks (void)
 Get declared marks.

Detailed Description

Functions to declare and create tracing marks.


Function Documentation

void TRACE_declare_mark ( const char *  mark_type)

Declare a new type for tracing mark.

This function declares a new Paje event type in the trace file that can be used by simulators to declare application-level marks. This function is independent of which API is used in SimGrid.

Parameters:
mark_typeThe name of the new type.
See also:
TRACE_mark
void TRACE_mark ( const char *  mark_type,
const char *  mark_value 
)

Create a new instance of a tracing mark type.

This function creates a mark in the trace file. The first parameter had to be previously declared using TRACE_declare_mark, the second is the identifier for this mark instance. We recommend that the mark_value is a unique value for the whole simulation. Nevertheless, this is not a strong requirement: the trace will be valid even if there are multiple mark identifiers for the same trace.

Parameters:
mark_typeThe name of the type for which the new instance will belong.
mark_valueThe name of the new instance mark.
See also:
TRACE_declare_mark
xbt_dynar_t TRACE_get_marks ( void  )

Get declared marks.

This function should be used to get marks that were already declared with TRACE_declare_mark.

Returns:
A dynar with the declared marks, must be freed with xbt_dynar_free.


Back to the main Simgrid Documentation page The version of SimGrid documented here is v3.7.1.
Documentation of other versions can be found in their respective archive files (directory doc/html).
Generated by doxygen