1 /*
2 * Copyright (c) 2012-2020 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_MPTCP_VAR_H_
30 #define _NETINET_MPTCP_VAR_H_
31
32 #ifdef PRIVATE
33 #include <netinet/in.h>
34 #include <netinet/tcp.h>
35 #endif
36
37 #ifdef BSD_KERNEL_PRIVATE
38 #include <sys/queue.h>
39 #include <sys/protosw.h>
40 #include <kern/locks.h>
41 #include <mach/boolean.h>
42 #include <netinet/mp_pcb.h>
43 #include <netinet/tcp_var.h>
44 #include <os/log.h>
45
46 struct mpt_itf_info {
47 uint32_t ifindex;
48 uint32_t has_v4_conn:1,
49 has_v6_conn:1,
50 has_nat64_conn:1,
51 no_mptcp_support:1;
52 };
53
54 /*
55 * MPTCP Session
56 *
57 * This is an extension to the multipath PCB specific for MPTCP, protected by
58 * the per-PCB mpp_lock (also the socket's lock);
59 */
60 struct mptses {
61 struct mppcb *mpte_mppcb; /* back ptr to multipath PCB */
62 struct mptcb *mpte_mptcb; /* ptr to MPTCP PCB */
63 TAILQ_HEAD(, mptopt) mpte_sopts; /* list of socket options */
64 TAILQ_HEAD(, mptsub) mpte_subflows; /* list of subflows */
65 #define MPTCP_MAX_NUM_SUBFLOWS 256
66 uint16_t mpte_numflows; /* # of subflows in list */
67 uint16_t mpte_nummpcapflows; /* # of MP_CAP subflows */
68 sae_associd_t mpte_associd; /* MPTCP association ID */
69 sae_connid_t mpte_connid_last; /* last used connection ID */
70
71 uint64_t mpte_time_target;
72 thread_call_t mpte_time_thread;
73 thread_call_t mpte_stop_urgency;
74
75 uint32_t mpte_last_cellicon_set;
76 uint32_t mpte_cellicon_increments;
77
78 union {
79 /* Source address of initial subflow */
80 struct sockaddr _mpte_src;
81 struct sockaddr_in _mpte_src_v4;
82 struct sockaddr_in6 _mpte_src_v6;
83 } mpte_u_src;
84 #define mpte_src mpte_u_src._mpte_src
85 #define __mpte_src_v4 mpte_u_src._mpte_src_v4
86 #define __mpte_src_v6 mpte_u_src._mpte_src_v6
87 union {
88 /* Destination address of initial subflow */
89 struct sockaddr _mpte_dst;
90 struct sockaddr_in _mpte_dst_v4;
91 struct sockaddr_in6 _mpte_dst_v6;
92 } mpte_u_dst;
93 #define mpte_dst mpte_u_dst._mpte_dst
94 #define __mpte_dst_v4 mpte_u_dst._mpte_dst_v4
95 #define __mpte_dst_v6 mpte_u_dst._mpte_dst_v6
96
97 struct sockaddr_in mpte_sub_dst_v4;
98 struct sockaddr_in6 mpte_sub_dst_v6;
99 uint8_t sub_dst_addr_id_v4;
100 uint8_t sub_dst_addr_id_v6;
101
102 uint16_t mpte_alternate_port; /* Alternate port for subflow establishment (network-byte-order) */
103
104 int mpte_epid;
105 uuid_t mpte_euuid;
106
107 struct mptsub *mpte_active_sub; /* ptr to last active subf */
108 uint16_t mpte_flags; /* per mptcp session flags */
109 #define MPTE_SND_REM_ADDR 0x01 /* Send Remove_addr option */
110 #define MPTE_SVCTYPE_CHECKED 0x02 /* Did entitlement-check for service-type */
111 #define MPTE_FIRSTPARTY 0x04 /* First-party app used multipath_extended entitlement */
112 #define MPTE_ACCESS_GRANTED 0x08 /* Access to cellular has been granted for this connection */
113 #define MPTE_FORCE_ENABLE 0x10 /* For MPTCP regardless of heuristics to detect middleboxes */
114 #define MPTE_IN_WORKLOOP 0x20 /* Are we currently inside the workloop ? */
115 #define MPTE_WORKLOOP_RELAUNCH 0x40 /* Another event got queued, we should restart the workloop */
116 #define MPTE_UNICAST_IP 0x80 /* New subflows are only being established towards the unicast IP in the ADD_ADDR */
117 #define MPTE_CELL_PROHIBITED 0x100 /* Cell access has been prohibited based on signal quality */
118 #define MPTE_FORCE_V0 0x200 /* Force MPTCP to use version 0 regradless of tcp cache */
119 #define MPTE_FORCE_V1 0x400 /* Force MPTCP to use version 1 regradless of tcp cache */
120 uint8_t mpte_svctype; /* MPTCP Service type */
121 uint8_t mpte_lost_aid; /* storing lost address id */
122 uint8_t mpte_addrid_last; /* storing address id parm */
123
124 #define MPTE_ITFINFO_SIZE 4
125 uint32_t mpte_itfinfo_size;
126 struct mpt_itf_info _mpte_itfinfo[MPTE_ITFINFO_SIZE];
127 struct mpt_itf_info *mpte_itfinfo;
128
129 struct mbuf *mpte_reinjectq;
130
131 /* The below is used for stats */
132 uint32_t mpte_subflow_switches; /* Number of subflow-switches in sending */
133 uint32_t mpte_used_cell:1,
134 mpte_used_wifi:1,
135 mpte_initial_cell:1,
136 mpte_triggered_cell,
137 mpte_handshake_success:1,
138 mpte_last_added_addr_is_v4:1;
139
140 struct mptcp_itf_stats mpte_itfstats[MPTCP_ITFSTATS_SIZE];
141 uint64_t mpte_init_txbytes __attribute__((aligned(8)));
142 uint64_t mpte_init_rxbytes __attribute__((aligned(8)));
143 };
144
145 static inline struct socket *
mptetoso(struct mptses * mpte)146 mptetoso(struct mptses *mpte)
147 {
148 return mpte->mpte_mppcb->mpp_socket;
149 }
150
151 static inline struct mptses *
mptompte(struct mppcb * mp)152 mptompte(struct mppcb *mp)
153 {
154 return (struct mptses *)mp->mpp_pcbe;
155 }
156
157 static inline struct mptses *
mpsotompte(struct socket * so)158 mpsotompte(struct socket *so)
159 {
160 return mptompte(mpsotomppcb(so));
161 }
162
163 static inline boolean_t
mpp_try_lock(struct mppcb * mp)164 mpp_try_lock(struct mppcb *mp)
165 {
166 if (!lck_mtx_try_lock(&mp->mpp_lock)) {
167 return false;
168 }
169
170 VERIFY(!(mp->mpp_flags & MPP_INSIDE_OUTPUT));
171 VERIFY(!(mp->mpp_flags & MPP_INSIDE_INPUT));
172 VERIFY(!(mp->mpp_flags & MPP_INSIDE_SETGETOPT));
173
174 return true;
175 }
176
177 static inline void
mpp_lock(struct mppcb * mp)178 mpp_lock(struct mppcb *mp)
179 {
180 lck_mtx_lock(&mp->mpp_lock);
181 VERIFY(!(mp->mpp_flags & MPP_INSIDE_OUTPUT));
182 VERIFY(!(mp->mpp_flags & MPP_INSIDE_INPUT));
183 VERIFY(!(mp->mpp_flags & MPP_INSIDE_SETGETOPT));
184 }
185
186 static inline void
mpp_unlock(struct mppcb * mp)187 mpp_unlock(struct mppcb *mp)
188 {
189 VERIFY(!(mp->mpp_flags & MPP_INSIDE_OUTPUT));
190 VERIFY(!(mp->mpp_flags & MPP_INSIDE_INPUT));
191 VERIFY(!(mp->mpp_flags & MPP_INSIDE_SETGETOPT));
192 lck_mtx_unlock(&mp->mpp_lock);
193 }
194
195 static inline lck_mtx_t *
mpp_getlock(struct mppcb * mp,int flags)196 mpp_getlock(struct mppcb *mp, int flags)
197 {
198 if (flags & PR_F_WILLUNLOCK) {
199 VERIFY(!(mp->mpp_flags & MPP_INSIDE_OUTPUT));
200 VERIFY(!(mp->mpp_flags & MPP_INSIDE_INPUT));
201 VERIFY(!(mp->mpp_flags & MPP_INSIDE_SETGETOPT));
202 }
203
204 return &mp->mpp_lock;
205 }
206
207 static inline int
mptcp_subflow_cwnd_space(struct socket * so)208 mptcp_subflow_cwnd_space(struct socket *so)
209 {
210 struct tcpcb *tp = sototcpcb(so);
211 int cwnd = (int)(MIN(tp->snd_wnd, tp->snd_cwnd) - (so->so_snd.sb_cc));
212
213 return MIN(cwnd, sbspace(&so->so_snd));
214 }
215
216 static inline bool
mptcp_subflows_need_backup_flag(struct mptses * mpte)217 mptcp_subflows_need_backup_flag(struct mptses *mpte)
218 {
219 return mpte->mpte_svctype < MPTCP_SVCTYPE_AGGREGATE ||
220 mpte->mpte_svctype == MPTCP_SVCTYPE_PURE_HANDOVER;
221 }
222
223 /*
224 * MPTCP socket options
225 */
226 struct mptopt {
227 TAILQ_ENTRY(mptopt) mpo_entry; /* glue to other options */
228 uint32_t mpo_flags; /* see flags below */
229 int mpo_level; /* sopt_level */
230 int mpo_name; /* sopt_name */
231 int mpo_intval; /* sopt_val */
232 };
233
234 #define MPOF_ATTACHED 0x1 /* attached to MP socket */
235 #define MPOF_SUBFLOW_OK 0x2 /* can be issued on subflow socket */
236 #define MPOF_INTERIM 0x4 /* has not been issued on any subflow */
237
238 /*
239 * MPTCP subflow
240 */
241 struct mptsub {
242 TAILQ_ENTRY(mptsub) mpts_entry; /* glue to peer subflows */
243 uint32_t mpts_refcnt; /* reference count */
244 uint32_t mpts_flags; /* see flags below */
245 uint32_t mpts_evctl; /* subflow control events */
246 sae_connid_t mpts_connid; /* subflow connection ID */
247 int mpts_oldintval; /* sopt_val before sosetopt */
248 struct mptses *mpts_mpte; /* back ptr to MPTCP session */
249 struct socket *mpts_socket; /* subflow socket */
250 struct sockaddr *mpts_src; /* source address */
251
252 union {
253 /* destination address */
254 struct sockaddr _mpts_dst;
255 struct sockaddr_in _mpts_dst_v4;
256 struct sockaddr_in6 _mpts_dst_v6;
257 } mpts_u_dst;
258 #define mpts_dst mpts_u_dst._mpts_dst
259 #define __mpts_dst_v4 mpts_u_dst._mpts_dst_v4
260 #define __mpts_dst_v6 mpts_u_dst._mpts_dst_v6
261 u_int32_t mpts_rel_seq; /* running count of subflow # */
262 u_int32_t mpts_iss; /* Initial sequence number, taking TFO into account */
263 u_int32_t mpts_ifscope; /* scoped to the interface */
264 uint32_t mpts_probesoon; /* send probe after probeto */
265 uint32_t mpts_probecnt; /* number of probes sent */
266 uint32_t mpts_maxseg; /* cached value of t_maxseg */
267 };
268
269 /*
270 * Valid values for mpts_flags. In particular:
271 *
272 * - MP_CAPABLE means that the connection is successfully established as
273 * MPTCP and data transfer may occur, but is not yet ready for multipath-
274 * related semantics until MP_READY. I.e. if this is on the first subflow,
275 * it causes the MPTCP socket to transition to a connected state, except
276 * that additional subflows will not be established; they will be marked
277 * with PENDING and will be processed when the first subflow is marked
278 * with MP_READY.
279 *
280 * - MP_READY implies that an MP_CAPABLE connection has been confirmed as
281 * an MPTCP connection. See notes above.
282 *
283 * - MP_DEGRADED implies that the connection has lost its MPTCP capabilities
284 * but data transfer on the MPTCP socket is unaffected. Any existing
285 * PENDING subflows will be disconnected, and further attempts to connect
286 * additional subflows will be rejected.
287 *
288 * Note that these are per-subflow flags. The setting and clearing of MP_READY
289 * reflects the state of the MPTCP connection with regards to its multipath
290 * semantics, via the MPTCPF_JOIN_READY flag. Until that flag is set (meaning
291 * until at least a subflow is marked with MP_READY), further connectx(2)
292 * attempts to join will be queued. When the flag is cleared (after it has
293 * been set), further connectx(2) will fail (and existing queued ones will be
294 * aborted) and the MPTCP connection loses all of its multipath semantics.
295 *
296 * Keep in sync with bsd/dev/dtrace/scripts/mptcp.d.
297 */
298 #define MPTSF_CONNECTING 0x00000002 /* connection was attempted */
299 #define MPTSF_CONNECT_PENDING 0x00000004 /* will connect when MPTCP is ready */
300 #define MPTSF_CONNECTED 0x00000008 /* connection is established */
301 #define MPTSF_DISCONNECTING 0x00000010 /* disconnection was attempted */
302 #define MPTSF_DISCONNECTED 0x00000020 /* has been disconnected */
303 #define MPTSF_MP_CAPABLE 0x00000040 /* connected as a MPTCP subflow */
304 #define MPTSF_MP_READY 0x00000080 /* MPTCP has been confirmed */
305 #define MPTSF_MP_DEGRADED 0x00000100 /* has lost its MPTCP capabilities */
306 #define MPTSF_PREFERRED 0x00000200 /* primary/preferred subflow */
307 #define MPTSF_SOPT_OLDVAL 0x00000400 /* old option value is valid */
308 #define MPTSF_SOPT_INPROG 0x00000800 /* sosetopt in progress */
309 #define MPTSF_FAILINGOVER 0x00001000 /* subflow not used for output */
310 #define MPTSF_ACTIVE 0x00002000 /* subflow currently in use */
311 #define MPTSF_MPCAP_CTRSET 0x00004000 /* mpcap counter */
312 #define MPTSF_CLOSED 0x00008000 /* soclose_locked has been called on this subflow */
313 #define MPTSF_TFO_REQD 0x00010000 /* TFO requested */
314 #define MPTSF_CLOSE_REQD 0x00020000 /* A close has been requested from NECP */
315 #define MPTSF_INITIAL_SUB 0x00040000 /* This is the initial subflow */
316 #define MPTSF_READ_STALL 0x00080000 /* A read-stall has been detected */
317 #define MPTSF_WRITE_STALL 0x00100000 /* A write-stall has been detected */
318 #define MPTSF_FULLY_ESTABLISHED 0x00200000 /* Subflow is fully established and it has been confirmed
319 * whether or not it supports MPTCP.
320 * No need for further middlebox-detection.
321 */
322 #define MPTSF_CELLICON_SET 0x00400000 /* This subflow set the cellicon */
323
324 /*
325 * MPTCP states
326 * Keep in sync with bsd/dev/dtrace/scripts/mptcp.d
327 */
328 typedef enum mptcp_state {
329 MPTCPS_CLOSED = 0, /* closed */
330 MPTCPS_LISTEN = 1, /* not yet implemented */
331 MPTCPS_ESTABLISHED = 2, /* MPTCP connection established */
332 MPTCPS_CLOSE_WAIT = 3, /* rcvd DFIN, waiting for close */
333 MPTCPS_FIN_WAIT_1 = 4, /* have closed, sent DFIN */
334 MPTCPS_CLOSING = 5, /* closed xchd DFIN, waiting DFIN ACK */
335 MPTCPS_LAST_ACK = 6, /* had DFIN and close; await DFIN ACK */
336 MPTCPS_FIN_WAIT_2 = 7, /* have closed, DFIN is acked */
337 MPTCPS_TIME_WAIT = 8, /* in 2*MSL quiet wait after close */
338 MPTCPS_TERMINATE = 9, /* terminal state */
339 } mptcp_state_t;
340
341 /*
342 * WiFi Quality states from MPTCP's perspective
343 */
344 typedef enum mptcp_wifi_quality {
345 MPTCP_WIFI_QUALITY_GOOD,
346 MPTCP_WIFI_QUALITY_BAD,
347 MPTCP_WIFI_QUALITY_UNSURE,
348 } mptcp_wifi_quality_t;
349
350 typedef u_int64_t mptcp_key_t;
351 typedef u_int32_t mptcp_token_t;
352 typedef u_int8_t mptcp_addr_id;
353
354
355 /* Address ID list */
356 struct mptcp_subf_auth_entry {
357 LIST_ENTRY(mptcp_subf_auth_entry) msae_next;
358 u_int32_t msae_laddr_rand; /* Local nonce */
359 u_int32_t msae_raddr_rand; /* Remote nonce */
360 mptcp_addr_id msae_laddr_id; /* Local addr ID */
361 mptcp_addr_id msae_raddr_id; /* Remote addr ID */
362 };
363
364 /*
365 * MPTCP Protocol Control Block
366 *
367 * Protected by per-MPTCP mpt_lock.
368 * Keep in sync with bsd/dev/dtrace/scripts/mptcp.d.
369 */
370 struct mptcb {
371 struct mptses *mpt_mpte; /* back ptr to MPTCP session */
372 mptcp_state_t mpt_state; /* MPTCP state */
373 uint32_t mpt_flags; /* see flags below */
374 uint8_t mpt_version; /* MPTCP proto version */
375 u_short mpt_softerror; /* error not yet reported */
376 /*
377 * Authentication and metadata invariants
378 */
379 mptcp_key_t mpt_localkey; /* in network byte order */
380 mptcp_key_t mpt_remotekey; /* in network byte order */
381 mptcp_token_t mpt_localtoken; /* HMAC SHA1 of local key */
382 mptcp_token_t mpt_remotetoken; /* HMAC SHA1 of remote key */
383
384 /*
385 * Timer vars for scenarios where subflow level acks arrive, but
386 * Data ACKs do not.
387 */
388 int mpt_rxtshift; /* num of consecutive retrans */
389 uint64_t mpt_rxtstart; /* time at which rxt started */
390 uint64_t mpt_rtseq; /* seq # being tracked */
391 uint64_t mpt_timewait; /* timewait */
392 uint32_t mpt_timer_vals; /* timer related values */
393 /*
394 * Sending side
395 */
396 uint64_t mpt_snduna; /* DSN of last unacked byte */
397 uint64_t mpt_sndnxt; /* DSN of next byte to send */
398 uint64_t mpt_sndmax; /* DSN of max byte sent */
399 uint64_t mpt_local_idsn; /* First byte's DSN */
400 uint32_t mpt_sndwnd;
401 uint64_t mpt_sndwl1;
402 uint64_t mpt_sndwl2;
403 /*
404 * Receiving side
405 */
406 uint64_t mpt_rcvnxt; /* Next expected DSN */
407 uint64_t mpt_remote_idsn; /* Peer's IDSN */
408 uint64_t mpt_rcvadv;
409 uint32_t mpt_rcvwnd;
410 LIST_HEAD(, mptcp_subf_auth_entry) mpt_subauth_list; /* address IDs */
411 /*
412 * Fastclose
413 */
414 uint64_t mpt_dsn_at_csum_fail; /* MPFail Opt DSN */
415 uint32_t mpt_ssn_at_csum_fail; /* MPFail Subflow Seq */
416 /*
417 * Zombie handling
418 */
419 #define MPT_GC_TICKS (30)
420 #define MPT_GC_TICKS_FAST (10)
421 int32_t mpt_gc_ticks; /* Used for zombie deletion */
422
423 uint32_t mpt_notsent_lowat; /* TCP_NOTSENT_LOWAT support */
424
425 struct tsegqe_head mpt_segq;
426 uint32_t mpt_reassqlen; /* length of reassembly queue */
427 };
428
429 /* valid values for mpt_flags (see also notes on mpts_flags above) */
430 #define MPTCPF_CHECKSUM 0x001 /* checksum DSS option */
431 #define MPTCPF_FALLBACK_TO_TCP 0x002 /* Fallback to TCP */
432 #define MPTCPF_JOIN_READY 0x004 /* Ready to start 2 or more subflows */
433 #define MPTCPF_RECVD_MPFAIL 0x008 /* Received MP_FAIL option */
434 #define MPTCPF_SND_64BITDSN 0x010 /* Send full 64-bit DSN */
435 #define MPTCPF_SND_64BITACK 0x020 /* Send 64-bit ACK response */
436 #define MPTCPF_RCVD_64BITACK 0x040 /* Received 64-bit Data ACK */
437 #define MPTCPF_POST_FALLBACK_SYNC 0x080 /* Post fallback resend data */
438 #define MPTCPF_FALLBACK_HEURISTIC 0x100 /* Send SYN without MP_CAPABLE due to heuristic */
439 #define MPTCPF_HEURISTIC_TRAC 0x200 /* Tracked this connection in the heuristics as a failure */
440 #define MPTCPF_REASS_INPROG 0x400 /* Reassembly is in progress */
441
442 /* valid values for mpt_timer_vals */
443 #define MPTT_REXMT 0x01 /* Starting Retransmit Timer */
444 #define MPTT_TW 0x02 /* Starting Timewait Timer */
445 #define MPTT_FASTCLOSE 0x04 /* Starting Fastclose wait timer */
446
447 /* events for close FSM */
448 #define MPCE_CLOSE 0x1
449 #define MPCE_RECV_DATA_ACK 0x2
450 #define MPCE_RECV_DATA_FIN 0x4
451
452 /* mptcb manipulation */
453 static inline struct mptcb *
tptomptp(struct tcpcb * tp)454 tptomptp(struct tcpcb *tp)
455 {
456 return tp->t_mptcb;
457 }
458
459 /*
460 * MPTCP control block and state structures are allocated along with
461 * the MP protocol control block; the folllowing represents the layout.
462 */
463 struct mpp_mtp {
464 struct mppcb mpp; /* Multipath PCB */
465 struct mptses mpp_ses; /* MPTCP session */
466 struct mptcb mtcb; /* MPTCP PCB */
467 };
468
469 #ifdef SYSCTL_DECL
470 SYSCTL_DECL(_net_inet_mptcp);
471 #endif /* SYSCTL_DECL */
472
473 extern struct mppcbinfo mtcbinfo;
474 extern struct pr_usrreqs mptcp_usrreqs;
475 extern os_log_t mptcp_log_handle;
476
477 /* Encryption algorithm related definitions */
478 #define HMAC_TRUNCATED_SYNACK 8
479 #define HMAC_TRUNCATED_ACK 20
480 #define HMAC_TRUNCATED_ADD_ADDR 8
481
482 /* Mask to obtain 32-bit portion of data sequence number */
483 #define MPTCP_DATASEQ_LOW32_MASK (0xffffffff)
484 #define MPTCP_DATASEQ_LOW32(seq) (seq & MPTCP_DATASEQ_LOW32_MASK)
485
486 /* Mask to obtain upper 32-bit portion of data sequence number */
487 #define MPTCP_DATASEQ_HIGH32_MASK (0xffffffff00000000)
488 #define MPTCP_DATASEQ_HIGH32(seq) (seq & MPTCP_DATASEQ_HIGH32_MASK)
489
490 /* Mask to obtain 32-bit portion of data ack */
491 #define MPTCP_DATAACK_LOW32_MASK (0xffffffff)
492 #define MPTCP_DATAACK_LOW32(ack) (ack & MPTCP_DATAACK_LOW32_MASK)
493
494 /*
495 * x is the 64-bit data sequence number, y the 32-bit data seq number to be
496 * extended. z is y extended to the appropriate 64-bit value.
497 * This algorithm is based on the fact that subflow level window sizes are
498 * at the maximum 2**30 (in reality, they are a lot lesser). A high throughput
499 * application sending on a large number of subflows can in theory have very
500 * large MPTCP level send and receive windows. In which case, 64 bit DSNs
501 * must be sent in place of 32 bit DSNs on wire. For us, with 2 subflows at
502 * 512K each, sequence wraparound detection can be done by checking whether
503 * the 32-bit value obtained on wire is 2**31 bytes apart from the stored
504 * lower 32-bits of the Data Sequence Number. Bogus DSNs are dropped by
505 * comparing against rwnd. Bogus DSNs within rwnd cannot be protected against
506 * and are as weak as bogus TCP sequence numbers.
507 */
508 #define MPTCP_EXTEND_DSN(x, y, z) { \
509 if ((MPTCP_DATASEQ_LOW32(x) > y) && \
510 ((((u_int32_t)MPTCP_DATASEQ_LOW32(x)) - (u_int32_t)y) >= \
511 (u_int32_t)(1U << 31))) { \
512 /* \
513 * y wrapped around and x and y are 2**31 bytes apart \
514 */ \
515 z = MPTCP_DATASEQ_HIGH32(x) + 0x100000000; \
516 z |= y; \
517 } else if ((MPTCP_DATASEQ_LOW32(x) < y) && \
518 (((u_int32_t)y - \
519 ((u_int32_t)MPTCP_DATASEQ_LOW32(x))) >= \
520 (u_int32_t)(1U << 31))) { \
521 /* \
522 * x wrapped around and x and y are 2**31 apart \
523 */ \
524 z = MPTCP_DATASEQ_HIGH32(x) - 0x100000000; \
525 z |= y; \
526 } else { \
527 z = MPTCP_DATASEQ_HIGH32(x) | y; \
528 } \
529 }
530
531 extern int mptcp_enable; /* Multipath TCP */
532 extern int mptcp_mpcap_retries; /* Multipath TCP retries */
533 extern int mptcp_join_retries; /* Multipath TCP Join retries */
534 extern int mptcp_dss_csum; /* Multipath DSS Option checksum */
535 extern int mptcp_fail_thresh; /* Multipath failover thresh of retransmits */
536 extern int mptcp_subflow_keeptime; /* Multipath subflow TCP_KEEPALIVE opt */
537 extern int mptcp_developer_mode; /* Allow aggregation mode */
538 extern uint32_t mptcp_cellicon_refcount;
539 extern uint32_t mptcp_enable_v1;
540
541 #define MPTCP_CELLICON_TOGGLE_RATE (5 * TCP_RETRANSHZ) /* Only toggle every 5 seconds */
542
543 extern int tcp_jack_rxmt; /* Join ACK retransmission value in msecs */
544
545 extern int mptcp_reass_total_qlen;
546
547 __BEGIN_DECLS
548 extern void mptcp_init(struct protosw *, struct domain *);
549 extern int mptcp_ctloutput(struct socket *, struct sockopt *);
550 extern int mptcp_session_create(struct mppcb *);
551 extern boolean_t mptcp_ok_to_create_subflows(struct mptcb *mp_tp);
552 extern void mptcp_check_subflows_and_add(struct mptses *mpte);
553 extern void mptcp_check_subflows_and_remove(struct mptses *mpte);
554 extern void mptcpstats_inc_switch(struct mptses *mpte, const struct mptsub *mpts);
555 extern void mptcpstats_update(struct mptcp_itf_stats *stats, const struct mptsub *mpts);
556 extern int mptcpstats_get_index_by_ifindex(struct mptcp_itf_stats *stats, u_short ifindex, boolean_t create);
557 extern struct mptses *mptcp_drop(struct mptses *mpte, struct mptcb *mp_tp, u_short errno);
558 extern struct mptses *mptcp_close(struct mptses *, struct mptcb *);
559 extern int mptcp_lock(struct socket *, int, void *);
560 extern int mptcp_unlock(struct socket *, int, void *);
561 extern lck_mtx_t *mptcp_getlock(struct socket *, int);
562 extern void mptcp_subflow_workloop(struct mptses *);
563
564 extern void mptcp_sched_create_subflows(struct mptses *);
565
566 extern void mptcp_finish_usrclosed(struct mptses *mpte);
567 extern struct mptopt *mptcp_sopt_alloc(zalloc_flags_t);
568 extern const char *mptcp_sopt2str(int, int);
569 extern void mptcp_sopt_free(struct mptopt *);
570 extern void mptcp_sopt_insert(struct mptses *, struct mptopt *);
571 extern void mptcp_sopt_remove(struct mptses *, struct mptopt *);
572 extern struct mptopt *mptcp_sopt_find(struct mptses *, struct sockopt *);
573
574 extern int mptcp_subflow_add(struct mptses *, struct sockaddr *,
575 struct sockaddr *, uint32_t, sae_connid_t *);
576 extern void mptcp_subflow_del(struct mptses *, struct mptsub *);
577
578 extern void mptcp_handle_input(struct socket *so);
579 #define MPTCP_SUBOUT_PROBING 0x01
580 extern int mptcp_subflow_output(struct mptses *mpte, struct mptsub *mpts, int flags);
581 extern void mptcp_clean_reinjectq(struct mptses *mpte);
582 extern void mptcp_subflow_shutdown(struct mptses *, struct mptsub *);
583 extern void mptcp_subflow_disconnect(struct mptses *, struct mptsub *);
584 extern int mptcp_subflow_sosetopt(struct mptses *, struct mptsub *,
585 struct mptopt *);
586 extern int mptcp_subflow_sogetopt(struct mptses *, struct socket *,
587 struct mptopt *);
588
589 extern void mptcp_input(struct mptses *, struct mbuf *);
590 extern boolean_t mptcp_can_send_more(struct mptcb *mp_tp, boolean_t ignore_reinject);
591 extern int mptcp_output(struct mptses *);
592 extern void mptcp_close_fsm(struct mptcb *, uint32_t);
593
594 extern void mptcp_hmac_sha1(mptcp_key_t, mptcp_key_t, u_int32_t, u_int32_t,
595 u_char*);
596 extern void mptcp_hmac_sha256(mptcp_key_t, mptcp_key_t, u_char*, uint16_t,
597 u_char*);
598 extern void mptcp_get_mpjoin_hmac(mptcp_addr_id, struct mptcb *, u_char *, uint8_t);
599 extern void mptcp_get_rands(mptcp_addr_id, struct mptcb *, u_int32_t *,
600 u_int32_t *);
601 extern void mptcp_set_raddr_rand(mptcp_addr_id, struct mptcb *, mptcp_addr_id,
602 u_int32_t);
603 extern int mptcp_init_remote_parms(struct mptcb *);
604 extern boolean_t mptcp_ok_to_keepalive(struct mptcb *);
605 extern void mptcp_insert_dsn(struct mppcb *, struct mbuf *);
606 extern void mptcp_output_getm_dsnmap32(struct socket *so, int off,
607 uint32_t *dsn, uint32_t *relseq,
608 uint16_t *data_len, uint16_t *dss_csum);
609 extern void mptcp_output_getm_dsnmap64(struct socket *so, int off,
610 uint64_t *dsn, uint32_t *relseq,
611 uint16_t *data_len, uint16_t *dss_csum);
612 extern void mptcp_output_getm_data_level_details(struct socket *so, int off,
613 uint16_t *data_len, uint16_t *dss_csum);
614 extern void mptcp_act_on_txfail(struct socket *);
615 extern struct mptsub *mptcp_get_subflow(struct mptses *mpte, struct mptsub **preferred);
616 extern int mptcp_get_map_for_dsn(struct socket *so, uint64_t dsn_fail, uint32_t *tcp_seq);
617 extern int32_t mptcp_adj_sendlen(struct socket *so, int32_t off);
618 extern void mptcp_sbrcv_grow(struct mptcb *mp_tp);
619 extern int32_t mptcp_sbspace(struct mptcb *);
620 extern void mptcp_notify_mpready(struct socket *);
621 extern void mptcp_notify_mpfail(struct socket *);
622 extern void mptcp_notify_close(struct socket *);
623 extern boolean_t mptcp_no_rto_spike(struct socket*);
624 extern int mptcp_set_notsent_lowat(struct mptses *mpte, int optval);
625 extern u_int32_t mptcp_get_notsent_lowat(struct mptses *mpte);
626 extern int mptcp_notsent_lowat_check(struct socket *so);
627 extern void mptcp_ask_symptoms(struct mptses *mpte);
628 extern void mptcp_control_register(void);
629 extern mptcp_wifi_quality_t mptcp_wifi_quality_for_session(struct mptses *mpte);
630 extern boolean_t symptoms_is_wifi_lossy(void);
631 extern void mptcp_session_necp_cb(void *, int, uint32_t, uint32_t, bool *);
632 extern struct sockaddr *mptcp_get_session_dst(struct mptses *mpte,
633 boolean_t has_v6, boolean_t has_v4);
634 extern void mptcp_set_restrictions(struct socket *mp_so);
635 extern void mptcp_clear_cellicon(void);
636 extern void mptcp_unset_cellicon(struct mptses *mpte, struct mptsub *mpts, uint32_t val);
637 extern void mptcp_reset_rexmit_state(struct tcpcb *tp);
638 extern void mptcp_reset_keepalive(struct tcpcb *tp);
639 extern int mptcp_validate_csum(struct tcpcb *tp, struct mbuf *m, uint64_t dsn,
640 uint32_t sseq, uint16_t dlen, uint16_t csum, int dfin);
641 __END_DECLS
642
643 #endif /* BSD_KERNEL_PRIVATE */
644 #ifdef PRIVATE
645
646 typedef struct mptcp_flow {
647 uint64_t flow_len;
648 uint64_t flow_tcpci_offset;
649 uint32_t flow_flags;
650 sae_connid_t flow_cid;
651 struct sockaddr_storage flow_src;
652 struct sockaddr_storage flow_dst;
653 uint32_t flow_relseq; /* last subflow rel seq# */
654 int32_t flow_soerror; /* subflow level error */
655 uint32_t flow_probecnt; /* number of probes sent */
656 conninfo_tcp_t flow_ci; /* must be the last field */
657 } mptcp_flow_t;
658
659 typedef struct conninfo_mptcp {
660 uint64_t mptcpci_len;
661 uint64_t mptcpci_flow_offset; /* offsetof first flow */
662 uint64_t mptcpci_nflows; /* number of subflows */
663 uint32_t mptcpci_state; /* MPTCP level state */
664 uint32_t mptcpci_mpte_flags; /* Session flags */
665 uint32_t mptcpci_flags; /* MPTCB flags */
666 uint32_t mptcpci_ltoken; /* local token */
667 uint32_t mptcpci_rtoken; /* remote token */
668 uint32_t mptcpci_notsent_lowat; /* NOTSENT_LOWAT */
669
670 /* Send side */
671 uint64_t mptcpci_snduna; /* DSN of last unacked byte */
672 uint64_t mptcpci_sndnxt; /* DSN of next byte to send */
673 uint64_t mptcpci_sndmax; /* DSN of max byte sent */
674 uint64_t mptcpci_lidsn; /* Local IDSN */
675 uint32_t mptcpci_sndwnd; /* Send window snapshot */
676
677 /* Receive side */
678 uint64_t mptcpci_rcvnxt; /* Next expected DSN */
679 uint64_t mptcpci_rcvatmark; /* Session level rcvnxt */
680 uint64_t mptcpci_ridsn; /* Peer's IDSN */
681 uint32_t mptcpci_rcvwnd; /* Receive window */
682
683 uint8_t mptcpci_mpte_addrid; /* last addr id */
684
685 mptcp_flow_t mptcpci_flows[1];
686 } conninfo_mptcp_t;
687
688 /* Use SymptomsD notifications of wifi and cell status in subflow selection */
689 #define MPTCP_KERN_CTL_NAME "com.apple.network.advisory"
690 typedef struct symptoms_advisory {
691 union {
692 uint32_t sa_nwk_status_int;
693 struct {
694 union {
695 #define SYMPTOMS_ADVISORY_NOCOMMENT 0x0000
696 #define SYMPTOMS_ADVISORY_USEAPP 0xFFFF /* Very ugly workaround to avoid breaking backwards compatibility - ToDo: Fix it in +1 */
697 uint16_t sa_nwk_status;
698 struct {
699 #define SYMPTOMS_ADVISORY_WIFI_BAD 0x01
700 #define SYMPTOMS_ADVISORY_WIFI_OK 0x02
701 uint8_t sa_wifi_status;
702 #define SYMPTOMS_ADVISORY_CELL_BAD 0x01
703 #define SYMPTOMS_ADVISORY_CELL_OK 0x02
704 uint8_t sa_cell_status;
705 };
706 };
707 uint16_t sa_unused;
708 };
709 };
710 } symptoms_advisory_t;
711
712 #define MPTCP_TARGET_BASED_RSSI_THRESHOLD -75
713 struct mptcp_symptoms_answer {
714 struct symptoms_advisory advisory;
715 uuid_t uuid;
716 int32_t rssi;
717 };
718
719 struct mptcp_symptoms_ask_uuid {
720 uint32_t cmd;
721 #define MPTCP_SYMPTOMS_ASK_UUID 1
722 uuid_t uuid;
723 uint32_t priority;
724 #define MPTCP_SYMPTOMS_UNKNOWN 0
725 #define MPTCP_SYMPTOMS_BACKGROUND 1
726 #define MPTCP_SYMPTOMS_FOREGROUND 2
727 };
728
729 struct kev_mptcp_data {
730 int value;
731 };
732
733 #endif /* PRIVATE */
734 #endif /* _NETINET_MPTCP_VAR_H_ */
735