src/instr/interface.c

   1 /* Copyright (c) 2010. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   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. */
   6
   7 #include "instr/private.h"
   8
   9
  10 #ifdef HAVE_TRACING
  11
  12 XBT_LOG_NEW_DEFAULT_CATEGORY(tracing,"Tracing Interface");
  13
  14 static xbt_dict_t defined_types;
  15 static xbt_dict_t created_categories;
  16
  17 int TRACE_start ()
  18 {
  19   if (!_TRACE_configured()){
  20     THROW0 (tracing_error, TRACE_ERROR_START,
  21             "TRACE_start should be called after SimGrid initialization functions.");
  22     return 0;
  23   }
  24
  25   if (IS_TRACING) { /* what? trace is already active... ignore.. */
  26     THROW0 (tracing_error, TRACE_ERROR_START,
  27                  "TRACE_start called, but tracing is already active.");
  28     return 0;
  29   }
  30
  31   char *filename = _TRACE_filename ();
  32   if (!filename){
  33     THROW0 (tracing_error, TRACE_ERROR_START,
  34             "Trace filename is not initialized.");
  35     return 0;
  36   }
  37   FILE *file = fopen(filename, "w");
  38   if (!file) {
  39     THROW1 (tracing_error, TRACE_ERROR_START,
  40                 "Tracefile %s could not be opened for writing.", filename);
  41   } else {
  42     TRACE_paje_start (file);
  43   }
  44   TRACE_paje_create_header();
  45
  46   /* define paje hierarchy for tracing */
  47   pajeDefineContainerType("PLATFORM", "0", "platform");
  48   pajeDefineContainerType("HOST", "PLATFORM", "HOST");
  49   pajeDefineContainerType("LINK", "PLATFORM", "LINK");
  50
  51   if (IS_TRACING_PLATFORM){
  52     pajeDefineVariableType ("power", "HOST", "power");
  53     pajeDefineVariableType ("bandwidth", "LINK", "bandwidth");
  54     pajeDefineVariableType ("latency", "LINK", "latency");
  55   }
  56
  57   if (IS_TRACING_PROCESSES || IS_TRACING_VOLUME){
  58     //processes grouped by host
  59     pajeDefineContainerType("PROCESS", "HOST", "PROCESS");
  60   }
  61
  62   if (IS_TRACING_PROCESSES){
  63     pajeDefineStateType("category", "PROCESS", "category");
  64     pajeDefineStateType("presence", "PROCESS", "presence");
  65   }
  66
  67   if (IS_TRACING_VOLUME){
  68     pajeDefineLinkType ("volume", "0", "PROCESS", "PROCESS", "volume");
  69   }
  70
  71   if (IS_TRACING_TASKS){
  72     //tasks grouped by host
  73     pajeDefineContainerType("TASK", "HOST", "TASK");
  74     pajeDefineStateType("category", "TASK", "category");
  75     pajeDefineStateType("presence", "TASK", "presence");
  76   }
  77
  78   /* creating the platform */
  79   pajeCreateContainer(MSG_get_clock(), "platform", "PLATFORM", "0", "simgrid-platform");
  80
  81   /* other trace initialization */
  82   defined_types = xbt_dict_new();
  83   created_categories = xbt_dict_new();
  84   __TRACE_msg_init();
  85   __TRACE_surf_init();
  86   __TRACE_msg_process_init ();
  87
  88   return 0;
  89 }
  90
  91 int TRACE_end() {
  92         FILE *file = NULL;
  93   if (!IS_TRACING) return 1;
  94   file = TRACE_paje_end();
  95   fclose (file);
  96   return 0;
  97 }
  98
  99 int TRACE_category (const char *category)
 100 {
 101   static int first_time = 1;
 102   if (!IS_TRACING) return 1;
 103
 104   if (first_time){
 105           TRACE_define_type ("user_type", "0", 1);
 106           first_time = 0;
 107   }
 108   return TRACE_create_category (category, "user_type", "0");
 109 }
 110
 111 void TRACE_define_type (const char *type,
 112                 const char *parent_type, int final) {
 113         char *val_one = NULL;
 114   if (!IS_TRACING) return;
 115
 116   //check if type is already defined
 117   if (xbt_dict_get_or_null (defined_types, type)){
 118     THROW1 (tracing_error, TRACE_ERROR_TYPE_ALREADY_DEFINED, "Type %s is already defined", type);
 119   }
 120   //check if parent_type is already defined
 121   if (strcmp(parent_type, "0") && !xbt_dict_get_or_null (defined_types, parent_type)) {
 122     THROW1 (tracing_error, TRACE_ERROR_TYPE_NOT_DEFINED, "Type (used as parent) %s is not defined", parent_type);
 123   }
 124
 125   pajeDefineContainerType(type, parent_type, type);
 126   if (final) {
 127     //for m_process_t
 128     if (IS_TRACING_PROCESSES) pajeDefineContainerType ("process", type, "process");
 129     if (IS_TRACING_PROCESSES) pajeDefineStateType ("process-state", "process", "process-state");
 130
 131     if (IS_TRACING_TASKS) pajeDefineContainerType ("task", type, "task");
 132     if (IS_TRACING_TASKS) pajeDefineStateType ("task-state", "task", "task-state");
 133   }
 134   val_one = xbt_strdup ("1");
 135   xbt_dict_set (defined_types, type, &val_one, xbt_free);
 136 }
 137
 138 int TRACE_create_category (const char *category,
 139                 const char *type, const char *parent_category)
 140 {
 141   char state[100];
 142   char *val_one = NULL;
 143   if (!IS_TRACING) return 1;
 144
 145   //check if type is defined
 146   if (!xbt_dict_get_or_null (defined_types, type)) {
 147          THROW1 (tracing_error, TRACE_ERROR_TYPE_NOT_DEFINED, "Type %s is not defined", type);
 148          return 1;
 149   }
 150   //check if parent_category exists
 151   if (strcmp(parent_category, "0") && !xbt_dict_get_or_null (created_categories, parent_category)){
 152      THROW1 (tracing_error, TRACE_ERROR_CATEGORY_NOT_DEFINED, "Category (used as parent) %s is not created", parent_category);
 153      return 1;
 154   }
 155   //check if category is created
 156   if (xbt_dict_get_or_null (created_categories, category)){
 157      return 1;
 158   }
 159
 160   pajeCreateContainer(MSG_get_clock(), category, type, parent_category, category);
 161
 162   /* for registering application categories on top of platform */
 163
 164   snprintf (state, 100, "b%s", category);
 165   if (IS_TRACING_PLATFORM) pajeDefineVariableType (state, "LINK", state);
 166   snprintf (state, 100, "p%s", category);
 167   if (IS_TRACING_PLATFORM) pajeDefineVariableType (state, "HOST", state);
 168
 169   val_one = xbt_strdup ("1");
 170   xbt_dict_set (created_categories, category, &val_one, xbt_free);
 171   return 0;
 172 }
 173
 174 void TRACE_declare_mark (const char *mark_type)
 175 {
 176   if (!IS_TRACING) return;
 177   if (!mark_type) return;
 178
 179   pajeDefineEventType (mark_type, "0", mark_type);
 180 }
 181
 182 void TRACE_mark (const char *mark_type, const char *mark_value)
 183 {
 184   if (!IS_TRACING) return;
 185   if (!mark_type || !mark_value) return;
 186
 187   pajeNewEvent (MSG_get_clock(), mark_type, "0", mark_value);
 188 }
 189
 190 #endif /* HAVE_TRACING */