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