Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[trace] smpi types declaration updated
[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_PLATFORM_METHOD "tracing/platform/method"
25 #define OPT_TRIVA_UNCAT_CONF      "triva/uncategorized"
26 #define OPT_TRIVA_CAT_CONF        "triva/categorized"
27
28 static int trace_configured = 0;
29 static int trace_active = 0;
30
31 xbt_dict_t created_categories; //declared in instr_interface.c
32
33 int TRACE_start()
34 {
35   // tracing system must be:
36   //    - enabled (with --cfg=tracing:1)
37   //    - already configured (TRACE_global_init already called)
38   if (!(TRACE_is_enabled() && TRACE_is_configured())){
39     return 0;
40   }
41
42   DEBUG0("Tracing starts");
43
44   /* open the trace file */
45   TRACE_paje_start();
46
47   /* activate trace */
48   TRACE_activate ();
49
50   /* base type hierarchy:
51    * --cfg=tracing
52    */
53   if(0){
54 //  FIXME
55 //  pajeDefineEventType("source", "LINK", "source");
56 //  pajeDefineEventType("destination", "LINK", "destination");
57
58   /* type hierarchy for:
59    * --cfg=tracing/msg/process
60    * --cfg=tracing/msg/volume
61    */
62 //  FIXME
63 //  if (TRACE_msg_process_is_enabled() || TRACE_msg_volume_is_enabled()) {
64 //    //processes grouped by host
65 //    pajeDefineContainerType("PROCESS", "HOST", "PROCESS");
66 //  }
67 //
68 //  if (TRACE_msg_process_is_enabled()) {
69 //    pajeDefineStateType("category", "PROCESS", "category");
70 //    pajeDefineStateType("presence", "PROCESS", "presence");
71 //  }
72 //
73 //  if (TRACE_msg_volume_is_enabled()) {
74 //    pajeDefineLinkType("volume", "0", "PROCESS", "PROCESS", "volume");
75 //  }
76
77   /* type hierarchy for:
78    * --cfg=tracing/msg/task
79    */
80 //  FIXME
81 //  if (TRACE_msg_task_is_enabled()) {
82 //    //tasks grouped by host
83 //    pajeDefineContainerType("TASK", "HOST", "TASK");
84 //    pajeDefineStateType("category", "TASK", "category");
85 //    pajeDefineStateType("presence", "TASK", "presence");
86 //  }
87   }
88   /* other trace initialization */
89   created_categories = xbt_dict_new();
90   TRACE_msg_task_alloc();
91   TRACE_surf_alloc();
92   TRACE_msg_process_alloc();
93   TRACE_smpi_alloc();
94   return 0;
95 }
96
97 int TRACE_end()
98 {
99   if (!TRACE_is_active())
100     return 1;
101
102   /* close the trace file */
103   TRACE_paje_end();
104
105   /* generate uncategorized graph configuration for triva */
106   if (TRACE_get_triva_uncat_conf()){
107     TRACE_generate_triva_uncat_conf();
108   }
109
110   /* generate categorized graph configuration for triva */
111   if (TRACE_get_triva_cat_conf()){
112     TRACE_generate_triva_cat_conf();
113   }
114
115   /* activate trace */
116   TRACE_desactivate ();
117   DEBUG0("Tracing system is shutdown");
118   return 0;
119 }
120
121 void TRACE_activate (void)
122 {
123   xbt_assert0 (trace_active==0, "Tracing is already active.");
124   trace_active = 1;
125   DEBUG0 ("Tracing is on");
126 }
127
128 void TRACE_desactivate (void)
129 {
130   trace_active = 0;
131   DEBUG0 ("Tracing is off");
132 }
133
134 int TRACE_is_active (void)
135 {
136   return trace_active;
137 }
138
139 int TRACE_is_enabled(void)
140 {
141   return xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING);
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 xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_SMPI);
152 }
153
154 int TRACE_smpi_is_grouped(void)
155 {
156   return xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_SMPI_GROUP);
157 }
158
159 int TRACE_categorized (void)
160 {
161   return xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_CATEGORIZED);
162 }
163
164 int TRACE_uncategorized (void)
165 {
166   return xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_UNCATEGORIZED);
167 }
168
169 int TRACE_msg_task_is_enabled(void)
170 {
171   return xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_MSG_TASK);
172 }
173
174 int TRACE_msg_process_is_enabled(void)
175 {
176   return xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_MSG_PROCESS);
177 }
178
179 int TRACE_msg_volume_is_enabled(void)
180 {
181   return xbt_cfg_get_int(_surf_cfg_set, OPT_TRACING_MSG_VOLUME);
182 }
183
184 char *TRACE_get_filename(void)
185 {
186   return xbt_cfg_get_string(_surf_cfg_set, OPT_TRACING_FILENAME);
187 }
188
189 char *TRACE_get_platform_method(void)
190 {
191   return xbt_cfg_get_string(_surf_cfg_set, OPT_TRACING_PLATFORM_METHOD);
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   /* platform method */
250   char *default_tracing_platform_method = xbt_strdup("a");
251   xbt_cfg_register(&_surf_cfg_set, OPT_TRACING_PLATFORM_METHOD,
252                    "Tracing method used to register categorized resource behavior.",
253                    xbt_cfgelm_string, &default_tracing_platform_method, 1,
254                    1, NULL, NULL);
255
256   /* msg task */
257   int default_tracing_msg_task = 0;
258   xbt_cfg_register(&_surf_cfg_set, OPT_TRACING_MSG_TASK,
259                    "Tracing of MSG task behavior.",
260                    xbt_cfgelm_int, &default_tracing_msg_task, 0, 1,
261                    NULL, NULL);
262
263   /* msg process */
264   int default_tracing_msg_process = 0;
265   xbt_cfg_register(&_surf_cfg_set, OPT_TRACING_MSG_PROCESS,
266                    "Tracing of MSG process behavior.",
267                    xbt_cfgelm_int, &default_tracing_msg_process, 0, 1,
268                    NULL, NULL);
269
270   /* msg volume (experimental) */
271   int default_tracing_msg_volume = 0;
272   xbt_cfg_register(&_surf_cfg_set, OPT_TRACING_MSG_VOLUME,
273                    "Tracing of MSG communication volume (experimental).",
274                    xbt_cfgelm_int, &default_tracing_msg_volume, 0, 1,
275                    NULL, NULL);
276
277   /* Triva graph configuration for uncategorized tracing */
278   char *default_triva_uncat_conf_file = xbt_strdup ("");
279   xbt_cfg_register(&_surf_cfg_set, OPT_TRIVA_UNCAT_CONF,
280                    "Triva Graph configuration file for uncategorized resource utilization traces.",
281                    xbt_cfgelm_string, &default_triva_uncat_conf_file, 1, 1,
282                    NULL, NULL);
283
284   /* Triva graph configuration for uncategorized tracing */
285   char *default_triva_cat_conf_file = xbt_strdup ("");
286   xbt_cfg_register(&_surf_cfg_set, OPT_TRIVA_CAT_CONF,
287                    "Triva Graph configuration file for categorized resource utilization traces.",
288                    xbt_cfgelm_string, &default_triva_cat_conf_file, 1, 1,
289                    NULL, NULL);
290
291   /* instrumentation can be considered configured now */
292   trace_configured = 1;
293 }
294
295 static void print_line (const char *option, const char *desc, const char *longdesc, int detailed)
296 {
297   char str[INSTR_DEFAULT_STR_SIZE];
298   snprintf (str, INSTR_DEFAULT_STR_SIZE, "--cfg=%s ", option);
299
300   int len = strlen (str);
301   printf ("%s%*.*s %s\n", str, 30-len, 30-len, "", desc);
302   if (!!longdesc && detailed){
303     printf ("%s\n\n", longdesc);
304   }
305 }
306
307 void TRACE_help (int detailed)
308 {
309   printf(
310       "Description of the tracing options accepted by this simulator:\n\n");
311   print_line (OPT_TRACING, "Enable the tracing system",
312       "  It activates the tracing system and register the simulation platform\n"
313       "  in the trace file. You have to enable this option to others take effect.",
314       detailed);
315   print_line (OPT_TRACING_CATEGORIZED, "Trace categorized resource utilization",
316       "  It activates the categorized resource utilization tracing. It should\n"
317       "  be enabled if tracing categories are used by this simulator.",
318       detailed);
319   print_line (OPT_TRACING_UNCATEGORIZED, "Trace uncategorized resource utilization",
320       "  It activates the uncategorized resource utilization tracing. Use it if\n"
321       "  this simulator do not use tracing categories and resource use have to be\n"
322       "  traced.",
323       detailed);
324   print_line (OPT_TRACING_PLATFORM_METHOD, "Change the resource utilization tracing method",
325       "  It changes the way resource utilization (categorized or not) is traced\n"
326       "  inside the simulation core. Method 'a' (default) traces all updates defined\n"
327       "  by the CPU/network model of a given resource. Depending on the interface used\n"
328       "  by this simulator (MSG, SMPI, SimDAG), the default method can generate large\n"
329       "  trace files. Method 'b' tries to make smaller tracefiles using clever updates,\n"
330       "  without losing details of resource utilization. Method 'c' generates even\n"
331       "  smaller files by doing time integration during the simulation, but it loses\n"
332       "  precision. If this last method is used, the smallest timeslice used in the\n"
333       "  tracefile analysis must be bigger than the smaller resource utilization. If\n"
334       "  unsure, do not change this option.",
335       detailed);
336   print_line (OPT_TRACING_FILENAME, "Filename to register traces",
337       "  A file with this name will be created to register the simulation. The file\n"
338       "  is in the Paje format and can be analyzed using Triva or Paje visualization\n"
339       "  tools. More information can be found in these webpages:\n"
340       "     http://triva.gforge.inria.fr/\n"
341       "     http://paje.sourceforge.net/",
342       detailed);
343   print_line (OPT_TRACING_SMPI, "Trace the MPI Interface (SMPI)",
344       "  This option only has effect if this simulator is SMPI-based. Traces the MPI\n"
345       "  interface and generates a trace that can be analyzed using Gantt-like\n"
346       "  visualizations. Every MPI function (implemented by SMPI) is transformed in a\n"
347       "  state, and point-to-point communications can be analyzed with arrows.",
348       detailed);
349   print_line (OPT_TRACING_SMPI_GROUP, "Group MPI processes by host (SMPI)",
350       "  This option only has effect if this simulator is SMPI-based. The processes\n"
351       "  are grouped by the hosts where they were executed.",
352       detailed);
353   print_line (OPT_TRACING_MSG_TASK, "Trace task behavior (MSG)",
354       "  This option only has effect if this simulator is MSG-based. It traces the\n"
355       "  behavior of all categorized MSG tasks, grouping them by hosts.",
356       detailed);
357   print_line (OPT_TRACING_MSG_PROCESS, "Trace processes behavior (MSG)",
358       "  This option only has effect if this simulator is MSG-based. It traces the\n"
359       "  behavior of all categorized MSG processes, grouping them by hosts. This option\n"
360       "  can be used to track process location if this simulator has process migration.",
361       detailed);
362   print_line (OPT_TRACING_MSG_VOLUME, "Tracing of communication volume (MSG)",
363       "  This experimental option only has effect if this simulator is MSG-based.\n"
364       "  It traces the communication volume of MSG send/receive.",
365       detailed);
366   print_line (OPT_TRIVA_UNCAT_CONF, "Generate graph configuration for Triva",
367       "  This option can be used in all types of simulators build with SimGrid\n"
368       "  to generate a uncategorized resource utilization graph to be used as\n"
369       "  configuration for the Triva visualization analysis. This option\n"
370       "  can be used with tracing/categorized:1 and tracing:1 options to\n"
371       "  analyze an unmodified simulator before changing it to contain\n"
372       "  categories.",
373       detailed);
374   print_line (OPT_TRIVA_CAT_CONF, "generate uncategorized graph configuration for Triva",
375       "  This option can be used if this simulator uses tracing categories\n"
376       "  in its code. The file specified by this option holds a graph configuration\n"
377       "  file for the Triva visualization tool that can be used to analyze a categorized\n"
378       "  resource utilization.",
379       detailed);
380 }
381
382 void TRACE_generate_triva_uncat_conf (void)
383 {
384   char *output = TRACE_get_triva_uncat_conf ();
385   if (output && strlen(output) > 0){
386     FILE *file = fopen (output, "w");
387     xbt_assert1 (file != NULL,
388        "Unable to open file (%s) for writing triva graph "
389        "configuration (uncategorized).", output);
390     fprintf (file,
391         "{\n"
392         "  node = (HOST);\n"
393         "  edge = (LINK);\n"
394         "\n"
395         "  HOST = {\n"
396         "    size = power;\n"
397         "    scale = global;\n"
398         "    host_sep = {\n"
399         "      type = separation;\n"
400         "      size = power;\n"
401         "      values = (power_used);\n"
402         "    };\n"
403         "  };\n"
404         "  LINK = {\n"
405         "    src = source;\n"
406         "    dst = destination;\n"
407         "    size = bandwidth;\n"
408         "    scale = global;\n"
409         "    link_sep = {\n"
410         "      type = separation;\n"
411         "      size = bandwidth;\n"
412         "      values = (bandwidth_used);\n"
413         "    };\n"
414         "  };\n"
415         "  graphviz-algorithm = neato;\n"
416         "}\n"
417         );
418     fclose (file);
419   }
420 }
421
422 void TRACE_generate_triva_cat_conf (void)
423 {
424   char *output = TRACE_get_triva_cat_conf();
425   if (output && strlen(output) > 0){
426     //check if we do have categories declared
427     if (xbt_dict_length(created_categories) == 0){
428       INFO0("No categories declared, ignoring generation of triva graph configuration");
429       return;
430     }
431     xbt_dict_cursor_t cursor=NULL;
432     char *key, *data;
433     FILE *file = fopen (output, "w");
434     xbt_assert1 (file != NULL,
435        "Unable to open file (%s) for writing triva graph "
436        "configuration (categorized).", output);
437     fprintf (file,
438         "{\n"
439         "  node = (HOST);\n"
440         "  edge = (LINK);\n"
441         "\n"
442         "  HOST = {\n"
443         "    size = power;\n"
444         "    scale = global;\n"
445         "    host_sep = {\n"
446         "      type = separation;\n"
447         "      size = power;\n"
448         "      values = (");
449     xbt_dict_foreach(created_categories,cursor,key,data) {
450       fprintf(file, "%s, ",key);
451     }
452     fprintf (file,
453         ");\n"
454         "    };\n"
455         "  };\n"
456         "  LINK = {\n"
457         "    src = source;\n"
458         "    dst = destination;\n"
459         "    size = bandwidth;\n"
460         "    scale = global;\n"
461         "    link_sep = {\n"
462         "      type = separation;\n"
463         "      size = bandwidth;\n"
464         "      values = (");
465     xbt_dict_foreach(created_categories,cursor,key,data) {
466       fprintf(file, "%s, ",key);
467     }
468     fprintf (file,
469         ");\n"
470         "    };\n"
471         "  };\n"
472         "  graphviz-algorithm = neato;\n"
473         "}\n"
474         );
475     fclose(file);
476   }
477 }
478
479 #undef OPT_TRACING
480 #undef OPT_TRACING_SMPI
481 #undef OPT_TRACING_SMPI_GROUP
482 #undef OPT_TRACING_CATEGORIZED
483 #undef OPT_TRACING_UNCATEGORIZED
484 #undef OPT_TRACING_MSG_TASK
485 #undef OPT_TRACING_MSG_PROCESS
486 #undef OPT_TRACING_MSG_VOLUME
487 #undef OPT_TRACING_FILENAME
488 #undef OPT_TRACING_PLATFORM_METHOD
489 #undef OPT_TRIVA_UNCAT_CONF
490 #undef OPT_TRIVA_CAT_CONF
491
492 #endif /* HAVE_TRACING */