1041e85de6273dfc40c333b0e887b63d7cec2053
[obnox/wireshark/wip.git] / wiretap / wtap.c
1 /* wtap.c
2  *
3  * $Id$
4  *
5  * Wiretap Library
6  * Copyright (c) 1998 by Gilbert Ramirez <gram@alumni.rice.edu>
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21  */
22
23 #ifdef HAVE_CONFIG_H
24 #include "config.h"
25 #endif
26
27 #include <string.h>
28 #include <errno.h>
29
30 #ifdef HAVE_SYS_TYPES_H
31 #include <sys/types.h>
32 #endif
33
34 #ifdef HAVE_UNISTD_H
35 #include <unistd.h>
36 #endif
37
38 #include "wtap-int.h"
39 #include "wtap.h"
40
41 #include "file_wrappers.h"
42 #include <wsutil/file_util.h>
43 #include "buffer.h"
44
45 /*
46  * Return the size of the file, as reported by the OS.
47  * (gint64, in case that's 64 bits.)
48  */
49 gint64
50 wtap_file_size(wtap *wth, int *err)
51 {
52         struct stat statb;
53
54         if (fstat(wth->fd, &statb) == -1) {
55                 if (err != NULL)
56                         *err = errno;
57                 return -1;
58         }
59         return statb.st_size;
60 }
61
62 int
63 wtap_file_type(wtap *wth)
64 {
65         return wth->file_type;
66 }
67
68 int
69 wtap_snapshot_length(wtap *wth)
70 {
71         return wth->snapshot_length;
72 }
73
74 int
75 wtap_file_encap(wtap *wth)
76 {
77         return wth->file_encap;
78 }
79
80 int
81 wtap_file_tsprecision(wtap *wth)
82 {
83         return wth->tsprecision;
84 }
85
86 /* Table of the encapsulation types we know about. */
87 struct encap_type_info {
88         const char *name;
89         const char *short_name;
90 };
91
92 static struct encap_type_info encap_table_base[] = {
93         /* WTAP_ENCAP_UNKNOWN */
94         { "Unknown", NULL },
95
96         /* WTAP_ENCAP_ETHERNET */
97         { "Ethernet", "ether" },
98
99         /* WTAP_ENCAP_TOKEN_RING */
100         { "Token Ring", "tr" },
101
102         /* WTAP_ENCAP_SLIP */
103         { "SLIP", "slip" },
104
105         /* WTAP_ENCAP_PPP */
106         { "PPP", "ppp" },
107
108         /* WTAP_ENCAP_FDDI */
109         { "FDDI", "fddi" },
110
111         /* WTAP_ENCAP_FDDI_BITSWAPPED */
112         { "FDDI with bit-swapped MAC addresses", "fddi-swapped" },
113
114         /* WTAP_ENCAP_RAW_IP */
115         { "Raw IP", "rawip" },
116
117         /* WTAP_ENCAP_ARCNET */
118         { "ARCNET", "arcnet" },
119
120         /* WTAP_ENCAP_ARCNET_LINUX */
121         { "Linux ARCNET", "arcnet_linux" },
122
123         /* WTAP_ENCAP_ATM_RFC1483 */
124         { "RFC 1483 ATM", "atm-rfc1483" },
125
126         /* WTAP_ENCAP_LINUX_ATM_CLIP */
127         { "Linux ATM CLIP", "linux-atm-clip" },
128
129         /* WTAP_ENCAP_LAPB */
130         { "LAPB", "lapb" },
131
132         /* WTAP_ENCAP_ATM_PDUS */
133         { "ATM PDUs", "atm-pdus" },
134
135         /* WTAP_ENCAP_ATM_PDUS_UNTRUNCATED */
136         { "ATM PDUs - untruncated", "atm-pdus-untruncated" },
137
138         /* WTAP_ENCAP_NULL */
139         { "NULL", "null" },
140
141         /* WTAP_ENCAP_ASCEND */
142         { "Lucent/Ascend access equipment", "ascend" },
143
144         /* WTAP_ENCAP_ISDN */
145         { "ISDN", "isdn" },
146
147         /* WTAP_ENCAP_IP_OVER_FC */
148         { "RFC 2625 IP-over-Fibre Channel", "ip-over-fc" },
149
150         /* WTAP_ENCAP_PPP_WITH_PHDR */
151         { "PPP with Directional Info", "ppp-with-direction" },
152
153         /* WTAP_ENCAP_IEEE_802_11 */
154         { "IEEE 802.11 Wireless LAN", "ieee-802-11" },
155
156         /* WTAP_ENCAP_PRISM_HEADER */
157         { "IEEE 802.11 plus Prism II monitor mode header", "prism" },
158
159         /* WTAP_ENCAP_IEEE_802_11_WITH_RADIO */
160         { "IEEE 802.11 Wireless LAN with radio information", "ieee-802-11-radio" },
161
162         /* WTAP_ENCAP_IEEE_802_11_WLAN_RADIOTAP */
163         { "IEEE 802.11 plus radiotap WLAN header", "ieee-802-11-radiotap" },
164
165         /* WTAP_ENCAP_IEEE_802_11_WLAN_AVS */
166         { "IEEE 802.11 plus AVS WLAN header", "ieee-802-11-avs" },
167
168         /* WTAP_ENCAP_SLL */
169         { "Linux cooked-mode capture", "linux-sll" },
170
171         /* WTAP_ENCAP_FRELAY */
172         { "Frame Relay", "frelay" },
173
174         /* WTAP_ENCAP_FRELAY_WITH_PHDR */
175         { "Frame Relay with Directional Info", "frelay-with-direction" },
176
177         /* WTAP_ENCAP_CHDLC */
178         { "Cisco HDLC", "chdlc" },
179
180         /* WTAP_ENCAP_CISCO_IOS */
181         { "Cisco IOS internal", "ios" },
182
183         /* WTAP_ENCAP_LOCALTALK */
184         { "Localtalk", "ltalk" },
185
186         /* WTAP_ENCAP_OLD_PFLOG  */
187         { "OpenBSD PF Firewall logs, pre-3.4", "pflog-old" },
188
189         /* WTAP_ENCAP_HHDLC */
190         { "HiPath HDLC", "hhdlc" },
191
192         /* WTAP_ENCAP_DOCSIS */
193         { "Data Over Cable Service Interface Specification", "docsis" },
194
195         /* WTAP_ENCAP_COSINE */
196         { "CoSine L2 debug log", "cosine" },
197
198         /* WTAP_ENCAP_WFLEET_HDLC */
199         { "Wellfleet HDLC", "whdlc" },
200
201         /* WTAP_ENCAP_SDLC */
202         { "SDLC", "sdlc" },
203
204         /* WTAP_ENCAP_TZSP */
205         { "Tazmen sniffer protocol", "tzsp" },
206
207         /* WTAP_ENCAP_ENC */
208         { "OpenBSD enc(4) encapsulating interface", "enc" },
209
210         /* WTAP_ENCAP_PFLOG  */
211         { "OpenBSD PF Firewall logs", "pflog" },
212
213         /* WTAP_ENCAP_CHDLC_WITH_PHDR */
214         { "Cisco HDLC with Directional Info", "chdlc-with-direction" },
215
216         /* WTAP_ENCAP_BLUETOOTH_H4 */
217         { "Bluetooth H4", "bluetooth-h4" },
218
219         /* WTAP_ENCAP_MTP2 */
220         { "SS7 MTP2", "mtp2" },
221
222         /* WTAP_ENCAP_MTP3 */
223         { "SS7 MTP3", "mtp3" },
224
225         /* WTAP_ENCAP_IRDA */
226         { "IrDA", "irda" },
227
228         /* WTAP_ENCAP_USER0 */
229         { "USER 0", "user0" },
230
231         /* WTAP_ENCAP_USER1 */
232         { "USER 1", "user1" },
233
234         /* WTAP_ENCAP_USER2 */
235         { "USER 2", "user2" },
236
237         /* WTAP_ENCAP_USER3 */
238         { "USER 3", "user3" },
239
240         /* WTAP_ENCAP_USER4 */
241         { "USER 4", "user4" },
242
243         /* WTAP_ENCAP_USER5 */
244         { "USER 5", "user5" },
245
246         /* WTAP_ENCAP_USER6 */
247         { "USER 6", "user6" },
248
249         /* WTAP_ENCAP_USER7 */
250         { "USER 7", "user7" },
251
252         /* WTAP_ENCAP_USER8 */
253         { "USER 8", "user8" },
254
255         /* WTAP_ENCAP_USER9 */
256         { "USER 9", "user9" },
257
258         /* WTAP_ENCAP_USER10 */
259         { "USER 10", "user10" },
260
261         /* WTAP_ENCAP_USER11 */
262         { "USER 11", "user11" },
263
264         /* WTAP_ENCAP_USER12 */
265         { "USER 12", "user12" },
266
267         /* WTAP_ENCAP_USER13 */
268         { "USER 13", "user13" },
269
270         /* WTAP_ENCAP_USER14 */
271         { "USER 14", "user14" },
272
273         /* WTAP_ENCAP_USER15 */
274         { "USER 15", "user15" },
275
276         /* WTAP_ENCAP_SYMANTEC */
277         { "Symantec Enterprise Firewall", "symantec" },
278
279         /* WTAP_ENCAP_APPLE_IP_OVER_IEEE1394 */
280         { "Apple IP-over-IEEE 1394", "ap1394" },
281
282         /* WTAP_ENCAP_BACNET_MS_TP */
283         { "BACnet MS/TP", "bacnet-ms-tp" },
284
285         /* WTAP_ENCAP_NETTL_RAW_ICMP */
286         { "Raw ICMP with nettl headers", "raw-icmp-nettl" },
287
288         /* WTAP_ENCAP_NETTL_RAW_ICMPV6 */
289         { "Raw ICMPv6 with nettl headers", "raw-icmpv6-nettl" },
290
291         /* WTAP_ENCAP_GPRS_LLC */
292         { "GPRS LLC", "gprs-llc" },
293
294         /* WTAP_ENCAP_JUNIPER_ATM1 */
295         { "Juniper ATM1", "juniper-atm1" },
296
297         /* WTAP_ENCAP_JUNIPER_ATM2 */
298         { "Juniper ATM2", "juniper-atm2" },
299
300         /* WTAP_ENCAP_REDBACK */
301         { "Redback SmartEdge", "redback" },
302
303         /* WTAP_ENCAP_NETTL_RAW_IP */
304         { "Raw IP with nettl headers", "rawip-nettl" },
305
306         /* WTAP_ENCAP_NETTL_ETHERNET */
307         { "Ethernet with nettl headers", "ether-nettl" },
308
309         /* WTAP_ENCAP_NETTL_TOKEN_RING */
310         { "Token Ring with nettl headers", "tr-nettl" },
311
312         /* WTAP_ENCAP_NETTL_FDDI */
313         { "FDDI with nettl headers", "fddi-nettl" },
314
315         /* WTAP_ENCAP_NETTL_UNKNOWN */
316         { "Unknown link-layer type with nettl headers", "unknown-nettl" },
317
318         /* WTAP_ENCAP_MTP2_WITH_PHDR */
319         { "MTP2 with pseudoheader", "mtp2-with-phdr" },
320
321         /* WTAP_ENCAP_JUNIPER_PPPOE */
322         { "Juniper PPPoE", "juniper-pppoe" },
323
324         /* WTAP_ENCAP_GCOM_TIE1 */
325         { "GCOM TIE1", "gcom-tie1" },
326
327         /* WTAP_ENCAP_GCOM_SERIAL */
328         { "GCOM Serial", "gcom-serial" },
329
330         /* WTAP_ENCAP_NETTL_X25 */
331         { "X25 with nettl headers", "x25-nettl" },
332
333         /* WTAP_ENCAP_K12 */
334         { "K12 protocol analyzer", "k12" },
335
336         /* WTAP_ENCAP_JUNIPER_MLPPP */
337         { "Juniper MLPPP", "juniper-mlppp" },
338
339         /* WTAP_ENCAP_JUNIPER_MLFR */
340         { "Juniper MLFR", "juniper-mlfr" },
341
342         /* WTAP_ENCAP_JUNIPER_ETHER */
343         { "Juniper Ethernet", "juniper-ether" },
344
345         /* WTAP_ENCAP_JUNIPER_PPP */
346         { "Juniper PPP", "juniper-ppp" },
347
348         /* WTAP_ENCAP_JUNIPER_FRELAY */
349         { "Juniper Frame-Relay", "juniper-frelay" },
350
351         /* WTAP_ENCAP_JUNIPER_CHDLC */
352         { "Juniper C-HDLC", "juniper-chdlc" },
353
354         /* WTAP_ENCAP_JUNIPER_GGSN */
355         { "Juniper GGSN", "juniper-ggsn" },
356
357         /* WTAP_ENCAP_LINUX_LAPD */
358         { "LAPD", "lapd" },
359
360         /* WTAP_ENCAP_CATAPULT_DCT2000 */
361         { "Catapult DCT2000", "dct2000" },
362
363         /* WTAP_ENCAP_BER */
364         { "ASN.1 Basic Encoding Rules", "ber" },
365
366         /* WTAP_ENCAP_JUNIPER_VP */
367         { "Juniper Voice PIC", "juniper-vp" },
368
369         /* WTAP_ENCAP_USB */
370         { "Raw USB packets", "usb" },
371
372         /* WTAP_ENCAP_IEEE802_16_MAC_CPS */
373         { "IEEE 802.16 MAC Common Part Sublayer", "ieee-802-16-mac-cps" },
374
375         /* WTAP_ENCAP_NETTL_RAW_TELNET */
376         { "Raw telnet with nettl headers", "raw-telnet-nettl" },
377
378         /* WTAP_ENCAP_USB_LINUX */
379         { "USB packets with Linux header", "usb-linux" },
380
381         /* WTAP_ENCAP_MPEG */
382         { "MPEG", "mpeg" },
383
384         /* WTAP_ENCAP_PPI */
385         { "Per-Packet Information header", "ppi" },
386
387         /* WTAP_ENCAP_ERF */
388         { "Endace Record File", "erf" },
389
390         /* WTAP_ENCAP_BT_H4 */
391         { "Bluetooth H4 with linux header", "bluetooth-h4" },
392
393         /* WTAP_ENCAP_SITA */
394         { "SITA WAN packets", "sita-wan" },
395
396         /* WTAP_ENCAP_SCCP */
397         { "SS7 SCCP", "sccp" },
398
399         /* WTAP_ENCAP_BLUETOOTH_HCI */
400         { "Bluetooth without transport layer", "bluetooth-hci" },
401
402         /* WTAP_ENCAP_IPMB */
403         { "Intelligent Platform Management Bus", "ipmb" },
404
405         /* WTAP_ENCAP_IEEE802_15_4 */
406         { "IEEE 802.15.4 Wireless PAN", "wpan" },
407
408         /* WTAP_ENCAP_X2E_XORAYA */
409         { "X2E Xoraya", "x2e-xoraya" },
410
411         /* WTAP_ENCAP_FLEXRAY */
412         { "FlexRay", "flexray" },
413
414         /* WTAP_ENCAP_LIN */
415         { "Local Interconnect Network", "lin" },
416
417         /* WTAP_ENCAP_MOST */
418         { "Media Oriented Systems Transport", "most" },
419
420         /* WTAP_ENCAP_CAN20B */
421         { "Controller Area Network 2.0B", "can20b" },
422
423         /* WTAP_ENCAP_LAYER1_EVENT */
424         { "EyeSDN Layer 1 event", "layer1-event" },
425
426         /* WTAP_ENCAP_X2E_SERIAL */
427         { "X2E serial line capture", "x2e-serial" },
428
429         /* WTAP_ENCAP_I2C */
430         { "I2C", "i2c" },
431
432         /* WTAP_ENCAP_IEEE802_15_4_NONASK_PHY */
433         { "IEEE 802.15.4 Wireless PAN non-ASK PHY", "wpan-nonask-phy" },
434
435         /* WTAP_ENCAP_TNEF */
436         { "Transport-Neutral Encapsulation Format", "tnef" },
437
438         /* WTAP_ENCAP_USB_LINUX_MMAP */
439         { "USB packets with Linux header and padding", "usb-linux-mmap" },
440 };
441
442 gint wtap_num_encap_types = sizeof(encap_table_base) / sizeof(struct encap_type_info);
443 static GArray* encap_table_arr = NULL;
444 static const struct encap_type_info* encap_table = NULL;
445
446 static void wtap_init_encap_types(void) {
447
448         if (encap_table_arr) return;
449
450         encap_table_arr = g_array_new(FALSE,TRUE,sizeof(struct encap_type_info));
451
452         g_array_append_vals(encap_table_arr,encap_table_base,wtap_num_encap_types);
453
454         encap_table = (void*)encap_table_arr->data;
455 }
456
457 int wtap_get_num_encap_types(void) {
458         wtap_init_encap_types();
459         return wtap_num_encap_types;
460 }
461
462
463 int wtap_register_encap_type(char* name, char* short_name) {
464         struct encap_type_info e;
465         wtap_init_encap_types();
466
467         e.name = g_strdup(name);
468         e.short_name = g_strdup(short_name);
469
470         g_array_append_val(encap_table_arr,e);
471
472         encap_table = (void*)encap_table_arr->data;
473
474         return wtap_num_encap_types++;
475 }
476
477
478 /* Name that should be somewhat descriptive. */
479 const char
480 *wtap_encap_string(int encap)
481 {
482         if (encap < 0 || encap >= WTAP_NUM_ENCAP_TYPES)
483                 return NULL;
484         else
485                 return encap_table[encap].name;
486 }
487
488 /* Name to use in, say, a command-line flag specifying the type. */
489 const char
490 *wtap_encap_short_string(int encap)
491 {
492         if (encap < 0 || encap >= WTAP_NUM_ENCAP_TYPES)
493                 return NULL;
494         else
495                 return encap_table[encap].short_name;
496 }
497
498 /* Translate a short name to a capture file type. */
499 int
500 wtap_short_string_to_encap(const char *short_name)
501 {
502         int encap;
503
504         for (encap = 0; encap < WTAP_NUM_ENCAP_TYPES; encap++) {
505                 if (encap_table[encap].short_name != NULL &&
506                     strcmp(short_name, encap_table[encap].short_name) == 0)
507                         return encap;
508         }
509         return -1;      /* no such encapsulation type */
510 }
511
512 static const char *wtap_errlist[] = {
513         "The file isn't a plain file or pipe",
514         "The file is being opened for random access but is a pipe",
515         "The file isn't a capture file in a known format",
516         "File contains record data we don't support",
517         "That file format cannot be written to a pipe",
518         NULL,
519         "Files can't be saved in that format",
520         "Files from that network type can't be saved in that format",
521         "That file format doesn't support per-packet encapsulations",
522         NULL,
523         NULL,
524         "Less data was read than was expected",
525         "File contains a record that's not valid",
526         "Less data was written than was requested",
527         "Uncompression error: data oddly truncated",
528         "Uncompression error: data would overflow buffer",
529         "Uncompression error: bad LZ77 offset",
530         "The standard input cannot be opened for random access"
531 };
532 #define WTAP_ERRLIST_SIZE       (sizeof wtap_errlist / sizeof wtap_errlist[0])
533
534 const char
535 *wtap_strerror(int err)
536 {
537         static char errbuf[128];
538         unsigned int wtap_errlist_index;
539
540         if (err < 0) {
541 #ifdef HAVE_LIBZ
542                 if (err >= WTAP_ERR_ZLIB_MIN && err <= WTAP_ERR_ZLIB_MAX) {
543                         /* Assume it's a zlib error. */
544                         g_snprintf(errbuf, 128, "Uncompression error: %s",
545                             zError(err - WTAP_ERR_ZLIB));
546                         return errbuf;
547                 }
548 #endif
549                 wtap_errlist_index = -1 - err;
550                 if (wtap_errlist_index >= WTAP_ERRLIST_SIZE) {
551                         g_snprintf(errbuf, 128, "Error %d", err);
552                         return errbuf;
553                 }
554                 if (wtap_errlist[wtap_errlist_index] == NULL)
555                         return "Unknown reason";
556                 return wtap_errlist[wtap_errlist_index];
557         } else
558                 return strerror(err);
559 }
560
561 /* Close only the sequential side, freeing up memory it uses.
562
563    Note that we do *not* want to call the subtype's close function,
564    as it would free any per-subtype data, and that data may be
565    needed by the random-access side.
566
567    Instead, if the subtype has a "sequential close" function, we call it,
568    to free up stuff used only by the sequential side. */
569 void
570 wtap_sequential_close(wtap *wth)
571 {
572         if (wth->subtype_sequential_close != NULL)
573                 (*wth->subtype_sequential_close)(wth);
574
575         if (wth->fh != NULL) {
576                 file_close(wth->fh);
577                 wth->fh = NULL;
578         }
579
580         if (wth->frame_buffer) {
581                 buffer_free(wth->frame_buffer);
582                 g_free(wth->frame_buffer);
583                 wth->frame_buffer = NULL;
584         }
585 }
586
587 void
588 wtap_close(wtap *wth)
589 {
590         wtap_sequential_close(wth);
591
592         if (wth->subtype_close != NULL)
593                 (*wth->subtype_close)(wth);
594
595         if (wth->random_fh != NULL)
596                 file_close(wth->random_fh);
597
598         g_free(wth);
599 }
600
601 gboolean
602 wtap_read(wtap *wth, int *err, gchar **err_info, gint64 *data_offset)
603 {
604         /*
605          * Set the packet encapsulation to the file's encapsulation
606          * value; if that's not WTAP_ENCAP_PER_PACKET, it's the
607          * right answer (and means that the read routine for this
608          * capture file type doesn't have to set it), and if it
609          * *is* WTAP_ENCAP_PER_PACKET, the caller needs to set it
610          * anyway.
611          */
612         wth->phdr.pkt_encap = wth->file_encap;
613
614         if (!wth->subtype_read(wth, err, err_info, data_offset))
615                 return FALSE;   /* failure */
616
617         /*
618          * It makes no sense for the captured data length to be bigger
619          * than the actual data length.
620          */
621         if (wth->phdr.caplen > wth->phdr.len)
622                 wth->phdr.caplen = wth->phdr.len;
623
624         /*
625          * Make sure that it's not WTAP_ENCAP_PER_PACKET, as that
626          * probably means the file has that encapsulation type
627          * but the read routine didn't set this packet's
628          * encapsulation type.
629          */
630         g_assert(wth->phdr.pkt_encap != WTAP_ENCAP_PER_PACKET);
631
632         return TRUE;    /* success */
633 }
634
635 /*
636  * Return an approximation of the amount of data we've read sequentially
637  * from the file so far.  (gint64, in case that's 64 bits.)
638  */
639 gint64
640 wtap_read_so_far(wtap *wth, int *err)
641 {
642         off_t file_pos;
643
644         file_pos = ws_lseek(wth->fd, 0, SEEK_CUR);
645         if (file_pos == -1) {
646                 if (err != NULL)
647                         *err = errno;
648                 return -1;
649         }
650         return file_pos;
651 }
652
653 struct wtap_pkthdr*
654 wtap_phdr(wtap *wth)
655 {
656         return &wth->phdr;
657 }
658
659 union wtap_pseudo_header*
660 wtap_pseudoheader(wtap *wth)
661 {
662         return &wth->pseudo_header;
663 }
664
665 guint8*
666 wtap_buf_ptr(wtap *wth)
667 {
668         return buffer_start_ptr(wth->frame_buffer);
669 }
670
671 gboolean
672 wtap_seek_read(wtap *wth, gint64 seek_off,
673         union wtap_pseudo_header *pseudo_header, guint8 *pd, int len,
674         int *err, gchar **err_info)
675 {
676         return wth->subtype_seek_read(wth, seek_off, pseudo_header, pd, len,
677                 err, err_info);
678 }