debugobjects.c 26.1 KB
Newer Older
1
2
3
4
5
6
7
8
9
/*
 * Generic infrastructure for lifetime debugging of objects.
 *
 * Started by Thomas Gleixner
 *
 * Copyright (C) 2008, Thomas Gleixner <tglx@linutronix.de>
 *
 * For licencing details see kernel-base/COPYING
 */
10
11
12

#define pr_fmt(fmt) "ODEBUG: " fmt

13
14
#include <linux/debugobjects.h>
#include <linux/interrupt.h>
15
#include <linux/sched.h>
16
17
#include <linux/seq_file.h>
#include <linux/debugfs.h>
18
#include <linux/slab.h>
19
20
21
22
23
#include <linux/hash.h>

#define ODEBUG_HASH_BITS	14
#define ODEBUG_HASH_SIZE	(1 << ODEBUG_HASH_BITS)

24
#define ODEBUG_POOL_SIZE	1024
25
26
27
28
29
30
31
32
#define ODEBUG_POOL_MIN_LEVEL	256

#define ODEBUG_CHUNK_SHIFT	PAGE_SHIFT
#define ODEBUG_CHUNK_SIZE	(1 << ODEBUG_CHUNK_SHIFT)
#define ODEBUG_CHUNK_MASK	(~(ODEBUG_CHUNK_SIZE - 1))

struct debug_bucket {
	struct hlist_head	list;
33
	raw_spinlock_t		lock;
34
35
36
37
};

static struct debug_bucket	obj_hash[ODEBUG_HASH_SIZE];

38
static struct debug_obj		obj_static_pool[ODEBUG_POOL_SIZE] __initdata;
39

40
static DEFINE_RAW_SPINLOCK(pool_lock);
41
42
43
44
45
46
47
48
49
50
51
52

static HLIST_HEAD(obj_pool);

static int			obj_pool_min_free = ODEBUG_POOL_SIZE;
static int			obj_pool_free = ODEBUG_POOL_SIZE;
static int			obj_pool_used;
static int			obj_pool_max_used;
static struct kmem_cache	*obj_cache;

static int			debug_objects_maxchain __read_mostly;
static int			debug_objects_fixups __read_mostly;
static int			debug_objects_warnings __read_mostly;
53
54
55
static int			debug_objects_enabled __read_mostly
				= CONFIG_DEBUG_OBJECTS_ENABLE_DEFAULT;

56
57
static struct debug_obj_descr	*descr_test  __read_mostly;

58
59
60
static void free_obj_work(struct work_struct *work);
static DECLARE_WORK(debug_obj_work, free_obj_work);

61
62
63
64
65
static int __init enable_object_debug(char *str)
{
	debug_objects_enabled = 1;
	return 0;
}
66
67
68
69
70
71
72

static int __init disable_object_debug(char *str)
{
	debug_objects_enabled = 0;
	return 0;
}

73
early_param("debug_objects", enable_object_debug);
74
early_param("no_debug_objects", disable_object_debug);
75
76
77
78
79
80
81
82
83
84

static const char *obj_states[ODEBUG_STATE_MAX] = {
	[ODEBUG_STATE_NONE]		= "none",
	[ODEBUG_STATE_INIT]		= "initialized",
	[ODEBUG_STATE_INACTIVE]		= "inactive",
	[ODEBUG_STATE_ACTIVE]		= "active",
	[ODEBUG_STATE_DESTROYED]	= "destroyed",
	[ODEBUG_STATE_NOTAVAILABLE]	= "not available",
};

85
static void fill_pool(void)
86
87
88
{
	gfp_t gfp = GFP_ATOMIC | __GFP_NORETRY | __GFP_NOWARN;
	struct debug_obj *new;
89
	unsigned long flags;
90
91

	if (likely(obj_pool_free >= ODEBUG_POOL_MIN_LEVEL))
92
		return;
93
94

	if (unlikely(!obj_cache))
95
		return;
96
97
98
99
100

	while (obj_pool_free < ODEBUG_POOL_MIN_LEVEL) {

		new = kmem_cache_zalloc(obj_cache, gfp);
		if (!new)
101
			return;
102

103
		raw_spin_lock_irqsave(&pool_lock, flags);
104
105
		hlist_add_head(&new->node, &obj_pool);
		obj_pool_free++;
106
		raw_spin_unlock_irqrestore(&pool_lock, flags);
107
108
109
110
111
112
113
114
115
116
117
	}
}

/*
 * Lookup an object in the hash bucket.
 */
