/*
 * Copyright (c) 2000-2023 Apple Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 *
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 *
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 *
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/*
 * Copyright (c) 1982, 1986, 1989, 1993
 *    The Regents of the University of California.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *    This product includes software developed by the University of
 *    California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *    @(#)if.h    8.1 (Berkeley) 6/10/93
 */

#ifndef _NET_IF_PRIVATE_H_
#define _NET_IF_PRIVATE_H_

#include <mach/vm_types.h>
#include <net/if.h>
#include <net/if_dl.h>
#include <net/if_var.h>
#include <net/if_var_private.h>
#include <netinet/in.h>
#include <sys/types.h>
#include <uuid/uuid.h>

#if !defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE)
#ifndef DRIVERKIT
#ifdef KERNEL_PRIVATE
#define IF_MAXUNIT      0x7fff  /* historical value */

struct if_clonereq64 {
	int     ifcr_total;                 /* total cloners (out) */
	int     ifcr_count;                 /* room for this many in user buffer */
	user64_addr_t ifcru_buffer      __attribute__((aligned(8)));
};

struct if_clonereq32 {
	int     ifcr_total;                 /* total cloners (out) */
	int     ifcr_count;                 /* room for this many in user buffer */
	user32_addr_t ifcru_buffer;
};
#endif /* KERNEL_PRIVATE */

/* extended flags definitions:  (all bits reserved for internal/future use) */
#define IFEF_AUTOCONFIGURING    0x00000001      /* allow BOOTP/DHCP replies to enter */
#define IFEF_ENQUEUE_MULTI      0x00000002      /* enqueue multiple packets at once */
#define IFEF_DELAY_START        0x00000004      /* delay start callback */
#define IFEF_PROBE_CONNECTIVITY 0x00000008      /* Probe connections going over this interface */
#define IFEF_ADV_REPORT         0x00000010      /* Supports interface advisory report */
#define IFEF_IPV6_DISABLED      0x00000020      /* coupled to ND6_IFF_IFDISABLED */
#define IFEF_ACCEPT_RTADV       0x00000040      /* accepts IPv6 RA on the interface */
#define IFEF_TXSTART            0x00000080      /* has start callback */
#define IFEF_RXPOLL             0x00000100      /* supports opportunistic input poll */
#define IFEF_VLAN               0x00000200      /* interface has one or more vlans */
#define IFEF_BOND               0x00000400      /* interface is part of bond */
#define IFEF_ARPLL              0x00000800      /* ARP for IPv4LL addresses */
#define IFEF_CLAT46             0x00001000      /* CLAT46 RFC 6877 */

#define IS_INTF_CLAT46(ifp)     ((ifp) != NULL && ((ifp)->if_eflags & IFEF_CLAT46))
#define INTF_ADJUST_MTU_FOR_CLAT46(intf)                \
    (IS_INTF_CLAT46((intf)) ||                          \
     IS_INTF_CLAT46((intf)->if_delegated.ifp))          \

/*
 * XXX IFEF_NOAUTOIPV6LL is deprecated and should be done away with.
 * Configd pretty much manages the interface configuration.
 * Rather than looking at the flag we check if a specific LLA
 * has to be configured or the IID has to be generated by kernel.
 */
#define IFEF_NOAUTOIPV6LL       0x00002000      /* Need explicit IPv6 LL address */
#define IFEF_EXPENSIVE          0x00004000      /* Data access has a cost */
#define IFEF_IPV4_ROUTER        0x00008000      /* interior when in IPv4 router mode */
#define IFEF_CLONE              0x00010000      /* created using if_clone */
#define IFEF_LOCALNET_PRIVATE   0x00020000      /* local private network */
#define IFEF_SERVICE_TRIGGERED  IFEF_LOCALNET_PRIVATE
#define IFEF_IPV6_ND6ALT        0x00040000      /* alternative. KPI for ND6 */
#define IFEF_RESTRICTED_RECV    0x00080000      /* interface restricts inbound pkts */
#define IFEF_AWDL               0x00100000      /* Apple Wireless Direct Link */
#define IFEF_NOACKPRI           0x00200000      /* No TCP ACK prioritization */
#define IFEF_AWDL_RESTRICTED    0x00400000      /* Restricted AWDL mode */
#define IFEF_2KCL               0x00800000      /* prefers 2K cluster (socket based tunnel) */
#define IFEF_UNUSED1            0x01000000
#define IFEF_UNUSED2            0x02000000
#define IFEF_SKYWALK_NATIVE     0x04000000      /* Native Skywalk support */
#define IFEF_3CA                0x08000000      /* Capable of 3CA */
#define IFEF_SENDLIST           0x10000000      /* Supports tx packet lists */
#define IFEF_DIRECTLINK         0x20000000      /* point-to-point topology */
#define IFEF_QOSMARKING_ENABLED 0x40000000      /* QoS marking is enabled */
#define IFEF_UPDOWNCHANGE       0x80000000      /* up/down state is changing */

#ifdef XNU_KERNEL_PRIVATE
/*
 * Extra flags
 */
