2 * Copyright (c) 2014 Open Grid Computing, Inc. All rights reserved.
3 * Copyright (c) 2005-2006 Network Appliance, Inc. All rights reserved.
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
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
15 * Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
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.
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
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.
40 * Author: Tom Tucker <tom@opengridcomputing.com>
43 #include <linux/sunrpc/debug.h>
44 #include <linux/sunrpc/rpc_rdma.h>
45 #include <linux/spinlock.h>
46 #include <asm/unaligned.h>
47 #include <rdma/ib_verbs.h>
48 #include <rdma/rdma_cm.h>
49 #include <linux/sunrpc/svc_rdma.h>
51 #define RPCDBG_FACILITY RPCDBG_SVCXPRT
53 static u32
xdr_padsize(u32 len
)
55 return (len
& 3) ? (4 - (len
& 3)) : 0;
58 int svc_rdma_map_xdr(struct svcxprt_rdma
*xprt
,
60 struct svc_rdma_req_map
*vec
,
61 bool write_chunk_present
)
70 (xdr
->head
[0].iov_len
+ xdr
->page_len
+ xdr
->tail
[0].iov_len
)) {
71 pr_err("svcrdma: %s: XDR buffer length error\n", __func__
);
75 /* Skip the first sge, this is for the RPCRDMA header */
79 vec
->sge
[sge_no
].iov_base
= xdr
->head
[0].iov_base
;
80 vec
->sge
[sge_no
].iov_len
= xdr
->head
[0].iov_len
;
85 page_bytes
= xdr
->page_len
;
86 page_off
= xdr
->page_base
;
88 vec
->sge
[sge_no
].iov_base
=
89 page_address(xdr
->pages
[page_no
]) + page_off
;
90 sge_bytes
= min_t(u32
, page_bytes
, (PAGE_SIZE
- page_off
));
91 page_bytes
-= sge_bytes
;
92 vec
->sge
[sge_no
].iov_len
= sge_bytes
;
96 page_off
= 0; /* reset for next time through loop */
100 if (xdr
->tail
[0].iov_len
) {
101 unsigned char *base
= xdr
->tail
[0].iov_base
;
102 size_t len
= xdr
->tail
[0].iov_len
;
103 u32 xdr_pad
= xdr_padsize(xdr
->page_len
);
105 if (write_chunk_present
&& xdr_pad
) {
111 vec
->sge
[sge_no
].iov_base
= base
;
112 vec
->sge
[sge_no
].iov_len
= len
;
117 dprintk("svcrdma: %s: sge_no %d page_no %d "
118 "page_base %u page_len %u head_len %zu tail_len %zu\n",
119 __func__
, sge_no
, page_no
, xdr
->page_base
, xdr
->page_len
,
120 xdr
->head
[0].iov_len
, xdr
->tail
[0].iov_len
);
126 static dma_addr_t
dma_map_xdr(struct svcxprt_rdma
*xprt
,
128 u32 xdr_off
, size_t len
, int dir
)
132 if (xdr_off
< xdr
->head
[0].iov_len
) {
133 /* This offset is in the head */
134 xdr_off
+= (unsigned long)xdr
->head
[0].iov_base
& ~PAGE_MASK
;
135 page
= virt_to_page(xdr
->head
[0].iov_base
);
137 xdr_off
-= xdr
->head
[0].iov_len
;
138 if (xdr_off
< xdr
->page_len
) {
139 /* This offset is in the page list */
140 xdr_off
+= xdr
->page_base
;
141 page
= xdr
->pages
[xdr_off
>> PAGE_SHIFT
];
142 xdr_off
&= ~PAGE_MASK
;
144 /* This offset is in the tail */
145 xdr_off
-= xdr
->page_len
;
146 xdr_off
+= (unsigned long)
147 xdr
->tail
[0].iov_base
& ~PAGE_MASK
;
148 page
= virt_to_page(xdr
->tail
[0].iov_base
);
151 dma_addr
= ib_dma_map_page(xprt
->sc_cm_id
->device
, page
, xdr_off
,
152 min_t(size_t, PAGE_SIZE
, len
), dir
);
156 /* Parse the RPC Call's transport header.
158 static void svc_rdma_get_write_arrays(struct rpcrdma_msg
*rmsgp
,
159 struct rpcrdma_write_array
**write
,
160 struct rpcrdma_write_array
**reply
)
164 p
= (__be32
*)&rmsgp
->rm_body
.rm_chunks
[0];
167 while (*p
++ != xdr_zero
)
171 if (*p
!= xdr_zero
) {
172 *write
= (struct rpcrdma_write_array
*)p
;
173 while (*p
++ != xdr_zero
)
174 p
+= 1 + be32_to_cpu(*p
) * 4;
182 *reply
= (struct rpcrdma_write_array
*)p
;
187 /* RPC-over-RDMA Version One private extension: Remote Invalidation.
188 * Responder's choice: requester signals it can handle Send With
189 * Invalidate, and responder chooses one rkey to invalidate.
191 * Find a candidate rkey to invalidate when sending a reply. Picks the
192 * first rkey it finds in the chunks lists.
194 * Returns zero if RPC's chunk lists are empty.
196 static u32
svc_rdma_get_inv_rkey(struct rpcrdma_msg
*rdma_argp
,
197 struct rpcrdma_write_array
*wr_ary
,
198 struct rpcrdma_write_array
*rp_ary
)
200 struct rpcrdma_read_chunk
*rd_ary
;
201 struct rpcrdma_segment
*arg_ch
;
203 rd_ary
= (struct rpcrdma_read_chunk
*)&rdma_argp
->rm_body
.rm_chunks
[0];
204 if (rd_ary
->rc_discrim
!= xdr_zero
)
205 return be32_to_cpu(rd_ary
->rc_target
.rs_handle
);
207 if (wr_ary
&& be32_to_cpu(wr_ary
->wc_nchunks
)) {
208 arg_ch
= &wr_ary
->wc_array
[0].wc_target
;
209 return be32_to_cpu(arg_ch
->rs_handle
);
212 if (rp_ary
&& be32_to_cpu(rp_ary
->wc_nchunks
)) {
213 arg_ch
= &rp_ary
->wc_array
[0].wc_target
;
214 return be32_to_cpu(arg_ch
->rs_handle
);
221 * - The specified write_len can be represented in sc_max_sge * PAGE_SIZE
223 static int send_write(struct svcxprt_rdma
*xprt
, struct svc_rqst
*rqstp
,
225 u32 xdr_off
, int write_len
,
226 struct svc_rdma_req_map
*vec
)
228 struct ib_rdma_wr write_wr
;
235 struct svc_rdma_op_ctxt
*ctxt
;
237 if (vec
->count
> RPCSVC_MAXPAGES
) {
238 pr_err("svcrdma: Too many pages (%lu)\n", vec
->count
);
242 dprintk("svcrdma: RDMA_WRITE rmr=%x, to=%llx, xdr_off=%d, "
243 "write_len=%d, vec->sge=%p, vec->count=%lu\n",
244 rmr
, (unsigned long long)to
, xdr_off
,
245 write_len
, vec
->sge
, vec
->count
);
247 ctxt
= svc_rdma_get_context(xprt
);
248 ctxt
->direction
= DMA_TO_DEVICE
;
251 /* Find the SGE associated with xdr_off */
252 for (bc
= xdr_off
, xdr_sge_no
= 1; bc
&& xdr_sge_no
< vec
->count
;
254 if (vec
->sge
[xdr_sge_no
].iov_len
> bc
)
256 bc
-= vec
->sge
[xdr_sge_no
].iov_len
;
263 /* Copy the remaining SGE */
265 sge_bytes
= min_t(size_t,
266 bc
, vec
->sge
[xdr_sge_no
].iov_len
-sge_off
);
267 sge
[sge_no
].length
= sge_bytes
;
269 dma_map_xdr(xprt
, &rqstp
->rq_res
, xdr_off
,
270 sge_bytes
, DMA_TO_DEVICE
);
271 xdr_off
+= sge_bytes
;
272 if (ib_dma_mapping_error(xprt
->sc_cm_id
->device
,
275 svc_rdma_count_mappings(xprt
, ctxt
);
276 sge
[sge_no
].lkey
= xprt
->sc_pd
->local_dma_lkey
;
281 if (xdr_sge_no
> vec
->count
) {
282 pr_err("svcrdma: Too many sges (%d)\n", xdr_sge_no
);
286 if (sge_no
== xprt
->sc_max_sge
)
290 /* Prepare WRITE WR */
291 memset(&write_wr
, 0, sizeof write_wr
);
292 ctxt
->cqe
.done
= svc_rdma_wc_write
;
293 write_wr
.wr
.wr_cqe
= &ctxt
->cqe
;
294 write_wr
.wr
.sg_list
= &sge
[0];
295 write_wr
.wr
.num_sge
= sge_no
;
296 write_wr
.wr
.opcode
= IB_WR_RDMA_WRITE
;
297 write_wr
.wr
.send_flags
= IB_SEND_SIGNALED
;
299 write_wr
.remote_addr
= to
;
302 atomic_inc(&rdma_stat_write
);
303 if (svc_rdma_send(xprt
, &write_wr
.wr
))
305 return write_len
- bc
;
307 svc_rdma_unmap_dma(ctxt
);
308 svc_rdma_put_context(ctxt
, 0);
313 static int send_write_chunks(struct svcxprt_rdma
*xprt
,
314 struct rpcrdma_write_array
*wr_ary
,
315 struct rpcrdma_msg
*rdma_resp
,
316 struct svc_rqst
*rqstp
,
317 struct svc_rdma_req_map
*vec
)
319 u32 xfer_len
= rqstp
->rq_res
.page_len
;
325 struct rpcrdma_write_array
*res_ary
;
328 res_ary
= (struct rpcrdma_write_array
*)
329 &rdma_resp
->rm_body
.rm_chunks
[1];
331 /* Write chunks start at the pagelist */
332 nchunks
= be32_to_cpu(wr_ary
->wc_nchunks
);
333 for (xdr_off
= rqstp
->rq_res
.head
[0].iov_len
, chunk_no
= 0;
334 xfer_len
&& chunk_no
< nchunks
;
336 struct rpcrdma_segment
*arg_ch
;
339 arg_ch
= &wr_ary
->wc_array
[chunk_no
].wc_target
;
340 write_len
= min(xfer_len
, be32_to_cpu(arg_ch
->rs_length
));
342 /* Prepare the response chunk given the length actually
344 xdr_decode_hyper((__be32
*)&arg_ch
->rs_offset
, &rs_offset
);
345 svc_rdma_xdr_encode_array_chunk(res_ary
, chunk_no
,
351 ret
= send_write(xprt
, rqstp
,
352 be32_to_cpu(arg_ch
->rs_handle
),
353 rs_offset
+ chunk_off
,
365 /* Update the req with the number of chunks actually used */
366 svc_rdma_xdr_encode_write_list(rdma_resp
, chunk_no
);
368 return rqstp
->rq_res
.page_len
;
371 pr_err("svcrdma: failed to send write chunks, rc=%d\n", ret
);
376 static int send_reply_chunks(struct svcxprt_rdma
*xprt
,
377 struct rpcrdma_write_array
*rp_ary
,
378 struct rpcrdma_msg
*rdma_resp
,
379 struct svc_rqst
*rqstp
,
380 struct svc_rdma_req_map
*vec
)
382 u32 xfer_len
= rqstp
->rq_res
.len
;
388 struct rpcrdma_segment
*ch
;
389 struct rpcrdma_write_array
*res_ary
;
392 /* XXX: need to fix when reply lists occur with read-list and or
394 res_ary
= (struct rpcrdma_write_array
*)
395 &rdma_resp
->rm_body
.rm_chunks
[2];
397 /* xdr offset starts at RPC message */
398 nchunks
= be32_to_cpu(rp_ary
->wc_nchunks
);
399 for (xdr_off
= 0, chunk_no
= 0;
400 xfer_len
&& chunk_no
< nchunks
;
403 ch
= &rp_ary
->wc_array
[chunk_no
].wc_target
;
404 write_len
= min(xfer_len
, be32_to_cpu(ch
->rs_length
));
406 /* Prepare the reply chunk given the length actually
408 xdr_decode_hyper((__be32
*)&ch
->rs_offset
, &rs_offset
);
409 svc_rdma_xdr_encode_array_chunk(res_ary
, chunk_no
,
410 ch
->rs_handle
, ch
->rs_offset
,
414 ret
= send_write(xprt
, rqstp
,
415 be32_to_cpu(ch
->rs_handle
),
416 rs_offset
+ chunk_off
,
428 /* Update the req with the number of chunks actually used */
429 svc_rdma_xdr_encode_reply_array(res_ary
, chunk_no
);
431 return rqstp
->rq_res
.len
;
434 pr_err("svcrdma: failed to send reply chunks, rc=%d\n", ret
);
438 /* This function prepares the portion of the RPCRDMA message to be
439 * sent in the RDMA_SEND. This function is called after data sent via
440 * RDMA has already been transmitted. There are three cases:
441 * - The RPCRDMA header, RPC header, and payload are all sent in a
442 * single RDMA_SEND. This is the "inline" case.
443 * - The RPCRDMA header and some portion of the RPC header and data
444 * are sent via this RDMA_SEND and another portion of the data is
446 * - The RPCRDMA header [NOMSG] is sent in this RDMA_SEND and the RPC
447 * header and data are all transmitted via RDMA.
448 * In all three cases, this function prepares the RPCRDMA header in
449 * sge[0], the 'type' parameter indicates the type to place in the
450 * RPCRDMA header, and the 'byte_count' field indicates how much of
451 * the XDR to include in this RDMA_SEND. NB: The offset of the payload
452 * to send is zero in the XDR.
454 static int send_reply(struct svcxprt_rdma
*rdma
,
455 struct svc_rqst
*rqstp
,
457 struct rpcrdma_msg
*rdma_resp
,
458 struct svc_rdma_req_map
*vec
,
462 struct svc_rdma_op_ctxt
*ctxt
;
463 struct ib_send_wr send_wr
;
471 /* Prepare the context */
472 ctxt
= svc_rdma_get_context(rdma
);
473 ctxt
->direction
= DMA_TO_DEVICE
;
474 ctxt
->pages
[0] = page
;
477 /* Prepare the SGE for the RPCRDMA Header */
478 ctxt
->sge
[0].lkey
= rdma
->sc_pd
->local_dma_lkey
;
479 ctxt
->sge
[0].length
= svc_rdma_xdr_get_reply_hdr_len(rdma_resp
);
481 ib_dma_map_page(rdma
->sc_cm_id
->device
, page
, 0,
482 ctxt
->sge
[0].length
, DMA_TO_DEVICE
);
483 if (ib_dma_mapping_error(rdma
->sc_cm_id
->device
, ctxt
->sge
[0].addr
))
485 svc_rdma_count_mappings(rdma
, ctxt
);
487 ctxt
->direction
= DMA_TO_DEVICE
;
489 /* Map the payload indicated by 'byte_count' */
491 for (sge_no
= 1; byte_count
&& sge_no
< vec
->count
; sge_no
++) {
492 sge_bytes
= min_t(size_t, vec
->sge
[sge_no
].iov_len
, byte_count
);
493 byte_count
-= sge_bytes
;
494 ctxt
->sge
[sge_no
].addr
=
495 dma_map_xdr(rdma
, &rqstp
->rq_res
, xdr_off
,
496 sge_bytes
, DMA_TO_DEVICE
);
497 xdr_off
+= sge_bytes
;
498 if (ib_dma_mapping_error(rdma
->sc_cm_id
->device
,
499 ctxt
->sge
[sge_no
].addr
))
501 svc_rdma_count_mappings(rdma
, ctxt
);
502 ctxt
->sge
[sge_no
].lkey
= rdma
->sc_pd
->local_dma_lkey
;
503 ctxt
->sge
[sge_no
].length
= sge_bytes
;
505 if (byte_count
!= 0) {
506 pr_err("svcrdma: Could not map %d bytes\n", byte_count
);
510 /* Save all respages in the ctxt and remove them from the
511 * respages array. They are our pages until the I/O
514 pages
= rqstp
->rq_next_page
- rqstp
->rq_respages
;
515 for (page_no
= 0; page_no
< pages
; page_no
++) {
516 ctxt
->pages
[page_no
+1] = rqstp
->rq_respages
[page_no
];
518 rqstp
->rq_respages
[page_no
] = NULL
;
520 rqstp
->rq_next_page
= rqstp
->rq_respages
+ 1;
522 if (sge_no
> rdma
->sc_max_sge
) {
523 pr_err("svcrdma: Too many sges (%d)\n", sge_no
);
526 memset(&send_wr
, 0, sizeof send_wr
);
527 ctxt
->cqe
.done
= svc_rdma_wc_send
;
528 send_wr
.wr_cqe
= &ctxt
->cqe
;
529 send_wr
.sg_list
= ctxt
->sge
;
530 send_wr
.num_sge
= sge_no
;
532 send_wr
.opcode
= IB_WR_SEND_WITH_INV
;
533 send_wr
.ex
.invalidate_rkey
= inv_rkey
;
535 send_wr
.opcode
= IB_WR_SEND
;
536 send_wr
.send_flags
= IB_SEND_SIGNALED
;
538 ret
= svc_rdma_send(rdma
, &send_wr
);
545 svc_rdma_unmap_dma(ctxt
);
546 svc_rdma_put_context(ctxt
, 1);
550 void svc_rdma_prep_reply_hdr(struct svc_rqst
*rqstp
)
554 int svc_rdma_sendto(struct svc_rqst
*rqstp
)
556 struct svc_xprt
*xprt
= rqstp
->rq_xprt
;
557 struct svcxprt_rdma
*rdma
=
558 container_of(xprt
, struct svcxprt_rdma
, sc_xprt
);
559 struct rpcrdma_msg
*rdma_argp
;
560 struct rpcrdma_msg
*rdma_resp
;
561 struct rpcrdma_write_array
*wr_ary
, *rp_ary
;
562 enum rpcrdma_proc reply_type
;
565 struct page
*res_page
;
566 struct svc_rdma_req_map
*vec
;
569 dprintk("svcrdma: sending response for rqstp=%p\n", rqstp
);
571 /* Get the RDMA request header. The receive logic always
572 * places this at the start of page 0.
574 rdma_argp
= page_address(rqstp
->rq_pages
[0]);
575 svc_rdma_get_write_arrays(rdma_argp
, &wr_ary
, &rp_ary
);
578 if (rdma
->sc_snd_w_inv
)
579 inv_rkey
= svc_rdma_get_inv_rkey(rdma_argp
, wr_ary
, rp_ary
);
581 /* Build an req vec for the XDR */
582 vec
= svc_rdma_get_req_map(rdma
);
583 ret
= svc_rdma_map_xdr(rdma
, &rqstp
->rq_res
, vec
, wr_ary
!= NULL
);
586 inline_bytes
= rqstp
->rq_res
.len
;
588 /* Create the RDMA response header. xprt->xpt_mutex,
589 * acquired in svc_send(), serializes RPC replies. The
590 * code path below that inserts the credit grant value
591 * into each transport header runs only inside this
595 res_page
= alloc_page(GFP_KERNEL
);
598 rdma_resp
= page_address(res_page
);
600 reply_type
= RDMA_NOMSG
;
602 reply_type
= RDMA_MSG
;
603 svc_rdma_xdr_encode_reply_header(rdma
, rdma_argp
,
604 rdma_resp
, reply_type
);
606 /* Send any write-chunk data and build resp write-list */
608 ret
= send_write_chunks(rdma
, wr_ary
, rdma_resp
, rqstp
, vec
);
611 inline_bytes
-= ret
+ xdr_padsize(ret
);
614 /* Send any reply-list data and update resp reply-list */
616 ret
= send_reply_chunks(rdma
, rp_ary
, rdma_resp
, rqstp
, vec
);
622 /* Post a fresh Receive buffer _before_ sending the reply */
623 ret
= svc_rdma_post_recv(rdma
, GFP_KERNEL
);
627 ret
= send_reply(rdma
, rqstp
, res_page
, rdma_resp
, vec
,
628 inline_bytes
, inv_rkey
);
632 svc_rdma_put_req_map(rdma
, vec
);
633 dprintk("svcrdma: send_reply returns %d\n", ret
);
639 svc_rdma_put_req_map(rdma
, vec
);
640 pr_err("svcrdma: Could not send reply, err=%d. Closing transport.\n",
642 set_bit(XPT_CLOSE
, &rdma
->sc_xprt
.xpt_flags
);
646 void svc_rdma_send_error(struct svcxprt_rdma
*xprt
, struct rpcrdma_msg
*rmsgp
,
649 struct ib_send_wr err_wr
;
651 struct svc_rdma_op_ctxt
*ctxt
;
652 enum rpcrdma_errcode err
;
657 ret
= svc_rdma_repost_recv(xprt
, GFP_KERNEL
);
661 p
= alloc_page(GFP_KERNEL
);
664 va
= page_address(p
);
666 /* XDR encode an error reply */
668 if (status
== -EPROTONOSUPPORT
)
670 length
= svc_rdma_xdr_encode_error(xprt
, rmsgp
, err
, va
);
672 ctxt
= svc_rdma_get_context(xprt
);
673 ctxt
->direction
= DMA_TO_DEVICE
;
677 /* Prepare SGE for local address */
678 ctxt
->sge
[0].lkey
= xprt
->sc_pd
->local_dma_lkey
;
679 ctxt
->sge
[0].length
= length
;
680 ctxt
->sge
[0].addr
= ib_dma_map_page(xprt
->sc_cm_id
->device
,
681 p
, 0, length
, DMA_TO_DEVICE
);
682 if (ib_dma_mapping_error(xprt
->sc_cm_id
->device
, ctxt
->sge
[0].addr
)) {
683 dprintk("svcrdma: Error mapping buffer for protocol error\n");
684 svc_rdma_put_context(ctxt
, 1);
687 svc_rdma_count_mappings(xprt
, ctxt
);
689 /* Prepare SEND WR */
690 memset(&err_wr
, 0, sizeof(err_wr
));
691 ctxt
->cqe
.done
= svc_rdma_wc_send
;
692 err_wr
.wr_cqe
= &ctxt
->cqe
;
693 err_wr
.sg_list
= ctxt
->sge
;
695 err_wr
.opcode
= IB_WR_SEND
;
696 err_wr
.send_flags
= IB_SEND_SIGNALED
;
699 ret
= svc_rdma_send(xprt
, &err_wr
);
701 dprintk("svcrdma: Error %d posting send for protocol error\n",
703 svc_rdma_unmap_dma(ctxt
);
704 svc_rdma_put_context(ctxt
, 1);