1 /* -*- Mode: c; tab-width: 8; indent-tabs-mode: 1; c-basic-offset: 8; -*- */
3 * Copyright (c) 1993, 1994, 1995, 1996, 1997
4 * The Regents of the University of California. All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
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.
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
35 #ifndef lib_pcap_pcap_h
36 #define lib_pcap_pcap_h
38 #include <pcap/export-defs.h>
41 #include <pcap-stdinc.h>
43 #include <sys/types.h>
44 #include <sys/socket.h> /* u_int, u_char etc. */
46 #include <sys/types.h>
48 #endif /* _WIN32/MSDOS/UN*X */
59 * Version number of the current version of the pcap file format.
61 * NOTE: this is *NOT* the version number of the libpcap library.
62 * To fetch the version information for the version of libpcap
63 * you're using, use pcap_lib_version().
65 #define PCAP_VERSION_MAJOR 2
66 #define PCAP_VERSION_MINOR 4
68 #define PCAP_ERRBUF_SIZE 256
71 * Compatibility for systems that have a bpf.h that
72 * predates the bpf typedefs for 64-bit support.
74 #if BPF_RELEASE - 0 < 199406
75 typedef int bpf_int32;
76 typedef u_int bpf_u_int32;
79 typedef struct pcap pcap_t;
80 typedef struct pcap_dumper pcap_dumper_t;
81 typedef struct pcap_if pcap_if_t;
82 typedef struct pcap_addr pcap_addr_t;
85 * The first record in the file contains saved values for some
86 * of the flags used in the printout phases of tcpdump.
87 * Many fields here are 32 bit ints so compilers won't insert unwanted
88 * padding; these files need to be interchangeable across architectures.
90 * Do not change the layout of this structure, in any way (this includes
91 * changes that only affect the length of fields in this structure).
93 * Also, do not change the interpretation of any of the members of this
94 * structure, in any way (this includes using values other than
95 * LINKTYPE_ values, as defined in "savefile.c", in the "linktype"
100 * introduce a new structure for the new format, if the layout
101 * of the structure changed;
103 * send mail to "tcpdump-workers@lists.tcpdump.org", requesting
104 * a new magic number for your new capture file format, and, when
105 * you get the new magic number, put it in "savefile.c";
107 * use that magic number for save files with the changed file
110 * make the code in "savefile.c" capable of reading files with
111 * the old file header as well as files with the new file header
112 * (using the magic number to determine the header format).
114 * Then supply the changes by forking the branch at
116 * https://github.com/the-tcpdump-group/libpcap/issues
118 * and issuing a pull request, so that future versions of libpcap and
119 * programs that use it (such as tcpdump) will be able to read your new
120 * capture file format.
122 struct pcap_file_header {
124 u_short version_major;
125 u_short version_minor;
126 bpf_int32 thiszone; /* gmt to local correction */
127 bpf_u_int32 sigfigs; /* accuracy of timestamps */
128 bpf_u_int32 snaplen; /* max length saved portion of each pkt */
129 bpf_u_int32 linktype; /* data link type (LINKTYPE_*) */
133 * Macros for the value returned by pcap_datalink_ext().
135 * If LT_FCS_LENGTH_PRESENT(x) is true, the LT_FCS_LENGTH(x) macro
136 * gives the FCS length of packets in the capture.
138 #define LT_FCS_LENGTH_PRESENT(x) ((x) & 0x04000000)
139 #define LT_FCS_LENGTH(x) (((x) & 0xF0000000) >> 28)
140 #define LT_FCS_DATALINK_EXT(x) ((((x) & 0xF) << 28) | 0x04000000)
149 * Generic per-packet information, as supplied by libpcap.
151 * The time stamp can and should be a "struct timeval", regardless of
152 * whether your system supports 32-bit tv_sec in "struct timeval",
153 * 64-bit tv_sec in "struct timeval", or both if it supports both 32-bit
154 * and 64-bit applications. The on-disk format of savefiles uses 32-bit
155 * tv_sec (and tv_usec); this structure is irrelevant to that. 32-bit
156 * and 64-bit versions of libpcap, even if they're on the same platform,
157 * should supply the appropriate version of "struct timeval", even if
158 * that's not what the underlying packet capture mechanism supplies.
161 struct timeval ts; /* time stamp */
162 bpf_u_int32 caplen; /* length of portion present */
163 bpf_u_int32 len; /* length this packet (off wire) */
167 * As returned by the pcap_stats()
170 u_int ps_recv; /* number of packets received */
171 u_int ps_drop; /* number of packets dropped */
172 u_int ps_ifdrop; /* drops by interface -- only supported on some platforms */
173 #if defined(_WIN32) && defined(HAVE_REMOTE)
174 u_int ps_capt; /* number of packets that reach the application */
175 u_int ps_sent; /* number of packets sent by the server on the network */
176 u_int ps_netdrop; /* number of packets lost on the network */
177 #endif /* _WIN32 && HAVE_REMOTE */
182 * As returned by the pcap_stats_ex()
184 struct pcap_stat_ex {
185 u_long rx_packets; /* total packets received */
186 u_long tx_packets; /* total packets transmitted */
187 u_long rx_bytes; /* total bytes received */
188 u_long tx_bytes; /* total bytes transmitted */
189 u_long rx_errors; /* bad packets received */
190 u_long tx_errors; /* packet transmit problems */
191 u_long rx_dropped; /* no space in Rx buffers */
192 u_long tx_dropped; /* no space available for Tx */
193 u_long multicast; /* multicast packets received */
196 /* detailed rx_errors: */
197 u_long rx_length_errors;
198 u_long rx_over_errors; /* receiver ring buff overflow */
199 u_long rx_crc_errors; /* recv'd pkt with crc error */
200 u_long rx_frame_errors; /* recv'd frame alignment error */
201 u_long rx_fifo_errors; /* recv'r fifo overrun */
202 u_long rx_missed_errors; /* recv'r missed packet */
204 /* detailed tx_errors */
205 u_long tx_aborted_errors;
206 u_long tx_carrier_errors;
207 u_long tx_fifo_errors;
208 u_long tx_heartbeat_errors;
209 u_long tx_window_errors;
214 * Item in a list of interfaces.
217 struct pcap_if *next;
218 char *name; /* name to hand to "pcap_open_live()" */
219 char *description; /* textual description of interface, or NULL */
220 struct pcap_addr *addresses;
221 bpf_u_int32 flags; /* PCAP_IF_ interface flags */
224 #define PCAP_IF_LOOPBACK 0x00000001 /* interface is loopback */
225 #define PCAP_IF_UP 0x00000002 /* interface is up */
226 #define PCAP_IF_RUNNING 0x00000004 /* interface is running */
229 * Representation of an interface address.
232 struct pcap_addr *next;
233 struct sockaddr *addr; /* address */
234 struct sockaddr *netmask; /* netmask for that address */
235 struct sockaddr *broadaddr; /* broadcast address for that address */
236 struct sockaddr *dstaddr; /* P2P destination address for that address */
239 typedef void (*pcap_handler)(u_char *, const struct pcap_pkthdr *,
243 * Error codes for the pcap API.
244 * These will all be negative, so you can check for the success or
245 * failure of a call that returns these codes by checking for a
248 #define PCAP_ERROR -1 /* generic error code */
249 #define PCAP_ERROR_BREAK -2 /* loop terminated by pcap_breakloop */
250 #define PCAP_ERROR_NOT_ACTIVATED -3 /* the capture needs to be activated */
251 #define PCAP_ERROR_ACTIVATED -4 /* the operation can't be performed on already activated captures */
252 #define PCAP_ERROR_NO_SUCH_DEVICE -5 /* no such device exists */
253 #define PCAP_ERROR_RFMON_NOTSUP -6 /* this device doesn't support rfmon (monitor) mode */
254 #define PCAP_ERROR_NOT_RFMON -7 /* operation supported only in monitor mode */
255 #define PCAP_ERROR_PERM_DENIED -8 /* no permission to open the device */
256 #define PCAP_ERROR_IFACE_NOT_UP -9 /* interface isn't up */
257 #define PCAP_ERROR_CANTSET_TSTAMP_TYPE -10 /* this device doesn't support setting the time stamp type */
258 #define PCAP_ERROR_PROMISC_PERM_DENIED -11 /* you don't have permission to capture in promiscuous mode */
259 #define PCAP_ERROR_TSTAMP_PRECISION_NOTSUP -12 /* the requested time stamp precision is not supported */
262 * Warning codes for the pcap API.
263 * These will all be positive and non-zero, so they won't look like
266 #define PCAP_WARNING 1 /* generic warning code */
267 #define PCAP_WARNING_PROMISC_NOTSUP 2 /* this device doesn't support promiscuous mode */
268 #define PCAP_WARNING_TSTAMP_TYPE_NOTSUP 3 /* the requested time stamp type is not supported */
271 * Value to pass to pcap_compile() as the netmask if you don't know what
274 #define PCAP_NETMASK_UNKNOWN 0xffffffff
276 PCAP_API char *pcap_lookupdev(char *);
277 PCAP_API int pcap_lookupnet(const char *, bpf_u_int32 *, bpf_u_int32 *, char *);
279 PCAP_API pcap_t *pcap_create(const char *, char *);
280 PCAP_API int pcap_set_snaplen(pcap_t *, int);
281 PCAP_API int pcap_set_promisc(pcap_t *, int);
282 PCAP_API int pcap_can_set_rfmon(pcap_t *);
283 PCAP_API int pcap_set_rfmon(pcap_t *, int);
284 PCAP_API int pcap_set_timeout(pcap_t *, int);
285 PCAP_API int pcap_set_tstamp_type(pcap_t *, int);
286 PCAP_API int pcap_set_immediate_mode(pcap_t *, int);
287 PCAP_API int pcap_set_buffer_size(pcap_t *, int);
288 PCAP_API int pcap_set_tstamp_precision(pcap_t *, int);
289 PCAP_API int pcap_get_tstamp_precision(pcap_t *);
290 PCAP_API int pcap_activate(pcap_t *);
292 PCAP_API int pcap_list_tstamp_types(pcap_t *, int **);
293 PCAP_API void pcap_free_tstamp_types(int *);
294 PCAP_API int pcap_tstamp_type_name_to_val(const char *);
295 PCAP_API const char *pcap_tstamp_type_val_to_name(int);
296 PCAP_API const char *pcap_tstamp_type_val_to_description(int);
300 * Not all systems and interfaces will necessarily support all of these.
302 * A system that supports PCAP_TSTAMP_HOST is offering time stamps
303 * provided by the host machine, rather than by the capture device,
304 * but not committing to any characteristics of the time stamp;
305 * it will not offer any of the PCAP_TSTAMP_HOST_ subtypes.
307 * PCAP_TSTAMP_HOST_LOWPREC is a time stamp, provided by the host machine,
308 * that's low-precision but relatively cheap to fetch; it's normally done
309 * using the system clock, so it's normally synchronized with times you'd
310 * fetch from system calls.
312 * PCAP_TSTAMP_HOST_HIPREC is a time stamp, provided by the host machine,
313 * that's high-precision; it might be more expensive to fetch. It might
314 * or might not be synchronized with the system clock, and might have
315 * problems with time stamps for packets received on different CPUs,
316 * depending on the platform.
318 * PCAP_TSTAMP_ADAPTER is a high-precision time stamp supplied by the
319 * capture device; it's synchronized with the system clock.
321 * PCAP_TSTAMP_ADAPTER_UNSYNCED is a high-precision time stamp supplied by
322 * the capture device; it's not synchronized with the system clock.
324 * Note that time stamps synchronized with the system clock can go
325 * backwards, as the system clock can go backwards. If a clock is
326 * not in sync with the system clock, that could be because the
327 * system clock isn't keeping accurate time, because the other
328 * clock isn't keeping accurate time, or both.
330 * Note that host-provided time stamps generally correspond to the
331 * time when the time-stamping code sees the packet; this could
332 * be some unknown amount of time after the first or last bit of
333 * the packet is received by the network adapter, due to batching
334 * of interrupts for packet arrival, queueing delays, etc..
336 #define PCAP_TSTAMP_HOST 0 /* host-provided, unknown characteristics */
337 #define PCAP_TSTAMP_HOST_LOWPREC 1 /* host-provided, low precision */
338 #define PCAP_TSTAMP_HOST_HIPREC 2 /* host-provided, high precision */
339 #define PCAP_TSTAMP_ADAPTER 3 /* device-provided, synced with the system clock */
340 #define PCAP_TSTAMP_ADAPTER_UNSYNCED 4 /* device-provided, not synced with the system clock */
343 * Time stamp resolution types.
344 * Not all systems and interfaces will necessarily support all of these
345 * resolutions when doing live captures; all of them can be requested
346 * when reading a savefile.
348 #define PCAP_TSTAMP_PRECISION_MICRO 0 /* use timestamps with microsecond precision, default */
349 #define PCAP_TSTAMP_PRECISION_NANO 1 /* use timestamps with nanosecond precision */
351 PCAP_API pcap_t *pcap_open_live(const char *, int, int, int, char *);
352 PCAP_API pcap_t *pcap_open_dead(int, int);
353 PCAP_API pcap_t *pcap_open_dead_with_tstamp_precision(int, int, u_int);
354 PCAP_API pcap_t *pcap_open_offline_with_tstamp_precision(const char *, u_int, char *);
355 PCAP_API pcap_t *pcap_open_offline(const char *, char *);
357 PCAP_API pcap_t *pcap_hopen_offline_with_tstamp_precision(intptr_t, u_int, char *);
358 PCAP_API pcap_t *pcap_hopen_offline(intptr_t, char *);
360 * If we're building libpcap, these are internal routines in savefile.c,
361 * so we mustn't define them as macros.
363 #ifndef BUILDING_PCAP
364 #define pcap_fopen_offline_with_tstamp_precision(f,p,b) \
365 pcap_hopen_offline_with_tstamp_precision(_get_osfhandle(_fileno(f)), p, b)
366 #define pcap_fopen_offline(f,b) \
367 pcap_hopen_offline(_get_osfhandle(_fileno(f)), b)
370 PCAP_API pcap_t *pcap_fopen_offline_with_tstamp_precision(FILE *, u_int, char *);
371 PCAP_API pcap_t *pcap_fopen_offline(FILE *, char *);
374 PCAP_API void pcap_close(pcap_t *);
375 PCAP_API int pcap_loop(pcap_t *, int, pcap_handler, u_char *);
376 PCAP_API int pcap_dispatch(pcap_t *, int, pcap_handler, u_char *);
377 PCAP_API const u_char *pcap_next(pcap_t *, struct pcap_pkthdr *);
378 PCAP_API int pcap_next_ex(pcap_t *, struct pcap_pkthdr **, const u_char **);
379 PCAP_API void pcap_breakloop(pcap_t *);
380 PCAP_API int pcap_stats(pcap_t *, struct pcap_stat *);
381 PCAP_API int pcap_setfilter(pcap_t *, struct bpf_program *);
382 PCAP_API int pcap_setdirection(pcap_t *, pcap_direction_t);
383 PCAP_API int pcap_getnonblock(pcap_t *, char *);
384 PCAP_API int pcap_setnonblock(pcap_t *, int, char *);
385 PCAP_API int pcap_inject(pcap_t *, const void *, size_t);
386 PCAP_API int pcap_sendpacket(pcap_t *, const u_char *, int);
387 PCAP_API const char *pcap_statustostr(int);
388 PCAP_API const char *pcap_strerror(int);
389 PCAP_API char *pcap_geterr(pcap_t *);
390 PCAP_API void pcap_perror(pcap_t *, const char *);
391 PCAP_API int pcap_compile(pcap_t *, struct bpf_program *, const char *, int,
393 PCAP_API int pcap_compile_nopcap(int, int, struct bpf_program *,
394 const char *, int, bpf_u_int32);
395 PCAP_API void pcap_freecode(struct bpf_program *);
396 PCAP_API int pcap_offline_filter(const struct bpf_program *,
397 const struct pcap_pkthdr *, const u_char *);
398 PCAP_API int pcap_datalink(pcap_t *);
399 PCAP_API int pcap_datalink_ext(pcap_t *);
400 PCAP_API int pcap_list_datalinks(pcap_t *, int **);
401 PCAP_API int pcap_set_datalink(pcap_t *, int);
402 PCAP_API void pcap_free_datalinks(int *);
403 PCAP_API int pcap_datalink_name_to_val(const char *);
404 PCAP_API const char *pcap_datalink_val_to_name(int);
405 PCAP_API const char *pcap_datalink_val_to_description(int);
406 PCAP_API int pcap_snapshot(pcap_t *);
407 PCAP_API int pcap_is_swapped(pcap_t *);
408 PCAP_API int pcap_major_version(pcap_t *);
409 PCAP_API int pcap_minor_version(pcap_t *);
412 PCAP_API FILE *pcap_file(pcap_t *);
413 PCAP_API int pcap_fileno(pcap_t *);
416 PCAP_API int pcap_wsockinit(void);
419 PCAP_API pcap_dumper_t *pcap_dump_open(pcap_t *, const char *);
420 PCAP_API pcap_dumper_t *pcap_dump_fopen(pcap_t *, FILE *fp);
421 PCAP_API pcap_dumper_t *pcap_dump_open_append(pcap_t *, const char *);
422 PCAP_API FILE *pcap_dump_file(pcap_dumper_t *);
423 PCAP_API long pcap_dump_ftell(pcap_dumper_t *);
424 PCAP_API int pcap_dump_flush(pcap_dumper_t *);
425 PCAP_API void pcap_dump_close(pcap_dumper_t *);
426 PCAP_API void pcap_dump(u_char *, const struct pcap_pkthdr *, const u_char *);
428 PCAP_API int pcap_findalldevs(pcap_if_t **, char *);
429 PCAP_API void pcap_freealldevs(pcap_if_t *);
431 PCAP_API const char *pcap_lib_version(void);
434 * On at least some versions of NetBSD and QNX, we don't want to declare
435 * bpf_filter() here, as it's also be declared in <net/bpf.h>, with a
436 * different signature, but, on other BSD-flavored UN*Xes, it's not
437 * declared in <net/bpf.h>, so we *do* want to declare it here, so it's
438 * declared when we build pcap-bpf.c.
440 #if !defined(__NetBSD__) && !defined(__QNX__)
441 PCAP_API u_int bpf_filter(const struct bpf_insn *, const u_char *, u_int, u_int);
443 PCAP_API int bpf_validate(const struct bpf_insn *f, int len);
444 PCAP_API char *bpf_image(const struct bpf_insn *, int);
445 PCAP_API void bpf_dump(const struct bpf_program *, int);
454 \brief A queue of raw packets that will be sent to the network with pcap_sendqueue_transmit().
456 struct pcap_send_queue
458 u_int maxlen; /* Maximum size of the the queue, in bytes. This
459 variable contains the size of the buffer field. */
460 u_int len; /* Current size of the queue, in bytes. */
461 char *buffer; /* Buffer containing the packets to be sent. */
464 typedef struct pcap_send_queue pcap_send_queue;
467 \brief This typedef is a support for the pcap_get_airpcap_handle() function
469 #if !defined(AIRPCAP_HANDLE__EAE405F5_0171_9592_B3C2_C19EC426AD34__DEFINED_)
470 #define AIRPCAP_HANDLE__EAE405F5_0171_9592_B3C2_C19EC426AD34__DEFINED_
471 typedef struct _AirpcapHandle *PAirpcapHandle;
474 PCAP_API int pcap_setbuff(pcap_t *p, int dim);
475 PCAP_API int pcap_setmode(pcap_t *p, int mode);
476 PCAP_API int pcap_setmintocopy(pcap_t *p, int size);
478 PCAP_API HANDLE pcap_getevent(pcap_t *p);
480 PCAP_API int pcap_oid_get_request(pcap_t *, bpf_u_int32, void *, size_t *);
481 PCAP_API int pcap_oid_set_request(pcap_t *, bpf_u_int32, const void *, size_t *);
483 PCAP_API pcap_send_queue* pcap_sendqueue_alloc(u_int memsize);
485 PCAP_API void pcap_sendqueue_destroy(pcap_send_queue* queue);
487 PCAP_API int pcap_sendqueue_queue(pcap_send_queue* queue, const struct pcap_pkthdr *pkt_header, const u_char *pkt_data);
489 PCAP_API u_int pcap_sendqueue_transmit(pcap_t *p, pcap_send_queue* queue, int sync);
491 PCAP_API struct pcap_stat *pcap_stats_ex(pcap_t *p, int *pcap_stat_size);
493 PCAP_API int pcap_setuserbuffer(pcap_t *p, int size);
495 PCAP_API int pcap_live_dump(pcap_t *p, char *filename, int maxsize, int maxpacks);
497 PCAP_API int pcap_live_dump_ended(pcap_t *p, int sync);
499 PCAP_API int pcap_start_oem(char* err_str, int flags);
501 PCAP_API PAirpcapHandle pcap_get_airpcap_handle(pcap_t *p);
513 PCAP_API int pcap_stats_ex (pcap_t *, struct pcap_stat_ex *);
514 PCAP_API void pcap_set_wait (pcap_t *p, void (*yield)(void), int wait);
515 PCAP_API u_long pcap_mac_packets (void);
523 PCAP_API int pcap_get_selectable_fd(pcap_t *);
525 #endif /* _WIN32/MSDOS/UN*X */
528 /* Includes most of the public stuff that is needed for the remote capture */
529 #include <remote-ext.h>
530 #endif /* HAVE_REMOTE */
536 #endif /* lib_pcap_pcap_h */