1 /* SPDX-License-Identifier: (GPL-2.0+ OR BSD-3-Clause) */
3 * Copyright (c) 2017-2018 Mellanox Technologies. All rights reserved.
6 #ifndef _RDMA_RESTRACK_H_
7 #define _RDMA_RESTRACK_H_
9 #include <linux/typecheck.h>
10 #include <linux/rwsem.h>
11 #include <linux/sched.h>
12 #include <linux/kref.h>
13 #include <linux/completion.h>
14 #include <linux/sched/task.h>
17 * enum rdma_restrack_type - HW objects to track
19 enum rdma_restrack_type {
21 * @RDMA_RESTRACK_PD: Protection domain (PD)
25 * @RDMA_RESTRACK_CQ: Completion queue (CQ)
29 * @RDMA_RESTRACK_QP: Queue pair (QP)
33 * @RDMA_RESTRACK_CM_ID: Connection Manager ID (CM_ID)
37 * @RDMA_RESTRACK_MR: Memory Region (MR)
41 * @RDMA_RESTRACK_MAX: Last entry, used for array dclarations
46 #define RDMA_RESTRACK_HASH_BITS 8
48 * struct rdma_restrack_root - main resource tracking management
51 struct rdma_restrack_root {
53 * @rwsem: Read/write lock to protect lists
55 struct rw_semaphore rwsem;
57 * @hash: global database for all resources per-device
59 DECLARE_HASHTABLE(hash, RDMA_RESTRACK_HASH_BITS);
63 * struct rdma_restrack_entry - metadata per-entry
65 struct rdma_restrack_entry {
67 * @valid: validity indicator
69 * The entries are filled during rdma_restrack_add,
70 * can be attempted to be free during rdma_restrack_del.
72 * As an example for that, see mlx5 QPs with type MLX5_IB_QPT_HW_GSI
76 * @kref: Protect destroy of the resource
80 * @comp: Signal that all consumers of resource are completed their work
82 struct completion comp;
84 * @task: owner of resource tracking entity
86 * There are two types of entities: created by user and created
89 * This is relevant for the entities created by users.
90 * For the entities created by kernel, this pointer will be NULL.
92 struct task_struct *task;
94 * @kern_name: name of owner for the kernel created entities.
96 const char *kern_name;
98 * @node: hash table entry
100 struct hlist_node node;
102 * @type: various objects in restrack database
104 enum rdma_restrack_type type;
108 * rdma_restrack_init() - initialize resource tracking
109 * @res: resource tracking root
111 void rdma_restrack_init(struct rdma_restrack_root *res);
114 * rdma_restrack_clean() - clean resource tracking
115 * @res: resource tracking root
117 void rdma_restrack_clean(struct rdma_restrack_root *res);
120 * rdma_restrack_count() - the current usage of specific object
121 * @res: resource entry
122 * @type: actual type of object to operate
125 int rdma_restrack_count(struct rdma_restrack_root *res,
126 enum rdma_restrack_type type,
127 struct pid_namespace *ns);
130 * rdma_restrack_add() - add object to the reource tracking database
131 * @res: resource entry
133 void rdma_restrack_add(struct rdma_restrack_entry *res);
136 * rdma_restrack_del() - delete object from the reource tracking database
137 * @res: resource entry
138 * @type: actual type of object to operate
140 void rdma_restrack_del(struct rdma_restrack_entry *res);
143 * rdma_is_kernel_res() - check the owner of resource
144 * @res: resource entry
146 static inline bool rdma_is_kernel_res(struct rdma_restrack_entry *res)
152 * rdma_restrack_get() - grab to protect resource from release
153 * @res: resource entry
155 int __must_check rdma_restrack_get(struct rdma_restrack_entry *res);
158 * rdma_restrack_put() - release resource
159 * @res: resource entry
161 int rdma_restrack_put(struct rdma_restrack_entry *res);
164 * rdma_restrack_set_task() - set the task for this resource
165 * @res: resource entry
168 static inline void rdma_restrack_set_task(struct rdma_restrack_entry *res,
169 struct task_struct *task)
172 put_task_struct(res->task);
173 get_task_struct(task);
177 #endif /* _RDMA_RESTRACK_H_ */