blob: e787dda3b0f5657552e7e2ad9670b6440df714d6 [file] [log] [blame]
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -04001/*
Chuck Lever62b56a62017-10-30 16:22:14 -04002 * Copyright (c) 2014-2017 Oracle. All rights reserved.
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -04003 * Copyright (c) 2003-2007 Network Appliance, Inc. All rights reserved.
4 *
5 * This software is available to you under a choice of one of two
6 * licenses. You may choose to be licensed under the terms of the GNU
7 * General Public License (GPL) Version 2, available from the file
8 * COPYING in the main directory of this source tree, or the BSD-type
9 * license below:
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 *
15 * Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 *
18 * Redistributions in binary form must reproduce the above
19 * copyright notice, this list of conditions and the following
20 * disclaimer in the documentation and/or other materials provided
21 * with the distribution.
22 *
23 * Neither the name of the Network Appliance, Inc. nor the names of
24 * its contributors may be used to endorse or promote products
25 * derived from this software without specific prior written
26 * permission.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 */
40
41#ifndef _LINUX_SUNRPC_XPRT_RDMA_H
42#define _LINUX_SUNRPC_XPRT_RDMA_H
43
44#include <linux/wait.h> /* wait_queue_head_t, etc */
45#include <linux/spinlock.h> /* spinlock_t, etc */
Arun Sharma600634972011-07-26 16:09:06 -070046#include <linux/atomic.h> /* atomic_t, etc */
Chuck Lever254f91e2014-05-28 10:32:17 -040047#include <linux/workqueue.h> /* struct work_struct */
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -040048
49#include <rdma/rdma_cm.h> /* RDMA connection api */
50#include <rdma/ib_verbs.h> /* RDMA verbs api */
51
52#include <linux/sunrpc/clnt.h> /* rpc_xprt */
53#include <linux/sunrpc/rpc_rdma.h> /* RPC/RDMA protocol */
54#include <linux/sunrpc/xprtrdma.h> /* xprt parameters */
55
Tom Talpey5675add2008-10-09 15:01:41 -040056#define RDMA_RESOLVE_TIMEOUT (5000) /* 5 seconds */
57#define RDMA_CONNECT_RETRY_MAX (2) /* retries if no listener backlog */
58
Chuck Lever5d252f92016-01-07 14:50:10 -050059#define RPCRDMA_BIND_TO (60U * HZ)
60#define RPCRDMA_INIT_REEST_TO (5U * HZ)
61#define RPCRDMA_MAX_REEST_TO (30U * HZ)
62#define RPCRDMA_IDLE_DISC_TO (5U * 60 * HZ)
63
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -040064/*
65 * Interface Adapter -- one per transport instance
66 */
67struct rpcrdma_ia {
Chuck Levera0ce85f2015-03-30 14:34:21 -040068 const struct rpcrdma_memreg_ops *ri_ops;
Chuck Lever89e0d1122015-05-26 11:51:56 -040069 struct ib_device *ri_device;
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -040070 struct rdma_cm_id *ri_id;
71 struct ib_pd *ri_pd;
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -040072 struct completion ri_done;
Chuck Leverbebd0312017-04-11 13:23:10 -040073 struct completion ri_remove_done;
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -040074 int ri_async_rc;
Chuck Lever87cfb9a2016-09-15 10:57:07 -040075 unsigned int ri_max_segs;
Steve Wise0fc6c4e2014-05-28 10:32:00 -040076 unsigned int ri_max_frmr_depth;
Chuck Lever302d3de2016-05-02 14:41:05 -040077 unsigned int ri_max_inline_write;
78 unsigned int ri_max_inline_read;
Chuck Lever16f906d2017-02-08 17:00:10 -050079 unsigned int ri_max_send_sges;
Chuck Leverc8b920b2016-09-15 10:57:16 -040080 bool ri_reminv_expected;
Chuck Leverb5f0afb2017-02-08 16:59:54 -050081 bool ri_implicit_roundup;
Chuck Lever5e9fc6a2016-11-29 10:52:24 -050082 enum ib_mr_type ri_mrtype;
Chuck Leverbebd0312017-04-11 13:23:10 -040083 unsigned long ri_flags;
Chuck Leverce1ab9a2015-01-21 11:03:35 -050084 struct ib_qp_attr ri_qp_attr;
85 struct ib_qp_init_attr ri_qp_init_attr;
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -040086};
87
Chuck Leverbebd0312017-04-11 13:23:10 -040088enum {
89 RPCRDMA_IAF_REMOVING = 0,
90};
91
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -040092/*
93 * RDMA Endpoint -- one per transport instance
94 */
95
96struct rpcrdma_ep {
Chuck Leverae729502017-10-20 10:48:12 -040097 unsigned int rep_send_count;
98 unsigned int rep_send_batch;
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -040099 int rep_connected;
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400100 struct ib_qp_init_attr rep_attr;
101 wait_queue_head_t rep_connect_wait;
Chuck Lever87cfb9a2016-09-15 10:57:07 -0400102 struct rpcrdma_connect_private rep_cm_private;
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400103 struct rdma_conn_param rep_remote_cma;
104 struct sockaddr_storage rep_remote_addr;
Chuck Lever254f91e2014-05-28 10:32:17 -0400105 struct delayed_work rep_connect_worker;
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400106};
107
Chuck Lever124fa172015-10-24 17:27:51 -0400108/* Pre-allocate extra Work Requests for handling backward receives
109 * and sends. This is a fixed value because the Work Queues are
110 * allocated when the forward channel is set up.
111 */
112#if defined(CONFIG_SUNRPC_BACKCHANNEL)
113#define RPCRDMA_BACKWARD_WRS (8)
114#else
115#define RPCRDMA_BACKWARD_WRS (0)
116#endif
117
Chuck Lever9128c3e2015-01-21 11:04:00 -0500118/* Registered buffer -- registered kmalloc'd memory for RDMA SEND/RECV
119 *
120 * The below structure appears at the front of a large region of kmalloc'd
121 * memory, which always starts on a good alignment boundary.
122 */
123
124struct rpcrdma_regbuf {
Chuck Lever9128c3e2015-01-21 11:04:00 -0500125 struct ib_sge rg_iov;
Chuck Lever54cbd6b2016-09-15 10:56:18 -0400126 struct ib_device *rg_device;
Chuck Lever99ef4db2016-09-15 10:56:10 -0400127 enum dma_data_direction rg_direction;
Chuck Lever9128c3e2015-01-21 11:04:00 -0500128 __be32 rg_base[0] __attribute__ ((aligned(256)));
129};
130
131static inline u64
132rdmab_addr(struct rpcrdma_regbuf *rb)
133{
134 return rb->rg_iov.addr;
135}
136
137static inline u32
138rdmab_length(struct rpcrdma_regbuf *rb)
139{
140 return rb->rg_iov.length;
141}
142
143static inline u32
144rdmab_lkey(struct rpcrdma_regbuf *rb)
145{
146 return rb->rg_iov.lkey;
147}
148
Chuck Lever91a10c52017-04-11 13:23:02 -0400149static inline struct ib_device *
150rdmab_device(struct rpcrdma_regbuf *rb)
151{
152 return rb->rg_device;
153}
154
Chuck Lever5d252f92016-01-07 14:50:10 -0500155#define RPCRDMA_DEF_GFP (GFP_NOIO | __GFP_NOWARN)
156
Chuck Lever94931742016-05-02 14:40:56 -0400157/* To ensure a transport can always make forward progress,
158 * the number of RDMA segments allowed in header chunk lists
159 * is capped at 8. This prevents less-capable devices and
160 * memory registrations from overrunning the Send buffer
161 * while building chunk lists.
162 *
163 * Elements of the Read list take up more room than the
164 * Write list or Reply chunk. 8 read segments means the Read
165 * list (or Write list or Reply chunk) cannot consume more
166 * than
167 *
168 * ((8 + 2) * read segment size) + 1 XDR words, or 244 bytes.
169 *
170 * And the fixed part of the header is another 24 bytes.
171 *
172 * The smallest inline threshold is 1024 bytes, ensuring that
173 * at least 750 bytes are available for RPC messages.
174 */
Chuck Lever08cf2ef2016-09-15 10:56:02 -0400175enum {
176 RPCRDMA_MAX_HDR_SEGS = 8,
177 RPCRDMA_HDRBUF_SIZE = 256,
178};
Chuck Lever94931742016-05-02 14:40:56 -0400179
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400180/*
Chuck Levere1352c92017-10-16 15:01:22 -0400181 * struct rpcrdma_rep -- this structure encapsulates state required
182 * to receive and complete an RPC Reply, asychronously. It needs
183 * several pieces of state:
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400184 *
Chuck Levere1352c92017-10-16 15:01:22 -0400185 * o receive buffer and ib_sge (donated to provider)
186 * o status of receive (success or not, length, inv rkey)
187 * o bookkeeping state to get run by reply handler (XDR stream)
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400188 *
Chuck Levere1352c92017-10-16 15:01:22 -0400189 * These structures are allocated during transport initialization.
190 * N of these are associated with a transport instance, managed by
191 * struct rpcrdma_buffer. N is the max number of outstanding RPCs.
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400192 */
193
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400194struct rpcrdma_rep {
Chuck Lever552bf222016-03-04 11:28:36 -0500195 struct ib_cqe rr_cqe;
Chuck Lever5381e0e2017-10-16 15:01:14 -0400196 __be32 rr_xid;
197 __be32 rr_vers;
198 __be32 rr_proc;
Chuck Leverc8b920b2016-09-15 10:57:16 -0400199 int rr_wc_flags;
200 u32 rr_inv_rkey;
Chuck Leverc1bcb682017-08-03 14:30:52 -0400201 struct rpcrdma_regbuf *rr_rdmabuf;
Chuck Leverfed171b2015-05-26 11:51:37 -0400202 struct rpcrdma_xprt *rr_rxprt;
Chuck Leverfe97b472015-10-24 17:27:10 -0400203 struct work_struct rr_work;
Chuck Lever96f87782017-08-03 14:30:03 -0400204 struct xdr_buf rr_hdrbuf;
205 struct xdr_stream rr_stream;
Chuck Levere1352c92017-10-16 15:01:22 -0400206 struct rpc_rqst *rr_rqst;
Chuck Lever6b1184c2015-01-21 11:04:25 -0500207 struct list_head rr_list;
Chuck Lever6ea8e712016-09-15 10:56:51 -0400208 struct ib_recv_wr rr_recv_wr;
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400209};
210
Chuck Leverae729502017-10-20 10:48:12 -0400211/* struct rpcrdma_sendctx - DMA mapped SGEs to unmap after Send completes
212 */
Chuck Lever01bb35c2017-10-20 10:48:36 -0400213struct rpcrdma_req;
Chuck Leverae729502017-10-20 10:48:12 -0400214struct rpcrdma_xprt;
215struct rpcrdma_sendctx {
216 struct ib_send_wr sc_wr;
217 struct ib_cqe sc_cqe;
218 struct rpcrdma_xprt *sc_xprt;
Chuck Lever01bb35c2017-10-20 10:48:36 -0400219 struct rpcrdma_req *sc_req;
Chuck Leverae729502017-10-20 10:48:12 -0400220 unsigned int sc_unmap_count;
221 struct ib_sge sc_sges[];
222};
223
224/* Limit the number of SGEs that can be unmapped during one
225 * Send completion. This caps the amount of work a single
226 * completion can do before returning to the provider.
227 *
228 * Setting this to zero disables Send completion batching.
229 */
230enum {
231 RPCRDMA_MAX_SEND_BATCH = 7,
232};
233
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400234/*
Chuck Lever0dbb4102014-07-29 17:24:09 -0400235 * struct rpcrdma_mw - external memory region metadata
236 *
237 * An external memory region is any buffer or page that is registered
238 * on the fly (ie, not pre-registered).
239 *
Chuck Lever3111d722014-07-29 17:24:28 -0400240 * Each rpcrdma_buffer has a list of free MWs anchored in rb_mws. During
Chuck Lever0dbb4102014-07-29 17:24:09 -0400241 * call_allocate, rpcrdma_buffer_get() assigns one to each segment in
242 * an rpcrdma_req. Then rpcrdma_register_external() grabs these to keep
243 * track of registration metadata while each RPC is pending.
244 * rpcrdma_deregister_external() uses this metadata to unmap and
245 * release these resources when an RPC is complete.
246 */
247enum rpcrdma_frmr_state {
248 FRMR_IS_INVALID, /* ready to be used */
249 FRMR_IS_VALID, /* in use */
Chuck Lever62bdf942016-11-07 16:16:24 -0500250 FRMR_FLUSHED_FR, /* flushed FASTREG WR */
251 FRMR_FLUSHED_LI, /* flushed LOCALINV WR */
Chuck Lever0dbb4102014-07-29 17:24:09 -0400252};
253
254struct rpcrdma_frmr {
Chuck Lever0dbb4102014-07-29 17:24:09 -0400255 struct ib_mr *fr_mr;
Chuck Lever2fa8f882016-03-04 11:28:53 -0500256 struct ib_cqe fr_cqe;
Chuck Lever0dbb4102014-07-29 17:24:09 -0400257 enum rpcrdma_frmr_state fr_state;
Chuck Lever2fa8f882016-03-04 11:28:53 -0500258 struct completion fr_linv_done;
Chuck Lever3cf4e162015-12-16 17:22:31 -0500259 union {
260 struct ib_reg_wr fr_regwr;
261 struct ib_send_wr fr_invwr;
262 };
Chuck Lever0dbb4102014-07-29 17:24:09 -0400263};
264
Chuck Leveracb9da72015-05-26 11:53:23 -0400265struct rpcrdma_fmr {
Chuck Lever88975eb2016-06-29 13:52:37 -0400266 struct ib_fmr *fm_mr;
267 u64 *fm_physaddrs;
Chuck Lever0dbb4102014-07-29 17:24:09 -0400268};
269
270struct rpcrdma_mw {
Chuck Lever564471d2016-06-29 13:52:21 -0400271 struct list_head mw_list;
272 struct scatterlist *mw_sg;
273 int mw_nents;
274 enum dma_data_direction mw_dir;
Chuck Lever0dbb4102014-07-29 17:24:09 -0400275 union {
Chuck Leveracb9da72015-05-26 11:53:23 -0400276 struct rpcrdma_fmr fmr;
Chuck Lever0dbb4102014-07-29 17:24:09 -0400277 struct rpcrdma_frmr frmr;
Chuck Leverc882a652016-03-04 11:28:45 -0500278 };
Chuck Lever766656b2016-05-02 14:42:29 -0400279 struct rpcrdma_xprt *mw_xprt;
Chuck Lever9d6b0402016-06-29 13:54:16 -0400280 u32 mw_handle;
281 u32 mw_length;
282 u64 mw_offset;
Chuck Lever3111d722014-07-29 17:24:28 -0400283 struct list_head mw_all;
Chuck Lever0dbb4102014-07-29 17:24:09 -0400284};
285
286/*
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400287 * struct rpcrdma_req -- structure central to the request/reply sequence.
288 *
289 * N of these are associated with a transport instance, and stored in
290 * struct rpcrdma_buffer. N is the max number of outstanding requests.
291 *
292 * It includes pre-registered buffer memory for send AND recv.
293 * The recv buffer, however, is not owned by this structure, and
294 * is "donated" to the hardware when a recv is posted. When a
295 * reply is handled, the recv buffer used is given back to the
296 * struct rpcrdma_req associated with the request.
297 *
298 * In addition to the basic memory, this structure includes an array
299 * of iovs for send operations. The reason is that the iovs passed to
300 * ib_post_{send,recv} must not be modified until the work request
301 * completes.
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400302 */
303
Chuck Lever5ab81422016-06-29 13:54:25 -0400304/* Maximum number of page-sized "segments" per chunk list to be
305 * registered or invalidated. Must handle a Reply chunk:
306 */
307enum {
308 RPCRDMA_MAX_IOV_SEGS = 3,
309 RPCRDMA_MAX_DATA_SEGS = ((1 * 1024 * 1024) / PAGE_SIZE) + 1,
310 RPCRDMA_MAX_SEGS = RPCRDMA_MAX_DATA_SEGS +
311 RPCRDMA_MAX_IOV_SEGS,
312};
313
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400314struct rpcrdma_mr_seg { /* chunk descriptors */
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400315 u32 mr_len; /* length of chunk or segment */
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400316 struct page *mr_page; /* owning page, if any */
317 char *mr_offset; /* kva if no page, else offset */
318};
319
Chuck Leverc6f5b472017-02-08 17:00:18 -0500320/* The Send SGE array is provisioned to send a maximum size
321 * inline request:
Chuck Lever655fec62016-09-15 10:57:24 -0400322 * - RPC-over-RDMA header
323 * - xdr_buf head iovec
Chuck Leverc6f5b472017-02-08 17:00:18 -0500324 * - RPCRDMA_MAX_INLINE bytes, in pages
Chuck Lever655fec62016-09-15 10:57:24 -0400325 * - xdr_buf tail iovec
Chuck Leverc6f5b472017-02-08 17:00:18 -0500326 *
327 * The actual number of array elements consumed by each RPC
328 * depends on the device's max_sge limit.
Chuck Lever655fec62016-09-15 10:57:24 -0400329 */
330enum {
Chuck Lever16f906d2017-02-08 17:00:10 -0500331 RPCRDMA_MIN_SEND_SGES = 3,
Chuck Leverc6f5b472017-02-08 17:00:18 -0500332 RPCRDMA_MAX_PAGE_SGES = RPCRDMA_MAX_INLINE >> PAGE_SHIFT,
Chuck Lever655fec62016-09-15 10:57:24 -0400333 RPCRDMA_MAX_SEND_SGES = 1 + 1 + RPCRDMA_MAX_PAGE_SGES + 1,
334};
Chuck Leverb3221d62015-08-03 13:03:39 -0400335
Chuck Lever5ab81422016-06-29 13:54:25 -0400336struct rpcrdma_buffer;
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400337struct rpcrdma_req {
Chuck Levera80d66c2017-06-08 11:52:12 -0400338 struct list_head rl_list;
Chuck Leverccede752017-12-04 14:04:04 -0500339 int rl_cpu;
Chuck Leverb3221d62015-08-03 13:03:39 -0400340 unsigned int rl_connect_cookie;
341 struct rpcrdma_buffer *rl_buffer;
Chuck Lever90aab602016-09-15 10:56:43 -0400342 struct rpcrdma_rep *rl_reply;
Chuck Lever7a80f3f2017-08-10 12:47:28 -0400343 struct xdr_stream rl_stream;
344 struct xdr_buf rl_hdrbuf;
Chuck Leverae729502017-10-20 10:48:12 -0400345 struct rpcrdma_sendctx *rl_sendctx;
Chuck Lever9c40c492016-09-15 10:55:53 -0400346 struct rpcrdma_regbuf *rl_rdmabuf; /* xprt header */
347 struct rpcrdma_regbuf *rl_sendbuf; /* rq_snd_buf */
348 struct rpcrdma_regbuf *rl_recvbuf; /* rq_rcv_buf */
Chuck Leverf531a5d2015-10-24 17:27:43 -0400349
350 struct list_head rl_all;
Chuck Lever531cca02017-10-20 10:48:20 -0400351 unsigned long rl_flags;
Chuck Lever5ab81422016-06-29 13:54:25 -0400352
353 struct list_head rl_registered; /* registered segments */
354 struct rpcrdma_mr_seg rl_segments[RPCRDMA_MAX_SEGS];
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400355};
Chuck Lever0ca77dc2015-01-21 11:04:08 -0500356
Chuck Lever531cca02017-10-20 10:48:20 -0400357/* rl_flags */
358enum {
359 RPCRDMA_REQ_F_BACKCHANNEL = 0,
Chuck Lever0ba6f372017-10-20 10:48:28 -0400360 RPCRDMA_REQ_F_PENDING,
Chuck Lever01bb35c2017-10-20 10:48:36 -0400361 RPCRDMA_REQ_F_TX_RESOURCES,
Chuck Lever531cca02017-10-20 10:48:20 -0400362};
363
Chuck Lever5a6d1db2016-09-15 10:55:45 -0400364static inline void
365rpcrdma_set_xprtdata(struct rpc_rqst *rqst, struct rpcrdma_req *req)
366{
367 rqst->rq_xprtdata = req;
368}
369
Chuck Lever0ca77dc2015-01-21 11:04:08 -0500370static inline struct rpcrdma_req *
371rpcr_to_rdmar(struct rpc_rqst *rqst)
372{
Chuck Lever5a6d1db2016-09-15 10:55:45 -0400373 return rqst->rq_xprtdata;
Chuck Lever0ca77dc2015-01-21 11:04:08 -0500374}
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400375
Chuck Lever9a5c63e2017-02-08 17:00:43 -0500376static inline void
377rpcrdma_push_mw(struct rpcrdma_mw *mw, struct list_head *list)
378{
379 list_add_tail(&mw->mw_list, list);
380}
381
382static inline struct rpcrdma_mw *
383rpcrdma_pop_mw(struct list_head *list)
384{
385 struct rpcrdma_mw *mw;
386
387 mw = list_first_entry(list, struct rpcrdma_mw, mw_list);
388 list_del(&mw->mw_list);
389 return mw;
390}
391
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400392/*
393 * struct rpcrdma_buffer -- holds list/queue of pre-registered memory for
394 * inline requests/replies, and client/server credits.
395 *
396 * One of these is associated with a transport instance
397 */
398struct rpcrdma_buffer {
Chuck Lever58d1dcf2015-05-26 11:53:13 -0400399 spinlock_t rb_mwlock; /* protect rb_mws list */
400 struct list_head rb_mws;
401 struct list_head rb_all;
Chuck Lever58d1dcf2015-05-26 11:53:13 -0400402
Chuck Leverae729502017-10-20 10:48:12 -0400403 unsigned long rb_sc_head;
404 unsigned long rb_sc_tail;
405 unsigned long rb_sc_last;
406 struct rpcrdma_sendctx **rb_sc_ctxs;
407
Chuck Lever1e465fd2015-10-24 17:27:02 -0400408 spinlock_t rb_lock; /* protect buf lists */
Chuck Lever05c97462016-09-06 11:22:58 -0400409 int rb_send_count, rb_recv_count;
Chuck Lever1e465fd2015-10-24 17:27:02 -0400410 struct list_head rb_send_bufs;
411 struct list_head rb_recv_bufs;
Chuck Lever58d1dcf2015-05-26 11:53:13 -0400412 u32 rb_max_requests;
Chuck Leverbe798f92017-10-16 15:01:39 -0400413 u32 rb_credits; /* most recent credit grant */
Chuck Leverf531a5d2015-10-24 17:27:43 -0400414
415 u32 rb_bc_srv_max_requests;
416 spinlock_t rb_reqslock; /* protect rb_allreqs */
417 struct list_head rb_allreqs;
Chuck Lever5d252f92016-01-07 14:50:10 -0500418
419 u32 rb_bc_max_requests;
Chuck Lever505bbe62016-06-29 13:52:54 -0400420
421 spinlock_t rb_recovery_lock; /* protect rb_stale_mrs */
422 struct list_head rb_stale_mrs;
423 struct delayed_work rb_recovery_worker;
Chuck Levere2ac2362016-06-29 13:54:00 -0400424 struct delayed_work rb_refresh_worker;
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400425};
426#define rdmab_to_ia(b) (&container_of((b), struct rpcrdma_xprt, rx_buf)->rx_ia)
427
428/*
429 * Internal structure for transport instance creation. This
430 * exists primarily for modularity.
431 *
432 * This data should be set with mount options
433 */
434struct rpcrdma_create_data_internal {
435 struct sockaddr_storage addr; /* RDMA server address */
436 unsigned int max_requests; /* max requests (slots) in flight */
437 unsigned int rsize; /* mount rsize - max read hdr+data */
438 unsigned int wsize; /* mount wsize - max write hdr+data */
439 unsigned int inline_rsize; /* max non-rdma read data payload */
440 unsigned int inline_wsize; /* max non-rdma write data payload */
441 unsigned int padding; /* non-rdma write header padding */
442};
443
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400444/*
445 * Statistics for RPCRDMA
446 */
447struct rpcrdma_stats {
Chuck Lever67af6f62017-08-22 11:19:35 -0400448 /* accessed when sending a call */
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400449 unsigned long read_chunk_count;
450 unsigned long write_chunk_count;
451 unsigned long reply_chunk_count;
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400452 unsigned long long total_rdma_request;
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400453
Chuck Lever67af6f62017-08-22 11:19:35 -0400454 /* rarely accessed error counters */
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400455 unsigned long long pullup_copy_count;
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400456 unsigned long hardway_register_count;
457 unsigned long failed_marshal_count;
458 unsigned long bad_reply_count;
Chuck Lever505bbe62016-06-29 13:52:54 -0400459 unsigned long mrs_recovered;
460 unsigned long mrs_orphaned;
Chuck Levere2ac2362016-06-29 13:54:00 -0400461 unsigned long mrs_allocated;
Chuck Leverae729502017-10-20 10:48:12 -0400462 unsigned long empty_sendctx_q;
Chuck Lever67af6f62017-08-22 11:19:35 -0400463
464 /* accessed when receiving a reply */
465 unsigned long long total_rdma_reply;
466 unsigned long long fixup_copy_count;
Chuck Lever01bb35c2017-10-20 10:48:36 -0400467 unsigned long reply_waits_for_send;
Chuck Leverc8b920b2016-09-15 10:57:16 -0400468 unsigned long local_inv_needed;
Chuck Lever67af6f62017-08-22 11:19:35 -0400469 unsigned long nomsg_call_count;
470 unsigned long bcall_count;
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400471};
472
473/*
Chuck Levera0ce85f2015-03-30 14:34:21 -0400474 * Per-registration mode operations
475 */
Chuck Lever1c9351e2015-03-30 14:34:30 -0400476struct rpcrdma_xprt;
Chuck Levera0ce85f2015-03-30 14:34:21 -0400477struct rpcrdma_memreg_ops {
Chuck Lever6748b0c2017-08-14 15:38:30 -0400478 struct rpcrdma_mr_seg *
479 (*ro_map)(struct rpcrdma_xprt *,
Chuck Lever9d6b0402016-06-29 13:54:16 -0400480 struct rpcrdma_mr_seg *, int, bool,
481 struct rpcrdma_mw **);
Chuck Leverc3441612017-12-14 20:56:26 -0500482 void (*ro_reminv)(struct rpcrdma_rep *rep,
483 struct list_head *mws);
Chuck Lever32d0cee2015-12-16 17:22:39 -0500484 void (*ro_unmap_sync)(struct rpcrdma_xprt *,
Chuck Lever451d26e2017-06-08 11:52:04 -0400485 struct list_head *);
Chuck Lever505bbe62016-06-29 13:52:54 -0400486 void (*ro_recover_mr)(struct rpcrdma_mw *);
Chuck Lever3968cb52015-03-30 14:35:26 -0400487 int (*ro_open)(struct rpcrdma_ia *,
488 struct rpcrdma_ep *,
489 struct rpcrdma_create_data_internal *);
Chuck Lever1c9351e2015-03-30 14:34:30 -0400490 size_t (*ro_maxpages)(struct rpcrdma_xprt *);
Chuck Levere2ac2362016-06-29 13:54:00 -0400491 int (*ro_init_mr)(struct rpcrdma_ia *,
492 struct rpcrdma_mw *);
493 void (*ro_release_mr)(struct rpcrdma_mw *);
Chuck Levera0ce85f2015-03-30 14:34:21 -0400494 const char *ro_displayname;
Chuck Leverc8b920b2016-09-15 10:57:16 -0400495 const int ro_send_w_inv_ok;
Chuck Levera0ce85f2015-03-30 14:34:21 -0400496};
497
498extern const struct rpcrdma_memreg_ops rpcrdma_fmr_memreg_ops;
499extern const struct rpcrdma_memreg_ops rpcrdma_frwr_memreg_ops;
Chuck Levera0ce85f2015-03-30 14:34:21 -0400500
501/*
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400502 * RPCRDMA transport -- encapsulates the structures above for
503 * integration with RPC.
504 *
505 * The contained structures are embedded, not pointers,
506 * for convenience. This structure need not be visible externally.
507 *
508 * It is allocated and initialized during mount, and released
509 * during unmount.
510 */
511struct rpcrdma_xprt {
Chuck Lever5abefb82015-01-21 11:02:37 -0500512 struct rpc_xprt rx_xprt;
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400513 struct rpcrdma_ia rx_ia;
514 struct rpcrdma_ep rx_ep;
515 struct rpcrdma_buffer rx_buf;
516 struct rpcrdma_create_data_internal rx_data;
Chuck Lever5abefb82015-01-21 11:02:37 -0500517 struct delayed_work rx_connect_worker;
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400518 struct rpcrdma_stats rx_stats;
519};
520
Chuck Lever5abefb82015-01-21 11:02:37 -0500521#define rpcx_to_rdmax(x) container_of(x, struct rpcrdma_xprt, rx_xprt)
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400522#define rpcx_to_rdmad(x) (rpcx_to_rdmax(x)->rx_data)
523
Tom Talpey9191ca32008-10-09 15:01:11 -0400524/* Setting this to 0 ensures interoperability with early servers.
525 * Setting this to 1 enhances certain unaligned read/write performance.
526 * Default is 0, see sysctl entry and rpc_rdma.c rpcrdma_convert_iovs() */
527extern int xprt_rdma_pad_optimize;
528
Chuck Leverfff09592017-04-11 13:22:54 -0400529/* This setting controls the hunt for a supported memory
530 * registration strategy.
531 */
532extern unsigned int xprt_rdma_memreg_strategy;
533
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400534/*
535 * Interface Adapter calls - xprtrdma/verbs.c
536 */
Chuck Leverfff09592017-04-11 13:22:54 -0400537int rpcrdma_ia_open(struct rpcrdma_xprt *xprt, struct sockaddr *addr);
Chuck Leverbebd0312017-04-11 13:23:10 -0400538void rpcrdma_ia_remove(struct rpcrdma_ia *ia);
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400539void rpcrdma_ia_close(struct rpcrdma_ia *);
Chuck Leverb54054c2016-06-29 13:53:27 -0400540bool frwr_is_supported(struct rpcrdma_ia *);
541bool fmr_is_supported(struct rpcrdma_ia *);
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400542
Chuck Leverd8f532d2017-10-16 15:01:30 -0400543extern struct workqueue_struct *rpcrdma_receive_wq;
544
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400545/*
546 * Endpoint calls - xprtrdma/verbs.c
547 */
548int rpcrdma_ep_create(struct rpcrdma_ep *, struct rpcrdma_ia *,
549 struct rpcrdma_create_data_internal *);
Chuck Lever7f1d5412014-05-28 10:33:16 -0400550void rpcrdma_ep_destroy(struct rpcrdma_ep *, struct rpcrdma_ia *);
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400551int rpcrdma_ep_connect(struct rpcrdma_ep *, struct rpcrdma_ia *);
Chuck Lever3a72dc72016-11-29 10:53:37 -0500552void rpcrdma_conn_func(struct rpcrdma_ep *ep);
Chuck Lever282191c2014-07-29 17:25:55 -0400553void rpcrdma_ep_disconnect(struct rpcrdma_ep *, struct rpcrdma_ia *);
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400554
555int rpcrdma_ep_post(struct rpcrdma_ia *, struct rpcrdma_ep *,
556 struct rpcrdma_req *);
Chuck Leverb1573802016-09-15 10:56:35 -0400557int rpcrdma_ep_post_recv(struct rpcrdma_ia *, struct rpcrdma_rep *);
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400558
559/*
560 * Buffer calls - xprtrdma/verbs.c
561 */
Chuck Leverf531a5d2015-10-24 17:27:43 -0400562struct rpcrdma_req *rpcrdma_create_req(struct rpcrdma_xprt *);
Chuck Lever13650c22016-09-15 10:56:26 -0400563void rpcrdma_destroy_req(struct rpcrdma_req *);
Chuck Leverd698c4a2017-12-14 20:56:09 -0500564int rpcrdma_create_rep(struct rpcrdma_xprt *r_xprt);
Chuck Leverac920d02015-01-21 11:03:44 -0500565int rpcrdma_buffer_create(struct rpcrdma_xprt *);
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400566void rpcrdma_buffer_destroy(struct rpcrdma_buffer *);
Chuck Leverae729502017-10-20 10:48:12 -0400567struct rpcrdma_sendctx *rpcrdma_sendctx_get_locked(struct rpcrdma_buffer *buf);
568void rpcrdma_sendctx_put_locked(struct rpcrdma_sendctx *sc);
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400569
Chuck Lever346aa662015-05-26 11:52:06 -0400570struct rpcrdma_mw *rpcrdma_get_mw(struct rpcrdma_xprt *);
571void rpcrdma_put_mw(struct rpcrdma_xprt *, struct rpcrdma_mw *);
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400572struct rpcrdma_req *rpcrdma_buffer_get(struct rpcrdma_buffer *);
573void rpcrdma_buffer_put(struct rpcrdma_req *);
574void rpcrdma_recv_buffer_get(struct rpcrdma_req *);
575void rpcrdma_recv_buffer_put(struct rpcrdma_rep *);
576
Chuck Lever505bbe62016-06-29 13:52:54 -0400577void rpcrdma_defer_mr_recovery(struct rpcrdma_mw *);
578
Chuck Lever13650c22016-09-15 10:56:26 -0400579struct rpcrdma_regbuf *rpcrdma_alloc_regbuf(size_t, enum dma_data_direction,
Chuck Lever99ef4db2016-09-15 10:56:10 -0400580 gfp_t);
Chuck Lever54cbd6b2016-09-15 10:56:18 -0400581bool __rpcrdma_dma_map_regbuf(struct rpcrdma_ia *, struct rpcrdma_regbuf *);
Chuck Lever13650c22016-09-15 10:56:26 -0400582void rpcrdma_free_regbuf(struct rpcrdma_regbuf *);
Chuck Lever9128c3e2015-01-21 11:04:00 -0500583
Chuck Lever54cbd6b2016-09-15 10:56:18 -0400584static inline bool
585rpcrdma_regbuf_is_mapped(struct rpcrdma_regbuf *rb)
586{
587 return rb->rg_device != NULL;
588}
589
590static inline bool
591rpcrdma_dma_map_regbuf(struct rpcrdma_ia *ia, struct rpcrdma_regbuf *rb)
592{
593 if (likely(rpcrdma_regbuf_is_mapped(rb)))
594 return true;
595 return __rpcrdma_dma_map_regbuf(ia, rb);
596}
597
Chuck Leverf531a5d2015-10-24 17:27:43 -0400598int rpcrdma_ep_post_extra_recv(struct rpcrdma_xprt *, unsigned int);
Chuck Leverd6547882015-03-30 14:35:44 -0400599
Chuck Leverfe97b472015-10-24 17:27:10 -0400600int rpcrdma_alloc_wq(void);
601void rpcrdma_destroy_wq(void);
602
Chuck Leverd6547882015-03-30 14:35:44 -0400603/*
604 * Wrappers for chunk registration, shared by read/write chunk code.
605 */
606
Chuck Leverd6547882015-03-30 14:35:44 -0400607static inline enum dma_data_direction
608rpcrdma_data_dir(bool writing)
609{
610 return writing ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
611}
612
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400613/*
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400614 * RPC/RDMA protocol calls - xprtrdma/rpc_rdma.c
615 */
Chuck Lever655fec62016-09-15 10:57:24 -0400616
617enum rpcrdma_chunktype {
618 rpcrdma_noch = 0,
619 rpcrdma_readch,
620 rpcrdma_areadch,
621 rpcrdma_writech,
622 rpcrdma_replych
623};
624
Chuck Lever857f9ac2017-10-20 10:47:55 -0400625int rpcrdma_prepare_send_sges(struct rpcrdma_xprt *r_xprt,
626 struct rpcrdma_req *req, u32 hdrlen,
627 struct xdr_buf *xdr,
628 enum rpcrdma_chunktype rtype);
Chuck Leverae729502017-10-20 10:48:12 -0400629void rpcrdma_unmap_sendctx(struct rpcrdma_sendctx *sc);
Chuck Lever09e60642017-08-10 12:47:12 -0400630int rpcrdma_marshal_req(struct rpcrdma_xprt *r_xprt, struct rpc_rqst *rqst);
Chuck Lever87cfb9a2016-09-15 10:57:07 -0400631void rpcrdma_set_max_header_sizes(struct rpcrdma_xprt *);
Chuck Levere1352c92017-10-16 15:01:22 -0400632void rpcrdma_complete_rqst(struct rpcrdma_rep *rep);
Chuck Leverd8f532d2017-10-16 15:01:30 -0400633void rpcrdma_reply_handler(struct rpcrdma_rep *rep);
Chuck Lever0ba6f372017-10-20 10:48:28 -0400634void rpcrdma_release_rqst(struct rpcrdma_xprt *r_xprt,
635 struct rpcrdma_req *req);
Chuck Leverd8f532d2017-10-16 15:01:30 -0400636void rpcrdma_deferred_completion(struct work_struct *work);
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400637
Chuck Lever96f87782017-08-03 14:30:03 -0400638static inline void rpcrdma_set_xdrlen(struct xdr_buf *xdr, size_t len)
639{
640 xdr->head[0].iov_len = len;
641 xdr->len = len;
642}
643
Chuck Leverffe1f0d2015-06-04 11:21:42 -0400644/* RPC/RDMA module init - xprtrdma/transport.c
645 */
Chuck Lever5d252f92016-01-07 14:50:10 -0500646extern unsigned int xprt_rdma_max_inline_read;
647void xprt_rdma_format_addresses(struct rpc_xprt *xprt, struct sockaddr *sap);
648void xprt_rdma_free_addresses(struct rpc_xprt *xprt);
Chuck Lever3a72dc72016-11-29 10:53:37 -0500649void rpcrdma_connect_worker(struct work_struct *work);
Chuck Lever5d252f92016-01-07 14:50:10 -0500650void xprt_rdma_print_stats(struct rpc_xprt *xprt, struct seq_file *seq);
Chuck Leverffe1f0d2015-06-04 11:21:42 -0400651int xprt_rdma_init(void);
652void xprt_rdma_cleanup(void);
653
Chuck Leverf531a5d2015-10-24 17:27:43 -0400654/* Backchannel calls - xprtrdma/backchannel.c
655 */
656#if defined(CONFIG_SUNRPC_BACKCHANNEL)
657int xprt_rdma_bc_setup(struct rpc_xprt *, unsigned int);
Chuck Lever76566772015-10-24 17:28:32 -0400658int xprt_rdma_bc_up(struct svc_serv *, struct net *);
Chuck Lever6b26cc82016-05-02 14:40:40 -0400659size_t xprt_rdma_bc_maxpayload(struct rpc_xprt *);
Chuck Leverf531a5d2015-10-24 17:27:43 -0400660int rpcrdma_bc_post_recv(struct rpcrdma_xprt *, unsigned int);
Chuck Lever63cae472015-10-24 17:28:08 -0400661void rpcrdma_bc_receive_call(struct rpcrdma_xprt *, struct rpcrdma_rep *);
Chuck Lever83128a62015-10-24 17:27:59 -0400662int rpcrdma_bc_marshal_reply(struct rpc_rqst *);
Chuck Leverf531a5d2015-10-24 17:27:43 -0400663void xprt_rdma_bc_free_rqst(struct rpc_rqst *);
664void xprt_rdma_bc_destroy(struct rpc_xprt *, unsigned int);
665#endif /* CONFIG_SUNRPC_BACKCHANNEL */
666
Chuck Lever5d252f92016-01-07 14:50:10 -0500667extern struct xprt_class xprt_rdma_bc;
Tom Tuckercec56c82012-02-15 11:30:00 -0600668
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400669#endif /* _LINUX_SUNRPC_XPRT_RDMA_H */