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