[mirror_ubuntu-focal-kernel.git] / include / rdma / restrack.h

/* SPDX-License-Identifier: GPL-2.0 OR Linux-OpenIB */
/*
 * Copyright (c) 2017-2018 Mellanox Technologies. All rights reserved.
 */

#ifndef _RDMA_RESTRACK_H_
#define _RDMA_RESTRACK_H_

#include <linux/typecheck.h>
#include <linux/sched.h>
#include <linux/kref.h>
#include <linux/completion.h>
#include <linux/sched/task.h>
#include <uapi/rdma/rdma_netlink.h>
#include <linux/xarray.h>

struct ib_device;
struct sk_buff;

/**
 * enum rdma_restrack_type - HW objects to track
 */
enum rdma_restrack_type {
	/**
	 * @RDMA_RESTRACK_PD: Protection domain (PD)
	 */
	RDMA_RESTRACK_PD,
	/**
	 * @RDMA_RESTRACK_CQ: Completion queue (CQ)
	 */
	RDMA_RESTRACK_CQ,
	/**
	 * @RDMA_RESTRACK_QP: Queue pair (QP)
	 */
	RDMA_RESTRACK_QP,
	/**
	 * @RDMA_RESTRACK_CM_ID: Connection Manager ID (CM_ID)
	 */
	RDMA_RESTRACK_CM_ID,
	/**
	 * @RDMA_RESTRACK_MR: Memory Region (MR)
	 */
	RDMA_RESTRACK_MR,
	/**
	 * @RDMA_RESTRACK_CTX: Verbs contexts (CTX)
	 */
	RDMA_RESTRACK_CTX,
	/**
	 * @RDMA_RESTRACK_COUNTER: Statistic Counter
	 */
	RDMA_RESTRACK_COUNTER,
	/**
	 * @RDMA_RESTRACK_MAX: Last entry, used for array dclarations
	 */
	RDMA_RESTRACK_MAX
};

/**
 * struct rdma_restrack_entry - metadata per-entry
 */
struct rdma_restrack_entry {
	/**
	 * @valid: validity indicator
	 *
	 * The entries are filled during rdma_restrack_add,
	 * can be attempted to be free during rdma_restrack_del.
	 *
	 * As an example for that, see mlx5 QPs with type MLX5_IB_QPT_HW_GSI
	 */
	bool			valid;
	/*
	 * @kref: Protect destroy of the resource
	 */
	struct kref		kref;
	/*
	 * @comp: Signal that all consumers of resource are completed their work
	 */
	struct completion	comp;
	/**
	 * @task: owner of resource tracking entity
	 *
	 * There are two types of entities: created by user and created
	 * by kernel.
	 *
	 * This is relevant for the entities created by users.
	 * For the entities created by kernel, this pointer will be NULL.
	 */
	struct task_struct	*task;
	/**
	 * @kern_name: name of owner for the kernel created entities.
	 */
	const char		*kern_name;
	/**
	 * @type: various objects in restrack database
	 */
	enum rdma_restrack_type	type;
	/**
	 * @user: user resource
	 */
	bool			user;
	/**
	 * @id: ID to expose to users
	 */
	u32 id;
};

int rdma_restrack_count(struct ib_device *dev,
			enum rdma_restrack_type type);

void rdma_restrack_kadd(struct rdma_restrack_entry *res);
void rdma_restrack_uadd(struct rdma_restrack_entry *res);

/**
 * rdma_restrack_del() - delete object from the reource tracking database
 * @res:  resource entry
 * @type: actual type of object to operate
 */
void rdma_restrack_del(struct rdma_restrack_entry *res);

/**
 * rdma_is_kernel_res() - check the owner of resource
 * @res:  resource entry
 */
static inline bool rdma_is_kernel_res(struct rdma_restrack_entry *res)
{
	return !res->user;
}

/**
 * rdma_restrack_get() - grab to protect resource from release
 * @res:  resource entry
 */
