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/>.
22 #include <netinet/in.h>
28 #include "sync_chain.h"
29 #include "event_processing_lttng_common.h"
31 #include "event_processing_lttng_standard.h"
33 /* IPv4 Ethertype, taken from <linux/if_ether.h>, unlikely to change as it's
34 * defined by IANA: http://www.iana.org/assignments/ethernet-numbers
36 #define ETH_P_IP 0x0800
39 // Functions common to all processing modules
40 static void initProcessingLTTVStandard(SyncState
* const syncState
, ...);
41 static void destroyProcessingLTTVStandard(SyncState
* const syncState
);
43 static AllFactors
* finalizeProcessingLTTVStandard(SyncState
* const syncState
);
44 static void printProcessingStatsLTTVStandard(SyncState
* const syncState
);
45 static void writeProcessingGraphVariablesLTTVStandard(SyncState
* const
46 syncState
, const unsigned int i
);
47 static void writeProcessingTraceTraceOptionsLTTVStandard(SyncState
* const
48 syncState
, const unsigned int i
, const unsigned int j
);
49 static void writeProcessingTraceTimeOptionsLTTVStandard(SyncState
* const
50 syncState
, const unsigned int i
, const unsigned int j
);
52 // Functions specific to this module
53 static gboolean
processEventLTTVStandard(void* hookData
, void* callData
);
54 static void partialDestroyProcessingLTTVStandard(SyncState
* const syncState
);
57 static ProcessingModule processingModuleLTTVStandard
= {
58 .name
= "LTTV-standard",
59 .initProcessing
= &initProcessingLTTVStandard
,
60 .destroyProcessing
= &destroyProcessingLTTVStandard
,
61 .finalizeProcessing
= &finalizeProcessingLTTVStandard
,
62 .printProcessingStats
= &printProcessingStatsLTTVStandard
,
64 .writeVariables
= &writeProcessingGraphVariablesLTTVStandard
,
65 .writeTraceTraceOptions
= &writeProcessingTraceTraceOptionsLTTVStandard
,
66 .writeTraceTimeOptions
= &writeProcessingTraceTimeOptionsLTTVStandard
,
72 * Processing Module registering function
74 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: LttvTracesetContext*, set of LTTV traces
95 static void initProcessingLTTVStandard(SyncState
* const syncState
, ...)
98 ProcessingDataLTTVStandard
* processingData
;
101 processingData
= malloc(sizeof(ProcessingDataLTTVStandard
));
102 syncState
->processingData
= processingData
;
103 va_start(ap
, syncState
);
104 processingData
->traceSetContext
= va_arg(ap
, LttvTracesetContext
*);
107 lttv_traceset_number(processingData
->traceSetContext
->ts
);
108 processingData
->hookListList
= g_array_sized_new(FALSE
, FALSE
,
109 sizeof(GArray
*), syncState
->traceNb
);
111 processingData
->traceNumTable
= g_hash_table_new(&g_direct_hash
, NULL
);
112 for(i
= 0; i
< syncState
->traceNb
; i
++)
114 g_hash_table_insert(processingData
->traceNumTable
,
115 processingData
->traceSetContext
->traces
[i
]->t
,
116 GUINT_TO_POINTER(i
));
119 processingData
->pendingRecv
= malloc(sizeof(GHashTable
*) *
121 for(i
= 0; i
< syncState
->traceNb
; i
++)
123 processingData
->pendingRecv
[i
]= g_hash_table_new_full(&g_direct_hash
,
124 NULL
, NULL
, &gdnDestroyEvent
);
127 if (syncState
->stats
)
129 processingData
->stats
= calloc(1, sizeof(ProcessingStatsLTTVStandard
));
133 processingData
->stats
= NULL
;
136 if (syncState
->graphsStream
)
138 processingData
->graphs
= malloc(syncState
->traceNb
*
139 sizeof(ProcessingGraphsLTTVStandard
));
141 for(i
= 0; i
< syncState
->traceNb
; i
++)
143 LttTrace
* traceI
= processingData
->traceSetContext
->traces
[i
]->t
;
145 processingData
->graphs
[i
].startFreq
= traceI
->start_freq
;
146 processingData
->graphs
[i
].freqScale
= traceI
->freq_scale
;
151 processingData
->graphs
= NULL
;
154 registerHooks(processingData
->hookListList
,
155 processingData
->traceSetContext
, &processEventLTTVStandard
, syncState
,
156 syncState
->matchingModule
->canMatch
);
161 * Call the partial processing destroyer, obtain and the factors from
165 * syncState container for synchronization data.
168 * AllFactors synchronization factors for each trace pair
170 static AllFactors
* finalizeProcessingLTTVStandard(SyncState
* const syncState
)
172 partialDestroyProcessingLTTVStandard(syncState
);
174 return syncState
->matchingModule
->finalizeMatching(syncState
);
179 * Print statistics related to processing. Must be called after
180 * finalizeProcessing.
183 * syncState container for synchronization data.
185 static void printProcessingStatsLTTVStandard(SyncState
* const syncState
)
187 ProcessingDataLTTVStandard
* processingData
;
189 if (!syncState
->stats
)
194 processingData
= (ProcessingDataLTTVStandard
*) syncState
->processingData
;
196 printf("LTTV processing stats:\n");
197 printf("\treceived frames: %d\n", processingData
->stats
->totRecv
);
198 printf("\treceived frames that are IP: %d\n",
199 processingData
->stats
->totRecvIp
);
200 if (syncState
->matchingModule
->canMatch
[TCP
])
202 printf("\treceived and processed packets that are TCP: %d\n",
203 processingData
->stats
->totRecvTCP
);
205 if (syncState
->matchingModule
->canMatch
[UDP
])
207 printf("\treceived and processed packets that are UDP: %d\n",
208 processingData
->stats
->totRecvUDP
);
210 if (syncState
->matchingModule
->canMatch
[TCP
])
212 printf("\tsent packets that are TCP: %d\n",
213 processingData
->stats
->totOutE
);
219 * Unregister event hooks. Deallocate processingData.
222 * syncState: container for synchronization data.
223 * This function deallocates these processingData members:
226 static void destroyProcessingLTTVStandard(SyncState
* const syncState
)
228 ProcessingDataLTTVStandard
* processingData
;
230 processingData
= (ProcessingDataLTTVStandard
*) syncState
->processingData
;
232 if (processingData
== NULL
)
237 partialDestroyProcessingLTTVStandard(syncState
);
239 if (syncState
->stats
)
241 free(processingData
->stats
);
244 if (syncState
->graphsStream
)
246 free(processingData
->graphs
);
249 free(syncState
->processingData
);
250 syncState
->processingData
= NULL
;
255 * Unregister event hooks. Deallocate some of processingData.
257 * This function can be called right after the events have been processed to
258 * free some data structures that are not needed for finalization.
261 * syncState: container for synchronization data.
262 * This function deallocates these members:
267 static void partialDestroyProcessingLTTVStandard(SyncState
* const syncState
)
270 ProcessingDataLTTVStandard
* processingData
;
272 processingData
= (ProcessingDataLTTVStandard
*) syncState
->processingData
;
274 if (processingData
== NULL
|| processingData
->traceNumTable
== NULL
)
279 g_hash_table_destroy(processingData
->traceNumTable
);
280 processingData
->traceNumTable
= NULL
;
282 for(i
= 0; i
< syncState
->traceNb
; i
++)
285 g_debug("Cleaning up pendingRecv list");
286 g_hash_table_destroy(processingData
->pendingRecv
[i
]);
288 free(processingData
->pendingRecv
);
290 unregisterHooks(processingData
->hookListList
,
291 processingData
->traceSetContext
);
296 * Lttv hook function that will be called for network events
299 * hookData: LttvTraceHook* for the type of event that generated the call
300 * callData: LttvTracefileContext* at the moment of the event
303 * FALSE Always returns FALSE, meaning to keep processing hooks for
306 static gboolean
processEventLTTVStandard(void* hookData
, void* callData
)
308 LttvTraceHook
* traceHook
;
309 LttvTracefileContext
* tfc
;
315 unsigned long traceNum
;
316 struct marker_info
* info
;
317 SyncState
* syncState
;
318 ProcessingDataLTTVStandard
* processingData
;
321 traceHook
= (LttvTraceHook
*) hookData
;
322 tfc
= (LttvTracefileContext
*) callData
;
323 trace
= tfc
->t_context
->t
;
324 syncState
= (SyncState
*) traceHook
->hook_data
;
325 processingData
= (ProcessingDataLTTVStandard
*) syncState
->processingData
;
326 event
= ltt_tracefile_get_event(tfc
->tf
);
327 info
= marker_get_info_from_id(tfc
->tf
->mdata
, event
->event_id
);
328 tsc
= ltt_event_cycle_count(event
);
329 time
= ltt_event_time(event
);
330 wTime
.seconds
= time
.tv_sec
;
331 wTime
.nanosec
= time
.tv_nsec
;
333 g_assert(g_hash_table_lookup_extended(processingData
->traceNumTable
,
334 trace
, NULL
, &traceNumP
));
335 traceNum
= GPOINTER_TO_INT(traceNumP
);
337 g_debug("Process event: time: %ld.%09ld trace: %ld (%p) name: %s ",
338 time
.tv_sec
, time
.tv_nsec
, traceNum
, trace
,
339 g_quark_to_string(info
->name
));
341 if (info
->name
== LTT_EVENT_DEV_XMIT_EXTENDED
)
345 if (!ltt_event_get_unsigned(event
,
346 lttv_trace_get_hook_field(traceHook
, 1)) == ETH_P_IP
||
347 !ltt_event_get_unsigned(event
,
348 lttv_trace_get_hook_field(traceHook
, 2)) == IPPROTO_TCP
)
353 if (!syncState
->matchingModule
->canMatch
[TCP
])
358 if (syncState
->stats
)
360 processingData
->stats
->totOutE
++;
363 outE
= malloc(sizeof(Event
));
364 outE
->traceNum
= traceNum
;
366 outE
->wallTime
= wTime
;
368 outE
->copy
= ©TCPEvent
;
369 outE
->destroy
= &destroyTCPEvent
;
370 outE
->event
.tcpEvent
= malloc(sizeof(TCPEvent
));
371 outE
->event
.tcpEvent
->direction
= OUT
;
372 outE
->event
.tcpEvent
->segmentKey
= malloc(sizeof(SegmentKey
));
373 outE
->event
.tcpEvent
->segmentKey
->connectionKey
.saddr
=
374 htonl(ltt_event_get_unsigned(event
,
375 lttv_trace_get_hook_field(traceHook
, 3)));
376 outE
->event
.tcpEvent
->segmentKey
->connectionKey
.daddr
=
377 htonl(ltt_event_get_unsigned(event
,
378 lttv_trace_get_hook_field(traceHook
, 4)));
379 outE
->event
.tcpEvent
->segmentKey
->tot_len
=
380 ltt_event_get_unsigned(event
, lttv_trace_get_hook_field(traceHook
,
382 outE
->event
.tcpEvent
->segmentKey
->ihl
= ltt_event_get_unsigned(event
,
383 lttv_trace_get_hook_field(traceHook
, 6));
384 outE
->event
.tcpEvent
->segmentKey
->connectionKey
.source
=
385 ltt_event_get_unsigned(event
, lttv_trace_get_hook_field(traceHook
,
387 outE
->event
.tcpEvent
->segmentKey
->connectionKey
.dest
=
388 ltt_event_get_unsigned(event
, lttv_trace_get_hook_field(traceHook
,
390 outE
->event
.tcpEvent
->segmentKey
->seq
= ltt_event_get_unsigned(event
,
391 lttv_trace_get_hook_field(traceHook
, 9));
392 outE
->event
.tcpEvent
->segmentKey
->ack_seq
=
393 ltt_event_get_unsigned(event
, lttv_trace_get_hook_field(traceHook
,
395 outE
->event
.tcpEvent
->segmentKey
->doff
= ltt_event_get_unsigned(event
,
396 lttv_trace_get_hook_field(traceHook
, 11));
397 outE
->event
.tcpEvent
->segmentKey
->ack
= ltt_event_get_unsigned(event
,
398 lttv_trace_get_hook_field(traceHook
, 12));
399 outE
->event
.tcpEvent
->segmentKey
->rst
= ltt_event_get_unsigned(event
,
400 lttv_trace_get_hook_field(traceHook
, 13));
401 outE
->event
.tcpEvent
->segmentKey
->syn
= ltt_event_get_unsigned(event
,
402 lttv_trace_get_hook_field(traceHook
, 14));
403 outE
->event
.tcpEvent
->segmentKey
->fin
= ltt_event_get_unsigned(event
,
404 lttv_trace_get_hook_field(traceHook
, 15));
406 syncState
->matchingModule
->matchEvent(syncState
, outE
);
408 g_debug("Output event done");
410 else if (info
->name
== LTT_EVENT_DEV_RECEIVE
)
414 if (syncState
->stats
)
416 processingData
->stats
->totRecv
++;
419 protocol
= ltt_event_get_unsigned(event
,
420 lttv_trace_get_hook_field(traceHook
, 1));
422 if (protocol
== ETH_P_IP
)
427 if (syncState
->stats
)
429 processingData
->stats
->totRecvIp
++;
432 inE
= malloc(sizeof(Event
));
433 inE
->traceNum
= traceNum
;
435 inE
->wallTime
= wTime
;
436 inE
->event
.tcpEvent
= NULL
;
437 inE
->copy
= ©Event
;
438 inE
->destroy
= &destroyEvent
;
440 skb
= (void*) (long) ltt_event_get_long_unsigned(event
,
441 lttv_trace_get_hook_field(traceHook
, 0));
442 g_hash_table_replace(processingData
->pendingRecv
[traceNum
], skb
,
445 g_debug("Adding inE %p for skb %p to pendingRecv", inE
, skb
);
448 else if (info
->name
== LTT_EVENT_TCPV4_RCV_EXTENDED
)
453 // Search pendingRecv for an event with the same skb
454 skb
= (void*) (long) ltt_event_get_long_unsigned(event
,
455 lttv_trace_get_hook_field(traceHook
, 0));
458 g_hash_table_lookup(processingData
->pendingRecv
[traceNum
], skb
);
461 // This should only happen in case of lost events
462 g_warning("No matching pending receive event found");
466 if (syncState
->stats
)
468 processingData
->stats
->totRecvTCP
++;
471 // If it's there, remove it and proceed with a receive event
472 g_hash_table_steal(processingData
->pendingRecv
[traceNum
], skb
);
475 inE
->event
.tcpEvent
= malloc(sizeof(TCPEvent
));
476 inE
->copy
= ©TCPEvent
;
477 inE
->destroy
= &destroyTCPEvent
;
478 inE
->event
.tcpEvent
->direction
= IN
;
479 inE
->event
.tcpEvent
->segmentKey
= malloc(sizeof(SegmentKey
));
480 inE
->event
.tcpEvent
->segmentKey
->connectionKey
.saddr
=
481 htonl(ltt_event_get_unsigned(event
,
482 lttv_trace_get_hook_field(traceHook
, 1)));
483 inE
->event
.tcpEvent
->segmentKey
->connectionKey
.daddr
=
484 htonl(ltt_event_get_unsigned(event
,
485 lttv_trace_get_hook_field(traceHook
, 2)));
486 inE
->event
.tcpEvent
->segmentKey
->tot_len
=
487 ltt_event_get_unsigned(event
,
488 lttv_trace_get_hook_field(traceHook
, 3));
489 inE
->event
.tcpEvent
->segmentKey
->ihl
=
490 ltt_event_get_unsigned(event
,
491 lttv_trace_get_hook_field(traceHook
, 4));
492 inE
->event
.tcpEvent
->segmentKey
->connectionKey
.source
=
493 ltt_event_get_unsigned(event
,
494 lttv_trace_get_hook_field(traceHook
, 5));
495 inE
->event
.tcpEvent
->segmentKey
->connectionKey
.dest
=
496 ltt_event_get_unsigned(event
,
497 lttv_trace_get_hook_field(traceHook
, 6));
498 inE
->event
.tcpEvent
->segmentKey
->seq
=
499 ltt_event_get_unsigned(event
,
500 lttv_trace_get_hook_field(traceHook
, 7));
501 inE
->event
.tcpEvent
->segmentKey
->ack_seq
=
502 ltt_event_get_unsigned(event
,
503 lttv_trace_get_hook_field(traceHook
, 8));
504 inE
->event
.tcpEvent
->segmentKey
->doff
=
505 ltt_event_get_unsigned(event
,
506 lttv_trace_get_hook_field(traceHook
, 9));
507 inE
->event
.tcpEvent
->segmentKey
->ack
=
508 ltt_event_get_unsigned(event
,
509 lttv_trace_get_hook_field(traceHook
, 10));
510 inE
->event
.tcpEvent
->segmentKey
->rst
=
511 ltt_event_get_unsigned(event
,
512 lttv_trace_get_hook_field(traceHook
, 11));
513 inE
->event
.tcpEvent
->segmentKey
->syn
=
514 ltt_event_get_unsigned(event
,
515 lttv_trace_get_hook_field(traceHook
, 12));
516 inE
->event
.tcpEvent
->segmentKey
->fin
=
517 ltt_event_get_unsigned(event
,
518 lttv_trace_get_hook_field(traceHook
, 13));
520 syncState
->matchingModule
->matchEvent(syncState
, inE
);
522 g_debug("TCP input event %p for skb %p done", inE
, skb
);
525 else if (info
->name
== LTT_EVENT_UDPV4_RCV_EXTENDED
)
530 // Search pendingRecv for an event with the same skb
531 skb
= (void*) (long) ltt_event_get_long_unsigned(event
,
532 lttv_trace_get_hook_field(traceHook
, 0));
535 g_hash_table_lookup(processingData
->pendingRecv
[traceNum
], skb
);
538 // This should only happen in case of lost events
539 g_warning("No matching pending receive event found");
545 if (syncState
->stats
)
547 processingData
->stats
->totRecvUDP
++;
550 // If it's there, remove it and proceed with a receive event
551 g_hash_table_steal(processingData
->pendingRecv
[traceNum
], skb
);
554 inE
->event
.udpEvent
= malloc(sizeof(UDPEvent
));
555 inE
->copy
= ©UDPEvent
;
556 inE
->destroy
= &destroyUDPEvent
;
557 inE
->event
.udpEvent
->direction
= IN
;
558 inE
->event
.udpEvent
->datagramKey
= malloc(sizeof(DatagramKey
));
559 inE
->event
.udpEvent
->datagramKey
->saddr
=
560 htonl(ltt_event_get_unsigned(event
,
561 lttv_trace_get_hook_field(traceHook
, 1)));
562 inE
->event
.udpEvent
->datagramKey
->daddr
=
563 htonl(ltt_event_get_unsigned(event
,
564 lttv_trace_get_hook_field(traceHook
, 2)));
565 inE
->event
.udpEvent
->unicast
= ltt_event_get_unsigned(event
,
566 lttv_trace_get_hook_field(traceHook
, 3)) == 0 ? false : true;
567 inE
->event
.udpEvent
->datagramKey
->ulen
=
568 ltt_event_get_unsigned(event
,
569 lttv_trace_get_hook_field(traceHook
, 4));
570 inE
->event
.udpEvent
->datagramKey
->source
=
571 ltt_event_get_unsigned(event
,
572 lttv_trace_get_hook_field(traceHook
, 5));
573 inE
->event
.udpEvent
->datagramKey
->dest
=
574 ltt_event_get_unsigned(event
,
575 lttv_trace_get_hook_field(traceHook
, 6));
576 dataStart
= ltt_event_get_long_unsigned(event
,
577 lttv_trace_get_hook_field(traceHook
, 7));
578 g_assert_cmpuint(sizeof(inE
->event
.udpEvent
->datagramKey
->dataKey
),
579 ==, sizeof(guint64
));
580 if (inE
->event
.udpEvent
->datagramKey
->ulen
- 8 >=
581 sizeof(inE
->event
.udpEvent
->datagramKey
->dataKey
))
583 memcpy(inE
->event
.udpEvent
->datagramKey
->dataKey
, &dataStart
,
584 sizeof(inE
->event
.udpEvent
->datagramKey
->dataKey
));
588 memset(inE
->event
.udpEvent
->datagramKey
->dataKey
, 0,
589 sizeof(inE
->event
.udpEvent
->datagramKey
->dataKey
));
590 memcpy(inE
->event
.udpEvent
->datagramKey
->dataKey
, &dataStart
,
591 inE
->event
.udpEvent
->datagramKey
->ulen
- 8);
594 syncState
->matchingModule
->matchEvent(syncState
, inE
);
596 g_debug("UDP input event %p for skb %p done", inE
, skb
);
601 g_assert_not_reached();
609 * Write the processing-specific variables in the gnuplot script.
612 * syncState: container for synchronization data
615 static void writeProcessingGraphVariablesLTTVStandard(SyncState
* const
616 syncState
, const unsigned int i
)
618 ProcessingDataLTTVStandard
* processingData
= syncState
->processingData
;
619 ProcessingGraphsLTTVStandard
* traceI
= &processingData
->graphs
[i
];
621 fprintf(syncState
->graphsStream
, "clock_freq_%u= %.3f\n", i
, (double)
622 traceI
->startFreq
/ traceI
->freqScale
);
627 * Write the processing-specific options in the gnuplot script.
630 * syncState: container for synchronization data
631 * i: first trace number
632 * j: second trace number, garanteed to be larger than i
634 static void writeProcessingTraceTraceOptionsLTTVStandard(SyncState
* const
635 syncState
, const unsigned int i
, const unsigned int j
)
637 fprintf(syncState
->graphsStream
,
638 "set key inside right bottom\n"
639 "set xlabel \"Clock %1$u\"\n"
640 "set xtics nomirror\n"
641 "set ylabel \"Clock %2$u\"\n"
642 "set ytics nomirror\n"
643 "set x2label \"Clock %1$d (s)\"\n"
644 "set x2range [GPVAL_X_MIN / clock_freq_%1$u : GPVAL_X_MAX / clock_freq_%1$u]\n"
646 "set y2label \"Clock %2$d (s)\"\n"
647 "set y2range [GPVAL_Y_MIN / clock_freq_%2$u : GPVAL_Y_MAX / clock_freq_%2$u]\n"
648 "set y2tics\n", i
, j
);
653 * Write the processing-specific options in the gnuplot script.
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 writeProcessingTraceTimeOptionsLTTVStandard(SyncState
* const
661 syncState
, const unsigned int i
, const unsigned int j
)
663 fprintf(syncState
->graphsStream
,
664 "set key inside right bottom\n"
665 "set xlabel \"Clock %1$u\"\n"
666 "set xtics nomirror\n"
667 "set ylabel \"time (s)\"\n"
668 "set ytics nomirror\n"
669 "set x2label \"Clock %1$d (s)\"\n"
670 "set x2range [GPVAL_X_MIN / clock_freq_%1$u : GPVAL_X_MAX / clock_freq_%1$u]\n"