static struct debug_obj *lookup_object(void *addr, struct debug_bucket *b)
{
	struct debug_obj *obj;
	int cnt = 0;

118
	hlist_for_each_entry(obj, &b->list, node) {
119
120
121
122
123
124
125
126
127
128
129
		cnt++;
		if (obj->object == addr)
			return obj;
	}
	if (cnt > debug_objects_maxchain)
		debug_objects_maxchain = cnt;

	return NULL;
}

/*
130
 * Allocate a new object. If the pool is empty, switch off the debugger.
131
 * Must be called with interrupts disabled.
132
133
134
135
136
137
 */
static struct debug_obj *
alloc_object(void *addr, struct debug_bucket *b, struct debug_obj_descr *descr)
{
	struct debug_obj *obj = NULL;

138
	raw_spin_lock(&pool_lock);
139
140
141
142
143
144
	if (obj_pool.first) {
		obj	    = hlist_entry(obj_pool.first, typeof(*obj), node);

		obj->object = addr;
		obj->descr  = descr;
		obj->state  = ODEBUG_STATE_NONE;
145
		obj->astate = 0;
146
147
148
149
150
151
152
153
154
155
156
157
		hlist_del(&obj->node);

		hlist_add_head(&obj->node, &b->list);

		obj_pool_used++;
		if (obj_pool_used > obj_pool_max_used)
			obj_pool_max_used = obj_pool_used;

		obj_pool_free--;
		if (obj_pool_free < obj_pool_min_free)
			obj_pool_min_free = obj_pool_free;
	}
158
	raw_spin_unlock(&pool_lock);
159
160
161
162
163

	return obj;
}

/*
164
 * workqueue function to free objects.
165
 */
166
static void free_obj_work(struct work_struct *work)
167
{
168
	struct debug_obj *obj;
169
	unsigned long flags;
170

171
	raw_spin_lock_irqsave(&pool_lock, flags);
172
173
174
175
176
177
178
179
	while (obj_pool_free > ODEBUG_POOL_SIZE) {
		obj = hlist_entry(obj_pool.first, typeof(*obj), node);
		hlist_del(&obj->node);
		obj_pool_free--;
		/*
		 * We release pool_lock across kmem_cache_free() to
		 * avoid contention on pool_lock.
		 */
180
		raw_spin_unlock_irqrestore(&pool_lock, flags);
181
		kmem_cache_free(obj_cache, obj);
182
		raw_spin_lock_irqsave(&pool_lock, flags);
183
	}
184
	raw_spin_unlock_irqrestore(&pool_lock, flags);
185
186
187
188
189
190
191
192
193
194
195
}

/*
 * Put the object back into the pool and schedule work to free objects
 * if necessary.
 */
static void free_object(struct debug_obj *obj)
{
	unsigned long flags;
	int sched = 0;

196
	raw_spin_lock_irqsave(&pool_lock, flags);
197
198
199
200
201
	/*
	 * schedule work when the pool is filled and the cache is
	 * initialized:
	 */
	if (obj_pool_free > ODEBUG_POOL_SIZE && obj_cache)
202
		sched = keventd_up();
203
204
205
	hlist_add_head(&obj->node, &obj_pool);
	obj_pool_free++;
	obj_pool_used--;
206
	raw_spin_unlock_irqrestore(&pool_lock, flags);
207
208
	if (sched)
		schedule_work(&debug_obj_work);
209
210
211
212
213
214
215
216
217
}

/*
 * We run out of memory. That means we probably have tons of objects
 * allocated.
 */
static void debug_objects_oom(void)
{
	struct debug_bucket *db = obj_hash;
218
	struct hlist_node *tmp;
219
	HLIST_HEAD(freelist);
220
221
222
223
	struct debug_obj *obj;
	unsigned long flags;
	int i;

224
	pr_warn("Out of memory. ODEBUG disabled\n");
225
226

	for (i = 0; i < ODEBUG_HASH_SIZE; i++, db++) {
227
		raw_spin_lock_irqsave(&db->lock, flags);
228
		hlist_move_list(&db->list, &freelist);
229
		raw_spin_unlock_irqrestore(&db->lock, flags);
230
231

		/* Now free them */
232
		hlist_for_each_entry_safe(obj, tmp, &freelist, node) {
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
			hlist_del(&obj->node);
			free_object(obj);
		}
	}
}

/*
 * We use the pfn of the address for the hash. That way we can check
 * for freed objects simply by checking the affected bucket.
 */
static struct debug_bucket *get_bucket(unsigned long addr)
{
	unsigned long hash;

	hash = hash_long((addr >> ODEBUG_CHUNK_SHIFT), ODEBUG_HASH_BITS);
	return &obj_hash[hash];
}

