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.5 2008-05-30 01:43:21 guy 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@lists.tcpdump.org", requesting
96 *	a new 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 by forking the branch at
107 *
108 *	https://github.com/the-tcpdump-group/libpcap/issues
109 *
110 * and issuing a pull request, so that future versions of libpcap and
111 * programs that use it (such as tcpdump) will be able to read your new
112 * capture file format.
113 */
114
115enum pcap1_info_types {
116        PCAP_DATACAPTURE,
117	PCAP_TIMESTAMP,
118	PCAP_WALLTIME,
119	PCAP_TIMESKEW,
120	PCAP_PROBEPLACE,              /* aka direction */
121	PCAP_COMMENT,                 /* comment */
122};
123
124struct pcap1_info_container {
125	bpf_u_int32 info_len;         /* in bytes */
126	bpf_u_int32 info_type;        /* enum pcap1_info_types */
127	unsigned char info_data[0];
128};
129
130struct pcap1_info_timestamp {
131	struct pcap1_info_container pic;
132	bpf_u_int32    nanoseconds;   /* 10^-9 of seconds */
133	bpf_u_int32    seconds;       /* seconds since Unix epoch - GMT */
134	bpf_u_int16    macroseconds;  /* 16 bits more of MSB of time */
135	bpf_u_int16    sigfigs;	      /* accuracy of timestamps - LSB bits */
136};
137
138struct pcap1_info_packet {
139	struct pcap1_info_container pic;
140	bpf_u_int32 caplen;	/* length of portion present */
141	bpf_u_int32 len;	/* length this packet (off wire) */
142	bpf_u_int32 linktype;	/* data link type (LINKTYPE_*) */
143	bpf_u_int32 ifIndex;	/* abstracted interface index */
144	unsigned char packet_data[0];
145};
146
147enum pcap1_probe {
148	INBOUND  =1,
149	OUTBOUND =2,
150	FORWARD  =3,
151	PREENCAP =4,
152	POSTDECAP=5,
153};
154
155struct pcap1_info_probe {
156	struct pcap1_info_container pic;
157	bpf_u_int32                 probeloc;   /* enum pcap1_probe */
158        unsigned char               probe_desc[0];
159};
160
161struct pcap1_info_comment {
162	struct pcap1_info_container pic;
163        unsigned char               comment[0];
164};
165
166struct pcap1_packet_header {
167	bpf_u_int32 magic;
168	u_short     version_major;
169	u_short     version_minor;
170        bpf_u_int32 block_len;
171	struct pcap1_info_container pics[0];
172};
173
174/*
175 * Each packet in the dump file is prepended with this generic header.
176 * This gets around the problem of different headers for different
177 * packet interfaces.
178 */
179
180/*
181 * As returned by the pcap_stats()
182 */
183struct pcap_stat {
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 XXX not yet supported */
187#ifdef WIN32
188	u_int bs_capt;		/* number of packets that reach the application */
189#endif /* WIN32 */
190};
191
192/*
193 * Item in a list of interfaces.
194 */
195struct pcap_if {
196	struct pcap_if *next;
197	char *name;		/* name to hand to "pcap_open_live()" */
198	char *description;	/* textual description of interface, or NULL */
199	struct pcap_addr *addresses;
200	bpf_u_int32 flags;	/* PCAP_IF_ interface flags */
201};
202
203#define PCAP_IF_LOOPBACK	0x00000001	/* interface is loopback */
204
205/*
206 * Representation of an interface address.
207 */
208struct pcap_addr {
209	struct pcap_addr *next;
210	struct sockaddr *addr;		/* address */
211	struct sockaddr *netmask;	/* netmask for that address */
212	struct sockaddr *broadaddr;	/* broadcast address for that address */
213	struct sockaddr *dstaddr;	/* P2P destination address for that address */
214};
215
216typedef void (*pcap_handler)(u_char *, const struct pcap_pkthdr *,
217			     const u_char *);
218
219char	*pcap_lookupdev(char *);
220int	pcap_lookupnet(const char *, bpf_u_int32 *, bpf_u_int32 *, char *);
221pcap_t	*pcap_open_live(const char *, int, int, int, char *);
222pcap_t	*pcap_open_dead(int, int);
223pcap_t	*pcap_open_offline(const char *, char *);
224void	pcap_close(pcap_t *);
225int	pcap_loop(pcap_t *, int, pcap_handler, u_char *);
226int	pcap_dispatch(pcap_t *, int, pcap_handler, u_char *);
227const u_char*
228	pcap_next(pcap_t *, struct pcap_pkthdr *);
229int 	pcap_next_ex(pcap_t *, struct pcap_pkthdr **, const u_char **);
230void	pcap_breakloop(pcap_t *);
231int	pcap_stats(pcap_t *, struct pcap_stat *);
232int	pcap_setfilter(pcap_t *, struct bpf_program *);
233int	pcap_getnonblock(pcap_t *, char *);
234int	pcap_setnonblock(pcap_t *, int, char *);
235void	pcap_perror(pcap_t *, char *);
236char	*pcap_strerror(int);
237char	*pcap_geterr(pcap_t *);
238int	pcap_compile(pcap_t *, struct bpf_program *, char *, int,
239	    bpf_u_int32);
240int	pcap_compile_nopcap(int, int, struct bpf_program *,
241	    char *, int, bpf_u_int32);
242void	pcap_freecode(struct bpf_program *);
243int	pcap_datalink(pcap_t *);
244int	pcap_list_datalinks(pcap_t *, int **);
245int	pcap_set_datalink(pcap_t *, int);
246int	pcap_datalink_name_to_val(const char *);
247const char *pcap_datalink_val_to_name(int);
248const char *pcap_datalink_val_to_description(int);
249int	pcap_snapshot(pcap_t *);
250int	pcap_is_swapped(pcap_t *);
251int	pcap_major_version(pcap_t *);
252int	pcap_minor_version(pcap_t *);
253
254/* XXX */
255FILE	*pcap_file(pcap_t *);
256int	pcap_fileno(pcap_t *);
257
258pcap_dumper_t *pcap_dump_open(pcap_t *, const char *);
259int	pcap_dump_flush(pcap_dumper_t *);
260void	pcap_dump_close(pcap_dumper_t *);
261void	pcap_dump(u_char *, const struct pcap_pkthdr *, const u_char *);
262FILE	*pcap_dump_file(pcap_dumper_t *);
263
264int	pcap_findalldevs(pcap_if_t **, char *);
265void	pcap_freealldevs(pcap_if_t *);
266
267const char *pcap_lib_version(void);
268
269/* XXX this guy lives in the bpf tree */
270u_int	bpf_filter(struct bpf_insn *, u_char *, u_int, u_int);
271int	bpf_validate(struct bpf_insn *f, int len);
272char	*bpf_image(struct bpf_insn *, int);
273void	bpf_dump(struct bpf_program *, int);
274
275#ifdef WIN32
276/*
277 * Win32 definitions
278 */
279
280int pcap_setbuff(pcap_t *p, int dim);
281int pcap_setmode(pcap_t *p, int mode);
282int pcap_sendpacket(pcap_t *p, u_char *buf, int size);
283int pcap_setmintocopy(pcap_t *p, int size);
284
285#ifdef WPCAP
286/* Include file with the wpcap-specific extensions */
287#include <Win32-Extensions.h>
288#endif
289
290#define MODE_CAPT 0
291#define MODE_STAT 1
292
293#else
294/*
295 * UN*X definitions
296 */
297
298int	pcap_get_selectable_fd(pcap_t *);
299
300#endif /* WIN32 */
301
302#ifdef __cplusplus
303}
304#endif
305
306#endif
307