[deliverable/linux.git] / include / linux / sunrpc / svc_rdma.h

/*
 * Copyright (c) 2005-2006 Network Appliance, Inc. All rights reserved.
 *
 * This software is available to you under a choice of one of two
 * licenses.  You may choose to be licensed under the terms of the GNU
 * General Public License (GPL) Version 2, available from the file
 * COPYING in the main directory of this source tree, or the BSD-type
 * license below:
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *      Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer.
 *
 *      Redistributions in binary form must reproduce the above
 *      copyright notice, this list of conditions and the following
 *      disclaimer in the documentation and/or other materials provided
 *      with the distribution.
 *
 *      Neither the name of the Network Appliance, Inc. nor the names of
 *      its contributors may be used to endorse or promote products
 *      derived from this software without specific prior written
 *      permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Author: Tom Tucker <tom@opengridcomputing.com>
 */

#ifndef SVC_RDMA_H
#define SVC_RDMA_H
#include <linux/sunrpc/xdr.h>
#include <linux/sunrpc/svcsock.h>
#include <linux/sunrpc/rpc_rdma.h>
#include <rdma/ib_verbs.h>
#include <rdma/rdma_cm.h>
#define SVCRDMA_DEBUG

/* RPC/RDMA parameters and stats */
extern unsigned int svcrdma_ord;
extern unsigned int svcrdma_max_requests;
extern unsigned int svcrdma_max_req_size;

extern atomic_t rdma_stat_recv;
extern atomic_t rdma_stat_read;
extern atomic_t rdma_stat_write;
extern atomic_t rdma_stat_sq_starve;
extern atomic_t rdma_stat_rq_starve;
extern atomic_t rdma_stat_rq_poll;
extern atomic_t rdma_stat_rq_prod;
extern atomic_t rdma_stat_sq_poll;
extern atomic_t rdma_stat_sq_prod;

#define RPCRDMA_VERSION 1

/*
 * Contexts are built when an RDMA request is created and are a
 * record of the resources that can be recovered when the request
 * completes.
 */
struct svc_rdma_op_ctxt {
	struct svc_rdma_op_ctxt *read_hdr;
	struct list_head free_list;
	struct xdr_buf arg;
	struct list_head dto_q;
	enum ib_wr_opcode wr_op;
	enum ib_wc_status wc_status;
	u32 byte_len;
	struct svcxprt_rdma *xprt;
	unsigned long flags;
	enum dma_data_direction direction;
	int count;
	struct ib_sge sge[RPCSVC_MAXPAGES];
	struct page *pages[RPCSVC_MAXPAGES];
};

#define RDMACTXT_F_LAST_CTXT	2

struct svcxprt_rdma {
	struct svc_xprt      sc_xprt;		/* SVC transport structure */
	struct rdma_cm_id    *sc_cm_id;		/* RDMA connection id */
	struct list_head     sc_accept_q;	/* Conn. waiting accept */
	int		     sc_ord;		/* RDMA read limit */
	wait_queue_head_t    sc_read_wait;
	int                  sc_max_sge;

	int                  sc_sq_depth;	/* Depth of SQ */
	atomic_t             sc_sq_count;	/* Number of SQ WR on queue */

	int                  sc_max_requests;	/* Depth of RQ */
	int                  sc_max_req_size;	/* Size of each RQ WR buf */

	struct ib_pd         *sc_pd;

	atomic_t	     sc_ctxt_used;
	struct list_head     sc_ctxt_free;
	int		     sc_ctxt_cnt;
	int		     sc_ctxt_bump;
	int		     sc_ctxt_max;
	spinlock_t	     sc_ctxt_lock;
	struct list_head     sc_rq_dto_q;
	spinlock_t	     sc_rq_dto_lock;
	struct ib_qp         *sc_qp;
	struct ib_cq         *sc_rq_cq;
	struct ib_cq         *sc_sq_cq;
	struct ib_mr         *sc_phys_mr;	/* MR for server memory */

