[mirror_ubuntu-jammy-kernel.git] / include / net / mptcp.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * Multipath TCP
 *
 * Copyright (c) 2017 - 2019, Intel Corporation.
 */

#ifndef __NET_MPTCP_H
#define __NET_MPTCP_H

#include <linux/skbuff.h>
#include <linux/tcp.h>
#include <linux/types.h>

struct seq_file;

/* MPTCP sk_buff extension data */
struct mptcp_ext {
	union {
		u64	data_ack;
		u32	data_ack32;
	};
	u64		data_seq;
	u32		subflow_seq;
	u16		data_len;
	__sum16		csum;
	u8		use_map:1,
			dsn64:1,
			data_fin:1,
			use_ack:1,
			ack64:1,
			mpc_map:1,
			frozen:1,
			reset_transient:1;
	u8		reset_reason:4,
			csum_reqd:1;
};

#define MPTCP_RM_IDS_MAX	8

struct mptcp_rm_list {
	u8 ids[MPTCP_RM_IDS_MAX];
	u8 nr;
};

struct mptcp_addr_info {
	u8			id;
	sa_family_t		family;
	__be16			port;
	union {
		struct in_addr	addr;
#if IS_ENABLED(CONFIG_MPTCP_IPV6)
		struct in6_addr	addr6;
#endif
	};
};

struct mptcp_out_options {
#if IS_ENABLED(CONFIG_MPTCP)
	u16 suboptions;
	struct mptcp_rm_list rm_list;
	u8 join_id;
	u8 backup;
	u8 reset_reason:4,
	   reset_transient:1,
	   csum_reqd:1,
	   allow_join_id0:1;
	union {
		struct {
			u64 sndr_key;
			u64 rcvr_key;
		};
		struct {
			struct mptcp_addr_info addr;
			u64 ahmac;
		};
		struct {
			struct mptcp_ext ext_copy;
			u64 fail_seq;
		};
		struct {
			u32 nonce;
			u32 token;
			u64 thmac;
			u8 hmac[20];
		};
	};
#endif
};

#ifdef CONFIG_MPTCP
extern struct request_sock_ops mptcp_subflow_request_sock_ops;

void mptcp_init(void);

static inline bool sk_is_mptcp(const struct sock *sk)
{
	return tcp_sk(sk)->is_mptcp;
}

static inline bool rsk_is_mptcp(const struct request_sock *req)
{
	return tcp_rsk(req)->is_mptcp;
}

static inline bool rsk_drop_req(const struct request_sock *req)
{
	return tcp_rsk(req)->is_mptcp && tcp_rsk(req)->drop_req;
}

void mptcp_space(const struct sock *ssk, int *space, int *full_space);
bool mptcp_syn_options(struct sock *sk, const struct sk_buff *skb,
		       unsigned int *size, struct mptcp_out_options *opts);
bool mptcp_synack_options(const struct request_sock *req, unsigned int *size,
			  struct mptcp_out_options *opts);
bool mptcp_established_options(struct sock *sk, struct sk_buff *skb,
			       unsigned int *size, unsigned int remaining,
			       struct mptcp_out_options *opts);
bool mptcp_incoming_options(struct sock *sk, struct sk_buff *skb);

void mptcp_write_options(__be32 *ptr, const struct tcp_sock *tp,
			 struct mptcp_out_options *opts);

/* move the skb extension owership, with the assumption that 'to' is
 * newly allocated
 */
static inline void mptcp_skb_ext_move(struct sk_buff *to,
				      struct sk_buff *from)
{
	if (!skb_ext_exist(from, SKB_EXT_MPTCP))
		return;

	if (WARN_ON_ONCE(to->active_extensions))
		skb_ext_put(to);

	to->active_extensions = from->active_extensions;
	to->extensions = from->extensions;
	from->active_extensions = 0;
}

static inline void mptcp_skb_ext_copy(struct sk_buff *to,
				      struct sk_buff *from)
{
	struct mptcp_ext *from_ext;

