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
   7 enum 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
  17 struct 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  * @astate:     current active state
  24  * @object:     pointer to the real object
  25  * @descr:      pointer to an object type specific debug description structure
  26  */
  27 struct debug_obj {
  28         struct hlist_node       node;
  29         enum debug_obj_state    state;
  30         unsigned int            astate;
  31         void                    *object;
  32         struct debug_obj_descr  *descr;
  33 };
  34
  35 /**
  36  * struct debug_obj_descr - object type specific debug description structure
  37  * @name:               name of the object typee
  38  * @fixup_init:         fixup function, which is called when the init check
  39  *                      fails
  40  * @fixup_activate:     fixup function, which is called when the activate check
  41  *                      fails
  42  * @fixup_destroy:      fixup function, which is called when the destroy check
  43  *                      fails
  44  * @fixup_free:         fixup function, which is called when the free check
  45  *                      fails
  46  */
  47 struct debug_obj_descr {
  48         const char              *name;
  49
  50         int (*fixup_init)       (void *addr, enum debug_obj_state state);
  51         int (*fixup_activate)   (void *addr, enum debug_obj_state state);
  52         int (*fixup_destroy)    (void *addr, enum debug_obj_state state);
  53         int (*fixup_free)       (void *addr, enum debug_obj_state state);
  54 };
  55
  56 #ifdef CONFIG_DEBUG_OBJECTS
  57 extern void debug_object_init      (void *addr, struct debug_obj_descr *descr);
  58 extern void
  59 debug_object_init_on_stack(void *addr, struct debug_obj_descr *descr);
  60 extern void debug_object_activate  (void *addr, struct debug_obj_descr *descr);
  61 extern void debug_object_deactivate(void *addr, struct debug_obj_descr *descr);
  62 extern void debug_object_destroy   (void *addr, struct debug_obj_descr *descr);
  63 extern void debug_object_free      (void *addr, struct debug_obj_descr *descr);
  64
  65 /*
  66  * Active state:
  67  * - Set at 0 upon initialization.
  68  * - Must return to 0 before deactivation.
  69  */
  70 extern void
  71 debug_object_active_state(void *addr, struct debug_obj_descr *descr,
  72                           unsigned int expect, unsigned int next);
  73
  74 extern void debug_objects_early_init(void);
  75 extern void debug_objects_mem_init(void);
  76 #else
  77 static inline void
  78 debug_object_init      (void *addr, struct debug_obj_descr *descr) { }
  79 static inline void
  80 debug_object_init_on_stack(void *addr, struct debug_obj_descr *descr) { }
  81 static inline void
  82 debug_object_activate  (void *addr, struct debug_obj_descr *descr) { }
  83 static inline void
  84 debug_object_deactivate(void *addr, struct debug_obj_descr *descr) { }
  85 static inline void
  86 debug_object_destroy   (void *addr, struct debug_obj_descr *descr) { }
  87 static inline void
  88 debug_object_free      (void *addr, struct debug_obj_descr *descr) { }
  89
  90 static inline void debug_objects_early_init(void) { }
  91 static inline void debug_objects_mem_init(void) { }
  92 #endif
  93
  94 #ifdef CONFIG_DEBUG_OBJECTS_FREE
  95 extern void debug_check_no_obj_freed(const void *address, unsigned long size);
  96 #else
  97 static inline void
  98 debug_check_no_obj_freed(const void *address, unsigned long size) { }
  99 #endif
 100
 101 #endif