contrib/libpcap/pcap-int.h

   1 /*
   2  * Copyright (c) 1994, 1995, 1996
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by the Computer Systems
  16  *      Engineering Group at Lawrence Berkeley Laboratory.
  17  * 4. Neither the name of the University nor of the Laboratory may be used
  18  *    to endorse or promote products derived from this software without
  19  *    specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  *
  33  * @(#) $Header: /tcpdump/master/libpcap/pcap-int.h,v 1.85.2.9 2008-09-16 00:21:08 guy Exp $ (LBL)
  34  */
  35
  36 #ifndef pcap_int_h
  37 #define pcap_int_h
  38
  39 #include <pcap/pcap.h>
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44
  45 #ifdef HAVE_LIBDLPI
  46 #include <libdlpi.h>
  47 #endif
  48
  49 #ifdef WIN32
  50 #include <Packet32.h>
  51 #endif /* WIN32 */
  52
  53 #ifdef MSDOS
  54 #include <fcntl.h>
  55 #include <io.h>
  56 #endif
  57
  58 #if (defined(_MSC_VER) && (_MSC_VER <= 1200)) /* we are compiling with Visual Studio 6, that doesn't support the LL suffix*/
  59
  60 /*
  61  * Swap byte ordering of unsigned long long timestamp on a big endian
  62  * machine.
  63  */
  64 #define SWAPLL(ull)  ((ull & 0xff00000000000000) >> 56) | \
  65                       ((ull & 0x00ff000000000000) >> 40) | \
  66                       ((ull & 0x0000ff0000000000) >> 24) | \
  67                       ((ull & 0x000000ff00000000) >> 8)  | \
  68                       ((ull & 0x00000000ff000000) << 8)  | \
  69                       ((ull & 0x0000000000ff0000) << 24) | \
  70                       ((ull & 0x000000000000ff00) << 40) | \
  71                       ((ull & 0x00000000000000ff) << 56)
  72
  73 #else /* A recent Visual studio compiler or not VC */
  74
  75 /*
  76  * Swap byte ordering of unsigned long long timestamp on a big endian
  77  * machine.
  78  */
  79 #define SWAPLL(ull)  ((ull & 0xff00000000000000LL) >> 56) | \
  80                       ((ull & 0x00ff000000000000LL) >> 40) | \
  81                       ((ull & 0x0000ff0000000000LL) >> 24) | \
  82                       ((ull & 0x000000ff00000000LL) >> 8)  | \
  83                       ((ull & 0x00000000ff000000LL) << 8)  | \
  84                       ((ull & 0x0000000000ff0000LL) << 24) | \
  85                       ((ull & 0x000000000000ff00LL) << 40) | \
  86                       ((ull & 0x00000000000000ffLL) << 56)
  87
  88 #endif /* _MSC_VER */
  89
  90 /*
  91  * Savefile
  92  */
  93 typedef enum {
  94         NOT_SWAPPED,
  95         SWAPPED,
  96         MAYBE_SWAPPED
  97 } swapped_type_t;
  98
  99 /*
 100  * Used when reading a savefile.
 101  */
 102 struct pcap_sf {
 103         FILE *rfile;
 104         int swapped;
 105         size_t hdrsize;
 106         swapped_type_t lengths_swapped;
 107         int version_major;
 108         int version_minor;
 109         u_char *base;
 110 };
 111
 112 /*
 113  * Used when doing a live capture.
 114  */
 115 struct pcap_md {
 116         struct pcap_stat stat;
 117         /*XXX*/
 118         int use_bpf;            /* using kernel filter */
 119         u_long  TotPkts;        /* can't oflow for 79 hrs on ether */
 120         u_long  TotAccepted;    /* count accepted by filter */
 121         u_long  TotDrops;       /* count of dropped packets */
 122         long    TotMissed;      /* missed by i/f during this run */
 123         long    OrigMissed;     /* missed by i/f before this run */
 124         char    *device;        /* device name */
 125         int     timeout;        /* timeout for buffering */
 126         int     must_clear;     /* stuff we must clear when we close */
 127         struct pcap *next;      /* list of open pcaps that need stuff cleared on close */
 128 #ifdef linux
 129         int     sock_packet;    /* using Linux 2.0 compatible interface */
 130         int     cooked;         /* using SOCK_DGRAM rather than SOCK_RAW */
 131         int     ifindex;        /* interface index of device we're bound to */
 132         int     lo_ifindex;     /* interface index of the loopback device */
 133         u_int   packets_read;   /* count of packets read with recvfrom() */
 134         bpf_u_int32 oldmode;    /* mode to restore when turning monitor mode off */
 135         u_int   tp_version;     /* version of tpacket_hdr for mmaped ring */
 136         u_int   tp_hdrlen;      /* hdrlen of tpacket_hdr for mmaped ring */
 137 #endif /* linux */
 138
 139 #ifdef HAVE_DAG_API
 140 #ifdef HAVE_DAG_STREAMS_API
 141         u_char  *dag_mem_bottom;        /* DAG card current memory bottom pointer */
 142         u_char  *dag_mem_top;   /* DAG card current memory top pointer */
 143 #else /* HAVE_DAG_STREAMS_API */
 144         void    *dag_mem_base;  /* DAG card memory base address */
 145         u_int   dag_mem_bottom; /* DAG card current memory bottom offset */
 146         u_int   dag_mem_top;    /* DAG card current memory top offset */
 147 #endif /* HAVE_DAG_STREAMS_API */
 148         int     dag_fcs_bits;   /* Number of checksum bits from link layer */
 149         int     dag_offset_flags; /* Flags to pass to dag_offset(). */
 150         int     dag_stream;     /* DAG stream number */
 151         int     dag_timeout;    /* timeout specified to pcap_open_live.
 152                                  * Same as in linux above, introduce
 153                                  * generally? */
 154 #endif /* HAVE_DAG_API */
 155 #ifdef HAVE_ZEROCOPY_BPF
 156        /*
 157         * Zero-copy read buffer -- for zero-copy BPF.  'buffer' above will
 158         * alternative between these two actual mmap'd buffers as required.
 159         * As there is a header on the front size of the mmap'd buffer, only
 160         * some of the buffer is exposed to libpcap as a whole via bufsize;
 161         * zbufsize is the true size.  zbuffer tracks the current zbuf
 162         * assocated with buffer so that it can be used to decide which the
 163         * next buffer to read will be.
 164         */
 165        u_char *zbuf1, *zbuf2, *zbuffer;
 166        u_int zbufsize;
 167        u_int zerocopy;
 168        u_int interrupted;
 169        struct timespec firstsel;
 170        /*
 171         * If there's currently a buffer being actively processed, then it is
 172         * referenced here; 'buffer' is also pointed at it, but offset by the
 173         * size of the header.
 174         */
 175        struct bpf_zbuf_header *bzh;
 176 #endif /* HAVE_ZEROCOPY_BPF */
 177 };
 178
 179 /*
 180  * Stuff to clear when we close.
 181  */
 182 #define MUST_CLEAR_PROMISC      0x00000001      /* promiscuous mode */
 183 #define MUST_CLEAR_RFMON        0x00000002      /* rfmon (monitor) mode */
 184
 185 struct pcap_opt {
 186         int     buffer_size;
 187         char    *source;
 188         int     promisc;
 189         int     rfmon;
 190 };
 191
 192 /*
 193  * 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
 194  * Tru64 UNIX, and some versions of NetBSD pad FDDI packets to make everything
 195  * line up on a nice boundary.
 196  */
 197 #ifdef __NetBSD__
 198 #include <sys/param.h>  /* needed to declare __NetBSD_Version__ */
 199 #endif
 200
 201 #if defined(ultrix) || defined(__osf__) || (defined(__NetBSD__) && __NetBSD_Version__ > 106000000)
 202 #define       PCAP_FDDIPAD 3
 203 #endif
 204
 205 typedef int     (*activate_op_t)(pcap_t *);
 206 typedef int     (*can_set_rfmon_op_t)(pcap_t *);
 207 typedef int     (*read_op_t)(pcap_t *, int cnt, pcap_handler, u_char *);
 208 typedef int     (*inject_op_t)(pcap_t *, const void *, size_t);
 209 typedef int     (*setfilter_op_t)(pcap_t *, struct bpf_program *);
 210 typedef int     (*setdirection_op_t)(pcap_t *, pcap_direction_t);
 211 typedef int     (*set_datalink_op_t)(pcap_t *, int);
 212 typedef int     (*getnonblock_op_t)(pcap_t *, char *);
 213 typedef int     (*setnonblock_op_t)(pcap_t *, int, char *);
 214 typedef int     (*stats_op_t)(pcap_t *, struct pcap_stat *);
 215 #ifdef WIN32
 216 typedef int     (*setbuff_op_t)(pcap_t *, int);
 217 typedef int     (*setmode_op_t)(pcap_t *, int);
 218 typedef int     (*setmintocopy_op_t)(pcap_t *, int);
 219 #endif
 220 typedef void    (*cleanup_op_t)(pcap_t *);
 221
 222 struct pcap {
 223 #ifdef WIN32
 224         ADAPTER *adapter;
 225         LPPACKET Packet;
 226         int nonblock;
 227 #else
 228         int fd;
 229         int selectable_fd;
 230         int send_fd;
 231 #endif /* WIN32 */
 232
 233 #ifdef HAVE_LIBDLPI
 234         dlpi_handle_t dlpi_hd;
 235 #endif
 236         int snapshot;
 237         int linktype;           /* Network linktype */
 238         int linktype_ext;       /* Extended information stored in the linktype field of a file */
 239         int tzoff;              /* timezone offset */
 240         int offset;             /* offset for proper alignment */
 241         int activated;          /* true if the capture is really started */
 242         int oldstyle;           /* if we're opening with pcap_open_live() */
 243
 244         int break_loop;         /* flag set to force break from packet-reading loop */
 245
 246 #ifdef PCAP_FDDIPAD
 247         int fddipad;
 248 #endif
 249
 250 #ifdef MSDOS
 251         void (*wait_proc)(void); /*          call proc while waiting */
 252 #endif
 253
 254         struct pcap_sf sf;
 255         struct pcap_md md;
 256         struct pcap_opt opt;
 257
 258         /*
 259          * Read buffer.
 260          */
 261         int bufsize;
 262         u_char *buffer;
 263         u_char *bp;
 264         int cc;
 265
 266         /*
 267          * Place holder for pcap_next().
 268          */
 269         u_char *pkt;
 270
 271         /* We're accepting only packets in this direction/these directions. */
 272         pcap_direction_t direction;
 273
 274         /*
 275          * Methods.
 276          */
 277         activate_op_t activate_op;
 278         can_set_rfmon_op_t can_set_rfmon_op;
 279         read_op_t read_op;
 280         inject_op_t inject_op;
 281         setfilter_op_t setfilter_op;
 282         setdirection_op_t setdirection_op;
 283         set_datalink_op_t set_datalink_op;
 284         getnonblock_op_t getnonblock_op;
 285         setnonblock_op_t setnonblock_op;
 286         stats_op_t stats_op;
 287
 288 #ifdef WIN32
 289         /*
 290          * These are, at least currently, specific to the Win32 NPF
 291          * driver.
 292          */
 293         setbuff_op_t setbuff_op;
 294         setmode_op_t setmode_op;
 295         setmintocopy_op_t setmintocopy_op;
 296 #endif
 297         cleanup_op_t cleanup_op;
 298
 299         /*
 300          * Placeholder for filter code if bpf not in kernel.
 301          */
 302         struct bpf_program fcode;
 303
 304         char errbuf[PCAP_ERRBUF_SIZE + 1];
 305         int dlt_count;
 306         u_int *dlt_list;
 307
 308         struct pcap_pkthdr pcap_header; /* This is needed for the pcap_next_ex() to work */
 309 };
 310
 311 /*
 312  * This is a timeval as stored in a savefile.
 313  * It has to use the same types everywhere, independent of the actual
 314  * `struct timeval'; `struct timeval' has 32-bit tv_sec values on some
 315  * platforms and 64-bit tv_sec values on other platforms, and writing
 316  * out native `struct timeval' values would mean files could only be
 317  * read on systems with the same tv_sec size as the system on which
 318  * the file was written.
 319  */
 320
 321 struct pcap_timeval {
 322     bpf_int32 tv_sec;           /* seconds */
 323     bpf_int32 tv_usec;          /* microseconds */
 324 };
 325
 326 /*
 327  * This is a `pcap_pkthdr' as actually stored in a savefile.
 328  *
 329  * Do not change the format of this structure, in any way (this includes
 330  * changes that only affect the length of fields in this structure),
 331  * and do not make the time stamp anything other than seconds and
 332  * microseconds (e.g., seconds and nanoseconds).  Instead:
 333  *
 334  *      introduce a new structure for the new format;
 335  *
 336  *      send mail to "tcpdump-workers@lists.tcpdump.org", requesting
 337  *      a new magic number for your new capture file format, and, when
 338  *      you get the new magic number, put it in "savefile.c";
 339  *
 340  *      use that magic number for save files with the changed record
 341  *      header;
 342  *
 343  *      make the code in "savefile.c" capable of reading files with
 344  *      the old record header as well as files with the new record header
 345  *      (using the magic number to determine the header format).
 346  *
 347  * Then supply the changes as a patch at
 348  *
 349  *      http://sourceforge.net/projects/libpcap/
 350  *
 351  * so that future versions of libpcap and programs that use it (such as
 352  * tcpdump) will be able to read your new capture file format.
 353  */
 354
 355 struct pcap_sf_pkthdr {
 356     struct pcap_timeval ts;     /* time stamp */
 357     bpf_u_int32 caplen;         /* length of portion present */
 358     bpf_u_int32 len;            /* length this packet (off wire) */
 359 };
 360
 361 /*
 362  * How a `pcap_pkthdr' is actually stored in savefiles written
 363  * by some patched versions of libpcap (e.g. the ones in Red
 364  * Hat Linux 6.1 and 6.2).
 365  *
 366  * Do not change the format of this structure, in any way (this includes
 367  * changes that only affect the length of fields in this structure).
 368  * Instead, introduce a new structure, as per the above.
 369  */
 370
 371 struct pcap_sf_patched_pkthdr {
 372     struct pcap_timeval ts;     /* time stamp */
 373     bpf_u_int32 caplen;         /* length of portion present */
 374     bpf_u_int32 len;            /* length this packet (off wire) */
 375     int         index;
 376     unsigned short protocol;
 377     unsigned char pkt_type;
 378 };
 379
 380 int     yylex(void);
 381
 382 #ifndef min
 383 #define min(a, b) ((a) > (b) ? (b) : (a))
 384 #endif
 385
 386 /* XXX should these be in pcap.h? */
 387 int     pcap_offline_read(pcap_t *, int, pcap_handler, u_char *);
 388 int     pcap_read(pcap_t *, int cnt, pcap_handler, u_char *);
 389
 390 #ifndef HAVE_STRLCPY
 391 #define strlcpy(x, y, z) \
 392         (strncpy((x), (y), (z)), \
 393          ((z) <= 0 ? 0 : ((x)[(z) - 1] = '\0')), \
 394          strlen((y)))
 395 #endif
 396
 397 #include <stdarg.h>
 398
 399 #if !defined(HAVE_SNPRINTF)
 400 #define snprintf pcap_snprintf
 401 extern int snprintf (char *, size_t, const char *, ...);
 402 #endif
 403
 404 #if !defined(HAVE_VSNPRINTF)
 405 #define vsnprintf pcap_vsnprintf
 406 extern int vsnprintf (char *, size_t, const char *, va_list ap);
 407 #endif
 408
 409 /*
 410  * Routines that most pcap implementations can use for non-blocking mode.
 411  */
 412 #if !defined(WIN32) && !defined(MSDOS)
 413 int     pcap_getnonblock_fd(pcap_t *, char *);
 414 int     pcap_setnonblock_fd(pcap_t *p, int, char *);
 415 #endif
 416
 417 pcap_t  *pcap_create_common(const char *, char *);
 418 int     pcap_do_addexit(pcap_t *);
 419 void    pcap_add_to_pcaps_to_close(pcap_t *);
 420 void    pcap_remove_from_pcaps_to_close(pcap_t *);
 421 void    pcap_cleanup_live_common(pcap_t *);
 422 int     pcap_not_initialized(pcap_t *);
 423 int     pcap_check_activated(pcap_t *);
 424
 425 /*
 426  * Internal interfaces for "pcap_findalldevs()".
 427  *
 428  * "pcap_platform_finddevs()" is a platform-dependent routine to
 429  * add devices not found by the "standard" mechanisms (SIOCGIFCONF,
 430  * "getifaddrs()", etc..
 431  *
 432  * "pcap_add_if()" adds an interface to the list of interfaces.
 433  */
 434 int     pcap_platform_finddevs(pcap_if_t **, char *);
 435 int     add_addr_to_iflist(pcap_if_t **, const char *, u_int, struct sockaddr *,
 436             size_t, struct sockaddr *, size_t, struct sockaddr *, size_t,
 437             struct sockaddr *, size_t, char *);
 438 int     pcap_add_if(pcap_if_t **, const char *, u_int, const char *, char *);
 439 struct sockaddr *dup_sockaddr(struct sockaddr *, size_t);
 440 int     add_or_find_if(pcap_if_t **, pcap_if_t **, const char *, u_int,
 441             const char *, char *);
 442
 443 #ifdef WIN32
 444 char    *pcap_win32strerror(void);
 445 #endif
 446
 447 int     install_bpf_program(pcap_t *, struct bpf_program *);
 448
 449 int     pcap_strcasecmp(const char *, const char *);
 450
 451 #ifdef __cplusplus
 452 }
 453 #endif
 454
 455 #endif