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 * sf-pcapng.c - pcapng-file-format-specific code from savefile.c
28 #include <pcap/pcap-inttypes.h>
38 #include "pcap-common.h"
40 #ifdef HAVE_OS_PROTO_H
44 #include "sf-pcapng.h"
51 * Common part at the beginning of all blocks.
54 bpf_u_int32 block_type
;
55 bpf_u_int32 total_length
;
59 * Common trailer at the end of all blocks.
61 struct block_trailer
{
62 bpf_u_int32 total_length
;
68 #define OPT_ENDOFOPT 0 /* end of options */
69 #define OPT_COMMENT 1 /* comment string */
74 struct option_header
{
76 u_short option_length
;
80 * Structures for the part of each block type following the common
85 * Section Header Block.
87 #define BT_SHB 0x0A0D0D0A
89 struct section_header_block
{
90 bpf_u_int32 byte_order_magic
;
91 u_short major_version
;
92 u_short minor_version
;
93 uint64_t section_length
;
94 /* followed by options and trailer */
98 * Byte-order magic value.
100 #define BYTE_ORDER_MAGIC 0x1A2B3C4D
103 * Current version number. If major_version isn't PCAP_NG_VERSION_MAJOR,
104 * that means that this code can't read the file.
106 #define PCAP_NG_VERSION_MAJOR 1
107 #define PCAP_NG_VERSION_MINOR 0
110 * Interface Description Block.
112 #define BT_IDB 0x00000001
114 struct interface_description_block
{
118 /* followed by options and trailer */
122 * Options in the IDB.
124 #define IF_NAME 2 /* interface name string */
125 #define IF_DESCRIPTION 3 /* interface description string */
126 #define IF_IPV4ADDR 4 /* interface's IPv4 address and netmask */
127 #define IF_IPV6ADDR 5 /* interface's IPv6 address and prefix length */
128 #define IF_MACADDR 6 /* interface's MAC address */
129 #define IF_EUIADDR 7 /* interface's EUI address */
130 #define IF_SPEED 8 /* interface's speed, in bits/s */
131 #define IF_TSRESOL 9 /* interface's time stamp resolution */
132 #define IF_TZONE 10 /* interface's time zone */
133 #define IF_FILTER 11 /* filter used when capturing on interface */
134 #define IF_OS 12 /* string OS on which capture on this interface was done */
135 #define IF_FCSLEN 13 /* FCS length for this interface */
136 #define IF_TSOFFSET 14 /* time stamp offset for this interface */
139 * Enhanced Packet Block.
141 #define BT_EPB 0x00000006
143 struct enhanced_packet_block
{
144 bpf_u_int32 interface_id
;
145 bpf_u_int32 timestamp_high
;
146 bpf_u_int32 timestamp_low
;
149 /* followed by packet data, options, and trailer */
153 * Simple Packet Block.
155 #define BT_SPB 0x00000003
157 struct simple_packet_block
{
159 /* followed by packet data and trailer */
165 #define BT_PB 0x00000002
167 struct packet_block
{
168 u_short interface_id
;
170 bpf_u_int32 timestamp_high
;
171 bpf_u_int32 timestamp_low
;
174 /* followed by packet data, options, and trailer */
178 * Block cursor - used when processing the contents of a block.
179 * Contains a pointer into the data being processed and a count
180 * of bytes remaining in the block.
182 struct block_cursor
{
184 size_t data_remaining
;
185 bpf_u_int32 block_type
;
194 } tstamp_scale_type_t
;
197 * Per-interface information.
200 uint64_t tsresol
; /* time stamp resolution */
201 tstamp_scale_type_t scale_type
; /* how to scale */
202 uint64_t scale_factor
; /* time stamp scale factor for power-of-10 tsresol */
203 uint64_t tsoffset
; /* time stamp offset */
207 * Per-pcap_t private data.
209 * max_blocksize is the maximum size of a block that we'll accept. We
210 * reject blocks bigger than this, so we don't consume too much memory
211 * with a truly huge block. It can change as we see IDBs with different
212 * link-layer header types. (Currently, we don't support IDBs with
213 * different link-layer header types, but we will support it in the
214 * future, when we offer file-reading APIs that support it.)
216 * XXX - that's an issue on ILP32 platforms, where the maximum block
217 * size of 2^31-1 would eat all but one byte of the entire address space.
218 * It's less of an issue on ILP64/LLP64 platforms, but the actual size
219 * of the address space may be limited by 1) the number of *significant*
220 * address bits (currently, x86-64 only supports 48 bits of address), 2)
221 * any limitations imposed by the operating system; 3) any limitations
222 * imposed by the amount of available backing store for anonymous pages,
223 * so we impose a limit regardless of the size of a pointer.
226 uint64_t user_tsresol
; /* time stamp resolution requested by the user */
227 u_int max_blocksize
; /* don't grow buffer size past this */
228 bpf_u_int32 ifcount
; /* number of interfaces seen in this capture */
229 bpf_u_int32 ifaces_size
; /* size of array below */
230 struct pcap_ng_if
*ifaces
; /* array of interface information */
234 * The maximum block size we start with; we use an arbitrary value of
237 #define INITIAL_MAX_BLOCKSIZE (16*1024*1024)
240 * Maximum block size for a given maximum snapshot length; we define it
241 * as the size of an EPB with a max_snaplen-sized packet and 128KB of
244 #define MAX_BLOCKSIZE_FOR_SNAPLEN(max_snaplen) \
245 (sizeof (struct block_header) + \
246 sizeof (struct enhanced_packet_block) + \
247 (max_snaplen) + 131072 + \
248 sizeof (struct block_trailer))
250 static void pcap_ng_cleanup(pcap_t
*p
);
251 static int pcap_ng_next_packet(pcap_t
*p
, struct pcap_pkthdr
*hdr
,
255 read_bytes(FILE *fp
, void *buf
, size_t bytes_to_read
, int fail_on_eof
,
260 amt_read
= fread(buf
, 1, bytes_to_read
, fp
);
261 if (amt_read
!= bytes_to_read
) {
263 pcap_fmt_errmsg_for_errno(errbuf
, PCAP_ERRBUF_SIZE
,
264 errno
, "error reading dump file");
266 if (amt_read
== 0 && !fail_on_eof
)
267 return (0); /* EOF */
268 pcap_snprintf(errbuf
, PCAP_ERRBUF_SIZE
,
269 "truncated dump file; tried to read %" PRIsize
" bytes, only got %" PRIsize
,
270 bytes_to_read
, amt_read
);
278 read_block(FILE *fp
, pcap_t
*p
, struct block_cursor
*cursor
, char *errbuf
)
280 struct pcap_ng_sf
*ps
;
282 struct block_header bhdr
;
283 struct block_trailer
*btrlr
;
285 size_t data_remaining
;
289 status
= read_bytes(fp
, &bhdr
, sizeof(bhdr
), 0, errbuf
);
291 return (status
); /* error or EOF */
294 bhdr
.block_type
= SWAPLONG(bhdr
.block_type
);
295 bhdr
.total_length
= SWAPLONG(bhdr
.total_length
);
299 * Is this block "too small" - i.e., is it shorter than a block
300 * header plus a block trailer?
302 if (bhdr
.total_length
< sizeof(struct block_header
) +
303 sizeof(struct block_trailer
)) {
304 pcap_snprintf(errbuf
, PCAP_ERRBUF_SIZE
,
305 "block in pcapng dump file has a length of %u < %" PRIsize
,
307 sizeof(struct block_header
) + sizeof(struct block_trailer
));
312 * Is the block total length a multiple of 4?
314 if ((bhdr
.total_length
% 4) != 0) {
318 * According to Wireshark's code to read pcapng files,
319 * "the "block total length" of some example files
320 * don't contain the packet data padding bytes!",
321 * so we just round up rather than treating this as an
324 if (bhdr
.total_length
> 0xFFFFFFFCU
) {
326 * Not a multiple of 4, *and* can't be rounded
327 * up to a multiple of 4 and still fit in 32 bits.
329 pcap_snprintf(errbuf
, PCAP_ERRBUF_SIZE
,
330 "block in pcapng dump file has a length of %u that is not a multiple of 4 and can't be rounded up to a multiple of 4" PRIsize
,
338 bhdr
.total_length
= bhdr
.total_length
+ 4 - (bhdr
.total_length
% 4);
342 * Is the buffer big enough?
344 if (p
->bufsize
< bhdr
.total_length
) {
346 * No - make it big enough, unless it's too big, in
347 * which case we fail.
351 if (bhdr
.total_length
> ps
->max_blocksize
) {
352 pcap_snprintf(errbuf
, PCAP_ERRBUF_SIZE
, "pcapng block size %u > maximum %u", bhdr
.total_length
,
356 bigger_buffer
= realloc(p
->buffer
, bhdr
.total_length
);
357 if (bigger_buffer
== NULL
) {
358 pcap_snprintf(errbuf
, PCAP_ERRBUF_SIZE
, "out of memory");
361 p
->buffer
= bigger_buffer
;
365 * Copy the stuff we've read to the buffer, and read the rest
368 memcpy(p
->buffer
, &bhdr
, sizeof(bhdr
));
369 bdata
= (u_char
*)p
->buffer
+ sizeof(bhdr
);
370 data_remaining
= bhdr
.total_length
- sizeof(bhdr
);
371 if (read_bytes(fp
, bdata
, data_remaining
, 1, errbuf
) == -1)
375 * Get the block size from the trailer.
377 btrlr
= (struct block_trailer
*)(bdata
+ data_remaining
- sizeof (struct block_trailer
));
379 btrlr
->total_length
= SWAPLONG(btrlr
->total_length
);
382 * Is the total length from the trailer a multiple of 4?
384 if ((btrlr
->total_length
% 4) != 0) {
388 * According to Wireshark's code to read pcapng files,
389 * "the "block total length" of some example files
390 * don't contain the packet data padding bytes!",
391 * so we just round up rather than treating this as an
394 if (btrlr
->total_length
> 0xFFFFFFFCU
) {
396 * Not a multiple of 4, *and* can't be rounded
397 * up to a multiple of 4 and still fit in 32 bits.
399 pcap_snprintf(errbuf
, PCAP_ERRBUF_SIZE
,
400 "trailer of block in pcapng dump file has a block total length of %u that is not a multiple of 4 and can't be rounded up to a multiple of 4" PRIsize
,
401 btrlr
->total_length
);
408 btrlr
->total_length
= btrlr
->total_length
+ 4 - (btrlr
->total_length
% 4);
412 * Is it the same as the total length from the header?
414 if (bhdr
.total_length
!= btrlr
->total_length
) {
415 pcap_snprintf(errbuf
, PCAP_ERRBUF_SIZE
,
416 "block total length in header and trailer don't match");
421 * Initialize the cursor.
423 cursor
->data
= bdata
;
424 cursor
->data_remaining
= data_remaining
- sizeof(struct block_trailer
);
425 cursor
->block_type
= bhdr
.block_type
;
430 get_from_block_data(struct block_cursor
*cursor
, size_t chunk_size
,
436 * Make sure we have the specified amount of data remaining in
439 if (cursor
->data_remaining
< chunk_size
) {
440 pcap_snprintf(errbuf
, PCAP_ERRBUF_SIZE
,
441 "block of type %u in pcapng dump file is too short",
447 * Return the current pointer, and skip past the chunk.
450 cursor
->data
+= chunk_size
;
451 cursor
->data_remaining
-= chunk_size
;
455 static struct option_header
*
456 get_opthdr_from_block_data(pcap_t
*p
, struct block_cursor
*cursor
, char *errbuf
)
458 struct option_header
*opthdr
;
460 opthdr
= get_from_block_data(cursor
, sizeof(*opthdr
), errbuf
);
461 if (opthdr
== NULL
) {
463 * Option header is cut short.
469 * Byte-swap it if necessary.
472 opthdr
->option_code
= SWAPSHORT(opthdr
->option_code
);
473 opthdr
->option_length
= SWAPSHORT(opthdr
->option_length
);
480 get_optvalue_from_block_data(struct block_cursor
*cursor
,
481 struct option_header
*opthdr
, char *errbuf
)
483 size_t padded_option_len
;
486 /* Pad option length to 4-byte boundary */
487 padded_option_len
= opthdr
->option_length
;
488 padded_option_len
= ((padded_option_len
+ 3)/4)*4;
490 optvalue
= get_from_block_data(cursor
, padded_option_len
, errbuf
);
491 if (optvalue
== NULL
) {
493 * Option value is cut short.
502 process_idb_options(pcap_t
*p
, struct block_cursor
*cursor
, uint64_t *tsresol
,
503 uint64_t *tsoffset
, int *is_binary
, char *errbuf
)
505 struct option_header
*opthdr
;
507 int saw_tsresol
, saw_tsoffset
;
513 while (cursor
->data_remaining
!= 0) {
515 * Get the option header.
517 opthdr
= get_opthdr_from_block_data(p
, cursor
, errbuf
);
518 if (opthdr
== NULL
) {
520 * Option header is cut short.
528 optvalue
= get_optvalue_from_block_data(cursor
, opthdr
,
530 if (optvalue
== NULL
) {
532 * Option value is cut short.
537 switch (opthdr
->option_code
) {
540 if (opthdr
->option_length
!= 0) {
541 pcap_snprintf(errbuf
, PCAP_ERRBUF_SIZE
,
542 "Interface Description Block has opt_endofopt option with length %u != 0",
543 opthdr
->option_length
);
549 if (opthdr
->option_length
!= 1) {
550 pcap_snprintf(errbuf
, PCAP_ERRBUF_SIZE
,
551 "Interface Description Block has if_tsresol option with length %u != 1",
552 opthdr
->option_length
);
556 pcap_snprintf(errbuf
, PCAP_ERRBUF_SIZE
,
557 "Interface Description Block has more than one if_tsresol option");
561 memcpy(&tsresol_opt
, optvalue
, sizeof(tsresol_opt
));
562 if (tsresol_opt
& 0x80) {
564 * Resolution is negative power of 2.
566 uint8_t tsresol_shift
= (tsresol_opt
& 0x7F);
568 if (tsresol_shift
> 63) {
570 * Resolution is too high; 2^-{res}
571 * won't fit in a 64-bit value.
573 pcap_snprintf(errbuf
, PCAP_ERRBUF_SIZE
,
574 "Interface Description Block if_tsresol option resolution 2^-%u is too high",
579 *tsresol
= ((uint64_t)1) << tsresol_shift
;
582 * Resolution is negative power of 10.
584 if (tsresol_opt
> 19) {
586 * Resolution is too high; 2^-{res}
587 * won't fit in a 64-bit value (the
588 * largest power of 10 that fits
589 * in a 64-bit value is 10^19, as
590 * the largest 64-bit unsigned
591 * value is ~1.8*10^19).
593 pcap_snprintf(errbuf
, PCAP_ERRBUF_SIZE
,
594 "Interface Description Block if_tsresol option resolution 10^-%u is too high",
600 for (i
= 0; i
< tsresol_opt
; i
++)
606 if (opthdr
->option_length
!= 8) {
607 pcap_snprintf(errbuf
, PCAP_ERRBUF_SIZE
,
608 "Interface Description Block has if_tsoffset option with length %u != 8",
609 opthdr
->option_length
);
613 pcap_snprintf(errbuf
, PCAP_ERRBUF_SIZE
,
614 "Interface Description Block has more than one if_tsoffset option");
618 memcpy(tsoffset
, optvalue
, sizeof(*tsoffset
));
620 *tsoffset
= SWAPLL(*tsoffset
);
633 add_interface(pcap_t
*p
, struct block_cursor
*cursor
, char *errbuf
)
635 struct pcap_ng_sf
*ps
;
643 * Count this interface.
648 * Grow the array of per-interface information as necessary.
650 if (ps
->ifcount
> ps
->ifaces_size
) {
652 * We need to grow the array.
654 bpf_u_int32 new_ifaces_size
;
655 struct pcap_ng_if
*new_ifaces
;
657 if (ps
->ifaces_size
== 0) {
659 * It's currently empty.
661 * (The Clang static analyzer doesn't do enough,
662 * err, umm, dataflow *analysis* to realize that
663 * ps->ifaces_size == 0 if ps->ifaces == NULL,
664 * and so complains about a possible zero argument
665 * to realloc(), so we check for the former
666 * condition to shut it up.
668 * However, it doesn't complain that one of the
669 * multiplications below could overflow, which is
670 * a real, albeit extremely unlikely, problem (you'd
671 * need a pcapng file with tens of millions of
675 new_ifaces
= malloc(sizeof (struct pcap_ng_if
));
678 * It's not currently empty; double its size.
679 * (Perhaps overkill once we have a lot of interfaces.)
681 * Check for overflow if we double it.
683 if (ps
->ifaces_size
* 2 < ps
->ifaces_size
) {
685 * The maximum number of interfaces before
686 * ps->ifaces_size overflows is the largest
687 * possible 32-bit power of 2, as we do
690 pcap_snprintf(errbuf
, PCAP_ERRBUF_SIZE
,
691 "more than %u interfaces in the file",
697 * ps->ifaces_size * 2 doesn't overflow, so it's
700 new_ifaces_size
= ps
->ifaces_size
* 2;
703 * Now make sure that's not so big that it overflows
704 * if we multiply by sizeof (struct pcap_ng_if).
706 * That can happen on 32-bit platforms, with a 32-bit
707 * size_t; it shouldn't happen on 64-bit platforms,
708 * with a 64-bit size_t, as new_ifaces_size is
711 if (new_ifaces_size
* sizeof (struct pcap_ng_if
) < new_ifaces_size
) {
713 * As this fails only with 32-bit size_t,
714 * the multiplication was 32x32->32, and
715 * the largest 32-bit value that can safely
716 * be multiplied by sizeof (struct pcap_ng_if)
717 * without overflow is the largest 32-bit
718 * (unsigned) value divided by
719 * sizeof (struct pcap_ng_if).
721 pcap_snprintf(errbuf
, PCAP_ERRBUF_SIZE
,
722 "more than %u interfaces in the file",
723 0xFFFFFFFFU
/ ((u_int
)sizeof (struct pcap_ng_if
)));
726 new_ifaces
= realloc(ps
->ifaces
, new_ifaces_size
* sizeof (struct pcap_ng_if
));
728 if (new_ifaces
== NULL
) {
730 * We ran out of memory.
733 pcap_snprintf(errbuf
, PCAP_ERRBUF_SIZE
,
734 "out of memory for per-interface information (%u interfaces)",
738 ps
->ifaces_size
= new_ifaces_size
;
739 ps
->ifaces
= new_ifaces
;
743 * Set the default time stamp resolution and offset.
745 tsresol
= 1000000; /* microsecond resolution */
746 is_binary
= 0; /* which is a power of 10 */
747 tsoffset
= 0; /* absolute timestamps */
750 * Now look for various time stamp options, so we know
751 * how to interpret the time stamps for this interface.
753 if (process_idb_options(p
, cursor
, &tsresol
, &tsoffset
, &is_binary
,
757 ps
->ifaces
[ps
->ifcount
- 1].tsresol
= tsresol
;
758 ps
->ifaces
[ps
->ifcount
- 1].tsoffset
= tsoffset
;
761 * Determine whether we're scaling up or down or not
762 * at all for this interface.
764 if (tsresol
== ps
->user_tsresol
) {
766 * The resolution is the resolution the user wants,
767 * so we don't have to do scaling.
769 ps
->ifaces
[ps
->ifcount
- 1].scale_type
= PASS_THROUGH
;
770 } else if (tsresol
> ps
->user_tsresol
) {
772 * The resolution is greater than what the user wants,
773 * so we have to scale the timestamps down.
776 ps
->ifaces
[ps
->ifcount
- 1].scale_type
= SCALE_DOWN_BIN
;
779 * Calculate the scale factor.
781 ps
->ifaces
[ps
->ifcount
- 1].scale_factor
= tsresol
/ps
->user_tsresol
;
782 ps
->ifaces
[ps
->ifcount
- 1].scale_type
= SCALE_DOWN_DEC
;
786 * The resolution is less than what the user wants,
787 * so we have to scale the timestamps up.
790 ps
->ifaces
[ps
->ifcount
- 1].scale_type
= SCALE_UP_BIN
;
793 * Calculate the scale factor.
795 ps
->ifaces
[ps
->ifcount
- 1].scale_factor
= ps
->user_tsresol
/tsresol
;
796 ps
->ifaces
[ps
->ifcount
- 1].scale_type
= SCALE_UP_DEC
;
803 * Check whether this is a pcapng savefile and, if it is, extract the
804 * relevant information from the header.
807 pcap_ng_check_header(bpf_u_int32 magic
, FILE *fp
, u_int precision
, char *errbuf
,
811 bpf_u_int32 total_length
;
812 bpf_u_int32 byte_order_magic
;
813 struct block_header
*bhdrp
;
814 struct section_header_block
*shbp
;
817 struct pcap_ng_sf
*ps
;
819 struct block_cursor cursor
;
820 struct interface_description_block
*idbp
;
823 * Assume no read errors.
828 * Check whether the first 4 bytes of the file are the block
829 * type for a pcapng savefile.
831 if (magic
!= BT_SHB
) {
833 * XXX - check whether this looks like what the block
834 * type would be after being munged by mapping between
835 * UN*X and DOS/Windows text file format and, if it
836 * does, look for the byte-order magic number in
837 * the appropriate place and, if we find it, report
838 * this as possibly being a pcapng file transferred
839 * between UN*X and Windows in text file format?
841 return (NULL
); /* nope */
845 * OK, they are. However, that's just \n\r\r\n, so it could,
846 * conceivably, be an ordinary text file.
848 * It could not, however, conceivably be any other type of
849 * capture file, so we can read the rest of the putative
850 * Section Header Block; put the block type in the common
851 * header, read the rest of the common header and the
852 * fixed-length portion of the SHB, and look for the byte-order
855 amt_read
= fread(&total_length
, 1, sizeof(total_length
), fp
);
856 if (amt_read
< sizeof(total_length
)) {
858 pcap_fmt_errmsg_for_errno(errbuf
, PCAP_ERRBUF_SIZE
,
859 errno
, "error reading dump file");
861 return (NULL
); /* fail */
865 * Possibly a weird short text file, so just say
870 amt_read
= fread(&byte_order_magic
, 1, sizeof(byte_order_magic
), fp
);
871 if (amt_read
< sizeof(byte_order_magic
)) {
873 pcap_fmt_errmsg_for_errno(errbuf
, PCAP_ERRBUF_SIZE
,
874 errno
, "error reading dump file");
876 return (NULL
); /* fail */
880 * Possibly a weird short text file, so just say
885 if (byte_order_magic
!= BYTE_ORDER_MAGIC
) {
886 byte_order_magic
= SWAPLONG(byte_order_magic
);
887 if (byte_order_magic
!= BYTE_ORDER_MAGIC
) {
894 total_length
= SWAPLONG(total_length
);
898 * Check the sanity of the total length.
900 if (total_length
< sizeof(*bhdrp
) + sizeof(*shbp
) + sizeof(struct block_trailer
)) {
901 pcap_snprintf(errbuf
, PCAP_ERRBUF_SIZE
,
902 "Section Header Block in pcapng dump file has a length of %u < %" PRIsize
,
904 sizeof(*bhdrp
) + sizeof(*shbp
) + sizeof(struct block_trailer
));
910 * Make sure it's not too big.
912 if (total_length
> INITIAL_MAX_BLOCKSIZE
) {
913 pcap_snprintf(errbuf
, PCAP_ERRBUF_SIZE
,
914 "pcapng block size %u > maximum %u",
915 total_length
, INITIAL_MAX_BLOCKSIZE
);
921 * OK, this is a good pcapng file.
922 * Allocate a pcap_t for it.
924 p
= pcap_open_offline_common(errbuf
, sizeof (struct pcap_ng_sf
));
926 /* Allocation failed. */
930 p
->swapped
= swapped
;
934 * What precision does the user want?
938 case PCAP_TSTAMP_PRECISION_MICRO
:
939 ps
->user_tsresol
= 1000000;
942 case PCAP_TSTAMP_PRECISION_NANO
:
943 ps
->user_tsresol
= 1000000000;
947 pcap_snprintf(errbuf
, PCAP_ERRBUF_SIZE
,
948 "unknown time stamp resolution %u", precision
);
954 p
->opt
.tstamp_precision
= precision
;
957 * Allocate a buffer into which to read blocks. We default to
960 * the total length of the SHB for which we read the header;
962 * 2K, which should be more than large enough for an Enhanced
963 * Packet Block containing a full-size Ethernet frame, and
964 * leaving room for some options.
966 * If we find a bigger block, we reallocate the buffer, up to
967 * the maximum size. We start out with a maximum size of
968 * INITIAL_MAX_BLOCKSIZE; if we see any link-layer header types
969 * with a maximum snapshot that results in a larger maximum
970 * block length, we boost the maximum.
973 if (p
->bufsize
< total_length
)
974 p
->bufsize
= total_length
;
975 p
->buffer
= malloc(p
->bufsize
);
976 if (p
->buffer
== NULL
) {
977 pcap_snprintf(errbuf
, PCAP_ERRBUF_SIZE
, "out of memory");
982 ps
->max_blocksize
= INITIAL_MAX_BLOCKSIZE
;
985 * Copy the stuff we've read to the buffer, and read the rest
988 bhdrp
= (struct block_header
*)p
->buffer
;
989 shbp
= (struct section_header_block
*)((u_char
*)p
->buffer
+ sizeof(struct block_header
));
990 bhdrp
->block_type
= magic
;
991 bhdrp
->total_length
= total_length
;
992 shbp
->byte_order_magic
= byte_order_magic
;
994 (u_char
*)p
->buffer
+ (sizeof(magic
) + sizeof(total_length
) + sizeof(byte_order_magic
)),
995 total_length
- (sizeof(magic
) + sizeof(total_length
) + sizeof(byte_order_magic
)),
1001 * Byte-swap the fields we've read.
1003 shbp
->major_version
= SWAPSHORT(shbp
->major_version
);
1004 shbp
->minor_version
= SWAPSHORT(shbp
->minor_version
);
1007 * XXX - we don't care about the section length.
1010 /* currently only SHB version 1.0 is supported */
1011 if (! (shbp
->major_version
== PCAP_NG_VERSION_MAJOR
&&
1012 shbp
->minor_version
== PCAP_NG_VERSION_MINOR
)) {
1013 pcap_snprintf(errbuf
, PCAP_ERRBUF_SIZE
,
1014 "unsupported pcapng savefile version %u.%u",
1015 shbp
->major_version
, shbp
->minor_version
);
1018 p
->version_major
= shbp
->major_version
;
1019 p
->version_minor
= shbp
->minor_version
;
1022 * Save the time stamp resolution the user requested.
1024 p
->opt
.tstamp_precision
= precision
;
1027 * Now start looking for an Interface Description Block.
1031 * Read the next block.
1033 status
= read_block(fp
, p
, &cursor
, errbuf
);
1035 /* EOF - no IDB in this file */
1036 pcap_snprintf(errbuf
, PCAP_ERRBUF_SIZE
,
1037 "the capture file has no Interface Description Blocks");
1041 goto fail
; /* error */
1042 switch (cursor
.block_type
) {
1046 * Get a pointer to the fixed-length portion of the
1049 idbp
= get_from_block_data(&cursor
, sizeof(*idbp
),
1052 goto fail
; /* error */
1055 * Byte-swap it if necessary.
1058 idbp
->linktype
= SWAPSHORT(idbp
->linktype
);
1059 idbp
->snaplen
= SWAPLONG(idbp
->snaplen
);
1063 * Try to add this interface.
1065 if (!add_interface(p
, &cursor
, errbuf
))
1074 * Saw a packet before we saw any IDBs. That's
1075 * not valid, as we don't know what link-layer
1076 * encapsulation the packet has.
1078 pcap_snprintf(errbuf
, PCAP_ERRBUF_SIZE
,
1079 "the capture file has a packet block before any Interface Description Blocks");
1091 p
->snapshot
= idbp
->snaplen
;
1092 if (p
->snapshot
<= 0) {
1094 * Bogus snapshot length; use the maximum for this
1095 * link-layer type as a fallback.
1097 * XXX - the only reason why snapshot is signed is
1098 * that pcap_snapshot() returns an int, not an
1101 p
->snapshot
= max_snaplen_for_dlt(idbp
->linktype
);
1103 p
->linktype
= linktype_to_dlt(idbp
->linktype
);
1104 p
->linktype_ext
= 0;
1107 * If the maximum block size for a packet with the maximum
1108 * snapshot length for this DLT_ is bigger than the current
1109 * maximum block size, increase the maximum.
1111 if (MAX_BLOCKSIZE_FOR_SNAPLEN(max_snaplen_for_dlt(p
->linktype
)) > ps
->max_blocksize
)
1112 ps
->max_blocksize
= MAX_BLOCKSIZE_FOR_SNAPLEN(max_snaplen_for_dlt(p
->linktype
));
1114 p
->next_packet_op
= pcap_ng_next_packet
;
1115 p
->cleanup_op
= pcap_ng_cleanup
;
1128 pcap_ng_cleanup(pcap_t
*p
)
1130 struct pcap_ng_sf
*ps
= p
->priv
;
1137 * Read and return the next packet from the savefile. Return the header
1138 * in hdr and a pointer to the contents in data. Return 0 on success, 1
1139 * if there were no more packets, and -1 on an error.
1142 pcap_ng_next_packet(pcap_t
*p
, struct pcap_pkthdr
*hdr
, u_char
**data
)
1144 struct pcap_ng_sf
*ps
= p
->priv
;
1145 struct block_cursor cursor
;
1147 struct enhanced_packet_block
*epbp
;
1148 struct simple_packet_block
*spbp
;
1149 struct packet_block
*pbp
;
1150 bpf_u_int32 interface_id
= 0xFFFFFFFF;
1151 struct interface_description_block
*idbp
;
1152 struct section_header_block
*shbp
;
1153 FILE *fp
= p
->rfile
;
1154 uint64_t t
, sec
, frac
;
1157 * Look for an Enhanced Packet Block, a Simple Packet Block,
1158 * or a Packet Block.
1162 * Read the block type and length; those are common
1165 status
= read_block(fp
, p
, &cursor
, p
->errbuf
);
1167 return (1); /* EOF */
1169 return (-1); /* error */
1170 switch (cursor
.block_type
) {
1174 * Get a pointer to the fixed-length portion of the
1177 epbp
= get_from_block_data(&cursor
, sizeof(*epbp
),
1180 return (-1); /* error */
1183 * Byte-swap it if necessary.
1186 /* these were written in opposite byte order */
1187 interface_id
= SWAPLONG(epbp
->interface_id
);
1188 hdr
->caplen
= SWAPLONG(epbp
->caplen
);
1189 hdr
->len
= SWAPLONG(epbp
->len
);
1190 t
= ((uint64_t)SWAPLONG(epbp
->timestamp_high
)) << 32 |
1191 SWAPLONG(epbp
->timestamp_low
);
1193 interface_id
= epbp
->interface_id
;
1194 hdr
->caplen
= epbp
->caplen
;
1195 hdr
->len
= epbp
->len
;
1196 t
= ((uint64_t)epbp
->timestamp_high
) << 32 |
1197 epbp
->timestamp_low
;
1203 * Get a pointer to the fixed-length portion of the
1206 spbp
= get_from_block_data(&cursor
, sizeof(*spbp
),
1209 return (-1); /* error */
1212 * SPB packets are assumed to have arrived on
1213 * the first interface.
1218 * Byte-swap it if necessary.
1221 /* these were written in opposite byte order */
1222 hdr
->len
= SWAPLONG(spbp
->len
);
1224 hdr
->len
= spbp
->len
;
1227 * The SPB doesn't give the captured length;
1228 * it's the minimum of the snapshot length
1229 * and the packet length.
1231 hdr
->caplen
= hdr
->len
;
1232 if (hdr
->caplen
> (bpf_u_int32
)p
->snapshot
)
1233 hdr
->caplen
= p
->snapshot
;
1234 t
= 0; /* no time stamps */
1239 * Get a pointer to the fixed-length portion of the
1242 pbp
= get_from_block_data(&cursor
, sizeof(*pbp
),
1245 return (-1); /* error */
1248 * Byte-swap it if necessary.
1251 /* these were written in opposite byte order */
1252 interface_id
= SWAPSHORT(pbp
->interface_id
);
1253 hdr
->caplen
= SWAPLONG(pbp
->caplen
);
1254 hdr
->len
= SWAPLONG(pbp
->len
);
1255 t
= ((uint64_t)SWAPLONG(pbp
->timestamp_high
)) << 32 |
1256 SWAPLONG(pbp
->timestamp_low
);
1258 interface_id
= pbp
->interface_id
;
1259 hdr
->caplen
= pbp
->caplen
;
1260 hdr
->len
= pbp
->len
;
1261 t
= ((uint64_t)pbp
->timestamp_high
) << 32 |
1268 * Interface Description Block. Get a pointer
1269 * to its fixed-length portion.
1271 idbp
= get_from_block_data(&cursor
, sizeof(*idbp
),
1274 return (-1); /* error */
1277 * Byte-swap it if necessary.
1280 idbp
->linktype
= SWAPSHORT(idbp
->linktype
);
1281 idbp
->snaplen
= SWAPLONG(idbp
->snaplen
);
1285 * If the link-layer type or snapshot length
1286 * differ from the ones for the first IDB we
1289 * XXX - just discard packets from those
1292 if (p
->linktype
!= idbp
->linktype
) {
1293 pcap_snprintf(p
->errbuf
, PCAP_ERRBUF_SIZE
,
1294 "an interface has a type %u different from the type of the first interface",
1298 if ((bpf_u_int32
)p
->snapshot
!= idbp
->snaplen
) {
1299 pcap_snprintf(p
->errbuf
, PCAP_ERRBUF_SIZE
,
1300 "an interface has a snapshot length %u different from the type of the first interface",
1306 * Try to add this interface.
1308 if (!add_interface(p
, &cursor
, p
->errbuf
))
1314 * Section Header Block. Get a pointer
1315 * to its fixed-length portion.
1317 shbp
= get_from_block_data(&cursor
, sizeof(*shbp
),
1320 return (-1); /* error */
1323 * Assume the byte order of this section is
1324 * the same as that of the previous section.
1325 * We'll check for that later.
1328 shbp
->byte_order_magic
=
1329 SWAPLONG(shbp
->byte_order_magic
);
1330 shbp
->major_version
=
1331 SWAPSHORT(shbp
->major_version
);
1335 * Make sure the byte order doesn't change;
1336 * pcap_is_swapped() shouldn't change its
1337 * return value in the middle of reading a capture.
1339 switch (shbp
->byte_order_magic
) {
1341 case BYTE_ORDER_MAGIC
:
1347 case SWAPLONG(BYTE_ORDER_MAGIC
):
1349 * Byte order changes.
1351 pcap_snprintf(p
->errbuf
, PCAP_ERRBUF_SIZE
,
1352 "the file has sections with different byte orders");
1359 pcap_snprintf(p
->errbuf
, PCAP_ERRBUF_SIZE
,
1360 "the file has a section with a bad byte order magic field");
1365 * Make sure the major version is the version
1368 if (shbp
->major_version
!= PCAP_NG_VERSION_MAJOR
) {
1369 pcap_snprintf(p
->errbuf
, PCAP_ERRBUF_SIZE
,
1370 "unknown pcapng savefile major version number %u",
1371 shbp
->major_version
);
1376 * Reset the interface count; this section should
1377 * have its own set of IDBs. If any of them
1378 * don't have the same interface type, snapshot
1379 * length, or resolution as the first interface
1380 * we saw, we'll fail. (And if we don't see
1381 * any IDBs, we'll fail when we see a packet
1389 * Not a packet block, IDB, or SHB; ignore it.
1397 * Is the interface ID an interface we know?
1399 if (interface_id
>= ps
->ifcount
) {
1403 pcap_snprintf(p
->errbuf
, PCAP_ERRBUF_SIZE
,
1404 "a packet arrived on interface %u, but there's no Interface Description Block for that interface",
1409 if (hdr
->caplen
> (bpf_u_int32
)p
->snapshot
) {
1410 pcap_snprintf(p
->errbuf
, PCAP_ERRBUF_SIZE
,
1411 "invalid packet capture length %u, bigger than "
1412 "snaplen of %d", hdr
->caplen
, p
->snapshot
);
1417 * Convert the time stamp to seconds and fractions of a second,
1418 * with the fractions being in units of the file-supplied resolution.
1420 sec
= t
/ ps
->ifaces
[interface_id
].tsresol
+ ps
->ifaces
[interface_id
].tsoffset
;
1421 frac
= t
% ps
->ifaces
[interface_id
].tsresol
;
1424 * Convert the fractions from units of the file-supplied resolution
1425 * to units of the user-requested resolution.
1427 switch (ps
->ifaces
[interface_id
].scale_type
) {
1431 * The interface resolution is what the user wants,
1438 * The interface resolution is less than what the user
1439 * wants; scale the fractional part up to the units of
1440 * the resolution the user requested by multiplying by
1441 * the quotient of the user-requested resolution and the
1442 * file-supplied resolution.
1444 * Those resolutions are both powers of 10, and the user-
1445 * requested resolution is greater than the file-supplied
1446 * resolution, so the quotient in question is an integer.
1447 * We've calculated that quotient already, so we just
1450 frac
*= ps
->ifaces
[interface_id
].scale_factor
;
1455 * The interface resolution is less than what the user
1456 * wants; scale the fractional part up to the units of
1457 * the resolution the user requested by multiplying by
1458 * the quotient of the user-requested resolution and the
1459 * file-supplied resolution.
1461 * The file-supplied resolution is a power of 2, so the
1462 * quotient is not an integer, so, in order to do this
1463 * entirely with integer arithmetic, we multiply by the
1464 * user-requested resolution and divide by the file-
1465 * supplied resolution.
1467 * XXX - Is there something clever we could do here,
1468 * given that we know that the file-supplied resolution
1469 * is a power of 2? Doing a multiplication followed by
1470 * a division runs the risk of overflowing, and involves
1471 * two non-simple arithmetic operations.
1473 frac
*= ps
->user_tsresol
;
1474 frac
/= ps
->ifaces
[interface_id
].tsresol
;
1477 case SCALE_DOWN_DEC
:
1479 * The interface resolution is greater than what the user
1480 * wants; scale the fractional part up to the units of
1481 * the resolution the user requested by multiplying by
1482 * the quotient of the user-requested resolution and the
1483 * file-supplied resolution.
1485 * Those resolutions are both powers of 10, and the user-
1486 * requested resolution is less than the file-supplied
1487 * resolution, so the quotient in question isn't an
1488 * integer, but its reciprocal is, and we can just divide
1489 * by the reciprocal of the quotient. We've calculated
1490 * the reciprocal of that quotient already, so we must
1493 frac
/= ps
->ifaces
[interface_id
].scale_factor
;
1497 case SCALE_DOWN_BIN
:
1499 * The interface resolution is greater than what the user
1500 * wants; convert the fractional part to units of the
1501 * resolution the user requested by multiplying by the
1502 * quotient of the user-requested resolution and the
1503 * file-supplied resolution. We do that by multiplying
1504 * by the user-requested resolution and dividing by the
1505 * file-supplied resolution, as the quotient might not
1506 * fit in an integer.
1508 * The file-supplied resolution is a power of 2, so the
1509 * quotient is not an integer, and neither is its
1510 * reciprocal, so, in order to do this entirely with
1511 * integer arithmetic, we multiply by the user-requested
1512 * resolution and divide by the file-supplied resolution.
1514 * XXX - Is there something clever we could do here,
1515 * given that we know that the file-supplied resolution
1516 * is a power of 2? Doing a multiplication followed by
1517 * a division runs the risk of overflowing, and involves
1518 * two non-simple arithmetic operations.
1520 frac
*= ps
->user_tsresol
;
1521 frac
/= ps
->ifaces
[interface_id
].tsresol
;
1526 * tv_sec and tv_used in the Windows struct timeval are both
1529 hdr
->ts
.tv_sec
= (long)sec
;
1530 hdr
->ts
.tv_usec
= (long)frac
;
1533 * tv_sec in the UN*X struct timeval is a time_t; tv_usec is
1534 * suseconds_t in UN*Xes that work the way the current Single
1535 * UNIX Standard specify - but not all older UN*Xes necessarily
1536 * support that type, so just cast to int.
1538 hdr
->ts
.tv_sec
= (time_t)sec
;
1539 hdr
->ts
.tv_usec
= (int)frac
;
1543 * Get a pointer to the packet data.
1545 *data
= get_from_block_data(&cursor
, hdr
->caplen
, p
->errbuf
);
1550 swap_pseudo_headers(p
->linktype
, hdr
, *data
);