infrastructure to debug (dynamic) objects

[linux-2.6-microblaze.git] / include / linux / debugobjects.h

diff --git a/include/linux/debugobjects.h b/include/linux/debugobjects.h
new file mode 100644 (file)
index 0000000..8c243aa
--- /dev/null
+++ b/include/linux/debugobjects.h
@@ -0,0 +1,90 @@
+#ifndef _LINUX_DEBUGOBJECTS_H
+#define _LINUX_DEBUGOBJECTS_H
+
+#include <linux/list.h>
+#include <linux/spinlock.h>
+
+enum debug_obj_state {
+       ODEBUG_STATE_NONE,
+       ODEBUG_STATE_INIT,
+       ODEBUG_STATE_INACTIVE,
+       ODEBUG_STATE_ACTIVE,
+       ODEBUG_STATE_DESTROYED,
+       ODEBUG_STATE_NOTAVAILABLE,
+       ODEBUG_STATE_MAX,
+};
+
+struct debug_obj_descr;
+
+/**
+ * struct debug_obj - representaion of an tracked object
+ * @node:      hlist node to link the object into the tracker list
+ * @state:     tracked object state
+ * @object:    pointer to the real object
+ * @descr:     pointer to an object type specific debug description structure
+ */
+struct debug_obj {
+       struct hlist_node       node;
+       enum debug_obj_state    state;
+       void                    *object;
+       struct debug_obj_descr  *descr;
+};
+
+/**
+ * struct debug_obj_descr - object type specific debug description structure
+ * @name:              name of the object typee
+ * @fixup_init:                fixup function, which is called when the init check
+ *                     fails
+ * @fixup_activate:    fixup function, which is called when the activate check
+ *                     fails
+ * @fixup_destroy:     fixup function, which is called when the destroy check
+ *                     fails
+ * @fixup_free:                fixup function, which is called when the free check
+ *                     fails
+ */
+struct debug_obj_descr {
+       const char              *name;
+
+       int (*fixup_init)       (void *addr, enum debug_obj_state state);
+       int (*fixup_activate)   (void *addr, enum debug_obj_state state);
+       int (*fixup_destroy)    (void *addr, enum debug_obj_state state);
+       int (*fixup_free)       (void *addr, enum debug_obj_state state);
+};
+
+#ifdef CONFIG_DEBUG_OBJECTS
+extern void debug_object_init      (void *addr, struct debug_obj_descr *descr);
+extern void
+debug_object_init_on_stack(void *addr, struct debug_obj_descr *descr);
+extern void debug_object_activate  (void *addr, struct debug_obj_descr *descr);
+extern void debug_object_deactivate(void *addr, struct debug_obj_descr *descr);
+extern void debug_object_destroy   (void *addr, struct debug_obj_descr *descr);
+extern void debug_object_free      (void *addr, struct debug_obj_descr *descr);
+
+extern void debug_objects_early_init(void);
+extern void debug_objects_mem_init(void);
+#else
+static inline void
+debug_object_init      (void *addr, struct debug_obj_descr *descr) { }
+static inline void
+debug_object_init_on_stack(void *addr, struct debug_obj_descr *descr) { }
+static inline void
+debug_object_activate  (void *addr, struct debug_obj_descr *descr) { }
+static inline void
+debug_object_deactivate(void *addr, struct debug_obj_descr *descr) { }
+static inline void
+debug_object_destroy   (void *addr, struct debug_obj_descr *descr) { }
+static inline void
+debug_object_free      (void *addr, struct debug_obj_descr *descr) { }
+
+static inline void debug_objects_early_init(void) { }
+static inline void debug_objects_mem_init(void) { }
+#endif
+
+#ifdef CONFIG_DEBUG_OBJECTS_FREE
+extern void debug_check_no_obj_freed(const void *address, unsigned long size);
+#else
+static inline void
+debug_check_no_obj_freed(const void *address, unsigned long size) { }
+#endif
+
+#endif