1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 OR Linux-OpenIB */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun * Copyright (c) 2017-2018 Mellanox Technologies. All rights reserved.
4*4882a593Smuzhiyun */
5*4882a593Smuzhiyun
6*4882a593Smuzhiyun #ifndef _RDMA_RESTRACK_H_
7*4882a593Smuzhiyun #define _RDMA_RESTRACK_H_
8*4882a593Smuzhiyun
9*4882a593Smuzhiyun #include <linux/typecheck.h>
10*4882a593Smuzhiyun #include <linux/sched.h>
11*4882a593Smuzhiyun #include <linux/kref.h>
12*4882a593Smuzhiyun #include <linux/completion.h>
13*4882a593Smuzhiyun #include <linux/sched/task.h>
14*4882a593Smuzhiyun #include <uapi/rdma/rdma_netlink.h>
15*4882a593Smuzhiyun #include <linux/xarray.h>
16*4882a593Smuzhiyun
17*4882a593Smuzhiyun struct ib_device;
18*4882a593Smuzhiyun struct sk_buff;
19*4882a593Smuzhiyun
20*4882a593Smuzhiyun /**
21*4882a593Smuzhiyun * enum rdma_restrack_type - HW objects to track
22*4882a593Smuzhiyun */
23*4882a593Smuzhiyun enum rdma_restrack_type {
24*4882a593Smuzhiyun /**
25*4882a593Smuzhiyun * @RDMA_RESTRACK_PD: Protection domain (PD)
26*4882a593Smuzhiyun */
27*4882a593Smuzhiyun RDMA_RESTRACK_PD,
28*4882a593Smuzhiyun /**
29*4882a593Smuzhiyun * @RDMA_RESTRACK_CQ: Completion queue (CQ)
30*4882a593Smuzhiyun */
31*4882a593Smuzhiyun RDMA_RESTRACK_CQ,
32*4882a593Smuzhiyun /**
33*4882a593Smuzhiyun * @RDMA_RESTRACK_QP: Queue pair (QP)
34*4882a593Smuzhiyun */
35*4882a593Smuzhiyun RDMA_RESTRACK_QP,
36*4882a593Smuzhiyun /**
37*4882a593Smuzhiyun * @RDMA_RESTRACK_CM_ID: Connection Manager ID (CM_ID)
38*4882a593Smuzhiyun */
39*4882a593Smuzhiyun RDMA_RESTRACK_CM_ID,
40*4882a593Smuzhiyun /**
41*4882a593Smuzhiyun * @RDMA_RESTRACK_MR: Memory Region (MR)
42*4882a593Smuzhiyun */
43*4882a593Smuzhiyun RDMA_RESTRACK_MR,
44*4882a593Smuzhiyun /**
45*4882a593Smuzhiyun * @RDMA_RESTRACK_CTX: Verbs contexts (CTX)
46*4882a593Smuzhiyun */
47*4882a593Smuzhiyun RDMA_RESTRACK_CTX,
48*4882a593Smuzhiyun /**
49*4882a593Smuzhiyun * @RDMA_RESTRACK_COUNTER: Statistic Counter
50*4882a593Smuzhiyun */
51*4882a593Smuzhiyun RDMA_RESTRACK_COUNTER,
52*4882a593Smuzhiyun /**
53*4882a593Smuzhiyun * @RDMA_RESTRACK_MAX: Last entry, used for array dclarations
54*4882a593Smuzhiyun */
55*4882a593Smuzhiyun RDMA_RESTRACK_MAX
56*4882a593Smuzhiyun };
57*4882a593Smuzhiyun
58*4882a593Smuzhiyun /**
59*4882a593Smuzhiyun * struct rdma_restrack_entry - metadata per-entry
60*4882a593Smuzhiyun */
61*4882a593Smuzhiyun struct rdma_restrack_entry {
62*4882a593Smuzhiyun /**
63*4882a593Smuzhiyun * @valid: validity indicator
64*4882a593Smuzhiyun *
65*4882a593Smuzhiyun * The entries are filled during rdma_restrack_add,
66*4882a593Smuzhiyun * can be attempted to be free during rdma_restrack_del.
67*4882a593Smuzhiyun *
68*4882a593Smuzhiyun * As an example for that, see mlx5 QPs with type MLX5_IB_QPT_HW_GSI
69*4882a593Smuzhiyun */
70*4882a593Smuzhiyun bool valid;
71*4882a593Smuzhiyun /*
72*4882a593Smuzhiyun * @kref: Protect destroy of the resource
73*4882a593Smuzhiyun */
74*4882a593Smuzhiyun struct kref kref;
75*4882a593Smuzhiyun /*
76*4882a593Smuzhiyun * @comp: Signal that all consumers of resource are completed their work
77*4882a593Smuzhiyun */
78*4882a593Smuzhiyun struct completion comp;
79*4882a593Smuzhiyun /**
80*4882a593Smuzhiyun * @task: owner of resource tracking entity
81*4882a593Smuzhiyun *
82*4882a593Smuzhiyun * There are two types of entities: created by user and created
83*4882a593Smuzhiyun * by kernel.
84*4882a593Smuzhiyun *
85*4882a593Smuzhiyun * This is relevant for the entities created by users.
86*4882a593Smuzhiyun * For the entities created by kernel, this pointer will be NULL.
87*4882a593Smuzhiyun */
88*4882a593Smuzhiyun struct task_struct *task;
89*4882a593Smuzhiyun /**
90*4882a593Smuzhiyun * @kern_name: name of owner for the kernel created entities.
91*4882a593Smuzhiyun */
92*4882a593Smuzhiyun const char *kern_name;
93*4882a593Smuzhiyun /**
94*4882a593Smuzhiyun * @type: various objects in restrack database
95*4882a593Smuzhiyun */
96*4882a593Smuzhiyun enum rdma_restrack_type type;
97*4882a593Smuzhiyun /**
98*4882a593Smuzhiyun * @user: user resource
99*4882a593Smuzhiyun */
100*4882a593Smuzhiyun bool user;
101*4882a593Smuzhiyun /**
102*4882a593Smuzhiyun * @id: ID to expose to users
103*4882a593Smuzhiyun */
104*4882a593Smuzhiyun u32 id;
105*4882a593Smuzhiyun };
106*4882a593Smuzhiyun
107*4882a593Smuzhiyun int rdma_restrack_count(struct ib_device *dev,
108*4882a593Smuzhiyun enum rdma_restrack_type type);
109*4882a593Smuzhiyun /**
110*4882a593Smuzhiyun * rdma_is_kernel_res() - check the owner of resource
111*4882a593Smuzhiyun * @res: resource entry
112*4882a593Smuzhiyun */
rdma_is_kernel_res(const struct rdma_restrack_entry * res)113*4882a593Smuzhiyun static inline bool rdma_is_kernel_res(const struct rdma_restrack_entry *res)
114*4882a593Smuzhiyun {
115*4882a593Smuzhiyun return !res->user;
116*4882a593Smuzhiyun }
117*4882a593Smuzhiyun
118*4882a593Smuzhiyun /**
119*4882a593Smuzhiyun * rdma_restrack_get() - grab to protect resource from release
120*4882a593Smuzhiyun * @res: resource entry
121*4882a593Smuzhiyun */
122*4882a593Smuzhiyun int __must_check rdma_restrack_get(struct rdma_restrack_entry *res);
123*4882a593Smuzhiyun
124*4882a593Smuzhiyun /**
125*4882a593Smuzhiyun * rdma_restrack_put() - release resource
126*4882a593Smuzhiyun * @res: resource entry
127*4882a593Smuzhiyun */
128*4882a593Smuzhiyun int rdma_restrack_put(struct rdma_restrack_entry *res);
129*4882a593Smuzhiyun
130*4882a593Smuzhiyun /*
131*4882a593Smuzhiyun * Helper functions for rdma drivers when filling out
132*4882a593Smuzhiyun * nldev driver attributes.
133*4882a593Smuzhiyun */
134*4882a593Smuzhiyun int rdma_nl_put_driver_u32(struct sk_buff *msg, const char *name, u32 value);
135*4882a593Smuzhiyun int rdma_nl_put_driver_u32_hex(struct sk_buff *msg, const char *name,
136*4882a593Smuzhiyun u32 value);
137*4882a593Smuzhiyun int rdma_nl_put_driver_u64(struct sk_buff *msg, const char *name, u64 value);
138*4882a593Smuzhiyun int rdma_nl_put_driver_u64_hex(struct sk_buff *msg, const char *name,
139*4882a593Smuzhiyun u64 value);
140*4882a593Smuzhiyun int rdma_nl_put_driver_string(struct sk_buff *msg, const char *name,
141*4882a593Smuzhiyun const char *str);
142*4882a593Smuzhiyun int rdma_nl_stat_hwcounter_entry(struct sk_buff *msg, const char *name,
143*4882a593Smuzhiyun u64 value);
144*4882a593Smuzhiyun
145*4882a593Smuzhiyun struct rdma_restrack_entry *rdma_restrack_get_byid(struct ib_device *dev,
146*4882a593Smuzhiyun enum rdma_restrack_type type,
147*4882a593Smuzhiyun u32 id);
148*4882a593Smuzhiyun #endif /* _RDMA_RESTRACK_H_ */
149