[apple/xnu.git] / bsd / hfs / hfs_dbg.h

/*
 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * The contents of this file constitute Original Code as defined in and
 * are subject to the Apple Public Source License Version 1.1 (the
 * "License").  You may not use this file except in compliance with the
 * License.  Please obtain a copy of the License at
 * http://www.apple.com/publicsource and read it before using this file.
 * 
 * This Original Code and all software distributed under the License are
 * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
 * License for the specific language governing rights and limitations
 * under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
/*	hfs_dbg.h
 *
 *	(c) 1997 Apple Computer, Inc.  All Rights Reserved
 *
 *	hfs_dbg.h -- debugging macros for HFS file system.
 *
 *	HISTORY
 *	10-Nov-1998 Pat Dirks		Cleaned up definition of DBG_ASSERT to handle embedded '%' correctly.
 *	28-Apr-1998	Scott Roberts	Reorganized and added HFS_DEBUG_STAGE
 *	17-Nov-1997	Pat Dirks		Pat Dirks at Apple Computer
 *								Derived from old hfs version.
 */

struct componentname;

/* Define the debugging stage...
		4 -> Do all, aggresive, call_kdp
		3 -> debug asserts and debug err, panic instead of call_kdp
		2 -> debug error, no kdb
		1 -> very little, panic only
*/
#ifndef HFS_DIAGNOSTIC
	#define HFS_DIAGNOSTIC 0
#endif /* HFS_DIAGNOSTIC */

#ifndef HFS_DEBUG_STAGE
#if HFS_DIAGNOSTIC
	#define HFS_DEBUG_STAGE 4
#else
	#define HFS_DEBUG_STAGE 1
#endif /* KERNEL */
#endif	/* HFS_DEBUG_STAGE */

#ifdef KERNEL
  #define PRINTIT kprintf
#else /* KERNEL */
  #define PRINTIT printf
#endif /* KERNEL */

#if (HFS_DEBUG_STAGE > 3)
#define DEBUG_BREAK Debugger("");
#else
#define DEBUG_BREAK
#endif

#if (HFS_DEBUG_STAGE == 4)
    #define DEBUG_BREAK_MSG(PRINTF_ARGS) { PRINTIT PRINTF_ARGS; DEBUG_BREAK };
#elif (HFS_DEBUG_STAGE == 3)
    #define DEBUG_BREAK_MSG(PRINTF_ARGS) { panic PRINTF_ARGS;};
#else
    #define DEBUG_BREAK_MSG(PRINTF_ARGS) { PRINTIT PRINTF_ARGS; };
#endif


//#define PRINT_DELAY (void) tsleep((caddr_t)&lbolt, PPAUSE, "hfs kprintf", 0)
#define PRINT_DELAY

/*
 * Debugging macros.
 */
#if	HFS_DIAGNOSTIC
extern int hfs_dbg_all;
extern int hfs_dbg_err;

#ifdef KERNEL
    #if (HFS_DEBUG_STAGE == 4)
		char		gDebugAssertStr[255];
		#define DBG_ASSERT(a) { if (!(a)) { \
				sprintf(gDebugAssertStr,"Oops - File "__FILE__", line %d: assertion '%s' failed.\n", __LINE__, #a); \
                Debugger(gDebugAssertStr); } }
	#else
#define DBG_ASSERT(a) { if (!(a)) { panic("File "__FILE__", line %d: assertion '%s' failed.\n", __LINE__, #a); } }
    #endif /* HFS_DEBUG_STAGE */
#else
    #define DBG_ASSERT(a) assert(a)
#endif /* KERNEL */

#define DBG_ERR(x)	{		\
	if(hfs_dbg_all || hfs_dbg_err) {	\
        PRINTIT("%X: ", current_proc()->p_pid); \
	    PRINTIT("HFS ERROR: "); \
	    PRINTIT x;			\
	    PRINT_DELAY;  \
	};			\
}

#else	/* HFS_DIAGNOSTIC */

#define DBG_ASSERT(a)
#define DBG_ERR(x)

