dist/libpcap/pcap.h

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