Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[trace] cosmetics, remove TRACE_is_active, use TRACE_is_enabled instead
[simgrid.git] / src / instr / instr_interface.c
index 5f137ac..12966a6 100644 (file)
 #ifdef HAVE_TRACING
 
 #include "instr/instr_private.h"
+#include "surf/network_private.h"
 
-XBT_LOG_NEW_DEFAULT_CATEGORY(tracing, "Tracing Interface");
+typedef enum {
+  INSTR_US_DECLARE,
+  INSTR_US_SET,
+  INSTR_US_ADD,
+  INSTR_US_SUB,
+} InstrUserVariable;
 
-static xbt_dict_t defined_types;
-static xbt_dict_t created_categories;
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_api, instr, "API");
 
-int TRACE_start()
+void TRACE_category(const char *category)
 {
-  // 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;
-  }
+  TRACE_category_with_color (category, NULL);
+}
 
-  /* open the trace file */
-  TRACE_paje_start();
-
-  /* activate trace */
-  TRACE_activate ();
-
-  /* output header */
-  TRACE_paje_create_header();
-
-  /* define paje hierarchy for tracing */
-  pajeDefineContainerType("PLATFORM", "0", "platform");
-  pajeDefineContainerType("HOST", "PLATFORM", "HOST");
-  pajeDefineContainerType("LINK", "PLATFORM", "LINK");
-  pajeDefineVariableType("power", "HOST", "power");
-  pajeDefineVariableType("bandwidth", "LINK", "bandwidth");
-  pajeDefineVariableType("latency", "LINK", "latency");
-  pajeDefineEventType("source", "LINK", "source");
-  pajeDefineEventType("destination", "LINK", "destination");
-
-  if (TRACE_platform_is_enabled()) {
-    if (TRACE_uncategorized()){
-      pajeDefineVariableType("power_used", "HOST", "power_used");
-      pajeDefineVariableType("bandwidth_used", "LINK", "bandwidth_used");
-    }
-  }
+void TRACE_category_with_color (const char *category, const char *color)
+{
+  if (!(TRACE_categorized() && category != NULL))
+    return;
 
-  if (TRACE_msg_process_is_enabled() || TRACE_msg_volume_is_enabled()) {
-    //processes grouped by host
-    pajeDefineContainerType("PROCESS", "HOST", "PROCESS");
-  }
+  xbt_assert (instr_platform_traced(),
+      "%s must be called after environment creation", __FUNCTION__);
 
-  if (TRACE_msg_process_is_enabled()) {
-    pajeDefineStateType("category", "PROCESS", "category");
-    pajeDefineStateType("presence", "PROCESS", "presence");
-  }
+  //check if category is already created
+  char *created = xbt_dict_get_or_null(created_categories, category);
+  if (created) return;
+  xbt_dict_set (created_categories, category, xbt_strdup("1"), xbt_free);
 
-  if (TRACE_msg_volume_is_enabled()) {
-    pajeDefineLinkType("volume", "0", "PROCESS", "PROCESS", "volume");
+  //define final_color
+  char final_color[INSTR_DEFAULT_STR_SIZE];
+  if (!color){
+    //generate a random color
+    double red = drand48();
+    double green = drand48();
+    double blue = drand48();
+    snprintf (final_color, INSTR_DEFAULT_STR_SIZE, "%f %f %f", red, green, blue);
+  }else{
+    snprintf (final_color, INSTR_DEFAULT_STR_SIZE, "%s", color);
   }
 
-  if (TRACE_msg_task_is_enabled()) {
-    //tasks grouped by host
-    pajeDefineContainerType("TASK", "HOST", "TASK");
-    pajeDefineStateType("category", "TASK", "category");
-    pajeDefineStateType("presence", "TASK", "presence");
+  XBT_DEBUG("CAT,declare %s, %s", category, final_color);
+
+  //define the type of this category on top of hosts and links
+  instr_new_variable_type (category, final_color);
+}
+
+void TRACE_declare_mark(const char *mark_type)
+{
+  if (!TRACE_is_enabled())
+    return;
+  if (!mark_type)
+    return;
+
+  XBT_DEBUG("MARK,declare %s", mark_type);
+  getEventType(mark_type, NULL, getRootType());
+}
+
+void TRACE_mark(const char *mark_type, const char *mark_value)
+{
+  if (!TRACE_is_enabled())
+    return;
+  if (!mark_type || !mark_value)
+    return;
+
+  XBT_DEBUG("MARK %s %s", mark_type, mark_value);
+  type_t type = getEventType (mark_type, NULL, getRootContainer()->type);
+  val_t value = getValue (mark_value, NULL, type);
+  new_pajeNewEvent (MSG_get_clock(), getRootContainer(), type, value);
+}
+
+static void instr_user_variable(double time,
+                         const char *resource,
+                         const char *variable,
+                         const char *father_type,
+                         double value,
+                         InstrUserVariable what)
+{
+  if (!TRACE_is_enabled())
+    return;
+
+  xbt_assert (instr_platform_traced(),
+      "%s must be called after environment creation", __FUNCTION__);
+
+  char valuestr[100];
+  snprintf(valuestr, 100, "%g", value);
+
+  switch (what){
+  case INSTR_US_DECLARE:
+    instr_new_user_variable_type (father_type, variable, NULL);
+    break;
+  case INSTR_US_SET:
+  {
+    container_t container = getContainerByName(resource);
+    type_t type = getVariableType (variable, NULL, container->type);
+    new_pajeSetVariable(time, container, type, value);
+    break;
+  }
+  case INSTR_US_ADD:
+  {
+    container_t container = getContainerByName(resource);
+    type_t type = getVariableType (variable, NULL, container->type);
+    new_pajeAddVariable(time, container, type, value);
+    break;
   }
+  case INSTR_US_SUB:
+  {
+    container_t container = getContainerByName(resource);
+    type_t type = getVariableType (variable, NULL, container->type);
+    new_pajeSubVariable(time, container, type, value);
+    break;
+  }
+  default:
+    //TODO: launch exception
+    break;
+  }
+}
 
-  if (TRACE_smpi_is_enabled()) {
-    if (TRACE_smpi_is_grouped()){
-      pajeDefineContainerType("MPI_PROCESS", "HOST", "MPI_PROCESS");
-    }else{
-      pajeDefineContainerType("MPI_PROCESS", "PLATFORM", "MPI_PROCESS");
-    }
-    pajeDefineStateType("MPI_STATE", "MPI_PROCESS", "MPI_STATE");
-    pajeDefineLinkType("MPI_LINK", "0", "MPI_PROCESS", "MPI_PROCESS",
-                       "MPI_LINK");
+static void instr_user_srcdst_variable(double time,
+                              const char *src,
+                              const char *dst,
+                              const char *variable,
+                              const char *father_type,
+                              double value,
+                              InstrUserVariable what)
+{
+  xbt_dynar_t route = global_routing->get_route (src, dst);
+  unsigned int i;
+  void *link;
+  xbt_dynar_foreach (route, i, link) {
+    char *link_name = ((link_CM02_t)link)->lmm_resource.generic_resource.name;
+    instr_user_variable (time, link_name, variable, father_type, value, what);
   }
+}
 
-  /* creating the platform */
-  pajeCreateContainer(MSG_get_clock(), "platform", "PLATFORM", "0",
-                      "simgrid-platform");
+const char *TRACE_node_name (xbt_node_t node)
+{
+  void *data = xbt_graph_node_get_data(node);
+  char *str = (char*)data;
+  return str;
+}
 
-  /* other trace initialization */
-  defined_types = xbt_dict_new();
-  created_categories = xbt_dict_new();
-  TRACE_msg_task_alloc();
-  TRACE_category_alloc();
-  TRACE_surf_alloc();
-  TRACE_msg_process_alloc();
-  TRACE_smpi_alloc();
-  return 0;
+xbt_graph_t TRACE_platform_graph (void)
+{
+  if (!TRACE_is_enabled())
+    return NULL;
+
+  return instr_routing_platform_graph ();
 }
 
-int TRACE_end()
+void TRACE_platform_graph_export_graphviz (xbt_graph_t g, const char *filename)
 {
-  if (!TRACE_is_active())
-    return 1;
+  instr_routing_platform_graph_export_graphviz (g, filename);
+}
 
-  /* close the trace file */
-  TRACE_paje_end();
 
-  /* activate trace */
-  TRACE_desactivate ();
-  return 0;
+/*
+ * Derived functions that use instr_user_variable and TRACE_user_srcdst_variable.
+ * They were previously defined as pre-processors directives, but were transformed
+ * into functions so the user can track them using gdb.
+ */
+
+/* for host variables */
+void TRACE_host_variable_declare (const char *var)
+{
+  instr_user_variable(0, NULL, var, "HOST", 0, INSTR_US_DECLARE);
 }
 
-int TRACE_category(const char *category)
+void TRACE_host_variable_set (const char *host, const char *variable, double value)
 {
-  return TRACE_category_with_color (category, NULL);
+  TRACE_host_variable_set_with_time (MSG_get_clock(), host, variable, value);
 }
 
-int TRACE_category_with_color (const char *category, const char *color)
+void TRACE_host_variable_add (const char *host, const char *variable, double value)
 {
-  static int first_time = 1;
-  if (!TRACE_is_active())
-    return 1;
+  TRACE_host_variable_add_with_time (MSG_get_clock(), host, variable, value);
+}
 
-  if (first_time) {
-    TRACE_define_type("user_type", "0", 1);
-    first_time = 0;
-  }
-  return TRACE_create_category_with_color(category, "user_type", "0", color);
+void TRACE_host_variable_sub (const char *host, const char *variable, double value)
+{
+  TRACE_host_variable_sub_with_time (MSG_get_clock(), host, variable, value);
 }
 
-void TRACE_define_type(const char *type,
-                       const char *parent_type, int final)
+void TRACE_host_variable_set_with_time (double time, const char *host, const char *variable, double value)
 {
-  char *val_one = NULL;
-  if (!TRACE_is_active())
-    return;
+  instr_user_variable(time, host, variable, "HOST", value, INSTR_US_SET);
+}
 
-  //check if type is already defined
-  if (xbt_dict_get_or_null(defined_types, type)) {
-    THROW1(tracing_error, TRACE_ERROR_TYPE_ALREADY_DEFINED,
-           "Type %s is already defined", type);
-  }
-  //check if parent_type is already defined
-  if (strcmp(parent_type, "0")
-      && !xbt_dict_get_or_null(defined_types, parent_type)) {
-    THROW1(tracing_error, TRACE_ERROR_TYPE_NOT_DEFINED,
-           "Type (used as parent) %s is not defined", parent_type);
-  }
+void TRACE_host_variable_add_with_time (double time, const char *host, const char *variable, double value)
+{
+  instr_user_variable(time, host, variable, "HOST", value, INSTR_US_ADD);
+}
 
-  pajeDefineContainerType(type, parent_type, type);
-  if (final) {
-    //for m_process_t
-    if (TRACE_msg_process_is_enabled())
-      pajeDefineContainerType("process", type, "process");
-    if (TRACE_msg_process_is_enabled())
-      pajeDefineStateType("process-state", "process", "process-state");
-
-    if (TRACE_msg_task_is_enabled())
-      pajeDefineContainerType("task", type, "task");
-    if (TRACE_msg_task_is_enabled())
-      pajeDefineStateType("task-state", "task", "task-state");
-  }
-  val_one = xbt_strdup("1");
-  xbt_dict_set(defined_types, type, &val_one, xbt_free);
+void TRACE_host_variable_sub_with_time (double time, const char *host, const char *variable, double value)
+{
+  instr_user_variable(time, host, variable, "HOST", value, INSTR_US_SUB);
 }
 
-int TRACE_create_category(const char *category,
-                          const char *type, const char *parent_category)
+/* for link variables */
+void TRACE_link_variable_declare (const char *var)
 {
-  return TRACE_create_category_with_color (category, type, parent_category, NULL);
+  instr_user_variable (0, NULL, var, "LINK", 0, INSTR_US_DECLARE);
 }
 
-int TRACE_create_category_with_color(const char *category,
-                          const char *type,
-                          const char *parent_category,
-                          const char *color)
+void TRACE_link_variable_set (const char *link, const char *variable, double value)
 {
-  char state[100];
-  char *val_one = NULL;
-  if (!TRACE_is_active())
-    return 1;
+  TRACE_link_variable_set_with_time (MSG_get_clock(), link, variable, value);
+}
 
-  //check if type is defined
-  if (!xbt_dict_get_or_null(defined_types, type)) {
-    THROW1(tracing_error, TRACE_ERROR_TYPE_NOT_DEFINED,
-           "Type %s is not defined", type);
-    return 1;
-  }
-  //check if parent_category exists
-  if (strcmp(parent_category, "0")
-      && !xbt_dict_get_or_null(created_categories, parent_category)) {
-    THROW1(tracing_error, TRACE_ERROR_CATEGORY_NOT_DEFINED,
-           "Category (used as parent) %s is not created", parent_category);
-    return 1;
-  }
-  //check if category is created
-  if (xbt_dict_get_or_null(created_categories, category)) {
-    return 1;
-  }
+void TRACE_link_variable_add (const char *link, const char *variable, double value)
+{
+  TRACE_link_variable_add_with_time (MSG_get_clock(), link, variable, value);
+}
 
-  pajeCreateContainer(MSG_get_clock(), category, type, parent_category,
-                      category);
+void TRACE_link_variable_sub (const char *link, const char *variable, double value)
+{
+  TRACE_link_variable_sub_with_time (MSG_get_clock(), link, variable, value);
+}
 
-  char final_color[INSTR_DEFAULT_STR_SIZE];
-  if (!color){
-    //generate a random color
-    double red = drand48();
-    double green = drand48();
-    double blue = drand48();
-    snprintf (final_color, INSTR_DEFAULT_STR_SIZE, "%f %f %f", red, green, blue);
-  }else{
-    snprintf (final_color, INSTR_DEFAULT_STR_SIZE, "%s", color);
-  }
+void TRACE_link_variable_set_with_time (double time, const char *link, const char *variable, double value)
+{
+  instr_user_variable (time, link, variable, "LINK", value, INSTR_US_SET);
+}
 
-  /* for registering application categories on top of platform */
-  snprintf(state, 100, "b%s", category);
-  if (TRACE_platform_is_enabled())
-    pajeDefineVariableTypeWithColor(state, "LINK", state, final_color);
-  snprintf(state, 100, "p%s", category);
-  if (TRACE_platform_is_enabled())
-    pajeDefineVariableTypeWithColor(state, "HOST", state, final_color);
+void TRACE_link_variable_add_with_time (double time, const char *link, const char *variable, double value)
+{
+  instr_user_variable (time, link, variable, "LINK", value, INSTR_US_ADD);
+}
 
-  val_one = xbt_strdup("1");
-  xbt_dict_set(created_categories, category, &val_one, xbt_free);
-  return 0;
+void TRACE_link_variable_sub_with_time (double time, const char *link, const char *variable, double value)
+{
+  instr_user_variable (time, link, variable, "LINK", value, INSTR_US_SUB);
 }
 
-void TRACE_declare_mark(const char *mark_type)
+/* for link variables, but with src and dst used for get_route */
+void TRACE_link_srcdst_variable_set (const char *src, const char *dst, const char *variable, double value)
 {
-  if (!TRACE_is_active())
-    return;
-  if (!mark_type)
-    return;
+  TRACE_link_srcdst_variable_set_with_time (MSG_get_clock(), src, dst, variable, value);
+}
 
-  pajeDefineEventType(mark_type, "0", mark_type);
+void TRACE_link_srcdst_variable_add (const char *src, const char *dst, const char *variable, double value)
+{
+  TRACE_link_srcdst_variable_add_with_time (MSG_get_clock(), src, dst, variable, value);
 }
 
-void TRACE_mark(const char *mark_type, const char *mark_value)
+void TRACE_link_srcdst_variable_sub (const char *src, const char *dst, const char *variable, double value)
 {
-  if (!TRACE_is_active())
-    return;
-  if (!mark_type || !mark_value)
-    return;
+  TRACE_link_srcdst_variable_sub_with_time (MSG_get_clock(), src, dst, variable, value);
+}
+
+void TRACE_link_srcdst_variable_set_with_time (double time, const char *src, const char *dst, const char *variable, double value)
+{
+  instr_user_srcdst_variable (time, src, dst, variable, "LINK", value, INSTR_US_SET);
+}
+
+void TRACE_link_srcdst_variable_add_with_time (double time, const char *src, const char *dst, const char *variable, double value)
+{
+  instr_user_srcdst_variable (time, src, dst, variable, "LINK", value, INSTR_US_ADD);
+}
 
-  pajeNewEvent(MSG_get_clock(), mark_type, "0", mark_value);
+void TRACE_link_srcdst_variable_sub_with_time (double time, const char *src, const char *dst, const char *variable, double value)
+{
+  instr_user_srcdst_variable (time, src, dst, variable, "LINK", value, INSTR_US_SUB);
 }
 
 #endif /* HAVE_TRACING */