1 // SPDX-License-Identifier: GPL-2.0 OR Linux-OpenIB
3 * Copyright (c) 2017-2018 Mellanox Technologies. All rights reserved.
6 #include <rdma/rdma_cm.h>
7 #include <rdma/ib_verbs.h>
8 #include <rdma/restrack.h>
9 #include <linux/mutex.h>
10 #include <linux/sched/task.h>
11 #include <linux/pid_namespace.h>
15 static int fill_res_noop(struct sk_buff *msg,
16 struct rdma_restrack_entry *entry)
21 void rdma_restrack_init(struct rdma_restrack_root *res)
23 init_rwsem(&res->rwsem);
24 res->fill_res_entry = fill_res_noop;
27 static const char *type2str(enum rdma_restrack_type type)
29 static const char * const names[RDMA_RESTRACK_MAX] = {
30 [RDMA_RESTRACK_PD] = "PD",
31 [RDMA_RESTRACK_CQ] = "CQ",
32 [RDMA_RESTRACK_QP] = "QP",
33 [RDMA_RESTRACK_CM_ID] = "CM_ID",
34 [RDMA_RESTRACK_MR] = "MR",
40 void rdma_restrack_clean(struct rdma_restrack_root *res)
42 struct rdma_restrack_entry *e;
43 char buf[TASK_COMM_LEN];
44 struct ib_device *dev;
48 if (hash_empty(res->hash))
51 dev = container_of(res, struct ib_device, res);
52 pr_err("restrack: %s", CUT_HERE);
53 dev_err(&dev->dev, "BUG: RESTRACK detected leak of resources\n");
54 hash_for_each(res->hash, bkt, e, node) {
55 if (rdma_is_kernel_res(e)) {
59 * There is no need to call get_task_struct here,
60 * because we can be here only if there are more
61 * get_task_struct() call than put_task_struct().
63 get_task_comm(buf, e->task);
67 pr_err("restrack: %s %s object allocated by %s is not freed\n",
68 rdma_is_kernel_res(e) ? "Kernel" : "User",
69 type2str(e->type), owner);
71 pr_err("restrack: %s", CUT_HERE);
74 int rdma_restrack_count(struct rdma_restrack_root *res,
75 enum rdma_restrack_type type,
76 struct pid_namespace *ns)
78 struct rdma_restrack_entry *e;
81 down_read(&res->rwsem);
82 hash_for_each_possible(res->hash, e, node, type) {
83 if (ns == &init_pid_ns ||
84 (!rdma_is_kernel_res(e) &&
85 ns == task_active_pid_ns(e->task)))
91 EXPORT_SYMBOL(rdma_restrack_count);
93 static void set_kern_name(struct rdma_restrack_entry *res)
98 case RDMA_RESTRACK_QP:
99 pd = container_of(res, struct ib_qp, res)->pd;
101 WARN_ONCE(true, "XRC QPs are not supported\n");
102 /* Survive, despite the programmer's error */
103 res->kern_name = " ";
106 case RDMA_RESTRACK_MR:
107 pd = container_of(res, struct ib_mr, res)->pd;
110 /* Other types set kern_name directly */
116 res->kern_name = pd->res.kern_name;
119 static struct ib_device *res_to_dev(struct rdma_restrack_entry *res)
122 case RDMA_RESTRACK_PD:
123 return container_of(res, struct ib_pd, res)->device;
124 case RDMA_RESTRACK_CQ:
125 return container_of(res, struct ib_cq, res)->device;
126 case RDMA_RESTRACK_QP:
127 return container_of(res, struct ib_qp, res)->device;
128 case RDMA_RESTRACK_CM_ID:
129 return container_of(res, struct rdma_id_private,
131 case RDMA_RESTRACK_MR:
132 return container_of(res, struct ib_mr, res)->device;
134 WARN_ONCE(true, "Wrong resource tracking type %u\n", res->type);
139 static bool res_is_user(struct rdma_restrack_entry *res)
142 case RDMA_RESTRACK_PD:
143 return container_of(res, struct ib_pd, res)->uobject;
144 case RDMA_RESTRACK_CQ:
145 return container_of(res, struct ib_cq, res)->uobject;
146 case RDMA_RESTRACK_QP:
147 return container_of(res, struct ib_qp, res)->uobject;
148 case RDMA_RESTRACK_CM_ID:
149 return !res->kern_name;
150 case RDMA_RESTRACK_MR:
151 return container_of(res, struct ib_mr, res)->pd->uobject;
153 WARN_ONCE(true, "Wrong resource tracking type %u\n", res->type);
158 void rdma_restrack_set_task(struct rdma_restrack_entry *res,
162 res->kern_name = caller;
167 put_task_struct(res->task);
168 get_task_struct(current);
171 EXPORT_SYMBOL(rdma_restrack_set_task);
173 void rdma_restrack_add(struct rdma_restrack_entry *res)
175 struct ib_device *dev = res_to_dev(res);
180 if (res->type != RDMA_RESTRACK_CM_ID || !res_is_user(res))
183 if (res_is_user(res)) {
185 rdma_restrack_set_task(res, NULL);
186 res->kern_name = NULL;
191 kref_init(&res->kref);
192 init_completion(&res->comp);
195 down_write(&dev->res.rwsem);
196 hash_add(dev->res.hash, &res->node, res->type);
197 up_write(&dev->res.rwsem);
199 EXPORT_SYMBOL(rdma_restrack_add);
201 int __must_check rdma_restrack_get(struct rdma_restrack_entry *res)
203 return kref_get_unless_zero(&res->kref);
205 EXPORT_SYMBOL(rdma_restrack_get);
207 static void restrack_release(struct kref *kref)
209 struct rdma_restrack_entry *res;
211 res = container_of(kref, struct rdma_restrack_entry, kref);
212 complete(&res->comp);
215 int rdma_restrack_put(struct rdma_restrack_entry *res)
217 return kref_put(&res->kref, restrack_release);
219 EXPORT_SYMBOL(rdma_restrack_put);
221 void rdma_restrack_del(struct rdma_restrack_entry *res)
223 struct ib_device *dev;
228 dev = res_to_dev(res);
232 rdma_restrack_put(res);
234 wait_for_completion(&res->comp);
236 down_write(&dev->res.rwsem);
237 hash_del(&res->node);
239 up_write(&dev->res.rwsem);
243 put_task_struct(res->task);
247 EXPORT_SYMBOL(rdma_restrack_del);