Files
rocm-systems/rocclr/runtime/utils/debug.hpp
T
foreman 1f0d5016ed P4 to Git Change 2027470 by axie@axie-hip-rocm on 2019/11/08 13:48:51
SWDEV-198863 - Options for hip-clang-vdi path to provide the chicken bits, or functional equivalents to HCC_DB (phase 3)
	Use ClPrint to implement other log functions.
	Move some funtion to use new log functions.
	This is the final change of the JIRA.

	Tests:
	1. Linux HIP ROCM platform. VEGA10. Driver is release build.
	1.1 export LOG_LEVEL=3
	      ./hipModule
	      There are many logs.
	1.2 export GPU_LOG_MASK=0
	     ./hipModule
	     There is no log
	2. Windows HIP PAL platform. VEGA10, Driver is release build.
	2.1 set LOG_LEVEL=3
	    run test hipPrintfKernel
	    There are many logs
	2.2 set GPU_LOG_MASK=0
	    run test hipPrintfKernel
	    There is no log

	3. http://ocltc.amd.com:8111/viewModification.html?modId=128588&personal=true&tab=vcsModificationBuilds

	ReviewBoard: http://ocltc.amd.com/reviews/r/18259/

Affected files ...

... //depot/stg/opencl/drivers/opencl/runtime/device/pal/paldevice.cpp#177 edit
... //depot/stg/opencl/drivers/opencl/runtime/device/pal/palvirtual.cpp#157 edit
... //depot/stg/opencl/drivers/opencl/runtime/utils/debug.cpp#6 edit
... //depot/stg/opencl/drivers/opencl/runtime/utils/debug.hpp#14 edit
2019-11-08 13:54:34 -05:00

196 baris
9.2 KiB
C++

