source: lib/format_wag.c @ 431548c5

4.0.1-hotfixescachetimestampsdevelopdpdk-ndagetsilivegetfragoffhelplibtrace4ndag_formatpfringrc-4.0.1rc-4.0.2rc-4.0.3rc-4.0.4ringdecrementfixringperformanceringtimestampfixes
Last change on this file since 431548c5 was 431548c5, checked in by Shane Alcock <salcock@…>, 15 years ago

Updated various format modules to use libtrace_direction_t rather than int8_t
Changed MIN in fifo.c to be FIFO_MIN as this was very prone to conflict

  • Property mode set to 100644
File size: 15.3 KB
Line 
1/*
2 * This file is part of libtrace
3 *
4 * Copyright (c) 2004 The University of Waikato, Hamilton, New Zealand.
5 * Authors: Daniel Lawson
6 *          Perry Lorier
7 *         
8 * All rights reserved.
9 *
10 * This code has been developed by the University of Waikato WAND
11 * research group. For further information please see http://www.wand.net.nz/
12 *
13 * libtrace is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
16 * (at your option) any later version.
17 *
18 * libtrace is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21 * GNU General Public License for more details.
22 *
23 * You should have received a copy of the GNU General Public License
24 * along with libtrace; if not, write to the Free Software
25 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 *
27 * $Id$
28 *
29 */
30
31#define _GNU_SOURCE
32#include "config.h"
33#include "common.h"
34#include "libtrace.h"
35#include "libtrace_int.h"
36#include "format_helper.h"
37#include "wag.h"
38
39#include <sys/stat.h>
40#include <fcntl.h>
41#include <assert.h>
42#include <errno.h>
43#include <stdio.h>
44#include <string.h>
45#include <stdlib.h>
46
47#ifdef HAVE_LIMITS_H
48#  include <limits.h>
49#endif
50
51#ifdef HAVE_SYS_LIMITS_H
52#  include <sys/limits.h>
53#endif
54
55#ifdef WIN32
56#  include <io.h>
57#  include <share.h>
58#endif
59
60static struct libtrace_format_t wag;
61static struct libtrace_format_t wag_trace;
62
63#define DATA(x)         ((struct wag_format_data_t *)x->format_data)
64#define DATAOUT(x)      ((struct wag_format_data_out_t *)x->format_data)
65
66#define INPUT DATA(libtrace)->input
67#define OUTPUT DATAOUT(libtrace)->output
68#define OPTIONS DATAOUT(libtrace)->options
69
70struct wag_format_data_t {
71        /** Information about the current state of the input device */
72        union {
73                int fd;
74                libtrace_io_t *file;
75        } input;       
76};
77
78struct wag_format_data_out_t {
79        union {
80                struct {
81                        int level;
82                        int filemode;
83                } zlib;
84        } options;
85        union {
86                int fd;
87                libtrace_io_t *file;
88        } output;
89};
90
91static int wag_init_input(libtrace_t *libtrace) {
92        libtrace->format_data = calloc(1, sizeof(struct wag_format_data_t));
93
94        return 0;
95}
96
97static int wag_start_input(libtrace_t *libtrace)
98{
99        struct stat buf;
100        if (stat(libtrace->uridata,&buf) == -1 ) {
101                trace_set_err(libtrace,errno,"stat(%s)",libtrace->uridata);
102                return -1;
103        }
104#ifndef WIN32
105        if (S_ISCHR(buf.st_mode)) {
106                INPUT.fd = open(libtrace->uridata, O_RDONLY);
107                return 0;
108        }
109#endif
110        trace_set_err(libtrace,TRACE_ERR_INIT_FAILED,
111                        "%s is not a valid char device",
112                        libtrace->uridata);
113        return -1;
114}
115
116static int wtf_init_input(libtrace_t *libtrace) 
117{
118        libtrace->format_data = calloc(1,sizeof(struct wag_format_data_t));
119        return 0;
120}
121
122static int wtf_start_input(libtrace_t *libtrace)
123{
124        if (DATA(libtrace)->input.file)
125                return 0; /* success */
126        DATA(libtrace)->input.file = trace_open_file(libtrace);
127
128        if (!DATA(libtrace)->input.file)
129                return -1; 
130
131        return 0; /* success */
132}
133
134static int wtf_init_output(libtrace_out_t *libtrace) {
135        libtrace->format_data = malloc(sizeof(struct wag_format_data_out_t));
136
137        OUTPUT.file = 0;
138        OPTIONS.zlib.level = 0;
139        OPTIONS.zlib.filemode = O_CREAT | O_WRONLY;
140       
141        return 0;
142}
143
144static int wtf_start_output(libtrace_out_t *libtrace) {
145        OUTPUT.file = trace_open_file_out(libtrace,
146                        OPTIONS.zlib.level,
147                        OPTIONS.zlib.filemode);
148        if (!OUTPUT.file) {
149                return -1;
150        }
151        return 0;
152}
153
154static int wtf_config_output(libtrace_out_t *libtrace, 
155                trace_option_output_t option,
156                void *value) {
157        switch(option) {
158#if HAVE_ZLIB
159                case TRACE_OPTION_OUTPUT_COMPRESS:
160                        OPTIONS.zlib.level = *(int*)value;
161                        assert(OPTIONS.zlib.level>=0 
162                                        && OPTIONS.zlib.level<=9);
163                        return 0;
164#else
165                case TRACE_OPTION_OUTPUT_COMPRESS:
166                        /* E feature unavailable */
167                        trace_set_err_out(libtrace,TRACE_ERR_OPTION_UNAVAIL,
168                                        "zlib not supported");
169                        return -1;
170#endif
171                default:
172                        /* E unknown feature */
173                        trace_set_err_out(libtrace,TRACE_ERR_UNKNOWN_OPTION,
174                                        "Unknown option");
175                        return -1;
176        }
177}
178
179static int wag_pause_input(libtrace_t *libtrace)
180{
181        close(INPUT.fd);
182        return 0;
183}
184
185static int wag_fin_input(libtrace_t *libtrace) {
186        free(libtrace->format_data);
187        return 0;
188}
189
190static int wtf_fin_input(libtrace_t *libtrace) {
191        libtrace_io_close(INPUT.file);
192        free(libtrace->format_data);
193        return 0;
194}
195
196static int wtf_fin_output(libtrace_out_t *libtrace) {
197        libtrace_io_close(OUTPUT.file);
198        free(libtrace->format_data);
199        return 0;
200}
201
202static int wag_read(libtrace_t *libtrace, void *buffer, size_t len, 
203                int block) {
204        size_t framesize;
205        char *buf_ptr = (char *)buffer;
206        int to_read = 0;
207        uint16_t magic = 0;
208        long fd_flags;
209       
210        assert(libtrace);
211
212        to_read = sizeof(struct frame_t);
213
214#ifndef WIN32
215        fd_flags = fcntl(INPUT.fd, F_GETFL);
216        if (fd_flags == -1) {
217                /* TODO: Replace with better libtrace-style
218                 * error handling later */
219                perror("Could not get fd flags");
220                return 0;
221        }
222       
223       
224       
225        if (!block) {
226                if (fcntl(INPUT.fd, F_SETFL, fd_flags | O_NONBLOCK) == -1) {
227                        perror("Could not set fd flags");
228                        return 0;
229                }
230        }
231        else {
232                if (fd_flags & O_NONBLOCK) {
233                        fd_flags &= ~O_NONBLOCK;
234                        if (fcntl(INPUT.fd, F_SETFL, fd_flags) == -1) {
235                                perror("Could not set fd flags");
236                                return 0;
237                        }
238                }
239        }
240#endif
241
242        /* I'm not sure if wag has a memory hole which we can use for
243         * zero-copy - something to add in later, I guess */
244       
245        while (to_read>0) {
246                int ret=read(INPUT.fd,buf_ptr,to_read);
247
248                if (ret == -1) {
249                        if (errno == EINTR)
250                                continue;
251                       
252                        if (errno == EAGAIN) {
253                                trace_set_err(libtrace, EAGAIN, "EAGAIN");
254                                return -1;
255                        }
256           
257                        trace_set_err(libtrace,errno,
258                                        "read(%s)",libtrace->uridata);
259                        return -1;
260                }
261
262                assert(ret>0);
263
264                to_read = to_read - ret;
265                buf_ptr = buf_ptr + ret;
266        }
267
268
269        framesize = ntohs(((struct frame_t *)buffer)->size);
270        magic = ntohs(((struct frame_t *)buffer)->magic);
271
272        if (magic != 0xdaa1) {
273          trace_set_err(libtrace,
274                          TRACE_ERR_BAD_PACKET,"magic number bad or missing");
275          return -1;
276        }
277
278        /* We should deal.  this is called "snapping", but we don't yet */
279        assert(framesize<=len);
280
281        buf_ptr = (void*)((char*)buffer + sizeof (struct frame_t));
282        to_read = framesize - sizeof(struct frame_t);
283       
284        while (to_read>0) {
285                int ret=read(INPUT.fd,buf_ptr,to_read);
286
287                if (ret == -1) {
288                        if (errno == EINTR) 
289                                continue;
290                        if (errno == EAGAIN) {
291                                /* What happens to the frame header?! */
292                                trace_set_err(libtrace, EAGAIN, "EAGAIN");
293                                return -1;
294                        }
295                        trace_set_err(libtrace,errno,"read(%s)",
296                                        libtrace->uridata);
297                        return -1;
298                }
299
300                to_read = to_read - ret;
301                buf_ptr = buf_ptr + ret;
302        }
303        return framesize;
304}
305
306
307static int wag_read_packet_versatile(libtrace_t *libtrace, libtrace_packet_t *packet, int block_flag) {
308        int numbytes;
309       
310        if (packet->buf_control == TRACE_CTRL_EXTERNAL || !packet->buffer) {
311                packet->buf_control = TRACE_CTRL_PACKET;
312                packet->buffer = malloc(LIBTRACE_PACKET_BUFSIZE);
313        }
314       
315       
316        packet->trace = libtrace;
317        packet->type = RT_DATA_WAG;
318       
319        if ((numbytes = wag_read(libtrace, (void *)packet->buffer, 
320                                        RP_BUFSIZE, block_flag)) <= 0) {
321           
322                return numbytes;
323        }
324
325       
326        packet->header = packet->buffer;
327        packet->payload=(char*)packet->buffer+trace_get_framing_length(packet);
328        packet->size = trace_get_framing_length(packet) + trace_get_capture_length(packet);
329        return numbytes;
330}
331
332static int wag_read_packet(libtrace_t *libtrace, libtrace_packet_t *packet) {
333        return wag_read_packet_versatile(libtrace, packet, 1);
334}
335
336static int wtf_read_packet(libtrace_t *libtrace, libtrace_packet_t *packet) {
337        int numbytes;
338        void *buffer;
339        void *buffer2;
340        int framesize;
341        int size;
342
343        if (packet->buf_control == TRACE_CTRL_EXTERNAL || !packet->buffer) {
344                packet->buf_control = TRACE_CTRL_PACKET;
345                packet->buffer = malloc(LIBTRACE_PACKET_BUFSIZE);
346        }
347        packet->type = RT_DATA_WAG;
348        buffer2 = buffer = packet->buffer;
349
350        numbytes = libtrace_io_read(INPUT.file, buffer, sizeof(struct frame_t));
351
352        if (numbytes == 0) {
353                return 0;
354        }
355
356        if (numbytes != sizeof(struct frame_t)) {
357                int err=errno;
358                trace_set_err(libtrace,err,
359                                "read(%s,frame_t)",packet->trace->uridata);
360                printf("failed to read header=%i\n",err);
361                return -1;
362        }
363
364        if (htons(((struct frame_t *)buffer)->magic) != 0xdaa1) {
365                trace_set_err(libtrace,
366                                TRACE_ERR_BAD_PACKET,"Insufficient magic (%04x)",htons(((struct frame_t *)buffer)->magic));
367                return -1;
368        }
369
370        framesize = ntohs(((struct frame_t *)buffer)->size);
371        buffer2 = (char*)buffer + sizeof(struct frame_t);
372        size = framesize - sizeof(struct frame_t);
373        assert(size < LIBTRACE_PACKET_BUFSIZE);
374        assert(size > 0);
375       
376        if ((numbytes=libtrace_io_read(INPUT.file, buffer2, size)) != size) {
377                trace_set_err(libtrace,
378                                errno,"read(%s,buffer)",packet->trace->uridata);
379                return -1;
380        }
381
382        packet->header = packet->buffer;
383        packet->payload=(char*)packet->buffer+trace_get_framing_length(packet);
384        return framesize;
385       
386}                               
387       
388static int wtf_write_packet(libtrace_out_t *libtrace, const libtrace_packet_t *packet) {
389        int numbytes =0 ;
390        if (packet->trace->format != &wag_trace) {
391                trace_set_err_out(libtrace,TRACE_ERR_NO_CONVERSION,
392                                "Cannot convert to wag trace format from %s format yet",
393                                packet->trace->format->name);
394                return -1;
395        }
396
397        /* We could just read from packet->buffer, but I feel it is more
398         * technically correct to read from the header and payload pointers
399         */
400        if ((numbytes = libtrace_io_write(OUTPUT.file, packet->header, 
401                                trace_get_framing_length(packet))) == -1) {
402                trace_set_err_out(libtrace,errno,
403                                "write(%s)",packet->trace->uridata);
404                return -1;
405        }
406        if ((numbytes = libtrace_io_write(OUTPUT.file, packet->payload, 
407                                trace_get_capture_length(packet)) == -1)) {
408                trace_set_err_out(libtrace,
409                                errno,"write(%s)",packet->trace->uridata);
410                return -1;
411        }
412        return numbytes;
413}
414
415static libtrace_linktype_t wag_get_link_type(const libtrace_packet_t *packet UNUSED) {
416        return TRACE_TYPE_80211;
417}
418
419static libtrace_direction_t wag_get_direction(const libtrace_packet_t *packet) {
420        struct frame_data_rx_t *wagptr = (struct frame_data_rx_t *)packet->buffer;
421        if (wagptr->hdr.type == 0) {
422                return wagptr->hdr.subtype; 
423        }
424        return -1;
425}
426
427static uint64_t wag_get_erf_timestamp(const libtrace_packet_t *packet) {
428        struct frame_data_rx_t *wagptr = (struct frame_data_rx_t *)packet->buffer;
429        uint64_t timestamp = 0;
430        timestamp = ((uint64_t)(ntohl(wagptr->ts.secs)) << 32) | (uint64_t)(ntohl(wagptr->ts.subsecs));
431        return timestamp;
432}
433
434static int wag_get_capture_length(const libtrace_packet_t *packet) {
435        return ntohs(((struct frame_t *)packet->header)->size)
436                -sizeof(struct frame_data_rx_t);
437}
438
439static int wag_get_wire_length(const libtrace_packet_t *packet) {
440        return ntohs(((struct frame_t *)packet->header)->size)
441                -sizeof(struct frame_data_rx_t);
442}
443
444static int wag_get_framing_length(UNUSED const libtrace_packet_t *packet) {
445        return sizeof(struct frame_data_rx_t);
446}
447
448static int wag_get_fd(const libtrace_t *trace) {
449        return DATA(trace)->input.fd;
450}
451
452struct libtrace_eventobj_t trace_event_wag(libtrace_t *trace, libtrace_packet_t *packet) {
453        struct libtrace_eventobj_t event = {0,0,0.0,0};
454        libtrace_err_t read_err;
455
456        assert(trace);
457        assert(packet);
458
459        /* We could probably just call get_fd here */
460        if (trace->format->get_fd) {
461                event.fd = trace->format->get_fd(trace);
462        } else {
463                event.fd = 0;
464        }
465       
466        event.size = wag_read_packet_versatile(trace, packet, 0);
467        if (event.size == -1) {
468                read_err = trace_get_err(trace);
469                if (read_err.err_num = EAGAIN) {
470                        event.type = TRACE_EVENT_IOWAIT;
471                }
472                else {
473                        printf("Packet error\n");
474                        event.type = TRACE_EVENT_PACKET;
475                }
476        } else if (event.size == 0) {
477                event.type = TRACE_EVENT_TERMINATE;
478        } else {
479                event.type = TRACE_EVENT_PACKET;
480        }
481
482        return event;
483}
484       
485static void wag_help() {
486        printf("wag format module: $Revision$\n");
487        printf("Supported input URIs:\n");
488        printf("\twag:/dev/wagn\n");
489        printf("\n");
490        printf("\te.g.: wag:/dev/wag0\n");
491        printf("\n");
492        printf("Supported output URIs:\n");
493        printf("\tNone\n");
494        printf("\n");
495}
496
497static void wtf_help() {
498        printf("wag trace format module: $Revision$\n");
499        printf("Supported input URIs:\n");
500        printf("\twtf:/path/to/trace.wag\n");
501        printf("\twtf:/path/to/trace.wag.gz\n");
502        printf("\n");
503        printf("\te.g.: wtf:/tmp/trace.wag.gz\n");
504        printf("\n");
505        printf("Supported output URIs:\n");
506        printf("\twtf:/path/to/trace.wag\n");
507        printf("\twtf:/path/to/trace.wag.gz\n");
508        printf("\n");
509        printf("\te.g.: wtf:/tmp/trace.wag.gz\n");
510        printf("\n");
511}
512
513static struct libtrace_format_t wag = {
514        "wag",
515        "$Id$",
516        TRACE_FORMAT_WAG,
517        wag_init_input,                 /* init_input */       
518        NULL,                           /* config_input */
519        wag_start_input,                /* start_input */
520        wag_pause_input,                /* pause_input */
521        NULL,                           /* init_output */
522        NULL,                           /* config_output */
523        NULL,                           /* start_output */
524        wag_fin_input,                  /* fin_input */
525        NULL,                           /* fin_output */
526        wag_read_packet,                /* read_packet */
527        NULL,                           /* fin_packet */
528        NULL,                           /* write_packet */
529        wag_get_link_type,              /* get_link_type */
530        wag_get_direction,              /* get_direction */
531        NULL,                           /* set_direction */
532        wag_get_erf_timestamp,          /* get_erf_timestamp */
533        NULL,                           /* get_timeval */
534        NULL,                           /* get_seconds */
535        NULL,                           /* seek_erf */
536        NULL,                           /* seek_timeval */
537        NULL,                           /* seek_seconds */
538        wag_get_capture_length,         /* get_capture_length */
539        wag_get_wire_length,            /* get_wire_length */
540        wag_get_framing_length,         /* get_framing_length */
541        NULL,                           /* set_capture_length */
542        wag_get_fd,                     /* get_fd */
543        trace_event_wag,                /* trace_event */
544        wag_help,                       /* help */
545        NULL                            /* next pointer */
546};
547
548/* wtf stands for Wag Trace Format */
549
550static struct libtrace_format_t wag_trace = {
551        "wtf",
552        "$Id$",
553        TRACE_FORMAT_WAG,
554        wtf_init_input,                 /* init_input */
555        NULL,                           /* config input */
556        wtf_start_input,                /* start input */
557        NULL,                           /* pause_input */
558        wtf_init_output,                /* init_output */
559        wtf_config_output,              /* config_output */
560        wtf_start_output,               /* start output */
561        wtf_fin_input,                  /* fin_input */
562        wtf_fin_output,                 /* fin_output */
563        wtf_read_packet,                /* read_packet */
564        NULL,                           /* fin_packet */
565        wtf_write_packet,               /* write_packet */
566        wag_get_link_type,              /* get_link_type */
567        wag_get_direction,              /* get_direction */
568        NULL,                           /* set_direction */
569        wag_get_erf_timestamp,          /* get_erf_timestamp */
570        NULL,                           /* get_timeval */
571        NULL,                           /* get_seconds */
572        NULL,                           /* seek_erf */
573        NULL,                           /* seek_timeval */
574        NULL,                           /* seek_seconds */
575        wag_get_capture_length,         /* get_capture_length */
576        wag_get_wire_length,            /* get_wire_length */
577        wag_get_framing_length,         /* get_framing_length */
578        NULL,                           /* set_capture_length */
579        NULL,                           /* get_fd */
580        trace_event_trace,              /* trace_event */
581        wtf_help,                       /* help */
582        NULL                            /* next pointer */
583};
584
585
586void CONSTRUCTOR wag_constructor() {
587        register_format(&wag);
588        register_format(&wag_trace);
589}
Note: See TracBrowser for help on using the repository browser.