common/VBoxGuestLib/VBoxGuestR3LibMisc.cpp

	VBoxGuestR3LibMisc.cpp revision c5dcc851f65b0d1a63e37d75c84a17403e77b3ba
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess/* $Id$ */
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess/** @file
63c21144c05821a22c5c084c6163d9e5fe224d94kess * VBoxGuestR3Lib - Ring-3 Support Library for VirtualBox guest additions, Misc.
a99c5d4cc3cab6a62b04d52000dbc22ce1fa2d94coar */
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess
a3d2b657dd7ca66251b562b6a82c2335135b9172nd/*
031b91a62d25106ae69d4693475c79618dd5e884fielding * Copyright (C) 2007 Sun Microsystems, Inc.
031b91a62d25106ae69d4693475c79618dd5e884fielding *
031b91a62d25106ae69d4693475c79618dd5e884fielding * This file is part of VirtualBox Open Source Edition (OSE), as
031b91a62d25106ae69d4693475c79618dd5e884fielding * available from http://www.virtualbox.org. This file is free software;
031b91a62d25106ae69d4693475c79618dd5e884fielding * you can redistribute it and/or modify it under the terms of the GNU
031b91a62d25106ae69d4693475c79618dd5e884fielding * General Public License (GPL) as published by the Free Software
a3d2b657dd7ca66251b562b6a82c2335135b9172nd * Foundation, in version 2 as it comes in the "COPYING" file of the
a3d2b657dd7ca66251b562b6a82c2335135b9172nd * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
a3d2b657dd7ca66251b562b6a82c2335135b9172nd * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
a3d2b657dd7ca66251b562b6a82c2335135b9172nd *
a3d2b657dd7ca66251b562b6a82c2335135b9172nd * The contents of this file may alternatively be used under the terms
a3d2b657dd7ca66251b562b6a82c2335135b9172nd * of the Common Development and Distribution License Version 1.0
a3d2b657dd7ca66251b562b6a82c2335135b9172nd * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
a3d2b657dd7ca66251b562b6a82c2335135b9172nd * VirtualBox OSE distribution, in which case the provisions of the
a3d2b657dd7ca66251b562b6a82c2335135b9172nd * CDDL are applicable instead of those of the GPL.
a3d2b657dd7ca66251b562b6a82c2335135b9172nd *
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * You may elect to license modified versions of this file under the
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * terms and conditions of either the GPL or the CDDL or both.
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess *
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * Clara, CA 95054 USA or visit http://www.sun.com if you need
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * additional information or have any questions.
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess */
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess/*******************************************************************************
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess*   Header Files                                                               *
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess*******************************************************************************/
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess#include <iprt/mem.h>
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess#include <iprt/string.h>
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess#include <VBox/log.h>
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess#include <VBox/version.h>
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess#include "VBGLR3Internal.h"
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess/** @todo Split this file up so we can drop most of the VBOX_VBGLR3_XFREE86
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess *        #ifdef'ing. */
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess/**
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * Wait for the host to signal one or more events and return which.
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess *
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * The events will only be delivered by the host if they have been enabled
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * previously using @a VbglR3CtlFilterMask.  If one or several of the events
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * have already been signalled but not yet waited for, this function will return
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * immediately and return those events.
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess *
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * @returns IPRT status code.
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess *
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * @param   fMask       The events we want to wait for, or-ed together.
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * @param   cMillies    How long to wait before giving up and returning
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess *                      (VERR_TIMEOUT). Use RT_INDEFINITE_WAIT to wait until we
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess *                      are interrupted or one of the events is signalled.
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * @param   pfEvents    Where to store the events signalled. Optional.
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess */
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekessVBGLR3DECL(int) VbglR3WaitEvent(uint32_t fMask, uint32_t cMillies, uint32_t *pfEvents)
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess{
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess#ifndef VBOX_VBGLR3_XFREE86
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    LogFlow(("VbglR3WaitEvent: fMask=0x%x, cMillies=%u, pfEvents=%p\n",
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess             fMask, cMillies, pfEvents));
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    AssertReturn((fMask & ~VMMDEV_EVENT_VALID_EVENT_MASK) == 0, VERR_INVALID_PARAMETER);
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    AssertPtrNullReturn(pfEvents, VERR_INVALID_POINTER);
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess#endif
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    VBoxGuestWaitEventInfo waitEvent;
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    waitEvent.u32TimeoutIn = cMillies;
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    waitEvent.u32EventMaskIn = fMask;
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    waitEvent.u32Result = VBOXGUEST_WAITEVENT_ERROR;
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    waitEvent.u32EventFlagsOut = 0;
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    int rc = vbglR3DoIOCtl(VBOXGUEST_IOCTL_WAITEVENT, &waitEvent, sizeof(waitEvent));
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    if (RT_SUCCESS(rc))
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    {
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess#if !defined(VBOX_VBGLR3_XFREE86) && !defined(RT_OS_WINDOWS)
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess        AssertMsg(waitEvent.u32Result == VBOXGUEST_WAITEVENT_OK, ("%d rc=%Rrc\n", waitEvent.u32Result, rc));
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess#endif
e1b7b8d87b22c020c01d97d3913da97f2efec94and        if (pfEvents)
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess            *pfEvents = waitEvent.u32EventFlagsOut;
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    }
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess#ifndef VBOX_VBGLR3_XFREE86
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    LogFlow(("VbglR3WaitEvent: rc=%Rrc, u32EventFlagsOut=0x%x. u32Result=%d\n",
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess             rc, waitEvent.u32EventFlagsOut, waitEvent.u32Result));
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess#endif
e1b7b8d87b22c020c01d97d3913da97f2efec94and    return rc;
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess}
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess/**
e1b7b8d87b22c020c01d97d3913da97f2efec94and * Cause any pending WaitEvent calls (VBOXGUEST_IOCTL_WAITEVENT) to return
e1b7b8d87b22c020c01d97d3913da97f2efec94and * with a VERR_INTERRUPTED status.
e1b7b8d87b22c020c01d97d3913da97f2efec94and *
e1b7b8d87b22c020c01d97d3913da97f2efec94and * Can be used in combination with a termination flag variable for interrupting
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * event loops.  Avoiding race conditions is the responsibility of the caller.
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess *
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * @returns IPRT status code.
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess */
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekessVBGLR3DECL(int) VbglR3InterruptEventWaits(void)
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess{
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    return vbglR3DoIOCtl(VBOXGUEST_IOCTL_CANCEL_ALL_WAITEVENTS, 0, 0);
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess}
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess
e1b7b8d87b22c020c01d97d3913da97f2efec94and/**
e1b7b8d87b22c020c01d97d3913da97f2efec94and * Write to the backdoor logger from ring 3 guest code.
e1b7b8d87b22c020c01d97d3913da97f2efec94and *
e1b7b8d87b22c020c01d97d3913da97f2efec94and * @returns IPRT status code.
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess *
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * @param   pch     The string to log.  Does not need to be terminated.
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * @param   cb      The number of byte to log.
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * @todo    cb -> cch.
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess *
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * @remarks This currently does not accept more than 255 bytes of data at
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess *          one time. It should probably be rewritten to use pass a pointer
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess *          in the IOCtl.
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess */
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekessVBGLR3DECL(int) VbglR3WriteLog(const char *pch, size_t cb)
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess{
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    /*
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess     * Quietly skip NULL strings.
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess     * (Happens in the RTLogBackdoorPrintf case.)
e1b7b8d87b22c020c01d97d3913da97f2efec94and     */
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    if (!cb)
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess        return VINF_SUCCESS;
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    if (!VALID_PTR(pch))
e1b7b8d87b22c020c01d97d3913da97f2efec94and        return VERR_INVALID_POINTER;
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess#ifdef RT_OS_WINDOWS
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    /*
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess     * Duplicate the string as it may be read only (a C string).
e1b7b8d87b22c020c01d97d3913da97f2efec94and     */
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    void *pvTmp = RTMemDup(pch, cb);
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    if (!pvTmp)
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess        return VERR_NO_MEMORY;
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    int rc = vbglR3DoIOCtl(VBOXGUEST_IOCTL_LOG(cb), pvTmp, cb);
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    RTMemFree(pvTmp);
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    return rc;
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess#elif 0 /** @todo Several OSes could take this route (solaris and freebsd for instance). */
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    /*
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess     * Handle the entire request in one go.
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess     */
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    return vbglR3DoIOCtl(VBOXGUEST_IOCTL_LOG(cb), pvTmp, cb);
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess#else
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    /*
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess     * *BSD does not accept more than 4KB per ioctl request, while
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess     * Linux can't express sizes above 8KB, so, split it up into 2KB chunks.
e1b7b8d87b22c020c01d97d3913da97f2efec94and     */
e1b7b8d87b22c020c01d97d3913da97f2efec94and# define STEP 2048
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    int rc = VINF_SUCCESS;
e1b7b8d87b22c020c01d97d3913da97f2efec94and    for (size_t off = 0; off < cb && RT_SUCCESS(rc); off += STEP)
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    {
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess        size_t cbStep = RT_MIN(cb - off, STEP);
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess        rc = vbglR3DoIOCtl(VBOXGUEST_IOCTL_LOG(cbStep), (char *)pch + off, cbStep);
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    }
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess# undef STEP
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    return rc;
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess#endif
e1b7b8d87b22c020c01d97d3913da97f2efec94and}
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess/**
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * Change the IRQ filter mask.
e1b7b8d87b22c020c01d97d3913da97f2efec94and *
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * @returns IPRT status code.
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * @param   fOr     The OR mask.
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * @param   fNo     The NOT mask.
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess */
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekessVBGLR3DECL(int) VbglR3CtlFilterMask(uint32_t fOr, uint32_t fNot)
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess{
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    VBoxGuestFilterMaskInfo Info;
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    Info.u32OrMask = fOr;
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    Info.u32NotMask = fNot;
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    return vbglR3DoIOCtl(VBOXGUEST_IOCTL_CTL_FILTER_MASK, &Info, sizeof(Info));
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess}
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess/**
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * Report a change in the capabilities that we support to the host.
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess *
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * @returns IPRT status code.
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * @param   fOr     Capabilities which have been added.
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * @param   fNot    Capabilities which have been removed.
e1b7b8d87b22c020c01d97d3913da97f2efec94and *
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * @todo    Move to a different file.
e1b7b8d87b22c020c01d97d3913da97f2efec94and */
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekessVBGLR3DECL(int) VbglR3SetGuestCaps(uint32_t fOr, uint32_t fNot)
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess{
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    VMMDevReqGuestCapabilities2 Req;
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    vmmdevInitRequest(&Req.header, VMMDevReq_SetGuestCapabilities);
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    Req.u32OrMask = fOr;
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    Req.u32NotMask = fNot;
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    int rc = vbglR3GRPerform(&Req.header);
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess#if defined(DEBUG) && !defined(VBOX_VBGLR3_XFREE86)
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    if (RT_SUCCESS(rc))
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess        LogRel(("Successfully changed guest capabilities: or mask 0x%x, not mask 0x%x.\n", fOr, fNot));
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    else
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess        LogRel(("Failed to change guest capabilities: or mask 0x%x, not mask 0x%x.  rc=%Rrc.\n", fOr, fNot, rc));
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess#endif
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    return rc;
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess}
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess
e1b7b8d87b22c020c01d97d3913da97f2efec94and#ifndef VBOX_VBGLR3_XFREE86
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess/**
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * Query the current statistics update interval.
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess *
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * @returns IPRT status code.
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * @param   pcMsInterval    Update interval in ms (out).
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess */
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekessVBGLR3DECL(int) VbglR3StatQueryInterval(PRTMSINTERVAL pcMsInterval)
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess{
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    VMMDevGetStatisticsChangeRequest Req;
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    vmmdevInitRequest(&Req.header, VMMDevReq_GetStatisticsChangeRequest);
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    Req.eventAck = VMMDEV_EVENT_STATISTICS_INTERVAL_CHANGE_REQUEST;
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    Req.u32StatInterval = 1;
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    int rc = vbglR3GRPerform(&Req.header);
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    if (RT_SUCCESS(rc))
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    {
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess        *pcMsInterval = Req.u32StatInterval * 1000;
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess        if (*pcMsInterval / 1000 != Req.u32StatInterval)
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess            *pcMsInterval = ~(RTMSINTERVAL)0;
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    }
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    return rc;
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess}
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess/**
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * Report guest statistics.
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess *
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * @returns IPRT status code.
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * @param   pReq        Request packet with statistics.
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess */
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekessVBGLR3DECL(int) VbglR3StatReport(VMMDevReportGuestStats *pReq)
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess{
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    vmmdevInitRequest(&pReq->header, VMMDevReq_ReportGuestStats);
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    return vbglR3GRPerform(&pReq->header);
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess}
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess/**
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * Refresh the memory balloon after a change.
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess *
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * @returns IPRT status code.
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * @param   pcChunks        The size of the balloon in chunks of 1MB (out).
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * @param   pfHandleInR3    Allocating of memory in R3 required (out).
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess */
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekessVBGLR3DECL(int) VbglR3MemBalloonRefresh(uint32_t *pcChunks, bool *pfHandleInR3)
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess{
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    VBoxGuestCheckBalloonInfo Info;
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    int rc = vbglR3DoIOCtl(VBOXGUEST_IOCTL_CHECK_BALLOON, &Info, sizeof(Info));
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    if (RT_SUCCESS(rc))
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    {
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess        *pcChunks = Info.cBalloonChunks;
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess        Assert(Info.fHandleInR3 == false || Info.fHandleInR3 == true ||  RT_FAILURE(rc));
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess        *pfHandleInR3 = Info.fHandleInR3 != false;
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    }
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    return rc;
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess}
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess/**
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * Change the memory by granting/reclaiming memory to/from R0.
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess *
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * @returns IPRT status code.
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * @param   pv          Memory chunk (1MB).
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * @param   fInflate    true = inflate balloon (grant memory).
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess *                      false = deflate balloon (reclaim memory).
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess */
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekessVBGLR3DECL(int) VbglR3MemBalloonChange(void *pv, bool fInflate)
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess{
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    VBoxGuestChangeBalloonInfo Info;
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    Info.u64ChunkAddr = (uint64_t)((uintptr_t)pv);
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    Info.fInflate = fInflate;
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    return vbglR3DoIOCtl(VBOXGUEST_IOCTL_CHANGE_BALLOON, &Info, sizeof(Info));
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess}
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess/**
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess * Fallback for vbglR3GetAdditionsVersion.
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess */
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekessstatic int vbglR3GetAdditionsCompileTimeVersion(char **ppszVer, char **ppszRev)
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess{
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    if (ppszVer)
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    {
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess        *ppszVer = RTStrDup(VBOX_VERSION_STRING);
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess        if (!*ppszVer)
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess            return VERR_NO_STR_MEMORY;
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    }
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    if (ppszRev)
4be0f2d2988dc74815a5f9f4a308fbef2c29674ekess    {
        char szRev[64];
        RTStrPrintf(szRev, sizeof(szRev), "%d", VBOX_SVN_REV);
        *ppszRev = RTStrDup(szRev);
        if (!*ppszRev)
        {
            if (ppszVer)
            {
                RTStrFree(*ppszVer);
                *ppszVer = NULL;
            }
            return VERR_NO_STR_MEMORY;
        }
    }

    return VINF_SUCCESS;
}

