#include "MachineImplCloneVM.h"

#include "VirtualBoxImpl.h"

#include "MediumImpl.h"

#include "HostImpl.h"

#include <iprt/path.h>

#include <iprt/dir.h>

#include <iprt/cpp/utils.h>

#ifdef DEBUG_poetzsch

# include <iprt/stream.h>

#endif

#include <VBox/com/list.h>

#include <VBox/com/MultiResult.h>

typedef struct

{

Utf8Str strBaseName;

ComPtr<IMedium> pMedium;

uint32_t uIdx;

ULONG uWeight;

} MEDIUMTASK;

typedef struct

{

RTCList<MEDIUMTASK> chain;

bool fCreateDiffs;

bool fAttachLinked;

} MEDIUMTASKCHAIN;

typedef struct

{

Guid snapshotUuid;

Utf8Str strSaveStateFile;

ULONG uWeight;

} SAVESTATETASK;

struct MachineCloneVMPrivate

{

MachineCloneVMPrivate(MachineCloneVM *a_q, ComObjPtr<Machine> &a_pSrcMachine, ComObjPtr<Machine> &a_pTrgMachine, CloneMode_T a_mode, const RTCList<CloneOptions_T> &opts)

: q_ptr(a_q)

, p(a_pSrcMachine)

, pSrcMachine(a_pSrcMachine)

, pTrgMachine(a_pTrgMachine)

, mode(a_mode)

, options(opts)

{}

/* Thread management */

int startWorker()

{

return RTThreadCreate(NULL,

MachineCloneVMPrivate::workerThread,

static_cast<void*>(this),

0,

RTTHREADTYPE_MAIN_WORKER,

0,

"MachineClone");

}

static int workerThread(RTTHREAD /* Thread */, void *pvUser)

{

MachineCloneVMPrivate *pTask = static_cast<MachineCloneVMPrivate*>(pvUser);

AssertReturn(pTask, VERR_INVALID_POINTER);

HRESULT rc = pTask->q_ptr->run();

pTask->pProgress->notifyComplete(rc);

pTask->q_ptr->destroy();

return VINF_SUCCESS;

}

/* Private helper methods */

/* MachineCloneVM::start helper: */

HRESULT createMachineList(const ComPtr<ISnapshot> &pSnapshot, RTCList< ComObjPtr<Machine> > &machineList) const;

inline void updateProgressStats(MEDIUMTASKCHAIN &mtc, bool fAttachLinked, ULONG &uCount, ULONG &uTotalWeight) const;

inline HRESULT addSaveState(const ComObjPtr<Machine> &machine, ULONG &uCount, ULONG &uTotalWeight);

inline HRESULT queryBaseName(const ComPtr<IMedium> &pMedium, Utf8Str &strBaseName) const;

HRESULT queryMediasForMachineState(const RTCList<ComObjPtr<Machine> > &machineList, bool fAttachLinked, ULONG &uCount, ULONG &uTotalWeight);

HRESULT queryMediasForMachineAndChildStates(const RTCList<ComObjPtr<Machine> > &machineList, bool fAttachLinked, ULONG &uCount, ULONG &uTotalWeight);

HRESULT queryMediasForAllStates(const RTCList<ComObjPtr<Machine> > &machineList, bool fAttachLinked, ULONG &uCount, ULONG &uTotalWeight);

/* MachineCloneVM::run helper: */

bool findSnapshot(const settings::SnapshotsList &snl, const Guid &id, settings::Snapshot &sn) const;

void updateMACAddresses(settings::NetworkAdaptersList &nwl) const;

void updateMACAddresses(settings::SnapshotsList &sl) const;

void updateStorageLists(settings::StorageControllersList &sc, const Bstr &bstrOldId, const Bstr &bstrNewId) const;

void updateSnapshotStorageLists(settings::SnapshotsList &sl, const Bstr &bstrOldId, const Bstr &bstrNewId) const;

void updateStateFile(settings::SnapshotsList &snl, const Guid &id, const Utf8Str &strFile) const;

HRESULT createDifferencingMedium(const ComObjPtr<Medium> &pParent, const Utf8Str &strSnapshotFolder, RTCList<ComObjPtr<Medium> > &newMedia, ComObjPtr<Medium> *ppDiff) const;

static int copyStateFileProgress(unsigned uPercentage, void *pvUser);

/* Private q and parent pointer */

MachineCloneVM *q_ptr;

ComObjPtr<Machine> p;

/* Private helper members */

ComObjPtr<Machine> pSrcMachine;

ComObjPtr<Machine> pTrgMachine;

ComPtr<IMachine> pOldMachineState;

ComObjPtr<Progress> pProgress;

Guid snapshotId;

CloneMode_T mode;

RTCList<CloneOptions_T> options;

RTCList<MEDIUMTASKCHAIN> llMedias;

RTCList<SAVESTATETASK> llSaveStateFiles; /* Snapshot UUID -> File path */

};

HRESULT MachineCloneVMPrivate::createMachineList(const ComPtr<ISnapshot> &pSnapshot, RTCList< ComObjPtr<Machine> > &machineList) const

{

HRESULT rc = S_OK;

Bstr name;

rc = pSnapshot->COMGETTER(Name)(name.asOutParam());

if (FAILED(rc)) return rc;

ComPtr<IMachine> pMachine;

rc = pSnapshot->COMGETTER(Machine)(pMachine.asOutParam());

if (FAILED(rc)) return rc;

machineList.append((Machine*)(IMachine*)pMachine);

SafeIfaceArray<ISnapshot> sfaChilds;

rc = pSnapshot->COMGETTER(Children)(ComSafeArrayAsOutParam(sfaChilds));

if (FAILED(rc)) return rc;

for (size_t i = 0; i < sfaChilds.size(); ++i)

{

rc = createMachineList(sfaChilds[i], machineList);

if (FAILED(rc)) return rc;

}

return rc;

}

void MachineCloneVMPrivate::updateProgressStats(MEDIUMTASKCHAIN &mtc, bool fAttachLinked, ULONG &uCount, ULONG &uTotalWeight) const

