[mirror_ubuntu-bionic-kernel.git] / net / smc / smc.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 *  Shared Memory Communications over RDMA (SMC-R) and RoCE
 *
 *  Definitions for the SMC module (socket related)
 *
 *  Copyright IBM Corp. 2016
 *
 *  Author(s):  Ursula Braun <ubraun@linux.vnet.ibm.com>
 */
#ifndef __SMC_H
#define __SMC_H

#include <linux/socket.h>
#include <linux/types.h>
#include <linux/compiler.h> /* __aligned */
#include <net/sock.h>

#include "smc_ib.h"

#define SMCPROTO_SMC		0	/* SMC protocol */

#define SMC_MAX_PORTS		2	/* Max # of ports */

extern struct proto smc_proto;

#ifdef ATOMIC64_INIT
#define KERNEL_HAS_ATOMIC64
#endif

enum smc_state {		/* possible states of an SMC socket */
	SMC_ACTIVE	= 1,
	SMC_INIT	= 2,
	SMC_CLOSED	= 7,
	SMC_LISTEN	= 10,
	/* normal close */
	SMC_PEERCLOSEWAIT1	= 20,
	SMC_PEERCLOSEWAIT2	= 21,
	SMC_APPFINCLOSEWAIT	= 24,
	SMC_APPCLOSEWAIT1	= 22,
	SMC_APPCLOSEWAIT2	= 23,
	SMC_PEERFINCLOSEWAIT	= 25,
	/* abnormal close */
	SMC_PEERABORTWAIT	= 26,
	SMC_PROCESSABORT	= 27,
};

struct smc_link_group;

struct smc_wr_rx_hdr {	/* common prefix part of LLC and CDC to demultiplex */
	u8			type;
} __aligned(1);

struct smc_cdc_conn_state_flags {
#if defined(__BIG_ENDIAN_BITFIELD)
	u8	peer_done_writing : 1;	/* Sending done indicator */
	u8	peer_conn_closed : 1;	/* Peer connection closed indicator */
	u8	peer_conn_abort : 1;	/* Abnormal close indicator */
	u8	reserved : 5;
#elif defined(__LITTLE_ENDIAN_BITFIELD)
	u8	reserved : 5;
	u8	peer_conn_abort : 1;
	u8	peer_conn_closed : 1;
	u8	peer_done_writing : 1;
#endif
};

struct smc_cdc_producer_flags {
#if defined(__BIG_ENDIAN_BITFIELD)
	u8	write_blocked : 1;	/* Writing Blocked, no rx buf space */
	u8	urg_data_pending : 1;	/* Urgent Data Pending */
	u8	urg_data_present : 1;	/* Urgent Data Present */
	u8	cons_curs_upd_req : 1;	/* cursor update requested */
	u8	failover_validation : 1;/* message replay due to failover */
	u8	reserved : 3;
#elif defined(__LITTLE_ENDIAN_BITFIELD)
	u8	reserved : 3;
	u8	failover_validation : 1;
	u8	cons_curs_upd_req : 1;
	u8	urg_data_present : 1;
	u8	urg_data_pending : 1;
	u8	write_blocked : 1;
#endif
};

/* in host byte order */
union smc_host_cursor {	/* SMC cursor - an offset in an RMBE */
	struct {
		u16	reserved;
		u16	wrap;		/* window wrap sequence number */
		u32	count;		/* cursor (= offset) part */
	};
#ifdef KERNEL_HAS_ATOMIC64
	atomic64_t		acurs;	/* for atomic processing */
#else
	u64			acurs;	/* for atomic processing */
#endif
} __aligned(8);

