1/*
2 * Copyright (c) 2008-2021, 2025 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
30#ifndef _NET_IF_UTUN_H_
31#define _NET_IF_UTUN_H_
32
33#include <sys/types.h>
34
35
36/*
37 * Name registered by the utun kernel control
38 */
39#define UTUN_CONTROL_NAME "com.apple.net.utun_control"
40
41/*
42 * Socket option names to manage utun
43 */
44#define UTUN_OPT_FLAGS 1
45#define UTUN_OPT_IFNAME 2
46#define UTUN_OPT_EXT_IFDATA_STATS 3 /* get|set (type int) */
47#define UTUN_OPT_INC_IFDATA_STATS_IN 4 /* set to increment stat counters (type struct utun_stats_param) */
48#define UTUN_OPT_INC_IFDATA_STATS_OUT 5 /* set to increment stat counters (type struct utun_stats_param) */
49
50#define UTUN_OPT_SET_DELEGATE_INTERFACE 15 /* set the delegate interface (char[]) */
51#define UTUN_OPT_MAX_PENDING_PACKETS 16 /* the number of packets that can be waiting to be read
52 * from the control socket at a time */
53#define UTUN_OPT_ENABLE_CHANNEL 17
54#define UTUN_OPT_GET_CHANNEL_UUID 18
55#define UTUN_OPT_ENABLE_FLOWSWITCH 19
56
57#define UTUN_OPT_ENABLE_NETIF 20 /* Must be set before connecting */
58#define UTUN_OPT_SLOT_SIZE 21 /* Must be set before connecting */
59#define UTUN_OPT_NETIF_RING_SIZE 22 /* Must be set before connecting */
60#define UTUN_OPT_TX_FSW_RING_SIZE 23 /* Must be set before connecting */
61#define UTUN_OPT_RX_FSW_RING_SIZE 24 /* Must be set before connecting */
62#define UTUN_OPT_KPIPE_TX_RING_SIZE 25 /* Must be set before connecting */
63#define UTUN_OPT_KPIPE_RX_RING_SIZE 26 /* Must be set before connecting */
64#define UTUN_OPT_ATTACH_FLOWSWITCH 27 /* Must be set before connecting */
65#define UTUN_OPT_CHANNEL_BIND_UUID 28 /* Must be set before connecting */
66#define UTUN_OPT_CHANNEL_BIND_PID 29 /* Must be set before connecting */
67#define UTUN_OPT_USER_PACKET_POOL 30 /* Must be set before connecting */
68#define UTUN_OPT_RX_FLOW_STEERING_AUTO 31 /* set/get (type int) */
69#define UTUN_OPT_LOW_POWER_WAKE 32 /* set/get (type int) */
70
71/*
72 * Flags for by UTUN_OPT_FLAGS
73 */
74#define UTUN_FLAGS_NO_OUTPUT 0x0001
75#define UTUN_FLAGS_NO_INPUT 0x0002
76#define UTUN_FLAGS_ENABLE_PROC_UUID 0x0004
77
78/*
79 * utun stats parameter structure
80 */
81struct utun_stats_param {
82 u_int64_t utsp_packets;
83 u_int64_t utsp_bytes;
84 u_int64_t utsp_errors;
85};
86
87#endif