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