Logo AND Algorithmique Numérique Distribuée

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