c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync/* $Id$ */
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync/** @file
c30c238d5383e268f3a39c309d28971300aae614vboxsync * Runtime VBox - Release Logger.
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync */
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync/*
c58f1213e628a545081c70e26c6b67a841cff880vboxsync * Copyright (C) 2006-2012 Oracle Corporation
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync *
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * available from http://www.virtualbox.org. This file is free software;
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * you can redistribute it and/or modify it under the terms of the GNU
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * General Public License (GPL) as published by the Free Software
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync *
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * The contents of this file may alternatively be used under the terms
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * of the Common Development and Distribution License Version 1.0
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * VirtualBox OSE distribution, in which case the provisions of the
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * CDDL are applicable instead of those of the GPL.
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync *
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * You may elect to license modified versions of this file under the
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * terms and conditions of either the GPL or the CDDL or both.
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync */
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync/*******************************************************************************
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync* Header Files *
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync*******************************************************************************/
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync#include <iprt/log.h>
aa4bcf0a4b2db3ac352b56a291d49cb8d4b66d32vboxsync#include "internal/iprt.h"
aa4bcf0a4b2db3ac352b56a291d49cb8d4b66d32vboxsync
7e960d3a0a8a3a84d7aba2cca45d72b1c31cc97bvboxsync#ifndef IN_RC
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync# include <iprt/alloc.h>
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync# include <iprt/process.h>
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync# include <iprt/semaphore.h>
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync# include <iprt/thread.h>
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync# include <iprt/mp.h>
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync#endif
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync#ifdef IN_RING3
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync# include <iprt/file.h>
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync# include <iprt/path.h>
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync#endif
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync#include <iprt/time.h>
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync#include <iprt/asm.h>
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync#include <iprt/assert.h>
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync#include <iprt/err.h>
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync#include <iprt/param.h>
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync#include <iprt/stdarg.h>
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync#include <iprt/string.h>
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync#include <iprt/ctype.h>
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync#ifdef IN_RING3
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync# include <iprt/alloca.h>
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync# include <stdio.h>
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync#endif
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync/*******************************************************************************
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync* Global Variables *
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync*******************************************************************************/
7e960d3a0a8a3a84d7aba2cca45d72b1c31cc97bvboxsync#ifdef IN_RC
ad27e1d5e48ca41245120c331cc88b50464813cevboxsync/** Default release logger instance. */
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsyncextern "C" DECLIMPORT(RTLOGGERRC) g_RelLogger;
7e960d3a0a8a3a84d7aba2cca45d72b1c31cc97bvboxsync#else /* !IN_RC */
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync/** Default release logger instance. */
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsyncstatic PRTLOGGER g_pRelLogger;
7e960d3a0a8a3a84d7aba2cca45d72b1c31cc97bvboxsync#endif /* !IN_RC */
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync/**
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * Gets the default release logger instance.
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync *
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * @returns Pointer to default release logger instance.
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * @returns NULL if no default release logger instance available.
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync */
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsyncRTDECL(PRTLOGGER) RTLogRelDefaultInstance(void)
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync{
7e960d3a0a8a3a84d7aba2cca45d72b1c31cc97bvboxsync#ifdef IN_RC
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync return &g_RelLogger;
7e960d3a0a8a3a84d7aba2cca45d72b1c31cc97bvboxsync#else /* !IN_RC */
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync return g_pRelLogger;
7e960d3a0a8a3a84d7aba2cca45d72b1c31cc97bvboxsync#endif /* !IN_RC */
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync}
aa4bcf0a4b2db3ac352b56a291d49cb8d4b66d32vboxsyncRT_EXPORT_SYMBOL(RTLogRelDefaultInstance);
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync
7e960d3a0a8a3a84d7aba2cca45d72b1c31cc97bvboxsync#ifndef IN_RC
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync/**
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * Sets the default logger instance.
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync *
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * @returns iprt status code.
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * @param pLogger The new default release logger instance.
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync */
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsyncRTDECL(PRTLOGGER) RTLogRelSetDefaultInstance(PRTLOGGER pLogger)
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync{
c7ff622115966b69b482bd2896662e40d823b22fvboxsync return ASMAtomicXchgPtrT(&g_pRelLogger, pLogger, PRTLOGGER);
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync}
aa4bcf0a4b2db3ac352b56a291d49cb8d4b66d32vboxsyncRT_EXPORT_SYMBOL(RTLogRelSetDefaultInstance);
7e960d3a0a8a3a84d7aba2cca45d72b1c31cc97bvboxsync#endif /* !IN_RC */
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync/**
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * Write to a logger instance, defaulting to the release one.
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync *
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * This function will check whether the instance, group and flags makes up a
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * logging kind which is currently enabled before writing anything to the log.
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync *
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * @param pLogger Pointer to logger instance. If NULL the default release instance is attempted.
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * @param fFlags The logging flags.
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * @param iGroup The group.
ad27e1d5e48ca41245120c331cc88b50464813cevboxsync * The value ~0U is reserved for compatibility with RTLogLogger[V] and is
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * only for internal usage!
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * @param pszFormat Format string.
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * @param args Format arguments.
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync */
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsyncRTDECL(void) RTLogRelLoggerV(PRTLOGGER pLogger, unsigned fFlags, unsigned iGroup, const char *pszFormat, va_list args)
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync{
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync /*
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * A NULL logger means default instance.
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync */
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync if (!pLogger)
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync {
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync pLogger = RTLogRelDefaultInstance();
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync if (!pLogger)
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync return;
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync }
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync RTLogLoggerExV(pLogger, fFlags, iGroup, pszFormat, args);
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync}
aa4bcf0a4b2db3ac352b56a291d49cb8d4b66d32vboxsyncRT_EXPORT_SYMBOL(RTLogRelLoggerV);
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync/**
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * vprintf like function for writing to the default release log.
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync *
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * @param pszFormat Printf like format string.
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * @param args Optional arguments as specified in pszFormat.
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync *
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * @remark The API doesn't support formatting of floating point numbers at the moment.
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync */
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsyncRTDECL(void) RTLogRelPrintfV(const char *pszFormat, va_list args)
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync{
210e87cc03f92d54681b81a81cc1fdbd48a9d2c8vboxsync RTLogRelLoggerV(NULL, 0, ~0U, pszFormat, args);
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync}
aa4bcf0a4b2db3ac352b56a291d49cb8d4b66d32vboxsyncRT_EXPORT_SYMBOL(RTLogRelPrintfV);
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync
89aaf34d7efe046975e813e7ed14b2d1d5530c75vboxsync
89aaf34d7efe046975e813e7ed14b2d1d5530c75vboxsync/**
89aaf34d7efe046975e813e7ed14b2d1d5530c75vboxsync * Changes the buffering setting of the default release logger.
89aaf34d7efe046975e813e7ed14b2d1d5530c75vboxsync *
89aaf34d7efe046975e813e7ed14b2d1d5530c75vboxsync * This can be used for optimizing longish logging sequences.
89aaf34d7efe046975e813e7ed14b2d1d5530c75vboxsync *
89aaf34d7efe046975e813e7ed14b2d1d5530c75vboxsync * @returns The old state.
89aaf34d7efe046975e813e7ed14b2d1d5530c75vboxsync * @param fBuffered The new state.
89aaf34d7efe046975e813e7ed14b2d1d5530c75vboxsync */
89aaf34d7efe046975e813e7ed14b2d1d5530c75vboxsyncRTDECL(bool) RTLogRelSetBuffering(bool fBuffered)
89aaf34d7efe046975e813e7ed14b2d1d5530c75vboxsync{
89aaf34d7efe046975e813e7ed14b2d1d5530c75vboxsync PRTLOGGER pLogger = RTLogRelDefaultInstance();
89aaf34d7efe046975e813e7ed14b2d1d5530c75vboxsync if (pLogger)
89aaf34d7efe046975e813e7ed14b2d1d5530c75vboxsync return RTLogSetBuffering(pLogger, fBuffered);
89aaf34d7efe046975e813e7ed14b2d1d5530c75vboxsync return false;
89aaf34d7efe046975e813e7ed14b2d1d5530c75vboxsync}
89aaf34d7efe046975e813e7ed14b2d1d5530c75vboxsyncRT_EXPORT_SYMBOL(RTLogRelSetBuffering);
89aaf34d7efe046975e813e7ed14b2d1d5530c75vboxsync