The Tcpdump Group git mirrors - libpcap/blob - bpf/net/bpf.h

   1 /*-
   2  * Copyright (c) 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * This code is derived from the Stanford/CMU enet packet filter,
   6  * (net/enet.c) distributed as part of 4.3BSD, and code contributed
   7  * to Berkeley by Steven McCanne and Van Jacobson both of Lawrence
   8  * Berkeley Laboratory.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  * 3. All advertising materials mentioning features or use of this software
  19  *    must display the following acknowledgement:
  20  *      This product includes software developed by the University of
  21  *      California, Berkeley and its contributors.
  22  * 4. Neither the name of the University nor the names of its contributors
  23  *    may be used to endorse or promote products derived from this software
  24  *    without specific prior written permission.
  25  *
  26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  36  * SUCH DAMAGE.
  37  *
  38  *      @(#)bpf.h       7.1 (Berkeley) 5/7/91
  39  *
  40  * @(#) $Header: /tcpdump/master/libpcap/bpf/net/Attic/bpf.h,v 1.42 2000-12-16 21:31:11 guy Exp $ (LBL)
  41  */
  42
  43 #ifndef BPF_MAJOR_VERSION
  44
  45 /* BSD style release date */
  46 #define BPF_RELEASE 199606
  47
  48 typedef int bpf_int32;
  49 typedef u_int bpf_u_int32;
  50
  51 /*
  52  * Alignment macros.  BPF_WORDALIGN rounds up to the next
  53  * even multiple of BPF_ALIGNMENT.
  54  */
  55 #ifndef __NetBSD__
  56 #define BPF_ALIGNMENT sizeof(bpf_int32)
  57 #else
  58 #define BPF_ALIGNMENT sizeof(long)
  59 #endif
  60 #define BPF_WORDALIGN(x) (((x)+(BPF_ALIGNMENT-1))&~(BPF_ALIGNMENT-1))
  61
  62 #define BPF_MAXINSNS 512
  63 #define BPF_MAXBUFSIZE 0x8000
  64 #define BPF_MINBUFSIZE 32
  65
  66 /*
  67  *  Structure for BIOCSETF.
  68  */
  69 struct bpf_program {
  70         u_int bf_len;
  71         struct bpf_insn *bf_insns;
  72 };
  73
  74 /*
  75  * Struct returned by BIOCGSTATS.
  76  */
  77 struct bpf_stat {
  78         u_int bs_recv;          /* number of packets received */
  79         u_int bs_drop;          /* number of packets dropped */
  80 };
  81
  82 /*
  83  * Struct return by BIOCVERSION.  This represents the version number of
  84  * the filter language described by the instruction encodings below.
  85  * bpf understands a program iff kernel_major == filter_major &&
  86  * kernel_minor >= filter_minor, that is, if the value returned by the
  87  * running kernel has the same major number and a minor number equal
  88  * equal to or less than the filter being downloaded.  Otherwise, the
  89  * results are undefined, meaning an error may be returned or packets
  90  * may be accepted haphazardly.
  91  * It has nothing to do with the source code version.
  92  */
  93 struct bpf_version {
  94         u_short bv_major;
  95         u_short bv_minor;
  96 };
  97 /* Current version number of filter architecture. */
  98 #define BPF_MAJOR_VERSION 1
  99 #define BPF_MINOR_VERSION 1
 100
 101 /*
 102  * BPF ioctls
 103  *
 104  * The first set is for compatibility with Sun's pcc style
 105  * header files.  If your using gcc, we assume that you
 106  * have run fixincludes so the latter set should work.
 107  */
 108 #if (defined(sun) || defined(ibm032)) && !defined(__GNUC__)
 109 #define BIOCGBLEN       _IOR(B,102, u_int)
 110 #define BIOCSBLEN       _IOWR(B,102, u_int)
 111 #define BIOCSETF        _IOW(B,103, struct bpf_program)
 112 #define BIOCFLUSH       _IO(B,104)
 113 #define BIOCPROMISC     _IO(B,105)
 114 #define BIOCGDLT        _IOR(B,106, u_int)
 115 #define BIOCGETIF       _IOR(B,107, struct ifreq)
 116 #define BIOCSETIF       _IOW(B,108, struct ifreq)
 117 #define BIOCSRTIMEOUT   _IOW(B,109, struct timeval)
 118 #define BIOCGRTIMEOUT   _IOR(B,110, struct timeval)
 119 #define BIOCGSTATS      _IOR(B,111, struct bpf_stat)
 120 #define BIOCIMMEDIATE   _IOW(B,112, u_int)
 121 #define BIOCVERSION     _IOR(B,113, struct bpf_version)
 122 #define BIOCSTCPF       _IOW(B,114, struct bpf_program)
 123 #define BIOCSUDPF       _IOW(B,115, struct bpf_program)
 124 #else
 125 #define BIOCGBLEN       _IOR('B',102, u_int)
 126 #define BIOCSBLEN       _IOWR('B',102, u_int)
 127 #define BIOCSETF        _IOW('B',103, struct bpf_program)
 128 #define BIOCFLUSH       _IO('B',104)
 129 #define BIOCPROMISC     _IO('B',105)
 130 #define BIOCGDLT        _IOR('B',106, u_int)
 131 #define BIOCGETIF       _IOR('B',107, struct ifreq)
 132 #define BIOCSETIF       _IOW('B',108, struct ifreq)
 133 #define BIOCSRTIMEOUT   _IOW('B',109, struct timeval)
 134 #define BIOCGRTIMEOUT   _IOR('B',110, struct timeval)
 135 #define BIOCGSTATS      _IOR('B',111, struct bpf_stat)
 136 #define BIOCIMMEDIATE   _IOW('B',112, u_int)
 137 #define BIOCVERSION     _IOR('B',113, struct bpf_version)
 138 #define BIOCSTCPF       _IOW('B',114, struct bpf_program)
 139 #define BIOCSUDPF       _IOW('B',115, struct bpf_program)
 140 #endif
 141
 142 /*
 143  * Structure prepended to each packet.
 144  */
 145 struct bpf_hdr {
 146         struct timeval  bh_tstamp;      /* time stamp */
 147         bpf_u_int32     bh_caplen;      /* length of captured portion */
 148         bpf_u_int32     bh_datalen;     /* original length of packet */
 149         u_short         bh_hdrlen;      /* length of bpf header (this struct
 150                                            plus alignment padding) */
 151 };
 152 /*
 153  * Because the structure above is not a multiple of 4 bytes, some compilers
 154  * will insist on inserting padding; hence, sizeof(struct bpf_hdr) won't work.
 155  * Only the kernel needs to know about it; applications use bh_hdrlen.
 156  */
 157 #if defined(KERNEL) || defined(_KERNEL)
 158 #define SIZEOF_BPF_HDR 18
 159 #endif
 160
 161 /*
 162  * Data-link level type codes.
 163  */
 164
 165 /*
 166  * These are the types that are the same on all platforms; on other
 167  * platforms, a <net/bpf.h> should be supplied that defines the additional
 168  * DLT_* codes appropriately for that platform (the BSDs, for example,
 169  * should not just pick up this version of "bpf.h"; they should also define
 170  * the additional DLT_* codes used by their kernels, as well as the values
 171  * defined here - and, if the values they use for particular DLT_ types
 172  * differ from those here, they should use their values, not the ones
 173  * here).
 174  */
 175 #define DLT_NULL        0       /* no link-layer encapsulation */
 176 #define DLT_EN10MB      1       /* Ethernet (10Mb) */
 177 #define DLT_EN3MB       2       /* Experimental Ethernet (3Mb) */
 178 #define DLT_AX25        3       /* Amateur Radio AX.25 */
 179 #define DLT_PRONET      4       /* Proteon ProNET Token Ring */
 180 #define DLT_CHAOS       5       /* Chaos */
 181 #define DLT_IEEE802     6       /* IEEE 802 Networks */
 182 #define DLT_ARCNET      7       /* ARCNET */
 183 #define DLT_SLIP        8       /* Serial Line IP */
 184 #define DLT_PPP         9       /* Point-to-point Protocol */
 185 #define DLT_FDDI        10      /* FDDI */
 186
 187 /*
 188  * These are values from the traditional libpcap "bpf.h".
 189  * Ports of this to particular platforms should replace these definitions
 190  * with the ones appropriate to that platform, if the values are
 191  * different on that platform.
 192  */
 193 #define DLT_ATM_RFC1483 11      /* LLC/SNAP encapsulated atm */
 194 #define DLT_RAW         12      /* raw IP */
 195
 196 /*
 197  * These are values from BSD/OS's "bpf.h".
 198  * These are not the same as the values from the traditional libpcap
 199  * "bpf.h"; however, these values shouldn't be generated by any
 200  * OS other than BSD/OS, so the correct values to use here are the
 201  * BSD/OS values.
 202  *
 203  * Platforms that have already assigned these values to other
 204  * DLT_ codes, however, should give these codes the values
 205  * from that platform, so that programs that use these codes will
 206  * continue to compile - even though they won't correctly read
 207  * files of these types.
 208  */
 209 #define DLT_SLIP_BSDOS  15      /* BSD/OS Serial Line IP */
 210 #define DLT_PPP_BSDOS   16      /* BSD/OS Point-to-point Protocol */
 211
 212 #define DLT_ATM_CLIP    19      /* Linux Classical-IP over ATM */
 213
 214 /*
 215  * This value is defined by NetBSD; other platforms should refrain from
 216  * using it for other purposes, so that NetBSD savefiles with a link
 217  * type of 50 can be read as this type on all platforms.
 218  */
 219 #define DLT_PPP_SERIAL  50      /* PPP over serial with HDLC encapsulation */
 220
 221 /*
 222  * This value was defined by libpcap 0.5; platforms that have defined
 223  * it with a different value should define it here with that value -
 224  * a link type of 104 in a save file will be mapped to DLT_C_HDLC,
 225  * whatever value that happens to be, so programs will correctly
 226  * handle files with that link type regardless of the value of
 227  * DLT_C_HDLC.
 228  *
 229  * The name DLT_C_HDLC was used by BSD/OS; we use that name for source
 230  * compatibility with programs written for BSD/OS.
 231  *
 232  * libpcap 0.5 defined it as DLT_CHDLC; we define DLT_CHDLC as well,
 233  * for source compatibility with programs written for libpcap 0.5.
 234  */
 235 #define DLT_C_HDLC      104     /* Cisco HDLC */
 236 #define DLT_CHDLC       DLT_C_HDLC
 237
 238 /*
 239  * Reserved for future use.
 240  * Do not pick other numerical value for these unless you have also
 241  * picked up the tcpdump.org top-of-CVS-tree version of "savefile.c",
 242  * which will arrange that capture files for these DLT_ types have
 243  * the same "network" value on all platforms, regardless of what
 244  * value is chosen for their DLT_ type (thus allowing captures made
 245  * on one platform to be read on other platforms, even if the two
 246  * platforms don't use the same numerical values for all DLT_ types).
 247  */
 248 #define DLT_IEEE802_11  105     /* IEEE 802.11 wireless */
 249
 250 /*
 251  * Values between 106 and 107 are used in capture file headers as
 252  * link-layer types corresponding to DLT_ types that might differ
 253  * between platforms; don't use those values for new DLT_ new types.
 254  */
 255
 256 /*
 257  * OpenBSD DLT_LOOP, for loopback devices; it's like DLT_NULL, except
 258  * that the AF_ type in the link-layer header is in network byte order.
 259  *
 260  * OpenBSD defines it as 12, but that collides with DLT_RAW, so we
 261  * define it as 108 here.  If OpenBSD picks up this file, it should
 262  * define DLT_LOOP as 12 in its version, as per the comment above -
 263  * and should not use 108 for any purpose.
 264  */
 265 #define DLT_LOOP        108
 266
 267 /*
 268  * Values between 109 and 113 are used in capture file headers as
 269  * link-layer types corresponding to DLT_ types that might differ
 270  * between platforms; don't use those values for new DLT_ new types.
 271  */
 272
 273 /*
 274  * The instruction encondings.
 275  */
 276 /* instruction classes */
 277 #define BPF_CLASS(code) ((code) & 0x07)
 278 #define         BPF_LD          0x00
 279 #define         BPF_LDX         0x01
 280 #define         BPF_ST          0x02
 281 #define         BPF_STX         0x03
 282 #define         BPF_ALU         0x04
 283 #define         BPF_JMP         0x05
 284 #define         BPF_RET         0x06
 285 #define         BPF_MISC        0x07
 286
 287 /* ld/ldx fields */
 288 #define BPF_SIZE(code)  ((code) & 0x18)
 289 #define         BPF_W           0x00
 290 #define         BPF_H           0x08
 291 #define         BPF_B           0x10
 292 #define BPF_MODE(code)  ((code) & 0xe0)
 293 #define         BPF_IMM         0x00
 294 #define         BPF_ABS         0x20
 295 #define         BPF_IND         0x40
 296 #define         BPF_MEM         0x60
 297 #define         BPF_LEN         0x80
 298 #define         BPF_MSH         0xa0
 299
 300 /* alu/jmp fields */
 301 #define BPF_OP(code)    ((code) & 0xf0)
 302 #define         BPF_ADD         0x00
 303 #define         BPF_SUB         0x10
 304 #define         BPF_MUL         0x20
 305 #define         BPF_DIV         0x30
 306 #define         BPF_OR          0x40
 307 #define         BPF_AND         0x50
 308 #define         BPF_LSH         0x60
 309 #define         BPF_RSH         0x70
 310 #define         BPF_NEG         0x80
 311 #define         BPF_JA          0x00
 312 #define         BPF_JEQ         0x10
 313 #define         BPF_JGT         0x20
 314 #define         BPF_JGE         0x30
 315 #define         BPF_JSET        0x40
 316 #define BPF_SRC(code)   ((code) & 0x08)
 317 #define         BPF_K           0x00
 318 #define         BPF_X           0x08
 319
 320 /* ret - BPF_K and BPF_X also apply */
 321 #define BPF_RVAL(code)  ((code) & 0x18)
 322 #define         BPF_A           0x10
 323
 324 /* misc */
 325 #define BPF_MISCOP(code) ((code) & 0xf8)
 326 #define         BPF_TAX         0x00
 327 #define         BPF_TXA         0x80
 328
 329 /*
 330  * The instruction data structure.
 331  */
 332 struct bpf_insn {
 333         u_short code;
 334         u_char  jt;
 335         u_char  jf;
 336         bpf_int32 k;
 337 };
 338
 339 /*
 340  * Macros for insn array initializers.
 341  */
 342 #define BPF_STMT(code, k) { (u_short)(code), 0, 0, k }
 343 #define BPF_JUMP(code, k, jt, jf) { (u_short)(code), jt, jf, k }
 344
 345 #if defined(BSD) && (defined(KERNEL) || defined(_KERNEL))
 346 /*
 347  * Systems based on non-BSD kernels don't have ifnet's (or they don't mean
 348  * anything if it is in <net/if.h>) and won't work like this.
 349  */
 350 # if __STDC__
 351 extern void bpf_tap(struct ifnet *, u_char *, u_int);
 352 extern void bpf_mtap(struct ifnet *, struct mbuf *);
 353 extern void bpfattach(struct ifnet *, u_int, u_int);
 354 extern void bpfilterattach(int);
 355 # else
 356 extern void bpf_tap();
 357 extern void bpf_mtap();
 358 extern void bpfattach();
 359 extern void bpfilterattach();
 360 # endif /* __STDC__ */
 361 #endif /* BSD && (_KERNEL || KERNEL) */
 362 #if __STDC__
 363 extern int bpf_validate(struct bpf_insn *, int);
 364 extern u_int bpf_filter(struct bpf_insn *, u_char *, u_int, u_int);
 365 #else
 366 extern int bpf_validate();
 367 extern u_int bpf_filter();
 368 #endif
 369
 370 /*
 371  * Number of scratch memory words (for BPF_LD|BPF_MEM and BPF_ST).
 372  */
 373 #define BPF_MEMWORDS 16
 374
 375 #endif