src/instr/instr_trace.cpp

   1 /* Copyright (c) 2010-2015. 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 "src/instr/instr_private.h"
   8 #include "xbt/virtu.h" /* sg_cmdline */
   9
  10 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(instr_trace, instr, "tracing event system");
  11
  12 FILE *tracing_file = NULL;
  13
  14 void print_NULL(paje_event_t event){}
  15
  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 */
  18
  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
  25 };
  26
  27 xbt_dynar_t buffer = NULL;
  28
  29 void dump_comment (const char *comment)
  30 {
  31   if (!strlen(comment)) return;
  32   fprintf (tracing_file, "# %s\n", comment);
  33 }
  34
  35 void dump_comment_file (const char *filename)
  36 {
  37   if (!strlen(filename)) return;
  38   FILE *file = fopen (filename, "r");
  39   if (!file){
  40     THROWF (system_error, 1, "Comment file %s could not be opened for reading.", filename);
  41   }
  42   while (!feof(file)){
  43     char c;
  44     c = fgetc(file);
  45     if (feof(file)) break;
  46     fprintf (tracing_file, "# ");
  47     while (c != '\n'){
  48       fprintf (tracing_file, "%c", c);
  49       c = fgetc(file);
  50       if (feof(file)) break;
  51     }
  52     fprintf (tracing_file, "\n");
  53   }
  54   fclose(file);
  55 }
  56
  57 void TRACE_init()
  58 {
  59   buffer = xbt_dynar_new(sizeof(paje_event_t), NULL);
  60 }
  61
  62 void TRACE_finalize()
  63 {
  64   xbt_dynar_free(&buffer);
  65 }
  66
  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)
  70 {
  71   if (!TRACE_is_enabled()) return;
  72   XBT_DEBUG("%s: dump until %f. starts", __FUNCTION__, TRACE_last_timestamp_to_dump);
  73   if (force){
  74     paje_event_t event;
  75     unsigned int i;
  76     xbt_dynar_foreach(buffer, i, event){
  77       event->print (event);
  78       event->free (event);
  79     }
  80     xbt_dynar_free (&buffer);
  81     buffer = xbt_dynar_new (sizeof(paje_event_t), NULL);
  82   }else{
  83     paje_event_t event;
  84     unsigned int cursor;
  85     xbt_dynar_foreach(buffer, cursor, event) {
  86       double head_timestamp = event->timestamp;
  87       if (head_timestamp > TRACE_last_timestamp_to_dump){
  88         break;
  89       }
  90       event->print (event);
  91       event->free (event);
  92     }
  93     xbt_dynar_remove_n_at(buffer, cursor, 0);
  94   }
  95   XBT_DEBUG("%s: ends", __FUNCTION__);
  96 }
  97
  98 /* internal do the instrumentation module */
  99 static void insert_into_buffer (paje_event_t tbi)
 100 {
 101   if (TRACE_buffer() == 0){
 102     tbi->print (tbi);
 103     tbi->free (tbi);
 104     return;
 105   }
 106
 107   XBT_DEBUG("%s: insert event_type=%d, timestamp=%f, buffersize=%lu)",
 108       __FUNCTION__, (int)tbi->event_type, tbi->timestamp, xbt_dynar_length(buffer));
 109
 110   unsigned int i;
 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)
 114       break;
 115   }
 116   xbt_dynar_insert_at(buffer, i, &tbi);
 117   if (i == 0)
 118     XBT_DEBUG("%s: inserted at beginning", __FUNCTION__);
 119   else
 120     XBT_DEBUG("%s: inserted at%s %u", __FUNCTION__, (i == xbt_dynar_length(buffer) - 1 ? " end, pos =" : ""), i);
 121 }
 122
 123 static void free_paje_event (paje_event_t event)
 124 {
 125   XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
 126   switch (event->event_type){
 127   case PAJE_StartLink:
 128     xbt_free (((startLink_t)(event->data))->value);
 129     xbt_free (((startLink_t)(event->data))->key);
 130     break;
 131   case PAJE_EndLink:
 132     xbt_free (((endLink_t)(event->data))->value);
 133     xbt_free (((endLink_t)(event->data))->key);
 134     break;
 135   default:
 136     break;
 137   }
 138   xbt_free (event->data);
 139   xbt_free (event);
 140 }
 141
 142 void new_pajeDefineContainerType(type_t type)
 143 {
 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;
 151
 152   XBT_DEBUG("%s: event_type=%d", __FUNCTION__, (int)event->event_type);
 153
 154   //print it
 155   event->print (event);
 156   event->free (event);
 157 }
 158
 159 void new_pajeDefineVariableType(type_t type)
 160 {
 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;
 168
 169   XBT_DEBUG("%s: event_type=%d", __FUNCTION__, (int)event->event_type);
 170
 171   //print it
 172   event->print (event);
 173   event->free (event);
 174 }
 175
 176 void new_pajeDefineStateType(type_t type)
 177 {
 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;
 185
 186   XBT_DEBUG("%s: event_type=%d", __FUNCTION__, (int)event->event_type);
 187
 188   //print it
 189   event->print (event);
 190   event->free (event);
 191 }
 192
 193 void new_pajeDefineEventType(type_t type)
 194 {
 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;
 202
 203   XBT_DEBUG("%s: event_type=%d", __FUNCTION__, (int)event->event_type);
 204
 205   //print it
 206   event->print (event);
 207   event->free (event);
 208 }
 209
 210 void new_pajeDefineLinkType(type_t type, type_t source, type_t dest)
 211 {
 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;
 221
 222   XBT_DEBUG("%s: event_type=%d", __FUNCTION__, (int)event->event_type);
 223
 224   //print it
 225   event->print (event);
 226   event->free (event);
 227 }
 228
 229 void new_pajeDefineEntityValue (val_t value)
 230 {
 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;
 238
 239   XBT_DEBUG("%s: event_type=%d", __FUNCTION__, (int)event->event_type);
 240
 241   //print it
 242   event->print (event);
 243   event->free (event);
 244 }
 245
 246 void new_pajeCreateContainer (container_t container)
 247 {
 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;
 255
 256   XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
 257
 258   //print it
 259   event->print (event);
 260   event->free (event);
 261 }
 262
 263 void new_pajeDestroyContainer (container_t container)
 264 {
 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;
 272
 273   XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
 274
 275   //print it
 276   event->print (event);
 277   event->free (event);
 278 }
 279
 280 void new_pajeSetVariable (double timestamp, container_t container, type_t type, double value)
 281 {
 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;
 291
 292   XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
 293
 294   insert_into_buffer (event);
 295 }
 296
 297
 298 void new_pajeAddVariable (double timestamp, container_t container, type_t type, double value)
 299 {
 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;
 309
 310   XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
 311
 312   insert_into_buffer (event);
 313 }
 314
 315 void new_pajeSubVariable (double timestamp, container_t container, type_t type, double value)
 316 {
 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;
 326
 327   XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
 328
 329   insert_into_buffer (event);
 330 }
 331
 332 void new_pajeSetState (double timestamp, container_t container, type_t type, val_t value)
 333 {
 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;
 343
 344   XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
 345
 346   insert_into_buffer (event);
 347 }
 348
 349
 350 void new_pajePushStateWithExtra (double timestamp, container_t container, type_t type, val_t value, void* extra)
 351 {
 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;
 362
 363   XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
 364
 365   insert_into_buffer (event);
 366 }
 367
 368
 369 void new_pajePushState (double timestamp, container_t container, type_t type, val_t value)
 370 {
 371   paje_event_t event = xbt_new0(s_paje_event_t, 1);
 372   event->event_type = PAJE_PushState;
 373   event->timestamp = timestamp;
 374   event->print = active_writer.print_PushState;
 375   event->free = free_paje_event;
 376   event->data = xbt_new0(s_pushState_t, 1);
 377   ((pushState_t)(event->data))->type = type;
 378   ((pushState_t)(event->data))->container = container;
 379   ((pushState_t)(event->data))->value = value;
 380   XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
 381
 382   insert_into_buffer (event);
 383 }
 384
 385 void new_pajePopState (double timestamp, container_t container, type_t type)
 386 {
 387   paje_event_t event = xbt_new0(s_paje_event_t, 1);
 388   event->event_type = PAJE_PopState;
 389   event->timestamp = timestamp;
 390   event->print = active_writer.print_PopState;
 391   event->free = free_paje_event;
 392   event->data = xbt_new0(s_popState_t, 1);
 393   ((popState_t)(event->data))->type = type;
 394   ((popState_t)(event->data))->container = container;
 395
 396   XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
 397
 398   insert_into_buffer (event);
 399 }
 400
 401
 402 void new_pajeResetState (double timestamp, container_t container, type_t type)
 403 {
 404   paje_event_t event = xbt_new0(s_paje_event_t, 1);
 405   event->event_type = PAJE_ResetState;
 406   event->timestamp = timestamp;
 407   event->print = active_writer.print_ResetState;
 408   event->free = free_paje_event;
 409   event->data = xbt_new0(s_resetState_t, 1);
 410   ((resetState_t)(event->data))->type = type;
 411   ((resetState_t)(event->data))->container = container;
 412
 413   XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
 414
 415   insert_into_buffer (event);
 416 }
 417
 418 void new_pajeStartLink (double timestamp, container_t container, type_t type, container_t sourceContainer,
 419                         const char *value, const char *key)
 420 {
 421   paje_event_t event = xbt_new0(s_paje_event_t, 1);
 422   event->event_type = PAJE_StartLink;
 423   event->timestamp = timestamp;
 424   event->print = active_writer.print_StartLink;
 425   event->free = free_paje_event;
 426   event->data = xbt_new0(s_startLink_t, 1);
 427   ((startLink_t)(event->data))->type = type;
 428   ((startLink_t)(event->data))->container = container;
 429   ((startLink_t)(event->data))->sourceContainer = sourceContainer;
 430   ((startLink_t)(event->data))->value = xbt_strdup(value);
 431   ((startLink_t)(event->data))->key = xbt_strdup(key);
 432   ((startLink_t)(event->data))->size = -1;
 433   XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
 434
 435   insert_into_buffer (event);
 436 }
 437
 438 void new_pajeStartLinkWithSize (double timestamp, container_t container, type_t type, container_t sourceContainer,
 439                                 const char *value, const char *key, int size)
 440 {
 441   paje_event_t event = xbt_new0(s_paje_event_t, 1);
 442   event->event_type = PAJE_StartLink;
 443   event->timestamp = timestamp;
 444   event->print = active_writer.print_StartLink;
 445   event->free = free_paje_event;
 446   event->data = xbt_new0(s_startLink_t, 1);
 447   ((startLink_t)(event->data))->type = type;
 448   ((startLink_t)(event->data))->container = container;
 449   ((startLink_t)(event->data))->sourceContainer = sourceContainer;
 450   ((startLink_t)(event->data))->value = xbt_strdup(value);
 451   ((startLink_t)(event->data))->key = xbt_strdup(key);
 452   ((startLink_t)(event->data))->size = size;
 453
 454   XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
 455
 456   insert_into_buffer (event);
 457 }
 458
 459 void new_pajeEndLink (double timestamp, container_t container, type_t type, container_t destContainer,
 460                       const char *value, const char *key)
 461 {
 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);
 473
 474   XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
 475
 476   insert_into_buffer (event);
 477 }
 478
 479 void new_pajeNewEvent (double timestamp, container_t container, type_t type, val_t value)
 480 {
 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;
 490
 491   XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
 492
 493   insert_into_buffer (event);
 494 }