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.67 2003-01-23 07:24:53 guy Exp $ (LBL)
  41  */
  42
  43 #ifndef BPF_MAJOR_VERSION
  44
  45 #ifdef __cplusplus
  46 extern "C" {
  47 #endif
  48
  49 /* BSD style release date */
  50 #define BPF_RELEASE 199606
  51
  52 typedef int bpf_int32;
  53 typedef u_int bpf_u_int32;
  54
  55 /*
  56  * Alignment macros.  BPF_WORDALIGN rounds up to the next
  57  * even multiple of BPF_ALIGNMENT.
  58  */
  59 #ifndef __NetBSD__
  60 #define BPF_ALIGNMENT sizeof(bpf_int32)
  61 #else
  62 #define BPF_ALIGNMENT sizeof(long)
  63 #endif
  64 #define BPF_WORDALIGN(x) (((x)+(BPF_ALIGNMENT-1))&~(BPF_ALIGNMENT-1))
  65
  66 #define BPF_MAXINSNS 512
  67 #define BPF_MAXBUFSIZE 0x8000
  68 #define BPF_MINBUFSIZE 32
  69
  70 /*
  71  *  Structure for BIOCSETF.
  72  */
  73 struct bpf_program {
  74         u_int bf_len;
  75         struct bpf_insn *bf_insns;
  76 };
  77
  78 /*
  79  * Struct returned by BIOCGSTATS.
  80  */
  81 struct bpf_stat {
  82         u_int bs_recv;          /* number of packets received */
  83         u_int bs_drop;          /* number of packets dropped */
  84 };
  85
  86 /*
  87  * Struct return by BIOCVERSION.  This represents the version number of
  88  * the filter language described by the instruction encodings below.
  89  * bpf understands a program iff kernel_major == filter_major &&
  90  * kernel_minor >= filter_minor, that is, if the value returned by the
  91  * running kernel has the same major number and a minor number equal
  92  * equal to or less than the filter being downloaded.  Otherwise, the
  93  * results are undefined, meaning an error may be returned or packets
  94  * may be accepted haphazardly.
  95  * It has nothing to do with the source code version.
  96  */
  97 struct bpf_version {
  98         u_short bv_major;
  99         u_short bv_minor;
 100 };
 101 /* Current version number of filter architecture. */
 102 #define BPF_MAJOR_VERSION 1
 103 #define BPF_MINOR_VERSION 1
 104
 105 /*
 106  * BPF ioctls
 107  *
 108  * The first set is for compatibility with Sun's pcc style
 109  * header files.  If your using gcc, we assume that you
 110  * have run fixincludes so the latter set should work.
 111  */
 112 #if (defined(sun) || defined(ibm032)) && !defined(__GNUC__)
 113 #define BIOCGBLEN       _IOR(B,102, u_int)
 114 #define BIOCSBLEN       _IOWR(B,102, u_int)
 115 #define BIOCSETF        _IOW(B,103, struct bpf_program)
 116 #define BIOCFLUSH       _IO(B,104)
 117 #define BIOCPROMISC     _IO(B,105)
 118 #define BIOCGDLT        _IOR(B,106, u_int)
 119 #define BIOCGETIF       _IOR(B,107, struct ifreq)
 120 #define BIOCSETIF       _IOW(B,108, struct ifreq)
 121 #define BIOCSRTIMEOUT   _IOW(B,109, struct timeval)
 122 #define BIOCGRTIMEOUT   _IOR(B,110, struct timeval)
 123 #define BIOCGSTATS      _IOR(B,111, struct bpf_stat)
 124 #define BIOCIMMEDIATE   _IOW(B,112, u_int)
 125 #define BIOCVERSION     _IOR(B,113, struct bpf_version)
 126 #define BIOCSTCPF       _IOW(B,114, struct bpf_program)
 127 #define BIOCSUDPF       _IOW(B,115, struct bpf_program)
 128 #else
 129 #define BIOCGBLEN       _IOR('B',102, u_int)
 130 #define BIOCSBLEN       _IOWR('B',102, u_int)
 131 #define BIOCSETF        _IOW('B',103, struct bpf_program)
 132 #define BIOCFLUSH       _IO('B',104)
 133 #define BIOCPROMISC     _IO('B',105)
 134 #define BIOCGDLT        _IOR('B',106, u_int)
 135 #define BIOCGETIF       _IOR('B',107, struct ifreq)
 136 #define BIOCSETIF       _IOW('B',108, struct ifreq)
 137 #define BIOCSRTIMEOUT   _IOW('B',109, struct timeval)
 138 #define BIOCGRTIMEOUT   _IOR('B',110, struct timeval)
 139 #define BIOCGSTATS      _IOR('B',111, struct bpf_stat)
 140 #define BIOCIMMEDIATE   _IOW('B',112, u_int)
 141 #define BIOCVERSION     _IOR('B',113, struct bpf_version)
 142 #define BIOCSTCPF       _IOW('B',114, struct bpf_program)
 143 #define BIOCSUDPF       _IOW('B',115, struct bpf_program)
 144 #endif
 145
 146 /*
 147  * Structure prepended to each packet.
 148  */
 149 struct bpf_hdr {
 150         struct timeval  bh_tstamp;      /* time stamp */
 151         bpf_u_int32     bh_caplen;      /* length of captured portion */
 152         bpf_u_int32     bh_datalen;     /* original length of packet */
 153         u_short         bh_hdrlen;      /* length of bpf header (this struct
 154                                            plus alignment padding) */
 155 };
 156 /*
 157  * Because the structure above is not a multiple of 4 bytes, some compilers
 158  * will insist on inserting padding; hence, sizeof(struct bpf_hdr) won't work.
 159  * Only the kernel needs to know about it; applications use bh_hdrlen.
 160  */
 161 #if defined(KERNEL) || defined(_KERNEL)
 162 #define SIZEOF_BPF_HDR 18
 163 #endif
 164
 165 /*
 166  * Data-link level type codes.
 167  */
 168
 169 /*
 170  * These are the types that are the same on all platforms; on other
 171  * platforms, a <net/bpf.h> should be supplied that defines the additional
 172  * DLT_* codes appropriately for that platform (the BSDs, for example,
 173  * should not just pick up this version of "bpf.h"; they should also define
 174  * the additional DLT_* codes used by their kernels, as well as the values
 175  * defined here - and, if the values they use for particular DLT_ types
 176  * differ from those here, they should use their values, not the ones
 177  * here).
 178  */
 179 #define DLT_NULL        0       /* no link-layer encapsulation */
 180 #define DLT_EN10MB      1       /* Ethernet (10Mb) */
 181 #define DLT_EN3MB       2       /* Experimental Ethernet (3Mb) */
 182 #define DLT_AX25        3       /* Amateur Radio AX.25 */
 183 #define DLT_PRONET      4       /* Proteon ProNET Token Ring */
 184 #define DLT_CHAOS       5       /* Chaos */
 185 #define DLT_IEEE802     6       /* IEEE 802 Networks */
 186 #define DLT_ARCNET      7       /* ARCNET, with BSD-style header */
 187 #define DLT_SLIP        8       /* Serial Line IP */
 188 #define DLT_PPP         9       /* Point-to-point Protocol */
 189 #define DLT_FDDI        10      /* FDDI */
 190
 191 /*
 192  * These are values from the traditional libpcap "bpf.h".
 193  * Ports of this to particular platforms should replace these definitions
 194  * with the ones appropriate to that platform, if the values are
 195  * different on that platform.
 196  */
 197 #define DLT_ATM_RFC1483 11      /* LLC/SNAP encapsulated atm */
 198 #define DLT_RAW         12      /* raw IP */
 199
 200 /*
 201  * These are values from BSD/OS's "bpf.h".
 202  * These are not the same as the values from the traditional libpcap
 203  * "bpf.h"; however, these values shouldn't be generated by any
 204  * OS other than BSD/OS, so the correct values to use here are the
 205  * BSD/OS values.
 206  *
 207  * Platforms that have already assigned these values to other
 208  * DLT_ codes, however, should give these codes the values
 209  * from that platform, so that programs that use these codes will
 210  * continue to compile - even though they won't correctly read
 211  * files of these types.
 212  */
 213 #ifdef __NetBSD__
 214 #ifndef DLT_SLIP_BSDOS
 215 #define DLT_SLIP_BSDOS  13      /* BSD/OS Serial Line IP */
 216 #define DLT_PPP_BSDOS   14      /* BSD/OS Point-to-point Protocol */
 217 #endif
 218 #else
 219 #define DLT_SLIP_BSDOS  15      /* BSD/OS Serial Line IP */
 220 #define DLT_PPP_BSDOS   16      /* BSD/OS Point-to-point Protocol */
 221 #endif
 222
 223 #define DLT_ATM_CLIP    19      /* Linux Classical-IP over ATM */
 224
 225 /*
 226  * These values are defined by NetBSD; other platforms should refrain from
 227  * using them for other purposes, so that NetBSD savefiles with link
 228  * types of 50 or 51 can be read as this type on all platforms.
 229  */
 230 #define DLT_PPP_SERIAL  50      /* PPP over serial with HDLC encapsulation */
 231 #define DLT_PPP_ETHER   51      /* PPP over Ethernet */
 232
 233 /*
 234  * Values between 100 and 103 are used in capture file headers as
 235  * link-layer types corresponding to DLT_ types that differ
 236  * between platforms; don't use those values for new DLT_ new types.
 237  */
 238
 239 /*
 240  * This value was defined by libpcap 0.5; platforms that have defined
 241  * it with a different value should define it here with that value -
 242  * a link type of 104 in a save file will be mapped to DLT_C_HDLC,
 243  * whatever value that happens to be, so programs will correctly
 244  * handle files with that link type regardless of the value of
 245  * DLT_C_HDLC.
 246  *
 247  * The name DLT_C_HDLC was used by BSD/OS; we use that name for source
 248  * compatibility with programs written for BSD/OS.
 249  *
 250  * libpcap 0.5 defined it as DLT_CHDLC; we define DLT_CHDLC as well,
 251  * for source compatibility with programs written for libpcap 0.5.
 252  */
 253 #define DLT_C_HDLC      104     /* Cisco HDLC */
 254 #define DLT_CHDLC       DLT_C_HDLC
 255
 256 #define DLT_IEEE802_11  105     /* IEEE 802.11 wireless */
 257
 258 /*
 259  * 106 is reserved for Linux Classical IP over ATM; it's like DLT_RAW,
 260  * except when it isn't.  (I.e., sometimes it's just raw IP, and
 261  * sometimes it isn't.)  We currently handle it as DLT_LINUX_SLL,
 262  * so that we don't have to worry about the link-layer header.)
 263  */
 264
 265 /*
 266  * Frame Relay; BSD/OS has a DLT_FR with a value of 11, but that collides
 267  * with other values.
 268  * DLT_FR and DLT_FRELAY packets start with the Q.922 Frame Relay header
 269  * (DLCI, etc.).
 270  */
 271 #define DLT_FRELAY      107
 272
 273 /*
 274  * OpenBSD DLT_LOOP, for loopback devices; it's like DLT_NULL, except
 275  * that the AF_ type in the link-layer header is in network byte order.
 276  *
 277  * OpenBSD defines it as 12, but that collides with DLT_RAW, so we
 278  * define it as 108 here.  If OpenBSD picks up this file, it should
 279  * define DLT_LOOP as 12 in its version, as per the comment above -
 280  * and should not use 108 as a DLT_ value.
 281  */
 282 #define DLT_LOOP        108
 283
 284 /*
 285  * Values between 109 and 112 are used in capture file headers as
 286  * link-layer types corresponding to DLT_ types that might differ
 287  * between platforms; don't use those values for new DLT_ types
 288  * other than the corresponding DLT_ types.
 289  */
 290
 291 /*
 292  * This is for Linux cooked sockets.
 293  */
 294 #define DLT_LINUX_SLL   113
 295
 296 /*
 297  * Apple LocalTalk hardware.
 298  */
 299 #define DLT_LTALK       114
 300
 301 /*
 302  * Acorn Econet.
 303  */
 304 #define DLT_ECONET      115
 305
 306 /*
 307  * Reserved for use with OpenBSD ipfilter.
 308  */
 309 #define DLT_IPFILTER    116
 310
 311 /*
 312  * Reserved for use in capture-file headers as a link-layer type
 313  * corresponding to OpenBSD DLT_PFLOG; DLT_PFLOG is 17 in OpenBSD,
 314  * but that's DLT_LANE8023 in SuSE 6.3, so we can't use 17 for it
 315  * in capture-file headers.
 316  */
 317 #define DLT_PFLOG       117
 318
 319 /*
 320  * Registered for Cisco-internal use.
 321  */
 322 #define DLT_CISCO_IOS   118
 323
 324 /*
 325  * Reserved for 802.11 cards using the Prism II chips, with a link-layer
 326  * header including Prism monitor mode information plus an 802.11
 327  * header.
 328  */
 329 #define DLT_PRISM_HEADER        119
 330
 331 /*
 332  * Reserved for Aironet 802.11 cards, with an Aironet link-layer header
 333  * (see Doug Ambrisko's FreeBSD patches).
 334  */
 335 #define DLT_AIRONET_HEADER      120
 336
 337 /*
 338  * Reserved for Siemens HiPath HDLC.
 339  */
 340 #define DLT_HHDLC               121
 341
 342 /*
 343  * This is for RFC 2625 IP-over-Fibre Channel.
 344  *
 345  * This is not for use with raw Fibre Channel, where the link-layer
 346  * header starts with a Fibre Channel frame header; it's for IP-over-FC,
 347  * where the link-layer header starts with an RFC 2625 Network_Header
 348  * field.
 349  */
 350 #define DLT_IP_OVER_FC          122
 351
 352 /*
 353  * This is for Full Frontal ATM on Solaris with SunATM, with a
 354  * pseudo-header followed by an AALn PDU.
 355  *
 356  * There may be other forms of Full Frontal ATM on other OSes,
 357  * with different pseudo-headers.
 358  *
 359  * If ATM software returns a pseudo-header with VPI/VCI information
 360  * (and, ideally, packet type information, e.g. signalling, ILMI,
 361  * LANE, LLC-multiplexed traffic, etc.), it should not use
 362  * DLT_ATM_RFC1483, but should get a new DLT_ value, so tcpdump
 363  * and the like don't have to infer the presence or absence of a
 364  * pseudo-header and the form of the pseudo-header.
 365  */
 366 #define DLT_SUNATM              123     /* Solaris+SunATM */
 367
 368 /*
 369  * Reserved as per request from Kent Dahlgren <kent@praesum.com>
 370  * for private use.
 371  */
 372 #define DLT_RIO                 124     /* RapidIO */
 373 #define DLT_PCI_EXP             125     /* PCI Express */
 374 #define DLT_AURORA              126     /* Xilinx Aurora link layer */
 375
 376 /*
 377  * For future use with 802.11 captures - defined by AbsoluteValue
 378  * Systems to store a number of bits of link-layer information:
 379  *
 380  *      http://www.shaftnet.org/~pizza/software/capturefrm.txt
 381  *
 382  * but could and arguably should also be used by non-AVS Linux
 383  * 802.11 drivers and BSD drivers; that may happen in the future.
 384  */
 385 #define DLT_IEEE802_11_RADIO    127     /* 802.11 plus WLAN header */
 386
 387 /*
 388  * Reserved for the TZSP encapsulation, as per request from
 389  * Chris Waters <chris.waters@networkchemistry.com>
 390  * TZSP is a generic encapsulation for any other link type,
 391  * which includes a means to include meta-information
 392  * with the packet, e.g. signal strength and channel
 393  * for 802.11 packets.
 394  */
 395 #define DLT_TZSP                128     /* Tazmen Sniffer Protocol */
 396
 397 /*
 398  * BSD's ARCNET headers have the source host, destination host,
 399  * and type at the beginning of the packet; that's what's handed
 400  * up to userland via BPF.
 401  *
 402  * Linux's ARCNET headers, however, have a 2-byte offset field
 403  * between the host IDs and the type; that's what's handed up
 404  * to userland via PF_PACKET sockets.
 405  *
 406  * We therefore have to have separate DLT_ values for them.
 407  */
 408 #define DLT_ARCNET_LINUX        129     /* ARCNET */
 409
 410 /*
 411  * The instruction encodings.
 412  */
 413 /* instruction classes */
 414 #define BPF_CLASS(code) ((code) & 0x07)
 415 #define         BPF_LD          0x00
 416 #define         BPF_LDX         0x01
 417 #define         BPF_ST          0x02
 418 #define         BPF_STX         0x03
 419 #define         BPF_ALU         0x04
 420 #define         BPF_JMP         0x05
 421 #define         BPF_RET         0x06
 422 #define         BPF_MISC        0x07
 423
 424 /* ld/ldx fields */
 425 #define BPF_SIZE(code)  ((code) & 0x18)
 426 #define         BPF_W           0x00
 427 #define         BPF_H           0x08
 428 #define         BPF_B           0x10
 429 #define BPF_MODE(code)  ((code) & 0xe0)
 430 #define         BPF_IMM         0x00
 431 #define         BPF_ABS         0x20
 432 #define         BPF_IND         0x40
 433 #define         BPF_MEM         0x60
 434 #define         BPF_LEN         0x80
 435 #define         BPF_MSH         0xa0
 436
 437 /* alu/jmp fields */
 438 #define BPF_OP(code)    ((code) & 0xf0)
 439 #define         BPF_ADD         0x00
 440 #define         BPF_SUB         0x10
 441 #define         BPF_MUL         0x20
 442 #define         BPF_DIV         0x30
 443 #define         BPF_OR          0x40
 444 #define         BPF_AND         0x50
 445 #define         BPF_LSH         0x60
 446 #define         BPF_RSH         0x70
 447 #define         BPF_NEG         0x80
 448 #define         BPF_JA          0x00
 449 #define         BPF_JEQ         0x10
 450 #define         BPF_JGT         0x20
 451 #define         BPF_JGE         0x30
 452 #define         BPF_JSET        0x40
 453 #define BPF_SRC(code)   ((code) & 0x08)
 454 #define         BPF_K           0x00
 455 #define         BPF_X           0x08
 456
 457 /* ret - BPF_K and BPF_X also apply */
 458 #define BPF_RVAL(code)  ((code) & 0x18)
 459 #define         BPF_A           0x10
 460
 461 /* misc */
 462 #define BPF_MISCOP(code) ((code) & 0xf8)
 463 #define         BPF_TAX         0x00
 464 #define         BPF_TXA         0x80
 465
 466 /*
 467  * The instruction data structure.
 468  */
 469 struct bpf_insn {
 470         u_short code;
 471         u_char  jt;
 472         u_char  jf;
 473         bpf_int32 k;
 474 };
 475
 476 /*
 477  * Macros for insn array initializers.
 478  */
 479 #define BPF_STMT(code, k) { (u_short)(code), 0, 0, k }
 480 #define BPF_JUMP(code, k, jt, jf) { (u_short)(code), jt, jf, k }
 481
 482 #if defined(BSD) && (defined(KERNEL) || defined(_KERNEL))
 483 /*
 484  * Systems based on non-BSD kernels don't have ifnet's (or they don't mean
 485  * anything if it is in <net/if.h>) and won't work like this.
 486  */
 487 # if __STDC__
 488 extern void bpf_tap(struct ifnet *, u_char *, u_int);
 489 extern void bpf_mtap(struct ifnet *, struct mbuf *);
 490 extern void bpfattach(struct ifnet *, u_int, u_int);
 491 extern void bpfilterattach(int);
 492 # else
 493 extern void bpf_tap();
 494 extern void bpf_mtap();
 495 extern void bpfattach();
 496 extern void bpfilterattach();
 497 # endif /* __STDC__ */
 498 #endif /* BSD && (_KERNEL || KERNEL) */
 499 #if __STDC__ || defined(__cplusplus)
 500 extern int bpf_validate(struct bpf_insn *, int);
 501 extern u_int bpf_filter(struct bpf_insn *, u_char *, u_int, u_int);
 502 #else
 503 extern int bpf_validate();
 504 extern u_int bpf_filter();
 505 #endif
 506
 507 /*
 508  * Number of scratch memory words (for BPF_LD|BPF_MEM and BPF_ST).
 509  */
 510 #define BPF_MEMWORDS 16
 511
 512 #ifdef __cplusplus
 513 }
 514 #endif
 515
 516 #endif