1 /* Copyright (c) 2010-2015. The SimGrid Team.
2 * All rights reserved. */
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. */
7 #include "src/instr/instr_private.h"
8 #include "src/instr/instr_smpi.h"
9 #include "src/smpi/private.hpp"
10 #include "xbt/virtu.h" /* sg_cmdline */
12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(instr_trace, instr, "tracing event system");
14 FILE *tracing_file = nullptr;
16 void print_NULL(paje_event_t event){}
18 /* The active set of functions for the selected trace format
19 * By default, they all do nothing, hence the print_NULL to avoid segfaults */
21 s_instr_trace_writer_t active_writer = {&print_NULL, &print_NULL, &print_NULL, &print_NULL, &print_NULL, &print_NULL,
22 &print_NULL, &print_NULL, &print_NULL, &print_NULL, &print_NULL, &print_NULL,
23 &print_NULL, &print_NULL, &print_NULL, &print_NULL, &print_NULL, &print_NULL};
25 std::vector<paje_event_t> buffer;
27 void dump_comment (const char *comment)
29 if (!strlen(comment)) return;
30 fprintf (tracing_file, "# %s\n", comment);
33 void dump_comment_file (const char *filename)
35 if (!strlen(filename)) return;
36 FILE *file = fopen (filename, "r");
38 THROWF (system_error, 1, "Comment file %s could not be opened for reading.", filename);
43 if (feof(file)) break;
44 fprintf (tracing_file, "# ");
46 fprintf (tracing_file, "%c", c);
48 if (feof(file)) break;
50 fprintf (tracing_file, "\n");
55 double TRACE_last_timestamp_to_dump = 0;
56 //dumps the trace file until the timestamp TRACE_last_timestamp_to_dump
57 void TRACE_paje_dump_buffer (int force)
59 if (!TRACE_is_enabled()) return;
60 XBT_DEBUG("%s: dump until %f. starts", __FUNCTION__, TRACE_last_timestamp_to_dump);
62 for (auto event :buffer){
68 std::vector<paje_event_t>::iterator i = buffer.begin();
69 for (auto event :buffer){
70 double head_timestamp = event->timestamp;
71 if (head_timestamp > TRACE_last_timestamp_to_dump)
77 buffer.erase(buffer.begin(), i);
79 XBT_DEBUG("%s: ends", __FUNCTION__);
82 /* internal do the instrumentation module */
83 static void insert_into_buffer (paje_event_t tbi)
85 if (TRACE_buffer() == 0){
91 XBT_DEBUG("%s: insert event_type=%d, timestamp=%f, buffersize=%zu)",
92 __FUNCTION__, (int)tbi->event_type, tbi->timestamp, buffer.size());
93 std::vector<paje_event_t>::reverse_iterator i;
94 for (i = buffer.rbegin(); i != buffer.rend(); ++i) {
96 if (e1->timestamp <= tbi->timestamp)
99 buffer.insert(i.base(), tbi);
100 if (i == buffer.rend())
101 XBT_DEBUG("%s: inserted at beginning", __FUNCTION__);
103 XBT_DEBUG("%s: inserted at%s %zd", __FUNCTION__, (i == buffer.rbegin()) ? " end" :"pos =",
104 std::distance(buffer.rend(),i));
107 static void free_paje_event (paje_event_t event)
109 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
110 switch (event->event_type){
112 xbt_free (((startLink_t)(event->data))->value);
113 xbt_free (((startLink_t)(event->data))->key);
116 xbt_free (((endLink_t)(event->data))->value);
117 xbt_free (((endLink_t)(event->data))->key);
122 xbt_free (event->data);
126 void new_pajeDefineContainerType(type_t type)
128 paje_event_t event = xbt_new0(s_paje_event_t, 1);
129 event->event_type = PAJE_DefineContainerType;
130 event->timestamp = 0;
131 event->print = active_writer.print_DefineContainerType;
132 event->free = &free_paje_event;
133 event->data = xbt_new0(s_defineContainerType_t, 1);
134 ((defineContainerType_t)(event->data))->type = type;
136 XBT_DEBUG("%s: event_type=%d", __FUNCTION__, (int)event->event_type);
139 event->print (event);
143 void new_pajeDefineVariableType(type_t type)
145 paje_event_t event = xbt_new0(s_paje_event_t, 1);
146 event->event_type = PAJE_DefineVariableType;
147 event->timestamp = 0;
148 event->print = active_writer.print_DefineVariableType;
149 event->free = &free_paje_event;
150 event->data = xbt_new0(s_defineVariableType_t, 1);
151 ((defineVariableType_t)(event->data))->type = type;
153 XBT_DEBUG("%s: event_type=%d", __FUNCTION__, (int)event->event_type);
156 event->print (event);
160 void new_pajeDefineStateType(type_t type)
162 paje_event_t event = xbt_new0(s_paje_event_t, 1);
163 event->event_type = PAJE_DefineStateType;
164 event->timestamp = 0;
165 event->print = active_writer.print_DefineStateType;
166 event->free = &free_paje_event;
167 event->data = xbt_new0(s_defineStateType_t, 1);
168 ((defineStateType_t)(event->data))->type = type;
170 XBT_DEBUG("%s: event_type=%d", __FUNCTION__, (int)event->event_type);
173 event->print (event);
177 void new_pajeDefineEventType(type_t type)
179 paje_event_t event = xbt_new0(s_paje_event_t, 1);
180 event->event_type = PAJE_DefineEventType;
181 event->timestamp = 0;
182 event->print = active_writer.print_DefineEventType;
183 event->free = &free_paje_event;
184 event->data = xbt_new0(s_defineEventType_t, 1);
185 ((defineEventType_t)(event->data))->type = type;
187 XBT_DEBUG("%s: event_type=%d", __FUNCTION__, (int)event->event_type);
190 event->print (event);
194 void new_pajeDefineLinkType(type_t type, type_t source, type_t dest)
196 paje_event_t event = xbt_new0(s_paje_event_t, 1);
197 event->event_type = PAJE_DefineLinkType;
198 event->timestamp = 0;
199 event->print = active_writer.print_DefineLinkType;
200 event->free = &free_paje_event;
201 event->data = xbt_new0(s_defineLinkType_t, 1);
202 ((defineLinkType_t)(event->data))->type = type;
203 ((defineLinkType_t)(event->data))->source = source;
204 ((defineLinkType_t)(event->data))->dest = dest;
206 XBT_DEBUG("%s: event_type=%d", __FUNCTION__, (int)event->event_type);
209 event->print (event);
213 void new_pajeDefineEntityValue (val_t value)
215 paje_event_t event = xbt_new0(s_paje_event_t, 1);
216 event->event_type = PAJE_DefineEntityValue;
217 event->timestamp = 0;
218 event->print = active_writer.print_DefineEntityValue;
219 event->free = &free_paje_event;
220 event->data = xbt_new0(s_defineEntityValue_t, 1);
221 ((defineEntityValue_t)(event->data))->value = value;
223 XBT_DEBUG("%s: event_type=%d", __FUNCTION__, (int)event->event_type);
226 event->print (event);
230 void new_pajeCreateContainer (container_t container)
232 paje_event_t event = xbt_new0(s_paje_event_t, 1);
233 event->event_type = PAJE_CreateContainer;
234 event->timestamp = SIMIX_get_clock();
235 event->print = active_writer.print_CreateContainer;
236 event->free = &free_paje_event;
237 event->data = xbt_new0(s_createContainer_t, 1);
238 ((createContainer_t)(event->data))->container = container;
240 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
243 event->print (event);
247 void new_pajeDestroyContainer (container_t container)
249 paje_event_t event = xbt_new0(s_paje_event_t, 1);
250 event->event_type = PAJE_DestroyContainer;
251 event->timestamp = SIMIX_get_clock();
252 event->print = active_writer.print_DestroyContainer;
253 event->free = &free_paje_event;
254 event->data = xbt_new0(s_destroyContainer_t, 1);
255 ((destroyContainer_t)(event->data))->container = container;
257 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
260 event->print (event);
264 void new_pajeSetVariable (double timestamp, container_t container, type_t type, double value)
266 paje_event_t event = xbt_new0(s_paje_event_t, 1);
267 event->event_type = PAJE_SetVariable;
268 event->timestamp = timestamp;
269 event->print = active_writer.print_SetVariable;
270 event->free = &free_paje_event;
271 event->data = xbt_new0(s_setVariable_t, 1);
272 ((setVariable_t)(event->data))->type = type;
273 ((setVariable_t)(event->data))->container = container;
274 ((setVariable_t)(event->data))->value = value;
276 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
278 insert_into_buffer (event);
282 void new_pajeAddVariable (double timestamp, container_t container, type_t type, double value)
284 paje_event_t event = xbt_new0(s_paje_event_t, 1);
285 event->event_type = PAJE_AddVariable;
286 event->timestamp = timestamp;
287 event->print = active_writer.print_AddVariable;
288 event->free = &free_paje_event;
289 event->data = xbt_new0(s_addVariable_t, 1);
290 ((addVariable_t)(event->data))->type = type;
291 ((addVariable_t)(event->data))->container = container;
292 ((addVariable_t)(event->data))->value = value;
294 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
296 insert_into_buffer (event);
299 void new_pajeSubVariable (double timestamp, container_t container, type_t type, double value)
301 paje_event_t event = xbt_new0(s_paje_event_t, 1);
302 event->event_type = PAJE_SubVariable;
303 event->timestamp = timestamp;
304 event->print = active_writer.print_SubVariable;
305 event->free = &free_paje_event;
306 event->data = xbt_new0(s_subVariable_t, 1);
307 ((subVariable_t)(event->data))->type = type;
308 ((subVariable_t)(event->data))->container = container;
309 ((subVariable_t)(event->data))->value = value;
311 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
313 insert_into_buffer (event);
316 void new_pajeSetState (double timestamp, container_t container, type_t type, val_t value)
318 paje_event_t event = xbt_new0(s_paje_event_t, 1);
319 event->event_type = PAJE_SetState;
320 event->timestamp = timestamp;
321 event->print = active_writer.print_SetState;
322 event->free = &free_paje_event;
323 event->data = xbt_new0(s_setState_t, 1);
324 ((setState_t)(event->data))->type = type;
325 ((setState_t)(event->data))->container = container;
326 ((setState_t)(event->data))->value = value;
329 if (xbt_cfg_get_boolean("smpi/trace-call-location")) {
330 smpi_trace_call_location_t* loc = smpi_trace_get_call_location();
331 ((setState_t)(event->data))->filename = loc->filename;
332 ((setState_t)(event->data))->linenumber = loc->linenumber;
336 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
338 insert_into_buffer (event);
342 void new_pajePushStateWithExtra (double timestamp, container_t container, type_t type, val_t value, void* extra)
344 paje_event_t event = xbt_new0(s_paje_event_t, 1);
345 event->event_type = PAJE_PushState;
346 event->timestamp = timestamp;
347 event->print = active_writer.print_PushState;
348 event->free = &free_paje_event;
349 event->data = xbt_new0(s_pushState_t, 1);
350 ((pushState_t)(event->data))->type = type;
351 ((pushState_t)(event->data))->container = container;
352 ((pushState_t)(event->data))->value = value;
353 ((pushState_t)(event->data))->extra = extra;
356 if (xbt_cfg_get_boolean("smpi/trace-call-location")) {
357 smpi_trace_call_location_t* loc = smpi_trace_get_call_location();
358 ((pushState_t)(event->data))->filename = loc->filename;
359 ((pushState_t)(event->data))->linenumber = loc->linenumber;
363 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
365 insert_into_buffer (event);
369 void new_pajePushState (double timestamp, container_t container, type_t type, val_t value)
371 new_pajePushStateWithExtra(timestamp, container, type, value, nullptr);
374 void new_pajePopState (double timestamp, container_t container, type_t type)
376 paje_event_t event = xbt_new0(s_paje_event_t, 1);
377 event->event_type = PAJE_PopState;
378 event->timestamp = timestamp;
379 event->print = active_writer.print_PopState;
380 event->free = &free_paje_event;
381 event->data = xbt_new0(s_popState_t, 1);
382 ((popState_t)(event->data))->type = type;
383 ((popState_t)(event->data))->container = container;
385 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
387 insert_into_buffer (event);
391 void new_pajeResetState (double timestamp, container_t container, type_t type)
393 paje_event_t event = xbt_new0(s_paje_event_t, 1);
394 event->event_type = PAJE_ResetState;
395 event->timestamp = timestamp;
396 event->print = active_writer.print_ResetState;
397 event->free = &free_paje_event;
398 event->data = xbt_new0(s_resetState_t, 1);
399 ((resetState_t)(event->data))->type = type;
400 ((resetState_t)(event->data))->container = container;
402 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
404 insert_into_buffer (event);
407 void new_pajeStartLink (double timestamp, container_t container, type_t type, container_t sourceContainer,
408 const char *value, const char *key)
410 new_pajeStartLinkWithSize(timestamp, container, type, sourceContainer, value, key, -1);
413 void new_pajeStartLinkWithSize (double timestamp, container_t container, type_t type, container_t sourceContainer,
414 const char *value, const char *key, int size)
416 paje_event_t event = xbt_new0(s_paje_event_t, 1);
417 event->event_type = PAJE_StartLink;
418 event->timestamp = timestamp;
419 event->print = active_writer.print_StartLink;
420 event->free = &free_paje_event;
421 event->data = xbt_new0(s_startLink_t, 1);
422 ((startLink_t)(event->data))->type = type;
423 ((startLink_t)(event->data))->container = container;
424 ((startLink_t)(event->data))->sourceContainer = sourceContainer;
425 ((startLink_t)(event->data))->value = xbt_strdup(value);
426 ((startLink_t)(event->data))->key = xbt_strdup(key);
427 ((startLink_t)(event->data))->size = size;
429 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
431 insert_into_buffer (event);
434 void new_pajeEndLink (double timestamp, container_t container, type_t type, container_t destContainer,
435 const char *value, const char *key)
437 paje_event_t event = xbt_new0(s_paje_event_t, 1);
438 event->event_type = PAJE_EndLink;
439 event->timestamp = timestamp;
440 event->print = active_writer.print_EndLink;
441 event->free = &free_paje_event;
442 event->data = xbt_new0(s_endLink_t, 1);
443 ((endLink_t)(event->data))->type = type;
444 ((endLink_t)(event->data))->container = container;
445 ((endLink_t)(event->data))->destContainer = destContainer;
446 ((endLink_t)(event->data))->value = xbt_strdup(value);
447 ((endLink_t)(event->data))->key = xbt_strdup(key);
449 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
451 insert_into_buffer (event);
454 void new_pajeNewEvent (double timestamp, container_t container, type_t type, val_t value)
456 paje_event_t event = xbt_new0(s_paje_event_t, 1);
457 event->event_type = PAJE_NewEvent;
458 event->timestamp = timestamp;
459 event->print = active_writer.print_NewEvent;
460 event->free = &free_paje_event;
461 event->data = xbt_new0(s_newEvent_t, 1);
462 ((newEvent_t)(event->data))->type = type;
463 ((newEvent_t)(event->data))->container = container;
464 ((newEvent_t)(event->data))->value = value;
466 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
468 insert_into_buffer (event);