Added paranoia checks debug facility. It helps checking that data in

memory haven't changed behind one's back.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@25193 a95241bf-73f2-0310-859d-f6bbb57e9c96

headers/private/kernel/debug_paranoia.h

@@ -0,0 +1,91 @@
+/*
+ * Copyright 2008, Ingo Weinhold, [email protected].
+ * Distributed under the terms of the MIT License.
+ */
+#ifndef _KERNEL_DEBUG_PARANOIA_H
+#define _KERNEL_DEBUG_PARANOIA_H
+
+#include <sys/cdefs.h>
+
+#include <SupportDefs.h>
+
+#include "paranoia_config.h"
+
+
+// How to use: Include the header only from source files. Define
+// ENABLE_PARANOIA_CHECK_COMPONENT (to 1 to enable) before. Use the macros
+// defined below and the ParanoiaChecker class.
+
+
+__BEGIN_DECLS
+
+#if ENABLE_PARANOIA_CHECKS
+
+status_t	create_paranoia_check_set(const void* object,
+				const char* description);
+status_t	delete_paranoia_check_set(const void* object);
+status_t	run_paranoia_checks(const void* object);
+
+status_t	set_paranoia_check(const void* object, const void* address,
+				size_t size);
+status_t	remove_paranoia_check(const void* object, const void* address,
+				size_t size);
+
+#endif	// ENABLE_PARANOIA_CHECKS
+
+void		debug_paranoia_init();
+
+__END_DECLS
+
+
+#if ENABLE_PARANOIA_CHECK_COMPONENT
+#	define PARANOIA_ONLY(x)	x
+#else
+#	define PARANOIA_ONLY(x)
+#endif
+
+#define	CREATE_PARANOIA_CHECK_SET(object, description)	\
+			PARANOIA_ONLY(create_paranoia_check_set((object), (description)))
+#define	DELETE_PARANOIA_CHECK_SET(object)	\
+			PARANOIA_ONLY(delete_paranoia_check_set((object)))
+#define	RUN_PARANOIA_CHECKS(object)	\
+			PARANOIA_ONLY(run_paranoia_checks((object)))
+#define	SET_PARANOIA_CHECK(object, address, size)	\
+			PARANOIA_ONLY(set_paranoia_check((object), (address), (size)))
+#define	REMOVE_PARANOIA_CHECK(object, address, size)	\
+			PARANOIA_ONLY(remove_paranoia_check((object), (address), (size)))
+
+
+#ifdef __cplusplus
+
+class ParanoiaChecker {
+public:
+	inline ParanoiaChecker(const void* object)
+	{
+		PARANOIA_ONLY(fObject = object);
+		RUN_PARANOIA_CHECKS(fObject);
+	}
+
+	inline ~ParanoiaChecker()
+	{
+		PARANOIA_ONLY(
+			if (fObject != NULL)
+				RUN_PARANOIA_CHECKS(fObject);
+		)
+	}
+
+	inline void Disable()
+	{
+		PARANOIA_ONLY(fObject = NULL);
+	}
+
+private:
+	PARANOIA_ONLY(
+		const void*	fObject;
+	)
+};
+
+#endif	// __cplusplus
+
+
+#endif	// _KERNEL_DEBUG_PARANOIA_H