bsd/net/if.h

   1 /*
   2  * Copyright (c) 2000-2016 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /*
  29  * Copyright (c) 1982, 1986, 1989, 1993
  30  *      The Regents of the University of California.  All rights reserved.
  31  *
  32  * Redistribution and use in source and binary forms, with or without
  33  * modification, are permitted provided that the following conditions
  34  * are met:
  35  * 1. Redistributions of source code must retain the above copyright
  36  *    notice, this list of conditions and the following disclaimer.
  37  * 2. Redistributions in binary form must reproduce the above copyright
  38  *    notice, this list of conditions and the following disclaimer in the
  39  *    documentation and/or other materials provided with the distribution.
  40  * 3. All advertising materials mentioning features or use of this software
  41  *    must display the following acknowledgement:
  42  *      This product includes software developed by the University of
  43  *      California, Berkeley and its contributors.
  44  * 4. Neither the name of the University nor the names of its contributors
  45  *    may be used to endorse or promote products derived from this software
  46  *    without specific prior written permission.
  47  *
  48  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  49  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  50  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  51  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  52  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  53  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  54  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  55  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  56  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  57  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  58  * SUCH DAMAGE.
  59  *
  60  *      @(#)if.h        8.1 (Berkeley) 6/10/93
  61  */
  62
  63 #ifndef _NET_IF_H_
  64 #define _NET_IF_H_
  65
  66 #include <sys/cdefs.h>
  67 #include <net/net_kev.h>
  68
  69 #define IF_NAMESIZE     16
  70
  71 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
  72 #include <sys/appleapiopts.h>
  73 #ifdef __APPLE__
  74
  75 #include <net/if_var.h>
  76 #include <sys/types.h>
  77 #include <sys/socket.h>
  78
  79 #ifdef PRIVATE
  80 #include <net/if_dl.h>
  81 #include <netinet/in.h>
  82 #include <mach/vm_types.h>
  83 #endif /* PRIVATE */
  84 #endif
  85
  86 struct if_clonereq {
  87         int     ifcr_total;             /* total cloners (out) */
  88         int     ifcr_count;             /* room for this many in user buffer */
  89         char    *ifcr_buffer;           /* buffer for cloner names */
  90 };
  91
  92 #ifdef KERNEL_PRIVATE
  93 #define IF_MAXUNIT      0x7fff  /* historical value */
  94
  95 struct if_clonereq64 {
  96         int     ifcr_total;             /* total cloners (out) */
  97         int     ifcr_count;             /* room for this many in user buffer */
  98         user64_addr_t ifcru_buffer      __attribute__((aligned(8)));
  99 };
 100
 101 struct if_clonereq32 {
 102         int     ifcr_total;             /* total cloners (out) */
 103         int     ifcr_count;             /* room for this many in user buffer */
 104         user32_addr_t ifcru_buffer;
 105 };
 106 #endif /* KERNEL_PRIVATE */
 107
 108 #define IFF_UP          0x1             /* interface is up */
 109 #define IFF_BROADCAST   0x2             /* broadcast address valid */
 110 #define IFF_DEBUG       0x4             /* turn on debugging */
 111 #define IFF_LOOPBACK    0x8             /* is a loopback net */
 112 #define IFF_POINTOPOINT 0x10            /* interface is point-to-point link */
 113 #define IFF_NOTRAILERS  0x20            /* obsolete: avoid use of trailers */
 114 #define IFF_RUNNING     0x40            /* resources allocated */
 115 #define IFF_NOARP       0x80            /* no address resolution protocol */
 116 #define IFF_PROMISC     0x100           /* receive all packets */
 117 #define IFF_ALLMULTI    0x200           /* receive all multicast packets */
 118 #define IFF_OACTIVE     0x400           /* transmission in progress */
 119 #define IFF_SIMPLEX     0x800           /* can't hear own transmissions */
 120 #define IFF_LINK0       0x1000          /* per link layer defined bit */
 121 #define IFF_LINK1       0x2000          /* per link layer defined bit */
 122 #define IFF_LINK2       0x4000          /* per link layer defined bit */
 123 #define IFF_ALTPHYS     IFF_LINK2       /* use alternate physical connection */
 124 #define IFF_MULTICAST   0x8000          /* supports multicast */
 125
 126 #ifdef PRIVATE
 127 /* extended flags definitions:  (all bits reserved for internal/future use) */
 128 #define IFEF_AUTOCONFIGURING    0x00000001      /* allow BOOTP/DHCP replies to enter */
 129 #define IFEF_ENQUEUE_MULTI      0x00000002      /* enqueue multiple packets at once */
 130 #define IFEF_DELAY_START        0x00000004      /* delay start callback */
 131 #define IFEF_PROBE_CONNECTIVITY 0x00000008      /* Probe connections going over this interface */
 132 #define IFEF_QOSMARKING_CAPABLE 0x00000010      /* XXX Obsolete, to be removed */
 133 #define IFEF_IPV6_DISABLED      0x00000020      /* coupled to ND6_IFF_IFDISABLED */
 134 #define IFEF_ACCEPT_RTADV       0x00000040      /* accepts IPv6 RA on the interface */
 135 #define IFEF_TXSTART            0x00000080      /* has start callback */
 136 #define IFEF_RXPOLL             0x00000100      /* supports opportunistic input poll */
 137 #define IFEF_VLAN               0x00000200      /* interface has one or more vlans */
 138 #define IFEF_BOND               0x00000400      /* interface is part of bond */
 139 #define IFEF_ARPLL              0x00000800      /* ARP for IPv4LL addresses */
 140 /* #define      IFEF_NOWINDOWSCALE      0x00001000 */   /* Don't scale TCP window on iface */
 141 /*
 142  * XXX IFEF_NOAUTOIPV6LL is deprecated and should be done away with.
 143  * Configd pretty much manages the interface configuration.
 144  * Rather than looking at the flag we check if a specific LLA
 145  * has to be configured or the IID has to be generated by kernel.
 146  */
 147 #define IFEF_NOAUTOIPV6LL       0x00002000      /* Need explicit IPv6 LL address */
 148 #define IFEF_EXPENSIVE          0x00004000      /* Data access has a cost */
 149 #define IFEF_IPV4_ROUTER        0x00008000      /* interior when in IPv4 router mode */
 150 #define IFEF_IPV6_ROUTER        0x00010000      /* interior when in IPv6 router mode */
 151 #define IFEF_LOCALNET_PRIVATE   0x00020000      /* local private network */
 152 #define IFEF_SERVICE_TRIGGERED  IFEF_LOCALNET_PRIVATE
 153 #define IFEF_IPV6_ND6ALT        0x00040000      /* alternative. KPI for ND6 */
 154 #define IFEF_RESTRICTED_RECV    0x00080000      /* interface restricts inbound pkts */
 155 #define IFEF_AWDL               0x00100000      /* Apple Wireless Direct Link */
 156 #define IFEF_NOACKPRI           0x00200000      /* No TCP ACK prioritization */
 157 #define IFEF_AWDL_RESTRICTED    0x00400000      /* Restricted AWDL mode */
 158 #define IFEF_2KCL               0x00800000      /* prefers 2K cluster (socket based tunnel) */
 159 #define IFEF_ECN_ENABLE         0x01000000      /* use ECN for TCP connections on the interface */
 160 #define IFEF_ECN_DISABLE        0x02000000      /* do not use ECN for TCP connections on the interface */
 161 #define IFEF_SKYWALK_NATIVE     0x04000000      /* Native Skywalk support */
 162 #define IFEF_3CA                0x08000000      /* Capable of 3CA */
 163 #define IFEF_SENDLIST           0x10000000      /* Supports tx packet lists */
 164 #define IFEF_DIRECTLINK         0x20000000      /* point-to-point topology */
 165 #define IFEF_QOSMARKING_ENABLED 0x40000000      /* OoS marking is enabled */
 166 #define IFEF_UPDOWNCHANGE       0x80000000      /* up/down state is changing */
 167
 168 #ifdef XNU_KERNEL_PRIVATE
 169 /*
 170  * Extra flags
 171  */
 172 #define IFXF_WAKE_ON_MAGIC_PACKET       0x00000001 /* wake on magic packet */
 173 #define IFXF_TIMESTAMP_ENABLED                  0x00000002 /* time stamping enabled */
 174
 175 /*
 176  * Current requirements for an AWDL interface.  Setting/clearing IFEF_AWDL
 177  * will also trigger the setting/clearing of the rest of the flags.  Once
 178  * IFEF_AWDL is set, the rest of flags cannot be cleared, by definition.
 179  */
 180 #define IFEF_AWDL_MASK \
 181         (IFEF_LOCALNET_PRIVATE | IFEF_IPV6_ND6ALT | IFEF_RESTRICTED_RECV | \
 182         IFEF_AWDL)
 183 #endif /* XNU_KERNEL_PRIVATE */
 184 #endif /* PRIVATE */
 185
 186 #ifdef KERNEL_PRIVATE
 187 /*
 188  * !!! NOTE !!!
 189  *
 190  * if_idle_flags definitions: (all bits are reserved for internal/future
 191  * use). Setting these flags MUST be done via the ifnet_set_idle_flags()
 192  * KPI due to the associated reference counting.  Clearing them may be done by
 193  * calling the KPI, otherwise implicitly at interface detach time.  Setting
 194  * the if_idle_flags field to a non-zero value will cause the networking
 195  * stack to aggressively purge expired objects (routes, etc.)
 196  */
 197 #define IFRF_IDLE_NOTIFY        0x1     /* Generate notifications on idle */
 198
 199 /* flags set internally only: */
 200 #define IFF_CANTCHANGE \
 201         (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\
 202             IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI)
 203 #endif /* KERNEL_PRIVATE */
 204
 205 /*
 206  * Capabilities that interfaces can advertise.
 207  *
 208  * struct ifnet.if_capabilities
 209  *   contains the optional features & capabilities a particular interface
 210  *   supports (not only the driver but also the detected hw revision).
 211  *   Capabilities are defined by IFCAP_* below.
 212  * struct ifnet.if_capenable
 213  *   contains the enabled (either by default or through ifconfig) optional
 214  *   features & capabilities on this interface.
 215  *   Capabilities are defined by IFCAP_* below.
 216  * struct if_data.ifi_hwassist in IFNET_* form, defined in net/kpi_interface.h,
 217  *   contains the enabled optional features & capabilites that can be used
 218  *   individually per packet and are specified in the mbuf pkthdr.csum_flags
 219  *   field.  IFCAP_* and IFNET_* do not match one to one and IFNET_* may be
 220  *   more detailed or differenciated than IFCAP_*.
 221  *   IFNET_* hwassist flags have corresponding CSUM_* in sys/mbuf.h
 222  */
 223 #define IFCAP_RXCSUM            0x00001 /* can offload checksum on RX */
 224 #define IFCAP_TXCSUM            0x00002 /* can offload checksum on TX */
 225 #define IFCAP_VLAN_MTU          0x00004 /* VLAN-compatible MTU */
 226 #define IFCAP_VLAN_HWTAGGING    0x00008 /* hardware VLAN tag support */
 227 #define IFCAP_JUMBO_MTU         0x00010 /* 9000 byte MTU supported */
 228 #define IFCAP_TSO4              0x00020 /* can do TCP Segmentation Offload */
 229 #define IFCAP_TSO6              0x00040 /* can do TCP6 Segmentation Offload */
 230 #define IFCAP_LRO               0x00080 /* can do Large Receive Offload */
 231 #define IFCAP_AV                0x00100 /* can do 802.1 AV Bridging */
 232 #define IFCAP_TXSTATUS          0x00200 /* can return linklevel xmit status */
 233 #define IFCAP_SKYWALK           0x00400 /* Skywalk mode supported/enabled */
 234 #define IFCAP_HW_TIMESTAMP      0x00800 /* Time stamping in hardware */
 235 #define IFCAP_SW_TIMESTAMP      0x01000 /* Time stamping in software */
 236
 237 #define IFCAP_HWCSUM    (IFCAP_RXCSUM | IFCAP_TXCSUM)
 238 #define IFCAP_TSO       (IFCAP_TSO4 | IFCAP_TSO6)
 239
 240 #define IFCAP_VALID (IFCAP_HWCSUM | IFCAP_TSO | IFCAP_LRO | IFCAP_VLAN_MTU | \
 241         IFCAP_VLAN_HWTAGGING | IFCAP_JUMBO_MTU | IFCAP_AV | IFCAP_TXSTATUS | \
 242         IFCAP_SKYWALK | IFCAP_SW_TIMESTAMP | IFCAP_HW_TIMESTAMP)
 243
 244 #define IFQ_MAXLEN      128
 245 #define IFNET_SLOWHZ    1       /* granularity is 1 second */
 246 #define IFQ_TARGET_DELAY        (10ULL * 1000 * 1000)   /* 10 ms */
 247 #define IFQ_UPDATE_INTERVAL     (100ULL * 1000 * 1000)  /* 100 ms */
 248
 249 /*
 250  * Message format for use in obtaining information about interfaces
 251  * from sysctl and the routing socket
 252  */
 253 struct if_msghdr {
 254         unsigned short  ifm_msglen;     /* to skip non-understood messages */
 255         unsigned char   ifm_version;    /* future binary compatability */
 256         unsigned char   ifm_type;       /* message type */
 257         int             ifm_addrs;      /* like rtm_addrs */
 258         int             ifm_flags;      /* value of if_flags */
 259         unsigned short  ifm_index;      /* index for associated ifp */
 260         struct  if_data ifm_data;       /* statistics and other data about if */
 261 };
 262
 263 /*
 264  * Message format for use in obtaining information about interface addresses
 265  * from sysctl and the routing socket
 266  */
 267 struct ifa_msghdr {
 268         unsigned short  ifam_msglen;    /* to skip non-understood messages */
 269         unsigned char   ifam_version;   /* future binary compatability */
 270         unsigned char   ifam_type;      /* message type */
 271         int             ifam_addrs;     /* like rtm_addrs */
 272         int             ifam_flags;     /* value of ifa_flags */
 273         unsigned short  ifam_index;     /* index for associated ifp */
 274         int             ifam_metric;    /* value of ifa_metric */
 275 };
 276
 277 /*
 278  * Message format for use in obtaining information about multicast addresses
 279  * from the routing socket
 280  */
 281 struct ifma_msghdr {
 282         unsigned short  ifmam_msglen;   /* to skip non-understood messages */
 283         unsigned char   ifmam_version;  /* future binary compatability */
 284         unsigned char   ifmam_type;     /* message type */
 285         int             ifmam_addrs;    /* like rtm_addrs */
 286         int             ifmam_flags;    /* value of ifa_flags */
 287         unsigned short  ifmam_index;    /* index for associated ifp */
 288 };
 289
 290 /*
 291  * Message format for use in obtaining information about interfaces
 292  * from sysctl
 293  */
 294 struct if_msghdr2 {
 295         u_short ifm_msglen;     /* to skip over non-understood messages */
 296         u_char  ifm_version;    /* future binary compatability */
 297         u_char  ifm_type;       /* message type */
 298         int     ifm_addrs;      /* like rtm_addrs */
 299         int     ifm_flags;      /* value of if_flags */
 300         u_short ifm_index;      /* index for associated ifp */
 301         int     ifm_snd_len;    /* instantaneous length of send queue */
 302         int     ifm_snd_maxlen; /* maximum length of send queue */
 303         int     ifm_snd_drops;  /* number of drops in send queue */
 304         int     ifm_timer;      /* time until if_watchdog called */
 305         struct if_data64        ifm_data;       /* statistics and other data */
 306 };
 307
 308 /*
 309  * Message format for use in obtaining information about multicast addresses
 310  * from sysctl
 311  */
 312 struct ifma_msghdr2 {
 313         u_short ifmam_msglen;   /* to skip over non-understood messages */
 314         u_char  ifmam_version;  /* future binary compatability */
 315         u_char  ifmam_type;     /* message type */
 316         int     ifmam_addrs;    /* like rtm_addrs */
 317         int     ifmam_flags;    /* value of ifa_flags */
 318         u_short ifmam_index;    /* index for associated ifp */
 319         int32_t ifmam_refcount;
 320 };
 321
 322 /*
 323  * ifdevmtu: interface device mtu
 324  *    Used with SIOCGIFDEVMTU to get the current mtu in use by the device,
 325  *    as well as the minimum and maximum mtu allowed by the device.
 326  */
 327 struct ifdevmtu {
 328         int     ifdm_current;
 329         int     ifdm_min;
 330         int     ifdm_max;
 331 };
 332
 333 #pragma pack(4)
 334
 335 /*
 336  ifkpi: interface kpi ioctl
 337  Used with SIOCSIFKPI and SIOCGIFKPI.
 338
 339  ifk_module_id - From in the kernel, a value from kev_vendor_code_find. From
 340         user space, a value from SIOCGKEVVENDOR ioctl on a kernel event socket.
 341  ifk_type - The type. Types are specific to each module id.
 342  ifk_data - The data. ifk_ptr may be a 64bit pointer for 64 bit processes.
 343
 344  Copying data between user space and kernel space is done using copyin
 345  and copyout. A process may be running in 64bit mode. In such a case,
 346  the pointer will be a 64bit pointer, not a 32bit pointer. The following
 347  sample is a safe way to copy the data in to the kernel from either a
 348  32bit or 64bit process:
 349
 350  user_addr_t tmp_ptr;
 351  if (IS_64BIT_PROCESS(current_proc())) {
 352         tmp_ptr = CAST_USER_ADDR_T(ifkpi.ifk_data.ifk_ptr64);
 353  }
 354  else {
 355         tmp_ptr = CAST_USER_ADDR_T(ifkpi.ifk_data.ifk_ptr);
 356  }
 357  error = copyin(tmp_ptr, allocated_dst_buffer, size of allocated_dst_buffer);
 358  */
 359
 360 struct ifkpi {
 361         unsigned int    ifk_module_id;
 362         unsigned int    ifk_type;
 363         union {
 364                 void            *ifk_ptr;
 365                 int             ifk_value;
 366 #ifdef KERNEL
 367                 u_int64_t       ifk_ptr64;
 368 #endif /* KERNEL */
 369         } ifk_data;
 370 };
 371
 372 /* Wake capabilities of a interface */
 373 #define IF_WAKE_ON_MAGIC_PACKET         0x01
 374 #ifdef KERNEL_PRIVATE
 375 #define IF_WAKE_VALID_FLAGS IF_WAKE_ON_MAGIC_PACKET
 376 #endif /* KERNEL_PRIVATE */
 377
 378
 379 #pragma pack()
 380
 381 /*
 382  * Interface request structure used for socket
 383  * ioctl's.  All interface ioctl's must have parameter
 384  * definitions which begin with ifr_name.  The
 385  * remainder may be interface specific.
 386  */
 387 struct  ifreq {
 388 #ifndef IFNAMSIZ
 389 #define IFNAMSIZ        IF_NAMESIZE
 390 #endif
 391         char    ifr_name[IFNAMSIZ];             /* if name, e.g. "en0" */
 392         union {
 393                 struct  sockaddr ifru_addr;
 394                 struct  sockaddr ifru_dstaddr;
 395                 struct  sockaddr ifru_broadaddr;
 396                 short   ifru_flags;
 397                 int     ifru_metric;
 398                 int     ifru_mtu;
 399                 int     ifru_phys;
 400                 int     ifru_media;
 401                 int     ifru_intval;
 402                 caddr_t ifru_data;
 403 #ifdef KERNEL_PRIVATE
 404                 u_int64_t ifru_data64;  /* 64-bit ifru_data */
 405 #endif /* KERNEL_PRIVATE */
 406                 struct  ifdevmtu ifru_devmtu;
 407                 struct  ifkpi   ifru_kpi;
 408                 u_int32_t ifru_wake_flags;
 409                 u_int32_t ifru_route_refcnt;
 410 #ifdef PRIVATE
 411                 int     ifru_link_quality_metric;
 412 #endif /* PRIVATE */
 413                 int     ifru_cap[2];
 414 #ifdef PRIVATE
 415                 struct {
 416                         uint32_t        ifo_flags;
 417 #define IFRIFOF_BLOCK_OPPORTUNISTIC     0x00000001
 418                         uint32_t        ifo_inuse;
 419                 } ifru_opportunistic;
 420                 u_int64_t ifru_eflags;
 421                 struct {
 422                         int32_t         ifl_level;
 423                         uint32_t        ifl_flags;
 424 #define IFRLOGF_DLIL                    0x00000001
 425 #define IFRLOGF_FAMILY                  0x00010000
 426 #define IFRLOGF_DRIVER                  0x01000000
 427 #define IFRLOGF_FIRMWARE                0x10000000
 428                         int32_t         ifl_category;
 429 #define IFRLOGCAT_CONNECTIVITY          1
 430 #define IFRLOGCAT_QUALITY               2
 431 #define IFRLOGCAT_PERFORMANCE           3
 432                         int32_t         ifl_subcategory;
 433                 } ifru_log;
 434                 u_int32_t ifru_delegated;
 435                 struct {
 436                         uint32_t        ift_type;
 437                         uint32_t        ift_family;
 438 #define IFRTYPE_FAMILY_ANY              0
 439 #define IFRTYPE_FAMILY_LOOPBACK         1
 440 #define IFRTYPE_FAMILY_ETHERNET         2
 441 #define IFRTYPE_FAMILY_SLIP             3
 442 #define IFRTYPE_FAMILY_TUN              4
 443 #define IFRTYPE_FAMILY_VLAN             5
 444 #define IFRTYPE_FAMILY_PPP              6
 445 #define IFRTYPE_FAMILY_PVC              7
 446 #define IFRTYPE_FAMILY_DISC             8
 447 #define IFRTYPE_FAMILY_MDECAP           9
 448 #define IFRTYPE_FAMILY_GIF              10
 449 #define IFRTYPE_FAMILY_FAITH            11
 450 #define IFRTYPE_FAMILY_STF              12
 451 #define IFRTYPE_FAMILY_FIREWIRE         13
 452 #define IFRTYPE_FAMILY_BOND             14
 453 #define IFRTYPE_FAMILY_CELLULAR         15
 454                         uint32_t        ift_subfamily;
 455 #define IFRTYPE_SUBFAMILY_ANY           0
 456 #define IFRTYPE_SUBFAMILY_USB           1
 457 #define IFRTYPE_SUBFAMILY_BLUETOOTH     2
 458 #define IFRTYPE_SUBFAMILY_WIFI          3
 459 #define IFRTYPE_SUBFAMILY_THUNDERBOLT   4
 460 #define IFRTYPE_SUBFAMILY_RESERVED      5
 461 #define IFRTYPE_SUBFAMILY_INTCOPROC     6
 462                 } ifru_type;
 463                 u_int32_t ifru_functional_type;
 464 #define IFRTYPE_FUNCTIONAL_UNKNOWN      0
 465 #define IFRTYPE_FUNCTIONAL_LOOPBACK     1
 466 #define IFRTYPE_FUNCTIONAL_WIRED        2
 467 #define IFRTYPE_FUNCTIONAL_WIFI_INFRA   3
 468 #define IFRTYPE_FUNCTIONAL_WIFI_AWDL    4
 469 #define IFRTYPE_FUNCTIONAL_CELLULAR     5
 470 #define IFRTYPE_FUNCTIONAL_LAST         5
 471                 u_int32_t ifru_expensive;
 472                 u_int32_t ifru_2kcl;
 473                 struct {
 474                         u_int32_t qlen;
 475                         u_int32_t timeout;
 476                 } ifru_start_delay;
 477                 struct if_interface_state       ifru_interface_state;
 478                 u_int32_t ifru_probe_connectivity;
 479                 u_int32_t ifru_ecn_mode;
 480 #define IFRTYPE_ECN_DEFAULT             0
 481 #define IFRTYPE_ECN_ENABLE              1
 482 #define IFRTYPE_ECN_DISABLE             2
 483                 u_int32_t ifru_qosmarking_mode;
 484 #define IFRTYPE_QOSMARKING_MODE_NONE            0
 485 #define IFRTYPE_QOSMARKING_FASTLANE     1
 486                 u_int32_t ifru_qosmarking_enabled;
 487                 u_int32_t ifru_disable_output;
 488 #endif /* PRIVATE */
 489         } ifr_ifru;
 490 #define ifr_addr        ifr_ifru.ifru_addr      /* address */
 491 #define ifr_dstaddr     ifr_ifru.ifru_dstaddr   /* other end of p-to-p link */
 492 #define ifr_broadaddr   ifr_ifru.ifru_broadaddr /* broadcast address */
 493 #ifdef __APPLE__
 494 #define ifr_flags       ifr_ifru.ifru_flags     /* flags */
 495 #else
 496 #define ifr_flags       ifr_ifru.ifru_flags[0]  /* flags */
 497 #define ifr_prevflags   ifr_ifru.ifru_flags[1]  /* flags */
 498 #endif /* __APPLE__ */
 499 #define ifr_metric      ifr_ifru.ifru_metric    /* metric */
 500 #define ifr_mtu         ifr_ifru.ifru_mtu       /* mtu */
 501 #define ifr_phys        ifr_ifru.ifru_phys      /* physical wire */
 502 #define ifr_media       ifr_ifru.ifru_media     /* physical media */
 503 #define ifr_data        ifr_ifru.ifru_data      /* for use by interface */
 504 #define ifr_devmtu      ifr_ifru.ifru_devmtu
 505 #define ifr_intval      ifr_ifru.ifru_intval    /* integer value */
 506 #ifdef KERNEL_PRIVATE
 507 #define ifr_data64      ifr_ifru.ifru_data64    /* 64-bit pointer */
 508 #endif /* KERNEL_PRIVATE */
 509 #define ifr_kpi         ifr_ifru.ifru_kpi
 510 #define ifr_wake_flags  ifr_ifru.ifru_wake_flags /* wake capabilities */
 511 #define ifr_route_refcnt ifr_ifru.ifru_route_refcnt /* route references count */
 512 #ifdef PRIVATE
 513 #define ifr_link_quality_metric ifr_ifru.ifru_link_quality_metric /* LQM */
 514 #endif /* PRIVATE */
 515 #define ifr_reqcap      ifr_ifru.ifru_cap[0]    /* requested capabilities */
 516 #define ifr_curcap      ifr_ifru.ifru_cap[1]    /* current capabilities */
 517 #ifdef PRIVATE
 518 #define ifr_opportunistic       ifr_ifru.ifru_opportunistic
 519 #define ifr_eflags      ifr_ifru.ifru_eflags    /* extended flags  */
 520 #define ifr_log         ifr_ifru.ifru_log       /* logging level/flags */
 521 #define ifr_delegated   ifr_ifru.ifru_delegated /* delegated interface index */
 522 #define ifr_expensive   ifr_ifru.ifru_expensive
 523 #define ifr_type        ifr_ifru.ifru_type      /* interface type */
 524 #define ifr_functional_type     ifr_ifru.ifru_functional_type
 525 #define ifr_2kcl        ifr_ifru.ifru_2kcl
 526 #define ifr_start_delay_qlen    ifr_ifru.ifru_start_delay.qlen
 527 #define ifr_start_delay_timeout ifr_ifru.ifru_start_delay.timeout
 528 #define ifr_interface_state     ifr_ifru.ifru_interface_state
 529 #define ifr_probe_connectivity  ifr_ifru.ifru_probe_connectivity
 530 #define ifr_ecn_mode    ifr_ifru.ifru_ecn_mode
 531 #define ifr_qosmarking_mode     ifr_ifru.ifru_qosmarking_mode
 532 #define ifr_fastlane_capable    ifr_qosmarking_mode
 533 #define ifr_qosmarking_enabled  ifr_ifru.ifru_qosmarking_enabled
 534 #define ifr_fastlane_enabled    ifr_qosmarking_enabled
 535 #define ifr_disable_output      ifr_ifru.ifru_disable_output
 536
 537 #endif /* PRIVATE */
 538 };
 539
 540 #define _SIZEOF_ADDR_IFREQ(ifr) \
 541         ((ifr).ifr_addr.sa_len > sizeof (struct sockaddr) ? \
 542         (sizeof (struct ifreq) - sizeof (struct sockaddr) + \
 543         (ifr).ifr_addr.sa_len) : sizeof (struct ifreq))
 544
 545 struct ifaliasreq {
 546         char    ifra_name[IFNAMSIZ];            /* if name, e.g. "en0" */
 547         struct  sockaddr ifra_addr;
 548         struct  sockaddr ifra_broadaddr;
 549         struct  sockaddr ifra_mask;
 550 };
 551
 552 struct rslvmulti_req {
 553         struct sockaddr *sa;
 554         struct sockaddr **llsa;
 555 };
 556
 557 #if !defined(KERNEL) || defined(KERNEL_PRIVATE)
 558 #pragma pack(4)
 559
 560 struct ifmediareq {
 561         char    ifm_name[IFNAMSIZ];     /* if name, e.g. "en0" */
 562         int     ifm_current;            /* current media options */
 563         int     ifm_mask;               /* don't care mask */
 564         int     ifm_status;             /* media status */
 565         int     ifm_active;             /* active options */
 566         int     ifm_count;              /* # entries in ifm_ulist array */
 567         int     *ifm_ulist;             /* media words */
 568 };
 569
 570 #pragma pack()
 571 #endif /* !KERNEL || KERNEL_PRIVATE */
 572
 573 #ifdef KERNEL_PRIVATE
 574 #pragma pack(4)
 575 struct ifmediareq64 {
 576         char    ifm_name[IFNAMSIZ];     /* if name, e.g. "en0" */
 577         int     ifm_current;            /* current media options */
 578         int     ifm_mask;               /* don't care mask */
 579         int     ifm_status;             /* media status */
 580         int     ifm_active;             /* active options */
 581         int     ifm_count;              /* # entries in ifm_ulist array */
 582         user64_addr_t ifmu_ulist __attribute__((aligned(8)));
 583 };
 584
 585 struct ifmediareq32 {
 586         char    ifm_name[IFNAMSIZ];     /* if name, e.g. "en0" */
 587         int     ifm_current;            /* current media options */
 588         int     ifm_mask;               /* don't care mask */
 589         int     ifm_status;             /* media status */
 590         int     ifm_active;             /* active options */
 591         int     ifm_count;              /* # entries in ifm_ulist array */
 592         user32_addr_t ifmu_ulist;       /* 32-bit pointer */
 593 };
 594 #pragma pack()
 595 #endif /* KERNEL_PRIVATE */
 596
 597
 598 #pragma pack(4)
 599 struct  ifdrv {
 600         char            ifd_name[IFNAMSIZ];     /* if name, e.g. "en0" */
 601         unsigned long   ifd_cmd;
 602         size_t          ifd_len;                /* length of ifd_data buffer */
 603         void            *ifd_data;
 604 };
 605 #pragma pack()
 606
 607 #ifdef KERNEL_PRIVATE
 608 #pragma pack(4)
 609 struct ifdrv32 {
 610         char            ifd_name[IFNAMSIZ];     /* if name, e.g. "en0" */
 611         u_int32_t       ifd_cmd;
 612         u_int32_t       ifd_len;
 613         user32_addr_t   ifd_data;
 614 };
 615
 616 struct  ifdrv64 {
 617         char            ifd_name[IFNAMSIZ];     /* if name, e.g. "en0" */
 618         u_int64_t       ifd_cmd;
 619         u_int64_t       ifd_len;
 620         user64_addr_t   ifd_data;
 621 };
 622 #pragma pack()
 623 #endif /* KERNEL_PRIVATE */
 624
 625 /*
 626  * Structure used to retrieve aux status data from interfaces.
 627  * Kernel suppliers to this interface should respect the formatting
 628  * needed by ifconfig(8): each line starts with a TAB and ends with
 629  * a newline.
 630  */
 631
 632 #define IFSTATMAX       800             /* 10 lines of text */
 633 struct ifstat {
 634         char    ifs_name[IFNAMSIZ];     /* if name, e.g. "en0" */
 635         char    ascii[IFSTATMAX + 1];
 636 };
 637
 638 #if !defined(KERNEL) || defined(KERNEL_PRIVATE)
 639 /*
 640  * Structure used in SIOCGIFCONF request.
 641  * Used to retrieve interface configuration
 642  * for machine (useful for programs which
 643  * must know all networks accessible).
 644  */
 645 #pragma pack(4)
 646 struct  ifconf {
 647         int     ifc_len;                /* size of associated buffer */
 648         union {
 649                 caddr_t ifcu_buf;
 650                 struct  ifreq *ifcu_req;
 651         } ifc_ifcu;
 652 };
 653 #pragma pack()
 654 #define ifc_buf ifc_ifcu.ifcu_buf       /* buffer address */
 655 #define ifc_req ifc_ifcu.ifcu_req       /* array of structures returned */
 656 #endif /* !KERNEL || KERNEL_PRIVATE */
 657
 658 #if defined(KERNEL_PRIVATE)
 659 #pragma pack(4)
 660 struct ifconf32 {
 661         int     ifc_len;                /* size of associated buffer */
 662         struct {
 663                 user32_addr_t ifcu_req;
 664         } ifc_ifcu;
 665 };
 666
 667 struct ifconf64 {
 668         int     ifc_len;                /* size of associated buffer */
 669         struct {
 670                 user64_addr_t ifcu_req  __attribute__((aligned(8)));
 671         } ifc_ifcu;
 672 };
 673 #pragma pack()
 674 #endif /* KERNEL_PRIVATE */
 675
 676 /*
 677  * DLIL KEV_DL_PROTO_ATTACHED/DETACHED structure
 678  */
 679 struct kev_dl_proto_data {
 680         struct net_event_data           link_data;
 681         u_int32_t                       proto_family;
 682         u_int32_t                       proto_remaining_count;
 683 };
 684
 685 #ifdef PRIVATE
 686 /*
 687  * Link Quality Metrics
 688  *
 689  *      IFNET_LQM_THRESH_OFF      Metric is not available; device is off.
 690  *      IFNET_LQM_THRESH_UNKNOWN  Metric is not (yet) known.
 691  *      IFNET_LQM_THRESH_BAD      Link quality is considered bad by driver.
 692  *      IFNET_LQM_THRESH_POOR     Link quality is considered poor by driver.
 693  *      IFNET_LQM_THRESH_GOOD     Link quality is considered good by driver.
 694  */
 695 enum {
 696         IFNET_LQM_THRESH_OFF            = (-2),
 697         IFNET_LQM_THRESH_UNKNOWN        = (-1),
 698         IFNET_LQM_THRESH_BAD            = 10,
 699         IFNET_LQM_THRESH_POOR           = 50,
 700         IFNET_LQM_THRESH_GOOD           = 100
 701 };
 702 #ifdef XNU_KERNEL_PRIVATE
 703 #define IFNET_LQM_MIN   IFNET_LQM_THRESH_OFF
 704 #define IFNET_LQM_MAX   IFNET_LQM_THRESH_GOOD
 705 #endif /* XNU_KERNEL_PRIVATE */
 706
 707 /*
 708  * DLIL KEV_DL_LINK_QUALITY_METRIC_CHANGED structure
 709  */
 710 struct kev_dl_link_quality_metric_data {
 711         struct net_event_data   link_data;
 712         int                     link_quality_metric;
 713 };
 714
 715 #define IF_DESCSIZE     128
 716
 717 /*
 718  * Structure for SIOC[SG]IFDESC
 719  */
 720 struct if_descreq {
 721         char                    ifdr_name[IFNAMSIZ];    /* interface name */
 722         u_int32_t               ifdr_len;               /* up to IF_DESCSIZE */
 723         u_int8_t                ifdr_desc[IF_DESCSIZE]; /* opaque data */
 724 };
 725
 726 /*
 727  *      Output packet scheduling models
 728  *
 729  *      IFNET_SCHED_MODEL_NORMAL The default output packet scheduling model
 730  *              where the driver or media does not require strict scheduling
 731  *              strategy, and that the networking stack is free to choose the
 732  *              most appropriate scheduling and queueing algorithm, including
 733  *              shaping traffics.
 734  *      IFNET_SCHED_MODEL_DRIVER_MANAGED The alternative output packet
 735  *              scheduling model where the driver or media requires strict
 736  *              scheduling strategy (e.g. 802.11 WMM), and that the networking
 737  *              stack is only responsible for creating multiple queues for the
 738  *              corresponding service classes.
 739  */
 740 enum {
 741         IFNET_SCHED_MODEL_NORMAL                = 0,
 742         IFNET_SCHED_MODEL_DRIVER_MANAGED        = 1,
 743         IFNET_SCHED_MODEL_FQ_CODEL              = 2,
 744 #ifdef XNU_KERNEL_PRIVATE
 745         IFNET_SCHED_MODEL_MAX                   = 3,
 746 #endif /* XNU_KERNEL_PRIVATE */
 747 };
 748
 749 /*
 750  * Values for iflpr_flags
 751  */
 752 #define IFLPRF_ALTQ             0x1     /* configured via PF/ALTQ */
 753 #define IFLPRF_DRVMANAGED       0x2     /* output queue scheduled by drv */
 754
 755 /*
 756  * Structure for SIOCGIFLINKPARAMS
 757  */
 758 struct if_linkparamsreq {
 759         char            iflpr_name[IFNAMSIZ];   /* interface name */
 760         u_int32_t       iflpr_flags;
 761         u_int32_t       iflpr_output_sched;
 762         u_int64_t       iflpr_output_tbr_rate;
 763         u_int32_t       iflpr_output_tbr_percent;
 764         struct if_bandwidths iflpr_output_bw;
 765         struct if_bandwidths iflpr_input_bw;
 766         struct if_latencies iflpr_output_lt;
 767         struct if_latencies iflpr_input_lt;
 768 };
 769
 770 /*
 771  * Structure for SIOCGIFQUEUESTATS
 772  */
 773 struct if_qstatsreq {
 774         char            ifqr_name[IFNAMSIZ];    /* interface name */
 775         u_int32_t       ifqr_slot;
 776         void            *ifqr_buf               __attribute__((aligned(8)));
 777         int              ifqr_len               __attribute__((aligned(8)));
 778 };
 779
 780 /*
 781  * Node Proximity Metrics
 782  */
 783 enum {
 784         IFNET_NPM_THRESH_UNKNOWN        = (-1),
 785         IFNET_NPM_THRESH_NEAR           = 30,
 786         IFNET_NPM_THRESH_GENERAL        = 70,
 787         IFNET_NPM_THRESH_FAR            = 100,
 788 };
 789
 790 /*
 791  *      Received Signal Strength Indication [special values]
 792  *
 793  *      IFNET_RSSI_UNKNOWN      Metric is not (yet) known.
 794  */
 795 enum {
 796         IFNET_RSSI_UNKNOWN      = ((-2147483647)-1),    /* INT32_MIN */
 797 };
 798
 799
 800 /*
 801  * DLIL KEV_DL_NODE_PRESENCE/KEV_DL_NODE_ABSENCE event structures
 802  */
 803 struct kev_dl_node_presence {
 804         struct net_event_data   link_data;
 805         struct sockaddr_in6     sin6_node_address;
 806         struct sockaddr_dl      sdl_node_address;
 807         int32_t                 rssi;
 808         int                     link_quality_metric;
 809         int                     node_proximity_metric;
 810         u_int8_t                node_service_info[48];
 811 };
 812
 813 struct kev_dl_node_absence {
 814         struct net_event_data   link_data;
 815         struct sockaddr_in6     sin6_node_address;
 816         struct sockaddr_dl      sdl_node_address;
 817 };
 818
 819 /*
 820  * Structure for SIOC[SG]IFTHROTTLE
 821  */
 822 struct if_throttlereq {
 823         char            ifthr_name[IFNAMSIZ];   /* interface name */
 824         u_int32_t       ifthr_level;
 825 };
 826
 827 /*
 828  *      Interface throttling levels
 829  *
 830  *      IFNET_THROTTLE_OFF The default throttling level (no throttling.)
 831  *              All service class queues operate normally according to the
 832  *              standard packet scheduler configuration.
 833  *      IFNET_THROTTLE_OPPORTUNISTIC One or more service class queues that
 834  *              are responsible for managing "opportunistic" traffics are
 835  *              suspended.  Packets enqueued on those queues will be dropped
 836  *              and a flow advisory error will be generated to the data
 837  *              source.  Existing packets in the queues will stay enqueued
 838  *              until the interface is no longer throttled, or until they
 839  *              are explicitly flushed.
 840  */
 841 enum {
 842         IFNET_THROTTLE_OFF                      = 0,
 843         IFNET_THROTTLE_OPPORTUNISTIC            = 1,
 844 #ifdef XNU_KERNEL_PRIVATE
 845         IFNET_THROTTLE_MAX                      = 2,
 846 #endif /* XNU_KERNEL_PRIVATE */
 847 };
 848
 849 /*
 850  * Structure for SIOC[A/D]IFAGENTID
 851  */
 852 struct if_agentidreq {
 853         char            ifar_name[IFNAMSIZ];    /* interface name */
 854         uuid_t          ifar_uuid;              /* agent UUID to add or delete */
 855 };
 856
 857 /*
 858  * Structure for SIOCGIFAGENTIDS
 859  */
 860 struct if_agentidsreq {
 861         char            ifar_name[IFNAMSIZ];    /* interface name */
 862         u_int32_t       ifar_count;             /* number of agent UUIDs */
 863         uuid_t          *ifar_uuids;            /* array of agent UUIDs */
 864 };
 865
 866 #ifdef BSD_KERNEL_PRIVATE
 867 struct if_agentidsreq32 {
 868         char            ifar_name[IFNAMSIZ];
 869         u_int32_t       ifar_count;
 870         user32_addr_t ifar_uuids;
 871 };
 872 struct if_agentidsreq64 {
 873         char            ifar_name[IFNAMSIZ];
 874         u_int32_t       ifar_count;
 875         user64_addr_t ifar_uuids __attribute__((aligned(8)));
 876 };
 877 #endif /* BSD_KERNEL_PRIVATE */
 878
 879 #define DLIL_MODIDLEN   20      /* same as IFNET_MODIDLEN */
 880 #define DLIL_MODARGLEN  12      /* same as IFNET_MODARGLEN */
 881
 882 /*
 883  * DLIL KEV_DL_ISSUES event structure
 884  */
 885 struct kev_dl_issues {
 886         struct net_event_data   link_data;
 887         u_int8_t                modid[DLIL_MODIDLEN];
 888         u_int64_t               timestamp;
 889         u_int8_t                info[DLIL_MODARGLEN];
 890 };
 891
 892 /*
 893  * DLIL KEV_DL_RRC_STATE_CHANGED structure
 894  */
 895 struct kev_dl_rrc_state {
 896         struct net_event_data   link_data;
 897         u_int32_t               rrc_state;
 898 };
 899
 900 /*
 901  * Length of network signature/fingerprint blob.
 902  */
 903 #define IFNET_SIGNATURELEN      20
 904
 905 /*
 906  * Structure for SIOC[S/G]IFNETSIGNATURE
 907  */
 908 struct if_nsreq {
 909         char            ifnsr_name[IFNAMSIZ];
 910         u_int8_t        ifnsr_family;   /* address family */
 911         u_int8_t        ifnsr_len;      /* data length */
 912         u_int16_t       ifnsr_flags;    /* for future */
 913         u_int8_t        ifnsr_data[IFNET_SIGNATURELEN];
 914 };
 915
 916 /*
 917  * Structure for SIOC[S/G]IFORDER
 918  *
 919  * When setting, ifo_count is the number of u_int32_t interface indices
 920  * in the ifo_ordered_indices array.
 921  *
 922  * When getting, if ifo_count is 0, the length of the ordered list will
 923  * be returned. If the ifo_count is non-0, it is the number of u_int32_t
 924  * interface indices allocated. Upon return, ifo_count will contain the number
 925  * of indices copied into the array.
 926  */
 927 struct if_order {
 928         u_int32_t                       ifo_count;
 929         u_int32_t                       ifo_reserved;
 930         mach_vm_address_t       ifo_ordered_indices; /* array of u_int32_t */
 931 };
 932
 933 /*
 934  * Struct for traffic class to DSCP mapping
 935  */
 936 struct if_tdmreq {
 937         char                            iftdm_name[IFNAMSIZ];
 938         u_int32_t                       iftdm_len;      /* byte length of the table */
 939         struct netsvctype_dscp_map      *iftdm_table;
 940 };
 941
 942 #ifdef BSD_KERNEL_PRIVATE
 943 struct if_tdmreq32 {
 944         char                    iftdm_name[IFNAMSIZ];
 945         u_int32_t               iftdm_len;      /* byte length of the table */
 946         user32_addr_t           iftdm_table;
 947 };
 948
 949 struct if_tdmreq64 {
 950         char                    iftdm_name[IFNAMSIZ];
 951         u_int32_t               iftdm_len;      /* byte length of the table */
 952         user64_addr_t           iftdm_table __attribute__((aligned(8)));
 953 };
 954 #endif
 955
 956 #endif /* PRIVATE */
 957
 958 #ifdef KERNEL
 959 #ifdef MALLOC_DECLARE
 960 MALLOC_DECLARE(M_IFADDR);
 961 MALLOC_DECLARE(M_IFMADDR);
 962 #endif
 963 #endif
 964 #endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */
 965
 966 #ifndef KERNEL
 967 struct if_nameindex {
 968         unsigned int     if_index;      /* 1, 2, ... */
 969         char            *if_name;       /* null terminated name: "le0", ... */
 970 };
 971
 972 __BEGIN_DECLS
 973 unsigned int     if_nametoindex(const char *);
 974 char            *if_indextoname(unsigned int, char *);
 975 struct           if_nameindex *if_nameindex(void);
 976 void             if_freenameindex(struct if_nameindex *);
 977 __END_DECLS
 978 #endif
 979
 980 #ifdef KERNEL
 981 #include <net/kpi_interface.h>
 982 #endif
 983
 984 #endif /* !_NET_IF_H_ */