[mirror_ubuntu-jammy-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_SRQ: Shared receive queue (SRQ)
	 */
	RDMA_RESTRACK_SRQ,
	/**
	 * @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;
	/**
	 * @no_track: don't add this entry to restrack DB
	 *
	 * This field is used to mark an entry that doesn't need to be added to
	 * internal restrack DB and presented later to the users at the nldev
	 * query stage.
	 */
	u8			no_track : 1;
	/*
	 * @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);
/**
 * rdma_is_kernel_res() - check the owner of resource
 * @res:  resource entry
 */
static inline bool rdma_is_kernel_res(const 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);

/*
 * 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);
int rdma_nl_put_driver_string(struct sk_buff *msg, const char *name,
			      const char *str);
int rdma_nl_stat_hwcounter_entry(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);

/**
 * rdma_restrack_no_track() - don't add resource to the DB
 * @res: resource entry
 *
 * Every user of thie API should be cross examined.
 * Probaby you don't need to use this function.
 */
static inline void rdma_restrack_no_track(struct rdma_restrack_entry *res)
{
	res->no_track = true;
}
static inline bool rdma_restrack_is_tracked(struct rdma_restrack_entry *res)
{
	return !res->no_track;
}
#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,
48f8a70e NO	52	/**
	53	* @RDMA_RESTRACK_SRQ: Shared receive queue (SRQ)
	54	*/
	55	RDMA_RESTRACK_SRQ,
02d8883f LR	56	/**
	57	* @RDMA_RESTRACK_MAX: Last entry, used for array dclarations
	58	*/
	59	RDMA_RESTRACK_MAX
	60	};
	61
02d8883f LR	62	/**
	63	* struct rdma_restrack_entry - metadata per-entry
	64	*/
	65	struct rdma_restrack_entry {
	66	/**
	67	* @valid: validity indicator
	68	*
	69	* The entries are filled during rdma_restrack_add,
	70	* can be attempted to be free during rdma_restrack_del.
	71	*
	72	* As an example for that, see mlx5 QPs with type MLX5_IB_QPT_HW_GSI
	73	*/
	74	bool valid;
2b1f7470 LR	75	/**
	76	* @no_track: don't add this entry to restrack DB
	77	*
	78	* This field is used to mark an entry that doesn't need to be added to
	79	* internal restrack DB and presented later to the users at the nldev
	80	* query stage.
	81	*/
	82	u8 no_track : 1;
02d8883f LR	83	/*
	84	* @kref: Protect destroy of the resource
	85	*/
	86	struct kref kref;
	87	/*
	88	* @comp: Signal that all consumers of resource are completed their work
	89	*/
	90	struct completion comp;
	91	/**
	92	* @task: owner of resource tracking entity
	93	*
	94	* There are two types of entities: created by user and created
	95	* by kernel.
	96	*
	97	* This is relevant for the entities created by users.
	98	* For the entities created by kernel, this pointer will be NULL.
	99	*/
	100	struct task_struct *task;
	101	/**
	102	* @kern_name: name of owner for the kernel created entities.
	103	*/
	104	const char *kern_name;
02d8883f LR	105	/**
	106	* @type: various objects in restrack database
	107	*/
	108	enum rdma_restrack_type type;
af8d7037 SR	109	/**
	110	* @user: user resource
	111	*/
	112	bool user;
fd47c2f9 LR	113	/**
	114	* @id: ID to expose to users
	115	*/
	116	u32 id;
02d8883f LR	117	};
02d8883f LR	118
0ad699c0	119	int rdma_restrack_count(struct ib_device *dev,
60c78668	120	enum rdma_restrack_type type);
02d8883f LR	121	/**
	122	* rdma_is_kernel_res() - check the owner of resource
	123	* @res: resource entry
	124	*/
b09c4d70	125	static inline bool rdma_is_kernel_res(const struct rdma_restrack_entry *res)
02d8883f	126	{
af8d7037	127	return !res->user;
02d8883f LR	128	}
	129
	130	/**
	131	* rdma_restrack_get() - grab to protect resource from release
	132	* @res: resource entry
	133	*/
	134	int __must_check rdma_restrack_get(struct rdma_restrack_entry *res);
	135
	136	/**
03286030	137	* rdma_restrack_put() - release resource
02d8883f LR	138	* @res: resource entry
	139	*/
	140	int rdma_restrack_put(struct rdma_restrack_entry *res);
00313983	141
73937e8a SW	142	/*
	143	* Helper functions for rdma drivers when filling out
	144	* nldev driver attributes.
	145	*/
	146	int rdma_nl_put_driver_u32(struct sk_buff msg, const char name, u32 value);
	147	int rdma_nl_put_driver_u32_hex(struct sk_buff msg, const char name,
	148	u32 value);
	149	int rdma_nl_put_driver_u64(struct sk_buff msg, const char name, u64 value);
	150	int rdma_nl_put_driver_u64_hex(struct sk_buff msg, const char name,
	151	u64 value);
e1b95ae0 EA	152	int rdma_nl_put_driver_string(struct sk_buff msg, const char name,
e1b95ae0 EA	153	const char *str);
4061ff7a EA	154	int rdma_nl_stat_hwcounter_entry(struct sk_buff msg, const char name,
4061ff7a EA	155	u64 value);
e1b95ae0	156
18c4c66f LR	157	struct rdma_restrack_entry rdma_restrack_get_byid(struct ib_device dev,
	158	enum rdma_restrack_type type,
	159	u32 id);
2b1f7470 LR	160
	161	/**
	162	* rdma_restrack_no_track() - don't add resource to the DB
	163	* @res: resource entry
	164	*
	165	* Every user of thie API should be cross examined.
	166	* Probaby you don't need to use this function.
	167	*/
	168	static inline void rdma_restrack_no_track(struct rdma_restrack_entry *res)
	169	{
	170	res->no_track = true;
	171	}
	172	static inline bool rdma_restrack_is_tracked(struct rdma_restrack_entry *res)
	173	{
	174	return !res->no_track;
	175	}
02d8883f	176	#endif /* _RDMA_RESTRACK_H_ */