a23fd118e437af0a7877dd313db8fdaa3537c675yl * CDDL HEADER START
a23fd118e437af0a7877dd313db8fdaa3537c675yl * The contents of this file are subject to the terms of the
a23fd118e437af0a7877dd313db8fdaa3537c675yl * Common Development and Distribution License (the "License").
a23fd118e437af0a7877dd313db8fdaa3537c675yl * You may not use this file except in compliance with the License.
a23fd118e437af0a7877dd313db8fdaa3537c675yl * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
a23fd118e437af0a7877dd313db8fdaa3537c675yl * See the License for the specific language governing permissions
a23fd118e437af0a7877dd313db8fdaa3537c675yl * and limitations under the License.
a23fd118e437af0a7877dd313db8fdaa3537c675yl * When distributing Covered Code, include this CDDL HEADER in each
a23fd118e437af0a7877dd313db8fdaa3537c675yl * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
a23fd118e437af0a7877dd313db8fdaa3537c675yl * If applicable, add the following below this CDDL HEADER, with the
a23fd118e437af0a7877dd313db8fdaa3537c675yl * fields enclosed by brackets "[]" replaced with your own identifying
a23fd118e437af0a7877dd313db8fdaa3537c675yl * information: Portions Copyright [yyyy] [name of copyright owner]
a23fd118e437af0a7877dd313db8fdaa3537c675yl * CDDL HEADER END
8347601bcb0a439f6e50fc36b4039a73d08700e1yl * Copyright (c) 2002-2006 Neterion, Inc.
7eced415e5dd557aef2d78483b5a7785f0e13670xw * __FUNCTION__ is, together with __PRETTY_FUNCTION__ or something similar,
7eced415e5dd557aef2d78483b5a7785f0e13670xw * a gcc extension. we'll have to #ifdef around that, and provide some
7eced415e5dd557aef2d78483b5a7785f0e13670xw * meaningful replacement for those, so to make some gcc versions happier
a23fd118e437af0a7877dd313db8fdaa3537c675yl * enum xge_debug_level_e
a23fd118e437af0a7877dd313db8fdaa3537c675yl * @XGE_NONE: debug disabled
a23fd118e437af0a7877dd313db8fdaa3537c675yl * @XGE_ERR: all errors going to be logged out
a23fd118e437af0a7877dd313db8fdaa3537c675yl * @XGE_TRACE: all errors plus all kind of verbose tracing print outs
a23fd118e437af0a7877dd313db8fdaa3537c675yl * going to be logged out. Very noisy.
a23fd118e437af0a7877dd313db8fdaa3537c675yl * This enumeration going to be used to switch between different
a23fd118e437af0a7877dd313db8fdaa3537c675yl * debug levels during runtime if DEBUG macro defined during
a23fd118e437af0a7877dd313db8fdaa3537c675yl * compilation. If DEBUG macro not defined than code will be
a23fd118e437af0a7877dd313db8fdaa3537c675yl * compiled out.
a23fd118e437af0a7877dd313db8fdaa3537c675yl#if defined(XGE_DEBUG_TRACE_MASK) || defined(XGE_DEBUG_ERR_MASK)
7eced415e5dd557aef2d78483b5a7785f0e13670xwextern unsigned long *g_module_mask;
a23fd118e437af0a7877dd313db8fdaa3537c675ylextern int *g_level;
a23fd118e437af0a7877dd313db8fdaa3537c675yl * @XGE_COMPONENT_HAL_CONFIG: do debug for xge core config module
a23fd118e437af0a7877dd313db8fdaa3537c675yl * @XGE_COMPONENT_HAL_FIFO: do debug for xge core fifo module
a23fd118e437af0a7877dd313db8fdaa3537c675yl * @XGE_COMPONENT_HAL_RING: do debug for xge core ring module
a23fd118e437af0a7877dd313db8fdaa3537c675yl * @XGE_COMPONENT_HAL_CHANNEL: do debug for xge core channel module
a23fd118e437af0a7877dd313db8fdaa3537c675yl * @XGE_COMPONENT_HAL_DEVICE: do debug for xge core device module
8347601bcb0a439f6e50fc36b4039a73d08700e1yl * @XGE_COMPONENT_HAL_DMQ: do debug for xge core DMQ module
8347601bcb0a439f6e50fc36b4039a73d08700e1yl * @XGE_COMPONENT_HAL_UMQ: do debug for xge core UMQ module
8347601bcb0a439f6e50fc36b4039a73d08700e1yl * @XGE_COMPONENT_HAL_SQ: do debug for xge core SQ module
8347601bcb0a439f6e50fc36b4039a73d08700e1yl * @XGE_COMPONENT_HAL_SRQ: do debug for xge core SRQ module
7eced415e5dd557aef2d78483b5a7785f0e13670xw * @XGE_COMPONENT_HAL_CQRQ: do debug for xge core CRQ module
7eced415e5dd557aef2d78483b5a7785f0e13670xw * @XGE_COMPONENT_HAL_POOL: do debug for xge core memory pool module
7eced415e5dd557aef2d78483b5a7785f0e13670xw * @XGE_COMPONENT_HAL_BITMAP: do debug for xge core BITMAP module
a23fd118e437af0a7877dd313db8fdaa3537c675yl * @XGE_COMPONENT_CORE: do debug for xge KMA core module
a23fd118e437af0a7877dd313db8fdaa3537c675yl * @XGE_COMPONENT_OSDEP: do debug for xge KMA os dependent parts
a23fd118e437af0a7877dd313db8fdaa3537c675yl * @XGE_COMPONENT_LL: do debug for xge link layer module
a23fd118e437af0a7877dd313db8fdaa3537c675yl * @XGE_COMPONENT_ALL: activate debug for all modules with no exceptions
a23fd118e437af0a7877dd313db8fdaa3537c675yl * This enumeration going to be used to distinguish modules
a23fd118e437af0a7877dd313db8fdaa3537c675yl * or libraries during compilation and runtime. Makefile must declare
a23fd118e437af0a7877dd313db8fdaa3537c675yl * XGE_DEBUG_MODULE_MASK macro and set it to proper value.
a23fd118e437af0a7877dd313db8fdaa3537c675yl /* space for CORE_XXX */
a23fd118e437af0a7877dd313db8fdaa3537c675yl#error "XGE_DEBUG_MODULE_MASK macro must be defined for DEBUG mode..."
a23fd118e437af0a7877dd313db8fdaa3537c675yl #define xge_trace_aux(fmt) xge_os_vatrace(g_xge_os_tracebuf, fmt)
a23fd118e437af0a7877dd313db8fdaa3537c675yl * xge_debug
a23fd118e437af0a7877dd313db8fdaa3537c675yl * @level: level of debug verbosity.
a23fd118e437af0a7877dd313db8fdaa3537c675yl * @fmt: printf like format string
a23fd118e437af0a7877dd313db8fdaa3537c675yl * Provides logging facilities. Can be customized on per-module
a23fd118e437af0a7877dd313db8fdaa3537c675yl * basis or/and with debug levels. Input parameters, except
a23fd118e437af0a7877dd313db8fdaa3537c675yl * module and level, are the same as posix printf. This function
a23fd118e437af0a7877dd313db8fdaa3537c675yl * may be compiled out if DEBUG macro was never defined.
a23fd118e437af0a7877dd313db8fdaa3537c675yl * See also: xge_debug_level_e{}.
a23fd118e437af0a7877dd313db8fdaa3537c675ylif (((level >= XGE_TRACE && ((module & XGE_DEBUG_TRACE_MASK) == module)) || \
a23fd118e437af0a7877dd313db8fdaa3537c675yl (level >= XGE_ERR && ((module & XGE_DEBUG_ERR_MASK) == module))) && \
7eced415e5dd557aef2d78483b5a7785f0e13670xw level >= *g_level && module & *(unsigned int *)g_module_mask) { \
a23fd118e437af0a7877dd313db8fdaa3537c675yl#else /* __GNUC__ */
a23fd118e437af0a7877dd313db8fdaa3537c675yl #define xge_trace_aux(fmt...) xge_os_trace(g_xge_os_tracebuf, fmt)
a23fd118e437af0a7877dd313db8fdaa3537c675ylif (((level >= XGE_TRACE && ((module & XGE_DEBUG_TRACE_MASK) == module)) || \
a23fd118e437af0a7877dd313db8fdaa3537c675yl (level >= XGE_ERR && ((module & XGE_DEBUG_ERR_MASK) == module))) && \
7eced415e5dd557aef2d78483b5a7785f0e13670xw level >= *g_level && module & *(unsigned int *)g_module_mask) { \
a23fd118e437af0a7877dd313db8fdaa3537c675yl#endif /* __GNUC__ */
a23fd118e437af0a7877dd313db8fdaa3537c675ylstatic inline void xge_debug_stats(xge_debug_level_e level, char *fmt, ...) {
a23fd118e437af0a7877dd313db8fdaa3537c675yl#else /* __GNUC__ */
a23fd118e437af0a7877dd313db8fdaa3537c675yl#endif /* __GNUC__ */
a23fd118e437af0a7877dd313db8fdaa3537c675ylstatic inline void xge_debug_stats(xge_debug_level_e level, char *fmt, ...) {}
a23fd118e437af0a7877dd313db8fdaa3537c675yl#else /* __GNUC__ */
a23fd118e437af0a7877dd313db8fdaa3537c675yl#endif /* __GNUC__ */
7eced415e5dd557aef2d78483b5a7785f0e13670xw/* Interrupt Related */
7eced415e5dd557aef2d78483b5a7785f0e13670xwstatic inline void xge_debug_interrupt(xge_debug_level_e level, char *fmt, ...) {
7eced415e5dd557aef2d78483b5a7785f0e13670xw#else /* __GNUC__ */
7eced415e5dd557aef2d78483b5a7785f0e13670xw#endif /* __GNUC__ */
7eced415e5dd557aef2d78483b5a7785f0e13670xwstatic inline void xge_debug_interrupt(xge_debug_level_e level, char *fmt, ...) {}
7eced415e5dd557aef2d78483b5a7785f0e13670xw#else /* __GNUC__ */
7eced415e5dd557aef2d78483b5a7785f0e13670xw#endif /* __GNUC__ */
a23fd118e437af0a7877dd313db8fdaa3537c675ylstatic inline void xge_debug_queue(xge_debug_level_e level, char *fmt, ...) {
a23fd118e437af0a7877dd313db8fdaa3537c675yl#else /* __GNUC__ */
a23fd118e437af0a7877dd313db8fdaa3537c675yl#endif /* __GNUC__ */
a23fd118e437af0a7877dd313db8fdaa3537c675ylstatic inline void xge_debug_queue(xge_debug_level_e level, char *fmt,
a23fd118e437af0a7877dd313db8fdaa3537c675yl#else /* __GNUC__ */
a23fd118e437af0a7877dd313db8fdaa3537c675yl#endif /* __GNUC__ */
a23fd118e437af0a7877dd313db8fdaa3537c675ylstatic inline void xge_debug_mm(xge_debug_level_e level, char *fmt, ...)
a23fd118e437af0a7877dd313db8fdaa3537c675yl#else /* __GNUC__ */
a23fd118e437af0a7877dd313db8fdaa3537c675yl#endif /* __GNUC__ */
a23fd118e437af0a7877dd313db8fdaa3537c675ylstatic inline void xge_debug_mm(xge_debug_level_e level, char *fmt, ...)
a23fd118e437af0a7877dd313db8fdaa3537c675yl#else /* __GNUC__ */
a23fd118e437af0a7877dd313db8fdaa3537c675yl#endif /* __GNUC__ */
a23fd118e437af0a7877dd313db8fdaa3537c675ylstatic inline void xge_debug_config(xge_debug_level_e level, char *fmt, ...) {
a23fd118e437af0a7877dd313db8fdaa3537c675yl#else /* __GNUC__ */
a23fd118e437af0a7877dd313db8fdaa3537c675yl#endif /* __GNUC__ */
a23fd118e437af0a7877dd313db8fdaa3537c675ylstatic inline void xge_debug_config(xge_debug_level_e level, char *fmt,
a23fd118e437af0a7877dd313db8fdaa3537c675yl#else /* __GNUC__ */
a23fd118e437af0a7877dd313db8fdaa3537c675yl#endif /* __GNUC__ */
a23fd118e437af0a7877dd313db8fdaa3537c675ylstatic inline void xge_debug_fifo(xge_debug_level_e level, char *fmt, ...) {
a23fd118e437af0a7877dd313db8fdaa3537c675yl#else /* __GNUC__ */
a23fd118e437af0a7877dd313db8fdaa3537c675yl#endif /* __GNUC__ */
a23fd118e437af0a7877dd313db8fdaa3537c675ylstatic inline void xge_debug_fifo(xge_debug_level_e level, char *fmt, ...) {}
a23fd118e437af0a7877dd313db8fdaa3537c675yl#else /* __GNUC__ */
a23fd118e437af0a7877dd313db8fdaa3537c675yl#endif /* __GNUC__ */
a23fd118e437af0a7877dd313db8fdaa3537c675ylstatic inline void xge_debug_ring(xge_debug_level_e level, char *fmt, ...) {
a23fd118e437af0a7877dd313db8fdaa3537c675yl#else /* __GNUC__ */
a23fd118e437af0a7877dd313db8fdaa3537c675yl#endif /* __GNUC__ */
a23fd118e437af0a7877dd313db8fdaa3537c675ylstatic inline void xge_debug_ring(xge_debug_level_e level, char *fmt, ...) {}
a23fd118e437af0a7877dd313db8fdaa3537c675yl#else /* __GNUC__ */
a23fd118e437af0a7877dd313db8fdaa3537c675yl#endif /* __GNUC__ */
a23fd118e437af0a7877dd313db8fdaa3537c675ylstatic inline void xge_debug_channel(xge_debug_level_e level, char *fmt, ...) {
a23fd118e437af0a7877dd313db8fdaa3537c675yl#else /* __GNUC__ */
a23fd118e437af0a7877dd313db8fdaa3537c675yl#endif /* __GNUC__ */
a23fd118e437af0a7877dd313db8fdaa3537c675ylstatic inline void xge_debug_channel(xge_debug_level_e level, char *fmt, ...) {}
a23fd118e437af0a7877dd313db8fdaa3537c675yl#else /* __GNUC__ */
a23fd118e437af0a7877dd313db8fdaa3537c675yl#endif /* __GNUC__ */
a23fd118e437af0a7877dd313db8fdaa3537c675ylstatic inline void xge_debug_device(xge_debug_level_e level, char *fmt, ...) {
a23fd118e437af0a7877dd313db8fdaa3537c675yl#else /* __GNUC__ */
a23fd118e437af0a7877dd313db8fdaa3537c675yl#endif /* __GNUC__ */
a23fd118e437af0a7877dd313db8fdaa3537c675ylstatic inline void xge_debug_device(xge_debug_level_e level, char *fmt, ...) {}
a23fd118e437af0a7877dd313db8fdaa3537c675yl#else /* __GNUC__ */
a23fd118e437af0a7877dd313db8fdaa3537c675yl#endif /* __GNUC__ */
a23fd118e437af0a7877dd313db8fdaa3537c675ylstatic inline void xge_debug_osdep(xge_debug_level_e level, char *fmt, ...) {
a23fd118e437af0a7877dd313db8fdaa3537c675yl#else /* __GNUC__ */
a23fd118e437af0a7877dd313db8fdaa3537c675yl#endif /* __GNUC__ */
a23fd118e437af0a7877dd313db8fdaa3537c675ylstatic inline void xge_debug_osdep(xge_debug_level_e level, char *fmt, ...) {}
a23fd118e437af0a7877dd313db8fdaa3537c675yl#else /* __GNUC__ */
a23fd118e437af0a7877dd313db8fdaa3537c675yl#endif /* __GNUC__ */
a23fd118e437af0a7877dd313db8fdaa3537c675ylstatic inline void xge_debug_ll(xge_debug_level_e level, char *fmt, ...)
a23fd118e437af0a7877dd313db8fdaa3537c675yl#else /* __GNUC__ */
a23fd118e437af0a7877dd313db8fdaa3537c675yl#endif /* __GNUC__ */
a23fd118e437af0a7877dd313db8fdaa3537c675ylstatic inline void xge_debug_ll(xge_debug_level_e level, char *fmt, ...) {}
a23fd118e437af0a7877dd313db8fdaa3537c675yl#else /* __GNUC__ */
a23fd118e437af0a7877dd313db8fdaa3537c675yl#endif /* __GNUC__ */
7eced415e5dd557aef2d78483b5a7785f0e13670xwstatic inline void xge_debug_interrupt(xge_debug_level_e level, char *fmt, ...) {}
a23fd118e437af0a7877dd313db8fdaa3537c675ylstatic inline void xge_debug_stats(xge_debug_level_e level, char *fmt, ...) {}
a23fd118e437af0a7877dd313db8fdaa3537c675ylstatic inline void xge_debug_queue(xge_debug_level_e level, char *fmt, ...) {}
a23fd118e437af0a7877dd313db8fdaa3537c675ylstatic inline void xge_debug_mm(xge_debug_level_e level, char *fmt, ...) {}
a23fd118e437af0a7877dd313db8fdaa3537c675ylstatic inline void xge_debug_config(xge_debug_level_e level, char *fmt, ...) {}
a23fd118e437af0a7877dd313db8fdaa3537c675ylstatic inline void xge_debug_fifo(xge_debug_level_e level, char *fmt, ...) {}
a23fd118e437af0a7877dd313db8fdaa3537c675ylstatic inline void xge_debug_ring(xge_debug_level_e level, char *fmt, ...) {}
a23fd118e437af0a7877dd313db8fdaa3537c675ylstatic inline void xge_debug_channel(xge_debug_level_e level, char *fmt, ...) {}
a23fd118e437af0a7877dd313db8fdaa3537c675ylstatic inline void xge_debug_device(xge_debug_level_e level, char *fmt, ...) {}
a23fd118e437af0a7877dd313db8fdaa3537c675ylstatic inline void xge_debug_hal(xge_debug_level_e level, char *fmt, ...) {}
a23fd118e437af0a7877dd313db8fdaa3537c675ylstatic inline void xge_debug_osdep(xge_debug_level_e level, char *fmt, ...) {}
a23fd118e437af0a7877dd313db8fdaa3537c675ylstatic inline void xge_debug_ll(xge_debug_level_e level, char *fmt, ...) {}
a23fd118e437af0a7877dd313db8fdaa3537c675yl#endif /* end of XGE_DEBUG_*_MASK */
a23fd118e437af0a7877dd313db8fdaa3537c675yl * xge_assert
a23fd118e437af0a7877dd313db8fdaa3537c675yl * @test: C-condition to check
a23fd118e437af0a7877dd313db8fdaa3537c675yl * @fmt: printf like format string
a23fd118e437af0a7877dd313db8fdaa3537c675yl * This function implements traditional assert. By default assertions
a23fd118e437af0a7877dd313db8fdaa3537c675yl * are enabled. It can be disabled by defining XGE_DEBUG_ASSERT macro in
a23fd118e437af0a7877dd313db8fdaa3537c675yl * compilation
a23fd118e437af0a7877dd313db8fdaa3537c675yl if (!(test)) xge_os_bug("bad cond: "#test" at %s:%d\n", \
a23fd118e437af0a7877dd313db8fdaa3537c675yl#endif /* end of XGE_DEBUG_ASSERT */
a23fd118e437af0a7877dd313db8fdaa3537c675yl#endif /* XGE_DEBUG_H */