#define IFXF_WAKE_ON_MAGIC_PACKET       0x00000001 /* wake on magic packet */
#define IFXF_TIMESTAMP_ENABLED          0x00000002 /* time stamping enabled */
#define IFXF_NX_NOAUTO                  0x00000004 /* no auto config nexus */
#define IFXF_LEGACY                     0x00000008 /* legacy (non-netif) mode */
#define IFXF_LOW_INTERNET_UL            0x00000010 /* Uplink Low Internet is confirmed */
#define IFXF_LOW_INTERNET_DL            0x00000020 /* Downlink Low Internet is confirmed */
#define IFXF_ALLOC_KPI                  0x00000040 /* Allocated via the ifnet_alloc KPI */
#define IFXF_LOW_POWER                  0x00000080 /* Low Power Mode */
#define IFXF_MPK_LOG                    0x00000100 /* Multi-layer Packet Logging */
#define IFXF_CONSTRAINED                0x00000200 /* Constrained - Save Data Mode */
#define IFXF_LOW_LATENCY                0x00000400 /* Low latency interface */
#define IFXF_MARK_WAKE_PKT              0x00000800 /* Mark next input packet as wake packet */
#define IFXF_FAST_PKT_DELIVERY          0x00001000 /* Fast Packet Delivery */
#define IFXF_NO_TRAFFIC_SHAPING         0x00002000 /* Skip dummynet and netem traffic shaping */
#define IFXF_MANAGEMENT                 0x00004000 /* Management interface */
#define IFXF_ULTRA_CONSTRAINED          0x00008000 /* Ultra constrained mode */
#define IFXF_IS_VPN                     0x00010000 /* Is VPN */
#define IFXF_DELAYWAKEPKTEVENT          0x00020000 /* Delay notification of wake packet events */
#define IFXF_DISABLE_INPUT              0x00040000 /* Drop receive traffic */
#define IFXF_CONGESTED_LINK             0x00080000 /* Link is congested */
#define IFXF_IS_COMPANIONLINK           0x00100000 /* Is companion link */
#define IFXF_RX_FLOW_STEERING           0x00200000 /* Rx flow steering */
#define IFXF_LINK_HEURISTICS            0x00800000 /* Link heuristics enabled */
#define IFXF_LINK_HEUR_OFF_PENDING      0x01000000 /* Link heurisitics delay disable */
#define IFXF_POINTOPOINT_MDNS           0x02000000 /* Point-to-point interface supports mDNS */
#define IFXF_INBAND_WAKE_PKT_TAGGING    0x04000000 /* Inband tagging of packet wake flag */
#define IFXF_LOW_POWER_WAKE             0x08000000 /* Low Power Wake */
#define IFXF_REQUIRE_CELL_THREAD_GROUP  0x10000000 /* Require cellular thread group */

/*
 * Current requirements for an AWDL interface.  Setting/clearing IFEF_AWDL
 * will also trigger the setting/clearing of the rest of the flags.  Once
 * IFEF_AWDL is set, the rest of flags cannot be cleared, by definition.
 */
#define IFEF_AWDL_MASK \
    (IFEF_LOCALNET_PRIVATE | IFEF_IPV6_ND6ALT | IFEF_RESTRICTED_RECV | \
    IFEF_AWDL)
#endif /* XNU_KERNEL_PRIVATE */

#ifdef KERNEL_PRIVATE
/*
 * !!! NOTE !!!
 *
 * if_idle_flags definitions: (all bits are reserved for internal/future
 * use). Setting these flags MUST be done via the ifnet_set_idle_flags()
 * KPI due to the associated reference counting.  Clearing them may be done by
 * calling the KPI, otherwise implicitly at interface detach time.  Setting
 * the if_idle_flags field to a non-zero value will cause the networking
 * stack to aggressively purge expired objects (routes, etc.)
 */
#define IFRF_IDLE_NOTIFY        0x1     /* Generate notifications on idle */

/* flags set internally only: */
#define IFF_CANTCHANGE \
    (IFF_BROADCAST|IFF_POINTOPOINT|IFF_RUNNING|IFF_OACTIVE|\
	IFF_SIMPLEX|IFF_MULTICAST|IFF_ALLMULTI)

#define IF_WAKE_VALID_FLAGS IF_WAKE_ON_MAGIC_PACKET
#endif /* KERNEL_PRIVATE */

#ifdef IFREQ_OPAQUE
/*
 * This is the private version of the ifreq structure, the
 * public version lives in if.h. If you make any changes
 * here, you probably also need to make them in if.h!
 */
struct  ifreq {
	char    ifr_name[IFNAMSIZ];         /* if name, e.g. "en0" */
	union {
		struct  sockaddr ifru_addr;
		struct  sockaddr ifru_dstaddr;
		struct  sockaddr ifru_broadaddr;
		short   ifru_flags;
		int     ifru_metric;
		int     ifru_mtu;
		int     ifru_phys;
		int     ifru_media;
		int     ifru_intval;
		caddr_t ifru_data;
#ifdef KERNEL_PRIVATE
		u_int64_t ifru_data64; /* 64-bit ifru_data */
#endif /* KERNEL_PRIVATE */
		struct  ifdevmtu ifru_devmtu;
		struct  ifkpi   ifru_kpi;
		u_int32_t ifru_wake_flags;
		u_int32_t ifru_route_refcnt;
		int     ifru_link_quality_metric;
		int     ifru_cap[2];
		struct {
			uint32_t        ifo_flags;
#define IFRIFOF_BLOCK_OPPORTUNISTIC     0x00000001