static void debug_print_object(struct debug_obj *obj, char *msg)
{
253
	struct debug_obj_descr *descr = obj->descr;
254
255
	static int limit;

256
257
258
	if (limit < 5 && descr != descr_test) {
		void *hint = descr->debug_hint ?
			descr->debug_hint(obj->object) : NULL;
259
		limit++;
260
		WARN(1, KERN_ERR "ODEBUG: %s %s (active state %u) "
261
				 "object type: %s hint: %pS\n",
262
			msg, obj_states[obj->state], obj->astate,
263
			descr->name, hint);
264
265
266
267
268
269
270
271
	}
	debug_objects_warnings++;
}

/*
 * Try to repair the damage, so we have a better chance to get useful
 * debug output.
 */
272
273
static bool
debug_object_fixup(bool (*fixup)(void *addr, enum debug_obj_state state),
274
275
		   void * addr, enum debug_obj_state state)
{
276
277
278
279
280
	if (fixup && fixup(addr, state)) {
		debug_objects_fixups++;
		return true;
	}
	return false;
281
282
283
284
285
286
287
288
289
290
}

static void debug_object_is_on_stack(void *addr, int onstack)
{
	int is_on_stack;
	static int limit;

	if (limit > 4)
		return;

291
	is_on_stack = object_is_on_stack(addr);
292
293
294
295
296
	if (is_on_stack == onstack)
		return;

	limit++;
	if (is_on_stack)
297
		pr_warn("object is on stack, but not annotated\n");
298
	else
299
		pr_warn("object is not on stack, but annotated\n");
300
301
302
303
304
305
306
307
308
309
310
	WARN_ON(1);
}

static void
__debug_object_init(void *addr, struct debug_obj_descr *descr, int onstack)
{
	enum debug_obj_state state;
	struct debug_bucket *db;
	struct debug_obj *obj;
	unsigned long flags;

311
312
	fill_pool();

313
314
	db = get_bucket((unsigned long) addr);

315
	raw_spin_lock_irqsave(&db->lock, flags);
316
317
318
319
320
321

	obj = lookup_object(addr, db);
	if (!obj) {
		obj = alloc_object(addr, db, descr);
		if (!obj) {
			debug_objects_enabled = 0;
322
			raw_spin_unlock_irqrestore(&db->lock, flags);
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
			debug_objects_oom();
			return;
		}
		debug_object_is_on_stack(addr, onstack);
	}

	switch (obj->state) {
	case ODEBUG_STATE_NONE:
	case ODEBUG_STATE_INIT:
	case ODEBUG_STATE_INACTIVE:
		obj->state = ODEBUG_STATE_INIT;
		break;

	case ODEBUG_STATE_ACTIVE:
		debug_print_object(obj, "init");
		state = obj->state;
339
		raw_spin_unlock_irqrestore(&db->lock, flags);
340
341
342
343
344
345
346
347
348
349
		debug_object_fixup(descr->fixup_init, addr, state);
		return;

	case ODEBUG_STATE_DESTROYED:
		debug_print_object(obj, "init");
		break;
	default:
		break;
	}

350
	raw_spin_unlock_irqrestore(&db->lock, flags);
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
}

/**
 * debug_object_init - debug checks when an object is initialized
 * @addr:	address of the object
 * @descr:	pointer to an object specific debug description structure
 */
void debug_object_init(void *addr, struct debug_obj_descr *descr)
{
	if (!debug_objects_enabled)
		return;

	__debug_object_init(addr, descr, 0);
}

/**
 * debug_object_init_on_stack - debug checks when an object on stack is
 *				initialized
 * @addr:	address of the object
 * @descr:	pointer to an object specific debug description structure
 */
void debug_object_init_on_stack(void *addr, struct debug_obj_descr *descr)
{
	if (!debug_objects_enabled)
		return;

	__debug_object_init(addr, descr, 1);
}

/**
 * debug_object_activate - debug checks when an object is activated
 * @addr:	address of the object
 * @descr:	pointer to an object specific debug description structure
384
 * Returns 0 for success, -EINVAL for check failed.
385
 */
