Commit | Line | Data |
---|---|---|
f58851e6 TT |
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 */ | |
60063497 | 45 | #include <linux/atomic.h> /* atomic_t, etc */ |
254f91e2 | 46 | #include <linux/workqueue.h> /* struct work_struct */ |
f58851e6 TT |
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 */ | |
7e5be288 | 54 | #include <linux/sunrpc/svc.h> /* RPCSVC_MAXPAYLOAD */ |
f58851e6 | 55 | |
5675add3 TT |
56 | #define RDMA_RESOLVE_TIMEOUT (5000) /* 5 seconds */ |
57 | #define RDMA_CONNECT_RETRY_MAX (2) /* retries if no listener backlog */ | |
58 | ||
f58851e6 TT |
59 | /* |
60 | * Interface Adapter -- one per transport instance | |
61 | */ | |
62 | struct rpcrdma_ia { | |
73806c88 | 63 | rwlock_t ri_qplock; |
f58851e6 TT |
64 | struct rdma_cm_id *ri_id; |
65 | struct ib_pd *ri_pd; | |
66 | struct ib_mr *ri_bind_mem; | |
fe9053b3 TT |
67 | u32 ri_dma_lkey; |
68 | int ri_have_dma_lkey; | |
f58851e6 TT |
69 | struct completion ri_done; |
70 | int ri_async_rc; | |
71 | enum rpcrdma_memreg ri_memreg_strategy; | |
0fc6c4e7 | 72 | unsigned int ri_max_frmr_depth; |
7bc7972c | 73 | struct ib_device_attr ri_devattr; |
ce1ab9ab CL |
74 | struct ib_qp_attr ri_qp_attr; |
75 | struct ib_qp_init_attr ri_qp_init_attr; | |
f58851e6 TT |
76 | }; |
77 | ||
78 | /* | |
79 | * RDMA Endpoint -- one per transport instance | |
80 | */ | |
81 | ||
8301a2c0 | 82 | #define RPCRDMA_WC_BUDGET (128) |
1c00dd07 CL |
83 | #define RPCRDMA_POLLSIZE (16) |
84 | ||
f58851e6 TT |
85 | struct rpcrdma_ep { |
86 | atomic_t rep_cqcount; | |
87 | int rep_cqinit; | |
88 | int rep_connected; | |
f58851e6 TT |
89 | struct ib_qp_init_attr rep_attr; |
90 | wait_queue_head_t rep_connect_wait; | |
c05fbb5a | 91 | struct rpcrdma_regbuf *rep_padbuf; |
f58851e6 TT |
92 | struct rdma_conn_param rep_remote_cma; |
93 | struct sockaddr_storage rep_remote_addr; | |
254f91e2 | 94 | struct delayed_work rep_connect_worker; |
1c00dd07 CL |
95 | struct ib_wc rep_send_wcs[RPCRDMA_POLLSIZE]; |
96 | struct ib_wc rep_recv_wcs[RPCRDMA_POLLSIZE]; | |
f58851e6 TT |
97 | }; |
98 | ||
e7104a2a CL |
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 | ||
f58851e6 TT |
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 | ||
9128c3e7 CL |
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 | ||
f58851e6 TT |
146 | /* |
147 | * struct rpcrdma_rep -- this structure encapsulates state required to recv | |
148 | * and complete a reply, asychronously. It needs several pieces of | |
149 | * state: | |
150 | * o recv buffer (posted to provider) | |
151 | * o ib_sge (also donated to provider) | |
152 | * o status of reply (length, success or not) | |
153 | * o bookkeeping state to get run by tasklet (list, etc) | |
154 | * | |
155 | * These are allocated during initialization, per-transport instance; | |
156 | * however, the tasklet execution list itself is global, as it should | |
157 | * always be pretty short. | |
158 | * | |
159 | * N of these are associated with a transport instance, and stored in | |
160 | * struct rpcrdma_buffer. N is the max number of outstanding requests. | |
161 | */ | |
162 | ||
163 | /* temporary static scatter/gather max */ | |
2773395b | 164 | #define RPCRDMA_MAX_DATA_SEGS (64) /* max scatter/gather */ |
f58851e6 | 165 | #define RPCRDMA_MAX_SEGS (RPCRDMA_MAX_DATA_SEGS + 2) /* head+tail = 2 */ |
f58851e6 TT |
166 | |
167 | struct rpcrdma_buffer; | |
168 | ||
169 | struct rpcrdma_rep { | |
6b1184cd CL |
170 | unsigned int rr_len; |
171 | struct rpcrdma_buffer *rr_buffer; | |
172 | struct rpc_xprt *rr_xprt; | |
173 | void (*rr_func)(struct rpcrdma_rep *); | |
174 | struct list_head rr_list; | |
175 | struct rpcrdma_regbuf *rr_rdmabuf; | |
f58851e6 TT |
176 | }; |
177 | ||
0dbb4108 CL |
178 | /* |
179 | * struct rpcrdma_mw - external memory region metadata | |
180 | * | |
181 | * An external memory region is any buffer or page that is registered | |
182 | * on the fly (ie, not pre-registered). | |
183 | * | |
3111d72c | 184 | * Each rpcrdma_buffer has a list of free MWs anchored in rb_mws. During |
0dbb4108 CL |
185 | * call_allocate, rpcrdma_buffer_get() assigns one to each segment in |
186 | * an rpcrdma_req. Then rpcrdma_register_external() grabs these to keep | |
187 | * track of registration metadata while each RPC is pending. | |
188 | * rpcrdma_deregister_external() uses this metadata to unmap and | |
189 | * release these resources when an RPC is complete. | |
190 | */ | |
191 | enum rpcrdma_frmr_state { | |
192 | FRMR_IS_INVALID, /* ready to be used */ | |
193 | FRMR_IS_VALID, /* in use */ | |
9f9d802a | 194 | FRMR_IS_STALE, /* failed completion */ |
0dbb4108 CL |
195 | }; |
196 | ||
197 | struct rpcrdma_frmr { | |
198 | struct ib_fast_reg_page_list *fr_pgl; | |
199 | struct ib_mr *fr_mr; | |
200 | enum rpcrdma_frmr_state fr_state; | |
201 | }; | |
202 | ||
203 | struct rpcrdma_mw { | |
204 | union { | |
205 | struct ib_fmr *fmr; | |
206 | struct rpcrdma_frmr frmr; | |
207 | } r; | |
208 | struct list_head mw_list; | |
3111d72c | 209 | struct list_head mw_all; |
0dbb4108 CL |
210 | }; |
211 | ||
f58851e6 TT |
212 | /* |
213 | * struct rpcrdma_req -- structure central to the request/reply sequence. | |
214 | * | |
215 | * N of these are associated with a transport instance, and stored in | |
216 | * struct rpcrdma_buffer. N is the max number of outstanding requests. | |
217 | * | |
218 | * It includes pre-registered buffer memory for send AND recv. | |
219 | * The recv buffer, however, is not owned by this structure, and | |
220 | * is "donated" to the hardware when a recv is posted. When a | |
221 | * reply is handled, the recv buffer used is given back to the | |
222 | * struct rpcrdma_req associated with the request. | |
223 | * | |
224 | * In addition to the basic memory, this structure includes an array | |
225 | * of iovs for send operations. The reason is that the iovs passed to | |
226 | * ib_post_{send,recv} must not be modified until the work request | |
227 | * completes. | |
228 | * | |
229 | * NOTES: | |
230 | * o RPCRDMA_MAX_SEGS is the max number of addressible chunk elements we | |
231 | * marshal. The number needed varies depending on the iov lists that | |
232 | * are passed to us, the memory registration mode we are in, and if | |
233 | * physical addressing is used, the layout. | |
234 | */ | |
235 | ||
236 | struct rpcrdma_mr_seg { /* chunk descriptors */ | |
3eb35810 | 237 | struct rpcrdma_mw *rl_mw; /* registered MR */ |
f58851e6 TT |
238 | u64 mr_base; /* registration result */ |
239 | u32 mr_rkey; /* registration result */ | |
240 | u32 mr_len; /* length of chunk or segment */ | |
241 | int mr_nsegs; /* number of segments in chunk or 0 */ | |
242 | enum dma_data_direction mr_dir; /* segment mapping direction */ | |
243 | dma_addr_t mr_dma; /* segment mapping address */ | |
244 | size_t mr_dmalen; /* segment mapping length */ | |
245 | struct page *mr_page; /* owning page, if any */ | |
246 | char *mr_offset; /* kva if no page, else offset */ | |
247 | }; | |
248 | ||
249 | struct rpcrdma_req { | |
f58851e6 TT |
250 | unsigned int rl_niovs; /* 0, 2 or 4 */ |
251 | unsigned int rl_nchunks; /* non-zero if chunks */ | |
575448bd | 252 | unsigned int rl_connect_cookie; /* retry detection */ |
f58851e6 TT |
253 | struct rpcrdma_buffer *rl_buffer; /* home base for this structure */ |
254 | struct rpcrdma_rep *rl_reply;/* holder for reply buffer */ | |
f58851e6 | 255 | struct ib_sge rl_send_iov[4]; /* for active requests */ |
85275c87 | 256 | struct rpcrdma_regbuf *rl_rdmabuf; |
0ca77dc3 | 257 | struct rpcrdma_regbuf *rl_sendbuf; |
85275c87 | 258 | struct rpcrdma_mr_seg rl_segments[RPCRDMA_MAX_SEGS]; |
f58851e6 | 259 | }; |
0ca77dc3 CL |
260 | |
261 | static inline struct rpcrdma_req * | |
262 | rpcr_to_rdmar(struct rpc_rqst *rqst) | |
263 | { | |
b625a616 CL |
264 | void *buffer = rqst->rq_buffer; |
265 | struct rpcrdma_regbuf *rb; | |
266 | ||
267 | rb = container_of(buffer, struct rpcrdma_regbuf, rg_base); | |
0ca77dc3 CL |
268 | return rb->rg_owner; |
269 | } | |
f58851e6 TT |
270 | |
271 | /* | |
272 | * struct rpcrdma_buffer -- holds list/queue of pre-registered memory for | |
273 | * inline requests/replies, and client/server credits. | |
274 | * | |
275 | * One of these is associated with a transport instance | |
276 | */ | |
277 | struct rpcrdma_buffer { | |
278 | spinlock_t rb_lock; /* protects indexes */ | |
9b1dcbc8 | 279 | u32 rb_max_requests;/* client max requests */ |
fe9053b3 | 280 | struct list_head rb_mws; /* optional memory windows/fmrs/frmrs */ |
3111d72c | 281 | struct list_head rb_all; |
f58851e6 TT |
282 | int rb_send_index; |
283 | struct rpcrdma_req **rb_send_bufs; | |
284 | int rb_recv_index; | |
285 | struct rpcrdma_rep **rb_recv_bufs; | |
286 | char *rb_pool; | |
287 | }; | |
288 | #define rdmab_to_ia(b) (&container_of((b), struct rpcrdma_xprt, rx_buf)->rx_ia) | |
289 | ||
290 | /* | |
291 | * Internal structure for transport instance creation. This | |
292 | * exists primarily for modularity. | |
293 | * | |
294 | * This data should be set with mount options | |
295 | */ | |
296 | struct rpcrdma_create_data_internal { | |
297 | struct sockaddr_storage addr; /* RDMA server address */ | |
298 | unsigned int max_requests; /* max requests (slots) in flight */ | |
299 | unsigned int rsize; /* mount rsize - max read hdr+data */ | |
300 | unsigned int wsize; /* mount wsize - max write hdr+data */ | |
301 | unsigned int inline_rsize; /* max non-rdma read data payload */ | |
302 | unsigned int inline_wsize; /* max non-rdma write data payload */ | |
303 | unsigned int padding; /* non-rdma write header padding */ | |
304 | }; | |
305 | ||
306 | #define RPCRDMA_INLINE_READ_THRESHOLD(rq) \ | |
a4f0835c | 307 | (rpcx_to_rdmad(rq->rq_xprt).inline_rsize) |
f58851e6 TT |
308 | |
309 | #define RPCRDMA_INLINE_WRITE_THRESHOLD(rq)\ | |
a4f0835c | 310 | (rpcx_to_rdmad(rq->rq_xprt).inline_wsize) |
f58851e6 TT |
311 | |
312 | #define RPCRDMA_INLINE_PAD_VALUE(rq)\ | |
a4f0835c | 313 | rpcx_to_rdmad(rq->rq_xprt).padding |
f58851e6 TT |
314 | |
315 | /* | |
316 | * Statistics for RPCRDMA | |
317 | */ | |
318 | struct rpcrdma_stats { | |
319 | unsigned long read_chunk_count; | |
320 | unsigned long write_chunk_count; | |
321 | unsigned long reply_chunk_count; | |
322 | ||
323 | unsigned long long total_rdma_request; | |
324 | unsigned long long total_rdma_reply; | |
325 | ||
326 | unsigned long long pullup_copy_count; | |
327 | unsigned long long fixup_copy_count; | |
328 | unsigned long hardway_register_count; | |
329 | unsigned long failed_marshal_count; | |
330 | unsigned long bad_reply_count; | |
331 | }; | |
332 | ||
333 | /* | |
334 | * RPCRDMA transport -- encapsulates the structures above for | |
335 | * integration with RPC. | |
336 | * | |
337 | * The contained structures are embedded, not pointers, | |
338 | * for convenience. This structure need not be visible externally. | |
339 | * | |
340 | * It is allocated and initialized during mount, and released | |
341 | * during unmount. | |
342 | */ | |
343 | struct rpcrdma_xprt { | |
5abefb86 | 344 | struct rpc_xprt rx_xprt; |
f58851e6 TT |
345 | struct rpcrdma_ia rx_ia; |
346 | struct rpcrdma_ep rx_ep; | |
347 | struct rpcrdma_buffer rx_buf; | |
348 | struct rpcrdma_create_data_internal rx_data; | |
5abefb86 | 349 | struct delayed_work rx_connect_worker; |
f58851e6 TT |
350 | struct rpcrdma_stats rx_stats; |
351 | }; | |
352 | ||
5abefb86 | 353 | #define rpcx_to_rdmax(x) container_of(x, struct rpcrdma_xprt, rx_xprt) |
f58851e6 TT |
354 | #define rpcx_to_rdmad(x) (rpcx_to_rdmax(x)->rx_data) |
355 | ||
9191ca3b TT |
356 | /* Setting this to 0 ensures interoperability with early servers. |
357 | * Setting this to 1 enhances certain unaligned read/write performance. | |
358 | * Default is 0, see sysctl entry and rpc_rdma.c rpcrdma_convert_iovs() */ | |
359 | extern int xprt_rdma_pad_optimize; | |
360 | ||
f58851e6 TT |
361 | /* |
362 | * Interface Adapter calls - xprtrdma/verbs.c | |
363 | */ | |
364 | int rpcrdma_ia_open(struct rpcrdma_xprt *, struct sockaddr *, int); | |
365 | void rpcrdma_ia_close(struct rpcrdma_ia *); | |
366 | ||
367 | /* | |
368 | * Endpoint calls - xprtrdma/verbs.c | |
369 | */ | |
370 | int rpcrdma_ep_create(struct rpcrdma_ep *, struct rpcrdma_ia *, | |
371 | struct rpcrdma_create_data_internal *); | |
7f1d5419 | 372 | void rpcrdma_ep_destroy(struct rpcrdma_ep *, struct rpcrdma_ia *); |
f58851e6 | 373 | int rpcrdma_ep_connect(struct rpcrdma_ep *, struct rpcrdma_ia *); |
282191cb | 374 | void rpcrdma_ep_disconnect(struct rpcrdma_ep *, struct rpcrdma_ia *); |
f58851e6 TT |
375 | |
376 | int rpcrdma_ep_post(struct rpcrdma_ia *, struct rpcrdma_ep *, | |
377 | struct rpcrdma_req *); | |
378 | int rpcrdma_ep_post_recv(struct rpcrdma_ia *, struct rpcrdma_ep *, | |
379 | struct rpcrdma_rep *); | |
380 | ||
381 | /* | |
382 | * Buffer calls - xprtrdma/verbs.c | |
383 | */ | |
ac920d04 | 384 | int rpcrdma_buffer_create(struct rpcrdma_xprt *); |
f58851e6 TT |
385 | void rpcrdma_buffer_destroy(struct rpcrdma_buffer *); |
386 | ||
387 | struct rpcrdma_req *rpcrdma_buffer_get(struct rpcrdma_buffer *); | |
388 | void rpcrdma_buffer_put(struct rpcrdma_req *); | |
389 | void rpcrdma_recv_buffer_get(struct rpcrdma_req *); | |
390 | void rpcrdma_recv_buffer_put(struct rpcrdma_rep *); | |
391 | ||
f58851e6 TT |
392 | int rpcrdma_register_external(struct rpcrdma_mr_seg *, |
393 | int, int, struct rpcrdma_xprt *); | |
394 | int rpcrdma_deregister_external(struct rpcrdma_mr_seg *, | |
13c9ff8f | 395 | struct rpcrdma_xprt *); |
f58851e6 | 396 | |
9128c3e7 CL |
397 | struct rpcrdma_regbuf *rpcrdma_alloc_regbuf(struct rpcrdma_ia *, |
398 | size_t, gfp_t); | |
399 | void rpcrdma_free_regbuf(struct rpcrdma_ia *, | |
400 | struct rpcrdma_regbuf *); | |
401 | ||
f58851e6 TT |
402 | /* |
403 | * RPC/RDMA connection management calls - xprtrdma/rpc_rdma.c | |
404 | */ | |
254f91e2 | 405 | void rpcrdma_connect_worker(struct work_struct *); |
f58851e6 TT |
406 | void rpcrdma_conn_func(struct rpcrdma_ep *); |
407 | void rpcrdma_reply_handler(struct rpcrdma_rep *); | |
408 | ||
409 | /* | |
410 | * RPC/RDMA protocol calls - xprtrdma/rpc_rdma.c | |
411 | */ | |
412 | int rpcrdma_marshal_req(struct rpc_rqst *); | |
43e95988 | 413 | size_t rpcrdma_max_payload(struct rpcrdma_xprt *); |
f58851e6 | 414 | |
cec56c8f TT |
415 | /* Temporary NFS request map cache. Created in svc_rdma.c */ |
416 | extern struct kmem_cache *svc_rdma_map_cachep; | |
417 | /* WR context cache. Created in svc_rdma.c */ | |
418 | extern struct kmem_cache *svc_rdma_ctxt_cachep; | |
419 | /* Workqueue created in svc_rdma.c */ | |
420 | extern struct workqueue_struct *svc_rdma_wq; | |
421 | ||
7e5be288 SW |
422 | #if RPCSVC_MAXPAYLOAD < (RPCRDMA_MAX_DATA_SEGS << PAGE_SHIFT) |
423 | #define RPCSVC_MAXPAYLOAD_RDMA RPCSVC_MAXPAYLOAD | |
424 | #else | |
425 | #define RPCSVC_MAXPAYLOAD_RDMA (RPCRDMA_MAX_DATA_SEGS << PAGE_SHIFT) | |
426 | #endif | |
427 | ||
f58851e6 | 428 | #endif /* _LINUX_SUNRPC_XPRT_RDMA_H */ |