log.h revision b8542d71866b0f4ece84f7e2e007a2f18e54dddb
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * IPRT - Logging.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Copyright (C) 2006-2007 Sun Microsystems, Inc.
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 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Clara, CA 95054 USA or visit http://www.sun.com if you need
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * additional information or have any questions.
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_DIR", \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync "RT_FILE", \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync "RT_LDR", \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync "RT_PATH", \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync "RT_PROCESS", \
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 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. */
9540eeb13face31ddc1c5f15338556fe46f18a77vboxsync * Flush function.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param pLogger Pointer to the logger instance which is to be flushed.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsynctypedef DECLCALLBACK(void) FNRTLOGFLUSH(PRTLOGGER pLogger);
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** Pointer to logger function. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Flush function.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param pLogger Pointer to the logger instance which is to be flushed.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsynctypedef DECLCALLBACK(void) FNRTLOGFLUSHGC(PRTLOGGERGC pLogger);
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** Pointer to logger function. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsynctypedef GCPTRTYPE(FNRTLOGFLUSHGC *) PFNRTLOGFLUSHGC;
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Logger instance structure for GC.
9540eeb13face31ddc1c5f15338556fe46f18a77vboxsync /** Pointer to temporary scratch buffer.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * This is used to format the log messages. */
9540eeb13face31ddc1c5f15338556fe46f18a77vboxsync /** Current scratch buffer position. */
9540eeb13face31ddc1c5f15338556fe46f18a77vboxsync /** 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 (RTLOGGERGC_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/** RTLOGGERGC::u32Magic value. (John Rogers Searle) */
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 /** 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 * (The memory is (not R0) allocated using RTMemExecAlloc().) */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Pointer to the flush function. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Mutex. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Magic number. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Logger instance flags - RTLOGFLAGS. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Destination flags - RTLOGDEST. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Handle to log file (if open). */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Pointer to filename.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * (The memory is allocated in the smae block as RTLOGGER.) */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Pointer to the group name array.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * (The data is readonly and provided by the user.) */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync const char * const *papszGroups;
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** The max number of groups that there is room for in afGroups and papszGroups.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Used by RTLogCopyGroupAndFlags(). */
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 * 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 /** Show relative timestamps with PREFIX_TSC and PREFIX_TS */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Show decimal timestamps with PREFIX_TSC and PREFIX_TS */
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). */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** 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 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. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Logger per group flags.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Enabled. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Level 1 logging. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Level 2 logging. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Level 3 logging. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Level 4 logging. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Level 5 logging. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Level 6 logging. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Flow logging. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Lelik logging. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Michael logging. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** dmik logging. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** sunlover logging. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Achim logging. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Sander logging. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Klaus logging. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** Frank logging. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** bird logging. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** NoName logging. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Logger destination type.
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync /** Log to file. */
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync /** Log to stdout. */
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync /** 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 * Determin 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.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogIt
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Write to specific logger if group enabled.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync# define _LogIt(pvInst, fFlags, iGroup, ...) RTLogLoggerEx((PRTLOGGER)pvInst, fFlags, iGroup, __VA_ARGS__)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync# define LogIt(pvInst, fFlags, iGroup, fmtargs) _LogIt(pvInst, fFlags, iGroup, _LogRemoveParentheseis fmtargs)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync# define _LogItAlways(pvInst, fFlags, iGroup, ...) RTLogLoggerEx((PRTLOGGER)pvInst, fFlags, ~0U, __VA_ARGS__)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync# define LogItAlways(pvInst, fFlags, iGroup, fmtargs) _LogItAlways(pvInst, fFlags, iGroup, _LogRemoveParentheseis fmtargs)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync /** @todo invent a flag or something for skipping the group check so we can pass iGroup. LogItAlways. */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync register PRTLOGGER LogIt_pLogger = (PRTLOGGER)(pvInst) ? (PRTLOGGER)(pvInst) : RTLogDefaultInstance(); \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync register unsigned LogIt_fFlags = LogIt_pLogger->afGroups[(unsigned)(iGroup) < LogIt_pLogger->cGroups ? (unsigned)(iGroup) : 0]; \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync if ((LogIt_fFlags & ((fFlags) | RTLOGGRPFLAGS_ENABLED)) == ((fFlags) | RTLOGGRPFLAGS_ENABLED)) \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync } while (0)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync# define LogItAlways(pvInst, fFlags, iGroup, fmtargs) \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync register PRTLOGGER LogIt_pLogger = (PRTLOGGER)(pvInst) ? (PRTLOGGER)(pvInst) : RTLogDefaultInstance(); \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync } while (0)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync# define LogIt(pvInst, fFlags, iGroup, fmtargs) do { } while (0)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync# define LogItAlways(pvInst, fFlags, fmtargs) do { } while (0)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync# define _LogIt(pvInst, fFlags, iGroup, ...) do { } while (0)
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync/** @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 LogDmik
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * dmik logging.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogDmik(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_DMIK, LOG_GROUP, a)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogSunlover
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * sunlover logging.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogSunlover(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_SUNLOVER, LOG_GROUP, a)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogAchim
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Achim logging.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogAchim(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_ACHIM, LOG_GROUP, a)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogSander
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Sander logging.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogSander(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_SANDER, LOG_GROUP, a)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogKlaus
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * klaus logging.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#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 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>.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync _LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, "WARNING! %M", _LogRemoveParentheseis a )
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @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): %M" LOG_FN_FMT, __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 LogThisFunc
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * The same as LogFunc but for class functions (methods): the resulting log
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * 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>.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync _LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_FLOW, LOG_GROUP, LOG_FN_FMT ": %M", __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync do { LogFlow((LOG_FN_FMT ": ", __PRETTY_FUNCTION__)); LogFlow(a); } while (0)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogWarningFunc
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * The same as LogWarning(), but prepents the log message with the function name.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param a Log message in format <tt>("string\n" [, args])</tt>.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync _LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, LOG_FN_FMT ": WARNING! %M", __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync do { Log((LOG_FN_FMT ": WARNING! ", __PRETTY_FUNCTION__)); Log(a); } while (0)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogFlowThisFunc
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * The same as LogFlowFunc but for class functions (methods): the resulting log
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * 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_FLOW, LOG_GROUP, "{%p} " LOG_FN_FMT ": %M", this, __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync 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>.
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync _LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, "{%p} " LOG_FN_FMT ": WARNING! %M", this, __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync do { Log(("{%p} " LOG_FN_FMT ": WARNING! ", this, __PRETTY_FUNCTION__)); Log(a); } while (0)
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync/** 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 |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 LogIsItEnabledInternal((pvInst), (unsigned)(iGroup), (unsigned)(fFlags))
9540eeb13face31ddc1c5f15338556fe46f18a77vboxsync# define LogIsItEnabled(pvInst, fFlags, 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
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync * Checks whether level 4 logging is enabled.
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync#define LogIs4Enabled() LogIsItEnabled(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_4, LOG_GROUP)
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync/** @def LogIs5Enabled
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync * Checks whether level 5 logging is enabled.
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync#define LogIs5Enabled() LogIsItEnabled(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_5, LOG_GROUP)
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync/** @def LogIs6Enabled
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync * Checks whether level 6 logging is enabled.
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync#define LogIs6Enabled() LogIsItEnabled(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_6, LOG_GROUP)
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync/** @def LogIsFlowEnabled
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync * Checks whether execution flow logging is enabled.
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync#define LogIsFlowEnabled() LogIsItEnabled(LOG_INSTANCE, RTLOGGRPFLAGS_FLOW, LOG_GROUP)
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync/** @def LOG_DISABLED
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync * Use this compile time define to disable all logging macros. It can
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync * be overriden for each of the logging macros by the LOG_ENABLE*
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync * compile time defines.
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync/** @def LOG_ENABLED
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync * Use this compile time define to enable logging when not in debug mode
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync * or LOG_DISABLED is set.
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync * This will enabled Log() only.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LOG_ENABLE_FLOW
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * 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/** @name Release Logging
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogIt
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Write to specific logger if group enabled.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync# define _LogRelIt(pvInst, fFlags, iGroup, ...) RTLogLoggerEx((PRTLOGGER)pvInst, fFlags, iGroup, __VA_ARGS__)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync# define LogRelIt(pvInst, fFlags, iGroup, fmtargs) \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync PRTLOGGER LogRelIt_pLogger = (PRTLOGGER)(pvInst) ? (PRTLOGGER)(pvInst) : RTLogRelDefaultInstance(); \
9540eeb13face31ddc1c5f15338556fe46f18a77vboxsync _LogRelIt(LogRelIt_pLogger, fFlags, iGroup, _LogRelRemoveParentheseis fmtargs); \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync } while (0)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync# define LogRelIt(pvInst, fFlags, iGroup, fmtargs) \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync PRTLOGGER LogRelIt_pLogger = (PRTLOGGER)(pvInst) ? (PRTLOGGER)(pvInst) : RTLogRelDefaultInstance(); \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync unsigned LogIt_fFlags = LogRelIt_pLogger->afGroups[(unsigned)(iGroup) < LogRelIt_pLogger->cGroups ? (unsigned)(iGroup) : 0]; \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync if ((LogIt_fFlags & ((fFlags) | RTLOGGRPFLAGS_ENABLED)) == ((fFlags) | RTLOGGRPFLAGS_ENABLED)) \
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync } while (0)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogRel
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Level 1 logging.
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync#define LogRel(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, a)
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync/** @def LogRel2
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync * Level 2 logging.
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync#define LogRel2(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_2, LOG_GROUP, a)
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync/** @def LogRel3
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync * Level 3 logging.
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync#define LogRel3(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_3, LOG_GROUP, a)
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync/** @def LogRel4
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync * Level 4 logging.
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync#define LogRel4(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_4, LOG_GROUP, a)
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync/** @def LogRel5
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync * Level 5 logging.
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync#define LogRel5(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_5, LOG_GROUP, a)
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync/** @def LogRel6
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync * Level 6 logging.
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync#define LogRel6(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_6, LOG_GROUP, a)
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync/** @def LogRelFlow
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync * Logging of execution flow.
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync#define LogRelFlow(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_FLOW, LOG_GROUP, a)
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync/** @def LogRelFunc
ac6445a70a26cb69d08734f1d9dbc171cec86cd8vboxsync * Release logging. Prepends the given log message with the function name
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * followed by a semicolon and space.
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 do { LogRel(("{%p} " LOG_FN_FMT ": ", this, __PRETTY_FUNCTION__)); LogRel(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 LogRelDmik
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * dmik logging.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogRelDmik(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_DMIK, 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.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogRelBird(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_BIRD, LOG_GROUP, a)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogRelNoName
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * NoName logging.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogRelNoName(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_NONAME, LOG_GROUP, a)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogRelIsItEnabled
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Checks whether the specified logging group is enabled or not.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync LogRelIsItEnabledInternal((pvInst), (unsigned)(iGroup), (unsigned)(fFlags))
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogRelIsEnabled
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Checks whether level 1 logging is enabled.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#define LogRelIsEnabled() LogRelIsItEnabled(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @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_GC */
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();
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync register unsigned fGrpFlags = pLogger->afGroups[(unsigned)iGroup < pLogger->cGroups ? (unsigned)iGroup : 0];
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync if ((fGrpFlags & (fFlags | RTLOGGRPFLAGS_ENABLED)) == (fFlags | RTLOGGRPFLAGS_ENABLED))
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync return true;
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync 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 compatability 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.
9540eeb13face31ddc1c5f15338556fe46f18a77vboxsyncRTDECL(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 compatability 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/** @name COM port logging
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LOG_TO_COM
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Redirects the normal loging 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)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @name Backdoor Logging
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LOG_TO_BACKDOOR
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Redirects the normal logging macros to the backdoor versions.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LOG_NO_BACKDOOR
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Disables all LogBackdoor* macros.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogBackdoor
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Generic logging to the VBox backdoor via port I/O.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#if defined(LOG_ENABLED) && !defined(LOG_NO_BACKDOOR)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync# define LogBackdoor(a) do { } while (0)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogBackdoorFlow
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Logging of execution flow messages to the backdoor I/O port.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#if defined(LOG_ENABLED) && !defined(LOG_NO_BACKDOOR)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync# define LogBackdoorFlow(a) do { } while (0)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** @def LogRelBackdoor
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Release logging to the VBox backdoor via port I/O.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync# define LogRelBackdoor(a) do { } while (0)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Gets the default logger instance.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @returns Pointer to default logger instance.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @returns NULL if no default logger instance available.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Sets the default logger instance.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @returns The old default instance.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param pLogger The new default logger instance.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsyncRTDECL(PRTLOGGER) RTLogSetDefaultInstance(PRTLOGGER pLogger);
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#endif /* !IN_GC */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Changes the default logger instance for the current thread.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @returns IPRT status code.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param pLogger The logger instance. Pass NULL for deregistration.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param uKey Associated key for cleanup purposes. If pLogger is NULL,
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * all instances with this key will be deregistered. So in
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * order to only deregister the instance associated with the
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * current thread use 0.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsyncRTDECL(int) RTLogSetDefaultInstanceThread(PRTLOGGER pLogger, uintptr_t uKey);
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync#endif /* IN_RING0 */
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync/** Internal worker function.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Don't call directly, use the LogIsItEnabled macro!
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsyncDECLINLINE(bool) LogIsItEnabledInternal(void *pvInst, unsigned iGroup, unsigned fFlags)
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync register PRTLOGGER pLogger = (PRTLOGGER)pvInst ? (PRTLOGGER)pvInst : RTLogDefaultInstance();
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync register unsigned fGrpFlags = pLogger->afGroups[(unsigned)iGroup < pLogger->cGroups ? (unsigned)iGroup : 0];
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync if ((fGrpFlags & (fFlags | RTLOGGRPFLAGS_ENABLED)) == (fFlags | RTLOGGRPFLAGS_ENABLED))
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync return true;
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync return false;
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Creates the default logger instance for a iprt users.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Any user of the logging features will need to implement
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * this or use the generic dummy.
9540eeb13face31ddc1c5f15338556fe46f18a77vboxsync * @returns Pointer to the logger instance.
9540eeb13face31ddc1c5f15338556fe46f18a77vboxsync * Create a logger instance.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @returns iprt status code.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param ppLogger Where to store the logger instance.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param fFlags Logger instance flags, a combination of the RTLOGFLAGS_* values.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param pszGroupSettings The initial group settings.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param pszEnvVarBase Base name for the environment variables for this instance.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param cGroups Number of groups in the array.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param papszGroups Pointer to array of groups. This must stick around for the life of the
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * logger instance.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param fDestFlags The destination flags. RTLOGDEST_FILE is ORed if pszFilenameFmt specified.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param pszFilenameFmt Log filename format string. Standard RTStrFormat().
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param ... Format arguments.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsyncRTDECL(int) RTLogCreate(PRTLOGGER *ppLogger, RTUINT fFlags, const char *pszGroupSettings,
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync const char *pszEnvVarBase, unsigned cGroups, const char * const * papszGroups,
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync RTUINT fDestFlags, const char *pszFilenameFmt, ...);
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Create a logger instance.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @returns iprt status code.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param ppLogger Where to store the logger instance.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param fFlags Logger instance flags, a combination of the RTLOGFLAGS_* values.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param pszGroupSettings The initial group settings.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param pszEnvVarBase Base name for the environment variables for this instance.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param cGroups Number of groups in the array.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param papszGroups Pointer to array of groups. This must stick around for the life of the
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * logger instance.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param fDestFlags The destination flags. RTLOGDEST_FILE is ORed if pszFilenameFmt specified.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param pszErrorMsg A buffer which is filled with an error message if something fails. May be NULL.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param cchErrorMsg The size of the error message buffer.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param pszFilenameFmt Log filename format string. Standard RTStrFormat().
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param ... Format arguments.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsyncRTDECL(int) RTLogCreateEx(PRTLOGGER *ppLogger, RTUINT fFlags, const char *pszGroupSettings,
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync const char *pszEnvVarBase, unsigned cGroups, const char * const * papszGroups,
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync RTUINT fDestFlags, char *pszErrorMsg, size_t cchErrorMsg, const char *pszFilenameFmt, ...);
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Create a logger instance.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @returns iprt status code.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param ppLogger Where to store the logger instance.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param fFlags Logger instance flags, a combination of the RTLOGFLAGS_* values.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param pszGroupSettings The initial group settings.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param pszEnvVarBase Base name for the environment variables for this instance.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param cGroups Number of groups in the array.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param papszGroups Pointer to array of groups. This must stick around for the life of the
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * logger instance.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param fDestFlags The destination flags. RTLOGDEST_FILE is ORed if pszFilenameFmt specified.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param pszErrorMsg A buffer which is filled with an error message if something fails. May be NULL.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param cchErrorMsg The size of the error message buffer.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param pszFilenameFmt Log filename format string. Standard RTStrFormat().
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param args Format arguments.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsyncRTDECL(int) RTLogCreateExV(PRTLOGGER *ppLogger, RTUINT fFlags, const char *pszGroupSettings,
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync const char *pszEnvVarBase, unsigned cGroups, const char * const * papszGroups,
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync RTUINT fDestFlags, char *pszErrorMsg, size_t cchErrorMsg, const char *pszFilenameFmt, va_list args);
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Create a logger instance for singled threaded ring-0 usage.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @returns iprt status code.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param pLogger Where to create the logger instance.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param cbLogger The amount of memory available for the logger instance.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param pfnLogger Pointer to logger wrapper function for the clone.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param pfnFlush Pointer to flush function for the clone.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param fFlags Logger instance flags for the clone, a combination of the RTLOGFLAGS_* values.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param fDestFlags The destination flags.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsyncRTDECL(int) RTLogCreateForR0(PRTLOGGER pLogger, size_t cbLogger, PFNRTLOGGER pfnLogger, PFNRTLOGFLUSH pfnFlush, RTUINT fFlags, RTUINT fDestFlags);
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Destroys a logger instance.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * The instance is flushed and all output destinations closed (where applicable).
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @returns iprt status code.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param pLogger The logger instance which close destroyed.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Create a logger instance clone for GC usage.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @returns iprt status code.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param pLogger The logger instance to be cloned.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param pLoggerGC Where to create the GC logger instance.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param cbLoggerGC Amount of memory allocated to for the GC logger instance clone.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param pfnLoggerGCPtr Pointer to logger wrapper function for this instance (GC Ptr).
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param pfnFlushGCPtr Pointer to flush function (GC Ptr).
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param fFlags Logger instance flags, a combination of the RTLOGFLAGS_* values.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsyncRTDECL(int) RTLogCloneGC(PRTLOGGER pLogger, PRTLOGGERGC pLoggerGC, size_t cbLoggerGC,
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync RTGCPTR pfnLoggerGCPtr, RTGCPTR pfnFlushGCPtr, RTUINT fFlags);
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Flushes a GC logger instance to a HC logger.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @returns iprt status code.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param pLogger The HC logger instance to flush pLoggerGC to.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * If NULL the default logger is used.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * @param pLoggerGC The GC logger instance to flush.
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsyncRTDECL(void) RTLogFlushGC(PRTLOGGER pLogger, PRTLOGGERGC pLoggerGC);
016096e367cd20c3d3c3fd9a6650b55935c2e31dvboxsync * Flushes the buffer in one logger instance onto another logger.
RTDECL(int) RTLogCopyGroupsAndFlags(PRTLOGGER pDstLogger, PCRTLOGGER pSrcLogger, unsigned fFlagsOr, unsigned fFlagsAnd);
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