/* in host byte order, except for flag bitfields in network byte order */
struct smc_host_cdc_msg {		/* Connection Data Control message */
	struct smc_wr_rx_hdr		common; /* .type = 0xFE */
	u8				len;	/* length = 44 */
	u16				seqno;	/* connection seq # */
	u32				token;	/* alert_token */
	union smc_host_cursor		prod;		/* producer cursor */
	union smc_host_cursor		cons;		/* consumer cursor,
							 * piggy backed "ack"
							 */
	struct smc_cdc_producer_flags	prod_flags;	/* conn. tx/rx status */
	struct smc_cdc_conn_state_flags	conn_state_flags; /* peer conn. status*/
	u8				reserved[18];
} __aligned(8);

struct smc_connection {
	struct rb_node		alert_node;
	struct smc_link_group	*lgr;		/* link group of connection */
	u32			alert_token_local; /* unique conn. id */
	u8			peer_conn_idx;	/* from tcp handshake */
	int			peer_rmbe_size;	/* size of peer rx buffer */
	atomic_t		peer_rmbe_space;/* remaining free bytes in peer
						 * rmbe
						 */
	int			rtoken_idx;	/* idx to peer RMB rkey/addr */

	struct smc_buf_desc	*sndbuf_desc;	/* send buffer descriptor */
	int			sndbuf_size;	/* sndbuf size <== sock wmem */
	struct smc_buf_desc	*rmb_desc;	/* RMBE descriptor */
	int			rmbe_size;	/* RMBE size <== sock rmem */
	int			rmbe_size_short;/* compressed notation */
	int			rmbe_update_limit;
						/* lower limit for consumer
						 * cursor update
						 */

	struct smc_host_cdc_msg	local_tx_ctrl;	/* host byte order staging
						 * buffer for CDC msg send
						 * .prod cf. TCP snd_nxt
						 * .cons cf. TCP sends ack
						 */
	union smc_host_cursor	tx_curs_prep;	/* tx - prepared data
						 * snd_max..wmem_alloc
						 */
	union smc_host_cursor	tx_curs_sent;	/* tx - sent data
						 * snd_nxt ?
						 */
	union smc_host_cursor	tx_curs_fin;	/* tx - confirmed by peer
						 * snd-wnd-begin ?
						 */
	atomic_t		sndbuf_space;	/* remaining space in sndbuf */
	u16			tx_cdc_seq;	/* sequence # for CDC send */
	spinlock_t		send_lock;	/* protect wr_sends */
	struct delayed_work	tx_work;	/* retry of smc_cdc_msg_send */

	struct smc_host_cdc_msg	local_rx_ctrl;	/* filled during event_handl.
						 * .prod cf. TCP rcv_nxt
						 * .cons cf. TCP snd_una
						 */
	union smc_host_cursor	rx_curs_confirmed; /* confirmed to peer
						    * source of snd_una ?
						    */
	atomic_t		bytes_to_rcv;	/* arrived data,
						 * not yet received
						 */
#ifndef KERNEL_HAS_ATOMIC64
	spinlock_t		acurs_lock;	/* protect cursors */
#endif
	struct work_struct	close_work;	/* peer sent some closing */
};

struct smc_sock {				/* smc sock container */
	struct sock		sk;
	struct socket		*clcsock;	/* internal tcp socket */
	struct smc_connection	conn;		/* smc connection */
	struct sockaddr		*addr;		/* inet connect address */
	struct smc_sock		*listen_smc;	/* listen parent */
	struct work_struct	tcp_listen_work;/* handle tcp socket accepts */
	struct work_struct	smc_listen_work;/* prepare new accept socket */
	struct list_head	accept_q;	/* sockets to be accepted */
	spinlock_t		accept_q_lock;	/* protects accept_q */
	struct delayed_work	sock_put_work;	/* final socket freeing */
	bool			use_fallback;	/* fallback to tcp */
	u8			wait_close_tx_prepared : 1;
						/* shutdown wr or close
						 * started, waiting for unsent
						 * data to be sent
						 */
};

static inline struct smc_sock *smc_sk(const struct sock *sk)
{
	return (struct smc_sock *)sk;
}

#define SMC_SYSTEMID_LEN		8

