Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[trace] to proceed, check if platform is traced in functions that need it
[simgrid.git] / src / instr / 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 "simgrid_config.h"
8
9 #ifdef HAVE_TRACING
10
11 #include "instr/instr_private.h"
12 #include "surf/network_private.h"
13
14 typedef enum {
15   INSTR_US_DECLARE,
16   INSTR_US_SET,
17   INSTR_US_ADD,
18   INSTR_US_SUB,
19 } InstrUserVariable;
20
21 XBT_LOG_NEW_DEFAULT_SUBCATEGORY (instr_api, instr, "API");
22
23 void TRACE_category(const char *category)
24 {
25   TRACE_category_with_color (category, NULL);
26 }
27
28 void TRACE_category_with_color (const char *category, const char *color)
29 {
30   /* safe switch */
31   if (!TRACE_is_enabled()) return;
32
33   if (!(TRACE_categorized() && category != NULL)) return;
34
35   /* if platform is not traced, we can't deal with categories */
36   if (!TRACE_needs_platform()) return;
37
38   //check if category is already created
39   char *created = xbt_dict_get_or_null(created_categories, category);
40   if (created) return;
41   xbt_dict_set (created_categories, category, xbt_strdup("1"), xbt_free);
42
43   //define final_color
44   char final_color[INSTR_DEFAULT_STR_SIZE];
45   if (!color){
46     //generate a random color
47     double red = drand48();
48     double green = drand48();
49     double blue = drand48();
50     snprintf (final_color, INSTR_DEFAULT_STR_SIZE, "%f %f %f", red, green, blue);
51   }else{
52     snprintf (final_color, INSTR_DEFAULT_STR_SIZE, "%s", color);
53   }
54
55   XBT_DEBUG("CAT,declare %s, %s", category, final_color);
56
57   //define the type of this category on top of hosts and links
58   instr_new_variable_type (category, final_color);
59 }
60
61 void TRACE_declare_mark(const char *mark_type)
62 {
63   /* safe switch */
64   if (!TRACE_is_enabled()) return;
65
66   if (!mark_type) return;
67
68   XBT_DEBUG("MARK,declare %s", mark_type);
69   getEventType(mark_type, NULL, getRootType());
70 }
71
72 void TRACE_mark(const char *mark_type, const char *mark_value)
73 {
74   /* safe switch */
75   if (!TRACE_is_enabled()) return;
76
77   if (!mark_type || !mark_value) return;
78
79   XBT_DEBUG("MARK %s %s", mark_type, mark_value);
80   type_t type = getEventType (mark_type, NULL, getRootContainer()->type);
81   val_t value = getValue (mark_value, NULL, type);
82   new_pajeNewEvent (MSG_get_clock(), getRootContainer(), type, value);
83 }
84
85 static void instr_user_variable(double time,
86                          const char *resource,
87                          const char *variable,
88                          const char *father_type,
89                          double value,
90                          InstrUserVariable what)
91 {
92   /* safe switch */
93   if (!TRACE_is_enabled()) return;
94
95   /* if platform is not traced, we can't deal user variables */
96   if (!TRACE_needs_platform()) return;
97
98   char valuestr[100];
99   snprintf(valuestr, 100, "%g", value);
100
101   switch (what){
102   case INSTR_US_DECLARE:
103     instr_new_user_variable_type (father_type, variable, NULL);
104     break;
105   case INSTR_US_SET:
106   {
107     container_t container = getContainerByName(resource);
108     type_t type = getVariableType (variable, NULL, container->type);
109     new_pajeSetVariable(time, container, type, value);
110     break;
111   }
112   case INSTR_US_ADD:
113   {
114     container_t container = getContainerByName(resource);
115     type_t type = getVariableType (variable, NULL, container->type);
116     new_pajeAddVariable(time, container, type, value);
117     break;
118   }
119   case INSTR_US_SUB:
120   {
121     container_t container = getContainerByName(resource);
122     type_t type = getVariableType (variable, NULL, container->type);
123     new_pajeSubVariable(time, container, type, value);
124     break;
125   }
126   default:
127     //TODO: launch exception
128     break;
129   }
130 }
131
132 static void instr_user_srcdst_variable(double time,
133                               const char *src,
134                               const char *dst,
135                               const char *variable,
136                               const char *father_type,
137                               double value,
138                               InstrUserVariable what)
139 {
140   xbt_dynar_t route = global_routing->get_route (src, dst);
141   unsigned int i;
142   void *link;
143   xbt_dynar_foreach (route, i, link) {
144     char *link_name = ((link_CM02_t)link)->lmm_resource.generic_resource.name;
145     instr_user_variable (time, link_name, variable, father_type, value, what);
146   }
147 }
148
149 const char *TRACE_node_name (xbt_node_t node)
150 {
151   void *data = xbt_graph_node_get_data(node);
152   char *str = (char*)data;
153   return str;
154 }
155
156 xbt_graph_t TRACE_platform_graph (void)
157 {
158   if (!TRACE_is_enabled()) return NULL;
159   return instr_routing_platform_graph ();
160 }
161
162 void TRACE_platform_graph_export_graphviz (xbt_graph_t g, const char *filename)
163 {
164   instr_routing_platform_graph_export_graphviz (g, filename);
165 }
166
167
168 /*
169  * Derived functions that use instr_user_variable and TRACE_user_srcdst_variable.
170  * They were previously defined as pre-processors directives, but were transformed
171  * into functions so the user can track them using gdb.
172  */
173
174 /* for host variables */
175 void TRACE_host_variable_declare (const char *var)
176 {
177   instr_user_variable(0, NULL, var, "HOST", 0, INSTR_US_DECLARE);
178 }
179
180 void TRACE_host_variable_set (const char *host, const char *variable, double value)
181 {
182   TRACE_host_variable_set_with_time (MSG_get_clock(), host, variable, value);
183 }
184
185 void TRACE_host_variable_add (const char *host, const char *variable, double value)
186 {
187   TRACE_host_variable_add_with_time (MSG_get_clock(), host, variable, value);
188 }
189
190 void TRACE_host_variable_sub (const char *host, const char *variable, double value)
191 {
192   TRACE_host_variable_sub_with_time (MSG_get_clock(), host, variable, value);
193 }
194
195 void TRACE_host_variable_set_with_time (double time, const char *host, const char *variable, double value)
196 {
197   instr_user_variable(time, host, variable, "HOST", value, INSTR_US_SET);
198 }
199
200 void TRACE_host_variable_add_with_time (double time, const char *host, const char *variable, double value)
201 {
202   instr_user_variable(time, host, variable, "HOST", value, INSTR_US_ADD);
203 }
204
205 void TRACE_host_variable_sub_with_time (double time, const char *host, const char *variable, double value)
206 {
207   instr_user_variable(time, host, variable, "HOST", value, INSTR_US_SUB);
208 }
209
210 /* for link variables */
211 void TRACE_link_variable_declare (const char *var)
212 {
213   instr_user_variable (0, NULL, var, "LINK", 0, INSTR_US_DECLARE);
214 }
215
216 void TRACE_link_variable_set (const char *link, const char *variable, double value)
217 {
218   TRACE_link_variable_set_with_time (MSG_get_clock(), link, variable, value);
219 }
220
221 void TRACE_link_variable_add (const char *link, const char *variable, double value)
222 {
223   TRACE_link_variable_add_with_time (MSG_get_clock(), link, variable, value);
224 }
225
226 void TRACE_link_variable_sub (const char *link, const char *variable, double value)
227 {
228   TRACE_link_variable_sub_with_time (MSG_get_clock(), link, variable, value);
229 }
230
231 void TRACE_link_variable_set_with_time (double time, const char *link, const char *variable, double value)
232 {
233   instr_user_variable (time, link, variable, "LINK", value, INSTR_US_SET);
234 }
235
236 void TRACE_link_variable_add_with_time (double time, const char *link, const char *variable, double value)
237 {
238   instr_user_variable (time, link, variable, "LINK", value, INSTR_US_ADD);
239 }
240
241 void TRACE_link_variable_sub_with_time (double time, const char *link, const char *variable, double value)
242 {
243   instr_user_variable (time, link, variable, "LINK", value, INSTR_US_SUB);
244 }
245
246 /* for link variables, but with src and dst used for get_route */
247 void TRACE_link_srcdst_variable_set (const char *src, const char *dst, const char *variable, double value)
248 {
249   TRACE_link_srcdst_variable_set_with_time (MSG_get_clock(), src, dst, variable, value);
250 }
251
252 void TRACE_link_srcdst_variable_add (const char *src, const char *dst, const char *variable, double value)
253 {
254   TRACE_link_srcdst_variable_add_with_time (MSG_get_clock(), src, dst, variable, value);
255 }
256
257 void TRACE_link_srcdst_variable_sub (const char *src, const char *dst, const char *variable, double value)
258 {
259   TRACE_link_srcdst_variable_sub_with_time (MSG_get_clock(), src, dst, variable, value);
260 }
261
262 void TRACE_link_srcdst_variable_set_with_time (double time, const char *src, const char *dst, const char *variable, double value)
263 {
264   instr_user_srcdst_variable (time, src, dst, variable, "LINK", value, INSTR_US_SET);
265 }
266
267 void TRACE_link_srcdst_variable_add_with_time (double time, const char *src, const char *dst, const char *variable, double value)
268 {
269   instr_user_srcdst_variable (time, src, dst, variable, "LINK", value, INSTR_US_ADD);
270 }
271
272 void TRACE_link_srcdst_variable_sub_with_time (double time, const char *src, const char *dst, const char *variable, double value)
273 {
274   instr_user_srcdst_variable (time, src, dst, variable, "LINK", value, INSTR_US_SUB);
275 }
276
277 #endif /* HAVE_TRACING */