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