1 /* Copyright (c) 2010. The SimGrid Team.
2 * All rights reserved. */
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. */
8 #include "instr/instr_private.h"
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");
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"
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;
40 static int trace_configured = 0;
41 static int trace_active = 0;
43 xbt_dict_t created_categories; //declared in instr_interface.c
45 static void TRACE_getopts(void)
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);
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())){
70 XBT_DEBUG("Tracing starts");
72 /* open the trace file */
78 /* other trace initialization */
79 created_categories = xbt_dict_new();
87 if (!TRACE_is_active())
90 /* generate uncategorized graph configuration for triva */
91 if (TRACE_get_triva_uncat_conf()){
92 TRACE_generate_triva_uncat_conf();
95 /* generate categorized graph configuration for triva */
96 if (TRACE_get_triva_cat_conf()){
97 TRACE_generate_triva_cat_conf();
100 /* dump trace buffer */
101 TRACE_last_timestamp_to_dump = surf_get_clock();
102 TRACE_paje_dump_buffer(1);
104 /* destroy all data structures of tracing (and free) */
105 destroyAllContainers();
107 /* close the trace file */
111 TRACE_desactivate ();
112 XBT_DEBUG("Tracing system is shutdown");
116 void TRACE_activate (void)
118 xbt_assert (trace_active==0, "Tracing is already active.");
120 XBT_DEBUG ("Tracing is on");
123 void TRACE_desactivate (void)
126 XBT_DEBUG ("Tracing is off");
129 int TRACE_is_active (void)
134 int TRACE_is_enabled(void)
136 return trace_enabled;
139 int TRACE_is_configured(void)
141 return trace_configured;
144 int TRACE_smpi_is_enabled(void)
146 return trace_smpi_enabled && TRACE_is_enabled();
149 int TRACE_smpi_is_grouped(void)
151 return trace_smpi_grouped;
154 int TRACE_categorized (void)
156 return trace_categorized;
159 int TRACE_uncategorized (void)
161 return trace_uncategorized;
164 int TRACE_msg_task_is_enabled(void)
166 return trace_msg_task_enabled && TRACE_is_enabled();
169 int TRACE_msg_process_is_enabled(void)
171 return trace_msg_process_enabled && TRACE_is_enabled();
174 int TRACE_msg_volume_is_enabled(void)
176 return trace_msg_volume_enabled && TRACE_is_enabled();
179 int TRACE_buffer (void)
181 return trace_buffer && TRACE_is_enabled();
184 int TRACE_onelink_only (void)
186 return trace_onelink_only && TRACE_is_enabled();
189 char *TRACE_get_filename(void)
191 return xbt_cfg_get_string(_surf_cfg_set, OPT_TRACING_FILENAME);
194 char *TRACE_get_triva_uncat_conf (void)
196 return xbt_cfg_get_string(_surf_cfg_set, OPT_TRIVA_UNCAT_CONF);
199 char *TRACE_get_triva_cat_conf (void)
201 return xbt_cfg_get_string(_surf_cfg_set, OPT_TRIVA_CAT_CONF);
204 void TRACE_global_init(int *argc, char **argv)
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,
214 int default_tracing = 0;
215 xbt_cfg_register(&_surf_cfg_set, OPT_TRACING,
217 xbt_cfgelm_int, &default_tracing, 0, 1,
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,
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,
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,
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,
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,
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,
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,
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,
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,
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,
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,
298 /* instrumentation can be considered configured now */
299 trace_configured = 1;
302 static void print_line (const char *option, const char *desc, const char *longdesc, int detailed)
304 char str[INSTR_DEFAULT_STR_SIZE];
305 snprintf (str, INSTR_DEFAULT_STR_SIZE, "--cfg=%s ", option);
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);
314 void TRACE_help (int detailed)
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.",
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.",
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"
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/",
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.",
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.",
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.",
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.",
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.",
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.",
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.",
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"
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.",
391 void TRACE_generate_triva_uncat_conf (void)
393 char *output = TRACE_get_triva_uncat_conf ();
394 if (output && strlen(output) > 0){
395 xbt_dict_cursor_t cursor=NULL;
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);
404 fprintf (file, "{\n");
406 //register NODE types
407 fprintf (file, " node = (");
408 xbt_dict_foreach(trivaNodeTypes, cursor, name, value) {
409 fprintf (file, "%s, ", name);
412 //register EDGE types
416 xbt_dict_foreach(trivaEdgeTypes, cursor, name, value) {
417 fprintf (file, "%s, ", name);
423 //configuration for all nodes
428 " values = (power_used);\n"
432 " size = bandwidth;\n"
433 " values = (bandwidth_used);\n"
436 fprintf (file, "}\n");
441 void TRACE_generate_triva_cat_conf (void)
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;
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");
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);
460 fprintf (file, "{\n");
462 //register NODE types
463 fprintf (file, " node = (");
464 xbt_dict_foreach(trivaNodeTypes, cursor, name, value) {
465 fprintf (file, "%s, ", name);
468 //register EDGE types
472 xbt_dict_foreach(trivaEdgeTypes, cursor, name, value) {
473 fprintf (file, "%s, ", name);
479 //configuration for all nodes
485 xbt_dict_foreach(created_categories,cursor2,name2,value2) {
486 fprintf (file, "p%s, ", name2);
493 " size = bandwidth;\n"
495 xbt_dict_foreach(created_categories,cursor2,name2,value2) {
496 fprintf (file, "b%s, ", name2);
502 fprintf (file, "}\n");
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
520 #endif /* HAVE_TRACING */