1*5113495bSYour Name /*
2*5113495bSYour Name * Copyright (c) 2019, 2021 The Linux Foundation. All rights reserved.
3*5113495bSYour Name * Copyright (c) 2021 Qualcomm Innovation Center, Inc. All rights reserved.
4*5113495bSYour Name *
5*5113495bSYour Name * Permission to use, copy, modify, and/or distribute this software for
6*5113495bSYour Name * any purpose with or without fee is hereby granted, provided that the
7*5113495bSYour Name * above copyright notice and this permission notice appear in all
8*5113495bSYour Name * copies.
9*5113495bSYour Name *
10*5113495bSYour Name * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
11*5113495bSYour Name * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
12*5113495bSYour Name * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
13*5113495bSYour Name * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
14*5113495bSYour Name * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
15*5113495bSYour Name * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
16*5113495bSYour Name * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17*5113495bSYour Name * PERFORMANCE OF THIS SOFTWARE.
18*5113495bSYour Name */
19*5113495bSYour Name
20*5113495bSYour Name #include "qdf_debug_domain.h"
21*5113495bSYour Name #include "qdf_lock.h"
22*5113495bSYour Name #include "qdf_mem.h"
23*5113495bSYour Name #include "qdf_module.h"
24*5113495bSYour Name #include "qdf_ptr_hash.h"
25*5113495bSYour Name #include "qdf_status.h"
26*5113495bSYour Name #include "qdf_str.h"
27*5113495bSYour Name #include "qdf_tracker.h"
28*5113495bSYour Name #include "qdf_types.h"
29*5113495bSYour Name
30*5113495bSYour Name #ifdef CONFIG_LEAK_DETECTION
31*5113495bSYour Name struct qdf_tracker_node {
32*5113495bSYour Name struct qdf_ptr_hash_entry entry;
33*5113495bSYour Name enum qdf_debug_domain domain;
34*5113495bSYour Name char func[QDF_TRACKER_FUNC_SIZE];
35*5113495bSYour Name uint32_t line;
36*5113495bSYour Name };
37*5113495bSYour Name
qdf_tracker_init(struct qdf_tracker * tracker)38*5113495bSYour Name void qdf_tracker_init(struct qdf_tracker *tracker)
39*5113495bSYour Name {
40*5113495bSYour Name qdf_spinlock_create(&tracker->lock);
41*5113495bSYour Name qdf_ptr_hash_init(tracker->ht);
42*5113495bSYour Name }
43*5113495bSYour Name qdf_export_symbol(qdf_tracker_init);
44*5113495bSYour Name
qdf_tracker_deinit(struct qdf_tracker * tracker)45*5113495bSYour Name void qdf_tracker_deinit(struct qdf_tracker *tracker)
46*5113495bSYour Name {
47*5113495bSYour Name qdf_tracker_check_for_leaks(tracker);
48*5113495bSYour Name
49*5113495bSYour Name qdf_spin_lock_bh(&tracker->lock);
50*5113495bSYour Name QDF_BUG(qdf_ptr_hash_empty(tracker->ht));
51*5113495bSYour Name qdf_spin_unlock_bh(&tracker->lock);
52*5113495bSYour Name
53*5113495bSYour Name qdf_ptr_hash_deinit(tracker->ht);
54*5113495bSYour Name qdf_spinlock_destroy(&tracker->lock);
55*5113495bSYour Name }
56*5113495bSYour Name qdf_export_symbol(qdf_tracker_deinit);
57*5113495bSYour Name
qdf_tracker_print_break(void)58*5113495bSYour Name static inline void qdf_tracker_print_break(void)
59*5113495bSYour Name {
60*5113495bSYour Name qdf_nofl_alert("-----------------------------------------------------");
61*5113495bSYour Name }
62*5113495bSYour Name
qdf_tracker_leaks_print(struct qdf_tracker * tracker,enum qdf_debug_domain domain)63*5113495bSYour Name static uint32_t qdf_tracker_leaks_print(struct qdf_tracker *tracker,
64*5113495bSYour Name enum qdf_debug_domain domain)
65*5113495bSYour Name {
66*5113495bSYour Name struct qdf_ptr_hash_bucket *bucket;
67*5113495bSYour Name struct qdf_tracker_node *node;
68*5113495bSYour Name bool print_header = true;
69*5113495bSYour Name uint32_t count = 0;
70*5113495bSYour Name
71*5113495bSYour Name qdf_ptr_hash_for_each(tracker->ht, bucket, node, entry) {
72*5113495bSYour Name if (node->domain != domain)
73*5113495bSYour Name continue;
74*5113495bSYour Name
75*5113495bSYour Name if (print_header) {
76*5113495bSYour Name print_header = false;
77*5113495bSYour Name qdf_nofl_alert("%s detected in %s domain!",
78*5113495bSYour Name tracker->leak_title,
79*5113495bSYour Name qdf_debug_domain_name(domain));
80*5113495bSYour Name qdf_tracker_print_break();
81*5113495bSYour Name }
82*5113495bSYour Name
83*5113495bSYour Name count++;
84*5113495bSYour Name qdf_nofl_alert("0x%lx @ %s:%u", node->entry.key,
85*5113495bSYour Name node->func, node->line);
86*5113495bSYour Name }
87*5113495bSYour Name
88*5113495bSYour Name if (count)
89*5113495bSYour Name qdf_tracker_print_break();
90*5113495bSYour Name
91*5113495bSYour Name return count;
92*5113495bSYour Name }
93*5113495bSYour Name
qdf_tracker_check_for_leaks(struct qdf_tracker * tracker)94*5113495bSYour Name void qdf_tracker_check_for_leaks(struct qdf_tracker *tracker)
95*5113495bSYour Name {
96*5113495bSYour Name enum qdf_debug_domain domain = qdf_debug_domain_get();
97*5113495bSYour Name uint32_t leaks;
98*5113495bSYour Name
99*5113495bSYour Name qdf_spin_lock_bh(&tracker->lock);
100*5113495bSYour Name leaks = qdf_tracker_leaks_print(tracker, domain);
101*5113495bSYour Name if (leaks)
102*5113495bSYour Name QDF_DEBUG_PANIC("%u fatal %s detected in %s domain!",
103*5113495bSYour Name leaks, tracker->leak_title,
104*5113495bSYour Name qdf_debug_domain_name(domain));
105*5113495bSYour Name qdf_spin_unlock_bh(&tracker->lock);
106*5113495bSYour Name }
107*5113495bSYour Name qdf_export_symbol(qdf_tracker_check_for_leaks);
108*5113495bSYour Name
qdf_tracker_track(struct qdf_tracker * tracker,void * ptr,const char * func,uint32_t line)109*5113495bSYour Name QDF_STATUS qdf_tracker_track(struct qdf_tracker *tracker, void *ptr,
110*5113495bSYour Name const char *func, uint32_t line)
111*5113495bSYour Name {
112*5113495bSYour Name struct qdf_tracker_node *node;
113*5113495bSYour Name
114*5113495bSYour Name QDF_BUG(ptr);
115*5113495bSYour Name if (!ptr)
116*5113495bSYour Name return QDF_STATUS_E_INVAL;
117*5113495bSYour Name
118*5113495bSYour Name qdf_spin_lock_bh(&tracker->lock);
119*5113495bSYour Name node = qdf_ptr_hash_get(tracker->ht, ptr, node, entry);
120*5113495bSYour Name if (node)
121*5113495bSYour Name QDF_DEBUG_PANIC("Double %s (via %s:%u); last %s from %s:%u",
122*5113495bSYour Name tracker->track_title, func, line,
123*5113495bSYour Name tracker->track_title, node->func, node->line);
124*5113495bSYour Name qdf_spin_unlock_bh(&tracker->lock);
125*5113495bSYour Name
126*5113495bSYour Name if (node)
127*5113495bSYour Name return QDF_STATUS_E_ALREADY;
128*5113495bSYour Name
129*5113495bSYour Name node = qdf_mem_malloc(sizeof(*node));
130*5113495bSYour Name if (!node)
131*5113495bSYour Name return QDF_STATUS_E_NOMEM;
132*5113495bSYour Name
133*5113495bSYour Name node->domain = qdf_debug_domain_get();
134*5113495bSYour Name qdf_str_lcopy(node->func, func, QDF_TRACKER_FUNC_SIZE);
135*5113495bSYour Name node->line = line;
136*5113495bSYour Name
137*5113495bSYour Name qdf_spin_lock_bh(&tracker->lock);
138*5113495bSYour Name qdf_ptr_hash_add(tracker->ht, ptr, node, entry);
139*5113495bSYour Name qdf_spin_unlock_bh(&tracker->lock);
140*5113495bSYour Name
141*5113495bSYour Name return QDF_STATUS_SUCCESS;
142*5113495bSYour Name }
143*5113495bSYour Name qdf_export_symbol(qdf_tracker_track);
144*5113495bSYour Name
qdf_tracker_untrack(struct qdf_tracker * tracker,void * ptr,const char * func,uint32_t line)145*5113495bSYour Name void qdf_tracker_untrack(struct qdf_tracker *tracker, void *ptr,
146*5113495bSYour Name const char *func, uint32_t line)
147*5113495bSYour Name {
148*5113495bSYour Name enum qdf_debug_domain domain = qdf_debug_domain_get();
149*5113495bSYour Name struct qdf_tracker_node *node;
150*5113495bSYour Name
151*5113495bSYour Name QDF_BUG(ptr);
152*5113495bSYour Name if (!ptr)
153*5113495bSYour Name return;
154*5113495bSYour Name
155*5113495bSYour Name qdf_spin_lock_bh(&tracker->lock);
156*5113495bSYour Name node = qdf_ptr_hash_remove(tracker->ht, ptr, node, entry);
157*5113495bSYour Name if (!node)
158*5113495bSYour Name QDF_DEBUG_PANIC("Double %s (via %s:%u)",
159*5113495bSYour Name tracker->untrack_title, func, line);
160*5113495bSYour Name else if (node->domain != domain)
161*5113495bSYour Name QDF_DEBUG_PANIC("%s domain mismatch; tracked:%s, %s:%u; untracked:%s , %s:%u",
162*5113495bSYour Name tracker->untrack_title,
163*5113495bSYour Name qdf_debug_domain_name(node->domain),
164*5113495bSYour Name node->func, node->line,
165*5113495bSYour Name qdf_debug_domain_name(domain),
166*5113495bSYour Name func, line);
167*5113495bSYour Name qdf_spin_unlock_bh(&tracker->lock);
168*5113495bSYour Name
169*5113495bSYour Name if (node)
170*5113495bSYour Name qdf_mem_free(node);
171*5113495bSYour Name }
172*5113495bSYour Name qdf_export_symbol(qdf_tracker_untrack);
173*5113495bSYour Name
qdf_tracker_lookup(struct qdf_tracker * tracker,void * ptr,char (* out_func)[QDF_TRACKER_FUNC_SIZE],uint32_t * out_line)174*5113495bSYour Name bool qdf_tracker_lookup(struct qdf_tracker *tracker, void *ptr,
175*5113495bSYour Name char (*out_func)[QDF_TRACKER_FUNC_SIZE],
176*5113495bSYour Name uint32_t *out_line)
177*5113495bSYour Name {
178*5113495bSYour Name struct qdf_tracker_node *node;
179*5113495bSYour Name
180*5113495bSYour Name qdf_spin_lock_bh(&tracker->lock);
181*5113495bSYour Name node = qdf_ptr_hash_get(tracker->ht, ptr, node, entry);
182*5113495bSYour Name if (node) {
183*5113495bSYour Name qdf_str_lcopy((char *)out_func, node->func,
184*5113495bSYour Name QDF_TRACKER_FUNC_SIZE);
185*5113495bSYour Name *out_line = node->line;
186*5113495bSYour Name }
187*5113495bSYour Name qdf_spin_unlock_bh(&tracker->lock);
188*5113495bSYour Name
189*5113495bSYour Name return !!node;
190*5113495bSYour Name }
191*5113495bSYour Name #endif
192