[linux.git] / net / smc / smc_clc.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 *  Shared Memory Communications over RDMA (SMC-R) and RoCE
 *
 *  CLC (connection layer control) handshake over initial TCP socket to
 *  prepare for RDMA traffic
 *
 *  Copyright IBM Corp. 2016
 *
 *  Author(s):  Ursula Braun <[email protected]>
 */

#ifndef _SMC_CLC_H
#define _SMC_CLC_H

#include <rdma/ib_verbs.h>

#include "smc.h"

#define SMC_CLC_PROPOSAL	0x01
#define SMC_CLC_ACCEPT		0x02
#define SMC_CLC_CONFIRM		0x03
#define SMC_CLC_DECLINE		0x04

#define SMC_CLC_V1		0x1		/* SMC version                */
#define SMC_TYPE_R		0		/* SMC-R only		      */
#define SMC_TYPE_D		1		/* SMC-D only		      */
#define SMC_TYPE_B		3		/* SMC-R and SMC-D	      */
#define CLC_WAIT_TIME		(6 * HZ)	/* max. wait time on clcsock  */
#define CLC_WAIT_TIME_SHORT	HZ		/* short wait time on clcsock */
#define SMC_CLC_DECL_MEM	0x01010000  /* insufficient memory resources  */
#define SMC_CLC_DECL_TIMEOUT_CL	0x02010000  /* timeout w4 QP confirm link     */
#define SMC_CLC_DECL_TIMEOUT_AL	0x02020000  /* timeout w4 QP add link	      */
#define SMC_CLC_DECL_CNFERR	0x03000000  /* configuration error            */
#define SMC_CLC_DECL_PEERNOSMC	0x03010000  /* peer did not indicate SMC      */
#define SMC_CLC_DECL_IPSEC	0x03020000  /* IPsec usage		      */
#define SMC_CLC_DECL_NOSMCDEV	0x03030000  /* no SMC device found	      */
#define SMC_CLC_DECL_MODEUNSUPP	0x03040000  /* smc modes do not match (R or D)*/
#define SMC_CLC_DECL_RMBE_EC	0x03050000  /* peer has eyecatcher in RMBE    */
#define SMC_CLC_DECL_OPTUNSUPP	0x03060000  /* fastopen sockopt not supported */
#define SMC_CLC_DECL_DIFFPREFIX	0x03070000  /* IP prefix / subnet mismatch    */
#define SMC_CLC_DECL_GETVLANERR	0x03080000  /* err to get vlan id of ip device*/
#define SMC_CLC_DECL_SYNCERR	0x04000000  /* synchronization error          */
#define SMC_CLC_DECL_PEERDECL	0x05000000  /* peer declined during handshake */
#define SMC_CLC_DECL_INTERR	0x09990000  /* internal error		      */
#define SMC_CLC_DECL_ERR_RTOK	0x09990001  /*	 rtoken handling failed       */
#define SMC_CLC_DECL_ERR_RDYLNK	0x09990002  /*	 ib ready link failed	      */
#define SMC_CLC_DECL_ERR_REGRMB	0x09990003  /*	 reg rmb failed		      */

struct smc_clc_msg_hdr {	/* header1 of clc messages */
	u8 eyecatcher[4];	/* eye catcher */
	u8 type;		/* proposal / accept / confirm / decline */
	__be16 length;
#if defined(__BIG_ENDIAN_BITFIELD)
	u8 version : 4,
	   flag    : 1,
	   rsvd	   : 1,
	   path	   : 2;
#elif defined(__LITTLE_ENDIAN_BITFIELD)
	u8 path    : 2,
	   rsvd    : 1,
	   flag    : 1,
	   version : 4;
#endif
} __packed;			/* format defined in RFC7609 */

struct smc_clc_msg_trail {	/* trailer of clc messages */
	u8 eyecatcher[4];
};

struct smc_clc_msg_local {	/* header2 of clc messages */
	u8 id_for_peer[SMC_SYSTEMID_LEN]; /* unique system id */
	u8 gid[16];		/* gid of ib_device port */
	u8 mac[6];		/* mac of ib_device port */
};

#define SMC_CLC_MAX_V6_PREFIX	8

/* Struct would be 4 byte aligned, but it is used in an array that is sent
 * to peers and must conform to RFC7609, hence we need to use packed here.
 */
