[thirdparty/kernel/stable.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>

/**
 * 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_MAX: Last entry, used for array dclarations
	 */
	RDMA_RESTRACK_MAX
};

struct ib_device;

/**
 * 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,
			struct pid_namespace *ns);

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