386
int debug_object_activate(void *addr, struct debug_obj_descr *descr)
387
388
389
390
391
{
	enum debug_obj_state state;
	struct debug_bucket *db;
	struct debug_obj *obj;
	unsigned long flags;
392
	int ret;
393
394
395
	struct debug_obj o = { .object = addr,
			       .state = ODEBUG_STATE_NOTAVAILABLE,
			       .descr = descr };
396
397

	if (!debug_objects_enabled)
398
		return 0;
399
400
401

	db = get_bucket((unsigned long) addr);

402
	raw_spin_lock_irqsave(&db->lock, flags);
403
404
405
406
407
408
409

	obj = lookup_object(addr, db);
	if (obj) {
		switch (obj->state) {
		case ODEBUG_STATE_INIT:
		case ODEBUG_STATE_INACTIVE:
			obj->state = ODEBUG_STATE_ACTIVE;
410
			ret = 0;
411
412
413
414
415
			break;

		case ODEBUG_STATE_ACTIVE:
			debug_print_object(obj, "activate");
			state = obj->state;
416
			raw_spin_unlock_irqrestore(&db->lock, flags);
417
418
			ret = debug_object_fixup(descr->fixup_activate, addr, state);
			return ret ? -EINVAL : 0;
419
420
421

		case ODEBUG_STATE_DESTROYED:
			debug_print_object(obj, "activate");
422
			ret = -EINVAL;
423
424
			break;
		default:
425
			ret = 0;
426
427
			break;
		}
428
		raw_spin_unlock_irqrestore(&db->lock, flags);
429
		return ret;
430
431
	}

432
	raw_spin_unlock_irqrestore(&db->lock, flags);
433
434
435
436
437
	/*
	 * This happens when a static object is activated. We
	 * let the type specific code decide whether this is
	 * true or not.
	 */
438
	if (debug_object_fixup(descr->fixup_activate, addr,
439
			   ODEBUG_STATE_NOTAVAILABLE)) {
440
		debug_print_object(&o, "activate");
441
442
443
		return -EINVAL;
	}
	return 0;
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
}

/**
 * debug_object_deactivate - debug checks when an object is deactivated
 * @addr:	address of the object
 * @descr:	pointer to an object specific debug description structure
 */
void debug_object_deactivate(void *addr, struct debug_obj_descr *descr)
{
	struct debug_bucket *db;
	struct debug_obj *obj;
	unsigned long flags;

	if (!debug_objects_enabled)
		return;

	db = get_bucket((unsigned long) addr);

462
	raw_spin_lock_irqsave(&db->lock, flags);
463
464
465
466
467
468
469

	obj = lookup_object(addr, db);
	if (obj) {
		switch (obj->state) {
		case ODEBUG_STATE_INIT:
		case ODEBUG_STATE_INACTIVE:
		case ODEBUG_STATE_ACTIVE:
470
471
472
473
			if (!obj->astate)
				obj->state = ODEBUG_STATE_INACTIVE;
			else
				debug_print_object(obj, "deactivate");
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
			break;

		case ODEBUG_STATE_DESTROYED:
			debug_print_object(obj, "deactivate");
			break;
		default:
			break;
		}
	} else {
		struct debug_obj o = { .object = addr,
				       .state = ODEBUG_STATE_NOTAVAILABLE,
				       .descr = descr };

		debug_print_object(&o, "deactivate");
	}

490
	raw_spin_unlock_irqrestore(&db->lock, flags);
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
}

/**
 * debug_object_destroy - debug checks when an object is destroyed
 * @addr:	address of the object
 * @descr:	pointer to an object specific debug description structure
 */
void debug_object_destroy(void *addr, struct debug_obj_descr *descr)
{
	enum debug_obj_state state;
	struct debug_bucket *db;
	struct debug_obj *obj;
	unsigned long flags;

	if (!debug_objects_enabled)
		return;

	db = get_bucket((unsigned long) addr);

510
	raw_spin_lock_irqsave(&db->lock, flags);
511
512
513
514
515
516
517
518
519
520
521
522
523
524

	obj = lookup_object(addr, db);
	if (!obj)
		goto out_unlock;

	switch (obj->state) {
	case ODEBUG_STATE_NONE:
	case ODEBUG_STATE_INIT:
	case ODEBUG_STATE_INACTIVE:
		obj->state = ODEBUG_STATE_DESTROYED;
		break;
	case ODEBUG_STATE_ACTIVE:
		debug_print_object(obj, "destroy");
		state = obj->state;
525
		raw_spin_unlock_irqrestore(&db->lock, flags);
526
527
528
529
530
531
532
533
534
535
		debug_object_fixup(descr->fixup_destroy, addr, state);
		return;

	case ODEBUG_STATE_DESTROYED:
		debug_print_object(obj, "destroy");
		break;
	default:
		break;
	}
out_unlock:
536
	raw_spin_unlock_irqrestore(&db->lock, flags);
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
}

/**
 * debug_object_free - debug checks when an object is freed
 * @addr:	address of the object
 * @descr:	pointer to an object specific debug description structure
 */
