/** @file * InnoTek Portable Runtime - Logging. */ /* * Copyright (C) 2006 InnoTek Systemberatung GmbH * * This file is part of VirtualBox Open Source Edition (OSE), as * available from http://www.virtualbox.org. This file is free software; * you can redistribute it and/or modify it under the terms of the GNU * General Public License as published by the Free Software Foundation, * in version 2 as it comes in the "COPYING" file of the VirtualBox OSE * distribution. VirtualBox OSE is distributed in the hope that it will * be useful, but WITHOUT ANY WARRANTY of any kind. * * If you received this file as part of a commercial VirtualBox * distribution, then only the terms of your commercial VirtualBox * license agreement apply instead of the previous paragraph. */ #ifndef __iprt_log_h__ #define __iprt_log_h__ #include #include #include __BEGIN_DECLS /** @defgroup grp_rt_log RTLog - Logging * @ingroup grp_rt * @{ */ /** * InnoTek Portable Runtime Logging Groups. * (Remember to update RT_LOGGROUP_NAMES!) * * @remark It should be pretty obvious, but just to have * mentioned it, the values are sorted alphabetically (using the * english alphabet) except for _DEFAULT which is always first. * * If anyone might be wondering what the alphabet looks like: * 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 */ typedef enum RTLOGGROUP { /** Default logging group. */ RTLOGGROUP_DEFAULT, RTLOGGROUP_DIR, RTLOGGROUP_FILE, RTLOGGROUP_FS, RTLOGGROUP_LDR, RTLOGGROUP_PATH, RTLOGGROUP_PROCESS, RTLOGGROUP_THREAD, RTLOGGROUP_TIME, RTLOGGROUP_TIMER, RTLOGGROUP_ZIP = 31, RTLOGGROUP_FIRST_USER = 32 } RTLOGGROUP; /** @def RT_LOGGROUP_NAMES * InnoTek Portable Runtime Logging group names. * * Must correspond 100% to RTLOGGROUP! * Don't forget commas! * * @remark It should be pretty obvious, but just to have * mentioned it, the values are sorted alphabetically (using the * english alphabet) except for _DEFAULT which is always first. * * If anyone might be wondering what the alphabet looks like: * 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 */ #define RT_LOGGROUP_NAMES \ "DEFAULT", \ "RT_DIR", \ "RT_FILE", \ "RT_FS", \ "RT_LDR", \ "RT_PATH", \ "RT_PROCESS", \ "RT_TIME", \ "RT_TIMER", \ "RT_THREAD", \ "RT_10", \ "RT_11", \ "RT_12", \ "RT_13", \ "RT_14", \ "RT_15", \ "RT_16", \ "RT_17", \ "RT_18", \ "RT_19", \ "RT_20", \ "RT_21", \ "RT_22", \ "RT_23", \ "RT_24", \ "RT_25", \ "RT_26", \ "RT_27", \ "RT_28", \ "RT_29", \ "RT_30", \ "RT_ZIP" \ /** @def LOG_GROUP * Active logging group. */ #ifndef LOG_GROUP # define LOG_GROUP RTLOGGROUP_DEFAULT #endif /** @def LOG_INSTANCE * Active logging instance. */ #ifndef LOG_INSTANCE # define LOG_INSTANCE NULL #endif /** @def LOG_REL_INSTANCE * Active release logging instance. */ #ifndef LOG_REL_INSTANCE # define LOG_REL_INSTANCE NULL #endif /** Logger structure. */ #ifdef IN_GC typedef struct RTLOGGERGC RTLOGGER; #else typedef struct RTLOGGER RTLOGGER; #endif /** Pointer to logger structure. */ typedef RTLOGGER *PRTLOGGER; /** Pointer to const logger structure. */ typedef const RTLOGGER *PCRTLOGGER; /** Guest context logger structure. */ typedef struct RTLOGGERGC RTLOGGERGC; /** Pointer to guest context logger structure. */ typedef RTLOGGERGC *PRTLOGGERGC; /** Pointer to const guest context logger structure. */ typedef const RTLOGGERGC *PCRTLOGGERGC; /** * Logger function. * * @param pszFormat Format string. * @param ... Optional arguments as specified in the format string. */ typedef DECLCALLBACK(void) FNRTLOGGER(const char *pszFormat, ...); /** Pointer to logger function. */ typedef FNRTLOGGER *PFNRTLOGGER; /** * Flush function. * * @param pLogger Pointer to the logger instance which is to be flushed. */ typedef DECLCALLBACK(void) FNRTLOGFLUSH(PRTLOGGER pLogger); /** Pointer to logger function. */ typedef FNRTLOGFLUSH *PFNRTLOGFLUSH; /** * Flush function. * * @param pLogger Pointer to the logger instance which is to be flushed. */ typedef DECLCALLBACK(void) FNRTLOGFLUSHGC(PRTLOGGERGC pLogger); /** Pointer to logger function. */ typedef GCPTRTYPE(FNRTLOGFLUSHGC *) PFNRTLOGFLUSHGC; /** * Logger instance structure for GC. */ struct RTLOGGERGC { /** Pointer to temporary scratch buffer. * This is used to format the log messages. */ char achScratch[16384]; /** Current scratch buffer position. */ RTUINT offScratch; /** This is set if a prefix is pending. */ RTUINT fPendingPrefix; /** Pointer to the logger function. * This is actually pointer to a wrapper which will push a pointer to the * instance pointer onto the stack before jumping to the real logger function. * A very unfortunate hack to work around the missing variadic macro support in C++. */ GCPTRTYPE(PFNRTLOGGER) pfnLogger; /** Pointer to the flush function. */ PFNRTLOGFLUSHGC pfnFlush; /** Magic number (RTLOGGERGC_MAGIC). */ uint32_t u32Magic; /** Logger instance flags - RTLOGFLAGS. */ RTUINT fFlags; /** Number of groups in the afGroups member. */ RTUINT cGroups; /** Group flags array - RTLOGGRPFLAGS. * This member have variable length and may extend way beyond * the declared size of 1 entry. */ RTUINT afGroups[1]; }; /** RTLOGGERGC::u32Magic value. (John Rogers Searle) */ #define RTLOGGERGC_MAGIC 0x19320731 #ifndef IN_GC /** * Logger instance structure. */ struct RTLOGGER { /** Pointer to temporary scratch buffer. * This is used to format the log messages. */ char achScratch[16384]; /** Current scratch buffer position. */ RTUINT offScratch; /** This is set if a prefix is pending. */ RTUINT fPendingPrefix; /** Pointer to the logger function. * This is actually pointer to a wrapper which will push a pointer to the * instance pointer onto the stack before jumping to the real logger function. * A very unfortunate hack to work around the missing variadic macro support in C++. * (The memory is (not R0) allocated using RTMemExecAlloc().) */ PFNRTLOGGER pfnLogger; /** Pointer to the flush function. */ PFNRTLOGFLUSH pfnFlush; /** Mutex. */ RTSEMFASTMUTEX MutexSem; /** Magic number. */ uint32_t u32Magic; /** Logger instance flags - RTLOGFLAGS. */ RTUINT fFlags; /** Destination flags - RTLOGDEST. */ RTUINT fDestFlags; /** Handle to log file (if open). */ RTFILE File; /** Pointer to filename. * (The memory is allocated in the smae block as RTLOGGER.) */ char *pszFilename; /** Pointer to the group name array. * (The data is readonly and provided by the user.) */ const char * const *papszGroups; /** The max number of groups that there is room for in afGroups and papszGroups. * Used by RTLogCopyGroupAndFlags(). */ RTUINT cMaxGroups; /** Number of groups in the afGroups and papszGroups members. */ RTUINT cGroups; /** Group flags array - RTLOGGRPFLAGS. * This member have variable length and may extend way beyond * the declared size of 1 entry. */ RTUINT afGroups[1]; }; /** RTLOGGER::u32Magic value. (Avram Noam Chomsky) */ #define RTLOGGER_MAGIC 0x19281207 #endif /** * Logger flags. */ typedef enum RTLOGFLAGS { /** The logger instance is disabled for normal output. */ RTLOGFLAGS_DISABLED = 0x00000001, /** The logger instance is using buffered output. */ RTLOGFLAGS_BUFFERED = 0x00000002, /** The logger instance expands LF to CR/LF. */ RTLOGFLAGS_USECRLF = 0x00000010, /** Show relative timestamps with PREFIX_TSC and PREFIX_TS */ RTLOGFLAGS_REL_TS = 0x00010000, /** Show decimal timestamps with PREFIX_TSC and PREFIX_TS */ RTLOGFLAGS_DECIMAL_TS = 0x00020000, /** New lines should be prefixed with group flag number causing the output. */ RTLOGFLAGS_PREFIX_FLAG_NO = 0x00040000, /** New lines should be prefixed with group flag name causing the output. */ RTLOGFLAGS_PREFIX_FLAG = 0x00080000, /** New lines should be prefixed with group number. */ RTLOGFLAGS_PREFIX_GROUP_NO = 0x00100000, /** New lines should be prefixed with group name. */ RTLOGFLAGS_PREFIX_GROUP = 0x00200000, /** New lines should be prefixed with the native thread id. */ RTLOGFLAGS_PREFIX_TID = 0x00400000, /** New lines should be prefixed with thread name. */ RTLOGFLAGS_PREFIX_THREAD = 0x00800000, /** New lines should be prefixed with formatted timestamp since program start. */ RTLOGFLAGS_PREFIX_TIME_PROG = 0x04000000, /** New lines should be prefixed with formatted timestamp (UCT). */ RTLOGFLAGS_PREFIX_TIME = 0x08000000, /** New lines should be prefixed with milliseconds since program start. */ RTLOGFLAGS_PREFIX_MS_PROG = 0x10000000, /** New lines should be prefixed with timestamp. */ RTLOGFLAGS_PREFIX_TSC = 0x20000000, /** New lines should be prefixed with timestamp. */ RTLOGFLAGS_PREFIX_TS = 0x40000000, /** The prefix mask. */ RTLOGFLAGS_PREFIX_MASK = 0x7cff0000 } RTLOGFLAGS; /** * Logger per group flags. */ typedef enum RTLOGGRPFLAGS { /** Enabled. */ RTLOGGRPFLAGS_ENABLED = 0x00000001, /** Level 1 logging. */ RTLOGGRPFLAGS_LEVEL_1 = 0x00000002, /** Level 2 logging. */ RTLOGGRPFLAGS_LEVEL_2 = 0x00000004, /** Level 3 logging. */ RTLOGGRPFLAGS_LEVEL_3 = 0x00000008, /** Level 4 logging. */ RTLOGGRPFLAGS_LEVEL_4 = 0x00000010, /** Level 5 logging. */ RTLOGGRPFLAGS_LEVEL_5 = 0x00000020, /** Level 6 logging. */ RTLOGGRPFLAGS_LEVEL_6 = 0x00000040, /** Flow logging. */ RTLOGGRPFLAGS_FLOW = 0x00000080, /** Lelik logging. */ RTLOGGRPFLAGS_LELIK = 0x00000100, /** Michael logging. */ RTLOGGRPFLAGS_MICHAEL = 0x00000200, /** dmik logging. */ RTLOGGRPFLAGS_DMIK = 0x00000400, /** sunlover logging. */ RTLOGGRPFLAGS_SUNLOVER = 0x00000800, /** Achim logging. */ RTLOGGRPFLAGS_ACHIM = 0x00001000, /** Sander logging. */ RTLOGGRPFLAGS_SANDER = 0x00002000, /** Klaus logging. */ RTLOGGRPFLAGS_KLAUS = 0x00004000, /** Frank logging. */ RTLOGGRPFLAGS_FRANK = 0x00008000, /** bird logging. */ RTLOGGRPFLAGS_BIRD = 0x00010000, /** NoName logging. */ RTLOGGRPFLAGS_NONAME = 0x00020000 } RTLOGGRPFLAGS; /** * Logger destination type. */ typedef enum RTLOGDEST { /** Log to file. */ RTLOGDEST_FILE = 0x00000001, /** Log to stdout. */ RTLOGDEST_STDOUT = 0x00000002, /** Log to stderr. */ RTLOGDEST_STDERR = 0x00000004, /** Log to debugger (win32 only). */ RTLOGDEST_DEBUGGER = 0x00000008, /** Log to com port. */ RTLOGDEST_COM = 0x00000010, /** Just a dummy flag to be used when no other flag applies. */ RTLOGDEST_DUMMY = 0x20000000, /** Log to a user defined output stream. */ RTLOGDEST_USER = 0x40000000 } RTLOGDEST; RTDECL(void) RTLogPrintfEx(void *pvInstance, unsigned fFlags, unsigned iGroup, const char *pszFormat, ...); /* * Determin whether logging is enabled and forcefully normalize the indicators. */ #if (defined(DEBUG) || defined(LOG_ENABLED)) && !defined(LOG_DISABLED) # undef LOG_DISABLED # undef LOG_ENABLED # define LOG_ENABLED #else # undef LOG_ENABLED # undef LOG_DISABLED # define LOG_DISABLED #endif /** @def LogIt * Write to specific logger if group enabled. */ #ifdef LOG_ENABLED # if defined(__AMD64__) || defined(LOG_USE_C99) # define _LogRemoveParentheseis(...) __VA_ARGS__ # define _LogIt(pvInst, fFlags, iGroup, ...) RTLogLoggerEx((PRTLOGGER)pvInst, fFlags, iGroup, __VA_ARGS__) # define LogIt(pvInst, fFlags, iGroup, fmtargs) _LogIt(pvInst, fFlags, iGroup, _LogRemoveParentheseis fmtargs) # else # define LogIt(pvInst, fFlags, iGroup, fmtargs) \ do \ { \ register PRTLOGGER LogIt_pLogger = (PRTLOGGER)(pvInst) ? (PRTLOGGER)(pvInst) : RTLogDefaultInstance(); \ if (LogIt_pLogger) \ { \ register unsigned LogIt_fFlags = LogIt_pLogger->afGroups[(unsigned)(iGroup) < LogIt_pLogger->cGroups ? (unsigned)(iGroup) : 0]; \ if ((LogIt_fFlags & ((fFlags) | RTLOGGRPFLAGS_ENABLED)) == ((fFlags) | RTLOGGRPFLAGS_ENABLED)) \ LogIt_pLogger->pfnLogger fmtargs; \ } \ } while (0) # endif #else # define LogIt(pvInst, fFlags, iGroup, fmtargs) do { } while (0) #endif /** @def Log * Level 1 logging. */ #define Log(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, a) /** @def Log2 * Level 2 logging. */ #define Log2(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_2, LOG_GROUP, a) /** @def Log3 * Level 3 logging. */ #define Log3(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_3, LOG_GROUP, a) /** @def Log4 * Level 4 logging. */ #define Log4(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_4, LOG_GROUP, a) /** @def Log5 * Level 5 logging. */ #define Log5(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_5, LOG_GROUP, a) /** @def Log6 * Level 6 logging. */ #define Log6(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_6, LOG_GROUP, a) /** @def LogFlow * Logging of execution flow. */ #define LogFlow(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_FLOW, LOG_GROUP, a) /** @def LogLelik * lelik logging. */ #define LogLelik(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LELIK, LOG_GROUP, a) /** @def LogMichael * michael logging. */ #define LogMichael(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_MICHAEL, LOG_GROUP, a) /** @def LogDmik * dmik logging. */ #define LogDmik(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_DMIK, LOG_GROUP, a) /** @def LogSunlover * sunlover logging. */ #define LogSunlover(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_SUNLOVER, LOG_GROUP, a) /** @def LogAchim * Achim logging. */ #define LogAchim(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_ACHIM, LOG_GROUP, a) /** @def LogSander * Sander logging. */ #define LogSander(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_SANDER, LOG_GROUP, a) /** @def LogKlaus * klaus logging. */ #define LogKlaus(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_KLAUS, LOG_GROUP, a) /** @def LogFrank * frank logging. */ #define LogFrank(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_FRANK, LOG_GROUP, a) /** @def LogBird * bird logging. */ #define LogBird(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_BIRD, LOG_GROUP, a) /** @def LogNoName * NoName logging. */ #define LogNoName(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_NONAME, LOG_GROUP, a) /** @def LogWarning * The same as Log(), but prepents a "WARNING! " string to the message. * @param m custom log message in format ("string\n" [, args]) * @todo use a Log macro with a variable argument list (requires MSVC8) to * join two separate Log* calls and make this op atomic */ #define LogWarning(m) \ do { Log(("WARNING! ")); Log(m); } while (0) /** @def LogTrace * Macro to trace the execution flow: logs the file name, line number and * function name. Can be easily searched for in log files using the * ">>>>>" pattern (prepended to the beginning of each line). */ #define LogTrace() \ LogFlow((">>>>> %s (%d): %s\n", __FILE__, __LINE__, __PRETTY_FUNCTION__)) /** @def LogTraceMsg * The same as LogTrace but logs a custom log message right after the trace line. * @param m custom log message in format ("string\n" [, args]) * @todo use a Log macro with a variable argument list (requires MSVC8) to * join two separate Log* calls and make this op atomic */ #define LogTraceMsg(m) \ do { LogTrace(); LogFlow(m); } while (0) /** @def LogFlowFunc * Macro to log the execution flow inside C/C++ functions. * Prepends the given log message with the function name followed by a semicolon * and space. * @param m log message in format ("string\n" [, args]) * @todo use a Log macro with a variable argument list (requires MSVC8) to * join two separate Log* calls and make this op atomic */ #define LogFlowFunc(m) \ do { LogFlow(("%s: ", __PRETTY_FUNCTION__)); LogFlow(m); } while (0) /** @def LogWarningFunc * The same as LogWarning(), but prepents the log message with the function name. * @param m log message in format ("string\n" [, args]) * @todo use a Log macro with a variable argument list (requires MSVC8) to * join two separate Log* calls and make this op atomic */ #define LogWarningFunc(m) \ do { Log(("%s: WARNING! ", __PRETTY_FUNCTION__)); Log(m); } while (0) /** @def LogFlowThisFunc * The same as LogFlowFunc but for class functions (methods): the resulting log * line is additionally perpended with a hex value of |this| pointer. * @param m log message in format ("string\n" [, args]) * @todo use a Log macro with a variable argument list (requires MSVC8) to * join two separate Log* calls and make this op atomic */ #define LogFlowThisFunc(m) \ do { LogFlow(("{%p} %s: ", this, __PRETTY_FUNCTION__)); LogFlow(m); } while (0) /** @def LogWarningThisFunc * The same as LogWarningFunc() but for class functions (methods): the resulting * log line is additionally perpended with a hex value of |this| pointer. * @param m log message in format ("string\n" [, args]) * @todo use a Log macro with a variable argument list (requires MSVC8) to * join two separate Log* calls and make this op atomic */ #define LogWarningThisFunc(m) \ do { Log(("{%p} %s: WARNING! ", this, __PRETTY_FUNCTION__)); Log(m); } while (0) /** Shortcut to |LogFlowFunc ("ENTER\n")|, marks the beginnig of the function */ #define LogFlowFuncEnter() LogFlowFunc(("ENTER\n")) /** Shortcut to |LogFlowFunc ("LEAVE\n")|, marks the end of the function */ #define LogFlowFuncLeave() LogFlowFunc(("LEAVE\n")) /** Shortcut to |LogFlowThisFunc ("ENTER\n")|, marks the beginnig of the function */ #define LogFlowThisFuncEnter() LogFlowThisFunc(("ENTER\n")) /** Shortcut to |LogFlowThisFunc ("LEAVE\n")|, marks the end of the function */ #define LogFlowThisFuncLeave() LogFlowThisFunc(("LEAVE\n")) /** @def LogObjRefCnt * Helper macro to print the current reference count of the given COM object * to the log file. * @param obj object in question (must be a pointer to an IUnknown subclass * or simply define COM-style AddRef() and Release() methods) * @note Use it only for temporary debugging. It leaves dummy code even if * logging is disabled. */ #define LogObjRefCnt(obj) \ do { \ int refc = (obj)->AddRef(); -- refc; \ LogFlow((#obj "{%p}.refCnt=%d\n", (obj), refc)); \ (obj)->Release(); \ } while (0) /** @def LogIsItEnabled * Checks whether the specified logging group is enabled or not. */ #ifdef LOG_ENABLED # define LogIsItEnabled(pvInst, fFlags, iGroup) \ LogIsItEnabledInternal((pvInst), (unsigned)(iGroup), (unsigned)(fFlags)) #else # define LogIsItEnabled(pvInst, fFlags, iGroup) (false) #endif /** @def LogIsEnabled * Checks whether level 1 logging is enabled. */ #define LogIsEnabled() LogIsItEnabled(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP) /** @def LogIs2Enabled * Checks whether level 2 logging is enabled. */ #define LogIs2Enabled() LogIsItEnabled(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_2, LOG_GROUP) /** @def LogIs3Enabled * Checks whether level 3 logging is enabled. */ #define LogIs3Enabled() LogIsItEnabled(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_3, LOG_GROUP) /** @def LogIs4Enabled * Checks whether level 4 logging is enabled. */ #define LogIs4Enabled() LogIsItEnabled(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_4, LOG_GROUP) /** @def LogIs5Enabled * Checks whether level 5 logging is enabled. */ #define LogIs5Enabled() LogIsItEnabled(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_5, LOG_GROUP) /** @def LogIs6Enabled * Checks whether level 6 logging is enabled. */ #define LogIs6Enabled() LogIsItEnabled(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_6, LOG_GROUP) /** @def LogIsFlowEnabled * Checks whether execution flow logging is enabled. */ #define LogIsFlowEnabled() LogIsItEnabled(LOG_INSTANCE, RTLOGGRPFLAGS_FLOW, LOG_GROUP) #ifdef __DOXYGEN__ # define LOG_DISABLED # define LOG_ENABLED # define LOG_ENABLE_FLOW #endif /** @def LOG_DISABLED * Use this compile time define to disable all logging macros. It can * be overriden for each of the logging macros by the LOG_ENABLE* * compile time defines. */ /** @def LOG_ENABLED * Use this compile time define to enable logging when not in debug mode * or LOG_DISABLED is set. * This will enabled Log() only. */ /** @def LOG_ENABLE_FLOW * Use this compile time define to enable flow logging when not in * debug mode or LOG_DISABLED is defined. * This will enable LogFlow() only. */ /** @name COM port logging * { */ #ifdef __DOXYGEN__ # define LOG_TO_COM # define LOG_NO_COM #endif /** @def LOG_TO_COM * Redirects the normal loging macros to the serial versions. */ /** @def LOG_NO_COM * Disables all LogCom* macros. */ /** @def LogCom * Generic logging to serial port. */ #if defined(LOG_ENABLED) && !defined(LOG_NO_COM) # define LogCom(a) RTLogComPrintf a #else # define LogCom(a) do { } while (0) #endif /** @def LogComFlow * Logging to serial port of execution flow. */ #if defined(LOG_ENABLED) && defined(LOG_ENABLE_FLOW) && !defined(LOG_NO_COM) # define LogComFlow(a) RTLogComPrintf a #else # define LogComFlow(a) do { } while (0) #endif #ifdef LOG_TO_COM # undef Log # define Log(a) LogCom(a) # undef LogFlow # define LogFlow(a) LogComFlow(a) #endif /** @} */ /** @name Backdoor Logging * @{ */ #ifdef __DOXYGEN__ # define LOG_TO_BACKDOOR # define LOG_NO_BACKDOOR #endif /** @def LOG_TO_BACKDOOR * Redirects the normal logging macros to the backdoor versions. */ /** @def LOG_NO_BACKDOOR * Disables all LogBackdoor* macros. */ /** @def LogBackdoor * Generic logging to the VBox backdoor via port io. */ #if defined(LOG_ENABLED) && !defined(LOG_NO_BACKDOOR) # define LogBackdoor(a) RTLogBackdoorPrintf a #else # define LogBackdoor(a) do { } while (0) #endif /** @def LogBackdoorFlow * Logging of execution flow messages to the backdoor io port. */ #if defined(LOG_ENABLED) && !defined(LOG_NO_BACKDOOR) # define LogBackdoorFlow(a) RTLogBackdoorPrintf a #else # define LogBackdoorFlow(a) do { } while (0) #endif #ifdef LOG_TO_BACKDOOR # undef Log # define Log(a) LogBackdoor(a) # undef LogFlow # define LogFlow(a) LogBackdoorFlow(a) #endif /** @} */ /** @name Release Logging * @{ */ /** @def LogIt * Write to specific logger if group enabled. */ #if defined(__AMD64__) || defined(LOG_USE_C99) # define _LogRelRemoveParentheseis(...) __VA_ARGS__ # define _LogRelIt(pvInst, fFlags, iGroup, ...) RTLogLoggerEx((PRTLOGGER)pvInst, fFlags, iGroup, __VA_ARGS__) # define LogRelIt(pvInst, fFlags, iGroup, fmtargs) \ do \ { \ PRTLOGGER LogRelIt_pLogger = (PRTLOGGER)(pvInst) ? (PRTLOGGER)(pvInst) : RTLogRelDefaultInstance(); \ if (LogRelIt_pLogger) \ _LogRelIt(LogRelIt_pLogger, fFlags, iGroup, _LogRelRemoveParentheseis fmtargs); \ LogIt(LOG_INSTANCE, fFlags, iGroup, fmtargs); \ } while (0) #else # define LogRelIt(pvInst, fFlags, iGroup, fmtargs) \ do \ { \ PRTLOGGER LogRelIt_pLogger = (PRTLOGGER)(pvInst) ? (PRTLOGGER)(pvInst) : RTLogRelDefaultInstance(); \ if (LogRelIt_pLogger) \ { \ unsigned LogIt_fFlags = LogRelIt_pLogger->afGroups[(unsigned)(iGroup) < LogRelIt_pLogger->cGroups ? (unsigned)(iGroup) : 0]; \ if ((LogIt_fFlags & ((fFlags) | RTLOGGRPFLAGS_ENABLED)) == ((fFlags) | RTLOGGRPFLAGS_ENABLED)) \ LogRelIt_pLogger->pfnLogger fmtargs; \ } \ LogIt(LOG_INSTANCE, fFlags, iGroup, fmtargs); \ } while (0) #endif /** @def LogRel * Level 1 logging. */ #define LogRel(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, a) /** @def LogRel2 * Level 2 logging. */ #define LogRel2(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_2, LOG_GROUP, a) /** @def LogRel3 * Level 3 logging. */ #define LogRel3(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_3, LOG_GROUP, a) /** @def LogRel4 * Level 4 logging. */ #define LogRel4(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_4, LOG_GROUP, a) /** @def LogRel5 * Level 5 logging. */ #define LogRel5(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_5, LOG_GROUP, a) /** @def LogRel6 * Level 6 logging. */ #define LogRel6(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_6, LOG_GROUP, a) /** @def LogRelFlow * Logging of execution flow. */ #define LogRelFlow(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_FLOW, LOG_GROUP, a) /** @def LogRelLelik * lelik logging. */ #define LogRelLelik(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LELIK, LOG_GROUP, a) /** @def LogRelMichael * michael logging. */ #define LogRelMichael(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_MICHAEL, LOG_GROUP, a) /** @def LogRelDmik * dmik logging. */ #define LogRelDmik(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_DMIK, LOG_GROUP, a) /** @def LogRelSunlover * sunlover logging. */ #define LogRelSunlover(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_SUNLOVER, LOG_GROUP, a) /** @def LogRelAchim * Achim logging. */ #define LogRelAchim(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_ACHIM, LOG_GROUP, a) /** @def LogRelSander * Sander logging. */ #define LogRelSander(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_SANDER, LOG_GROUP, a) /** @def LogRelKlaus * klaus logging. */ #define LogRelKlaus(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_KLAUS, LOG_GROUP, a) /** @def LogRelFrank * frank logging. */ #define LogRelFrank(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_FRANK, LOG_GROUP, a) /** @def LogRelBird * bird logging. */ #define LogRelBird(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_BIRD, LOG_GROUP, a) /** @def LogRelNoName * NoName logging. */ #define LogRelNoName(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_NONAME, LOG_GROUP, a) /** @def LogRelIsItEnabled * Checks whether the specified logging group is enabled or not. */ #define LogRelIsItEnabled(pvInst, fFlags, iGroup) \ LogRelIsItEnabledInternal((pvInst), (unsigned)(iGroup), (unsigned)(fFlags)) /** @def LogRelIsEnabled * Checks whether level 1 logging is enabled. */ #define LogRelIsEnabled() LogRelIsItEnabled(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP) /** @def LogRelIs2Enabled * Checks whether level 2 logging is enabled. */ #define LogRelIs2Enabled() LogRelIsItEnabled(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_2, LOG_GROUP) /** @def LogRelIs3Enabled * Checks whether level 3 logging is enabled. */ #define LogRelIs3Enabled() LogRelIsItEnabled(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_3, LOG_GROUP) /** @def LogRelIs4Enabled * Checks whether level 4 logging is enabled. */ #define LogRelIs4Enabled() LogRelIsItEnabled(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_4, LOG_GROUP) /** @def LogRelIs5Enabled * Checks whether level 5 logging is enabled. */ #define LogRelIs5Enabled() LogRelIsItEnabled(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_5, LOG_GROUP) /** @def LogRelIs6Enabled * Checks whether level 6 logging is enabled. */ #define LogRelIs6Enabled() LogRelIsItEnabled(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_6, LOG_GROUP) /** @def LogRelIsFlowEnabled * Checks whether execution flow logging is enabled. */ #define LogRelIsFlowEnabled() LogRelIsItEnabled(LOG_REL_INSTANCE, RTLOGGRPFLAGS_FLOW, LOG_GROUP) #ifndef IN_GC /** * Sets the default release logger instance. * * @returns The old default instance. * @param pLogger The new default release logger instance. */ RTDECL(PRTLOGGER) RTLogRelSetDefaultInstance(PRTLOGGER pLogger); #endif /* !IN_GC */ /** * Gets the default release logger instance. * * @returns Pointer to default release logger instance. * @returns NULL if no default release logger instance available. */ RTDECL(PRTLOGGER) RTLogRelDefaultInstance(void); /** Internal worker function. * Don't call directly, use the LogRelIsItEnabled macro! */ DECLINLINE(bool) LogRelIsItEnabledInternal(void *pvInst, unsigned iGroup, unsigned fFlags) { register PRTLOGGER pLogger = (PRTLOGGER)pvInst ? (PRTLOGGER)pvInst : RTLogRelDefaultInstance(); if (pLogger) { register unsigned fGrpFlags = pLogger->afGroups[(unsigned)iGroup < pLogger->cGroups ? (unsigned)iGroup : 0]; if ((fGrpFlags & (fFlags | RTLOGGRPFLAGS_ENABLED)) == (fFlags | RTLOGGRPFLAGS_ENABLED)) return true; } return false; } /** * Write to a logger instance, defaulting to the release one. * * This function will check whether the instance, group and flags makes up a * logging kind which is currently enabled before writing anything to the log. * * @param pLogger Pointer to logger instance. * @param fFlags The logging flags. * @param iGroup The group. * The value ~0U is reserved for compatability with RTLogLogger[V] and is * only for internal usage! * @param pszFormat Format string. * @param ... Format arguments. * @remark This is a worker function for LogRelIt. */ RTDECL(void) RTLogRelLogger(PRTLOGGER pLogger, unsigned fFlags, unsigned iGroup, const char *pszFormat, ...); /** * Write to a logger instance, defaulting to the release one. * * This function will check whether the instance, group and flags makes up a * logging kind which is currently enabled before writing anything to the log. * * @param pLogger Pointer to logger instance. If NULL the default release instance is attempted. * @param fFlags The logging flags. * @param iGroup The group. * The value ~0U is reserved for compatability with RTLogLogger[V] and is * only for internal usage! * @param pszFormat Format string. * @param args Format arguments. */ RTDECL(void) RTLogRelLoggerV(PRTLOGGER pLogger, unsigned fFlags, unsigned iGroup, const char *pszFormat, va_list args); /** * printf like function for writing to the default release log. * * @param pszFormat Printf like format string. * @param ... Optional arguments as specified in pszFormat. * * @remark The API doesn't support formatting of floating point numbers at the moment. */ RTDECL(void) RTLogRelPrintf(const char *pszFormat, ...); /** * vprintf like function for writing to the default release log. * * @param pszFormat Printf like format string. * @param args Optional arguments as specified in pszFormat. * * @remark The API doesn't support formatting of floating point numbers at the moment. */ RTDECL(void) RTLogRelPrintfV(const char *pszFormat, va_list args); /** @} */ /** * Gets the default logger instance. * * @returns Pointer to default logger instance. * @returns NULL if no default logger instance available. */ RTDECL(PRTLOGGER) RTLogDefaultInstance(void); #ifdef IN_RING0 /** * Changes the default logger instance for the current thread. * * @returns IPRT status code. * @param pLogger The logger instance. Pass NULL for deregistration. * @param uKey Associated key for cleanup purposes. If pLogger is NULL, * all instances with this key will be deregistered. So in * order to only deregister the instance associated with the * current thread use 0. */ RTDECL(int) RTLogSetDefaultInstanceThread(PRTLOGGER pLogger, uintptr_t uKey); #endif /* IN_RING0 */ #ifdef LOG_ENABLED /** Internal worker function. * Don't call directly, use the LogIsItEnabled macro! */ DECLINLINE(bool) LogIsItEnabledInternal(void *pvInst, unsigned iGroup, unsigned fFlags) { register PRTLOGGER pLogger = (PRTLOGGER)pvInst ? (PRTLOGGER)pvInst : RTLogDefaultInstance(); if (pLogger) { register unsigned fGrpFlags = pLogger->afGroups[(unsigned)iGroup < pLogger->cGroups ? (unsigned)iGroup : 0]; if ((fGrpFlags & (fFlags | RTLOGGRPFLAGS_ENABLED)) == (fFlags | RTLOGGRPFLAGS_ENABLED)) return true; } return false; } #endif #ifndef IN_GC /** * Creates the default logger instance for a iprt users. * * Any user of the logging features will need to implement * this or use the generic dummy. * * @returns Pointer to the logger instance. */ RTDECL(PRTLOGGER) RTLogDefaultInit(void); /** * Create a logger instance. * * @returns iprt status code. * * @param ppLogger Where to store the logger instance. * @param fFlags Logger instance flags, a combination of the RTLOGFLAGS_* values. * @param pszGroupSettings The initial group settings. * @param pszEnvVarBase Base name for the environment variables for this instance. * @param cGroups Number of groups in the array. * @param papszGroups Pointer to array of groups. This must stick around for the life of the * logger instance. * @param fDestFlags The destination flags. RTLOGDEST_FILE is ORed if pszFilenameFmt specified. * @param pszFilenameFmt Log filename format string. Standard RTStrFormat(). * @param ... Format arguments. */ RTDECL(int) RTLogCreate(PRTLOGGER *ppLogger, RTUINT fFlags, const char *pszGroupSettings, const char *pszEnvVarBase, unsigned cGroups, const char * const * papszGroups, RTUINT fDestFlags, const char *pszFilenameFmt, ...); /** * Create a logger instance for singled threaded ring-0 usage. * * @returns iprt status code. * * @param pLogger Where to create the logger instance. * @param cbLogger The amount of memory available for the logger instance. * @param pfnLogger Pointer to logger wrapper function for the clone. * @param pfnFlush Pointer to flush function for the clone. * @param fFlags Logger instance flags for the clone, a combination of the RTLOGFLAGS_* values. * @param fDestFlags The destination flags. */ RTDECL(int) RTLogCreateForR0(PRTLOGGER pLogger, size_t cbLogger, PFNRTLOGGER pfnLogger, PFNRTLOGFLUSH pfnFlush, RTUINT fFlags, RTUINT fDestFlags); /** * Destroys a logger instance. * * The instance is flushed and all output destinations closed (where applicable). * * @returns iprt status code. * @param pLogger The logger instance which close destroyed. */ RTDECL(int) RTLogDestroy(PRTLOGGER pLogger); /** * Create a logger instance clone for GC usage. * * @returns iprt status code. * * @param pLogger The logger instance to be cloned. * @param pLoggerGC Where to create the GC logger instance. * @param cbLoggerGC Amount of memory allocated to for the GC logger instance clone. * @param pfnLoggerGCPtr Pointer to logger wrapper function for this instance (GC Ptr). * @param pfnFlushGCPtr Pointer to flush function (GC Ptr). * @param fFlags Logger instance flags, a combination of the RTLOGFLAGS_* values. */ RTDECL(int) RTLogCloneGC(PRTLOGGER pLogger, PRTLOGGERGC pLoggerGC, size_t cbLoggerGC, RTGCPTR pfnLoggerGCPtr, RTGCPTR pfnFlushGCPtr, RTUINT fFlags); /** * Flushes a GC logger instance to a HC logger. * * @returns iprt status code. * @param pLogger The HC logger instance to flush pLoggerGC to. * If NULL the default logger is used. * @param pLoggerGC The GC logger instance to flush. */ RTDECL(void) RTLogFlushGC(PRTLOGGER pLogger, PRTLOGGERGC pLoggerGC); /** * Flushes the buffer in one logger instance onto another logger. * * @returns iprt status code. * * @param pSrcLogger The logger instance to flush. * @param pDstLogger The logger instance to flush onto. * If NULL the default logger will be used. */ RTDECL(void) RTLogFlushToLogger(PRTLOGGER pSrcLogger, PRTLOGGER pDstLogger); /** * Copies the group settings and flags from logger instance to another. * * @returns IPRT status code. * @param pDstLogger The destination logger instance. * @param pSrcLogger The source logger instance. If NULL the default one is used. * @param fFlagsOr OR mask for the flags. * @param fFlagsAnd AND mask for the flags. */ RTDECL(int) RTLogCopyGroupsAndFlags(PRTLOGGER pDstLogger, PCRTLOGGER pSrcLogger, unsigned fFlagsOr, unsigned fFlagsAnd); /** * Updates the group settings for the logger instance using the specified * specification string. * * @returns iprt status code. * Failures can safely be ignored. * @param pLogger Logger instance (NULL for default logger). * @param pszVar Value to parse. */ RTDECL(int) RTLogGroupSettings(PRTLOGGER pLogger, const char *pszVar); #endif /* !IN_GC */ /** * Updates the flags for the logger instance using the specified * specification string. * * @returns iprt status code. * Failures can safely be ignored. * @param pLogger Logger instance (NULL for default logger). * @param pszVar Value to parse. */ RTDECL(int) RTLogFlags(PRTLOGGER pLogger, const char *pszVar); /** * Flushes the specified logger. * * @param pLogger The logger instance to flush. * If NULL the default instance is used. The default instance * will not be initialized by this call. */ RTDECL(void) RTLogFlush(PRTLOGGER pLogger); /** * Write to a logger instance. * * @param pLogger Pointer to logger instance. * @param pvCallerRet Ignored. * @param pszFormat Format string. * @param ... Format arguments. */ RTDECL(void) RTLogLogger(PRTLOGGER pLogger, void *pvCallerRet, const char *pszFormat, ...); /** * Write to a logger instance. * * @param pLogger Pointer to logger instance. * @param pszFormat Format string. * @param args Format arguments. */ RTDECL(void) RTLogLoggerV(PRTLOGGER pLogger, const char *pszFormat, va_list args); /** * Write to a logger instance. * * This function will check whether the instance, group and flags makes up a * logging kind which is currently enabled before writing anything to the log. * * @param pLogger Pointer to logger instance. If NULL the default logger instance will be attempted. * @param fFlags The logging flags. * @param iGroup The group. * The value ~0U is reserved for compatability with RTLogLogger[V] and is * only for internal usage! * @param pszFormat Format string. * @param ... Format arguments. * @remark This is a worker function of LogIt. */ RTDECL(void) RTLogLoggerEx(PRTLOGGER pLogger, unsigned fFlags, unsigned iGroup, const char *pszFormat, ...); /** * Write to a logger instance. * * This function will check whether the instance, group and flags makes up a * logging kind which is currently enabled before writing anything to the log. * * @param pLogger Pointer to logger instance. If NULL the default logger instance will be attempted. * @param fFlags The logging flags. * @param iGroup The group. * The value ~0U is reserved for compatability with RTLogLogger[V] and is * only for internal usage! * @param pszFormat Format string. * @param args Format arguments. */ RTDECL(void) RTLogLoggerExV(PRTLOGGER pLogger, unsigned fFlags, unsigned iGroup, const char *pszFormat, va_list args); /** * printf like function for writing to the default log. * * @param pszFormat Printf like format string. * @param ... Optional arguments as specified in pszFormat. * * @remark The API doesn't support formatting of floating point numbers at the moment. */ RTDECL(void) RTLogPrintf(const char *pszFormat, ...); /** * vprintf like function for writing to the default log. * * @param pszFormat Printf like format string. * @param args Optional arguments as specified in pszFormat. * * @remark The API doesn't support formatting of floating point numbers at the moment. */ RTDECL(void) RTLogPrintfV(const char *pszFormat, va_list args); #ifndef DECLARED_FNRTSTROUTPUT /* duplicated in iprt/string.h */ #define DECLARED_FNRTSTROUTPUT /** * Output callback. * * @returns number of bytes written. * @param pvArg User argument. * @param pachChars Pointer to an array of utf-8 characters. * @param cbChars Number of bytes in the character array pointed to by pachChars. */ typedef DECLCALLBACK(size_t) FNRTSTROUTPUT(void *pvArg, const char *pachChars, size_t cbChars); /** Pointer to callback function. */ typedef FNRTSTROUTPUT *PFNRTSTROUTPUT; #endif /** * Partial vsprintf worker implementation. * * @returns number of bytes formatted. * @param pfnOutput Output worker. * Called in two ways. Normally with a string an it's length. * For termination, it's called with NULL for string, 0 for length. * @param pvArg Argument to output worker. * @param pszFormat Format string. * @param args Argument list. */ RTDECL(size_t) RTLogFormatV(PFNRTSTROUTPUT pfnOutput, void *pvArg, const char *pszFormat, va_list args); /** * Write log buffer to COM port. * * @param pach Pointer to the buffer to write. * @param cb Number of bytes to write. */ RTDECL(void) RTLogWriteCom(const char *pach, size_t cb); /** * Prints a formatted string to the serial port used for logging. * * @returns Number of bytes written. * @param pszFormat Format string. * @param ... Optional arguments specified in the format string. */ RTDECL(size_t) RTLogComPrintf(const char *pszFormat, ...); /** * Prints a formatted string to the serial port used for logging. * * @returns Number of bytes written. * @param pszFormat Format string. * @param args Optional arguments specified in the format string. */ RTDECL(size_t) RTLogComPrintfV(const char *pszFormat, va_list args); #if 0 /* not implemented yet */ /** Indicates that the semaphores shall be used to notify the other * part about buffer changes. */ #define LOGHOOKBUFFER_FLAGS_SEMAPHORED 1 /** * Log Hook Buffer. * Use to commuicate between the logger and a log consumer. */ typedef struct RTLOGHOOKBUFFER { /** Write pointer. */ volatile void *pvWrite; /** Read pointer. */ volatile void *pvRead; /** Buffer start. */ void *pvStart; /** Buffer end (exclusive). */ void *pvEnd; /** Signaling semaphore used by the writer to wait on a full buffer. * Only used when indicated in flags. */ void *pvSemWriter; /** Signaling semaphore used by the read to wait on an empty buffer. * Only used when indicated in flags. */ void *pvSemReader; /** Buffer flags. Current reserved and set to zero. */ volatile unsigned fFlags; } RTLOGHOOKBUFFER; /** Pointer to a log hook buffer. */ typedef RTLOGHOOKBUFFER *PRTLOGHOOKBUFFER; /** * Register a logging hook. * * This type of logging hooks are expecting different threads acting * producer and consumer. They share a circular buffer which have two * pointers one for each end. When the buffer is full there are two * alternatives (indicated by a buffer flag), either wait for the * consumer to get it's job done, or to write a generic message saying * buffer overflow. * * Since the waiting would need a signal semaphore, we'll skip that for now. * * @returns iprt status code. * @param pBuffer Pointer to a logger hook buffer. */ RTDECL(int) RTLogRegisterHook(PRTLOGGER pLogger, PRTLOGHOOKBUFFER pBuffer); /** * Deregister a logging hook registerd with RTLogRegisterHook(). * * @returns iprt status code. * @param pBuffer Pointer to a logger hook buffer. */ RTDECL(int) RTLogDeregisterHook(PRTLOGGER pLogger, PRTLOGHOOKBUFFER pBuffer); #endif /* not implemented yet */ /** * Write log buffer to a debugger (RTLOGDEST_DEBUGGER). * * @param pach What to write. * @param cb How much to write. * @remark When linking statically, this function can be replaced by defining your own. */ RTDECL(void) RTLogWriteDebugger(const char *pach, size_t cb); /** * Write log buffer to a user defined output stream (RTLOGDEST_USER). * * @param pach What to write. * @param cb How much to write. * @remark When linking statically, this function can be replaced by defining your own. */ RTDECL(void) RTLogWriteUser(const char *pach, size_t cb); /** * Write log buffer to stdout (RTLOGDEST_STDOUT). * * @param pach What to write. * @param cb How much to write. * @remark When linking statically, this function can be replaced by defining your own. */ RTDECL(void) RTLogWriteStdOut(const char *pach, size_t cb); /** * Write log buffer to stdout (RTLOGDEST_STDERR). * * @param pach What to write. * @param cb How much to write. * @remark When linking statically, this function can be replaced by defining your own. */ RTDECL(void) RTLogWriteStdErr(const char *pach, size_t cb); __END_DECLS /** @} */ #endif