common/VBoxGuestLib/SysHlp.cpp

	SysHlp.cpp revision 9e278d07064bac76cd24c99cca7bef6b206211b9
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync/** @file
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync *
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync * VBoxGuestLib - A support library for VirtualBox guest additions:
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync * Physical memory heap
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync */
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync/*
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync * Copyright (C) 2006-2007 innotek GmbH
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync *
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync * available from http://www.virtualbox.org. This file is free software;
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync * you can redistribute it and/or modify it under the terms of the GNU
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync * General Public License as published by the Free Software Foundation,
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync * in version 2 as it comes in the "COPYING" file of the VirtualBox OSE
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync * distribution. VirtualBox OSE is distributed in the hope that it will
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync * be useful, but WITHOUT ANY WARRANTY of any kind.
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync *
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync * If you received this file as part of a commercial VirtualBox
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync * distribution, then only the terms of your commercial VirtualBox
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync * license agreement apply instead of the previous paragraph.
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync */
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync#define LOG_GROUP LOG_GROUP_HGCM
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync#include <VBox/log.h>
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync#include <VBox/VBoxGuestLib.h>
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync#include "SysHlp.h"
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync#include <iprt/assert.h>
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync#if !defined(__WIN__) && !defined(__LINUX__)
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync#include <iprt/memobj.h>
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync#endif
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsyncint vbglLockLinear (void **ppvCtx, void *pv, uint32_t u32Size, bool fWriteAccess)
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync{
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync    int rc = VINF_SUCCESS;
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync#ifdef __WIN__
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync    PMDL pMdl = IoAllocateMdl (pv, u32Size, FALSE, FALSE, NULL);
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync    if (pMdl == NULL)
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync    {
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync        rc = VERR_NOT_SUPPORTED;
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync    }
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync    else
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync    {
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync        __try {
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync            /* Calls to MmProbeAndLockPages must be enclosed in a try/except block. */
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync            MmProbeAndLockPages (pMdl,
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync                                 KernelMode,
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync                                 (fWriteAccess) ? IoModifyAccess : IoReadAccess);
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync            *ppvCtx = pMdl;
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync        } __except(EXCEPTION_EXECUTE_HANDLER) {
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync            IoFreeMdl (pMdl);
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync            rc = VERR_INVALID_PARAMETER;
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync        }
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync    }
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync#elif defined(__LINUX__)
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync    NOREF(ppvCtx);
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync    NOREF(pv);
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync    NOREF(u32Size);
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync#else
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync    /* Default to IPRT - this ASSUMES that it is USER addresses we're locking. */
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync    RTR0MEMOBJ MemObj;
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync    rc = RTR0MemObjLockUser(&MemObj, pv, u32Size, NIL_RTR0PROCESS);
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync    if (RT_SUCCESS(rc))
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync        *ppvCtx = MemObj;
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync    else
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync        *ppvCtx = NIL_RTR0MEMOBJ;
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync#endif
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync    return rc;
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync}
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsyncvoid vbglUnlockLinear (void *pvCtx, void *pv, uint32_t u32Size)
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync{
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync    NOREF(pv);
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync    NOREF(u32Size);
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync#ifdef __WIN__
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync    PMDL pMdl = (PMDL)pvCtx;
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync    if (pMdl != NULL)
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync    {
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync        MmUnlockPages (pMdl);
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync        IoFreeMdl (pMdl);
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync    }
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync#elif defined(__LINUX__)
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync    NOREF(pvCtx);
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync#else
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync    /* default to IPRT */
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync    RTR0MEMOBJ MemObj = (RTR0MEMOBJ)pvCtx;
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync    int rc = RTR0MemObjFree(MemObj, false);
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync    AssertRC(rc);
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync#endif
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync}
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync#ifndef VBGL_VBOXGUEST
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync#if defined (__LINUX__) && !defined (__KERNEL__)
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync# include <unistd.h>
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync# include <errno.h>
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync# include <sys/fcntl.h>
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync# include <sys/ioctl.h>
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync#endif
a3f3701cea1ba388e7c877955252bb7375eedebdvboxsync
#ifdef __LINUX__
__BEGIN_DECLS
extern DECLVBGL(void *) vboxadd_cmc_open (void);
extern DECLVBGL(void) vboxadd_cmc_close (void *);
extern DECLVBGL(int) vboxadd_cmc_call (void *opaque, uint32_t func, void *data);
__END_DECLS
#endif /* __LINUX__ */

