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