int __must_check rdma_restrack_get(struct rdma_restrack_entry *res);

/**
 * rdma_restrack_put() - release resource
 * @res:  resource entry
 */
int rdma_restrack_put(struct rdma_restrack_entry *res);

/**
 * rdma_restrack_set_task() - set the task for this resource
 * @res:  resource entry
 * @caller: kernel name, the current task will be used if the caller is NULL.
 */
void rdma_restrack_set_task(struct rdma_restrack_entry *res,
			    const char *caller);

/*
 * Helper functions for rdma drivers when filling out
 * nldev driver attributes.
 */
int rdma_nl_put_driver_u32(struct sk_buff *msg, const char *name, u32 value);
int rdma_nl_put_driver_u32_hex(struct sk_buff *msg, const char *name,
			       u32 value);
int rdma_nl_put_driver_u64(struct sk_buff *msg, const char *name, u64 value);
int rdma_nl_put_driver_u64_hex(struct sk_buff *msg, const char *name,
			       u64 value);
struct rdma_restrack_entry *rdma_restrack_get_byid(struct ib_device *dev,
						   enum rdma_restrack_type type,
						   u32 id);
#endif /* _RDMA_RESTRACK_H_ */
Commit	Line	Data
33edc3b2	1	/* SPDX-License-Identifier: GPL-2.0 OR Linux-OpenIB */
02d8883f LR	2	/*
	3	* Copyright (c) 2017-2018 Mellanox Technologies. All rights reserved.
	4	*/
	5
	6	#ifndef _RDMA_RESTRACK_H_
	7	#define _RDMA_RESTRACK_H_
	8
	9	#include <linux/typecheck.h>
02d8883f LR	10	#include <linux/sched.h>
	11	#include <linux/kref.h>
	12	#include <linux/completion.h>
00313983	13	#include <linux/sched/task.h>
73937e8a	14	#include <uapi/rdma/rdma_netlink.h>
fd47c2f9	15	#include <linux/xarray.h>
02d8883f	16
390d5772 JG	17	struct ib_device;
	18	struct sk_buff;
	19
02d8883f LR	20	/**
	21	* enum rdma_restrack_type - HW objects to track
	22	*/
	23	enum rdma_restrack_type {
	24	/**
	25	* @RDMA_RESTRACK_PD: Protection domain (PD)
	26	*/
	27	RDMA_RESTRACK_PD,
	28	/**
	29	* @RDMA_RESTRACK_CQ: Completion queue (CQ)
	30	*/
	31	RDMA_RESTRACK_CQ,
	32	/**
	33	* @RDMA_RESTRACK_QP: Queue pair (QP)
	34	*/
	35	RDMA_RESTRACK_QP,
00313983 SW	36	/**
	37	* @RDMA_RESTRACK_CM_ID: Connection Manager ID (CM_ID)
	38	*/
	39	RDMA_RESTRACK_CM_ID,
fccec5b8 SW	40	/**
	41	* @RDMA_RESTRACK_MR: Memory Region (MR)
	42	*/
	43	RDMA_RESTRACK_MR,
60615210 LR	44	/**
	45	* @RDMA_RESTRACK_CTX: Verbs contexts (CTX)
	46	*/
	47	RDMA_RESTRACK_CTX,
7ade1ff9 MZ	48	/**
	49	* @RDMA_RESTRACK_COUNTER: Statistic Counter
	50	*/
	51	RDMA_RESTRACK_COUNTER,
02d8883f LR	52	/**
	53	* @RDMA_RESTRACK_MAX: Last entry, used for array dclarations
	54	*/
	55	RDMA_RESTRACK_MAX
	56	};
	57
