blob: 7c09e2ae25423d923d9d6bc27e4c669968d8880f [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 Leverb5f0afb2017-02-08 16:59:54 -050080 bool ri_implicit_roundup;
Chuck Lever5e9fc6a2016-11-29 10:52:24 -050081 enum ib_mr_type ri_mrtype;
Chuck Leverbebd0312017-04-11 13:23:10 -040082 unsigned long ri_flags;
Chuck Leverce1ab9a2015-01-21 11:03:35 -050083 struct ib_qp_attr ri_qp_attr;
84 struct ib_qp_init_attr ri_qp_init_attr;
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -040085};
86
Chuck Leverbebd0312017-04-11 13:23:10 -040087enum {
88 RPCRDMA_IAF_REMOVING = 0,
89};
90
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -040091/*
92 * RDMA Endpoint -- one per transport instance
93 */
94
95struct rpcrdma_ep {
Chuck Leverae729502017-10-20 10:48:12 -040096 unsigned int rep_send_count;
97 unsigned int rep_send_batch;
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -040098 int rep_connected;
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -040099 struct ib_qp_init_attr rep_attr;
100 wait_queue_head_t rep_connect_wait;
Chuck Lever87cfb9a2016-09-15 10:57:07 -0400101 struct rpcrdma_connect_private rep_cm_private;
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400102 struct rdma_conn_param rep_remote_cma;
Chuck Lever254f91e2014-05-28 10:32:17 -0400103 struct delayed_work rep_connect_worker;
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400104};
105
Chuck Lever124fa172015-10-24 17:27:51 -0400106/* Pre-allocate extra Work Requests for handling backward receives
107 * and sends. This is a fixed value because the Work Queues are
108 * allocated when the forward channel is set up.
109 */
110#if defined(CONFIG_SUNRPC_BACKCHANNEL)
111#define RPCRDMA_BACKWARD_WRS (8)
112#else
113#define RPCRDMA_BACKWARD_WRS (0)
114#endif
115
Chuck Lever9128c3e2015-01-21 11:04:00 -0500116/* Registered buffer -- registered kmalloc'd memory for RDMA SEND/RECV
117 *
118 * The below structure appears at the front of a large region of kmalloc'd
119 * memory, which always starts on a good alignment boundary.
120 */
121
122struct rpcrdma_regbuf {
Chuck Lever9128c3e2015-01-21 11:04:00 -0500123 struct ib_sge rg_iov;
Chuck Lever54cbd6b2016-09-15 10:56:18 -0400124 struct ib_device *rg_device;
Chuck Lever99ef4db2016-09-15 10:56:10 -0400125 enum dma_data_direction rg_direction;
Chuck Lever9128c3e2015-01-21 11:04:00 -0500126 __be32 rg_base[0] __attribute__ ((aligned(256)));
127};
128
129static inline u64
130rdmab_addr(struct rpcrdma_regbuf *rb)
131{
132 return rb->rg_iov.addr;
133}
134
135static inline u32
136rdmab_length(struct rpcrdma_regbuf *rb)
137{
138 return rb->rg_iov.length;
139}
140
141static inline u32
142rdmab_lkey(struct rpcrdma_regbuf *rb)
143{
144 return rb->rg_iov.lkey;
145}
146
Chuck Lever91a10c52017-04-11 13:23:02 -0400147static inline struct ib_device *
148rdmab_device(struct rpcrdma_regbuf *rb)
149{
150 return rb->rg_device;
151}
152
Chuck Lever5d252f92016-01-07 14:50:10 -0500153#define RPCRDMA_DEF_GFP (GFP_NOIO | __GFP_NOWARN)
154
Chuck Lever94931742016-05-02 14:40:56 -0400155/* To ensure a transport can always make forward progress,
156 * the number of RDMA segments allowed in header chunk lists
157 * is capped at 8. This prevents less-capable devices and
158 * memory registrations from overrunning the Send buffer
159 * while building chunk lists.
160 *
161 * Elements of the Read list take up more room than the
162 * Write list or Reply chunk. 8 read segments means the Read
163 * list (or Write list or Reply chunk) cannot consume more
164 * than
165 *
166 * ((8 + 2) * read segment size) + 1 XDR words, or 244 bytes.
167 *
168 * And the fixed part of the header is another 24 bytes.
169 *
170 * The smallest inline threshold is 1024 bytes, ensuring that
171 * at least 750 bytes are available for RPC messages.
172 */
Chuck Lever08cf2ef2016-09-15 10:56:02 -0400173enum {
174 RPCRDMA_MAX_HDR_SEGS = 8,
175 RPCRDMA_HDRBUF_SIZE = 256,
176};
Chuck Lever94931742016-05-02 14:40:56 -0400177
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400178/*
Chuck Levere1352c92017-10-16 15:01:22 -0400179 * struct rpcrdma_rep -- this structure encapsulates state required
180 * to receive and complete an RPC Reply, asychronously. It needs
181 * several pieces of state:
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400182 *
Chuck Levere1352c92017-10-16 15:01:22 -0400183 * o receive buffer and ib_sge (donated to provider)
184 * o status of receive (success or not, length, inv rkey)
185 * o bookkeeping state to get run by reply handler (XDR stream)
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400186 *
Chuck Levere1352c92017-10-16 15:01:22 -0400187 * These structures are allocated during transport initialization.
188 * N of these are associated with a transport instance, managed by
189 * struct rpcrdma_buffer. N is the max number of outstanding RPCs.
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400190 */
191
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400192struct rpcrdma_rep {
Chuck Lever552bf222016-03-04 11:28:36 -0500193 struct ib_cqe rr_cqe;
Chuck Lever5381e0e2017-10-16 15:01:14 -0400194 __be32 rr_xid;
195 __be32 rr_vers;
196 __be32 rr_proc;
Chuck Leverc8b920b2016-09-15 10:57:16 -0400197 int rr_wc_flags;
198 u32 rr_inv_rkey;
Chuck Leverc1bcb682017-08-03 14:30:52 -0400199 struct rpcrdma_regbuf *rr_rdmabuf;
Chuck Leverfed171b2015-05-26 11:51:37 -0400200 struct rpcrdma_xprt *rr_rxprt;
Chuck Leverfe97b472015-10-24 17:27:10 -0400201 struct work_struct rr_work;
Chuck Lever96f87782017-08-03 14:30:03 -0400202 struct xdr_buf rr_hdrbuf;
203 struct xdr_stream rr_stream;
Chuck Levere1352c92017-10-16 15:01:22 -0400204 struct rpc_rqst *rr_rqst;
Chuck Lever6b1184c2015-01-21 11:04:25 -0500205 struct list_head rr_list;
Chuck Lever6ea8e712016-09-15 10:56:51 -0400206 struct ib_recv_wr rr_recv_wr;
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400207};
208
Chuck Leverae729502017-10-20 10:48:12 -0400209/* struct rpcrdma_sendctx - DMA mapped SGEs to unmap after Send completes
210 */
Chuck Lever01bb35c2017-10-20 10:48:36 -0400211struct rpcrdma_req;
Chuck Leverae729502017-10-20 10:48:12 -0400212struct rpcrdma_xprt;
213struct rpcrdma_sendctx {
214 struct ib_send_wr sc_wr;
215 struct ib_cqe sc_cqe;
216 struct rpcrdma_xprt *sc_xprt;
Chuck Lever01bb35c2017-10-20 10:48:36 -0400217 struct rpcrdma_req *sc_req;
Chuck Leverae729502017-10-20 10:48:12 -0400218 unsigned int sc_unmap_count;
219 struct ib_sge sc_sges[];
220};
221
222/* Limit the number of SGEs that can be unmapped during one
223 * Send completion. This caps the amount of work a single
224 * completion can do before returning to the provider.
225 *
226 * Setting this to zero disables Send completion batching.
227 */
228enum {
229 RPCRDMA_MAX_SEND_BATCH = 7,
230};
231
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400232/*
Chuck Lever0dbb4102014-07-29 17:24:09 -0400233 * struct rpcrdma_mw - external memory region metadata
234 *
235 * An external memory region is any buffer or page that is registered
236 * on the fly (ie, not pre-registered).
237 *
Chuck Lever3111d722014-07-29 17:24:28 -0400238 * Each rpcrdma_buffer has a list of free MWs anchored in rb_mws. During
Chuck Lever0dbb4102014-07-29 17:24:09 -0400239 * call_allocate, rpcrdma_buffer_get() assigns one to each segment in
240 * an rpcrdma_req. Then rpcrdma_register_external() grabs these to keep
241 * track of registration metadata while each RPC is pending.
242 * rpcrdma_deregister_external() uses this metadata to unmap and
243 * release these resources when an RPC is complete.
244 */
245enum rpcrdma_frmr_state {
246 FRMR_IS_INVALID, /* ready to be used */
247 FRMR_IS_VALID, /* in use */
Chuck Lever62bdf942016-11-07 16:16:24 -0500248 FRMR_FLUSHED_FR, /* flushed FASTREG WR */
249 FRMR_FLUSHED_LI, /* flushed LOCALINV WR */
Chuck Lever0dbb4102014-07-29 17:24:09 -0400250};
251
252struct rpcrdma_frmr {
Chuck Lever0dbb4102014-07-29 17:24:09 -0400253 struct ib_mr *fr_mr;
Chuck Lever2fa8f882016-03-04 11:28:53 -0500254 struct ib_cqe fr_cqe;
Chuck Lever0dbb4102014-07-29 17:24:09 -0400255 enum rpcrdma_frmr_state fr_state;
Chuck Lever2fa8f882016-03-04 11:28:53 -0500256 struct completion fr_linv_done;
Chuck Lever3cf4e162015-12-16 17:22:31 -0500257 union {
258 struct ib_reg_wr fr_regwr;
259 struct ib_send_wr fr_invwr;
260 };
Chuck Lever0dbb4102014-07-29 17:24:09 -0400261};
262
Chuck Leveracb9da72015-05-26 11:53:23 -0400263struct rpcrdma_fmr {
Chuck Lever88975eb2016-06-29 13:52:37 -0400264 struct ib_fmr *fm_mr;
265 u64 *fm_physaddrs;
Chuck Lever0dbb4102014-07-29 17:24:09 -0400266};
267
268struct rpcrdma_mw {
Chuck Lever564471d2016-06-29 13:52:21 -0400269 struct list_head mw_list;
270 struct scatterlist *mw_sg;
271 int mw_nents;
272 enum dma_data_direction mw_dir;
Chuck Lever0dbb4102014-07-29 17:24:09 -0400273 union {
Chuck Leveracb9da72015-05-26 11:53:23 -0400274 struct rpcrdma_fmr fmr;
Chuck Lever0dbb4102014-07-29 17:24:09 -0400275 struct rpcrdma_frmr frmr;
Chuck Leverc882a652016-03-04 11:28:45 -0500276 };
Chuck Lever766656b2016-05-02 14:42:29 -0400277 struct rpcrdma_xprt *mw_xprt;
Chuck Lever9d6b0402016-06-29 13:54:16 -0400278 u32 mw_handle;
279 u32 mw_length;
280 u64 mw_offset;
Chuck Lever3111d722014-07-29 17:24:28 -0400281 struct list_head mw_all;
Chuck Lever0dbb4102014-07-29 17:24:09 -0400282};
283
284/*
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400285 * struct rpcrdma_req -- structure central to the request/reply sequence.
286 *
287 * N of these are associated with a transport instance, and stored in
288 * struct rpcrdma_buffer. N is the max number of outstanding requests.
289 *
290 * It includes pre-registered buffer memory for send AND recv.
291 * The recv buffer, however, is not owned by this structure, and
292 * is "donated" to the hardware when a recv is posted. When a
293 * reply is handled, the recv buffer used is given back to the
294 * struct rpcrdma_req associated with the request.
295 *
296 * In addition to the basic memory, this structure includes an array
297 * of iovs for send operations. The reason is that the iovs passed to
298 * ib_post_{send,recv} must not be modified until the work request
299 * completes.
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400300 */
301
Chuck Lever5ab81422016-06-29 13:54:25 -0400302/* Maximum number of page-sized "segments" per chunk list to be
303 * registered or invalidated. Must handle a Reply chunk:
304 */
305enum {
306 RPCRDMA_MAX_IOV_SEGS = 3,
307 RPCRDMA_MAX_DATA_SEGS = ((1 * 1024 * 1024) / PAGE_SIZE) + 1,
308 RPCRDMA_MAX_SEGS = RPCRDMA_MAX_DATA_SEGS +
309 RPCRDMA_MAX_IOV_SEGS,
310};
311
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400312struct rpcrdma_mr_seg { /* chunk descriptors */
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400313 u32 mr_len; /* length of chunk or segment */
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400314 struct page *mr_page; /* owning page, if any */
315 char *mr_offset; /* kva if no page, else offset */
316};
317
Chuck Leverc6f5b472017-02-08 17:00:18 -0500318/* The Send SGE array is provisioned to send a maximum size
319 * inline request:
Chuck Lever655fec62016-09-15 10:57:24 -0400320 * - RPC-over-RDMA header
321 * - xdr_buf head iovec
Chuck Leverc6f5b472017-02-08 17:00:18 -0500322 * - RPCRDMA_MAX_INLINE bytes, in pages
Chuck Lever655fec62016-09-15 10:57:24 -0400323 * - xdr_buf tail iovec
Chuck Leverc6f5b472017-02-08 17:00:18 -0500324 *
325 * The actual number of array elements consumed by each RPC
326 * depends on the device's max_sge limit.
Chuck Lever655fec62016-09-15 10:57:24 -0400327 */
328enum {
Chuck Lever16f906d2017-02-08 17:00:10 -0500329 RPCRDMA_MIN_SEND_SGES = 3,
Chuck Leverc6f5b472017-02-08 17:00:18 -0500330 RPCRDMA_MAX_PAGE_SGES = RPCRDMA_MAX_INLINE >> PAGE_SHIFT,
Chuck Lever655fec62016-09-15 10:57:24 -0400331 RPCRDMA_MAX_SEND_SGES = 1 + 1 + RPCRDMA_MAX_PAGE_SGES + 1,
332};
Chuck Leverb3221d62015-08-03 13:03:39 -0400333
Chuck Lever5ab81422016-06-29 13:54:25 -0400334struct rpcrdma_buffer;
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400335struct rpcrdma_req {
Chuck Levera80d66c2017-06-08 11:52:12 -0400336 struct list_head rl_list;
Chuck Leverccede752017-12-04 14:04:04 -0500337 int rl_cpu;
Chuck Leverb3221d62015-08-03 13:03:39 -0400338 unsigned int rl_connect_cookie;
339 struct rpcrdma_buffer *rl_buffer;
Chuck Lever90aab602016-09-15 10:56:43 -0400340 struct rpcrdma_rep *rl_reply;
Chuck Lever7a80f3f2017-08-10 12:47:28 -0400341 struct xdr_stream rl_stream;
342 struct xdr_buf rl_hdrbuf;
Chuck Leverae729502017-10-20 10:48:12 -0400343 struct rpcrdma_sendctx *rl_sendctx;
Chuck Lever9c40c492016-09-15 10:55:53 -0400344 struct rpcrdma_regbuf *rl_rdmabuf; /* xprt header */
345 struct rpcrdma_regbuf *rl_sendbuf; /* rq_snd_buf */
346 struct rpcrdma_regbuf *rl_recvbuf; /* rq_rcv_buf */
Chuck Leverf531a5d2015-10-24 17:27:43 -0400347
348 struct list_head rl_all;
Chuck Lever531cca02017-10-20 10:48:20 -0400349 unsigned long rl_flags;
Chuck Lever5ab81422016-06-29 13:54:25 -0400350
351 struct list_head rl_registered; /* registered segments */
352 struct rpcrdma_mr_seg rl_segments[RPCRDMA_MAX_SEGS];
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400353};
Chuck Lever0ca77dc2015-01-21 11:04:08 -0500354
Chuck Lever531cca02017-10-20 10:48:20 -0400355/* rl_flags */
356enum {
357 RPCRDMA_REQ_F_BACKCHANNEL = 0,
Chuck Lever0ba6f372017-10-20 10:48:28 -0400358 RPCRDMA_REQ_F_PENDING,
Chuck Lever01bb35c2017-10-20 10:48:36 -0400359 RPCRDMA_REQ_F_TX_RESOURCES,
Chuck Lever531cca02017-10-20 10:48:20 -0400360};
361
Chuck Lever5a6d1db2016-09-15 10:55:45 -0400362static inline void
363rpcrdma_set_xprtdata(struct rpc_rqst *rqst, struct rpcrdma_req *req)
364{
365 rqst->rq_xprtdata = req;
366}
367
Chuck Lever0ca77dc2015-01-21 11:04:08 -0500368static inline struct rpcrdma_req *
369rpcr_to_rdmar(struct rpc_rqst *rqst)
370{
Chuck Lever5a6d1db2016-09-15 10:55:45 -0400371 return rqst->rq_xprtdata;
Chuck Lever0ca77dc2015-01-21 11:04:08 -0500372}
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400373
Chuck Lever9a5c63e2017-02-08 17:00:43 -0500374static inline void
375rpcrdma_push_mw(struct rpcrdma_mw *mw, struct list_head *list)
376{
377 list_add_tail(&mw->mw_list, list);
378}
379
380static inline struct rpcrdma_mw *
381rpcrdma_pop_mw(struct list_head *list)
382{
383 struct rpcrdma_mw *mw;
384
385 mw = list_first_entry(list, struct rpcrdma_mw, mw_list);
386 list_del(&mw->mw_list);
387 return mw;
388}
389
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400390/*
391 * struct rpcrdma_buffer -- holds list/queue of pre-registered memory for
392 * inline requests/replies, and client/server credits.
393 *
394 * One of these is associated with a transport instance
395 */
396struct rpcrdma_buffer {
Chuck Lever58d1dcf2015-05-26 11:53:13 -0400397 spinlock_t rb_mwlock; /* protect rb_mws list */
398 struct list_head rb_mws;
399 struct list_head rb_all;
Chuck Lever58d1dcf2015-05-26 11:53:13 -0400400
Chuck Leverae729502017-10-20 10:48:12 -0400401 unsigned long rb_sc_head;
402 unsigned long rb_sc_tail;
403 unsigned long rb_sc_last;
404 struct rpcrdma_sendctx **rb_sc_ctxs;
405
Chuck Lever1e465fd2015-10-24 17:27:02 -0400406 spinlock_t rb_lock; /* protect buf lists */
Chuck Lever05c97462016-09-06 11:22:58 -0400407 int rb_send_count, rb_recv_count;
Chuck Lever1e465fd2015-10-24 17:27:02 -0400408 struct list_head rb_send_bufs;
409 struct list_head rb_recv_bufs;
Chuck Lever58d1dcf2015-05-26 11:53:13 -0400410 u32 rb_max_requests;
Chuck Leverbe798f92017-10-16 15:01:39 -0400411 u32 rb_credits; /* most recent credit grant */
Chuck Leverf531a5d2015-10-24 17:27:43 -0400412
413 u32 rb_bc_srv_max_requests;
414 spinlock_t rb_reqslock; /* protect rb_allreqs */
415 struct list_head rb_allreqs;
Chuck Lever5d252f92016-01-07 14:50:10 -0500416
417 u32 rb_bc_max_requests;
Chuck Lever505bbe62016-06-29 13:52:54 -0400418
419 spinlock_t rb_recovery_lock; /* protect rb_stale_mrs */
420 struct list_head rb_stale_mrs;
421 struct delayed_work rb_recovery_worker;
Chuck Levere2ac2362016-06-29 13:54:00 -0400422 struct delayed_work rb_refresh_worker;
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400423};
424#define rdmab_to_ia(b) (&container_of((b), struct rpcrdma_xprt, rx_buf)->rx_ia)
425
426/*
427 * Internal structure for transport instance creation. This
428 * exists primarily for modularity.
429 *
430 * This data should be set with mount options
431 */
432struct rpcrdma_create_data_internal {
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400433 unsigned int max_requests; /* max requests (slots) in flight */
434 unsigned int rsize; /* mount rsize - max read hdr+data */
435 unsigned int wsize; /* mount wsize - max write hdr+data */
436 unsigned int inline_rsize; /* max non-rdma read data payload */
437 unsigned int inline_wsize; /* max non-rdma write data payload */
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400438};
439
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400440/*
441 * Statistics for RPCRDMA
442 */
443struct rpcrdma_stats {
Chuck Lever67af6f62017-08-22 11:19:35 -0400444 /* accessed when sending a call */
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400445 unsigned long read_chunk_count;
446 unsigned long write_chunk_count;
447 unsigned long reply_chunk_count;
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400448 unsigned long long total_rdma_request;
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400449
Chuck Lever67af6f62017-08-22 11:19:35 -0400450 /* rarely accessed error counters */
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400451 unsigned long long pullup_copy_count;
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400452 unsigned long hardway_register_count;
453 unsigned long failed_marshal_count;
454 unsigned long bad_reply_count;
Chuck Lever505bbe62016-06-29 13:52:54 -0400455 unsigned long mrs_recovered;
456 unsigned long mrs_orphaned;
Chuck Levere2ac2362016-06-29 13:54:00 -0400457 unsigned long mrs_allocated;
Chuck Leverae729502017-10-20 10:48:12 -0400458 unsigned long empty_sendctx_q;
Chuck Lever67af6f62017-08-22 11:19:35 -0400459
460 /* accessed when receiving a reply */
461 unsigned long long total_rdma_reply;
462 unsigned long long fixup_copy_count;
Chuck Lever01bb35c2017-10-20 10:48:36 -0400463 unsigned long reply_waits_for_send;
Chuck Leverc8b920b2016-09-15 10:57:16 -0400464 unsigned long local_inv_needed;
Chuck Lever67af6f62017-08-22 11:19:35 -0400465 unsigned long nomsg_call_count;
466 unsigned long bcall_count;
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400467};
468
469/*
Chuck Levera0ce85f2015-03-30 14:34:21 -0400470 * Per-registration mode operations
471 */
Chuck Lever1c9351e2015-03-30 14:34:30 -0400472struct rpcrdma_xprt;
Chuck Levera0ce85f2015-03-30 14:34:21 -0400473struct rpcrdma_memreg_ops {
Chuck Lever6748b0c2017-08-14 15:38:30 -0400474 struct rpcrdma_mr_seg *
475 (*ro_map)(struct rpcrdma_xprt *,
Chuck Lever9d6b0402016-06-29 13:54:16 -0400476 struct rpcrdma_mr_seg *, int, bool,
477 struct rpcrdma_mw **);
Chuck Leverc3441612017-12-14 20:56:26 -0500478 void (*ro_reminv)(struct rpcrdma_rep *rep,
479 struct list_head *mws);
Chuck Lever32d0cee2015-12-16 17:22:39 -0500480 void (*ro_unmap_sync)(struct rpcrdma_xprt *,
Chuck Lever451d26e2017-06-08 11:52:04 -0400481 struct list_head *);
Chuck Lever505bbe62016-06-29 13:52:54 -0400482 void (*ro_recover_mr)(struct rpcrdma_mw *);
Chuck Lever3968cb52015-03-30 14:35:26 -0400483 int (*ro_open)(struct rpcrdma_ia *,
484 struct rpcrdma_ep *,
485 struct rpcrdma_create_data_internal *);
Chuck Lever1c9351e2015-03-30 14:34:30 -0400486 size_t (*ro_maxpages)(struct rpcrdma_xprt *);
Chuck Levere2ac2362016-06-29 13:54:00 -0400487 int (*ro_init_mr)(struct rpcrdma_ia *,
488 struct rpcrdma_mw *);
489 void (*ro_release_mr)(struct rpcrdma_mw *);
Chuck Levera0ce85f2015-03-30 14:34:21 -0400490 const char *ro_displayname;
Chuck Leverc8b920b2016-09-15 10:57:16 -0400491 const int ro_send_w_inv_ok;
Chuck Levera0ce85f2015-03-30 14:34:21 -0400492};
493
494extern const struct rpcrdma_memreg_ops rpcrdma_fmr_memreg_ops;
495extern const struct rpcrdma_memreg_ops rpcrdma_frwr_memreg_ops;
Chuck Levera0ce85f2015-03-30 14:34:21 -0400496
497/*
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400498 * RPCRDMA transport -- encapsulates the structures above for
499 * integration with RPC.
500 *
501 * The contained structures are embedded, not pointers,
502 * for convenience. This structure need not be visible externally.
503 *
504 * It is allocated and initialized during mount, and released
505 * during unmount.
506 */
507struct rpcrdma_xprt {
Chuck Lever5abefb82015-01-21 11:02:37 -0500508 struct rpc_xprt rx_xprt;
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400509 struct rpcrdma_ia rx_ia;
510 struct rpcrdma_ep rx_ep;
511 struct rpcrdma_buffer rx_buf;
512 struct rpcrdma_create_data_internal rx_data;
Chuck Lever5abefb82015-01-21 11:02:37 -0500513 struct delayed_work rx_connect_worker;
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400514 struct rpcrdma_stats rx_stats;
515};
516
Chuck Lever5abefb82015-01-21 11:02:37 -0500517#define rpcx_to_rdmax(x) container_of(x, struct rpcrdma_xprt, rx_xprt)
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400518#define rpcx_to_rdmad(x) (rpcx_to_rdmax(x)->rx_data)
519
Chuck Leverd461f1f2017-12-14 20:56:50 -0500520static inline const char *
521rpcrdma_addrstr(const struct rpcrdma_xprt *r_xprt)
522{
523 return r_xprt->rx_xprt.address_strings[RPC_DISPLAY_ADDR];
524}
525
526static inline const char *
527rpcrdma_portstr(const struct rpcrdma_xprt *r_xprt)
528{
529 return r_xprt->rx_xprt.address_strings[RPC_DISPLAY_PORT];
530}
531
Tom Talpey9191ca32008-10-09 15:01:11 -0400532/* Setting this to 0 ensures interoperability with early servers.
533 * Setting this to 1 enhances certain unaligned read/write performance.
534 * Default is 0, see sysctl entry and rpc_rdma.c rpcrdma_convert_iovs() */
535extern int xprt_rdma_pad_optimize;
536
Chuck Leverfff09592017-04-11 13:22:54 -0400537/* This setting controls the hunt for a supported memory
538 * registration strategy.
539 */
540extern unsigned int xprt_rdma_memreg_strategy;
541
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400542/*
543 * Interface Adapter calls - xprtrdma/verbs.c
544 */
Chuck Leverdd229ce2017-12-14 20:56:58 -0500545int rpcrdma_ia_open(struct rpcrdma_xprt *xprt);
Chuck Leverbebd0312017-04-11 13:23:10 -0400546void rpcrdma_ia_remove(struct rpcrdma_ia *ia);
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400547void rpcrdma_ia_close(struct rpcrdma_ia *);
Chuck Leverb54054c2016-06-29 13:53:27 -0400548bool frwr_is_supported(struct rpcrdma_ia *);
549bool fmr_is_supported(struct rpcrdma_ia *);
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400550
Chuck Leverd8f532d2017-10-16 15:01:30 -0400551extern struct workqueue_struct *rpcrdma_receive_wq;
552
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400553/*
554 * Endpoint calls - xprtrdma/verbs.c
555 */
556int rpcrdma_ep_create(struct rpcrdma_ep *, struct rpcrdma_ia *,
557 struct rpcrdma_create_data_internal *);
Chuck Lever7f1d5412014-05-28 10:33:16 -0400558void rpcrdma_ep_destroy(struct rpcrdma_ep *, struct rpcrdma_ia *);
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400559int rpcrdma_ep_connect(struct rpcrdma_ep *, struct rpcrdma_ia *);
Chuck Lever3a72dc72016-11-29 10:53:37 -0500560void rpcrdma_conn_func(struct rpcrdma_ep *ep);
Chuck Lever282191c2014-07-29 17:25:55 -0400561void rpcrdma_ep_disconnect(struct rpcrdma_ep *, struct rpcrdma_ia *);
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400562
563int rpcrdma_ep_post(struct rpcrdma_ia *, struct rpcrdma_ep *,
564 struct rpcrdma_req *);
Chuck Leverb1573802016-09-15 10:56:35 -0400565int rpcrdma_ep_post_recv(struct rpcrdma_ia *, struct rpcrdma_rep *);
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400566
567/*
568 * Buffer calls - xprtrdma/verbs.c
569 */
Chuck Leverf531a5d2015-10-24 17:27:43 -0400570struct rpcrdma_req *rpcrdma_create_req(struct rpcrdma_xprt *);
Chuck Lever13650c22016-09-15 10:56:26 -0400571void rpcrdma_destroy_req(struct rpcrdma_req *);
Chuck Leverd698c4a2017-12-14 20:56:09 -0500572int rpcrdma_create_rep(struct rpcrdma_xprt *r_xprt);
Chuck Leverac920d02015-01-21 11:03:44 -0500573int rpcrdma_buffer_create(struct rpcrdma_xprt *);
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400574void rpcrdma_buffer_destroy(struct rpcrdma_buffer *);
Chuck Leverae729502017-10-20 10:48:12 -0400575struct rpcrdma_sendctx *rpcrdma_sendctx_get_locked(struct rpcrdma_buffer *buf);
576void rpcrdma_sendctx_put_locked(struct rpcrdma_sendctx *sc);
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400577
Chuck Lever346aa662015-05-26 11:52:06 -0400578struct rpcrdma_mw *rpcrdma_get_mw(struct rpcrdma_xprt *);
579void rpcrdma_put_mw(struct rpcrdma_xprt *, struct rpcrdma_mw *);
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400580struct rpcrdma_req *rpcrdma_buffer_get(struct rpcrdma_buffer *);
581void rpcrdma_buffer_put(struct rpcrdma_req *);
582void rpcrdma_recv_buffer_get(struct rpcrdma_req *);
583void rpcrdma_recv_buffer_put(struct rpcrdma_rep *);
584
Chuck Lever505bbe62016-06-29 13:52:54 -0400585void rpcrdma_defer_mr_recovery(struct rpcrdma_mw *);
586
Chuck Lever13650c22016-09-15 10:56:26 -0400587struct rpcrdma_regbuf *rpcrdma_alloc_regbuf(size_t, enum dma_data_direction,
Chuck Lever99ef4db2016-09-15 10:56:10 -0400588 gfp_t);
Chuck Lever54cbd6b2016-09-15 10:56:18 -0400589bool __rpcrdma_dma_map_regbuf(struct rpcrdma_ia *, struct rpcrdma_regbuf *);
Chuck Lever13650c22016-09-15 10:56:26 -0400590void rpcrdma_free_regbuf(struct rpcrdma_regbuf *);
Chuck Lever9128c3e2015-01-21 11:04:00 -0500591
Chuck Lever54cbd6b2016-09-15 10:56:18 -0400592static inline bool
593rpcrdma_regbuf_is_mapped(struct rpcrdma_regbuf *rb)
594{
595 return rb->rg_device != NULL;
596}
597
598static inline bool
599rpcrdma_dma_map_regbuf(struct rpcrdma_ia *ia, struct rpcrdma_regbuf *rb)
600{
601 if (likely(rpcrdma_regbuf_is_mapped(rb)))
602 return true;
603 return __rpcrdma_dma_map_regbuf(ia, rb);
604}
605
Chuck Leverf531a5d2015-10-24 17:27:43 -0400606int rpcrdma_ep_post_extra_recv(struct rpcrdma_xprt *, unsigned int);
Chuck Leverd6547882015-03-30 14:35:44 -0400607
Chuck Leverfe97b472015-10-24 17:27:10 -0400608int rpcrdma_alloc_wq(void);
609void rpcrdma_destroy_wq(void);
610
Chuck Leverd6547882015-03-30 14:35:44 -0400611/*
612 * Wrappers for chunk registration, shared by read/write chunk code.
613 */
614
Chuck Leverd6547882015-03-30 14:35:44 -0400615static inline enum dma_data_direction
616rpcrdma_data_dir(bool writing)
617{
618 return writing ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
619}
620
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400621/*
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400622 * RPC/RDMA protocol calls - xprtrdma/rpc_rdma.c
623 */
Chuck Lever655fec62016-09-15 10:57:24 -0400624
625enum rpcrdma_chunktype {
626 rpcrdma_noch = 0,
627 rpcrdma_readch,
628 rpcrdma_areadch,
629 rpcrdma_writech,
630 rpcrdma_replych
631};
632
Chuck Lever857f9ac2017-10-20 10:47:55 -0400633int rpcrdma_prepare_send_sges(struct rpcrdma_xprt *r_xprt,
634 struct rpcrdma_req *req, u32 hdrlen,
635 struct xdr_buf *xdr,
636 enum rpcrdma_chunktype rtype);
Chuck Leverae729502017-10-20 10:48:12 -0400637void rpcrdma_unmap_sendctx(struct rpcrdma_sendctx *sc);
Chuck Lever09e60642017-08-10 12:47:12 -0400638int rpcrdma_marshal_req(struct rpcrdma_xprt *r_xprt, struct rpc_rqst *rqst);
Chuck Lever87cfb9a2016-09-15 10:57:07 -0400639void rpcrdma_set_max_header_sizes(struct rpcrdma_xprt *);
Chuck Levere1352c92017-10-16 15:01:22 -0400640void rpcrdma_complete_rqst(struct rpcrdma_rep *rep);
Chuck Leverd8f532d2017-10-16 15:01:30 -0400641void rpcrdma_reply_handler(struct rpcrdma_rep *rep);
Chuck Lever0ba6f372017-10-20 10:48:28 -0400642void rpcrdma_release_rqst(struct rpcrdma_xprt *r_xprt,
643 struct rpcrdma_req *req);
Chuck Leverd8f532d2017-10-16 15:01:30 -0400644void rpcrdma_deferred_completion(struct work_struct *work);
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400645
Chuck Lever96f87782017-08-03 14:30:03 -0400646static inline void rpcrdma_set_xdrlen(struct xdr_buf *xdr, size_t len)
647{
648 xdr->head[0].iov_len = len;
649 xdr->len = len;
650}
651
Chuck Leverffe1f0d2015-06-04 11:21:42 -0400652/* RPC/RDMA module init - xprtrdma/transport.c
653 */
Chuck Lever5d252f92016-01-07 14:50:10 -0500654extern unsigned int xprt_rdma_max_inline_read;
655void xprt_rdma_format_addresses(struct rpc_xprt *xprt, struct sockaddr *sap);
656void xprt_rdma_free_addresses(struct rpc_xprt *xprt);
Chuck Lever3a72dc72016-11-29 10:53:37 -0500657void rpcrdma_connect_worker(struct work_struct *work);
Chuck Lever5d252f92016-01-07 14:50:10 -0500658void xprt_rdma_print_stats(struct rpc_xprt *xprt, struct seq_file *seq);
Chuck Leverffe1f0d2015-06-04 11:21:42 -0400659int xprt_rdma_init(void);
660void xprt_rdma_cleanup(void);
661
Chuck Leverf531a5d2015-10-24 17:27:43 -0400662/* Backchannel calls - xprtrdma/backchannel.c
663 */
664#if defined(CONFIG_SUNRPC_BACKCHANNEL)
665int xprt_rdma_bc_setup(struct rpc_xprt *, unsigned int);
Chuck Lever76566772015-10-24 17:28:32 -0400666int xprt_rdma_bc_up(struct svc_serv *, struct net *);
Chuck Lever6b26cc82016-05-02 14:40:40 -0400667size_t xprt_rdma_bc_maxpayload(struct rpc_xprt *);
Chuck Leverf531a5d2015-10-24 17:27:43 -0400668int rpcrdma_bc_post_recv(struct rpcrdma_xprt *, unsigned int);
Chuck Lever63cae472015-10-24 17:28:08 -0400669void rpcrdma_bc_receive_call(struct rpcrdma_xprt *, struct rpcrdma_rep *);
Chuck Lever83128a62015-10-24 17:27:59 -0400670int rpcrdma_bc_marshal_reply(struct rpc_rqst *);
Chuck Leverf531a5d2015-10-24 17:27:43 -0400671void xprt_rdma_bc_free_rqst(struct rpc_rqst *);
672void xprt_rdma_bc_destroy(struct rpc_xprt *, unsigned int);
673#endif /* CONFIG_SUNRPC_BACKCHANNEL */
674
Chuck Lever5d252f92016-01-07 14:50:10 -0500675extern struct xprt_class xprt_rdma_bc;
Tom Tuckercec56c82012-02-15 11:30:00 -0600676
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400677#endif /* _LINUX_SUNRPC_XPRT_RDMA_H */