]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - net/smc/smc_clc.h
net/smc: build and send V2 CLC proposal
[mirror_ubuntu-jammy-kernel.git] / net / smc / smc_clc.h
CommitLineData
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 <ubraun@linux.vnet.ibm.com>
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
c758dfdd
HW
25#define SMC_TYPE_R 0 /* SMC-R only */
26#define SMC_TYPE_D 1 /* SMC-D only */
fb4f7926 27#define SMC_TYPE_N 2 /* neither SMC-R nor SMC-D */
c758dfdd 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 */
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 */
9aa68d29
KG
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 */
603cc149
KG
40#define SMC_CLC_DECL_MODEUNSUPP 0x03040000 /* smc modes do not match (R or D)*/
41#define SMC_CLC_DECL_RMBE_EC 0x03050000 /* peer has eyecatcher in RMBE */
42#define SMC_CLC_DECL_OPTUNSUPP 0x03060000 /* fastopen sockopt not supported */
59886697 43#define SMC_CLC_DECL_DIFFPREFIX 0x03070000 /* IP prefix / subnet mismatch */
fba7e8ef 44#define SMC_CLC_DECL_GETVLANERR 0x03080000 /* err to get vlan id of ip device*/
7a62725a 45#define SMC_CLC_DECL_ISMVLANERR 0x03090000 /* err to reg vlan id on ism dev */
b9247544 46#define SMC_CLC_DECL_NOACTLINK 0x030a0000 /* no active smc-r link in lgr */
0fb0b02b 47#define SMC_CLC_DECL_NOSRVLINK 0x030b0000 /* SMC-R link from srv not found */
fb4f7926 48#define SMC_CLC_DECL_VERSMISMAT 0x030c0000 /* SMC version mismatch */
72b7f6c4 49#define SMC_CLC_DECL_MAX_DMB 0x030d0000 /* SMC-D DMB limit exceeded */
a046d57d 50#define SMC_CLC_DECL_SYNCERR 0x04000000 /* synchronization error */
603cc149 51#define SMC_CLC_DECL_PEERDECL 0x05000000 /* peer declined during handshake */
4ada81fd
KG
52#define SMC_CLC_DECL_INTERR 0x09990000 /* internal error */
53#define SMC_CLC_DECL_ERR_RTOK 0x09990001 /* rtoken handling failed */
54#define SMC_CLC_DECL_ERR_RDYLNK 0x09990002 /* ib ready link failed */
55#define SMC_CLC_DECL_ERR_REGRMB 0x09990003 /* reg rmb failed */
a046d57d 56
f1eb02f9
UB
57#define SMC_FIRST_CONTACT_MASK 0b10 /* first contact bit within typev2 */
58
a046d57d
UB
59struct smc_clc_msg_hdr { /* header1 of clc messages */
60 u8 eyecatcher[4]; /* eye catcher */
61 u8 type; /* proposal / accept / confirm / decline */
62 __be16 length;
63#if defined(__BIG_ENDIAN_BITFIELD)
64 u8 version : 4,
f1eb02f9
UB
65 typev2 : 2,
66 typev1 : 2;
a046d57d 67#elif defined(__LITTLE_ENDIAN_BITFIELD)
f1eb02f9
UB
68 u8 typev1 : 2,
69 typev2 : 2,
a046d57d
UB
70 version : 4;
71#endif
72} __packed; /* format defined in RFC7609 */
73
74struct smc_clc_msg_trail { /* trailer of clc messages */
75 u8 eyecatcher[4];
76};
77
78struct smc_clc_msg_local { /* header2 of clc messages */
79 u8 id_for_peer[SMC_SYSTEMID_LEN]; /* unique system id */
80 u8 gid[16]; /* gid of ib_device port */
81 u8 mac[6]; /* mac of ib_device port */
82};
83
1a26d020
KG
84/* Struct would be 4 byte aligned, but it is used in an array that is sent
85 * to peers and must conform to RFC7609, hence we need to use packed here.
86 */
e7b7a64a 87struct smc_clc_ipv6_prefix {
1a26d020 88 struct in6_addr prefix;
e7b7a64a 89 u8 prefix_len;
1a26d020 90} __packed; /* format defined in RFC7609 */
e7b7a64a 91
8c3dca34
UB
92#if defined(__BIG_ENDIAN_BITFIELD)
93struct smc_clc_v2_flag {
94 u8 release : 4,
95 rsvd : 3,
96 seid : 1;
97};
98#elif defined(__LITTLE_ENDIAN_BITFIELD)
99struct smc_clc_v2_flag {
100 u8 seid : 1,
101 rsvd : 3,
102 release : 4;
103};
104#endif
105
106struct smc_clnt_opts_area_hdr {
107 u8 eid_cnt; /* number of user defined EIDs */
108 u8 ism_gid_cnt; /* number of ISMv2 GIDs */
109 u8 reserved1;
110 struct smc_clc_v2_flag flag;
111 u8 reserved2[2];
112 __be16 smcd_v2_ext_offset; /* SMC-Dv2 Extension Offset */
113};
114
115struct smc_clc_smcd_gid_chid {
116 __be64 gid; /* ISM GID */
117 __be16 chid; /* ISMv2 CHID */
118} __packed; /* format defined in
119 * IBM Shared Memory Communications Version 2
120 * (https://www.ibm.com/support/pages/node/6326337)
121 */
122
123struct smc_clc_v2_extension {
124 struct smc_clnt_opts_area_hdr hdr;
125 u8 roce[16]; /* RoCEv2 GID */
126 u8 reserved[16];
127 u8 user_eids[0][SMC_MAX_EID_LEN];
128};
129
e7b7a64a 130struct smc_clc_msg_proposal_prefix { /* prefix part of clc proposal message*/
a046d57d
UB
131 __be32 outgoing_subnet; /* subnet mask */
132 u8 prefix_len; /* number of significant bits in mask */
133 u8 reserved[2];
134 u8 ipv6_prefixes_cnt; /* number of IPv6 prefixes in prefix array */
a046d57d
UB
135} __aligned(4);
136
c758dfdd 137struct smc_clc_msg_smcd { /* SMC-D GID information */
8c3dca34
UB
138 struct smc_clc_smcd_gid_chid ism; /* ISM native GID+CHID of requestor */
139 __be16 v2_ext_offset; /* SMC Version 2 Extension Offset */
140 u8 reserved[28];
141};
142
143struct smc_clc_smcd_v2_extension {
144 u8 system_eid[SMC_MAX_EID_LEN];
145 u8 reserved[16];
146 struct smc_clc_smcd_gid_chid gidchid[0];
c758dfdd
HW
147};
148
e7b7a64a
UB
149struct smc_clc_msg_proposal { /* clc proposal message sent by Linux */
150 struct smc_clc_msg_hdr hdr;
151 struct smc_clc_msg_local lcl;
152 __be16 iparea_offset; /* offset to IP address information area */
153} __aligned(4);
154
8c3dca34
UB
155#define SMC_CLC_MAX_V6_PREFIX 8
156
6bb14e48
UB
157struct smc_clc_msg_proposal_area {
158 struct smc_clc_msg_proposal pclc_base;
159 struct smc_clc_msg_smcd pclc_smcd;
160 struct smc_clc_msg_proposal_prefix pclc_prfx;
161 struct smc_clc_ipv6_prefix pclc_prfx_ipv6[SMC_CLC_MAX_V6_PREFIX];
8c3dca34
UB
162 struct smc_clc_v2_extension pclc_v2_ext;
163 struct smc_clc_smcd_v2_extension pclc_smcd_v2_ext;
164 struct smc_clc_smcd_gid_chid pclc_gidchids[SMC_MAX_ISM_DEVS];
6bb14e48
UB
165 struct smc_clc_msg_trail pclc_trl;
166};
e7b7a64a 167
3d9725a6
UB
168struct smcr_clc_msg_accept_confirm { /* SMCR accept/confirm */
169 struct smc_clc_msg_local lcl;
170 u8 qpn[3]; /* QP number */
171 __be32 rmb_rkey; /* RMB rkey */
172 u8 rmbe_idx; /* Index of RMBE in RMB */
173 __be32 rmbe_alert_token; /* unique connection id */
174 #if defined(__BIG_ENDIAN_BITFIELD)
175 u8 rmbe_size : 4, /* buf size (compressed) */
176 qp_mtu : 4; /* QP mtu */
a046d57d 177#elif defined(__LITTLE_ENDIAN_BITFIELD)
3d9725a6
UB
178 u8 qp_mtu : 4,
179 rmbe_size : 4;
a046d57d 180#endif
3d9725a6
UB
181 u8 reserved;
182 __be64 rmb_dma_addr; /* RMB virtual address */
183 u8 reserved2;
184 u8 psn[3]; /* packet sequence number */
3d9725a6
UB
185} __packed;
186
187struct smcd_clc_msg_accept_confirm { /* SMCD accept/confirm */
188 u64 gid; /* Sender GID */
189 u64 token; /* DMB token */
190 u8 dmbe_idx; /* DMBE index */
c758dfdd 191#if defined(__BIG_ENDIAN_BITFIELD)
3d9725a6
UB
192 u8 dmbe_size : 4, /* buf size (compressed) */
193 reserved3 : 4;
c758dfdd 194#elif defined(__LITTLE_ENDIAN_BITFIELD)
3d9725a6
UB
195 u8 reserved3 : 4,
196 dmbe_size : 4;
c758dfdd 197#endif
3d9725a6 198 u16 reserved4;
e15c6c46 199 __be32 linkid; /* Link identifier */
3d9725a6 200 u32 reserved5[3];
3d9725a6
UB
201} __packed;
202
203struct smc_clc_msg_accept_confirm { /* clc accept / confirm message */
204 struct smc_clc_msg_hdr hdr;
205 union {
206 struct smcr_clc_msg_accept_confirm r0; /* SMC-R */
207 struct smcd_clc_msg_accept_confirm d0; /* SMC-D */
c758dfdd 208 };
a046d57d
UB
209} __packed; /* format defined in RFC7609 */
210
211struct smc_clc_msg_decline { /* clc decline message */
212 struct smc_clc_msg_hdr hdr;
213 u8 id_for_peer[SMC_SYSTEMID_LEN]; /* sender peer_id */
214 __be32 peer_diagnosis; /* diagnosis information */
215 u8 reserved2[4];
216 struct smc_clc_msg_trail trl; /* eye catcher "SMCR" EBCDIC */
217} __aligned(4);
218
e7b7a64a
UB
219/* determine start of the prefix area within the proposal message */
220static inline struct smc_clc_msg_proposal_prefix *
221smc_clc_proposal_get_prefix(struct smc_clc_msg_proposal *pclc)
222{
223 return (struct smc_clc_msg_proposal_prefix *)
224 ((u8 *)pclc + sizeof(*pclc) + ntohs(pclc->iparea_offset));
225}
226
7affc809
UB
227static inline bool smcr_indicated(int smc_type)
228{
229 return smc_type == SMC_TYPE_R || smc_type == SMC_TYPE_B;
230}
231
232static inline bool smcd_indicated(int smc_type)
233{
234 return smc_type == SMC_TYPE_D || smc_type == SMC_TYPE_B;
235}
236
c758dfdd
HW
237/* get SMC-D info from proposal message */
238static inline struct smc_clc_msg_smcd *
239smc_get_clc_msg_smcd(struct smc_clc_msg_proposal *prop)
240{
8c3dca34 241 if (smcd_indicated(prop->hdr.typev1) &&
7affc809 242 ntohs(prop->iparea_offset) != sizeof(struct smc_clc_msg_smcd))
c758dfdd
HW
243 return NULL;
244
245 return (struct smc_clc_msg_smcd *)(prop + 1);
246}
247
8c3dca34
UB
248static inline struct smc_clc_v2_extension *
249smc_get_clc_v2_ext(struct smc_clc_msg_proposal *prop)
250{
251 struct smc_clc_msg_smcd *prop_smcd = smc_get_clc_msg_smcd(prop);
252
253 if (!prop_smcd || !ntohs(prop_smcd->v2_ext_offset))
254 return NULL;
255
256 return (struct smc_clc_v2_extension *)
257 ((u8 *)prop_smcd +
258 offsetof(struct smc_clc_msg_smcd, v2_ext_offset) +
259 sizeof(prop_smcd->v2_ext_offset) +
260 ntohs(prop_smcd->v2_ext_offset));
261}
262
c758dfdd 263struct smcd_dev;
bc36d2fc 264struct smc_init_info;
c758dfdd 265
c246d942
KG
266int smc_clc_prfx_match(struct socket *clcsock,
267 struct smc_clc_msg_proposal_prefix *prop);
a046d57d 268int smc_clc_wait_msg(struct smc_sock *smc, void *buf, int buflen,
2b59f58e 269 u8 expected_type, unsigned long timeout);
bfbedfd3 270int smc_clc_send_decline(struct smc_sock *smc, u32 peer_diag_info);
d70bf4f7 271int smc_clc_send_proposal(struct smc_sock *smc, struct smc_init_info *ini);
a046d57d 272int smc_clc_send_confirm(struct smc_sock *smc);
5ac54d87 273int smc_clc_send_accept(struct smc_sock *smc, bool srv_first_contact);
a046d57d
UB
274
275#endif