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#ifndef _RDMA_RESTRACK_H_
7#define _RDMA_RESTRACK_H_
8
9#include <linux/typecheck.h>
10#include <linux/sched.h>
11#include <linux/kref.h>
12#include <linux/completion.h>
13#include <linux/sched/task.h>
14#include <uapi/rdma/rdma_netlink.h>
15#include <linux/xarray.h>
16
17struct ib_device;
18struct sk_buff;
19
20/**
21 * enum rdma_restrack_type - HW objects to track
22 */
23enum 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,
36 /**
37 * @RDMA_RESTRACK_CM_ID: Connection Manager ID (CM_ID)
38 */
39 RDMA_RESTRACK_CM_ID,
40 /**
41 * @RDMA_RESTRACK_MR: Memory Region (MR)
42 */
43 RDMA_RESTRACK_MR,
44 /**
45 * @RDMA_RESTRACK_CTX: Verbs contexts (CTX)
46 */
47 RDMA_RESTRACK_CTX,
48 /**
49 * @RDMA_RESTRACK_COUNTER: Statistic Counter
50 */
51 RDMA_RESTRACK_COUNTER,
52 /**
53 * @RDMA_RESTRACK_SRQ: Shared receive queue (SRQ)
54 */
55 RDMA_RESTRACK_SRQ,
56 /**
57 * @RDMA_RESTRACK_MAX: Last entry, used for array dclarations
58 */
59 RDMA_RESTRACK_MAX
60};
61
62/**
63 * struct rdma_restrack_entry - metadata per-entry
64 */
65struct 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;
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;
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;
105 /**
106 * @type: various objects in restrack database
107 */
108 enum rdma_restrack_type type;
109 /**
110 * @user: user resource
111 */
112 bool user;
113 /**
114 * @id: ID to expose to users
115 */
116 u32 id;
117};
118
119int rdma_restrack_count(struct ib_device *dev,
120 enum rdma_restrack_type type);
121/**
122 * rdma_is_kernel_res() - check the owner of resource
123 * @res: resource entry
124 */
125static inline bool rdma_is_kernel_res(const struct rdma_restrack_entry *res)
126{
127 return !res->user;
128}
129
130/**
131 * rdma_restrack_get() - grab to protect resource from release
132 * @res: resource entry
133 */
134int __must_check rdma_restrack_get(struct rdma_restrack_entry *res);
135
136/**
137 * rdma_restrack_put() - release resource
138 * @res: resource entry
139 */
140int rdma_restrack_put(struct rdma_restrack_entry *res);
141
142/*
143 * Helper functions for rdma drivers when filling out
144 * nldev driver attributes.
145 */
146int rdma_nl_put_driver_u32(struct sk_buff *msg, const char *name, u32 value);
147int rdma_nl_put_driver_u32_hex(struct sk_buff *msg, const char *name,
148 u32 value);
149int rdma_nl_put_driver_u64(struct sk_buff *msg, const char *name, u64 value);
150int rdma_nl_put_driver_u64_hex(struct sk_buff *msg, const char *name,
151 u64 value);
152int rdma_nl_put_driver_string(struct sk_buff *msg, const char *name,
153 const char *str);
154int rdma_nl_stat_hwcounter_entry(struct sk_buff *msg, const char *name,
155 u64 value);
156
157struct rdma_restrack_entry *rdma_restrack_get_byid(struct ib_device *dev,
158 enum rdma_restrack_type type,
159 u32 id);
160
161/**
162 * rdma_restrack_no_track() - don't add resource to the DB
163 * @res: resource entry
164 *
165 * Every user of this API should be cross examined.
166 * Probably you don't need to use this function.
167 */
168static inline void rdma_restrack_no_track(struct rdma_restrack_entry *res)
169{
170 res->no_track = true;
171}
172static inline bool rdma_restrack_is_tracked(struct rdma_restrack_entry *res)
173{
174 return !res->no_track;
175}
176#endif /* _RDMA_RESTRACK_H_ */
1/* SPDX-License-Identifier: GPL-2.0 OR Linux-OpenIB */
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>
10#include <linux/sched.h>
11#include <linux/kref.h>
12#include <linux/completion.h>
13#include <linux/sched/task.h>
14#include <uapi/rdma/rdma_netlink.h>
15#include <linux/xarray.h>
16
17struct ib_device;
18struct sk_buff;
19
20/**
21 * enum rdma_restrack_type - HW objects to track
22 */
23enum 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,
36 /**
37 * @RDMA_RESTRACK_CM_ID: Connection Manager ID (CM_ID)
38 */
39 RDMA_RESTRACK_CM_ID,
40 /**
41 * @RDMA_RESTRACK_MR: Memory Region (MR)
42 */
43 RDMA_RESTRACK_MR,
44 /**
45 * @RDMA_RESTRACK_CTX: Verbs contexts (CTX)
46 */
47 RDMA_RESTRACK_CTX,
48 /**
49 * @RDMA_RESTRACK_COUNTER: Statistic Counter
50 */
51 RDMA_RESTRACK_COUNTER,
52 /**
53 * @RDMA_RESTRACK_MAX: Last entry, used for array dclarations
54 */
55 RDMA_RESTRACK_MAX
56};
57
58/**
59 * struct rdma_restrack_entry - metadata per-entry
60 */
61struct rdma_restrack_entry {
62 /**
63 * @valid: validity indicator
64 *
65 * The entries are filled during rdma_restrack_add,
66 * can be attempted to be free during rdma_restrack_del.
67 *
68 * As an example for that, see mlx5 QPs with type MLX5_IB_QPT_HW_GSI
69 */
70 bool valid;
71 /*
72 * @kref: Protect destroy of the resource
73 */
74 struct kref kref;
75 /*
76 * @comp: Signal that all consumers of resource are completed their work
77 */
78 struct completion comp;
79 /**
80 * @task: owner of resource tracking entity
81 *
82 * There are two types of entities: created by user and created
83 * by kernel.
84 *
85 * This is relevant for the entities created by users.
86 * For the entities created by kernel, this pointer will be NULL.
87 */
88 struct task_struct *task;
89 /**
90 * @kern_name: name of owner for the kernel created entities.
91 */
92 const char *kern_name;
93 /**
94 * @type: various objects in restrack database
95 */
96 enum rdma_restrack_type type;
97 /**
98 * @user: user resource
99 */
100 bool user;
101 /**
102 * @id: ID to expose to users
103 */
104 u32 id;
105};
106
107int rdma_restrack_count(struct ib_device *dev,
108 enum rdma_restrack_type type);
109
110void rdma_restrack_kadd(struct rdma_restrack_entry *res);
111void rdma_restrack_uadd(struct rdma_restrack_entry *res);
112
113/**
114 * rdma_restrack_del() - delete object from the reource tracking database
115 * @res: resource entry
116 * @type: actual type of object to operate
117 */
118void rdma_restrack_del(struct rdma_restrack_entry *res);
119
120/**
121 * rdma_is_kernel_res() - check the owner of resource
122 * @res: resource entry
123 */
124static inline bool rdma_is_kernel_res(struct rdma_restrack_entry *res)
125{
126 return !res->user;
127}
128
129/**
130 * rdma_restrack_get() - grab to protect resource from release
131 * @res: resource entry
132 */
133int __must_check rdma_restrack_get(struct rdma_restrack_entry *res);
134
135/**
136 * rdma_restrack_put() - release resource
137 * @res: resource entry
138 */
139int rdma_restrack_put(struct rdma_restrack_entry *res);
140
141/**
142 * rdma_restrack_set_task() - set the task for this resource
143 * @res: resource entry
144 * @caller: kernel name, the current task will be used if the caller is NULL.
145 */
146void rdma_restrack_set_task(struct rdma_restrack_entry *res,
147 const char *caller);
148
149/*
150 * Helper functions for rdma drivers when filling out
151 * nldev driver attributes.
152 */
153int rdma_nl_put_driver_u32(struct sk_buff *msg, const char *name, u32 value);
154int rdma_nl_put_driver_u32_hex(struct sk_buff *msg, const char *name,
155 u32 value);
156int rdma_nl_put_driver_u64(struct sk_buff *msg, const char *name, u64 value);
157int rdma_nl_put_driver_u64_hex(struct sk_buff *msg, const char *name,
158 u64 value);
159struct rdma_restrack_entry *rdma_restrack_get_byid(struct ib_device *dev,
160 enum rdma_restrack_type type,
161 u32 id);
162#endif /* _RDMA_RESTRACK_H_ */