extern u8	local_systemid[SMC_SYSTEMID_LEN]; /* unique system identifier */

/* convert an u32 value into network byte order, store it into a 3 byte field */
static inline void hton24(u8 *net, u32 host)
{
	__be32 t;

	t = cpu_to_be32(host);
	memcpy(net, ((u8 *)&t) + 1, 3);
}

/* convert a received 3 byte field into host byte order*/
static inline u32 ntoh24(u8 *net)
{
	__be32 t = 0;

	memcpy(((u8 *)&t) + 1, net, 3);
	return be32_to_cpu(t);
}

#define SMC_BUF_MIN_SIZE 16384		/* minimum size of an RMB */

#define SMC_RMBE_SIZES	16	/* number of distinct sizes for an RMBE */
/* theoretically, the RFC states that largest size would be 512K,
 * i.e. compressed 5 and thus 6 sizes (0..5), despite
 * struct smc_clc_msg_accept_confirm.rmbe_size being a 4 bit value (0..15)
 */

/* convert the RMB size into the compressed notation - minimum 16K.
 * In contrast to plain ilog2, this rounds towards the next power of 2,
 * so the socket application gets at least its desired sndbuf / rcvbuf size.
 */
static inline u8 smc_compress_bufsize(int size)
{
	u8 compressed;

	if (size <= SMC_BUF_MIN_SIZE)
		return 0;

	size = (size - 1) >> 14;
	compressed = ilog2(size) + 1;
	if (compressed >= SMC_RMBE_SIZES)
		compressed = SMC_RMBE_SIZES - 1;
	return compressed;
}

/* convert the RMB size from compressed notation into integer */
static inline int smc_uncompress_bufsize(u8 compressed)
{
	u32 size;

	size = 0x00000001 << (((int)compressed) + 14);
	return (int)size;
}

#ifdef CONFIG_XFRM
static inline bool using_ipsec(struct smc_sock *smc)
{
	return (smc->clcsock->sk->sk_policy[0] ||
		smc->clcsock->sk->sk_policy[1]) ? 1 : 0;
}
#else
static inline bool using_ipsec(struct smc_sock *smc)
{
	return 0;
}
#endif

struct smc_clc_msg_local;

int smc_netinfo_by_tcpsk(struct socket *clcsock, __be32 *subnet,
			 u8 *prefix_len);
void smc_conn_free(struct smc_connection *conn);
int smc_conn_create(struct smc_sock *smc, __be32 peer_in_addr,
		    struct smc_ib_device *smcibdev, u8 ibport,
		    struct smc_clc_msg_local *lcl, int srv_first_contact);
struct sock *smc_accept_dequeue(struct sock *parent, struct socket *new_sock);
void smc_close_non_accepted(struct sock *sk);

#endif	/* __SMC_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
ac713874 UB	2	/*
	3	* Shared Memory Communications over RDMA (SMC-R) and RoCE
	4	*
	5	* Definitions for the SMC module (socket related)
	6	*
	7	* Copyright IBM Corp. 2016
	8	*
	9	* Author(s): Ursula Braun <ubraun@linux.vnet.ibm.com>
	10	*/
	11	#ifndef __SMC_H
	12	#define __SMC_H
	13
	14	#include <linux/socket.h>
	15	#include <linux/types.h>
f38ba179	16	#include <linux/compiler.h> /* __aligned */
ac713874 UB	17	#include <net/sock.h>
ac713874 UB	18
0cfdd8f9 UB	19	#include "smc_ib.h"
0cfdd8f9 UB	20
ac713874 UB	21	#define SMCPROTO_SMC 0 /* SMC protocol */
ac713874 UB	22
a4cf0443 UB	23	#define SMC_MAX_PORTS 2 /* Max # of ports */
a4cf0443 UB	24
f16a7dd5 UB	25	extern struct proto smc_proto;
f16a7dd5 UB	26
5f08318f UB	27	#ifdef ATOMIC64_INIT
	28	#define KERNEL_HAS_ATOMIC64
	29	#endif
	30
