share/man/man9/ifnet.9

   1 .\" -*- Nroff -*-
   2 .\" Copyright 1996, 1997 Massachusetts Institute of Technology
   3 .\"
   4 .\" Permission to use, copy, modify, and distribute this software and
   5 .\" its documentation for any purpose and without fee is hereby
   6 .\" granted, provided that both the above copyright notice and this
   7 .\" permission notice appear in all copies, that both the above
   8 .\" copyright notice and this permission notice appear in all
   9 .\" supporting documentation, and that the name of M.I.T. not be used
  10 .\" in advertising or publicity pertaining to distribution of the
  11 .\" software without specific, written prior permission.  M.I.T. makes
  12 .\" no representations about the suitability of this software for any
  13 .\" purpose.  It is provided "as is" without express or implied
  14 .\" warranty.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY M.I.T. ``AS IS''.  M.I.T. DISCLAIMS
  17 .\" ALL EXPRESS OR IMPLIED WARRANTIES WITH REGARD TO THIS SOFTWARE,
  18 .\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  19 .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT
  20 .\" SHALL M.I.T. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21 .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22 .\" LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  23 .\" USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  24 .\" ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  25 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  26 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27 .\" SUCH DAMAGE.
  28 .\"
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd June 8, 2004
  32 .Os
  33 .Dt IFNET 9
  34 .Sh NAME
  35 .Nm ifnet ,
  36 .Nm ifaddr ,
  37 .Nm ifqueue ,
  38 .Nm if_data
  39 .Nd kernel interfaces for manipulating network interfaces
  40 .Sh SYNOPSIS
  41 .In sys/param.h
  42 .In sys/time.h
  43 .In sys/socket.h
  44 .In net/if.h
  45 .In net/if_var.h
  46 .In net/if_types.h
  47 .\"
  48 .Ss "Interface Manipulation Functions"
  49 .Ft void
  50 .Fn if_attach "struct ifnet *ifp"
  51 .Ft void
  52 .Fn if_down "struct ifnet *ifp"
  53 .Ft int
  54 .Fn ifioctl "struct socket *so" "u_long cmd" "caddr_t data" "struct thread *td"
  55 .Ft int
  56 .Fn ifpromisc "struct ifnet *ifp" "int pswitch"
  57 .Ft int
  58 .Fn if_allmulti "struct ifnet *ifp" "int amswitch"
  59 .Ft "struct ifnet *"
  60 .Fn ifunit "const char *name"
  61 .Ft void
  62 .Fn if_up "struct ifnet *ifp"
  63 .\"
  64 .Ss "Interface Address Functions"
  65 .Ft "struct ifaddr *"
  66 .Fn ifa_ifwithaddr "struct sockaddr *addr"
  67 .Ft "struct ifaddr *"
  68 .Fn ifa_ifwithdstaddr "struct sockaddr *addr"
  69 .Ft "struct ifaddr *"
  70 .Fn ifa_ifwithnet "struct sockaddr *addr"
  71 .Ft "struct ifaddr *"
  72 .Fn ifaof_ifpforaddr "struct sockaddr *addr" "struct ifnet *ifp"
  73 .Ft void
  74 .Fn ifafree "struct ifaddr *ifa"
  75 .Fn IFAFREE "struct ifaddr *ifa"
  76 .\"
  77 .Ss "Interface Multicast Address Functions"
  78 .Ft int
  79 .Fn if_addmulti "struct ifnet *ifp" "struct sockaddr *sa" "struct ifmultiaddr **ifmap"
  80 .Ft int
  81 .Fn if_delmulti "struct ifnet *ifp" "struct sockaddr *sa"
  82 .Ft "struct ifmultiaddr *"
  83 .Fn ifmaof_ifpforaddr "struct sockaddr *addr" "struct ifnet *ifp"
  84 .Ss "Output queue macros"
  85 .Fn IF_DEQUEUE "struct ifqueue *ifq" "struct mbuf *m"
  86 .\"
  87 .Ss "struct ifnet Member Functions"
  88 .Ft void
  89 .Fn \*(lp*if_input\*(rp "struct ifnet *ifp" "struct mbuf *m"
  90 .Ft int
  91 .Fo \*(lp*if_output\*(rp
  92 .Fa "struct ifnet *ifp" "struct mbuf *m"
  93 .Fa "struct sockaddr *dst" "struct rtentry *rt"
  94 .Fc
  95 .Ft void
  96 .Fn \*(lp*if_start\*(rp "struct ifnet *ifp"
  97 .Ft int
  98 .Fn \*(lp*if_done\*(rp "struct ifnet *ifp"
  99 .Ft int
 100 .Fn \*(lp*if_ioctl\*(rp "struct ifnet *ifp" "int cmd" "caddr_t data"
 101 .Ft void
 102 .Fn \*(lp*if_watchdog\*(rp "struct ifnet *ifp"
 103 .Ft int
 104 .Fn \*(lp*if_poll_recv\*(rp "struct ifnet *ifp" "int *quotap"
 105 .Ft int
 106 .Fn \*(lp*if_poll_xmit\*(rp "struct ifnet *ifp" "int *quotap"
 107 .Ft void
 108 .Fn \*(lp*if_poll_inttrn\*(rp "struct ifnet *ifp"
 109 .Ft void
 110 .Fn \*(lp*if_poll_slowinput\*(rp "struct ifnet *ifp" "struct mbuf *m"
 111 .Ft void
 112 .Fn \*(lp*if_init\*(rp "void *if_softc"
 113 .Ft int
 114 .Fo \*(lp*if_resolvemulti\*(rp
 115 .Fa "struct ifnet *ifp" "struct sockaddr **retsa" "struct sockaddr *addr"
 116 .Fc
 117 .Ss "struct ifaddr member function"
 118 .Ft void
 119 .Fo \*(lp*ifa_rtrequest\*(rp
 120 .Fa "int cmd" "struct rtentry *rt" "struct sockaddr *dst"
 121 .Fc
 122 .\"
 123 .Ss "Global Variables"
 124 .Vt extern struct ifnethead ifnet ;
 125 .Vt extern struct ifaddr **ifnet_addrs ;
 126 .Vt extern int if_index ;
 127 .Vt extern int ifqmaxlen ;
 128 .Sh DATA STRUCTURES
 129 The kernel mechanisms for handling network interfaces reside primarily
 130 in the
 131 .Vt ifnet , if_data , ifaddr ,
 132 and
 133 .Vt ifmultiaddr
 134 structures in
 135 .In net/if.h
 136 and
 137 .In net/if_var.h
 138 and the functions named above and defined in
 139 .Pa /sys/net/if.c .
 140 Those interfaces which are intended to be used by user programs
 141 are defined in
 142 .In net/if.h ;
 143 these include the interface flags, the
 144 .Vt if_data
 145 structure, and the structures defining the appearance of
 146 interface-related messages on the
 147 .Xr route 4
 148 routing socket and in
 149 .Xr sysctl 3 .
 150 The header file
 151 .In net/if_var.h
 152 defines the kernel-internal interfaces, including the
 153 .Vt ifnet , ifaddr ,
 154 and
 155 .Vt ifmultiaddr
 156 structures and the functions which manipulate them.
 157 (A few user programs will need
 158 .In net/if_var.h
 159 because it is the prerequisite of some other header file like
 160 .In netinet/if_ether.h .
 161 Most references to those two files in particular can be replaced by
 162 .In net/ethernet.h . )
 163 .Pp
 164 The system keeps a linked list of interfaces using the
 165 .Li TAILQ
 166 macros defined in
 167 .Xr queue 3 ;
 168 this list is headed by a
 169 .Vt "struct ifnethead"
 170 called
 171 .Va ifnet .
 172 The elements of this list are of type
 173 .Vt "struct ifnet" ,
 174 and most kernel routines which manipulate interface as such accept or
 175 return pointers to these structures.
 176 Each interface structure
 177 contains an
 178 .Vt if_data
 179 structure, which contains statistics and identifying information used
 180 by management programs, and which is exported to user programs by way
 181 of the
 182 .Xr ifmib 4
 183 branch of the
 184 .Xr sysctl 3
 185 MIB.
 186 Each interface also has a
 187 .Li TAILQ
 188 of interface addresses, described by
 189 .Vt ifaddr
 190 structures; the head of the queue is always an
 191 .Dv AF_LINK
 192 address
 193 (see
 194 .Xr link_addr 3 )
 195 describing the link layer implemented by the interface (if any).
 196 (Some trivial interfaces do not provide any link layer addresses;
 197 this structure, while still present, serves only to identify the
 198 interface name and index.)
 199 .Pp
 200 Finally, those interfaces supporting reception of multicast datagrams
 201 have a
 202 .Li TAILQ
 203 of multicast group memberships, described by
 204 .Vt ifmultiaddr
 205 structures.
 206 These memberships are reference-counted.
 207 .Pp
 208 Interfaces are also associated with an output queue, defined as a
 209 .Vt "struct ifqueue" ;
 210 this structure is used to hold packets while the interface is in the
 211 process of sending another.
 212 .Pp
 213 .Ss The Vt ifnet Ss structure
 214 The fields of
 215 .Vt "struct ifnet"
 216 are as follows:
 217 .Bl -tag -width ".Va if_capabilities" -offset indent
 218 .It Va if_softc
 219 .Pq Vt "void *"
 220 A pointer to the driver's private state block.
 221 (Initialized by driver.)
 222 .It Va if_link
 223 .Pq Fn TAILQ_ENTRY ifnet
 224 .Xr queue 3
 225 macro glue.
 226 .It Va if_xname
 227 .Pq Vt "char *"
 228 The name of the interface,
 229 (e.g.,
 230 .Dq Li fxp0
 231 or
 232 .Dq Li lo0 ) .
 233 (Initialized by driver.)
 234 .It Va if_dname
 235 .Pq Vt "const char *"
 236 The name of the driver.
 237 (Initialized by driver.)
 238 .It Va if_dunit
 239 .Pq Vt int
 240 A unique number assigned to each interface managed by a particular
 241 driver.
 242 Drivers may choose to set this to
 243 .Dv IF_DUNIT_NONE
 244 if a unit number is not associated with the device.
 245 (Initialized by driver.)
 246 .It Va if_addrhead
 247 .Pq Vt "struct ifaddrhead"
 248 The head of the
 249 .Xr queue 3
 250 .Li TAILQ
 251 containing the list of addresses assigned to this interface.
 252 .It Va if_pcount
 253 .Pq Vt int
 254 A count of promiscuous listeners on this interface, used to
 255 reference-count the
 256 .Dv IFF_PROMISC
 257 flag.
 258 .It Va if_bpf
 259 .Pq Vt "struct bpf_if *"
 260 Opaque per-interface data for the packet filter,
 261 .Xr bpf 4 .
 262 (Initialized by
 263 .Fn bpf_attach . )
 264 .It Va if_index
 265 .Pq Vt u_short
 266 A unique number assigned to each interface in sequence as it is
 267 attached.
 268 This number can be used in a
 269 .Vt "struct sockaddr_dl"
 270 to refer to a particular interface by index
 271 (see
 272 .Xr link_addr 3 ) .
 273 .It Va if_timer
 274 .Pq Vt short
 275 Number of seconds until the watchdog timer
 276 .Fn if_watchdog
 277 is called, or zero if the timer is disabled.
 278 (Set by driver,
 279 decremented by generic watchdog code.)
 280 .It Va if_flags
 281 .Pq Vt int
 282 Flags describing operational parameters of this interface (see below).
 283 (Manipulated by both driver and generic code.)
 284 .It Va if_capabilities
 285 .Pq Vt int
 286 Flags describing the capabilities the interface supports (see below).
 287 .It Va if_capenable
 288 .Pq Vt int
 289 Flags describing the enabled capabilities of the interface (see below).
 290 .\" .It Va if_ipending
 291 .\" Interrupt-pending bits for polled operation:
 292 .\" .Dv IFI_XMIT
 293 .\" (transmit complete interrupt)
 294 .\" and
 295 .\" .Dv IFI_RECV
 296 .\" (received packet ready interrupt).
 297 .\" See the
 298 .\" .Sx Polling
 299 .\" section, below.
 300 .\" (Manipulated by driver.)
 301 .It Va if_linkmib
 302 .Pq Vt "void *"
 303 A pointer to an interface-specific MIB structure exported by
 304 .Xr ifmib 4 .
 305 (Initialized by driver.)
 306 .It Va if_linkmiblen
 307 .Pq Vt size_t
 308 The size of said structure.
 309 (Initialized by driver.)
 310 .It Va if_data
 311 .Pq Vt "struct if_data"
 312 More statistics and information; see
 313 .Sx "The if_data structure" ,
 314 below.
 315 (Initialized by driver, manipulated by both driver and generic
 316 code.)
 317 .It Va if_snd
 318 .Pq Vt "struct ifqueue"
 319 The output queue.
 320 (Manipulated by driver.)
 321 .\".It Va if_poll_slowq
 322 .\".Pq Vt "struct ifqueue *"
 323 .\"A pointer to the input queue for devices which do not support polling
 324 .\"well.
 325 .\"See the
 326 .\".Sx Polling
 327 .\"section, below.
 328 .\"(Initialized by driver.)
 329 .El
 330 .Pp
 331 There are in addition a number of function pointers which the driver
 332 must initialize to complete its interface with the generic interface
 333 layer:
 334 .Bl -ohang -offset indent
 335 .It Fn if_input
 336 Pass a packet to an appropriate upper layer as determined
 337 from the link-layer header of the packet.
 338 This routine is to be called from an interrupt handler or
 339 used to emulate reception of a packet on this interface.
 340 A single function implementing
 341 .Fn if_input
 342 can be shared among multiple drivers utilizing the same link-layer
 343 framing, e.g., Ethernet.
 344 .It Fn if_output
 345 Output a packet on interface
 346 .Fa ifp ,
 347 or queue it on the output queue if the interface is already active.
 348 .It Fn if_start
 349 Start queued output on an interface.
 350 This function is exposed in
 351 order to provide for some interface classes to share a
 352 .Fn if_output
 353 among all drivers.
 354 .Fn if_start
 355 may only be called when the
 356 .Dv IFF_OACTIVE
 357 flag is not set.
 358 (Thus,
 359 .Dv IFF_OACTIVE
 360 does not literally mean that output is active, but rather that the
 361 device's internal output queue is full.)
 362 .It Fn if_done
 363 Not used.
 364 We are not even sure what it was ever for.
 365 The prototype is faked.
 366 .It Fn if_ioctl
 367 Process interface-related
 368 .Xr ioctl 2
 369 requests
 370 (defined in
 371 .In sys/sockio.h ) .
 372 Preliminary processing is done by the generic routine
 373 .Fn ifioctl
 374 to check for appropriate privileges, locate the interface being
 375 manipulated, and perform certain generic operations like twiddling
 376 flags and flushing queues.
 377 See the description of
 378 .Fn ifioctl
 379 below for more information.
 380 .It Fn if_watchdog
 381 Routine called by the generic code when the watchdog timer,
 382 .Va if_timer ,
 383 expires.
 384 Usually this will reset the interface.
 385 .\" .It Fn if_poll_recv
 386 .\" .It Fn if_poll_xmit
 387 .\" .It Fn if_poll_slowinput
 388 .\" .It Fn if_poll_intren
 389 .\" See the
 390 .\" .Sx Polling
 391 .\" section, below.
 392 .It Fn if_init
 393 Initialize and bring up the hardware,
 394 e.g., reset the chip and the watchdog timer and enable the receiver unit.
 395 Should mark the interface running,
 396 but not active
 397 .Dv ( IFF_RUNNING , ~IIF_OACTIVE ) .
 398 .It Fn if_resolvemulti
 399 Check the requested multicast group membership,
 400 .Fa addr ,
 401 for validity, and if necessary compute a link-layer group which
 402 corresponds to that address which is returned in
 403 .Fa *retsa .
 404 Returns zero on success, or an error code on failure.
 405 .El
 406 .Ss "Interface Flags"
 407 Interface flags are used for a number of different purposes.
 408 Some
 409 flags simply indicate information about the type of interface and its
 410 capabilities; others are dynamically manipulated to reflect the
 411 current state of the interface.
 412 Flags of the former kind are marked
 413 .Aq S
 414 in this table; the latter are marked
 415 .Aq D .
 416 .Pp
 417 The macro
 418 .Dv IFF_CANTCHANGE
 419 defines the bits which cannot be set by a user program using the
 420 .Dv SIOCSIFFLAGS
 421 command to
 422 .Xr ioctl 2 ;
 423 these are indicated by an asterisk
 424 .Pq Ql *
 425 in the following listing.
 426 .Pp
 427 .Bl -tag -width ".Dv IFF_POINTOPOINT" -offset indent -compact
 428 .It Dv IFF_UP
 429 .Aq D
 430 The interface has been configured up by the user-level code.
 431 .It Dv IFF_BROADCAST
 432 .Aq S*
 433 The interface supports broadcast.
 434 .It Dv IFF_DEBUG
 435 .Aq D
 436 Used to enable/disable driver debugging code.
 437 .It Dv IFF_LOOPBACK
 438 .Aq S
 439 The interface is a loopback device.
 440 .It Dv IFF_POINTOPOINT
 441 .Aq S*
 442 The interface is point-to-point;
 443 .Dq broadcast
 444 address is actually the address of the other end.
 445 .It Dv IFF_RUNNING
 446 .Aq D*
 447 The interface has been configured and dynamic resources were
 448 successfully allocated.
 449 Probably only useful internal to the
 450 interface.
 451 .It Dv IFF_NOARP
 452 .Aq D
 453 Disable network address resolution on this interface.
 454 .It Dv IFF_PROMISC
 455 .Aq D*
 456 This interface is in promiscuous mode.
 457 .It Dv IFF_PPROMISC
 458 .Aq D
 459 This interface is in the permanently promiscuous mode (implies
 460 .Dv IFF_PROMISC ) .
 461 .It Dv IFF_ALLMULTI
 462 .Aq D*
 463 This interface is in all-multicasts mode (used by multicast routers).
 464 .It Dv IFF_OACTIVE
 465 .Aq D*
 466 The interface's hardware output queue (if any) is full; output packets
 467 are to be queued.
 468 .It Dv IFF_SIMPLEX
 469 .Aq S*
 470 The interface cannot hear its own transmissions.
 471 .It Dv IFF_LINK0
 472 .It Dv IFF_LINK1
 473 .It Dv IFF_LINK2
 474 .Aq D
 475 Control flags for the link layer.
 476 (Currently abused to select among
 477 multiple physical layers on some devices.)
 478 .It Dv IFF_MULTICAST
 479 .Aq S*
 480 This interface supports multicast.
 481 .It Dv IFF_POLLING
 482 .Aq D*
 483 The interface is in
 484 .Xr polling 4
 485 mode.
 486 See
 487 .Sx Interface Capabilities Flags
 488 for details.
 489 .El
 490 .Ss "Interface Capabilities Flags"
 491 Interface capabilities are specialized features an interface may
 492 or may not support.
 493 These capabilities are very hardware-specific
 494 and allow, when enabled,
 495 to offload specific network processing to the interface
 496 or to offer a particular feature for use by other kernel parts.
 497 .Pp
 498 It should be stressed that a capability can be completely
 499 uncontrolled (i.e., stay always enabled with no way to disable it)
 500 or allow limited control over itself (e.g., depend on another
 501 capability's state.)
 502 Such peculiarities are determined solely by the hardware and driver
 503 of a particular interface.
 504 Only the driver possesses
 505 the knowledge on whether and how the interface capabilities
 506 can be controlled.
 507 Consequently, capabilities flags in
 508 .Va if_capenable
 509 should never be modified directly by kernel code other than
 510 the interface driver.
 511 The command
 512 .Dv SIOCSIFCAP
 513 to
 514 .Fn ifioctl
 515 is the dedicated means to attempt altering
 516 .Va if_capenable
 517 on an interface.
 518 Userland code shall use
 519 .Xr ioctl 2 .
 520 .Pp
 521 The following capabilities are currently supported by the system:
 522 .Bl -tag -width ".Dv IFCAP_VLAN_HWTAGGING" -offset indent
 523 .It Dv IFCAP_NETCONS
 524 This interface can be a network console.
 525 .It Dv IFCAP_POLLING
 526 This interface supports
 527 .Xr polling 4 .
 528 See below for details.
 529 .It Dv IFCAP_RXCSUM
 530 This interface can do checksum validation on receiving data.
 531 Some interfaces do not have sufficient buffer storage to store frames
 532 above a certain MTU-size completely.
 533 The driver for the interface might disable hardware checksum validation
 534 if the MTU is set above the hardcoded limit.
 535 .It Dv IFCAP_TXCSUM
 536 This interface can do checksum calculation on transmitting data.
 537 .It Dv IFCAP_HWCSUM
 538 A shorthand for
 539 .Pq Dv IFCAP_RXCSUM | IFCAP_TXCSUM .
 540 .It Dv IFCAP_VLAN_HWTAGGING
 541 This interface can do VLAN tagging on output and
 542 demultiplex frames by their VLAN tag on input.
 543 .It Dv IFCAP_VLAN_MTU
 544 The
 545 .Xr vlan 4
 546 driver can operate over this interface in software tagging mode
 547 without having to decrease MTU on
 548 .Xr vlan 4
 549 interfaces below 1500 bytes.
 550 This implies the ability of this interface to cope with frames somewhat
 551 longer than permitted by the Ethernet specification.
 552 .It Dv IFCAP_JUMBO_MTU
 553 This Ethernet interface can transmit and receive frames up to
 554 9000 bytes long.
 555 .El
 556 .Pp
 557 The ability of advanced network interfaces to offload certain
 558 computational tasks from the host CPU to the board is limited
 559 mostly to TCP/IP.
 560 Therefore a separate field associated with an interface
 561 (see
 562 .Va ifnet.if_data.ifi_hwassist
 563 below)
 564 keeps a detailed description of its enabled capabilities
 565 specific to TCP/IP processing.
 566 The TCP/IP module consults the field to see which tasks
 567 can be done on an
 568 .Em outgoing
 569 packet by the interface.
 570 The flags defined for that field are a superset of those for
 571 .Va mbuf.m_pkthdr.csum_flags ,
 572 namely:
 573 .Bl -tag -width ".Dv CSUM_FRAGMENT" -offset indent
 574 .It Dv CSUM_IP
 575 The interface will compute IP checksums.
 576 .It Dv CSUM_TCP
 577 The interface will compute TCP checksums.
 578 .It Dv CSUM_UDP
 579 The interface will compute UDP checksums.
 580 .It Dv CSUM_IP_FRAGS
 581 The interface can compute a TCP or UDP checksum for a packet
 582 fragmented by the host CPU.
 583 Makes sense only along with
 584 .Dv CSUM_TCP
 585 or
 586 .Dv CSUM_UDP .
 587 .It Dv CSUM_FRAGMENT
 588 The interface will do the fragmentation of IP packets if necessary.
 589 The host CPU does not need to care about MTU on this interface
 590 as long as a packet to transmit through it is an IP one and it
 591 does not exceed the size of the hardware buffer.
 592 .El
 593 .Pp
 594 An interface notifies the TCP/IP module about the tasks
 595 the former has performed on an
 596 .Em incoming
 597 packet by setting the corresponding flags in the field
 598 .Va mbuf.m_pkthdr.csum_flags
 599 of the
 600 .Vt mbuf chain
 601 containing the packet.
 602 See
 603 .Xr mbuf 9
 604 for details.
 605 .Pp
 606 The capability of a network interface to operate in
 607 .Xr polling 4
 608 mode involves several flags in different
 609 global variables and per-interface fields.
 610 First, there is a system-wide
 611 .Xr sysctl 8
 612 master switch named
 613 .Va kern.polling.enable ,
 614 which can toggle
 615 .Xr polling 4
 616 globally.
 617 If that variable is set to non-zero,
 618 .Xr polling 4
 619 will be used on those devices where it is enabled individually.
 620 Otherwise,
 621 .Xr polling 4
 622 will not be used in the system.
 623 Second, the capability flag
 624 .Dv IFCAP_POLLING
 625 set in interface's
 626 .Va if_capabilities
 627 indicates support for
 628 .Xr polling 4
 629 on the particular interface.
 630 If set in
 631 .Va if_capabilities ,
 632 the same flag can be marked or cleared in the interface's
 633 .Va if_capenable ,
 634 thus initiating switch of the interface to
 635 .Xr polling 4
 636 mode or interrupt
 637 mode, respectively.
 638 The actual mode change will occur at an implementation-specific moment
 639 in the future, e.g., during the next interrupt or
 640 .Xr polling 4
 641 cycle.
 642 And finally, if the mode transition has been successful, the flag
 643 .Dv IFF_POLLING
 644 is marked or cleared in the interface's
 645 .Va if_flags
 646 to indicate the current mode of the interface.
 647 .Ss The Vt if_data Ss Structure
 648 In
 649 .Bx 4.4 ,
 650 a subset of the interface information believed to be of interest to
 651 management stations was segregated from the
 652 .Vt ifnet
 653 structure and moved into its own
 654 .Vt if_data
 655 structure to facilitate its use by user programs.
 656 The following elements of the
 657 .Vt if_data
 658 structure are initialized by the interface and are not expected to change
 659 significantly over the course of normal operation:
 660 .Bl -tag -width ".Va ifi_lastchange" -offset indent
 661 .It Va ifi_type
 662 .Pq Vt u_char
 663 The type of the interface, as defined in
 664 .In net/if_types.h
 665 and described below in the
 666 .Sx "Interface Types"
 667 section.
 668 .It Va ifi_physical
 669 .Pq Vt u_char
 670 Intended to represent a selection of physical layers on devices which
 671 support more than one; never implemented.
 672 .It Va ifi_addrlen
 673 .Pq Vt u_char
 674 Length of a link-layer address on this device, or zero if there are
 675 none.
 676 Used to initialized the address length field in
 677 .Vt sockaddr_dl
 678 structures referring to this interface.
 679 .It Va ifi_hdrlen
 680 .Pq Vt u_char
 681 Maximum length of any link-layer header which might be prepended by
 682 the driver to a packet before transmission.
 683 The generic code computes
 684 the maximum over all interfaces and uses that value to influence the
 685 placement of data in
 686 .Vt mbuf Ns s
 687 to attempt to ensure that there is always
 688 sufficient space to prepend a link-layer header without allocating an
 689 additional
 690 .Vt mbuf .
 691 .\" (See
 692 .\" .Xr mbuf 9 . )
 693 .\" .It Va ifi_recvquota
 694 .\" .Pq Vt u_char
 695 .\" Number of packets the interface is permitted to receive at one time
 696 .\" when in polled mode.
 697 .\" .It Va ifi_xmitquota
 698 .\" .Pq Vt u_char
 699 .\" Number of packets the interface is permitted to queue for transmission
 700 .\" at one time when in polled mode.
 701 .\" There is some controversy over
 702 .\" whether such a restriction makes any sense at all.
 703 .It Va ifi_datalen
 704 .Pq Vt u_char
 705 Length of the
 706 .Vt if_data
 707 structure.
 708 Allows some stabilization of the routing socket ABI in the face of
 709 increases in the length of
 710 .Vt struct ifdata .
 711 .It Va ifi_mtu
 712 .Pq Vt u_long
 713 The maximum transmission unit of the medium, exclusive of any
 714 link-layer overhead.
 715 .It Va ifi_metric
 716 .Pq Vt u_long
 717 A dimensionless metric interpreted by a user-mode routing process.
 718 .It Va ifi_baudrate
 719 .Pq Vt u_long
 720 The line rate of the interface, in bits per second.
 721 .It Va ifi_hwassist
 722 .Pq Vt u_long
 723 A detailed interpretation of the capabilities
 724 to offload computational tasks for
 725 .Em outgoing
 726 packets.
 727 The interface driver must keep this field in accord with
 728 the current value of
 729 .Va if_capenable .
 730 .It ifi_epoch
 731 .Pq Vt time_t
 732 The system uptime when interface was attached or the statistics
 733 below were reset.
 734 This is intended to be used to set the SNMP variable
 735 .Va ifCounterDiscontinuityTime .
 736 It may also be used to determine if two successive queries for an
 737 interface of the same index have returned results for the same
 738 interface.
 739 .El
 740 .Pp
 741 The structure additionally contains generic statistics applicable to a
 742 variety of different interface types (except as noted, all members are
 743 of type
 744 .Vt u_long ) :
 745 .Bl -tag -width ".Va ifi_lastchange" -offset indent
 746 .It Va ifi_link_state
 747 .Pq Vt u_char
 748 The current link state of Ethernet interfaces.
 749 See the
 750 .Sx Interface Link States
 751 section for possible values.
 752 .It Va ifi_ipackets
 753 Number of packets received.
 754 .It Va ifi_ierrors
 755 Number of receive errors detected (e.g., FCS errors, DMA overruns,
 756 etc.).
 757 More detailed breakdowns can often be had by way of a
 758 link-specific MIB.
 759 .It Va ifi_opackets
 760 Number of packets transmitted.
 761 .It Va ifi_oerrors
 762 Number of output errors detected (e.g., late collisions, DMA overruns,
 763 etc.).
 764 More detailed breakdowns can often be had by way of a
 765 link-specific MIB.
 766 .It Va ifi_collisions
 767 Total number of collisions detected on output for CSMA interfaces.
 768 (This member is sometimes [ab]used by other types of interfaces for
 769 other output error counts.)
 770 .It Va ifi_ibytes
 771 Total traffic received, in bytes.
 772 .It Va ifi_obytes
 773 Total traffic transmitted, in bytes.
 774 .It Va ifi_imcasts
 775 Number of packets received which were sent by link-layer multicast.
 776 .It Va ifi_omcasts
 777 Number of packets sent by link-layer multicast.
 778 .It Va ifi_iqdrops
 779 Number of packets dropped on input.
 780 Rarely implemented.
 781 .It Va ifi_noproto
 782 Number of packets received for unknown network-layer protocol.
 783 .\" .It Va ifi_recvtiming
 784 .\" Amount of time, in microseconds, spent to receive an average packet on
 785 .\" this interface.
 786 .\" See the
 787 .\" .Sx Polling
 788 .\" section, below.
 789 .\" .It Va ifi_xmittiming
 790 .\" Amount of time, in microseconds, spent to service a transmit-complete
 791 .\" interrupt on this interface.
 792 .\" See the
 793 .\" .Sx Polling
 794 .\" section, below.
 795 .It Va ifi_lastchange
 796 .Pq Vt "struct timeval"
 797 The time of the last administrative change to the interface (as required
 798 for
 799 .Tn SNMP ) .
 800 .El
 801 .Ss Interface Types
 802 The header file
 803 .In net/if_types.h
 804 defines symbolic constants for a number of different types of
 805 interfaces.
 806 The most common are:
 807 .Pp
 808 .Bl -tag -offset indent -width ".Dv IFT_PROPVIRTUAL" -compact
 809 .It Dv IFT_OTHER
 810 none of the following
 811 .It Dv IFT_ETHER
 812 Ethernet
 813 .It Dv IFT_ISO88023
 814 ISO 8802-3 CSMA/CD
 815 .It Dv IFT_ISO88024
 816 ISO 8802-4 Token Bus
 817 .It Dv IFT_ISO88025
 818 ISO 8802-5 Token Ring
 819 .It Dv IFT_ISO88026
 820 ISO 8802-6 DQDB MAN
 821 .It Dv IFT_FDDI
 822 FDDI
 823 .It Dv IFT_PPP
 824 Internet Point-to-Point Protocol
 825 .Pq Xr ppp 8
 826 .It Dv IFT_LOOP
 827 The loopback
 828 .Pq Xr lo 4
 829 interface
 830 .It Dv IFT_SLIP
 831 Serial Line IP
 832 .It Dv IFT_PARA
 833 Parallel-port IP
 834 .Pq Dq Tn PLIP
 835 .It Dv IFT_ATM
 836 Asynchronous Transfer Mode
 837 .El
 838 .Ss Interface Link States
 839 The following link states are currently defined:
 840 .Pp
 841 .Bl -tag -offset indent -width ".Dv LINK_STATE_UNKNOWN" -compact
 842 .It Dv LINK_STATE_UNKNOWN
 843 The link is in an invalid or unknown state.
 844 .It Dv LINK_STATE_DOWN
 845 The link is down.
 846 .It Dv LINK_STATE_UP
 847 The link is up.
 848 .El
 849 .Ss The Vt ifaddr Ss Structure
 850 Every interface is associated with a list
 851 (or, rather, a
 852 .Li TAILQ )
 853 of addresses, rooted at the interface structure's
 854 .Va if_addrlist
 855 member.
 856 The first element in this list is always an
 857 .Dv AF_LINK
 858 address representing the interface itself; multi-access network
 859 drivers should complete this structure by filling in their link-layer
 860 addresses after calling
 861 .Fn if_attach .
 862 Other members of the structure represent network-layer addresses which
 863 have been configured by means of the
 864 .Dv SIOCAIFADDR
 865 command to
 866 .Xr ioctl 2 ,
 867 called on a socket of the appropriate protocol family.
 868 The elements of this list consist of
 869 .Vt ifaddr
 870 structures.
 871 Most protocols will declare their own protocol-specific
 872 interface address structures, but all begin with a
 873 .Vt "struct ifaddr"
 874 which provides the most-commonly-needed functionality across all
 875 protocols.
 876 Interface addresses are reference-counted.
 877 .Pp
 878 The members of
 879 .Vt "struct ifaddr"
 880 are as follows:
 881 .Bl -tag -width ".Va ifa_rtrequest" -offset indent
 882 .It Va ifa_addr
 883 .Pq Vt "struct sockaddr *"
 884 The local address of the interface.
 885 .It Va ifa_dstaddr
 886 .Pq Vt "struct sockaddr *"
 887 The remote address of point-to-point interfaces, and the broadcast
 888 address of broadcast interfaces.
 889 .Va ( ifa_broadaddr
 890 is a macro for
 891 .Va ifa_dstaddr . )
 892 .It Va ifa_netmask
 893 .Pq Vt "struct sockaddr *"
 894 The network mask for multi-access interfaces, and the confusion
 895 generator for point-to-point interfaces.
 896 .It Va ifa_ifp
 897 .Pq Vt "struct ifnet *"
 898 A link back to the interface structure.
 899 .It Va ifa_link
 900 .Pq Fn TAILQ_ENTRY ifaddr
 901 .Xr queue 3
 902 glue for list of addresses on each interface.
 903 .It Va ifa_rtrequest
 904 See below.
 905 .It Va ifa_flags
 906 .Pq Vt u_short
 907 Some of the flags which would be used for a route representing this
 908 address in the route table.
 909 .It Va ifa_refcnt
 910 .Pq Vt short
 911 The reference count.
 912 .It Va ifa_metric
 913 .Pq Vt int
 914 A metric associated with this interface address, for the use of some
 915 external routing protocol.
 916 .El
 917 .Pp
 918 References to
 919 .Vt ifaddr
 920 structures are gained manually, by incrementing the
 921 .Va ifa_refcnt
 922 member.
 923 References are released by calling either the
 924 .Fn ifafree
 925 function or the
 926 .Fn IFAFREE
 927 macro.
 928 .Pp
 929 .Fn ifa_rtrequest
 930 is a pointer to a function which receives callouts from the routing
 931 code
 932 .Pq Fn rtrequest
 933 to perform link-layer-specific actions upon requests to add, resolve,
 934 or delete routes.
 935 The
 936 .Fa cmd
 937 argument indicates the request in question:
 938 .Dv RTM_ADD , RTM_RESOLVE ,
 939 or
 940 .Dv RTM_DELETE .
 941 The
 942 .Fa rt
 943 argument is the route in question; the
 944 .Fa dst
 945 argument is the specific destination being manipulated
 946 for
 947 .Dv RTM_RESOLVE ,
 948 or a null pointer otherwise.
 949 .Sh FUNCTIONS
 950 The functions provided by the generic interface code can be divided
 951 into two groups: those which manipulate interfaces, and those which
 952 manipulate interface addresses.
 953 In addition to these functions, there
 954 may also be link-layer support routines which are used by a number of
 955 drivers implementing a specific link layer over different hardware;
 956 see the documentation for that link layer for more details.
 957 .Ss The Vt ifmultiaddr Ss Structure
 958 Every multicast-capable interface is associated with a list of
 959 multicast group memberships, which indicate at a low level which
 960 link-layer multicast addresses (if any) should be accepted, and at a
 961 high level, in which network-layer multicast groups a user process has
 962 expressed interest.
 963 .Pp
 964 The elements of the structure are as follows:
 965 .Bl -tag -width ".Va ifma_refcount" -offset indent
 966 .It Va ifma_link
 967 .Pq Fn LIST_ENTRY ifmultiaddr
 968 .Xr queue 3
 969 macro glue.
 970 .It Va ifma_addr
 971 .Pq Vt "struct sockaddr *"
 972 A pointer to the address which this record represents.
 973 The
 974 memberships for various address families are stored in arbitrary
 975 order.
 976 .It Va ifma_lladdr
 977 .Pq Vt "struct sockaddr *"
 978 A pointer to the link-layer multicast address, if any, to which the
 979 network-layer multicast address in
 980 .Va ifma_addr
 981 is mapped, else a null pointer.
 982 If this element is non-nil, this
 983 membership also holds an invisible reference to another membership for
 984 that link-layer address.
 985 .It Va ifma_refcount
 986 .Pq Vt u_int
 987 A reference count of requests for this particular membership.
 988 .El
 989 .Ss Interface Manipulation Functions
 990 .Bl -ohang -offset indent
 991 .It Fn if_attach
 992 Link the specified interface
 993 .Fa ifp
 994 into the list of network interfaces.
 995 Also initialize the list of
 996 addresses on that interface, and create a link-layer
 997 .Vt ifaddr
 998 structure to be the first element in that list.
 999 (A pointer to
1000 this address structure is saved in the global array
1001 .Va ifnet_addrs . )
1002 .It Fn if_down
1003 Mark the interface
1004 .Fa ifp
1005 as down (i.e.,
1006 .Dv IFF_UP
1007 is not set),
1008 flush its output queue, notify protocols of the transition,
1009 and generate a message from the
1010 .Xr route 4
1011 routing socket.
1012 .It Fn if_up
1013 Mark the interface
1014 .Fa ifp
1015 as up, notify protocols of the transition,
1016 and generate a message from the
1017 .Xr route 4
1018 routing socket.
1019 .It Fn ifpromisc
1020 Add or remove a promiscuous reference to
1021 .Fa ifp .
1022 If
1023 .Fa pswitch
1024 is true, add a reference;
1025 if it is false, remove a reference.
1026 On reference count transitions
1027 from zero to one and one to zero, set the
1028 .Dv IFF_PROMISC
1029 flag appropriately and call
1030 .Fn if_ioctl
1031 to set up the interface in the desired mode.
1032 .It Fn if_allmulti
1033 As
1034 .Fn ifpromisc ,
1035 but for the all-multicasts
1036 .Pq Dv IFF_ALLMULTI
1037 flag instead of the promiscuous flag.
1038 .It Fn ifunit
1039 Return an
1040 .Vt ifnet
1041 pointer for the interface named
1042 .Fa name .
1043 .It Fn ifioctl
1044 Process the ioctl request
1045 .Fa cmd ,
1046 issued on socket
1047 .Fa so
1048 by thread
1049 .Fa td ,
1050 with data parameter
1051 .Fa data .
1052 This is the main routine for handling all interface configuration
1053 requests from user mode.
1054 It is ordinarily only called from the socket-layer
1055 .Xr ioctl 2
1056 handler, and only for commands with class
1057 .Sq Li i .
1058 Any unrecognized commands will be passed down to socket
1059 .Fa so Ns 's
1060 protocol for
1061 further interpretation.
1062 The following commands are handled by
1063 .Fn ifioctl :
1064 .Pp
1065 .Bl -tag -width ".Dv OSIOCGIFNETMASK" -offset indent -compact
1066 .It Dv SIOCGIFCONF
1067 .It Dv OSIOCGIFCONF
1068 Get interface configuration.
1069 (No call-down to driver.)
1070 .Pp
1071 .It Dv SIOCSIFNAME
1072 Set the interface name.
1073 .Dv RTM_IFANNOUNCE
1074 departure and arrival messages are sent so that
1075 routing code that relies on the interface name will update its interface
1076 list.
1077 Caller must have appropriate privilege.
1078 (No call-down to driver.)
1079 .It Dv SIOCGIFCAP
1080 .It Dv SIOCGIFFLAGS
1081 .It Dv SIOCGIFMETRIC
1082 .It Dv SIOCGIFMTU
1083 .It Dv SIOCGIFPHYS
1084 Get interface capabilities, flags, metric, MTU, medium selection.
1085 (No call-down to driver.)
1086 .Pp
1087 .It Dv SIOCSIFCAP
1088 Enable or disable interface capabilities.
1089 Caller must have appropriate privilege.
1090 Before a call to the driver-specific
1091 .Fn if_ioctl
1092 routine, the requested mask for enabled capabilities is checked
1093 against the mask of capabilities supported by the interface,
1094 .Va if_capabilities .
1095 Requesting to enable an unsupported capability is invalid.
1096 The rest is supposed to be done by the driver,
1097 which includes updating
1098 .Va if_capenable
1099 and
1100 .Va if_data.ifi_hwassist
1101 appropriately.
1102 .Pp
1103 .It Dv SIOCSIFFLAGS
1104 Change interface flags.
1105 Caller must have appropriate privilege.
1106 If a change to the
1107 .Dv IFF_UP
1108 flag is requested,
1109 .Fn if_up
1110 or
1111 .Fn if_down
1112 is called as appropriate.
1113 Flags listed in
1114 .Dv IFF_CANTCHANGE
1115 are masked off, and the field
1116 .Va if_flags
1117 in the interface structure is updated.
1118 Finally, the driver
1119 .Fn if_ioctl
1120 routine is called to perform any setup
1121 requested.
1122 .Pp
1123 .It Dv SIOCSIFMETRIC
1124 .It Dv SIOCSIFPHYS
1125 Change interface metric or medium.
1126 Caller must have appropriate privilege.
1127 .Pp
1128 .It Dv SIOCSIFMTU
1129 Change interface MTU.
1130 Caller must have appropriate privilege.
1131 MTU
1132 values less than 72 or greater than 65535 are considered invalid.
1133 The driver
1134 .Fn if_ioctl
1135 routine is called to implement the change; it is responsible for any
1136 additional sanity checking and for actually modifying the MTU in the
1137 interface structure.
1138 .Pp
1139 .It Dv SIOCADDMULTI
1140 .It Dv SIOCDELMULTI
1141 Add or delete permanent multicast group memberships on the interface.
1142 Caller must have appropriate privilege.
1143 The
1144 .Fn if_addmulti
1145 or
1146 .Fn if_delmulti
1147 function is called to perform the operation; qq.v.
1148 .Pp
1149 .It Dv SIOCSIFDSTADDR
1150 .It Dv SIOCSIFADDR
1151 .It Dv SIOCSIFBRDADDR
1152 .It Dv SIOCSIFNETMASK
1153 The socket's protocol control routine is called to implement the
1154 requested action.
1155 .Pp
1156 .It Dv OSIOGIFADDR
1157 .It Dv OSIOCGIFDSTADDR
1158 .It Dv OSIOCGIFBRDADDR
1159 .It Dv OSIOCGIFNETMASK
1160 The socket's protocol control routine is called to implement the
1161 requested action.
1162 On return,
1163 .Vt sockaddr
1164 structures are converted into old-style (no
1165 .Va sa_len
1166 member).
1167 .El
1168 .El
1169 .Pp
1170 .Fn if_down ,
1171 .Fn ifioctl ,
1172 .Fn ifpromisc ,
1173 and
1174 .Fn if_up
1175 must be called at
1176 .Fn splnet
1177 or higher.
1178 .Ss "Interface Address Functions"
1179 Several functions exist to look up an interface address structure
1180 given an address.
1181 .Fn ifa_ifwithaddr
1182 returns an interface address with either a local address or a
1183 broadcast address precisely matching the parameter
1184 .Fa addr .
1185 .Fn ifa_ifwithdstaddr
1186 returns an interface address for a point-to-point interface whose
1187 remote
1188 .Pq Dq destination
1189 address is
1190 .Fa addr .
1191 .Pp
1192 .Fn ifa_ifwithnet
1193 returns the most specific interface address which matches the
1194 specified address,
1195 .Fa addr ,
1196 subject to its configured netmask, or a point-to-point interface
1197 address whose remote address is
1198 .Fa addr
1199 if one is found.
1200 .Pp
1201 .Fn ifaof_ifpforaddr
1202 returns the most specific address configured on interface
1203 .Fa ifp
1204 which matches address
1205 .Fa addr ,
1206 subject to its configured netmask.
1207 If the interface is
1208 point-to-point, only an interface address whose remote address is
1209 precisely
1210 .Fa addr
1211 will be returned.
1212 .Pp
1213 All of these functions return a null pointer if no such address can be
1214 found.
1215 .Ss "Interface Multicast Address Functions"
1216 The
1217 .Fn if_addmulti ,
1218 .Fn if_delmulti ,
1219 and
1220 .Fn ifmaof_ifpforaddr
1221 functions provide support for requesting and relinquishing multicast
1222 group memberships, and for querying an interface's membership list,
1223 respectively.
1224 The
1225 .Fn if_addmulti
1226 function takes a pointer to an interface,
1227 .Fa ifp ,
1228 and a generic address,
1229 .Fa sa .
1230 It also takes a pointer to a
1231 .Vt "struct ifmultiaddr *"
1232 which is filled in on successful return with the address of the
1233 group membership control block.
1234 The
1235 .Fn if_addmulti
1236 function performs the following four-step process:
1237 .Bl -enum -offset indent
1238 .It
1239 Call the interface's
1240 .Fn if_resolvemulti
1241 entry point to determine the link-layer address, if any, corresponding
1242 to this membership request, and also to give the link layer an
1243 opportunity to veto this membership request should it so desire.
1244 .It
1245 Check the interface's group membership list for a pre-existing
1246 membership for this group.
1247 If one is not found, allocate a new one;
1248 if one is, increment its reference count.
1249 .It
1250 If the
1251 .Fn if_resolvemulti
1252 routine returned a link-layer address corresponding to the group,
1253 repeat the previous step for that address as well.
1254 .It
1255 If the interface's multicast address filter needs to be changed
1256 because a new membership was added, call the interface's
1257 .Fn if_ioctl
1258 routine
1259 (with a
1260 .Fa cmd
1261 argument of
1262 .Dv SIOCADDMULTI )
1263 to request that it do so.
1264 .El
1265 .Pp
1266 The
1267 .Fn if_delmulti
1268 function, given an interface
1269 .Fa ifp
1270 and an address,
1271 .Fa sa ,
1272 reverses this process.
1273 Both functions return zero on success, or a
1274 standard error number on failure.
1275 .Pp
1276 The
1277 .Fn ifmaof_ifpforaddr
1278 function examines the membership list of interface
1279 .Fa ifp
1280 for an address matching
1281 .Fa addr ,
1282 and returns a pointer to that
1283 .Vt "struct ifmultiaddr"
1284 if one is found, else it returns a null pointer.
1285 .Sh SEE ALSO
1286 .Xr ioctl 2 ,
1287 .Xr link_addr 3 ,
1288 .Xr queue 3 ,
1289 .Xr sysctl 3 ,
1290 .Xr bpf 4 ,
1291 .Xr ifmib 4 ,
1292 .Xr lo 4 ,
1293 .Xr netintro 4 ,
1294 .Xr polling 4 ,
1295 .Xr config 8 ,
1296 .Xr ppp 8 ,
1297 .Xr mbuf 9 ,
1298 .Xr rtentry 9
1299 .Rs
1300 .%A Gary R. Wright
1301 .%A W. Richard Stevens
1302 .%B TCP/IP Illustrated
1303 .%V Vol. 2
1304 .%O Addison-Wesley, ISBN 0-201-63354-X
1305 .Re
1306 .Sh AUTHORS
1307 This manual page was written by
1308 .An Garrett A. Wollman .