DrvVD.cpp revision a9f41cb889f53e8407561a6155052c441eb0fc5f
af062818b47340eef15700d2f0211576ba3506eevboxsync * DrvVD - Generic VBox disk media driver.
af062818b47340eef15700d2f0211576ba3506eevboxsync * Copyright (C) 2006-2010 Sun Microsystems, Inc.
af062818b47340eef15700d2f0211576ba3506eevboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
af062818b47340eef15700d2f0211576ba3506eevboxsync * available from http://www.virtualbox.org. This file is free software;
af062818b47340eef15700d2f0211576ba3506eevboxsync * you can redistribute it and/or modify it under the terms of the GNU
af062818b47340eef15700d2f0211576ba3506eevboxsync * General Public License (GPL) as published by the Free Software
af062818b47340eef15700d2f0211576ba3506eevboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
af062818b47340eef15700d2f0211576ba3506eevboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
af062818b47340eef15700d2f0211576ba3506eevboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
af062818b47340eef15700d2f0211576ba3506eevboxsync * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
af062818b47340eef15700d2f0211576ba3506eevboxsync * Clara, CA 95054 USA or visit http://www.sun.com if you need
b955672b950093ff7416d1269dd4d3b69983bd8fvboxsync * additional information or have any questions.
b955672b950093ff7416d1269dd4d3b69983bd8fvboxsync/*******************************************************************************
b955672b950093ff7416d1269dd4d3b69983bd8fvboxsync* Header files *
b955672b950093ff7416d1269dd4d3b69983bd8fvboxsync*******************************************************************************/
af062818b47340eef15700d2f0211576ba3506eevboxsync/* All lwip header files are not C++ safe. So hack around this. */
af062818b47340eef15700d2f0211576ba3506eevboxsync#endif /* VBOX_WITH_INIP */
af062818b47340eef15700d2f0211576ba3506eevboxsync/* Small hack to get at lwIP initialized status */
af062818b47340eef15700d2f0211576ba3506eevboxsyncextern bool DevINIPConfigured(void);
af062818b47340eef15700d2f0211576ba3506eevboxsync#endif /* VBOX_WITH_INIP */
af062818b47340eef15700d2f0211576ba3506eevboxsync/*******************************************************************************
af062818b47340eef15700d2f0211576ba3506eevboxsync* Defined types, constants and macros *
af062818b47340eef15700d2f0211576ba3506eevboxsync*******************************************************************************/
af062818b47340eef15700d2f0211576ba3506eevboxsync/** Converts a pointer to VBOXDISK::IMedia to a PVBOXDISK. */
af062818b47340eef15700d2f0211576ba3506eevboxsync ( (PVBOXDISK)((uintptr_t)pInterface - RT_OFFSETOF(VBOXDISK, IMedia)) )
af062818b47340eef15700d2f0211576ba3506eevboxsync/** Converts a pointer to PDMDRVINS::IBase to a PPDMDRVINS. */
af062818b47340eef15700d2f0211576ba3506eevboxsync ( (PPDMDRVINS)((uintptr_t)pInterface - RT_OFFSETOF(PDMDRVINS, IBase)) )
af062818b47340eef15700d2f0211576ba3506eevboxsync/** Converts a pointer to PDMDRVINS::IBase to a PVBOXDISK. */
af062818b47340eef15700d2f0211576ba3506eevboxsync ( PDMINS_2_DATA(PDMIBASE_2_DRVINS(pInterface), PVBOXDISK) )
af062818b47340eef15700d2f0211576ba3506eevboxsync/** Converts a pointer to VBOXDISK::IMediaAsync to a PVBOXDISK. */
af062818b47340eef15700d2f0211576ba3506eevboxsync ( (PVBOXDISK)((uintptr_t)pInterface - RT_OFFSETOF(VBOXDISK, IMediaAsync)) )
af062818b47340eef15700d2f0211576ba3506eevboxsync * VBox disk container, image information, private part.
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef struct VBOXIMAGE
af062818b47340eef15700d2f0211576ba3506eevboxsync /** Pointer to next image. */
af062818b47340eef15700d2f0211576ba3506eevboxsync /** Pointer to list of VD interfaces. Per-image. */
af062818b47340eef15700d2f0211576ba3506eevboxsync /** Common structure for the configuration information interface. */
af062818b47340eef15700d2f0211576ba3506eevboxsync * Storage backend data.
af062818b47340eef15700d2f0211576ba3506eevboxsync /** PDM async completion end point. */
af062818b47340eef15700d2f0211576ba3506eevboxsync /** The template. */
af062818b47340eef15700d2f0211576ba3506eevboxsync /** Event semaphore for synchronous operations. */
af062818b47340eef15700d2f0211576ba3506eevboxsync /** Flag whether a synchronous operation is currently pending. */
af062818b47340eef15700d2f0211576ba3506eevboxsync volatile bool fSyncIoPending;
af062818b47340eef15700d2f0211576ba3506eevboxsync /** Return code of the last completed request. */
af062818b47340eef15700d2f0211576ba3506eevboxsync /** Callback routine */
af062818b47340eef15700d2f0211576ba3506eevboxsync /** Pointer to the optional thread synchronization interface of the disk. */
af062818b47340eef15700d2f0211576ba3506eevboxsync /** Pointer to the optional thread synchronization callbacks of the disk. */
af062818b47340eef15700d2f0211576ba3506eevboxsync PVDINTERFACETHREADSYNC pInterfaceThreadSyncCallbacks;
af062818b47340eef15700d2f0211576ba3506eevboxsync * VBox disk container media main structure, private part.
af062818b47340eef15700d2f0211576ba3506eevboxsync * @implements PDMIMEDIA
af062818b47340eef15700d2f0211576ba3506eevboxsync * @implements PDMIMEDIAASYNC
af062818b47340eef15700d2f0211576ba3506eevboxsync * @implements VDINTERFACEERROR
af062818b47340eef15700d2f0211576ba3506eevboxsync * @implements VDINTERFACETCPNET
af062818b47340eef15700d2f0211576ba3506eevboxsync * @implements VDINTERFACEASYNCIO
af062818b47340eef15700d2f0211576ba3506eevboxsync * @implements VDINTERFACECONFIG
af062818b47340eef15700d2f0211576ba3506eevboxsynctypedef struct VBOXDISK
af062818b47340eef15700d2f0211576ba3506eevboxsync /** The VBox disk container. */
af062818b47340eef15700d2f0211576ba3506eevboxsync /** The media interface. */
af062818b47340eef15700d2f0211576ba3506eevboxsync /** Pointer to the driver instance. */
af062818b47340eef15700d2f0211576ba3506eevboxsync /** Flag whether suspend has changed image open mode to read only. */
af062818b47340eef15700d2f0211576ba3506eevboxsync /** Flag whether to use the runtime (true) or startup error facility. */
af062818b47340eef15700d2f0211576ba3506eevboxsync /** Pointer to list of VD interfaces. Per-disk. */
af062818b47340eef15700d2f0211576ba3506eevboxsync /** Common structure for the supported error interface. */
af062818b47340eef15700d2f0211576ba3506eevboxsync /** Callback table for error interface. */
af062818b47340eef15700d2f0211576ba3506eevboxsync /** Common structure for the supported TCP network stack interface. */
af062818b47340eef15700d2f0211576ba3506eevboxsync /** Callback table for TCP network stack interface. */
af062818b47340eef15700d2f0211576ba3506eevboxsync /** Common structure for the supported async I/O interface. */
af062818b47340eef15700d2f0211576ba3506eevboxsync /** Callback table for async I/O interface. */
af062818b47340eef15700d2f0211576ba3506eevboxsync /** Common structure for the supported thread synchronization interface. */
af062818b47340eef15700d2f0211576ba3506eevboxsync /** Callback table for thread synchronization interface. */
af062818b47340eef15700d2f0211576ba3506eevboxsync /** Callback table for the configuration information interface. */
af062818b47340eef15700d2f0211576ba3506eevboxsync /** Flag whether opened disk suppports async I/O operations. */
af062818b47340eef15700d2f0211576ba3506eevboxsync /** The async media interface. */
af062818b47340eef15700d2f0211576ba3506eevboxsync /** The async media port interface above. */
af062818b47340eef15700d2f0211576ba3506eevboxsync /** Pointer to the list of data we need to keep per image. */
af062818b47340eef15700d2f0211576ba3506eevboxsync /** Flag whether a merge operation has been set up. */
af062818b47340eef15700d2f0211576ba3506eevboxsync /** Synchronization to prevent destruction before merge finishes. */
af062818b47340eef15700d2f0211576ba3506eevboxsync /** Synchronization between merge and other image accesses. */
af062818b47340eef15700d2f0211576ba3506eevboxsync /** Source image index for merging. */
af062818b47340eef15700d2f0211576ba3506eevboxsync /** Target image index for merging. */
af062818b47340eef15700d2f0211576ba3506eevboxsync/*******************************************************************************
af062818b47340eef15700d2f0211576ba3506eevboxsync* Internal Functions *
af062818b47340eef15700d2f0211576ba3506eevboxsync*******************************************************************************/
af062818b47340eef15700d2f0211576ba3506eevboxsync * Internal: allocate new image descriptor and put it in the list
af062818b47340eef15700d2f0211576ba3506eevboxsync PVBOXIMAGE pImage = (PVBOXIMAGE)RTMemAllocZ(sizeof(VBOXIMAGE));
af062818b47340eef15700d2f0211576ba3506eevboxsync * Internal: free the list of images descriptors.
af062818b47340eef15700d2f0211576ba3506eevboxsync * Make the image temporarily read-only.
af062818b47340eef15700d2f0211576ba3506eevboxsync * @returns VBox status code.
af062818b47340eef15700d2f0211576ba3506eevboxsync * @param pThis The driver instance data.
af062818b47340eef15700d2f0211576ba3506eevboxsync rc = VDGetOpenFlags(pThis->pDisk, VD_LAST_IMAGE, &uOpenFlags);
af062818b47340eef15700d2f0211576ba3506eevboxsync rc = VDSetOpenFlags(pThis->pDisk, VD_LAST_IMAGE, uOpenFlags);
af062818b47340eef15700d2f0211576ba3506eevboxsync * Undo the temporary read-only status of the image.
af062818b47340eef15700d2f0211576ba3506eevboxsync * @returns VBox status code.
af062818b47340eef15700d2f0211576ba3506eevboxsync * @param pThis The driver instance data.
af062818b47340eef15700d2f0211576ba3506eevboxsync rc = VDGetOpenFlags(pThis->pDisk, VD_LAST_IMAGE, &uOpenFlags);
af062818b47340eef15700d2f0211576ba3506eevboxsync rc = VDSetOpenFlags(pThis->pDisk, VD_LAST_IMAGE, uOpenFlags);
af062818b47340eef15700d2f0211576ba3506eevboxsync/*******************************************************************************
af062818b47340eef15700d2f0211576ba3506eevboxsync* Error reporting callback *
af062818b47340eef15700d2f0211576ba3506eevboxsync*******************************************************************************/
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic void drvvdErrorCallback(void *pvUser, int rc, RT_SRC_POS_DECL,
af062818b47340eef15700d2f0211576ba3506eevboxsync PVBOXDISK pThis = PDMINS_2_DATA(pDrvIns, PVBOXDISK);
af062818b47340eef15700d2f0211576ba3506eevboxsync /* We must not pass VMSETRTERR_FLAGS_FATAL as it could lead to a
af062818b47340eef15700d2f0211576ba3506eevboxsync * deadlock: We are probably executed in a thread context != EMT
af062818b47340eef15700d2f0211576ba3506eevboxsync * and the EM thread would wait until every thread is suspended
af062818b47340eef15700d2f0211576ba3506eevboxsync * but we would wait for the EM thread ... */
af062818b47340eef15700d2f0211576ba3506eevboxsync PDMDrvHlpVMSetRuntimeErrorV(pDrvIns, /* fFlags=*/ 0, "DrvVD", pszFormat, va);
af062818b47340eef15700d2f0211576ba3506eevboxsync PDMDrvHlpVMSetErrorV(pDrvIns, rc, RT_SRC_POS_ARGS, pszFormat, va);
af062818b47340eef15700d2f0211576ba3506eevboxsync/*******************************************************************************
af062818b47340eef15700d2f0211576ba3506eevboxsync* VD Async I/O interface implementation *
af062818b47340eef15700d2f0211576ba3506eevboxsync*******************************************************************************/
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(void) drvvdAsyncTaskCompleted(PPDMDRVINS pDrvIns, void *pvTemplateUser, void *pvUser, int rcReq)
af062818b47340eef15700d2f0211576ba3506eevboxsync PVBOXDISK pThis = PDMINS_2_DATA(pDrvIns, PVBOXDISK);
af062818b47340eef15700d2f0211576ba3506eevboxsync PDRVVDSTORAGEBACKEND pStorageBackend = (PDRVVDSTORAGEBACKEND)pvTemplateUser;
af062818b47340eef15700d2f0211576ba3506eevboxsync /* If thread synchronization is active, then signal the end of the
af062818b47340eef15700d2f0211576ba3506eevboxsync * this disk read/write operation. */
af062818b47340eef15700d2f0211576ba3506eevboxsync /** @todo provide a way to determine the type of task (read/write)
af062818b47340eef15700d2f0211576ba3506eevboxsync * which was completed, see also VBoxHDD.cpp. */
af062818b47340eef15700d2f0211576ba3506eevboxsync if (RT_UNLIKELY(pStorageBackend->pInterfaceThreadSyncCallbacks))
af062818b47340eef15700d2f0211576ba3506eevboxsync int rc2 = pStorageBackend->pInterfaceThreadSyncCallbacks->pfnFinishWrite(pStorageBackend->pInterfaceThreadSync->pvUser);
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(int) drvvdAsyncIOOpen(void *pvUser, const char *pszLocation,
af062818b47340eef15700d2f0211576ba3506eevboxsync PDRVVDSTORAGEBACKEND pStorageBackend = (PDRVVDSTORAGEBACKEND)RTMemAllocZ(sizeof(DRVVDSTORAGEBACKEND));
af062818b47340eef15700d2f0211576ba3506eevboxsync pStorageBackend->pInterfaceThreadSyncCallbacks = NULL;
af062818b47340eef15700d2f0211576ba3506eevboxsync pStorageBackend->pInterfaceThreadSync = VDInterfaceGet(pVDIfsDisk, VDINTERFACETYPE_THREADSYNC);
af062818b47340eef15700d2f0211576ba3506eevboxsync if (RT_UNLIKELY(pStorageBackend->pInterfaceThreadSync))
af062818b47340eef15700d2f0211576ba3506eevboxsync pStorageBackend->pInterfaceThreadSyncCallbacks = VDGetInterfaceThreadSync(pStorageBackend->pInterfaceThreadSync);
af062818b47340eef15700d2f0211576ba3506eevboxsync rc = PDMDrvHlpPDMAsyncCompletionTemplateCreate(pThis->pDrvIns, &pStorageBackend->pTemplate,
af062818b47340eef15700d2f0211576ba3506eevboxsync drvvdAsyncTaskCompleted, pStorageBackend, "AsyncTaskCompleted");
af062818b47340eef15700d2f0211576ba3506eevboxsync rc = PDMR3AsyncCompletionEpCreateForFile(&pStorageBackend->pEndpoint, pszLocation,
af062818b47340eef15700d2f0211576ba3506eevboxsync uOpenFlags & VD_INTERFACEASYNCIO_OPEN_FLAGS_READONLY
af062818b47340eef15700d2f0211576ba3506eevboxsync ? PDMACEP_FILE_FLAGS_READ_ONLY | PDMACEP_FILE_FLAGS_CACHING
af062818b47340eef15700d2f0211576ba3506eevboxsync PDMR3AsyncCompletionTemplateDestroy(pStorageBackend->pTemplate);
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(int) drvvdAsyncIOClose(void *pvUser, void *pStorage)
af062818b47340eef15700d2f0211576ba3506eevboxsync PDRVVDSTORAGEBACKEND pStorageBackend = (PDRVVDSTORAGEBACKEND)pStorage;
af062818b47340eef15700d2f0211576ba3506eevboxsync PDMR3AsyncCompletionEpClose(pStorageBackend->pEndpoint);
af062818b47340eef15700d2f0211576ba3506eevboxsync PDMR3AsyncCompletionTemplateDestroy(pStorageBackend->pTemplate);
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(int) drvvdAsyncIOReadSync(void *pvUser, void *pStorage, uint64_t uOffset,
af062818b47340eef15700d2f0211576ba3506eevboxsync PDRVVDSTORAGEBACKEND pStorageBackend = (PDRVVDSTORAGEBACKEND)pStorage;
af062818b47340eef15700d2f0211576ba3506eevboxsync ASMAtomicXchgBool(&pStorageBackend->fSyncIoPending, true);
af062818b47340eef15700d2f0211576ba3506eevboxsync int rc = PDMR3AsyncCompletionEpRead(pStorageBackend->pEndpoint, uOffset, &DataSeg, 1, cbRead, NULL, &pTask);
af062818b47340eef15700d2f0211576ba3506eevboxsync rc = RTSemEventWait(pStorageBackend->EventSem, RT_INDEFINITE_WAIT);
af062818b47340eef15700d2f0211576ba3506eevboxsync ASMAtomicXchgBool(&pStorageBackend->fSyncIoPending, false);
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(int) drvvdAsyncIOWriteSync(void *pvUser, void *pStorage, uint64_t uOffset,
af062818b47340eef15700d2f0211576ba3506eevboxsync size_t cbWrite, const void *pvBuf, size_t *pcbWritten)
af062818b47340eef15700d2f0211576ba3506eevboxsync PDRVVDSTORAGEBACKEND pStorageBackend = (PDRVVDSTORAGEBACKEND)pStorage;
af062818b47340eef15700d2f0211576ba3506eevboxsync ASMAtomicXchgBool(&pStorageBackend->fSyncIoPending, true);
af062818b47340eef15700d2f0211576ba3506eevboxsync int rc = PDMR3AsyncCompletionEpWrite(pStorageBackend->pEndpoint, uOffset, &DataSeg, 1, cbWrite, NULL, &pTask);
af062818b47340eef15700d2f0211576ba3506eevboxsync rc = RTSemEventWait(pStorageBackend->EventSem, RT_INDEFINITE_WAIT);
af062818b47340eef15700d2f0211576ba3506eevboxsync ASMAtomicXchgBool(&pStorageBackend->fSyncIoPending, false);
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(int) drvvdAsyncIOFlushSync(void *pvUser, void *pStorage)
af062818b47340eef15700d2f0211576ba3506eevboxsync PDRVVDSTORAGEBACKEND pStorageBackend = (PDRVVDSTORAGEBACKEND)pStorage;
af062818b47340eef15700d2f0211576ba3506eevboxsync ASMAtomicXchgBool(&pStorageBackend->fSyncIoPending, true);
af062818b47340eef15700d2f0211576ba3506eevboxsync int rc = PDMR3AsyncCompletionEpFlush(pStorageBackend->pEndpoint, NULL, &pTask);
af062818b47340eef15700d2f0211576ba3506eevboxsync rc = RTSemEventWait(pStorageBackend->EventSem, RT_INDEFINITE_WAIT);
af062818b47340eef15700d2f0211576ba3506eevboxsync ASMAtomicXchgBool(&pStorageBackend->fSyncIoPending, false);
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(int) drvvdAsyncIOReadAsync(void *pvUser, void *pStorage, uint64_t uOffset,
af062818b47340eef15700d2f0211576ba3506eevboxsync PDRVVDSTORAGEBACKEND pStorageBackend = (PDRVVDSTORAGEBACKEND)pStorage;
af062818b47340eef15700d2f0211576ba3506eevboxsync int rc = PDMR3AsyncCompletionEpRead(pStorageBackend->pEndpoint, uOffset, paSegments, cSegments, cbRead,
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(int) drvvdAsyncIOWriteAsync(void *pvUser, void *pStorage, uint64_t uOffset,
af062818b47340eef15700d2f0211576ba3506eevboxsync PDRVVDSTORAGEBACKEND pStorageBackend = (PDRVVDSTORAGEBACKEND)pStorage;
af062818b47340eef15700d2f0211576ba3506eevboxsync int rc = PDMR3AsyncCompletionEpWrite(pStorageBackend->pEndpoint, uOffset, paSegments, cSegments, cbWrite,
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(int) drvvdAsyncIOFlushAsync(void *pvUser, void *pStorage,
af062818b47340eef15700d2f0211576ba3506eevboxsync PDRVVDSTORAGEBACKEND pStorageBackend = (PDRVVDSTORAGEBACKEND)pStorage;
af062818b47340eef15700d2f0211576ba3506eevboxsync int rc = PDMR3AsyncCompletionEpFlush(pStorageBackend->pEndpoint, pvCompletion,
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(int) drvvdAsyncIOGetSize(void *pvUser, void *pStorage, uint64_t *pcbSize)
af062818b47340eef15700d2f0211576ba3506eevboxsync PDRVVDSTORAGEBACKEND pStorageBackend = (PDRVVDSTORAGEBACKEND)pStorage;
af062818b47340eef15700d2f0211576ba3506eevboxsync return PDMR3AsyncCompletionEpGetSize(pStorageBackend->pEndpoint, pcbSize);
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(int) drvvdAsyncIOSetSize(void *pvUser, void *pStorage, uint64_t cbSize)
af062818b47340eef15700d2f0211576ba3506eevboxsync PDRVVDSTORAGEBACKEND pStorageBackend = (PDRVVDSTORAGEBACKEND)pStorage;
af062818b47340eef15700d2f0211576ba3506eevboxsync rc = PDMR3AsyncCompletionEpSetSize(pStorageBackend->pEndpoint, cbSize);
af062818b47340eef15700d2f0211576ba3506eevboxsync#endif /* VBOX_WITH_PDM_ASYNC_COMPLETION */
af062818b47340eef15700d2f0211576ba3506eevboxsync/*******************************************************************************
af062818b47340eef15700d2f0211576ba3506eevboxsync* VD Thread Synchronization interface implementation *
af062818b47340eef15700d2f0211576ba3506eevboxsync*******************************************************************************/
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(int) drvvdThreadStartRead(void *pvUser)
af062818b47340eef15700d2f0211576ba3506eevboxsync return RTSemRWRequestRead(pThis->MergeLock, RT_INDEFINITE_WAIT);
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(int) drvvdThreadFinishRead(void *pvUser)
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(int) drvvdThreadStartWrite(void *pvUser)
af062818b47340eef15700d2f0211576ba3506eevboxsync return RTSemRWRequestWrite(pThis->MergeLock, RT_INDEFINITE_WAIT);
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(int) drvvdThreadFinishWrite(void *pvUser)
af062818b47340eef15700d2f0211576ba3506eevboxsync/*******************************************************************************
af062818b47340eef15700d2f0211576ba3506eevboxsync* VD Configuration interface implementation *
af062818b47340eef15700d2f0211576ba3506eevboxsync*******************************************************************************/
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic bool drvvdCfgAreKeysValid(void *pvUser, const char *pszzValid)
af062818b47340eef15700d2f0211576ba3506eevboxsync return CFGMR3AreValuesValid((PCFGMNODE)pvUser, pszzValid);
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic int drvvdCfgQuerySize(void *pvUser, const char *pszName, size_t *pcb)
af062818b47340eef15700d2f0211576ba3506eevboxsync return CFGMR3QuerySize((PCFGMNODE)pvUser, pszName, pcb);
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic int drvvdCfgQuery(void *pvUser, const char *pszName, char *pszString, size_t cchString)
af062818b47340eef15700d2f0211576ba3506eevboxsync return CFGMR3QueryString((PCFGMNODE)pvUser, pszName, pszString, cchString);
af062818b47340eef15700d2f0211576ba3506eevboxsync/*******************************************************************************
af062818b47340eef15700d2f0211576ba3506eevboxsync* VD TCP network stack interface implementation - INIP case *
af062818b47340eef15700d2f0211576ba3506eevboxsync*******************************************************************************/
af062818b47340eef15700d2f0211576ba3506eevboxsync/** @copydoc VDINTERFACETCPNET::pfnClientConnect */
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(int) drvvdINIPClientConnect(const char *pszAddress, uint32_t uPort, PRTSOCKET pSock)
af062818b47340eef15700d2f0211576ba3506eevboxsync /* First check whether lwIP is set up in this VM instance. */
af062818b47340eef15700d2f0211576ba3506eevboxsync /* Resolve hostname. As there is no standard resolver for lwIP yet,
af062818b47340eef15700d2f0211576ba3506eevboxsync * just accept numeric IP addresses for now. */
af062818b47340eef15700d2f0211576ba3506eevboxsync LogRelFunc(("cannot resolve IP %s\n", pszAddress));
af062818b47340eef15700d2f0211576ba3506eevboxsync /* Create socket and connect. */
af062818b47340eef15700d2f0211576ba3506eevboxsync RTSOCKET Sock = lwip_socket(PF_INET, SOCK_STREAM, 0);
af062818b47340eef15700d2f0211576ba3506eevboxsync if (!lwip_connect(Sock, (struct sockaddr *)&InAddr, sizeof(InAddr)))
af062818b47340eef15700d2f0211576ba3506eevboxsync rc = VERR_NET_CONNECTION_REFUSED; /* @todo real solution needed */
af062818b47340eef15700d2f0211576ba3506eevboxsync rc = VERR_NET_CONNECTION_REFUSED; /* @todo real solution needed */
af062818b47340eef15700d2f0211576ba3506eevboxsync/** @copydoc VDINTERFACETCPNET::pfnClientClose */
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(int) drvvdINIPClientClose(RTSOCKET Sock)
af062818b47340eef15700d2f0211576ba3506eevboxsync return VINF_SUCCESS; /** @todo real solution needed */
af062818b47340eef15700d2f0211576ba3506eevboxsync/** @copydoc VDINTERFACETCPNET::pfnSelectOne */
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(int) drvvdINIPSelectOne(RTSOCKET Sock, RTMSINTERVAL cMillies)
af062818b47340eef15700d2f0211576ba3506eevboxsync rc = lwip_select(Sock + 1, &fdsetR, NULL, &fdsetE, NULL);
af062818b47340eef15700d2f0211576ba3506eevboxsync rc = lwip_select(Sock + 1, &fdsetR, NULL, &fdsetE, &timeout);
af062818b47340eef15700d2f0211576ba3506eevboxsync return VERR_NET_CONNECTION_REFUSED; /** @todo real solution needed */
af062818b47340eef15700d2f0211576ba3506eevboxsync/** @copydoc VDINTERFACETCPNET::pfnRead */
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(int) drvvdINIPRead(RTSOCKET Sock, void *pvBuffer, size_t cbBuffer, size_t *pcbRead)
af062818b47340eef15700d2f0211576ba3506eevboxsync /* Do params checking */
af062818b47340eef15700d2f0211576ba3506eevboxsync * Read loop.
af062818b47340eef15700d2f0211576ba3506eevboxsync * If pcbRead is NULL we have to fill the entire buffer!
af062818b47340eef15700d2f0211576ba3506eevboxsync /** @todo this clipping here is just in case (the send function
af062818b47340eef15700d2f0211576ba3506eevboxsync * needed it, so I added it here, too). Didn't investigate if this
af062818b47340eef15700d2f0211576ba3506eevboxsync * really has issues. Better be safe than sorry. */
af062818b47340eef15700d2f0211576ba3506eevboxsync ssize_t cbBytesRead = lwip_recv(Sock, (char *)pvBuffer + cbRead,
af062818b47340eef15700d2f0211576ba3506eevboxsync return VERR_NET_CONNECTION_REFUSED; /** @todo real solution */
af062818b47340eef15700d2f0211576ba3506eevboxsync return VERR_NET_CONNECTION_REFUSED; /** @todo real solution */
af062818b47340eef15700d2f0211576ba3506eevboxsync /* return partial data */
af062818b47340eef15700d2f0211576ba3506eevboxsync /* read more? */
af062818b47340eef15700d2f0211576ba3506eevboxsync/** @copydoc VDINTERFACETCPNET::pfnWrite */
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(int) drvvdINIPWrite(RTSOCKET Sock, const void *pvBuffer, size_t cbBuffer)
af062818b47340eef15700d2f0211576ba3506eevboxsync /** @todo lwip send only supports up to 65535 bytes in a single
af062818b47340eef15700d2f0211576ba3506eevboxsync * send (stupid limitation buried in the code), so make sure we
af062818b47340eef15700d2f0211576ba3506eevboxsync * don't get any wraparounds. This should be moved to DevINIP
af062818b47340eef15700d2f0211576ba3506eevboxsync * stack interface once that's implemented. */
af062818b47340eef15700d2f0211576ba3506eevboxsync ssize_t cbWritten = lwip_send(Sock, (void *)pvBuffer,
af062818b47340eef15700d2f0211576ba3506eevboxsync return VERR_NET_CONNECTION_REFUSED; /** @todo real solution needed */
af062818b47340eef15700d2f0211576ba3506eevboxsync AssertMsg(cbBuffer >= (size_t)cbWritten, ("Wrote more than we requested!!! cbWritten=%d cbBuffer=%d\n",
af062818b47340eef15700d2f0211576ba3506eevboxsync/** @copydoc VDINTERFACETCPNET::pfnFlush */
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(int) drvvdINIPFlush(RTSOCKET Sock)
af062818b47340eef15700d2f0211576ba3506eevboxsync/** @copydoc VDINTERFACETCPNET::pfnGetLocalAddress */
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(int) drvvdINIPGetLocalAddress(RTSOCKET Sock, PRTNETADDR pAddr)
af062818b47340eef15700d2f0211576ba3506eevboxsync * Convert the address.
af062818b47340eef15700d2f0211576ba3506eevboxsync/** @copydoc VDINTERFACETCPNET::pfnGetPeerAddress */
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(int) drvvdINIPGetPeerAddress(RTSOCKET Sock, PRTNETADDR pAddr)
af062818b47340eef15700d2f0211576ba3506eevboxsync * Convert the address.
af062818b47340eef15700d2f0211576ba3506eevboxsync#endif /* VBOX_WITH_INIP */
af062818b47340eef15700d2f0211576ba3506eevboxsync/*******************************************************************************
af062818b47340eef15700d2f0211576ba3506eevboxsync* Media interface methods *
af062818b47340eef15700d2f0211576ba3506eevboxsync*******************************************************************************/
af062818b47340eef15700d2f0211576ba3506eevboxsync/** @copydoc PDMIMEDIA::pfnRead */
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(int) drvvdRead(PPDMIMEDIA pInterface,
af062818b47340eef15700d2f0211576ba3506eevboxsync LogFlow(("%s: off=%#llx pvBuf=%p cbRead=%d\n", __FUNCTION__,
af062818b47340eef15700d2f0211576ba3506eevboxsync PVBOXDISK pThis = PDMIMEDIA_2_VBOXDISK(pInterface);
af062818b47340eef15700d2f0211576ba3506eevboxsync Log2(("%s: off=%#llx pvBuf=%p cbRead=%d %.*Rhxd\n", __FUNCTION__,
af062818b47340eef15700d2f0211576ba3506eevboxsync/** @copydoc PDMIMEDIA::pfnWrite */
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(int) drvvdWrite(PPDMIMEDIA pInterface,
af062818b47340eef15700d2f0211576ba3506eevboxsync LogFlow(("%s: off=%#llx pvBuf=%p cbWrite=%d\n", __FUNCTION__,
af062818b47340eef15700d2f0211576ba3506eevboxsync PVBOXDISK pThis = PDMIMEDIA_2_VBOXDISK(pInterface);
af062818b47340eef15700d2f0211576ba3506eevboxsync Log2(("%s: off=%#llx pvBuf=%p cbWrite=%d %.*Rhxd\n", __FUNCTION__,
af062818b47340eef15700d2f0211576ba3506eevboxsync int rc = VDWrite(pThis->pDisk, off, pvBuf, cbWrite);
af062818b47340eef15700d2f0211576ba3506eevboxsync/** @copydoc PDMIMEDIA::pfnFlush */
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(int) drvvdFlush(PPDMIMEDIA pInterface)
af062818b47340eef15700d2f0211576ba3506eevboxsync PVBOXDISK pThis = PDMIMEDIA_2_VBOXDISK(pInterface);
af062818b47340eef15700d2f0211576ba3506eevboxsync/** @copydoc PDMIMEDIA::pfnMerge */
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(int) drvvdMerge(PPDMIMEDIA pInterface,
af062818b47340eef15700d2f0211576ba3506eevboxsync PVBOXDISK pThis = PDMIMEDIA_2_VBOXDISK(pInterface);
af062818b47340eef15700d2f0211576ba3506eevboxsync /* Note: There is an unavoidable race between destruction and another
af062818b47340eef15700d2f0211576ba3506eevboxsync * thread invoking this function. This is handled safely and gracefully by
af062818b47340eef15700d2f0211576ba3506eevboxsync * atomically invalidating the lock handle in drvvdDestruct. */
af062818b47340eef15700d2f0211576ba3506eevboxsync int rc2 = RTSemFastMutexRequest(pThis->MergeCompleteMutex);
af062818b47340eef15700d2f0211576ba3506eevboxsync /* Take shortcut: PFNSIMPLEPROGRESS is exactly the same type as
af062818b47340eef15700d2f0211576ba3506eevboxsync * PFNVDPROGRESS, so there's no need for a conversion function. */
af062818b47340eef15700d2f0211576ba3506eevboxsync /** @todo maybe introduce a conversion which limits update frequency. */
af062818b47340eef15700d2f0211576ba3506eevboxsync VDIProgressCallbacks.cbSize = sizeof(VDINTERFACEPROGRESS);
af062818b47340eef15700d2f0211576ba3506eevboxsync VDIProgressCallbacks.enmInterface = VDINTERFACETYPE_PROGRESS;
af062818b47340eef15700d2f0211576ba3506eevboxsync rc2 = VDInterfaceAdd(&VDIProgress, "DrvVD_VDIProgress", VDINTERFACETYPE_PROGRESS,
af062818b47340eef15700d2f0211576ba3506eevboxsync rc2 = RTSemFastMutexRelease(pThis->MergeCompleteMutex);
af062818b47340eef15700d2f0211576ba3506eevboxsync/** @copydoc PDMIMEDIA::pfnGetSize */
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(uint64_t) drvvdGetSize(PPDMIMEDIA pInterface)
af062818b47340eef15700d2f0211576ba3506eevboxsync PVBOXDISK pThis = PDMIMEDIA_2_VBOXDISK(pInterface);
af062818b47340eef15700d2f0211576ba3506eevboxsync uint64_t cb = VDGetSize(pThis->pDisk, VD_LAST_IMAGE);
af062818b47340eef15700d2f0211576ba3506eevboxsync LogFlow(("%s: returns %#llx (%llu)\n", __FUNCTION__, cb, cb));
af062818b47340eef15700d2f0211576ba3506eevboxsync/** @copydoc PDMIMEDIA::pfnIsReadOnly */
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(bool) drvvdIsReadOnly(PPDMIMEDIA pInterface)
af062818b47340eef15700d2f0211576ba3506eevboxsync PVBOXDISK pThis = PDMIMEDIA_2_VBOXDISK(pInterface);
af062818b47340eef15700d2f0211576ba3506eevboxsync/** @copydoc PDMIMEDIA::pfnBiosGetPCHSGeometry */
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(int) drvvdBiosGetPCHSGeometry(PPDMIMEDIA pInterface,
af062818b47340eef15700d2f0211576ba3506eevboxsync PVBOXDISK pThis = PDMIMEDIA_2_VBOXDISK(pInterface);
af062818b47340eef15700d2f0211576ba3506eevboxsync int rc = VDGetPCHSGeometry(pThis->pDisk, VD_LAST_IMAGE, pPCHSGeometry);
af062818b47340eef15700d2f0211576ba3506eevboxsync Log(("%s: geometry not available.\n", __FUNCTION__));
af062818b47340eef15700d2f0211576ba3506eevboxsync LogFlow(("%s: returns %Rrc (CHS=%d/%d/%d)\n", __FUNCTION__,
af062818b47340eef15700d2f0211576ba3506eevboxsync rc, pPCHSGeometry->cCylinders, pPCHSGeometry->cHeads, pPCHSGeometry->cSectors));
af062818b47340eef15700d2f0211576ba3506eevboxsync/** @copydoc PDMIMEDIA::pfnBiosSetPCHSGeometry */
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(int) drvvdBiosSetPCHSGeometry(PPDMIMEDIA pInterface,
af062818b47340eef15700d2f0211576ba3506eevboxsync pPCHSGeometry->cCylinders, pPCHSGeometry->cHeads, pPCHSGeometry->cSectors));
af062818b47340eef15700d2f0211576ba3506eevboxsync PVBOXDISK pThis = PDMIMEDIA_2_VBOXDISK(pInterface);
af062818b47340eef15700d2f0211576ba3506eevboxsync int rc = VDSetPCHSGeometry(pThis->pDisk, VD_LAST_IMAGE, pPCHSGeometry);
af062818b47340eef15700d2f0211576ba3506eevboxsync/** @copydoc PDMIMEDIA::pfnBiosGetLCHSGeometry */
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(int) drvvdBiosGetLCHSGeometry(PPDMIMEDIA pInterface,
af062818b47340eef15700d2f0211576ba3506eevboxsync PVBOXDISK pThis = PDMIMEDIA_2_VBOXDISK(pInterface);
af062818b47340eef15700d2f0211576ba3506eevboxsync int rc = VDGetLCHSGeometry(pThis->pDisk, VD_LAST_IMAGE, pLCHSGeometry);
af062818b47340eef15700d2f0211576ba3506eevboxsync Log(("%s: geometry not available.\n", __FUNCTION__));
af062818b47340eef15700d2f0211576ba3506eevboxsync LogFlow(("%s: returns %Rrc (CHS=%d/%d/%d)\n", __FUNCTION__,
af062818b47340eef15700d2f0211576ba3506eevboxsync rc, pLCHSGeometry->cCylinders, pLCHSGeometry->cHeads, pLCHSGeometry->cSectors));
af062818b47340eef15700d2f0211576ba3506eevboxsync/** @copydoc PDMIMEDIA::pfnBiosSetLCHSGeometry */
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(int) drvvdBiosSetLCHSGeometry(PPDMIMEDIA pInterface,
af062818b47340eef15700d2f0211576ba3506eevboxsync pLCHSGeometry->cCylinders, pLCHSGeometry->cHeads, pLCHSGeometry->cSectors));
af062818b47340eef15700d2f0211576ba3506eevboxsync PVBOXDISK pThis = PDMIMEDIA_2_VBOXDISK(pInterface);
af062818b47340eef15700d2f0211576ba3506eevboxsync int rc = VDSetLCHSGeometry(pThis->pDisk, VD_LAST_IMAGE, pLCHSGeometry);
af062818b47340eef15700d2f0211576ba3506eevboxsync/** @copydoc PDMIMEDIA::pfnGetUuid */
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(int) drvvdGetUuid(PPDMIMEDIA pInterface, PRTUUID pUuid)
af062818b47340eef15700d2f0211576ba3506eevboxsync PVBOXDISK pThis = PDMIMEDIA_2_VBOXDISK(pInterface);
af062818b47340eef15700d2f0211576ba3506eevboxsync LogFlow(("%s: returns %Rrc ({%RTuuid})\n", __FUNCTION__, rc, pUuid));
af062818b47340eef15700d2f0211576ba3506eevboxsync/*******************************************************************************
af062818b47340eef15700d2f0211576ba3506eevboxsync* Async Media interface methods *
af062818b47340eef15700d2f0211576ba3506eevboxsync*******************************************************************************/
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic void drvvdAsyncReqComplete(void *pvUser1, void *pvUser2)
af062818b47340eef15700d2f0211576ba3506eevboxsync int rc = pThis->pDrvMediaAsyncPort->pfnTransferCompleteNotify(pThis->pDrvMediaAsyncPort,
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(int) drvvdStartRead(PPDMIMEDIAASYNC pInterface, uint64_t uOffset,
af062818b47340eef15700d2f0211576ba3506eevboxsync LogFlow(("%s: uOffset=%#llx paSeg=%#p cSeg=%u cbRead=%d\n pvUser=%#p", __FUNCTION__,
af062818b47340eef15700d2f0211576ba3506eevboxsync PVBOXDISK pThis = PDMIMEDIAASYNC_2_VBOXDISK(pInterface);
af062818b47340eef15700d2f0211576ba3506eevboxsync int rc = VDAsyncRead(pThis->pDisk, uOffset, cbRead, paSeg, cSeg,
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(int) drvvdStartWrite(PPDMIMEDIAASYNC pInterface, uint64_t uOffset,
af062818b47340eef15700d2f0211576ba3506eevboxsync LogFlow(("%s: uOffset=%#llx paSeg=%#p cSeg=%u cbWrite=%d\n pvUser=%#p", __FUNCTION__,
af062818b47340eef15700d2f0211576ba3506eevboxsync PVBOXDISK pThis = PDMIMEDIAASYNC_2_VBOXDISK(pInterface);
af062818b47340eef15700d2f0211576ba3506eevboxsync int rc = VDAsyncWrite(pThis->pDisk, uOffset, cbWrite, paSeg, cSeg,
af062818b47340eef15700d2f0211576ba3506eevboxsync/*******************************************************************************
af062818b47340eef15700d2f0211576ba3506eevboxsync* Base interface methods *
af062818b47340eef15700d2f0211576ba3506eevboxsync*******************************************************************************/
af062818b47340eef15700d2f0211576ba3506eevboxsync * @interface_method_impl{PDMIBASE,pfnQueryInterface}
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(void *) drvvdQueryInterface(PPDMIBASE pInterface, const char *pszIID)
af062818b47340eef15700d2f0211576ba3506eevboxsync PPDMDRVINS pDrvIns = PDMIBASE_2_DRVINS(pInterface);
af062818b47340eef15700d2f0211576ba3506eevboxsync PVBOXDISK pThis = PDMINS_2_DATA(pDrvIns, PVBOXDISK);
af062818b47340eef15700d2f0211576ba3506eevboxsync PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pDrvIns->IBase);
af062818b47340eef15700d2f0211576ba3506eevboxsync PDMIBASE_RETURN_INTERFACE(pszIID, PDMIMEDIA, &pThis->IMedia);
af062818b47340eef15700d2f0211576ba3506eevboxsync PDMIBASE_RETURN_INTERFACE(pszIID, PDMIMEDIAASYNC, pThis->fAsyncIOSupported ? &pThis->IMediaAsync : NULL);
af062818b47340eef15700d2f0211576ba3506eevboxsync/*******************************************************************************
af062818b47340eef15700d2f0211576ba3506eevboxsync* Saved state notification methods *
af062818b47340eef15700d2f0211576ba3506eevboxsync*******************************************************************************/
af062818b47340eef15700d2f0211576ba3506eevboxsync * Load done callback for re-opening the image writable during teleportation.
af062818b47340eef15700d2f0211576ba3506eevboxsync * This is called both for successful and failed load runs, we only care about
af062818b47340eef15700d2f0211576ba3506eevboxsync * successfull ones.
af062818b47340eef15700d2f0211576ba3506eevboxsync * @returns VBox status code.
af062818b47340eef15700d2f0211576ba3506eevboxsync * @param pDrvIns The driver instance.
af062818b47340eef15700d2f0211576ba3506eevboxsync * @param pSSM The saved state handle.
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(int) drvvdLoadDone(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM)
af062818b47340eef15700d2f0211576ba3506eevboxsync PVBOXDISK pThis = PDMINS_2_DATA(pDrvIns, PVBOXDISK);
af062818b47340eef15700d2f0211576ba3506eevboxsync /* Drop out if we don't have any work to do or if it's a failed load. */
af062818b47340eef15700d2f0211576ba3506eevboxsync if (RT_FAILURE(rc)) /** @todo does the bugger set any errors? */
af062818b47340eef15700d2f0211576ba3506eevboxsync/*******************************************************************************
af062818b47340eef15700d2f0211576ba3506eevboxsync* Driver methods *
af062818b47340eef15700d2f0211576ba3506eevboxsync*******************************************************************************/
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(void) drvvdPowerOff(PPDMDRVINS pDrvIns)
af062818b47340eef15700d2f0211576ba3506eevboxsync PVBOXDISK pThis = PDMINS_2_DATA(pDrvIns, PVBOXDISK);
af062818b47340eef15700d2f0211576ba3506eevboxsync * We must close the disk here to ensure that
af062818b47340eef15700d2f0211576ba3506eevboxsync * the backend closes all files before the
af062818b47340eef15700d2f0211576ba3506eevboxsync * async transport driver is destructed.
af062818b47340eef15700d2f0211576ba3506eevboxsync * VM resume notification that we use to undo what the temporary read-only image
af062818b47340eef15700d2f0211576ba3506eevboxsync * mode set by drvvdSuspend.
af062818b47340eef15700d2f0211576ba3506eevboxsync * Also switch to runtime error mode if we're resuming after a state load
af062818b47340eef15700d2f0211576ba3506eevboxsync * without having been powered on first.
af062818b47340eef15700d2f0211576ba3506eevboxsync * @param pDrvIns The driver instance data.
af062818b47340eef15700d2f0211576ba3506eevboxsync * @todo The VMSetError vs VMSetRuntimeError mess must be fixed elsewhere,
af062818b47340eef15700d2f0211576ba3506eevboxsync * we're making assumptions about Main behavior here!
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(void) drvvdResume(PPDMDRVINS pDrvIns)
af062818b47340eef15700d2f0211576ba3506eevboxsync PVBOXDISK pThis = PDMINS_2_DATA(pDrvIns, PVBOXDISK);
af062818b47340eef15700d2f0211576ba3506eevboxsync * The VM is being suspended, temporarily change to read-only image mode.
af062818b47340eef15700d2f0211576ba3506eevboxsync * This is important for several reasons:
af062818b47340eef15700d2f0211576ba3506eevboxsync * -# It makes sure that there are no pending writes to the image. Most
af062818b47340eef15700d2f0211576ba3506eevboxsync * backends implements this by closing and reopening the image in read-only
af062818b47340eef15700d2f0211576ba3506eevboxsync * -# It allows Main to read the images during snapshotting without having
af062818b47340eef15700d2f0211576ba3506eevboxsync * to account for concurrent writes.
af062818b47340eef15700d2f0211576ba3506eevboxsync * -# This is essential for making teleportation targets sharing images work
af062818b47340eef15700d2f0211576ba3506eevboxsync * right. Both with regards to caching and with regards to file sharing
af062818b47340eef15700d2f0211576ba3506eevboxsync * locks (RTFILE_O_DENY_*). (See also drvvdLoadDone.)
af062818b47340eef15700d2f0211576ba3506eevboxsync * @param pDrvIns The driver instance data.
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(void) drvvdSuspend(PPDMDRVINS pDrvIns)
af062818b47340eef15700d2f0211576ba3506eevboxsync PVBOXDISK pThis = PDMINS_2_DATA(pDrvIns, PVBOXDISK);
af062818b47340eef15700d2f0211576ba3506eevboxsync * VM PowerOn notification for undoing the TempReadOnly config option and
af062818b47340eef15700d2f0211576ba3506eevboxsync * changing to runtime error mode.
af062818b47340eef15700d2f0211576ba3506eevboxsync * @param pDrvIns The driver instance data.
af062818b47340eef15700d2f0211576ba3506eevboxsync * @todo The VMSetError vs VMSetRuntimeError mess must be fixed elsewhere,
af062818b47340eef15700d2f0211576ba3506eevboxsync * we're making assumptions about Main behavior here!
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(void) drvvdPowerOn(PPDMDRVINS pDrvIns)
af062818b47340eef15700d2f0211576ba3506eevboxsync PVBOXDISK pThis = PDMINS_2_DATA(pDrvIns, PVBOXDISK);
af062818b47340eef15700d2f0211576ba3506eevboxsync * @copydoc FNPDMDRVDESTRUCT
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(void) drvvdDestruct(PPDMDRVINS pDrvIns)
af062818b47340eef15700d2f0211576ba3506eevboxsync PVBOXDISK pThis = PDMINS_2_DATA(pDrvIns, PVBOXDISK);
af062818b47340eef15700d2f0211576ba3506eevboxsync RTSEMFASTMUTEX mutex = (RTSEMFASTMUTEX)ASMAtomicXchgPtr((void **)&pThis->MergeCompleteMutex,
af062818b47340eef15700d2f0211576ba3506eevboxsync /* Request the semaphore to wait until a potentially running merge
af062818b47340eef15700d2f0211576ba3506eevboxsync * operation has been finished. */
af062818b47340eef15700d2f0211576ba3506eevboxsync * Construct a VBox disk media driver instance.
af062818b47340eef15700d2f0211576ba3506eevboxsync * @copydoc FNPDMDRVCONSTRUCT
af062818b47340eef15700d2f0211576ba3506eevboxsyncstatic DECLCALLBACK(int) drvvdConstruct(PPDMDRVINS pDrvIns,
af062818b47340eef15700d2f0211576ba3506eevboxsync PVBOXDISK pThis = PDMINS_2_DATA(pDrvIns, PVBOXDISK);
af062818b47340eef15700d2f0211576ba3506eevboxsync char *pszName = NULL; /**< The path of the disk image file. */
af062818b47340eef15700d2f0211576ba3506eevboxsync char *pszFormat = NULL; /**< The format backed to use for this image. */
af062818b47340eef15700d2f0211576ba3506eevboxsync bool fReadOnly; /**< True if the media is read-only. */
af062818b47340eef15700d2f0211576ba3506eevboxsync bool fHonorZeroWrites; /**< True if zero blocks should be written. */
af062818b47340eef15700d2f0211576ba3506eevboxsync * Init the static parts.
af062818b47340eef15700d2f0211576ba3506eevboxsync pDrvIns->IBase.pfnQueryInterface = drvvdQueryInterface;
af062818b47340eef15700d2f0211576ba3506eevboxsync /* IMedia */
af062818b47340eef15700d2f0211576ba3506eevboxsync pThis->IMedia.pfnBiosGetPCHSGeometry = drvvdBiosGetPCHSGeometry;
af062818b47340eef15700d2f0211576ba3506eevboxsync pThis->IMedia.pfnBiosSetPCHSGeometry = drvvdBiosSetPCHSGeometry;
af062818b47340eef15700d2f0211576ba3506eevboxsync pThis->IMedia.pfnBiosGetLCHSGeometry = drvvdBiosGetLCHSGeometry;
af062818b47340eef15700d2f0211576ba3506eevboxsync pThis->IMedia.pfnBiosSetLCHSGeometry = drvvdBiosSetLCHSGeometry;
af062818b47340eef15700d2f0211576ba3506eevboxsync /* IMediaAsync */
af062818b47340eef15700d2f0211576ba3506eevboxsync pThis->IMediaAsync.pfnStartWrite = drvvdStartWrite;
af062818b47340eef15700d2f0211576ba3506eevboxsync /* Initialize supported VD interfaces. */
af062818b47340eef15700d2f0211576ba3506eevboxsync pThis->VDIErrorCallbacks.cbSize = sizeof(VDINTERFACEERROR);
af062818b47340eef15700d2f0211576ba3506eevboxsync pThis->VDIErrorCallbacks.enmInterface = VDINTERFACETYPE_ERROR;
af062818b47340eef15700d2f0211576ba3506eevboxsync pThis->VDIErrorCallbacks.pfnError = drvvdErrorCallback;
af062818b47340eef15700d2f0211576ba3506eevboxsync rc = VDInterfaceAdd(&pThis->VDIError, "DrvVD_VDIError", VDINTERFACETYPE_ERROR,
af062818b47340eef15700d2f0211576ba3506eevboxsync &pThis->VDIErrorCallbacks, pDrvIns, &pThis->pVDIfsDisk);
af062818b47340eef15700d2f0211576ba3506eevboxsync /* This is just prepared here, the actual interface is per-image, so it's
af062818b47340eef15700d2f0211576ba3506eevboxsync * added later. No need to have separate callback tables. */
af062818b47340eef15700d2f0211576ba3506eevboxsync pThis->VDIConfigCallbacks.cbSize = sizeof(VDINTERFACECONFIG);
af062818b47340eef15700d2f0211576ba3506eevboxsync pThis->VDIConfigCallbacks.enmInterface = VDINTERFACETYPE_CONFIG;
af062818b47340eef15700d2f0211576ba3506eevboxsync pThis->VDIConfigCallbacks.pfnAreKeysValid = drvvdCfgAreKeysValid;
af062818b47340eef15700d2f0211576ba3506eevboxsync pThis->VDIConfigCallbacks.pfnQuerySize = drvvdCfgQuerySize;
af062818b47340eef15700d2f0211576ba3506eevboxsync pThis->VDIConfigCallbacks.pfnQuery = drvvdCfgQuery;
af062818b47340eef15700d2f0211576ba3506eevboxsync /* List of images is empty now. */
af062818b47340eef15700d2f0211576ba3506eevboxsync /* Try to attach async media port interface above.*/
af062818b47340eef15700d2f0211576ba3506eevboxsync pThis->pDrvMediaAsyncPort = PDMIBASE_QUERY_INTERFACE(pDrvIns->pUpBase, PDMIMEDIAASYNCPORT);
af062818b47340eef15700d2f0211576ba3506eevboxsync * Validate configuration and find all parent images.
af062818b47340eef15700d2f0211576ba3506eevboxsync * It's sort of up side down from the image dependency tree.
af062818b47340eef15700d2f0211576ba3506eevboxsync bool fHostIP = false;
af062818b47340eef15700d2f0211576ba3506eevboxsync bool fUseNewIo = false;
af062818b47340eef15700d2f0211576ba3506eevboxsync unsigned iLevel = 0;
if (!fValid)
if (!pParent)
iLevel++;
if (fHostIP)
#ifndef VBOX_WITH_INIP
unsigned iImageIdx = 0;
if (!pImage)
bool fMergeSource;
if (fMergeSource)
bool fMergeTarget;
if (fMergeTarget)
unsigned uOpenFlags;
if (fHonorZeroWrites)
&& !fReadOnly
&& iLevel == 0)
pszName);
iLevel--;
iImageIdx--;
return rc;
sizeof(VBOXDISK),
NULL,
NULL,
NULL,
NULL,
NULL,
NULL,