#ifdef __OS2__
__BEGIN_DECLS
/*
 * On OS/2 we'll do the connecting in the assembly code of the
 * client driver, exporting a g_VBoxGuestIDC symbol containing
 * the connection information obtained from the 16-bit IDC.
 */
extern VBOXGUESTOS2IDCCONNECT g_VBoxGuestIDC;
__END_DECLS
#endif


int vbglDriverOpen (VBGLDRIVER *pDriver)
{
#ifdef __WIN__
    UNICODE_STRING uszDeviceName;
    RtlInitUnicodeString (&uszDeviceName, L"\\Device\\VBoxGuest");

    PDEVICE_OBJECT pDeviceObject = NULL;
    PFILE_OBJECT pFileObject = NULL;

    NTSTATUS rc = IoGetDeviceObjectPointer (&uszDeviceName, FILE_ALL_ACCESS,
                                            &pFileObject, &pDeviceObject);

    if (NT_SUCCESS (rc))
    {
        Log(("vbglDriverOpen VBoxGuest successful pDeviceObject=%x\n", pDeviceObject));
        pDriver->pDeviceObject = pDeviceObject;
        pDriver->pFileObject = pFileObject;
        return VINF_SUCCESS;
    }
    /** @todo return RTErrConvertFromNtStatus(rc)! */
    Log(("vbglDriverOpen VBoxGuest failed with ntstatus=%x\n", rc));
    return rc;

#elif defined (__LINUX__)
    void *opaque;

    opaque = (void *) vboxadd_cmc_open ();
    if (!opaque)
    {
        return VERR_NOT_IMPLEMENTED;
    }
    pDriver->opaque = opaque;
    return VINF_SUCCESS;

#elif defined (__OS2__)
    /*
     * Just check whether the connection was made or not.
     */
    if (    g_VBoxGuestIDC.u32Version == VMMDEV_VERSION
        &&  VALID_PTR(g_VBoxGuestIDC.u32Session)
        &&  VALID_PTR(g_VBoxGuestIDC.pfnServiceEP))
    {
        pDriver->u32Session = g_VBoxGuestIDC.u32Session;
        return VINF_SUCCESS;
    }
    pDriver->u32Session = UINT32_MAX;
    Log(("vbglDriverOpen: failed\n"));
    return VERR_FILE_NOT_FOUND;

#else
# error "Port me"
#endif
}

int vbglDriverIOCtl (VBGLDRIVER *pDriver, uint32_t u32Function, void *pvData, uint32_t cbData)
{
#ifdef __WIN__
    IO_STATUS_BLOCK ioStatusBlock;

    KEVENT Event;
    KeInitializeEvent (&Event, NotificationEvent, FALSE);

    PIRP irp = IoBuildDeviceIoControlRequest (u32Function,
                                              pDriver->pDeviceObject,
                                              pvData,
                                              cbData,
                                              pvData,
                                              cbData,
                                              FALSE, /* external */
                                              &Event,
                                              &ioStatusBlock);
    if (irp == NULL)
    {
        Log(("vbglDriverIOCtl: IoBuildDeviceIoControlRequest failed\n"));
        return VERR_NO_MEMORY;
    }

    NTSTATUS rc = IoCallDriver (pDriver->pDeviceObject, irp);

    if (rc == STATUS_PENDING)
    {
        Log(("vbglDriverIOCtl: STATUS_PENDING\n"));
        rc = KeWaitForSingleObject(&Event,
                                   Executive,
                                   KernelMode,
                                   FALSE,
                                   NULL);

        rc = ioStatusBlock.Status;
    }

    if (!NT_SUCCESS(rc))
        Log(("vbglDriverIOCtl: IoCallDriver failed with ntstatus=%x\n", rc));

    return NT_SUCCESS(rc)? VINF_SUCCESS: VERR_VBGL_IOCTL_FAILED;

#elif defined (__LINUX__)
    return vboxadd_cmc_call (pDriver->opaque, u32Function, pvData);

#elif defined (__OS2__)
    if (    pDriver->u32Session
        &&  pDriver->u32Session == g_VBoxGuestIDC.u32Session)
        return g_VBoxGuestIDC.pfnServiceEP(pDriver->u32Session, u32Function, pvData, cbData, NULL);

    Log(("vbglDriverIOCtl: No connection\n"));
    return VERR_WRONG_ORDER;

#else
# error "Port me"
#endif
}

void vbglDriverClose (VBGLDRIVER *pDriver)
{
#ifdef __WIN__
    Log(("vbglDriverClose pDeviceObject=%x\n", pDriver->pDeviceObject));
    ObDereferenceObject (pDriver->pFileObject);

#elif defined (__LINUX__)
    vboxadd_cmc_close (pDriver->opaque);

#elif defined (__OS2__)
    pDriver->u32Session = 0;

#else
# error "Port me"
#endif
}

#endif /* !VBGL_VBOXGUEST */