Commit | Line | Data |
---|---|---|
9e4a51ad | 1 | // SPDX-License-Identifier: GPL-2.0 |
3ac7fe5a TG |
2 | /* |
3 | * Generic infrastructure for lifetime debugging of objects. | |
4 | * | |
3ac7fe5a | 5 | * Copyright (C) 2008, Thomas Gleixner <tglx@linutronix.de> |
3ac7fe5a | 6 | */ |
719e4843 FF |
7 | |
8 | #define pr_fmt(fmt) "ODEBUG: " fmt | |
9 | ||
3ac7fe5a TG |
10 | #include <linux/debugobjects.h> |
11 | #include <linux/interrupt.h> | |
d43c36dc | 12 | #include <linux/sched.h> |
68db0cf1 | 13 | #include <linux/sched/task_stack.h> |
3ac7fe5a TG |
14 | #include <linux/seq_file.h> |
15 | #include <linux/debugfs.h> | |
5a0e3ad6 | 16 | #include <linux/slab.h> |
3ac7fe5a | 17 | #include <linux/hash.h> |
caba4cbb | 18 | #include <linux/kmemleak.h> |
88451f2c | 19 | #include <linux/cpu.h> |
3ac7fe5a TG |
20 | |
21 | #define ODEBUG_HASH_BITS 14 | |
22 | #define ODEBUG_HASH_SIZE (1 << ODEBUG_HASH_BITS) | |
23 | ||
0b6ec8c0 | 24 | #define ODEBUG_POOL_SIZE 1024 |
3ac7fe5a | 25 | #define ODEBUG_POOL_MIN_LEVEL 256 |
d86998b1 | 26 | #define ODEBUG_POOL_PERCPU_SIZE 64 |
634d61f4 | 27 | #define ODEBUG_BATCH_SIZE 16 |
3ac7fe5a TG |
28 | |
29 | #define ODEBUG_CHUNK_SHIFT PAGE_SHIFT | |
30 | #define ODEBUG_CHUNK_SIZE (1 << ODEBUG_CHUNK_SHIFT) | |
31 | #define ODEBUG_CHUNK_MASK (~(ODEBUG_CHUNK_SIZE - 1)) | |
32 | ||
a7344a68 WL |
33 | /* |
34 | * We limit the freeing of debug objects via workqueue at a maximum | |
35 | * frequency of 10Hz and about 1024 objects for each freeing operation. | |
36 | * So it is freeing at most 10k debug objects per second. | |
37 | */ | |
38 | #define ODEBUG_FREE_WORK_MAX 1024 | |
39 | #define ODEBUG_FREE_WORK_DELAY DIV_ROUND_UP(HZ, 10) | |
40 | ||
3ac7fe5a TG |
41 | struct debug_bucket { |
42 | struct hlist_head list; | |
aef9cb05 | 43 | raw_spinlock_t lock; |
3ac7fe5a TG |
44 | }; |
45 | ||
d86998b1 WL |
46 | /* |
47 | * Debug object percpu free list | |
48 | * Access is protected by disabling irq | |
49 | */ | |
50 | struct debug_percpu_free { | |
51 | struct hlist_head free_objs; | |
52 | int obj_free; | |
53 | }; | |
54 | ||
55 | static DEFINE_PER_CPU(struct debug_percpu_free, percpu_obj_pool); | |
56 | ||
3ac7fe5a TG |
57 | static struct debug_bucket obj_hash[ODEBUG_HASH_SIZE]; |
58 | ||
1be1cb7b | 59 | static struct debug_obj obj_static_pool[ODEBUG_POOL_SIZE] __initdata; |
3ac7fe5a | 60 | |
aef9cb05 | 61 | static DEFINE_RAW_SPINLOCK(pool_lock); |
3ac7fe5a TG |
62 | |
63 | static HLIST_HEAD(obj_pool); | |
36c4ead6 | 64 | static HLIST_HEAD(obj_to_free); |
3ac7fe5a | 65 | |
d86998b1 WL |
66 | /* |
67 | * Because of the presence of percpu free pools, obj_pool_free will | |
68 | * under-count those in the percpu free pools. Similarly, obj_pool_used | |
69 | * will over-count those in the percpu free pools. Adjustments will be | |
70 | * made at debug_stats_show(). Both obj_pool_min_free and obj_pool_max_used | |
71 | * can be off. | |
72 | */ | |
3ac7fe5a TG |
73 | static int obj_pool_min_free = ODEBUG_POOL_SIZE; |
74 | static int obj_pool_free = ODEBUG_POOL_SIZE; | |
75 | static int obj_pool_used; | |
76 | static int obj_pool_max_used; | |
a7344a68 | 77 | static bool obj_freeing; |
36c4ead6 YS |
78 | /* The number of objs on the global free list */ |
79 | static int obj_nr_tofree; | |
3ac7fe5a TG |
80 | |
81 | static int debug_objects_maxchain __read_mostly; | |
163cf842 | 82 | static int __maybe_unused debug_objects_maxchecked __read_mostly; |
3ac7fe5a TG |
83 | static int debug_objects_fixups __read_mostly; |
84 | static int debug_objects_warnings __read_mostly; | |
3ae70205 IM |
85 | static int debug_objects_enabled __read_mostly |
86 | = CONFIG_DEBUG_OBJECTS_ENABLE_DEFAULT; | |
97dd552e WL |
87 | static int debug_objects_pool_size __read_mostly |
88 | = ODEBUG_POOL_SIZE; | |
89 | static int debug_objects_pool_min_level __read_mostly | |
90 | = ODEBUG_POOL_MIN_LEVEL; | |
aedcade6 | 91 | static const struct debug_obj_descr *descr_test __read_mostly; |
d86998b1 | 92 | static struct kmem_cache *obj_cache __read_mostly; |
3ac7fe5a | 93 | |
c4b73aab | 94 | /* |
0cad93c3 | 95 | * Track numbers of kmem_cache_alloc()/free() calls done. |
c4b73aab | 96 | */ |
0cad93c3 | 97 | static int debug_objects_allocated; |
c4b73aab WL |
98 | static int debug_objects_freed; |
99 | ||
337fff8b | 100 | static void free_obj_work(struct work_struct *work); |
a7344a68 | 101 | static DECLARE_DELAYED_WORK(debug_obj_work, free_obj_work); |
337fff8b | 102 | |
3ac7fe5a TG |
103 | static int __init enable_object_debug(char *str) |
104 | { | |
105 | debug_objects_enabled = 1; | |
106 | return 0; | |
107 | } | |
3e8ebb5c KM |
108 | |
109 | static int __init disable_object_debug(char *str) | |
110 | { | |
111 | debug_objects_enabled = 0; | |
112 | return 0; | |
113 | } | |
114 | ||
3ac7fe5a | 115 | early_param("debug_objects", enable_object_debug); |
3e8ebb5c | 116 | early_param("no_debug_objects", disable_object_debug); |
3ac7fe5a TG |
117 | |
118 | static const char *obj_states[ODEBUG_STATE_MAX] = { | |
119 | [ODEBUG_STATE_NONE] = "none", | |
120 | [ODEBUG_STATE_INIT] = "initialized", | |
121 | [ODEBUG_STATE_INACTIVE] = "inactive", | |
122 | [ODEBUG_STATE_ACTIVE] = "active", | |
123 | [ODEBUG_STATE_DESTROYED] = "destroyed", | |
124 | [ODEBUG_STATE_NOTAVAILABLE] = "not available", | |
125 | }; | |
126 | ||
1fda107d | 127 | static void fill_pool(void) |
3ac7fe5a TG |
128 | { |
129 | gfp_t gfp = GFP_ATOMIC | __GFP_NORETRY | __GFP_NOWARN; | |
d26bf505 | 130 | struct debug_obj *obj; |
50db04dd | 131 | unsigned long flags; |
3ac7fe5a | 132 | |
35fd7a63 | 133 | if (likely(READ_ONCE(obj_pool_free) >= debug_objects_pool_min_level)) |
1fda107d | 134 | return; |
3ac7fe5a | 135 | |
36c4ead6 YS |
136 | /* |
137 | * Reuse objs from the global free list; they will be reinitialized | |
138 | * when allocating. | |
35fd7a63 ME |
139 | * |
140 | * Both obj_nr_tofree and obj_pool_free are checked locklessly; the | |
141 | * READ_ONCE()s pair with the WRITE_ONCE()s in pool_lock critical | |
142 | * sections. | |
36c4ead6 | 143 | */ |
35fd7a63 | 144 | while (READ_ONCE(obj_nr_tofree) && (READ_ONCE(obj_pool_free) < obj_pool_min_free)) { |
36c4ead6 YS |
145 | raw_spin_lock_irqsave(&pool_lock, flags); |
146 | /* | |
147 | * Recheck with the lock held as the worker thread might have | |
148 | * won the race and freed the global free list already. | |
149 | */ | |
d26bf505 | 150 | while (obj_nr_tofree && (obj_pool_free < obj_pool_min_free)) { |
36c4ead6 YS |
151 | obj = hlist_entry(obj_to_free.first, typeof(*obj), node); |
152 | hlist_del(&obj->node); | |
35fd7a63 | 153 | WRITE_ONCE(obj_nr_tofree, obj_nr_tofree - 1); |
36c4ead6 | 154 | hlist_add_head(&obj->node, &obj_pool); |
35fd7a63 | 155 | WRITE_ONCE(obj_pool_free, obj_pool_free + 1); |
36c4ead6 YS |
156 | } |
157 | raw_spin_unlock_irqrestore(&pool_lock, flags); | |
158 | } | |
159 | ||
3ac7fe5a | 160 | if (unlikely(!obj_cache)) |
1fda107d | 161 | return; |
3ac7fe5a | 162 | |
35fd7a63 | 163 | while (READ_ONCE(obj_pool_free) < debug_objects_pool_min_level) { |
d26bf505 WL |
164 | struct debug_obj *new[ODEBUG_BATCH_SIZE]; |
165 | int cnt; | |
3ac7fe5a | 166 | |
d26bf505 WL |
167 | for (cnt = 0; cnt < ODEBUG_BATCH_SIZE; cnt++) { |
168 | new[cnt] = kmem_cache_zalloc(obj_cache, gfp); | |
169 | if (!new[cnt]) | |
170 | break; | |
171 | } | |
172 | if (!cnt) | |
3340808c | 173 | return; |
3ac7fe5a | 174 | |
aef9cb05 | 175 | raw_spin_lock_irqsave(&pool_lock, flags); |
d26bf505 WL |
176 | while (cnt) { |
177 | hlist_add_head(&new[--cnt]->node, &obj_pool); | |
178 | debug_objects_allocated++; | |
35fd7a63 | 179 | WRITE_ONCE(obj_pool_free, obj_pool_free + 1); |
d26bf505 | 180 | } |
aef9cb05 | 181 | raw_spin_unlock_irqrestore(&pool_lock, flags); |
3ac7fe5a | 182 | } |
3ac7fe5a TG |
183 | } |
184 | ||
185 | /* | |
186 | * Lookup an object in the hash bucket. | |
187 | */ | |
188 | static struct debug_obj *lookup_object(void *addr, struct debug_bucket *b) | |
189 | { | |
3ac7fe5a TG |
190 | struct debug_obj *obj; |
191 | int cnt = 0; | |
192 | ||
b67bfe0d | 193 | hlist_for_each_entry(obj, &b->list, node) { |
3ac7fe5a TG |
194 | cnt++; |
195 | if (obj->object == addr) | |
196 | return obj; | |
197 | } | |
198 | if (cnt > debug_objects_maxchain) | |
199 | debug_objects_maxchain = cnt; | |
200 | ||
201 | return NULL; | |
202 | } | |
203 | ||
d86998b1 WL |
204 | /* |
205 | * Allocate a new object from the hlist | |
206 | */ | |
207 | static struct debug_obj *__alloc_object(struct hlist_head *list) | |
208 | { | |
209 | struct debug_obj *obj = NULL; | |
210 | ||
211 | if (list->first) { | |
212 | obj = hlist_entry(list->first, typeof(*obj), node); | |
213 | hlist_del(&obj->node); | |
214 | } | |
215 | ||
216 | return obj; | |
217 | } | |
218 | ||
3ac7fe5a | 219 | static struct debug_obj * |
aedcade6 | 220 | alloc_object(void *addr, struct debug_bucket *b, const struct debug_obj_descr *descr) |
3ac7fe5a | 221 | { |
634d61f4 | 222 | struct debug_percpu_free *percpu_pool = this_cpu_ptr(&percpu_obj_pool); |
d86998b1 | 223 | struct debug_obj *obj; |
3ac7fe5a | 224 | |
d86998b1 | 225 | if (likely(obj_cache)) { |
d86998b1 WL |
226 | obj = __alloc_object(&percpu_pool->free_objs); |
227 | if (obj) { | |
228 | percpu_pool->obj_free--; | |
229 | goto init_obj; | |
230 | } | |
231 | } | |
3ac7fe5a | 232 | |
d86998b1 WL |
233 | raw_spin_lock(&pool_lock); |
234 | obj = __alloc_object(&obj_pool); | |
235 | if (obj) { | |
3ac7fe5a | 236 | obj_pool_used++; |
35fd7a63 | 237 | WRITE_ONCE(obj_pool_free, obj_pool_free - 1); |
634d61f4 WL |
238 | |
239 | /* | |
240 | * Looking ahead, allocate one batch of debug objects and | |
241 | * put them into the percpu free pool. | |
242 | */ | |
243 | if (likely(obj_cache)) { | |
244 | int i; | |
245 | ||
246 | for (i = 0; i < ODEBUG_BATCH_SIZE; i++) { | |
247 | struct debug_obj *obj2; | |
248 | ||
249 | obj2 = __alloc_object(&obj_pool); | |
250 | if (!obj2) | |
251 | break; | |
252 | hlist_add_head(&obj2->node, | |
253 | &percpu_pool->free_objs); | |
254 | percpu_pool->obj_free++; | |
255 | obj_pool_used++; | |
35fd7a63 | 256 | WRITE_ONCE(obj_pool_free, obj_pool_free - 1); |
634d61f4 WL |
257 | } |
258 | } | |
259 | ||
3ac7fe5a TG |
260 | if (obj_pool_used > obj_pool_max_used) |
261 | obj_pool_max_used = obj_pool_used; | |
262 | ||
3ac7fe5a TG |
263 | if (obj_pool_free < obj_pool_min_free) |
264 | obj_pool_min_free = obj_pool_free; | |
265 | } | |
aef9cb05 | 266 | raw_spin_unlock(&pool_lock); |
3ac7fe5a | 267 | |
d86998b1 WL |
268 | init_obj: |
269 | if (obj) { | |
270 | obj->object = addr; | |
271 | obj->descr = descr; | |
272 | obj->state = ODEBUG_STATE_NONE; | |
273 | obj->astate = 0; | |
274 | hlist_add_head(&obj->node, &b->list); | |
275 | } | |
3ac7fe5a TG |
276 | return obj; |
277 | } | |
278 | ||
279 | /* | |
337fff8b | 280 | * workqueue function to free objects. |
858274b6 WL |
281 | * |
282 | * To reduce contention on the global pool_lock, the actual freeing of | |
636e1970 | 283 | * debug objects will be delayed if the pool_lock is busy. |
3ac7fe5a | 284 | */ |
337fff8b | 285 | static void free_obj_work(struct work_struct *work) |
3ac7fe5a | 286 | { |
36c4ead6 YS |
287 | struct hlist_node *tmp; |
288 | struct debug_obj *obj; | |
673d62cc | 289 | unsigned long flags; |
36c4ead6 | 290 | HLIST_HEAD(tofree); |
3ac7fe5a | 291 | |
a7344a68 | 292 | WRITE_ONCE(obj_freeing, false); |
858274b6 WL |
293 | if (!raw_spin_trylock_irqsave(&pool_lock, flags)) |
294 | return; | |
36c4ead6 | 295 | |
a7344a68 WL |
296 | if (obj_pool_free >= debug_objects_pool_size) |
297 | goto free_objs; | |
298 | ||
36c4ead6 YS |
299 | /* |
300 | * The objs on the pool list might be allocated before the work is | |
301 | * run, so recheck if pool list it full or not, if not fill pool | |
a7344a68 WL |
302 | * list from the global free list. As it is likely that a workload |
303 | * may be gearing up to use more and more objects, don't free any | |
304 | * of them until the next round. | |
36c4ead6 YS |
305 | */ |
306 | while (obj_nr_tofree && obj_pool_free < debug_objects_pool_size) { | |
307 | obj = hlist_entry(obj_to_free.first, typeof(*obj), node); | |
308 | hlist_del(&obj->node); | |
309 | hlist_add_head(&obj->node, &obj_pool); | |
35fd7a63 ME |
310 | WRITE_ONCE(obj_pool_free, obj_pool_free + 1); |
311 | WRITE_ONCE(obj_nr_tofree, obj_nr_tofree - 1); | |
36c4ead6 | 312 | } |
a7344a68 WL |
313 | raw_spin_unlock_irqrestore(&pool_lock, flags); |
314 | return; | |
36c4ead6 | 315 | |
a7344a68 | 316 | free_objs: |
36c4ead6 YS |
317 | /* |
318 | * Pool list is already full and there are still objs on the free | |
319 | * list. Move remaining free objs to a temporary list to free the | |
320 | * memory outside the pool_lock held region. | |
321 | */ | |
322 | if (obj_nr_tofree) { | |
323 | hlist_move_list(&obj_to_free, &tofree); | |
04148187 | 324 | debug_objects_freed += obj_nr_tofree; |
35fd7a63 | 325 | WRITE_ONCE(obj_nr_tofree, 0); |
36c4ead6 | 326 | } |
aef9cb05 | 327 | raw_spin_unlock_irqrestore(&pool_lock, flags); |
36c4ead6 YS |
328 | |
329 | hlist_for_each_entry_safe(obj, tmp, &tofree, node) { | |
330 | hlist_del(&obj->node); | |
331 | kmem_cache_free(obj_cache, obj); | |
332 | } | |
337fff8b TG |
333 | } |
334 | ||
a7344a68 | 335 | static void __free_object(struct debug_obj *obj) |
337fff8b | 336 | { |
634d61f4 WL |
337 | struct debug_obj *objs[ODEBUG_BATCH_SIZE]; |
338 | struct debug_percpu_free *percpu_pool; | |
339 | int lookahead_count = 0; | |
337fff8b | 340 | unsigned long flags; |
636e1970 | 341 | bool work; |
337fff8b | 342 | |
d86998b1 | 343 | local_irq_save(flags); |
634d61f4 WL |
344 | if (!obj_cache) |
345 | goto free_to_obj_pool; | |
346 | ||
d86998b1 WL |
347 | /* |
348 | * Try to free it into the percpu pool first. | |
349 | */ | |
350 | percpu_pool = this_cpu_ptr(&percpu_obj_pool); | |
634d61f4 | 351 | if (percpu_pool->obj_free < ODEBUG_POOL_PERCPU_SIZE) { |
d86998b1 WL |
352 | hlist_add_head(&obj->node, &percpu_pool->free_objs); |
353 | percpu_pool->obj_free++; | |
354 | local_irq_restore(flags); | |
a7344a68 | 355 | return; |
d86998b1 WL |
356 | } |
357 | ||
634d61f4 WL |
358 | /* |
359 | * As the percpu pool is full, look ahead and pull out a batch | |
360 | * of objects from the percpu pool and free them as well. | |
361 | */ | |
362 | for (; lookahead_count < ODEBUG_BATCH_SIZE; lookahead_count++) { | |
363 | objs[lookahead_count] = __alloc_object(&percpu_pool->free_objs); | |
364 | if (!objs[lookahead_count]) | |
365 | break; | |
366 | percpu_pool->obj_free--; | |
367 | } | |
368 | ||
369 | free_to_obj_pool: | |
d86998b1 | 370 | raw_spin_lock(&pool_lock); |
a7344a68 WL |
371 | work = (obj_pool_free > debug_objects_pool_size) && obj_cache && |
372 | (obj_nr_tofree < ODEBUG_FREE_WORK_MAX); | |
337fff8b | 373 | obj_pool_used--; |
636e1970 YS |
374 | |
375 | if (work) { | |
35fd7a63 | 376 | WRITE_ONCE(obj_nr_tofree, obj_nr_tofree + 1); |
636e1970 | 377 | hlist_add_head(&obj->node, &obj_to_free); |
634d61f4 | 378 | if (lookahead_count) { |
35fd7a63 | 379 | WRITE_ONCE(obj_nr_tofree, obj_nr_tofree + lookahead_count); |
634d61f4 WL |
380 | obj_pool_used -= lookahead_count; |
381 | while (lookahead_count) { | |
382 | hlist_add_head(&objs[--lookahead_count]->node, | |
383 | &obj_to_free); | |
384 | } | |
385 | } | |
a7344a68 WL |
386 | |
387 | if ((obj_pool_free > debug_objects_pool_size) && | |
388 | (obj_nr_tofree < ODEBUG_FREE_WORK_MAX)) { | |
389 | int i; | |
390 | ||
391 | /* | |
392 | * Free one more batch of objects from obj_pool. | |
393 | */ | |
394 | for (i = 0; i < ODEBUG_BATCH_SIZE; i++) { | |
395 | obj = __alloc_object(&obj_pool); | |
396 | hlist_add_head(&obj->node, &obj_to_free); | |
35fd7a63 ME |
397 | WRITE_ONCE(obj_pool_free, obj_pool_free - 1); |
398 | WRITE_ONCE(obj_nr_tofree, obj_nr_tofree + 1); | |
a7344a68 WL |
399 | } |
400 | } | |
636e1970 | 401 | } else { |
35fd7a63 | 402 | WRITE_ONCE(obj_pool_free, obj_pool_free + 1); |
636e1970 | 403 | hlist_add_head(&obj->node, &obj_pool); |
634d61f4 | 404 | if (lookahead_count) { |
35fd7a63 | 405 | WRITE_ONCE(obj_pool_free, obj_pool_free + lookahead_count); |
634d61f4 WL |
406 | obj_pool_used -= lookahead_count; |
407 | while (lookahead_count) { | |
408 | hlist_add_head(&objs[--lookahead_count]->node, | |
409 | &obj_pool); | |
410 | } | |
411 | } | |
636e1970 | 412 | } |
d86998b1 WL |
413 | raw_spin_unlock(&pool_lock); |
414 | local_irq_restore(flags); | |
636e1970 YS |
415 | } |
416 | ||
417 | /* | |
418 | * Put the object back into the pool and schedule work to free objects | |
419 | * if necessary. | |
420 | */ | |
421 | static void free_object(struct debug_obj *obj) | |
422 | { | |
a7344a68 | 423 | __free_object(obj); |
35fd7a63 | 424 | if (!READ_ONCE(obj_freeing) && READ_ONCE(obj_nr_tofree)) { |
a7344a68 WL |
425 | WRITE_ONCE(obj_freeing, true); |
426 | schedule_delayed_work(&debug_obj_work, ODEBUG_FREE_WORK_DELAY); | |
427 | } | |
3ac7fe5a TG |
428 | } |
429 | ||
88451f2c Z |
430 | #ifdef CONFIG_HOTPLUG_CPU |
431 | static int object_cpu_offline(unsigned int cpu) | |
432 | { | |
433 | struct debug_percpu_free *percpu_pool; | |
434 | struct hlist_node *tmp; | |
435 | struct debug_obj *obj; | |
eabb7f1a | 436 | unsigned long flags; |
88451f2c Z |
437 | |
438 | /* Remote access is safe as the CPU is dead already */ | |
439 | percpu_pool = per_cpu_ptr(&percpu_obj_pool, cpu); | |
440 | hlist_for_each_entry_safe(obj, tmp, &percpu_pool->free_objs, node) { | |
441 | hlist_del(&obj->node); | |
442 | kmem_cache_free(obj_cache, obj); | |
443 | } | |
eabb7f1a | 444 | |
445 | raw_spin_lock_irqsave(&pool_lock, flags); | |
446 | obj_pool_used -= percpu_pool->obj_free; | |
447 | debug_objects_freed += percpu_pool->obj_free; | |
448 | raw_spin_unlock_irqrestore(&pool_lock, flags); | |
449 | ||
88451f2c Z |
450 | percpu_pool->obj_free = 0; |
451 | ||
452 | return 0; | |
453 | } | |
454 | #endif | |
455 | ||
3ac7fe5a TG |
456 | /* |
457 | * We run out of memory. That means we probably have tons of objects | |
458 | * allocated. | |
459 | */ | |
460 | static void debug_objects_oom(void) | |
461 | { | |
462 | struct debug_bucket *db = obj_hash; | |
b67bfe0d | 463 | struct hlist_node *tmp; |
673d62cc | 464 | HLIST_HEAD(freelist); |
3ac7fe5a TG |
465 | struct debug_obj *obj; |
466 | unsigned long flags; | |
467 | int i; | |
468 | ||
719e4843 | 469 | pr_warn("Out of memory. ODEBUG disabled\n"); |
3ac7fe5a TG |
470 | |
471 | for (i = 0; i < ODEBUG_HASH_SIZE; i++, db++) { | |
aef9cb05 | 472 | raw_spin_lock_irqsave(&db->lock, flags); |
673d62cc | 473 | hlist_move_list(&db->list, &freelist); |
aef9cb05 | 474 | raw_spin_unlock_irqrestore(&db->lock, flags); |
673d62cc VN |
475 | |
476 | /* Now free them */ | |
b67bfe0d | 477 | hlist_for_each_entry_safe(obj, tmp, &freelist, node) { |
3ac7fe5a TG |
478 | hlist_del(&obj->node); |
479 | free_object(obj); | |
480 | } | |
3ac7fe5a TG |
481 | } |
482 | } | |
483 | ||
484 | /* | |
485 | * We use the pfn of the address for the hash. That way we can check | |
486 | * for freed objects simply by checking the affected bucket. | |
487 | */ | |
488 | static struct debug_bucket *get_bucket(unsigned long addr) | |
489 | { | |
490 | unsigned long hash; | |
491 | ||
492 | hash = hash_long((addr >> ODEBUG_CHUNK_SHIFT), ODEBUG_HASH_BITS); | |
493 | return &obj_hash[hash]; | |
494 | } | |
495 | ||
496 | static void debug_print_object(struct debug_obj *obj, char *msg) | |
497 | { | |
aedcade6 | 498 | const struct debug_obj_descr *descr = obj->descr; |
3ac7fe5a TG |
499 | static int limit; |
500 | ||
99777288 SG |
501 | if (limit < 5 && descr != descr_test) { |
502 | void *hint = descr->debug_hint ? | |
503 | descr->debug_hint(obj->object) : NULL; | |
3ac7fe5a | 504 | limit++; |
a5d8e467 | 505 | WARN(1, KERN_ERR "ODEBUG: %s %s (active state %u) " |
c4db2d3b | 506 | "object: %p object type: %s hint: %pS\n", |
a5d8e467 | 507 | msg, obj_states[obj->state], obj->astate, |
c4db2d3b | 508 | obj->object, descr->name, hint); |
3ac7fe5a TG |
509 | } |
510 | debug_objects_warnings++; | |
511 | } | |
512 | ||
513 | /* | |
514 | * Try to repair the damage, so we have a better chance to get useful | |
515 | * debug output. | |
516 | */ | |
b1e4d9d8 DC |
517 | static bool |
518 | debug_object_fixup(bool (*fixup)(void *addr, enum debug_obj_state state), | |
3ac7fe5a TG |
519 | void * addr, enum debug_obj_state state) |
520 | { | |
b1e4d9d8 DC |
521 | if (fixup && fixup(addr, state)) { |
522 | debug_objects_fixups++; | |
523 | return true; | |
524 | } | |
525 | return false; | |
3ac7fe5a TG |
526 | } |
527 | ||
528 | static void debug_object_is_on_stack(void *addr, int onstack) | |
529 | { | |
3ac7fe5a TG |
530 | int is_on_stack; |
531 | static int limit; | |
532 | ||
533 | if (limit > 4) | |
534 | return; | |
535 | ||
8b05c7e6 | 536 | is_on_stack = object_is_on_stack(addr); |
3ac7fe5a TG |
537 | if (is_on_stack == onstack) |
538 | return; | |
539 | ||
540 | limit++; | |
541 | if (is_on_stack) | |
fc91a3c4 JFG |
542 | pr_warn("object %p is on stack %p, but NOT annotated.\n", addr, |
543 | task_stack_page(current)); | |
3ac7fe5a | 544 | else |
fc91a3c4 JFG |
545 | pr_warn("object %p is NOT on stack %p, but annotated.\n", addr, |
546 | task_stack_page(current)); | |
547 | ||
3ac7fe5a TG |
548 | WARN_ON(1); |
549 | } | |
550 | ||
63a75969 TG |
551 | static struct debug_obj *lookup_object_or_alloc(void *addr, struct debug_bucket *b, |
552 | const struct debug_obj_descr *descr, | |
553 | bool onstack, bool alloc_ifstatic) | |
554 | { | |
555 | struct debug_obj *obj = lookup_object(addr, b); | |
556 | enum debug_obj_state state = ODEBUG_STATE_NONE; | |
557 | ||
558 | if (likely(obj)) | |
559 | return obj; | |
560 | ||
561 | /* | |
562 | * debug_object_init() unconditionally allocates untracked | |
563 | * objects. It does not matter whether it is a static object or | |
564 | * not. | |
565 | * | |
566 | * debug_object_assert_init() and debug_object_activate() allow | |
567 | * allocation only if the descriptor callback confirms that the | |
568 | * object is static and considered initialized. For non-static | |
569 | * objects the allocation needs to be done from the fixup callback. | |
570 | */ | |
571 | if (unlikely(alloc_ifstatic)) { | |
572 | if (!descr->is_static_object || !descr->is_static_object(addr)) | |
573 | return ERR_PTR(-ENOENT); | |
574 | /* Statically allocated objects are considered initialized */ | |
575 | state = ODEBUG_STATE_INIT; | |
576 | } | |
577 | ||
578 | obj = alloc_object(addr, b, descr); | |
579 | if (likely(obj)) { | |
580 | obj->state = state; | |
581 | debug_object_is_on_stack(addr, onstack); | |
582 | return obj; | |
583 | } | |
584 | ||
585 | /* Out of memory. Do the cleanup outside of the locked region */ | |
586 | debug_objects_enabled = 0; | |
587 | return NULL; | |
588 | } | |
589 | ||
0af462f1 TG |
590 | static void debug_objects_fill_pool(void) |
591 | { | |
592 | /* | |
593 | * On RT enabled kernels the pool refill must happen in preemptible | |
0cce06ba PZ |
594 | * context -- for !RT kernels we rely on the fact that spinlock_t and |
595 | * raw_spinlock_t are basically the same type and this lock-type | |
596 | * inversion works just fine. | |
0af462f1 | 597 | */ |
0cce06ba PZ |
598 | if (!IS_ENABLED(CONFIG_PREEMPT_RT) || preemptible()) { |
599 | /* | |
600 | * Annotate away the spinlock_t inside raw_spinlock_t warning | |
601 | * by temporarily raising the wait-type to WAIT_SLEEP, matching | |
602 | * the preemptible() condition above. | |
603 | */ | |
604 | static DEFINE_WAIT_OVERRIDE_MAP(fill_pool_map, LD_WAIT_SLEEP); | |
605 | lock_map_acquire_try(&fill_pool_map); | |
0af462f1 | 606 | fill_pool(); |
0cce06ba PZ |
607 | lock_map_release(&fill_pool_map); |
608 | } | |
0af462f1 TG |
609 | } |
610 | ||
3ac7fe5a | 611 | static void |
aedcade6 | 612 | __debug_object_init(void *addr, const struct debug_obj_descr *descr, int onstack) |
3ac7fe5a TG |
613 | { |
614 | enum debug_obj_state state; | |
615 | struct debug_bucket *db; | |
616 | struct debug_obj *obj; | |
617 | unsigned long flags; | |
618 | ||
0af462f1 | 619 | debug_objects_fill_pool(); |
50db04dd | 620 | |
3ac7fe5a TG |
621 | db = get_bucket((unsigned long) addr); |
622 | ||
aef9cb05 | 623 | raw_spin_lock_irqsave(&db->lock, flags); |
3ac7fe5a | 624 | |
63a75969 TG |
625 | obj = lookup_object_or_alloc(addr, db, descr, onstack, false); |
626 | if (unlikely(!obj)) { | |
627 | raw_spin_unlock_irqrestore(&db->lock, flags); | |
628 | debug_objects_oom(); | |
629 | return; | |
3ac7fe5a TG |
630 | } |
631 | ||
632 | switch (obj->state) { | |
633 | case ODEBUG_STATE_NONE: | |
634 | case ODEBUG_STATE_INIT: | |
635 | case ODEBUG_STATE_INACTIVE: | |
636 | obj->state = ODEBUG_STATE_INIT; | |
637 | break; | |
638 | ||
639 | case ODEBUG_STATE_ACTIVE: | |
3ac7fe5a | 640 | state = obj->state; |
aef9cb05 | 641 | raw_spin_unlock_irqrestore(&db->lock, flags); |
d5f34153 | 642 | debug_print_object(obj, "init"); |
3ac7fe5a TG |
643 | debug_object_fixup(descr->fixup_init, addr, state); |
644 | return; | |
645 | ||
646 | case ODEBUG_STATE_DESTROYED: | |
d5f34153 | 647 | raw_spin_unlock_irqrestore(&db->lock, flags); |
3ac7fe5a | 648 | debug_print_object(obj, "init"); |
d5f34153 | 649 | return; |
3ac7fe5a TG |
650 | default: |
651 | break; | |
652 | } | |
653 | ||
aef9cb05 | 654 | raw_spin_unlock_irqrestore(&db->lock, flags); |
3ac7fe5a TG |
655 | } |
656 | ||
657 | /** | |
658 | * debug_object_init - debug checks when an object is initialized | |
659 | * @addr: address of the object | |
660 | * @descr: pointer to an object specific debug description structure | |
661 | */ | |
aedcade6 | 662 | void debug_object_init(void *addr, const struct debug_obj_descr *descr) |
3ac7fe5a TG |
663 | { |
664 | if (!debug_objects_enabled) | |
665 | return; | |
666 | ||
667 | __debug_object_init(addr, descr, 0); | |
668 | } | |
f8ff04e2 | 669 | EXPORT_SYMBOL_GPL(debug_object_init); |
3ac7fe5a TG |
670 | |
671 | /** | |
672 | * debug_object_init_on_stack - debug checks when an object on stack is | |
673 | * initialized | |
674 | * @addr: address of the object | |
675 | * @descr: pointer to an object specific debug description structure | |
676 | */ | |
aedcade6 | 677 | void debug_object_init_on_stack(void *addr, const struct debug_obj_descr *descr) |
3ac7fe5a TG |
678 | { |
679 | if (!debug_objects_enabled) | |
680 | return; | |
681 | ||
682 | __debug_object_init(addr, descr, 1); | |
683 | } | |
f8ff04e2 | 684 | EXPORT_SYMBOL_GPL(debug_object_init_on_stack); |
3ac7fe5a TG |
685 | |
686 | /** | |
687 | * debug_object_activate - debug checks when an object is activated | |
688 | * @addr: address of the object | |
689 | * @descr: pointer to an object specific debug description structure | |
b778ae25 | 690 | * Returns 0 for success, -EINVAL for check failed. |
3ac7fe5a | 691 | */ |
aedcade6 | 692 | int debug_object_activate(void *addr, const struct debug_obj_descr *descr) |
3ac7fe5a | 693 | { |
63a75969 | 694 | struct debug_obj o = { .object = addr, .state = ODEBUG_STATE_NOTAVAILABLE, .descr = descr }; |
3ac7fe5a TG |
695 | enum debug_obj_state state; |
696 | struct debug_bucket *db; | |
697 | struct debug_obj *obj; | |
698 | unsigned long flags; | |
b778ae25 | 699 | int ret; |
3ac7fe5a TG |
700 | |
701 | if (!debug_objects_enabled) | |
b778ae25 | 702 | return 0; |
3ac7fe5a | 703 | |
0af462f1 TG |
704 | debug_objects_fill_pool(); |
705 | ||
3ac7fe5a TG |
706 | db = get_bucket((unsigned long) addr); |
707 | ||
aef9cb05 | 708 | raw_spin_lock_irqsave(&db->lock, flags); |
3ac7fe5a | 709 | |
63a75969 TG |
710 | obj = lookup_object_or_alloc(addr, db, descr, false, true); |
711 | if (likely(!IS_ERR_OR_NULL(obj))) { | |
d5f34153 WL |
712 | bool print_object = false; |
713 | ||
3ac7fe5a TG |
714 | switch (obj->state) { |
715 | case ODEBUG_STATE_INIT: | |
716 | case ODEBUG_STATE_INACTIVE: | |
717 | obj->state = ODEBUG_STATE_ACTIVE; | |
b778ae25 | 718 | ret = 0; |
3ac7fe5a TG |
719 | break; |
720 | ||
721 | case ODEBUG_STATE_ACTIVE: | |
3ac7fe5a | 722 | state = obj->state; |
aef9cb05 | 723 | raw_spin_unlock_irqrestore(&db->lock, flags); |
d5f34153 | 724 | debug_print_object(obj, "activate"); |
b778ae25 | 725 | ret = debug_object_fixup(descr->fixup_activate, addr, state); |
e7a8e78b | 726 | return ret ? 0 : -EINVAL; |
3ac7fe5a TG |
727 | |
728 | case ODEBUG_STATE_DESTROYED: | |
d5f34153 | 729 | print_object = true; |
b778ae25 | 730 | ret = -EINVAL; |
3ac7fe5a TG |
731 | break; |
732 | default: | |
b778ae25 | 733 | ret = 0; |
3ac7fe5a TG |
734 | break; |
735 | } | |
aef9cb05 | 736 | raw_spin_unlock_irqrestore(&db->lock, flags); |
d5f34153 WL |
737 | if (print_object) |
738 | debug_print_object(obj, "activate"); | |
b778ae25 | 739 | return ret; |
3ac7fe5a TG |
740 | } |
741 | ||
aef9cb05 | 742 | raw_spin_unlock_irqrestore(&db->lock, flags); |
d5f34153 | 743 | |
63a75969 TG |
744 | /* If NULL the allocation has hit OOM */ |
745 | if (!obj) { | |
746 | debug_objects_oom(); | |
747 | return 0; | |
b778ae25 | 748 | } |
63a75969 TG |
749 | |
750 | /* Object is neither static nor tracked. It's not initialized */ | |
751 | debug_print_object(&o, "activate"); | |
752 | ret = debug_object_fixup(descr->fixup_activate, addr, ODEBUG_STATE_NOTAVAILABLE); | |
753 | return ret ? 0 : -EINVAL; | |
3ac7fe5a | 754 | } |
f8ff04e2 | 755 | EXPORT_SYMBOL_GPL(debug_object_activate); |
3ac7fe5a TG |
756 | |
757 | /** | |
758 | * debug_object_deactivate - debug checks when an object is deactivated | |
759 | * @addr: address of the object | |
760 | * @descr: pointer to an object specific debug description structure | |
761 | */ | |
aedcade6 | 762 | void debug_object_deactivate(void *addr, const struct debug_obj_descr *descr) |
3ac7fe5a TG |
763 | { |
764 | struct debug_bucket *db; | |
765 | struct debug_obj *obj; | |
766 | unsigned long flags; | |
d5f34153 | 767 | bool print_object = false; |
3ac7fe5a TG |
768 | |
769 | if (!debug_objects_enabled) | |
770 | return; | |
771 | ||
772 | db = get_bucket((unsigned long) addr); | |
773 | ||
aef9cb05 | 774 | raw_spin_lock_irqsave(&db->lock, flags); |
3ac7fe5a TG |
775 | |
776 | obj = lookup_object(addr, db); | |
777 | if (obj) { | |
778 | switch (obj->state) { | |
779 | case ODEBUG_STATE_INIT: | |
780 | case ODEBUG_STATE_INACTIVE: | |
781 | case ODEBUG_STATE_ACTIVE: | |
a5d8e467 MD |
782 | if (!obj->astate) |
783 | obj->state = ODEBUG_STATE_INACTIVE; | |
784 | else | |
d5f34153 | 785 | print_object = true; |
3ac7fe5a TG |
786 | break; |
787 | ||
788 | case ODEBUG_STATE_DESTROYED: | |
d5f34153 | 789 | print_object = true; |
3ac7fe5a TG |
790 | break; |
791 | default: | |
792 | break; | |
793 | } | |
d5f34153 WL |
794 | } |
795 | ||
796 | raw_spin_unlock_irqrestore(&db->lock, flags); | |
797 | if (!obj) { | |
3ac7fe5a TG |
798 | struct debug_obj o = { .object = addr, |
799 | .state = ODEBUG_STATE_NOTAVAILABLE, | |
800 | .descr = descr }; | |
801 | ||
802 | debug_print_object(&o, "deactivate"); | |
d5f34153 WL |
803 | } else if (print_object) { |
804 | debug_print_object(obj, "deactivate"); | |
3ac7fe5a | 805 | } |
3ac7fe5a | 806 | } |
f8ff04e2 | 807 | EXPORT_SYMBOL_GPL(debug_object_deactivate); |
3ac7fe5a TG |
808 | |
809 | /** | |
810 | * debug_object_destroy - debug checks when an object is destroyed | |
811 | * @addr: address of the object | |
812 | * @descr: pointer to an object specific debug description structure | |
813 | */ | |
aedcade6 | 814 | void debug_object_destroy(void *addr, const struct debug_obj_descr *descr) |
3ac7fe5a TG |
815 | { |
816 | enum debug_obj_state state; | |
817 | struct debug_bucket *db; | |
818 | struct debug_obj *obj; | |
819 | unsigned long flags; | |
d5f34153 | 820 | bool print_object = false; |
3ac7fe5a TG |
821 | |
822 | if (!debug_objects_enabled) | |
823 | return; | |
824 | ||
825 | db = get_bucket((unsigned long) addr); | |
826 | ||
aef9cb05 | 827 | raw_spin_lock_irqsave(&db->lock, flags); |
3ac7fe5a TG |
828 | |
829 | obj = lookup_object(addr, db); | |
830 | if (!obj) | |
831 | goto out_unlock; | |
832 | ||
833 | switch (obj->state) { | |
834 | case ODEBUG_STATE_NONE: | |
835 | case ODEBUG_STATE_INIT: | |
836 | case ODEBUG_STATE_INACTIVE: | |
837 | obj->state = ODEBUG_STATE_DESTROYED; | |
838 | break; | |
839 | case ODEBUG_STATE_ACTIVE: | |
3ac7fe5a | 840 | state = obj->state; |
aef9cb05 | 841 | raw_spin_unlock_irqrestore(&db->lock, flags); |
d5f34153 | 842 | debug_print_object(obj, "destroy"); |
3ac7fe5a TG |
843 | debug_object_fixup(descr->fixup_destroy, addr, state); |
844 | return; | |
845 | ||
846 | case ODEBUG_STATE_DESTROYED: | |
d5f34153 | 847 | print_object = true; |
3ac7fe5a TG |
848 | break; |
849 | default: | |
850 | break; | |
851 | } | |
852 | out_unlock: | |
aef9cb05 | 853 | raw_spin_unlock_irqrestore(&db->lock, flags); |
d5f34153 WL |
854 | if (print_object) |
855 | debug_print_object(obj, "destroy"); | |
3ac7fe5a | 856 | } |
f8ff04e2 | 857 | EXPORT_SYMBOL_GPL(debug_object_destroy); |
3ac7fe5a TG |
858 | |
859 | /** | |
860 | * debug_object_free - debug checks when an object is freed | |
861 | * @addr: address of the object | |
862 | * @descr: pointer to an object specific debug description structure | |
863 | */ | |
aedcade6 | 864 | void debug_object_free(void *addr, const struct debug_obj_descr *descr) |
3ac7fe5a TG |
865 | { |
866 | enum debug_obj_state state; | |
867 | struct debug_bucket *db; | |
868 | struct debug_obj *obj; | |
869 | unsigned long flags; | |
870 | ||
871 | if (!debug_objects_enabled) | |
872 | return; | |
873 | ||
874 | db = get_bucket((unsigned long) addr); | |
875 | ||
aef9cb05 | 876 | raw_spin_lock_irqsave(&db->lock, flags); |
3ac7fe5a TG |
877 | |
878 | obj = lookup_object(addr, db); | |
879 | if (!obj) | |
880 | goto out_unlock; | |
881 | ||
882 | switch (obj->state) { | |
883 | case ODEBUG_STATE_ACTIVE: | |
3ac7fe5a | 884 | state = obj->state; |
aef9cb05 | 885 | raw_spin_unlock_irqrestore(&db->lock, flags); |
d5f34153 | 886 | debug_print_object(obj, "free"); |
3ac7fe5a TG |
887 | debug_object_fixup(descr->fixup_free, addr, state); |
888 | return; | |
889 | default: | |
890 | hlist_del(&obj->node); | |
aef9cb05 | 891 | raw_spin_unlock_irqrestore(&db->lock, flags); |
3ac7fe5a | 892 | free_object(obj); |
673d62cc | 893 | return; |
3ac7fe5a TG |
894 | } |
895 | out_unlock: | |
aef9cb05 | 896 | raw_spin_unlock_irqrestore(&db->lock, flags); |
3ac7fe5a | 897 | } |
f8ff04e2 | 898 | EXPORT_SYMBOL_GPL(debug_object_free); |
3ac7fe5a | 899 | |
b84d435c CC |
900 | /** |
901 | * debug_object_assert_init - debug checks when object should be init-ed | |
902 | * @addr: address of the object | |
903 | * @descr: pointer to an object specific debug description structure | |
904 | */ | |
aedcade6 | 905 | void debug_object_assert_init(void *addr, const struct debug_obj_descr *descr) |
b84d435c | 906 | { |
63a75969 | 907 | struct debug_obj o = { .object = addr, .state = ODEBUG_STATE_NOTAVAILABLE, .descr = descr }; |
b84d435c CC |
908 | struct debug_bucket *db; |
909 | struct debug_obj *obj; | |
910 | unsigned long flags; | |
911 | ||
912 | if (!debug_objects_enabled) | |
913 | return; | |
914 | ||
0af462f1 TG |
915 | debug_objects_fill_pool(); |
916 | ||
b84d435c CC |
917 | db = get_bucket((unsigned long) addr); |
918 | ||
919 | raw_spin_lock_irqsave(&db->lock, flags); | |
63a75969 TG |
920 | obj = lookup_object_or_alloc(addr, db, descr, false, true); |
921 | raw_spin_unlock_irqrestore(&db->lock, flags); | |
922 | if (likely(!IS_ERR_OR_NULL(obj))) | |
923 | return; | |
b84d435c | 924 | |
63a75969 | 925 | /* If NULL the allocation has hit OOM */ |
b84d435c | 926 | if (!obj) { |
63a75969 | 927 | debug_objects_oom(); |
b84d435c CC |
928 | return; |
929 | } | |
930 | ||
63a75969 TG |
931 | /* Object is neither tracked nor static. It's not initialized. */ |
932 | debug_print_object(&o, "assert_init"); | |
933 | debug_object_fixup(descr->fixup_assert_init, addr, ODEBUG_STATE_NOTAVAILABLE); | |
b84d435c | 934 | } |
f8ff04e2 | 935 | EXPORT_SYMBOL_GPL(debug_object_assert_init); |
b84d435c | 936 | |
a5d8e467 MD |
937 | /** |
938 | * debug_object_active_state - debug checks object usage state machine | |
939 | * @addr: address of the object | |
940 | * @descr: pointer to an object specific debug description structure | |
941 | * @expect: expected state | |
942 | * @next: state to move to if expected state is found | |
943 | */ | |
944 | void | |
aedcade6 | 945 | debug_object_active_state(void *addr, const struct debug_obj_descr *descr, |
a5d8e467 MD |
946 | unsigned int expect, unsigned int next) |
947 | { | |
948 | struct debug_bucket *db; | |
949 | struct debug_obj *obj; | |
950 | unsigned long flags; | |
d5f34153 | 951 | bool print_object = false; |
a5d8e467 MD |
952 | |
953 | if (!debug_objects_enabled) | |
954 | return; | |
955 | ||
956 | db = get_bucket((unsigned long) addr); | |
957 | ||
958 | raw_spin_lock_irqsave(&db->lock, flags); | |
959 | ||
960 | obj = lookup_object(addr, db); | |
961 | if (obj) { | |
962 | switch (obj->state) { | |
963 | case ODEBUG_STATE_ACTIVE: | |
964 | if (obj->astate == expect) | |
965 | obj->astate = next; | |
966 | else | |
d5f34153 | 967 | print_object = true; |
a5d8e467 MD |
968 | break; |
969 | ||
970 | default: | |
d5f34153 | 971 | print_object = true; |
a5d8e467 MD |
972 | break; |
973 | } | |
d5f34153 WL |
974 | } |
975 | ||
976 | raw_spin_unlock_irqrestore(&db->lock, flags); | |
977 | if (!obj) { | |
a5d8e467 MD |
978 | struct debug_obj o = { .object = addr, |
979 | .state = ODEBUG_STATE_NOTAVAILABLE, | |
980 | .descr = descr }; | |
981 | ||
982 | debug_print_object(&o, "active_state"); | |
d5f34153 WL |
983 | } else if (print_object) { |
984 | debug_print_object(obj, "active_state"); | |
a5d8e467 | 985 | } |
a5d8e467 | 986 | } |
f8ff04e2 | 987 | EXPORT_SYMBOL_GPL(debug_object_active_state); |
a5d8e467 | 988 | |
3ac7fe5a TG |
989 | #ifdef CONFIG_DEBUG_OBJECTS_FREE |
990 | static void __debug_check_no_obj_freed(const void *address, unsigned long size) | |
991 | { | |
992 | unsigned long flags, oaddr, saddr, eaddr, paddr, chunks; | |
aedcade6 | 993 | const struct debug_obj_descr *descr; |
3ac7fe5a TG |
994 | enum debug_obj_state state; |
995 | struct debug_bucket *db; | |
1ea9b98b | 996 | struct hlist_node *tmp; |
3ac7fe5a | 997 | struct debug_obj *obj; |
bd9dcd04 | 998 | int cnt, objs_checked = 0; |
3ac7fe5a TG |
999 | |
1000 | saddr = (unsigned long) address; | |
1001 | eaddr = saddr + size; | |
1002 | paddr = saddr & ODEBUG_CHUNK_MASK; | |
1003 | chunks = ((eaddr - paddr) + (ODEBUG_CHUNK_SIZE - 1)); | |
1004 | chunks >>= ODEBUG_CHUNK_SHIFT; | |
1005 | ||
1006 | for (;chunks > 0; chunks--, paddr += ODEBUG_CHUNK_SIZE) { | |
1007 | db = get_bucket(paddr); | |
1008 | ||
1009 | repeat: | |
1010 | cnt = 0; | |
aef9cb05 | 1011 | raw_spin_lock_irqsave(&db->lock, flags); |
b67bfe0d | 1012 | hlist_for_each_entry_safe(obj, tmp, &db->list, node) { |
3ac7fe5a TG |
1013 | cnt++; |
1014 | oaddr = (unsigned long) obj->object; | |
1015 | if (oaddr < saddr || oaddr >= eaddr) | |
1016 | continue; | |
1017 | ||
1018 | switch (obj->state) { | |
1019 | case ODEBUG_STATE_ACTIVE: | |
3ac7fe5a TG |
1020 | descr = obj->descr; |
1021 | state = obj->state; | |
aef9cb05 | 1022 | raw_spin_unlock_irqrestore(&db->lock, flags); |
d5f34153 | 1023 | debug_print_object(obj, "free"); |
3ac7fe5a TG |
1024 | debug_object_fixup(descr->fixup_free, |
1025 | (void *) oaddr, state); | |
1026 | goto repeat; | |
1027 | default: | |
1028 | hlist_del(&obj->node); | |
a7344a68 | 1029 | __free_object(obj); |
3ac7fe5a TG |
1030 | break; |
1031 | } | |
1032 | } | |
aef9cb05 | 1033 | raw_spin_unlock_irqrestore(&db->lock, flags); |
673d62cc | 1034 | |
3ac7fe5a TG |
1035 | if (cnt > debug_objects_maxchain) |
1036 | debug_objects_maxchain = cnt; | |
bd9dcd04 YS |
1037 | |
1038 | objs_checked += cnt; | |
3ac7fe5a | 1039 | } |
bd9dcd04 YS |
1040 | |
1041 | if (objs_checked > debug_objects_maxchecked) | |
1042 | debug_objects_maxchecked = objs_checked; | |
1ea9b98b YS |
1043 | |
1044 | /* Schedule work to actually kmem_cache_free() objects */ | |
35fd7a63 | 1045 | if (!READ_ONCE(obj_freeing) && READ_ONCE(obj_nr_tofree)) { |
a7344a68 WL |
1046 | WRITE_ONCE(obj_freeing, true); |
1047 | schedule_delayed_work(&debug_obj_work, ODEBUG_FREE_WORK_DELAY); | |
1048 | } | |
3ac7fe5a TG |
1049 | } |
1050 | ||
1051 | void debug_check_no_obj_freed(const void *address, unsigned long size) | |
1052 | { | |
1053 | if (debug_objects_enabled) | |
1054 | __debug_check_no_obj_freed(address, size); | |
1055 | } | |
1056 | #endif | |
1057 | ||
1058 | #ifdef CONFIG_DEBUG_FS | |
1059 | ||
1060 | static int debug_stats_show(struct seq_file *m, void *v) | |
1061 | { | |
d86998b1 WL |
1062 | int cpu, obj_percpu_free = 0; |
1063 | ||
1064 | for_each_possible_cpu(cpu) | |
1065 | obj_percpu_free += per_cpu(percpu_obj_pool.obj_free, cpu); | |
1066 | ||
3ac7fe5a | 1067 | seq_printf(m, "max_chain :%d\n", debug_objects_maxchain); |
bd9dcd04 | 1068 | seq_printf(m, "max_checked :%d\n", debug_objects_maxchecked); |
3ac7fe5a TG |
1069 | seq_printf(m, "warnings :%d\n", debug_objects_warnings); |
1070 | seq_printf(m, "fixups :%d\n", debug_objects_fixups); | |
35fd7a63 | 1071 | seq_printf(m, "pool_free :%d\n", READ_ONCE(obj_pool_free) + obj_percpu_free); |
d86998b1 | 1072 | seq_printf(m, "pool_pcp_free :%d\n", obj_percpu_free); |
3ac7fe5a | 1073 | seq_printf(m, "pool_min_free :%d\n", obj_pool_min_free); |
d86998b1 | 1074 | seq_printf(m, "pool_used :%d\n", obj_pool_used - obj_percpu_free); |
3ac7fe5a | 1075 | seq_printf(m, "pool_max_used :%d\n", obj_pool_max_used); |
35fd7a63 | 1076 | seq_printf(m, "on_free_list :%d\n", READ_ONCE(obj_nr_tofree)); |
0cad93c3 WL |
1077 | seq_printf(m, "objs_allocated:%d\n", debug_objects_allocated); |
1078 | seq_printf(m, "objs_freed :%d\n", debug_objects_freed); | |
3ac7fe5a TG |
1079 | return 0; |
1080 | } | |
0f85c480 | 1081 | DEFINE_SHOW_ATTRIBUTE(debug_stats); |
3ac7fe5a TG |
1082 | |
1083 | static int __init debug_objects_init_debugfs(void) | |
1084 | { | |
fecb0d95 | 1085 | struct dentry *dbgdir; |
3ac7fe5a TG |
1086 | |
1087 | if (!debug_objects_enabled) | |
1088 | return 0; | |
1089 | ||
1090 | dbgdir = debugfs_create_dir("debug_objects", NULL); | |
3ac7fe5a | 1091 | |
fecb0d95 | 1092 | debugfs_create_file("stats", 0444, dbgdir, NULL, &debug_stats_fops); |
3ac7fe5a TG |
1093 | |
1094 | return 0; | |
3ac7fe5a TG |
1095 | } |
1096 | __initcall(debug_objects_init_debugfs); | |
1097 | ||
1098 | #else | |
1099 | static inline void debug_objects_init_debugfs(void) { } | |
1100 | #endif | |
1101 | ||
1102 | #ifdef CONFIG_DEBUG_OBJECTS_SELFTEST | |
1103 | ||
1104 | /* Random data structure for the self test */ | |
1105 | struct self_test { | |
1106 | unsigned long dummy1[6]; | |
1107 | int static_init; | |
1108 | unsigned long dummy2[3]; | |
1109 | }; | |
1110 | ||
aedcade6 | 1111 | static __initconst const struct debug_obj_descr descr_type_test; |
3ac7fe5a | 1112 | |
b9fdac7f DC |
1113 | static bool __init is_static_object(void *addr) |
1114 | { | |
1115 | struct self_test *obj = addr; | |
1116 | ||
1117 | return obj->static_init; | |
1118 | } | |
1119 | ||
3ac7fe5a TG |
1120 | /* |
1121 | * fixup_init is called when: | |
1122 | * - an active object is initialized | |
1123 | */ | |
b1e4d9d8 | 1124 | static bool __init fixup_init(void *addr, enum debug_obj_state state) |
3ac7fe5a TG |
1125 | { |
1126 | struct self_test *obj = addr; | |
1127 | ||
1128 | switch (state) { | |
1129 | case ODEBUG_STATE_ACTIVE: | |
1130 | debug_object_deactivate(obj, &descr_type_test); | |
1131 | debug_object_init(obj, &descr_type_test); | |
b1e4d9d8 | 1132 | return true; |
3ac7fe5a | 1133 | default: |
b1e4d9d8 | 1134 | return false; |
3ac7fe5a TG |
1135 | } |
1136 | } | |
1137 | ||
1138 | /* | |
1139 | * fixup_activate is called when: | |
1140 | * - an active object is activated | |
b9fdac7f | 1141 | * - an unknown non-static object is activated |
3ac7fe5a | 1142 | */ |
b1e4d9d8 | 1143 | static bool __init fixup_activate(void *addr, enum debug_obj_state state) |
3ac7fe5a TG |
1144 | { |
1145 | struct self_test *obj = addr; | |
1146 | ||
1147 | switch (state) { | |
1148 | case ODEBUG_STATE_NOTAVAILABLE: | |
b1e4d9d8 | 1149 | return true; |
3ac7fe5a TG |
1150 | case ODEBUG_STATE_ACTIVE: |
1151 | debug_object_deactivate(obj, &descr_type_test); | |
1152 | debug_object_activate(obj, &descr_type_test); | |
b1e4d9d8 | 1153 | return true; |
3ac7fe5a TG |
1154 | |
1155 | default: | |
b1e4d9d8 | 1156 | return false; |
3ac7fe5a TG |
1157 | } |
1158 | } | |
1159 | ||
1160 | /* | |
1161 | * fixup_destroy is called when: | |
1162 | * - an active object is destroyed | |
1163 | */ | |
b1e4d9d8 | 1164 | static bool __init fixup_destroy(void *addr, enum debug_obj_state state) |
3ac7fe5a TG |
1165 | { |
1166 | struct self_test *obj = addr; | |
1167 | ||
1168 | switch (state) { | |
1169 | case ODEBUG_STATE_ACTIVE: | |
1170 | debug_object_deactivate(obj, &descr_type_test); | |
1171 | debug_object_destroy(obj, &descr_type_test); | |
b1e4d9d8 | 1172 | return true; |
3ac7fe5a | 1173 | default: |
b1e4d9d8 | 1174 | return false; |
3ac7fe5a TG |
1175 | } |
1176 | } | |
1177 | ||
1178 | /* | |
1179 | * fixup_free is called when: | |
1180 | * - an active object is freed | |
1181 | */ | |
b1e4d9d8 | 1182 | static bool __init fixup_free(void *addr, enum debug_obj_state state) |
3ac7fe5a TG |
1183 | { |
1184 | struct self_test *obj = addr; | |
1185 | ||
1186 | switch (state) { | |
1187 | case ODEBUG_STATE_ACTIVE: | |
1188 | debug_object_deactivate(obj, &descr_type_test); | |
1189 | debug_object_free(obj, &descr_type_test); | |
b1e4d9d8 | 1190 | return true; |
3ac7fe5a | 1191 | default: |
b1e4d9d8 | 1192 | return false; |
3ac7fe5a TG |
1193 | } |
1194 | } | |
1195 | ||
1fb2f77c | 1196 | static int __init |
3ac7fe5a TG |
1197 | check_results(void *addr, enum debug_obj_state state, int fixups, int warnings) |
1198 | { | |
1199 | struct debug_bucket *db; | |
1200 | struct debug_obj *obj; | |
1201 | unsigned long flags; | |
1202 | int res = -EINVAL; | |
1203 | ||
1204 | db = get_bucket((unsigned long) addr); | |
1205 | ||
aef9cb05 | 1206 | raw_spin_lock_irqsave(&db->lock, flags); |
3ac7fe5a TG |
1207 | |
1208 | obj = lookup_object(addr, db); | |
1209 | if (!obj && state != ODEBUG_STATE_NONE) { | |
5cd2b459 | 1210 | WARN(1, KERN_ERR "ODEBUG: selftest object not found\n"); |
3ac7fe5a TG |
1211 | goto out; |
1212 | } | |
1213 | if (obj && obj->state != state) { | |
5cd2b459 | 1214 | WARN(1, KERN_ERR "ODEBUG: selftest wrong state: %d != %d\n", |
3ac7fe5a | 1215 | obj->state, state); |
3ac7fe5a TG |
1216 | goto out; |
1217 | } | |
1218 | if (fixups != debug_objects_fixups) { | |
5cd2b459 | 1219 | WARN(1, KERN_ERR "ODEBUG: selftest fixups failed %d != %d\n", |
3ac7fe5a | 1220 | fixups, debug_objects_fixups); |
3ac7fe5a TG |
1221 | goto out; |
1222 | } | |
1223 | if (warnings != debug_objects_warnings) { | |
5cd2b459 | 1224 | WARN(1, KERN_ERR "ODEBUG: selftest warnings failed %d != %d\n", |
3ac7fe5a | 1225 | warnings, debug_objects_warnings); |
3ac7fe5a TG |
1226 | goto out; |
1227 | } | |
1228 | res = 0; | |
1229 | out: | |
aef9cb05 | 1230 | raw_spin_unlock_irqrestore(&db->lock, flags); |
3ac7fe5a TG |
1231 | if (res) |
1232 | debug_objects_enabled = 0; | |
1233 | return res; | |
1234 | } | |
1235 | ||
aedcade6 | 1236 | static __initconst const struct debug_obj_descr descr_type_test = { |
3ac7fe5a | 1237 | .name = "selftest", |
b9fdac7f | 1238 | .is_static_object = is_static_object, |
3ac7fe5a TG |
1239 | .fixup_init = fixup_init, |
1240 | .fixup_activate = fixup_activate, | |
1241 | .fixup_destroy = fixup_destroy, | |
1242 | .fixup_free = fixup_free, | |
1243 | }; | |
1244 | ||
1245 | static __initdata struct self_test obj = { .static_init = 0 }; | |
1246 | ||
1247 | static void __init debug_objects_selftest(void) | |
1248 | { | |
1249 | int fixups, oldfixups, warnings, oldwarnings; | |
1250 | unsigned long flags; | |
1251 | ||
1252 | local_irq_save(flags); | |
1253 | ||
1254 | fixups = oldfixups = debug_objects_fixups; | |
1255 | warnings = oldwarnings = debug_objects_warnings; | |
1256 | descr_test = &descr_type_test; | |
1257 | ||
1258 | debug_object_init(&obj, &descr_type_test); | |
1259 | if (check_results(&obj, ODEBUG_STATE_INIT, fixups, warnings)) | |
1260 | goto out; | |
1261 | debug_object_activate(&obj, &descr_type_test); | |
1262 | if (check_results(&obj, ODEBUG_STATE_ACTIVE, fixups, warnings)) | |
1263 | goto out; | |
1264 | debug_object_activate(&obj, &descr_type_test); | |
1265 | if (check_results(&obj, ODEBUG_STATE_ACTIVE, ++fixups, ++warnings)) | |
1266 | goto out; | |
1267 | debug_object_deactivate(&obj, &descr_type_test); | |
1268 | if (check_results(&obj, ODEBUG_STATE_INACTIVE, fixups, warnings)) | |
1269 | goto out; | |
1270 | debug_object_destroy(&obj, &descr_type_test); | |
1271 | if (check_results(&obj, ODEBUG_STATE_DESTROYED, fixups, warnings)) | |
1272 | goto out; | |
1273 | debug_object_init(&obj, &descr_type_test); | |
1274 | if (check_results(&obj, ODEBUG_STATE_DESTROYED, fixups, ++warnings)) | |
1275 | goto out; | |
1276 | debug_object_activate(&obj, &descr_type_test); | |
1277 | if (check_results(&obj, ODEBUG_STATE_DESTROYED, fixups, ++warnings)) | |
1278 | goto out; | |
1279 | debug_object_deactivate(&obj, &descr_type_test); | |
1280 | if (check_results(&obj, ODEBUG_STATE_DESTROYED, fixups, ++warnings)) | |
1281 | goto out; | |
1282 | debug_object_free(&obj, &descr_type_test); | |
1283 | if (check_results(&obj, ODEBUG_STATE_NONE, fixups, warnings)) | |
1284 | goto out; | |
1285 | ||
1286 | obj.static_init = 1; | |
1287 | debug_object_activate(&obj, &descr_type_test); | |
9f78ff00 | 1288 | if (check_results(&obj, ODEBUG_STATE_ACTIVE, fixups, warnings)) |
3ac7fe5a TG |
1289 | goto out; |
1290 | debug_object_init(&obj, &descr_type_test); | |
1291 | if (check_results(&obj, ODEBUG_STATE_INIT, ++fixups, ++warnings)) | |
1292 | goto out; | |
1293 | debug_object_free(&obj, &descr_type_test); | |
1294 | if (check_results(&obj, ODEBUG_STATE_NONE, fixups, warnings)) | |
1295 | goto out; | |
1296 | ||
1297 | #ifdef CONFIG_DEBUG_OBJECTS_FREE | |
1298 | debug_object_init(&obj, &descr_type_test); | |
1299 | if (check_results(&obj, ODEBUG_STATE_INIT, fixups, warnings)) | |
1300 | goto out; | |
1301 | debug_object_activate(&obj, &descr_type_test); | |
1302 | if (check_results(&obj, ODEBUG_STATE_ACTIVE, fixups, warnings)) | |
1303 | goto out; | |
1304 | __debug_check_no_obj_freed(&obj, sizeof(obj)); | |
1305 | if (check_results(&obj, ODEBUG_STATE_NONE, ++fixups, ++warnings)) | |
1306 | goto out; | |
1307 | #endif | |
719e4843 | 1308 | pr_info("selftest passed\n"); |
3ac7fe5a TG |
1309 | |
1310 | out: | |
1311 | debug_objects_fixups = oldfixups; | |
1312 | debug_objects_warnings = oldwarnings; | |
1313 | descr_test = NULL; | |
1314 | ||
1315 | local_irq_restore(flags); | |
1316 | } | |
1317 | #else | |
1318 | static inline void debug_objects_selftest(void) { } | |
1319 | #endif | |
1320 | ||
1321 | /* | |
1322 | * Called during early boot to initialize the hash buckets and link | |
1323 | * the static object pool objects into the poll list. After this call | |
1324 | * the object tracker is fully operational. | |
1325 | */ | |
1326 | void __init debug_objects_early_init(void) | |
1327 | { | |
1328 | int i; | |
1329 | ||
1330 | for (i = 0; i < ODEBUG_HASH_SIZE; i++) | |
aef9cb05 | 1331 | raw_spin_lock_init(&obj_hash[i].lock); |
3ac7fe5a TG |
1332 | |
1333 | for (i = 0; i < ODEBUG_POOL_SIZE; i++) | |
1334 | hlist_add_head(&obj_static_pool[i].node, &obj_pool); | |
1335 | } | |
1336 | ||
1be1cb7b TG |
1337 | /* |
1338 | * Convert the statically allocated objects to dynamic ones: | |
1339 | */ | |
1fb2f77c | 1340 | static int __init debug_objects_replace_static_objects(void) |
1be1cb7b TG |
1341 | { |
1342 | struct debug_bucket *db = obj_hash; | |
b67bfe0d | 1343 | struct hlist_node *tmp; |
1be1cb7b TG |
1344 | struct debug_obj *obj, *new; |
1345 | HLIST_HEAD(objects); | |
1346 | int i, cnt = 0; | |
1347 | ||
1348 | for (i = 0; i < ODEBUG_POOL_SIZE; i++) { | |
1349 | obj = kmem_cache_zalloc(obj_cache, GFP_KERNEL); | |
1350 | if (!obj) | |
1351 | goto free; | |
1352 | hlist_add_head(&obj->node, &objects); | |
1353 | } | |
1354 | ||
eabb7f1a | 1355 | debug_objects_allocated += i; |
1356 | ||
1be1cb7b | 1357 | /* |
a9ee3a63 QC |
1358 | * debug_objects_mem_init() is now called early that only one CPU is up |
1359 | * and interrupts have been disabled, so it is safe to replace the | |
1360 | * active object references. | |
1be1cb7b | 1361 | */ |
1be1cb7b TG |
1362 | |
1363 | /* Remove the statically allocated objects from the pool */ | |
b67bfe0d | 1364 | hlist_for_each_entry_safe(obj, tmp, &obj_pool, node) |
1be1cb7b TG |
1365 | hlist_del(&obj->node); |
1366 | /* Move the allocated objects to the pool */ | |
1367 | hlist_move_list(&objects, &obj_pool); | |
1368 | ||
1369 | /* Replace the active object references */ | |
1370 | for (i = 0; i < ODEBUG_HASH_SIZE; i++, db++) { | |
1371 | hlist_move_list(&db->list, &objects); | |
1372 | ||
b67bfe0d | 1373 | hlist_for_each_entry(obj, &objects, node) { |
1be1cb7b TG |
1374 | new = hlist_entry(obj_pool.first, typeof(*obj), node); |
1375 | hlist_del(&new->node); | |
1376 | /* copy object data */ | |
1377 | *new = *obj; | |
1378 | hlist_add_head(&new->node, &db->list); | |
1379 | cnt++; | |
1380 | } | |
1381 | } | |
1382 | ||
c0f35cc0 FF |
1383 | pr_debug("%d of %d active objects replaced\n", |
1384 | cnt, obj_pool_used); | |
1be1cb7b TG |
1385 | return 0; |
1386 | free: | |
b67bfe0d | 1387 | hlist_for_each_entry_safe(obj, tmp, &objects, node) { |
1be1cb7b TG |
1388 | hlist_del(&obj->node); |
1389 | kmem_cache_free(obj_cache, obj); | |
1390 | } | |
1391 | return -ENOMEM; | |
1392 | } | |
1393 | ||
3ac7fe5a TG |
1394 | /* |
1395 | * Called after the kmem_caches are functional to setup a dedicated | |
1396 | * cache pool, which has the SLAB_DEBUG_OBJECTS flag set. This flag | |
1397 | * prevents that the debug code is called on kmem_cache_free() for the | |
1398 | * debug tracker objects to avoid recursive calls. | |
1399 | */ | |
1400 | void __init debug_objects_mem_init(void) | |
1401 | { | |
634d61f4 | 1402 | int cpu, extras; |
d86998b1 | 1403 | |
3ac7fe5a TG |
1404 | if (!debug_objects_enabled) |
1405 | return; | |
1406 | ||
d86998b1 WL |
1407 | /* |
1408 | * Initialize the percpu object pools | |
1409 | * | |
1410 | * Initialization is not strictly necessary, but was done for | |
1411 | * completeness. | |
1412 | */ | |
1413 | for_each_possible_cpu(cpu) | |
1414 | INIT_HLIST_HEAD(&per_cpu(percpu_obj_pool.free_objs, cpu)); | |
1415 | ||
3ac7fe5a TG |
1416 | obj_cache = kmem_cache_create("debug_objects_cache", |
1417 | sizeof (struct debug_obj), 0, | |
8de456cf QC |
1418 | SLAB_DEBUG_OBJECTS | SLAB_NOLEAKTRACE, |
1419 | NULL); | |
3ac7fe5a | 1420 | |
1be1cb7b | 1421 | if (!obj_cache || debug_objects_replace_static_objects()) { |
3ac7fe5a | 1422 | debug_objects_enabled = 0; |
3ff4f80a | 1423 | kmem_cache_destroy(obj_cache); |
719e4843 | 1424 | pr_warn("out of memory.\n"); |
eabb7f1a | 1425 | return; |
1be1cb7b | 1426 | } else |
3ac7fe5a | 1427 | debug_objects_selftest(); |
634d61f4 | 1428 | |
88451f2c Z |
1429 | #ifdef CONFIG_HOTPLUG_CPU |
1430 | cpuhp_setup_state_nocalls(CPUHP_DEBUG_OBJ_DEAD, "object:offline", NULL, | |
1431 | object_cpu_offline); | |
1432 | #endif | |
1433 | ||
634d61f4 WL |
1434 | /* |
1435 | * Increase the thresholds for allocating and freeing objects | |
1436 | * according to the number of possible CPUs available in the system. | |
1437 | */ | |
1438 | extras = num_possible_cpus() * ODEBUG_BATCH_SIZE; | |
1439 | debug_objects_pool_size += extras; | |
1440 | debug_objects_pool_min_level += extras; | |
3ac7fe5a | 1441 | } |