1 /* Copyright (c) 2010. The SimGrid Team.
2 * All rights reserved. */
4 /* This program is free software; you can redistribute it and/or modify it
5 * under the terms of the license (GNU LGPL) which comes with this package. */
7 #include "simgrid_config.h"
11 #include "instr/private.h"
13 XBT_LOG_NEW_DEFAULT_CATEGORY(tracing,"Tracing Interface");
15 static xbt_dict_t defined_types;
16 static xbt_dict_t created_categories;
20 if (!TRACE_is_configured()){
21 THROW0 (tracing_error, TRACE_ERROR_START,
22 "TRACE_start should be called after SimGrid initialization functions.");
26 if (IS_TRACING) { /* what? trace is already active... ignore.. */
27 THROW0 (tracing_error, TRACE_ERROR_START,
28 "TRACE_start called, but tracing is already active.");
32 char *filename = TRACE_get_filename ();
34 THROW0 (tracing_error, TRACE_ERROR_START,
35 "Trace filename is not initialized.");
38 FILE *file = fopen(filename, "w");
40 THROW1 (tracing_error, TRACE_ERROR_START,
41 "Tracefile %s could not be opened for writing.", filename);
43 TRACE_paje_start (file);
45 TRACE_paje_create_header();
47 /* define paje hierarchy for tracing */
48 pajeDefineContainerType("PLATFORM", "0", "platform");
49 pajeDefineContainerType("HOST", "PLATFORM", "HOST");
50 pajeDefineContainerType("LINK", "PLATFORM", "LINK");
52 if (IS_TRACING_PLATFORM){
53 pajeDefineVariableType ("power", "HOST", "power");
54 pajeDefineVariableType ("power_used", "HOST", "power_used");
55 pajeDefineVariableType ("bandwidth", "LINK", "bandwidth");
56 pajeDefineVariableType ("bandwidth_used", "LINK", "bandwidth_used");
57 pajeDefineVariableType ("latency", "LINK", "latency");
58 pajeDefineEventType ("source", "LINK", "source");
59 pajeDefineEventType ("destination", "LINK", "destination");
62 if (IS_TRACING_PROCESSES || IS_TRACING_VOLUME){
63 //processes grouped by host
64 pajeDefineContainerType("PROCESS", "HOST", "PROCESS");
67 if (IS_TRACING_PROCESSES){
68 pajeDefineStateType("category", "PROCESS", "category");
69 pajeDefineStateType("presence", "PROCESS", "presence");
72 if (IS_TRACING_VOLUME){
73 pajeDefineLinkType ("volume", "0", "PROCESS", "PROCESS", "volume");
76 if (IS_TRACING_TASKS){
77 //tasks grouped by host
78 pajeDefineContainerType("TASK", "HOST", "TASK");
79 pajeDefineStateType("category", "TASK", "category");
80 pajeDefineStateType("presence", "TASK", "presence");
84 pajeDefineContainerType ("MPI_PROCESS", "HOST", "MPI_PROCESS");
85 pajeDefineStateType ("MPI_STATE", "MPI_PROCESS", "MPI_STATE");
86 pajeDefineLinkType ("MPI_LINK", "0", "MPI_PROCESS", "MPI_PROCESS", "MPI_LINK");
89 /* creating the platform */
90 pajeCreateContainer(MSG_get_clock(), "platform", "PLATFORM", "0", "simgrid-platform");
92 /* other trace initialization */
93 defined_types = xbt_dict_new();
94 created_categories = xbt_dict_new();
95 TRACE_msg_task_alloc ();
96 TRACE_category_alloc ();
98 TRACE_msg_process_alloc ();
106 if (!IS_TRACING) return 1;
107 file = TRACE_paje_end();
112 int TRACE_category (const char *category)
114 static int first_time = 1;
115 if (!IS_TRACING) return 1;
118 TRACE_define_type ("user_type", "0", 1);
121 return TRACE_create_category (category, "user_type", "0");
124 void TRACE_define_type (const char *type,
125 const char *parent_type, int final) {
126 char *val_one = NULL;
127 if (!IS_TRACING) return;
129 //check if type is already defined
130 if (xbt_dict_get_or_null (defined_types, type)){
131 THROW1 (tracing_error, TRACE_ERROR_TYPE_ALREADY_DEFINED, "Type %s is already defined", type);
133 //check if parent_type is already defined
134 if (strcmp(parent_type, "0") && !xbt_dict_get_or_null (defined_types, parent_type)) {
135 THROW1 (tracing_error, TRACE_ERROR_TYPE_NOT_DEFINED, "Type (used as parent) %s is not defined", parent_type);
138 pajeDefineContainerType(type, parent_type, type);
141 if (IS_TRACING_PROCESSES) pajeDefineContainerType ("process", type, "process");
142 if (IS_TRACING_PROCESSES) pajeDefineStateType ("process-state", "process", "process-state");
144 if (IS_TRACING_TASKS) pajeDefineContainerType ("task", type, "task");
145 if (IS_TRACING_TASKS) pajeDefineStateType ("task-state", "task", "task-state");
147 val_one = xbt_strdup ("1");
148 xbt_dict_set (defined_types, type, &val_one, xbt_free);
151 int TRACE_create_category (const char *category,
152 const char *type, const char *parent_category)
155 char *val_one = NULL;
156 if (!IS_TRACING) return 1;
158 //check if type is defined
159 if (!xbt_dict_get_or_null (defined_types, type)) {
160 THROW1 (tracing_error, TRACE_ERROR_TYPE_NOT_DEFINED, "Type %s is not defined", type);
163 //check if parent_category exists
164 if (strcmp(parent_category, "0") && !xbt_dict_get_or_null (created_categories, parent_category)){
165 THROW1 (tracing_error, TRACE_ERROR_CATEGORY_NOT_DEFINED, "Category (used as parent) %s is not created", parent_category);
168 //check if category is created
169 if (xbt_dict_get_or_null (created_categories, category)){
173 pajeCreateContainer(MSG_get_clock(), category, type, parent_category, category);
175 /* for registering application categories on top of platform */
177 snprintf (state, 100, "b%s", category);
178 if (IS_TRACING_PLATFORM) pajeDefineVariableType (state, "LINK", state);
179 snprintf (state, 100, "p%s", category);
180 if (IS_TRACING_PLATFORM) pajeDefineVariableType (state, "HOST", state);
182 val_one = xbt_strdup ("1");
183 xbt_dict_set (created_categories, category, &val_one, xbt_free);
187 void TRACE_declare_mark (const char *mark_type)
189 if (!IS_TRACING) return;
190 if (!mark_type) return;
192 pajeDefineEventType (mark_type, "0", mark_type);
195 void TRACE_mark (const char *mark_type, const char *mark_value)
197 if (!IS_TRACING) return;
198 if (!mark_type || !mark_value) return;
200 pajeNewEvent (MSG_get_clock(), mark_type, "0", mark_value);
203 int TRACE_smpi_set_category (const char *category)
205 //if category is NULL, trace of platform is disabled
206 if (!IS_TRACING) return 1;
207 if (category != NULL){
208 int ret = TRACE_category (category);
209 TRACE_category_set (SIMIX_process_self(), category);
212 TRACE_category_unset (SIMIX_process_self());
217 #endif /* HAVE_TRACING */