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