1 /* This file is part of the Linux Trace Toolkit viewer
2 * Copyright (C) 2009 Benjamin Poirier <benjamin.poirier@polymtl.ca>
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;
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.
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,
27 #include <sys/resource.h>
29 #include <sys/types.h>
33 #include <lttv/module.h>
34 #include <lttv/option.h>
36 #include "sync_chain.h"
37 #include "sync_chain_lttv.h"
41 static void destroy();
43 static void gfAddModuleOption(gpointer data
, gpointer user_data
);
44 static void gfRemoveModuleOption(gpointer data
, gpointer user_data
);
46 static ModuleOption optionSync
= {
49 .optionHelp
= "synchronize the time between the traces",
51 static ModuleOption optionSyncStats
= {
52 .longName
= "sync-stats",
54 .optionHelp
= "print statistics about the time synchronization",
56 static ModuleOption optionSyncNull
= {
57 .longName
= "sync-null",
59 .optionHelp
= "read the events but do not perform any processing",
61 static GString
* analysisModulesNames
;
62 static ModuleOption optionSyncAnalysis
= {
63 .longName
= "sync-analysis",
64 .hasArg
= REQUIRED_ARG
,
65 .optionHelp
= "specify the algorithm to use for event analysis",
67 static ModuleOption optionSyncGraphs
= {
68 .longName
= "sync-graphs",
70 .optionHelp
= "output gnuplot graph showing synchronization points",
72 static char graphsDir
[20];
73 static ModuleOption optionSyncGraphsDir
= {
74 .longName
= "sync-graphs-dir",
75 .hasArg
= REQUIRED_ARG
,
76 .optionHelp
= "specify the directory where to store the graphs",
81 * Module init function
83 * This function is declared to be the module initialization function. Event
84 * modules are registered with a "constructor (102)" attribute except one in
85 * each class (processing, matching, analysis) which is chosen to be the
86 * default and which is registered with a "constructor (101)" attribute.
87 * Constructors with no priority are called after constructors with
88 * priorities. The result is that the list of event modules is known when this
89 * function is executed.
97 g_assert(g_queue_get_length(&analysisModules
) > 0);
98 optionSyncAnalysis
.arg
= ((AnalysisModule
*)
99 g_queue_peek_head(&analysisModules
))->name
;
100 analysisModulesNames
= g_string_new("");
101 g_queue_foreach(&analysisModules
, &gfAppendAnalysisName
,
102 analysisModulesNames
);
103 // remove the last ", "
104 g_string_truncate(analysisModulesNames
, analysisModulesNames
->len
- 2);
105 optionSyncAnalysis
.argHelp
= analysisModulesNames
->str
;
107 retval
= snprintf(graphsDir
, sizeof(graphsDir
), "graphs-%d", getpid());
108 if (retval
> sizeof(graphsDir
) - 1)
110 graphsDir
[sizeof(graphsDir
) - 1]= '\0';
112 optionSyncGraphsDir
.arg
= graphsDir
;
113 optionSyncGraphsDir
.argHelp
= graphsDir
;
115 g_queue_push_head(&moduleOptions
, &optionSyncGraphsDir
);
116 g_queue_push_head(&moduleOptions
, &optionSyncGraphs
);
117 g_queue_push_head(&moduleOptions
, &optionSyncAnalysis
);
118 g_queue_push_head(&moduleOptions
, &optionSyncNull
);
119 g_queue_push_head(&moduleOptions
, &optionSyncStats
);
120 g_queue_push_head(&moduleOptions
, &optionSync
);
122 g_queue_foreach(&moduleOptions
, &gfAddModuleOption
, NULL
);
127 * Module unload function
129 static void destroy()
131 g_debug("Sync destroy");
133 g_queue_foreach(&moduleOptions
, &gfRemoveModuleOption
, NULL
);
134 g_string_free(analysisModulesNames
, TRUE
);
136 g_queue_clear(&processingModules
);
137 g_queue_clear(&matchingModules
);
138 g_queue_clear(&analysisModules
);
139 g_queue_clear(&moduleOptions
);
144 * Calculate a traceset's drift and offset values based on network events
146 * The individual correction factors are written out to each trace.
149 * traceSetContext: traceset
151 void syncTraceset(LttvTracesetContext
* const traceSetContext
)
153 SyncState
* syncState
;
154 struct timeval startTime
, endTime
;
155 struct rusage startUsage
, endUsage
;
160 if (!optionSync
.present
)
162 g_debug("Not synchronizing traceset because option is disabled");
166 if (optionSyncStats
.present
)
168 gettimeofday(&startTime
, 0);
169 getrusage(RUSAGE_SELF
, &startUsage
);
172 // Initialize data structures
173 syncState
= malloc(sizeof(SyncState
));
175 if (optionSyncStats
.present
)
177 syncState
->stats
= true;
181 syncState
->stats
= false;
184 if (!optionSyncNull
.present
&& optionSyncGraphs
.present
)
186 // Create the graph directory right away in case the module initialization
187 // functions have something to write in it.
188 syncState
->graphsDir
= optionSyncGraphsDir
.arg
;
189 syncState
->graphsStream
= createGraphsDir(syncState
->graphsDir
);
193 syncState
->graphsStream
= NULL
;
194 syncState
->graphsDir
= NULL
;
197 // Identify and initialize modules
198 syncState
->processingData
= NULL
;
199 if (optionSyncNull
.present
)
201 result
= g_queue_find_custom(&processingModules
, "LTTV-null",
202 &gcfCompareProcessing
);
206 result
= g_queue_find_custom(&processingModules
, "LTTV-standard",
207 &gcfCompareProcessing
);
209 g_assert(result
!= NULL
);
210 syncState
->processingModule
= (ProcessingModule
*) result
->data
;
212 syncState
->matchingData
= NULL
;
213 result
= g_queue_find_custom(&matchingModules
, "TCP", &gcfCompareMatching
);
214 g_assert(result
!= NULL
);
215 syncState
->matchingModule
= (MatchingModule
*) result
->data
;
217 syncState
->analysisData
= NULL
;
218 result
= g_queue_find_custom(&analysisModules
, optionSyncAnalysis
.arg
,
219 &gcfCompareAnalysis
);
222 syncState
->analysisModule
= (AnalysisModule
*) result
->data
;
226 g_error("Analysis module '%s' not found", optionSyncAnalysis
.arg
);
229 syncState
->processingModule
->initProcessing(syncState
, traceSetContext
);
230 if (!optionSyncNull
.present
)
232 syncState
->matchingModule
->initMatching(syncState
);
233 syncState
->analysisModule
->initAnalysis(syncState
);
237 lttv_process_traceset_seek_time(traceSetContext
, ltt_time_zero
);
238 lttv_process_traceset_middle(traceSetContext
, ltt_time_infinite
,
240 lttv_process_traceset_seek_time(traceSetContext
, ltt_time_zero
);
242 syncState
->processingModule
->finalizeProcessing(syncState
);
245 if (!optionSyncNull
.present
&& optionSyncGraphs
.present
)
247 writeGraphsScript(syncState
);
249 if (fclose(syncState
->graphsStream
) != 0)
251 g_error(strerror(errno
));
255 if (!optionSyncNull
.present
&& optionSyncStats
.present
)
257 printStats(syncState
);
259 printf("Resulting synchronization factors:\n");
260 for (i
= 0; i
< syncState
->traceNb
; i
++)
264 t
= traceSetContext
->traces
[i
]->t
;
266 printf("\ttrace %u drift= %g offset= %g (%f) start time= %ld.%09ld\n",
267 i
, t
->drift
, t
->offset
, (double) tsc_to_uint64(t
->freq_scale
,
268 t
->start_freq
, t
->offset
) / NANOSECONDS_PER_SECOND
,
269 t
->start_time_from_tsc
.tv_sec
,
270 t
->start_time_from_tsc
.tv_nsec
);
274 syncState
->processingModule
->destroyProcessing(syncState
);
275 if (syncState
->matchingModule
!= NULL
)
277 syncState
->matchingModule
->destroyMatching(syncState
);
279 if (syncState
->analysisModule
!= NULL
)
281 syncState
->analysisModule
->destroyAnalysis(syncState
);
286 if (optionSyncStats
.present
)
288 gettimeofday(&endTime
, 0);
289 retval
= getrusage(RUSAGE_SELF
, &endUsage
);
291 timeDiff(&endTime
, &startTime
);
292 timeDiff(&endUsage
.ru_utime
, &startUsage
.ru_utime
);
293 timeDiff(&endUsage
.ru_stime
, &startUsage
.ru_stime
);
295 printf("Synchronization time:\n");
296 printf("\treal time: %ld.%06ld\n", endTime
.tv_sec
, endTime
.tv_usec
);
297 printf("\tuser time: %ld.%06ld\n", endUsage
.ru_utime
.tv_sec
,
298 endUsage
.ru_utime
.tv_usec
);
299 printf("\tsystem time: %ld.%06ld\n", endUsage
.ru_stime
.tv_sec
,
300 endUsage
.ru_stime
.tv_usec
);
306 * A GFunc for g_queue_foreach()
309 * data: ModuleOption*
312 static void gfAddModuleOption(gpointer data
, gpointer user_data
)
314 ModuleOption
* option
= data
;
315 LttvOptionType conversion
[]= {
316 [NO_ARG
]= LTTV_OPT_NONE
,
317 [OPTIONAL_ARG
]= LTTV_OPT_NONE
,
318 [REQUIRED_ARG
]= LTTV_OPT_STRING
,
320 size_t fieldOffset
[]= {
321 [NO_ARG
]= offsetof(ModuleOption
, present
),
322 [REQUIRED_ARG
]= offsetof(ModuleOption
, arg
),
324 static const char* argHelpNone
= "none";
326 g_assert_cmpuint(sizeof(conversion
) / sizeof(*conversion
), ==,
328 if (option
->hasArg
== OPTIONAL_ARG
)
330 g_warning("Parameters with optional arguments not supported by the "
331 "lttv option scheme, parameter '%s' will not be available",
336 lttv_option_add(option
->longName
, '\0', option
->optionHelp
,
337 option
->argHelp
? option
->argHelp
: argHelpNone
,
338 conversion
[option
->hasArg
], (void*) option
+ fieldOffset
[option
->hasArg
],
345 * A GFunc for g_queue_foreach()
348 * data: ModuleOption*
351 static void gfRemoveModuleOption(gpointer data
, gpointer user_data
)
353 lttv_option_remove(((ModuleOption
*) data
)->longName
);
357 LTTV_MODULE("sync", "Synchronize traces", \
358 "Synchronizes a traceset based on the correspondance of network events", \
359 init
, destroy
, "option")