1*5113495bSYour Name /*
2*5113495bSYour Name * Copyright (c) 2019 The Linux Foundation. All rights reserved.
3*5113495bSYour Name * Copyright (c) 2021, 2023 Qualcomm Innovation Center, Inc. All rights reserved.
4*5113495bSYour Name *
5*5113495bSYour Name *
6*5113495bSYour Name * Permission to use, copy, modify, and/or distribute this software for
7*5113495bSYour Name * any purpose with or without fee is hereby granted, provided that the
8*5113495bSYour Name * above copyright notice and this permission notice appear in all
9*5113495bSYour Name * copies.
10*5113495bSYour Name *
11*5113495bSYour Name * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
12*5113495bSYour Name * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
13*5113495bSYour Name * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
14*5113495bSYour Name * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
15*5113495bSYour Name * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
16*5113495bSYour Name * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
17*5113495bSYour Name * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
18*5113495bSYour Name * PERFORMANCE OF THIS SOFTWARE.
19*5113495bSYour Name */
20*5113495bSYour Name
21*5113495bSYour Name #ifndef __QDF_TRACKER_H
22*5113495bSYour Name #define __QDF_TRACKER_H
23*5113495bSYour Name
24*5113495bSYour Name #include "qdf_lock.h"
25*5113495bSYour Name #include "qdf_ptr_hash.h"
26*5113495bSYour Name #include "qdf_status.h"
27*5113495bSYour Name #include "qdf_types.h"
28*5113495bSYour Name
29*5113495bSYour Name #define QDF_TRACKER_FUNC_SIZE 48
30*5113495bSYour Name
31*5113495bSYour Name /**
32*5113495bSYour Name * struct qdf_tracker - a generic type for tracking resources
33*5113495bSYour Name * @leak_title: the string title to use when logging leaks
34*5113495bSYour Name * @track_title: the string title to use when logging double tracking issues
35*5113495bSYour Name * @untrack_title: the string title to use when logging double untracking issues
36*5113495bSYour Name * @lock: lock for simultaneous access to @ht
37*5113495bSYour Name * @ht: the hashtable used for storing tracking information
38*5113495bSYour Name */
39*5113495bSYour Name struct qdf_tracker {
40*5113495bSYour Name const char *leak_title;
41*5113495bSYour Name const char *track_title;
42*5113495bSYour Name const char *untrack_title;
43*5113495bSYour Name struct qdf_spinlock lock;
44*5113495bSYour Name struct qdf_ptr_hash *ht;
45*5113495bSYour Name };
46*5113495bSYour Name
47*5113495bSYour Name /**
48*5113495bSYour Name * qdf_tracker_declare() - statically declare a qdf_tacker instance
49*5113495bSYour Name * @name: C identifier to use for the new qdf_tracker
50*5113495bSYour Name * @bits: the number of bits to use for hashing the resource pointers
51*5113495bSYour Name * @_leak_title: the string title to use when logging leaks
52*5113495bSYour Name * @_track_title: the string title to use when logging double tracking issues
53*5113495bSYour Name * @_untrack_title: the string title to use when logging double untracking issues
54*5113495bSYour Name */
55*5113495bSYour Name #define qdf_tracker_declare(name, bits, _leak_title, \
56*5113495bSYour Name _track_title, _untrack_title) \
57*5113495bSYour Name qdf_ptr_hash_declare(name ## _ht, bits); \
58*5113495bSYour Name struct qdf_tracker name = { \
59*5113495bSYour Name .leak_title = _leak_title, \
60*5113495bSYour Name .track_title = _track_title, \
61*5113495bSYour Name .untrack_title = _untrack_title, \
62*5113495bSYour Name .ht = qdf_ptr_hash_ptr(name ## _ht), \
63*5113495bSYour Name }
64*5113495bSYour Name
65*5113495bSYour Name #ifdef CONFIG_LEAK_DETECTION
66*5113495bSYour Name /**
67*5113495bSYour Name * qdf_tracker_init() - initialize a qdf_tracker
68*5113495bSYour Name * @tracker: the qdf_tracker to initialize
69*5113495bSYour Name *
70*5113495bSYour Name * Return: None
71*5113495bSYour Name */
72*5113495bSYour Name void qdf_tracker_init(struct qdf_tracker *tracker);
73*5113495bSYour Name
74*5113495bSYour Name /**
75*5113495bSYour Name * qdf_tracker_deinit() - de-initialize a qdf_tracker
76*5113495bSYour Name * @tracker: the qdf_tracker to de-initialize
77*5113495bSYour Name *
78*5113495bSYour Name * Return: None
79*5113495bSYour Name */
80*5113495bSYour Name void qdf_tracker_deinit(struct qdf_tracker *tracker);
81*5113495bSYour Name
82*5113495bSYour Name /**
83*5113495bSYour Name * qdf_tracker_track() - track a resource with @tracker
84*5113495bSYour Name * @tracker: the qdf_tracker to track with
85*5113495bSYour Name * @ptr: an opaque pointer to the resource to track
86*5113495bSYour Name * @func: name of the caller function operating on @ptr
87*5113495bSYour Name * @line: line number of the call site operating on @ptr
88*5113495bSYour Name *
89*5113495bSYour Name * Return: QDF_STATUS
90*5113495bSYour Name */
91*5113495bSYour Name qdf_must_check QDF_STATUS
92*5113495bSYour Name qdf_tracker_track(struct qdf_tracker *tracker, void *ptr,
93*5113495bSYour Name const char *func, uint32_t line);
94*5113495bSYour Name
95*5113495bSYour Name /**
96*5113495bSYour Name * qdf_tracker_untrack() - untrack a resource with @tracker
97*5113495bSYour Name * @tracker: the qdf_tracker used to track @ptr
98*5113495bSYour Name * @ptr: an opaque pointer to the resource to untrack
99*5113495bSYour Name * @func: name of the caller function operating on @ptr
100*5113495bSYour Name * @line: line number of the call site operating on @ptr
101*5113495bSYour Name *
102*5113495bSYour Name * Return: None
103*5113495bSYour Name */
104*5113495bSYour Name void qdf_tracker_untrack(struct qdf_tracker *tracker, void *ptr,
105*5113495bSYour Name const char *func, uint32_t line);
106*5113495bSYour Name
107*5113495bSYour Name /**
108*5113495bSYour Name * qdf_tracker_check_for_leaks() - assert @tracker has no tracked resources
109*5113495bSYour Name * for the current debug domain
110*5113495bSYour Name * @tracker: the qdf_tracker to check
111*5113495bSYour Name *
112*5113495bSYour Name * Return: None
113*5113495bSYour Name */
114*5113495bSYour Name void qdf_tracker_check_for_leaks(struct qdf_tracker *tracker);
115*5113495bSYour Name
116*5113495bSYour Name /**
117*5113495bSYour Name * qdf_tracker_lookup() - query tracking information for @ptr
118*5113495bSYour Name * @tracker: the qdf_tracker to check
119*5113495bSYour Name * @ptr: the opaque pointer of the resource to lookup
120*5113495bSYour Name * @out_func: function name provided when @ptr was tracked, populated on success
121*5113495bSYour Name * @out_line: line number provided when @ptr was tracked, populated on success
122*5113495bSYour Name *
123*5113495bSYour Name * Note: @out_func is assumed to be sizeof(QDF_TRACKER_FUNC_SIZE).
124*5113495bSYour Name *
125*5113495bSYour Name * Return: true if @tracker is tracking @ptr
126*5113495bSYour Name */
127*5113495bSYour Name qdf_must_check bool
128*5113495bSYour Name qdf_tracker_lookup(struct qdf_tracker *tracker, void *ptr,
129*5113495bSYour Name char (*out_func)[QDF_TRACKER_FUNC_SIZE],
130*5113495bSYour Name uint32_t *out_line);
131*5113495bSYour Name #else
132*5113495bSYour Name static inline
qdf_tracker_init(struct qdf_tracker * tracker)133*5113495bSYour Name void qdf_tracker_init(struct qdf_tracker *tracker)
134*5113495bSYour Name {
135*5113495bSYour Name }
136*5113495bSYour Name
137*5113495bSYour Name static inline
qdf_tracker_deinit(struct qdf_tracker * tracker)138*5113495bSYour Name void qdf_tracker_deinit(struct qdf_tracker *tracker)
139*5113495bSYour Name {
140*5113495bSYour Name }
141*5113495bSYour Name
142*5113495bSYour Name static inline qdf_must_check QDF_STATUS
qdf_tracker_track(struct qdf_tracker * tracker,void * ptr,const char * func,uint32_t line)143*5113495bSYour Name qdf_tracker_track(struct qdf_tracker *tracker, void *ptr,
144*5113495bSYour Name const char *func, uint32_t line)
145*5113495bSYour Name {
146*5113495bSYour Name return QDF_STATUS_SUCCESS;
147*5113495bSYour Name }
148*5113495bSYour Name
149*5113495bSYour Name static inline
qdf_tracker_untrack(struct qdf_tracker * tracker,void * ptr,const char * func,uint32_t line)150*5113495bSYour Name void qdf_tracker_untrack(struct qdf_tracker *tracker, void *ptr,
151*5113495bSYour Name const char *func, uint32_t line)
152*5113495bSYour Name {
153*5113495bSYour Name }
154*5113495bSYour Name
155*5113495bSYour Name static inline
qdf_tracker_check_for_leaks(struct qdf_tracker * tracker)156*5113495bSYour Name void qdf_tracker_check_for_leaks(struct qdf_tracker *tracker)
157*5113495bSYour Name {
158*5113495bSYour Name }
159*5113495bSYour Name
160*5113495bSYour Name static inline qdf_must_check bool
qdf_tracker_lookup(struct qdf_tracker * tracker,void * ptr,char (* out_func)[QDF_TRACKER_FUNC_SIZE],uint32_t * out_line)161*5113495bSYour Name qdf_tracker_lookup(struct qdf_tracker *tracker, void *ptr,
162*5113495bSYour Name char (*out_func)[QDF_TRACKER_FUNC_SIZE],
163*5113495bSYour Name uint32_t *out_line)
164*5113495bSYour Name {
165*5113495bSYour Name return false;
166*5113495bSYour Name }
167*5113495bSYour Name #endif
168*5113495bSYour Name #endif /* __QDF_TRACKER_H */
169*5113495bSYour Name
170