common/VBoxGuestLib/VBoxGuestR3Lib.cpp

	VBoxGuestR3Lib.cpp revision e64031e20c39650a7bc902a3e1aba613b9415dee
03831d35f7499c87d51205817c93e9a8d42c4baestevel/* $Id$ */
03831d35f7499c87d51205817c93e9a8d42c4baestevel/** @file
03831d35f7499c87d51205817c93e9a8d42c4baestevel * VBoxGuestR3Lib - Ring-3 Support Library for VirtualBox guest additions, Core.
03831d35f7499c87d51205817c93e9a8d42c4baestevel */
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel/*
03831d35f7499c87d51205817c93e9a8d42c4baestevel * Copyright (C) 2007 Oracle Corporation
03831d35f7499c87d51205817c93e9a8d42c4baestevel *
03831d35f7499c87d51205817c93e9a8d42c4baestevel * This file is part of VirtualBox Open Source Edition (OSE), as
03831d35f7499c87d51205817c93e9a8d42c4baestevel * available from http://www.virtualbox.org. This file is free software;
03831d35f7499c87d51205817c93e9a8d42c4baestevel * you can redistribute it and/or modify it under the terms of the GNU
03831d35f7499c87d51205817c93e9a8d42c4baestevel * General Public License (GPL) as published by the Free Software
03831d35f7499c87d51205817c93e9a8d42c4baestevel * Foundation, in version 2 as it comes in the "COPYING" file of the
03831d35f7499c87d51205817c93e9a8d42c4baestevel * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
03831d35f7499c87d51205817c93e9a8d42c4baestevel * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
03831d35f7499c87d51205817c93e9a8d42c4baestevel *
03831d35f7499c87d51205817c93e9a8d42c4baestevel * The contents of this file may alternatively be used under the terms
03831d35f7499c87d51205817c93e9a8d42c4baestevel * of the Common Development and Distribution License Version 1.0
03831d35f7499c87d51205817c93e9a8d42c4baestevel * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
03831d35f7499c87d51205817c93e9a8d42c4baestevel * VirtualBox OSE distribution, in which case the provisions of the
03831d35f7499c87d51205817c93e9a8d42c4baestevel * CDDL are applicable instead of those of the GPL.
03831d35f7499c87d51205817c93e9a8d42c4baestevel *
03831d35f7499c87d51205817c93e9a8d42c4baestevel * You may elect to license modified versions of this file under the
03831d35f7499c87d51205817c93e9a8d42c4baestevel * terms and conditions of either the GPL or the CDDL or both.
03831d35f7499c87d51205817c93e9a8d42c4baestevel */
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel/*******************************************************************************
03831d35f7499c87d51205817c93e9a8d42c4baestevel*   Header Files                                                               *
03831d35f7499c87d51205817c93e9a8d42c4baestevel*******************************************************************************/
03831d35f7499c87d51205817c93e9a8d42c4baestevel#if defined(RT_OS_WINDOWS)
03831d35f7499c87d51205817c93e9a8d42c4baestevel# include <Windows.h>
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel#elif defined(RT_OS_OS2)
03831d35f7499c87d51205817c93e9a8d42c4baestevel# define INCL_BASE
03831d35f7499c87d51205817c93e9a8d42c4baestevel# define INCL_ERRORS
03831d35f7499c87d51205817c93e9a8d42c4baestevel# include <os2.h>
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel#elif defined(RT_OS_FREEBSD) \
03831d35f7499c87d51205817c93e9a8d42c4baestevel   || defined(RT_OS_LINUX) \
03831d35f7499c87d51205817c93e9a8d42c4baestevel   || defined(RT_OS_SOLARIS)
03831d35f7499c87d51205817c93e9a8d42c4baestevel# include <sys/types.h>
03831d35f7499c87d51205817c93e9a8d42c4baestevel# include <sys/stat.h>
03831d35f7499c87d51205817c93e9a8d42c4baestevel# if defined(RT_OS_LINUX) /** @todo check this on solaris+freebsd as well. */
03831d35f7499c87d51205817c93e9a8d42c4baestevel#  include <sys/ioctl.h>
03831d35f7499c87d51205817c93e9a8d42c4baestevel# endif
03831d35f7499c87d51205817c93e9a8d42c4baestevel# include <errno.h>
03831d35f7499c87d51205817c93e9a8d42c4baestevel# include <unistd.h>
03831d35f7499c87d51205817c93e9a8d42c4baestevel#endif
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel#include <iprt/assert.h>
03831d35f7499c87d51205817c93e9a8d42c4baestevel#include <iprt/asm.h>
03831d35f7499c87d51205817c93e9a8d42c4baestevel#include <iprt/file.h>
03831d35f7499c87d51205817c93e9a8d42c4baestevel#include <iprt/time.h>
03831d35f7499c87d51205817c93e9a8d42c4baestevel#include <iprt/string.h>
03831d35f7499c87d51205817c93e9a8d42c4baestevel#include <iprt/thread.h>
03831d35f7499c87d51205817c93e9a8d42c4baestevel#include <VBox/log.h>
03831d35f7499c87d51205817c93e9a8d42c4baestevel#include "VBGLR3Internal.h"
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel#ifdef VBOX_VBGLR3_XFREE86
03831d35f7499c87d51205817c93e9a8d42c4baestevel/* Rather than try to resolve all the header file conflicts, I will just
03831d35f7499c87d51205817c93e9a8d42c4baestevel   prototype what we need here. */
03831d35f7499c87d51205817c93e9a8d42c4baestevel# define XF86_O_RDWR  0x0002
03831d35f7499c87d51205817c93e9a8d42c4baesteveltypedef void *pointer;
03831d35f7499c87d51205817c93e9a8d42c4baestevelextern "C" int xf86open(const char *, int, ...);
03831d35f7499c87d51205817c93e9a8d42c4baestevelextern "C" int xf86close(int);
03831d35f7499c87d51205817c93e9a8d42c4baestevelextern "C" int xf86ioctl(int, unsigned long, pointer);
03831d35f7499c87d51205817c93e9a8d42c4baestevel#endif
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel/*******************************************************************************
03831d35f7499c87d51205817c93e9a8d42c4baestevel*   Global Variables                                                           *
03831d35f7499c87d51205817c93e9a8d42c4baestevel*******************************************************************************/
03831d35f7499c87d51205817c93e9a8d42c4baestevel/** The VBoxGuest device handle. */
03831d35f7499c87d51205817c93e9a8d42c4baestevel#ifdef VBOX_VBGLR3_XFREE86
03831d35f7499c87d51205817c93e9a8d42c4baestevelstatic int g_File = -1;
03831d35f7499c87d51205817c93e9a8d42c4baestevel#elif defined(RT_OS_WINDOWS)
03831d35f7499c87d51205817c93e9a8d42c4baestevelstatic HANDLE g_hFile = INVALID_HANDLE_VALUE;
03831d35f7499c87d51205817c93e9a8d42c4baestevel#else
03831d35f7499c87d51205817c93e9a8d42c4baestevelstatic RTFILE g_File = NIL_RTFILE;
03831d35f7499c87d51205817c93e9a8d42c4baestevel#endif
03831d35f7499c87d51205817c93e9a8d42c4baestevel/** User counter.
03831d35f7499c87d51205817c93e9a8d42c4baestevel * A counter of the number of times the library has been initialised, for use with
03831d35f7499c87d51205817c93e9a8d42c4baestevel * X.org drivers, where the library may be shared by multiple independant modules
03831d35f7499c87d51205817c93e9a8d42c4baestevel * inside a single process space.
03831d35f7499c87d51205817c93e9a8d42c4baestevel */
03831d35f7499c87d51205817c93e9a8d42c4baestevelstatic uint32_t volatile g_cInits = 0;
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel/**
03831d35f7499c87d51205817c93e9a8d42c4baestevel * Implementation of VbglR3Init and VbglR3InitUser
03831d35f7499c87d51205817c93e9a8d42c4baestevel */
03831d35f7499c87d51205817c93e9a8d42c4baestevelstatic int vbglR3Init(const char *pszDeviceName)
03831d35f7499c87d51205817c93e9a8d42c4baestevel{
03831d35f7499c87d51205817c93e9a8d42c4baestevel    uint32_t cInits = ASMAtomicIncU32(&g_cInits);
03831d35f7499c87d51205817c93e9a8d42c4baestevel    Assert(cInits > 0);
03831d35f7499c87d51205817c93e9a8d42c4baestevel    if (cInits > 1)
03831d35f7499c87d51205817c93e9a8d42c4baestevel    {
03831d35f7499c87d51205817c93e9a8d42c4baestevel        /*
03831d35f7499c87d51205817c93e9a8d42c4baestevel         * This will fail if two (or more) threads race each other calling VbglR3Init.
03831d35f7499c87d51205817c93e9a8d42c4baestevel         * However it will work fine for single threaded or otherwise serialized
03831d35f7499c87d51205817c93e9a8d42c4baestevel         * processed calling us more than once.
03831d35f7499c87d51205817c93e9a8d42c4baestevel         */
03831d35f7499c87d51205817c93e9a8d42c4baestevel#ifdef RT_OS_WINDOWS
03831d35f7499c87d51205817c93e9a8d42c4baestevel        if (g_hFile == INVALID_HANDLE_VALUE)
03831d35f7499c87d51205817c93e9a8d42c4baestevel#elif !defined (VBOX_VBGLR3_XFREE86)
03831d35f7499c87d51205817c93e9a8d42c4baestevel        if (g_File == NIL_RTFILE)
03831d35f7499c87d51205817c93e9a8d42c4baestevel#else
03831d35f7499c87d51205817c93e9a8d42c4baestevel        if (g_File == -1)
03831d35f7499c87d51205817c93e9a8d42c4baestevel#endif
03831d35f7499c87d51205817c93e9a8d42c4baestevel            return VERR_INTERNAL_ERROR;
03831d35f7499c87d51205817c93e9a8d42c4baestevel        return VINF_SUCCESS;
03831d35f7499c87d51205817c93e9a8d42c4baestevel    }
03831d35f7499c87d51205817c93e9a8d42c4baestevel#if defined(RT_OS_WINDOWS)
03831d35f7499c87d51205817c93e9a8d42c4baestevel    if (g_hFile != INVALID_HANDLE_VALUE)
03831d35f7499c87d51205817c93e9a8d42c4baestevel#elif !defined(VBOX_VBGLR3_XFREE86)
03831d35f7499c87d51205817c93e9a8d42c4baestevel    if (g_File != NIL_RTFILE)
03831d35f7499c87d51205817c93e9a8d42c4baestevel#else
03831d35f7499c87d51205817c93e9a8d42c4baestevel    if (g_File != -1)
03831d35f7499c87d51205817c93e9a8d42c4baestevel#endif
03831d35f7499c87d51205817c93e9a8d42c4baestevel        return VERR_INTERNAL_ERROR;
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel#if defined(RT_OS_WINDOWS)
03831d35f7499c87d51205817c93e9a8d42c4baestevel    /*
03831d35f7499c87d51205817c93e9a8d42c4baestevel     * Have to use CreateFile here as we want to specify FILE_FLAG_OVERLAPPED
03831d35f7499c87d51205817c93e9a8d42c4baestevel     * and possible some other bits not availble thru iprt/file.h.
03831d35f7499c87d51205817c93e9a8d42c4baestevel     */
03831d35f7499c87d51205817c93e9a8d42c4baestevel    HANDLE hFile = CreateFile(pszDeviceName,
03831d35f7499c87d51205817c93e9a8d42c4baestevel                              GENERIC_READ | GENERIC_WRITE,
03831d35f7499c87d51205817c93e9a8d42c4baestevel                              FILE_SHARE_READ | FILE_SHARE_WRITE,
03831d35f7499c87d51205817c93e9a8d42c4baestevel                              NULL,
03831d35f7499c87d51205817c93e9a8d42c4baestevel                              OPEN_EXISTING,
03831d35f7499c87d51205817c93e9a8d42c4baestevel                              FILE_ATTRIBUTE_NORMAL | FILE_FLAG_OVERLAPPED,
03831d35f7499c87d51205817c93e9a8d42c4baestevel                              NULL);
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel    if (hFile == INVALID_HANDLE_VALUE)
03831d35f7499c87d51205817c93e9a8d42c4baestevel        return VERR_OPEN_FAILED;
03831d35f7499c87d51205817c93e9a8d42c4baestevel    g_hFile = hFile;
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel#elif defined(RT_OS_OS2)
03831d35f7499c87d51205817c93e9a8d42c4baestevel    /*
03831d35f7499c87d51205817c93e9a8d42c4baestevel     * We might wish to compile this with Watcom, so stick to
03831d35f7499c87d51205817c93e9a8d42c4baestevel     * the OS/2 APIs all the way. And in any case we have to use
03831d35f7499c87d51205817c93e9a8d42c4baestevel     * DosDevIOCtl for the requests, why not use Dos* for everything.
03831d35f7499c87d51205817c93e9a8d42c4baestevel     */
03831d35f7499c87d51205817c93e9a8d42c4baestevel    HFILE hf = NULLHANDLE;
03831d35f7499c87d51205817c93e9a8d42c4baestevel    ULONG ulAction = 0;
03831d35f7499c87d51205817c93e9a8d42c4baestevel    APIRET rc = DosOpen((PCSZ)pszDeviceName, &hf, &ulAction, 0, FILE_NORMAL,
03831d35f7499c87d51205817c93e9a8d42c4baestevel                        OPEN_ACTION_OPEN_IF_EXISTS,
03831d35f7499c87d51205817c93e9a8d42c4baestevel                        OPEN_FLAGS_FAIL_ON_ERROR | OPEN_FLAGS_NOINHERIT | OPEN_SHARE_DENYNONE | OPEN_ACCESS_READWRITE,
03831d35f7499c87d51205817c93e9a8d42c4baestevel                        NULL);
03831d35f7499c87d51205817c93e9a8d42c4baestevel    if (rc)
03831d35f7499c87d51205817c93e9a8d42c4baestevel        return RTErrConvertFromOS2(rc);
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel    if (hf < 16)
03831d35f7499c87d51205817c93e9a8d42c4baestevel    {
03831d35f7499c87d51205817c93e9a8d42c4baestevel        HFILE ahfs[16];
03831d35f7499c87d51205817c93e9a8d42c4baestevel        unsigned i;
03831d35f7499c87d51205817c93e9a8d42c4baestevel        for (i = 0; i < RT_ELEMENTS(ahfs); i++)
03831d35f7499c87d51205817c93e9a8d42c4baestevel        {
03831d35f7499c87d51205817c93e9a8d42c4baestevel            ahfs[i] = 0xffffffff;
03831d35f7499c87d51205817c93e9a8d42c4baestevel            rc = DosDupHandle(hf, &ahfs[i]);
03831d35f7499c87d51205817c93e9a8d42c4baestevel            if (rc)
03831d35f7499c87d51205817c93e9a8d42c4baestevel                break;
03831d35f7499c87d51205817c93e9a8d42c4baestevel        }
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel        if (i-- > 1)
03831d35f7499c87d51205817c93e9a8d42c4baestevel        {
03831d35f7499c87d51205817c93e9a8d42c4baestevel            ULONG fulState = 0;
03831d35f7499c87d51205817c93e9a8d42c4baestevel            rc = DosQueryFHState(ahfs[i], &fulState);
03831d35f7499c87d51205817c93e9a8d42c4baestevel            if (!rc)
03831d35f7499c87d51205817c93e9a8d42c4baestevel            {
03831d35f7499c87d51205817c93e9a8d42c4baestevel                fulState |= OPEN_FLAGS_NOINHERIT;
03831d35f7499c87d51205817c93e9a8d42c4baestevel                fulState &= OPEN_FLAGS_WRITE_THROUGH | OPEN_FLAGS_FAIL_ON_ERROR | OPEN_FLAGS_NO_CACHE | OPEN_FLAGS_NOINHERIT; /* Turn off non-participating bits. */
03831d35f7499c87d51205817c93e9a8d42c4baestevel                rc = DosSetFHState(ahfs[i], fulState);
03831d35f7499c87d51205817c93e9a8d42c4baestevel            }
03831d35f7499c87d51205817c93e9a8d42c4baestevel            if (!rc)
03831d35f7499c87d51205817c93e9a8d42c4baestevel            {
03831d35f7499c87d51205817c93e9a8d42c4baestevel                rc = DosClose(hf);
03831d35f7499c87d51205817c93e9a8d42c4baestevel                AssertMsg(!rc, ("%ld\n", rc));
03831d35f7499c87d51205817c93e9a8d42c4baestevel                hf = ahfs[i];
03831d35f7499c87d51205817c93e9a8d42c4baestevel            }
03831d35f7499c87d51205817c93e9a8d42c4baestevel            else
03831d35f7499c87d51205817c93e9a8d42c4baestevel                i++;
03831d35f7499c87d51205817c93e9a8d42c4baestevel            while (i-- > 0)
03831d35f7499c87d51205817c93e9a8d42c4baestevel                DosClose(ahfs[i]);
03831d35f7499c87d51205817c93e9a8d42c4baestevel        }
03831d35f7499c87d51205817c93e9a8d42c4baestevel    }
03831d35f7499c87d51205817c93e9a8d42c4baestevel    g_File = hf;
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel#elif defined(VBOX_VBGLR3_XFREE86)
03831d35f7499c87d51205817c93e9a8d42c4baestevel    int File = xf86open(pszDeviceName, XF86_O_RDWR);
03831d35f7499c87d51205817c93e9a8d42c4baestevel    if (File == -1)
03831d35f7499c87d51205817c93e9a8d42c4baestevel        return VERR_OPEN_FAILED;
03831d35f7499c87d51205817c93e9a8d42c4baestevel    g_File = File;
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel#else
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel    /* The default implemenation. (linux, solaris, freebsd) */
03831d35f7499c87d51205817c93e9a8d42c4baestevel    RTFILE File;
03831d35f7499c87d51205817c93e9a8d42c4baestevel    int rc = RTFileOpen(&File, pszDeviceName, RTFILE_O_READWRITE | RTFILE_O_OPEN | RTFILE_O_DENY_NONE);
03831d35f7499c87d51205817c93e9a8d42c4baestevel    if (RT_FAILURE(rc))
03831d35f7499c87d51205817c93e9a8d42c4baestevel        return rc;
03831d35f7499c87d51205817c93e9a8d42c4baestevel    g_File = File;
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel#endif
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel#ifndef VBOX_VBGLR3_XFREE86
03831d35f7499c87d51205817c93e9a8d42c4baestevel    /*
03831d35f7499c87d51205817c93e9a8d42c4baestevel     * Create release logger
03831d35f7499c87d51205817c93e9a8d42c4baestevel     */
03831d35f7499c87d51205817c93e9a8d42c4baestevel    PRTLOGGER pReleaseLogger;
03831d35f7499c87d51205817c93e9a8d42c4baestevel    static const char * const s_apszGroups[] = VBOX_LOGGROUP_NAMES;
03831d35f7499c87d51205817c93e9a8d42c4baestevel    int rc2 = RTLogCreate(&pReleaseLogger, 0, "all", "VBOX_RELEASE_LOG",
03831d35f7499c87d51205817c93e9a8d42c4baestevel                          RT_ELEMENTS(s_apszGroups), &s_apszGroups[0],
03831d35f7499c87d51205817c93e9a8d42c4baestevel                          RTLOGDEST_USER, NULL);
03831d35f7499c87d51205817c93e9a8d42c4baestevel    /* This may legitimately fail if we are using the mini-runtime. */
03831d35f7499c87d51205817c93e9a8d42c4baestevel    if (RT_SUCCESS(rc2))
03831d35f7499c87d51205817c93e9a8d42c4baestevel        RTLogRelSetDefaultInstance(pReleaseLogger);
03831d35f7499c87d51205817c93e9a8d42c4baestevel#endif
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel    return VINF_SUCCESS;
03831d35f7499c87d51205817c93e9a8d42c4baestevel}
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel/**
03831d35f7499c87d51205817c93e9a8d42c4baestevel * Open the VBox R3 Guest Library.  This should be called by system daemons
03831d35f7499c87d51205817c93e9a8d42c4baestevel * and processes.
03831d35f7499c87d51205817c93e9a8d42c4baestevel */
03831d35f7499c87d51205817c93e9a8d42c4baestevelVBGLR3DECL(int) VbglR3Init(void)
03831d35f7499c87d51205817c93e9a8d42c4baestevel{
03831d35f7499c87d51205817c93e9a8d42c4baestevel    return vbglR3Init(VBOXGUEST_DEVICE_NAME);
03831d35f7499c87d51205817c93e9a8d42c4baestevel}
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel/**
03831d35f7499c87d51205817c93e9a8d42c4baestevel * Open the VBox R3 Guest Library.  Equivalent to VbglR3Init, but for user
03831d35f7499c87d51205817c93e9a8d42c4baestevel * session processes.
03831d35f7499c87d51205817c93e9a8d42c4baestevel */
03831d35f7499c87d51205817c93e9a8d42c4baestevelVBGLR3DECL(int) VbglR3InitUser(void)
03831d35f7499c87d51205817c93e9a8d42c4baestevel{
03831d35f7499c87d51205817c93e9a8d42c4baestevel    return vbglR3Init(VBOXGUEST_USER_DEVICE_NAME);
03831d35f7499c87d51205817c93e9a8d42c4baestevel}
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevelVBGLR3DECL(void) VbglR3Term(void)
03831d35f7499c87d51205817c93e9a8d42c4baestevel{
03831d35f7499c87d51205817c93e9a8d42c4baestevel    /*
03831d35f7499c87d51205817c93e9a8d42c4baestevel     * Decrement the reference count and see if we're the last one out.
03831d35f7499c87d51205817c93e9a8d42c4baestevel     */
03831d35f7499c87d51205817c93e9a8d42c4baestevel    uint32_t cInits = ASMAtomicDecU32(&g_cInits);
03831d35f7499c87d51205817c93e9a8d42c4baestevel    if (cInits > 0)
03831d35f7499c87d51205817c93e9a8d42c4baestevel        return;
03831d35f7499c87d51205817c93e9a8d42c4baestevel#if !defined(VBOX_VBGLR3_XFREE86)
03831d35f7499c87d51205817c93e9a8d42c4baestevel    AssertReturnVoid(!cInits);
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel# if defined(RT_OS_WINDOWS)
03831d35f7499c87d51205817c93e9a8d42c4baestevel    HANDLE hFile = g_hFile;
03831d35f7499c87d51205817c93e9a8d42c4baestevel    g_hFile = INVALID_HANDLE_VALUE;
03831d35f7499c87d51205817c93e9a8d42c4baestevel    AssertReturnVoid(hFile != INVALID_HANDLE_VALUE);
03831d35f7499c87d51205817c93e9a8d42c4baestevel    BOOL fRc = CloseHandle(hFile);
03831d35f7499c87d51205817c93e9a8d42c4baestevel    Assert(fRc); NOREF(fRc);
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel# elif defined(RT_OS_OS2)
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel    RTFILE File = g_File;
03831d35f7499c87d51205817c93e9a8d42c4baestevel    g_File = NIL_RTFILE;
03831d35f7499c87d51205817c93e9a8d42c4baestevel    AssertReturnVoid(File != NIL_RTFILE);
03831d35f7499c87d51205817c93e9a8d42c4baestevel    APIRET rc = DosClose(File);
03831d35f7499c87d51205817c93e9a8d42c4baestevel    AssertMsg(!rc, ("%ld\n", rc));
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel# else /* The IPRT case. */
03831d35f7499c87d51205817c93e9a8d42c4baestevel    RTFILE File = g_File;
03831d35f7499c87d51205817c93e9a8d42c4baestevel    g_File = NIL_RTFILE;
03831d35f7499c87d51205817c93e9a8d42c4baestevel    AssertReturnVoid(File != NIL_RTFILE);
03831d35f7499c87d51205817c93e9a8d42c4baestevel    int rc = RTFileClose(File);
03831d35f7499c87d51205817c93e9a8d42c4baestevel    AssertRC(rc);
03831d35f7499c87d51205817c93e9a8d42c4baestevel# endif
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel#else  /* VBOX_VBGLR3_XFREE86 */
03831d35f7499c87d51205817c93e9a8d42c4baestevel    int File = g_File;
03831d35f7499c87d51205817c93e9a8d42c4baestevel    g_File = -1;
03831d35f7499c87d51205817c93e9a8d42c4baestevel    if (File == -1)
03831d35f7499c87d51205817c93e9a8d42c4baestevel        return;
03831d35f7499c87d51205817c93e9a8d42c4baestevel    xf86close(File);
03831d35f7499c87d51205817c93e9a8d42c4baestevel#endif /* VBOX_VBGLR3_XFREE86 */
03831d35f7499c87d51205817c93e9a8d42c4baestevel}
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel/**
03831d35f7499c87d51205817c93e9a8d42c4baestevel * Internal wrapper around various OS specific ioctl implemenations.
03831d35f7499c87d51205817c93e9a8d42c4baestevel *
03831d35f7499c87d51205817c93e9a8d42c4baestevel * @returns VBox status code as returned by VBoxGuestCommonIOCtl, or
03831d35f7499c87d51205817c93e9a8d42c4baestevel *          an failure returned by the OS specific ioctl APIs.
03831d35f7499c87d51205817c93e9a8d42c4baestevel *
03831d35f7499c87d51205817c93e9a8d42c4baestevel * @param   iFunction   The requested function.
03831d35f7499c87d51205817c93e9a8d42c4baestevel * @param   pvData      The input and output data buffer.
03831d35f7499c87d51205817c93e9a8d42c4baestevel * @param   cbData      The size of the buffer.
03831d35f7499c87d51205817c93e9a8d42c4baestevel *
03831d35f7499c87d51205817c93e9a8d42c4baestevel * @remark  Exactly how the VBoxGuestCommonIOCtl is ferried back
03831d35f7499c87d51205817c93e9a8d42c4baestevel *          here is OS specific. On BSD and Darwin we can use errno,
03831d35f7499c87d51205817c93e9a8d42c4baestevel *          while on OS/2 we use the 2nd buffer of the IOCtl.
03831d35f7499c87d51205817c93e9a8d42c4baestevel */
03831d35f7499c87d51205817c93e9a8d42c4baestevelint vbglR3DoIOCtl(unsigned iFunction, void *pvData, size_t cbData)
03831d35f7499c87d51205817c93e9a8d42c4baestevel{
03831d35f7499c87d51205817c93e9a8d42c4baestevel#if defined(RT_OS_WINDOWS)
03831d35f7499c87d51205817c93e9a8d42c4baestevel    DWORD cbReturned = 0;
03831d35f7499c87d51205817c93e9a8d42c4baestevel    if (!DeviceIoControl(g_hFile, iFunction, pvData, (DWORD)cbData, pvData, (DWORD)cbData, &cbReturned, NULL))
03831d35f7499c87d51205817c93e9a8d42c4baestevel    {
03831d35f7499c87d51205817c93e9a8d42c4baestevel/** @todo The passing of error codes needs to be tested and fixed (as does *all* the other hosts except for
03831d35f7499c87d51205817c93e9a8d42c4baestevel * OS/2).  The idea is that the VBox status codes in ring-0 should be transfered without loss down to
03831d35f7499c87d51205817c93e9a8d42c4baestevel * ring-3. However, it's not vitally important right now (obviously, since the other guys has been
03831d35f7499c87d51205817c93e9a8d42c4baestevel * ignoring it for 1+ years now).  On Linux and Solaris the transfer is done, but it is currently not
03831d35f7499c87d51205817c93e9a8d42c4baestevel * lossless, so still needs fixing. */
03831d35f7499c87d51205817c93e9a8d42c4baestevel        DWORD LastErr = GetLastError();
03831d35f7499c87d51205817c93e9a8d42c4baestevel        return RTErrConvertFromWin32(LastErr);
03831d35f7499c87d51205817c93e9a8d42c4baestevel    }
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel    return VINF_SUCCESS;
03831d35f7499c87d51205817c93e9a8d42c4baestevel
03831d35f7499c87d51205817c93e9a8d42c4baestevel#elif defined(RT_OS_OS2)
03831d35f7499c87d51205817c93e9a8d42c4baestevel    ULONG cbOS2Parm = cbData;
03831d35f7499c87d51205817c93e9a8d42c4baestevel    int32_t vrc = VERR_INTERNAL_ERROR;
03831d35f7499c87d51205817c93e9a8d42c4baestevel    ULONG cbOS2Data = sizeof(vrc);
    APIRET rc = DosDevIOCtl(g_File, VBOXGUEST_IOCTL_CATEGORY, iFunction,
                            pvData, cbData, &cbOS2Parm,
                            &vrc, sizeof(vrc), &cbOS2Data);
    if (RT_LIKELY(!rc))
        return vrc;
    return RTErrConvertFromOS2(rc);

#elif defined(RT_OS_SOLARIS) || defined(RT_OS_FREEBSD)
    VBGLBIGREQ Hdr;
    Hdr.u32Magic = VBGLBIGREQ_MAGIC;
    Hdr.cbData = cbData;
    Hdr.pvDataR3 = pvData;
# if HC_ARCH_BITS == 32
    Hdr.u32Padding = 0;
# endif

/** @todo test status code passing! Check that the kernel doesn't do any
 *        error checks using specific errno values, and just pass an VBox
 *        error instead of an errno.h one. Alternatively, extend/redefine the
 *        header with an error code return field (much better alternative
 *        actually). */
    int rc = ioctl((int)g_File, iFunction, &Hdr);
    if (rc == -1)
    {
        rc = errno;
        return RTErrConvertFromErrno(rc);
    }
    return VINF_SUCCESS;

#elif defined(RT_OS_LINUX)
# ifdef VBOX_VBGLR3_XFREE86
    int rc = xf86ioctl((int)g_File, iFunction, pvData);
# else
    int rc = ioctl((int)g_File, iFunction, pvData);
# endif
    if (RT_LIKELY(rc == 0))
        return VINF_SUCCESS;

    /* Positive values are negated VBox error status codes. */
    if (rc > 0)
        rc = -rc;
    else
# ifdef VBOX_VBGLR3_XFREE86
        rc = VERR_FILE_IO_ERROR;
#  else
        rc = RTErrConvertFromErrno(errno);
# endif
    NOREF(cbData);
    return rc;

#elif defined(VBOX_VBGLR3_XFREE86)
    /* PORTME - This is preferred over the RTFileIOCtl variant below, just be careful with the (int). */
/** @todo test status code passing! */
    int rc = xf86ioctl(g_File, iFunction, pvData);
    if (rc == -1)
        return VERR_FILE_IO_ERROR;  /* This is purely legacy stuff, it has to work and no more. */
    return VINF_SUCCESS;

#else
    /* Default implementation - PORTME: Do not use this without testings that passing errors works! */
/** @todo test status code passing! */
    int rc2 = VERR_INTERNAL_ERROR;
    int rc = RTFileIoCtl(g_File, (int)iFunction, pvData, cbData, &rc2);
    if (RT_SUCCESS(rc))
        rc = rc2;
    return rc;
#endif
}