/* $Id: MediumImpl.cpp 23327 2009-09-25 11:36:00Z vboxsync $ */ /** @file * * VirtualBox COM class implementation */ /* * Copyright (C) 2008-2009 Sun Microsystems, Inc. * * This file is part of VirtualBox Open Source Edition (OSE), as * available from http://www.virtualbox.org. This file is free software; * you can redistribute it and/or modify it under the terms of the GNU * General Public License (GPL) as published by the Free Software * Foundation, in version 2 as it comes in the "COPYING" file of the * VirtualBox OSE distribution. VirtualBox OSE is distributed in the * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind. * * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa * Clara, CA 95054 USA or visit http://www.sun.com if you need * additional information or have any questions. */ #include "MediumImpl.h" #include "ProgressImpl.h" #include "SystemPropertiesImpl.h" #include "VirtualBoxImpl.h" #include "Logging.h" #include #include #include #include #include #include #include #include #include #include //////////////////////////////////////////////////////////////////////////////// // // Medium data definition // //////////////////////////////////////////////////////////////////////////////// /** Describes how a machine refers to this image. */ struct BackRef { /** Equality predicate for stdc++. */ struct EqualsTo : public std::unary_function { explicit EqualsTo(const Guid &aMachineId) : machineId(aMachineId) {} bool operator()(const argument_type &aThat) const { return aThat.machineId == machineId; } const Guid machineId; }; typedef std::list GuidList; BackRef() : inCurState(false) {} BackRef(const Guid &aMachineId, const Guid &aSnapshotId = Guid::Empty) : machineId(aMachineId) , inCurState(aSnapshotId.isEmpty()) { if (!aSnapshotId.isEmpty()) snapshotIds.push_back(aSnapshotId); } Guid machineId; bool inCurState : 1; GuidList snapshotIds; }; typedef std::list BackRefList; struct Medium::Data { Data() : state(MediumState_NotCreated), size(0), readers(0), queryInfoSem(NIL_RTSEMEVENTMULTI), queryInfoCallers(0), accessibleInLock(false), type(MediumType_Normal), logicalSize(0), hddOpenMode(OpenReadWrite), autoReset(false), setImageId(false), setParentId(false), hostDrive(FALSE), implicit(false), numCreateDiffTasks(0), vdProgress(NULL), vdDiskIfaces(NULL) {} const Guid id; Bstr description; MediumState_T state; Bstr location; Bstr locationFull; uint64_t size; Bstr lastAccessError; BackRefList backRefs; size_t readers; RTSEMEVENTMULTI queryInfoSem; size_t queryInfoCallers; bool accessibleInLock : 1; const Bstr format; ComObjPtr formatObj; MediumType_T type; uint64_t logicalSize; /*< In MBytes. */ HDDOpenMode hddOpenMode; BOOL autoReset : 1; /** the following members are invalid after changing UUID on open */ BOOL setImageId : 1; BOOL setParentId : 1; const Guid imageId; const Guid parentId; BOOL hostDrive : 1; typedef std::map PropertyMap; PropertyMap properties; bool implicit : 1; uint32_t numCreateDiffTasks; Utf8Str vdError; /*< Error remembered by the VD error callback. */ Progress *vdProgress; /*< Progress for the VD progress callback. */ VDINTERFACE vdIfError; VDINTERFACEERROR vdIfCallsError; VDINTERFACE vdIfProgress; VDINTERFACEPROGRESS vdIfCallsProgress; VDINTERFACE vdIfConfig; VDINTERFACECONFIG vdIfCallsConfig; VDINTERFACE vdIfTcpNet; VDINTERFACETCPNET vdIfCallsTcpNet; PVDINTERFACE vdDiskIfaces; }; //////////////////////////////////////////////////////////////////////////////// // // Globals // //////////////////////////////////////////////////////////////////////////////// /** * Asynchronous task thread parameter bucket. * * Note that instances of this class must be created using new() because the * task thread function will delete them when the task is complete! * * @note The constructor of this class adds a caller on the managed Medium * object which is automatically released upon destruction. */ struct Medium::Task : public com::SupportErrorInfoBase { enum Operation { CreateBase, CreateDiff, Merge, Clone, Delete, Reset, Compact }; Medium *that; VirtualBoxBaseProto::AutoCaller autoCaller; ComObjPtr progress; Operation operation; /** Where to save the result when executed using #runNow(). */ HRESULT rc; Task(Medium *aThat, Progress *aProgress, Operation aOperation) : that(aThat), autoCaller(aThat) , progress(aProgress) , operation(aOperation) , rc(S_OK) {} ~Task(); void setData(Medium *aTarget) { d.target = aTarget; HRESULT rc = d.target->addCaller(); AssertComRC(rc); } void setData(Medium *aTarget, Medium *aParent) { d.target = aTarget; HRESULT rc = d.target->addCaller(); AssertComRC(rc); d.parentDisk = aParent; if (aParent) { rc = d.parentDisk->addCaller(); AssertComRC(rc); } } void setData(MergeChain *aChain) { AssertReturnVoid(aChain != NULL); d.chain.reset(aChain); } void setData(ImageChain *aSrcChain, ImageChain *aParentChain) { AssertReturnVoid(aSrcChain != NULL); AssertReturnVoid(aParentChain != NULL); d.source.reset(aSrcChain); d.parent.reset(aParentChain); } void setData(ImageChain *aImgChain) { AssertReturnVoid(aImgChain != NULL); d.images.reset(aImgChain); } HRESULT startThread(); HRESULT runNow(); struct Data { Data() : size(0) {} /* CreateBase */ uint64_t size; /* CreateBase, CreateDiff, Clone */ MediumVariant_T variant; /* CreateDiff, Clone */ ComObjPtr target; /* Clone */ /** Media to open, in {parent,child} order */ std::auto_ptr source; /** Media which are parent of target, in {parent,child} order */ std::auto_ptr parent; /** The to-be parent medium object */ ComObjPtr parentDisk; /* Merge */ /** Media to merge, in {parent,child} order */ std::auto_ptr chain; /* Compact */ /** Media to open, in {parent,child} order */ std::auto_ptr images; } d; protected: // SupportErrorInfoBase interface const GUID &mainInterfaceID() const { return COM_IIDOF(IMedium); } const char *componentName() const { return Medium::ComponentName(); } }; Medium::Task::~Task() { /* remove callers added by setData() */ if (!d.target.isNull()) d.target->releaseCaller(); } /** * Starts a new thread driven by the Medium::taskThread() function and passes * this Task instance as an argument. * * Note that if this method returns success, this Task object becomes an ownee * of the started thread and will be automatically deleted when the thread * terminates. * * @note When the task is executed by this method, IProgress::notifyComplete() * is automatically called for the progress object associated with this * task when the task is finished to signal the operation completion for * other threads asynchronously waiting for it. */ HRESULT Medium::Task::startThread() { int vrc = RTThreadCreate(NULL, Medium::taskThread, this, 0, RTTHREADTYPE_MAIN_HEAVY_WORKER, 0, "Medium::Task"); ComAssertMsgRCRet(vrc, ("Could not create Medium::Task thread (%Rrc)\n", vrc), E_FAIL); return S_OK; } /** * Runs Medium::taskThread() by passing it this Task instance as an argument * on the current thread instead of creating a new one. * * This call implies that it is made on another temporary thread created for * some asynchronous task. Avoid calling it from a normal thread since the task * operatinos are potentially lengthy and will block the calling thread in this * case. * * Note that this Task object will be deleted by taskThread() when this method * returns! * * @note When the task is executed by this method, IProgress::notifyComplete() * is not called for the progress object associated with this task when * the task is finished. Instead, the result of the operation is returned * by this method directly and it's the caller's responsibility to * complete the progress object in this case. */ HRESULT Medium::Task::runNow() { Medium::taskThread(NIL_RTTHREAD, this); return rc; } //////////////////////////////////////////////////////////////////////////////// // // Merge chain class // //////////////////////////////////////////////////////////////////////////////// /** * Helper class for merge operations. * * @note It is assumed that when modifying methods of this class are called, * Medium::treeLock() is held in read mode. */ class Medium::MergeChain : public Medium::List, public com::SupportErrorInfoBase { public: MergeChain(bool aForward, bool aIgnoreAttachments) : mForward(aForward) , mIgnoreAttachments(aIgnoreAttachments) {} ~MergeChain() { for (iterator it = mChildren.begin(); it != mChildren.end(); ++ it) { HRESULT rc = (*it)->UnlockWrite(NULL); AssertComRC(rc); (*it)->releaseCaller(); } for (iterator it = begin(); it != end(); ++ it) { AutoWriteLock alock(*it); Assert((*it)->m->state == MediumState_LockedWrite || (*it)->m->state == MediumState_Deleting); if ((*it)->m->state == MediumState_LockedWrite) (*it)->UnlockWrite(NULL); else (*it)->m->state = MediumState_Created; (*it)->releaseCaller(); } if (!mParent.isNull()) mParent->releaseCaller(); } HRESULT addSource(Medium *aMedium) { HRESULT rc = aMedium->addCaller(); CheckComRCReturnRC(rc); AutoWriteLock alock(aMedium); if (mForward) { rc = checkChildrenAndAttachmentsAndImmutable(aMedium); if (FAILED(rc)) { aMedium->releaseCaller(); return rc; } } /* We have to fetch the state with the COM method, cause it's possible that the medium isn't fully initialized yet. See HRESULT Medium::protectedInit(VirtualBox *aVirtualBox, const settings::Key &aImageNode) for an explanation why. */ MediumState_T m; rc = aMedium->COMGETTER(State)(&m); CheckComRCReturnRC(rc); /* go to Deleting */ switch (m) { case MediumState_Created: aMedium->m->state = MediumState_Deleting; break; default: aMedium->releaseCaller(); return aMedium->setStateError(); } push_front(aMedium); if (mForward) { /* we will need parent to reparent target */ if (!aMedium->mParent.isNull()) { rc = aMedium->mParent->addCaller(); CheckComRCReturnRC(rc); mParent = aMedium->mParent; } } else { /* we will need to reparent children */ for (List::const_iterator it = aMedium->children().begin(); it != aMedium->children().end(); ++ it) { rc = (*it)->addCaller(); CheckComRCReturnRC(rc); rc = (*it)->LockWrite(NULL); if (FAILED(rc)) { (*it)->releaseCaller(); return rc; } mChildren.push_back(*it); } } return S_OK; } HRESULT addTarget(Medium *aMedium) { HRESULT rc = aMedium->addCaller(); CheckComRCReturnRC(rc); AutoWriteLock alock(aMedium); if (!mForward) { rc = checkChildrenAndImmutable(aMedium); if (FAILED(rc)) { aMedium->releaseCaller(); return rc; } } /* go to LockedWrite */ rc = aMedium->LockWrite(NULL); if (FAILED(rc)) { aMedium->releaseCaller(); return rc; } push_front(aMedium); return S_OK; } HRESULT addIntermediate(Medium *aMedium) { HRESULT rc = aMedium->addCaller(); CheckComRCReturnRC(rc); AutoWriteLock alock(aMedium); rc = checkChildrenAndAttachments(aMedium); if (FAILED(rc)) { aMedium->releaseCaller(); return rc; } /* go to Deleting */ switch (aMedium->m->state) { case MediumState_Created: aMedium->m->state = MediumState_Deleting; break; default: aMedium->releaseCaller(); return aMedium->setStateError(); } push_front(aMedium); return S_OK; } bool isForward() const { return mForward; } Medium *parent() const { return mParent; } const List &children() const { return mChildren; } Medium *source() const { AssertReturn(size() > 0, NULL); return mForward ? front() : back(); } Medium *target() const { AssertReturn(size() > 0, NULL); return mForward ? back() : front(); } protected: // SupportErrorInfoBase interface const GUID &mainInterfaceID() const { return COM_IIDOF(IMedium); } const char *componentName() const { return Medium::ComponentName(); } private: HRESULT check(Medium *aMedium, bool aChildren, bool aAttachments, bool aImmutable) { if (aChildren) { /* not going to multi-merge as it's too expensive */ if (aMedium->children().size() > 1) { return setError(E_FAIL, tr("Medium '%ls' involved in the merge operation has more than one child medium (%d)"), aMedium->m->locationFull.raw(), aMedium->children().size()); } } if (aAttachments && !mIgnoreAttachments) { if (aMedium->m->backRefs.size() != 0) return setError(E_FAIL, tr("Medium '%ls' is attached to %d virtual machines"), aMedium->m->locationFull.raw(), aMedium->m->backRefs.size()); } if (aImmutable) { if (aMedium->m->type == MediumType_Immutable) return setError(E_FAIL, tr("Medium '%ls' is immutable"), aMedium->m->locationFull.raw()); } return S_OK; } HRESULT checkChildren(Medium *aMedium) { return check(aMedium, true, false, false); } HRESULT checkChildrenAndImmutable(Medium *aMedium) { return check(aMedium, true, false, true); } HRESULT checkChildrenAndAttachments(Medium *aMedium) { return check(aMedium, true, true, false); } HRESULT checkChildrenAndAttachmentsAndImmutable(Medium *aMedium) { return check(aMedium, true, true, true); } /** true if forward merge, false if backward */ bool mForward : 1; /** true to not perform attachment checks */ bool mIgnoreAttachments : 1; /** Parent of the source when forward merge (if any) */ ComObjPtr mParent; /** Children of the source when backward merge (if any) */ List mChildren; }; //////////////////////////////////////////////////////////////////////////////// // // ImageChain class // //////////////////////////////////////////////////////////////////////////////// /** * Helper class for image operations involving the entire parent chain. * * @note It is assumed that when modifying methods of this class are called, * Medium::treeLock() is held in read mode. */ class Medium::ImageChain : public Medium::List, public com::SupportErrorInfoBase { public: ImageChain() {} ~ImageChain() { /* empty? */ if (begin() != end()) { List::const_iterator last = end(); last--; for (List::const_iterator it = begin(); it != end(); ++ it) { AutoWriteLock alock(*it); if (it == last) { Assert( (*it)->m->state == MediumState_LockedRead || (*it)->m->state == MediumState_LockedWrite); if ((*it)->m->state == MediumState_LockedRead) (*it)->UnlockRead(NULL); else if ((*it)->m->state == MediumState_LockedWrite) (*it)->UnlockWrite(NULL); } else { Assert((*it)->m->state == MediumState_LockedRead); if ((*it)->m->state == MediumState_LockedRead) (*it)->UnlockRead(NULL); } (*it)->releaseCaller(); } } } HRESULT addImage(Medium *aMedium) { HRESULT rc = aMedium->addCaller(); CheckComRCReturnRC(rc); push_front(aMedium); return S_OK; } HRESULT lockImagesRead() { /* Lock all disks in the chain in {parent, child} order, * and make sure they are accessible. */ /// @todo code duplication with SessionMachine::lockMedia, see below ErrorInfoKeeper eik(true /* aIsNull */); MultiResult mrc(S_OK); for (List::const_iterator it = begin(); it != end(); ++ it) { HRESULT rc = S_OK; MediumState_T mediaState; rc = (*it)->LockRead(&mediaState); CheckComRCReturnRC(rc); if (mediaState == MediumState_Inaccessible) { rc = (*it)->COMGETTER(State)(&mediaState); CheckComRCReturnRC(rc); Assert(mediaState == MediumState_LockedRead); /* Note that we locked the medium already, so use the error * value to see if there was an accessibility failure */ Bstr error; rc = (*it)->COMGETTER(LastAccessError)(error.asOutParam()); CheckComRCReturnRC(rc); if (!error.isEmpty()) { Bstr loc; rc = (*it)->COMGETTER(Location)(loc.asOutParam()); CheckComRCThrowRC(rc); /* collect multiple errors */ eik.restore(); /* be in sync with Medium::setStateError() */ Assert(!error.isEmpty()); mrc = setError(E_FAIL, tr("Medium '%ls' is not accessible. %ls"), loc.raw(), error.raw()); eik.fetch(); } } } eik.restore(); CheckComRCReturnRC((HRESULT)mrc); return S_OK; } HRESULT lockImagesReadAndLastWrite() { /* Lock all disks in the chain in {parent, child} order, * and make sure they are accessible. */ /// @todo code duplication with SessionMachine::lockMedia, see below ErrorInfoKeeper eik(true /* aIsNull */); MultiResult mrc(S_OK); List::const_iterator last = end(); last--; for (List::const_iterator it = begin(); it != end(); ++ it) { HRESULT rc = S_OK; MediumState_T mediaState; if (it == last) rc = (*it)->LockWrite(&mediaState); else rc = (*it)->LockRead(&mediaState); CheckComRCReturnRC(rc); if (mediaState == MediumState_Inaccessible) { rc = (*it)->COMGETTER(State)(&mediaState); CheckComRCReturnRC(rc); if (it == last) Assert(mediaState == MediumState_LockedWrite); else Assert(mediaState == MediumState_LockedRead); /* Note that we locked the medium already, so use the error * value to see if there was an accessibility failure */ Bstr error; rc = (*it)->COMGETTER(LastAccessError)(error.asOutParam()); CheckComRCReturnRC(rc); if (!error.isEmpty()) { Bstr loc; rc = (*it)->COMGETTER(Location)(loc.asOutParam()); CheckComRCThrowRC(rc); /* collect multiple errors */ eik.restore(); /* be in sync with Medium::setStateError() */ Assert(!error.isEmpty()); mrc = setError(E_FAIL, tr("Medium '%ls' is not accessible. %ls"), loc.raw(), error.raw()); eik.fetch(); } } } eik.restore(); CheckComRCReturnRC((HRESULT) mrc); return S_OK; } protected: // SupportErrorInfoBase interface const GUID &mainInterfaceID() const { return COM_IIDOF(IMedium); } const char *componentName() const { return Medium::ComponentName(); } private: }; //////////////////////////////////////////////////////////////////////////////// // // Medium constructor / destructor // //////////////////////////////////////////////////////////////////////////////// DEFINE_EMPTY_CTOR_DTOR(Medium) HRESULT Medium::FinalConstruct() { m = new Data; /* Initialize the callbacks of the VD error interface */ m->vdIfCallsError.cbSize = sizeof(VDINTERFACEERROR); m->vdIfCallsError.enmInterface = VDINTERFACETYPE_ERROR; m->vdIfCallsError.pfnError = vdErrorCall; m->vdIfCallsError.pfnMessage = NULL; /* Initialize the callbacks of the VD progress interface */ m->vdIfCallsProgress.cbSize = sizeof(VDINTERFACEPROGRESS); m->vdIfCallsProgress.enmInterface = VDINTERFACETYPE_PROGRESS; m->vdIfCallsProgress.pfnProgress = vdProgressCall; /* Initialize the callbacks of the VD config interface */ m->vdIfCallsConfig.cbSize = sizeof(VDINTERFACECONFIG); m->vdIfCallsConfig.enmInterface = VDINTERFACETYPE_CONFIG; m->vdIfCallsConfig.pfnAreKeysValid = vdConfigAreKeysValid; m->vdIfCallsConfig.pfnQuerySize = vdConfigQuerySize; m->vdIfCallsConfig.pfnQuery = vdConfigQuery; /* Initialize the callbacks of the VD TCP interface (we always use the host * * IP stack for now) */ m->vdIfCallsTcpNet.cbSize = sizeof(VDINTERFACETCPNET); m->vdIfCallsTcpNet.enmInterface = VDINTERFACETYPE_TCPNET; m->vdIfCallsTcpNet.pfnClientConnect = RTTcpClientConnect; m->vdIfCallsTcpNet.pfnClientClose = RTTcpClientClose; m->vdIfCallsTcpNet.pfnSelectOne = RTTcpSelectOne; m->vdIfCallsTcpNet.pfnRead = RTTcpRead; m->vdIfCallsTcpNet.pfnWrite = RTTcpWrite; m->vdIfCallsTcpNet.pfnFlush = RTTcpFlush; /* Initialize the per-disk interface chain */ int vrc; vrc = VDInterfaceAdd(&m->vdIfError, "Medium::vdInterfaceError", VDINTERFACETYPE_ERROR, &m->vdIfCallsError, this, &m->vdDiskIfaces); AssertRCReturn(vrc, E_FAIL); vrc = VDInterfaceAdd(&m->vdIfProgress, "Medium::vdInterfaceProgress", VDINTERFACETYPE_PROGRESS, &m->vdIfCallsProgress, this, &m->vdDiskIfaces); AssertRCReturn(vrc, E_FAIL); vrc = VDInterfaceAdd(&m->vdIfConfig, "Medium::vdInterfaceConfig", VDINTERFACETYPE_CONFIG, &m->vdIfCallsConfig, this, &m->vdDiskIfaces); AssertRCReturn(vrc, E_FAIL); vrc = VDInterfaceAdd(&m->vdIfTcpNet, "Medium::vdInterfaceTcpNet", VDINTERFACETYPE_TCPNET, &m->vdIfCallsTcpNet, this, &m->vdDiskIfaces); AssertRCReturn(vrc, E_FAIL); return S_OK; } void Medium::FinalRelease() { uninit(); delete m; } /** * Initializes the hard disk object without creating or opening an associated * storage unit. * * For hard disks that don't have the VD_CAP_CREATE_FIXED or * VD_CAP_CREATE_DYNAMIC capability (and therefore cannot be created or deleted * with the means of VirtualBox) the associated storage unit is assumed to be * ready for use so the state of the hard disk object will be set to Created. * * @param aVirtualBox VirtualBox object. * @param aLocation Storage unit location. */ HRESULT Medium::init(VirtualBox *aVirtualBox, CBSTR aFormat, CBSTR aLocation) { AssertReturn(aVirtualBox != NULL, E_FAIL); AssertReturn(aFormat != NULL && *aFormat != '\0', E_FAIL); /* Enclose the state transition NotReady->InInit->Ready */ AutoInitSpan autoInitSpan(this); AssertReturn(autoInitSpan.isOk(), E_FAIL); HRESULT rc = S_OK; /* share VirtualBox weakly (parent remains NULL so far) */ unconst(mVirtualBox) = aVirtualBox; /* register with VirtualBox early, since uninit() will * unconditionally unregister on failure */ aVirtualBox->addDependentChild(this); /* no storage yet */ m->state = MediumState_NotCreated; /* cannot be a host drive */ m->hostDrive = false; /* No storage unit is created yet, no need to queryInfo() */ rc = setFormat(aFormat); CheckComRCReturnRC(rc); if (m->formatObj->capabilities() & MediumFormatCapabilities_File) { rc = setLocation(aLocation); CheckComRCReturnRC(rc); } else { rc = setLocation(aLocation); CheckComRCReturnRC(rc); /// @todo later we may want to use a pfnComposeLocation backend info /// callback to generate a well-formed location value (based on the hard /// disk properties we have) rather than allowing each caller to invent /// its own (pseudo-)location. } if (!(m->formatObj->capabilities() & (MediumFormatCapabilities_CreateFixed | MediumFormatCapabilities_CreateDynamic))) { /* storage for hard disks of this format can neither be explicitly * created by VirtualBox nor deleted, so we place the hard disk to * Created state here and also add it to the registry */ m->state = MediumState_Created; unconst(m->id).create(); rc = mVirtualBox->registerHardDisk(this); /// @todo later we may want to use a pfnIsConfigSufficient backend info /// callback that would tell us when we have enough properties to work /// with the hard disk and this information could be used to actually /// move such hard disks from NotCreated to Created state. Instead of /// pfnIsConfigSufficient we can use MediumFormat property /// descriptions to see which properties are mandatory } /* Confirm a successful initialization when it's the case */ if (SUCCEEDED(rc)) autoInitSpan.setSucceeded(); return rc; } /** * Initializes the hard disk object by opening the storage unit at the specified * location. The enOpenMode parameter defines whether the image will be opened * read/write or read-only. * * Note that the UUID, format and the parent of this hard disk will be * determined when reading the hard disk storage unit, unless new values are * specified by the parameters. If the detected or set parent is * not known to VirtualBox, then this method will fail. * * @param aVirtualBox VirtualBox object. * @param aLocation Storage unit location. * @param enOpenMode Whether to open the image read/write or read-only. * @param aSetImageId Whether to set the image UUID or not. * @param aImageId New image UUID if @aSetId is true. Empty string means * create a new UUID, and a zero UUID is invalid. * @param aSetParentId Whether to set the parent UUID or not. * @param aParentId New parent UUID if @aSetParentId is true. Empty string * means create a new UUID, and a zero UUID is valid. */ HRESULT Medium::init(VirtualBox *aVirtualBox, CBSTR aLocation, HDDOpenMode enOpenMode, DeviceType_T aDeviceType, BOOL aSetImageId, const Guid &aImageId, BOOL aSetParentId, const Guid &aParentId) { AssertReturn(aVirtualBox, E_INVALIDARG); AssertReturn(aLocation, E_INVALIDARG); /* Enclose the state transition NotReady->InInit->Ready */ AutoInitSpan autoInitSpan(this); AssertReturn(autoInitSpan.isOk(), E_FAIL); HRESULT rc = S_OK; /* share VirtualBox weakly (parent remains NULL so far) */ unconst(mVirtualBox) = aVirtualBox; /* register with VirtualBox early, since uninit() will * unconditionally unregister on failure */ aVirtualBox->addDependentChild(this); /* there must be a storage unit */ m->state = MediumState_Created; /* cannot be a host drive */ m->hostDrive = false; /* remember the open mode (defaults to ReadWrite) */ m->hddOpenMode = enOpenMode; if (aDeviceType == DeviceType_HardDisk) rc = setLocation(aLocation); else rc = setLocation(aLocation, "RAW"); CheckComRCReturnRC(rc); /* save the new uuid values, will be used by queryInfo() */ m->setImageId = aSetImageId; unconst(m->imageId) = aImageId; m->setParentId = aSetParentId; unconst(m->parentId) = aParentId; /* get all the information about the medium from the storage unit */ rc = queryInfo(); if (SUCCEEDED(rc)) { /* if the storage unit is not accessible, it's not acceptable for the * newly opened media so convert this into an error */ if (m->state == MediumState_Inaccessible) { Assert(!m->lastAccessError.isEmpty()); rc = setError(E_FAIL, Utf8Str(m->lastAccessError)); } else { AssertReturn(!m->id.isEmpty(), E_FAIL); /* storage format must be detected by queryInfo() if the medium is accessible */ AssertReturn(!m->format.isNull(), E_FAIL); } } /* Confirm a successful initialization when it's the case */ if (SUCCEEDED(rc)) autoInitSpan.setSucceeded(); return rc; } /** * Initializes the medium object by loading its data from the given settings * node. In this mode, the image will always be opened read/write. * * @param aVirtualBox VirtualBox object. * @param aParent Parent medium disk or NULL for a root (base) medium. * @param aType Device type of the medium. * @param aNode Configuration settings. * * @note Locks VirtualBox lock for writing, treeLock() for writing. */ HRESULT Medium::init(VirtualBox *aVirtualBox, Medium *aParent, DeviceType_T aType, const settings::Medium &data) { using namespace settings; AssertReturn(aVirtualBox, E_INVALIDARG); /* Enclose the state transition NotReady->InInit->Ready */ AutoInitSpan autoInitSpan(this); AssertReturn(autoInitSpan.isOk(), E_FAIL); HRESULT rc = S_OK; /* share VirtualBox and parent weakly */ unconst(mVirtualBox) = aVirtualBox; /* register with VirtualBox/parent early, since uninit() will * unconditionally unregister on failure */ if (aParent == NULL) aVirtualBox->addDependentChild(this); else { /* we set mParent */ AutoWriteLock treeLock(this->treeLock()); mParent = aParent; aParent->addDependentChild(this); } /* see below why we don't call queryInfo() (and therefore treat the medium * as inaccessible for now */ m->state = MediumState_Inaccessible; m->lastAccessError = tr("Accessibility check was not yet performed"); /* required */ unconst(m->id) = data.uuid; /* assume not a host drive */ m->hostDrive = false; /* optional */ m->description = data.strDescription; /* required */ if (aType == DeviceType_HardDisk) { AssertReturn(!data.strFormat.isEmpty(), E_FAIL); rc = setFormat(Bstr(data.strFormat)); CheckComRCReturnRC(rc); } else { /// @todo handle host drive settings here as well? if (!data.strFormat.isEmpty()) rc = setFormat(Bstr(data.strFormat)); else rc = setFormat(Bstr("RAW")); CheckComRCReturnRC(rc); } /* optional, only for diffs, default is false */ if (aParent != NULL) m->autoReset = data.fAutoReset; else m->autoReset = false; /* properties (after setting the format as it populates the map). Note that * if some properties are not supported but preseint in the settings file, * they will still be read and accessible (for possible backward * compatibility; we can also clean them up from the XML upon next * XML format version change if we wish) */ for (settings::PropertiesMap::const_iterator it = data.properties.begin(); it != data.properties.end(); ++ it) { const Utf8Str &name = it->first; const Utf8Str &value = it->second; m->properties[Bstr(name)] = Bstr(value); } /* required */ rc = setLocation(data.strLocation); CheckComRCReturnRC(rc); if (aType == DeviceType_HardDisk) { /* type is only for base hard disks */ if (mParent.isNull()) m->type = data.hdType; } else m->type = MediumType_Writethrough; LogFlowThisFunc(("m->locationFull='%ls', m->format=%ls, m->id={%RTuuid}\n", m->locationFull.raw(), m->format.raw(), m->id.raw())); /* Don't call queryInfo() for registered media to prevent the calling * thread (i.e. the VirtualBox server startup thread) from an unexpected * freeze but mark it as initially inaccessible instead. The vital UUID, * location and format properties are read from the registry file above; to * get the actual state and the rest of the data, the user will have to call * COMGETTER(State). */ /* load all children */ for (settings::MediaList::const_iterator it = data.llChildren.begin(); it != data.llChildren.end(); ++ it) { const settings::Medium &m = *it; ComObjPtr pHD; pHD.createObject(); rc = pHD->init(aVirtualBox, this, // parent aType, m); // child data CheckComRCBreakRC(rc); rc = mVirtualBox->registerHardDisk(pHD, false /* aSaveRegistry */); CheckComRCBreakRC(rc); } /* Confirm a successful initialization when it's the case */ if (SUCCEEDED(rc)) autoInitSpan.setSucceeded(); return rc; } /** * Initializes the medium object by providing the host drive information. * Not used for anything but the host floppy/host DVD case. * * @todo optimize all callers to avoid reconstructing objects with the same * information over and over again - in the typical case each VM referring to * a particular host drive has its own instance. * * @param aVirtualBox VirtualBox object. * @param aType Device type of the medium. * @param aLocation Location of the host drive. * @param aDescription Comment for this host drive. * * @note Locks VirtualBox lock for writing, treeLock() for writing. */ HRESULT Medium::init(VirtualBox *aVirtualBox, DeviceType_T aType, CBSTR aLocation, CBSTR aDescription) { ComAssertRet(aType == DeviceType_DVD || aType == DeviceType_Floppy, E_INVALIDARG); ComAssertRet(aLocation, E_INVALIDARG); /* Enclose the state transition NotReady->InInit->Ready */ AutoInitSpan autoInitSpan(this); AssertReturn(autoInitSpan.isOk(), E_FAIL); /* share VirtualBox weakly (parent remains NULL so far) */ unconst(mVirtualBox) = aVirtualBox; aVirtualBox->addDependentChild(this); /* fake up a UUID which is unique, but also reproducible */ RTUUID uuid; RTUuidClear(&uuid); if (aType == DeviceType_DVD) memcpy(&uuid.au8[0], "DVD", 3); else memcpy(&uuid.au8[0], "FD", 2); /* use device name, adjusted to the end of uuid, shortened if necessary */ Utf8Str loc(aLocation); size_t cbLocation = strlen(loc.raw()); if (cbLocation > 12) memcpy(&uuid.au8[4], loc.raw() + (cbLocation - 12), 12); else memcpy(&uuid.au8[4 + 12 - cbLocation], loc.raw(), cbLocation); unconst(m->id) = uuid; m->type = MediumType_Writethrough; m->state = MediumState_Created; m->hostDrive = true; HRESULT rc = setFormat(Bstr("RAW")); CheckComRCReturnRC(rc); rc = setLocation(aLocation); CheckComRCReturnRC(rc); m->description = aDescription; /// @todo generate uuid (similarly to host network interface uuid) from location and device type autoInitSpan.setSucceeded(); return S_OK; } /** * Uninitializes the instance. * * Called either from FinalRelease() or by the parent when it gets destroyed. * * @note All children of this hard disk get uninitialized by calling their * uninit() methods. * * @note Locks treeLock() for writing, VirtualBox for writing. */ void Medium::uninit() { /* Enclose the state transition Ready->InUninit->NotReady */ AutoUninitSpan autoUninitSpan(this); if (autoUninitSpan.uninitDone()) return; if (!m->formatObj.isNull()) { /* remove the caller reference we added in setFormat() */ m->formatObj->releaseCaller(); m->formatObj.setNull(); } if (m->state == MediumState_Deleting) { /* we are being uninitialized after've been deleted by merge. * Reparenting has already been done so don't touch it here (we are * now orphans and remoeDependentChild() will assert) */ Assert(mParent.isNull()); } else { /* we uninit children and reset mParent * and VirtualBox::removeDependentChild() needs a write lock */ AutoMultiWriteLock2 alock(mVirtualBox->lockHandle(), this->treeLock()); uninitDependentChildren(); if (!mParent.isNull()) { mParent->removeDependentChild(this); mParent.setNull(); } else mVirtualBox->removeDependentChild(this); } unconst(mVirtualBox).setNull(); } //////////////////////////////////////////////////////////////////////////////// // // IMedium public methods // //////////////////////////////////////////////////////////////////////////////// STDMETHODIMP Medium::COMGETTER(Id)(BSTR *aId) { CheckComArgOutPointerValid(aId); AutoCaller autoCaller(this); CheckComRCReturnRC(autoCaller.rc()); AutoReadLock alock(this); m->id.toUtf16().cloneTo(aId); return S_OK; } STDMETHODIMP Medium::COMGETTER(Description)(BSTR *aDescription) { CheckComArgOutPointerValid(aDescription); AutoCaller autoCaller(this); CheckComRCReturnRC(autoCaller.rc()); AutoReadLock alock(this); if (m->description.isEmpty()) Bstr("").cloneTo(aDescription); else m->description.cloneTo(aDescription); return S_OK; } STDMETHODIMP Medium::COMSETTER(Description)(IN_BSTR aDescription) { CheckComArgNotNull(aDescription); AutoCaller autoCaller(this); CheckComRCReturnRC(autoCaller.rc()); AutoWriteLock alock(this); /// @todo update m->description and save the global registry (and local /// registries of portable VMs referring to this medium), this will also /// require to add the mRegistered flag to data ReturnComNotImplemented(); } STDMETHODIMP Medium::COMGETTER(State)(MediumState_T *aState) { CheckComArgOutPointerValid(aState); AutoCaller autoCaller(this); CheckComRCReturnRC(autoCaller.rc()); /* queryInfo() locks this for writing. */ AutoWriteLock alock(this); HRESULT rc = S_OK; switch (m->state) { case MediumState_Created: case MediumState_Inaccessible: case MediumState_LockedRead: case MediumState_LockedWrite: { rc = queryInfo(); break; } default: break; } *aState = m->state; return rc; } STDMETHODIMP Medium::COMGETTER(Location)(BSTR *aLocation) { CheckComArgOutPointerValid(aLocation); AutoCaller autoCaller(this); CheckComRCReturnRC(autoCaller.rc()); AutoReadLock alock(this); m->locationFull.cloneTo(aLocation); return S_OK; } STDMETHODIMP Medium::COMSETTER(Location)(IN_BSTR aLocation) { CheckComArgNotNull(aLocation); AutoCaller autoCaller(this); CheckComRCReturnRC(autoCaller.rc()); AutoWriteLock alock(this); /// @todo NEWMEDIA for file names, add the default extension if no extension /// is present (using the information from the VD backend which also implies /// that one more parameter should be passed to setLocation() requesting /// that functionality since it is only allwed when called from this method /// @todo NEWMEDIA rename the file and set m->location on success, then save /// the global registry (and local registries of portable VMs referring to /// this medium), this will also require to add the mRegistered flag to data ReturnComNotImplemented(); } STDMETHODIMP Medium::COMGETTER(Name)(BSTR *aName) { CheckComArgOutPointerValid(aName); AutoCaller autoCaller(this); CheckComRCReturnRC(autoCaller.rc()); AutoReadLock alock(this); name().cloneTo(aName); return S_OK; } STDMETHODIMP Medium::COMGETTER(HostDrive)(BOOL *aHostDrive) { CheckComArgOutPointerValid(aHostDrive); AutoCaller autoCaller(this); CheckComRCReturnRC(autoCaller.rc()); AutoReadLock alock(this); *aHostDrive = m->hostDrive; return S_OK; } STDMETHODIMP Medium::COMGETTER(Size)(ULONG64 *aSize) { CheckComArgOutPointerValid(aSize); AutoCaller autoCaller(this); CheckComRCReturnRC(autoCaller.rc()); AutoReadLock alock(this); *aSize = m->size; return S_OK; } STDMETHODIMP Medium::COMGETTER(Format)(BSTR *aFormat) { if (aFormat == NULL) return E_POINTER; AutoCaller autoCaller(this); CheckComRCReturnRC(autoCaller.rc()); /* no need to lock, m->format is const */ m->format.cloneTo(aFormat); return S_OK; } STDMETHODIMP Medium::COMGETTER(Type)(MediumType_T *aType) { if (aType == NULL) return E_POINTER; AutoCaller autoCaller(this); CheckComRCReturnRC(autoCaller.rc()); AutoReadLock alock(this); *aType = m->type; return S_OK; } STDMETHODIMP Medium::COMSETTER(Type)(MediumType_T aType) { AutoCaller autoCaller(this); CheckComRCReturnRC(autoCaller.rc()); /* VirtualBox::saveSettings() needs a write lock */ AutoMultiWriteLock2 alock(mVirtualBox, this); switch (m->state) { case MediumState_Created: case MediumState_Inaccessible: break; default: return setStateError(); } if (m->type == aType) { /* Nothing to do */ return S_OK; } /* we access mParent & children() */ AutoReadLock treeLock(this->treeLock()); /* cannot change the type of a differencing hard disk */ if (!mParent.isNull()) return setError(E_FAIL, tr("Hard disk '%ls' is a differencing hard disk"), m->locationFull.raw()); /* cannot change the type of a hard disk being in use */ if (m->backRefs.size() != 0) return setError(E_FAIL, tr("Hard disk '%ls' is attached to %d virtual machines"), m->locationFull.raw(), m->backRefs.size()); switch (aType) { case MediumType_Normal: case MediumType_Immutable: { /* normal can be easily converted to imutable and vice versa even * if they have children as long as they are not attached to any * machine themselves */ break; } case MediumType_Writethrough: { /* cannot change to writethrough if there are children */ if (children().size() != 0) return setError(E_FAIL, tr("Hard disk '%ls' has %d child hard disks"), children().size()); break; } default: AssertFailedReturn(E_FAIL); } m->type = aType; HRESULT rc = mVirtualBox->saveSettings(); return rc; } STDMETHODIMP Medium::COMGETTER(Parent)(IMedium **aParent) { if (aParent == NULL) return E_POINTER; AutoCaller autoCaller(this); CheckComRCReturnRC(autoCaller.rc()); /* we access mParent */ AutoReadLock treeLock(this->treeLock()); mParent.queryInterfaceTo(aParent); return S_OK; } STDMETHODIMP Medium::COMGETTER(Children)(ComSafeArrayOut(IMedium *, aChildren)) { if (ComSafeArrayOutIsNull(aChildren)) return E_POINTER; AutoCaller autoCaller(this); CheckComRCReturnRC(autoCaller.rc()); /* we access children */ AutoReadLock treeLock(this->treeLock()); SafeIfaceArray children(this->children()); children.detachTo(ComSafeArrayOutArg(aChildren)); return S_OK; } STDMETHODIMP Medium::COMGETTER(Base)(IMedium **aBase) { if (aBase == NULL) return E_POINTER; /* base() will do callers/locking */ base().queryInterfaceTo(aBase); return S_OK; } STDMETHODIMP Medium::COMGETTER(ReadOnly)(BOOL *aReadOnly) { if (aReadOnly == NULL) return E_POINTER; AutoCaller autoCaller(this); CheckComRCReturnRC(autoCaller.rc()); /* isRadOnly() will do locking */ *aReadOnly = isReadOnly(); return S_OK; } STDMETHODIMP Medium::COMGETTER(LogicalSize)(ULONG64 *aLogicalSize) { CheckComArgOutPointerValid(aLogicalSize); { AutoCaller autoCaller(this); CheckComRCReturnRC(autoCaller.rc()); AutoReadLock alock(this); /* we access mParent */ AutoReadLock treeLock(this->treeLock()); if (mParent.isNull()) { *aLogicalSize = m->logicalSize; return S_OK; } } /* We assume that some backend may decide to return a meaningless value in * response to VDGetSize() for differencing hard disks and therefore * always ask the base hard disk ourselves. */ /* base() will do callers/locking */ return base()->COMGETTER(LogicalSize)(aLogicalSize); } STDMETHODIMP Medium::COMGETTER(AutoReset)(BOOL *aAutoReset) { CheckComArgOutPointerValid(aAutoReset); AutoCaller autoCaller(this); CheckComRCReturnRC(autoCaller.rc()); AutoReadLock alock(this); if (mParent.isNull()) *aAutoReset = FALSE; *aAutoReset = m->autoReset; return S_OK; } STDMETHODIMP Medium::COMSETTER(AutoReset)(BOOL aAutoReset) { AutoCaller autoCaller(this); CheckComRCReturnRC(autoCaller.rc()); /* VirtualBox::saveSettings() needs a write lock */ AutoMultiWriteLock2 alock(mVirtualBox, this); if (mParent.isNull()) return setError(VBOX_E_NOT_SUPPORTED, tr("Hard disk '%ls' is not differencing"), m->locationFull.raw()); if (m->autoReset != aAutoReset) { m->autoReset = aAutoReset; return mVirtualBox->saveSettings(); } return S_OK; } STDMETHODIMP Medium::COMGETTER(LastAccessError)(BSTR *aLastAccessError) { CheckComArgOutPointerValid(aLastAccessError); AutoCaller autoCaller(this); CheckComRCReturnRC(autoCaller.rc()); AutoReadLock alock(this); if (m->lastAccessError.isEmpty()) Bstr("").cloneTo(aLastAccessError); else m->lastAccessError.cloneTo(aLastAccessError); return S_OK; } STDMETHODIMP Medium::COMGETTER(MachineIds)(ComSafeArrayOut(BSTR,aMachineIds)) { if (ComSafeGUIDArrayOutIsNull(aMachineIds)) return E_POINTER; AutoCaller autoCaller(this); CheckComRCReturnRC(autoCaller.rc()); AutoReadLock alock(this); com::SafeArray machineIds; if (m->backRefs.size() != 0) { machineIds.reset(m->backRefs.size()); size_t i = 0; for (BackRefList::const_iterator it = m->backRefs.begin(); it != m->backRefs.end(); ++ it, ++ i) { it->machineId.toUtf16().detachTo(&machineIds [i]); } } machineIds.detachTo(ComSafeArrayOutArg(aMachineIds)); return S_OK; } STDMETHODIMP Medium::GetSnapshotIds(IN_BSTR aMachineId, ComSafeArrayOut(BSTR, aSnapshotIds)) { CheckComArgExpr(aMachineId, Guid(aMachineId).isEmpty() == false); CheckComArgOutSafeArrayPointerValid(aSnapshotIds); AutoCaller autoCaller(this); CheckComRCReturnRC(autoCaller.rc()); AutoReadLock alock(this); com::SafeArray snapshotIds; Guid id(aMachineId); for (BackRefList::const_iterator it = m->backRefs.begin(); it != m->backRefs.end(); ++ it) { if (it->machineId == id) { size_t size = it->snapshotIds.size(); /* if the medium is attached to the machine in the current state, we * return its ID as the first element of the array */ if (it->inCurState) ++ size; if (size > 0) { snapshotIds.reset(size); size_t j = 0; if (it->inCurState) it->machineId.toUtf16().detachTo(&snapshotIds [j ++]); for (BackRef::GuidList::const_iterator jt = it->snapshotIds.begin(); jt != it->snapshotIds.end(); ++ jt, ++ j) { (*jt).toUtf16().detachTo(&snapshotIds [j]); } } break; } } snapshotIds.detachTo(ComSafeArrayOutArg(aSnapshotIds)); return S_OK; } /** * @note @a aState may be NULL if the state value is not needed (only for * in-process calls). */ STDMETHODIMP Medium::LockRead(MediumState_T *aState) { AutoCaller autoCaller(this); CheckComRCReturnRC(autoCaller.rc()); AutoWriteLock alock(this); /* return the current state before */ if (aState) *aState = m->state; HRESULT rc = S_OK; switch (m->state) { case MediumState_Created: case MediumState_Inaccessible: case MediumState_LockedRead: { ++m->readers; ComAssertMsgBreak(m->readers != 0, ("Counter overflow"), rc = E_FAIL); if (m->state == MediumState_Created) m->accessibleInLock = true; else if (m->state == MediumState_Inaccessible) m->accessibleInLock = false; m->state = MediumState_LockedRead; break; } default: { rc = setStateError(); break; } } return rc; } /** * @note @a aState may be NULL if the state value is not needed (only for * in-process calls). */ STDMETHODIMP Medium::UnlockRead(MediumState_T *aState) { AutoCaller autoCaller(this); CheckComRCReturnRC(autoCaller.rc()); AutoWriteLock alock(this); HRESULT rc = S_OK; switch (m->state) { case MediumState_LockedRead: { if (m->queryInfoSem == NIL_RTSEMEVENTMULTI) { Assert(m->readers != 0); --m->readers; /* Reset the state after the last reader */ if (m->readers == 0) { if (m->accessibleInLock) m->state = MediumState_Created; else m->state = MediumState_Inaccessible; } break; } /* otherwise, queryInfo() is in progress; fall through */ } default: { rc = setError(VBOX_E_INVALID_OBJECT_STATE, tr ("Medium '%ls' is not locked for reading"), m->locationFull.raw()); break; } } /* return the current state after */ if (aState) *aState = m->state; return rc; } /** * @note @a aState may be NULL if the state value is not needed (only for * in-process calls). */ STDMETHODIMP Medium::LockWrite(MediumState_T *aState) { AutoCaller autoCaller(this); CheckComRCReturnRC(autoCaller.rc()); AutoWriteLock alock(this); /* return the current state before */ if (aState) *aState = m->state; HRESULT rc = S_OK; switch (m->state) { case MediumState_Created: case MediumState_Inaccessible: { if (m->state == MediumState_Created) m->accessibleInLock = true; else if (m->state == MediumState_Inaccessible) m->accessibleInLock = false; m->state = MediumState_LockedWrite; break; } default: { rc = setStateError(); break; } } return rc; } /** * @note @a aState may be NULL if the state value is not needed (only for * in-process calls). */ STDMETHODIMP Medium::UnlockWrite(MediumState_T *aState) { AutoCaller autoCaller(this); CheckComRCReturnRC(autoCaller.rc()); AutoWriteLock alock(this); HRESULT rc = S_OK; switch (m->state) { case MediumState_LockedWrite: { if (m->accessibleInLock) m->state = MediumState_Created; else m->state = MediumState_Inaccessible; break; } default: { rc = setError(VBOX_E_INVALID_OBJECT_STATE, tr ("Medium '%ls' is not locked for writing"), m->locationFull.raw()); break; } } /* return the current state after */ if (aState) *aState = m->state; return rc; } STDMETHODIMP Medium::Close() { AutoMayUninitSpan mayUninitSpan(this); CheckComRCReturnRC(mayUninitSpan.rc()); if (mayUninitSpan.alreadyInProgress()) return S_OK; /* unregisterWithVirtualBox() is assumed to always need a write mVirtualBox * lock as it is intenede to modify its internal structires. Also, we want * to unregister ourselves atomically after detecting that closure is * possible to make sure that we don't do that after another thread has done * VirtualBox::find*() but before it starts using us (provided that it holds * a mVirtualBox lock of course). */ AutoWriteLock vboxLock(mVirtualBox); bool wasCreated = true; switch (m->state) { case MediumState_NotCreated: wasCreated = false; break; case MediumState_Created: case MediumState_Inaccessible: break; default: return setStateError(); } if (m->backRefs.size() != 0) return setError(VBOX_E_OBJECT_IN_USE, tr("Medium '%ls' is attached to %d virtual machines"), m->locationFull.raw(), m->backRefs.size()); /* perform extra media-dependent close checks */ HRESULT rc = canClose(); CheckComRCReturnRC(rc); if (wasCreated) { /* remove from the list of known media before performing actual * uninitialization (to keep the media registry consistent on * failure to do so) */ rc = unregisterWithVirtualBox(); CheckComRCReturnRC(rc); } /* cause uninit() to happen on success */ mayUninitSpan.acceptUninit(); return S_OK; } STDMETHODIMP Medium::GetProperty(IN_BSTR aName, BSTR *aValue) { CheckComArgStrNotEmptyOrNull(aName); CheckComArgOutPointerValid(aValue); AutoCaller autoCaller(this); CheckComRCReturnRC(autoCaller.rc()); AutoReadLock alock(this); Data::PropertyMap::const_iterator it = m->properties.find(Bstr(aName)); if (it == m->properties.end()) return setError(VBOX_E_OBJECT_NOT_FOUND, tr("Property '%ls' does not exist"), aName); if (it->second.isEmpty()) Bstr("").cloneTo(aValue); else it->second.cloneTo(aValue); return S_OK; } STDMETHODIMP Medium::SetProperty(IN_BSTR aName, IN_BSTR aValue) { CheckComArgStrNotEmptyOrNull(aName); AutoCaller autoCaller(this); CheckComRCReturnRC(autoCaller.rc()); /* VirtualBox::saveSettings() needs a write lock */ AutoMultiWriteLock2 alock(mVirtualBox, this); switch (m->state) { case MediumState_Created: case MediumState_Inaccessible: break; default: return setStateError(); } Data::PropertyMap::iterator it = m->properties.find(Bstr(aName)); if (it == m->properties.end()) return setError(VBOX_E_OBJECT_NOT_FOUND, tr("Property '%ls' does not exist"), aName); if (aValue && !*aValue) it->second = (const char *)NULL; else it->second = aValue; HRESULT rc = mVirtualBox->saveSettings(); return rc; } STDMETHODIMP Medium::GetProperties(IN_BSTR aNames, ComSafeArrayOut(BSTR, aReturnNames), ComSafeArrayOut(BSTR, aReturnValues)) { CheckComArgOutSafeArrayPointerValid(aReturnNames); CheckComArgOutSafeArrayPointerValid(aReturnValues); AutoCaller autoCaller(this); CheckComRCReturnRC(autoCaller.rc()); AutoReadLock alock(this); /// @todo make use of aNames according to the documentation NOREF(aNames); com::SafeArray names(m->properties.size()); com::SafeArray values(m->properties.size()); size_t i = 0; for (Data::PropertyMap::const_iterator it = m->properties.begin(); it != m->properties.end(); ++it) { it->first.cloneTo(&names[i]); if (it->second.isEmpty()) Bstr("").cloneTo(&values [i]); else it->second.cloneTo(&values [i]); ++ i; } names.detachTo(ComSafeArrayOutArg(aReturnNames)); values.detachTo(ComSafeArrayOutArg(aReturnValues)); return S_OK; } STDMETHODIMP Medium::SetProperties(ComSafeArrayIn(IN_BSTR, aNames), ComSafeArrayIn(IN_BSTR, aValues)) { CheckComArgSafeArrayNotNull(aNames); CheckComArgSafeArrayNotNull(aValues); AutoCaller autoCaller(this); CheckComRCReturnRC(autoCaller.rc()); /* VirtualBox::saveSettings() needs a write lock */ AutoMultiWriteLock2 alock(mVirtualBox, this); com::SafeArray names(ComSafeArrayInArg(aNames)); com::SafeArray values(ComSafeArrayInArg(aValues)); /* first pass: validate names */ for (size_t i = 0; i < names.size(); ++i) { if (m->properties.find(Bstr(names[i])) == m->properties.end()) return setError(VBOX_E_OBJECT_NOT_FOUND, tr("Property '%ls' does not exist"), names[i]); } /* second pass: assign */ for (size_t i = 0; i < names.size(); ++i) { Data::PropertyMap::iterator it = m->properties.find(Bstr(names[i])); AssertReturn(it != m->properties.end(), E_FAIL); if (values[i] && !*values[i]) it->second = (const char *)NULL; else it->second = values [i]; } HRESULT rc = mVirtualBox->saveSettings(); return rc; } STDMETHODIMP Medium::CreateBaseStorage(ULONG64 aLogicalSize, MediumVariant_T aVariant, IProgress **aProgress) { CheckComArgOutPointerValid(aProgress); AutoCaller autoCaller(this); CheckComRCReturnRC(autoCaller.rc()); AutoWriteLock alock(this); aVariant = (MediumVariant_T)((unsigned)aVariant & (unsigned)~MediumVariant_Diff); if ( !(aVariant & MediumVariant_Fixed) && !(m->formatObj->capabilities() & MediumFormatCapabilities_CreateDynamic)) return setError(VBOX_E_NOT_SUPPORTED, tr("Hard disk format '%ls' does not support dynamic storage creation"), m->format.raw()); if ( (aVariant & MediumVariant_Fixed) && !(m->formatObj->capabilities() & MediumFormatCapabilities_CreateDynamic)) return setError(VBOX_E_NOT_SUPPORTED, tr("Hard disk format '%ls' does not support fixed storage creation"), m->format.raw()); switch (m->state) { case MediumState_NotCreated: break; default: return setStateError(); } ComObjPtr progress; progress.createObject(); /// @todo include fixed/dynamic HRESULT rc = progress->init(mVirtualBox, static_cast(this), (aVariant & MediumVariant_Fixed) ? BstrFmt(tr("Creating fixed hard disk storage unit '%ls'"), m->locationFull.raw()) : BstrFmt(tr("Creating dynamic hard disk storage unit '%ls'"), m->locationFull.raw()), TRUE /* aCancelable */); CheckComRCReturnRC(rc); /* setup task object and thread to carry out the operation * asynchronously */ std::auto_ptr task(new Task(this, progress, Task::CreateBase)); AssertComRCReturnRC(task->autoCaller.rc()); task->d.size = aLogicalSize; task->d.variant = aVariant; rc = task->startThread(); CheckComRCReturnRC(rc); /* go to Creating state on success */ m->state = MediumState_Creating; /* task is now owned by taskThread() so release it */ task.release(); /* return progress to the caller */ progress.queryInterfaceTo(aProgress); return S_OK; } STDMETHODIMP Medium::DeleteStorage(IProgress **aProgress) { CheckComArgOutPointerValid(aProgress); AutoCaller autoCaller(this); CheckComRCReturnRC(autoCaller.rc()); ComObjPtr progress; HRESULT rc = deleteStorageNoWait(progress); if (SUCCEEDED(rc)) { /* return progress to the caller */ progress.queryInterfaceTo(aProgress); } return rc; } STDMETHODIMP Medium::CreateDiffStorage(IMedium *aTarget, MediumVariant_T aVariant, IProgress **aProgress) { CheckComArgNotNull(aTarget); CheckComArgOutPointerValid(aProgress); AutoCaller autoCaller(this); CheckComRCReturnRC(autoCaller.rc()); ComObjPtr diff; HRESULT rc = mVirtualBox->cast(aTarget, diff); CheckComRCReturnRC(rc); AutoWriteLock alock(this); if (m->type == MediumType_Writethrough) return setError(E_FAIL, tr("Hard disk '%ls' is Writethrough"), m->locationFull.raw()); /* We want to be locked for reading as long as our diff child is being * created */ rc = LockRead(NULL); CheckComRCReturnRC(rc); ComObjPtr progress; rc = createDiffStorageNoWait(diff, aVariant, progress); if (FAILED(rc)) { HRESULT rc2 = UnlockRead(NULL); AssertComRC(rc2); /* Note: on success, taskThread() will unlock this */ } else { /* return progress to the caller */ progress.queryInterfaceTo(aProgress); } return rc; } STDMETHODIMP Medium::MergeTo(IN_BSTR /* aTargetId */, IProgress ** /* aProgress */) { AutoCaller autoCaller(this); CheckComRCReturnRC(autoCaller.rc()); ReturnComNotImplemented(); } STDMETHODIMP Medium::CloneTo(IMedium *aTarget, MediumVariant_T aVariant, IMedium *aParent, IProgress **aProgress) { CheckComArgNotNull(aTarget); CheckComArgOutPointerValid(aProgress); AutoCaller autoCaller(this); CheckComRCReturnRC(autoCaller.rc()); ComObjPtr target; HRESULT rc = mVirtualBox->cast(aTarget, target); CheckComRCReturnRC(rc); ComObjPtr parent; if (aParent) { rc = mVirtualBox->cast(aParent, parent); CheckComRCReturnRC(rc); } AutoMultiWriteLock3 alock(this, target, parent); ComObjPtr progress; try { if ( target->m->state != MediumState_NotCreated && target->m->state != MediumState_Created) throw target->setStateError(); /** @todo separate out creating/locking an image chain from * SessionMachine::lockMedia and use it from here too. * logically this belongs into Medium functionality. */ /* Build the source chain and lock images in the proper order. */ std::auto_ptr srcChain(new ImageChain()); /* we walk the source tree */ AutoReadLock srcTreeLock(this->treeLock()); for (Medium *hd = this; hd; hd = hd->mParent) { rc = srcChain->addImage(hd); CheckComRCThrowRC(rc); } rc = srcChain->lockImagesRead(); CheckComRCThrowRC(rc); /* Build the parent chain and lock images in the proper order. */ std::auto_ptr parentChain(new ImageChain()); /* we walk the future parent tree */ AutoReadLock parentTreeLock; if (parent) parentTreeLock.attach(parent->treeLock()); for (Medium *hd = parent; hd; hd = hd->mParent) { rc = parentChain->addImage(hd); CheckComRCThrowRC(rc); } if (target->m->state == MediumState_Created) { /* If we're cloning to an existing image the parent chain also * contains the target image, and it gets locked for writing. */ rc = parentChain->addImage(target); CheckComRCThrowRC(rc); rc = parentChain->lockImagesReadAndLastWrite(); CheckComRCThrowRC(rc); } else { rc = parentChain->lockImagesRead(); CheckComRCThrowRC(rc); } progress.createObject(); rc = progress->init(mVirtualBox, static_cast (this), BstrFmt(tr("Creating clone hard disk '%ls'"), target->m->locationFull.raw()), TRUE /* aCancelable */); CheckComRCThrowRC(rc); /* setup task object and thread to carry out the operation * asynchronously */ std::auto_ptr task(new Task(this, progress, Task::Clone)); AssertComRCThrowRC(task->autoCaller.rc()); task->setData(target, parent); task->d.variant = aVariant; task->setData(srcChain.release(), parentChain.release()); rc = task->startThread(); CheckComRCThrowRC(rc); if (target->m->state == MediumState_NotCreated) { /* go to Creating state before leaving the lock */ target->m->state = MediumState_Creating; } /* task is now owned (or already deleted) by taskThread() so release it */ task.release(); } catch (HRESULT aRC) { rc = aRC; } if (SUCCEEDED(rc)) { /* return progress to the caller */ progress.queryInterfaceTo(aProgress); } return rc; } STDMETHODIMP Medium::Compact(IProgress **aProgress) { CheckComArgOutPointerValid(aProgress); AutoCaller autoCaller(this); CheckComRCReturnRC(autoCaller.rc()); AutoWriteLock alock(this); ComObjPtr progress; HRESULT rc = S_OK; try { /** @todo separate out creating/locking an image chain from * SessionMachine::lockMedia and use it from here too. * logically this belongs into Medium functionality. */ /* Build the image chain and lock images in the proper order. */ std::auto_ptr imgChain(new ImageChain()); /* we walk the image tree */ AutoReadLock srcTreeLock(this->treeLock()); for (Medium *hd = this; hd; hd = hd->mParent) { rc = imgChain->addImage(hd); CheckComRCThrowRC(rc); } rc = imgChain->lockImagesReadAndLastWrite(); CheckComRCThrowRC(rc); progress.createObject(); rc = progress->init(mVirtualBox, static_cast (this), BstrFmt(tr("Compacting hard disk '%ls'"), m->locationFull.raw()), TRUE /* aCancelable */); CheckComRCThrowRC(rc); /* setup task object and thread to carry out the operation * asynchronously */ std::auto_ptr task(new Task(this, progress, Task::Compact)); AssertComRCThrowRC(task->autoCaller.rc()); task->setData(imgChain.release()); rc = task->startThread(); CheckComRCThrowRC(rc); /* task is now owned (or already deleted) by taskThread() so release it */ task.release(); } catch (HRESULT aRC) { rc = aRC; } if (SUCCEEDED(rc)) { /* return progress to the caller */ progress.queryInterfaceTo(aProgress); } return rc; } STDMETHODIMP Medium::Reset(IProgress **aProgress) { CheckComArgOutPointerValid(aProgress); AutoCaller autoCaller(this); CheckComRCReturnRC(autoCaller.rc()); AutoWriteLock alock(this); if (mParent.isNull()) return setError(VBOX_E_NOT_SUPPORTED, tr ("Hard disk '%ls' is not differencing"), m->locationFull.raw()); HRESULT rc = canClose(); CheckComRCReturnRC(rc); rc = LockWrite(NULL); CheckComRCReturnRC(rc); ComObjPtr progress; try { progress.createObject(); rc = progress->init(mVirtualBox, static_cast (this), BstrFmt(tr("Resetting differencing hard disk '%ls'"), m->locationFull.raw()), FALSE /* aCancelable */); CheckComRCThrowRC(rc); /* setup task object and thread to carry out the operation * asynchronously */ std::auto_ptr task(new Task(this, progress, Task::Reset)); AssertComRCThrowRC(task->autoCaller.rc()); rc = task->startThread(); CheckComRCThrowRC(rc); /* task is now owned (or already deleted) by taskThread() so release it */ task.release(); } catch (HRESULT aRC) { rc = aRC; } if (FAILED (rc)) { HRESULT rc2 = UnlockWrite(NULL); AssertComRC(rc2); /* Note: on success, taskThread() will unlock this */ } else { /* return progress to the caller */ progress.queryInterfaceTo(aProgress); } return rc; } //////////////////////////////////////////////////////////////////////////////// // // Medium internal methods // //////////////////////////////////////////////////////////////////////////////// /** * Checks if the given change of \a aOldPath to \a aNewPath affects the location * of this media and updates it if necessary to reflect the new location. * * @param aOldPath Old path (full). * @param aNewPath New path (full). * * @note Locks this object for writing. */ HRESULT Medium::updatePath(const char *aOldPath, const char *aNewPath) { AssertReturn(aOldPath, E_FAIL); AssertReturn(aNewPath, E_FAIL); AutoCaller autoCaller(this); CheckComRCReturnRC(autoCaller.rc()); AutoWriteLock alock(this); LogFlowThisFunc(("locationFull.before='%s'\n", m->locationFull.raw())); Utf8Str path = m->locationFull; if (RTPathStartsWith(path.c_str(), aOldPath)) { Utf8Str newPath = Utf8StrFmt("%s%s", aNewPath, path.raw() + strlen(aOldPath)); path = newPath; mVirtualBox->calculateRelativePath(path, path); unconst(m->locationFull) = newPath; unconst(m->location) = path; LogFlowThisFunc(("locationFull.after='%s'\n", m->locationFull.raw())); } return S_OK; } /** * Adds the given machine and optionally the snapshot to the list of the objects * this image is attached to. * * @param aMachineId Machine ID. * @param aSnapshotId Snapshot ID; when non-empty, adds a snapshot attachment. */ HRESULT Medium::attachTo(const Guid &aMachineId, const Guid &aSnapshotId /*= Guid::Empty*/) { AssertReturn(!aMachineId.isEmpty(), E_FAIL); AutoCaller autoCaller(this); AssertComRCReturnRC(autoCaller.rc()); AutoWriteLock alock(this); switch (m->state) { case MediumState_Created: case MediumState_Inaccessible: case MediumState_LockedRead: case MediumState_LockedWrite: break; default: return setStateError(); } HRESULT rc = canAttach(aMachineId, aSnapshotId); CheckComRCReturnRC(rc); BackRefList::iterator it = std::find_if(m->backRefs.begin(), m->backRefs.end(), BackRef::EqualsTo(aMachineId)); if (it == m->backRefs.end()) { BackRef ref(aMachineId, aSnapshotId); m->backRefs.push_back(ref); return S_OK; } if (aSnapshotId.isEmpty()) { /* sanity: no duplicate attachments */ AssertReturn(!it->inCurState, E_FAIL); it->inCurState = true; return S_OK; } /* sanity: no duplicate attachments */ BackRef::GuidList::const_iterator jt = std::find(it->snapshotIds.begin(), it->snapshotIds.end(), aSnapshotId); AssertReturn(jt == it->snapshotIds.end(), E_FAIL); it->snapshotIds.push_back(aSnapshotId); return S_OK; } /** * Removes the given machine and optionally the snapshot from the list of the * objects this image is attached to. * * @param aMachineId Machine ID. * @param aSnapshotId Snapshot ID; when non-empty, removes the snapshot * attachment. */ HRESULT Medium::detachFrom(const Guid &aMachineId, const Guid &aSnapshotId /*= Guid::Empty*/) { AssertReturn(!aMachineId.isEmpty(), E_FAIL); AutoCaller autoCaller(this); AssertComRCReturnRC(autoCaller.rc()); AutoWriteLock alock(this); BackRefList::iterator it = std::find_if(m->backRefs.begin(), m->backRefs.end(), BackRef::EqualsTo(aMachineId)); AssertReturn(it != m->backRefs.end(), E_FAIL); if (aSnapshotId.isEmpty()) { /* remove the current state attachment */ it->inCurState = false; } else { /* remove the snapshot attachment */ BackRef::GuidList::iterator jt = std::find(it->snapshotIds.begin(), it->snapshotIds.end(), aSnapshotId); AssertReturn(jt != it->snapshotIds.end(), E_FAIL); it->snapshotIds.erase(jt); } /* if the backref becomes empty, remove it */ if (it->inCurState == false && it->snapshotIds.size() == 0) m->backRefs.erase(it); return S_OK; } /** * Internal method to return the medium's GUID. Must have caller + locking! * @return */ const Guid& Medium::id() const { return m->id; } /** * Internal method to return the medium's GUID. Must have caller + locking! * @return */ MediumState_T Medium::state() const { return m->state; } /** * Internal method to return the medium's location. Must have caller + locking! * @return */ const Bstr& Medium::location() const { return m->location; } /** * Internal method to return the medium's full location. Must have caller + locking! * @return */ const Bstr& Medium::locationFull() const { return m->locationFull; } /** * Internal method to return the medium's list of backrefs. Must have caller + locking! * @return */ // const Medium::BackRefList& Medium::backRefs() const // { // return m->backRefs; // } const Guid* Medium::getFirstMachineBackrefId() const { if (!m->backRefs.size()) return NULL; return &m->backRefs.front().machineId; } const Guid* Medium::getFirstMachineBackrefSnapshotId() const { if (!m->backRefs.size()) return NULL; const BackRef &ref = m->backRefs.front(); if (!ref.snapshotIds.size()) return NULL; return &ref.snapshotIds.front(); } /** * Internal method to check whether the medium is attached to the given machine. Must have caller + locking! * @return */ bool Medium::isAttachedTo(const Guid &aMachineId) { BackRefList::iterator it = std::find_if(m->backRefs.begin(), m->backRefs.end(), BackRef::EqualsTo(aMachineId)); return it != m->backRefs.end() && it->inCurState; } /** * Checks if the given change of \a aOldPath to \a aNewPath affects the location * of this hard disk or any its child and updates the paths if necessary to * reflect the new location. * * @param aOldPath Old path (full). * @param aNewPath New path (full). * * @note Locks treeLock() for reading, this object and all children for writing. */ void Medium::updatePaths(const char *aOldPath, const char *aNewPath) { AssertReturnVoid(aOldPath); AssertReturnVoid(aNewPath); AutoCaller autoCaller(this); AssertComRCReturnVoid(autoCaller.rc()); AutoWriteLock alock(this); /* we access children() */ AutoReadLock treeLock(this->treeLock()); updatePath(aOldPath, aNewPath); /* update paths of all children */ for (List::const_iterator it = children().begin(); it != children().end(); ++ it) { (*it)->updatePaths(aOldPath, aNewPath); } } /** * Returns the base hard disk of the hard disk chain this hard disk is part of. * * The base hard disk is found by walking up the parent-child relationship axis. * If the hard disk doesn't have a parent (i.e. it's a base hard disk), it * returns itself in response to this method. * * @param aLevel Where to store the number of ancestors of this hard disk * (zero for the base), may be @c NULL. * * @note Locks treeLock() for reading. */ ComObjPtr Medium::base(uint32_t *aLevel /*= NULL*/) { ComObjPtr base; uint32_t level; AutoCaller autoCaller(this); AssertReturn(autoCaller.isOk(), base); /* we access mParent */ AutoReadLock treeLock(this->treeLock()); base = this; level = 0; if (!mParent.isNull()) { for (;;) { AutoCaller baseCaller(base); AssertReturn(baseCaller.isOk(), base); if (base->mParent.isNull()) break; base = base->mParent; ++ level; } } if (aLevel != NULL) *aLevel = level; return base; } /** * Returns @c true if this hard disk cannot be modified because it has * dependants (children) or is part of the snapshot. Related to the hard disk * type and posterity, not to the current media state. * * @note Locks this object and treeLock() for reading. */ bool Medium::isReadOnly() { AutoCaller autoCaller(this); AssertComRCReturn(autoCaller.rc(), false); AutoReadLock alock(this); /* we access children */ AutoReadLock treeLock(this->treeLock()); switch (m->type) { case MediumType_Normal: { if (children().size() != 0) return true; for (BackRefList::const_iterator it = m->backRefs.begin(); it != m->backRefs.end(); ++ it) if (it->snapshotIds.size() != 0) return true; return false; } case MediumType_Immutable: { return true; } case MediumType_Writethrough: { return false; } default: break; } AssertFailedReturn(false); } /** * Saves hard disk data by appending a new child node to the given * parent node which can be either or . * * @param data Settings struct to be updated. * * @note Locks this object, treeLock() and children for reading. */ HRESULT Medium::saveSettings(settings::Medium &data) { AutoCaller autoCaller(this); CheckComRCReturnRC(autoCaller.rc()); AutoReadLock alock(this); /* we access mParent */ AutoReadLock treeLock(this->treeLock()); data.uuid = m->id; data.strLocation = m->location; data.strFormat = m->format; /* optional, only for diffs, default is false */ if (!mParent.isNull()) data.fAutoReset = !!m->autoReset; else data.fAutoReset = false; /* optional */ data.strDescription = m->description; /* optional properties */ data.properties.clear(); for (Data::PropertyMap::const_iterator it = m->properties.begin(); it != m->properties.end(); ++it) { /* only save properties that have non-default values */ if (!it->second.isNull()) { Utf8Str name = it->first; Utf8Str value = it->second; data.properties[name] = value; } } /* only for base hard disks */ if (mParent.isNull()) data.hdType = m->type; /* save all children */ for (List::const_iterator it = children().begin(); it != children().end(); ++it) { settings::Medium m; HRESULT rc = (*it)->saveSettings(m); AssertComRCReturnRC(rc); data.llChildren.push_back(m); } return S_OK; } /** * Compares the location of this hard disk to the given location. * * The comparison takes the location details into account. For example, if the * location is a file in the host's filesystem, a case insensitive comparison * will be performed for case insensitive filesystems. * * @param aLocation Location to compare to (as is). * @param aResult Where to store the result of comparison: 0 if locations * are equal, 1 if this object's location is greater than * the specified location, and -1 otherwise. */ HRESULT Medium::compareLocationTo(const char *aLocation, int &aResult) { AutoCaller autoCaller(this); AssertComRCReturnRC(autoCaller.rc()); AutoReadLock alock(this); Utf8Str locationFull(m->locationFull); /// @todo NEWMEDIA delegate the comparison to the backend? if (m->formatObj->capabilities() & MediumFormatCapabilities_File) { Utf8Str location(aLocation); /* For locations represented by files, append the default path if * only the name is given, and then get the full path. */ if (!RTPathHavePath(aLocation)) { location = Utf8StrFmt("%s%c%s", mVirtualBox->getDefaultHardDiskFolder().raw(), RTPATH_DELIMITER, aLocation); } int vrc = mVirtualBox->calculateFullPath(location, location); if (RT_FAILURE(vrc)) return setError(E_FAIL, tr("Invalid hard disk storage file location '%s' (%Rrc)"), location.raw(), vrc); aResult = RTPathCompare(locationFull.c_str(), location.c_str()); } else aResult = locationFull.compare(aLocation); return S_OK; } /** * Checks that this hard disk may be discarded and performs necessary state * changes. * * This method is to be called prior to calling the #discard() to perform * necessary consistency checks and place involved hard disks to appropriate * states. If #discard() is not called or fails, the state modifications * performed by this method must be undone by #cancelDiscard(). * * See #discard() for more info about discarding hard disks. * * @param aChain Where to store the created merge chain (may return NULL * if no real merge is necessary). * * @note Locks treeLock() for reading. Locks this object, aTarget and all * intermediate hard disks for writing. */ HRESULT Medium::prepareDiscard(MergeChain * &aChain) { AutoCaller autoCaller(this); AssertComRCReturnRC(autoCaller.rc()); aChain = NULL; AutoWriteLock alock(this); /* we access mParent & children() */ AutoReadLock treeLock(this->treeLock()); AssertReturn(m->type == MediumType_Normal, E_FAIL); if (children().size() == 0) { /* special treatment of the last hard disk in the chain: */ if (mParent.isNull()) { /* lock only, to prevent any usage; discard() will unlock */ return LockWrite(NULL); } /* the differencing hard disk w/o children will be deleted, protect it * from attaching to other VMs (this is why Deleting) */ switch (m->state) { case MediumState_Created: m->state = MediumState_Deleting; break; default: return setStateError(); } /* aChain is intentionally NULL here */ return S_OK; } /* not going multi-merge as it's too expensive */ if (children().size() > 1) return setError(E_FAIL, tr ("Hard disk '%ls' has more than one child hard disk (%d)"), m->locationFull.raw(), children().size()); /* this is a read-only hard disk with children; it must be associated with * exactly one snapshot (when the snapshot is being taken, none of the * current VM's hard disks may be attached to other VMs). Note that by the * time when discard() is called, there must be no any attachments at all * (the code calling prepareDiscard() should detach). */ AssertReturn(m->backRefs.size() == 1 && !m->backRefs.front().inCurState && m->backRefs.front().snapshotIds.size() == 1, E_FAIL); ComObjPtr child = children().front(); /* we keep this locked, so lock the affected child to make sure the lock * order is correct when calling prepareMergeTo() */ AutoWriteLock childLock(child); /* delegate the rest to the profi */ if (mParent.isNull()) { /* base hard disk, backward merge */ Assert(child->m->backRefs.size() == 1); if (child->m->backRefs.front().machineId != m->backRefs.front().machineId) { /* backward merge is too tricky, we'll just detach on discard, so * lock only, to prevent any usage; discard() will only unlock * (since we return NULL in aChain) */ return LockWrite(NULL); } return child->prepareMergeTo(this, aChain, true /* aIgnoreAttachments */); } else { /* forward merge */ return prepareMergeTo(child, aChain, true /* aIgnoreAttachments */); } } /** * Discards this hard disk. * * Discarding the hard disk is merging its contents to its differencing child * hard disk (forward merge) or contents of its child hard disk to itself * (backward merge) if this hard disk is a base hard disk. If this hard disk is * a differencing hard disk w/o children, then it will be simply deleted. * Calling this method on a base hard disk w/o children will do nothing and * silently succeed. If this hard disk has more than one child, the method will * currently return an error (since merging in this case would be too expensive * and result in data duplication). * * When the backward merge takes place (i.e. this hard disk is a target) then, * on success, this hard disk will automatically replace the differencing child * hard disk used as a source (which will then be deleted) in the attachment * this child hard disk is associated with. This will happen only if both hard * disks belong to the same machine because otherwise such a replace would be * too tricky and could be not expected by the other machine. Same relates to a * case when the child hard disk is not associated with any machine at all. When * the backward merge is not applied, the method behaves as if the base hard * disk were not attached at all -- i.e. simply detaches it from the machine but * leaves the hard disk chain intact. * * This method is basically a wrapper around #mergeTo() that selects the correct * merge direction and performs additional actions as described above and. * * Note that this method will not return until the merge operation is complete * (which may be quite time consuming depending on the size of the merged hard * disks). * * Note that #prepareDiscard() must be called before calling this method. If * this method returns a failure, the caller must call #cancelDiscard(). On * success, #cancelDiscard() must not be called (this method will perform all * necessary steps such as resetting states of all involved hard disks and * deleting @a aChain). * * @param aChain Merge chain created by #prepareDiscard() (may be NULL if * no real merge takes place). * * @note Locks the hard disks from the chain for writing. Locks the machine * object when the backward merge takes place. Locks treeLock() lock for * reading or writing. */ HRESULT Medium::discard(ComObjPtr &aProgress, MergeChain *aChain) { AssertReturn(!aProgress.isNull(), E_FAIL); ComObjPtr hdFrom; HRESULT rc = S_OK; { AutoCaller autoCaller(this); AssertComRCReturnRC(autoCaller.rc()); aProgress->SetNextOperation(BstrFmt(tr("Discarding hard disk '%s'"), name().raw()), 1); // weight if (aChain == NULL) { AutoWriteLock alock(this); /* we access mParent & children() */ AutoReadLock treeLock(this->treeLock()); Assert(children().size() == 0); /* special treatment of the last hard disk in the chain: */ if (mParent.isNull()) { rc = UnlockWrite(NULL); AssertComRC(rc); return rc; } /* delete the differencing hard disk w/o children */ Assert(m->state == MediumState_Deleting); /* go back to Created since deleteStorage() expects this state */ m->state = MediumState_Created; hdFrom = this; rc = deleteStorageAndWait(&aProgress); } else { hdFrom = aChain->source(); rc = hdFrom->mergeToAndWait(aChain, &aProgress); } } if (SUCCEEDED(rc)) { /* mergeToAndWait() cannot uninitialize the initiator because of * possible AutoCallers on the current thread, deleteStorageAndWait() * doesn't do it either; do it ourselves */ hdFrom->uninit(); } return rc; } /** * Undoes what #prepareDiscard() did. Must be called if #discard() is not called * or fails. Frees memory occupied by @a aChain. * * @param aChain Merge chain created by #prepareDiscard() (may be NULL if * no real merge takes place). * * @note Locks the hard disks from the chain for writing. Locks treeLock() for * reading. */ void Medium::cancelDiscard(MergeChain *aChain) { AutoCaller autoCaller(this); AssertComRCReturnVoid(autoCaller.rc()); if (aChain == NULL) { AutoWriteLock alock(this); /* we access mParent & children() */ AutoReadLock treeLock(this->treeLock()); Assert(children().size() == 0); /* special treatment of the last hard disk in the chain: */ if (mParent.isNull()) { HRESULT rc = UnlockWrite(NULL); AssertComRC(rc); return; } /* the differencing hard disk w/o children will be deleted, protect it * from attaching to other VMs (this is why Deleting) */ Assert(m->state == MediumState_Deleting); m->state = MediumState_Created; return; } /* delegate the rest to the profi */ cancelMergeTo(aChain); } /** * Returns a preferred format for differencing hard disks. */ Bstr Medium::preferredDiffFormat() { Bstr format; AutoCaller autoCaller(this); AssertComRCReturn(autoCaller.rc(), format); /* m->format is const, no need to lock */ format = m->format; /* check that our own format supports diffs */ if (!(m->formatObj->capabilities() & MediumFormatCapabilities_Differencing)) { /* use the default format if not */ AutoReadLock propsLock(mVirtualBox->systemProperties()); format = mVirtualBox->getDefaultHardDiskFormat(); } return format; } /** * Returns the medium type. Must have caller + locking! * @return */ MediumType_T Medium::type() const { return m->type; } /** * Returns VirtualBox::hardDiskTreeHandle(), for convenience. Don't forget * to follow these locking rules: * * 1. The write lock on this handle must be either held alone on the thread * or requested *after* the VirtualBox object lock. Mixing with other * locks is prohibited. * * 2. The read lock on this handle may be intermixed with any other lock * with the exception that it must be requested *after* the VirtualBox * object lock. */ RWLockHandle* Medium::treeLock() { return &mVirtualBox->hardDiskTreeLockHandle(); } // protected methods //////////////////////////////////////////////////////////////////////////////// /** * Returns a short version of the location attribute. * * @note Must be called from under this object's read or write lock. */ Utf8Str Medium::name() { Utf8Str location(m->locationFull); Utf8Str name = RTPathFilename(location.c_str()); return name; } /** * Sets the value of m->location and calculates the value of m->locationFull. * * Treats non-FS-path locations specially, and prepends the default hard disk * folder if the given location string does not contain any path information * at all. * * Also, if the specified location is a file path that ends with '/' then the * file name part will be generated by this method automatically in the format * '{}.' where is a fresh UUID that this method will generate * and assign to this medium, and is the default extension for this * medium's storage format. Note that this procedure requires the media state to * be NotCreated and will return a faiulre otherwise. * * @param aLocation Location of the storage unit. If the location is a FS-path, * then it can be relative to the VirtualBox home directory. * @param aFormat Optional fallback format if it is an import and the format * cannot be determined. * * @note Must be called from under this object's write lock. */ HRESULT Medium::setLocation(const Utf8Str &aLocation, const Utf8Str &aFormat) { AssertReturn(!aLocation.isEmpty(), E_FAIL); AutoCaller autoCaller(this); AssertComRCReturnRC(autoCaller.rc()); /* formatObj may be null only when initializing from an existing path and * no format is known yet */ AssertReturn((!m->format.isNull() && !m->formatObj.isNull()) || (autoCaller.state() == InInit && m->state != MediumState_NotCreated && m->id.isEmpty() && m->format.isNull() && m->formatObj.isNull()), E_FAIL); /* are we dealing with a new hard disk constructed using the existing * location? */ bool isImport = m->format.isNull(); if (isImport || (m->formatObj->capabilities() & MediumFormatCapabilities_File)) { Guid id; Utf8Str location(aLocation); if (m->state == MediumState_NotCreated) { /* must be a file (formatObj must be already known) */ Assert(m->formatObj->capabilities() & MediumFormatCapabilities_File); if (RTPathFilename(location.c_str()) == NULL) { /* no file name is given (either an empty string or ends with a * slash), generate a new UUID + file name if the state allows * this */ ComAssertMsgRet(!m->formatObj->fileExtensions().empty(), ("Must be at least one extension if it is MediumFormatCapabilities_File\n"), E_FAIL); Bstr ext = m->formatObj->fileExtensions().front(); ComAssertMsgRet(!ext.isEmpty(), ("Default extension must not be empty\n"), E_FAIL); id.create(); location = Utf8StrFmt("%s{%RTuuid}.%ls", location.raw(), id.raw(), ext.raw()); } } /* append the default folder if no path is given */ if (!RTPathHavePath(location.c_str())) location = Utf8StrFmt("%s%c%s", mVirtualBox->getDefaultHardDiskFolder().raw(), RTPATH_DELIMITER, location.raw()); /* get the full file name */ Utf8Str locationFull; int vrc = mVirtualBox->calculateFullPath(location, locationFull); if (RT_FAILURE(vrc)) return setError(VBOX_E_FILE_ERROR, tr("Invalid hard disk storage file location '%s' (%Rrc)"), location.raw(), vrc); /* detect the backend from the storage unit if importing */ if (isImport) { char *backendName = NULL; /* is it a file? */ { RTFILE file; vrc = RTFileOpen(&file, locationFull.c_str(), RTFILE_O_READ); if (RT_SUCCESS(vrc)) RTFileClose(file); } if (RT_SUCCESS(vrc)) { vrc = VDGetFormat(NULL, locationFull.c_str(), &backendName); } else if (vrc != VERR_FILE_NOT_FOUND && vrc != VERR_PATH_NOT_FOUND) { /* assume it's not a file, restore the original location */ location = locationFull = aLocation; vrc = VDGetFormat(NULL, locationFull.c_str(), &backendName); } if (RT_FAILURE(vrc)) { if (vrc == VERR_FILE_NOT_FOUND || vrc == VERR_PATH_NOT_FOUND) return setError(VBOX_E_FILE_ERROR, tr("Could not find file for the hard disk '%s' (%Rrc)"), locationFull.raw(), vrc); else if (aFormat.isEmpty()) return setError(VBOX_E_IPRT_ERROR, tr("Could not get the storage format of the hard disk '%s' (%Rrc)"), locationFull.raw(), vrc); else { HRESULT rc = setFormat(Bstr(aFormat)); /* setFormat() must not fail since we've just used the backend so * the format object must be there */ AssertComRCReturnRC(rc); } } else { ComAssertRet(backendName != NULL && *backendName != '\0', E_FAIL); HRESULT rc = setFormat(Bstr(backendName)); RTStrFree(backendName); /* setFormat() must not fail since we've just used the backend so * the format object must be there */ AssertComRCReturnRC(rc); } } /* is it still a file? */ if (m->formatObj->capabilities() & MediumFormatCapabilities_File) { m->location = location; m->locationFull = locationFull; if (m->state == MediumState_NotCreated) { /* assign a new UUID (this UUID will be used when calling * VDCreateBase/VDCreateDiff as a wanted UUID). Note that we * also do that if we didn't generate it to make sure it is * either generated by us or reset to null */ unconst(m->id) = id; } } else { m->location = locationFull; m->locationFull = locationFull; } } else { m->location = aLocation; m->locationFull = aLocation; } return S_OK; } /** * Queries information from the image file. * * As a result of this call, the accessibility state and data members such as * size and description will be updated with the current information. * * @note This method may block during a system I/O call that checks storage * accessibility. * * @note Locks treeLock() for reading and writing (for new diff media checked * for the first time). Locks mParent for reading. Locks this object for * writing. */ HRESULT Medium::queryInfo() { AutoWriteLock alock(this); AssertReturn(m->state == MediumState_Created || m->state == MediumState_Inaccessible || m->state == MediumState_LockedRead || m->state == MediumState_LockedWrite, E_FAIL); HRESULT rc = S_OK; int vrc = VINF_SUCCESS; /* check if a blocking queryInfo() call is in progress on some other thread, * and wait for it to finish if so instead of querying data ourselves */ if (m->queryInfoSem != NIL_RTSEMEVENTMULTI) { Assert(m->state == MediumState_LockedRead); ++m->queryInfoCallers; alock.leave(); vrc = RTSemEventMultiWait(m->queryInfoSem, RT_INDEFINITE_WAIT); alock.enter(); --m->queryInfoCallers; if (m->queryInfoCallers == 0) { /* last waiting caller deletes the semaphore */ RTSemEventMultiDestroy(m->queryInfoSem); m->queryInfoSem = NIL_RTSEMEVENTMULTI; } AssertRC(vrc); return S_OK; } /* lazily create a semaphore for possible callers */ vrc = RTSemEventMultiCreate(&m->queryInfoSem); ComAssertRCRet(vrc, E_FAIL); bool tempStateSet = false; if (m->state != MediumState_LockedRead && m->state != MediumState_LockedWrite) { /* Cause other methods to prevent any modifications before leaving the * lock. Note that clients will never see this temporary state change * since any COMGETTER(State) is (or will be) blocked until we finish * and restore the actual state. */ m->state = MediumState_LockedRead; tempStateSet = true; } /* leave the lock before a blocking operation */ alock.leave(); bool success = false; Utf8Str lastAccessError; try { Utf8Str location(m->locationFull); /* totally useless to do accessibility checks for host drives */ if (m->hostDrive) { success = true; throw S_OK; } /* are we dealing with a new hard disk constructed using the existing * location? */ bool isImport = m->id.isEmpty(); PVBOXHDD hdd; vrc = VDCreate(m->vdDiskIfaces, &hdd); ComAssertRCThrow(vrc, E_FAIL); try { unsigned flags = VD_OPEN_FLAGS_INFO; /* Note that we don't use VD_OPEN_FLAGS_READONLY when opening new * hard disks because that would prevent necessary modifications * when opening hard disks of some third-party formats for the first * time in VirtualBox (such as VMDK for which VDOpen() needs to * generate an UUID if it is missing) */ if ( (m->hddOpenMode == OpenReadOnly) || !isImport ) flags |= VD_OPEN_FLAGS_READONLY; /** @todo This kind of opening of images is assuming that diff * images can be opened as base images. Should be fixed ASAP. */ vrc = VDOpen(hdd, Utf8Str(m->format).c_str(), location.c_str(), flags, m->vdDiskIfaces); if (RT_FAILURE(vrc)) { lastAccessError = Utf8StrFmt(tr("Could not open the hard disk '%ls'%s"), m->locationFull.raw(), vdError(vrc).raw()); throw S_OK; } if (m->formatObj->capabilities() & MediumFormatCapabilities_Uuid) { /* modify the UUIDs if necessary */ if (m->setImageId) { vrc = VDSetUuid(hdd, 0, m->imageId); ComAssertRCThrow(vrc, E_FAIL); } if (m->setParentId) { vrc = VDSetParentUuid(hdd, 0, m->parentId); ComAssertRCThrow(vrc, E_FAIL); } /* zap the information, these are no long-term members */ m->setImageId = false; unconst(m->imageId).clear(); m->setParentId = false; unconst(m->parentId).clear(); /* check the UUID */ RTUUID uuid; vrc = VDGetUuid(hdd, 0, &uuid); ComAssertRCThrow(vrc, E_FAIL); if (isImport) { unconst(m->id) = uuid; if (m->id.isEmpty() && (m->hddOpenMode == OpenReadOnly)) // only when importing a VDMK that has no UUID, create one in memory unconst(m->id).create(); } else { Assert(!m->id.isEmpty()); if (m->id != uuid) { lastAccessError = Utf8StrFmt( tr("UUID {%RTuuid} of the hard disk '%ls' does not match the value {%RTuuid} stored in the media registry ('%ls')"), &uuid, m->locationFull.raw(), m->id.raw(), mVirtualBox->settingsFilePath().raw()); throw S_OK; } } } else { /* the backend does not support storing UUIDs within the * underlying storage so use what we store in XML */ /* generate an UUID for an imported UUID-less hard disk */ if (isImport) { if (m->setImageId) unconst(m->id) = m->imageId; else unconst(m->id).create(); } } /* check the type */ unsigned uImageFlags; vrc = VDGetImageFlags(hdd, 0, &uImageFlags); ComAssertRCThrow(vrc, E_FAIL); if (uImageFlags & VD_IMAGE_FLAGS_DIFF) { RTUUID parentId; vrc = VDGetParentUuid(hdd, 0, &parentId); ComAssertRCThrow(vrc, E_FAIL); if (isImport) { /* the parent must be known to us. Note that we freely * call locking methods of mVirtualBox and parent from the * write lock (breaking the {parent,child} lock order) * because there may be no concurrent access to the just * opened hard disk on ther threads yet (and init() will * fail if this method reporst MediumState_Inaccessible) */ Guid id = parentId; ComObjPtr parent; rc = mVirtualBox->findHardDisk(&id, NULL, false /* aSetError */, &parent); if (FAILED(rc)) { lastAccessError = Utf8StrFmt( tr("Parent hard disk with UUID {%RTuuid} of the hard disk '%ls' is not found in the media registry ('%ls')"), &parentId, m->locationFull.raw(), mVirtualBox->settingsFilePath().raw()); throw S_OK; } /* deassociate from VirtualBox, associate with parent */ mVirtualBox->removeDependentChild(this); /* we set mParent & children() */ AutoWriteLock treeLock(this->treeLock()); Assert(mParent.isNull()); mParent = parent; mParent->addDependentChild(this); } else { /* we access mParent */ AutoReadLock treeLock(this->treeLock()); /* check that parent UUIDs match. Note that there's no need * for the parent's AutoCaller (our lifetime is bound to * it) */ if (mParent.isNull()) { lastAccessError = Utf8StrFmt( tr("Hard disk '%ls' is differencing but it is not associated with any parent hard disk in the media registry ('%ls')"), m->locationFull.raw(), mVirtualBox->settingsFilePath().raw()); throw S_OK; } AutoReadLock parentLock(mParent); if (mParent->state() != MediumState_Inaccessible && mParent->id() != parentId) { lastAccessError = Utf8StrFmt( tr ("Parent UUID {%RTuuid} of the hard disk '%ls' does not match UUID {%RTuuid} of its parent hard disk stored in the media registry ('%ls')"), &parentId, m->locationFull.raw(), mParent->id().raw(), mVirtualBox->settingsFilePath().raw()); throw S_OK; } /// @todo NEWMEDIA what to do if the parent is not /// accessible while the diff is? Probably, nothing. The /// real code will detect the mismatch anyway. } } m->size = VDGetFileSize(hdd, 0); m->logicalSize = VDGetSize(hdd, 0) / _1M; success = true; } catch (HRESULT aRC) { rc = aRC; } VDDestroy(hdd); } catch (HRESULT aRC) { rc = aRC; } alock.enter(); if (success) m->lastAccessError.setNull(); else { m->lastAccessError = lastAccessError; LogWarningFunc(("'%ls' is not accessible (error='%ls', rc=%Rhrc, vrc=%Rrc)\n", m->locationFull.raw(), m->lastAccessError.raw(), rc, vrc)); } /* inform other callers if there are any */ if (m->queryInfoCallers > 0) { RTSemEventMultiSignal(m->queryInfoSem); } else { /* delete the semaphore ourselves */ RTSemEventMultiDestroy(m->queryInfoSem); m->queryInfoSem = NIL_RTSEMEVENTMULTI; } if (tempStateSet) { /* Set the proper state according to the result of the check */ if (success) m->state = MediumState_Created; else m->state = MediumState_Inaccessible; } else { /* we're locked, use a special field to store the result */ m->accessibleInLock = success; } return rc; } /** * Sets the extended error info according to the current media state. * * @note Must be called from under this object's write or read lock. */ HRESULT Medium::setStateError() { HRESULT rc = E_FAIL; switch (m->state) { case MediumState_NotCreated: { rc = setError(VBOX_E_INVALID_OBJECT_STATE, tr("Storage for the medium '%ls' is not created"), m->locationFull.raw()); break; } case MediumState_Created: { rc = setError(VBOX_E_INVALID_OBJECT_STATE, tr("Storage for the medium '%ls' is already created"), m->locationFull.raw()); break; } case MediumState_LockedRead: { rc = setError(VBOX_E_INVALID_OBJECT_STATE, tr("Medium '%ls' is locked for reading by another task"), m->locationFull.raw()); break; } case MediumState_LockedWrite: { rc = setError(VBOX_E_INVALID_OBJECT_STATE, tr("Medium '%ls' is locked for writing by another task"), m->locationFull.raw()); break; } case MediumState_Inaccessible: { AssertMsg(!m->lastAccessError.isEmpty(), ("There must always be a reason for Inaccessible")); /* be in sync with Console::powerUpThread() */ if (!m->lastAccessError.isEmpty()) rc = setError(VBOX_E_INVALID_OBJECT_STATE, tr("Medium '%ls' is not accessible. %ls"), m->locationFull.raw(), m->lastAccessError.raw()); else rc = setError(VBOX_E_INVALID_OBJECT_STATE, tr("Medium '%ls' is not accessible"), m->locationFull.raw()); break; } case MediumState_Creating: { rc = setError(VBOX_E_INVALID_OBJECT_STATE, tr("Storage for the medium '%ls' is being created"), m->locationFull.raw(), m->lastAccessError.raw()); break; } case MediumState_Deleting: { rc = setError(VBOX_E_INVALID_OBJECT_STATE, tr("Storage for the medium '%ls' is being deleted"), m->locationFull.raw(), m->lastAccessError.raw()); break; } default: { AssertFailed(); break; } } return rc; } /** * Deletes the hard disk storage unit. * * If @a aProgress is not NULL but the object it points to is @c null then a new * progress object will be created and assigned to @a *aProgress on success, * otherwise the existing progress object is used. If Progress is NULL, then no * progress object is created/used at all. * * When @a aWait is @c false, this method will create a thread to perform the * delete operation asynchronously and will return immediately. Otherwise, it * will perform the operation on the calling thread and will not return to the * caller until the operation is completed. Note that @a aProgress cannot be * NULL when @a aWait is @c false (this method will assert in this case). * * @param aProgress Where to find/store a Progress object to track operation * completion. * @param aWait @c true if this method should block instead of creating * an asynchronous thread. * * @note Locks mVirtualBox and this object for writing. Locks treeLock() for * writing. */ HRESULT Medium::deleteStorage(ComObjPtr *aProgress, bool aWait) { AssertReturn(aProgress != NULL || aWait == true, E_FAIL); /* unregisterWithVirtualBox() needs a write lock. We want to unregister * ourselves atomically after detecting that deletion is possible to make * sure that we don't do that after another thread has done * VirtualBox::findHardDisk() but before it starts using us (provided that * it holds a mVirtualBox lock too of course). */ AutoWriteLock vboxLock(mVirtualBox); AutoWriteLock alock(this); if (!(m->formatObj->capabilities() & (MediumFormatCapabilities_CreateDynamic | MediumFormatCapabilities_CreateFixed))) return setError(VBOX_E_NOT_SUPPORTED, tr("Hard disk format '%ls' does not support storage deletion"), m->format.raw()); /* Note that we are fine with Inaccessible state too: a) for symmetry with * create calls and b) because it doesn't really harm to try, if it is * really inaccessibke, the delete operation will fail anyway. Accepting * Inaccessible state is especially important because all registered hard * disks are initially Inaccessible upon VBoxSVC startup until * COMGETTER(State) is called. */ switch (m->state) { case MediumState_Created: case MediumState_Inaccessible: break; default: return setStateError(); } if (m->backRefs.size() != 0) return setError(VBOX_E_OBJECT_IN_USE, tr("Hard disk '%ls' is attached to %d virtual machines"), m->locationFull.raw(), m->backRefs.size()); HRESULT rc = canClose(); CheckComRCReturnRC(rc); /* go to Deleting state before leaving the lock */ m->state = MediumState_Deleting; /* we need to leave this object's write lock now because of * unregisterWithVirtualBox() that locks treeLock() for writing */ alock.leave(); /* try to remove from the list of known hard disks before performing actual * deletion (we favor the consistency of the media registry in the first * place which would have been broken if unregisterWithVirtualBox() failed * after we successfully deleted the storage) */ rc = unregisterWithVirtualBox(); alock.enter(); /* restore the state because we may fail below; we will set it later again*/ m->state = MediumState_Created; CheckComRCReturnRC(rc); ComObjPtr progress; if (aProgress != NULL) { /* use the existing progress object... */ progress = *aProgress; /* ...but create a new one if it is null */ if (progress.isNull()) { progress.createObject(); rc = progress->init(mVirtualBox, static_cast(this), BstrFmt(tr("Deleting hard disk storage unit '%ls'"), m->locationFull.raw()), FALSE /* aCancelable */); CheckComRCReturnRC(rc); } } std::auto_ptr task(new Task(this, progress, Task::Delete)); AssertComRCReturnRC(task->autoCaller.rc()); if (aWait) { /* go to Deleting state before starting the task */ m->state = MediumState_Deleting; rc = task->runNow(); } else { rc = task->startThread(); CheckComRCReturnRC(rc); /* go to Deleting state before leaving the lock */ m->state = MediumState_Deleting; } /* task is now owned (or already deleted) by taskThread() so release it */ task.release(); if (aProgress != NULL) { /* return progress to the caller */ *aProgress = progress; } return rc; } /** * Creates a new differencing storage unit using the given target hard disk's * format and the location. Note that @c aTarget must be NotCreated. * * As opposed to the CreateDiffStorage() method, this method doesn't try to lock * this hard disk for reading assuming that the caller has already done so. This * is used when taking an online snaopshot (where all original hard disks are * locked for writing and must remain such). Note however that if @a aWait is * @c false and this method returns a success then the thread started by * this method will unlock the hard disk (unless it is in * MediumState_LockedWrite state) so make sure the hard disk is either in * MediumState_LockedWrite or call #LockRead() before calling this method! If @a * aWait is @c true then this method neither locks nor unlocks the hard disk, so * make sure you do it yourself as needed. * * If @a aProgress is not NULL but the object it points to is @c null then a new * progress object will be created and assigned to @a *aProgress on success, * otherwise the existing progress object is used. If @a aProgress is NULL, then no * progress object is created/used at all. * * When @a aWait is @c false, this method will create a thread to perform the * create operation asynchronously and will return immediately. Otherwise, it * will perform the operation on the calling thread and will not return to the * caller until the operation is completed. Note that @a aProgress cannot be * NULL when @a aWait is @c false (this method will assert in this case). * * @param aTarget Target hard disk. * @param aVariant Precise image variant to create. * @param aProgress Where to find/store a Progress object to track operation * completion. * @param aWait @c true if this method should block instead of creating * an asynchronous thread. * * @note Locks this object and @a aTarget for writing. */ HRESULT Medium::createDiffStorage(ComObjPtr &aTarget, MediumVariant_T aVariant, ComObjPtr *aProgress, bool aWait) { AssertReturn(!aTarget.isNull(), E_FAIL); AssertReturn(aProgress != NULL || aWait == true, E_FAIL); AutoCaller autoCaller(this); CheckComRCReturnRC(autoCaller.rc()); AutoCaller targetCaller(aTarget); CheckComRCReturnRC(targetCaller.rc()); AutoMultiWriteLock2 alock(this, aTarget); AssertReturn(m->type != MediumType_Writethrough, E_FAIL); /* Note: MediumState_LockedWrite is ok when taking an online snapshot */ AssertReturn(m->state == MediumState_LockedRead || m->state == MediumState_LockedWrite, E_FAIL); if (aTarget->m->state != MediumState_NotCreated) return aTarget->setStateError(); HRESULT rc = S_OK; /* check that the hard disk is not attached to any VM in the current state*/ for (BackRefList::const_iterator it = m->backRefs.begin(); it != m->backRefs.end(); ++ it) { if (it->inCurState) { /* Note: when a VM snapshot is being taken, all normal hard disks * attached to the VM in the current state will be, as an exception, * also associated with the snapshot which is about to create (see * SnapshotMachine::init()) before deassociating them from the * current state (which takes place only on success in * Machine::fixupHardDisks()), so that the size of snapshotIds * will be 1 in this case. The given condition is used to filter out * this legal situatinon and do not report an error. */ if (it->snapshotIds.size() == 0) { return setError(VBOX_E_INVALID_OBJECT_STATE, tr("Hard disk '%ls' is attached to a virtual machine with UUID {%RTuuid}. No differencing hard disks based on it may be created until it is detached"), m->locationFull.raw(), it->machineId.raw()); } Assert(it->snapshotIds.size() == 1); } } ComObjPtr progress; if (aProgress != NULL) { /* use the existing progress object... */ progress = *aProgress; /* ...but create a new one if it is null */ if (progress.isNull()) { progress.createObject(); rc = progress->init(mVirtualBox, static_cast(this), BstrFmt(tr("Creating differencing hard disk storage unit '%ls'"), aTarget->m->locationFull.raw()), TRUE /* aCancelable */); CheckComRCReturnRC(rc); } } /* setup task object and thread to carry out the operation * asynchronously */ std::auto_ptr task(new Task(this, progress, Task::CreateDiff)); AssertComRCReturnRC(task->autoCaller.rc()); task->setData(aTarget); task->d.variant = aVariant; /* register a task (it will deregister itself when done) */ ++m->numCreateDiffTasks; Assert(m->numCreateDiffTasks != 0); /* overflow? */ if (aWait) { /* go to Creating state before starting the task */ aTarget->m->state = MediumState_Creating; rc = task->runNow(); } else { rc = task->startThread(); CheckComRCReturnRC(rc); /* go to Creating state before leaving the lock */ aTarget->m->state = MediumState_Creating; } /* task is now owned (or already deleted) by taskThread() so release it */ task.release(); if (aProgress != NULL) { /* return progress to the caller */ *aProgress = progress; } return rc; } /** * Prepares this (source) hard disk, target hard disk and all intermediate hard * disks for the merge operation. * * This method is to be called prior to calling the #mergeTo() to perform * necessary consistency checks and place involved hard disks to appropriate * states. If #mergeTo() is not called or fails, the state modifications * performed by this method must be undone by #cancelMergeTo(). * * Note that when @a aIgnoreAttachments is @c true then it's the caller's * responsibility to detach the source and all intermediate hard disks before * calling #mergeTo() (which will fail otherwise). * * See #mergeTo() for more information about merging. * * @param aTarget Target hard disk. * @param aChain Where to store the created merge chain. * @param aIgnoreAttachments Don't check if the source or any intermediate * hard disk is attached to any VM. * * @note Locks treeLock() for reading. Locks this object, aTarget and all * intermediate hard disks for writing. */ HRESULT Medium::prepareMergeTo(Medium *aTarget, MergeChain * &aChain, bool aIgnoreAttachments /*= false*/) { AssertReturn(aTarget != NULL, E_FAIL); AutoCaller autoCaller(this); AssertComRCReturnRC(autoCaller.rc()); AutoCaller targetCaller(aTarget); AssertComRCReturnRC(targetCaller.rc()); aChain = NULL; /* we walk the tree */ AutoReadLock treeLock(this->treeLock()); HRESULT rc = S_OK; /* detect the merge direction */ bool forward; { Medium *parent = mParent; while (parent != NULL && parent != aTarget) parent = parent->mParent; if (parent == aTarget) forward = false; else { parent = aTarget->mParent; while (parent != NULL && parent != this) parent = parent->mParent; if (parent == this) forward = true; else { Bstr tgtLoc; { AutoReadLock alock(this); tgtLoc = aTarget->locationFull(); } AutoReadLock alock(this); return setError(E_FAIL, tr("Hard disks '%ls' and '%ls' are unrelated"), m->locationFull.raw(), tgtLoc.raw()); } } } /* build the chain (will do necessary checks and state changes) */ std::auto_ptr chain(new MergeChain(forward, aIgnoreAttachments)); { Medium *last = forward ? aTarget : this; Medium *first = forward ? this : aTarget; for (;;) { if (last == aTarget) rc = chain->addTarget(last); else if (last == this) rc = chain->addSource(last); else rc = chain->addIntermediate(last); CheckComRCReturnRC(rc); if (last == first) break; last = last->mParent; } } aChain = chain.release(); return S_OK; } /** * Merges this hard disk to the specified hard disk which must be either its * direct ancestor or descendant. * * Given this hard disk is SOURCE and the specified hard disk is TARGET, we will * get two varians of the merge operation: * * forward merge * -------------------------> * [Extra] <- SOURCE <- Intermediate <- TARGET * Any Del Del LockWr * * * backward merge * <------------------------- * TARGET <- Intermediate <- SOURCE <- [Extra] * LockWr Del Del LockWr * * Each scheme shows the involved hard disks on the hard disk chain where * SOURCE and TARGET belong. Under each hard disk there is a state value which * the hard disk must have at a time of the mergeTo() call. * * The hard disks in the square braces may be absent (e.g. when the forward * operation takes place and SOURCE is the base hard disk, or when the backward * merge operation takes place and TARGET is the last child in the chain) but if * they present they are involved too as shown. * * Nor the source hard disk neither intermediate hard disks may be attached to * any VM directly or in the snapshot, otherwise this method will assert. * * The #prepareMergeTo() method must be called prior to this method to place all * involved to necessary states and perform other consistency checks. * * If @a aWait is @c true then this method will perform the operation on the * calling thread and will not return to the caller until the operation is * completed. When this method succeeds, all intermediate hard disk objects in * the chain will be uninitialized, the state of the target hard disk (and all * involved extra hard disks) will be restored and @a aChain will be deleted. * Note that this (source) hard disk is not uninitialized because of possible * AutoCaller instances held by the caller of this method on the current thread. * It's therefore the responsibility of the caller to call Medium::uninit() * after releasing all callers in this case! * * If @a aWait is @c false then this method will crea,te a thread to perform the * create operation asynchronously and will return immediately. If the operation * succeeds, the thread will uninitialize the source hard disk object and all * intermediate hard disk objects in the chain, reset the state of the target * hard disk (and all involved extra hard disks) and delete @a aChain. If the * operation fails, the thread will only reset the states of all involved hard * disks and delete @a aChain. * * When this method fails (regardless of the @a aWait mode), it is a caller's * responsiblity to undo state changes and delete @a aChain using * #cancelMergeTo(). * * If @a aProgress is not NULL but the object it points to is @c null then a new * progress object will be created and assigned to @a *aProgress on success, * otherwise the existing progress object is used. If Progress is NULL, then no * progress object is created/used at all. Note that @a aProgress cannot be * NULL when @a aWait is @c false (this method will assert in this case). * * @param aChain Merge chain created by #prepareMergeTo(). * @param aProgress Where to find/store a Progress object to track operation * completion. * @param aWait @c true if this method should block instead of creating * an asynchronous thread. * * @note Locks the branch lock for writing. Locks the hard disks from the chain * for writing. */ HRESULT Medium::mergeTo(MergeChain *aChain, ComObjPtr *aProgress, bool aWait) { AssertReturn(aChain != NULL, E_FAIL); AssertReturn(aProgress != NULL || aWait == true, E_FAIL); AutoCaller autoCaller(this); CheckComRCReturnRC(autoCaller.rc()); HRESULT rc = S_OK; ComObjPtr progress; if (aProgress != NULL) { /* use the existing progress object... */ progress = *aProgress; /* ...but create a new one if it is null */ if (progress.isNull()) { AutoReadLock alock(this); progress.createObject(); rc = progress->init(mVirtualBox, static_cast(this), BstrFmt(tr("Merging hard disk '%s' to '%s'"), name().raw(), aChain->target()->name().raw()), TRUE /* aCancelable */); CheckComRCReturnRC(rc); } } /* setup task object and thread to carry out the operation * asynchronously */ std::auto_ptr task(new Task(this, progress, Task::Merge)); AssertComRCReturnRC(task->autoCaller.rc()); task->setData(aChain); /* Note: task owns aChain (will delete it when not needed) in all cases * except when @a aWait is @c true and runNow() fails -- in this case * aChain will be left away because cancelMergeTo() will be applied by the * caller on it as it is required in the documentation above */ if (aWait) { rc = task->runNow(); } else { rc = task->startThread(); CheckComRCReturnRC(rc); } /* task is now owned (or already deleted) by taskThread() so release it */ task.release(); if (aProgress != NULL) { /* return progress to the caller */ *aProgress = progress; } return rc; } /** * Undoes what #prepareMergeTo() did. Must be called if #mergeTo() is not called * or fails. Frees memory occupied by @a aChain. * * @param aChain Merge chain created by #prepareMergeTo(). * * @note Locks the hard disks from the chain for writing. */ void Medium::cancelMergeTo(MergeChain *aChain) { AutoCaller autoCaller(this); AssertComRCReturnVoid(autoCaller.rc()); AssertReturnVoid(aChain != NULL); /* the destructor will do the thing */ delete aChain; } /** * Initializes the image medium object by opening an image file at the specified * location. * * @param aVirtualBox Parent VirtualBox object. * @param aLocation Path to the image file (can be relative to the * VirtualBox home directory). * @param aId UUID of the image. */ HRESULT Medium::protectedInit(VirtualBox *aVirtualBox, CBSTR aLocation, const Guid &aId) { LogFlowThisFunc(("aLocation='%ls', aId={%RTuuid}\n", aLocation, aId.raw())); AssertReturn(aVirtualBox, E_INVALIDARG); AssertReturn(aLocation, E_INVALIDARG); AssertReturn(!aId.isEmpty(), E_INVALIDARG); /* Enclose the state transition NotReady->InInit->Ready */ AutoInitSpan autoInitSpan(this); AssertReturn(autoInitSpan.isOk(), E_FAIL); HRESULT rc = S_OK; /* share parent weakly */ unconst(mVirtualBox) = aVirtualBox; /* register with parent early, since uninit() will unconditionally * unregister on failure */ mVirtualBox->addDependentChild(this); /* there must be a storage unit */ m->state = MediumState_Created; unconst(m->id) = aId; rc = setLocation(aLocation); CheckComRCReturnRC(rc); LogFlowThisFunc(("m->locationFull='%ls'\n", m->locationFull.raw())); /* get all the information about the medium from the file */ rc = queryInfo(); if (SUCCEEDED(rc)) { /* if the image file is not accessible, it's not acceptable for the * newly opened media so convert this into an error */ if (!m->lastAccessError.isEmpty()) rc = setError(VBOX_E_FILE_ERROR, Utf8Str(m->lastAccessError).c_str()); } /* Confirm a successful initialization when it's the case */ if (SUCCEEDED(rc)) autoInitSpan.setSucceeded(); return rc; } /** * Initializes the image medium object by loading its data from the given * settings node. * * Note that it is assumed that this method is called only for registered media. * * @param aVirtualBox Parent VirtualBox object. * @param aImageNode Either or settings node. */ HRESULT Medium::protectedInit(VirtualBox *aVirtualBox, const settings::Medium &data) { AssertReturn(aVirtualBox, E_INVALIDARG); /* Enclose the state transition NotReady->InInit->Ready */ AutoInitSpan autoInitSpan(this); AssertReturn(autoInitSpan.isOk(), E_FAIL); HRESULT rc = S_OK; /* share parent weakly */ unconst(mVirtualBox) = aVirtualBox; /* register with parent early, since uninit() will unconditionally * unregister on failure */ mVirtualBox->addDependentChild(this); /* see below why we don't call queryInfo() (and therefore treat the medium * as inaccessible for now */ m->state = MediumState_Inaccessible; /* required */ unconst(m->id) = data.uuid; /* required */ rc = setLocation(data.strLocation); CheckComRCReturnRC(rc); m->description = data.strDescription; LogFlowThisFunc(("m->locationFull='%ls', m->id={%RTuuid}\n", m->locationFull.raw(), m->id.raw())); /* Don't call queryInfo() for registered media to prevent the calling * thread (i.e. the VirtualBox server startup thread) from an unexpected * freeze but mark it as initially inaccessible instead. The vital UUID and * location properties are read from the registry file above; to get the * actual state and the rest of the data, the user will have to call * COMGETTER(State).*/ /* Confirm a successful initialization when it's the case */ if (SUCCEEDED(rc)) autoInitSpan.setSucceeded(); return rc; } /** * Uninitializes the instance. * * Called either from FinalRelease() or by the parent when it gets destroyed. */ void Medium::protectedUninit() { LogFlowThisFunc(("\n")); /* Enclose the state transition Ready->InUninit->NotReady */ AutoUninitSpan autoUninitSpan(this); if (autoUninitSpan.uninitDone()) return; mVirtualBox->removeDependentChild(this); unconst(mVirtualBox).setNull(); } // private methods //////////////////////////////////////////////////////////////////////////////// /** * Checks that the format ID is valid and sets it on success. * * Note that this method will caller-reference the format object on success! * This reference must be released somewhere to let the MediumFormat object be * uninitialized. * * @note Must be called from under this object's write lock. */ HRESULT Medium::setFormat(CBSTR aFormat) { /* get the format object first */ { AutoReadLock propsLock(mVirtualBox->systemProperties()); unconst(m->formatObj) = mVirtualBox->systemProperties()->mediumFormat(aFormat); if (m->formatObj.isNull()) return setError(E_INVALIDARG, tr("Invalid hard disk storage format '%ls'"), aFormat); /* reference the format permanently to prevent its unexpected * uninitialization */ HRESULT rc = m->formatObj->addCaller(); AssertComRCReturnRC(rc); /* get properties (preinsert them as keys in the map). Note that the * map doesn't grow over the object life time since the set of * properties is meant to be constant. */ Assert(m->properties.empty()); for (MediumFormat::PropertyList::const_iterator it = m->formatObj->properties().begin(); it != m->formatObj->properties().end(); ++ it) { m->properties.insert(std::make_pair(it->name, Bstr::Null)); } } unconst(m->format) = aFormat; return S_OK; } /** * @note Called from this object's AutoMayUninitSpan and from under mVirtualBox * write lock. * * @note Also reused by Medium::Reset(). * * @note Locks treeLock() for reading. */ HRESULT Medium::canClose() { /* we access children */ AutoReadLock treeLock(this->treeLock()); if (children().size() != 0) return setError(E_FAIL, tr("Hard disk '%ls' has %d child hard disks"), children().size()); return S_OK; } /** * @note Called from within this object's AutoWriteLock. */ HRESULT Medium::canAttach(const Guid & /* aMachineId */, const Guid & /* aSnapshotId */) { if (m->numCreateDiffTasks > 0) return setError(E_FAIL, tr("One or more differencing child hard disks are being created for the hard disk '%ls' (%u)"), m->locationFull.raw(), m->numCreateDiffTasks); return S_OK; } /** * @note Called from within this object's AutoMayUninitSpan (or AutoCaller) and * from under mVirtualBox write lock. * * @note Locks treeLock() for writing. */ HRESULT Medium::unregisterWithVirtualBox() { /* Note that we need to de-associate ourselves from the parent to let * unregisterHardDisk() properly save the registry */ /* we modify mParent and access children */ AutoWriteLock treeLock(this->treeLock()); const ComObjPtr parent = mParent; AssertReturn(children().size() == 0, E_FAIL); if (!mParent.isNull()) { /* deassociate from the parent, associate with VirtualBox */ mVirtualBox->addDependentChild(this); mParent->removeDependentChild(this); mParent.setNull(); } HRESULT rc = mVirtualBox->unregisterHardDisk(this); if (FAILED(rc)) { if (!parent.isNull()) { /* re-associate with the parent as we are still relatives in the * registry */ mParent = parent; mParent->addDependentChild(this); mVirtualBox->removeDependentChild(this); } } return rc; } /** * Returns the last error message collected by the vdErrorCall callback and * resets it. * * The error message is returned prepended with a dot and a space, like this: * * ". (%Rrc)" * * to make it easily appendable to a more general error message. The @c %Rrc * format string is given @a aVRC as an argument. * * If there is no last error message collected by vdErrorCall or if it is a * null or empty string, then this function returns the following text: * * " (%Rrc)" * * * @note Doesn't do any object locking; it is assumed that the caller makes sure * the callback isn't called by more than one thread at a time. * * @param aVRC VBox error code to use when no error message is provided. */ Utf8Str Medium::vdError(int aVRC) { Utf8Str error; if (m->vdError.isEmpty()) error = Utf8StrFmt(" (%Rrc)", aVRC); else error = Utf8StrFmt(".\n%s", m->vdError.raw()); m->vdError.setNull(); return error; } /** * Error message callback. * * Puts the reported error message to the m->vdError field. * * @note Doesn't do any object locking; it is assumed that the caller makes sure * the callback isn't called by more than one thread at a time. * * @param pvUser The opaque data passed on container creation. * @param rc The VBox error code. * @param RT_SRC_POS_DECL Use RT_SRC_POS. * @param pszFormat Error message format string. * @param va Error message arguments. */ /*static*/ DECLCALLBACK(void) Medium::vdErrorCall(void *pvUser, int rc, RT_SRC_POS_DECL, const char *pszFormat, va_list va) { NOREF(pszFile); NOREF(iLine); NOREF(pszFunction); /* RT_SRC_POS_DECL */ Medium *that = static_cast(pvUser); AssertReturnVoid(that != NULL); if (that->m->vdError.isEmpty()) that->m->vdError = Utf8StrFmt("%s (%Rrc)", Utf8StrFmtVA(pszFormat, va).raw(), rc); else that->m->vdError = Utf8StrFmt("%s.\n%s (%Rrc)", that->m->vdError.raw(), Utf8StrFmtVA(pszFormat, va).raw(), rc); } /** * PFNVMPROGRESS callback handler for Task operations. * * @param uPercent Completetion precentage (0-100). * @param pvUser Pointer to the Progress instance. */ /*static*/ DECLCALLBACK(int) Medium::vdProgressCall(PVM /* pVM */, unsigned uPercent, void *pvUser) { Medium *that = static_cast(pvUser); AssertReturn(that != NULL, VERR_GENERAL_FAILURE); if (that->m->vdProgress != NULL) { /* update the progress object, capping it at 99% as the final percent * is used for additional operations like setting the UUIDs and similar. */ HRESULT rc = that->m->vdProgress->SetCurrentOperationProgress(uPercent * 99 / 100); if (FAILED(rc)) { if (rc == E_FAIL) return VERR_CANCELLED; else return VERR_INVALID_STATE; } } return VINF_SUCCESS; } /* static */ DECLCALLBACK(bool) Medium::vdConfigAreKeysValid(void *pvUser, const char * /* pszzValid */) { Medium *that = static_cast(pvUser); AssertReturn(that != NULL, false); /* we always return true since the only keys we have are those found in * VDBACKENDINFO */ return true; } /* static */ DECLCALLBACK(int) Medium::vdConfigQuerySize(void *pvUser, const char *pszName, size_t *pcbValue) { AssertReturn(VALID_PTR(pcbValue), VERR_INVALID_POINTER); Medium *that = static_cast(pvUser); AssertReturn(that != NULL, VERR_GENERAL_FAILURE); Data::PropertyMap::const_iterator it = that->m->properties.find(Bstr(pszName)); if (it == that->m->properties.end()) return VERR_CFGM_VALUE_NOT_FOUND; /* we interpret null values as "no value" in Medium */ if (it->second.isNull()) return VERR_CFGM_VALUE_NOT_FOUND; *pcbValue = it->second.length() + 1 /* include terminator */; return VINF_SUCCESS; } /* static */ DECLCALLBACK(int) Medium::vdConfigQuery(void *pvUser, const char *pszName, char *pszValue, size_t cchValue) { AssertReturn(VALID_PTR(pszValue), VERR_INVALID_POINTER); Medium *that = static_cast(pvUser); AssertReturn(that != NULL, VERR_GENERAL_FAILURE); Data::PropertyMap::const_iterator it = that->m->properties.find(Bstr(pszName)); if (it == that->m->properties.end()) return VERR_CFGM_VALUE_NOT_FOUND; Utf8Str value = it->second; if (value.length() >= cchValue) return VERR_CFGM_NOT_ENOUGH_SPACE; /* we interpret null values as "no value" in Medium */ if (it->second.isNull()) return VERR_CFGM_VALUE_NOT_FOUND; memcpy(pszValue, value.c_str(), value.length() + 1); return VINF_SUCCESS; } /** * Thread function for time-consuming tasks. * * The Task structure passed to @a pvUser must be allocated using new and will * be freed by this method before it returns. * * @param pvUser Pointer to the Task instance. */ /* static */ DECLCALLBACK(int) Medium::taskThread(RTTHREAD thread, void *pvUser) { std::auto_ptr task(static_cast (pvUser)); AssertReturn(task.get(), VERR_GENERAL_FAILURE); bool isAsync = thread != NIL_RTTHREAD; Medium *that = task->that; /// @todo ugly hack, fix ComAssert... later #define setError that->setError /* Note: no need in AutoCaller because Task does that */ LogFlowFuncEnter(); LogFlowFunc(("{%p}: operation=%d\n", that, task->operation)); HRESULT rc = S_OK; switch (task->operation) { //////////////////////////////////////////////////////////////////////// case Task::CreateBase: { /* The lock is also used as a signal from the task initiator (which * releases it only after RTThreadCreate()) that we can start the job */ AutoWriteLock thatLock(that); /* these parameters we need after creation */ uint64_t size = 0, logicalSize = 0; /* The object may request a specific UUID (through a special form of * the setLocation() argument). Otherwise we have to generate it */ Guid id = that->m->id; bool generateUuid = id.isEmpty(); if (generateUuid) { id.create(); /* VirtualBox::registerHardDisk() will need UUID */ unconst(that->m->id) = id; } try { PVBOXHDD hdd; int vrc = VDCreate(that->m->vdDiskIfaces, &hdd); ComAssertRCThrow(vrc, E_FAIL); Utf8Str format(that->m->format); Utf8Str location(that->m->locationFull); /* uint64_t capabilities = */ that->m->formatObj->capabilities(); /* unlock before the potentially lengthy operation */ Assert(that->m->state == MediumState_Creating); thatLock.leave(); try { /* ensure the directory exists */ rc = VirtualBox::ensureFilePathExists(location); CheckComRCThrowRC(rc); PDMMEDIAGEOMETRY geo = { 0 }; /* auto-detect */ /* needed for vdProgressCallback */ that->m->vdProgress = task->progress; vrc = VDCreateBase(hdd, format.c_str(), location.c_str(), task->d.size * _1M, task->d.variant, NULL, &geo, &geo, id.raw(), VD_OPEN_FLAGS_NORMAL, NULL, that->m->vdDiskIfaces); if (RT_FAILURE(vrc)) { throw setError(E_FAIL, tr("Could not create the hard disk storage unit '%s'%s"), location.raw(), that->vdError(vrc).raw()); } size = VDGetFileSize(hdd, 0); logicalSize = VDGetSize(hdd, 0) / _1M; } catch (HRESULT aRC) { rc = aRC; } VDDestroy(hdd); } catch (HRESULT aRC) { rc = aRC; } if (SUCCEEDED(rc)) { /* register with mVirtualBox as the last step and move to * Created state only on success (leaving an orphan file is * better than breaking media registry consistency) */ rc = that->mVirtualBox->registerHardDisk(that); } thatLock.maybeEnter(); if (SUCCEEDED(rc)) { that->m->state = MediumState_Created; that->m->size = size; that->m->logicalSize = logicalSize; } else { /* back to NotCreated on failure */ that->m->state = MediumState_NotCreated; /* reset UUID to prevent it from being reused next time */ if (generateUuid) unconst(that->m->id).clear(); } break; } //////////////////////////////////////////////////////////////////////// case Task::CreateDiff: { ComObjPtr &target = task->d.target; /* Lock both in {parent,child} order. The lock is also used as a * signal from the task initiator (which releases it only after * RTThreadCreate()) that we can start the job*/ AutoMultiWriteLock2 thatLock(that, target); uint64_t size = 0, logicalSize = 0; /* The object may request a specific UUID (through a special form of * the setLocation() argument). Otherwise we have to generate it */ Guid targetId = target->m->id; bool generateUuid = targetId.isEmpty(); if (generateUuid) { targetId.create(); /* VirtualBox::registerHardDisk() will need UUID */ unconst(target->m->id) = targetId; } try { PVBOXHDD hdd; int vrc = VDCreate(that->m->vdDiskIfaces, &hdd); ComAssertRCThrow(vrc, E_FAIL); Guid id = that->m->id; Utf8Str format(that->m->format); Utf8Str location(that->m->locationFull); Utf8Str targetFormat(target->m->format); Utf8Str targetLocation(target->m->locationFull); Assert(target->m->state == MediumState_Creating); /* Note: MediumState_LockedWrite is ok when taking an online * snapshot */ Assert(that->m->state == MediumState_LockedRead || that->m->state == MediumState_LockedWrite); /* unlock before the potentially lengthy operation */ thatLock.leave(); try { vrc = VDOpen(hdd, format.c_str(), location.c_str(), VD_OPEN_FLAGS_READONLY | VD_OPEN_FLAGS_INFO, that->m->vdDiskIfaces); if (RT_FAILURE(vrc)) { throw setError(E_FAIL, tr("Could not open the hard disk storage unit '%s'%s"), location.raw(), that->vdError(vrc).raw()); } /* ensure the target directory exists */ rc = VirtualBox::ensureFilePathExists(targetLocation); CheckComRCThrowRC(rc); /* needed for vdProgressCallback */ that->m->vdProgress = task->progress; /** @todo add VD_IMAGE_FLAGS_DIFF to the image flags, to * be on the safe side. */ vrc = VDCreateDiff(hdd, targetFormat.c_str(), targetLocation.c_str(), task->d.variant, NULL, targetId.raw(), id.raw(), VD_OPEN_FLAGS_NORMAL, target->m->vdDiskIfaces, that->m->vdDiskIfaces); that->m->vdProgress = NULL; if (RT_FAILURE(vrc)) { throw setError(E_FAIL, tr("Could not create the differencing hard disk storage unit '%s'%s"), targetLocation.raw(), that->vdError(vrc).raw()); } size = VDGetFileSize(hdd, 1); logicalSize = VDGetSize(hdd, 1) / _1M; } catch (HRESULT aRC) { rc = aRC; } VDDestroy(hdd); } catch (HRESULT aRC) { rc = aRC; } if (SUCCEEDED(rc)) { /* we set mParent & children() (note that thatLock is released * here), but lock VirtualBox first to follow the rule */ AutoMultiWriteLock2 alock(that->mVirtualBox->lockHandle(), that->treeLock()); Assert(target->mParent.isNull()); /* associate the child with the parent and deassociate from * VirtualBox */ target->mParent = that; that->addDependentChild(target); target->mVirtualBox->removeDependentChild(target); /* diffs for immutable hard disks are auto-reset by default */ target->m->autoReset = that->base()->m->type == MediumType_Immutable ? TRUE : FALSE; /* register with mVirtualBox as the last step and move to * Created state only on success (leaving an orphan file is * better than breaking media registry consistency) */ rc = that->mVirtualBox->registerHardDisk(target); if (FAILED(rc)) { /* break the parent association on failure to register */ target->mVirtualBox->addDependentChild(target); that->removeDependentChild(target); target->mParent.setNull(); } } thatLock.maybeEnter(); if (SUCCEEDED(rc)) { target->m->state = MediumState_Created; target->m->size = size; target->m->logicalSize = logicalSize; } else { /* back to NotCreated on failure */ target->m->state = MediumState_NotCreated; target->m->autoReset = FALSE; /* reset UUID to prevent it from being reused next time */ if (generateUuid) unconst(target->m->id).clear(); } if (isAsync) { /* unlock ourselves when done (unless in MediumState_LockedWrite * state because of taking the online snapshot*/ if (that->m->state != MediumState_LockedWrite) { HRESULT rc2 = that->UnlockRead(NULL); AssertComRC(rc2); } } /* deregister the task registered in createDiffStorage() */ Assert(that->m->numCreateDiffTasks != 0); --that->m->numCreateDiffTasks; /* Note that in sync mode, it's the caller's responsibility to * unlock the hard disk */ break; } //////////////////////////////////////////////////////////////////////// case Task::Merge: { /* The lock is also used as a signal from the task initiator (which * releases it only after RTThreadCreate()) that we can start the * job. We don't actually need the lock for anything else since the * object is protected by MediumState_Deleting and we don't modify * its sensitive fields below */ { AutoWriteLock thatLock(that); } MergeChain *chain = task->d.chain.get(); #if 0 LogFlow(("*** MERGE forward = %RTbool\n", chain->isForward())); #endif try { PVBOXHDD hdd; int vrc = VDCreate(that->m->vdDiskIfaces, &hdd); ComAssertRCThrow(vrc, E_FAIL); try { /* Open all hard disks in the chain (they are in the * {parent,child} order in there. Note that we don't lock * objects in this chain since they must be in states * (Deleting and LockedWrite) that prevent from changing * their format and location fields from outside. */ for (MergeChain::const_iterator it = chain->begin(); it != chain->end(); ++ it) { /* complex sanity (sane complexity) */ Assert((chain->isForward() && ((*it != chain->back() && (*it)->m->state == MediumState_Deleting) || (*it == chain->back() && (*it)->m->state == MediumState_LockedWrite))) || (!chain->isForward() && ((*it != chain->front() && (*it)->m->state == MediumState_Deleting) || (*it == chain->front() && (*it)->m->state == MediumState_LockedWrite)))); Assert(*it == chain->target() || (*it)->m->backRefs.size() == 0); /* open the first image with VDOPEN_FLAGS_INFO because * it's not necessarily the base one */ vrc = VDOpen(hdd, Utf8Str((*it)->m->format).c_str(), Utf8Str((*it)->m->locationFull).c_str(), it == chain->begin() ? VD_OPEN_FLAGS_INFO : 0, (*it)->m->vdDiskIfaces); if (RT_FAILURE(vrc)) throw vrc; #if 0 LogFlow(("*** MERGE disk = %ls\n", (*it)->m->locationFull.raw())); #endif } /* needed for vdProgressCallback */ that->m->vdProgress = task->progress; unsigned start = chain->isForward() ? 0 : (unsigned)chain->size() - 1; unsigned end = chain->isForward() ? (unsigned)chain->size() - 1 : 0; #if 0 LogFlow(("*** MERGE from %d to %d\n", start, end)); #endif vrc = VDMerge(hdd, start, end, that->m->vdDiskIfaces); that->m->vdProgress = NULL; if (RT_FAILURE(vrc)) throw vrc; /* update parent UUIDs */ /// @todo VDMerge should be taught to do so, including the /// multiple children case if (chain->isForward()) { /* target's UUID needs to be updated (note that target * is the only image in the container on success) */ vrc = VDSetParentUuid(hdd, 0, chain->parent()->m->id); if (RT_FAILURE(vrc)) throw vrc; } else { /* we need to update UUIDs of all source's children * which cannot be part of the container at once so * add each one in there individually */ if (chain->children().size() > 0) { for (List::const_iterator it = chain->children().begin(); it != chain->children().end(); ++ it) { /* VD_OPEN_FLAGS_INFO since UUID is wrong yet */ vrc = VDOpen(hdd, Utf8Str((*it)->m->format).c_str(), Utf8Str((*it)->m->locationFull).c_str(), VD_OPEN_FLAGS_INFO, (*it)->m->vdDiskIfaces); if (RT_FAILURE(vrc)) throw vrc; vrc = VDSetParentUuid(hdd, 1, chain->target()->m->id); if (RT_FAILURE(vrc)) throw vrc; vrc = VDClose(hdd, false /* fDelete */); if (RT_FAILURE(vrc)) throw vrc; } } } } catch (HRESULT aRC) { rc = aRC; } catch (int aVRC) { throw setError(E_FAIL, tr("Could not merge the hard disk '%ls' to '%ls'%s"), chain->source()->m->locationFull.raw(), chain->target()->m->locationFull.raw(), that->vdError(aVRC).raw()); } VDDestroy(hdd); } catch (HRESULT aRC) { rc = aRC; } HRESULT rc2; bool saveSettingsFailed = false; if (SUCCEEDED(rc)) { /* all hard disks but the target were successfully deleted by * VDMerge; reparent the last one and uninitialize deleted */ /* we set mParent & children() (note that thatLock is released * here), but lock VirtualBox first to follow the rule */ AutoMultiWriteLock2 alock(that->mVirtualBox->lockHandle(), that->treeLock()); Medium *source = chain->source(); Medium *target = chain->target(); if (chain->isForward()) { /* first, unregister the target since it may become a base * hard disk which needs re-registration */ rc2 = target->mVirtualBox-> unregisterHardDisk(target, false /* aSaveSettings */); AssertComRC(rc2); /* then, reparent it and disconnect the deleted branch at * both ends (chain->parent() is source's parent) */ target->mParent->removeDependentChild(target); target->mParent = chain->parent(); if (!target->mParent.isNull()) { target->mParent->addDependentChild(target); target->mParent->removeDependentChild(source); source->mParent.setNull(); } else { target->mVirtualBox->addDependentChild(target); target->mVirtualBox->removeDependentChild(source); } /* then, register again */ rc2 = target->mVirtualBox-> registerHardDisk(target, false /* aSaveSettings */); AssertComRC(rc2); } else { Assert(target->children().size() == 1); Medium *targetChild = target->children().front(); /* disconnect the deleted branch at the elder end */ target->removeDependentChild(targetChild); targetChild->mParent.setNull(); const List &children = chain->children(); /* reparent source's chidren and disconnect the deleted * branch at the younger end m*/ if (children.size() > 0) { /* obey {parent,child} lock order */ AutoWriteLock sourceLock(source); for (List::const_iterator it = children.begin(); it != children.end(); ++ it) { AutoWriteLock childLock(*it); (*it)->mParent = target; (*it)->mParent->addDependentChild(*it); source->removeDependentChild(*it); } } } /* try to save the hard disk registry */ rc = that->mVirtualBox->saveSettings(); if (SUCCEEDED(rc)) { /* unregister and uninitialize all hard disks in the chain * but the target */ for (MergeChain::iterator it = chain->begin(); it != chain->end();) { if (*it == chain->target()) { ++ it; continue; } rc2 = (*it)->mVirtualBox-> unregisterHardDisk(*it, false /* aSaveSettings */); AssertComRC(rc2); /* now, uninitialize the deleted hard disk (note that * due to the Deleting state, uninit() will not touch * the parent-child relationship so we need to * uninitialize each disk individually) */ /* note that the operation initiator hard disk (which is * normally also the source hard disk) is a special case * -- there is one more caller added by Task to it which * we must release. Also, if we are in sync mode, the * caller may still hold an AutoCaller instance for it * and therefore we cannot uninit() it (it's therefore * the caller's responsibility) */ if (*it == that) task->autoCaller.release(); /* release the caller added by MergeChain before * uninit() */ (*it)->releaseCaller(); if (isAsync || *it != that) (*it)->uninit(); /* delete (to prevent uninitialization in MergeChain * dtor) and advance to the next item */ it = chain->erase(it); } /* Note that states of all other hard disks (target, parent, * children) will be restored by the MergeChain dtor */ } else { /* too bad if we fail, but we'll need to rollback everything * we did above to at least keep the HD tree in sync with * the current registry on disk */ saveSettingsFailed = true; /// @todo NEWMEDIA implement a proper undo AssertFailed(); } } if (FAILED(rc)) { /* Here we come if either VDMerge() failed (in which case we * assume that it tried to do everything to make a further * retry possible -- e.g. not deleted intermediate hard disks * and so on) or VirtualBox::saveSettings() failed (where we * should have the original tree but with intermediate storage * units deleted by VDMerge()). We have to only restore states * (through the MergeChain dtor) unless we are run synchronously * in which case it's the responsibility of the caller as stated * in the mergeTo() docs. The latter also implies that we * don't own the merge chain, so release it in this case. */ if (!isAsync) task->d.chain.release(); NOREF(saveSettingsFailed); } break; } //////////////////////////////////////////////////////////////////////// case Task::Clone: { ComObjPtr &target = task->d.target; ComObjPtr &parent = task->d.parentDisk; /* Lock all in {parent,child} order. The lock is also used as a * signal from the task initiator (which releases it only after * RTThreadCreate()) that we can start the job. */ AutoMultiWriteLock3 thatLock(that, target, parent); ImageChain *srcChain = task->d.source.get(); ImageChain *parentChain = task->d.parent.get(); uint64_t size = 0, logicalSize = 0; /* The object may request a specific UUID (through a special form of * the setLocation() argument). Otherwise we have to generate it */ Guid targetId = target->m->id; bool generateUuid = targetId.isEmpty(); if (generateUuid) { targetId.create(); /* VirtualBox::registerHardDisk() will need UUID */ unconst(target->m->id) = targetId; } try { PVBOXHDD hdd; int vrc = VDCreate(that->m->vdDiskIfaces, &hdd); ComAssertRCThrow(vrc, E_FAIL); try { /* Open all hard disk images in the source chain. */ for (List::const_iterator it = srcChain->begin(); it != srcChain->end(); ++ it) { /* sanity check */ Assert((*it)->m->state == MediumState_LockedRead); /** Open all images in read-only mode. */ vrc = VDOpen(hdd, Utf8Str((*it)->m->format).c_str(), Utf8Str((*it)->m->locationFull).c_str(), VD_OPEN_FLAGS_READONLY, (*it)->m->vdDiskIfaces); if (RT_FAILURE(vrc)) { throw setError(E_FAIL, tr("Could not open the hard disk storage unit '%s'%s"), Utf8Str((*it)->m->locationFull).raw(), that->vdError(vrc).raw()); } } /* unlock before the potentially lengthy operation */ thatLock.leave(); Utf8Str targetFormat(target->m->format); Utf8Str targetLocation(target->m->locationFull); Assert( target->m->state == MediumState_Creating || target->m->state == MediumState_LockedWrite); Assert(that->m->state == MediumState_LockedRead); Assert(parent.isNull() || parent->m->state == MediumState_LockedRead); /* ensure the target directory exists */ rc = VirtualBox::ensureFilePathExists(targetLocation); CheckComRCThrowRC(rc); /* needed for vdProgressCallback */ that->m->vdProgress = task->progress; PVBOXHDD targetHdd; int vrc = VDCreate(that->m->vdDiskIfaces, &targetHdd); ComAssertRCThrow(vrc, E_FAIL); try { /* Open all hard disk images in the parent chain. */ for (List::const_iterator it = parentChain->begin(); it != parentChain->end(); ++ it) { /* sanity check */ Assert( (*it)->m->state == MediumState_LockedRead || (*it)->m->state == MediumState_LockedWrite); /* Open all images in appropriate mode. */ vrc = VDOpen(targetHdd, Utf8Str((*it)->m->format).c_str(), Utf8Str((*it)->m->locationFull).c_str(), ((*it)->m->state == MediumState_LockedWrite) ? VD_OPEN_FLAGS_NORMAL : VD_OPEN_FLAGS_READONLY, (*it)->m->vdDiskIfaces); if (RT_FAILURE(vrc)) { throw setError(E_FAIL, tr("Could not open the hard disk storage unit '%s'%s"), Utf8Str((*it)->m->locationFull).raw(), that->vdError(vrc).raw()); } } vrc = VDCopy(hdd, VD_LAST_IMAGE, targetHdd, targetFormat.c_str(), target->m->state == MediumState_Creating ? targetLocation.raw() : (char *)NULL, false, 0, task->d.variant, targetId.raw(), NULL, target->m->vdDiskIfaces, that->m->vdDiskIfaces); that->m->vdProgress = NULL; if (RT_FAILURE(vrc)) { throw setError(E_FAIL, tr("Could not create the clone hard disk '%s'%s"), targetLocation.raw(), that->vdError(vrc).raw()); } size = VDGetFileSize(targetHdd, 0); logicalSize = VDGetSize(targetHdd, 0) / _1M; } catch (HRESULT aRC) { rc = aRC; } VDDestroy(targetHdd); } catch (HRESULT aRC) { rc = aRC; } VDDestroy(hdd); } catch (HRESULT aRC) { rc = aRC; } /* Only do the parent changes for newly created images. */ if (target->m->state == MediumState_Creating) { if (SUCCEEDED(rc)) { /* we set mParent & children() (note that thatLock is released * here), but lock VirtualBox first to follow the rule */ AutoMultiWriteLock2 alock(that->mVirtualBox->lockHandle(), that->treeLock()); Assert(target->mParent.isNull()); if (parent) { /* associate the clone with the parent and deassociate * from VirtualBox */ target->mParent = parent; parent->addDependentChild(target); target->mVirtualBox->removeDependentChild(target); /* register with mVirtualBox as the last step and move to * Created state only on success (leaving an orphan file is * better than breaking media registry consistency) */ rc = parent->mVirtualBox->registerHardDisk(target); if (FAILED(rc)) { /* break parent association on failure to register */ target->mVirtualBox->addDependentChild(target); parent->removeDependentChild(target); target->mParent.setNull(); } } else { /* just register */ rc = that->mVirtualBox->registerHardDisk(target); } } } thatLock.maybeEnter(); if (target->m->state == MediumState_Creating) { if (SUCCEEDED(rc)) { target->m->state = MediumState_Created; target->m->size = size; target->m->logicalSize = logicalSize; } else { /* back to NotCreated on failure */ target->m->state = MediumState_NotCreated; /* reset UUID to prevent it from being reused next time */ if (generateUuid) unconst(target->m->id).clear(); } } /* Everything is explicitly unlocked when the task exits, * as the task destruction also destroys the source chain. */ /* Make sure the source chain is released early. It could happen * that we get a deadlock in Appliance::Import when Medium::Close * is called & the source chain is released at the same time. */ task->d.source.reset(); break; } //////////////////////////////////////////////////////////////////////// case Task::Delete: { /* The lock is also used as a signal from the task initiator (which * releases it only after RTThreadCreate()) that we can start the job */ AutoWriteLock thatLock(that); try { PVBOXHDD hdd; int vrc = VDCreate(that->m->vdDiskIfaces, &hdd); ComAssertRCThrow(vrc, E_FAIL); Utf8Str format(that->m->format); Utf8Str location(that->m->locationFull); /* unlock before the potentially lengthy operation */ Assert(that->m->state == MediumState_Deleting); thatLock.leave(); try { vrc = VDOpen(hdd, format.c_str(), location.c_str(), VD_OPEN_FLAGS_READONLY | VD_OPEN_FLAGS_INFO, that->m->vdDiskIfaces); if (RT_SUCCESS(vrc)) vrc = VDClose(hdd, true /* fDelete */); if (RT_FAILURE(vrc)) { throw setError(E_FAIL, tr("Could not delete the hard disk storage unit '%s'%s"), location.raw(), that->vdError(vrc).raw()); } } catch (HRESULT aRC) { rc = aRC; } VDDestroy(hdd); } catch (HRESULT aRC) { rc = aRC; } thatLock.maybeEnter(); /* go to the NotCreated state even on failure since the storage * may have been already partially deleted and cannot be used any * more. One will be able to manually re-open the storage if really * needed to re-register it. */ that->m->state = MediumState_NotCreated; /* Reset UUID to prevent Create* from reusing it again */ unconst(that->m->id).clear(); break; } case Task::Reset: { /* The lock is also used as a signal from the task initiator (which * releases it only after RTThreadCreate()) that we can start the job */ AutoWriteLock thatLock(that); /// @todo Below we use a pair of delete/create operations to reset /// the diff contents but the most efficient way will of course be /// to add a VDResetDiff() API call uint64_t size = 0, logicalSize = 0; try { PVBOXHDD hdd; int vrc = VDCreate(that->m->vdDiskIfaces, &hdd); ComAssertRCThrow(vrc, E_FAIL); Guid id = that->m->id; Utf8Str format(that->m->format); Utf8Str location(that->m->locationFull); Guid parentId = that->mParent->m->id; Utf8Str parentFormat(that->mParent->m->format); Utf8Str parentLocation(that->mParent->m->locationFull); Assert(that->m->state == MediumState_LockedWrite); /* unlock before the potentially lengthy operation */ thatLock.leave(); try { /* first, delete the storage unit */ vrc = VDOpen(hdd, format.c_str(), location.c_str(), VD_OPEN_FLAGS_READONLY | VD_OPEN_FLAGS_INFO, that->m->vdDiskIfaces); if (RT_SUCCESS(vrc)) vrc = VDClose(hdd, true /* fDelete */); if (RT_FAILURE(vrc)) { throw setError(E_FAIL, tr("Could not delete the hard disk storage unit '%s'%s"), location.raw(), that->vdError(vrc).raw()); } /* next, create it again */ vrc = VDOpen(hdd, parentFormat.c_str(), parentLocation.c_str(), VD_OPEN_FLAGS_READONLY | VD_OPEN_FLAGS_INFO, that->m->vdDiskIfaces); if (RT_FAILURE(vrc)) { throw setError(E_FAIL, tr("Could not open the hard disk storage unit '%s'%s"), parentLocation.raw(), that->vdError(vrc).raw()); } /* needed for vdProgressCallback */ that->m->vdProgress = task->progress; vrc = VDCreateDiff(hdd, format.c_str(), location.c_str(), /// @todo use the same image variant as before VD_IMAGE_FLAGS_NONE, NULL, id.raw(), parentId.raw(), VD_OPEN_FLAGS_NORMAL, that->m->vdDiskIfaces, that->m->vdDiskIfaces); that->m->vdProgress = NULL; if (RT_FAILURE(vrc)) { throw setError(E_FAIL, tr("Could not create the differencing hard disk storage unit '%s'%s"), location.raw(), that->vdError(vrc).raw()); } size = VDGetFileSize(hdd, 1); logicalSize = VDGetSize(hdd, 1) / _1M; } catch (HRESULT aRC) { rc = aRC; } VDDestroy(hdd); } catch (HRESULT aRC) { rc = aRC; } thatLock.enter(); that->m->size = size; that->m->logicalSize = logicalSize; if (isAsync) { /* unlock ourselves when done */ HRESULT rc2 = that->UnlockWrite(NULL); AssertComRC(rc2); } /* Note that in sync mode, it's the caller's responsibility to * unlock the hard disk */ break; } //////////////////////////////////////////////////////////////////////// case Task::Compact: { /* Lock all in {parent,child} order. The lock is also used as a * signal from the task initiator (which releases it only after * RTThreadCreate()) that we can start the job. */ AutoWriteLock thatLock(that); ImageChain *imgChain = task->d.images.get(); try { PVBOXHDD hdd; int vrc = VDCreate(that->m->vdDiskIfaces, &hdd); ComAssertRCThrow(vrc, E_FAIL); try { /* Open all hard disk images in the chain. */ List::const_iterator last = imgChain->end(); last--; for (List::const_iterator it = imgChain->begin(); it != imgChain->end(); ++ it) { /* sanity check */ if (it == last) Assert((*it)->m->state == MediumState_LockedWrite); else Assert((*it)->m->state == MediumState_LockedRead); /** Open all images but last in read-only mode. */ vrc = VDOpen(hdd, Utf8Str((*it)->m->format).c_str(), Utf8Str((*it)->m->locationFull).c_str(), (it == last) ? VD_OPEN_FLAGS_NORMAL : VD_OPEN_FLAGS_READONLY, (*it)->m->vdDiskIfaces); if (RT_FAILURE(vrc)) { throw setError(E_FAIL, tr("Could not open the hard disk storage unit '%s'%s"), Utf8Str((*it)->m->locationFull).raw(), that->vdError(vrc).raw()); } } /* unlock before the potentially lengthy operation */ thatLock.leave(); Assert(that->m->state == MediumState_LockedWrite); /* needed for vdProgressCallback */ that->m->vdProgress = task->progress; vrc = VDCompact(hdd, VD_LAST_IMAGE, that->m->vdDiskIfaces); that->m->vdProgress = NULL; if (RT_FAILURE(vrc)) { if (vrc == VERR_NOT_SUPPORTED) throw setError(VBOX_E_NOT_SUPPORTED, tr("Compacting is not supported yet for hard disk '%s'"), Utf8Str(that->m->locationFull).raw()); else if (vrc == VERR_NOT_IMPLEMENTED) throw setError(E_NOTIMPL, tr("Compacting is not implemented, hard disk '%s'"), Utf8Str(that->m->locationFull).raw()); else throw setError(E_FAIL, tr("Could not compact hard disk '%s'%s"), Utf8Str(that->m->locationFull).raw(), that->vdError(vrc).raw()); } } catch (HRESULT aRC) { rc = aRC; } VDDestroy(hdd); } catch (HRESULT aRC) { rc = aRC; } /* Everything is explicitly unlocked when the task exits, * as the task destruction also destroys the image chain. */ break; } default: AssertFailedReturn(VERR_GENERAL_FAILURE); } /* complete the progress if run asynchronously */ if (isAsync) { if (!task->progress.isNull()) task->progress->notifyComplete(rc); } else { task->rc = rc; } LogFlowFunc(("rc=%Rhrc\n", rc)); LogFlowFuncLeave(); return VINF_SUCCESS; /// @todo ugly hack, fix ComAssert... later #undef setError } /* vi: set tabstop=4 shiftwidth=4 expandtab: */