log.h revision e2cc15c0a51069f593b9acae158291f5b0fe8cc5
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * IPRT - Logging.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Copyright (C) 2006-2012 Oracle Corporation
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * available from http://www.virtualbox.org. This file is free software;
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * you can redistribute it and/or modify it under the terms of the GNU
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * General Public License (GPL) as published by the Free Software
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * The contents of this file may alternatively be used under the terms
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * of the Common Development and Distribution License Version 1.0
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * VirtualBox OSE distribution, in which case the provisions of the
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * CDDL are applicable instead of those of the GPL.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * You may elect to license modified versions of this file under the
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * terms and conditions of either the GPL or the CDDL or both.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @defgroup grp_rt_log RTLog - Logging
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @ingroup grp_rt
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * IPRT Logging Groups.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * (Remember to update RT_LOGGROUP_NAMES!)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @remark It should be pretty obvious, but just to have
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * mentioned it, the values are sorted alphabetically (using the
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * english alphabet) except for _DEFAULT which is always first.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * If anyone might be wondering what the alphabet looks like:
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * a b c d e f g h i j k l m n o p q r s t u v w x y z
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Default logging group. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def RT_LOGGROUP_NAMES
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * IPRT Logging group names.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Must correspond 100% to RTLOGGROUP!
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Don't forget commas!
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @remark It should be pretty obvious, but just to have
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * mentioned it, the values are sorted alphabetically (using the
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * english alphabet) except for _DEFAULT which is always first.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * If anyone might be wondering what the alphabet looks like:
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * a b c d e f g h i j k l m n o p q r s t u v w x y z
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync "DEFAULT", \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync "RT_DBG", \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync "RT_DBG_DWARF", \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync "RT_DIR", \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync "RT_FILE", \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync "RT_LDR", \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync "RT_PATH", \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync "RT_PROCESS", \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync "RT_SYMLINK", \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync "RT_THREAD", \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync "RT_TIME", \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync "RT_TIMER", \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LOG_GROUP
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Active logging group.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LOG_INSTANCE
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Active logging instance.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LOG_REL_INSTANCE
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Active release logging instance.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LOG_FN_FMT
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * You can use this to specify you desired way of printing __PRETTY_FUNCTION__
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * if you dislike the default one.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** Logger structure. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** Pointer to logger structure. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** Pointer to const logger structure. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** Guest context logger structure. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** Pointer to guest context logger structure. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** Pointer to const guest context logger structure. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Logger phase.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Used for signalling the log header/footer callback what to do.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Begin of the logging. */
9540eeb13face31ddc1c5f15338556fe46f18a77vboxsync /** End of the logging. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Before rotating the log file. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** After rotating the log file. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** 32-bit type blow up hack. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Logger function.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param pszFormat Format string.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param ... Optional arguments as specified in the format string.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsynctypedef DECLCALLBACK(void) FNRTLOGGER(const char *pszFormat, ...);
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** Pointer to logger function. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Flush function.
9540eeb13face31ddc1c5f15338556fe46f18a77vboxsync * @param pLogger Pointer to the logger instance which is to be flushed.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsynctypedef DECLCALLBACK(void) FNRTLOGFLUSH(PRTLOGGER pLogger);
9540eeb13face31ddc1c5f15338556fe46f18a77vboxsync/** Pointer to flush function. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Flush function.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param pLogger Pointer to the logger instance which is to be flushed.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsynctypedef DECLCALLBACK(void) FNRTLOGFLUSHGC(PRTLOGGERRC pLogger);
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** Pointer to logger function. */
9540eeb13face31ddc1c5f15338556fe46f18a77vboxsynctypedef RCPTRTYPE(FNRTLOGFLUSHGC *) PFNRTLOGFLUSHGC;
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Header/footer message callback.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param pLogger Pointer to the logger instance.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param pszFormat Format string.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param ... Optional arguments specified in the format string.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsynctypedef DECLCALLBACK(void) FNRTLOGPHASEMSG(PRTLOGGER pLogger, const char *pszFormat, ...);
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** Pointer to header/footer message callback function. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Log file header/footer callback.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param pLogger Pointer to the logger instance.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param enmLogPhase Indicates at what time the callback is invoked.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param pfnLogPhaseMsg Callback for writing the header/footer (RTLogPrintf
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * and others are out of bounds).
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsynctypedef DECLCALLBACK(void) FNRTLOGPHASE(PRTLOGGER pLogger, RTLOGPHASE enmLogPhase, PFNRTLOGPHASEMSG pfnLogPhaseMsg);
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** Pointer to log header/footer callback function. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Custom log prefix callback.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @returns The number of chars written.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param pLogger Pointer to the logger instance.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param pchBuf Output buffer pointer.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * No need to terminate the output.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param cchBuf The size of the output buffer.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param pvUser The user argument.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsynctypedef DECLCALLBACK(size_t) FNRTLOGPREFIX(PRTLOGGER pLogger, char *pchBuf, size_t cchBuf, void *pvUser);
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** Pointer to prefix callback function. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Logger instance structure for GC.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Pointer to temporary scratch buffer.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * This is used to format the log messages. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Current scratch buffer position. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** This is set if a prefix is pending. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Pointer to the logger function.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * This is actually pointer to a wrapper which will push a pointer to the
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * instance pointer onto the stack before jumping to the real logger function.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * A very unfortunate hack to work around the missing variadic macro support in C++. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Pointer to the flush function. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Magic number (RTLOGGERRC_MAGIC). */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Logger instance flags - RTLOGFLAGS. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Number of groups in the afGroups member. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Group flags array - RTLOGGRPFLAGS.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * This member have variable length and may extend way beyond
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * the declared size of 1 entry. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** RTLOGGERRC::u32Magic value. (John Rogers Searle) */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** Pointer to internal logger bits. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Logger instance structure.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Pointer to temporary scratch buffer.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * This is used to format the log messages. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Current scratch buffer position. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Magic number. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Logger instance flags - RTLOGFLAGS. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Destination flags - RTLOGDEST. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Pointer to the internal bits of the logger.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * (The memory is allocated in the same block as RTLOGGER.) */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Pointer to the logger function (used in non-C99 mode only).
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * This is actually pointer to a wrapper which will push a pointer to the
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * instance pointer onto the stack before jumping to the real logger function.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * A very unfortunate hack to work around the missing variadic macro
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * support in older C++/C standards. (The memory is allocated using
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * RTMemExecAlloc(), except for agnostic R0 code.) */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Number of groups in the afGroups and papszGroups members. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Group flags array - RTLOGGRPFLAGS.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * This member have variable length and may extend way beyond
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * the declared size of 1 entry. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** RTLOGGER::u32Magic value. (Avram Noam Chomsky) */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#endif /* !IN_RC */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Logger flags.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** The logger instance is disabled for normal output. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** The logger instance is using buffered output. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** The logger instance expands LF to CR/LF. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Append to the log destination where applicable. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Show relative timestamps with PREFIX_TSC and PREFIX_TS */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Show decimal timestamps with PREFIX_TSC and PREFIX_TS */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Open the file in write through mode. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Flush the file to disk when flushing the buffer. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Restrict the number of log entries per group. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** New lines should be prefixed with the write and read lock counts. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** New lines should be prefixed with the CPU id (ApicID on intel/amd). */
23603ed361f22874964e3a841add2c58ec2bb1eavboxsync /** New lines should be prefixed with the native process id. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** New lines should be prefixed with group flag number causing the output. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** New lines should be prefixed with group flag name causing the output. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** New lines should be prefixed with group number. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** New lines should be prefixed with group name. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** New lines should be prefixed with the native thread id. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** New lines should be prefixed with thread name. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** New lines should be prefixed with data from a custom callback. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** New lines should be prefixed with formatted timestamp since program start. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** New lines should be prefixed with formatted timestamp (UCT). */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** New lines should be prefixed with milliseconds since program start. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** New lines should be prefixed with timestamp. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** New lines should be prefixed with timestamp. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** The prefix mask. */
36fbf6dcd3e6b2e5891456b730577ff0eb355c9fvboxsync * Logger per group flags.
36fbf6dcd3e6b2e5891456b730577ff0eb355c9fvboxsync /** Enabled. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Level 1 logging. */
36fbf6dcd3e6b2e5891456b730577ff0eb355c9fvboxsync /** Level 2 logging. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Level 3 logging. */
36fbf6dcd3e6b2e5891456b730577ff0eb355c9fvboxsync /** Level 4 logging. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Level 5 logging. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Level 6 logging. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Flow logging. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Restrict the number of log entries. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Lelik logging. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Michael logging. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** sunlover logging. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Achim logging. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Sander logging. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Klaus logging. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Frank logging. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** bird logging. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** aleksey logging. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** dj logging. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** NoName logging. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Logger destination type.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Log to file. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Log to stdout. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Log to stderr. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Log to debugger (win32 only). */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Log to com port. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Just a dummy flag to be used when no other flag applies. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Log to a user defined output stream. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsyncRTDECL(void) RTLogPrintfEx(void *pvInstance, unsigned fFlags, unsigned iGroup, const char *pszFormat, ...);
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LOG_DISABLED
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Use this compile time define to disable all logging macros. It can
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * be overridden for each of the logging macros by the LOG_ENABLE*
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * compile time defines.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LOG_ENABLED
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Use this compile time define to enable logging when not in debug mode
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * or LOG_DISABLED is set.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * This will enabled Log() only.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LOG_ENABLE_FLOW
36fbf6dcd3e6b2e5891456b730577ff0eb355c9fvboxsync * Use this compile time define to enable flow logging when not in
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * debug mode or LOG_DISABLED is defined.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * This will enable LogFlow() only.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Determine whether logging is enabled and forcefully normalize the indicators.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#if (defined(DEBUG) || defined(LOG_ENABLED)) && !defined(LOG_DISABLED)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LOG_USE_C99
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Governs the use of variadic macros.
36fbf6dcd3e6b2e5891456b730577ff0eb355c9fvboxsync# if defined(RT_ARCH_AMD64) || defined(RT_OS_DARWIN) || defined(RT_ARCH_SPARC) || defined(RT_ARCH_SPARC64)
36fbf6dcd3e6b2e5891456b730577ff0eb355c9fvboxsync/** @def LogIt
36fbf6dcd3e6b2e5891456b730577ff0eb355c9fvboxsync * Write to specific logger if group enabled.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync# define _LogIt(a_pvInst, a_fFlags, a_iGroup, ...) RTLogLoggerEx((PRTLOGGER)a_pvInst, a_fFlags, a_iGroup, __VA_ARGS__)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync# define LogIt(a_pvInst, a_fFlags, a_iGroup, fmtargs) _LogIt(a_pvInst, a_fFlags, a_iGroup, _LogRemoveParentheseis fmtargs)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync# define _LogItAlways(a_pvInst, a_fFlags, a_iGroup, ...) RTLogLoggerEx((PRTLOGGER)a_pvInst, a_fFlags, ~0U, __VA_ARGS__)
36fbf6dcd3e6b2e5891456b730577ff0eb355c9fvboxsync# define LogItAlways(a_pvInst, a_fFlags, a_iGroup, fmtargs) _LogItAlways(a_pvInst, a_fFlags, a_iGroup, _LogRemoveParentheseis fmtargs)
36fbf6dcd3e6b2e5891456b730577ff0eb355c9fvboxsync /** @todo invent a flag or something for skipping the group check so we can pass iGroup. LogItAlways. */
36fbf6dcd3e6b2e5891456b730577ff0eb355c9fvboxsync# define LogIt(a_pvInst, a_fFlags, a_iGroup, fmtargs) \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync register PRTLOGGER LogIt_pLogger = (PRTLOGGER)(a_pvInst) ? (PRTLOGGER)(a_pvInst) : RTLogDefaultInstance(); \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync && !(LogIt_pLogger->fFlags & RTLOGFLAGS_DISABLED)) \
36fbf6dcd3e6b2e5891456b730577ff0eb355c9fvboxsync register unsigned LogIt_fFlags = LogIt_pLogger->afGroups[(unsigned)(a_iGroup) < LogIt_pLogger->cGroups ? (unsigned)(a_iGroup) : 0]; \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync if ((LogIt_fFlags & ((a_fFlags) | RTLOGGRPFLAGS_ENABLED)) == ((a_fFlags) | RTLOGGRPFLAGS_ENABLED)) \
36fbf6dcd3e6b2e5891456b730577ff0eb355c9fvboxsync } while (0)
36fbf6dcd3e6b2e5891456b730577ff0eb355c9fvboxsync# define LogItAlways(a_pvInst, a_fFlags, a_iGroup, fmtargs) \
36fbf6dcd3e6b2e5891456b730577ff0eb355c9fvboxsync register PRTLOGGER LogIt_pLogger = (PRTLOGGER)(a_pvInst) ? (PRTLOGGER)(a_pvInst) : RTLogDefaultInstance(); \
36fbf6dcd3e6b2e5891456b730577ff0eb355c9fvboxsync && !(LogIt_pLogger->fFlags & RTLOGFLAGS_DISABLED)) \
36fbf6dcd3e6b2e5891456b730577ff0eb355c9fvboxsync } while (0)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync# define LogIt(a_pvInst, a_fFlags, a_iGroup, fmtargs) do { } while (0)
36fbf6dcd3e6b2e5891456b730577ff0eb355c9fvboxsync# define LogItAlways(a_pvInst, a_fFlags, a_iGroup, fmtargs) do { } while (0)
36fbf6dcd3e6b2e5891456b730577ff0eb355c9fvboxsync# define _LogIt(a_pvInst, a_fFlags, a_iGroup, ...) do { } while (0)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync# define _LogItAlways(a_pvInst, a_fFlags, a_iGroup, ...) do { } while (0)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def Log
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Level 1 logging that works regardless of the group settings.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogAlways(a) LogItAlways(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, a)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def Log
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Level 1 logging.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define Log(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, a)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def Log2
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Level 2 logging.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define Log2(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_2, LOG_GROUP, a)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def Log3
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Level 3 logging.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define Log3(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_3, LOG_GROUP, a)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def Log4
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Level 4 logging.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define Log4(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_4, LOG_GROUP, a)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def Log5
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Level 5 logging.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define Log5(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_5, LOG_GROUP, a)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def Log6
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Level 6 logging.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define Log6(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_6, LOG_GROUP, a)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogFlow
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Logging of execution flow.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogFlow(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_FLOW, LOG_GROUP, a)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogLelik
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * lelik logging.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogLelik(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LELIK, LOG_GROUP, a)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogMichael
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * michael logging.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogMichael(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_MICHAEL, LOG_GROUP, a)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogSunlover
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * sunlover logging.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogSunlover(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_SUNLOVER, LOG_GROUP, a)
034f0367d3b0431c6346b1a3af3abb435ee50d4evboxsync/** @def LogAchim
3614117c1132a61599e6190939e775cafe549411vboxsync * Achim logging.
3614117c1132a61599e6190939e775cafe549411vboxsync#define LogAchim(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_ACHIM, LOG_GROUP, a)
3614117c1132a61599e6190939e775cafe549411vboxsync/** @def LogSander
3614117c1132a61599e6190939e775cafe549411vboxsync * Sander logging.
3614117c1132a61599e6190939e775cafe549411vboxsync#define LogSander(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_SANDER, LOG_GROUP, a)
3614117c1132a61599e6190939e775cafe549411vboxsync/** @def LogKlaus
3614117c1132a61599e6190939e775cafe549411vboxsync * klaus logging.
3614117c1132a61599e6190939e775cafe549411vboxsync#define LogKlaus(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_KLAUS, LOG_GROUP, a)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogFrank
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * frank logging.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogFrank(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_FRANK, LOG_GROUP, a)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogBird
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * bird logging.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogBird(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_BIRD, LOG_GROUP, a)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogAleksey
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * aleksey logging.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogAleksey(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_ALEKSEY, LOG_GROUP, a)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogDJ
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * dj logging.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogDJ(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_DJ, LOG_GROUP, a)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogNoName
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * NoName logging.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogNoName(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_NONAME, LOG_GROUP, a)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogWarning
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * The same as Log(), but prepents a <tt>"WARNING! "</tt> string to the message.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param a Custom log message in format <tt>("string\n" [, args])</tt>.
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync _LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, "WARNING! %M", _LogRemoveParentheseis a )
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync/** @def LogTrace
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Macro to trace the execution flow: logs the file name, line number and
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * function name. Can be easily searched for in log files using the
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * ">>>>>" pattern (prepended to the beginning of each line).
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync LogFlow((">>>>> %s (%d): " LOG_FN_FMT "\n", __FILE__, __LINE__, __PRETTY_FUNCTION__))
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogTraceMsg
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * The same as LogTrace but logs a custom log message right after the trace line.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param a Custom log message in format <tt>("string\n" [, args])</tt>.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync _LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_FLOW, LOG_GROUP, ">>>>> %s (%d): " LOG_FN_FMT ": %M", __FILE__, __LINE__, __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync do { LogFlow((">>>>> %s (%d): " LOG_FN_FMT ": ", __FILE__, __LINE__, __PRETTY_FUNCTION__)); LogFlow(a); } while (0)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogFunc
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Level 1 logging inside C/C++ functions.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Prepends the given log message with the function name followed by a
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * semicolon and space.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param a Log message in format <tt>("string\n" [, args])</tt>.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync# define LogFunc(a) \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync _LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, LOG_FN_FMT ": %M", __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync# define LogFunc(a) \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync do { Log((LOG_FN_FMT ": ", __PRETTY_FUNCTION__)); Log(a); } while (0)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def Log2Func
9540eeb13face31ddc1c5f15338556fe46f18a77vboxsync * Level 2 logging inside C/C++ functions.
9540eeb13face31ddc1c5f15338556fe46f18a77vboxsync * Prepends the given log message with the function name followed by a
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * semicolon and space.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param a Log message in format <tt>("string\n" [, args])</tt>.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync# define Log2Func(a) \
36fbf6dcd3e6b2e5891456b730577ff0eb355c9fvboxsync _LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_2, LOG_GROUP, LOG_FN_FMT ": %M", __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync# define Log2Func(a) \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync do { Log2((LOG_FN_FMT ": ", __PRETTY_FUNCTION__)); Log2(a); } while (0)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def Log3Func
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Level 3 logging inside C/C++ functions.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Prepends the given log message with the function name followed by a
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync * semicolon and space.
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync * @param a Log message in format <tt>("string\n" [, args])</tt>.
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync# define Log3Func(a) \
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync _LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_3, LOG_GROUP, LOG_FN_FMT ": %M", __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync# define Log3Func(a) \
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync do { Log3((LOG_FN_FMT ": ", __PRETTY_FUNCTION__)); Log3(a); } while (0)
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync/** @def Log4Func
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync * Level 4 logging inside C/C++ functions.
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync * Prepends the given log message with the function name followed by a
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync * semicolon and space.
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync * @param a Log message in format <tt>("string\n" [, args])</tt>.
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync# define Log4Func(a) \
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync _LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_4, LOG_GROUP, LOG_FN_FMT ": %M", __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync# define Log4Func(a) \
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync do { Log4((LOG_FN_FMT ": ", __PRETTY_FUNCTION__)); Log4(a); } while (0)
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync/** @def Log5Func
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync * Level 5 logging inside C/C++ functions.
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync * Prepends the given log message with the function name followed by a
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync * semicolon and space.
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync * @param a Log message in format <tt>("string\n" [, args])</tt>.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync# define Log5Func(a) \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync _LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_5, LOG_GROUP, LOG_FN_FMT ": %M", __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync# define Log5Func(a) \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync do { Log5((LOG_FN_FMT ": ", __PRETTY_FUNCTION__)); Log5(a); } while (0)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def Log6Func
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Level 6 logging inside C/C++ functions.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Prepends the given log message with the function name followed by a
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * semicolon and space.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param a Log message in format <tt>("string\n" [, args])</tt>.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync# define Log6Func(a) \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync _LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_6, LOG_GROUP, LOG_FN_FMT ": %M", __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync# define Log6Func(a) \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync do { Log6((LOG_FN_FMT ": ", __PRETTY_FUNCTION__)); Log6(a); } while (0)
9540eeb13face31ddc1c5f15338556fe46f18a77vboxsync/** @def LogThisFunc
9540eeb13face31ddc1c5f15338556fe46f18a77vboxsync * The same as LogFunc but for class functions (methods): the resulting log
9540eeb13face31ddc1c5f15338556fe46f18a77vboxsync * line is additionally prepended with a hex value of |this| pointer.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param a Log message in format <tt>("string\n" [, args])</tt>.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync _LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, "{%p} " LOG_FN_FMT ": %M", this, __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync do { Log(("{%p} " LOG_FN_FMT ": ", this, __PRETTY_FUNCTION__)); Log(a); } while (0)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogFlowFunc
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Macro to log the execution flow inside C/C++ functions.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Prepends the given log message with the function name followed by
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * a semicolon and space.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param a Log message in format <tt>("string\n" [, args])</tt>.
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync _LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_FLOW, LOG_GROUP, LOG_FN_FMT ": %M", __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync do { LogFlow((LOG_FN_FMT ": ", __PRETTY_FUNCTION__)); LogFlow(a); } while (0)
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync/** @def LogWarningFunc
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync * The same as LogWarning(), but prepents the log message with the function name.
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync * @param a Log message in format <tt>("string\n" [, args])</tt>.
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync _LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, LOG_FN_FMT ": WARNING! %M", __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync do { Log((LOG_FN_FMT ": WARNING! ", __PRETTY_FUNCTION__)); Log(a); } while (0)
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync/** @def LogFlowThisFunc
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync * The same as LogFlowFunc but for class functions (methods): the resulting log
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync * line is additionally prepended with a hex value of |this| pointer.
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync * @param a Log message in format <tt>("string\n" [, args])</tt>.
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync _LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_FLOW, LOG_GROUP, "{%p} " LOG_FN_FMT ": %M", this, __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync do { LogFlow(("{%p} " LOG_FN_FMT ": ", this, __PRETTY_FUNCTION__)); LogFlow(a); } while (0)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogWarningThisFunc
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * The same as LogWarningFunc() but for class functions (methods): the resulting
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * log line is additionally prepended with a hex value of |this| pointer.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param a Log message in format <tt>("string\n" [, args])</tt>.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync _LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, "{%p} " LOG_FN_FMT ": WARNING! %M", this, __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync do { Log(("{%p} " LOG_FN_FMT ": WARNING! ", this, __PRETTY_FUNCTION__)); Log(a); } while (0)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** Shortcut to |LogFlowFunc ("ENTER\n")|, marks the beginnig of the function. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** Shortcut to |LogFlowFunc ("LEAVE\n")|, marks the end of the function. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** Shortcut to |LogFlowFunc ("LEAVE: %Rrc\n")|, marks the end of the function. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogFlowFuncLeaveRC(rc) LogFlowFunc(("LEAVE: %Rrc\n", (rc)))
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** Shortcut to |LogFlowThisFunc ("ENTER\n")|, marks the beginnig of the function. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogFlowThisFuncEnter() LogFlowThisFunc(("ENTER\n"))
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** Shortcut to |LogFlowThisFunc ("LEAVE\n")|, marks the end of the function. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogFlowThisFuncLeave() LogFlowThisFunc(("LEAVE\n"))
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogObjRefCnt
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Helper macro to print the current reference count of the given COM object
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * to the log file.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param pObj Pointer to the object in question (must be a pointer to an
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * IUnknown subclass or simply define COM-style AddRef() and
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Release() methods)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @note Use it only for temporary debugging. It leaves dummy code even if
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * logging is disabled.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync LogFlow((#pObj "{%p}.refCnt=%d\n", (pObj), refc - 1)); \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync } while (0)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogIsItEnabled
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Checks whether the specified logging group is enabled or not.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync# define LogIsItEnabled(a_pvInst, a_fFlags, a_iGroup) \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync LogIsItEnabledInternal((a_pvInst), (unsigned)(a_iGroup), (unsigned)(a_fFlags))
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync# define LogIsItEnabled(a_pvInst, a_fFlags, a_iGroup) (false)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogIsEnabled
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Checks whether level 1 logging is enabled.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogIsEnabled() LogIsItEnabled(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogIs2Enabled
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Checks whether level 2 logging is enabled.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogIs2Enabled() LogIsItEnabled(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_2, LOG_GROUP)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogIs3Enabled
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Checks whether level 3 logging is enabled.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogIs3Enabled() LogIsItEnabled(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_3, LOG_GROUP)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogIs4Enabled
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Checks whether level 4 logging is enabled.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogIs4Enabled() LogIsItEnabled(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_4, LOG_GROUP)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogIs5Enabled
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Checks whether level 5 logging is enabled.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogIs5Enabled() LogIsItEnabled(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_5, LOG_GROUP)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogIs6Enabled
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Checks whether level 6 logging is enabled.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogIs6Enabled() LogIsItEnabled(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_6, LOG_GROUP)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogIsFlowEnabled
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Checks whether execution flow logging is enabled.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogIsFlowEnabled() LogIsItEnabled(LOG_INSTANCE, RTLOGGRPFLAGS_FLOW, LOG_GROUP)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @name Passing Function Call Position When Logging.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * This is a little bit ugly as we have to omit the comma before the
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * position parameters so that we don't inccur any overhead in non-logging
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * builds (!defined(LOG_ENABLED).
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** Source position for passing to a function call. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync# define RTLOG_COMMA_SRC_POS , __FILE__, __LINE__, __PRETTY_FUNCTION__
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** Source position declaration. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync# define RTLOG_COMMA_SRC_POS_DECL , const char *pszFile, unsigned iLine, const char *pszFunction
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** Source position arguments. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync# define RTLOG_COMMA_SRC_POS_ARGS , pszFile, iLine, pszFunction
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** Applies NOREF() to the source position arguments. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync# define RTLOG_SRC_POS_NOREF() do { NOREF(pszFile); NOREF(iLine); NOREF(pszFunction); } while (0)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync# define RTLOG_SRC_POS_NOREF() do { } while (0)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @name Release Logging
23603ed361f22874964e3a841add2c58ec2bb1eavboxsync/** @def RTLOG_REL_DISABLED
23603ed361f22874964e3a841add2c58ec2bb1eavboxsync * Use this compile time define to disable all release logging
23603ed361f22874964e3a841add2c58ec2bb1eavboxsync/** @def RTLOG_REL_ENABLED
23603ed361f22874964e3a841add2c58ec2bb1eavboxsync * Use this compile time define to override RTLOG_REL_DISABLE.
23603ed361f22874964e3a841add2c58ec2bb1eavboxsync * Determine whether release logging is enabled and forcefully normalize the indicators.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#if !defined(RTLOG_REL_DISABLED) || defined(RTLOG_REL_ENABLED)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogIt
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Write to specific logger if group enabled.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync# define _LogRelIt(a_pvInst, a_fFlags, a_iGroup, ...) \
9540eeb13face31ddc1c5f15338556fe46f18a77vboxsync PRTLOGGER LogRelIt_pLogger = (PRTLOGGER)(a_pvInst) ? (PRTLOGGER)(a_pvInst) : RTLogRelDefaultInstance(); \
5045ab9ca39fa0b301f4020b7a072406eb0ecea2vboxsync && !(LogRelIt_pLogger->fFlags & RTLOGFLAGS_DISABLED)) \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync RTLogLoggerEx(LogRelIt_pLogger, a_fFlags, a_iGroup, __VA_ARGS__); \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync _LogIt(LOG_INSTANCE, a_fFlags, a_iGroup, __VA_ARGS__); \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync } while (0)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync# define LogRelIt(a_pvInst, a_fFlags, a_iGroup, fmtargs) _LogRelIt(a_pvInst, a_fFlags, a_iGroup, _LogRelRemoveParentheseis fmtargs)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync# define LogRelIt(a_pvInst, a_fFlags, a_iGroup, fmtargs) \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync PRTLOGGER LogRelIt_pLogger = (PRTLOGGER)(a_pvInst) ? (PRTLOGGER)(a_pvInst) : RTLogRelDefaultInstance(); \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync && !(LogRelIt_pLogger->fFlags & RTLOGFLAGS_DISABLED)) \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync unsigned LogIt_fFlags = LogRelIt_pLogger->afGroups[(unsigned)(a_iGroup) < LogRelIt_pLogger->cGroups ? (unsigned)(a_iGroup) : 0]; \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync if ((LogIt_fFlags & ((a_fFlags) | RTLOGGRPFLAGS_ENABLED)) == ((a_fFlags) | RTLOGGRPFLAGS_ENABLED)) \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync LogIt(LOG_INSTANCE, a_fFlags, a_iGroup, fmtargs); \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync } while (0)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#else /* !RTLOG_REL_ENABLED */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync# define LogRelIt(a_pvInst, a_fFlags, a_iGroup, fmtargs) do { } while (0)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync# define _LogRelIt(a_pvInst, a_fFlags, a_iGroup, ...) do { } while (0)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#endif /* !RTLOG_REL_ENABLED */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogRel
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Level 1 logging.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogRel(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, a)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogRel2
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Level 2 logging.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogRel2(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_2, LOG_GROUP, a)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogRel3
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Level 3 logging.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogRel3(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_3, LOG_GROUP, a)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogRel4
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Level 4 logging.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogRel4(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_4, LOG_GROUP, a)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogRel5
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Level 5 logging.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogRel5(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_5, LOG_GROUP, a)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogRel6
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Level 6 logging.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogRel6(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_6, LOG_GROUP, a)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogRelFlow
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Logging of execution flow.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogRelFlow(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_FLOW, LOG_GROUP, a)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogRelFunc
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Release logging. Prepends the given log message with the function name
3614117c1132a61599e6190939e775cafe549411vboxsync * followed by a semicolon and space.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync _LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, LOG_FN_FMT ": %M", __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync# define LogFunc(a) \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync _LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, LOG_FN_FMT ": %M", __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync do { LogRel((LOG_FN_FMT ": ", __PRETTY_FUNCTION__)); LogRel(a); } while (0)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogRelThisFunc
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * The same as LogRelFunc but for class functions (methods): the resulting log
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * line is additionally prepended with a hex value of |this| pointer.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync _LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, "{%p} " LOG_FN_FMT ": %M", this, __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync do { LogRel(("{%p} " LOG_FN_FMT ": ", this, __PRETTY_FUNCTION__)); LogRel(a); } while (0)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogRelFlowFunc
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Release logging. Macro to log the execution flow inside C/C++ functions.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Prepends the given log message with the function name followed by
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * a semicolon and space.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param a Log message in format <tt>("string\n" [, args])</tt>.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync _LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_FLOW, LOG_GROUP, LOG_FN_FMT ": %M", __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync do { LogRelFlow((LOG_FN_FMT ": ", __PRETTY_FUNCTION__)); LogRelFlow(a); } while (0)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogRelLelik
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * lelik logging.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogRelLelik(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LELIK, LOG_GROUP, a)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogRelMichael
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * michael logging.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogRelMichael(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_MICHAEL, LOG_GROUP, a)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogRelSunlover
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * sunlover logging.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogRelSunlover(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_SUNLOVER, LOG_GROUP, a)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogRelAchim
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Achim logging.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogRelAchim(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_ACHIM, LOG_GROUP, a)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogRelSander
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Sander logging.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogRelSander(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_SANDER, LOG_GROUP, a)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogRelKlaus
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * klaus logging.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogRelKlaus(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_KLAUS, LOG_GROUP, a)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogRelFrank
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * frank logging.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogRelFrank(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_FRANK, LOG_GROUP, a)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogRelBird
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * bird logging.
23603ed361f22874964e3a841add2c58ec2bb1eavboxsync#define LogRelBird(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_BIRD, LOG_GROUP, a)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogRelNoName
23603ed361f22874964e3a841add2c58ec2bb1eavboxsync * NoName logging.
23603ed361f22874964e3a841add2c58ec2bb1eavboxsync#define LogRelNoName(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_NONAME, LOG_GROUP, a)
23603ed361f22874964e3a841add2c58ec2bb1eavboxsync/** @def LogRelIsItEnabled
23603ed361f22874964e3a841add2c58ec2bb1eavboxsync * Checks whether the specified logging group is enabled or not.
23603ed361f22874964e3a841add2c58ec2bb1eavboxsync#define LogRelIsItEnabled(a_pvInst, a_fFlags, a_iGroup) \
23603ed361f22874964e3a841add2c58ec2bb1eavboxsync LogRelIsItEnabledInternal((a_pvInst), (unsigned)(a_iGroup), (unsigned)(a_fFlags))
23603ed361f22874964e3a841add2c58ec2bb1eavboxsync/** @def LogRelIsEnabled
23603ed361f22874964e3a841add2c58ec2bb1eavboxsync * Checks whether level 1 logging is enabled.
23603ed361f22874964e3a841add2c58ec2bb1eavboxsync#define LogRelIsEnabled() LogRelIsItEnabled(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP)
23603ed361f22874964e3a841add2c58ec2bb1eavboxsync/** @def LogRelIs2Enabled
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Checks whether level 2 logging is enabled.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogRelIs2Enabled() LogRelIsItEnabled(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_2, LOG_GROUP)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogRelIs3Enabled
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Checks whether level 3 logging is enabled.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogRelIs3Enabled() LogRelIsItEnabled(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_3, LOG_GROUP)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogRelIs4Enabled
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Checks whether level 4 logging is enabled.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogRelIs4Enabled() LogRelIsItEnabled(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_4, LOG_GROUP)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogRelIs5Enabled
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Checks whether level 5 logging is enabled.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogRelIs5Enabled() LogRelIsItEnabled(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_5, LOG_GROUP)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogRelIs6Enabled
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Checks whether level 6 logging is enabled.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogRelIs6Enabled() LogRelIsItEnabled(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_6, LOG_GROUP)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogRelIsFlowEnabled
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Checks whether execution flow logging is enabled.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogRelIsFlowEnabled() LogRelIsItEnabled(LOG_REL_INSTANCE, RTLOGGRPFLAGS_FLOW, LOG_GROUP)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Sets the default release logger instance.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @returns The old default instance.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param pLogger The new default release logger instance.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsyncRTDECL(PRTLOGGER) RTLogRelSetDefaultInstance(PRTLOGGER pLogger);
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#endif /* !IN_RC */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Gets the default release logger instance.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @returns Pointer to default release logger instance.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @returns NULL if no default release logger instance available.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** Internal worker function.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Don't call directly, use the LogRelIsItEnabled macro!
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsyncDECLINLINE(bool) LogRelIsItEnabledInternal(void *pvInst, unsigned iGroup, unsigned fFlags)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync register PRTLOGGER pLogger = (PRTLOGGER)pvInst ? (PRTLOGGER)pvInst : RTLogRelDefaultInstance();
9540eeb13face31ddc1c5f15338556fe46f18a77vboxsync register unsigned fGrpFlags = pLogger->afGroups[(unsigned)iGroup < pLogger->cGroups ? (unsigned)iGroup : 0];
9540eeb13face31ddc1c5f15338556fe46f18a77vboxsync if ((fGrpFlags & (fFlags | RTLOGGRPFLAGS_ENABLED)) == (fFlags | RTLOGGRPFLAGS_ENABLED))
9540eeb13face31ddc1c5f15338556fe46f18a77vboxsync return true;
9540eeb13face31ddc1c5f15338556fe46f18a77vboxsync return false;
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Write to a logger instance, defaulting to the release one.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * This function will check whether the instance, group and flags makes up a
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * logging kind which is currently enabled before writing anything to the log.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param pLogger Pointer to logger instance.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param fFlags The logging flags.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param iGroup The group.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * The value ~0U is reserved for compatibility with RTLogLogger[V] and is
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * only for internal usage!
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param pszFormat Format string.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param ... Format arguments.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @remark This is a worker function for LogRelIt.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsyncRTDECL(void) RTLogRelLogger(PRTLOGGER pLogger, unsigned fFlags, unsigned iGroup, const char *pszFormat, ...);
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Write to a logger instance, defaulting to the release one.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * This function will check whether the instance, group and flags makes up a
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * logging kind which is currently enabled before writing anything to the log.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param pLogger Pointer to logger instance. If NULL the default release instance is attempted.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param fFlags The logging flags.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param iGroup The group.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * The value ~0U is reserved for compatibility with RTLogLogger[V] and is
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * only for internal usage!
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param pszFormat Format string.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param args Format arguments.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsyncRTDECL(void) RTLogRelLoggerV(PRTLOGGER pLogger, unsigned fFlags, unsigned iGroup, const char *pszFormat, va_list args);
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * printf like function for writing to the default release log.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param pszFormat Printf like format string.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param ... Optional arguments as specified in pszFormat.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @remark The API doesn't support formatting of floating point numbers at the moment.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsyncRTDECL(void) RTLogRelPrintf(const char *pszFormat, ...);
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * vprintf like function for writing to the default release log.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param pszFormat Printf like format string.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param args Optional arguments as specified in pszFormat.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @remark The API doesn't support formatting of floating point numbers at the moment.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsyncRTDECL(void) RTLogRelPrintfV(const char *pszFormat, va_list args);
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Changes the buffering setting of the default release logger.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * This can be used for optimizing longish logging sequences.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @returns The old state.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param fBuffered The new state.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @name COM port logging
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LOG_TO_COM
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Redirects the normal logging macros to the serial versions.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LOG_NO_COM
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Disables all LogCom* macros.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogCom
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Generic logging to serial port.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync# define LogCom(a) do { } while (0)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogComFlow
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Logging to serial port of execution flow.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#if defined(LOG_ENABLED) && defined(LOG_ENABLE_FLOW) && !defined(LOG_NO_COM)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync# define LogComFlow(a) do { } while (0)
#ifdef DOXYGEN_RUNNING
# define LOG_TO_BACKDOOR
# define LOG_NO_BACKDOOR
# define LogBackdoor(a) do { } while (0)
# define LogBackdoorFlow(a) do { } while (0)
#if !defined(LOG_NO_BACKDOOR)
# define LogRelBackdoor(a) do { } while (0)
#ifdef LOG_TO_BACKDOOR
# if defined(LOG_USE_C99)
#ifndef IN_RC
#ifdef IN_RING0
#ifdef LOG_ENABLED
if ( pLogger
register unsigned fGrpFlags = pLogger->afGroups[(unsigned)iGroup < pLogger->cGroups ? (unsigned)iGroup : 0];
#ifndef IN_RC
* @param pszErrorMsg A buffer which is filled with an error message if something fails. May be NULL.
RTDECL(int) RTLogSetCustomPrefixCallback(PRTLOGGER pLogger, PFNRTLOGPREFIX pfnCallback, void *pvUser);
#ifndef IN_RC
RTDECL(void) RTLogLoggerEx(PRTLOGGER pLogger, unsigned fFlags, unsigned iGroup, const char *pszFormat, ...);
RTDECL(void) RTLogLoggerExV(PRTLOGGER pLogger, unsigned fFlags, unsigned iGroup, const char *pszFormat, va_list args);
#define DECLARED_FNRTSTROUTPUT
RTDECL(size_t) RTLogFormatV(PFNRTSTROUTPUT pfnOutput, void *pvArg, const char *pszFormat, va_list args);
typedef struct RTLOGHOOKBUFFER
volatile void *pvWrite;
volatile void *pvRead;
void *pvStart;
void *pvEnd;
void *pvSemWriter;
void *pvSemReader;
volatile unsigned fFlags;
#ifdef VBOX