1 /* SPDX-License-Identifier: GPL-2.0 */
3 * Shared Memory Communications over RDMA (SMC-R) and RoCE
5 * CLC (connection layer control) handshake over initial TCP socket to
6 * prepare for RDMA traffic
8 * Copyright IBM Corp. 2016
10 * Author(s): Ursula Braun <ubraun@linux.vnet.ibm.com>
16 #include <rdma/ib_verbs.h>
20 #define SMC_CLC_PROPOSAL 0x01
21 #define SMC_CLC_ACCEPT 0x02
22 #define SMC_CLC_CONFIRM 0x03
23 #define SMC_CLC_DECLINE 0x04
25 #define SMC_CLC_V1 0x1 /* SMC version */
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 */
29 #define CLC_WAIT_TIME (6 * HZ) /* max. wait time on clcsock */
30 #define CLC_WAIT_TIME_SHORT HZ /* short wait time on clcsock */
31 #define SMC_CLC_DECL_MEM 0x01010000 /* insufficient memory resources */
32 #define SMC_CLC_DECL_TIMEOUT_CL 0x02010000 /* timeout w4 QP confirm link */
33 #define SMC_CLC_DECL_TIMEOUT_AL 0x02020000 /* timeout w4 QP add link */
34 #define SMC_CLC_DECL_CNFERR 0x03000000 /* configuration error */
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 (R or D) */
38 #define SMC_CLC_DECL_NOSMCDDEV 0x03030001 /* no SMC-D device found */
39 #define SMC_CLC_DECL_NOSMCRDEV 0x03030002 /* no SMC-R device found */
40 #define SMC_CLC_DECL_SMCDNOTALK 0x03030003 /* SMC-D dev can't talk to peer */
41 #define SMC_CLC_DECL_MODEUNSUPP 0x03040000 /* smc modes do not match (R or D)*/
42 #define SMC_CLC_DECL_RMBE_EC 0x03050000 /* peer has eyecatcher in RMBE */
43 #define SMC_CLC_DECL_OPTUNSUPP 0x03060000 /* fastopen sockopt not supported */
44 #define SMC_CLC_DECL_DIFFPREFIX 0x03070000 /* IP prefix / subnet mismatch */
45 #define SMC_CLC_DECL_GETVLANERR 0x03080000 /* err to get vlan id of ip device*/
46 #define SMC_CLC_DECL_ISMVLANERR 0x03090000 /* err to reg vlan id on ism dev */
47 #define SMC_CLC_DECL_NOACTLINK 0x030a0000 /* no active smc-r link in lgr */
48 #define SMC_CLC_DECL_NOSRVLINK 0x030b0000 /* SMC-R link from srv not found */
49 #define SMC_CLC_DECL_SYNCERR 0x04000000 /* synchronization error */
50 #define SMC_CLC_DECL_PEERDECL 0x05000000 /* peer declined during handshake */
51 #define SMC_CLC_DECL_INTERR 0x09990000 /* internal error */
52 #define SMC_CLC_DECL_ERR_RTOK 0x09990001 /* rtoken handling failed */
53 #define SMC_CLC_DECL_ERR_RDYLNK 0x09990002 /* ib ready link failed */
54 #define SMC_CLC_DECL_ERR_REGRMB 0x09990003 /* reg rmb failed */
56 struct smc_clc_msg_hdr
{ /* header1 of clc messages */
57 u8 eyecatcher
[4]; /* eye catcher */
58 u8 type
; /* proposal / accept / confirm / decline */
60 #if defined(__BIG_ENDIAN_BITFIELD)
65 #elif defined(__LITTLE_ENDIAN_BITFIELD)
71 } __packed
; /* format defined in RFC7609 */
73 struct smc_clc_msg_trail
{ /* trailer of clc messages */
77 struct smc_clc_msg_local
{ /* header2 of clc messages */
78 u8 id_for_peer
[SMC_SYSTEMID_LEN
]; /* unique system id */
79 u8 gid
[16]; /* gid of ib_device port */
80 u8 mac
[6]; /* mac of ib_device port */
83 #define SMC_CLC_MAX_V6_PREFIX 8
85 /* Struct would be 4 byte aligned, but it is used in an array that is sent
86 * to peers and must conform to RFC7609, hence we need to use packed here.
88 struct smc_clc_ipv6_prefix
{
89 struct in6_addr prefix
;
91 } __packed
; /* format defined in RFC7609 */
93 struct smc_clc_msg_proposal_prefix
{ /* prefix part of clc proposal message*/
94 __be32 outgoing_subnet
; /* subnet mask */
95 u8 prefix_len
; /* number of significant bits in mask */
97 u8 ipv6_prefixes_cnt
; /* number of IPv6 prefixes in prefix array */
100 struct smc_clc_msg_smcd
{ /* SMC-D GID information */
101 u64 gid
; /* ISM GID of requestor */
105 struct smc_clc_msg_proposal
{ /* clc proposal message sent by Linux */
106 struct smc_clc_msg_hdr hdr
;
107 struct smc_clc_msg_local lcl
;
108 __be16 iparea_offset
; /* offset to IP address information area */
111 #define SMC_CLC_PROPOSAL_MAX_OFFSET 0x28
112 #define SMC_CLC_PROPOSAL_MAX_PREFIX (SMC_CLC_MAX_V6_PREFIX * \
113 sizeof(struct smc_clc_ipv6_prefix))
114 #define SMC_CLC_MAX_LEN (sizeof(struct smc_clc_msg_proposal) + \
115 SMC_CLC_PROPOSAL_MAX_OFFSET + \
116 sizeof(struct smc_clc_msg_proposal_prefix) + \
117 SMC_CLC_PROPOSAL_MAX_PREFIX + \
118 sizeof(struct smc_clc_msg_trail))
120 struct smc_clc_msg_accept_confirm
{ /* clc accept / confirm message */
121 struct smc_clc_msg_hdr hdr
;
124 struct smc_clc_msg_local lcl
;
125 u8 qpn
[3]; /* QP number */
126 __be32 rmb_rkey
; /* RMB rkey */
127 u8 rmbe_idx
; /* Index of RMBE in RMB */
128 __be32 rmbe_alert_token
;/* unique connection id */
129 #if defined(__BIG_ENDIAN_BITFIELD)
130 u8 rmbe_size
: 4, /* buf size (compressed) */
131 qp_mtu
: 4; /* QP mtu */
132 #elif defined(__LITTLE_ENDIAN_BITFIELD)
137 __be64 rmb_dma_addr
; /* RMB virtual address */
139 u8 psn
[3]; /* packet sequence number */
140 struct smc_clc_msg_trail smcr_trl
;
141 /* eye catcher "SMCR" EBCDIC */
144 u64 gid
; /* Sender GID */
145 u64 token
; /* DMB token */
146 u8 dmbe_idx
; /* DMBE index */
147 #if defined(__BIG_ENDIAN_BITFIELD)
148 u8 dmbe_size
: 4, /* buf size (compressed) */
150 #elif defined(__LITTLE_ENDIAN_BITFIELD)
155 u32 linkid
; /* Link identifier */
157 struct smc_clc_msg_trail smcd_trl
;
158 /* eye catcher "SMCD" EBCDIC */
161 } __packed
; /* format defined in RFC7609 */
163 struct smc_clc_msg_decline
{ /* clc decline message */
164 struct smc_clc_msg_hdr hdr
;
165 u8 id_for_peer
[SMC_SYSTEMID_LEN
]; /* sender peer_id */
166 __be32 peer_diagnosis
; /* diagnosis information */
168 struct smc_clc_msg_trail trl
; /* eye catcher "SMCR" EBCDIC */
171 /* determine start of the prefix area within the proposal message */
172 static inline struct smc_clc_msg_proposal_prefix
*
173 smc_clc_proposal_get_prefix(struct smc_clc_msg_proposal
*pclc
)
175 return (struct smc_clc_msg_proposal_prefix
*)
176 ((u8
*)pclc
+ sizeof(*pclc
) + ntohs(pclc
->iparea_offset
));
179 /* get SMC-D info from proposal message */
180 static inline struct smc_clc_msg_smcd
*
181 smc_get_clc_msg_smcd(struct smc_clc_msg_proposal
*prop
)
183 if (ntohs(prop
->iparea_offset
) != sizeof(struct smc_clc_msg_smcd
))
186 return (struct smc_clc_msg_smcd
*)(prop
+ 1);
190 struct smc_init_info
;
192 int smc_clc_prfx_match(struct socket
*clcsock
,
193 struct smc_clc_msg_proposal_prefix
*prop
);
194 int smc_clc_wait_msg(struct smc_sock
*smc
, void *buf
, int buflen
,
195 u8 expected_type
, unsigned long timeout
);
196 int smc_clc_send_decline(struct smc_sock
*smc
, u32 peer_diag_info
);
197 int smc_clc_send_proposal(struct smc_sock
*smc
, int smc_type
,
198 struct smc_init_info
*ini
);
199 int smc_clc_send_confirm(struct smc_sock
*smc
);
200 int smc_clc_send_accept(struct smc_sock
*smc
, int srv_first_contact
);