pcap.h revision 172680
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 * $FreeBSD: head/contrib/libpcap/pcap.h 172680 2007-10-16 02:07:55Z mlaier $ 35 * @(#) $Header: /tcpdump/master/libpcap/pcap.h,v 1.52.2.7 2007/06/11 09:52:05 guy Exp $ (LBL) 36 */ 37 38#ifndef lib_pcap_h 39#define lib_pcap_h 40 41#include <sys/types.h> 42#include <sys/time.h> 43 44#ifndef PCAP_DONT_INCLUDE_PCAP_BPF_H 45#include <pcap-bpf.h> 46#endif 47 48#include <stdio.h> 49 50#ifdef __cplusplus 51extern "C" { 52#endif 53 54#define PCAP_VERSION_MAJOR 2 55#define PCAP_VERSION_MINOR 4 56 57#define PCAP_ERRBUF_SIZE 256 58 59/* 60 * Compatibility for systems that have a bpf.h that 61 * predates the bpf typedefs for 64-bit support. 62 */ 63#if BPF_RELEASE - 0 < 199406 64typedef int bpf_int32; 65typedef u_int bpf_u_int32; 66#endif 67 68typedef struct pcap pcap_t; 69typedef struct pcap_dumper pcap_dumper_t; 70typedef struct pcap_if pcap_if_t; 71typedef struct pcap_addr pcap_addr_t; 72 73/* 74 * The first record in the file contains saved values for some 75 * of the flags used in the printout phases of tcpdump. 76 * Many fields here are 32 bit ints so compilers won't insert unwanted 77 * padding; these files need to be interchangeable across architectures. 78 * 79 * Do not change the layout of this structure, in any way (this includes 80 * changes that only affect the length of fields in this structure). 81 * 82 * Also, do not change the interpretation of any of the members of this 83 * structure, in any way (this includes using values other than 84 * LINKTYPE_ values, as defined in "savefile.c", in the "linktype" 85 * field). 86 * 87 * Instead: 88 * 89 * introduce a new structure for the new format, if the layout 90 * of the structure changed; 91 * 92 * send mail to "tcpdump-workers@tcpdump.org", requesting a new 93 * magic number for your new capture file format, and, when 94 * you get the new magic number, put it in "savefile.c"; 95 * 96 * use that magic number for save files with the changed file 97 * header; 98 * 99 * make the code in "savefile.c" capable of reading files with 100 * the old file header as well as files with the new file header 101 * (using the magic number to determine the header format). 102 * 103 * Then supply the changes to "patches@tcpdump.org", so that future 104 * versions of libpcap and programs that use it (such as tcpdump) will 105 * be able to read your new capture file format. 106 */ 107struct pcap_file_header { 108 bpf_u_int32 magic; 109 u_short version_major; 110 u_short version_minor; 111 bpf_int32 thiszone; /* gmt to local correction */ 112 bpf_u_int32 sigfigs; /* accuracy of timestamps */ 113 bpf_u_int32 snaplen; /* max length saved portion of each pkt */ 114 bpf_u_int32 linktype; /* data link type (LINKTYPE_*) */ 115}; 116 117typedef enum { 118 PCAP_D_INOUT = 0, 119 PCAP_D_IN, 120 PCAP_D_OUT 121} pcap_direction_t; 122 123/* 124 * Generic per-packet information, as supplied by libpcap. 125 * 126 * The time stamp can and should be a "struct timeval", regardless of 127 * whether your system supports 32-bit tv_sec in "struct timeval", 128 * 64-bit tv_sec in "struct timeval", or both if it supports both 32-bit 129 * and 64-bit applications. The on-disk format of savefiles uses 32-bit 130 * tv_sec (and tv_usec); this structure is irrelevant to that. 32-bit 131 * and 64-bit versions of libpcap, even if they're on the same platform, 132 * should supply the appropriate version of "struct timeval", even if 133 * that's not what the underlying packet capture mechanism supplies. 134 */ 135struct pcap_pkthdr { 136 struct timeval ts; /* time stamp */ 137 bpf_u_int32 caplen; /* length of portion present */ 138 bpf_u_int32 len; /* length this packet (off wire) */ 139}; 140 141/* 142 * As returned by the pcap_stats() 143 */ 144struct pcap_stat { 145 u_int ps_recv; /* number of packets received */ 146 u_int ps_drop; /* number of packets dropped */ 147 u_int ps_ifdrop; /* drops by interface XXX not yet supported */ 148#ifdef WIN32 149 u_int bs_capt; /* number of packets that reach the application */ 150#endif /* WIN32 */ 151}; 152 153#ifdef MSDOS 154/* 155 * As returned by the pcap_stats_ex() 156 */ 157struct pcap_stat_ex { 158 u_long rx_packets; /* total packets received */ 159 u_long tx_packets; /* total packets transmitted */ 160 u_long rx_bytes; /* total bytes received */ 161 u_long tx_bytes; /* total bytes transmitted */ 162 u_long rx_errors; /* bad packets received */ 163 u_long tx_errors; /* packet transmit problems */ 164 u_long rx_dropped; /* no space in Rx buffers */ 165 u_long tx_dropped; /* no space available for Tx */ 166 u_long multicast; /* multicast packets received */ 167 u_long collisions; 168 169 /* detailed rx_errors: */ 170 u_long rx_length_errors; 171 u_long rx_over_errors; /* receiver ring buff overflow */ 172 u_long rx_crc_errors; /* recv'd pkt with crc error */ 173 u_long rx_frame_errors; /* recv'd frame alignment error */ 174 u_long rx_fifo_errors; /* recv'r fifo overrun */ 175 u_long rx_missed_errors; /* recv'r missed packet */ 176 177 /* detailed tx_errors */ 178 u_long tx_aborted_errors; 179 u_long tx_carrier_errors; 180 u_long tx_fifo_errors; 181 u_long tx_heartbeat_errors; 182 u_long tx_window_errors; 183 }; 184#endif 185 186/* 187 * Item in a list of interfaces. 188 */ 189struct pcap_if { 190 struct pcap_if *next; 191 char *name; /* name to hand to "pcap_open_live()" */ 192 char *description; /* textual description of interface, or NULL */ 193 struct pcap_addr *addresses; 194 bpf_u_int32 flags; /* PCAP_IF_ interface flags */ 195}; 196 197#define PCAP_IF_LOOPBACK 0x00000001 /* interface is loopback */ 198 199/* 200 * Representation of an interface address. 201 */ 202struct pcap_addr { 203 struct pcap_addr *next; 204 struct sockaddr *addr; /* address */ 205 struct sockaddr *netmask; /* netmask for that address */ 206 struct sockaddr *broadaddr; /* broadcast address for that address */ 207 struct sockaddr *dstaddr; /* P2P destination address for that address */ 208}; 209 210typedef void (*pcap_handler)(u_char *, const struct pcap_pkthdr *, 211 const u_char *); 212 213char *pcap_lookupdev(char *); 214int pcap_lookupnet(const char *, bpf_u_int32 *, bpf_u_int32 *, char *); 215pcap_t *pcap_open_live(const char *, int, int, int, char *); 216pcap_t *pcap_open_dead(int, int); 217pcap_t *pcap_open_offline(const char *, char *); 218pcap_t *pcap_fopen_offline(FILE *, char *); 219void pcap_close(pcap_t *); 220int pcap_loop(pcap_t *, int, pcap_handler, u_char *); 221int pcap_dispatch(pcap_t *, int, pcap_handler, u_char *); 222const u_char* 223 pcap_next(pcap_t *, struct pcap_pkthdr *); 224int pcap_next_ex(pcap_t *, struct pcap_pkthdr **, const u_char **); 225void pcap_breakloop(pcap_t *); 226int pcap_stats(pcap_t *, struct pcap_stat *); 227int pcap_setfilter(pcap_t *, struct bpf_program *); 228int pcap_setdirection(pcap_t *, pcap_direction_t); 229int pcap_getnonblock(pcap_t *, char *); 230int pcap_setnonblock(pcap_t *, int, char *); 231void pcap_perror(pcap_t *, char *); 232int pcap_inject(pcap_t *, const void *, size_t); 233int pcap_sendpacket(pcap_t *, const u_char *, int); 234const char *pcap_strerror(int); 235char *pcap_geterr(pcap_t *); 236int pcap_compile(pcap_t *, struct bpf_program *, const char *, int, 237 bpf_u_int32); 238int pcap_compile_nopcap(int, int, struct bpf_program *, 239 const char *, int, bpf_u_int32); 240void pcap_freecode(struct bpf_program *); 241int pcap_datalink(pcap_t *); 242int pcap_list_datalinks(pcap_t *, int **); 243int pcap_set_datalink(pcap_t *, int); 244int pcap_datalink_name_to_val(const char *); 245const char *pcap_datalink_val_to_name(int); 246const char *pcap_datalink_val_to_description(int); 247int pcap_snapshot(pcap_t *); 248int pcap_is_swapped(pcap_t *); 249int pcap_major_version(pcap_t *); 250int pcap_minor_version(pcap_t *); 251 252/* XXX */ 253FILE *pcap_file(pcap_t *); 254int pcap_fileno(pcap_t *); 255 256pcap_dumper_t *pcap_dump_open(pcap_t *, const char *); 257pcap_dumper_t *pcap_dump_fopen(pcap_t *, FILE *fp); 258FILE *pcap_dump_file(pcap_dumper_t *); 259long pcap_dump_ftell(pcap_dumper_t *); 260int pcap_dump_flush(pcap_dumper_t *); 261void pcap_dump_close(pcap_dumper_t *); 262void pcap_dump(u_char *, const struct pcap_pkthdr *, const u_char *); 263 264int pcap_findalldevs(pcap_if_t **, char *); 265void pcap_freealldevs(pcap_if_t *); 266 267const char *pcap_lib_version(void); 268 269/* XXX this guy lives in the bpf tree */ 270u_int bpf_filter(struct bpf_insn *, u_char *, u_int, u_int); 271int bpf_validate(struct bpf_insn *f, int len); 272char *bpf_image(struct bpf_insn *, int); 273void bpf_dump(struct bpf_program *, int); 274 275#if defined(WIN32) 276 277/* 278 * Win32 definitions 279 */ 280 281int pcap_setbuff(pcap_t *p, int dim); 282int pcap_setmode(pcap_t *p, int mode); 283int pcap_setmintocopy(pcap_t *p, int size); 284 285#ifdef WPCAP 286/* Include file with the wpcap-specific extensions */ 287#include <Win32-Extensions.h> 288#endif /* WPCAP */ 289 290#define MODE_CAPT 0 291#define MODE_STAT 1 292#define MODE_MON 2 293 294#elif defined(MSDOS) 295 296/* 297 * MS-DOS definitions 298 */ 299 300int pcap_stats_ex (pcap_t *, struct pcap_stat_ex *); 301void pcap_set_wait (pcap_t *p, void (*yield)(void), int wait); 302u_long pcap_mac_packets (void); 303 304#else /* UN*X */ 305 306/* 307 * UN*X definitions 308 */ 309 310int pcap_get_selectable_fd(pcap_t *); 311 312#endif /* WIN32/MSDOS/UN*X */ 313 314#ifdef __cplusplus 315} 316#endif 317 318#endif 319