void debug_object_free(void *addr, struct debug_obj_descr *descr)
{
	enum debug_obj_state state;
	struct debug_bucket *db;
	struct debug_obj *obj;
	unsigned long flags;

	if (!debug_objects_enabled)
		return;

	db = get_bucket((unsigned long) addr);

556
	raw_spin_lock_irqsave(&db->lock, flags);
557
558
559
560
561
562
563
564
565

	obj = lookup_object(addr, db);
	if (!obj)
		goto out_unlock;

	switch (obj->state) {
	case ODEBUG_STATE_ACTIVE:
		debug_print_object(obj, "free");
		state = obj->state;
566
		raw_spin_unlock_irqrestore(&db->lock, flags);
567
568
569
570
		debug_object_fixup(descr->fixup_free, addr, state);
		return;
	default:
		hlist_del(&obj->node);
571
		raw_spin_unlock_irqrestore(&db->lock, flags);
572
		free_object(obj);
573
		return;
574
575
	}
out_unlock:
576
	raw_spin_unlock_irqrestore(&db->lock, flags);
577
578
}

579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
/**
 * debug_object_assert_init - debug checks when object should be init-ed
 * @addr:	address of the object
 * @descr:	pointer to an object specific debug description structure
 */
void debug_object_assert_init(void *addr, struct debug_obj_descr *descr)
{
	struct debug_bucket *db;
	struct debug_obj *obj;
	unsigned long flags;

	if (!debug_objects_enabled)
		return;

	db = get_bucket((unsigned long) addr);

	raw_spin_lock_irqsave(&db->lock, flags);

	obj = lookup_object(addr, db);
	if (!obj) {
		struct debug_obj o = { .object = addr,
				       .state = ODEBUG_STATE_NOTAVAILABLE,
				       .descr = descr };

		raw_spin_unlock_irqrestore(&db->lock, flags);
		/*
		 * Maybe the object is static.  Let the type specific
		 * code decide what to do.
		 */
		if (debug_object_fixup(descr->fixup_assert_init, addr,
				       ODEBUG_STATE_NOTAVAILABLE))
			debug_print_object(&o, "assert_init");
		return;
	}

	raw_spin_unlock_irqrestore(&db->lock, flags);
}

617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
/**
 * debug_object_active_state - debug checks object usage state machine
 * @addr:	address of the object
 * @descr:	pointer to an object specific debug description structure
 * @expect:	expected state
 * @next:	state to move to if expected state is found
 */
void
debug_object_active_state(void *addr, struct debug_obj_descr *descr,
			  unsigned int expect, unsigned int next)
{
	struct debug_bucket *db;
	struct debug_obj *obj;
	unsigned long flags;

	if (!debug_objects_enabled)
		return;

	db = get_bucket((unsigned long) addr);

	raw_spin_lock_irqsave(&db->lock, flags);

	obj = lookup_object(addr, db);
	if (obj) {
		switch (obj->state) {
		case ODEBUG_STATE_ACTIVE:
			if (obj->astate == expect)
				obj->astate = next;
			else
				debug_print_object(obj, "active_state");
			break;

		default:
			debug_print_object(obj, "active_state");
			break;
		}
	} else {
		struct debug_obj o = { .object = addr,
				       .state = ODEBUG_STATE_NOTAVAILABLE,
				       .descr = descr };

		debug_print_object(&o, "active_state");
	}

	raw_spin_unlock_irqrestore(&db->lock, flags);
}

664
665
666
667
#ifdef CONFIG_DEBUG_OBJECTS_FREE
static void __debug_check_no_obj_freed(const void *address, unsigned long size)
{
	unsigned long flags, oaddr, saddr, eaddr, paddr, chunks;
668
	struct hlist_node *tmp;
669
	HLIST_HEAD(freelist);
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
	struct debug_obj_descr *descr;
	enum debug_obj_state state;
	struct debug_bucket *db;
	struct debug_obj *obj;
	int cnt;

	saddr = (unsigned long) address;
	eaddr = saddr + size;
	paddr = saddr & ODEBUG_CHUNK_MASK;
	chunks = ((eaddr - paddr) + (ODEBUG_CHUNK_SIZE - 1));
	chunks >>= ODEBUG_CHUNK_SHIFT;

	for (;chunks > 0; chunks--, paddr += ODEBUG_CHUNK_SIZE) {
		db = get_bucket(paddr);

repeat:
		cnt = 0;
687
		raw_spin_lock_irqsave(&db->lock, flags);
688
		hlist_for_each_entry_safe(obj, tmp, &db->list, node) {
689
690
691
692
693
694
695
696
697
698
			cnt++;
			oaddr = (unsigned long) obj->object;
			if (oaddr < saddr || oaddr >= eaddr)
				continue;

			switch (obj->state) {
			case ODEBUG_STATE_ACTIVE:
				debug_print_object(obj, "free");
				descr = obj->descr;
				state = obj->state;
699
				raw_spin_unlock_irqrestore(&db->lock, flags);
700
701
702
703
704
				debug_object_fixup(descr->fixup_free,
						   (void *) oaddr, state);
				goto repeat;
			default:
				hlist_del(&obj->node);
705
				hlist_add_head(&obj->node, &freelist);
706
707
708
				break;
			}
		}
709
		raw_spin_unlock_irqrestore(&db->lock, flags);
710
711

		/* Now free them */
712
		hlist_for_each_entry_safe(obj, tmp, &freelist, node) {
713
714
715
716
			hlist_del(&obj->node);
			free_object(obj);
		}

717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
		if (cnt > debug_objects_maxchain)
			debug_objects_maxchain = cnt;
	}
}

