source: lib/format_wag.c @ 742a332

4.0.1-hotfixescachetimestampsdevelopdpdk-ndagetsilivegetfragoffhelplibtrace4ndag_formatpfringrc-4.0.1rc-4.0.2rc-4.0.3rc-4.0.4ringdecrementfixringperformanceringtimestampfixes
Last change on this file since 742a332 was a7d1914, checked in by Perry Lorier <perry@…>, 15 years ago

Remove packet->size as noone really knew what it held anyway, and disagreements
were more easily settled by removing it than standardising one way or the other.

  • Property mode set to 100644
File size: 16.8 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#else
59#  include <sys/ioctl.h>
60#endif
61
62static struct libtrace_format_t wag;
63static struct libtrace_format_t wag_trace;
64
65#define DATA(x)         ((struct wag_format_data_t *)x->format_data)
66#define DATAOUT(x)      ((struct wag_format_data_out_t *)x->format_data)
67
68#define INPUT DATA(libtrace)->input
69#define OUTPUT DATAOUT(libtrace)->output
70#define OPTIONS DATAOUT(libtrace)->options
71
72struct wag_format_data_t {
73        /** Information about the current state of the input device */
74        union {
75                int fd;
76                libtrace_io_t *file;
77        } input;       
78};
79
80struct wag_format_data_out_t {
81        union {
82                struct {
83                        int level;
84                        int filemode;
85                } zlib;
86        } options;
87        union {
88                int fd;
89                libtrace_io_t *file;
90        } output;
91};
92
93static int wag_init_input(libtrace_t *libtrace) {
94        libtrace->format_data = calloc(1, sizeof(struct wag_format_data_t));
95
96        return 0;
97}
98
99static int wag_start_input(libtrace_t *libtrace)
100{
101        struct stat buf;
102        if (stat(libtrace->uridata,&buf) == -1 ) {
103                trace_set_err(libtrace,errno,"stat(%s)",libtrace->uridata);
104                return -1;
105        }
106#ifndef WIN32
107        if (S_ISCHR(buf.st_mode)) {
108                INPUT.fd = open(libtrace->uridata, O_RDONLY);
109                if (ioctl (INPUT.fd, CAPTURE_RADIOON, 0) == -1) {
110                        trace_set_err(libtrace, errno,
111                                "Could not turn WAG radio on");
112                        return -1;
113                }
114                return 0;
115        }
116#endif
117        trace_set_err(libtrace,TRACE_ERR_INIT_FAILED,
118                        "%s is not a valid char device",
119                        libtrace->uridata);
120        return -1;
121}
122
123static int wtf_init_input(libtrace_t *libtrace) 
124{
125        libtrace->format_data = calloc(1,sizeof(struct wag_format_data_t));
126        return 0;
127}
128
129static int wtf_start_input(libtrace_t *libtrace)
130{
131        if (DATA(libtrace)->input.file)
132                return 0; /* success */
133        DATA(libtrace)->input.file = trace_open_file(libtrace);
134
135        if (!DATA(libtrace)->input.file)
136                return -1; 
137
138        return 0; /* success */
139}
140
141static int wtf_init_output(libtrace_out_t *libtrace) {
142        libtrace->format_data = malloc(sizeof(struct wag_format_data_out_t));
143
144        OUTPUT.file = 0;
145        OPTIONS.zlib.level = 0;
146        OPTIONS.zlib.filemode = O_CREAT | O_WRONLY;
147       
148        return 0;
149}
150
151static int wtf_start_output(libtrace_out_t *libtrace) {
152        OUTPUT.file = trace_open_file_out(libtrace,
153                        OPTIONS.zlib.level,
154                        OPTIONS.zlib.filemode);
155        if (!OUTPUT.file) {
156                return -1;
157        }
158        return 0;
159}
160
161static int wtf_config_output(libtrace_out_t *libtrace, 
162                trace_option_output_t option,
163                void *value) {
164        switch(option) {
165#ifdef HAVE_LIBZ
166                case TRACE_OPTION_OUTPUT_COMPRESS:
167                        OPTIONS.zlib.level = *(int*)value;
168                        assert(OPTIONS.zlib.level>=0 
169                                        && OPTIONS.zlib.level<=9);
170                        return 0;
171#else
172                case TRACE_OPTION_OUTPUT_COMPRESS:
173                        /* E feature unavailable */
174                        trace_set_err_out(libtrace,TRACE_ERR_OPTION_UNAVAIL,
175                                        "zlib not supported");
176                        return -1;
177#endif
178                default:
179                        /* E unknown feature */
180                        trace_set_err_out(libtrace,TRACE_ERR_UNKNOWN_OPTION,
181                                        "Unknown option");
182                        return -1;
183        }
184}
185
186static int wag_pause_input(libtrace_t *libtrace)
187{
188        if (ioctl (INPUT.fd, CAPTURE_RADIOON, 0) == -1) {
189                trace_set_err(libtrace, errno,
190                                "Could not turn WAG radio off");
191        }
192        close(INPUT.fd);
193        return 0;
194}
195
196static int wag_fin_input(libtrace_t *libtrace) {
197        ioctl (INPUT.fd, CAPTURE_RADIOON, 0);
198        free(libtrace->format_data);
199        return 0;
200}
201
202static int wtf_fin_input(libtrace_t *libtrace) {
203        libtrace_io_close(INPUT.file);
204        free(libtrace->format_data);
205        return 0;
206}
207
208static int wtf_fin_output(libtrace_out_t *libtrace) {
209        libtrace_io_close(OUTPUT.file);
210        free(libtrace->format_data);
211        return 0;
212}
213
214static int wag_read(libtrace_t *libtrace, void *buffer, size_t len, 
215                int block) {
216        size_t framesize;
217        char *buf_ptr = (char *)buffer;
218        int to_read = 0;
219        uint16_t magic = 0;
220        long fd_flags;
221       
222        assert(libtrace);
223
224        to_read = sizeof(struct frame_t);
225
226#ifndef WIN32
227        fd_flags = fcntl(INPUT.fd, F_GETFL);
228        if (fd_flags == -1) {
229                /* TODO: Replace with better libtrace-style
230                 * error handling later */
231                perror("Could not get fd flags");
232                return 0;
233        }
234       
235       
236       
237        if (!block) {
238                if (fcntl(INPUT.fd, F_SETFL, fd_flags | O_NONBLOCK) == -1) {
239                        perror("Could not set fd flags");
240                        return 0;
241                }
242        }
243        else {
244                if (fd_flags & O_NONBLOCK) {
245                        fd_flags &= ~O_NONBLOCK;
246                        if (fcntl(INPUT.fd, F_SETFL, fd_flags) == -1) {
247                                perror("Could not set fd flags");
248                                return 0;
249                        }
250                }
251        }
252#endif
253
254        /* I'm not sure if wag has a memory hole which we can use for
255         * zero-copy - something to add in later, I guess */
256       
257        while (to_read>0) {
258                int ret=read(INPUT.fd,buf_ptr,to_read);
259
260                if (ret == -1) {
261                        if (errno == EINTR)
262                                continue;
263                       
264                        if (errno == EAGAIN) {
265                                trace_set_err(libtrace, EAGAIN, "EAGAIN");
266                                return -1;
267                        }
268           
269                        trace_set_err(libtrace,errno,
270                                        "read(%s)",libtrace->uridata);
271                        return -1;
272                }
273
274                assert(ret>0);
275
276                to_read = to_read - ret;
277                buf_ptr = buf_ptr + ret;
278        }
279
280
281        framesize = ntohs(((struct frame_t *)buffer)->size);
282        magic = ntohs(((struct frame_t *)buffer)->magic);
283
284        if (magic != 0xdaa1) {
285          trace_set_err(libtrace,
286                          TRACE_ERR_BAD_PACKET,"magic number bad or missing");
287          return -1;
288        }
289
290        /* We should deal.  this is called "snapping", but we don't yet */
291        assert(framesize<=len);
292
293        buf_ptr = (void*)((char*)buffer + sizeof (struct frame_t));
294        to_read = framesize - sizeof(struct frame_t);
295       
296        while (to_read>0) {
297                int ret=read(INPUT.fd,buf_ptr,to_read);
298
299                if (ret == -1) {
300                        if (errno == EINTR) 
301                                continue;
302                        if (errno == EAGAIN) {
303                                /* What happens to the frame header?! */
304                                trace_set_err(libtrace, EAGAIN, "EAGAIN");
305                                return -1;
306                        }
307                        trace_set_err(libtrace,errno,"read(%s)",
308                                        libtrace->uridata);
309                        return -1;
310                }
311
312                to_read = to_read - ret;
313                buf_ptr = buf_ptr + ret;
314        }
315        return framesize;
316}
317
318
319static int wag_read_packet_versatile(libtrace_t *libtrace, libtrace_packet_t *packet, int block_flag) {
320        int numbytes;
321       
322        if (packet->buf_control == TRACE_CTRL_EXTERNAL || !packet->buffer) {
323                packet->buf_control = TRACE_CTRL_PACKET;
324                packet->buffer = malloc(LIBTRACE_PACKET_BUFSIZE);
325        }
326       
327       
328        packet->trace = libtrace;
329        packet->type = RT_DATA_WAG;
330       
331        if ((numbytes = wag_read(libtrace, (void *)packet->buffer, 
332                                        RP_BUFSIZE, block_flag)) <= 0) {
333           
334                return numbytes;
335        }
336
337       
338        packet->header = packet->buffer;
339        packet->payload=(char*)packet->buffer+trace_get_framing_length(packet);
340        return numbytes;
341}
342
343static int wag_read_packet(libtrace_t *libtrace, libtrace_packet_t *packet) {
344        return wag_read_packet_versatile(libtrace, packet, 1);
345}
346
347static int wtf_read_packet(libtrace_t *libtrace, libtrace_packet_t *packet) {
348        int numbytes;
349        void *buffer;
350        void *buffer2;
351        int framesize;
352        int size;
353
354        if (packet->buf_control == TRACE_CTRL_EXTERNAL || !packet->buffer) {
355                packet->buf_control = TRACE_CTRL_PACKET;
356                packet->buffer = malloc(LIBTRACE_PACKET_BUFSIZE);
357        }
358        packet->type = RT_DATA_WAG;
359        buffer2 = buffer = packet->buffer;
360
361        numbytes = libtrace_io_read(INPUT.file, buffer, sizeof(struct frame_t));
362
363        if (numbytes == 0) {
364                return 0;
365        }
366
367        if (numbytes != sizeof(struct frame_t)) {
368                int err=errno;
369                trace_set_err(libtrace,err,
370                                "read(%s,frame_t)",packet->trace->uridata);
371                printf("failed to read header=%i\n",err);
372                return -1;
373        }
374
375        if (htons(((struct frame_t *)buffer)->magic) != 0xdaa1) {
376                trace_set_err(libtrace,
377                                TRACE_ERR_BAD_PACKET,"Insufficient magic (%04x)",htons(((struct frame_t *)buffer)->magic));
378                return -1;
379        }
380
381        framesize = ntohs(((struct frame_t *)buffer)->size);
382        buffer2 = (char*)buffer + sizeof(struct frame_t);
383        size = framesize - sizeof(struct frame_t);
384        assert(size < LIBTRACE_PACKET_BUFSIZE);
385        assert(size > 0);
386       
387        if ((numbytes=libtrace_io_read(INPUT.file, buffer2, size)) != size) {
388                trace_set_err(libtrace,
389                                errno,"read(%s,buffer)",packet->trace->uridata);
390                return -1;
391        }
392
393        packet->header = packet->buffer;
394        packet->payload=(char*)packet->buffer+trace_get_framing_length(packet);
395        return framesize;
396       
397}                               
398       
399static int wtf_write_packet(libtrace_out_t *libtrace, libtrace_packet_t *packet)
400{ 
401        int numbytes =0 ;
402        if (packet->trace->format != &wag_trace) {
403                trace_set_err_out(libtrace,TRACE_ERR_NO_CONVERSION,
404                                "Cannot convert to wag trace format from %s format yet",
405                                packet->trace->format->name);
406                return -1;
407        }
408
409        /* We could just read from packet->buffer, but I feel it is more
410         * technically correct to read from the header and payload pointers
411         */
412        if ((numbytes = libtrace_io_write(OUTPUT.file, packet->header, 
413                                trace_get_framing_length(packet))) 
414                        !=(int)trace_get_framing_length(packet)) {
415                trace_set_err_out(libtrace,errno,
416                                "write(%s)",packet->trace->uridata);
417                return -1;
418        }
419        if ((numbytes = libtrace_io_write(OUTPUT.file, packet->payload, 
420                                trace_get_capture_length(packet)) 
421                                != (int)trace_get_capture_length(packet))) {
422                trace_set_err_out(libtrace,
423                                errno,"write(%s)",packet->trace->uridata);
424                return -1;
425        }
426        return numbytes;
427}
428
429static libtrace_linktype_t wag_get_link_type(const libtrace_packet_t *packet UNUSED) {
430        return TRACE_TYPE_80211;
431}
432
433static libtrace_direction_t wag_get_direction(const libtrace_packet_t *packet) {
434        struct frame_data_rx_t *wagptr = (struct frame_data_rx_t *)packet->buffer;
435        if (wagptr->hdr.type == 0) {
436                return wagptr->hdr.subtype; 
437        }
438        return -1;
439}
440
441static uint64_t wag_get_erf_timestamp(const libtrace_packet_t *packet) {
442        struct frame_data_rx_t *wagptr = (struct frame_data_rx_t *)packet->buffer;
443        uint64_t timestamp = 0;
444        timestamp = ((uint64_t)(ntohl(wagptr->ts.secs)) << 32) | (uint64_t)(ntohl(wagptr->ts.subsecs));
445        return timestamp;
446}
447
448static int wag_get_capture_length(const libtrace_packet_t *packet) {
449       
450        struct frame_t * wag_frame_data = (struct frame_t *)packet->header;
451       
452        if (wag_frame_data->subtype == FRAME_SUBTYPE_DATA_RX) {
453                struct frame_data_rx_t *wag_hdr = 
454                        (struct frame_data_rx_t *)packet->header;
455                return ntohs(wag_hdr->rxinfo.length);
456        }
457
458        if (wag_frame_data->subtype == FRAME_SUBTYPE_DATA_TX) {
459                struct frame_data_tx_t *wag_hdr =
460                       (struct frame_data_tx_t *)packet->header;
461                return ntohs(wag_hdr->txinfo.length);
462        }
463
464        /* default option - not optimal as there tends to be an
465         * extra 2 bytes floating around somewhere */
466        return ntohs(((struct frame_t *)packet->header)->size)
467                -sizeof(struct frame_data_rx_t);
468}
469
470static int wag_get_wire_length(const libtrace_packet_t *packet) {
471        struct frame_t * wag_frame_data = (struct frame_t *)packet->header;
472
473       
474        if (wag_frame_data->subtype == FRAME_SUBTYPE_DATA_RX) {
475                struct frame_data_rx_t *wag_hdr = 
476                        (struct frame_data_rx_t *)packet->header;
477                return ntohs(wag_hdr->rxinfo.length);
478        }
479
480        if (wag_frame_data->subtype == FRAME_SUBTYPE_DATA_TX) {
481                struct frame_data_tx_t *wag_hdr =
482                       (struct frame_data_tx_t *)packet->header;
483                return ntohs(wag_hdr->txinfo.length);
484        }
485       
486        /* default option - not optimal as there tends to be an
487         * extra 2 bytes floating around somewhere */
488        return ntohs(((struct frame_t *)packet->header)->size)
489                -sizeof(struct frame_data_rx_t);
490}
491
492static int wag_get_framing_length(UNUSED const libtrace_packet_t *packet) {
493        /* There's an extra two bytes floating around somewhere that
494         * we can't account for! */
495        return sizeof(struct frame_data_rx_t);
496}
497
498static int wag_get_fd(const libtrace_t *trace) {
499        return DATA(trace)->input.fd;
500}
501
502struct libtrace_eventobj_t trace_event_wag(libtrace_t *trace, libtrace_packet_t *packet) {
503        struct libtrace_eventobj_t event = {0,0,0.0,0};
504        libtrace_err_t read_err;
505
506        assert(trace);
507        assert(packet);
508
509        /* We could probably just call get_fd here */
510        if (trace->format->get_fd) {
511                event.fd = trace->format->get_fd(trace);
512        } else {
513                event.fd = 0;
514        }
515       
516        event.size = wag_read_packet_versatile(trace, packet, 0);
517        if (event.size == -1) {
518                read_err = trace_get_err(trace);
519                if (read_err.err_num == EAGAIN) {
520                        event.type = TRACE_EVENT_IOWAIT;
521                }
522                else {
523                        printf("Packet error\n");
524                        event.type = TRACE_EVENT_PACKET;
525                }
526        } else if (event.size == 0) {
527                event.type = TRACE_EVENT_TERMINATE;
528        } else {
529                event.type = TRACE_EVENT_PACKET;
530        }
531
532        return event;
533}
534       
535static void wag_help() {
536        printf("wag format module: $Revision$\n");
537        printf("Supported input URIs:\n");
538        printf("\twag:/dev/wagn\n");
539        printf("\n");
540        printf("\te.g.: wag:/dev/wag0\n");
541        printf("\n");
542        printf("Supported output URIs:\n");
543        printf("\tNone\n");
544        printf("\n");
545}
546
547static void wtf_help() {
548        printf("wag trace format module: $Revision$\n");
549        printf("Supported input URIs:\n");
550        printf("\twtf:/path/to/trace.wag\n");
551        printf("\twtf:/path/to/trace.wag.gz\n");
552        printf("\n");
553        printf("\te.g.: wtf:/tmp/trace.wag.gz\n");
554        printf("\n");
555        printf("Supported output URIs:\n");
556        printf("\twtf:/path/to/trace.wag\n");
557        printf("\twtf:/path/to/trace.wag.gz\n");
558        printf("\n");
559        printf("\te.g.: wtf:/tmp/trace.wag.gz\n");
560        printf("\n");
561}
562
563static struct libtrace_format_t wag = {
564        "wag",
565        "$Id$",
566        TRACE_FORMAT_WAG,
567        wag_init_input,                 /* init_input */       
568        NULL,                           /* config_input */
569        wag_start_input,                /* start_input */
570        wag_pause_input,                /* pause_input */
571        NULL,                           /* init_output */
572        NULL,                           /* config_output */
573        NULL,                           /* start_output */
574        wag_fin_input,                  /* fin_input */
575        NULL,                           /* fin_output */
576        wag_read_packet,                /* read_packet */
577        NULL,                           /* fin_packet */
578        NULL,                           /* write_packet */
579        wag_get_link_type,              /* get_link_type */
580        wag_get_direction,              /* get_direction */
581        NULL,                           /* set_direction */
582        wag_get_erf_timestamp,          /* get_erf_timestamp */
583        NULL,                           /* get_timeval */
584        NULL,                           /* get_seconds */
585        NULL,                           /* seek_erf */
586        NULL,                           /* seek_timeval */
587        NULL,                           /* seek_seconds */
588        wag_get_capture_length,         /* get_capture_length */
589        wag_get_wire_length,            /* get_wire_length */
590        wag_get_framing_length,         /* get_framing_length */
591        NULL,                           /* set_capture_length */
592        wag_get_fd,                     /* get_fd */
593        trace_event_wag,                /* trace_event */
594        wag_help,                       /* help */
595        NULL                            /* next pointer */
596};
597
598/* wtf stands for Wag Trace Format */
599
600static struct libtrace_format_t wag_trace = {
601        "wtf",
602        "$Id$",
603        TRACE_FORMAT_WAG,
604        wtf_init_input,                 /* init_input */
605        NULL,                           /* config input */
606        wtf_start_input,                /* start input */
607        NULL,                           /* pause_input */
608        wtf_init_output,                /* init_output */
609        wtf_config_output,              /* config_output */
610        wtf_start_output,               /* start output */
611        wtf_fin_input,                  /* fin_input */
612        wtf_fin_output,                 /* fin_output */
613        wtf_read_packet,                /* read_packet */
614        NULL,                           /* fin_packet */
615        wtf_write_packet,               /* write_packet */
616        wag_get_link_type,              /* get_link_type */
617        wag_get_direction,              /* get_direction */
618        NULL,                           /* set_direction */
619        wag_get_erf_timestamp,          /* get_erf_timestamp */
620        NULL,                           /* get_timeval */
621        NULL,                           /* get_seconds */
622        NULL,                           /* seek_erf */
623        NULL,                           /* seek_timeval */
624        NULL,                           /* seek_seconds */
625        wag_get_capture_length,         /* get_capture_length */
626        wag_get_wire_length,            /* get_wire_length */
627        wag_get_framing_length,         /* get_framing_length */
628        NULL,                           /* set_capture_length */
629        NULL,                           /* get_fd */
630        trace_event_trace,              /* trace_event */
631        wtf_help,                       /* help */
632        NULL                            /* next pointer */
633};
634
635
636void wag_constructor() {
637        register_format(&wag);
638        register_format(&wag_trace);
639}
Note: See TracBrowser for help on using the repository browser.