struct smc_clc_ipv6_prefix {
	struct in6_addr prefix;
	u8 prefix_len;
} __packed;			/* format defined in RFC7609 */

struct smc_clc_msg_proposal_prefix {	/* prefix part of clc proposal message*/
	__be32 outgoing_subnet;	/* subnet mask */
	u8 prefix_len;		/* number of significant bits in mask */
	u8 reserved[2];
	u8 ipv6_prefixes_cnt;	/* number of IPv6 prefixes in prefix array */
} __aligned(4);

struct smc_clc_msg_smcd {	/* SMC-D GID information */
	u64 gid;		/* ISM GID of requestor */
	u8 res[32];
};

struct smc_clc_msg_proposal {	/* clc proposal message sent by Linux */
	struct smc_clc_msg_hdr hdr;
	struct smc_clc_msg_local lcl;
	__be16 iparea_offset;	/* offset to IP address information area */
} __aligned(4);

#define SMC_CLC_PROPOSAL_MAX_OFFSET	0x28
#define SMC_CLC_PROPOSAL_MAX_PREFIX	(SMC_CLC_MAX_V6_PREFIX * \
					 sizeof(struct smc_clc_ipv6_prefix))
#define SMC_CLC_MAX_LEN		(sizeof(struct smc_clc_msg_proposal) + \
				 SMC_CLC_PROPOSAL_MAX_OFFSET + \
				 sizeof(struct smc_clc_msg_proposal_prefix) + \
				 SMC_CLC_PROPOSAL_MAX_PREFIX + \
				 sizeof(struct smc_clc_msg_trail))

struct smc_clc_msg_accept_confirm {	/* clc accept / confirm message */
	struct smc_clc_msg_hdr hdr;
	union {
		struct { /* SMC-R */
			struct smc_clc_msg_local lcl;
			u8 qpn[3];		/* QP number */
			__be32 rmb_rkey;	/* RMB rkey */
			u8 rmbe_idx;		/* Index of RMBE in RMB */
			__be32 rmbe_alert_token;/* unique connection id */
#if defined(__BIG_ENDIAN_BITFIELD)
			u8 rmbe_size : 4,	/* buf size (compressed) */
			   qp_mtu   : 4;	/* QP mtu */
#elif defined(__LITTLE_ENDIAN_BITFIELD)
			u8 qp_mtu   : 4,
			   rmbe_size : 4;
#endif
			u8 reserved;
			__be64 rmb_dma_addr;	/* RMB virtual address */
			u8 reserved2;
			u8 psn[3];		/* packet sequence number */
			struct smc_clc_msg_trail smcr_trl;
						/* eye catcher "SMCR" EBCDIC */
		} __packed;
		struct { /* SMC-D */
			u64 gid;		/* Sender GID */
			u64 token;		/* DMB token */
			u8 dmbe_idx;		/* DMBE index */
#if defined(__BIG_ENDIAN_BITFIELD)
			u8 dmbe_size : 4,	/* buf size (compressed) */
			   reserved3 : 4;
#elif defined(__LITTLE_ENDIAN_BITFIELD)
			u8 reserved3 : 4,
			   dmbe_size : 4;
#endif
			u16 reserved4;
			u32 linkid;		/* Link identifier */
			u32 reserved5[3];
			struct smc_clc_msg_trail smcd_trl;
						/* eye catcher "SMCD" EBCDIC */
		} __packed;
	};
} __packed;			/* format defined in RFC7609 */

struct smc_clc_msg_decline {	/* clc decline message */
	struct smc_clc_msg_hdr hdr;
	u8 id_for_peer[SMC_SYSTEMID_LEN]; /* sender peer_id */
	__be32 peer_diagnosis;	/* diagnosis information */
	u8 reserved2[4];
	struct smc_clc_msg_trail trl; /* eye catcher "SMCR" EBCDIC */
} __aligned(4);

/* determine start of the prefix area within the proposal message */
static inline struct smc_clc_msg_proposal_prefix *
smc_clc_proposal_get_prefix(struct smc_clc_msg_proposal *pclc)
{
	return (struct smc_clc_msg_proposal_prefix *)
	       ((u8 *)pclc + sizeof(*pclc) + ntohs(pclc->iparea_offset));
}