	from_ext = skb_ext_find(from, SKB_EXT_MPTCP);
	if (!from_ext)
		return;

	from_ext->frozen = 1;
	skb_ext_copy(to, from);
}

static inline bool mptcp_ext_matches(const struct mptcp_ext *to_ext,
				     const struct mptcp_ext *from_ext)
{
	/* MPTCP always clears the ext when adding it to the skb, so
	 * holes do not bother us here
	 */
	return !from_ext ||
	       (to_ext && from_ext &&
	        !memcmp(from_ext, to_ext, sizeof(struct mptcp_ext)));
}

/* check if skbs can be collapsed.
 * MPTCP collapse is allowed if neither @to or @from carry an mptcp data
 * mapping, or if the extension of @to is the same as @from.
 * Collapsing is not possible if @to lacks an extension, but @from carries one.
 */
static inline bool mptcp_skb_can_collapse(const struct sk_buff *to,
					  const struct sk_buff *from)
{
	return mptcp_ext_matches(skb_ext_find(to, SKB_EXT_MPTCP),
				 skb_ext_find(from, SKB_EXT_MPTCP));
}

void mptcp_seq_show(struct seq_file *seq);
int mptcp_subflow_init_cookie_req(struct request_sock *req,
				  const struct sock *sk_listener,
				  struct sk_buff *skb);

__be32 mptcp_get_reset_option(const struct sk_buff *skb);

static inline __be32 mptcp_reset_option(const struct sk_buff *skb)
{
	if (skb_ext_exist(skb, SKB_EXT_MPTCP))
		return mptcp_get_reset_option(skb);

	return htonl(0u);
}
#else

static inline void mptcp_init(void)
{
}

static inline bool sk_is_mptcp(const struct sock *sk)
{
	return false;
}

static inline bool rsk_is_mptcp(const struct request_sock *req)
{
	return false;
}

static inline bool rsk_drop_req(const struct request_sock *req)
{
	return false;
}

static inline void mptcp_parse_option(const struct sk_buff *skb,
				      const unsigned char *ptr, int opsize,
				      struct tcp_options_received *opt_rx)
{
}

static inline bool mptcp_syn_options(struct sock *sk, const struct sk_buff *skb,
				     unsigned int *size,
				     struct mptcp_out_options *opts)
{
	return false;
}

static inline bool mptcp_synack_options(const struct request_sock *req,
					unsigned int *size,
					struct mptcp_out_options *opts)
{
	return false;
}

static inline bool mptcp_established_options(struct sock *sk,
					     struct sk_buff *skb,
					     unsigned int *size,
					     unsigned int remaining,
					     struct mptcp_out_options *opts)
{
	return false;
}

static inline bool mptcp_incoming_options(struct sock *sk,
					  struct sk_buff *skb)
{
	return true;
}

static inline void mptcp_skb_ext_move(struct sk_buff *to,
				      const struct sk_buff *from)
{
}

static inline void mptcp_skb_ext_copy(struct sk_buff *to,
				      struct sk_buff *from)
{
}

static inline bool mptcp_skb_can_collapse(const struct sk_buff *to,
					  const struct sk_buff *from)
{
	return true;
}

static inline void mptcp_space(const struct sock *ssk, int *s, int *fs) { }
static inline void mptcp_seq_show(struct seq_file *seq) { }

static inline int mptcp_subflow_init_cookie_req(struct request_sock *req,
						const struct sock *sk_listener,
						struct sk_buff *skb)
{
	return 0; /* TCP fallback */
}

static inline __be32 mptcp_reset_option(const struct sk_buff *skb)  { return htonl(0u); }
#endif /* CONFIG_MPTCP */

