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/pcap1.h,v 1.2 2004/03/30 14:42:50 mcr Exp $ (LBL)
35 */
36
37#ifndef lib_pcap_h
38#define lib_pcap_h
39
40#ifdef WIN32
41#include <pcap-stdinc.h>
42#else /* WIN32 */
43#include <sys/types.h>
44#include <sys/time.h>
45#endif /* WIN32 */
46
47#ifndef PCAP_DONT_INCLUDE_PCAP_BPF_H
48#include <pcap-bpf.h>
49#endif
50
51#include <stdio.h>
52
53#ifdef __cplusplus
54extern "C" {
55#endif
56
57#define PCAP_VERSION_MAJOR 3
58#define PCAP_VERSION_MINOR 0
59
60#define PCAP_ERRBUF_SIZE 256
61
62/*
63 * Compatibility for systems that have a bpf.h that
64 * predates the bpf typedefs for 64-bit support.
65 */
66#if BPF_RELEASE - 0 < 199406
67typedef	int bpf_int32;
68typedef	u_int bpf_u_int32;
69#endif
70
71typedef struct pcap pcap_t;
72typedef struct pcap_dumper pcap_dumper_t;
73typedef struct pcap_if pcap_if_t;
74typedef struct pcap_addr pcap_addr_t;
75
76/*
77 * The first record in the file contains saved values for some
78 * of the flags used in the printout phases of tcpdump.
79 * Many fields here are 32 bit ints so compilers won't insert unwanted
80 * padding; these files need to be interchangeable across architectures.
81 *
82 * Do not change the layout of this structure, in any way (this includes
83 * changes that only affect the length of fields in this structure).
84 *
85 * Also, do not change the interpretation of any of the members of this
86 * structure, in any way (this includes using values other than
87 * LINKTYPE_ values, as defined in "savefile.c", in the "linktype"
88 * field).
89 *
90 * Instead:
91 *
92 *	introduce a new structure for the new format, if the layout
93 *	of the structure changed;
94 *
95 *	send mail to "tcpdump-workers@tcpdump.org", requesting a new
96 *	magic number for your new capture file format, and, when
97 *	you get the new magic number, put it in "savefile.c";
98 *
99 *	use that magic number for save files with the changed file
100 *	header;
101 *
102 *	make the code in "savefile.c" capable of reading files with
103 *	the old file header as well as files with the new file header
104 *	(using the magic number to determine the header format).
105 *
106 * Then supply the changes to "patches@tcpdump.org", so that future
107 * versions of libpcap and programs that use it (such as tcpdump) will
108 * be able to read your new capture file format.
109 */
110
111enum pcap1_info_types {
112        PCAP_DATACAPTURE,
113	PCAP_TIMESTAMP,
114	PCAP_WALLTIME,
115	PCAP_TIMESKEW,
116	PCAP_PROBEPLACE,              /* aka direction */
117	PCAP_COMMENT,                 /* comment */
118};
119
120struct pcap1_info_container {
121	bpf_u_int32 info_len;         /* in bytes */
122	bpf_u_int32 info_type;        /* enum pcap1_info_types */
123	unsigned char info_data[0];
124};
125
126struct pcap1_info_timestamp {
127	struct pcap1_info_container pic;
128	bpf_u_int32    nanoseconds;   /* 10^-9 of seconds */
129	bpf_u_int32    seconds;       /* seconds since Unix epoch - GMT */
130	bpf_u_int16    macroseconds;  /* 16 bits more of MSB of time */
131	bpf_u_int16    sigfigs;	      /* accuracy of timestamps - LSB bits */
132};
133
134struct pcap1_info_packet {
135	struct pcap1_info_container pic;
136	bpf_u_int32 caplen;	/* length of portion present */
137	bpf_u_int32 len;	/* length this packet (off wire) */
138	bpf_u_int32 linktype;	/* data link type (LINKTYPE_*) */
139	bpf_u_int32 ifIndex;	/* abstracted interface index */
140	unsigned char packet_data[0];
141};
142
143enum pcap1_probe {
144	INBOUND  =1,
145	OUTBOUND =2,
146	FORWARD  =3,
147	PREENCAP =4,
148	POSTDECAP=5,
149};
150
151struct pcap1_info_probe {
152	struct pcap1_info_container pic;
153	bpf_u_int32                 probeloc;   /* enum pcap1_probe */
154        unsigned char               probe_desc[0];
155};
156
157struct pcap1_info_comment {
158	struct pcap1_info_container pic;
159        unsigned char               comment[0];
160};
161
162struct pcap1_packet_header {
163	bpf_u_int32 magic;
164	u_short     version_major;
165	u_short     version_minor;
166        bpf_u_int32 block_len;
167	struct pcap1_info_container pics[0];
168};
169
170/*
171 * Each packet in the dump file is prepended with this generic header.
172 * This gets around the problem of different headers for different
173 * packet interfaces.
174 */
175
176/*
177 * As returned by the pcap_stats()
178 */
179struct pcap_stat {
180	u_int ps_recv;		/* number of packets received */
181	u_int ps_drop;		/* number of packets dropped */
182	u_int ps_ifdrop;	/* drops by interface XXX not yet supported */
183#ifdef WIN32
184	u_int bs_capt;		/* number of packets that reach the application */
185#endif /* WIN32 */
186};
187
188/*
189 * Item in a list of interfaces.
190 */
191struct pcap_if {
192	struct pcap_if *next;
193	char *name;		/* name to hand to "pcap_open_live()" */
194	char *description;	/* textual description of interface, or NULL */
195	struct pcap_addr *addresses;
196	bpf_u_int32 flags;	/* PCAP_IF_ interface flags */
197};
198
199#define PCAP_IF_LOOPBACK	0x00000001	/* interface is loopback */
200
201/*
202 * Representation of an interface address.
203 */
204struct pcap_addr {
205	struct pcap_addr *next;
206	struct sockaddr *addr;		/* address */
207	struct sockaddr *netmask;	/* netmask for that address */
208	struct sockaddr *broadaddr;	/* broadcast address for that address */
209	struct sockaddr *dstaddr;	/* P2P destination address for that address */
210};
211
212typedef void (*pcap_handler)(u_char *, const struct pcap_pkthdr *,
213			     const u_char *);
214
215char	*pcap_lookupdev(char *);
216int	pcap_lookupnet(const char *, bpf_u_int32 *, bpf_u_int32 *, char *);
217pcap_t	*pcap_open_live(const char *, int, int, int, char *);
218pcap_t	*pcap_open_dead(int, int);
219pcap_t	*pcap_open_offline(const char *, char *);
220void	pcap_close(pcap_t *);
221int	pcap_loop(pcap_t *, int, pcap_handler, u_char *);
222int	pcap_dispatch(pcap_t *, int, pcap_handler, u_char *);
223const u_char*
224	pcap_next(pcap_t *, struct pcap_pkthdr *);
225int 	pcap_next_ex(pcap_t *, struct pcap_pkthdr **, const u_char **);
226void	pcap_breakloop(pcap_t *);
227int	pcap_stats(pcap_t *, struct pcap_stat *);
228int	pcap_setfilter(pcap_t *, struct bpf_program *);
229int	pcap_getnonblock(pcap_t *, char *);
230int	pcap_setnonblock(pcap_t *, int, char *);
231void	pcap_perror(pcap_t *, char *);
232char	*pcap_strerror(int);
233char	*pcap_geterr(pcap_t *);
234int	pcap_compile(pcap_t *, struct bpf_program *, char *, int,
235	    bpf_u_int32);
236int	pcap_compile_nopcap(int, int, struct bpf_program *,
237	    char *, int, bpf_u_int32);
238void	pcap_freecode(struct bpf_program *);
239int	pcap_datalink(pcap_t *);
240int	pcap_list_datalinks(pcap_t *, int **);
241int	pcap_set_datalink(pcap_t *, int);
242int	pcap_datalink_name_to_val(const char *);
243const char *pcap_datalink_val_to_name(int);
244const char *pcap_datalink_val_to_description(int);
245int	pcap_snapshot(pcap_t *);
246int	pcap_is_swapped(pcap_t *);
247int	pcap_major_version(pcap_t *);
248int	pcap_minor_version(pcap_t *);
249
250/* XXX */
251FILE	*pcap_file(pcap_t *);
252int	pcap_fileno(pcap_t *);
253
254pcap_dumper_t *pcap_dump_open(pcap_t *, const char *);
255int	pcap_dump_flush(pcap_dumper_t *);
256void	pcap_dump_close(pcap_dumper_t *);
257void	pcap_dump(u_char *, const struct pcap_pkthdr *, const u_char *);
258FILE	*pcap_dump_file(pcap_dumper_t *);
259
260int	pcap_findalldevs(pcap_if_t **, char *);
261void	pcap_freealldevs(pcap_if_t *);
262
263const char *pcap_lib_version(void);
264
265/* XXX this guy lives in the bpf tree */
266u_int	bpf_filter(struct bpf_insn *, u_char *, u_int, u_int);
267int	bpf_validate(struct bpf_insn *f, int len);
268char	*bpf_image(struct bpf_insn *, int);
269void	bpf_dump(struct bpf_program *, int);
270
271#ifdef WIN32
272/*
273 * Win32 definitions
274 */
275
276int pcap_setbuff(pcap_t *p, int dim);
277int pcap_setmode(pcap_t *p, int mode);
278int pcap_sendpacket(pcap_t *p, u_char *buf, int size);
279int pcap_setmintocopy(pcap_t *p, int size);
280
281#ifdef WPCAP
282/* Include file with the wpcap-specific extensions */
283#include <Win32-Extensions.h>
284#endif
285
286#define MODE_CAPT 0
287#define MODE_STAT 1
288
289#else
290/*
291 * UN*X definitions
292 */
293
294int	pcap_get_selectable_fd(pcap_t *);
295
296#endif /* WIN32 */
297
298#ifdef __cplusplus
299}
300#endif
301
302#endif
303