[linux-2.6-block.git] / net / mptcp / protocol.h

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

#ifndef __MPTCP_PROTOCOL_H
#define __MPTCP_PROTOCOL_H

#include <linux/random.h>
#include <net/tcp.h>
#include <net/inet_connection_sock.h>

#define MPTCP_SUPPORTED_VERSION	1

/* MPTCP option bits */
#define OPTION_MPTCP_MPC_SYN	BIT(0)
#define OPTION_MPTCP_MPC_SYNACK	BIT(1)
#define OPTION_MPTCP_MPC_ACK	BIT(2)
#define OPTION_MPTCP_MPJ_SYN	BIT(3)
#define OPTION_MPTCP_MPJ_SYNACK	BIT(4)
#define OPTION_MPTCP_MPJ_ACK	BIT(5)
#define OPTION_MPTCP_ADD_ADDR	BIT(6)
#define OPTION_MPTCP_ADD_ADDR6	BIT(7)
#define OPTION_MPTCP_RM_ADDR	BIT(8)

/* MPTCP option subtypes */
#define MPTCPOPT_MP_CAPABLE	0
#define MPTCPOPT_MP_JOIN	1
#define MPTCPOPT_DSS		2
#define MPTCPOPT_ADD_ADDR	3
#define MPTCPOPT_RM_ADDR	4
#define MPTCPOPT_MP_PRIO	5
#define MPTCPOPT_MP_FAIL	6
#define MPTCPOPT_MP_FASTCLOSE	7

/* MPTCP suboption lengths */
#define TCPOLEN_MPTCP_MPC_SYN		4
#define TCPOLEN_MPTCP_MPC_SYNACK	12
#define TCPOLEN_MPTCP_MPC_ACK		20
#define TCPOLEN_MPTCP_MPC_ACK_DATA	22
#define TCPOLEN_MPTCP_MPJ_SYN		12
#define TCPOLEN_MPTCP_MPJ_SYNACK	16
#define TCPOLEN_MPTCP_MPJ_ACK		24
#define TCPOLEN_MPTCP_DSS_BASE		4
#define TCPOLEN_MPTCP_DSS_ACK32		4
#define TCPOLEN_MPTCP_DSS_ACK64		8
#define TCPOLEN_MPTCP_DSS_MAP32		10
#define TCPOLEN_MPTCP_DSS_MAP64		14
#define TCPOLEN_MPTCP_DSS_CHECKSUM	2
#define TCPOLEN_MPTCP_ADD_ADDR		16
#define TCPOLEN_MPTCP_ADD_ADDR_PORT	18
#define TCPOLEN_MPTCP_ADD_ADDR_BASE	8
#define TCPOLEN_MPTCP_ADD_ADDR_BASE_PORT	10
#define TCPOLEN_MPTCP_ADD_ADDR6		28
#define TCPOLEN_MPTCP_ADD_ADDR6_PORT	30
#define TCPOLEN_MPTCP_ADD_ADDR6_BASE	20
#define TCPOLEN_MPTCP_ADD_ADDR6_BASE_PORT	22
#define TCPOLEN_MPTCP_PORT_LEN		2
#define TCPOLEN_MPTCP_RM_ADDR_BASE	4

/* MPTCP MP_JOIN flags */
#define MPTCPOPT_BACKUP		BIT(0)
#define MPTCPOPT_HMAC_LEN	20
#define MPTCPOPT_THMAC_LEN	8

/* MPTCP MP_CAPABLE flags */
#define MPTCP_VERSION_MASK	(0x0F)
#define MPTCP_CAP_CHECKSUM_REQD	BIT(7)
#define MPTCP_CAP_EXTENSIBILITY	BIT(6)
#define MPTCP_CAP_HMAC_SHA256	BIT(0)
#define MPTCP_CAP_FLAG_MASK	(0x3F)

/* MPTCP DSS flags */
#define MPTCP_DSS_DATA_FIN	BIT(4)
#define MPTCP_DSS_DSN64		BIT(3)
#define MPTCP_DSS_HAS_MAP	BIT(2)
#define MPTCP_DSS_ACK64		BIT(1)
#define MPTCP_DSS_HAS_ACK	BIT(0)
#define MPTCP_DSS_FLAG_MASK	(0x1F)

/* MPTCP ADD_ADDR flags */
#define MPTCP_ADDR_ECHO		BIT(0)
#define MPTCP_ADDR_IPVERSION_4	4
#define MPTCP_ADDR_IPVERSION_6	6

/* MPTCP socket flags */
#define MPTCP_DATA_READY	0
#define MPTCP_SEND_SPACE	1
#define MPTCP_WORK_RTX		2
#define MPTCP_WORK_EOF		3
#define MPTCP_FALLBACK_DONE	4

struct mptcp_options_received {
	u64	sndr_key;
	u64	rcvr_key;
	u64	data_ack;
	u64	data_seq;
	u32	subflow_seq;
	u16	data_len;
	u16	mp_capable : 1,
		mp_join : 1,
		dss : 1,
		add_addr : 1,
		rm_addr : 1,
		family : 4,
		echo : 1,
		backup : 1;
	u32	token;
	u32	nonce;
	u64	thmac;
	u8	hmac[20];
	u8	join_id;
	u8	use_map:1,
		dsn64:1,
		data_fin:1,
		use_ack:1,
		ack64:1,
		mpc_map:1,
		__unused:2;
	u8	addr_id;
	u8	rm_id;
	union {
		struct in_addr	addr;
#if IS_ENABLED(CONFIG_MPTCP_IPV6)
		struct in6_addr	addr6;
#endif
	};
	u64	ahmac;
	u16	port;
};

static inline __be32 mptcp_option(u8 subopt, u8 len, u8 nib, u8 field)
{
	return htonl((TCPOPT_MPTCP << 24) | (len << 16) | (subopt << 12) |
		     ((nib & 0xF) << 8) | field);
}

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

