re-organizing tracing masks and first support for "swarm-based" traces of tasks or...

[simgrid.git] / src / instr / interface.c

diff --git a/src/instr/interface.c b/src/instr/interface.c
index 6e13062..f4927eb 100644 (file)
--- a/src/instr/interface.c
+++ b/src/instr/interface.c
@@ -15,15 +15,25 @@
 
 #ifdef HAVE_TRACING
 
-XBT_LOG_NEW_DEFAULT_CATEGORY(tracing,"Tracing Surf");
+XBT_LOG_NEW_DEFAULT_CATEGORY(tracing,"Tracing Interface");
 
-extern xbt_dict_t created_containers; /* declared in general.c */
 static xbt_dict_t defined_types;
 static xbt_dict_t created_categories;
 
 int trace_mask;
 
-/**
+/** \ingroup tracing
+ * \brief Simple initialization of tracing.
+ *
+ * \param filename of the file that will contain the traces
+ * \return 0 if everything is ok
+ */
+int TRACE_start (const char *filename)
+{
+  return TRACE_start_with_mask (filename, TRACE_PLATFORM);
+}
+
+/** \ingroup tracing
  * \brief Initialization of tracing.
  *
  * Function to be called at first when tracing a simulation
@@ -57,43 +67,33 @@ int TRACE_start_with_mask(const char *filename, int mask) {
   /* setting the mask */
   trace_mask = mask;
 
-  //check if options are correct
-  if (IS_TRACING_TASKS){
-       if (!IS_TRACING_PROCESSES){
-         TRACE_end();
-      THROW0 (tracing_error, TRACE_ERROR_MASK,
-              "TRACE_PROCESS must be enabled if TRACE_TASK is used");
-       }
-  }
+  /* define paje hierarchy for tracing */
+  pajeDefineContainerType("PLATFORM", "0", "platform");
+  pajeDefineContainerType("HOST", "PLATFORM", "HOST");
+  pajeDefineContainerType("LINK", "PLATFORM", "LINK");
 
-  if (IS_TRACING_PROCESSES|IS_TRACING_TASKS){
-       if (!IS_TRACING_PLATFORM){
-         TRACE_end();
-      THROW0 (tracing_error, TRACE_ERROR_MASK,
-                 "TRACE_PLATFORM must be enabled if TRACE_PROCESS or TRACE_TASK is used");
-       }
+  if (IS_TRACING_PLATFORM){
+    pajeDefineVariableType ("power", "HOST", "power");
+    pajeDefineVariableType ("bandwidth", "LINK", "bandwidth");
+    pajeDefineVariableType ("latency", "LINK", "latency");
   }
 
-  //defining platform hierarchy
-  if (IS_TRACING_PLATFORM) pajeDefineContainerType("PLATFORM", "0", "platform");
-  if (IS_TRACING_PLATFORM) pajeDefineContainerType("HOST", "PLATFORM", "HOST");
-  if (IS_TRACING_PLATFORM) pajeDefineVariableType ("power", "HOST", "power");
-  if (IS_TRACING_PLATFORM) pajeDefineContainerType("LINK", "PLATFORM", "LINK");
-  if (IS_TRACING_PLATFORM) pajeDefineVariableType ("bandwidth", "LINK", "bandwidth");
-  if (IS_TRACING_PLATFORM) pajeDefineVariableType ("latency", "LINK", "latency");
-
-  if (IS_TRACING_PROCESSES) pajeDefineContainerType("PROCESS", "HOST", "PROCESS");
-  if (IS_TRACING_PROCESSES) pajeDefineStateType("presence", "PROCESS", "presence");
-
   if (IS_TRACING_PROCESSES){
-       if (IS_TRACING_TASKS) pajeDefineContainerType("TASK", "PROCESS", "TASK");
-  }else{
-       if (IS_TRACING_TASKS) pajeDefineContainerType("TASK", "HOST", "TASK");
+    //processes grouped by host
+    pajeDefineContainerType("PROCESS", "HOST", "PROCESS");
+    pajeDefineStateType("presence", "PROCESS", "presence");
   }
 
-  if (IS_TRACING_PLATFORM) pajeCreateContainer(MSG_get_clock(), "platform", "PLATFORM", "0", "simgrid-platform");
+  if (IS_TRACING_TASKS){
+    //tasks grouped by host
+    pajeDefineContainerType("TASK", "HOST", "TASK");
+    pajeDefineStateType("presence", "TASK", "presence");
+  }
 
-  created_containers = xbt_dict_new();
+  /* creating the platform */
+  pajeCreateContainer(MSG_get_clock(), "platform", "PLATFORM", "0", "simgrid-platform");
+
+  /* other trace initialization */
   defined_types = xbt_dict_new();
   created_categories = xbt_dict_new();
   __TRACE_msg_init();
@@ -110,15 +110,15 @@ int TRACE_end() {
   return 0;
 }
 
-void TRACE_category (const char *category)
+int TRACE_category (const char *category)
 {
-  if (!IS_TRACING) return;
+  if (!IS_TRACING) return 1;
   static int first_time = 1;
   if (first_time){
          TRACE_define_type ("user_type", "0", 1);
          first_time = 0;
   }
-  TRACE_create_category (category, "user_type", "0");
+  return TRACE_create_category (category, "user_type", "0");
 }
 
 void TRACE_define_type (const char *type,
@@ -146,22 +146,24 @@ void TRACE_define_type (const char *type,
   xbt_dict_set (defined_types, type, xbt_strdup("1"), xbt_free);
 }
 
-void TRACE_create_category (const char *category,
+int TRACE_create_category (const char *category,
                const char *type, const char *parent_category)
 {
-  if (!IS_TRACING) return;
+  if (!IS_TRACING) return 1;
 
   //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)){
-        THROW1 (tracing_error, TRACE_ERROR_CATEGORY_ALREADY_DEFINED, "Category %s is already created", type);
+     return 1;
   }
 
   pajeCreateContainer(MSG_get_clock(), category, type, parent_category, category);
@@ -174,6 +176,7 @@ void TRACE_create_category (const char *category,
   if (IS_TRACING_PLATFORM) pajeDefineVariableType (state, "HOST", state);
 
   xbt_dict_set (created_categories, category, xbt_strdup("1"), xbt_free);
+  return 0;
 }
 
 void TRACE_set_mask (int mask)