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