Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
trace: functions to generate links, append a link type in the hierarchy of types
[simgrid.git] / src / instr / interface.c
index 6e13062..88a0576 100644 (file)
@@ -1,50 +1,39 @@
-/*
- * interface.c
- *
- *  Created on: Nov 23, 2009
- *      Author: Lucas Schnorr
- *     License: This program is free software; you can redistribute
- *              it and/or modify it under the terms of the license
- *              (GNU LGPL) which comes with this package.
- *
- *     Copyright (c) 2009 The SimGrid team.
- */
+/* Copyright (c) 2010. The SimGrid Team.
+ * All rights reserved.                                                     */
+
+/* This program is free software; you can redistribute it and/or modify it
+  * under the terms of the license (GNU LGPL) which comes with this package. */
 
 #include "instr/private.h"
 
 
 #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;
-
-/**
- * \brief Initialization of tracing.
- *
- * Function to be called at first when tracing a simulation
- *
- * \param name of the file that will contain the traces
- * \param mask to take into account during trace
- * \return 0 if everything is ok
- */
-int TRACE_start_with_mask(const char *filename, int mask) {
-  if (IS_TRACING) { /* what? trace is already active... ignore.. */
-       THROW0 (tracing_error, TRACE_ERROR_START,
-               "TRACE_start called, but tracing is already active");
+int TRACE_start ()
+{
+  if (!_TRACE_configured()){
+    THROW0 (tracing_error, TRACE_ERROR_START,
+            "TRACE_start should be called after SimGrid initialization functions.");
     return 0;
   }
 
-  /* checking if the mask is good (only TRACE_PLATFORM for now) */
-  if (mask != TRACE_PLATFORM){
-    THROW0 (tracing_error, TRACE_ERROR_MASK,
-            "Only TRACE_PLATFORM mask is accepted for now");
+  if (IS_TRACING) { /* what? trace is already active... ignore.. */
+    THROW0 (tracing_error, TRACE_ERROR_START,
+                "TRACE_start called, but tracing is already active.");
+    return 0;
   }
 
+  char *filename = _TRACE_filename ();
+  if (!filename){
+    THROW0 (tracing_error, TRACE_ERROR_START,
+            "Trace filename is not initialized.");
+    return 0;
+  }
   FILE *file = fopen(filename, "w");
   if (!file) {
     THROW1 (tracing_error, TRACE_ERROR_START,
@@ -54,75 +43,81 @@ int TRACE_start_with_mask(const char *filename, int mask) {
   }
   TRACE_paje_create_header();
 
-  /* setting the mask */
-  trace_mask = mask;
+  /* define paje hierarchy for tracing */
+  pajeDefineContainerType("PLATFORM", "0", "platform");
+  pajeDefineContainerType("HOST", "PLATFORM", "HOST");
+  pajeDefineContainerType("LINK", "PLATFORM", "LINK");
 
-  //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");
-       }
+  if (IS_TRACING_PLATFORM){
+    pajeDefineVariableType ("power", "HOST", "power");
+    pajeDefineVariableType ("bandwidth", "LINK", "bandwidth");
+    pajeDefineVariableType ("latency", "LINK", "latency");
   }
 
-  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_PROCESSES || IS_TRACING_VOLUME){
+    //processes grouped by host
+    pajeDefineContainerType("PROCESS", "HOST", "PROCESS");
   }
 
-  //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){
+    pajeDefineStateType("category", "PROCESS", "category");
+    pajeDefineStateType("presence", "PROCESS", "presence");
+  }
 
-  if (IS_TRACING_PROCESSES) pajeDefineContainerType("PROCESS", "HOST", "PROCESS");
-  if (IS_TRACING_PROCESSES) pajeDefineStateType("presence", "PROCESS", "presence");
+  if (IS_TRACING_VOLUME){
+    pajeDefineLinkType ("volume", "0", "PROCESS", "PROCESS", "volume");
+  }
 
-  if (IS_TRACING_PROCESSES){
-       if (IS_TRACING_TASKS) pajeDefineContainerType("TASK", "PROCESS", "TASK");
-  }else{
-       if (IS_TRACING_TASKS) pajeDefineContainerType("TASK", "HOST", "TASK");
+  if (IS_TRACING_TASKS){
+    //tasks grouped by host
+    pajeDefineContainerType("TASK", "HOST", "TASK");
+    pajeDefineStateType("category", "TASK", "category");
+    pajeDefineStateType("presence", "TASK", "presence");
+  }
+
+  if (IS_TRACING_SMPI){
+    pajeDefineContainerType ("MPI_PROCESS", "HOST", "MPI_PROCESS");
+    pajeDefineStateType ("MPI_STATE", "MPI_PROCESS", "MPI_STATE");
+    pajeDefineLinkType ("MPI_LINK", "0", "MPI_PROCESS", "MPI_PROCESS", "MPI_LINK");
   }
 
-  if (IS_TRACING_PLATFORM) pajeCreateContainer(MSG_get_clock(), "platform", "PLATFORM", "0", "simgrid-platform");
+  /* creating the platform */
+  pajeCreateContainer(MSG_get_clock(), "platform", "PLATFORM", "0", "simgrid-platform");
 
-  created_containers = xbt_dict_new();
+  /* other trace initialization */
   defined_types = xbt_dict_new();
   created_categories = xbt_dict_new();
   __TRACE_msg_init();
   __TRACE_surf_init();
   __TRACE_msg_process_init ();
+  __TRACE_smpi_init ();
 
   return 0;
 }
 
 int TRACE_end() {
+       FILE *file = NULL;
   if (!IS_TRACING) return 1;
-  FILE *file = TRACE_paje_end();
+  file = TRACE_paje_end();
   fclose (file);
   return 0;
 }
 
-void TRACE_category (const char *category)
+int TRACE_category (const char *category)
 {
-  if (!IS_TRACING) return;
   static int first_time = 1;
+  if (!IS_TRACING) return 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,
                const char *parent_type, int final) {
+       char *val_one = NULL;
   if (!IS_TRACING) return;
 
   //check if type is already defined
@@ -143,46 +138,60 @@ void TRACE_define_type (const char *type,
     if (IS_TRACING_TASKS) pajeDefineContainerType ("task", type, "task");
     if (IS_TRACING_TASKS) pajeDefineStateType ("task-state", "task", "task-state");
   }
-  xbt_dict_set (defined_types, type, xbt_strdup("1"), xbt_free);
+  val_one = xbt_strdup ("1");
+  xbt_dict_set (defined_types, type, &val_one, 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;
+  char state[100];
+  char *val_one = NULL;
+  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);
 
   /* for registering application categories on top of platform */
-  char state[100];
+
   snprintf (state, 100, "b%s", category);
   if (IS_TRACING_PLATFORM) pajeDefineVariableType (state, "LINK", state);
   snprintf (state, 100, "p%s", category);
   if (IS_TRACING_PLATFORM) pajeDefineVariableType (state, "HOST", state);
 
-  xbt_dict_set (created_categories, category, xbt_strdup("1"), xbt_free);
+  val_one = xbt_strdup ("1");
+  xbt_dict_set (created_categories, category, &val_one, xbt_free);
+  return 0;
+}
+
+void TRACE_declare_mark (const char *mark_type)
+{
+  if (!IS_TRACING) return;
+  if (!mark_type) return;
+
+  pajeDefineEventType (mark_type, "0", mark_type);
 }
 
-void TRACE_set_mask (int mask)
+void TRACE_mark (const char *mark_type, const char *mark_value)
 {
-  if (mask != TRACE_PLATFORM){
-     return;
-  }else{
-     trace_mask = mask;
-  }
+  if (!IS_TRACING) return;
+  if (!mark_type || !mark_value) return;
+
+  pajeNewEvent (MSG_get_clock(), mark_type, "0", mark_value);
 }
 
 #endif /* HAVE_TRACING */