Support/freebsd/SUPDrv-freebsd.c

	SUPDrv-freebsd.c revision fbce7e4e7123ca200586ee9257a12d663e928841
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync/* $Id$ */
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync/** @file
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync * VBoxDrv - FreeBSD specifics.
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync */
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync/*
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync * Copyright (c) 2007 knut st. osmundsen <bird-src-spam@anduin.net>
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync *
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync * Permission is hereby granted, free of charge, to any person
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync * obtaining a copy of this software and associated documentation
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync * files (the "Software"), to deal in the Software without
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync * restriction, including without limitation the rights to use,
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync * copy, modify, merge, publish, distribute, sublicense, and/or sell
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync * copies of the Software, and to permit persons to whom the
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync * Software is furnished to do so, subject to the following
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync * conditions:
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync *
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync * The above copyright notice and this permission notice shall be
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync * included in all copies or substantial portions of the Software.
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync *
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync * OTHER DEALINGS IN THE SOFTWARE.
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync */
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync/*******************************************************************************
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync*   Header Files                                                               *
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync*******************************************************************************/
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync/* Deal with conflicts first. */
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync#include <sys/param.h>
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync#undef PVM
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync#include <sys/types.h>
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync#include <sys/module.h>
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync#include <sys/systm.h>
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync#include <sys/errno.h>
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync#include <sys/kernel.h>
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync#include <sys/conf.h>
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync#include <sys/uio.h>
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync#include "SUPDRV.h"
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync#include <VBox/version.h>
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync#include <iprt/initterm.h>
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync#include <iprt/string.h>
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync#include <iprt/spinlock.h>
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync#include <iprt/process.h>
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync#include <iprt/assert.h>
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync#include <iprt/log.h>
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync/*******************************************************************************
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync*   Internal Functions                                                         *
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync*******************************************************************************/
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsyncstatic int VBoxDrvFreeBSDModuleEvent(struct module *pMod, int enmEventType, void *pvArg);
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsyncstatic int VBoxDrvFreeBSDLoad(void);
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsyncstatic int VBoxDrvFreeBSDUnload(void);
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsyncstatic d_fdopen_t   VBoxDrvFreeBSDOpen;
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsyncstatic d_close_t    VBoxDrvFreeBSDClose;
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsyncstatic d_ioctl_t    VBoxDrvFreeBSDIOCtl;
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsyncstatic int VBoxDrvFreeBsdErr2Native(int rc);
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync/*******************************************************************************
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync*   Global Variables                                                           *
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync*******************************************************************************/
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync/**
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync * Module info structure used by the kernel.
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync */
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsyncstatic moduledata_t g_VBoxDrvFreeBSDModule =
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync{
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync    "vboxdrv",
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync    VBoxDrvFreeBSDModuleEvent,
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync    NULL
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync};
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync/** Declare the module as a pseudo device. */
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsyncDECLARE_MODULE(vboxdrv, g_VBoxDrvFreeBSDModule, SI_SUB_PSEUDO, SI_ORDER_ANY);
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync/**
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync * The /dev/vboxdrv character device entry points.
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync */
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsyncstatic struct cdevsw        g_VBoxDrvFreeBSDChrDevSW =
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync{
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync    .d_version =        D_VERSION,
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync    .d_flags =          D_TRACKCLOSE,
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync    .d_fdopen =         VBoxDrvFreeBSDOpen,
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync    .d_close =          VBoxDrvFreeBSDClose,
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync    .d_ioctl =          VBoxDrvFreeBSDIOCtl,
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync    .d_name =           "vboxdrv"
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync};
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync/** The make_dev result. */
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsyncstatic struct cdev         *g_pVBoxDrvFreeBSDChrDev;
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync/** The device extention. */
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsyncstatic SUPDRVDEVEXT         g_DevExt;
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync/** Spinlock protecting g_apSessionHashTab. */
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsyncstatic RTSPINLOCK           g_Spinlock = NIL_RTSPINLOCK;
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync/** Hash table */
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsyncstatic PSUPDRVSESSION       g_apSessionHashTab[19];
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync/** Calculates the index into g_apSessionHashTab.*/
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync#define SESSION_HASH(sfn)   ((sfn) % RT_ELEMENTS(g_apSessionHashTab))
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync/**
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync * Module event handler.
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync *
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync * @param   pMod            The module structure.
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync * @param   enmEventType    The event type (modeventtype_t).
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync * @param   pvArg           Module argument. NULL.
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync *
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync * @return  0 on success, errno.h status code on failure.
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync */
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsyncstatic int VBoxDrvFreeBSDModuleEvent(struct module *pMod, int enmEventType, void *pvArg)
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync{
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync    int rc;
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync    switch (enmEventType)
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync    {
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync        case MOD_LOAD:
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync            rc = VBoxDrvFreeBSDLoad();
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync            break;
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync        case MOD_UNLOAD:
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync            rc = VBoxDrvFreeBSDUnload();
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync            break;
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync        case MOD_SHUTDOWN:
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync        case MOD_QUIESCE:
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync        default:
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync            return EOPNOTSUPP;
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync    }
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync    if (RT_SUCCESS(rc))
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync        return 0;
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync    return VBoxDrvFreeBsdErr2Native(rc);
1f1986470af9f0bb750dd859b142dc2e952deb20vboxsync}


