xref: /xnu-10002.61.3/bsd/netinet/flow_divert.h (revision 0f4c859e951fba394238ab619495c4e1d54d0f34)
1 /*
2  * Copyright (c) 2012-2017, 2020, 2022 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 
36 struct flow_divert_group;
37 struct flow_divert_trie_node;
38 
39 struct 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 	uint32_t bytes_written_by_app;
53 	uint32_t bytes_read_by_app;
54 	uint32_t bytes_sent;
55 	uint32_t bytes_received;
56 	uint8_t log_level;
57 	SLIST_ENTRY(flow_divert_pcb) tmp_list_entry;
58 	mbuf_t connect_packet;
59 	uint8_t *app_data;
60 	size_t app_data_length;
61 	union sockaddr_in_4_6 local_endpoint;
62 	struct sockaddr *original_remote_endpoint;
63 	struct ifnet *original_last_outifp6;
64 	struct ifnet *original_last_outifp;
65 	uint8_t original_vflag;
66 };
67 
68 RB_HEAD(fd_pcb_tree, flow_divert_pcb);
69 
70 struct flow_divert_trie {
71 	struct flow_divert_trie_node *nodes;
72 	uint16_t *child_maps;
73 	uint8_t *bytes;
74 	void *memory;
75 	uint16_t nodes_count;
76 	uint16_t child_maps_count;
77 	uint16_t bytes_count;
78 	uint16_t nodes_free_next;
79 	uint16_t child_maps_free_next;
80 	uint16_t bytes_free_next;
81 	uint16_t root;
82 };
83 
84 struct flow_divert_group {
85 	decl_lck_rw_data(, lck);
86 	TAILQ_ENTRY(flow_divert_group) chain;
87 	struct fd_pcb_tree                          pcb_tree;
88 	uint32_t                                            ctl_unit;
89 	uint8_t                                                     atomic_bits;
90 	MBUFQ_HEAD(send_queue_head)         send_queue;
91 	uint8_t                                                     *token_key;
92 	size_t                                                      token_key_size;
93 	uint32_t                                            flags;
94 	struct flow_divert_trie                     signing_id_trie;
95 	int32_t ref_count;
96 	pid_t in_process_pid;
97 	int32_t order;
98 };
99 
100 void            flow_divert_init(void);
101 void            flow_divert_detach(struct socket *so);
102 errno_t         flow_divert_token_set(struct socket *so, struct sockopt *sopt);
103 errno_t         flow_divert_token_get(struct socket *so, struct sockopt *sopt);
104 errno_t         flow_divert_pcb_init(struct socket *so);
105 errno_t         flow_divert_connect_out(struct socket *so, struct sockaddr *to, proc_t p);
106 errno_t         flow_divert_implicit_data_out(struct socket *so, int flags, mbuf_t data, struct sockaddr *to, mbuf_t control, struct proc *p);
107 
108 #endif /* __FLOW_DIVERT_H__ */
109