/* get SMC-D info from proposal message */
static inline struct smc_clc_msg_smcd *
smc_get_clc_msg_smcd(struct smc_clc_msg_proposal *prop)
{
	if (ntohs(prop->iparea_offset) != sizeof(struct smc_clc_msg_smcd))
		return NULL;

	return (struct smc_clc_msg_smcd *)(prop + 1);
}

struct smcd_dev;
struct smc_init_info;

int smc_clc_prfx_match(struct socket *clcsock,
		       struct smc_clc_msg_proposal_prefix *prop);
int smc_clc_wait_msg(struct smc_sock *smc, void *buf, int buflen,
		     u8 expected_type, unsigned long timeout);
int smc_clc_send_decline(struct smc_sock *smc, u32 peer_diag_info);
int smc_clc_send_proposal(struct smc_sock *smc, int smc_type,
			  struct smc_init_info *ini);
int smc_clc_send_confirm(struct smc_sock *smc);
int smc_clc_send_accept(struct smc_sock *smc, int srv_first_contact);

#endif
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
a046d57d UB	2	/*
	3	* Shared Memory Communications over RDMA (SMC-R) and RoCE
	4	*
	5	* CLC (connection layer control) handshake over initial TCP socket to
	6	* prepare for RDMA traffic
	7	*
	8	* Copyright IBM Corp. 2016
	9	*
	10	* Author(s): Ursula Braun <[email protected]>
	11	*/
	12
	13	#ifndef _SMC_CLC_H
	14	#define _SMC_CLC_H
	15
	16	#include <rdma/ib_verbs.h>
	17
	18	#include "smc.h"
	19
	20	#define SMC_CLC_PROPOSAL 0x01
	21	#define SMC_CLC_ACCEPT 0x02
	22	#define SMC_CLC_CONFIRM 0x03
	23	#define SMC_CLC_DECLINE 0x04
	24
a046d57d	25	#define SMC_CLC_V1 0x1 /* SMC version */
c758dfdd HW	26	#define SMC_TYPE_R 0 /* SMC-R only */
	27	#define SMC_TYPE_D 1 /* SMC-D only */
	28	#define SMC_TYPE_B 3 /* SMC-R and SMC-D */
a046d57d	29	#define CLC_WAIT_TIME (6 * HZ) /* max. wait time on clcsock */
2b59f58e	30	#define CLC_WAIT_TIME_SHORT HZ /* short wait time on clcsock */
a046d57d	31	#define SMC_CLC_DECL_MEM 0x01010000 /* insufficient memory resources */
603cc149 KG	32	#define SMC_CLC_DECL_TIMEOUT_CL 0x02010000 /* timeout w4 QP confirm link */
603cc149 KG	33	#define SMC_CLC_DECL_TIMEOUT_AL 0x02020000 /* timeout w4 QP add link */
a046d57d	34	#define SMC_CLC_DECL_CNFERR 0x03000000 /* configuration error */
603cc149 KG	35	#define SMC_CLC_DECL_PEERNOSMC 0x03010000 /* peer did not indicate SMC */
	36	#define SMC_CLC_DECL_IPSEC 0x03020000 /* IPsec usage */
	37	#define SMC_CLC_DECL_NOSMCDEV 0x03030000 /* no SMC device found */
	38	#define SMC_CLC_DECL_MODEUNSUPP 0x03040000 /* smc modes do not match (R or D)*/
	39	#define SMC_CLC_DECL_RMBE_EC 0x03050000 /* peer has eyecatcher in RMBE */
	40	#define SMC_CLC_DECL_OPTUNSUPP 0x03060000 /* fastopen sockopt not supported */
59886697	41	#define SMC_CLC_DECL_DIFFPREFIX 0x03070000 /* IP prefix / subnet mismatch */
fba7e8ef	42	#define SMC_CLC_DECL_GETVLANERR 0x03080000 /* err to get vlan id of ip device*/
a046d57d	43	#define SMC_CLC_DECL_SYNCERR 0x04000000 /* synchronization error */
603cc149	44	#define SMC_CLC_DECL_PEERDECL 0x05000000 /* peer declined during handshake */
4ada81fd KG	45	#define SMC_CLC_DECL_INTERR 0x09990000 /* internal error */
	46	#define SMC_CLC_DECL_ERR_RTOK 0x09990001 /* rtoken handling failed */
	47	#define SMC_CLC_DECL_ERR_RDYLNK 0x09990002 /* ib ready link failed */
	48	#define SMC_CLC_DECL_ERR_REGRMB 0x09990003 /* reg rmb failed */