static int VBoxDrvFreeBSDLoad(void)
{
    dprintf(("VBoxDrvFreeBSDLoad:\n"));

    /*
     * Initialize the runtime.
     */
    int rc = RTR0Init(0);
    if (RT_SUCCESS(rc))
    {
        /*
         * Initialize the device extension.
         */
        rc = supdrvInitDevExt(&g_DevExt);
        if (RT_SUCCESS(rc))
        {
            /*
             * Initialize the session hash table.
             */
            rc = RTSpinlockCreate(&g_Spinlock);
            if (RT_SUCCESS(rc))
            {
                /*
                 * Create our device node.
                 */
                /** @todo find a way to fix this 0666 permission issue. Perhaps by defining some vboxusers group with a fixed gid? */
                g_pVBoxDrvFreeBSDChrDev = make_dev(&g_VBoxDrvFreeBSDChrDevSW,
                                                   0,
                                                   UID_ROOT,
                                                   GID_WHEEL,
                                                   0666,
                                                   "vboxdrv");
                if (g_pVBoxDrvFreeBSDChrDev)
                {
                    dprintf(("VBoxDrvFreeBSDLoad: returns successfully\n"));
                    return VINF_SUCCESS;
                }

                printf("vboxdrv: make_dev failed\n");
                rc = SUPDRV_ERR_ALREADY_LOADED;
                RTSpinlockDestroy(g_Spinlock);
                g_Spinlock = NIL_RTSPINLOCK;
            }
            else
                printf("vboxdrv: RTSpinlockCreate failed, rc=%d\n", rc);
            supdrvDeleteDevExt(&g_DevExt);
        }
        else
            printf("vboxdrv: supdrvInitDevExt failed, rc=%d\n", rc);
        RTR0Term();
    }
    else
        printf("vboxdrv: RTR0Init failed, rc=%d\n", rc);
    return rc;
}

static int VBoxDrvFreeBSDUnload(void)
{
    int rc;
    dprintf(("VBoxDrvFreeBSDUnload:\n"));

    /** @todo verify that FreeBSD does reference counting. */

    /*
     * Reserve what we did in VBoxDrvFreeBSDInit.
     */
    if (g_pVBoxDrvFreeBSDChrDev)
    {
        destroy_dev(g_pVBoxDrvFreeBSDChrDev);
        g_pVBoxDrvFreeBSDChrDev = NULL;
    }

    supdrvDeleteDevExt(&g_DevExt);

    rc = RTSpinlockDestroy(g_Spinlock);
    AssertRC(rc);
    g_Spinlock = NIL_RTSPINLOCK;

    RTR0Term();

    memset(&g_DevExt, 0, sizeof(g_DevExt));

    dprintf(("VBoxDrvFreeBSDUnload: returns\n"));
    return VINF_SUCCESS;
}


static int VBoxDrvFreeBSDOpen(struct cdev *dev, int oflags, struct thread *td, int fdidx)
{
    dprintf(("VBoxDrvFreeBSDOpen:\n"));
    return EOPNOTSUPP;
}


static int VBoxDrvFreeBSDClose(struct cdev *dev, int fflag, int devtype, struct thread *td)
{
    dprintf(("VBoxDrvFreeBSDClose:\n"));
    return EBADF;
}


static int VBoxDrvFreeBSDIOCtl(struct cdev *dev, u_long cmd, caddr_t data, int fflag, struct thread *td)
{
    dprintf(("VBoxDrvFreeBSDIOCtl:\n"));
    return EINVAL;
}


/**
 * Converts an supdrv error code to a FreeBSD error code.
 *
 * @returns corresponding FreeBSD error code.
 * @param   rc  supdrv error code (SUPDRV_ERR_* defines).
 */
static int VBoxDrvFreeBsdErr2Native(int rc)
{
    switch (rc)
    {
        case 0:                             return 0;
        case SUPDRV_ERR_GENERAL_FAILURE:    return EACCES;
        case SUPDRV_ERR_INVALID_PARAM:      return EINVAL;
        case SUPDRV_ERR_INVALID_MAGIC:      return EILSEQ;
        case SUPDRV_ERR_INVALID_HANDLE:     return ENXIO;
        case SUPDRV_ERR_INVALID_POINTER:    return EFAULT;
        case SUPDRV_ERR_LOCK_FAILED:        return ENOLCK;
        case SUPDRV_ERR_ALREADY_LOADED:     return EEXIST;
        case SUPDRV_ERR_PERMISSION_DENIED:  return EPERM;
        case SUPDRV_ERR_VERSION_MISMATCH:   return ENOSYS;
    }

    return EPERM;
}


void VBOXCALL   supdrvOSObjInitCreator(PSUPDRVOBJ pObj, PSUPDRVSESSION pSession)
{
    NOREF(pObj);
    NOREF(pSession);
}


bool VBOXCALL   supdrvOSObjCanAccess(PSUPDRVOBJ pObj, PSUPDRVSESSION pSession, const char *pszObjName, int *prc)
{
    NOREF(pObj);
    NOREF(pSession);
    NOREF(pszObjName);
    NOREF(prc);
    return false;
}


SUPR0DECL(int) SUPR0Printf(const char *pszFormat, ...)
{
    va_list va;
    char szMsg[256];
    int cch;

    va_start(va, pszFormat);
    cch = RTStrPrintfV(szMsg, sizeof(szMsg), pszFormat, va);
    va_end(va);

    printf("%s", szMsg);

    return cch;
}