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
  55 #define RDMA_RESOLVE_TIMEOUT    (5000)  /* 5 seconds */
  56 #define RDMA_CONNECT_RETRY_MAX  (2)     /* retries if no listener backlog */
  57
  58 /*
  59  * Interface Adapter -- one per transport instance
  60  */
  61 struct rpcrdma_ia {
  62         const struct rpcrdma_memreg_ops *ri_ops;
  63         rwlock_t                ri_qplock;
  64         struct ib_device        *ri_device;
  65         struct rdma_cm_id       *ri_id;
  66         struct ib_pd            *ri_pd;
  67         struct ib_mr            *ri_dma_mr;
  68         struct completion       ri_done;
  69         int                     ri_async_rc;
  70         unsigned int            ri_max_frmr_depth;
  71         struct ib_device_attr   ri_devattr;
  72         struct ib_qp_attr       ri_qp_attr;
  73         struct ib_qp_init_attr  ri_qp_init_attr;
  74 };
  75
  76 /*
  77  * RDMA Endpoint -- one per transport instance
  78  */
  79
  80 struct rpcrdma_ep {
  81         atomic_t                rep_cqcount;
  82         int                     rep_cqinit;
  83         int                     rep_connected;
  84         struct ib_qp_init_attr  rep_attr;
  85         wait_queue_head_t       rep_connect_wait;
  86         struct rdma_conn_param  rep_remote_cma;
  87         struct sockaddr_storage rep_remote_addr;
  88         struct delayed_work     rep_connect_worker;
  89 };
  90
  91 /*
  92  * Force a signaled SEND Work Request every so often,
  93  * in case the provider needs to do some housekeeping.
  94  */
  95 #define RPCRDMA_MAX_UNSIGNALED_SENDS    (32)
  96
  97 #define INIT_CQCOUNT(ep) atomic_set(&(ep)->rep_cqcount, (ep)->rep_cqinit)
  98 #define DECR_CQCOUNT(ep) atomic_sub_return(1, &(ep)->rep_cqcount)
  99
 100 /* Force completion handler to ignore the signal
 101  */
 102 #define RPCRDMA_IGNORE_COMPLETION       (0ULL)
 103
 104 /* Registered buffer -- registered kmalloc'd memory for RDMA SEND/RECV
 105  *
 106  * The below structure appears at the front of a large region of kmalloc'd
 107  * memory, which always starts on a good alignment boundary.
 108  */
 109
 110 struct rpcrdma_regbuf {
 111         size_t                  rg_size;
 112         struct rpcrdma_req      *rg_owner;
 113         struct ib_sge           rg_iov;
 114         __be32                  rg_base[0] __attribute__ ((aligned(256)));
 115 };
 116
 117 static inline u64
 118 rdmab_addr(struct rpcrdma_regbuf *rb)
 119 {
 120         return rb->rg_iov.addr;
 121 }
 122
 123 static inline u32
 124 rdmab_length(struct rpcrdma_regbuf *rb)
 125 {
 126         return rb->rg_iov.length;
 127 }
 128
 129 static inline u32
 130 rdmab_lkey(struct rpcrdma_regbuf *rb)
 131 {
 132         return rb->rg_iov.lkey;
 133 }
 134
 135 static inline struct rpcrdma_msg *
 136 rdmab_to_msg(struct rpcrdma_regbuf *rb)
 137 {
 138         return (struct rpcrdma_msg *)rb->rg_base;
 139 }
 140
 141 /*
 142  * struct rpcrdma_rep -- this structure encapsulates state required to recv
 143  * and complete a reply, asychronously. It needs several pieces of
 144  * state:
 145  *   o recv buffer (posted to provider)
 146  *   o ib_sge (also donated to provider)
 147  *   o status of reply (length, success or not)
 148  *   o bookkeeping state to get run by tasklet (list, etc)
 149  *
 150  * These are allocated during initialization, per-transport instance;
 151  * however, the tasklet execution list itself is global, as it should
 152  * always be pretty short.
 153  *
 154  * N of these are associated with a transport instance, and stored in
 155  * struct rpcrdma_buffer. N is the max number of outstanding requests.
 156  */
 157
 158 #define RPCRDMA_MAX_DATA_SEGS   ((1 * 1024 * 1024) / PAGE_SIZE)
 159 #define RPCRDMA_MAX_SEGS        (RPCRDMA_MAX_DATA_SEGS + 2) /* head+tail = 2 */
 160
 161 struct rpcrdma_buffer;
 162
 163 struct rpcrdma_rep {
 164         unsigned int            rr_len;
 165         struct ib_device        *rr_device;
 166         struct rpcrdma_xprt     *rr_rxprt;
 167         struct work_struct      rr_work;
 168         struct list_head        rr_list;
 169         struct rpcrdma_regbuf   *rr_rdmabuf;
 170 };
 171
 172 #define RPCRDMA_BAD_LEN         (~0U)
 173
 174 /*
 175  * struct rpcrdma_mw - external memory region metadata
 176  *
 177  * An external memory region is any buffer or page that is registered
 178  * on the fly (ie, not pre-registered).
 179  *
 180  * Each rpcrdma_buffer has a list of free MWs anchored in rb_mws. During
 181  * call_allocate, rpcrdma_buffer_get() assigns one to each segment in
 182  * an rpcrdma_req. Then rpcrdma_register_external() grabs these to keep
 183  * track of registration metadata while each RPC is pending.
 184  * rpcrdma_deregister_external() uses this metadata to unmap and
 185  * release these resources when an RPC is complete.
 186  */
 187 enum rpcrdma_frmr_state {
 188         FRMR_IS_INVALID,        /* ready to be used */
 189         FRMR_IS_VALID,          /* in use */
 190         FRMR_IS_STALE,          /* failed completion */
 191 };
 192
 193 struct rpcrdma_frmr {
 194         struct ib_fast_reg_page_list    *fr_pgl;
 195         struct ib_mr                    *fr_mr;
 196         enum rpcrdma_frmr_state         fr_state;
 197         struct work_struct              fr_work;
 198         struct rpcrdma_xprt             *fr_xprt;
 199 };
 200
 201 struct rpcrdma_fmr {
 202         struct ib_fmr           *fmr;
 203         u64                     *physaddrs;
 204 };
 205
 206 struct rpcrdma_mw {
 207         union {
 208                 struct rpcrdma_fmr      fmr;
 209                 struct rpcrdma_frmr     frmr;
 210         } r;
 211         void                    (*mw_sendcompletion)(struct ib_wc *);
 212         struct list_head        mw_list;
 213         struct list_head        mw_all;
 214 };
 215
 216 /*
 217  * struct rpcrdma_req -- structure central to the request/reply sequence.
 218  *
 219  * N of these are associated with a transport instance, and stored in
 220  * struct rpcrdma_buffer. N is the max number of outstanding requests.
 221  *
 222  * It includes pre-registered buffer memory for send AND recv.
 223  * The recv buffer, however, is not owned by this structure, and
 224  * is "donated" to the hardware when a recv is posted. When a
 225  * reply is handled, the recv buffer used is given back to the
 226  * struct rpcrdma_req associated with the request.
 227  *
 228  * In addition to the basic memory, this structure includes an array
 229  * of iovs for send operations. The reason is that the iovs passed to
 230  * ib_post_{send,recv} must not be modified until the work request
 231  * completes.
 232  *
 233  * NOTES:
 234  *   o RPCRDMA_MAX_SEGS is the max number of addressible chunk elements we
 235  *     marshal. The number needed varies depending on the iov lists that
 236  *     are passed to us, the memory registration mode we are in, and if
 237  *     physical addressing is used, the layout.
 238  */
 239
 240 struct rpcrdma_mr_seg {         /* chunk descriptors */
 241         struct rpcrdma_mw *rl_mw;       /* registered MR */
 242         u64             mr_base;        /* registration result */
 243         u32             mr_rkey;        /* registration result */
 244         u32             mr_len;         /* length of chunk or segment */
 245         int             mr_nsegs;       /* number of segments in chunk or 0 */
 246         enum dma_data_direction mr_dir; /* segment mapping direction */
 247         dma_addr_t      mr_dma;         /* segment mapping address */
 248         size_t          mr_dmalen;      /* segment mapping length */
 249         struct page     *mr_page;       /* owning page, if any */
 250         char            *mr_offset;     /* kva if no page, else offset */
 251 };
 252
 253 #define RPCRDMA_MAX_IOVS        (2)
 254
 255 struct rpcrdma_req {
 256         struct list_head        rl_free;
 257         unsigned int            rl_niovs;
 258         unsigned int            rl_nchunks;
 259         unsigned int            rl_connect_cookie;
 260         struct rpcrdma_buffer   *rl_buffer;
 261         struct rpcrdma_rep      *rl_reply;/* holder for reply buffer */
 262         struct ib_sge           rl_send_iov[RPCRDMA_MAX_IOVS];
 263         struct rpcrdma_regbuf   *rl_rdmabuf;
 264         struct rpcrdma_regbuf   *rl_sendbuf;
 265         struct rpcrdma_mr_seg   rl_segments[RPCRDMA_MAX_SEGS];
 266 };
 267
 268 static inline struct rpcrdma_req *
 269 rpcr_to_rdmar(struct rpc_rqst *rqst)
 270 {
 271         void *buffer = rqst->rq_buffer;
 272         struct rpcrdma_regbuf *rb;
 273
 274         rb = container_of(buffer, struct rpcrdma_regbuf, rg_base);
 275         return rb->rg_owner;
 276 }
 277
 278 /*
 279  * struct rpcrdma_buffer -- holds list/queue of pre-registered memory for
 280  * inline requests/replies, and client/server credits.
 281  *
 282  * One of these is associated with a transport instance
 283  */
 284 struct rpcrdma_buffer {
 285         spinlock_t              rb_mwlock;      /* protect rb_mws list */
 286         struct list_head        rb_mws;
 287         struct list_head        rb_all;
 288         char                    *rb_pool;
 289
 290         spinlock_t              rb_lock;        /* protect buf lists */
 291         struct list_head        rb_send_bufs;
 292         struct list_head        rb_recv_bufs;
 293         u32                     rb_max_requests;
 294 };
 295 #define rdmab_to_ia(b) (&container_of((b), struct rpcrdma_xprt, rx_buf)->rx_ia)
 296
 297 /*
 298  * Internal structure for transport instance creation. This
 299  * exists primarily for modularity.
 300  *
 301  * This data should be set with mount options
 302  */
 303 struct rpcrdma_create_data_internal {
 304         struct sockaddr_storage addr;   /* RDMA server address */
 305         unsigned int    max_requests;   /* max requests (slots) in flight */
 306         unsigned int    rsize;          /* mount rsize - max read hdr+data */
 307         unsigned int    wsize;          /* mount wsize - max write hdr+data */
 308         unsigned int    inline_rsize;   /* max non-rdma read data payload */
 309         unsigned int    inline_wsize;   /* max non-rdma write data payload */
 310         unsigned int    padding;        /* non-rdma write header padding */
 311 };
 312
 313 #define RPCRDMA_INLINE_READ_THRESHOLD(rq) \
 314         (rpcx_to_rdmad(rq->rq_xprt).inline_rsize)
 315
 316 #define RPCRDMA_INLINE_WRITE_THRESHOLD(rq)\
 317         (rpcx_to_rdmad(rq->rq_xprt).inline_wsize)
 318
 319 #define RPCRDMA_INLINE_PAD_VALUE(rq)\
 320         rpcx_to_rdmad(rq->rq_xprt).padding
 321
 322 /*
 323  * Statistics for RPCRDMA
 324  */
 325 struct rpcrdma_stats {
 326         unsigned long           read_chunk_count;
 327         unsigned long           write_chunk_count;
 328         unsigned long           reply_chunk_count;
 329
 330         unsigned long long      total_rdma_request;
 331         unsigned long long      total_rdma_reply;
 332
 333         unsigned long long      pullup_copy_count;
 334         unsigned long long      fixup_copy_count;
 335         unsigned long           hardway_register_count;
 336         unsigned long           failed_marshal_count;
 337         unsigned long           bad_reply_count;
 338         unsigned long           nomsg_call_count;
 339 };
 340
 341 /*
 342  * Per-registration mode operations
 343  */
 344 struct rpcrdma_xprt;
 345 struct rpcrdma_memreg_ops {
 346         int             (*ro_map)(struct rpcrdma_xprt *,
 347                                   struct rpcrdma_mr_seg *, int, bool);
 348         int             (*ro_unmap)(struct rpcrdma_xprt *,
 349                                     struct rpcrdma_mr_seg *);
 350         int             (*ro_open)(struct rpcrdma_ia *,
 351                                    struct rpcrdma_ep *,
 352                                    struct rpcrdma_create_data_internal *);
 353         size_t          (*ro_maxpages)(struct rpcrdma_xprt *);
 354         int             (*ro_init)(struct rpcrdma_xprt *);
 355         void            (*ro_destroy)(struct rpcrdma_buffer *);
 356         const char      *ro_displayname;
 357 };
 358
 359 extern const struct rpcrdma_memreg_ops rpcrdma_fmr_memreg_ops;
 360 extern const struct rpcrdma_memreg_ops rpcrdma_frwr_memreg_ops;
 361 extern const struct rpcrdma_memreg_ops rpcrdma_physical_memreg_ops;
 362
 363 /*
 364  * RPCRDMA transport -- encapsulates the structures above for
 365  * integration with RPC.
 366  *
 367  * The contained structures are embedded, not pointers,
 368  * for convenience. This structure need not be visible externally.
 369  *
 370  * It is allocated and initialized during mount, and released
 371  * during unmount.
 372  */
 373 struct rpcrdma_xprt {
 374         struct rpc_xprt         rx_xprt;
 375         struct rpcrdma_ia       rx_ia;
 376         struct rpcrdma_ep       rx_ep;
 377         struct rpcrdma_buffer   rx_buf;
 378         struct rpcrdma_create_data_internal rx_data;
 379         struct delayed_work     rx_connect_worker;
 380         struct rpcrdma_stats    rx_stats;
 381 };
 382
 383 #define rpcx_to_rdmax(x) container_of(x, struct rpcrdma_xprt, rx_xprt)
 384 #define rpcx_to_rdmad(x) (rpcx_to_rdmax(x)->rx_data)
 385
 386 /* Setting this to 0 ensures interoperability with early servers.
 387  * Setting this to 1 enhances certain unaligned read/write performance.
 388  * Default is 0, see sysctl entry and rpc_rdma.c rpcrdma_convert_iovs() */
 389 extern int xprt_rdma_pad_optimize;
 390
 391 /*
 392  * Interface Adapter calls - xprtrdma/verbs.c
 393  */
 394 int rpcrdma_ia_open(struct rpcrdma_xprt *, struct sockaddr *, int);
 395 void rpcrdma_ia_close(struct rpcrdma_ia *);
 396
 397 /*
 398  * Endpoint calls - xprtrdma/verbs.c
 399  */
 400 int rpcrdma_ep_create(struct rpcrdma_ep *, struct rpcrdma_ia *,
 401                                 struct rpcrdma_create_data_internal *);
 402 void rpcrdma_ep_destroy(struct rpcrdma_ep *, struct rpcrdma_ia *);
 403 int rpcrdma_ep_connect(struct rpcrdma_ep *, struct rpcrdma_ia *);
 404 void rpcrdma_ep_disconnect(struct rpcrdma_ep *, struct rpcrdma_ia *);
 405
 406 int rpcrdma_ep_post(struct rpcrdma_ia *, struct rpcrdma_ep *,
 407                                 struct rpcrdma_req *);
 408 int rpcrdma_ep_post_recv(struct rpcrdma_ia *, struct rpcrdma_ep *,
 409                                 struct rpcrdma_rep *);
 410
 411 /*
 412  * Buffer calls - xprtrdma/verbs.c
 413  */
 414 int rpcrdma_buffer_create(struct rpcrdma_xprt *);
 415 void rpcrdma_buffer_destroy(struct rpcrdma_buffer *);
 416
 417 struct rpcrdma_mw *rpcrdma_get_mw(struct rpcrdma_xprt *);
 418 void rpcrdma_put_mw(struct rpcrdma_xprt *, struct rpcrdma_mw *);
 419 struct rpcrdma_req *rpcrdma_buffer_get(struct rpcrdma_buffer *);
 420 void rpcrdma_buffer_put(struct rpcrdma_req *);
 421 void rpcrdma_recv_buffer_get(struct rpcrdma_req *);
 422 void rpcrdma_recv_buffer_put(struct rpcrdma_rep *);
 423
 424 struct rpcrdma_regbuf *rpcrdma_alloc_regbuf(struct rpcrdma_ia *,
 425                                             size_t, gfp_t);
 426 void rpcrdma_free_regbuf(struct rpcrdma_ia *,
 427                          struct rpcrdma_regbuf *);
 428
 429 unsigned int rpcrdma_max_segments(struct rpcrdma_xprt *);
 430
 431 int frwr_alloc_recovery_wq(void);
 432 void frwr_destroy_recovery_wq(void);
 433
 434 int rpcrdma_alloc_wq(void);
 435 void rpcrdma_destroy_wq(void);
 436
 437 /*
 438  * Wrappers for chunk registration, shared by read/write chunk code.
 439  */
 440
 441 void rpcrdma_mapping_error(struct rpcrdma_mr_seg *);
 442
 443 static inline enum dma_data_direction
 444 rpcrdma_data_dir(bool writing)
 445 {
 446         return writing ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
 447 }
 448
 449 static inline void
 450 rpcrdma_map_one(struct ib_device *device, struct rpcrdma_mr_seg *seg,
 451                 enum dma_data_direction direction)
 452 {
 453         seg->mr_dir = direction;
 454         seg->mr_dmalen = seg->mr_len;
 455
 456         if (seg->mr_page)
 457                 seg->mr_dma = ib_dma_map_page(device,
 458                                 seg->mr_page, offset_in_page(seg->mr_offset),
 459                                 seg->mr_dmalen, seg->mr_dir);
 460         else
 461                 seg->mr_dma = ib_dma_map_single(device,
 462                                 seg->mr_offset,
 463                                 seg->mr_dmalen, seg->mr_dir);
 464
 465         if (ib_dma_mapping_error(device, seg->mr_dma))
 466                 rpcrdma_mapping_error(seg);
 467 }
 468
 469 static inline void
 470 rpcrdma_unmap_one(struct ib_device *device, struct rpcrdma_mr_seg *seg)
 471 {
 472         if (seg->mr_page)
 473                 ib_dma_unmap_page(device,
 474                                   seg->mr_dma, seg->mr_dmalen, seg->mr_dir);
 475         else
 476                 ib_dma_unmap_single(device,
 477                                     seg->mr_dma, seg->mr_dmalen, seg->mr_dir);
 478 }
 479
 480 /*
 481  * RPC/RDMA connection management calls - xprtrdma/rpc_rdma.c
 482  */
 483 void rpcrdma_connect_worker(struct work_struct *);
 484 void rpcrdma_conn_func(struct rpcrdma_ep *);
 485 void rpcrdma_reply_handler(struct rpcrdma_rep *);
 486
 487 /*
 488  * RPC/RDMA protocol calls - xprtrdma/rpc_rdma.c
 489  */
 490 int rpcrdma_marshal_req(struct rpc_rqst *);
 491
 492 /* RPC/RDMA module init - xprtrdma/transport.c
 493  */
 494 int xprt_rdma_init(void);
 495 void xprt_rdma_cleanup(void);
 496
 497 /* Temporary NFS request map cache. Created in svc_rdma.c  */
 498 extern struct kmem_cache *svc_rdma_map_cachep;
 499 /* WR context cache. Created in svc_rdma.c  */
 500 extern struct kmem_cache *svc_rdma_ctxt_cachep;
 501 /* Workqueue created in svc_rdma.c */
 502 extern struct workqueue_struct *svc_rdma_wq;
 503
 504 #endif                          /* _LINUX_SUNRPC_XPRT_RDMA_H */