Move and update documentation
[lttv.git] / lttv / lttv / sync / event_processing_lttng_standard.c
index cc9ada288353797096f954d5ea3361baf7840224..8cd4f83978ad65e3563361152dcd90ca2ba17c17 100644 (file)
@@ -1,30 +1,26 @@
 /* This file is part of the Linux Trace Toolkit viewer
- * Copyright (C) 2009 Benjamin Poirier <benjamin.poirier@polymtl.ca>
+ * Copyright (C) 2009, 2010 Benjamin Poirier <benjamin.poirier@polymtl.ca>
  *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License Version 2 as
- * published by the Free Software Foundation;
+ * This program is free software: you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 2.1 of the License, or (at
+ * your option) any later version.
  *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
+ * License for more details.
  *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
- * MA 02111-1307, USA.
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#define _ISOC99_SOURCE
-
 #ifdef HAVE_CONFIG_H
 #include <config.h>
 #endif
 
-#include <linux/if_ether.h>
-#include <math.h>
 #include <netinet/in.h>
+#include <stdarg.h>
 #include <stdint.h>
 #include <stdlib.h>
 #include <string.h>
 
 #include "event_processing_lttng_standard.h"
 
-
-#ifndef g_info
-#define g_info(format...) g_log (G_LOG_DOMAIN, G_LOG_LEVEL_INFO, format)
-#endif
+/* IPv4 Ethertype, taken from <linux/if_ether.h>, unlikely to change as it's
+ * defined by IANA: http://www.iana.org/assignments/ethernet-numbers
+ */
+#define ETH_P_IP    0x0800
 
 
 // Functions common to all processing modules
-static void initProcessingLTTVStandard(SyncState* const syncState,
-       LttvTracesetContext* const traceSetContext);
+static void initProcessingLTTVStandard(SyncState* const syncState, ...);
 static void destroyProcessingLTTVStandard(SyncState* const syncState);
 
-static void finalizeProcessingLTTVStandard(SyncState* const syncState);
+static AllFactors* finalizeProcessingLTTVStandard(SyncState* const syncState);
 static void printProcessingStatsLTTVStandard(SyncState* const syncState);
+static void writeProcessingGraphVariablesLTTVStandard(SyncState* const
+       syncState, const unsigned int i);
 static void writeProcessingTraceTraceOptionsLTTVStandard(SyncState* const
        syncState, const unsigned int i, const unsigned int j);
 static void writeProcessingTraceTimeOptionsLTTVStandard(SyncState* const
        syncState, const unsigned int i, const unsigned int j);
 
 // Functions specific to this module
-static void registerProcessingLTTVStandard() __attribute__((constructor (102)));
 static gboolean processEventLTTVStandard(void* hookData, void* callData);
 static void partialDestroyProcessingLTTVStandard(SyncState* const syncState);
 
