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