#ifdef RT_OS_WINDOWS
/**
 * Looks up the storage path handle (registry).
 *
 * @returns IPRT status value
 * @param   hKey        Receives pointer of allocated version string. NULL is
 *                      accepted. The returned pointer must be closed by
 *                      vbglR3CloseAdditionsWinStoragePath().
 */
static int vbglR3GetAdditionsWinStoragePath(PHKEY phKey)
{
    /*
     * Try get the *installed* version first.
     */
    LONG r;

    /* Check the new path first. */
    r = RegOpenKeyEx(HKEY_LOCAL_MACHINE, "SOFTWARE\\Sun\\VirtualBox Guest Additions", 0, KEY_READ, phKey);
# ifdef RT_ARCH_AMD64
    if (r != ERROR_SUCCESS)
    {
        /* Check Wow6432Node (for new entries). */
        r = RegOpenKeyEx(HKEY_LOCAL_MACHINE, "SOFTWARE\\Wow6432Node\\Sun\\VirtualBox Guest Additions", 0, KEY_READ, phKey);
    }
# endif

    /* Still no luck? Then try the old xVM paths ... */
    if (r != ERROR_SUCCESS)
    {
        r = RegOpenKeyEx(HKEY_LOCAL_MACHINE, "SOFTWARE\\Sun\\xVM VirtualBox Guest Additions", 0, KEY_READ, phKey);
# ifdef RT_ARCH_AMD64
        if (r != ERROR_SUCCESS)
        {
            /* Check Wow6432Node (for new entries). */
            r = RegOpenKeyEx(HKEY_LOCAL_MACHINE, "SOFTWARE\\Wow6432Node\\Sun\\xVM VirtualBox Guest Additions", 0, KEY_READ, phKey);
        }
# endif
    }
    return RTErrConvertFromWin32(r);
}