a046d57d UB	49
	50	struct smc_clc_msg_hdr { /* header1 of clc messages */
	51	u8 eyecatcher[4]; /* eye catcher */
	52	u8 type; /* proposal / accept / confirm / decline */
	53	__be16 length;
	54	#if defined(__BIG_ENDIAN_BITFIELD)
	55	u8 version : 4,
	56	flag : 1,
c758dfdd HW	57	rsvd : 1,
c758dfdd HW	58	path : 2;
a046d57d	59	#elif defined(__LITTLE_ENDIAN_BITFIELD)
c758dfdd HW	60	u8 path : 2,
c758dfdd HW	61	rsvd : 1,
a046d57d UB	62	flag : 1,
	63	version : 4;
	64	#endif
	65	} __packed; /* format defined in RFC7609 */
	66
	67	struct smc_clc_msg_trail { /* trailer of clc messages */
	68	u8 eyecatcher[4];
	69	};
	70
	71	struct smc_clc_msg_local { /* header2 of clc messages */
	72	u8 id_for_peer[SMC_SYSTEMID_LEN]; /* unique system id */
	73	u8 gid[16]; /* gid of ib_device port */
	74	u8 mac[6]; /* mac of ib_device port */
	75	};
	76
1a26d020 KG	77	#define SMC_CLC_MAX_V6_PREFIX 8
	78
	79	/* Struct would be 4 byte aligned, but it is used in an array that is sent
	80	* to peers and must conform to RFC7609, hence we need to use packed here.
	81	*/
e7b7a64a	82	struct smc_clc_ipv6_prefix {
1a26d020	83	struct in6_addr prefix;
e7b7a64a	84	u8 prefix_len;
1a26d020	85	} __packed; /* format defined in RFC7609 */
e7b7a64a UB	86
e7b7a64a UB	87	struct smc_clc_msg_proposal_prefix { /* prefix part of clc proposal message*/
a046d57d UB	88	__be32 outgoing_subnet; /* subnet mask */
	89	u8 prefix_len; /* number of significant bits in mask */
	90	u8 reserved[2];
	91	u8 ipv6_prefixes_cnt; /* number of IPv6 prefixes in prefix array */
a046d57d UB	92	} __aligned(4);
a046d57d UB	93
c758dfdd HW	94	struct smc_clc_msg_smcd { /* SMC-D GID information */
	95	u64 gid; /* ISM GID of requestor */
	96	u8 res[32];
	97	};
	98
e7b7a64a UB	99	struct smc_clc_msg_proposal { /* clc proposal message sent by Linux */
	100	struct smc_clc_msg_hdr hdr;
	101	struct smc_clc_msg_local lcl;
	102	__be16 iparea_offset; /* offset to IP address information area */
	103	} __aligned(4);
	104
	105	#define SMC_CLC_PROPOSAL_MAX_OFFSET 0x28
1a26d020 KG	106	#define SMC_CLC_PROPOSAL_MAX_PREFIX (SMC_CLC_MAX_V6_PREFIX * \
1a26d020 KG	107	sizeof(struct smc_clc_ipv6_prefix))
e7b7a64a UB	108	#define SMC_CLC_MAX_LEN (sizeof(struct smc_clc_msg_proposal) + \
e7b7a64a UB	109	SMC_CLC_PROPOSAL_MAX_OFFSET + \
1a26d020	110	sizeof(struct smc_clc_msg_proposal_prefix) + \
e7b7a64a UB	111	SMC_CLC_PROPOSAL_MAX_PREFIX + \
	112	sizeof(struct smc_clc_msg_trail))
	113
