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