1 | /* |
2 | * Copyright (c) 2012-2017 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 _NETINET_MP_PCB_H_ |
30 | #define _NETINET_MP_PCB_H_ |
31 | |
32 | #ifdef BSD_KERNEL_PRIVATE |
33 | #include <netinet/in_pcb.h> |
34 | |
35 | #include <sys/domain.h> |
36 | #include <sys/protosw.h> |
37 | #include <sys/socketvar.h> |
38 | #include <sys/types.h> |
39 | #include <sys/queue.h> |
40 | #include <kern/locks.h> |
41 | |
42 | /* Keep in sync with bsd/dev/dtrace/scripts/mptcp.d */ |
43 | typedef enum mppcb_state { |
44 | MPPCB_STATE_INUSE = 1, |
45 | MPPCB_STATE_DEAD = 2, |
46 | } mppcb_state_t; |
47 | |
48 | /* |
49 | * Multipath Protocol Control Block |
50 | */ |
51 | struct mppcb { |
52 | TAILQ_ENTRY(mppcb) mpp_entry; /* glue to all PCBs */ |
53 | decl_lck_mtx_data(, mpp_lock); /* per PCB lock */ |
54 | struct mppcbinfo *mpp_pcbinfo; /* PCB info */ |
55 | struct mptses *mpp_pcbe; /* ptr to MPTCP-session */ |
56 | struct socket *mpp_socket; /* back pointer to socket */ |
57 | uint32_t mpp_flags; /* PCB flags */ |
58 | mppcb_state_t mpp_state; /* PCB state */ |
59 | int32_t mpp_inside; /* Indicates whether or not a thread is processing MPTCP */ |
60 | |
61 | #if NECP |
62 | uuid_t necp_client_uuid; |
63 | struct inp_necp_attributes inp_necp_attributes; |
64 | void (*necp_cb)(void *, int, uint32_t, uint32_t, bool *); |
65 | #endif |
66 | }; |
67 | |
68 | static inline struct mppcb * |
69 | mpsotomppcb(struct socket *mp_so) |
70 | { |
71 | VERIFY(SOCK_DOM(mp_so) == PF_MULTIPATH); |
72 | return (struct mppcb *)mp_so->so_pcb; |
73 | } |
74 | |
75 | /* valid values for mpp_flags */ |
76 | #define MPP_ATTACHED 0x001 |
77 | #define MPP_INSIDE_OUTPUT 0x002 /* MPTCP-stack is inside mptcp_subflow_output */ |
78 | #define MPP_INSIDE_INPUT 0x004 /* MPTCP-stack is inside mptcp_subflow_input */ |
79 | #define MPP_INPUT_HANDLE 0x008 /* MPTCP-stack is handling input */ |
80 | #define MPP_WUPCALL 0x010 /* MPTCP-stack is handling a read upcall */ |
81 | #define MPP_SHOULD_WORKLOOP 0x020 /* MPTCP-stack should call the workloop function */ |
82 | #define MPP_SHOULD_RWAKEUP 0x040 /* MPTCP-stack should call sorwakeup */ |
83 | #define MPP_SHOULD_WWAKEUP 0x080 /* MPTCP-stack should call sowwakeup */ |
84 | #define MPP_CREATE_SUBFLOWS 0x100 /* This connection needs to create subflows */ |
85 | #define MPP_INSIDE_SETGETOPT 0x200 /* MPTCP-stack is inside mptcp_setopt/mptcp_getopt */ |
86 | |
87 | static inline boolean_t |
88 | mptcp_should_defer_upcall(struct mppcb *mpp) |
89 | { |
90 | return !!(mpp->mpp_flags & (MPP_INSIDE_OUTPUT | MPP_INSIDE_INPUT | MPP_INPUT_HANDLE | MPP_WUPCALL)); |
91 | } |
92 | |
93 | /* |
94 | * Multipath PCB Information |
95 | */ |
96 | struct mppcbinfo { |
97 | TAILQ_ENTRY(mppcbinfo) mppi_entry; /* glue to all PCB info */ |
98 | TAILQ_HEAD(, mppcb) mppi_pcbs; /* list of PCBs */ |
99 | uint32_t mppi_count; /* # of PCBs in list */ |
100 | lck_attr_t mppi_lock_attr; /* lock attr */ |
101 | struct mppcb *(*mppi_alloc)(void); |
102 | void (*mppi_free)(struct mppcb *); |
103 | lck_grp_t *mppi_lock_grp; /* lock grp */ |
104 | decl_lck_mtx_data(, mppi_lock); /* global PCB lock */ |
105 | uint32_t (*mppi_gc)(struct mppcbinfo *); /* garbage collector func */ |
106 | uint32_t (*mppi_timer)(struct mppcbinfo *); /* timer func */ |
107 | }; |
108 | |
109 | __BEGIN_DECLS |
110 | extern void mp_pcbinfo_attach(struct mppcbinfo *); |
111 | extern int mp_pcbinfo_detach(struct mppcbinfo *); |
112 | extern int mp_pcballoc(struct socket *, struct mppcbinfo *); |
113 | extern void mp_pcbdetach(struct socket *); |
114 | extern void mptcp_pcbdispose(struct mppcb *); |
115 | extern void mp_gc_sched(void); |
116 | extern void mptcp_timer_sched(void); |
117 | extern void mptcp_handle_deferred_upcalls(struct mppcb *mpp, uint32_t flag); |
118 | extern int mp_getsockaddr(struct socket *mp_so, struct sockaddr **nam); |
119 | extern int mp_getpeeraddr(struct socket *mp_so, struct sockaddr **nam); |
120 | #if NECP |
121 | extern int necp_client_register_multipath_cb(pid_t pid, uuid_t client_id, struct mppcb *mpp); |
122 | extern void necp_mppcb_dispose(struct mppcb *mpp); |
123 | #endif |
124 | __END_DECLS |
125 | |
126 | #endif /* BSD_KERNEL_PRIVATE */ |
127 | #endif /* !_NETINET_MP_PCB_H_ */ |
128 | |