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