/**
 * Closes the storage path handle (registry).
 *
 * @returns IPRT status value
 * @param   hKey        Handle to close, retrieved by
 *                      vbglR3GetAdditionsWinStoragePath().
 */
static int vbglR3CloseAdditionsWinStoragePath(HKEY hKey)
{
    return RTErrConvertFromWin32(RegCloseKey(hKey));
}

#endif /* RT_OS_WINDOWS */

/**
 * Retrieves the installed Guest Additions version and/or revision.
 *
 * @returns IPRT status value
 * @param   ppszVer     Receives pointer of allocated version string. NULL is
 *                      accepted. The returned pointer must be freed using
 *                      RTStrFree().
 * @param   ppszRev     Receives pointer of allocated revision string. NULL is
 *                      accepted. The returned pointer must be freed using
 *                      RTStrFree().
 */
VBGLR3DECL(int) VbglR3GetAdditionsVersion(char **ppszVer, char **ppszRev)
{
#ifdef RT_OS_WINDOWS
    HKEY hKey;
    int rc = vbglR3GetAdditionsWinStoragePath(&hKey);
    if (RT_SUCCESS(rc))
    {
        /* Version. */
        LONG l;
        DWORD dwType;
        DWORD dwSize = 32;
        char *pszTmp;
        if (ppszVer)
        {
            pszTmp = (char*)RTMemAlloc(dwSize);
            if (pszTmp)
            {
                l = RegQueryValueEx(hKey, "Version", NULL, &dwType, (BYTE*)(LPCTSTR)pszTmp, &dwSize);
                if (l == ERROR_SUCCESS)
                {
                    if (dwType == REG_SZ)
                        rc = RTStrDupEx(ppszVer, pszTmp);
                    else
                        rc = VERR_INVALID_PARAMETER;
                }
                else
                {
                    rc = RTErrConvertFromWin32(l);
                }
                RTMemFree(pszTmp);
            }
            else
                rc = VERR_NO_MEMORY;
        }
        /* Revision. */
        if (ppszRev)
        {
            dwSize = 32; /* Reset */
            pszTmp = (char*)RTMemAlloc(dwSize);
            if (pszTmp)
            {
                l = RegQueryValueEx(hKey, "Revision", NULL, &dwType, (BYTE*)(LPCTSTR)pszTmp, &dwSize);
                if (l == ERROR_SUCCESS)
                {
                    if (dwType == REG_SZ)
                        rc = RTStrDupEx(ppszRev, pszTmp);
                    else
                        rc = VERR_INVALID_PARAMETER;
                }
                else
                {
                    rc = RTErrConvertFromWin32(l);
                }
                RTMemFree(pszTmp);
            }
            else
                rc = VERR_NO_MEMORY;

            if (RT_FAILURE(rc) && ppszVer)
            {
                RTStrFree(*ppszVer);
                *ppszVer = NULL;
            }
        }
        rc = vbglR3CloseAdditionsWinStoragePath(hKey);
    }
    else
    {
        /*
         * No registry entries found, return the version string compiled
         * into this binary.
         */
        rc = vbglR3GetAdditionsCompileTimeVersion(ppszVer, ppszRev);
    }
    return rc;

#else  /* !RT_OS_WINDOWS */
    /*
     * On non-Windows platforms just return the compile-time version string.
     */
    return vbglR3GetAdditionsCompileTimeVersion(ppszVer, ppszRev);
#endif /* !RT_OS_WINDOWS */
}


