lttv/lttv/sync/data_structures.h

   1 /* This file is part of the Linux Trace Toolkit viewer
   2  * Copyright (C) 2009 Benjamin Poirier <benjamin.poirier@polymtl.ca>
   3  *
   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;
   7  *
   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.
  12  *
  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,
  16  * MA 02111-1307, USA.
  17  */
  18
  19 #ifndef DATA_STRUCTURES_H
  20 #define DATA_STRUCTURES_H
  21
  22 #include <glib.h>
  23 #include <stdbool.h>
  24 #include <stdint.h>
  25
  26 #include <ltt/ltt.h>
  27
  28
  29 enum Direction
  30 {
  31         OUT,
  32         IN,
  33 };
  34
  35 enum EventType
  36 {
  37         TCP,
  38         UDP,
  39         TYPE_COUNT // This must be the last field
  40 };
  41
  42 // Stage 1 to 2: These structures are passed from processing to matching modules
  43 // TCP events
  44 typedef struct
  45 {
  46         uint32_t saddr, daddr;
  47         uint16_t source, dest;
  48 } ConnectionKey;
  49
  50 typedef struct
  51 {
  52         ConnectionKey connectionKey;
  53         uint8_t ihl;
  54         uint16_t tot_len;
  55         uint32_t seq, ack_seq;
  56         uint8_t doff;
  57         uint8_t ack, rst, syn, fin;
  58 } SegmentKey;
  59
  60 typedef struct
  61 {
  62         enum Direction direction;
  63         SegmentKey* segmentKey;
  64 } TCPEvent;
  65
  66 // UDP events
  67 typedef struct
  68 {
  69         uint32_t saddr, daddr;
  70         uint16_t source, dest;
  71         uint16_t ulen;
  72         uint8_t dataKey[8];
  73 } DatagramKey;
  74
  75 typedef struct
  76 {
  77         enum Direction direction;
  78         DatagramKey* datagramKey;
  79         bool unicast;
  80 } UDPEvent;
  81
  82 typedef struct _Event
  83 {
  84         unsigned long traceNum;
  85         uint64_t time;
  86
  87         // specific event structures and functions could be in separate files and
  88         // type could be an int
  89         enum EventType type;
  90         // event could be a void*, this union is to avoid having to cast
  91         union {
  92                 TCPEvent* tcpEvent;
  93                 UDPEvent* udpEvent;
  94         } event;
  95
  96         void (*destroy)(struct _Event* const event);
  97 } Event;
  98
  99 // Stage 2 to 3: These structures are passed from matching to analysis modules
 100 typedef struct _Message
 101 {
 102         Event* inE, * outE;
 103
 104         void (*print)(const struct _Message* const message);
 105 } Message;
 106
 107 typedef struct
 108 {
 109         Message* message;
 110         GQueue* acks;
 111 } Exchange;
 112
 113 typedef struct
 114 {
 115         GQueue* events;
 116 } Broadcast;
 117
 118 // One set of factors for each trace, this is the result of synchronization
 119 typedef struct
 120 {
 121         double drift, offset;
 122 } Factors;
 123
 124
 125 // ConnectionKey-related functions
 126 guint ghfConnectionKeyHash(gconstpointer key);
 127
 128 gboolean gefConnectionKeyEqual(gconstpointer a, gconstpointer b);
 129 bool connectionKeyEqual(const ConnectionKey* const a, const ConnectionKey*
 130         const b);
 131
 132 void gdnConnectionKeyDestroy(gpointer data);
 133
 134 // SegmentKey-related functions
 135 guint ghfSegmentKeyHash(gconstpointer key);
 136 gboolean gefSegmentKeyEqual(gconstpointer a, gconstpointer b);
 137
 138 // DatagramKey-related functions
 139 guint ghfDatagramKeyHash(gconstpointer key);
 140 gboolean gefDatagramKeyEqual(gconstpointer a, gconstpointer b);
 141 void gdnDestroyDatagramKey(gpointer data);
 142
 143 // Event-related functions
 144 void gdnDestroyEvent(gpointer data);
 145 void destroyEvent(Event* const event);
 146 void destroyTCPEvent(Event* const event);
 147 void destroyUDPEvent(Event* const event);
 148 void gfDestroyEvent(gpointer data, gpointer user_data);
 149
 150 // Message-related functions
 151 void printTCPSegment(const Message* const segment);
 152 void convertIP(char* const str, const uint32_t addr);
 153
 154 gint gcfTCPSegmentAckCompare(gconstpointer a, gconstpointer b);
 155 bool isAcking(const Message* const ackSegment, const Message* const ackedSegment);
 156
 157 void gdnTCPSegmentListDestroy(gpointer data);
 158 void gfTCPSegmentDestroy(gpointer data, gpointer user_data);
 159 void destroyTCPSegment(Message* const segment);
 160
 161 // Exchange-related functions
 162 void destroyTCPExchange(Exchange* const exchange);
 163
 164 // Broadcast-related functions
 165 void gdnDestroyBroadcast(gpointer data);
 166 void destroyBroadcast(Broadcast* const broadcast);
 167
 168 #endif