Merge from vendor branch HEIMDAL:
[dragonfly.git] / contrib / libpcap-0.8.3 / 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.2.4 2003/12/15 01:42:24 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         int dag_offset_flags; /* Flags to pass to dag_offset(). */
93 #endif
94 };
95
96 struct pcap {
97 #ifdef WIN32
98         ADAPTER *adapter;
99         LPPACKET Packet;
100         int timeout;
101         int nonblock;
102 #else
103         int fd;
104         int selectable_fd;
105 #endif /* WIN32 */
106         int snapshot;
107         int linktype;
108         int tzoff;              /* timezone offset */
109         int offset;             /* offset for proper alignment */
110
111         int break_loop;         /* flag set to force break from packet-reading loop */
112
113         struct pcap_sf sf;
114         struct pcap_md md;
115
116         /*
117          * Read buffer.
118          */
119         int bufsize;
120         u_char *buffer;
121         u_char *bp;
122         int cc;
123
124         /*
125          * Place holder for pcap_next().
126          */
127         u_char *pkt;
128
129         /*
130          * Methods.
131          */
132         int     (*read_op)(pcap_t *, int cnt, pcap_handler, u_char *);
133         int     (*setfilter_op)(pcap_t *, struct bpf_program *);
134         int     (*set_datalink_op)(pcap_t *, int);
135         int     (*getnonblock_op)(pcap_t *, char *);
136         int     (*setnonblock_op)(pcap_t *, int, char *);
137         int     (*stats_op)(pcap_t *, struct pcap_stat *);
138         void    (*close_op)(pcap_t *);
139
140         /*
141          * Placeholder for filter code if bpf not in kernel.
142          */
143         struct bpf_program fcode;
144
145         char errbuf[PCAP_ERRBUF_SIZE + 1];
146         int dlt_count;
147         int *dlt_list;
148
149         struct pcap_pkthdr pcap_header; /* This is needed for the pcap_next_ex() to work */
150 };
151
152 /*
153  * This is a timeval as stored in disk in a dumpfile.
154  * It has to use the same types everywhere, independent of the actual
155  * `struct timeval'
156  */
157
158 struct pcap_timeval {
159     bpf_int32 tv_sec;           /* seconds */
160     bpf_int32 tv_usec;          /* microseconds */
161 };
162
163 /*
164  * How a `pcap_pkthdr' is actually stored in the dumpfile.
165  *
166  * Do not change the format of this structure, in any way (this includes
167  * changes that only affect the length of fields in this structure),
168  * and do not make the time stamp anything other than seconds and
169  * microseconds (e.g., seconds and nanoseconds).  Instead:
170  *
171  *      introduce a new structure for the new format;
172  *
173  *      send mail to "tcpdump-workers@tcpdump.org", requesting a new
174  *      magic number for your new capture file format, and, when
175  *      you get the new magic number, put it in "savefile.c";
176  *
177  *      use that magic number for save files with the changed record
178  *      header;
179  *
180  *      make the code in "savefile.c" capable of reading files with
181  *      the old record header as well as files with the new record header
182  *      (using the magic number to determine the header format).
183  *
184  * Then supply the changes to "patches@tcpdump.org", so that future
185  * versions of libpcap and programs that use it (such as tcpdump) will
186  * be able to read your new capture file format.
187  */
188
189 struct pcap_sf_pkthdr {
190     struct pcap_timeval ts;     /* time stamp */
191     bpf_u_int32 caplen;         /* length of portion present */
192     bpf_u_int32 len;            /* length this packet (off wire) */
193 };
194
195 /*
196  * How a `pcap_pkthdr' is actually stored in dumpfiles written
197  * by some patched versions of libpcap (e.g. the ones in Red
198  * Hat Linux 6.1 and 6.2).
199  *
200  * Do not change the format of this structure, in any way (this includes
201  * changes that only affect the length of fields in this structure).
202  * Instead, introduce a new structure, as per the above.
203  */
204
205 struct pcap_sf_patched_pkthdr {
206     struct pcap_timeval ts;     /* time stamp */
207     bpf_u_int32 caplen;         /* length of portion present */
208     bpf_u_int32 len;            /* length this packet (off wire) */
209     int         index;
210     unsigned short protocol;
211     unsigned char pkt_type;
212 };
213
214 int     yylex(void);
215
216 #ifndef min
217 #define min(a, b) ((a) > (b) ? (b) : (a))
218 #endif
219
220 /* XXX should these be in pcap.h? */
221 int     pcap_offline_read(pcap_t *, int, pcap_handler, u_char *);
222 int     pcap_read(pcap_t *, int cnt, pcap_handler, u_char *);
223
224
225 /*
226  * 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
227  * Tru64 UNIX, and NetBSD pad to make everything line up on a nice boundary.
228  */
229 #if defined(ultrix) || defined(__osf__) || defined(__NetBSD__)
230 #define       PCAP_FDDIPAD 3
231 #endif
232
233 #ifndef HAVE_STRLCPY
234 #define strlcpy(x, y, z) \
235         (strncpy((x), (y), (z)), \
236          ((z) <= 0 ? 0 : ((x)[(z) - 1] = '\0')), \
237          strlen((y)))
238 #endif
239
240 #include <stdarg.h>
241
242 #if !defined(HAVE_SNPRINTF)
243 #define snprintf pcap_snprintf
244 extern int snprintf (char *, size_t, const char *, ...);
245 #endif
246
247 #if !defined(HAVE_VSNPRINTF)
248 #define vsnprintf pcap_vsnprintf
249 extern int vsnprintf (char *, size_t, const char *, va_list ap);
250 #endif
251
252 /*
253  * Routines that most pcap implementations can use for non-blocking mode.
254  */
255 #ifndef WIN32
256 int     pcap_getnonblock_fd(pcap_t *, char *);
257 int     pcap_setnonblock_fd(pcap_t *p, int, char *);
258 #endif
259
260 /*
261  * Internal interfaces for "pcap_findalldevs()".
262  *
263  * "pcap_platform_finddevs()" is a platform-dependent routine to
264  * add devices not found by the "standard" mechanisms (SIOCGIFCONF,
265  * "getifaddrs()", etc..
266  *
267  * "pcap_add_if()" adds an interface to the list of interfaces.
268  */
269 int     pcap_platform_finddevs(pcap_if_t **, char *);
270 int     add_addr_to_iflist(pcap_if_t **, char *, u_int, struct sockaddr *,
271             size_t, struct sockaddr *, size_t, struct sockaddr *, size_t,
272             struct sockaddr *, size_t, char *);
273 int     pcap_add_if(pcap_if_t **, char *, u_int, const char *, char *);
274 struct sockaddr *dup_sockaddr(struct sockaddr *, size_t);
275 int     add_or_find_if(pcap_if_t **, pcap_if_t **, const char *, u_int,
276             const char *, char *);
277
278 #ifdef WIN32
279 char    *pcap_win32strerror(void);
280 #endif
281
282 /* XXX */
283 extern  int pcap_fddipad;
284
285 int     install_bpf_program(pcap_t *, struct bpf_program *);
286
287 int     pcap_strcasecmp(const char *, const char *);
288
289 #ifdef __cplusplus
290 }
291 #endif
292
293 #endif