share/man/man4/bpf.4

   1 .\" Copyright (c) 1990 The Regents of the University of California.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that: (1) source code distributions
   6 .\" retain the above copyright notice and this paragraph in its entirety, (2)
   7 .\" distributions including binary code include the above copyright notice and
   8 .\" this paragraph in its entirety in the documentation or other materials
   9 .\" provided with the distribution, and (3) all advertising materials mentioning
  10 .\" features or use of this software display the following acknowledgement:
  11 .\" ``This product includes software developed by the University of California,
  12 .\" Lawrence Berkeley Laboratory and its contributors.'' Neither the name of
  13 .\" the University nor the names of its contributors may be used to endorse
  14 .\" or promote products derived from this software without specific prior
  15 .\" written permission.
  16 .\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
  17 .\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
  18 .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  19 .\"
  20 .\" This document is derived in part from the enet man page (enet.4)
  21 .\" distributed with 4.3BSD Unix.
  22 .\"
  23 .\" $FreeBSD$
  24 .\"
  25 .Dd August 23, 2005
  26 .Dt BPF 4
  27 .Os
  28 .Sh NAME
  29 .Nm bpf
  30 .Nd Berkeley Packet Filter
  31 .Sh SYNOPSIS
  32 .Cd device bpf
  33 .Sh DESCRIPTION
  34 The Berkeley Packet Filter
  35 provides a raw interface to data link layers in a protocol
  36 independent fashion.
  37 All packets on the network, even those destined for other hosts,
  38 are accessible through this mechanism.
  39 .Pp
  40 The packet filter appears as a character special device,
  41 .Pa /dev/bpf0 ,
  42 .Pa /dev/bpf1 ,
  43 etc.
  44 After opening the device, the file descriptor must be bound to a
  45 specific network interface with the
  46 .Dv BIOCSETIF
  47 ioctl.
  48 A given interface can be shared by multiple listeners, and the filter
  49 underlying each descriptor will see an identical packet stream.
  50 .Pp
  51 A separate device file is required for each minor device.
  52 If a file is in use, the open will fail and
  53 .Va errno
  54 will be set to
  55 .Er EBUSY .
  56 .Pp
  57 Associated with each open instance of a
  58 .Nm
  59 file is a user-settable packet filter.
  60 Whenever a packet is received by an interface,
  61 all file descriptors listening on that interface apply their filter.
  62 Each descriptor that accepts the packet receives its own copy.
  63 .Pp
  64 Reads from these files return the next group of packets
  65 that have matched the filter.
  66 To improve performance, the buffer passed to read must be
  67 the same size as the buffers used internally by
  68 .Nm .
  69 This size is returned by the
  70 .Dv BIOCGBLEN
  71 ioctl (see below), and
  72 can be set with
  73 .Dv BIOCSBLEN .
  74 Note that an individual packet larger than this size is necessarily
  75 truncated.
  76 .Pp
  77 The packet filter will support any link level protocol that has fixed length
  78 headers.
  79 Currently, only Ethernet,
  80 .Tn SLIP ,
  81 and
  82 .Tn PPP
  83 drivers have been modified to interact with
  84 .Nm .
  85 .Pp
  86 Since packet data is in network byte order, applications should use the
  87 .Xr byteorder 3
  88 macros to extract multi-byte values.
  89 .Pp
  90 A packet can be sent out on the network by writing to a
  91 .Nm
  92 file descriptor.
  93 The writes are unbuffered, meaning only one packet can be processed per write.
  94 Currently, only writes to Ethernets and
  95 .Tn SLIP
  96 links are supported.
  97 .Sh IOCTLS
  98 The
  99 .Xr ioctl 2
 100 command codes below are defined in
 101 .In net/bpf.h .
 102 All commands require
 103 these includes:
 104 .Bd -literal
 105         #include <sys/types.h>
 106         #include <sys/time.h>
 107         #include <sys/ioctl.h>
 108         #include <net/bpf.h>
 109 .Ed
 110 .Pp
 111 Additionally,
 112 .Dv BIOCGETIF
 113 and
 114 .Dv BIOCSETIF
 115 require
 116 .In sys/socket.h
 117 and
 118 .In net/if.h .
 119 .Pp
 120 In addition to
 121 .Dv FIONREAD
 122 and
 123 .Dv SIOCGIFADDR ,
 124 the following commands may be applied to any open
 125 .Nm
 126 file.
 127 The (third) argument to
 128 .Xr ioctl 2
 129 should be a pointer to the type indicated.
 130 .Bl -tag -width BIOCGRTIMEOUT
 131 .It Dv BIOCGBLEN
 132 .Pq Li u_int
 133 Returns the required buffer length for reads on
 134 .Nm
 135 files.
 136 .It Dv BIOCSBLEN
 137 .Pq Li u_int
 138 Sets the buffer length for reads on
 139 .Nm
 140 files.
 141 The buffer must be set before the file is attached to an interface
 142 with
 143 .Dv BIOCSETIF .
 144 If the requested buffer size cannot be accommodated, the closest
 145 allowable size will be set and returned in the argument.
 146 A read call will result in
 147 .Er EIO
 148 if it is passed a buffer that is not this size.
 149 .It Dv BIOCGDLT
 150 .Pq Li u_int
 151 Returns the type of the data link layer underlying the attached interface.
 152 .Er EINVAL
 153 is returned if no interface has been specified.
 154 The device types, prefixed with
 155 .Dq Li DLT_ ,
 156 are defined in
 157 .In net/bpf.h .
 158 .It Dv BIOCPROMISC
 159 Forces the interface into promiscuous mode.
 160 All packets, not just those destined for the local host, are processed.
 161 Since more than one file can be listening on a given interface,
 162 a listener that opened its interface non-promiscuously may receive
 163 packets promiscuously.
 164 This problem can be remedied with an appropriate filter.
 165 .It Dv BIOCFLUSH
 166 Flushes the buffer of incoming packets,
 167 and resets the statistics that are returned by BIOCGSTATS.
 168 .It Dv BIOCGETIF
 169 .Pq Li "struct ifreq"
 170 Returns the name of the hardware interface that the file is listening on.
 171 The name is returned in the ifr_name field of
 172 the
 173 .Li ifreq
 174 structure.
 175 All other fields are undefined.
 176 .It Dv BIOCSETIF
 177 .Pq Li "struct ifreq"
 178 Sets the hardware interface associate with the file.
 179 This
 180 command must be performed before any packets can be read.
 181 The device is indicated by name using the
 182 .Li ifr_name
 183 field of the
 184 .Li ifreq
 185 structure.
 186 Additionally, performs the actions of
 187 .Dv BIOCFLUSH .
 188 .It Dv BIOCSRTIMEOUT
 189 .It Dv BIOCGRTIMEOUT
 190 .Pq Li "struct timeval"
 191 Set or get the read timeout parameter.
 192 The argument
 193 specifies the length of time to wait before timing
 194 out on a read request.
 195 This parameter is initialized to zero by
 196 .Xr open 2 ,
 197 indicating no timeout.
 198 .It Dv BIOCGSTATS
 199 .Pq Li "struct bpf_stat"
 200 Returns the following structure of packet statistics:
 201 .Bd -literal
 202 struct bpf_stat {
 203         u_int bs_recv;    /* number of packets received */
 204         u_int bs_drop;    /* number of packets dropped */
 205 };
 206 .Ed
 207 .Pp
 208 The fields are:
 209 .Bl -hang -offset indent
 210 .It Li bs_recv
 211 the number of packets received by the descriptor since opened or reset
 212 (including any buffered since the last read call);
 213 and
 214 .It Li bs_drop
 215 the number of packets which were accepted by the filter but dropped by the
 216 kernel because of buffer overflows
 217 (i.e., the application's reads are not keeping up with the packet traffic).
 218 .El
 219 .It Dv BIOCIMMEDIATE
 220 .Pq Li u_int
 221 Enable or disable
 222 .Dq immediate mode ,
 223 based on the truth value of the argument.
 224 When immediate mode is enabled, reads return immediately upon packet
 225 reception.
 226 Otherwise, a read will block until either the kernel buffer
 227 becomes full or a timeout occurs.
 228 This is useful for programs like
 229 .Xr rarpd 8
 230 which must respond to messages in real time.
 231 The default for a new file is off.
 232 .It Dv BIOCSETF
 233 .Pq Li "struct bpf_program"
 234 Sets the read filter program used by the kernel to discard uninteresting
 235 packets.
 236 An array of instructions and its length is passed in using
 237 the following structure:
 238 .Bd -literal
 239 struct bpf_program {
 240         int bf_len;
 241         struct bpf_insn *bf_insns;
 242 };
 243 .Ed
 244 .Pp
 245 The filter program is pointed to by the
 246 .Li bf_insns
 247 field while its length in units of
 248 .Sq Li struct bpf_insn
 249 is given by the
 250 .Li bf_len
 251 field.
 252 Also, the actions of
 253 .Dv BIOCFLUSH
 254 are performed.
 255 See section
 256 .Sx "FILTER MACHINE"
 257 for an explanation of the filter language.
 258 .It Dv BIOCSETWF
 259 .Pq Li "struct bpf_program"
 260 Sets the write filter program used by the kernel to control what type of
 261 packets can be written to the interface.
 262 See the
 263 .Dv BIOCSETF
 264 command for more
 265 information on the
 266 .Nm
 267 filter program.
 268 .It Dv BIOCVERSION
 269 .Pq Li "struct bpf_version"
 270 Returns the major and minor version numbers of the filter language currently
 271 recognized by the kernel.
 272 Before installing a filter, applications must check
 273 that the current version is compatible with the running kernel.
 274 Version numbers are compatible if the major numbers match and the application minor
 275 is less than or equal to the kernel minor.
 276 The kernel version number is returned in the following structure:
 277 .Bd -literal
 278 struct bpf_version {
 279         u_short bv_major;
 280         u_short bv_minor;
 281 };
 282 .Ed
 283 .Pp
 284 The current version numbers are given by
 285 .Dv BPF_MAJOR_VERSION
 286 and
 287 .Dv BPF_MINOR_VERSION
 288 from
 289 .In net/bpf.h .
 290 An incompatible filter
 291 may result in undefined behavior (most likely, an error returned by
 292 .Fn ioctl
 293 or haphazard packet matching).
 294 .It Dv BIOCSHDRCMPLT
 295 .It Dv BIOCGHDRCMPLT
 296 .Pq Li u_int
 297 Set or get the status of the
 298 .Dq header complete
 299 flag.
 300 Set to zero if the link level source address should be filled in automatically
 301 by the interface output routine.
 302 Set to one if the link level source
 303 address will be written, as provided, to the wire.
 304 This flag is initialized to zero by default.
 305 .It Dv BIOCSSEESENT
 306 .It Dv BIOCGSEESENT
 307 .Pq Li u_int
 308 Set or get the flag determining whether locally generated packets on the
 309 interface should be returned by BPF.
 310 Set to zero to see only incoming packets on the interface.
 311 Set to one to see packets originating locally and remotely on the interface.
 312 This flag is initialized to one by
 313 default.
 314 .It Dv BIOCLOCK
 315 Set the locked flag on the
 316 .Nm
 317 descriptor.
 318 This prevents the execution of
 319 ioctl commands which could change the underlying operating parameters of
 320 the device.
 321 .El
 322 .Sh BPF HEADER
 323 The following structure is prepended to each packet returned by
 324 .Xr read 2 :
 325 .Bd -literal
 326 struct bpf_hdr {
 327         struct timeval bh_tstamp;     /* time stamp */
 328         u_long bh_caplen;             /* length of captured portion */
 329         u_long bh_datalen;            /* original length of packet */
 330         u_short bh_hdrlen;            /* length of bpf header (this struct
 331                                          plus alignment padding */
 332 };
 333 .Ed
 334 .Pp
 335 The fields, whose values are stored in host order, and are:
 336 .Pp
 337 .Bl -tag -compact -width bh_datalen
 338 .It Li bh_tstamp
 339 The time at which the packet was processed by the packet filter.
 340 .It Li bh_caplen
 341 The length of the captured portion of the packet.
 342 This is the minimum of
 343 the truncation amount specified by the filter and the length of the packet.
 344 .It Li bh_datalen
 345 The length of the packet off the wire.
 346 This value is independent of the truncation amount specified by the filter.
 347 .It Li bh_hdrlen
 348 The length of the
 349 .Nm
 350 header, which may not be equal to
 351 .\" XXX - not really a function call
 352 .Fn sizeof "struct bpf_hdr" .
 353 .El
 354 .Pp
 355 The
 356 .Li bh_hdrlen
 357 field exists to account for
 358 padding between the header and the link level protocol.
 359 The purpose here is to guarantee proper alignment of the packet
 360 data structures, which is required on alignment sensitive
 361 architectures and improves performance on many other architectures.
 362 The packet filter insures that the
 363 .Li bpf_hdr
 364 and the network layer
 365 header will be word aligned.
 366 Suitable precautions
 367 must be taken when accessing the link layer protocol fields on alignment
 368 restricted machines.
 369 (This is not a problem on an Ethernet, since
 370 the type field is a short falling on an even offset,
 371 and the addresses are probably accessed in a bytewise fashion).
 372 .Pp
 373 Additionally, individual packets are padded so that each starts
 374 on a word boundary.
 375 This requires that an application
 376 has some knowledge of how to get from packet to packet.
 377 The macro
 378 .Dv BPF_WORDALIGN
 379 is defined in
 380 .In net/bpf.h
 381 to facilitate
 382 this process.
 383 It rounds up its argument to the nearest word aligned value (where a word is
 384 .Dv BPF_ALIGNMENT
 385 bytes wide).
 386 .Pp
 387 For example, if
 388 .Sq Li p
 389 points to the start of a packet, this expression
 390 will advance it to the next packet:
 391 .Dl p = (char *)p + BPF_WORDALIGN(p->bh_hdrlen + p->bh_caplen)
 392 .Pp
 393 For the alignment mechanisms to work properly, the
 394 buffer passed to
 395 .Xr read 2
 396 must itself be word aligned.
 397 The
 398 .Xr malloc 3
 399 function
 400 will always return an aligned buffer.
 401 .Sh FILTER MACHINE
 402 A filter program is an array of instructions, with all branches forwardly
 403 directed, terminated by a
 404 .Em return
 405 instruction.
 406 Each instruction performs some action on the pseudo-machine state,
 407 which consists of an accumulator, index register, scratch memory store,
 408 and implicit program counter.
 409 .Pp
 410 The following structure defines the instruction format:
 411 .Bd -literal
 412 struct bpf_insn {
 413         u_short code;
 414         u_char  jt;
 415         u_char  jf;
 416         u_long k;
 417 };
 418 .Ed
 419 .Pp
 420 The
 421 .Li k
 422 field is used in different ways by different instructions,
 423 and the
 424 .Li jt
 425 and
 426 .Li jf
 427 fields are used as offsets
 428 by the branch instructions.
 429 The opcodes are encoded in a semi-hierarchical fashion.
 430 There are eight classes of instructions:
 431 .Dv BPF_LD ,
 432 .Dv BPF_LDX ,
 433 .Dv BPF_ST ,
 434 .Dv BPF_STX ,
 435 .Dv BPF_ALU ,
 436 .Dv BPF_JMP ,
 437 .Dv BPF_RET ,
 438 and
 439 .Dv BPF_MISC .
 440 Various other mode and
 441 operator bits are or'd into the class to give the actual instructions.
 442 The classes and modes are defined in
 443 .In net/bpf.h .
 444 .Pp
 445 Below are the semantics for each defined
 446 .Nm
 447 instruction.
 448 We use the convention that A is the accumulator, X is the index register,
 449 P[] packet data, and M[] scratch memory store.
 450 P[i:n] gives the data at byte offset
 451 .Dq i
 452 in the packet,
 453 interpreted as a word (n=4),
 454 unsigned halfword (n=2), or unsigned byte (n=1).
 455 M[i] gives the i'th word in the scratch memory store, which is only
 456 addressed in word units.
 457 The memory store is indexed from 0 to
 458 .Dv BPF_MEMWORDS
 459 - 1.
 460 .Li k ,
 461 .Li jt ,
 462 and
 463 .Li jf
 464 are the corresponding fields in the
 465 instruction definition.
 466 .Dq len
 467 refers to the length of the packet.
 468 .Pp
 469 .Bl -tag -width BPF_STXx
 470 .It Dv BPF_LD
 471 These instructions copy a value into the accumulator.
 472 The type of the source operand is specified by an
 473 .Dq addressing mode
 474 and can be a constant
 475 .Pq Dv BPF_IMM ,
 476 packet data at a fixed offset
 477 .Pq Dv BPF_ABS ,
 478 packet data at a variable offset
 479 .Pq Dv BPF_IND ,
 480 the packet length
 481 .Pq Dv BPF_LEN ,
 482 or a word in the scratch memory store
 483 .Pq Dv BPF_MEM .
 484 For
 485 .Dv BPF_IND
 486 and
 487 .Dv BPF_ABS ,
 488 the data size must be specified as a word
 489 .Pq Dv BPF_W ,
 490 halfword
 491 .Pq Dv BPF_H ,
 492 or byte
 493 .Pq Dv BPF_B .
 494 The semantics of all the recognized
 495 .Dv BPF_LD
 496 instructions follow.
 497 .Pp
 498 .Bd -literal
 499 BPF_LD+BPF_W+BPF_ABS    A <- P[k:4]
 500 BPF_LD+BPF_H+BPF_ABS    A <- P[k:2]
 501 BPF_LD+BPF_B+BPF_ABS    A <- P[k:1]
 502 BPF_LD+BPF_W+BPF_IND    A <- P[X+k:4]
 503 BPF_LD+BPF_H+BPF_IND    A <- P[X+k:2]
 504 BPF_LD+BPF_B+BPF_IND    A <- P[X+k:1]
 505 BPF_LD+BPF_W+BPF_LEN    A <- len
 506 BPF_LD+BPF_IMM          A <- k
 507 BPF_LD+BPF_MEM          A <- M[k]
 508 .Ed
 509 .It Dv BPF_LDX
 510 These instructions load a value into the index register.
 511 Note that
 512 the addressing modes are more restrictive than those of the accumulator loads,
 513 but they include
 514 .Dv BPF_MSH ,
 515 a hack for efficiently loading the IP header length.
 516 .Pp
 517 .Bd -literal
 518 BPF_LDX+BPF_W+BPF_IMM   X <- k
 519 BPF_LDX+BPF_W+BPF_MEM   X <- M[k]
 520 BPF_LDX+BPF_W+BPF_LEN   X <- len
 521 BPF_LDX+BPF_B+BPF_MSH   X <- 4*(P[k:1]&0xf)
 522 .Ed
 523 .It Dv BPF_ST
 524 This instruction stores the accumulator into the scratch memory.
 525 We do not need an addressing mode since there is only one possibility
 526 for the destination.
 527 .Pp
 528 .Bd -literal
 529 BPF_ST                  M[k] <- A
 530 .Ed
 531 .It Dv BPF_STX
 532 This instruction stores the index register in the scratch memory store.
 533 .Pp
 534 .Bd -literal
 535 BPF_STX                 M[k] <- X
 536 .Ed
 537 .It Dv BPF_ALU
 538 The alu instructions perform operations between the accumulator and
 539 index register or constant, and store the result back in the accumulator.
 540 For binary operations, a source mode is required
 541 .Dv ( BPF_K
 542 or
 543 .Dv BPF_X ) .
 544 .Pp
 545 .Bd -literal
 546 BPF_ALU+BPF_ADD+BPF_K   A <- A + k
 547 BPF_ALU+BPF_SUB+BPF_K   A <- A - k
 548 BPF_ALU+BPF_MUL+BPF_K   A <- A * k
 549 BPF_ALU+BPF_DIV+BPF_K   A <- A / k
 550 BPF_ALU+BPF_AND+BPF_K   A <- A & k
 551 BPF_ALU+BPF_OR+BPF_K    A <- A | k
 552 BPF_ALU+BPF_LSH+BPF_K   A <- A << k
 553 BPF_ALU+BPF_RSH+BPF_K   A <- A >> k
 554 BPF_ALU+BPF_ADD+BPF_X   A <- A + X
 555 BPF_ALU+BPF_SUB+BPF_X   A <- A - X
 556 BPF_ALU+BPF_MUL+BPF_X   A <- A * X
 557 BPF_ALU+BPF_DIV+BPF_X   A <- A / X
 558 BPF_ALU+BPF_AND+BPF_X   A <- A & X
 559 BPF_ALU+BPF_OR+BPF_X    A <- A | X
 560 BPF_ALU+BPF_LSH+BPF_X   A <- A << X
 561 BPF_ALU+BPF_RSH+BPF_X   A <- A >> X
 562 BPF_ALU+BPF_NEG         A <- -A
 563 .Ed
 564 .It Dv BPF_JMP
 565 The jump instructions alter flow of control.
 566 Conditional jumps
 567 compare the accumulator against a constant
 568 .Pq Dv BPF_K
 569 or the index register
 570 .Pq Dv BPF_X .
 571 If the result is true (or non-zero),
 572 the true branch is taken, otherwise the false branch is taken.
 573 Jump offsets are encoded in 8 bits so the longest jump is 256 instructions.
 574 However, the jump always
 575 .Pq Dv BPF_JA
 576 opcode uses the 32 bit
 577 .Li k
 578 field as the offset, allowing arbitrarily distant destinations.
 579 All conditionals use unsigned comparison conventions.
 580 .Pp
 581 .Bd -literal
 582 BPF_JMP+BPF_JA          pc += k
 583 BPF_JMP+BPF_JGT+BPF_K   pc += (A > k) ? jt : jf
 584 BPF_JMP+BPF_JGE+BPF_K   pc += (A >= k) ? jt : jf
 585 BPF_JMP+BPF_JEQ+BPF_K   pc += (A == k) ? jt : jf
 586 BPF_JMP+BPF_JSET+BPF_K  pc += (A & k) ? jt : jf
 587 BPF_JMP+BPF_JGT+BPF_X   pc += (A > X) ? jt : jf
 588 BPF_JMP+BPF_JGE+BPF_X   pc += (A >= X) ? jt : jf
 589 BPF_JMP+BPF_JEQ+BPF_X   pc += (A == X) ? jt : jf
 590 BPF_JMP+BPF_JSET+BPF_X  pc += (A & X) ? jt : jf
 591 .Ed
 592 .It Dv BPF_RET
 593 The return instructions terminate the filter program and specify the amount
 594 of packet to accept (i.e., they return the truncation amount).
 595 A return value of zero indicates that the packet should be ignored.
 596 The return value is either a constant
 597 .Pq Dv BPF_K
 598 or the accumulator
 599 .Pq Dv BPF_A .
 600 .Pp
 601 .Bd -literal
 602 BPF_RET+BPF_A           accept A bytes
 603 BPF_RET+BPF_K           accept k bytes
 604 .Ed
 605 .It Dv BPF_MISC
 606 The miscellaneous category was created for anything that does not
 607 fit into the above classes, and for any new instructions that might need to
 608 be added.
 609 Currently, these are the register transfer instructions
 610 that copy the index register to the accumulator or vice versa.
 611 .Pp
 612 .Bd -literal
 613 BPF_MISC+BPF_TAX        X <- A
 614 BPF_MISC+BPF_TXA        A <- X
 615 .Ed
 616 .El
 617 .Pp
 618 The
 619 .Nm
 620 interface provides the following macros to facilitate
 621 array initializers:
 622 .Fn BPF_STMT opcode operand
 623 and
 624 .Fn BPF_JUMP opcode operand true_offset false_offset .
 625 .Sh FILES
 626 .Bl -tag -compact -width /dev/bpfXXX
 627 .It Pa /dev/bpf Ns Sy n
 628 the packet filter device
 629 .El
 630 .Sh EXAMPLES
 631 The following filter is taken from the Reverse ARP Daemon.
 632 It accepts only Reverse ARP requests.
 633 .Bd -literal
 634 struct bpf_insn insns[] = {
 635         BPF_STMT(BPF_LD+BPF_H+BPF_ABS, 12),
 636         BPF_JUMP(BPF_JMP+BPF_JEQ+BPF_K, ETHERTYPE_REVARP, 0, 3),
 637         BPF_STMT(BPF_LD+BPF_H+BPF_ABS, 20),
 638         BPF_JUMP(BPF_JMP+BPF_JEQ+BPF_K, REVARP_REQUEST, 0, 1),
 639         BPF_STMT(BPF_RET+BPF_K, sizeof(struct ether_arp) +
 640                  sizeof(struct ether_header)),
 641         BPF_STMT(BPF_RET+BPF_K, 0),
 642 };
 643 .Ed
 644 .Pp
 645 This filter accepts only IP packets between host 128.3.112.15 and
 646 128.3.112.35.
 647 .Bd -literal
 648 struct bpf_insn insns[] = {
 649         BPF_STMT(BPF_LD+BPF_H+BPF_ABS, 12),
 650         BPF_JUMP(BPF_JMP+BPF_JEQ+BPF_K, ETHERTYPE_IP, 0, 8),
 651         BPF_STMT(BPF_LD+BPF_W+BPF_ABS, 26),
 652         BPF_JUMP(BPF_JMP+BPF_JEQ+BPF_K, 0x8003700f, 0, 2),
 653         BPF_STMT(BPF_LD+BPF_W+BPF_ABS, 30),
 654         BPF_JUMP(BPF_JMP+BPF_JEQ+BPF_K, 0x80037023, 3, 4),
 655         BPF_JUMP(BPF_JMP+BPF_JEQ+BPF_K, 0x80037023, 0, 3),
 656         BPF_STMT(BPF_LD+BPF_W+BPF_ABS, 30),
 657         BPF_JUMP(BPF_JMP+BPF_JEQ+BPF_K, 0x8003700f, 0, 1),
 658         BPF_STMT(BPF_RET+BPF_K, (u_int)-1),
 659         BPF_STMT(BPF_RET+BPF_K, 0),
 660 };
 661 .Ed
 662 .Pp
 663 Finally, this filter returns only TCP finger packets.
 664 We must parse the IP header to reach the TCP header.
 665 The
 666 .Dv BPF_JSET
 667 instruction
 668 checks that the IP fragment offset is 0 so we are sure
 669 that we have a TCP header.
 670 .Bd -literal
 671 struct bpf_insn insns[] = {
 672         BPF_STMT(BPF_LD+BPF_H+BPF_ABS, 12),
 673         BPF_JUMP(BPF_JMP+BPF_JEQ+BPF_K, ETHERTYPE_IP, 0, 10),
 674         BPF_STMT(BPF_LD+BPF_B+BPF_ABS, 23),
 675         BPF_JUMP(BPF_JMP+BPF_JEQ+BPF_K, IPPROTO_TCP, 0, 8),
 676         BPF_STMT(BPF_LD+BPF_H+BPF_ABS, 20),
 677         BPF_JUMP(BPF_JMP+BPF_JSET+BPF_K, 0x1fff, 6, 0),
 678         BPF_STMT(BPF_LDX+BPF_B+BPF_MSH, 14),
 679         BPF_STMT(BPF_LD+BPF_H+BPF_IND, 14),
 680         BPF_JUMP(BPF_JMP+BPF_JEQ+BPF_K, 79, 2, 0),
 681         BPF_STMT(BPF_LD+BPF_H+BPF_IND, 16),
 682         BPF_JUMP(BPF_JMP+BPF_JEQ+BPF_K, 79, 0, 1),
 683         BPF_STMT(BPF_RET+BPF_K, (u_int)-1),
 684         BPF_STMT(BPF_RET+BPF_K, 0),
 685 };
 686 .Ed
 687 .Sh SEE ALSO
 688 .Xr tcpdump 1 ,
 689 .Xr ioctl 2 ,
 690 .Xr byteorder 3 ,
 691 .Xr ng_bpf 4 ,
 692 .Xr bpf 9
 693 .Rs
 694 .%A McCanne, S.
 695 .%A Jacobson V.
 696 .%T "An efficient, extensible, and portable network monitor"
 697 .Re
 698 .Sh HISTORY
 699 The Enet packet filter was created in 1980 by Mike Accetta and
 700 Rick Rashid at Carnegie-Mellon University.
 701 Jeffrey Mogul, at
 702 Stanford, ported the code to
 703 .Bx
 704 and continued its development from
 705 1983 on.
 706 Since then, it has evolved into the Ultrix Packet Filter at
 707 .Tn DEC ,
 708 a
 709 .Tn STREAMS
 710 .Tn NIT
 711 module under
 712 .Tn SunOS 4.1 ,
 713 and
 714 .Tn BPF .
 715 .Sh AUTHORS
 716 .An -nosplit
 717 .An Steven McCanne ,
 718 of Lawrence Berkeley Laboratory, implemented BPF in
 719 Summer 1990.
 720 Much of the design is due to
 721 .An Van Jacobson .
 722 .Sh BUGS
 723 The read buffer must be of a fixed size (returned by the
 724 .Dv BIOCGBLEN
 725 ioctl).
 726 .Pp
 727 A file that does not request promiscuous mode may receive promiscuously
 728 received packets as a side effect of another file requesting this
 729 mode on the same hardware interface.
 730 This could be fixed in the kernel with additional processing overhead.
 731 However, we favor the model where
 732 all files must assume that the interface is promiscuous, and if
 733 so desired, must utilize a filter to reject foreign packets.
 734 .Pp
 735 Data link protocols with variable length headers are not currently supported.
 736 .Pp
 737 The
 738 .Dv SEESENT
 739 flag has been observed to work incorrectly on some interface
 740 types, including those with hardware loopback rather than software loopback,
 741 and point-to-point interfaces.
 742 It appears to function correctly on a
 743 broad range of Ethernet-style interfaces.