net/smc/smc.h

   1 /*
   2  *  Shared Memory Communications over RDMA (SMC-R) and RoCE
   3  *
   4  *  Definitions for the SMC module (socket related)
   5  *
   6  *  Copyright IBM Corp. 2016
   7  *
   8  *  Author(s):  Ursula Braun <ubraun@linux.vnet.ibm.com>
   9  */
  10 #ifndef __SMC_H
  11 #define __SMC_H
  12
  13 #include <linux/socket.h>
  14 #include <linux/types.h>
  15 #include <linux/compiler.h> /* __aligned */
  16 #include <net/sock.h>
  17
  18 #include "smc_ib.h"
  19
  20 #define SMCPROTO_SMC            0       /* SMC protocol */
  21
  22 #define SMC_MAX_PORTS           2       /* Max # of ports */
  23
  24 #ifdef ATOMIC64_INIT
  25 #define KERNEL_HAS_ATOMIC64
  26 #endif
  27
  28 enum smc_state {                /* possible states of an SMC socket */
  29         SMC_ACTIVE      = 1,
  30         SMC_INIT        = 2,
  31         SMC_CLOSED      = 7,
  32         SMC_LISTEN      = 10,
  33 };
  34
  35 struct smc_link_group;
  36
  37 struct smc_wr_rx_hdr {  /* common prefix part of LLC and CDC to demultiplex */
  38         u8                      type;
  39 } __aligned(1);
  40
  41 struct smc_cdc_conn_state_flags {
  42 #if defined(__BIG_ENDIAN_BITFIELD)
  43         u8      peer_done_writing : 1;  /* Sending done indicator */
  44         u8      peer_conn_closed : 1;   /* Peer connection closed indicator */
  45         u8      peer_conn_abort : 1;    /* Abnormal close indicator */
  46         u8      reserved : 5;
  47 #elif defined(__LITTLE_ENDIAN_BITFIELD)
  48         u8      reserved : 5;
  49         u8      peer_conn_abort : 1;
  50         u8      peer_conn_closed : 1;
  51         u8      peer_done_writing : 1;
  52 #endif
  53 };
  54
  55 struct smc_cdc_producer_flags {
  56 #if defined(__BIG_ENDIAN_BITFIELD)
  57         u8      write_blocked : 1;      /* Writing Blocked, no rx buf space */
  58         u8      urg_data_pending : 1;   /* Urgent Data Pending */
  59         u8      urg_data_present : 1;   /* Urgent Data Present */
  60         u8      cons_curs_upd_req : 1;  /* cursor update requested */
  61         u8      failover_validation : 1;/* message replay due to failover */
  62         u8      reserved : 3;
  63 #elif defined(__LITTLE_ENDIAN_BITFIELD)
  64         u8      reserved : 3;
  65         u8      failover_validation : 1;
  66         u8      cons_curs_upd_req : 1;
  67         u8      urg_data_present : 1;
  68         u8      urg_data_pending : 1;
  69         u8      write_blocked : 1;
  70 #endif
  71 };
  72
  73 /* in host byte order */
  74 union smc_host_cursor { /* SMC cursor - an offset in an RMBE */
  75         struct {
  76                 u16     reserved;
  77                 u16     wrap;           /* window wrap sequence number */
  78                 u32     count;          /* cursor (= offset) part */
  79         };
  80 #ifdef KERNEL_HAS_ATOMIC64
  81         atomic64_t              acurs;  /* for atomic processing */
  82 #else
  83         u64                     acurs;  /* for atomic processing */
  84 #endif
  85 } __aligned(8);
  86
  87 /* in host byte order, except for flag bitfields in network byte order */
  88 struct smc_host_cdc_msg {               /* Connection Data Control message */
  89         struct smc_wr_rx_hdr            common; /* .type = 0xFE */
  90         u8                              len;    /* length = 44 */
  91         u16                             seqno;  /* connection seq # */
  92         u32                             token;  /* alert_token */
  93         union smc_host_cursor           prod;           /* producer cursor */
  94         union smc_host_cursor           cons;           /* consumer cursor,
  95                                                          * piggy backed "ack"
  96                                                          */
  97         struct smc_cdc_producer_flags   prod_flags;     /* conn. tx/rx status */
  98         struct smc_cdc_conn_state_flags conn_state_flags; /* peer conn. status*/
  99         u8                              reserved[18];
 100 } __aligned(8);
 101
 102 struct smc_connection {
 103         struct rb_node          alert_node;
 104         struct smc_link_group   *lgr;           /* link group of connection */
 105         u32                     alert_token_local; /* unique conn. id */
 106         u8                      peer_conn_idx;  /* from tcp handshake */
 107         int                     peer_rmbe_size; /* size of peer rx buffer */
 108         atomic_t                peer_rmbe_space;/* remaining free bytes in peer
 109                                                  * rmbe
 110                                                  */
 111         int                     rtoken_idx;     /* idx to peer RMB rkey/addr */
 112
 113         struct smc_buf_desc     *sndbuf_desc;   /* send buffer descriptor */
 114         int                     sndbuf_size;    /* sndbuf size <== sock wmem */
 115         struct smc_buf_desc     *rmb_desc;      /* RMBE descriptor */
 116         int                     rmbe_size;      /* RMBE size <== sock rmem */
 117         int                     rmbe_size_short;/* compressed notation */
 118         int                     rmbe_update_limit;
 119                                                 /* lower limit for consumer
 120                                                  * cursor update
 121                                                  */
 122
 123         struct smc_host_cdc_msg local_tx_ctrl;  /* host byte order staging
 124                                                  * buffer for CDC msg send
 125                                                  * .prod cf. TCP snd_nxt
 126                                                  * .cons cf. TCP sends ack
 127                                                  */
 128         union smc_host_cursor   tx_curs_prep;   /* tx - prepared data
 129                                                  * snd_max..wmem_alloc
 130                                                  */
 131         union smc_host_cursor   tx_curs_sent;   /* tx - sent data
 132                                                  * snd_nxt ?
 133                                                  */
 134         union smc_host_cursor   tx_curs_fin;    /* tx - confirmed by peer
 135                                                  * snd-wnd-begin ?
 136                                                  */
 137         atomic_t                sndbuf_space;   /* remaining space in sndbuf */
 138         u16                     tx_cdc_seq;     /* sequence # for CDC send */
 139         spinlock_t              send_lock;      /* protect wr_sends */
 140         struct work_struct      tx_work;        /* retry of smc_cdc_msg_send */
 141
 142         struct smc_host_cdc_msg local_rx_ctrl;  /* filled during event_handl.
 143                                                  * .prod cf. TCP rcv_nxt
 144                                                  * .cons cf. TCP snd_una
 145                                                  */
 146         union smc_host_cursor   rx_curs_confirmed; /* confirmed to peer
 147                                                     * source of snd_una ?
 148                                                     */
 149         atomic_t                bytes_to_rcv;   /* arrived data,
 150                                                  * not yet received
 151                                                  */
 152 #ifndef KERNEL_HAS_ATOMIC64
 153         spinlock_t              acurs_lock;     /* protect cursors */
 154 #endif
 155 };
 156
 157 struct smc_sock {                               /* smc sock container */
 158         struct sock             sk;
 159         struct socket           *clcsock;       /* internal tcp socket */
 160         struct smc_connection   conn;           /* smc connection */
 161         struct sockaddr         *addr;          /* inet connect address */
 162         struct smc_sock         *listen_smc;    /* listen parent */
 163         struct work_struct      tcp_listen_work;/* handle tcp socket accepts */
 164         struct work_struct      smc_listen_work;/* prepare new accept socket */
 165         struct list_head        accept_q;       /* sockets to be accepted */
 166         spinlock_t              accept_q_lock;  /* protects accept_q */
 167         bool                    use_fallback;   /* fallback to tcp */
 168 };
 169
 170 static inline struct smc_sock *smc_sk(const struct sock *sk)
 171 {
 172         return (struct smc_sock *)sk;
 173 }
 174
 175 #define SMC_SYSTEMID_LEN                8
 176
 177 extern u8       local_systemid[SMC_SYSTEMID_LEN]; /* unique system identifier */
 178
 179 /* convert an u32 value into network byte order, store it into a 3 byte field */
 180 static inline void hton24(u8 *net, u32 host)
 181 {
 182         __be32 t;
 183
 184         t = cpu_to_be32(host);
 185         memcpy(net, ((u8 *)&t) + 1, 3);
 186 }
 187
 188 /* convert a received 3 byte field into host byte order*/
 189 static inline u32 ntoh24(u8 *net)
 190 {
 191         __be32 t = 0;
 192
 193         memcpy(((u8 *)&t) + 1, net, 3);
 194         return be32_to_cpu(t);
 195 }
 196
 197 #define SMC_BUF_MIN_SIZE 16384          /* minimum size of an RMB */
 198
 199 #define SMC_RMBE_SIZES  16      /* number of distinct sizes for an RMBE */
 200 /* theoretically, the RFC states that largest size would be 512K,
 201  * i.e. compressed 5 and thus 6 sizes (0..5), despite
 202  * struct smc_clc_msg_accept_confirm.rmbe_size being a 4 bit value (0..15)
 203  */
 204
 205 /* convert the RMB size into the compressed notation - minimum 16K.
 206  * In contrast to plain ilog2, this rounds towards the next power of 2,
 207  * so the socket application gets at least its desired sndbuf / rcvbuf size.
 208  */
 209 static inline u8 smc_compress_bufsize(int size)
 210 {
 211         u8 compressed;
 212
 213         if (size <= SMC_BUF_MIN_SIZE)
 214                 return 0;
 215
 216         size = (size - 1) >> 14;
 217         compressed = ilog2(size) + 1;
 218         if (compressed >= SMC_RMBE_SIZES)
 219                 compressed = SMC_RMBE_SIZES - 1;
 220         return compressed;
 221 }
 222
 223 /* convert the RMB size from compressed notation into integer */
 224 static inline int smc_uncompress_bufsize(u8 compressed)
 225 {
 226         u32 size;
 227
 228         size = 0x00000001 << (((int)compressed) + 14);
 229         return (int)size;
 230 }
 231
 232 #ifdef CONFIG_XFRM
 233 static inline bool using_ipsec(struct smc_sock *smc)
 234 {
 235         return (smc->clcsock->sk->sk_policy[0] ||
 236                 smc->clcsock->sk->sk_policy[1]) ? 1 : 0;
 237 }
 238 #else
 239 static inline bool using_ipsec(struct smc_sock *smc)
 240 {
 241         return 0;
 242 }
 243 #endif
 244
 245 struct smc_clc_msg_local;
 246
 247 int smc_netinfo_by_tcpsk(struct socket *clcsock, __be32 *subnet,
 248                          u8 *prefix_len);
 249 void smc_conn_free(struct smc_connection *conn);
 250 int smc_conn_create(struct smc_sock *smc, __be32 peer_in_addr,
 251                     struct smc_ib_device *smcibdev, u8 ibport,
 252                     struct smc_clc_msg_local *lcl, int srv_first_contact);
 253
 254 #endif  /* __SMC_H */