2 * Copyright (c) 1993, 1994, 1995, 1996, 1997
3 * The Regents of the University of California. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that: (1) source code distributions
7 * retain the above copyright notice and this paragraph in its entirety, (2)
8 * distributions including binary code include the above copyright notice and
9 * this paragraph in its entirety in the documentation or other materials
10 * provided with the distribution, and (3) all advertising materials mentioning
11 * features or use of this software display the following acknowledgement:
12 * ``This product includes software developed by the University of California,
13 * Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
14 * the University nor the names of its contributors may be used to endorse
15 * or promote products derived from this software without specific prior
17 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
18 * WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
19 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
21 * savefile.c - supports offline use of tcpdump
22 * Extraction/creation by Jeffrey Mogul, DECWRL
23 * Modified by Steve McCanne, LBL.
25 * Used to save the received packet headers, after filtering, to
26 * a file, and then read them later.
27 * The first record in the file contains saved values for the machine
28 * dependent values so we can print the dump file on any architecture.
32 static const char rcsid
[] =
33 "@(#) $Header: /tcpdump/master/libpcap/savefile.c,v 1.72 2002-12-22 23:05:53 guy Exp $ (LBL)";
48 #ifdef HAVE_OS_PROTO_H
52 #define TCPDUMP_MAGIC 0xa1b2c3d4
53 #define PATCHED_TCPDUMP_MAGIC 0xa1b2cd34
56 * We use the "receiver-makes-right" approach to byte order,
57 * because time is at a premium when we are writing the file.
58 * In other words, the pcap_file_header and pcap_pkthdr,
59 * records are written in host byte order.
60 * Note that the packets are always written in network byte order.
62 * ntoh[ls] aren't sufficient because we might need to swap on a big-endian
63 * machine (if the file was written in little-end order).
66 ((((y)&0xff)<<24) | (((y)&0xff00)<<8) | (((y)&0xff0000)>>8) | (((y)>>24)&0xff))
67 #define SWAPSHORT(y) \
68 ( (((y)&0xff)<<8) | ((u_short)((y)&0xff00)>>8) )
71 #define SFERR_BADVERSION 2
73 #define SFERR_EOF 4 /* not really an error, just a status */
76 * We don't write DLT_* values to the capture file header, because
77 * they're not the same on all platforms.
79 * Unfortunately, the various flavors of BSD have not always used the same
80 * numerical values for the same data types, and various patches to
81 * libpcap for non-BSD OSes have added their own DLT_* codes for link
82 * layer encapsulation types seen on those OSes, and those codes have had,
83 * in some cases, values that were also used, on other platforms, for other
84 * link layer encapsulation types.
86 * This means that capture files of a type whose numerical DLT_* code
87 * means different things on different BSDs, or with different versions
88 * of libpcap, can't always be read on systems other than those like
89 * the one running on the machine on which the capture was made.
91 * Instead, we define here a set of LINKTYPE_* codes, and map DLT_* codes
92 * to LINKTYPE_* codes when writing a savefile header, and map LINKTYPE_*
93 * codes to DLT_* codes when reading a savefile header.
95 * For those DLT_* codes that have, as far as we know, the same values on
96 * all platforms (DLT_NULL through DLT_FDDI), we define LINKTYPE_xxx as
97 * DLT_xxx; that way, captures of those types can still be read by
98 * versions of libpcap that map LINKTYPE_* values to DLT_* values, and
99 * captures of those types written by versions of libpcap that map DLT_
100 * values to LINKTYPE_ values can still be read by older versions
103 * The other LINKTYPE_* codes are given values starting at 100, in the
104 * hopes that no DLT_* code will be given one of those values.
106 * In order to ensure that a given LINKTYPE_* code's value will refer to
107 * the same encapsulation type on all platforms, you should not allocate
108 * a new LINKTYPE_* value without consulting "tcpdump-workers@tcpdump.org".
109 * The tcpdump developers will allocate a value for you, and will not
110 * subsequently allocate it to anybody else; that value will be added to
111 * the "pcap.h" in the tcpdump.org CVS repository, so that a future
112 * libpcap release will include it.
114 * You should, if possible, also contribute patches to libpcap and tcpdump
115 * to handle the new encapsulation type, so that they can also be checked
116 * into the tcpdump.org CVS repository and so that they will appear in
117 * future libpcap and tcpdump releases.
119 #define LINKTYPE_NULL DLT_NULL
120 #define LINKTYPE_ETHERNET DLT_EN10MB /* also for 100Mb and up */
121 #define LINKTYPE_EXP_ETHERNET DLT_EN3MB /* 3Mb experimental Ethernet */
122 #define LINKTYPE_AX25 DLT_AX25
123 #define LINKTYPE_PRONET DLT_PRONET
124 #define LINKTYPE_CHAOS DLT_CHAOS
125 #define LINKTYPE_TOKEN_RING DLT_IEEE802 /* DLT_IEEE802 is used for Token Ring */
126 #define LINKTYPE_ARCNET DLT_ARCNET
127 #define LINKTYPE_SLIP DLT_SLIP
128 #define LINKTYPE_PPP DLT_PPP
129 #define LINKTYPE_FDDI DLT_FDDI
132 * LINKTYPE_PPP is for use when there might, or might not, be an RFC 1662
133 * PPP in HDLC-like framing header (with 0xff 0x03 before the PPP protocol
134 * field) at the beginning of the packet.
136 * This is for use when there is always such a header; the address field
137 * might be 0xff, for regular PPP, or it might be an address field for Cisco
138 * point-to-point with HDLC framing as per section 4.3.1 of RFC 1547 ("Cisco
139 * HDLC"). This is, for example, what you get with NetBSD's DLT_PPP_SERIAL.
141 * We give it the same value as NetBSD's DLT_PPP_SERIAL, in the hopes that
142 * nobody else will choose a DLT_ value of 50, and so that DLT_PPP_SERIAL
143 * captures will be written out with a link type that NetBSD's tcpdump
146 #define LINKTYPE_PPP_HDLC 50 /* PPP in HDLC-like framing */
148 #define LINKTYPE_PPP_ETHER 51 /* NetBSD PPP-over-Ethernet */
150 #define LINKTYPE_ATM_RFC1483 100 /* LLC/SNAP-encapsulated ATM */
151 #define LINKTYPE_RAW 101 /* raw IP */
152 #define LINKTYPE_SLIP_BSDOS 102 /* BSD/OS SLIP BPF header */
153 #define LINKTYPE_PPP_BSDOS 103 /* BSD/OS PPP BPF header */
154 #define LINKTYPE_C_HDLC 104 /* Cisco HDLC */
155 #define LINKTYPE_IEEE802_11 105 /* IEEE 802.11 (wireless) */
156 #define LINKTYPE_ATM_CLIP 106 /* Linux Classical IP over ATM */
157 #define LINKTYPE_FRELAY 107 /* Frame Relay */
158 #define LINKTYPE_LOOP 108 /* OpenBSD loopback */
160 #define LINKTYPE_LINUX_SLL 113 /* Linux cooked socket capture */
161 #define LINKTYPE_LTALK 114 /* Apple LocalTalk hardware */
162 #define LINKTYPE_ECONET 115 /* Acorn Econet */
164 #define LINKTYPE_CISCO_IOS 118 /* For Cisco-internal use */
165 #define LINKTYPE_PRISM_HEADER 119 /* 802.11+Prism II monitor mode */
166 #define LINKTYPE_AIRONET_HEADER 120 /* FreeBSD Aironet driver stuff */
167 #define LINKTYPE_IP_OVER_FC 122 /* RFC 2625 IP-over-Fibre Channel */
168 #define LINKTYPE_SUNATM 123 /* Solaris+SunATM */
170 #define LINKTYPE_IEEE802_11_RADIO 127 /* 802.11 plus WLAN header */
173 * These types are reserved for future use.
175 #define LINKTYPE_ENC 109 /* OpenBSD IPSEC enc */
176 #define LINKTYPE_LANE8023 110 /* ATM LANE + 802.3 */
177 #define LINKTYPE_HIPPI 111 /* NetBSD HIPPI */
178 #define LINKTYPE_HDLC 112 /* NetBSD HDLC framing */
179 #define LINKTYPE_IPFILTER 116 /* IP Filter capture files */
180 #define LINKTYPE_PFLOG 117 /* OpenBSD DLT_PFLOG */
181 #define LINKTYPE_HHDLC 121 /* Siemens HiPath HDLC */
182 #define LINKTYPE_RIO 123 /* RapidIO */
183 #define LINKTYPE_PCI_EXP 124 /* PCI Express */
184 #define LINKTYPE_AURORA 125 /* Xilinx Aurora link layer */
186 static struct linktype_map
{
191 * These DLT_* codes have LINKTYPE_* codes with values identical
192 * to the values of the corresponding DLT_* code.
194 { DLT_NULL
, LINKTYPE_NULL
},
195 { DLT_EN10MB
, LINKTYPE_ETHERNET
},
196 { DLT_EN3MB
, LINKTYPE_EXP_ETHERNET
},
197 { DLT_AX25
, LINKTYPE_AX25
},
198 { DLT_PRONET
, LINKTYPE_PRONET
},
199 { DLT_CHAOS
, LINKTYPE_CHAOS
},
200 { DLT_IEEE802
, LINKTYPE_TOKEN_RING
},
201 { DLT_ARCNET
, LINKTYPE_ARCNET
},
202 { DLT_SLIP
, LINKTYPE_SLIP
},
203 { DLT_PPP
, LINKTYPE_PPP
},
204 { DLT_FDDI
, LINKTYPE_FDDI
},
207 * These DLT_* codes have different values on different
208 * platforms; we map them to LINKTYPE_* codes that
209 * have values that should never be equal to any DLT_*
213 /* BSD/OS Frame Relay */
214 { DLT_FR
, LINKTYPE_FRELAY
},
216 { DLT_ATM_RFC1483
, LINKTYPE_ATM_RFC1483
},
217 { DLT_RAW
, LINKTYPE_RAW
},
218 { DLT_SLIP_BSDOS
, LINKTYPE_SLIP_BSDOS
},
219 { DLT_PPP_BSDOS
, LINKTYPE_PPP_BSDOS
},
221 /* BSD/OS Cisco HDLC */
222 { DLT_C_HDLC
, LINKTYPE_C_HDLC
},
225 * These DLT_* codes are not on all platforms, but, so far,
226 * there don't appear to be any platforms that define
227 * other codes with those values; we map them to
228 * different LINKTYPE_* values anyway, just in case.
231 /* Linux ATM Classical IP */
232 { DLT_ATM_CLIP
, LINKTYPE_ATM_CLIP
},
234 /* NetBSD sync/async serial PPP (or Cisco HDLC) */
235 { DLT_PPP_SERIAL
, LINKTYPE_PPP_HDLC
},
237 /* NetBSD PPP over Ethernet */
238 { DLT_PPP_ETHER
, LINKTYPE_PPP_ETHER
},
240 /* IEEE 802.11 wireless */
241 { DLT_IEEE802_11
, LINKTYPE_IEEE802_11
},
244 { DLT_FRELAY
, LINKTYPE_FRELAY
},
246 /* OpenBSD loopback */
247 { DLT_LOOP
, LINKTYPE_LOOP
},
249 /* Linux cooked socket capture */
250 { DLT_LINUX_SLL
, LINKTYPE_LINUX_SLL
},
252 /* Apple LocalTalk hardware */
253 { DLT_LTALK
, LINKTYPE_LTALK
},
256 { DLT_ECONET
, LINKTYPE_ECONET
},
258 /* For Cisco-internal use */
259 { DLT_CISCO_IOS
, LINKTYPE_CISCO_IOS
},
261 /* Prism II monitor-mode header plus 802.11 header */
262 { DLT_PRISM_HEADER
, LINKTYPE_PRISM_HEADER
},
264 /* FreeBSD Aironet driver stuff */
265 { DLT_AIRONET_HEADER
, LINKTYPE_AIRONET_HEADER
},
267 /* Siemens HiPath HDLC */
268 { DLT_HHDLC
, LINKTYPE_HHDLC
},
270 /* RFC 2625 IP-over-Fibre Channel */
271 { DLT_IP_OVER_FC
, LINKTYPE_IP_OVER_FC
},
274 { DLT_SUNATM
, LINKTYPE_SUNATM
},
277 { DLT_RIO
, LINKTYPE_RIO
},
280 { DLT_PCI_EXP
, LINKTYPE_PCI_EXP
},
282 /* Xilinx Aurora link layer */
283 { DLT_AURORA
, LINKTYPE_AURORA
},
285 /* 802.11 plus WLAN header */
286 { DLT_IEEE802_11_RADIO
, LINKTYPE_IEEE802_11_RADIO
},
289 * Any platform that defines additional DLT_* codes should:
291 * request a LINKTYPE_* code and value from tcpdump.org,
294 * add, in their version of libpcap, an entry to map
295 * those DLT_* codes to the corresponding LINKTYPE_*
298 * redefine, in their "net/bpf.h", any DLT_* values
299 * that collide with the values used by their additional
300 * DLT_* codes, to remove those collisions (but without
301 * making them collide with any of the LINKTYPE_*
302 * values equal to 50 or above; they should also avoid
303 * defining DLT_* values that collide with those
304 * LINKTYPE_* values, either).
310 dlt_to_linktype(int dlt
)
314 for (i
= 0; map
[i
].dlt
!= -1; i
++) {
315 if (map
[i
].dlt
== dlt
)
316 return (map
[i
].linktype
);
320 * If we don't have a mapping for this DLT_ code, return an
321 * error; that means that the table above needs to have an
328 linktype_to_dlt(int linktype
)
332 for (i
= 0; map
[i
].linktype
!= -1; i
++) {
333 if (map
[i
].linktype
== linktype
)
338 * If we don't have an entry for this link type, return
339 * the link type value; it may be a DLT_ value from an
340 * older version of libpcap.
346 sf_write_header(FILE *fp
, int linktype
, int thiszone
, int snaplen
)
348 struct pcap_file_header hdr
;
350 hdr
.magic
= TCPDUMP_MAGIC
;
351 hdr
.version_major
= PCAP_VERSION_MAJOR
;
352 hdr
.version_minor
= PCAP_VERSION_MINOR
;
354 hdr
.thiszone
= thiszone
;
355 hdr
.snaplen
= snaplen
;
357 hdr
.linktype
= linktype
;
359 if (fwrite((char *)&hdr
, sizeof(hdr
), 1, fp
) != 1)
366 swap_hdr(struct pcap_file_header
*hp
)
368 hp
->version_major
= SWAPSHORT(hp
->version_major
);
369 hp
->version_minor
= SWAPSHORT(hp
->version_minor
);
370 hp
->thiszone
= SWAPLONG(hp
->thiszone
);
371 hp
->sigfigs
= SWAPLONG(hp
->sigfigs
);
372 hp
->snaplen
= SWAPLONG(hp
->snaplen
);
373 hp
->linktype
= SWAPLONG(hp
->linktype
);
377 pcap_open_offline(const char *fname
, char *errbuf
)
381 struct pcap_file_header hdr
;
385 p
= (pcap_t
*)malloc(sizeof(*p
));
387 strlcpy(errbuf
, "out of swap", PCAP_ERRBUF_SIZE
);
391 memset((char *)p
, 0, sizeof(*p
));
393 * Set this field so we don't close stdin in pcap_close!
401 if (fname
[0] == '-' && fname
[1] == '\0')
405 fp
= fopen(fname
, "r");
407 fp
= fopen(fname
, "rb");
410 snprintf(errbuf
, PCAP_ERRBUF_SIZE
, "%s: %s", fname
,
411 pcap_strerror(errno
));
415 if (fread((char *)&hdr
, sizeof(hdr
), 1, fp
) != 1) {
416 snprintf(errbuf
, PCAP_ERRBUF_SIZE
, "fread: %s",
417 pcap_strerror(errno
));
421 if (magic
!= TCPDUMP_MAGIC
&& magic
!= PATCHED_TCPDUMP_MAGIC
) {
422 magic
= SWAPLONG(magic
);
423 if (magic
!= TCPDUMP_MAGIC
&& magic
!= PATCHED_TCPDUMP_MAGIC
) {
424 snprintf(errbuf
, PCAP_ERRBUF_SIZE
,
425 "bad dump file format");
431 if (magic
== PATCHED_TCPDUMP_MAGIC
) {
433 * XXX - the patch that's in some versions of libpcap
434 * changes the packet header but not the magic number;
435 * we'd have to use some hacks^H^H^H^H^Hheuristics to
438 p
->sf
.hdrsize
= sizeof(struct pcap_sf_patched_pkthdr
);
440 p
->sf
.hdrsize
= sizeof(struct pcap_sf_pkthdr
);
441 if (hdr
.version_major
< PCAP_VERSION_MAJOR
) {
442 snprintf(errbuf
, PCAP_ERRBUF_SIZE
, "archaic file format");
445 p
->tzoff
= hdr
.thiszone
;
446 p
->snapshot
= hdr
.snaplen
;
447 p
->linktype
= linktype_to_dlt(hdr
.linktype
);
450 p
->bufsize
= hdr
.snaplen
;
452 /* Allocate the space for pcap_pkthdr as well. It will be used by pcap_read_ex */
453 p
->bufsize
= hdr
.snaplen
+sizeof(struct pcap_pkthdr
);
456 /* Align link header as required for proper data alignment */
457 /* XXX should handle all types */
458 switch (p
->linktype
) {
465 linklen
= 13 + 8; /* fddi_header + llc */
475 p
->bufsize
= BPF_MAXBUFSIZE
;
476 p
->sf
.base
= (u_char
*)malloc(p
->bufsize
+ BPF_ALIGNMENT
);
477 if (p
->sf
.base
== NULL
) {
478 strlcpy(errbuf
, "out of swap", PCAP_ERRBUF_SIZE
);
481 p
->buffer
= p
->sf
.base
+ BPF_ALIGNMENT
- (linklen
% BPF_ALIGNMENT
);
482 p
->sf
.version_major
= hdr
.version_major
;
483 p
->sf
.version_minor
= hdr
.version_minor
;
485 /* XXX padding only needed for kernel fcode */
498 * Read sf_readfile and return the next packet. Return the header in hdr
499 * and the contents in buf. Return 0 on success, SFERR_EOF if there were
500 * no more packets, and SFERR_TRUNC if a partial packet was encountered.
507 sf_next_packet(pcap_t
*p
, struct pcap_pkthdr
*hdr
, u_char
*buf
, int buflen
)
509 struct pcap_sf_patched_pkthdr sf_hdr
;
510 FILE *fp
= p
->sf
.rfile
;
513 * Read the packet header; the structure we use as a buffer
514 * is the longer structure for files generated by the patched
515 * libpcap, but if the file has the magic number for an
516 * unpatched libpcap we only read as many bytes as the regular
519 if (fread(&sf_hdr
, p
->sf
.hdrsize
, 1, fp
) != 1) {
520 /* probably an EOF, though could be a truncated packet */
525 /* these were written in opposite byte order */
526 hdr
->caplen
= SWAPLONG(sf_hdr
.caplen
);
527 hdr
->len
= SWAPLONG(sf_hdr
.len
);
528 hdr
->ts
.tv_sec
= SWAPLONG(sf_hdr
.ts
.tv_sec
);
529 hdr
->ts
.tv_usec
= SWAPLONG(sf_hdr
.ts
.tv_usec
);
531 hdr
->caplen
= sf_hdr
.caplen
;
532 hdr
->len
= sf_hdr
.len
;
533 hdr
->ts
.tv_sec
= sf_hdr
.ts
.tv_sec
;
534 hdr
->ts
.tv_usec
= sf_hdr
.ts
.tv_usec
;
537 * We interchanged the caplen and len fields at version 2.3,
538 * in order to match the bpf header layout. But unfortunately
539 * some files were written with version 2.3 in their headers
540 * but without the interchanged fields.
542 if (p
->sf
.version_minor
< 3 ||
543 (p
->sf
.version_minor
== 3 && hdr
->caplen
> hdr
->len
)) {
545 hdr
->caplen
= hdr
->len
;
549 if (hdr
->caplen
> buflen
) {
551 * This can happen due to Solaris 2.3 systems tripping
552 * over the BUFMOD problem and not setting the snapshot
553 * correctly in the savefile header. If the caplen isn't
554 * grossly wrong, try to salvage.
556 static u_char
*tp
= NULL
;
557 static int tsize
= 0;
559 if (hdr
->caplen
> 65535) {
560 snprintf(p
->errbuf
, PCAP_ERRBUF_SIZE
,
561 "bogus savefile header");
565 if (tsize
< hdr
->caplen
) {
566 tsize
= ((hdr
->caplen
+ 1023) / 1024) * 1024;
569 tp
= (u_char
*)malloc(tsize
);
572 snprintf(p
->errbuf
, PCAP_ERRBUF_SIZE
,
573 "BUFMOD hack malloc");
577 if (fread((char *)tp
, hdr
->caplen
, 1, fp
) != 1) {
578 snprintf(p
->errbuf
, PCAP_ERRBUF_SIZE
,
579 "truncated dump file");
583 * We can only keep up to buflen bytes. Since caplen > buflen
584 * is exactly how we got here, we know we can only keep the
585 * first buflen bytes and must drop the remainder. Adjust
586 * caplen accordingly, so we don't get confused later as
587 * to how many bytes we have to play with.
589 hdr
->caplen
= buflen
;
590 memcpy((char *)buf
, (char *)tp
, buflen
);
593 /* read the packet itself */
595 if (fread((char *)buf
, hdr
->caplen
, 1, fp
) != 1) {
596 snprintf(p
->errbuf
, PCAP_ERRBUF_SIZE
,
597 "truncated dump file");
605 * Print out packets stored in the file initialized by sf_read_init().
606 * If cnt > 0, return after 'cnt' packets, otherwise continue until eof.
609 pcap_offline_read(pcap_t
*p
, int cnt
, pcap_handler callback
, u_char
*user
)
611 struct bpf_insn
*fcode
= p
->fcode
.bf_insns
;
615 while (status
== 0) {
616 struct pcap_pkthdr h
;
618 status
= sf_next_packet(p
, &h
, p
->buffer
, p
->bufsize
);
626 bpf_filter(fcode
, p
->buffer
, h
.len
, h
.caplen
)) {
627 (*callback
)(user
, &h
, p
->buffer
);
628 if (++n
>= cnt
&& cnt
> 0)
632 /*XXX this breaks semantics tcpslice expects */
637 * Output a packet to the initialized dump file.
640 pcap_dump(u_char
*user
, const struct pcap_pkthdr
*h
, const u_char
*sp
)
643 struct pcap_sf_pkthdr sf_hdr
;
646 sf_hdr
.ts
.tv_sec
= h
->ts
.tv_sec
;
647 sf_hdr
.ts
.tv_usec
= h
->ts
.tv_usec
;
648 sf_hdr
.caplen
= h
->caplen
;
650 /* XXX we should check the return status */
651 (void)fwrite(&sf_hdr
, sizeof(sf_hdr
), 1, f
);
652 (void)fwrite((char *)sp
, h
->caplen
, 1, f
);
656 * Initialize so that sf_write() will output to the file named 'fname'.
659 pcap_dump_open(pcap_t
*p
, const char *fname
)
664 linktype
= dlt_to_linktype(p
->linktype
);
665 if (linktype
== -1) {
666 snprintf(p
->errbuf
, PCAP_ERRBUF_SIZE
,
667 "%s: link-layer type %d isn't supported in savefiles",
672 if (fname
[0] == '-' && fname
[1] == '\0') {
675 _setmode(_fileno(f
), _O_BINARY
);
679 f
= fopen(fname
, "w");
681 f
= fopen(fname
, "wb");
682 setbuf(f
, NULL
); /* XXX - why? */
685 snprintf(p
->errbuf
, PCAP_ERRBUF_SIZE
, "%s: %s",
686 fname
, pcap_strerror(errno
));
690 (void)sf_write_header(f
, linktype
, p
->tzoff
, p
->snapshot
);
691 return ((pcap_dumper_t
*)f
);
695 pcap_dump_flush(pcap_dumper_t
*p
)
698 if (fflush((FILE *)p
) == EOF
)
705 pcap_dump_close(pcap_dumper_t
*p
)
709 if (ferror((FILE *)p
))
711 /* XXX should check return from fclose() too */
713 (void)fclose((FILE *)p
);