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_MODEUNSUPP 0x03040000 /* smc modes do not match (R or D)*/ 48 #define SMC_CLC_DECL_RMBE_EC 0x03050000 /* peer has eyecatcher in RMBE */ 49 #define SMC_CLC_DECL_OPTUNSUPP 0x03060000 /* fastopen sockopt not supported */ 50 #define SMC_CLC_DECL_DIFFPREFIX 0x03070000 /* IP prefix / subnet mismatch */ 51 #define SMC_CLC_DECL_GETVLANERR 0x03080000 /* err to get vlan id of ip device*/ 52 #define SMC_CLC_DECL_ISMVLANERR 0x03090000 /* err to reg vlan id on ism dev */ 53 #define SMC_CLC_DECL_NOACTLINK 0x030a0000 /* no active smc-r link in lgr */ 54 #define SMC_CLC_DECL_NOSRVLINK 0x030b0000 /* SMC-R link from srv not found */ 55 #define SMC_CLC_DECL_VERSMISMAT 0x030c0000 /* SMC version mismatch */ 56 #define SMC_CLC_DECL_MAX_DMB 0x030d0000 /* SMC-D DMB limit exceeded */ 57 #define SMC_CLC_DECL_SYNCERR 0x04000000 /* synchronization error */ 58 #define SMC_CLC_DECL_PEERDECL 0x05000000 /* peer declined during handshake */ 59 #define SMC_CLC_DECL_INTERR 0x09990000 /* internal error */ 60 #define SMC_CLC_DECL_ERR_RTOK 0x09990001 /* rtoken handling failed */ 61 #define SMC_CLC_DECL_ERR_RDYLNK 0x09990002 /* ib ready link failed */ 62 #define SMC_CLC_DECL_ERR_REGRMB 0x09990003 /* reg rmb failed */ 63 64 #define SMC_FIRST_CONTACT_MASK 0b10 /* first contact bit within typev2 */ 65 66 struct smc_clc_msg_hdr { /* header1 of clc messages */ 67 u8 eyecatcher[4]; /* eye catcher */ 68 u8 type; /* proposal / accept / confirm / decline */ 69 __be16 length; 70 #if defined(__BIG_ENDIAN_BITFIELD) 71 u8 version : 4, 72 typev2 : 2, 73 typev1 : 2; 74 #elif defined(__LITTLE_ENDIAN_BITFIELD) 75 u8 typev1 : 2, 76 typev2 : 2, 77 version : 4; 78 #endif 79 } __packed; /* format defined in RFC7609 */ 80 81 struct smc_clc_msg_trail { /* trailer of clc messages */ 82 u8 eyecatcher[4]; 83 }; 84 85 struct smc_clc_msg_local { /* header2 of clc messages */ 86 u8 id_for_peer[SMC_SYSTEMID_LEN]; /* unique system id */ 87 u8 gid[16]; /* gid of ib_device port */ 88 u8 mac[6]; /* mac of ib_device port */ 89 }; 90 91 /* Struct would be 4 byte aligned, but it is used in an array that is sent 92 * to peers and must conform to RFC7609, hence we need to use packed here. 93 */ 94 struct smc_clc_ipv6_prefix { 95 struct in6_addr prefix; 96 u8 prefix_len; 97 } __packed; /* format defined in RFC7609 */ 98 99 #if defined(__BIG_ENDIAN_BITFIELD) 100 struct smc_clc_v2_flag { 101 u8 release : 4, 102 rsvd : 3, 103 seid : 1; 104 }; 105 #elif defined(__LITTLE_ENDIAN_BITFIELD) 106 struct smc_clc_v2_flag { 107 u8 seid : 1, 108 rsvd : 3, 109 release : 4; 110 }; 111 #endif 112 113 struct smc_clnt_opts_area_hdr { 114 u8 eid_cnt; /* number of user defined EIDs */ 115 u8 ism_gid_cnt; /* number of ISMv2 GIDs */ 116 u8 reserved1; 117 struct smc_clc_v2_flag flag; 118 u8 reserved2[2]; 119 __be16 smcd_v2_ext_offset; /* SMC-Dv2 Extension Offset */ 120 }; 121 122 struct smc_clc_smcd_gid_chid { 123 __be64 gid; /* ISM GID */ 124 __be16 chid; /* ISMv2 CHID */ 125 } __packed; /* format defined in 126 * IBM Shared Memory Communications Version 2 127 * (https://www.ibm.com/support/pages/node/6326337) 128 */ 129 130 struct smc_clc_v2_extension { 131 struct smc_clnt_opts_area_hdr hdr; 132 u8 roce[16]; /* RoCEv2 GID */ 133 u8 reserved[16]; 134 u8 user_eids[][SMC_MAX_EID_LEN]; 135 }; 136 137 struct smc_clc_msg_proposal_prefix { /* prefix part of clc proposal message*/ 138 __be32 outgoing_subnet; /* subnet mask */ 139 u8 prefix_len; /* number of significant bits in mask */ 140 u8 reserved[2]; 141 u8 ipv6_prefixes_cnt; /* number of IPv6 prefixes in prefix array */ 142 } __aligned(4); 143 144 struct smc_clc_msg_smcd { /* SMC-D GID information */ 145 struct smc_clc_smcd_gid_chid ism; /* ISM native GID+CHID of requestor */ 146 __be16 v2_ext_offset; /* SMC Version 2 Extension Offset */ 147 u8 reserved[28]; 148 }; 149 150 struct smc_clc_smcd_v2_extension { 151 u8 system_eid[SMC_MAX_EID_LEN]; 152 u8 reserved[16]; 153 struct smc_clc_smcd_gid_chid gidchid[]; 154 }; 155 156 struct smc_clc_msg_proposal { /* clc proposal message sent by Linux */ 157 struct smc_clc_msg_hdr hdr; 158 struct smc_clc_msg_local lcl; 159 __be16 iparea_offset; /* offset to IP address information area */ 160 } __aligned(4); 161 162 #define SMC_CLC_MAX_V6_PREFIX 8 163 #define SMC_CLC_MAX_UEID 8 164 165 struct smc_clc_msg_proposal_area { 166 struct smc_clc_msg_proposal pclc_base; 167 struct smc_clc_msg_smcd pclc_smcd; 168 struct smc_clc_msg_proposal_prefix pclc_prfx; 169 struct smc_clc_ipv6_prefix pclc_prfx_ipv6[SMC_CLC_MAX_V6_PREFIX]; 170 struct smc_clc_v2_extension pclc_v2_ext; 171 u8 user_eids[SMC_CLC_MAX_UEID][SMC_MAX_EID_LEN]; 172 struct smc_clc_smcd_v2_extension pclc_smcd_v2_ext; 173 struct smc_clc_smcd_gid_chid pclc_gidchids[SMC_MAX_ISM_DEVS]; 174 struct smc_clc_msg_trail pclc_trl; 175 }; 176 177 struct smcr_clc_msg_accept_confirm { /* SMCR accept/confirm */ 178 struct smc_clc_msg_local lcl; 179 u8 qpn[3]; /* QP number */ 180 __be32 rmb_rkey; /* RMB rkey */ 181 u8 rmbe_idx; /* Index of RMBE in RMB */ 182 __be32 rmbe_alert_token; /* unique connection id */ 183 #if defined(__BIG_ENDIAN_BITFIELD) 184 u8 rmbe_size : 4, /* buf size (compressed) */ 185 qp_mtu : 4; /* QP mtu */ 186 #elif defined(__LITTLE_ENDIAN_BITFIELD) 187 u8 qp_mtu : 4, 188 rmbe_size : 4; 189 #endif 190 u8 reserved; 191 __be64 rmb_dma_addr; /* RMB virtual address */ 192 u8 reserved2; 193 u8 psn[3]; /* packet sequence number */ 194 } __packed; 195 196 struct smcd_clc_msg_accept_confirm_common { /* SMCD accept/confirm */ 197 u64 gid; /* Sender GID */ 198 u64 token; /* DMB token */ 199 u8 dmbe_idx; /* DMBE index */ 200 #if defined(__BIG_ENDIAN_BITFIELD) 201 u8 dmbe_size : 4, /* buf size (compressed) */ 202 reserved3 : 4; 203 #elif defined(__LITTLE_ENDIAN_BITFIELD) 204 u8 reserved3 : 4, 205 dmbe_size : 4; 206 #endif 207 u16 reserved4; 208 __be32 linkid; /* Link identifier */ 209 } __packed; 210 211 #define SMC_CLC_OS_ZOS 1 212 #define SMC_CLC_OS_LINUX 2 213 #define SMC_CLC_OS_AIX 3 214 215 struct smc_clc_first_contact_ext { 216 u8 reserved1; 217 #if defined(__BIG_ENDIAN_BITFIELD) 218 u8 os_type : 4, 219 release : 4; 220 #elif defined(__LITTLE_ENDIAN_BITFIELD) 221 u8 release : 4, 222 os_type : 4; 223 #endif 224 u8 reserved2[2]; 225 u8 hostname[SMC_MAX_HOSTNAME_LEN]; 226 }; 227 228 struct smc_clc_msg_accept_confirm { /* clc accept / confirm message */ 229 struct smc_clc_msg_hdr hdr; 230 union { 231 struct smcr_clc_msg_accept_confirm r0; /* SMC-R */ 232 struct { /* SMC-D */ 233 struct smcd_clc_msg_accept_confirm_common d0; 234 u32 reserved5[3]; 235 }; 236 }; 237 } __packed; /* format defined in RFC7609 */ 238 239 struct smc_clc_msg_accept_confirm_v2 { /* clc accept / confirm message */ 240 struct smc_clc_msg_hdr hdr; 241 union { 242 struct smcr_clc_msg_accept_confirm r0; /* SMC-R */ 243 struct { /* SMC-D */ 244 struct smcd_clc_msg_accept_confirm_common d0; 245 __be16 chid; 246 u8 eid[SMC_MAX_EID_LEN]; 247 u8 reserved5[8]; 248 }; 249 }; 250 }; 251 252 struct smc_clc_msg_decline { /* clc decline message */ 253 struct smc_clc_msg_hdr hdr; 254 u8 id_for_peer[SMC_SYSTEMID_LEN]; /* sender peer_id */ 255 __be32 peer_diagnosis; /* diagnosis information */ 256 #if defined(__BIG_ENDIAN_BITFIELD) 257 u8 os_type : 4, 258 reserved : 4; 259 #elif defined(__LITTLE_ENDIAN_BITFIELD) 260 u8 reserved : 4, 261 os_type : 4; 262 #endif 263 u8 reserved2[3]; 264 struct smc_clc_msg_trail trl; /* eye catcher "SMCD" or "SMCR" EBCDIC */ 265 } __aligned(4); 266 267 /* determine start of the prefix area within the proposal message */ 268 static inline struct smc_clc_msg_proposal_prefix * 269 smc_clc_proposal_get_prefix(struct smc_clc_msg_proposal *pclc) 270 { 271 return (struct smc_clc_msg_proposal_prefix *) 272 ((u8 *)pclc + sizeof(*pclc) + ntohs(pclc->iparea_offset)); 273 } 274 275 static inline bool smcr_indicated(int smc_type) 276 { 277 return smc_type == SMC_TYPE_R || smc_type == SMC_TYPE_B; 278 } 279 280 static inline bool smcd_indicated(int smc_type) 281 { 282 return smc_type == SMC_TYPE_D || smc_type == SMC_TYPE_B; 283 } 284 285 /* get SMC-D info from proposal message */ 286 static inline struct smc_clc_msg_smcd * 287 smc_get_clc_msg_smcd(struct smc_clc_msg_proposal *prop) 288 { 289 if (smcd_indicated(prop->hdr.typev1) && 290 ntohs(prop->iparea_offset) != sizeof(struct smc_clc_msg_smcd)) 291 return NULL; 292 293 return (struct smc_clc_msg_smcd *)(prop + 1); 294 } 295 296 static inline struct smc_clc_v2_extension * 297 smc_get_clc_v2_ext(struct smc_clc_msg_proposal *prop) 298 { 299 struct smc_clc_msg_smcd *prop_smcd = smc_get_clc_msg_smcd(prop); 300 301 if (!prop_smcd || !ntohs(prop_smcd->v2_ext_offset)) 302 return NULL; 303 304 return (struct smc_clc_v2_extension *) 305 ((u8 *)prop_smcd + 306 offsetof(struct smc_clc_msg_smcd, v2_ext_offset) + 307 sizeof(prop_smcd->v2_ext_offset) + 308 ntohs(prop_smcd->v2_ext_offset)); 309 } 310 311 static inline struct smc_clc_smcd_v2_extension * 312 smc_get_clc_smcd_v2_ext(struct smc_clc_v2_extension *prop_v2ext) 313 { 314 if (!prop_v2ext) 315 return NULL; 316 if (!ntohs(prop_v2ext->hdr.smcd_v2_ext_offset)) 317 return NULL; 318 319 return (struct smc_clc_smcd_v2_extension *) 320 ((u8 *)prop_v2ext + 321 offsetof(struct smc_clc_v2_extension, hdr) + 322 offsetof(struct smc_clnt_opts_area_hdr, smcd_v2_ext_offset) + 323 sizeof(prop_v2ext->hdr.smcd_v2_ext_offset) + 324 ntohs(prop_v2ext->hdr.smcd_v2_ext_offset)); 325 } 326 327 struct smcd_dev; 328 struct smc_init_info; 329 330 int smc_clc_prfx_match(struct socket *clcsock, 331 struct smc_clc_msg_proposal_prefix *prop); 332 int smc_clc_wait_msg(struct smc_sock *smc, void *buf, int buflen, 333 u8 expected_type, unsigned long timeout); 334 int smc_clc_send_decline(struct smc_sock *smc, u32 peer_diag_info, u8 version); 335 int smc_clc_send_proposal(struct smc_sock *smc, struct smc_init_info *ini); 336 int smc_clc_send_confirm(struct smc_sock *smc, bool clnt_first_contact, 337 u8 version, u8 *eid); 338 int smc_clc_send_accept(struct smc_sock *smc, bool srv_first_contact, 339 u8 version, u8 *negotiated_eid); 340 void smc_clc_init(void) __init; 341 void smc_clc_exit(void); 342 void smc_clc_get_hostname(u8 **host); 343 bool smc_clc_match_eid(u8 *negotiated_eid, 344 struct smc_clc_v2_extension *smc_v2_ext, 345 u8 *peer_eid, u8 *local_eid); 346 int smc_nl_dump_ueid(struct sk_buff *skb, struct netlink_callback *cb); 347 int smc_nl_add_ueid(struct sk_buff *skb, struct genl_info *info); 348 int smc_nl_remove_ueid(struct sk_buff *skb, struct genl_info *info); 349 int smc_nl_flush_ueid(struct sk_buff *skb, struct genl_info *info); 350 int smc_nl_dump_seid(struct sk_buff *skb, struct netlink_callback *cb); 351 int smc_nl_enable_seid(struct sk_buff *skb, struct genl_info *info); 352 int smc_nl_disable_seid(struct sk_buff *skb, struct genl_info *info); 353 354 #endif 355