enum mptcp_pm_status {
	MPTCP_PM_ADD_ADDR_RECEIVED,
	MPTCP_PM_ESTABLISHED,
	MPTCP_PM_SUBFLOW_ESTABLISHED,
};

struct mptcp_pm_data {
	struct mptcp_addr_info local;
	struct mptcp_addr_info remote;

	spinlock_t	lock;		/*protects the whole PM data */

	bool		addr_signal;
	bool		server_side;
	bool		work_pending;
	bool		accept_addr;
	bool		accept_subflow;
	u8		add_addr_signaled;
	u8		add_addr_accepted;
	u8		local_addr_used;
	u8		subflows;
	u8		add_addr_signal_max;
	u8		add_addr_accept_max;
	u8		local_addr_max;
	u8		subflows_max;
	u8		status;
};

struct mptcp_data_frag {
	struct list_head list;
	u64 data_seq;
	int data_len;
	int offset;
	int overhead;
	struct page *page;
};

/* MPTCP connection sock */
struct mptcp_sock {
	/* inet_connection_sock must be the first member */
	struct inet_connection_sock sk;
	u64		local_key;
	u64		remote_key;
	u64		write_seq;
	u64		ack_seq;
	u64		rcv_data_fin_seq;
	atomic64_t	snd_una;
	unsigned long	timer_ival;
	u32		token;
	unsigned long	flags;
	bool		can_ack;
	bool		fully_established;
	bool		rcv_data_fin;
	bool		snd_data_fin_enable;
	spinlock_t	join_list_lock;
	struct work_struct work;
	struct list_head conn_list;
	struct list_head rtx_queue;
	struct list_head join_list;
	struct skb_ext	*cached_ext;	/* for the next sendmsg */
	struct socket	*subflow; /* outgoing connect/listener/!mp_capable */
	struct sock	*first;
	struct mptcp_pm_data	pm;
	struct {
		u32	space;	/* bytes copied in last measurement window */
		u32	copied; /* bytes copied in this measurement window */
		u64	time;	/* start time of measurement window */
		u64	rtt_us; /* last maximum rtt of subflows */
	} rcvq_space;
};

#define mptcp_for_each_subflow(__msk, __subflow)			\
	list_for_each_entry(__subflow, &((__msk)->conn_list), node)

static inline struct mptcp_sock *mptcp_sk(const struct sock *sk)
{
	return (struct mptcp_sock *)sk;
}

static inline struct mptcp_data_frag *mptcp_rtx_tail(const struct sock *sk)
{
	struct mptcp_sock *msk = mptcp_sk(sk);

	if (list_empty(&msk->rtx_queue))
		return NULL;

	return list_last_entry(&msk->rtx_queue, struct mptcp_data_frag, list);
}

static inline struct mptcp_data_frag *mptcp_rtx_head(const struct sock *sk)
{
	struct mptcp_sock *msk = mptcp_sk(sk);

	return list_first_entry_or_null(&msk->rtx_queue, struct mptcp_data_frag, list);
}

struct mptcp_subflow_request_sock {
	struct	tcp_request_sock sk;
	u16	mp_capable : 1,
		mp_join : 1,
		backup : 1;
	u8	local_id;
	u8	remote_id;
	u64	local_key;
	u64	idsn;
	u32	token;
	u32	ssn_offset;
	u64	thmac;
	u32	local_nonce;
	u32	remote_nonce;
	struct mptcp_sock	*msk;
	struct hlist_nulls_node token_node;
};

static inline struct mptcp_subflow_request_sock *
mptcp_subflow_rsk(const struct request_sock *rsk)
{
	return (struct mptcp_subflow_request_sock *)rsk;
}

/* MPTCP subflow context */
struct mptcp_subflow_context {
	struct	list_head node;/* conn_list of subflows */
	u64	local_key;
	u64	remote_key;
	u64	idsn;
	u64	map_seq;
	u32	snd_isn;
	u32	token;
	u32	rel_write_seq;
	u32	map_subflow_seq;
	u32	ssn_offset;
	u32	map_data_len;
	u32	request_mptcp : 1,  /* send MP_CAPABLE */
		request_join : 1,   /* send MP_JOIN */
		request_bkup : 1,
		mp_capable : 1,	    /* remote is MPTCP capable */
		mp_join : 1,	    /* remote is JOINing */
		fully_established : 1,	    /* path validated */
		pm_notified : 1,    /* PM hook called for established status */
		conn_finished : 1,
		map_valid : 1,
		mpc_map : 1,
		backup : 1,
		data_avail : 1,
		rx_eof : 1,
		use_64bit_ack : 1, /* Set when we received a 64-bit DSN */
		can_ack : 1;	    /* only after processing the remote a key */
	u32	remote_nonce;
	u64	thmac;
	u32	local_nonce;
	u32	remote_token;
	u8	hmac[MPTCPOPT_HMAC_LEN];
	u8	local_id;
	u8	remote_id;

	struct	sock *tcp_sock;	    /* tcp sk backpointer */
	struct	sock *conn;	    /* parent mptcp_sock */
	const	struct inet_connection_sock_af_ops *icsk_af_ops;
	void	(*tcp_data_ready)(struct sock *sk);
	void	(*tcp_state_change)(struct sock *sk);
	void	(*tcp_write_space)(struct sock *sk);

	struct	rcu_head rcu;
};

static inline struct mptcp_subflow_context *
mptcp_subflow_ctx(const struct sock *sk)
{
	struct inet_connection_sock *icsk = inet_csk(sk);

	/* Use RCU on icsk_ulp_data only for sock diag code */
	return (__force struct mptcp_subflow_context *)icsk->icsk_ulp_data;
}

static inline struct sock *
mptcp_subflow_tcp_sock(const struct mptcp_subflow_context *subflow)
{
	return subflow->tcp_sock;
}

