2 * Copyright (c) 2015 Oracle. All rights reserved.
4 * Support for backward direction RPCs on RPC/RDMA.
7 #include <linux/module.h>
8 #include <linux/sunrpc/xprt.h>
9 #include <linux/sunrpc/svc.h>
10 #include <linux/sunrpc/svc_xprt.h>
12 #include "xprt_rdma.h"
14 #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
15 # define RPCDBG_FACILITY RPCDBG_TRANS
18 #define RPCRDMA_BACKCHANNEL_DEBUG
20 static void rpcrdma_bc_free_rqst(struct rpcrdma_xprt *r_xprt,
21 struct rpc_rqst *rqst)
23 struct rpcrdma_buffer *buf = &r_xprt->rx_buf;
24 struct rpcrdma_req *req = rpcr_to_rdmar(rqst);
26 spin_lock(&buf->rb_reqslock);
27 list_del(&req->rl_all);
28 spin_unlock(&buf->rb_reqslock);
30 rpcrdma_destroy_req(&r_xprt->rx_ia, req);
35 static int rpcrdma_bc_setup_rqst(struct rpcrdma_xprt *r_xprt,
36 struct rpc_rqst *rqst)
38 struct rpcrdma_ia *ia = &r_xprt->rx_ia;
39 struct rpcrdma_regbuf *rb;
40 struct rpcrdma_req *req;
44 req = rpcrdma_create_req(r_xprt);
47 req->rl_backchannel = true;
49 size = RPCRDMA_INLINE_WRITE_THRESHOLD(rqst);
50 rb = rpcrdma_alloc_regbuf(ia, size, GFP_KERNEL);
55 size += RPCRDMA_INLINE_READ_THRESHOLD(rqst);
56 rb = rpcrdma_alloc_regbuf(ia, size, GFP_KERNEL);
61 /* so that rpcr_to_rdmar works when receiving a request */
62 rqst->rq_buffer = (void *)req->rl_sendbuf->rg_base;
64 buf = &rqst->rq_snd_buf;
65 buf->head[0].iov_base = rqst->rq_buffer;
66 buf->head[0].iov_len = 0;
67 buf->tail[0].iov_base = NULL;
68 buf->tail[0].iov_len = 0;
76 rpcrdma_bc_free_rqst(r_xprt, rqst);
80 /* Allocate and add receive buffers to the rpcrdma_buffer's
81 * existing list of rep's. These are released when the
82 * transport is destroyed.
84 static int rpcrdma_bc_setup_reps(struct rpcrdma_xprt *r_xprt,
90 rc = rpcrdma_create_rep(r_xprt);
98 * xprt_rdma_bc_setup - Pre-allocate resources for handling backchannel requests
99 * @xprt: transport associated with these backchannel resources
100 * @reqs: number of concurrent incoming requests to expect
102 * Returns 0 on success; otherwise a negative errno
104 int xprt_rdma_bc_setup(struct rpc_xprt *xprt, unsigned int reqs)
106 struct rpcrdma_xprt *r_xprt = rpcx_to_rdmax(xprt);
107 struct rpcrdma_buffer *buffer = &r_xprt->rx_buf;
108 struct rpc_rqst *rqst;
112 /* The backchannel reply path returns each rpc_rqst to the
113 * bc_pa_list _after_ the reply is sent. If the server is
114 * faster than the client, it can send another backward
115 * direction request before the rpc_rqst is returned to the
116 * list. The client rejects the request in this case.
118 * Twice as many rpc_rqsts are prepared to ensure there is
119 * always an rpc_rqst available as soon as a reply is sent.
121 if (reqs > RPCRDMA_BACKWARD_WRS >> 1)
124 for (i = 0; i < (reqs << 1); i++) {
125 rqst = kzalloc(sizeof(*rqst), GFP_KERNEL);
127 pr_err("RPC: %s: Failed to create bc rpc_rqst\n",
132 rqst->rq_xprt = &r_xprt->rx_xprt;
133 INIT_LIST_HEAD(&rqst->rq_list);
134 INIT_LIST_HEAD(&rqst->rq_bc_list);
136 if (rpcrdma_bc_setup_rqst(r_xprt, rqst))
139 spin_lock_bh(&xprt->bc_pa_lock);
140 list_add(&rqst->rq_bc_pa_list, &xprt->bc_pa_list);
141 spin_unlock_bh(&xprt->bc_pa_lock);
144 rc = rpcrdma_bc_setup_reps(r_xprt, reqs);
148 rc = rpcrdma_ep_post_extra_recv(r_xprt, reqs);
152 buffer->rb_bc_srv_max_requests = reqs;
153 request_module("svcrdma");
158 xprt_rdma_bc_destroy(xprt, reqs);
161 pr_err("RPC: %s: setup backchannel transport failed\n", __func__);
166 * xprt_rdma_bc_up - Create transport endpoint for backchannel service
167 * @serv: server endpoint
168 * @net: network namespace
170 * The "xprt" is an implied argument: it supplies the name of the
171 * backchannel transport class.
173 * Returns zero on success, negative errno on failure
175 int xprt_rdma_bc_up(struct svc_serv *serv, struct net *net)
179 ret = svc_create_xprt(serv, "rdma-bc", net, PF_INET, 0, 0);
186 * rpcrdma_bc_marshal_reply - Send backwards direction reply
187 * @rqst: buffer containing RPC reply data
189 * Returns zero on success.
191 int rpcrdma_bc_marshal_reply(struct rpc_rqst *rqst)
193 struct rpc_xprt *xprt = rqst->rq_xprt;
194 struct rpcrdma_xprt *r_xprt = rpcx_to_rdmax(xprt);
195 struct rpcrdma_req *req = rpcr_to_rdmar(rqst);
196 struct rpcrdma_msg *headerp;
199 headerp = rdmab_to_msg(req->rl_rdmabuf);
200 headerp->rm_xid = rqst->rq_xid;
201 headerp->rm_vers = rpcrdma_version;
203 cpu_to_be32(r_xprt->rx_buf.rb_bc_srv_max_requests);
204 headerp->rm_type = rdma_msg;
205 headerp->rm_body.rm_chunks[0] = xdr_zero;
206 headerp->rm_body.rm_chunks[1] = xdr_zero;
207 headerp->rm_body.rm_chunks[2] = xdr_zero;
209 rpclen = rqst->rq_svec[0].iov_len;
211 pr_info("RPC: %s: rpclen %zd headerp 0x%p lkey 0x%x\n",
212 __func__, rpclen, headerp, rdmab_lkey(req->rl_rdmabuf));
213 pr_info("RPC: %s: RPC/RDMA: %*ph\n",
214 __func__, (int)RPCRDMA_HDRLEN_MIN, headerp);
215 pr_info("RPC: %s: RPC: %*ph\n",
216 __func__, (int)rpclen, rqst->rq_svec[0].iov_base);
218 req->rl_send_iov[0].addr = rdmab_addr(req->rl_rdmabuf);
219 req->rl_send_iov[0].length = RPCRDMA_HDRLEN_MIN;
220 req->rl_send_iov[0].lkey = rdmab_lkey(req->rl_rdmabuf);
222 req->rl_send_iov[1].addr = rdmab_addr(req->rl_sendbuf);
223 req->rl_send_iov[1].length = rpclen;
224 req->rl_send_iov[1].lkey = rdmab_lkey(req->rl_sendbuf);
231 * xprt_rdma_bc_destroy - Release resources for handling backchannel requests
232 * @xprt: transport associated with these backchannel resources
233 * @reqs: number of incoming requests to destroy; ignored
235 void xprt_rdma_bc_destroy(struct rpc_xprt *xprt, unsigned int reqs)
237 struct rpcrdma_xprt *r_xprt = rpcx_to_rdmax(xprt);
238 struct rpc_rqst *rqst, *tmp;
240 spin_lock_bh(&xprt->bc_pa_lock);
241 list_for_each_entry_safe(rqst, tmp, &xprt->bc_pa_list, rq_bc_pa_list) {
242 list_del(&rqst->rq_bc_pa_list);
243 spin_unlock_bh(&xprt->bc_pa_lock);
245 rpcrdma_bc_free_rqst(r_xprt, rqst);
247 spin_lock_bh(&xprt->bc_pa_lock);
249 spin_unlock_bh(&xprt->bc_pa_lock);
253 * xprt_rdma_bc_free_rqst - Release a backchannel rqst
254 * @rqst: request to release
256 void xprt_rdma_bc_free_rqst(struct rpc_rqst *rqst)
258 struct rpc_xprt *xprt = rqst->rq_xprt;
260 smp_mb__before_atomic();
261 WARN_ON_ONCE(!test_bit(RPC_BC_PA_IN_USE, &rqst->rq_bc_pa_state));
262 clear_bit(RPC_BC_PA_IN_USE, &rqst->rq_bc_pa_state);
263 smp_mb__after_atomic();
265 spin_lock_bh(&xprt->bc_pa_lock);
266 list_add_tail(&rqst->rq_bc_pa_list, &xprt->bc_pa_list);
267 spin_unlock_bh(&xprt->bc_pa_lock);
271 * rpcrdma_bc_receive_call - Handle a backward direction call
272 * @xprt: transport receiving the call
273 * @rep: receive buffer containing the call
275 * Called in the RPC reply handler, which runs in a tasklet.
278 * Operational assumptions:
279 * o Backchannel credits are ignored, just as the NFS server
280 * forechannel currently does
281 * o The ULP manages a replay cache (eg, NFSv4.1 sessions).
282 * No replay detection is done at the transport level
284 void rpcrdma_bc_receive_call(struct rpcrdma_xprt *r_xprt,
285 struct rpcrdma_rep *rep)
287 struct rpc_xprt *xprt = &r_xprt->rx_xprt;
288 struct rpcrdma_msg *headerp;
289 struct svc_serv *bc_serv;
290 struct rpcrdma_req *req;
291 struct rpc_rqst *rqst;
296 headerp = rdmab_to_msg(rep->rr_rdmabuf);
297 #ifdef RPCRDMA_BACKCHANNEL_DEBUG
298 pr_info("RPC: %s: callback XID %08x, length=%u\n",
299 __func__, be32_to_cpu(headerp->rm_xid), rep->rr_len);
300 pr_info("RPC: %s: %*ph\n", __func__, rep->rr_len, headerp);
304 * Need at least enough bytes for RPC/RDMA header, as code
305 * here references the header fields by array offset. Also,
306 * backward calls are always inline, so ensure there
307 * are some bytes beyond the RPC/RDMA header.
309 if (rep->rr_len < RPCRDMA_HDRLEN_MIN + 24)
311 p = (__be32 *)((unsigned char *)headerp + RPCRDMA_HDRLEN_MIN);
312 size = rep->rr_len - RPCRDMA_HDRLEN_MIN;
314 /* Grab a free bc rqst */
315 spin_lock(&xprt->bc_pa_lock);
316 if (list_empty(&xprt->bc_pa_list)) {
317 spin_unlock(&xprt->bc_pa_lock);
320 rqst = list_first_entry(&xprt->bc_pa_list,
321 struct rpc_rqst, rq_bc_pa_list);
322 list_del(&rqst->rq_bc_pa_list);
323 spin_unlock(&xprt->bc_pa_lock);
324 #ifdef RPCRDMA_BACKCHANNEL_DEBUG
325 pr_info("RPC: %s: using rqst %p\n", __func__, rqst);
329 rqst->rq_reply_bytes_recvd = 0;
330 rqst->rq_bytes_sent = 0;
331 rqst->rq_xid = headerp->rm_xid;
333 rqst->rq_private_buf.len = size;
334 set_bit(RPC_BC_PA_IN_USE, &rqst->rq_bc_pa_state);
336 buf = &rqst->rq_rcv_buf;
337 memset(buf, 0, sizeof(*buf));
338 buf->head[0].iov_base = p;
339 buf->head[0].iov_len = size;
342 /* The receive buffer has to be hooked to the rpcrdma_req
343 * so that it can be reposted after the server is done
344 * parsing it but just before sending the backward
347 req = rpcr_to_rdmar(rqst);
348 #ifdef RPCRDMA_BACKCHANNEL_DEBUG
349 pr_info("RPC: %s: attaching rep %p to req %p\n",
354 /* Defeat the retransmit detection logic in send_request */
355 req->rl_connect_cookie = 0;
357 /* Queue rqst for ULP's callback service */
358 bc_serv = xprt->bc_serv;
359 spin_lock(&bc_serv->sv_cb_lock);
360 list_add(&rqst->rq_bc_list, &bc_serv->sv_cb_list);
361 spin_unlock(&bc_serv->sv_cb_lock);
363 wake_up(&bc_serv->sv_cb_waitq);
365 r_xprt->rx_stats.bcall_count++;
369 pr_warn("RPC/RDMA backchannel overflow\n");
370 xprt_disconnect_done(xprt);
371 /* This receive buffer gets reposted automatically
372 * when the connection is re-established.
377 pr_warn("RPC/RDMA short backward direction call\n");
379 if (rpcrdma_ep_post_recv(&r_xprt->rx_ia, &r_xprt->rx_ep, rep))
380 xprt_disconnect_done(xprt);
382 pr_warn("RPC: %s: reposting rep %p\n",