	spinlock_t	     sc_lock;		/* transport lock */

	wait_queue_head_t    sc_send_wait;	/* SQ exhaustion waitlist */
	unsigned long	     sc_flags;
	struct list_head     sc_dto_q;		/* DTO tasklet I/O pending Q */
	struct list_head     sc_read_complete_q;
	spinlock_t           sc_read_complete_lock;
};
/* sc_flags */
#define RDMAXPRT_RQ_PENDING	1
#define RDMAXPRT_SQ_PENDING	2
#define RDMAXPRT_CONN_PENDING	3

#define RPCRDMA_LISTEN_BACKLOG  10
/* The default ORD value is based on two outstanding full-size writes with a
 * page size of 4k, or 32k * 2 ops / 4k = 16 outstanding RDMA_READ.  */
#define RPCRDMA_ORD             (64/4)
#define RPCRDMA_SQ_DEPTH_MULT   8
#define RPCRDMA_MAX_THREADS     16
#define RPCRDMA_MAX_REQUESTS    16
#define RPCRDMA_MAX_REQ_SIZE    4096

/* svc_rdma_marshal.c */
extern void svc_rdma_rcl_chunk_counts(struct rpcrdma_read_chunk *,
				      int *, int *);
extern int svc_rdma_xdr_decode_req(struct rpcrdma_msg **, struct svc_rqst *);
extern int svc_rdma_xdr_decode_deferred_req(struct svc_rqst *);
extern int svc_rdma_xdr_encode_error(struct svcxprt_rdma *,
				     struct rpcrdma_msg *,
				     enum rpcrdma_errcode, u32 *);
extern void svc_rdma_xdr_encode_write_list(struct rpcrdma_msg *, int);
extern void svc_rdma_xdr_encode_reply_array(struct rpcrdma_write_array *, int);
extern void svc_rdma_xdr_encode_array_chunk(struct rpcrdma_write_array *, int,
					    u32, u64, u32);
extern void svc_rdma_xdr_encode_reply_header(struct svcxprt_rdma *,
					     struct rpcrdma_msg *,
					     struct rpcrdma_msg *,
					     enum rpcrdma_proc);
extern int svc_rdma_xdr_get_reply_hdr_len(struct rpcrdma_msg *);

/* svc_rdma_recvfrom.c */
extern int svc_rdma_recvfrom(struct svc_rqst *);

/* svc_rdma_sendto.c */
extern int svc_rdma_sendto(struct svc_rqst *);

/* svc_rdma_transport.c */
extern int svc_rdma_send(struct svcxprt_rdma *, struct ib_send_wr *);
extern int svc_rdma_send_error(struct svcxprt_rdma *, struct rpcrdma_msg *,
			       enum rpcrdma_errcode);
struct page *svc_rdma_get_page(void);
extern int svc_rdma_post_recv(struct svcxprt_rdma *);
extern int svc_rdma_create_listen(struct svc_serv *, int, struct sockaddr *);
extern struct svc_rdma_op_ctxt *svc_rdma_get_context(struct svcxprt_rdma *);
extern void svc_rdma_put_context(struct svc_rdma_op_ctxt *, int);
extern void svc_sq_reap(struct svcxprt_rdma *);
extern void svc_rq_reap(struct svcxprt_rdma *);
extern struct svc_xprt_class svc_rdma_class;
extern void svc_rdma_prep_reply_hdr(struct svc_rqst *);

/* svc_rdma.c */
extern int svc_rdma_init(void);
extern void svc_rdma_cleanup(void);

/*
 * Returns the address of the first read chunk or <nul> if no read chunk is
 * present
 */
static inline struct rpcrdma_read_chunk *
svc_rdma_get_read_chunk(struct rpcrdma_msg *rmsgp)
{
	struct rpcrdma_read_chunk *ch =
		(struct rpcrdma_read_chunk *)&rmsgp->rm_body.rm_chunks[0];

	if (ch->rc_discrim == 0)
		return NULL;

	return ch;
}