static inline u64
mptcp_subflow_get_map_offset(const struct mptcp_subflow_context *subflow)
{
	return tcp_sk(mptcp_subflow_tcp_sock(subflow))->copied_seq -
		      subflow->ssn_offset -
		      subflow->map_subflow_seq;
}

static inline u64
mptcp_subflow_get_mapped_dsn(const struct mptcp_subflow_context *subflow)
{
	return subflow->map_seq + mptcp_subflow_get_map_offset(subflow);
}

int mptcp_is_enabled(struct net *net);
void mptcp_subflow_fully_established(struct mptcp_subflow_context *subflow,
				     struct mptcp_options_received *mp_opt);
bool mptcp_subflow_data_available(struct sock *sk);
void __init mptcp_subflow_init(void);

/* called with sk socket lock held */
int __mptcp_subflow_connect(struct sock *sk, int ifindex,
			    const struct mptcp_addr_info *loc,
			    const struct mptcp_addr_info *remote);
int mptcp_subflow_create_socket(struct sock *sk, struct socket **new_sock);

static inline void mptcp_subflow_tcp_fallback(struct sock *sk,
					      struct mptcp_subflow_context *ctx)
{
	sk->sk_data_ready = ctx->tcp_data_ready;
	sk->sk_state_change = ctx->tcp_state_change;
	sk->sk_write_space = ctx->tcp_write_space;

	inet_csk(sk)->icsk_af_ops = ctx->icsk_af_ops;
}

void __init mptcp_proto_init(void);
#if IS_ENABLED(CONFIG_MPTCP_IPV6)
int __init mptcp_proto_v6_init(void);
#endif

struct sock *mptcp_sk_clone(const struct sock *sk,
			    const struct mptcp_options_received *mp_opt,
			    struct request_sock *req);
void mptcp_get_options(const struct sk_buff *skb,
		       struct mptcp_options_received *mp_opt);

void mptcp_finish_connect(struct sock *sk);
static inline bool mptcp_is_fully_established(struct sock *sk)
{
	return inet_sk_state_load(sk) == TCP_ESTABLISHED &&
	       READ_ONCE(mptcp_sk(sk)->fully_established);
}
void mptcp_rcv_space_init(struct mptcp_sock *msk, const struct sock *ssk);
void mptcp_data_ready(struct sock *sk, struct sock *ssk);
bool mptcp_finish_join(struct sock *sk);
void mptcp_data_acked(struct sock *sk);
void mptcp_subflow_eof(struct sock *sk);
bool mptcp_update_rcv_data_fin(struct mptcp_sock *msk, u64 data_fin_seq);

void __init mptcp_token_init(void);
static inline void mptcp_token_init_request(struct request_sock *req)
{
	mptcp_subflow_rsk(req)->token_node.pprev = NULL;
}

int mptcp_token_new_request(struct request_sock *req);
void mptcp_token_destroy_request(struct request_sock *req);
int mptcp_token_new_connect(struct sock *sk);
void mptcp_token_accept(struct mptcp_subflow_request_sock *r,
			struct mptcp_sock *msk);
bool mptcp_token_exists(u32 token);
struct mptcp_sock *mptcp_token_get_sock(u32 token);
struct mptcp_sock *mptcp_token_iter_next(const struct net *net, long *s_slot,
					 long *s_num);
void mptcp_token_destroy(struct mptcp_sock *msk);

void mptcp_crypto_key_sha(u64 key, u32 *token, u64 *idsn);

void mptcp_crypto_hmac_sha(u64 key1, u64 key2, u8 *msg, int len, void *hmac);

void __init mptcp_pm_init(void);
void mptcp_pm_data_init(struct mptcp_sock *msk);
void mptcp_pm_new_connection(struct mptcp_sock *msk, int server_side);
void mptcp_pm_fully_established(struct mptcp_sock *msk);
bool mptcp_pm_allow_new_subflow(struct mptcp_sock *msk);
void mptcp_pm_connection_closed(struct mptcp_sock *msk);
void mptcp_pm_subflow_established(struct mptcp_sock *msk,
				  struct mptcp_subflow_context *subflow);
void mptcp_pm_subflow_closed(struct mptcp_sock *msk, u8 id);
void mptcp_pm_add_addr_received(struct mptcp_sock *msk,
				const struct mptcp_addr_info *addr);

int mptcp_pm_announce_addr(struct mptcp_sock *msk,
			   const struct mptcp_addr_info *addr);
int mptcp_pm_remove_addr(struct mptcp_sock *msk, u8 local_id);
int mptcp_pm_remove_subflow(struct mptcp_sock *msk, u8 remote_id);

static inline bool mptcp_pm_should_signal(struct mptcp_sock *msk)
{
	return READ_ONCE(msk->pm.addr_signal);
}

static inline unsigned int mptcp_add_addr_len(int family)
{
	if (family == AF_INET)
		return TCPOLEN_MPTCP_ADD_ADDR;
	return TCPOLEN_MPTCP_ADD_ADDR6;
}

bool mptcp_pm_addr_signal(struct mptcp_sock *msk, unsigned int remaining,
			  struct mptcp_addr_info *saddr);
int mptcp_pm_get_local_id(struct mptcp_sock *msk, struct sock_common *skc);

void __init mptcp_pm_nl_init(void);
void mptcp_pm_nl_data_init(struct mptcp_sock *msk);
void mptcp_pm_nl_fully_established(struct mptcp_sock *msk);
void mptcp_pm_nl_subflow_established(struct mptcp_sock *msk);
void mptcp_pm_nl_add_addr_received(struct mptcp_sock *msk);
int mptcp_pm_nl_get_local_id(struct mptcp_sock *msk, struct sock_common *skc);

static inline struct mptcp_ext *mptcp_get_ext(struct sk_buff *skb)
{
	return (struct mptcp_ext *)skb_ext_find(skb, SKB_EXT_MPTCP);
}

