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