1 /* SPDX-License-Identifier: GPL-2.0 */
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 #include <linux/smc.h>
18
19 #include "smc.h"
20 #include "smc_netlink.h"
21
22 #define SMC_CLC_PROPOSAL 0x01
23 #define SMC_CLC_ACCEPT 0x02
24 #define SMC_CLC_CONFIRM 0x03
25 #define SMC_CLC_DECLINE 0x04
26
27 #define SMC_TYPE_R 0 /* SMC-R only */
28 #define SMC_TYPE_D 1 /* SMC-D only */
29 #define SMC_TYPE_N 2 /* neither SMC-R nor SMC-D */
30 #define SMC_TYPE_B 3 /* SMC-R and SMC-D */
31 #define CLC_WAIT_TIME (6 * HZ) /* max. wait time on clcsock */
32 #define CLC_WAIT_TIME_SHORT HZ /* short wait time on clcsock */
33 #define SMC_CLC_DECL_MEM 0x01010000 /* insufficient memory resources */
34 #define SMC_CLC_DECL_TIMEOUT_CL 0x02010000 /* timeout w4 QP confirm link */
35 #define SMC_CLC_DECL_TIMEOUT_AL 0x02020000 /* timeout w4 QP add link */
36 #define SMC_CLC_DECL_CNFERR 0x03000000 /* configuration error */
37 #define SMC_CLC_DECL_PEERNOSMC 0x03010000 /* peer did not indicate SMC */
38 #define SMC_CLC_DECL_IPSEC 0x03020000 /* IPsec usage */
39 #define SMC_CLC_DECL_NOSMCDEV 0x03030000 /* no SMC device found (R or D) */
40 #define SMC_CLC_DECL_NOSMCDDEV 0x03030001 /* no SMC-D device found */
41 #define SMC_CLC_DECL_NOSMCRDEV 0x03030002 /* no SMC-R device found */
42 #define SMC_CLC_DECL_NOISM2SUPP 0x03030003 /* hardware has no ISMv2 support */
43 #define SMC_CLC_DECL_NOV2EXT 0x03030004 /* peer sent no clc v2 extension */
44 #define SMC_CLC_DECL_NOV2DEXT 0x03030005 /* peer sent no clc SMC-Dv2 ext. */
45 #define SMC_CLC_DECL_NOSEID 0x03030006 /* peer sent no SEID */
46 #define SMC_CLC_DECL_NOSMCD2DEV 0x03030007 /* no SMC-Dv2 device found */
47 #define SMC_CLC_DECL_NOUEID 0x03030008 /* peer sent no UEID */
48 #define SMC_CLC_DECL_RELEASEERR 0x03030009 /* release version negotiate failed */
49 #define SMC_CLC_DECL_MAXCONNERR 0x0303000a /* max connections negotiate failed */
50 #define SMC_CLC_DECL_MAXLINKERR 0x0303000b /* max links negotiate failed */
51 #define SMC_CLC_DECL_MODEUNSUPP 0x03040000 /* smc modes do not match (R or D)*/
52 #define SMC_CLC_DECL_RMBE_EC 0x03050000 /* peer has eyecatcher in RMBE */
53 #define SMC_CLC_DECL_OPTUNSUPP 0x03060000 /* fastopen sockopt not supported */
54 #define SMC_CLC_DECL_DIFFPREFIX 0x03070000 /* IP prefix / subnet mismatch */
55 #define SMC_CLC_DECL_GETVLANERR 0x03080000 /* err to get vlan id of ip device*/
56 #define SMC_CLC_DECL_ISMVLANERR 0x03090000 /* err to reg vlan id on ism dev */
57 #define SMC_CLC_DECL_NOACTLINK 0x030a0000 /* no active smc-r link in lgr */
58 #define SMC_CLC_DECL_NOSRVLINK 0x030b0000 /* SMC-R link from srv not found */
59 #define SMC_CLC_DECL_VERSMISMAT 0x030c0000 /* SMC version mismatch */
60 #define SMC_CLC_DECL_MAX_DMB 0x030d0000 /* SMC-D DMB limit exceeded */
61 #define SMC_CLC_DECL_NOROUTE 0x030e0000 /* SMC-Rv2 conn. no route to peer */
62 #define SMC_CLC_DECL_NOINDIRECT 0x030f0000 /* SMC-Rv2 conn. indirect mismatch*/
63 #define SMC_CLC_DECL_SYNCERR 0x04000000 /* synchronization error */
64 #define SMC_CLC_DECL_PEERDECL 0x05000000 /* peer declined during handshake */
65 #define SMC_CLC_DECL_INTERR 0x09990000 /* internal error */
66 #define SMC_CLC_DECL_ERR_RTOK 0x09990001 /* rtoken handling failed */
67 #define SMC_CLC_DECL_ERR_RDYLNK 0x09990002 /* ib ready link failed */
68 #define SMC_CLC_DECL_ERR_REGBUF 0x09990003 /* reg rdma bufs failed */
69
70 #define SMC_FIRST_CONTACT_MASK 0b10 /* first contact bit within typev2 */
71
72 struct smc_clc_msg_hdr { /* header1 of clc messages */
73 u8 eyecatcher[4]; /* eye catcher */
74 u8 type; /* proposal / accept / confirm / decline */
75 __be16 length;
76 #if defined(__BIG_ENDIAN_BITFIELD)
77 u8 version : 4,
78 typev2 : 2,
79 typev1 : 2;
80 #elif defined(__LITTLE_ENDIAN_BITFIELD)
81 u8 typev1 : 2,
82 typev2 : 2,
83 version : 4;
84 #endif
85 } __packed; /* format defined in RFC7609 */
86
87 struct smc_clc_msg_trail { /* trailer of clc messages */
88 u8 eyecatcher[4];
89 };
90
91 struct smc_clc_msg_local { /* header2 of clc messages */
92 u8 id_for_peer[SMC_SYSTEMID_LEN]; /* unique system id */
93 u8 gid[16]; /* gid of ib_device port */
94 u8 mac[6]; /* mac of ib_device port */
95 };
96
97 /* Struct would be 4 byte aligned, but it is used in an array that is sent
98 * to peers and must conform to RFC7609, hence we need to use packed here.
99 */
100 struct smc_clc_ipv6_prefix {
101 struct in6_addr prefix;
102 u8 prefix_len;
103 } __packed; /* format defined in RFC7609 */
104
105 #if defined(__BIG_ENDIAN_BITFIELD)
106 struct smc_clc_v2_flag {
107 u8 release : 4,
108 rsvd : 3,
109 seid : 1;
110 };
111 #elif defined(__LITTLE_ENDIAN_BITFIELD)
112 struct smc_clc_v2_flag {
113 u8 seid : 1,
114 rsvd : 3,
115 release : 4;
116 };
117 #endif
118
119 struct smc_clnt_opts_area_hdr {
120 u8 eid_cnt; /* number of user defined EIDs */
121 u8 ism_gid_cnt; /* number of ISMv2 GIDs */
122 u8 reserved1;
123 struct smc_clc_v2_flag flag;
124 u8 reserved2[2];
125 __be16 smcd_v2_ext_offset; /* SMC-Dv2 Extension Offset */
126 };
127
128 struct smc_clc_smcd_gid_chid {
129 __be64 gid; /* ISM GID */
130 __be16 chid; /* ISMv2 CHID */
131 } __packed; /* format defined in
132 * IBM Shared Memory Communications Version 2
133 * (https://www.ibm.com/support/pages/node/6326337)
134 */
135
136 struct smc_clc_v2_extension {
137 /* New members must be added within the struct_group() macro below. */
138 struct_group_tagged(smc_clc_v2_extension_fixed, fixed,
139 struct smc_clnt_opts_area_hdr hdr;
140 u8 roce[16]; /* RoCEv2 GID */
141 u8 max_conns;
142 u8 max_links;
143 __be16 feature_mask;
144 u8 reserved[12];
145 );
146 u8 user_eids[][SMC_MAX_EID_LEN];
147 };
148
149 struct smc_clc_msg_proposal_prefix { /* prefix part of clc proposal message*/
150 __be32 outgoing_subnet; /* subnet mask */
151 u8 prefix_len; /* number of significant bits in mask */
152 u8 reserved[2];
153 u8 ipv6_prefixes_cnt; /* number of IPv6 prefixes in prefix array */
154 } __aligned(4);
155
156 struct smc_clc_msg_smcd { /* SMC-D GID information */
157 struct smc_clc_smcd_gid_chid ism; /* ISM native GID+CHID of requestor */
158 __be16 v2_ext_offset; /* SMC Version 2 Extension Offset */
159 u8 vendor_oui[3]; /* vendor organizationally unique identifier */
160 u8 vendor_exp_options[5];
161 u8 reserved[20];
162 };
163
164 struct smc_clc_smcd_v2_extension {
165 /* New members must be added within the struct_group() macro below. */
166 struct_group_tagged(smc_clc_smcd_v2_extension_fixed, fixed,
167 u8 system_eid[SMC_MAX_EID_LEN];
168 u8 reserved[16];
169 );
170 struct smc_clc_smcd_gid_chid gidchid[];
171 };
172
173 struct smc_clc_msg_proposal { /* clc proposal message sent by Linux */
174 struct smc_clc_msg_hdr hdr;
175 struct smc_clc_msg_local lcl;
176 __be16 iparea_offset; /* offset to IP address information area */
177 } __aligned(4);
178
179 #define SMC_CLC_MAX_V6_PREFIX 8
180 #define SMC_CLC_MAX_UEID 8
181 #define SMCD_CLC_MAX_V2_GID_ENTRIES 8 /* max # of CHID-GID entries in CLC
182 * proposal SMC-Dv2 extension.
183 * each ISM device takes one entry and
184 * each Emulated-ISM takes two entries
185 */
186
187 struct smc_clc_msg_proposal_area {
188 struct smc_clc_msg_proposal pclc_base;
189 struct smc_clc_msg_smcd pclc_smcd;
190 struct smc_clc_msg_proposal_prefix pclc_prfx;
191 struct smc_clc_ipv6_prefix pclc_prfx_ipv6[SMC_CLC_MAX_V6_PREFIX];
192 struct smc_clc_v2_extension_fixed pclc_v2_ext;
193 u8 user_eids[SMC_CLC_MAX_UEID][SMC_MAX_EID_LEN];
194 struct smc_clc_smcd_v2_extension_fixed pclc_smcd_v2_ext;
195 struct smc_clc_smcd_gid_chid
196 pclc_gidchids[SMCD_CLC_MAX_V2_GID_ENTRIES];
197 struct smc_clc_msg_trail pclc_trl;
198 };
199
200 struct smcr_clc_msg_accept_confirm { /* SMCR accept/confirm */
201 struct smc_clc_msg_local lcl;
202 u8 qpn[3]; /* QP number */
203 __be32 rmb_rkey; /* RMB rkey */
204 u8 rmbe_idx; /* Index of RMBE in RMB */
205 __be32 rmbe_alert_token; /* unique connection id */
206 #if defined(__BIG_ENDIAN_BITFIELD)
207 u8 rmbe_size : 4, /* buf size (compressed) */
208 qp_mtu : 4; /* QP mtu */
209 #elif defined(__LITTLE_ENDIAN_BITFIELD)
210 u8 qp_mtu : 4,
211 rmbe_size : 4;
212 #endif
213 u8 reserved;
214 __be64 rmb_dma_addr; /* RMB virtual address */
215 u8 reserved2;
216 u8 psn[3]; /* packet sequence number */
217 } __packed;
218
219 struct smcd_clc_msg_accept_confirm_common { /* SMCD accept/confirm */
220 __be64 gid; /* Sender GID */
221 __be64 token; /* DMB token */
222 u8 dmbe_idx; /* DMBE index */
223 #if defined(__BIG_ENDIAN_BITFIELD)
224 u8 dmbe_size : 4, /* buf size (compressed) */
225 reserved3 : 4;
226 #elif defined(__LITTLE_ENDIAN_BITFIELD)
227 u8 reserved3 : 4,
228 dmbe_size : 4;
229 #endif
230 u16 reserved4;
231 __be32 linkid; /* Link identifier */
232 } __packed;
233
234 #define SMC_CLC_OS_ZOS 1
235 #define SMC_CLC_OS_LINUX 2
236 #define SMC_CLC_OS_AIX 3
237
238 struct smc_clc_first_contact_ext {
239 #if defined(__BIG_ENDIAN_BITFIELD)
240 u8 v2_direct : 1,
241 reserved : 7;
242 u8 os_type : 4,
243 release : 4;
244 #elif defined(__LITTLE_ENDIAN_BITFIELD)
245 u8 reserved : 7,
246 v2_direct : 1;
247 u8 release : 4,
248 os_type : 4;
249 #endif
250 u8 reserved2[2];
251 u8 hostname[SMC_MAX_HOSTNAME_LEN];
252 };
253
254 struct smc_clc_first_contact_ext_v2x {
255 struct smc_clc_first_contact_ext fce_v2_base;
256 union {
257 struct {
258 u8 max_conns; /* for SMC-R only */
259 u8 max_links; /* for SMC-R only */
260 };
261 u8 reserved3[2]; /* for SMC-D only */
262 };
263 __be16 feature_mask;
264 __be32 vendor_exp_options;
265 u8 reserved4[8];
266 } __packed; /* format defined in
267 * IBM Shared Memory Communications Version 2 (Third Edition)
268 * (https://www.ibm.com/support/pages/node/7009315)
269 */
270
271 struct smc_clc_fce_gid_ext {
272 u8 gid_cnt;
273 u8 reserved2[3];
274 u8 gid[][SMC_GID_SIZE];
275 };
276
277 struct smc_clc_msg_accept_confirm { /* clc accept / confirm message */
278 struct smc_clc_msg_hdr hdr;
279 union {
280 struct { /* SMC-R */
281 struct smcr_clc_msg_accept_confirm r0;
282 struct { /* v2 only */
283 u8 eid[SMC_MAX_EID_LEN];
284 u8 reserved6[8];
285 } __packed r1;
286 };
287 struct { /* SMC-D */
288 struct smcd_clc_msg_accept_confirm_common d0;
289 struct { /* v2 only, but 12 bytes reserved in v1 */
290 __be16 chid;
291 u8 eid[SMC_MAX_EID_LEN];
292 __be64 gid_ext;
293 } __packed d1;
294 };
295 };
296 };
297
298 struct smc_clc_msg_decline { /* clc decline message */
299 struct smc_clc_msg_hdr hdr;
300 u8 id_for_peer[SMC_SYSTEMID_LEN]; /* sender peer_id */
301 __be32 peer_diagnosis; /* diagnosis information */
302 #if defined(__BIG_ENDIAN_BITFIELD)
303 u8 os_type : 4,
304 reserved : 4;
305 #elif defined(__LITTLE_ENDIAN_BITFIELD)
306 u8 reserved : 4,
307 os_type : 4;
308 #endif
309 u8 reserved2[3];
310 struct smc_clc_msg_trail trl; /* eye catcher "SMCD" or "SMCR" EBCDIC */
311 } __aligned(4);
312
313 #define SMC_DECL_DIAG_COUNT_V2 4 /* no. of additional peer diagnosis codes */
314
315 struct smc_clc_msg_decline_v2 { /* clc decline message */
316 struct smc_clc_msg_hdr hdr;
317 u8 id_for_peer[SMC_SYSTEMID_LEN]; /* sender peer_id */
318 __be32 peer_diagnosis; /* diagnosis information */
319 #if defined(__BIG_ENDIAN_BITFIELD)
320 u8 os_type : 4,
321 reserved : 4;
322 #elif defined(__LITTLE_ENDIAN_BITFIELD)
323 u8 reserved : 4,
324 os_type : 4;
325 #endif
326 u8 reserved2[3];
327 __be32 peer_diagnosis_v2[SMC_DECL_DIAG_COUNT_V2];
328 struct smc_clc_msg_trail trl; /* eye catcher "SMCD" or "SMCR" EBCDIC */
329 } __aligned(4);
330
331 /* determine start of the prefix area within the proposal message */
332 static inline struct smc_clc_msg_proposal_prefix *
333 smc_clc_proposal_get_prefix(struct smc_clc_msg_proposal *pclc)
334 {
335 return (struct smc_clc_msg_proposal_prefix *)
336 ((u8 *)pclc + sizeof(*pclc) + ntohs(pclc->iparea_offset));
337 }
338
339 static inline bool smcr_indicated(int smc_type)
340 {
341 return smc_type == SMC_TYPE_R || smc_type == SMC_TYPE_B;
342 }
343
344 static inline bool smcd_indicated(int smc_type)
345 {
346 return smc_type == SMC_TYPE_D || smc_type == SMC_TYPE_B;
347 }
348
349 static inline u8 smc_indicated_type(int is_smcd, int is_smcr)
350 {
351 if (is_smcd && is_smcr)
352 return SMC_TYPE_B;
353 if (is_smcd)
354 return SMC_TYPE_D;
355 if (is_smcr)
356 return SMC_TYPE_R;
357 return SMC_TYPE_N;
358 }
359
360 /* get SMC-D info from proposal message */
361 static inline struct smc_clc_msg_smcd *
362 smc_get_clc_msg_smcd(struct smc_clc_msg_proposal *prop)
363 {
364 if (smcd_indicated(prop->hdr.typev1) &&
365 ntohs(prop->iparea_offset) != sizeof(struct smc_clc_msg_smcd))
366 return NULL;
367
368 return (struct smc_clc_msg_smcd *)(prop + 1);
369 }
370
371 static inline struct smc_clc_v2_extension *
372 smc_get_clc_v2_ext(struct smc_clc_msg_proposal *prop)
373 {
374 struct smc_clc_msg_smcd *prop_smcd = smc_get_clc_msg_smcd(prop);
375
376 if (!prop_smcd || !ntohs(prop_smcd->v2_ext_offset))
377 return NULL;
378
379 return (struct smc_clc_v2_extension *)
380 ((u8 *)prop_smcd +
381 offsetof(struct smc_clc_msg_smcd, v2_ext_offset) +
382 sizeof(prop_smcd->v2_ext_offset) +
383 ntohs(prop_smcd->v2_ext_offset));
384 }
385
386 static inline struct smc_clc_smcd_v2_extension *
387 smc_get_clc_smcd_v2_ext(struct smc_clc_v2_extension *prop_v2ext)
388 {
389 if (!prop_v2ext)
390 return NULL;
391 if (!ntohs(prop_v2ext->hdr.smcd_v2_ext_offset))
392 return NULL;
393
394 return (struct smc_clc_smcd_v2_extension *)
395 ((u8 *)prop_v2ext +
396 offsetof(struct smc_clc_v2_extension, hdr) +
397 offsetof(struct smc_clnt_opts_area_hdr, smcd_v2_ext_offset) +
398 sizeof(prop_v2ext->hdr.smcd_v2_ext_offset) +
399 ntohs(prop_v2ext->hdr.smcd_v2_ext_offset));
400 }
401
402 static inline struct smc_clc_first_contact_ext *
403 smc_get_clc_first_contact_ext(struct smc_clc_msg_accept_confirm *clc,
404 bool is_smcd)
405 {
406 int clc_v2_len;
407
408 if (clc->hdr.version == SMC_V1 ||
409 !(clc->hdr.typev2 & SMC_FIRST_CONTACT_MASK))
410 return NULL;
411
412 if (is_smcd)
413 clc_v2_len =
414 offsetofend(struct smc_clc_msg_accept_confirm, d1);
415 else
416 clc_v2_len =
417 offsetofend(struct smc_clc_msg_accept_confirm, r1);
418
419 return (struct smc_clc_first_contact_ext *)(((u8 *)clc) + clc_v2_len);
420 }
421
422 struct smcd_dev;
423 struct smc_init_info;
424
425 int smc_clc_prfx_match(struct socket *clcsock,
426 struct smc_clc_msg_proposal_prefix *prop);
427 int smc_clc_wait_msg(struct smc_sock *smc, void *buf, int buflen,
428 u8 expected_type, unsigned long timeout);
429 int smc_clc_send_decline(struct smc_sock *smc, u32 peer_diag_info, u8 version);
430 int smc_clc_send_proposal(struct smc_sock *smc, struct smc_init_info *ini);
431 int smc_clc_send_confirm(struct smc_sock *smc, bool clnt_first_contact,
432 u8 version, u8 *eid, struct smc_init_info *ini);
433 int smc_clc_send_accept(struct smc_sock *smc, bool srv_first_contact,
434 u8 version, u8 *negotiated_eid, struct smc_init_info *ini);
435 int smc_clc_srv_v2x_features_validate(struct smc_sock *smc,
436 struct smc_clc_msg_proposal *pclc,
437 struct smc_init_info *ini);
438 int smc_clc_clnt_v2x_features_validate(struct smc_clc_first_contact_ext *fce,
439 struct smc_init_info *ini);
440 int smc_clc_v2x_features_confirm_check(struct smc_clc_msg_accept_confirm *cclc,
441 struct smc_init_info *ini);
442 void smc_clc_init(void) __init;
443 void smc_clc_exit(void);
444 void smc_clc_get_hostname(u8 **host);
445 bool smc_clc_match_eid(u8 *negotiated_eid,
446 struct smc_clc_v2_extension *smc_v2_ext,
447 u8 *peer_eid, u8 *local_eid);
448 int smc_clc_ueid_count(void);
449 int smc_nl_dump_ueid(struct sk_buff *skb, struct netlink_callback *cb);
450 int smc_nl_add_ueid(struct sk_buff *skb, struct genl_info *info);
451 int smc_nl_remove_ueid(struct sk_buff *skb, struct genl_info *info);
452 int smc_nl_flush_ueid(struct sk_buff *skb, struct genl_info *info);
453 int smc_nl_dump_seid(struct sk_buff *skb, struct netlink_callback *cb);
454 int smc_nl_enable_seid(struct sk_buff *skb, struct genl_info *info);
455 int smc_nl_disable_seid(struct sk_buff *skb, struct genl_info *info);
456
457 #endif
458
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.