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.85.2.5 2008-04-14 20:41:52 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 #endif /* linux */
 136
 137 #ifdef HAVE_DAG_API
 138 #ifdef HAVE_DAG_STREAMS_API
 139         u_char  *dag_mem_bottom;        /* DAG card current memory bottom pointer */
 140         u_char  *dag_mem_top;   /* DAG card current memory top pointer */
 141 #else /* HAVE_DAG_STREAMS_API */
 142         void    *dag_mem_base;  /* DAG card memory base address */
 143         u_int   dag_mem_bottom; /* DAG card current memory bottom offset */
 144         u_int   dag_mem_top;    /* DAG card current memory top offset */
 145 #endif /* HAVE_DAG_STREAMS_API */
 146         int     dag_fcs_bits;   /* Number of checksum bits from link layer */
 147         int     dag_offset_flags; /* Flags to pass to dag_offset(). */
 148         int     dag_stream;     /* DAG stream number */
 149         int     dag_timeout;    /* timeout specified to pcap_open_live.
 150                                  * Same as in linux above, introduce
 151                                  * generally? */
 152 #endif /* HAVE_DAG_API */
 153 };
 154
 155 /*
 156  * Stuff to clear when we close.
 157  */
 158 #define MUST_CLEAR_PROMISC      0x00000001      /* promiscuous mode */
 159 #define MUST_CLEAR_RFMON        0x00000002      /* rfmon (monitor) mode */
 160
 161 struct pcap_opt {
 162         int     buffer_size;
 163         char    *source;
 164         int     promisc;
 165         int     rfmon;
 166 };
 167
 168 /*
 169  * 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
 170  * Tru64 UNIX, and some versions of NetBSD pad FDDI packets to make everything
 171  * line up on a nice boundary.
 172  */
 173 #ifdef __NetBSD__
 174 #include <sys/param.h>  /* needed to declare __NetBSD_Version__ */
 175 #endif
 176
 177 #if defined(ultrix) || defined(__osf__) || (defined(__NetBSD__) && __NetBSD_Version__ > 106000000)
 178 #define       PCAP_FDDIPAD 3
 179 #endif
 180
 181 typedef int     (*activate_op_t)(pcap_t *);
 182 typedef int     (*can_set_rfmon_op_t)(pcap_t *);
 183 typedef int     (*read_op_t)(pcap_t *, int cnt, pcap_handler, u_char *);
 184 typedef int     (*inject_op_t)(pcap_t *, const void *, size_t);
 185 typedef int     (*setfilter_op_t)(pcap_t *, struct bpf_program *);
 186 typedef int     (*setdirection_op_t)(pcap_t *, pcap_direction_t);
 187 typedef int     (*set_datalink_op_t)(pcap_t *, int);
 188 typedef int     (*getnonblock_op_t)(pcap_t *, char *);
 189 typedef int     (*setnonblock_op_t)(pcap_t *, int, char *);
 190 typedef int     (*stats_op_t)(pcap_t *, struct pcap_stat *);
 191 #ifdef WIN32
 192 typedef int     (*setbuff_op_t)(pcap_t *, int);
 193 typedef int     (*setmode_op_t)(pcap_t *, int);
 194 typedef int     (*setmintocopy_op_t)(pcap_t *, int);
 195 #endif
 196 typedef void    (*cleanup_op_t)(pcap_t *);
 197
 198 struct pcap {
 199 #ifdef WIN32
 200         ADAPTER *adapter;
 201         LPPACKET Packet;
 202         int nonblock;
 203 #else
 204         int fd;
 205         int selectable_fd;
 206         int send_fd;
 207 #endif /* WIN32 */
 208
 209 #ifdef HAVE_LIBDLPI
 210         dlpi_handle_t dlpi_hd;
 211 #endif
 212         int snapshot;
 213         int linktype;           /* Network linktype */
 214         int linktype_ext;       /* Extended information stored in the linktype field of a file */
 215         int tzoff;              /* timezone offset */
 216         int offset;             /* offset for proper alignment */
 217         int activated;          /* true if the capture is really started */
 218         int oldstyle;           /* if we're opening with pcap_open_live() */
 219
 220         int break_loop;         /* flag set to force break from packet-reading loop */
 221
 222 #ifdef PCAP_FDDIPAD
 223         int fddipad;
 224 #endif
 225
 226 #ifdef MSDOS
 227         void (*wait_proc)(void); /*          call proc while waiting */
 228 #endif
 229
 230         struct pcap_sf sf;
 231         struct pcap_md md;
 232         struct pcap_opt opt;
 233
 234         /*
 235          * Read buffer.
 236          */
 237         int bufsize;
 238         u_char *buffer;
 239         u_char *bp;
 240         int cc;
 241
 242         /*
 243          * Place holder for pcap_next().
 244          */
 245         u_char *pkt;
 246
 247         /* We're accepting only packets in this direction/these directions. */
 248         pcap_direction_t direction;
 249
 250         /*
 251          * Methods.
 252          */
 253         activate_op_t activate_op;
 254         can_set_rfmon_op_t can_set_rfmon_op;
 255         read_op_t read_op;
 256         inject_op_t inject_op;
 257         setfilter_op_t setfilter_op;
 258         setdirection_op_t setdirection_op;
 259         set_datalink_op_t set_datalink_op;
 260         getnonblock_op_t getnonblock_op;
 261         setnonblock_op_t setnonblock_op;
 262         stats_op_t stats_op;
 263
 264 #ifdef WIN32
 265         /*
 266          * These are, at least currently, specific to the Win32 NPF
 267          * driver.
 268          */
 269         setbuff_op_t setbuff_op;
 270         setmode_op_t setmode_op;
 271         setmintocopy_op_t setmintocopy_op;
 272 #endif
 273         cleanup_op_t cleanup_op;
 274
 275         /*
 276          * Placeholder for filter code if bpf not in kernel.
 277          */
 278         struct bpf_program fcode;
 279
 280         char errbuf[PCAP_ERRBUF_SIZE + 1];
 281         int dlt_count;
 282         u_int *dlt_list;
 283
 284         struct pcap_pkthdr pcap_header; /* This is needed for the pcap_next_ex() to work */
 285 };
 286
 287 /*
 288  * This is a timeval as stored in a savefile.
 289  * It has to use the same types everywhere, independent of the actual
 290  * `struct timeval'; `struct timeval' has 32-bit tv_sec values on some
 291  * platforms and 64-bit tv_sec values on other platforms, and writing
 292  * out native `struct timeval' values would mean files could only be
 293  * read on systems with the same tv_sec size as the system on which
 294  * the file was written.
 295  */
 296
 297 struct pcap_timeval {
 298     bpf_int32 tv_sec;           /* seconds */
 299     bpf_int32 tv_usec;          /* microseconds */
 300 };
 301
 302 /*
 303  * This is a `pcap_pkthdr' as actually stored in a savefile.
 304  *
 305  * Do not change the format of this structure, in any way (this includes
 306  * changes that only affect the length of fields in this structure),
 307  * and do not make the time stamp anything other than seconds and
 308  * microseconds (e.g., seconds and nanoseconds).  Instead:
 309  *
 310  *      introduce a new structure for the new format;
 311  *
 312  *      send mail to "tcpdump-workers@tcpdump.org", requesting a new
 313  *      magic number for your new capture file format, and, when
 314  *      you get the new magic number, put it in "savefile.c";
 315  *
 316  *      use that magic number for save files with the changed record
 317  *      header;
 318  *
 319  *      make the code in "savefile.c" capable of reading files with
 320  *      the old record header as well as files with the new record header
 321  *      (using the magic number to determine the header format).
 322  *
 323  * Then supply the changes to "patches@tcpdump.org", so that future
 324  * versions of libpcap and programs that use it (such as tcpdump) will
 325  * be able to read your new capture file format.
 326  */
 327
 328 struct pcap_sf_pkthdr {
 329     struct pcap_timeval ts;     /* time stamp */
 330     bpf_u_int32 caplen;         /* length of portion present */
 331     bpf_u_int32 len;            /* length this packet (off wire) */
 332 };
 333
 334 /*
 335  * How a `pcap_pkthdr' is actually stored in savefiles written
 336  * by some patched versions of libpcap (e.g. the ones in Red
 337  * Hat Linux 6.1 and 6.2).
 338  *
 339  * Do not change the format of this structure, in any way (this includes
 340  * changes that only affect the length of fields in this structure).
 341  * Instead, introduce a new structure, as per the above.
 342  */
 343
 344 struct pcap_sf_patched_pkthdr {
 345     struct pcap_timeval ts;     /* time stamp */
 346     bpf_u_int32 caplen;         /* length of portion present */
 347     bpf_u_int32 len;            /* length this packet (off wire) */
 348     int         index;
 349     unsigned short protocol;
 350     unsigned char pkt_type;
 351 };
 352
 353 int     yylex(void);
 354
 355 #ifndef min
 356 #define min(a, b) ((a) > (b) ? (b) : (a))
 357 #endif
 358
 359 /* XXX should these be in pcap.h? */
 360 int     pcap_offline_read(pcap_t *, int, pcap_handler, u_char *);
 361 int     pcap_read(pcap_t *, int cnt, pcap_handler, u_char *);
 362
 363 #ifndef HAVE_STRLCPY
 364 #define strlcpy(x, y, z) \
 365         (strncpy((x), (y), (z)), \
 366          ((z) <= 0 ? 0 : ((x)[(z) - 1] = '\0')), \
 367          strlen((y)))
 368 #endif
 369
 370 #include <stdarg.h>
 371
 372 #if !defined(HAVE_SNPRINTF)
 373 #define snprintf pcap_snprintf
 374 extern int snprintf (char *, size_t, const char *, ...);
 375 #endif
 376
 377 #if !defined(HAVE_VSNPRINTF)
 378 #define vsnprintf pcap_vsnprintf
 379 extern int vsnprintf (char *, size_t, const char *, va_list ap);
 380 #endif
 381
 382 /*
 383  * Routines that most pcap implementations can use for non-blocking mode.
 384  */
 385 #if !defined(WIN32) && !defined(MSDOS)
 386 int     pcap_getnonblock_fd(pcap_t *, char *);
 387 int     pcap_setnonblock_fd(pcap_t *p, int, char *);
 388 #endif
 389
 390 pcap_t  *pcap_create_common(const char *, char *);
 391 int     pcap_do_addexit(pcap_t *);
 392 void    pcap_add_to_pcaps_to_close(pcap_t *);
 393 void    pcap_remove_from_pcaps_to_close(pcap_t *);
 394 void    pcap_cleanup_live_common(pcap_t *);
 395 int     pcap_not_initialized(pcap_t *);
 396 int     pcap_check_activated(pcap_t *);
 397
 398 /*
 399  * Internal interfaces for "pcap_findalldevs()".
 400  *
 401  * "pcap_platform_finddevs()" is a platform-dependent routine to
 402  * add devices not found by the "standard" mechanisms (SIOCGIFCONF,
 403  * "getifaddrs()", etc..
 404  *
 405  * "pcap_add_if()" adds an interface to the list of interfaces.
 406  */
 407 int     pcap_platform_finddevs(pcap_if_t **, char *);
 408 int     add_addr_to_iflist(pcap_if_t **, const char *, u_int, struct sockaddr *,
 409             size_t, struct sockaddr *, size_t, struct sockaddr *, size_t,
 410             struct sockaddr *, size_t, char *);
 411 int     pcap_add_if(pcap_if_t **, const char *, u_int, const char *, char *);
 412 struct sockaddr *dup_sockaddr(struct sockaddr *, size_t);
 413 int     add_or_find_if(pcap_if_t **, pcap_if_t **, const char *, u_int,
 414             const char *, char *);
 415
 416 #ifdef WIN32
 417 char    *pcap_win32strerror(void);
 418 #endif
 419
 420 int     install_bpf_program(pcap_t *, struct bpf_program *);
 421
 422 int     pcap_strcasecmp(const char *, const char *);
 423
 424 #ifdef __cplusplus
 425 }
 426 #endif
 427
 428 #endif