source: lib/format_tsh.c @ bf7e954

4.0.1-hotfixescachetimestampsdevelopdpdk-ndagetsilivegetfragoffhelplibtrace4ndag_formatpfringrc-4.0.1rc-4.0.2rc-4.0.3rc-4.0.4ringdecrementfixringperformanceringtimestampfixes
Last change on this file since bf7e954 was d026488, checked in by Shane Alcock <salcock@…>, 12 years ago
  • Updated documentation and licensing for the last two format modules
  • Property mode set to 100644
File size: 8.6 KB
Line 
1/*
2 * This file is part of libtrace
3 *
4 * Copyright (c) 2007,2008,2009,2010 The University of Waikato, Hamilton,
5 * New Zealand.
6 *
7 * Authors: Daniel Lawson
8 *          Perry Lorier
9 *          Shane Alcock
10 *         
11 * All rights reserved.
12 *
13 * This code has been developed by the University of Waikato WAND
14 * research group. For further information please see http://www.wand.net.nz/
15 *
16 * libtrace is free software; you can redistribute it and/or modify
17 * it under the terms of the GNU General Public License as published by
18 * the Free Software Foundation; either version 2 of the License, or
19 * (at your option) any later version.
20 *
21 * libtrace is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
24 * GNU General Public License for more details.
25 *
26 * You should have received a copy of the GNU General Public License
27 * along with libtrace; if not, write to the Free Software
28 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
29 *
30 * $Id$
31 *
32 */
33
34
35#include "config.h"
36#include "common.h"
37#include "libtrace.h"
38#include "libtrace_int.h"
39#include "format_helper.h"
40
41#include <assert.h>
42#include <errno.h>
43#include <fcntl.h>
44#include <stdio.h>
45#include <string.h>
46#include <stdlib.h>
47
48/* This format module deals with reading traces that are in the TSH format.
49 *
50 * We do not support writing TSH traces, because it's a pretty rubbish format.
51 */
52
53static struct libtrace_format_t tshformat;
54
55typedef struct tsh_pkt_header_t {
56        uint32_t seconds;
57        uint32_t usecs;
58} tsh_pkt_header_t;
59
60static int tsh_get_framing_length(const libtrace_packet_t *packet UNUSED)
61{
62        return sizeof(tsh_pkt_header_t);
63}
64
65
66static int tsh_init_input(libtrace_t *libtrace) 
67{
68        libtrace->format_data = NULL; /* No format data */
69       
70        return 0; /* success */
71}
72
73static int tsh_start_input(libtrace_t *libtrace)
74{
75        if (libtrace->io)
76                return 0; /* success */
77
78        libtrace->io = trace_open_file(libtrace);
79
80        if (!libtrace->io)
81                return -1;
82
83        return 0; /* success */
84}
85
86static int tsh_fin_input(libtrace_t *libtrace) {
87        if (libtrace->io)
88                wandio_destroy(libtrace->io);
89        return 0;
90}
91
92static int tsh_prepare_packet(libtrace_t *libtrace, libtrace_packet_t *packet,
93                void *buffer, libtrace_rt_types_t rt_type, uint32_t flags) {
94        if (packet->buffer != buffer &&
95                        packet->buf_control == TRACE_CTRL_PACKET) {
96                free(packet->buffer);
97        }
98
99        if ((flags & TRACE_PREP_OWN_BUFFER) == TRACE_PREP_OWN_BUFFER) {
100                packet->buf_control = TRACE_CTRL_PACKET;
101        } else
102                packet->buf_control = TRACE_CTRL_EXTERNAL;
103
104
105        packet->buffer = buffer;
106        packet->header = buffer;
107        packet->type = rt_type;
108        packet->payload = (char *)packet->buffer + sizeof(tsh_pkt_header_t);
109
110        if (libtrace->format_data == NULL) {
111                if (tsh_init_input(libtrace))
112                        return -1;
113        }
114
115        return 0;
116}
117
118static int tsh_read_packet(libtrace_t *libtrace, libtrace_packet_t *packet) {
119        int numbytes;
120        void *buffer2 = packet->buffer;
121        uint32_t flags = 0;
122
123        if (!packet->buffer || packet->buf_control == TRACE_CTRL_EXTERNAL) {
124                packet->buffer = malloc((size_t)LIBTRACE_PACKET_BUFSIZE);
125                if (!packet->buffer) {
126                        trace_set_err(libtrace, errno, 
127                                        "Cannot allocate memory");
128                        return -1;
129                }
130        }
131
132        flags |= TRACE_PREP_OWN_BUFFER;
133        packet->type = TRACE_RT_DATA_TSH;
134
135        buffer2 = packet->buffer;
136
137        /* Read the TSH header */
138        if ((numbytes=wandio_read(libtrace->io,
139                                        buffer2,
140                                        (size_t)sizeof(tsh_pkt_header_t))) == -1) {
141                trace_set_err(libtrace,errno,"read(%s)",
142                                libtrace->uridata);
143                return -1;
144        }
145        /* EOF */
146        if (numbytes == 0) {
147                return 0;
148        }
149
150        buffer2 = (char*)buffer2 + numbytes;
151
152        /* Read the IP header */
153        if ((numbytes=wandio_read(libtrace->io,
154                                buffer2,
155                                (size_t)sizeof(libtrace_ip_t))) 
156                        != sizeof(libtrace_ip_t)) {
157                trace_set_err(libtrace,errno,"read(%s)",
158                                libtrace->uridata);
159                return -1;
160        }
161
162        /* IP Options aren't captured in the trace, so leave room
163         * for them, and put the transport header where it "should" be
164         */
165        buffer2 = (char*)buffer2 + ((libtrace_ip_t*)buffer2)->ip_hl*4;
166
167        /* Read the transport header */
168        if ((numbytes=wandio_read(libtrace->io,
169                                buffer2,
170                                16)) != 16) {
171                trace_set_err(libtrace,errno,"read(%s)",
172                                libtrace->uridata);
173                return -1;
174        }
175       
176        if (tsh_prepare_packet(libtrace, packet, packet->buffer, packet->type, 
177                                flags)) {
178                return -1;
179        }
180
181
182        return 80;
183}
184
185static libtrace_linktype_t tsh_get_link_type(const libtrace_packet_t *packet UNUSED) {
186        return TRACE_TYPE_NONE;
187}
188
189static libtrace_direction_t tsh_get_direction(const libtrace_packet_t *packet) {
190        return ntohl(((tsh_pkt_header_t*)(packet->header))->usecs & htonl(0xFF000000)) >> 24;
191}
192
193static struct timeval tsh_get_timeval(const libtrace_packet_t *packet)
194{
195        struct timeval tv;
196        tv.tv_sec=ntohl(((tsh_pkt_header_t*)(packet->header))->seconds);
197        tv.tv_usec=ntohl(((tsh_pkt_header_t*)(packet->header))->usecs & htonl(0x00FFFFFF));
198
199        return tv;
200}
201
202static int tsh_get_capture_length(const libtrace_packet_t *packet) {
203        /* 16 bytes transport + 24 bytes IP, and we're missing the
204         * IP options, but we'll pretend we have them
205         */
206        return 16+((libtrace_ip_t*)packet->payload)->ip_hl*4;
207}
208
209static int tsh_get_wire_length(const libtrace_packet_t *packet) {
210        return ((libtrace_ip_t*)packet->payload)->ip_len;
211}
212
213static void tsh_help(void) {
214        printf("tsh format module: $Revision$\n");
215        printf("Supported input URIs:\n");
216        printf("\ttsh:/path/to/file\t(uncompressed)\n");
217        printf("\ttsh:/path/to/file.gz\t(gzip-compressed)\n");
218        printf("\ttsh:-\t(stdin, either compressed or not)\n");
219        printf("\ttsh:/path/to/socket\n");
220        printf("\n");
221        printf("\te.g.: erf:/tmp/trace\n");
222        printf("\n");
223}
224
225static struct libtrace_format_t tshformat = {
226        "tsh",
227        "$Id$",
228        TRACE_FORMAT_TSH,
229        NULL,                           /* probe filename */
230        NULL,                           /* probe magic */
231        tsh_init_input,                 /* init_input */       
232        NULL,                           /* config_input */
233        tsh_start_input,                /* start_input */
234        NULL,                           /* pause_input */
235        NULL,                           /* init_output */
236        NULL,                           /* config_output */
237        NULL,                           /* start_output */
238        tsh_fin_input,                  /* fin_input */
239        NULL,                           /* fin_output */
240        tsh_read_packet,                /* read_packet */
241        tsh_prepare_packet,             /* prepare_packet */
242        NULL,                           /* fin_packet */
243        NULL,                           /* write_packet */
244        tsh_get_link_type,              /* get_link_type */
245        tsh_get_direction,              /* get_direction */
246        NULL,                           /* set_direction */
247        NULL,                           /* get_erf_timestamp */
248        tsh_get_timeval,                /* get_timeval */
249        NULL,                           /* get_timespec */
250        NULL,                           /* get_seconds */
251        NULL,                           /* seek_erf */
252        NULL,                           /* seek_timeval */
253        NULL,                           /* seek_seconds */
254        tsh_get_capture_length,         /* get_capture_length */
255        tsh_get_wire_length,            /* get_wire_length */
256        tsh_get_framing_length,         /* get_framing_length */
257        NULL,                           /* set_capture_length */
258        NULL,                           /* get_received_packets */
259        NULL,                           /* get_filtered_packets */
260        NULL,                           /* get_dropped_packets */
261        NULL,                           /* get_captured_packets */
262        NULL,                           /* get_fd */
263        trace_event_trace,              /* trace_event */
264        tsh_help,                       /* help */
265        NULL                            /* next pointer */
266};
267
268/* the tsh header format is the same as tsh, except that the bits that will
269 * always be "0" in the fr+ format are used for an "interface" identifier,
270 * thus on tr+ traces, this will always be 0.  So, we use the exact same
271 * decoder for both traces.
272 */
273static struct libtrace_format_t frplusformat = {
274        "fr+",
275        "$Id$",
276        TRACE_FORMAT_TSH,
277        NULL,                           /* probe filename */
278        NULL,                           /* probe magic */
279        tsh_init_input,                 /* init_input */       
280        NULL,                           /* config_input */
281        tsh_start_input,                /* start_input */
282        NULL,                           /* pause_input */
283        NULL,                           /* init_output */
284        NULL,                           /* config_output */
285        NULL,                           /* start_output */
286        tsh_fin_input,                  /* fin_input */
287        NULL,                           /* fin_output */
288        tsh_read_packet,                /* read_packet */
289        tsh_prepare_packet,             /* prepare_packet */
290        NULL,                           /* fin_packet */
291        NULL,                           /* write_packet */
292        tsh_get_link_type,              /* get_link_type */
293        tsh_get_direction,              /* get_direction */
294        NULL,                           /* set_direction */
295        NULL,                           /* get_erf_timestamp */
296        tsh_get_timeval,                /* get_timeval */
297        NULL,                           /* get_timespec */
298        NULL,                           /* get_seconds */
299        NULL,                           /* seek_erf */
300        NULL,                           /* seek_timeval */
301        NULL,                           /* seek_seconds */
302        tsh_get_capture_length,         /* get_capture_length */
303        tsh_get_wire_length,            /* get_wire_length */
304        tsh_get_framing_length,         /* get_framing_length */
305        NULL,                           /* set_capture_length */
306        NULL,                           /* get_received_packets */
307        NULL,                           /* get_filtered_packets */
308        NULL,                           /* get_dropped_packets */
309        NULL,                           /* get_captured_packets */
310        NULL,                           /* get_fd */
311        trace_event_trace,              /* trace_event */
312        tsh_help,                       /* help */
313        NULL                            /* next pointer */
314};
315
316void tsh_constructor(void) {
317        register_format(&tshformat);
318        register_format(&frplusformat);
319}
Note: See TracBrowser for help on using the repository browser.