Add APIs to Wiretap to return the file of the size as supplied by the OS
[metze/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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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_SYS_STAT_H
35 #include <sys/stat.h>
36 #endif
37
38 #ifdef HAVE_UNISTD_H
39 #include <unistd.h>
40 #endif
41
42 #ifdef HAVE_IO_H
43 #include <io.h>
44 #endif
45
46 #include "wtap-int.h"
47 #include "file_wrappers.h"
48 #include "buffer.h"
49
50 /*
51  * Return the size of the file, as reported by the OS.
52  * (gint64, in case that's 64 bits.)
53  */
54 gint64
55 wtap_file_size(wtap *wth, int *err)
56 {
57         struct stat statb;
58
59         if (fstat(wth->fd, &statb) == -1) {
60                 if (err != NULL)
61                         *err = errno;
62                 return -1;
63         }
64         return statb.st_size;
65 }
66
67 int
68 wtap_file_type(wtap *wth)
69 {
70         return wth->file_type;
71 }
72
73 int
74 wtap_snapshot_length(wtap *wth)
75 {
76         return wth->snapshot_length;
77 }
78
79 int
80 wtap_file_encap(wtap *wth)
81 {
82         return wth->file_encap;
83 }
84
85 /* Table of the encapsulation types we know about. */
86 static const struct encap_type_info {
87         const char *name;
88         const char *short_name;
89 } encap_table[WTAP_NUM_ENCAP_TYPES] = {
90         /* WTAP_ENCAP_UNKNOWN */
91         { "Unknown", NULL },
92
93         /* WTAP_ENCAP_ETHERNET */
94         { "Ethernet", "ether" },
95
96         /* WTAP_ENCAP_TOKEN_RING */
97         { "Token Ring", "tr" },
98
99         /* WTAP_ENCAP_SLIP */
100         { "SLIP", "slip" },
101
102         /* WTAP_ENCAP_PPP */
103         { "PPP", "ppp" },
104
105         /* WTAP_ENCAP_FDDI */
106         { "FDDI", "fddi" },
107
108         /* WTAP_ENCAP_FDDI_BITSWAPPED */
109         { "FDDI with bit-swapped MAC addresses", "fddi-swapped" },
110
111         /* WTAP_ENCAP_RAW_IP */
112         { "Raw IP", "rawip" },
113
114         /* WTAP_ENCAP_ARCNET */
115         { "ARCNET", "arcnet" },
116
117         /* WTAP_ENCAP_ARCNET_LINUX */
118         { "Linux ARCNET", "arcnet_linux" },
119
120         /* WTAP_ENCAP_ATM_RFC1483 */
121         { "RFC 1483 ATM", "atm-rfc1483" },
122
123         /* WTAP_ENCAP_LINUX_ATM_CLIP */
124         { "Linux ATM CLIP", "linux-atm-clip" },
125
126         /* WTAP_ENCAP_LAPB */
127         { "LAPB", "lapb" },
128
129         /* WTAP_ENCAP_ATM_PDUS */
130         { "ATM PDUs", "atm-pdus" },
131
132         /* WTAP_ENCAP_ATM_PDUS_UNTRUNCATED */
133         { "ATM PDUs - untruncated", "atm-pdus-untruncated" },
134
135         /* WTAP_ENCAP_NULL */
136         { "NULL", "null" },
137
138         /* WTAP_ENCAP_ASCEND */
139         { "Lucent/Ascend access equipment", "ascend" },
140
141         /* WTAP_ENCAP_ISDN */
142         { "ISDN", "isdn" },
143
144         /* WTAP_ENCAP_IP_OVER_FC */
145         { "RFC 2625 IP-over-Fibre Channel", "ip-over-fc" },
146
147         /* WTAP_ENCAP_PPP_WITH_PHDR */
148         { "PPP with Directional Info", "ppp-with-direction" },
149
150         /* WTAP_ENCAP_IEEE_802_11 */
151         { "IEEE 802.11 Wireless LAN", "ieee-802-11" },
152
153         /* WTAP_ENCAP_PRISM_HEADER */
154         { "IEEE 802.11 plus Prism II monitor mode header", "prism" },
155
156         /* WTAP_ENCAP_IEEE_802_11_WITH_RADIO */
157         { "IEEE 802.11 Wireless LAN with radio information", "ieee-802-11-radio" },
158
159         /* WTAP_ENCAP_IEEE_802_11_WLAN_RADIOTAP */
160         { "IEEE 802.11 plus radiotap WLAN header", "ieee-802-11-radiotap" },
161
162         /* WTAP_ENCAP_IEEE_802_11_WLAN_AVS */
163         { "IEEE 802.11 plus AVS WLAN header", "ieee-802-11-avs" },
164
165         /* WTAP_ENCAP_SLL */
166         { "Linux cooked-mode capture", "linux-sll" },
167
168         /* WTAP_ENCAP_FRELAY */
169         { "Frame Relay", "frelay" },
170
171         /* WTAP_ENCAP_FRELAY_WITH_PHDR */
172         { "Frame Relay with Directional Info", "frelay-with-direction" },
173
174         /* WTAP_ENCAP_CHDLC */
175         { "Cisco HDLC", "chdlc" },
176
177         /* WTAP_ENCAP_CISCO_IOS */
178         { "Cisco IOS internal", "ios" },
179
180         /* WTAP_ENCAP_LOCALTALK */
181         { "Localtalk", "ltalk" },
182
183         /* WTAP_ENCAP_OLD_PFLOG  */
184         { "OpenBSD PF Firewall logs, pre-3.4", "pflog-old" },
185
186         /* WTAP_ENCAP_HHDLC */
187         { "HiPath HDLC", "hhdlc" },
188
189         /* WTAP_ENCAP_DOCSIS */
190         { "Data Over Cable Service Interface Specification", "docsis" },
191
192         /* WTAP_ENCAP_COSINE */
193         { "CoSine L2 debug log", "cosine" },
194
195         /* WTAP_ENCAP_WFLEET_HDLC */
196         { "Wellfleet HDLC", "whdlc" },
197
198         /* WTAP_ENCAP_SDLC */
199         { "SDLC", "sdlc" },
200
201         /* WTAP_ENCAP_TZSP */
202         { "Tazmen sniffer protocol", "tzsp" },
203
204         /* WTAP_ENCAP_ENC */
205         { "OpenBSD enc(4) encapsulating interface", "enc" },
206
207         /* WTAP_ENCAP_PFLOG  */
208         { "OpenBSD PF Firewall logs", "pflog" },
209
210         /* WTAP_ENCAP_CHDLC_WITH_PHDR */
211         { "Cisco HDLC with Directional Info", "chdlc-with-direction" },
212
213         /* WTAP_ENCAP_BLUETOOTH_H4 */
214         { "Bluetooth H4", "bluetooth-h4" },
215
216         /* WTAP_ENCAP_MTP2 */
217         { "SS7 MTP2", "mtp2" },
218
219         /* WTAP_ENCAP_MTP3 */
220         { "SS7 MTP3", "mtp3" },
221
222         /* WTAP_ENCAP_IRDA */
223         { "IrDA", "irda" },
224
225         /* WTAP_ENCAP_USER0 */
226         { "USER 0", "user0" },
227
228         /* WTAP_ENCAP_USER1 */
229         { "USER 1", "user1" },
230
231         /* WTAP_ENCAP_USER2 */
232         { "USER 2", "user2" },
233
234         /* WTAP_ENCAP_USER3 */
235         { "USER 3", "user3" },
236
237         /* WTAP_ENCAP_USER4 */
238         { "USER 4", "user4" },
239
240         /* WTAP_ENCAP_USER5 */
241         { "USER 5", "user5" },
242
243         /* WTAP_ENCAP_USER6 */
244         { "USER 6", "user6" },
245
246         /* WTAP_ENCAP_USER7 */
247         { "USER 7", "user7" },
248
249         /* WTAP_ENCAP_USER8 */
250         { "USER 8", "user8" },
251
252         /* WTAP_ENCAP_USER9 */
253         { "USER 9", "user9" },
254
255         /* WTAP_ENCAP_USER10 */
256         { "USER 10", "user10" },
257
258         /* WTAP_ENCAP_USER11 */
259         { "USER 11", "user11" },
260
261         /* WTAP_ENCAP_USER12 */
262         { "USER 12", "user12" },
263
264         /* WTAP_ENCAP_USER13 */
265         { "USER 13", "user13" },
266
267         /* WTAP_ENCAP_USER14 */
268         { "USER 14", "user14" },
269
270         /* WTAP_ENCAP_USER15 */
271         { "USER 15", "user15" },
272
273         /* WTAP_ENCAP_SYMANTEC */
274         { "Symantec Enterprise Firewall", "symantec" },
275
276         /* WTAP_ENCAP_APPLE_IP_OVER_IEEE1394 */
277         { "Apple IP-over-IEEE 1394", "ap1394" },
278
279         /* WTAP_ENCAP_BACNET_MS_TP */
280         { "BACnet MS/TP", "bacnet-ms-tp" },
281
282         /* WTAP_ENCAP_NETTL_RAW_ICMP */
283         { "Raw ICMP with nettl headers", "raw-icmp-nettl" },
284
285         /* WTAP_ENCAP_NETTL_RAW_ICMPV6 */
286         { "Raw ICMPv6 with nettl headers", "raw-icmpv6-nettl" },
287
288         /* WTAP_ENCAP_GPRS_LLC */
289         { "GPRS LLC", "gprs-llc" },
290
291         /* WTAP_ENCAP_JUNIPER_ATM1 */
292         { "Juniper ATM1", "juniper-atm1" },
293
294         /* WTAP_ENCAP_JUNIPER_ATM2 */
295         { "Juniper ATM2", "juniper-atm2" },
296
297         /* WTAP_ENCAP_REDBACK */
298         { "Redback SmartEdge", "redback" },
299
300         /* WTAP_ENCAP_NETTL_RAW_IP */
301         { "Raw IP with nettl headers", "rawip-nettl" },
302
303         /* WTAP_ENCAP_NETTL_ETHERNET */
304         { "Ethernet with nettl headers", "ether-nettl" },
305
306         /* WTAP_ENCAP_NETTL_TOKEN_RING */
307         { "Token Ring with nettl headers", "tr-nettl" },
308
309         /* WTAP_ENCAP_NETTL_FDDI */
310         { "FDDI with nettl headers", "fddi-nettl" },
311
312         /* WTAP_ENCAP_NETTL_UNKNOWN */
313         { "Unknown link-layer type with nettl headers", "unknown-nettl" },
314
315         /* WTAP_ENCAP_MTP2_WITH_PHDR */
316         { "MTP2 with pseudoheader", "mtp2-with-phdr" },
317
318         /* WTAP_ENCAP_JUNIPER_PPPOE */
319         { "Juniper PPPoE", "juniper-pppoe" },
320
321         /* WTAP_ENCAP_GCOM_TIE1 */
322         { "GCOM TIE1", "gcom-tie1" },
323
324         /* WTAP_ENCAP_GCOM_SERIAL */
325         { "GCOM Serial", "gcom-serial" },
326
327         /* WTAP_ENCAP_NETTL_X25 */
328         { "X25 with nettl headers", "x25-nettl" },
329
330         /* WTAP_ENCAP_JUNIPER_MLPPP */
331         { "Juniper MLPPP", "juniper-mlppp" },
332
333         /* WTAP_ENCAP_JUNIPER_MLFR */
334         { "Juniper MLFR", "juniper-mlfr" },
335
336 };
337
338 /* Name that should be somewhat descriptive. */
339 const char
340 *wtap_encap_string(int encap)
341 {
342         if (encap < 0 || encap >= WTAP_NUM_ENCAP_TYPES)
343                 return NULL;
344         else
345                 return encap_table[encap].name;
346 }
347
348 /* Name to use in, say, a command-line flag specifying the type. */
349 const char
350 *wtap_encap_short_string(int encap)
351 {
352         if (encap < 0 || encap >= WTAP_NUM_ENCAP_TYPES)
353                 return NULL;
354         else
355                 return encap_table[encap].short_name;
356 }
357
358 /* Translate a short name to a capture file type. */
359 int
360 wtap_short_string_to_encap(const char *short_name)
361 {
362         int encap;
363
364         for (encap = 0; encap < WTAP_NUM_ENCAP_TYPES; encap++) {
365                 if (encap_table[encap].short_name != NULL &&
366                     strcmp(short_name, encap_table[encap].short_name) == 0)
367                         return encap;
368         }
369         return -1;      /* no such encapsulation type */
370 }
371
372 static const char *wtap_errlist[] = {
373         "The file isn't a plain file or pipe",
374         "The file is being opened for random access but is a pipe",
375         "The file isn't a capture file in a known format",
376         "File contains record data we don't support",
377         "That file format cannot be written to a pipe",
378         NULL,
379         "Files can't be saved in that format",
380         "Files from that network type can't be saved in that format",
381         "That file format doesn't support per-packet encapsulations",
382         NULL,
383         NULL,
384         "Less data was read than was expected",
385         "File contains a record that's not valid",
386         "Less data was written than was requested",
387         "Uncompression error: data oddly truncated",
388         "Uncompression error: data would overflow buffer",
389         "Uncompression error: bad LZ77 offset",
390         "The standard input cannot be opened for random access",
391 };
392 #define WTAP_ERRLIST_SIZE       (sizeof wtap_errlist / sizeof wtap_errlist[0])
393
394 const char
395 *wtap_strerror(int err)
396 {
397         static char errbuf[128];
398         unsigned int wtap_errlist_index;
399
400         if (err < 0) {
401 #ifdef HAVE_LIBZ
402                 if (err >= WTAP_ERR_ZLIB_MIN && err <= WTAP_ERR_ZLIB_MAX) {
403                         /* Assume it's a zlib error. */
404                         sprintf(errbuf, "Uncompression error: %s",
405                             zError(err - WTAP_ERR_ZLIB));
406                         return errbuf;
407                 }
408 #endif
409                 wtap_errlist_index = -1 - err;
410                 if (wtap_errlist_index >= WTAP_ERRLIST_SIZE) {
411                         sprintf(errbuf, "Error %d", err);
412                         return errbuf;
413                 }
414                 if (wtap_errlist[wtap_errlist_index] == NULL)
415                         return "Unknown reason";
416                 return wtap_errlist[wtap_errlist_index];
417         } else
418                 return strerror(err);
419 }
420
421 /* Close only the sequential side, freeing up memory it uses.
422
423    Note that we do *not* want to call the subtype's close function,
424    as it would free any per-subtype data, and that data may be
425    needed by the random-access side.
426
427    Instead, if the subtype has a "sequential close" function, we call it,
428    to free up stuff used only by the sequential side. */
429 void
430 wtap_sequential_close(wtap *wth)
431 {
432         if (wth->subtype_sequential_close != NULL)
433                 (*wth->subtype_sequential_close)(wth);
434
435         if (wth->fh != NULL) {
436                 file_close(wth->fh);
437                 wth->fh = NULL;
438         }
439
440         if (wth->frame_buffer) {
441                 buffer_free(wth->frame_buffer);
442                 g_free(wth->frame_buffer);
443                 wth->frame_buffer = NULL;
444         }
445 }
446
447 void
448 wtap_close(wtap *wth)
449 {
450         wtap_sequential_close(wth);
451
452         if (wth->subtype_close != NULL)
453                 (*wth->subtype_close)(wth);
454
455         if (wth->random_fh != NULL)
456                 file_close(wth->random_fh);
457
458         g_free(wth);
459 }
460
461 gboolean
462 wtap_read(wtap *wth, int *err, gchar **err_info, long *data_offset)
463 {
464         /*
465          * Set the packet encapsulation to the file's encapsulation
466          * value; if that's not WTAP_ENCAP_PER_PACKET, it's the
467          * right answer (and means that the read routine for this
468          * capture file type doesn't have to set it), and if it
469          * *is* WTAP_ENCAP_PER_PACKET, the caller needs to set it
470          * anyway.
471          */
472         wth->phdr.pkt_encap = wth->file_encap;
473
474         if (!wth->subtype_read(wth, err, err_info, data_offset))
475                 return FALSE;   /* failure */
476
477         /*
478          * It makes no sense for the captured data length to be bigger
479          * than the actual data length.
480          */
481         if (wth->phdr.caplen > wth->phdr.len)
482                 wth->phdr.caplen = wth->phdr.len;
483
484         /*
485          * Make sure that it's not WTAP_ENCAP_PER_PACKET, as that
486          * probably means the file has that encapsulation type
487          * but the read routine didn't set this packet's
488          * encapsulation type.
489          */
490         g_assert(wth->phdr.pkt_encap != WTAP_ENCAP_PER_PACKET);
491
492         return TRUE;    /* success */
493 }
494
495 /*
496  * Return an approximation of the amount of data we've read sequentially
497  * from the file so far.  (gint64, in case that's 64 bits.)
498  */
499 gint64
500 wtap_read_so_far(wtap *wth, int *err)
501 {
502         off_t file_pos;
503
504         file_pos = lseek(wth->fd, 0, SEEK_CUR);
505         if (file_pos == -1) {
506                 if (err != NULL)
507                         *err = errno;
508                 return -1;
509         }
510         return file_pos;
511 }
512
513 struct wtap_pkthdr*
514 wtap_phdr(wtap *wth)
515 {
516         return &wth->phdr;
517 }
518
519 union wtap_pseudo_header*
520 wtap_pseudoheader(wtap *wth)
521 {
522         return &wth->pseudo_header;
523 }
524
525 guint8*
526 wtap_buf_ptr(wtap *wth)
527 {
528         return buffer_start_ptr(wth->frame_buffer);
529 }
530
531 gboolean
532 wtap_seek_read(wtap *wth, long seek_off,
533         union wtap_pseudo_header *pseudo_header, guint8 *pd, int len,
534         int *err, gchar **err_info)
535 {
536         return wth->subtype_seek_read(wth, seek_off, pseudo_header, pd, len,
537                 err, err_info);
538 }