contrib/libpcap/pcap.h

   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.34 2001/12/09 05:10:03 guy Exp $ (LBL)
  35  *
  36  * $FreeBSD$
  37  */
  38
  39 #ifndef lib_pcap_h
  40 #define lib_pcap_h
  41
  42 #include <sys/types.h>
  43 #include <sys/time.h>
  44
  45 #include <net/bpf.h>
  46
  47 #include <stdio.h>
  48
  49 #ifdef __cplusplus
  50 extern "C" {
  51 #endif
  52
  53 #define PCAP_VERSION_MAJOR 2
  54 #define PCAP_VERSION_MINOR 4
  55
  56 #define PCAP_ERRBUF_SIZE 256
  57
  58 /*
  59  * Compatibility for systems that have a bpf.h that
  60  * predates the bpf typedefs for 64-bit support.
  61  */
  62 #if BPF_RELEASE - 0 < 199406
  63 typedef int bpf_int32;
  64 typedef u_int bpf_u_int32;
  65 #endif
  66
  67 typedef struct pcap pcap_t;
  68 typedef struct pcap_dumper pcap_dumper_t;
  69 typedef struct pcap_if pcap_if_t;
  70 typedef struct pcap_addr pcap_addr_t;
  71
  72 /*
  73  * The first record in the file contains saved values for some
  74  * of the flags used in the printout phases of tcpdump.
  75  * Many fields here are 32 bit ints so compilers won't insert unwanted
  76  * padding; these files need to be interchangeable across architectures.
  77  *
  78  * Do not change the layout of this structure, in any way (this includes
  79  * changes that only affect the length of fields in this structure).
  80  *
  81  * Also, do not change the interpretation of any of the members of this
  82  * structure, in any way (this includes using values other than
  83  * LINKTYPE_ values, as defined in "savefile.c", in the "linktype"
  84  * field).
  85  *
  86  * Instead:
  87  *
  88  *      introduce a new structure for the new format, if the layout
  89  *      of the structure changed;
  90  *
  91  *      send mail to "tcpdump-workers@tcpdump.org", requesting a new
  92  *      magic number for your new capture file format, and, when
  93  *      you get the new magic number, put it in "savefile.c";
  94  *
  95  *      use that magic number for save files with the changed file
  96  *      header;
  97  *
  98  *      make the code in "savefile.c" capable of reading files with
  99  *      the old file header as well as files with the new file header
 100  *      (using the magic number to determine the header format).
 101  *
 102  * Then supply the changes to "patches@tcpdump.org", so that future
 103  * versions of libpcap and programs that use it (such as tcpdump) will
 104  * be able to read your new capture file format.
 105  */
 106 struct pcap_file_header {
 107         bpf_u_int32 magic;
 108         u_short version_major;
 109         u_short version_minor;
 110         bpf_int32 thiszone;     /* gmt to local correction */
 111         bpf_u_int32 sigfigs;    /* accuracy of timestamps */
 112         bpf_u_int32 snaplen;    /* max length saved portion of each pkt */
 113         bpf_u_int32 linktype;   /* data link type (LINKTYPE_*) */
 114 };
 115
 116 /*
 117  * Each packet in the dump file is prepended with this generic header.
 118  * This gets around the problem of different headers for different
 119  * packet interfaces.
 120  */
 121 struct pcap_pkthdr {
 122         struct timeval ts;      /* time stamp */
 123         bpf_u_int32 caplen;     /* length of portion present */
 124         bpf_u_int32 len;        /* length this packet (off wire) */
 125 };
 126
 127 /*
 128  * As returned by the pcap_stats()
 129  */
 130 struct pcap_stat {
 131         u_int ps_recv;          /* number of packets received */
 132         u_int ps_drop;          /* number of packets dropped */
 133         u_int ps_ifdrop;        /* drops by interface XXX not yet supported */
 134 };
 135
 136 /*
 137  * Item in a list of interfaces.
 138  */
 139 struct pcap_if {
 140         struct pcap_if *next;
 141         char *name;             /* name to hand to "pcap_open_live()" */
 142         char *description;      /* textual description of interface, or NULL */
 143         struct pcap_addr *addresses;
 144         u_int flags;            /* PCAP_IF_ interface flags */
 145 };
 146
 147 #define PCAP_IF_LOOPBACK        0x00000001      /* interface is loopback */
 148
 149 /*
 150  * Representation of an interface address.
 151  */
 152 struct pcap_addr {
 153         struct pcap_addr *next;
 154         struct sockaddr *addr;          /* address */
 155         struct sockaddr *netmask;       /* netmask for that address */
 156         struct sockaddr *broadaddr;     /* broadcast address for that address */
 157         struct sockaddr *dstaddr;       /* P2P destination address for that address */
 158 };
 159
 160 typedef void (*pcap_handler)(u_char *, const struct pcap_pkthdr *,
 161                              const u_char *);
 162
 163 char    *pcap_lookupdev(char *);
 164 int     pcap_lookupnet(char *, bpf_u_int32 *, bpf_u_int32 *, char *);
 165 pcap_t  *pcap_open_live(char *, int, int, int, char *);
 166 pcap_t  *pcap_open_dead(int, int);
 167 pcap_t  *pcap_open_offline(const char *, char *);
 168 void    pcap_close(pcap_t *);
 169 int     pcap_loop(pcap_t *, int, pcap_handler, u_char *);
 170 int     pcap_dispatch(pcap_t *, int, pcap_handler, u_char *);
 171 const u_char*
 172         pcap_next(pcap_t *, struct pcap_pkthdr *);
 173 int     pcap_stats(pcap_t *, struct pcap_stat *);
 174 int     pcap_setfilter(pcap_t *, struct bpf_program *);
 175 int     pcap_getnonblock(pcap_t *, char *);
 176 int     pcap_setnonblock(pcap_t *, int, char *);
 177 void    pcap_perror(pcap_t *, char *);
 178 char    *pcap_strerror(int);
 179 char    *pcap_geterr(pcap_t *);
 180 int     pcap_compile(pcap_t *, struct bpf_program *, char *, int,
 181             bpf_u_int32);
 182 int     pcap_compile_nopcap(int, int, struct bpf_program *,
 183             char *, int, bpf_u_int32);
 184 void    pcap_freecode(struct bpf_program *);
 185 int     pcap_datalink(pcap_t *);
 186 int     pcap_snapshot(pcap_t *);
 187 int     pcap_is_swapped(pcap_t *);
 188 int     pcap_major_version(pcap_t *);
 189 int     pcap_minor_version(pcap_t *);
 190
 191 /* XXX */
 192 FILE    *pcap_file(pcap_t *);
 193 int     pcap_fileno(pcap_t *);
 194
 195 pcap_dumper_t *pcap_dump_open(pcap_t *, const char *);
 196 void    pcap_dump_close(pcap_dumper_t *);
 197 void    pcap_dump(u_char *, const struct pcap_pkthdr *, const u_char *);
 198
 199 int     pcap_findalldevs(pcap_if_t **, char *);
 200 void    pcap_freealldevs(pcap_if_t *);
 201
 202 /* XXX this guy lives in the bpf tree */
 203 u_int   bpf_filter(struct bpf_insn *, u_char *, u_int, u_int);
 204 int     bpf_validate(struct bpf_insn *f, int len);
 205 char    *bpf_image(struct bpf_insn *, int);
 206 void    bpf_dump(struct bpf_program *, int);
 207
 208 #ifdef __cplusplus
 209 }
 210 #endif
 211
 212 #endif