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