pcap-int.h revision 236167
117683Spst/* 217683Spst * Copyright (c) 1994, 1995, 1996 317683Spst * The Regents of the University of California. All rights reserved. 417683Spst * 517683Spst * Redistribution and use in source and binary forms, with or without 617683Spst * modification, are permitted provided that the following conditions 717683Spst * are met: 817683Spst * 1. Redistributions of source code must retain the above copyright 917683Spst * notice, this list of conditions and the following disclaimer. 1017683Spst * 2. Redistributions in binary form must reproduce the above copyright 1117683Spst * notice, this list of conditions and the following disclaimer in the 1217683Spst * documentation and/or other materials provided with the distribution. 1317683Spst * 3. All advertising materials mentioning features or use of this software 1417683Spst * must display the following acknowledgement: 1517683Spst * This product includes software developed by the Computer Systems 1617683Spst * Engineering Group at Lawrence Berkeley Laboratory. 1717683Spst * 4. Neither the name of the University nor of the Laboratory may be used 1817683Spst * to endorse or promote products derived from this software without 1917683Spst * specific prior written permission. 2026175Sfenner * 2117683Spst * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 2217683Spst * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 2317683Spst * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 2417683Spst * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 2517683Spst * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 2626175Sfenner * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2726175Sfenner * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2826175Sfenner * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2926175Sfenner * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 3026175Sfenner * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 3117683Spst * SUCH DAMAGE. 3217683Spst * 3317683Spst * @(#) $Header: /tcpdump/master/libpcap/pcap-int.h,v 1.94 2008-09-16 00:20:23 guy Exp $ (LBL) 3417683Spst */ 3517683Spst 3617683Spst#ifndef pcap_int_h 3717683Spst#define pcap_int_h 3817683Spst 3917683Spst#include <pcap/pcap.h> 4017683Spst 4117683Spst#ifdef __cplusplus 4217683Spstextern "C" { 4317683Spst#endif 4417683Spst 4517683Spst#ifdef HAVE_LIBDLPI 4617683Spst#include <libdlpi.h> 4717683Spst#endif 4817683Spst 4917683Spst#ifdef WIN32 5017683Spst#include <Packet32.h> 5117683Spstextern CRITICAL_SECTION g_PcapCompileCriticalSection; 5217683Spst#endif /* WIN32 */ 5317683Spst 5417683Spst#ifdef MSDOS 5517683Spst#include <fcntl.h> 5617683Spst#include <io.h> 5717683Spst#endif 5817683Spst 5917683Spst#ifdef HAVE_SNF_API 6017683Spst#include <snf.h> 6117683Spst#endif 6217683Spst 6317683Spst#if (defined(_MSC_VER) && (_MSC_VER <= 1200)) /* we are compiling with Visual Studio 6, that doesn't support the LL suffix*/ 6417683Spst 6517683Spst/* 6617683Spst * Swap byte ordering of unsigned long long timestamp on a big endian 6717683Spst * machine. 6817683Spst */ 6917683Spst#define SWAPLL(ull) ((ull & 0xff00000000000000) >> 56) | \ 7017683Spst ((ull & 0x00ff000000000000) >> 40) | \ 7117683Spst ((ull & 0x0000ff0000000000) >> 24) | \ 7217683Spst ((ull & 0x000000ff00000000) >> 8) | \ 7317683Spst ((ull & 0x00000000ff000000) << 8) | \ 7417683Spst ((ull & 0x0000000000ff0000) << 24) | \ 7517683Spst ((ull & 0x000000000000ff00) << 40) | \ 7617683Spst ((ull & 0x00000000000000ff) << 56) 7717683Spst 7817683Spst#else /* A recent Visual studio compiler or not VC */ 7917683Spst 8017683Spst/* 8117683Spst * Swap byte ordering of unsigned long long timestamp on a big endian 8217683Spst * machine. 8317683Spst */ 8417683Spst#define SWAPLL(ull) ((ull & 0xff00000000000000LL) >> 56) | \ 8517683Spst ((ull & 0x00ff000000000000LL) >> 40) | \ 8617683Spst ((ull & 0x0000ff0000000000LL) >> 24) | \ 8717683Spst ((ull & 0x000000ff00000000LL) >> 8) | \ 8817683Spst ((ull & 0x00000000ff000000LL) << 8) | \ 8917683Spst ((ull & 0x0000000000ff0000LL) << 24) | \ 9017683Spst ((ull & 0x000000000000ff00LL) << 40) | \ 9117683Spst ((ull & 0x00000000000000ffLL) << 56) 9217683Spst 9317683Spst#endif /* _MSC_VER */ 9417683Spst 9517683Spst/* 9617683Spst * Savefile 9717683Spst */ 9817683Spsttypedef enum { 9917683Spst NOT_SWAPPED, 10017683Spst SWAPPED, 10117683Spst MAYBE_SWAPPED 10217683Spst} swapped_type_t; 10317683Spst 10417683Spst/* 10517683Spst * Used when reading a savefile. 10617683Spst */ 10717683Spststruct pcap_sf { 10817683Spst FILE *rfile; 10917683Spst int (*next_packet_op)(pcap_t *, struct pcap_pkthdr *, u_char **); 11017683Spst int swapped; 11117683Spst size_t hdrsize; 11217683Spst swapped_type_t lengths_swapped; 11317683Spst int version_major; 11417683Spst int version_minor; 11517683Spst bpf_u_int32 ifcount; /* number of interfaces seen in this capture */ 11617683Spst u_int tsresol; /* time stamp resolution */ 11717683Spst u_int tsscale; /* scaling factor for resolution -> microseconds */ 11817683Spst u_int64_t tsoffset; /* time stamp offset */ 11917683Spst}; 12017683Spst 12117683Spst/* 12217683Spst * Used when doing a live capture. 12317683Spst */ 12417683Spststruct pcap_md { 12517683Spst struct pcap_stat stat; 12617683Spst /*XXX*/ 12717683Spst int use_bpf; /* using kernel filter */ 12817683Spst u_long TotPkts; /* can't oflow for 79 hrs on ether */ 12917683Spst u_long TotAccepted; /* count accepted by filter */ 13017683Spst u_long TotDrops; /* count of dropped packets */ 13117683Spst long TotMissed; /* missed by i/f during this run */ 13217683Spst long OrigMissed; /* missed by i/f before this run */ 13317683Spst char *device; /* device name */ 13417683Spst int timeout; /* timeout for buffering */ 13517683Spst int must_do_on_close; /* stuff we must do when we close */ 13617683Spst struct pcap *next; /* list of open pcaps that need stuff cleared on close */ 13717683Spst#ifdef linux 13817683Spst int sock_packet; /* using Linux 2.0 compatible interface */ 13917683Spst int cooked; /* using SOCK_DGRAM rather than SOCK_RAW */ 14017683Spst int ifindex; /* interface index of device we're bound to */ 14117683Spst int lo_ifindex; /* interface index of the loopback device */ 14217683Spst u_int packets_read; /* count of packets read with recvfrom() */ 14317683Spst bpf_u_int32 oldmode; /* mode to restore when turning monitor mode off */ 14417683Spst char *mondevice; /* mac80211 monitor device we created */ 14517683Spst u_char *mmapbuf; /* memory-mapped region pointer */ 14617683Spst size_t mmapbuflen; /* size of region */ 14717683Spst u_int tp_version; /* version of tpacket_hdr for mmaped ring */ 14817683Spst u_int tp_hdrlen; /* hdrlen of tpacket_hdr for mmaped ring */ 14917683Spst u_char *oneshot_buffer; /* buffer for copy of packet */ 15017683Spst long proc_dropped; /* packets reported dropped by /proc/net/dev */ 15117683Spst#endif /* linux */ 15217683Spst 15317683Spst#ifdef HAVE_DAG_API 15417683Spst#ifdef HAVE_DAG_STREAMS_API 15517683Spst u_char *dag_mem_bottom; /* DAG card current memory bottom pointer */ 15617683Spst u_char *dag_mem_top; /* DAG card current memory top pointer */ 15717683Spst#else /* HAVE_DAG_STREAMS_API */ 15817683Spst void *dag_mem_base; /* DAG card memory base address */ 15917683Spst u_int dag_mem_bottom; /* DAG card current memory bottom offset */ 16017683Spst u_int dag_mem_top; /* DAG card current memory top offset */ 16117683Spst#endif /* HAVE_DAG_STREAMS_API */ 16217683Spst int dag_fcs_bits; /* Number of checksum bits from link layer */ 16317683Spst int dag_offset_flags; /* Flags to pass to dag_offset(). */ 16417683Spst int dag_stream; /* DAG stream number */ 16517683Spst int dag_timeout; /* timeout specified to pcap_open_live. 16617683Spst * Same as in linux above, introduce 16717683Spst * generally? */ 16817683Spst#endif /* HAVE_DAG_API */ 16917683Spst#ifdef HAVE_SNF_API 17017683Spst snf_handle_t snf_handle; /* opaque device handle */ 17117683Spst snf_ring_t snf_ring; /* opaque device ring handle */ 17217683Spst int snf_timeout; 17317683Spst int snf_boardnum; 17417683Spst#endif /*HAVE_SNF_API*/ 17517683Spst 17617683Spst#ifdef HAVE_ZEROCOPY_BPF 17717683Spst /* 17817683Spst * Zero-copy read buffer -- for zero-copy BPF. 'buffer' above will 17917683Spst * alternative between these two actual mmap'd buffers as required. 18017683Spst * As there is a header on the front size of the mmap'd buffer, only 18117683Spst * some of the buffer is exposed to libpcap as a whole via bufsize; 18217683Spst * zbufsize is the true size. zbuffer tracks the current zbuf 18317683Spst * assocated with buffer so that it can be used to decide which the 18417683Spst * next buffer to read will be. 18517683Spst */ 18617683Spst u_char *zbuf1, *zbuf2, *zbuffer; 18717683Spst u_int zbufsize; 18817683Spst u_int zerocopy; 18917683Spst u_int interrupted; 19017683Spst struct timespec firstsel; 19117683Spst /* 19217683Spst * If there's currently a buffer being actively processed, then it is 19317683Spst * referenced here; 'buffer' is also pointed at it, but offset by the 19417683Spst * size of the header. 19517683Spst */ 19617683Spst struct bpf_zbuf_header *bzh; 19717683Spst#endif /* HAVE_ZEROCOPY_BPF */ 19817683Spst}; 19917683Spst 20017683Spst/* 20117683Spst * Stuff to do when we close. 20217683Spst */ 20317683Spst#define MUST_CLEAR_PROMISC 0x00000001 /* clear promiscuous mode */ 20417683Spst#define MUST_CLEAR_RFMON 0x00000002 /* clear rfmon (monitor) mode */ 20517683Spst#define MUST_DELETE_MONIF 0x00000004 /* delete monitor-mode interface */ 20617683Spst 20717683Spststruct pcap_opt { 20817683Spst int buffer_size; 20917683Spst char *source; 21017683Spst int promisc; 21117683Spst int rfmon; 21217683Spst int tstamp_type; 21317683Spst}; 21417683Spst 21517683Spst/* 21617683Spst * Ultrix, DEC OSF/1^H^H^H^H^H^H^H^H^HDigital UNIX^H^H^H^H^H^H^H^H^H^H^H^H 21717683Spst * Tru64 UNIX, and some versions of NetBSD pad FDDI packets to make everything 21817683Spst * line up on a nice boundary. 21917683Spst */ 22017683Spst#ifdef __NetBSD__ 22117683Spst#include <sys/param.h> /* needed to declare __NetBSD_Version__ */ 22217683Spst#endif 22317683Spst 22417683Spst#if defined(ultrix) || defined(__osf__) || (defined(__NetBSD__) && __NetBSD_Version__ > 106000000) 22517683Spst#define PCAP_FDDIPAD 3 22617683Spst#endif 22717683Spst 22817683Spsttypedef int (*activate_op_t)(pcap_t *); 22917683Spsttypedef int (*can_set_rfmon_op_t)(pcap_t *); 23017683Spsttypedef int (*read_op_t)(pcap_t *, int cnt, pcap_handler, u_char *); 23117683Spsttypedef int (*inject_op_t)(pcap_t *, const void *, size_t); 23217683Spsttypedef int (*setfilter_op_t)(pcap_t *, struct bpf_program *); 23317683Spsttypedef int (*setdirection_op_t)(pcap_t *, pcap_direction_t); 23417683Spsttypedef int (*set_datalink_op_t)(pcap_t *, int); 23517683Spsttypedef int (*getnonblock_op_t)(pcap_t *, char *); 23617683Spsttypedef int (*setnonblock_op_t)(pcap_t *, int, char *); 23717683Spsttypedef int (*stats_op_t)(pcap_t *, struct pcap_stat *); 23817683Spst#ifdef WIN32 23917683Spsttypedef int (*setbuff_op_t)(pcap_t *, int); 24017683Spsttypedef int (*setmode_op_t)(pcap_t *, int); 24117683Spsttypedef int (*setmintocopy_op_t)(pcap_t *, int); 24217683Spst#endif 24317683Spsttypedef void (*cleanup_op_t)(pcap_t *); 24417683Spst 24517683Spststruct pcap { 24617683Spst#ifdef WIN32 24717683Spst ADAPTER *adapter; 24817683Spst LPPACKET Packet; 24917683Spst int nonblock; 25017683Spst#else 25117683Spst int fd; 25217683Spst int selectable_fd; 25317683Spst int send_fd; 25417683Spst#endif /* WIN32 */ 25517683Spst 25617683Spst#ifdef HAVE_LIBDLPI 25717683Spst dlpi_handle_t dlpi_hd; 25817683Spst#endif 25917683Spst int snapshot; 26017683Spst int linktype; /* Network linktype */ 26117683Spst int linktype_ext; /* Extended information stored in the linktype field of a file */ 26217683Spst int tzoff; /* timezone offset */ 26317683Spst int offset; /* offset for proper alignment */ 26417683Spst int activated; /* true if the capture is really started */ 26517683Spst int oldstyle; /* if we're opening with pcap_open_live() */ 26617683Spst 26717683Spst int break_loop; /* flag set to force break from packet-reading loop */ 26817683Spst 26917683Spst#ifdef PCAP_FDDIPAD 27017683Spst int fddipad; 27117683Spst#endif 27217683Spst 27317683Spst#ifdef MSDOS 27417683Spst void (*wait_proc)(void); /* call proc while waiting */ 27517683Spst#endif 27617683Spst 27717683Spst struct pcap_sf sf; 27817683Spst struct pcap_md md; 27917683Spst struct pcap_opt opt; 28017683Spst 28117683Spst /* 28217683Spst * Read buffer. 28317683Spst */ 28417683Spst int bufsize; 28517683Spst u_char *buffer; 28617683Spst u_char *bp; 28717683Spst int cc; 28817683Spst 28917683Spst /* 29017683Spst * Place holder for pcap_next(). 29117683Spst */ 29217683Spst u_char *pkt; 29317683Spst 29417683Spst /* We're accepting only packets in this direction/these directions. */ 29517683Spst pcap_direction_t direction; 29617683Spst 29717683Spst /* 29817683Spst * Methods. 29917683Spst */ 30017683Spst activate_op_t activate_op; 301 can_set_rfmon_op_t can_set_rfmon_op; 302 read_op_t read_op; 303 inject_op_t inject_op; 304 setfilter_op_t setfilter_op; 305 setdirection_op_t setdirection_op; 306 set_datalink_op_t set_datalink_op; 307 getnonblock_op_t getnonblock_op; 308 setnonblock_op_t setnonblock_op; 309 stats_op_t stats_op; 310 311 /* 312 * Routine to use as callback for pcap_next()/pcap_next_ex(). 313 */ 314 pcap_handler oneshot_callback; 315 316#ifdef WIN32 317 /* 318 * These are, at least currently, specific to the Win32 NPF 319 * driver. 320 */ 321 setbuff_op_t setbuff_op; 322 setmode_op_t setmode_op; 323 setmintocopy_op_t setmintocopy_op; 324#endif 325 cleanup_op_t cleanup_op; 326 327 /* 328 * Placeholder for filter code if bpf not in kernel. 329 */ 330 struct bpf_program fcode; 331 332 char errbuf[PCAP_ERRBUF_SIZE + 1]; 333 int dlt_count; 334 u_int *dlt_list; 335 int tstamp_type_count; 336 u_int *tstamp_type_list; 337 338 struct pcap_pkthdr pcap_header; /* This is needed for the pcap_next_ex() to work */ 339}; 340 341/* 342 * This is a timeval as stored in a savefile. 343 * It has to use the same types everywhere, independent of the actual 344 * `struct timeval'; `struct timeval' has 32-bit tv_sec values on some 345 * platforms and 64-bit tv_sec values on other platforms, and writing 346 * out native `struct timeval' values would mean files could only be 347 * read on systems with the same tv_sec size as the system on which 348 * the file was written. 349 */ 350 351struct pcap_timeval { 352 bpf_int32 tv_sec; /* seconds */ 353 bpf_int32 tv_usec; /* microseconds */ 354}; 355 356/* 357 * This is a `pcap_pkthdr' as actually stored in a savefile. 358 * 359 * Do not change the format of this structure, in any way (this includes 360 * changes that only affect the length of fields in this structure), 361 * and do not make the time stamp anything other than seconds and 362 * microseconds (e.g., seconds and nanoseconds). Instead: 363 * 364 * introduce a new structure for the new format; 365 * 366 * send mail to "tcpdump-workers@lists.tcpdump.org", requesting 367 * a new magic number for your new capture file format, and, when 368 * you get the new magic number, put it in "savefile.c"; 369 * 370 * use that magic number for save files with the changed record 371 * header; 372 * 373 * make the code in "savefile.c" capable of reading files with 374 * the old record header as well as files with the new record header 375 * (using the magic number to determine the header format). 376 * 377 * Then supply the changes as a patch at 378 * 379 * http://sourceforge.net/projects/libpcap/ 380 * 381 * so that future versions of libpcap and programs that use it (such as 382 * tcpdump) will be able to read your new capture file format. 383 */ 384 385struct pcap_sf_pkthdr { 386 struct pcap_timeval ts; /* time stamp */ 387 bpf_u_int32 caplen; /* length of portion present */ 388 bpf_u_int32 len; /* length this packet (off wire) */ 389}; 390 391/* 392 * How a `pcap_pkthdr' is actually stored in savefiles written 393 * by some patched versions of libpcap (e.g. the ones in Red 394 * Hat Linux 6.1 and 6.2). 395 * 396 * Do not change the format of this structure, in any way (this includes 397 * changes that only affect the length of fields in this structure). 398 * Instead, introduce a new structure, as per the above. 399 */ 400 401struct pcap_sf_patched_pkthdr { 402 struct pcap_timeval ts; /* time stamp */ 403 bpf_u_int32 caplen; /* length of portion present */ 404 bpf_u_int32 len; /* length this packet (off wire) */ 405 int index; 406 unsigned short protocol; 407 unsigned char pkt_type; 408}; 409 410/* 411 * User data structure for the one-shot callback used for pcap_next() 412 * and pcap_next_ex(). 413 */ 414struct oneshot_userdata { 415 struct pcap_pkthdr *hdr; 416 const u_char **pkt; 417 pcap_t *pd; 418}; 419 420int yylex(void); 421 422#ifndef min 423#define min(a, b) ((a) > (b) ? (b) : (a)) 424#endif 425 426/* XXX should these be in pcap.h? */ 427int pcap_offline_read(pcap_t *, int, pcap_handler, u_char *); 428int pcap_read(pcap_t *, int cnt, pcap_handler, u_char *); 429 430#ifndef HAVE_STRLCPY 431#define strlcpy(x, y, z) \ 432 (strncpy((x), (y), (z)), \ 433 ((z) <= 0 ? 0 : ((x)[(z) - 1] = '\0')), \ 434 strlen((y))) 435#endif 436 437#include <stdarg.h> 438 439#if !defined(HAVE_SNPRINTF) 440#define snprintf pcap_snprintf 441extern int snprintf (char *, size_t, const char *, ...); 442#endif 443 444#if !defined(HAVE_VSNPRINTF) 445#define vsnprintf pcap_vsnprintf 446extern int vsnprintf (char *, size_t, const char *, va_list ap); 447#endif 448 449/* 450 * Routines that most pcap implementations can use for non-blocking mode. 451 */ 452#if !defined(WIN32) && !defined(MSDOS) 453int pcap_getnonblock_fd(pcap_t *, char *); 454int pcap_setnonblock_fd(pcap_t *p, int, char *); 455#endif 456 457pcap_t *pcap_create_common(const char *, char *); 458int pcap_do_addexit(pcap_t *); 459void pcap_add_to_pcaps_to_close(pcap_t *); 460void pcap_remove_from_pcaps_to_close(pcap_t *); 461void pcap_cleanup_live_common(pcap_t *); 462int pcap_not_initialized(pcap_t *); 463int pcap_check_activated(pcap_t *); 464 465/* 466 * Internal interfaces for "pcap_findalldevs()". 467 * 468 * "pcap_platform_finddevs()" is a platform-dependent routine to 469 * add devices not found by the "standard" mechanisms (SIOCGIFCONF, 470 * "getifaddrs()", etc.. 471 * 472 * "pcap_add_if()" adds an interface to the list of interfaces. 473 */ 474int pcap_platform_finddevs(pcap_if_t **, char *); 475int add_addr_to_iflist(pcap_if_t **, const char *, u_int, struct sockaddr *, 476 size_t, struct sockaddr *, size_t, struct sockaddr *, size_t, 477 struct sockaddr *, size_t, char *); 478int pcap_add_if(pcap_if_t **, const char *, u_int, const char *, char *); 479struct sockaddr *dup_sockaddr(struct sockaddr *, size_t); 480int add_or_find_if(pcap_if_t **, pcap_if_t **, const char *, u_int, 481 const char *, char *); 482 483#ifdef WIN32 484char *pcap_win32strerror(void); 485#endif 486 487int install_bpf_program(pcap_t *, struct bpf_program *); 488 489int pcap_strcasecmp(const char *, const char *); 490 491#ifdef __cplusplus 492} 493#endif 494 495#endif 496