-/* Copyright (c) 2010. The SimGrid Team.
+/* Copyright (c) 2010-2013. The SimGrid Team.
* All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
#include "instr/instr_private.h"
#include "simgrid/sg_config.h"
+#include "surf/surf.h"
#ifdef HAVE_TRACING
#define OPT_TRACING_SMPI "tracing/smpi"
#define OPT_TRACING_SMPI_GROUP "tracing/smpi/group"
#define OPT_TRACING_SMPI_COMPUTING "tracing/smpi/computing"
+#define OPT_TRACING_SMPI_INTERNALS "tracing/smpi/internals"
+#define OPT_TRACING_DISPLAY_SIZES "tracing/smpi/display_sizes"
#define OPT_TRACING_CATEGORIZED "tracing/categorized"
#define OPT_TRACING_UNCATEGORIZED "tracing/uncategorized"
#define OPT_TRACING_MSG_PROCESS "tracing/msg/process"
+#define OPT_TRACING_MSG_VM "tracing/msg/vm"
#define OPT_TRACING_FILENAME "tracing/filename"
#define OPT_TRACING_BUFFER "tracing/buffer"
#define OPT_TRACING_ONELINK_ONLY "tracing/onelink_only"
#define OPT_TRACING_COMMENT_FILE "tracing/comment_file"
#define OPT_VIVA_UNCAT_CONF "viva/uncategorized"
#define OPT_VIVA_CAT_CONF "viva/categorized"
+#define OPT_TRACING_DISABLE_LINK "tracing/disable_link"
+#define OPT_TRACING_DISABLE_POWER "tracing/disable_power"
static int trace_enabled;
static int trace_platform;
static int trace_smpi_enabled;
static int trace_smpi_grouped;
static int trace_smpi_computing;
+static int trace_view_internals;
static int trace_categorized;
static int trace_uncategorized;
static int trace_msg_process_enabled;
+static int trace_msg_vm_enabled;
static int trace_buffer;
static int trace_onelink_only;
static int trace_disable_destroy;
static int trace_basic;
+static int trace_display_sizes = 0;
+static int trace_disable_link;
+static int trace_disable_power;
static int trace_configured = 0;
static int trace_active = 0;
+
+
static void TRACE_getopts(void)
{
trace_enabled = xbt_cfg_get_int(_sg_cfg_set, OPT_TRACING);
trace_smpi_enabled = xbt_cfg_get_int(_sg_cfg_set, OPT_TRACING_SMPI);
trace_smpi_grouped = xbt_cfg_get_int(_sg_cfg_set, OPT_TRACING_SMPI_GROUP);
trace_smpi_computing = xbt_cfg_get_int(_sg_cfg_set, OPT_TRACING_SMPI_COMPUTING);
+ trace_view_internals = xbt_cfg_get_int(_sg_cfg_set, OPT_TRACING_SMPI_INTERNALS);
trace_categorized = xbt_cfg_get_int(_sg_cfg_set, OPT_TRACING_CATEGORIZED);
trace_uncategorized = xbt_cfg_get_int(_sg_cfg_set, OPT_TRACING_UNCATEGORIZED);
trace_msg_process_enabled = xbt_cfg_get_int(_sg_cfg_set, OPT_TRACING_MSG_PROCESS);
+ trace_msg_vm_enabled = xbt_cfg_get_int(_sg_cfg_set, OPT_TRACING_MSG_VM);
trace_buffer = xbt_cfg_get_int(_sg_cfg_set, OPT_TRACING_BUFFER);
trace_onelink_only = xbt_cfg_get_int(_sg_cfg_set, OPT_TRACING_ONELINK_ONLY);
trace_disable_destroy = xbt_cfg_get_int(_sg_cfg_set, OPT_TRACING_DISABLE_DESTROY);
trace_basic = xbt_cfg_get_int(_sg_cfg_set, OPT_TRACING_BASIC);
+ trace_display_sizes = xbt_cfg_get_int(_sg_cfg_set, OPT_TRACING_DISPLAY_SIZES);
+ trace_disable_link = xbt_cfg_get_int(_sg_cfg_set, OPT_TRACING_DISABLE_LINK);
+ trace_disable_power = xbt_cfg_get_int(_sg_cfg_set, OPT_TRACING_DISABLE_POWER);
+}
+
+static xbt_dynar_t TRACE_start_functions = NULL;
+void TRACE_add_start_function(void (*func) ())
+{
+ if (TRACE_start_functions == NULL)
+ TRACE_start_functions = xbt_dynar_new(sizeof(void (*)()), NULL);
+ xbt_dynar_push(TRACE_start_functions, &func);
}
int TRACE_start()
// tracing system must be:
// - enabled (with --cfg=tracing:1)
// - already configured (TRACE_global_init already called)
- if (!(TRACE_is_enabled() && TRACE_is_configured())){
- return 0;
- }
+ if (TRACE_is_enabled() && TRACE_is_configured()) {
+ XBT_DEBUG("Tracing starts");
- XBT_DEBUG("Tracing starts");
+ /* open the trace file */
+ TRACE_paje_start();
- /* open the trace file */
- TRACE_paje_start();
-
- /* activate trace */
- if (trace_active == 1){
- THROWF (tracing_error, 0, "Tracing is already active");
+ /* activate trace */
+ if (trace_active == 1) {
+ THROWF(tracing_error, 0, "Tracing is already active");
+ }
+ trace_active = 1;
+ XBT_DEBUG("Tracing is on");
+
+ /* other trace initialization */
+ created_categories = xbt_dict_new_homogeneous(xbt_free);
+ declared_marks = xbt_dict_new_homogeneous(xbt_free);
+ user_host_variables = xbt_dict_new_homogeneous(xbt_free);
+ user_vm_variables = xbt_dict_new_homogeneous (xbt_free);
+ user_link_variables = xbt_dict_new_homogeneous(xbt_free);
+
+ if (TRACE_start_functions != NULL) {
+ void (*func) ();
+ unsigned int iter = xbt_dynar_length(TRACE_start_functions);
+ xbt_dynar_foreach(TRACE_start_functions, iter, func) {
+ func();
+ }
+ }
}
- trace_active = 1;
- XBT_DEBUG ("Tracing is on");
-
- /* other trace initialization */
- created_categories = xbt_dict_new_homogeneous(xbt_free);
- declared_marks = xbt_dict_new_homogeneous (xbt_free);
- user_host_variables = xbt_dict_new_homogeneous (xbt_free);
- user_link_variables = xbt_dict_new_homogeneous (xbt_free);
- TRACE_surf_alloc();
- TRACE_smpi_alloc();
+ xbt_dynar_free(&TRACE_start_functions);
return 0;
}
+static xbt_dynar_t TRACE_end_functions = NULL;
+void TRACE_add_end_function(void (*func) (void))
+{
+ if (TRACE_end_functions == NULL)
+ TRACE_end_functions = xbt_dynar_new(sizeof(void (*)(void)), NULL);
+ xbt_dynar_push(TRACE_end_functions, &func);
+}
+
int TRACE_end()
{
- if (!trace_active)
- return 1;
-
- TRACE_generate_viva_uncat_conf();
- TRACE_generate_viva_cat_conf();
-
- /* dump trace buffer */
- TRACE_last_timestamp_to_dump = surf_get_clock();
- TRACE_paje_dump_buffer(1);
-
- /* destroy all data structures of tracing (and free) */
- PJ_container_free_all();
- PJ_type_free_all();
- PJ_container_release();
- PJ_type_release();
- TRACE_smpi_release();
- TRACE_surf_release();
- xbt_dict_free(&user_link_variables);
- xbt_dict_free(&user_host_variables);
- xbt_dict_free(&declared_marks);
- xbt_dict_free(&created_categories);
-
- /* close the trace file */
- TRACE_paje_end();
-
- /* de-activate trace */
- trace_active = 0;
- XBT_DEBUG ("Tracing is off");
- XBT_DEBUG("Tracing system is shutdown");
- return 0;
+ int retval;
+ if (!trace_active) {
+ retval = 1;
+ } else {
+ retval = 0;
+
+ TRACE_generate_viva_uncat_conf();
+ TRACE_generate_viva_cat_conf();
+
+ /* dump trace buffer */
+ TRACE_last_timestamp_to_dump = surf_get_clock();
+ TRACE_paje_dump_buffer(1);
+
+ /* destroy all data structures of tracing (and free) */
+ PJ_container_free_all();
+ PJ_type_free_all();
+ PJ_container_release();
+ PJ_type_release();
+
+ if (TRACE_end_functions != NULL) {
+ void (*func) (void);
+ unsigned int iter;
+ xbt_dynar_foreach(TRACE_end_functions, iter, func) {
+ func();
+ }
+ }
+
+ xbt_dict_free(&user_link_variables);
+ xbt_dict_free(&user_host_variables);
+ xbt_dict_free(&user_vm_variables);
+ xbt_dict_free(&declared_marks);
+ xbt_dict_free(&created_categories);
+
+ /* close the trace file */
+ TRACE_paje_end();
+
+ /* de-activate trace */
+ trace_active = 0;
+ XBT_DEBUG("Tracing is off");
+ XBT_DEBUG("Tracing system is shutdown");
+ }
+ xbt_dynar_free(&TRACE_end_functions);
+ return retval;
}
int TRACE_needs_platform (void)
{
return TRACE_msg_process_is_enabled() ||
+ TRACE_msg_vm_is_enabled() ||
TRACE_categorized() ||
TRACE_uncategorized() ||
TRACE_platform () ||
return trace_smpi_computing;
}
+int TRACE_smpi_view_internals(void)
+{
+ return trace_view_internals;
+}
int TRACE_categorized (void)
{
return trace_msg_process_enabled && TRACE_is_enabled();
}
+int TRACE_msg_vm_is_enabled(void)
+{
+ return trace_msg_vm_enabled && TRACE_is_enabled();
+}
+
+int TRACE_disable_link(void)
+{
+ return trace_disable_link && TRACE_is_enabled();
+}
+
+int TRACE_disable_power(void)
+{
+ return trace_disable_power && TRACE_is_enabled();
+}
+
int TRACE_buffer (void)
{
return trace_buffer && TRACE_is_enabled();
return trace_basic && TRACE_is_enabled();
}
+int TRACE_display_sizes (void)
+{
+ return trace_display_sizes && trace_smpi_enabled && TRACE_is_enabled();
+}
+
char *TRACE_get_comment (void)
{
return xbt_cfg_get_string(_sg_cfg_set, OPT_TRACING_COMMENT);
void TRACE_global_init(int *argc, char **argv)
{
/* name of the tracefile */
- char *default_tracing_filename = xbt_strdup("simgrid.trace");
xbt_cfg_register(&_sg_cfg_set, OPT_TRACING_FILENAME,
"Trace file created by the instrumented SimGrid.",
- xbt_cfgelm_string, &default_tracing_filename, 1, 1,
+ xbt_cfgelm_string, NULL, 1, 1,
NULL, NULL);
+ xbt_cfg_setdefault_string(_sg_cfg_set, OPT_TRACING_FILENAME, "simgrid.trace");
/* tracing */
- int default_tracing = 0;
xbt_cfg_register(&_sg_cfg_set, OPT_TRACING,
"Enable Tracing.",
- xbt_cfgelm_int, &default_tracing, 0, 1,
+ xbt_cfgelm_int, NULL, 0, 1,
NULL, NULL);
+ xbt_cfg_setdefault_int(_sg_cfg_set, OPT_TRACING, 0);
/* register platform in the trace */
- int default_tracing_platform = 0;
xbt_cfg_register(&_sg_cfg_set, OPT_TRACING_PLATFORM,
"Register the platform in the trace as a hierarchy.",
- xbt_cfgelm_int, &default_tracing_platform, 0, 1,
+ xbt_cfgelm_int, NULL, 0, 1,
NULL, NULL);
+ xbt_cfg_setdefault_int(_sg_cfg_set, OPT_TRACING_PLATFORM, 0);
/* register platform in the trace */
- int default_tracing_platform_topology = 1;
xbt_cfg_register(&_sg_cfg_set, OPT_TRACING_TOPOLOGY,
"Register the platform topology in the trace as a graph.",
- xbt_cfgelm_int, &default_tracing_platform_topology, 0, 1,
+ xbt_cfgelm_int, NULL, 0, 1,
NULL, NULL);
+ xbt_cfg_setdefault_int(_sg_cfg_set, OPT_TRACING_TOPOLOGY, 1);
/* smpi */
- int default_tracing_smpi = 0;
xbt_cfg_register(&_sg_cfg_set, OPT_TRACING_SMPI,
"Tracing of the SMPI interface.",
- xbt_cfgelm_int, &default_tracing_smpi, 0, 1,
+ xbt_cfgelm_int, NULL, 0, 1,
NULL, NULL);
+ xbt_cfg_setdefault_int(_sg_cfg_set, OPT_TRACING_SMPI, 0);
/* smpi grouped */
- int default_tracing_smpi_grouped = 0;
xbt_cfg_register(&_sg_cfg_set, OPT_TRACING_SMPI_GROUP,
"Group MPI processes by host.",
- xbt_cfgelm_int, &default_tracing_smpi_grouped, 0, 1,
+ xbt_cfgelm_int, NULL, 0, 1,
NULL, NULL);
+ xbt_cfg_setdefault_int(_sg_cfg_set, OPT_TRACING_SMPI_GROUP, 0);
/* smpi computing */
- int default_tracing_smpi_computing = 0;
xbt_cfg_register(&_sg_cfg_set, OPT_TRACING_SMPI_COMPUTING,
"Generate states for timing out of SMPI parts of the application",
- xbt_cfgelm_int, &default_tracing_smpi_computing, 0, 1,
+ xbt_cfgelm_int, NULL, 0, 1,
+ NULL, NULL);
+ xbt_cfg_setdefault_int(_sg_cfg_set, OPT_TRACING_SMPI_COMPUTING, 0);
+
+ /* smpi internals */
+ xbt_cfg_register(&_sg_cfg_set, OPT_TRACING_SMPI_INTERNALS,
+ "View internal messages sent by Collective communications in SMPI",
+ xbt_cfgelm_int, NULL, 0, 1,
NULL, NULL);
+ xbt_cfg_setdefault_int(_sg_cfg_set, OPT_TRACING_SMPI_INTERNALS, 0);
/* tracing categorized resource utilization traces */
- int default_tracing_categorized = 0;
xbt_cfg_register(&_sg_cfg_set, OPT_TRACING_CATEGORIZED,
"Tracing categorized resource utilization of hosts and links.",
- xbt_cfgelm_int, &default_tracing_categorized, 0, 1,
+ xbt_cfgelm_int, NULL, 0, 1,
NULL, NULL);
+ xbt_cfg_setdefault_int(_sg_cfg_set, OPT_TRACING_CATEGORIZED, 0);
/* tracing uncategorized resource utilization */
- int default_tracing_uncategorized = 0;
xbt_cfg_register(&_sg_cfg_set, OPT_TRACING_UNCATEGORIZED,
"Tracing uncategorized resource utilization of hosts and links.",
- xbt_cfgelm_int, &default_tracing_uncategorized, 0, 1,
+ xbt_cfgelm_int, NULL, 0, 1,
NULL, NULL);
+ xbt_cfg_setdefault_int(_sg_cfg_set, OPT_TRACING_UNCATEGORIZED, 0);
/* msg process */
- int default_tracing_msg_process = 0;
xbt_cfg_register(&_sg_cfg_set, OPT_TRACING_MSG_PROCESS,
"Tracing of MSG process behavior.",
- xbt_cfgelm_int, &default_tracing_msg_process, 0, 1,
+ xbt_cfgelm_int, NULL, 0, 1,
NULL, NULL);
+ xbt_cfg_setdefault_int(_sg_cfg_set, OPT_TRACING_MSG_PROCESS, 0);
+
+ /* msg process */
+ xbt_cfg_register(&_sg_cfg_set, OPT_TRACING_MSG_VM,
+ "Tracing of MSG process behavior.",
+ xbt_cfgelm_int, NULL, 0, 1,
+ NULL, NULL);
+ xbt_cfg_setdefault_int(_sg_cfg_set, OPT_TRACING_MSG_VM, 0);
+
+ /* disable tracing link */
+ xbt_cfg_register(&_sg_cfg_set, OPT_TRACING_DISABLE_LINK,
+ "Do not trace link bandwidth and latency.",
+ xbt_cfgelm_int, NULL, 0, 1,
+ NULL, NULL);
+ xbt_cfg_setdefault_int(_sg_cfg_set, OPT_TRACING_DISABLE_LINK, 0);
+
+ /* disable tracing link */
+ xbt_cfg_register(&_sg_cfg_set, OPT_TRACING_DISABLE_POWER,
+ "Do not trace host power.",
+ xbt_cfgelm_int, NULL, 0, 1,
+ NULL, NULL);
+ xbt_cfg_setdefault_int(_sg_cfg_set, OPT_TRACING_DISABLE_POWER, 0);
+
/* tracing buffer */
- int default_buffer = 1;
xbt_cfg_register(&_sg_cfg_set, OPT_TRACING_BUFFER,
"Buffer trace events to put them in temporal order.",
- xbt_cfgelm_int, &default_buffer, 0, 1,
+ xbt_cfgelm_int, NULL, 0, 1,
NULL, NULL);
+ xbt_cfg_setdefault_int(_sg_cfg_set, OPT_TRACING_BUFFER, 1);
/* tracing one link only */
- int default_onelink_only = 0;
xbt_cfg_register(&_sg_cfg_set, OPT_TRACING_ONELINK_ONLY,
"Use only routes with one link to trace platform.",
- xbt_cfgelm_int, &default_onelink_only, 0, 1,
+ xbt_cfgelm_int, NULL, 0, 1,
NULL, NULL);
+ xbt_cfg_setdefault_int(_sg_cfg_set, OPT_TRACING_ONELINK_ONLY, 0);
/* disable destroy */
- int default_disable_destroy = 0;
xbt_cfg_register(&_sg_cfg_set, OPT_TRACING_DISABLE_DESTROY,
"Disable platform containers destruction.",
- xbt_cfgelm_int, &default_disable_destroy, 0, 1,
+ xbt_cfgelm_int, NULL, 0, 1,
NULL, NULL);
+ xbt_cfg_setdefault_int(_sg_cfg_set, OPT_TRACING_DISABLE_DESTROY, 0);
/* basic -- Avoid extended events (impoverished trace file) */
- int default_basic = 0;
xbt_cfg_register(&_sg_cfg_set, OPT_TRACING_BASIC,
"Avoid extended events (impoverished trace file).",
- xbt_cfgelm_int, &default_basic, 0, 1,
+ xbt_cfgelm_int, NULL, 0, 1,
+ NULL, NULL);
+ xbt_cfg_setdefault_int(_sg_cfg_set, OPT_TRACING_BASIC, 0);
+
+ /* display_sizes -- Extended events with message size information */
+ xbt_cfg_register(&_sg_cfg_set, OPT_TRACING_DISPLAY_SIZES,
+ "(smpi only for now) Extended events with message size information",
+ xbt_cfgelm_int, NULL, 0, 1,
NULL, NULL);
+ xbt_cfg_setdefault_int(_sg_cfg_set, OPT_TRACING_DISPLAY_SIZES, 0);
/* comment */
- char *default_tracing_comment = xbt_strdup ("");
xbt_cfg_register(&_sg_cfg_set, OPT_TRACING_COMMENT,
"Comment to be added on the top of the trace file.",
- xbt_cfgelm_string, &default_tracing_comment, 1, 1,
+ xbt_cfgelm_string, NULL, 1, 1,
NULL, NULL);
+ xbt_cfg_setdefault_string(_sg_cfg_set, OPT_TRACING_COMMENT, "");
/* comment_file */
- char *default_tracing_comment_file = xbt_strdup ("");
xbt_cfg_register(&_sg_cfg_set, OPT_TRACING_COMMENT_FILE,
"The contents of the file are added to the top of the trace file as comment.",
- xbt_cfgelm_string, &default_tracing_comment_file, 1, 1,
+ xbt_cfgelm_string, NULL, 1, 1,
NULL, NULL);
+ xbt_cfg_setdefault_string(_sg_cfg_set, OPT_TRACING_COMMENT_FILE, "");
/* Viva graph configuration for uncategorized tracing */
- char *default_viva_uncat_conf_file = xbt_strdup ("");
xbt_cfg_register(&_sg_cfg_set, OPT_VIVA_UNCAT_CONF,
"Viva Graph configuration file for uncategorized resource utilization traces.",
- xbt_cfgelm_string, &default_viva_uncat_conf_file, 1, 1,
+ xbt_cfgelm_string, NULL, 1, 1,
NULL, NULL);
+ xbt_cfg_setdefault_string(_sg_cfg_set, OPT_VIVA_UNCAT_CONF, "");
/* Viva graph configuration for uncategorized tracing */
- char *default_viva_cat_conf_file = xbt_strdup ("");
xbt_cfg_register(&_sg_cfg_set, OPT_VIVA_CAT_CONF,
"Viva Graph configuration file for categorized resource utilization traces.",
- xbt_cfgelm_string, &default_viva_cat_conf_file, 1, 1,
+ xbt_cfgelm_string, NULL, 1, 1,
NULL, NULL);
+ xbt_cfg_setdefault_string(_sg_cfg_set, OPT_VIVA_CAT_CONF, "");
/* instrumentation can be considered configured now */
trace_configured = 1;
" This option aims at tracing computations in the application, outside SMPI\n"
" to allow further study of simulated or real computation time",
detailed);
+ print_line (OPT_TRACING_SMPI_INTERNALS, "Generates tracing events corresponding",
+ " to point-to-point messages sent by collective communications",
+ detailed);
print_line (OPT_TRACING_MSG_PROCESS, "Trace processes behavior (MSG)",
" This option only has effect if this simulator is MSG-based. It traces the\n"
" behavior of all categorized MSG processes, grouping them by hosts. This option\n"
" trace. Keep in mind that the trace might be incomplete, without all the\n"
" information that would be registered otherwise.",
detailed);
+ print_line (OPT_TRACING_DISPLAY_SIZES, "Only works for SMPI now. Add message size information",
+ "Message size (in bytes) is added to links, and to states. For collectives, the displayed value \n"
+ "is the more relevant to the collective (total sent by the process, usually)",
+ detailed);
print_line (OPT_TRACING_COMMENT, "Comment to be added on the top of the trace file.",
" Use this to add a comment line to the top of the trace file.",
detailed);
