net/smc/smc_clc.h

   1 /*
   2  *  Shared Memory Communications over RDMA (SMC-R) and RoCE
   3  *
   4  *  CLC (connection layer control) handshake over initial TCP socket to
   5  *  prepare for RDMA traffic
   6  *
   7  *  Copyright IBM Corp. 2016
   8  *
   9  *  Author(s):  Ursula Braun <ubraun@linux.vnet.ibm.com>
  10  */
  11
  12 #ifndef _SMC_CLC_H
  13 #define _SMC_CLC_H
  14
  15 #include <rdma/ib_verbs.h>
  16
  17 #include "smc.h"
  18
  19 #define SMC_CLC_PROPOSAL        0x01
  20 #define SMC_CLC_ACCEPT          0x02
  21 #define SMC_CLC_CONFIRM         0x03
  22 #define SMC_CLC_DECLINE         0x04
  23
  24 /* eye catcher "SMCR" EBCDIC for CLC messages */
  25 static const char SMC_EYECATCHER[4] = {'\xe2', '\xd4', '\xc3', '\xd9'};
  26
  27 #define SMC_CLC_V1              0x1             /* SMC version                */
  28 #define CLC_WAIT_TIME           (6 * HZ)        /* max. wait time on clcsock  */
  29 #define SMC_CLC_DECL_MEM        0x01010000  /* insufficient memory resources  */
  30 #define SMC_CLC_DECL_TIMEOUT    0x02000000  /* timeout                        */
  31 #define SMC_CLC_DECL_CNFERR     0x03000000  /* configuration error            */
  32 #define SMC_CLC_DECL_IPSEC      0x03030000  /* IPsec usage                    */
  33 #define SMC_CLC_DECL_SYNCERR    0x04000000  /* synchronization error          */
  34 #define SMC_CLC_DECL_REPLY      0x06000000  /* reply to a received decline    */
  35 #define SMC_CLC_DECL_INTERR     0x99990000  /* internal error                 */
  36
  37 struct smc_clc_msg_hdr {        /* header1 of clc messages */
  38         u8 eyecatcher[4];       /* eye catcher */
  39         u8 type;                /* proposal / accept / confirm / decline */
  40         __be16 length;
  41 #if defined(__BIG_ENDIAN_BITFIELD)
  42         u8 version : 4,
  43            flag    : 1,
  44            rsvd    : 3;
  45 #elif defined(__LITTLE_ENDIAN_BITFIELD)
  46         u8 rsvd    : 3,
  47            flag    : 1,
  48            version : 4;
  49 #endif
  50 } __packed;                     /* format defined in RFC7609 */
  51
  52 struct smc_clc_msg_trail {      /* trailer of clc messages */
  53         u8 eyecatcher[4];
  54 };
  55
  56 struct smc_clc_msg_local {      /* header2 of clc messages */
  57         u8 id_for_peer[SMC_SYSTEMID_LEN]; /* unique system id */
  58         u8 gid[16];             /* gid of ib_device port */
  59         u8 mac[6];              /* mac of ib_device port */
  60 };
  61
  62 struct smc_clc_msg_proposal {   /* clc proposal message */
  63         struct smc_clc_msg_hdr hdr;
  64         struct smc_clc_msg_local lcl;
  65         __be16 iparea_offset;   /* offset to IP address information area */
  66         __be32 outgoing_subnet; /* subnet mask */
  67         u8 prefix_len;          /* number of significant bits in mask */
  68         u8 reserved[2];
  69         u8 ipv6_prefixes_cnt;   /* number of IPv6 prefixes in prefix array */
  70         struct smc_clc_msg_trail trl; /* eye catcher "SMCR" EBCDIC */
  71 } __aligned(4);
  72
  73 struct smc_clc_msg_accept_confirm {     /* clc accept / confirm message */
  74         struct smc_clc_msg_hdr hdr;
  75         struct smc_clc_msg_local lcl;
  76         u8 qpn[3];              /* QP number */
  77         __be32 rmb_rkey;        /* RMB rkey */
  78         u8 conn_idx;            /* Connection index, which RMBE in RMB */
  79         __be32 rmbe_alert_token;/* unique connection id */
  80 #if defined(__BIG_ENDIAN_BITFIELD)
  81         u8 rmbe_size : 4,       /* RMBE buf size (compressed notation) */
  82            qp_mtu   : 4;        /* QP mtu */
  83 #elif defined(__LITTLE_ENDIAN_BITFIELD)
  84         u8 qp_mtu   : 4,
  85            rmbe_size : 4;
  86 #endif
  87         u8 reserved;
  88         __be64 rmb_dma_addr;    /* RMB virtual address */
  89         u8 reserved2;
  90         u8 psn[3];              /* initial packet sequence number */
  91         struct smc_clc_msg_trail trl; /* eye catcher "SMCR" EBCDIC */
  92 } __packed;                     /* format defined in RFC7609 */
  93
  94 struct smc_clc_msg_decline {    /* clc decline message */
  95         struct smc_clc_msg_hdr hdr;
  96         u8 id_for_peer[SMC_SYSTEMID_LEN]; /* sender peer_id */
  97         __be32 peer_diagnosis;  /* diagnosis information */
  98         u8 reserved2[4];
  99         struct smc_clc_msg_trail trl; /* eye catcher "SMCR" EBCDIC */
 100 } __aligned(4);
 101
 102 struct smc_sock;
 103 struct smc_ib_device;
 104
 105 int smc_clc_wait_msg(struct smc_sock *smc, void *buf, int buflen,
 106                      u8 expected_type);
 107 int smc_clc_send_decline(struct smc_sock *smc, u32 peer_diag_info,
 108                          u8 out_of_sync);
 109 int smc_clc_send_proposal(struct smc_sock *smc, struct smc_ib_device *smcibdev,
 110                           u8 ibport);
 111 int smc_clc_send_confirm(struct smc_sock *smc);
 112 int smc_clc_send_accept(struct smc_sock *smc);
 113
 114 #endif