Loading...
1// SPDX-License-Identifier: GPL-2.0 OR Linux-OpenIB
2/*
3 * Copyright (c) 2017-2018 Mellanox Technologies. All rights reserved.
4 */
5
6#include <rdma/rdma_cm.h>
7#include <rdma/ib_verbs.h>
8#include <rdma/restrack.h>
9#include <rdma/rdma_counter.h>
10#include <linux/mutex.h>
11#include <linux/sched/task.h>
12#include <linux/pid_namespace.h>
13
14#include "cma_priv.h"
15#include "restrack.h"
16
17/**
18 * rdma_restrack_init() - initialize and allocate resource tracking
19 * @dev: IB device
20 *
21 * Return: 0 on success
22 */
23int rdma_restrack_init(struct ib_device *dev)
24{
25 struct rdma_restrack_root *rt;
26 int i;
27
28 dev->res = kcalloc(RDMA_RESTRACK_MAX, sizeof(*rt), GFP_KERNEL);
29 if (!dev->res)
30 return -ENOMEM;
31
32 rt = dev->res;
33
34 for (i = 0; i < RDMA_RESTRACK_MAX; i++)
35 xa_init_flags(&rt[i].xa, XA_FLAGS_ALLOC);
36
37 return 0;
38}
39
40/**
41 * rdma_restrack_clean() - clean resource tracking
42 * @dev: IB device
43 */
44void rdma_restrack_clean(struct ib_device *dev)
45{
46 struct rdma_restrack_root *rt = dev->res;
47 int i;
48
49 for (i = 0 ; i < RDMA_RESTRACK_MAX; i++) {
50 struct xarray *xa = &dev->res[i].xa;
51
52 WARN_ON(!xa_empty(xa));
53 xa_destroy(xa);
54 }
55 kfree(rt);
56}
57
58/**
59 * rdma_restrack_count() - the current usage of specific object
60 * @dev: IB device
61 * @type: actual type of object to operate
62 * @show_details: count driver specific objects
63 */
64int rdma_restrack_count(struct ib_device *dev, enum rdma_restrack_type type,
65 bool show_details)
66{
67 struct rdma_restrack_root *rt = &dev->res[type];
68 struct rdma_restrack_entry *e;
69 XA_STATE(xas, &rt->xa, 0);
70 u32 cnt = 0;
71
72 xa_lock(&rt->xa);
73 xas_for_each(&xas, e, U32_MAX) {
74 if (xa_get_mark(&rt->xa, e->id, RESTRACK_DD) && !show_details)
75 continue;
76 cnt++;
77 }
78 xa_unlock(&rt->xa);
79 return cnt;
80}
81EXPORT_SYMBOL(rdma_restrack_count);
82
83static struct ib_device *res_to_dev(struct rdma_restrack_entry *res)
84{
85 switch (res->type) {
86 case RDMA_RESTRACK_PD:
87 return container_of(res, struct ib_pd, res)->device;
88 case RDMA_RESTRACK_CQ:
89 return container_of(res, struct ib_cq, res)->device;
90 case RDMA_RESTRACK_QP:
91 return container_of(res, struct ib_qp, res)->device;
92 case RDMA_RESTRACK_CM_ID:
93 return container_of(res, struct rdma_id_private,
94 res)->id.device;
95 case RDMA_RESTRACK_MR:
96 return container_of(res, struct ib_mr, res)->device;
97 case RDMA_RESTRACK_CTX:
98 return container_of(res, struct ib_ucontext, res)->device;
99 case RDMA_RESTRACK_COUNTER:
100 return container_of(res, struct rdma_counter, res)->device;
101 case RDMA_RESTRACK_SRQ:
102 return container_of(res, struct ib_srq, res)->device;
103 default:
104 WARN_ONCE(true, "Wrong resource tracking type %u\n", res->type);
105 return NULL;
106 }
107}
108
109/**
110 * rdma_restrack_attach_task() - attach the task onto this resource,
111 * valid for user space restrack entries.
112 * @res: resource entry
113 * @task: the task to attach
114 */
115static void rdma_restrack_attach_task(struct rdma_restrack_entry *res,
116 struct task_struct *task)
117{
118 if (WARN_ON_ONCE(!task))
119 return;
120
121 if (res->task)
122 put_task_struct(res->task);
123 get_task_struct(task);
124 res->task = task;
125 res->user = true;
126}
127
128/**
129 * rdma_restrack_set_name() - set the task for this resource
130 * @res: resource entry
131 * @caller: kernel name, the current task will be used if the caller is NULL.
132 */
133void rdma_restrack_set_name(struct rdma_restrack_entry *res, const char *caller)
134{
135 if (caller) {
136 res->kern_name = caller;
137 return;
138 }
139
140 rdma_restrack_attach_task(res, current);
141}
142EXPORT_SYMBOL(rdma_restrack_set_name);
143
144/**
145 * rdma_restrack_parent_name() - set the restrack name properties based
146 * on parent restrack
147 * @dst: destination resource entry
148 * @parent: parent resource entry
149 */
150void rdma_restrack_parent_name(struct rdma_restrack_entry *dst,
151 const struct rdma_restrack_entry *parent)
152{
153 if (rdma_is_kernel_res(parent))
154 dst->kern_name = parent->kern_name;
155 else
156 rdma_restrack_attach_task(dst, parent->task);
157}
158EXPORT_SYMBOL(rdma_restrack_parent_name);
159
160/**
161 * rdma_restrack_new() - Initializes new restrack entry to allow _put() interface
162 * to release memory in fully automatic way.
163 * @res: Entry to initialize
164 * @type: REstrack type
165 */
166void rdma_restrack_new(struct rdma_restrack_entry *res,
167 enum rdma_restrack_type type)
168{
169 kref_init(&res->kref);
170 init_completion(&res->comp);
171 res->type = type;
172}
173EXPORT_SYMBOL(rdma_restrack_new);
174
175/**
176 * rdma_restrack_add() - add object to the reource tracking database
177 * @res: resource entry
178 */
179void rdma_restrack_add(struct rdma_restrack_entry *res)
180{
181 struct ib_device *dev = res_to_dev(res);
182 struct rdma_restrack_root *rt;
183 int ret = 0;
184
185 if (!dev)
186 return;
187
188 if (res->no_track)
189 goto out;
190
191 rt = &dev->res[res->type];
192
193 if (res->type == RDMA_RESTRACK_QP) {
194 /* Special case to ensure that LQPN points to right QP */
195 struct ib_qp *qp = container_of(res, struct ib_qp, res);
196
197 WARN_ONCE(qp->qp_num >> 24 || qp->port >> 8,
198 "QP number 0x%0X and port 0x%0X", qp->qp_num,
199 qp->port);
200 res->id = qp->qp_num;
201 if (qp->qp_type == IB_QPT_SMI || qp->qp_type == IB_QPT_GSI)
202 res->id |= qp->port << 24;
203 ret = xa_insert(&rt->xa, res->id, res, GFP_KERNEL);
204 if (ret)
205 res->id = 0;
206
207 if (qp->qp_type >= IB_QPT_DRIVER)
208 xa_set_mark(&rt->xa, res->id, RESTRACK_DD);
209 } else if (res->type == RDMA_RESTRACK_COUNTER) {
210 /* Special case to ensure that cntn points to right counter */
211 struct rdma_counter *counter;
212
213 counter = container_of(res, struct rdma_counter, res);
214 ret = xa_insert(&rt->xa, counter->id, res, GFP_KERNEL);
215 res->id = ret ? 0 : counter->id;
216 } else {
217 ret = xa_alloc_cyclic(&rt->xa, &res->id, res, xa_limit_32b,
218 &rt->next_id, GFP_KERNEL);
219 ret = (ret < 0) ? ret : 0;
220 }
221
222out:
223 if (!ret)
224 res->valid = true;
225}
226EXPORT_SYMBOL(rdma_restrack_add);
227
228int __must_check rdma_restrack_get(struct rdma_restrack_entry *res)
229{
230 return kref_get_unless_zero(&res->kref);
231}
232EXPORT_SYMBOL(rdma_restrack_get);
233
234/**
235 * rdma_restrack_get_byid() - translate from ID to restrack object
236 * @dev: IB device
237 * @type: resource track type
238 * @id: ID to take a look
239 *
240 * Return: Pointer to restrack entry or -ENOENT in case of error.
241 */
242struct rdma_restrack_entry *
243rdma_restrack_get_byid(struct ib_device *dev,
244 enum rdma_restrack_type type, u32 id)
245{
246 struct rdma_restrack_root *rt = &dev->res[type];
247 struct rdma_restrack_entry *res;
248
249 xa_lock(&rt->xa);
250 res = xa_load(&rt->xa, id);
251 if (!res || !rdma_restrack_get(res))
252 res = ERR_PTR(-ENOENT);
253 xa_unlock(&rt->xa);
254
255 return res;
256}
257EXPORT_SYMBOL(rdma_restrack_get_byid);
258
259static void restrack_release(struct kref *kref)
260{
261 struct rdma_restrack_entry *res;
262
263 res = container_of(kref, struct rdma_restrack_entry, kref);
264 if (res->task) {
265 put_task_struct(res->task);
266 res->task = NULL;
267 }
268 complete(&res->comp);
269}
270
271int rdma_restrack_put(struct rdma_restrack_entry *res)
272{
273 return kref_put(&res->kref, restrack_release);
274}
275EXPORT_SYMBOL(rdma_restrack_put);
276
277/**
278 * rdma_restrack_del() - delete object from the reource tracking database
279 * @res: resource entry
280 */
281void rdma_restrack_del(struct rdma_restrack_entry *res)
282{
283 struct rdma_restrack_entry *old;
284 struct rdma_restrack_root *rt;
285 struct ib_device *dev;
286
287 if (!res->valid) {
288 if (res->task) {
289 put_task_struct(res->task);
290 res->task = NULL;
291 }
292 return;
293 }
294
295 if (res->no_track)
296 goto out;
297
298 dev = res_to_dev(res);
299 if (WARN_ON(!dev))
300 return;
301
302 rt = &dev->res[res->type];
303
304 old = xa_erase(&rt->xa, res->id);
305 WARN_ON(old != res);
306
307out:
308 res->valid = false;
309 rdma_restrack_put(res);
310 wait_for_completion(&res->comp);
311}
312EXPORT_SYMBOL(rdma_restrack_del);
1// SPDX-License-Identifier: GPL-2.0 OR Linux-OpenIB
2/*
3 * Copyright (c) 2017-2018 Mellanox Technologies. All rights reserved.
4 */
5
6#include <rdma/rdma_cm.h>
7#include <rdma/ib_verbs.h>
8#include <rdma/restrack.h>
9#include <rdma/rdma_counter.h>
10#include <linux/mutex.h>
11#include <linux/sched/task.h>
12#include <linux/pid_namespace.h>
13
14#include "cma_priv.h"
15#include "restrack.h"
16
17/**
18 * rdma_restrack_init() - initialize and allocate resource tracking
19 * @dev: IB device
20 *
21 * Return: 0 on success
22 */
23int rdma_restrack_init(struct ib_device *dev)
24{
25 struct rdma_restrack_root *rt;
26 int i;
27
28 dev->res = kcalloc(RDMA_RESTRACK_MAX, sizeof(*rt), GFP_KERNEL);
29 if (!dev->res)
30 return -ENOMEM;
31
32 rt = dev->res;
33
34 for (i = 0; i < RDMA_RESTRACK_MAX; i++)
35 xa_init_flags(&rt[i].xa, XA_FLAGS_ALLOC);
36
37 return 0;
38}
39
40static const char *type2str(enum rdma_restrack_type type)
41{
42 static const char * const names[RDMA_RESTRACK_MAX] = {
43 [RDMA_RESTRACK_PD] = "PD",
44 [RDMA_RESTRACK_CQ] = "CQ",
45 [RDMA_RESTRACK_QP] = "QP",
46 [RDMA_RESTRACK_CM_ID] = "CM_ID",
47 [RDMA_RESTRACK_MR] = "MR",
48 [RDMA_RESTRACK_CTX] = "CTX",
49 [RDMA_RESTRACK_COUNTER] = "COUNTER",
50 };
51
52 return names[type];
53};
54
55/**
56 * rdma_restrack_clean() - clean resource tracking
57 * @dev: IB device
58 */
59void rdma_restrack_clean(struct ib_device *dev)
60{
61 struct rdma_restrack_root *rt = dev->res;
62 struct rdma_restrack_entry *e;
63 char buf[TASK_COMM_LEN];
64 bool found = false;
65 const char *owner;
66 int i;
67
68 for (i = 0 ; i < RDMA_RESTRACK_MAX; i++) {
69 struct xarray *xa = &dev->res[i].xa;
70
71 if (!xa_empty(xa)) {
72 unsigned long index;
73
74 if (!found) {
75 pr_err("restrack: %s", CUT_HERE);
76 dev_err(&dev->dev, "BUG: RESTRACK detected leak of resources\n");
77 }
78 xa_for_each(xa, index, e) {
79 if (rdma_is_kernel_res(e)) {
80 owner = e->kern_name;
81 } else {
82 /*
83 * There is no need to call get_task_struct here,
84 * because we can be here only if there are more
85 * get_task_struct() call than put_task_struct().
86 */
87 get_task_comm(buf, e->task);
88 owner = buf;
89 }
90
91 pr_err("restrack: %s %s object allocated by %s is not freed\n",
92 rdma_is_kernel_res(e) ? "Kernel" :
93 "User",
94 type2str(e->type), owner);
95 }
96 found = true;
97 }
98 xa_destroy(xa);
99 }
100 if (found)
101 pr_err("restrack: %s", CUT_HERE);
102
103 kfree(rt);
104}
105
106/**
107 * rdma_restrack_count() - the current usage of specific object
108 * @dev: IB device
109 * @type: actual type of object to operate
110 */
111int rdma_restrack_count(struct ib_device *dev, enum rdma_restrack_type type)
112{
113 struct rdma_restrack_root *rt = &dev->res[type];
114 struct rdma_restrack_entry *e;
115 XA_STATE(xas, &rt->xa, 0);
116 u32 cnt = 0;
117
118 xa_lock(&rt->xa);
119 xas_for_each(&xas, e, U32_MAX) {
120 if (!rdma_is_visible_in_pid_ns(e))
121 continue;
122 cnt++;
123 }
124 xa_unlock(&rt->xa);
125 return cnt;
126}
127EXPORT_SYMBOL(rdma_restrack_count);
128
129static void set_kern_name(struct rdma_restrack_entry *res)
130{
131 struct ib_pd *pd;
132
133 switch (res->type) {
134 case RDMA_RESTRACK_QP:
135 pd = container_of(res, struct ib_qp, res)->pd;
136 if (!pd) {
137 WARN_ONCE(true, "XRC QPs are not supported\n");
138 /* Survive, despite the programmer's error */
139 res->kern_name = " ";
140 }
141 break;
142 case RDMA_RESTRACK_MR:
143 pd = container_of(res, struct ib_mr, res)->pd;
144 break;
145 default:
146 /* Other types set kern_name directly */
147 pd = NULL;
148 break;
149 }
150
151 if (pd)
152 res->kern_name = pd->res.kern_name;
153}
154
155static struct ib_device *res_to_dev(struct rdma_restrack_entry *res)
156{
157 switch (res->type) {
158 case RDMA_RESTRACK_PD:
159 return container_of(res, struct ib_pd, res)->device;
160 case RDMA_RESTRACK_CQ:
161 return container_of(res, struct ib_cq, res)->device;
162 case RDMA_RESTRACK_QP:
163 return container_of(res, struct ib_qp, res)->device;
164 case RDMA_RESTRACK_CM_ID:
165 return container_of(res, struct rdma_id_private,
166 res)->id.device;
167 case RDMA_RESTRACK_MR:
168 return container_of(res, struct ib_mr, res)->device;
169 case RDMA_RESTRACK_CTX:
170 return container_of(res, struct ib_ucontext, res)->device;
171 case RDMA_RESTRACK_COUNTER:
172 return container_of(res, struct rdma_counter, res)->device;
173 default:
174 WARN_ONCE(true, "Wrong resource tracking type %u\n", res->type);
175 return NULL;
176 }
177}
178
179void rdma_restrack_set_task(struct rdma_restrack_entry *res,
180 const char *caller)
181{
182 if (caller) {
183 res->kern_name = caller;
184 return;
185 }
186
187 if (res->task)
188 put_task_struct(res->task);
189 get_task_struct(current);
190 res->task = current;
191}
192EXPORT_SYMBOL(rdma_restrack_set_task);
193
194/**
195 * rdma_restrack_attach_task() - attach the task onto this resource
196 * @res: resource entry
197 * @task: the task to attach, the current task will be used if it is NULL.
198 */
199void rdma_restrack_attach_task(struct rdma_restrack_entry *res,
200 struct task_struct *task)
201{
202 if (res->task)
203 put_task_struct(res->task);
204 get_task_struct(task);
205 res->task = task;
206}
207
208static void rdma_restrack_add(struct rdma_restrack_entry *res)
209{
210 struct ib_device *dev = res_to_dev(res);
211 struct rdma_restrack_root *rt;
212 int ret;
213
214 if (!dev)
215 return;
216
217 rt = &dev->res[res->type];
218
219 kref_init(&res->kref);
220 init_completion(&res->comp);
221 if (res->type == RDMA_RESTRACK_QP) {
222 /* Special case to ensure that LQPN points to right QP */
223 struct ib_qp *qp = container_of(res, struct ib_qp, res);
224
225 ret = xa_insert(&rt->xa, qp->qp_num, res, GFP_KERNEL);
226 res->id = ret ? 0 : qp->qp_num;
227 } else if (res->type == RDMA_RESTRACK_COUNTER) {
228 /* Special case to ensure that cntn points to right counter */
229 struct rdma_counter *counter;
230
231 counter = container_of(res, struct rdma_counter, res);
232 ret = xa_insert(&rt->xa, counter->id, res, GFP_KERNEL);
233 res->id = ret ? 0 : counter->id;
234 } else {
235 ret = xa_alloc_cyclic(&rt->xa, &res->id, res, xa_limit_32b,
236 &rt->next_id, GFP_KERNEL);
237 }
238
239 if (!ret)
240 res->valid = true;
241}
242
243/**
244 * rdma_restrack_kadd() - add kernel object to the reource tracking database
245 * @res: resource entry
246 */
247void rdma_restrack_kadd(struct rdma_restrack_entry *res)
248{
249 res->task = NULL;
250 set_kern_name(res);
251 res->user = false;
252 rdma_restrack_add(res);
253}
254EXPORT_SYMBOL(rdma_restrack_kadd);
255
256/**
257 * rdma_restrack_uadd() - add user object to the reource tracking database
258 * @res: resource entry
259 */
260void rdma_restrack_uadd(struct rdma_restrack_entry *res)
261{
262 if ((res->type != RDMA_RESTRACK_CM_ID) &&
263 (res->type != RDMA_RESTRACK_COUNTER))
264 res->task = NULL;
265
266 if (!res->task)
267 rdma_restrack_set_task(res, NULL);
268 res->kern_name = NULL;
269
270 res->user = true;
271 rdma_restrack_add(res);
272}
273EXPORT_SYMBOL(rdma_restrack_uadd);
274
275int __must_check rdma_restrack_get(struct rdma_restrack_entry *res)
276{
277 return kref_get_unless_zero(&res->kref);
278}
279EXPORT_SYMBOL(rdma_restrack_get);
280
281/**
282 * rdma_restrack_get_byid() - translate from ID to restrack object
283 * @dev: IB device
284 * @type: resource track type
285 * @id: ID to take a look
286 *
287 * Return: Pointer to restrack entry or -ENOENT in case of error.
288 */
289struct rdma_restrack_entry *
290rdma_restrack_get_byid(struct ib_device *dev,
291 enum rdma_restrack_type type, u32 id)
292{
293 struct rdma_restrack_root *rt = &dev->res[type];
294 struct rdma_restrack_entry *res;
295
296 xa_lock(&rt->xa);
297 res = xa_load(&rt->xa, id);
298 if (!res || !rdma_restrack_get(res))
299 res = ERR_PTR(-ENOENT);
300 xa_unlock(&rt->xa);
301
302 return res;
303}
304EXPORT_SYMBOL(rdma_restrack_get_byid);
305
306static void restrack_release(struct kref *kref)
307{
308 struct rdma_restrack_entry *res;
309
310 res = container_of(kref, struct rdma_restrack_entry, kref);
311 complete(&res->comp);
312}
313
314int rdma_restrack_put(struct rdma_restrack_entry *res)
315{
316 return kref_put(&res->kref, restrack_release);
317}
318EXPORT_SYMBOL(rdma_restrack_put);
319
320void rdma_restrack_del(struct rdma_restrack_entry *res)
321{
322 struct rdma_restrack_entry *old;
323 struct rdma_restrack_root *rt;
324 struct ib_device *dev;
325
326 if (!res->valid)
327 goto out;
328
329 dev = res_to_dev(res);
330 if (WARN_ON(!dev))
331 return;
332
333 rt = &dev->res[res->type];
334
335 old = xa_erase(&rt->xa, res->id);
336 WARN_ON(old != res);
337 res->valid = false;
338
339 rdma_restrack_put(res);
340 wait_for_completion(&res->comp);
341
342out:
343 if (res->task) {
344 put_task_struct(res->task);
345 res->task = NULL;
346 }
347}
348EXPORT_SYMBOL(rdma_restrack_del);
349
350bool rdma_is_visible_in_pid_ns(struct rdma_restrack_entry *res)
351{
352 /*
353 * 1. Kern resources should be visible in init
354 * namespace only
355 * 2. Present only resources visible in the current
356 * namespace
357 */
358 if (rdma_is_kernel_res(res))
359 return task_active_pid_ns(current) == &init_pid_ns;
360
361 /* PID 0 means that resource is not found in current namespace */
362 return task_pid_vnr(res->task);
363}