logrel.cpp revision 89aaf34d7efe046975e813e7ed14b2d1d5530c75
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * Runtime VBox - Logger.
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * Copyright (C) 2006-2007 Oracle Corporation
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * available from http://www.virtualbox.org. This file is free software;
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * you can redistribute it and/or modify it under the terms of the GNU
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * General Public License (GPL) as published by the Free Software
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * The contents of this file may alternatively be used under the terms
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * of the Common Development and Distribution License Version 1.0
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * VirtualBox OSE distribution, in which case the provisions of the
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * CDDL are applicable instead of those of the GPL.
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * You may elect to license modified versions of this file under the
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * terms and conditions of either the GPL or the CDDL or both.
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync/*******************************************************************************
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync* Header Files *
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync*******************************************************************************/
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync/*******************************************************************************
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync* Global Variables *
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync*******************************************************************************/
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync/** Default relese logger instance. */
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync#else /* !IN_RC */
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync/** Default release logger instance. */
e170d0511a1456f1677c93e03a78d7162ae82472vboxsync#endif /* !IN_RC */
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * Gets the default release logger instance.
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * @returns Pointer to default release logger instance.
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * @returns NULL if no default release logger instance available.
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync#else /* !IN_RC */
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync#endif /* !IN_RC */
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * Sets the default logger instance.
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * @returns iprt status code.
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * @param pLogger The new default release logger instance.
e4f367251aede667a6de69baa54ef9eb5f150871vboxsyncRTDECL(PRTLOGGER) RTLogRelSetDefaultInstance(PRTLOGGER pLogger)
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync return ASMAtomicXchgPtrT(&g_pRelLogger, pLogger, PRTLOGGER);
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync#endif /* !IN_RC */
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * Write to a logger instance, defaulting to the release one.
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * This function will check whether the instance, group and flags makes up a
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * logging kind which is currently enabled before writing anything to the log.
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * @param pLogger Pointer to logger instance. If NULL the default release instance is attempted.
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * @param fFlags The logging flags.
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * @param iGroup The group.
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * The value ~0U is reserved for compatability with RTLogLogger[V] and is
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * only for internal usage!
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * @param pszFormat Format string.
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * @param args Format arguments.
e4f367251aede667a6de69baa54ef9eb5f150871vboxsyncRTDECL(void) RTLogRelLoggerV(PRTLOGGER pLogger, unsigned fFlags, unsigned iGroup, const char *pszFormat, va_list args)
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * A NULL logger means default instance.
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync RTLogLoggerExV(pLogger, fFlags, iGroup, pszFormat, args);
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * vprintf like function for writing to the default release log.
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * @param pszFormat Printf like format string.
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * @param args Optional arguments as specified in pszFormat.
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * @remark The API doesn't support formatting of floating point numbers at the moment.
e4f367251aede667a6de69baa54ef9eb5f150871vboxsyncRTDECL(void) RTLogRelPrintfV(const char *pszFormat, va_list args)
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * Changes the buffering setting of the default release logger.
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * This can be used for optimizing longish logging sequences.
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * @returns The old state.
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync * @param fBuffered The new state.
e4f367251aede667a6de69baa54ef9eb5f150871vboxsync return false;