svcrdma: rc_position sanity checking
[deliverable/linux.git] / include / linux / sunrpc / svc_rdma.h
CommitLineData
d21b05f1
TT
1/*
2 * Copyright (c) 2005-2006 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 * Author: Tom Tucker <tom@opengridcomputing.com>
40 */
41
42#ifndef SVC_RDMA_H
43#define SVC_RDMA_H
44#include <linux/sunrpc/xdr.h>
45#include <linux/sunrpc/svcsock.h>
46#include <linux/sunrpc/rpc_rdma.h>
47#include <rdma/ib_verbs.h>
48#include <rdma/rdma_cm.h>
49#define SVCRDMA_DEBUG
50
51/* RPC/RDMA parameters and stats */
52extern unsigned int svcrdma_ord;
53extern unsigned int svcrdma_max_requests;
54extern unsigned int svcrdma_max_req_size;
55
56extern atomic_t rdma_stat_recv;
57extern atomic_t rdma_stat_read;
58extern atomic_t rdma_stat_write;
59extern atomic_t rdma_stat_sq_starve;
60extern atomic_t rdma_stat_rq_starve;
61extern atomic_t rdma_stat_rq_poll;
62extern atomic_t rdma_stat_rq_prod;
63extern atomic_t rdma_stat_sq_poll;
64extern atomic_t rdma_stat_sq_prod;
65
66#define RPCRDMA_VERSION 1
67
68/*
69 * Contexts are built when an RDMA request is created and are a
70 * record of the resources that can be recovered when the request
71 * completes.
72 */
73struct svc_rdma_op_ctxt {
02e7452d 74 struct svc_rdma_op_ctxt *read_hdr;
0d3ebb9a 75 struct svc_rdma_fastreg_mr *frmr;
f820c57e 76 int hdr_count;
d21b05f1
TT
77 struct xdr_buf arg;
78 struct list_head dto_q;
79 enum ib_wr_opcode wr_op;
80 enum ib_wc_status wc_status;
81 u32 byte_len;
82 struct svcxprt_rdma *xprt;
83 unsigned long flags;
84 enum dma_data_direction direction;
85 int count;
86 struct ib_sge sge[RPCSVC_MAXPAGES];
87 struct page *pages[RPCSVC_MAXPAGES];
88};
89
ab96dddb
TT
90/*
91 * NFS_ requests are mapped on the client side by the chunk lists in
92 * the RPCRDMA header. During the fetching of the RPC from the client
93 * and the writing of the reply to the client, the memory in the
94 * client and the memory in the server must be mapped as contiguous
95 * vaddr/len for access by the hardware. These data strucures keep
96 * these mappings.
97 *
98 * For an RDMA_WRITE, the 'sge' maps the RPC REPLY. For RDMA_READ, the
99 * 'sge' in the svc_rdma_req_map maps the server side RPC reply and the
100 * 'ch' field maps the read-list of the RPCRDMA header to the 'sge'
101 * mapping of the reply.
102 */
103struct svc_rdma_chunk_sge {
104 int start; /* sge no for this chunk */
105 int count; /* sge count for this chunk */
106};
0d3ebb9a
TT
107struct svc_rdma_fastreg_mr {
108 struct ib_mr *mr;
109 void *kva;
110 struct ib_fast_reg_page_list *page_list;
111 int page_list_len;
112 unsigned long access_flags;
113 unsigned long map_len;
114 enum dma_data_direction direction;
115 struct list_head frmr_list;
116};
ab96dddb
TT
117struct svc_rdma_req_map {
118 unsigned long count;
119 union {
120 struct kvec sge[RPCSVC_MAXPAGES];
121 struct svc_rdma_chunk_sge ch[RPCSVC_MAXPAGES];
0bf48289 122 unsigned long lkey[RPCSVC_MAXPAGES];
ab96dddb
TT
123 };
124};
d21b05f1
TT
125#define RDMACTXT_F_LAST_CTXT 2
126
0d3ebb9a
TT
127#define SVCRDMA_DEVCAP_FAST_REG 1 /* fast mr registration */
128#define SVCRDMA_DEVCAP_READ_W_INV 2 /* read w/ invalidate */
129
d21b05f1
TT
130struct svcxprt_rdma {
131 struct svc_xprt sc_xprt; /* SVC transport structure */
132 struct rdma_cm_id *sc_cm_id; /* RDMA connection id */
133 struct list_head sc_accept_q; /* Conn. waiting accept */
134 int sc_ord; /* RDMA read limit */
d21b05f1
TT
135 int sc_max_sge;
136
137 int sc_sq_depth; /* Depth of SQ */
138 atomic_t sc_sq_count; /* Number of SQ WR on queue */
139
140 int sc_max_requests; /* Depth of RQ */
141 int sc_max_req_size; /* Size of each RQ WR buf */
142
143 struct ib_pd *sc_pd;
144
87295b6c 145 atomic_t sc_dma_used;
87407673 146 atomic_t sc_ctxt_used;
d21b05f1
TT
147 struct list_head sc_rq_dto_q;
148 spinlock_t sc_rq_dto_lock;
149 struct ib_qp *sc_qp;
150 struct ib_cq *sc_rq_cq;
151 struct ib_cq *sc_sq_cq;
152 struct ib_mr *sc_phys_mr; /* MR for server memory */
e5452411
CL
153 int (*sc_reader)(struct svcxprt_rdma *,
154 struct svc_rqst *,
155 struct svc_rdma_op_ctxt *,
156 int *, u32 *, u32, u32, u64, bool);
0d3ebb9a
TT
157 u32 sc_dev_caps; /* distilled device caps */
158 u32 sc_dma_lkey; /* local dma key */
159 unsigned int sc_frmr_pg_list_len;
160 struct list_head sc_frmr_q;
161 spinlock_t sc_frmr_q_lock;
d21b05f1
TT
162
163 spinlock_t sc_lock; /* transport lock */
164
165 wait_queue_head_t sc_send_wait; /* SQ exhaustion waitlist */
166 unsigned long sc_flags;
167 struct list_head sc_dto_q; /* DTO tasklet I/O pending Q */
168 struct list_head sc_read_complete_q;
8da91ea8 169 struct work_struct sc_work;
d21b05f1
TT
170};
171/* sc_flags */
172#define RDMAXPRT_RQ_PENDING 1
173#define RDMAXPRT_SQ_PENDING 2
174#define RDMAXPRT_CONN_PENDING 3
175
176#define RPCRDMA_LISTEN_BACKLOG 10
177/* The default ORD value is based on two outstanding full-size writes with a
178 * page size of 4k, or 32k * 2 ops / 4k = 16 outstanding RDMA_READ. */
179#define RPCRDMA_ORD (64/4)
180#define RPCRDMA_SQ_DEPTH_MULT 8
d9bb5a43 181#define RPCRDMA_MAX_REQUESTS 32
d21b05f1
TT
182#define RPCRDMA_MAX_REQ_SIZE 4096
183
184/* svc_rdma_marshal.c */
d21b05f1
TT
185extern int svc_rdma_xdr_decode_req(struct rpcrdma_msg **, struct svc_rqst *);
186extern int svc_rdma_xdr_decode_deferred_req(struct svc_rqst *);
187extern int svc_rdma_xdr_encode_error(struct svcxprt_rdma *,
188 struct rpcrdma_msg *,
189 enum rpcrdma_errcode, u32 *);
190extern void svc_rdma_xdr_encode_write_list(struct rpcrdma_msg *, int);
191extern void svc_rdma_xdr_encode_reply_array(struct rpcrdma_write_array *, int);
192extern void svc_rdma_xdr_encode_array_chunk(struct rpcrdma_write_array *, int,
1fa9c444 193 __be32, __be64, u32);
d21b05f1
TT
194extern void svc_rdma_xdr_encode_reply_header(struct svcxprt_rdma *,
195 struct rpcrdma_msg *,
196 struct rpcrdma_msg *,
197 enum rpcrdma_proc);
198extern int svc_rdma_xdr_get_reply_hdr_len(struct rpcrdma_msg *);
199
200/* svc_rdma_recvfrom.c */
201extern int svc_rdma_recvfrom(struct svc_rqst *);
e5452411
CL
202extern int rdma_read_chunk_lcl(struct svcxprt_rdma *, struct svc_rqst *,
203 struct svc_rdma_op_ctxt *, int *, u32 *,
204 u32, u32, u64, bool);
205extern int rdma_read_chunk_frmr(struct svcxprt_rdma *, struct svc_rqst *,
206 struct svc_rdma_op_ctxt *, int *, u32 *,
207 u32, u32, u64, bool);
d21b05f1
TT
208
209/* svc_rdma_sendto.c */
210extern int svc_rdma_sendto(struct svc_rqst *);
211
212/* svc_rdma_transport.c */
213extern int svc_rdma_send(struct svcxprt_rdma *, struct ib_send_wr *);
008fdbc5
TT
214extern void svc_rdma_send_error(struct svcxprt_rdma *, struct rpcrdma_msg *,
215 enum rpcrdma_errcode);
d21b05f1
TT
216struct page *svc_rdma_get_page(void);
217extern int svc_rdma_post_recv(struct svcxprt_rdma *);
218extern int svc_rdma_create_listen(struct svc_serv *, int, struct sockaddr *);
219extern struct svc_rdma_op_ctxt *svc_rdma_get_context(struct svcxprt_rdma *);
220extern void svc_rdma_put_context(struct svc_rdma_op_ctxt *, int);
146b6df6 221extern void svc_rdma_unmap_dma(struct svc_rdma_op_ctxt *ctxt);
ab96dddb
TT
222extern struct svc_rdma_req_map *svc_rdma_get_req_map(void);
223extern void svc_rdma_put_req_map(struct svc_rdma_req_map *);
e1183210 224extern int svc_rdma_fastreg(struct svcxprt_rdma *, struct svc_rdma_fastreg_mr *);
64be8608
TT
225extern struct svc_rdma_fastreg_mr *svc_rdma_get_frmr(struct svcxprt_rdma *);
226extern void svc_rdma_put_frmr(struct svcxprt_rdma *,
227 struct svc_rdma_fastreg_mr *);
d21b05f1
TT
228extern void svc_sq_reap(struct svcxprt_rdma *);
229extern void svc_rq_reap(struct svcxprt_rdma *);
230extern struct svc_xprt_class svc_rdma_class;
231extern void svc_rdma_prep_reply_hdr(struct svc_rqst *);
232
233/* svc_rdma.c */
234extern int svc_rdma_init(void);
235extern void svc_rdma_cleanup(void);
236
237/*
238 * Returns the address of the first read chunk or <nul> if no read chunk is
239 * present
240 */
241static inline struct rpcrdma_read_chunk *
242svc_rdma_get_read_chunk(struct rpcrdma_msg *rmsgp)
243{
244 struct rpcrdma_read_chunk *ch =
245 (struct rpcrdma_read_chunk *)&rmsgp->rm_body.rm_chunks[0];
246
247 if (ch->rc_discrim == 0)
248 return NULL;
249
250 return ch;
251}
252
253/*
254 * Returns the address of the first read write array element or <nul> if no
255 * write array list is present
256 */
257static inline struct rpcrdma_write_array *
258svc_rdma_get_write_array(struct rpcrdma_msg *rmsgp)
259{
260 if (rmsgp->rm_body.rm_chunks[0] != 0
261 || rmsgp->rm_body.rm_chunks[1] == 0)
262 return NULL;
263
264 return (struct rpcrdma_write_array *)&rmsgp->rm_body.rm_chunks[1];
265}
266
267/*
268 * Returns the address of the first reply array element or <nul> if no
269 * reply array is present
270 */
271static inline struct rpcrdma_write_array *
272svc_rdma_get_reply_array(struct rpcrdma_msg *rmsgp)
273{
274 struct rpcrdma_read_chunk *rch;
275 struct rpcrdma_write_array *wr_ary;
276 struct rpcrdma_write_array *rp_ary;
277
278 /* XXX: Need to fix when reply list may occur with read-list and/or
279 * write list */
280 if (rmsgp->rm_body.rm_chunks[0] != 0 ||
281 rmsgp->rm_body.rm_chunks[1] != 0)
282 return NULL;
283
284 rch = svc_rdma_get_read_chunk(rmsgp);
285 if (rch) {
286 while (rch->rc_discrim)
287 rch++;
288
289 /* The reply list follows an empty write array located
290 * at 'rc_position' here. The reply array is at rc_target.
291 */
292 rp_ary = (struct rpcrdma_write_array *)&rch->rc_target;
293
294 goto found_it;
295 }
296
297 wr_ary = svc_rdma_get_write_array(rmsgp);
298 if (wr_ary) {
299 rp_ary = (struct rpcrdma_write_array *)
300 &wr_ary->
cec56c8f 301 wc_array[ntohl(wr_ary->wc_nchunks)].wc_target.rs_length;
d21b05f1
TT
302
303 goto found_it;
304 }
305
306 /* No read list, no write list */
307 rp_ary = (struct rpcrdma_write_array *)
308 &rmsgp->rm_body.rm_chunks[2];
309
310 found_it:
311 if (rp_ary->wc_discrim == 0)
312 return NULL;
313
314 return rp_ary;
315}
316#endif
This page took 4.383851 seconds and 5 git commands to generate.