void debug_check_no_obj_freed(const void *address, unsigned long size)
{
	if (debug_objects_enabled)
		__debug_check_no_obj_freed(address, size);
}
#endif

#ifdef CONFIG_DEBUG_FS

static int debug_stats_show(struct seq_file *m, void *v)
{
	seq_printf(m, "max_chain     :%d\n", debug_objects_maxchain);
	seq_printf(m, "warnings      :%d\n", debug_objects_warnings);
	seq_printf(m, "fixups        :%d\n", debug_objects_fixups);
	seq_printf(m, "pool_free     :%d\n", obj_pool_free);
	seq_printf(m, "pool_min_free :%d\n", obj_pool_min_free);
	seq_printf(m, "pool_used     :%d\n", obj_pool_used);
	seq_printf(m, "pool_max_used :%d\n", obj_pool_max_used);
	return 0;
}

static int debug_stats_open(struct inode *inode, struct file *filp)
{
	return single_open(filp, debug_stats_show, NULL);
}

static const struct file_operations debug_stats_fops = {
	.open		= debug_stats_open,
	.read		= seq_read,
	.llseek		= seq_lseek,
	.release	= single_release,
};

static int __init debug_objects_init_debugfs(void)
{
	struct dentry *dbgdir, *dbgstats;

	if (!debug_objects_enabled)
		return 0;

	dbgdir = debugfs_create_dir("debug_objects", NULL);
	if (!dbgdir)
		return -ENOMEM;

	dbgstats = debugfs_create_file("stats", 0444, dbgdir, NULL,
				       &debug_stats_fops);
	if (!dbgstats)
		goto err;

	return 0;

err:
	debugfs_remove(dbgdir);

	return -ENOMEM;
}
__initcall(debug_objects_init_debugfs);

#else
static inline void debug_objects_init_debugfs(void) { }
#endif

#ifdef CONFIG_DEBUG_OBJECTS_SELFTEST

/* Random data structure for the self test */
struct self_test {
	unsigned long	dummy1[6];
	int		static_init;
	unsigned long	dummy2[3];
};

static __initdata struct debug_obj_descr descr_type_test;

/*
 * fixup_init is called when:
 * - an active object is initialized
 */
799
static bool __init fixup_init(void *addr, enum debug_obj_state state)
800
801
802
803
804
805
806
{
	struct self_test *obj = addr;

	switch (state) {
	case ODEBUG_STATE_ACTIVE:
		debug_object_deactivate(obj, &descr_type_test);
		debug_object_init(obj, &descr_type_test);
807
		return true;
808
	default:
809
		return false;
810
811
812
813
814
815
816
817
	}
}

/*
 * fixup_activate is called when:
 * - an active object is activated
 * - an unknown object is activated (might be a statically initialized object)
 */
818
static bool __init fixup_activate(void *addr, enum debug_obj_state state)
819
820
821
822
823
824
825
826
{
	struct self_test *obj = addr;

	switch (state) {
	case ODEBUG_STATE_NOTAVAILABLE:
		if (obj->static_init == 1) {
			debug_object_init(obj, &descr_type_test);
			debug_object_activate(obj, &descr_type_test);
827
			return false;
828
		}
829
		return true;
830
831
832
833

	case ODEBUG_STATE_ACTIVE:
		debug_object_deactivate(obj, &descr_type_test);
		debug_object_activate(obj, &descr_type_test);
834
		return true;
835
836

	default:
837
		return false;
838
839
840
841
842
843
844
	}
}

/*
 * fixup_destroy is called when:
 * - an active object is destroyed
 */
845
static bool __init fixup_destroy(void *addr, enum debug_obj_state state)
846
847
848
849
850
851
852
{
	struct self_test *obj = addr;

	switch (state) {
	case ODEBUG_STATE_ACTIVE:
		debug_object_deactivate(obj, &descr_type_test);
		debug_object_destroy(obj, &descr_type_test);
853
		return true;
854
	default:
855
		return false;
856
857
858
859
860
861
862
	}
}