#if IS_ENABLED(CONFIG_MPTCP_IPV6)
int mptcpv6_init(void);
void mptcpv6_handle_mapped(struct sock *sk, bool mapped);
#elif IS_ENABLED(CONFIG_IPV6)
static inline int mptcpv6_init(void) { return 0; }
static inline void mptcpv6_handle_mapped(struct sock *sk, bool mapped) { }
#endif

#endif /* __NET_MPTCP_H */
Commit	Line	Data
3ee17bc7 MM	1	/* SPDX-License-Identifier: GPL-2.0 */
	2	/*
	3	* Multipath TCP
	4	*
	5	* Copyright (c) 2017 - 2019, Intel Corporation.
	6	*/
	7
	8	#ifndef __NET_MPTCP_H
	9	#define __NET_MPTCP_H
	10
85712484	11	#include <linux/skbuff.h>
eda7acdd	12	#include <linux/tcp.h>
3ee17bc7 MM	13	#include <linux/types.h>
3ee17bc7 MM	14
fc518953 FW	15	struct seq_file;
fc518953 FW	16
3ee17bc7 MM	17	/* MPTCP sk_buff extension data */
3ee17bc7 MM	18	struct mptcp_ext {
a0c1d0ea CP	19	union {
	20	u64 data_ack;
	21	u32 data_ack32;
	22	};
3ee17bc7 MM	23	u64 data_seq;
	24	u32 subflow_seq;
	25	u16 data_len;
d0cc2987	26	__sum16 csum;
3ee17bc7 MM	27	u8 use_map:1,
	28	dsn64:1,
	29	data_fin:1,
	30	use_ack:1,
	31	ack64:1,
cc7972ea	32	mpc_map:1,
5a369ca6	33	frozen:1,
dc87efdb	34	reset_transient:1;
208e8f66 GT	35	u8 reset_reason:4,
208e8f66 GT	36	csum_reqd:1;
3ee17bc7 MM	37	};
3ee17bc7 MM	38
6445e17a GT	39	#define MPTCP_RM_IDS_MAX 8
	40
	41	struct mptcp_rm_list {
	42	u8 ids[MPTCP_RM_IDS_MAX];
	43	u8 nr;
	44	};
	45
30f60bae GT	46	struct mptcp_addr_info {
	47	u8 id;
	48	sa_family_t family;
	49	__be16 port;
	50	union {
	51	struct in_addr addr;
	52	#if IS_ENABLED(CONFIG_MPTCP_IPV6)
	53	struct in6_addr addr6;
	54	#endif
	55	};
	56	};
	57
eda7acdd PK	58	struct mptcp_out_options {
	59	#if IS_ENABLED(CONFIG_MPTCP)
	60	u16 suboptions;
6445e17a	61	struct mptcp_rm_list rm_list;
f296234c PK	62	u8 join_id;
f296234c PK	63	u8 backup;
06fe1719 GT	64	u8 reset_reason:4,
06fe1719 GT	65	reset_transient:1,
bab6b88e GT	66	csum_reqd:1,
bab6b88e GT	67	allow_join_id0:1;
d7b26908 PA	68	union {
	69	struct {
	70	u64 sndr_key;
	71	u64 rcvr_key;
	72	};
	73	struct {
	74	struct mptcp_addr_info addr;
	75	u64 ahmac;
	76	};
c25aeb4e GT	77	struct {
	78	struct mptcp_ext ext_copy;
	79	u64 fail_seq;
	80	};
d7b26908 PA	81	struct {
	82	u32 nonce;
	83	u32 token;
	84	u64 thmac;
	85	u8 hmac[20];
	86	};
	87	};
eda7acdd PK	88	#endif
	89	};
	90
85712484	91	#ifdef CONFIG_MPTCP
08b8d080	92	extern struct request_sock_ops mptcp_subflow_request_sock_ops;
85712484	93
f870fa0b MM	94	void mptcp_init(void);
f870fa0b MM	95
cec37a6e PK	96	static inline bool sk_is_mptcp(const struct sock *sk)
	97	{
	98	return tcp_sk(sk)->is_mptcp;
	99	}
	100
	101	static inline bool rsk_is_mptcp(const struct request_sock *req)
	102	{
	103	return tcp_rsk(req)->is_mptcp;
	104	}
	105
