source: lib/format_pcapfile.c @ 5ceb545

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

If the file was never opened, don't bother trying to close it.
(Reported by Nevil Brownlee)

  • Property mode set to 100644
File size: 15.4 KB
Line 
1/*
2 * This file is part of libtrace
3 *
4 * Copyright (c) 2007,2008 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#include "common.h"
32#include "config.h"
33#include "libtrace.h"
34#include "libtrace_int.h"
35#include "format_helper.h"
36
37#include <sys/stat.h>
38#include <assert.h>
39#include <stdio.h>
40#include <stdlib.h>
41#include <string.h>
42#include <errno.h>
43#include <fcntl.h>
44
45#define DATA(x) ((struct pcapfile_format_data_t*)((x)->format_data))
46#define DATAOUT(x) ((struct pcapfile_format_data_out_t*)((x)->format_data))
47#define IN_OPTIONS DATA(libtrace)->options
48
49typedef struct pcapfile_header_t {
50                uint32_t magic_number;   /* magic number */
51                uint16_t version_major;  /* major version number */
52                uint16_t version_minor;  /* minor version number */
53                int32_t  thiszone;       /* GMT to local correction */
54                uint32_t sigfigs;        /* timestamp accuracy */
55                uint32_t snaplen;        /* aka "wirelen" */
56                uint32_t network;        /* data link type */
57} pcapfile_header_t; 
58
59struct pcapfile_format_data_t {
60        libtrace_io_t *file;
61        struct {
62                int real_time;
63        } options;
64        pcapfile_header_t header;
65};
66
67struct pcapfile_format_data_out_t {
68        libtrace_io_t *file;
69        int level;
70        int flag;
71
72};
73
74static int pcapfile_init_input(libtrace_t *libtrace) {
75        libtrace->format_data = malloc(sizeof(struct pcapfile_format_data_t));
76
77        if (libtrace->format_data == NULL) {
78                trace_set_err(libtrace,ENOMEM,"Out of memory");
79                return -1;
80        }
81
82        DATA(libtrace)->file=NULL;
83        IN_OPTIONS.real_time = 0;
84        return 0;
85}
86
87static int pcapfile_init_output(libtrace_out_t *libtrace) {
88        libtrace->format_data = 
89                malloc(sizeof(struct pcapfile_format_data_out_t));
90
91        DATAOUT(libtrace)->file=NULL;
92        DATAOUT(libtrace)->level=0;
93        DATAOUT(libtrace)->flag=O_CREAT|O_WRONLY;
94
95        return 0;
96}
97
98static uint16_t swaps(libtrace_t *libtrace, uint16_t num)
99{
100        /* to deal with open_dead traces that might try and use this
101         * if we don't have any per trace data, assume host byte order
102         */
103        if (!DATA(libtrace))
104                return num;
105        if (DATA(libtrace)->header.magic_number == 0xd4c3b2a1)
106                return byteswap16(num);
107
108        return num;
109}
110
111static uint32_t swapl(libtrace_t *libtrace, uint32_t num)
112{
113        /* to deal with open_dead traces that might try and use this
114         * if we don't have any per trace data, assume host byte order
115         */
116        if (!DATA(libtrace))
117                return num;
118        if (DATA(libtrace)->header.magic_number == 0xd4c3b2a1)
119                return byteswap32(num);
120
121        return num;
122}
123
124
125static int pcapfile_start_input(libtrace_t *libtrace) 
126{
127        int err;
128
129        if (!DATA(libtrace)->file) {
130                DATA(libtrace)->file=trace_open_file(libtrace);
131
132                if (!DATA(libtrace)->file)
133                        return -1;
134
135                err=libtrace_io_read(DATA(libtrace)->file,
136                                &DATA(libtrace)->header,
137                                sizeof(DATA(libtrace)->header));
138
139                if (err<1)
140                        return -1;
141               
142                if (swapl(libtrace,DATA(libtrace)->header.magic_number) != 0xa1b2c3d4) {
143                        trace_set_err(libtrace,TRACE_ERR_INIT_FAILED,"Not a pcap tracefile\n");
144                        return -1; /* Not a pcap file */
145                }
146
147                if (swaps(libtrace,DATA(libtrace)->header.version_major)!=2
148                        && swaps(libtrace,DATA(libtrace)->header.version_minor)!=4) {
149                        trace_set_err(libtrace,TRACE_ERR_INIT_FAILED,"Unknown pcap tracefile version %d.%d\n",
150                                        swaps(libtrace,
151                                                DATA(libtrace)->header.version_major),
152                                        swaps(libtrace,
153                                                DATA(libtrace)->header.version_minor));
154                        return -1;
155                }
156
157        }
158
159        return 0;
160}
161
162static int pcapfile_start_output(libtrace_out_t *libtrace UNUSED)
163{
164        return 0;
165}
166
167static int pcapfile_config_input(libtrace_t *libtrace,
168                trace_option_t option,
169                void *data)
170{
171        switch(option) {
172                case TRACE_OPTION_EVENT_REALTIME:
173                        IN_OPTIONS.real_time = *(int *)data;
174                        return 0;
175                case TRACE_OPTION_META_FREQ:
176                case TRACE_OPTION_SNAPLEN:
177                case TRACE_OPTION_PROMISC:
178                case TRACE_OPTION_FILTER:
179                        /* all these are either unsupported or handled
180                         * by trace_config */
181                        break;
182        }
183       
184        trace_set_err(libtrace,TRACE_ERR_UNKNOWN_OPTION,
185                        "Unknown option %i", option);
186        return -1;
187}
188
189static int pcapfile_fin_input(libtrace_t *libtrace) 
190{
191        if (DATA(libtrace)->file)
192                libtrace_io_close(DATA(libtrace)->file);
193        free(libtrace->format_data);
194        return 0; /* success */
195}
196
197static int pcapfile_fin_output(libtrace_out_t *libtrace)
198{
199        if (DATA(libtrace)->file)
200                libtrace_io_close(DATA(libtrace)->file);
201        free(libtrace->format_data);
202        libtrace->format_data=NULL;
203        return 0; /* success */
204}
205
206static int pcapfile_config_output(libtrace_out_t *libtrace,
207                trace_option_output_t option,
208                void *value)
209{
210        switch (option) {
211                case TRACE_OPTION_OUTPUT_COMPRESS:
212                        DATAOUT(libtrace)->level = *(int*)value;
213                        return 0;
214                case TRACE_OPTION_OUTPUT_FILEFLAGS:
215                        DATAOUT(libtrace)->flag = *(int*)value;
216                        return 0;
217                default:
218                        /* Unknown option */
219                        trace_set_err_out(libtrace,TRACE_ERR_UNKNOWN_OPTION,
220                                        "Unknown option");
221                        return -1;
222        }
223        return -1;
224}
225
226static int pcapfile_prepare_packet(libtrace_t *libtrace, 
227                libtrace_packet_t *packet, void *buffer, 
228                libtrace_rt_types_t rt_type, uint32_t flags) {
229
230        if (packet->buffer != buffer && 
231                        packet->buf_control == TRACE_CTRL_PACKET) {
232                free(packet->buffer);
233        }
234
235        if ((flags & TRACE_PREP_OWN_BUFFER) == TRACE_PREP_OWN_BUFFER) {
236                packet->buf_control = TRACE_CTRL_PACKET;
237        } else
238                packet->buf_control = TRACE_CTRL_EXTERNAL;
239       
240       
241        packet->buffer = buffer;
242        packet->header = buffer;
243        packet->payload = (char*)packet->buffer
244                + sizeof(libtrace_pcapfile_pkt_hdr_t);
245        packet->type = rt_type; 
246
247        if (libtrace->format_data == NULL) {
248                if (pcapfile_init_input(libtrace))
249                        return -1;
250        }
251       
252        return 0;
253}
254
255static int pcapfile_read_packet(libtrace_t *libtrace, libtrace_packet_t *packet)
256{
257        int err;
258        uint32_t flags = 0;
259       
260        assert(libtrace->format_data);
261
262        packet->type = pcap_linktype_to_rt(swapl(libtrace,
263                                DATA(libtrace)->header.network));
264
265        if (!packet->buffer || packet->buf_control == TRACE_CTRL_EXTERNAL) {
266                packet->buffer = malloc((size_t)LIBTRACE_PACKET_BUFSIZE);
267        }
268
269        flags |= TRACE_PREP_OWN_BUFFER;
270       
271        err=libtrace_io_read(DATA(libtrace)->file,
272                        packet->buffer,
273                        sizeof(libtrace_pcapfile_pkt_hdr_t));
274
275        if (err<0) {
276                trace_set_err(libtrace,errno,"reading packet");
277                return -1;
278        }
279        if (err==0) {
280                /* EOF */
281                return 0;
282        }
283
284        err=libtrace_io_read(DATA(libtrace)->file,
285                        (char*)packet->buffer+sizeof(libtrace_pcapfile_pkt_hdr_t),
286                        (size_t)swapl(libtrace,((libtrace_pcapfile_pkt_hdr_t*)packet->buffer)->caplen)
287                        );
288
289       
290        if (err<0) {
291                trace_set_err(libtrace,errno,"reading packet");
292                return -1;
293        }
294        if (err==0) {
295                return 0;
296        }
297
298        if (pcapfile_prepare_packet(libtrace, packet, packet->buffer,
299                                packet->type, flags)) {
300                return -1;
301        }
302       
303        return sizeof(libtrace_pcapfile_pkt_hdr_t)
304                +swapl(libtrace,((libtrace_pcapfile_pkt_hdr_t*)packet->buffer)->caplen);
305}
306
307static int pcapfile_write_packet(libtrace_out_t *out,
308                libtrace_packet_t *packet)
309{
310        struct libtrace_pcapfile_pkt_hdr_t hdr;
311        struct timeval tv = trace_get_timeval(packet);
312        int numbytes;
313        int ret;
314        void *ptr;
315        uint32_t remaining;
316        libtrace_linktype_t linktype;
317
318        ptr = trace_get_packet_buffer(packet,&linktype,&remaining);
319       
320        /* Silently discard RT metadata packets and packets with an
321         * unknown linktype. */
322        if (linktype == TRACE_TYPE_METADATA || linktype == -1) {
323                return 0;
324        }
325
326        /* If this packet cannot be converted to a pcap linktype then
327         * pop off the top header until it can be converted
328         */
329        while (libtrace_to_pcap_linktype(linktype)==~0U) {
330                if (!demote_packet(packet)) {
331                        trace_set_err_out(out, 
332                                TRACE_ERR_NO_CONVERSION,
333                                "pcap does not support this format");
334                        return -1;
335                }
336
337                ptr = trace_get_packet_buffer(packet,&linktype,&remaining);
338        }
339
340
341        /* Now we know the link type write out a header if we've not done
342         * so already
343         */
344        if (!DATAOUT(out)->file) {
345                struct pcapfile_header_t pcaphdr;
346
347                DATAOUT(out)->file=trace_open_file_out(out,
348                                DATAOUT(out)->level,
349                                DATAOUT(out)->flag);
350                if (!DATAOUT(out)->file)
351                        return -1;
352
353                pcaphdr.magic_number = 0xa1b2c3d4;
354                pcaphdr.version_major = 2;
355                pcaphdr.version_minor = 4;
356                pcaphdr.thiszone = 0;
357                pcaphdr.sigfigs = 0;
358                pcaphdr.snaplen = 65536;
359                pcaphdr.network = 
360                        libtrace_to_pcap_linktype(linktype);
361
362                libtrace_io_write(DATAOUT(out)->file, 
363                                &pcaphdr, sizeof(pcaphdr));
364        }
365
366        hdr.ts_sec = tv.tv_sec;
367        hdr.ts_usec = tv.tv_usec;
368        hdr.caplen = trace_get_capture_length(packet);
369        /* PCAP doesn't include the FCS, we do */
370        if (linktype==TRACE_TYPE_ETH)
371                if (trace_get_wire_length(packet) >= 4) {
372                        hdr.wirelen = trace_get_wire_length(packet)-4;
373                }
374                else {
375                        hdr.wirelen = 0;
376                }
377        else
378                hdr.wirelen = trace_get_wire_length(packet);
379
380
381        numbytes=libtrace_io_write(DATAOUT(out)->file,
382                        &hdr, sizeof(hdr));
383
384        if (numbytes!=sizeof(hdr)) 
385                return -1;
386
387        ret=libtrace_io_write(DATAOUT(out)->file,
388                        ptr,
389                        remaining);
390
391        if (ret!=(int)remaining)
392                return -1;
393
394        return numbytes+ret;
395}
396
397static libtrace_linktype_t pcapfile_get_link_type(
398                const libtrace_packet_t *packet) 
399{
400#if 0
401        return pcap_linktype_to_libtrace(
402                        swapl(packet->trace,
403                                DATA(packet->trace)->header.network
404                             )
405                        );
406#endif
407        return pcap_linktype_to_libtrace(rt_to_pcap_linktype(packet->type));
408}
409
410static libtrace_direction_t pcapfile_get_direction(const libtrace_packet_t *packet) 
411{
412        libtrace_direction_t direction  = -1;
413        switch(pcapfile_get_link_type(packet)) {
414                case TRACE_TYPE_LINUX_SLL:
415                {
416                        libtrace_sll_header_t *sll;
417                        libtrace_linktype_t linktype;
418
419                        sll = (libtrace_sll_header_t*)trace_get_packet_buffer(
420                                        packet,
421                                        &linktype,
422                                        NULL);
423                        if (!sll) {
424                                trace_set_err(packet->trace,
425                                        TRACE_ERR_BAD_PACKET,
426                                                "Bad or missing packet");
427                                return -1;
428                        }
429                        /* 0 == LINUX_SLL_HOST */
430                        /* the Waikato Capture point defines "packets
431                         * originating locally" (ie, outbound), with a
432                         * direction of 0, and "packets destined locally"
433                         * (ie, inbound), with a direction of 1.
434                         * This is kind-of-opposite to LINUX_SLL.
435                         * We return consistent values here, however
436                         *
437                         * Note that in recent versions of pcap, you can
438                         * use "inbound" and "outbound" on ppp in linux
439                         */
440                        if (ntohs(sll->pkttype == 0)) {
441                                direction = TRACE_DIR_INCOMING;
442                        } else {
443                                direction = TRACE_DIR_OUTGOING;
444                        }
445                        break;
446
447                }
448                case TRACE_TYPE_PFLOG:
449                {
450                        libtrace_pflog_header_t *pflog;
451                        libtrace_linktype_t linktype;
452
453                        pflog=(libtrace_pflog_header_t*)trace_get_packet_buffer(
454                                        packet,&linktype,NULL);
455                        if (!pflog) {
456                                trace_set_err(packet->trace,
457                                                TRACE_ERR_BAD_PACKET,
458                                                "Bad or missing packet");
459                                return -1;
460                        }
461                        /* enum    { PF_IN=0, PF_OUT=1 }; */
462                        if (ntohs(pflog->dir==0)) {
463
464                                direction = TRACE_DIR_INCOMING;
465                        }
466                        else {
467                                direction = TRACE_DIR_OUTGOING;
468                        }
469                        break;
470                }
471                default:
472                        break;
473        }       
474        return direction;
475}
476
477
478static struct timeval pcapfile_get_timeval(
479                const libtrace_packet_t *packet) 
480{
481        libtrace_pcapfile_pkt_hdr_t *hdr =
482                (libtrace_pcapfile_pkt_hdr_t*)packet->header;
483        struct timeval ts;
484        ts.tv_sec = swapl(packet->trace,hdr->ts_sec);
485        ts.tv_usec = swapl(packet->trace,hdr->ts_usec);
486        return ts;
487}
488
489
490static int pcapfile_get_capture_length(const libtrace_packet_t *packet) {
491        libtrace_pcapfile_pkt_hdr_t *pcapptr
492                = (libtrace_pcapfile_pkt_hdr_t *)packet->header;
493
494        return swapl(packet->trace,pcapptr->caplen);
495}
496
497static int pcapfile_get_wire_length(const libtrace_packet_t *packet) {
498        libtrace_pcapfile_pkt_hdr_t *pcapptr
499                = (libtrace_pcapfile_pkt_hdr_t *)packet->header;
500        if (packet->type==pcap_linktype_to_rt(TRACE_DLT_EN10MB))
501                /* Include the missing FCS */
502                return swapl(packet->trace,pcapptr->wirelen)+4; 
503        else if (packet->type==pcap_linktype_to_rt(TRACE_DLT_IEEE802_11_RADIO)){
504                /* If the packet is Radiotap and the flags field indicates
505                 * that the FCS is not included in the 802.11 frame, then
506                 * we need to add 4 to the wire-length to account for it.
507                 */
508                uint8_t flags;
509                void *link;
510                libtrace_linktype_t linktype;
511                link = trace_get_packet_buffer(packet, &linktype, NULL);
512                trace_get_wireless_flags(link, linktype, &flags);
513                if ((flags & TRACE_RADIOTAP_F_FCS) == 0)
514                        return swapl(packet->trace,pcapptr->wirelen)+4;
515        }
516        return swapl(packet->trace,pcapptr->wirelen);
517}
518
519static int pcapfile_get_framing_length(const libtrace_packet_t *packet UNUSED) {
520        return sizeof(libtrace_pcapfile_pkt_hdr_t);
521}
522
523static size_t pcapfile_set_capture_length(libtrace_packet_t *packet,size_t size) {
524        libtrace_pcapfile_pkt_hdr_t *pcapptr = 0;
525        assert(packet);
526        if (size > trace_get_capture_length(packet)) {
527                /* can't make a packet larger */
528                return trace_get_capture_length(packet);
529        }
530        /* Reset the cached capture length */
531        packet->capture_length = -1;
532        pcapptr = (libtrace_pcapfile_pkt_hdr_t *)packet->header;
533        pcapptr->caplen = swapl(packet->trace,(uint32_t)size);
534        return trace_get_capture_length(packet);
535}
536
537static struct libtrace_eventobj_t pcapfile_event(libtrace_t *libtrace, libtrace_packet_t *packet) {
538       
539        libtrace_eventobj_t event = {0,0,0.0,0};
540       
541        if (IN_OPTIONS.real_time) {
542                event.size = pcapfile_read_packet(libtrace, packet);
543                if (event.size < 1)
544                        event.type = TRACE_EVENT_TERMINATE;
545                else
546                        event.type = TRACE_EVENT_PACKET;
547                return event;
548        } else {
549                return trace_event_trace(libtrace, packet);
550        }
551}
552
553static void pcapfile_help(void) {
554        printf("pcapfile format module: $Revision$\n");
555        printf("Supported input URIs:\n");
556        printf("\tpcapfile:/path/to/file\n");
557        printf("\tpcapfile:/path/to/file.gz\n");
558        printf("\n");
559        printf("\te.g.: pcapfile:/tmp/trace.pcap\n");
560        printf("\n");
561}
562
563static struct libtrace_format_t pcapfile = {
564        "pcapfile",
565        "$Id$",
566        TRACE_FORMAT_PCAPFILE,
567        pcapfile_init_input,            /* init_input */
568        pcapfile_config_input,          /* config_input */
569        pcapfile_start_input,           /* start_input */
570        NULL,                           /* pause_input */
571        pcapfile_init_output,           /* init_output */
572        pcapfile_config_output,         /* config_output */
573        pcapfile_start_output,          /* start_output */
574        pcapfile_fin_input,             /* fin_input */
575        pcapfile_fin_output,            /* fin_output */
576        pcapfile_read_packet,           /* read_packet */
577        pcapfile_prepare_packet,        /* prepare_packet */
578        NULL,                           /* fin_packet */
579        pcapfile_write_packet,          /* write_packet */
580        pcapfile_get_link_type,         /* get_link_type */
581        pcapfile_get_direction,         /* get_direction */
582        NULL,                           /* set_direction */
583        NULL,                           /* get_erf_timestamp */
584        pcapfile_get_timeval,           /* get_timeval */
585        NULL,                           /* get_seconds */
586        NULL,                           /* seek_erf */
587        NULL,                           /* seek_timeval */
588        NULL,                           /* seek_seconds */
589        pcapfile_get_capture_length,    /* get_capture_length */
590        pcapfile_get_wire_length,       /* get_wire_length */
591        pcapfile_get_framing_length,    /* get_framing_length */
592        pcapfile_set_capture_length,    /* set_capture_length */
593        NULL,                           /* get_received_packets */
594        NULL,                           /* get_filtered_packets */
595        NULL,                           /* get_dropped_packets */
596        NULL,                           /* get_captured_packets */
597        NULL,                           /* get_fd */
598        trace_event_trace,              /* trace_event */
599        pcapfile_help,                  /* help */
600        NULL                            /* next pointer */
601};
602
603
604void pcapfile_constructor(void) {
605        register_format(&pcapfile);
606}
607
608
Note: See TracBrowser for help on using the repository browser.