net/smc/smc_clc.h

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