logellipsis.cpp revision c34f9b1d1526bb5e7fa22d868de402fc50c318fe
75da45714b471969a6eb41b469237d51d1ed92beMark Craig/* $Id$ */
75da45714b471969a6eb41b469237d51d1ed92beMark Craig/** @file
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * Runtime VBox - Logger, the ellipsis variants.
75da45714b471969a6eb41b469237d51d1ed92beMark Craig */
75da45714b471969a6eb41b469237d51d1ed92beMark Craig
75da45714b471969a6eb41b469237d51d1ed92beMark Craig/*
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * Copyright (C) 2006-2007 Sun Microsystems, Inc.
75da45714b471969a6eb41b469237d51d1ed92beMark Craig *
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * This file is part of VirtualBox Open Source Edition (OSE), as
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * available from http://www.virtualbox.org. This file is free software;
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * you can redistribute it and/or modify it under the terms of the GNU
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * General Public License (GPL) as published by the Free Software
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * Foundation, in version 2 as it comes in the "COPYING" file of the
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
75da45714b471969a6eb41b469237d51d1ed92beMark Craig *
780edb54801442497adec4f16256e80d53618bc5jenkins * The contents of this file may alternatively be used under the terms
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * of the Common Development and Distribution License Version 1.0
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * VirtualBox OSE distribution, in which case the provisions of the
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * CDDL are applicable instead of those of the GPL.
75da45714b471969a6eb41b469237d51d1ed92beMark Craig *
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * You may elect to license modified versions of this file under the
780edb54801442497adec4f16256e80d53618bc5jenkins * terms and conditions of either the GPL or the CDDL or both.
75da45714b471969a6eb41b469237d51d1ed92beMark Craig *
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * Clara, CA 95054 USA or visit http://www.sun.com if you need
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * additional information or have any questions.
75da45714b471969a6eb41b469237d51d1ed92beMark Craig */
75da45714b471969a6eb41b469237d51d1ed92beMark Craig
75da45714b471969a6eb41b469237d51d1ed92beMark Craig/*******************************************************************************
75da45714b471969a6eb41b469237d51d1ed92beMark Craig* Header Files *
75da45714b471969a6eb41b469237d51d1ed92beMark Craig*******************************************************************************/
75da45714b471969a6eb41b469237d51d1ed92beMark Craig#include <iprt/log.h>
75da45714b471969a6eb41b469237d51d1ed92beMark Craig#include <iprt/asm.h>
75da45714b471969a6eb41b469237d51d1ed92beMark Craig#include <iprt/stdarg.h>
75da45714b471969a6eb41b469237d51d1ed92beMark Craig
75da45714b471969a6eb41b469237d51d1ed92beMark Craig
75da45714b471969a6eb41b469237d51d1ed92beMark Craig/**
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * Write to a logger instance.
75da45714b471969a6eb41b469237d51d1ed92beMark Craig *
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * @param pLogger Pointer to logger instance.
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * @param pvCallerRet Ignored.
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * @param pszFormat Format string.
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * @param ... Format arguments.
75da45714b471969a6eb41b469237d51d1ed92beMark Craig */
75da45714b471969a6eb41b469237d51d1ed92beMark CraigRTDECL(void) RTLogLogger(PRTLOGGER pLogger, void *pvCallerRet, const char *pszFormat, ...)
75da45714b471969a6eb41b469237d51d1ed92beMark Craig{
75da45714b471969a6eb41b469237d51d1ed92beMark Craig va_list args;
75da45714b471969a6eb41b469237d51d1ed92beMark Craig va_start(args, pszFormat);
75da45714b471969a6eb41b469237d51d1ed92beMark Craig#if defined(RT_OS_DARWIN) && defined(RT_ARCH_X86) && defined(IN_RING3)
75da45714b471969a6eb41b469237d51d1ed92beMark Craig /* manually align the stack before doing the call.
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * We boldly assume that there is a stack frame here! */
75da45714b471969a6eb41b469237d51d1ed92beMark Craig __asm__ __volatile__("andl $-32, %%esp\t\n" ::: "%esp");
75da45714b471969a6eb41b469237d51d1ed92beMark Craig RTLogLoggerExV(pLogger, 0, ~0U, pszFormat, args);
75da45714b471969a6eb41b469237d51d1ed92beMark Craig#else
75da45714b471969a6eb41b469237d51d1ed92beMark Craig RTLogLoggerExV(pLogger, 0, ~0U, pszFormat, args);
75da45714b471969a6eb41b469237d51d1ed92beMark Craig#endif
75da45714b471969a6eb41b469237d51d1ed92beMark Craig va_end(args);
75da45714b471969a6eb41b469237d51d1ed92beMark Craig}
75da45714b471969a6eb41b469237d51d1ed92beMark Craig
75da45714b471969a6eb41b469237d51d1ed92beMark Craig
75da45714b471969a6eb41b469237d51d1ed92beMark Craig/**
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * Write to a logger instance.
75da45714b471969a6eb41b469237d51d1ed92beMark Craig *
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * This function will check whether the instance, group and flags makes up a
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * logging kind which is currently enabled before writing anything to the log.
75da45714b471969a6eb41b469237d51d1ed92beMark Craig *
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * @param pLogger Pointer to logger instance. If NULL the default logger instance will be attempted.
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * @param fFlags The logging flags.
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * @param iGroup The group.
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * The value ~0U is reserved for compatability with RTLogLogger[V] and is
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * only for internal usage!
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * @param pszFormat Format string.
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * @param ... Format arguments.
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * @remark This is a worker function of LogIt.
75da45714b471969a6eb41b469237d51d1ed92beMark Craig */
75da45714b471969a6eb41b469237d51d1ed92beMark CraigRTDECL(void) RTLogLoggerEx(PRTLOGGER pLogger, unsigned fFlags, unsigned iGroup, const char *pszFormat, ...)
75da45714b471969a6eb41b469237d51d1ed92beMark Craig{
75da45714b471969a6eb41b469237d51d1ed92beMark Craig va_list args;
75da45714b471969a6eb41b469237d51d1ed92beMark Craig va_start(args, pszFormat);
75da45714b471969a6eb41b469237d51d1ed92beMark Craig RTLogLoggerExV(pLogger, fFlags, iGroup, pszFormat, args);
75da45714b471969a6eb41b469237d51d1ed92beMark Craig va_end(args);
75da45714b471969a6eb41b469237d51d1ed92beMark Craig}
75da45714b471969a6eb41b469237d51d1ed92beMark Craig
75da45714b471969a6eb41b469237d51d1ed92beMark Craig
75da45714b471969a6eb41b469237d51d1ed92beMark Craig/**
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * printf like function for writing to the default log.
75da45714b471969a6eb41b469237d51d1ed92beMark Craig *
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * @param pszFormat Printf like format string.
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * @param ... Optional arguments as specified in pszFormat.
75da45714b471969a6eb41b469237d51d1ed92beMark Craig *
75da45714b471969a6eb41b469237d51d1ed92beMark Craig * @remark The API doesn't support formatting of floating point numbers at the moment.
75da45714b471969a6eb41b469237d51d1ed92beMark Craig */
75da45714b471969a6eb41b469237d51d1ed92beMark CraigRTDECL(void) RTLogPrintf(const char *pszFormat, ...)
75da45714b471969a6eb41b469237d51d1ed92beMark Craig{
75da45714b471969a6eb41b469237d51d1ed92beMark Craig va_list args;
75da45714b471969a6eb41b469237d51d1ed92beMark Craig va_start(args, pszFormat);
75da45714b471969a6eb41b469237d51d1ed92beMark Craig RTLogPrintfV(pszFormat, args);
75da45714b471969a6eb41b469237d51d1ed92beMark Craig va_end(args);
75da45714b471969a6eb41b469237d51d1ed92beMark Craig}
75da45714b471969a6eb41b469237d51d1ed92beMark Craig
75da45714b471969a6eb41b469237d51d1ed92beMark Craig