WebSVN – HelenOS – Diff – /trunk/kernel/generic/include/debug.h


/*
 * Copyright (c) 2005 Martin Decky
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
/** @addtogroup genericdebug
 * @{
 */
/** @file
 */
 
#ifndef KERN_DEBUG_H_
#define KERN_DEBUG_H_
 
#include <panic.h>
#include <arch/debug.h>
 
#define CALLER ((uintptr_t) __builtin_return_address(0))
 
#ifndef HERE
/** Current Instruction Pointer address */
#   define HERE ((uintptr_t *) 0)
#endif
 
/** Debugging ASSERT macro
 *
 * If CONFIG_DEBUG is set, the ASSERT() macro
 * evaluates expr and if it is false raises
 * kernel panic.
 *
 * @param expr Expression which is expected to be true.
 *
 */
#ifdef CONFIG_DEBUG
#   define ASSERT(expr) \
        if (!(expr)) { \
            panic("assertion failed (%s), caller=%p\n", #expr, CALLER); \
        }
#else
#   define ASSERT(expr)
#endif
 
/** Extensive logging output macro
 *
 * If CONFIG_LOG is set, the LOG() macro
 * will print whatever message is indicated plus
 * an information about the location.
 *
 */
 
#ifdef CONFIG_LOG
#   define LOG(format, ...) \
        printf("%s() at %s:%u: " format "\n", __func__, __FILE__, \
            __LINE__, ##__VA_ARGS__);
#else
#   define LOG(format, ...)
#endif
 
/** Extensive logging execute macro
 *
 * If CONFIG_LOG is set, the LOG_EXEC() macro
 * will print an information about calling a given
 * function and call it.
 *
 */
 
#ifdef CONFIG_LOG
#   define LOG_EXEC(fnc) \
        { \
            printf("%s() at %s:%u: " #fnc "\n", __func__, __FILE__, \
            __LINE__); \
            fnc; \
        }
#else
#   define LOG_EXEC(fnc) fnc
#endif
 
 
#endif
 
/** @}
 */
 

Rev 3067	Rev 3702
1	/*	1	/*
2	* Copyright (c) 2005 Martin Decky	2	* Copyright (c) 2005 Martin Decky
3	* All rights reserved.	3	* All rights reserved.
4	*	4	*
5	* Redistribution and use in source and binary forms, with or without	5	* Redistribution and use in source and binary forms, with or without
6	* modification, are permitted provided that the following conditions	6	* modification, are permitted provided that the following conditions
7	* are met:	7	* are met:
8	*	8	*
9	* - Redistributions of source code must retain the above copyright	9	* - Redistributions of source code must retain the above copyright
10	* notice, this list of conditions and the following disclaimer.	10	* notice, this list of conditions and the following disclaimer.
11	* - Redistributions in binary form must reproduce the above copyright	11	* - Redistributions in binary form must reproduce the above copyright
12	* notice, this list of conditions and the following disclaimer in the	12	* notice, this list of conditions and the following disclaimer in the
13	* documentation and/or other materials provided with the distribution.	13	* documentation and/or other materials provided with the distribution.
14	* - The name of the author may not be used to endorse or promote products	14	* - The name of the author may not be used to endorse or promote products
15	* derived from this software without specific prior written permission.	15	* derived from this software without specific prior written permission.
16	*	16	*
17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR	17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES	18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.	19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,	20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT	21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,	22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY	23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT	24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF	25	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.	26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27	*/	27	*/
28		28
29	/** @addtogroup genericdebug	29	/** @addtogroup genericdebug
30	* @{	30	* @{
31	*/	31	*/
32	/** @file	32	/** @file
33	*/	33	*/
34		34
35	#ifndef KERN_DEBUG_H_	35	#ifndef KERN_DEBUG_H_
36	#define KERN_DEBUG_H_	36	#define KERN_DEBUG_H_
37		37
38	#include <panic.h>	38	#include <panic.h>
39	#include <arch/debug.h>	39	#include <arch/debug.h>
40		40
41	#define CALLER ((uintptr_t) __builtin_return_address(0))	41	#define CALLER ((uintptr_t) __builtin_return_address(0))
42		42
43	#ifndef HERE	43	#ifndef HERE
44	/** Current Instruction Pointer address */	44	/** Current Instruction Pointer address */
45	# define HERE ((uintptr_t *) 0)	45	# define HERE ((uintptr_t *) 0)
46	#endif	46	#endif
47		47
48	/** Debugging ASSERT macro	48	/** Debugging ASSERT macro
49	*	49	*
50	* If CONFIG_DEBUG is set, the ASSERT() macro	50	* If CONFIG_DEBUG is set, the ASSERT() macro
51	* evaluates expr and if it is false raises	51	* evaluates expr and if it is false raises
52	* kernel panic.	52	* kernel panic.
53	*	53	*
54	* @param expr Expression which is expected to be true.	54	* @param expr Expression which is expected to be true.
55	*	55	*
56	*/	56	*/
57	#ifdef CONFIG_DEBUG	57	#ifdef CONFIG_DEBUG
58	# define ASSERT(expr) \	58	# define ASSERT(expr) \
59	if (!(expr)) { \	59	if (!(expr)) { \
60	panic("assertion failed (%s), caller=%p\n", #expr, CALLER); \	60	panic("assertion failed (%s), caller=%p\n", #expr, CALLER); \
61	}	61	}
62	#else	62	#else
63	# define ASSERT(expr)	63	# define ASSERT(expr)
64	#endif	64	#endif
65		65
66	/** Extensive debugging output macro	66	/** Extensive logging output macro
67	*	67	*
68	* If CONFIG_EDEBUG is set, the LOG() macro	68	* If CONFIG_LOG is set, the LOG() macro
69	* will print whatever message is indicated plus	69	* will print whatever message is indicated plus
70	* an information about the location.	70	* an information about the location.
71	*	71	*
72	*/	72	*/
73		73
74	#ifdef CONFIG_EDEBUG	74	#ifdef CONFIG_LOG
75	# define LOG(format, ...) \	75	# define LOG(format, ...) \
76	printf("%s() at %s:%u: " format "\n", __func__, __FILE__, \	76	printf("%s() at %s:%u: " format "\n", __func__, __FILE__, \
77	__LINE__, ##__VA_ARGS__);	77	__LINE__, ##__VA_ARGS__);
78	#else	78	#else
79	# define LOG(format, ...)	79	# define LOG(format, ...)
80	#endif	80	#endif
81		81
82	/** Extensive debugging execute macro	82	/** Extensive logging execute macro
83	*	83	*
84	* If CONFIG_EDEBUG is set, the LOG_EXEC() macro	84	* If CONFIG_LOG is set, the LOG_EXEC() macro
85	* will print an information about calling a given	85	* will print an information about calling a given
86	* function and call it.	86	* function and call it.
87	*	87	*
88	*/	88	*/
89		89
90	#ifdef CONFIG_EDEBUG	90	#ifdef CONFIG_LOG
91	# define LOG_EXEC(fnc) \	91	# define LOG_EXEC(fnc) \
92	{ \	92	{ \
93	printf("%s() at %s:%u: " #fnc "\n", __func__, __FILE__, \	93	printf("%s() at %s:%u: " #fnc "\n", __func__, __FILE__, \
94	__LINE__); \	94	__LINE__); \
95	fnc; \	95	fnc; \
96	}	96	}
97	#else	97	#else
98	# define LOG_EXEC(fnc) fnc	98	# define LOG_EXEC(fnc) fnc
99	#endif	99	#endif
100		100
101		101
102	#endif	102	#endif
103		103
104	/** @}	104	/** @}
105	*/	105	*/
106		106

Subversion Repositories HelenOS

(root)/trunk/kernel/generic/include/debug.h @ 3848 – Rev 3067 → 3702