ac713874 UB	31	enum smc_state { /* possible states of an SMC socket */
	32	SMC_ACTIVE = 1,
	33	SMC_INIT = 2,
	34	SMC_CLOSED = 7,
	35	SMC_LISTEN = 10,
b38d7324 UB	36	/* normal close */
	37	SMC_PEERCLOSEWAIT1 = 20,
	38	SMC_PEERCLOSEWAIT2 = 21,
	39	SMC_APPFINCLOSEWAIT = 24,
	40	SMC_APPCLOSEWAIT1 = 22,
	41	SMC_APPCLOSEWAIT2 = 23,
	42	SMC_PEERFINCLOSEWAIT = 25,
	43	/* abnormal close */
	44	SMC_PEERABORTWAIT = 26,
	45	SMC_PROCESSABORT = 27,
ac713874 UB	46	};
ac713874 UB	47
0cfdd8f9 UB	48	struct smc_link_group;
0cfdd8f9 UB	49
f38ba179 UB	50	struct smc_wr_rx_hdr { /* common prefix part of LLC and CDC to demultiplex */
	51	u8 type;
	52	} __aligned(1);
	53
5f08318f UB	54	struct smc_cdc_conn_state_flags {
	55	#if defined(__BIG_ENDIAN_BITFIELD)
	56	u8 peer_done_writing : 1; /* Sending done indicator */
	57	u8 peer_conn_closed : 1; /* Peer connection closed indicator */
	58	u8 peer_conn_abort : 1; /* Abnormal close indicator */
	59	u8 reserved : 5;
	60	#elif defined(__LITTLE_ENDIAN_BITFIELD)
	61	u8 reserved : 5;
	62	u8 peer_conn_abort : 1;
	63	u8 peer_conn_closed : 1;
	64	u8 peer_done_writing : 1;
	65	#endif
	66	};
	67
	68	struct smc_cdc_producer_flags {
	69	#if defined(__BIG_ENDIAN_BITFIELD)
	70	u8 write_blocked : 1; /* Writing Blocked, no rx buf space */
	71	u8 urg_data_pending : 1; /* Urgent Data Pending */
	72	u8 urg_data_present : 1; /* Urgent Data Present */
	73	u8 cons_curs_upd_req : 1; /* cursor update requested */
	74	u8 failover_validation : 1;/* message replay due to failover */
	75	u8 reserved : 3;
	76	#elif defined(__LITTLE_ENDIAN_BITFIELD)
	77	u8 reserved : 3;
	78	u8 failover_validation : 1;
	79	u8 cons_curs_upd_req : 1;
	80	u8 urg_data_present : 1;
	81	u8 urg_data_pending : 1;
	82	u8 write_blocked : 1;
	83	#endif
	84	};
	85
	86	/* in host byte order */
	87	union smc_host_cursor { /* SMC cursor - an offset in an RMBE */
	88	struct {
	89	u16 reserved;
	90	u16 wrap; /* window wrap sequence number */
	91	u32 count; /* cursor (= offset) part */
	92	};
	93	#ifdef KERNEL_HAS_ATOMIC64
	94	atomic64_t acurs; /* for atomic processing */
	95	#else
	96	u64 acurs; /* for atomic processing */
	97	#endif
	98	} __aligned(8);
	99
	100	/* in host byte order, except for flag bitfields in network byte order */
	101	struct smc_host_cdc_msg { /* Connection Data Control message */
	102	struct smc_wr_rx_hdr common; /* .type = 0xFE */
	103	u8 len; /* length = 44 */
	104	u16 seqno; /* connection seq # */
	105	u32 token; /* alert_token */
	106	union smc_host_cursor prod; /* producer cursor */
	107	union smc_host_cursor cons; /* consumer cursor,
	108	* piggy backed "ack"
	109	*/
	110	struct smc_cdc_producer_flags prod_flags; /* conn. tx/rx status */
	111	struct smc_cdc_conn_state_flags conn_state_flags; /* peer conn. status*/
	112	u8 reserved[18];
	113	} __aligned(8);
	114
