OSDN Git Service

xprtrdma: Use smaller buffers for RPC-over-RDMA headers
[uclinux-h8/linux.git] / 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 #define RPCRDMA_BIND_TO         (60U * HZ)
59 #define RPCRDMA_INIT_REEST_TO   (5U * HZ)
60 #define RPCRDMA_MAX_REEST_TO    (30U * HZ)
61 #define RPCRDMA_IDLE_DISC_TO    (5U * 60 * HZ)
62
63 /*
64  * Interface Adapter -- one per transport instance
65  */
66 struct rpcrdma_ia {
67         const struct rpcrdma_memreg_ops *ri_ops;
68         struct ib_device        *ri_device;
69         struct rdma_cm_id       *ri_id;
70         struct ib_pd            *ri_pd;
71         struct completion       ri_done;
72         int                     ri_async_rc;
73         unsigned int            ri_max_frmr_depth;
74         unsigned int            ri_max_inline_write;
75         unsigned int            ri_max_inline_read;
76         struct ib_qp_attr       ri_qp_attr;
77         struct ib_qp_init_attr  ri_qp_init_attr;
78 };
79
80 /*
81  * RDMA Endpoint -- one per transport instance
82  */
83
84 struct rpcrdma_ep {
85         atomic_t                rep_cqcount;
86         int                     rep_cqinit;
87         int                     rep_connected;
88         struct ib_qp_init_attr  rep_attr;
89         wait_queue_head_t       rep_connect_wait;
90         struct rdma_conn_param  rep_remote_cma;
91         struct sockaddr_storage rep_remote_addr;
92         struct delayed_work     rep_connect_worker;
93 };
94
95 #define INIT_CQCOUNT(ep) atomic_set(&(ep)->rep_cqcount, (ep)->rep_cqinit)
96 #define DECR_CQCOUNT(ep) atomic_sub_return(1, &(ep)->rep_cqcount)
97
98 /* Pre-allocate extra Work Requests for handling backward receives
99  * and sends. This is a fixed value because the Work Queues are
100  * allocated when the forward channel is set up.
101  */
102 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
103 #define RPCRDMA_BACKWARD_WRS            (8)
104 #else
105 #define RPCRDMA_BACKWARD_WRS            (0)
106 #endif
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         struct ib_sge           rg_iov;
116         __be32                  rg_base[0] __attribute__ ((aligned(256)));
117 };
118
119 static inline u64
120 rdmab_addr(struct rpcrdma_regbuf *rb)
121 {
122         return rb->rg_iov.addr;
123 }
124
125 static inline u32
126 rdmab_length(struct rpcrdma_regbuf *rb)
127 {
128         return rb->rg_iov.length;
129 }
130
131 static inline u32
132 rdmab_lkey(struct rpcrdma_regbuf *rb)
133 {
134         return rb->rg_iov.lkey;
135 }
136
137 static inline struct rpcrdma_msg *
138 rdmab_to_msg(struct rpcrdma_regbuf *rb)
139 {
140         return (struct rpcrdma_msg *)rb->rg_base;
141 }
142
143 #define RPCRDMA_DEF_GFP         (GFP_NOIO | __GFP_NOWARN)
144
145 /* To ensure a transport can always make forward progress,
146  * the number of RDMA segments allowed in header chunk lists
147  * is capped at 8. This prevents less-capable devices and
148  * memory registrations from overrunning the Send buffer
149  * while building chunk lists.
150  *
151  * Elements of the Read list take up more room than the
152  * Write list or Reply chunk. 8 read segments means the Read
153  * list (or Write list or Reply chunk) cannot consume more
154  * than
155  *
156  * ((8 + 2) * read segment size) + 1 XDR words, or 244 bytes.
157  *
158  * And the fixed part of the header is another 24 bytes.
159  *
160  * The smallest inline threshold is 1024 bytes, ensuring that
161  * at least 750 bytes are available for RPC messages.
162  */
163 enum {
164         RPCRDMA_MAX_HDR_SEGS = 8,
165         RPCRDMA_HDRBUF_SIZE = 256,
166 };
167
168 /*
169  * struct rpcrdma_rep -- this structure encapsulates state required to recv
170  * and complete a reply, asychronously. It needs several pieces of
171  * state:
172  *   o recv buffer (posted to provider)
173  *   o ib_sge (also donated to provider)
174  *   o status of reply (length, success or not)
175  *   o bookkeeping state to get run by reply handler (list, etc)
176  *
177  * These are allocated during initialization, per-transport instance.
178  *
179  * N of these are associated with a transport instance, and stored in
180  * struct rpcrdma_buffer. N is the max number of outstanding requests.
181  */
182
183 struct rpcrdma_rep {
184         struct ib_cqe           rr_cqe;
185         unsigned int            rr_len;
186         struct ib_device        *rr_device;
187         struct rpcrdma_xprt     *rr_rxprt;
188         struct work_struct      rr_work;
189         struct list_head        rr_list;
190         struct rpcrdma_regbuf   *rr_rdmabuf;
191 };
192
193 #define RPCRDMA_BAD_LEN         (~0U)
194
195 /*
196  * struct rpcrdma_mw - external memory region metadata
197  *
198  * An external memory region is any buffer or page that is registered
199  * on the fly (ie, not pre-registered).
200  *
201  * Each rpcrdma_buffer has a list of free MWs anchored in rb_mws. During
202  * call_allocate, rpcrdma_buffer_get() assigns one to each segment in
203  * an rpcrdma_req. Then rpcrdma_register_external() grabs these to keep
204  * track of registration metadata while each RPC is pending.
205  * rpcrdma_deregister_external() uses this metadata to unmap and
206  * release these resources when an RPC is complete.
207  */
208 enum rpcrdma_frmr_state {
209         FRMR_IS_INVALID,        /* ready to be used */
210         FRMR_IS_VALID,          /* in use */
211         FRMR_IS_STALE,          /* failed completion */
212 };
213
214 struct rpcrdma_frmr {
215         struct ib_mr                    *fr_mr;
216         struct ib_cqe                   fr_cqe;
217         enum rpcrdma_frmr_state         fr_state;
218         struct completion               fr_linv_done;
219         union {
220                 struct ib_reg_wr        fr_regwr;
221                 struct ib_send_wr       fr_invwr;
222         };
223 };
224
225 struct rpcrdma_fmr {
226         struct ib_fmr           *fm_mr;
227         u64                     *fm_physaddrs;
228 };
229
230 struct rpcrdma_mw {
231         struct list_head        mw_list;
232         struct scatterlist      *mw_sg;
233         int                     mw_nents;
234         enum dma_data_direction mw_dir;
235         union {
236                 struct rpcrdma_fmr      fmr;
237                 struct rpcrdma_frmr     frmr;
238         };
239         struct rpcrdma_xprt     *mw_xprt;
240         u32                     mw_handle;
241         u32                     mw_length;
242         u64                     mw_offset;
243         struct list_head        mw_all;
244 };
245
246 /*
247  * struct rpcrdma_req -- structure central to the request/reply sequence.
248  *
249  * N of these are associated with a transport instance, and stored in
250  * struct rpcrdma_buffer. N is the max number of outstanding requests.
251  *
252  * It includes pre-registered buffer memory for send AND recv.
253  * The recv buffer, however, is not owned by this structure, and
254  * is "donated" to the hardware when a recv is posted. When a
255  * reply is handled, the recv buffer used is given back to the
256  * struct rpcrdma_req associated with the request.
257  *
258  * In addition to the basic memory, this structure includes an array
259  * of iovs for send operations. The reason is that the iovs passed to
260  * ib_post_{send,recv} must not be modified until the work request
261  * completes.
262  */
263
264 /* Maximum number of page-sized "segments" per chunk list to be
265  * registered or invalidated. Must handle a Reply chunk:
266  */
267 enum {
268         RPCRDMA_MAX_IOV_SEGS    = 3,
269         RPCRDMA_MAX_DATA_SEGS   = ((1 * 1024 * 1024) / PAGE_SIZE) + 1,
270         RPCRDMA_MAX_SEGS        = RPCRDMA_MAX_DATA_SEGS +
271                                   RPCRDMA_MAX_IOV_SEGS,
272 };
273
274 struct rpcrdma_mr_seg {         /* chunk descriptors */
275         u32             mr_len;         /* length of chunk or segment */
276         struct page     *mr_page;       /* owning page, if any */
277         char            *mr_offset;     /* kva if no page, else offset */
278 };
279
280 #define RPCRDMA_MAX_IOVS        (2)
281
282 struct rpcrdma_buffer;
283 struct rpcrdma_req {
284         struct list_head        rl_free;
285         unsigned int            rl_niovs;
286         unsigned int            rl_connect_cookie;
287         struct rpcrdma_buffer   *rl_buffer;
288         struct rpcrdma_rep      *rl_reply;/* holder for reply buffer */
289         struct ib_sge           rl_send_iov[RPCRDMA_MAX_IOVS];
290         struct rpcrdma_regbuf   *rl_rdmabuf;    /* xprt header */
291         struct rpcrdma_regbuf   *rl_sendbuf;    /* rq_snd_buf */
292         struct rpcrdma_regbuf   *rl_recvbuf;    /* rq_rcv_buf */
293
294         struct ib_cqe           rl_cqe;
295         struct list_head        rl_all;
296         bool                    rl_backchannel;
297
298         struct list_head        rl_registered;  /* registered segments */
299         struct rpcrdma_mr_seg   rl_segments[RPCRDMA_MAX_SEGS];
300 };
301
302 static inline void
303 rpcrdma_set_xprtdata(struct rpc_rqst *rqst, struct rpcrdma_req *req)
304 {
305         rqst->rq_xprtdata = req;
306 }
307
308 static inline struct rpcrdma_req *
309 rpcr_to_rdmar(struct rpc_rqst *rqst)
310 {
311         return rqst->rq_xprtdata;
312 }
313
314 /*
315  * struct rpcrdma_buffer -- holds list/queue of pre-registered memory for
316  * inline requests/replies, and client/server credits.
317  *
318  * One of these is associated with a transport instance
319  */
320 struct rpcrdma_buffer {
321         spinlock_t              rb_mwlock;      /* protect rb_mws list */
322         struct list_head        rb_mws;
323         struct list_head        rb_all;
324         char                    *rb_pool;
325
326         spinlock_t              rb_lock;        /* protect buf lists */
327         int                     rb_send_count, rb_recv_count;
328         struct list_head        rb_send_bufs;
329         struct list_head        rb_recv_bufs;
330         u32                     rb_max_requests;
331         atomic_t                rb_credits;     /* most recent credit grant */
332
333         u32                     rb_bc_srv_max_requests;
334         spinlock_t              rb_reqslock;    /* protect rb_allreqs */
335         struct list_head        rb_allreqs;
336
337         u32                     rb_bc_max_requests;
338
339         spinlock_t              rb_recovery_lock; /* protect rb_stale_mrs */
340         struct list_head        rb_stale_mrs;
341         struct delayed_work     rb_recovery_worker;
342         struct delayed_work     rb_refresh_worker;
343 };
344 #define rdmab_to_ia(b) (&container_of((b), struct rpcrdma_xprt, rx_buf)->rx_ia)
345
346 /*
347  * Internal structure for transport instance creation. This
348  * exists primarily for modularity.
349  *
350  * This data should be set with mount options
351  */
352 struct rpcrdma_create_data_internal {
353         struct sockaddr_storage addr;   /* RDMA server address */
354         unsigned int    max_requests;   /* max requests (slots) in flight */
355         unsigned int    rsize;          /* mount rsize - max read hdr+data */
356         unsigned int    wsize;          /* mount wsize - max write hdr+data */
357         unsigned int    inline_rsize;   /* max non-rdma read data payload */
358         unsigned int    inline_wsize;   /* max non-rdma write data payload */
359         unsigned int    padding;        /* non-rdma write header padding */
360 };
361
362 /*
363  * Statistics for RPCRDMA
364  */
365 struct rpcrdma_stats {
366         unsigned long           read_chunk_count;
367         unsigned long           write_chunk_count;
368         unsigned long           reply_chunk_count;
369
370         unsigned long long      total_rdma_request;
371         unsigned long long      total_rdma_reply;
372
373         unsigned long long      pullup_copy_count;
374         unsigned long long      fixup_copy_count;
375         unsigned long           hardway_register_count;
376         unsigned long           failed_marshal_count;
377         unsigned long           bad_reply_count;
378         unsigned long           nomsg_call_count;
379         unsigned long           bcall_count;
380         unsigned long           mrs_recovered;
381         unsigned long           mrs_orphaned;
382         unsigned long           mrs_allocated;
383 };
384
385 /*
386  * Per-registration mode operations
387  */
388 struct rpcrdma_xprt;
389 struct rpcrdma_memreg_ops {
390         int             (*ro_map)(struct rpcrdma_xprt *,
391                                   struct rpcrdma_mr_seg *, int, bool,
392                                   struct rpcrdma_mw **);
393         void            (*ro_unmap_sync)(struct rpcrdma_xprt *,
394                                          struct rpcrdma_req *);
395         void            (*ro_unmap_safe)(struct rpcrdma_xprt *,
396                                          struct rpcrdma_req *, bool);
397         void            (*ro_recover_mr)(struct rpcrdma_mw *);
398         int             (*ro_open)(struct rpcrdma_ia *,
399                                    struct rpcrdma_ep *,
400                                    struct rpcrdma_create_data_internal *);
401         size_t          (*ro_maxpages)(struct rpcrdma_xprt *);
402         int             (*ro_init_mr)(struct rpcrdma_ia *,
403                                       struct rpcrdma_mw *);
404         void            (*ro_release_mr)(struct rpcrdma_mw *);
405         const char      *ro_displayname;
406 };
407
408 extern const struct rpcrdma_memreg_ops rpcrdma_fmr_memreg_ops;
409 extern const struct rpcrdma_memreg_ops rpcrdma_frwr_memreg_ops;
410
411 /*
412  * RPCRDMA transport -- encapsulates the structures above for
413  * integration with RPC.
414  *
415  * The contained structures are embedded, not pointers,
416  * for convenience. This structure need not be visible externally.
417  *
418  * It is allocated and initialized during mount, and released
419  * during unmount.
420  */
421 struct rpcrdma_xprt {
422         struct rpc_xprt         rx_xprt;
423         struct rpcrdma_ia       rx_ia;
424         struct rpcrdma_ep       rx_ep;
425         struct rpcrdma_buffer   rx_buf;
426         struct rpcrdma_create_data_internal rx_data;
427         struct delayed_work     rx_connect_worker;
428         struct rpcrdma_stats    rx_stats;
429 };
430
431 #define rpcx_to_rdmax(x) container_of(x, struct rpcrdma_xprt, rx_xprt)
432 #define rpcx_to_rdmad(x) (rpcx_to_rdmax(x)->rx_data)
433
434 /* Setting this to 0 ensures interoperability with early servers.
435  * Setting this to 1 enhances certain unaligned read/write performance.
436  * Default is 0, see sysctl entry and rpc_rdma.c rpcrdma_convert_iovs() */
437 extern int xprt_rdma_pad_optimize;
438
439 /*
440  * Interface Adapter calls - xprtrdma/verbs.c
441  */
442 int rpcrdma_ia_open(struct rpcrdma_xprt *, struct sockaddr *, int);
443 void rpcrdma_ia_close(struct rpcrdma_ia *);
444 bool frwr_is_supported(struct rpcrdma_ia *);
445 bool fmr_is_supported(struct rpcrdma_ia *);
446
447 /*
448  * Endpoint calls - xprtrdma/verbs.c
449  */
450 int rpcrdma_ep_create(struct rpcrdma_ep *, struct rpcrdma_ia *,
451                                 struct rpcrdma_create_data_internal *);
452 void rpcrdma_ep_destroy(struct rpcrdma_ep *, struct rpcrdma_ia *);
453 int rpcrdma_ep_connect(struct rpcrdma_ep *, struct rpcrdma_ia *);
454 void rpcrdma_ep_disconnect(struct rpcrdma_ep *, struct rpcrdma_ia *);
455
456 int rpcrdma_ep_post(struct rpcrdma_ia *, struct rpcrdma_ep *,
457                                 struct rpcrdma_req *);
458 int rpcrdma_ep_post_recv(struct rpcrdma_ia *, struct rpcrdma_ep *,
459                                 struct rpcrdma_rep *);
460
461 /*
462  * Buffer calls - xprtrdma/verbs.c
463  */
464 struct rpcrdma_req *rpcrdma_create_req(struct rpcrdma_xprt *);
465 struct rpcrdma_rep *rpcrdma_create_rep(struct rpcrdma_xprt *);
466 void rpcrdma_destroy_req(struct rpcrdma_ia *, struct rpcrdma_req *);
467 int rpcrdma_buffer_create(struct rpcrdma_xprt *);
468 void rpcrdma_buffer_destroy(struct rpcrdma_buffer *);
469
470 struct rpcrdma_mw *rpcrdma_get_mw(struct rpcrdma_xprt *);
471 void rpcrdma_put_mw(struct rpcrdma_xprt *, struct rpcrdma_mw *);
472 struct rpcrdma_req *rpcrdma_buffer_get(struct rpcrdma_buffer *);
473 void rpcrdma_buffer_put(struct rpcrdma_req *);
474 void rpcrdma_recv_buffer_get(struct rpcrdma_req *);
475 void rpcrdma_recv_buffer_put(struct rpcrdma_rep *);
476
477 void rpcrdma_defer_mr_recovery(struct rpcrdma_mw *);
478
479 struct rpcrdma_regbuf *rpcrdma_alloc_regbuf(struct rpcrdma_ia *,
480                                             size_t, gfp_t);
481 void rpcrdma_free_regbuf(struct rpcrdma_ia *,
482                          struct rpcrdma_regbuf *);
483
484 int rpcrdma_ep_post_extra_recv(struct rpcrdma_xprt *, unsigned int);
485
486 int rpcrdma_alloc_wq(void);
487 void rpcrdma_destroy_wq(void);
488
489 /*
490  * Wrappers for chunk registration, shared by read/write chunk code.
491  */
492
493 static inline enum dma_data_direction
494 rpcrdma_data_dir(bool writing)
495 {
496         return writing ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
497 }
498
499 /*
500  * RPC/RDMA connection management calls - xprtrdma/rpc_rdma.c
501  */
502 void rpcrdma_connect_worker(struct work_struct *);
503 void rpcrdma_conn_func(struct rpcrdma_ep *);
504 void rpcrdma_reply_handler(struct rpcrdma_rep *);
505
506 /*
507  * RPC/RDMA protocol calls - xprtrdma/rpc_rdma.c
508  */
509 int rpcrdma_marshal_req(struct rpc_rqst *);
510 void rpcrdma_set_max_header_sizes(struct rpcrdma_ia *,
511                                   struct rpcrdma_create_data_internal *,
512                                   unsigned int);
513
514 /* RPC/RDMA module init - xprtrdma/transport.c
515  */
516 extern unsigned int xprt_rdma_max_inline_read;
517 void xprt_rdma_format_addresses(struct rpc_xprt *xprt, struct sockaddr *sap);
518 void xprt_rdma_free_addresses(struct rpc_xprt *xprt);
519 void xprt_rdma_print_stats(struct rpc_xprt *xprt, struct seq_file *seq);
520 int xprt_rdma_init(void);
521 void xprt_rdma_cleanup(void);
522
523 /* Backchannel calls - xprtrdma/backchannel.c
524  */
525 #if defined(CONFIG_SUNRPC_BACKCHANNEL)
526 int xprt_rdma_bc_setup(struct rpc_xprt *, unsigned int);
527 int xprt_rdma_bc_up(struct svc_serv *, struct net *);
528 size_t xprt_rdma_bc_maxpayload(struct rpc_xprt *);
529 int rpcrdma_bc_post_recv(struct rpcrdma_xprt *, unsigned int);
530 void rpcrdma_bc_receive_call(struct rpcrdma_xprt *, struct rpcrdma_rep *);
531 int rpcrdma_bc_marshal_reply(struct rpc_rqst *);
532 void xprt_rdma_bc_free_rqst(struct rpc_rqst *);
533 void xprt_rdma_bc_destroy(struct rpc_xprt *, unsigned int);
534 #endif  /* CONFIG_SUNRPC_BACKCHANNEL */
535
536 extern struct xprt_class xprt_rdma_bc;
537
538 #endif                          /* _LINUX_SUNRPC_XPRT_RDMA_H */