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