0cfdd8f9 UB	115	struct smc_connection {
	116	struct rb_node alert_node;
	117	struct smc_link_group lgr; / link group of connection */
	118	u32 alert_token_local; /* unique conn. id */
	119	u8 peer_conn_idx; /* from tcp handshake */
cd6851f3 UB	120	int peer_rmbe_size; /* size of peer rx buffer */
	121	atomic_t peer_rmbe_space;/* remaining free bytes in peer
	122	* rmbe
	123	*/
bd4ad577	124	int rtoken_idx; /* idx to peer RMB rkey/addr */
cd6851f3 UB	125
	126	struct smc_buf_desc sndbuf_desc; / send buffer descriptor */
	127	int sndbuf_size; /* sndbuf size <== sock wmem */
	128	struct smc_buf_desc rmb_desc; / RMBE descriptor */
	129	int rmbe_size; /* RMBE size <== sock rmem */
	130	int rmbe_size_short;/* compressed notation */
952310cc UB	131	int rmbe_update_limit;
	132	/* lower limit for consumer
	133	* cursor update
	134	*/
5f08318f UB	135
	136	struct smc_host_cdc_msg local_tx_ctrl; /* host byte order staging
	137	* buffer for CDC msg send
	138	* .prod cf. TCP snd_nxt
	139	* .cons cf. TCP sends ack
	140	*/
	141	union smc_host_cursor tx_curs_prep; /* tx - prepared data
	142	* snd_max..wmem_alloc
	143	*/
	144	union smc_host_cursor tx_curs_sent; /* tx - sent data
	145	* snd_nxt ?
	146	*/
	147	union smc_host_cursor tx_curs_fin; /* tx - confirmed by peer
	148	* snd-wnd-begin ?
	149	*/
	150	atomic_t sndbuf_space; /* remaining space in sndbuf */
	151	u16 tx_cdc_seq; /* sequence # for CDC send */
	152	spinlock_t send_lock; /* protect wr_sends */
18e537cd	153	struct delayed_work tx_work; /* retry of smc_cdc_msg_send */
5f08318f UB	154
	155	struct smc_host_cdc_msg local_rx_ctrl; /* filled during event_handl.
	156	* .prod cf. TCP rcv_nxt
	157	* .cons cf. TCP snd_una
	158	*/
	159	union smc_host_cursor rx_curs_confirmed; /* confirmed to peer
	160	* source of snd_una ?
	161	*/
	162	atomic_t bytes_to_rcv; /* arrived data,
	163	* not yet received
	164	*/
	165	#ifndef KERNEL_HAS_ATOMIC64
	166	spinlock_t acurs_lock; /* protect cursors */
	167	#endif
46c28dbd	168	struct work_struct close_work; /* peer sent some closing */
0cfdd8f9 UB	169	};
0cfdd8f9 UB	170
ac713874 UB	171	struct smc_sock { /* smc sock container */
	172	struct sock sk;
	173	struct socket clcsock; / internal tcp socket */
0cfdd8f9	174	struct smc_connection conn; /* smc connection */
a046d57d UB	175	struct sockaddr addr; / inet connect address */
	176	struct smc_sock listen_smc; / listen parent */
	177	struct work_struct tcp_listen_work;/* handle tcp socket accepts */
	178	struct work_struct smc_listen_work;/* prepare new accept socket */
	179	struct list_head accept_q; /* sockets to be accepted */
	180	spinlock_t accept_q_lock; /* protects accept_q */
b38d7324	181	struct delayed_work sock_put_work; /* final socket freeing */
ac713874	182	bool use_fallback; /* fallback to tcp */
b38d7324 UB	183	u8 wait_close_tx_prepared : 1;
	184	/* shutdown wr or close
	185	* started, waiting for unsent
	186	* data to be sent
	187	*/
ac713874 UB	188	};
	189
	190	static inline struct smc_sock smc_sk(const struct sock sk)
	191	{
	192	return (struct smc_sock *)sk;
	193	}
	194
