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 struct smc_clnt_opts_area_hdr hdr; 138 u8 roce[16]; /* RoCEv2 GID */ 139 u8 max_conns; 140 u8 max_links; 141 u8 reserved[14]; 142 u8 user_eids[][SMC_MAX_EID_LEN]; 143 }; 144 145 struct smc_clc_msg_proposal_prefix { /* prefix part of clc proposal message*/ 146 __be32 outgoing_subnet; /* subnet mask */ 147 u8 prefix_len; /* number of significant bits in mask */ 148 u8 reserved[2]; 149 u8 ipv6_prefixes_cnt; /* number of IPv6 prefixes in prefix array */ 150 } __aligned(4); 151 152 struct smc_clc_msg_smcd { /* SMC-D GID information */ 153 struct smc_clc_smcd_gid_chid ism; /* ISM native GID+CHID of requestor */ 154 __be16 v2_ext_offset; /* SMC Version 2 Extension Offset */ 155 u8 vendor_oui[3]; /* vendor organizationally unique identifier */ 156 u8 vendor_exp_options[5]; 157 u8 reserved[20]; 158 }; 159 160 struct smc_clc_smcd_v2_extension { 161 u8 system_eid[SMC_MAX_EID_LEN]; 162 u8 reserved[16]; 163 struct smc_clc_smcd_gid_chid gidchid[]; 164 }; 165 166 struct smc_clc_msg_proposal { /* clc proposal message sent by Linux */ 167 struct smc_clc_msg_hdr hdr; 168 struct smc_clc_msg_local lcl; 169 __be16 iparea_offset; /* offset to IP address information area */ 170 } __aligned(4); 171 172 #define SMC_CLC_MAX_V6_PREFIX 8 173 #define SMC_CLC_MAX_UEID 8 174 #define SMCD_CLC_MAX_V2_GID_ENTRIES 8 /* max # of CHID-GID entries in CLC 175 * proposal SMC-Dv2 extension. 176 * each ISM device takes one entry and 177 * each virtual ISM takes two entries. 178 */ 179 180 struct smc_clc_msg_proposal_area { 181 struct smc_clc_msg_proposal pclc_base; 182 struct smc_clc_msg_smcd pclc_smcd; 183 struct smc_clc_msg_proposal_prefix pclc_prfx; 184 struct smc_clc_ipv6_prefix pclc_prfx_ipv6[SMC_CLC_MAX_V6_PREFIX]; 185 struct smc_clc_v2_extension pclc_v2_ext; 186 u8 user_eids[SMC_CLC_MAX_UEID][SMC_MAX_EID_LEN]; 187 struct smc_clc_smcd_v2_extension pclc_smcd_v2_ext; 188 struct smc_clc_smcd_gid_chid 189 pclc_gidchids[SMCD_CLC_MAX_V2_GID_ENTRIES]; 190 struct smc_clc_msg_trail pclc_trl; 191 }; 192 193 struct smcr_clc_msg_accept_confirm { /* SMCR accept/confirm */ 194 struct smc_clc_msg_local lcl; 195 u8 qpn[3]; /* QP number */ 196 __be32 rmb_rkey; /* RMB rkey */ 197 u8 rmbe_idx; /* Index of RMBE in RMB */ 198 __be32 rmbe_alert_token; /* unique connection id */ 199 #if defined(__BIG_ENDIAN_BITFIELD) 200 u8 rmbe_size : 4, /* buf size (compressed) */ 201 qp_mtu : 4; /* QP mtu */ 202 #elif defined(__LITTLE_ENDIAN_BITFIELD) 203 u8 qp_mtu : 4, 204 rmbe_size : 4; 205 #endif 206 u8 reserved; 207 __be64 rmb_dma_addr; /* RMB virtual address */ 208 u8 reserved2; 209 u8 psn[3]; /* packet sequence number */ 210 } __packed; 211 212 struct smcd_clc_msg_accept_confirm_common { /* SMCD accept/confirm */ 213 __be64 gid; /* Sender GID */ 214 __be64 token; /* DMB token */ 215 u8 dmbe_idx; /* DMBE index */ 216 #if defined(__BIG_ENDIAN_BITFIELD) 217 u8 dmbe_size : 4, /* buf size (compressed) */ 218 reserved3 : 4; 219 #elif defined(__LITTLE_ENDIAN_BITFIELD) 220 u8 reserved3 : 4, 221 dmbe_size : 4; 222 #endif 223 u16 reserved4; 224 __be32 linkid; /* Link identifier */ 225 } __packed; 226 227 #define SMC_CLC_OS_ZOS 1 228 #define SMC_CLC_OS_LINUX 2 229 #define SMC_CLC_OS_AIX 3 230 231 struct smc_clc_first_contact_ext { 232 #if defined(__BIG_ENDIAN_BITFIELD) 233 u8 v2_direct : 1, 234 reserved : 7; 235 u8 os_type : 4, 236 release : 4; 237 #elif defined(__LITTLE_ENDIAN_BITFIELD) 238 u8 reserved : 7, 239 v2_direct : 1; 240 u8 release : 4, 241 os_type : 4; 242 #endif 243 u8 reserved2[2]; 244 u8 hostname[SMC_MAX_HOSTNAME_LEN]; 245 }; 246 247 struct smc_clc_first_contact_ext_v2x { 248 struct smc_clc_first_contact_ext fce_v2_base; 249 u8 max_conns; /* for SMC-R only */ 250 u8 max_links; /* for SMC-R only */ 251 u8 reserved3[2]; 252 __be32 vendor_exp_options; 253 u8 reserved4[8]; 254 } __packed; /* format defined in 255 * IBM Shared Memory Communications Version 2 (Third Edition) 256 * (https://www.ibm.com/support/pages/node/7009315) 257 */ 258 259 struct smc_clc_fce_gid_ext { 260 u8 gid_cnt; 261 u8 reserved2[3]; 262 u8 gid[][SMC_GID_SIZE]; 263 }; 264 265 struct smc_clc_msg_accept_confirm { /* clc accept / confirm message */ 266 struct smc_clc_msg_hdr hdr; 267 union { 268 struct { /* SMC-R */ 269 struct smcr_clc_msg_accept_confirm r0; 270 struct { /* v2 only */ 271 u8 eid[SMC_MAX_EID_LEN]; 272 u8 reserved6[8]; 273 } __packed r1; 274 }; 275 struct { /* SMC-D */ 276 struct smcd_clc_msg_accept_confirm_common d0; 277 struct { /* v2 only, but 12 bytes reserved in v1 */ 278 __be16 chid; 279 u8 eid[SMC_MAX_EID_LEN]; 280 __be64 gid_ext; 281 } __packed d1; 282 }; 283 }; 284 }; 285 286 struct smc_clc_msg_decline { /* clc decline message */ 287 struct smc_clc_msg_hdr hdr; 288 u8 id_for_peer[SMC_SYSTEMID_LEN]; /* sender peer_id */ 289 __be32 peer_diagnosis; /* diagnosis information */ 290 #if defined(__BIG_ENDIAN_BITFIELD) 291 u8 os_type : 4, 292 reserved : 4; 293 #elif defined(__LITTLE_ENDIAN_BITFIELD) 294 u8 reserved : 4, 295 os_type : 4; 296 #endif 297 u8 reserved2[3]; 298 struct smc_clc_msg_trail trl; /* eye catcher "SMCD" or "SMCR" EBCDIC */ 299 } __aligned(4); 300 301 #define SMC_DECL_DIAG_COUNT_V2 4 /* no. of additional peer diagnosis codes */ 302 303 struct smc_clc_msg_decline_v2 { /* clc decline message */ 304 struct smc_clc_msg_hdr hdr; 305 u8 id_for_peer[SMC_SYSTEMID_LEN]; /* sender peer_id */ 306 __be32 peer_diagnosis; /* diagnosis information */ 307 #if defined(__BIG_ENDIAN_BITFIELD) 308 u8 os_type : 4, 309 reserved : 4; 310 #elif defined(__LITTLE_ENDIAN_BITFIELD) 311 u8 reserved : 4, 312 os_type : 4; 313 #endif 314 u8 reserved2[3]; 315 __be32 peer_diagnosis_v2[SMC_DECL_DIAG_COUNT_V2]; 316 struct smc_clc_msg_trail trl; /* eye catcher "SMCD" or "SMCR" EBCDIC */ 317 } __aligned(4); 318 319 /* determine start of the prefix area within the proposal message */ 320 static inline struct smc_clc_msg_proposal_prefix * 321 smc_clc_proposal_get_prefix(struct smc_clc_msg_proposal *pclc) 322 { 323 return (struct smc_clc_msg_proposal_prefix *) 324 ((u8 *)pclc + sizeof(*pclc) + ntohs(pclc->iparea_offset)); 325 } 326 327 static inline bool smcr_indicated(int smc_type) 328 { 329 return smc_type == SMC_TYPE_R || smc_type == SMC_TYPE_B; 330 } 331 332 static inline bool smcd_indicated(int smc_type) 333 { 334 return smc_type == SMC_TYPE_D || smc_type == SMC_TYPE_B; 335 } 336 337 static inline u8 smc_indicated_type(int is_smcd, int is_smcr) 338 { 339 if (is_smcd && is_smcr) 340 return SMC_TYPE_B; 341 if (is_smcd) 342 return SMC_TYPE_D; 343 if (is_smcr) 344 return SMC_TYPE_R; 345 return SMC_TYPE_N; 346 } 347 348 /* get SMC-D info from proposal message */ 349 static inline struct smc_clc_msg_smcd * 350 smc_get_clc_msg_smcd(struct smc_clc_msg_proposal *prop) 351 { 352 if (smcd_indicated(prop->hdr.typev1) && 353 ntohs(prop->iparea_offset) != sizeof(struct smc_clc_msg_smcd)) 354 return NULL; 355 356 return (struct smc_clc_msg_smcd *)(prop + 1); 357 } 358 359 static inline struct smc_clc_v2_extension * 360 smc_get_clc_v2_ext(struct smc_clc_msg_proposal *prop) 361 { 362 struct smc_clc_msg_smcd *prop_smcd = smc_get_clc_msg_smcd(prop); 363 364 if (!prop_smcd || !ntohs(prop_smcd->v2_ext_offset)) 365 return NULL; 366 367 return (struct smc_clc_v2_extension *) 368 ((u8 *)prop_smcd + 369 offsetof(struct smc_clc_msg_smcd, v2_ext_offset) + 370 sizeof(prop_smcd->v2_ext_offset) + 371 ntohs(prop_smcd->v2_ext_offset)); 372 } 373 374 static inline struct smc_clc_smcd_v2_extension * 375 smc_get_clc_smcd_v2_ext(struct smc_clc_v2_extension *prop_v2ext) 376 { 377 if (!prop_v2ext) 378 return NULL; 379 if (!ntohs(prop_v2ext->hdr.smcd_v2_ext_offset)) 380 return NULL; 381 382 return (struct smc_clc_smcd_v2_extension *) 383 ((u8 *)prop_v2ext + 384 offsetof(struct smc_clc_v2_extension, hdr) + 385 offsetof(struct smc_clnt_opts_area_hdr, smcd_v2_ext_offset) + 386 sizeof(prop_v2ext->hdr.smcd_v2_ext_offset) + 387 ntohs(prop_v2ext->hdr.smcd_v2_ext_offset)); 388 } 389 390 static inline struct smc_clc_first_contact_ext * 391 smc_get_clc_first_contact_ext(struct smc_clc_msg_accept_confirm *clc, 392 bool is_smcd) 393 { 394 int clc_v2_len; 395 396 if (clc->hdr.version == SMC_V1 || 397 !(clc->hdr.typev2 & SMC_FIRST_CONTACT_MASK)) 398 return NULL; 399 400 if (is_smcd) 401 clc_v2_len = 402 offsetofend(struct smc_clc_msg_accept_confirm, d1); 403 else 404 clc_v2_len = 405 offsetofend(struct smc_clc_msg_accept_confirm, r1); 406 407 return (struct smc_clc_first_contact_ext *)(((u8 *)clc) + clc_v2_len); 408 } 409 410 struct smcd_dev; 411 struct smc_init_info; 412 413 int smc_clc_prfx_match(struct socket *clcsock, 414 struct smc_clc_msg_proposal_prefix *prop); 415 int smc_clc_wait_msg(struct smc_sock *smc, void *buf, int buflen, 416 u8 expected_type, unsigned long timeout); 417 int smc_clc_send_decline(struct smc_sock *smc, u32 peer_diag_info, u8 version); 418 int smc_clc_send_proposal(struct smc_sock *smc, struct smc_init_info *ini); 419 int smc_clc_send_confirm(struct smc_sock *smc, bool clnt_first_contact, 420 u8 version, u8 *eid, struct smc_init_info *ini); 421 int smc_clc_send_accept(struct smc_sock *smc, bool srv_first_contact, 422 u8 version, u8 *negotiated_eid, struct smc_init_info *ini); 423 int smc_clc_srv_v2x_features_validate(struct smc_clc_msg_proposal *pclc, 424 struct smc_init_info *ini); 425 int smc_clc_clnt_v2x_features_validate(struct smc_clc_first_contact_ext *fce, 426 struct smc_init_info *ini); 427 int smc_clc_v2x_features_confirm_check(struct smc_clc_msg_accept_confirm *cclc, 428 struct smc_init_info *ini); 429 void smc_clc_init(void) __init; 430 void smc_clc_exit(void); 431 void smc_clc_get_hostname(u8 **host); 432 bool smc_clc_match_eid(u8 *negotiated_eid, 433 struct smc_clc_v2_extension *smc_v2_ext, 434 u8 *peer_eid, u8 *local_eid); 435 int smc_clc_ueid_count(void); 436 int smc_nl_dump_ueid(struct sk_buff *skb, struct netlink_callback *cb); 437 int smc_nl_add_ueid(struct sk_buff *skb, struct genl_info *info); 438 int smc_nl_remove_ueid(struct sk_buff *skb, struct genl_info *info); 439 int smc_nl_flush_ueid(struct sk_buff *skb, struct genl_info *info); 440 int smc_nl_dump_seid(struct sk_buff *skb, struct netlink_callback *cb); 441 int smc_nl_enable_seid(struct sk_buff *skb, struct genl_info *info); 442 int smc_nl_disable_seid(struct sk_buff *skb, struct genl_info *info); 443 444 #endif 445