Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[trace] let paje output its own header
[simgrid.git] / src / instr / instr_interface.c
1 /* Copyright (c) 2010. The SimGrid Team.
2  * All rights reserved.                                                     */
3
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. */
6
7 #include "simgrid_config.h"
8
9 #ifdef HAVE_TRACING
10
11 #include "instr/instr_private.h"
12
13 XBT_LOG_NEW_DEFAULT_CATEGORY(tracing, "Tracing Interface");
14
15 static xbt_dict_t defined_types;
16 static xbt_dict_t created_categories;
17
18 int TRACE_start()
19 {
20   // tracing system must be:
21   //    - enabled (with --cfg=tracing:1)
22   //    - already configured (TRACE_global_init already called)
23   if (!(TRACE_is_enabled() && TRACE_is_configured())){
24     return 0;
25   }
26
27   /* open the trace file */
28   TRACE_paje_start();
29
30   /* activate trace */
31   TRACE_activate ();
32
33   /* define paje hierarchy for tracing */
34   pajeDefineContainerType("PLATFORM", "0", "platform");
35   pajeDefineContainerType("HOST", "PLATFORM", "HOST");
36   pajeDefineContainerType("LINK", "PLATFORM", "LINK");
37   pajeDefineVariableType("power", "HOST", "power");
38   pajeDefineVariableType("bandwidth", "LINK", "bandwidth");
39   pajeDefineVariableType("latency", "LINK", "latency");
40   pajeDefineEventType("source", "LINK", "source");
41   pajeDefineEventType("destination", "LINK", "destination");
42
43   if (TRACE_platform_is_enabled()) {
44     if (TRACE_uncategorized()){
45       pajeDefineVariableType("power_used", "HOST", "power_used");
46       pajeDefineVariableType("bandwidth_used", "LINK", "bandwidth_used");
47     }
48   }
49
50   if (TRACE_msg_process_is_enabled() || TRACE_msg_volume_is_enabled()) {
51     //processes grouped by host
52     pajeDefineContainerType("PROCESS", "HOST", "PROCESS");
53   }
54
55   if (TRACE_msg_process_is_enabled()) {
56     pajeDefineStateType("category", "PROCESS", "category");
57     pajeDefineStateType("presence", "PROCESS", "presence");
58   }
59
60   if (TRACE_msg_volume_is_enabled()) {
61     pajeDefineLinkType("volume", "0", "PROCESS", "PROCESS", "volume");
62   }
63
64   if (TRACE_msg_task_is_enabled()) {
65     //tasks grouped by host
66     pajeDefineContainerType("TASK", "HOST", "TASK");
67     pajeDefineStateType("category", "TASK", "category");
68     pajeDefineStateType("presence", "TASK", "presence");
69   }
70
71   if (TRACE_smpi_is_enabled()) {
72     if (TRACE_smpi_is_grouped()){
73       pajeDefineContainerType("MPI_PROCESS", "HOST", "MPI_PROCESS");
74     }else{
75       pajeDefineContainerType("MPI_PROCESS", "PLATFORM", "MPI_PROCESS");
76     }
77     pajeDefineStateType("MPI_STATE", "MPI_PROCESS", "MPI_STATE");
78     pajeDefineLinkType("MPI_LINK", "0", "MPI_PROCESS", "MPI_PROCESS",
79                        "MPI_LINK");
80   }
81
82   /* creating the platform */
83   pajeCreateContainer(MSG_get_clock(), "platform", "PLATFORM", "0",
84                       "simgrid-platform");
85
86   /* other trace initialization */
87   defined_types = xbt_dict_new();
88   created_categories = xbt_dict_new();
89   TRACE_msg_task_alloc();
90   TRACE_category_alloc();
91   TRACE_surf_alloc();
92   TRACE_msg_process_alloc();
93   TRACE_smpi_alloc();
94   return 0;
95 }
96
97 int TRACE_end()
98 {
99   if (!TRACE_is_active())
100     return 1;
101
102   /* close the trace file */
103   TRACE_paje_end();
104
105   /* activate trace */
106   TRACE_desactivate ();
107   return 0;
108 }
109
110 int TRACE_category(const char *category)
111 {
112   return TRACE_category_with_color (category, NULL);
113 }
114
115 int TRACE_category_with_color (const char *category, const char *color)
116 {
117   static int first_time = 1;
118   if (!TRACE_is_active())
119     return 1;
120
121   if (first_time) {
122     TRACE_define_type("user_type", "0", 1);
123     first_time = 0;
124   }
125   return TRACE_create_category_with_color(category, "user_type", "0", color);
126 }
127
128 void TRACE_define_type(const char *type,
129                        const char *parent_type, int final)
130 {
131   char *val_one = NULL;
132   if (!TRACE_is_active())
133     return;
134
135   //check if type is already defined
136   if (xbt_dict_get_or_null(defined_types, type)) {
137     THROW1(tracing_error, TRACE_ERROR_TYPE_ALREADY_DEFINED,
138            "Type %s is already defined", type);
139   }
140   //check if parent_type is already defined
141   if (strcmp(parent_type, "0")
142       && !xbt_dict_get_or_null(defined_types, parent_type)) {
143     THROW1(tracing_error, TRACE_ERROR_TYPE_NOT_DEFINED,
144            "Type (used as parent) %s is not defined", parent_type);
145   }
146
147   pajeDefineContainerType(type, parent_type, type);
148   if (final) {
149     //for m_process_t
150     if (TRACE_msg_process_is_enabled())
151       pajeDefineContainerType("process", type, "process");
152     if (TRACE_msg_process_is_enabled())
153       pajeDefineStateType("process-state", "process", "process-state");
154
155     if (TRACE_msg_task_is_enabled())
156       pajeDefineContainerType("task", type, "task");
157     if (TRACE_msg_task_is_enabled())
158       pajeDefineStateType("task-state", "task", "task-state");
159   }
160   val_one = xbt_strdup("1");
161   xbt_dict_set(defined_types, type, &val_one, xbt_free);
162 }
163
164 int TRACE_create_category(const char *category,
165                           const char *type, const char *parent_category)
166 {
167   return TRACE_create_category_with_color (category, type, parent_category, NULL);
168 }
169
170 int TRACE_create_category_with_color(const char *category,
171                           const char *type,
172                           const char *parent_category,
173                           const char *color)
174 {
175   char state[100];
176   char *val_one = NULL;
177   if (!TRACE_is_active())
178     return 1;
179
180   //check if type is defined
181   if (!xbt_dict_get_or_null(defined_types, type)) {
182     THROW1(tracing_error, TRACE_ERROR_TYPE_NOT_DEFINED,
183            "Type %s is not defined", type);
184     return 1;
185   }
186   //check if parent_category exists
187   if (strcmp(parent_category, "0")
188       && !xbt_dict_get_or_null(created_categories, parent_category)) {
189     THROW1(tracing_error, TRACE_ERROR_CATEGORY_NOT_DEFINED,
190            "Category (used as parent) %s is not created", parent_category);
191     return 1;
192   }
193   //check if category is created
194   if (xbt_dict_get_or_null(created_categories, category)) {
195     return 1;
196   }
197
198   pajeCreateContainer(MSG_get_clock(), category, type, parent_category,
199                       category);
200
201   char final_color[INSTR_DEFAULT_STR_SIZE];
202   if (!color){
203     //generate a random color
204     double red = drand48();
205     double green = drand48();
206     double blue = drand48();
207     snprintf (final_color, INSTR_DEFAULT_STR_SIZE, "%f %f %f", red, green, blue);
208   }else{
209     snprintf (final_color, INSTR_DEFAULT_STR_SIZE, "%s", color);
210   }
211
212   /* for registering application categories on top of platform */
213   snprintf(state, 100, "b%s", category);
214   if (TRACE_platform_is_enabled())
215     pajeDefineVariableTypeWithColor(state, "LINK", state, final_color);
216   snprintf(state, 100, "p%s", category);
217   if (TRACE_platform_is_enabled())
218     pajeDefineVariableTypeWithColor(state, "HOST", state, final_color);
219
220   val_one = xbt_strdup("1");
221   xbt_dict_set(created_categories, category, &val_one, xbt_free);
222   return 0;
223 }
224
225 void TRACE_declare_mark(const char *mark_type)
226 {
227   if (!TRACE_is_active())
228     return;
229   if (!mark_type)
230     return;
231
232   pajeDefineEventType(mark_type, "0", mark_type);
233 }
234
235 void TRACE_mark(const char *mark_type, const char *mark_value)
236 {
237   if (!TRACE_is_active())
238     return;
239   if (!mark_type || !mark_value)
240     return;
241
242   pajeNewEvent(MSG_get_clock(), mark_type, "0", mark_value);
243 }
244
245 #endif /* HAVE_TRACING */