~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/include/linux/sunrpc/svc_rdma.h

Version: ~ [ linux-5.15-rc5 ] ~ [ linux-5.14.11 ] ~ [ linux-5.13.19 ] ~ [ linux-5.12.19 ] ~ [ linux-5.11.22 ] ~ [ linux-5.10.72 ] ~ [ linux-5.9.16 ] ~ [ linux-5.8.18 ] ~ [ linux-5.7.19 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.152 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.210 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.250 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.286 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.288 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.18.140 ] ~ [ linux-3.16.85 ] ~ [ linux-3.14.79 ] ~ [ linux-3.12.74 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

  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 */
 52 extern unsigned int svcrdma_ord;
 53 extern unsigned int svcrdma_max_requests;
 54 extern unsigned int svcrdma_max_bc_requests;
 55 extern unsigned int svcrdma_max_req_size;
 56 
 57 extern atomic_t rdma_stat_recv;
 58 extern atomic_t rdma_stat_read;
 59 extern atomic_t rdma_stat_write;
 60 extern atomic_t rdma_stat_sq_starve;
 61 extern atomic_t rdma_stat_rq_starve;
 62 extern atomic_t rdma_stat_rq_poll;
 63 extern atomic_t rdma_stat_rq_prod;
 64 extern atomic_t rdma_stat_sq_poll;
 65 extern atomic_t rdma_stat_sq_prod;
 66 
 67 /*
 68  * Contexts are built when an RDMA request is created and are a
 69  * record of the resources that can be recovered when the request
 70  * completes.
 71  */
 72 struct svc_rdma_op_ctxt {
 73         struct list_head free;
 74         struct svc_rdma_op_ctxt *read_hdr;
 75         struct svc_rdma_fastreg_mr *frmr;
 76         int hdr_count;
 77         struct xdr_buf arg;
 78         struct ib_cqe cqe;
 79         struct ib_cqe reg_cqe;
 80         struct ib_cqe inv_cqe;
 81         struct list_head dto_q;
 82         enum ib_wc_status wc_status;
 83         u32 byte_len;
 84         u32 position;
 85         struct svcxprt_rdma *xprt;
 86         unsigned long flags;
 87         enum dma_data_direction direction;
 88         int count;
 89         unsigned int mapped_sges;
 90         struct ib_sge sge[RPCSVC_MAXPAGES];
 91         struct page *pages[RPCSVC_MAXPAGES];
 92 };
 93 
 94 /*
 95  * NFS_ requests are mapped on the client side by the chunk lists in
 96  * the RPCRDMA header. During the fetching of the RPC from the client
 97  * and the writing of the reply to the client, the memory in the
 98  * client and the memory in the server must be mapped as contiguous
 99  * vaddr/len for access by the hardware. These data strucures keep
100  * these mappings.
101  *
102  * For an RDMA_WRITE, the 'sge' maps the RPC REPLY. For RDMA_READ, the
103  * 'sge' in the svc_rdma_req_map maps the server side RPC reply and the
104  * 'ch' field maps the read-list of the RPCRDMA header to the 'sge'
105  * mapping of the reply.
106  */
107 struct svc_rdma_chunk_sge {
108         int start;              /* sge no for this chunk */
109         int count;              /* sge count for this chunk */
110 };
111 struct svc_rdma_fastreg_mr {
112         struct ib_mr *mr;
113         struct scatterlist *sg;
114         int sg_nents;
115         unsigned long access_flags;
116         enum dma_data_direction direction;
117         struct list_head frmr_list;
118 };
119 struct svc_rdma_req_map {
120         struct list_head free;
121         unsigned long count;
122         union {
123                 struct kvec sge[RPCSVC_MAXPAGES];
124                 struct svc_rdma_chunk_sge ch[RPCSVC_MAXPAGES];
125                 unsigned long lkey[RPCSVC_MAXPAGES];
126         };
127 };
128 #define RDMACTXT_F_LAST_CTXT    2
129 
130 #define SVCRDMA_DEVCAP_FAST_REG         1       /* fast mr registration */
131 #define SVCRDMA_DEVCAP_READ_W_INV       2       /* read w/ invalidate */
132 
133 struct svcxprt_rdma {
134         struct svc_xprt      sc_xprt;           /* SVC transport structure */
135         struct rdma_cm_id    *sc_cm_id;         /* RDMA connection id */
136         struct list_head     sc_accept_q;       /* Conn. waiting accept */
137         int                  sc_ord;            /* RDMA read limit */
138         int                  sc_max_sge;
139         int                  sc_max_sge_rd;     /* max sge for read target */
140 
141         atomic_t             sc_sq_count;       /* Number of SQ WR on queue */
142         unsigned int         sc_sq_depth;       /* Depth of SQ */
143         unsigned int         sc_rq_depth;       /* Depth of RQ */
144         u32                  sc_max_requests;   /* Forward credits */
145         u32                  sc_max_bc_requests;/* Backward credits */
146         int                  sc_max_req_size;   /* Size of each RQ WR buf */
147 
148         struct ib_pd         *sc_pd;
149 
150         atomic_t             sc_dma_used;
151         spinlock_t           sc_ctxt_lock;
152         struct list_head     sc_ctxts;
153         int                  sc_ctxt_used;
154         spinlock_t           sc_map_lock;
155         struct list_head     sc_maps;
156 
157         struct list_head     sc_rq_dto_q;
158         spinlock_t           sc_rq_dto_lock;
159         struct ib_qp         *sc_qp;
160         struct ib_cq         *sc_rq_cq;
161         struct ib_cq         *sc_sq_cq;
162         int                  (*sc_reader)(struct svcxprt_rdma *,
163                                           struct svc_rqst *,
164                                           struct svc_rdma_op_ctxt *,
165                                           int *, u32 *, u32, u32, u64, bool);
166         u32                  sc_dev_caps;       /* distilled device caps */
167         unsigned int         sc_frmr_pg_list_len;
168         struct list_head     sc_frmr_q;
169         spinlock_t           sc_frmr_q_lock;
170 
171         spinlock_t           sc_lock;           /* transport lock */
172 
173         wait_queue_head_t    sc_send_wait;      /* SQ exhaustion waitlist */
174         unsigned long        sc_flags;
175         struct list_head     sc_dto_q;          /* DTO tasklet I/O pending Q */
176         struct list_head     sc_read_complete_q;
177         struct work_struct   sc_work;
178 };
179 /* sc_flags */
180 #define RDMAXPRT_CONN_PENDING   3
181 
182 #define RPCRDMA_LISTEN_BACKLOG  10
183 /* The default ORD value is based on two outstanding full-size writes with a
184  * page size of 4k, or 32k * 2 ops / 4k = 16 outstanding RDMA_READ.  */
185 #define RPCRDMA_ORD             (64/4)
186 #define RPCRDMA_SQ_DEPTH_MULT   8
187 #define RPCRDMA_MAX_REQUESTS    32
188 #define RPCRDMA_MAX_REQ_SIZE    4096
189 
190 /* Typical ULP usage of BC requests is NFSv4.1 backchannel. Our
191  * current NFSv4.1 implementation supports one backchannel slot.
192  */
193 #define RPCRDMA_MAX_BC_REQUESTS 2
194 
195 #define RPCSVC_MAXPAYLOAD_RDMA  RPCSVC_MAXPAYLOAD
196 
197 /* Track DMA maps for this transport and context */
198 static inline void svc_rdma_count_mappings(struct svcxprt_rdma *rdma,
199                                            struct svc_rdma_op_ctxt *ctxt)
200 {
201         ctxt->mapped_sges++;
202         atomic_inc(&rdma->sc_dma_used);
203 }
204 
205 /* svc_rdma_backchannel.c */
206 extern int svc_rdma_handle_bc_reply(struct rpc_xprt *xprt,
207                                     struct rpcrdma_msg *rmsgp,
208                                     struct xdr_buf *rcvbuf);
209 
210 /* svc_rdma_marshal.c */
211 extern int svc_rdma_xdr_decode_req(struct xdr_buf *);
212 extern int svc_rdma_xdr_encode_error(struct svcxprt_rdma *,
213                                      struct rpcrdma_msg *,
214                                      enum rpcrdma_errcode, __be32 *);
215 extern void svc_rdma_xdr_encode_write_list(struct rpcrdma_msg *, int);
216 extern void svc_rdma_xdr_encode_reply_array(struct rpcrdma_write_array *, int);
217 extern void svc_rdma_xdr_encode_array_chunk(struct rpcrdma_write_array *, int,
218                                             __be32, __be64, u32);
219 extern void svc_rdma_xdr_encode_reply_header(struct svcxprt_rdma *,
220                                              struct rpcrdma_msg *,
221                                              struct rpcrdma_msg *,
222                                              enum rpcrdma_proc);
223 extern int svc_rdma_xdr_get_reply_hdr_len(struct rpcrdma_msg *);
224 
225 /* svc_rdma_recvfrom.c */
226 extern int svc_rdma_recvfrom(struct svc_rqst *);
227 extern int rdma_read_chunk_lcl(struct svcxprt_rdma *, struct svc_rqst *,
228                                struct svc_rdma_op_ctxt *, int *, u32 *,
229                                u32, u32, u64, bool);
230 extern int rdma_read_chunk_frmr(struct svcxprt_rdma *, struct svc_rqst *,
231                                 struct svc_rdma_op_ctxt *, int *, u32 *,
232                                 u32, u32, u64, bool);
233 
234 /* svc_rdma_sendto.c */
235 extern int svc_rdma_map_xdr(struct svcxprt_rdma *, struct xdr_buf *,
236                             struct svc_rdma_req_map *, bool);
237 extern int svc_rdma_sendto(struct svc_rqst *);
238 extern struct rpcrdma_read_chunk *
239         svc_rdma_get_read_chunk(struct rpcrdma_msg *);
240 extern void svc_rdma_send_error(struct svcxprt_rdma *, struct rpcrdma_msg *,
241                                 int);
242 
243 /* svc_rdma_transport.c */
244 extern void svc_rdma_wc_send(struct ib_cq *, struct ib_wc *);
245 extern void svc_rdma_wc_write(struct ib_cq *, struct ib_wc *);
246 extern void svc_rdma_wc_reg(struct ib_cq *, struct ib_wc *);
247 extern void svc_rdma_wc_read(struct ib_cq *, struct ib_wc *);
248 extern void svc_rdma_wc_inv(struct ib_cq *, struct ib_wc *);
249 extern int svc_rdma_send(struct svcxprt_rdma *, struct ib_send_wr *);
250 extern int svc_rdma_post_recv(struct svcxprt_rdma *, gfp_t);
251 extern int svc_rdma_repost_recv(struct svcxprt_rdma *, gfp_t);
252 extern int svc_rdma_create_listen(struct svc_serv *, int, struct sockaddr *);
253 extern struct svc_rdma_op_ctxt *svc_rdma_get_context(struct svcxprt_rdma *);
254 extern void svc_rdma_put_context(struct svc_rdma_op_ctxt *, int);
255 extern void svc_rdma_unmap_dma(struct svc_rdma_op_ctxt *ctxt);
256 extern struct svc_rdma_req_map *svc_rdma_get_req_map(struct svcxprt_rdma *);
257 extern void svc_rdma_put_req_map(struct svcxprt_rdma *,
258                                  struct svc_rdma_req_map *);
259 extern struct svc_rdma_fastreg_mr *svc_rdma_get_frmr(struct svcxprt_rdma *);
260 extern void svc_rdma_put_frmr(struct svcxprt_rdma *,
261                               struct svc_rdma_fastreg_mr *);
262 extern void svc_sq_reap(struct svcxprt_rdma *);
263 extern void svc_rq_reap(struct svcxprt_rdma *);
264 extern void svc_rdma_prep_reply_hdr(struct svc_rqst *);
265 
266 extern struct svc_xprt_class svc_rdma_class;
267 #ifdef CONFIG_SUNRPC_BACKCHANNEL
268 extern struct svc_xprt_class svc_rdma_bc_class;
269 #endif
270 
271 /* svc_rdma.c */
272 extern struct workqueue_struct *svc_rdma_wq;
273 extern int svc_rdma_init(void);
274 extern void svc_rdma_cleanup(void);
275 
276 #endif
277 

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp