[linux.git] / net / rds / ib_mr.h

/*
 * Copyright (c) 2016 Oracle.  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
 * OpenIB.org BSD 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.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
#ifndef _RDS_IB_MR_H
#define _RDS_IB_MR_H

#include <linux/kernel.h>

#include "rds.h"
#include "ib.h"

#define RDS_MR_1M_POOL_SIZE		(8192 / 2)
#define RDS_MR_1M_MSG_SIZE		256
#define RDS_MR_8K_MSG_SIZE		2
#define RDS_MR_8K_SCALE			(256 / (RDS_MR_8K_MSG_SIZE + 1))
#define RDS_MR_8K_POOL_SIZE		(RDS_MR_8K_SCALE * (8192 / 2))

enum rds_ib_fr_state {
	FRMR_IS_FREE,	/* mr invalidated & ready for use */
	FRMR_IS_INUSE,	/* mr is in use or used & can be invalidated */
	FRMR_IS_STALE,	/* Stale MR and needs to be dropped  */
};

struct rds_ib_frmr {
	struct ib_mr		*mr;
	enum rds_ib_fr_state	fr_state;
	bool			fr_inv;
	wait_queue_head_t	fr_inv_done;
	bool			fr_reg;
	wait_queue_head_t	fr_reg_done;
	struct ib_send_wr	fr_wr;
	unsigned int		dma_npages;
	unsigned int		sg_byte_len;
};

/* This is stored as mr->r_trans_private. */
struct rds_ib_mr {
	struct delayed_work		work;
	struct rds_ib_device		*device;
	struct rds_ib_mr_pool		*pool;
	struct rds_ib_connection	*ic;

	struct llist_node		llnode;

	/* unmap_list is for freeing */
	struct list_head		unmap_list;
	unsigned int			remap_count;

	struct scatterlist		*sg;
	unsigned int			sg_len;
	int				sg_dma_len;

	u8				odp:1;
	union {
		struct rds_ib_frmr	frmr;
		struct ib_mr		*mr;
	} u;
};

/* Our own little MR pool */
struct rds_ib_mr_pool {
	unsigned int            pool_type;
	struct mutex		flush_lock;	/* serialize fmr invalidate */
	struct delayed_work	flush_worker;	/* flush worker */

	atomic_t		item_count;	/* total # of MRs */
	atomic_t		dirty_count;	/* # dirty of MRs */

	struct llist_head	drop_list;	/* MRs not reached max_maps */
	struct llist_head	free_list;	/* unused MRs */
	struct llist_head	clean_list;	/* unused & unmapped MRs */
	wait_queue_head_t	flush_wait;
	spinlock_t		clean_lock;	/* "clean_list" concurrency */

	atomic_t		free_pinned;	/* memory pinned by free MRs */
	unsigned long		max_items;
	unsigned long		max_items_soft;
	unsigned long		max_free_pinned;
	unsigned int		max_pages;
};

extern struct workqueue_struct *rds_ib_mr_wq;
extern bool prefer_frmr;

struct rds_ib_mr_pool *rds_ib_create_mr_pool(struct rds_ib_device *rds_dev,
					     int npages);
void rds_ib_get_mr_info(struct rds_ib_device *rds_ibdev,
			struct rds_info_rdma_connection *iinfo);
void rds6_ib_get_mr_info(struct rds_ib_device *rds_ibdev,
			 struct rds6_info_rdma_connection *iinfo6);
void rds_ib_destroy_mr_pool(struct rds_ib_mr_pool *);
void *rds_ib_get_mr(struct scatterlist *sg, unsigned long nents,
		    struct rds_sock *rs, u32 *key_ret,
		    struct rds_connection *conn, u64 start, u64 length,
		    int need_odp);
void rds_ib_sync_mr(void *trans_private, int dir);
void rds_ib_free_mr(void *trans_private, int invalidate);
void rds_ib_flush_mrs(void);
int rds_ib_mr_init(void);
void rds_ib_mr_exit(void);
u32 rds_ib_get_lkey(void *trans_private);

void __rds_ib_teardown_mr(struct rds_ib_mr *);
void rds_ib_teardown_mr(struct rds_ib_mr *);
struct rds_ib_mr *rds_ib_reuse_mr(struct rds_ib_mr_pool *);
int rds_ib_flush_mr_pool(struct rds_ib_mr_pool *, int, struct rds_ib_mr **);
struct rds_ib_mr *rds_ib_try_reuse_ibmr(struct rds_ib_mr_pool *);
struct rds_ib_mr *rds_ib_reg_frmr(struct rds_ib_device *rds_ibdev,
				  struct rds_ib_connection *ic,
				  struct scatterlist *sg,
				  unsigned long nents, u32 *key);
void rds_ib_unreg_frmr(struct list_head *list, unsigned int *nfreed,
		       unsigned long *unpinned, unsigned int goal);
void rds_ib_free_frmr_list(struct rds_ib_mr *);
#endif
Commit	Line	Data
f6df683f	1	/*
	2	* Copyright (c) 2016 Oracle. 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
	8	* OpenIB.org BSD license below:
	9	*
	10	* Redistribution and use in source and binary forms, with or
	11	* without modification, are permitted provided that the following
	12	* conditions are met:
	13	*
	14	* - Redistributions of source code must retain the above
	15	* copyright notice, this list of conditions and the following
	16	* disclaimer.
	17	*
	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
	21	* provided with the distribution.
	22	*
	23	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
	24	* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
	25	* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
	26	* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
	27	* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
	28	* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
	29	* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	30	* SOFTWARE.
	31	*/
	32	#ifndef _RDS_IB_MR_H
	33	#define _RDS_IB_MR_H
	34
	35	#include <linux/kernel.h>
	36
	37	#include "rds.h"
	38	#include "ib.h"
	39
	40	#define RDS_MR_1M_POOL_SIZE (8192 / 2)
	41	#define RDS_MR_1M_MSG_SIZE 256
	42	#define RDS_MR_8K_MSG_SIZE 2
	43	#define RDS_MR_8K_SCALE (256 / (RDS_MR_8K_MSG_SIZE + 1))
	44	#define RDS_MR_8K_POOL_SIZE (RDS_MR_8K_SCALE * (8192 / 2))
	45
