debugobjects.h

  1/* SPDX-License-Identifier: GPL-2.0 */
  2#ifndef _LINUX_DEBUGOBJECTS_H
  3#define _LINUX_DEBUGOBJECTS_H
  4
  5#include <linux/list.h>
  6#include <linux/spinlock.h>
  7
  8enum debug_obj_state {
  9	ODEBUG_STATE_NONE,
 10	ODEBUG_STATE_INIT,
 11	ODEBUG_STATE_INACTIVE,
 12	ODEBUG_STATE_ACTIVE,
 13	ODEBUG_STATE_DESTROYED,
 14	ODEBUG_STATE_NOTAVAILABLE,
 15	ODEBUG_STATE_MAX,
 16};
 17
 18struct debug_obj_descr;
 19
 20/**
 21 * struct debug_obj - representation of an tracked object
 22 * @node:	hlist node to link the object into the tracker list
 23 * @state:	tracked object state
 24 * @astate:	current active state
 25 * @object:	pointer to the real object
 26 * @batch_last:	pointer to the last hlist node in a batch
 27 * @descr:	pointer to an object type specific debug description structure
 28 */
 29struct debug_obj {
 30	struct hlist_node		node;
 31	enum debug_obj_state		state;
 32	unsigned int			astate;
 33	union {
 34		void			*object;
 35		struct hlist_node	*batch_last;
 36	};
 37	const struct debug_obj_descr *descr;
 38};
 39
 40/**
 41 * struct debug_obj_descr - object type specific debug description structure
 42 *
 43 * @name:		name of the object typee
 44 * @debug_hint:		function returning address, which have associated
 45 *			kernel symbol, to allow identify the object
 46 * @is_static_object:	return true if the obj is static, otherwise return false
 47 * @fixup_init:		fixup function, which is called when the init check
 48 *			fails. All fixup functions must return true if fixup
 49 *			was successful, otherwise return false
 50 * @fixup_activate:	fixup function, which is called when the activate check
 51 *			fails
 52 * @fixup_destroy:	fixup function, which is called when the destroy check
 53 *			fails
 54 * @fixup_free:		fixup function, which is called when the free check
 55 *			fails
 56 * @fixup_assert_init:  fixup function, which is called when the assert_init
 57 *			check fails
 58 */
 59struct debug_obj_descr {
 60	const char		*name;
 61	void *(*debug_hint)(void *addr);
 62	bool (*is_static_object)(void *addr);
 63	bool (*fixup_init)(void *addr, enum debug_obj_state state);
 64	bool (*fixup_activate)(void *addr, enum debug_obj_state state);
 65	bool (*fixup_destroy)(void *addr, enum debug_obj_state state);
 66	bool (*fixup_free)(void *addr, enum debug_obj_state state);
 67	bool (*fixup_assert_init)(void *addr, enum debug_obj_state state);
 68};
 69
 70#ifdef CONFIG_DEBUG_OBJECTS
 71extern void debug_object_init      (void *addr, const struct debug_obj_descr *descr);
 72extern void
 73debug_object_init_on_stack(void *addr, const struct debug_obj_descr *descr);
 74extern int debug_object_activate  (void *addr, const struct debug_obj_descr *descr);
 75extern void debug_object_deactivate(void *addr, const struct debug_obj_descr *descr);
 76extern void debug_object_destroy   (void *addr, const struct debug_obj_descr *descr);
 77extern void debug_object_free      (void *addr, const struct debug_obj_descr *descr);
 78extern void debug_object_assert_init(void *addr, const struct debug_obj_descr *descr);
 79
 80/*
 81 * Active state:
 82 * - Set at 0 upon initialization.
 83 * - Must return to 0 before deactivation.
 84 */
 85extern void
 86debug_object_active_state(void *addr, const struct debug_obj_descr *descr,
 87			  unsigned int expect, unsigned int next);
 88
 89extern void debug_objects_early_init(void);
 90extern void debug_objects_mem_init(void);
 91#else
 92static inline void
 93debug_object_init      (void *addr, const struct debug_obj_descr *descr) { }
 94static inline void
 95debug_object_init_on_stack(void *addr, const struct debug_obj_descr *descr) { }
 96static inline int
 97debug_object_activate  (void *addr, const struct debug_obj_descr *descr) { return 0; }
 98static inline void
 99debug_object_deactivate(void *addr, const struct debug_obj_descr *descr) { }
100static inline void
101debug_object_destroy   (void *addr, const struct debug_obj_descr *descr) { }
102static inline void
103debug_object_free      (void *addr, const struct debug_obj_descr *descr) { }
104static inline void
105debug_object_assert_init(void *addr, const struct debug_obj_descr *descr) { }
106
107static inline void debug_objects_early_init(void) { }
108static inline void debug_objects_mem_init(void) { }
109#endif
110
111#ifdef CONFIG_DEBUG_OBJECTS_FREE
112extern void debug_check_no_obj_freed(const void *address, unsigned long size);
113#else
114static inline void
115debug_check_no_obj_freed(const void *address, unsigned long size) { }
116#endif
117
118#endif