//
// Copyright (c) 2008 Advanced Micro Devices, Inc. All rights reserved.
//
#ifndef DEBUG_HPP_
#define DEBUG_HPP_
#include <cassert>
//! \addtogroup Utils
namespace amd { /*@{*/
enum LogLevel { LOG_NONE = 0, LOG_ERROR = 1, LOG_WARNING = 2, LOG_INFO = 3, LOG_DEBUG = 4 };
enum LogMask {
LOG_API = 0x00000001, //!< API call
LOG_CMD = 0x00000002, //!< Kernel and Copy Commands and Barriers
LOG_WAIT = 0x00000004, //!< Synchronization and waiting for commands to finish
LOG_AQL = 0x00000008, //!< Decode and display AQL packets
LOG_QUEUE = 0x00000010, //!< Queue commands and queue contents
LOG_SIG = 0x00000020, //!< Signal creation, allocation, pool
LOG_LOCK = 0x00000040, //!< Locks and thread-safety code.
LOG_KERN = 0x00000080, //!< kernel creations and arguments, etc.
LOG_COPY = 0x00000100, //!< Copy debug
LOG_COPY2 = 0x00000200, //!< Detailed copy debug
LOG_RESOURCE = 0x00000400, //!< Resource allocation, performance-impacting events.
LOG_INIT = 0x00000800, //!< Initialization and shutdown
LOG_MISC = 0x00001000, //!< misc debug, not yet classified
LOG_AQL2 = 0x00002000, //!< Show raw bytes of AQL packet
LOG_CODE = 0x00004000, //!< Show code creation debug
LOG_CMD2 = 0x00008000, //!< More detailed command info, including barrier commands
LOG_ALWAYS = 0xFFFFFFFF, //!< Log always even mask flag is zero
};
//! \cond ignore
extern "C" void breakpoint();
//! \endcond
//! \brief Report a Fatal exception message and abort.
extern void report_fatal(const char* file, int line, const char* message);
//! \brief Display a warning message.
extern void report_warning(const char* message);
//! \brief Insert a log entry.
extern void log_entry(LogLevel level, const char* file, int line, const char* messsage);
//! \brief Insert a timestamped log entry.
extern void log_timestamped(LogLevel level, const char* file, int line, const char* messsage);
//! \brief Insert a printf-style log entry.
extern void log_printf(LogLevel level, const char* file, int line, const char* format, ...);
/*@}*/} // namespace amd
#if __INTEL_COMPILER
// Disable ICC's warning #279: controlling expression is constant
// (0!=1 && "msg")
// ^
#pragma warning(disable : 279)
#endif // __INTEL_COMPILER
//! \brief Abort the program if the invariant \a cond is false.
#define guarantee(cond) \
if (!(cond)) { \
amd::report_fatal(__FILE__, __LINE__, "guarantee(" XSTR(cond) ")"); \
amd::breakpoint(); \
}
#define fixme_guarantee(cond) guarantee(cond)
//! \brief Abort the program with a fatal error message.
#define fatal(msg) \
do { \
assert(false && msg); \
} while (0)
//! \brief Display a warning message.
inline void warning(const char* msg) { amd::report_warning(msg); }
/*! \brief Abort the program with a "ShouldNotReachHere" message.
* \hideinitializer
*/
#define ShouldNotReachHere() fatal("ShouldNotReachHere()")
/*! \brief Abort the program with a "ShouldNotCallThis" message.
* \hideinitializer
*/
#define ShouldNotCallThis() fatal("ShouldNotCallThis()")
/*! \brief Abort the program with an "Unimplemented" message.
* \hideinitializer
*/
#define Unimplemented() fatal("Unimplemented()")
/*! \brief Display an "Untested" warning message.
* \hideinitializer
*/
#ifndef NDEBUG
#define Untested(msg) warning("Untested(\"" msg "\")")
#else /*NDEBUG*/
#define Untested(msg) (void)(0)
#endif /*NDEBUG*/
#define Log(level, msg) \
do { \
if (LOG_LEVEL >= level) { \
amd::log_entry(level, __FILE__, __LINE__, msg); \
} \
} while (false)
#define LogTS(level, msg) \
do { \
if (LOG_LEVEL >= level) { \
amd::log_timestamped(level, __FILE__, __LINE__, msg); \
} \
} while (false)
#define Logf(level, format, ...) \
do { \
if (LOG_LEVEL >= level) { \
amd::log_printf(level, __FILE__, __LINE__, format, __VA_ARGS__); \
} \
} while (false)
#define CondLog(cond, msg) \
do { \
if (false DEBUG_ONLY(|| (cond))) { \
Log(amd::LOG_INFO, msg); \
} \
} while (false)
#define LogGuarantee(cond, level, msg) \
do { \
if (LOG_LEVEL >= level) { \
guarantee(cond); \
} \
} while (false)
#define LogTSInfo(msg) LogTS(amd::LOG_INFO, msg)
#define LogTSError(msg) LogTS(amd::LOG_ERROR, msg)
#define LogTSWarning(msg) LogTS(amd::LOG_WARNING, msg)
#define DebugInfoGuarantee(cond) LogGuarantee(cond, amd::LOG_INFO, "Warning")
/* backend and compiler use LOG_LEVEL macro from makefile. Define GPU_LOG_MASK for them. */
#if defined(LOG_LEVEL)
#define GPU_LOG_MASK 0x7FFFFFFF
#endif
// You may define CL_LOG to enable following log functions even for release build
#define CL_LOG
#ifdef CL_LOG
#define ClPrint(level, mask, format, ...) \
do { \
if (LOG_LEVEL >= level) { \
if (GPU_LOG_MASK & mask || mask == amd::LOG_ALWAYS) { \
amd::log_printf(level, __FILE__, __LINE__, format, ##__VA_ARGS__); \
} \
} \
} while (false)
#define ClCondPrint(level, mask, condition, format, ...) \
do { \
if (LOG_LEVEL >= level && (condition)) { \
if (GPU_LOG_MASK & mask || mask == amd::LOG_ALWAYS) { \
amd::log_printf(level, __FILE__, __LINE__, format, ##__VA_ARGS__); \
} \
} \
} while (false)
#else /*CL_LOG*/
#define ClPrint(level, mask, format, ...) (void)(0)
#define ClCondPrint(level, mask, condition, format, ...) (void)(0)
#endif /*CL_LOG*/
#define ClTrace(level, mask) ClPrint(level, mask, "%s", __func__)
#define LogInfo(msg) ClPrint(amd::LOG_INFO, amd::LOG_ALWAYS, msg)
#define LogError(msg) ClPrint(amd::LOG_ERROR, amd::LOG_ALWAYS, msg)
#define LogWarning(msg) ClPrint(amd::LOG_WARNING, amd::LOG_ALWAYS, msg)
#define LogPrintfDebug(format, ...) ClPrint(amd::LOG_DEBUG, amd::LOG_ALWAYS, format, __VA_ARGS__)
#define LogPrintfError(format, ...) ClPrint(amd::LOG_ERROR, amd::LOG_ALWAYS, format, __VA_ARGS__)
#define LogPrintfWarning(format, ...) ClPrint(amd::LOG_WARNING, amd::LOG_ALWAYS, format, __VA_ARGS__)
#define LogPrintfInfo(format, ...) ClPrint(amd::LOG_INFO, amd::LOG_ALWAYS, format, __VA_ARGS__)
#endif /*DEBUG_HPP_*/