Merge branch 'vendor/LIBPCAP'
[dragonfly.git] / contrib / libpcap / pcap.h
1 /* -*- Mode: c; tab-width: 8; indent-tabs-mode: 1; c-basic-offset: 8; -*- */
2 /*
3  * Copyright (c) 1993, 1994, 1995, 1996, 1997
4  *      The Regents of the University of California.  All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
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.
21  *
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
32  * SUCH DAMAGE.
33  *
34  * @(#) $Header: /tcpdump/master/libpcap/pcap.h,v 1.52.2.7 2007/06/11 09:52:05 guy Exp $ (LBL)
35  */
36
37 #ifndef lib_pcap_h
38 #define lib_pcap_h
39
40 #if defined(WIN32)
41   #include <pcap-stdinc.h>
42 #elif defined(MSDOS)
43   #include <sys/types.h>
44   #include <sys/socket.h>  /* u_int, u_char etc. */
45 #else /* UN*X */
46   #include <sys/types.h>
47   #include <sys/time.h>
48 #endif /* WIN32/MSDOS/UN*X */
49
50 #include <net/bpf.h>
51
52 #include <stdio.h>
53
54 #ifdef __cplusplus
55 extern "C" {
56 #endif
57
58 #define PCAP_VERSION_MAJOR 2
59 #define PCAP_VERSION_MINOR 4
60
61 #define PCAP_ERRBUF_SIZE 256
62
63 /*
64  * Compatibility for systems that have a bpf.h that
65  * predates the bpf typedefs for 64-bit support.
66  */
67 #if BPF_RELEASE - 0 < 199406
68 typedef int bpf_int32;
69 typedef u_int bpf_u_int32;
70 #endif
71
72 typedef struct pcap pcap_t;
73 typedef struct pcap_dumper pcap_dumper_t;
74 typedef struct pcap_if pcap_if_t;
75 typedef struct pcap_addr pcap_addr_t;
76
77 /*
78  * The first record in the file contains saved values for some
79  * of the flags used in the printout phases of tcpdump.
80  * Many fields here are 32 bit ints so compilers won't insert unwanted
81  * padding; these files need to be interchangeable across architectures.
82  *
83  * Do not change the layout of this structure, in any way (this includes
84  * changes that only affect the length of fields in this structure).
85  *
86  * Also, do not change the interpretation of any of the members of this
87  * structure, in any way (this includes using values other than
88  * LINKTYPE_ values, as defined in "savefile.c", in the "linktype"
89  * field).
90  *
91  * Instead:
92  *
93  *      introduce a new structure for the new format, if the layout
94  *      of the structure changed;
95  *
96  *      send mail to "tcpdump-workers@tcpdump.org", requesting a new
97  *      magic number for your new capture file format, and, when
98  *      you get the new magic number, put it in "savefile.c";
99  *
100  *      use that magic number for save files with the changed file
101  *      header;
102  *
103  *      make the code in "savefile.c" capable of reading files with
104  *      the old file header as well as files with the new file header
105  *      (using the magic number to determine the header format).
106  *
107  * Then supply the changes to "patches@tcpdump.org", so that future
108  * versions of libpcap and programs that use it (such as tcpdump) will
109  * be able to read your new capture file format.
110  */
111 struct pcap_file_header {
112         bpf_u_int32 magic;
113         u_short version_major;
114         u_short version_minor;
115         bpf_int32 thiszone;     /* gmt to local correction */
116         bpf_u_int32 sigfigs;    /* accuracy of timestamps */
117         bpf_u_int32 snaplen;    /* max length saved portion of each pkt */
118         bpf_u_int32 linktype;   /* data link type (LINKTYPE_*) */
119 };
120
121 typedef enum {
122        PCAP_D_INOUT = 0,
123        PCAP_D_IN,
124        PCAP_D_OUT
125 } pcap_direction_t;
126
127 /*
128  * Generic per-packet information, as supplied by libpcap.
129  *
130  * The time stamp can and should be a "struct timeval", regardless of
131  * whether your system supports 32-bit tv_sec in "struct timeval",
132  * 64-bit tv_sec in "struct timeval", or both if it supports both 32-bit
133  * and 64-bit applications.  The on-disk format of savefiles uses 32-bit
134  * tv_sec (and tv_usec); this structure is irrelevant to that.  32-bit
135  * and 64-bit versions of libpcap, even if they're on the same platform,
136  * should supply the appropriate version of "struct timeval", even if
137  * that's not what the underlying packet capture mechanism supplies.
138  */
139 struct pcap_pkthdr {
140         struct timeval ts;      /* time stamp */
141         bpf_u_int32 caplen;     /* length of portion present */
142         bpf_u_int32 len;        /* length this packet (off wire) */
143 };
144
145 /*
146  * As returned by the pcap_stats()
147  */
148 struct pcap_stat {
149         u_int ps_recv;          /* number of packets received */
150         u_int ps_drop;          /* number of packets dropped */
151         u_int ps_ifdrop;        /* drops by interface XXX not yet supported */
152 #ifdef WIN32
153         u_int bs_capt;          /* number of packets that reach the application */
154 #endif /* WIN32 */
155 };
156
157 #ifdef MSDOS
158 /*
159  * As returned by the pcap_stats_ex()
160  */
161 struct pcap_stat_ex {
162        u_long  rx_packets;        /* total packets received       */
163        u_long  tx_packets;        /* total packets transmitted    */
164        u_long  rx_bytes;          /* total bytes received         */
165        u_long  tx_bytes;          /* total bytes transmitted      */
166        u_long  rx_errors;         /* bad packets received         */
167        u_long  tx_errors;         /* packet transmit problems     */
168        u_long  rx_dropped;        /* no space in Rx buffers       */
169        u_long  tx_dropped;        /* no space available for Tx    */
170        u_long  multicast;         /* multicast packets received   */
171        u_long  collisions;
172
173        /* detailed rx_errors: */
174        u_long  rx_length_errors;
175        u_long  rx_over_errors;    /* receiver ring buff overflow  */
176        u_long  rx_crc_errors;     /* recv'd pkt with crc error    */
177        u_long  rx_frame_errors;   /* recv'd frame alignment error */
178        u_long  rx_fifo_errors;    /* recv'r fifo overrun          */
179        u_long  rx_missed_errors;  /* recv'r missed packet         */
180
181        /* detailed tx_errors */
182        u_long  tx_aborted_errors;
183        u_long  tx_carrier_errors;
184        u_long  tx_fifo_errors;
185        u_long  tx_heartbeat_errors;
186        u_long  tx_window_errors;
187      };
188 #endif
189
190 /*
191  * Item in a list of interfaces.
192  */
193 struct pcap_if {
194         struct pcap_if *next;
195         char *name;             /* name to hand to "pcap_open_live()" */
196         char *description;      /* textual description of interface, or NULL */
197         struct pcap_addr *addresses;
198         bpf_u_int32 flags;      /* PCAP_IF_ interface flags */
199 };
200
201 #define PCAP_IF_LOOPBACK        0x00000001      /* interface is loopback */
202
203 /*
204  * Representation of an interface address.
205  */
206 struct pcap_addr {
207         struct pcap_addr *next;
208         struct sockaddr *addr;          /* address */
209         struct sockaddr *netmask;       /* netmask for that address */
210         struct sockaddr *broadaddr;     /* broadcast address for that address */
211         struct sockaddr *dstaddr;       /* P2P destination address for that address */
212 };
213
214 typedef void (*pcap_handler)(u_char *, const struct pcap_pkthdr *,
215                              const u_char *);
216
217 char    *pcap_lookupdev(char *);
218 int     pcap_lookupnet(const char *, bpf_u_int32 *, bpf_u_int32 *, char *);
219 pcap_t  *pcap_open_live(const char *, int, int, int, char *);
220 pcap_t  *pcap_open_dead(int, int);
221 pcap_t  *pcap_open_offline(const char *, char *);
222 pcap_t  *pcap_fopen_offline(FILE *, char *);
223 void    pcap_close(pcap_t *);
224 int     pcap_loop(pcap_t *, int, pcap_handler, u_char *);
225 int     pcap_dispatch(pcap_t *, int, pcap_handler, u_char *);
226 const u_char*
227         pcap_next(pcap_t *, struct pcap_pkthdr *);
228 int     pcap_next_ex(pcap_t *, struct pcap_pkthdr **, const u_char **);
229 void    pcap_breakloop(pcap_t *);
230 int     pcap_stats(pcap_t *, struct pcap_stat *);
231 int     pcap_setfilter(pcap_t *, struct bpf_program *);
232 int     pcap_setdirection(pcap_t *, pcap_direction_t);
233 int     pcap_getnonblock(pcap_t *, char *);
234 int     pcap_setnonblock(pcap_t *, int, char *);
235 void    pcap_perror(pcap_t *, char *);
236 int     pcap_inject(pcap_t *, const void *, size_t);
237 int     pcap_sendpacket(pcap_t *, const u_char *, int);
238 const char *pcap_strerror(int);
239 char    *pcap_geterr(pcap_t *);
240 int     pcap_compile(pcap_t *, struct bpf_program *, const char *, int,
241             bpf_u_int32);
242 int     pcap_compile_nopcap(int, int, struct bpf_program *,
243             const char *, int, bpf_u_int32);
244 void    pcap_freecode(struct bpf_program *);
245 int     pcap_datalink(pcap_t *);
246 int     pcap_list_datalinks(pcap_t *, int **);
247 int     pcap_set_datalink(pcap_t *, int);
248 int     pcap_datalink_name_to_val(const char *);
249 const char *pcap_datalink_val_to_name(int);
250 const char *pcap_datalink_val_to_description(int);
251 int     pcap_snapshot(pcap_t *);
252 int     pcap_is_swapped(pcap_t *);
253 int     pcap_major_version(pcap_t *);
254 int     pcap_minor_version(pcap_t *);
255
256 /* XXX */
257 FILE    *pcap_file(pcap_t *);
258 int     pcap_fileno(pcap_t *);
259
260 pcap_dumper_t *pcap_dump_open(pcap_t *, const char *);
261 pcap_dumper_t *pcap_dump_fopen(pcap_t *, FILE *fp);
262 FILE    *pcap_dump_file(pcap_dumper_t *);
263 long    pcap_dump_ftell(pcap_dumper_t *);
264 int     pcap_dump_flush(pcap_dumper_t *);
265 void    pcap_dump_close(pcap_dumper_t *);
266 void    pcap_dump(u_char *, const struct pcap_pkthdr *, const u_char *);
267
268 int     pcap_findalldevs(pcap_if_t **, char *);
269 void    pcap_freealldevs(pcap_if_t *);
270
271 const char *pcap_lib_version(void);
272
273 /* XXX this guy lives in the bpf tree */
274 u_int   bpf_filter(struct bpf_insn *, u_char *, u_int, u_int);
275 int     bpf_validate(struct bpf_insn *f, int len);
276 char    *bpf_image(struct bpf_insn *, int);
277 void    bpf_dump(struct bpf_program *, int);
278
279 #if defined(WIN32)
280
281 /*
282  * Win32 definitions
283  */
284
285 int pcap_setbuff(pcap_t *p, int dim);
286 int pcap_setmode(pcap_t *p, int mode);
287 int pcap_setmintocopy(pcap_t *p, int size);
288
289 #ifdef WPCAP
290 /* Include file with the wpcap-specific extensions */
291 #include <Win32-Extensions.h>
292 #endif /* WPCAP */
293
294 #define MODE_CAPT 0
295 #define MODE_STAT 1
296 #define MODE_MON 2
297
298 #elif defined(MSDOS)
299
300 /*
301  * MS-DOS definitions
302  */
303
304 int  pcap_stats_ex (pcap_t *, struct pcap_stat_ex *);
305 void pcap_set_wait (pcap_t *p, void (*yield)(void), int wait);
306 u_long pcap_mac_packets (void);
307
308 #else /* UN*X */
309
310 /*
311  * UN*X definitions
312  */
313
314 int     pcap_get_selectable_fd(pcap_t *);
315
316 #endif /* WIN32/MSDOS/UN*X */
317
318 #ifdef __cplusplus
319 }
320 #endif
321
322 #endif