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 void 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.
140 static void finalizeProcessingText(SyncState
* const syncState
)
145 ProcessingDataText
* processingData
= (ProcessingDataText
*)
146 syncState
->processingData
;
147 FILE* testCase
= processingData
->testCase
;
151 seq
= calloc(syncState
->traceNb
, sizeof(unsigned int));
153 skipCommentLines(testCase
);
154 retval
= getline(&line
, &bufLen
, testCase
);
155 while(!feof(testCase
))
157 unsigned int sender
, receiver
;
158 double sendTime
, recvTime
;
162 if (retval
== -1 && !feof(testCase
))
164 g_error(strerror(errno
));
167 if (line
[retval
- 1] == '\n')
169 line
[retval
- 1]= '\0';
172 retval
= sscanf(line
, " %u %u %lf %lf %c", &sender
, &receiver
,
173 &sendTime
, &recvTime
, &tmp
);
176 g_error(strerror(errno
));
178 else if (retval
!= 4)
180 g_error("Error parsing test file while looking for data point, line was '%s'", line
);
183 if (sender
+ 1 > syncState
->traceNb
)
185 g_error("Error parsing test file, sender is out of range, line was '%s'", line
);
188 if (receiver
+ 1 > syncState
->traceNb
)
190 g_error("Error parsing test file, receiver is out of range, line was '%s'", line
);
195 g_error("Error parsing test file, send time is negative, line was '%s'", line
);
200 g_error("Error parsing test file, receive time is negative, line was '%s'", line
);
203 // Generate ouput and input events
205 unsigned int addressOffset
;
207 unsigned int traceNum
;
209 enum Direction direction
;
211 {sender
, sendTime
, OUT
},
212 {receiver
, recvTime
, IN
},
215 /* addressOffset is added to a traceNum to convert it to an address so
216 * that the address is not plainly the same as the traceNb. */
217 if (syncState
->traceNb
> 1)
219 addressOffset
= pow(10, floor(log(syncState
->traceNb
- 1) /
227 for (i
= 0; i
< sizeof(loopValues
) / sizeof(*loopValues
); i
++)
231 event
= malloc(sizeof(Event
));
232 event
->traceNum
= loopValues
[i
].traceNum
;
233 event
->wallTime
.seconds
= floor(loopValues
[i
].time
);
234 event
->wallTime
.nanosec
= floor((loopValues
[i
].time
-
235 floor(loopValues
[i
].time
)) * NANOSECONDS_PER_SECOND
);
236 event
->cpuTime
= round(loopValues
[i
].time
* CPU_FREQ
);
238 event
->destroy
= &destroyTCPEvent
;
239 event
->event
.tcpEvent
= malloc(sizeof(TCPEvent
));
240 event
->event
.tcpEvent
->direction
= loopValues
[i
].direction
;
241 event
->event
.tcpEvent
->segmentKey
= malloc(sizeof(SegmentKey
));
242 event
->event
.tcpEvent
->segmentKey
->ihl
= 5;
243 event
->event
.tcpEvent
->segmentKey
->tot_len
= 40;
244 event
->event
.tcpEvent
->segmentKey
->connectionKey
.saddr
= sender
+
246 event
->event
.tcpEvent
->segmentKey
->connectionKey
.daddr
= receiver
+
248 event
->event
.tcpEvent
->segmentKey
->connectionKey
.source
= 57645;
249 event
->event
.tcpEvent
->segmentKey
->connectionKey
.dest
= 80;
250 event
->event
.tcpEvent
->segmentKey
->seq
= seq
[sender
];
251 event
->event
.tcpEvent
->segmentKey
->ack_seq
= 0;
252 event
->event
.tcpEvent
->segmentKey
->doff
= 5;
253 event
->event
.tcpEvent
->segmentKey
->ack
= 0;
254 event
->event
.tcpEvent
->segmentKey
->rst
= 0;
255 event
->event
.tcpEvent
->segmentKey
->syn
= 1;
256 event
->event
.tcpEvent
->segmentKey
->fin
= 0;
258 syncState
->matchingModule
->matchEvent(syncState
, event
);
264 skipCommentLines(testCase
);
265 retval
= getline(&line
, &bufLen
, testCase
);
275 factors
= syncState
->matchingModule
->finalizeMatching(syncState
);
276 if (syncState
->stats
)
278 processingData
->factors
= factors
;
282 g_array_free(factors
, TRUE
);
288 * Print statistics related to processing. Must be called after
289 * finalizeProcessing.
292 * syncState container for synchronization data.
294 static void printProcessingStatsText(SyncState
* const syncState
)
298 printf("Resulting synchronization factors:\n");
299 for (i
= 0; i
< syncState
->traceNb
; i
++)
301 Factors
* factors
= &g_array_index(((ProcessingDataText
*)
302 syncState
->processingData
)->factors
, Factors
, i
);
304 printf("\ttrace %u drift= %g offset= %g (%f)\n", i
, factors
->drift
,
305 factors
->offset
, factors
->offset
/ CPU_FREQ
);
311 * Read trace number from the test case stream. The trace number should be the
312 * first non-comment line and should be an unsigned int by itself on a line.
315 * testCase: test case stream
320 static unsigned int readTraceNb(FILE* testCase
)
328 skipCommentLines(testCase
);
329 retval
= getline(&line
, &len
, testCase
);
334 g_error("Unexpected end of file while looking for number of traces");
338 g_error(strerror(errno
));
341 if (line
[retval
- 1] == '\n')
343 line
[retval
- 1]= '\0';
346 retval
= sscanf(line
, " %u %c", &result
, &tmp
);
347 if (retval
== EOF
|| retval
!= 1)
349 g_error("Error parsing test file while looking for number of traces, line was '%s'", line
);
351 // Not really needed but avoids warning from gcc
365 * Advance testCase stream over empty space, empty lines and lines that begin
369 * testCase: test case stream
371 static void skipCommentLines(FILE* testCase
)
380 firstChar
= fgetc(testCase
);
381 if (firstChar
== (int) '#')
383 retval
= getline(&line
, &len
, testCase
);
392 g_error(strerror(errno
));
396 else if (firstChar
== (int) '\n' || firstChar
== (int) ' ')
398 else if (firstChar
== EOF
)
407 retval
= ungetc(firstChar
, testCase
);
410 g_error("Error: ungetc()");
422 * Write the processing-specific variables in the gnuplot script.
425 * syncState: container for synchronization data
428 static void writeProcessingGraphVariablesText(SyncState
* const syncState
,
429 const unsigned int i
)
431 fprintf(syncState
->graphsStream
, "clock_freq_%u= %.3f\n", i
, CPU_FREQ
);
436 * Write the processing-specific options in the gnuplot script.
439 * syncState: container for synchronization data
440 * i: first trace number
441 * j: second trace number, garanteed to be larger than i
443 static void writeProcessingTraceTraceOptionsText(SyncState
* const syncState
,
444 const unsigned int i
, const unsigned int j
)
446 fprintf(syncState
->graphsStream
,
447 "set key inside right bottom\n"
448 "set xlabel \"Clock %1$u\"\n"
449 "set xtics nomirror\n"
450 "set ylabel \"Clock %2$u\"\n"
451 "set ytics nomirror\n"
452 "set x2label \"Clock %1$d (s)\"\n"
453 "set x2range [GPVAL_X_MIN / clock_freq_%1$u : GPVAL_X_MAX / clock_freq_%1$u]\n"
455 "set y2label \"Clock %2$d (s)\"\n"
456 "set y2range [GPVAL_Y_MIN / clock_freq_%2$u : GPVAL_Y_MAX / clock_freq_%2$u]\n"
457 "set y2tics\n", i
, j
);
462 * Write the processing-specific options in the gnuplot script.
465 * syncState: container for synchronization data
466 * i: first trace number
467 * j: second trace number, garanteed to be larger than i
469 static void writeProcessingTraceTimeOptionsText(SyncState
* const syncState
,
470 const unsigned int i
, const unsigned int j
)
472 fprintf(syncState
->graphsStream
,
473 "set key inside right bottom\n"
474 "set xlabel \"Clock %1$u\"\n"
475 "set xtics nomirror\n"
476 "set ylabel \"time (s)\"\n"
477 "set ytics nomirror\n"
478 "set x2label \"Clock %1$d (s)\"\n"
479 "set x2range [GPVAL_X_MIN / clock_freq_%1$u : GPVAL_X_MAX / clock_freq_%1$u]\n"