02d8883f LR	58	/**
	59	* struct rdma_restrack_entry - metadata per-entry
	60	*/
	61	struct rdma_restrack_entry {
	62	/**
	63	* @valid: validity indicator
	64	*
	65	* The entries are filled during rdma_restrack_add,
	66	* can be attempted to be free during rdma_restrack_del.
	67	*
	68	* As an example for that, see mlx5 QPs with type MLX5_IB_QPT_HW_GSI
	69	*/
	70	bool valid;
	71	/*
	72	* @kref: Protect destroy of the resource
	73	*/
	74	struct kref kref;
	75	/*
	76	* @comp: Signal that all consumers of resource are completed their work
	77	*/
	78	struct completion comp;
	79	/**
	80	* @task: owner of resource tracking entity
	81	*
	82	* There are two types of entities: created by user and created
	83	* by kernel.
	84	*
	85	* This is relevant for the entities created by users.
	86	* For the entities created by kernel, this pointer will be NULL.
	87	*/
	88	struct task_struct *task;
	89	/**
	90	* @kern_name: name of owner for the kernel created entities.
	91	*/
	92	const char *kern_name;
02d8883f LR	93	/**
	94	* @type: various objects in restrack database
	95	*/
	96	enum rdma_restrack_type type;
af8d7037 SR	97	/**
	98	* @user: user resource
	99	*/
	100	bool user;
fd47c2f9 LR	101	/**
	102	* @id: ID to expose to users
	103	*/
	104	u32 id;
02d8883f LR	105	};
02d8883f LR	106
0ad699c0	107	int rdma_restrack_count(struct ib_device *dev,
60c78668	108	enum rdma_restrack_type type);
02d8883f	109
af8d7037 SR	110	void rdma_restrack_kadd(struct rdma_restrack_entry *res);
af8d7037 SR	111	void rdma_restrack_uadd(struct rdma_restrack_entry *res);
02d8883f LR	112
	113	/**
	114	* rdma_restrack_del() - delete object from the reource tracking database
	115	* @res: resource entry
	116	* @type: actual type of object to operate
	117	*/
	118	void rdma_restrack_del(struct rdma_restrack_entry *res);
	119
	120	/**
	121	* rdma_is_kernel_res() - check the owner of resource
	122	* @res: resource entry
	123	*/
	124	static inline bool rdma_is_kernel_res(struct rdma_restrack_entry *res)
	125	{
af8d7037	126	return !res->user;
02d8883f LR	127	}
	128
	129	/**
	130	* rdma_restrack_get() - grab to protect resource from release
	131	* @res: resource entry
	132	*/
	133	int __must_check rdma_restrack_get(struct rdma_restrack_entry *res);
	134
	135	/**
03286030	136	* rdma_restrack_put() - release resource
02d8883f LR	137	* @res: resource entry
	138	*/
	139	int rdma_restrack_put(struct rdma_restrack_entry *res);
00313983 SW	140
	141	/**
	142	* rdma_restrack_set_task() - set the task for this resource
	143	* @res: resource entry
2165fc26	144	* @caller: kernel name, the current task will be used if the caller is NULL.
00313983	145	*/
363ad355	146	void rdma_restrack_set_task(struct rdma_restrack_entry *res,
2165fc26	147	const char *caller);
00313983	148
73937e8a SW	149	/*
	150	* Helper functions for rdma drivers when filling out
	151	* nldev driver attributes.
	152	*/
	153	int rdma_nl_put_driver_u32(struct sk_buff msg, const char name, u32 value);
	154	int rdma_nl_put_driver_u32_hex(struct sk_buff msg, const char name,
	155	u32 value);
	156	int rdma_nl_put_driver_u64(struct sk_buff msg, const char name, u64 value);
	157	int rdma_nl_put_driver_u64_hex(struct sk_buff msg, const char name,
	158	u64 value);
18c4c66f LR	159	struct rdma_restrack_entry rdma_restrack_get_byid(struct ib_device dev,
	160	enum rdma_restrack_type type,
	161	u32 id);
02d8883f	162	#endif /* _RDMA_RESTRACK_H_ */