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");
12 FILE *tracing_file = NULL;
14 void print_NULL(paje_event_t event){}
16 /* The active set of functions for the selected trace format
17 * By default, they all do nothing, hence the print_NULL to avoid segfaults */
19 s_instr_trace_writer_t active_writer = {
20 print_NULL, print_NULL, print_NULL, print_NULL,
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
27 xbt_dynar_t buffer = NULL;
29 void dump_comment (const char *comment)
31 if (!strlen(comment)) return;
32 fprintf (tracing_file, "# %s\n", comment);
35 void dump_comment_file (const char *filename)
37 if (!strlen(filename)) return;
38 FILE *file = fopen (filename, "r");
40 THROWF (system_error, 1, "Comment file %s could not be opened for reading.", filename);
45 if (feof(file)) break;
46 fprintf (tracing_file, "# ");
48 fprintf (tracing_file, "%c", c);
50 if (feof(file)) break;
52 fprintf (tracing_file, "\n");
59 buffer = xbt_dynar_new(sizeof(paje_event_t), NULL);
64 xbt_dynar_free(&buffer);
67 double TRACE_last_timestamp_to_dump = 0;
68 //dumps the trace file until the timestamp TRACE_last_timestamp_to_dump
69 void TRACE_paje_dump_buffer (int force)
71 if (!TRACE_is_enabled()) return;
72 XBT_DEBUG("%s: dump until %f. starts", __FUNCTION__, TRACE_last_timestamp_to_dump);
76 xbt_dynar_foreach(buffer, i, event){
80 xbt_dynar_free (&buffer);
81 buffer = xbt_dynar_new (sizeof(paje_event_t), NULL);
85 xbt_dynar_foreach(buffer, cursor, event) {
86 double head_timestamp = event->timestamp;
87 if (head_timestamp > TRACE_last_timestamp_to_dump){
93 xbt_dynar_remove_n_at(buffer, cursor, 0);
95 XBT_DEBUG("%s: ends", __FUNCTION__);
98 /* internal do the instrumentation module */
99 static void insert_into_buffer (paje_event_t tbi)
101 if (TRACE_buffer() == 0){
107 XBT_DEBUG("%s: insert event_type=%d, timestamp=%f, buffersize=%lu)",
108 __FUNCTION__, (int)tbi->event_type, tbi->timestamp, xbt_dynar_length(buffer));
111 for (i = xbt_dynar_length(buffer); i > 0; i--) {
112 paje_event_t e1 = *(paje_event_t*)xbt_dynar_get_ptr(buffer, i - 1);
113 if (e1->timestamp <= tbi->timestamp)
116 xbt_dynar_insert_at(buffer, i, &tbi);
118 XBT_DEBUG("%s: inserted at beginning", __FUNCTION__);
120 XBT_DEBUG("%s: inserted at%s %u", __FUNCTION__, (i == xbt_dynar_length(buffer) - 1 ? " end, pos =" : ""), i);
123 static void free_paje_event (paje_event_t event)
125 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
126 switch (event->event_type){
128 xbt_free (((startLink_t)(event->data))->value);
129 xbt_free (((startLink_t)(event->data))->key);
132 xbt_free (((endLink_t)(event->data))->value);
133 xbt_free (((endLink_t)(event->data))->key);
138 xbt_free (event->data);
142 void new_pajeDefineContainerType(type_t type)
144 paje_event_t event = xbt_new0(s_paje_event_t, 1);
145 event->event_type = PAJE_DefineContainerType;
146 event->timestamp = 0;
147 event->print = active_writer.print_DefineContainerType;
148 event->free = free_paje_event;
149 event->data = xbt_new0(s_defineContainerType_t, 1);
150 ((defineContainerType_t)(event->data))->type = type;
152 XBT_DEBUG("%s: event_type=%d", __FUNCTION__, (int)event->event_type);
155 event->print (event);
159 void new_pajeDefineVariableType(type_t type)
161 paje_event_t event = xbt_new0(s_paje_event_t, 1);
162 event->event_type = PAJE_DefineVariableType;
163 event->timestamp = 0;
164 event->print = active_writer.print_DefineVariableType;
165 event->free = free_paje_event;
166 event->data = xbt_new0(s_defineVariableType_t, 1);
167 ((defineVariableType_t)(event->data))->type = type;
169 XBT_DEBUG("%s: event_type=%d", __FUNCTION__, (int)event->event_type);
172 event->print (event);
176 void new_pajeDefineStateType(type_t type)
178 paje_event_t event = xbt_new0(s_paje_event_t, 1);
179 event->event_type = PAJE_DefineStateType;
180 event->timestamp = 0;
181 event->print = active_writer.print_DefineStateType;
182 event->free = free_paje_event;
183 event->data = xbt_new0(s_defineStateType_t, 1);
184 ((defineStateType_t)(event->data))->type = type;
186 XBT_DEBUG("%s: event_type=%d", __FUNCTION__, (int)event->event_type);
189 event->print (event);
193 void new_pajeDefineEventType(type_t type)
195 paje_event_t event = xbt_new0(s_paje_event_t, 1);
196 event->event_type = PAJE_DefineEventType;
197 event->timestamp = 0;
198 event->print = active_writer.print_DefineEventType;
199 event->free = free_paje_event;
200 event->data = xbt_new0(s_defineEventType_t, 1);
201 ((defineEventType_t)(event->data))->type = type;
203 XBT_DEBUG("%s: event_type=%d", __FUNCTION__, (int)event->event_type);
206 event->print (event);
210 void new_pajeDefineLinkType(type_t type, type_t source, type_t dest)
212 paje_event_t event = xbt_new0(s_paje_event_t, 1);
213 event->event_type = PAJE_DefineLinkType;
214 event->timestamp = 0;
215 event->print = active_writer.print_DefineLinkType;
216 event->free = free_paje_event;
217 event->data = xbt_new0(s_defineLinkType_t, 1);
218 ((defineLinkType_t)(event->data))->type = type;
219 ((defineLinkType_t)(event->data))->source = source;
220 ((defineLinkType_t)(event->data))->dest = dest;
222 XBT_DEBUG("%s: event_type=%d", __FUNCTION__, (int)event->event_type);
225 event->print (event);
229 void new_pajeDefineEntityValue (val_t value)
231 paje_event_t event = xbt_new0(s_paje_event_t, 1);
232 event->event_type = PAJE_DefineEntityValue;
233 event->timestamp = 0;
234 event->print = active_writer.print_DefineEntityValue;
235 event->free = free_paje_event;
236 event->data = xbt_new0(s_defineEntityValue_t, 1);
237 ((defineEntityValue_t)(event->data))->value = value;
239 XBT_DEBUG("%s: event_type=%d", __FUNCTION__, (int)event->event_type);
242 event->print (event);
246 void new_pajeCreateContainer (container_t container)
248 paje_event_t event = xbt_new0(s_paje_event_t, 1);
249 event->event_type = PAJE_CreateContainer;
250 event->timestamp = SIMIX_get_clock();
251 event->print = active_writer.print_CreateContainer;
252 event->free = free_paje_event;
253 event->data = xbt_new0(s_createContainer_t, 1);
254 ((createContainer_t)(event->data))->container = container;
256 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
259 event->print (event);
263 void new_pajeDestroyContainer (container_t container)
265 paje_event_t event = xbt_new0(s_paje_event_t, 1);
266 event->event_type = PAJE_DestroyContainer;
267 event->timestamp = SIMIX_get_clock();
268 event->print = active_writer.print_DestroyContainer;
269 event->free = free_paje_event;
270 event->data = xbt_new0(s_destroyContainer_t, 1);
271 ((destroyContainer_t)(event->data))->container = container;
273 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
276 event->print (event);
280 void new_pajeSetVariable (double timestamp, container_t container, type_t type, double value)
282 paje_event_t event = xbt_new0(s_paje_event_t, 1);
283 event->event_type = PAJE_SetVariable;
284 event->timestamp = timestamp;
285 event->print = active_writer.print_SetVariable;
286 event->free = free_paje_event;
287 event->data = xbt_new0(s_setVariable_t, 1);
288 ((setVariable_t)(event->data))->type = type;
289 ((setVariable_t)(event->data))->container = container;
290 ((setVariable_t)(event->data))->value = value;
292 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
294 insert_into_buffer (event);
298 void new_pajeAddVariable (double timestamp, container_t container, type_t type, double value)
300 paje_event_t event = xbt_new0(s_paje_event_t, 1);
301 event->event_type = PAJE_AddVariable;
302 event->timestamp = timestamp;
303 event->print = active_writer.print_AddVariable;
304 event->free = free_paje_event;
305 event->data = xbt_new0(s_addVariable_t, 1);
306 ((addVariable_t)(event->data))->type = type;
307 ((addVariable_t)(event->data))->container = container;
308 ((addVariable_t)(event->data))->value = value;
310 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
312 insert_into_buffer (event);
315 void new_pajeSubVariable (double timestamp, container_t container, type_t type, double value)
317 paje_event_t event = xbt_new0(s_paje_event_t, 1);
318 event->event_type = PAJE_SubVariable;
319 event->timestamp = timestamp;
320 event->print = active_writer.print_SubVariable;
321 event->free = free_paje_event;
322 event->data = xbt_new0(s_subVariable_t, 1);
323 ((subVariable_t)(event->data))->type = type;
324 ((subVariable_t)(event->data))->container = container;
325 ((subVariable_t)(event->data))->value = value;
327 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
329 insert_into_buffer (event);
332 void new_pajeSetState (double timestamp, container_t container, type_t type, val_t value)
334 paje_event_t event = xbt_new0(s_paje_event_t, 1);
335 event->event_type = PAJE_SetState;
336 event->timestamp = timestamp;
337 event->print = active_writer.print_SetState;
338 event->free = free_paje_event;
339 event->data = xbt_new0(s_setState_t, 1);
340 ((setState_t)(event->data))->type = type;
341 ((setState_t)(event->data))->container = container;
342 ((setState_t)(event->data))->value = value;
344 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
346 insert_into_buffer (event);
350 void new_pajePushStateWithExtra (double timestamp, container_t container, type_t type, val_t value, void* extra)
352 paje_event_t event = xbt_new0(s_paje_event_t, 1);
353 event->event_type = PAJE_PushState;
354 event->timestamp = timestamp;
355 event->print = active_writer.print_PushState;
356 event->free = free_paje_event;
357 event->data = xbt_new0(s_pushState_t, 1);
358 ((pushState_t)(event->data))->type = type;
359 ((pushState_t)(event->data))->container = container;
360 ((pushState_t)(event->data))->value = value;
361 ((pushState_t)(event->data))->extra = extra;
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 paje_event_t event = xbt_new0(s_paje_event_t, 1);
411 event->event_type = PAJE_StartLink;
412 event->timestamp = timestamp;
413 event->print = active_writer.print_StartLink;
414 event->free = free_paje_event;
415 event->data = xbt_new0(s_startLink_t, 1);
416 ((startLink_t)(event->data))->type = type;
417 ((startLink_t)(event->data))->container = container;
418 ((startLink_t)(event->data))->sourceContainer = sourceContainer;
419 ((startLink_t)(event->data))->value = xbt_strdup(value);
420 ((startLink_t)(event->data))->key = xbt_strdup(key);
421 ((startLink_t)(event->data))->size = -1;
422 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
424 insert_into_buffer (event);
427 void new_pajeStartLinkWithSize (double timestamp, container_t container, type_t type, container_t sourceContainer,
428 const char *value, const char *key, int size)
430 paje_event_t event = xbt_new0(s_paje_event_t, 1);
431 event->event_type = PAJE_StartLink;
432 event->timestamp = timestamp;
433 event->print = active_writer.print_StartLink;
434 event->free = free_paje_event;
435 event->data = xbt_new0(s_startLink_t, 1);
436 ((startLink_t)(event->data))->type = type;
437 ((startLink_t)(event->data))->container = container;
438 ((startLink_t)(event->data))->sourceContainer = sourceContainer;
439 ((startLink_t)(event->data))->value = xbt_strdup(value);
440 ((startLink_t)(event->data))->key = xbt_strdup(key);
441 ((startLink_t)(event->data))->size = size;
443 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
445 insert_into_buffer (event);
448 void new_pajeEndLink (double timestamp, container_t container, type_t type, container_t destContainer,
449 const char *value, const char *key)
451 paje_event_t event = xbt_new0(s_paje_event_t, 1);
452 event->event_type = PAJE_EndLink;
453 event->timestamp = timestamp;
454 event->print = active_writer.print_EndLink;
455 event->free = free_paje_event;
456 event->data = xbt_new0(s_endLink_t, 1);
457 ((endLink_t)(event->data))->type = type;
458 ((endLink_t)(event->data))->container = container;
459 ((endLink_t)(event->data))->destContainer = destContainer;
460 ((endLink_t)(event->data))->value = xbt_strdup(value);
461 ((endLink_t)(event->data))->key = xbt_strdup(key);
463 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
465 insert_into_buffer (event);
468 void new_pajeNewEvent (double timestamp, container_t container, type_t type, val_t value)
470 paje_event_t event = xbt_new0(s_paje_event_t, 1);
471 event->event_type = PAJE_NewEvent;
472 event->timestamp = timestamp;
473 event->print = active_writer.print_NewEvent;
474 event->free = free_paje_event;
475 event->data = xbt_new0(s_newEvent_t, 1);
476 ((newEvent_t)(event->data))->type = type;
477 ((newEvent_t)(event->data))->container = container;
478 ((newEvent_t)(event->data))->value = value;
480 XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
482 insert_into_buffer (event);