a4cf0443 UB	195	#define SMC_SYSTEMID_LEN 8
	196
	197	extern u8 local_systemid[SMC_SYSTEMID_LEN]; /* unique system identifier */
	198
0cfdd8f9 UB	199	/* convert an u32 value into network byte order, store it into a 3 byte field */
	200	static inline void hton24(u8 *net, u32 host)
	201	{
	202	__be32 t;
	203
	204	t = cpu_to_be32(host);
	205	memcpy(net, ((u8 *)&t) + 1, 3);
	206	}
	207
	208	/* convert a received 3 byte field into host byte order*/
	209	static inline u32 ntoh24(u8 *net)
	210	{
	211	__be32 t = 0;
	212
	213	memcpy(((u8 *)&t) + 1, net, 3);
	214	return be32_to_cpu(t);
	215	}
	216
cd6851f3 UB	217	#define SMC_BUF_MIN_SIZE 16384 /* minimum size of an RMB */
	218
	219	#define SMC_RMBE_SIZES 16 /* number of distinct sizes for an RMBE */
	220	/* theoretically, the RFC states that largest size would be 512K,
	221	* i.e. compressed 5 and thus 6 sizes (0..5), despite
	222	* struct smc_clc_msg_accept_confirm.rmbe_size being a 4 bit value (0..15)
	223	*/
	224
	225	/* convert the RMB size into the compressed notation - minimum 16K.
	226	* In contrast to plain ilog2, this rounds towards the next power of 2,
	227	* so the socket application gets at least its desired sndbuf / rcvbuf size.
	228	*/
	229	static inline u8 smc_compress_bufsize(int size)
	230	{
	231	u8 compressed;
	232
	233	if (size <= SMC_BUF_MIN_SIZE)
	234	return 0;
	235
	236	size = (size - 1) >> 14;
	237	compressed = ilog2(size) + 1;
	238	if (compressed >= SMC_RMBE_SIZES)
	239	compressed = SMC_RMBE_SIZES - 1;
	240	return compressed;
	241	}
	242
	243	/* convert the RMB size from compressed notation into integer */
	244	static inline int smc_uncompress_bufsize(u8 compressed)
	245	{
	246	u32 size;
	247
	248	size = 0x00000001 << (((int)compressed) + 14);
	249	return (int)size;
	250	}
	251
a046d57d UB	252	#ifdef CONFIG_XFRM
	253	static inline bool using_ipsec(struct smc_sock *smc)
	254	{
	255	return (smc->clcsock->sk->sk_policy[0] \|\|
	256	smc->clcsock->sk->sk_policy[1]) ? 1 : 0;
	257	}
	258	#else
	259	static inline bool using_ipsec(struct smc_sock *smc)
	260	{
	261	return 0;
	262	}
	263	#endif
	264
0cfdd8f9 UB	265	struct smc_clc_msg_local;
0cfdd8f9 UB	266
a046d57d UB	267	int smc_netinfo_by_tcpsk(struct socket clcsock, __be32 subnet,
a046d57d UB	268	u8 *prefix_len);
0cfdd8f9 UB	269	void smc_conn_free(struct smc_connection *conn);
	270	int smc_conn_create(struct smc_sock *smc, __be32 peer_in_addr,
	271	struct smc_ib_device *smcibdev, u8 ibport,
	272	struct smc_clc_msg_local *lcl, int srv_first_contact);
b38d7324 UB	273	struct sock smc_accept_dequeue(struct sock parent, struct socket *new_sock);
b38d7324 UB	274	void smc_close_non_accepted(struct sock *sk);
a046d57d	275
ac713874	276	#endif /* __SMC_H */