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