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 */
50 #ifndef PCAP_DONT_INCLUDE_PCAP_BPF_H
57 // We have to define the SOCKET here, although it has been defined in sockutils.h
58 // This is to avoid the distribution of the 'sockutils.h' file around
59 // (for example in the WinPcap developer's pack)
62 #define SOCKET unsigned int
74 * Version number of the current version of the pcap file format.
76 * NOTE: this is *NOT* the version number of the libpcap library.
77 * To fetch the version information for the version of libpcap
78 * you're using, use pcap_lib_version().
80 #define PCAP_VERSION_MAJOR 2
81 #define PCAP_VERSION_MINOR 4
83 #define PCAP_ERRBUF_SIZE 256
86 * Compatibility for systems that have a bpf.h that
87 * predates the bpf typedefs for 64-bit support.
89 #if BPF_RELEASE - 0 < 199406
90 typedef int bpf_int32
;
91 typedef u_int bpf_u_int32
;
94 typedef struct pcap pcap_t
;
95 typedef struct pcap_dumper pcap_dumper_t
;
96 typedef struct pcap_if pcap_if_t
;
97 typedef struct pcap_addr pcap_addr_t
;
100 * The first record in the file contains saved values for some
101 * of the flags used in the printout phases of tcpdump.
102 * Many fields here are 32 bit ints so compilers won't insert unwanted
103 * padding; these files need to be interchangeable across architectures.
105 * Do not change the layout of this structure, in any way (this includes
106 * changes that only affect the length of fields in this structure).
108 * Also, do not change the interpretation of any of the members of this
109 * structure, in any way (this includes using values other than
110 * LINKTYPE_ values, as defined in "savefile.c", in the "linktype"
115 * introduce a new structure for the new format, if the layout
116 * of the structure changed;
118 * send mail to "tcpdump-workers@lists.tcpdump.org", requesting
119 * a new magic number for your new capture file format, and, when
120 * you get the new magic number, put it in "savefile.c";
122 * use that magic number for save files with the changed file
125 * make the code in "savefile.c" capable of reading files with
126 * the old file header as well as files with the new file header
127 * (using the magic number to determine the header format).
129 * Then supply the changes as a patch at
131 * http://sourceforge.net/projects/libpcap/
133 * so that future versions of libpcap and programs that use it (such as
134 * tcpdump) will be able to read your new capture file format.
136 struct pcap_file_header
{
138 u_short version_major
;
139 u_short version_minor
;
140 bpf_int32 thiszone
; /* gmt to local correction */
141 bpf_u_int32 sigfigs
; /* accuracy of timestamps */
142 bpf_u_int32 snaplen
; /* max length saved portion of each pkt */
143 bpf_u_int32 linktype
; /* data link type (LINKTYPE_*) */
147 * Macros for the value returned by pcap_datalink_ext().
149 * If LT_FCS_LENGTH_PRESENT(x) is true, the LT_FCS_LENGTH(x) macro
150 * gives the FCS length of packets in the capture.
152 #define LT_FCS_LENGTH_PRESENT(x) ((x) & 0x04000000)
153 #define LT_FCS_LENGTH(x) (((x) & 0xF0000000) >> 28)
154 #define LT_FCS_DATALINK_EXT(x) ((((x) & 0xF) << 28) | 0x04000000)
163 * Generic per-packet information, as supplied by libpcap.
165 * The time stamp can and should be a "struct timeval", regardless of
166 * whether your system supports 32-bit tv_sec in "struct timeval",
167 * 64-bit tv_sec in "struct timeval", or both if it supports both 32-bit
168 * and 64-bit applications. The on-disk format of savefiles uses 32-bit
169 * tv_sec (and tv_usec); this structure is irrelevant to that. 32-bit
170 * and 64-bit versions of libpcap, even if they're on the same platform,
171 * should supply the appropriate version of "struct timeval", even if
172 * that's not what the underlying packet capture mechanism supplies.
175 struct timeval ts
; /* time stamp */
176 bpf_u_int32 caplen
; /* length of portion present */
177 bpf_u_int32 len
; /* length this packet (off wire) */
181 * As returned by the pcap_stats()
184 u_int ps_recv
; /* number of packets received */
185 u_int ps_drop
; /* number of packets dropped */
186 u_int ps_ifdrop
; /* drops by interface -- only supported on some platforms */
188 u_int bs_capt
; /* number of packets that reach the application */
194 * As returned by the pcap_stats_ex()
196 struct pcap_stat_ex
{
197 u_long rx_packets
; /* total packets received */
198 u_long tx_packets
; /* total packets transmitted */
199 u_long rx_bytes
; /* total bytes received */
200 u_long tx_bytes
; /* total bytes transmitted */
201 u_long rx_errors
; /* bad packets received */
202 u_long tx_errors
; /* packet transmit problems */
203 u_long rx_dropped
; /* no space in Rx buffers */
204 u_long tx_dropped
; /* no space available for Tx */
205 u_long multicast
; /* multicast packets received */
208 /* detailed rx_errors: */
209 u_long rx_length_errors
;
210 u_long rx_over_errors
; /* receiver ring buff overflow */
211 u_long rx_crc_errors
; /* recv'd pkt with crc error */
212 u_long rx_frame_errors
; /* recv'd frame alignment error */
213 u_long rx_fifo_errors
; /* recv'r fifo overrun */
214 u_long rx_missed_errors
; /* recv'r missed packet */
216 /* detailed tx_errors */
217 u_long tx_aborted_errors
;
218 u_long tx_carrier_errors
;
219 u_long tx_fifo_errors
;
220 u_long tx_heartbeat_errors
;
221 u_long tx_window_errors
;
226 * Item in a list of interfaces.
229 struct pcap_if
*next
;
230 char *name
; /* name to hand to "pcap_open_live()" */
231 char *description
; /* textual description of interface, or NULL */
232 struct pcap_addr
*addresses
;
233 bpf_u_int32 flags
; /* PCAP_IF_ interface flags */
236 #define PCAP_IF_LOOPBACK 0x00000001 /* interface is loopback */
239 * Representation of an interface address.
242 struct pcap_addr
*next
;
243 struct sockaddr
*addr
; /* address */
244 struct sockaddr
*netmask
; /* netmask for that address */
245 struct sockaddr
*broadaddr
; /* broadcast address for that address */
246 struct sockaddr
*dstaddr
; /* P2P destination address for that address */
249 typedef void (*pcap_handler
)(u_char
*, const struct pcap_pkthdr
*,
253 * Error codes for the pcap API.
254 * These will all be negative, so you can check for the success or
255 * failure of a call that returns these codes by checking for a
258 #define PCAP_ERROR -1 /* generic error code */
259 #define PCAP_ERROR_BREAK -2 /* loop terminated by pcap_breakloop */
260 #define PCAP_ERROR_NOT_ACTIVATED -3 /* the capture needs to be activated */
261 #define PCAP_ERROR_ACTIVATED -4 /* the operation can't be performed on already activated captures */
262 #define PCAP_ERROR_NO_SUCH_DEVICE -5 /* no such device exists */
263 #define PCAP_ERROR_RFMON_NOTSUP -6 /* this device doesn't support rfmon (monitor) mode */
264 #define PCAP_ERROR_NOT_RFMON -7 /* operation supported only in monitor mode */
265 #define PCAP_ERROR_PERM_DENIED -8 /* no permission to open the device */
266 #define PCAP_ERROR_IFACE_NOT_UP -9 /* interface isn't up */
267 #define PCAP_ERROR_CANTSET_TSTAMP_TYPE -10 /* this device doesn't support setting the time stamp type */
268 #define PCAP_ERROR_PROMISC_PERM_DENIED -11 /* you don't have permission to capture in promiscuous mode */
271 * Warning codes for the pcap API.
272 * These will all be positive and non-zero, so they won't look like
275 #define PCAP_WARNING 1 /* generic warning code */
276 #define PCAP_WARNING_PROMISC_NOTSUP 2 /* this device doesn't support promiscuous mode */
277 #define PCAP_WARNING_TSTAMP_TYPE_NOTSUP 3 /* the requested time stamp type is not supported */
280 * Value to pass to pcap_compile() as the netmask if you don't know what
283 #define PCAP_NETMASK_UNKNOWN 0xffffffff
285 char *pcap_lookupdev(char *);
286 int pcap_lookupnet(const char *, bpf_u_int32
*, bpf_u_int32
*, char *);
288 pcap_t
*pcap_create(const char *, char *);
289 int pcap_set_snaplen(pcap_t
*, int);
290 int pcap_set_promisc(pcap_t
*, int);
291 int pcap_can_set_rfmon(pcap_t
*);
292 int pcap_set_rfmon(pcap_t
*, int);
293 int pcap_set_timeout(pcap_t
*, int);
294 int pcap_set_tstamp_type(pcap_t
*, int);
295 int pcap_set_buffer_size(pcap_t
*, int);
296 int pcap_activate(pcap_t
*);
298 int pcap_list_tstamp_types(pcap_t
*, int **);
299 void pcap_free_tstamp_types(int *);
300 int pcap_tstamp_type_name_to_val(const char *);
301 const char *pcap_tstamp_type_val_to_name(int);
302 const char *pcap_tstamp_type_val_to_description(int);
306 * Not all systems and interfaces will necessarily support all of these.
308 * A system that supports PCAP_TSTAMP_HOST is offering time stamps
309 * provided by the host machine, rather than by the capture device,
310 * but not committing to any characteristics of the time stamp;
311 * it will not offer any of the PCAP_TSTAMP_HOST_ subtypes.
313 * PCAP_TSTAMP_HOST_LOWPREC is a time stamp, provided by the host machine,
314 * that's low-precision but relatively cheap to fetch; it's normally done
315 * using the system clock, so it's normally synchronized with times you'd
316 * fetch from system calls.
318 * PCAP_TSTAMP_HOST_HIPREC is a time stamp, provided by the host machine,
319 * that's high-precision; it might be more expensive to fetch. It might
320 * or might not be synchronized with the system clock, and might have
321 * problems with time stamps for packets received on different CPUs,
322 * depending on the platform.
324 * PCAP_TSTAMP_ADAPTER is a high-precision time stamp supplied by the
325 * capture device; it's synchronized with the system clock.
327 * PCAP_TSTAMP_ADAPTER_UNSYNCED is a high-precision time stamp supplied by
328 * the capture device; it's not synchronized with the system clock.
330 * Note that time stamps synchronized with the system clock can go
331 * backwards, as the system clock can go backwards. If a clock is
332 * not in sync with the system clock, that could be because the
333 * system clock isn't keeping accurate time, because the other
334 * clock isn't keeping accurate time, or both.
336 * Note that host-provided time stamps generally correspond to the
337 * time when the time-stamping code sees the packet; this could
338 * be some unknown amount of time after the first or last bit of
339 * the packet is received by the network adapter, due to batching
340 * of interrupts for packet arrival, queueing delays, etc..
342 #define PCAP_TSTAMP_HOST 0 /* host-provided, unknown characteristics */
343 #define PCAP_TSTAMP_HOST_LOWPREC 1 /* host-provided, low precision */
344 #define PCAP_TSTAMP_HOST_HIPREC 2 /* host-provided, high precision */
345 #define PCAP_TSTAMP_ADAPTER 3 /* device-provided, synced with the system clock */
346 #define PCAP_TSTAMP_ADAPTER_UNSYNCED 4 /* device-provided, not synced with the system clock */
348 pcap_t
*pcap_open_live(const char *, int, int, int, char *);
349 pcap_t
*pcap_open_dead(int, int);
350 pcap_t
*pcap_open_offline(const char *, char *);
352 pcap_t
*pcap_hopen_offline(intptr_t, char *);
353 #if !defined(LIBPCAP_EXPORTS)
354 #define pcap_fopen_offline(f,b) \
355 pcap_hopen_offline(_get_osfhandle(_fileno(f)), b)
356 #else /*LIBPCAP_EXPORTS*/
357 static pcap_t
*pcap_fopen_offline(FILE *, char *);
360 pcap_t
*pcap_fopen_offline(FILE *, char *);
363 void pcap_close(pcap_t
*);
364 int pcap_loop(pcap_t
*, int, pcap_handler
, u_char
*);
365 int pcap_dispatch(pcap_t
*, int, pcap_handler
, u_char
*);
367 pcap_next(pcap_t
*, struct pcap_pkthdr
*);
368 int pcap_next_ex(pcap_t
*, struct pcap_pkthdr
**, const u_char
**);
369 void pcap_breakloop(pcap_t
*);
370 int pcap_stats(pcap_t
*, struct pcap_stat
*);
371 int pcap_setfilter(pcap_t
*, struct bpf_program
*);
372 int pcap_setdirection(pcap_t
*, pcap_direction_t
);
373 int pcap_getnonblock(pcap_t
*, char *);
374 int pcap_setnonblock(pcap_t
*, int, char *);
375 int pcap_inject(pcap_t
*, const void *, size_t);
376 int pcap_sendpacket(pcap_t
*, const u_char
*, int);
377 const char *pcap_statustostr(int);
378 const char *pcap_strerror(int);
379 char *pcap_geterr(pcap_t
*);
380 void pcap_perror(pcap_t
*, char *);
381 int pcap_compile(pcap_t
*, struct bpf_program
*, const char *, int,
383 int pcap_compile_nopcap(int, int, struct bpf_program
*,
384 const char *, int, bpf_u_int32
);
385 void pcap_freecode(struct bpf_program
*);
386 int pcap_offline_filter(struct bpf_program
*, const struct pcap_pkthdr
*,
388 int pcap_datalink(pcap_t
*);
389 int pcap_datalink_ext(pcap_t
*);
390 int pcap_list_datalinks(pcap_t
*, int **);
391 int pcap_set_datalink(pcap_t
*, int);
392 void pcap_free_datalinks(int *);
393 int pcap_datalink_name_to_val(const char *);
394 const char *pcap_datalink_val_to_name(int);
395 const char *pcap_datalink_val_to_description(int);
396 int pcap_snapshot(pcap_t
*);
397 int pcap_is_swapped(pcap_t
*);
398 int pcap_major_version(pcap_t
*);
399 int pcap_minor_version(pcap_t
*);
402 FILE *pcap_file(pcap_t
*);
403 int pcap_fileno(pcap_t
*);
405 pcap_dumper_t
*pcap_dump_open(pcap_t
*, const char *);
406 pcap_dumper_t
*pcap_dump_fopen(pcap_t
*, FILE *fp
);
407 FILE *pcap_dump_file(pcap_dumper_t
*);
408 long pcap_dump_ftell(pcap_dumper_t
*);
409 int pcap_dump_flush(pcap_dumper_t
*);
410 void pcap_dump_close(pcap_dumper_t
*);
411 void pcap_dump(u_char
*, const struct pcap_pkthdr
*, const u_char
*);
413 int pcap_findalldevs(pcap_if_t
**, char *);
414 void pcap_freealldevs(pcap_if_t
*);
416 const char *pcap_lib_version(void);
419 * On at least some versions of NetBSD, we don't want to declare
420 * bpf_filter() here, as it's also be declared in <net/bpf.h>, with a
421 * different signature, but, on other BSD-flavored UN*Xes, it's not
422 * declared in <net/bpf.h>, so we *do* want to declare it here, so it's
423 * declared when we build pcap-bpf.c.
426 u_int
bpf_filter(const struct bpf_insn
*, const u_char
*, u_int
, u_int
);
428 int bpf_validate(const struct bpf_insn
*f
, int len
);
429 char *bpf_image(const struct bpf_insn
*, int);
430 void bpf_dump(const struct bpf_program
*, int);
438 int pcap_setbuff(pcap_t
*p
, int dim
);
439 int pcap_setmode(pcap_t
*p
, int mode
);
440 int pcap_setmintocopy(pcap_t
*p
, int size
);
443 /* Include file with the wpcap-specific extensions */
444 #include <Win32-Extensions.h>
457 int pcap_stats_ex (pcap_t
*, struct pcap_stat_ex
*);
458 void pcap_set_wait (pcap_t
*p
, void (*yield
)(void), int wait
);
459 u_long
pcap_mac_packets (void);
467 int pcap_get_selectable_fd(pcap_t
*);
469 #endif /* WIN32/MSDOS/UN*X */
472 /* Includes most of the public stuff that is needed for the remote capture */
473 #include <remote-ext.h>
474 #endif /* HAVE_REMOTE */
480 #endif /* lib_pcap_pcap_h */