1/* -*- Mode: c; tab-width: 8; indent-tabs-mode: 1; c-basic-offset: 8; -*- */ 2/* 3 * Copyright (c) 1993, 1994, 1995, 1996, 1997 4 * The Regents of the University of California. All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 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. 21 * 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 32 * SUCH DAMAGE. 33 * 34 * @(#) Header: /tcpdump/master/libpcap/pcap/pcap.h,v 1.15 2008-10-06 15:27:32 gianluca Exp (LBL) 35 */ 36 37#ifndef lib_pcap_pcap_h 38#define lib_pcap_pcap_h 39 40#if defined(WIN32) 41 #include <pcap-stdinc.h> 42#elif defined(MSDOS) 43 #include <sys/types.h> 44 #include <sys/socket.h> /* u_int, u_char etc. */ 45#else /* UN*X */ 46 #include <sys/types.h> 47 #include <sys/time.h> 48#endif /* WIN32/MSDOS/UN*X */ 49 50#ifndef PCAP_DONT_INCLUDE_PCAP_BPF_H 51#include <pcap/bpf.h> 52#else 53#include <net/bpf.h> 54#endif 55 56#include <stdio.h> 57 58#ifdef __cplusplus 59extern "C" { 60#endif 61 62/* 63 * Version number of the current version of the pcap file format. 64 * 65 * NOTE: this is *NOT* the version number of the libpcap library. 66 * To fetch the version information for the version of libpcap 67 * you're using, use pcap_lib_version(). 68 */ 69#define PCAP_VERSION_MAJOR 2 70#define PCAP_VERSION_MINOR 4 71 72#define PCAP_ERRBUF_SIZE 256 73 74/* 75 * Compatibility for systems that have a bpf.h that 76 * predates the bpf typedefs for 64-bit support. 77 */ 78#if BPF_RELEASE - 0 < 199406 79typedef int bpf_int32; 80typedef u_int bpf_u_int32; 81#endif 82 83typedef struct pcap pcap_t; 84typedef struct pcap_dumper pcap_dumper_t; 85typedef struct pcap_if pcap_if_t; 86typedef struct pcap_addr pcap_addr_t; 87 88/* 89 * The first record in the file contains saved values for some 90 * of the flags used in the printout phases of tcpdump. 91 * Many fields here are 32 bit ints so compilers won't insert unwanted 92 * padding; these files need to be interchangeable across architectures. 93 * 94 * Do not change the layout of this structure, in any way (this includes 95 * changes that only affect the length of fields in this structure). 96 * 97 * Also, do not change the interpretation of any of the members of this 98 * structure, in any way (this includes using values other than 99 * LINKTYPE_ values, as defined in "savefile.c", in the "linktype" 100 * field). 101 * 102 * Instead: 103 * 104 * introduce a new structure for the new format, if the layout 105 * of the structure changed; 106 * 107 * send mail to "tcpdump-workers@lists.tcpdump.org", requesting 108 * a new magic number for your new capture file format, and, when 109 * you get the new magic number, put it in "savefile.c"; 110 * 111 * use that magic number for save files with the changed file 112 * header; 113 * 114 * make the code in "savefile.c" capable of reading files with 115 * the old file header as well as files with the new file header 116 * (using the magic number to determine the header format). 117 * 118 * Then supply the changes as a patch at 119 * 120 * http://sourceforge.net/projects/libpcap/ 121 * 122 * so that future versions of libpcap and programs that use it (such as 123 * tcpdump) will be able to read your new capture file format. 124 */ 125struct pcap_file_header { 126 bpf_u_int32 magic; 127 u_short version_major; 128 u_short version_minor; 129 bpf_int32 thiszone; /* gmt to local correction */ 130 bpf_u_int32 sigfigs; /* accuracy of timestamps */ 131 bpf_u_int32 snaplen; /* max length saved portion of each pkt */ 132 bpf_u_int32 linktype; /* data link type (LINKTYPE_*) */ 133}; 134 135/* 136 * Macros for the value returned by pcap_datalink_ext(). 137 * 138 * If LT_FCS_LENGTH_PRESENT(x) is true, the LT_FCS_LENGTH(x) macro 139 * gives the FCS length of packets in the capture. 140 */ 141#define LT_FCS_LENGTH_PRESENT(x) ((x) & 0x04000000) 142#define LT_FCS_LENGTH(x) (((x) & 0xF0000000) >> 28) 143#define LT_FCS_DATALINK_EXT(x) ((((x) & 0xF) << 28) | 0x04000000) 144 145typedef enum { 146 PCAP_D_INOUT = 0, 147 PCAP_D_IN, 148 PCAP_D_OUT 149} pcap_direction_t; 150 151/* 152 * Generic per-packet information, as supplied by libpcap. 153 * 154 * The time stamp can and should be a "struct timeval", regardless of 155 * whether your system supports 32-bit tv_sec in "struct timeval", 156 * 64-bit tv_sec in "struct timeval", or both if it supports both 32-bit 157 * and 64-bit applications. The on-disk format of savefiles uses 32-bit 158 * tv_sec (and tv_usec); this structure is irrelevant to that. 32-bit 159 * and 64-bit versions of libpcap, even if they're on the same platform, 160 * should supply the appropriate version of "struct timeval", even if 161 * that's not what the underlying packet capture mechanism supplies. 162 */ 163struct pcap_pkthdr { 164 struct timeval ts; /* time stamp */ 165 bpf_u_int32 caplen; /* length of portion present */ 166 bpf_u_int32 len; /* length this packet (off wire) */ 167}; 168 169/* 170 * As returned by the pcap_stats() 171 */ 172struct pcap_stat { 173 u_int ps_recv; /* number of packets received */ 174 u_int ps_drop; /* number of packets dropped */ 175 u_int ps_ifdrop; /* drops by interface -- only supported on some platforms */ 176#ifdef WIN32 177 u_int bs_capt; /* number of packets that reach the application */ 178#endif /* WIN32 */ 179}; 180 181#ifdef MSDOS 182/* 183 * As returned by the pcap_stats_ex() 184 */ 185struct pcap_stat_ex { 186 u_long rx_packets; /* total packets received */ 187 u_long tx_packets; /* total packets transmitted */ 188 u_long rx_bytes; /* total bytes received */ 189 u_long tx_bytes; /* total bytes transmitted */ 190 u_long rx_errors; /* bad packets received */ 191 u_long tx_errors; /* packet transmit problems */ 192 u_long rx_dropped; /* no space in Rx buffers */ 193 u_long tx_dropped; /* no space available for Tx */ 194 u_long multicast; /* multicast packets received */ 195 u_long collisions; 196 197 /* detailed rx_errors: */ 198 u_long rx_length_errors; 199 u_long rx_over_errors; /* receiver ring buff overflow */ 200 u_long rx_crc_errors; /* recv'd pkt with crc error */ 201 u_long rx_frame_errors; /* recv'd frame alignment error */ 202 u_long rx_fifo_errors; /* recv'r fifo overrun */ 203 u_long rx_missed_errors; /* recv'r missed packet */ 204 205 /* detailed tx_errors */ 206 u_long tx_aborted_errors; 207 u_long tx_carrier_errors; 208 u_long tx_fifo_errors; 209 u_long tx_heartbeat_errors; 210 u_long tx_window_errors; 211 }; 212#endif 213 214/* 215 * Item in a list of interfaces. 216 */ 217struct pcap_if { 218 struct pcap_if *next; 219 char *name; /* name to hand to "pcap_open_live()" */ 220 char *description; /* textual description of interface, or NULL */ 221 struct pcap_addr *addresses; 222 bpf_u_int32 flags; /* PCAP_IF_ interface flags */ 223}; 224 225#define PCAP_IF_LOOPBACK 0x00000001 /* interface is loopback */ 226 227/* 228 * Representation of an interface address. 229 */ 230struct pcap_addr { 231 struct pcap_addr *next; 232 struct sockaddr *addr; /* address */ 233 struct sockaddr *netmask; /* netmask for that address */ 234 struct sockaddr *broadaddr; /* broadcast address for that address */ 235 struct sockaddr *dstaddr; /* P2P destination address for that address */ 236}; 237 238typedef void (*pcap_handler)(u_char *, const struct pcap_pkthdr *, 239 const u_char *); 240 241/* 242 * Error codes for the pcap API. 243 * These will all be negative, so you can check for the success or 244 * failure of a call that returns these codes by checking for a 245 * negative value. 246 */ 247#define PCAP_ERROR -1 /* generic error code */ 248#define PCAP_ERROR_BREAK -2 /* loop terminated by pcap_breakloop */ 249#define PCAP_ERROR_NOT_ACTIVATED -3 /* the capture needs to be activated */ 250#define PCAP_ERROR_ACTIVATED -4 /* the operation can't be performed on already activated captures */ 251#define PCAP_ERROR_NO_SUCH_DEVICE -5 /* no such device exists */ 252#define PCAP_ERROR_RFMON_NOTSUP -6 /* this device doesn't support rfmon (monitor) mode */ 253#define PCAP_ERROR_NOT_RFMON -7 /* operation supported only in monitor mode */ 254#define PCAP_ERROR_PERM_DENIED -8 /* no permission to open the device */ 255#define PCAP_ERROR_IFACE_NOT_UP -9 /* interface isn't up */ 256 257/* 258 * Warning codes for the pcap API. 259 * These will all be positive and non-zero, so they won't look like 260 * errors. 261 */ 262#define PCAP_WARNING 1 /* generic warning code */ 263#define PCAP_WARNING_PROMISC_NOTSUP 2 /* this device doesn't support promiscuous mode */ 264 265/* 266 * Value to pass to pcap_compile() as the netmask if you don't know what 267 * the netmask is. 268 */ 269#define PCAP_NETMASK_UNKNOWN 0xffffffff 270 271char *pcap_lookupdev(char *); 272int pcap_lookupnet(const char *, bpf_u_int32 *, bpf_u_int32 *, char *); 273 274pcap_t *pcap_create(const char *, char *); 275int pcap_set_snaplen(pcap_t *, int); 276int pcap_set_promisc(pcap_t *, int); 277int pcap_can_set_rfmon(pcap_t *); 278int pcap_set_rfmon(pcap_t *, int); 279int pcap_set_timeout(pcap_t *, int); 280int pcap_set_buffer_size(pcap_t *, int); 281int pcap_activate(pcap_t *); 282 283pcap_t *pcap_open_live(const char *, int, int, int, char *); 284pcap_t *pcap_open_dead(int, int); 285pcap_t *pcap_open_offline(const char *, char *); 286#if defined(WIN32) 287pcap_t *pcap_hopen_offline(intptr_t, char *); 288#if !defined(LIBPCAP_EXPORTS) 289#define pcap_fopen_offline(f,b) \ 290 pcap_hopen_offline(_get_osfhandle(_fileno(f)), b) 291#else /*LIBPCAP_EXPORTS*/ 292static pcap_t *pcap_fopen_offline(FILE *, char *); 293#endif 294#else /*WIN32*/ 295pcap_t *pcap_fopen_offline(FILE *, char *); 296#endif /*WIN32*/ 297 298void pcap_close(pcap_t *); 299int pcap_loop(pcap_t *, int, pcap_handler, u_char *); 300int pcap_dispatch(pcap_t *, int, pcap_handler, u_char *); 301const u_char* 302 pcap_next(pcap_t *, struct pcap_pkthdr *); 303int pcap_next_ex(pcap_t *, struct pcap_pkthdr **, const u_char **); 304void pcap_breakloop(pcap_t *); 305int pcap_stats(pcap_t *, struct pcap_stat *); 306int pcap_setfilter(pcap_t *, struct bpf_program *); 307int pcap_setdirection(pcap_t *, pcap_direction_t); 308int pcap_getnonblock(pcap_t *, char *); 309int pcap_setnonblock(pcap_t *, int, char *); 310int pcap_inject(pcap_t *, const void *, size_t); 311int pcap_sendpacket(pcap_t *, const u_char *, int); 312const char *pcap_statustostr(int); 313const char *pcap_strerror(int); 314char *pcap_geterr(pcap_t *); 315void pcap_perror(pcap_t *, char *); 316int pcap_compile(pcap_t *, struct bpf_program *, const char *, int, 317 bpf_u_int32); 318int pcap_compile_nopcap(int, int, struct bpf_program *, 319 const char *, int, bpf_u_int32); 320void pcap_freecode(struct bpf_program *); 321int pcap_offline_filter(struct bpf_program *, const struct pcap_pkthdr *, 322 const u_char *); 323int pcap_datalink(pcap_t *); 324int pcap_datalink_ext(pcap_t *); 325int pcap_list_datalinks(pcap_t *, int **); 326int pcap_set_datalink(pcap_t *, int); 327void pcap_free_datalinks(int *); 328int pcap_datalink_name_to_val(const char *); 329const char *pcap_datalink_val_to_name(int); 330const char *pcap_datalink_val_to_description(int); 331int pcap_snapshot(pcap_t *); 332int pcap_is_swapped(pcap_t *); 333int pcap_major_version(pcap_t *); 334int pcap_minor_version(pcap_t *); 335 336/* XXX */ 337FILE *pcap_file(pcap_t *); 338int pcap_fileno(pcap_t *); 339 340pcap_dumper_t *pcap_dump_open(pcap_t *, const char *); 341pcap_dumper_t *pcap_dump_fopen(pcap_t *, FILE *fp); 342FILE *pcap_dump_file(pcap_dumper_t *); 343long pcap_dump_ftell(pcap_dumper_t *); 344int pcap_dump_flush(pcap_dumper_t *); 345void pcap_dump_close(pcap_dumper_t *); 346void pcap_dump(u_char *, const struct pcap_pkthdr *, const u_char *); 347 348int pcap_findalldevs(pcap_if_t **, char *); 349void pcap_freealldevs(pcap_if_t *); 350 351const char *pcap_lib_version(void); 352 353/* XXX this guy lives in the bpf tree */ 354u_int bpf_filter(const struct bpf_insn *, const u_char *, u_int, u_int); 355int bpf_validate(const struct bpf_insn *f, int len); 356char *bpf_image(const struct bpf_insn *, int); 357void bpf_dump(const struct bpf_program *, int); 358 359#if defined(WIN32) 360 361/* 362 * Win32 definitions 363 */ 364 365int pcap_setbuff(pcap_t *p, int dim); 366int pcap_setmode(pcap_t *p, int mode); 367int pcap_setmintocopy(pcap_t *p, int size); 368 369#ifdef WPCAP 370/* Include file with the wpcap-specific extensions */ 371#include <Win32-Extensions.h> 372#endif /* WPCAP */ 373 374#define MODE_CAPT 0 375#define MODE_STAT 1 376#define MODE_MON 2 377 378#elif defined(MSDOS) 379 380/* 381 * MS-DOS definitions 382 */ 383 384int pcap_stats_ex (pcap_t *, struct pcap_stat_ex *); 385void pcap_set_wait (pcap_t *p, void (*yield)(void), int wait); 386u_long pcap_mac_packets (void); 387 388#else /* UN*X */ 389 390/* 391 * UN*X definitions 392 */ 393 394int pcap_get_selectable_fd(pcap_t *); 395 396#endif /* WIN32/MSDOS/UN*X */ 397 398#ifdef __cplusplus 399} 400#endif 401 402#endif 403