static inline bool before64(__u64 seq1, __u64 seq2)
{
	return (__s64)(seq1 - seq2) < 0;
}

#define after64(seq2, seq1)	before64(seq1, seq2)

void mptcp_diag_subflow_init(struct tcp_ulp_ops *ops);

static inline bool __mptcp_check_fallback(struct mptcp_sock *msk)
{
	return test_bit(MPTCP_FALLBACK_DONE, &msk->flags);
}

static inline bool mptcp_check_fallback(struct sock *sk)
{
	struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
	struct mptcp_sock *msk = mptcp_sk(subflow->conn);

	return __mptcp_check_fallback(msk);
}

static inline void __mptcp_do_fallback(struct mptcp_sock *msk)
{
	if (test_bit(MPTCP_FALLBACK_DONE, &msk->flags)) {
		pr_debug("TCP fallback already done (msk=%p)", msk);
		return;
	}
	set_bit(MPTCP_FALLBACK_DONE, &msk->flags);
}

static inline void mptcp_do_fallback(struct sock *sk)
{
	struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
	struct mptcp_sock *msk = mptcp_sk(subflow->conn);

	__mptcp_do_fallback(msk);
}

#define pr_fallback(a) pr_debug("%s:fallback to TCP (msk=%p)", __func__, a)

static inline bool subflow_simultaneous_connect(struct sock *sk)
{
	struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
	struct sock *parent = subflow->conn;

	return sk->sk_state == TCP_ESTABLISHED &&
	       !mptcp_sk(parent)->pm.server_side &&
	       !subflow->conn_finished;
}

#ifdef CONFIG_SYN_COOKIES
void subflow_init_req_cookie_join_save(const struct mptcp_subflow_request_sock *subflow_req,
				       struct sk_buff *skb);
bool mptcp_token_join_cookie_init_state(struct mptcp_subflow_request_sock *subflow_req,
					struct sk_buff *skb);
void __init mptcp_join_cookie_init(void);
#else
static inline void
subflow_init_req_cookie_join_save(const struct mptcp_subflow_request_sock *subflow_req,
				  struct sk_buff *skb) {}
static inline bool
mptcp_token_join_cookie_init_state(struct mptcp_subflow_request_sock *subflow_req,
				   struct sk_buff *skb)
{
	return false;
}

static inline void mptcp_join_cookie_init(void) {}
#endif

#endif /* __MPTCP_PROTOCOL_H */
Commit	Line	Data
f870fa0b MM	1	/* SPDX-License-Identifier: GPL-2.0 */
	2	/* Multipath TCP
	3	*
	4	* Copyright (c) 2017 - 2019, Intel Corporation.
	5	*/
	6
	7	#ifndef __MPTCP_PROTOCOL_H
	8	#define __MPTCP_PROTOCOL_H
	9
79c0949e PK	10	#include <linux/random.h>
	11	#include <net/tcp.h>
	12	#include <net/inet_connection_sock.h>
	13
cc7972ea	14	#define MPTCP_SUPPORTED_VERSION 1
eda7acdd PK	15
	16	/* MPTCP option bits */
	17	#define OPTION_MPTCP_MPC_SYN BIT(0)
	18	#define OPTION_MPTCP_MPC_SYNACK BIT(1)
	19	#define OPTION_MPTCP_MPC_ACK BIT(2)
f296234c PK	20	#define OPTION_MPTCP_MPJ_SYN BIT(3)
	21	#define OPTION_MPTCP_MPJ_SYNACK BIT(4)
	22	#define OPTION_MPTCP_MPJ_ACK BIT(5)
3df523ab PK	23	#define OPTION_MPTCP_ADD_ADDR BIT(6)
	24	#define OPTION_MPTCP_ADD_ADDR6 BIT(7)
	25	#define OPTION_MPTCP_RM_ADDR BIT(8)
eda7acdd PK	26
	27	/* MPTCP option subtypes */
	28	#define MPTCPOPT_MP_CAPABLE 0
	29	#define MPTCPOPT_MP_JOIN 1
	30	#define MPTCPOPT_DSS 2
	31	#define MPTCPOPT_ADD_ADDR 3
	32	#define MPTCPOPT_RM_ADDR 4
	33	#define MPTCPOPT_MP_PRIO 5
	34	#define MPTCPOPT_MP_FAIL 6
	35	#define MPTCPOPT_MP_FASTCLOSE 7
	36
	37	/* MPTCP suboption lengths */
cc7972ea	38	#define TCPOLEN_MPTCP_MPC_SYN 4
eda7acdd PK	39	#define TCPOLEN_MPTCP_MPC_SYNACK 12
eda7acdd PK	40	#define TCPOLEN_MPTCP_MPC_ACK 20
cc7972ea	41	#define TCPOLEN_MPTCP_MPC_ACK_DATA 22
f296234c PK	42	#define TCPOLEN_MPTCP_MPJ_SYN 12
	43	#define TCPOLEN_MPTCP_MPJ_SYNACK 16
	44	#define TCPOLEN_MPTCP_MPJ_ACK 24
6d0060f6	45	#define TCPOLEN_MPTCP_DSS_BASE 4
648ef4b8	46	#define TCPOLEN_MPTCP_DSS_ACK32 4
6d0060f6	47	#define TCPOLEN_MPTCP_DSS_ACK64 8
648ef4b8	48	#define TCPOLEN_MPTCP_DSS_MAP32 10
6d0060f6 MM	49	#define TCPOLEN_MPTCP_DSS_MAP64 14
6d0060f6 MM	50	#define TCPOLEN_MPTCP_DSS_CHECKSUM 2
3df523ab PK	51	#define TCPOLEN_MPTCP_ADD_ADDR 16
	52	#define TCPOLEN_MPTCP_ADD_ADDR_PORT 18
	53	#define TCPOLEN_MPTCP_ADD_ADDR_BASE 8
	54	#define TCPOLEN_MPTCP_ADD_ADDR_BASE_PORT 10
	55	#define TCPOLEN_MPTCP_ADD_ADDR6 28
	56	#define TCPOLEN_MPTCP_ADD_ADDR6_PORT 30
	57	#define TCPOLEN_MPTCP_ADD_ADDR6_BASE 20
	58	#define TCPOLEN_MPTCP_ADD_ADDR6_BASE_PORT 22
	59	#define TCPOLEN_MPTCP_PORT_LEN 2
	60	#define TCPOLEN_MPTCP_RM_ADDR_BASE 4
