xref: /linux-6.15/lib/debugobjects.c (revision 5cd2b459)
13ac7fe5aSThomas Gleixner /*
23ac7fe5aSThomas Gleixner  * Generic infrastructure for lifetime debugging of objects.
33ac7fe5aSThomas Gleixner  *
43ac7fe5aSThomas Gleixner  * Started by Thomas Gleixner
53ac7fe5aSThomas Gleixner  *
63ac7fe5aSThomas Gleixner  * Copyright (C) 2008, Thomas Gleixner <[email protected]>
73ac7fe5aSThomas Gleixner  *
83ac7fe5aSThomas Gleixner  * For licencing details see kernel-base/COPYING
93ac7fe5aSThomas Gleixner  */
103ac7fe5aSThomas Gleixner #include <linux/debugobjects.h>
113ac7fe5aSThomas Gleixner #include <linux/interrupt.h>
123ac7fe5aSThomas Gleixner #include <linux/seq_file.h>
133ac7fe5aSThomas Gleixner #include <linux/debugfs.h>
143ac7fe5aSThomas Gleixner #include <linux/hash.h>
153ac7fe5aSThomas Gleixner 
163ac7fe5aSThomas Gleixner #define ODEBUG_HASH_BITS	14
173ac7fe5aSThomas Gleixner #define ODEBUG_HASH_SIZE	(1 << ODEBUG_HASH_BITS)
183ac7fe5aSThomas Gleixner 
193ac7fe5aSThomas Gleixner #define ODEBUG_POOL_SIZE	512
203ac7fe5aSThomas Gleixner #define ODEBUG_POOL_MIN_LEVEL	256
213ac7fe5aSThomas Gleixner 
223ac7fe5aSThomas Gleixner #define ODEBUG_CHUNK_SHIFT	PAGE_SHIFT
233ac7fe5aSThomas Gleixner #define ODEBUG_CHUNK_SIZE	(1 << ODEBUG_CHUNK_SHIFT)
243ac7fe5aSThomas Gleixner #define ODEBUG_CHUNK_MASK	(~(ODEBUG_CHUNK_SIZE - 1))
253ac7fe5aSThomas Gleixner 
263ac7fe5aSThomas Gleixner struct debug_bucket {
273ac7fe5aSThomas Gleixner 	struct hlist_head	list;
283ac7fe5aSThomas Gleixner 	spinlock_t		lock;
293ac7fe5aSThomas Gleixner };
303ac7fe5aSThomas Gleixner 
313ac7fe5aSThomas Gleixner static struct debug_bucket	obj_hash[ODEBUG_HASH_SIZE];
323ac7fe5aSThomas Gleixner 
333ac7fe5aSThomas Gleixner static struct debug_obj		obj_static_pool[ODEBUG_POOL_SIZE];
343ac7fe5aSThomas Gleixner 
353ac7fe5aSThomas Gleixner static DEFINE_SPINLOCK(pool_lock);
363ac7fe5aSThomas Gleixner 
373ac7fe5aSThomas Gleixner static HLIST_HEAD(obj_pool);
383ac7fe5aSThomas Gleixner 
393ac7fe5aSThomas Gleixner static int			obj_pool_min_free = ODEBUG_POOL_SIZE;
403ac7fe5aSThomas Gleixner static int			obj_pool_free = ODEBUG_POOL_SIZE;
413ac7fe5aSThomas Gleixner static int			obj_pool_used;
423ac7fe5aSThomas Gleixner static int			obj_pool_max_used;
433ac7fe5aSThomas Gleixner static struct kmem_cache	*obj_cache;
443ac7fe5aSThomas Gleixner 
453ac7fe5aSThomas Gleixner static int			debug_objects_maxchain __read_mostly;
463ac7fe5aSThomas Gleixner static int			debug_objects_fixups __read_mostly;
473ac7fe5aSThomas Gleixner static int			debug_objects_warnings __read_mostly;
483ac7fe5aSThomas Gleixner static int			debug_objects_enabled __read_mostly;
493ac7fe5aSThomas Gleixner static struct debug_obj_descr	*descr_test  __read_mostly;
503ac7fe5aSThomas Gleixner 
513ac7fe5aSThomas Gleixner static int __init enable_object_debug(char *str)
523ac7fe5aSThomas Gleixner {
533ac7fe5aSThomas Gleixner 	debug_objects_enabled = 1;
543ac7fe5aSThomas Gleixner 	return 0;
553ac7fe5aSThomas Gleixner }
563ac7fe5aSThomas Gleixner early_param("debug_objects", enable_object_debug);
573ac7fe5aSThomas Gleixner 
583ac7fe5aSThomas Gleixner static const char *obj_states[ODEBUG_STATE_MAX] = {
593ac7fe5aSThomas Gleixner 	[ODEBUG_STATE_NONE]		= "none",
603ac7fe5aSThomas Gleixner 	[ODEBUG_STATE_INIT]		= "initialized",
613ac7fe5aSThomas Gleixner 	[ODEBUG_STATE_INACTIVE]		= "inactive",
623ac7fe5aSThomas Gleixner 	[ODEBUG_STATE_ACTIVE]		= "active",
633ac7fe5aSThomas Gleixner 	[ODEBUG_STATE_DESTROYED]	= "destroyed",
643ac7fe5aSThomas Gleixner 	[ODEBUG_STATE_NOTAVAILABLE]	= "not available",
653ac7fe5aSThomas Gleixner };
663ac7fe5aSThomas Gleixner 
673ac7fe5aSThomas Gleixner static int fill_pool(void)
683ac7fe5aSThomas Gleixner {
693ac7fe5aSThomas Gleixner 	gfp_t gfp = GFP_ATOMIC | __GFP_NORETRY | __GFP_NOWARN;
703ac7fe5aSThomas Gleixner 	struct debug_obj *new;
7150db04ddSVegard Nossum 	unsigned long flags;
723ac7fe5aSThomas Gleixner 
733ac7fe5aSThomas Gleixner 	if (likely(obj_pool_free >= ODEBUG_POOL_MIN_LEVEL))
743ac7fe5aSThomas Gleixner 		return obj_pool_free;
753ac7fe5aSThomas Gleixner 
763ac7fe5aSThomas Gleixner 	if (unlikely(!obj_cache))
773ac7fe5aSThomas Gleixner 		return obj_pool_free;
783ac7fe5aSThomas Gleixner 
793ac7fe5aSThomas Gleixner 	while (obj_pool_free < ODEBUG_POOL_MIN_LEVEL) {
803ac7fe5aSThomas Gleixner 
813ac7fe5aSThomas Gleixner 		new = kmem_cache_zalloc(obj_cache, gfp);
823ac7fe5aSThomas Gleixner 		if (!new)
833ac7fe5aSThomas Gleixner 			return obj_pool_free;
843ac7fe5aSThomas Gleixner 
8550db04ddSVegard Nossum 		spin_lock_irqsave(&pool_lock, flags);
863ac7fe5aSThomas Gleixner 		hlist_add_head(&new->node, &obj_pool);
873ac7fe5aSThomas Gleixner 		obj_pool_free++;
8850db04ddSVegard Nossum 		spin_unlock_irqrestore(&pool_lock, flags);
893ac7fe5aSThomas Gleixner 	}
903ac7fe5aSThomas Gleixner 	return obj_pool_free;
913ac7fe5aSThomas Gleixner }
923ac7fe5aSThomas Gleixner 
933ac7fe5aSThomas Gleixner /*
943ac7fe5aSThomas Gleixner  * Lookup an object in the hash bucket.
953ac7fe5aSThomas Gleixner  */
963ac7fe5aSThomas Gleixner static struct debug_obj *lookup_object(void *addr, struct debug_bucket *b)
973ac7fe5aSThomas Gleixner {
983ac7fe5aSThomas Gleixner 	struct hlist_node *node;
993ac7fe5aSThomas Gleixner 	struct debug_obj *obj;
1003ac7fe5aSThomas Gleixner 	int cnt = 0;
1013ac7fe5aSThomas Gleixner 
1023ac7fe5aSThomas Gleixner 	hlist_for_each_entry(obj, node, &b->list, node) {
1033ac7fe5aSThomas Gleixner 		cnt++;
1043ac7fe5aSThomas Gleixner 		if (obj->object == addr)
1053ac7fe5aSThomas Gleixner 			return obj;
1063ac7fe5aSThomas Gleixner 	}
1073ac7fe5aSThomas Gleixner 	if (cnt > debug_objects_maxchain)
1083ac7fe5aSThomas Gleixner 		debug_objects_maxchain = cnt;
1093ac7fe5aSThomas Gleixner 
1103ac7fe5aSThomas Gleixner 	return NULL;
1113ac7fe5aSThomas Gleixner }
1123ac7fe5aSThomas Gleixner 
1133ac7fe5aSThomas Gleixner /*
11450db04ddSVegard Nossum  * Allocate a new object. If the pool is empty, switch off the debugger.
1153ac7fe5aSThomas Gleixner  */
1163ac7fe5aSThomas Gleixner static struct debug_obj *
1173ac7fe5aSThomas Gleixner alloc_object(void *addr, struct debug_bucket *b, struct debug_obj_descr *descr)
1183ac7fe5aSThomas Gleixner {
1193ac7fe5aSThomas Gleixner 	struct debug_obj *obj = NULL;
1203ac7fe5aSThomas Gleixner 
1213ac7fe5aSThomas Gleixner 	spin_lock(&pool_lock);
1223ac7fe5aSThomas Gleixner 	if (obj_pool.first) {
1233ac7fe5aSThomas Gleixner 		obj	    = hlist_entry(obj_pool.first, typeof(*obj), node);
1243ac7fe5aSThomas Gleixner 
1253ac7fe5aSThomas Gleixner 		obj->object = addr;
1263ac7fe5aSThomas Gleixner 		obj->descr  = descr;
1273ac7fe5aSThomas Gleixner 		obj->state  = ODEBUG_STATE_NONE;
1283ac7fe5aSThomas Gleixner 		hlist_del(&obj->node);
1293ac7fe5aSThomas Gleixner 
1303ac7fe5aSThomas Gleixner 		hlist_add_head(&obj->node, &b->list);
1313ac7fe5aSThomas Gleixner 
1323ac7fe5aSThomas Gleixner 		obj_pool_used++;
1333ac7fe5aSThomas Gleixner 		if (obj_pool_used > obj_pool_max_used)
1343ac7fe5aSThomas Gleixner 			obj_pool_max_used = obj_pool_used;
1353ac7fe5aSThomas Gleixner 
1363ac7fe5aSThomas Gleixner 		obj_pool_free--;
1373ac7fe5aSThomas Gleixner 		if (obj_pool_free < obj_pool_min_free)
1383ac7fe5aSThomas Gleixner 			obj_pool_min_free = obj_pool_free;
1393ac7fe5aSThomas Gleixner 	}
1403ac7fe5aSThomas Gleixner 	spin_unlock(&pool_lock);
1413ac7fe5aSThomas Gleixner 
1423ac7fe5aSThomas Gleixner 	return obj;
1433ac7fe5aSThomas Gleixner }
1443ac7fe5aSThomas Gleixner 
1453ac7fe5aSThomas Gleixner /*
1463ac7fe5aSThomas Gleixner  * Put the object back into the pool or give it back to kmem_cache:
1473ac7fe5aSThomas Gleixner  */
1483ac7fe5aSThomas Gleixner static void free_object(struct debug_obj *obj)
1493ac7fe5aSThomas Gleixner {
1503ac7fe5aSThomas Gleixner 	unsigned long idx = (unsigned long)(obj - obj_static_pool);
1513ac7fe5aSThomas Gleixner 
1523ac7fe5aSThomas Gleixner 	if (obj_pool_free < ODEBUG_POOL_SIZE || idx < ODEBUG_POOL_SIZE) {
1533ac7fe5aSThomas Gleixner 		spin_lock(&pool_lock);
1543ac7fe5aSThomas Gleixner 		hlist_add_head(&obj->node, &obj_pool);
1553ac7fe5aSThomas Gleixner 		obj_pool_free++;
1563ac7fe5aSThomas Gleixner 		obj_pool_used--;
1573ac7fe5aSThomas Gleixner 		spin_unlock(&pool_lock);
1583ac7fe5aSThomas Gleixner 	} else {
1593ac7fe5aSThomas Gleixner 		spin_lock(&pool_lock);
1603ac7fe5aSThomas Gleixner 		obj_pool_used--;
1613ac7fe5aSThomas Gleixner 		spin_unlock(&pool_lock);
1623ac7fe5aSThomas Gleixner 		kmem_cache_free(obj_cache, obj);
1633ac7fe5aSThomas Gleixner 	}
1643ac7fe5aSThomas Gleixner }
1653ac7fe5aSThomas Gleixner 
1663ac7fe5aSThomas Gleixner /*
1673ac7fe5aSThomas Gleixner  * We run out of memory. That means we probably have tons of objects
1683ac7fe5aSThomas Gleixner  * allocated.
1693ac7fe5aSThomas Gleixner  */
1703ac7fe5aSThomas Gleixner static void debug_objects_oom(void)
1713ac7fe5aSThomas Gleixner {
1723ac7fe5aSThomas Gleixner 	struct debug_bucket *db = obj_hash;
1733ac7fe5aSThomas Gleixner 	struct hlist_node *node, *tmp;
1743ac7fe5aSThomas Gleixner 	struct debug_obj *obj;
1753ac7fe5aSThomas Gleixner 	unsigned long flags;
1763ac7fe5aSThomas Gleixner 	int i;
1773ac7fe5aSThomas Gleixner 
1783ac7fe5aSThomas Gleixner 	printk(KERN_WARNING "ODEBUG: Out of memory. ODEBUG disabled\n");
1793ac7fe5aSThomas Gleixner 
1803ac7fe5aSThomas Gleixner 	for (i = 0; i < ODEBUG_HASH_SIZE; i++, db++) {
1813ac7fe5aSThomas Gleixner 		spin_lock_irqsave(&db->lock, flags);
1823ac7fe5aSThomas Gleixner 		hlist_for_each_entry_safe(obj, node, tmp, &db->list, node) {
1833ac7fe5aSThomas Gleixner 			hlist_del(&obj->node);
1843ac7fe5aSThomas Gleixner 			free_object(obj);
1853ac7fe5aSThomas Gleixner 		}
1863ac7fe5aSThomas Gleixner 		spin_unlock_irqrestore(&db->lock, flags);
1873ac7fe5aSThomas Gleixner 	}
1883ac7fe5aSThomas Gleixner }
1893ac7fe5aSThomas Gleixner 
1903ac7fe5aSThomas Gleixner /*
1913ac7fe5aSThomas Gleixner  * We use the pfn of the address for the hash. That way we can check
1923ac7fe5aSThomas Gleixner  * for freed objects simply by checking the affected bucket.
1933ac7fe5aSThomas Gleixner  */
1943ac7fe5aSThomas Gleixner static struct debug_bucket *get_bucket(unsigned long addr)
1953ac7fe5aSThomas Gleixner {
1963ac7fe5aSThomas Gleixner 	unsigned long hash;
1973ac7fe5aSThomas Gleixner 
1983ac7fe5aSThomas Gleixner 	hash = hash_long((addr >> ODEBUG_CHUNK_SHIFT), ODEBUG_HASH_BITS);
1993ac7fe5aSThomas Gleixner 	return &obj_hash[hash];
2003ac7fe5aSThomas Gleixner }
2013ac7fe5aSThomas Gleixner 
2023ac7fe5aSThomas Gleixner static void debug_print_object(struct debug_obj *obj, char *msg)
2033ac7fe5aSThomas Gleixner {
2043ac7fe5aSThomas Gleixner 	static int limit;
2053ac7fe5aSThomas Gleixner 
2063ac7fe5aSThomas Gleixner 	if (limit < 5 && obj->descr != descr_test) {
2073ac7fe5aSThomas Gleixner 		limit++;
208*5cd2b459SArjan van de Ven 		WARN(1, KERN_ERR "ODEBUG: %s %s object type: %s\n", msg,
2093ac7fe5aSThomas Gleixner 		       obj_states[obj->state], obj->descr->name);
2103ac7fe5aSThomas Gleixner 	}
2113ac7fe5aSThomas Gleixner 	debug_objects_warnings++;
2123ac7fe5aSThomas Gleixner }
2133ac7fe5aSThomas Gleixner 
2143ac7fe5aSThomas Gleixner /*
2153ac7fe5aSThomas Gleixner  * Try to repair the damage, so we have a better chance to get useful
2163ac7fe5aSThomas Gleixner  * debug output.
2173ac7fe5aSThomas Gleixner  */
2183ac7fe5aSThomas Gleixner static void
2193ac7fe5aSThomas Gleixner debug_object_fixup(int (*fixup)(void *addr, enum debug_obj_state state),
2203ac7fe5aSThomas Gleixner 		   void * addr, enum debug_obj_state state)
2213ac7fe5aSThomas Gleixner {
2223ac7fe5aSThomas Gleixner 	if (fixup)
2233ac7fe5aSThomas Gleixner 		debug_objects_fixups += fixup(addr, state);
2243ac7fe5aSThomas Gleixner }
2253ac7fe5aSThomas Gleixner 
2263ac7fe5aSThomas Gleixner static void debug_object_is_on_stack(void *addr, int onstack)
2273ac7fe5aSThomas Gleixner {
2283ac7fe5aSThomas Gleixner 	int is_on_stack;
2293ac7fe5aSThomas Gleixner 	static int limit;
2303ac7fe5aSThomas Gleixner 
2313ac7fe5aSThomas Gleixner 	if (limit > 4)
2323ac7fe5aSThomas Gleixner 		return;
2333ac7fe5aSThomas Gleixner 
2348b05c7e6SFUJITA Tomonori 	is_on_stack = object_is_on_stack(addr);
2353ac7fe5aSThomas Gleixner 	if (is_on_stack == onstack)
2363ac7fe5aSThomas Gleixner 		return;
2373ac7fe5aSThomas Gleixner 
2383ac7fe5aSThomas Gleixner 	limit++;
2393ac7fe5aSThomas Gleixner 	if (is_on_stack)
2403ac7fe5aSThomas Gleixner 		printk(KERN_WARNING
2413ac7fe5aSThomas Gleixner 		       "ODEBUG: object is on stack, but not annotated\n");
2423ac7fe5aSThomas Gleixner 	else
2433ac7fe5aSThomas Gleixner 		printk(KERN_WARNING
2443ac7fe5aSThomas Gleixner 		       "ODEBUG: object is not on stack, but annotated\n");
2453ac7fe5aSThomas Gleixner 	WARN_ON(1);
2463ac7fe5aSThomas Gleixner }
2473ac7fe5aSThomas Gleixner 
2483ac7fe5aSThomas Gleixner static void
2493ac7fe5aSThomas Gleixner __debug_object_init(void *addr, struct debug_obj_descr *descr, int onstack)
2503ac7fe5aSThomas Gleixner {
2513ac7fe5aSThomas Gleixner 	enum debug_obj_state state;
2523ac7fe5aSThomas Gleixner 	struct debug_bucket *db;
2533ac7fe5aSThomas Gleixner 	struct debug_obj *obj;
2543ac7fe5aSThomas Gleixner 	unsigned long flags;
2553ac7fe5aSThomas Gleixner 
25650db04ddSVegard Nossum 	fill_pool();
25750db04ddSVegard Nossum 
2583ac7fe5aSThomas Gleixner 	db = get_bucket((unsigned long) addr);
2593ac7fe5aSThomas Gleixner 
2603ac7fe5aSThomas Gleixner 	spin_lock_irqsave(&db->lock, flags);
2613ac7fe5aSThomas Gleixner 
2623ac7fe5aSThomas Gleixner 	obj = lookup_object(addr, db);
2633ac7fe5aSThomas Gleixner 	if (!obj) {
2643ac7fe5aSThomas Gleixner 		obj = alloc_object(addr, db, descr);
2653ac7fe5aSThomas Gleixner 		if (!obj) {
2663ac7fe5aSThomas Gleixner 			debug_objects_enabled = 0;
2673ac7fe5aSThomas Gleixner 			spin_unlock_irqrestore(&db->lock, flags);
2683ac7fe5aSThomas Gleixner 			debug_objects_oom();
2693ac7fe5aSThomas Gleixner 			return;
2703ac7fe5aSThomas Gleixner 		}
2713ac7fe5aSThomas Gleixner 		debug_object_is_on_stack(addr, onstack);
2723ac7fe5aSThomas Gleixner 	}
2733ac7fe5aSThomas Gleixner 
2743ac7fe5aSThomas Gleixner 	switch (obj->state) {
2753ac7fe5aSThomas Gleixner 	case ODEBUG_STATE_NONE:
2763ac7fe5aSThomas Gleixner 	case ODEBUG_STATE_INIT:
2773ac7fe5aSThomas Gleixner 	case ODEBUG_STATE_INACTIVE:
2783ac7fe5aSThomas Gleixner 		obj->state = ODEBUG_STATE_INIT;
2793ac7fe5aSThomas Gleixner 		break;
2803ac7fe5aSThomas Gleixner 
2813ac7fe5aSThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
2823ac7fe5aSThomas Gleixner 		debug_print_object(obj, "init");
2833ac7fe5aSThomas Gleixner 		state = obj->state;
2843ac7fe5aSThomas Gleixner 		spin_unlock_irqrestore(&db->lock, flags);
2853ac7fe5aSThomas Gleixner 		debug_object_fixup(descr->fixup_init, addr, state);
2863ac7fe5aSThomas Gleixner 		return;
2873ac7fe5aSThomas Gleixner 
2883ac7fe5aSThomas Gleixner 	case ODEBUG_STATE_DESTROYED:
2893ac7fe5aSThomas Gleixner 		debug_print_object(obj, "init");
2903ac7fe5aSThomas Gleixner 		break;
2913ac7fe5aSThomas Gleixner 	default:
2923ac7fe5aSThomas Gleixner 		break;
2933ac7fe5aSThomas Gleixner 	}
2943ac7fe5aSThomas Gleixner 
2953ac7fe5aSThomas Gleixner 	spin_unlock_irqrestore(&db->lock, flags);
2963ac7fe5aSThomas Gleixner }
2973ac7fe5aSThomas Gleixner 
2983ac7fe5aSThomas Gleixner /**
2993ac7fe5aSThomas Gleixner  * debug_object_init - debug checks when an object is initialized
3003ac7fe5aSThomas Gleixner  * @addr:	address of the object
3013ac7fe5aSThomas Gleixner  * @descr:	pointer to an object specific debug description structure
3023ac7fe5aSThomas Gleixner  */
3033ac7fe5aSThomas Gleixner void debug_object_init(void *addr, struct debug_obj_descr *descr)
3043ac7fe5aSThomas Gleixner {
3053ac7fe5aSThomas Gleixner 	if (!debug_objects_enabled)
3063ac7fe5aSThomas Gleixner 		return;
3073ac7fe5aSThomas Gleixner 
3083ac7fe5aSThomas Gleixner 	__debug_object_init(addr, descr, 0);
3093ac7fe5aSThomas Gleixner }
3103ac7fe5aSThomas Gleixner 
3113ac7fe5aSThomas Gleixner /**
3123ac7fe5aSThomas Gleixner  * debug_object_init_on_stack - debug checks when an object on stack is
3133ac7fe5aSThomas Gleixner  *				initialized
3143ac7fe5aSThomas Gleixner  * @addr:	address of the object
3153ac7fe5aSThomas Gleixner  * @descr:	pointer to an object specific debug description structure
3163ac7fe5aSThomas Gleixner  */
3173ac7fe5aSThomas Gleixner void debug_object_init_on_stack(void *addr, struct debug_obj_descr *descr)
3183ac7fe5aSThomas Gleixner {
3193ac7fe5aSThomas Gleixner 	if (!debug_objects_enabled)
3203ac7fe5aSThomas Gleixner 		return;
3213ac7fe5aSThomas Gleixner 
3223ac7fe5aSThomas Gleixner 	__debug_object_init(addr, descr, 1);
3233ac7fe5aSThomas Gleixner }
3243ac7fe5aSThomas Gleixner 
3253ac7fe5aSThomas Gleixner /**
3263ac7fe5aSThomas Gleixner  * debug_object_activate - debug checks when an object is activated
3273ac7fe5aSThomas Gleixner  * @addr:	address of the object
3283ac7fe5aSThomas Gleixner  * @descr:	pointer to an object specific debug description structure
3293ac7fe5aSThomas Gleixner  */
3303ac7fe5aSThomas Gleixner void debug_object_activate(void *addr, struct debug_obj_descr *descr)
3313ac7fe5aSThomas Gleixner {
3323ac7fe5aSThomas Gleixner 	enum debug_obj_state state;
3333ac7fe5aSThomas Gleixner 	struct debug_bucket *db;
3343ac7fe5aSThomas Gleixner 	struct debug_obj *obj;
3353ac7fe5aSThomas Gleixner 	unsigned long flags;
3363ac7fe5aSThomas Gleixner 
3373ac7fe5aSThomas Gleixner 	if (!debug_objects_enabled)
3383ac7fe5aSThomas Gleixner 		return;
3393ac7fe5aSThomas Gleixner 
3403ac7fe5aSThomas Gleixner 	db = get_bucket((unsigned long) addr);
3413ac7fe5aSThomas Gleixner 
3423ac7fe5aSThomas Gleixner 	spin_lock_irqsave(&db->lock, flags);
3433ac7fe5aSThomas Gleixner 
3443ac7fe5aSThomas Gleixner 	obj = lookup_object(addr, db);
3453ac7fe5aSThomas Gleixner 	if (obj) {
3463ac7fe5aSThomas Gleixner 		switch (obj->state) {
3473ac7fe5aSThomas Gleixner 		case ODEBUG_STATE_INIT:
3483ac7fe5aSThomas Gleixner 		case ODEBUG_STATE_INACTIVE:
3493ac7fe5aSThomas Gleixner 			obj->state = ODEBUG_STATE_ACTIVE;
3503ac7fe5aSThomas Gleixner 			break;
3513ac7fe5aSThomas Gleixner 
3523ac7fe5aSThomas Gleixner 		case ODEBUG_STATE_ACTIVE:
3533ac7fe5aSThomas Gleixner 			debug_print_object(obj, "activate");
3543ac7fe5aSThomas Gleixner 			state = obj->state;
3553ac7fe5aSThomas Gleixner 			spin_unlock_irqrestore(&db->lock, flags);
3563ac7fe5aSThomas Gleixner 			debug_object_fixup(descr->fixup_activate, addr, state);
3573ac7fe5aSThomas Gleixner 			return;
3583ac7fe5aSThomas Gleixner 
3593ac7fe5aSThomas Gleixner 		case ODEBUG_STATE_DESTROYED:
3603ac7fe5aSThomas Gleixner 			debug_print_object(obj, "activate");
3613ac7fe5aSThomas Gleixner 			break;
3623ac7fe5aSThomas Gleixner 		default:
3633ac7fe5aSThomas Gleixner 			break;
3643ac7fe5aSThomas Gleixner 		}
3653ac7fe5aSThomas Gleixner 		spin_unlock_irqrestore(&db->lock, flags);
3663ac7fe5aSThomas Gleixner 		return;
3673ac7fe5aSThomas Gleixner 	}
3683ac7fe5aSThomas Gleixner 
3693ac7fe5aSThomas Gleixner 	spin_unlock_irqrestore(&db->lock, flags);
3703ac7fe5aSThomas Gleixner 	/*
3713ac7fe5aSThomas Gleixner 	 * This happens when a static object is activated. We
3723ac7fe5aSThomas Gleixner 	 * let the type specific code decide whether this is
3733ac7fe5aSThomas Gleixner 	 * true or not.
3743ac7fe5aSThomas Gleixner 	 */
3753ac7fe5aSThomas Gleixner 	debug_object_fixup(descr->fixup_activate, addr,
3763ac7fe5aSThomas Gleixner 			   ODEBUG_STATE_NOTAVAILABLE);
3773ac7fe5aSThomas Gleixner }
3783ac7fe5aSThomas Gleixner 
3793ac7fe5aSThomas Gleixner /**
3803ac7fe5aSThomas Gleixner  * debug_object_deactivate - debug checks when an object is deactivated
3813ac7fe5aSThomas Gleixner  * @addr:	address of the object
3823ac7fe5aSThomas Gleixner  * @descr:	pointer to an object specific debug description structure
3833ac7fe5aSThomas Gleixner  */
3843ac7fe5aSThomas Gleixner void debug_object_deactivate(void *addr, struct debug_obj_descr *descr)
3853ac7fe5aSThomas Gleixner {
3863ac7fe5aSThomas Gleixner 	struct debug_bucket *db;
3873ac7fe5aSThomas Gleixner 	struct debug_obj *obj;
3883ac7fe5aSThomas Gleixner 	unsigned long flags;
3893ac7fe5aSThomas Gleixner 
3903ac7fe5aSThomas Gleixner 	if (!debug_objects_enabled)
3913ac7fe5aSThomas Gleixner 		return;
3923ac7fe5aSThomas Gleixner 
3933ac7fe5aSThomas Gleixner 	db = get_bucket((unsigned long) addr);
3943ac7fe5aSThomas Gleixner 
3953ac7fe5aSThomas Gleixner 	spin_lock_irqsave(&db->lock, flags);
3963ac7fe5aSThomas Gleixner 
3973ac7fe5aSThomas Gleixner 	obj = lookup_object(addr, db);
3983ac7fe5aSThomas Gleixner 	if (obj) {
3993ac7fe5aSThomas Gleixner 		switch (obj->state) {
4003ac7fe5aSThomas Gleixner 		case ODEBUG_STATE_INIT:
4013ac7fe5aSThomas Gleixner 		case ODEBUG_STATE_INACTIVE:
4023ac7fe5aSThomas Gleixner 		case ODEBUG_STATE_ACTIVE:
4033ac7fe5aSThomas Gleixner 			obj->state = ODEBUG_STATE_INACTIVE;
4043ac7fe5aSThomas Gleixner 			break;
4053ac7fe5aSThomas Gleixner 
4063ac7fe5aSThomas Gleixner 		case ODEBUG_STATE_DESTROYED:
4073ac7fe5aSThomas Gleixner 			debug_print_object(obj, "deactivate");
4083ac7fe5aSThomas Gleixner 			break;
4093ac7fe5aSThomas Gleixner 		default:
4103ac7fe5aSThomas Gleixner 			break;
4113ac7fe5aSThomas Gleixner 		}
4123ac7fe5aSThomas Gleixner 	} else {
4133ac7fe5aSThomas Gleixner 		struct debug_obj o = { .object = addr,
4143ac7fe5aSThomas Gleixner 				       .state = ODEBUG_STATE_NOTAVAILABLE,
4153ac7fe5aSThomas Gleixner 				       .descr = descr };
4163ac7fe5aSThomas Gleixner 
4173ac7fe5aSThomas Gleixner 		debug_print_object(&o, "deactivate");
4183ac7fe5aSThomas Gleixner 	}
4193ac7fe5aSThomas Gleixner 
4203ac7fe5aSThomas Gleixner 	spin_unlock_irqrestore(&db->lock, flags);
4213ac7fe5aSThomas Gleixner }
4223ac7fe5aSThomas Gleixner 
4233ac7fe5aSThomas Gleixner /**
4243ac7fe5aSThomas Gleixner  * debug_object_destroy - debug checks when an object is destroyed
4253ac7fe5aSThomas Gleixner  * @addr:	address of the object
4263ac7fe5aSThomas Gleixner  * @descr:	pointer to an object specific debug description structure
4273ac7fe5aSThomas Gleixner  */
4283ac7fe5aSThomas Gleixner void debug_object_destroy(void *addr, struct debug_obj_descr *descr)
4293ac7fe5aSThomas Gleixner {
4303ac7fe5aSThomas Gleixner 	enum debug_obj_state state;
4313ac7fe5aSThomas Gleixner 	struct debug_bucket *db;
4323ac7fe5aSThomas Gleixner 	struct debug_obj *obj;
4333ac7fe5aSThomas Gleixner 	unsigned long flags;
4343ac7fe5aSThomas Gleixner 
4353ac7fe5aSThomas Gleixner 	if (!debug_objects_enabled)
4363ac7fe5aSThomas Gleixner 		return;
4373ac7fe5aSThomas Gleixner 
4383ac7fe5aSThomas Gleixner 	db = get_bucket((unsigned long) addr);
4393ac7fe5aSThomas Gleixner 
4403ac7fe5aSThomas Gleixner 	spin_lock_irqsave(&db->lock, flags);
4413ac7fe5aSThomas Gleixner 
4423ac7fe5aSThomas Gleixner 	obj = lookup_object(addr, db);
4433ac7fe5aSThomas Gleixner 	if (!obj)
4443ac7fe5aSThomas Gleixner 		goto out_unlock;
4453ac7fe5aSThomas Gleixner 
4463ac7fe5aSThomas Gleixner 	switch (obj->state) {
4473ac7fe5aSThomas Gleixner 	case ODEBUG_STATE_NONE:
4483ac7fe5aSThomas Gleixner 	case ODEBUG_STATE_INIT:
4493ac7fe5aSThomas Gleixner 	case ODEBUG_STATE_INACTIVE:
4503ac7fe5aSThomas Gleixner 		obj->state = ODEBUG_STATE_DESTROYED;
4513ac7fe5aSThomas Gleixner 		break;
4523ac7fe5aSThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
4533ac7fe5aSThomas Gleixner 		debug_print_object(obj, "destroy");
4543ac7fe5aSThomas Gleixner 		state = obj->state;
4553ac7fe5aSThomas Gleixner 		spin_unlock_irqrestore(&db->lock, flags);
4563ac7fe5aSThomas Gleixner 		debug_object_fixup(descr->fixup_destroy, addr, state);
4573ac7fe5aSThomas Gleixner 		return;
4583ac7fe5aSThomas Gleixner 
4593ac7fe5aSThomas Gleixner 	case ODEBUG_STATE_DESTROYED:
4603ac7fe5aSThomas Gleixner 		debug_print_object(obj, "destroy");
4613ac7fe5aSThomas Gleixner 		break;
4623ac7fe5aSThomas Gleixner 	default:
4633ac7fe5aSThomas Gleixner 		break;
4643ac7fe5aSThomas Gleixner 	}
4653ac7fe5aSThomas Gleixner out_unlock:
4663ac7fe5aSThomas Gleixner 	spin_unlock_irqrestore(&db->lock, flags);
4673ac7fe5aSThomas Gleixner }
4683ac7fe5aSThomas Gleixner 
4693ac7fe5aSThomas Gleixner /**
4703ac7fe5aSThomas Gleixner  * debug_object_free - debug checks when an object is freed
4713ac7fe5aSThomas Gleixner  * @addr:	address of the object
4723ac7fe5aSThomas Gleixner  * @descr:	pointer to an object specific debug description structure
4733ac7fe5aSThomas Gleixner  */
4743ac7fe5aSThomas Gleixner void debug_object_free(void *addr, struct debug_obj_descr *descr)
4753ac7fe5aSThomas Gleixner {
4763ac7fe5aSThomas Gleixner 	enum debug_obj_state state;
4773ac7fe5aSThomas Gleixner 	struct debug_bucket *db;
4783ac7fe5aSThomas Gleixner 	struct debug_obj *obj;
4793ac7fe5aSThomas Gleixner 	unsigned long flags;
4803ac7fe5aSThomas Gleixner 
4813ac7fe5aSThomas Gleixner 	if (!debug_objects_enabled)
4823ac7fe5aSThomas Gleixner 		return;
4833ac7fe5aSThomas Gleixner 
4843ac7fe5aSThomas Gleixner 	db = get_bucket((unsigned long) addr);
4853ac7fe5aSThomas Gleixner 
4863ac7fe5aSThomas Gleixner 	spin_lock_irqsave(&db->lock, flags);
4873ac7fe5aSThomas Gleixner 
4883ac7fe5aSThomas Gleixner 	obj = lookup_object(addr, db);
4893ac7fe5aSThomas Gleixner 	if (!obj)
4903ac7fe5aSThomas Gleixner 		goto out_unlock;
4913ac7fe5aSThomas Gleixner 
4923ac7fe5aSThomas Gleixner 	switch (obj->state) {
4933ac7fe5aSThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
4943ac7fe5aSThomas Gleixner 		debug_print_object(obj, "free");
4953ac7fe5aSThomas Gleixner 		state = obj->state;
4963ac7fe5aSThomas Gleixner 		spin_unlock_irqrestore(&db->lock, flags);
4973ac7fe5aSThomas Gleixner 		debug_object_fixup(descr->fixup_free, addr, state);
4983ac7fe5aSThomas Gleixner 		return;
4993ac7fe5aSThomas Gleixner 	default:
5003ac7fe5aSThomas Gleixner 		hlist_del(&obj->node);
5013ac7fe5aSThomas Gleixner 		free_object(obj);
5023ac7fe5aSThomas Gleixner 		break;
5033ac7fe5aSThomas Gleixner 	}
5043ac7fe5aSThomas Gleixner out_unlock:
5053ac7fe5aSThomas Gleixner 	spin_unlock_irqrestore(&db->lock, flags);
5063ac7fe5aSThomas Gleixner }
5073ac7fe5aSThomas Gleixner 
5083ac7fe5aSThomas Gleixner #ifdef CONFIG_DEBUG_OBJECTS_FREE
5093ac7fe5aSThomas Gleixner static void __debug_check_no_obj_freed(const void *address, unsigned long size)
5103ac7fe5aSThomas Gleixner {
5113ac7fe5aSThomas Gleixner 	unsigned long flags, oaddr, saddr, eaddr, paddr, chunks;
5123ac7fe5aSThomas Gleixner 	struct hlist_node *node, *tmp;
5133ac7fe5aSThomas Gleixner 	struct debug_obj_descr *descr;
5143ac7fe5aSThomas Gleixner 	enum debug_obj_state state;
5153ac7fe5aSThomas Gleixner 	struct debug_bucket *db;
5163ac7fe5aSThomas Gleixner 	struct debug_obj *obj;
5173ac7fe5aSThomas Gleixner 	int cnt;
5183ac7fe5aSThomas Gleixner 
5193ac7fe5aSThomas Gleixner 	saddr = (unsigned long) address;
5203ac7fe5aSThomas Gleixner 	eaddr = saddr + size;
5213ac7fe5aSThomas Gleixner 	paddr = saddr & ODEBUG_CHUNK_MASK;
5223ac7fe5aSThomas Gleixner 	chunks = ((eaddr - paddr) + (ODEBUG_CHUNK_SIZE - 1));
5233ac7fe5aSThomas Gleixner 	chunks >>= ODEBUG_CHUNK_SHIFT;
5243ac7fe5aSThomas Gleixner 
5253ac7fe5aSThomas Gleixner 	for (;chunks > 0; chunks--, paddr += ODEBUG_CHUNK_SIZE) {
5263ac7fe5aSThomas Gleixner 		db = get_bucket(paddr);
5273ac7fe5aSThomas Gleixner 
5283ac7fe5aSThomas Gleixner repeat:
5293ac7fe5aSThomas Gleixner 		cnt = 0;
5303ac7fe5aSThomas Gleixner 		spin_lock_irqsave(&db->lock, flags);
5313ac7fe5aSThomas Gleixner 		hlist_for_each_entry_safe(obj, node, tmp, &db->list, node) {
5323ac7fe5aSThomas Gleixner 			cnt++;
5333ac7fe5aSThomas Gleixner 			oaddr = (unsigned long) obj->object;
5343ac7fe5aSThomas Gleixner 			if (oaddr < saddr || oaddr >= eaddr)
5353ac7fe5aSThomas Gleixner 				continue;
5363ac7fe5aSThomas Gleixner 
5373ac7fe5aSThomas Gleixner 			switch (obj->state) {
5383ac7fe5aSThomas Gleixner 			case ODEBUG_STATE_ACTIVE:
5393ac7fe5aSThomas Gleixner 				debug_print_object(obj, "free");
5403ac7fe5aSThomas Gleixner 				descr = obj->descr;
5413ac7fe5aSThomas Gleixner 				state = obj->state;
5423ac7fe5aSThomas Gleixner 				spin_unlock_irqrestore(&db->lock, flags);
5433ac7fe5aSThomas Gleixner 				debug_object_fixup(descr->fixup_free,
5443ac7fe5aSThomas Gleixner 						   (void *) oaddr, state);
5453ac7fe5aSThomas Gleixner 				goto repeat;
5463ac7fe5aSThomas Gleixner 			default:
5473ac7fe5aSThomas Gleixner 				hlist_del(&obj->node);
5483ac7fe5aSThomas Gleixner 				free_object(obj);
5493ac7fe5aSThomas Gleixner 				break;
5503ac7fe5aSThomas Gleixner 			}
5513ac7fe5aSThomas Gleixner 		}
5523ac7fe5aSThomas Gleixner 		spin_unlock_irqrestore(&db->lock, flags);
5533ac7fe5aSThomas Gleixner 		if (cnt > debug_objects_maxchain)
5543ac7fe5aSThomas Gleixner 			debug_objects_maxchain = cnt;
5553ac7fe5aSThomas Gleixner 	}
5563ac7fe5aSThomas Gleixner }
5573ac7fe5aSThomas Gleixner 
5583ac7fe5aSThomas Gleixner void debug_check_no_obj_freed(const void *address, unsigned long size)
5593ac7fe5aSThomas Gleixner {
5603ac7fe5aSThomas Gleixner 	if (debug_objects_enabled)
5613ac7fe5aSThomas Gleixner 		__debug_check_no_obj_freed(address, size);
5623ac7fe5aSThomas Gleixner }
5633ac7fe5aSThomas Gleixner #endif
5643ac7fe5aSThomas Gleixner 
5653ac7fe5aSThomas Gleixner #ifdef CONFIG_DEBUG_FS
5663ac7fe5aSThomas Gleixner 
5673ac7fe5aSThomas Gleixner static int debug_stats_show(struct seq_file *m, void *v)
5683ac7fe5aSThomas Gleixner {
5693ac7fe5aSThomas Gleixner 	seq_printf(m, "max_chain     :%d\n", debug_objects_maxchain);
5703ac7fe5aSThomas Gleixner 	seq_printf(m, "warnings      :%d\n", debug_objects_warnings);
5713ac7fe5aSThomas Gleixner 	seq_printf(m, "fixups        :%d\n", debug_objects_fixups);
5723ac7fe5aSThomas Gleixner 	seq_printf(m, "pool_free     :%d\n", obj_pool_free);
5733ac7fe5aSThomas Gleixner 	seq_printf(m, "pool_min_free :%d\n", obj_pool_min_free);
5743ac7fe5aSThomas Gleixner 	seq_printf(m, "pool_used     :%d\n", obj_pool_used);
5753ac7fe5aSThomas Gleixner 	seq_printf(m, "pool_max_used :%d\n", obj_pool_max_used);
5763ac7fe5aSThomas Gleixner 	return 0;
5773ac7fe5aSThomas Gleixner }
5783ac7fe5aSThomas Gleixner 
5793ac7fe5aSThomas Gleixner static int debug_stats_open(struct inode *inode, struct file *filp)
5803ac7fe5aSThomas Gleixner {
5813ac7fe5aSThomas Gleixner 	return single_open(filp, debug_stats_show, NULL);
5823ac7fe5aSThomas Gleixner }
5833ac7fe5aSThomas Gleixner 
5843ac7fe5aSThomas Gleixner static const struct file_operations debug_stats_fops = {
5853ac7fe5aSThomas Gleixner 	.open		= debug_stats_open,
5863ac7fe5aSThomas Gleixner 	.read		= seq_read,
5873ac7fe5aSThomas Gleixner 	.llseek		= seq_lseek,
5883ac7fe5aSThomas Gleixner 	.release	= single_release,
5893ac7fe5aSThomas Gleixner };
5903ac7fe5aSThomas Gleixner 
5913ac7fe5aSThomas Gleixner static int __init debug_objects_init_debugfs(void)
5923ac7fe5aSThomas Gleixner {
5933ac7fe5aSThomas Gleixner 	struct dentry *dbgdir, *dbgstats;
5943ac7fe5aSThomas Gleixner 
5953ac7fe5aSThomas Gleixner 	if (!debug_objects_enabled)
5963ac7fe5aSThomas Gleixner 		return 0;
5973ac7fe5aSThomas Gleixner 
5983ac7fe5aSThomas Gleixner 	dbgdir = debugfs_create_dir("debug_objects", NULL);
5993ac7fe5aSThomas Gleixner 	if (!dbgdir)
6003ac7fe5aSThomas Gleixner 		return -ENOMEM;
6013ac7fe5aSThomas Gleixner 
6023ac7fe5aSThomas Gleixner 	dbgstats = debugfs_create_file("stats", 0444, dbgdir, NULL,
6033ac7fe5aSThomas Gleixner 				       &debug_stats_fops);
6043ac7fe5aSThomas Gleixner 	if (!dbgstats)
6053ac7fe5aSThomas Gleixner 		goto err;
6063ac7fe5aSThomas Gleixner 
6073ac7fe5aSThomas Gleixner 	return 0;
6083ac7fe5aSThomas Gleixner 
6093ac7fe5aSThomas Gleixner err:
6103ac7fe5aSThomas Gleixner 	debugfs_remove(dbgdir);
6113ac7fe5aSThomas Gleixner 
6123ac7fe5aSThomas Gleixner 	return -ENOMEM;
6133ac7fe5aSThomas Gleixner }
6143ac7fe5aSThomas Gleixner __initcall(debug_objects_init_debugfs);
6153ac7fe5aSThomas Gleixner 
6163ac7fe5aSThomas Gleixner #else
6173ac7fe5aSThomas Gleixner static inline void debug_objects_init_debugfs(void) { }
6183ac7fe5aSThomas Gleixner #endif
6193ac7fe5aSThomas Gleixner 
6203ac7fe5aSThomas Gleixner #ifdef CONFIG_DEBUG_OBJECTS_SELFTEST
6213ac7fe5aSThomas Gleixner 
6223ac7fe5aSThomas Gleixner /* Random data structure for the self test */
6233ac7fe5aSThomas Gleixner struct self_test {
6243ac7fe5aSThomas Gleixner 	unsigned long	dummy1[6];
6253ac7fe5aSThomas Gleixner 	int		static_init;
6263ac7fe5aSThomas Gleixner 	unsigned long	dummy2[3];
6273ac7fe5aSThomas Gleixner };
6283ac7fe5aSThomas Gleixner 
6293ac7fe5aSThomas Gleixner static __initdata struct debug_obj_descr descr_type_test;
6303ac7fe5aSThomas Gleixner 
6313ac7fe5aSThomas Gleixner /*
6323ac7fe5aSThomas Gleixner  * fixup_init is called when:
6333ac7fe5aSThomas Gleixner  * - an active object is initialized
6343ac7fe5aSThomas Gleixner  */
6353ac7fe5aSThomas Gleixner static int __init fixup_init(void *addr, enum debug_obj_state state)
6363ac7fe5aSThomas Gleixner {
6373ac7fe5aSThomas Gleixner 	struct self_test *obj = addr;
6383ac7fe5aSThomas Gleixner 
6393ac7fe5aSThomas Gleixner 	switch (state) {
6403ac7fe5aSThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
6413ac7fe5aSThomas Gleixner 		debug_object_deactivate(obj, &descr_type_test);
6423ac7fe5aSThomas Gleixner 		debug_object_init(obj, &descr_type_test);
6433ac7fe5aSThomas Gleixner 		return 1;
6443ac7fe5aSThomas Gleixner 	default:
6453ac7fe5aSThomas Gleixner 		return 0;
6463ac7fe5aSThomas Gleixner 	}
6473ac7fe5aSThomas Gleixner }
6483ac7fe5aSThomas Gleixner 
6493ac7fe5aSThomas Gleixner /*
6503ac7fe5aSThomas Gleixner  * fixup_activate is called when:
6513ac7fe5aSThomas Gleixner  * - an active object is activated
6523ac7fe5aSThomas Gleixner  * - an unknown object is activated (might be a statically initialized object)
6533ac7fe5aSThomas Gleixner  */
6543ac7fe5aSThomas Gleixner static int __init fixup_activate(void *addr, enum debug_obj_state state)
6553ac7fe5aSThomas Gleixner {
6563ac7fe5aSThomas Gleixner 	struct self_test *obj = addr;
6573ac7fe5aSThomas Gleixner 
6583ac7fe5aSThomas Gleixner 	switch (state) {
6593ac7fe5aSThomas Gleixner 	case ODEBUG_STATE_NOTAVAILABLE:
6603ac7fe5aSThomas Gleixner 		if (obj->static_init == 1) {
6613ac7fe5aSThomas Gleixner 			debug_object_init(obj, &descr_type_test);
6623ac7fe5aSThomas Gleixner 			debug_object_activate(obj, &descr_type_test);
6633ac7fe5aSThomas Gleixner 			/*
6643ac7fe5aSThomas Gleixner 			 * Real code should return 0 here ! This is
6653ac7fe5aSThomas Gleixner 			 * not a fixup of some bad behaviour. We
6663ac7fe5aSThomas Gleixner 			 * merily call the debug_init function to keep
6673ac7fe5aSThomas Gleixner 			 * track of the object.
6683ac7fe5aSThomas Gleixner 			 */
6693ac7fe5aSThomas Gleixner 			return 1;
6703ac7fe5aSThomas Gleixner 		} else {
6713ac7fe5aSThomas Gleixner 			/* Real code needs to emit a warning here */
6723ac7fe5aSThomas Gleixner 		}
6733ac7fe5aSThomas Gleixner 		return 0;
6743ac7fe5aSThomas Gleixner 
6753ac7fe5aSThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
6763ac7fe5aSThomas Gleixner 		debug_object_deactivate(obj, &descr_type_test);
6773ac7fe5aSThomas Gleixner 		debug_object_activate(obj, &descr_type_test);
6783ac7fe5aSThomas Gleixner 		return 1;
6793ac7fe5aSThomas Gleixner 
6803ac7fe5aSThomas Gleixner 	default:
6813ac7fe5aSThomas Gleixner 		return 0;
6823ac7fe5aSThomas Gleixner 	}
6833ac7fe5aSThomas Gleixner }
6843ac7fe5aSThomas Gleixner 
6853ac7fe5aSThomas Gleixner /*
6863ac7fe5aSThomas Gleixner  * fixup_destroy is called when:
6873ac7fe5aSThomas Gleixner  * - an active object is destroyed
6883ac7fe5aSThomas Gleixner  */
6893ac7fe5aSThomas Gleixner static int __init fixup_destroy(void *addr, enum debug_obj_state state)
6903ac7fe5aSThomas Gleixner {
6913ac7fe5aSThomas Gleixner 	struct self_test *obj = addr;
6923ac7fe5aSThomas Gleixner 
6933ac7fe5aSThomas Gleixner 	switch (state) {
6943ac7fe5aSThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
6953ac7fe5aSThomas Gleixner 		debug_object_deactivate(obj, &descr_type_test);
6963ac7fe5aSThomas Gleixner 		debug_object_destroy(obj, &descr_type_test);
6973ac7fe5aSThomas Gleixner 		return 1;
6983ac7fe5aSThomas Gleixner 	default:
6993ac7fe5aSThomas Gleixner 		return 0;
7003ac7fe5aSThomas Gleixner 	}
7013ac7fe5aSThomas Gleixner }
7023ac7fe5aSThomas Gleixner 
7033ac7fe5aSThomas Gleixner /*
7043ac7fe5aSThomas Gleixner  * fixup_free is called when:
7053ac7fe5aSThomas Gleixner  * - an active object is freed
7063ac7fe5aSThomas Gleixner  */
7073ac7fe5aSThomas Gleixner static int __init fixup_free(void *addr, enum debug_obj_state state)
7083ac7fe5aSThomas Gleixner {
7093ac7fe5aSThomas Gleixner 	struct self_test *obj = addr;
7103ac7fe5aSThomas Gleixner 
7113ac7fe5aSThomas Gleixner 	switch (state) {
7123ac7fe5aSThomas Gleixner 	case ODEBUG_STATE_ACTIVE:
7133ac7fe5aSThomas Gleixner 		debug_object_deactivate(obj, &descr_type_test);
7143ac7fe5aSThomas Gleixner 		debug_object_free(obj, &descr_type_test);
7153ac7fe5aSThomas Gleixner 		return 1;
7163ac7fe5aSThomas Gleixner 	default:
7173ac7fe5aSThomas Gleixner 		return 0;
7183ac7fe5aSThomas Gleixner 	}
7193ac7fe5aSThomas Gleixner }
7203ac7fe5aSThomas Gleixner 
7213ac7fe5aSThomas Gleixner static int
7223ac7fe5aSThomas Gleixner check_results(void *addr, enum debug_obj_state state, int fixups, int warnings)
7233ac7fe5aSThomas Gleixner {
7243ac7fe5aSThomas Gleixner 	struct debug_bucket *db;
7253ac7fe5aSThomas Gleixner 	struct debug_obj *obj;
7263ac7fe5aSThomas Gleixner 	unsigned long flags;
7273ac7fe5aSThomas Gleixner 	int res = -EINVAL;
7283ac7fe5aSThomas Gleixner 
7293ac7fe5aSThomas Gleixner 	db = get_bucket((unsigned long) addr);
7303ac7fe5aSThomas Gleixner 
7313ac7fe5aSThomas Gleixner 	spin_lock_irqsave(&db->lock, flags);
7323ac7fe5aSThomas Gleixner 
7333ac7fe5aSThomas Gleixner 	obj = lookup_object(addr, db);
7343ac7fe5aSThomas Gleixner 	if (!obj && state != ODEBUG_STATE_NONE) {
735*5cd2b459SArjan van de Ven 		WARN(1, KERN_ERR "ODEBUG: selftest object not found\n");
7363ac7fe5aSThomas Gleixner 		goto out;
7373ac7fe5aSThomas Gleixner 	}
7383ac7fe5aSThomas Gleixner 	if (obj && obj->state != state) {
739*5cd2b459SArjan van de Ven 		WARN(1, KERN_ERR "ODEBUG: selftest wrong state: %d != %d\n",
7403ac7fe5aSThomas Gleixner 		       obj->state, state);
7413ac7fe5aSThomas Gleixner 		goto out;
7423ac7fe5aSThomas Gleixner 	}
7433ac7fe5aSThomas Gleixner 	if (fixups != debug_objects_fixups) {
744*5cd2b459SArjan van de Ven 		WARN(1, KERN_ERR "ODEBUG: selftest fixups failed %d != %d\n",
7453ac7fe5aSThomas Gleixner 		       fixups, debug_objects_fixups);
7463ac7fe5aSThomas Gleixner 		goto out;
7473ac7fe5aSThomas Gleixner 	}
7483ac7fe5aSThomas Gleixner 	if (warnings != debug_objects_warnings) {
749*5cd2b459SArjan van de Ven 		WARN(1, KERN_ERR "ODEBUG: selftest warnings failed %d != %d\n",
7503ac7fe5aSThomas Gleixner 		       warnings, debug_objects_warnings);
7513ac7fe5aSThomas Gleixner 		goto out;
7523ac7fe5aSThomas Gleixner 	}
7533ac7fe5aSThomas Gleixner 	res = 0;
7543ac7fe5aSThomas Gleixner out:
7553ac7fe5aSThomas Gleixner 	spin_unlock_irqrestore(&db->lock, flags);
7563ac7fe5aSThomas Gleixner 	if (res)
7573ac7fe5aSThomas Gleixner 		debug_objects_enabled = 0;
7583ac7fe5aSThomas Gleixner 	return res;
7593ac7fe5aSThomas Gleixner }
7603ac7fe5aSThomas Gleixner 
7613ac7fe5aSThomas Gleixner static __initdata struct debug_obj_descr descr_type_test = {
7623ac7fe5aSThomas Gleixner 	.name			= "selftest",
7633ac7fe5aSThomas Gleixner 	.fixup_init		= fixup_init,
7643ac7fe5aSThomas Gleixner 	.fixup_activate		= fixup_activate,
7653ac7fe5aSThomas Gleixner 	.fixup_destroy		= fixup_destroy,
7663ac7fe5aSThomas Gleixner 	.fixup_free		= fixup_free,
7673ac7fe5aSThomas Gleixner };
7683ac7fe5aSThomas Gleixner 
7693ac7fe5aSThomas Gleixner static __initdata struct self_test obj = { .static_init = 0 };
7703ac7fe5aSThomas Gleixner 
7713ac7fe5aSThomas Gleixner static void __init debug_objects_selftest(void)
7723ac7fe5aSThomas Gleixner {
7733ac7fe5aSThomas Gleixner 	int fixups, oldfixups, warnings, oldwarnings;
7743ac7fe5aSThomas Gleixner 	unsigned long flags;
7753ac7fe5aSThomas Gleixner 
7763ac7fe5aSThomas Gleixner 	local_irq_save(flags);
7773ac7fe5aSThomas Gleixner 
7783ac7fe5aSThomas Gleixner 	fixups = oldfixups = debug_objects_fixups;
7793ac7fe5aSThomas Gleixner 	warnings = oldwarnings = debug_objects_warnings;
7803ac7fe5aSThomas Gleixner 	descr_test = &descr_type_test;
7813ac7fe5aSThomas Gleixner 
7823ac7fe5aSThomas Gleixner 	debug_object_init(&obj, &descr_type_test);
7833ac7fe5aSThomas Gleixner 	if (check_results(&obj, ODEBUG_STATE_INIT, fixups, warnings))
7843ac7fe5aSThomas Gleixner 		goto out;
7853ac7fe5aSThomas Gleixner 	debug_object_activate(&obj, &descr_type_test);
7863ac7fe5aSThomas Gleixner 	if (check_results(&obj, ODEBUG_STATE_ACTIVE, fixups, warnings))
7873ac7fe5aSThomas Gleixner 		goto out;
7883ac7fe5aSThomas Gleixner 	debug_object_activate(&obj, &descr_type_test);
7893ac7fe5aSThomas Gleixner 	if (check_results(&obj, ODEBUG_STATE_ACTIVE, ++fixups, ++warnings))
7903ac7fe5aSThomas Gleixner 		goto out;
7913ac7fe5aSThomas Gleixner 	debug_object_deactivate(&obj, &descr_type_test);
7923ac7fe5aSThomas Gleixner 	if (check_results(&obj, ODEBUG_STATE_INACTIVE, fixups, warnings))
7933ac7fe5aSThomas Gleixner 		goto out;
7943ac7fe5aSThomas Gleixner 	debug_object_destroy(&obj, &descr_type_test);
7953ac7fe5aSThomas Gleixner 	if (check_results(&obj, ODEBUG_STATE_DESTROYED, fixups, warnings))
7963ac7fe5aSThomas Gleixner 		goto out;
7973ac7fe5aSThomas Gleixner 	debug_object_init(&obj, &descr_type_test);
7983ac7fe5aSThomas Gleixner 	if (check_results(&obj, ODEBUG_STATE_DESTROYED, fixups, ++warnings))
7993ac7fe5aSThomas Gleixner 		goto out;
8003ac7fe5aSThomas Gleixner 	debug_object_activate(&obj, &descr_type_test);
8013ac7fe5aSThomas Gleixner 	if (check_results(&obj, ODEBUG_STATE_DESTROYED, fixups, ++warnings))
8023ac7fe5aSThomas Gleixner 		goto out;
8033ac7fe5aSThomas Gleixner 	debug_object_deactivate(&obj, &descr_type_test);
8043ac7fe5aSThomas Gleixner 	if (check_results(&obj, ODEBUG_STATE_DESTROYED, fixups, ++warnings))
8053ac7fe5aSThomas Gleixner 		goto out;
8063ac7fe5aSThomas Gleixner 	debug_object_free(&obj, &descr_type_test);
8073ac7fe5aSThomas Gleixner 	if (check_results(&obj, ODEBUG_STATE_NONE, fixups, warnings))
8083ac7fe5aSThomas Gleixner 		goto out;
8093ac7fe5aSThomas Gleixner 
8103ac7fe5aSThomas Gleixner 	obj.static_init = 1;
8113ac7fe5aSThomas Gleixner 	debug_object_activate(&obj, &descr_type_test);
8123ac7fe5aSThomas Gleixner 	if (check_results(&obj, ODEBUG_STATE_ACTIVE, ++fixups, warnings))
8133ac7fe5aSThomas Gleixner 		goto out;
8143ac7fe5aSThomas Gleixner 	debug_object_init(&obj, &descr_type_test);
8153ac7fe5aSThomas Gleixner 	if (check_results(&obj, ODEBUG_STATE_INIT, ++fixups, ++warnings))
8163ac7fe5aSThomas Gleixner 		goto out;
8173ac7fe5aSThomas Gleixner 	debug_object_free(&obj, &descr_type_test);
8183ac7fe5aSThomas Gleixner 	if (check_results(&obj, ODEBUG_STATE_NONE, fixups, warnings))
8193ac7fe5aSThomas Gleixner 		goto out;
8203ac7fe5aSThomas Gleixner 
8213ac7fe5aSThomas Gleixner #ifdef CONFIG_DEBUG_OBJECTS_FREE
8223ac7fe5aSThomas Gleixner 	debug_object_init(&obj, &descr_type_test);
8233ac7fe5aSThomas Gleixner 	if (check_results(&obj, ODEBUG_STATE_INIT, fixups, warnings))
8243ac7fe5aSThomas Gleixner 		goto out;
8253ac7fe5aSThomas Gleixner 	debug_object_activate(&obj, &descr_type_test);
8263ac7fe5aSThomas Gleixner 	if (check_results(&obj, ODEBUG_STATE_ACTIVE, fixups, warnings))
8273ac7fe5aSThomas Gleixner 		goto out;
8283ac7fe5aSThomas Gleixner 	__debug_check_no_obj_freed(&obj, sizeof(obj));
8293ac7fe5aSThomas Gleixner 	if (check_results(&obj, ODEBUG_STATE_NONE, ++fixups, ++warnings))
8303ac7fe5aSThomas Gleixner 		goto out;
8313ac7fe5aSThomas Gleixner #endif
8323ac7fe5aSThomas Gleixner 	printk(KERN_INFO "ODEBUG: selftest passed\n");
8333ac7fe5aSThomas Gleixner 
8343ac7fe5aSThomas Gleixner out:
8353ac7fe5aSThomas Gleixner 	debug_objects_fixups = oldfixups;
8363ac7fe5aSThomas Gleixner 	debug_objects_warnings = oldwarnings;
8373ac7fe5aSThomas Gleixner 	descr_test = NULL;
8383ac7fe5aSThomas Gleixner 
8393ac7fe5aSThomas Gleixner 	local_irq_restore(flags);
8403ac7fe5aSThomas Gleixner }
8413ac7fe5aSThomas Gleixner #else
8423ac7fe5aSThomas Gleixner static inline void debug_objects_selftest(void) { }
8433ac7fe5aSThomas Gleixner #endif
8443ac7fe5aSThomas Gleixner 
8453ac7fe5aSThomas Gleixner /*
8463ac7fe5aSThomas Gleixner  * Called during early boot to initialize the hash buckets and link
8473ac7fe5aSThomas Gleixner  * the static object pool objects into the poll list. After this call
8483ac7fe5aSThomas Gleixner  * the object tracker is fully operational.
8493ac7fe5aSThomas Gleixner  */
8503ac7fe5aSThomas Gleixner void __init debug_objects_early_init(void)
8513ac7fe5aSThomas Gleixner {
8523ac7fe5aSThomas Gleixner 	int i;
8533ac7fe5aSThomas Gleixner 
8543ac7fe5aSThomas Gleixner 	for (i = 0; i < ODEBUG_HASH_SIZE; i++)
8553ac7fe5aSThomas Gleixner 		spin_lock_init(&obj_hash[i].lock);
8563ac7fe5aSThomas Gleixner 
8573ac7fe5aSThomas Gleixner 	for (i = 0; i < ODEBUG_POOL_SIZE; i++)
8583ac7fe5aSThomas Gleixner 		hlist_add_head(&obj_static_pool[i].node, &obj_pool);
8593ac7fe5aSThomas Gleixner }
8603ac7fe5aSThomas Gleixner 
8613ac7fe5aSThomas Gleixner /*
8623ac7fe5aSThomas Gleixner  * Called after the kmem_caches are functional to setup a dedicated
8633ac7fe5aSThomas Gleixner  * cache pool, which has the SLAB_DEBUG_OBJECTS flag set. This flag
8643ac7fe5aSThomas Gleixner  * prevents that the debug code is called on kmem_cache_free() for the
8653ac7fe5aSThomas Gleixner  * debug tracker objects to avoid recursive calls.
8663ac7fe5aSThomas Gleixner  */
8673ac7fe5aSThomas Gleixner void __init debug_objects_mem_init(void)
8683ac7fe5aSThomas Gleixner {
8693ac7fe5aSThomas Gleixner 	if (!debug_objects_enabled)
8703ac7fe5aSThomas Gleixner 		return;
8713ac7fe5aSThomas Gleixner 
8723ac7fe5aSThomas Gleixner 	obj_cache = kmem_cache_create("debug_objects_cache",
8733ac7fe5aSThomas Gleixner 				      sizeof (struct debug_obj), 0,
8743ac7fe5aSThomas Gleixner 				      SLAB_DEBUG_OBJECTS, NULL);
8753ac7fe5aSThomas Gleixner 
8763ac7fe5aSThomas Gleixner 	if (!obj_cache)
8773ac7fe5aSThomas Gleixner 		debug_objects_enabled = 0;
8783ac7fe5aSThomas Gleixner 	else
8793ac7fe5aSThomas Gleixner 		debug_objects_selftest();
8803ac7fe5aSThomas Gleixner }
881