3393f8daa3
Some of the major changes include: - The SCSI error handling portion of cam_periph_error() has been broken out into a number of subfunctions to better modularize the code that handles the hierarchy of SCSI errors. As a result, the code is now much easier to read. - String handling and error printing has been significantly revamped. We now use sbufs to do string formatting instead of using printfs (for the kernel) and snprintf/strncat (for userland) as before. There is a new catchall error printing routine, cam_error_print() and its string-based counterpart, cam_error_string() that allow the kernel and userland applications to pass in a CCB and have errors printed out properly, whether or not they're SCSI errors. Among other things, this helped eliminate a fair amount of duplicate code in camcontrol. We now print out more information than before, including the CAM status and SCSI status and the error recovery action taken to remedy the problem. - sbufs are now available in userland, via libsbuf. This change was necessary since most of the error printing code is shared between libcam and the kernel. - A new transfer settings interface is included in this checkin. This code is #ifdef'ed out, and is primarily intended to aid discussion with HBA driver authors on the final form the interface should take. There is example code in the ahc(4) driver that implements the HBA driver side of the new interface. The new transfer settings code won't be enabled until we're ready to switch all HBA drivers over to the new interface. src/Makefile.inc1, lib/Makefile: Add libsbuf. It must be built before libcam, since libcam uses sbuf routines. libcam/Makefile: libcam now depends on libsbuf. libsbuf/Makefile: Add a makefile for libsbuf. This pulls in the sbuf sources from sys/kern. bsd.libnames.mk: Add LIBSBUF. camcontrol/Makefile: Add -lsbuf. Since camcontrol is statically linked, we can't depend on the dynamic linker to pull in libsbuf. camcontrol.c: Use cam_error_print() instead of checking for CAM_SCSI_STATUS_ERROR on every failed CCB. sbuf.9: Change the prototypes for sbuf_cat() and sbuf_cpy() so that the source string is now a const char *. This is more in line wth the standard system string functions, and helps eliminate warnings when dealing with a const source buffer. Fix a typo. cam.c: Add description strings for the various CAM error status values, as well as routines to look up those strings. Add new cam_error_string() and cam_error_print() routines for userland and the kernel. cam.h: Add a new CAM flag, CAM_RETRY_SELTO. Add enumerated types for the various options available with cam_error_print() and cam_error_string(). cam_ccb.h: Add new transfer negotiation structures/types. Change inq_len in the ccb_getdev structure to be "reserved". This field has never been filled in, and will be removed when we next bump the CAM version. cam_debug.h: Fix typo. cam_periph.c: Modularize cam_periph_error(). The SCSI error handling part of cam_periph_error() is now in camperiphscsistatuserror() and camperiphscsisenseerror(). In cam_periph_lock(), increase the reference count on the periph while we wait for our lock attempt to succeed so that the periph won't go away while we're sleeping. cam_xpt.c: Add new transfer negotiation code. (ifdefed out) Add a new function, xpt_path_string(). This is a string/sbuf analog to xpt_print_path(). scsi_all.c: Revamp string handing and error printing code. We now use sbufs for much of the string formatting code. More of that code is shared between userland the kernel. scsi_all.h: Get rid of SS_TURSTART, it wasn't terribly useful in the first place. Add a new error action, SS_REQSENSE. (Send a request sense and then retry the command.) This is useful when the controller hasn't performed autosense for some reason. Change the default actions around a bit. scsi_cd.c, scsi_da.c, scsi_pt.c, scsi_ses.c: SF_RETRY_SELTO -> CAM_RETRY_SELTO. Selection timeouts shouldn't be covered by a sense flag. scsi_pass.[ch]: SF_RETRY_SELTO -> CAM_RETRY_SELTO. Get rid of the last vestiges of a read/write interface. libkern/bsearch.c, sys/libkern.h, conf/files: Add bsearch.c, which is needed for some of the new table lookup routines. aic7xxx_freebsd.c: Define AHC_NEW_TRAN_SETTINGS if CAM_NEW_TRAN_CODE is defined. sbuf.h, subr_sbuf.c: Add the appropriate #ifdefs so sbufs can compile and run in userland. Change sbuf_printf() to use vsnprintf() instead of kvprintf(), which is only available in the kernel. Change the source string for sbuf_cpy() and sbuf_cat() to be a const char *. Add __BEGIN_DECLS and __END_DECLS around function prototypes since they're now exported to userland. kdump/mkioctls: Include stdio.h before cam.h since cam.h now includes a function with a FILE * argument. Submitted by: gibbs (mostly) Reviewed by: jdp, marcel (libsbuf makefile changes) Reviewed by: des (sbuf changes) Reviewed by: ken
92 lines
3.1 KiB
C
92 lines
3.1 KiB
C
/*
|
|
* Macros for tracing/loging information in the CAM layer
|
|
*
|
|
* 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.
|
|
*
|
|
* $FreeBSD$
|
|
*/
|
|
#ifndef _CAM_CAM_DEBUG_H
|
|
#define _CAM_CAM_DEBUG_H 1
|
|
|
|
#if defined(CAMDEBUG) && defined(_KERNEL)
|
|
#include <machine/clock.h>
|
|
#endif /* CAMDEBUG && _KERNEL */
|
|
|
|
/*
|
|
* 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_flags;
|
|
|
|
#if defined(CAMDEBUG) && defined(_KERNEL)
|
|
|
|
/* Path we want to debug */
|
|
extern struct cam_path *cam_dpath;
|
|
/* Current debug levels set */
|
|
extern u_int32_t cam_dflags;
|
|
/* Printf delay value (to prevent scrolling) */
|
|
extern u_int32_t cam_debug_delay;
|
|
|
|
/* Debugging macros. */
|
|
#define CAM_DEBUGGED(path, flag) \
|
|
((cam_dflags & (flag)) \
|
|
&& (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_dflags & (flag)) \
|
|
&& (cam_dpath != NULL) \
|
|
&& (xpt_path_comp(cam_dpath, path) >= 0) \
|
|
&& (xpt_path_comp(cam_dpath, path) < 2)) { \
|
|
xpt_print_path(path); \
|
|
printf printfargs; \
|
|
if (cam_debug_delay != 0) \
|
|
DELAY(cam_debug_delay); \
|
|
}
|
|
#define CAM_DEBUG_PRINT(flag, printfargs) \
|
|
if (cam_dflags & (flag)) { \
|
|
printf("cam_debug: "); \
|
|
printf printfargs; \
|
|
if (cam_debug_delay != 0) \
|
|
DELAY(cam_debug_delay); \
|
|
}
|
|
|
|
#else /* !CAMDEBUG || !_KERNEL */
|
|
|
|
#define CAM_DEBUGGED(A, B) 0
|
|
#define CAM_DEBUG(A, B, C)
|
|
#define CAM_DEBUG_PRINT(A, B)
|
|
|
|
#endif /* CAMDEBUG && _KERNEL */
|
|
|
|
#endif /* _CAM_CAM_DEBUG_H */
|