os/boardsupport/emulator/emulatorbsp/wpdpack/include/pcap.h
author sl@SLION-WIN7.fritz.box
Fri, 15 Jun 2012 03:10:57 +0200
changeset 0 bde4ae8d615e
permissions -rw-r--r--
First public contribution.
     1 /* -*- Mode: c; tab-width: 8; indent-tabs-mode: 1; c-basic-offset: 8; -*- */
     2 /*
     3  * Copyright (c) 1993, 1994, 1995, 1996, 1997
     4  *	The Regents of the University of California.  All rights reserved.
     5  *
     6  * Redistribution and use in source and binary forms, with or without
     7  * modification, are permitted provided that the following conditions
     8  * are met:
     9  * 1. Redistributions of source code must retain the above copyright
    10  *    notice, this list of conditions and the following disclaimer.
    11  * 2. Redistributions in binary form must reproduce the above copyright
    12  *    notice, this list of conditions and the following disclaimer in the
    13  *    documentation and/or other materials provided with the distribution.
    14  * 3. All advertising materials mentioning features or use of this software
    15  *    must display the following acknowledgement:
    16  *	This product includes software developed by the Computer Systems
    17  *	Engineering Group at Lawrence Berkeley Laboratory.
    18  * 4. Neither the name of the University nor of the Laboratory may be used
    19  *    to endorse or promote products derived from this software without
    20  *    specific prior written permission.
    21  *
    22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
    23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
    25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
    26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
    27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
    28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
    29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
    30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
    31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
    32  * SUCH DAMAGE.
    33  *
    34  * @(#) $Header: /tcpdump/master/libpcap/pcap.h,v 1.52.2.6 2006/02/09 22:26:49 guy Exp $ (LBL)
    35  */
    36 
    37 #ifndef lib_pcap_h
    38 #define lib_pcap_h
    39 
    40 #if defined(WIN32)
    41   #include "pcap-stdinc.h"
    42 #elif defined(MSDOS)
    43   #include <sys/types.h>
    44   #include <sys/socket.h>  /* u_int, u_char etc. */
    45 #else /* UN*X */
    46   #include <sys/types.h>
    47   #include <sys/time.h>
    48 #endif /* WIN32/MSDOS/UN*X */
    49 
    50 #ifndef PCAP_DONT_INCLUDE_PCAP_BPF_H
    51 #include "pcap-bpf.h"
    52 #endif
    53 
    54 #include <stdio.h>
    55 
    56 #ifdef HAVE_REMOTE
    57 	// We have to define the SOCKET here, although it has been defined in sockutils.h
    58 	// This is to avoid the distribution of the 'sockutils.h' file around
    59 	// (for example in the WinPcap developer's pack)
    60 	#ifndef SOCKET
    61 		#ifdef WIN32
    62 			#define SOCKET unsigned int
    63 		#else
    64 			#define SOCKET int
    65 		#endif
    66 	#endif
    67 #endif
    68 
    69 #ifdef __cplusplus
    70 extern "C" {
    71 #endif
    72 
    73 #define PCAP_VERSION_MAJOR 2
    74 #define PCAP_VERSION_MINOR 4
    75 
    76 #define PCAP_ERRBUF_SIZE 256
    77 
    78 /*
    79  * Compatibility for systems that have a bpf.h that
    80  * predates the bpf typedefs for 64-bit support.
    81  */
    82 #if BPF_RELEASE - 0 < 199406
    83 typedef	int bpf_int32;
    84 typedef	u_int bpf_u_int32;
    85 #endif
    86 
    87 typedef struct pcap pcap_t;
    88 typedef struct pcap_dumper pcap_dumper_t;
    89 typedef struct pcap_if pcap_if_t;
    90 typedef struct pcap_addr pcap_addr_t;
    91 
    92 /*
    93  * The first record in the file contains saved values for some
    94  * of the flags used in the printout phases of tcpdump.
    95  * Many fields here are 32 bit ints so compilers won't insert unwanted
    96  * padding; these files need to be interchangeable across architectures.
    97  *
    98  * Do not change the layout of this structure, in any way (this includes
    99  * changes that only affect the length of fields in this structure).
   100  *
   101  * Also, do not change the interpretation of any of the members of this
   102  * structure, in any way (this includes using values other than
   103  * LINKTYPE_ values, as defined in "savefile.c", in the "linktype"
   104  * field).
   105  *
   106  * Instead:
   107  *
   108  *	introduce a new structure for the new format, if the layout
   109  *	of the structure changed;
   110  *
   111  *	send mail to "tcpdump-workers@tcpdump.org", requesting a new
   112  *	magic number for your new capture file format, and, when
   113  *	you get the new magic number, put it in "savefile.c";
   114  *
   115  *	use that magic number for save files with the changed file
   116  *	header;
   117  *
   118  *	make the code in "savefile.c" capable of reading files with
   119  *	the old file header as well as files with the new file header
   120  *	(using the magic number to determine the header format).
   121  *
   122  * Then supply the changes to "patches@tcpdump.org", so that future
   123  * versions of libpcap and programs that use it (such as tcpdump) will
   124  * be able to read your new capture file format.
   125  */
   126 struct pcap_file_header {
   127 	bpf_u_int32 magic;
   128 	u_short version_major;
   129 	u_short version_minor;
   130 	bpf_int32 thiszone;	/* gmt to local correction */
   131 	bpf_u_int32 sigfigs;	/* accuracy of timestamps */
   132 	bpf_u_int32 snaplen;	/* max length saved portion of each pkt */
   133 	bpf_u_int32 linktype;	/* data link type (LINKTYPE_*) */
   134 };
   135 
   136 typedef enum {
   137        PCAP_D_INOUT = 0,
   138        PCAP_D_IN,
   139        PCAP_D_OUT
   140 } pcap_direction_t;
   141 
   142 /*
   143  * Generic per-packet information, as supplied by libpcap.
   144  *
   145  * The time stamp can and should be a "struct timeval", regardless of
   146  * whether your system supports 32-bit tv_sec in "struct timeval",
   147  * 64-bit tv_sec in "struct timeval", or both if it supports both 32-bit
   148  * and 64-bit applications.  The on-disk format of savefiles uses 32-bit
   149  * tv_sec (and tv_usec); this structure is irrelevant to that.  32-bit
   150  * and 64-bit versions of libpcap, even if they're on the same platform,
   151  * should supply the appropriate version of "struct timeval", even if
   152  * that's not what the underlying packet capture mechanism supplies.
   153  */
   154 struct pcap_pkthdr {
   155 	struct timeval ts;	/* time stamp */
   156 	bpf_u_int32 caplen;	/* length of portion present */
   157 	bpf_u_int32 len;	/* length this packet (off wire) */
   158 };
   159 
   160 /*
   161  * As returned by the pcap_stats()
   162  */
   163 struct pcap_stat {
   164 	u_int ps_recv;		/* number of packets received */
   165 	u_int ps_drop;		/* number of packets dropped */
   166 	u_int ps_ifdrop;	/* drops by interface XXX not yet supported */
   167 #ifdef HAVE_REMOTE
   168 	u_int ps_capt;		/* number of packets that are received by the application; please get rid off the Win32 ifdef */
   169 	u_int ps_sent;		/* number of packets sent by the server on the network */
   170 	u_int ps_netdrop;	/* number of packets lost on the network */
   171 #endif /* HAVE_REMOTE */
   172 };
   173 
   174 #ifdef MSDOS
   175 /*
   176  * As returned by the pcap_stats_ex()
   177  */
   178 struct pcap_stat_ex {
   179        u_long  rx_packets;        /* total packets received       */
   180        u_long  tx_packets;        /* total packets transmitted    */
   181        u_long  rx_bytes;          /* total bytes received         */
   182        u_long  tx_bytes;          /* total bytes transmitted      */
   183        u_long  rx_errors;         /* bad packets received         */
   184        u_long  tx_errors;         /* packet transmit problems     */
   185        u_long  rx_dropped;        /* no space in Rx buffers       */
   186        u_long  tx_dropped;        /* no space available for Tx    */
   187        u_long  multicast;         /* multicast packets received   */
   188        u_long  collisions;
   189 
   190        /* detailed rx_errors: */
   191        u_long  rx_length_errors;
   192        u_long  rx_over_errors;    /* receiver ring buff overflow  */
   193        u_long  rx_crc_errors;     /* recv'd pkt with crc error    */
   194        u_long  rx_frame_errors;   /* recv'd frame alignment error */
   195        u_long  rx_fifo_errors;    /* recv'r fifo overrun          */
   196        u_long  rx_missed_errors;  /* recv'r missed packet         */
   197 
   198        /* detailed tx_errors */
   199        u_long  tx_aborted_errors;
   200        u_long  tx_carrier_errors;
   201        u_long  tx_fifo_errors;
   202        u_long  tx_heartbeat_errors;
   203        u_long  tx_window_errors;
   204      };
   205 #endif
   206 
   207 /*
   208  * Item in a list of interfaces.
   209  */
   210 struct pcap_if {
   211 	struct pcap_if *next;
   212 	char *name;		/* name to hand to "pcap_open_live()" */
   213 	char *description;	/* textual description of interface, or NULL */
   214 	struct pcap_addr *addresses;
   215 	bpf_u_int32 flags;	/* PCAP_IF_ interface flags */
   216 };
   217 
   218 #define PCAP_IF_LOOPBACK	0x00000001	/* interface is loopback */
   219 
   220 /*
   221  * Representation of an interface address.
   222  */
   223 struct pcap_addr {
   224 	struct pcap_addr *next;
   225 	struct sockaddr *addr;		/* address */
   226 	struct sockaddr *netmask;	/* netmask for that address */
   227 	struct sockaddr *broadaddr;	/* broadcast address for that address */
   228 	struct sockaddr *dstaddr;	/* P2P destination address for that address */
   229 };
   230 
   231 typedef void (*pcap_handler)(u_char *, const struct pcap_pkthdr *,
   232 			     const u_char *);
   233 
   234 char	*pcap_lookupdev(char *);
   235 int	pcap_lookupnet(const char *, bpf_u_int32 *, bpf_u_int32 *, char *);
   236 pcap_t	*pcap_open_live(const char *, int, int, int, char *);
   237 pcap_t	*pcap_open_dead(int, int);
   238 pcap_t	*pcap_open_offline(const char *, char *);
   239 pcap_t	*pcap_fopen_offline(FILE *, char *);
   240 void	pcap_close(pcap_t *);
   241 int	pcap_loop(pcap_t *, int, pcap_handler, u_char *);
   242 int	pcap_dispatch(pcap_t *, int, pcap_handler, u_char *);
   243 const u_char*
   244 	pcap_next(pcap_t *, struct pcap_pkthdr *);
   245 int 	pcap_next_ex(pcap_t *, struct pcap_pkthdr **, const u_char **);
   246 void	pcap_breakloop(pcap_t *);
   247 int	pcap_stats(pcap_t *, struct pcap_stat *);
   248 int	pcap_setfilter(pcap_t *, struct bpf_program *);
   249 int 	pcap_setdirection(pcap_t *, pcap_direction_t);
   250 int	pcap_getnonblock(pcap_t *, char *);
   251 int	pcap_setnonblock(pcap_t *, int, char *);
   252 void	pcap_perror(pcap_t *, char *);
   253 int	pcap_inject(pcap_t *, const void *, size_t);
   254 int	pcap_sendpacket(pcap_t *, const u_char *, int);
   255 char	*pcap_strerror(int);
   256 char	*pcap_geterr(pcap_t *);
   257 int	pcap_compile(pcap_t *, struct bpf_program *, char *, int,
   258 	    bpf_u_int32);
   259 int	pcap_compile_nopcap(int, int, struct bpf_program *,
   260 	    char *, int, bpf_u_int32);
   261 void	pcap_freecode(struct bpf_program *);
   262 int	pcap_datalink(pcap_t *);
   263 int	pcap_list_datalinks(pcap_t *, int **);
   264 int	pcap_set_datalink(pcap_t *, int);
   265 int	pcap_datalink_name_to_val(const char *);
   266 const char *pcap_datalink_val_to_name(int);
   267 const char *pcap_datalink_val_to_description(int);
   268 int	pcap_snapshot(pcap_t *);
   269 int	pcap_is_swapped(pcap_t *);
   270 int	pcap_major_version(pcap_t *);
   271 int	pcap_minor_version(pcap_t *);
   272 
   273 /* XXX */
   274 FILE	*pcap_file(pcap_t *);
   275 int	pcap_fileno(pcap_t *);
   276 
   277 pcap_dumper_t *pcap_dump_open(pcap_t *, const char *);
   278 pcap_dumper_t *pcap_dump_fopen(pcap_t *, FILE *fp);
   279 FILE	*pcap_dump_file(pcap_dumper_t *);
   280 long	pcap_dump_ftell(pcap_dumper_t *);
   281 int	pcap_dump_flush(pcap_dumper_t *);
   282 void	pcap_dump_close(pcap_dumper_t *);
   283 void	pcap_dump(u_char *, const struct pcap_pkthdr *, const u_char *);
   284 
   285 int	pcap_findalldevs(pcap_if_t **, char *);
   286 void	pcap_freealldevs(pcap_if_t *);
   287 
   288 const char *pcap_lib_version(void);
   289 
   290 /* XXX this guy lives in the bpf tree */
   291 u_int	bpf_filter(struct bpf_insn *, u_char *, u_int, u_int);
   292 int	bpf_validate(struct bpf_insn *f, int len);
   293 char	*bpf_image(struct bpf_insn *, int);
   294 void	bpf_dump(struct bpf_program *, int);
   295 
   296 #if defined(WIN32)
   297 
   298 /*
   299  * Win32 definitions
   300  */
   301 
   302 int pcap_setbuff(pcap_t *p, int dim);
   303 int pcap_setmode(pcap_t *p, int mode);
   304 int pcap_setmintocopy(pcap_t *p, int size);
   305 
   306 #ifdef WPCAP
   307 /* Include file with the wpcap-specific extensions */
   308 #include <Win32-Extensions.h>
   309 #endif /* WPCAP */
   310 
   311 #define MODE_CAPT 0
   312 #define MODE_STAT 1
   313 #define MODE_MON 2
   314 
   315 #elif defined(MSDOS)
   316 
   317 /*
   318  * MS-DOS definitions
   319  */
   320 
   321 int  pcap_stats_ex (pcap_t *, struct pcap_stat_ex *);
   322 void pcap_set_wait (pcap_t *p, void (*yield)(void), int wait);
   323 u_long pcap_mac_packets (void);
   324 
   325 #else /* UN*X */
   326 
   327 /*
   328  * UN*X definitions
   329  */
   330 
   331 int	pcap_get_selectable_fd(pcap_t *);
   332 
   333 #endif /* WIN32/MSDOS/UN*X */
   334 
   335 #ifdef HAVE_REMOTE
   336 /* Includes most of the public stuff that is needed for the remote capture */
   337 #include "remote-ext.h"
   338 #endif	 /* HAVE_REMOTE */
   339 
   340 #ifdef __cplusplus
   341 }
   342 #endif
   343 
   344 #endif