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
  47 #include <rdma/rdma_cm.h>               /* RDMA connection api */
  48 #include <rdma/ib_verbs.h>              /* RDMA verbs api */
  49
  50 #include <linux/sunrpc/clnt.h>          /* rpc_xprt */
  51 #include <linux/sunrpc/rpc_rdma.h>      /* RPC/RDMA protocol */
  52 #include <linux/sunrpc/xprtrdma.h>      /* xprt parameters */
  53
  54 #define RDMA_RESOLVE_TIMEOUT    (5000)  /* 5 seconds */
  55 #define RDMA_CONNECT_RETRY_MAX  (2)     /* retries if no listener backlog */
  56
  57 /*
  58  * Interface Adapter -- one per transport instance
  59  */
  60 struct rpcrdma_ia {
  61         struct rdma_cm_id       *ri_id;
  62         struct ib_pd            *ri_pd;
  63         struct ib_mr            *ri_bind_mem;
  64         u32                     ri_dma_lkey;
  65         int                     ri_have_dma_lkey;
  66         struct completion       ri_done;
  67         int                     ri_async_rc;
  68         enum rpcrdma_memreg     ri_memreg_strategy;
  69         unsigned int            ri_max_frmr_depth;
  70 };
  71
  72 /*
  73  * RDMA Endpoint -- one per transport instance
  74  */
  75
  76 struct rpcrdma_ep {
  77         atomic_t                rep_cqcount;
  78         int                     rep_cqinit;
  79         int                     rep_connected;
  80         struct rpcrdma_ia       *rep_ia;
  81         struct ib_cq            *rep_cq;
  82         struct ib_qp_init_attr  rep_attr;
  83         wait_queue_head_t       rep_connect_wait;
  84         struct ib_sge           rep_pad;        /* holds zeroed pad */
  85         struct ib_mr            *rep_pad_mr;    /* holds zeroed pad */
  86         void                    (*rep_func)(struct rpcrdma_ep *);
  87         struct rpc_xprt         *rep_xprt;      /* for rep_func */
  88         struct rdma_conn_param  rep_remote_cma;
  89         struct sockaddr_storage rep_remote_addr;
  90 };
  91
  92 #define INIT_CQCOUNT(ep) atomic_set(&(ep)->rep_cqcount, (ep)->rep_cqinit)
  93 #define DECR_CQCOUNT(ep) atomic_sub_return(1, &(ep)->rep_cqcount)
  94
  95 /*
  96  * struct rpcrdma_rep -- this structure encapsulates state required to recv
  97  * and complete a reply, asychronously. It needs several pieces of
  98  * state:
  99  *   o recv buffer (posted to provider)
 100  *   o ib_sge (also donated to provider)
 101  *   o status of reply (length, success or not)
 102  *   o bookkeeping state to get run by tasklet (list, etc)
 103  *
 104  * These are allocated during initialization, per-transport instance;
 105  * however, the tasklet execution list itself is global, as it should
 106  * always be pretty short.
 107  *
 108  * N of these are associated with a transport instance, and stored in
 109  * struct rpcrdma_buffer. N is the max number of outstanding requests.
 110  */
 111
 112 /* temporary static scatter/gather max */
 113 #define RPCRDMA_MAX_DATA_SEGS   (64)    /* max scatter/gather */
 114 #define RPCRDMA_MAX_SEGS        (RPCRDMA_MAX_DATA_SEGS + 2) /* head+tail = 2 */
 115 #define MAX_RPCRDMAHDR  (\
 116         /* max supported RPC/RDMA header */ \
 117         sizeof(struct rpcrdma_msg) + (2 * sizeof(u32)) + \
 118         (sizeof(struct rpcrdma_read_chunk) * RPCRDMA_MAX_SEGS) + sizeof(u32))
 119
 120 struct rpcrdma_buffer;
 121
 122 struct rpcrdma_rep {
 123         unsigned int    rr_len;         /* actual received reply length */
 124         struct rpcrdma_buffer *rr_buffer; /* home base for this structure */
 125         struct rpc_xprt *rr_xprt;       /* needed for request/reply matching */
 126         void (*rr_func)(struct rpcrdma_rep *);/* called by tasklet in softint */
 127         struct list_head rr_list;       /* tasklet list */
 128         wait_queue_head_t rr_unbind;    /* optional unbind wait */
 129         struct ib_sge   rr_iov;         /* for posting */
 130         struct ib_mr    *rr_handle;     /* handle for mem in rr_iov */
 131         char    rr_base[MAX_RPCRDMAHDR]; /* minimal inline receive buffer */
 132 };
 133
 134 /*
 135  * struct rpcrdma_req -- structure central to the request/reply sequence.
 136  *
 137  * N of these are associated with a transport instance, and stored in
 138  * struct rpcrdma_buffer. N is the max number of outstanding requests.
 139  *
 140  * It includes pre-registered buffer memory for send AND recv.
 141  * The recv buffer, however, is not owned by this structure, and
 142  * is "donated" to the hardware when a recv is posted. When a
 143  * reply is handled, the recv buffer used is given back to the
 144  * struct rpcrdma_req associated with the request.
 145  *
 146  * In addition to the basic memory, this structure includes an array
 147  * of iovs for send operations. The reason is that the iovs passed to
 148  * ib_post_{send,recv} must not be modified until the work request
 149  * completes.
 150  *
 151  * NOTES:
 152  *   o RPCRDMA_MAX_SEGS is the max number of addressible chunk elements we
 153  *     marshal. The number needed varies depending on the iov lists that
 154  *     are passed to us, the memory registration mode we are in, and if
 155  *     physical addressing is used, the layout.
 156  */
 157
 158 struct rpcrdma_mr_seg {         /* chunk descriptors */
 159         union {                         /* chunk memory handles */
 160                 struct ib_mr    *rl_mr;         /* if registered directly */
 161                 struct rpcrdma_mw {             /* if registered from region */
 162                         union {
 163                                 struct ib_mw    *mw;
 164                                 struct ib_fmr   *fmr;
 165                                 struct {
 166                                         struct ib_fast_reg_page_list *fr_pgl;
 167                                         struct ib_mr *fr_mr;
 168                                         enum { FRMR_IS_INVALID, FRMR_IS_VALID  } state;
 169                                 } frmr;
 170                         } r;
 171                         struct list_head mw_list;
 172                 } *rl_mw;
 173         } mr_chunk;
 174         u64             mr_base;        /* registration result */
 175         u32             mr_rkey;        /* registration result */
 176         u32             mr_len;         /* length of chunk or segment */
 177         int             mr_nsegs;       /* number of segments in chunk or 0 */
 178         enum dma_data_direction mr_dir; /* segment mapping direction */
 179         dma_addr_t      mr_dma;         /* segment mapping address */
 180         size_t          mr_dmalen;      /* segment mapping length */
 181         struct page     *mr_page;       /* owning page, if any */
 182         char            *mr_offset;     /* kva if no page, else offset */
 183 };
 184
 185 struct rpcrdma_req {
 186         size_t          rl_size;        /* actual length of buffer */
 187         unsigned int    rl_niovs;       /* 0, 2 or 4 */
 188         unsigned int    rl_nchunks;     /* non-zero if chunks */
 189         unsigned int    rl_connect_cookie;      /* retry detection */
 190         struct rpcrdma_buffer *rl_buffer; /* home base for this structure */
 191         struct rpcrdma_rep      *rl_reply;/* holder for reply buffer */
 192         struct rpcrdma_mr_seg rl_segments[RPCRDMA_MAX_SEGS];/* chunk segments */
 193         struct ib_sge   rl_send_iov[4]; /* for active requests */
 194         struct ib_sge   rl_iov;         /* for posting */
 195         struct ib_mr    *rl_handle;     /* handle for mem in rl_iov */
 196         char            rl_base[MAX_RPCRDMAHDR]; /* start of actual buffer */
 197         __u32           rl_xdr_buf[0];  /* start of returned rpc rq_buffer */
 198 };
 199 #define rpcr_to_rdmar(r) \
 200         container_of((r)->rq_buffer, struct rpcrdma_req, rl_xdr_buf[0])
 201
 202 /*
 203  * struct rpcrdma_buffer -- holds list/queue of pre-registered memory for
 204  * inline requests/replies, and client/server credits.
 205  *
 206  * One of these is associated with a transport instance
 207  */
 208 struct rpcrdma_buffer {
 209         spinlock_t      rb_lock;        /* protects indexes */
 210         atomic_t        rb_credits;     /* most recent server credits */
 211         unsigned long   rb_cwndscale;   /* cached framework rpc_cwndscale */
 212         int             rb_max_requests;/* client max requests */
 213         struct list_head rb_mws;        /* optional memory windows/fmrs/frmrs */
 214         int             rb_send_index;
 215         struct rpcrdma_req      **rb_send_bufs;
 216         int             rb_recv_index;
 217         struct rpcrdma_rep      **rb_recv_bufs;
 218         char            *rb_pool;
 219 };
 220 #define rdmab_to_ia(b) (&container_of((b), struct rpcrdma_xprt, rx_buf)->rx_ia)
 221
 222 /*
 223  * Internal structure for transport instance creation. This
 224  * exists primarily for modularity.
 225  *
 226  * This data should be set with mount options
 227  */
 228 struct rpcrdma_create_data_internal {
 229         struct sockaddr_storage addr;   /* RDMA server address */
 230         unsigned int    max_requests;   /* max requests (slots) in flight */
 231         unsigned int    rsize;          /* mount rsize - max read hdr+data */
 232         unsigned int    wsize;          /* mount wsize - max write hdr+data */
 233         unsigned int    inline_rsize;   /* max non-rdma read data payload */
 234         unsigned int    inline_wsize;   /* max non-rdma write data payload */
 235         unsigned int    padding;        /* non-rdma write header padding */
 236 };
 237
 238 #define RPCRDMA_INLINE_READ_THRESHOLD(rq) \
 239         (rpcx_to_rdmad(rq->rq_xprt).inline_rsize)
 240
 241 #define RPCRDMA_INLINE_WRITE_THRESHOLD(rq)\
 242         (rpcx_to_rdmad(rq->rq_xprt).inline_wsize)
 243
 244 #define RPCRDMA_INLINE_PAD_VALUE(rq)\
 245         rpcx_to_rdmad(rq->rq_xprt).padding
 246
 247 /*
 248  * Statistics for RPCRDMA
 249  */
 250 struct rpcrdma_stats {
 251         unsigned long           read_chunk_count;
 252         unsigned long           write_chunk_count;
 253         unsigned long           reply_chunk_count;
 254
 255         unsigned long long      total_rdma_request;
 256         unsigned long long      total_rdma_reply;
 257
 258         unsigned long long      pullup_copy_count;
 259         unsigned long long      fixup_copy_count;
 260         unsigned long           hardway_register_count;
 261         unsigned long           failed_marshal_count;
 262         unsigned long           bad_reply_count;
 263 };
 264
 265 /*
 266  * RPCRDMA transport -- encapsulates the structures above for
 267  * integration with RPC.
 268  *
 269  * The contained structures are embedded, not pointers,
 270  * for convenience. This structure need not be visible externally.
 271  *
 272  * It is allocated and initialized during mount, and released
 273  * during unmount.
 274  */
 275 struct rpcrdma_xprt {
 276         struct rpc_xprt         xprt;
 277         struct rpcrdma_ia       rx_ia;
 278         struct rpcrdma_ep       rx_ep;
 279         struct rpcrdma_buffer   rx_buf;
 280         struct rpcrdma_create_data_internal rx_data;
 281         struct delayed_work     rdma_connect;
 282         struct rpcrdma_stats    rx_stats;
 283 };
 284
 285 #define rpcx_to_rdmax(x) container_of(x, struct rpcrdma_xprt, xprt)
 286 #define rpcx_to_rdmad(x) (rpcx_to_rdmax(x)->rx_data)
 287
 288 /* Setting this to 0 ensures interoperability with early servers.
 289  * Setting this to 1 enhances certain unaligned read/write performance.
 290  * Default is 0, see sysctl entry and rpc_rdma.c rpcrdma_convert_iovs() */
 291 extern int xprt_rdma_pad_optimize;
 292
 293 /*
 294  * Interface Adapter calls - xprtrdma/verbs.c
 295  */
 296 int rpcrdma_ia_open(struct rpcrdma_xprt *, struct sockaddr *, int);
 297 void rpcrdma_ia_close(struct rpcrdma_ia *);
 298
 299 /*
 300  * Endpoint calls - xprtrdma/verbs.c
 301  */
 302 int rpcrdma_ep_create(struct rpcrdma_ep *, struct rpcrdma_ia *,
 303                                 struct rpcrdma_create_data_internal *);
 304 int rpcrdma_ep_destroy(struct rpcrdma_ep *, struct rpcrdma_ia *);
 305 int rpcrdma_ep_connect(struct rpcrdma_ep *, struct rpcrdma_ia *);
 306 int rpcrdma_ep_disconnect(struct rpcrdma_ep *, struct rpcrdma_ia *);
 307
 308 int rpcrdma_ep_post(struct rpcrdma_ia *, struct rpcrdma_ep *,
 309                                 struct rpcrdma_req *);
 310 int rpcrdma_ep_post_recv(struct rpcrdma_ia *, struct rpcrdma_ep *,
 311                                 struct rpcrdma_rep *);
 312
 313 /*
 314  * Buffer calls - xprtrdma/verbs.c
 315  */
 316 int rpcrdma_buffer_create(struct rpcrdma_buffer *, struct rpcrdma_ep *,
 317                                 struct rpcrdma_ia *,
 318                                 struct rpcrdma_create_data_internal *);
 319 void rpcrdma_buffer_destroy(struct rpcrdma_buffer *);
 320
 321 struct rpcrdma_req *rpcrdma_buffer_get(struct rpcrdma_buffer *);
 322 void rpcrdma_buffer_put(struct rpcrdma_req *);
 323 void rpcrdma_recv_buffer_get(struct rpcrdma_req *);
 324 void rpcrdma_recv_buffer_put(struct rpcrdma_rep *);
 325
 326 int rpcrdma_register_internal(struct rpcrdma_ia *, void *, int,
 327                                 struct ib_mr **, struct ib_sge *);
 328 int rpcrdma_deregister_internal(struct rpcrdma_ia *,
 329                                 struct ib_mr *, struct ib_sge *);
 330
 331 int rpcrdma_register_external(struct rpcrdma_mr_seg *,
 332                                 int, int, struct rpcrdma_xprt *);
 333 int rpcrdma_deregister_external(struct rpcrdma_mr_seg *,
 334                                 struct rpcrdma_xprt *, void *);
 335
 336 /*
 337  * RPC/RDMA connection management calls - xprtrdma/rpc_rdma.c
 338  */
 339 void rpcrdma_conn_func(struct rpcrdma_ep *);
 340 void rpcrdma_reply_handler(struct rpcrdma_rep *);
 341
 342 /*
 343  * RPC/RDMA protocol calls - xprtrdma/rpc_rdma.c
 344  */
 345 int rpcrdma_marshal_req(struct rpc_rqst *);
 346
 347 /* Temporary NFS request map cache. Created in svc_rdma.c  */
 348 extern struct kmem_cache *svc_rdma_map_cachep;
 349 /* WR context cache. Created in svc_rdma.c  */
 350 extern struct kmem_cache *svc_rdma_ctxt_cachep;
 351 /* Workqueue created in svc_rdma.c */
 352 extern struct workqueue_struct *svc_rdma_wq;
 353
 354 #endif                          /* _LINUX_SUNRPC_XPRT_RDMA_H */