Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
use surf init/fini callbacks, no need for TRACE ones
[simgrid.git] / src / instr / instr_config.cpp
1 /* Copyright (c) 2010-2015. 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 "src/instr/instr_private.h"
8 #include "surf/surf.h"
9 #include <vector>
10
11 XBT_LOG_NEW_CATEGORY(instr, "Logging the behavior of the tracing system (used for Visualization/Analysis of simulations)");
12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_config, instr, "Configuration");
13
14 #define OPT_TRACING_BASIC                "tracing/basic"
15 #define OPT_TRACING_BUFFER               "tracing/buffer"
16 #define OPT_TRACING_CATEGORIZED          "tracing/categorized"
17 #define OPT_TRACING_COMMENT_FILE         "tracing/comment-file"
18 #define OPT_TRACING_COMMENT              "tracing/comment"
19 #define OPT_TRACING_DISABLE_DESTROY      "tracing/disable-destroy"
20 #define OPT_TRACING_DISABLE_LINK         "tracing/disable-link"
21 #define OPT_TRACING_DISABLE_POWER        "tracing/disable-power"
22 #define OPT_TRACING_DISPLAY_SIZES        "tracing/smpi/display-sizes"
23 #define OPT_TRACING_FILENAME             "tracing/filename"
24 #define OPT_TRACING_FORMAT_TI_ONEFILE    "tracing/smpi/format/ti-one-file"
25 #define OPT_TRACING_FORMAT               "tracing/smpi/format"
26 #define OPT_TRACING_MSG_PROCESS          "tracing/msg/process"
27 #define OPT_TRACING_MSG_VM               "tracing/msg/vm"
28 #define OPT_TRACING_ONELINK_ONLY         "tracing/onelink-only"
29 #define OPT_TRACING_PLATFORM             "tracing/platform"
30 #define OPT_TRACING_PRECISION            "tracing/precision"
31 #define OPT_TRACING_SMPI_COMPUTING       "tracing/smpi/computing"
32 #define OPT_TRACING_SMPI_GROUP           "tracing/smpi/group"
33 #define OPT_TRACING_SMPI_INTERNALS       "tracing/smpi/internals"
34 #define OPT_TRACING_SMPI_SLEEPING        "tracing/smpi/sleeping"
35 #define OPT_TRACING_SMPI                 "tracing/smpi"
36 #define OPT_TRACING_TOPOLOGY             "tracing/platform/topology"
37 #define OPT_TRACING                      "tracing"
38 #define OPT_TRACING_UNCATEGORIZED        "tracing/uncategorized"
39 #define OPT_VIVA_CAT_CONF                "viva/categorized"
40 #define OPT_VIVA_UNCAT_CONF              "viva/uncategorized"
41
42 static bool trace_enabled = false;
43 static bool trace_platform;
44 static bool trace_platform_topology;
45 static bool trace_smpi_enabled;
46 static bool trace_smpi_grouped;
47 static bool trace_smpi_computing;
48 static bool trace_smpi_sleeping;
49 static bool trace_view_internals;
50 static bool trace_categorized;
51 static bool trace_uncategorized;
52 static bool trace_msg_process_enabled;
53 static bool trace_msg_vm_enabled;
54 static bool trace_buffer;
55 static bool trace_onelink_only;
56 static bool trace_disable_destroy;
57 static bool trace_basic;
58 static bool trace_display_sizes = false;
59 static bool trace_disable_link;
60 static bool trace_disable_power;
61 static int trace_precision;
62
63 static bool trace_configured = false;
64 static bool trace_active     = false;
65
66 static void TRACE_getopts()
67 {
68   trace_enabled             = xbt_cfg_get_boolean(OPT_TRACING);
69   trace_platform            = xbt_cfg_get_boolean(OPT_TRACING_PLATFORM);
70   trace_platform_topology   = xbt_cfg_get_boolean(OPT_TRACING_TOPOLOGY);
71   trace_smpi_enabled        = xbt_cfg_get_boolean(OPT_TRACING_SMPI);
72   trace_smpi_grouped        = xbt_cfg_get_boolean(OPT_TRACING_SMPI_GROUP);
73   trace_smpi_computing      = xbt_cfg_get_boolean(OPT_TRACING_SMPI_COMPUTING);
74   trace_smpi_sleeping       = xbt_cfg_get_boolean(OPT_TRACING_SMPI_SLEEPING);
75   trace_view_internals      = xbt_cfg_get_boolean(OPT_TRACING_SMPI_INTERNALS);
76   trace_categorized         = xbt_cfg_get_boolean(OPT_TRACING_CATEGORIZED);
77   trace_uncategorized       = xbt_cfg_get_boolean(OPT_TRACING_UNCATEGORIZED);
78   trace_msg_process_enabled = xbt_cfg_get_boolean(OPT_TRACING_MSG_PROCESS);
79   trace_msg_vm_enabled      = xbt_cfg_get_boolean(OPT_TRACING_MSG_VM);
80   trace_buffer              = xbt_cfg_get_boolean(OPT_TRACING_BUFFER);
81   trace_onelink_only        = xbt_cfg_get_boolean(OPT_TRACING_ONELINK_ONLY);
82   trace_disable_destroy     = xbt_cfg_get_boolean(OPT_TRACING_DISABLE_DESTROY);
83   trace_basic               = xbt_cfg_get_boolean(OPT_TRACING_BASIC);
84   trace_display_sizes       = xbt_cfg_get_boolean(OPT_TRACING_DISPLAY_SIZES);
85   trace_disable_link        = xbt_cfg_get_boolean(OPT_TRACING_DISABLE_LINK);
86   trace_disable_power       = xbt_cfg_get_boolean(OPT_TRACING_DISABLE_POWER);
87   trace_precision           = xbt_cfg_get_int(OPT_TRACING_PRECISION);
88 }
89
90 int TRACE_start()
91 {
92   if (TRACE_is_configured())
93     TRACE_getopts();
94
95   // tracing system must be:
96   //    - enabled (with --cfg=tracing:yes)
97   //    - already configured (TRACE_global_init already called)
98   if (TRACE_is_enabled()) {
99
100     XBT_DEBUG("Tracing starts");
101     /* init the tracing module to generate the right output */
102
103     /* open the trace file(s) */
104     const char* format = xbt_cfg_get_string(OPT_TRACING_FORMAT);
105     XBT_DEBUG("Tracing format %s\n", format);
106     if(!strcmp(format, "Paje")){
107       TRACE_paje_init();
108       TRACE_paje_start();
109     }else if (!strcmp(format, "TI")){
110       TRACE_TI_init();
111       TRACE_TI_start();
112     }else{
113       xbt_die("Unknown trace format :%s ", format);
114     }
115
116     /* activate trace */
117     if (trace_active == 1) {
118       THROWF(tracing_error, 0, "Tracing is already active");
119     }
120     trace_active = 1;
121     XBT_DEBUG("Tracing is on");
122
123     /* other trace initialization */
124     created_categories = xbt_dict_new_homogeneous(xbt_free_f);
125     declared_marks = xbt_dict_new_homogeneous(xbt_free_f);
126     user_host_variables = xbt_dict_new_homogeneous(xbt_free_f);
127     user_vm_variables = xbt_dict_new_homogeneous(xbt_free_f);
128     user_link_variables = xbt_dict_new_homogeneous(xbt_free_f);
129   }
130   return 0;
131 }
132
133 int TRACE_end()
134 {
135   int retval;
136   if (!trace_active) {
137     retval = 1;
138   } else {
139     retval = 0;
140
141     TRACE_generate_viva_uncat_conf();
142     TRACE_generate_viva_cat_conf();
143
144     /* dump trace buffer */
145     TRACE_last_timestamp_to_dump = surf_get_clock();
146     TRACE_paje_dump_buffer(1);
147
148     /* destroy all data structures of tracing (and free) */
149     PJ_container_free_all();
150     PJ_type_free_all();
151     PJ_container_release();
152     PJ_type_release();
153
154     xbt_dict_free(&user_link_variables);
155     xbt_dict_free(&user_host_variables);
156     xbt_dict_free(&user_vm_variables);
157     xbt_dict_free(&declared_marks);
158     xbt_dict_free(&created_categories);
159
160     /* close the trace files */
161     const char* format = xbt_cfg_get_string(OPT_TRACING_FORMAT);
162     XBT_DEBUG("Tracing format %s\n", format);
163     if(!strcmp(format, "Paje")){
164       TRACE_paje_end();
165     }else if (!strcmp(format, "TI")){
166       TRACE_TI_end();
167     }else{
168       xbt_die("Unknown trace format :%s ", format);
169     }
170
171     /* de-activate trace */
172     trace_active = 0;
173     XBT_DEBUG("Tracing is off");
174     XBT_DEBUG("Tracing system is shutdown");
175   }
176   return retval;
177 }
178
179 bool TRACE_needs_platform ()
180 {
181   return TRACE_msg_process_is_enabled() || TRACE_msg_vm_is_enabled() || TRACE_categorized() ||
182          TRACE_uncategorized() || TRACE_platform () || (TRACE_smpi_is_enabled() && TRACE_smpi_is_grouped());
183 }
184
185 bool TRACE_is_enabled()
186 {
187   return trace_enabled;
188 }
189
190 bool TRACE_platform()
191 {
192   return trace_platform;
193 }
194
195 bool TRACE_platform_topology()
196 {
197   return trace_platform_topology;
198 }
199
200 bool TRACE_is_configured()
201 {
202   return trace_configured;
203 }
204
205 bool TRACE_smpi_is_enabled()
206 {
207   return (trace_smpi_enabled || TRACE_smpi_is_grouped()) && TRACE_is_enabled();
208 }
209
210 bool TRACE_smpi_is_grouped()
211 {
212   return trace_smpi_grouped;
213 }
214
215 bool TRACE_smpi_is_computing()
216 {
217   return trace_smpi_computing;
218 }
219
220 bool TRACE_smpi_is_sleeping()
221 {
222   return trace_smpi_sleeping;
223 }
224
225 bool TRACE_smpi_view_internals()
226 {
227   return trace_view_internals;
228 }
229
230 bool TRACE_categorized ()
231 {
232   return trace_categorized;
233 }
234
235 bool TRACE_uncategorized ()
236 {
237   return trace_uncategorized;
238 }
239
240 bool TRACE_msg_process_is_enabled()
241 {
242   return trace_msg_process_enabled && TRACE_is_enabled();
243 }
244
245 bool TRACE_msg_vm_is_enabled()
246 {
247   return trace_msg_vm_enabled && TRACE_is_enabled();
248 }
249
250 bool TRACE_disable_link()
251 {
252   return trace_disable_link && TRACE_is_enabled();
253 }
254
255 bool TRACE_disable_speed()
256 {
257   return trace_disable_power && TRACE_is_enabled();
258 }
259
260 bool TRACE_buffer ()
261 {
262   return trace_buffer && TRACE_is_enabled();
263 }
264
265 bool TRACE_onelink_only ()
266 {
267   return trace_onelink_only && TRACE_is_enabled();
268 }
269
270 bool TRACE_disable_destroy ()
271 {
272   return trace_disable_destroy && TRACE_is_enabled();
273 }
274
275 bool TRACE_basic ()
276 {
277   return trace_basic && TRACE_is_enabled();
278 }
279
280 bool TRACE_display_sizes ()
281 {
282    return trace_display_sizes && trace_smpi_enabled && TRACE_is_enabled();
283 }
284
285 char *TRACE_get_comment ()
286 {
287   return xbt_cfg_get_string(OPT_TRACING_COMMENT);
288 }
289
290 char *TRACE_get_comment_file ()
291 {
292   return xbt_cfg_get_string(OPT_TRACING_COMMENT_FILE);
293 }
294
295 int TRACE_precision ()
296 {
297   return xbt_cfg_get_int(OPT_TRACING_PRECISION);
298 }
299
300 char *TRACE_get_filename()
301 {
302   return xbt_cfg_get_string(OPT_TRACING_FILENAME);
303 }
304
305 char *TRACE_get_viva_uncat_conf ()
306 {
307   return xbt_cfg_get_string(OPT_VIVA_UNCAT_CONF);
308 }
309
310 char *TRACE_get_viva_cat_conf ()
311 {
312   return xbt_cfg_get_string(OPT_VIVA_CAT_CONF);
313 }
314
315 void TRACE_global_init(int *argc, char **argv)
316 {
317   static int is_initialised = 0;
318   if (is_initialised)
319     return;
320
321   is_initialised = 1;
322   /* name of the tracefile */
323   xbt_cfg_register_string (OPT_TRACING_FILENAME, "simgrid.trace", nullptr, "Trace file created by the instrumented SimGrid.");
324   xbt_cfg_register_boolean(OPT_TRACING, "no", nullptr, "Enable Tracing.");
325   xbt_cfg_register_boolean(OPT_TRACING_PLATFORM, "no", nullptr, "Register the platform in the trace as a hierarchy.");
326   xbt_cfg_register_boolean(OPT_TRACING_TOPOLOGY, "yes", nullptr, "Register the platform topology in the trace as a graph.");
327   xbt_cfg_register_boolean(OPT_TRACING_SMPI, "no", nullptr, "Tracing of the SMPI interface.");
328   xbt_cfg_register_boolean(OPT_TRACING_SMPI_GROUP,"no", nullptr, "Group MPI processes by host.");
329   xbt_cfg_register_boolean(OPT_TRACING_SMPI_COMPUTING, "no", nullptr, "Generate states for timing out of SMPI parts of the application");
330   xbt_cfg_register_boolean(OPT_TRACING_SMPI_SLEEPING, "no", nullptr, "Generate states for timing out of SMPI parts of the application");
331   xbt_cfg_register_boolean(OPT_TRACING_SMPI_INTERNALS, "no", nullptr, "View internal messages sent by Collective communications in SMPI");
332   xbt_cfg_register_boolean(OPT_TRACING_CATEGORIZED, "no", nullptr, "Tracing categorized resource utilization of hosts and links.");
333   xbt_cfg_register_boolean(OPT_TRACING_UNCATEGORIZED, "no", nullptr, "Tracing uncategorized resource utilization of hosts and links.");
334
335   xbt_cfg_register_boolean(OPT_TRACING_MSG_PROCESS, "no", nullptr, "Tracing of MSG process behavior.");
336   xbt_cfg_register_boolean(OPT_TRACING_MSG_VM, "no", nullptr, "Tracing of MSG process behavior.");
337   xbt_cfg_register_boolean(OPT_TRACING_DISABLE_LINK, "no", nullptr, "Do not trace link bandwidth and latency.");
338   xbt_cfg_register_boolean(OPT_TRACING_DISABLE_POWER, "no", nullptr, "Do not trace host power.");
339   xbt_cfg_register_boolean(OPT_TRACING_BUFFER, "yes", nullptr, "Buffer trace events to put them in temporal order.");
340
341   xbt_cfg_register_boolean(OPT_TRACING_ONELINK_ONLY, "no", nullptr, "Use only routes with one link to trace platform.");
342   xbt_cfg_register_boolean(OPT_TRACING_DISABLE_DESTROY, "no", nullptr, "Disable platform containers destruction.");
343   xbt_cfg_register_boolean(OPT_TRACING_BASIC, "no", nullptr, "Avoid extended events (impoverished trace file).");
344   xbt_cfg_register_boolean(OPT_TRACING_DISPLAY_SIZES, "no", nullptr, "(smpi only) Extended events with message size information");
345   xbt_cfg_register_string(OPT_TRACING_FORMAT, "Paje", nullptr, "(smpi only) Switch the output format of Tracing");
346   xbt_cfg_register_boolean(OPT_TRACING_FORMAT_TI_ONEFILE, "no", nullptr, "(smpi only) For replay format only : output to one file only");
347   xbt_cfg_register_string(OPT_TRACING_COMMENT, "", nullptr, "Comment to be added on the top of the trace file.");
348   xbt_cfg_register_string(OPT_TRACING_COMMENT_FILE, "", nullptr,
349       "The contents of the file are added to the top of the trace file as comment.");
350   xbt_cfg_register_int(OPT_TRACING_PRECISION, 6, nullptr, "Numerical precision used when timestamping events "
351       "(expressed in number of digits after decimal point)");
352   /* Viva graph configuration for uncategorized tracing */
353   xbt_cfg_register_string(OPT_VIVA_UNCAT_CONF, "", nullptr, "Viva Graph configuration file for uncategorized resource utilization traces.");
354   xbt_cfg_register_string(OPT_VIVA_CAT_CONF, "", nullptr, "Viva Graph configuration file for categorized resource utilization traces.");
355
356   xbt_cfg_register_alias(OPT_TRACING_COMMENT_FILE,"tracing/comment_file");
357   xbt_cfg_register_alias(OPT_TRACING_DISABLE_DESTROY, "tracing/disable_destroy");
358   xbt_cfg_register_alias(OPT_TRACING_DISABLE_LINK, "tracing/disable_link");
359   xbt_cfg_register_alias(OPT_TRACING_DISABLE_POWER, "tracing/disable_power");
360   xbt_cfg_register_alias(OPT_TRACING_DISPLAY_SIZES, "tracing/smpi/display_sizes");
361   xbt_cfg_register_alias(OPT_TRACING_FORMAT_TI_ONEFILE, "tracing/smpi/format/ti_one_file");
362   xbt_cfg_register_alias(OPT_TRACING_ONELINK_ONLY, "tracing/onelink_only");
363
364   /* instrumentation can be considered configured now */
365   trace_configured = 1;
366 }
367
368 static void print_line (const char *option, const char *desc, const char *longdesc, int detailed)
369 {
370   char str[INSTR_DEFAULT_STR_SIZE];
371   snprintf (str, INSTR_DEFAULT_STR_SIZE, "--cfg=%s ", option);
372
373   int len = strlen (str);
374   printf ("%s%*.*s %s\n", str, 30-len, 30-len, "", desc);
375   if (longdesc != nullptr && detailed){
376     printf ("%s\n\n", longdesc);
377   }
378 }
379
380 void TRACE_help (int detailed)
381 {
382   printf("Description of the tracing options accepted by this simulator:\n\n");
383   print_line (OPT_TRACING, "Enable the tracing system",
384       "  It activates the tracing system and register the simulation platform\n"
385       "  in the trace file. You have to enable this option to others take effect.", detailed);
386   print_line (OPT_TRACING_CATEGORIZED, "Trace categorized resource utilization",
387       "  It activates the categorized resource utilization tracing. It should\n"
388       "  be enabled if tracing categories are used by this simulator.", detailed);
389   print_line (OPT_TRACING_UNCATEGORIZED, "Trace uncategorized resource utilization",
390       "  It activates the uncategorized resource utilization tracing. Use it if\n"
391       "  this simulator do not use tracing categories and resource use have to be\n"
392       "  traced.", detailed);
393   print_line (OPT_TRACING_FILENAME, "Filename to register traces",
394       "  A file with this name will be created to register the simulation. The file\n"
395       "  is in the Paje format and can be analyzed using Viva, Paje, and PajeNG visualization\n"
396       "  tools. More information can be found in these webpages:\n"
397       "     http://github.com/schnorr/viva/\n"
398       "     http://github.com/schnorr/pajeng/\n"
399       "     http://paje.sourceforge.net/", detailed);
400   print_line (OPT_TRACING_SMPI, "Trace the MPI Interface (SMPI)",
401       "  This option only has effect if this simulator is SMPI-based. Traces the MPI\n"
402       "  interface and generates a trace that can be analyzed using Gantt-like\n"
403       "  visualizations. Every MPI function (implemented by SMPI) is transformed in a\n"
404       "  state, and point-to-point communications can be analyzed with arrows.", detailed);
405   print_line (OPT_TRACING_SMPI_GROUP, "Group MPI processes by host (SMPI)",
406       "  This option only has effect if this simulator is SMPI-based. The processes\n"
407       "  are grouped by the hosts where they were executed.", detailed);
408   print_line (OPT_TRACING_SMPI_COMPUTING, "Generates a \" Computing \" State",
409       "  This option aims at tracing computations in the application, outside SMPI\n"
410       "  to allow further study of simulated or real computation time", detailed);
411    print_line (OPT_TRACING_SMPI_SLEEPING, "Generates a \" Sleeping \" State",
412       "  This option aims at tracing sleeps in the application, outside SMPI\n"
413       "  to allow further study of simulated or real sleep time", detailed);
414   print_line (OPT_TRACING_SMPI_INTERNALS, "Generates tracing events corresponding",
415       "  to point-to-point messages sent by collective communications", detailed);
416   print_line (OPT_TRACING_MSG_PROCESS, "Trace processes behavior (MSG)",
417       "  This option only has effect if this simulator is MSG-based. It traces the\n"
418       "  behavior of all categorized MSG processes, grouping them by hosts. This option\n"
419       "  can be used to track process location if this simulator has process migration.", detailed);
420   print_line (OPT_TRACING_BUFFER, "Buffer events to put them in temporal order",
421       "  This option put some events in a time-ordered buffer using the insertion\n"
422       "  sort algorithm. The process of acquiring and releasing locks to access this\n"
423       "  buffer and the cost of the sorting algorithm make this process slow. The\n"
424       "  simulator performance can be severely impacted if this option is activated,\n"
425       "  but you are sure to get a trace file with events sorted.", detailed);
426   print_line (OPT_TRACING_ONELINK_ONLY, "Consider only one link routes to trace platform",
427       "  This option changes the way SimGrid register its platform on the trace file.\n"
428       "  Normally, the tracing considers all routes (no matter their size) on the\n"
429       "  platform file to re-create the resource topology. If this option is activated,\n"
430       "  only the routes with one link are used to register the topology within an AS.\n"
431       "  Routes among AS continue to be traced as usual.", detailed);
432   print_line (OPT_TRACING_DISABLE_DESTROY, "Disable platform containers destruction",
433       "  Disable the destruction of containers at the end of simulation. This can be\n"
434       "  used with simulators that have a different notion of time (different from\n"
435       "  the simulated time).", detailed);
436   print_line (OPT_TRACING_BASIC, "Avoid extended events (impoverished trace file).",
437       "  Some visualization tools are not able to parse correctly the Paje file format.\n"
438       "  Use this option if you are using one of these tools to visualize the simulation\n"
439       "  trace. Keep in mind that the trace might be incomplete, without all the\n"
440       "  information that would be registered otherwise.", detailed);
441   print_line (OPT_TRACING_DISPLAY_SIZES, "Only works for SMPI now. Add message size information",
442       "  Message size (in bytes) is added to links, and to states. For collectives,\n"
443       "  the displayed value is the more relevant to the collective (total sent by\n"
444       "  the process, usually)", detailed);
445   print_line (OPT_TRACING_FORMAT, "Only works for SMPI now. Switch output format",
446       "  Default format is Paje. Time independent traces are also supported,\n"
447       "  to output traces that can later be used by the trace replay tool", detailed);
448   print_line (OPT_TRACING_FORMAT_TI_ONEFILE, "Only works for SMPI now, and TI output format",
449       "  By default, each process outputs to a separate file, inside a filename_files folder\n"
450       "  By setting this option to yes, all processes will output to only one file\n"
451       "  This is meant to avoid opening thousands of files with large simulations", detailed);
452   print_line (OPT_TRACING_COMMENT, "Comment to be added on the top of the trace file.",
453       "  Use this to add a comment line to the top of the trace file.", detailed);
454   print_line (OPT_TRACING_COMMENT_FILE, "File contents added to trace file as comment.",
455       "  Use this to add the contents of a file to the top of the trace file as comment.", detailed);
456   print_line (OPT_VIVA_UNCAT_CONF, "Generate a graph configuration for Viva",
457       "  This option can be used in all types of simulators build with SimGrid\n"
458       "  to generate a uncategorized resource utilization graph to be used as\n"
459       "  configuration for the Viva visualization tool. This option\n"
460       "  can be used with tracing/categorized:1 and tracing:1 options to\n"
461       "  analyze an unmodified simulator before changing it to contain\n"
462       "  categories.", detailed);
463   print_line (OPT_VIVA_CAT_CONF, "Generate an uncategorized graph configuration for Viva",
464       "  This option can be used if this simulator uses tracing categories\n"
465       "  in its code. The file specified by this option holds a graph configuration\n"
466       "  file for the Viva visualization tool that can be used to analyze a categorized\n"
467       "  resource utilization.", detailed);
468   print_line (OPT_TRACING_TOPOLOGY, "Register the platform topology as a graph",
469         "  This option (enabled by default) can be used to disable the tracing of\n"
470         "  the platform topology in the trace file. Sometimes, such task is really\n"
471         "  time consuming, since it must get the route from each host to other hosts\n"
472         "  within the same Autonomous System (AS).", detailed);
473 }
474
475 static void output_types (const char *name, xbt_dynar_t types, FILE *file)
476 {
477   unsigned int i;
478   fprintf (file, "  %s = (", name);
479   for (i = xbt_dynar_length(types); i > 0; i--) {
480     char *type = *(static_cast<char**>(xbt_dynar_get_ptr(types, i - 1)));
481     fprintf (file, "\"%s\"", type);
482     if (i - 1 > 0){
483       fprintf (file, ",");
484     }else{
485       fprintf (file, ");\n");
486     }
487   }
488   xbt_dynar_free (&types);
489 }
490
491 static void output_categories (const char *name, xbt_dynar_t cats, FILE *file)
492 {
493   unsigned int i;
494   fprintf (file, "    values = (");
495   for (i = xbt_dynar_length(cats); i > 0; i--) {
496     char *cat = *(static_cast<char**>(xbt_dynar_get_ptr(cats, i - 1)));
497     fprintf (file, "\"%s%s\"", name, cat);
498     if (i - 1 > 0){
499       fprintf (file, ",");
500     }else{
501       fprintf (file, ");\n");
502     }
503   }
504   xbt_dynar_free (&cats);
505 }
506
507 static void uncat_configuration (FILE *file)
508 {
509   //register NODE and EDGE types
510   output_types ("node", TRACE_get_node_types(), file);
511   output_types ("edge", TRACE_get_edge_types(), file);
512   fprintf (file, "\n");
513
514   //configuration for all nodes
515   fprintf (file,
516       "  host = {\n"
517       "    type = \"square\";\n"
518       "    size = \"power\";\n"
519       "    values = (\"power_used\");\n"
520       "  };\n"
521       "  link = {\n"
522       "    type = \"rhombus\";\n"
523       "    size = \"bandwidth\";\n"
524       "    values = (\"bandwidth_used\");\n"
525       "  };\n");
526   //close
527 }
528
529 static void cat_configuration (FILE *file)
530 {
531   //register NODE and EDGE types
532   output_types ("node", TRACE_get_node_types(), file);
533   output_types ("edge", TRACE_get_edge_types(), file);
534   fprintf (file, "\n");
535
536   //configuration for all nodes
537   fprintf (file,
538            "  host = {\n"
539            "    type = \"square\";\n"
540            "    size = \"power\";\n");
541   output_categories ("p", TRACE_get_categories(), file);
542   fprintf (file,
543            "  };\n"
544            "  link = {\n"
545            "    type = \"rhombus\";\n"
546            "    size = \"bandwidth\";\n");
547   output_categories ("b", TRACE_get_categories(), file);
548   fprintf (file, "  };\n");
549   //close
550 }
551
552 static void generate_uncat_configuration (const char *output, const char *name, int brackets)
553 {
554   if (output && strlen(output) > 0){
555     FILE *file = fopen (output, "w");
556     if (file == nullptr){
557       THROWF (system_error, 1, "Unable to open file (%s) for writing %s graph configuration (uncategorized).",
558               output, name);
559     }
560
561     if (brackets)
562       fprintf (file, "{\n");
563     uncat_configuration (file);
564     if (brackets)
565       fprintf (file, "}\n");
566     fclose (file);
567   }
568 }
569
570 static void generate_cat_configuration (const char *output, const char *name, int brackets)
571 {
572   if (output && strlen(output) > 0){
573     //check if we do have categories declared
574     if (xbt_dict_is_empty(created_categories)){
575       XBT_INFO("No categories declared, ignoring generation of %s graph configuration", name);
576       return;
577     }
578
579     FILE *file = fopen (output, "w");
580     if (file == nullptr){
581       THROWF (system_error, 1, "Unable to open file (%s) for writing %s graph "
582           "configuration (categorized).", output, name);
583     }
584
585     if (brackets) fprintf (file, "{\n");
586     cat_configuration (file);
587     if (brackets) fprintf (file, "}\n");
588     fclose (file);
589   }
590 }
591
592 void TRACE_generate_viva_uncat_conf ()
593 {
594   generate_uncat_configuration (TRACE_get_viva_uncat_conf (), "viva", 0);
595 }
596
597 void TRACE_generate_viva_cat_conf ()
598 {
599   generate_cat_configuration (TRACE_get_viva_cat_conf(), "viva", 0);
600 }
601
602 static int previous_trace_state = -1;
603
604 void instr_pause_tracing ()
605 {
606   previous_trace_state = trace_enabled;
607   if (!TRACE_is_enabled()){
608     XBT_DEBUG ("Tracing is already paused, therefore do nothing.");
609   }else{
610     XBT_DEBUG ("Tracing is being paused.");
611   }
612   trace_enabled = 0;
613   XBT_DEBUG ("Tracing is paused.");
614 }
615
616 void instr_resume_tracing ()
617 {
618   if (TRACE_is_enabled()){
619     XBT_DEBUG ("Tracing is already running while trying to resume, therefore do nothing.");
620   }else{
621     XBT_DEBUG ("Tracing is being resumed.");
622   }
623
624   if (previous_trace_state != -1){
625     trace_enabled = previous_trace_state;
626   }else{
627     trace_enabled = 1;
628   }
629   XBT_DEBUG ("Tracing is resumed.");
630   previous_trace_state = -1;
631 }
632
633 #undef OPT_TRACING
634 #undef OPT_TRACING_PLATFORM
635 #undef OPT_TRACING_TOPOLOGY
636 #undef OPT_TRACING_SMPI
637 #undef OPT_TRACING_SMPI_GROUP
638 #undef OPT_TRACING_CATEGORIZED
639 #undef OPT_TRACING_UNCATEGORIZED
640 #undef OPT_TRACING_MSG_PROCESS
641 #undef OPT_TRACING_FILENAME
642 #undef OPT_TRACING_BUFFER
643 #undef OPT_TRACING_ONELINK_ONLY
644 #undef OPT_TRACING_DISABLE_DESTROY
645 #undef OPT_TRACING_BASIC
646 #undef OPT_TRACING_COMMENT
647 #undef OPT_TRACING_COMMENT_FILE
648 #undef OPT_VIVA_UNCAT_CONF
649 #undef OPT_VIVA_CAT_CONF