1 /* -*- Mode: c; tab-width: 8; indent-tabs-mode: 1; c-basic-offset: 8; -*- */
3 * Copyright (c) 1993, 1994, 1995, 1996, 1997
4 * The Regents of the University of California. All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 3. All advertising materials mentioning features or use of this software
15 * must display the following acknowledgement:
16 * This product includes software developed by the Computer Systems
17 * Engineering Group at Lawrence Berkeley Laboratory.
18 * 4. Neither the name of the University nor of the Laboratory may be used
19 * to endorse or promote products derived from this software without
20 * specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34 * @(#) $Header: /tcpdump/master/libpcap/pcap/pcap.h,v 1.15 2008-10-06 15:27:32 gianluca Exp $ (LBL)
37 #ifndef lib_pcap_pcap_h
38 #define lib_pcap_pcap_h
41 #include <pcap-stdinc.h>
43 #include <sys/types.h>
44 #include <sys/socket.h> /* u_int, u_char etc. */
46 #include <sys/types.h>
48 #endif /* WIN32/MSDOS/UN*X */
59 * Version number of the current version of the pcap file format.
61 * NOTE: this is *NOT* the version number of the libpcap library.
62 * To fetch the version information for the version of libpcap
63 * you're using, use pcap_lib_version().
65 #define PCAP_VERSION_MAJOR 2
66 #define PCAP_VERSION_MINOR 4
68 #define PCAP_ERRBUF_SIZE 256
71 * Compatibility for systems that have a bpf.h that
72 * predates the bpf typedefs for 64-bit support.
74 #if BPF_RELEASE - 0 < 199406
75 typedef int bpf_int32;
76 typedef u_int bpf_u_int32;
79 typedef struct pcap pcap_t;
80 typedef struct pcap_dumper pcap_dumper_t;
81 typedef struct pcap_if pcap_if_t;
82 typedef struct pcap_addr pcap_addr_t;
85 * The first record in the file contains saved values for some
86 * of the flags used in the printout phases of tcpdump.
87 * Many fields here are 32 bit ints so compilers won't insert unwanted
88 * padding; these files need to be interchangeable across architectures.
90 * Do not change the layout of this structure, in any way (this includes
91 * changes that only affect the length of fields in this structure).
93 * Also, do not change the interpretation of any of the members of this
94 * structure, in any way (this includes using values other than
95 * LINKTYPE_ values, as defined in "savefile.c", in the "linktype"
100 * introduce a new structure for the new format, if the layout
101 * of the structure changed;
103 * send mail to "tcpdump-workers@lists.tcpdump.org", requesting
104 * a new magic number for your new capture file format, and, when
105 * you get the new magic number, put it in "savefile.c";
107 * use that magic number for save files with the changed file
110 * make the code in "savefile.c" capable of reading files with
111 * the old file header as well as files with the new file header
112 * (using the magic number to determine the header format).
114 * Then supply the changes as a patch at
116 * http://sourceforge.net/projects/libpcap/
118 * so that future versions of libpcap and programs that use it (such as
119 * tcpdump) will be able to read your new capture file format.
121 struct pcap_file_header {
123 u_short version_major;
124 u_short version_minor;
125 bpf_int32 thiszone; /* gmt to local correction */
126 bpf_u_int32 sigfigs; /* accuracy of timestamps */
127 bpf_u_int32 snaplen; /* max length saved portion of each pkt */
128 bpf_u_int32 linktype; /* data link type (LINKTYPE_*) */
132 * Macros for the value returned by pcap_datalink_ext().
134 * If LT_FCS_LENGTH_PRESENT(x) is true, the LT_FCS_LENGTH(x) macro
135 * gives the FCS length of packets in the capture.
137 #define LT_FCS_LENGTH_PRESENT(x) ((x) & 0x04000000)
138 #define LT_FCS_LENGTH(x) (((x) & 0xF0000000) >> 28)
139 #define LT_FCS_DATALINK_EXT(x) ((((x) & 0xF) << 28) | 0x04000000)
148 * Generic per-packet information, as supplied by libpcap.
150 * The time stamp can and should be a "struct timeval", regardless of
151 * whether your system supports 32-bit tv_sec in "struct timeval",
152 * 64-bit tv_sec in "struct timeval", or both if it supports both 32-bit
153 * and 64-bit applications. The on-disk format of savefiles uses 32-bit
154 * tv_sec (and tv_usec); this structure is irrelevant to that. 32-bit
155 * and 64-bit versions of libpcap, even if they're on the same platform,
156 * should supply the appropriate version of "struct timeval", even if
157 * that's not what the underlying packet capture mechanism supplies.
160 struct timeval ts; /* time stamp */
161 bpf_u_int32 caplen; /* length of portion present */
162 bpf_u_int32 len; /* length this packet (off wire) */
166 * As returned by the pcap_stats()
169 u_int ps_recv; /* number of packets received */
170 u_int ps_drop; /* number of packets dropped */
171 u_int ps_ifdrop; /* drops by interface -- only supported on some platforms */
173 u_int bs_capt; /* number of packets that reach the application */
179 * As returned by the pcap_stats_ex()
181 struct pcap_stat_ex {
182 u_long rx_packets; /* total packets received */
183 u_long tx_packets; /* total packets transmitted */
184 u_long rx_bytes; /* total bytes received */
185 u_long tx_bytes; /* total bytes transmitted */
186 u_long rx_errors; /* bad packets received */
187 u_long tx_errors; /* packet transmit problems */
188 u_long rx_dropped; /* no space in Rx buffers */
189 u_long tx_dropped; /* no space available for Tx */
190 u_long multicast; /* multicast packets received */
193 /* detailed rx_errors: */
194 u_long rx_length_errors;
195 u_long rx_over_errors; /* receiver ring buff overflow */
196 u_long rx_crc_errors; /* recv'd pkt with crc error */
197 u_long rx_frame_errors; /* recv'd frame alignment error */
198 u_long rx_fifo_errors; /* recv'r fifo overrun */
199 u_long rx_missed_errors; /* recv'r missed packet */
201 /* detailed tx_errors */
202 u_long tx_aborted_errors;
203 u_long tx_carrier_errors;
204 u_long tx_fifo_errors;
205 u_long tx_heartbeat_errors;
206 u_long tx_window_errors;
211 * Item in a list of interfaces.
214 struct pcap_if *next;
215 char *name; /* name to hand to "pcap_open_live()" */
216 char *description; /* textual description of interface, or NULL */
217 struct pcap_addr *addresses;
218 bpf_u_int32 flags; /* PCAP_IF_ interface flags */
221 #define PCAP_IF_LOOPBACK 0x00000001 /* interface is loopback */
224 * Representation of an interface address.
227 struct pcap_addr *next;
228 struct sockaddr *addr; /* address */
229 struct sockaddr *netmask; /* netmask for that address */
230 struct sockaddr *broadaddr; /* broadcast address for that address */
231 struct sockaddr *dstaddr; /* P2P destination address for that address */
234 typedef void (*pcap_handler)(u_char *, const struct pcap_pkthdr *,
238 * Error codes for the pcap API.
239 * These will all be negative, so you can check for the success or
240 * failure of a call that returns these codes by checking for a
243 #define PCAP_ERROR -1 /* generic error code */
244 #define PCAP_ERROR_BREAK -2 /* loop terminated by pcap_breakloop */
245 #define PCAP_ERROR_NOT_ACTIVATED -3 /* the capture needs to be activated */
246 #define PCAP_ERROR_ACTIVATED -4 /* the operation can't be performed on already activated captures */
247 #define PCAP_ERROR_NO_SUCH_DEVICE -5 /* no such device exists */
248 #define PCAP_ERROR_RFMON_NOTSUP -6 /* this device doesn't support rfmon (monitor) mode */
249 #define PCAP_ERROR_NOT_RFMON -7 /* operation supported only in monitor mode */
250 #define PCAP_ERROR_PERM_DENIED -8 /* no permission to open the device */
251 #define PCAP_ERROR_IFACE_NOT_UP -9 /* interface isn't up */
254 * Warning codes for the pcap API.
255 * These will all be positive and non-zero, so they won't look like
258 #define PCAP_WARNING 1 /* generic warning code */
259 #define PCAP_WARNING_PROMISC_NOTSUP 2 /* this device doesn't support promiscuous mode */
262 * Value to pass to pcap_compile() as the netmask if you don't know what
265 #define PCAP_NETMASK_UNKNOWN 0xffffffff
267 char *pcap_lookupdev(char *);
268 int pcap_lookupnet(const char *, bpf_u_int32 *, bpf_u_int32 *, char *);
270 pcap_t *pcap_create(const char *, char *);
271 int pcap_set_snaplen(pcap_t *, int);
272 int pcap_set_promisc(pcap_t *, int);
273 int pcap_can_set_rfmon(pcap_t *);
274 int pcap_set_rfmon(pcap_t *, int);
275 int pcap_set_timeout(pcap_t *, int);
276 int pcap_set_buffer_size(pcap_t *, int);
277 int pcap_activate(pcap_t *);
279 pcap_t *pcap_open_live(const char *, int, int, int, char *);
280 pcap_t *pcap_open_dead(int, int);
281 pcap_t *pcap_open_offline(const char *, char *);
283 pcap_t *pcap_hopen_offline(intptr_t, char *);
284 #if !defined(LIBPCAP_EXPORTS)
285 #define pcap_fopen_offline(f,b) \
286 pcap_hopen_offline(_get_osfhandle(_fileno(f)), b)
287 #else /*LIBPCAP_EXPORTS*/
288 static pcap_t *pcap_fopen_offline(FILE *, char *);
291 pcap_t *pcap_fopen_offline(FILE *, char *);
294 void pcap_close(pcap_t *);
295 int pcap_loop(pcap_t *, int, pcap_handler, u_char *);
296 int pcap_dispatch(pcap_t *, int, pcap_handler, u_char *);
298 pcap_next(pcap_t *, struct pcap_pkthdr *);
299 int pcap_next_ex(pcap_t *, struct pcap_pkthdr **, const u_char **);
300 void pcap_breakloop(pcap_t *);
301 int pcap_stats(pcap_t *, struct pcap_stat *);
302 int pcap_setfilter(pcap_t *, struct bpf_program *);
303 int pcap_setdirection(pcap_t *, pcap_direction_t);
304 int pcap_getnonblock(pcap_t *, char *);
305 int pcap_setnonblock(pcap_t *, int, char *);
306 int pcap_inject(pcap_t *, const void *, size_t);
307 int pcap_sendpacket(pcap_t *, const u_char *, int);
308 const char *pcap_statustostr(int);
309 const char *pcap_strerror(int);
310 char *pcap_geterr(pcap_t *);
311 void pcap_perror(pcap_t *, char *);
312 int pcap_compile(pcap_t *, struct bpf_program *, const char *, int,
314 int pcap_compile_nopcap(int, int, struct bpf_program *,
315 const char *, int, bpf_u_int32);
316 void pcap_freecode(struct bpf_program *);
317 int pcap_offline_filter(struct bpf_program *, const struct pcap_pkthdr *,
319 int pcap_datalink(pcap_t *);
320 int pcap_datalink_ext(pcap_t *);
321 int pcap_list_datalinks(pcap_t *, int **);
322 int pcap_set_datalink(pcap_t *, int);
323 void pcap_free_datalinks(int *);
324 int pcap_datalink_name_to_val(const char *);
325 const char *pcap_datalink_val_to_name(int);
326 const char *pcap_datalink_val_to_description(int);
327 int pcap_snapshot(pcap_t *);
328 int pcap_is_swapped(pcap_t *);
329 int pcap_major_version(pcap_t *);
330 int pcap_minor_version(pcap_t *);
333 FILE *pcap_file(pcap_t *);
334 int pcap_fileno(pcap_t *);
336 pcap_dumper_t *pcap_dump_open(pcap_t *, const char *);
337 pcap_dumper_t *pcap_dump_fopen(pcap_t *, FILE *fp);
338 FILE *pcap_dump_file(pcap_dumper_t *);
339 long pcap_dump_ftell(pcap_dumper_t *);
340 int pcap_dump_flush(pcap_dumper_t *);
341 void pcap_dump_close(pcap_dumper_t *);
342 void pcap_dump(u_char *, const struct pcap_pkthdr *, const u_char *);
344 int pcap_findalldevs(pcap_if_t **, char *);
345 void pcap_freealldevs(pcap_if_t *);
347 const char *pcap_lib_version(void);
349 /* XXX this guy lives in the bpf tree */
350 u_int bpf_filter(struct bpf_insn *, u_char *, u_int, u_int);
351 int bpf_validate(const struct bpf_insn *f, int len);
352 char *bpf_image(struct bpf_insn *, int);
353 void bpf_dump(struct bpf_program *, int);
361 int pcap_setbuff(pcap_t *p, int dim);
362 int pcap_setmode(pcap_t *p, int mode);
363 int pcap_setmintocopy(pcap_t *p, int size);
366 /* Include file with the wpcap-specific extensions */
367 #include <Win32-Extensions.h>
380 int pcap_stats_ex (pcap_t *, struct pcap_stat_ex *);
381 void pcap_set_wait (pcap_t *p, void (*yield)(void), int wait);
382 u_long pcap_mac_packets (void);
390 int pcap_get_selectable_fd(pcap_t *);
392 #endif /* WIN32/MSDOS/UN*X */