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