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