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 = NULL;
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 = {
22 print_NULL, print_NULL, print_NULL, print_NULL,
23 print_NULL, print_NULL, print_NULL, print_NULL,
24 print_NULL, print_NULL, print_NULL, print_NULL,
25 print_NULL, print_NULL, print_NULL, print_NULL,
26 print_NULL, print_NULL
29 xbt_dynar_t buffer = NULL;
31 void dump_comment (const char *comment)
33 if (!strlen(comment)) return;
34 fprintf (tracing_file, "# %s\n", comment);
37 void dump_comment_file (const char *filename)
39 if (!strlen(filename)) return;
40 FILE *file = fopen (filename, "r");
42 THROWF (system_error, 1, "Comment file %s could not be opened for reading.", filename);
47 if (feof(file)) break;
48 fprintf (tracing_file, "# ");
50 fprintf (tracing_file, "%c", c);
52 if (feof(file)) break;
54 fprintf (tracing_file, "\n");
61 buffer = xbt_dynar_new(sizeof(paje_event_t), NULL);
66 xbt_dynar_free(&buffer);
69 double TRACE_last_timestamp_to_dump = 0;
70 //dumps the trace file until the timestamp TRACE_last_timestamp_to_dump
71 void TRACE_paje_dump_buffer (int force)
73 if (!TRACE_is_enabled()) return;
74 XBT_DEBUG("%s: dump until %f. starts", __FUNCTION__, TRACE_last_timestamp_to_dump);
78 xbt_dynar_foreach(buffer, i, event){
82 xbt_dynar_free (&buffer);
83 buffer = xbt_dynar_new (sizeof(paje_event_t), NULL);
87 xbt_dynar_foreach(buffer, cursor, event) {
88 double head_timestamp = event->timestamp;
89 if (head_timestamp > TRACE_last_timestamp_to_dump){
95 xbt_dynar_remove_n_at(buffer, cursor, 0);
97 XBT_DEBUG("%s: ends", __FUNCTION__);
100 /* internal do the instrumentation module */
101 static void insert_into_buffer (paje_event_t tbi)
103 if (TRACE_buffer() == 0){
109 XBT_DEBUG("%s: insert event_type=%d, timestamp=%f, buffersize=%lu)",
110 __FUNCTION__, (int)tbi->event_type, tbi->timestamp, xbt_dynar_length(buffer));
113 for (i = xbt_dynar_length(buffer); i > 0; i--) {
114 paje_event_t e1 = *(paje_event_t*)xbt_dynar_get_ptr(buffer, i - 1);
115 if (e1->timestamp <= tbi->timestamp)
118 xbt_dynar_insert_at(buffer, i, &tbi);
120 XBT_DEBUG("%s: inserted at beginning", __FUNCTION__);
122 XBT_DEBUG("%s: inserted at%s %u", __FUNCTION__, (i == xbt_dynar_length(buffer) - 1 ? " end, pos =" : ""), i);
125 static void free_paje_event (paje_event_t event)
127 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
128 switch (event->event_type){
130 xbt_free (((startLink_t)(event->data))->value);
131 xbt_free (((startLink_t)(event->data))->key);
134 xbt_free (((endLink_t)(event->data))->value);
135 xbt_free (((endLink_t)(event->data))->key);
140 xbt_free (event->data);
144 void new_pajeDefineContainerType(type_t type)
146 paje_event_t event = xbt_new0(s_paje_event_t, 1);
147 event->event_type = PAJE_DefineContainerType;
148 event->timestamp = 0;
149 event->print = active_writer.print_DefineContainerType;
150 event->free = free_paje_event;
151 event->data = xbt_new0(s_defineContainerType_t, 1);
152 ((defineContainerType_t)(event->data))->type = type;
154 XBT_DEBUG("%s: event_type=%d", __FUNCTION__, (int)event->event_type);
157 event->print (event);
161 void new_pajeDefineVariableType(type_t type)
163 paje_event_t event = xbt_new0(s_paje_event_t, 1);
164 event->event_type = PAJE_DefineVariableType;
165 event->timestamp = 0;
166 event->print = active_writer.print_DefineVariableType;
167 event->free = free_paje_event;
168 event->data = xbt_new0(s_defineVariableType_t, 1);
169 ((defineVariableType_t)(event->data))->type = type;
171 XBT_DEBUG("%s: event_type=%d", __FUNCTION__, (int)event->event_type);
174 event->print (event);
178 void new_pajeDefineStateType(type_t type)
180 paje_event_t event = xbt_new0(s_paje_event_t, 1);
181 event->event_type = PAJE_DefineStateType;
182 event->timestamp = 0;
183 event->print = active_writer.print_DefineStateType;
184 event->free = free_paje_event;
185 event->data = xbt_new0(s_defineStateType_t, 1);
186 ((defineStateType_t)(event->data))->type = type;
188 XBT_DEBUG("%s: event_type=%d", __FUNCTION__, (int)event->event_type);
191 event->print (event);
195 void new_pajeDefineEventType(type_t type)
197 paje_event_t event = xbt_new0(s_paje_event_t, 1);
198 event->event_type = PAJE_DefineEventType;
199 event->timestamp = 0;
200 event->print = active_writer.print_DefineEventType;
201 event->free = free_paje_event;
202 event->data = xbt_new0(s_defineEventType_t, 1);
203 ((defineEventType_t)(event->data))->type = type;
205 XBT_DEBUG("%s: event_type=%d", __FUNCTION__, (int)event->event_type);
208 event->print (event);
212 void new_pajeDefineLinkType(type_t type, type_t source, type_t dest)
214 paje_event_t event = xbt_new0(s_paje_event_t, 1);
215 event->event_type = PAJE_DefineLinkType;
216 event->timestamp = 0;
217 event->print = active_writer.print_DefineLinkType;
218 event->free = free_paje_event;
219 event->data = xbt_new0(s_defineLinkType_t, 1);
220 ((defineLinkType_t)(event->data))->type = type;
221 ((defineLinkType_t)(event->data))->source = source;
222 ((defineLinkType_t)(event->data))->dest = dest;
224 XBT_DEBUG("%s: event_type=%d", __FUNCTION__, (int)event->event_type);
227 event->print (event);
231 void new_pajeDefineEntityValue (val_t value)
233 paje_event_t event = xbt_new0(s_paje_event_t, 1);
234 event->event_type = PAJE_DefineEntityValue;
235 event->timestamp = 0;
236 event->print = active_writer.print_DefineEntityValue;
237 event->free = free_paje_event;
238 event->data = xbt_new0(s_defineEntityValue_t, 1);
239 ((defineEntityValue_t)(event->data))->value = value;
241 XBT_DEBUG("%s: event_type=%d", __FUNCTION__, (int)event->event_type);
244 event->print (event);
248 void new_pajeCreateContainer (container_t container)
250 paje_event_t event = xbt_new0(s_paje_event_t, 1);
251 event->event_type = PAJE_CreateContainer;
252 event->timestamp = SIMIX_get_clock();
253 event->print = active_writer.print_CreateContainer;
254 event->free = free_paje_event;
255 event->data = xbt_new0(s_createContainer_t, 1);
256 ((createContainer_t)(event->data))->container = container;
258 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
261 event->print (event);
265 void new_pajeDestroyContainer (container_t container)
267 paje_event_t event = xbt_new0(s_paje_event_t, 1);
268 event->event_type = PAJE_DestroyContainer;
269 event->timestamp = SIMIX_get_clock();
270 event->print = active_writer.print_DestroyContainer;
271 event->free = free_paje_event;
272 event->data = xbt_new0(s_destroyContainer_t, 1);
273 ((destroyContainer_t)(event->data))->container = container;
275 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
278 event->print (event);
282 void new_pajeSetVariable (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_SetVariable;
286 event->timestamp = timestamp;
287 event->print = active_writer.print_SetVariable;
288 event->free = free_paje_event;
289 event->data = xbt_new0(s_setVariable_t, 1);
290 ((setVariable_t)(event->data))->type = type;
291 ((setVariable_t)(event->data))->container = container;
292 ((setVariable_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);
300 void new_pajeAddVariable (double timestamp, container_t container, type_t type, double value)
302 paje_event_t event = xbt_new0(s_paje_event_t, 1);
303 event->event_type = PAJE_AddVariable;
304 event->timestamp = timestamp;
305 event->print = active_writer.print_AddVariable;
306 event->free = free_paje_event;
307 event->data = xbt_new0(s_addVariable_t, 1);
308 ((addVariable_t)(event->data))->type = type;
309 ((addVariable_t)(event->data))->container = container;
310 ((addVariable_t)(event->data))->value = value;
312 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
314 insert_into_buffer (event);
317 void new_pajeSubVariable (double timestamp, container_t container, type_t type, double value)
319 paje_event_t event = xbt_new0(s_paje_event_t, 1);
320 event->event_type = PAJE_SubVariable;
321 event->timestamp = timestamp;
322 event->print = active_writer.print_SubVariable;
323 event->free = free_paje_event;
324 event->data = xbt_new0(s_subVariable_t, 1);
325 ((subVariable_t)(event->data))->type = type;
326 ((subVariable_t)(event->data))->container = container;
327 ((subVariable_t)(event->data))->value = value;
329 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
331 insert_into_buffer (event);
334 void new_pajeSetState (double timestamp, container_t container, type_t type, val_t value)
336 paje_event_t event = xbt_new0(s_paje_event_t, 1);
337 event->event_type = PAJE_SetState;
338 event->timestamp = timestamp;
339 event->print = active_writer.print_SetState;
340 event->free = free_paje_event;
341 event->data = xbt_new0(s_setState_t, 1);
342 ((setState_t)(event->data))->type = type;
343 ((setState_t)(event->data))->container = container;
344 ((setState_t)(event->data))->value = value;
346 if (xbt_cfg_get_boolean("smpi/trace-call-location")) {
347 smpi_trace_call_location_t* loc = smpi_trace_get_call_location();
348 ((setState_t)(event->data))->filename = loc->filename;
349 ((setState_t)(event->data))->linenumber = loc->linenumber;
352 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
354 insert_into_buffer (event);
358 void new_pajePushStateWithExtra (double timestamp, container_t container, type_t type, val_t value, void* extra)
360 paje_event_t event = xbt_new0(s_paje_event_t, 1);
361 event->event_type = PAJE_PushState;
362 event->timestamp = timestamp;
363 event->print = active_writer.print_PushState;
364 event->free = free_paje_event;
365 event->data = xbt_new0(s_pushState_t, 1);
366 ((pushState_t)(event->data))->type = type;
367 ((pushState_t)(event->data))->container = container;
368 ((pushState_t)(event->data))->value = value;
369 ((pushState_t)(event->data))->extra = extra;
371 if (xbt_cfg_get_boolean("smpi/trace-call-location")) {
372 smpi_trace_call_location_t* loc = smpi_trace_get_call_location();
373 ((pushState_t)(event->data))->filename = loc->filename;
374 ((pushState_t)(event->data))->linenumber = loc->linenumber;
377 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
379 insert_into_buffer (event);
383 void new_pajePushState (double timestamp, container_t container, type_t type, val_t value)
385 new_pajePushStateWithExtra(timestamp, container, type, value, nullptr);
388 void new_pajePopState (double timestamp, container_t container, type_t type)
390 paje_event_t event = xbt_new0(s_paje_event_t, 1);
391 event->event_type = PAJE_PopState;
392 event->timestamp = timestamp;
393 event->print = active_writer.print_PopState;
394 event->free = free_paje_event;
395 event->data = xbt_new0(s_popState_t, 1);
396 ((popState_t)(event->data))->type = type;
397 ((popState_t)(event->data))->container = container;
399 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
401 insert_into_buffer (event);
405 void new_pajeResetState (double timestamp, container_t container, type_t type)
407 paje_event_t event = xbt_new0(s_paje_event_t, 1);
408 event->event_type = PAJE_ResetState;
409 event->timestamp = timestamp;
410 event->print = active_writer.print_ResetState;
411 event->free = free_paje_event;
412 event->data = xbt_new0(s_resetState_t, 1);
413 ((resetState_t)(event->data))->type = type;
414 ((resetState_t)(event->data))->container = container;
416 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
418 insert_into_buffer (event);
421 void new_pajeStartLink (double timestamp, container_t container, type_t type, container_t sourceContainer,
422 const char *value, const char *key)
424 paje_event_t event = xbt_new0(s_paje_event_t, 1);
425 event->event_type = PAJE_StartLink;
426 event->timestamp = timestamp;
427 event->print = active_writer.print_StartLink;
428 event->free = free_paje_event;
429 event->data = xbt_new0(s_startLink_t, 1);
430 ((startLink_t)(event->data))->type = type;
431 ((startLink_t)(event->data))->container = container;
432 ((startLink_t)(event->data))->sourceContainer = sourceContainer;
433 ((startLink_t)(event->data))->value = xbt_strdup(value);
434 ((startLink_t)(event->data))->key = xbt_strdup(key);
435 ((startLink_t)(event->data))->size = -1;
436 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
438 insert_into_buffer (event);
441 void new_pajeStartLinkWithSize (double timestamp, container_t container, type_t type, container_t sourceContainer,
442 const char *value, const char *key, int size)
444 paje_event_t event = xbt_new0(s_paje_event_t, 1);
445 event->event_type = PAJE_StartLink;
446 event->timestamp = timestamp;
447 event->print = active_writer.print_StartLink;
448 event->free = free_paje_event;
449 event->data = xbt_new0(s_startLink_t, 1);
450 ((startLink_t)(event->data))->type = type;
451 ((startLink_t)(event->data))->container = container;
452 ((startLink_t)(event->data))->sourceContainer = sourceContainer;
453 ((startLink_t)(event->data))->value = xbt_strdup(value);
454 ((startLink_t)(event->data))->key = xbt_strdup(key);
455 ((startLink_t)(event->data))->size = size;
457 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
459 insert_into_buffer (event);
462 void new_pajeEndLink (double timestamp, container_t container, type_t type, container_t destContainer,
463 const char *value, const char *key)
465 paje_event_t event = xbt_new0(s_paje_event_t, 1);
466 event->event_type = PAJE_EndLink;
467 event->timestamp = timestamp;
468 event->print = active_writer.print_EndLink;
469 event->free = free_paje_event;
470 event->data = xbt_new0(s_endLink_t, 1);
471 ((endLink_t)(event->data))->type = type;
472 ((endLink_t)(event->data))->container = container;
473 ((endLink_t)(event->data))->destContainer = destContainer;
474 ((endLink_t)(event->data))->value = xbt_strdup(value);
475 ((endLink_t)(event->data))->key = xbt_strdup(key);
477 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
479 insert_into_buffer (event);
482 void new_pajeNewEvent (double timestamp, container_t container, type_t type, val_t value)
484 paje_event_t event = xbt_new0(s_paje_event_t, 1);
485 event->event_type = PAJE_NewEvent;
486 event->timestamp = timestamp;
487 event->print = active_writer.print_NewEvent;
488 event->free = free_paje_event;
489 event->data = xbt_new0(s_newEvent_t, 1);
490 ((newEvent_t)(event->data))->type = type;
491 ((newEvent_t)(event->data))->container = container;
492 ((newEvent_t)(event->data))->value = value;
494 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
496 insert_into_buffer (event);