@@ -65,6 +61,7 @@ static ProcessingModule processingModuleLTTVStandard = {
        .finalizeProcessing= &finalizeProcessingLTTVStandard,
        .printProcessingStats= &printProcessingStatsLTTVStandard,
        .graphFunctions= {
+               .writeVariables= &writeProcessingGraphVariablesLTTVStandard,
                .writeTraceTraceOptions= &writeProcessingTraceTraceOptionsLTTVStandard,
                .writeTraceTimeOptions= &writeProcessingTraceTimeOptionsLTTVStandard,
        },
@@ -74,7 +71,7 @@ static ProcessingModule processingModuleLTTVStandard = {
 /*
  * Processing Module registering function
  */
-static void registerProcessingLTTVStandard()
+void registerProcessingLTTVStandard()
 {
        g_queue_push_tail(&processingModules, &processingModuleLTTVStandard);
 
@@ -93,37 +90,47 @@ static void registerProcessingLTTVStandard()
  *                 pendingRecv
  *                 hookListList
  *                 stats
- *   traceSetContext: set of LTTV traces
+ *   traceSetContext: LttvTracesetContext*, set of LTTV traces
  */
-static void initProcessingLTTVStandard(SyncState* const syncState, LttvTracesetContext*
-       const traceSetContext)
+static void initProcessingLTTVStandard(SyncState* const syncState, ...)
 {
        unsigned int i;
        ProcessingDataLTTVStandard* processingData;
+       va_list ap;
 
        processingData= malloc(sizeof(ProcessingDataLTTVStandard));
        syncState->processingData= processingData;
-       processingData->traceSetContext= traceSetContext;
+       va_start(ap, syncState);
+       processingData->traceSetContext= va_arg(ap, LttvTracesetContext*);
+       va_end(ap);
+       syncState->traceNb=
+               lttv_traceset_number(processingData->traceSetContext->ts);
+       processingData->hookListList= g_array_sized_new(FALSE, FALSE,
+               sizeof(GArray*), syncState->traceNb);
 
-       if (syncState->stats)
-       {
-               processingData->stats= calloc(1, sizeof(ProcessingStatsLTTVStandard));
-       }
-       else
+       processingData->traceNumTable= g_hash_table_new(&g_direct_hash, NULL);
+       for(i= 0; i < syncState->traceNb; i++)
        {
-               processingData->stats= NULL;
+               g_hash_table_insert(processingData->traceNumTable,
+                       processingData->traceSetContext->traces[i]->t,
+                       GUINT_TO_POINTER(i));
        }
 
-       processingData->traceNumTable= g_hash_table_new(&g_direct_hash, NULL);
-       processingData->hookListList= g_array_sized_new(FALSE, FALSE,
-               sizeof(GArray*), syncState->traceNb);
        processingData->pendingRecv= malloc(sizeof(GHashTable*) *
                syncState->traceNb);
-
        for(i= 0; i < syncState->traceNb; i++)
        {
-               g_hash_table_insert(processingData->traceNumTable,
-                       processingData->traceSetContext->traces[i]->t, (gpointer) i);
+               processingData->pendingRecv[i]= g_hash_table_new_full(&g_direct_hash,
+                       NULL, NULL, &gdnDestroyEvent);
+       }
+
+       if (syncState->stats)
+       {
+               processingData->stats= calloc(1, sizeof(ProcessingStatsLTTVStandard));
+       }
+       else
+       {
+               processingData->stats= NULL;
        }
 
        if (syncState->graphsStream)
@@ -133,7 +140,7 @@ static void initProcessingLTTVStandard(SyncState* const syncState, LttvTracesetC
 
                for(i= 0; i < syncState->traceNb; i++)
                {
-                       LttTrace* traceI= traceSetContext->traces[i]->t;
+                       LttTrace* traceI= processingData->traceSetContext->traces[i]->t;
 
                        processingData->graphs[i].startFreq= traceI->start_freq;
                        processingData->graphs[i].freqScale= traceI->freq_scale;
@@ -144,106 +151,36 @@ static void initProcessingLTTVStandard(SyncState* const syncState, LttvTracesetC
                processingData->graphs= NULL;
        }
 
-       for(i= 0; i < syncState->traceNb; i++)
-       {
-               processingData->pendingRecv[i]= g_hash_table_new_full(&g_direct_hash,
-                       NULL, NULL, &gdnDestroyEvent);
-       }
-
-       registerHooks(processingData->hookListList, traceSetContext,
-               &processEventLTTVStandard, syncState,
+       registerHooks(processingData->hookListList,
+               processingData->traceSetContext, &processEventLTTVStandard, syncState,
                syncState->matchingModule->canMatch);
 }
 
 
 /*
- * Call the partial processing destroyer, obtain and adjust the factors from
+ * Call the partial processing destroyer, obtain and the factors from
  * downstream
  *
  * Args:
  *   syncState     container for synchronization data.
+ *
+ * Returns:
+ *   AllFactors    synchronization factors for each trace pair
  */
-static void finalizeProcessingLTTVStandard(SyncState* const syncState)
+static AllFactors* finalizeProcessingLTTVStandard(SyncState* const syncState)
 {
-       unsigned int i;
-       GArray* factors;
-       double minOffset, minDrift;
-       unsigned int refFreqTrace;
        ProcessingDataLTTVStandard* processingData;
 
        processingData= (ProcessingDataLTTVStandard*) syncState->processingData;
 
        partialDestroyProcessingLTTVStandard(syncState);
 
-       factors= syncState->matchingModule->finalizeMatching(syncState);
-
-       /* The offsets are adjusted so the lowest one is 0. This is done because
-        * of a Lttv specific limitation: events cannot have negative times. By
-        * having non-negative offsets, events cannot be moved backwards to
-        * negative times.
-        */
-       minOffset= 0;
-       for (i= 0; i < syncState->traceNb; i++)
-       {
-               minOffset= MIN(g_array_index(factors, Factors, i).offset, minOffset);
-       }
-
-       for (i= 0; i < syncState->traceNb; i++)
-       {
-               g_array_index(factors, Factors, i).offset-= minOffset;
-       }
-
-       /* Because the timestamps are corrected at the TSC level (not at the
-        * LttTime level) all trace frequencies must be made equal. We choose to
-        * use the frequency of the system with the lowest drift
-        */
-       minDrift= INFINITY;
-       refFreqTrace= 0;
-       for (i= 0; i < syncState->traceNb; i++)
-       {
-               if (g_array_index(factors, Factors, i).drift < minDrift)
-               {
-                       minDrift= g_array_index(factors, Factors, i).drift;
-                       refFreqTrace= i;
-               }
-       }
-       g_assert(syncState->traceNb == 0 || minDrift != INFINITY);
-
-       // Write the factors to the LttTrace structures
-       for (i= 0; i < syncState->traceNb; i++)
-       {
-               LttTrace* t;
-               Factors* traceFactors;
-
-               t= processingData->traceSetContext->traces[i]->t;
-               traceFactors= &g_array_index(factors, Factors, i);
-
-               t->drift= traceFactors->drift;
-               t->offset= traceFactors->offset;
-               t->start_freq=
-                       processingData->traceSetContext->traces[refFreqTrace]->t->start_freq;
-               t->freq_scale=
-                       processingData->traceSetContext->traces[refFreqTrace]->t->freq_scale;
-               t->start_time_from_tsc =
-                       ltt_time_from_uint64(tsc_to_uint64(t->freq_scale, t->start_freq,
-                                       t->drift * t->start_tsc + t->offset));
-       }
-
-       g_array_free(factors, TRUE);
-
-       lttv_traceset_context_compute_time_span(processingData->traceSetContext,
-               &processingData->traceSetContext->time_span);
-
-       g_debug("traceset start %ld.%09ld end %ld.%09ld\n",
-               processingData->traceSetContext->time_span.start_time.tv_sec,
-               processingData->traceSetContext->time_span.start_time.tv_nsec,
-               processingData->traceSetContext->time_span.end_time.tv_sec,
-               processingData->traceSetContext->time_span.end_time.tv_nsec);
+       return syncState->matchingModule->finalizeMatching(syncState);
 }
 
 
 /*
- * Print statistics related to processing Must be called after
+ * Print statistics related to processing. Must be called after
  * finalizeProcessing.
  *
  * Args:
@@ -349,7 +286,7 @@ static void partialDestroyProcessingLTTVStandard(SyncState* const syncState)
        for(i= 0; i < syncState->traceNb; i++)
        {
 
-               g_debug("Cleaning up pendingRecv list\n");
+               g_debug("Cleaning up pendingRecv list");
                g_hash_table_destroy(processingData->pendingRecv[i]);
        }
        free(processingData->pendingRecv);
@@ -383,6 +320,7 @@ static gboolean processEventLTTVStandard(void* hookData, void* callData)
        struct marker_info* info;
        SyncState* syncState;
        ProcessingDataLTTVStandard* processingData;
+       gpointer traceNumP;
 
        traceHook= (LttvTraceHook*) hookData;
        tfc= (LttvTracefileContext*) callData;
@@ -397,9 +335,10 @@ static gboolean processEventLTTVStandard(void* hookData, void* callData)
        wTime.nanosec= time.tv_nsec;
 
        g_assert(g_hash_table_lookup_extended(processingData->traceNumTable,
-                       trace, NULL, (gpointer*) &traceNum));
+                       trace, NULL, &traceNumP));
+       traceNum= GPOINTER_TO_INT(traceNumP);
 
-       g_debug("XXXX process event: time: %ld.%09ld trace: %ld (%p) name: %s ",
+       g_debug("Process event: time: %ld.%09ld trace: %ld (%p) name: %s ",
                time.tv_sec, time.tv_nsec, traceNum, trace,
                g_quark_to_string(info->name));
 
@@ -470,7 +409,7 @@ static gboolean processEventLTTVStandard(void* hookData, void* callData)
 
                syncState->matchingModule->matchEvent(syncState, outE);
 
-               g_debug("Output event done\n");
+               g_debug("Output event done");
        }
        else if (info->name == LTT_EVENT_DEV_RECEIVE)
        {
@@ -507,11 +446,7 @@ static gboolean processEventLTTVStandard(void* hookData, void* callData)
                        g_hash_table_replace(processingData->pendingRecv[traceNum], skb,
                                inE);
 
-                       g_debug("Adding inE %p for skb %p to pendingRecv\n", inE, skb);
-               }
-               else
-               {
-                       g_debug("\n");
+                       g_debug("Adding inE %p for skb %p to pendingRecv", inE, skb);
                }
        }
        else if (info->name == LTT_EVENT_TCPV4_RCV_EXTENDED)
@@ -588,7 +523,7 @@ static gboolean processEventLTTVStandard(void* hookData, void* callData)
 
                        syncState->matchingModule->matchEvent(syncState, inE);
 
-                       g_debug("TCP input event %p for skb %p done\n", inE, skb);
+                       g_debug("TCP input event %p for skb %p done", inE, skb);
                }
        }
        else if (info->name == LTT_EVENT_UDPV4_RCV_EXTENDED)
@@ -662,7 +597,7 @@ static gboolean processEventLTTVStandard(void* hookData, void* callData)
 
                        syncState->matchingModule->matchEvent(syncState, inE);
 
-                       g_debug("UDP input event %p for skb %p done\n", inE, skb);
+                       g_debug("UDP input event %p for skb %p done", inE, skb);
                }
        }
        else
@@ -674,6 +609,24 @@ static gboolean processEventLTTVStandard(void* hookData, void* callData)
 }
 
 
+/*
+ * Write the processing-specific variables in the gnuplot script.
+ *
+ * Args:
+ *   syncState:    container for synchronization data
+ *   i:            trace number
+ */
+static void writeProcessingGraphVariablesLTTVStandard(SyncState* const
+       syncState, const unsigned int i)
+{
+       ProcessingDataLTTVStandard* processingData= syncState->processingData;
+       ProcessingGraphsLTTVStandard* traceI= &processingData->graphs[i];
+
+       fprintf(syncState->graphsStream, "clock_freq_%u= %.3f\n", i, (double)
+               traceI->startFreq / traceI->freqScale);
+}
+
+
 /*
  * Write the processing-specific options in the gnuplot script.
  *
@@ -685,27 +638,18 @@ static gboolean processEventLTTVStandard(void* hookData, void* callData)
 static void writeProcessingTraceTraceOptionsLTTVStandard(SyncState* const
        syncState, const unsigned int i, const unsigned int j)
 {
-       ProcessingDataLTTVStandard* processingData;
-       ProcessingGraphsLTTVStandard* traceI, * traceJ;
-
-       processingData= (ProcessingDataLTTVStandard*) syncState->processingData;
-
-       traceI= &processingData->graphs[i];
-       traceJ= &processingData->graphs[j];
-
        fprintf(syncState->graphsStream,
         "set key inside right bottom\n"
         "set xlabel \"Clock %1$u\"\n"
         "set xtics nomirror\n"
-        "set ylabel \"Clock %3$u\"\n"
+        "set ylabel \"Clock %2$u\"\n"
         "set ytics nomirror\n"
                "set x2label \"Clock %1$d (s)\"\n"
-               "set x2range [GPVAL_X_MIN / %2$.1f : GPVAL_X_MAX / %2$.1f]\n"
+               "set x2range [GPVAL_X_MIN / clock_freq_%1$u : GPVAL_X_MAX / clock_freq_%1$u]\n"
                "set x2tics\n"
-               "set y2label \"Clock %3$d (s)\"\n"
-               "set y2range [GPVAL_Y_MIN / %4$.1f : GPVAL_Y_MAX / %4$.1f]\n"
-               "set y2tics\n", i, (double) traceI->startFreq / traceI->freqScale, j,
-               (double) traceJ->startFreq / traceJ->freqScale);
+               "set y2label \"Clock %2$d (s)\"\n"
+               "set y2range [GPVAL_Y_MIN / clock_freq_%2$u : GPVAL_Y_MAX / clock_freq_%2$u]\n"
+               "set y2tics\n", i, j);
 }
 
 
@@ -720,14 +664,6 @@ static void writeProcessingTraceTraceOptionsLTTVStandard(SyncState* const
 static void writeProcessingTraceTimeOptionsLTTVStandard(SyncState* const
        syncState, const unsigned int i, const unsigned int j)
 {
-       ProcessingDataLTTVStandard* processingData;
-       ProcessingGraphsLTTVStandard* traceI, * traceJ;
-
-       processingData= (ProcessingDataLTTVStandard*) syncState->processingData;
-
-       traceI= &processingData->graphs[i];
-       traceJ= &processingData->graphs[j];
-
        fprintf(syncState->graphsStream,
         "set key inside right bottom\n"
         "set xlabel \"Clock %1$u\"\n"
@@ -735,6 +671,6 @@ static void writeProcessingTraceTimeOptionsLTTVStandard(SyncState* const
         "set ylabel \"time (s)\"\n"
         "set ytics nomirror\n"
                "set x2label \"Clock %1$d (s)\"\n"
-               "set x2range [GPVAL_X_MIN / %2$.1f : GPVAL_X_MAX / %2$.1f]\n"
-               "set x2tics\n", i, (double) traceI->startFreq / traceI->freqScale);
+               "set x2range [GPVAL_X_MIN / clock_freq_%1$u : GPVAL_X_MAX / clock_freq_%1$u]\n"
+               "set x2tics\n", i);
 }
This page took 0.027367 seconds and 4 git commands to generate.