{

if (fAttachLinked)

{

/* Implicit diff creation as part of attach is a pretty cheap

++uCount;

uTotalWeight += 1; /* 1MB per attachment */

}

else

{

/* Currently the copying of diff images involves reading at least

uint64_t uMaxSize = 0;

for (size_t e = mtc.chain.size(); e > 0; --e)

{

MEDIUMTASK &mt = mtc.chain.at(e - 1);

mt.uWeight += uMaxSize;

/* Calculate progress data */

++uCount;

uTotalWeight += mt.uWeight;

/* Save the max size for better weighting of diff image

uMaxSize = RT_MAX(uMaxSize, mt.uWeight);

}

}

}

HRESULT MachineCloneVMPrivate::addSaveState(const ComObjPtr<Machine> &machine, ULONG &uCount, ULONG &uTotalWeight)

{

Bstr bstrSrcSaveStatePath;

HRESULT rc = machine->COMGETTER(StateFilePath)(bstrSrcSaveStatePath.asOutParam());

if (FAILED(rc)) return rc;

if (!bstrSrcSaveStatePath.isEmpty())

{

SAVESTATETASK sst;

sst.snapshotUuid = machine->getSnapshotId();

sst.strSaveStateFile = bstrSrcSaveStatePath;

uint64_t cbSize;

int vrc = RTFileQuerySize(sst.strSaveStateFile.c_str(), &cbSize);

if (RT_FAILURE(vrc))

return p->setError(VBOX_E_IPRT_ERROR, p->tr("Could not query file size of '%s' (%Rrc)"), sst.strSaveStateFile.c_str(), vrc);

/* same rule as above: count both the data which needs to

sst.uWeight = 2 * (cbSize + _1M - 1) / _1M;

llSaveStateFiles.append(sst);

++uCount;

uTotalWeight += sst.uWeight;

}

return S_OK;

}

HRESULT MachineCloneVMPrivate::queryBaseName(const ComPtr<IMedium> &pMedium, Utf8Str &strBaseName) const

{

ComPtr<IMedium> pBaseMedium;

HRESULT rc = pMedium->COMGETTER(Base)(pBaseMedium.asOutParam());

if (FAILED(rc)) return rc;

Bstr bstrBaseName;

rc = pBaseMedium->COMGETTER(Name)(bstrBaseName.asOutParam());

if (FAILED(rc)) return rc;

strBaseName = bstrBaseName;

return rc;

}

HRESULT MachineCloneVMPrivate::queryMediasForMachineState(const RTCList<ComObjPtr<Machine> > &machineList, bool fAttachLinked, ULONG &uCount, ULONG &uTotalWeight)

{

/* This mode is pretty straightforward. We didn't need to know about any

HRESULT rc = S_OK;

for (size_t i = 0; i < machineList.size(); ++i)

{

const ComObjPtr<Machine> &machine = machineList.at(i);

/* If this is the Snapshot Machine we want to clone, we need to

const bool fCreateDiffs = (machine == pOldMachineState);

/* Add all attachments of the different machines to a worker list. */

SafeIfaceArray<IMediumAttachment> sfaAttachments;

rc = machine->COMGETTER(MediumAttachments)(ComSafeArrayAsOutParam(sfaAttachments));

if (FAILED(rc)) return rc;

for (size_t a = 0; a < sfaAttachments.size(); ++a)

{

const ComPtr<IMediumAttachment> &pAtt = sfaAttachments[a];

DeviceType_T type;

rc = pAtt->COMGETTER(Type)(&type);

if (FAILED(rc)) return rc;

/* Only harddisk's are of interest. */

if (type != DeviceType_HardDisk)

continue;

/* Valid medium attached? */

ComPtr<IMedium> pSrcMedium;

rc = pAtt->COMGETTER(Medium)(pSrcMedium.asOutParam());

if (FAILED(rc)) return rc;

if (pSrcMedium.isNull())

continue;

/* Create the medium task chain. In this case it will always

MEDIUMTASKCHAIN mtc;

mtc.fCreateDiffs = fCreateDiffs;

mtc.fAttachLinked = fAttachLinked;

/* Refresh the state so that the file size get read. */

MediumState_T e;

rc = pSrcMedium->RefreshState(&e);

if (FAILED(rc)) return rc;

LONG64 lSize;

rc = pSrcMedium->COMGETTER(Size)(&lSize);

if (FAILED(rc)) return rc;

MEDIUMTASK mt;

mt.uIdx = UINT32_MAX; /* No read/write optimization possible. */

/* Save the base name. */

rc = queryBaseName(pSrcMedium, mt.strBaseName);

if (FAILED(rc)) return rc;

/* Save the current medium, for later cloning. */

mt.pMedium = pSrcMedium;

if (fAttachLinked)

mt.uWeight = 0; /* dummy */

else

mt.uWeight = (lSize + _1M - 1) / _1M;

mtc.chain.append(mt);

/* Update the progress info. */

updateProgressStats(mtc, fAttachLinked, uCount, uTotalWeight);

/* Append the list of images which have to be cloned. */

llMedias.append(mtc);

}

/* Add the save state files of this machine if there is one. */

rc = addSaveState(machine, uCount, uTotalWeight);

if (FAILED(rc)) return rc;

}

return rc;

}

HRESULT MachineCloneVMPrivate::queryMediasForMachineAndChildStates(const RTCList<ComObjPtr<Machine> > &machineList, bool fAttachLinked, ULONG &uCount, ULONG &uTotalWeight)

