1 /* 2 * Copyright (c) 2000-2021 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_PRIVATE_H_ 64 #define _NET_IF_PRIVATE_H_ 65 66 #include <mach/vm_types.h> 67 #include <net/if.h> 68 #include <net/if_dl.h> 69 #include <net/if_var.h> 70 #include <net/if_var_private.h> 71 #include <netinet/in.h> 72 #include <sys/types.h> 73 #include <uuid/uuid.h> 74 75 #if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE) 76 #ifndef DRIVERKIT 77 #ifdef KERNEL_PRIVATE 78 #define IF_MAXUNIT 0x7fff /* historical value */ 79 80 struct if_clonereq64 { 81 int ifcr_total; /* total cloners (out) */ 82 int ifcr_count; /* room for this many in user buffer */ 83 user64_addr_t ifcru_buffer __attribute__((aligned(8))); 84 }; 85 86 struct if_clonereq32 { 87 int ifcr_total; /* total cloners (out) */ 88 int ifcr_count; /* room for this many in user buffer */ 89 user32_addr_t ifcru_buffer; 90 }; 91 #endif /* KERNEL_PRIVATE */ 92 93 /* extended flags definitions: (all bits reserved for internal/future use) */ 94 #define IFEF_AUTOCONFIGURING 0x00000001 /* allow BOOTP/DHCP replies to enter */ 95 #define IFEF_ENQUEUE_MULTI 0x00000002 /* enqueue multiple packets at once */ 96 #define IFEF_DELAY_START 0x00000004 /* delay start callback */ 97 #define IFEF_PROBE_CONNECTIVITY 0x00000008 /* Probe connections going over this interface */ 98 #define IFEF_ADV_REPORT 0x00000010 /* Supports interface advisory report */ 99 #define IFEF_IPV6_DISABLED 0x00000020 /* coupled to ND6_IFF_IFDISABLED */ 100 #define IFEF_ACCEPT_RTADV 0x00000040 /* accepts IPv6 RA on the interface */ 101 #define IFEF_TXSTART 0x00000080 /* has start callback */ 102 #define IFEF_RXPOLL 0x00000100 /* supports opportunistic input poll */ 103 #define IFEF_VLAN 0x00000200 /* interface has one or more vlans */ 104 #define IFEF_BOND 0x00000400 /* interface is part of bond */ 105 #define IFEF_ARPLL 0x00000800 /* ARP for IPv4LL addresses */ 106 #define IFEF_CLAT46 0x00001000 /* CLAT46 RFC 6877 */ 107 108 #define IS_INTF_CLAT46(ifp) ((ifp) != NULL && ((ifp)->if_eflags & IFEF_CLAT46)) 109 #define INTF_ADJUST_MTU_FOR_CLAT46(intf) \ 110 (IS_INTF_CLAT46((intf)) || \ 111 IS_INTF_CLAT46((intf)->if_delegated.ifp)) \ 112 113 /* 114 * XXX IFEF_NOAUTOIPV6LL is deprecated and should be done away with. 115 * Configd pretty much manages the interface configuration. 116 * Rather than looking at the flag we check if a specific LLA 117 * has to be configured or the IID has to be generated by kernel. 118 */ 119 #define IFEF_NOAUTOIPV6LL 0x00002000 /* Need explicit IPv6 LL address */ 120 #define IFEF_EXPENSIVE 0x00004000 /* Data access has a cost */ 121 #define IFEF_IPV4_ROUTER 0x00008000 /* interior when in IPv4 router mode */ 122 #define IFEF_LOCALNET_PRIVATE 0x00020000 /* local private network */ 123 #define IFEF_SERVICE_TRIGGERED IFEF_LOCALNET_PRIVATE 124 #define IFEF_IPV6_ND6ALT 0x00040000 /* alternative. KPI for ND6 */ 125 #define IFEF_RESTRICTED_RECV 0x00080000 /* interface restricts inbound pkts */ 126 #define IFEF_AWDL 0x00100000 /* Apple Wireless Direct Link */ 127 #define IFEF_NOACKPRI 0x00200000 /* No TCP ACK prioritization */ 128 #define IFEF_AWDL_RESTRICTED 0x00400000 /* Restricted AWDL mode */ 129 #define IFEF_2KCL 0x00800000 /* prefers 2K cluster (socket based tunnel) */ 130 #define IFEF_ECN_ENABLE 0x01000000 /* use ECN for TCP connections on the interface */ 131 #define IFEF_ECN_DISABLE 0x02000000 /* do not use ECN for TCP connections on the interface */ 132 #define IFEF_SKYWALK_NATIVE 0x04000000 /* Native Skywalk support */ 133 #define IFEF_3CA 0x08000000 /* Capable of 3CA */ 134 #define IFEF_SENDLIST 0x10000000 /* Supports tx packet lists */ 135 #define IFEF_DIRECTLINK 0x20000000 /* point-to-point topology */ 136 #define IFEF_QOSMARKING_ENABLED 0x40000000 /* QoS marking is enabled */ 137 #define IFEF_UPDOWNCHANGE 0x80000000 /* up/down state is changing */ 138 139 #ifdef XNU_KERNEL_PRIVATE 140 /* 141 * Extra flags 142 */ 143 #define IFXF_WAKE_ON_MAGIC_PACKET 0x00000001 /* wake on magic packet */ 144 #define IFXF_TIMESTAMP_ENABLED 0x00000002 /* time stamping enabled */ 145 #define IFXF_NX_NOAUTO 0x00000004 /* no auto config nexus */ 146 #define IFXF_LEGACY 0x00000008 /* legacy (non-netif) mode */ 147 #define IFXF_LOW_INTERNET_UL 0x00000010 /* Uplink Low Internet is confirmed */ 148 #define IFXF_LOW_INTERNET_DL 0x00000020 /* Downlink Low Internet is confirmed */ 149 #define IFXF_ALLOC_KPI 0x00000040 /* Allocated via the ifnet_alloc KPI */ 150 #define IFXF_LOW_POWER 0x00000080 /* Low Power Mode */ 151 #define IFXF_MPK_LOG 0x00000100 /* Multi-layer Packet Logging */ 152 #define IFXF_CONSTRAINED 0x00000200 /* Constrained - Save Data Mode */ 153 #define IFXF_LOW_LATENCY 0x00000400 /* Low latency interface */ 154 #define IFXF_MARK_WAKE_PKT 0x00000800 /* Mark next input packet as wake packet */ 155 #define IFXF_FAST_PKT_DELIVERY 0x00001000 /* Fast Packet Delivery */ 156 #define IFXF_NO_TRAFFIC_SHAPING 0x00002000 /* Skip dummynet and netem traffic shaping */ 157 158 /* 159 * Current requirements for an AWDL interface. Setting/clearing IFEF_AWDL 160 * will also trigger the setting/clearing of the rest of the flags. Once 161 * IFEF_AWDL is set, the rest of flags cannot be cleared, by definition. 162 */ 163 #define IFEF_AWDL_MASK \ 164 (IFEF_LOCALNET_PRIVATE | IFEF_IPV6_ND6ALT | IFEF_RESTRICTED_RECV | \ 165 IFEF_AWDL) 166 #endif /* XNU_KERNEL_PRIVATE */ 167 168 #ifdef KERNEL_PRIVATE 169 /* 170 * !!! NOTE !!! 171 * 172 * if_idle_flags definitions: (all bits are reserved for internal/future 173 * use). Setting these flags MUST be done via the ifnet_set_idle_flags() 174 * KPI due to the associated reference counting. Clearing them may be done by 175 * calling the KPI, otherwise implicitly at interface detach time. Setting 176 * the if_idle_flags field to a non-zero value will cause the networking 177 * stack to aggressively purge expired objects (routes, etc.) 178 */ 179 #define IFRF_IDLE_NOTIFY 0x1 /* Generate notifications on idle */ 180 181 /* flags set internally only: */ 182 #define IFF_CANTCHANGE \ 183 (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\ 184 IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI) 185 186 #define IF_WAKE_VALID_FLAGS IF_WAKE_ON_MAGIC_PACKET 187 #endif /* KERNEL_PRIVATE */ 188 189 #ifdef IFREQ_OPAQUE 190 /* 191 * This is the private version of the ifreq structure, the 192 * public version lives in if.h. If you make any changes 193 * here, you probably also need to make them in if.h! 194 */ 195 struct ifreq { 196 char ifr_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 197 union { 198 struct sockaddr ifru_addr; 199 struct sockaddr ifru_dstaddr; 200 struct sockaddr ifru_broadaddr; 201 short ifru_flags; 202 int ifru_metric; 203 int ifru_mtu; 204 int ifru_phys; 205 int ifru_media; 206 int ifru_intval; 207 caddr_t ifru_data; 208 #ifdef KERNEL_PRIVATE 209 u_int64_t ifru_data64; /* 64-bit ifru_data */ 210 #endif /* KERNEL_PRIVATE */ 211 struct ifdevmtu ifru_devmtu; 212 struct ifkpi ifru_kpi; 213 u_int32_t ifru_wake_flags; 214 u_int32_t ifru_route_refcnt; 215 int ifru_link_quality_metric; 216 int ifru_cap[2]; 217 struct { 218 uint32_t ifo_flags; 219 #define IFRIFOF_BLOCK_OPPORTUNISTIC 0x00000001 220 uint32_t ifo_inuse; 221 } ifru_opportunistic; 222 u_int64_t ifru_eflags; 223 u_int64_t ifru_xflags; 224 struct { 225 int32_t ifl_level; 226 uint32_t ifl_flags; 227 #define IFRLOGF_DLIL 0x00000001 228 #define IFRLOGF_FAMILY 0x00010000 229 #define IFRLOGF_DRIVER 0x01000000 230 #define IFRLOGF_FIRMWARE 0x10000000 231 int32_t ifl_category; 232 #define IFRLOGCAT_CONNECTIVITY 1 233 #define IFRLOGCAT_QUALITY 2 234 #define IFRLOGCAT_PERFORMANCE 3 235 int32_t ifl_subcategory; 236 } ifru_log; 237 u_int32_t ifru_delegated; 238 struct { 239 uint32_t ift_type; 240 uint32_t ift_family; 241 #define IFRTYPE_FAMILY_ANY 0 242 #define IFRTYPE_FAMILY_LOOPBACK 1 243 #define IFRTYPE_FAMILY_ETHERNET 2 244 #define IFRTYPE_FAMILY_SLIP 3 245 #define IFRTYPE_FAMILY_TUN 4 246 #define IFRTYPE_FAMILY_VLAN 5 247 #define IFRTYPE_FAMILY_PPP 6 248 #define IFRTYPE_FAMILY_PVC 7 249 #define IFRTYPE_FAMILY_DISC 8 250 #define IFRTYPE_FAMILY_MDECAP 9 251 #define IFRTYPE_FAMILY_GIF 10 252 #define IFRTYPE_FAMILY_FAITH 11 253 #define IFRTYPE_FAMILY_STF 12 254 #define IFRTYPE_FAMILY_FIREWIRE 13 255 #define IFRTYPE_FAMILY_BOND 14 256 #define IFRTYPE_FAMILY_CELLULAR 15 257 #define IFRTYPE_FAMILY_UNUSED_16 16 /* Un-used */ 258 #define IFRTYPE_FAMILY_UTUN 17 259 #define IFRTYPE_FAMILY_IPSEC 18 260 uint32_t ift_subfamily; 261 #define IFRTYPE_SUBFAMILY_ANY 0 262 #define IFRTYPE_SUBFAMILY_USB 1 263 #define IFRTYPE_SUBFAMILY_BLUETOOTH 2 264 #define IFRTYPE_SUBFAMILY_WIFI 3 265 #define IFRTYPE_SUBFAMILY_THUNDERBOLT 4 266 #define IFRTYPE_SUBFAMILY_RESERVED 5 267 #define IFRTYPE_SUBFAMILY_INTCOPROC 6 268 #define IFRTYPE_SUBFAMILY_QUICKRELAY 7 269 #define IFRTYPE_SUBFAMILY_DEFAULT 8 270 } ifru_type; 271 u_int32_t ifru_functional_type; 272 #define IFRTYPE_FUNCTIONAL_UNKNOWN 0 273 #define IFRTYPE_FUNCTIONAL_LOOPBACK 1 274 #define IFRTYPE_FUNCTIONAL_WIRED 2 275 #define IFRTYPE_FUNCTIONAL_WIFI_INFRA 3 276 #define IFRTYPE_FUNCTIONAL_WIFI_AWDL 4 277 #define IFRTYPE_FUNCTIONAL_CELLULAR 5 278 #define IFRTYPE_FUNCTIONAL_INTCOPROC 6 279 #define IFRTYPE_FUNCTIONAL_COMPANIONLINK 7 280 #define IFRTYPE_FUNCTIONAL_LAST 7 281 u_int32_t ifru_expensive; 282 u_int32_t ifru_constrained; 283 u_int32_t ifru_2kcl; 284 struct { 285 u_int32_t qlen; 286 u_int32_t timeout; 287 } ifru_start_delay; 288 struct if_interface_state ifru_interface_state; 289 u_int32_t ifru_probe_connectivity; 290 u_int32_t ifru_ecn_mode; 291 #define IFRTYPE_ECN_DEFAULT 0 292 #define IFRTYPE_ECN_ENABLE 1 293 #define IFRTYPE_ECN_DISABLE 2 294 u_int32_t ifru_qosmarking_mode; 295 #define IFRTYPE_QOSMARKING_MODE_NONE 0 296 #define IFRTYPE_QOSMARKING_FASTLANE 1 /* supported: socket/channel */ 297 #define IFRTYPE_QOSMARKING_RFC4594 2 /* supported: channel only */ 298 #define IFRTYPE_QOSMARKING_CUSTOM 3 /* supported: socket/channel */ 299 u_int32_t ifru_qosmarking_enabled; 300 u_int32_t ifru_disable_output; 301 u_int32_t ifru_low_internet; 302 #define IFRTYPE_LOW_INTERNET_DISABLE_UL_DL 0x0000 303 #define IFRTYPE_LOW_INTERNET_ENABLE_UL 0x0001 304 #define IFRTYPE_LOW_INTERNET_ENABLE_DL 0x0002 305 int ifru_low_power_mode; 306 u_int32_t ifru_tcp_kao_max; 307 int ifru_mpk_log; /* Multi Layer Packet Log */ 308 u_int32_t ifru_noack_prio; 309 struct { 310 u_int8_t up_bucket; 311 u_int8_t down_bucket; 312 } ifru_estimated_throughput; 313 struct { 314 u_int8_t technology; 315 u_int8_t channel; 316 } ifru_radio_details; 317 } ifr_ifru; 318 #define ifr_addr ifr_ifru.ifru_addr /* address */ 319 #define ifr_dstaddr ifr_ifru.ifru_dstaddr /* other end of p-to-p link */ 320 #define ifr_broadaddr ifr_ifru.ifru_broadaddr /* broadcast address */ 321 #ifdef __APPLE__ 322 #define ifr_flags ifr_ifru.ifru_flags /* flags */ 323 #else 324 #define ifr_flags ifr_ifru.ifru_flags[0] /* flags */ 325 #define ifr_prevflags ifr_ifru.ifru_flags[1] /* flags */ 326 #endif /* __APPLE__ */ 327 #define ifr_metric ifr_ifru.ifru_metric /* metric */ 328 #define ifr_mtu ifr_ifru.ifru_mtu /* mtu */ 329 #define ifr_phys ifr_ifru.ifru_phys /* physical wire */ 330 #define ifr_media ifr_ifru.ifru_media /* physical media */ 331 #define ifr_data ifr_ifru.ifru_data /* for use by interface */ 332 #define ifr_devmtu ifr_ifru.ifru_devmtu 333 #define ifr_intval ifr_ifru.ifru_intval /* integer value */ 334 #ifdef KERNEL_PRIVATE 335 #define ifr_data64 ifr_ifru.ifru_data64 /* 64-bit pointer */ 336 #endif /* KERNEL_PRIVATE */ 337 #define ifr_kpi ifr_ifru.ifru_kpi 338 #define ifr_wake_flags ifr_ifru.ifru_wake_flags /* wake capabilities */ 339 #define ifr_route_refcnt ifr_ifru.ifru_route_refcnt /* route references count */ 340 #define ifr_link_quality_metric ifr_ifru.ifru_link_quality_metric /* LQM */ 341 #define ifr_reqcap ifr_ifru.ifru_cap[0] /* requested capabilities */ 342 #define ifr_curcap ifr_ifru.ifru_cap[1] /* current capabilities */ 343 #define ifr_opportunistic ifr_ifru.ifru_opportunistic 344 #define ifr_eflags ifr_ifru.ifru_eflags /* extended flags */ 345 #define ifr_xflags ifr_ifru.ifru_xflags /* extra flags */ 346 #define ifr_log ifr_ifru.ifru_log /* logging level/flags */ 347 #define ifr_delegated ifr_ifru.ifru_delegated /* delegated interface index */ 348 #define ifr_expensive ifr_ifru.ifru_expensive 349 #define ifr_constrained ifr_ifru.ifru_constrained 350 #define ifr_type ifr_ifru.ifru_type /* interface type */ 351 #define ifr_functional_type ifr_ifru.ifru_functional_type 352 #define ifr_2kcl ifr_ifru.ifru_2kcl 353 #define ifr_start_delay_qlen ifr_ifru.ifru_start_delay.qlen 354 #define ifr_start_delay_timeout ifr_ifru.ifru_start_delay.timeout 355 #define ifr_interface_state ifr_ifru.ifru_interface_state 356 #define ifr_probe_connectivity ifr_ifru.ifru_probe_connectivity 357 #define ifr_ecn_mode ifr_ifru.ifru_ecn_mode 358 #define ifr_qosmarking_mode ifr_ifru.ifru_qosmarking_mode 359 #define ifr_fastlane_capable ifr_qosmarking_mode 360 #define ifr_qosmarking_enabled ifr_ifru.ifru_qosmarking_enabled 361 #define ifr_fastlane_enabled ifr_qosmarking_enabled 362 #define ifr_disable_output ifr_ifru.ifru_disable_output 363 #define ifr_low_internet ifr_ifru.ifru_low_internet 364 #define ifr_low_power_mode ifr_ifru.ifru_low_power_mode 365 #define ifr_tcp_kao_max ifr_ifru.ifru_tcp_kao_max 366 #define ifr_mpk_log ifr_ifru.ifru_mpk_log 367 #define ifr_noack_prio ifr_ifru.ifru_noack_prio 368 #define ifr_estimated_throughput ifr_ifru.ifru_estimated_throughput 369 #define ifr_radio_details ifr_ifru.ifru_radio_details 370 }; 371 372 #define _SIZEOF_ADDR_IFREQ(ifr) \ 373 ((ifr).ifr_addr.sa_len > sizeof (struct sockaddr) ? \ 374 (sizeof (struct ifreq) - sizeof (struct sockaddr) + \ 375 (ifr).ifr_addr.sa_len) : sizeof (struct ifreq)) 376 #endif /* IFREQ_OPAQUE */ 377 378 #ifdef KERNEL_PRIVATE 379 #pragma pack(4) 380 struct ifmediareq64 { 381 char ifm_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 382 int ifm_current; /* current media options */ 383 int ifm_mask; /* don't care mask */ 384 int ifm_status; /* media status */ 385 int ifm_active; /* active options */ 386 int ifm_count; /* # entries in ifm_ulist array */ 387 user64_addr_t ifmu_ulist __attribute__((aligned(8))); 388 }; 389 390 struct ifmediareq32 { 391 char ifm_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 392 int ifm_current; /* current media options */ 393 int ifm_mask; /* don't care mask */ 394 int ifm_status; /* media status */ 395 int ifm_active; /* active options */ 396 int ifm_count; /* # entries in ifm_ulist array */ 397 user32_addr_t ifmu_ulist; /* 32-bit pointer */ 398 }; 399 400 struct ifdrv32 { 401 char ifd_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 402 u_int32_t ifd_cmd; 403 u_int32_t ifd_len; 404 user32_addr_t ifd_data; 405 }; 406 407 struct ifdrv64 { 408 char ifd_name[IFNAMSIZ]; /* if name, e.g. "en0" */ 409 u_int64_t ifd_cmd; 410 u_int64_t ifd_len; 411 user64_addr_t ifd_data; 412 }; 413 414 struct ifconf32 { 415 int ifc_len; /* size of associated buffer */ 416 struct { 417 user32_addr_t ifcu_req; 418 } ifc_ifcu; 419 }; 420 421 struct ifconf64 { 422 int ifc_len; /* size of associated buffer */ 423 struct { 424 user64_addr_t ifcu_req __attribute__((aligned(8))); 425 } ifc_ifcu; 426 }; 427 #pragma pack() 428 #endif /* KERNEL_PRIVATE */ 429 430 /* 431 * Link Quality Metrics 432 * 433 * IFNET_LQM_THRESH_OFF Metric is not available; device is off. 434 * IFNET_LQM_THRESH_UNKNOWN Metric is not (yet) known. 435 * IFNET_LQM_THRESH_BAD Link quality is considered bad by driver. 436 * IFNET_LQM_THRESH_POOR Link quality is considered poor by driver. 437 * IFNET_LQM_THRESH_GOOD Link quality is considered good by driver. 438 */ 439 enum { 440 IFNET_LQM_THRESH_OFF = (-2), 441 IFNET_LQM_THRESH_UNKNOWN = (-1), 442 IFNET_LQM_THRESH_ABORT = 10, 443 IFNET_LQM_THRESH_MINIMALLY_VIABLE = 20, 444 IFNET_LQM_THRESH_POOR = 50, 445 IFNET_LQM_THRESH_GOOD = 100 446 }; 447 #define IFNET_LQM_THRESH_BAD IFNET_LQM_THRESH_ABORT 448 449 #ifdef XNU_KERNEL_PRIVATE 450 #define IFNET_LQM_MIN IFNET_LQM_THRESH_OFF 451 #define IFNET_LQM_MAX IFNET_LQM_THRESH_GOOD 452 #endif /* XNU_KERNEL_PRIVATE */ 453 454 /* 455 * DLIL KEV_DL_LINK_QUALITY_METRIC_CHANGED structure 456 */ 457 struct kev_dl_link_quality_metric_data { 458 struct net_event_data link_data; 459 int link_quality_metric; 460 }; 461 462 #define IF_DESCSIZE 128 463 464 /* 465 * Structure for SIOC[SG]IFDESC 466 */ 467 struct if_descreq { 468 char ifdr_name[IFNAMSIZ]; /* interface name */ 469 u_int32_t ifdr_len; /* up to IF_DESCSIZE */ 470 u_int8_t ifdr_desc[IF_DESCSIZE]; /* opaque data */ 471 }; 472 473 /* 474 * Output packet scheduling models 475 * 476 * IFNET_SCHED_MODEL_NORMAL The default output packet scheduling model 477 * where the driver or media does not require strict scheduling 478 * strategy, and that the networking stack is free to choose the 479 * most appropriate scheduling and queueing algorithm, including 480 * shaping traffics. 481 * IFNET_SCHED_MODEL_DRIVER_MANAGED The alternative output packet 482 * scheduling model where the driver or media requires strict 483 * scheduling strategy (e.g. 802.11 WMM), and that the networking 484 * stack is only responsible for creating multiple queues for the 485 * corresponding service classes. 486 */ 487 enum { 488 IFNET_SCHED_MODEL_NORMAL = 0, 489 IFNET_SCHED_MODEL_DRIVER_MANAGED = 1, 490 IFNET_SCHED_MODEL_FQ_CODEL = 2, 491 #ifdef XNU_KERNEL_PRIVATE 492 IFNET_SCHED_MODEL_MAX = 3, 493 #endif /* XNU_KERNEL_PRIVATE */ 494 }; 495 496 /* 497 * Values for iflpr_flags 498 */ 499 #define IFLPRF_ALTQ 0x1 /* configured via PF/ALTQ */ 500 #define IFLPRF_DRVMANAGED 0x2 /* output queue scheduled by drv */ 501 502 /* 503 * Structure for SIOCGIFLINKPARAMS 504 */ 505 struct if_linkparamsreq { 506 char iflpr_name[IFNAMSIZ]; /* interface name */ 507 u_int32_t iflpr_flags; 508 u_int32_t iflpr_output_sched; 509 u_int64_t iflpr_output_tbr_rate; 510 u_int32_t iflpr_output_tbr_percent; 511 u_int64_t iflpr_input_tbr_rate; 512 struct if_bandwidths iflpr_output_bw; 513 struct if_bandwidths iflpr_input_bw; 514 struct if_latencies iflpr_output_lt; 515 struct if_latencies iflpr_input_lt; 516 struct if_netem_params iflpr_input_netem; 517 struct if_netem_params iflpr_output_netem; 518 }; 519 520 /* 521 * Structure for SIOCGIFQUEUESTATS 522 */ 523 struct if_qstatsreq { 524 char ifqr_name[IFNAMSIZ]; /* interface name */ 525 u_int32_t ifqr_grp_idx; 526 u_int32_t ifqr_slot; 527 void *ifqr_buf __attribute__((aligned(8))); 528 int ifqr_len __attribute__((aligned(8))); 529 }; 530 531 /* 532 * Node Proximity Metrics 533 */ 534 enum { 535 IFNET_NPM_THRESH_UNKNOWN = (-1), 536 IFNET_NPM_THRESH_NEAR = 30, 537 IFNET_NPM_THRESH_GENERAL = 70, 538 IFNET_NPM_THRESH_FAR = 100, 539 }; 540 541 /* 542 * Received Signal Strength Indication [special values] 543 * 544 * IFNET_RSSI_UNKNOWN Metric is not (yet) known. 545 */ 546 enum { 547 IFNET_RSSI_UNKNOWN = ((-2147483647) - 1), /* INT32_MIN */ 548 }; 549 550 551 #if !__has_ptrcheck 552 /* 553 * DLIL KEV_DL_NODE_PRESENCE/KEV_DL_NODE_ABSENCE event structures 554 */ 555 struct kev_dl_node_presence { 556 struct net_event_data link_data; 557 struct sockaddr_in6 sin6_node_address; 558 struct sockaddr_dl sdl_node_address; 559 int32_t rssi; 560 int link_quality_metric; 561 int node_proximity_metric; 562 u_int8_t node_service_info[48]; 563 }; 564 565 struct kev_dl_node_absence { 566 struct net_event_data link_data; 567 struct sockaddr_in6 sin6_node_address; 568 struct sockaddr_dl sdl_node_address; 569 }; 570 #endif 571 572 /* 573 * Structure for SIOC[SG]IFTHROTTLE 574 */ 575 struct if_throttlereq { 576 char ifthr_name[IFNAMSIZ]; /* interface name */ 577 u_int32_t ifthr_level; 578 }; 579 580 /* 581 * Interface throttling levels 582 * 583 * IFNET_THROTTLE_OFF The default throttling level (no throttling.) 584 * All service class queues operate normally according to the 585 * standard packet scheduler configuration. 586 * IFNET_THROTTLE_OPPORTUNISTIC One or more service class queues that 587 * are responsible for managing "opportunistic" traffics are 588 * suspended. Packets enqueued on those queues will be dropped 589 * and a flow advisory error will be generated to the data 590 * source. Existing packets in the queues will stay enqueued 591 * until the interface is no longer throttled, or until they 592 * are explicitly flushed. 593 */ 594 enum { 595 IFNET_THROTTLE_OFF = 0, 596 IFNET_THROTTLE_OPPORTUNISTIC = 1, 597 #ifdef XNU_KERNEL_PRIVATE 598 IFNET_THROTTLE_MAX = 2, 599 #endif /* XNU_KERNEL_PRIVATE */ 600 }; 601 602 /* 603 * Structure for SIOC[A/D]IFAGENTID 604 */ 605 struct if_agentidreq { 606 char ifar_name[IFNAMSIZ]; /* interface name */ 607 uuid_t ifar_uuid; /* agent UUID to add or delete */ 608 }; 609 610 /* 611 * Structure for SIOCGIFAGENTIDS 612 */ 613 struct if_agentidsreq { 614 char ifar_name[IFNAMSIZ]; /* interface name */ 615 u_int32_t ifar_count; /* number of agent UUIDs */ 616 uuid_t *ifar_uuids; /* array of agent UUIDs */ 617 }; 618 619 #ifdef BSD_KERNEL_PRIVATE 620 struct if_agentidsreq32 { 621 char ifar_name[IFNAMSIZ]; 622 u_int32_t ifar_count; 623 user32_addr_t ifar_uuids; 624 }; 625 struct if_agentidsreq64 { 626 char ifar_name[IFNAMSIZ]; 627 u_int32_t ifar_count; 628 user64_addr_t ifar_uuids __attribute__((aligned(8))); 629 }; 630 #endif /* BSD_KERNEL_PRIVATE */ 631 632 /* 633 * Structure for SIOCGIFNEXUS 634 */ 635 struct if_nexusreq { 636 char ifnr_name[IFNAMSIZ]; /* interface name */ 637 uint64_t ifnr_flags; /* unused, must be zero */ 638 uuid_t ifnr_netif; /* netif nexus instance UUID */ 639 uuid_t ifnr_flowswitch; /* flowswitch nexus UUID */ 640 uint64_t ifnr_reserved[5]; 641 }; 642 643 #define DLIL_MODIDLEN 20 /* same as IFNET_MODIDLEN */ 644 #define DLIL_MODARGLEN 12 /* same as IFNET_MODARGLEN */ 645 646 /* 647 * DLIL KEV_DL_ISSUES event structure 648 */ 649 struct kev_dl_issues { 650 struct net_event_data link_data; 651 u_int8_t modid[DLIL_MODIDLEN]; 652 u_int64_t timestamp; 653 u_int8_t info[DLIL_MODARGLEN]; 654 }; 655 656 /* 657 * DLIL KEV_DL_RRC_STATE_CHANGED structure 658 */ 659 struct kev_dl_rrc_state { 660 struct net_event_data link_data; 661 u_int32_t rrc_state; 662 }; 663 664 /* 665 * KEV_DL_LOW_POWER_MODE_CHANGED 666 */ 667 struct kev_dl_low_power_mode { 668 struct net_event_data link_data; 669 int low_power_event; 670 }; 671 672 /* 673 * Length of network signature/fingerprint blob. 674 */ 675 #define IFNET_SIGNATURELEN 20 676 677 /* 678 * Structure for SIOC[S/G]IFNETSIGNATURE 679 */ 680 struct if_nsreq { 681 char ifnsr_name[IFNAMSIZ]; 682 u_int8_t ifnsr_family; /* address family */ 683 u_int8_t ifnsr_len; /* data length */ 684 u_int16_t ifnsr_flags; /* for future */ 685 u_int8_t ifnsr_data[IFNET_SIGNATURELEN]; 686 }; 687 688 /* Structure for SIOCSIFNETWORKID */ 689 struct if_netidreq { 690 char ifnetid_name[IFNAMSIZ]; 691 u_int8_t ifnetid_len; 692 u_int8_t ifnetid[IFNET_NETWORK_ID_LEN]; 693 }; 694 695 #define NAT64_PREFIX_LEN_32 4 696 #define NAT64_PREFIX_LEN_40 5 697 #define NAT64_PREFIX_LEN_48 6 698 #define NAT64_PREFIX_LEN_56 7 699 #define NAT64_PREFIX_LEN_64 8 700 #define NAT64_PREFIX_LEN_96 12 701 #define NAT64_PREFIX_LEN_MAX NAT64_PREFIX_LEN_96 702 703 #define NAT64_MAX_NUM_PREFIXES 4 704 705 struct ipv6_prefix { 706 struct in6_addr ipv6_prefix; 707 uint32_t prefix_len; 708 }; 709 710 struct if_ipv6_address { 711 struct in6_addr v6_address; 712 uint32_t v6_prefixlen; 713 }; 714 715 /* Structure for SIOC[S/G]IFNAT64PREFIX */ 716 struct if_nat64req { 717 char ifnat64_name[IFNAMSIZ]; 718 struct ipv6_prefix ifnat64_prefixes[NAT64_MAX_NUM_PREFIXES]; 719 }; 720 721 /* Structure for SIOCGIFCLAT46ADDR */ 722 struct if_clat46req { 723 char ifclat46_name[IFNAMSIZ]; 724 struct if_ipv6_address ifclat46_addr; 725 }; 726 727 /* 728 * Structure for SIOC[S/G]IFORDER 729 * 730 * When setting, ifo_count is the number of u_int32_t interface indices 731 * in the ifo_ordered_indices array. 732 * 733 * When getting, if ifo_count is 0, the length of the ordered list will 734 * be returned. If the ifo_count is non-0, it is the number of u_int32_t 735 * interface indices allocated. Upon return, ifo_count will contain the number 736 * of indices copied into the array. 737 */ 738 struct if_order { 739 u_int32_t ifo_count; 740 u_int32_t ifo_reserved; 741 mach_vm_address_t ifo_ordered_indices; /* array of u_int32_t */ 742 }; 743 744 /* 745 * Struct for traffic class to DSCP mapping 746 */ 747 struct if_tdmreq { 748 char iftdm_name[IFNAMSIZ]; 749 u_int32_t iftdm_len; /* byte length of the table */ 750 struct netsvctype_dscp_map *iftdm_table; 751 }; 752 753 #ifdef BSD_KERNEL_PRIVATE 754 struct if_tdmreq32 { 755 char iftdm_name[IFNAMSIZ]; 756 u_int32_t iftdm_len; /* byte length of the table */ 757 user32_addr_t iftdm_table; 758 }; 759 760 struct if_tdmreq64 { 761 char iftdm_name[IFNAMSIZ]; 762 u_int32_t iftdm_len; /* byte length of the table */ 763 user64_addr_t iftdm_table __attribute__((aligned(8))); 764 }; 765 #endif 766 767 /* 768 * Structure for SIOCGIFPROTOLIST. 769 */ 770 struct if_protolistreq { 771 char ifpl_name[IFNAMSIZ]; 772 u_int32_t ifpl_count; 773 u_int32_t ifpl_reserved; /* must be zero */ 774 u_int32_t *ifpl_list; 775 }; 776 777 #ifdef BSD_KERNEL_PRIVATE 778 struct if_protolistreq32 { 779 char ifpl_name[IFNAMSIZ]; 780 u_int32_t ifpl_count; 781 u_int32_t ifpl_reserved; /* must be zero */ 782 user32_addr_t ifpl_list; 783 }; 784 785 struct if_protolistreq64 { 786 char ifpl_name[IFNAMSIZ]; 787 u_int32_t ifpl_count; 788 u_int32_t ifpl_reserved; /* must be zero */ 789 user64_addr_t ifpl_list; 790 }; 791 #endif /* BSD_KERNEL_PRIVATE */ 792 793 #endif /* DRIVERKIT */ 794 #endif /* (_POSIX_C_SOURCE && !_DARWIN_C_SOURCE) */ 795 796 #endif /* !_NET_IF_PRIVATE_H_ */ 797