eda7acdd	61
ec3edaa7	62	/* MPTCP MP_JOIN flags */
f296234c PK	63	#define MPTCPOPT_BACKUP BIT(0)
f296234c PK	64	#define MPTCPOPT_HMAC_LEN 20
ec3edaa7	65	#define MPTCPOPT_THMAC_LEN 8
f296234c	66
eda7acdd PK	67	/* MPTCP MP_CAPABLE flags */
	68	#define MPTCP_VERSION_MASK (0x0F)
	69	#define MPTCP_CAP_CHECKSUM_REQD BIT(7)
	70	#define MPTCP_CAP_EXTENSIBILITY BIT(6)
65492c5a	71	#define MPTCP_CAP_HMAC_SHA256 BIT(0)
eda7acdd PK	72	#define MPTCP_CAP_FLAG_MASK (0x3F)
eda7acdd PK	73
6d0060f6 MM	74	/* MPTCP DSS flags */
	75	#define MPTCP_DSS_DATA_FIN BIT(4)
	76	#define MPTCP_DSS_DSN64 BIT(3)
	77	#define MPTCP_DSS_HAS_MAP BIT(2)
	78	#define MPTCP_DSS_ACK64 BIT(1)
	79	#define MPTCP_DSS_HAS_ACK BIT(0)
648ef4b8 MM	80	#define MPTCP_DSS_FLAG_MASK (0x1F)
648ef4b8 MM	81
3df523ab PK	82	/* MPTCP ADD_ADDR flags */
3df523ab PK	83	#define MPTCP_ADDR_ECHO BIT(0)
3df523ab PK	84	#define MPTCP_ADDR_IPVERSION_4 4
	85	#define MPTCP_ADDR_IPVERSION_6 6
	86
648ef4b8	87	/* MPTCP socket flags */
d99bfed5 FW	88	#define MPTCP_DATA_READY 0
d99bfed5 FW	89	#define MPTCP_SEND_SPACE 1
3b1d6210	90	#define MPTCP_WORK_RTX 2
59832e24	91	#define MPTCP_WORK_EOF 3
e1ff9e82	92	#define MPTCP_FALLBACK_DONE 4
6d0060f6	93
cfde141e PA	94	struct mptcp_options_received {
	95	u64 sndr_key;
	96	u64 rcvr_key;
	97	u64 data_ack;
	98	u64 data_seq;
	99	u32 subflow_seq;
	100	u16 data_len;
	101	u16 mp_capable : 1,
	102	mp_join : 1,
	103	dss : 1,
	104	add_addr : 1,
	105	rm_addr : 1,
	106	family : 4,
	107	echo : 1,
	108	backup : 1;
	109	u32 token;
	110	u32 nonce;
	111	u64 thmac;
	112	u8 hmac[20];
	113	u8 join_id;
	114	u8 use_map:1,
	115	dsn64:1,
	116	data_fin:1,
	117	use_ack:1,
	118	ack64:1,
	119	mpc_map:1,
	120	__unused:2;
	121	u8 addr_id;
	122	u8 rm_id;
	123	union {
	124	struct in_addr addr;
	125	#if IS_ENABLED(CONFIG_MPTCP_IPV6)
	126	struct in6_addr addr6;
	127	#endif
	128	};
	129	u64 ahmac;
	130	u16 port;
	131	};
	132
3df523ab PK	133	static inline __be32 mptcp_option(u8 subopt, u8 len, u8 nib, u8 field)
	134	{
	135	return htonl((TCPOPT_MPTCP << 24) \| (len << 16) \| (subopt << 12) \|
	136	((nib & 0xF) << 8) \| field);
	137	}
	138
1b1c7a0e PK	139	struct mptcp_addr_info {
	140	sa_family_t family;
	141	__be16 port;
	142	u8 id;
	143	union {
	144	struct in_addr addr;
	145	#if IS_ENABLED(CONFIG_MPTCP_IPV6)
	146	struct in6_addr addr6;
	147	#endif
	148	};
	149	};
	150
	151	enum mptcp_pm_status {
	152	MPTCP_PM_ADD_ADDR_RECEIVED,
	153	MPTCP_PM_ESTABLISHED,
	154	MPTCP_PM_SUBFLOW_ESTABLISHED,
	155	};
	156
	157	struct mptcp_pm_data {
	158	struct mptcp_addr_info local;
	159	struct mptcp_addr_info remote;
	160
	161	spinlock_t lock; /protects the whole PM data /
	162
	163	bool addr_signal;
	164	bool server_side;
	165	bool work_pending;
	166	bool accept_addr;
	167	bool accept_subflow;
	168	u8 add_addr_signaled;
	169	u8 add_addr_accepted;
	170	u8 local_addr_used;
	171	u8 subflows;
	172	u8 add_addr_signal_max;
	173	u8 add_addr_accept_max;
	174	u8 local_addr_max;
	175	u8 subflows_max;
	176	u8 status;
1b1c7a0e PK	177	};
1b1c7a0e PK	178
18b683bf PA	179	struct mptcp_data_frag {
	180	struct list_head list;
	181	u64 data_seq;
	182	int data_len;
	183	int offset;
	184	int overhead;
	185	struct page *page;
	186	};
	187
