Annotation of embedaddon/libnet/win32/wpdpack/Include/pcap/pcap.h, revision 1.1.1.1

1.1       misho       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/pcap.h,v 1.4.2.11 2008-10-06 15:38:39 gianluca Exp $ (LBL)
                     35:  */
                     36: 
                     37: #ifndef lib_pcap_pcap_h
                     38: #define lib_pcap_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@lists.tcpdump.org", requesting
                    112:  *     a new 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 as a patch at
                    123:  *
                    124:  *     http://sourceforge.net/projects/libpcap/
                    125:  *
                    126:  * so that future versions of libpcap and programs that use it (such as
                    127:  * tcpdump) will be able to read your new capture file format.
                    128:  */
                    129: struct pcap_file_header {
                    130:        bpf_u_int32 magic;
                    131:        u_short version_major;
                    132:        u_short version_minor;
                    133:        bpf_int32 thiszone;     /* gmt to local correction */
                    134:        bpf_u_int32 sigfigs;    /* accuracy of timestamps */
                    135:        bpf_u_int32 snaplen;    /* max length saved portion of each pkt */
                    136:        bpf_u_int32 linktype;   /* data link type (LINKTYPE_*) */
                    137: };
                    138: 
                    139: /*
                    140:  * Macros for the value returned by pcap_datalink_ext().
                    141:  * 
                    142:  * If LT_FCS_LENGTH_PRESENT(x) is true, the LT_FCS_LENGTH(x) macro
                    143:  * gives the FCS length of packets in the capture.
                    144:  */
                    145: #define LT_FCS_LENGTH_PRESENT(x)       ((x) & 0x04000000)
                    146: #define LT_FCS_LENGTH(x)               (((x) & 0xF0000000) >> 28)
                    147: #define LT_FCS_DATALINK_EXT(x)         ((((x) & 0xF) << 28) | 0x04000000)
                    148: 
                    149: typedef enum {
                    150:        PCAP_D_INOUT = 0,
                    151:        PCAP_D_IN,
                    152:        PCAP_D_OUT
                    153: } pcap_direction_t;
                    154: 
                    155: /*
                    156:  * Generic per-packet information, as supplied by libpcap.
                    157:  *
                    158:  * The time stamp can and should be a "struct timeval", regardless of
                    159:  * whether your system supports 32-bit tv_sec in "struct timeval",
                    160:  * 64-bit tv_sec in "struct timeval", or both if it supports both 32-bit
                    161:  * and 64-bit applications.  The on-disk format of savefiles uses 32-bit
                    162:  * tv_sec (and tv_usec); this structure is irrelevant to that.  32-bit
                    163:  * and 64-bit versions of libpcap, even if they're on the same platform,
                    164:  * should supply the appropriate version of "struct timeval", even if
                    165:  * that's not what the underlying packet capture mechanism supplies.
                    166:  */
                    167: struct pcap_pkthdr {
                    168:        struct timeval ts;      /* time stamp */
                    169:        bpf_u_int32 caplen;     /* length of portion present */
                    170:        bpf_u_int32 len;        /* length this packet (off wire) */
                    171: };
                    172: 
                    173: /*
                    174:  * As returned by the pcap_stats()
                    175:  */
                    176: struct pcap_stat {
                    177:        u_int ps_recv;          /* number of packets received */
                    178:        u_int ps_drop;          /* number of packets dropped */
                    179:        u_int ps_ifdrop;        /* drops by interface XXX not yet supported */
                    180: #ifdef HAVE_REMOTE
                    181:        u_int ps_capt;          /* number of packets that are received by the application; please get rid off the Win32 ifdef */
                    182:        u_int ps_sent;          /* number of packets sent by the server on the network */
                    183:        u_int ps_netdrop;       /* number of packets lost on the network */
                    184: #endif /* HAVE_REMOTE */
                    185: };
                    186: 
                    187: #ifdef MSDOS
                    188: /*
                    189:  * As returned by the pcap_stats_ex()
                    190:  */
                    191: struct pcap_stat_ex {
                    192:        u_long  rx_packets;        /* total packets received       */
                    193:        u_long  tx_packets;        /* total packets transmitted    */
                    194:        u_long  rx_bytes;          /* total bytes received         */
                    195:        u_long  tx_bytes;          /* total bytes transmitted      */
                    196:        u_long  rx_errors;         /* bad packets received         */
                    197:        u_long  tx_errors;         /* packet transmit problems     */
                    198:        u_long  rx_dropped;        /* no space in Rx buffers       */
                    199:        u_long  tx_dropped;        /* no space available for Tx    */
                    200:        u_long  multicast;         /* multicast packets received   */
                    201:        u_long  collisions;
                    202: 
                    203:        /* detailed rx_errors: */
                    204:        u_long  rx_length_errors;
                    205:        u_long  rx_over_errors;    /* receiver ring buff overflow  */
                    206:        u_long  rx_crc_errors;     /* recv'd pkt with crc error    */
                    207:        u_long  rx_frame_errors;   /* recv'd frame alignment error */
                    208:        u_long  rx_fifo_errors;    /* recv'r fifo overrun          */
                    209:        u_long  rx_missed_errors;  /* recv'r missed packet         */
                    210: 
                    211:        /* detailed tx_errors */
                    212:        u_long  tx_aborted_errors;
                    213:        u_long  tx_carrier_errors;
                    214:        u_long  tx_fifo_errors;
                    215:        u_long  tx_heartbeat_errors;
                    216:        u_long  tx_window_errors;
                    217:      };
                    218: #endif
                    219: 
                    220: /*
                    221:  * Item in a list of interfaces.
                    222:  */
                    223: struct pcap_if {
                    224:        struct pcap_if *next;
                    225:        char *name;             /* name to hand to "pcap_open_live()" */
                    226:        char *description;      /* textual description of interface, or NULL */
                    227:        struct pcap_addr *addresses;
                    228:        bpf_u_int32 flags;      /* PCAP_IF_ interface flags */
                    229: };
                    230: 
                    231: #define PCAP_IF_LOOPBACK       0x00000001      /* interface is loopback */
                    232: 
                    233: /*
                    234:  * Representation of an interface address.
                    235:  */
                    236: struct pcap_addr {
                    237:        struct pcap_addr *next;
                    238:        struct sockaddr *addr;          /* address */
                    239:        struct sockaddr *netmask;       /* netmask for that address */
                    240:        struct sockaddr *broadaddr;     /* broadcast address for that address */
                    241:        struct sockaddr *dstaddr;       /* P2P destination address for that address */
                    242: };
                    243: 
                    244: typedef void (*pcap_handler)(u_char *, const struct pcap_pkthdr *,
                    245:                             const u_char *);
                    246: 
                    247: /*
                    248:  * Error codes for the pcap API.
                    249:  * These will all be negative, so you can check for the success or
                    250:  * failure of a call that returns these codes by checking for a
                    251:  * negative value.
                    252:  */
                    253: #define PCAP_ERROR                     -1      /* generic error code */
                    254: #define PCAP_ERROR_BREAK               -2      /* loop terminated by pcap_breakloop */
                    255: #define PCAP_ERROR_NOT_ACTIVATED       -3      /* the capture needs to be activated */
                    256: #define PCAP_ERROR_ACTIVATED           -4      /* the operation can't be performed on already activated captures */
                    257: #define PCAP_ERROR_NO_SUCH_DEVICE      -5      /* no such device exists */
                    258: #define PCAP_ERROR_RFMON_NOTSUP                -6      /* this device doesn't support rfmon (monitor) mode */
                    259: #define PCAP_ERROR_NOT_RFMON           -7      /* operation supported only in monitor mode */
                    260: #define PCAP_ERROR_PERM_DENIED         -8      /* no permission to open the device */
                    261: #define PCAP_ERROR_IFACE_NOT_UP                -9      /* interface isn't up */
                    262: 
                    263: /*
                    264:  * Warning codes for the pcap API.
                    265:  * These will all be positive and non-zero, so they won't look like
                    266:  * errors.
                    267:  */
                    268: #define PCAP_WARNING                   1       /* generic warning code */
                    269: #define PCAP_WARNING_PROMISC_NOTSUP    2       /* this device doesn't support promiscuous mode */
                    270: 
                    271: char   *pcap_lookupdev(char *);
                    272: int    pcap_lookupnet(const char *, bpf_u_int32 *, bpf_u_int32 *, char *);
                    273: 
                    274: pcap_t *pcap_create(const char *, char *);
                    275: int    pcap_set_snaplen(pcap_t *, int);
                    276: int    pcap_set_promisc(pcap_t *, int);
                    277: int    pcap_can_set_rfmon(pcap_t *);
                    278: int    pcap_set_rfmon(pcap_t *, int);
                    279: int    pcap_set_timeout(pcap_t *, int);
                    280: int    pcap_set_buffer_size(pcap_t *, int);
                    281: int    pcap_activate(pcap_t *);
                    282: 
                    283: pcap_t *pcap_open_live(const char *, int, int, int, char *);
                    284: pcap_t *pcap_open_dead(int, int);
                    285: pcap_t *pcap_open_offline(const char *, char *);
                    286: #if defined(WIN32)
                    287: pcap_t  *pcap_hopen_offline(intptr_t, char *);
                    288: #if !defined(LIBPCAP_EXPORTS)
                    289: #define pcap_fopen_offline(f,b) \
                    290:        pcap_hopen_offline(_get_osfhandle(_fileno(f)), b)
                    291: #else /*LIBPCAP_EXPORTS*/
                    292: static pcap_t *pcap_fopen_offline(FILE *, char *);
                    293: #endif
                    294: #else /*WIN32*/
                    295: pcap_t *pcap_fopen_offline(FILE *, char *);
                    296: #endif /*WIN32*/
                    297: 
                    298: void   pcap_close(pcap_t *);
                    299: int    pcap_loop(pcap_t *, int, pcap_handler, u_char *);
                    300: int    pcap_dispatch(pcap_t *, int, pcap_handler, u_char *);
                    301: const u_char*
                    302:        pcap_next(pcap_t *, struct pcap_pkthdr *);
                    303: int    pcap_next_ex(pcap_t *, struct pcap_pkthdr **, const u_char **);
                    304: void   pcap_breakloop(pcap_t *);
                    305: int    pcap_stats(pcap_t *, struct pcap_stat *);
                    306: int    pcap_setfilter(pcap_t *, struct bpf_program *);
                    307: int    pcap_setdirection(pcap_t *, pcap_direction_t);
                    308: int    pcap_getnonblock(pcap_t *, char *);
                    309: int    pcap_setnonblock(pcap_t *, int, char *);
                    310: int    pcap_inject(pcap_t *, const void *, size_t);
                    311: int    pcap_sendpacket(pcap_t *, const u_char *, int);
                    312: const char *pcap_statustostr(int);
                    313: const char *pcap_strerror(int);
                    314: char   *pcap_geterr(pcap_t *);
                    315: void   pcap_perror(pcap_t *, char *);
                    316: int    pcap_compile(pcap_t *, struct bpf_program *, const char *, int,
                    317:            bpf_u_int32);
                    318: int    pcap_compile_nopcap(int, int, struct bpf_program *,
                    319:            const char *, int, bpf_u_int32);
                    320: void   pcap_freecode(struct bpf_program *);
                    321: int    pcap_offline_filter(struct bpf_program *, const struct pcap_pkthdr *,
                    322:            const u_char *);
                    323: int    pcap_datalink(pcap_t *);
                    324: int    pcap_datalink_ext(pcap_t *);
                    325: int    pcap_list_datalinks(pcap_t *, int **);
                    326: int    pcap_set_datalink(pcap_t *, int);
                    327: void   pcap_free_datalinks(int *);
                    328: int    pcap_datalink_name_to_val(const char *);
                    329: const char *pcap_datalink_val_to_name(int);
                    330: const char *pcap_datalink_val_to_description(int);
                    331: int    pcap_snapshot(pcap_t *);
                    332: int    pcap_is_swapped(pcap_t *);
                    333: int    pcap_major_version(pcap_t *);
                    334: int    pcap_minor_version(pcap_t *);
                    335: 
                    336: /* XXX */
                    337: FILE   *pcap_file(pcap_t *);
                    338: int    pcap_fileno(pcap_t *);
                    339: 
                    340: pcap_dumper_t *pcap_dump_open(pcap_t *, const char *);
                    341: pcap_dumper_t *pcap_dump_fopen(pcap_t *, FILE *fp);
                    342: FILE   *pcap_dump_file(pcap_dumper_t *);
                    343: long   pcap_dump_ftell(pcap_dumper_t *);
                    344: int    pcap_dump_flush(pcap_dumper_t *);
                    345: void   pcap_dump_close(pcap_dumper_t *);
                    346: void   pcap_dump(u_char *, const struct pcap_pkthdr *, const u_char *);
                    347: 
                    348: int    pcap_findalldevs(pcap_if_t **, char *);
                    349: void   pcap_freealldevs(pcap_if_t *);
                    350: 
                    351: const char *pcap_lib_version(void);
                    352: 
                    353: /* XXX this guy lives in the bpf tree */
                    354: u_int  bpf_filter(const struct bpf_insn *, const u_char *, u_int, u_int);
                    355: int    bpf_validate(const struct bpf_insn *f, int len);
                    356: char   *bpf_image(const struct bpf_insn *, int);
                    357: void   bpf_dump(const struct bpf_program *, int);
                    358: 
                    359: #if defined(WIN32)
                    360: 
                    361: /*
                    362:  * Win32 definitions
                    363:  */
                    364: 
                    365: int pcap_setbuff(pcap_t *p, int dim);
                    366: int pcap_setmode(pcap_t *p, int mode);
                    367: int pcap_setmintocopy(pcap_t *p, int size);
                    368: 
                    369: #ifdef WPCAP
                    370: /* Include file with the wpcap-specific extensions */
                    371: #include <Win32-Extensions.h>
                    372: #endif /* WPCAP */
                    373: 
                    374: #define MODE_CAPT 0
                    375: #define MODE_STAT 1
                    376: #define MODE_MON 2
                    377: 
                    378: #elif defined(MSDOS)
                    379: 
                    380: /*
                    381:  * MS-DOS definitions
                    382:  */
                    383: 
                    384: int  pcap_stats_ex (pcap_t *, struct pcap_stat_ex *);
                    385: void pcap_set_wait (pcap_t *p, void (*yield)(void), int wait);
                    386: u_long pcap_mac_packets (void);
                    387: 
                    388: #else /* UN*X */
                    389: 
                    390: /*
                    391:  * UN*X definitions
                    392:  */
                    393: 
                    394: int    pcap_get_selectable_fd(pcap_t *);
                    395: 
                    396: #endif /* WIN32/MSDOS/UN*X */
                    397: 
                    398: #ifdef HAVE_REMOTE
                    399: /* Includes most of the public stuff that is needed for the remote capture */
                    400: #include <remote-ext.h>
                    401: #endif  /* HAVE_REMOTE */
                    402: 
                    403: #ifdef __cplusplus
                    404: }
                    405: #endif
                    406: 
                    407: #endif

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>