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.4.2.11 2008-10-06 15:38:39 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 <net/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@lists.tcpdump.org", requesting 99 * a new 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 as a patch at 110 * 111 * http://sourceforge.net/projects/libpcap/ 112 * 113 * so that future versions of libpcap and programs that use it (such as 114 * tcpdump) will be able to read your new capture file format. 115 */ 116 struct pcap_file_header { 117 bpf_u_int32 magic; 118 u_short version_major; 119 u_short version_minor; 120 bpf_int32 thiszone; /* gmt to local correction */ 121 bpf_u_int32 sigfigs; /* accuracy of timestamps */ 122 bpf_u_int32 snaplen; /* max length saved portion of each pkt */ 123 bpf_u_int32 linktype; /* data link type (LINKTYPE_*) */ 124 }; 125 126 /* 127 * Macros for the value returned by pcap_datalink_ext(). 128 * 129 * If LT_FCS_LENGTH_PRESENT(x) is true, the LT_FCS_LENGTH(x) macro 130 * gives the FCS length of packets in the capture. 131 */ 132 #define LT_FCS_LENGTH_PRESENT(x) ((x) & 0x04000000) 133 #define LT_FCS_LENGTH(x) (((x) & 0xF0000000) >> 28) 134 #define LT_FCS_DATALINK_EXT(x) ((((x) & 0xF) << 28) | 0x04000000) 135 136 typedef enum { 137 PCAP_D_INOUT = 0, 138 PCAP_D_IN, 139 PCAP_D_OUT 140 } pcap_direction_t; 141 142 /* 143 * Generic per-packet information, as supplied by libpcap. 144 * 145 * The time stamp can and should be a "struct timeval", regardless of 146 * whether your system supports 32-bit tv_sec in "struct timeval", 147 * 64-bit tv_sec in "struct timeval", or both if it supports both 32-bit 148 * and 64-bit applications. The on-disk format of savefiles uses 32-bit 149 * tv_sec (and tv_usec); this structure is irrelevant to that. 32-bit 150 * and 64-bit versions of libpcap, even if they're on the same platform, 151 * should supply the appropriate version of "struct timeval", even if 152 * that's not what the underlying packet capture mechanism supplies. 153 */ 154 struct pcap_pkthdr { 155 struct timeval ts; /* time stamp */ 156 bpf_u_int32 caplen; /* length of portion present */ 157 bpf_u_int32 len; /* length this packet (off wire) */ 158 }; 159 160 /* 161 * As returned by the pcap_stats() 162 */ 163 struct pcap_stat { 164 u_int ps_recv; /* number of packets received */ 165 u_int ps_drop; /* number of packets dropped */ 166 u_int ps_ifdrop; /* drops by interface XXX not yet supported */ 167 #ifdef WIN32 168 u_int bs_capt; /* number of packets that reach the application */ 169 #endif /* WIN32 */ 170 }; 171 172 #ifdef MSDOS 173 /* 174 * As returned by the pcap_stats_ex() 175 */ 176 struct pcap_stat_ex { 177 u_long rx_packets; /* total packets received */ 178 u_long tx_packets; /* total packets transmitted */ 179 u_long rx_bytes; /* total bytes received */ 180 u_long tx_bytes; /* total bytes transmitted */ 181 u_long rx_errors; /* bad packets received */ 182 u_long tx_errors; /* packet transmit problems */ 183 u_long rx_dropped; /* no space in Rx buffers */ 184 u_long tx_dropped; /* no space available for Tx */ 185 u_long multicast; /* multicast packets received */ 186 u_long collisions; 187 188 /* detailed rx_errors: */ 189 u_long rx_length_errors; 190 u_long rx_over_errors; /* receiver ring buff overflow */ 191 u_long rx_crc_errors; /* recv'd pkt with crc error */ 192 u_long rx_frame_errors; /* recv'd frame alignment error */ 193 u_long rx_fifo_errors; /* recv'r fifo overrun */ 194 u_long rx_missed_errors; /* recv'r missed packet */ 195 196 /* detailed tx_errors */ 197 u_long tx_aborted_errors; 198 u_long tx_carrier_errors; 199 u_long tx_fifo_errors; 200 u_long tx_heartbeat_errors; 201 u_long tx_window_errors; 202 }; 203 #endif 204 205 /* 206 * Item in a list of interfaces. 207 */ 208 struct pcap_if { 209 struct pcap_if *next; 210 char *name; /* name to hand to "pcap_open_live()" */ 211 char *description; /* textual description of interface, or NULL */ 212 struct pcap_addr *addresses; 213 bpf_u_int32 flags; /* PCAP_IF_ interface flags */ 214 }; 215 216 #define PCAP_IF_LOOPBACK 0x00000001 /* interface is loopback */ 217 218 /* 219 * Representation of an interface address. 220 */ 221 struct pcap_addr { 222 struct pcap_addr *next; 223 struct sockaddr *addr; /* address */ 224 struct sockaddr *netmask; /* netmask for that address */ 225 struct sockaddr *broadaddr; /* broadcast address for that address */ 226 struct sockaddr *dstaddr; /* P2P destination address for that address */ 227 }; 228 229 typedef void (*pcap_handler)(u_char *, const struct pcap_pkthdr *, 230 const u_char *); 231 232 /* 233 * Error codes for the pcap API. 234 * These will all be negative, so you can check for the success or 235 * failure of a call that returns these codes by checking for a 236 * negative value. 237 */ 238 #define PCAP_ERROR -1 /* generic error code */ 239 #define PCAP_ERROR_BREAK -2 /* loop terminated by pcap_breakloop */ 240 #define PCAP_ERROR_NOT_ACTIVATED -3 /* the capture needs to be activated */ 241 #define PCAP_ERROR_ACTIVATED -4 /* the operation can't be performed on already activated captures */ 242 #define PCAP_ERROR_NO_SUCH_DEVICE -5 /* no such device exists */ 243 #define PCAP_ERROR_RFMON_NOTSUP -6 /* this device doesn't support rfmon (monitor) mode */ 244 #define PCAP_ERROR_NOT_RFMON -7 /* operation supported only in monitor mode */ 245 #define PCAP_ERROR_PERM_DENIED -8 /* no permission to open the device */ 246 #define PCAP_ERROR_IFACE_NOT_UP -9 /* interface isn't up */ 247 248 /* 249 * Warning codes for the pcap API. 250 * These will all be positive and non-zero, so they won't look like 251 * errors. 252 */ 253 #define PCAP_WARNING 1 /* generic warning code */ 254 #define PCAP_WARNING_PROMISC_NOTSUP 2 /* this device doesn't support promiscuous mode */ 255 256 char *pcap_lookupdev(char *); 257 int pcap_lookupnet(const char *, bpf_u_int32 *, bpf_u_int32 *, char *); 258 259 pcap_t *pcap_create(const char *, char *); 260 int pcap_set_snaplen(pcap_t *, int); 261 int pcap_set_promisc(pcap_t *, int); 262 int pcap_can_set_rfmon(pcap_t *); 263 int pcap_set_rfmon(pcap_t *, int); 264 int pcap_set_timeout(pcap_t *, int); 265 int pcap_set_buffer_size(pcap_t *, int); 266 int pcap_activate(pcap_t *); 267 268 pcap_t *pcap_open_live(const char *, int, int, int, char *); 269 pcap_t *pcap_open_dead(int, int); 270 pcap_t *pcap_open_offline(const char *, char *); 271 #if defined(WIN32) 272 pcap_t *pcap_hopen_offline(intptr_t, char *); 273 #if !defined(LIBPCAP_EXPORTS) 274 #define pcap_fopen_offline(f,b) \ 275 pcap_hopen_offline(_get_osfhandle(_fileno(f)), b) 276 #else /*LIBPCAP_EXPORTS*/ 277 static pcap_t *pcap_fopen_offline(FILE *, char *); 278 #endif 279 #else /*WIN32*/ 280 pcap_t *pcap_fopen_offline(FILE *, char *); 281 #endif /*WIN32*/ 282 283 void pcap_close(pcap_t *); 284 int pcap_loop(pcap_t *, int, pcap_handler, u_char *); 285 int pcap_dispatch(pcap_t *, int, pcap_handler, u_char *); 286 const u_char* 287 pcap_next(pcap_t *, struct pcap_pkthdr *); 288 int pcap_next_ex(pcap_t *, struct pcap_pkthdr **, const u_char **); 289 void pcap_breakloop(pcap_t *); 290 int pcap_stats(pcap_t *, struct pcap_stat *); 291 int pcap_setfilter(pcap_t *, struct bpf_program *); 292 int pcap_setdirection(pcap_t *, pcap_direction_t); 293 int pcap_getnonblock(pcap_t *, char *); 294 int pcap_setnonblock(pcap_t *, int, char *); 295 int pcap_inject(pcap_t *, const void *, size_t); 296 int pcap_sendpacket(pcap_t *, const u_char *, int); 297 const char *pcap_statustostr(int); 298 const char *pcap_strerror(int); 299 char *pcap_geterr(pcap_t *); 300 void pcap_perror(pcap_t *, char *); 301 int pcap_compile(pcap_t *, struct bpf_program *, const char *, int, 302 bpf_u_int32); 303 int pcap_compile_nopcap(int, int, struct bpf_program *, 304 const char *, int, bpf_u_int32); 305 void pcap_freecode(struct bpf_program *); 306 int pcap_offline_filter(struct bpf_program *, const struct pcap_pkthdr *, 307 const u_char *); 308 int pcap_datalink(pcap_t *); 309 int pcap_datalink_ext(pcap_t *); 310 int pcap_list_datalinks(pcap_t *, int **); 311 int pcap_set_datalink(pcap_t *, int); 312 void pcap_free_datalinks(int *); 313 int pcap_datalink_name_to_val(const char *); 314 const char *pcap_datalink_val_to_name(int); 315 const char *pcap_datalink_val_to_description(int); 316 int pcap_snapshot(pcap_t *); 317 int pcap_is_swapped(pcap_t *); 318 int pcap_major_version(pcap_t *); 319 int pcap_minor_version(pcap_t *); 320 321 /* XXX */ 322 FILE *pcap_file(pcap_t *); 323 int pcap_fileno(pcap_t *); 324 325 pcap_dumper_t *pcap_dump_open(pcap_t *, const char *); 326 pcap_dumper_t *pcap_dump_fopen(pcap_t *, FILE *fp); 327 FILE *pcap_dump_file(pcap_dumper_t *); 328 long pcap_dump_ftell(pcap_dumper_t *); 329 int pcap_dump_flush(pcap_dumper_t *); 330 void pcap_dump_close(pcap_dumper_t *); 331 void pcap_dump(u_char *, const struct pcap_pkthdr *, const u_char *); 332 333 int pcap_findalldevs(pcap_if_t **, char *); 334 void pcap_freealldevs(pcap_if_t *); 335 336 const char *pcap_lib_version(void); 337 338 /* XXX this guy lives in the bpf tree */ 339 u_int bpf_filter(const struct bpf_insn *, const u_char *, u_int, u_int); 340 int bpf_validate(const struct bpf_insn *f, int len); 341 char *bpf_image(const struct bpf_insn *, int); 342 void bpf_dump(const struct bpf_program *, int); 343 344 #if defined(WIN32) 345 346 /* 347 * Win32 definitions 348 */ 349 350 int pcap_setbuff(pcap_t *p, int dim); 351 int pcap_setmode(pcap_t *p, int mode); 352 int pcap_setmintocopy(pcap_t *p, int size); 353 354 #ifdef WPCAP 355 /* Include file with the wpcap-specific extensions */ 356 #include <Win32-Extensions.h> 357 #endif /* WPCAP */ 358 359 #define MODE_CAPT 0 360 #define MODE_STAT 1 361 #define MODE_MON 2 362 363 #elif defined(MSDOS) 364 365 /* 366 * MS-DOS definitions 367 */ 368 369 int pcap_stats_ex (pcap_t *, struct pcap_stat_ex *); 370 void pcap_set_wait (pcap_t *p, void (*yield)(void), int wait); 371 u_long pcap_mac_packets (void); 372 373 #else /* UN*X */ 374 375 /* 376 * UN*X definitions 377 */ 378 379 int pcap_get_selectable_fd(pcap_t *); 380 381 #endif /* WIN32/MSDOS/UN*X */ 382 383 #ifdef __cplusplus 384 } 385 #endif 386 387 #endif 388