/**
 * Retrieves the installation path of Guest Additions.
 *
 * @returns IPRT status value
 * @param   ppszPath    Receives pointer of allocated installation path string.
 *                      The returned pointer must be freed using
 *                      RTStrFree().
 */
VBGLR3DECL(int) VbglR3GetAdditionsInstallationPath(char **ppszPath)
{
    int rc;
#ifdef RT_OS_WINDOWS
    HKEY hKey;
    rc = vbglR3GetAdditionsWinStoragePath(&hKey);
    if (RT_SUCCESS(rc))
    {
        /* Installation directory. */
        DWORD dwType;
        DWORD dwSize = _MAX_PATH * sizeof(char);
        char *pszTmp = (char*)RTMemAlloc(dwSize + 1);
        if (pszTmp)
        {
            LONG l = RegQueryValueEx(hKey, "InstallDir", NULL, &dwType, (BYTE*)(LPCTSTR)pszTmp, &dwSize);
            if ((l != ERROR_SUCCESS) && (l != ERROR_FILE_NOT_FOUND))
            {
                rc = RTErrConvertFromNtStatus(l);
            }
            else
            {
                if (dwType == REG_SZ)
                    rc = RTStrDupEx(ppszPath, pszTmp);
                else
                    rc = VERR_INVALID_PARAMETER;
                if (RT_SUCCESS(rc))
                {
                    /* Flip slashes. */
                    for (char *pszTmp2 = ppszPath[0]; *pszTmp2; ++pszTmp2)
                        if (*pszTmp2 == '\\')
                            *pszTmp2 = '/';
                }
            }
            RTMemFree(pszTmp);
        }
        else
            rc = VERR_NO_MEMORY;
        rc = vbglR3CloseAdditionsWinStoragePath(hKey);
    }
#else
    /** @todo implement me */
    rc = VERR_NOT_IMPLEMENTED;
#endif
    return rc;
}

#endif /* !VBOX_VBGLR3_XFREE86 */