{

/* This is basically a three step approach. First select all medias

HRESULT rc = S_OK;

std::map<ComPtr<IMedium>, uint32_t> mediaHist; /* Our usage histogram for the medias */

for (size_t i = 0; i < machineList.size(); ++i)

{

const ComObjPtr<Machine> &machine = machineList.at(i);

/* If this is the Snapshot Machine we want to clone, we need to

const bool fCreateDiffs = (machine == pOldMachineState);

/* Add all attachments (and their parents) of the different

SafeIfaceArray<IMediumAttachment> sfaAttachments;

rc = machine->COMGETTER(MediumAttachments)(ComSafeArrayAsOutParam(sfaAttachments));

if (FAILED(rc)) return rc;

for (size_t a = 0; a < sfaAttachments.size(); ++a)

{

const ComPtr<IMediumAttachment> &pAtt = sfaAttachments[a];

DeviceType_T type;

rc = pAtt->COMGETTER(Type)(&type);

if (FAILED(rc)) return rc;

/* Only harddisk's are of interest. */

if (type != DeviceType_HardDisk)

continue;

/* Valid medium attached? */

ComPtr<IMedium> pSrcMedium;

rc = pAtt->COMGETTER(Medium)(pSrcMedium.asOutParam());

if (FAILED(rc)) return rc;

if (pSrcMedium.isNull())

continue;

MEDIUMTASKCHAIN mtc;

mtc.fCreateDiffs = fCreateDiffs;

mtc.fAttachLinked = fAttachLinked;

while (!pSrcMedium.isNull())

{

/* Build a histogram of used medias and the parent chain. */

++mediaHist[pSrcMedium];

/* Refresh the state so that the file size get read. */

MediumState_T e;

rc = pSrcMedium->RefreshState(&e);

if (FAILED(rc)) return rc;

LONG64 lSize;

rc = pSrcMedium->COMGETTER(Size)(&lSize);

if (FAILED(rc)) return rc;

MEDIUMTASK mt;

mt.uIdx = UINT32_MAX;

mt.pMedium = pSrcMedium;

mt.uWeight = (lSize + _1M - 1) / _1M;

mtc.chain.append(mt);

/* Query next parent. */

rc = pSrcMedium->COMGETTER(Parent)(pSrcMedium.asOutParam());

if (FAILED(rc)) return rc;

}

llMedias.append(mtc);

}

/* Add the save state files of this machine if there is one. */

rc = addSaveState(machine, uCount, uTotalWeight);

if (FAILED(rc)) return rc;

}

/* Build up the index list of the image chain. Unfortunately we can't do

for (size_t i = 0; i < llMedias.size(); ++i)

{

uint32_t uIdx = 0;

MEDIUMTASKCHAIN &mtc = llMedias.at(i);

for (size_t a = mtc.chain.size(); a > 0; --a)

mtc.chain[a - 1].uIdx = ++uIdx;

}

#ifdef DEBUG_poetzsch

/* Print the histogram */

std::map<ComPtr<IMedium>, uint32_t>::iterator it;

for (it = mediaHist.begin(); it != mediaHist.end(); ++it)

{

Bstr bstrSrcName;

rc = (*it).first->COMGETTER(Name)(bstrSrcName.asOutParam());

if (FAILED(rc)) return rc;

RTPrintf("%ls: %d\n", bstrSrcName.raw(), (*it).second);

}

#endif

/* Go over every medium in the list and check if it either a directly

for (size_t i = 0; i < llMedias.size(); ++i)

{

MEDIUMTASKCHAIN &mtc = llMedias.at(i);

RTCList<MEDIUMTASK> newChain;

uint32_t used = 0;

for (size_t a = 0; a < mtc.chain.size(); ++a)

{

const MEDIUMTASK &mt = mtc.chain.at(a);

uint32_t hist = mediaHist[mt.pMedium];

#ifdef DEBUG_poetzsch

Bstr bstrSrcName;

rc = mt.pMedium->COMGETTER(Name)(bstrSrcName.asOutParam());

if (FAILED(rc)) return rc;

RTPrintf("%ls: %d (%d)\n", bstrSrcName.raw(), hist, used);

#endif

/* Check if there is a "step" in the histogram when going the chain

if (hist > used)

{

newChain.append(mt);

used = hist;

}

}

/* Make sure we always using the old base name as new base name, even

rc = queryBaseName(newChain.last().pMedium, newChain.last().strBaseName);

if (FAILED(rc)) return rc;

/* Update the old medium chain with the updated one. */

mtc.chain = newChain;

/* Update the progress info. */

updateProgressStats(mtc, fAttachLinked, uCount, uTotalWeight);

}

return rc;

}

HRESULT MachineCloneVMPrivate::queryMediasForAllStates(const RTCList<ComObjPtr<Machine> > &machineList, bool fAttachLinked, ULONG &uCount, ULONG &uTotalWeight)

{

/* In this case we create a exact copy of the original VM. This means just

HRESULT rc = S_OK;

for (size_t i = 0; i < machineList.size(); ++i)

{

const ComObjPtr<Machine> &machine = machineList.at(i);

/* If this is the Snapshot Machine we want to clone, we need to

const bool fCreateDiffs = (machine == pOldMachineState);

/* Add all attachments (and their parents) of the different

SafeIfaceArray<IMediumAttachment> sfaAttachments;

rc = machine->COMGETTER(MediumAttachments)(ComSafeArrayAsOutParam(sfaAttachments));

if (FAILED(rc)) return rc;

for (size_t a = 0; a < sfaAttachments.size(); ++a)

{

const ComPtr<IMediumAttachment> &pAtt = sfaAttachments[a];

DeviceType_T type;

rc = pAtt->COMGETTER(Type)(&type);

if (FAILED(rc)) return rc;

/* Only harddisk's are of interest. */

if (type != DeviceType_HardDisk)

continue;

/* Valid medium attached? */

ComPtr<IMedium> pSrcMedium;

rc = pAtt->COMGETTER(Medium)(pSrcMedium.asOutParam());

if (FAILED(rc)) return rc;

if (pSrcMedium.isNull())

continue;

/* Build up a child->parent list of this attachment. (Note: we are

MEDIUMTASKCHAIN mtc;

mtc.fCreateDiffs = fCreateDiffs;

mtc.fAttachLinked = fAttachLinked;

while (!pSrcMedium.isNull())

{

/* Refresh the state so that the file size get read. */

MediumState_T e;

rc = pSrcMedium->RefreshState(&e);

if (FAILED(rc)) return rc;

LONG64 lSize;

rc = pSrcMedium->COMGETTER(Size)(&lSize);

if (FAILED(rc)) return rc;

/* Save the current medium, for later cloning. */

MEDIUMTASK mt;

mt.uIdx = UINT32_MAX;

mt.pMedium = pSrcMedium;

mt.uWeight = (lSize + _1M - 1) / _1M;

mtc.chain.append(mt);

/* Query next parent. */

rc = pSrcMedium->COMGETTER(Parent)(pSrcMedium.asOutParam());

if (FAILED(rc)) return rc;

}

/* Update the progress info. */

updateProgressStats(mtc, fAttachLinked, uCount, uTotalWeight);

/* Append the list of images which have to be cloned. */

llMedias.append(mtc);

}

/* Add the save state files of this machine if there is one. */

rc = addSaveState(machine, uCount, uTotalWeight);

if (FAILED(rc)) return rc;

}