1659185f AR	46	enum rds_ib_fr_state {
	47	FRMR_IS_FREE, /* mr invalidated & ready for use */
	48	FRMR_IS_INUSE, /* mr is in use or used & can be invalidated */
	49	FRMR_IS_STALE, /* Stale MR and needs to be dropped */
	50	};
	51
	52	struct rds_ib_frmr {
	53	struct ib_mr *mr;
	54	enum rds_ib_fr_state fr_state;
	55	bool fr_inv;
2c7da8e6	56	wait_queue_head_t fr_inv_done;
5f33141d GR	57	bool fr_reg;
5f33141d GR	58	wait_queue_head_t fr_reg_done;
1659185f AR	59	struct ib_send_wr fr_wr;
	60	unsigned int dma_npages;
	61	unsigned int sg_byte_len;
	62	};
	63
f6df683f	64	/* This is stored as mr->r_trans_private. */
f6df683f	65	struct rds_ib_mr {
2eafa174	66	struct delayed_work work;
d4de76da	67	struct rds_ib_device *device;
	68	struct rds_ib_mr_pool *pool;
	69	struct rds_ib_connection *ic;
f6df683f	70
d4de76da	71	struct llist_node llnode;
f6df683f	72
f6df683f	73	/* unmap_list is for freeing */
d4de76da	74	struct list_head unmap_list;
d4de76da	75	unsigned int remap_count;
f6df683f	76
d4de76da	77	struct scatterlist *sg;
	78	unsigned int sg_len;
	79	int sg_dma_len;
a69365a3	80
2eafa174	81	u8 odp:1;
a69365a3	82	union {
1659185f	83	struct rds_ib_frmr frmr;
2eafa174	84	struct ib_mr *mr;
a69365a3	85	} u;
f6df683f	86	};
	87
	88	/* Our own little MR pool */
	89	struct rds_ib_mr_pool {
	90	unsigned int pool_type;
	91	struct mutex flush_lock; /* serialize fmr invalidate */
	92	struct delayed_work flush_worker; /* flush worker */
	93
	94	atomic_t item_count; /* total # of MRs */
	95	atomic_t dirty_count; /* # dirty of MRs */
	96
	97	struct llist_head drop_list; /* MRs not reached max_maps */
	98	struct llist_head free_list; /* unused MRs */
	99	struct llist_head clean_list; /* unused & unmapped MRs */
	100	wait_queue_head_t flush_wait;
c9467447	101	spinlock_t clean_lock; /* "clean_list" concurrency */
f6df683f	102
	103	atomic_t free_pinned; /* memory pinned by free MRs */
	104	unsigned long max_items;
	105	unsigned long max_items_soft;
	106	unsigned long max_free_pinned;
07549ee2	107	unsigned int max_pages;
f6df683f	108	};
	109
	110	extern struct workqueue_struct *rds_ib_mr_wq;
2cb2912d	111	extern bool prefer_frmr;
f6df683f	112
	113	struct rds_ib_mr_pool rds_ib_create_mr_pool(struct rds_ib_device rds_dev,
	114	int npages);
	115	void rds_ib_get_mr_info(struct rds_ib_device *rds_ibdev,
	116	struct rds_info_rdma_connection *iinfo);
b7ff8b10 KCP	117	void rds6_ib_get_mr_info(struct rds_ib_device *rds_ibdev,
b7ff8b10 KCP	118	struct rds6_info_rdma_connection *iinfo6);
f6df683f	119	void rds_ib_destroy_mr_pool(struct rds_ib_mr_pool *);
f6df683f	120	void rds_ib_get_mr(struct scatterlist sg, unsigned long nents,
9e630bcb	121	struct rds_sock rs, u32 key_ret,
2eafa174 HWR	122	struct rds_connection *conn, u64 start, u64 length,
2eafa174 HWR	123	int need_odp);
f6df683f	124	void rds_ib_sync_mr(void *trans_private, int dir);
	125	void rds_ib_free_mr(void *trans_private, int invalidate);
	126	void rds_ib_flush_mrs(void);
	127	int rds_ib_mr_init(void);
	128	void rds_ib_mr_exit(void);
2eafa174	129	u32 rds_ib_get_lkey(void *trans_private);
f6df683f	130
	131	void __rds_ib_teardown_mr(struct rds_ib_mr *);
	132	void rds_ib_teardown_mr(struct rds_ib_mr *);
f6df683f	133	struct rds_ib_mr rds_ib_reuse_mr(struct rds_ib_mr_pool );
f6df683f	134	int rds_ib_flush_mr_pool(struct rds_ib_mr_pool , int, struct rds_ib_mr *);
490ea596	135	struct rds_ib_mr rds_ib_try_reuse_ibmr(struct rds_ib_mr_pool );
1659185f AR	136	struct rds_ib_mr rds_ib_reg_frmr(struct rds_ib_device rds_ibdev,
	137	struct rds_ib_connection *ic,
	138	struct scatterlist *sg,
	139	unsigned long nents, u32 *key);
	140	void rds_ib_unreg_frmr(struct list_head list, unsigned int nfreed,
	141	unsigned long *unpinned, unsigned int goal);
	142	void rds_ib_free_frmr_list(struct rds_ib_mr *);
f6df683f	143	#endif