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,
19 #define _ISOC99_SOURCE
25 #include <linux/if_ether.h>
27 #include <netinet/in.h>
32 #include "sync_chain.h"
33 #include "event_processing_lttng_common.h"
35 #include "event_processing_lttng_standard.h"
39 #define g_info(format...) g_log (G_LOG_DOMAIN, G_LOG_LEVEL_INFO, format)
43 // Functions common to all processing modules
44 static void initProcessingLTTVStandard(SyncState
* const syncState
,
45 LttvTracesetContext
* const traceSetContext
);
46 static void destroyProcessingLTTVStandard(SyncState
* const syncState
);
48 static void finalizeProcessingLTTVStandard(SyncState
* const syncState
);
49 static void printProcessingStatsLTTVStandard(SyncState
* const syncState
);
50 static void writeProcessingGraphsOptionsLTTVStandard(FILE* stream
, SyncState
*
51 const syncState
, const unsigned int i
, const unsigned int j
);
53 // Functions specific to this module
54 static void registerProcessingLTTVStandard() __attribute__((constructor (102)));
55 static gboolean
processEventLTTVStandard(void* hookData
, void* callData
);
56 static void partialDestroyProcessingLTTVStandard(SyncState
* const syncState
);
59 static ProcessingModule processingModuleLTTVStandard
= {
60 .name
= "LTTV-standard",
61 .initProcessing
= &initProcessingLTTVStandard
,
62 .destroyProcessing
= &destroyProcessingLTTVStandard
,
63 .finalizeProcessing
= &finalizeProcessingLTTVStandard
,
64 .printProcessingStats
= &printProcessingStatsLTTVStandard
,
65 .writeProcessingGraphsPlots
= NULL
,
66 .writeProcessingGraphsOptions
= &writeProcessingGraphsOptionsLTTVStandard
,
72 * Processing Module registering function
74 static void registerProcessingLTTVStandard()
76 g_queue_push_tail(&processingModules
, &processingModuleLTTVStandard
);
83 * Allocate and initialize data structures for synchronizing a traceset.
84 * Register event hooks.
87 * syncState: container for synchronization data.
88 * This function allocates these processingData members:
93 * traceSetContext: set of LTTV traces
95 static void initProcessingLTTVStandard(SyncState
* const syncState
, LttvTracesetContext
*
96 const traceSetContext
)
99 ProcessingDataLTTVStandard
* processingData
;
101 processingData
= malloc(sizeof(ProcessingDataLTTVStandard
));
102 syncState
->processingData
= processingData
;
103 processingData
->traceSetContext
= traceSetContext
;
105 if (syncState
->stats
)
107 processingData
->stats
= calloc(1, sizeof(ProcessingStatsLTTVStandard
));
111 processingData
->stats
= NULL
;
114 processingData
->traceNumTable
= g_hash_table_new(&g_direct_hash
, NULL
);
115 processingData
->hookListList
= g_array_sized_new(FALSE
, FALSE
,
116 sizeof(GArray
*), syncState
->traceNb
);
117 processingData
->pendingRecv
= malloc(sizeof(GHashTable
*) *
120 for(i
= 0; i
< syncState
->traceNb
; i
++)
122 g_hash_table_insert(processingData
->traceNumTable
,
123 processingData
->traceSetContext
->traces
[i
]->t
, (gpointer
) i
);
126 for(i
= 0; i
< syncState
->traceNb
; i
++)
128 processingData
->pendingRecv
[i
]= g_hash_table_new_full(&g_direct_hash
,
129 NULL
, NULL
, &gdnDestroyEvent
);
132 registerHooks(processingData
->hookListList
, traceSetContext
,
133 &processEventLTTVStandard
, syncState
,
134 syncState
->matchingModule
->canMatch
);
139 * Call the partial processing destroyer, obtain and adjust the factors from
143 * syncState container for synchronization data.
145 static void finalizeProcessingLTTVStandard(SyncState
* const syncState
)
149 double minOffset
, minDrift
;
150 unsigned int refFreqTrace
;
151 ProcessingDataLTTVStandard
* processingData
;
153 processingData
= (ProcessingDataLTTVStandard
*) syncState
->processingData
;
155 partialDestroyProcessingLTTVStandard(syncState
);
157 factors
= syncState
->matchingModule
->finalizeMatching(syncState
);
159 /* The offsets are adjusted so the lowest one is 0. This is done because
160 * of a Lttv specific limitation: events cannot have negative times. By
161 * having non-negative offsets, events cannot be moved backwards to
165 for (i
= 0; i
< syncState
->traceNb
; i
++)
167 minOffset
= MIN(g_array_index(factors
, Factors
, i
).offset
, minOffset
);
170 for (i
= 0; i
< syncState
->traceNb
; i
++)
172 g_array_index(factors
, Factors
, i
).offset
-= minOffset
;
175 /* Because the timestamps are corrected at the TSC level (not at the
176 * LttTime level) all trace frequencies must be made equal. We choose to
177 * use the frequency of the system with the lowest drift
181 for (i
= 0; i
< syncState
->traceNb
; i
++)
183 if (g_array_index(factors
, Factors
, i
).drift
< minDrift
)
185 minDrift
= g_array_index(factors
, Factors
, i
).drift
;
189 g_assert(syncState
->traceNb
== 0 || minDrift
!= INFINITY
);
191 // Write the factors to the LttTrace structures
192 for (i
= 0; i
< syncState
->traceNb
; i
++)
195 Factors
* traceFactors
;
197 t
= processingData
->traceSetContext
->traces
[i
]->t
;
198 traceFactors
= &g_array_index(factors
, Factors
, i
);
200 t
->drift
= traceFactors
->drift
;
201 t
->offset
= traceFactors
->offset
;
203 processingData
->traceSetContext
->traces
[refFreqTrace
]->t
->start_freq
;
205 processingData
->traceSetContext
->traces
[refFreqTrace
]->t
->freq_scale
;
206 t
->start_time_from_tsc
=
207 ltt_time_from_uint64(tsc_to_uint64(t
->freq_scale
, t
->start_freq
,
208 t
->drift
* t
->start_tsc
+ t
->offset
));
211 g_array_free(factors
, TRUE
);
213 lttv_traceset_context_compute_time_span(processingData
->traceSetContext
,
214 &processingData
->traceSetContext
->time_span
);
216 g_debug("traceset start %ld.%09ld end %ld.%09ld\n",
217 processingData
->traceSetContext
->time_span
.start_time
.tv_sec
,
218 processingData
->traceSetContext
->time_span
.start_time
.tv_nsec
,
219 processingData
->traceSetContext
->time_span
.end_time
.tv_sec
,
220 processingData
->traceSetContext
->time_span
.end_time
.tv_nsec
);
225 * Print statistics related to processing Must be called after
226 * finalizeProcessing.
229 * syncState container for synchronization data.
231 static void printProcessingStatsLTTVStandard(SyncState
* const syncState
)
233 ProcessingDataLTTVStandard
* processingData
;
235 if (!syncState
->stats
)
240 processingData
= (ProcessingDataLTTVStandard
*) syncState
->processingData
;
242 printf("LTTV processing stats:\n");
243 printf("\treceived frames: %d\n", processingData
->stats
->totRecv
);
244 printf("\treceived frames that are IP: %d\n",
245 processingData
->stats
->totRecvIp
);
246 if (syncState
->matchingModule
->canMatch
[TCP
])
248 printf("\treceived and processed packets that are TCP: %d\n",
249 processingData
->stats
->totRecvTCP
);
251 if (syncState
->matchingModule
->canMatch
[UDP
])
253 printf("\treceived and processed packets that are UDP: %d\n",
254 processingData
->stats
->totRecvUDP
);
256 if (syncState
->matchingModule
->canMatch
[TCP
])
258 printf("\tsent packets that are TCP: %d\n",
259 processingData
->stats
->totOutE
);
265 * Unregister event hooks. Deallocate processingData.
268 * syncState: container for synchronization data.
269 * This function deallocates these processingData members:
272 static void destroyProcessingLTTVStandard(SyncState
* const syncState
)
274 ProcessingDataLTTVStandard
* processingData
;
276 processingData
= (ProcessingDataLTTVStandard
*) syncState
->processingData
;
278 if (processingData
== NULL
)
283 partialDestroyProcessingLTTVStandard(syncState
);
285 if (syncState
->stats
)
287 free(processingData
->stats
);
290 free(syncState
->processingData
);
291 syncState
->processingData
= NULL
;
296 * Unregister event hooks. Deallocate some of processingData.
298 * This function can be called right after the events have been processed to
299 * free some data structures that are not needed for finalization.
302 * syncState: container for synchronization data.
303 * This function deallocates these members:
308 static void partialDestroyProcessingLTTVStandard(SyncState
* const syncState
)
311 ProcessingDataLTTVStandard
* processingData
;
313 processingData
= (ProcessingDataLTTVStandard
*) syncState
->processingData
;
315 if (processingData
== NULL
|| processingData
->traceNumTable
== NULL
)
320 g_hash_table_destroy(processingData
->traceNumTable
);
321 processingData
->traceNumTable
= NULL
;
323 for(i
= 0; i
< syncState
->traceNb
; i
++)
326 g_debug("Cleaning up pendingRecv list\n");
327 g_hash_table_destroy(processingData
->pendingRecv
[i
]);
329 free(processingData
->pendingRecv
);
331 unregisterHooks(processingData
->hookListList
,
332 processingData
->traceSetContext
);
337 * Lttv hook function that will be called for network events
340 * hookData: LttvTraceHook* for the type of event that generated the call
341 * callData: LttvTracefileContext* at the moment of the event
344 * FALSE Always returns FALSE, meaning to keep processing hooks for
347 static gboolean
processEventLTTVStandard(void* hookData
, void* callData
)
349 LttvTraceHook
* traceHook
;
350 LttvTracefileContext
* tfc
;
356 unsigned long traceNum
;
357 struct marker_info
* info
;
358 SyncState
* syncState
;
359 ProcessingDataLTTVStandard
* processingData
;
361 traceHook
= (LttvTraceHook
*) hookData
;
362 tfc
= (LttvTracefileContext
*) callData
;
363 trace
= tfc
->t_context
->t
;
364 syncState
= (SyncState
*) traceHook
->hook_data
;
365 processingData
= (ProcessingDataLTTVStandard
*) syncState
->processingData
;
366 event
= ltt_tracefile_get_event(tfc
->tf
);
367 info
= marker_get_info_from_id(tfc
->tf
->mdata
, event
->event_id
);
368 tsc
= ltt_event_cycle_count(event
);
369 time
= ltt_event_time(event
);
370 wTime
.seconds
= time
.tv_sec
;
371 wTime
.nanosec
= time
.tv_nsec
;
373 g_assert(g_hash_table_lookup_extended(processingData
->traceNumTable
,
374 trace
, NULL
, (gpointer
*) &traceNum
));
376 g_debug("XXXX process event: time: %ld.%09ld trace: %ld (%p) name: %s ",
377 time
.tv_sec
, time
.tv_nsec
, traceNum
, trace
,
378 g_quark_to_string(info
->name
));
380 if (info
->name
== LTT_EVENT_DEV_XMIT_EXTENDED
)
384 if (!ltt_event_get_unsigned(event
,
385 lttv_trace_get_hook_field(traceHook
, 1)) == ETH_P_IP
||
386 !ltt_event_get_unsigned(event
,
387 lttv_trace_get_hook_field(traceHook
, 2)) == IPPROTO_TCP
)
392 if (!syncState
->matchingModule
->canMatch
[TCP
])
397 if (syncState
->stats
)
399 processingData
->stats
->totOutE
++;
402 outE
= malloc(sizeof(Event
));
403 outE
->traceNum
= traceNum
;
405 outE
->wallTime
= wTime
;
407 outE
->copy
= ©TCPEvent
;
408 outE
->destroy
= &destroyTCPEvent
;
409 outE
->event
.tcpEvent
= malloc(sizeof(TCPEvent
));
410 outE
->event
.tcpEvent
->direction
= OUT
;
411 outE
->event
.tcpEvent
->segmentKey
= malloc(sizeof(SegmentKey
));
412 outE
->event
.tcpEvent
->segmentKey
->connectionKey
.saddr
=
413 htonl(ltt_event_get_unsigned(event
,
414 lttv_trace_get_hook_field(traceHook
, 3)));
415 outE
->event
.tcpEvent
->segmentKey
->connectionKey
.daddr
=
416 htonl(ltt_event_get_unsigned(event
,
417 lttv_trace_get_hook_field(traceHook
, 4)));
418 outE
->event
.tcpEvent
->segmentKey
->tot_len
=
419 ltt_event_get_unsigned(event
, lttv_trace_get_hook_field(traceHook
,
421 outE
->event
.tcpEvent
->segmentKey
->ihl
= ltt_event_get_unsigned(event
,
422 lttv_trace_get_hook_field(traceHook
, 6));
423 outE
->event
.tcpEvent
->segmentKey
->connectionKey
.source
=
424 ltt_event_get_unsigned(event
, lttv_trace_get_hook_field(traceHook
,
426 outE
->event
.tcpEvent
->segmentKey
->connectionKey
.dest
=
427 ltt_event_get_unsigned(event
, lttv_trace_get_hook_field(traceHook
,
429 outE
->event
.tcpEvent
->segmentKey
->seq
= ltt_event_get_unsigned(event
,
430 lttv_trace_get_hook_field(traceHook
, 9));
431 outE
->event
.tcpEvent
->segmentKey
->ack_seq
=
432 ltt_event_get_unsigned(event
, lttv_trace_get_hook_field(traceHook
,
434 outE
->event
.tcpEvent
->segmentKey
->doff
= ltt_event_get_unsigned(event
,
435 lttv_trace_get_hook_field(traceHook
, 11));
436 outE
->event
.tcpEvent
->segmentKey
->ack
= ltt_event_get_unsigned(event
,
437 lttv_trace_get_hook_field(traceHook
, 12));
438 outE
->event
.tcpEvent
->segmentKey
->rst
= ltt_event_get_unsigned(event
,
439 lttv_trace_get_hook_field(traceHook
, 13));
440 outE
->event
.tcpEvent
->segmentKey
->syn
= ltt_event_get_unsigned(event
,
441 lttv_trace_get_hook_field(traceHook
, 14));
442 outE
->event
.tcpEvent
->segmentKey
->fin
= ltt_event_get_unsigned(event
,
443 lttv_trace_get_hook_field(traceHook
, 15));
445 syncState
->matchingModule
->matchEvent(syncState
, outE
);
447 g_debug("Output event done\n");
449 else if (info
->name
== LTT_EVENT_DEV_RECEIVE
)
453 if (syncState
->stats
)
455 processingData
->stats
->totRecv
++;
458 protocol
= ltt_event_get_unsigned(event
,
459 lttv_trace_get_hook_field(traceHook
, 1));
461 if (protocol
== ETH_P_IP
)
466 if (syncState
->stats
)
468 processingData
->stats
->totRecvIp
++;
471 inE
= malloc(sizeof(Event
));
472 inE
->traceNum
= traceNum
;
474 inE
->wallTime
= wTime
;
475 inE
->event
.tcpEvent
= NULL
;
476 inE
->copy
= ©Event
;
477 inE
->destroy
= &destroyEvent
;
479 skb
= (void*) (long) ltt_event_get_long_unsigned(event
,
480 lttv_trace_get_hook_field(traceHook
, 0));
481 g_hash_table_replace(processingData
->pendingRecv
[traceNum
], skb
,
484 g_debug("Adding inE %p for skb %p to pendingRecv\n", inE
, skb
);
491 else if (info
->name
== LTT_EVENT_TCPV4_RCV_EXTENDED
)
496 // Search pendingRecv for an event with the same skb
497 skb
= (void*) (long) ltt_event_get_long_unsigned(event
,
498 lttv_trace_get_hook_field(traceHook
, 0));
501 g_hash_table_lookup(processingData
->pendingRecv
[traceNum
], skb
);
504 // This should only happen in case of lost events
505 g_warning("No matching pending receive event found");
509 if (syncState
->stats
)
511 processingData
->stats
->totRecvTCP
++;
514 // If it's there, remove it and proceed with a receive event
515 g_hash_table_steal(processingData
->pendingRecv
[traceNum
], skb
);
518 inE
->event
.tcpEvent
= malloc(sizeof(TCPEvent
));
519 inE
->copy
= ©TCPEvent
;
520 inE
->destroy
= &destroyTCPEvent
;
521 inE
->event
.tcpEvent
->direction
= IN
;
522 inE
->event
.tcpEvent
->segmentKey
= malloc(sizeof(SegmentKey
));
523 inE
->event
.tcpEvent
->segmentKey
->connectionKey
.saddr
=
524 htonl(ltt_event_get_unsigned(event
,
525 lttv_trace_get_hook_field(traceHook
, 1)));
526 inE
->event
.tcpEvent
->segmentKey
->connectionKey
.daddr
=
527 htonl(ltt_event_get_unsigned(event
,
528 lttv_trace_get_hook_field(traceHook
, 2)));
529 inE
->event
.tcpEvent
->segmentKey
->tot_len
=
530 ltt_event_get_unsigned(event
,
531 lttv_trace_get_hook_field(traceHook
, 3));
532 inE
->event
.tcpEvent
->segmentKey
->ihl
=
533 ltt_event_get_unsigned(event
,
534 lttv_trace_get_hook_field(traceHook
, 4));
535 inE
->event
.tcpEvent
->segmentKey
->connectionKey
.source
=
536 ltt_event_get_unsigned(event
,
537 lttv_trace_get_hook_field(traceHook
, 5));
538 inE
->event
.tcpEvent
->segmentKey
->connectionKey
.dest
=
539 ltt_event_get_unsigned(event
,
540 lttv_trace_get_hook_field(traceHook
, 6));
541 inE
->event
.tcpEvent
->segmentKey
->seq
=
542 ltt_event_get_unsigned(event
,
543 lttv_trace_get_hook_field(traceHook
, 7));
544 inE
->event
.tcpEvent
->segmentKey
->ack_seq
=
545 ltt_event_get_unsigned(event
,
546 lttv_trace_get_hook_field(traceHook
, 8));
547 inE
->event
.tcpEvent
->segmentKey
->doff
=
548 ltt_event_get_unsigned(event
,
549 lttv_trace_get_hook_field(traceHook
, 9));
550 inE
->event
.tcpEvent
->segmentKey
->ack
=
551 ltt_event_get_unsigned(event
,
552 lttv_trace_get_hook_field(traceHook
, 10));
553 inE
->event
.tcpEvent
->segmentKey
->rst
=
554 ltt_event_get_unsigned(event
,
555 lttv_trace_get_hook_field(traceHook
, 11));
556 inE
->event
.tcpEvent
->segmentKey
->syn
=
557 ltt_event_get_unsigned(event
,
558 lttv_trace_get_hook_field(traceHook
, 12));
559 inE
->event
.tcpEvent
->segmentKey
->fin
=
560 ltt_event_get_unsigned(event
,
561 lttv_trace_get_hook_field(traceHook
, 13));
563 syncState
->matchingModule
->matchEvent(syncState
, inE
);
565 g_debug("TCP input event %p for skb %p done\n", inE
, skb
);
568 else if (info
->name
== LTT_EVENT_UDPV4_RCV_EXTENDED
)
573 // Search pendingRecv for an event with the same skb
574 skb
= (void*) (long) ltt_event_get_long_unsigned(event
,
575 lttv_trace_get_hook_field(traceHook
, 0));
578 g_hash_table_lookup(processingData
->pendingRecv
[traceNum
], skb
);
581 // This should only happen in case of lost events
582 g_warning("No matching pending receive event found");
588 if (syncState
->stats
)
590 processingData
->stats
->totRecvUDP
++;
593 // If it's there, remove it and proceed with a receive event
594 g_hash_table_steal(processingData
->pendingRecv
[traceNum
], skb
);
597 inE
->event
.udpEvent
= malloc(sizeof(UDPEvent
));
598 inE
->copy
= ©UDPEvent
;
599 inE
->destroy
= &destroyUDPEvent
;
600 inE
->event
.udpEvent
->direction
= IN
;
601 inE
->event
.udpEvent
->datagramKey
= malloc(sizeof(DatagramKey
));
602 inE
->event
.udpEvent
->datagramKey
->saddr
=
603 htonl(ltt_event_get_unsigned(event
,
604 lttv_trace_get_hook_field(traceHook
, 1)));
605 inE
->event
.udpEvent
->datagramKey
->daddr
=
606 htonl(ltt_event_get_unsigned(event
,
607 lttv_trace_get_hook_field(traceHook
, 2)));
608 inE
->event
.udpEvent
->unicast
= ltt_event_get_unsigned(event
,
609 lttv_trace_get_hook_field(traceHook
, 3)) == 0 ? false : true;
610 inE
->event
.udpEvent
->datagramKey
->ulen
=
611 ltt_event_get_unsigned(event
,
612 lttv_trace_get_hook_field(traceHook
, 4));
613 inE
->event
.udpEvent
->datagramKey
->source
=
614 ltt_event_get_unsigned(event
,
615 lttv_trace_get_hook_field(traceHook
, 5));
616 inE
->event
.udpEvent
->datagramKey
->dest
=
617 ltt_event_get_unsigned(event
,
618 lttv_trace_get_hook_field(traceHook
, 6));
619 dataStart
= ltt_event_get_long_unsigned(event
,
620 lttv_trace_get_hook_field(traceHook
, 7));
621 g_assert_cmpuint(sizeof(inE
->event
.udpEvent
->datagramKey
->dataKey
),
622 ==, sizeof(guint64
));
623 if (inE
->event
.udpEvent
->datagramKey
->ulen
- 8 >=
624 sizeof(inE
->event
.udpEvent
->datagramKey
->dataKey
))
626 memcpy(inE
->event
.udpEvent
->datagramKey
->dataKey
, &dataStart
,
627 sizeof(inE
->event
.udpEvent
->datagramKey
->dataKey
));
631 memset(inE
->event
.udpEvent
->datagramKey
->dataKey
, 0,
632 sizeof(inE
->event
.udpEvent
->datagramKey
->dataKey
));
633 memcpy(inE
->event
.udpEvent
->datagramKey
->dataKey
, &dataStart
,
634 inE
->event
.udpEvent
->datagramKey
->ulen
- 8);
637 syncState
->matchingModule
->matchEvent(syncState
, inE
);
639 g_debug("UDP input event %p for skb %p done\n", inE
, skb
);
644 g_assert_not_reached();
652 * Write the processing-specific options in the gnuplot script.
655 * stream: stream where to write the data
656 * syncState: container for synchronization data
657 * i: first trace number
658 * j: second trace number, garanteed to be larger than i
660 static void writeProcessingGraphsOptionsLTTVStandard(FILE* stream
, SyncState
*
661 const syncState
, const unsigned int i
, const unsigned int j
)
663 ProcessingDataLTTVStandard
* processingData
;
664 LttTrace
* traceI
, * traceJ
;
666 processingData
= (ProcessingDataLTTVStandard
*) syncState
->processingData
;
668 traceI
= processingData
->traceSetContext
->traces
[i
]->t
;
669 traceJ
= processingData
->traceSetContext
->traces
[j
]->t
;
672 "set key inside right bottom\n"
673 "set xlabel \"Clock %1$u\"\n"
674 "set xtics nomirror\n"
675 "set ylabel \"Clock %3$u\"\n"
676 "set ytics nomirror\n"
677 "set x2label \"Clock %1$d (s)\"\n"
678 "set x2range [GPVAL_X_MIN / %2$.1f : GPVAL_X_MAX / %2$.1f]\n"
680 "set y2label \"Clock %3$d (s)\"\n"
681 "set y2range [GPVAL_Y_MIN / %4$.1f : GPVAL_Y_MAX / %4$.1f]\n"
682 "set y2tics\n", i
, (double) traceI
->start_freq
/ traceI
->freq_scale
,
683 j
, (double) traceJ
->start_freq
/ traceJ
->freq_scale
);