VBoxHDD.cpp revision caf54c14752060b187e3fca12a6f71f4b13126b8
e99772f9bf09219c532812c859fbeea513c67e65vboxsync/* $Id$ */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync/** @file
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * VBoxHDD - VBox HDD Container implementation.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync/*
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * Copyright (C) 2006-2008 Sun Microsystems, Inc.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync *
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * available from http://www.virtualbox.org. This file is free software;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * you can redistribute it and/or modify it under the terms of the GNU
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * General Public License (GPL) as published by the Free Software
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync *
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * Clara, CA 95054 USA or visit http://www.sun.com if you need
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * additional information or have any questions.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync/*******************************************************************************
e99772f9bf09219c532812c859fbeea513c67e65vboxsync* Header Files *
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync*******************************************************************************/
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync#define LOG_GROUP LOG_GROUP_VD
e99772f9bf09219c532812c859fbeea513c67e65vboxsync#include <VBox/VBoxHDD.h>
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync#include <VBox/err.h>
e99772f9bf09219c532812c859fbeea513c67e65vboxsync#include <VBox/sup.h>
e99772f9bf09219c532812c859fbeea513c67e65vboxsync#include <VBox/log.h>
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync#include <iprt/alloc.h>
e99772f9bf09219c532812c859fbeea513c67e65vboxsync#include <iprt/assert.h>
e99772f9bf09219c532812c859fbeea513c67e65vboxsync#include <iprt/uuid.h>
e99772f9bf09219c532812c859fbeea513c67e65vboxsync#include <iprt/file.h>
e99772f9bf09219c532812c859fbeea513c67e65vboxsync#include <iprt/string.h>
e99772f9bf09219c532812c859fbeea513c67e65vboxsync#include <iprt/asm.h>
e99772f9bf09219c532812c859fbeea513c67e65vboxsync#include <iprt/ldr.h>
e99772f9bf09219c532812c859fbeea513c67e65vboxsync#include <iprt/dir.h>
e99772f9bf09219c532812c859fbeea513c67e65vboxsync#include <iprt/path.h>
e99772f9bf09219c532812c859fbeea513c67e65vboxsync#include <iprt/param.h>
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync#include "VBoxHDD-Internal.h"
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync#define VBOXHDDDISK_SIGNATURE 0x6f0e2a7d
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync/** Buffer size used for merging images. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync#define VD_MERGE_BUFFER_SIZE (16 * _1M)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync/**
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * VBox HDD Container image descriptor.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync */
e99772f9bf09219c532812c859fbeea513c67e65vboxsynctypedef struct VDIMAGE
e99772f9bf09219c532812c859fbeea513c67e65vboxsync{
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /** Link to parent image descriptor, if any. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync struct VDIMAGE *pPrev;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /** Link to child image descriptor, if any. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync struct VDIMAGE *pNext;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /** Container base filename. (UTF-8) */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync char *pszFilename;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /** Data managed by the backend which keeps the actual info. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync void *pvBackendData;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /** Cached sanitized image flags. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync unsigned uImageFlags;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /** Image open flags (only those handled generically in this code and which
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * the backends will never ever see). */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync unsigned uOpenFlags;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /** Function pointers for the various backend methods. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync PCVBOXHDDBACKEND Backend;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /** Pointer to list of VD interfaces, per-image. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync PVDINTERFACE pVDIfsImage;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync} VDIMAGE, *PVDIMAGE;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync/**
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * uModified bit flags.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync#define VD_IMAGE_MODIFIED_FLAG RT_BIT(0)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync#define VD_IMAGE_MODIFIED_FIRST RT_BIT(1)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync#define VD_IMAGE_MODIFIED_DISABLE_UUID_UPDATE RT_BIT(2)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync/**
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * VBox HDD Container main structure, private part.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync */
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncstruct VBOXHDD
e99772f9bf09219c532812c859fbeea513c67e65vboxsync{
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /** Structure signature (VBOXHDDDISK_SIGNATURE). */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync uint32_t u32Signature;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /** Number of opened images. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync unsigned cImages;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /** Base image. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync PVDIMAGE pBase;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /** Last opened image in the chain.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * The same as pBase if only one image is used. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync PVDIMAGE pLast;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /** Flags representing the modification state. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync unsigned uModified;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /** Cached size of this disk. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync uint64_t cbSize;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /** Cached PCHS geometry for this disk. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync PDMMEDIAGEOMETRY PCHSGeometry;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /** Cached LCHS geometry for this disk. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync PDMMEDIAGEOMETRY LCHSGeometry;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /** Pointer to list of VD interfaces, per-disk. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync PVDINTERFACE pVDIfsDisk;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /** Pointer to the common interface structure for error reporting. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync PVDINTERFACE pInterfaceError;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /** Pointer to the error interface we use if available. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync PVDINTERFACEERROR pInterfaceErrorCallbacks;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync};
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync/**
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * VBox parent read descriptor, used internally for compaction.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync */
e99772f9bf09219c532812c859fbeea513c67e65vboxsynctypedef struct VDPARENTSTATEDESC
e99772f9bf09219c532812c859fbeea513c67e65vboxsync{
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /** Pointer to disk descriptor. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync PVBOXHDD pDisk;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /** Pointer to image descriptor. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync PVDIMAGE pImage;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync} VDPARENTSTATEDESC, *PVDPARENTSTATEDESC;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncextern VBOXHDDBACKEND g_RawBackend;
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncextern VBOXHDDBACKEND g_VmdkBackend;
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncextern VBOXHDDBACKEND g_VDIBackend;
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncextern VBOXHDDBACKEND g_VhdBackend;
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncextern VBOXHDDBACKEND g_ParallelsBackend;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync#ifdef VBOX_WITH_ISCSI
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncextern VBOXHDDBACKEND g_ISCSIBackend;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync#endif
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncstatic unsigned g_cBackends = 0;
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncstatic PVBOXHDDBACKEND *g_apBackends = NULL;
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncstatic PVBOXHDDBACKEND aStaticBackends[] =
e99772f9bf09219c532812c859fbeea513c67e65vboxsync{
e99772f9bf09219c532812c859fbeea513c67e65vboxsync &g_RawBackend,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync &g_VmdkBackend,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync &g_VDIBackend,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync &g_VhdBackend,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync &g_ParallelsBackend
e99772f9bf09219c532812c859fbeea513c67e65vboxsync#ifdef VBOX_WITH_ISCSI
e99772f9bf09219c532812c859fbeea513c67e65vboxsync ,&g_ISCSIBackend
e99772f9bf09219c532812c859fbeea513c67e65vboxsync#endif
e99772f9bf09219c532812c859fbeea513c67e65vboxsync};
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync/**
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * internal: add several backends.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync */
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncstatic int vdAddBackends(PVBOXHDDBACKEND *ppBackends, unsigned cBackends)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync{
e99772f9bf09219c532812c859fbeea513c67e65vboxsync PVBOXHDDBACKEND *pTmp = (PVBOXHDDBACKEND*)RTMemRealloc(g_apBackends,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync (g_cBackends + cBackends) * sizeof(PVBOXHDDBACKEND));
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (RT_UNLIKELY(!pTmp))
e99772f9bf09219c532812c859fbeea513c67e65vboxsync return VERR_NO_MEMORY;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync g_apBackends = pTmp;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync memcpy(&g_apBackends[g_cBackends], ppBackends, cBackends * sizeof(PVBOXHDDBACKEND));
e99772f9bf09219c532812c859fbeea513c67e65vboxsync g_cBackends += cBackends;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync return VINF_SUCCESS;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync}
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync/**
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * internal: add single backend.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync */
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncDECLINLINE(int) vdAddBackend(PVBOXHDDBACKEND pBackend)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync{
e99772f9bf09219c532812c859fbeea513c67e65vboxsync return vdAddBackends(&pBackend, 1);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync}
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync/**
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * internal: issue error message.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync */
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncstatic int vdError(PVBOXHDD pDisk, int rc, RT_SRC_POS_DECL,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync const char *pszFormat, ...)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync{
e99772f9bf09219c532812c859fbeea513c67e65vboxsync va_list va;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync va_start(va, pszFormat);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (pDisk->pInterfaceErrorCallbacks)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pDisk->pInterfaceErrorCallbacks->pfnError(pDisk->pInterfaceError->pvUser, rc, RT_SRC_POS_ARGS, pszFormat, va);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync va_end(va);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync return rc;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync}
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync/**
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * internal: find image format backend.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync */
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncstatic int vdFindBackend(const char *pszBackend, PCVBOXHDDBACKEND *ppBackend)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync{
e99772f9bf09219c532812c859fbeea513c67e65vboxsync int rc = VINF_SUCCESS;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync PCVBOXHDDBACKEND pBackend = NULL;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (!g_apBackends)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync VDInit();
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync for (unsigned i = 0; i < g_cBackends; i++)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (!RTStrICmp(pszBackend, g_apBackends[i]->pszBackendName))
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pBackend = g_apBackends[i];
e99772f9bf09219c532812c859fbeea513c67e65vboxsync break;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync *ppBackend = pBackend;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync return rc;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync}
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync/**
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * internal: add image structure to the end of images list.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync */
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncstatic void vdAddImageToList(PVBOXHDD pDisk, PVDIMAGE pImage)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync{
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pImage->pPrev = NULL;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pImage->pNext = NULL;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (pDisk->pBase)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync Assert(pDisk->cImages > 0);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pImage->pPrev = pDisk->pLast;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pDisk->pLast->pNext = pImage;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pDisk->pLast = pImage;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync else
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync Assert(pDisk->cImages == 0);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pDisk->pBase = pImage;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pDisk->pLast = pImage;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pDisk->cImages++;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync}
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync/**
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * internal: remove image structure from the images list.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync */
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncstatic void vdRemoveImageFromList(PVBOXHDD pDisk, PVDIMAGE pImage)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync{
e99772f9bf09219c532812c859fbeea513c67e65vboxsync Assert(pDisk->cImages > 0);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (pImage->pPrev)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pImage->pPrev->pNext = pImage->pNext;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync else
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pDisk->pBase = pImage->pNext;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (pImage->pNext)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pImage->pNext->pPrev = pImage->pPrev;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync else
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pDisk->pLast = pImage->pPrev;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pImage->pPrev = NULL;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pImage->pNext = NULL;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pDisk->cImages--;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync}
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync/**
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * internal: find image by index into the images list.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync */
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncstatic PVDIMAGE vdGetImageByNumber(PVBOXHDD pDisk, unsigned nImage)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync{
e99772f9bf09219c532812c859fbeea513c67e65vboxsync PVDIMAGE pImage = pDisk->pBase;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (nImage == VD_LAST_IMAGE)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync return pDisk->pLast;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync while (pImage && nImage)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pImage = pImage->pNext;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync nImage--;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync return pImage;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync}
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync/**
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * internal: read the specified amount of data in whatever blocks the backend
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * will give us.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync */
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncstatic int vdReadHelper(PVBOXHDD pDisk, PVDIMAGE pImage, uint64_t uOffset,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync void *pvBuf, size_t cbRead)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync{
e99772f9bf09219c532812c859fbeea513c67e65vboxsync int rc;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync size_t cbThisRead;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* Loop until all read. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync do
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* Search for image with allocated block. Do not attempt to read more
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * than the previous reads marked as valid. Otherwise this would return
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * stale data when different block sizes are used for the images. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync cbThisRead = cbRead;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync rc = VERR_VD_BLOCK_FREE;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync for (PVDIMAGE pCurrImage = pImage;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pCurrImage != NULL && rc == VERR_VD_BLOCK_FREE;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pCurrImage = pCurrImage->pPrev)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync rc = pCurrImage->Backend->pfnRead(pCurrImage->pvBackendData,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync uOffset, pvBuf, cbThisRead,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync &cbThisRead);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* No image in the chain contains the data for the block. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (rc == VERR_VD_BLOCK_FREE)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync memset(pvBuf, '\0', cbThisRead);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync rc = VINF_SUCCESS;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync cbRead -= cbThisRead;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync uOffset += cbThisRead;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pvBuf = (char *)pvBuf + cbThisRead;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync } while (cbRead != 0 && RT_SUCCESS(rc));
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync return rc;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync}
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync/**
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * internal: parent image read wrapper for compacting.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync */
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncstatic int vdParentRead(void *pvUser, uint64_t uOffset, void *pvBuf,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync size_t cbRead)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync{
e99772f9bf09219c532812c859fbeea513c67e65vboxsync PVDPARENTSTATEDESC pParentState = (PVDPARENTSTATEDESC)pvUser;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync return vdReadHelper(pParentState->pDisk, pParentState->pImage, uOffset,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pvBuf, cbRead);
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync}
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync/**
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync * internal: mark the disk as not modified.
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync */
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsyncstatic void vdResetModifiedFlag(PVBOXHDD pDisk)
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync{
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync if (pDisk->uModified & VD_IMAGE_MODIFIED_FLAG)
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync {
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync /* generate new last-modified uuid */
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync if (!(pDisk->uModified & VD_IMAGE_MODIFIED_DISABLE_UUID_UPDATE))
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync {
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync RTUUID Uuid;
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync RTUuidCreate(&Uuid);
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync pDisk->pLast->Backend->pfnSetModificationUuid(pDisk->pLast->pvBackendData,
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync &Uuid);
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync }
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync pDisk->uModified &= ~VD_IMAGE_MODIFIED_FLAG;
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync }
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync}
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync/**
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync * internal: mark the disk as modified.
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync */
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsyncstatic void vdSetModifiedFlag(PVBOXHDD pDisk)
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync{
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync pDisk->uModified |= VD_IMAGE_MODIFIED_FLAG;
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync if (pDisk->uModified & VD_IMAGE_MODIFIED_FIRST)
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync {
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync pDisk->uModified &= ~VD_IMAGE_MODIFIED_FIRST;
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync /* First modify, so create a UUID and ensure it's written to disk. */
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync vdResetModifiedFlag(pDisk);
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync if (!(pDisk->uModified | VD_IMAGE_MODIFIED_DISABLE_UUID_UPDATE))
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync pDisk->pLast->Backend->pfnFlush(pDisk->pLast->pvBackendData);
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync }
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync}
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync/**
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * internal: write a complete block (only used for diff images), taking the
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * remaining data from parent images. This implementation does not optimize
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * anything (except that it tries to read only that portions from parent
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * images that are really needed).
e99772f9bf09219c532812c859fbeea513c67e65vboxsync */
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncstatic int vdWriteHelperStandard(PVBOXHDD pDisk, PVDIMAGE pImage,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync uint64_t uOffset, size_t cbWrite,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync size_t cbThisWrite, size_t cbPreRead,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync size_t cbPostRead, const void *pvBuf,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync void *pvTmp)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync{
e99772f9bf09219c532812c859fbeea513c67e65vboxsync int rc = VINF_SUCCESS;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* Read the data that goes before the write to fill the block. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (cbPreRead)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync rc = vdReadHelper(pDisk, pImage, uOffset - cbPreRead, pvTmp,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync cbPreRead);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (RT_FAILURE(rc))
e99772f9bf09219c532812c859fbeea513c67e65vboxsync return rc;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* Copy the data to the right place in the buffer. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync memcpy((char *)pvTmp + cbPreRead, pvBuf, cbThisWrite);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* Read the data that goes after the write to fill the block. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (cbPostRead)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* If we have data to be written, use that instead of reading
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * data from the image. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync size_t cbWriteCopy;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (cbWrite > cbThisWrite)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync cbWriteCopy = RT_MIN(cbWrite - cbThisWrite, cbPostRead);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync else
e99772f9bf09219c532812c859fbeea513c67e65vboxsync cbWriteCopy = 0;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* Figure out how much we cannnot read from the image, because
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * the last block to write might exceed the nominal size of the
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * image for technical reasons. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync size_t cbFill;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (uOffset + cbThisWrite + cbPostRead > pDisk->cbSize)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync cbFill = uOffset + cbThisWrite + cbPostRead - pDisk->cbSize;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync else
e99772f9bf09219c532812c859fbeea513c67e65vboxsync cbFill = 0;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* The rest must be read from the image. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync size_t cbReadImage = cbPostRead - cbWriteCopy - cbFill;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* Now assemble the remaining data. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (cbWriteCopy)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync memcpy((char *)pvTmp + cbPreRead + cbThisWrite,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync (char *)pvBuf + cbThisWrite, cbWriteCopy);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (cbReadImage)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync rc = vdReadHelper(pDisk, pImage,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync uOffset + cbThisWrite + cbWriteCopy,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync (char *)pvTmp + cbPreRead + cbThisWrite + cbWriteCopy,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync cbReadImage);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (RT_FAILURE(rc))
e99772f9bf09219c532812c859fbeea513c67e65vboxsync return rc;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* Zero out the remainder of this block. Will never be visible, as this
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * is beyond the limit of the image. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (cbFill)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync memset((char *)pvTmp + cbPreRead + cbThisWrite + cbWriteCopy + cbReadImage,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync '\0', cbFill);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* Write the full block to the virtual disk. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync rc = pImage->Backend->pfnWrite(pImage->pvBackendData,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync uOffset - cbPreRead, pvTmp,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync cbPreRead + cbThisWrite + cbPostRead,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync NULL, &cbPreRead, &cbPostRead, 0);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync Assert(rc != VERR_VD_BLOCK_FREE);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync Assert(cbPreRead == 0);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync Assert(cbPostRead == 0);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync return rc;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync}
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync/**
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * internal: write a complete block (only used for diff images), taking the
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * remaining data from parent images. This implementation optimizes out writes
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * that do not change the data relative to the state as of the parent images.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * All backends which support differential/growing images support this.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync */
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncstatic int vdWriteHelperOptimized(PVBOXHDD pDisk, PVDIMAGE pImage,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync uint64_t uOffset, size_t cbWrite,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync size_t cbThisWrite, size_t cbPreRead,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync size_t cbPostRead, const void *pvBuf,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync void *pvTmp)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync{
e99772f9bf09219c532812c859fbeea513c67e65vboxsync size_t cbFill = 0;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync size_t cbWriteCopy = 0;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync size_t cbReadImage = 0;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync int rc;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (cbPostRead)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* Figure out how much we cannnot read from the image, because
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * the last block to write might exceed the nominal size of the
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * image for technical reasons. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (uOffset + cbThisWrite + cbPostRead > pDisk->cbSize)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync cbFill = uOffset + cbThisWrite + cbPostRead - pDisk->cbSize;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* If we have data to be written, use that instead of reading
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * data from the image. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (cbWrite > cbThisWrite)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync cbWriteCopy = RT_MIN(cbWrite - cbThisWrite, cbPostRead);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* The rest must be read from the image. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync cbReadImage = cbPostRead - cbWriteCopy - cbFill;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
b20cc298c1a3191a4e6ce780c19313117902675dvboxsync
b20cc298c1a3191a4e6ce780c19313117902675dvboxsync /* Read the entire data of the block so that we can compare whether it will
b20cc298c1a3191a4e6ce780c19313117902675dvboxsync * be modified by the write or not. */
b20cc298c1a3191a4e6ce780c19313117902675dvboxsync rc = vdReadHelper(pDisk, pImage, uOffset - cbPreRead, pvTmp,
b20cc298c1a3191a4e6ce780c19313117902675dvboxsync cbPreRead + cbThisWrite + cbPostRead - cbFill);
b20cc298c1a3191a4e6ce780c19313117902675dvboxsync if (RT_FAILURE(rc))
b20cc298c1a3191a4e6ce780c19313117902675dvboxsync return rc;
b20cc298c1a3191a4e6ce780c19313117902675dvboxsync
b20cc298c1a3191a4e6ce780c19313117902675dvboxsync /* Check if the write would modify anything in this block. */
b20cc298c1a3191a4e6ce780c19313117902675dvboxsync if ( !memcmp((char *)pvTmp + cbPreRead, pvBuf, cbThisWrite)
b20cc298c1a3191a4e6ce780c19313117902675dvboxsync && (!cbWriteCopy || !memcmp((char *)pvTmp + cbPreRead + cbThisWrite,
b20cc298c1a3191a4e6ce780c19313117902675dvboxsync (char *)pvBuf + cbThisWrite, cbWriteCopy)))
b20cc298c1a3191a4e6ce780c19313117902675dvboxsync {
b20cc298c1a3191a4e6ce780c19313117902675dvboxsync /* Block is completely unchanged, so no need to write anything. */
b20cc298c1a3191a4e6ce780c19313117902675dvboxsync return VINF_SUCCESS;
b20cc298c1a3191a4e6ce780c19313117902675dvboxsync }
b20cc298c1a3191a4e6ce780c19313117902675dvboxsync
b20cc298c1a3191a4e6ce780c19313117902675dvboxsync /* Copy the data to the right place in the buffer. */
b20cc298c1a3191a4e6ce780c19313117902675dvboxsync memcpy((char *)pvTmp + cbPreRead, pvBuf, cbThisWrite);
b20cc298c1a3191a4e6ce780c19313117902675dvboxsync
b20cc298c1a3191a4e6ce780c19313117902675dvboxsync /* Handle the data that goes after the write to fill the block. */
b20cc298c1a3191a4e6ce780c19313117902675dvboxsync if (cbPostRead)
b20cc298c1a3191a4e6ce780c19313117902675dvboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* Now assemble the remaining data. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (cbWriteCopy)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync memcpy((char *)pvTmp + cbPreRead + cbThisWrite,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync (char *)pvBuf + cbThisWrite, cbWriteCopy);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* Zero out the remainder of this block. Will never be visible, as this
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * is beyond the limit of the image. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (cbFill)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync memset((char *)pvTmp + cbPreRead + cbThisWrite + cbWriteCopy + cbReadImage,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync '\0', cbFill);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* Write the full block to the virtual disk. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync rc = pImage->Backend->pfnWrite(pImage->pvBackendData,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync uOffset - cbPreRead, pvTmp,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync cbPreRead + cbThisWrite + cbPostRead,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync NULL, &cbPreRead, &cbPostRead, 0);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync Assert(rc != VERR_VD_BLOCK_FREE);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync Assert(cbPreRead == 0);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync Assert(cbPostRead == 0);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync return rc;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync}
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync/**
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * internal: write buffer to the image, taking care of block boundaries and
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * write optimizations.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync */
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncstatic int vdWriteHelper(PVBOXHDD pDisk, PVDIMAGE pImage, uint64_t uOffset,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync const void *pvBuf, size_t cbWrite)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync{
e99772f9bf09219c532812c859fbeea513c67e65vboxsync int rc;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync unsigned fWrite;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync size_t cbThisWrite;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync size_t cbPreRead, cbPostRead;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* Loop until all written. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync do
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* Try to write the possibly partial block to the last opened image.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * This works when the block is already allocated in this image or
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * if it is a full-block write (and allocation isn't suppressed below).
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * For image formats which don't support zero blocks, it's beneficial
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * to avoid unnecessarily allocating unchanged blocks. This prevents
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * unwanted expanding of images. VMDK is an example. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync cbThisWrite = cbWrite;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync fWrite = (pImage->uOpenFlags & VD_OPEN_FLAGS_HONOR_SAME)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync ? 0 : VD_WRITE_NO_ALLOC;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync rc = pImage->Backend->pfnWrite(pImage->pvBackendData, uOffset, pvBuf,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync cbThisWrite, &cbThisWrite, &cbPreRead,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync &cbPostRead, fWrite);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (rc == VERR_VD_BLOCK_FREE)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync void *pvTmp = RTMemTmpAlloc(cbPreRead + cbThisWrite + cbPostRead);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync AssertBreakStmt(VALID_PTR(pvTmp), rc = VERR_NO_MEMORY);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (!(pImage->uOpenFlags & VD_OPEN_FLAGS_HONOR_SAME))
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* Optimized write, suppress writing to a so far unallocated
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * block if the data is in fact not changed. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync rc = vdWriteHelperOptimized(pDisk, pImage, uOffset, cbWrite,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync cbThisWrite, cbPreRead, cbPostRead,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pvBuf, pvTmp);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync else
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* Normal write, not optimized in any way. The block will
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * be written no matter what. This will usually (unless the
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * backend has some further optimization enabled) cause the
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * block to be allocated. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync rc = vdWriteHelperStandard(pDisk, pImage, uOffset, cbWrite,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync cbThisWrite, cbPreRead, cbPostRead,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pvBuf, pvTmp);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync RTMemTmpFree(pvTmp);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (RT_FAILURE(rc))
e99772f9bf09219c532812c859fbeea513c67e65vboxsync break;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync cbWrite -= cbThisWrite;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync uOffset += cbThisWrite;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pvBuf = (char *)pvBuf + cbThisWrite;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync } while (cbWrite != 0 && RT_SUCCESS(rc));
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync return rc;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync}
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync/**
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * internal: scans plugin directory and loads the backends have been found.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync */
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncstatic int vdLoadDynamicBackends()
e99772f9bf09219c532812c859fbeea513c67e65vboxsync{
e99772f9bf09219c532812c859fbeea513c67e65vboxsync int rc = VINF_SUCCESS;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync PRTDIR pPluginDir = NULL;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* Enumerate plugin backends. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync char szPath[RTPATH_MAX];
e99772f9bf09219c532812c859fbeea513c67e65vboxsync rc = RTPathAppPrivateArch(szPath, sizeof(szPath));
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (RT_FAILURE(rc))
e99772f9bf09219c532812c859fbeea513c67e65vboxsync return rc;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* To get all entries with VBoxHDD as prefix. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync char *pszPluginFilter;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync rc = RTStrAPrintf(&pszPluginFilter, "%s/%s*", szPath,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync VBOX_HDDFORMAT_PLUGIN_PREFIX);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (RT_FAILURE(rc))
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync rc = VERR_NO_MEMORY;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync return rc;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync PRTDIRENTRYEX pPluginDirEntry = NULL;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync size_t cbPluginDirEntry = sizeof(RTDIRENTRYEX);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* The plugins are in the same directory as the other shared libs. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync rc = RTDirOpenFiltered(&pPluginDir, pszPluginFilter, RTDIRFILTER_WINNT);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (RT_FAILURE(rc))
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* On Windows the above immediately signals that there are no
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * files matching, while on other platforms enumerating the
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * files below fails. Either way: no plugins. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync goto out;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pPluginDirEntry = (PRTDIRENTRYEX)RTMemAllocZ(sizeof(RTDIRENTRYEX));
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (!pPluginDirEntry)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync rc = VERR_NO_MEMORY;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync goto out;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync while ((rc = RTDirReadEx(pPluginDir, pPluginDirEntry, &cbPluginDirEntry, RTFSOBJATTRADD_NOTHING)) != VERR_NO_MORE_FILES)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync RTLDRMOD hPlugin = NIL_RTLDRMOD;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync PFNVBOXHDDFORMATLOAD pfnHDDFormatLoad = NULL;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync PVBOXHDDBACKEND pBackend = NULL;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync char *pszPluginPath = NULL;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (rc == VERR_BUFFER_OVERFLOW)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* allocate new buffer. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync RTMemFree(pPluginDirEntry);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pPluginDirEntry = (PRTDIRENTRYEX)RTMemAllocZ(cbPluginDirEntry);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* Retry. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync rc = RTDirReadEx(pPluginDir, pPluginDirEntry, &cbPluginDirEntry, RTFSOBJATTRADD_NOTHING);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (RT_FAILURE(rc))
e99772f9bf09219c532812c859fbeea513c67e65vboxsync break;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync else if (RT_FAILURE(rc))
e99772f9bf09219c532812c859fbeea513c67e65vboxsync break;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* We got the new entry. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (!RTFS_IS_FILE(pPluginDirEntry->Info.Attr.fMode))
e99772f9bf09219c532812c859fbeea513c67e65vboxsync continue;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* Prepend the path to the libraries. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync rc = RTStrAPrintf(&pszPluginPath, "%s/%s", szPath, pPluginDirEntry->szName);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (RT_FAILURE(rc))
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync rc = VERR_NO_MEMORY;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync break;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync rc = SUPR3HardenedLdrLoad(pszPluginPath, &hPlugin);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (RT_SUCCESS(rc))
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync rc = RTLdrGetSymbol(hPlugin, VBOX_HDDFORMAT_LOAD_NAME, (void**)&pfnHDDFormatLoad);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (RT_FAILURE(rc) || !pfnHDDFormatLoad)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync LogFunc(("error resolving the entry point %s in plugin %s, rc=%Rrc, pfnHDDFormat=%#p\n", VBOX_HDDFORMAT_LOAD_NAME, pPluginDirEntry->szName, rc, pfnHDDFormatLoad));
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (RT_SUCCESS(rc))
e99772f9bf09219c532812c859fbeea513c67e65vboxsync rc = VERR_SYMBOL_NOT_FOUND;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (RT_SUCCESS(rc))
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* Get the function table. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync rc = pfnHDDFormatLoad(&pBackend);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (RT_SUCCESS(rc) && pBackend->cbSize == sizeof(VBOXHDDBACKEND))
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pBackend->hPlugin = hPlugin;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync vdAddBackend(pBackend);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync else
e99772f9bf09219c532812c859fbeea513c67e65vboxsync LogFunc(("ignored plugin '%s': pBackend->cbSize=%d rc=%Rrc\n", pszPluginPath, pBackend->cbSize, rc));
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync else
e99772f9bf09219c532812c859fbeea513c67e65vboxsync LogFunc(("ignored plugin '%s': rc=%Rrc\n", pszPluginPath, rc));
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (RT_FAILURE(rc))
e99772f9bf09219c532812c859fbeea513c67e65vboxsync RTLdrClose(hPlugin);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync RTStrFree(pszPluginPath);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncout:
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (rc == VERR_NO_MORE_FILES)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync rc = VINF_SUCCESS;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync RTStrFree(pszPluginFilter);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (pPluginDirEntry)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync RTMemFree(pPluginDirEntry);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (pPluginDir)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync RTDirClose(pPluginDir);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync return rc;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync}
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync/**
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * internal: send output to the log (unconditionally).
e99772f9bf09219c532812c859fbeea513c67e65vboxsync */
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncint vdLogMessage(void *pvUser, const char *pszFormat, ...)
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync{
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync NOREF(pvUser);
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync va_list args;
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync va_start(args, pszFormat);
b20cc298c1a3191a4e6ce780c19313117902675dvboxsync RTLogPrintf(pszFormat, args);
768888227f95954ce8676ae279645fae10e24ba2vboxsync va_end(args);
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync return VINF_SUCCESS;
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync}
768888227f95954ce8676ae279645fae10e24ba2vboxsync
768888227f95954ce8676ae279645fae10e24ba2vboxsync
768888227f95954ce8676ae279645fae10e24ba2vboxsync/**
768888227f95954ce8676ae279645fae10e24ba2vboxsync * Initializes HDD backends.
768888227f95954ce8676ae279645fae10e24ba2vboxsync *
768888227f95954ce8676ae279645fae10e24ba2vboxsync * @returns VBox status code.
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsync */
62b88df0b51ed81807d485b371b90aff7dfd7beevboxsyncVBOXDDU_DECL(int) VDInit(void)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync{
e99772f9bf09219c532812c859fbeea513c67e65vboxsync int rc = vdAddBackends(aStaticBackends, RT_ELEMENTS(aStaticBackends));
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync if (RT_SUCCESS(rc))
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync rc = vdLoadDynamicBackends();
b20cc298c1a3191a4e6ce780c19313117902675dvboxsync LogRel(("VDInit finished\n"));
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync return rc;
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync}
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync/**
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync * Destroys loaded HDD backends.
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync *
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync * @returns VBox status code.
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync */
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsyncVBOXDDU_DECL(int) VDShutdown(void)
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync{
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync PVBOXHDDBACKEND *pBackends = g_apBackends;
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync unsigned cBackends = g_cBackends;
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync if (!pBackends)
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync return VERR_INTERNAL_ERROR;
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync g_cBackends = 0;
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync g_apBackends = NULL;
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync for (unsigned i = 0; i < cBackends; i++)
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync if (pBackends[i]->hPlugin != NIL_RTLDRMOD)
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync RTLdrClose(pBackends[i]->hPlugin);
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync RTMemFree(pBackends);
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync return VINF_SUCCESS;
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync}
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync/**
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync * Lists all HDD backends and their capabilities in a caller-provided buffer.
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync *
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync * @todo this code contains memory leaks, inconsistent (and probably buggy)
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync * allocation, and it lacks documentation what the caller needs to free.
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync *
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync * @returns VBox status code.
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync * VERR_BUFFER_OVERFLOW if not enough space is passed.
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync * @param cEntriesAlloc Number of list entries available.
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync * @param pEntries Pointer to array for the entries.
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync * @param pcEntriesUsed Number of entries returned.
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync */
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsyncVBOXDDU_DECL(int) VDBackendInfo(unsigned cEntriesAlloc, PVDBACKENDINFO pEntries,
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync unsigned *pcEntriesUsed)
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync{
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync int rc = VINF_SUCCESS;
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync PRTDIR pPluginDir = NULL;
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync unsigned cEntries = 0;
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync LogFlowFunc(("cEntriesAlloc=%u pEntries=%#p pcEntriesUsed=%#p\n", cEntriesAlloc, pEntries, pcEntriesUsed));
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync /* Check arguments. */
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync AssertMsgReturn(cEntriesAlloc,
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync ("cEntriesAlloc=%u\n", cEntriesAlloc),
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync VERR_INVALID_PARAMETER);
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync AssertMsgReturn(VALID_PTR(pEntries),
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync ("pEntries=%#p\n", pEntries),
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync VERR_INVALID_PARAMETER);
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync AssertMsgReturn(VALID_PTR(pcEntriesUsed),
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync ("pcEntriesUsed=%#p\n", pcEntriesUsed),
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync VERR_INVALID_PARAMETER);
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync if (!g_apBackends)
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync VDInit();
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync if (cEntriesAlloc < g_cBackends)
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync {
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync *pcEntriesUsed = g_cBackends;
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync return VERR_BUFFER_OVERFLOW;
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync }
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync for (unsigned i = 0; i < g_cBackends; i++)
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync {
5c4d7e2aae42bbf39793dfa686925f076a56b4d5vboxsync pEntries[i].pszBackend = g_apBackends[i]->pszBackendName;
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync pEntries[i].uBackendCaps = g_apBackends[i]->uBackendCaps;
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync pEntries[i].papszFileExtensions = g_apBackends[i]->papszFileExtensions;
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync pEntries[i].paConfigInfo = g_apBackends[i]->paConfigInfo;
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync pEntries[i].pfnComposeLocation = g_apBackends[i]->pfnComposeLocation;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pEntries[i].pfnComposeName = g_apBackends[i]->pfnComposeName;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync LogFlowFunc(("returns %Rrc *pcEntriesUsed=%u\n", rc, cEntries));
e99772f9bf09219c532812c859fbeea513c67e65vboxsync *pcEntriesUsed = g_cBackends;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync return rc;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync}
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync/**
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * Lists the capablities of a backend indentified by its name.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * Free all returned names with RTStrFree() when you no longer need them.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync *
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * @returns VBox status code.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * @param pszBackend The backend name.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * @param pEntries Pointer to an entry.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync */
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncVBOXDDU_DECL(int) VDBackendInfoOne(const char *pszBackend, PVDBACKENDINFO pEntry)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync{
e99772f9bf09219c532812c859fbeea513c67e65vboxsync LogFlowFunc(("pszBackend=%#p pEntry=%#p\n", pszBackend, pEntry));
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* Check arguments. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync AssertMsgReturn(VALID_PTR(pszBackend),
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync ("pszBackend=%#p\n", pszBackend),
e99772f9bf09219c532812c859fbeea513c67e65vboxsync VERR_INVALID_PARAMETER);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync AssertMsgReturn(VALID_PTR(pEntry),
e99772f9bf09219c532812c859fbeea513c67e65vboxsync ("pEntry=%#p\n", pEntry),
e99772f9bf09219c532812c859fbeea513c67e65vboxsync VERR_INVALID_PARAMETER);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (!g_apBackends)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync VDInit();
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
0c69348b58bb8eabb1bea8867ee932b667bd0d34vboxsync /* Go through loaded backends. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync for (unsigned i = 0; i < g_cBackends; i++)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (!RTStrICmp(pszBackend, g_apBackends[i]->pszBackendName))
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pEntry->pszBackend = g_apBackends[i]->pszBackendName;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pEntry->uBackendCaps = g_apBackends[i]->uBackendCaps;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pEntry->papszFileExtensions = g_apBackends[i]->papszFileExtensions;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pEntry->paConfigInfo = g_apBackends[i]->paConfigInfo;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync return VINF_SUCCESS;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync return VERR_NOT_FOUND;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync}
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync/**
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * Allocates and initializes an empty HDD container.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * No image files are opened.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync *
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * @returns VBox status code.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * @param pVDIfsDisk Pointer to the per-disk VD interface list.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * @param ppDisk Where to store the reference to HDD container.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync */
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncVBOXDDU_DECL(int) VDCreate(PVDINTERFACE pVDIfsDisk, PVBOXHDD *ppDisk)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync{
e99772f9bf09219c532812c859fbeea513c67e65vboxsync int rc = VINF_SUCCESS;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync PVBOXHDD pDisk = NULL;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync LogFlowFunc(("pVDIfsDisk=%#p\n", pVDIfsDisk));
e99772f9bf09219c532812c859fbeea513c67e65vboxsync do
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* Check arguments. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync AssertMsgBreakStmt(VALID_PTR(ppDisk),
e99772f9bf09219c532812c859fbeea513c67e65vboxsync ("ppDisk=%#p\n", ppDisk),
e99772f9bf09219c532812c859fbeea513c67e65vboxsync rc = VERR_INVALID_PARAMETER);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pDisk = (PVBOXHDD)RTMemAllocZ(sizeof(VBOXHDD));
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (pDisk)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pDisk->u32Signature = VBOXHDDDISK_SIGNATURE;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pDisk->cImages = 0;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pDisk->pBase = NULL;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pDisk->pLast = NULL;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pDisk->cbSize = 0;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pDisk->PCHSGeometry.cCylinders = 0;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pDisk->PCHSGeometry.cHeads = 0;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pDisk->PCHSGeometry.cSectors = 0;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pDisk->LCHSGeometry.cCylinders = 0;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pDisk->LCHSGeometry.cHeads = 0;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pDisk->LCHSGeometry.cSectors = 0;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pDisk->pVDIfsDisk = pVDIfsDisk;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pDisk->pInterfaceError = NULL;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pDisk->pInterfaceErrorCallbacks = NULL;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pDisk->pInterfaceError = VDInterfaceGet(pVDIfsDisk, VDINTERFACETYPE_ERROR);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (pDisk->pInterfaceError)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pDisk->pInterfaceErrorCallbacks = VDGetInterfaceError(pDisk->pInterfaceError);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync *ppDisk = pDisk;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync else
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync rc = VERR_NO_MEMORY;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync break;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync } while (0);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync LogFlowFunc(("returns %Rrc (pDisk=%#p)\n", rc, pDisk));
e99772f9bf09219c532812c859fbeea513c67e65vboxsync return rc;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync}
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync/**
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * Destroys HDD container.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * If container has opened image files they will be closed.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync *
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * @param pDisk Pointer to HDD container.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync */
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncVBOXDDU_DECL(void) VDDestroy(PVBOXHDD pDisk)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync{
e99772f9bf09219c532812c859fbeea513c67e65vboxsync LogFlowFunc(("pDisk=%#p\n", pDisk));
e99772f9bf09219c532812c859fbeea513c67e65vboxsync do
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* sanity check */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync AssertPtrBreak(pDisk);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync AssertMsg(pDisk->u32Signature == VBOXHDDDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
e99772f9bf09219c532812c859fbeea513c67e65vboxsync VDCloseAll(pDisk);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync RTMemFree(pDisk);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync } while (0);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync LogFlowFunc(("returns\n"));
e99772f9bf09219c532812c859fbeea513c67e65vboxsync}
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync/**
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * Try to get the backend name which can use this image.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync *
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * @returns VBox status code.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * VINF_SUCCESS if a plugin was found.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * ppszFormat contains the string which can be used as backend name.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * VERR_NOT_SUPPORTED if no backend was found.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * @param pszFilename Name of the image file for which the backend is queried.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * @param ppszFormat Receives pointer of the UTF-8 string which contains the format name.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * The returned pointer must be freed using RTStrFree().
e99772f9bf09219c532812c859fbeea513c67e65vboxsync */
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncVBOXDDU_DECL(int) VDGetFormat(const char *pszFilename, char **ppszFormat)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync{
e99772f9bf09219c532812c859fbeea513c67e65vboxsync int rc = VERR_NOT_SUPPORTED;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync LogFlowFunc(("pszFilename=\"%s\"\n", pszFilename));
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* Check arguments. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync AssertMsgReturn(VALID_PTR(pszFilename) && *pszFilename,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync ("pszFilename=%#p \"%s\"\n", pszFilename, pszFilename),
e99772f9bf09219c532812c859fbeea513c67e65vboxsync VERR_INVALID_PARAMETER);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync AssertMsgReturn(VALID_PTR(ppszFormat),
e99772f9bf09219c532812c859fbeea513c67e65vboxsync ("ppszFormat=%#p\n", ppszFormat),
e99772f9bf09219c532812c859fbeea513c67e65vboxsync VERR_INVALID_PARAMETER);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (!g_apBackends)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync VDInit();
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* Find the backend supporting this file format. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync for (unsigned i = 0; i < g_cBackends; i++)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (g_apBackends[i]->pfnCheckIfValid)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync rc = g_apBackends[i]->pfnCheckIfValid(pszFilename);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if ( RT_SUCCESS(rc)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* The correct backend has been found, but there is a small
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * incompatibility so that the file cannot be used. Stop here
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * and signal success - the actual open will of course fail,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * but that will create a really sensible error message. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync || ( rc != VERR_VD_GEN_INVALID_HEADER
e99772f9bf09219c532812c859fbeea513c67e65vboxsync && rc != VERR_VD_VDI_INVALID_HEADER
e99772f9bf09219c532812c859fbeea513c67e65vboxsync && rc != VERR_VD_VMDK_INVALID_HEADER
e99772f9bf09219c532812c859fbeea513c67e65vboxsync && rc != VERR_VD_ISCSI_INVALID_HEADER
e99772f9bf09219c532812c859fbeea513c67e65vboxsync && rc != VERR_VD_VHD_INVALID_HEADER
e99772f9bf09219c532812c859fbeea513c67e65vboxsync && rc != VERR_VD_RAW_INVALID_HEADER))
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* Copy the name into the new string. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync char *pszFormat = RTStrDup(g_apBackends[i]->pszBackendName);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (!pszFormat)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync rc = VERR_NO_MEMORY;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync break;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync *ppszFormat = pszFormat;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync rc = VINF_SUCCESS;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync break;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync rc = VERR_NOT_SUPPORTED;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync LogFlowFunc(("returns %Rrc *ppszFormat=\"%s\"\n", rc, *ppszFormat));
e99772f9bf09219c532812c859fbeea513c67e65vboxsync return rc;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync}
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync/**
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * Opens an image file.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync *
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * The first opened image file in HDD container must have a base image type,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * others (next opened images) must be a differencing or undo images.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * Linkage is checked for differencing image to be in consistence with the previously opened image.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * When another differencing image is opened and the last image was opened in read/write access
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * mode, then the last image is reopened in read-only with deny write sharing mode. This allows
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * other processes to use images in read-only mode too.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync *
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * Note that the image is opened in read-only mode if a read/write open is not possible.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * Use VDIsReadOnly to check open mode.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync *
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * @returns VBox status code.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * @param pDisk Pointer to HDD container.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * @param pszBackend Name of the image file backend to use.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * @param pszFilename Name of the image file to open.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * @param uOpenFlags Image file open mode, see VD_OPEN_FLAGS_* constants.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * @param pVDIfsImage Pointer to the per-image VD interface list.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync */
e99772f9bf09219c532812c859fbeea513c67e65vboxsyncVBOXDDU_DECL(int) VDOpen(PVBOXHDD pDisk, const char *pszBackend,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync const char *pszFilename, unsigned uOpenFlags,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync PVDINTERFACE pVDIfsImage)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync{
e99772f9bf09219c532812c859fbeea513c67e65vboxsync int rc = VINF_SUCCESS;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync PVDIMAGE pImage = NULL;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync LogFlowFunc(("pDisk=%#p pszBackend=\"%s\" pszFilename=\"%s\" uOpenFlags=%#x, pVDIfsImage=%#p\n",
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pDisk, pszBackend, pszFilename, uOpenFlags, pVDIfsImage));
e99772f9bf09219c532812c859fbeea513c67e65vboxsync do
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* sanity check */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync AssertPtrBreakStmt(pDisk, rc = VERR_INVALID_PARAMETER);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync AssertMsg(pDisk->u32Signature == VBOXHDDDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* Check arguments. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync AssertMsgBreakStmt(VALID_PTR(pszBackend) && *pszBackend,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync ("pszBackend=%#p \"%s\"\n", pszBackend, pszBackend),
e99772f9bf09219c532812c859fbeea513c67e65vboxsync rc = VERR_INVALID_PARAMETER);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync AssertMsgBreakStmt(VALID_PTR(pszFilename) && *pszFilename,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync ("pszFilename=%#p \"%s\"\n", pszFilename, pszFilename),
e99772f9bf09219c532812c859fbeea513c67e65vboxsync rc = VERR_INVALID_PARAMETER);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync AssertMsgBreakStmt((uOpenFlags & ~VD_OPEN_FLAGS_MASK) == 0,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync ("uOpenFlags=%#x\n", uOpenFlags),
e99772f9bf09219c532812c859fbeea513c67e65vboxsync rc = VERR_INVALID_PARAMETER);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* Set up image descriptor. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pImage = (PVDIMAGE)RTMemAllocZ(sizeof(VDIMAGE));
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (!pImage)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync rc = VERR_NO_MEMORY;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync break;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pImage->pszFilename = RTStrDup(pszFilename);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (!pImage->pszFilename)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync rc = VERR_NO_MEMORY;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync break;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pImage->pVDIfsImage = pVDIfsImage;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync rc = vdFindBackend(pszBackend, &pImage->Backend);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (RT_FAILURE(rc))
e99772f9bf09219c532812c859fbeea513c67e65vboxsync break;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (!pImage->Backend)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync rc = vdError(pDisk, VERR_INVALID_PARAMETER, RT_SRC_POS,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync N_("VD: unknown backend name '%s'"), pszBackend);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync break;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pImage->uOpenFlags = uOpenFlags & VD_OPEN_FLAGS_HONOR_SAME;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync rc = pImage->Backend->pfnOpen(pImage->pszFilename,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync uOpenFlags & ~VD_OPEN_FLAGS_HONOR_SAME,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pDisk->pVDIfsDisk,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pImage->pVDIfsImage,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync &pImage->pvBackendData);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* If the open in read-write mode failed, retry in read-only mode. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (RT_FAILURE(rc))
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (!(uOpenFlags & VD_OPEN_FLAGS_READONLY)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync && (rc == VERR_ACCESS_DENIED
e99772f9bf09219c532812c859fbeea513c67e65vboxsync || rc == VERR_PERMISSION_DENIED
e99772f9bf09219c532812c859fbeea513c67e65vboxsync || rc == VERR_WRITE_PROTECT
e99772f9bf09219c532812c859fbeea513c67e65vboxsync || rc == VERR_SHARING_VIOLATION
e99772f9bf09219c532812c859fbeea513c67e65vboxsync || rc == VERR_FILE_LOCK_FAILED))
e99772f9bf09219c532812c859fbeea513c67e65vboxsync rc = pImage->Backend->pfnOpen(pImage->pszFilename,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync (uOpenFlags & ~VD_OPEN_FLAGS_HONOR_SAME)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync | VD_OPEN_FLAGS_READONLY,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pDisk->pVDIfsDisk,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pImage->pVDIfsImage,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync &pImage->pvBackendData);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (RT_FAILURE(rc))
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
66b58af085e22ee26be57f98127fb49ee2e91790vboxsync rc = vdError(pDisk, rc, RT_SRC_POS,
66b58af085e22ee26be57f98127fb49ee2e91790vboxsync N_("VD: error opening image file '%s'"), pszFilename);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync break;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync unsigned uImageFlags;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync uImageFlags = pImage->Backend->pfnGetImageFlags(pImage->pvBackendData);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* Check image type. As the image itself has only partial knowledge
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * whether it's a base image or not, this info is derived here. The
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * base image can be fixed or normal, all others must be normal or
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * diff images. Some image formats don't distinguish between normal
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * and diff images, so this must be corrected here. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (RT_FAILURE(rc))
e99772f9bf09219c532812c859fbeea513c67e65vboxsync uImageFlags = VD_IMAGE_FLAGS_NONE;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if ( RT_SUCCESS(rc)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync && !(uOpenFlags & VD_OPEN_FLAGS_INFO))
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if ( pDisk->cImages == 0
e99772f9bf09219c532812c859fbeea513c67e65vboxsync && (uImageFlags & VD_IMAGE_FLAGS_DIFF))
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync rc = VERR_VD_INVALID_TYPE;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync break;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync else if (pDisk->cImages != 0)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (uImageFlags & VD_IMAGE_FLAGS_FIXED)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync rc = VERR_VD_INVALID_TYPE;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync break;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync else
e99772f9bf09219c532812c859fbeea513c67e65vboxsync uImageFlags |= VD_IMAGE_FLAGS_DIFF;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pImage->uImageFlags = uImageFlags;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* Force sane optimization settings. It's not worth avoiding writes
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * to fixed size images. The overhead would have almost no payback. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (uImageFlags & VD_IMAGE_FLAGS_FIXED)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pImage->uOpenFlags |= VD_OPEN_FLAGS_HONOR_SAME;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /** @todo optionally check UUIDs */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync int rc2;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* Cache disk information. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pDisk->cbSize = pImage->Backend->pfnGetSize(pImage->pvBackendData);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* Cache PCHS geometry. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync rc2 = pImage->Backend->pfnGetPCHSGeometry(pImage->pvBackendData,
e99772f9bf09219c532812c859fbeea513c67e65vboxsync &pDisk->PCHSGeometry);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (RT_FAILURE(rc2))
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pDisk->PCHSGeometry.cCylinders = 0;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pDisk->PCHSGeometry.cHeads = 0;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pDisk->PCHSGeometry.cSectors = 0;
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync }
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync else
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync {
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync /* Make sure the PCHS geometry is properly clipped. */
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync pDisk->PCHSGeometry.cCylinders = RT_MIN(pDisk->PCHSGeometry.cCylinders, 16383);
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync pDisk->PCHSGeometry.cHeads = RT_MIN(pDisk->PCHSGeometry.cHeads, 16);
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync pDisk->PCHSGeometry.cSectors = RT_MIN(pDisk->PCHSGeometry.cSectors, 63);
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync }
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync /* Cache LCHS geometry. */
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync rc2 = pImage->Backend->pfnGetLCHSGeometry(pImage->pvBackendData,
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync &pDisk->LCHSGeometry);
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync if (RT_FAILURE(rc2))
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync {
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync pDisk->LCHSGeometry.cCylinders = 0;
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync pDisk->LCHSGeometry.cHeads = 0;
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync pDisk->LCHSGeometry.cSectors = 0;
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync }
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync else
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync {
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync /* Make sure the LCHS geometry is properly clipped. */
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync pDisk->LCHSGeometry.cHeads = RT_MIN(pDisk->LCHSGeometry.cHeads, 255);
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync pDisk->LCHSGeometry.cSectors = RT_MIN(pDisk->LCHSGeometry.cSectors, 63);
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync }
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync if (pDisk->cImages != 0)
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync {
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync /* Switch previous image to read-only mode. */
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync unsigned uOpenFlagsPrevImg;
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync uOpenFlagsPrevImg = pDisk->pLast->Backend->pfnGetOpenFlags(pDisk->pLast->pvBackendData);
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync if (!(uOpenFlagsPrevImg & VD_OPEN_FLAGS_READONLY))
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync {
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync uOpenFlagsPrevImg |= VD_OPEN_FLAGS_READONLY;
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync rc = pDisk->pLast->Backend->pfnSetOpenFlags(pDisk->pLast->pvBackendData, uOpenFlagsPrevImg);
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync }
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync }
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync if (RT_SUCCESS(rc))
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync {
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync /* Image successfully opened, make it the last image. */
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync vdAddImageToList(pDisk, pImage);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (!(uOpenFlags & VD_OPEN_FLAGS_READONLY))
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pDisk->uModified = VD_IMAGE_MODIFIED_FIRST;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync else
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync /* Error detected, but image opened. Close image. */
e99772f9bf09219c532812c859fbeea513c67e65vboxsync int rc2;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync rc2 = pImage->Backend->pfnClose(pImage->pvBackendData, false);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync AssertRC(rc2);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync pImage->pvBackendData = NULL;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync } while (0);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (RT_FAILURE(rc))
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (pImage)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync {
e99772f9bf09219c532812c859fbeea513c67e65vboxsync if (pImage->pszFilename)
e99772f9bf09219c532812c859fbeea513c67e65vboxsync RTStrFree(pImage->pszFilename);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync RTMemFree(pImage);
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync }
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync LogFlowFunc(("returns %Rrc\n", rc));
e99772f9bf09219c532812c859fbeea513c67e65vboxsync return rc;
e99772f9bf09219c532812c859fbeea513c67e65vboxsync}
e99772f9bf09219c532812c859fbeea513c67e65vboxsync
e99772f9bf09219c532812c859fbeea513c67e65vboxsync/**
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * Creates and opens a new base image file.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync *
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * @returns VBox status code.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * @param pDisk Pointer to HDD container.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * @param pszBackend Name of the image file backend to use.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * @param pszFilename Name of the image file to create.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * @param cbSize Image size in bytes.
e99772f9bf09219c532812c859fbeea513c67e65vboxsync * @param uImageFlags Flags specifying special image features.
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync * @param pszComment Pointer to image comment. NULL is ok.
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync * @param pPCHSGeometry Pointer to physical disk geometry <= (16383,16,63). Not NULL.
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync * @param pLCHSGeometry Pointer to logical disk geometry <= (x,255,63). Not NULL.
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync * @param pUuid New UUID of the image. If NULL, a new UUID is created.
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync * @param uOpenFlags Image file open mode, see VD_OPEN_FLAGS_* constants.
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync * @param pVDIfsImage Pointer to the per-image VD interface list.
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync * @param pVDIfsOperation Pointer to the per-operation VD interface list.
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync */
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsyncVBOXDDU_DECL(int) VDCreateBase(PVBOXHDD pDisk, const char *pszBackend,
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync const char *pszFilename, uint64_t cbSize,
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync unsigned uImageFlags, const char *pszComment,
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync PCPDMMEDIAGEOMETRY pPCHSGeometry,
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync PCPDMMEDIAGEOMETRY pLCHSGeometry,
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync PCRTUUID pUuid, unsigned uOpenFlags,
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync PVDINTERFACE pVDIfsImage,
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync PVDINTERFACE pVDIfsOperation)
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync{
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync int rc = VINF_SUCCESS;
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync PVDIMAGE pImage = NULL;
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync RTUUID uuid;
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync LogFlowFunc(("pDisk=%#p pszBackend=\"%s\" pszFilename=\"%s\" cbSize=%llu uImageFlags=%#x pszComment=\"%s\" PCHS=%u/%u/%u LCHS=%u/%u/%u Uuid=%RTuuid uOpenFlags=%#x pVDIfsImage=%#p pVDIfsOperation=%#p\n",
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync pDisk, pszBackend, pszFilename, cbSize, uImageFlags, pszComment,
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync pPCHSGeometry->cCylinders, pPCHSGeometry->cHeads,
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync pPCHSGeometry->cSectors, pLCHSGeometry->cCylinders,
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync pLCHSGeometry->cHeads, pLCHSGeometry->cSectors, pUuid,
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync uOpenFlags, pVDIfsImage, pVDIfsOperation));
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync PVDINTERFACE pIfProgress = VDInterfaceGet(pVDIfsOperation,
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync VDINTERFACETYPE_PROGRESS);
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync PVDINTERFACEPROGRESS pCbProgress = NULL;
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync if (pIfProgress)
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync pCbProgress = VDGetInterfaceProgress(pIfProgress);
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync do
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync {
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync /* sanity check */
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync AssertPtrBreakStmt(pDisk, rc = VERR_INVALID_PARAMETER);
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync AssertMsg(pDisk->u32Signature == VBOXHDDDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync /* Check arguments. */
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync AssertMsgBreakStmt(VALID_PTR(pszBackend) && *pszBackend,
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync ("pszBackend=%#p \"%s\"\n", pszBackend, pszBackend),
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync rc = VERR_INVALID_PARAMETER);
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync AssertMsgBreakStmt(VALID_PTR(pszFilename) && *pszFilename,
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync ("pszFilename=%#p \"%s\"\n", pszFilename, pszFilename),
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync rc = VERR_INVALID_PARAMETER);
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync AssertMsgBreakStmt(cbSize,
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync ("cbSize=%llu\n", cbSize),
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync rc = VERR_INVALID_PARAMETER);
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync AssertMsgBreakStmt( ((uImageFlags & ~VD_IMAGE_FLAGS_MASK) == 0)
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync || ((uImageFlags & (VD_IMAGE_FLAGS_FIXED | VD_IMAGE_FLAGS_DIFF)) != VD_IMAGE_FLAGS_FIXED),
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync ("uImageFlags=%#x\n", uImageFlags),
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync rc = VERR_INVALID_PARAMETER);
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync /* The PCHS geometry fields may be 0 to leave it for later. */
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync AssertMsgBreakStmt( VALID_PTR(pPCHSGeometry)
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync && pPCHSGeometry->cHeads <= 16
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync && pPCHSGeometry->cSectors <= 63,
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync ("pPCHSGeometry=%#p PCHS=%u/%u/%u\n", pPCHSGeometry,
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync pPCHSGeometry->cCylinders, pPCHSGeometry->cHeads,
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync pPCHSGeometry->cSectors),
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync rc = VERR_INVALID_PARAMETER);
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync /* The LCHS geometry fields may be 0 to leave it to later autodetection. */
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync AssertMsgBreakStmt( VALID_PTR(pLCHSGeometry)
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync && pLCHSGeometry->cHeads <= 255
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync && pLCHSGeometry->cSectors <= 63,
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync ("pLCHSGeometry=%#p LCHS=%u/%u/%u\n", pLCHSGeometry,
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync pLCHSGeometry->cCylinders, pLCHSGeometry->cHeads,
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync pLCHSGeometry->cSectors),
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync rc = VERR_INVALID_PARAMETER);
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync /* The UUID may be NULL. */
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync AssertMsgBreakStmt(pUuid == NULL || VALID_PTR(pUuid),
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync ("pUuid=%#p UUID=%RTuuid\n", pUuid, pUuid),
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync rc = VERR_INVALID_PARAMETER);
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync AssertMsgBreakStmt((uOpenFlags & ~VD_OPEN_FLAGS_MASK) == 0,
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync ("uOpenFlags=%#x\n", uOpenFlags),
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync rc = VERR_INVALID_PARAMETER);
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync /* Check state. */
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync AssertMsgBreakStmt(pDisk->cImages == 0,
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync ("Create base image cannot be done with other images open\n"),
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync rc = VERR_VD_INVALID_STATE);
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync /* Set up image descriptor. */
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync pImage = (PVDIMAGE)RTMemAllocZ(sizeof(VDIMAGE));
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync if (!pImage)
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync {
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync rc = VERR_NO_MEMORY;
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync break;
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync }
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync pImage->pszFilename = RTStrDup(pszFilename);
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync if (!pImage->pszFilename)
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync {
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync rc = VERR_NO_MEMORY;
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync break;
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync }
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync pImage->pVDIfsImage = pVDIfsImage;
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync rc = vdFindBackend(pszBackend, &pImage->Backend);
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync if (RT_FAILURE(rc))
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync break;
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync if (!pImage->Backend)
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync {
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync rc = vdError(pDisk, VERR_INVALID_PARAMETER, RT_SRC_POS,
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync N_("VD: unknown backend name '%s'"), pszBackend);
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync break;
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync }
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync /* Create UUID if the caller didn't specify one. */
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync if (!pUuid)
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync {
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync rc = RTUuidCreate(&uuid);
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync if (RT_FAILURE(rc))
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync {
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync rc = vdError(pDisk, rc, RT_SRC_POS,
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync N_("VD: cannot generate UUID for image '%s'"),
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync pszFilename);
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync break;
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync }
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync pUuid = &uuid;
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync }
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync pImage->uOpenFlags = uOpenFlags & VD_OPEN_FLAGS_HONOR_SAME;
b07b4216b07447c916723417ee9b44f69c2fc11fvboxsync uImageFlags &= ~VD_IMAGE_FLAGS_DIFF;
rc = pImage->Backend->pfnCreate(pImage->pszFilename, cbSize,
uImageFlags, pszComment, pPCHSGeometry,
pLCHSGeometry, pUuid,
uOpenFlags & ~VD_OPEN_FLAGS_HONOR_SAME,
0, 99,
pDisk->pVDIfsDisk,
pImage->pVDIfsImage,
pVDIfsOperation,
&pImage->pvBackendData);
if (RT_SUCCESS(rc))
{
pImage->uImageFlags = uImageFlags;
/* Force sane optimization settings. It's not worth avoiding writes
* to fixed size images. The overhead would have almost no payback. */
if (uImageFlags & VD_IMAGE_FLAGS_FIXED)
pImage->uOpenFlags |= VD_OPEN_FLAGS_HONOR_SAME;
/** @todo optionally check UUIDs */
int rc2;
/* Cache disk information. */
pDisk->cbSize = pImage->Backend->pfnGetSize(pImage->pvBackendData);
/* Cache PCHS geometry. */
rc2 = pImage->Backend->pfnGetPCHSGeometry(pImage->pvBackendData,
&pDisk->PCHSGeometry);
if (RT_FAILURE(rc2))
{
pDisk->PCHSGeometry.cCylinders = 0;
pDisk->PCHSGeometry.cHeads = 0;
pDisk->PCHSGeometry.cSectors = 0;
}
else
{
/* Make sure the CHS geometry is properly clipped. */
pDisk->PCHSGeometry.cCylinders = RT_MIN(pDisk->PCHSGeometry.cCylinders, 16383);
pDisk->PCHSGeometry.cHeads = RT_MIN(pDisk->PCHSGeometry.cHeads, 16);
pDisk->PCHSGeometry.cSectors = RT_MIN(pDisk->PCHSGeometry.cSectors, 63);
}
/* Cache LCHS geometry. */
rc2 = pImage->Backend->pfnGetLCHSGeometry(pImage->pvBackendData,
&pDisk->LCHSGeometry);
if (RT_FAILURE(rc2))
{
pDisk->LCHSGeometry.cCylinders = 0;
pDisk->LCHSGeometry.cHeads = 0;
pDisk->LCHSGeometry.cSectors = 0;
}
else
{
/* Make sure the CHS geometry is properly clipped. */
pDisk->LCHSGeometry.cHeads = RT_MIN(pDisk->LCHSGeometry.cHeads, 255);
pDisk->LCHSGeometry.cSectors = RT_MIN(pDisk->LCHSGeometry.cSectors, 63);
}
}
if (RT_SUCCESS(rc))
{
/* Image successfully opened, make it the last image. */
vdAddImageToList(pDisk, pImage);
if (!(uOpenFlags & VD_OPEN_FLAGS_READONLY))
pDisk->uModified = VD_IMAGE_MODIFIED_FIRST;
}
else
{
/* Error detected, but image opened. Close and delete image. */
int rc2;
rc2 = pImage->Backend->pfnClose(pImage->pvBackendData, true);
AssertRC(rc2);
pImage->pvBackendData = NULL;
}
} while (0);
if (RT_FAILURE(rc))
{
if (pImage)
{
if (pImage->pszFilename)
RTStrFree(pImage->pszFilename);
RTMemFree(pImage);
}
}
if (RT_SUCCESS(rc) && pCbProgress && pCbProgress->pfnProgress)
pCbProgress->pfnProgress(NULL /* WARNING! pVM=NULL */, 100,
pIfProgress->pvUser);
LogFlowFunc(("returns %Rrc\n", rc));
return rc;
}
/**
* Creates and opens a new differencing image file in HDD container.
* See comments for VDOpen function about differencing images.
*
* @returns VBox status code.
* @param pDisk Pointer to HDD container.
* @param pszBackend Name of the image file backend to use.
* @param pszFilename Name of the differencing image file to create.
* @param uImageFlags Flags specifying special image features.
* @param pszComment Pointer to image comment. NULL is ok.
* @param pUuid New UUID of the image. If NULL, a new UUID is created.
* @param pParentUuid New parent UUID of the image. If NULL, the UUID is queried automatically.
* @param uOpenFlags Image file open mode, see VD_OPEN_FLAGS_* constants.
* @param pVDIfsImage Pointer to the per-image VD interface list.
* @param pVDIfsOperation Pointer to the per-operation VD interface list.
*/
VBOXDDU_DECL(int) VDCreateDiff(PVBOXHDD pDisk, const char *pszBackend,
const char *pszFilename, unsigned uImageFlags,
const char *pszComment, PCRTUUID pUuid,
PCRTUUID pParentUuid, unsigned uOpenFlags,
PVDINTERFACE pVDIfsImage,
PVDINTERFACE pVDIfsOperation)
{
int rc = VINF_SUCCESS;
PVDIMAGE pImage = NULL;
RTUUID uuid;
LogFlowFunc(("pDisk=%#p pszBackend=\"%s\" pszFilename=\"%s\" uImageFlags=%#x pszComment=\"%s\" Uuid=%RTuuid ParentUuid=%RTuuid uOpenFlags=%#x pVDIfsImage=%#p pVDIfsOperation=%#p\n",
pDisk, pszBackend, pszFilename, uImageFlags, pszComment, pUuid, pParentUuid, uOpenFlags,
pVDIfsImage, pVDIfsOperation));
PVDINTERFACE pIfProgress = VDInterfaceGet(pVDIfsOperation,
VDINTERFACETYPE_PROGRESS);
PVDINTERFACEPROGRESS pCbProgress = NULL;
if (pIfProgress)
pCbProgress = VDGetInterfaceProgress(pIfProgress);
do
{
/* sanity check */
AssertPtrBreakStmt(pDisk, rc = VERR_INVALID_PARAMETER);
AssertMsg(pDisk->u32Signature == VBOXHDDDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
/* Check arguments. */
AssertMsgBreakStmt(VALID_PTR(pszBackend) && *pszBackend,
("pszBackend=%#p \"%s\"\n", pszBackend, pszBackend),
rc = VERR_INVALID_PARAMETER);
AssertMsgBreakStmt(VALID_PTR(pszFilename) && *pszFilename,
("pszFilename=%#p \"%s\"\n", pszFilename, pszFilename),
rc = VERR_INVALID_PARAMETER);
AssertMsgBreakStmt((uImageFlags & ~VD_IMAGE_FLAGS_MASK) == 0,
("uImageFlags=%#x\n", uImageFlags),
rc = VERR_INVALID_PARAMETER);
/* The UUID may be NULL. */
AssertMsgBreakStmt(pUuid == NULL || VALID_PTR(pUuid),
("pUuid=%#p UUID=%RTuuid\n", pUuid, pUuid),
rc = VERR_INVALID_PARAMETER);
/* The parent UUID may be NULL. */
AssertMsgBreakStmt(pParentUuid == NULL || VALID_PTR(pParentUuid),
("pParentUuid=%#p ParentUUID=%RTuuid\n", pParentUuid, pParentUuid),
rc = VERR_INVALID_PARAMETER);
AssertMsgBreakStmt((uOpenFlags & ~VD_OPEN_FLAGS_MASK) == 0,
("uOpenFlags=%#x\n", uOpenFlags),
rc = VERR_INVALID_PARAMETER);
/* Check state. */
AssertMsgBreakStmt(pDisk->cImages != 0,
("Create diff image cannot be done without other images open\n"),
rc = VERR_VD_INVALID_STATE);
/* Set up image descriptor. */
pImage = (PVDIMAGE)RTMemAllocZ(sizeof(VDIMAGE));
if (!pImage)
{
rc = VERR_NO_MEMORY;
break;
}
pImage->pszFilename = RTStrDup(pszFilename);
if (!pImage->pszFilename)
{
rc = VERR_NO_MEMORY;
break;
}
rc = vdFindBackend(pszBackend, &pImage->Backend);
if (RT_FAILURE(rc))
break;
if (!pImage->Backend)
{
rc = vdError(pDisk, VERR_INVALID_PARAMETER, RT_SRC_POS,
N_("VD: unknown backend name '%s'"), pszBackend);
break;
}
/* Create UUID if the caller didn't specify one. */
if (!pUuid)
{
rc = RTUuidCreate(&uuid);
if (RT_FAILURE(rc))
{
rc = vdError(pDisk, rc, RT_SRC_POS,
N_("VD: cannot generate UUID for image '%s'"),
pszFilename);
break;
}
pUuid = &uuid;
}
pImage->uOpenFlags = uOpenFlags & VD_OPEN_FLAGS_HONOR_SAME;
uImageFlags |= VD_IMAGE_FLAGS_DIFF;
rc = pImage->Backend->pfnCreate(pImage->pszFilename, pDisk->cbSize,
uImageFlags | VD_IMAGE_FLAGS_DIFF,
pszComment, &pDisk->PCHSGeometry,
&pDisk->LCHSGeometry, pUuid,
uOpenFlags & ~VD_OPEN_FLAGS_HONOR_SAME,
0, 99,
pDisk->pVDIfsDisk,
pImage->pVDIfsImage,
pVDIfsOperation,
&pImage->pvBackendData);
if (RT_SUCCESS(rc) && pDisk->cImages != 0)
{
pImage->uImageFlags = uImageFlags;
/* Switch previous image to read-only mode. */
unsigned uOpenFlagsPrevImg;
uOpenFlagsPrevImg = pDisk->pLast->Backend->pfnGetOpenFlags(pDisk->pLast->pvBackendData);
if (!(uOpenFlagsPrevImg & VD_OPEN_FLAGS_READONLY))
{
uOpenFlagsPrevImg |= VD_OPEN_FLAGS_READONLY;
rc = pDisk->pLast->Backend->pfnSetOpenFlags(pDisk->pLast->pvBackendData, uOpenFlagsPrevImg);
}
}
if (RT_SUCCESS(rc))
{
RTUUID Uuid;
RTTIMESPEC ts;
int rc2;
if (pParentUuid && !RTUuidIsNull(pParentUuid))
{
Uuid = *pParentUuid;
pImage->Backend->pfnSetParentUuid(pImage->pvBackendData, &Uuid);
}
else
{
rc2 = pDisk->pLast->Backend->pfnGetUuid(pDisk->pLast->pvBackendData,
&Uuid);
if (RT_SUCCESS(rc2))
pImage->Backend->pfnSetParentUuid(pImage->pvBackendData, &Uuid);
}
rc2 = pDisk->pLast->Backend->pfnGetModificationUuid(pDisk->pLast->pvBackendData,
&Uuid);
if (RT_SUCCESS(rc2))
pImage->Backend->pfnSetParentModificationUuid(pImage->pvBackendData,
&Uuid);
rc2 = pDisk->pLast->Backend->pfnGetTimeStamp(pDisk->pLast->pvBackendData,
&ts);
if (RT_SUCCESS(rc2))
pImage->Backend->pfnSetParentTimeStamp(pImage->pvBackendData, &ts);
rc2 = pImage->Backend->pfnSetParentFilename(pImage->pvBackendData, pDisk->pLast->pszFilename);
}
if (RT_SUCCESS(rc))
{
/** @todo optionally check UUIDs */
}
if (RT_SUCCESS(rc))
{
/* Image successfully opened, make it the last image. */
vdAddImageToList(pDisk, pImage);
if (!(uOpenFlags & VD_OPEN_FLAGS_READONLY))
pDisk->uModified = VD_IMAGE_MODIFIED_FIRST;
}
else
{
/* Error detected, but image opened. Close and delete image. */
int rc2;
rc2 = pImage->Backend->pfnClose(pImage->pvBackendData, true);
AssertRC(rc2);
pImage->pvBackendData = NULL;
}
} while (0);
if (RT_FAILURE(rc))
{
if (pImage)
{
if (pImage->pszFilename)
RTStrFree(pImage->pszFilename);
RTMemFree(pImage);
}
}
if (RT_SUCCESS(rc) && pCbProgress && pCbProgress->pfnProgress)
pCbProgress->pfnProgress(NULL /* WARNING! pVM=NULL */, 100,
pIfProgress->pvUser);
LogFlowFunc(("returns %Rrc\n", rc));
return rc;
}
/**
* Merges two images (not necessarily with direct parent/child relationship).
* As a side effect the source image and potentially the other images which
* are also merged to the destination are deleted from both the disk and the
* images in the HDD container.
*
* @returns VBox status code.
* @returns VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
* @param pDisk Pointer to HDD container.
* @param nImageFrom Name of the image file to merge from.
* @param nImageTo Name of the image file to merge to.
* @param pVDIfsOperation Pointer to the per-operation VD interface list.
*/
VBOXDDU_DECL(int) VDMerge(PVBOXHDD pDisk, unsigned nImageFrom,
unsigned nImageTo, PVDINTERFACE pVDIfsOperation)
{
int rc = VINF_SUCCESS;
void *pvBuf = NULL;
LogFlowFunc(("pDisk=%#p nImageFrom=%u nImageTo=%u pVDIfsOperation=%#p\n",
pDisk, nImageFrom, nImageTo, pVDIfsOperation));
PVDINTERFACE pIfProgress = VDInterfaceGet(pVDIfsOperation,
VDINTERFACETYPE_PROGRESS);
PVDINTERFACEPROGRESS pCbProgress = NULL;
if (pIfProgress)
pCbProgress = VDGetInterfaceProgress(pIfProgress);
do
{
/* sanity check */
AssertPtrBreakStmt(pDisk, rc = VERR_INVALID_PARAMETER);
AssertMsg(pDisk->u32Signature == VBOXHDDDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
PVDIMAGE pImageFrom = vdGetImageByNumber(pDisk, nImageFrom);
PVDIMAGE pImageTo = vdGetImageByNumber(pDisk, nImageTo);
if (!pImageFrom || !pImageTo)
{
rc = VERR_VD_IMAGE_NOT_FOUND;
break;
}
AssertBreakStmt(pImageFrom != pImageTo, rc = VERR_INVALID_PARAMETER);
/* Make sure destination image is writable. */
unsigned uOpenFlags = pImageTo->Backend->pfnGetOpenFlags(pImageTo->pvBackendData);
if (uOpenFlags & VD_OPEN_FLAGS_READONLY)
{
uOpenFlags &= ~VD_OPEN_FLAGS_READONLY;
rc = pImageTo->Backend->pfnSetOpenFlags(pImageTo->pvBackendData,
uOpenFlags);
if (RT_FAILURE(rc))
break;
}
/* Get size of destination image. */
uint64_t cbSize = pImageTo->Backend->pfnGetSize(pImageTo->pvBackendData);
/* Allocate tmp buffer. */
pvBuf = RTMemTmpAlloc(VD_MERGE_BUFFER_SIZE);
if (!pvBuf)
{
rc = VERR_NO_MEMORY;
break;
}
/* Merging is done directly on the images itself. This potentially
* causes trouble if the disk is full in the middle of operation. */
/** @todo write alternative implementation which works with temporary
* images (which is safer, but requires even more space). Also has the
* drawback that merging into a raw disk parent simply isn't possible
* this way (but in that case disk full isn't really a problem). */
if (nImageFrom < nImageTo)
{
/* Merge parent state into child. This means writing all not
* allocated blocks in the destination image which are allocated in
* the images to be merged. */
uint64_t uOffset = 0;
uint64_t cbRemaining = cbSize;
do
{
size_t cbThisRead = RT_MIN(VD_MERGE_BUFFER_SIZE, cbRemaining);
rc = pImageTo->Backend->pfnRead(pImageTo->pvBackendData,
uOffset, pvBuf, cbThisRead,
&cbThisRead);
if (rc == VERR_VD_BLOCK_FREE)
{
/* Search for image with allocated block. Do not attempt to
* read more than the previous reads marked as valid.
* Otherwise this would return stale data when different
* block sizes are used for the images. */
for (PVDIMAGE pCurrImage = pImageTo->pPrev;
pCurrImage != NULL && pCurrImage != pImageFrom->pPrev && rc == VERR_VD_BLOCK_FREE;
pCurrImage = pCurrImage->pPrev)
{
rc = pCurrImage->Backend->pfnRead(pCurrImage->pvBackendData,
uOffset, pvBuf,
cbThisRead,
&cbThisRead);
}
if (rc != VERR_VD_BLOCK_FREE)
{
if (RT_FAILURE(rc))
break;
rc = vdWriteHelper(pDisk, pImageTo, uOffset, pvBuf,
cbThisRead);
if (RT_FAILURE(rc))
break;
}
else
rc = VINF_SUCCESS;
}
else if (RT_FAILURE(rc))
break;
uOffset += cbThisRead;
cbRemaining -= cbThisRead;
if (pCbProgress && pCbProgress->pfnProgress)
{
rc = pCbProgress->pfnProgress(NULL /* WARNING! pVM=NULL */,
uOffset * 99 / cbSize,
pIfProgress->pvUser);
if (RT_FAILURE(rc))
break;
}
} while (uOffset < cbSize);
}
else
{
/* Merge child state into parent. This means writing all blocks
* which are allocated in the image up to the source image to the
* destination image. */
uint64_t uOffset = 0;
uint64_t cbRemaining = cbSize;
do
{
size_t cbThisRead = RT_MIN(VD_MERGE_BUFFER_SIZE, cbRemaining);
rc = VERR_VD_BLOCK_FREE;
/* Search for image with allocated block. Do not attempt to
* read more than the previous reads marked as valid. Otherwise
* this would return stale data when different block sizes are
* used for the images. */
for (PVDIMAGE pCurrImage = pImageFrom;
pCurrImage != NULL && pCurrImage != pImageTo && rc == VERR_VD_BLOCK_FREE;
pCurrImage = pCurrImage->pPrev)
{
rc = pCurrImage->Backend->pfnRead(pCurrImage->pvBackendData,
uOffset, pvBuf,
cbThisRead, &cbThisRead);
}
if (rc != VERR_VD_BLOCK_FREE)
{
if (RT_FAILURE(rc))
break;
rc = vdWriteHelper(pDisk, pImageTo, uOffset, pvBuf,
cbThisRead);
if (RT_FAILURE(rc))
break;
}
else
rc = VINF_SUCCESS;
uOffset += cbThisRead;
cbRemaining -= cbThisRead;
if (pCbProgress && pCbProgress->pfnProgress)
{
rc = pCbProgress->pfnProgress(NULL /* WARNING! pVM=NULL */,
uOffset * 99 / cbSize,
pIfProgress->pvUser);
if (RT_FAILURE(rc))
break;
}
} while (uOffset < cbSize);
}
/* Update parent UUID so that image chain is consistent. */
RTUUID Uuid;
if (nImageFrom < nImageTo)
{
if (pImageTo->pPrev)
{
rc = pImageTo->Backend->pfnGetUuid(pImageTo->pPrev->pvBackendData,
&Uuid);
AssertRC(rc);
}
else
RTUuidClear(&Uuid);
rc = pImageTo->Backend->pfnSetParentUuid(pImageTo->pvBackendData,
&Uuid);
AssertRC(rc);
}
else
{
if (pImageFrom->pNext)
{
rc = pImageTo->Backend->pfnGetUuid(pImageTo->pvBackendData,
&Uuid);
AssertRC(rc);
rc = pImageFrom->Backend->pfnSetParentUuid(pImageFrom->pNext,
&Uuid);
AssertRC(rc);
}
}
/* Make sure destination image is back to read only if necessary. */
if (pImageTo != pDisk->pLast && pImageFrom != pDisk->pLast)
{
uOpenFlags = pImageTo->Backend->pfnGetOpenFlags(pImageTo->pvBackendData);
uOpenFlags |= VD_OPEN_FLAGS_READONLY;
rc = pImageTo->Backend->pfnSetOpenFlags(pImageTo->pvBackendData,
uOpenFlags);
if (RT_FAILURE(rc))
break;
}
/* Delete the no longer needed images. */
PVDIMAGE pImg = pImageFrom, pTmp;
while (pImg != pImageTo)
{
if (nImageFrom < nImageTo)
pTmp = pImg->pNext;
else
pTmp = pImg->pPrev;
vdRemoveImageFromList(pDisk, pImg);
pImg->Backend->pfnClose(pImg->pvBackendData, true);
RTMemFree(pImg->pszFilename);
RTMemFree(pImg);
pImg = pTmp;
}
} while (0);
if (pvBuf)
RTMemTmpFree(pvBuf);
if (RT_SUCCESS(rc) && pCbProgress && pCbProgress->pfnProgress)
pCbProgress->pfnProgress(NULL /* WARNING! pVM=NULL */, 100,
pIfProgress->pvUser);
LogFlowFunc(("returns %Rrc\n", rc));
return rc;
}
/**
* Copies an image from one HDD container to another.
* The copy is opened in the target HDD container.
* It is possible to convert between different image formats, because the
* backend for the destination may be different from the source.
* If both the source and destination reference the same HDD container,
* then the image is moved (by copying/deleting or renaming) to the new location.
* The source container is unchanged if the move operation fails, otherwise
* the image at the new location is opened in the same way as the old one was.
*
* @returns VBox status code.
* @returns VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
* @param pDiskFrom Pointer to source HDD container.
* @param nImage Image number, counts from 0. 0 is always base image of container.
* @param pDiskTo Pointer to destination HDD container.
* @param pszBackend Name of the image file backend to use.
* @param pszFilename New name of the image (may be NULL if pDiskFrom == pDiskTo).
* @param fMoveByRename If true, attempt to perform a move by renaming (if successful the new size is ignored).
* @param cbSize New image size (0 means leave unchanged).
* @param uImageFlags Flags specifying special destination image features.
* @param pDstUuid New UUID of the destination image. If NULL, a new UUID is created.
* This parameter is used if and only if a true copy is created.
* In all rename/move cases the UUIDs are copied over.
* @param pVDIfsOperation Pointer to the per-operation VD interface list.
* @param pDstVDIfsImage Pointer to the per-image VD interface list, for the
* destination image.
* @param pDstVDIfsOperation Pointer to the per-image VD interface list,
* for the destination image.
*/
VBOXDDU_DECL(int) VDCopy(PVBOXHDD pDiskFrom, unsigned nImage, PVBOXHDD pDiskTo,
const char *pszBackend, const char *pszFilename,
bool fMoveByRename, uint64_t cbSize,
unsigned uImageFlags, PCRTUUID pDstUuid,
PVDINTERFACE pVDIfsOperation,
PVDINTERFACE pDstVDIfsImage,
PVDINTERFACE pDstVDIfsOperation)
{
int rc, rc2 = VINF_SUCCESS;
void *pvBuf = NULL;
PVDIMAGE pImageTo = NULL;
LogFlowFunc(("pDiskFrom=%#p nImage=%u pDiskTo=%#p pszBackend=\"%s\" pszFilename=\"%s\" fMoveByRename=%d cbSize=%llu pVDIfsOperation=%#p pDstVDIfsImage=%#p pDstVDIfsOperation=%#p\n",
pDiskFrom, nImage, pDiskTo, pszBackend, pszFilename, fMoveByRename, cbSize, pVDIfsOperation, pDstVDIfsImage, pDstVDIfsOperation));
PVDINTERFACE pIfProgress = VDInterfaceGet(pVDIfsOperation,
VDINTERFACETYPE_PROGRESS);
PVDINTERFACEPROGRESS pCbProgress = NULL;
if (pIfProgress)
pCbProgress = VDGetInterfaceProgress(pIfProgress);
PVDINTERFACE pDstIfProgress = VDInterfaceGet(pDstVDIfsOperation,
VDINTERFACETYPE_PROGRESS);
PVDINTERFACEPROGRESS pDstCbProgress = NULL;
if (pDstIfProgress)
pDstCbProgress = VDGetInterfaceProgress(pDstIfProgress);
do {
/* Check arguments. */
AssertMsgBreakStmt(VALID_PTR(pDiskFrom), ("pDiskFrom=%#p\n", pDiskFrom),
rc = VERR_INVALID_PARAMETER);
AssertMsg(pDiskFrom->u32Signature == VBOXHDDDISK_SIGNATURE,
("u32Signature=%08x\n", pDiskFrom->u32Signature));
PVDIMAGE pImageFrom = vdGetImageByNumber(pDiskFrom, nImage);
AssertPtrBreakStmt(pImageFrom, rc = VERR_VD_IMAGE_NOT_FOUND);
AssertMsgBreakStmt(VALID_PTR(pDiskTo), ("pDiskTo=%#p\n", pDiskTo),
rc = VERR_INVALID_PARAMETER);
AssertMsg(pDiskTo->u32Signature == VBOXHDDDISK_SIGNATURE,
("u32Signature=%08x\n", pDiskTo->u32Signature));
/* Move the image. */
if (pDiskFrom == pDiskTo)
{
/* Rename only works when backends are the same. */
if ( fMoveByRename
&& !RTStrICmp(pszBackend, pImageFrom->Backend->pszBackendName))
{
rc = pImageFrom->Backend->pfnRename(pImageFrom->pvBackendData, pszFilename ? pszFilename : pImageFrom->pszFilename);
break;
}
/** @todo Moving (including shrinking/growing) of the image is
* requested, but the rename attempt failed or it wasn't possible.
* Must now copy image to temp location. */
AssertReleaseMsgFailed(("VDCopy: moving by copy/delete not implemented\n"));
}
/* pszFilename is allowed to be NULL, as this indicates copy to the existing image. */
AssertMsgBreakStmt(pszFilename == NULL || (VALID_PTR(pszFilename) && *pszFilename),
("pszFilename=%#p \"%s\"\n", pszFilename, pszFilename),
rc = VERR_INVALID_PARAMETER);
uint64_t cbSizeFrom;
cbSizeFrom = pImageFrom->Backend->pfnGetSize(pImageFrom->pvBackendData);
if (cbSizeFrom == 0)
{
rc = VERR_VD_VALUE_NOT_FOUND;
break;
}
PDMMEDIAGEOMETRY PCHSGeometryFrom = {0, 0, 0};
PDMMEDIAGEOMETRY LCHSGeometryFrom = {0, 0, 0};
pImageFrom->Backend->pfnGetPCHSGeometry(pImageFrom->pvBackendData, &PCHSGeometryFrom);
pImageFrom->Backend->pfnGetLCHSGeometry(pImageFrom->pvBackendData, &LCHSGeometryFrom);
RTUUID ImageUuid, ImageModificationUuid;
RTUUID ParentUuid, ParentModificationUuid;
if (pDiskFrom != pDiskTo)
{
if (pDstUuid)
ImageUuid = *pDstUuid;
else
RTUuidCreate(&ImageUuid);
}
else
{
rc = pImageFrom->Backend->pfnGetUuid(pImageFrom->pvBackendData, &ImageUuid);
if (RT_FAILURE(rc))
RTUuidCreate(&ImageUuid);
}
rc = pImageFrom->Backend->pfnGetModificationUuid(pImageFrom->pvBackendData, &ImageModificationUuid);
if (RT_FAILURE(rc))
RTUuidClear(&ImageModificationUuid);
rc = pImageFrom->Backend->pfnGetParentUuid(pImageFrom->pvBackendData, &ParentUuid);
if (RT_FAILURE(rc))
RTUuidClear(&ParentUuid);
rc = pImageFrom->Backend->pfnGetParentModificationUuid(pImageFrom->pvBackendData, &ParentModificationUuid);
if (RT_FAILURE(rc))
RTUuidClear(&ParentModificationUuid);
char szComment[1024];
rc = pImageFrom->Backend->pfnGetComment(pImageFrom->pvBackendData, szComment, sizeof(szComment));
if (RT_FAILURE(rc))
szComment[0] = '\0';
else
szComment[sizeof(szComment) - 1] = '\0';
unsigned uOpenFlagsFrom;
uOpenFlagsFrom = pImageFrom->Backend->pfnGetOpenFlags(pImageFrom->pvBackendData);
if (pszFilename)
{
if (cbSize == 0)
cbSize = cbSizeFrom;
/* Create destination image with the properties of the source image. */
/** @todo replace the VDCreateDiff/VDCreateBase calls by direct
* calls to the backend. Unifies the code and reduces the API
* dependencies. */
if (uImageFlags & VD_IMAGE_FLAGS_DIFF)
{
rc = VDCreateDiff(pDiskTo, pszBackend, pszFilename, uImageFlags,
szComment, &ImageUuid, &ParentUuid, uOpenFlagsFrom & ~VD_OPEN_FLAGS_READONLY, NULL, NULL);
} else {
/** @todo Please, review this! It's an ugly hack I think... */
if (!RTStrICmp(pszBackend, "RAW"))
uImageFlags |= VD_IMAGE_FLAGS_FIXED;
rc = VDCreateBase(pDiskTo, pszBackend, pszFilename, cbSize,
uImageFlags, szComment,
&PCHSGeometryFrom, &LCHSGeometryFrom,
NULL, uOpenFlagsFrom & ~VD_OPEN_FLAGS_READONLY, NULL, NULL);
if (RT_SUCCESS(rc) && !RTUuidIsNull(&ImageUuid))
pDiskTo->pLast->Backend->pfnSetUuid(pDiskTo->pLast->pvBackendData, &ImageUuid);
if (RT_SUCCESS(rc) && !RTUuidIsNull(&ParentUuid))
pDiskTo->pLast->Backend->pfnSetParentUuid(pDiskTo->pLast->pvBackendData, &ParentUuid);
}
if (RT_FAILURE(rc))
break;
pImageTo = pDiskTo->pLast;
AssertPtrBreakStmt(pImageTo, rc = VERR_VD_IMAGE_NOT_FOUND);
cbSize = RT_MIN(cbSize, cbSizeFrom);
}
else
{
pImageTo = pDiskTo->pLast;
AssertPtrBreakStmt(pImageTo, rc = VERR_VD_IMAGE_NOT_FOUND);
uint64_t cbSizeTo;
cbSizeTo = pImageTo->Backend->pfnGetSize(pImageTo->pvBackendData);
if (cbSizeTo == 0)
{
rc = VERR_VD_VALUE_NOT_FOUND;
break;
}
if (cbSize == 0)
cbSize = RT_MIN(cbSizeFrom, cbSizeTo);
}
/* Allocate tmp buffer. */
pvBuf = RTMemTmpAlloc(VD_MERGE_BUFFER_SIZE);
if (!pvBuf)
{
rc = VERR_NO_MEMORY;
break;
}
/* Copy the data. */
uint64_t uOffset = 0;
uint64_t cbRemaining = cbSize;
do
{
size_t cbThisRead = RT_MIN(VD_MERGE_BUFFER_SIZE, cbRemaining);
rc = vdReadHelper(pDiskFrom, pImageFrom, uOffset, pvBuf,
cbThisRead);
if (RT_FAILURE(rc))
break;
rc = vdWriteHelper(pDiskTo, pImageTo, uOffset, pvBuf,
cbThisRead);
if (RT_FAILURE(rc))
break;
uOffset += cbThisRead;
cbRemaining -= cbThisRead;
if (pCbProgress && pCbProgress->pfnProgress)
{
rc = pCbProgress->pfnProgress(NULL /* WARNING! pVM=NULL */,
uOffset * 99 / cbSize,
pIfProgress->pvUser);
if (RT_FAILURE(rc))
break;
}
if (pDstCbProgress && pDstCbProgress->pfnProgress)
{
rc = pDstCbProgress->pfnProgress(NULL /* WARNING! pVM=NULL */,
uOffset * 99 / cbSize,
pDstIfProgress->pvUser);
if (RT_FAILURE(rc))
break;
}
} while (uOffset < cbSize);
if (RT_SUCCESS(rc))
{
pImageTo->Backend->pfnSetModificationUuid(pImageTo->pvBackendData, &ImageModificationUuid);
/** @todo double-check this - it makes little sense to copy over the parent modification uuid,
* as the destination image can have a totally different parent. */
#if 0
pImageTo->Backend->pfnSetParentModificationUuid(pImageTo->pvBackendData, &ParentModificationUuid);
#endif
}
} while (0);
if (RT_FAILURE(rc) && pImageTo && pszFilename)
{
/* Error detected, but new image created. Remove image from list. */
vdRemoveImageFromList(pDiskTo, pImageTo);
/* Close and delete image. */
rc2 = pImageTo->Backend->pfnClose(pImageTo->pvBackendData, true);
AssertRC(rc2);
pImageTo->pvBackendData = NULL;
/* Free remaining resources. */
if (pImageTo->pszFilename)
RTStrFree(pImageTo->pszFilename);
RTMemFree(pImageTo);
}
if (pvBuf)
RTMemTmpFree(pvBuf);
if (RT_SUCCESS(rc))
{
if (pCbProgress && pCbProgress->pfnProgress)
pCbProgress->pfnProgress(NULL /* WARNING! pVM=NULL */, 100,
pIfProgress->pvUser);
if (pDstCbProgress && pDstCbProgress->pfnProgress)
pDstCbProgress->pfnProgress(NULL /* WARNING! pVM=NULL */, 100,
pDstIfProgress->pvUser);
}
LogFlowFunc(("returns %Rrc\n", rc));
return rc;
}
/**
* Optimizes the storage consumption of an image. Typically the unused blocks
* have to be wiped with zeroes to achieve a substantial reduced storage use.
* Another optimization done is reordering the image blocks, which can provide
* a significant performance boost, as reads and writes tend to use less random
* file offsets.
*
* @return VBox status code.
* @return VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
* @return VERR_VD_IMAGE_READ_ONLY if image is not writable.
* @return VERR_NOT_SUPPORTED if this kind of image can be compacted, but
* the code for this isn't implemented yet.
* @param pDisk Pointer to HDD container.
* @param nImage Image number, counts from 0. 0 is always base image of container.
* @param pVDIfsOperation Pointer to the per-operation VD interface list.
*/
VBOXDDU_DECL(int) VDCompact(PVBOXHDD pDisk, unsigned nImage,
PVDINTERFACE pVDIfsOperation)
{
int rc;
void *pvBuf = NULL;
void *pvTmp = NULL;
LogFlowFunc(("pDisk=%#p nImage=%u pVDIfsOperation=%#p\n",
pDisk, nImage, pVDIfsOperation));
PVDINTERFACE pIfProgress = VDInterfaceGet(pVDIfsOperation,
VDINTERFACETYPE_PROGRESS);
PVDINTERFACEPROGRESS pCbProgress = NULL;
if (pIfProgress)
pCbProgress = VDGetInterfaceProgress(pIfProgress);
do {
/* Check arguments. */
AssertMsgBreakStmt(VALID_PTR(pDisk), ("pDisk=%#p\n", pDisk),
rc = VERR_INVALID_PARAMETER);
AssertMsg(pDisk->u32Signature == VBOXHDDDISK_SIGNATURE,
("u32Signature=%08x\n", pDisk->u32Signature));
PVDIMAGE pImage = vdGetImageByNumber(pDisk, nImage);
AssertPtrBreakStmt(pImage, rc = VERR_VD_IMAGE_NOT_FOUND);
/* If there is no compact callback for not file based backends then
* the backend doesn't need compaction. No need to make much fuss about
* this. For file based ones signal this as not yet supported. */
if (!pImage->Backend->pfnCompact)
{
if (pImage->Backend->uBackendCaps & VD_CAP_FILE)
rc = VERR_NOT_SUPPORTED;
else
rc = VINF_SUCCESS;
break;
}
/* Insert interface for reading parent state into per-operation list,
* if there is a parent image. */
VDINTERFACE IfOpParent;
VDINTERFACEPARENTSTATE ParentCb;
VDPARENTSTATEDESC ParentUser;
if (pImage->pPrev)
{
ParentCb.cbSize = sizeof(ParentCb);
ParentCb.enmInterface = VDINTERFACETYPE_PARENTSTATE;
ParentCb.pfnParentRead = vdParentRead;
ParentUser.pDisk = pDisk;
ParentUser.pImage = pImage->pPrev;
rc = VDInterfaceAdd(&IfOpParent, "VDCompact_ParentState", VDINTERFACETYPE_PARENTSTATE,
&ParentCb, &ParentUser, &pVDIfsOperation);
AssertRC(rc);
}
rc = pImage->Backend->pfnCompact(pImage->pvBackendData,
0, 99,
pVDIfsOperation);
} while (0);
if (pvBuf)
RTMemTmpFree(pvBuf);
if (pvTmp)
RTMemTmpFree(pvTmp);
if (RT_SUCCESS(rc))
{
if (pCbProgress && pCbProgress->pfnProgress)
pCbProgress->pfnProgress(NULL /* WARNING! pVM=NULL */, 100,
pIfProgress->pvUser);
}
LogFlowFunc(("returns %Rrc\n", rc));
return rc;
}
/**
* Closes the last opened image file in HDD container.
* If previous image file was opened in read-only mode (that is normal) and closing image
* was opened in read-write mode (the whole disk was in read-write mode) - the previous image
* will be reopened in read/write mode.
*
* @returns VBox status code.
* @returns VERR_VD_NOT_OPENED if no image is opened in HDD container.
* @param pDisk Pointer to HDD container.
* @param fDelete If true, delete the image from the host disk.
*/
VBOXDDU_DECL(int) VDClose(PVBOXHDD pDisk, bool fDelete)
{
int rc = VINF_SUCCESS;
LogFlowFunc(("pDisk=%#p fDelete=%d\n", pDisk, fDelete));
do
{
/* sanity check */
AssertPtrBreakStmt(pDisk, rc = VERR_INVALID_PARAMETER);
AssertMsg(pDisk->u32Signature == VBOXHDDDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
PVDIMAGE pImage = pDisk->pLast;
if (!pImage)
{
rc = VERR_VD_NOT_OPENED;
break;
}
unsigned uOpenFlags = pImage->Backend->pfnGetOpenFlags(pImage->pvBackendData);
/* Remove image from list of opened images. */
vdRemoveImageFromList(pDisk, pImage);
/* Close (and optionally delete) image. */
rc = pImage->Backend->pfnClose(pImage->pvBackendData, fDelete);
/* Free remaining resources related to the image. */
RTStrFree(pImage->pszFilename);
RTMemFree(pImage);
pImage = pDisk->pLast;
if (!pImage)
break;
/* If disk was previously in read/write mode, make sure it will stay
* like this (if possible) after closing this image. Set the open flags
* accordingly. */
if (!(uOpenFlags & VD_OPEN_FLAGS_READONLY))
{
uOpenFlags = pImage->Backend->pfnGetOpenFlags(pImage->pvBackendData);
uOpenFlags &= ~ VD_OPEN_FLAGS_READONLY;
rc = pImage->Backend->pfnSetOpenFlags(pImage->pvBackendData, uOpenFlags);
}
int rc2;
/* Cache disk information. */
pDisk->cbSize = pImage->Backend->pfnGetSize(pImage->pvBackendData);
/* Cache PCHS geometry. */
rc2 = pImage->Backend->pfnGetPCHSGeometry(pImage->pvBackendData,
&pDisk->PCHSGeometry);
if (RT_FAILURE(rc2))
{
pDisk->PCHSGeometry.cCylinders = 0;
pDisk->PCHSGeometry.cHeads = 0;
pDisk->PCHSGeometry.cSectors = 0;
}
else
{
/* Make sure the PCHS geometry is properly clipped. */
pDisk->PCHSGeometry.cCylinders = RT_MIN(pDisk->PCHSGeometry.cCylinders, 16383);
pDisk->PCHSGeometry.cHeads = RT_MIN(pDisk->PCHSGeometry.cHeads, 16);
pDisk->PCHSGeometry.cSectors = RT_MIN(pDisk->PCHSGeometry.cSectors, 63);
}
/* Cache LCHS geometry. */
rc2 = pImage->Backend->pfnGetLCHSGeometry(pImage->pvBackendData,
&pDisk->LCHSGeometry);
if (RT_FAILURE(rc2))
{
pDisk->LCHSGeometry.cCylinders = 0;
pDisk->LCHSGeometry.cHeads = 0;
pDisk->LCHSGeometry.cSectors = 0;
}
else
{
/* Make sure the LCHS geometry is properly clipped. */
pDisk->LCHSGeometry.cHeads = RT_MIN(pDisk->LCHSGeometry.cHeads, 255);
pDisk->LCHSGeometry.cSectors = RT_MIN(pDisk->LCHSGeometry.cSectors, 63);
}
} while (0);
LogFlowFunc(("returns %Rrc\n", rc));
return rc;
}
/**
* Closes all opened image files in HDD container.
*
* @returns VBox status code.
* @param pDisk Pointer to HDD container.
*/
VBOXDDU_DECL(int) VDCloseAll(PVBOXHDD pDisk)
{
int rc = VINF_SUCCESS;
LogFlowFunc(("pDisk=%#p\n", pDisk));
do
{
/* sanity check */
AssertPtrBreakStmt(pDisk, rc = VERR_INVALID_PARAMETER);
AssertMsg(pDisk->u32Signature == VBOXHDDDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
PVDIMAGE pImage = pDisk->pLast;
while (VALID_PTR(pImage))
{
PVDIMAGE pPrev = pImage->pPrev;
/* Remove image from list of opened images. */
vdRemoveImageFromList(pDisk, pImage);
/* Close image. */
int rc2 = pImage->Backend->pfnClose(pImage->pvBackendData, false);
if (RT_FAILURE(rc2) && RT_SUCCESS(rc))
rc = rc2;
/* Free remaining resources related to the image. */
RTStrFree(pImage->pszFilename);
RTMemFree(pImage);
pImage = pPrev;
}
Assert(!VALID_PTR(pDisk->pLast));
} while (0);
LogFlowFunc(("returns %Rrc\n", rc));
return rc;
}
/**
* Read data from virtual HDD.
*
* @returns VBox status code.
* @returns VERR_VD_NOT_OPENED if no image is opened in HDD container.
* @param pDisk Pointer to HDD container.
* @param uOffset Offset of first reading byte from start of disk.
* @param pvBuf Pointer to buffer for reading data.
* @param cbRead Number of bytes to read.
*/
VBOXDDU_DECL(int) VDRead(PVBOXHDD pDisk, uint64_t uOffset, void *pvBuf,
size_t cbRead)
{
int rc;
LogFlowFunc(("pDisk=%#p uOffset=%llu pvBuf=%p cbRead=%zu\n",
pDisk, uOffset, pvBuf, cbRead));
do
{
/* sanity check */
AssertPtrBreakStmt(pDisk, rc = VERR_INVALID_PARAMETER);
AssertMsg(pDisk->u32Signature == VBOXHDDDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
/* Check arguments. */
AssertMsgBreakStmt(VALID_PTR(pvBuf),
("pvBuf=%#p\n", pvBuf),
rc = VERR_INVALID_PARAMETER);
AssertMsgBreakStmt(cbRead,
("cbRead=%zu\n", cbRead),
rc = VERR_INVALID_PARAMETER);
AssertMsgBreakStmt(uOffset + cbRead <= pDisk->cbSize,
("uOffset=%llu cbRead=%zu pDisk->cbSize=%llu\n",
uOffset, cbRead, pDisk->cbSize),
rc = VERR_INVALID_PARAMETER);
PVDIMAGE pImage = pDisk->pLast;
AssertPtrBreakStmt(pImage, rc = VERR_VD_NOT_OPENED);
rc = vdReadHelper(pDisk, pImage, uOffset, pvBuf, cbRead);
} while (0);
LogFlowFunc(("returns %Rrc\n", rc));
return rc;
}
/**
* Write data to virtual HDD.
*
* @returns VBox status code.
* @returns VERR_VD_NOT_OPENED if no image is opened in HDD container.
* @param pDisk Pointer to HDD container.
* @param uOffset Offset of the first byte being
* written from start of disk.
* @param pvBuf Pointer to buffer for writing data.
* @param cbWrite Number of bytes to write.
*/
VBOXDDU_DECL(int) VDWrite(PVBOXHDD pDisk, uint64_t uOffset, const void *pvBuf,
size_t cbWrite)
{
int rc = VINF_SUCCESS;
LogFlowFunc(("pDisk=%#p uOffset=%llu pvBuf=%p cbWrite=%zu\n",
pDisk, uOffset, pvBuf, cbWrite));
do
{
/* sanity check */
AssertPtrBreakStmt(pDisk, rc = VERR_INVALID_PARAMETER);
AssertMsg(pDisk->u32Signature == VBOXHDDDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
/* Check arguments. */
AssertMsgBreakStmt(VALID_PTR(pvBuf),
("pvBuf=%#p\n", pvBuf),
rc = VERR_INVALID_PARAMETER);
AssertMsgBreakStmt(cbWrite,
("cbWrite=%zu\n", cbWrite),
rc = VERR_INVALID_PARAMETER);
AssertMsgBreakStmt(uOffset + cbWrite <= pDisk->cbSize,
("uOffset=%llu cbWrite=%zu pDisk->cbSize=%llu\n",
uOffset, cbWrite, pDisk->cbSize),
rc = VERR_INVALID_PARAMETER);
PVDIMAGE pImage = pDisk->pLast;
AssertPtrBreakStmt(pImage, rc = VERR_VD_NOT_OPENED);
vdSetModifiedFlag(pDisk);
rc = vdWriteHelper(pDisk, pImage, uOffset, pvBuf, cbWrite);
} while (0);
LogFlowFunc(("returns %Rrc\n", rc));
return rc;
}
/**
* Make sure the on disk representation of a virtual HDD is up to date.
*
* @returns VBox status code.
* @returns VERR_VD_NOT_OPENED if no image is opened in HDD container.
* @param pDisk Pointer to HDD container.
*/
VBOXDDU_DECL(int) VDFlush(PVBOXHDD pDisk)
{
int rc = VINF_SUCCESS;
LogFlowFunc(("pDisk=%#p\n", pDisk));
do
{
/* sanity check */
AssertPtrBreakStmt(pDisk, rc = VERR_INVALID_PARAMETER);
AssertMsg(pDisk->u32Signature == VBOXHDDDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
PVDIMAGE pImage = pDisk->pLast;
AssertPtrBreakStmt(pImage, rc = VERR_VD_NOT_OPENED);
vdResetModifiedFlag(pDisk);
rc = pImage->Backend->pfnFlush(pImage->pvBackendData);
} while (0);
LogFlowFunc(("returns %Rrc\n", rc));
return rc;
}
/**
* Get number of opened images in HDD container.
*
* @returns Number of opened images for HDD container. 0 if no images have been opened.
* @param pDisk Pointer to HDD container.
*/
VBOXDDU_DECL(unsigned) VDGetCount(PVBOXHDD pDisk)
{
unsigned cImages;
LogFlowFunc(("pDisk=%#p\n", pDisk));
do
{
/* sanity check */
AssertPtrBreakStmt(pDisk, cImages = 0);
AssertMsg(pDisk->u32Signature == VBOXHDDDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
cImages = pDisk->cImages;
} while (0);
LogFlowFunc(("returns %u\n", cImages));
return cImages;
}
/**
* Get read/write mode of HDD container.
*
* @returns Virtual disk ReadOnly status.
* @returns true if no image is opened in HDD container.
* @param pDisk Pointer to HDD container.
*/
VBOXDDU_DECL(bool) VDIsReadOnly(PVBOXHDD pDisk)
{
bool fReadOnly;
LogFlowFunc(("pDisk=%#p\n", pDisk));
do
{
/* sanity check */
AssertPtrBreakStmt(pDisk, fReadOnly = false);
AssertMsg(pDisk->u32Signature == VBOXHDDDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
PVDIMAGE pImage = pDisk->pLast;
AssertPtrBreakStmt(pImage, fReadOnly = true);
unsigned uOpenFlags;
uOpenFlags = pDisk->pLast->Backend->pfnGetOpenFlags(pDisk->pLast->pvBackendData);
fReadOnly = !!(uOpenFlags & VD_OPEN_FLAGS_READONLY);
} while (0);
LogFlowFunc(("returns %d\n", fReadOnly));
return fReadOnly;
}
/**
* Get total capacity of an image in HDD container.
*
* @returns Virtual disk size in bytes.
* @returns 0 if no image with specified number was not opened.
* @param pDisk Pointer to HDD container.
* @param nImage Image number, counds from 0. 0 is always base image of container.
*/
VBOXDDU_DECL(uint64_t) VDGetSize(PVBOXHDD pDisk, unsigned nImage)
{
uint64_t cbSize;
LogFlowFunc(("pDisk=%#p nImage=%u\n", pDisk, nImage));
do
{
/* sanity check */
AssertPtrBreakStmt(pDisk, cbSize = 0);
AssertMsg(pDisk->u32Signature == VBOXHDDDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
PVDIMAGE pImage = vdGetImageByNumber(pDisk, nImage);
AssertPtrBreakStmt(pImage, cbSize = 0);
cbSize = pImage->Backend->pfnGetSize(pImage->pvBackendData);
} while (0);
LogFlowFunc(("returns %llu\n", cbSize));
return cbSize;
}
/**
* Get total file size of an image in HDD container.
*
* @returns Virtual disk size in bytes.
* @returns 0 if no image is opened in HDD container.
* @param pDisk Pointer to HDD container.
* @param nImage Image number, counts from 0. 0 is always base image of container.
*/
VBOXDDU_DECL(uint64_t) VDGetFileSize(PVBOXHDD pDisk, unsigned nImage)
{
uint64_t cbSize;
LogFlowFunc(("pDisk=%#p nImage=%u\n", pDisk, nImage));
do
{
/* sanity check */
AssertPtrBreakStmt(pDisk, cbSize = 0);
AssertMsg(pDisk->u32Signature == VBOXHDDDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
PVDIMAGE pImage = vdGetImageByNumber(pDisk, nImage);
AssertPtrBreakStmt(pImage, cbSize = 0);
cbSize = pImage->Backend->pfnGetFileSize(pImage->pvBackendData);
} while (0);
LogFlowFunc(("returns %llu\n", cbSize));
return cbSize;
}
/**
* Get virtual disk PCHS geometry stored in HDD container.
*
* @returns VBox status code.
* @returns VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
* @returns VERR_VD_GEOMETRY_NOT_SET if no geometry present in the HDD container.
* @param pDisk Pointer to HDD container.
* @param nImage Image number, counts from 0. 0 is always base image of container.
* @param pPCHSGeometry Where to store PCHS geometry. Not NULL.
*/
VBOXDDU_DECL(int) VDGetPCHSGeometry(PVBOXHDD pDisk, unsigned nImage,
PPDMMEDIAGEOMETRY pPCHSGeometry)
{
int rc = VINF_SUCCESS;
LogFlowFunc(("pDisk=%#p nImage=%u pPCHSGeometry=%#p\n",
pDisk, nImage, pPCHSGeometry));
do
{
/* sanity check */
AssertPtrBreakStmt(pDisk, rc = VERR_INVALID_PARAMETER);
AssertMsg(pDisk->u32Signature == VBOXHDDDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
/* Check arguments. */
AssertMsgBreakStmt(VALID_PTR(pPCHSGeometry),
("pPCHSGeometry=%#p\n", pPCHSGeometry),
rc = VERR_INVALID_PARAMETER);
PVDIMAGE pImage = vdGetImageByNumber(pDisk, nImage);
AssertPtrBreakStmt(pImage, rc = VERR_VD_IMAGE_NOT_FOUND);
if (pImage == pDisk->pLast)
{
/* Use cached information if possible. */
if (pDisk->PCHSGeometry.cCylinders != 0)
*pPCHSGeometry = pDisk->PCHSGeometry;
else
rc = VERR_VD_GEOMETRY_NOT_SET;
}
else
rc = pImage->Backend->pfnGetPCHSGeometry(pImage->pvBackendData,
pPCHSGeometry);
} while (0);
LogFlowFunc(("%s: %Rrc (PCHS=%u/%u/%u)\n", __FUNCTION__, rc,
pDisk->PCHSGeometry.cCylinders, pDisk->PCHSGeometry.cHeads,
pDisk->PCHSGeometry.cSectors));
return rc;
}
/**
* Store virtual disk PCHS geometry in HDD container.
*
* Note that in case of unrecoverable error all images in HDD container will be closed.
*
* @returns VBox status code.
* @returns VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
* @returns VERR_VD_GEOMETRY_NOT_SET if no geometry present in the HDD container.
* @param pDisk Pointer to HDD container.
* @param nImage Image number, counts from 0. 0 is always base image of container.
* @param pPCHSGeometry Where to load PCHS geometry from. Not NULL.
*/
VBOXDDU_DECL(int) VDSetPCHSGeometry(PVBOXHDD pDisk, unsigned nImage,
PCPDMMEDIAGEOMETRY pPCHSGeometry)
{
int rc = VINF_SUCCESS;
LogFlowFunc(("pDisk=%#p nImage=%u pPCHSGeometry=%#p PCHS=%u/%u/%u\n",
pDisk, nImage, pPCHSGeometry, pPCHSGeometry->cCylinders,
pPCHSGeometry->cHeads, pPCHSGeometry->cSectors));
do
{
/* sanity check */
AssertPtrBreakStmt(pDisk, rc = VERR_INVALID_PARAMETER);
AssertMsg(pDisk->u32Signature == VBOXHDDDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
/* Check arguments. */
AssertMsgBreakStmt( VALID_PTR(pPCHSGeometry)
&& pPCHSGeometry->cHeads <= 16
&& pPCHSGeometry->cSectors <= 63,
("pPCHSGeometry=%#p PCHS=%u/%u/%u\n", pPCHSGeometry,
pPCHSGeometry->cCylinders, pPCHSGeometry->cHeads,
pPCHSGeometry->cSectors),
rc = VERR_INVALID_PARAMETER);
PVDIMAGE pImage = vdGetImageByNumber(pDisk, nImage);
AssertPtrBreakStmt(pImage, rc = VERR_VD_IMAGE_NOT_FOUND);
if (pImage == pDisk->pLast)
{
if ( pPCHSGeometry->cCylinders != pDisk->PCHSGeometry.cCylinders
|| pPCHSGeometry->cHeads != pDisk->PCHSGeometry.cHeads
|| pPCHSGeometry->cSectors != pDisk->PCHSGeometry.cSectors)
{
/* Only update geometry if it is changed. Avoids similar checks
* in every backend. Most of the time the new geometry is set
* to the previous values, so no need to go through the hassle
* of updating an image which could be opened in read-only mode
* right now. */
rc = pImage->Backend->pfnSetPCHSGeometry(pImage->pvBackendData,
pPCHSGeometry);
/* Cache new geometry values in any case. */
int rc2 = pImage->Backend->pfnGetPCHSGeometry(pImage->pvBackendData,
&pDisk->PCHSGeometry);
if (RT_FAILURE(rc2))
{
pDisk->PCHSGeometry.cCylinders = 0;
pDisk->PCHSGeometry.cHeads = 0;
pDisk->PCHSGeometry.cSectors = 0;
}
else
{
/* Make sure the CHS geometry is properly clipped. */
pDisk->PCHSGeometry.cHeads = RT_MIN(pDisk->PCHSGeometry.cHeads, 255);
pDisk->PCHSGeometry.cSectors = RT_MIN(pDisk->PCHSGeometry.cSectors, 63);
}
}
}
else
{
PDMMEDIAGEOMETRY PCHS;
rc = pImage->Backend->pfnGetPCHSGeometry(pImage->pvBackendData,
&PCHS);
if ( RT_FAILURE(rc)
|| pPCHSGeometry->cCylinders != PCHS.cCylinders
|| pPCHSGeometry->cHeads != PCHS.cHeads
|| pPCHSGeometry->cSectors != PCHS.cSectors)
{
/* Only update geometry if it is changed. Avoids similar checks
* in every backend. Most of the time the new geometry is set
* to the previous values, so no need to go through the hassle
* of updating an image which could be opened in read-only mode
* right now. */
rc = pImage->Backend->pfnSetPCHSGeometry(pImage->pvBackendData,
pPCHSGeometry);
}
}
} while (0);
LogFlowFunc(("returns %Rrc\n", rc));
return rc;
}
/**
* Get virtual disk LCHS geometry stored in HDD container.
*
* @returns VBox status code.
* @returns VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
* @returns VERR_VD_GEOMETRY_NOT_SET if no geometry present in the HDD container.
* @param pDisk Pointer to HDD container.
* @param nImage Image number, counts from 0. 0 is always base image of container.
* @param pLCHSGeometry Where to store LCHS geometry. Not NULL.
*/
VBOXDDU_DECL(int) VDGetLCHSGeometry(PVBOXHDD pDisk, unsigned nImage,
PPDMMEDIAGEOMETRY pLCHSGeometry)
{
int rc = VINF_SUCCESS;
LogFlowFunc(("pDisk=%#p nImage=%u pLCHSGeometry=%#p\n",
pDisk, nImage, pLCHSGeometry));
do
{
/* sanity check */
AssertPtrBreakStmt(pDisk, rc = VERR_INVALID_PARAMETER);
AssertMsg(pDisk->u32Signature == VBOXHDDDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
/* Check arguments. */
AssertMsgBreakStmt(VALID_PTR(pLCHSGeometry),
("pLCHSGeometry=%#p\n", pLCHSGeometry),
rc = VERR_INVALID_PARAMETER);
PVDIMAGE pImage = vdGetImageByNumber(pDisk, nImage);
AssertPtrBreakStmt(pImage, rc = VERR_VD_IMAGE_NOT_FOUND);
if (pImage == pDisk->pLast)
{
/* Use cached information if possible. */
if (pDisk->LCHSGeometry.cCylinders != 0)
*pLCHSGeometry = pDisk->LCHSGeometry;
else
rc = VERR_VD_GEOMETRY_NOT_SET;
}
else
rc = pImage->Backend->pfnGetLCHSGeometry(pImage->pvBackendData,
pLCHSGeometry);
} while (0);
LogFlowFunc((": %Rrc (LCHS=%u/%u/%u)\n", rc,
pDisk->LCHSGeometry.cCylinders, pDisk->LCHSGeometry.cHeads,
pDisk->LCHSGeometry.cSectors));
return rc;
}
/**
* Store virtual disk LCHS geometry in HDD container.
*
* Note that in case of unrecoverable error all images in HDD container will be closed.
*
* @returns VBox status code.
* @returns VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
* @returns VERR_VD_GEOMETRY_NOT_SET if no geometry present in the HDD container.
* @param pDisk Pointer to HDD container.
* @param nImage Image number, counts from 0. 0 is always base image of container.
* @param pLCHSGeometry Where to load LCHS geometry from. Not NULL.
*/
VBOXDDU_DECL(int) VDSetLCHSGeometry(PVBOXHDD pDisk, unsigned nImage,
PCPDMMEDIAGEOMETRY pLCHSGeometry)
{
int rc = VINF_SUCCESS;
LogFlowFunc(("pDisk=%#p nImage=%u pLCHSGeometry=%#p LCHS=%u/%u/%u\n",
pDisk, nImage, pLCHSGeometry, pLCHSGeometry->cCylinders,
pLCHSGeometry->cHeads, pLCHSGeometry->cSectors));
do
{
/* sanity check */
AssertPtrBreakStmt(pDisk, rc = VERR_INVALID_PARAMETER);
AssertMsg(pDisk->u32Signature == VBOXHDDDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
/* Check arguments. */
AssertMsgBreakStmt( VALID_PTR(pLCHSGeometry)
&& pLCHSGeometry->cHeads <= 255
&& pLCHSGeometry->cSectors <= 63,
("pLCHSGeometry=%#p LCHS=%u/%u/%u\n", pLCHSGeometry,
pLCHSGeometry->cCylinders, pLCHSGeometry->cHeads,
pLCHSGeometry->cSectors),
rc = VERR_INVALID_PARAMETER);
PVDIMAGE pImage = vdGetImageByNumber(pDisk, nImage);
AssertPtrBreakStmt(pImage, rc = VERR_VD_IMAGE_NOT_FOUND);
if (pImage == pDisk->pLast)
{
if ( pLCHSGeometry->cCylinders != pDisk->LCHSGeometry.cCylinders
|| pLCHSGeometry->cHeads != pDisk->LCHSGeometry.cHeads
|| pLCHSGeometry->cSectors != pDisk->LCHSGeometry.cSectors)
{
/* Only update geometry if it is changed. Avoids similar checks
* in every backend. Most of the time the new geometry is set
* to the previous values, so no need to go through the hassle
* of updating an image which could be opened in read-only mode
* right now. */
rc = pImage->Backend->pfnSetLCHSGeometry(pImage->pvBackendData,
pLCHSGeometry);
/* Cache new geometry values in any case. */
int rc2 = pImage->Backend->pfnGetLCHSGeometry(pImage->pvBackendData,
&pDisk->LCHSGeometry);
if (RT_FAILURE(rc2))
{
pDisk->LCHSGeometry.cCylinders = 0;
pDisk->LCHSGeometry.cHeads = 0;
pDisk->LCHSGeometry.cSectors = 0;
}
else
{
/* Make sure the CHS geometry is properly clipped. */
pDisk->LCHSGeometry.cHeads = RT_MIN(pDisk->LCHSGeometry.cHeads, 255);
pDisk->LCHSGeometry.cSectors = RT_MIN(pDisk->LCHSGeometry.cSectors, 63);
}
}
}
else
{
PDMMEDIAGEOMETRY LCHS;
rc = pImage->Backend->pfnGetLCHSGeometry(pImage->pvBackendData,
&LCHS);
if ( RT_FAILURE(rc)
|| pLCHSGeometry->cCylinders != LCHS.cCylinders
|| pLCHSGeometry->cHeads != LCHS.cHeads
|| pLCHSGeometry->cSectors != LCHS.cSectors)
{
/* Only update geometry if it is changed. Avoids similar checks
* in every backend. Most of the time the new geometry is set
* to the previous values, so no need to go through the hassle
* of updating an image which could be opened in read-only mode
* right now. */
rc = pImage->Backend->pfnSetLCHSGeometry(pImage->pvBackendData,
pLCHSGeometry);
}
}
} while (0);
LogFlowFunc(("returns %Rrc\n", rc));
return rc;
}
/**
* Get version of image in HDD container.
*
* @returns VBox status code.
* @returns VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
* @param pDisk Pointer to HDD container.
* @param nImage Image number, counts from 0. 0 is always base image of container.
* @param puVersion Where to store the image version.
*/
VBOXDDU_DECL(int) VDGetVersion(PVBOXHDD pDisk, unsigned nImage,
unsigned *puVersion)
{
int rc = VINF_SUCCESS;
LogFlowFunc(("pDisk=%#p nImage=%u puVersion=%#p\n",
pDisk, nImage, puVersion));
do
{
/* sanity check */
AssertPtrBreakStmt(pDisk, rc = VERR_INVALID_PARAMETER);
AssertMsg(pDisk->u32Signature == VBOXHDDDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
/* Check arguments. */
AssertMsgBreakStmt(VALID_PTR(puVersion),
("puVersion=%#p\n", puVersion),
rc = VERR_INVALID_PARAMETER);
PVDIMAGE pImage = vdGetImageByNumber(pDisk, nImage);
AssertPtrBreakStmt(pImage, rc = VERR_VD_IMAGE_NOT_FOUND);
*puVersion = pImage->Backend->pfnGetVersion(pImage->pvBackendData);
} while (0);
LogFlowFunc(("returns %Rrc uVersion=%#x\n", rc, *puVersion));
return rc;
}
/**
* List the capabilities of image backend in HDD container.
*
* @returns VBox status code.
* @returns VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
* @param pDisk Pointer to the HDD container.
* @param nImage Image number, counts from 0. 0 is always base image of container.
* @param pbackendInfo Where to store the backend information.
*/
VBOXDDU_DECL(int) VDBackendInfoSingle(PVBOXHDD pDisk, unsigned nImage,
PVDBACKENDINFO pBackendInfo)
{
int rc = VINF_SUCCESS;
LogFlowFunc(("pDisk=%#p nImage=%u pBackendInfo=%#p\n",
pDisk, nImage, pBackendInfo));
do
{
/* sanity check */
AssertPtrBreakStmt(pDisk, rc = VERR_INVALID_PARAMETER);
AssertMsg(pDisk->u32Signature == VBOXHDDDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
/* Check arguments. */
AssertMsgBreakStmt(VALID_PTR(pBackendInfo),
("pBackendInfo=%#p\n", pBackendInfo),
rc = VERR_INVALID_PARAMETER);
PVDIMAGE pImage = vdGetImageByNumber(pDisk, nImage);
AssertPtrBreakStmt(pImage, rc = VERR_VD_IMAGE_NOT_FOUND);
pBackendInfo->pszBackend = RTStrDup(pImage->Backend->pszBackendName);
pBackendInfo->uBackendCaps = pImage->Backend->uBackendCaps;
pBackendInfo->papszFileExtensions = pImage->Backend->papszFileExtensions;
pBackendInfo->paConfigInfo = pImage->Backend->paConfigInfo;
} while (0);
LogFlowFunc(("returns %Rrc\n", rc));
return rc;
}
/**
* Get flags of image in HDD container.
*
* @returns VBox status code.
* @returns VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
* @param pDisk Pointer to HDD container.
* @param nImage Image number, counts from 0. 0 is always base image of container.
* @param puImageFlags Where to store the image flags.
*/
VBOXDDU_DECL(int) VDGetImageFlags(PVBOXHDD pDisk, unsigned nImage,
unsigned *puImageFlags)
{
int rc = VINF_SUCCESS;
LogFlowFunc(("pDisk=%#p nImage=%u puImageFlags=%#p\n",
pDisk, nImage, puImageFlags));
do
{
/* sanity check */
AssertPtrBreakStmt(pDisk, rc = VERR_INVALID_PARAMETER);
AssertMsg(pDisk->u32Signature == VBOXHDDDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
/* Check arguments. */
AssertMsgBreakStmt(VALID_PTR(puImageFlags),
("puImageFlags=%#p\n", puImageFlags),
rc = VERR_INVALID_PARAMETER);
PVDIMAGE pImage = vdGetImageByNumber(pDisk, nImage);
AssertPtrBreakStmt(pImage, rc = VERR_VD_IMAGE_NOT_FOUND);
*puImageFlags = pImage->Backend->pfnGetImageFlags(pImage->pvBackendData);
} while (0);
LogFlowFunc(("returns %Rrc uImageFlags=%#x\n", rc, *puImageFlags));
return rc;
}
/**
* Get open flags of image in HDD container.
*
* @returns VBox status code.
* @returns VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
* @param pDisk Pointer to HDD container.
* @param nImage Image number, counts from 0. 0 is always base image of container.
* @param puOpenFlags Where to store the image open flags.
*/
VBOXDDU_DECL(int) VDGetOpenFlags(PVBOXHDD pDisk, unsigned nImage,
unsigned *puOpenFlags)
{
int rc = VINF_SUCCESS;
LogFlowFunc(("pDisk=%#p nImage=%u puOpenFlags=%#p\n",
pDisk, nImage, puOpenFlags));
do
{
/* sanity check */
AssertPtrBreakStmt(pDisk, rc = VERR_INVALID_PARAMETER);
AssertMsg(pDisk->u32Signature == VBOXHDDDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
/* Check arguments. */
AssertMsgBreakStmt(VALID_PTR(puOpenFlags),
("puOpenFlags=%#p\n", puOpenFlags),
rc = VERR_INVALID_PARAMETER);
PVDIMAGE pImage = vdGetImageByNumber(pDisk, nImage);
AssertPtrBreakStmt(pImage, rc = VERR_VD_IMAGE_NOT_FOUND);
*puOpenFlags = pImage->Backend->pfnGetOpenFlags(pImage->pvBackendData);
} while (0);
LogFlowFunc(("returns %Rrc uOpenFlags=%#x\n", rc, *puOpenFlags));
return rc;
}
/**
* Set open flags of image in HDD container.
* This operation may cause file locking changes and/or files being reopened.
* Note that in case of unrecoverable error all images in HDD container will be closed.
*
* @returns VBox status code.
* @returns VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
* @param pDisk Pointer to HDD container.
* @param nImage Image number, counts from 0. 0 is always base image of container.
* @param uOpenFlags Image file open mode, see VD_OPEN_FLAGS_* constants.
*/
VBOXDDU_DECL(int) VDSetOpenFlags(PVBOXHDD pDisk, unsigned nImage,
unsigned uOpenFlags)
{
int rc;
LogFlowFunc(("pDisk=%#p uOpenFlags=%#u\n", pDisk, uOpenFlags));
do
{
/* sanity check */
AssertPtrBreakStmt(pDisk, rc = VERR_INVALID_PARAMETER);
AssertMsg(pDisk->u32Signature == VBOXHDDDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
/* Check arguments. */
AssertMsgBreakStmt((uOpenFlags & ~VD_OPEN_FLAGS_MASK) == 0,
("uOpenFlags=%#x\n", uOpenFlags),
rc = VERR_INVALID_PARAMETER);
PVDIMAGE pImage = vdGetImageByNumber(pDisk, nImage);
AssertPtrBreakStmt(pImage, rc = VERR_VD_IMAGE_NOT_FOUND);
rc = pImage->Backend->pfnSetOpenFlags(pImage->pvBackendData,
uOpenFlags);
} while (0);
LogFlowFunc(("returns %Rrc\n", rc));
return rc;
}
/**
* Get base filename of image in HDD container. Some image formats use
* other filenames as well, so don't use this for anything but informational
* purposes.
*
* @returns VBox status code.
* @returns VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
* @returns VERR_BUFFER_OVERFLOW if pszFilename buffer too small to hold filename.
* @param pDisk Pointer to HDD container.
* @param nImage Image number, counts from 0. 0 is always base image of container.
* @param pszFilename Where to store the image file name.
* @param cbFilename Size of buffer pszFilename points to.
*/
VBOXDDU_DECL(int) VDGetFilename(PVBOXHDD pDisk, unsigned nImage,
char *pszFilename, unsigned cbFilename)
{
int rc;
LogFlowFunc(("pDisk=%#p nImage=%u pszFilename=%#p cbFilename=%u\n",
pDisk, nImage, pszFilename, cbFilename));
do
{
/* sanity check */
AssertPtrBreakStmt(pDisk, rc = VERR_INVALID_PARAMETER);
AssertMsg(pDisk->u32Signature == VBOXHDDDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
/* Check arguments. */
AssertMsgBreakStmt(VALID_PTR(pszFilename) && *pszFilename,
("pszFilename=%#p \"%s\"\n", pszFilename, pszFilename),
rc = VERR_INVALID_PARAMETER);
AssertMsgBreakStmt(cbFilename,
("cbFilename=%u\n", cbFilename),
rc = VERR_INVALID_PARAMETER);
PVDIMAGE pImage = vdGetImageByNumber(pDisk, nImage);
AssertPtrBreakStmt(pImage, rc = VERR_VD_IMAGE_NOT_FOUND);
size_t cb = strlen(pImage->pszFilename);
if (cb <= cbFilename)
{
strcpy(pszFilename, pImage->pszFilename);
rc = VINF_SUCCESS;
}
else
{
strncpy(pszFilename, pImage->pszFilename, cbFilename - 1);
pszFilename[cbFilename - 1] = '\0';
rc = VERR_BUFFER_OVERFLOW;
}
} while (0);
LogFlowFunc(("returns %Rrc, pszFilename=\"%s\"\n", rc, pszFilename));
return rc;
}
/**
* Get the comment line of image in HDD container.
*
* @returns VBox status code.
* @returns VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
* @returns VERR_BUFFER_OVERFLOW if pszComment buffer too small to hold comment text.
* @param pDisk Pointer to HDD container.
* @param nImage Image number, counts from 0. 0 is always base image of container.
* @param pszComment Where to store the comment string of image. NULL is ok.
* @param cbComment The size of pszComment buffer. 0 is ok.
*/
VBOXDDU_DECL(int) VDGetComment(PVBOXHDD pDisk, unsigned nImage,
char *pszComment, unsigned cbComment)
{
int rc;
LogFlowFunc(("pDisk=%#p nImage=%u pszComment=%#p cbComment=%u\n",
pDisk, nImage, pszComment, cbComment));
do
{
/* sanity check */
AssertPtrBreakStmt(pDisk, rc = VERR_INVALID_PARAMETER);
AssertMsg(pDisk->u32Signature == VBOXHDDDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
/* Check arguments. */
AssertMsgBreakStmt(VALID_PTR(pszComment),
("pszComment=%#p \"%s\"\n", pszComment, pszComment),
rc = VERR_INVALID_PARAMETER);
AssertMsgBreakStmt(cbComment,
("cbComment=%u\n", cbComment),
rc = VERR_INVALID_PARAMETER);
PVDIMAGE pImage = vdGetImageByNumber(pDisk, nImage);
AssertPtrBreakStmt(pImage, rc = VERR_VD_IMAGE_NOT_FOUND);
rc = pImage->Backend->pfnGetComment(pImage->pvBackendData, pszComment,
cbComment);
} while (0);
LogFlowFunc(("returns %Rrc, pszComment=\"%s\"\n", rc, pszComment));
return rc;
}
/**
* Changes the comment line of image in HDD container.
*
* @returns VBox status code.
* @returns VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
* @param pDisk Pointer to HDD container.
* @param nImage Image number, counts from 0. 0 is always base image of container.
* @param pszComment New comment string (UTF-8). NULL is allowed to reset the comment.
*/
VBOXDDU_DECL(int) VDSetComment(PVBOXHDD pDisk, unsigned nImage,
const char *pszComment)
{
int rc;
LogFlowFunc(("pDisk=%#p nImage=%u pszComment=%#p \"%s\"\n",
pDisk, nImage, pszComment, pszComment));
do
{
/* sanity check */
AssertPtrBreakStmt(pDisk, rc = VERR_INVALID_PARAMETER);
AssertMsg(pDisk->u32Signature == VBOXHDDDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
/* Check arguments. */
AssertMsgBreakStmt(VALID_PTR(pszComment) || pszComment == NULL,
("pszComment=%#p \"%s\"\n", pszComment, pszComment),
rc = VERR_INVALID_PARAMETER);
PVDIMAGE pImage = vdGetImageByNumber(pDisk, nImage);
AssertPtrBreakStmt(pImage, rc = VERR_VD_IMAGE_NOT_FOUND);
rc = pImage->Backend->pfnSetComment(pImage->pvBackendData, pszComment);
} while (0);
LogFlowFunc(("returns %Rrc\n", rc));
return rc;
}
/**
* Get UUID of image in HDD container.
*
* @returns VBox status code.
* @returns VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
* @param pDisk Pointer to HDD container.
* @param nImage Image number, counts from 0. 0 is always base image of container.
* @param pUuid Where to store the image creation UUID.
*/
VBOXDDU_DECL(int) VDGetUuid(PVBOXHDD pDisk, unsigned nImage, PRTUUID pUuid)
{
int rc;
LogFlowFunc(("pDisk=%#p nImage=%u pUuid=%#p\n", pDisk, nImage, pUuid));
do
{
/* sanity check */
AssertPtrBreakStmt(pDisk, rc = VERR_INVALID_PARAMETER);
AssertMsg(pDisk->u32Signature == VBOXHDDDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
/* Check arguments. */
AssertMsgBreakStmt(VALID_PTR(pUuid),
("pUuid=%#p\n", pUuid),
rc = VERR_INVALID_PARAMETER);
PVDIMAGE pImage = vdGetImageByNumber(pDisk, nImage);
AssertPtrBreakStmt(pImage, rc = VERR_VD_IMAGE_NOT_FOUND);
rc = pImage->Backend->pfnGetUuid(pImage->pvBackendData, pUuid);
} while (0);
LogFlowFunc(("returns %Rrc, Uuid={%RTuuid}\n", rc, pUuid));
return rc;
}
/**
* Set the image's UUID. Should not be used by normal applications.
*
* @returns VBox status code.
* @returns VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
* @param pDisk Pointer to HDD container.
* @param nImage Image number, counts from 0. 0 is always base image of container.
* @param pUuid New UUID of the image. If NULL, a new UUID is created.
*/
VBOXDDU_DECL(int) VDSetUuid(PVBOXHDD pDisk, unsigned nImage, PCRTUUID pUuid)
{
int rc;
LogFlowFunc(("pDisk=%#p nImage=%u pUuid=%#p {%RTuuid}\n",
pDisk, nImage, pUuid, pUuid));
do
{
/* sanity check */
AssertPtrBreakStmt(pDisk, rc = VERR_INVALID_PARAMETER);
AssertMsg(pDisk->u32Signature == VBOXHDDDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
AssertMsgBreakStmt(VALID_PTR(pUuid) || pUuid == NULL,
("pUuid=%#p\n", pUuid),
rc = VERR_INVALID_PARAMETER);
PVDIMAGE pImage = vdGetImageByNumber(pDisk, nImage);
AssertPtrBreakStmt(pImage, rc = VERR_VD_IMAGE_NOT_FOUND);
RTUUID Uuid;
if (!pUuid)
{
RTUuidCreate(&Uuid);
pUuid = &Uuid;
}
rc = pImage->Backend->pfnSetUuid(pImage->pvBackendData, pUuid);
} while (0);
LogFlowFunc(("returns %Rrc\n", rc));
return rc;
}
/**
* Get last modification UUID of image in HDD container.
*
* @returns VBox status code.
* @returns VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
* @param pDisk Pointer to HDD container.
* @param nImage Image number, counts from 0. 0 is always base image of container.
* @param pUuid Where to store the image modification UUID.
*/
VBOXDDU_DECL(int) VDGetModificationUuid(PVBOXHDD pDisk, unsigned nImage, PRTUUID pUuid)
{
int rc = VINF_SUCCESS;
LogFlowFunc(("pDisk=%#p nImage=%u pUuid=%#p\n", pDisk, nImage, pUuid));
do
{
/* sanity check */
AssertPtrBreakStmt(pDisk, rc = VERR_INVALID_PARAMETER);
AssertMsg(pDisk->u32Signature == VBOXHDDDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
/* Check arguments. */
AssertMsgBreakStmt(VALID_PTR(pUuid),
("pUuid=%#p\n", pUuid),
rc = VERR_INVALID_PARAMETER);
PVDIMAGE pImage = vdGetImageByNumber(pDisk, nImage);
AssertPtrBreakStmt(pImage, rc = VERR_VD_IMAGE_NOT_FOUND);
rc = pImage->Backend->pfnGetModificationUuid(pImage->pvBackendData,
pUuid);
} while (0);
LogFlowFunc(("returns %Rrc, Uuid={%RTuuid}\n", rc, pUuid));
return rc;
}
/**
* Set the image's last modification UUID. Should not be used by normal applications.
*
* @returns VBox status code.
* @returns VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
* @param pDisk Pointer to HDD container.
* @param nImage Image number, counts from 0. 0 is always base image of container.
* @param pUuid New modification UUID of the image. If NULL, a new UUID is created.
*/
VBOXDDU_DECL(int) VDSetModificationUuid(PVBOXHDD pDisk, unsigned nImage, PCRTUUID pUuid)
{
int rc;
LogFlowFunc(("pDisk=%#p nImage=%u pUuid=%#p {%RTuuid}\n",
pDisk, nImage, pUuid, pUuid));
do
{
/* sanity check */
AssertPtrBreakStmt(pDisk, rc = VERR_INVALID_PARAMETER);
AssertMsg(pDisk->u32Signature == VBOXHDDDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
/* Check arguments. */
AssertMsgBreakStmt(VALID_PTR(pUuid) || pUuid == NULL,
("pUuid=%#p\n", pUuid),
rc = VERR_INVALID_PARAMETER);
PVDIMAGE pImage = vdGetImageByNumber(pDisk, nImage);
AssertPtrBreakStmt(pImage, rc = VERR_VD_IMAGE_NOT_FOUND);
RTUUID Uuid;
if (!pUuid)
{
RTUuidCreate(&Uuid);
pUuid = &Uuid;
}
rc = pImage->Backend->pfnSetModificationUuid(pImage->pvBackendData,
pUuid);
} while (0);
LogFlowFunc(("returns %Rrc\n", rc));
return rc;
}
/**
* Get parent UUID of image in HDD container.
*
* @returns VBox status code.
* @returns VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
* @param pDisk Pointer to HDD container.
* @param nImage Image number, counts from 0. 0 is always base image of container.
* @param pUuid Where to store the parent image UUID.
*/
VBOXDDU_DECL(int) VDGetParentUuid(PVBOXHDD pDisk, unsigned nImage,
PRTUUID pUuid)
{
int rc = VINF_SUCCESS;
LogFlowFunc(("pDisk=%#p nImage=%u pUuid=%#p\n", pDisk, nImage, pUuid));
do
{
/* sanity check */
AssertPtrBreakStmt(pDisk, rc = VERR_INVALID_PARAMETER);
AssertMsg(pDisk->u32Signature == VBOXHDDDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
/* Check arguments. */
AssertMsgBreakStmt(VALID_PTR(pUuid),
("pUuid=%#p\n", pUuid),
rc = VERR_INVALID_PARAMETER);
PVDIMAGE pImage = vdGetImageByNumber(pDisk, nImage);
AssertPtrBreakStmt(pImage, rc = VERR_VD_IMAGE_NOT_FOUND);
rc = pImage->Backend->pfnGetParentUuid(pImage->pvBackendData, pUuid);
} while (0);
LogFlowFunc(("returns %Rrc, Uuid={%RTuuid}\n", rc, pUuid));
return rc;
}
/**
* Set the image's parent UUID. Should not be used by normal applications.
*
* @returns VBox status code.
* @param pDisk Pointer to HDD container.
* @param nImage Image number, counts from 0. 0 is always base image of container.
* @param pUuid New parent UUID of the image. If NULL, a new UUID is created.
*/
VBOXDDU_DECL(int) VDSetParentUuid(PVBOXHDD pDisk, unsigned nImage,
PCRTUUID pUuid)
{
int rc;
LogFlowFunc(("pDisk=%#p nImage=%u pUuid=%#p {%RTuuid}\n",
pDisk, nImage, pUuid, pUuid));
do
{
/* sanity check */
AssertPtrBreakStmt(pDisk, rc = VERR_INVALID_PARAMETER);
AssertMsg(pDisk->u32Signature == VBOXHDDDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
/* Check arguments. */
AssertMsgBreakStmt(VALID_PTR(pUuid) || pUuid == NULL,
("pUuid=%#p\n", pUuid),
rc = VERR_INVALID_PARAMETER);
PVDIMAGE pImage = vdGetImageByNumber(pDisk, nImage);
AssertPtrBreakStmt(pImage, rc = VERR_VD_IMAGE_NOT_FOUND);
RTUUID Uuid;
if (!pUuid)
{
RTUuidCreate(&Uuid);
pUuid = &Uuid;
}
rc = pImage->Backend->pfnSetParentUuid(pImage->pvBackendData, pUuid);
} while (0);
LogFlowFunc(("returns %Rrc\n", rc));
return rc;
}
/**
* Debug helper - dumps all opened images in HDD container into the log file.
*
* @param pDisk Pointer to HDD container.
*/
VBOXDDU_DECL(void) VDDumpImages(PVBOXHDD pDisk)
{
do
{
/* sanity check */
AssertPtrBreak(pDisk);
AssertMsg(pDisk->u32Signature == VBOXHDDDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
int (*pfnMessage)(void *, const char *, ...) = NULL;
void *pvUser = pDisk->pInterfaceError->pvUser;
if (pDisk->pInterfaceErrorCallbacks && VALID_PTR(pDisk->pInterfaceErrorCallbacks->pfnMessage))
pfnMessage = pDisk->pInterfaceErrorCallbacks->pfnMessage;
else
{
pDisk->pInterfaceErrorCallbacks->pfnMessage = vdLogMessage;
pfnMessage = vdLogMessage;
}
pfnMessage(pvUser, "--- Dumping VD Disk, Images=%u\n", pDisk->cImages);
for (PVDIMAGE pImage = pDisk->pBase; pImage; pImage = pImage->pNext)
{
pfnMessage(pvUser, "Dumping VD image \"%s\" (Backend=%s)\n",
pImage->pszFilename, pImage->Backend->pszBackendName);
pImage->Backend->pfnDump(pImage->pvBackendData);
}
} while (0);
}
/**
* Query if asynchronous operations are supported for this disk.
*
* @returns VBox status code.
* @returns VERR_VD_IMAGE_NOT_FOUND if image with specified number was not opened.
* @param pDisk Pointer to the HDD container.
* @param nImage Image number, counts from 0. 0 is always base image of container.
* @param pfAIOSupported Where to store if async IO is supported.
*/
VBOXDDU_DECL(int) VDImageIsAsyncIOSupported(PVBOXHDD pDisk, unsigned nImage, bool *pfAIOSupported)
{
int rc = VINF_SUCCESS;
LogFlowFunc(("pDisk=%#p nImage=%u pfAIOSupported=%#p\n", pDisk, nImage, pfAIOSupported));
do
{
/* sanity check */
AssertPtrBreakStmt(pDisk, rc = VERR_INVALID_PARAMETER);
AssertMsg(pDisk->u32Signature == VBOXHDDDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
/* Check arguments. */
AssertMsgBreakStmt(VALID_PTR(pfAIOSupported),
("pfAIOSupported=%#p\n", pfAIOSupported),
rc = VERR_INVALID_PARAMETER);
PVDIMAGE pImage = vdGetImageByNumber(pDisk, nImage);
AssertPtrBreakStmt(pImage, rc = VERR_VD_IMAGE_NOT_FOUND);
if (pImage->Backend->uBackendCaps & VD_CAP_ASYNC)
*pfAIOSupported = pImage->Backend->pfnIsAsyncIOSupported(pImage->pvBackendData);
else
*pfAIOSupported = false;
} while (0);
LogFlowFunc(("returns %Rrc, fAIOSupported=%u\n", rc, *pfAIOSupported));
return rc;
}
/**
* Start a asynchronous read request.
*
* @returns VBox status code.
* @param pDisk Pointer to the HDD container.
* @param uOffset The offset of the virtual disk to read from.
* @param cbRead How many bytes to read.
* @param paSeg Pointer to an array of segments.
* @param cSeg Number of segments in the array.
* @param pvUser User data which is passed on completion
*/
VBOXDDU_DECL(int) VDAsyncRead(PVBOXHDD pDisk, uint64_t uOffset, size_t cbRead,
PPDMDATASEG paSeg, unsigned cSeg,
void *pvUser)
{
int rc = VERR_VD_BLOCK_FREE;
LogFlowFunc(("pDisk=%#p uOffset=%llu paSeg=%p cSeg=%u cbRead=%zu\n",
pDisk, uOffset, paSeg, cSeg, cbRead));
do
{
/* sanity check */
AssertPtrBreakStmt(pDisk, rc = VERR_INVALID_PARAMETER);
AssertMsg(pDisk->u32Signature == VBOXHDDDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
/* Check arguments. */
AssertMsgBreakStmt(cbRead,
("cbRead=%zu\n", cbRead),
rc = VERR_INVALID_PARAMETER);
AssertMsgBreakStmt(uOffset + cbRead <= pDisk->cbSize,
("uOffset=%llu cbRead=%zu pDisk->cbSize=%llu\n",
uOffset, cbRead, pDisk->cbSize),
rc = VERR_INVALID_PARAMETER);
AssertMsgBreakStmt(VALID_PTR(paSeg),
("paSeg=%#p\n", paSeg),
rc = VERR_INVALID_PARAMETER);
AssertMsgBreakStmt(cSeg,
("cSeg=%zu\n", cSeg),
rc = VERR_INVALID_PARAMETER);
PVDIMAGE pImage = pDisk->pLast;
AssertPtrBreakStmt(pImage, rc = VERR_VD_NOT_OPENED);
/* @todo: This does not work for images which do not have all meta data in memory. */
for (PVDIMAGE pCurrImage = pImage;
pCurrImage != NULL && rc == VERR_VD_BLOCK_FREE;
pCurrImage = pCurrImage->pPrev)
{
rc = pCurrImage->Backend->pfnAsyncRead(pCurrImage->pvBackendData,
uOffset, cbRead, paSeg, cSeg,
pvUser);
}
/* No image in the chain contains the data for the block. */
if (rc == VERR_VD_BLOCK_FREE)
{
for (unsigned i = 0; i < cSeg && (cbRead > 0); i++)
{
memset(paSeg[i].pvSeg, '\0', paSeg[i].cbSeg);
cbRead -= paSeg[i].cbSeg;
}
/* Request finished without the need to enqueue a async I/O request. Tell caller. */
rc = VINF_VD_ASYNC_IO_FINISHED;
}
} while (0);
LogFlowFunc(("returns %Rrc\n", rc));
return rc;
}
/**
* Start a asynchronous write request.
*
* @returns VBox status code.
* @param pDisk Pointer to the HDD container.
* @param uOffset The offset of the virtual disk to write to.
* @param cbWrtie How many bytes to write.
* @param paSeg Pointer to an array of segments.
* @param cSeg Number of segments in the array.
* @param pvUser User data which is passed on completion.
*/
VBOXDDU_DECL(int) VDAsyncWrite(PVBOXHDD pDisk, uint64_t uOffset, size_t cbWrite,
PPDMDATASEG paSeg, unsigned cSeg,
void *pvUser)
{
int rc;
LogFlowFunc(("pDisk=%#p uOffset=%llu paSeg=%p cSeg=%u cbWrite=%zu\n",
pDisk, uOffset, paSeg, cSeg, cbWrite));
do
{
/* sanity check */
AssertPtrBreakStmt(pDisk, rc = VERR_INVALID_PARAMETER);
AssertMsg(pDisk->u32Signature == VBOXHDDDISK_SIGNATURE, ("u32Signature=%08x\n", pDisk->u32Signature));
/* Check arguments. */
AssertMsgBreakStmt(cbWrite,
("cbWrite=%zu\n", cbWrite),
rc = VERR_INVALID_PARAMETER);
AssertMsgBreakStmt(uOffset + cbWrite <= pDisk->cbSize,
("uOffset=%llu cbWrite=%zu pDisk->cbSize=%llu\n",
uOffset, cbWrite, pDisk->cbSize),
rc = VERR_INVALID_PARAMETER);
AssertMsgBreakStmt(VALID_PTR(paSeg),
("paSeg=%#p\n", paSeg),
rc = VERR_INVALID_PARAMETER);
AssertMsgBreakStmt(cSeg,
("cSeg=%zu\n", cSeg),
rc = VERR_INVALID_PARAMETER);
PVDIMAGE pImage = pDisk->pLast;
AssertPtrBreakStmt(pImage, rc = VERR_VD_NOT_OPENED);
vdSetModifiedFlag(pDisk);
rc = pImage->Backend->pfnAsyncWrite(pImage->pvBackendData,
uOffset, cbWrite,
paSeg, cSeg, pvUser);
} while (0);
LogFlowFunc(("returns %Rrc\n", rc));
return rc;
}
#if 0
/** @copydoc VBOXHDDBACKEND::pfnComposeLocation */
int genericFileComposeLocation(PVDINTERFACE pConfig, char **pszLocation)
{
return NULL;
}
/** @copydoc VBOXHDDBACKEND::pfnComposeName */
int genericFileComposeName(PVDINTERFACE pConfig, char **pszName)
{
return NULL;
}
#endif