mirror of
https://github.com/SCST-project/scst.git
synced 2026-05-16 10:11:28 +00:00
5a9a0ad491
- SCST_USER_UNREGISTER_DEVICE - to unregister device, flush mem reuse (SGV) cache and send UCMD_STATE_ON_CACHE_FREEING notifications for all freed buffers to the user space handler. Simple device close doesn't allow that, so all the cached buffers might look as "leaked" from the user space handler POV. - SCST_USER_FLUSH_CACHE - to flush mem reuse (SGV) cache and send UCMD_STATE_ON_CACHE_FREEING notifications for all freed buffers to the user space handler + some cosmetics Docs update is coming git-svn-id: http://svn.code.sf.net/p/scst/svn/trunk@665 d57e44dd-8a1f-0410-8b47-8ef2f437770f
290 lines
7.2 KiB
C
290 lines
7.2 KiB
C
/*
|
|
* debug.h
|
|
*
|
|
* Copyright (C) 2004 - 2008 Vladislav Bolkhovitin <vst@vlnb.net>
|
|
* Copyright (C) 2004 - 2005 Leonid Stoljar
|
|
* Copyright (C) 2007 - 2008 CMS Distribution Limited
|
|
*
|
|
* Contains macroses for execution tracing and error reporting
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation, version 2
|
|
* of the License.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*/
|
|
|
|
#ifndef __DEBUG_H
|
|
#define __DEBUG_H
|
|
|
|
#include <sys/types.h>
|
|
#include <linux/unistd.h>
|
|
#include <errno.h>
|
|
|
|
extern pid_t gettid(void);
|
|
|
|
#define sBUG() assert(0)
|
|
#define sBUG_ON(p) assert(!(p))
|
|
|
|
#ifdef EXTRACHECKS
|
|
#define EXTRACHECKS_BUG_ON(a) sBUG_ON(a)
|
|
#else
|
|
#define EXTRACHECKS_BUG_ON(a)
|
|
#endif
|
|
|
|
#define TRACE_NULL 0x00000000
|
|
#define TRACE_DEBUG 0x00000001
|
|
#define TRACE_FUNCTION 0x00000002
|
|
#define TRACE_LINE 0x00000004
|
|
#define TRACE_PID 0x00000008
|
|
#define TRACE_ENTRYEXIT 0x00000010
|
|
#define TRACE_BUFF 0x00000020
|
|
#define TRACE_MEMORY 0x00000040
|
|
#define TRACE_SG 0x00000080
|
|
#define TRACE_OUT_OF_MEM 0x00000100
|
|
#define TRACE_MINOR 0x00000200 /* less important events */
|
|
#define TRACE_MGMT 0x00000400
|
|
#define TRACE_MGMT_MINOR 0x00000800
|
|
#define TRACE_MGMT_DEBUG 0x00001000
|
|
#define TRACE_SCSI 0x00002000
|
|
#define TRACE_SPECIAL 0x00004000 /* filtering debug, etc */
|
|
#define TRACE_TIME 0x00008000
|
|
#define TRACE_ORDER 0x00010000
|
|
#define TRACE_ALL 0xffffffff
|
|
|
|
#define PRINT(format, args...) fprintf(stdout, format "\n", ## args);
|
|
#define PRINTN(format, args...) fprintf(stdout, format, ## args);
|
|
|
|
extern char *app_name;
|
|
#define LOG_PREFIX app_name
|
|
|
|
#ifdef LOG_PREFIX
|
|
#define __LOG_PREFIX LOG_PREFIX
|
|
#else
|
|
#define __LOG_PREFIX NULL
|
|
#endif
|
|
|
|
#if defined(DEBUG) || defined(TRACING)
|
|
|
|
extern unsigned long trace_flag;
|
|
|
|
extern int debug_init(void);
|
|
extern void debug_done(void);
|
|
|
|
extern int debug_print_prefix(unsigned long trace_flag, const char *prefix,
|
|
const char *func, int line);
|
|
extern void debug_print_buffer(const void *data, int len);
|
|
|
|
#define TRACE(trace, format, args...) \
|
|
do { \
|
|
if (trace_flag & (trace)) \
|
|
{ \
|
|
debug_print_prefix(trace_flag, __LOG_PREFIX, __FUNCTION__, \
|
|
__LINE__); \
|
|
PRINT(format, args); \
|
|
} \
|
|
} while(0)
|
|
|
|
#define PRINT_BUFFER(message, buff, len) \
|
|
do { \
|
|
PRINT("%s:", message); \
|
|
debug_print_buffer(buff, len); \
|
|
} while(0)
|
|
|
|
#else /* DEBUG || TRACING */
|
|
|
|
#define TRACE(trace, args...) {}
|
|
#define PRINT_BUFFER(message, buff, len) {}
|
|
|
|
static inline int debug_init(void) { return 0; }
|
|
static inline void debug_done(void) {}
|
|
|
|
#endif /* DEBUG || TRACING */
|
|
|
|
#ifdef DEBUG
|
|
|
|
#include <assert.h>
|
|
|
|
#define TRACE_MEM(format, args...) \
|
|
do { \
|
|
if (trace_flag & TRACE_MEMORY) \
|
|
{ \
|
|
debug_print_prefix(trace_flag, NULL, __FUNCTION__, \
|
|
__LINE__); \
|
|
PRINT(format, args); \
|
|
} \
|
|
} while(0)
|
|
|
|
#define TRACE_DBG(format, args...) \
|
|
do { \
|
|
if (trace_flag & TRACE_DEBUG) \
|
|
{ \
|
|
debug_print_prefix(trace_flag, NULL, __FUNCTION__, \
|
|
__LINE__); \
|
|
PRINT(format, args); \
|
|
} \
|
|
} while(0)
|
|
|
|
#define TRACE_DBG_SPECIAL(args...) TRACE(TRACE_DEBUG|TRACE_SPECIAL, args)
|
|
|
|
#define TRACE_MGMT_DBG(format, args...) \
|
|
do { \
|
|
if (trace_flag & TRACE_MGMT_DEBUG) \
|
|
{ \
|
|
debug_print_prefix(trace_flag, NULL, __FUNCTION__, \
|
|
__LINE__); \
|
|
PRINT(format, args); \
|
|
} \
|
|
} while(0)
|
|
|
|
#define TRACE_BUFFER(message, buff, len) \
|
|
do { \
|
|
if (trace_flag & TRACE_BUFF) \
|
|
{ \
|
|
debug_print_prefix(trace_flag, NULL, __FUNCTION__, \
|
|
__LINE__); \
|
|
PRINT("%s:", message); \
|
|
debug_print_buffer(buff, len); \
|
|
} \
|
|
} while(0)
|
|
|
|
#define TRACE_BUFF_FLAG(flag, message, buff, len) \
|
|
do { \
|
|
if (trace_flag & (flag)) \
|
|
{ \
|
|
debug_print_prefix(trace_flag, NULL, __FUNCTION__, \
|
|
__LINE__); \
|
|
PRINT("%s:", message); \
|
|
debug_print_buffer(buff, len); \
|
|
} \
|
|
} while(0)
|
|
|
|
#define PRINT_ERROR(format, args...) \
|
|
do { \
|
|
debug_print_prefix(trace_flag, __LOG_PREFIX, __FUNCTION__, \
|
|
__LINE__); \
|
|
PRINT("***ERROR*** " format, args); \
|
|
} while(0)
|
|
|
|
#define PRINT_INFO(format, args...) \
|
|
do { \
|
|
debug_print_prefix(trace_flag, __LOG_PREFIX, __FUNCTION__, \
|
|
__LINE__); \
|
|
PRINT(format, args); \
|
|
} while(0)
|
|
|
|
#define TRACE_ENTRY() \
|
|
do { \
|
|
if (trace_flag & TRACE_ENTRYEXIT) \
|
|
{ \
|
|
if (trace_flag & TRACE_PID) \
|
|
{ \
|
|
PRINT("[%d]: ENTRY %s", gettid(), \
|
|
__FUNCTION__); \
|
|
} \
|
|
else \
|
|
{ \
|
|
PRINT("ENTRY %s", __FUNCTION__); \
|
|
} \
|
|
} \
|
|
} while(0)
|
|
|
|
#define TRACE_EXIT() \
|
|
do { \
|
|
if (trace_flag & TRACE_ENTRYEXIT) \
|
|
{ \
|
|
if (trace_flag & TRACE_PID) \
|
|
{ \
|
|
PRINT("[%d]: EXIT %s", gettid(), \
|
|
__FUNCTION__); \
|
|
} \
|
|
else \
|
|
{ \
|
|
PRINT("EXIT %s", __FUNCTION__); \
|
|
} \
|
|
} \
|
|
} while(0)
|
|
|
|
#define TRACE_EXIT_RES(res) \
|
|
do { \
|
|
if (trace_flag & TRACE_ENTRYEXIT) \
|
|
{ \
|
|
if (trace_flag & TRACE_PID) \
|
|
{ \
|
|
PRINT("[%d]: EXIT %s: %ld", gettid(), \
|
|
__FUNCTION__, (long)(res)); \
|
|
} \
|
|
else \
|
|
{ \
|
|
PRINT("EXIT %s: %ld", __FUNCTION__, (long)(res)); \
|
|
} \
|
|
} \
|
|
} while(0)
|
|
|
|
#define TRACE_EXIT_HRES(res) \
|
|
do { \
|
|
if (trace_flag & TRACE_ENTRYEXIT) \
|
|
{ \
|
|
if (trace_flag & TRACE_PID) \
|
|
{ \
|
|
PRINT("[%d]: EXIT %s: 0x%lx", gettid(), \
|
|
__FUNCTION__, (long)(res)); \
|
|
} \
|
|
else \
|
|
{ \
|
|
PRINT("EXIT %s: %lx", __FUNCTION__, (long)(res)); \
|
|
} \
|
|
} \
|
|
} while(0)
|
|
|
|
#else /* DEBUG */
|
|
|
|
#define NDEBUG
|
|
#include <assert.h>
|
|
|
|
#define TRACE_MEM(format, args...) {}
|
|
#define TRACE_DBG(format, args...) {}
|
|
#define TRACE_DBG_SPECIAL(args...) {}
|
|
#define TRACE_MGMT_DBG(format, args...) {}
|
|
#define TRACE_BUFFER(message, buff, len) {}
|
|
#define TRACE_BUFF_FLAG(flag, message, buff, len) {}
|
|
#define TRACE_ENTRY() {}
|
|
#define TRACE_EXIT() {}
|
|
#define TRACE_EXIT_RES(res) {}
|
|
#define TRACE_EXIT_HRES(res) {}
|
|
|
|
#ifdef LOG_PREFIX
|
|
|
|
#define PRINT_INFO(format, args...) \
|
|
do { \
|
|
PRINT("%s: " format, LOG_PREFIX, args); \
|
|
} while(0)
|
|
|
|
#define PRINT_ERROR(format, args...) \
|
|
do { \
|
|
PRINT("%s: ***ERROR*** " \
|
|
format, LOG_PREFIX, args); \
|
|
} while(0)
|
|
|
|
#else
|
|
|
|
#define PRINT_INFO(format, args...) \
|
|
do { \
|
|
PRINT(format, args); \
|
|
} while(0)
|
|
|
|
#define PRINT_ERROR(format, args...) \
|
|
do { \
|
|
PRINT("***ERROR*** " format, args); \
|
|
} while(0)
|
|
|
|
#endif /* LOG_PREFIX */
|
|
|
|
#endif /* DEBUG */
|
|
|
|
#endif /* __DEBUG_H */
|