1/*
2 * Copyright (c) 2012-2017, 2020, 2022, 2024 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#ifndef __FLOW_DIVERT_H__
30#define __FLOW_DIVERT_H__
31
32#include <sys/mbuf.h>
33
34#define FLOW_DIVERT_ORDER_LAST INT_MAX
35
36struct flow_divert_group;
37struct flow_divert_trie_node;
38
39struct flow_divert_pcb {
40 decl_lck_mtx_data(, mtx);
41 socket_t so;
42 RB_ENTRY(flow_divert_pcb) rb_link;
43 uint32_t hash;
44 mbuf_t connect_token;
45 uint32_t flags;
46 uint32_t send_window;
47 struct flow_divert_group *group;
48 uint32_t control_group_unit;
49 uint32_t aggregate_unit;
50 uint32_t policy_control_unit;
51 int32_t ref_count;
52 uint64_t bytes_written_by_app;
53 uint64_t bytes_sent;
54 uint64_t bytes_received;
55 uint8_t log_level;
56 SLIST_ENTRY(flow_divert_pcb) tmp_list_entry;
57 mbuf_t connect_packet;
58 uint8_t *app_data;
59 size_t app_data_length;
60 union sockaddr_in_4_6 local_endpoint;
61 struct sockaddr *original_remote_endpoint;
62 struct ifnet *original_last_outifp6;
63 struct ifnet *original_last_outifp;
64 uint8_t original_vflag;
65};
66
67RB_HEAD(fd_pcb_tree, flow_divert_pcb);
68
69struct flow_divert_trie {
70 struct flow_divert_trie_node *nodes;
71 uint16_t *child_maps;
72 uint8_t *bytes;
73 void *memory;
74 uint16_t nodes_count;
75 uint16_t child_maps_count;
76 uint16_t bytes_count;
77 uint16_t nodes_free_next;
78 uint16_t child_maps_free_next;
79 uint16_t bytes_free_next;
80 uint16_t root;
81};
82
83struct flow_divert_group {
84 decl_lck_rw_data(, lck);
85 TAILQ_ENTRY(flow_divert_group) chain;
86 struct fd_pcb_tree pcb_tree;
87 uint32_t ctl_unit;
88 uint8_t atomic_bits;
89 MBUFQ_HEAD(send_queue_head) send_queue;
90 uint8_t *token_key;
91 size_t token_key_size;
92 uint32_t flags;
93 struct flow_divert_trie signing_id_trie;
94 int32_t ref_count;
95 pid_t in_process_pid;
96 int32_t order;
97};
98
99void flow_divert_init(void);
100void flow_divert_detach(struct socket *so);
101errno_t flow_divert_token_set(struct socket *so, struct sockopt *sopt);
102errno_t flow_divert_token_get(struct socket *so, struct sockopt *sopt);
103errno_t flow_divert_pcb_init(struct socket *so);
104errno_t flow_divert_connect_out(struct socket *so, struct sockaddr *to, proc_t p);
105errno_t flow_divert_implicit_data_out(struct socket *so, int flags, mbuf_t data, struct sockaddr *to, mbuf_t control, struct proc *p);
106
107#endif /* __FLOW_DIVERT_H__ */
108