/*
 * fixup_free is called when:
 * - an active object is freed
 */
863
static bool __init fixup_free(void *addr, enum debug_obj_state state)
864
865
866
867
868
869
870
{
	struct self_test *obj = addr;

	switch (state) {
	case ODEBUG_STATE_ACTIVE:
		debug_object_deactivate(obj, &descr_type_test);
		debug_object_free(obj, &descr_type_test);
871
		return true;
872
	default:
873
		return false;
874
875
876
	}
}

877
static int __init
878
879
880
881
882
883
884
885
886
check_results(void *addr, enum debug_obj_state state, int fixups, int warnings)
{
	struct debug_bucket *db;
	struct debug_obj *obj;
	unsigned long flags;
	int res = -EINVAL;

	db = get_bucket((unsigned long) addr);

887
	raw_spin_lock_irqsave(&db->lock, flags);
888
889
890

	obj = lookup_object(addr, db);
	if (!obj && state != ODEBUG_STATE_NONE) {
Arjan van de Ven's avatar
Arjan van de Ven committed
891
		WARN(1, KERN_ERR "ODEBUG: selftest object not found\n");
892
893
894
		goto out;
	}
	if (obj && obj->state != state) {
Arjan van de Ven's avatar
Arjan van de Ven committed
895
		WARN(1, KERN_ERR "ODEBUG: selftest wrong state: %d != %d\n",
896
897
898
899
		       obj->state, state);
		goto out;
	}
	if (fixups != debug_objects_fixups) {
Arjan van de Ven's avatar
Arjan van de Ven committed
900
		WARN(1, KERN_ERR "ODEBUG: selftest fixups failed %d != %d\n",
901
902
903
904
		       fixups, debug_objects_fixups);
		goto out;
	}
	if (warnings != debug_objects_warnings) {
Arjan van de Ven's avatar
Arjan van de Ven committed
905
		WARN(1, KERN_ERR "ODEBUG: selftest warnings failed %d != %d\n",
906
907
908
909
910
		       warnings, debug_objects_warnings);
		goto out;
	}
	res = 0;
out:
911
	raw_spin_unlock_irqrestore(&db->lock, flags);
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
	if (res)
		debug_objects_enabled = 0;
	return res;
}

static __initdata struct debug_obj_descr descr_type_test = {
	.name			= "selftest",
	.fixup_init		= fixup_init,
	.fixup_activate		= fixup_activate,
	.fixup_destroy		= fixup_destroy,
	.fixup_free		= fixup_free,
};

static __initdata struct self_test obj = { .static_init = 0 };

static void __init debug_objects_selftest(void)
{
	int fixups, oldfixups, warnings, oldwarnings;
	unsigned long flags;

	local_irq_save(flags);

	fixups = oldfixups = debug_objects_fixups;
	warnings = oldwarnings = debug_objects_warnings;
	descr_test = &descr_type_test;

	debug_object_init(&obj, &descr_type_test);
	if (check_results(&obj, ODEBUG_STATE_INIT, fixups, warnings))
		goto out;
	debug_object_activate(&obj, &descr_type_test);
	if (check_results(&obj, ODEBUG_STATE_ACTIVE, fixups, warnings))
		goto out;
	debug_object_activate(&obj, &descr_type_test);
	if (check_results(&obj, ODEBUG_STATE_ACTIVE, ++fixups, ++warnings))
		goto out;
	debug_object_deactivate(&obj, &descr_type_test);
	if (check_results(&obj, ODEBUG_STATE_INACTIVE, fixups, warnings))
		goto out;
	debug_object_destroy(&obj, &descr_type_test);
	if (check_results(&obj, ODEBUG_STATE_DESTROYED, fixups, warnings))
		goto out;
	debug_object_init(&obj, &descr_type_test);
	if (check_results(&obj, ODEBUG_STATE_DESTROYED, fixups, ++warnings))
		goto out;
	debug_object_activate(&obj, &descr_type_test);
	if (check_results(&obj, ODEBUG_STATE_DESTROYED, fixups, ++warnings))
		goto out;
	debug_object_deactivate(&obj, &descr_type_test);
	if (check_results(&obj, ODEBUG_STATE_DESTROYED, fixups, ++warnings))
		goto out;
	debug_object_free(&obj, &descr_type_test);
	if (check_results(&obj, ODEBUG_STATE_NONE, fixups, warnings))
		goto out;

	obj.static_init = 1;
	debug_object_activate(&obj, &descr_type_test);
968
	if (check_results(&obj, ODEBUG_STATE_ACTIVE, fixups, warnings))
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
		goto out;
	debug_object_init(&obj, &descr_type_test);
	if (check_results(&obj, ODEBUG_STATE_INIT, ++fixups, ++warnings))
		goto out;
	debug_object_free(&obj, &descr_type_test);
	if (check_results(&obj, ODEBUG_STATE_NONE, fixups, warnings))
		goto out;

#ifdef CONFIG_DEBUG_OBJECTS_FREE
	debug_object_init(&obj, &descr_type_test);
	if (check_results(&obj, ODEBUG_STATE_INIT, fixups, warnings))
		goto out;
	debug_object_activate(&obj, &descr_type_test);
	if (check_results(&obj, ODEBUG_STATE_ACTIVE, fixups, warnings))
		goto out;
	__debug_check_no_obj_freed(&obj, sizeof(obj));
	if (check_results(&obj, ODEBUG_STATE_NONE, ++fixups, ++warnings))
		goto out;
#endif
988
	pr_info("selftest passed\n");
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010

out:
	debug_objects_fixups = oldfixups;
	debug_objects_warnings = oldwarnings;
	descr_test = NULL;

	local_irq_restore(flags);
}
#else
static inline void debug_objects_selftest(void) { }
#endif