/* Build up the index list of the image chain. Unfortunately we can't do

for (size_t i = 0; i < llMedias.size(); ++i)

{

uint32_t uIdx = 0;

MEDIUMTASKCHAIN &mtc = llMedias.at(i);

for (size_t a = mtc.chain.size(); a > 0; --a)

mtc.chain[a - 1].uIdx = ++uIdx;

}

return rc;

}

bool MachineCloneVMPrivate::findSnapshot(const settings::SnapshotsList &snl, const Guid &id, settings::Snapshot &sn) const

{

settings::SnapshotsList::const_iterator it;

for (it = snl.begin(); it != snl.end(); ++it)

{

if (it->uuid == id)

{

sn = (*it);

return true;

}

else if (!it->llChildSnapshots.empty())

{

if (findSnapshot(it->llChildSnapshots, id, sn))

return true;

}

}

return false;

}

void MachineCloneVMPrivate::updateMACAddresses(settings::NetworkAdaptersList &nwl) const

{

const bool fNotNAT = options.contains(CloneOptions_KeepNATMACs);

settings::NetworkAdaptersList::iterator it;

for (it = nwl.begin(); it != nwl.end(); ++it)

{

if ( fNotNAT

&& it->mode == NetworkAttachmentType_NAT)

continue;

Host::generateMACAddress(it->strMACAddress);

}

}

void MachineCloneVMPrivate::updateMACAddresses(settings::SnapshotsList &sl) const

{

settings::SnapshotsList::iterator it;

for (it = sl.begin(); it != sl.end(); ++it)

{

updateMACAddresses(it->hardware.llNetworkAdapters);

if (!it->llChildSnapshots.empty())

updateMACAddresses(it->llChildSnapshots);

}

}

void MachineCloneVMPrivate::updateStorageLists(settings::StorageControllersList &sc, const Bstr &bstrOldId, const Bstr &bstrNewId) const

{

settings::StorageControllersList::iterator it3;

for (it3 = sc.begin();

it3 != sc.end();

++it3)

{

settings::AttachedDevicesList &llAttachments = it3->llAttachedDevices;

settings::AttachedDevicesList::iterator it4;

for (it4 = llAttachments.begin();

it4 != llAttachments.end();

++it4)

{

if ( it4->deviceType == DeviceType_HardDisk

&& it4->uuid == bstrOldId)

{

it4->uuid = bstrNewId;

}

}

}

}

void MachineCloneVMPrivate::updateSnapshotStorageLists(settings::SnapshotsList &sl, const Bstr &bstrOldId, const Bstr &bstrNewId) const

{

settings::SnapshotsList::iterator it;

for ( it = sl.begin();

it != sl.end();

++it)

{

updateStorageLists(it->storage.llStorageControllers, bstrOldId, bstrNewId);

if (!it->llChildSnapshots.empty())

updateSnapshotStorageLists(it->llChildSnapshots, bstrOldId, bstrNewId);

}

}

void MachineCloneVMPrivate::updateStateFile(settings::SnapshotsList &snl, const Guid &id, const Utf8Str &strFile) const

{

settings::SnapshotsList::iterator it;

for (it = snl.begin(); it != snl.end(); ++it)

{

if (it->uuid == id)

it->strStateFile = strFile;

else if (!it->llChildSnapshots.empty())

updateStateFile(it->llChildSnapshots, id, strFile);

}

}

HRESULT MachineCloneVMPrivate::createDifferencingMedium(const ComObjPtr<Medium> &pParent, const Utf8Str &strSnapshotFolder, RTCList<ComObjPtr<Medium> > &newMedia, ComObjPtr<Medium> *ppDiff) const

{

HRESULT rc = S_OK;

try

{

Bstr bstrSrcId;

rc = pParent->COMGETTER(Id)(bstrSrcId.asOutParam());

if (FAILED(rc)) throw rc;

ComObjPtr<Medium> diff;

diff.createObject();

rc = diff->init(p->getVirtualBox(),

pParent->getPreferredDiffFormat(),

Utf8StrFmt("%s%c", strSnapshotFolder.c_str(), RTPATH_DELIMITER),

Guid::Empty, /* empty media registry */

NULL); /* pllRegistriesThatNeedSaving */

if (FAILED(rc)) throw rc;

MediumLockList *pMediumLockList(new MediumLockList());

rc = diff->createMediumLockList(true /* fFailIfInaccessible */,

true /* fMediumLockWrite */,

pParent,

*pMediumLockList);

if (FAILED(rc)) throw rc;

rc = pMediumLockList->Lock();

if (FAILED(rc)) throw rc;

/* this already registers the new diff image */

rc = pParent->createDiffStorage(diff, MediumVariant_Standard,

pMediumLockList,

NULL /* aProgress */,

true /* aWait */,

NULL); // pllRegistriesThatNeedSaving

delete pMediumLockList;

if (FAILED(rc)) throw rc;

/* Remember created medium. */

newMedia.append(diff);

*ppDiff = diff;

}

catch (HRESULT rc2)

{

rc = rc2;

}

catch (...)

{

rc = VirtualBox::handleUnexpectedExceptions(RT_SRC_POS);

}

return rc;

}

int MachineCloneVMPrivate::copyStateFileProgress(unsigned uPercentage, void *pvUser)

{

ComObjPtr<Progress> pProgress = *static_cast< ComObjPtr<Progress>* >(pvUser);

BOOL fCanceled = false;

HRESULT rc = pProgress->COMGETTER(Canceled)(&fCanceled);

if (FAILED(rc)) return VERR_GENERAL_FAILURE;

/* If canceled by the user tell it to the copy operation. */

if (fCanceled) return VERR_CANCELLED;

/* Set the new process. */

rc = pProgress->SetCurrentOperationProgress(uPercentage);

if (FAILED(rc)) return VERR_GENERAL_FAILURE;

return VINF_SUCCESS;

}

MachineCloneVM::MachineCloneVM(ComObjPtr<Machine> pSrcMachine, ComObjPtr<Machine> pTrgMachine, CloneMode_T mode, const RTCList<CloneOptions_T> &opts)

: d_ptr(new MachineCloneVMPrivate(this, pSrcMachine, pTrgMachine, mode, opts))

{

}

MachineCloneVM::~MachineCloneVM()

{

delete d_ptr;

}

HRESULT MachineCloneVM::start(IProgress **pProgress)

