sys/cam/cam_debug.h

   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  * $FreeBSD$
  29  */
  30 #ifndef _CAM_CAM_DEBUG_H
  31 #define _CAM_CAM_DEBUG_H 1
  32
  33 /*
  34  * Debugging flags.
  35  */
  36 typedef enum {
  37         CAM_DEBUG_NONE          = 0x00, /* no debugging */
  38         CAM_DEBUG_INFO          = 0x01, /* scsi commands, errors, data */
  39         CAM_DEBUG_TRACE         = 0x02, /* routine flow tracking */
  40         CAM_DEBUG_SUBTRACE      = 0x04, /* internal to routine flows */
  41         CAM_DEBUG_CDB           = 0x08, /* print out SCSI CDBs only */
  42         CAM_DEBUG_XPT           = 0x10, /* print out xpt scheduling */
  43         CAM_DEBUG_PERIPH        = 0x20, /* print out peripheral calls */
  44         CAM_DEBUG_PROBE         = 0x40  /* print out probe actions */
  45 } cam_debug_flags;
  46
  47 #if defined(CAMDEBUG) && defined(_KERNEL)
  48
  49 /* Path we want to debug */
  50 extern struct cam_path *cam_dpath;
  51 /* Current debug levels set */
  52 extern u_int32_t cam_dflags;
  53 /* Printf delay value (to prevent scrolling) */
  54 extern u_int32_t cam_debug_delay;
  55
  56 /* Debugging macros. */
  57 #define CAM_DEBUGGED(path, flag)                        \
  58         ((cam_dflags & (flag))                          \
  59          && (cam_dpath != NULL)                         \
  60          && (xpt_path_comp(cam_dpath, path) >= 0)       \
  61          && (xpt_path_comp(cam_dpath, path) < 2))
  62
  63 #define CAM_DEBUG(path, flag, printfargs)               \
  64         if ((cam_dflags & (flag))                       \
  65          && (cam_dpath != NULL)                         \
  66          && (xpt_path_comp(cam_dpath, path) >= 0)       \
  67          && (xpt_path_comp(cam_dpath, path) < 2)) {     \
  68                 xpt_print_path(path);                   \
  69                 printf printfargs;                      \
  70                 if (cam_debug_delay != 0)               \
  71                         DELAY(cam_debug_delay);         \
  72         }
  73
  74 #define CAM_DEBUG_PRINT(flag, printfargs)               \
  75         if (cam_dflags & (flag)) {                      \
  76                 printf("cam_debug: ");                  \
  77                 printf printfargs;                      \
  78                 if (cam_debug_delay != 0)               \
  79                         DELAY(cam_debug_delay);         \
  80         }
  81
  82 #define CAM_DEBUG_PATH_PRINT(flag, path, printfargs)    \
  83         if (cam_dflags & (flag)) {                      \
  84                 xpt_print(path, "cam_debug: ");         \
  85                 printf printfargs;                      \
  86                 if (cam_debug_delay != 0)               \
  87                         DELAY(cam_debug_delay);         \
  88         }
  89
  90 #else /* !CAMDEBUG || !_KERNEL */
  91
  92 #define CAM_DEBUGGED(A, B)      0
  93 #define CAM_DEBUG(A, B, C)
  94 #define CAM_DEBUG_PRINT(A, B)
  95 #define CAM_DEBUG_PATH_PRINT(A, B, C)
  96
  97 #endif /* CAMDEBUG && _KERNEL */
  98
  99 #endif /* _CAM_CAM_DEBUG_H */