LXR linux/include/linux/debugobjects.h

   1#ifndef _LINUX_DEBUGOBJECTS_H
   2#define _LINUX_DEBUGOBJECTS_H
   3
   4#include <linux/list.h>
   5#include <linux/spinlock.h>
   6
   7enum debug_obj_state {
   8        ODEBUG_STATE_NONE,
   9        ODEBUG_STATE_INIT,
  10        ODEBUG_STATE_INACTIVE,
  11        ODEBUG_STATE_ACTIVE,
  12        ODEBUG_STATE_DESTROYED,
  13        ODEBUG_STATE_NOTAVAILABLE,
  14        ODEBUG_STATE_MAX,
  15};
  16
  17struct debug_obj_descr;
  18
  19/**
  20 * struct debug_obj - representaion of an tracked object
  21 * @node:       hlist node to link the object into the tracker list
  22 * @state:      tracked object state
  23 * @object:     pointer to the real object
  24 * @descr:      pointer to an object type specific debug description structure
  25 */
  26struct debug_obj {
  27        struct hlist_node       node;
  28        enum debug_obj_state    state;
  29        void                    *object;
  30        struct debug_obj_descr  *descr;
  31};
  32
  33/**
  34 * struct debug_obj_descr - object type specific debug description structure
  35 * @name:               name of the object typee
  36 * @fixup_init:         fixup function, which is called when the init check
  37 *                      fails
  38 * @fixup_activate:     fixup function, which is called when the activate check
  39 *                      fails
  40 * @fixup_destroy:      fixup function, which is called when the destroy check
  41 *                      fails
  42 * @fixup_free:         fixup function, which is called when the free check
  43 *                      fails
  44 */
  45struct debug_obj_descr {
  46        const char              *name;
  47
  48        int (*fixup_init)       (void *addr, enum debug_obj_state state);
  49        int (*fixup_activate)   (void *addr, enum debug_obj_state state);
  50        int (*fixup_destroy)    (void *addr, enum debug_obj_state state);
  51        int (*fixup_free)       (void *addr, enum debug_obj_state state);
  52};
  53
  54#ifdef CONFIG_DEBUG_OBJECTS
  55extern void debug_object_init      (void *addr, struct debug_obj_descr *descr);
  56extern void
  57debug_object_init_on_stack(void *addr, struct debug_obj_descr *descr);
  58extern void debug_object_activate  (void *addr, struct debug_obj_descr *descr);
  59extern void debug_object_deactivate(void *addr, struct debug_obj_descr *descr);
  60extern void debug_object_destroy   (void *addr, struct debug_obj_descr *descr);
  61extern void debug_object_free      (void *addr, struct debug_obj_descr *descr);
  62
  63extern void debug_objects_early_init(void);
  64extern void debug_objects_mem_init(void);
  65#else
  66static inline void
  67debug_object_init      (void *addr, struct debug_obj_descr *descr) { }
  68static inline void
  69debug_object_init_on_stack(void *addr, struct debug_obj_descr *descr) { }
  70static inline void
  71debug_object_activate  (void *addr, struct debug_obj_descr *descr) { }
  72static inline void
  73debug_object_deactivate(void *addr, struct debug_obj_descr *descr) { }
  74static inline void
  75debug_object_destroy   (void *addr, struct debug_obj_descr *descr) { }
  76static inline void
  77debug_object_free      (void *addr, struct debug_obj_descr *descr) { }
  78
  79static inline void debug_objects_early_init(void) { }
  80static inline void debug_objects_mem_init(void) { }
  81#endif
  82
  83#ifdef CONFIG_DEBUG_OBJECTS_FREE
  84extern void debug_check_no_obj_freed(const void *address, unsigned long size);
  85#else
  86static inline void
  87debug_check_no_obj_freed(const void *address, unsigned long size) { }
  88#endif
  89
  90#endif
  91