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$ 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 #include <net/bpf.h> 45 46 #include <stdio.h> 47 48 #ifdef __cplusplus 49 extern "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 62 typedef int bpf_int32; 63 typedef u_int bpf_u_int32; 64 #endif 65 66 typedef struct pcap pcap_t; 67 typedef struct pcap_dumper pcap_dumper_t; 68 typedef struct pcap_if pcap_if_t; 69 typedef 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 */ 105 struct 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 115 typedef enum { 116 PCAP_D_INOUT = 0, 117 PCAP_D_IN, 118 PCAP_D_OUT 119 } pcap_direction_t; 120 121 /* 122 * Generic per-packet information, as supplied by libpcap. 123 * 124 * The time stamp can and should be a "struct timeval", regardless of 125 * whether your system supports 32-bit tv_sec in "struct timeval", 126 * 64-bit tv_sec in "struct timeval", or both if it supports both 32-bit 127 * and 64-bit applications. The on-disk format of savefiles uses 32-bit 128 * tv_sec (and tv_usec); this structure is irrelevant to that. 32-bit 129 * and 64-bit versions of libpcap, even if they're on the same platform, 130 * should supply the appropriate version of "struct timeval", even if 131 * that's not what the underlying packet capture mechanism supplies. 132 */ 133 struct pcap_pkthdr { 134 struct timeval ts; /* time stamp */ 135 bpf_u_int32 caplen; /* length of portion present */ 136 bpf_u_int32 len; /* length this packet (off wire) */ 137 }; 138 139 /* 140 * As returned by the pcap_stats() 141 */ 142 struct pcap_stat { 143 u_int ps_recv; /* number of packets received */ 144 u_int ps_drop; /* number of packets dropped */ 145 u_int ps_ifdrop; /* drops by interface XXX not yet supported */ 146 #ifdef WIN32 147 u_int bs_capt; /* number of packets that reach the application */ 148 #endif /* WIN32 */ 149 }; 150 151 #ifdef MSDOS 152 /* 153 * As returned by the pcap_stats_ex() 154 */ 155 struct pcap_stat_ex { 156 u_long rx_packets; /* total packets received */ 157 u_long tx_packets; /* total packets transmitted */ 158 u_long rx_bytes; /* total bytes received */ 159 u_long tx_bytes; /* total bytes transmitted */ 160 u_long rx_errors; /* bad packets received */ 161 u_long tx_errors; /* packet transmit problems */ 162 u_long rx_dropped; /* no space in Rx buffers */ 163 u_long tx_dropped; /* no space available for Tx */ 164 u_long multicast; /* multicast packets received */ 165 u_long collisions; 166 167 /* detailed rx_errors: */ 168 u_long rx_length_errors; 169 u_long rx_over_errors; /* receiver ring buff overflow */ 170 u_long rx_crc_errors; /* recv'd pkt with crc error */ 171 u_long rx_frame_errors; /* recv'd frame alignment error */ 172 u_long rx_fifo_errors; /* recv'r fifo overrun */ 173 u_long rx_missed_errors; /* recv'r missed packet */ 174 175 /* detailed tx_errors */ 176 u_long tx_aborted_errors; 177 u_long tx_carrier_errors; 178 u_long tx_fifo_errors; 179 u_long tx_heartbeat_errors; 180 u_long tx_window_errors; 181 }; 182 #endif 183 184 /* 185 * Item in a list of interfaces. 186 */ 187 struct pcap_if { 188 struct pcap_if *next; 189 char *name; /* name to hand to "pcap_open_live()" */ 190 char *description; /* textual description of interface, or NULL */ 191 struct pcap_addr *addresses; 192 bpf_u_int32 flags; /* PCAP_IF_ interface flags */ 193 }; 194 195 #define PCAP_IF_LOOPBACK 0x00000001 /* interface is loopback */ 196 197 /* 198 * Representation of an interface address. 199 */ 200 struct pcap_addr { 201 struct pcap_addr *next; 202 struct sockaddr *addr; /* address */ 203 struct sockaddr *netmask; /* netmask for that address */ 204 struct sockaddr *broadaddr; /* broadcast address for that address */ 205 struct sockaddr *dstaddr; /* P2P destination address for that address */ 206 }; 207 208 typedef void (*pcap_handler)(u_char *, const struct pcap_pkthdr *, 209 const u_char *); 210 211 char *pcap_lookupdev(char *); 212 int pcap_lookupnet(const char *, bpf_u_int32 *, bpf_u_int32 *, char *); 213 pcap_t *pcap_open_live(const char *, int, int, int, char *); 214 pcap_t *pcap_open_dead(int, int); 215 pcap_t *pcap_open_offline(const char *, char *); 216 pcap_t *pcap_fopen_offline(FILE *, char *); 217 void pcap_close(pcap_t *); 218 int pcap_loop(pcap_t *, int, pcap_handler, u_char *); 219 int pcap_dispatch(pcap_t *, int, pcap_handler, u_char *); 220 const u_char* 221 pcap_next(pcap_t *, struct pcap_pkthdr *); 222 int pcap_next_ex(pcap_t *, struct pcap_pkthdr **, const u_char **); 223 void pcap_breakloop(pcap_t *); 224 int pcap_stats(pcap_t *, struct pcap_stat *); 225 int pcap_setfilter(pcap_t *, struct bpf_program *); 226 int pcap_setdirection(pcap_t *, pcap_direction_t); 227 int pcap_getnonblock(pcap_t *, char *); 228 int pcap_setnonblock(pcap_t *, int, char *); 229 void pcap_perror(pcap_t *, char *); 230 int pcap_inject(pcap_t *, const void *, size_t); 231 int pcap_sendpacket(pcap_t *, const u_char *, int); 232 const char *pcap_strerror(int); 233 char *pcap_geterr(pcap_t *); 234 int pcap_compile(pcap_t *, struct bpf_program *, const char *, int, 235 bpf_u_int32); 236 int pcap_compile_nopcap(int, int, struct bpf_program *, 237 const char *, int, bpf_u_int32); 238 void pcap_freecode(struct bpf_program *); 239 int pcap_datalink(pcap_t *); 240 int pcap_list_datalinks(pcap_t *, int **); 241 int pcap_set_datalink(pcap_t *, int); 242 int pcap_datalink_name_to_val(const char *); 243 const char *pcap_datalink_val_to_name(int); 244 const char *pcap_datalink_val_to_description(int); 245 int pcap_snapshot(pcap_t *); 246 int pcap_is_swapped(pcap_t *); 247 int pcap_major_version(pcap_t *); 248 int pcap_minor_version(pcap_t *); 249 250 /* XXX */ 251 FILE *pcap_file(pcap_t *); 252 int pcap_fileno(pcap_t *); 253 254 pcap_dumper_t *pcap_dump_open(pcap_t *, const char *); 255 pcap_dumper_t *pcap_dump_fopen(pcap_t *, FILE *fp); 256 FILE *pcap_dump_file(pcap_dumper_t *); 257 long pcap_dump_ftell(pcap_dumper_t *); 258 int pcap_dump_flush(pcap_dumper_t *); 259 void pcap_dump_close(pcap_dumper_t *); 260 void pcap_dump(u_char *, const struct pcap_pkthdr *, const u_char *); 261 262 int pcap_findalldevs(pcap_if_t **, char *); 263 void pcap_freealldevs(pcap_if_t *); 264 265 const char *pcap_lib_version(void); 266 267 /* XXX this guy lives in the bpf tree */ 268 u_int bpf_filter(struct bpf_insn *, u_char *, u_int, u_int); 269 int bpf_validate(struct bpf_insn *f, int len); 270 char *bpf_image(struct bpf_insn *, int); 271 void bpf_dump(struct bpf_program *, int); 272 273 #if defined(WIN32) 274 275 /* 276 * Win32 definitions 277 */ 278 279 int pcap_setbuff(pcap_t *p, int dim); 280 int pcap_setmode(pcap_t *p, int mode); 281 int pcap_setmintocopy(pcap_t *p, int size); 282 283 #ifdef WPCAP 284 /* Include file with the wpcap-specific extensions */ 285 #include <Win32-Extensions.h> 286 #endif /* WPCAP */ 287 288 #define MODE_CAPT 0 289 #define MODE_STAT 1 290 #define MODE_MON 2 291 292 #elif defined(MSDOS) 293 294 /* 295 * MS-DOS definitions 296 */ 297 298 int pcap_stats_ex (pcap_t *, struct pcap_stat_ex *); 299 void pcap_set_wait (pcap_t *p, void (*yield)(void), int wait); 300 u_long pcap_mac_packets (void); 301 302 #else /* UN*X */ 303 304 /* 305 * UN*X definitions 306 */ 307 308 int pcap_get_selectable_fd(pcap_t *); 309 310 #endif /* WIN32/MSDOS/UN*X */ 311 312 #ifdef __cplusplus 313 } 314 #endif 315 316 #endif 317