lttv/lttv/sync/sync_chain_lttv.c

   1 /* This file is part of the Linux Trace Toolkit viewer
   2  * Copyright (C) 2009 Benjamin Poirier <benjamin.poirier@polymtl.ca>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License Version 2 as
   6  * published by the Free Software Foundation;
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program; if not, write to the Free Software
  15  * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  16  * MA 02111-1307, USA.
  17  */
  18
  19 #ifdef HAVE_CONFIG_H
  20 #include <config.h>
  21 #endif
  22
  23 #include <errno.h>
  24 #include <fcntl.h>
  25 #include <stdio.h>
  26 #include <stdlib.h>
  27 #include <sys/resource.h>
  28 #include <sys/stat.h>
  29 #include <sys/types.h>
  30 #include <sys/stat.h>
  31 #include <unistd.h>
  32
  33 #include <lttv/module.h>
  34 #include <lttv/option.h>
  35
  36 #include "sync_chain.h"
  37
  38
  39 #ifndef g_info
  40 #define g_info(format...) g_log (G_LOG_DOMAIN, G_LOG_LEVEL_INFO, format)
  41 #endif
  42
  43
  44 static void init();
  45 static void destroy();
  46
  47 static void gfAppendAnalysisName(gpointer data, gpointer user_data);
  48 static void gfAddModuleOption(gpointer data, gpointer user_data);
  49 static void gfRemoveModuleOption(gpointer data, gpointer user_data);
  50
  51 GQueue processingModules= G_QUEUE_INIT;
  52 GQueue matchingModules= G_QUEUE_INIT;
  53 GQueue analysisModules= G_QUEUE_INIT;
  54 GQueue moduleOptions= G_QUEUE_INIT;
  55
  56 static char* argHelpNone= "none";
  57 static ModuleOption optionSync= {
  58         .longName= "sync",
  59         .hasArg= NO_ARG,
  60         {.present= false},
  61         .optionHelp= "synchronize the time between the traces",
  62 };
  63 static char graphsDir[20];
  64 static ModuleOption optionSyncStats= {
  65         .longName= "sync-stats",
  66         .hasArg= NO_ARG,
  67         {.present= false},
  68         .optionHelp= "print statistics about the time synchronization",
  69 };
  70 static ModuleOption optionSyncNull= {
  71         .longName= "sync-null",
  72         .hasArg= NO_ARG,
  73         {.present= false},
  74         .optionHelp= "read the events but do not perform any processing",
  75 };
  76 static GString* analysisModulesNames;
  77 static ModuleOption optionSyncAnalysis= {
  78         .longName= "sync-analysis",
  79         .hasArg= REQUIRED_ARG,
  80         .optionHelp= "specify the algorithm to use for event analysis",
  81 };
  82 static ModuleOption optionSyncGraphs= {
  83         .longName= "sync-graphs",
  84         .hasArg= NO_ARG,
  85         {.present= false},
  86         .optionHelp= "output gnuplot graph showing synchronization points",
  87 };
  88 static ModuleOption optionSyncGraphsDir= {
  89         .longName= "sync-graphs-dir",
  90         .hasArg= REQUIRED_ARG,
  91         .optionHelp= "specify the directory where to store the graphs",
  92 };
  93
  94 /*
  95  * Module init function
  96  *
  97  * This function is declared to be the module initialization function. Event
  98  * modules are registered with a "constructor (102)" attribute except one in
  99  * each class (processing, matching, analysis) which is chosen to be the
 100  * default and which is registered with a "constructor (101)" attribute.
 101  * Constructors with no priority are called after constructors with
 102  * priorities. The result is that the list of event modules is known when this
 103  * function is executed.
 104  */
 105 static void init()
 106 {
 107         int retval;
 108
 109         g_debug("\t\t\tXXXX sync init\n");
 110
 111         g_assert(g_queue_get_length(&analysisModules) > 0);
 112         optionSyncAnalysis.arg = ((AnalysisModule*)
 113                 g_queue_peek_head(&analysisModules))->name;
 114         analysisModulesNames= g_string_new("");
 115         g_queue_foreach(&analysisModules, &gfAppendAnalysisName,
 116                 analysisModulesNames);
 117         // remove the last ", "
 118         g_string_truncate(analysisModulesNames, analysisModulesNames->len - 2);
 119         optionSyncAnalysis.argHelp= analysisModulesNames->str;
 120
 121         retval= snprintf(graphsDir, sizeof(graphsDir), "graphs-%d", getpid());
 122         if (retval > sizeof(graphsDir) - 1)
 123         {
 124                 graphsDir[sizeof(graphsDir) - 1]= '\0';
 125         }
 126         optionSyncGraphsDir.arg= graphsDir;
 127         optionSyncGraphsDir.argHelp= graphsDir;
 128
 129         g_queue_push_head(&moduleOptions, &optionSyncGraphsDir);
 130         g_queue_push_head(&moduleOptions, &optionSyncGraphs);
 131         g_queue_push_head(&moduleOptions, &optionSyncAnalysis);
 132         g_queue_push_head(&moduleOptions, &optionSyncNull);
 133         g_queue_push_head(&moduleOptions, &optionSyncStats);
 134         g_queue_push_head(&moduleOptions, &optionSync);
 135
 136         g_queue_foreach(&moduleOptions, &gfAddModuleOption, NULL);
 137
 138 }
 139
 140
 141 /*
 142  * Module unload function
 143  */
 144 static void destroy()
 145 {
 146         g_debug("\t\t\tXXXX sync destroy\n");
 147
 148         g_queue_foreach(&moduleOptions, &gfRemoveModuleOption, NULL);
 149         g_string_free(analysisModulesNames, TRUE);
 150
 151         g_queue_clear(&processingModules);
 152         g_queue_clear(&matchingModules);
 153         g_queue_clear(&analysisModules);
 154         g_queue_clear(&moduleOptions);
 155 }
 156
 157
 158 /*
 159  * Calculate a traceset's drift and offset values based on network events
 160  *
 161  * The individual correction factors are written out to each trace.
 162  *
 163  * Args:
 164  *   traceSetContext: traceset
 165  */
 166 void syncTraceset(LttvTracesetContext* const traceSetContext)
 167 {
 168         SyncState* syncState;
 169         struct timeval startTime, endTime;
 170         struct rusage startUsage, endUsage;
 171         GList* result;
 172         unsigned int i;
 173         int retval;
 174
 175         if (!optionSync.present)
 176         {
 177                 g_debug("Not synchronizing traceset because option is disabled");
 178                 return;
 179         }
 180
 181         if (optionSyncStats.present)
 182         {
 183                 gettimeofday(&startTime, 0);
 184                 getrusage(RUSAGE_SELF, &startUsage);
 185         }
 186
 187         // Initialize data structures
 188         syncState= malloc(sizeof(SyncState));
 189         syncState->traceNb= lttv_traceset_number(traceSetContext->ts);
 190
 191         if (optionSyncStats.present)
 192         {
 193                 syncState->stats= true;
 194         }
 195         else
 196         {
 197                 syncState->stats= false;
 198         }
 199
 200         if (optionSyncGraphs.present)
 201         {
 202                 char* cwd;
 203                 int graphsFp;
 204
 205                 // Create the graph directory right away in case the module initialization
 206                 // functions have something to write in it.
 207                 syncState->graphsDir= optionSyncGraphsDir.arg;
 208                 cwd= changeToGraphDir(optionSyncGraphsDir.arg);
 209
 210                 if ((graphsFp= open("graphs.gnu", O_WRONLY | O_CREAT | O_TRUNC, S_IRUSR |
 211                                 S_IWUSR | S_IXUSR | S_IRGRP | S_IWGRP | S_IXGRP | S_IROTH
 212                                 | S_IWOTH | S_IXOTH)) == -1)
 213                 {
 214                         g_error(strerror(errno));
 215                 }
 216                 if ((syncState->graphsStream= fdopen(graphsFp, "w")) == NULL)
 217                 {
 218                         g_error(strerror(errno));
 219                 }
 220
 221                 fprintf(syncState->graphsStream,
 222                         "#!/usr/bin/gnuplot\n\n"
 223                         "set terminal postscript eps color size 8in,6in\n\n");
 224
 225                 retval= chdir(cwd);
 226                 if (retval == -1)
 227                 {
 228                         g_error(strerror(errno));
 229                 }
 230                 free(cwd);
 231         }
 232         else
 233         {
 234                 syncState->graphsStream= NULL;
 235                 syncState->graphsDir= NULL;
 236         }
 237
 238         // Identify and initialize modules
 239         syncState->processingData= NULL;
 240         if (optionSyncNull.present)
 241         {
 242                 result= g_queue_find_custom(&processingModules, "LTTV-null",
 243                         &gcfCompareProcessing);
 244         }
 245         else
 246         {
 247                 result= g_queue_find_custom(&processingModules, "LTTV-standard",
 248                         &gcfCompareProcessing);
 249         }
 250         g_assert(result != NULL);
 251         syncState->processingModule= (ProcessingModule*) result->data;
 252
 253         syncState->matchingData= NULL;
 254         result= g_queue_find_custom(&matchingModules, "TCP", &gcfCompareMatching);
 255         g_assert(result != NULL);
 256         syncState->matchingModule= (MatchingModule*) result->data;
 257
 258         syncState->analysisData= NULL;
 259         result= g_queue_find_custom(&analysisModules, optionSyncAnalysis.arg,
 260                 &gcfCompareAnalysis);
 261         if (result != NULL)
 262         {
 263                 syncState->analysisModule= (AnalysisModule*) result->data;
 264         }
 265         else
 266         {
 267                 g_error("Analysis module '%s' not found", optionSyncAnalysis.arg);
 268         }
 269
 270         if (!optionSyncNull.present)
 271         {
 272                 syncState->analysisModule->initAnalysis(syncState);
 273                 syncState->matchingModule->initMatching(syncState);
 274         }
 275         syncState->processingModule->initProcessing(syncState, traceSetContext);
 276
 277         // Process traceset
 278         lttv_process_traceset_seek_time(traceSetContext, ltt_time_zero);
 279         lttv_process_traceset_middle(traceSetContext, ltt_time_infinite,
 280                 G_MAXULONG, NULL);
 281         lttv_process_traceset_seek_time(traceSetContext, ltt_time_zero);
 282
 283         syncState->processingModule->finalizeProcessing(syncState);
 284
 285         // Write graphs file
 286         if (optionSyncGraphs.present)
 287         {
 288                 writeGraphsScript(syncState);
 289
 290                 if (fclose(syncState->graphsStream) != 0)
 291                 {
 292                         g_error(strerror(errno));
 293                 }
 294         }
 295
 296         if (syncState->processingModule->printProcessingStats != NULL)
 297         {
 298                 syncState->processingModule->printProcessingStats(syncState);
 299         }
 300         if (syncState->matchingModule->printMatchingStats != NULL)
 301         {
 302                 syncState->matchingModule->printMatchingStats(syncState);
 303         }
 304         if (syncState->analysisModule->printAnalysisStats != NULL)
 305         {
 306                 syncState->analysisModule->printAnalysisStats(syncState);
 307         }
 308
 309         if (optionSyncStats.present)
 310         {
 311                 printf("Resulting synchronization factors:\n");
 312                 for (i= 0; i < syncState->traceNb; i++)
 313                 {
 314                         LttTrace* t;
 315
 316                         t= traceSetContext->traces[i]->t;
 317
 318                         printf("\ttrace %u drift= %g offset= %g (%f) start time= %ld.%09ld\n",
 319                                 i, t->drift, t->offset, (double) tsc_to_uint64(t->freq_scale,
 320                                         t->start_freq, t->offset) / NANOSECONDS_PER_SECOND,
 321                                 t->start_time_from_tsc.tv_sec,
 322                                 t->start_time_from_tsc.tv_nsec);
 323                 }
 324         }
 325
 326         syncState->processingModule->destroyProcessing(syncState);
 327         if (syncState->matchingModule != NULL)
 328         {
 329                 syncState->matchingModule->destroyMatching(syncState);
 330         }
 331         if (syncState->analysisModule != NULL)
 332         {
 333                 syncState->analysisModule->destroyAnalysis(syncState);
 334         }
 335
 336         free(syncState);
 337
 338         if (optionSyncStats.present)
 339         {
 340                 gettimeofday(&endTime, 0);
 341                 retval= getrusage(RUSAGE_SELF, &endUsage);
 342
 343                 timeDiff(&endTime, &startTime);
 344                 timeDiff(&endUsage.ru_utime, &startUsage.ru_utime);
 345                 timeDiff(&endUsage.ru_stime, &startUsage.ru_stime);
 346
 347                 printf("Synchronization time:\n");
 348                 printf("\treal time: %ld.%06ld\n", endTime.tv_sec, endTime.tv_usec);
 349                 printf("\tuser time: %ld.%06ld\n", endUsage.ru_utime.tv_sec,
 350                         endUsage.ru_utime.tv_usec);
 351                 printf("\tsystem time: %ld.%06ld\n", endUsage.ru_stime.tv_sec,
 352                         endUsage.ru_stime.tv_usec);
 353         }
 354 }
 355
 356
 357 /*
 358  * Calculate the elapsed time between two timeval values
 359  *
 360  * Args:
 361  *   end:          end time, result is also stored in this structure
 362  *   start:        start time
 363  */
 364 void timeDiff(struct timeval* const end, const struct timeval* const start)
 365 {
 366                 if (end->tv_usec >= start->tv_usec)
 367                 {
 368                         end->tv_sec-= start->tv_sec;
 369                         end->tv_usec-= start->tv_usec;
 370                 }
 371                 else
 372                 {
 373                         end->tv_sec= end->tv_sec - start->tv_sec - 1;
 374                         end->tv_usec= end->tv_usec - start->tv_usec + 1e6;
 375                 }
 376 }
 377
 378
 379 /*
 380  * A GCompareFunc for g_slist_find_custom()
 381  *
 382  * Args:
 383  *   a:            ProcessingModule*, element's data
 384  *   b:            char*, user data to compare against
 385  *
 386  * Returns:
 387  *   0 if the processing module a's name is b
 388  */
 389 gint gcfCompareProcessing(gconstpointer a, gconstpointer b)
 390 {
 391         const ProcessingModule* processingModule;
 392         const char* name;
 393
 394         processingModule= (const ProcessingModule*) a;
 395         name= (const char*) b;
 396
 397         return strncmp(processingModule->name, name,
 398                 strlen(processingModule->name) + 1);
 399 }
 400
 401
 402 /*
 403  * A GCompareFunc for g_slist_find_custom()
 404  *
 405  * Args:
 406  *   a:            MatchingModule*, element's data
 407  *   b:            char*, user data to compare against
 408  *
 409  * Returns:
 410  *   0 if the matching module a's name is b
 411  */
 412 gint gcfCompareMatching(gconstpointer a, gconstpointer b)
 413 {
 414         const MatchingModule* matchingModule;
 415         const char* name;
 416
 417         matchingModule= (const MatchingModule*) a;
 418         name= (const char*) b;
 419
 420         return strncmp(matchingModule->name, name, strlen(matchingModule->name) +
 421                 1);
 422 }
 423
 424
 425 /*
 426  * A GCompareFunc for g_slist_find_custom()
 427  *
 428  * Args:
 429  *   a:            AnalysisModule*, element's data
 430  *   b:            char*, user data to compare against
 431  *
 432  * Returns:
 433  *   0 if the analysis module a's name is b
 434  */
 435 gint gcfCompareAnalysis(gconstpointer a, gconstpointer b)
 436 {
 437         const AnalysisModule* analysisModule;
 438         const char* name;
 439
 440         analysisModule= (const AnalysisModule*) a;
 441         name= (const char*) b;
 442
 443         return strncmp(analysisModule->name, name, strlen(analysisModule->name) +
 444                 1);
 445 }
 446
 447
 448 /*
 449  * A GFunc for g_queue_foreach()
 450  *
 451  * Concatenate analysis module names.
 452  *
 453  * Args:
 454  *   data:         AnalysisModule*
 455  *   user_data:    GString*, concatenated names
 456  */
 457 static void gfAppendAnalysisName(gpointer data, gpointer user_data)
 458 {
 459         g_string_append((GString*) user_data, ((AnalysisModule*) data)->name);
 460         g_string_append((GString*) user_data, ", ");
 461 }
 462
 463
 464 /*
 465  * Change to the directory used to hold graphs. Create it if necessary.
 466  *
 467  * Args:
 468  *   graph:        name of directory
 469  *
 470  * Returns:
 471  *   The current working directory before the execution of the function. The
 472  *   string must be free'd by the caller.
 473  */
 474 char* changeToGraphDir(const char* const graphs)
 475 {
 476         int retval;
 477         char* cwd;
 478
 479         cwd= getcwd(NULL, 0);
 480         if (cwd == NULL)
 481         {
 482                 g_error(strerror(errno));
 483         }
 484         while ((retval= chdir(graphs)) != 0)
 485         {
 486                 if (errno == ENOENT)
 487                 {
 488                         retval= mkdir(graphs, S_IRUSR | S_IWUSR | S_IXUSR | S_IRGRP |
 489                                 S_IWGRP | S_IXGRP | S_IROTH | S_IWOTH | S_IXOTH);
 490                         if (retval != 0)
 491                         {
 492                                 g_error(strerror(errno));
 493                         }
 494                 }
 495                 else
 496                 {
 497                         g_error(strerror(errno));
 498                 }
 499         }
 500
 501         return cwd;
 502 }
 503
 504
 505 /*
 506  * A GFunc for g_queue_foreach()
 507  *
 508  * Args:
 509  *   data:         ModuleOption*
 510  *   user_data:    NULL
 511  */
 512 static void gfAddModuleOption(gpointer data, gpointer user_data)
 513 {
 514         ModuleOption* option;
 515         LttvOptionType conversion[]= {
 516                 [NO_ARG]= LTTV_OPT_NONE,
 517                 [REQUIRED_ARG]= LTTV_OPT_STRING,
 518         };
 519
 520         g_assert_cmpuint(sizeof(conversion) / sizeof(*conversion), ==,
 521                 HAS_ARG_COUNT);
 522         option= (ModuleOption*) data;
 523         lttv_option_add(option->longName, '\0', option->optionHelp,
 524                 option->argHelp ? option->argHelp : argHelpNone,
 525                 conversion[option->hasArg], &option->arg, NULL, NULL);
 526 }
 527
 528
 529 /*
 530  * A GFunc for g_queue_foreach()
 531  *
 532  * Args:
 533  *   data:         ModuleOption*
 534  *   user_data:    NULL
 535  */
 536 static void gfRemoveModuleOption(gpointer data, gpointer user_data)
 537 {
 538         lttv_option_remove(((ModuleOption*) data)->longName);
 539 }
 540
 541
 542 LTTV_MODULE("sync", "Synchronize traces", \
 543         "Synchronizes a traceset based on the correspondance of network events", \
 544         init, destroy, "option")