]> The Tcpdump Group git mirrors - libpcap/blobdiff - pcap-int.h
pcap_create_interface() needs the interface name on Linux.
[libpcap] / pcap-int.h
index bfa2098825bdb5bc09541a190129b7574c9a3f20..c5a030f5fe5435cebbe21bde9ecb873adb14423d 100644 (file)
  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  * SUCH DAMAGE.
- *
- * @(#) $Header: /tcpdump/master/libpcap/pcap-int.h,v 1.21 2000-05-04 13:34:24 itojun Exp $ (LBL)
  */
 
 #ifndef pcap_int_h
-#define pcap_int_h
+#define        pcap_int_h
+
+#include <pcap/pcap.h>
 
-#include <pcap.h>
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#if defined(_WIN32)
+  /*
+   * Make sure Packet32.h doesn't define BPF structures that we've
+   * probably already defined as a result of including <pcap/pcap.h>.
+   */
+  #define BPF_MAJOR_VERSION
+  #include <Packet32.h>
+#elif defined(MSDOS)
+  #include <fcntl.h>
+  #include <io.h>
+#endif
+
+#if (defined(_MSC_VER) && (_MSC_VER <= 1200)) /* we are compiling with Visual Studio 6, that doesn't support the LL suffix*/
 
 /*
- * Savefile
+ * Swap byte ordering of unsigned long long timestamp on a big endian
+ * machine.
  */
-struct pcap_sf {
-       FILE *rfile;
-       int swapped;
-       int version_major;
-       int version_minor;
-       u_char *base;
+#define SWAPLL(ull)  ((ull & 0xff00000000000000) >> 56) | \
+                      ((ull & 0x00ff000000000000) >> 40) | \
+                      ((ull & 0x0000ff0000000000) >> 24) | \
+                      ((ull & 0x000000ff00000000) >> 8)  | \
+                      ((ull & 0x00000000ff000000) << 8)  | \
+                      ((ull & 0x0000000000ff0000) << 24) | \
+                      ((ull & 0x000000000000ff00) << 40) | \
+                      ((ull & 0x00000000000000ff) << 56)
+
+#else /* A recent Visual studio compiler or not VC */
+
+/*
+ * Swap byte ordering of unsigned long long timestamp on a big endian
+ * machine.
+ */
+#define SWAPLL(ull)  ((ull & 0xff00000000000000LL) >> 56) | \
+                      ((ull & 0x00ff000000000000LL) >> 40) | \
+                      ((ull & 0x0000ff0000000000LL) >> 24) | \
+                      ((ull & 0x000000ff00000000LL) >> 8)  | \
+                      ((ull & 0x00000000ff000000LL) << 8)  | \
+                      ((ull & 0x0000000000ff0000LL) << 24) | \
+                      ((ull & 0x000000000000ff00LL) << 40) | \
+                      ((ull & 0x00000000000000ffLL) << 56)
+
+#endif /* _MSC_VER */
+
+/*
+ * Maximum snapshot length.
+ *
+ * Somewhat arbitrary, but chosen to be:
+ *
+ *    1) big enough for maximum-size Linux loopback packets (65549)
+ *       and some USB packets captured with USBPcap:
+ *
+ *           http://desowin.org/usbpcap/
+ *
+ *       (> 131072, < 262144)
+ *
+ * and
+ *
+ *    2) small enough not to cause attempts to allocate huge amounts of
+ *       memory; some applications might use the snapshot length in a
+ *       savefile header to control the size of the buffer they allocate,
+ *       so a size of, say, 2^31-1 might not work well.
+ *
+ * We don't enforce this in pcap_set_snaplen(), but we use it internally.
+ */
+#define MAXIMUM_SNAPLEN                262144
+
+struct pcap_opt {
+       char    *device;
+       int     timeout;        /* timeout for buffering */
+       int     buffer_size;
+       int     promisc;
+       int     rfmon;          /* monitor mode */
+       int     immediate;      /* immediate mode - deliver packets as soon as they arrive */
+       int     tstamp_type;
+       int     tstamp_precision;
 };
 
-struct pcap_md {
-       struct pcap_stat stat;
-       /*XXX*/
-       int use_bpf;
-       u_long  TotPkts;        /* can't oflow for 79 hrs on ether */
-       u_long  TotAccepted;    /* count accepted by filter */
-       u_long  TotDrops;       /* count of dropped packets */
-       long    TotMissed;      /* missed by i/f during this run */
-       long    OrigMissed;     /* missed by i/f before this run */
-#ifdef linux
-       int pad;
-       int skip;
-       char *device;
+typedef int    (*activate_op_t)(pcap_t *);
+typedef int    (*can_set_rfmon_op_t)(pcap_t *);
+typedef int    (*read_op_t)(pcap_t *, int cnt, pcap_handler, u_char *);
+typedef int    (*inject_op_t)(pcap_t *, const void *, size_t);
+typedef int    (*setfilter_op_t)(pcap_t *, struct bpf_program *);
+typedef int    (*setdirection_op_t)(pcap_t *, pcap_direction_t);
+typedef int    (*set_datalink_op_t)(pcap_t *, int);
+typedef int    (*getnonblock_op_t)(pcap_t *, char *);
+typedef int    (*setnonblock_op_t)(pcap_t *, int, char *);
+typedef int    (*stats_op_t)(pcap_t *, struct pcap_stat *);
+#ifdef _WIN32
+typedef struct pcap_stat *(*stats_ex_op_t)(pcap_t *, int *);
+typedef int    (*setbuff_op_t)(pcap_t *, int);
+typedef int    (*setmode_op_t)(pcap_t *, int);
+typedef int    (*setmintocopy_op_t)(pcap_t *, int);
+typedef HANDLE (*getevent_op_t)(pcap_t *);
+typedef int    (*oid_get_request_op_t)(pcap_t *, bpf_u_int32, void *, size_t *);
+typedef int    (*oid_set_request_op_t)(pcap_t *, bpf_u_int32, const void *, size_t *);
+typedef u_int  (*sendqueue_transmit_op_t)(pcap_t *, pcap_send_queue *, int);
+typedef int    (*setuserbuffer_op_t)(pcap_t *, int);
+typedef int    (*live_dump_op_t)(pcap_t *, char *, int, int);
+typedef int    (*live_dump_ended_op_t)(pcap_t *, int);
+typedef PAirpcapHandle (*get_airpcap_handle_op_t)(pcap_t *);
 #endif
-};
+typedef void   (*cleanup_op_t)(pcap_t *);
 
+/*
+ * We put all the stuff used in the read code path at the beginning,
+ * to try to keep it together in the same cache line or lines.
+ */
 struct pcap {
-       int fd;
-       int snapshot;
-       int linktype;
-       int tzoff;              /* timezone offset */
-       int offset;             /* offset for proper alignment */
+       /*
+        * Method to call to read packets on a live capture.
+        */
+       read_op_t read_op;
+
+       /*
+        * Method to call to read packets from a savefile.
+        */
+       int (*next_packet_op)(pcap_t *, struct pcap_pkthdr *, u_char **);
 
-       struct pcap_sf sf;
-       struct pcap_md md;
+#ifdef _WIN32
+       ADAPTER *adapter;
+#else
+       int fd;
+       int selectable_fd;
+#endif /* _WIN32 */
 
        /*
         * Read buffer.
         */
        int bufsize;
-       u_char *buffer;
+       void *buffer;
        u_char *bp;
        int cc;
 
+       int break_loop;         /* flag set to force break from packet-reading loop */
+
+       void *priv;             /* private data for methods */
+
+       int swapped;
+       FILE *rfile;            /* null if live capture, non-null if savefile */
+       int fddipad;
+       struct pcap *next;      /* list of open pcaps that need stuff cleared on close */
+
+       /*
+        * File version number; meaningful only for a savefile, but we
+        * keep it here so that apps that (mistakenly) ask for the
+        * version numbers will get the same zero values that they
+        * always did.
+        */
+       int version_major;
+       int version_minor;
+
+       int snapshot;
+       int linktype;           /* Network linktype */
+       int linktype_ext;       /* Extended information stored in the linktype field of a file */
+       int tzoff;              /* timezone offset */
+       int offset;             /* offset for proper alignment */
+       int activated;          /* true if the capture is really started */
+       int oldstyle;           /* if we're opening with pcap_open_live() */
+
+       struct pcap_opt opt;
+
        /*
         * Place holder for pcap_next().
         */
        u_char *pkt;
 
-       
+#ifdef _WIN32
+       struct pcap_stat stat;          /* used for pcap_stats_ex() */
+#endif
+
+       /* We're accepting only packets in this direction/these directions. */
+       pcap_direction_t direction;
+
+       /*
+        * Flags to affect BPF code generation.
+        */
+       int bpf_codegen_flags;
+
        /*
         * Placeholder for filter code if bpf not in kernel.
         */
        struct bpf_program fcode;
 
-       char errbuf[PCAP_ERRBUF_SIZE];
+       char errbuf[PCAP_ERRBUF_SIZE + 1];
+       int dlt_count;
+       u_int *dlt_list;
+       int tstamp_type_count;
+       u_int *tstamp_type_list;
+       int tstamp_precision_count;
+       u_int *tstamp_precision_list;
+
+       struct pcap_pkthdr pcap_header; /* This is needed for the pcap_next_ex() to work */
+
+       /*
+        * More methods.
+        */
+       activate_op_t activate_op;
+       can_set_rfmon_op_t can_set_rfmon_op;
+       inject_op_t inject_op;
+       setfilter_op_t setfilter_op;
+       setdirection_op_t setdirection_op;
+       set_datalink_op_t set_datalink_op;
+       getnonblock_op_t getnonblock_op;
+       setnonblock_op_t setnonblock_op;
+       stats_op_t stats_op;
+
+       /*
+        * Routine to use as callback for pcap_next()/pcap_next_ex().
+        */
+       pcap_handler oneshot_callback;
+
+#ifdef _WIN32
+       /*
+        * These are, at least currently, specific to the Win32 NPF
+        * driver.
+        */
+       stats_ex_op_t stats_ex_op;
+       setbuff_op_t setbuff_op;
+       setmode_op_t setmode_op;
+       setmintocopy_op_t setmintocopy_op;
+       getevent_op_t getevent_op;
+       oid_get_request_op_t oid_get_request_op;
+       oid_set_request_op_t oid_set_request_op;
+       sendqueue_transmit_op_t sendqueue_transmit_op;
+       setuserbuffer_op_t setuserbuffer_op;
+       live_dump_op_t live_dump_op;
+       live_dump_ended_op_t live_dump_ended_op;
+       get_airpcap_handle_op_t get_airpcap_handle_op;
+#endif
+       cleanup_op_t cleanup_op;
 };
 
 /*
- * This is a timeval as stored in disk in a dumpfile.
+ * BPF code generation flags.
+ */
+#define BPF_SPECIAL_VLAN_HANDLING      0x00000001      /* special VLAN handling for Linux */
+
+/*
+ * This is a timeval as stored in a savefile.
  * It has to use the same types everywhere, independent of the actual
- * `struct timeval'
+ * `struct timeval'; `struct timeval' has 32-bit tv_sec values on some
+ * platforms and 64-bit tv_sec values on other platforms, and writing
+ * out native `struct timeval' values would mean files could only be
+ * read on systems with the same tv_sec size as the system on which
+ * the file was written.
  */
 
 struct pcap_timeval {
@@ -109,7 +294,33 @@ struct pcap_timeval {
 };
 
 /*
- * How a `pcap_pkthdr' is actually stored in the dumpfile.
+ * This is a `pcap_pkthdr' as actually stored in a savefile.
+ *
+ * Do not change the format of this structure, in any way (this includes
+ * changes that only affect the length of fields in this structure),
+ * and do not make the time stamp anything other than seconds and
+ * microseconds (e.g., seconds and nanoseconds).  Instead:
+ *
+ *     introduce a new structure for the new format;
+ *
+ *     send mail to "[email protected]", requesting
+ *     a new magic number for your new capture file format, and, when
+ *     you get the new magic number, put it in "savefile.c";
+ *
+ *     use that magic number for save files with the changed record
+ *     header;
+ *
+ *     make the code in "savefile.c" capable of reading files with
+ *     the old record header as well as files with the new record header
+ *     (using the magic number to determine the header format).
+ *
+ * Then supply the changes by forking the branch at
+ *
+ *     https://github.com/the-tcpdump-group/libpcap/issues
+ *
+ * and issuing a pull request, so that future versions of libpcap and
+ * programs that use it (such as tcpdump) will be able to read your new
+ * capture file format.
  */
 
 struct pcap_sf_pkthdr {
@@ -118,26 +329,194 @@ struct pcap_sf_pkthdr {
     bpf_u_int32 len;           /* length this packet (off wire) */
 };
 
-int    yylex(void);
+/*
+ * How a `pcap_pkthdr' is actually stored in savefiles written
+ * by some patched versions of libpcap (e.g. the ones in Red
+ * Hat Linux 6.1 and 6.2).
+ *
+ * Do not change the format of this structure, in any way (this includes
+ * changes that only affect the length of fields in this structure).
+ * Instead, introduce a new structure, as per the above.
+ */
+
+struct pcap_sf_patched_pkthdr {
+    struct pcap_timeval ts;    /* time stamp */
+    bpf_u_int32 caplen;                /* length of portion present */
+    bpf_u_int32 len;           /* length this packet (off wire) */
+    int                index;
+    unsigned short protocol;
+    unsigned char pkt_type;
+};
+
+/*
+ * User data structure for the one-shot callback used for pcap_next()
+ * and pcap_next_ex().
+ */
+struct oneshot_userdata {
+       struct pcap_pkthdr *hdr;
+       const u_char **pkt;
+       pcap_t *pd;
+};
 
 #ifndef min
 #define min(a, b) ((a) > (b) ? (b) : (a))
 #endif
 
-/* XXX should these be in pcap.h? */
 int    pcap_offline_read(pcap_t *, int, pcap_handler, u_char *);
-int    pcap_read(pcap_t *, int cnt, pcap_handler, u_char *);
-
-/* Ultrix pads to make everything line up on a nice boundary */
-#if defined(ultrix) || defined(__alpha) || defined(__NetBSD__)
-#define       PCAP_FDDIPAD 3
-#endif
 
 #ifndef HAVE_STRLCPY
 #define strlcpy(x, y, z) \
-       (strncpy((x), (y), (z)), (x)[(z) - 1] = '\0', strlen((y)))
+       (strncpy((x), (y), (z)), \
+        ((z) <= 0 ? 0 : ((x)[(z) - 1] = '\0')), \
+        strlen((y)))
+#endif
+
+#include <stdarg.h>
+
+/*
+ * For flagging arguments as format strings in MSVC.
+ */
+#if _MSC_VER >= 1400
+ #include <sal.h>
+ #if _MSC_VER > 1400
+  #define FORMAT_STRING(p) _Printf_format_string_ p
+ #else
+  #define FORMAT_STRING(p) __format_string p
+ #endif
+#else
+ #define FORMAT_STRING(p) p
+#endif
+
+/*
+ * On Windows, snprintf(), with that name and with C99 behavior - i.e.,
+ * guaranteeing that the formatted string is null-terminated - didn't
+ * appear until Visual Studio 2015.  Prior to that, the C runtime had
+ * only _snprintf(), which *doesn't* guarantee that the string is
+ * null-terminated if it is truncated due to the buffer being too
+ * small.  We therefore can't just define snprintf to be _snprintf
+ * and define vsnprintf to be _vsnprintf, as we're relying on null-
+ * termination of strings in all cases.
+ *
+ * We also want to allow this to be built with versions of Visual Studio
+ * prior to VS 2015, so we can't rely on snprintf() being present.
+ *
+ * And we want to make sure that, if we support plugins in the future,
+ * a routine with C99 snprintf() behavior will be available to them.
+ * We also don't want it to collide with the C library snprintf() if
+ * there is one.
+ *
+ * So we make pcap_snprintf() and pcap_vsnprintf() available, either by
+ * #defining them to be snprintf or vsnprintf, respectively, or by
+ * defining our own versions and exporting them.
+ */
+#ifdef HAVE_SNPRINTF
+#define pcap_snprintf snprintf
+#else
+extern int pcap_snprintf(char *, size_t, FORMAT_STRING(const char *), ...);
+#endif
+
+#ifdef HAVE_VSNPRINTF
+#define pcap_vsnprintf vsnprintf
+#else
+extern int pcap_vsnprintf(char *, size_t, const char *, va_list ap);
+#endif
+
+/*
+ * Does the packet count argument to a module's read routine say
+ * "supply packets until you run out of packets"?
+ */
+#define PACKET_COUNT_IS_UNLIMITED(count)       ((count) <= 0)
+
+/*
+ * Routines that most pcap implementations can use for non-blocking mode.
+ */
+#if !defined(_WIN32) && !defined(MSDOS)
+int    pcap_getnonblock_fd(pcap_t *, char *);
+int    pcap_setnonblock_fd(pcap_t *p, int, char *);
+#endif
+
+/*
+ * Internal interfaces for "pcap_create()".
+ *
+ * "pcap_create_interface()" is the routine to do a pcap_create on
+ * a regular network interface.  There are multiple implementations
+ * of this, one for each platform type (Linux, BPF, DLPI, etc.),
+ * with the one used chosen by the configure script.
+ *
+ * "pcap_create_common()" allocates and fills in a pcap_t, for use
+ * by pcap_create routines.
+ */
+pcap_t *pcap_create_interface(const char *, char *);
+pcap_t *pcap_create_common(char *, size_t);
+int    pcap_do_addexit(pcap_t *);
+void   pcap_add_to_pcaps_to_close(pcap_t *);
+void   pcap_remove_from_pcaps_to_close(pcap_t *);
+void   pcap_cleanup_live_common(pcap_t *);
+int    pcap_check_activated(pcap_t *);
+
+/*
+ * Internal interfaces for "pcap_findalldevs()".
+ *
+ * "pcap_platform_finddevs()" is a platform-dependent routine to
+ * find local network interfaces.
+ *
+ * "pcap_findalldevs_interfaces()" is a helper to find those interfaces
+ * using the "standard" mechanisms (SIOCGIFCONF, "getifaddrs()", etc.).
+ *
+ * "pcap_add_if()" adds an interface to the list of interfaces, for
+ * use by various "find interfaces" routines.
+ */
+int    pcap_platform_finddevs(pcap_if_t **, char *);
+#if !defined(_WIN32) && !defined(MSDOS)
+int    pcap_findalldevs_interfaces(pcap_if_t **, char *,
+           int (*)(const char *));
+#endif
+int    add_addr_to_iflist(pcap_if_t **, const char *, bpf_u_int32,
+           struct sockaddr *, size_t, struct sockaddr *, size_t,
+           struct sockaddr *, size_t, struct sockaddr *, size_t, char *);
+int    add_addr_to_dev(pcap_if_t *, struct sockaddr *, size_t,
+           struct sockaddr *, size_t, struct sockaddr *, size_t,
+           struct sockaddr *dstaddr, size_t, char *errbuf);
+int    pcap_add_if(pcap_if_t **, const char *, bpf_u_int32, const char *,
+           char *);
+int    add_or_find_if(pcap_if_t **, pcap_if_t **, const char *, bpf_u_int32,
+           const char *, char *);
+#ifndef _WIN32
+bpf_u_int32 if_flags_to_pcap_flags(const char *, u_int);
+#endif
+
+/*
+ * Internal interfaces for "pcap_open_offline()".
+ *
+ * "pcap_open_offline_common()" allocates and fills in a pcap_t, for use
+ * by pcap_open_offline routines.
+ *
+ * "sf_cleanup()" closes the file handle associated with a pcap_t, if
+ * appropriate, and frees all data common to all modules for handling
+ * savefile types.
+ */
+pcap_t *pcap_open_offline_common(char *ebuf, size_t size);
+void   sf_cleanup(pcap_t *p);
+
+/*
+ * Internal interfaces for both "pcap_create()" and routines that
+ * open savefiles.
+ *
+ * "pcap_oneshot()" is the standard one-shot callback for "pcap_next()"
+ * and "pcap_next_ex()".
+ */
+void   pcap_oneshot(u_char *, const struct pcap_pkthdr *, const u_char *);
+
+#ifdef _WIN32
+void   pcap_win32_err_to_str(DWORD, char *);
+#endif
+
+int    install_bpf_program(pcap_t *, struct bpf_program *);
+
+int    pcap_strcasecmp(const char *, const char *);
+
+#ifdef __cplusplus
+}
 #endif
 
-/* XXX */
-extern int pcap_fddipad;
 #endif