log.h revision 65169cfba1adfc4c86c2b6b99a0b8e67ed216a23
0dc2366f7b9f9f36e10909b1e95edbf2a261c2acVenugopal Iyer * IPRT - Logging.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Copyright (C) 2006-2011 Oracle Corporation
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * This file is part of VirtualBox Open Source Edition (OSE), as
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * available from http://www.virtualbox.org. This file is free software;
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * you can redistribute it and/or modify it under the terms of the GNU
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * General Public License (GPL) as published by the Free Software
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Foundation, in version 2 as it comes in the "COPYING" file of the
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * The contents of this file may alternatively be used under the terms
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * of the Common Development and Distribution License Version 1.0
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * VirtualBox OSE distribution, in which case the provisions of the
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * CDDL are applicable instead of those of the GPL.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * You may elect to license modified versions of this file under the
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * terms and conditions of either the GPL or the CDDL or both.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#ifndef ___iprt_log_h
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define ___iprt_log_h
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#include <iprt/cdefs.h>
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#include <iprt/types.h>
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#include <iprt/stdarg.h>
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @defgroup grp_rt_log RTLog - Logging
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @ingroup grp_rt
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * IPRT Logging Groups.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * (Remember to update RT_LOGGROUP_NAMES!)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @remark It should be pretty obvious, but just to have
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * mentioned it, the values are sorted alphabetically (using the
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * english alphabet) except for _DEFAULT which is always first.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * If anyone might be wondering what the alphabet looks like:
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * 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
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing Chinatypedef enum RTLOGGROUP
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Default logging group. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGGROUP_DEFAULT,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGGROUP_FILE,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGGROUP_PATH,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGGROUP_PROCESS,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGGROUP_SYMLINK,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGGROUP_THREAD,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGGROUP_TIME,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGGROUP_TIMER,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGGROUP_ZIP = 31,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGGROUP_FIRST_USER = 32
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def RT_LOGGROUP_NAMES
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * IPRT Logging group names.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Must correspond 100% to RTLOGGROUP!
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Don't forget commas!
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @remark It should be pretty obvious, but just to have
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * mentioned it, the values are sorted alphabetically (using the
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * english alphabet) except for _DEFAULT which is always first.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * If anyone might be wondering what the alphabet looks like:
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * 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
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define RT_LOGGROUP_NAMES \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LOG_GROUP
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Active logging group.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#ifndef LOG_GROUP
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LOG_GROUP RTLOGGROUP_DEFAULT
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LOG_INSTANCE
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Active logging instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#ifndef LOG_INSTANCE
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LOG_INSTANCE NULL
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LOG_REL_INSTANCE
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Active release logging instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#ifndef LOG_REL_INSTANCE
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LOG_REL_INSTANCE NULL
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LOG_FN_FMT
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * You can use this to specify you desired way of printing __PRETTY_FUNCTION__
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * if you dislike the default one.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#ifndef LOG_FN_FMT
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LOG_FN_FMT "%Rfn"
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** Logger structure. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing Chinatypedef struct RTLOGGERRC RTLOGGER;
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing Chinatypedef struct RTLOGGER RTLOGGER;
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** Pointer to logger structure. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing Chinatypedef RTLOGGER *PRTLOGGER;
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** Pointer to const logger structure. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing Chinatypedef const RTLOGGER *PCRTLOGGER;
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** Guest context logger structure. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing Chinatypedef struct RTLOGGERRC RTLOGGERRC;
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** Pointer to guest context logger structure. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing Chinatypedef RTLOGGERRC *PRTLOGGERRC;
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** Pointer to const guest context logger structure. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing Chinatypedef const RTLOGGERRC *PCRTLOGGERRC;
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Used for signalling the log header/footer callback what to do.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing Chinatypedef enum RTLOGPHASE
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Begin of the logging. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGPHASE_BEGIN = 0,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** End of the logging. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Before rotating the log file. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGPHASE_PREROTATE,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** After rotating the log file. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGPHASE_POSTROTATE,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** 32-bit type blow up hack. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGPHASE_32BIT_HACK = 0x7fffffff
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Logger function.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pszFormat Format string.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param ... Optional arguments as specified in the format string.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing Chinatypedef DECLCALLBACK(void) FNRTLOGGER(const char *pszFormat, ...);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** Pointer to logger function. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing Chinatypedef FNRTLOGGER *PFNRTLOGGER;
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Flush function.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pLogger Pointer to the logger instance which is to be flushed.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing Chinatypedef DECLCALLBACK(void) FNRTLOGFLUSH(PRTLOGGER pLogger);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** Pointer to flush function. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing Chinatypedef FNRTLOGFLUSH *PFNRTLOGFLUSH;
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Flush function.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pLogger Pointer to the logger instance which is to be flushed.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing Chinatypedef DECLCALLBACK(void) FNRTLOGFLUSHGC(PRTLOGGERRC pLogger);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** Pointer to logger function. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing Chinatypedef RCPTRTYPE(FNRTLOGFLUSHGC *) PFNRTLOGFLUSHGC;
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Header/footer message callback.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pLogger Pointer to the logger instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pszFormat Format string.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param ... Optional arguments specified in the format string.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing Chinatypedef DECLCALLBACK(void) FNRTLOGPHASEMSG(PRTLOGGER pLogger, const char *pszFormat, ...);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** Pointer to header/footer message callback function. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing Chinatypedef FNRTLOGPHASEMSG *PFNRTLOGPHASEMSG;
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Log file header/footer callback.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pLogger Pointer to the logger instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param enmLogPhase Indicates at what time the callback is invoked.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pfnLogPhaseMsg Callback for writing the header/footer (RTLogPrintf
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * and others are out of bounds).
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing Chinatypedef DECLCALLBACK(void) FNRTLOGPHASE(PRTLOGGER pLogger, RTLOGPHASE enmLogPhase, PFNRTLOGPHASEMSG pfnLogPhaseMsg);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** Pointer to log header/footer callback function. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing Chinatypedef FNRTLOGPHASE *PFNRTLOGPHASE;
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Custom log prefix callback.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @returns The number of chars written.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pLogger Pointer to the logger instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pchBuf Output buffer pointer.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * No need to terminate the output.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param cchBuf The size of the output buffer.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pvUser The user argument.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing Chinatypedef DECLCALLBACK(size_t) FNRTLOGPREFIX(PRTLOGGER pLogger, char *pchBuf, size_t cchBuf, void *pvUser);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** Pointer to prefix callback function. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing Chinatypedef FNRTLOGPREFIX *PFNRTLOGPREFIX;
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Logger instance structure for GC.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing Chinastruct RTLOGGERRC
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Pointer to temporary scratch buffer.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * This is used to format the log messages. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China char achScratch[32768];
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Current scratch buffer position. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China uint32_t offScratch;
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** This is set if a prefix is pending. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China bool fPendingPrefix;
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China bool afAlignment[3];
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Pointer to the logger function.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * This is actually pointer to a wrapper which will push a pointer to the
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * instance pointer onto the stack before jumping to the real logger function.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * A very unfortunate hack to work around the missing variadic macro support in C++. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RCPTRTYPE(PFNRTLOGGER) pfnLogger;
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Pointer to the flush function. */
0dc2366f7b9f9f36e10909b1e95edbf2a261c2acVenugopal Iyer /** Magic number (RTLOGGERRC_MAGIC). */
0dc2366f7b9f9f36e10909b1e95edbf2a261c2acVenugopal Iyer /** Logger instance flags - RTLOGFLAGS. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China uint32_t fFlags;
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Number of groups in the afGroups member. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Group flags array - RTLOGGRPFLAGS.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * This member have variable length and may extend way beyond
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * the declared size of 1 entry. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China uint32_t afGroups[1];
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** RTLOGGERRC::u32Magic value. (John Rogers Searle) */
0dc2366f7b9f9f36e10909b1e95edbf2a261c2acVenugopal Iyer/** Pointer to internal logger bits. */
0dc2366f7b9f9f36e10909b1e95edbf2a261c2acVenugopal Iyertypedef struct RTLOGGERINTERNAL *PRTLOGGERINTERNAL;
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Logger instance structure.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Pointer to temporary scratch buffer.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * This is used to format the log messages. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China char achScratch[49152];
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Current scratch buffer position. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China uint32_t offScratch;
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Magic number. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China uint32_t u32Magic;
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Logger instance flags - RTLOGFLAGS. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China uint32_t fFlags;
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Destination flags - RTLOGDEST. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China uint32_t fDestFlags;
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Pointer to the internal bits of the logger.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * (The memory is allocated in the same block as RTLOGGER.) */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China PRTLOGGERINTERNAL pInt;
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Pointer to the logger function (used in non-C99 mode only).
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * This is actually pointer to a wrapper which will push a pointer to the
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * instance pointer onto the stack before jumping to the real logger function.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * A very unfortunate hack to work around the missing variadic macro
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * support in older C++/C standards. (The memory is allocated using
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * RTMemExecAlloc(), except for agnostic R0 code.) */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China PFNRTLOGGER pfnLogger;
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Number of groups in the afGroups and papszGroups members. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China uint32_t cGroups;
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Group flags array - RTLOGGRPFLAGS.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * This member have variable length and may extend way beyond
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * the declared size of 1 entry. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China uint32_t afGroups[1];
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** RTLOGGER::u32Magic value. (Avram Noam Chomsky) */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define RTLOGGER_MAGIC UINT32_C(0x19281207)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#endif /* !IN_RC */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing Chinatypedef enum RTLOGFLAGS
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** The logger instance is disabled for normal output. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGFLAGS_DISABLED = 0x00000001,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** The logger instance is using buffered output. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGFLAGS_BUFFERED = 0x00000002,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** The logger instance expands LF to CR/LF. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGFLAGS_USECRLF = 0x00000010,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Append to the log destination where applicable. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGFLAGS_APPEND = 0x00000020,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Show relative timestamps with PREFIX_TSC and PREFIX_TS */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGFLAGS_REL_TS = 0x00000040,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Show decimal timestamps with PREFIX_TSC and PREFIX_TS */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGFLAGS_DECIMAL_TS = 0x00000080,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Open the file in write through mode. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGFLAGS_WRITE_THROUGH = 0x00000100,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Flush the file to disk when flushing the buffer. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGFLAGS_FLUSH = 0x00000200,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Restrict the number of log entries per group. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGFLAGS_RESTRICT_GROUPS = 0x00000400,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** New lines should be prefixed with the write and read lock counts. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGFLAGS_PREFIX_LOCK_COUNTS = 0x00008000,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** New lines should be prefixed with the CPU id (ApicID on intel/amd). */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGFLAGS_PREFIX_CPUID = 0x00010000,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** New lines should be prefixed with the native process id. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGFLAGS_PREFIX_PID = 0x00020000,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** New lines should be prefixed with group flag number causing the output. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGFLAGS_PREFIX_FLAG_NO = 0x00040000,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** New lines should be prefixed with group flag name causing the output. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGFLAGS_PREFIX_FLAG = 0x00080000,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** New lines should be prefixed with group number. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGFLAGS_PREFIX_GROUP_NO = 0x00100000,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** New lines should be prefixed with group name. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGFLAGS_PREFIX_GROUP = 0x00200000,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** New lines should be prefixed with the native thread id. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGFLAGS_PREFIX_TID = 0x00400000,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** New lines should be prefixed with thread name. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGFLAGS_PREFIX_THREAD = 0x00800000,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** New lines should be prefixed with data from a custom callback. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGFLAGS_PREFIX_CUSTOM = 0x01000000,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** New lines should be prefixed with formatted timestamp since program start. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGFLAGS_PREFIX_TIME_PROG = 0x04000000,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** New lines should be prefixed with formatted timestamp (UCT). */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGFLAGS_PREFIX_TIME = 0x08000000,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** New lines should be prefixed with milliseconds since program start. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGFLAGS_PREFIX_MS_PROG = 0x10000000,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** New lines should be prefixed with timestamp. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGFLAGS_PREFIX_TSC = 0x20000000,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** New lines should be prefixed with timestamp. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGFLAGS_PREFIX_TS = 0x40000000,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** The prefix mask. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGFLAGS_PREFIX_MASK = 0x7dff8000
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Logger per group flags.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing Chinatypedef enum RTLOGGRPFLAGS
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGGRPFLAGS_ENABLED = 0x00000001,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Level 1 logging. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGGRPFLAGS_LEVEL_1 = 0x00000002,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Level 2 logging. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGGRPFLAGS_LEVEL_2 = 0x00000004,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Level 3 logging. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGGRPFLAGS_LEVEL_3 = 0x00000008,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Level 4 logging. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGGRPFLAGS_LEVEL_4 = 0x00000010,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Level 5 logging. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGGRPFLAGS_LEVEL_5 = 0x00000020,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Level 6 logging. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGGRPFLAGS_LEVEL_6 = 0x00000040,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Flow logging. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGGRPFLAGS_FLOW = 0x00000080,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Restrict the number of log entries. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGGRPFLAGS_RESTRICT = 0x00000100,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Lelik logging. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGGRPFLAGS_LELIK = 0x00010000,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Michael logging. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGGRPFLAGS_MICHAEL = 0x00020000,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** sunlover logging. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGGRPFLAGS_SUNLOVER = 0x00040000,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Achim logging. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGGRPFLAGS_ACHIM = 0x00080000,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Sander logging. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGGRPFLAGS_SANDER = 0x00100000,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Klaus logging. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGGRPFLAGS_KLAUS = 0x00200000,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Frank logging. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGGRPFLAGS_FRANK = 0x00400000,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** bird logging. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGGRPFLAGS_BIRD = 0x00800000,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** aleksey logging. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGGRPFLAGS_ALEKSEY = 0x01000000,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** dj logging. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGGRPFLAGS_DJ = 0x02000000,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** NoName logging. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGGRPFLAGS_NONAME = 0x04000000
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Logger destination type.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing Chinatypedef enum RTLOGDEST
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Log to file. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGDEST_FILE = 0x00000001,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Log to stdout. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGDEST_STDOUT = 0x00000002,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Log to stderr. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGDEST_STDERR = 0x00000004,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Log to debugger (win32 only). */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGDEST_DEBUGGER = 0x00000008,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Log to com port. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGDEST_COM = 0x00000010,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Just a dummy flag to be used when no other flag applies. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGDEST_DUMMY = 0x20000000,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Log to a user defined output stream. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLOGDEST_USER = 0x40000000
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(void) RTLogPrintfEx(void *pvInstance, unsigned fFlags, unsigned iGroup, const char *pszFormat, ...);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#ifdef DOXYGEN_RUNNING
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LOG_DISABLED
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LOG_ENABLED
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LOG_ENABLE_FLOW
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LOG_DISABLED
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Use this compile time define to disable all logging macros. It can
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * be overridden for each of the logging macros by the LOG_ENABLE*
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * compile time defines.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LOG_ENABLED
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Use this compile time define to enable logging when not in debug mode
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * or LOG_DISABLED is set.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * This will enabled Log() only.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LOG_ENABLE_FLOW
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Use this compile time define to enable flow logging when not in
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * debug mode or LOG_DISABLED is defined.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * This will enable LogFlow() only.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Determine whether logging is enabled and forcefully normalize the indicators.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#if (defined(DEBUG) || defined(LOG_ENABLED)) && !defined(LOG_DISABLED)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# undef LOG_DISABLED
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# undef LOG_ENABLED
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LOG_ENABLED
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# undef LOG_ENABLED
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# undef LOG_DISABLED
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LOG_DISABLED
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LOG_USE_C99
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Governs the use of variadic macros.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#ifndef LOG_USE_C99
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# if defined(RT_ARCH_AMD64) || defined(RT_OS_DARWIN) || defined(RT_ARCH_SPARC) || defined(RT_ARCH_SPARC64)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LOG_USE_C99
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Write to specific logger if group enabled.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#ifdef LOG_ENABLED
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# if defined(LOG_USE_C99)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define _LogRemoveParentheseis(...) __VA_ARGS__
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define _LogIt(a_pvInst, a_fFlags, a_iGroup, ...) RTLogLoggerEx((PRTLOGGER)a_pvInst, a_fFlags, a_iGroup, __VA_ARGS__)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogIt(a_pvInst, a_fFlags, a_iGroup, fmtargs) _LogIt(a_pvInst, a_fFlags, a_iGroup, _LogRemoveParentheseis fmtargs)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define _LogItAlways(a_pvInst, a_fFlags, a_iGroup, ...) RTLogLoggerEx((PRTLOGGER)a_pvInst, a_fFlags, ~0U, __VA_ARGS__)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogItAlways(a_pvInst, a_fFlags, a_iGroup, fmtargs) _LogItAlways(a_pvInst, a_fFlags, a_iGroup, _LogRemoveParentheseis fmtargs)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** @todo invent a flag or something for skipping the group check so we can pass iGroup. LogItAlways. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogIt(a_pvInst, a_fFlags, a_iGroup, fmtargs) \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China register PRTLOGGER LogIt_pLogger = (PRTLOGGER)(a_pvInst) ? (PRTLOGGER)(a_pvInst) : RTLogDefaultInstance(); \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China if ( LogIt_pLogger \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China && !(LogIt_pLogger->fFlags & RTLOGFLAGS_DISABLED)) \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China register unsigned LogIt_fFlags = LogIt_pLogger->afGroups[(unsigned)(a_iGroup) < LogIt_pLogger->cGroups ? (unsigned)(a_iGroup) : 0]; \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China if ((LogIt_fFlags & ((a_fFlags) | RTLOGGRPFLAGS_ENABLED)) == ((a_fFlags) | RTLOGGRPFLAGS_ENABLED)) \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China LogIt_pLogger->pfnLogger fmtargs; \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogItAlways(a_pvInst, a_fFlags, a_iGroup, fmtargs) \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China register PRTLOGGER LogIt_pLogger = (PRTLOGGER)(a_pvInst) ? (PRTLOGGER)(a_pvInst) : RTLogDefaultInstance(); \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China if ( LogIt_pLogger \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China && !(LogIt_pLogger->fFlags & RTLOGFLAGS_DISABLED)) \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China LogIt_pLogger->pfnLogger fmtargs; \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogIt(a_pvInst, a_fFlags, a_iGroup, fmtargs) do { } while (0)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogItAlways(a_pvInst, a_fFlags, a_iGroup, fmtargs) do { } while (0)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# if defined(LOG_USE_C99)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define _LogRemoveParentheseis(...) __VA_ARGS__
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define _LogIt(a_pvInst, a_fFlags, a_iGroup, ...) do { } while (0)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define _LogItAlways(a_pvInst, a_fFlags, a_iGroup, ...) do { } while (0)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Level 1 logging that works regardless of the group settings.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogAlways(a) LogItAlways(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, a)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Level 1 logging.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define Log(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, a)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Level 2 logging.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define Log2(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_2, LOG_GROUP, a)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Level 3 logging.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define Log3(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_3, LOG_GROUP, a)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Level 4 logging.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define Log4(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_4, LOG_GROUP, a)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Level 5 logging.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define Log5(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_5, LOG_GROUP, a)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Level 6 logging.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define Log6(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_6, LOG_GROUP, a)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Logging of execution flow.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogFlow(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_FLOW, LOG_GROUP, a)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogLelik
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * lelik logging.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogLelik(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LELIK, LOG_GROUP, a)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogMichael
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * michael logging.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogMichael(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_MICHAEL, LOG_GROUP, a)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogSunlover
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * sunlover logging.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogSunlover(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_SUNLOVER, LOG_GROUP, a)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogAchim
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Achim logging.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogAchim(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_ACHIM, LOG_GROUP, a)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogSander
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Sander logging.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogSander(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_SANDER, LOG_GROUP, a)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogKlaus
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * klaus logging.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogKlaus(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_KLAUS, LOG_GROUP, a)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogFrank
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * frank logging.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogFrank(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_FRANK, LOG_GROUP, a)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogBird(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_BIRD, LOG_GROUP, a)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogAleksey
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * aleksey logging.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogAleksey(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_ALEKSEY, LOG_GROUP, a)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogDJ(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_DJ, LOG_GROUP, a)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogNoName
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * NoName logging.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogNoName(a) LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_NONAME, LOG_GROUP, a)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogWarning
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * The same as Log(), but prepents a <tt>"WARNING! "</tt> string to the message.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param a Custom log message in format <tt>("string\n" [, args])</tt>.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#if defined(LOG_USE_C99)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogWarning(a) \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China _LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, "WARNING! %M", _LogRemoveParentheseis a )
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogWarning(a) \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China do { Log(("WARNING! ")); Log(a); } while (0)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogTrace
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Macro to trace the execution flow: logs the file name, line number and
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * function name. Can be easily searched for in log files using the
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * ">>>>>" pattern (prepended to the beginning of each line).
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogTrace() \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China LogFlow((">>>>> %s (%d): " LOG_FN_FMT "\n", __FILE__, __LINE__, __PRETTY_FUNCTION__))
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogTraceMsg
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * The same as LogTrace but logs a custom log message right after the trace line.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param a Custom log message in format <tt>("string\n" [, args])</tt>.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#ifdef LOG_USE_C99
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogTraceMsg(a) \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China _LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_FLOW, LOG_GROUP, ">>>>> %s (%d): " LOG_FN_FMT ": %M", __FILE__, __LINE__, __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogTraceMsg(a) \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China do { LogFlow((">>>>> %s (%d): " LOG_FN_FMT ": ", __FILE__, __LINE__, __PRETTY_FUNCTION__)); LogFlow(a); } while (0)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Level 1 logging inside C/C++ functions.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Prepends the given log message with the function name followed by a
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * semicolon and space.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param a Log message in format <tt>("string\n" [, args])</tt>.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#ifdef LOG_USE_C99
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogFunc(a) \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China _LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, LOG_FN_FMT ": %M", __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogFunc(a) \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China do { Log((LOG_FN_FMT ": ", __PRETTY_FUNCTION__)); Log(a); } while (0)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogThisFunc
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * The same as LogFunc but for class functions (methods): the resulting log
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * line is additionally prepended with a hex value of |this| pointer.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param a Log message in format <tt>("string\n" [, args])</tt>.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#ifdef LOG_USE_C99
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogThisFunc(a) \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China _LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, "{%p} " LOG_FN_FMT ": %M", this, __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogThisFunc(a) \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China do { Log(("{%p} " LOG_FN_FMT ": ", this, __PRETTY_FUNCTION__)); Log(a); } while (0)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogFlowFunc
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Macro to log the execution flow inside C/C++ functions.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Prepends the given log message with the function name followed by
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * a semicolon and space.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param a Log message in format <tt>("string\n" [, args])</tt>.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#ifdef LOG_USE_C99
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogFlowFunc(a) \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China _LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_FLOW, LOG_GROUP, LOG_FN_FMT ": %M", __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogFlowFunc(a) \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China do { LogFlow((LOG_FN_FMT ": ", __PRETTY_FUNCTION__)); LogFlow(a); } while (0)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogWarningFunc
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * The same as LogWarning(), but prepents the log message with the function name.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param a Log message in format <tt>("string\n" [, args])</tt>.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#ifdef LOG_USE_C99
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogWarningFunc(a) \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China _LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, LOG_FN_FMT ": WARNING! %M", __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogWarningFunc(a) \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China do { Log((LOG_FN_FMT ": WARNING! ", __PRETTY_FUNCTION__)); Log(a); } while (0)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogFlowThisFunc
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * The same as LogFlowFunc but for class functions (methods): the resulting log
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * line is additionally prepended with a hex value of |this| pointer.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param a Log message in format <tt>("string\n" [, args])</tt>.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#ifdef LOG_USE_C99
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogFlowThisFunc(a) \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China _LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_FLOW, LOG_GROUP, "{%p} " LOG_FN_FMT ": %M", this, __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogFlowThisFunc(a) \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China do { LogFlow(("{%p} " LOG_FN_FMT ": ", this, __PRETTY_FUNCTION__)); LogFlow(a); } while (0)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogWarningThisFunc
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * The same as LogWarningFunc() but for class functions (methods): the resulting
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * log line is additionally prepended with a hex value of |this| pointer.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param a Log message in format <tt>("string\n" [, args])</tt>.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#ifdef LOG_USE_C99
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogWarningThisFunc(a) \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China _LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, "{%p} " LOG_FN_FMT ": WARNING! %M", this, __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogWarningThisFunc(a) \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China do { Log(("{%p} " LOG_FN_FMT ": WARNING! ", this, __PRETTY_FUNCTION__)); Log(a); } while (0)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** Shortcut to |LogFlowFunc ("ENTER\n")|, marks the beginnig of the function. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogFlowFuncEnter() LogFlowFunc(("ENTER\n"))
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** Shortcut to |LogFlowFunc ("LEAVE\n")|, marks the end of the function. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogFlowFuncLeave() LogFlowFunc(("LEAVE\n"))
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** Shortcut to |LogFlowThisFunc ("ENTER\n")|, marks the beginnig of the function. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogFlowThisFuncEnter() LogFlowThisFunc(("ENTER\n"))
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** Shortcut to |LogFlowThisFunc ("LEAVE\n")|, marks the end of the function. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogFlowThisFuncLeave() LogFlowThisFunc(("LEAVE\n"))
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogObjRefCnt
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Helper macro to print the current reference count of the given COM object
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * to the log file.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pObj Pointer to the object in question (must be a pointer to an
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * IUnknown subclass or simply define COM-style AddRef() and
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Release() methods)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @note Use it only for temporary debugging. It leaves dummy code even if
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * logging is disabled.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogObjRefCnt(pObj) \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China int refc = (pObj)->AddRef(); \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China LogFlow((#pObj "{%p}.refCnt=%d\n", (pObj), refc - 1)); \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China (pObj)->Release(); \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogIsItEnabled
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Checks whether the specified logging group is enabled or not.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#ifdef LOG_ENABLED
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogIsItEnabled(a_pvInst, a_fFlags, a_iGroup) \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China LogIsItEnabledInternal((a_pvInst), (unsigned)(a_iGroup), (unsigned)(a_fFlags))
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogIsItEnabled(a_pvInst, a_fFlags, a_iGroup) (false)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogIsEnabled
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Checks whether level 1 logging is enabled.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogIsEnabled() LogIsItEnabled(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogIs2Enabled
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Checks whether level 2 logging is enabled.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogIs2Enabled() LogIsItEnabled(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_2, LOG_GROUP)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogIs3Enabled
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Checks whether level 3 logging is enabled.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogIs3Enabled() LogIsItEnabled(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_3, LOG_GROUP)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogIs4Enabled
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Checks whether level 4 logging is enabled.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogIs4Enabled() LogIsItEnabled(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_4, LOG_GROUP)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogIs5Enabled
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Checks whether level 5 logging is enabled.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogIs5Enabled() LogIsItEnabled(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_5, LOG_GROUP)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogIs6Enabled
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Checks whether level 6 logging is enabled.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogIs6Enabled() LogIsItEnabled(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_6, LOG_GROUP)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogIsFlowEnabled
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Checks whether execution flow logging is enabled.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogIsFlowEnabled() LogIsItEnabled(LOG_INSTANCE, RTLOGGRPFLAGS_FLOW, LOG_GROUP)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @name Passing Function Call Position When Logging.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * This is a little bit ugly as we have to omit the comma before the
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * position parameters so that we don't inccur any overhead in non-logging
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * builds (!defined(LOG_ENABLED).
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** Source position for passing to a function call. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#ifdef LOG_ENABLED
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define RTLOG_COMMA_SRC_POS , __FILE__, __LINE__, __PRETTY_FUNCTION__
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define RTLOG_COMMA_SRC_POS RT_NOTHING
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** Source position declaration. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#ifdef LOG_ENABLED
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define RTLOG_COMMA_SRC_POS_DECL , const char *pszFile, unsigned iLine, const char *pszFunction
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define RTLOG_COMMA_SRC_POS_DECL RT_NOTHING
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** Source position arguments. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#ifdef LOG_ENABLED
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define RTLOG_COMMA_SRC_POS_ARGS , pszFile, iLine, pszFunction
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define RTLOG_COMMA_SRC_POS_ARGS RT_NOTHING
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** Applies NOREF() to the source position arguments. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#ifdef LOG_ENABLED
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define RTLOG_SRC_POS_NOREF() do { NOREF(pszFile); NOREF(iLine); NOREF(pszFunction); } while (0)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define RTLOG_SRC_POS_NOREF() do { } while (0)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @name Release Logging
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#ifdef DOXYGEN_RUNNING
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define RTLOG_REL_DISABLED
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define RTLOG_REL_ENABLED
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def RTLOG_REL_DISABLED
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Use this compile time define to disable all release logging
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def RTLOG_REL_ENABLED
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Use this compile time define to override RTLOG_REL_DISABLE.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Determine whether release logging is enabled and forcefully normalize the indicators.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#if !defined(RTLOG_REL_DISABLED) || defined(RTLOG_REL_ENABLED)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# undef RTLOG_REL_DISABLED
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# undef RTLOG_REL_ENABLED
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define RTLOG_REL_ENABLED
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# undef RTLOG_REL_ENABLED
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# undef RTLOG_REL_DISABLED
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define RTLOG_REL_DISABLED
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Write to specific logger if group enabled.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#ifdef RTLOG_REL_ENABLED
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# if defined(LOG_USE_C99)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define _LogRelRemoveParentheseis(...) __VA_ARGS__
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define _LogRelIt(a_pvInst, a_fFlags, a_iGroup, ...) \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China PRTLOGGER LogRelIt_pLogger = (PRTLOGGER)(a_pvInst) ? (PRTLOGGER)(a_pvInst) : RTLogRelDefaultInstance(); \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China if ( LogRelIt_pLogger \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China && !(LogRelIt_pLogger->fFlags & RTLOGFLAGS_DISABLED)) \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTLogLoggerEx(LogRelIt_pLogger, a_fFlags, a_iGroup, __VA_ARGS__); \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China _LogIt(LOG_INSTANCE, a_fFlags, a_iGroup, __VA_ARGS__); \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogRelIt(a_pvInst, a_fFlags, a_iGroup, fmtargs) _LogRelIt(a_pvInst, a_fFlags, a_iGroup, _LogRelRemoveParentheseis fmtargs)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogRelIt(a_pvInst, a_fFlags, a_iGroup, fmtargs) \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China PRTLOGGER LogRelIt_pLogger = (PRTLOGGER)(a_pvInst) ? (PRTLOGGER)(a_pvInst) : RTLogRelDefaultInstance(); \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China if ( LogRelIt_pLogger \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China && !(LogRelIt_pLogger->fFlags & RTLOGFLAGS_DISABLED)) \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China unsigned LogIt_fFlags = LogRelIt_pLogger->afGroups[(unsigned)(a_iGroup) < LogRelIt_pLogger->cGroups ? (unsigned)(a_iGroup) : 0]; \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China if ((LogIt_fFlags & ((a_fFlags) | RTLOGGRPFLAGS_ENABLED)) == ((a_fFlags) | RTLOGGRPFLAGS_ENABLED)) \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China LogRelIt_pLogger->pfnLogger fmtargs; \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China LogIt(LOG_INSTANCE, a_fFlags, a_iGroup, fmtargs); \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#else /* !RTLOG_REL_ENABLED */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogRelIt(a_pvInst, a_fFlags, a_iGroup, fmtargs) do { } while (0)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# if defined(LOG_USE_C99)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define _LogRelRemoveParentheseis(...) __VA_ARGS__
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define _LogRelIt(a_pvInst, a_fFlags, a_iGroup, ...) do { } while (0)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#endif /* !RTLOG_REL_ENABLED */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Level 1 logging.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogRel(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, a)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Level 2 logging.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogRel2(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_2, LOG_GROUP, a)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Level 3 logging.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogRel3(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_3, LOG_GROUP, a)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Level 4 logging.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogRel4(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_4, LOG_GROUP, a)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Level 5 logging.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogRel5(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_5, LOG_GROUP, a)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Level 6 logging.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogRel6(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_6, LOG_GROUP, a)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogRelFlow
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Logging of execution flow.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogRelFlow(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_FLOW, LOG_GROUP, a)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogRelFunc
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Release logging. Prepends the given log message with the function name
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * followed by a semicolon and space.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#ifdef LOG_USE_C99
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogRelFunc(a) \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China _LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, LOG_FN_FMT ": %M", __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogFunc(a) \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China _LogIt(LOG_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, LOG_FN_FMT ": %M", __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogRelFunc(a) \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China do { LogRel((LOG_FN_FMT ": ", __PRETTY_FUNCTION__)); LogRel(a); } while (0)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogRelThisFunc
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * The same as LogRelFunc but for class functions (methods): the resulting log
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * line is additionally prepended with a hex value of |this| pointer.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#ifdef LOG_USE_C99
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogRelThisFunc(a) \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China _LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP, "{%p} " LOG_FN_FMT ": %M", this, __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogRelThisFunc(a) \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China do { LogRel(("{%p} " LOG_FN_FMT ": ", this, __PRETTY_FUNCTION__)); LogRel(a); } while (0)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogRelFlowFunc
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Release logging. Macro to log the execution flow inside C/C++ functions.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Prepends the given log message with the function name followed by
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * a semicolon and space.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param a Log message in format <tt>("string\n" [, args])</tt>.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#ifdef LOG_USE_C99
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogRelFlowFunc(a) \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China _LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_FLOW, LOG_GROUP, LOG_FN_FMT ": %M", __PRETTY_FUNCTION__, _LogRemoveParentheseis a )
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogRelFlowFunc(a) \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China do { LogRelFlow((LOG_FN_FMT ": ", __PRETTY_FUNCTION__)); LogRelFlow(a); } while (0)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogRelLelik
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * lelik logging.
c1374a13e412c4ec42cba867e57347a0e049a822Surya Prakki#define LogRelLelik(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LELIK, LOG_GROUP, a)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogRelMichael
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * michael logging.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogRelMichael(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_MICHAEL, LOG_GROUP, a)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogRelSunlover
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * sunlover logging.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogRelSunlover(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_SUNLOVER, LOG_GROUP, a)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogRelAchim
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Achim logging.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogRelAchim(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_ACHIM, LOG_GROUP, a)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogRelSander
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Sander logging.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogRelSander(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_SANDER, LOG_GROUP, a)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogRelKlaus
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * klaus logging.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogRelKlaus(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_KLAUS, LOG_GROUP, a)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogRelFrank
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * frank logging.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogRelFrank(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_FRANK, LOG_GROUP, a)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogRelBird
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogRelBird(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_BIRD, LOG_GROUP, a)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogRelNoName
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * NoName logging.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogRelNoName(a) LogRelIt(LOG_REL_INSTANCE, RTLOGGRPFLAGS_NONAME, LOG_GROUP, a)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogRelIsItEnabled
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Checks whether the specified logging group is enabled or not.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogRelIsItEnabled(a_pvInst, a_fFlags, a_iGroup) \
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China LogRelIsItEnabledInternal((a_pvInst), (unsigned)(a_iGroup), (unsigned)(a_fFlags))
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogRelIsEnabled
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Checks whether level 1 logging is enabled.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogRelIsEnabled() LogRelIsItEnabled(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_1, LOG_GROUP)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogRelIs2Enabled
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Checks whether level 2 logging is enabled.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogRelIs2Enabled() LogRelIsItEnabled(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_2, LOG_GROUP)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogRelIs3Enabled
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Checks whether level 3 logging is enabled.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogRelIs3Enabled() LogRelIsItEnabled(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_3, LOG_GROUP)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogRelIs4Enabled
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Checks whether level 4 logging is enabled.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogRelIs4Enabled() LogRelIsItEnabled(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_4, LOG_GROUP)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogRelIs5Enabled
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Checks whether level 5 logging is enabled.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogRelIs5Enabled() LogRelIsItEnabled(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_5, LOG_GROUP)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogRelIs6Enabled
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Checks whether level 6 logging is enabled.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogRelIs6Enabled() LogRelIsItEnabled(LOG_REL_INSTANCE, RTLOGGRPFLAGS_LEVEL_6, LOG_GROUP)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogRelIsFlowEnabled
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Checks whether execution flow logging is enabled.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LogRelIsFlowEnabled() LogRelIsItEnabled(LOG_REL_INSTANCE, RTLOGGRPFLAGS_FLOW, LOG_GROUP)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Sets the default release logger instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @returns The old default instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pLogger The new default release logger instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(PRTLOGGER) RTLogRelSetDefaultInstance(PRTLOGGER pLogger);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#endif /* !IN_RC */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Gets the default release logger instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @returns Pointer to default release logger instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @returns NULL if no default release logger instance available.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(PRTLOGGER) RTLogRelDefaultInstance(void);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** Internal worker function.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Don't call directly, use the LogRelIsItEnabled macro!
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaDECLINLINE(bool) LogRelIsItEnabledInternal(void *pvInst, unsigned iGroup, unsigned fFlags)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China register PRTLOGGER pLogger = (PRTLOGGER)pvInst ? (PRTLOGGER)pvInst : RTLogRelDefaultInstance();
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China && !(pLogger->fFlags & RTLOGFLAGS_DISABLED))
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China register unsigned fGrpFlags = pLogger->afGroups[(unsigned)iGroup < pLogger->cGroups ? (unsigned)iGroup : 0];
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China if ((fGrpFlags & (fFlags | RTLOGGRPFLAGS_ENABLED)) == (fFlags | RTLOGGRPFLAGS_ENABLED))
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Write to a logger instance, defaulting to the release one.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * This function will check whether the instance, group and flags makes up a
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * logging kind which is currently enabled before writing anything to the log.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pLogger Pointer to logger instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param fFlags The logging flags.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param iGroup The group.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * The value ~0U is reserved for compatibility with RTLogLogger[V] and is
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * only for internal usage!
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pszFormat Format string.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param ... Format arguments.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @remark This is a worker function for LogRelIt.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(void) RTLogRelLogger(PRTLOGGER pLogger, unsigned fFlags, unsigned iGroup, const char *pszFormat, ...);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Write to a logger instance, defaulting to the release one.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * This function will check whether the instance, group and flags makes up a
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * logging kind which is currently enabled before writing anything to the log.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pLogger Pointer to logger instance. If NULL the default release instance is attempted.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param fFlags The logging flags.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param iGroup The group.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * The value ~0U is reserved for compatibility with RTLogLogger[V] and is
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * only for internal usage!
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pszFormat Format string.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param args Format arguments.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(void) RTLogRelLoggerV(PRTLOGGER pLogger, unsigned fFlags, unsigned iGroup, const char *pszFormat, va_list args);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * printf like function for writing to the default release log.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pszFormat Printf like format string.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param ... Optional arguments as specified in pszFormat.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @remark The API doesn't support formatting of floating point numbers at the moment.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(void) RTLogRelPrintf(const char *pszFormat, ...);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * vprintf like function for writing to the default release log.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pszFormat Printf like format string.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param args Optional arguments as specified in pszFormat.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @remark The API doesn't support formatting of floating point numbers at the moment.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(void) RTLogRelPrintfV(const char *pszFormat, va_list args);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Changes the buffering setting of the default release logger.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * This can be used for optimizing longish logging sequences.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @returns The old state.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param fBuffered The new state.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(bool) RTLogRelSetBuffering(bool fBuffered);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @name COM port logging
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#ifdef DOXYGEN_RUNNING
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LOG_TO_COM
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LOG_NO_COM
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LOG_TO_COM
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Redirects the normal logging macros to the serial versions.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LOG_NO_COM
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Disables all LogCom* macros.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Generic logging to serial port.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#if defined(LOG_ENABLED) && !defined(LOG_NO_COM)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogCom(a) RTLogComPrintf a
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogCom(a) do { } while (0)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogComFlow
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Logging to serial port of execution flow.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#if defined(LOG_ENABLED) && defined(LOG_ENABLE_FLOW) && !defined(LOG_NO_COM)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogComFlow(a) RTLogComPrintf a
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogComFlow(a) do { } while (0)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#ifdef LOG_TO_COM
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define Log(a) LogCom(a)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogFlow(a) LogComFlow(a)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @name Backdoor Logging
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#ifdef DOXYGEN_RUNNING
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LOG_TO_BACKDOOR
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LOG_NO_BACKDOOR
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LOG_TO_BACKDOOR
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Redirects the normal logging macros to the backdoor versions.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LOG_NO_BACKDOOR
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Disables all LogBackdoor* macros.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogBackdoor
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Generic logging to the VBox backdoor via port I/O.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#if defined(LOG_ENABLED) && !defined(LOG_NO_BACKDOOR)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogBackdoor(a) RTLogBackdoorPrintf a
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogBackdoor(a) do { } while (0)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogBackdoorFlow
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Logging of execution flow messages to the backdoor I/O port.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#if defined(LOG_ENABLED) && !defined(LOG_NO_BACKDOOR)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogBackdoorFlow(a) RTLogBackdoorPrintf a
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogBackdoorFlow(a) do { } while (0)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** @def LogRelBackdoor
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Release logging to the VBox backdoor via port I/O.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#if !defined(LOG_NO_BACKDOOR)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogRelBackdoor(a) RTLogBackdoorPrintf a
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogRelBackdoor(a) do { } while (0)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#ifdef LOG_TO_BACKDOOR
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define Log(a) LogBackdoor(a)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogFlow(a) LogBackdoorFlow(a)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define LogRel(a) LogRelBackdoor(a)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# if defined(LOG_USE_C99)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China# define _LogIt(a_pvInst, a_fFlags, a_iGroup, ...) LogBackdoor((__VA_ARGS__))
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Gets the default logger instance, creating it if necessary.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @returns Pointer to default logger instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @returns NULL if no default logger instance available.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(PRTLOGGER) RTLogDefaultInstance(void);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Gets the default logger instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @returns Pointer to default logger instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @returns NULL if no default logger instance available.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(PRTLOGGER) RTLogGetDefaultInstance(void);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Sets the default logger instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @returns The old default instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pLogger The new default logger instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(PRTLOGGER) RTLogSetDefaultInstance(PRTLOGGER pLogger);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#endif /* !IN_RC */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Changes the default logger instance for the current thread.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @returns IPRT status code.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pLogger The logger instance. Pass NULL for deregistration.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param uKey Associated key for cleanup purposes. If pLogger is NULL,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * all instances with this key will be deregistered. So in
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * order to only deregister the instance associated with the
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * current thread use 0.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(int) RTLogSetDefaultInstanceThread(PRTLOGGER pLogger, uintptr_t uKey);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#endif /* IN_RING0 */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#ifdef LOG_ENABLED
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** Internal worker function.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Don't call directly, use the LogIsItEnabled macro!
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaDECLINLINE(bool) LogIsItEnabledInternal(void *pvInst, unsigned iGroup, unsigned fFlags)
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China register PRTLOGGER pLogger = (PRTLOGGER)pvInst ? (PRTLOGGER)pvInst : RTLogDefaultInstance();
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China && !(pLogger->fFlags & RTLOGFLAGS_DISABLED))
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China register unsigned fGrpFlags = pLogger->afGroups[(unsigned)iGroup < pLogger->cGroups ? (unsigned)iGroup : 0];
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China if ((fGrpFlags & (fFlags | RTLOGGRPFLAGS_ENABLED)) == (fFlags | RTLOGGRPFLAGS_ENABLED))
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Creates the default logger instance for a iprt users.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Any user of the logging features will need to implement
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * this or use the generic dummy.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @returns Pointer to the logger instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(PRTLOGGER) RTLogDefaultInit(void);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Create a logger instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @returns iprt status code.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param ppLogger Where to store the logger instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param fFlags Logger instance flags, a combination of the
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * RTLOGFLAGS_* values.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pszGroupSettings The initial group settings.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pszEnvVarBase Base name for the environment variables for
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * this instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param cGroups Number of groups in the array.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param papszGroups Pointer to array of groups. This must stick
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * around for the life of the logger instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param fDestFlags The destination flags. RTLOGDEST_FILE is ORed
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * if pszFilenameFmt specified.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pszFilenameFmt Log filename format string. Standard
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * RTStrFormat().
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param ... Format arguments.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(int) RTLogCreate(PRTLOGGER *ppLogger, uint32_t fFlags, const char *pszGroupSettings,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China const char *pszEnvVarBase, unsigned cGroups, const char * const * papszGroups,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China uint32_t fDestFlags, const char *pszFilenameFmt, ...);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Create a logger instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @returns iprt status code.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param ppLogger Where to store the logger instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param fFlags Logger instance flags, a combination of the
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * RTLOGFLAGS_* values.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pszGroupSettings The initial group settings.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pszEnvVarBase Base name for the environment variables for
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * this instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param cGroups Number of groups in the array.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param papszGroups Pointer to array of groups. This must stick
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * around for the life of the logger instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param fDestFlags The destination flags. RTLOGDEST_FILE is ORed
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * if pszFilenameFmt specified.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pfnPhase Callback function for starting logging and for
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * ending or starting a new file for log history
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * rotation. NULL is OK.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param cHistory Number of old log files to keep when performing
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * log history rotation. 0 means no history.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param cbHistoryFileMax Maximum size of log file when performing
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * history rotation. 0 means no size limit.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param cSecsHistoryTimeSlot Maximum time interval per log file when
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * performing history rotation, in seconds.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * 0 means time limit.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pszErrorMsg A buffer which is filled with an error message if something fails. May be NULL.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param cchErrorMsg The size of the error message buffer.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pszFilenameFmt Log filename format string. Standard RTStrFormat().
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param ... Format arguments.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(int) RTLogCreateEx(PRTLOGGER *ppLogger, uint32_t fFlags, const char *pszGroupSettings,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China const char *pszEnvVarBase, unsigned cGroups, const char * const * papszGroups,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China uint32_t fDestFlags, PFNRTLOGPHASE pfnPhase, uint32_t cHistory,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China uint64_t cbHistoryFileMax, uint32_t cSecsHistoryTimeSlot,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China char *pszErrorMsg, size_t cchErrorMsg, const char *pszFilenameFmt, ...);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Create a logger instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @returns iprt status code.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param ppLogger Where to store the logger instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param fFlags Logger instance flags, a combination of the
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * RTLOGFLAGS_* values.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pszGroupSettings The initial group settings.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pszEnvVarBase Base name for the environment variables for
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * this instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param cGroups Number of groups in the array.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param papszGroups Pointer to array of groups. This must stick
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * around for the life of the logger instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param fDestFlags The destination flags. RTLOGDEST_FILE is ORed
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * if pszFilenameFmt specified.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pfnPhase Callback function for starting logging and for
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * ending or starting a new file for log history
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param cHistory Number of old log files to keep when performing
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * log history rotation. 0 means no history.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param cbHistoryFileMax Maximum size of log file when performing
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * history rotation. 0 means no size limit.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param cSecsHistoryTimeSlot Maximum time interval per log file when
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * performing history rotation, in seconds.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * 0 means no time limit.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pszErrorMsg A buffer which is filled with an error message
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * if something fails. May be NULL.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param cchErrorMsg The size of the error message buffer.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pszFilenameFmt Log filename format string. Standard
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * RTStrFormat().
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param args Format arguments.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(int) RTLogCreateExV(PRTLOGGER *ppLogger, uint32_t fFlags, const char *pszGroupSettings,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China const char *pszEnvVarBase, unsigned cGroups, const char * const * papszGroups,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China uint32_t fDestFlags, PFNRTLOGPHASE pfnPhase, uint32_t cHistory,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China uint64_t cbHistoryFileMax, uint32_t cSecsHistoryTimeSlot,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China char *pszErrorMsg, size_t cchErrorMsg, const char *pszFilenameFmt, va_list args);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Create a logger instance for singled threaded ring-0 usage.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @returns iprt status code.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pLogger Where to create the logger instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param cbLogger The amount of memory available for the logger instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pLoggerR0Ptr The ring-0 address corresponding to @a pLogger.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pfnLoggerR0Ptr Pointer to logger wrapper function.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pfnFlushR0Ptr Pointer to flush function.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param fFlags Logger instance flags, a combination of the RTLOGFLAGS_* values.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param fDestFlags The destination flags.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(int) RTLogCreateForR0(PRTLOGGER pLogger, size_t cbLogger,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTR0PTR pLoggerR0Ptr, RTR0PTR pfnLoggerR0Ptr, RTR0PTR pfnFlushR0Ptr,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China uint32_t fFlags, uint32_t fDestFlags);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Calculates the minimum size of a ring-0 logger instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @returns The minimum size.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param cGroups The number of groups.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param fFlags Relevant flags.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(size_t) RTLogCalcSizeForR0(uint32_t cGroups, uint32_t fFlags);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Destroys a logger instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * The instance is flushed and all output destinations closed (where applicable).
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @returns iprt status code.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pLogger The logger instance which close destroyed. NULL is fine.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(int) RTLogDestroy(PRTLOGGER pLogger);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Create a logger instance clone for RC usage.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @returns iprt status code.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pLogger The logger instance to be cloned.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pLoggerRC Where to create the RC logger instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param cbLoggerRC Amount of memory allocated to for the RC logger
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * instance clone.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pfnLoggerRCPtr Pointer to logger wrapper function for this
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * instance (RC Ptr).
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pfnFlushRCPtr Pointer to flush function (RC Ptr).
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param fFlags Logger instance flags, a combination of the RTLOGFLAGS_* values.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(int) RTLogCloneRC(PRTLOGGER pLogger, PRTLOGGERRC pLoggerRC, size_t cbLoggerRC,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTRCPTR pfnLoggerRCPtr, RTRCPTR pfnFlushRCPtr, uint32_t fFlags);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Flushes a RC logger instance to a R3 logger.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @returns iprt status code.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pLogger The R3 logger instance to flush pLoggerRC to. If NULL
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * the default logger is used.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pLoggerRC The RC logger instance to flush.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(void) RTLogFlushRC(PRTLOGGER pLogger, PRTLOGGERRC pLoggerRC);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Flushes the buffer in one logger instance onto another logger.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @returns iprt status code.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pSrcLogger The logger instance to flush.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pDstLogger The logger instance to flush onto.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * If NULL the default logger will be used.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(void) RTLogFlushToLogger(PRTLOGGER pSrcLogger, PRTLOGGER pDstLogger);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Flushes a R0 logger instance to a R3 logger.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @returns iprt status code.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pLogger The R3 logger instance to flush pLoggerR0 to. If NULL
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * the default logger is used.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pLoggerR0 The R0 logger instance to flush.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(void) RTLogFlushR0(PRTLOGGER pLogger, PRTLOGGER pLoggerR0);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Sets the custom prefix callback.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @returns IPRT status code.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pLogger The logger instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pfnCallback The callback.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pvUser The user argument for the callback.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(int) RTLogSetCustomPrefixCallback(PRTLOGGER pLogger, PFNRTLOGPREFIX pfnCallback, void *pvUser);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Same as RTLogSetCustomPrefixCallback for loggers created by
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * RTLogCreateForR0.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @returns IPRT status code.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pLogger The logger instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pLoggerR0Ptr The ring-0 address corresponding to @a pLogger.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pfnCallbackR0Ptr The callback.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pvUserR0Ptr The user argument for the callback.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(int) RTLogSetCustomPrefixCallbackForR0(PRTLOGGER pLogger, RTR0PTR pLoggerR0Ptr,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China RTR0PTR pfnCallbackR0Ptr, RTR0PTR pvUserR0Ptr);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Copies the group settings and flags from logger instance to another.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @returns IPRT status code.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pDstLogger The destination logger instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pDstLoggerR0Ptr The ring-0 address corresponding to @a pDstLogger.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pSrcLogger The source logger instance. If NULL the default one is used.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param fFlagsOr OR mask for the flags.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param fFlagsAnd AND mask for the flags.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(int) RTLogCopyGroupsAndFlagsForR0(PRTLOGGER pDstLogger, RTR0PTR pDstLoggerR0Ptr,
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China PCRTLOGGER pSrcLogger, uint32_t fFlagsOr, uint32_t fFlagsAnd);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Get the current log group settings as a string.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @returns VINF_SUCCESS or VERR_BUFFER_OVERFLOW.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pLogger Logger instance (NULL for default logger).
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pszBuf The output buffer.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param cchBuf The size of the output buffer. Must be greater
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(int) RTLogGetGroupSettings(PRTLOGGER pLogger, char *pszBuf, size_t cchBuf);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Updates the group settings for the logger instance using the specified
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * specification string.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @returns iprt status code.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Failures can safely be ignored.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pLogger Logger instance (NULL for default logger).
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pszVar Value to parse.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(int) RTLogGroupSettings(PRTLOGGER pLogger, const char *pszVar);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#endif /* !IN_RC */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Updates the flags for the logger instance using the specified
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * specification string.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @returns iprt status code.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Failures can safely be ignored.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pLogger Logger instance (NULL for default logger).
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pszVar Value to parse.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(int) RTLogFlags(PRTLOGGER pLogger, const char *pszVar);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Changes the buffering setting of the specified logger.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * This can be used for optimizing longish logging sequences.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @returns The old state.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pLogger The logger instance (NULL is an alias for the
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * default logger).
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param fBuffered The new state.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(bool) RTLogSetBuffering(PRTLOGGER pLogger, bool fBuffered);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Sets the max number of entries per group.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @returns Old restriction.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pLogger The logger instance (NULL is an alias for the
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * default logger).
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param cMaxEntriesPerGroup The max number of entries per group.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @remarks Lowering the limit of an active logger may quietly mute groups.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Raising it may reactive already muted groups.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(uint32_t) RTLogSetGroupLimit(PRTLOGGER pLogger, uint32_t cMaxEntriesPerGroup);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Get the current log flags as a string.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @returns VINF_SUCCESS or VERR_BUFFER_OVERFLOW.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pLogger Logger instance (NULL for default logger).
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pszBuf The output buffer.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param cchBuf The size of the output buffer. Must be greater
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(int) RTLogGetFlags(PRTLOGGER pLogger, char *pszBuf, size_t cchBuf);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Updates the logger destination using the specified string.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @returns VINF_SUCCESS or VERR_BUFFER_OVERFLOW.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pLogger Logger instance (NULL for default logger).
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pszVar The value to parse.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(int) RTLogDestinations(PRTLOGGER pLogger, char const *pszVar);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Get the current log destinations as a string.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @returns VINF_SUCCESS or VERR_BUFFER_OVERFLOW.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pLogger Logger instance (NULL for default logger).
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pszBuf The output buffer.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param cchBuf The size of the output buffer. Must be greater
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(int) RTLogGetDestinations(PRTLOGGER pLogger, char *pszBuf, size_t cchBuf);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#endif /* !IN_RC */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Flushes the specified logger.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pLogger The logger instance to flush.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * If NULL the default instance is used. The default instance
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * will not be initialized by this call.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(void) RTLogFlush(PRTLOGGER pLogger);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Write to a logger instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pLogger Pointer to logger instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pvCallerRet Ignored.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pszFormat Format string.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param ... Format arguments.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(void) RTLogLogger(PRTLOGGER pLogger, void *pvCallerRet, const char *pszFormat, ...);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Write to a logger instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pLogger Pointer to logger instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pszFormat Format string.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param args Format arguments.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(void) RTLogLoggerV(PRTLOGGER pLogger, const char *pszFormat, va_list args);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Write to a logger instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * This function will check whether the instance, group and flags makes up a
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * logging kind which is currently enabled before writing anything to the log.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pLogger Pointer to logger instance. If NULL the default logger instance will be attempted.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param fFlags The logging flags.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param iGroup The group.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * The value ~0U is reserved for compatibility with RTLogLogger[V] and is
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * only for internal usage!
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pszFormat Format string.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param ... Format arguments.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @remark This is a worker function of LogIt.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(void) RTLogLoggerEx(PRTLOGGER pLogger, unsigned fFlags, unsigned iGroup, const char *pszFormat, ...);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Write to a logger instance.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * This function will check whether the instance, group and flags makes up a
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * logging kind which is currently enabled before writing anything to the log.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pLogger Pointer to logger instance. If NULL the default logger instance will be attempted.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param fFlags The logging flags.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param iGroup The group.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * The value ~0U is reserved for compatibility with RTLogLogger[V] and is
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * only for internal usage!
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pszFormat Format string.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param args Format arguments.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(void) RTLogLoggerExV(PRTLOGGER pLogger, unsigned fFlags, unsigned iGroup, const char *pszFormat, va_list args);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * printf like function for writing to the default log.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pszFormat Printf like format string.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param ... Optional arguments as specified in pszFormat.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @remark The API doesn't support formatting of floating point numbers at the moment.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(void) RTLogPrintf(const char *pszFormat, ...);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * vprintf like function for writing to the default log.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pszFormat Printf like format string.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param args Optional arguments as specified in pszFormat.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @remark The API doesn't support formatting of floating point numbers at the moment.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(void) RTLogPrintfV(const char *pszFormat, va_list args);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#ifndef DECLARED_FNRTSTROUTPUT /* duplicated in iprt/string.h */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define DECLARED_FNRTSTROUTPUT
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Output callback.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @returns number of bytes written.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pvArg User argument.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pachChars Pointer to an array of utf-8 characters.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param cbChars Number of bytes in the character array pointed to by pachChars.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing Chinatypedef DECLCALLBACK(size_t) FNRTSTROUTPUT(void *pvArg, const char *pachChars, size_t cbChars);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** Pointer to callback function. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing Chinatypedef FNRTSTROUTPUT *PFNRTSTROUTPUT;
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Partial vsprintf worker implementation.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @returns number of bytes formatted.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pfnOutput Output worker.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Called in two ways. Normally with a string an it's length.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * For termination, it's called with NULL for string, 0 for length.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pvArg Argument to output worker.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pszFormat Format string.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param args Argument list.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(size_t) RTLogFormatV(PFNRTSTROUTPUT pfnOutput, void *pvArg, const char *pszFormat, va_list args);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Write log buffer to COM port.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pach Pointer to the buffer to write.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param cb Number of bytes to write.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(void) RTLogWriteCom(const char *pach, size_t cb);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Prints a formatted string to the serial port used for logging.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @returns Number of bytes written.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pszFormat Format string.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param ... Optional arguments specified in the format string.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(size_t) RTLogComPrintf(const char *pszFormat, ...);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Prints a formatted string to the serial port used for logging.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @returns Number of bytes written.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pszFormat Format string.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param args Optional arguments specified in the format string.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(size_t) RTLogComPrintfV(const char *pszFormat, va_list args);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#if 0 /* not implemented yet */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** Indicates that the semaphores shall be used to notify the other
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * part about buffer changes. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#define LOGHOOKBUFFER_FLAGS_SEMAPHORED 1
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Log Hook Buffer.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Use to communicate between the logger and a log consumer.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing Chinatypedef struct RTLOGHOOKBUFFER
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Write pointer. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China volatile void *pvWrite;
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Read pointer. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China volatile void *pvRead;
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Buffer start. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Buffer end (exclusive). */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Signaling semaphore used by the writer to wait on a full buffer.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Only used when indicated in flags. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China void *pvSemWriter;
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Signaling semaphore used by the read to wait on an empty buffer.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Only used when indicated in flags. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China void *pvSemReader;
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China /** Buffer flags. Current reserved and set to zero. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China volatile unsigned fFlags;
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China} RTLOGHOOKBUFFER;
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China/** Pointer to a log hook buffer. */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing Chinatypedef RTLOGHOOKBUFFER *PRTLOGHOOKBUFFER;
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Register a logging hook.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * This type of logging hooks are expecting different threads acting
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * producer and consumer. They share a circular buffer which have two
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * pointers one for each end. When the buffer is full there are two
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * alternatives (indicated by a buffer flag), either wait for the
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * consumer to get it's job done, or to write a generic message saying
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * buffer overflow.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Since the waiting would need a signal semaphore, we'll skip that for now.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @returns iprt status code.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pBuffer Pointer to a logger hook buffer.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(int) RTLogRegisterHook(PRTLOGGER pLogger, PRTLOGHOOKBUFFER pBuffer);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Deregister a logging hook registered with RTLogRegisterHook().
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @returns iprt status code.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pBuffer Pointer to a logger hook buffer.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(int) RTLogDeregisterHook(PRTLOGGER pLogger, PRTLOGHOOKBUFFER pBuffer);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China#endif /* not implemented yet */
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Write log buffer to a debugger (RTLOGDEST_DEBUGGER).
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pach What to write.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param cb How much to write.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @remark When linking statically, this function can be replaced by defining your own.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(void) RTLogWriteDebugger(const char *pach, size_t cb);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Write log buffer to a user defined output stream (RTLOGDEST_USER).
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pach What to write.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param cb How much to write.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @remark When linking statically, this function can be replaced by defining your own.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(void) RTLogWriteUser(const char *pach, size_t cb);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Write log buffer to stdout (RTLOGDEST_STDOUT).
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pach What to write.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param cb How much to write.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @remark When linking statically, this function can be replaced by defining your own.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(void) RTLogWriteStdOut(const char *pach, size_t cb);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Write log buffer to stdout (RTLOGDEST_STDERR).
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pach What to write.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param cb How much to write.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @remark When linking statically, this function can be replaced by defining your own.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(void) RTLogWriteStdErr(const char *pach, size_t cb);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Prints a formatted string to the backdoor port.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @returns Number of bytes written.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pszFormat Format string.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param ... Optional arguments specified in the format string.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(size_t) RTLogBackdoorPrintf(const char *pszFormat, ...);
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * Prints a formatted string to the backdoor port.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @returns Number of bytes written.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param pszFormat Format string.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing China * @param args Optional arguments specified in the format string.
10115c80ec7040cb0f5be39c544c4febb00369eefei feng - Sun Microsystems - Beijing ChinaRTDECL(size_t) RTLogBackdoorPrintfV(const char *pszFormat, va_list args);