VBoxGuestR3Lib.cpp revision 0c1bdc5adae416967cb64e09f8ec81a5b77fe31d
083dd76e9fd7a829b1ed67ffc9003276643e7db1vboxsync/* $Id$ */
85c594c1140f082dd862abde9dc7825137a3d51avboxsync/** @file
083dd76e9fd7a829b1ed67ffc9003276643e7db1vboxsync * VBoxGuestR3Lib - Ring-3 Support Library for VirtualBox guest additions, Core.
85c594c1140f082dd862abde9dc7825137a3d51avboxsync */
85c594c1140f082dd862abde9dc7825137a3d51avboxsync
85c594c1140f082dd862abde9dc7825137a3d51avboxsync/*
85c594c1140f082dd862abde9dc7825137a3d51avboxsync * Copyright (C) 2007 innotek GmbH
85c594c1140f082dd862abde9dc7825137a3d51avboxsync *
bd8e360cd1db83dcb2694ea9122ce3bc5bae678avboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
bd8e360cd1db83dcb2694ea9122ce3bc5bae678avboxsync * available from http://www.virtualbox.org. This file is free software;
bd8e360cd1db83dcb2694ea9122ce3bc5bae678avboxsync * you can redistribute it and/or modify it under the terms of the GNU
bd8e360cd1db83dcb2694ea9122ce3bc5bae678avboxsync * General Public License (GPL) as published by the Free Software
bd8e360cd1db83dcb2694ea9122ce3bc5bae678avboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
bd8e360cd1db83dcb2694ea9122ce3bc5bae678avboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
bd8e360cd1db83dcb2694ea9122ce3bc5bae678avboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
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>
87b2fb3f8283472ba7010aedbf2b4dc12302155cvboxsync#elif defined(RT_OS_SOLARIS)
87b2fb3f8283472ba7010aedbf2b4dc12302155cvboxsync# include <sys/types.h>
87b2fb3f8283472ba7010aedbf2b4dc12302155cvboxsync# include <sys/stat.h>
11a862be79fe123488bccca60c06e92cdbfec6e8vboxsync# include <errno.h>
87b2fb3f8283472ba7010aedbf2b4dc12302155cvboxsync# include <unistd.h>
e38719852d98638514dba23fbacf53ad11361d6avboxsync#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>
c125376ef076c2334e09915c77098cdfef3a4935vboxsync#include <iprt/alloca.h>
85c594c1140f082dd862abde9dc7825137a3d51avboxsync#include <VBox/VBoxGuest.h>
083dd76e9fd7a829b1ed67ffc9003276643e7db1vboxsync#include "VBGLR3Internal.h"
85c594c1140f082dd862abde9dc7825137a3d51avboxsync
6edb4183bc898fddcd0987b6c5c3903b8246fe45vboxsync
85c594c1140f082dd862abde9dc7825137a3d51avboxsync/*******************************************************************************
85c594c1140f082dd862abde9dc7825137a3d51avboxsync* Global Variables *
85c594c1140f082dd862abde9dc7825137a3d51avboxsync*******************************************************************************/
85c594c1140f082dd862abde9dc7825137a3d51avboxsync/** The VBoxGuest device handle. */
85c594c1140f082dd862abde9dc7825137a3d51avboxsyncstatic RTFILE g_File = NIL_RTFILE;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync
4ad933b349952e43d0b6ce21b3f5e2833ca04e85vboxsync
85c594c1140f082dd862abde9dc7825137a3d51avboxsyncVBGLR3DECL(int) VbglR3Init(void)
85c594c1140f082dd862abde9dc7825137a3d51avboxsync{
85c594c1140f082dd862abde9dc7825137a3d51avboxsync if (g_File != NIL_RTFILE)
85c594c1140f082dd862abde9dc7825137a3d51avboxsync return VINF_SUCCESS;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync
85c594c1140f082dd862abde9dc7825137a3d51avboxsync#if defined(RT_OS_OS2)
85c594c1140f082dd862abde9dc7825137a3d51avboxsync /*
e38719852d98638514dba23fbacf53ad11361d6avboxsync * We might wish to compile this with Watcom, so stick to
e38719852d98638514dba23fbacf53ad11361d6avboxsync * 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
6edb4183bc898fddcd0987b6c5c3903b8246fe45vboxsync /* PORTME */
6edb4183bc898fddcd0987b6c5c3903b8246fe45vboxsync#else
6edb4183bc898fddcd0987b6c5c3903b8246fe45vboxsync /* the default implemenation. (linux, solaris) */
85c594c1140f082dd862abde9dc7825137a3d51avboxsync RTFILE File;
6edb4183bc898fddcd0987b6c5c3903b8246fe45vboxsync int rc = RTFileOpen(&File, VBOXGUEST_DEVICE_NAME, RTFILE_O_READWRITE | RTFILE_O_OPEN | RTFILE_O_DENY_NONE);
85c594c1140f082dd862abde9dc7825137a3d51avboxsync if (RT_FAILURE(rc))
85c594c1140f082dd862abde9dc7825137a3d51avboxsync return rc;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync g_File = File;
85c594c1140f082dd862abde9dc7825137a3d51avboxsync
e38719852d98638514dba23fbacf53ad11361d6avboxsync#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.
e38719852d98638514dba23fbacf53ad11361d6avboxsync *
85c594c1140f082dd862abde9dc7825137a3d51avboxsync * @returns VBox status code as returned by VBoxGuestCommonIOCtl, or
85c594c1140f082dd862abde9dc7825137a3d51avboxsync * an failure returned by the OS specific ioctl APIs.
e38719852d98638514dba23fbacf53ad11361d6avboxsync *
85c594c1140f082dd862abde9dc7825137a3d51avboxsync * @param iFunction The requested function.
85c594c1140f082dd862abde9dc7825137a3d51avboxsync * @param pvData The input and output data buffer.
85c594c1140f082dd862abde9dc7825137a3d51avboxsync * @param cbData The size of the buffer.
e38719852d98638514dba23fbacf53ad11361d6avboxsync *
85c594c1140f082dd862abde9dc7825137a3d51avboxsync * @remark Exactly how the VBoxGuestCommonIOCtl is ferried back
e38719852d98638514dba23fbacf53ad11361d6avboxsync * 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 */
0c1bdc5adae416967cb64e09f8ec81a5b77fe31dvboxsyncint 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);
e38719852d98638514dba23fbacf53ad11361d6avboxsync 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
11a862be79fe123488bccca60c06e92cdbfec6e8vboxsync#elif defined(RT_OS_SOLARIS)
1c8130d3c423590046a8ed4f3059de38ac5dcc14vboxsync VBGLBIGREQ Hdr;
1c8130d3c423590046a8ed4f3059de38ac5dcc14vboxsync Hdr.u32Magic = VBGLBIGREQ_MAGIC;
1c8130d3c423590046a8ed4f3059de38ac5dcc14vboxsync Hdr.cbData = cbData;
11a862be79fe123488bccca60c06e92cdbfec6e8vboxsync Hdr.pvDataR3 = pvData;
1c8130d3c423590046a8ed4f3059de38ac5dcc14vboxsync
11a862be79fe123488bccca60c06e92cdbfec6e8vboxsync int rc = ioctl((int)g_File, iFunction, &Hdr);
1c8130d3c423590046a8ed4f3059de38ac5dcc14vboxsync if (rc == -1)
1c8130d3c423590046a8ed4f3059de38ac5dcc14vboxsync rc = errno;
1c8130d3c423590046a8ed4f3059de38ac5dcc14vboxsync return rc;
1c8130d3c423590046a8ed4f3059de38ac5dcc14vboxsync
e38719852d98638514dba23fbacf53ad11361d6avboxsync#else
c125376ef076c2334e09915c77098cdfef3a4935vboxsync /* Default implementation - PORTME: Do not use this without testings that error passing works! */
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}
85c594c1140f082dd862abde9dc7825137a3d51avboxsync