{

DPTR(MachineCloneVM);

ComObjPtr<Machine> &p = d->p;

HRESULT rc;

try

{

/** @todo r=klaus this code cannot deal with someone crazy specifying

if (d->pSrcMachine->isSessionMachine())

throw E_FAIL;

/* Handle the special case that someone is requesting a _full_ clone

if ( d->mode == CloneMode_AllStates

&& d->pSrcMachine->isSnapshotMachine())

{

Bstr bstrSrcMachineId;

rc = d->pSrcMachine->COMGETTER(Id)(bstrSrcMachineId.asOutParam());

if (FAILED(rc)) throw rc;

ComPtr<IMachine> newSrcMachine;

rc = d->pSrcMachine->getVirtualBox()->FindMachine(bstrSrcMachineId.raw(), newSrcMachine.asOutParam());

if (FAILED(rc)) throw rc;

d->pSrcMachine = (Machine*)(IMachine*)newSrcMachine;

}

bool fSubtreeIncludesCurrent = false;

ComObjPtr<Machine> pCurrState;

if (d->mode == CloneMode_MachineAndChildStates)

{

if (d->pSrcMachine->isSnapshotMachine())

{

/* find machine object for current snapshot of current state */

Bstr bstrSrcMachineId;

rc = d->pSrcMachine->COMGETTER(Id)(bstrSrcMachineId.asOutParam());

if (FAILED(rc)) throw rc;

ComPtr<IMachine> pCurr;

rc = d->pSrcMachine->getVirtualBox()->FindMachine(bstrSrcMachineId.raw(), pCurr.asOutParam());

if (FAILED(rc)) throw rc;

if (pCurr.isNull())

throw E_FAIL;

pCurrState = (Machine *)(IMachine *)pCurr;

ComPtr<ISnapshot> pSnapshot;

rc = pCurrState->COMGETTER(CurrentSnapshot)(pSnapshot.asOutParam());

if (FAILED(rc)) throw rc;

if (pSnapshot.isNull())

throw E_FAIL;

ComPtr<IMachine> pCurrSnapMachine;

rc = pSnapshot->COMGETTER(Machine)(pCurrSnapMachine.asOutParam());

if (FAILED(rc)) throw rc;

if (pCurrSnapMachine.isNull())

throw E_FAIL;

/* now check if there is a parent chain which leads to the

while (!pSnapshot.isNull())

{

ComPtr<IMachine> pSnapMachine;

rc = pSnapshot->COMGETTER(Machine)(pSnapMachine.asOutParam());

if (FAILED(rc)) throw rc;

if (pSnapMachine.isNull())

throw E_FAIL;

if (pSnapMachine == d->pSrcMachine)

{

fSubtreeIncludesCurrent = true;

break;

}

rc = pSnapshot->COMGETTER(Parent)(pSnapshot.asOutParam());

if (FAILED(rc)) throw rc;

}

}

else

{

/* If the subtree is only the Current State simply use the

d->mode = CloneMode_MachineState;

}

}

/* Lock the target machine early (so nobody mess around with it in the meantime). */

AutoWriteLock trgLock(d->pTrgMachine COMMA_LOCKVAL_SRC_POS);

if (d->pSrcMachine->isSnapshotMachine())

d->snapshotId = d->pSrcMachine->getSnapshotId();

/* Add the current machine and all snapshot machines below this machine

RTCList< ComObjPtr<Machine> > machineList;

/* Include current state? */

if ( d->mode == CloneMode_MachineState

|| d->mode == CloneMode_AllStates)

machineList.append(d->pSrcMachine);

/* Should be done a depth copy with all child snapshots? */

if ( d->mode == CloneMode_MachineAndChildStates

|| d->mode == CloneMode_AllStates)

{

ULONG cSnapshots = 0;

rc = d->pSrcMachine->COMGETTER(SnapshotCount)(&cSnapshots);

if (FAILED(rc)) throw rc;

if (cSnapshots > 0)

{

Utf8Str id;

if (d->mode == CloneMode_MachineAndChildStates)

id = d->snapshotId.toString();

ComPtr<ISnapshot> pSnapshot;

rc = d->pSrcMachine->FindSnapshot(Bstr(id).raw(), pSnapshot.asOutParam());

if (FAILED(rc)) throw rc;

rc = d->createMachineList(pSnapshot, machineList);

if (FAILED(rc)) throw rc;

if (d->mode == CloneMode_MachineAndChildStates)

{

if (fSubtreeIncludesCurrent)

{

if (pCurrState.isNull())

throw E_FAIL;

machineList.append(pCurrState);

}

else

{

rc = pSnapshot->COMGETTER(Machine)(d->pOldMachineState.asOutParam());

if (FAILED(rc)) throw rc;

}

}

}

}

/* We have different approaches for getting the medias which needs to

ULONG uCount = 2; /* One init task and the machine creation. */

ULONG uTotalWeight = 2; /* The init task and the machine creation is worth one. */

bool fAttachLinked = d->options.contains(CloneOptions_Link); /* Linked clones requested? */

switch (d->mode)

{

case CloneMode_MachineState: d->queryMediasForMachineState(machineList, fAttachLinked, uCount, uTotalWeight); break;

case CloneMode_MachineAndChildStates: d->queryMediasForMachineAndChildStates(machineList, fAttachLinked, uCount, uTotalWeight); break;

case CloneMode_AllStates: d->queryMediasForAllStates(machineList, fAttachLinked, uCount, uTotalWeight); break;

}

/* Now create the progress project, so the user knows whats going on. */

rc = d->pProgress.createObject();

if (FAILED(rc)) throw rc;

rc = d->pProgress->init(p->getVirtualBox(),

static_cast<IMachine*>(d->pSrcMachine) /* aInitiator */,

Bstr(p->tr("Cloning Machine")).raw(),

true /* fCancellable */,

uCount,

uTotalWeight,

Bstr(p->tr("Initialize Cloning")).raw(),

1);

if (FAILED(rc)) throw rc;

int vrc = d->startWorker();

if (RT_FAILURE(vrc))

p->setError(VBOX_E_IPRT_ERROR, "Could not create machine clone thread (%Rrc)", vrc);

}

catch (HRESULT rc2)

{

rc = rc2;

}

if (SUCCEEDED(rc))

d->pProgress.queryInterfaceTo(pProgress);

return rc;

}

HRESULT MachineCloneVM::run()

