SimGrid: TRACE

SimGrid 3.10 Versatile Simulation of Distributed Systems

- Home page
- Online documentation
- Dev's Corner

All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
Modules | Functions
TRACE

Tracing mechanism and its functions. More...

## Modules
| Tracing categories
| Functions to declare tracing categories.
| Tracing marks
| Functions to declare and create tracing marks.
| Tracing user variables
| Functions to declare and define user variables associated to resources.

## Functions
int | TRACE_platform_graph_export_graphviz (const char *filename)
| Creates a file with the topology of the platform file used for the simulator.
xbt_dynar_t | TRACE_get_node_types (void)
| Get Paje container types that can be mapped to the nodes of a graph.
xbt_dynar_t | TRACE_get_edge_types (void)
| Get Paje container types that can be mapped to the edges of a graph.
void | TRACE_pause (void)
| Pauses all tracing activities.
void | TRACE_resume (void)
| Resumes all tracing activities.

## Detailed Description

Tracing mechanism and its functions.

SimGrid can trace the resource (of hosts and links) utilization using any of its programming interfaces (MSG, SimDAG and SMPI). This means that the tracing will register how much power is used for each host and how much bandwidth is used for each link of the platform.

The idea of the tracing facilities is to give SimGrid users to possibility to classify MSG and SimDAG tasks by category, tracing the platform utilization (hosts and links) for each of the categories. The API enables the declaration of categories and a function to associate them to the tasks (MSG and SD). The tasks that are not classified according to a category are not traced. If no categories are specified, simulations can still be traced using a special parameter in the command line (see Tracing Simulations for details).

# TRACE documentation

- Tracing categories
- Tracing marks
- Tracing user variables

## Function Documentation

int TRACE_platform_graph_export_graphviz | ( | const char * | filename | ) |

Creates a file with the topology of the platform file used for the simulator.

The graph topology will have the following properties: all hosts, links and routers of the platform file are mapped to graph nodes; routes are mapped to edges. The platform's AS are not represented in the output.

Parameters

  filename | The name of the file that will hold the graph.

Returns
  1 of successful, 0 otherwise.

xbt_dynar_t TRACE_get_node_types | ( | void |  | ) |

Get Paje container types that can be mapped to the nodes of a graph.

This function can be used to create a user made graph configuration file for Triva. Normally, it is used with the functions defined in Tracing user variables.

Returns
  A dynar with the types, must be freed with xbt_dynar_free.

xbt_dynar_t TRACE_get_edge_types | ( | void |  | ) |

Get Paje container types that can be mapped to the edges of a graph.

This function can be used to create a user made graph configuration file for Triva. Normally, it is used with the functions defined in Tracing user variables.

Returns
  A dynar with the types, must be freed with xbt_dynar_free.

void TRACE_pause | ( | void |  | ) |

Pauses all tracing activities.

See Also
  TRACE_resume

void TRACE_resume | ( | void |  | ) |

Resumes all tracing activities.

See Also
  TRACE_pause