90bf4513 PA	106	static inline bool rsk_drop_req(const struct request_sock *req)
	107	{
	108	return tcp_rsk(req)->is_mptcp && tcp_rsk(req)->drop_req;
	109	}
	110
071c8ed6	111	void mptcp_space(const struct sock ssk, int space, int *full_space);
cc7972ea CP	112	bool mptcp_syn_options(struct sock sk, const struct sk_buff skb,
cc7972ea CP	113	unsigned int size, struct mptcp_out_options opts);
cec37a6e PK	114	bool mptcp_synack_options(const struct request_sock req, unsigned int size,
	115	struct mptcp_out_options *opts);
	116	bool mptcp_established_options(struct sock sk, struct sk_buff skb,
	117	unsigned int *size, unsigned int remaining,
	118	struct mptcp_out_options *opts);
6787b7e3	119	bool mptcp_incoming_options(struct sock sk, struct sk_buff skb);
cec37a6e	120
fa3fe2b1 FW	121	void mptcp_write_options(__be32 ptr, const struct tcp_sock tp,
fa3fe2b1 FW	122	struct mptcp_out_options *opts);
eda7acdd	123
85712484 MM	124	/* move the skb extension owership, with the assumption that 'to' is
	125	* newly allocated
	126	*/
	127	static inline void mptcp_skb_ext_move(struct sk_buff *to,
	128	struct sk_buff *from)
	129	{
	130	if (!skb_ext_exist(from, SKB_EXT_MPTCP))
	131	return;
	132
	133	if (WARN_ON_ONCE(to->active_extensions))
	134	skb_ext_put(to);
	135
	136	to->active_extensions = from->active_extensions;
	137	to->extensions = from->extensions;
	138	from->active_extensions = 0;
	139	}
	140
5a369ca6 PA	141	static inline void mptcp_skb_ext_copy(struct sk_buff *to,
	142	struct sk_buff *from)
	143	{
	144	struct mptcp_ext *from_ext;
	145
	146	from_ext = skb_ext_find(from, SKB_EXT_MPTCP);
	147	if (!from_ext)
	148	return;
	149
	150	from_ext->frozen = 1;
	151	skb_ext_copy(to, from);
	152	}
	153
85712484 MM	154	static inline bool mptcp_ext_matches(const struct mptcp_ext *to_ext,
	155	const struct mptcp_ext *from_ext)
	156	{
	157	/* MPTCP always clears the ext when adding it to the skb, so
	158	* holes do not bother us here
	159	*/
	160	return !from_ext \|\|
	161	(to_ext && from_ext &&
	162	!memcmp(from_ext, to_ext, sizeof(struct mptcp_ext)));
	163	}
	164
	165	/* check if skbs can be collapsed.
	166	* MPTCP collapse is allowed if neither @to or @from carry an mptcp data
	167	* mapping, or if the extension of @to is the same as @from.
	168	* Collapsing is not possible if @to lacks an extension, but @from carries one.
	169	*/
	170	static inline bool mptcp_skb_can_collapse(const struct sk_buff *to,
	171	const struct sk_buff *from)
	172	{
	173	return mptcp_ext_matches(skb_ext_find(to, SKB_EXT_MPTCP),
	174	skb_ext_find(from, SKB_EXT_MPTCP));
	175	}
	176
fc518953	177	void mptcp_seq_show(struct seq_file *seq);
c83a47e5 FW	178	int mptcp_subflow_init_cookie_req(struct request_sock *req,
	179	const struct sock *sk_listener,
	180	struct sk_buff *skb);
