source: lib/format_wag.c @ aeee9db

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

Added non_blocking read support for wag devices
Created trace_event_wag to bypass the lack of FIONREAD ioctl
Fixed bug where packet->size wasn't being set when wag device reads a packet

  • 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        fd_flags = fcntl(INPUT.fd, F_GETFL);
215        if (fd_flags == -1) {
216                /* TODO: Replace with better libtrace-style
217                 * error handling later */
218                perror("Could not get fd flags");
219                return 0;
220        }
221       
222       
223       
224        if (!block) {
225                if (fcntl(INPUT.fd, F_SETFL, fd_flags | O_NONBLOCK) == -1) {
226                        perror("Could not set fd flags");
227                        return 0;
228                }
229        }
230        else {
231                if (fd_flags & O_NONBLOCK) {
232                        fd_flags &= ~O_NONBLOCK;
233                        if (fcntl(INPUT.fd, F_SETFL, fd_flags) == -1) {
234                                perror("Could not set fd flags");
235                                return 0;
236                        }
237                }
238        }
239
240        /* I'm not sure if wag has a memory hole which we can use for
241         * zero-copy - something to add in later, I guess */
242       
243        while (to_read>0) {
244                int ret=read(INPUT.fd,buf_ptr,to_read);
245
246                if (ret == -1) {
247                        if (errno == EINTR)
248                                continue;
249                       
250                        if (errno == EAGAIN) {
251                                trace_set_err(libtrace, EAGAIN, "EAGAIN");
252                                return -1;
253                        }
254           
255                        trace_set_err(libtrace,errno,
256                                        "read(%s)",libtrace->uridata);
257                        return -1;
258                }
259
260                assert(ret>0);
261
262                to_read = to_read - ret;
263                buf_ptr = buf_ptr + ret;
264        }
265
266
267        framesize = ntohs(((struct frame_t *)buffer)->size);
268        magic = ntohs(((struct frame_t *)buffer)->magic);
269
270        if (magic != 0xdaa1) {
271          trace_set_err(libtrace,
272                          TRACE_ERR_BAD_PACKET,"magic number bad or missing");
273          return -1;
274        }
275
276        /* We should deal.  this is called "snapping", but we don't yet */
277        assert(framesize<=len);
278
279        buf_ptr = (void*)((char*)buffer + sizeof (struct frame_t));
280        to_read = framesize - sizeof(struct frame_t);
281       
282        while (to_read>0) {
283                int ret=read(INPUT.fd,buf_ptr,to_read);
284
285                if (ret == -1) {
286                        if (errno == EINTR) 
287                                continue;
288                        if (errno == EAGAIN) {
289                                /* What happens to the frame header?! */
290                                trace_set_err(libtrace, EAGAIN, "EAGAIN");
291                                return -1;
292                        }
293                        trace_set_err(libtrace,errno,"read(%s)",
294                                        libtrace->uridata);
295                        return -1;
296                }
297
298                to_read = to_read - ret;
299                buf_ptr = buf_ptr + ret;
300        }
301        return framesize;
302}
303
304
305static int wag_read_packet_versatile(libtrace_t *libtrace, libtrace_packet_t *packet, int block_flag) {
306        int numbytes;
307       
308        if (packet->buf_control == TRACE_CTRL_EXTERNAL || !packet->buffer) {
309                packet->buf_control = TRACE_CTRL_PACKET;
310                packet->buffer = malloc(LIBTRACE_PACKET_BUFSIZE);
311        }
312       
313       
314        packet->trace = libtrace;
315        packet->type = RT_DATA_WAG;
316       
317        if ((numbytes = wag_read(libtrace, (void *)packet->buffer, 
318                                        RP_BUFSIZE, block_flag)) <= 0) {
319           
320                return numbytes;
321        }
322
323       
324        packet->header = packet->buffer;
325        packet->payload=(char*)packet->buffer+trace_get_framing_length(packet);
326        packet->size = trace_get_framing_length(packet) + trace_get_capture_length(packet);
327        return numbytes;
328}
329
330static int wag_read_packet(libtrace_t *libtrace, libtrace_packet_t *packet) {
331        return wag_read_packet_versatile(libtrace, packet, 1);
332}
333
334static int wtf_read_packet(libtrace_t *libtrace, libtrace_packet_t *packet) {
335        int numbytes;
336        void *buffer;
337        void *buffer2;
338        int framesize;
339        int size;
340
341        if (packet->buf_control == TRACE_CTRL_EXTERNAL || !packet->buffer) {
342                packet->buf_control = TRACE_CTRL_PACKET;
343                packet->buffer = malloc(LIBTRACE_PACKET_BUFSIZE);
344        }
345        packet->type = RT_DATA_WAG;
346        buffer2 = buffer = packet->buffer;
347
348        numbytes = libtrace_io_read(INPUT.file, buffer, sizeof(struct frame_t));
349
350        if (numbytes == 0) {
351                return 0;
352        }
353
354        if (numbytes != sizeof(struct frame_t)) {
355                int err=errno;
356                trace_set_err(libtrace,err,
357                                "read(%s,frame_t)",packet->trace->uridata);
358                printf("failed to read header=%i\n",err);
359                return -1;
360        }
361
362        if (htons(((struct frame_t *)buffer)->magic) != 0xdaa1) {
363                trace_set_err(libtrace,
364                                TRACE_ERR_BAD_PACKET,"Insufficient magic (%04x)",htons(((struct frame_t *)buffer)->magic));
365                return -1;
366        }
367
368        framesize = ntohs(((struct frame_t *)buffer)->size);
369        buffer2 = (char*)buffer + sizeof(struct frame_t);
370        size = framesize - sizeof(struct frame_t);
371        assert(size < LIBTRACE_PACKET_BUFSIZE);
372        assert(size > 0);
373       
374        if ((numbytes=libtrace_io_read(INPUT.file, buffer2, size)) != size) {
375                trace_set_err(libtrace,
376                                errno,"read(%s,buffer)",packet->trace->uridata);
377                return -1;
378        }
379
380        packet->header = packet->buffer;
381        packet->payload=(char*)packet->buffer+trace_get_framing_length(packet);
382        return framesize;
383       
384}                               
385       
386static int wtf_write_packet(libtrace_out_t *libtrace, const libtrace_packet_t *packet) {
387        int numbytes =0 ;
388        if (packet->trace->format != &wag_trace) {
389                trace_set_err_out(libtrace,TRACE_ERR_NO_CONVERSION,
390                                "Cannot convert to wag trace format from %s format yet",
391                                packet->trace->format->name);
392                return -1;
393        }
394
395        /* We could just read from packet->buffer, but I feel it is more
396         * technically correct to read from the header and payload pointers
397         */
398        if ((numbytes = libtrace_io_write(OUTPUT.file, packet->header, 
399                                trace_get_framing_length(packet))) == -1) {
400                trace_set_err_out(libtrace,errno,
401                                "write(%s)",packet->trace->uridata);
402                return -1;
403        }
404        if ((numbytes = libtrace_io_write(OUTPUT.file, packet->payload, 
405                                trace_get_capture_length(packet)) == -1)) {
406                trace_set_err_out(libtrace,
407                                errno,"write(%s)",packet->trace->uridata);
408                return -1;
409        }
410        return numbytes;
411}
412
413static libtrace_linktype_t wag_get_link_type(const libtrace_packet_t *packet UNUSED) {
414        return TRACE_TYPE_80211;
415}
416
417static int8_t wag_get_direction(const libtrace_packet_t *packet) {
418        struct frame_data_rx_t *wagptr = (struct frame_data_rx_t *)packet->buffer;
419        if (wagptr->hdr.type == 0) {
420                return wagptr->hdr.subtype; 
421        }
422        return -1;
423}
424
425static uint64_t wag_get_erf_timestamp(const libtrace_packet_t *packet) {
426        struct frame_data_rx_t *wagptr = (struct frame_data_rx_t *)packet->buffer;
427        uint64_t timestamp = 0;
428        timestamp = ((uint64_t)(ntohl(wagptr->ts.secs)) << 32) | (uint64_t)(ntohl(wagptr->ts.subsecs));
429        return timestamp;
430}
431
432static int wag_get_capture_length(const libtrace_packet_t *packet) {
433        return ntohs(((struct frame_t *)packet->header)->size)
434                -sizeof(struct frame_data_rx_t);
435}
436
437static int wag_get_wire_length(const libtrace_packet_t *packet) {
438        return ntohs(((struct frame_t *)packet->header)->size)
439                -sizeof(struct frame_data_rx_t);
440}
441
442static int wag_get_framing_length(UNUSED const libtrace_packet_t *packet) {
443        return sizeof(struct frame_data_rx_t);
444}
445
446static int wag_get_fd(const libtrace_t *trace) {
447        return DATA(trace)->input.fd;
448}
449
450struct libtrace_eventobj_t trace_event_wag(libtrace_t *trace, libtrace_packet_t *packet) {
451        struct libtrace_eventobj_t event = {0,0,0.0,0};
452        libtrace_err_t read_err;
453
454        assert(trace);
455        assert(packet);
456
457        /* We could probably just call get_fd here */
458        if (trace->format->get_fd) {
459                event.fd = trace->format->get_fd(trace);
460        } else {
461                event.fd = 0;
462        }
463       
464        event.size = wag_read_packet_versatile(trace, packet, 0);
465        if (event.size == -1) {
466                read_err = trace_get_err(trace);
467                if (read_err.err_num = EAGAIN) {
468                        event.type = TRACE_EVENT_IOWAIT;
469                }
470                else {
471                        printf("Packet error\n");
472                        event.type = TRACE_EVENT_PACKET;
473                }
474        } else if (event.size == 0) {
475                event.type = TRACE_EVENT_TERMINATE;
476        } else {
477                event.type = TRACE_EVENT_PACKET;
478        }
479
480        return event;
481}
482       
483static void wag_help() {
484        printf("wag format module: $Revision$\n");
485        printf("Supported input URIs:\n");
486        printf("\twag:/dev/wagn\n");
487        printf("\n");
488        printf("\te.g.: wag:/dev/wag0\n");
489        printf("\n");
490        printf("Supported output URIs:\n");
491        printf("\tNone\n");
492        printf("\n");
493}
494
495static void wtf_help() {
496        printf("wag trace format module: $Revision$\n");
497        printf("Supported input URIs:\n");
498        printf("\twtf:/path/to/trace.wag\n");
499        printf("\twtf:/path/to/trace.wag.gz\n");
500        printf("\n");
501        printf("\te.g.: wtf:/tmp/trace.wag.gz\n");
502        printf("\n");
503        printf("Supported output URIs:\n");
504        printf("\twtf:/path/to/trace.wag\n");
505        printf("\twtf:/path/to/trace.wag.gz\n");
506        printf("\n");
507        printf("\te.g.: wtf:/tmp/trace.wag.gz\n");
508        printf("\n");
509}
510
511static struct libtrace_format_t wag = {
512        "wag",
513        "$Id$",
514        TRACE_FORMAT_WAG,
515        wag_init_input,                 /* init_input */       
516        NULL,                           /* config_input */
517        wag_start_input,                /* start_input */
518        wag_pause_input,                /* pause_input */
519        NULL,                           /* init_output */
520        NULL,                           /* config_output */
521        NULL,                           /* start_output */
522        wag_fin_input,                  /* fin_input */
523        NULL,                           /* fin_output */
524        wag_read_packet,                /* read_packet */
525        NULL,                           /* fin_packet */
526        NULL,                           /* write_packet */
527        wag_get_link_type,              /* get_link_type */
528        wag_get_direction,              /* get_direction */
529        NULL,                           /* set_direction */
530        wag_get_erf_timestamp,          /* get_erf_timestamp */
531        NULL,                           /* get_timeval */
532        NULL,                           /* get_seconds */
533        NULL,                           /* seek_erf */
534        NULL,                           /* seek_timeval */
535        NULL,                           /* seek_seconds */
536        wag_get_capture_length,         /* get_capture_length */
537        wag_get_wire_length,            /* get_wire_length */
538        wag_get_framing_length,         /* get_framing_length */
539        NULL,                           /* set_capture_length */
540        wag_get_fd,                     /* get_fd */
541        trace_event_wag,                /* trace_event */
542        wag_help,                       /* help */
543        NULL                            /* next pointer */
544};
545
546/* wtf stands for Wag Trace Format */
547
548static struct libtrace_format_t wag_trace = {
549        "wtf",
550        "$Id$",
551        TRACE_FORMAT_WAG,
552        wtf_init_input,                 /* init_input */
553        NULL,                           /* config input */
554        wtf_start_input,                /* start input */
555        NULL,                           /* pause_input */
556        wtf_init_output,                /* init_output */
557        wtf_config_output,              /* config_output */
558        wtf_start_output,               /* start output */
559        wtf_fin_input,                  /* fin_input */
560        wtf_fin_output,                 /* fin_output */
561        wtf_read_packet,                /* read_packet */
562        NULL,                           /* fin_packet */
563        wtf_write_packet,               /* write_packet */
564        wag_get_link_type,              /* get_link_type */
565        wag_get_direction,              /* get_direction */
566        NULL,                           /* set_direction */
567        wag_get_erf_timestamp,          /* get_erf_timestamp */
568        NULL,                           /* get_timeval */
569        NULL,                           /* get_seconds */
570        NULL,                           /* seek_erf */
571        NULL,                           /* seek_timeval */
572        NULL,                           /* seek_seconds */
573        wag_get_capture_length,         /* get_capture_length */
574        wag_get_wire_length,            /* get_wire_length */
575        wag_get_framing_length,         /* get_framing_length */
576        NULL,                           /* set_capture_length */
577        NULL,                           /* get_fd */
578        trace_event_trace,              /* trace_event */
579        wtf_help,                       /* help */
580        NULL                            /* next pointer */
581};
582
583
584void CONSTRUCTOR wag_constructor() {
585        register_format(&wag);
586        register_format(&wag_trace);
587}
Note: See TracBrowser for help on using the repository browser.