1 /* This file is part of the Linux Trace Toolkit viewer
2 * Copyright (C) 2009, 2010 Benjamin Poirier <benjamin.poirier@polymtl.ca>
4 * This program is free software: you can redistribute it and/or modify it
5 * under the terms of the GNU Lesser General Public License as published by
6 * the Free Software Foundation, either version 2.1 of the License, or (at
7 * your option) any later version.
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
12 * License for more details.
14 * You should have received a copy of the GNU Lesser General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 #define NANOSECONDS_PER_SECOND 1000000000
32 #include "sync_chain.h"
34 #include "event_processing_text.h"
37 // Functions common to all processing modules
38 static void initProcessingText(SyncState
* const syncState
, ...);
39 static void destroyProcessingText(SyncState
* const syncState
);
40 static GArray
* finalizeProcessingText(SyncState
* const syncState
);
41 static void printProcessingStatsText(SyncState
* const syncState
);
42 static void writeProcessingTraceTimeOptionsText(SyncState
* const syncState
,
43 const unsigned int i
, const unsigned int j
);
44 static void writeProcessingTraceTraceOptionsText(SyncState
* const syncState
,
45 const unsigned int i
, const unsigned int j
);
46 static void writeProcessingGraphVariablesText(SyncState
* const syncState
,
47 const unsigned int i
);
49 // Functions specific to this module
50 static unsigned int readTraceNb(FILE* testCase
);
51 static void skipCommentLines(FILE* testCase
);
54 static ProcessingModule processingModuleText
= {
56 .initProcessing
= &initProcessingText
,
57 .destroyProcessing
= &destroyProcessingText
,
58 .finalizeProcessing
= &finalizeProcessingText
,
59 .printProcessingStats
= &printProcessingStatsText
,
61 .writeVariables
= &writeProcessingGraphVariablesText
,
62 .writeTraceTraceOptions
= &writeProcessingTraceTraceOptionsText
,
63 .writeTraceTimeOptions
= &writeProcessingTraceTimeOptionsText
,
69 * Processing Module registering function
71 void registerProcessingText()
73 g_queue_push_tail(&processingModules
, &processingModuleText
);
78 * Allocate and initialize data structures for synchronizing a traceset.
79 * Open test case file.
82 * syncState: container for synchronization data.
83 * testCaseName: const char*, test case file name
85 static void initProcessingText(SyncState
* const syncState
, ...)
87 ProcessingDataText
* processingData
;
88 const char* testCaseName
;
91 processingData
= malloc(sizeof(ProcessingDataText
));
92 syncState
->processingData
= processingData
;
93 va_start(ap
, syncState
);
94 testCaseName
= va_arg(ap
, const char*);
97 processingData
->testCase
= fopen(testCaseName
, "r");
98 if (processingData
->testCase
== NULL
)
100 g_error(strerror(errno
));
102 syncState
->traceNb
= readTraceNb(processingData
->testCase
);
104 if (syncState
->stats
)
106 processingData
->factors
= NULL
;
111 static void destroyProcessingText(SyncState
* const syncState
)
113 ProcessingDataText
* processingData
= (ProcessingDataText
*)
114 syncState
->processingData
;
116 if (processingData
== NULL
)
121 fclose(processingData
->testCase
);
123 if (syncState
->stats
&& processingData
->factors
)
125 g_array_free(processingData
->factors
, TRUE
);
128 free(syncState
->processingData
);
129 syncState
->processingData
= NULL
;
134 * Read the test case file and make up events. Dispatch those events to the
138 * syncState: container for synchronization data.
141 * Factors[traceNb] synchronization factors for each trace
143 static GArray
* finalizeProcessingText(SyncState
* const syncState
)
148 ProcessingDataText
* processingData
= (ProcessingDataText
*)
149 syncState
->processingData
;
150 FILE* testCase
= processingData
->testCase
;
154 seq
= calloc(syncState
->traceNb
, sizeof(unsigned int));
156 skipCommentLines(testCase
);
157 retval
= getline(&line
, &bufLen
, testCase
);
158 while(!feof(testCase
))
160 unsigned int sender
, receiver
;
161 double sendTime
, recvTime
;
165 if (retval
== -1 && !feof(testCase
))
167 g_error(strerror(errno
));
170 if (line
[retval
- 1] == '\n')
172 line
[retval
- 1]= '\0';
175 retval
= sscanf(line
, " %u %u %lf %lf %c", &sender
, &receiver
,
176 &sendTime
, &recvTime
, &tmp
);
179 g_error(strerror(errno
));
181 else if (retval
!= 4)
183 g_error("Error parsing test file while looking for data point, line was '%s'", line
);
186 if (sender
+ 1 > syncState
->traceNb
)
188 g_error("Error parsing test file, sender is out of range, line was '%s'", line
);
191 if (receiver
+ 1 > syncState
->traceNb
)
193 g_error("Error parsing test file, receiver is out of range, line was '%s'", line
);
198 g_error("Error parsing test file, send time is negative, line was '%s'", line
);
203 g_error("Error parsing test file, receive time is negative, line was '%s'", line
);
206 // Generate ouput and input events
208 unsigned int addressOffset
;
210 unsigned int traceNum
;
212 enum Direction direction
;
214 {sender
, sendTime
, OUT
},
215 {receiver
, recvTime
, IN
},
218 /* addressOffset is added to a traceNum to convert it to an address so
219 * that the address is not plainly the same as the traceNb. */
220 if (syncState
->traceNb
> 1)
222 addressOffset
= pow(10, floor(log(syncState
->traceNb
- 1) /
230 for (i
= 0; i
< sizeof(loopValues
) / sizeof(*loopValues
); i
++)
234 event
= malloc(sizeof(Event
));
235 event
->traceNum
= loopValues
[i
].traceNum
;
236 event
->wallTime
.seconds
= floor(loopValues
[i
].time
);
237 event
->wallTime
.nanosec
= floor((loopValues
[i
].time
-
238 floor(loopValues
[i
].time
)) * NANOSECONDS_PER_SECOND
);
239 event
->cpuTime
= round(loopValues
[i
].time
* CPU_FREQ
);
241 event
->destroy
= &destroyTCPEvent
;
242 event
->event
.tcpEvent
= malloc(sizeof(TCPEvent
));
243 event
->event
.tcpEvent
->direction
= loopValues
[i
].direction
;
244 event
->event
.tcpEvent
->segmentKey
= malloc(sizeof(SegmentKey
));
245 event
->event
.tcpEvent
->segmentKey
->ihl
= 5;
246 event
->event
.tcpEvent
->segmentKey
->tot_len
= 40;
247 event
->event
.tcpEvent
->segmentKey
->connectionKey
.saddr
= sender
+
249 event
->event
.tcpEvent
->segmentKey
->connectionKey
.daddr
= receiver
+
251 event
->event
.tcpEvent
->segmentKey
->connectionKey
.source
= 57645;
252 event
->event
.tcpEvent
->segmentKey
->connectionKey
.dest
= 80;
253 event
->event
.tcpEvent
->segmentKey
->seq
= seq
[sender
];
254 event
->event
.tcpEvent
->segmentKey
->ack_seq
= 0;
255 event
->event
.tcpEvent
->segmentKey
->doff
= 5;
256 event
->event
.tcpEvent
->segmentKey
->ack
= 0;
257 event
->event
.tcpEvent
->segmentKey
->rst
= 0;
258 event
->event
.tcpEvent
->segmentKey
->syn
= 1;
259 event
->event
.tcpEvent
->segmentKey
->fin
= 0;
261 syncState
->matchingModule
->matchEvent(syncState
, event
);
267 skipCommentLines(testCase
);
268 retval
= getline(&line
, &bufLen
, testCase
);
278 factors
= syncState
->matchingModule
->finalizeMatching(syncState
);
279 if (syncState
->stats
)
281 processingData
->factors
= factors
;
289 * Print statistics related to processing. Must be called after
290 * finalizeProcessing.
293 * syncState container for synchronization data.
295 static void printProcessingStatsText(SyncState
* const syncState
)
299 printf("Resulting synchronization factors:\n");
300 for (i
= 0; i
< syncState
->traceNb
; i
++)
302 Factors
* factors
= &g_array_index(((ProcessingDataText
*)
303 syncState
->processingData
)->factors
, Factors
, i
);
305 printf("\ttrace %u drift= %g offset= %g (%f)\n", i
, factors
->drift
,
306 factors
->offset
, factors
->offset
/ CPU_FREQ
);
312 * Read trace number from the test case stream. The trace number should be the
313 * first non-comment line and should be an unsigned int by itself on a line.
316 * testCase: test case stream
321 static unsigned int readTraceNb(FILE* testCase
)
329 skipCommentLines(testCase
);
330 retval
= getline(&line
, &len
, testCase
);
335 g_error("Unexpected end of file while looking for number of traces");
339 g_error(strerror(errno
));
342 if (line
[retval
- 1] == '\n')
344 line
[retval
- 1]= '\0';
347 retval
= sscanf(line
, " %u %c", &result
, &tmp
);
348 if (retval
== EOF
|| retval
!= 1)
350 g_error("Error parsing test file while looking for number of traces, line was '%s'", line
);
352 // Not really needed but avoids warning from gcc
366 * Advance testCase stream over empty space, empty lines and lines that begin
370 * testCase: test case stream
372 static void skipCommentLines(FILE* testCase
)
381 firstChar
= fgetc(testCase
);
382 if (firstChar
== (int) '#')
384 retval
= getline(&line
, &len
, testCase
);
393 g_error(strerror(errno
));
397 else if (firstChar
== (int) '\n' || firstChar
== (int) ' ')
399 else if (firstChar
== EOF
)
408 retval
= ungetc(firstChar
, testCase
);
411 g_error("Error: ungetc()");
423 * Write the processing-specific variables in the gnuplot script.
426 * syncState: container for synchronization data
429 static void writeProcessingGraphVariablesText(SyncState
* const syncState
,
430 const unsigned int i
)
432 fprintf(syncState
->graphsStream
, "clock_freq_%u= %.3f\n", i
, CPU_FREQ
);
437 * Write the processing-specific options in the gnuplot script.
440 * syncState: container for synchronization data
441 * i: first trace number
442 * j: second trace number, garanteed to be larger than i
444 static void writeProcessingTraceTraceOptionsText(SyncState
* const syncState
,
445 const unsigned int i
, const unsigned int j
)
447 fprintf(syncState
->graphsStream
,
448 "set key inside right bottom\n"
449 "set xlabel \"Clock %1$u\"\n"
450 "set xtics nomirror\n"
451 "set ylabel \"Clock %2$u\"\n"
452 "set ytics nomirror\n"
453 "set x2label \"Clock %1$d (s)\"\n"
454 "set x2range [GPVAL_X_MIN / clock_freq_%1$u : GPVAL_X_MAX / clock_freq_%1$u]\n"
456 "set y2label \"Clock %2$d (s)\"\n"
457 "set y2range [GPVAL_Y_MIN / clock_freq_%2$u : GPVAL_Y_MAX / clock_freq_%2$u]\n"
458 "set y2tics\n", i
, j
);
463 * Write the processing-specific options in the gnuplot script.
466 * syncState: container for synchronization data
467 * i: first trace number
468 * j: second trace number, garanteed to be larger than i
470 static void writeProcessingTraceTimeOptionsText(SyncState
* const syncState
,
471 const unsigned int i
, const unsigned int j
)
473 fprintf(syncState
->graphsStream
,
474 "set key inside right bottom\n"
475 "set xlabel \"Clock %1$u\"\n"
476 "set xtics nomirror\n"
477 "set ylabel \"time (s)\"\n"
478 "set ytics nomirror\n"
479 "set x2label \"Clock %1$d (s)\"\n"
480 "set x2range [GPVAL_X_MIN / clock_freq_%1$u : GPVAL_X_MAX / clock_freq_%1$u]\n"