f870fa0b MM	188	/* MPTCP connection sock */
	189	struct mptcp_sock {
	190	/* inet_connection_sock must be the first member */
	191	struct inet_connection_sock sk;
cec37a6e PK	192	u64 local_key;
cec37a6e PK	193	u64 remote_key;
6d0060f6 MM	194	u64 write_seq;
6d0060f6 MM	195	u64 ack_seq;
3721b9b6	196	u64 rcv_data_fin_seq;
cc9d2566	197	atomic64_t snd_una;
b51f9b80	198	unsigned long timer_ival;
79c0949e	199	u32 token;
648ef4b8	200	unsigned long flags;
d22f4988	201	bool can_ack;
b93df08c	202	bool fully_established;
3721b9b6	203	bool rcv_data_fin;
7279da61	204	bool snd_data_fin_enable;
ec3edaa7	205	spinlock_t join_list_lock;
80992017	206	struct work_struct work;
cec37a6e	207	struct list_head conn_list;
18b683bf	208	struct list_head rtx_queue;
ec3edaa7	209	struct list_head join_list;
6d0060f6	210	struct skb_ext cached_ext; / for the next sendmsg */
f870fa0b	211	struct socket subflow; / outgoing connect/listener/!mp_capable */
8ab183de	212	struct sock *first;
1b1c7a0e	213	struct mptcp_pm_data pm;
a6b118fe FW	214	struct {
	215	u32 space; /* bytes copied in last measurement window */
	216	u32 copied; /* bytes copied in this measurement window */
	217	u64 time; /* start time of measurement window */
	218	u64 rtt_us; /* last maximum rtt of subflows */
	219	} rcvq_space;
f870fa0b MM	220	};
f870fa0b MM	221
cec37a6e PK	222	#define mptcp_for_each_subflow(__msk, __subflow) \
	223	list_for_each_entry(__subflow, &((__msk)->conn_list), node)
	224
f870fa0b MM	225	static inline struct mptcp_sock mptcp_sk(const struct sock sk)
	226	{
	227	return (struct mptcp_sock *)sk;
	228	}
	229
18b683bf PA	230	static inline struct mptcp_data_frag mptcp_rtx_tail(const struct sock sk)
	231	{
	232	struct mptcp_sock *msk = mptcp_sk(sk);
	233
	234	if (list_empty(&msk->rtx_queue))
	235	return NULL;
	236
	237	return list_last_entry(&msk->rtx_queue, struct mptcp_data_frag, list);
	238	}
	239
7948f6cc FW	240	static inline struct mptcp_data_frag mptcp_rtx_head(const struct sock sk)
	241	{
	242	struct mptcp_sock *msk = mptcp_sk(sk);
	243
a386bc5b	244	return list_first_entry_or_null(&msk->rtx_queue, struct mptcp_data_frag, list);
7948f6cc FW	245	}
7948f6cc FW	246
cec37a6e PK	247	struct mptcp_subflow_request_sock {
cec37a6e PK	248	struct tcp_request_sock sk;
d22f4988	249	u16 mp_capable : 1,
cec37a6e	250	mp_join : 1,
fca5c82c	251	backup : 1;
1b1c7a0e	252	u8 local_id;
f296234c	253	u8 remote_id;
cec37a6e	254	u64 local_key;
79c0949e PK	255	u64 idsn;
79c0949e PK	256	u32 token;
648ef4b8	257	u32 ssn_offset;
f296234c PK	258	u64 thmac;
	259	u32 local_nonce;
	260	u32 remote_nonce;
8fd4de12	261	struct mptcp_sock *msk;
2c5ebd00	262	struct hlist_nulls_node token_node;
cec37a6e PK	263	};
	264
	265	static inline struct mptcp_subflow_request_sock *
	266	mptcp_subflow_rsk(const struct request_sock *rsk)
	267	{
	268	return (struct mptcp_subflow_request_sock *)rsk;
	269	}
	270
2303f994 PK	271	/* MPTCP subflow context */
2303f994 PK	272	struct mptcp_subflow_context {
cec37a6e PK	273	struct list_head node;/* conn_list of subflows */
	274	u64 local_key;
	275	u64 remote_key;
79c0949e	276	u64 idsn;
648ef4b8	277	u64 map_seq;
cc7972ea	278	u32 snd_isn;
79c0949e	279	u32 token;
6d0060f6	280	u32 rel_write_seq;
648ef4b8 MM	281	u32 map_subflow_seq;
	282	u32 ssn_offset;
	283	u32 map_data_len;
cec37a6e	284	u32 request_mptcp : 1, /* send MP_CAPABLE */
ec3edaa7 PK	285	request_join : 1, /* send MP_JOIN */
ec3edaa7 PK	286	request_bkup : 1,
cec37a6e	287	mp_capable : 1, /* remote is MPTCP capable */
f296234c	288	mp_join : 1, /* remote is JOINing */
0be534f5	289	fully_established : 1, /* path validated */
f296234c	290	pm_notified : 1, /* PM hook called for established status */
648ef4b8 MM	291	conn_finished : 1,
648ef4b8 MM	292	map_valid : 1,
d22f4988	293	mpc_map : 1,
f296234c	294	backup : 1,
648ef4b8	295	data_avail : 1,
d22f4988	296	rx_eof : 1,
a0c1d0ea	297	use_64bit_ack : 1, /* Set when we received a 64-bit DSN */
d22f4988	298	can_ack : 1; /* only after processing the remote a key */
f296234c PK	299	u32 remote_nonce;
	300	u64 thmac;
	301	u32 local_nonce;
ec3edaa7 PK	302	u32 remote_token;
ec3edaa7 PK	303	u8 hmac[MPTCPOPT_HMAC_LEN];
f296234c PK	304	u8 local_id;
f296234c PK	305	u8 remote_id;
648ef4b8	306
2303f994 PK	307	struct sock tcp_sock; / tcp sk backpointer */
2303f994 PK	308	struct sock conn; / parent mptcp_sock */
cec37a6e	309	const struct inet_connection_sock_af_ops *icsk_af_ops;
648ef4b8 MM	310	void (tcp_data_ready)(struct sock sk);
	311	void (tcp_state_change)(struct sock sk);
	312	void (tcp_write_space)(struct sock sk);
	313
2303f994 PK	314	struct rcu_head rcu;
	315	};
	316
	317	static inline struct mptcp_subflow_context *
	318	mptcp_subflow_ctx(const struct sock *sk)
	319	{
	320	struct inet_connection_sock *icsk = inet_csk(sk);
	321
	322	/* Use RCU on icsk_ulp_data only for sock diag code */
	323	return (__force struct mptcp_subflow_context *)icsk->icsk_ulp_data;
	324	}
	325
	326	static inline struct sock *
	327	mptcp_subflow_tcp_sock(const struct mptcp_subflow_context *subflow)
	328	{
	329	return subflow->tcp_sock;
	330	}
	331
