1/* -*- Mode: c; tab-width: 8; indent-tabs-mode: 1; c-basic-offset: 8; -*- */ 2/* 3 * Copyright (c) 2012-2014 Apple Inc. All rights reserved. 4 * 5 * @APPLE_LICENSE_HEADER_START@ 6 * 7 * This file contains Original Code and/or Modifications of Original Code 8 * as defined in and that are subject to the Apple Public Source License 9 * Version 2.0 (the 'License'). You may not use this file except in 10 * compliance with the License. Please obtain a copy of the License at 11 * http://www.opensource.apple.com/apsl/ and read it before using this 12 * file. 13 * 14 * The Original Code and all software distributed under the License are 15 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 16 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, 17 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, 18 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 19 * Please see the License for the specific language governing rights and 20 * limitations under the License. 21 * 22 * @APPLE_LICENSE_HEADER_END@ 23 */ 24/* 25 * Copyright (c) 1993, 1994, 1995, 1996, 1997 26 * The Regents of the University of California. All rights reserved. 27 * 28 * Redistribution and use in source and binary forms, with or without 29 * modification, are permitted provided that the following conditions 30 * are met: 31 * 1. Redistributions of source code must retain the above copyright 32 * notice, this list of conditions and the following disclaimer. 33 * 2. Redistributions in binary form must reproduce the above copyright 34 * notice, this list of conditions and the following disclaimer in the 35 * documentation and/or other materials provided with the distribution. 36 * 3. All advertising materials mentioning features or use of this software 37 * must display the following acknowledgement: 38 * This product includes software developed by the Computer Systems 39 * Engineering Group at Lawrence Berkeley Laboratory. 40 * 4. Neither the name of the University nor of the Laboratory may be used 41 * to endorse or promote products derived from this software without 42 * specific prior written permission. 43 * 44 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 45 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 46 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 47 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 48 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 49 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 50 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 51 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 52 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 53 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 54 * SUCH DAMAGE. 55 * 56 * @(#) $Header: /tcpdump/master/libpcap/pcap/pcap.h,v 1.15 2008-10-06 15:27:32 gianluca Exp $ (LBL) 57 */ 58 59#ifndef lib_pcap_pcap_h 60#define lib_pcap_pcap_h 61 62#if defined(WIN32) 63 #include <pcap-stdinc.h> 64#elif defined(MSDOS) 65 #include <sys/types.h> 66 #include <sys/socket.h> /* u_int, u_char etc. */ 67#else /* UN*X */ 68 #include <sys/types.h> 69 #include <sys/time.h> 70#endif /* WIN32/MSDOS/UN*X */ 71 72#ifndef PCAP_DONT_INCLUDE_PCAP_BPF_H 73#include <pcap/bpf.h> 74#endif 75 76#include <stdio.h> 77 78#ifdef __cplusplus 79extern "C" { 80#endif 81 82/* 83 * Version number of the current version of the pcap file format. 84 * 85 * NOTE: this is *NOT* the version number of the libpcap library. 86 * To fetch the version information for the version of libpcap 87 * you're using, use pcap_lib_version(). 88 */ 89#define PCAP_VERSION_MAJOR 2 90#define PCAP_VERSION_MINOR 4 91 92#define PCAP_ERRBUF_SIZE 256 93 94/* 95 * Compatibility for systems that have a bpf.h that 96 * predates the bpf typedefs for 64-bit support. 97 */ 98#if BPF_RELEASE - 0 < 199406 99typedef int bpf_int32; 100typedef u_int bpf_u_int32; 101#endif 102 103typedef struct pcap pcap_t; 104typedef struct pcap_dumper pcap_dumper_t; 105typedef struct pcap_if pcap_if_t; 106typedef struct pcap_addr pcap_addr_t; 107 108/* 109 * The first record in the file contains saved values for some 110 * of the flags used in the printout phases of tcpdump. 111 * Many fields here are 32 bit ints so compilers won't insert unwanted 112 * padding; these files need to be interchangeable across architectures. 113 * 114 * Do not change the layout of this structure, in any way (this includes 115 * changes that only affect the length of fields in this structure). 116 * 117 * Also, do not change the interpretation of any of the members of this 118 * structure, in any way (this includes using values other than 119 * LINKTYPE_ values, as defined in "savefile.c", in the "linktype" 120 * field). 121 * 122 * Instead: 123 * 124 * introduce a new structure for the new format, if the layout 125 * of the structure changed; 126 * 127 * send mail to "tcpdump-workers@lists.tcpdump.org", requesting 128 * a new magic number for your new capture file format, and, when 129 * you get the new magic number, put it in "savefile.c"; 130 * 131 * use that magic number for save files with the changed file 132 * header; 133 * 134 * make the code in "savefile.c" capable of reading files with 135 * the old file header as well as files with the new file header 136 * (using the magic number to determine the header format). 137 * 138 * Then supply the changes by forking the branch at 139 * 140 * https://github.com/the-tcpdump-group/libpcap/issues 141 * 142 * and issuing a pull request, so that future versions of libpcap and 143 * programs that use it (such as tcpdump) will be able to read your new 144 * capture file format. 145 */ 146struct pcap_file_header { 147 bpf_u_int32 magic; 148 u_short version_major; 149 u_short version_minor; 150 bpf_int32 thiszone; /* gmt to local correction */ 151 bpf_u_int32 sigfigs; /* accuracy of timestamps */ 152 bpf_u_int32 snaplen; /* max length saved portion of each pkt */ 153 bpf_u_int32 linktype; /* data link type (LINKTYPE_*) */ 154}; 155 156/* 157 * Macros for the value returned by pcap_datalink_ext(). 158 * 159 * If LT_FCS_LENGTH_PRESENT(x) is true, the LT_FCS_LENGTH(x) macro 160 * gives the FCS length of packets in the capture. 161 */ 162#define LT_FCS_LENGTH_PRESENT(x) ((x) & 0x04000000) 163#define LT_FCS_LENGTH(x) (((x) & 0xF0000000) >> 28) 164#define LT_FCS_DATALINK_EXT(x) ((((x) & 0xF) << 28) | 0x04000000) 165 166typedef enum { 167 PCAP_D_INOUT = 0, 168 PCAP_D_IN, 169 PCAP_D_OUT 170} pcap_direction_t; 171 172/* 173 * Generic per-packet information, as supplied by libpcap. 174 * 175 * The time stamp can and should be a "struct timeval", regardless of 176 * whether your system supports 32-bit tv_sec in "struct timeval", 177 * 64-bit tv_sec in "struct timeval", or both if it supports both 32-bit 178 * and 64-bit applications. The on-disk format of savefiles uses 32-bit 179 * tv_sec (and tv_usec); this structure is irrelevant to that. 32-bit 180 * and 64-bit versions of libpcap, even if they're on the same platform, 181 * should supply the appropriate version of "struct timeval", even if 182 * that's not what the underlying packet capture mechanism supplies. 183 */ 184struct pcap_pkthdr { 185 struct timeval ts; /* time stamp */ 186 bpf_u_int32 caplen; /* length of portion present */ 187 bpf_u_int32 len; /* length this packet (off wire) */ 188#ifdef __APPLE__ 189 char comment[256]; 190#endif 191}; 192 193/* 194 * As returned by the pcap_stats() 195 */ 196struct pcap_stat { 197 u_int ps_recv; /* number of packets received */ 198 u_int ps_drop; /* number of packets dropped */ 199 u_int ps_ifdrop; /* drops by interface -- only supported on some platforms */ 200#ifdef WIN32 201 u_int bs_capt; /* number of packets that reach the application */ 202#endif /* WIN32 */ 203}; 204 205#ifdef MSDOS 206/* 207 * As returned by the pcap_stats_ex() 208 */ 209struct pcap_stat_ex { 210 u_long rx_packets; /* total packets received */ 211 u_long tx_packets; /* total packets transmitted */ 212 u_long rx_bytes; /* total bytes received */ 213 u_long tx_bytes; /* total bytes transmitted */ 214 u_long rx_errors; /* bad packets received */ 215 u_long tx_errors; /* packet transmit problems */ 216 u_long rx_dropped; /* no space in Rx buffers */ 217 u_long tx_dropped; /* no space available for Tx */ 218 u_long multicast; /* multicast packets received */ 219 u_long collisions; 220 221 /* detailed rx_errors: */ 222 u_long rx_length_errors; 223 u_long rx_over_errors; /* receiver ring buff overflow */ 224 u_long rx_crc_errors; /* recv'd pkt with crc error */ 225 u_long rx_frame_errors; /* recv'd frame alignment error */ 226 u_long rx_fifo_errors; /* recv'r fifo overrun */ 227 u_long rx_missed_errors; /* recv'r missed packet */ 228 229 /* detailed tx_errors */ 230 u_long tx_aborted_errors; 231 u_long tx_carrier_errors; 232 u_long tx_fifo_errors; 233 u_long tx_heartbeat_errors; 234 u_long tx_window_errors; 235 }; 236#endif 237 238/* 239 * Item in a list of interfaces. 240 */ 241struct pcap_if { 242 struct pcap_if *next; 243 char *name; /* name to hand to "pcap_open_live()" */ 244 char *description; /* textual description of interface, or NULL */ 245 struct pcap_addr *addresses; 246 bpf_u_int32 flags; /* PCAP_IF_ interface flags */ 247}; 248 249#define PCAP_IF_LOOPBACK 0x00000001 /* interface is loopback */ 250 251/* 252 * Representation of an interface address. 253 */ 254struct pcap_addr { 255 struct pcap_addr *next; 256 struct sockaddr *addr; /* address */ 257 struct sockaddr *netmask; /* netmask for that address */ 258 struct sockaddr *broadaddr; /* broadcast address for that address */ 259 struct sockaddr *dstaddr; /* P2P destination address for that address */ 260}; 261 262typedef void (*pcap_handler)(u_char *, const struct pcap_pkthdr *, 263 const u_char *); 264 265/* 266 * Error codes for the pcap API. 267 * These will all be negative, so you can check for the success or 268 * failure of a call that returns these codes by checking for a 269 * negative value. 270 */ 271#define PCAP_ERROR -1 /* generic error code */ 272#define PCAP_ERROR_BREAK -2 /* loop terminated by pcap_breakloop */ 273#define PCAP_ERROR_NOT_ACTIVATED -3 /* the capture needs to be activated */ 274#define PCAP_ERROR_ACTIVATED -4 /* the operation can't be performed on already activated captures */ 275#define PCAP_ERROR_NO_SUCH_DEVICE -5 /* no such device exists */ 276#define PCAP_ERROR_RFMON_NOTSUP -6 /* this device doesn't support rfmon (monitor) mode */ 277#define PCAP_ERROR_NOT_RFMON -7 /* operation supported only in monitor mode */ 278#define PCAP_ERROR_PERM_DENIED -8 /* no permission to open the device */ 279#define PCAP_ERROR_IFACE_NOT_UP -9 /* interface isn't up */ 280#define PCAP_ERROR_CANTSET_TSTAMP_TYPE -10 /* this device doesn't support setting the time stamp type */ 281#define PCAP_ERROR_PROMISC_PERM_DENIED -11 /* you don't have permission to capture in promiscuous mode */ 282#define PCAP_ERROR_TSTAMP_PRECISION_NOTSUP -12 /* the requested time stamp precision is not supported */ 283 284/* 285 * Warning codes for the pcap API. 286 * These will all be positive and non-zero, so they won't look like 287 * errors. 288 */ 289#define PCAP_WARNING 1 /* generic warning code */ 290#define PCAP_WARNING_PROMISC_NOTSUP 2 /* this device doesn't support promiscuous mode */ 291#define PCAP_WARNING_TSTAMP_TYPE_NOTSUP 3 /* the requested time stamp type is not supported */ 292 293/* 294 * Value to pass to pcap_compile() as the netmask if you don't know what 295 * the netmask is. 296 */ 297#define PCAP_NETMASK_UNKNOWN 0xffffffff 298 299char *pcap_lookupdev(char *); 300int pcap_lookupnet(const char *, bpf_u_int32 *, bpf_u_int32 *, char *); 301 302pcap_t *pcap_create(const char *, char *); 303int pcap_set_snaplen(pcap_t *, int); 304int pcap_set_promisc(pcap_t *, int); 305int pcap_can_set_rfmon(pcap_t *); 306int pcap_set_rfmon(pcap_t *, int); 307int pcap_set_timeout(pcap_t *, int); 308int pcap_set_tstamp_type(pcap_t *, int); 309int pcap_set_immediate_mode(pcap_t *, int); 310int pcap_set_buffer_size(pcap_t *, int); 311int pcap_set_tstamp_precision(pcap_t *, int); 312int pcap_get_tstamp_precision(pcap_t *); 313int pcap_activate(pcap_t *); 314#ifdef __APPLE__ 315int pcap_apple_set_exthdr(pcap_t *p, int); 316#if PRIVATE 317/* 318 * To access DLT_PKPTAP, pcap_set_want_pktap() must be called before pcap_activate() 319 */ 320int pcap_set_want_pktap(pcap_t *, int); 321#endif /* PRIVATE */ 322#endif /* __APPLE__ */ 323 324int pcap_list_tstamp_types(pcap_t *, int **); 325void pcap_free_tstamp_types(int *); 326int pcap_tstamp_type_name_to_val(const char *); 327const char *pcap_tstamp_type_val_to_name(int); 328const char *pcap_tstamp_type_val_to_description(int); 329 330/* 331 * Time stamp types. 332 * Not all systems and interfaces will necessarily support all of these. 333 * 334 * A system that supports PCAP_TSTAMP_HOST is offering time stamps 335 * provided by the host machine, rather than by the capture device, 336 * but not committing to any characteristics of the time stamp; 337 * it will not offer any of the PCAP_TSTAMP_HOST_ subtypes. 338 * 339 * PCAP_TSTAMP_HOST_LOWPREC is a time stamp, provided by the host machine, 340 * that's low-precision but relatively cheap to fetch; it's normally done 341 * using the system clock, so it's normally synchronized with times you'd 342 * fetch from system calls. 343 * 344 * PCAP_TSTAMP_HOST_HIPREC is a time stamp, provided by the host machine, 345 * that's high-precision; it might be more expensive to fetch. It might 346 * or might not be synchronized with the system clock, and might have 347 * problems with time stamps for packets received on different CPUs, 348 * depending on the platform. 349 * 350 * PCAP_TSTAMP_ADAPTER is a high-precision time stamp supplied by the 351 * capture device; it's synchronized with the system clock. 352 * 353 * PCAP_TSTAMP_ADAPTER_UNSYNCED is a high-precision time stamp supplied by 354 * the capture device; it's not synchronized with the system clock. 355 * 356 * Note that time stamps synchronized with the system clock can go 357 * backwards, as the system clock can go backwards. If a clock is 358 * not in sync with the system clock, that could be because the 359 * system clock isn't keeping accurate time, because the other 360 * clock isn't keeping accurate time, or both. 361 * 362 * Note that host-provided time stamps generally correspond to the 363 * time when the time-stamping code sees the packet; this could 364 * be some unknown amount of time after the first or last bit of 365 * the packet is received by the network adapter, due to batching 366 * of interrupts for packet arrival, queueing delays, etc.. 367 */ 368#define PCAP_TSTAMP_HOST 0 /* host-provided, unknown characteristics */ 369#define PCAP_TSTAMP_HOST_LOWPREC 1 /* host-provided, low precision */ 370#define PCAP_TSTAMP_HOST_HIPREC 2 /* host-provided, high precision */ 371#define PCAP_TSTAMP_ADAPTER 3 /* device-provided, synced with the system clock */ 372#define PCAP_TSTAMP_ADAPTER_UNSYNCED 4 /* device-provided, not synced with the system clock */ 373 374/* 375 * Time stamp resolution types. 376 * Not all systems and interfaces will necessarily support all of these 377 * resolutions when doing live captures; all of them can be requested 378 * when reading a savefile. 379 */ 380#define PCAP_TSTAMP_PRECISION_MICRO 0 /* use timestamps with microsecond precision, default */ 381#define PCAP_TSTAMP_PRECISION_NANO 1 /* use timestamps with nanosecond precision */ 382 383pcap_t *pcap_open_live(const char *, int, int, int, char *); 384pcap_t *pcap_open_dead(int, int); 385pcap_t *pcap_open_dead_with_tstamp_precision(int, int, u_int); 386pcap_t *pcap_open_offline_with_tstamp_precision(const char *, u_int, char *); 387pcap_t *pcap_open_offline(const char *, char *); 388#if defined(WIN32) 389pcap_t *pcap_hopen_offline_with_tstamp_precision(intptr_t, u_int, char *); 390pcap_t *pcap_hopen_offline(intptr_t, char *); 391#if !defined(LIBPCAP_EXPORTS) 392#define pcap_fopen_offline_with_tstamp_precision(f,p,b) \ 393 pcap_hopen_offline_with_tstamp_precision(_get_osfhandle(_fileno(f)), p, b) 394#define pcap_fopen_offline(f,b) \ 395 pcap_hopen_offline(_get_osfhandle(_fileno(f)), b) 396#else /*LIBPCAP_EXPORTS*/ 397static pcap_t *pcap_fopen_offline_with_tstamp_precision(FILE *, u_int, char *); 398static pcap_t *pcap_fopen_offline(FILE *, char *); 399#endif 400#else /*WIN32*/ 401pcap_t *pcap_fopen_offline_with_tstamp_precision(FILE *, u_int, char *); 402pcap_t *pcap_fopen_offline(FILE *, char *); 403#endif /*WIN32*/ 404 405void pcap_close(pcap_t *); 406int pcap_loop(pcap_t *, int, pcap_handler, u_char *); 407int pcap_dispatch(pcap_t *, int, pcap_handler, u_char *); 408const u_char* 409 pcap_next(pcap_t *, struct pcap_pkthdr *); 410int pcap_next_ex(pcap_t *, struct pcap_pkthdr **, const u_char **); 411void pcap_breakloop(pcap_t *); 412int pcap_stats(pcap_t *, struct pcap_stat *); 413int pcap_setfilter(pcap_t *, struct bpf_program *); 414int pcap_setdirection(pcap_t *, pcap_direction_t); 415int pcap_getnonblock(pcap_t *, char *); 416int pcap_setnonblock(pcap_t *, int, char *); 417int pcap_inject(pcap_t *, const void *, size_t); 418int pcap_sendpacket(pcap_t *, const u_char *, int); 419const char *pcap_statustostr(int); 420const char *pcap_strerror(int); 421char *pcap_geterr(pcap_t *); 422void pcap_perror(pcap_t *, char *); 423int pcap_compile(pcap_t *, struct bpf_program *, const char *, int, 424 bpf_u_int32); 425int pcap_compile_nopcap(int, int, struct bpf_program *, 426 const char *, int, bpf_u_int32); 427void pcap_freecode(struct bpf_program *); 428int pcap_offline_filter(const struct bpf_program *, 429 const struct pcap_pkthdr *, const u_char *); 430int pcap_datalink(pcap_t *); 431int pcap_datalink_ext(pcap_t *); 432int pcap_list_datalinks(pcap_t *, int **); 433int pcap_set_datalink(pcap_t *, int); 434void pcap_free_datalinks(int *); 435int pcap_datalink_name_to_val(const char *); 436const char *pcap_datalink_val_to_name(int); 437const char *pcap_datalink_val_to_description(int); 438int pcap_snapshot(pcap_t *); 439int pcap_is_swapped(pcap_t *); 440int pcap_major_version(pcap_t *); 441int pcap_minor_version(pcap_t *); 442 443/* XXX */ 444FILE *pcap_file(pcap_t *); 445int pcap_fileno(pcap_t *); 446 447pcap_dumper_t *pcap_dump_open(pcap_t *, const char *); 448pcap_dumper_t *pcap_dump_fopen(pcap_t *, FILE *fp); 449FILE *pcap_dump_file(pcap_dumper_t *); 450long pcap_dump_ftell(pcap_dumper_t *); 451int pcap_dump_flush(pcap_dumper_t *); 452void pcap_dump_close(pcap_dumper_t *); 453void pcap_dump(u_char *, const struct pcap_pkthdr *, const u_char *); 454 455int pcap_findalldevs(pcap_if_t **, char *); 456void pcap_freealldevs(pcap_if_t *); 457 458const char *pcap_lib_version(void); 459 460/* 461 * On at least some versions of NetBSD, we don't want to declare 462 * bpf_filter() here, as it's also be declared in <net/bpf.h>, with a 463 * different signature, but, on other BSD-flavored UN*Xes, it's not 464 * declared in <net/bpf.h>, so we *do* want to declare it here, so it's 465 * declared when we build pcap-bpf.c. 466 */ 467#ifndef __NetBSD__ 468u_int bpf_filter(const struct bpf_insn *, const u_char *, u_int, u_int); 469#endif 470int bpf_validate(const struct bpf_insn *f, int len); 471char *bpf_image(const struct bpf_insn *, int); 472void bpf_dump(const struct bpf_program *, int); 473 474#if defined(WIN32) 475 476/* 477 * Win32 definitions 478 */ 479 480int pcap_setbuff(pcap_t *p, int dim); 481int pcap_setmode(pcap_t *p, int mode); 482int pcap_setmintocopy(pcap_t *p, int size); 483Adapter *pcap_get_adapter(pcap_t *p); 484 485#ifdef WPCAP 486/* Include file with the wpcap-specific extensions */ 487#include <Win32-Extensions.h> 488#endif /* WPCAP */ 489 490#define MODE_CAPT 0 491#define MODE_STAT 1 492#define MODE_MON 2 493 494#elif defined(MSDOS) 495 496/* 497 * MS-DOS definitions 498 */ 499 500int pcap_stats_ex (pcap_t *, struct pcap_stat_ex *); 501void pcap_set_wait (pcap_t *p, void (*yield)(void), int wait); 502u_long pcap_mac_packets (void); 503 504#else /* UN*X */ 505 506/* 507 * UN*X definitions 508 */ 509 510int pcap_get_selectable_fd(pcap_t *); 511 512#endif /* WIN32/MSDOS/UN*X */ 513 514#ifdef __cplusplus 515} 516#endif 517 518#endif /* lib_pcap_pcap_h */ 519