Logo AND Algorithmique Numérique Distribuée

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