| 1 | /* $Id: VBoxGuestR3Lib.cpp 10639 2008-07-15 10:03:43Z vboxsync $ */
|
|---|
| 2 | /** @file
|
|---|
| 3 | * VBoxGuestR3Lib - Ring-3 Support Library for VirtualBox guest additions, Core.
|
|---|
| 4 | */
|
|---|
| 5 |
|
|---|
| 6 | /*
|
|---|
| 7 | * Copyright (C) 2007 Sun Microsystems, Inc.
|
|---|
| 8 | *
|
|---|
| 9 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
|---|
| 10 | * available from http://www.virtualbox.org. This file is free software;
|
|---|
| 11 | * you can redistribute it and/or modify it under the terms of the GNU
|
|---|
| 12 | * General Public License (GPL) as published by the Free Software
|
|---|
| 13 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
|---|
| 14 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
|---|
| 15 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
|---|
| 16 | *
|
|---|
| 17 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
|
|---|
| 18 | * Clara, CA 95054 USA or visit http://www.sun.com if you need
|
|---|
| 19 | * additional information or have any questions.
|
|---|
| 20 | */
|
|---|
| 21 |
|
|---|
| 22 |
|
|---|
| 23 | /*******************************************************************************
|
|---|
| 24 | * Header Files *
|
|---|
| 25 | *******************************************************************************/
|
|---|
| 26 | #if defined(RT_OS_WINDOWS)
|
|---|
| 27 | # include <Windows.h>
|
|---|
| 28 |
|
|---|
| 29 | #elif defined(RT_OS_OS2)
|
|---|
| 30 | # define INCL_BASE
|
|---|
| 31 | # define INCL_ERRORS
|
|---|
| 32 | # include <os2.h>
|
|---|
| 33 |
|
|---|
| 34 | #elif defined(RT_OS_SOLARIS) || defined(RT_OS_FREEBSD)
|
|---|
| 35 | # include <sys/types.h>
|
|---|
| 36 | # include <sys/stat.h>
|
|---|
| 37 | # include <errno.h>
|
|---|
| 38 | # include <unistd.h>
|
|---|
| 39 | #endif
|
|---|
| 40 |
|
|---|
| 41 | #include <iprt/time.h>
|
|---|
| 42 | #include <iprt/asm.h>
|
|---|
| 43 | #include <iprt/string.h>
|
|---|
| 44 | #include <iprt/file.h>
|
|---|
| 45 | #include <iprt/assert.h>
|
|---|
| 46 | #include <iprt/thread.h>
|
|---|
| 47 | #include <VBox/VBoxGuest.h>
|
|---|
| 48 | #include <VBox/log.h>
|
|---|
| 49 | #include "VBGLR3Internal.h"
|
|---|
| 50 |
|
|---|
| 51 | #ifdef VBOX_VBGLR3_XFREE86
|
|---|
| 52 | /* Rather than try to resolve all the header file conflicts, I will just
|
|---|
| 53 | prototype what we need here. */
|
|---|
| 54 | # define XF86_O_RDWR 0x0002
|
|---|
| 55 | typedef void *pointer;
|
|---|
| 56 | extern "C" int xf86open(const char*, int,...);
|
|---|
| 57 | extern "C" int xf86close(int);
|
|---|
| 58 | extern "C" int xf86ioctl(int, unsigned long, pointer);
|
|---|
| 59 | #endif
|
|---|
| 60 |
|
|---|
| 61 | /*******************************************************************************
|
|---|
| 62 | * Global Variables *
|
|---|
| 63 | *******************************************************************************/
|
|---|
| 64 | /** The VBoxGuest device handle. */
|
|---|
| 65 | #ifdef VBOX_VBGLR3_XFREE86
|
|---|
| 66 | static int g_File = -1;
|
|---|
| 67 | #elif defined(RT_OS_WINDOWS)
|
|---|
| 68 | static HANDLE g_hFile = INVALID_HANDLE_VALUE;
|
|---|
| 69 | #else
|
|---|
| 70 | static RTFILE g_File = NIL_RTFILE;
|
|---|
| 71 | #endif
|
|---|
| 72 | /** User counter.
|
|---|
| 73 | * A counter of the number of times the library has been initialised, for use with
|
|---|
| 74 | * X.org drivers, where the library may be shared by multiple independant modules
|
|---|
| 75 | * inside a single process space.
|
|---|
| 76 | */
|
|---|
| 77 | static uint32_t volatile g_cInits = 0;
|
|---|
| 78 |
|
|---|
| 79 |
|
|---|
| 80 | VBGLR3DECL(int) VbglR3Init(void)
|
|---|
| 81 | {
|
|---|
| 82 | uint32_t cInits = ASMAtomicIncU32(&g_cInits);
|
|---|
| 83 | #ifndef VBOX_VBGLR3_XFREE86
|
|---|
| 84 | Assert(cInits > 0);
|
|---|
| 85 | #endif
|
|---|
| 86 | if (cInits > 1)
|
|---|
| 87 | {
|
|---|
| 88 | /*
|
|---|
| 89 | * This will fail if two (or more) threads race each other calling VbglR3Init.
|
|---|
| 90 | * However it will work fine for single threaded or otherwise serialized
|
|---|
| 91 | * processed calling us more than once.
|
|---|
| 92 | */
|
|---|
| 93 | #ifdef RT_OS_WINDOWS
|
|---|
| 94 | if (g_hFile == INVALID_HANDLE_VALUE)
|
|---|
| 95 | #elif !defined (VBOX_VBGLR3_XFREE86)
|
|---|
| 96 | if (g_File == NIL_RTFILE)
|
|---|
| 97 | #else
|
|---|
| 98 | if (g_File == -1)
|
|---|
| 99 | #endif
|
|---|
| 100 | return VERR_INTERNAL_ERROR;
|
|---|
| 101 | return VINF_SUCCESS;
|
|---|
| 102 | }
|
|---|
| 103 | #if defined(RT_OS_WINDOWS)
|
|---|
| 104 | if (g_hFile != INVALID_HANDLE_VALUE)
|
|---|
| 105 | #elif !defined(VBOX_VBGLR3_XFREE86)
|
|---|
| 106 | if (g_File != NIL_RTFILE)
|
|---|
| 107 | #else
|
|---|
| 108 | if (g_File != -1)
|
|---|
| 109 | #endif
|
|---|
| 110 | return VERR_INTERNAL_ERROR;
|
|---|
| 111 |
|
|---|
| 112 | #if defined(RT_OS_WINDOWS)
|
|---|
| 113 | /*
|
|---|
| 114 | * Have to use CreateFile here as we want to specify FILE_FLAG_OVERLAPPED
|
|---|
| 115 | * and possible some other bits not availble thru iprt/file.h.
|
|---|
| 116 | */
|
|---|
| 117 | HANDLE hFile = CreateFile(VBOXGUEST_DEVICE_NAME,
|
|---|
| 118 | GENERIC_READ | GENERIC_WRITE,
|
|---|
| 119 | FILE_SHARE_READ | FILE_SHARE_WRITE,
|
|---|
| 120 | NULL,
|
|---|
| 121 | OPEN_EXISTING,
|
|---|
| 122 | FILE_ATTRIBUTE_NORMAL | FILE_FLAG_OVERLAPPED,
|
|---|
| 123 | NULL);
|
|---|
| 124 |
|
|---|
| 125 | if (hFile == INVALID_HANDLE_VALUE)
|
|---|
| 126 | return VERR_OPEN_FAILED;
|
|---|
| 127 | g_hFile = hFile;
|
|---|
| 128 |
|
|---|
| 129 | #elif defined(RT_OS_OS2)
|
|---|
| 130 | /*
|
|---|
| 131 | * We might wish to compile this with Watcom, so stick to
|
|---|
| 132 | * the OS/2 APIs all the way. And in any case we have to use
|
|---|
| 133 | * DosDevIOCtl for the requests, why not use Dos* for everything.
|
|---|
| 134 | */
|
|---|
| 135 | HFILE hf = NULLHANDLE;
|
|---|
| 136 | ULONG ulAction = 0;
|
|---|
| 137 | APIRET rc = DosOpen((PCSZ)VBOXGUEST_DEVICE_NAME, &hf, &ulAction, 0, FILE_NORMAL,
|
|---|
| 138 | OPEN_ACTION_OPEN_IF_EXISTS,
|
|---|
| 139 | OPEN_FLAGS_FAIL_ON_ERROR | OPEN_FLAGS_NOINHERIT | OPEN_SHARE_DENYNONE | OPEN_ACCESS_READWRITE,
|
|---|
| 140 | NULL);
|
|---|
| 141 | if (rc)
|
|---|
| 142 | return RTErrConvertFromOS2(rc);
|
|---|
| 143 |
|
|---|
| 144 | if (hf < 16)
|
|---|
| 145 | {
|
|---|
| 146 | HFILE ahfs[16];
|
|---|
| 147 | unsigned i;
|
|---|
| 148 | for (i = 0; i < RT_ELEMENTS(ahfs); i++)
|
|---|
| 149 | {
|
|---|
| 150 | ahfs[i] = 0xffffffff;
|
|---|
| 151 | rc = DosDupHandle(hf, &ahfs[i]);
|
|---|
| 152 | if (rc)
|
|---|
| 153 | break;
|
|---|
| 154 | }
|
|---|
| 155 |
|
|---|
| 156 | if (i-- > 1)
|
|---|
| 157 | {
|
|---|
| 158 | ULONG fulState = 0;
|
|---|
| 159 | rc = DosQueryFHState(ahfs[i], &fulState);
|
|---|
| 160 | if (!rc)
|
|---|
| 161 | {
|
|---|
| 162 | fulState |= OPEN_FLAGS_NOINHERIT;
|
|---|
| 163 | fulState &= OPEN_FLAGS_WRITE_THROUGH | OPEN_FLAGS_FAIL_ON_ERROR | OPEN_FLAGS_NO_CACHE | OPEN_FLAGS_NOINHERIT; /* Turn off non-participating bits. */
|
|---|
| 164 | rc = DosSetFHState(ahfs[i], fulState);
|
|---|
| 165 | }
|
|---|
| 166 | if (!rc)
|
|---|
| 167 | {
|
|---|
| 168 | rc = DosClose(hf);
|
|---|
| 169 | AssertMsg(!rc, ("%ld\n", rc));
|
|---|
| 170 | hf = ahfs[i];
|
|---|
| 171 | }
|
|---|
| 172 | else
|
|---|
| 173 | i++;
|
|---|
| 174 | while (i-- > 0)
|
|---|
| 175 | DosClose(ahfs[i]);
|
|---|
| 176 | }
|
|---|
| 177 | }
|
|---|
| 178 | g_File = hf;
|
|---|
| 179 |
|
|---|
| 180 | #elif defined(RT_OS_FREEBSD)
|
|---|
| 181 | /*
|
|---|
| 182 | * Try open the BSD device. The device cloning makes this a bit of work.
|
|---|
| 183 | */
|
|---|
| 184 | # if defined(VBOX_VBGLR3_XFREE86)
|
|---|
| 185 | int File = 0;
|
|---|
| 186 | # else
|
|---|
| 187 | RTFILE File = 0;
|
|---|
| 188 | # endif
|
|---|
| 189 | int rc;
|
|---|
| 190 | char szDevice[sizeof(VBOXGUEST_DEVICE_NAME) + 16];
|
|---|
| 191 | for (unsigned iUnit = 0; iUnit < 1024; iUnit++)
|
|---|
| 192 | {
|
|---|
| 193 | RTStrPrintf(szDevice, sizeof(szDevice), VBOXGUEST_DEVICE_NAME "%d", iUnit);
|
|---|
| 194 | # if defined(VBOX_VBGLR3_XFREE86)
|
|---|
| 195 | File = xf86open(szDevice, XF86_O_RDWR);
|
|---|
| 196 | if (File >= 0)
|
|---|
| 197 | break;
|
|---|
| 198 | # else
|
|---|
| 199 | rc = RTFileOpen(&File, szDevice, RTFILE_O_READWRITE | RTFILE_O_OPEN | RTFILE_O_DENY_NONE);
|
|---|
| 200 | if (RT_SUCCESS(rc))
|
|---|
| 201 | break;
|
|---|
| 202 | # endif
|
|---|
| 203 | }
|
|---|
| 204 |
|
|---|
| 205 | # if defined(VBOX_VBGLR3_XFREE86)
|
|---|
| 206 | if (File == -1)
|
|---|
| 207 | return VERR_OPEN_FAILED;
|
|---|
| 208 | # else
|
|---|
| 209 | if (RT_FAILURE(rc))
|
|---|
| 210 | return rc;
|
|---|
| 211 | # endif
|
|---|
| 212 |
|
|---|
| 213 | g_File = File;
|
|---|
| 214 |
|
|---|
| 215 | #elif defined(VBOX_VBGLR3_XFREE86) && !defined(RT_OS_FREEBSD)
|
|---|
| 216 | int File = xf86open(VBOXGUEST_DEVICE_NAME, XF86_O_RDWR);
|
|---|
| 217 | if (File == -1)
|
|---|
| 218 | return VERR_OPEN_FAILED;
|
|---|
| 219 | g_File = File;
|
|---|
| 220 |
|
|---|
| 221 | #else
|
|---|
| 222 |
|
|---|
| 223 | /* The default implemenation. (linux, solaris) */
|
|---|
| 224 | RTFILE File;
|
|---|
| 225 | int rc = RTFileOpen(&File, VBOXGUEST_DEVICE_NAME, RTFILE_O_READWRITE | RTFILE_O_OPEN | RTFILE_O_DENY_NONE);
|
|---|
| 226 | if (RT_FAILURE(rc))
|
|---|
| 227 | return rc;
|
|---|
| 228 | g_File = File;
|
|---|
| 229 |
|
|---|
| 230 | #endif
|
|---|
| 231 |
|
|---|
| 232 | /*
|
|---|
| 233 | * Create release logger
|
|---|
| 234 | */
|
|---|
| 235 | PRTLOGGER pReleaseLogger;
|
|---|
| 236 | static const char * const s_apszGroups[] = VBOX_LOGGROUP_NAMES;
|
|---|
| 237 | int rc2 = RTLogCreate(&pReleaseLogger, 0, "all", "VBOX_RELEASE_LOG",
|
|---|
| 238 | RT_ELEMENTS(s_apszGroups), &s_apszGroups[0],
|
|---|
| 239 | RTLOGDEST_USER, NULL);
|
|---|
| 240 | /* This may legitimately fail if we are using the mini-runtime. */
|
|---|
| 241 | if (RT_SUCCESS(rc2))
|
|---|
| 242 | RTLogRelSetDefaultInstance(pReleaseLogger);
|
|---|
| 243 |
|
|---|
| 244 | return VINF_SUCCESS;
|
|---|
| 245 | }
|
|---|
| 246 |
|
|---|
| 247 |
|
|---|
| 248 | VBGLR3DECL(void) VbglR3Term(void)
|
|---|
| 249 | {
|
|---|
| 250 | /*
|
|---|
| 251 | * Decrement the reference count and see if we're the last one out.
|
|---|
| 252 | */
|
|---|
| 253 | uint32_t cInits = ASMAtomicDecU32(&g_cInits);
|
|---|
| 254 | if (cInits > 0)
|
|---|
| 255 | return;
|
|---|
| 256 | #if !defined(VBOX_VBGLR3_XFREE86)
|
|---|
| 257 | AssertReturnVoid(!cInits);
|
|---|
| 258 |
|
|---|
| 259 | # if defined(RT_OS_WINDOWS)
|
|---|
| 260 | HANDLE hFile = g_hFile;
|
|---|
| 261 | g_hFile = INVALID_HANDLE_VALUE;
|
|---|
| 262 | AssertReturnVoid(hFile != INVALID_HANDLE_VALUE);
|
|---|
| 263 | BOOL fRc = CloseHandle(hFile);
|
|---|
| 264 | Assert(fRc); NOREF(fRc);
|
|---|
| 265 |
|
|---|
| 266 | # elif defined(RT_OS_OS2)
|
|---|
| 267 |
|
|---|
| 268 | RTFILE File = g_File;
|
|---|
| 269 | g_File = NIL_RTFILE;
|
|---|
| 270 | AssertReturnVoid(File != NIL_RTFILE);
|
|---|
| 271 | APIRET rc = DosClose(File);
|
|---|
| 272 | AssertMsg(!rc, ("%ld\n", rc));
|
|---|
| 273 |
|
|---|
| 274 | # else /* The IPRT case. */
|
|---|
| 275 | RTFILE File = g_File;
|
|---|
| 276 | g_File = NIL_RTFILE;
|
|---|
| 277 | AssertReturnVoid(File != NIL_RTFILE);
|
|---|
| 278 | int rc = RTFileClose(File);
|
|---|
| 279 | AssertRC(rc);
|
|---|
| 280 | # endif
|
|---|
| 281 |
|
|---|
| 282 | #else /* VBOX_VBGLR3_XFREE86 */
|
|---|
| 283 | int File = g_File;
|
|---|
| 284 | g_File = -1;
|
|---|
| 285 | if (File == -1)
|
|---|
| 286 | return;
|
|---|
| 287 | xf86close(File);
|
|---|
| 288 | #endif /* VBOX_VBGLR3_XFREE86 */
|
|---|
| 289 | }
|
|---|
| 290 |
|
|---|
| 291 |
|
|---|
| 292 | /**
|
|---|
| 293 | * Internal wrapper around various OS specific ioctl implemenations.
|
|---|
| 294 | *
|
|---|
| 295 | * @returns VBox status code as returned by VBoxGuestCommonIOCtl, or
|
|---|
| 296 | * an failure returned by the OS specific ioctl APIs.
|
|---|
| 297 | *
|
|---|
| 298 | * @param iFunction The requested function.
|
|---|
| 299 | * @param pvData The input and output data buffer.
|
|---|
| 300 | * @param cbData The size of the buffer.
|
|---|
| 301 | *
|
|---|
| 302 | * @remark Exactly how the VBoxGuestCommonIOCtl is ferried back
|
|---|
| 303 | * here is OS specific. On BSD and Darwin we can use errno,
|
|---|
| 304 | * while on OS/2 we use the 2nd buffer of the IOCtl.
|
|---|
| 305 | */
|
|---|
| 306 | int vbglR3DoIOCtl(unsigned iFunction, void *pvData, size_t cbData)
|
|---|
| 307 | {
|
|---|
| 308 | #if defined(RT_OS_WINDOWS)
|
|---|
| 309 | DWORD cbReturned = 0;
|
|---|
| 310 | if (!DeviceIoControl(g_hFile, iFunction, pvData, cbData, pvData, cbData, &cbReturned, NULL))
|
|---|
| 311 | {
|
|---|
| 312 | /** @todo The passing of error codes needs to be tested and fixed (as does *all* the other hosts except for
|
|---|
| 313 | * OS, Michael and Ramshankar!). The idea is that the VBox status codes in ring-0 should be
|
|---|
| 314 | * transfered without loss down to ring-3. However, it's not vitally important right now (obviously, since
|
|---|
| 315 | * the other guys has been ignoring it for 1+ years now). */
|
|---|
| 316 | DWORD LastErr = GetLastError();
|
|---|
| 317 | return RTErrConvertFromWin32(LastErr);
|
|---|
| 318 | }
|
|---|
| 319 |
|
|---|
| 320 | return VINF_SUCCESS;
|
|---|
| 321 |
|
|---|
| 322 | #elif defined(RT_OS_OS2)
|
|---|
| 323 | ULONG cbOS2Parm = cbData;
|
|---|
| 324 | int32_t vrc = VERR_INTERNAL_ERROR;
|
|---|
| 325 | ULONG cbOS2Data = sizeof(vrc);
|
|---|
| 326 | APIRET rc = DosDevIOCtl(g_File, VBOXGUEST_IOCTL_CATEGORY, iFunction,
|
|---|
| 327 | pvData, cbData, &cbOS2Parm,
|
|---|
| 328 | &vrc, sizeof(vrc), &cbOS2Data);
|
|---|
| 329 | if (RT_LIKELY(!rc))
|
|---|
| 330 | return vrc;
|
|---|
| 331 | return RTErrConvertFromOS2(rc);
|
|---|
| 332 |
|
|---|
| 333 | #elif defined(RT_OS_SOLARIS) || defined(RT_OS_FREEBSD)
|
|---|
| 334 | VBGLBIGREQ Hdr;
|
|---|
| 335 | Hdr.u32Magic = VBGLBIGREQ_MAGIC;
|
|---|
| 336 | Hdr.cbData = cbData;
|
|---|
| 337 | Hdr.pvDataR3 = pvData;
|
|---|
| 338 |
|
|---|
| 339 | /** @todo test status code passing! */
|
|---|
| 340 | int rc = ioctl((int)g_File, iFunction, &Hdr);
|
|---|
| 341 | if (rc == -1)
|
|---|
| 342 | {
|
|---|
| 343 | rc = errno;
|
|---|
| 344 | return RTErrConvertFromErrno(rc);
|
|---|
| 345 | }
|
|---|
| 346 | return VINF_SUCCESS;
|
|---|
| 347 |
|
|---|
| 348 | #elif defined(VBOX_VBGLR3_XFREE86)
|
|---|
| 349 | /* PORTME - This is preferred over the RTFileIOCtl variant below, just be careful with the (int). */
|
|---|
| 350 | /** @todo test status code passing! */
|
|---|
| 351 | int rc = xf86ioctl(g_File, iFunction, pvData);
|
|---|
| 352 | if (rc == -1)
|
|---|
| 353 | return VERR_FILE_IO_ERROR; /* This is purely legacy stuff, it has to work and no more. */
|
|---|
| 354 | return VINF_SUCCESS;
|
|---|
| 355 |
|
|---|
| 356 | #else
|
|---|
| 357 | /* Default implementation - PORTME: Do not use this without testings that passing errors works! */
|
|---|
| 358 | /** @todo test status code passing! */
|
|---|
| 359 | int rc2 = VERR_INTERNAL_ERROR;
|
|---|
| 360 | int rc = RTFileIoCtl(g_File, (int)iFunction, pvData, cbData, &rc2);
|
|---|
| 361 | if (RT_SUCCESS(rc))
|
|---|
| 362 | rc = rc2;
|
|---|
| 363 | return rc;
|
|---|
| 364 | #endif
|
|---|
| 365 | }
|
|---|
| 366 |
|
|---|
