Make option type OPTIONAL_ARG available
[lttv.git] / lttv / lttv / sync / sync_chain_lttv.c
index 2479512fed5ddb083ef170fabda3b154f56199d7..bbd2b3aacb9b9d70b65f363722b15bfc40687406 100644 (file)
@@ -26,7 +26,6 @@
 #include <stdlib.h>
 #include <sys/resource.h>
 #include <sys/stat.h>
-#include <sys/time.h>
 #include <sys/types.h>
 #include <sys/stat.h>
 #include <unistd.h>
 #include <lttv/module.h>
 #include <lttv/option.h>
 
+#include "sync_chain.h"
 #include "sync_chain_lttv.h"
 
 
-#ifndef g_info
-#define g_info(format...) g_log (G_LOG_DOMAIN, G_LOG_LEVEL_INFO, format)
-#endif
-
-
 static void init();
 static void destroy();
 
-static void timeDiff(struct timeval* const end, const struct timeval* const start);
-
-static gint gcfCompareAnalysis(gconstpointer a, gconstpointer b);
-static gint gcfCompareProcessing(gconstpointer a, gconstpointer b);
-static void gfAppendAnalysisName(gpointer data, gpointer user_data);
-
-static gboolean optionSync;
-static gboolean optionSyncStats;
-static gboolean optionSyncNull;
-static char* optionSyncAnalysis;
-static gboolean optionSyncGraphs;
-static char* optionSyncGraphsDir;
+static void gfAddModuleOption(gpointer data, gpointer user_data);
+static void gfRemoveModuleOption(gpointer data, gpointer user_data);
+
+static ModuleOption optionSync= {
+       .longName= "sync",
+       .hasArg= NO_ARG,
+       .optionHelp= "synchronize the time between the traces",
+};
+static ModuleOption optionSyncStats= {
+       .longName= "sync-stats",
+       .hasArg= NO_ARG,
+       .optionHelp= "print statistics about the time synchronization",
+};
+static ModuleOption optionSyncNull= {
+       .longName= "sync-null",
+       .hasArg= NO_ARG,
+       .optionHelp= "read the events but do not perform any processing",
+};
+static GString* analysisModulesNames;
+static ModuleOption optionSyncAnalysis= {
+       .longName= "sync-analysis",
+       .hasArg= REQUIRED_ARG,
+       .optionHelp= "specify the algorithm to use for event analysis",
+};
+static ModuleOption optionSyncGraphs= {
+       .longName= "sync-graphs",
+       .hasArg= NO_ARG,
+       .optionHelp= "output gnuplot graph showing synchronization points",
+};
 static char graphsDir[20];