648ef4b8 MM	332	static inline u64
	333	mptcp_subflow_get_map_offset(const struct mptcp_subflow_context *subflow)
	334	{
	335	return tcp_sk(mptcp_subflow_tcp_sock(subflow))->copied_seq -
	336	subflow->ssn_offset -
	337	subflow->map_subflow_seq;
	338	}
	339
	340	static inline u64
	341	mptcp_subflow_get_mapped_dsn(const struct mptcp_subflow_context *subflow)
	342	{
	343	return subflow->map_seq + mptcp_subflow_get_map_offset(subflow);
	344	}
	345
	346	int mptcp_is_enabled(struct net *net);
b93df08c PA	347	void mptcp_subflow_fully_established(struct mptcp_subflow_context *subflow,
b93df08c PA	348	struct mptcp_options_received *mp_opt);
648ef4b8	349	bool mptcp_subflow_data_available(struct sock *sk);
d39dceca	350	void __init mptcp_subflow_init(void);
ec3edaa7 PK	351
	352	/* called with sk socket lock held */
	353	int __mptcp_subflow_connect(struct sock *sk, int ifindex,
	354	const struct mptcp_addr_info *loc,
	355	const struct mptcp_addr_info *remote);
2303f994 PK	356	int mptcp_subflow_create_socket(struct sock sk, struct socket *new_sock);
2303f994 PK	357
648ef4b8 MM	358	static inline void mptcp_subflow_tcp_fallback(struct sock *sk,
	359	struct mptcp_subflow_context *ctx)
	360	{
	361	sk->sk_data_ready = ctx->tcp_data_ready;
	362	sk->sk_state_change = ctx->tcp_state_change;
	363	sk->sk_write_space = ctx->tcp_write_space;
	364
	365	inet_csk(sk)->icsk_af_ops = ctx->icsk_af_ops;
	366	}
	367
d39dceca	368	void __init mptcp_proto_init(void);
784325e9	369	#if IS_ENABLED(CONFIG_MPTCP_IPV6)
d39dceca	370	int __init mptcp_proto_v6_init(void);
784325e9	371	#endif
648ef4b8	372
fca5c82c	373	struct sock mptcp_sk_clone(const struct sock sk,
cfde141e	374	const struct mptcp_options_received *mp_opt,
fca5c82c	375	struct request_sock *req);
cec37a6e	376	void mptcp_get_options(const struct sk_buff *skb,
cfde141e	377	struct mptcp_options_received *mp_opt);
cec37a6e PK	378
cec37a6e PK	379	void mptcp_finish_connect(struct sock *sk);
b93df08c PA	380	static inline bool mptcp_is_fully_established(struct sock *sk)
	381	{
	382	return inet_sk_state_load(sk) == TCP_ESTABLISHED &&
	383	READ_ONCE(mptcp_sk(sk)->fully_established);
	384	}
a6b118fe	385	void mptcp_rcv_space_init(struct mptcp_sock msk, const struct sock ssk);
2e52213c	386	void mptcp_data_ready(struct sock sk, struct sock ssk);
f296234c	387	bool mptcp_finish_join(struct sock *sk);
b51f9b80	388	void mptcp_data_acked(struct sock *sk);
59832e24	389	void mptcp_subflow_eof(struct sock *sk);
3721b9b6	390	bool mptcp_update_rcv_data_fin(struct mptcp_sock *msk, u64 data_fin_seq);
cec37a6e	391
2c5ebd00 PA	392	void __init mptcp_token_init(void);
	393	static inline void mptcp_token_init_request(struct request_sock *req)
	394	{
	395	mptcp_subflow_rsk(req)->token_node.pprev = NULL;
	396	}
	397
