c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync/* $Id$ */
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync/** @file
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * Runtime VBox - Logger, the ellipsis variants.
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync */
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync/*
c58f1213e628a545081c70e26c6b67a841cff880vboxsync * Copyright (C) 2006-2011 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
aa4bcf0a4b2db3ac352b56a291d49cb8d4b66d32vboxsync
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync/*******************************************************************************
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync* Header Files *
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync*******************************************************************************/
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync#include <iprt/log.h>
aa4bcf0a4b2db3ac352b56a291d49cb8d4b66d32vboxsync#include "internal/iprt.h"
aa4bcf0a4b2db3ac352b56a291d49cb8d4b66d32vboxsync
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync#include <iprt/asm.h>
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync#include <iprt/stdarg.h>
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync/**
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * Write to a logger instance.
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync *
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * @param pLogger Pointer to logger instance.
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * @param pvCallerRet Ignored.
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * @param pszFormat Format string.
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * @param ... Format arguments.
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync */
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsyncRTDECL(void) RTLogLogger(PRTLOGGER pLogger, void *pvCallerRet, const char *pszFormat, ...)
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync{
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync va_list args;
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync va_start(args, pszFormat);
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync#if defined(RT_OS_DARWIN) && defined(RT_ARCH_X86) && defined(IN_RING3)
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync /* manually align the stack before doing the call.
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * We boldly assume that there is a stack frame here! */
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync __asm__ __volatile__("andl $-32, %%esp\t\n" ::: "%esp");
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync RTLogLoggerExV(pLogger, 0, ~0U, pszFormat, args);
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync#else
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync RTLogLoggerExV(pLogger, 0, ~0U, pszFormat, args);
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync#endif
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync va_end(args);
4e47bb772df0d04d1ded3e06354de547d52e2d06vboxsync NOREF(pvCallerRet);
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync}
aa4bcf0a4b2db3ac352b56a291d49cb8d4b66d32vboxsyncRT_EXPORT_SYMBOL(RTLogLogger);
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync/**
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * Write to a logger instance.
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 logger instance will be 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 ... Format arguments.
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * @remark This is a worker function of LogIt.
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync */
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsyncRTDECL(void) RTLogLoggerEx(PRTLOGGER pLogger, unsigned fFlags, unsigned iGroup, const char *pszFormat, ...)
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync{
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync va_list args;
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync va_start(args, pszFormat);
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync RTLogLoggerExV(pLogger, fFlags, iGroup, pszFormat, args);
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync va_end(args);
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync}
aa4bcf0a4b2db3ac352b56a291d49cb8d4b66d32vboxsyncRT_EXPORT_SYMBOL(RTLogLoggerEx);
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync/**
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * printf like function for writing to the default log.
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync *
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * @param pszFormat Printf like format string.
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync * @param ... 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) RTLogPrintf(const char *pszFormat, ...)
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync{
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync va_list args;
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync va_start(args, pszFormat);
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync RTLogPrintfV(pszFormat, args);
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync va_end(args);
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync}
aa4bcf0a4b2db3ac352b56a291d49cb8d4b66d32vboxsyncRT_EXPORT_SYMBOL(RTLogPrintf);
c34f9b1d1526bb5e7fa22d868de402fc50c318fevboxsync