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