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