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