/*
 * Called during early boot to initialize the hash buckets and link
 * the static object pool objects into the poll list. After this call
 * the object tracker is fully operational.
 */
void __init debug_objects_early_init(void)
{
	int i;

	for (i = 0; i < ODEBUG_HASH_SIZE; i++)
1011
		raw_spin_lock_init(&obj_hash[i].lock);
1012
1013
1014
1015
1016

	for (i = 0; i < ODEBUG_POOL_SIZE; i++)
		hlist_add_head(&obj_static_pool[i].node, &obj_pool);
}

1017
1018
1019
/*
 * Convert the statically allocated objects to dynamic ones:
 */
1020
static int __init debug_objects_replace_static_objects(void)
1021
1022
{
	struct debug_bucket *db = obj_hash;
1023
	struct hlist_node *tmp;
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
	struct debug_obj *obj, *new;
	HLIST_HEAD(objects);
	int i, cnt = 0;

	for (i = 0; i < ODEBUG_POOL_SIZE; i++) {
		obj = kmem_cache_zalloc(obj_cache, GFP_KERNEL);
		if (!obj)
			goto free;
		hlist_add_head(&obj->node, &objects);
	}

	/*
	 * When debug_objects_mem_init() is called we know that only
	 * one CPU is up, so disabling interrupts is enough
	 * protection. This avoids the lockdep hell of lock ordering.
	 */
	local_irq_disable();

	/* Remove the statically allocated objects from the pool */
1043
	hlist_for_each_entry_safe(obj, tmp, &obj_pool, node)
1044
1045
1046
1047
1048
1049
1050
1051
		hlist_del(&obj->node);
	/* Move the allocated objects to the pool */
	hlist_move_list(&objects, &obj_pool);

	/* Replace the active object references */
	for (i = 0; i < ODEBUG_HASH_SIZE; i++, db++) {
		hlist_move_list(&db->list, &objects);

1052
		hlist_for_each_entry(obj, &objects, node) {
1053
1054
1055
1056
1057
1058
1059
1060
			new = hlist_entry(obj_pool.first, typeof(*obj), node);
			hlist_del(&new->node);
			/* copy object data */
			*new = *obj;
			hlist_add_head(&new->node, &db->list);
			cnt++;
		}
	}
1061
	local_irq_enable();
1062

1063
1064
	pr_debug("%d of %d active objects replaced\n",
		 cnt, obj_pool_used);
1065
1066
	return 0;
free:
1067
	hlist_for_each_entry_safe(obj, tmp, &objects, node) {
1068
1069
1070
1071
1072
1073
		hlist_del(&obj->node);
		kmem_cache_free(obj_cache, obj);
	}
	return -ENOMEM;
}

1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
/*
 * Called after the kmem_caches are functional to setup a dedicated
 * cache pool, which has the SLAB_DEBUG_OBJECTS flag set. This flag
 * prevents that the debug code is called on kmem_cache_free() for the
 * debug tracker objects to avoid recursive calls.
 */
void __init debug_objects_mem_init(void)
{
	if (!debug_objects_enabled)
		return;

	obj_cache = kmem_cache_create("debug_objects_cache",
				      sizeof (struct debug_obj), 0,
				      SLAB_DEBUG_OBJECTS, NULL);

1089
	if (!obj_cache || debug_objects_replace_static_objects()) {
1090
		debug_objects_enabled = 0;
1091
1092
		if (obj_cache)
			kmem_cache_destroy(obj_cache);
1093
		pr_warn("out of memory.\n");
1094
	} else
1095
1096
		debug_objects_selftest();
}