/*
 * Returns the address of the first read write array element or <nul> if no
 * write array list is present
 */
static inline struct rpcrdma_write_array *
svc_rdma_get_write_array(struct rpcrdma_msg *rmsgp)
{
	if (rmsgp->rm_body.rm_chunks[0] != 0
	    || rmsgp->rm_body.rm_chunks[1] == 0)
		return NULL;

	return (struct rpcrdma_write_array *)&rmsgp->rm_body.rm_chunks[1];
}

/*
 * Returns the address of the first reply array element or <nul> if no
 * reply array is present
 */
static inline struct rpcrdma_write_array *
svc_rdma_get_reply_array(struct rpcrdma_msg *rmsgp)
{
	struct rpcrdma_read_chunk *rch;
	struct rpcrdma_write_array *wr_ary;
	struct rpcrdma_write_array *rp_ary;

	/* XXX: Need to fix when reply list may occur with read-list and/or
	 * write list */
	if (rmsgp->rm_body.rm_chunks[0] != 0 ||
	    rmsgp->rm_body.rm_chunks[1] != 0)
		return NULL;

	rch = svc_rdma_get_read_chunk(rmsgp);
	if (rch) {
		while (rch->rc_discrim)
			rch++;

		/* The reply list follows an empty write array located
		 * at 'rc_position' here. The reply array is at rc_target.
		 */
		rp_ary = (struct rpcrdma_write_array *)&rch->rc_target;

		goto found_it;
	}

	wr_ary = svc_rdma_get_write_array(rmsgp);
	if (wr_ary) {
		rp_ary = (struct rpcrdma_write_array *)
			&wr_ary->
			wc_array[wr_ary->wc_nchunks].wc_target.rs_length;

		goto found_it;
	}

	/* No read list, no write list */
	rp_ary = (struct rpcrdma_write_array *)
		&rmsgp->rm_body.rm_chunks[2];

 found_it:
	if (rp_ary->wc_discrim == 0)
		return NULL;

	return rp_ary;
}
#endif
Commit	Line	Data
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 */
	52	extern unsigned int svcrdma_ord;
	53	extern unsigned int svcrdma_max_requests;
	54	extern unsigned int svcrdma_max_req_size;
	55
	56	extern atomic_t rdma_stat_recv;
	57	extern atomic_t rdma_stat_read;
	58	extern atomic_t rdma_stat_write;
	59	extern atomic_t rdma_stat_sq_starve;
	60	extern atomic_t rdma_stat_rq_starve;
	61	extern atomic_t rdma_stat_rq_poll;
	62	extern atomic_t rdma_stat_rq_prod;
	63	extern atomic_t rdma_stat_sq_poll;
	64	extern 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	*/
73	struct svc_rdma_op_ctxt {
02e7452d	74	struct svc_rdma_op_ctxt *read_hdr;
87407673	75	struct list_head free_list;
d21b05f1 TT	76	struct xdr_buf arg;
	77	struct list_head dto_q;
	78	enum ib_wr_opcode wr_op;
	79	enum ib_wc_status wc_status;
	80	u32 byte_len;
	81	struct svcxprt_rdma *xprt;
	82	unsigned long flags;
	83	enum dma_data_direction direction;
	84	int count;
	85	struct ib_sge sge[RPCSVC_MAXPAGES];
	86	struct page *pages[RPCSVC_MAXPAGES];
	87	};
	88