{

DPTR(MachineCloneVM);

ComObjPtr<Machine> &p = d->p;

AutoCaller autoCaller(p);

if (FAILED(autoCaller.rc())) return autoCaller.rc();

AutoReadLock srcLock(p COMMA_LOCKVAL_SRC_POS);

AutoWriteLock trgLock(d->pTrgMachine COMMA_LOCKVAL_SRC_POS);

HRESULT rc = S_OK;

/*

/* Where should all the media go? */

Utf8Str strTrgSnapshotFolder;

Utf8Str strTrgMachineFolder = d->pTrgMachine->getSettingsFileFull();

strTrgMachineFolder.stripFilename();

RTCList<ComObjPtr<Medium> > newMedia; /* All created images */

RTCList<Utf8Str> newFiles; /* All extra created files (save states, ...) */

try

{

/* Copy all the configuration from this machine to an empty

settings::MachineConfigFile trgMCF = *d->pSrcMachine->mData->pMachineConfigFile;

/* Reset media registry. */

trgMCF.mediaRegistry.llHardDisks.clear();

/* If we got a valid snapshot id, replace the hardware/storage section

settings::Snapshot sn;

if (!d->snapshotId.isEmpty())

if (!d->findSnapshot(trgMCF.llFirstSnapshot, d->snapshotId, sn))

throw p->setError(E_FAIL,

p->tr("Could not find data to snapshots '%s'"), d->snapshotId.toString().c_str());

if (d->mode == CloneMode_MachineState)

{

if (!sn.uuid.isEmpty())

{

trgMCF.hardwareMachine = sn.hardware;

trgMCF.storageMachine = sn.storage;

}

/* Remove any hint on snapshots. */

trgMCF.llFirstSnapshot.clear();

trgMCF.uuidCurrentSnapshot.clear();

}

else if ( d->mode == CloneMode_MachineAndChildStates

&& !sn.uuid.isEmpty())

{

if (!d->pOldMachineState.isNull())

{

/* Copy the snapshot data to the current machine. */

trgMCF.hardwareMachine = sn.hardware;

trgMCF.storageMachine = sn.storage;

/* Current state is under root snapshot. */

trgMCF.uuidCurrentSnapshot = sn.uuid;

/* There will be created a new differencing image based on this

trgMCF.fCurrentStateModified = false;

}

/* The snapshot will be the root one. */

trgMCF.llFirstSnapshot.clear();

trgMCF.llFirstSnapshot.push_back(sn);

}

/* Generate new MAC addresses for all machines when not forbidden. */

if (!d->options.contains(CloneOptions_KeepAllMACs))

{

d->updateMACAddresses(trgMCF.hardwareMachine.llNetworkAdapters);

d->updateMACAddresses(trgMCF.llFirstSnapshot);

}

/* When the current snapshot folder is absolute we reset it to the

if (RTPathStartsWithRoot(trgMCF.machineUserData.strSnapshotFolder.c_str()))

trgMCF.machineUserData.strSnapshotFolder = "Snapshots";

trgMCF.strStateFile = "";

/* Set the new name. */

const Utf8Str strOldVMName = trgMCF.machineUserData.strName;

trgMCF.machineUserData.strName = d->pTrgMachine->mUserData->s.strName;

trgMCF.uuid = d->pTrgMachine->mData->mUuid;

Bstr bstrSrcSnapshotFolder;

rc = d->pSrcMachine->COMGETTER(SnapshotFolder)(bstrSrcSnapshotFolder.asOutParam());

if (FAILED(rc)) throw rc;

/* The absolute name of the snapshot folder. */

strTrgSnapshotFolder = Utf8StrFmt("%s%c%s", strTrgMachineFolder.c_str(), RTPATH_DELIMITER, trgMCF.machineUserData.strSnapshotFolder.c_str());

/* Should we rename the disk names. */

bool fKeepDiskNames = d->options.contains(CloneOptions_KeepDiskNames);

/* We need to create a map with the already created medias. This is

typedef std::map<Utf8Str, ComObjPtr<Medium> > TStrMediumMap;

typedef std::pair<Utf8Str, ComObjPtr<Medium> > TStrMediumPair;

TStrMediumMap map;

GuidList llRegistriesThatNeedSaving;

size_t cDisks = 0;

for (size_t i = 0; i < d->llMedias.size(); ++i)

{

const MEDIUMTASKCHAIN &mtc = d->llMedias.at(i);

ComObjPtr<Medium> pNewParent;

uint32_t uSrcParentIdx = UINT32_MAX;

uint32_t uTrgParentIdx = UINT32_MAX;

for (size_t a = mtc.chain.size(); a > 0; --a)

{

const MEDIUMTASK &mt = mtc.chain.at(a - 1);

ComPtr<IMedium> pMedium = mt.pMedium;

Bstr bstrSrcName;

rc = pMedium->COMGETTER(Name)(bstrSrcName.asOutParam());

if (FAILED(rc)) throw rc;

rc = d->pProgress->SetNextOperation(BstrFmt(p->tr("Cloning Disk '%ls' ..."), bstrSrcName.raw()).raw(), mt.uWeight);

if (FAILED(rc)) throw rc;

Bstr bstrSrcId;

rc = pMedium->COMGETTER(Id)(bstrSrcId.asOutParam());

if (FAILED(rc)) throw rc;

if (mtc.fAttachLinked)

{

IMedium *pTmp = pMedium;

ComObjPtr<Medium> pLMedium = static_cast<Medium*>(pTmp);

if (pLMedium.isNull())

throw E_POINTER;

ComObjPtr<Medium> pBase = pLMedium->getBase();

if (pBase->isReadOnly())

{

ComObjPtr<Medium> pDiff;

/* create the diff under the snapshot medium */

rc = d->createDifferencingMedium(pLMedium, strTrgSnapshotFolder,

newMedia, &pDiff);

if (FAILED(rc)) throw rc;

map.insert(TStrMediumPair(Utf8Str(bstrSrcId), pDiff));

/* diff image has to be used... */

pNewParent = pDiff;

}

else

{

/* Attach the medium directly, as its type is not

newMedia.append(pLMedium);

map.insert(TStrMediumPair(Utf8Str(bstrSrcId), pLMedium));

pNewParent = pLMedium;

}

}

else

{

/* Is a clone already there? */

TStrMediumMap::iterator it = map.find(Utf8Str(bstrSrcId));

if (it != map.end())

pNewParent = it->second;

else

{

ComPtr<IMediumFormat> pSrcFormat;

rc = pMedium->COMGETTER(MediumFormat)(pSrcFormat.asOutParam());

ULONG uSrcCaps = 0;

rc = pSrcFormat->COMGETTER(Capabilities)(&uSrcCaps);

if (FAILED(rc)) throw rc;

/* Default format? */

Utf8Str strDefaultFormat;

p->mParent->getDefaultHardDiskFormat(strDefaultFormat);

Bstr bstrSrcFormat(strDefaultFormat);

ULONG srcVar = MediumVariant_Standard;

/* Is the source file based? */

if ((uSrcCaps & MediumFormatCapabilities_File) == MediumFormatCapabilities_File)

{

/* Yes, just use the source format. Otherwise the defaults

rc = pMedium->COMGETTER(Format)(bstrSrcFormat.asOutParam());

if (FAILED(rc)) throw rc;

rc = pMedium->COMGETTER(Variant)(&srcVar);

if (FAILED(rc)) throw rc;

}

Guid newId;

newId.create();

Utf8Str strNewName(bstrSrcName);

if (!fKeepDiskNames)

{

Utf8Str strSrcTest = bstrSrcName;

/* Check if we have to use another name. */

if (!mt.strBaseName.isEmpty())

strSrcTest = mt.strBaseName;

strSrcTest.stripExt();

/* If the old disk name was in {uuid} format we also

if (strSrcTest == strOldVMName)

strNewName = Utf8StrFmt("%s%s", trgMCF.machineUserData.strName.c_str(), RTPathExt(Utf8Str(bstrSrcName).c_str()));

else if ( strSrcTest.startsWith("{")

&& strSrcTest.endsWith("}"))

{

strSrcTest = strSrcTest.substr(1, strSrcTest.length() - 2);

if (isValidGuid(strSrcTest))

strNewName = Utf8StrFmt("%s%s", newId.toStringCurly().c_str(), RTPathExt(strNewName.c_str()));

}

else

strNewName = Utf8StrFmt("%s-disk%d%s", trgMCF.machineUserData.strName.c_str(), ++cDisks, RTPathExt(Utf8Str(bstrSrcName).c_str()));

}

/* Check if this medium comes from the snapshot folder, if

Bstr bstrSrcPath;

Utf8Str strFile = Utf8StrFmt("%s%c%s", strTrgMachineFolder.c_str(), RTPATH_DELIMITER, strNewName.c_str());

rc = pMedium->COMGETTER(Location)(bstrSrcPath.asOutParam());

if (FAILED(rc)) throw rc;

if ( !bstrSrcPath.isEmpty()

&& RTPathStartsWith(Utf8Str(bstrSrcPath).c_str(), Utf8Str(bstrSrcSnapshotFolder).c_str())

&& (fKeepDiskNames || mt.strBaseName.isEmpty()))

strFile = Utf8StrFmt("%s%c%s", strTrgSnapshotFolder.c_str(), RTPATH_DELIMITER, strNewName.c_str());

/* Start creating the clone. */

ComObjPtr<Medium> pTarget;

rc = pTarget.createObject();

if (FAILED(rc)) throw rc;

rc = pTarget->init(p->mParent,

Utf8Str(bstrSrcFormat),

strFile,

Guid::Empty, /* empty media registry */

NULL /* llRegistriesThatNeedSaving */);

if (FAILED(rc)) throw rc;

/* Update the new uuid. */

pTarget->updateId(newId);

srcLock.release();

/* Do the disk cloning. */

ComPtr<IProgress> progress2;

ComObjPtr<Medium> pLMedium = static_cast<Medium*>((IMedium*)pMedium);

rc = pLMedium->cloneToEx(pTarget,

srcVar,

pNewParent,

progress2.asOutParam(),

uSrcParentIdx,

uTrgParentIdx);

if (FAILED(rc)) throw rc;

/* Wait until the async process has finished. */

rc = d->pProgress->WaitForAsyncProgressCompletion(progress2);

srcLock.acquire();

if (FAILED(rc)) throw rc;

/* Check the result of the async process. */

LONG iRc;

rc = progress2->COMGETTER(ResultCode)(&iRc);

if (FAILED(rc)) throw rc;

if (FAILED(iRc))

{

/* If the thread of the progress object has an error, then

ProgressErrorInfo info(progress2);

throw p->setError(iRc, Utf8Str(info.getText()).c_str());

}

/* Remember created medium. */

newMedia.append(pTarget);

/* Get the medium type from the source and set it to the

MediumType_T type;

rc = pMedium->COMGETTER(Type)(&type);

if (FAILED(rc)) throw rc;

rc = pTarget->COMSETTER(Type)(type);

if (FAILED(rc)) throw rc;

map.insert(TStrMediumPair(Utf8Str(bstrSrcId), pTarget));

/* register the new harddisk */

{

AutoWriteLock tlock(p->mParent->getMediaTreeLockHandle() COMMA_LOCKVAL_SRC_POS);

rc = p->mParent->registerHardDisk(pTarget, NULL /* pllRegistriesThatNeedSaving */);

if (FAILED(rc)) throw rc;

}

/* This medium becomes the parent of the next medium in the

pNewParent = pTarget;

}

}

/* Save the current source medium index as the new parent

uSrcParentIdx = mt.uIdx;

/* Simply increase the target index. */

++uTrgParentIdx;

}

Bstr bstrSrcId;

rc = mtc.chain.first().pMedium->COMGETTER(Id)(bstrSrcId.asOutParam());

if (FAILED(rc)) throw rc;

Bstr bstrTrgId;

rc = pNewParent->COMGETTER(Id)(bstrTrgId.asOutParam());

if (FAILED(rc)) throw rc;

/* update snapshot configuration */

d->updateSnapshotStorageLists(trgMCF.llFirstSnapshot, bstrSrcId, bstrTrgId);

/* create new 'Current State' diff for caller defined place */

if (mtc.fCreateDiffs)

{

const MEDIUMTASK &mt = mtc.chain.first();

ComObjPtr<Medium> pLMedium = static_cast<Medium*>((IMedium*)mt.pMedium);

if (pLMedium.isNull())

throw E_POINTER;

ComObjPtr<Medium> pBase = pLMedium->getBase();

if (pBase->isReadOnly())

{

ComObjPtr<Medium> pDiff;

rc = d->createDifferencingMedium(pNewParent, strTrgSnapshotFolder,

newMedia, &pDiff);

if (FAILED(rc)) throw rc;

/* diff image has to be used... */

pNewParent = pDiff;

}

else

{

/* Attach the medium directly, as its type is not

newMedia.append(pNewParent);

}

rc = pNewParent->COMGETTER(Id)(bstrTrgId.asOutParam());

if (FAILED(rc)) throw rc;

}

/* update 'Current State' configuration */

d->updateStorageLists(trgMCF.storageMachine.llStorageControllers, bstrSrcId, bstrTrgId);

}

/* Make sure all disks know of the new machine uuid. We do this last to

for (size_t i = newMedia.size(); i > 0; --i)

{

const ComObjPtr<Medium> &pMedium = newMedia.at(i - 1);

AutoCaller mac(pMedium);

if (FAILED(mac.rc())) throw mac.rc();

AutoWriteLock mlock(pMedium COMMA_LOCKVAL_SRC_POS);

Guid uuid = d->pTrgMachine->mData->mUuid;

if (d->options.contains(CloneOptions_Link))

{

ComObjPtr<Medium> pParent = pMedium->getParent();

mlock.release();

if (!pParent.isNull())

{

AutoCaller mac2(pParent);

if (FAILED(mac2.rc())) throw mac2.rc();

AutoReadLock mlock2(pParent COMMA_LOCKVAL_SRC_POS);

if (pParent->getFirstRegistryMachineId(uuid))

VirtualBox::addGuidToListUniquely(llRegistriesThatNeedSaving, uuid);

}

mlock.acquire();

}

pMedium->addRegistry(uuid, false /* fRecurse */);

}

/* Check if a snapshot folder is necessary and if so doesn't already

if ( !d->llSaveStateFiles.isEmpty()

&& !RTDirExists(strTrgSnapshotFolder.c_str()))

{

int vrc = RTDirCreateFullPath(strTrgSnapshotFolder.c_str(), 0777);

if (RT_FAILURE(vrc))

throw p->setError(VBOX_E_IPRT_ERROR,

p->tr("Could not create snapshots folder '%s' (%Rrc)"), strTrgSnapshotFolder.c_str(), vrc);

}

/* Clone all save state files. */

for (size_t i = 0; i < d->llSaveStateFiles.size(); ++i)

{

SAVESTATETASK sst = d->llSaveStateFiles.at(i);

const Utf8Str &strTrgSaveState = Utf8StrFmt("%s%c%s", strTrgSnapshotFolder.c_str(), RTPATH_DELIMITER, RTPathFilename(sst.strSaveStateFile.c_str()));

/* Move to next sub-operation. */

rc = d->pProgress->SetNextOperation(BstrFmt(p->tr("Copy save state file '%s' ..."), RTPathFilename(sst.strSaveStateFile.c_str())).raw(), sst.uWeight);

if (FAILED(rc)) throw rc;

/* Copy the file only if it was not copied already. */

if (!newFiles.contains(strTrgSaveState.c_str()))

{

int vrc = RTFileCopyEx(sst.strSaveStateFile.c_str(), strTrgSaveState.c_str(), 0, MachineCloneVMPrivate::copyStateFileProgress, &d->pProgress);

if (RT_FAILURE(vrc))

throw p->setError(VBOX_E_IPRT_ERROR,

p->tr("Could not copy state file '%s' to '%s' (%Rrc)"), sst.strSaveStateFile.c_str(), strTrgSaveState.c_str(), vrc);

newFiles.append(strTrgSaveState);

}

/* Update the path in the configuration either for the current

if (sst.snapshotUuid.isEmpty())

trgMCF.strStateFile = strTrgSaveState;

else

d->updateStateFile(trgMCF.llFirstSnapshot, sst.snapshotUuid, strTrgSaveState);

}

{

rc = d->pProgress->SetNextOperation(BstrFmt(p->tr("Create Machine Clone '%s' ..."), trgMCF.machineUserData.strName.c_str()).raw(), 1);

if (FAILED(rc)) throw rc;

/* After modifying the new machine config, we can copy the stuff

rc = d->pTrgMachine->checkStateDependency(p->MutableStateDep);

if (FAILED(rc)) throw rc;

rc = d->pTrgMachine->loadMachineDataFromSettings(trgMCF,

&d->pTrgMachine->mData->mUuid);

if (FAILED(rc)) throw rc;

/* save all VM data */

bool fNeedsGlobalSaveSettings = false;

rc = d->pTrgMachine->saveSettings(&fNeedsGlobalSaveSettings, Machine::SaveS_Force);

if (FAILED(rc)) throw rc;

/* Release all locks */

trgLock.release();

srcLock.release();

if (fNeedsGlobalSaveSettings)

{

/* save the global settings; for that we should hold only the

AutoWriteLock vlock(p->mParent COMMA_LOCKVAL_SRC_POS);

rc = p->mParent->saveSettings();

if (FAILED(rc)) throw rc;

}

}

/* Any additional machines need saving? */

if (!llRegistriesThatNeedSaving.empty())

{

rc = p->mParent->saveRegistries(llRegistriesThatNeedSaving);

if (FAILED(rc)) throw rc;

}

}

catch (HRESULT rc2)

{

rc = rc2;

}

catch (...)

{

rc = VirtualBox::handleUnexpectedExceptions(RT_SRC_POS);

}

MultiResult mrc(rc);

/* Cleanup on failure (CANCEL also) */

if (FAILED(rc))

{

int vrc = VINF_SUCCESS;

/* Delete all created files. */

for (size_t i = 0; i < newFiles.size(); ++i)

{

vrc = RTFileDelete(newFiles.at(i).c_str());

if (RT_FAILURE(vrc))

mrc = p->setError(VBOX_E_IPRT_ERROR, p->tr("Could not delete file '%s' (%Rrc)"), newFiles.at(i).c_str(), vrc);

}

/* Delete all already created medias. (Reverse, cause there could be

for (size_t i = newMedia.size(); i > 0; --i)

{

const ComObjPtr<Medium> &pMedium = newMedia.at(i - 1);

mrc = pMedium->deleteStorage(NULL /* aProgress */,

true /* aWait */,

NULL /* llRegistriesThatNeedSaving */);

pMedium->Close();

}

/* Delete the snapshot folder when not empty. */

if (!strTrgSnapshotFolder.isEmpty())

RTDirRemove(strTrgSnapshotFolder.c_str());

/* Delete the machine folder when not empty. */

RTDirRemove(strTrgMachineFolder.c_str());

}

return mrc;

}

void MachineCloneVM::destroy()

{

delete this;

}