#endif	/* HFS_DIAGNOSTIC */
Commit	Line	Data
1c79356b A	1	/*
	2	* Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
	6	* The contents of this file constitute Original Code as defined in and
	7	* are subject to the Apple Public Source License Version 1.1 (the
	8	* "License"). You may not use this file except in compliance with the
	9	* License. Please obtain a copy of the License at
	10	* http://www.apple.com/publicsource and read it before using this file.
	11	*
	12	* This Original Code and all software distributed under the License are
	13	* distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
	14	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
	15	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
	16	* FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
	17	* License for the specific language governing rights and limitations
	18	* under the License.
	19	*
	20	* @APPLE_LICENSE_HEADER_END@
	21	*/
	22	/* hfs_dbg.h
	23	*
	24	* (c) 1997 Apple Computer, Inc. All Rights Reserved
	25	*
	26	* hfs_dbg.h -- debugging macros for HFS file system.
	27	*
	28	* HISTORY
	29	* 10-Nov-1998 Pat Dirks Cleaned up definition of DBG_ASSERT to handle embedded '%' correctly.
	30	* 28-Apr-1998 Scott Roberts Reorganized and added HFS_DEBUG_STAGE
	31	* 17-Nov-1997 Pat Dirks Pat Dirks at Apple Computer
	32	* Derived from old hfs version.
	33	*/
	34
	35	struct componentname;
	36
	37	/* Define the debugging stage...
	38	4 -> Do all, aggresive, call_kdp
	39	3 -> debug asserts and debug err, panic instead of call_kdp
	40	2 -> debug error, no kdb
	41	1 -> very little, panic only
	42	*/
	43	#ifndef HFS_DIAGNOSTIC
	44	#define HFS_DIAGNOSTIC 0
	45	#endif /* HFS_DIAGNOSTIC */
	46
	47	#ifndef HFS_DEBUG_STAGE
	48	#if HFS_DIAGNOSTIC
	49	#define HFS_DEBUG_STAGE 4
	50	#else
	51	#define HFS_DEBUG_STAGE 1
	52	#endif /* KERNEL */
	53	#endif /* HFS_DEBUG_STAGE */
	54
	55	#ifdef KERNEL
	56	#define PRINTIT kprintf
	57	#else /* KERNEL */
	58	#define PRINTIT printf
	59	#endif /* KERNEL */
	60
	61	#if (HFS_DEBUG_STAGE > 3)
	62	#define DEBUG_BREAK Debugger("");
	63	#else
	64	#define DEBUG_BREAK
65	#endif
66
67	#if (HFS_DEBUG_STAGE == 4)
68	#define DEBUG_BREAK_MSG(PRINTF_ARGS) { PRINTIT PRINTF_ARGS; DEBUG_BREAK };
69	#elif (HFS_DEBUG_STAGE == 3)
70	#define DEBUG_BREAK_MSG(PRINTF_ARGS) { panic PRINTF_ARGS;};
71	#else
72	#define DEBUG_BREAK_MSG(PRINTF_ARGS) { PRINTIT PRINTF_ARGS; };
73	#endif
74
75
76	//#define PRINT_DELAY (void) tsleep((caddr_t)&lbolt, PPAUSE, "hfs kprintf", 0)
77	#define PRINT_DELAY
78
79	/*
80	* Debugging macros.
81	*/
82	#if HFS_DIAGNOSTIC
83	extern int hfs_dbg_all;
1c79356b	84	extern int hfs_dbg_err;
1c79356b A	85
	86	#ifdef KERNEL
	87	#if (HFS_DEBUG_STAGE == 4)
	88	char gDebugAssertStr[255];
	89	#define DBG_ASSERT(a) { if (!(a)) { \
	90	sprintf(gDebugAssertStr,"Oops - File "__FILE__", line %d: assertion '%s' failed.\n", __LINE__, #a); \
	91	Debugger(gDebugAssertStr); } }
	92	#else
	93	#define DBG_ASSERT(a) { if (!(a)) { panic("File "__FILE__", line %d: assertion '%s' failed.\n", __LINE__, #a); } }
	94	#endif /* HFS_DEBUG_STAGE */
	95	#else
	96	#define DBG_ASSERT(a) assert(a)
	97	#endif /* KERNEL */
	98
1c79356b A	99	#define DBG_ERR(x) { \
	100	if(hfs_dbg_all \|\| hfs_dbg_err) { \
	101	PRINTIT("%X: ", current_proc()->p_pid); \
	102	PRINTIT("HFS ERROR: "); \
	103	PRINTIT x; \
	104	PRINT_DELAY; \
	105	}; \
	106	}
1c79356b	107
9bccf70c	108	#else /* HFS_DIAGNOSTIC */
1c79356b	109
9bccf70c A	110	#define DBG_ASSERT(a)
9bccf70c A	111	#define DBG_ERR(x)
1c79356b	112
9bccf70c	113	#endif /* HFS_DIAGNOSTIC */
1c79356b	114