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