[apple/xnu.git] / bsd / netinet / flow_divert.h

/*
 * Copyright (c) 2012-2017 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 __FLOW_DIVERT_H__
#define __FLOW_DIVERT_H__

#include <sys/mbuf.h>

struct flow_divert_group;
struct flow_divert_trie_node;

struct flow_divert_pcb {
	decl_lck_mtx_data(, mtx);
	socket_t                                            so;
	RB_ENTRY(flow_divert_pcb)           rb_link;
	uint32_t                                            hash;
	mbuf_t                                                      connect_token;
	struct sockaddr                                     *local_address;
	struct sockaddr                                     *remote_address;
	uint32_t                                            flags;
	uint32_t                                            send_window;
	uint32_t                                            sb_size;
	struct flow_divert_group            *group;
	uint32_t                                            control_group_unit;
	int32_t                                                     ref_count;
	uint32_t                                            bytes_written_by_app;
	uint32_t                                            bytes_read_by_app;
	uint32_t                                            bytes_sent;
	uint32_t                                            bytes_received;
	uint8_t                                                     log_level;
	SLIST_ENTRY(flow_divert_pcb)        tmp_list_entry;
	mbuf_t                                                      connect_packet;
	uint8_t                                                     *app_data;
	size_t                                                      app_data_length;
};

RB_HEAD(fd_pcb_tree, flow_divert_pcb);

struct flow_divert_trie {
	struct flow_divert_trie_node *nodes;
	uint16_t *child_maps;
	uint8_t *bytes;
	void *memory;
	size_t nodes_count;
	size_t child_maps_count;
	size_t bytes_count;
	size_t nodes_free_next;
	size_t child_maps_free_next;
	size_t bytes_free_next;
	uint16_t root;
};

struct flow_divert_group {
	decl_lck_rw_data(, lck);
	struct fd_pcb_tree                          pcb_tree;
	uint32_t                                            ctl_unit;
	uint8_t                                                     atomic_bits;
	MBUFQ_HEAD(send_queue_head)         send_queue;
	uint8_t                                                     *token_key;
	size_t                                                      token_key_size;
	uint32_t                                            flags;
	struct flow_divert_trie                     signing_id_trie;
};

void            flow_divert_init(void);
void            flow_divert_detach(struct socket *so);
errno_t         flow_divert_token_set(struct socket *so, struct sockopt *sopt);
errno_t         flow_divert_token_get(struct socket *so, struct sockopt *sopt);
errno_t         flow_divert_pcb_init(struct socket *so, uint32_t ctl_unit);
errno_t         flow_divert_connect_out(struct socket *so, struct sockaddr *to, proc_t p);
errno_t         flow_divert_implicit_data_out(struct socket *so, int flags, mbuf_t data, struct sockaddr *to, mbuf_t control, struct proc *p);

#endif /* __FLOW_DIVERT_H__ */
Commit	Line	Data
39236c6e	1	/*
5ba3f43e	2	* Copyright (c) 2012-2017 Apple Inc. All rights reserved.
39236c6e A	3	*
39236c6e A	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
0a7de745	5	*
39236c6e A	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.
0a7de745	14	*
39236c6e A	15	* Please obtain a copy of the License at
39236c6e A	16	* http://www.opensource.apple.com/apsl/ and read it before using this file.
0a7de745	17	*
39236c6e A	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.
0a7de745	25	*
39236c6e A	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	struct flow_divert_group;
39037602	35	struct flow_divert_trie_node;
39236c6e A	36
39236c6e A	37	struct flow_divert_pcb {
0a7de745 A	38	decl_lck_mtx_data(, mtx);
	39	socket_t so;
	40	RB_ENTRY(flow_divert_pcb) rb_link;
	41	uint32_t hash;
	42	mbuf_t connect_token;
	43	struct sockaddr *local_address;
	44	struct sockaddr *remote_address;
	45	uint32_t flags;
	46	uint32_t send_window;
	47	uint32_t sb_size;
	48	struct flow_divert_group *group;
	49	uint32_t control_group_unit;
	50	int32_t ref_count;
	51	uint32_t bytes_written_by_app;
	52	uint32_t bytes_read_by_app;
	53	uint32_t bytes_sent;
	54	uint32_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;
39236c6e A	60	};
	61
	62	RB_HEAD(fd_pcb_tree, flow_divert_pcb);
	63
0a7de745	64	struct flow_divert_trie {
39037602 A	65	struct flow_divert_trie_node *nodes;
	66	uint16_t *child_maps;
	67	uint8_t *bytes;
	68	void *memory;
	69	size_t nodes_count;
	70	size_t child_maps_count;
	71	size_t bytes_count;
	72	size_t nodes_free_next;
	73	size_t child_maps_free_next;
	74	size_t bytes_free_next;
	75	uint16_t root;
	76	};
	77
39236c6e	78	struct flow_divert_group {
0a7de745 A	79	decl_lck_rw_data(, lck);
	80	struct fd_pcb_tree pcb_tree;
	81	uint32_t ctl_unit;
	82	uint8_t atomic_bits;
	83	MBUFQ_HEAD(send_queue_head) send_queue;
	84	uint8_t *token_key;
	85	size_t token_key_size;
	86	uint32_t flags;
	87	struct flow_divert_trie signing_id_trie;
39236c6e A	88	};
39236c6e A	89
0a7de745 A	90	void flow_divert_init(void);
	91	void flow_divert_detach(struct socket *so);
	92	errno_t flow_divert_token_set(struct socket so, struct sockopt sopt);
	93	errno_t flow_divert_token_get(struct socket so, struct sockopt sopt);
	94	errno_t flow_divert_pcb_init(struct socket *so, uint32_t ctl_unit);
	95	errno_t flow_divert_connect_out(struct socket so, struct sockaddr to, proc_t p);
	96	errno_t flow_divert_implicit_data_out(struct socket so, int flags, mbuf_t data, struct sockaddr to, mbuf_t control, struct proc *p);
39236c6e A	97
39236c6e A	98	#endif /* __FLOW_DIVERT_H__ */