dc87efdb FW	181
	182	__be32 mptcp_get_reset_option(const struct sk_buff *skb);
	183
	184	static inline __be32 mptcp_reset_option(const struct sk_buff *skb)
	185	{
	186	if (skb_ext_exist(skb, SKB_EXT_MPTCP))
	187	return mptcp_get_reset_option(skb);
	188
	189	return htonl(0u);
	190	}
85712484 MM	191	#else
85712484 MM	192
f870fa0b MM	193	static inline void mptcp_init(void)
	194	{
	195	}
	196
cec37a6e PK	197	static inline bool sk_is_mptcp(const struct sock *sk)
	198	{
	199	return false;
	200	}
	201
	202	static inline bool rsk_is_mptcp(const struct request_sock *req)
	203	{
	204	return false;
	205	}
	206
90bf4513 PA	207	static inline bool rsk_drop_req(const struct request_sock *req)
	208	{
	209	return false;
	210	}
	211
cc7972ea CP	212	static inline void mptcp_parse_option(const struct sk_buff *skb,
cc7972ea CP	213	const unsigned char *ptr, int opsize,
eda7acdd PK	214	struct tcp_options_received *opt_rx)
	215	{
	216	}
	217
cc7972ea CP	218	static inline bool mptcp_syn_options(struct sock sk, const struct sk_buff skb,
cc7972ea CP	219	unsigned int *size,
cec37a6e PK	220	struct mptcp_out_options *opts)
	221	{
	222	return false;
	223	}
	224
cec37a6e PK	225	static inline bool mptcp_synack_options(const struct request_sock *req,
	226	unsigned int *size,
	227	struct mptcp_out_options *opts)
	228	{
	229	return false;
	230	}
	231
	232	static inline bool mptcp_established_options(struct sock *sk,
	233	struct sk_buff *skb,
	234	unsigned int *size,
	235	unsigned int remaining,
	236	struct mptcp_out_options *opts)
	237	{
	238	return false;
	239	}
	240
6787b7e3	241	static inline bool mptcp_incoming_options(struct sock *sk,
77d0cab9	242	struct sk_buff *skb)
648ef4b8	243	{
6787b7e3	244	return true;
648ef4b8 MM	245	}
648ef4b8 MM	246
85712484 MM	247	static inline void mptcp_skb_ext_move(struct sk_buff *to,
	248	const struct sk_buff *from)
	249	{
	250	}
	251
5a369ca6 PA	252	static inline void mptcp_skb_ext_copy(struct sk_buff *to,
	253	struct sk_buff *from)
	254	{
	255	}
	256
85712484 MM	257	static inline bool mptcp_skb_can_collapse(const struct sk_buff *to,
	258	const struct sk_buff *from)
	259	{
	260	return true;
	261	}
	262
071c8ed6	263	static inline void mptcp_space(const struct sock ssk, int s, int *fs) { }
fc518953	264	static inline void mptcp_seq_show(struct seq_file *seq) { }
c83a47e5 FW	265
	266	static inline int mptcp_subflow_init_cookie_req(struct request_sock *req,
	267	const struct sock *sk_listener,
	268	struct sk_buff *skb)
	269	{
	270	return 0; /* TCP fallback */
	271	}
dc87efdb FW	272
dc87efdb FW	273	static inline __be32 mptcp_reset_option(const struct sk_buff *skb) { return htonl(0u); }
85712484	274	#endif /* CONFIG_MPTCP */
f870fa0b MM	275
	276	#if IS_ENABLED(CONFIG_MPTCP_IPV6)
	277	int mptcpv6_init(void);
31484d56	278	void mptcpv6_handle_mapped(struct sock *sk, bool mapped);
f870fa0b	279	#elif IS_ENABLED(CONFIG_IPV6)
31484d56 GU	280	static inline int mptcpv6_init(void) { return 0; }
31484d56 GU	281	static inline void mptcpv6_handle_mapped(struct sock *sk, bool mapped) { }
f870fa0b MM	282	#endif
f870fa0b MM	283
3ee17bc7	284	#endif /* __NET_MPTCP_H */