-
-GQueue processingModules= G_QUEUE_INIT;
-GQueue matchingModules= G_QUEUE_INIT;
-GQueue analysisModules= G_QUEUE_INIT;
+static ModuleOption optionSyncGraphsDir= {
+       .longName= "sync-graphs-dir",
+       .hasArg= REQUIRED_ARG,
+       .optionHelp= "specify the directory where to store the graphs",
+};
 
 
 /*
@@ -77,51 +90,36 @@ GQueue analysisModules= G_QUEUE_INIT;
  */
 static void init()
 {
-       GString* analysisModulesNames;
        int retval;
 
-       g_debug("\t\t\tXXXX sync init\n");
-
-       optionSync= FALSE;
-       lttv_option_add("sync", '\0', "synchronize the time between the traces" ,
-               "none", LTTV_OPT_NONE, &optionSync, NULL, NULL);
-
-       optionSyncStats= FALSE;
-       lttv_option_add("sync-stats", '\0', "print statistics about the time "
-               "synchronization", "none", LTTV_OPT_NONE, &optionSyncStats, NULL,
-               NULL);
-
-       optionSyncNull= FALSE;
-       lttv_option_add("sync-null", '\0', "read the events but do not perform "
-               "any processing", "none", LTTV_OPT_NONE, &optionSyncNull, NULL, NULL);
+       g_debug("Sync init");
 
        g_assert(g_queue_get_length(&analysisModules) > 0);
-       optionSyncAnalysis= ((AnalysisModule*)
+       optionSyncAnalysis.arg= ((AnalysisModule*)
                g_queue_peek_head(&analysisModules))->name;
        analysisModulesNames= g_string_new("");
        g_queue_foreach(&analysisModules, &gfAppendAnalysisName,
                analysisModulesNames);
        // remove the last ", "
        g_string_truncate(analysisModulesNames, analysisModulesNames->len - 2);
-       lttv_option_add("sync-analysis", '\0', "specify the algorithm to use for "
-               "event analysis" , analysisModulesNames->str, LTTV_OPT_STRING,
-               &optionSyncAnalysis, NULL, NULL);
-       g_string_free(analysisModulesNames, TRUE);
-
-       optionSyncGraphs= FALSE;
-       lttv_option_add("sync-graphs", '\0', "output gnuplot graph showing "
-               "synchronization points", "none", LTTV_OPT_NONE, &optionSyncGraphs,
-               NULL, NULL);
+       optionSyncAnalysis.argHelp= analysisModulesNames->str;
 
        retval= snprintf(graphsDir, sizeof(graphsDir), "graphs-%d", getpid());
        if (retval > sizeof(graphsDir) - 1)
        {
                graphsDir[sizeof(graphsDir) - 1]= '\0';
        }
-       optionSyncGraphsDir= graphsDir;
-       lttv_option_add("sync-graphs-dir", '\0', "specify the directory where to"
-               " store the graphs", graphsDir, LTTV_OPT_STRING, &optionSyncGraphsDir,
-               NULL, NULL);
+       optionSyncGraphsDir.arg= graphsDir;
+       optionSyncGraphsDir.argHelp= graphsDir;
+
+       g_queue_push_head(&moduleOptions, &optionSyncGraphsDir);
+       g_queue_push_head(&moduleOptions, &optionSyncGraphs);
+       g_queue_push_head(&moduleOptions, &optionSyncAnalysis);
+       g_queue_push_head(&moduleOptions, &optionSyncNull);
+       g_queue_push_head(&moduleOptions, &optionSyncStats);
+       g_queue_push_head(&moduleOptions, &optionSync);
+
+       g_queue_foreach(&moduleOptions, &gfAddModuleOption, NULL);
 }
 
 
@@ -130,14 +128,15 @@ static void init()
  */
 static void destroy()
 {
-       g_debug("\t\t\tXXXX sync destroy\n");
-
-       lttv_option_remove("sync");
-       lttv_option_remove("sync-stats");
-       lttv_option_remove("sync-null");
-       lttv_option_remove("sync-analysis");
-       lttv_option_remove("sync-graphs");
-       lttv_option_remove("sync-graphs-dir");
+       g_debug("Sync destroy");
+
+       g_queue_foreach(&moduleOptions, &gfRemoveModuleOption, NULL);
+       g_string_free(analysisModulesNames, TRUE);
+
+       g_queue_clear(&processingModules);
+       g_queue_clear(&matchingModules);
+       g_queue_clear(&analysisModules);
+       g_queue_clear(&moduleOptions);
 }
 
 
@@ -155,18 +154,16 @@ void syncTraceset(LttvTracesetContext* const traceSetContext)
        struct timeval startTime, endTime;
        struct rusage startUsage, endUsage;
        GList* result;
-       char* cwd;
-       FILE* graphsStream;
-       int graphsFp;
+       unsigned int i;
        int retval;
 
-       if (optionSync == FALSE)
+       if (!optionSync.present)
        {
                g_debug("Not synchronizing traceset because option is disabled");
                return;
        }
 
-       if (optionSyncStats)
+       if (optionSyncStats.present)
        {
                gettimeofday(&startTime, 0);
                getrusage(RUSAGE_SELF, &startUsage);
@@ -176,7 +173,7 @@ void syncTraceset(LttvTracesetContext* const traceSetContext)
        syncState= malloc(sizeof(SyncState));
        syncState->traceNb= lttv_traceset_number(traceSetContext->ts);
 
-       if (optionSyncStats)
+       if (optionSyncStats.present)
        {
                syncState->stats= true;
        }
@@ -185,18 +182,22 @@ void syncTraceset(LttvTracesetContext* const traceSetContext)
                syncState->stats= false;
        }
 
-       if (optionSyncGraphs)
+       if (optionSyncGraphs.present)
        {
-               syncState->graphs= optionSyncGraphsDir;
+               // Create the graph directory right away in case the module initialization
+               // functions have something to write in it.
+               syncState->graphsDir= optionSyncGraphsDir.arg;
+               syncState->graphsStream= createGraphsDir(syncState->graphsDir);
        }
        else
        {
-               syncState->graphs= NULL;
+               syncState->graphsStream= NULL;
+               syncState->graphsDir= NULL;
        }
 
-       // Identify and initialize processing module
+       // Identify and initialize modules
        syncState->processingData= NULL;
-       if (optionSyncNull)
+       if (optionSyncNull.present)
        {
                result= g_queue_find_custom(&processingModules, "LTTV-null",
                        &gcfCompareProcessing);
@@ -209,39 +210,13 @@ void syncTraceset(LttvTracesetContext* const traceSetContext)
        g_assert(result != NULL);
        syncState->processingModule= (ProcessingModule*) result->data;
 
-       graphsStream= NULL;
-       if (syncState->graphs &&
-               syncState->processingModule->writeProcessingGraphsPlots != NULL)
-       {
-               // Create the graph directory right away in case the module initialization
-               // functions have something to write in it.
-               cwd= changeToGraphDir(syncState->graphs);
-
-               if ((graphsFp= open("graphs.gnu", O_WRONLY | O_CREAT | O_TRUNC, S_IRUSR |
-                               S_IWUSR | S_IXUSR | S_IRGRP | S_IWGRP | S_IXGRP | S_IROTH
-                               | S_IWOTH | S_IXOTH)) == -1)
-               {
-                       g_error(strerror(errno));
-               }
-               if ((graphsStream= fdopen(graphsFp, "w")) == NULL)
-               {
-                       g_error(strerror(errno));
-               }
-
-               retval= chdir(cwd);
-               if (retval == -1)
-               {
-                       g_error(strerror(errno));
-               }
-               free(cwd);
-       }
-
-       // Identify matching and analysis modules
-       g_assert(g_queue_get_length(&matchingModules) == 1);
-       syncState->matchingModule= (MatchingModule*)
-               g_queue_peek_head(&matchingModules);
+       syncState->matchingData= NULL;
+       result= g_queue_find_custom(&matchingModules, "TCP", &gcfCompareMatching);
+       g_assert(result != NULL);
+       syncState->matchingModule= (MatchingModule*) result->data;
 
-       result= g_queue_find_custom(&analysisModules, optionSyncAnalysis,
+       syncState->analysisData= NULL;
+       result= g_queue_find_custom(&analysisModules, optionSyncAnalysis.arg,
                &gcfCompareAnalysis);
        if (result != NULL)
        {
@@ -249,19 +224,15 @@ void syncTraceset(LttvTracesetContext* const traceSetContext)
        }
        else
        {
-               g_error("Analysis module '%s' not found", optionSyncAnalysis);
+               g_error("Analysis module '%s' not found", optionSyncAnalysis.arg);
        }
 
-       syncState->processingModule->initProcessing(syncState, traceSetContext);
-
-       syncState->matchingData= NULL;
-       syncState->analysisData= NULL;
-
-       if (!optionSyncNull)
+       if (!optionSyncNull.present)
        {
-               syncState->matchingModule->initMatching(syncState);
                syncState->analysisModule->initAnalysis(syncState);
+               syncState->matchingModule->initMatching(syncState);
        }
+       syncState->processingModule->initProcessing(syncState, traceSetContext);
 
        // Process traceset
        lttv_process_traceset_seek_time(traceSetContext, ltt_time_zero);
@@ -272,58 +243,11 @@ void syncTraceset(LttvTracesetContext* const traceSetContext)
        syncState->processingModule->finalizeProcessing(syncState);
 
        // Write graphs file
-       if (graphsStream != NULL)
+       if (optionSyncGraphs.present)
        {
-               unsigned int i, j;
-
-               fprintf(graphsStream,
-                       "#!/usr/bin/gnuplot\n\n"
-                       "set terminal postscript eps color size 8in,6in\n");
+               writeGraphsScript(syncState);
 
-               // Cover the upper triangular matrix, i is the reference node.
-               for (i= 0; i < syncState->traceNb; i++)
-               {
-                       for (j= i + 1; j < syncState->traceNb; j++)
-                       {
-                               long pos;
-
-                               fprintf(graphsStream,
-                                       "\nset output \"%03d-%03d.eps\"\n"
-                                       "plot \\\n", i, j);
-
-                               syncState->processingModule->writeProcessingGraphsPlots(graphsStream,
-                                       syncState, i, j);
-
-                               // Remove the ", \\\n" from the last graph plot line
-                               fflush(graphsStream);
-                               pos= ftell(graphsStream);
-                               if (ftruncate(fileno(graphsStream), pos - 4) == -1)
-                               {
-                                       g_error(strerror(errno));
-                               }
-                               if (fseek(graphsStream, 0, SEEK_END) == -1)
-                               {
-                                       g_error(strerror(errno));
-                               }
-
-                               fprintf(graphsStream,
-                                       "\nset output \"%1$03d-%2$03d.eps\"\n"
-                                       "set key inside right bottom\n"
-                                       "set title \"\"\n"
-                                       "set xlabel \"Clock %1$u\"\n"
-                                       "set xtics nomirror\n"
-                                       "set ylabel \"Clock %2$u\"\n"
-                                       "set ytics nomirror\n", i, j);
-
-                               syncState->processingModule->writeProcessingGraphsOptions(graphsStream,
-                                       syncState, i, j);
-
-                               fprintf(graphsStream,
-                                       "replot\n");
-                       }
-               }
-
-               if (fclose(graphsStream) != 0)
+               if (fclose(syncState->graphsStream) != 0)
                {
                        g_error(strerror(errno));
                }
@@ -333,6 +257,31 @@ void syncTraceset(LttvTracesetContext* const traceSetContext)
        {
                syncState->processingModule->printProcessingStats(syncState);
        }
+       if (syncState->matchingModule->printMatchingStats != NULL)
+       {
+               syncState->matchingModule->printMatchingStats(syncState);
+       }
+       if (syncState->analysisModule->printAnalysisStats != NULL)
+       {
+               syncState->analysisModule->printAnalysisStats(syncState);
+       }
+
+       if (optionSyncStats.present)
+       {
+               printf("Resulting synchronization factors:\n");
+               for (i= 0; i < syncState->traceNb; i++)
+               {
+                       LttTrace* t;
+
+                       t= traceSetContext->traces[i]->t;
+
+                       printf("\ttrace %u drift= %g offset= %g (%f) start time= %ld.%09ld\n",
+                               i, t->drift, t->offset, (double) tsc_to_uint64(t->freq_scale,
+                                       t->start_freq, t->offset) / NANOSECONDS_PER_SECOND,
+                               t->start_time_from_tsc.tv_sec,
+                               t->start_time_from_tsc.tv_nsec);
+               }
+       }
 
        syncState->processingModule->destroyProcessing(syncState);
        if (syncState->matchingModule != NULL)
@@ -346,7 +295,7 @@ void syncTraceset(LttvTracesetContext* const traceSetContext)
 
        free(syncState);
 
-       if (optionSyncStats)
+       if (optionSyncStats.present)
        {
                gettimeofday(&endTime, 0);
                retval= getrusage(RUSAGE_SELF, &endUsage);
@@ -365,128 +314,55 @@ void syncTraceset(LttvTracesetContext* const traceSetContext)
 }
 
 
-/*
- * Calculate the elapsed time between two timeval values
- *
- * Args:
- *   end:          end time, result is also stored in this structure
- *   start:        start time
- */
-static void timeDiff(struct timeval* const end, const struct timeval* const start)
-{
-               if (end->tv_usec >= start->tv_usec)
-               {
-                       end->tv_sec-= start->tv_sec;
-                       end->tv_usec-= start->tv_usec;
-               }
-               else
-               {
-                       end->tv_sec= end->tv_sec - start->tv_sec - 1;
-                       end->tv_usec= end->tv_usec - start->tv_usec + 1e6;
-               }
-}
-
-
-/*
- * A GCompareFunc for g_slist_find_custom()
- *
- * Args:
- *   a:            AnalysisModule*, element's data
- *   b:            char*, user data to compare against
- *
- * Returns:
- *   0 if the analysis module a's name is b
- */
-static gint gcfCompareAnalysis(gconstpointer a, gconstpointer b)
-{
-       const AnalysisModule* analysisModule;
-       const char* name;
-
-       analysisModule= (const AnalysisModule*)a;
-       name= (const char*)b;
-
-       return strncmp(analysisModule->name, name, strlen(analysisModule->name) +
-               1);
-}
-
-
-/*
- * A GCompareFunc for g_slist_find_custom()
- *
- * Args:
- *   a:            ProcessingModule*, element's data
- *   b:            char*, user data to compare against
- *
- * Returns:
- *   0 if the analysis module a's name is b
- */
-static gint gcfCompareProcessing(gconstpointer a, gconstpointer b)
-{
-       const ProcessingModule* processingModule;
-       const char* name;
-
-       processingModule= (const ProcessingModule*)a;
-       name= (const char*)b;
-
-       return strncmp(processingModule->name, name,
-               strlen(processingModule->name) + 1);
-}
-
-
 /*
  * A GFunc for g_queue_foreach()
  *
- * Concatenate analysis module names.
- *
  * Args:
- *   data:         AnalysisModule*
- *   user_data:    GString*, concatenated names
+ *   data:         ModuleOption*
+ *   user_data:    NULL
  */
-static void gfAppendAnalysisName(gpointer data, gpointer user_data)
+static void gfAddModuleOption(gpointer data, gpointer user_data)
 {
-       g_string_append((GString*) user_data, ((AnalysisModule*) data)->name);
-       g_string_append((GString*) user_data, ", ");
+       ModuleOption* option= data;
+       LttvOptionType conversion[]= {
+               [NO_ARG]= LTTV_OPT_NONE,
+               [OPTIONAL_ARG]= LTTV_OPT_NONE,
+               [REQUIRED_ARG]= LTTV_OPT_STRING,
+       };
+       size_t fieldOffset[]= {
+               [NO_ARG]= offsetof(ModuleOption, present),
+               [REQUIRED_ARG]= offsetof(ModuleOption, arg),
+       };
+       static const char* argHelpNone= "none";
+
+       g_assert_cmpuint(sizeof(conversion) / sizeof(*conversion), ==,
+               HAS_ARG_COUNT);
+       if (option->hasArg == OPTIONAL_ARG)
+       {
+               g_warning("Parameters with optional arguments not supported by the "
+                       "lttv option scheme, parameter '%s' will not be available",
+                       option->longName);
+       }
+       else
+       {
+               lttv_option_add(option->longName, '\0', option->optionHelp,
+                       option->argHelp ? option->argHelp : argHelpNone,
+                       conversion[option->hasArg], (void*) option + fieldOffset[option->hasArg],
+                       NULL, NULL);
+       }
 }
 
 
 /*
- * Change to the directory used to hold graphs. Create it if necessary.
+ * A GFunc for g_queue_foreach()
  *
  * Args:
- *   graph:        name of directory
- *
- * Returns:
- *   The current working directory before the execution of the function. The
- *   string must be free'd by the caller.
+ *   data:         ModuleOption*
+ *   user_data:    NULL
  */
-char* changeToGraphDir(char* const graphs)
+static void gfRemoveModuleOption(gpointer data, gpointer user_data)
 {
-       int retval;
-       char* cwd;
-
-       cwd= getcwd(NULL, 0);
-       if (cwd == NULL)
-       {
-               g_error(strerror(errno));
-       }
-       while ((retval= chdir(graphs)) != 0)
-       {
-               if (errno == ENOENT)
-               {
-                       retval= mkdir(graphs, S_IRUSR | S_IWUSR | S_IXUSR | S_IRGRP |
-                               S_IWGRP | S_IXGRP | S_IROTH | S_IWOTH | S_IXOTH);
-                       if (retval != 0)
-                       {
-                               g_error(strerror(errno));
-                       }
-               }
-               else
-               {
-                       g_error(strerror(errno));
-               }
-       }
-
-       return cwd;
+       lttv_option_remove(((ModuleOption*) data)->longName);
 }
 
 
This page took 0.028633 seconds and 4 git commands to generate.