VBoxGuestR3LibMisc.cpp revision 2dbca53b2c122d346cb55db24009d1b1e31e1539
/* $Id$ */
/** @file
* VBoxGuestR3Lib - Ring-3 Support Library for VirtualBox guest additions, Misc.
*/
/*
* Copyright (C) 2007 Sun Microsystems, Inc.
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*
* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
* Clara, CA 95054 USA or visit http://www.sun.com if you need
* additional information or have any questions.
*/
/*******************************************************************************
* Header Files *
*******************************************************************************/
#include "VBGLR3Internal.h"
/**
* Wait for the host to signal one or more events and return which.
*
* The events will only be delivered by the host if they have been enabled
* previously using @a VbglR3CtlFilterMask. If one or several of the events
* have already been signalled but not yet waited for, this function will return
* immediately and return those events.
*
* @returns IPRT status code
*
* @param fMask The events we want to wait for, or-ed together.
* @param cMillies How long to wait before giving up and returning
* (VERR_TIMEOUT). Use RT_INDEFINITE_WAIT to wait until we
* are interrupted or one of the events is signalled.
* @param pfEvents Where to store the events signalled. Optional.
*/
{
#ifndef VBOX_VBGLR3_XFREE86
LogFlow(("VbglR3WaitEvent: fMask=0x%x, cMillies=%u, pfEvents=%p\n",
#endif
if (RT_SUCCESS(rc))
{
#ifndef VBOX_VBGLR3_XFREE86
#endif
if (pfEvents)
}
#ifndef VBOX_VBGLR3_XFREE86
LogFlow(("VbglR3WaitEvent: rc=%Rrc, u32EventFlagsOut=0x%x. u32Result=%d\n",
#endif
return rc;
}
/**
* Cause any pending WaitEvent calls (VBOXGUEST_IOCTL_WAITEVENT) to return
* with a VERR_INTERRUPTED status.
*
* Can be used in combination with a termination flag variable for interrupting
* event loops. Avoiding race conditions is the responsibility of the caller.
*
* @returns IPRT status code
*/
VBGLR3DECL(int) VbglR3InterruptEventWaits(void)
{
return vbglR3DoIOCtl(VBOXGUEST_IOCTL_CANCEL_ALL_WAITEVENTS, 0, 0);
}
/**
* Write to the backdoor logger from ring 3 guest code.
*
* @returns IPRT status code
*
* @remarks This currently does not accept more than 255 bytes of data at
* one time. It should probably be rewritten to use pass a pointer
* in the IOCtl.
*/
{
/*
* Quietly skip NULL strings.
* (Happens in the RTLogBackdoorPrintf case.)
*/
if (!cb)
return VINF_SUCCESS;
return VERR_INVALID_POINTER;
#ifdef RT_OS_WINDOWS
/*
* Duplicate the string as it may be read only (a C string).
*/
if (!pvTmp)
return VERR_NO_MEMORY;
return rc;
#elif 0 /** @todo Several OSes could take this route (solaris and freebsd for instance). */
/*
* Handle the entire request in one go.
*/
#else
/*
* *BSD does not accept more than 4KB per ioctl request, while
* Linux can't express sizes above 8KB, so, split it up into 2KB chunks.
*/
# define STEP 2048
int rc = VINF_SUCCESS;
{
}
return rc;
#endif
}
/**
* Change the IRQ filter mask.
*
* @returns IPRT status code
* @param fOr The OR mask.
* @param fNo The NOT mask.
*/
{
}
/**
* Report a change in the capabilities that we support to the host.
*
* @returns IPRT status value
* @param fOr Capabilities which have been added.
* @param fNot Capabilities which have been removed.
*
* @todo Move to a different file.
*/
{
#if defined(DEBUG) && !defined(VBOX_VBGLR3_XFREE86)
if (RT_SUCCESS(rc))
else
LogRel(("Failed to change guest capabilities: or mask 0x%x, not mask 0x%x. rc=%Rrc.\n", fOr, fNot, rc));
#endif
return rc;
}
/**
* Query the current statistics update interval
*
* @returns IPRT status code
* @param pu32Interval Update interval in ms (out)
*/
{
if (RT_SUCCESS(rc))
return rc;
}
/**
* Report guest statistics
*
* @returns IPRT status code
* @param pReq Request packet with statistics
*/
{
}
/**
* Refresh the memory balloon after a change
*
* @returns IPRT status code
* @param pu32Size Memory balloon size in MBs (out)
*/
{
}
#ifndef VBOX_VBGLR3_XFREE86
/**
* Fallback for vbglR3GetAdditionsVersion.
*/
{
if (ppszVer)
{
if (!*ppszVer)
return VERR_NO_STR_MEMORY;
}
if (ppszRev)
{
char szRev[64];
if (!*ppszRev)
{
if (ppszVer)
{
}
return VERR_NO_STR_MEMORY;
}
}
return VINF_SUCCESS;
}
#endif
#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().
*/
{
/*
* 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().
*/
{
}
#endif /* RT_OS_WINDOWS */
#ifndef VBOX_VBGLR3_XFREE86
/**
*
* @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().
*/
{
#ifdef RT_OS_WINDOWS
if (RT_SUCCESS(rc))
{
/* Version. */
LONG l;
char *pszTmp;
if (ppszVer)
{
if (pszTmp)
{
if (l == ERROR_SUCCESS)
{
else
}
else
{
rc = RTErrConvertFromWin32(l);
}
}
else
rc = VERR_NO_MEMORY;
}
/* Revision. */
if (ppszRev)
{
if (pszTmp)
{
if (l == ERROR_SUCCESS)
{
else
}
else
{
rc = RTErrConvertFromWin32(l);
}
}
else
rc = VERR_NO_MEMORY;
{
}
}
}
else
{
/*
* No registry entries found, return the version string compiled
* into this binary.
*/
}
return rc;
#else /* !RT_OS_WINDOWS */
/*
* On non-Windows platforms just return the compile-time version string.
*/
#endif /* !RT_OS_WINDOWS */
}
#endif /* !VBOX_VBGLR3_XFREE86 */
/**
* 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().
*/
{
int rc;
#ifdef RT_OS_WINDOWS
if (RT_SUCCESS(rc))
{
/* Installation directory. */
if (pszTmp)
{
if ((l != ERROR_SUCCESS) && (l != ERROR_FILE_NOT_FOUND))
{
rc = RTErrConvertFromNtStatus(l);
}
else
{
else
if (RT_SUCCESS(rc))
{
/* Flip slashes. */
if (*pszTmp2 == '\\')
*pszTmp2 = '/';
}
}
}
else
rc = VERR_NO_MEMORY;
}
#else
/** @todo implement me */
#endif
return rc;
}