sys/net/if.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1982, 1986, 1989, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. Neither the name of the University nor the names of its contributors
  16  *    may be used to endorse or promote products derived from this software
  17  *    without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  *
  31  *      @(#)if.h        8.1 (Berkeley) 6/10/93
  32  * $FreeBSD$
  33  */
  34
  35 #ifndef _NET_IF_H_
  36 #define _NET_IF_H_
  37
  38 #include <sys/cdefs.h>
  39
  40 #if __BSD_VISIBLE
  41 /*
  42  * <net/if.h> does not depend on <sys/time.h> on most other systems.  This
  43  * helps userland compatibility.  (struct timeval ifi_lastchange)
  44  * The same holds for <sys/socket.h>.  (struct sockaddr ifru_addr)
  45  */
  46 #ifndef _KERNEL
  47 #include <sys/time.h>
  48 #include <sys/socket.h>
  49 #endif
  50 #endif
  51
  52 /*
  53  * Length of interface external name, including terminating '\0'.
  54  * Note: this is the same size as a generic device's external name.
  55  */
  56 #define         IF_NAMESIZE     16
  57 #if __BSD_VISIBLE
  58 #define         IFNAMSIZ        IF_NAMESIZE
  59 #define         IF_MAXUNIT      0x7fff  /* historical value */
  60 #endif
  61 #if __BSD_VISIBLE
  62
  63 /*
  64  * Structure used to query names of interface cloners.
  65  */
  66
  67 struct if_clonereq {
  68         int     ifcr_total;             /* total cloners (out) */
  69         int     ifcr_count;             /* room for this many in user buffer */
  70         char    *ifcr_buffer;           /* buffer for cloner names */
  71 };
  72
  73 /*
  74  * Structure describing information about an interface
  75  * which may be of interest to management entities.
  76  */
  77 struct if_data {
  78         /* generic interface information */
  79         uint8_t ifi_type;               /* ethernet, tokenring, etc */
  80         uint8_t ifi_physical;           /* e.g., AUI, Thinnet, 10base-T, etc */
  81         uint8_t ifi_addrlen;            /* media address length */
  82         uint8_t ifi_hdrlen;             /* media header length */
  83         uint8_t ifi_link_state;         /* current link state */
  84         uint8_t ifi_vhid;               /* carp vhid */
  85         uint16_t        ifi_datalen;    /* length of this data struct */
  86         uint32_t        ifi_mtu;        /* maximum transmission unit */
  87         uint32_t        ifi_metric;     /* routing metric (external only) */
  88         uint64_t        ifi_baudrate;   /* linespeed */
  89         /* volatile statistics */
  90         uint64_t        ifi_ipackets;   /* packets received on interface */
  91         uint64_t        ifi_ierrors;    /* input errors on interface */
  92         uint64_t        ifi_opackets;   /* packets sent on interface */
  93         uint64_t        ifi_oerrors;    /* output errors on interface */
  94         uint64_t        ifi_collisions; /* collisions on csma interfaces */
  95         uint64_t        ifi_ibytes;     /* total number of octets received */
  96         uint64_t        ifi_obytes;     /* total number of octets sent */
  97         uint64_t        ifi_imcasts;    /* packets received via multicast */
  98         uint64_t        ifi_omcasts;    /* packets sent via multicast */
  99         uint64_t        ifi_iqdrops;    /* dropped on input */
 100         uint64_t        ifi_oqdrops;    /* dropped on output */
 101         uint64_t        ifi_noproto;    /* destined for unsupported protocol */
 102         uint64_t        ifi_hwassist;   /* HW offload capabilities, see IFCAP */
 103
 104         /* Unions are here to make sizes MI. */
 105         union {                         /* uptime at attach or stat reset */
 106                 time_t          tt;
 107                 uint64_t        ph;
 108         } __ifi_epoch;
 109 #define ifi_epoch       __ifi_epoch.tt
 110         union {                         /* time of last administrative change */
 111                 struct timeval  tv;
 112                 struct {
 113                         uint64_t ph1;
 114                         uint64_t ph2;
 115                 } ph;
 116         } __ifi_lastchange;
 117 #define ifi_lastchange  __ifi_lastchange.tv
 118 };
 119
 120 /*-
 121  * Interface flags are of two types: network stack owned flags, and driver
 122  * owned flags.  Historically, these values were stored in the same ifnet
 123  * flags field, but with the advent of fine-grained locking, they have been
 124  * broken out such that the network stack is responsible for synchronizing
 125  * the stack-owned fields, and the device driver the device-owned fields.
 126  * Both halves can perform lockless reads of the other half's field, subject
 127  * to accepting the involved races.
 128  *
 129  * Both sets of flags come from the same number space, and should not be
 130  * permitted to conflict, as they are exposed to user space via a single
 131  * field.
 132  *
 133  * The following symbols identify read and write requirements for fields:
 134  *
 135  * (i) if_flags field set by device driver before attach, read-only there
 136  *     after.
 137  * (n) if_flags field written only by the network stack, read by either the
 138  *     stack or driver.
 139  * (d) if_drv_flags field written only by the device driver, read by either
 140  *     the stack or driver.
 141  */
 142 #define IFF_UP          0x1             /* (n) interface is up */
 143 #define IFF_BROADCAST   0x2             /* (i) broadcast address valid */
 144 #define IFF_DEBUG       0x4             /* (n) turn on debugging */
 145 #define IFF_LOOPBACK    0x8             /* (i) is a loopback net */
 146 #define IFF_POINTOPOINT 0x10            /* (i) is a point-to-point link */
 147 #define IFF_NEEDSEPOCH  0x20            /* (i) calls if_input w/o net epoch */
 148 #define IFF_DRV_RUNNING 0x40            /* (d) resources allocated */
 149 #define IFF_NOARP       0x80            /* (n) no address resolution protocol */
 150 #define IFF_PROMISC     0x100           /* (n) receive all packets */
 151 #define IFF_ALLMULTI    0x200           /* (n) receive all multicast packets */
 152 #define IFF_DRV_OACTIVE 0x400           /* (d) tx hardware queue is full */
 153 #define IFF_SIMPLEX     0x800           /* (i) can't hear own transmissions */
 154 #define IFF_LINK0       0x1000          /* per link layer defined bit */
 155 #define IFF_LINK1       0x2000          /* per link layer defined bit */
 156 #define IFF_LINK2       0x4000          /* per link layer defined bit */
 157 #define IFF_ALTPHYS     IFF_LINK2       /* use alternate physical connection */
 158 #define IFF_MULTICAST   0x8000          /* (i) supports multicast */
 159 #define IFF_CANTCONFIG  0x10000         /* (i) unconfigurable using ioctl(2) */
 160 #define IFF_PPROMISC    0x20000         /* (n) user-requested promisc mode */
 161 #define IFF_MONITOR     0x40000         /* (n) user-requested monitor mode */
 162 #define IFF_STATICARP   0x80000         /* (n) static ARP */
 163 #define IFF_STICKYARP   0x100000        /* (n) sticky ARP */
 164 #define IFF_DYING       0x200000        /* (n) interface is winding down */
 165 #define IFF_RENAMING    0x400000        /* (n) interface is being renamed */
 166 #define IFF_SPARE       0x800000
 167 #define IFF_NETLINK_1   0x1000000       /* (n) used by netlink */
 168
 169 /*
 170  * Old names for driver flags so that user space tools can continue to use
 171  * the old (portable) names.
 172  */
 173 #ifndef _KERNEL
 174 #define IFF_RUNNING     IFF_DRV_RUNNING
 175 #define IFF_OACTIVE     IFF_DRV_OACTIVE
 176 #endif
 177
 178 /* flags set internally only: */
 179 #define IFF_CANTCHANGE \
 180         (IFF_BROADCAST|IFF_POINTOPOINT|IFF_DRV_RUNNING|IFF_DRV_OACTIVE|\
 181             IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI|IFF_PROMISC|\
 182             IFF_DYING|IFF_CANTCONFIG|IFF_NEEDSEPOCH)
 183
 184 /*
 185  * Values for if_link_state.
 186  */
 187 #define LINK_STATE_UNKNOWN      0       /* link invalid/unknown */
 188 #define LINK_STATE_DOWN         1       /* link is down */
 189 #define LINK_STATE_UP           2       /* link is up */
 190
 191 /*
 192  * Some convenience macros used for setting ifi_baudrate.
 193  * XXX 1000 vs. 1024? --thorpej@netbsd.org
 194  */
 195 #define IF_Kbps(x)      ((uintmax_t)(x) * 1000) /* kilobits/sec. */
 196 #define IF_Mbps(x)      (IF_Kbps((x) * 1000))   /* megabits/sec. */
 197 #define IF_Gbps(x)      (IF_Mbps((x) * 1000))   /* gigabits/sec. */
 198
 199 /*
 200  * Capabilities that interfaces can advertise.
 201  *
 202  * struct ifnet.if_capabilities
 203  *   contains the optional features & capabilities a particular interface
 204  *   supports (not only the driver but also the detected hw revision).
 205  *   Capabilities are defined by IFCAP_* below.
 206  * struct ifnet.if_capenable
 207  *   contains the enabled (either by default or through ifconfig) optional
 208  *   features & capabilities on this interface.
 209  *   Capabilities are defined by IFCAP_* below.
 210  * struct if_data.ifi_hwassist in mbuf CSUM_ flag form, controlled by above
 211  *   contains the enabled optional feature & capabilites that can be used
 212  *   individually per packet and are specified in the mbuf pkthdr.csum_flags
 213  *   field.  IFCAP_* and CSUM_* do not match one to one and CSUM_* may be
 214  *   more detailed or differentiated than IFCAP_*.
 215  *   Hwassist features are defined CSUM_* in sys/mbuf.h
 216  *
 217  * Capabilities that cannot be arbitrarily changed with ifconfig/ioctl
 218  * are listed in IFCAP_CANTCHANGE, similar to IFF_CANTCHANGE.
 219  * This is not strictly necessary because the common code never
 220  * changes capabilities, and it is left to the individual driver
 221  * to do the right thing. However, having the filter here
 222  * avoids replication of the same code in all individual drivers.
 223  */
 224
 225 /* IFCAP values as bit indexes */
 226
 227 #define IFCAP_B_RXCSUM          0 /* can offload checksum on RX */
 228 #define IFCAP_B_TXCSUM          1 /* can offload checksum on TX */
 229 #define IFCAP_B_NETCONS         2 /* can be a network console */
 230 #define IFCAP_B_VLAN_MTU        3 /* VLAN-compatible MTU */
 231 #define IFCAP_B_VLAN_HWTAGGING  4 /* hardware VLAN tag support */
 232 #define IFCAP_B_JUMBO_MTU       5 /* 9000 byte MTU supported */
 233 #define IFCAP_B_POLLING         6 /* driver supports polling */
 234 #define IFCAP_B_VLAN_HWCSUM     7 /* can do IFCAP_HWCSUM on VLANs */
 235 #define IFCAP_B_TSO4            8 /* can do TCP Segmentation Offload */
 236 #define IFCAP_B_TSO6            9 /* can do TCP6 Segmentation Offload */
 237 #define IFCAP_B_LRO             10 /* can do Large Receive Offload */
 238 #define IFCAP_B_WOL_UCAST       11 /* wake on any unicast frame */
 239 #define IFCAP_B_WOL_MCAST       12 /* wake on any multicast frame */
 240 #define IFCAP_B_WOL_MAGIC       13 /* wake on any Magic Packet */
 241 #define IFCAP_B_TOE4            14 /* interface can offload TCP */
 242 #define IFCAP_B_TOE6            15 /* interface can offload TCP6 */
 243 #define IFCAP_B_VLAN_HWFILTER   16 /* interface hw can filter vlan tag */
 244 #define IFCAP_B_NV              17 /* can do SIOCGIFCAPNV/SIOCSIFCAPNV */
 245 #define IFCAP_B_VLAN_HWTSO      18 /* can do IFCAP_TSO on VLANs */
 246 #define IFCAP_B_LINKSTATE       19 /* the runtime link state is dynamic */
 247 #define IFCAP_B_NETMAP          20 /* netmap mode supported/enabled */
 248 #define IFCAP_B_RXCSUM_IPV6     21 /* can offload checksum on IPv6 RX */
 249 #define IFCAP_B_TXCSUM_IPV6     22 /* can offload checksum on IPv6 TX */
 250 #define IFCAP_B_HWSTATS         23 /* manages counters internally */
 251 #define IFCAP_B_TXRTLMT         24 /* hardware supports TX rate limiting */
 252 #define IFCAP_B_HWRXTSTMP       25 /* hardware rx timestamping */
 253 #define IFCAP_B_MEXTPG          26 /* understands M_EXTPG mbufs */
 254 #define IFCAP_B_TXTLS4          27 /* can do TLS encryption and segmentation for TCP */
 255 #define IFCAP_B_TXTLS6          28 /* can do TLS encryption and segmentation for TCP6 */
 256 #define IFCAP_B_VXLAN_HWCSUM    29 /* can do IFCAN_HWCSUM on VXLANs */
 257 #define IFCAP_B_VXLAN_HWTSO     30 /* can do IFCAP_TSO on VXLANs */
 258 #define IFCAP_B_TXTLS_RTLMT     31 /* can do TLS with rate limiting */
 259 #define IFCAP_B_RXTLS4          32 /* can to TLS receive for TCP */
 260 #define IFCAP_B_RXTLS6          33 /* can to TLS receive for TCP6 */
 261 #define __IFCAP_B_SIZE          34
 262
 263 #define IFCAP_B_MAX     (__IFCAP_B_MAX - 1)
 264 #define IFCAP_B_SIZE    (__IFCAP_B_SIZE)
 265
 266 #define IFCAP_BIT(x)            (1 << (x))
 267
 268 #define IFCAP_RXCSUM            IFCAP_BIT(IFCAP_B_RXCSUM)
 269 #define IFCAP_TXCSUM            IFCAP_BIT(IFCAP_B_TXCSUM)
 270 #define IFCAP_NETCONS           IFCAP_BIT(IFCAP_B_NETCONS)
 271 #define IFCAP_VLAN_MTU          IFCAP_BIT(IFCAP_B_VLAN_MTU)
 272 #define IFCAP_VLAN_HWTAGGING    IFCAP_BIT(IFCAP_B_VLAN_HWTAGGING)
 273 #define IFCAP_JUMBO_MTU         IFCAP_BIT(IFCAP_B_JUMBO_MTU)
 274 #define IFCAP_POLLING           IFCAP_BIT(IFCAP_B_POLLING)
 275 #define IFCAP_VLAN_HWCSUM       IFCAP_BIT(IFCAP_B_VLAN_HWCSUM)
 276 #define IFCAP_TSO4              IFCAP_BIT(IFCAP_B_TSO4)
 277 #define IFCAP_TSO6              IFCAP_BIT(IFCAP_B_TSO6)
 278 #define IFCAP_LRO               IFCAP_BIT(IFCAP_B_LRO)
 279 #define IFCAP_WOL_UCAST         IFCAP_BIT(IFCAP_B_WOL_UCAST)
 280 #define IFCAP_WOL_MCAST         IFCAP_BIT(IFCAP_B_WOL_MCAST)
 281 #define IFCAP_WOL_MAGIC         IFCAP_BIT(IFCAP_B_WOL_MAGIC)
 282 #define IFCAP_TOE4              IFCAP_BIT(IFCAP_B_TOE4)
 283 #define IFCAP_TOE6              IFCAP_BIT(IFCAP_B_TOE6)
 284 #define IFCAP_VLAN_HWFILTER     IFCAP_BIT(IFCAP_B_VLAN_HWFILTER)
 285 #define IFCAP_NV                IFCAP_BIT(IFCAP_B_NV)
 286 #define IFCAP_VLAN_HWTSO        IFCAP_BIT(IFCAP_B_VLAN_HWTSO)
 287 #define IFCAP_LINKSTATE         IFCAP_BIT(IFCAP_B_LINKSTATE)
 288 #define IFCAP_NETMAP            IFCAP_BIT(IFCAP_B_NETMAP)
 289 #define IFCAP_RXCSUM_IPV6       IFCAP_BIT(IFCAP_B_RXCSUM_IPV6)
 290 #define IFCAP_TXCSUM_IPV6       IFCAP_BIT(IFCAP_B_TXCSUM_IPV6)
 291 #define IFCAP_HWSTATS           IFCAP_BIT(IFCAP_B_HWSTATS)
 292 #define IFCAP_TXRTLMT           IFCAP_BIT(IFCAP_B_TXRTLMT)
 293 #define IFCAP_HWRXTSTMP         IFCAP_BIT(IFCAP_B_HWRXTSTMP)
 294 #define IFCAP_MEXTPG            IFCAP_BIT(IFCAP_B_MEXTPG)
 295 #define IFCAP_TXTLS4            IFCAP_BIT(IFCAP_B_TXTLS4)
 296 #define IFCAP_TXTLS6            IFCAP_BIT(IFCAP_B_TXTLS6)
 297 #define IFCAP_VXLAN_HWCSUM      IFCAP_BIT(IFCAP_B_VXLAN_HWCSUM)
 298 #define IFCAP_VXLAN_HWTSO       IFCAP_BIT(IFCAP_B_VXLAN_HWTSO)
 299 #define IFCAP_TXTLS_RTLMT       IFCAP_BIT(IFCAP_B_TXTLS_RTLMT)
 300
 301 /* IFCAP2_* are integers, not bits. */
 302 #define IFCAP2_RXTLS4           (IFCAP_B_RXTLS4 - 32)
 303 #define IFCAP2_RXTLS6           (IFCAP_B_RXTLS6 - 32)
 304
 305 #define IFCAP2_BIT(x)           (1UL << (x))
 306
 307 #define IFCAP_HWCSUM_IPV6       (IFCAP_RXCSUM_IPV6 | IFCAP_TXCSUM_IPV6)
 308
 309 #define IFCAP_HWCSUM    (IFCAP_RXCSUM | IFCAP_TXCSUM)
 310 #define IFCAP_TSO       (IFCAP_TSO4 | IFCAP_TSO6)
 311 #define IFCAP_WOL       (IFCAP_WOL_UCAST | IFCAP_WOL_MCAST | IFCAP_WOL_MAGIC)
 312 #define IFCAP_TOE       (IFCAP_TOE4 | IFCAP_TOE6)
 313 #define IFCAP_TXTLS     (IFCAP_TXTLS4 | IFCAP_TXTLS6)
 314
 315 #define IFCAP_CANTCHANGE        (IFCAP_NETMAP | IFCAP_NV)
 316 #define IFCAP_ALLCAPS           0xffffffff
 317
 318 #define IFQ_MAXLEN      50
 319 #define IFNET_SLOWHZ    1               /* granularity is 1 second */
 320
 321 /*
 322  * Message format for use in obtaining information about interfaces
 323  * from getkerninfo and the routing socket
 324  * For the new, extensible interface see struct if_msghdrl below.
 325  */
 326 struct if_msghdr {
 327         u_short ifm_msglen;     /* to skip over non-understood messages */
 328         u_char  ifm_version;    /* future binary compatibility */
 329         u_char  ifm_type;       /* message type */
 330         int     ifm_addrs;      /* like rtm_addrs */
 331         int     ifm_flags;      /* value of if_flags */
 332         u_short ifm_index;      /* index for associated ifp */
 333         u_short _ifm_spare1;
 334         struct  if_data ifm_data;/* statistics and other data about if */
 335 };
 336
 337 /*
 338  * The 'l' version shall be used by new interfaces, like NET_RT_IFLISTL.  It is
 339  * extensible after ifm_data_off or within ifm_data.  Both the if_msghdr and
 340  * if_data now have a member field detailing the struct length in addition to
 341  * the routing message length.  Macros are provided to find the start of
 342  * ifm_data and the start of the socket address strucutres immediately following
 343  * struct if_msghdrl given a pointer to struct if_msghdrl.
 344  */
 345 #define IF_MSGHDRL_IFM_DATA(_l) \
 346     (struct if_data *)((char *)(_l) + (_l)->ifm_data_off)
 347 #define IF_MSGHDRL_RTA(_l) \
 348     (void *)((uintptr_t)(_l) + (_l)->ifm_len)
 349 struct if_msghdrl {
 350         u_short ifm_msglen;     /* to skip over non-understood messages */
 351         u_char  ifm_version;    /* future binary compatibility */
 352         u_char  ifm_type;       /* message type */
 353         int     ifm_addrs;      /* like rtm_addrs */
 354         int     ifm_flags;      /* value of if_flags */
 355         u_short ifm_index;      /* index for associated ifp */
 356         u_short _ifm_spare1;    /* spare space to grow if_index, see if_var.h */
 357         u_short ifm_len;        /* length of if_msghdrl incl. if_data */
 358         u_short ifm_data_off;   /* offset of if_data from beginning */
 359         int     _ifm_spare2;
 360         struct  if_data ifm_data;/* statistics and other data about if */
 361 };
 362
 363 /*
 364  * Message format for use in obtaining information about interface addresses
 365  * from getkerninfo and the routing socket
 366  * For the new, extensible interface see struct ifa_msghdrl below.
 367  */
 368 struct ifa_msghdr {
 369         u_short ifam_msglen;    /* to skip over non-understood messages */
 370         u_char  ifam_version;   /* future binary compatibility */
 371         u_char  ifam_type;      /* message type */
 372         int     ifam_addrs;     /* like rtm_addrs */
 373         int     ifam_flags;     /* value of ifa_flags */
 374         u_short ifam_index;     /* index for associated ifp */
 375         u_short _ifam_spare1;
 376         int     ifam_metric;    /* value of ifa_ifp->if_metric */
 377 };
 378
 379 /*
 380  * The 'l' version shall be used by new interfaces, like NET_RT_IFLISTL.  It is
 381  * extensible after ifam_metric or within ifam_data.  Both the ifa_msghdrl and
 382  * if_data now have a member field detailing the struct length in addition to
 383  * the routing message length.  Macros are provided to find the start of
 384  * ifm_data and the start of the socket address strucutres immediately following
 385  * struct ifa_msghdrl given a pointer to struct ifa_msghdrl.
 386  */
 387 #define IFA_MSGHDRL_IFAM_DATA(_l) \
 388     (struct if_data *)((char *)(_l) + (_l)->ifam_data_off)
 389 #define IFA_MSGHDRL_RTA(_l) \
 390     (void *)((uintptr_t)(_l) + (_l)->ifam_len)
 391 struct ifa_msghdrl {
 392         u_short ifam_msglen;    /* to skip over non-understood messages */
 393         u_char  ifam_version;   /* future binary compatibility */
 394         u_char  ifam_type;      /* message type */
 395         int     ifam_addrs;     /* like rtm_addrs */
 396         int     ifam_flags;     /* value of ifa_flags */
 397         u_short ifam_index;     /* index for associated ifp */
 398         u_short _ifam_spare1;   /* spare space to grow if_index, see if_var.h */
 399         u_short ifam_len;       /* length of ifa_msghdrl incl. if_data */
 400         u_short ifam_data_off;  /* offset of if_data from beginning */
 401         int     ifam_metric;    /* value of ifa_ifp->if_metric */
 402         struct  if_data ifam_data;/* statistics and other data about if or
 403                                  * address */
 404 };
 405
 406 /*
 407  * Message format for use in obtaining information about multicast addresses
 408  * from the routing socket
 409  */
 410 struct ifma_msghdr {
 411         u_short ifmam_msglen;   /* to skip over non-understood messages */
 412         u_char  ifmam_version;  /* future binary compatibility */
 413         u_char  ifmam_type;     /* message type */
 414         int     ifmam_addrs;    /* like rtm_addrs */
 415         int     ifmam_flags;    /* value of ifa_flags */
 416         u_short ifmam_index;    /* index for associated ifp */
 417         u_short _ifmam_spare1;
 418 };
 419
 420 /*
 421  * Message format announcing the arrival or departure of a network interface.
 422  */
 423 struct if_announcemsghdr {
 424         u_short ifan_msglen;    /* to skip over non-understood messages */
 425         u_char  ifan_version;   /* future binary compatibility */
 426         u_char  ifan_type;      /* message type */
 427         u_short ifan_index;     /* index for associated ifp */
 428         char    ifan_name[IFNAMSIZ]; /* if name, e.g. "en0" */
 429         u_short ifan_what;      /* what type of announcement */
 430 };
 431
 432 #define IFAN_ARRIVAL    0       /* interface arrival */
 433 #define IFAN_DEPARTURE  1       /* interface departure */
 434
 435 /*
 436  * Buffer with length to be used in SIOCGIFDESCR/SIOCSIFDESCR requests
 437  */
 438 struct ifreq_buffer {
 439         size_t  length;
 440         void    *buffer;
 441 };
 442
 443 struct ifreq_nv_req {
 444         u_int   buf_length;     /* Total size of buffer,
 445                                    u_int for ABI struct ifreq */
 446         u_int   length;         /* Length of the filled part */
 447         void    *buffer;        /* Buffer itself, containing packed nv */
 448 };
 449
 450 #define IFR_CAP_NV_MAXBUFSIZE   (2 * 1024 * 1024)
 451
 452 /*
 453  * Interface request structure used for socket
 454  * ioctl's.  All interface ioctl's must have parameter
 455  * definitions which begin with ifr_name.  The
 456  * remainder may be interface specific.
 457  */
 458 struct ifreq {
 459         char    ifr_name[IFNAMSIZ];             /* if name, e.g. "en0" */
 460         union {
 461                 struct  sockaddr ifru_addr;
 462                 struct  sockaddr ifru_dstaddr;
 463                 struct  sockaddr ifru_broadaddr;
 464                 struct  ifreq_buffer ifru_buffer;
 465                 short   ifru_flags[2];
 466                 short   ifru_index;
 467                 int     ifru_jid;
 468                 int     ifru_metric;
 469                 int     ifru_mtu;
 470                 int     ifru_phys;
 471                 int     ifru_media;
 472                 caddr_t ifru_data;
 473                 int     ifru_cap[2];
 474                 u_int   ifru_fib;
 475                 u_char  ifru_vlan_pcp;
 476                 struct  ifreq_nv_req ifru_nv;
 477         } ifr_ifru;
 478 #define ifr_addr        ifr_ifru.ifru_addr      /* address */
 479 #define ifr_dstaddr     ifr_ifru.ifru_dstaddr   /* other end of p-to-p link */
 480 #define ifr_broadaddr   ifr_ifru.ifru_broadaddr /* broadcast address */
 481 #ifndef _KERNEL
 482 #define ifr_buffer      ifr_ifru.ifru_buffer    /* user supplied buffer with its length */
 483 #endif
 484 #define ifr_flags       ifr_ifru.ifru_flags[0]  /* flags (low 16 bits) */
 485 #define ifr_flagshigh   ifr_ifru.ifru_flags[1]  /* flags (high 16 bits) */
 486 #define ifr_jid         ifr_ifru.ifru_jid       /* jail/vnet */
 487 #define ifr_metric      ifr_ifru.ifru_metric    /* metric */
 488 #define ifr_mtu         ifr_ifru.ifru_mtu       /* mtu */
 489 #define ifr_phys        ifr_ifru.ifru_phys      /* physical wire */
 490 #define ifr_media       ifr_ifru.ifru_media     /* physical media */
 491 #ifndef _KERNEL
 492 #define ifr_data        ifr_ifru.ifru_data      /* for use by interface */
 493 #endif
 494 #define ifr_reqcap      ifr_ifru.ifru_cap[0]    /* requested capabilities */
 495 #define ifr_curcap      ifr_ifru.ifru_cap[1]    /* current capabilities */
 496 #define ifr_index       ifr_ifru.ifru_index     /* interface index */
 497 #define ifr_fib         ifr_ifru.ifru_fib       /* interface fib */
 498 #define ifr_vlan_pcp    ifr_ifru.ifru_vlan_pcp  /* VLAN priority */
 499 #define ifr_lan_pcp     ifr_ifru.ifru_vlan_pcp  /* VLAN priority */
 500 #define ifr_cap_nv      ifr_ifru.ifru_nv        /* nv-based cap interface */
 501 };
 502
 503 #define _SIZEOF_ADDR_IFREQ(ifr) \
 504         ((ifr).ifr_addr.sa_len > sizeof(struct sockaddr) ? \
 505          (sizeof(struct ifreq) - sizeof(struct sockaddr) + \
 506           (ifr).ifr_addr.sa_len) : sizeof(struct ifreq))
 507
 508 struct ifaliasreq {
 509         char    ifra_name[IFNAMSIZ];            /* if name, e.g. "en0" */
 510         struct  sockaddr ifra_addr;
 511         struct  sockaddr ifra_broadaddr;
 512         struct  sockaddr ifra_mask;
 513         int     ifra_vhid;
 514 };
 515
 516 /* 9.x compat */
 517 struct oifaliasreq {
 518         char    ifra_name[IFNAMSIZ];
 519         struct  sockaddr ifra_addr;
 520         struct  sockaddr ifra_broadaddr;
 521         struct  sockaddr ifra_mask;
 522 };
 523
 524 struct ifmediareq {
 525         char    ifm_name[IFNAMSIZ];     /* if name, e.g. "en0" */
 526         int     ifm_current;            /* current media options */
 527         int     ifm_mask;               /* don't care mask */
 528         int     ifm_status;             /* media status */
 529         int     ifm_active;             /* active options */
 530         int     ifm_count;              /* # entries in ifm_ulist array */
 531         int     *ifm_ulist;             /* media words */
 532 };
 533
 534 struct ifdrv {
 535         char            ifd_name[IFNAMSIZ];     /* if name, e.g. "en0" */
 536         unsigned long   ifd_cmd;
 537         size_t          ifd_len;
 538         void            *ifd_data;
 539 };
 540
 541 /*
 542  * Structure used to retrieve aux status data from interfaces.
 543  * Kernel suppliers to this interface should respect the formatting
 544  * needed by ifconfig(8): each line starts with a TAB and ends with
 545  * a newline.  The canonical example to copy and paste is in if_tun.c.
 546  */
 547
 548 #define IFSTATMAX       800             /* 10 lines of text */
 549 struct ifstat {
 550         char    ifs_name[IFNAMSIZ];     /* if name, e.g. "en0" */
 551         char    ascii[IFSTATMAX + 1];
 552 };
 553
 554 /*
 555  * Structure used in SIOCGIFCONF request.
 556  * Used to retrieve interface configuration
 557  * for machine (useful for programs which
 558  * must know all networks accessible).
 559  */
 560 struct ifconf {
 561         int     ifc_len;                /* size of associated buffer */
 562         union {
 563                 caddr_t ifcu_buf;
 564                 struct  ifreq *ifcu_req;
 565         } ifc_ifcu;
 566 #define ifc_buf ifc_ifcu.ifcu_buf       /* buffer address */
 567 #define ifc_req ifc_ifcu.ifcu_req       /* array of structures returned */
 568 };
 569
 570 /*
 571  * interface groups
 572  */
 573
 574 #define IFG_ALL         "all"           /* group contains all interfaces */
 575 /* XXX: will we implement this? */
 576 #define IFG_EGRESS      "egress"        /* if(s) default route(s) point to */
 577
 578 struct ifg_req {
 579         union {
 580                 char                     ifgrqu_group[IFNAMSIZ];
 581                 char                     ifgrqu_member[IFNAMSIZ];
 582         } ifgrq_ifgrqu;
 583 #define ifgrq_group     ifgrq_ifgrqu.ifgrqu_group
 584 #define ifgrq_member    ifgrq_ifgrqu.ifgrqu_member
 585 };
 586
 587 /*
 588  * Used to lookup groups for an interface
 589  */
 590 struct ifgroupreq {
 591         char    ifgr_name[IFNAMSIZ];
 592         u_int   ifgr_len;
 593         union {
 594                 char    ifgru_group[IFNAMSIZ];
 595                 struct  ifg_req *ifgru_groups;
 596         } ifgr_ifgru;
 597 #define ifgr_group      ifgr_ifgru.ifgru_group
 598 #define ifgr_groups     ifgr_ifgru.ifgru_groups
 599 };
 600
 601 /*
 602  * Structure used to request i2c data
 603  * from interface transceivers.
 604  */
 605 struct ifi2creq {
 606         uint8_t dev_addr;       /* i2c address (0xA0, 0xA2) */
 607         uint8_t offset;         /* read offset */
 608         uint8_t len;            /* read length */
 609         uint8_t spare0;
 610         uint32_t spare1;
 611         uint8_t data[8];        /* read buffer */
 612 };
 613
 614 /*
 615  * RSS hash.
 616  */
 617
 618 #define RSS_FUNC_NONE           0               /* RSS disabled */
 619 #define RSS_FUNC_PRIVATE        1               /* non-standard */
 620 #define RSS_FUNC_TOEPLITZ       2
 621
 622 #define RSS_TYPE_IPV4           0x00000001
 623 #define RSS_TYPE_TCP_IPV4       0x00000002
 624 #define RSS_TYPE_IPV6           0x00000004
 625 #define RSS_TYPE_IPV6_EX        0x00000008
 626 #define RSS_TYPE_TCP_IPV6       0x00000010
 627 #define RSS_TYPE_TCP_IPV6_EX    0x00000020
 628 #define RSS_TYPE_UDP_IPV4       0x00000040
 629 #define RSS_TYPE_UDP_IPV6       0x00000080
 630 #define RSS_TYPE_UDP_IPV6_EX    0x00000100
 631
 632 #define RSS_KEYLEN              128
 633
 634 struct ifrsskey {
 635         char            ifrk_name[IFNAMSIZ];    /* if name, e.g. "en0" */
 636         uint8_t         ifrk_func;              /* RSS_FUNC_ */
 637         uint8_t         ifrk_spare0;
 638         uint16_t        ifrk_keylen;
 639         uint8_t         ifrk_key[RSS_KEYLEN];
 640 };
 641
 642 struct ifrsshash {
 643         char            ifrh_name[IFNAMSIZ];    /* if name, e.g. "en0" */
 644         uint8_t         ifrh_func;              /* RSS_FUNC_ */
 645         uint8_t         ifrh_spare0;
 646         uint16_t        ifrh_spare1;
 647         uint32_t        ifrh_types;             /* RSS_TYPE_ */
 648 };
 649
 650 #define IFNET_PCP_NONE  0xff    /* PCP disabled */
 651
 652 #define IFDR_MSG_SIZE           64
 653 #define IFDR_REASON_MSG         1
 654 #define IFDR_REASON_VENDOR      2
 655 struct ifdownreason {
 656         char            ifdr_name[IFNAMSIZ];
 657         uint32_t        ifdr_reason;
 658         uint32_t        ifdr_vendor;
 659         char            ifdr_msg[IFDR_MSG_SIZE];
 660 };
 661
 662 #endif /* __BSD_VISIBLE */
 663
 664 /*
 665  * Opaque interface structure.
 666  */
 667
 668 typedef struct ifnet *if_t;
 669
 670 #ifdef _KERNEL
 671 #ifdef MALLOC_DECLARE
 672 MALLOC_DECLARE(M_IFADDR);
 673 MALLOC_DECLARE(M_IFMADDR);
 674 #endif
 675
 676 extern struct sx ifnet_detach_sxlock;
 677
 678 struct nvlist;
 679 struct ifcap_nv_bit_name;
 680 int if_capnv_to_capint(const struct nvlist *nv, int *old_cap,
 681     const struct ifcap_nv_bit_name *nn, bool all);
 682 void if_capint_to_capnv(struct nvlist *nv,
 683     const struct ifcap_nv_bit_name *nn, int ifr_cap, int ifr_req);
 684 struct siocsifcapnv_driver_data {
 685         int reqcap;
 686         int reqcap2;
 687         struct nvlist *nvcap;
 688 };
 689 #endif
 690
 691 #ifndef _KERNEL
 692 struct if_nameindex {
 693         unsigned int    if_index;       /* 1, 2, ... */
 694         char            *if_name;       /* null terminated name: "le0", ... */
 695 };
 696
 697 __BEGIN_DECLS
 698 void                     if_freenameindex(struct if_nameindex *);
 699 char                    *if_indextoname(unsigned int, char *);
 700 struct if_nameindex     *if_nameindex(void);
 701 unsigned int             if_nametoindex(const char *);
 702 __END_DECLS
 703 #endif
 704 #endif /* !_NET_IF_H_ */