Logo AND Algorithmique Numérique Distribuée

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