VBoxGuest-freebsd.c revision e465512ca00838f2eee92814ee935296396cd2d3
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * VirtualBox Guest Additions Driver for FreeBSD.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * Copyright (C) 2007 Sun Microsystems, Inc.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * available from http://www.virtualbox.org. This file is free software;
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * you can redistribute it and/or modify it under the terms of the GNU
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * General Public License (GPL) as published by the Free Software
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
0d12c7f9423f2745f8e282523d0930f91bff03b3vboxsync * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
0d12c7f9423f2745f8e282523d0930f91bff03b3vboxsync * Clara, CA 95054 USA or visit http://www.sun.com if you need
0d12c7f9423f2745f8e282523d0930f91bff03b3vboxsync * additional information or have any questions.
0d12c7f9423f2745f8e282523d0930f91bff03b3vboxsync/** @todo r=bird: This must merge with SUPDrv-freebsd.c before long. The two
0d12c7f9423f2745f8e282523d0930f91bff03b3vboxsync * source files should only differ on prefixes and the extra bits wrt to the
0d12c7f9423f2745f8e282523d0930f91bff03b3vboxsync * pci device. I.e. it should be diffable so that fixes to one can easily be
0d12c7f9423f2745f8e282523d0930f91bff03b3vboxsync * applied to the other. */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync/** The module name. */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync /** file node minor code */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync /** Resource ID of the I/O port */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync /** Pointer to the I/O port resource. */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync /** Start address of the IO Port. */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync /** Resource ID of the MMIO area */
044af0d1e6474076366759db86f101778c5f20ccvboxsync /** Pointer to the MMIO resource. */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync /** Handle of the MMIO resource. */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync /** Size of the memory area. */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync /** Mapping of the register space */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync /** IRQ number */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync /** IRQ resource handle. */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync /** Pointer to the IRQ handler. */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync /** VMMDev version */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsyncstatic MALLOC_DEFINE(M_VBOXDEV, "vboxdev_pci", "VirtualBox Guest driver PCI");
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * Character device file handlers.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * IRQ related functions.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsyncstatic void VBoxGuestFreeBSDRemoveIRQ(device_t pDevice, void *pvState);
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsyncstatic int VBoxGuestFreeBSDAddIRQ(device_t pDevice, void *pvState);
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * Available functions for kernel drivers.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsyncDECLVBGL(int) VBoxGuestFreeBSDServiceCall(void *pvSession, unsigned uCmd, void *pvData, size_t cbData, size_t *pcbDataReturned);
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsyncDECLVBGL(void *) VBoxGuestFreeBSDServiceOpen(uint32_t *pu32Version);
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsyncDECLVBGL(int) VBoxGuestFreeBSDServiceClose(void *pvSession);
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * Device node entry points.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync/** Device extention & session data association structure. */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync/** List of cloned device. Managed by the kernel. */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync/** The dev_clone event handler tag. */
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * VBoxGuest Common ioctl wrapper from VBoxGuestLib.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * @returns VBox error code.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * @param pvSession Opaque pointer to the session.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * @param uCmd Requested function.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * @param pvData IO data buffer.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * @param cbData Size of the data buffer.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * @param pcbDataReturned Where to store the amount of returned data.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsyncDECLVBGL(int) VBoxGuestFreeBSDServiceCall(void *pvSession, unsigned uCmd, void *pvData, size_t cbData, size_t *pcbDataReturned)
044af0d1e6474076366759db86f101778c5f20ccvboxsync LogFlow((DEVICE_NAME ":VBoxGuestFreeBSDServiceCall %pvSesssion=%p uCmd=%u pvData=%p cbData=%d\n", pvSession, uCmd, pvData, cbData));
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync PVBOXGUESTSESSION pSession = (PVBOXGUESTSESSION)pvSession;
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync ("SC: %p != %p\n", pSession->pDevExt, &g_DevExt), VERR_INVALID_HANDLE);
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync return VBoxGuestCommonIOCtl(uCmd, &g_DevExt, pSession, pvData, cbData, pcbDataReturned);
2bb12e589d2c280ad042e4e70635ae7224c7eceevboxsync * FreeBSD Guest service open.
2bb12e589d2c280ad042e4e70635ae7224c7eceevboxsync * @returns Opaque pointer to session object.
2bb12e589d2c280ad042e4e70635ae7224c7eceevboxsync * @param pu32Version Where to store VMMDev version.
2bb12e589d2c280ad042e4e70635ae7224c7eceevboxsyncDECLVBGL(void *) VBoxGuestFreeBSDServiceOpen(uint32_t *pu32Version)
2bb12e589d2c280ad042e4e70635ae7224c7eceevboxsync LogFlow((DEVICE_NAME ":VBoxGuestFreeBSDServiceOpen\n"));
044af0d1e6474076366759db86f101778c5f20ccvboxsync int rc = VBoxGuestCreateKernelSession(&g_DevExt, &pSession);
044af0d1e6474076366759db86f101778c5f20ccvboxsync LogRel((DEVICE_NAME ":VBoxGuestCreateKernelSession failed. rc=%d\n", rc));
044af0d1e6474076366759db86f101778c5f20ccvboxsync * FreeBSD Guest service close.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @returns VBox error code.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * @param pvState Opaque pointer to the session object.
044af0d1e6474076366759db86f101778c5f20ccvboxsyncDECLVBGL(int) VBoxGuestFreeBSDServiceClose(void *pvSession)
044af0d1e6474076366759db86f101778c5f20ccvboxsync LogFlow((DEVICE_NAME ":VBoxGuestFreeBSDServiceClose\n"));
044af0d1e6474076366759db86f101778c5f20ccvboxsync PVBOXGUESTSESSION pSession = (PVBOXGUESTSESSION)pvSession;
044af0d1e6474076366759db86f101778c5f20ccvboxsync * DEVFS event handler.
044af0d1e6474076366759db86f101778c5f20ccvboxsyncstatic void VBoxGuestFreeBSDClone(void *pvArg, struct ucred *pCred, char *pszName, int cchName, struct cdev **ppDev)
044af0d1e6474076366759db86f101778c5f20ccvboxsync Log(("VBoxGuestFreeBSDClone: pszName=%s ppDev=%p\n", pszName, ppDev));
044af0d1e6474076366759db86f101778c5f20ccvboxsync * One device node per user, si_drv1 points to the session.
044af0d1e6474076366759db86f101778c5f20ccvboxsync * /dev/vboxguest<N> where N = {0...255}.
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync if (dev_stdclone(pszName, NULL, "vboxguest", &iUnit) != 1)
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync Log(("VBoxGuestFreeBSDClone: iUnit=%d >= 256 - rejected\n", iUnit));
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync Log(("VBoxGuestFreeBSDClone: pszName=%s iUnit=%d\n", pszName, iUnit));
044af0d1e6474076366759db86f101778c5f20ccvboxsync rc = clone_create(&g_pVBoxGuestFreeBSDClones, &g_VBoxGuestFreeBSDChrDevSW, &iUnit, ppDev, 0);
044af0d1e6474076366759db86f101778c5f20ccvboxsync Log(("VBoxGuestFreeBSDClone: clone_create -> %d; iUnit=%d\n", rc, iUnit));
044af0d1e6474076366759db86f101778c5f20ccvboxsync Log(("VBoxGuestFreeBSDClone: Created *ppDev=%p iUnit=%d si_drv1=%p si_drv2=%p\n",
044af0d1e6474076366759db86f101778c5f20ccvboxsync *ppDev, iUnit, (*ppDev)->si_drv1, (*ppDev)->si_drv2));
044af0d1e6474076366759db86f101778c5f20ccvboxsync Log(("VBoxGuestFreeBSDClone: make_dev iUnit=%d failed\n", iUnit));
044af0d1e6474076366759db86f101778c5f20ccvboxsync Log(("VBoxGuestFreeBSDClone: Existing *ppDev=%p iUnit=%d si_drv1=%p si_drv2=%p\n",
044af0d1e6474076366759db86f101778c5f20ccvboxsync *ppDev, iUnit, (*ppDev)->si_drv1, (*ppDev)->si_drv2));
044af0d1e6474076366759db86f101778c5f20ccvboxsync * File open handler
a1df400bbe9d64aad400442e56eb637019300a5evboxsyncstatic int VBoxGuestFreeBSDOpen(struct cdev *pDev, int fOpen, struct thread *pTd, struct file *pFd)
a1df400bbe9d64aad400442e56eb637019300a5evboxsyncstatic int VBoxGuestFreeBSDOpen(struct cdev *pDev, int fOpen, struct thread *pTd)
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * Try grab it (we don't grab the giant, remember).
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync if (!ASMAtomicCmpXchgPtr(&pDev->si_drv1, (void *)0x42, NULL))
a1df400bbe9d64aad400442e56eb637019300a5evboxsync * Create a new session.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync rc = VBoxGuestCreateUserSession(&g_DevExt, &pSession);
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync if (ASMAtomicCmpXchgPtr(&pDev->si_drv1, pSession, (void *)0x42))
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync Log((DEVICE_NAME ":VBoxGuestFreeBSDOpen success: g_DevExt=%p pSession=%p rc=%d pid=%d\n", &g_DevExt, pSession, rc, (int)RTProcSelf()));
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync LogRel((DEVICE_NAME ":VBoxGuestFreeBSDOpen: failed. rc=%d\n", rc));
a1df400bbe9d64aad400442e56eb637019300a5evboxsync * File close handler
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsyncstatic int VBoxGuestFreeBSDClose(struct cdev *pDev, int fFile, int DevType, struct thread *pTd)
044af0d1e6474076366759db86f101778c5f20ccvboxsync PVBOXGUESTSESSION pSession = (PVBOXGUESTSESSION)pDev->si_drv1;
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync Log(("VBoxGuestFreeBSDClose: fFile=%#x iUnit=%d pSession=%p\n", fFile, minor2unit(minor(pDev)), pSession));
044af0d1e6474076366759db86f101778c5f20ccvboxsync * Close the session if it's still hanging on to the device...
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync if (!ASMAtomicCmpXchgPtr(&pDev->si_drv1, NULL, pSession))
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync Log(("VBoxGuestFreeBSDClose: si_drv1=%p expected %p!\n", pDev->si_drv1, pSession));
044af0d1e6474076366759db86f101778c5f20ccvboxsync Log(("VBoxGuestFreeBSDClose: si_drv1=%p!\n", pSession));
044af0d1e6474076366759db86f101778c5f20ccvboxsync * IOCTL handler
044af0d1e6474076366759db86f101778c5f20ccvboxsyncstatic int VBoxGuestFreeBSDIOCtl(struct cdev *pDev, u_long ulCmd, caddr_t pvData, int fFile, struct thread *pTd)
044af0d1e6474076366759db86f101778c5f20ccvboxsync * Validate the input.
044af0d1e6474076366759db86f101778c5f20ccvboxsync PVBOXGUESTSESSION pSession = (PVBOXGUESTSESSION)pDev->si_drv1;
044af0d1e6474076366759db86f101778c5f20ccvboxsync * Validate the request wrapper.
df8e6a449f00e1884fbf4a1fc67143614d7d528dvboxsync Log((DEVICE_NAME ": VBoxGuestFreeBSDIOCtl: bad request %lu size=%lu expected=%d\n", ulCmd, IOCPARM_LEN(ulCmd), sizeof(VBGLBIGREQ)));
044af0d1e6474076366759db86f101778c5f20ccvboxsync Log((DEVICE_NAME ": VBoxGuestFreeBSDIOCtl: bad magic %#x; pArg=%p Cmd=%lu.\n", ReqWrap->u32Magic, pvData, ulCmd));
ca3da10d05961c339b5180fbd40a54587d6bad35vboxsync printf(DEVICE_NAME ": VBoxGuestFreeBSDIOCtl: bad size %#x; pArg=%p Cmd=%lu.\n", ReqWrap->cbData, pvData, ulCmd);
df8e6a449f00e1884fbf4a1fc67143614d7d528dvboxsync * Read the request.
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync Log((DEVICE_NAME ":VBoxGuestFreeBSDIOCtl: RTMemTmpAlloc failed to alloc %d bytes.\n", ReqWrap->cbData));
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync rc = copyin((void *)(uintptr_t)ReqWrap->pvDataR3, pvBuf, ReqWrap->cbData);
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync Log((DEVICE_NAME ":VBoxGuestFreeBSDIOCtl: copyin failed; pvBuf=%p pArg=%p Cmd=%lu. rc=%d\n", pvBuf, pvData, ulCmd, rc));
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync Log((DEVICE_NAME ":VBoxGuestFreeBSDIOCtl: pvBuf invalid pointer %p\n", pvBuf));
ae83ea510012552d3286d67b41abddf158ca6654vboxsync Log((DEVICE_NAME ":VBoxGuestFreeBSDIOCtl: pSession=%p pid=%d.\n", pSession, (int)RTProcSelf()));
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync * Process the IOCtl.
c0e27f622f9bd6d9e77d2d959aab71d69dabf0d3vboxsync rc = VBoxGuestCommonIOCtl(ulCmd, &g_DevExt, pSession, pvBuf, ReqWrap->cbData, &cbDataReturned);
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync Log((DEVICE_NAME ":VBoxGuestFreeBSDIOCtl: too much output data %d expected %d\n", cbDataReturned, ReqWrap->cbData));
172ae196da38208e5f1e3485715a89f2d53c6880vboxsync rc = copyout(pvBuf, (void *)(uintptr_t)ReqWrap->pvDataR3, cbDataReturned);
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsync Log((DEVICE_NAME ":VBoxGuestFreeBSDIOCtl: copyout failed; pvBuf=%p pArg=%p Cmd=%lu. rc=%d\n", pvBuf, pvData, ulCmd, rc));
72a6fe3989272cb2d409b50caca25e1edbca9398vboxsync Log((DEVICE_NAME ":VBoxGuestFreeBSDIOCtl: VBoxGuestCommonIOCtl failed. rc=%d\n", rc));
3a4a6501d0ccd629d9951b644d380c7bb2d46086vboxsyncstatic ssize_t VBoxGuestFreeBSDWrite (struct cdev *pDev, struct uio *pUio, int fIo)
RTR0Term();
int iResId = 0;
int rc = 0;
rc = bus_setup_intr(pDevice, pState->pIrqRes, INTR_TYPE_BIO, NULL, (driver_intr_t *)VBoxGuestFreeBSDISR, pState, &pState->pfnIrqHandler);
rc = bus_setup_intr(pDevice, pState->pIrqRes, INTR_TYPE_BIO, (driver_intr_t *)VBoxGuestFreeBSDISR, pState, &pState->pfnIrqHandler);
if (rc)
return VERR_DEV_IO_ERROR;
return VINF_SUCCESS;
int iResId = 0;
return ENXIO;
if (!pState)
if (!pState)
return ENOMEM;
RTR0Term();
return ENXIO;
return ENXIO;
sizeof(struct VBoxGuestDeviceState),