Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[trace] Cache config options.
[simgrid.git] / src / instr / instr_config.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
8 #include "instr/instr_private.h"
9
10 #ifdef HAVE_TRACING
11
12 XBT_LOG_NEW_CATEGORY(instr, "Logging the behavior of the tracing system (used for Visualization/Analysis of simulations)");
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_config, instr, "Configuration");
14
15 #define OPT_TRACING               "tracing"
16 #define OPT_TRACING_SMPI          "tracing/smpi"
17 #define OPT_TRACING_SMPI_GROUP    "tracing/smpi/group"
18 #define OPT_TRACING_CATEGORIZED   "tracing/categorized"
19 #define OPT_TRACING_UNCATEGORIZED "tracing/uncategorized"
20 #define OPT_TRACING_MSG_TASK      "tracing/msg/task"
21 #define OPT_TRACING_MSG_PROCESS   "tracing/msg/process"
22 #define OPT_TRACING_MSG_VOLUME    "tracing/msg/volume"
23 #define OPT_TRACING_FILENAME      "tracing/filename"
24 #define OPT_TRACING_BUFFER        "tracing/buffer"
25 #define OPT_TRACING_ONELINK_ONLY  "tracing/onelink_only"
26 #define OPT_TRIVA_UNCAT_CONF      "triva/uncategorized"
27 #define OPT_TRIVA_CAT_CONF        "triva/categorized"
28
29 static int trace_enabled;
30 static int trace_smpi_enabled;
31 static int trace_smpi_grouped;
32 static int trace_categorized;
33 static int trace_uncategorized;
34 static int trace_msg_task_enabled;
35 static int trace_msg_process_enabled;
36 static int trace_msg_volume_enabled;
37 static int trace_buffer;
38 static int trace_onelink_only;
39
40 static int trace_configured = 0;
41 static int trace_active = 0;
42
43 xbt_dict_t created_categories; //declared in instr_interface.c
44
45 static void TRACE_getopts(void)
46 {
47   trace_enabled = xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING);
48   trace_smpi_enabled = xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_SMPI);
49   trace_smpi_grouped = xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_SMPI_GROUP);
50   trace_categorized = xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_CATEGORIZED);
51   trace_uncategorized = xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_UNCATEGORIZED);
52   trace_msg_task_enabled = xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_MSG_TASK);
53   trace_msg_process_enabled = xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_MSG_PROCESS);
54   trace_msg_volume_enabled = xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_MSG_VOLUME);
55   trace_buffer = xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_BUFFER);
56   trace_onelink_only = xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_ONELINK_ONLY);
57 }
58
59 int TRACE_start()
60 {
61   TRACE_getopts();
62
63   // tracing system must be:
64   //    - enabled (with --cfg=tracing:1)
65   //    - already configured (TRACE_global_init already called)
66   if (!(TRACE_is_enabled() && TRACE_is_configured())){
67     return 0;
68   }
69
70   XBT_DEBUG("Tracing starts");
71
72   /* open the trace file */
73   TRACE_paje_start();
74
75   /* activate trace */
76   TRACE_activate ();
77
78   /* other trace initialization */
79   created_categories = xbt_dict_new();
80   TRACE_surf_alloc();
81   TRACE_smpi_alloc();
82   return 0;
83 }
84
85 int TRACE_end()
86 {
87   if (!TRACE_is_active())
88     return 1;
89
90   /* generate uncategorized graph configuration for triva */
91   if (TRACE_get_triva_uncat_conf()){
92     TRACE_generate_triva_uncat_conf();
93   }
94
95   /* generate categorized graph configuration for triva */
96   if (TRACE_get_triva_cat_conf()){
97     TRACE_generate_triva_cat_conf();
98   }
99
100   /* dump trace buffer */
101   TRACE_last_timestamp_to_dump = surf_get_clock();
102   TRACE_paje_dump_buffer(1);
103
104   /* destroy all data structures of tracing (and free) */
105   destroyAllContainers();
106
107   /* close the trace file */
108   TRACE_paje_end();
109
110   /* activate trace */
111   TRACE_desactivate ();
112   XBT_DEBUG("Tracing system is shutdown");
113   return 0;
114 }
115
116 void TRACE_activate (void)
117 {
118   xbt_assert (trace_active==0, "Tracing is already active.");
119   trace_active = 1;
120   XBT_DEBUG ("Tracing is on");
121 }
122
123 void TRACE_desactivate (void)
124 {
125   trace_active = 0;
126   XBT_DEBUG ("Tracing is off");
127 }
128
129 int TRACE_is_active (void)
130 {
131   return trace_active;
132 }
133
134 int TRACE_is_enabled(void)
135 {
136   return trace_enabled;
137 }
138
139 int TRACE_is_configured(void)
140 {
141   return trace_configured;
142 }
143
144 int TRACE_smpi_is_enabled(void)
145 {
146   return trace_smpi_enabled && TRACE_is_enabled();
147 }
148
149 int TRACE_smpi_is_grouped(void)
150 {
151   return trace_smpi_grouped;
152 }
153
154 int TRACE_categorized (void)
155 {
156   return trace_categorized;
157 }
158
159 int TRACE_uncategorized (void)
160 {
161   return trace_uncategorized;
162 }
163
164 int TRACE_msg_task_is_enabled(void)
165 {
166   return trace_msg_task_enabled && TRACE_is_enabled();
167 }
168
169 int TRACE_msg_process_is_enabled(void)
170 {
171   return trace_msg_process_enabled && TRACE_is_enabled();
172 }
173
174 int TRACE_msg_volume_is_enabled(void)
175 {
176   return trace_msg_volume_enabled && TRACE_is_enabled();
177 }
178
179 int TRACE_buffer (void)
180 {
181   return trace_buffer && TRACE_is_enabled();
182 }
183
184 int TRACE_onelink_only (void)
185 {
186   return trace_onelink_only && TRACE_is_enabled();
187 }
188
189 char *TRACE_get_filename(void)
190 {
191   return xbt_cfg_get_string(_surf_cfg_set, OPT_TRACING_FILENAME);
192 }
193
194 char *TRACE_get_triva_uncat_conf (void)
195 {
196   return xbt_cfg_get_string(_surf_cfg_set, OPT_TRIVA_UNCAT_CONF);
197 }
198
199 char *TRACE_get_triva_cat_conf (void)
200 {
201   return xbt_cfg_get_string(_surf_cfg_set, OPT_TRIVA_CAT_CONF);
202 }
203
204 void TRACE_global_init(int *argc, char **argv)
205 {
206   /* name of the tracefile */
207   char *default_tracing_filename = xbt_strdup("simgrid.trace");
208   xbt_cfg_register(&_surf_cfg_set, OPT_TRACING_FILENAME,
209                    "Trace file created by the instrumented SimGrid.",
210                    xbt_cfgelm_string, &default_tracing_filename, 1, 1,
211                    NULL, NULL);
212
213   /* tracing */
214   int default_tracing = 0;
215   xbt_cfg_register(&_surf_cfg_set, OPT_TRACING,
216                    "Enable Tracing.",
217                    xbt_cfgelm_int, &default_tracing, 0, 1,
218                    NULL, NULL);
219
220   /* smpi */
221   int default_tracing_smpi = 0;
222   xbt_cfg_register(&_surf_cfg_set, OPT_TRACING_SMPI,
223                    "Tracing of the SMPI interface.",
224                    xbt_cfgelm_int, &default_tracing_smpi, 0, 1,
225                    NULL, NULL);
226
227   /* smpi grouped */
228   int default_tracing_smpi_grouped = 0;
229   xbt_cfg_register(&_surf_cfg_set, OPT_TRACING_SMPI_GROUP,
230                    "Group MPI processes by host.",
231                    xbt_cfgelm_int, &default_tracing_smpi_grouped, 0, 1,
232                    NULL, NULL);
233
234
235   /* platform */
236   int default_tracing_platform = 0;
237   xbt_cfg_register(&_surf_cfg_set, OPT_TRACING_CATEGORIZED,
238                    "Tracing of categorized platform (host and link) utilization.",
239                    xbt_cfgelm_int, &default_tracing_platform, 0, 1,
240                    NULL, NULL);
241
242   /* tracing uncategorized resource utilization */
243   int default_tracing_uncategorized = 0;
244   xbt_cfg_register(&_surf_cfg_set, OPT_TRACING_UNCATEGORIZED,
245                    "Tracing of uncategorized resource (host and link) utilization.",
246                    xbt_cfgelm_int, &default_tracing_uncategorized, 0, 1,
247                    NULL, NULL);
248
249   /* msg task */
250   int default_tracing_msg_task = 0;
251   xbt_cfg_register(&_surf_cfg_set, OPT_TRACING_MSG_TASK,
252                    "Tracing of MSG task behavior.",
253                    xbt_cfgelm_int, &default_tracing_msg_task, 0, 1,
254                    NULL, NULL);
255
256   /* msg process */
257   int default_tracing_msg_process = 0;
258   xbt_cfg_register(&_surf_cfg_set, OPT_TRACING_MSG_PROCESS,
259                    "Tracing of MSG process behavior.",
260                    xbt_cfgelm_int, &default_tracing_msg_process, 0, 1,
261                    NULL, NULL);
262
263   /* msg volume (experimental) */
264   int default_tracing_msg_volume = 0;
265   xbt_cfg_register(&_surf_cfg_set, OPT_TRACING_MSG_VOLUME,
266                    "Tracing of MSG communication volume (experimental).",
267                    xbt_cfgelm_int, &default_tracing_msg_volume, 0, 1,
268                    NULL, NULL);
269
270   /* msg volume (experimental) */
271   int default_buffer = 0;
272   xbt_cfg_register(&_surf_cfg_set, OPT_TRACING_BUFFER,
273                    "Buffer trace events to put them in temporal order.",
274                    xbt_cfgelm_int, &default_buffer, 0, 1,
275                    NULL, NULL);
276
277   /* msg volume (experimental) */
278   int default_onelink_only = 0;
279   xbt_cfg_register(&_surf_cfg_set, OPT_TRACING_ONELINK_ONLY,
280                    "Use only routes with one link to trace platform.",
281                    xbt_cfgelm_int, &default_onelink_only, 0, 1,
282                    NULL, NULL);
283
284   /* Triva graph configuration for uncategorized tracing */
285   char *default_triva_uncat_conf_file = xbt_strdup ("");
286   xbt_cfg_register(&_surf_cfg_set, OPT_TRIVA_UNCAT_CONF,
287                    "Triva Graph configuration file for uncategorized resource utilization traces.",
288                    xbt_cfgelm_string, &default_triva_uncat_conf_file, 1, 1,
289                    NULL, NULL);
290
291   /* Triva graph configuration for uncategorized tracing */
292   char *default_triva_cat_conf_file = xbt_strdup ("");
293   xbt_cfg_register(&_surf_cfg_set, OPT_TRIVA_CAT_CONF,
294                    "Triva Graph configuration file for categorized resource utilization traces.",
295                    xbt_cfgelm_string, &default_triva_cat_conf_file, 1, 1,
296                    NULL, NULL);
297
298   /* instrumentation can be considered configured now */
299   trace_configured = 1;
300 }
301
302 static void print_line (const char *option, const char *desc, const char *longdesc, int detailed)
303 {
304   char str[INSTR_DEFAULT_STR_SIZE];
305   snprintf (str, INSTR_DEFAULT_STR_SIZE, "--cfg=%s ", option);
306
307   int len = strlen (str);
308   printf ("%s%*.*s %s\n", str, 30-len, 30-len, "", desc);
309   if (!!longdesc && detailed){
310     printf ("%s\n\n", longdesc);
311   }
312 }
313
314 void TRACE_help (int detailed)
315 {
316   printf(
317       "Description of the tracing options accepted by this simulator:\n\n");
318   print_line (OPT_TRACING, "Enable the tracing system",
319       "  It activates the tracing system and register the simulation platform\n"
320       "  in the trace file. You have to enable this option to others take effect.",
321       detailed);
322   print_line (OPT_TRACING_CATEGORIZED, "Trace categorized resource utilization",
323       "  It activates the categorized resource utilization tracing. It should\n"
324       "  be enabled if tracing categories are used by this simulator.",
325       detailed);
326   print_line (OPT_TRACING_UNCATEGORIZED, "Trace uncategorized resource utilization",
327       "  It activates the uncategorized resource utilization tracing. Use it if\n"
328       "  this simulator do not use tracing categories and resource use have to be\n"
329       "  traced.",
330       detailed);
331   print_line (OPT_TRACING_FILENAME, "Filename to register traces",
332       "  A file with this name will be created to register the simulation. The file\n"
333       "  is in the Paje format and can be analyzed using Triva or Paje visualization\n"
334       "  tools. More information can be found in these webpages:\n"
335       "     http://triva.gforge.inria.fr/\n"
336       "     http://paje.sourceforge.net/",
337       detailed);
338   print_line (OPT_TRACING_SMPI, "Trace the MPI Interface (SMPI)",
339       "  This option only has effect if this simulator is SMPI-based. Traces the MPI\n"
340       "  interface and generates a trace that can be analyzed using Gantt-like\n"
341       "  visualizations. Every MPI function (implemented by SMPI) is transformed in a\n"
342       "  state, and point-to-point communications can be analyzed with arrows.",
343       detailed);
344   print_line (OPT_TRACING_SMPI_GROUP, "Group MPI processes by host (SMPI)",
345       "  This option only has effect if this simulator is SMPI-based. The processes\n"
346       "  are grouped by the hosts where they were executed.",
347       detailed);
348   print_line (OPT_TRACING_MSG_TASK, "Trace task behavior (MSG)",
349       "  This option only has effect if this simulator is MSG-based. It traces the\n"
350       "  behavior of all categorized MSG tasks, grouping them by hosts.",
351       detailed);
352   print_line (OPT_TRACING_MSG_PROCESS, "Trace processes behavior (MSG)",
353       "  This option only has effect if this simulator is MSG-based. It traces the\n"
354       "  behavior of all categorized MSG processes, grouping them by hosts. This option\n"
355       "  can be used to track process location if this simulator has process migration.",
356       detailed);
357   print_line (OPT_TRACING_MSG_VOLUME, "Tracing of communication volume (MSG)",
358       "  This experimental option only has effect if this simulator is MSG-based.\n"
359       "  It traces the communication volume of MSG send/receive.",
360       detailed);
361   print_line (OPT_TRACING_BUFFER, "Buffer events to put them in temporal order",
362       "  This option put some events in a time-ordered buffer using the insertion\n"
363       "  sort algorithm. The process of acquiring and releasing locks to access this\n"
364       "  buffer and the cost of the sorting algorithm make this process slow. The\n"
365       "  simulator performance can be severely impacted if this option is activated,\n"
366       "  but you are sure to get a trace file with events sorted.",
367       detailed);
368   print_line (OPT_TRACING_ONELINK_ONLY, "Consider only one link routes to trace platform",
369       "  This option changes the way SimGrid register its platform on the trace file.\n"
370       "  Normally, the tracing considers all routes (no matter their size) on the\n"
371       "  platform file to re-create the resource topology. If this option is activated,\n"
372       "  only the routes with one link are used to register the topology within an AS.\n"
373       "  Routes among AS continue to be traced as usual.",
374       detailed);
375   print_line (OPT_TRIVA_UNCAT_CONF, "Generate graph configuration for Triva",
376       "  This option can be used in all types of simulators build with SimGrid\n"
377       "  to generate a uncategorized resource utilization graph to be used as\n"
378       "  configuration for the Triva visualization analysis. This option\n"
379       "  can be used with tracing/categorized:1 and tracing:1 options to\n"
380       "  analyze an unmodified simulator before changing it to contain\n"
381       "  categories.",
382       detailed);
383   print_line (OPT_TRIVA_CAT_CONF, "generate uncategorized graph configuration for Triva",
384       "  This option can be used if this simulator uses tracing categories\n"
385       "  in its code. The file specified by this option holds a graph configuration\n"
386       "  file for the Triva visualization tool that can be used to analyze a categorized\n"
387       "  resource utilization.",
388       detailed);
389 }
390
391 void TRACE_generate_triva_uncat_conf (void)
392 {
393   char *output = TRACE_get_triva_uncat_conf ();
394   if (output && strlen(output) > 0){
395     xbt_dict_cursor_t cursor=NULL;
396     char *name, *value;
397
398     FILE *file = fopen (output, "w");
399     xbt_assert (file != NULL,
400        "Unable to open file (%s) for writing triva graph "
401        "configuration (uncategorized).", output);
402
403     //open
404     fprintf (file, "{\n");
405
406     //register NODE types
407     fprintf (file, "  node = (");
408     xbt_dict_foreach(trivaNodeTypes, cursor, name, value) {
409       fprintf (file, "%s, ", name);
410     }
411
412     //register EDGE types
413     fprintf (file,
414         ");\n"
415         "  edge = (");
416     xbt_dict_foreach(trivaEdgeTypes, cursor, name, value) {
417       fprintf (file, "%s, ", name);
418     }
419     fprintf (file,
420         ");\n"
421         "\n");
422
423     //configuration for all nodes
424     fprintf (file,
425         "  host = {\n"
426         "    type = square;\n"
427         "    size = power;\n"
428         "    values = (power_used);\n"
429         "  };\n"
430         "  link = {\n"
431         "    type = rhombus;\n"
432         "    size = bandwidth;\n"
433         "    values = (bandwidth_used);\n"
434         "  };\n");
435     //close
436     fprintf (file, "}\n");
437     fclose (file);
438   }
439 }
440
441 void TRACE_generate_triva_cat_conf (void)
442 {
443   char *output = TRACE_get_triva_cat_conf();
444   if (output && strlen(output) > 0){
445     xbt_dict_cursor_t cursor=NULL, cursor2=NULL;
446     char *name, *name2, *value, *value2;
447
448     //check if we do have categories declared
449     if (xbt_dict_length(created_categories) == 0){
450       XBT_INFO("No categories declared, ignoring generation of triva graph configuration");
451       return;
452     }
453
454     FILE *file = fopen (output, "w");
455     xbt_assert (file != NULL,
456        "Unable to open file (%s) for writing triva graph "
457        "configuration (categorized).", output);
458
459     //open
460     fprintf (file, "{\n");
461
462     //register NODE types
463     fprintf (file, "  node = (");
464     xbt_dict_foreach(trivaNodeTypes, cursor, name, value) {
465       fprintf (file, "%s, ", name);
466     }
467
468     //register EDGE types
469     fprintf (file,
470         ");\n"
471         "  edge = (");
472     xbt_dict_foreach(trivaEdgeTypes, cursor, name, value) {
473       fprintf (file, "%s, ", name);
474     }
475     fprintf (file,
476         ");\n"
477         "\n");
478
479     //configuration for all nodes
480     fprintf (file,
481         "  host = {\n"
482         "    type = square;\n"
483         "    size = power;\n"
484         "    values = (");
485     xbt_dict_foreach(created_categories,cursor2,name2,value2) {
486       fprintf (file, "p%s, ", name2);
487     }
488     fprintf (file,
489         ");\n"
490         "  };\n"
491         "  link = {\n"
492         "    type = rhombus;\n"
493         "    size = bandwidth;\n"
494         "    values = (");
495     xbt_dict_foreach(created_categories,cursor2,name2,value2) {
496       fprintf (file, "b%s, ", name2);
497     }
498     fprintf (file,
499         ");\n"
500         "  };\n");
501     //close
502     fprintf (file, "}\n");
503     fclose (file);
504   }
505 }
506
507 #undef OPT_TRACING
508 #undef OPT_TRACING_SMPI
509 #undef OPT_TRACING_SMPI_GROUP
510 #undef OPT_TRACING_CATEGORIZED
511 #undef OPT_TRACING_UNCATEGORIZED
512 #undef OPT_TRACING_MSG_TASK
513 #undef OPT_TRACING_MSG_PROCESS
514 #undef OPT_TRACING_MSG_VOLUME
515 #undef OPT_TRACING_FILENAME
516 #undef OPT_TRACING_PLATFORM_METHOD
517 #undef OPT_TRIVA_UNCAT_CONF
518 #undef OPT_TRIVA_CAT_CONF
519
520 #endif /* HAVE_TRACING */