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 "xbt/virtu.h" /* sg_cmdline */
10 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(instr_trace, instr, "tracing event system");
13 FILE *tracing_file = NULL;
15 void print_NULL(paje_event_t event){}
17 /* The active set of functions for the selected trace format
18 * By default, they all do nothing, hence the print_NULL to avoid segfaults */
20 s_instr_trace_writer_t active_writer = {
21 print_NULL, print_NULL, print_NULL, print_NULL,
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
28 xbt_dynar_t buffer = NULL;
30 void dump_comment (const char *comment)
32 if (!strlen(comment)) return;
33 fprintf (tracing_file, "# %s\n", comment);
36 void dump_comment_file (const char *filename)
38 if (!strlen(filename)) return;
39 FILE *file = fopen (filename, "r");
41 THROWF (system_error, 1, "Comment file %s could not be opened for reading.", filename);
46 if (feof(file)) break;
47 fprintf (tracing_file, "# ");
49 fprintf (tracing_file, "%c", c);
51 if (feof(file)) break;
53 fprintf (tracing_file, "\n");
60 buffer = xbt_dynar_new(sizeof(paje_event_t), NULL);
65 xbt_dynar_free(&buffer);
68 double TRACE_last_timestamp_to_dump = 0;
69 //dumps the trace file until the timestamp TRACE_last_timestamp_to_dump
70 void TRACE_paje_dump_buffer (int force)
72 if (!TRACE_is_enabled()) return;
73 XBT_DEBUG("%s: dump until %f. starts", __FUNCTION__, TRACE_last_timestamp_to_dump);
77 xbt_dynar_foreach(buffer, i, event){
81 xbt_dynar_free (&buffer);
82 buffer = xbt_dynar_new (sizeof(paje_event_t), NULL);
86 xbt_dynar_foreach(buffer, cursor, event) {
87 double head_timestamp = event->timestamp;
88 if (head_timestamp > TRACE_last_timestamp_to_dump){
94 xbt_dynar_remove_n_at(buffer, cursor, 0);
96 XBT_DEBUG("%s: ends", __FUNCTION__);
99 /* internal do the instrumentation module */
100 static void insert_into_buffer (paje_event_t tbi)
102 if (TRACE_buffer() == 0){
108 XBT_DEBUG("%s: insert event_type=%d, timestamp=%f, buffersize=%lu)",
109 __FUNCTION__, (int)tbi->event_type, tbi->timestamp, xbt_dynar_length(buffer));
112 for (i = xbt_dynar_length(buffer); i > 0; i--) {
113 paje_event_t e1 = *(paje_event_t*)xbt_dynar_get_ptr(buffer, i - 1);
114 if (e1->timestamp <= tbi->timestamp)
117 xbt_dynar_insert_at(buffer, i, &tbi);
119 XBT_DEBUG("%s: inserted at beginning", __FUNCTION__);
121 XBT_DEBUG("%s: inserted at%s %u", __FUNCTION__,
122 (i == xbt_dynar_length(buffer) - 1 ? " end, pos =" : ""), i);
126 static void free_paje_event (paje_event_t event)
128 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
129 switch (event->event_type){
131 xbt_free (((startLink_t)(event->data))->value);
132 xbt_free (((startLink_t)(event->data))->key);
135 xbt_free (((endLink_t)(event->data))->value);
136 xbt_free (((endLink_t)(event->data))->key);
141 xbt_free (event->data);
145 void new_pajeDefineContainerType(type_t type)
147 paje_event_t event = xbt_new0(s_paje_event_t, 1);
148 event->event_type = PAJE_DefineContainerType;
149 event->timestamp = 0;
150 event->print = active_writer.print_DefineContainerType;
151 event->free = free_paje_event;
152 event->data = xbt_new0(s_defineContainerType_t, 1);
153 ((defineContainerType_t)(event->data))->type = type;
155 XBT_DEBUG("%s: event_type=%d", __FUNCTION__, (int)event->event_type);
158 event->print (event);
162 void new_pajeDefineVariableType(type_t type)
164 paje_event_t event = xbt_new0(s_paje_event_t, 1);
165 event->event_type = PAJE_DefineVariableType;
166 event->timestamp = 0;
167 event->print = active_writer.print_DefineVariableType;
168 event->free = free_paje_event;
169 event->data = xbt_new0(s_defineVariableType_t, 1);
170 ((defineVariableType_t)(event->data))->type = type;
172 XBT_DEBUG("%s: event_type=%d", __FUNCTION__, (int)event->event_type);
175 event->print (event);
179 void new_pajeDefineStateType(type_t type)
181 paje_event_t event = xbt_new0(s_paje_event_t, 1);
182 event->event_type = PAJE_DefineStateType;
183 event->timestamp = 0;
184 event->print = active_writer.print_DefineStateType;
185 event->free = free_paje_event;
186 event->data = xbt_new0(s_defineStateType_t, 1);
187 ((defineStateType_t)(event->data))->type = type;
189 XBT_DEBUG("%s: event_type=%d", __FUNCTION__, (int)event->event_type);
192 event->print (event);
196 void new_pajeDefineEventType(type_t type)
198 paje_event_t event = xbt_new0(s_paje_event_t, 1);
199 event->event_type = PAJE_DefineEventType;
200 event->timestamp = 0;
201 event->print = active_writer.print_DefineEventType;
202 event->free = free_paje_event;
203 event->data = xbt_new0(s_defineEventType_t, 1);
204 ((defineEventType_t)(event->data))->type = type;
206 XBT_DEBUG("%s: event_type=%d", __FUNCTION__, (int)event->event_type);
209 event->print (event);
213 void new_pajeDefineLinkType(type_t type, type_t source, type_t dest)
215 paje_event_t event = xbt_new0(s_paje_event_t, 1);
216 event->event_type = PAJE_DefineLinkType;
217 event->timestamp = 0;
218 event->print = active_writer.print_DefineLinkType;
219 event->free = free_paje_event;
220 event->data = xbt_new0(s_defineLinkType_t, 1);
221 ((defineLinkType_t)(event->data))->type = type;
222 ((defineLinkType_t)(event->data))->source = source;
223 ((defineLinkType_t)(event->data))->dest = dest;
225 XBT_DEBUG("%s: event_type=%d", __FUNCTION__, (int)event->event_type);
228 event->print (event);
232 void new_pajeDefineEntityValue (val_t value)
234 paje_event_t event = xbt_new0(s_paje_event_t, 1);
235 event->event_type = PAJE_DefineEntityValue;
236 event->timestamp = 0;
237 event->print = active_writer.print_DefineEntityValue;
238 event->free = free_paje_event;
239 event->data = xbt_new0(s_defineEntityValue_t, 1);
240 ((defineEntityValue_t)(event->data))->value = value;
242 XBT_DEBUG("%s: event_type=%d", __FUNCTION__, (int)event->event_type);
245 event->print (event);
249 void new_pajeCreateContainer (container_t container)
251 paje_event_t event = xbt_new0(s_paje_event_t, 1);
252 event->event_type = PAJE_CreateContainer;
253 event->timestamp = SIMIX_get_clock();
254 event->print = active_writer.print_CreateContainer;
255 event->free = free_paje_event;
256 event->data = xbt_new0(s_createContainer_t, 1);
257 ((createContainer_t)(event->data))->container = container;
259 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
262 event->print (event);
266 void new_pajeDestroyContainer (container_t container)
268 paje_event_t event = xbt_new0(s_paje_event_t, 1);
269 event->event_type = PAJE_DestroyContainer;
270 event->timestamp = SIMIX_get_clock();
271 event->print = active_writer.print_DestroyContainer;
272 event->free = free_paje_event;
273 event->data = xbt_new0(s_destroyContainer_t, 1);
274 ((destroyContainer_t)(event->data))->container = container;
276 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
279 event->print (event);
283 void new_pajeSetVariable (double timestamp, container_t container, type_t type, double value)
285 paje_event_t event = xbt_new0(s_paje_event_t, 1);
286 event->event_type = PAJE_SetVariable;
287 event->timestamp = timestamp;
288 event->print = active_writer.print_SetVariable;
289 event->free = free_paje_event;
290 event->data = xbt_new0(s_setVariable_t, 1);
291 ((setVariable_t)(event->data))->type = type;
292 ((setVariable_t)(event->data))->container = container;
293 ((setVariable_t)(event->data))->value = value;
295 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
297 insert_into_buffer (event);
301 void new_pajeAddVariable (double timestamp, container_t container, type_t type, double value)
303 paje_event_t event = xbt_new0(s_paje_event_t, 1);
304 event->event_type = PAJE_AddVariable;
305 event->timestamp = timestamp;
306 event->print = active_writer.print_AddVariable;
307 event->free = free_paje_event;
308 event->data = xbt_new0(s_addVariable_t, 1);
309 ((addVariable_t)(event->data))->type = type;
310 ((addVariable_t)(event->data))->container = container;
311 ((addVariable_t)(event->data))->value = value;
313 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
315 insert_into_buffer (event);
318 void new_pajeSubVariable (double timestamp, container_t container, type_t type, double value)
320 paje_event_t event = xbt_new0(s_paje_event_t, 1);
321 event->event_type = PAJE_SubVariable;
322 event->timestamp = timestamp;
323 event->print = active_writer.print_SubVariable;
324 event->free = free_paje_event;
325 event->data = xbt_new0(s_subVariable_t, 1);
326 ((subVariable_t)(event->data))->type = type;
327 ((subVariable_t)(event->data))->container = container;
328 ((subVariable_t)(event->data))->value = value;
330 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
332 insert_into_buffer (event);
335 void new_pajeSetState (double timestamp, container_t container, type_t type, val_t value)
337 paje_event_t event = xbt_new0(s_paje_event_t, 1);
338 event->event_type = PAJE_SetState;
339 event->timestamp = timestamp;
340 event->print = active_writer.print_SetState;
341 event->free = free_paje_event;
342 event->data = xbt_new0(s_setState_t, 1);
343 ((setState_t)(event->data))->type = type;
344 ((setState_t)(event->data))->container = container;
345 ((setState_t)(event->data))->value = value;
347 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
349 insert_into_buffer (event);
353 void new_pajePushStateWithExtra (double timestamp, container_t container, type_t type, val_t value, void* extra)
355 paje_event_t event = xbt_new0(s_paje_event_t, 1);
356 event->event_type = PAJE_PushState;
357 event->timestamp = timestamp;
358 event->print = active_writer.print_PushState;
359 event->free = free_paje_event;
360 event->data = xbt_new0(s_pushState_t, 1);
361 ((pushState_t)(event->data))->type = type;
362 ((pushState_t)(event->data))->container = container;
363 ((pushState_t)(event->data))->value = value;
364 ((pushState_t)(event->data))->extra = extra;
366 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
368 insert_into_buffer (event);
372 void new_pajePushState (double timestamp, container_t container, type_t type, val_t value)
374 paje_event_t event = xbt_new0(s_paje_event_t, 1);
375 event->event_type = PAJE_PushState;
376 event->timestamp = timestamp;
377 event->print = active_writer.print_PushState;
378 event->free = free_paje_event;
379 event->data = xbt_new0(s_pushState_t, 1);
380 ((pushState_t)(event->data))->type = type;
381 ((pushState_t)(event->data))->container = container;
382 ((pushState_t)(event->data))->value = value;
383 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
385 insert_into_buffer (event);
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, const char *value, const char *key)
423 paje_event_t event = xbt_new0(s_paje_event_t, 1);
424 event->event_type = PAJE_StartLink;
425 event->timestamp = timestamp;
426 event->print = active_writer.print_StartLink;
427 event->free = free_paje_event;
428 event->data = xbt_new0(s_startLink_t, 1);
429 ((startLink_t)(event->data))->type = type;
430 ((startLink_t)(event->data))->container = container;
431 ((startLink_t)(event->data))->sourceContainer = sourceContainer;
432 ((startLink_t)(event->data))->value = xbt_strdup(value);
433 ((startLink_t)(event->data))->key = xbt_strdup(key);
434 ((startLink_t)(event->data))->size = -1;
435 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
437 insert_into_buffer (event);
440 void new_pajeStartLinkWithSize (double timestamp, container_t container, type_t type, container_t sourceContainer, const char *value, const char *key, int size)
442 paje_event_t event = xbt_new0(s_paje_event_t, 1);
443 event->event_type = PAJE_StartLink;
444 event->timestamp = timestamp;
445 event->print = active_writer.print_StartLink;
446 event->free = free_paje_event;
447 event->data = xbt_new0(s_startLink_t, 1);
448 ((startLink_t)(event->data))->type = type;
449 ((startLink_t)(event->data))->container = container;
450 ((startLink_t)(event->data))->sourceContainer = sourceContainer;
451 ((startLink_t)(event->data))->value = xbt_strdup(value);
452 ((startLink_t)(event->data))->key = xbt_strdup(key);
453 ((startLink_t)(event->data))->size = size;
455 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
457 insert_into_buffer (event);
460 void new_pajeEndLink (double timestamp, container_t container, type_t type, container_t destContainer, const char *value, const char *key)
462 paje_event_t event = xbt_new0(s_paje_event_t, 1);
463 event->event_type = PAJE_EndLink;
464 event->timestamp = timestamp;
465 event->print = active_writer.print_EndLink;
466 event->free = free_paje_event;
467 event->data = xbt_new0(s_endLink_t, 1);
468 ((endLink_t)(event->data))->type = type;
469 ((endLink_t)(event->data))->container = container;
470 ((endLink_t)(event->data))->destContainer = destContainer;
471 ((endLink_t)(event->data))->value = xbt_strdup(value);
472 ((endLink_t)(event->data))->key = xbt_strdup(key);
474 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
476 insert_into_buffer (event);
479 void new_pajeNewEvent (double timestamp, container_t container, type_t type, val_t value)
481 paje_event_t event = xbt_new0(s_paje_event_t, 1);
482 event->event_type = PAJE_NewEvent;
483 event->timestamp = timestamp;
484 event->print = active_writer.print_NewEvent;
485 event->free = free_paje_event;
486 event->data = xbt_new0(s_newEvent_t, 1);
487 ((newEvent_t)(event->data))->type = type;
488 ((newEvent_t)(event->data))->container = container;
489 ((newEvent_t)(event->data))->value = value;
491 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
493 insert_into_buffer (event);