net/sunrpc/xprtrdma/xprt_rdma.h

   1 /*
   2  * Copyright (c) 2003-2007 Network Appliance, Inc. All rights reserved.
   3  *
   4  * This software is available to you under a choice of one of two
   5  * licenses.  You may choose to be licensed under the terms of the GNU
   6  * General Public License (GPL) Version 2, available from the file
   7  * COPYING in the main directory of this source tree, or the BSD-type
   8  * license below:
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  *
  14  *      Redistributions of source code must retain the above copyright
  15  *      notice, this list of conditions and the following disclaimer.
  16  *
  17  *      Redistributions in binary form must reproduce the above
  18  *      copyright notice, this list of conditions and the following
  19  *      disclaimer in the documentation and/or other materials provided
  20  *      with the distribution.
  21  *
  22  *      Neither the name of the Network Appliance, Inc. nor the names of
  23  *      its contributors may be used to endorse or promote products
  24  *      derived from this software without specific prior written
  25  *      permission.
  26  *
  27  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  28  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  29  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  30  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  31  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  32  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  33  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  34  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  35  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  36  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  37  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  38  */
  39
  40 #ifndef _LINUX_SUNRPC_XPRT_RDMA_H
  41 #define _LINUX_SUNRPC_XPRT_RDMA_H
  42
  43 #include <linux/wait.h>                 /* wait_queue_head_t, etc */
  44 #include <linux/spinlock.h>             /* spinlock_t, etc */
  45 #include <linux/atomic.h>                       /* atomic_t, etc */
  46 #include <linux/workqueue.h>            /* struct work_struct */
  47
  48 #include <rdma/rdma_cm.h>               /* RDMA connection api */
  49 #include <rdma/ib_verbs.h>              /* RDMA verbs api */
  50
  51 #include <linux/sunrpc/clnt.h>          /* rpc_xprt */
  52 #include <linux/sunrpc/rpc_rdma.h>      /* RPC/RDMA protocol */
  53 #include <linux/sunrpc/xprtrdma.h>      /* xprt parameters */
  54 #include <linux/sunrpc/svc.h>           /* RPCSVC_MAXPAYLOAD */
  55
  56 #define RDMA_RESOLVE_TIMEOUT    (5000)  /* 5 seconds */
  57 #define RDMA_CONNECT_RETRY_MAX  (2)     /* retries if no listener backlog */
  58
  59 /*
  60  * Interface Adapter -- one per transport instance
  61  */
  62 struct rpcrdma_ia {
  63         rwlock_t                ri_qplock;
  64         struct rdma_cm_id       *ri_id;
  65         struct ib_pd            *ri_pd;
  66         struct ib_mr            *ri_bind_mem;
  67         u32                     ri_dma_lkey;
  68         int                     ri_have_dma_lkey;
  69         struct completion       ri_done;
  70         int                     ri_async_rc;
  71         enum rpcrdma_memreg     ri_memreg_strategy;
  72         unsigned int            ri_max_frmr_depth;
  73         struct ib_device_attr   ri_devattr;
  74         struct ib_qp_attr       ri_qp_attr;
  75         struct ib_qp_init_attr  ri_qp_init_attr;
  76 };
  77
  78 /*
  79  * RDMA Endpoint -- one per transport instance
  80  */
  81
  82 #define RPCRDMA_WC_BUDGET       (128)
  83 #define RPCRDMA_POLLSIZE        (16)
  84
  85 struct rpcrdma_ep {
  86         atomic_t                rep_cqcount;
  87         int                     rep_cqinit;
  88         int                     rep_connected;
  89         struct ib_qp_init_attr  rep_attr;
  90         wait_queue_head_t       rep_connect_wait;
  91         struct rpcrdma_regbuf   *rep_padbuf;
  92         struct rdma_conn_param  rep_remote_cma;
  93         struct sockaddr_storage rep_remote_addr;
  94         struct delayed_work     rep_connect_worker;
  95         struct ib_wc            rep_send_wcs[RPCRDMA_POLLSIZE];
  96         struct ib_wc            rep_recv_wcs[RPCRDMA_POLLSIZE];
  97 };
  98
  99 /*
 100  * Force a signaled SEND Work Request every so often,
 101  * in case the provider needs to do some housekeeping.
 102  */
 103 #define RPCRDMA_MAX_UNSIGNALED_SENDS    (32)
 104
 105 #define INIT_CQCOUNT(ep) atomic_set(&(ep)->rep_cqcount, (ep)->rep_cqinit)
 106 #define DECR_CQCOUNT(ep) atomic_sub_return(1, &(ep)->rep_cqcount)
 107
 108 /* Registered buffer -- registered kmalloc'd memory for RDMA SEND/RECV
 109  *
 110  * The below structure appears at the front of a large region of kmalloc'd
 111  * memory, which always starts on a good alignment boundary.
 112  */
 113
 114 struct rpcrdma_regbuf {
 115         size_t                  rg_size;
 116         struct rpcrdma_req      *rg_owner;
 117         struct ib_mr            *rg_mr;
 118         struct ib_sge           rg_iov;
 119         __be32                  rg_base[0] __attribute__ ((aligned(256)));
 120 };
 121
 122 static inline u64
 123 rdmab_addr(struct rpcrdma_regbuf *rb)
 124 {
 125         return rb->rg_iov.addr;
 126 }
 127
 128 static inline u32
 129 rdmab_length(struct rpcrdma_regbuf *rb)
 130 {
 131         return rb->rg_iov.length;
 132 }
 133
 134 static inline u32
 135 rdmab_lkey(struct rpcrdma_regbuf *rb)
 136 {
 137         return rb->rg_iov.lkey;
 138 }
 139
 140 static inline struct rpcrdma_msg *
 141 rdmab_to_msg(struct rpcrdma_regbuf *rb)
 142 {
 143         return (struct rpcrdma_msg *)rb->rg_base;
 144 }
 145
 146 enum rpcrdma_chunktype {
 147         rpcrdma_noch = 0,
 148         rpcrdma_readch,
 149         rpcrdma_areadch,
 150         rpcrdma_writech,
 151         rpcrdma_replych
 152 };
 153
 154 /*
 155  * struct rpcrdma_rep -- this structure encapsulates state required to recv
 156  * and complete a reply, asychronously. It needs several pieces of
 157  * state:
 158  *   o recv buffer (posted to provider)
 159  *   o ib_sge (also donated to provider)
 160  *   o status of reply (length, success or not)
 161  *   o bookkeeping state to get run by tasklet (list, etc)
 162  *
 163  * These are allocated during initialization, per-transport instance;
 164  * however, the tasklet execution list itself is global, as it should
 165  * always be pretty short.
 166  *
 167  * N of these are associated with a transport instance, and stored in
 168  * struct rpcrdma_buffer. N is the max number of outstanding requests.
 169  */
 170
 171 /* temporary static scatter/gather max */
 172 #define RPCRDMA_MAX_DATA_SEGS   (64)    /* max scatter/gather */
 173 #define RPCRDMA_MAX_SEGS        (RPCRDMA_MAX_DATA_SEGS + 2) /* head+tail = 2 */
 174 #define MAX_RPCRDMAHDR  (\
 175         /* max supported RPC/RDMA header */ \
 176         sizeof(struct rpcrdma_msg) + (2 * sizeof(u32)) + \
 177         (sizeof(struct rpcrdma_read_chunk) * RPCRDMA_MAX_SEGS) + sizeof(u32))
 178
 179 struct rpcrdma_buffer;
 180
 181 struct rpcrdma_rep {
 182         unsigned int            rr_len;
 183         struct rpcrdma_buffer   *rr_buffer;
 184         struct rpc_xprt         *rr_xprt;
 185         void                    (*rr_func)(struct rpcrdma_rep *);
 186         struct list_head        rr_list;
 187         struct rpcrdma_regbuf   *rr_rdmabuf;
 188 };
 189
 190 /*
 191  * struct rpcrdma_mw - external memory region metadata
 192  *
 193  * An external memory region is any buffer or page that is registered
 194  * on the fly (ie, not pre-registered).
 195  *
 196  * Each rpcrdma_buffer has a list of free MWs anchored in rb_mws. During
 197  * call_allocate, rpcrdma_buffer_get() assigns one to each segment in
 198  * an rpcrdma_req. Then rpcrdma_register_external() grabs these to keep
 199  * track of registration metadata while each RPC is pending.
 200  * rpcrdma_deregister_external() uses this metadata to unmap and
 201  * release these resources when an RPC is complete.
 202  */
 203 enum rpcrdma_frmr_state {
 204         FRMR_IS_INVALID,        /* ready to be used */
 205         FRMR_IS_VALID,          /* in use */
 206         FRMR_IS_STALE,          /* failed completion */
 207 };
 208
 209 struct rpcrdma_frmr {
 210         struct ib_fast_reg_page_list    *fr_pgl;
 211         struct ib_mr                    *fr_mr;
 212         enum rpcrdma_frmr_state         fr_state;
 213 };
 214
 215 struct rpcrdma_mw {
 216         union {
 217                 struct ib_fmr           *fmr;
 218                 struct rpcrdma_frmr     frmr;
 219         } r;
 220         struct list_head        mw_list;
 221         struct list_head        mw_all;
 222 };
 223
 224 /*
 225  * struct rpcrdma_req -- structure central to the request/reply sequence.
 226  *
 227  * N of these are associated with a transport instance, and stored in
 228  * struct rpcrdma_buffer. N is the max number of outstanding requests.
 229  *
 230  * It includes pre-registered buffer memory for send AND recv.
 231  * The recv buffer, however, is not owned by this structure, and
 232  * is "donated" to the hardware when a recv is posted. When a
 233  * reply is handled, the recv buffer used is given back to the
 234  * struct rpcrdma_req associated with the request.
 235  *
 236  * In addition to the basic memory, this structure includes an array
 237  * of iovs for send operations. The reason is that the iovs passed to
 238  * ib_post_{send,recv} must not be modified until the work request
 239  * completes.
 240  *
 241  * NOTES:
 242  *   o RPCRDMA_MAX_SEGS is the max number of addressible chunk elements we
 243  *     marshal. The number needed varies depending on the iov lists that
 244  *     are passed to us, the memory registration mode we are in, and if
 245  *     physical addressing is used, the layout.
 246  */
 247
 248 struct rpcrdma_mr_seg {         /* chunk descriptors */
 249         struct rpcrdma_mw *rl_mw;       /* registered MR */
 250         u64             mr_base;        /* registration result */
 251         u32             mr_rkey;        /* registration result */
 252         u32             mr_len;         /* length of chunk or segment */
 253         int             mr_nsegs;       /* number of segments in chunk or 0 */
 254         enum dma_data_direction mr_dir; /* segment mapping direction */
 255         dma_addr_t      mr_dma;         /* segment mapping address */
 256         size_t          mr_dmalen;      /* segment mapping length */
 257         struct page     *mr_page;       /* owning page, if any */
 258         char            *mr_offset;     /* kva if no page, else offset */
 259 };
 260
 261 struct rpcrdma_req {
 262         unsigned int    rl_niovs;       /* 0, 2 or 4 */
 263         unsigned int    rl_nchunks;     /* non-zero if chunks */
 264         unsigned int    rl_connect_cookie;      /* retry detection */
 265         enum rpcrdma_chunktype  rl_rtype, rl_wtype;
 266         struct rpcrdma_buffer *rl_buffer; /* home base for this structure */
 267         struct rpcrdma_rep      *rl_reply;/* holder for reply buffer */
 268         struct ib_sge   rl_send_iov[4]; /* for active requests */
 269         struct rpcrdma_regbuf *rl_rdmabuf;
 270         struct rpcrdma_regbuf *rl_sendbuf;
 271         struct rpcrdma_mr_seg rl_segments[RPCRDMA_MAX_SEGS];
 272 };
 273
 274 static inline struct rpcrdma_req *
 275 rpcr_to_rdmar(struct rpc_rqst *rqst)
 276 {
 277         struct rpcrdma_regbuf *rb = container_of(rqst->rq_buffer,
 278                                                  struct rpcrdma_regbuf,
 279                                                  rg_base[0]);
 280         return rb->rg_owner;
 281 }
 282
 283 /*
 284  * struct rpcrdma_buffer -- holds list/queue of pre-registered memory for
 285  * inline requests/replies, and client/server credits.
 286  *
 287  * One of these is associated with a transport instance
 288  */
 289 struct rpcrdma_buffer {
 290         spinlock_t      rb_lock;        /* protects indexes */
 291         int             rb_max_requests;/* client max requests */
 292         struct list_head rb_mws;        /* optional memory windows/fmrs/frmrs */
 293         struct list_head rb_all;
 294         int             rb_send_index;
 295         struct rpcrdma_req      **rb_send_bufs;
 296         int             rb_recv_index;
 297         struct rpcrdma_rep      **rb_recv_bufs;
 298         char            *rb_pool;
 299 };
 300 #define rdmab_to_ia(b) (&container_of((b), struct rpcrdma_xprt, rx_buf)->rx_ia)
 301
 302 /*
 303  * Internal structure for transport instance creation. This
 304  * exists primarily for modularity.
 305  *
 306  * This data should be set with mount options
 307  */
 308 struct rpcrdma_create_data_internal {
 309         struct sockaddr_storage addr;   /* RDMA server address */
 310         unsigned int    max_requests;   /* max requests (slots) in flight */
 311         unsigned int    rsize;          /* mount rsize - max read hdr+data */
 312         unsigned int    wsize;          /* mount wsize - max write hdr+data */
 313         unsigned int    inline_rsize;   /* max non-rdma read data payload */
 314         unsigned int    inline_wsize;   /* max non-rdma write data payload */
 315         unsigned int    padding;        /* non-rdma write header padding */
 316 };
 317
 318 #define RPCRDMA_INLINE_READ_THRESHOLD(rq) \
 319         (rpcx_to_rdmad(rq->rq_xprt).inline_rsize)
 320
 321 #define RPCRDMA_INLINE_WRITE_THRESHOLD(rq)\
 322         (rpcx_to_rdmad(rq->rq_xprt).inline_wsize)
 323
 324 #define RPCRDMA_INLINE_PAD_VALUE(rq)\
 325         rpcx_to_rdmad(rq->rq_xprt).padding
 326
 327 /*
 328  * Statistics for RPCRDMA
 329  */
 330 struct rpcrdma_stats {
 331         unsigned long           read_chunk_count;
 332         unsigned long           write_chunk_count;
 333         unsigned long           reply_chunk_count;
 334
 335         unsigned long long      total_rdma_request;
 336         unsigned long long      total_rdma_reply;
 337
 338         unsigned long long      pullup_copy_count;
 339         unsigned long long      fixup_copy_count;
 340         unsigned long           hardway_register_count;
 341         unsigned long           failed_marshal_count;
 342         unsigned long           bad_reply_count;
 343 };
 344
 345 /*
 346  * RPCRDMA transport -- encapsulates the structures above for
 347  * integration with RPC.
 348  *
 349  * The contained structures are embedded, not pointers,
 350  * for convenience. This structure need not be visible externally.
 351  *
 352  * It is allocated and initialized during mount, and released
 353  * during unmount.
 354  */
 355 struct rpcrdma_xprt {
 356         struct rpc_xprt         rx_xprt;
 357         struct rpcrdma_ia       rx_ia;
 358         struct rpcrdma_ep       rx_ep;
 359         struct rpcrdma_buffer   rx_buf;
 360         struct rpcrdma_create_data_internal rx_data;
 361         struct delayed_work     rx_connect_worker;
 362         struct rpcrdma_stats    rx_stats;
 363 };
 364
 365 #define rpcx_to_rdmax(x) container_of(x, struct rpcrdma_xprt, rx_xprt)
 366 #define rpcx_to_rdmad(x) (rpcx_to_rdmax(x)->rx_data)
 367
 368 /* Setting this to 0 ensures interoperability with early servers.
 369  * Setting this to 1 enhances certain unaligned read/write performance.
 370  * Default is 0, see sysctl entry and rpc_rdma.c rpcrdma_convert_iovs() */
 371 extern int xprt_rdma_pad_optimize;
 372
 373 /*
 374  * Interface Adapter calls - xprtrdma/verbs.c
 375  */
 376 int rpcrdma_ia_open(struct rpcrdma_xprt *, struct sockaddr *, int);
 377 void rpcrdma_ia_close(struct rpcrdma_ia *);
 378
 379 /*
 380  * Endpoint calls - xprtrdma/verbs.c
 381  */
 382 int rpcrdma_ep_create(struct rpcrdma_ep *, struct rpcrdma_ia *,
 383                                 struct rpcrdma_create_data_internal *);
 384 void rpcrdma_ep_destroy(struct rpcrdma_ep *, struct rpcrdma_ia *);
 385 int rpcrdma_ep_connect(struct rpcrdma_ep *, struct rpcrdma_ia *);
 386 void rpcrdma_ep_disconnect(struct rpcrdma_ep *, struct rpcrdma_ia *);
 387
 388 int rpcrdma_ep_post(struct rpcrdma_ia *, struct rpcrdma_ep *,
 389                                 struct rpcrdma_req *);
 390 int rpcrdma_ep_post_recv(struct rpcrdma_ia *, struct rpcrdma_ep *,
 391                                 struct rpcrdma_rep *);
 392
 393 /*
 394  * Buffer calls - xprtrdma/verbs.c
 395  */
 396 int rpcrdma_buffer_create(struct rpcrdma_xprt *);
 397 void rpcrdma_buffer_destroy(struct rpcrdma_buffer *);
 398
 399 struct rpcrdma_req *rpcrdma_buffer_get(struct rpcrdma_buffer *);
 400 void rpcrdma_buffer_put(struct rpcrdma_req *);
 401 void rpcrdma_recv_buffer_get(struct rpcrdma_req *);
 402 void rpcrdma_recv_buffer_put(struct rpcrdma_rep *);
 403
 404 int rpcrdma_register_internal(struct rpcrdma_ia *, void *, int,
 405                                 struct ib_mr **, struct ib_sge *);
 406 int rpcrdma_deregister_internal(struct rpcrdma_ia *,
 407                                 struct ib_mr *, struct ib_sge *);
 408
 409 int rpcrdma_register_external(struct rpcrdma_mr_seg *,
 410                                 int, int, struct rpcrdma_xprt *);
 411 int rpcrdma_deregister_external(struct rpcrdma_mr_seg *,
 412                                 struct rpcrdma_xprt *);
 413
 414 struct rpcrdma_regbuf *rpcrdma_alloc_regbuf(struct rpcrdma_ia *,
 415                                             size_t, gfp_t);
 416 void rpcrdma_free_regbuf(struct rpcrdma_ia *,
 417                          struct rpcrdma_regbuf *);
 418
 419 /*
 420  * RPC/RDMA connection management calls - xprtrdma/rpc_rdma.c
 421  */
 422 void rpcrdma_connect_worker(struct work_struct *);
 423 void rpcrdma_conn_func(struct rpcrdma_ep *);
 424 void rpcrdma_reply_handler(struct rpcrdma_rep *);
 425
 426 /*
 427  * RPC/RDMA protocol calls - xprtrdma/rpc_rdma.c
 428  */
 429 ssize_t rpcrdma_marshal_chunks(struct rpc_rqst *, ssize_t);
 430 int rpcrdma_marshal_req(struct rpc_rqst *);
 431 size_t rpcrdma_max_payload(struct rpcrdma_xprt *);
 432
 433 /* Temporary NFS request map cache. Created in svc_rdma.c  */
 434 extern struct kmem_cache *svc_rdma_map_cachep;
 435 /* WR context cache. Created in svc_rdma.c  */
 436 extern struct kmem_cache *svc_rdma_ctxt_cachep;
 437 /* Workqueue created in svc_rdma.c */
 438 extern struct workqueue_struct *svc_rdma_wq;
 439
 440 #if RPCSVC_MAXPAYLOAD < (RPCRDMA_MAX_DATA_SEGS << PAGE_SHIFT)
 441 #define RPCSVC_MAXPAYLOAD_RDMA RPCSVC_MAXPAYLOAD
 442 #else
 443 #define RPCSVC_MAXPAYLOAD_RDMA (RPCRDMA_MAX_DATA_SEGS << PAGE_SHIFT)
 444 #endif
 445
 446 #endif                          /* _LINUX_SUNRPC_XPRT_RDMA_H */