blob: 2af910662928e01500d9422bb216dabf9a012461 [file] [log] [blame]
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -04001/*
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 */
Arun Sharma600634972011-07-26 16:09:06 -070045#include <linux/atomic.h> /* atomic_t, etc */
Chuck Lever254f91e2014-05-28 10:32:17 -040046#include <linux/workqueue.h> /* struct work_struct */
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -040047
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
Tom Talpey5675add2008-10-09 15:01:41 -040055#define RDMA_RESOLVE_TIMEOUT (5000) /* 5 seconds */
56#define RDMA_CONNECT_RETRY_MAX (2) /* retries if no listener backlog */
57
Chuck Lever5d252f92016-01-07 14:50:10 -050058#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
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -040063/*
64 * Interface Adapter -- one per transport instance
65 */
66struct rpcrdma_ia {
Chuck Levera0ce85f2015-03-30 14:34:21 -040067 const struct rpcrdma_memreg_ops *ri_ops;
Chuck Lever89e0d1122015-05-26 11:51:56 -040068 struct ib_device *ri_device;
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -040069 struct rdma_cm_id *ri_id;
70 struct ib_pd *ri_pd;
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -040071 struct completion ri_done;
Chuck Leverbebd0312017-04-11 13:23:10 -040072 struct completion ri_remove_done;
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -040073 int ri_async_rc;
Chuck Lever87cfb9a2016-09-15 10:57:07 -040074 unsigned int ri_max_segs;
Steve Wise0fc6c4e2014-05-28 10:32:00 -040075 unsigned int ri_max_frmr_depth;
Chuck Lever302d3de2016-05-02 14:41:05 -040076 unsigned int ri_max_inline_write;
77 unsigned int ri_max_inline_read;
Chuck Lever16f906d2017-02-08 17:00:10 -050078 unsigned int ri_max_send_sges;
Chuck Leverc8b920b2016-09-15 10:57:16 -040079 bool ri_reminv_expected;
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 {
96 atomic_t rep_cqcount;
97 int rep_cqinit;
98 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;
103 struct sockaddr_storage rep_remote_addr;
Chuck Lever254f91e2014-05-28 10:32:17 -0400104 struct delayed_work rep_connect_worker;
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400105};
106
Chuck Lever8d38de62016-11-29 10:52:16 -0500107static inline void
108rpcrdma_init_cqcount(struct rpcrdma_ep *ep, int count)
109{
110 atomic_set(&ep->rep_cqcount, ep->rep_cqinit - count);
111}
112
113/* To update send queue accounting, provider must take a
114 * send completion every now and then.
115 */
116static inline void
117rpcrdma_set_signaled(struct rpcrdma_ep *ep, struct ib_send_wr *send_wr)
118{
119 send_wr->send_flags = 0;
120 if (unlikely(atomic_sub_return(1, &ep->rep_cqcount) <= 0)) {
121 rpcrdma_init_cqcount(ep, 0);
122 send_wr->send_flags = IB_SEND_SIGNALED;
123 }
124}
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400125
Chuck Lever124fa172015-10-24 17:27:51 -0400126/* Pre-allocate extra Work Requests for handling backward receives
127 * and sends. This is a fixed value because the Work Queues are
128 * allocated when the forward channel is set up.
129 */
130#if defined(CONFIG_SUNRPC_BACKCHANNEL)
131#define RPCRDMA_BACKWARD_WRS (8)
132#else
133#define RPCRDMA_BACKWARD_WRS (0)
134#endif
135
Chuck Lever9128c3e2015-01-21 11:04:00 -0500136/* Registered buffer -- registered kmalloc'd memory for RDMA SEND/RECV
137 *
138 * The below structure appears at the front of a large region of kmalloc'd
139 * memory, which always starts on a good alignment boundary.
140 */
141
142struct rpcrdma_regbuf {
Chuck Lever9128c3e2015-01-21 11:04:00 -0500143 struct ib_sge rg_iov;
Chuck Lever54cbd6b2016-09-15 10:56:18 -0400144 struct ib_device *rg_device;
Chuck Lever99ef4db2016-09-15 10:56:10 -0400145 enum dma_data_direction rg_direction;
Chuck Lever9128c3e2015-01-21 11:04:00 -0500146 __be32 rg_base[0] __attribute__ ((aligned(256)));
147};
148
149static inline u64
150rdmab_addr(struct rpcrdma_regbuf *rb)
151{
152 return rb->rg_iov.addr;
153}
154
155static inline u32
156rdmab_length(struct rpcrdma_regbuf *rb)
157{
158 return rb->rg_iov.length;
159}
160
161static inline u32
162rdmab_lkey(struct rpcrdma_regbuf *rb)
163{
164 return rb->rg_iov.lkey;
165}
166
167static inline struct rpcrdma_msg *
168rdmab_to_msg(struct rpcrdma_regbuf *rb)
169{
170 return (struct rpcrdma_msg *)rb->rg_base;
171}
172
Chuck Lever91a10c52017-04-11 13:23:02 -0400173static inline struct ib_device *
174rdmab_device(struct rpcrdma_regbuf *rb)
175{
176 return rb->rg_device;
177}
178
Chuck Lever5d252f92016-01-07 14:50:10 -0500179#define RPCRDMA_DEF_GFP (GFP_NOIO | __GFP_NOWARN)
180
Chuck Lever94931742016-05-02 14:40:56 -0400181/* To ensure a transport can always make forward progress,
182 * the number of RDMA segments allowed in header chunk lists
183 * is capped at 8. This prevents less-capable devices and
184 * memory registrations from overrunning the Send buffer
185 * while building chunk lists.
186 *
187 * Elements of the Read list take up more room than the
188 * Write list or Reply chunk. 8 read segments means the Read
189 * list (or Write list or Reply chunk) cannot consume more
190 * than
191 *
192 * ((8 + 2) * read segment size) + 1 XDR words, or 244 bytes.
193 *
194 * And the fixed part of the header is another 24 bytes.
195 *
196 * The smallest inline threshold is 1024 bytes, ensuring that
197 * at least 750 bytes are available for RPC messages.
198 */
Chuck Lever08cf2ef2016-09-15 10:56:02 -0400199enum {
200 RPCRDMA_MAX_HDR_SEGS = 8,
201 RPCRDMA_HDRBUF_SIZE = 256,
202};
Chuck Lever94931742016-05-02 14:40:56 -0400203
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400204/*
205 * struct rpcrdma_rep -- this structure encapsulates state required to recv
206 * and complete a reply, asychronously. It needs several pieces of
207 * state:
208 * o recv buffer (posted to provider)
209 * o ib_sge (also donated to provider)
210 * o status of reply (length, success or not)
Chuck Lever5ab81422016-06-29 13:54:25 -0400211 * o bookkeeping state to get run by reply handler (list, etc)
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400212 *
Chuck Lever5ab81422016-06-29 13:54:25 -0400213 * These are allocated during initialization, per-transport instance.
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400214 *
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
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400219struct rpcrdma_rep {
Chuck Lever552bf222016-03-04 11:28:36 -0500220 struct ib_cqe rr_cqe;
Chuck Leverc8b920b2016-09-15 10:57:16 -0400221 int rr_wc_flags;
222 u32 rr_inv_rkey;
Chuck Leverc1bcb682017-08-03 14:30:52 -0400223 struct rpcrdma_regbuf *rr_rdmabuf;
Chuck Leverfed171b2015-05-26 11:51:37 -0400224 struct rpcrdma_xprt *rr_rxprt;
Chuck Leverfe97b472015-10-24 17:27:10 -0400225 struct work_struct rr_work;
Chuck Lever96f87782017-08-03 14:30:03 -0400226 struct xdr_buf rr_hdrbuf;
227 struct xdr_stream rr_stream;
Chuck Lever6b1184c2015-01-21 11:04:25 -0500228 struct list_head rr_list;
Chuck Lever6ea8e712016-09-15 10:56:51 -0400229 struct ib_recv_wr rr_recv_wr;
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400230};
231
232/*
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 Lever4b196dc62017-06-08 11:51:56 -0400273 unsigned long mw_flags;
Chuck Lever0dbb4102014-07-29 17:24:09 -0400274 union {
Chuck Leveracb9da72015-05-26 11:53:23 -0400275 struct rpcrdma_fmr fmr;
Chuck Lever0dbb4102014-07-29 17:24:09 -0400276 struct rpcrdma_frmr frmr;
Chuck Leverc882a652016-03-04 11:28:45 -0500277 };
Chuck Lever766656b2016-05-02 14:42:29 -0400278 struct rpcrdma_xprt *mw_xprt;
Chuck Lever9d6b0402016-06-29 13:54:16 -0400279 u32 mw_handle;
280 u32 mw_length;
281 u64 mw_offset;
Chuck Lever3111d722014-07-29 17:24:28 -0400282 struct list_head mw_all;
Chuck Lever0dbb4102014-07-29 17:24:09 -0400283};
284
Chuck Lever4b196dc62017-06-08 11:51:56 -0400285/* mw_flags */
286enum {
287 RPCRDMA_MW_F_RI = 1,
288};
289
Chuck Lever0dbb4102014-07-29 17:24:09 -0400290/*
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400291 * struct rpcrdma_req -- structure central to the request/reply sequence.
292 *
293 * N of these are associated with a transport instance, and stored in
294 * struct rpcrdma_buffer. N is the max number of outstanding requests.
295 *
296 * It includes pre-registered buffer memory for send AND recv.
297 * The recv buffer, however, is not owned by this structure, and
298 * is "donated" to the hardware when a recv is posted. When a
299 * reply is handled, the recv buffer used is given back to the
300 * struct rpcrdma_req associated with the request.
301 *
302 * In addition to the basic memory, this structure includes an array
303 * of iovs for send operations. The reason is that the iovs passed to
304 * ib_post_{send,recv} must not be modified until the work request
305 * completes.
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400306 */
307
Chuck Lever5ab81422016-06-29 13:54:25 -0400308/* Maximum number of page-sized "segments" per chunk list to be
309 * registered or invalidated. Must handle a Reply chunk:
310 */
311enum {
312 RPCRDMA_MAX_IOV_SEGS = 3,
313 RPCRDMA_MAX_DATA_SEGS = ((1 * 1024 * 1024) / PAGE_SIZE) + 1,
314 RPCRDMA_MAX_SEGS = RPCRDMA_MAX_DATA_SEGS +
315 RPCRDMA_MAX_IOV_SEGS,
316};
317
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400318struct rpcrdma_mr_seg { /* chunk descriptors */
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400319 u32 mr_len; /* length of chunk or segment */
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400320 struct page *mr_page; /* owning page, if any */
321 char *mr_offset; /* kva if no page, else offset */
322};
323
Chuck Leverc6f5b472017-02-08 17:00:18 -0500324/* The Send SGE array is provisioned to send a maximum size
325 * inline request:
Chuck Lever655fec62016-09-15 10:57:24 -0400326 * - RPC-over-RDMA header
327 * - xdr_buf head iovec
Chuck Leverc6f5b472017-02-08 17:00:18 -0500328 * - RPCRDMA_MAX_INLINE bytes, in pages
Chuck Lever655fec62016-09-15 10:57:24 -0400329 * - xdr_buf tail iovec
Chuck Leverc6f5b472017-02-08 17:00:18 -0500330 *
331 * The actual number of array elements consumed by each RPC
332 * depends on the device's max_sge limit.
Chuck Lever655fec62016-09-15 10:57:24 -0400333 */
334enum {
Chuck Lever16f906d2017-02-08 17:00:10 -0500335 RPCRDMA_MIN_SEND_SGES = 3,
Chuck Leverc6f5b472017-02-08 17:00:18 -0500336 RPCRDMA_MAX_PAGE_SGES = RPCRDMA_MAX_INLINE >> PAGE_SHIFT,
Chuck Lever655fec62016-09-15 10:57:24 -0400337 RPCRDMA_MAX_SEND_SGES = 1 + 1 + RPCRDMA_MAX_PAGE_SGES + 1,
338};
Chuck Leverb3221d62015-08-03 13:03:39 -0400339
Chuck Lever5ab81422016-06-29 13:54:25 -0400340struct rpcrdma_buffer;
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400341struct rpcrdma_req {
Chuck Levera80d66c2017-06-08 11:52:12 -0400342 struct list_head rl_list;
Chuck Lever431af642017-06-08 11:52:20 -0400343 __be32 rl_xid;
Chuck Lever655fec62016-09-15 10:57:24 -0400344 unsigned int rl_mapped_sges;
Chuck Leverb3221d62015-08-03 13:03:39 -0400345 unsigned int rl_connect_cookie;
346 struct rpcrdma_buffer *rl_buffer;
Chuck Lever90aab602016-09-15 10:56:43 -0400347 struct rpcrdma_rep *rl_reply;
Chuck Lever7a80f3f2017-08-10 12:47:28 -0400348 struct xdr_stream rl_stream;
349 struct xdr_buf rl_hdrbuf;
Chuck Lever90aab602016-09-15 10:56:43 -0400350 struct ib_send_wr rl_send_wr;
Chuck Lever655fec62016-09-15 10:57:24 -0400351 struct ib_sge rl_send_sge[RPCRDMA_MAX_SEND_SGES];
Chuck Lever9c40c492016-09-15 10:55:53 -0400352 struct rpcrdma_regbuf *rl_rdmabuf; /* xprt header */
353 struct rpcrdma_regbuf *rl_sendbuf; /* rq_snd_buf */
354 struct rpcrdma_regbuf *rl_recvbuf; /* rq_rcv_buf */
Chuck Leverf531a5d2015-10-24 17:27:43 -0400355
Chuck Lever2fa8f882016-03-04 11:28:53 -0500356 struct ib_cqe rl_cqe;
Chuck Leverf531a5d2015-10-24 17:27:43 -0400357 struct list_head rl_all;
358 bool rl_backchannel;
Chuck Lever5ab81422016-06-29 13:54:25 -0400359
360 struct list_head rl_registered; /* registered segments */
361 struct rpcrdma_mr_seg rl_segments[RPCRDMA_MAX_SEGS];
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400362};
Chuck Lever0ca77dc2015-01-21 11:04:08 -0500363
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 Lever1e465fd2015-10-24 17:27:02 -0400403 spinlock_t rb_lock; /* protect buf lists */
Chuck Lever05c97462016-09-06 11:22:58 -0400404 int rb_send_count, rb_recv_count;
Chuck Lever1e465fd2015-10-24 17:27:02 -0400405 struct list_head rb_send_bufs;
406 struct list_head rb_recv_bufs;
Chuck Lever431af642017-06-08 11:52:20 -0400407 struct list_head rb_pending;
Chuck Lever58d1dcf2015-05-26 11:53:13 -0400408 u32 rb_max_requests;
Chuck Lever23826c72016-03-04 11:28:27 -0500409 atomic_t rb_credits; /* most recent credit grant */
Chuck Leverf531a5d2015-10-24 17:27:43 -0400410
411 u32 rb_bc_srv_max_requests;
412 spinlock_t rb_reqslock; /* protect rb_allreqs */
413 struct list_head rb_allreqs;
Chuck Lever5d252f92016-01-07 14:50:10 -0500414
415 u32 rb_bc_max_requests;
Chuck Lever505bbe62016-06-29 13:52:54 -0400416
417 spinlock_t rb_recovery_lock; /* protect rb_stale_mrs */
418 struct list_head rb_stale_mrs;
419 struct delayed_work rb_recovery_worker;
Chuck Levere2ac2362016-06-29 13:54:00 -0400420 struct delayed_work rb_refresh_worker;
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400421};
422#define rdmab_to_ia(b) (&container_of((b), struct rpcrdma_xprt, rx_buf)->rx_ia)
423
424/*
425 * Internal structure for transport instance creation. This
426 * exists primarily for modularity.
427 *
428 * This data should be set with mount options
429 */
430struct rpcrdma_create_data_internal {
431 struct sockaddr_storage addr; /* RDMA server address */
432 unsigned int max_requests; /* max requests (slots) in flight */
433 unsigned int rsize; /* mount rsize - max read hdr+data */
434 unsigned int wsize; /* mount wsize - max write hdr+data */
435 unsigned int inline_rsize; /* max non-rdma read data payload */
436 unsigned int inline_wsize; /* max non-rdma write data payload */
437 unsigned int padding; /* non-rdma write header padding */
438};
439
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400440/*
441 * Statistics for RPCRDMA
442 */
443struct rpcrdma_stats {
444 unsigned long read_chunk_count;
445 unsigned long write_chunk_count;
446 unsigned long reply_chunk_count;
447
448 unsigned long long total_rdma_request;
449 unsigned long long total_rdma_reply;
450
451 unsigned long long pullup_copy_count;
452 unsigned long long fixup_copy_count;
453 unsigned long hardway_register_count;
454 unsigned long failed_marshal_count;
455 unsigned long bad_reply_count;
Chuck Lever860477d2015-08-03 13:04:45 -0400456 unsigned long nomsg_call_count;
Chuck Lever63cae472015-10-24 17:28:08 -0400457 unsigned long bcall_count;
Chuck Lever505bbe62016-06-29 13:52:54 -0400458 unsigned long mrs_recovered;
459 unsigned long mrs_orphaned;
Chuck Levere2ac2362016-06-29 13:54:00 -0400460 unsigned long mrs_allocated;
Chuck Leverc8b920b2016-09-15 10:57:16 -0400461 unsigned long local_inv_needed;
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400462};
463
464/*
Chuck Levera0ce85f2015-03-30 14:34:21 -0400465 * Per-registration mode operations
466 */
Chuck Lever1c9351e2015-03-30 14:34:30 -0400467struct rpcrdma_xprt;
Chuck Levera0ce85f2015-03-30 14:34:21 -0400468struct rpcrdma_memreg_ops {
Chuck Lever9c1b4d72015-03-30 14:34:39 -0400469 int (*ro_map)(struct rpcrdma_xprt *,
Chuck Lever9d6b0402016-06-29 13:54:16 -0400470 struct rpcrdma_mr_seg *, int, bool,
471 struct rpcrdma_mw **);
Chuck Lever32d0cee2015-12-16 17:22:39 -0500472 void (*ro_unmap_sync)(struct rpcrdma_xprt *,
Chuck Lever451d26e2017-06-08 11:52:04 -0400473 struct list_head *);
Chuck Leveread3f262016-05-02 14:42:46 -0400474 void (*ro_unmap_safe)(struct rpcrdma_xprt *,
475 struct rpcrdma_req *, bool);
Chuck Lever505bbe62016-06-29 13:52:54 -0400476 void (*ro_recover_mr)(struct rpcrdma_mw *);
Chuck Lever3968cb52015-03-30 14:35:26 -0400477 int (*ro_open)(struct rpcrdma_ia *,
478 struct rpcrdma_ep *,
479 struct rpcrdma_create_data_internal *);
Chuck Lever1c9351e2015-03-30 14:34:30 -0400480 size_t (*ro_maxpages)(struct rpcrdma_xprt *);
Chuck Levere2ac2362016-06-29 13:54:00 -0400481 int (*ro_init_mr)(struct rpcrdma_ia *,
482 struct rpcrdma_mw *);
483 void (*ro_release_mr)(struct rpcrdma_mw *);
Chuck Levera0ce85f2015-03-30 14:34:21 -0400484 const char *ro_displayname;
Chuck Leverc8b920b2016-09-15 10:57:16 -0400485 const int ro_send_w_inv_ok;
Chuck Levera0ce85f2015-03-30 14:34:21 -0400486};
487
488extern const struct rpcrdma_memreg_ops rpcrdma_fmr_memreg_ops;
489extern const struct rpcrdma_memreg_ops rpcrdma_frwr_memreg_ops;
Chuck Levera0ce85f2015-03-30 14:34:21 -0400490
491/*
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400492 * RPCRDMA transport -- encapsulates the structures above for
493 * integration with RPC.
494 *
495 * The contained structures are embedded, not pointers,
496 * for convenience. This structure need not be visible externally.
497 *
498 * It is allocated and initialized during mount, and released
499 * during unmount.
500 */
501struct rpcrdma_xprt {
Chuck Lever5abefb82015-01-21 11:02:37 -0500502 struct rpc_xprt rx_xprt;
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400503 struct rpcrdma_ia rx_ia;
504 struct rpcrdma_ep rx_ep;
505 struct rpcrdma_buffer rx_buf;
506 struct rpcrdma_create_data_internal rx_data;
Chuck Lever5abefb82015-01-21 11:02:37 -0500507 struct delayed_work rx_connect_worker;
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400508 struct rpcrdma_stats rx_stats;
509};
510
Chuck Lever5abefb82015-01-21 11:02:37 -0500511#define rpcx_to_rdmax(x) container_of(x, struct rpcrdma_xprt, rx_xprt)
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400512#define rpcx_to_rdmad(x) (rpcx_to_rdmax(x)->rx_data)
513
Tom Talpey9191ca32008-10-09 15:01:11 -0400514/* Setting this to 0 ensures interoperability with early servers.
515 * Setting this to 1 enhances certain unaligned read/write performance.
516 * Default is 0, see sysctl entry and rpc_rdma.c rpcrdma_convert_iovs() */
517extern int xprt_rdma_pad_optimize;
518
Chuck Leverfff09592017-04-11 13:22:54 -0400519/* This setting controls the hunt for a supported memory
520 * registration strategy.
521 */
522extern unsigned int xprt_rdma_memreg_strategy;
523
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400524/*
525 * Interface Adapter calls - xprtrdma/verbs.c
526 */
Chuck Leverfff09592017-04-11 13:22:54 -0400527int rpcrdma_ia_open(struct rpcrdma_xprt *xprt, struct sockaddr *addr);
Chuck Leverbebd0312017-04-11 13:23:10 -0400528void rpcrdma_ia_remove(struct rpcrdma_ia *ia);
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400529void rpcrdma_ia_close(struct rpcrdma_ia *);
Chuck Leverb54054c2016-06-29 13:53:27 -0400530bool frwr_is_supported(struct rpcrdma_ia *);
531bool fmr_is_supported(struct rpcrdma_ia *);
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400532
533/*
534 * Endpoint calls - xprtrdma/verbs.c
535 */
536int rpcrdma_ep_create(struct rpcrdma_ep *, struct rpcrdma_ia *,
537 struct rpcrdma_create_data_internal *);
Chuck Lever7f1d5412014-05-28 10:33:16 -0400538void rpcrdma_ep_destroy(struct rpcrdma_ep *, struct rpcrdma_ia *);
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400539int rpcrdma_ep_connect(struct rpcrdma_ep *, struct rpcrdma_ia *);
Chuck Lever3a72dc72016-11-29 10:53:37 -0500540void rpcrdma_conn_func(struct rpcrdma_ep *ep);
Chuck Lever282191c2014-07-29 17:25:55 -0400541void rpcrdma_ep_disconnect(struct rpcrdma_ep *, struct rpcrdma_ia *);
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400542
543int rpcrdma_ep_post(struct rpcrdma_ia *, struct rpcrdma_ep *,
544 struct rpcrdma_req *);
Chuck Leverb1573802016-09-15 10:56:35 -0400545int rpcrdma_ep_post_recv(struct rpcrdma_ia *, struct rpcrdma_rep *);
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400546
547/*
548 * Buffer calls - xprtrdma/verbs.c
549 */
Chuck Leverf531a5d2015-10-24 17:27:43 -0400550struct rpcrdma_req *rpcrdma_create_req(struct rpcrdma_xprt *);
551struct rpcrdma_rep *rpcrdma_create_rep(struct rpcrdma_xprt *);
Chuck Lever13650c22016-09-15 10:56:26 -0400552void rpcrdma_destroy_req(struct rpcrdma_req *);
Chuck Leverac920d02015-01-21 11:03:44 -0500553int rpcrdma_buffer_create(struct rpcrdma_xprt *);
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400554void rpcrdma_buffer_destroy(struct rpcrdma_buffer *);
555
Chuck Lever431af642017-06-08 11:52:20 -0400556static inline void
557rpcrdma_insert_req(struct rpcrdma_buffer *buffers, struct rpcrdma_req *req)
558{
559 spin_lock(&buffers->rb_lock);
560 if (list_empty(&req->rl_list))
561 list_add_tail(&req->rl_list, &buffers->rb_pending);
562 spin_unlock(&buffers->rb_lock);
563}
564
565static inline struct rpcrdma_req *
566rpcrdma_lookup_req_locked(struct rpcrdma_buffer *buffers, __be32 xid)
567{
568 struct rpcrdma_req *pos;
569
570 list_for_each_entry(pos, &buffers->rb_pending, rl_list)
571 if (pos->rl_xid == xid)
572 return pos;
573 return NULL;
574}
575
576static inline void
577rpcrdma_remove_req(struct rpcrdma_buffer *buffers, struct rpcrdma_req *req)
578{
579 spin_lock(&buffers->rb_lock);
580 list_del(&req->rl_list);
581 spin_unlock(&buffers->rb_lock);
582}
583
Chuck Lever346aa662015-05-26 11:52:06 -0400584struct rpcrdma_mw *rpcrdma_get_mw(struct rpcrdma_xprt *);
585void rpcrdma_put_mw(struct rpcrdma_xprt *, struct rpcrdma_mw *);
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400586struct rpcrdma_req *rpcrdma_buffer_get(struct rpcrdma_buffer *);
587void rpcrdma_buffer_put(struct rpcrdma_req *);
588void rpcrdma_recv_buffer_get(struct rpcrdma_req *);
589void rpcrdma_recv_buffer_put(struct rpcrdma_rep *);
590
Chuck Lever505bbe62016-06-29 13:52:54 -0400591void rpcrdma_defer_mr_recovery(struct rpcrdma_mw *);
592
Chuck Lever13650c22016-09-15 10:56:26 -0400593struct rpcrdma_regbuf *rpcrdma_alloc_regbuf(size_t, enum dma_data_direction,
Chuck Lever99ef4db2016-09-15 10:56:10 -0400594 gfp_t);
Chuck Lever54cbd6b2016-09-15 10:56:18 -0400595bool __rpcrdma_dma_map_regbuf(struct rpcrdma_ia *, struct rpcrdma_regbuf *);
Chuck Lever13650c22016-09-15 10:56:26 -0400596void rpcrdma_free_regbuf(struct rpcrdma_regbuf *);
Chuck Lever9128c3e2015-01-21 11:04:00 -0500597
Chuck Lever54cbd6b2016-09-15 10:56:18 -0400598static inline bool
599rpcrdma_regbuf_is_mapped(struct rpcrdma_regbuf *rb)
600{
601 return rb->rg_device != NULL;
602}
603
604static inline bool
605rpcrdma_dma_map_regbuf(struct rpcrdma_ia *ia, struct rpcrdma_regbuf *rb)
606{
607 if (likely(rpcrdma_regbuf_is_mapped(rb)))
608 return true;
609 return __rpcrdma_dma_map_regbuf(ia, rb);
610}
611
Chuck Leverf531a5d2015-10-24 17:27:43 -0400612int rpcrdma_ep_post_extra_recv(struct rpcrdma_xprt *, unsigned int);
Chuck Leverd6547882015-03-30 14:35:44 -0400613
Chuck Leverfe97b472015-10-24 17:27:10 -0400614int rpcrdma_alloc_wq(void);
615void rpcrdma_destroy_wq(void);
616
Chuck Leverd6547882015-03-30 14:35:44 -0400617/*
618 * Wrappers for chunk registration, shared by read/write chunk code.
619 */
620
Chuck Leverd6547882015-03-30 14:35:44 -0400621static inline enum dma_data_direction
622rpcrdma_data_dir(bool writing)
623{
624 return writing ? DMA_FROM_DEVICE : DMA_TO_DEVICE;
625}
626
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400627/*
\"Talpey, Thomas\f58851e2007-09-10 13:50:12 -0400628 * RPC/RDMA protocol calls - xprtrdma/rpc_rdma.c
629 */
Chuck Lever655fec62016-09-15 10:57:24 -0400630
631enum rpcrdma_chunktype {
632 rpcrdma_noch = 0,
633 rpcrdma_readch,
634 rpcrdma_areadch,
635 rpcrdma_writech,
636 rpcrdma_replych
637};
638
639bool rpcrdma_prepare_send_sges(struct rpcrdma_ia *, struct rpcrdma_req *,
640 u32, struct xdr_buf *, enum rpcrdma_chunktype);
641void rpcrdma_unmap_sges(struct rpcrdma_ia *, struct rpcrdma_req *);
Chuck Lever09e60642017-08-10 12:47:12 -0400642int rpcrdma_marshal_req(struct rpcrdma_xprt *r_xprt, struct rpc_rqst *rqst);
Chuck Lever87cfb9a2016-09-15 10:57:07 -0400643void rpcrdma_set_max_header_sizes(struct rpcrdma_xprt *);
Chuck Lever3a72dc72016-11-29 10:53:37 -0500644void rpcrdma_reply_handler(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 */