1 /* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */
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>
45 #include <linux/llist.h>
46 #include <linux/sunrpc/xdr.h>
47 #include <linux/sunrpc/svcsock.h>
48 #include <linux/sunrpc/rpc_rdma.h>
49 #include <linux/sunrpc/rpc_rdma_cid.h>
50 #include <linux/sunrpc/svc_rdma_pcl.h>
52 #include <linux/percpu_counter.h>
53 #include <rdma/ib_verbs.h>
54 #include <rdma/rdma_cm.h>
56 /* Default and maximum inline threshold sizes */
58 RPCRDMA_PULLUP_THRESH = RPCRDMA_V1_DEF_INLINE_SIZE >> 1,
59 RPCRDMA_DEF_INLINE_THRESH = 4096,
60 RPCRDMA_MAX_INLINE_THRESH = 65536
63 /* RPC/RDMA parameters and stats */
64 extern unsigned int svcrdma_ord;
65 extern unsigned int svcrdma_max_requests;
66 extern unsigned int svcrdma_max_bc_requests;
67 extern unsigned int svcrdma_max_req_size;
69 extern struct percpu_counter svcrdma_stat_read;
70 extern struct percpu_counter svcrdma_stat_recv;
71 extern struct percpu_counter svcrdma_stat_sq_starve;
72 extern struct percpu_counter svcrdma_stat_write;
75 struct svc_xprt sc_xprt; /* SVC transport structure */
76 struct rdma_cm_id *sc_cm_id; /* RDMA connection id */
77 struct list_head sc_accept_q; /* Conn. waiting accept */
78 int sc_ord; /* RDMA read limit */
80 bool sc_snd_w_inv; /* OK to use Send With Invalidate */
82 atomic_t sc_sq_avail; /* SQEs ready to be consumed */
83 unsigned int sc_sq_depth; /* Depth of SQ */
84 __be32 sc_fc_credits; /* Forward credits */
85 u32 sc_max_requests; /* Max requests */
86 u32 sc_max_bc_requests;/* Backward credits */
87 int sc_max_req_size; /* Size of each RQ WR buf */
92 spinlock_t sc_send_lock;
93 struct list_head sc_send_ctxts;
94 spinlock_t sc_rw_ctxt_lock;
95 struct list_head sc_rw_ctxts;
99 struct list_head sc_rq_dto_q;
100 spinlock_t sc_rq_dto_lock;
102 struct ib_cq *sc_rq_cq;
103 struct ib_cq *sc_sq_cq;
105 spinlock_t sc_lock; /* transport lock */
107 wait_queue_head_t sc_send_wait; /* SQ exhaustion waitlist */
108 unsigned long sc_flags;
109 struct list_head sc_read_complete_q;
110 struct work_struct sc_work;
112 struct llist_head sc_recv_ctxts;
114 atomic_t sc_completion_ids;
117 #define RDMAXPRT_CONN_PENDING 3
120 * Default connection parameters
123 RPCRDMA_LISTEN_BACKLOG = 10,
124 RPCRDMA_MAX_REQUESTS = 64,
125 RPCRDMA_MAX_BC_REQUESTS = 2,
128 #define RPCSVC_MAXPAYLOAD_RDMA RPCSVC_MAXPAYLOAD
130 struct svc_rdma_recv_ctxt {
131 struct llist_node rc_node;
132 struct list_head rc_list;
133 struct ib_recv_wr rc_recv_wr;
134 struct ib_cqe rc_cqe;
135 struct rpc_rdma_cid rc_cid;
136 struct ib_sge rc_recv_sge;
138 struct xdr_buf rc_arg;
139 struct xdr_stream rc_stream;
142 unsigned int rc_page_count;
143 unsigned int rc_hdr_count;
147 struct svc_rdma_pcl rc_call_pcl;
149 struct svc_rdma_pcl rc_read_pcl;
150 struct svc_rdma_chunk *rc_cur_result_payload;
151 struct svc_rdma_pcl rc_write_pcl;
152 struct svc_rdma_pcl rc_reply_pcl;
154 struct page *rc_pages[RPCSVC_MAXPAGES];
157 struct svc_rdma_send_ctxt {
158 struct list_head sc_list;
159 struct rpc_rdma_cid sc_cid;
161 struct ib_send_wr sc_send_wr;
162 struct ib_cqe sc_cqe;
163 struct completion sc_done;
164 struct xdr_buf sc_hdrbuf;
165 struct xdr_stream sc_stream;
169 struct ib_sge sc_sges[];
172 /* svc_rdma_backchannel.c */
173 extern void svc_rdma_handle_bc_reply(struct svc_rqst *rqstp,
174 struct svc_rdma_recv_ctxt *rctxt);
176 /* svc_rdma_recvfrom.c */
177 extern void svc_rdma_recv_ctxts_destroy(struct svcxprt_rdma *rdma);
178 extern bool svc_rdma_post_recvs(struct svcxprt_rdma *rdma);
179 extern struct svc_rdma_recv_ctxt *
180 svc_rdma_recv_ctxt_get(struct svcxprt_rdma *rdma);
181 extern void svc_rdma_recv_ctxt_put(struct svcxprt_rdma *rdma,
182 struct svc_rdma_recv_ctxt *ctxt);
183 extern void svc_rdma_flush_recv_queues(struct svcxprt_rdma *rdma);
184 extern void svc_rdma_release_rqst(struct svc_rqst *rqstp);
185 extern int svc_rdma_recvfrom(struct svc_rqst *);
188 extern void svc_rdma_destroy_rw_ctxts(struct svcxprt_rdma *rdma);
189 extern int svc_rdma_send_write_chunk(struct svcxprt_rdma *rdma,
190 const struct svc_rdma_chunk *chunk,
191 const struct xdr_buf *xdr);
192 extern int svc_rdma_send_reply_chunk(struct svcxprt_rdma *rdma,
193 const struct svc_rdma_recv_ctxt *rctxt,
194 const struct xdr_buf *xdr);
195 extern int svc_rdma_process_read_list(struct svcxprt_rdma *rdma,
196 struct svc_rqst *rqstp,
197 struct svc_rdma_recv_ctxt *head);
199 /* svc_rdma_sendto.c */
200 extern void svc_rdma_send_ctxts_destroy(struct svcxprt_rdma *rdma);
201 extern struct svc_rdma_send_ctxt *
202 svc_rdma_send_ctxt_get(struct svcxprt_rdma *rdma);
203 extern void svc_rdma_send_ctxt_put(struct svcxprt_rdma *rdma,
204 struct svc_rdma_send_ctxt *ctxt);
205 extern int svc_rdma_send(struct svcxprt_rdma *rdma,
206 struct svc_rdma_send_ctxt *ctxt);
207 extern int svc_rdma_map_reply_msg(struct svcxprt_rdma *rdma,
208 struct svc_rdma_send_ctxt *sctxt,
209 const struct svc_rdma_recv_ctxt *rctxt,
210 const struct xdr_buf *xdr);
211 extern void svc_rdma_send_error_msg(struct svcxprt_rdma *rdma,
212 struct svc_rdma_send_ctxt *sctxt,
213 struct svc_rdma_recv_ctxt *rctxt,
215 extern int svc_rdma_sendto(struct svc_rqst *);
216 extern int svc_rdma_result_payload(struct svc_rqst *rqstp, unsigned int offset,
217 unsigned int length);
219 /* svc_rdma_transport.c */
220 extern struct svc_xprt_class svc_rdma_class;
221 #ifdef CONFIG_SUNRPC_BACKCHANNEL
222 extern struct svc_xprt_class svc_rdma_bc_class;
226 extern int svc_rdma_init(void);
227 extern void svc_rdma_cleanup(void);