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 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 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 SMC_CLC_DECL_MEM 0x01010000 /* insufficient memory resources */ 31 #define SMC_CLC_DECL_TIMEOUT 0x02000000 /* timeout */ 32 #define SMC_CLC_DECL_CNFERR 0x03000000 /* configuration error */ 33 #define SMC_CLC_DECL_IPSEC 0x03030000 /* IPsec usage */ 34 #define SMC_CLC_DECL_SYNCERR 0x04000000 /* synchronization error */ 35 #define SMC_CLC_DECL_REPLY 0x06000000 /* reply to a received decline */ 36 #define SMC_CLC_DECL_INTERR 0x99990000 /* internal error */ 37 #define SMC_CLC_DECL_TCL 0x02040000 /* timeout w4 QP confirm */ 38 #define SMC_CLC_DECL_SEND 0x07000000 /* sending problem */ 39 #define SMC_CLC_DECL_RMBE_EC 0x08000000 /* peer has eyecatcher in RMBE */ 40 41 struct smc_clc_msg_hdr { /* header1 of clc messages */ 42 u8 eyecatcher[4]; /* eye catcher */ 43 u8 type; /* proposal / accept / confirm / decline */ 44 __be16 length; 45 #if defined(__BIG_ENDIAN_BITFIELD) 46 u8 version : 4, 47 flag : 1, 48 rsvd : 1, 49 path : 2; 50 #elif defined(__LITTLE_ENDIAN_BITFIELD) 51 u8 path : 2, 52 rsvd : 1, 53 flag : 1, 54 version : 4; 55 #endif 56 } __packed; /* format defined in RFC7609 */ 57 58 struct smc_clc_msg_trail { /* trailer of clc messages */ 59 u8 eyecatcher[4]; 60 }; 61 62 struct smc_clc_msg_local { /* header2 of clc messages */ 63 u8 id_for_peer[SMC_SYSTEMID_LEN]; /* unique system id */ 64 u8 gid[16]; /* gid of ib_device port */ 65 u8 mac[6]; /* mac of ib_device port */ 66 }; 67 68 #define SMC_CLC_MAX_V6_PREFIX 8 69 70 /* Struct would be 4 byte aligned, but it is used in an array that is sent 71 * to peers and must conform to RFC7609, hence we need to use packed here. 72 */ 73 struct smc_clc_ipv6_prefix { 74 struct in6_addr prefix; 75 u8 prefix_len; 76 } __packed; /* format defined in RFC7609 */ 77 78 struct smc_clc_msg_proposal_prefix { /* prefix part of clc proposal message*/ 79 __be32 outgoing_subnet; /* subnet mask */ 80 u8 prefix_len; /* number of significant bits in mask */ 81 u8 reserved[2]; 82 u8 ipv6_prefixes_cnt; /* number of IPv6 prefixes in prefix array */ 83 } __aligned(4); 84 85 struct smc_clc_msg_smcd { /* SMC-D GID information */ 86 u64 gid; /* ISM GID of requestor */ 87 u8 res[32]; 88 }; 89 90 struct smc_clc_msg_proposal { /* clc proposal message sent by Linux */ 91 struct smc_clc_msg_hdr hdr; 92 struct smc_clc_msg_local lcl; 93 __be16 iparea_offset; /* offset to IP address information area */ 94 } __aligned(4); 95 96 #define SMC_CLC_PROPOSAL_MAX_OFFSET 0x28 97 #define SMC_CLC_PROPOSAL_MAX_PREFIX (SMC_CLC_MAX_V6_PREFIX * \ 98 sizeof(struct smc_clc_ipv6_prefix)) 99 #define SMC_CLC_MAX_LEN (sizeof(struct smc_clc_msg_proposal) + \ 100 SMC_CLC_PROPOSAL_MAX_OFFSET + \ 101 sizeof(struct smc_clc_msg_proposal_prefix) + \ 102 SMC_CLC_PROPOSAL_MAX_PREFIX + \ 103 sizeof(struct smc_clc_msg_trail)) 104 105 struct smc_clc_msg_accept_confirm { /* clc accept / confirm message */ 106 struct smc_clc_msg_hdr hdr; 107 union { 108 struct { /* SMC-R */ 109 struct smc_clc_msg_local lcl; 110 u8 qpn[3]; /* QP number */ 111 __be32 rmb_rkey; /* RMB rkey */ 112 u8 rmbe_idx; /* Index of RMBE in RMB */ 113 __be32 rmbe_alert_token;/* unique connection id */ 114 #if defined(__BIG_ENDIAN_BITFIELD) 115 u8 rmbe_size : 4, /* buf size (compressed) */ 116 qp_mtu : 4; /* QP mtu */ 117 #elif defined(__LITTLE_ENDIAN_BITFIELD) 118 u8 qp_mtu : 4, 119 rmbe_size : 4; 120 #endif 121 u8 reserved; 122 __be64 rmb_dma_addr; /* RMB virtual address */ 123 u8 reserved2; 124 u8 psn[3]; /* packet sequence number */ 125 struct smc_clc_msg_trail smcr_trl; 126 /* eye catcher "SMCR" EBCDIC */ 127 } __packed; 128 struct { /* SMC-D */ 129 u64 gid; /* Sender GID */ 130 u64 token; /* DMB token */ 131 u8 dmbe_idx; /* DMBE index */ 132 #if defined(__BIG_ENDIAN_BITFIELD) 133 u8 dmbe_size : 4, /* buf size (compressed) */ 134 reserved3 : 4; 135 #elif defined(__LITTLE_ENDIAN_BITFIELD) 136 u8 reserved3 : 4, 137 dmbe_size : 4; 138 #endif 139 u16 reserved4; 140 u32 linkid; /* Link identifier */ 141 u32 reserved5[3]; 142 struct smc_clc_msg_trail smcd_trl; 143 /* eye catcher "SMCD" EBCDIC */ 144 } __packed; 145 }; 146 } __packed; /* format defined in RFC7609 */ 147 148 struct smc_clc_msg_decline { /* clc decline message */ 149 struct smc_clc_msg_hdr hdr; 150 u8 id_for_peer[SMC_SYSTEMID_LEN]; /* sender peer_id */ 151 __be32 peer_diagnosis; /* diagnosis information */ 152 u8 reserved2[4]; 153 struct smc_clc_msg_trail trl; /* eye catcher "SMCR" EBCDIC */ 154 } __aligned(4); 155 156 /* determine start of the prefix area within the proposal message */ 157 static inline struct smc_clc_msg_proposal_prefix * 158 smc_clc_proposal_get_prefix(struct smc_clc_msg_proposal *pclc) 159 { 160 return (struct smc_clc_msg_proposal_prefix *) 161 ((u8 *)pclc + sizeof(*pclc) + ntohs(pclc->iparea_offset)); 162 } 163 164 /* get SMC-D info from proposal message */ 165 static inline struct smc_clc_msg_smcd * 166 smc_get_clc_msg_smcd(struct smc_clc_msg_proposal *prop) 167 { 168 if (ntohs(prop->iparea_offset) != sizeof(struct smc_clc_msg_smcd)) 169 return NULL; 170 171 return (struct smc_clc_msg_smcd *)(prop + 1); 172 } 173 174 struct smcd_dev; 175 176 int smc_clc_prfx_match(struct socket *clcsock, 177 struct smc_clc_msg_proposal_prefix *prop); 178 int smc_clc_wait_msg(struct smc_sock *smc, void *buf, int buflen, 179 u8 expected_type); 180 int smc_clc_send_decline(struct smc_sock *smc, u32 peer_diag_info); 181 int smc_clc_send_proposal(struct smc_sock *smc, int smc_type, 182 struct smc_ib_device *smcibdev, u8 ibport, 183 struct smcd_dev *ismdev); 184 int smc_clc_send_confirm(struct smc_sock *smc); 185 int smc_clc_send_accept(struct smc_sock *smc, int srv_first_contact); 186 187 #endif 188