1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
|
/* 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/rwsem.h>
#include <linux/sched.h>
#include <linux/kref.h>
#include <linux/completion.h>
#include <linux/sched/task.h>
#include <uapi/rdma/rdma_netlink.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_MAX: Last entry, used for array dclarations
*/
RDMA_RESTRACK_MAX
};
#define RDMA_RESTRACK_HASH_BITS 8
struct rdma_restrack_entry;
/**
* struct rdma_restrack_root - main resource tracking management
* entity, per-device
*/
struct rdma_restrack_root {
/*
* @rwsem: Read/write lock to protect lists
*/
struct rw_semaphore rwsem;
/**
* @hash: global database for all resources per-device
*/
DECLARE_HASHTABLE(hash, RDMA_RESTRACK_HASH_BITS);
/**
* @fill_res_entry: driver-specific fill function
*
* Allows rdma drivers to add their own restrack attributes.
*/
int (*fill_res_entry)(struct sk_buff *msg,
struct rdma_restrack_entry *entry);
};
/**
* 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;
/**
* @node: hash table entry
*/
struct hlist_node node;
/**
* @type: various objects in restrack database
*/
enum rdma_restrack_type type;
};
/**
* rdma_restrack_init() - initialize resource tracking
* @res: resource tracking root
*/
void rdma_restrack_init(struct rdma_restrack_root *res);
/**
* rdma_restrack_clean() - clean resource tracking
* @res: resource tracking root
*/
void rdma_restrack_clean(struct rdma_restrack_root *res);
/**
* rdma_restrack_count() - the current usage of specific object
* @res: resource entry
* @type: actual type of object to operate
* @ns: PID namespace
*/
int rdma_restrack_count(struct rdma_restrack_root *res,
enum rdma_restrack_type type,
struct pid_namespace *ns);
/**
* rdma_restrack_add() - add object to the reource tracking database
* @res: resource entry
*/
void rdma_restrack_add(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->task;
}
/**
* 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
* @task: task struct
*/
static inline void rdma_restrack_set_task(struct rdma_restrack_entry *res,
struct task_struct *task)
{
if (res->task)
put_task_struct(res->task);
get_task_struct(task);
res->task = task;
}
/*
* 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);
#endif /* _RDMA_RESTRACK_H_ */
|
