xref: /freebsd/sys/cam/cam_debug.h (revision 70f2356d364fdb7e2ff5487ae03125a338defd54)

/*-
 * Macros for tracing/loging information in the CAM layer
 *
 * SPDX-License-Identifier: BSD-2-Clause
 *
 * Copyright (c) 1997 Justin T. Gibbs.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions, and the following disclaimer,
 *    without modification, immediately at the beginning of the file.
 * 2. 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 AND CONTRIBUTORS ``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 OR CONTRIBUTORS 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.
 */
#ifndef	_CAM_CAM_DEBUG_H
#define _CAM_CAM_DEBUG_H 1

/*
 * Debugging flags.
 */
typedef enum {
	CAM_DEBUG_NONE		= 0x00, /* no debugging */
	CAM_DEBUG_INFO		= 0x01,	/* scsi commands, errors, data */
	CAM_DEBUG_TRACE		= 0x02,	/* routine flow tracking */
	CAM_DEBUG_SUBTRACE	= 0x04,	/* internal to routine flows */
	CAM_DEBUG_CDB		= 0x08, /* print out SCSI CDBs only */
	CAM_DEBUG_XPT		= 0x10,	/* print out xpt scheduling */
	CAM_DEBUG_PERIPH	= 0x20, /* print out peripheral calls */
	CAM_DEBUG_PROBE		= 0x40  /* print out probe actions */
} cam_debug_flags;

#if defined(_KERNEL)

#ifndef CAM_DEBUG_FLAGS
#define CAM_DEBUG_FLAGS		CAM_DEBUG_NONE
#endif

#ifndef CAM_DEBUG_COMPILE
#ifdef CAMDEBUG
#define CAM_DEBUG_COMPILE	(-1)
#else
#define CAM_DEBUG_COMPILE	(CAM_DEBUG_INFO | CAM_DEBUG_CDB | \
				 CAM_DEBUG_PERIPH | CAM_DEBUG_PROBE | \
				 CAM_DEBUG_FLAGS)
#endif
#endif

#ifndef CAM_DEBUG_BUS
#define CAM_DEBUG_BUS		CAM_BUS_WILDCARD
#endif
#ifndef CAM_DEBUG_TARGET
#define CAM_DEBUG_TARGET	CAM_TARGET_WILDCARD
#endif
#ifndef CAM_DEBUG_LUN
#define CAM_DEBUG_LUN		CAM_LUN_WILDCARD
#endif

#ifndef CAM_DEBUG_DELAY
#define CAM_DEBUG_DELAY		0
#endif

/* Path we want to debug */
extern struct cam_path *cam_dpath;
/* Current debug levels set */
extern uint32_t cam_dflags;
/* Printf delay value (to prevent scrolling) */
extern uint32_t cam_debug_delay;

/* Helper routines -- helps conserve stack */
struct cam_ed;
void xpt_cam_path_debug(struct cam_path *path, const char *fmt, ...);
void xpt_cam_dev_debug(struct cam_ed *dev, const char *fmt, ...);
void xpt_cam_debug(const char *fmt, ...);

/* Stupid macro to remove a layer of parens */
#define _CAM_X(...) __VA_ARGS__

/* Debugging macros. */
#define	CAM_DEBUGGED(path, flag)					\
	(((flag) & (CAM_DEBUG_COMPILE) & cam_dflags)			\
	 && (cam_dpath != NULL)						\
	 && (xpt_path_comp(cam_dpath, (path)) >= 0)			\
	 && (xpt_path_comp(cam_dpath, (path)) < 2))

#define	CAM_DEBUG(path, flag, printfargs)				\
	if (CAM_DEBUGGED(path, flag)) {					\
		xpt_cam_path_debug(path, _CAM_X printfargs);		\
	}

#define	CAM_DEBUG_DEV(dev, flag, printfargs)				\
	if (((flag) & (CAM_DEBUG_COMPILE) & cam_dflags)			\
	&& (cam_dpath != NULL)						\
	&& (xpt_path_comp_dev(cam_dpath, (dev)) >= 0)			\
	&& (xpt_path_comp_dev(cam_dpath, (dev)) < 2)) {			\
		xpt_cam_dev_debug(dev, _CAM_X printfargs);		\
	}

#define	CAM_DEBUG_PRINT(flag, printfargs)				\
	if (((flag) & (CAM_DEBUG_COMPILE) & cam_dflags)) {		\
		xpt_cam_debug(_CAM_X printfargs);			\
	}

#else /* !_KERNEL */

#define	CAM_DEBUGGED(A, B)	0
#define	CAM_DEBUG(A, B, C)
#define	CAM_DEBUG_DEV(A, B, C)
#define	CAM_DEBUG_PRINT(A, B)

#endif /* _KERNEL */

#endif /* _CAM_CAM_DEBUG_H */