a046d57d UB	114	struct smc_clc_msg_accept_confirm { /* clc accept / confirm message */
a046d57d UB	115	struct smc_clc_msg_hdr hdr;
c758dfdd HW	116	union {
	117	struct { /* SMC-R */
	118	struct smc_clc_msg_local lcl;
	119	u8 qpn[3]; /* QP number */
	120	__be32 rmb_rkey; /* RMB rkey */
	121	u8 rmbe_idx; /* Index of RMBE in RMB */
	122	__be32 rmbe_alert_token;/* unique connection id */
a046d57d	123	#if defined(__BIG_ENDIAN_BITFIELD)
c758dfdd HW	124	u8 rmbe_size : 4, /* buf size (compressed) */
c758dfdd HW	125	qp_mtu : 4; /* QP mtu */
a046d57d	126	#elif defined(__LITTLE_ENDIAN_BITFIELD)
c758dfdd HW	127	u8 qp_mtu : 4,
c758dfdd HW	128	rmbe_size : 4;
a046d57d	129	#endif
c758dfdd HW	130	u8 reserved;
	131	__be64 rmb_dma_addr; /* RMB virtual address */
	132	u8 reserved2;
	133	u8 psn[3]; /* packet sequence number */
	134	struct smc_clc_msg_trail smcr_trl;
	135	/* eye catcher "SMCR" EBCDIC */
	136	} __packed;
	137	struct { /* SMC-D */
	138	u64 gid; /* Sender GID */
	139	u64 token; /* DMB token */
	140	u8 dmbe_idx; /* DMBE index */
	141	#if defined(__BIG_ENDIAN_BITFIELD)
	142	u8 dmbe_size : 4, /* buf size (compressed) */
	143	reserved3 : 4;
	144	#elif defined(__LITTLE_ENDIAN_BITFIELD)
	145	u8 reserved3 : 4,
	146	dmbe_size : 4;
	147	#endif
	148	u16 reserved4;
	149	u32 linkid; /* Link identifier */
	150	u32 reserved5[3];
	151	struct smc_clc_msg_trail smcd_trl;
	152	/* eye catcher "SMCD" EBCDIC */
	153	} __packed;
	154	};
a046d57d UB	155	} __packed; /* format defined in RFC7609 */
	156
	157	struct smc_clc_msg_decline { /* clc decline message */
	158	struct smc_clc_msg_hdr hdr;
	159	u8 id_for_peer[SMC_SYSTEMID_LEN]; /* sender peer_id */
	160	__be32 peer_diagnosis; /* diagnosis information */
	161	u8 reserved2[4];
	162	struct smc_clc_msg_trail trl; /* eye catcher "SMCR" EBCDIC */
	163	} __aligned(4);
	164
e7b7a64a UB	165	/* determine start of the prefix area within the proposal message */
	166	static inline struct smc_clc_msg_proposal_prefix *
	167	smc_clc_proposal_get_prefix(struct smc_clc_msg_proposal *pclc)
	168	{
	169	return (struct smc_clc_msg_proposal_prefix *)
	170	((u8 )pclc + sizeof(pclc) + ntohs(pclc->iparea_offset));
	171	}
	172
c758dfdd HW	173	/* get SMC-D info from proposal message */
	174	static inline struct smc_clc_msg_smcd *
	175	smc_get_clc_msg_smcd(struct smc_clc_msg_proposal *prop)
	176	{
	177	if (ntohs(prop->iparea_offset) != sizeof(struct smc_clc_msg_smcd))
	178	return NULL;
	179
	180	return (struct smc_clc_msg_smcd *)(prop + 1);
	181	}
	182
	183	struct smcd_dev;
bc36d2fc	184	struct smc_init_info;
c758dfdd	185
c246d942 KG	186	int smc_clc_prfx_match(struct socket *clcsock,
c246d942 KG	187	struct smc_clc_msg_proposal_prefix *prop);
a046d57d	188	int smc_clc_wait_msg(struct smc_sock smc, void buf, int buflen,
2b59f58e	189	u8 expected_type, unsigned long timeout);
bfbedfd3	190	int smc_clc_send_decline(struct smc_sock *smc, u32 peer_diag_info);
c758dfdd	191	int smc_clc_send_proposal(struct smc_sock *smc, int smc_type,
bc36d2fc	192	struct smc_init_info *ini);
a046d57d	193	int smc_clc_send_confirm(struct smc_sock *smc);
0cfdd8f9	194	int smc_clc_send_accept(struct smc_sock *smc, int srv_first_contact);
a046d57d UB	195
a046d57d UB	196	#endif