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   if (IS_TRACING_SMPI){
  79     pajeDefineContainerType ("MPI_PROCESS", "HOST", "MPI_PROCESS");
  80   }
  81
  82   /* creating the platform */
  83   pajeCreateContainer(MSG_get_clock(), "platform", "PLATFORM", "0", "simgrid-platform");
  84
  85   /* other trace initialization */
  86   defined_types = xbt_dict_new();
  87   created_categories = xbt_dict_new();
  88   __TRACE_msg_init();
  89   __TRACE_surf_init();
  90   __TRACE_msg_process_init ();
  91
  92   return 0;
  93 }
  94
  95 int TRACE_end() {
  96         FILE *file = NULL;
  97   if (!IS_TRACING) return 1;
  98   file = TRACE_paje_end();
  99   fclose (file);
 100   return 0;
 101 }
 102
 103 int TRACE_category (const char *category)
 104 {
 105   static int first_time = 1;
 106   if (!IS_TRACING) return 1;
 107
 108   if (first_time){
 109           TRACE_define_type ("user_type", "0", 1);
 110           first_time = 0;
 111   }
 112   return TRACE_create_category (category, "user_type", "0");
 113 }
 114
 115 void TRACE_define_type (const char *type,
 116                 const char *parent_type, int final) {
 117         char *val_one = NULL;
 118   if (!IS_TRACING) return;
 119
 120   //check if type is already defined
 121   if (xbt_dict_get_or_null (defined_types, type)){
 122     THROW1 (tracing_error, TRACE_ERROR_TYPE_ALREADY_DEFINED, "Type %s is already defined", type);
 123   }
 124   //check if parent_type is already defined
 125   if (strcmp(parent_type, "0") && !xbt_dict_get_or_null (defined_types, parent_type)) {
 126     THROW1 (tracing_error, TRACE_ERROR_TYPE_NOT_DEFINED, "Type (used as parent) %s is not defined", parent_type);
 127   }
 128
 129   pajeDefineContainerType(type, parent_type, type);
 130   if (final) {
 131     //for m_process_t
 132     if (IS_TRACING_PROCESSES) pajeDefineContainerType ("process", type, "process");
 133     if (IS_TRACING_PROCESSES) pajeDefineStateType ("process-state", "process", "process-state");
 134
 135     if (IS_TRACING_TASKS) pajeDefineContainerType ("task", type, "task");
 136     if (IS_TRACING_TASKS) pajeDefineStateType ("task-state", "task", "task-state");
 137   }
 138   val_one = xbt_strdup ("1");
 139   xbt_dict_set (defined_types, type, &val_one, xbt_free);
 140 }
 141
 142 int TRACE_create_category (const char *category,
 143                 const char *type, const char *parent_category)
 144 {
 145   char state[100];
 146   char *val_one = NULL;
 147   if (!IS_TRACING) return 1;
 148
 149   //check if type is defined
 150   if (!xbt_dict_get_or_null (defined_types, type)) {
 151          THROW1 (tracing_error, TRACE_ERROR_TYPE_NOT_DEFINED, "Type %s is not defined", type);
 152          return 1;
 153   }
 154   //check if parent_category exists
 155   if (strcmp(parent_category, "0") && !xbt_dict_get_or_null (created_categories, parent_category)){
 156      THROW1 (tracing_error, TRACE_ERROR_CATEGORY_NOT_DEFINED, "Category (used as parent) %s is not created", parent_category);
 157      return 1;
 158   }
 159   //check if category is created
 160   if (xbt_dict_get_or_null (created_categories, category)){
 161      return 1;
 162   }
 163
 164   pajeCreateContainer(MSG_get_clock(), category, type, parent_category, category);
 165
 166   /* for registering application categories on top of platform */
 167
 168   snprintf (state, 100, "b%s", category);
 169   if (IS_TRACING_PLATFORM) pajeDefineVariableType (state, "LINK", state);
 170   snprintf (state, 100, "p%s", category);
 171   if (IS_TRACING_PLATFORM) pajeDefineVariableType (state, "HOST", state);
 172
 173   val_one = xbt_strdup ("1");
 174   xbt_dict_set (created_categories, category, &val_one, xbt_free);
 175   return 0;
 176 }
 177
 178 void TRACE_declare_mark (const char *mark_type)
 179 {
 180   if (!IS_TRACING) return;
 181   if (!mark_type) return;
 182
 183   pajeDefineEventType (mark_type, "0", mark_type);
 184 }
 185
 186 void TRACE_mark (const char *mark_type, const char *mark_value)
 187 {
 188   if (!IS_TRACING) return;
 189   if (!mark_type || !mark_value) return;
 190
 191   pajeNewEvent (MSG_get_clock(), mark_type, "0", mark_value);
 192 }
 193
 194 #endif /* HAVE_TRACING */