xref: /freebsd/sys/cam/cam_debug.h (revision 380a989b3223d455375b4fae70fd0b9bdd43bafb)
1 /*
2  * Macros for tracing/loging information in the CAM layer
3  *
4  * Copyright (c) 1997 Justin T. Gibbs.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions, and the following disclaimer,
12  *    without modification, immediately at the beginning of the file.
13  * 2. The name of the author may not be used to endorse or promote products
14  *    derived from this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
20  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  *      $Id: cam_debug.h,v 1.2 1998/10/02 21:00:50 ken Exp $
29  */
30 #ifndef	_CAM_CAM_DEBUG_H
31 #define _CAM_CAM_DEBUG_H 1
32 
33 #if defined(CAMDEBUG) && defined(KERNEL)
34 #include <machine/clock.h>
35 #endif /* CAMDEBUG && KERNEL */
36 
37 /*
38  * Debugging flags.
39  */
40 typedef enum {
41 	CAM_DEBUG_NONE		= 0x00, /* no debugging */
42 	CAM_DEBUG_INFO		= 0x01,	/* scsi commands, errors, data */
43 	CAM_DEBUG_TRACE		= 0x02,	/* routine flow tracking */
44 	CAM_DEBUG_SUBTRACE	= 0x04,	/* internal to routine flows */
45 	CAM_DEBUG_CDB		= 0x08, /* print out SCSI CDBs only */
46 	CAM_DEBUG_XPT		= 0x10	/* print out xpt scheduling */
47 } cam_debug_flags;
48 
49 #if defined(CAMDEBUG) && defined(KERNEL)
50 
51 /* Path we want to debug */
52 extern struct cam_path *cam_dpath;
53 /* Current debug levels set */
54 extern u_int32_t cam_dflags;
55 
56 /* Debugging macros. */
57 #define	CAM_DEBUGGED(path, flag)			\
58 	((cam_dflags & (flag))				\
59 	 && (cam_dpath != NULL)				\
60 	 && (xpt_path_comp(path, cam_dpath) >= 0))
61 #define	CAM_DEBUG(path, flag, printfargs)		\
62 	if ((cam_dflags & (flag))			\
63 	 && (cam_dpath != NULL)				\
64 	 && (xpt_path_comp(path, cam_dpath) >= 0)) {	\
65 		xpt_print_path(path);			\
66  		printf printfargs;			\
67 		DELAY(100000);				\
68 	}
69 #define	CAM_DEBUG_PRINT(flag, printfargs)		\
70 	if (cam_dflags & (flag)) {			\
71 		printf("cam_debug: ");			\
72  		printf printfargs;			\
73 		DELAY(100000);				\
74 	}
75 
76 #else /* !CAMDEBUG || !KERNEL */
77 
78 #define	CAM_DEBUGGED(A, B)	0
79 #define	CAM_DEBUG(A, B, C)
80 #define	CAM_DEBUG_PRINT(A, B)
81 
82 #endif /* CAMDEBUG && KERNEL */
83 
84 #endif /* _CAM_CAM_DEBUG_H */
85