DrvRawFile.cpp revision 5b465a7c1237993faf8bb50120d247f3f0319ada
8e2911e5309f5dff976cc7ac17d832d4ee2cdca3vboxsync * VBox stream drivers - Raw file output.
ee4d840f54fd2dcea8a73b1b86d5ec0db370b05dvboxsync * Copyright (C) 2006-2010 Sun Microsystems, Inc.
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync * available from http://www.virtualbox.org. This file is free software;
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync * you can redistribute it and/or modify it under the terms of the GNU
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync * General Public License (GPL) as published by the Free Software
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync * Clara, CA 95054 USA or visit http://www.sun.com if you need
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync * additional information or have any questions.
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync/*******************************************************************************
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync* Header Files *
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync*******************************************************************************/
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync/*******************************************************************************
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync* Defined Constants And Macros *
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync*******************************************************************************/
dc1ef3adbbc24e348697c7f7d4b4df5cf4f64c32vboxsync/** Converts a pointer to DRVRAWFILE::IMedia to a PDRVRAWFILE. */
dc1ef3adbbc24e348697c7f7d4b4df5cf4f64c32vboxsync#define PDMISTREAM_2_DRVRAWFILE(pInterface) ( (PDRVRAWFILE)((uintptr_t)pInterface - RT_OFFSETOF(DRVRAWFILE, IStream)) )
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync/** Converts a pointer to PDMDRVINS::IBase to a PPDMDRVINS. */
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync#define PDMIBASE_2_DRVINS(pInterface) ( (PPDMDRVINS)((uintptr_t)pInterface - RT_OFFSETOF(PDMDRVINS, IBase)) )
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync/*******************************************************************************
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync* Structures and Typedefs *
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync*******************************************************************************/
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync * Raw file output driver instance data.
ee4d840f54fd2dcea8a73b1b86d5ec0db370b05dvboxsync * @implements PDMISTREAM
dc1ef3adbbc24e348697c7f7d4b4df5cf4f64c32vboxsynctypedef struct DRVRAWFILE
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync /** The stream interface. */
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync /** Pointer to the driver instance. */
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync /** Pointer to the file name. (Freed by MM) */
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync /** Flag whether VirtualBox represents the server or client side. */
e74eef731a813e4e06680c587a6759b9974b29c9vboxsync/* -=-=-=-=- PDMISTREAM -=-=-=-=- */
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync/** @copydoc PDMISTREAM::pfnWrite */
dc1ef3adbbc24e348697c7f7d4b4df5cf4f64c32vboxsyncstatic DECLCALLBACK(int) drvRawFileWrite(PPDMISTREAM pInterface, const void *pvBuf, size_t *pcbWrite)
dc1ef3adbbc24e348697c7f7d4b4df5cf4f64c32vboxsync PDRVRAWFILE pThis = PDMISTREAM_2_DRVRAWFILE(pInterface);
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync LogFlow(("%s: pvBuf=%p *pcbWrite=%#x (%s)\n", __FUNCTION__, pvBuf, *pcbWrite, pThis->pszLocation));
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync rc = RTFileWrite(pThis->OutputFile, pvBuf, *pcbWrite, &cbWritten);
b2b8d2ecd8d9bafa7d53919432c46e86fb377fa7vboxsync /* don't flush here, takes too long and we will loose characters */
e74eef731a813e4e06680c587a6759b9974b29c9vboxsync/* -=-=-=-=- PDMIBASE -=-=-=-=- */
ee4d840f54fd2dcea8a73b1b86d5ec0db370b05dvboxsync * @interface_method_impl{PDMIBASE,pfnQueryInterface}
ee4d840f54fd2dcea8a73b1b86d5ec0db370b05dvboxsyncstatic DECLCALLBACK(void *) drvRawFileQueryInterface(PPDMIBASE pInterface, const char *pszIID)
ee4d840f54fd2dcea8a73b1b86d5ec0db370b05dvboxsync PPDMDRVINS pDrvIns = PDMIBASE_2_DRVINS(pInterface);
ee4d840f54fd2dcea8a73b1b86d5ec0db370b05dvboxsync PDRVRAWFILE pThis = PDMINS_2_DATA(pDrvIns, PDRVRAWFILE);
a39ea3668b7019c23a68936259545f9b71bce1aavboxsync PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pDrvIns->IBase);
da3503c04ce76e653401396fe2795a9bc2427a1dvboxsync PDMIBASE_RETURN_INTERFACE(pszIID, PDMISTREAM, &pThis->IStream);
e74eef731a813e4e06680c587a6759b9974b29c9vboxsync/* -=-=-=-=- PDMDRVREG -=-=-=-=- */
e74eef731a813e4e06680c587a6759b9974b29c9vboxsync * Power off a raw output stream driver instance.
e74eef731a813e4e06680c587a6759b9974b29c9vboxsync * This does most of the destruction work, to avoid ordering dependencies.
e74eef731a813e4e06680c587a6759b9974b29c9vboxsync * @param pDrvIns The driver instance data.
e74eef731a813e4e06680c587a6759b9974b29c9vboxsyncstatic DECLCALLBACK(void) drvRawFilePowerOff(PPDMDRVINS pDrvIns)
dc1ef3adbbc24e348697c7f7d4b4df5cf4f64c32vboxsync PDRVRAWFILE pThis = PDMINS_2_DATA(pDrvIns, PDRVRAWFILE);
e74eef731a813e4e06680c587a6759b9974b29c9vboxsync LogFlow(("%s: %s\n", __FUNCTION__, pThis->pszLocation));
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync * Destruct a raw output stream driver instance.
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync * Most VM resources are freed by the VM. This callback is provided so that
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync * any non-VM resources can be freed correctly.
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync * @param pDrvIns The driver instance data.
dc1ef3adbbc24e348697c7f7d4b4df5cf4f64c32vboxsyncstatic DECLCALLBACK(void) drvRawFileDestruct(PPDMDRVINS pDrvIns)
dc1ef3adbbc24e348697c7f7d4b4df5cf4f64c32vboxsync PDRVRAWFILE pThis = PDMINS_2_DATA(pDrvIns, PDRVRAWFILE);
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync LogFlow(("%s: %s\n", __FUNCTION__, pThis->pszLocation));
e74eef731a813e4e06680c587a6759b9974b29c9vboxsync * Construct a raw output stream driver instance.
e74eef731a813e4e06680c587a6759b9974b29c9vboxsync * @copydoc FNPDMDRVCONSTRUCT
e74eef731a813e4e06680c587a6759b9974b29c9vboxsyncstatic DECLCALLBACK(int) drvRawFileConstruct(PPDMDRVINS pDrvIns, PCFGMNODE pCfgHandle, uint32_t fFlags)
dc1ef3adbbc24e348697c7f7d4b4df5cf4f64c32vboxsync PDRVRAWFILE pThis = PDMINS_2_DATA(pDrvIns, PDRVRAWFILE);
e74eef731a813e4e06680c587a6759b9974b29c9vboxsync * Init the static parts.
e74eef731a813e4e06680c587a6759b9974b29c9vboxsync /* IBase */
e74eef731a813e4e06680c587a6759b9974b29c9vboxsync pDrvIns->IBase.pfnQueryInterface = drvRawFileQueryInterface;
e74eef731a813e4e06680c587a6759b9974b29c9vboxsync /* IStream */
e74eef731a813e4e06680c587a6759b9974b29c9vboxsync * Read the configuration.
e74eef731a813e4e06680c587a6759b9974b29c9vboxsync if (!CFGMR3AreValuesValid(pCfgHandle, "Location\0"))
e74eef731a813e4e06680c587a6759b9974b29c9vboxsync AssertFailedReturn(VERR_PDM_DRVINS_UNKNOWN_CFG_VALUES);
e74eef731a813e4e06680c587a6759b9974b29c9vboxsync int rc = CFGMR3QueryStringAlloc(pCfgHandle, "Location", &pThis->pszLocation);
e74eef731a813e4e06680c587a6759b9974b29c9vboxsync AssertMsgFailedReturn(("Configuration error: query \"Location\" resulted in %Rrc.\n", rc), rc);
e74eef731a813e4e06680c587a6759b9974b29c9vboxsync * Open the raw file.
e74eef731a813e4e06680c587a6759b9974b29c9vboxsync rc = RTFileOpen(&pThis->OutputFile, pThis->pszLocation, RTFILE_O_WRITE | RTFILE_O_CREATE_REPLACE | RTFILE_O_DENY_NONE);
e74eef731a813e4e06680c587a6759b9974b29c9vboxsync LogRel(("RawFile%d: CreateFile failed rc=%Rrc\n", pDrvIns->iInstance));
e74eef731a813e4e06680c587a6759b9974b29c9vboxsync return PDMDrvHlpVMSetError(pDrvIns, rc, RT_SRC_POS, N_("RawFile#%d failed to create the raw output file %s"), pDrvIns->iInstance, pThis->pszLocation);
e74eef731a813e4e06680c587a6759b9974b29c9vboxsync LogFlow(("drvRawFileConstruct: location %s\n", pThis->pszLocation));
e74eef731a813e4e06680c587a6759b9974b29c9vboxsync LogRel(("RawFile#%u: location %s\n", pDrvIns->iInstance, pThis->pszLocation));
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync * Raw file driver registration record.
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync /* u32Version */
5b465a7c1237993faf8bb50120d247f3f0319adavboxsync /* szName */
ad77e3ec3cde24263bc7537575f5cae442bee3b1vboxsync /* szRCMod */
ad77e3ec3cde24263bc7537575f5cae442bee3b1vboxsync /* szR0Mod */
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync /* pszDescription */
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync "RawFile stream driver.",
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync /* fFlags */
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync /* fClass. */
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync /* cMaxInstances */
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync /* cbInstance */
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync /* pfnConstruct */
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync /* pfnDestruct */
ad77e3ec3cde24263bc7537575f5cae442bee3b1vboxsync /* pfnRelocate */
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync /* pfnIOCtl */
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync /* pfnPowerOn */
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync /* pfnReset */
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync /* pfnSuspend */
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync /* pfnResume */
cba6719bd64ec749967bbe931230452664109857vboxsync /* pfnAttach */
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync /* pfnDetach */
801238b286a80a5dd67ba56a1f26c0bc98a2a1eavboxsync /* pfnPowerOff */
cba6719bd64ec749967bbe931230452664109857vboxsync /* pfnSoftReset */
cba6719bd64ec749967bbe931230452664109857vboxsync /* u32EndVersion */