d21b05f1 TT	89	#define RDMACTXT_F_LAST_CTXT 2
	90
	91	struct svcxprt_rdma {
	92	struct svc_xprt sc_xprt; /* SVC transport structure */
	93	struct rdma_cm_id sc_cm_id; / RDMA connection id */
	94	struct list_head sc_accept_q; /* Conn. waiting accept */
	95	int sc_ord; /* RDMA read limit */
	96	wait_queue_head_t sc_read_wait;
	97	int sc_max_sge;
	98
	99	int sc_sq_depth; /* Depth of SQ */
	100	atomic_t sc_sq_count; /* Number of SQ WR on queue */
	101
	102	int sc_max_requests; /* Depth of RQ */
	103	int sc_max_req_size; /* Size of each RQ WR buf */
	104
	105	struct ib_pd *sc_pd;
	106
87407673 TT	107	atomic_t sc_ctxt_used;
87407673 TT	108	struct list_head sc_ctxt_free;
d21b05f1 TT	109	int sc_ctxt_cnt;
	110	int sc_ctxt_bump;
	111	int sc_ctxt_max;
	112	spinlock_t sc_ctxt_lock;
	113	struct list_head sc_rq_dto_q;
	114	spinlock_t sc_rq_dto_lock;
	115	struct ib_qp *sc_qp;
	116	struct ib_cq *sc_rq_cq;
	117	struct ib_cq *sc_sq_cq;
	118	struct ib_mr sc_phys_mr; / MR for server memory */
	119
	120	spinlock_t sc_lock; /* transport lock */
	121
	122	wait_queue_head_t sc_send_wait; /* SQ exhaustion waitlist */
	123	unsigned long sc_flags;
	124	struct list_head sc_dto_q; /* DTO tasklet I/O pending Q */
	125	struct list_head sc_read_complete_q;
	126	spinlock_t sc_read_complete_lock;
	127	};
	128	/* sc_flags */
	129	#define RDMAXPRT_RQ_PENDING 1
	130	#define RDMAXPRT_SQ_PENDING 2
	131	#define RDMAXPRT_CONN_PENDING 3
	132
	133	#define RPCRDMA_LISTEN_BACKLOG 10
	134	/* The default ORD value is based on two outstanding full-size writes with a
	135	* page size of 4k, or 32k * 2 ops / 4k = 16 outstanding RDMA_READ. */
	136	#define RPCRDMA_ORD (64/4)
	137	#define RPCRDMA_SQ_DEPTH_MULT 8
	138	#define RPCRDMA_MAX_THREADS 16
	139	#define RPCRDMA_MAX_REQUESTS 16
	140	#define RPCRDMA_MAX_REQ_SIZE 4096
	141
	142	/* svc_rdma_marshal.c */
	143	extern void svc_rdma_rcl_chunk_counts(struct rpcrdma_read_chunk *,
	144	int , int );
	145	extern int svc_rdma_xdr_decode_req(struct rpcrdma_msg *, struct svc_rqst );
	146	extern int svc_rdma_xdr_decode_deferred_req(struct svc_rqst *);
	147	extern int svc_rdma_xdr_encode_error(struct svcxprt_rdma *,
	148	struct rpcrdma_msg *,
	149	enum rpcrdma_errcode, u32 *);
	150	extern void svc_rdma_xdr_encode_write_list(struct rpcrdma_msg *, int);
	151	extern void svc_rdma_xdr_encode_reply_array(struct rpcrdma_write_array *, int);
	152	extern void svc_rdma_xdr_encode_array_chunk(struct rpcrdma_write_array *, int,
	153	u32, u64, u32);
	154	extern void svc_rdma_xdr_encode_reply_header(struct svcxprt_rdma *,
	155	struct rpcrdma_msg *,
	156	struct rpcrdma_msg *,
	157	enum rpcrdma_proc);
	158	extern int svc_rdma_xdr_get_reply_hdr_len(struct rpcrdma_msg *);
	159
	160	/* svc_rdma_recvfrom.c */
	161	extern int svc_rdma_recvfrom(struct svc_rqst *);
	162
	163	/* svc_rdma_sendto.c */
	164	extern int svc_rdma_sendto(struct svc_rqst *);
	165
	166	/* svc_rdma_transport.c */
	167	extern int svc_rdma_send(struct svcxprt_rdma , struct ib_send_wr );
	168	extern int svc_rdma_send_error(struct svcxprt_rdma , struct rpcrdma_msg ,
	169	enum rpcrdma_errcode);
	170	struct page *svc_rdma_get_page(void);
	171	extern int svc_rdma_post_recv(struct svcxprt_rdma *);
	172	extern int svc_rdma_create_listen(struct svc_serv , int, struct sockaddr );
