VBoxGuestR3Lib.cpp revision 85c594c1140f082dd862abde9dc7825137a3d51a
85c594c1140f082dd862abde9dc7825137a3d51avboxsync/** $Id$ */
85c594c1140f082dd862abde9dc7825137a3d51avboxsync/** @file
85c594c1140f082dd862abde9dc7825137a3d51avboxsync * VBoxGuestR3Lib - Ring-3 Support Library for VirtualBox guest additions.
85c594c1140f082dd862abde9dc7825137a3d51avboxsync */
85c594c1140f082dd862abde9dc7825137a3d51avboxsync
85c594c1140f082dd862abde9dc7825137a3d51avboxsync/*
85c594c1140f082dd862abde9dc7825137a3d51avboxsync * Copyright (C) 2007 innotek GmbH
85c594c1140f082dd862abde9dc7825137a3d51avboxsync *
85c594c1140f082dd862abde9dc7825137a3d51avboxsync * innotek GmbH confidential
85c594c1140f082dd862abde9dc7825137a3d51avboxsync * All rights reserved
85c594c1140f082dd862abde9dc7825137a3d51avboxsync */
85c594c1140f082dd862abde9dc7825137a3d51avboxsync
85c594c1140f082dd862abde9dc7825137a3d51avboxsync
85c594c1140f082dd862abde9dc7825137a3d51avboxsync/*******************************************************************************
85c594c1140f082dd862abde9dc7825137a3d51avboxsync* Header Files *
85c594c1140f082dd862abde9dc7825137a3d51avboxsync*******************************************************************************/
85c594c1140f082dd862abde9dc7825137a3d51avboxsync#ifdef RT_OS_OS2
85c594c1140f082dd862abde9dc7825137a3d51avboxsync# define INCL_BASE
85c594c1140f082dd862abde9dc7825137a3d51avboxsync# define INCL_ERRORS
85c594c1140f082dd862abde9dc7825137a3d51avboxsync# include <os2.h>
85c594c1140f082dd862abde9dc7825137a3d51avboxsync#endif
85c594c1140f082dd862abde9dc7825137a3d51avboxsync
85c594c1140f082dd862abde9dc7825137a3d51avboxsync#include <iprt/time.h>
85c594c1140f082dd862abde9dc7825137a3d51avboxsync#include <iprt/asm.h>
85c594c1140f082dd862abde9dc7825137a3d51avboxsync#include <iprt/string.h>
85c594c1140f082dd862abde9dc7825137a3d51avboxsync#include <iprt/file.h>
85c594c1140f082dd862abde9dc7825137a3d51avboxsync#include <iprt/assert.h>
85c594c1140f082dd862abde9dc7825137a3d51avboxsync#include <iprt/mem.h>
85c594c1140f082dd862abde9dc7825137a3d51avboxsync#include <VBox/VBoxGuest.h>
85c594c1140f082dd862abde9dc7825137a3d51avboxsync
85c594c1140f082dd862abde9dc7825137a3d51avboxsync
85c594c1140f082dd862abde9dc7825137a3d51avboxsync/*******************************************************************************
85c594c1140f082dd862abde9dc7825137a3d51avboxsync* Global Variables *
85c594c1140f082dd862abde9dc7825137a3d51avboxsync*******************************************************************************/
85c594c1140f082dd862abde9dc7825137a3d51avboxsync/** The VBoxGuest device handle. */
85c594c1140f082dd862abde9dc7825137a3d51avboxsyncstatic RTFILE g_File = NIL_RTFILE;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync
85c594c1140f082dd862abde9dc7825137a3d51avboxsyncVBGLR3DECL(int) VbglR3Init(void)
85c594c1140f082dd862abde9dc7825137a3d51avboxsync{
85c594c1140f082dd862abde9dc7825137a3d51avboxsync if (g_File != NIL_RTFILE)
85c594c1140f082dd862abde9dc7825137a3d51avboxsync return VINF_SUCCESS;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync
85c594c1140f082dd862abde9dc7825137a3d51avboxsync#if defined(RT_OS_OS2)
85c594c1140f082dd862abde9dc7825137a3d51avboxsync /*
85c594c1140f082dd862abde9dc7825137a3d51avboxsync * We might wish to compile this with Watcom, so stick to
85c594c1140f082dd862abde9dc7825137a3d51avboxsync * the OS/2 APIs all the way. And in any case we have to use
85c594c1140f082dd862abde9dc7825137a3d51avboxsync * DosDevIOCtl for the requests, why not use Dos* for everything.
85c594c1140f082dd862abde9dc7825137a3d51avboxsync */
85c594c1140f082dd862abde9dc7825137a3d51avboxsync HFILE hf = NULLHANDLE;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync ULONG ulAction = 0;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync APIRET rc = DosOpen((PCSZ)VBOXGUEST_DEVICE_NAME, &hf, &ulAction, 0, FILE_NORMAL,
85c594c1140f082dd862abde9dc7825137a3d51avboxsync OPEN_ACTION_OPEN_IF_EXISTS,
85c594c1140f082dd862abde9dc7825137a3d51avboxsync OPEN_FLAGS_FAIL_ON_ERROR | OPEN_FLAGS_NOINHERIT | OPEN_SHARE_DENYNONE | OPEN_ACCESS_READWRITE,
85c594c1140f082dd862abde9dc7825137a3d51avboxsync NULL);
85c594c1140f082dd862abde9dc7825137a3d51avboxsync if (rc)
85c594c1140f082dd862abde9dc7825137a3d51avboxsync return RTErrConvertFromOS2(rc);
85c594c1140f082dd862abde9dc7825137a3d51avboxsync
85c594c1140f082dd862abde9dc7825137a3d51avboxsync if (hf < 16)
85c594c1140f082dd862abde9dc7825137a3d51avboxsync {
85c594c1140f082dd862abde9dc7825137a3d51avboxsync HFILE ahfs[16];
85c594c1140f082dd862abde9dc7825137a3d51avboxsync unsigned i;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync for (i = 0; i < RT_ELEMENTS(ahfs); i++)
85c594c1140f082dd862abde9dc7825137a3d51avboxsync {
85c594c1140f082dd862abde9dc7825137a3d51avboxsync ahfs[i] = 0xffffffff;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync rc = DosDupHandle(hf, &ahfs[i]);
85c594c1140f082dd862abde9dc7825137a3d51avboxsync if (rc)
85c594c1140f082dd862abde9dc7825137a3d51avboxsync break;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync }
85c594c1140f082dd862abde9dc7825137a3d51avboxsync
85c594c1140f082dd862abde9dc7825137a3d51avboxsync if (i-- > 1)
85c594c1140f082dd862abde9dc7825137a3d51avboxsync {
85c594c1140f082dd862abde9dc7825137a3d51avboxsync ULONG fulState = 0;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync rc = DosQueryFHState(ahfs[i], &fulState);
85c594c1140f082dd862abde9dc7825137a3d51avboxsync if (!rc)
85c594c1140f082dd862abde9dc7825137a3d51avboxsync {
85c594c1140f082dd862abde9dc7825137a3d51avboxsync fulState |= OPEN_FLAGS_NOINHERIT;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync fulState &= OPEN_FLAGS_WRITE_THROUGH | OPEN_FLAGS_FAIL_ON_ERROR | OPEN_FLAGS_NO_CACHE | OPEN_FLAGS_NOINHERIT; /* Turn off non-participating bits. */
85c594c1140f082dd862abde9dc7825137a3d51avboxsync rc = DosSetFHState(ahfs[i], fulState);
85c594c1140f082dd862abde9dc7825137a3d51avboxsync }
85c594c1140f082dd862abde9dc7825137a3d51avboxsync if (!rc)
85c594c1140f082dd862abde9dc7825137a3d51avboxsync {
85c594c1140f082dd862abde9dc7825137a3d51avboxsync rc = DosClose(hf);
85c594c1140f082dd862abde9dc7825137a3d51avboxsync AssertMsg(!rc, ("%ld\n", rc));
85c594c1140f082dd862abde9dc7825137a3d51avboxsync hf = ahfs[i];
85c594c1140f082dd862abde9dc7825137a3d51avboxsync }
85c594c1140f082dd862abde9dc7825137a3d51avboxsync else
85c594c1140f082dd862abde9dc7825137a3d51avboxsync i++;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync while (i-- > 0)
85c594c1140f082dd862abde9dc7825137a3d51avboxsync DosClose(ahfs[i]);
85c594c1140f082dd862abde9dc7825137a3d51avboxsync }
85c594c1140f082dd862abde9dc7825137a3d51avboxsync }
85c594c1140f082dd862abde9dc7825137a3d51avboxsync g_File = hf;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync
85c594c1140f082dd862abde9dc7825137a3d51avboxsync#else
85c594c1140f082dd862abde9dc7825137a3d51avboxsync /* the default implemenation. */
85c594c1140f082dd862abde9dc7825137a3d51avboxsync RTFILE File;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync int rc = RTFileOpen(&File, VBOXGUEST_DEVICE_NAME, RTFILE_O_DENY_READWRITE | RTFILE_O_OPEN | RTFILE_O_DENY_NONE);
85c594c1140f082dd862abde9dc7825137a3d51avboxsync if (RT_FAILURE(rc))
85c594c1140f082dd862abde9dc7825137a3d51avboxsync return rc;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync g_File = File;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync
85c594c1140f082dd862abde9dc7825137a3d51avboxsync#endif
85c594c1140f082dd862abde9dc7825137a3d51avboxsync
85c594c1140f082dd862abde9dc7825137a3d51avboxsync return VINF_SUCCESS;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync}
85c594c1140f082dd862abde9dc7825137a3d51avboxsync
85c594c1140f082dd862abde9dc7825137a3d51avboxsync
85c594c1140f082dd862abde9dc7825137a3d51avboxsyncVBGLR3DECL(void) VbglR3Term(void)
85c594c1140f082dd862abde9dc7825137a3d51avboxsync{
85c594c1140f082dd862abde9dc7825137a3d51avboxsync RTFILE File = g_File;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync g_File = NIL_RTFILE;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync if (File == NIL_RTFILE)
85c594c1140f082dd862abde9dc7825137a3d51avboxsync return;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync#if defined(RT_OS_OS2)
85c594c1140f082dd862abde9dc7825137a3d51avboxsync APIRET rc = DosClose(File);
85c594c1140f082dd862abde9dc7825137a3d51avboxsync AssertMsg(!rc, ("%ld\n", rc));
85c594c1140f082dd862abde9dc7825137a3d51avboxsync#else
85c594c1140f082dd862abde9dc7825137a3d51avboxsync int rc = RTFileClose(File);
85c594c1140f082dd862abde9dc7825137a3d51avboxsync AssertRC(rc);
85c594c1140f082dd862abde9dc7825137a3d51avboxsync#endif
85c594c1140f082dd862abde9dc7825137a3d51avboxsync}
85c594c1140f082dd862abde9dc7825137a3d51avboxsync
85c594c1140f082dd862abde9dc7825137a3d51avboxsync
85c594c1140f082dd862abde9dc7825137a3d51avboxsync/**
85c594c1140f082dd862abde9dc7825137a3d51avboxsync * Internal wrapper around various OS specific ioctl implemenations.
85c594c1140f082dd862abde9dc7825137a3d51avboxsync *
85c594c1140f082dd862abde9dc7825137a3d51avboxsync * @returns VBox status code as returned by VBoxGuestCommonIOCtl, or
85c594c1140f082dd862abde9dc7825137a3d51avboxsync * an failure returned by the OS specific ioctl APIs.
85c594c1140f082dd862abde9dc7825137a3d51avboxsync *
85c594c1140f082dd862abde9dc7825137a3d51avboxsync * @param iFunction The requested function.
85c594c1140f082dd862abde9dc7825137a3d51avboxsync * @param pvData The input and output data buffer.
85c594c1140f082dd862abde9dc7825137a3d51avboxsync * @param cbData The size of the buffer.
85c594c1140f082dd862abde9dc7825137a3d51avboxsync *
85c594c1140f082dd862abde9dc7825137a3d51avboxsync * @remark Exactly how the VBoxGuestCommonIOCtl is ferried back
85c594c1140f082dd862abde9dc7825137a3d51avboxsync * here is OS specific. On BSD and Darwin we can use errno,
85c594c1140f082dd862abde9dc7825137a3d51avboxsync * while on OS/2 we use the 2nd buffer of the IOCtl.
85c594c1140f082dd862abde9dc7825137a3d51avboxsync */
85c594c1140f082dd862abde9dc7825137a3d51avboxsyncint vbglR3DoIOCtl(unsigned iFunction, void *pvData, size_t cbData)
85c594c1140f082dd862abde9dc7825137a3d51avboxsync{
85c594c1140f082dd862abde9dc7825137a3d51avboxsync#ifdef RT_OS_OS2
85c594c1140f082dd862abde9dc7825137a3d51avboxsync ULONG cbOS2Parm = cbData;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync int32_t vrc = VERR_INTERNAL_ERROR;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync ULONG cbOS2Data = sizeof(vrc);
85c594c1140f082dd862abde9dc7825137a3d51avboxsync APIRET rc = DosDevIOCtl(g_File, VBOXGUEST_IOCTL_CATEGORY, iFunction,
85c594c1140f082dd862abde9dc7825137a3d51avboxsync pvData, cbData, &cbOS2Parm,
85c594c1140f082dd862abde9dc7825137a3d51avboxsync &vrc, sizeof(vrc), &cbOS2Data);
85c594c1140f082dd862abde9dc7825137a3d51avboxsync if (RT_LIKELY(!rc))
85c594c1140f082dd862abde9dc7825137a3d51avboxsync return vrc;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync return RTErrConvertFromOS2(rc);
85c594c1140f082dd862abde9dc7825137a3d51avboxsync
85c594c1140f082dd862abde9dc7825137a3d51avboxsync#elif defined(RT_OS_LINUX)
85c594c1140f082dd862abde9dc7825137a3d51avboxsync int rc2 = VERR_INTERNAL_ERROR;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync int rc = RTFileIoCtl(g_File, (int)iFunction, pvData, cbData, &rc2);
85c594c1140f082dd862abde9dc7825137a3d51avboxsync if (RT_SUCCESS(rc))
85c594c1140f082dd862abde9dc7825137a3d51avboxsync rc = rc2;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync return rc;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync#else
85c594c1140f082dd862abde9dc7825137a3d51avboxsync# error "PORTME"
85c594c1140f082dd862abde9dc7825137a3d51avboxsync# if 0 /* if this works for anyone I'd be amazed. */
85c594c1140f082dd862abde9dc7825137a3d51avboxsync int rc2 = VERR_INTERNAL_ERROR;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync int rc = RTFileIoCtl(g_File, (int)iFunction, pvData, cbData, &rc2);
85c594c1140f082dd862abde9dc7825137a3d51avboxsync if (RT_SUCCESS(rc))
85c594c1140f082dd862abde9dc7825137a3d51avboxsync rc = rc2;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync return rc;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync# endif
85c594c1140f082dd862abde9dc7825137a3d51avboxsync#endif
85c594c1140f082dd862abde9dc7825137a3d51avboxsync}
85c594c1140f082dd862abde9dc7825137a3d51avboxsync
85c594c1140f082dd862abde9dc7825137a3d51avboxsyncVBGLR3DECL(int) VbglR3GRAlloc(VMMDevRequestHeader **ppReq, uint32_t cbSize,
85c594c1140f082dd862abde9dc7825137a3d51avboxsync VMMDevRequestType reqType)
85c594c1140f082dd862abde9dc7825137a3d51avboxsync{
85c594c1140f082dd862abde9dc7825137a3d51avboxsync VMMDevRequestHeader *pReq;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync int rc = VINF_SUCCESS;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync
85c594c1140f082dd862abde9dc7825137a3d51avboxsync if (!ppReq || cbSize < sizeof (VMMDevRequestHeader))
85c594c1140f082dd862abde9dc7825137a3d51avboxsync {
85c594c1140f082dd862abde9dc7825137a3d51avboxsync AssertMsgFailed(("VbglR3GRAlloc: Invalid parameter: ppReq = %p, cbSize = %d\n",
85c594c1140f082dd862abde9dc7825137a3d51avboxsync ppReq, cbSize));
85c594c1140f082dd862abde9dc7825137a3d51avboxsync return VERR_INVALID_PARAMETER;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync }
85c594c1140f082dd862abde9dc7825137a3d51avboxsync pReq = (VMMDevRequestHeader *)RTMemTmpAlloc (cbSize);
85c594c1140f082dd862abde9dc7825137a3d51avboxsync if (!pReq)
85c594c1140f082dd862abde9dc7825137a3d51avboxsync {
85c594c1140f082dd862abde9dc7825137a3d51avboxsync AssertMsgFailed(("VbglR3GRAlloc: no memory\n"));
85c594c1140f082dd862abde9dc7825137a3d51avboxsync rc = VERR_NO_MEMORY;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync }
85c594c1140f082dd862abde9dc7825137a3d51avboxsync else
85c594c1140f082dd862abde9dc7825137a3d51avboxsync {
85c594c1140f082dd862abde9dc7825137a3d51avboxsync pReq->size = cbSize;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync pReq->version = VMMDEV_REQUEST_HEADER_VERSION;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync pReq->requestType = reqType;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync pReq->rc = VERR_GENERAL_FAILURE;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync pReq->reserved1 = 0;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync pReq->reserved2 = 0;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync
85c594c1140f082dd862abde9dc7825137a3d51avboxsync *ppReq = pReq;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync }
85c594c1140f082dd862abde9dc7825137a3d51avboxsync
85c594c1140f082dd862abde9dc7825137a3d51avboxsync return rc;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync}
85c594c1140f082dd862abde9dc7825137a3d51avboxsync
85c594c1140f082dd862abde9dc7825137a3d51avboxsyncVBGLR3DECL(int) VbglR3GRPerform(VMMDevRequestHeader *pReq)
85c594c1140f082dd862abde9dc7825137a3d51avboxsync{
85c594c1140f082dd862abde9dc7825137a3d51avboxsync return vbglR3DoIOCtl(VBOXGUEST_IOCTL_VMMREQUEST(pReq->size), pReq, pReq->size);
85c594c1140f082dd862abde9dc7825137a3d51avboxsync}
85c594c1140f082dd862abde9dc7825137a3d51avboxsync
85c594c1140f082dd862abde9dc7825137a3d51avboxsyncVBGLR3DECL(void) VbglR3GRFree (VMMDevRequestHeader *pReq)
85c594c1140f082dd862abde9dc7825137a3d51avboxsync{
85c594c1140f082dd862abde9dc7825137a3d51avboxsync RTMemTmpFree((void *)pReq);
85c594c1140f082dd862abde9dc7825137a3d51avboxsync}
85c594c1140f082dd862abde9dc7825137a3d51avboxsync
85c594c1140f082dd862abde9dc7825137a3d51avboxsyncVBGLR3DECL(int) VbglR3GetHostTime(PRTTIMESPEC pTime)
85c594c1140f082dd862abde9dc7825137a3d51avboxsync{
85c594c1140f082dd862abde9dc7825137a3d51avboxsync VMMDevReqHostTime Req;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync vmmdevInitRequest(&Req.header, VMMDevReq_GetHostTime);
85c594c1140f082dd862abde9dc7825137a3d51avboxsync Req.time = UINT64_MAX;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync int rc = VbglR3GRPerform(&Req.header);
85c594c1140f082dd862abde9dc7825137a3d51avboxsync if (RT_SUCCESS(rc))
85c594c1140f082dd862abde9dc7825137a3d51avboxsync RTTimeSpecSetMilli(pTime, (int64_t)Req.time);
85c594c1140f082dd862abde9dc7825137a3d51avboxsync return rc;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync}
85c594c1140f082dd862abde9dc7825137a3d51avboxsync
85c594c1140f082dd862abde9dc7825137a3d51avboxsync/**
85c594c1140f082dd862abde9dc7825137a3d51avboxsync * Cause any pending WaitEvent calls (VBOXGUEST_IOCTL_WAITEVENT) to return with a
85c594c1140f082dd862abde9dc7825137a3d51avboxsync * VERR_INTERRUPTED error. Can be used in combination with a termination flag variable for
85c594c1140f082dd862abde9dc7825137a3d51avboxsync * interrupting event loops. Avoiding race conditions is the responsibility of the caller.
85c594c1140f082dd862abde9dc7825137a3d51avboxsync *
85c594c1140f082dd862abde9dc7825137a3d51avboxsync * @returns IPRT status code
85c594c1140f082dd862abde9dc7825137a3d51avboxsync */
85c594c1140f082dd862abde9dc7825137a3d51avboxsyncVBGLR3DECL(int) VbglR3InterruptEventWaits(void)
85c594c1140f082dd862abde9dc7825137a3d51avboxsync{
85c594c1140f082dd862abde9dc7825137a3d51avboxsync return vbglR3DoIOCtl(VBOXGUEST_IOCTL_WAITEVENT_INTERRUPT_ALL, 0, 0);
85c594c1140f082dd862abde9dc7825137a3d51avboxsync}