]> The Tcpdump Group git mirrors - libpcap/blob - pcap-int.h
Add a "pcap_breakloop()" API to break out of the loop in
[libpcap] / pcap-int.h
1 /*
2 * Copyright (c) 1994, 1995, 1996
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: /tcpdump/master/libpcap/pcap-int.h,v 1.55 2003-11-04 07:05:34 guy Exp $ (LBL)
34 */
35
36 #ifndef pcap_int_h
37 #define pcap_int_h
38
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42
43 #include <pcap.h>
44
45 #ifdef WIN32
46 #include <packet32.h>
47 #endif /* WIN32 */
48
49 /*
50 * Savefile
51 */
52 typedef enum {
53 NOT_SWAPPED,
54 SWAPPED,
55 MAYBE_SWAPPED
56 } swapped_type_t;
57
58 struct pcap_sf {
59 FILE *rfile;
60 int swapped;
61 int hdrsize;
62 swapped_type_t lengths_swapped;
63 int version_major;
64 int version_minor;
65 u_char *base;
66 };
67
68 struct pcap_md {
69 struct pcap_stat stat;
70 /*XXX*/
71 int use_bpf; /* using kernel filter */
72 u_long TotPkts; /* can't oflow for 79 hrs on ether */
73 u_long TotAccepted; /* count accepted by filter */
74 u_long TotDrops; /* count of dropped packets */
75 long TotMissed; /* missed by i/f during this run */
76 long OrigMissed; /* missed by i/f before this run */
77 #ifdef linux
78 int sock_packet; /* using Linux 2.0 compatible interface */
79 int timeout; /* timeout specified to pcap_open_live */
80 int clear_promisc; /* must clear promiscuous mode when we close */
81 int cooked; /* using SOCK_DGRAM rather than SOCK_RAW */
82 int lo_ifindex; /* interface index of the loopback device */
83 char *device; /* device name */
84 struct pcap *next; /* list of open promiscuous sock_packet pcaps */
85 #endif
86
87 #ifdef HAVE_DAG_API
88 void *dag_mem_base; /* DAG card memory base address */
89 u_int dag_mem_bottom; /* DAG card current memory bottom pointer */
90 u_int dag_mem_top; /* DAG card current memory top pointer */
91 int dag_fcs_bits; /* Number of checksum bits from link layer */
92 #endif
93 };
94
95 struct pcap {
96 #ifdef WIN32
97 ADAPTER *adapter;
98 LPPACKET Packet;
99 int timeout;
100 int nonblock;
101 #else
102 int fd;
103 #endif /* WIN32 */
104 int snapshot;
105 int linktype;
106 int tzoff; /* timezone offset */
107 int offset; /* offset for proper alignment */
108
109 int break_loop; /* flag set to force break from packet-reading loop */
110
111 struct pcap_sf sf;
112 struct pcap_md md;
113
114 /*
115 * Read buffer.
116 */
117 int bufsize;
118 u_char *buffer;
119 u_char *bp;
120 int cc;
121
122 /*
123 * Place holder for pcap_next().
124 */
125 u_char *pkt;
126
127 /*
128 * Methods.
129 */
130 int (*read_op)(pcap_t *, int cnt, pcap_handler, u_char *);
131 int (*setfilter_op)(pcap_t *, struct bpf_program *);
132 int (*set_datalink_op)(pcap_t *, int);
133 int (*stats_op)(pcap_t *, struct pcap_stat *);
134 void (*close_op)(pcap_t *);
135
136 /*
137 * Placeholder for filter code if bpf not in kernel.
138 */
139 struct bpf_program fcode;
140
141 char errbuf[PCAP_ERRBUF_SIZE + 1];
142 int dlt_count;
143 int *dlt_list;
144
145 struct pcap_pkthdr pcap_header; /* This is needed for the pcap_next_ex() to work */
146 };
147
148 /*
149 * This is a timeval as stored in disk in a dumpfile.
150 * It has to use the same types everywhere, independent of the actual
151 * `struct timeval'
152 */
153
154 struct pcap_timeval {
155 bpf_int32 tv_sec; /* seconds */
156 bpf_int32 tv_usec; /* microseconds */
157 };
158
159 /*
160 * How a `pcap_pkthdr' is actually stored in the dumpfile.
161 *
162 * Do not change the format of this structure, in any way (this includes
163 * changes that only affect the length of fields in this structure),
164 * and do not make the time stamp anything other than seconds and
165 * microseconds (e.g., seconds and nanoseconds). Instead:
166 *
167 * introduce a new structure for the new format;
168 *
169 * send mail to "tcpdump-workers@tcpdump.org", requesting a new
170 * magic number for your new capture file format, and, when
171 * you get the new magic number, put it in "savefile.c";
172 *
173 * use that magic number for save files with the changed record
174 * header;
175 *
176 * make the code in "savefile.c" capable of reading files with
177 * the old record header as well as files with the new record header
178 * (using the magic number to determine the header format).
179 *
180 * Then supply the changes to "patches@tcpdump.org", so that future
181 * versions of libpcap and programs that use it (such as tcpdump) will
182 * be able to read your new capture file format.
183 */
184
185 struct pcap_sf_pkthdr {
186 struct pcap_timeval ts; /* time stamp */
187 bpf_u_int32 caplen; /* length of portion present */
188 bpf_u_int32 len; /* length this packet (off wire) */
189 };
190
191 /*
192 * How a `pcap_pkthdr' is actually stored in dumpfiles written
193 * by some patched versions of libpcap (e.g. the ones in Red
194 * Hat Linux 6.1 and 6.2).
195 *
196 * Do not change the format of this structure, in any way (this includes
197 * changes that only affect the length of fields in this structure).
198 * Instead, introduce a new structure, as per the above.
199 */
200
201 struct pcap_sf_patched_pkthdr {
202 struct pcap_timeval ts; /* time stamp */
203 bpf_u_int32 caplen; /* length of portion present */
204 bpf_u_int32 len; /* length this packet (off wire) */
205 int index;
206 unsigned short protocol;
207 unsigned char pkt_type;
208 };
209
210 int yylex(void);
211
212 #ifndef min
213 #define min(a, b) ((a) > (b) ? (b) : (a))
214 #endif
215
216 /* XXX should these be in pcap.h? */
217 int pcap_offline_read(pcap_t *, int, pcap_handler, u_char *);
218 int pcap_read(pcap_t *, int cnt, pcap_handler, u_char *);
219
220
221 /*
222 * Ultrix, DEC OSF/1^H^H^H^H^H^H^H^H^HDigital UNIX^H^H^H^H^H^H^H^H^H^H^H^H
223 * Tru64 UNIX, and NetBSD pad to make everything line up on a nice boundary.
224 */
225 #if defined(ultrix) || defined(__osf__) || defined(__NetBSD__)
226 #define PCAP_FDDIPAD 3
227 #endif
228
229 #ifndef HAVE_STRLCPY
230 #define strlcpy(x, y, z) \
231 (strncpy((x), (y), (z)), \
232 ((z) <= 0 ? 0 : ((x)[(z) - 1] = '\0')), \
233 strlen((y)))
234 #endif
235
236 /*
237 * Internal interface for "pcap_set_datalink()". Attempts to set the
238 * link-layer type to the specified type; if that fails, returns -1.
239 * (On platforms that don't support setting it at all, this can just
240 * return 0 - on those platforms, "pcap_set_datalink()" has already
241 * checked whether the DLT_ value is the one the device supports.
242 */
243 int pcap_set_datalink_platform(pcap_t *, int);
244
245 /*
246 * Internal interfaces for "pcap_findalldevs()".
247 *
248 * "pcap_platform_finddevs()" is a platform-dependent routine to
249 * add devices not found by the "standard" mechanisms (SIOCGIFCONF,
250 * "getifaddrs()", etc..
251 *
252 * "pcap_add_if()" adds an interface to the list of interfaces.
253 */
254 int pcap_platform_finddevs(pcap_if_t **, char *);
255 int add_addr_to_iflist(pcap_if_t **, char *, u_int, struct sockaddr *,
256 size_t, struct sockaddr *, size_t, struct sockaddr *, size_t,
257 struct sockaddr *, size_t, char *);
258 int pcap_add_if(pcap_if_t **, char *, u_int, const char *, char *);
259 struct sockaddr *dup_sockaddr(struct sockaddr *, size_t);
260 int add_or_find_if(pcap_if_t **, pcap_if_t **, const char *, u_int,
261 const char *, char *);
262
263 #ifdef WIN32
264 char *pcap_win32strerror(void);
265 #endif
266
267 /* XXX */
268 extern int pcap_fddipad;
269
270 int install_bpf_program(pcap_t *, struct bpf_program *);
271
272 int pcap_strcasecmp(const char *, const char *);
273
274 #ifdef __cplusplus
275 }
276 #endif
277
278 #endif