xref: /freebsd/contrib/libpcap/pcap.h (revision d74e86d9e30043893d6b308468008b65640ddcae)
1 /*
2  * Copyright (c) 1993, 1994, 1995, 1996, 1997
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *	This product includes software developed by the Computer Systems
16  *	Engineering Group at Lawrence Berkeley Laboratory.
17  * 4. Neither the name of the University nor of the Laboratory may be used
18  *    to endorse or promote products derived from this software without
19  *    specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31  * SUCH DAMAGE.
32  *
33  * @(#) $Header: pcap.h,v 1.21 97/10/15 21:59:13 leres Exp $ (LBL)
34  */
35 
36 #ifndef lib_pcap_h
37 #define lib_pcap_h
38 
39 #include <sys/types.h>
40 #include <sys/time.h>
41 
42 #include <net/bpf.h>
43 
44 #include <stdio.h>
45 
46 #ifdef __cplusplus
47 extern "C" {
48 #endif
49 
50 
51 #define PCAP_VERSION_MAJOR 2
52 #define PCAP_VERSION_MINOR 4
53 
54 #define PCAP_ERRBUF_SIZE 256
55 
56 /*
57  * Compatibility for systems that have a bpf.h that
58  * predates the bpf typedefs for 64-bit support.
59  */
60 #if BPF_RELEASE - 0 < 199406
61 typedef	int bpf_int32;
62 typedef	u_int bpf_u_int32;
63 #endif
64 
65 typedef struct pcap pcap_t;
66 typedef struct pcap_dumper pcap_dumper_t;
67 
68 /*
69  * The first record in the file contains saved values for some
70  * of the flags used in the printout phases of tcpdump.
71  * Many fields here are 32 bit ints so compilers won't insert unwanted
72  * padding; these files need to be interchangeable across architectures.
73  */
74 struct pcap_file_header {
75 	bpf_u_int32 magic;
76 	u_short version_major;
77 	u_short version_minor;
78 	bpf_int32 thiszone;	/* gmt to local correction */
79 	bpf_u_int32 sigfigs;	/* accuracy of timestamps */
80 	bpf_u_int32 snaplen;	/* max length saved portion of each pkt */
81 	bpf_u_int32 linktype;	/* data link type (DLT_*) */
82 };
83 
84 /*
85  * Each packet in the dump file is prepended with this generic header.
86  * This gets around the problem of different headers for different
87  * packet interfaces.
88  */
89 struct pcap_pkthdr {
90 	struct timeval ts;	/* time stamp */
91 	bpf_u_int32 caplen;	/* length of portion present */
92 	bpf_u_int32 len;	/* length this packet (off wire) */
93 };
94 
95 /*
96  * As returned by the pcap_stats()
97  */
98 struct pcap_stat {
99 	u_int ps_recv;		/* number of packets received */
100 	u_int ps_drop;		/* number of packets dropped */
101 	u_int ps_ifdrop;	/* drops by interface XXX not yet supported */
102 };
103 
104 typedef void (*pcap_handler)(u_char *, const struct pcap_pkthdr *,
105 			     const u_char *);
106 
107 char	*pcap_lookupdev(char *);
108 int	pcap_lookupnet(char *, bpf_u_int32 *, bpf_u_int32 *, char *);
109 pcap_t	*pcap_open_live(char *, int, int, int, char *);
110 pcap_t	*pcap_open_offline(const char *, char *);
111 void	pcap_close(pcap_t *);
112 int	pcap_loop(pcap_t *, int, pcap_handler, u_char *);
113 int	pcap_dispatch(pcap_t *, int, pcap_handler, u_char *);
114 const u_char*
115 	pcap_next(pcap_t *, struct pcap_pkthdr *);
116 int	pcap_stats(pcap_t *, struct pcap_stat *);
117 int	pcap_setfilter(pcap_t *, struct bpf_program *);
118 void	pcap_perror(pcap_t *, char *);
119 char	*pcap_strerror(int);
120 char	*pcap_geterr(pcap_t *);
121 int	pcap_compile(pcap_t *, struct bpf_program *, char *, int,
122 	    bpf_u_int32);
123 /* XXX */
124 int	pcap_freecode(pcap_t *, struct bpf_program *);
125 int	pcap_datalink(pcap_t *);
126 int	pcap_snapshot(pcap_t *);
127 int	pcap_is_swapped(pcap_t *);
128 int	pcap_major_version(pcap_t *);
129 int	pcap_minor_version(pcap_t *);
130 
131 /* XXX */
132 FILE	*pcap_file(pcap_t *);
133 int	pcap_fileno(pcap_t *);
134 
135 pcap_dumper_t *pcap_dump_open(pcap_t *, const char *);
136 void	pcap_dump_close(pcap_dumper_t *);
137 void	pcap_dump(u_char *, const struct pcap_pkthdr *, const u_char *);
138 
139 /* XXX this guy lives in the bpf tree */
140 u_int	bpf_filter(struct bpf_insn *, u_char *, u_int, u_int);
141 char	*bpf_image(struct bpf_insn *, int);
142 
143 #ifdef __cplusplus
144 }
145 #endif
146 
147 
148 #endif
149