xref: /xnu-12377.1.9/bsd/net/if_utun.h (revision f6217f891ac0bb64f3d375211650a4c1ff8ca1ea)

/*
 * Copyright (c) 2008-2021 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@
 */


#ifndef _NET_IF_UTUN_H_
#define _NET_IF_UTUN_H_

#include <sys/types.h>

#ifdef KERNEL_PRIVATE

#include <sys/kern_control.h>

void* utun_alloc(size_t size);
void utun_free(void *ptr);
errno_t utun_register_control(void);
#if SKYWALK
boolean_t utun_interface_needs_netagent(ifnet_t interface);
#endif /* SKYWALK */

#endif

/*
 * Name registered by the utun kernel control
 */
#define UTUN_CONTROL_NAME "com.apple.net.utun_control"

/*
 * Socket option names to manage utun
 */
#define UTUN_OPT_FLAGS                                  1
#define UTUN_OPT_IFNAME                                 2
#define UTUN_OPT_EXT_IFDATA_STATS                       3       /* get|set (type int) */
#define UTUN_OPT_INC_IFDATA_STATS_IN                    4       /* set to increment stat counters (type struct utun_stats_param) */
#define UTUN_OPT_INC_IFDATA_STATS_OUT                   5       /* set to increment stat counters (type struct utun_stats_param) */

#define UTUN_OPT_SET_DELEGATE_INTERFACE                 15      /* set the delegate interface (char[]) */
#define UTUN_OPT_MAX_PENDING_PACKETS                    16      /* the number of packets that can be waiting to be read
	                                                         * from the control socket at a time */
#define UTUN_OPT_ENABLE_CHANNEL                         17
#define UTUN_OPT_GET_CHANNEL_UUID                       18
#define UTUN_OPT_ENABLE_FLOWSWITCH                      19

#define UTUN_OPT_ENABLE_NETIF                           20      /* Must be set before connecting */
#define UTUN_OPT_SLOT_SIZE                              21      /* Must be set before connecting */
#define UTUN_OPT_NETIF_RING_SIZE                        22      /* Must be set before connecting */
#define UTUN_OPT_TX_FSW_RING_SIZE                       23      /* Must be set before connecting */
#define UTUN_OPT_RX_FSW_RING_SIZE                       24      /* Must be set before connecting */
#define UTUN_OPT_KPIPE_TX_RING_SIZE                     25      /* Must be set before connecting */
#define UTUN_OPT_KPIPE_RX_RING_SIZE                     26      /* Must be set before connecting */
#define UTUN_OPT_ATTACH_FLOWSWITCH                      27      /* Must be set before connecting */
#define UTUN_OPT_CHANNEL_BIND_UUID                      28      /* Must be set before connecting */
#define UTUN_OPT_CHANNEL_BIND_PID                       29      /* Must be set before connecting */

/*
 * Flags for by UTUN_OPT_FLAGS
 */
#define UTUN_FLAGS_NO_OUTPUT            0x0001
#define UTUN_FLAGS_NO_INPUT             0x0002
#define UTUN_FLAGS_ENABLE_PROC_UUID     0x0004

/*
 * utun stats parameter structure
 */
struct utun_stats_param {
	u_int64_t       utsp_packets;
	u_int64_t       utsp_bytes;
	u_int64_t       utsp_errors;
};

#endif