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.88 2008-03-13 18:13:57 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 struct pcap_sf {
 100         FILE *rfile;
 101         int swapped;
 102         size_t hdrsize;
 103         swapped_type_t lengths_swapped;
 104         int version_major;
 105         int version_minor;
 106         u_char *base;
 107 };
 108
 109 struct pcap_md {
 110         struct pcap_stat stat;
 111         /*XXX*/
 112         int use_bpf;            /* using kernel filter */
 113         u_long  TotPkts;        /* can't oflow for 79 hrs on ether */
 114         u_long  TotAccepted;    /* count accepted by filter */
 115         u_long  TotDrops;       /* count of dropped packets */
 116         long    TotMissed;      /* missed by i/f during this run */
 117         long    OrigMissed;     /* missed by i/f before this run */
 118         char    *device;        /* device name */
 119 #ifdef linux
 120         int     sock_packet;    /* using Linux 2.0 compatible interface */
 121         int     cooked;         /* using SOCK_DGRAM rather than SOCK_RAW */
 122         int     ifindex;        /* interface index of device we're bound to */
 123         int     lo_ifindex;     /* interface index of the loopback device */
 124         struct pcap *next;      /* list of open promiscuous sock_packet pcaps */
 125         u_int   packets_read;   /* count of packets read with recvfrom() */
 126 #endif /* linux */
 127 #if defined(linux) || defined(SITA)
 128         int     timeout;        /* timeout specified to pcap_open_live */
 129         int     clear_promisc;  /* must clear promiscuous mode when we close */
 130 #endif /* linux || SITA */
 131
 132 #ifdef HAVE_DAG_API
 133 #ifdef HAVE_DAG_STREAMS_API
 134         u_char  *dag_mem_bottom;        /* DAG card current memory bottom pointer */
 135         u_char  *dag_mem_top;   /* DAG card current memory top pointer */
 136 #else /* HAVE_DAG_STREAMS_API */
 137         void    *dag_mem_base;  /* DAG card memory base address */
 138         u_int   dag_mem_bottom; /* DAG card current memory bottom offset */
 139         u_int   dag_mem_top;    /* DAG card current memory top offset */
 140 #endif /* HAVE_DAG_STREAMS_API */
 141         int     dag_fcs_bits;   /* Number of checksum bits from link layer */
 142         int     dag_offset_flags; /* Flags to pass to dag_offset(). */
 143         int     dag_stream;     /* DAG stream number */
 144         int     dag_timeout;    /* timeout specified to pcap_open_live.
 145                                  * Same as in linux above, introduce
 146                                  * generally? */
 147 #endif /* HAVE_DAG_API */
 148 };
 149
 150 /*
 151  * 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
 152  * Tru64 UNIX, and some versions of NetBSD pad FDDI packets to make everything
 153  * line up on a nice boundary.
 154  */
 155 #ifdef __NetBSD__
 156 #include <sys/param.h>  /* needed to declare __NetBSD_Version__ */
 157 #endif
 158
 159 #if defined(ultrix) || defined(__osf__) || (defined(__NetBSD__) && __NetBSD_Version__ > 106000000)
 160 #define       PCAP_FDDIPAD 3
 161 #endif
 162
 163 struct pcap {
 164 #ifdef WIN32
 165         ADAPTER *adapter;
 166         LPPACKET Packet;
 167         int timeout;
 168         int nonblock;
 169 #else
 170         int fd;
 171         int selectable_fd;
 172         int send_fd;
 173 #endif /* WIN32 */
 174
 175 #ifdef HAVE_LIBDLPI
 176         dlpi_handle_t dlpi_hd;
 177 #endif
 178         int snapshot;
 179         int linktype;           /* Network linktype */
 180         int linktype_ext;       /* Extended information stored in the linktype field of a file */
 181         int tzoff;              /* timezone offset */
 182         int offset;             /* offset for proper alignment */
 183
 184         int break_loop;         /* flag set to force break from packet-reading loop */
 185
 186 #ifdef PCAP_FDDIPAD
 187         int fddipad;
 188 #endif
 189
 190 #ifdef MSDOS
 191         int inter_packet_wait;   /* offline: wait between packets */
 192         void (*wait_proc)(void); /*          call proc while waiting */
 193 #endif
 194
 195         struct pcap_sf sf;
 196         struct pcap_md md;
 197
 198         /*
 199          * Read buffer.
 200          */
 201         int bufsize;
 202         u_char *buffer;
 203         u_char *bp;
 204         int cc;
 205
 206         /*
 207          * Place holder for pcap_next().
 208          */
 209         u_char *pkt;
 210
 211         /* We're accepting only packets in this direction/these directions. */
 212         pcap_direction_t direction;
 213
 214         /*
 215          * Methods.
 216          */
 217         int     (*read_op)(pcap_t *, int cnt, pcap_handler, u_char *);
 218         int     (*inject_op)(pcap_t *, const void *, size_t);
 219         int     (*setfilter_op)(pcap_t *, struct bpf_program *);
 220         int     (*setdirection_op)(pcap_t *, pcap_direction_t);
 221         int     (*set_datalink_op)(pcap_t *, int);
 222         int     (*getnonblock_op)(pcap_t *, char *);
 223         int     (*setnonblock_op)(pcap_t *, int, char *);
 224         int     (*stats_op)(pcap_t *, struct pcap_stat *);
 225 #ifdef WIN32
 226         /*
 227          * Win32-only; given the way the buffer size is set with BPF,
 228          * to make this cross-platform we'll have to set the buffer
 229          * size at open time.
 230          */
 231         int     (*setbuff_op)(pcap_t *, int);
 232
 233         /*
 234          * These are, at least currently, specific to the Win32 NPF
 235          * driver.
 236          */
 237         int     (*setmode_op)(pcap_t *, int);
 238         int     (*setmintocopy_op)(pcap_t *, int);
 239 #endif
 240         void    (*close_op)(pcap_t *);
 241
 242         /*
 243          * Placeholder for filter code if bpf not in kernel.
 244          */
 245         struct bpf_program fcode;
 246
 247         char errbuf[PCAP_ERRBUF_SIZE + 1];
 248         int dlt_count;
 249         u_int *dlt_list;
 250
 251         struct pcap_pkthdr pcap_header; /* This is needed for the pcap_next_ex() to work */
 252 };
 253
 254 /*
 255  * This is a timeval as stored in a savefile.
 256  * It has to use the same types everywhere, independent of the actual
 257  * `struct timeval'; `struct timeval' has 32-bit tv_sec values on some
 258  * platforms and 64-bit tv_sec values on other platforms, and writing
 259  * out native `struct timeval' values would mean files could only be
 260  * read on systems with the same tv_sec size as the system on which
 261  * the file was written.
 262  */
 263
 264 struct pcap_timeval {
 265     bpf_int32 tv_sec;           /* seconds */
 266     bpf_int32 tv_usec;          /* microseconds */
 267 };
 268
 269 /*
 270  * This is a `pcap_pkthdr' as actually stored in a savefile.
 271  *
 272  * Do not change the format of this structure, in any way (this includes
 273  * changes that only affect the length of fields in this structure),
 274  * and do not make the time stamp anything other than seconds and
 275  * microseconds (e.g., seconds and nanoseconds).  Instead:
 276  *
 277  *      introduce a new structure for the new format;
 278  *
 279  *      send mail to "tcpdump-workers@tcpdump.org", requesting a new
 280  *      magic number for your new capture file format, and, when
 281  *      you get the new magic number, put it in "savefile.c";
 282  *
 283  *      use that magic number for save files with the changed record
 284  *      header;
 285  *
 286  *      make the code in "savefile.c" capable of reading files with
 287  *      the old record header as well as files with the new record header
 288  *      (using the magic number to determine the header format).
 289  *
 290  * Then supply the changes to "patches@tcpdump.org", so that future
 291  * versions of libpcap and programs that use it (such as tcpdump) will
 292  * be able to read your new capture file format.
 293  */
 294
 295 struct pcap_sf_pkthdr {
 296     struct pcap_timeval ts;     /* time stamp */
 297     bpf_u_int32 caplen;         /* length of portion present */
 298     bpf_u_int32 len;            /* length this packet (off wire) */
 299 };
 300
 301 /*
 302  * How a `pcap_pkthdr' is actually stored in savefiles written
 303  * by some patched versions of libpcap (e.g. the ones in Red
 304  * Hat Linux 6.1 and 6.2).
 305  *
 306  * Do not change the format of this structure, in any way (this includes
 307  * changes that only affect the length of fields in this structure).
 308  * Instead, introduce a new structure, as per the above.
 309  */
 310
 311 struct pcap_sf_patched_pkthdr {
 312     struct pcap_timeval ts;     /* time stamp */
 313     bpf_u_int32 caplen;         /* length of portion present */
 314     bpf_u_int32 len;            /* length this packet (off wire) */
 315     int         index;
 316     unsigned short protocol;
 317     unsigned char pkt_type;
 318 };
 319
 320 int     yylex(void);
 321
 322 #ifndef min
 323 #define min(a, b) ((a) > (b) ? (b) : (a))
 324 #endif
 325
 326 /* XXX should these be in pcap.h? */
 327 int     pcap_offline_read(pcap_t *, int, pcap_handler, u_char *);
 328 int     pcap_read(pcap_t *, int cnt, pcap_handler, u_char *);
 329
 330 #ifndef HAVE_STRLCPY
 331 #define strlcpy(x, y, z) \
 332         (strncpy((x), (y), (z)), \
 333          ((z) <= 0 ? 0 : ((x)[(z) - 1] = '\0')), \
 334          strlen((y)))
 335 #endif
 336
 337 #include <stdarg.h>
 338
 339 #if !defined(HAVE_SNPRINTF)
 340 #define snprintf pcap_snprintf
 341 extern int snprintf (char *, size_t, const char *, ...);
 342 #endif
 343
 344 #if !defined(HAVE_VSNPRINTF)
 345 #define vsnprintf pcap_vsnprintf
 346 extern int vsnprintf (char *, size_t, const char *, va_list ap);
 347 #endif
 348
 349 /*
 350  * Routines that most pcap implementations can use for non-blocking mode.
 351  */
 352 #if !defined(WIN32) && !defined(MSDOS)
 353 int     pcap_getnonblock_fd(pcap_t *, char *);
 354 int     pcap_setnonblock_fd(pcap_t *p, int, char *);
 355 #endif
 356
 357 void    pcap_close_common(pcap_t *);
 358
 359 /*
 360  * Internal interfaces for "pcap_findalldevs()".
 361  *
 362  * "pcap_platform_finddevs()" is a platform-dependent routine to
 363  * add devices not found by the "standard" mechanisms (SIOCGIFCONF,
 364  * "getifaddrs()", etc..
 365  *
 366  * "pcap_add_if()" adds an interface to the list of interfaces.
 367  */
 368 int     pcap_platform_finddevs(pcap_if_t **, char *);
 369 int     add_addr_to_iflist(pcap_if_t **, const char *, u_int, struct sockaddr *,
 370             size_t, struct sockaddr *, size_t, struct sockaddr *, size_t,
 371             struct sockaddr *, size_t, char *);
 372 int     pcap_add_if(pcap_if_t **, const char *, u_int, const char *, char *);
 373 struct sockaddr *dup_sockaddr(struct sockaddr *, size_t);
 374 int     add_or_find_if(pcap_if_t **, pcap_if_t **, const char *, u_int,
 375             const char *, char *);
 376
 377 #ifdef WIN32
 378 char    *pcap_win32strerror(void);
 379 #endif
 380
 381 int     install_bpf_program(pcap_t *, struct bpf_program *);
 382
 383 int     pcap_strcasecmp(const char *, const char *);
 384
 385 #ifdef __cplusplus
 386 }
 387 #endif
 388
 389 #endif