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 "src/instr/instr_smpi.h"
   9 #include "src/smpi/private.hpp"
  10 #include "xbt/virtu.h" /* sg_cmdline */
  11
  12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(instr_trace, instr, "tracing event system");
  13
  14 FILE *tracing_file = nullptr;
  15
  16 void print_NULL(paje_event_t event){}
  17
  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 */
  20
  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
  27 };
  28
  29 std::vector<paje_event_t> buffer;
  30
  31 void dump_comment (const char *comment)
  32 {
  33   if (!strlen(comment)) return;
  34   fprintf (tracing_file, "# %s\n", comment);
  35 }
  36
  37 void dump_comment_file (const char *filename)
  38 {
  39   if (!strlen(filename)) return;
  40   FILE *file = fopen (filename, "r");
  41   if (!file){
  42     THROWF (system_error, 1, "Comment file %s could not be opened for reading.", filename);
  43   }
  44   while (!feof(file)){
  45     char c;
  46     c = fgetc(file);
  47     if (feof(file)) break;
  48     fprintf (tracing_file, "# ");
  49     while (c != '\n'){
  50       fprintf (tracing_file, "%c", c);
  51       c = fgetc(file);
  52       if (feof(file)) break;
  53     }
  54     fprintf (tracing_file, "\n");
  55   }
  56   fclose(file);
  57 }
  58
  59 double TRACE_last_timestamp_to_dump = 0;
  60 //dumps the trace file until the timestamp TRACE_last_timestamp_to_dump
  61 void TRACE_paje_dump_buffer (int force)
  62 {
  63   if (!TRACE_is_enabled()) return;
  64   XBT_DEBUG("%s: dump until %f. starts", __FUNCTION__, TRACE_last_timestamp_to_dump);
  65   if (force){
  66     for (auto event :buffer){
  67       event->print (event);
  68       event->free (event);
  69     }
  70     buffer.clear();
  71   }else{
  72     std::vector<paje_event_t>::iterator i = buffer.begin();
  73     for (auto event :buffer){
  74       double head_timestamp = event->timestamp;
  75       if (head_timestamp > TRACE_last_timestamp_to_dump)
  76         break;
  77       event->print (event);
  78       event->free (event);
  79       ++i;
  80     }
  81     buffer.erase(buffer.begin(), i);
  82   }
  83   XBT_DEBUG("%s: ends", __FUNCTION__);
  84 }
  85
  86 /* internal do the instrumentation module */
  87 static void insert_into_buffer (paje_event_t tbi)
  88 {
  89   if (TRACE_buffer() == 0){
  90     tbi->print (tbi);
  91     tbi->free (tbi);
  92     return;
  93   }
  94
  95   XBT_DEBUG("%s: insert event_type=%d, timestamp=%f, buffersize=%zu)",
  96       __FUNCTION__, (int)tbi->event_type, tbi->timestamp, buffer.size());
  97   std::vector<paje_event_t>::reverse_iterator i;
  98   for (i = buffer.rbegin(); i != buffer.rend(); ++i) {
  99     paje_event_t e1 = *i;
 100     if (e1->timestamp <= tbi->timestamp)
 101       break;
 102   }
 103   buffer.insert(i.base(), tbi);
 104   if (i == buffer.rend())
 105     XBT_DEBUG("%s: inserted at beginning", __FUNCTION__);
 106   else
 107     XBT_DEBUG("%s: inserted at%s %zd", __FUNCTION__, (i == buffer.rbegin()) ? " end" :"pos =",
 108         std::distance(buffer.rend(),i));
 109 }
 110
 111 static void free_paje_event (paje_event_t event)
 112 {
 113   XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
 114   switch (event->event_type){
 115   case PAJE_StartLink:
 116     xbt_free (((startLink_t)(event->data))->value);
 117     xbt_free (((startLink_t)(event->data))->key);
 118     break;
 119   case PAJE_EndLink:
 120     xbt_free (((endLink_t)(event->data))->value);
 121     xbt_free (((endLink_t)(event->data))->key);
 122     break;
 123   default:
 124     break;
 125   }
 126   xbt_free (event->data);
 127   xbt_free (event);
 128 }
 129
 130 void new_pajeDefineContainerType(type_t type)
 131 {
 132   paje_event_t event = xbt_new0(s_paje_event_t, 1);
 133   event->event_type = PAJE_DefineContainerType;
 134   event->timestamp = 0;
 135   event->print = active_writer.print_DefineContainerType;
 136   event->free = free_paje_event;
 137   event->data = xbt_new0(s_defineContainerType_t, 1);
 138   ((defineContainerType_t)(event->data))->type = type;
 139
 140   XBT_DEBUG("%s: event_type=%d", __FUNCTION__, (int)event->event_type);
 141
 142   //print it
 143   event->print (event);
 144   event->free (event);
 145 }
 146
 147 void new_pajeDefineVariableType(type_t type)
 148 {
 149   paje_event_t event = xbt_new0(s_paje_event_t, 1);
 150   event->event_type = PAJE_DefineVariableType;
 151   event->timestamp = 0;
 152   event->print = active_writer.print_DefineVariableType;
 153   event->free = free_paje_event;
 154   event->data = xbt_new0(s_defineVariableType_t, 1);
 155   ((defineVariableType_t)(event->data))->type = type;
 156
 157   XBT_DEBUG("%s: event_type=%d", __FUNCTION__, (int)event->event_type);
 158
 159   //print it
 160   event->print (event);
 161   event->free (event);
 162 }
 163
 164 void new_pajeDefineStateType(type_t type)
 165 {
 166   paje_event_t event = xbt_new0(s_paje_event_t, 1);
 167   event->event_type = PAJE_DefineStateType;
 168   event->timestamp = 0;
 169   event->print = active_writer.print_DefineStateType;
 170   event->free = free_paje_event;
 171   event->data = xbt_new0(s_defineStateType_t, 1);
 172   ((defineStateType_t)(event->data))->type = type;
 173
 174   XBT_DEBUG("%s: event_type=%d", __FUNCTION__, (int)event->event_type);
 175
 176   //print it
 177   event->print (event);
 178   event->free (event);
 179 }
 180
 181 void new_pajeDefineEventType(type_t type)
 182 {
 183   paje_event_t event = xbt_new0(s_paje_event_t, 1);
 184   event->event_type = PAJE_DefineEventType;
 185   event->timestamp = 0;
 186   event->print = active_writer.print_DefineEventType;
 187   event->free = free_paje_event;
 188   event->data = xbt_new0(s_defineEventType_t, 1);
 189   ((defineEventType_t)(event->data))->type = type;
 190
 191   XBT_DEBUG("%s: event_type=%d", __FUNCTION__, (int)event->event_type);
 192
 193   //print it
 194   event->print (event);
 195   event->free (event);
 196 }
 197
 198 void new_pajeDefineLinkType(type_t type, type_t source, type_t dest)
 199 {
 200   paje_event_t event = xbt_new0(s_paje_event_t, 1);
 201   event->event_type = PAJE_DefineLinkType;
 202   event->timestamp = 0;
 203   event->print = active_writer.print_DefineLinkType;
 204   event->free = free_paje_event;
 205   event->data = xbt_new0(s_defineLinkType_t, 1);
 206   ((defineLinkType_t)(event->data))->type = type;
 207   ((defineLinkType_t)(event->data))->source = source;
 208   ((defineLinkType_t)(event->data))->dest = dest;
 209
 210   XBT_DEBUG("%s: event_type=%d", __FUNCTION__, (int)event->event_type);
 211
 212   //print it
 213   event->print (event);
 214   event->free (event);
 215 }
 216
 217 void new_pajeDefineEntityValue (val_t value)
 218 {
 219   paje_event_t event = xbt_new0(s_paje_event_t, 1);
 220   event->event_type = PAJE_DefineEntityValue;
 221   event->timestamp = 0;
 222   event->print = active_writer.print_DefineEntityValue;
 223   event->free = free_paje_event;
 224   event->data = xbt_new0(s_defineEntityValue_t, 1);
 225   ((defineEntityValue_t)(event->data))->value = value;
 226
 227   XBT_DEBUG("%s: event_type=%d", __FUNCTION__, (int)event->event_type);
 228
 229   //print it
 230   event->print (event);
 231   event->free (event);
 232 }
 233
 234 void new_pajeCreateContainer (container_t container)
 235 {
 236   paje_event_t event = xbt_new0(s_paje_event_t, 1);
 237   event->event_type = PAJE_CreateContainer;
 238   event->timestamp = SIMIX_get_clock();
 239   event->print = active_writer.print_CreateContainer;
 240   event->free = free_paje_event;
 241   event->data = xbt_new0(s_createContainer_t, 1);
 242   ((createContainer_t)(event->data))->container = container;
 243
 244   XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
 245
 246   //print it
 247   event->print (event);
 248   event->free (event);
 249 }
 250
 251 void new_pajeDestroyContainer (container_t container)
 252 {
 253   paje_event_t event = xbt_new0(s_paje_event_t, 1);
 254   event->event_type = PAJE_DestroyContainer;
 255   event->timestamp = SIMIX_get_clock();
 256   event->print = active_writer.print_DestroyContainer;
 257   event->free = free_paje_event;
 258   event->data = xbt_new0(s_destroyContainer_t, 1);
 259   ((destroyContainer_t)(event->data))->container = container;
 260
 261   XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
 262
 263   //print it
 264   event->print (event);
 265   event->free (event);
 266 }
 267
 268 void new_pajeSetVariable (double timestamp, container_t container, type_t type, double value)
 269 {
 270   paje_event_t event = xbt_new0(s_paje_event_t, 1);
 271   event->event_type = PAJE_SetVariable;
 272   event->timestamp = timestamp;
 273   event->print = active_writer.print_SetVariable;
 274   event->free = free_paje_event;
 275   event->data = xbt_new0(s_setVariable_t, 1);
 276   ((setVariable_t)(event->data))->type = type;
 277   ((setVariable_t)(event->data))->container = container;
 278   ((setVariable_t)(event->data))->value = value;
 279
 280   XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
 281
 282   insert_into_buffer (event);
 283 }
 284
 285
 286 void new_pajeAddVariable (double timestamp, container_t container, type_t type, double value)
 287 {
 288   paje_event_t event = xbt_new0(s_paje_event_t, 1);
 289   event->event_type = PAJE_AddVariable;
 290   event->timestamp = timestamp;
 291   event->print = active_writer.print_AddVariable;
 292   event->free = free_paje_event;
 293   event->data = xbt_new0(s_addVariable_t, 1);
 294   ((addVariable_t)(event->data))->type = type;
 295   ((addVariable_t)(event->data))->container = container;
 296   ((addVariable_t)(event->data))->value = value;
 297
 298   XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
 299
 300   insert_into_buffer (event);
 301 }
 302
 303 void new_pajeSubVariable (double timestamp, container_t container, type_t type, double value)
 304 {
 305   paje_event_t event = xbt_new0(s_paje_event_t, 1);
 306   event->event_type = PAJE_SubVariable;
 307   event->timestamp = timestamp;
 308   event->print = active_writer.print_SubVariable;
 309   event->free = free_paje_event;
 310   event->data = xbt_new0(s_subVariable_t, 1);
 311   ((subVariable_t)(event->data))->type = type;
 312   ((subVariable_t)(event->data))->container = container;
 313   ((subVariable_t)(event->data))->value = value;
 314
 315   XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
 316
 317   insert_into_buffer (event);
 318 }
 319
 320 void new_pajeSetState (double timestamp, container_t container, type_t type, val_t value)
 321 {
 322   paje_event_t event = xbt_new0(s_paje_event_t, 1);
 323   event->event_type = PAJE_SetState;
 324   event->timestamp = timestamp;
 325   event->print = active_writer.print_SetState;
 326   event->free = free_paje_event;
 327   event->data = xbt_new0(s_setState_t, 1);
 328   ((setState_t)(event->data))->type = type;
 329   ((setState_t)(event->data))->container = container;
 330   ((setState_t)(event->data))->value = value;
 331
 332 #if HAVE_SMPI
 333   if (xbt_cfg_get_boolean("smpi/trace-call-location")) {
 334     smpi_trace_call_location_t* loc = smpi_trace_get_call_location();
 335     ((setState_t)(event->data))->filename   = loc->filename;
 336     ((setState_t)(event->data))->linenumber = loc->linenumber;
 337   }
 338 #endif
 339
 340   XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
 341
 342   insert_into_buffer (event);
 343 }
 344
 345
 346 void new_pajePushStateWithExtra (double timestamp, container_t container, type_t type, val_t value, void* extra)
 347 {
 348   paje_event_t event = xbt_new0(s_paje_event_t, 1);
 349   event->event_type = PAJE_PushState;
 350   event->timestamp = timestamp;
 351   event->print = active_writer.print_PushState;
 352   event->free = free_paje_event;
 353   event->data = xbt_new0(s_pushState_t, 1);
 354   ((pushState_t)(event->data))->type = type;
 355   ((pushState_t)(event->data))->container = container;
 356   ((pushState_t)(event->data))->value = value;
 357   ((pushState_t)(event->data))->extra = extra;
 358
 359 #if HAVE_SMPI
 360   if (xbt_cfg_get_boolean("smpi/trace-call-location")) {
 361     smpi_trace_call_location_t* loc = smpi_trace_get_call_location();
 362     ((pushState_t)(event->data))->filename   = loc->filename;
 363     ((pushState_t)(event->data))->linenumber = loc->linenumber;
 364   }
 365 #endif
 366
 367   XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
 368
 369   insert_into_buffer (event);
 370 }
 371
 372
 373 void new_pajePushState (double timestamp, container_t container, type_t type, val_t value)
 374 {
 375   new_pajePushStateWithExtra(timestamp, container, type, value, nullptr);
 376 }
 377
 378 void new_pajePopState (double timestamp, container_t container, type_t type)
 379 {
 380   paje_event_t event = xbt_new0(s_paje_event_t, 1);
 381   event->event_type = PAJE_PopState;
 382   event->timestamp = timestamp;
 383   event->print = active_writer.print_PopState;
 384   event->free = free_paje_event;
 385   event->data = xbt_new0(s_popState_t, 1);
 386   ((popState_t)(event->data))->type = type;
 387   ((popState_t)(event->data))->container = container;
 388
 389   XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
 390
 391   insert_into_buffer (event);
 392 }
 393
 394
 395 void new_pajeResetState (double timestamp, container_t container, type_t type)
 396 {
 397   paje_event_t event = xbt_new0(s_paje_event_t, 1);
 398   event->event_type = PAJE_ResetState;
 399   event->timestamp = timestamp;
 400   event->print = active_writer.print_ResetState;
 401   event->free = free_paje_event;
 402   event->data = xbt_new0(s_resetState_t, 1);
 403   ((resetState_t)(event->data))->type = type;
 404   ((resetState_t)(event->data))->container = container;
 405
 406   XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
 407
 408   insert_into_buffer (event);
 409 }
 410
 411 void new_pajeStartLink (double timestamp, container_t container, type_t type, container_t sourceContainer,
 412                         const char *value, const char *key)
 413 {
 414   paje_event_t event = xbt_new0(s_paje_event_t, 1);
 415   event->event_type = PAJE_StartLink;
 416   event->timestamp = timestamp;
 417   event->print = active_writer.print_StartLink;
 418   event->free = free_paje_event;
 419   event->data = xbt_new0(s_startLink_t, 1);
 420   ((startLink_t)(event->data))->type = type;
 421   ((startLink_t)(event->data))->container = container;
 422   ((startLink_t)(event->data))->sourceContainer = sourceContainer;
 423   ((startLink_t)(event->data))->value = xbt_strdup(value);
 424   ((startLink_t)(event->data))->key = xbt_strdup(key);
 425   ((startLink_t)(event->data))->size = -1;
 426   XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
 427
 428   insert_into_buffer (event);
 429 }
 430
 431 void new_pajeStartLinkWithSize (double timestamp, container_t container, type_t type, container_t sourceContainer,
 432                                 const char *value, const char *key, int size)
 433 {
 434   paje_event_t event = xbt_new0(s_paje_event_t, 1);
 435   event->event_type = PAJE_StartLink;
 436   event->timestamp = timestamp;
 437   event->print = active_writer.print_StartLink;
 438   event->free = free_paje_event;
 439   event->data = xbt_new0(s_startLink_t, 1);
 440   ((startLink_t)(event->data))->type = type;
 441   ((startLink_t)(event->data))->container = container;
 442   ((startLink_t)(event->data))->sourceContainer = sourceContainer;
 443   ((startLink_t)(event->data))->value = xbt_strdup(value);
 444   ((startLink_t)(event->data))->key = xbt_strdup(key);
 445   ((startLink_t)(event->data))->size = size;
 446
 447   XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
 448
 449   insert_into_buffer (event);
 450 }
 451
 452 void new_pajeEndLink (double timestamp, container_t container, type_t type, container_t destContainer,
 453                       const char *value, const char *key)
 454 {
 455   paje_event_t event = xbt_new0(s_paje_event_t, 1);
 456   event->event_type = PAJE_EndLink;
 457   event->timestamp = timestamp;
 458   event->print = active_writer.print_EndLink;
 459   event->free = free_paje_event;
 460   event->data = xbt_new0(s_endLink_t, 1);
 461   ((endLink_t)(event->data))->type = type;
 462   ((endLink_t)(event->data))->container = container;
 463   ((endLink_t)(event->data))->destContainer = destContainer;
 464   ((endLink_t)(event->data))->value = xbt_strdup(value);
 465   ((endLink_t)(event->data))->key = xbt_strdup(key);
 466
 467   XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
 468
 469   insert_into_buffer (event);
 470 }
 471
 472 void new_pajeNewEvent (double timestamp, container_t container, type_t type, val_t value)
 473 {
 474   paje_event_t event = xbt_new0(s_paje_event_t, 1);
 475   event->event_type = PAJE_NewEvent;
 476   event->timestamp = timestamp;
 477   event->print = active_writer.print_NewEvent;
 478   event->free = free_paje_event;
 479   event->data = xbt_new0(s_newEvent_t, 1);
 480   ((newEvent_t)(event->data))->type = type;
 481   ((newEvent_t)(event->data))->container = container;
 482   ((newEvent_t)(event->data))->value = value;
 483
 484   XBT_DEBUG("%s: event_type=%d, timestamp=%f", __FUNCTION__, (int)event->event_type, event->timestamp);
 485
 486   insert_into_buffer (event);
 487 }