Linux Audio

Check our new training course

Linux BSP upgrade and security maintenance

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