xref: /freebsd/contrib/libpcap/pcap.h (revision 2546665afcaf0d53dc2c7058fee96354b3680f5a)
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  * $FreeBSD$
35  * @(#) $Header: /tcpdump/master/libpcap/pcap.h,v 1.45.2.4 2004/01/27 22:56:20 guy Exp $ (LBL)
36  */
37 
38 #ifndef lib_pcap_h
39 #define lib_pcap_h
40 
41 #include <sys/types.h>
42 #include <sys/time.h>
43 
44 #include <net/bpf.h>
45 
46 #include <stdio.h>
47 
48 #ifdef __cplusplus
49 extern "C" {
50 #endif
51 
52 #define PCAP_VERSION_MAJOR 2
53 #define PCAP_VERSION_MINOR 4
54 
55 #define PCAP_ERRBUF_SIZE 256
56 
57 /*
58  * Compatibility for systems that have a bpf.h that
59  * predates the bpf typedefs for 64-bit support.
60  */
61 #if BPF_RELEASE - 0 < 199406
62 typedef	int bpf_int32;
63 typedef	u_int bpf_u_int32;
64 #endif
65 
66 typedef struct pcap pcap_t;
67 typedef struct pcap_dumper pcap_dumper_t;
68 typedef struct pcap_if pcap_if_t;
69 typedef struct pcap_addr pcap_addr_t;
70 
71 /*
72  * The first record in the file contains saved values for some
73  * of the flags used in the printout phases of tcpdump.
74  * Many fields here are 32 bit ints so compilers won't insert unwanted
75  * padding; these files need to be interchangeable across architectures.
76  *
77  * Do not change the layout of this structure, in any way (this includes
78  * changes that only affect the length of fields in this structure).
79  *
80  * Also, do not change the interpretation of any of the members of this
81  * structure, in any way (this includes using values other than
82  * LINKTYPE_ values, as defined in "savefile.c", in the "linktype"
83  * field).
84  *
85  * Instead:
86  *
87  *	introduce a new structure for the new format, if the layout
88  *	of the structure changed;
89  *
90  *	send mail to "tcpdump-workers@tcpdump.org", requesting a new
91  *	magic number for your new capture file format, and, when
92  *	you get the new magic number, put it in "savefile.c";
93  *
94  *	use that magic number for save files with the changed file
95  *	header;
96  *
97  *	make the code in "savefile.c" capable of reading files with
98  *	the old file header as well as files with the new file header
99  *	(using the magic number to determine the header format).
100  *
101  * Then supply the changes to "patches@tcpdump.org", so that future
102  * versions of libpcap and programs that use it (such as tcpdump) will
103  * be able to read your new capture file format.
104  */
105 struct pcap_file_header {
106 	bpf_u_int32 magic;
107 	u_short version_major;
108 	u_short version_minor;
109 	bpf_int32 thiszone;	/* gmt to local correction */
110 	bpf_u_int32 sigfigs;	/* accuracy of timestamps */
111 	bpf_u_int32 snaplen;	/* max length saved portion of each pkt */
112 	bpf_u_int32 linktype;	/* data link type (LINKTYPE_*) */
113 };
114 
115 /*
116  * Each packet in the dump file is prepended with this generic header.
117  * This gets around the problem of different headers for different
118  * packet interfaces.
119  */
120 struct pcap_pkthdr {
121 	struct timeval ts;	/* time stamp */
122 	bpf_u_int32 caplen;	/* length of portion present */
123 	bpf_u_int32 len;	/* length this packet (off wire) */
124 };
125 
126 /*
127  * As returned by the pcap_stats()
128  */
129 struct pcap_stat {
130 	u_int ps_recv;		/* number of packets received */
131 	u_int ps_drop;		/* number of packets dropped */
132 	u_int ps_ifdrop;	/* drops by interface XXX not yet supported */
133 #ifdef WIN32
134 	u_int bs_capt;		/* number of packets that reach the application */
135 #endif /* WIN32 */
136 };
137 
138 /*
139  * Item in a list of interfaces.
140  */
141 struct pcap_if {
142 	struct pcap_if *next;
143 	char *name;		/* name to hand to "pcap_open_live()" */
144 	char *description;	/* textual description of interface, or NULL */
145 	struct pcap_addr *addresses;
146 	bpf_u_int32 flags;	/* PCAP_IF_ interface flags */
147 };
148 
149 #define PCAP_IF_LOOPBACK	0x00000001	/* interface is loopback */
150 
151 /*
152  * Representation of an interface address.
153  */
154 struct pcap_addr {
155 	struct pcap_addr *next;
156 	struct sockaddr *addr;		/* address */
157 	struct sockaddr *netmask;	/* netmask for that address */
158 	struct sockaddr *broadaddr;	/* broadcast address for that address */
159 	struct sockaddr *dstaddr;	/* P2P destination address for that address */
160 };
161 
162 typedef void (*pcap_handler)(u_char *, const struct pcap_pkthdr *,
163 			     const u_char *);
164 
165 char	*pcap_lookupdev(char *);
166 int	pcap_lookupnet(const char *, bpf_u_int32 *, bpf_u_int32 *, char *);
167 pcap_t	*pcap_open_live(const char *, int, int, int, char *);
168 pcap_t	*pcap_open_dead(int, int);
169 pcap_t	*pcap_open_offline(const char *, char *);
170 void	pcap_close(pcap_t *);
171 int	pcap_loop(pcap_t *, int, pcap_handler, u_char *);
172 int	pcap_dispatch(pcap_t *, int, pcap_handler, u_char *);
173 const u_char*
174 	pcap_next(pcap_t *, struct pcap_pkthdr *);
175 int 	pcap_next_ex(pcap_t *, struct pcap_pkthdr **, const u_char **);
176 void	pcap_breakloop(pcap_t *);
177 int	pcap_stats(pcap_t *, struct pcap_stat *);
178 int	pcap_setfilter(pcap_t *, struct bpf_program *);
179 int	pcap_getnonblock(pcap_t *, char *);
180 int	pcap_setnonblock(pcap_t *, int, char *);
181 void	pcap_perror(pcap_t *, char *);
182 char	*pcap_strerror(int);
183 char	*pcap_geterr(pcap_t *);
184 int	pcap_compile(pcap_t *, struct bpf_program *, char *, int,
185 	    bpf_u_int32);
186 int	pcap_compile_nopcap(int, int, struct bpf_program *,
187 	    char *, int, bpf_u_int32);
188 void	pcap_freecode(struct bpf_program *);
189 int	pcap_datalink(pcap_t *);
190 int	pcap_list_datalinks(pcap_t *, int **);
191 int	pcap_set_datalink(pcap_t *, int);
192 int	pcap_datalink_name_to_val(const char *);
193 const char *pcap_datalink_val_to_name(int);
194 const char *pcap_datalink_val_to_description(int);
195 int	pcap_snapshot(pcap_t *);
196 int	pcap_is_swapped(pcap_t *);
197 int	pcap_major_version(pcap_t *);
198 int	pcap_minor_version(pcap_t *);
199 
200 /* XXX */
201 FILE	*pcap_file(pcap_t *);
202 int	pcap_fileno(pcap_t *);
203 
204 pcap_dumper_t *pcap_dump_open(pcap_t *, const char *);
205 int	pcap_dump_flush(pcap_dumper_t *);
206 void	pcap_dump_close(pcap_dumper_t *);
207 void	pcap_dump(u_char *, const struct pcap_pkthdr *, const u_char *);
208 FILE	*pcap_dump_file(pcap_dumper_t *);
209 
210 int	pcap_findalldevs(pcap_if_t **, char *);
211 void	pcap_freealldevs(pcap_if_t *);
212 
213 const char *pcap_lib_version(void);
214 
215 /* XXX this guy lives in the bpf tree */
216 u_int	bpf_filter(struct bpf_insn *, u_char *, u_int, u_int);
217 int	bpf_validate(struct bpf_insn *f, int len);
218 char	*bpf_image(struct bpf_insn *, int);
219 void	bpf_dump(struct bpf_program *, int);
220 
221 #ifdef WIN32
222 /*
223  * Win32 definitions
224  */
225 
226 int pcap_setbuff(pcap_t *p, int dim);
227 int pcap_setmode(pcap_t *p, int mode);
228 int pcap_sendpacket(pcap_t *p, u_char *buf, int size);
229 int pcap_setmintocopy(pcap_t *p, int size);
230 
231 #ifdef WPCAP
232 /* Include file with the wpcap-specific extensions */
233 #include <Win32-Extensions.h>
234 #endif
235 
236 #define MODE_CAPT 0
237 #define MODE_STAT 1
238 #define MODE_MON 2
239 
240 #else
241 /*
242  * UN*X definitions
243  */
244 
245 int	pcap_get_selectable_fd(pcap_t *);
246 
247 #endif /* WIN32 */
248 
249 #ifdef __cplusplus
250 }
251 #endif
252 
253 #endif
254