79c0949e	398	int mptcp_token_new_request(struct request_sock *req);
2c5ebd00	399	void mptcp_token_destroy_request(struct request_sock *req);
79c0949e	400	int mptcp_token_new_connect(struct sock *sk);
2c5ebd00 PA	401	void mptcp_token_accept(struct mptcp_subflow_request_sock *r,
2c5ebd00 PA	402	struct mptcp_sock *msk);
c83a47e5	403	bool mptcp_token_exists(u32 token);
f296234c	404	struct mptcp_sock *mptcp_token_get_sock(u32 token);
96d890da PA	405	struct mptcp_sock mptcp_token_iter_next(const struct net net, long *s_slot,
96d890da PA	406	long *s_num);
2c5ebd00	407	void mptcp_token_destroy(struct mptcp_sock *msk);
79c0949e PK	408
79c0949e PK	409	void mptcp_crypto_key_sha(u64 key, u32 token, u64 idsn);
79c0949e	410
3df523ab	411	void mptcp_crypto_hmac_sha(u64 key1, u64 key2, u8 msg, int len, void hmac);
79c0949e	412
d39dceca	413	void __init mptcp_pm_init(void);
1b1c7a0e PK	414	void mptcp_pm_data_init(struct mptcp_sock *msk);
	415	void mptcp_pm_new_connection(struct mptcp_sock *msk, int server_side);
	416	void mptcp_pm_fully_established(struct mptcp_sock *msk);
	417	bool mptcp_pm_allow_new_subflow(struct mptcp_sock *msk);
	418	void mptcp_pm_connection_closed(struct mptcp_sock *msk);
	419	void mptcp_pm_subflow_established(struct mptcp_sock *msk,
	420	struct mptcp_subflow_context *subflow);
	421	void mptcp_pm_subflow_closed(struct mptcp_sock *msk, u8 id);
	422	void mptcp_pm_add_addr_received(struct mptcp_sock *msk,
	423	const struct mptcp_addr_info *addr);
	424
	425	int mptcp_pm_announce_addr(struct mptcp_sock *msk,
	426	const struct mptcp_addr_info *addr);
	427	int mptcp_pm_remove_addr(struct mptcp_sock *msk, u8 local_id);
	428	int mptcp_pm_remove_subflow(struct mptcp_sock *msk, u8 remote_id);
	429
	430	static inline bool mptcp_pm_should_signal(struct mptcp_sock *msk)
	431	{
	432	return READ_ONCE(msk->pm.addr_signal);
	433	}
	434
	435	static inline unsigned int mptcp_add_addr_len(int family)
	436	{
	437	if (family == AF_INET)
	438	return TCPOLEN_MPTCP_ADD_ADDR;
	439	return TCPOLEN_MPTCP_ADD_ADDR6;
	440	}
	441
	442	bool mptcp_pm_addr_signal(struct mptcp_sock *msk, unsigned int remaining,
	443	struct mptcp_addr_info *saddr);
	444	int mptcp_pm_get_local_id(struct mptcp_sock msk, struct sock_common skc);
	445
d39dceca	446	void __init mptcp_pm_nl_init(void);
01cacb00 PA	447	void mptcp_pm_nl_data_init(struct mptcp_sock *msk);
	448	void mptcp_pm_nl_fully_established(struct mptcp_sock *msk);
	449	void mptcp_pm_nl_subflow_established(struct mptcp_sock *msk);
	450	void mptcp_pm_nl_add_addr_received(struct mptcp_sock *msk);
	451	int mptcp_pm_nl_get_local_id(struct mptcp_sock msk, struct sock_common skc);
	452
6d0060f6 MM	453	static inline struct mptcp_ext mptcp_get_ext(struct sk_buff skb)
	454	{
	455	return (struct mptcp_ext *)skb_ext_find(skb, SKB_EXT_MPTCP);
	456	}
	457
648ef4b8 MM	458	static inline bool before64(__u64 seq1, __u64 seq2)
	459	{
	460	return (__s64)(seq1 - seq2) < 0;
	461	}
	462
	463	#define after64(seq2, seq1) before64(seq1, seq2)
	464
5147dfb5 DC	465	void mptcp_diag_subflow_init(struct tcp_ulp_ops *ops);
5147dfb5 DC	466
e1ff9e82 DC	467	static inline bool __mptcp_check_fallback(struct mptcp_sock *msk)
	468	{
	469	return test_bit(MPTCP_FALLBACK_DONE, &msk->flags);
	470	}
	471
	472	static inline bool mptcp_check_fallback(struct sock *sk)
	473	{
	474	struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
	475	struct mptcp_sock *msk = mptcp_sk(subflow->conn);
	476
	477	return __mptcp_check_fallback(msk);
	478	}
	479
	480	static inline void __mptcp_do_fallback(struct mptcp_sock *msk)
	481	{
	482	if (test_bit(MPTCP_FALLBACK_DONE, &msk->flags)) {
	483	pr_debug("TCP fallback already done (msk=%p)", msk);
	484	return;
	485	}
	486	set_bit(MPTCP_FALLBACK_DONE, &msk->flags);
	487	}
	488
	489	static inline void mptcp_do_fallback(struct sock *sk)
	490	{
	491	struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
	492	struct mptcp_sock *msk = mptcp_sk(subflow->conn);
	493
	494	__mptcp_do_fallback(msk);
	495	}
	496
	497	#define pr_fallback(a) pr_debug("%s:fallback to TCP (msk=%p)", __func__, a)
	498
8fd73804 DC	499	static inline bool subflow_simultaneous_connect(struct sock *sk)
	500	{
	501	struct mptcp_subflow_context *subflow = mptcp_subflow_ctx(sk);
	502	struct sock *parent = subflow->conn;
	503
	504	return sk->sk_state == TCP_ESTABLISHED &&
	505	!mptcp_sk(parent)->pm.server_side &&
	506	!subflow->conn_finished;
	507	}
	508
9466a1cc FW	509	#ifdef CONFIG_SYN_COOKIES
	510	void subflow_init_req_cookie_join_save(const struct mptcp_subflow_request_sock *subflow_req,
	511	struct sk_buff *skb);
	512	bool mptcp_token_join_cookie_init_state(struct mptcp_subflow_request_sock *subflow_req,
	513	struct sk_buff *skb);
	514	void __init mptcp_join_cookie_init(void);
	515	#else
	516	static inline void
	517	subflow_init_req_cookie_join_save(const struct mptcp_subflow_request_sock *subflow_req,
	518	struct sk_buff *skb) {}
	519	static inline bool
	520	mptcp_token_join_cookie_init_state(struct mptcp_subflow_request_sock *subflow_req,
	521	struct sk_buff *skb)
	522	{
	523	return false;
	524	}
	525
	526	static inline void mptcp_join_cookie_init(void) {}
	527	#endif
	528
f870fa0b	529	#endif /* __MPTCP_PROTOCOL_H */