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.94 2008-09-16 00:20:23 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 extern CRITICAL_SECTION g_PcapCompileCriticalSection;
  48 #endif /* WIN32 */
  49
  50 #ifdef MSDOS
  51 #include <fcntl.h>
  52 #include <io.h>
  53 #endif
  54
  55 #if (defined(_MSC_VER) && (_MSC_VER <= 1200)) /* we are compiling with Visual Studio 6, that doesn't support the LL suffix*/
  56
  57 /*
  58  * Swap byte ordering of unsigned long long timestamp on a big endian
  59  * machine.
  60  */
  61 #define SWAPLL(ull)  ((ull & 0xff00000000000000) >> 56) | \
  62                       ((ull & 0x00ff000000000000) >> 40) | \
  63                       ((ull & 0x0000ff0000000000) >> 24) | \
  64                       ((ull & 0x000000ff00000000) >> 8)  | \
  65                       ((ull & 0x00000000ff000000) << 8)  | \
  66                       ((ull & 0x0000000000ff0000) << 24) | \
  67                       ((ull & 0x000000000000ff00) << 40) | \
  68                       ((ull & 0x00000000000000ff) << 56)
  69
  70 #else /* A recent Visual studio compiler or not VC */
  71
  72 /*
  73  * Swap byte ordering of unsigned long long timestamp on a big endian
  74  * machine.
  75  */
  76 #define SWAPLL(ull)  ((ull & 0xff00000000000000LL) >> 56) | \
  77                       ((ull & 0x00ff000000000000LL) >> 40) | \
  78                       ((ull & 0x0000ff0000000000LL) >> 24) | \
  79                       ((ull & 0x000000ff00000000LL) >> 8)  | \
  80                       ((ull & 0x00000000ff000000LL) << 8)  | \
  81                       ((ull & 0x0000000000ff0000LL) << 24) | \
  82                       ((ull & 0x000000000000ff00LL) << 40) | \
  83                       ((ull & 0x00000000000000ffLL) << 56)
  84
  85 #endif /* _MSC_VER */
  86
  87 struct pcap_opt {
  88         char    *source;
  89         int     timeout;        /* timeout for buffering */
  90         int     buffer_size;
  91         int     promisc;
  92         int     rfmon;          /* monitor mode */
  93         int     immediate;      /* immediate mode - deliver packets as soon as they arrive */
  94         int     tstamp_type;
  95 };
  96
  97 typedef int     (*activate_op_t)(pcap_t *);
  98 typedef int     (*can_set_rfmon_op_t)(pcap_t *);
  99 typedef int     (*read_op_t)(pcap_t *, int cnt, pcap_handler, u_char *);
 100 typedef int     (*inject_op_t)(pcap_t *, const void *, size_t);
 101 typedef int     (*setfilter_op_t)(pcap_t *, struct bpf_program *);
 102 typedef int     (*setdirection_op_t)(pcap_t *, pcap_direction_t);
 103 typedef int     (*set_datalink_op_t)(pcap_t *, int);
 104 typedef int     (*getnonblock_op_t)(pcap_t *, char *);
 105 typedef int     (*setnonblock_op_t)(pcap_t *, int, char *);
 106 typedef int     (*stats_op_t)(pcap_t *, struct pcap_stat *);
 107 #ifdef WIN32
 108 typedef int     (*setbuff_op_t)(pcap_t *, int);
 109 typedef int     (*setmode_op_t)(pcap_t *, int);
 110 typedef int     (*setmintocopy_op_t)(pcap_t *, int);
 111 typedef Adapter *(*getadapter_op_t)(pcap_t *);
 112 #endif
 113 typedef void    (*cleanup_op_t)(pcap_t *);
 114
 115 /*
 116  * We put all the stuff used in the read code path at the beginning,
 117  * to try to keep it together in the same cache line or lines.
 118  */
 119 struct pcap {
 120         /*
 121          * Method to call to read packets on a live capture.
 122          */
 123         read_op_t read_op;
 124
 125         /*
 126          * Method to call to read to read packets from a savefile.
 127          */
 128         int (*next_packet_op)(pcap_t *, struct pcap_pkthdr *, u_char **);
 129
 130 #ifdef WIN32
 131         ADAPTER *adapter;
 132         LPPACKET Packet;
 133         int nonblock;
 134 #else
 135         int fd;
 136         int selectable_fd;
 137 #endif /* WIN32 */
 138
 139         /*
 140          * Read buffer.
 141          */
 142         int bufsize;
 143         u_char *buffer;
 144         u_char *bp;
 145         int cc;
 146
 147         int break_loop;         /* flag set to force break from packet-reading loop */
 148
 149         void *private;          /* private data for methods */
 150
 151         int swapped;
 152         FILE *rfile;            /* null if live capture, non-null if savefile */
 153         int fddipad;
 154         struct pcap *next;      /* list of open pcaps that need stuff cleared on close */
 155
 156         /*
 157          * File version number; meaningful only for a savefile, but we
 158          * keep it here so that apps that (mistakenly) ask for the
 159          * version numbers will get the same zero values that they
 160          * always did.
 161          */
 162         int version_major;
 163         int version_minor;
 164
 165         int snapshot;
 166         int linktype;           /* Network linktype */
 167         int linktype_ext;       /* Extended information stored in the linktype field of a file */
 168         int tzoff;              /* timezone offset */
 169         int offset;             /* offset for proper alignment */
 170         int activated;          /* true if the capture is really started */
 171         int oldstyle;           /* if we're opening with pcap_open_live() */
 172
 173         struct pcap_opt opt;
 174
 175         /*
 176          * Place holder for pcap_next().
 177          */
 178         u_char *pkt;
 179
 180         /* We're accepting only packets in this direction/these directions. */
 181         pcap_direction_t direction;
 182
 183         /*
 184          * Placeholder for filter code if bpf not in kernel.
 185          */
 186         struct bpf_program fcode;
 187
 188         char errbuf[PCAP_ERRBUF_SIZE + 1];
 189         int dlt_count;
 190         u_int *dlt_list;
 191         int tstamp_type_count;
 192         u_int *tstamp_type_list;
 193
 194         struct pcap_pkthdr pcap_header; /* This is needed for the pcap_next_ex() to work */
 195
 196         /*
 197          * More methods.
 198          */
 199         activate_op_t activate_op;
 200         can_set_rfmon_op_t can_set_rfmon_op;
 201         inject_op_t inject_op;
 202         setfilter_op_t setfilter_op;
 203         setdirection_op_t setdirection_op;
 204         set_datalink_op_t set_datalink_op;
 205         getnonblock_op_t getnonblock_op;
 206         setnonblock_op_t setnonblock_op;
 207         stats_op_t stats_op;
 208
 209         /*
 210          * Routine to use as callback for pcap_next()/pcap_next_ex().
 211          */
 212         pcap_handler oneshot_callback;
 213
 214 #ifdef WIN32
 215         /*
 216          * These are, at least currently, specific to the Win32 NPF
 217          * driver.
 218          */
 219         setbuff_op_t setbuff_op;
 220         setmode_op_t setmode_op;
 221         setmintocopy_op_t setmintocopy_op;
 222         getadapter_op_t getadapter_op;
 223 #endif
 224         cleanup_op_t cleanup_op;
 225 };
 226
 227 /*
 228  * This is a timeval as stored in a savefile.
 229  * It has to use the same types everywhere, independent of the actual
 230  * `struct timeval'; `struct timeval' has 32-bit tv_sec values on some
 231  * platforms and 64-bit tv_sec values on other platforms, and writing
 232  * out native `struct timeval' values would mean files could only be
 233  * read on systems with the same tv_sec size as the system on which
 234  * the file was written.
 235  */
 236
 237 struct pcap_timeval {
 238     bpf_int32 tv_sec;           /* seconds */
 239     bpf_int32 tv_usec;          /* microseconds */
 240 };
 241
 242 /*
 243  * This is a `pcap_pkthdr' as actually stored in a savefile.
 244  *
 245  * Do not change the format of this structure, in any way (this includes
 246  * changes that only affect the length of fields in this structure),
 247  * and do not make the time stamp anything other than seconds and
 248  * microseconds (e.g., seconds and nanoseconds).  Instead:
 249  *
 250  *      introduce a new structure for the new format;
 251  *
 252  *      send mail to "tcpdump-workers@lists.tcpdump.org", requesting
 253  *      a new magic number for your new capture file format, and, when
 254  *      you get the new magic number, put it in "savefile.c";
 255  *
 256  *      use that magic number for save files with the changed record
 257  *      header;
 258  *
 259  *      make the code in "savefile.c" capable of reading files with
 260  *      the old record header as well as files with the new record header
 261  *      (using the magic number to determine the header format).
 262  *
 263  * Then supply the changes by forking the branch at
 264  *
 265  *      https://github.com/the-tcpdump-group/libpcap/issues
 266  *
 267  * and issuing a pull request, so that future versions of libpcap and
 268  * programs that use it (such as tcpdump) will be able to read your new
 269  * capture file format.
 270  */
 271
 272 struct pcap_sf_pkthdr {
 273     struct pcap_timeval ts;     /* time stamp */
 274     bpf_u_int32 caplen;         /* length of portion present */
 275     bpf_u_int32 len;            /* length this packet (off wire) */
 276 };
 277
 278 /*
 279  * How a `pcap_pkthdr' is actually stored in savefiles written
 280  * by some patched versions of libpcap (e.g. the ones in Red
 281  * Hat Linux 6.1 and 6.2).
 282  *
 283  * Do not change the format of this structure, in any way (this includes
 284  * changes that only affect the length of fields in this structure).
 285  * Instead, introduce a new structure, as per the above.
 286  */
 287
 288 struct pcap_sf_patched_pkthdr {
 289     struct pcap_timeval ts;     /* time stamp */
 290     bpf_u_int32 caplen;         /* length of portion present */
 291     bpf_u_int32 len;            /* length this packet (off wire) */
 292     int         index;
 293     unsigned short protocol;
 294     unsigned char pkt_type;
 295 };
 296
 297 /*
 298  * User data structure for the one-shot callback used for pcap_next()
 299  * and pcap_next_ex().
 300  */
 301 struct oneshot_userdata {
 302         struct pcap_pkthdr *hdr;
 303         const u_char **pkt;
 304         pcap_t *pd;
 305 };
 306
 307 int     yylex(void);
 308
 309 #ifndef min
 310 #define min(a, b) ((a) > (b) ? (b) : (a))
 311 #endif
 312
 313 /* XXX should these be in pcap.h? */
 314 int     pcap_offline_read(pcap_t *, int, pcap_handler, u_char *);
 315 int     pcap_read(pcap_t *, int cnt, pcap_handler, u_char *);
 316
 317 #ifndef HAVE_STRLCPY
 318 #define strlcpy(x, y, z) \
 319         (strncpy((x), (y), (z)), \
 320          ((z) <= 0 ? 0 : ((x)[(z) - 1] = '\0')), \
 321          strlen((y)))
 322 #endif
 323
 324 #include <stdarg.h>
 325
 326 #if !defined(HAVE_SNPRINTF)
 327 #define snprintf pcap_snprintf
 328 extern int snprintf (char *, size_t, const char *, ...);
 329 #endif
 330
 331 #if !defined(HAVE_VSNPRINTF)
 332 #define vsnprintf pcap_vsnprintf
 333 extern int vsnprintf (char *, size_t, const char *, va_list ap);
 334 #endif
 335
 336 /*
 337  * Routines that most pcap implementations can use for non-blocking mode.
 338  */
 339 #if !defined(WIN32) && !defined(MSDOS)
 340 int     pcap_getnonblock_fd(pcap_t *, char *);
 341 int     pcap_setnonblock_fd(pcap_t *p, int, char *);
 342 #endif
 343
 344 /*
 345  * Internal interfaces for "pcap_create()".
 346  *
 347  * "pcap_create_interface()" is the routine to do a pcap_create on
 348  * a regular network interface.  There are multiple implementations
 349  * of this, one for each platform type (Linux, BPF, DLPI, etc.),
 350  * with the one used chosen by the configure script.
 351  *
 352  * "pcap_create_common()" allocates and fills in a pcap_t, for use
 353  * by pcap_create routines.
 354  */
 355 pcap_t  *pcap_create_interface(const char *, char *);
 356 pcap_t  *pcap_create_common(const char *, char *, size_t);
 357 int     pcap_do_addexit(pcap_t *);
 358 void    pcap_add_to_pcaps_to_close(pcap_t *);
 359 void    pcap_remove_from_pcaps_to_close(pcap_t *);
 360 void    pcap_cleanup_live_common(pcap_t *);
 361 int     pcap_not_initialized(pcap_t *);
 362 int     pcap_check_activated(pcap_t *);
 363
 364 /*
 365  * Internal interfaces for "pcap_findalldevs()".
 366  *
 367  * "pcap_findalldevs_interfaces()" finds interfaces using the
 368  * "standard" mechanisms (SIOCGIFCONF, "getifaddrs()", etc.).
 369  *
 370  * "pcap_platform_finddevs()" is a platform-dependent routine to
 371  * add devices not found by the "standard" mechanisms.
 372  *
 373  * "pcap_add_if()" adds an interface to the list of interfaces, for
 374  * use by various "find interfaces" routines.
 375  */
 376 int     pcap_findalldevs_interfaces(pcap_if_t **, char *);
 377 int     pcap_platform_finddevs(pcap_if_t **, char *);
 378 int     add_addr_to_iflist(pcap_if_t **, const char *, u_int, struct sockaddr *,
 379             size_t, struct sockaddr *, size_t, struct sockaddr *, size_t,
 380             struct sockaddr *, size_t, char *);
 381 int     pcap_add_if(pcap_if_t **, const char *, u_int, const char *, char *);
 382 struct sockaddr *dup_sockaddr(struct sockaddr *, size_t);
 383 int     add_or_find_if(pcap_if_t **, pcap_if_t **, const char *, u_int,
 384             const char *, char *);
 385
 386 /*
 387  * Internal interfaces for "pcap_open_offline()".
 388  *
 389  * "pcap_open_offline_common()" allocates and fills in a pcap_t, for use
 390  * by pcap_open_offline routines.
 391  */
 392 pcap_t  *pcap_open_offline_common(char *ebuf, size_t size);
 393
 394 #ifdef WIN32
 395 char    *pcap_win32strerror(void);
 396 #endif
 397
 398 int     install_bpf_program(pcap_t *, struct bpf_program *);
 399
 400 int     pcap_strcasecmp(const char *, const char *);
 401
 402 #ifdef __cplusplus
 403 }
 404 #endif
 405
 406 #endif