Logo AND Algorithmique Numérique Distribuée

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