173	extern struct svc_rdma_op_ctxt svc_rdma_get_context(struct svcxprt_rdma );
174	extern void svc_rdma_put_context(struct svc_rdma_op_ctxt *, int);
175	extern void svc_sq_reap(struct svcxprt_rdma *);
176	extern void svc_rq_reap(struct svcxprt_rdma *);
177	extern struct svc_xprt_class svc_rdma_class;
178	extern void svc_rdma_prep_reply_hdr(struct svc_rqst *);
179
180	/* svc_rdma.c */
181	extern int svc_rdma_init(void);
182	extern void svc_rdma_cleanup(void);
183
184	/*
185	* Returns the address of the first read chunk or <nul> if no read chunk is
186	* present
187	*/
188	static inline struct rpcrdma_read_chunk *
189	svc_rdma_get_read_chunk(struct rpcrdma_msg *rmsgp)
190	{
191	struct rpcrdma_read_chunk *ch =
192	(struct rpcrdma_read_chunk *)&rmsgp->rm_body.rm_chunks[0];
193
194	if (ch->rc_discrim == 0)
195	return NULL;
196
197	return ch;
198	}
199
200	/*
201	* Returns the address of the first read write array element or <nul> if no
202	* write array list is present
203	*/
204	static inline struct rpcrdma_write_array *
205	svc_rdma_get_write_array(struct rpcrdma_msg *rmsgp)
206	{
207	if (rmsgp->rm_body.rm_chunks[0] != 0
208	\|\| rmsgp->rm_body.rm_chunks[1] == 0)
209	return NULL;
210
211	return (struct rpcrdma_write_array *)&rmsgp->rm_body.rm_chunks[1];
212	}
213
214	/*
215	* Returns the address of the first reply array element or <nul> if no
216	* reply array is present
217	*/
218	static inline struct rpcrdma_write_array *
219	svc_rdma_get_reply_array(struct rpcrdma_msg *rmsgp)
220	{
221	struct rpcrdma_read_chunk *rch;
222	struct rpcrdma_write_array *wr_ary;
223	struct rpcrdma_write_array *rp_ary;
224
225	/* XXX: Need to fix when reply list may occur with read-list and/or
226	* write list */
227	if (rmsgp->rm_body.rm_chunks[0] != 0 \|\|
228	rmsgp->rm_body.rm_chunks[1] != 0)
229	return NULL;
230
231	rch = svc_rdma_get_read_chunk(rmsgp);
232	if (rch) {
233	while (rch->rc_discrim)
234	rch++;
235
236	/* The reply list follows an empty write array located
237	* at 'rc_position' here. The reply array is at rc_target.
238	*/
239	rp_ary = (struct rpcrdma_write_array *)&rch->rc_target;
240
241	goto found_it;
242	}
243
244	wr_ary = svc_rdma_get_write_array(rmsgp);
245	if (wr_ary) {
246	rp_ary = (struct rpcrdma_write_array *)
247	&wr_ary->
248	wc_array[wr_ary->wc_nchunks].wc_target.rs_length;
249
250	goto found_it;
251	}
252
253	/* No read list, no write list */
254	rp_ary = (struct rpcrdma_write_array *)
255	&rmsgp->rm_body.rm_chunks[2];
256
257	found_it:
258	if (rp_ary->wc_discrim == 0)
259	return NULL;
260
261	return rp_ary;
262	}
263	#endif