2 * Copyright (c) 1994, 1995, 1996
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 the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. All advertising materials mentioning features or use of this software
14 * must display the following acknowledgement:
15 * This product includes software developed by the Computer Systems
16 * Engineering Group at Lawrence Berkeley Laboratory.
17 * 4. Neither the name of the University nor of the Laboratory may be used
18 * to endorse or promote products derived from this software without
19 * specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * @(#) $Header: /tcpdump/master/libpcap/pcap-int.h,v 1.85.2.9 2008-09-16 00:21:08 guy Exp $ (LBL)
40 #include <pcap/pcap.h>
59 #if (defined(_MSC_VER) && (_MSC_VER <= 1200)) /* we are compiling with Visual Studio 6, that doesn't support the LL suffix*/
62 * Swap byte ordering of unsigned long long timestamp on a big endian
65 #define SWAPLL(ull) ((ull & 0xff00000000000000) >> 56) | \
66 ((ull & 0x00ff000000000000) >> 40) | \
67 ((ull & 0x0000ff0000000000) >> 24) | \
68 ((ull & 0x000000ff00000000) >> 8) | \
69 ((ull & 0x00000000ff000000) << 8) | \
70 ((ull & 0x0000000000ff0000) << 24) | \
71 ((ull & 0x000000000000ff00) << 40) | \
72 ((ull & 0x00000000000000ff) << 56)
74 #else /* A recent Visual studio compiler or not VC */
77 * Swap byte ordering of unsigned long long timestamp on a big endian
80 #define SWAPLL(ull) ((ull & 0xff00000000000000LL) >> 56) | \
81 ((ull & 0x00ff000000000000LL) >> 40) | \
82 ((ull & 0x0000ff0000000000LL) >> 24) | \
83 ((ull & 0x000000ff00000000LL) >> 8) | \
84 ((ull & 0x00000000ff000000LL) << 8) | \
85 ((ull & 0x0000000000ff0000LL) << 24) | \
86 ((ull & 0x000000000000ff00LL) << 40) | \
87 ((ull & 0x00000000000000ffLL) << 56)
101 * Used when reading a savefile.
107 swapped_type_t lengths_swapped;
114 * Used when doing a live capture.
117 struct pcap_stat stat;
119 int use_bpf; /* using kernel filter */
120 u_long TotPkts; /* can't oflow for 79 hrs on ether */
121 u_long TotAccepted; /* count accepted by filter */
122 u_long TotDrops; /* count of dropped packets */
123 long TotMissed; /* missed by i/f during this run */
124 long OrigMissed; /* missed by i/f before this run */
125 char *device; /* device name */
126 int timeout; /* timeout for buffering */
127 int must_clear; /* stuff we must clear when we close */
128 struct pcap *next; /* list of open pcaps that need stuff cleared on close */
130 int sock_packet; /* using Linux 2.0 compatible interface */
131 int cooked; /* using SOCK_DGRAM rather than SOCK_RAW */
132 int ifindex; /* interface index of device we're bound to */
133 int lo_ifindex; /* interface index of the loopback device */
134 u_int packets_read; /* count of packets read with recvfrom() */
135 bpf_u_int32 oldmode; /* mode to restore when turning monitor mode off */
136 u_int tp_version; /* version of tpacket_hdr for mmaped ring */
137 u_int tp_hdrlen; /* hdrlen of tpacket_hdr for mmaped ring */
141 #ifdef HAVE_DAG_STREAMS_API
142 u_char *dag_mem_bottom; /* DAG card current memory bottom pointer */
143 u_char *dag_mem_top; /* DAG card current memory top pointer */
144 #else /* HAVE_DAG_STREAMS_API */
145 void *dag_mem_base; /* DAG card memory base address */
146 u_int dag_mem_bottom; /* DAG card current memory bottom offset */
147 u_int dag_mem_top; /* DAG card current memory top offset */
148 #endif /* HAVE_DAG_STREAMS_API */
149 int dag_fcs_bits; /* Number of checksum bits from link layer */
150 int dag_offset_flags; /* Flags to pass to dag_offset(). */
151 int dag_stream; /* DAG stream number */
152 int dag_timeout; /* timeout specified to pcap_open_live.
153 * Same as in linux above, introduce
155 #endif /* HAVE_DAG_API */
156 #ifdef HAVE_ZEROCOPY_BPF
158 * Zero-copy read buffer -- for zero-copy BPF. 'buffer' above will
159 * alternative between these two actual mmap'd buffers as required.
160 * As there is a header on the front size of the mmap'd buffer, only
161 * some of the buffer is exposed to libpcap as a whole via bufsize;
162 * zbufsize is the true size. zbuffer tracks the current zbuf
163 * assocated with buffer so that it can be used to decide which the
164 * next buffer to read will be.
166 u_char *zbuf1, *zbuf2, *zbuffer;
170 struct timespec firstsel;
172 * If there's currently a buffer being actively processed, then it is
173 * referenced here; 'buffer' is also pointed at it, but offset by the
174 * size of the header.
176 struct bpf_zbuf_header *bzh;
177 #endif /* HAVE_ZEROCOPY_BPF */
181 * Stuff to clear when we close.
183 #define MUST_CLEAR_PROMISC 0x00000001 /* promiscuous mode */
184 #define MUST_CLEAR_RFMON 0x00000002 /* rfmon (monitor) mode */
194 * Ultrix, DEC OSF/1^H^H^H^H^H^H^H^H^HDigital UNIX^H^H^H^H^H^H^H^H^H^H^H^H
195 * Tru64 UNIX, and some versions of NetBSD pad FDDI packets to make everything
196 * line up on a nice boundary.
199 #include <sys/param.h> /* needed to declare __NetBSD_Version__ */
202 #if defined(ultrix) || defined(__osf__) || (defined(__NetBSD__) && __NetBSD_Version__ > 106000000)
203 #define PCAP_FDDIPAD 3
206 typedef int (*activate_op_t)(pcap_t *);
207 typedef int (*can_set_rfmon_op_t)(pcap_t *);
208 typedef int (*read_op_t)(pcap_t *, int cnt, pcap_handler, u_char *);
209 typedef int (*inject_op_t)(pcap_t *, const void *, size_t);
210 typedef int (*setfilter_op_t)(pcap_t *, struct bpf_program *);
211 typedef int (*setdirection_op_t)(pcap_t *, pcap_direction_t);
212 typedef int (*set_datalink_op_t)(pcap_t *, int);
213 typedef int (*getnonblock_op_t)(pcap_t *, char *);
214 typedef int (*setnonblock_op_t)(pcap_t *, int, char *);
215 typedef int (*stats_op_t)(pcap_t *, struct pcap_stat *);
217 typedef int (*setbuff_op_t)(pcap_t *, int);
218 typedef int (*setmode_op_t)(pcap_t *, int);
219 typedef int (*setmintocopy_op_t)(pcap_t *, int);
221 typedef void (*cleanup_op_t)(pcap_t *);
235 dlpi_handle_t dlpi_hd;
238 int linktype; /* Network linktype */
239 int linktype_ext; /* Extended information stored in the linktype field of a file */
240 int tzoff; /* timezone offset */
241 int offset; /* offset for proper alignment */
242 int activated; /* true if the capture is really started */
243 int oldstyle; /* if we're opening with pcap_open_live() */
245 int break_loop; /* flag set to force break from packet-reading loop */
252 void (*wait_proc)(void); /* call proc while waiting */
260 * Read buffer -- for file descriptor read buffer model.
269 * Zero-copy read buffer -- for zero-copy BPF. 'buffer' above will
270 * alternative between these two actual mmap'd buffers as required.
271 * As there is a header on the front size of the mmap'd buffer, only
272 * some of the buffer is exposed to libpcap as a whole via bufsize;
273 * zbufsize is the true size. zbuffer tracks the current zbuf
274 * assocated with buffer so that it can be used to decide which the
275 * next buffer to read will be.
277 u_char *zbuf1, *zbuf2, *zbuffer;
282 struct timespec firstsel;
285 * If there's currently a buffer being actively processed, then it is
286 * referenced here; 'buffer' is also pointed at it, but offset by the
287 * size of the header.
289 struct bpf_zbuf_header *bzh;
292 * Place holder for pcap_next().
296 /* We're accepting only packets in this direction/these directions. */
297 pcap_direction_t direction;
302 activate_op_t activate_op;
303 can_set_rfmon_op_t can_set_rfmon_op;
305 inject_op_t inject_op;
306 setfilter_op_t setfilter_op;
307 setdirection_op_t setdirection_op;
308 set_datalink_op_t set_datalink_op;
309 getnonblock_op_t getnonblock_op;
310 setnonblock_op_t setnonblock_op;
315 * These are, at least currently, specific to the Win32 NPF
318 setbuff_op_t setbuff_op;
319 setmode_op_t setmode_op;
320 setmintocopy_op_t setmintocopy_op;
322 cleanup_op_t cleanup_op;
325 * Placeholder for filter code if bpf not in kernel.
327 struct bpf_program fcode;
329 char errbuf[PCAP_ERRBUF_SIZE + 1];
333 struct pcap_pkthdr pcap_header; /* This is needed for the pcap_next_ex() to work */
337 * This is a timeval as stored in a savefile.
338 * It has to use the same types everywhere, independent of the actual
339 * `struct timeval'; `struct timeval' has 32-bit tv_sec values on some
340 * platforms and 64-bit tv_sec values on other platforms, and writing
341 * out native `struct timeval' values would mean files could only be
342 * read on systems with the same tv_sec size as the system on which
343 * the file was written.
346 struct pcap_timeval {
347 bpf_int32 tv_sec; /* seconds */
348 bpf_int32 tv_usec; /* microseconds */
352 * This is a `pcap_pkthdr' as actually stored in a savefile.
354 * Do not change the format of this structure, in any way (this includes
355 * changes that only affect the length of fields in this structure),
356 * and do not make the time stamp anything other than seconds and
357 * microseconds (e.g., seconds and nanoseconds). Instead:
359 * introduce a new structure for the new format;
361 * send mail to "tcpdump-workers@lists.tcpdump.org", requesting
362 * a new magic number for your new capture file format, and, when
363 * you get the new magic number, put it in "savefile.c";
365 * use that magic number for save files with the changed record
368 * make the code in "savefile.c" capable of reading files with
369 * the old record header as well as files with the new record header
370 * (using the magic number to determine the header format).
372 * Then supply the changes as a patch at
374 * http://sourceforge.net/projects/libpcap/
376 * so that future versions of libpcap and programs that use it (such as
377 * tcpdump) will be able to read your new capture file format.
380 struct pcap_sf_pkthdr {
381 struct pcap_timeval ts; /* time stamp */
382 bpf_u_int32 caplen; /* length of portion present */
383 bpf_u_int32 len; /* length this packet (off wire) */
387 * How a `pcap_pkthdr' is actually stored in savefiles written
388 * by some patched versions of libpcap (e.g. the ones in Red
389 * Hat Linux 6.1 and 6.2).
391 * Do not change the format of this structure, in any way (this includes
392 * changes that only affect the length of fields in this structure).
393 * Instead, introduce a new structure, as per the above.
396 struct pcap_sf_patched_pkthdr {
397 struct pcap_timeval ts; /* time stamp */
398 bpf_u_int32 caplen; /* length of portion present */
399 bpf_u_int32 len; /* length this packet (off wire) */
401 unsigned short protocol;
402 unsigned char pkt_type;
408 #define min(a, b) ((a) > (b) ? (b) : (a))
411 /* XXX should these be in pcap.h? */
412 int pcap_offline_read(pcap_t *, int, pcap_handler, u_char *);
413 int pcap_read(pcap_t *, int cnt, pcap_handler, u_char *);
416 #define strlcpy(x, y, z) \
417 (strncpy((x), (y), (z)), \
418 ((z) <= 0 ? 0 : ((x)[(z) - 1] = '\0')), \
425 * Routines that most pcap implementations can use for non-blocking mode.
427 #if !defined(WIN32) && !defined(MSDOS)
428 int pcap_getnonblock_fd(pcap_t *, char *);
429 int pcap_setnonblock_fd(pcap_t *p, int, char *);
432 pcap_t *pcap_create_common(const char *, char *);
433 int pcap_do_addexit(pcap_t *);
434 void pcap_add_to_pcaps_to_close(pcap_t *);
435 void pcap_remove_from_pcaps_to_close(pcap_t *);
436 void pcap_cleanup_live_common(pcap_t *);
437 int pcap_not_initialized(pcap_t *);
438 int pcap_check_activated(pcap_t *);
441 * Internal interfaces for "pcap_findalldevs()".
443 * "pcap_platform_finddevs()" is a platform-dependent routine to
444 * add devices not found by the "standard" mechanisms (SIOCGIFCONF,
445 * "getifaddrs()", etc..
447 * "pcap_add_if()" adds an interface to the list of interfaces.
449 int pcap_platform_finddevs(pcap_if_t **, char *);
450 int add_addr_to_iflist(pcap_if_t **, const char *, u_int, struct sockaddr *,
451 size_t, struct sockaddr *, size_t, struct sockaddr *, size_t,
452 struct sockaddr *, size_t, char *);
453 int pcap_add_if(pcap_if_t **, const char *, u_int, const char *, char *);
454 struct sockaddr *dup_sockaddr(struct sockaddr *, size_t);
455 int add_or_find_if(pcap_if_t **, pcap_if_t **, const char *, u_int,
456 const char *, char *);
459 char *pcap_win32strerror(void);
462 int install_bpf_program(pcap_t *, struct bpf_program *);
464 int pcap_strcasecmp(const char *, const char *);