MachineImplCloneVM.cpp@ 38534

Last change on this file since 38534 was 38534, checked in by vboxsync, 13 years ago
Main: always use setError; improved some error messages; use the new setError(com::ErrorInfo) method
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 57.8 KB

Line
1	/* $Id: MachineImplCloneVM.cpp 38534 2011-08-25 15:50:21Z vboxsync $ */
2	/** @file
3	* Implementation of MachineCloneVM
4	*/
5
6	/*
7	* Copyright (C) 2011 Oracle Corporation
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.virtualbox.org. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*/
17
18	#include "MachineImplCloneVM.h"
19
20	#include "VirtualBoxImpl.h"
21	#include "MediumImpl.h"
22	#include "HostImpl.h"
23
24	#include <iprt/path.h>
25	#include <iprt/dir.h>
26	#include <iprt/cpp/utils.h>
27	#ifdef DEBUG_poetzsch
28	# include <iprt/stream.h>
29	#endif
30
31	#include <VBox/com/list.h>
32	#include <VBox/com/MultiResult.h>
33
34	// typedefs
35	/////////////////////////////////////////////////////////////////////////////
36
37	typedef struct
38	{
39	Utf8Str strBaseName;
40	ComPtr<IMedium> pMedium;
41	uint32_t uIdx;
42	ULONG uWeight;
43	} MEDIUMTASK;
44
45	typedef struct
46	{
47	RTCList<MEDIUMTASK> chain;
48	bool fCreateDiffs;
49	bool fAttachLinked;
50	} MEDIUMTASKCHAIN;
51
52	typedef struct
53	{
54	Guid snapshotUuid;
55	Utf8Str strSaveStateFile;
56	ULONG uWeight;
57	} SAVESTATETASK;
58
59	// The private class
60	/////////////////////////////////////////////////////////////////////////////
61
62	struct MachineCloneVMPrivate
63	{
64	MachineCloneVMPrivate(MachineCloneVM *a_q, ComObjPtr<Machine> &a_pSrcMachine, ComObjPtr<Machine> &a_pTrgMachine, CloneMode_T a_mode, const RTCList<CloneOptions_T> &opts)
65	: q_ptr(a_q)
66	, p(a_pSrcMachine)
67	, pSrcMachine(a_pSrcMachine)
68	, pTrgMachine(a_pTrgMachine)
69	, mode(a_mode)
70	, options(opts)
71	{}
72
73	/* Thread management */
74	int startWorker()
75	{
76	return RTThreadCreate(NULL,
77	MachineCloneVMPrivate::workerThread,
78	static_cast<void*>(this),
79	0,
80	RTTHREADTYPE_MAIN_WORKER,
81	0,
82	"MachineClone");
83	}
84
85	static int workerThread(RTTHREAD /* Thread /, void pvUser)
86	{
87	MachineCloneVMPrivate pTask = static_cast<MachineCloneVMPrivate>(pvUser);
88	AssertReturn(pTask, VERR_INVALID_POINTER);
89
90	HRESULT rc = pTask->q_ptr->run();
91
92	pTask->pProgress->notifyComplete(rc);
93
94	pTask->q_ptr->destroy();
95
96	return VINF_SUCCESS;
97	}
98
99	/* Private helper methods */
100
101	/* MachineCloneVM::start helper: */
102	HRESULT createMachineList(const ComPtr<ISnapshot> &pSnapshot, RTCList< ComObjPtr<Machine> > &machineList) const;
103	inline void updateProgressStats(MEDIUMTASKCHAIN &mtc, bool fAttachLinked, ULONG &uCount, ULONG &uTotalWeight) const;
104	inline HRESULT addSaveState(const ComObjPtr<Machine> &machine, ULONG &uCount, ULONG &uTotalWeight);
105	inline HRESULT queryBaseName(const ComPtr<IMedium> &pMedium, Utf8Str &strBaseName) const;
106	HRESULT queryMediasForMachineState(const RTCList<ComObjPtr<Machine> > &machineList, bool fAttachLinked, ULONG &uCount, ULONG &uTotalWeight);
107	HRESULT queryMediasForMachineAndChildStates(const RTCList<ComObjPtr<Machine> > &machineList, bool fAttachLinked, ULONG &uCount, ULONG &uTotalWeight);
108	HRESULT queryMediasForAllStates(const RTCList<ComObjPtr<Machine> > &machineList, bool fAttachLinked, ULONG &uCount, ULONG &uTotalWeight);
109
110	/* MachineCloneVM::run helper: */
111	bool findSnapshot(const settings::SnapshotsList &snl, const Guid &id, settings::Snapshot &sn) const;
112	void updateMACAddresses(settings::NetworkAdaptersList &nwl) const;
113	void updateMACAddresses(settings::SnapshotsList &sl) const;
114	void updateStorageLists(settings::StorageControllersList &sc, const Bstr &bstrOldId, const Bstr &bstrNewId) const;
115	void updateSnapshotStorageLists(settings::SnapshotsList &sl, const Bstr &bstrOldId, const Bstr &bstrNewId) const;
116	void updateStateFile(settings::SnapshotsList &snl, const Guid &id, const Utf8Str &strFile) const;
117	HRESULT createDifferencingMedium(const ComObjPtr<Medium> &pParent, const Utf8Str &strSnapshotFolder, RTCList<ComObjPtr<Medium> > &newMedia, ComObjPtr<Medium> *ppDiff) const;
118	static int copyStateFileProgress(unsigned uPercentage, void *pvUser);
119
120	/* Private q and parent pointer */
121	MachineCloneVM *q_ptr;
122	ComObjPtr<Machine> p;
123
124	/* Private helper members */
125	ComObjPtr<Machine> pSrcMachine;
126	ComObjPtr<Machine> pTrgMachine;
127	ComPtr<IMachine> pOldMachineState;
128	ComObjPtr<Progress> pProgress;
129	Guid snapshotId;
130	CloneMode_T mode;
131	RTCList<CloneOptions_T> options;
132	RTCList<MEDIUMTASKCHAIN> llMedias;
133	RTCList<SAVESTATETASK> llSaveStateFiles; /* Snapshot UUID -> File path */
134	};
135
136	HRESULT MachineCloneVMPrivate::createMachineList(const ComPtr<ISnapshot> &pSnapshot, RTCList< ComObjPtr<Machine> > &machineList) const
137	{
138	HRESULT rc = S_OK;
139	Bstr name;
140	rc = pSnapshot->COMGETTER(Name)(name.asOutParam());
141	if (FAILED(rc)) return rc;
142
143	ComPtr<IMachine> pMachine;
144	rc = pSnapshot->COMGETTER(Machine)(pMachine.asOutParam());
145	if (FAILED(rc)) return rc;
146	machineList.append((Machine)(IMachine)pMachine);
147
148	SafeIfaceArray<ISnapshot> sfaChilds;
149	rc = pSnapshot->COMGETTER(Children)(ComSafeArrayAsOutParam(sfaChilds));
150	if (FAILED(rc)) return rc;
151	for (size_t i = 0; i < sfaChilds.size(); ++i)
152	{
153	rc = createMachineList(sfaChilds[i], machineList);
154	if (FAILED(rc)) return rc;
155	}
156
157	return rc;
158	}
159
160	void MachineCloneVMPrivate::updateProgressStats(MEDIUMTASKCHAIN &mtc, bool fAttachLinked, ULONG &uCount, ULONG &uTotalWeight) const
161	{
162	if (fAttachLinked)
163	{
164	/* Implicit diff creation as part of attach is a pretty cheap
165	* operation, and does only need one operation per attachment. */
166	++uCount;
167	uTotalWeight += 1; /* 1MB per attachment */
168	}
169	else
170	{
171	/* Currently the copying of diff images involves reading at least
172	* the biggest parent in the previous chain. So even if the new
173	* diff image is small in size, it could need some time to create
174	* it. Adding the biggest size in the chain should balance this a
175	* little bit more, i.e. the weight is the sum of the data which
176	* needs to be read and written. */
177	uint64_t uMaxSize = 0;
178	for (size_t e = mtc.chain.size(); e > 0; --e)
179	{
180	MEDIUMTASK &mt = mtc.chain.at(e - 1);
181	mt.uWeight += uMaxSize;
182
183	/* Calculate progress data */
184	++uCount;
185	uTotalWeight += mt.uWeight;
186
187	/* Save the max size for better weighting of diff image
188	* creation. */
189	uMaxSize = RT_MAX(uMaxSize, mt.uWeight);
190	}
191	}
192	}
193
194	HRESULT MachineCloneVMPrivate::addSaveState(const ComObjPtr<Machine> &machine, ULONG &uCount, ULONG &uTotalWeight)
195	{
196	Bstr bstrSrcSaveStatePath;
197	HRESULT rc = machine->COMGETTER(StateFilePath)(bstrSrcSaveStatePath.asOutParam());
198	if (FAILED(rc)) return rc;
199	if (!bstrSrcSaveStatePath.isEmpty())
200	{
201	SAVESTATETASK sst;
202	sst.snapshotUuid = machine->getSnapshotId();
203	sst.strSaveStateFile = bstrSrcSaveStatePath;
204	uint64_t cbSize;
205	int vrc = RTFileQuerySize(sst.strSaveStateFile.c_str(), &cbSize);
206	if (RT_FAILURE(vrc))
207	return p->setError(VBOX_E_IPRT_ERROR, p->tr("Could not query file size of '%s' (%Rrc)"), sst.strSaveStateFile.c_str(), vrc);
208	/* same rule as above: count both the data which needs to
209	* be read and written */
210	sst.uWeight = 2 * (cbSize + _1M - 1) / _1M;
211	llSaveStateFiles.append(sst);
212	++uCount;
213	uTotalWeight += sst.uWeight;
214	}
215	return S_OK;
216	}
217
218	HRESULT MachineCloneVMPrivate::queryBaseName(const ComPtr<IMedium> &pMedium, Utf8Str &strBaseName) const
219	{
220	ComPtr<IMedium> pBaseMedium;
221	HRESULT rc = pMedium->COMGETTER(Base)(pBaseMedium.asOutParam());
222	if (FAILED(rc)) return rc;
223	Bstr bstrBaseName;
224	rc = pBaseMedium->COMGETTER(Name)(bstrBaseName.asOutParam());
225	if (FAILED(rc)) return rc;
226	strBaseName = bstrBaseName;
227	return rc;
228	}
229
230	HRESULT MachineCloneVMPrivate::queryMediasForMachineState(const RTCList<ComObjPtr<Machine> > &machineList, bool fAttachLinked, ULONG &uCount, ULONG &uTotalWeight)
231	{
232	/* This mode is pretty straightforward. We didn't need to know about any
233	* parent/children relationship and therefor simply adding all directly
234	* attached images of the source VM as cloning targets. The IMedium code
235	* take than care to merge any (possibly) existing parents into the new
236	* image. */
237	HRESULT rc = S_OK;
238	for (size_t i = 0; i < machineList.size(); ++i)
239	{
240	const ComObjPtr<Machine> &machine = machineList.at(i);
241	/* If this is the Snapshot Machine we want to clone, we need to
242	* create a new diff file for the new "current state". */
243	const bool fCreateDiffs = (machine == pOldMachineState);
244	/* Add all attachments of the different machines to a worker list. */
245	SafeIfaceArray<IMediumAttachment> sfaAttachments;
246	rc = machine->COMGETTER(MediumAttachments)(ComSafeArrayAsOutParam(sfaAttachments));
247	if (FAILED(rc)) return rc;
248	for (size_t a = 0; a < sfaAttachments.size(); ++a)
249	{
250	const ComPtr<IMediumAttachment> &pAtt = sfaAttachments[a];
251	DeviceType_T type;
252	rc = pAtt->COMGETTER(Type)(&type);
253	if (FAILED(rc)) return rc;
254
255	/* Only harddisk's are of interest. */
256	if (type != DeviceType_HardDisk)
257	continue;
258
259	/* Valid medium attached? */
260	ComPtr<IMedium> pSrcMedium;
261	rc = pAtt->COMGETTER(Medium)(pSrcMedium.asOutParam());
262	if (FAILED(rc)) return rc;
263	if (pSrcMedium.isNull())
264	continue;
265
266	/* Create the medium task chain. In this case it will always
267	* contain one image only. */
268	MEDIUMTASKCHAIN mtc;
269	mtc.fCreateDiffs = fCreateDiffs;
270	mtc.fAttachLinked = fAttachLinked;
271
272	/* Refresh the state so that the file size get read. */
273	MediumState_T e;
274	rc = pSrcMedium->RefreshState(&e);
275	if (FAILED(rc)) return rc;
276	LONG64 lSize;
277	rc = pSrcMedium->COMGETTER(Size)(&lSize);
278	if (FAILED(rc)) return rc;
279
280	MEDIUMTASK mt;
281	mt.uIdx = UINT32_MAX; /* No read/write optimization possible. */
282
283	/* Save the base name. */
284	rc = queryBaseName(pSrcMedium, mt.strBaseName);
285	if (FAILED(rc)) return rc;
286
287	/* Save the current medium, for later cloning. */
288	mt.pMedium = pSrcMedium;
289	if (fAttachLinked)
290	mt.uWeight = 0; /* dummy */
291	else
292	mt.uWeight = (lSize + _1M - 1) / _1M;
293	mtc.chain.append(mt);
294
295	/* Update the progress info. */
296	updateProgressStats(mtc, fAttachLinked, uCount, uTotalWeight);
297	/* Append the list of images which have to be cloned. */
298	llMedias.append(mtc);
299	}
300	/* Add the save state files of this machine if there is one. */
301	rc = addSaveState(machine, uCount, uTotalWeight);
302	if (FAILED(rc)) return rc;
303	}
304
305	return rc;
306	}
307
308	HRESULT MachineCloneVMPrivate::queryMediasForMachineAndChildStates(const RTCList<ComObjPtr<Machine> > &machineList, bool fAttachLinked, ULONG &uCount, ULONG &uTotalWeight)
309	{
310	/* This is basically a three step approach. First select all medias
311	* directly or indirectly involved in the clone. Second create a histogram
312	* of the usage of all that medias. Third select the medias which are
313	* directly attached or have more than one directly/indirectly used child
314	* in the new clone. Step one and two are done in the first loop.
315	*
316	* Example of the histogram counts after going through 3 attachments from
317	* bottom to top:
318	*
319	* 3
320	* \|
321	* -> 3
322	* / \
323	* 2 1 <-
324	* /
325	* -> 2
326	* / \
327	* -> 1 1
328	* \
329	* 1 <-
330	*
331	* Whenever the histogram count is changing compared to the previous one we
332	* need to include that image in the cloning step (Marked with <-). If we
333	* start at zero even the directly attached images are automatically
334	* included.
335	*
336	* Note: This still leads to media chains which can have the same medium
337	* included. This case is handled in "run" and therefor not critical, but
338	* it leads to wrong progress infos which isn't nice. */
339
340	HRESULT rc = S_OK;
341	std::map<ComPtr<IMedium>, uint32_t> mediaHist; /* Our usage histogram for the medias */
342	for (size_t i = 0; i < machineList.size(); ++i)
343	{
344	const ComObjPtr<Machine> &machine = machineList.at(i);
345	/* If this is the Snapshot Machine we want to clone, we need to
346	* create a new diff file for the new "current state". */
347	const bool fCreateDiffs = (machine == pOldMachineState);
348	/* Add all attachments (and their parents) of the different
349	* machines to a worker list. */
350	SafeIfaceArray<IMediumAttachment> sfaAttachments;
351	rc = machine->COMGETTER(MediumAttachments)(ComSafeArrayAsOutParam(sfaAttachments));
352	if (FAILED(rc)) return rc;
353	for (size_t a = 0; a < sfaAttachments.size(); ++a)
354	{
355	const ComPtr<IMediumAttachment> &pAtt = sfaAttachments[a];
356	DeviceType_T type;
357	rc = pAtt->COMGETTER(Type)(&type);
358	if (FAILED(rc)) return rc;
359
360	/* Only harddisk's are of interest. */
361	if (type != DeviceType_HardDisk)
362	continue;
363
364	/* Valid medium attached? */
365	ComPtr<IMedium> pSrcMedium;
366	rc = pAtt->COMGETTER(Medium)(pSrcMedium.asOutParam());
367	if (FAILED(rc)) return rc;
368
369	if (pSrcMedium.isNull())
370	continue;
371
372	MEDIUMTASKCHAIN mtc;
373	mtc.fCreateDiffs = fCreateDiffs;
374	mtc.fAttachLinked = fAttachLinked;
375
376	while (!pSrcMedium.isNull())
377	{
378	/* Build a histogram of used medias and the parent chain. */
379	++mediaHist[pSrcMedium];
380
381	/* Refresh the state so that the file size get read. */
382	MediumState_T e;
383	rc = pSrcMedium->RefreshState(&e);
384	if (FAILED(rc)) return rc;
385	LONG64 lSize;
386	rc = pSrcMedium->COMGETTER(Size)(&lSize);
387	if (FAILED(rc)) return rc;
388
389	MEDIUMTASK mt;
390	mt.uIdx = UINT32_MAX;
391	mt.pMedium = pSrcMedium;
392	mt.uWeight = (lSize + _1M - 1) / _1M;
393	mtc.chain.append(mt);
394
395	/* Query next parent. */
396	rc = pSrcMedium->COMGETTER(Parent)(pSrcMedium.asOutParam());
397	if (FAILED(rc)) return rc;
398	}
399
400	llMedias.append(mtc);
401	}
402	/* Add the save state files of this machine if there is one. */
403	rc = addSaveState(machine, uCount, uTotalWeight);
404	if (FAILED(rc)) return rc;
405	}
406	/* Build up the index list of the image chain. Unfortunately we can't do
407	* that in the previous loop, cause there we go from child -> parent and
408	* didn't know how many are between. */
409	for (size_t i = 0; i < llMedias.size(); ++i)
410	{
411	uint32_t uIdx = 0;
412	MEDIUMTASKCHAIN &mtc = llMedias.at(i);
413	for (size_t a = mtc.chain.size(); a > 0; --a)
414	mtc.chain[a - 1].uIdx = uIdx++;
415	}
416	#ifdef DEBUG_poetzsch
417	/* Print the histogram */
418	std::map<ComPtr<IMedium>, uint32_t>::iterator it;
419	for (it = mediaHist.begin(); it != mediaHist.end(); ++it)
420	{
421	Bstr bstrSrcName;
422	rc = (*it).first->COMGETTER(Name)(bstrSrcName.asOutParam());
423	if (FAILED(rc)) return rc;
424	RTPrintf("%ls: %d\n", bstrSrcName.raw(), (*it).second);
425	}
426	#endif
427	/* Go over every medium in the list and check if it either a directly
428	* attached disk or has more than one children. If so it needs to be
429	* replicated. Also we have to make sure that any direct or indirect
430	* children knows of the new parent (which doesn't necessarily mean it
431	* is a direct children in the source chain). */
432	for (size_t i = 0; i < llMedias.size(); ++i)
433	{
434	MEDIUMTASKCHAIN &mtc = llMedias.at(i);
435	RTCList<MEDIUMTASK> newChain;
436	uint32_t used = 0;
437	for (size_t a = 0; a < mtc.chain.size(); ++a)
438	{
439	const MEDIUMTASK &mt = mtc.chain.at(a);
440	uint32_t hist = mediaHist[mt.pMedium];
441	#ifdef DEBUG_poetzsch
442	Bstr bstrSrcName;
443	rc = mt.pMedium->COMGETTER(Name)(bstrSrcName.asOutParam());
444	if (FAILED(rc)) return rc;
445	RTPrintf("%ls: %d (%d)\n", bstrSrcName.raw(), hist, used);
446	#endif
447	/* Check if there is a "step" in the histogram when going the chain
448	* upwards. If so, we need this image, cause there is another branch
449	* from here in the cloned VM. */
450	if (hist > used)
451	{
452	newChain.append(mt);
453	used = hist;
454	}
455	}
456	/* Make sure we always using the old base name as new base name, even
457	* if the base is a differencing image in the source VM (with the UUID
458	* as name). */
459	rc = queryBaseName(newChain.last().pMedium, newChain.last().strBaseName);
460	if (FAILED(rc)) return rc;
461	/* Update the old medium chain with the updated one. */
462	mtc.chain = newChain;
463	/* Update the progress info. */
464	updateProgressStats(mtc, fAttachLinked, uCount, uTotalWeight);
465	}
466
467	return rc;
468	}
469
470	HRESULT MachineCloneVMPrivate::queryMediasForAllStates(const RTCList<ComObjPtr<Machine> > &machineList, bool fAttachLinked, ULONG &uCount, ULONG &uTotalWeight)
471	{
472	/* In this case we create a exact copy of the original VM. This means just
473	* adding all directly and indirectly attached disk images to the worker
474	* list. */
475	HRESULT rc = S_OK;
476	for (size_t i = 0; i < machineList.size(); ++i)
477	{
478	const ComObjPtr<Machine> &machine = machineList.at(i);
479	/* If this is the Snapshot Machine we want to clone, we need to
480	* create a new diff file for the new "current state". */
481	const bool fCreateDiffs = (machine == pOldMachineState);
482	/* Add all attachments (and their parents) of the different
483	* machines to a worker list. */
484	SafeIfaceArray<IMediumAttachment> sfaAttachments;
485	rc = machine->COMGETTER(MediumAttachments)(ComSafeArrayAsOutParam(sfaAttachments));
486	if (FAILED(rc)) return rc;
487	for (size_t a = 0; a < sfaAttachments.size(); ++a)
488	{
489	const ComPtr<IMediumAttachment> &pAtt = sfaAttachments[a];
490	DeviceType_T type;
491	rc = pAtt->COMGETTER(Type)(&type);
492	if (FAILED(rc)) return rc;
493
494	/* Only harddisk's are of interest. */
495	if (type != DeviceType_HardDisk)
496	continue;
497
498	/* Valid medium attached? */
499	ComPtr<IMedium> pSrcMedium;
500	rc = pAtt->COMGETTER(Medium)(pSrcMedium.asOutParam());
501	if (FAILED(rc)) return rc;
502	if (pSrcMedium.isNull())
503	continue;
504
505	/* Build up a child->parent list of this attachment. (Note: we are
506	* not interested of any child's not attached to this VM. So this
507	* will not create a full copy of the base/child relationship.) */
508	MEDIUMTASKCHAIN mtc;
509	mtc.fCreateDiffs = fCreateDiffs;
510	mtc.fAttachLinked = fAttachLinked;
511
512	while (!pSrcMedium.isNull())
513	{
514	/* Refresh the state so that the file size get read. */
515	MediumState_T e;
516	rc = pSrcMedium->RefreshState(&e);
517	if (FAILED(rc)) return rc;
518	LONG64 lSize;
519	rc = pSrcMedium->COMGETTER(Size)(&lSize);
520	if (FAILED(rc)) return rc;
521
522	/* Save the current medium, for later cloning. */
523	MEDIUMTASK mt;
524	mt.uIdx = UINT32_MAX;
525	mt.pMedium = pSrcMedium;
526	mt.uWeight = (lSize + _1M - 1) / _1M;
527	mtc.chain.append(mt);
528
529	/* Query next parent. */
530	rc = pSrcMedium->COMGETTER(Parent)(pSrcMedium.asOutParam());
531	if (FAILED(rc)) return rc;
532	}
533	/* Update the progress info. */
534	updateProgressStats(mtc, fAttachLinked, uCount, uTotalWeight);
535	/* Append the list of images which have to be cloned. */
536	llMedias.append(mtc);
537	}
538	/* Add the save state files of this machine if there is one. */
539	rc = addSaveState(machine, uCount, uTotalWeight);
540	if (FAILED(rc)) return rc;
541	}
542	/* Build up the index list of the image chain. Unfortunately we can't do
543	* that in the previous loop, cause there we go from child -> parent and
544	* didn't know how many are between. */
545	for (size_t i = 0; i < llMedias.size(); ++i)
546	{
547	uint32_t uIdx = 0;
548	MEDIUMTASKCHAIN &mtc = llMedias.at(i);
549	for (size_t a = mtc.chain.size(); a > 0; --a)
550	mtc.chain[a - 1].uIdx = uIdx++;
551	}
552
553	return rc;
554	}
555
556	bool MachineCloneVMPrivate::findSnapshot(const settings::SnapshotsList &snl, const Guid &id, settings::Snapshot &sn) const
557	{
558	settings::SnapshotsList::const_iterator it;
559	for (it = snl.begin(); it != snl.end(); ++it)
560	{
561	if (it->uuid == id)
562	{
563	sn = (*it);
564	return true;
565	}
566	else if (!it->llChildSnapshots.empty())
567	{
568	if (findSnapshot(it->llChildSnapshots, id, sn))
569	return true;
570	}
571	}
572	return false;
573	}
574
575	void MachineCloneVMPrivate::updateMACAddresses(settings::NetworkAdaptersList &nwl) const
576	{
577	const bool fNotNAT = options.contains(CloneOptions_KeepNATMACs);
578	settings::NetworkAdaptersList::iterator it;
579	for (it = nwl.begin(); it != nwl.end(); ++it)
580	{
581	if ( fNotNAT
582	&& it->mode == NetworkAttachmentType_NAT)
583	continue;
584	Host::generateMACAddress(it->strMACAddress);
585	}
586	}
587
588	void MachineCloneVMPrivate::updateMACAddresses(settings::SnapshotsList &sl) const
589	{
590	settings::SnapshotsList::iterator it;
591	for (it = sl.begin(); it != sl.end(); ++it)
592	{
593	updateMACAddresses(it->hardware.llNetworkAdapters);
594	if (!it->llChildSnapshots.empty())
595	updateMACAddresses(it->llChildSnapshots);
596	}
597	}
598
599	void MachineCloneVMPrivate::updateStorageLists(settings::StorageControllersList &sc, const Bstr &bstrOldId, const Bstr &bstrNewId) const
600	{
601	settings::StorageControllersList::iterator it3;
602	for (it3 = sc.begin();
603	it3 != sc.end();
604	++it3)
605	{
606	settings::AttachedDevicesList &llAttachments = it3->llAttachedDevices;
607	settings::AttachedDevicesList::iterator it4;
608	for (it4 = llAttachments.begin();
609	it4 != llAttachments.end();
610	++it4)
611	{
612	if ( it4->deviceType == DeviceType_HardDisk
613	&& it4->uuid == bstrOldId)
614	{
615	it4->uuid = bstrNewId;
616	}
617	}
618	}
619	}
620
621	void MachineCloneVMPrivate::updateSnapshotStorageLists(settings::SnapshotsList &sl, const Bstr &bstrOldId, const Bstr &bstrNewId) const
622	{
623	settings::SnapshotsList::iterator it;
624	for ( it = sl.begin();
625	it != sl.end();
626	++it)
627	{
628	updateStorageLists(it->storage.llStorageControllers, bstrOldId, bstrNewId);
629	if (!it->llChildSnapshots.empty())
630	updateSnapshotStorageLists(it->llChildSnapshots, bstrOldId, bstrNewId);
631	}
632	}
633
634	void MachineCloneVMPrivate::updateStateFile(settings::SnapshotsList &snl, const Guid &id, const Utf8Str &strFile) const
635	{
636	settings::SnapshotsList::iterator it;
637	for (it = snl.begin(); it != snl.end(); ++it)
638	{
639	if (it->uuid == id)
640	it->strStateFile = strFile;
641	else if (!it->llChildSnapshots.empty())
642	updateStateFile(it->llChildSnapshots, id, strFile);
643	}
644	}
645
646	HRESULT MachineCloneVMPrivate::createDifferencingMedium(const ComObjPtr<Medium> &pParent, const Utf8Str &strSnapshotFolder, RTCList<ComObjPtr<Medium> > &newMedia, ComObjPtr<Medium> *ppDiff) const
647	{
648	HRESULT rc = S_OK;
649	try
650	{
651	Bstr bstrSrcId;
652	rc = pParent->COMGETTER(Id)(bstrSrcId.asOutParam());
653	if (FAILED(rc)) throw rc;
654	ComObjPtr<Medium> diff;
655	diff.createObject();
656	rc = diff->init(p->getVirtualBox(),
657	pParent->getPreferredDiffFormat(),
658	Utf8StrFmt("%s%c", strSnapshotFolder.c_str(), RTPATH_DELIMITER),
659	Guid::Empty, /* empty media registry */
660	NULL); /* pllRegistriesThatNeedSaving */
661	if (FAILED(rc)) throw rc;
662	MediumLockList *pMediumLockList(new MediumLockList());
663	rc = diff->createMediumLockList(true /* fFailIfInaccessible */,
664	true /* fMediumLockWrite */,
665	pParent,
666	*pMediumLockList);
667	if (FAILED(rc)) throw rc;
668	rc = pMediumLockList->Lock();
669	if (FAILED(rc)) throw rc;
670	/* this already registers the new diff image */
671	rc = pParent->createDiffStorage(diff, MediumVariant_Standard,
672	pMediumLockList,
673	NULL /* aProgress */,
674	true /* aWait */,
675	NULL); // pllRegistriesThatNeedSaving
676	delete pMediumLockList;
677	if (FAILED(rc)) throw rc;
678	/* Remember created medium. */
679	newMedia.append(diff);
680	*ppDiff = diff;
681	}
682	catch (HRESULT rc2)
683	{
684	rc = rc2;
685	}
686	catch (...)
687	{
688	rc = VirtualBox::handleUnexpectedExceptions(RT_SRC_POS);
689	}
690
691	return rc;
692	}
693
694	/* static */
695	int MachineCloneVMPrivate::copyStateFileProgress(unsigned uPercentage, void *pvUser)
696	{
697	ComObjPtr<Progress> pProgress = static_cast< ComObjPtr<Progress> >(pvUser);
698
699	BOOL fCanceled = false;
700	HRESULT rc = pProgress->COMGETTER(Canceled)(&fCanceled);
701	if (FAILED(rc)) return VERR_GENERAL_FAILURE;
702	/* If canceled by the user tell it to the copy operation. */
703	if (fCanceled) return VERR_CANCELLED;
704	/* Set the new process. */
705	rc = pProgress->SetCurrentOperationProgress(uPercentage);
706	if (FAILED(rc)) return VERR_GENERAL_FAILURE;
707
708	return VINF_SUCCESS;
709	}
710
711	// The public class
712	/////////////////////////////////////////////////////////////////////////////
713
714	MachineCloneVM::MachineCloneVM(ComObjPtr<Machine> pSrcMachine, ComObjPtr<Machine> pTrgMachine, CloneMode_T mode, const RTCList<CloneOptions_T> &opts)
715	: d_ptr(new MachineCloneVMPrivate(this, pSrcMachine, pTrgMachine, mode, opts))
716	{
717	}
718
719	MachineCloneVM::~MachineCloneVM()
720	{
721	delete d_ptr;
722	}
723
724	HRESULT MachineCloneVM::start(IProgress **pProgress)
725	{
726	DPTR(MachineCloneVM);
727	ComObjPtr<Machine> &p = d->p;
728
729	HRESULT rc;
730	try
731	{
732	/** @todo r=klaus this code cannot deal with someone crazy specifying
733	* IMachine corresponding to a mutable machine as d->pSrcMachine */
734	if (d->pSrcMachine->isSessionMachine())
735	throw p->setError(E_INVALIDARG, "The source machine is mutable");
736
737	/* Handle the special case that someone is requesting a _full_ clone
738	* with all snapshots (and the current state), but uses a snapshot
739	* machine (and not the current one) as source machine. In this case we
740	* just replace the source (snapshot) machine with the current machine. */
741	if ( d->mode == CloneMode_AllStates
742	&& d->pSrcMachine->isSnapshotMachine())
743	{
744	Bstr bstrSrcMachineId;
745	rc = d->pSrcMachine->COMGETTER(Id)(bstrSrcMachineId.asOutParam());
746	if (FAILED(rc)) throw rc;
747	ComPtr<IMachine> newSrcMachine;
748	rc = d->pSrcMachine->getVirtualBox()->FindMachine(bstrSrcMachineId.raw(), newSrcMachine.asOutParam());
749	if (FAILED(rc)) throw rc;
750	d->pSrcMachine = (Machine)(IMachine)newSrcMachine;
751	}
752	bool fSubtreeIncludesCurrent = false;
753	ComObjPtr<Machine> pCurrState;
754	if (d->mode == CloneMode_MachineAndChildStates)
755	{
756	if (d->pSrcMachine->isSnapshotMachine())
757	{
758	/* find machine object for current snapshot of current state */
759	Bstr bstrSrcMachineId;
760	rc = d->pSrcMachine->COMGETTER(Id)(bstrSrcMachineId.asOutParam());
761	if (FAILED(rc)) throw rc;
762	ComPtr<IMachine> pCurr;
763	rc = d->pSrcMachine->getVirtualBox()->FindMachine(bstrSrcMachineId.raw(), pCurr.asOutParam());
764	if (FAILED(rc)) throw rc;
765	if (pCurr.isNull())
766	throw p->setError(VBOX_E_OBJECT_NOT_FOUND);
767	pCurrState = (Machine )(IMachine )pCurr;
768	ComPtr<ISnapshot> pSnapshot;
769	rc = pCurrState->COMGETTER(CurrentSnapshot)(pSnapshot.asOutParam());
770	if (FAILED(rc)) throw rc;
771	if (pSnapshot.isNull())
772	throw p->setError(VBOX_E_OBJECT_NOT_FOUND);
773	ComPtr<IMachine> pCurrSnapMachine;
774	rc = pSnapshot->COMGETTER(Machine)(pCurrSnapMachine.asOutParam());
775	if (FAILED(rc)) throw rc;
776	if (pCurrSnapMachine.isNull())
777	throw p->setError(VBOX_E_OBJECT_NOT_FOUND);
778
779	/* now check if there is a parent chain which leads to the
780	* snapshot machine defining the subtree. */
781	while (!pSnapshot.isNull())
782	{
783	ComPtr<IMachine> pSnapMachine;
784	rc = pSnapshot->COMGETTER(Machine)(pSnapMachine.asOutParam());
785	if (FAILED(rc)) throw rc;
786	if (pSnapMachine.isNull())
787	throw p->setError(VBOX_E_OBJECT_NOT_FOUND);
788	if (pSnapMachine == d->pSrcMachine)
789	{
790	fSubtreeIncludesCurrent = true;
791	break;
792	}
793	rc = pSnapshot->COMGETTER(Parent)(pSnapshot.asOutParam());
794	if (FAILED(rc)) throw rc;
795	}
796	}
797	else
798	{
799	/* If the subtree is only the Current State simply use the
800	* 'machine' case for cloning. It is easier to understand. */
801	d->mode = CloneMode_MachineState;
802	}
803	}
804
805	/* Lock the target machine early (so nobody mess around with it in the meantime). */
806	AutoWriteLock trgLock(d->pTrgMachine COMMA_LOCKVAL_SRC_POS);
807
808	if (d->pSrcMachine->isSnapshotMachine())
809	d->snapshotId = d->pSrcMachine->getSnapshotId();
810
811	/* Add the current machine and all snapshot machines below this machine
812	* in a list for further processing. */
813	RTCList< ComObjPtr<Machine> > machineList;
814
815	/* Include current state? */
816	if ( d->mode == CloneMode_MachineState
817	\|\| d->mode == CloneMode_AllStates)
818	machineList.append(d->pSrcMachine);
819	/* Should be done a depth copy with all child snapshots? */
820	if ( d->mode == CloneMode_MachineAndChildStates
821	\|\| d->mode == CloneMode_AllStates)
822	{
823	ULONG cSnapshots = 0;
824	rc = d->pSrcMachine->COMGETTER(SnapshotCount)(&cSnapshots);
825	if (FAILED(rc)) throw rc;
826	if (cSnapshots > 0)
827	{
828	Utf8Str id;
829	if (d->mode == CloneMode_MachineAndChildStates)
830	id = d->snapshotId.toString();
831	ComPtr<ISnapshot> pSnapshot;
832	rc = d->pSrcMachine->FindSnapshot(Bstr(id).raw(), pSnapshot.asOutParam());
833	if (FAILED(rc)) throw rc;
834	rc = d->createMachineList(pSnapshot, machineList);
835	if (FAILED(rc)) throw rc;
836	if (d->mode == CloneMode_MachineAndChildStates)
837	{
838	if (fSubtreeIncludesCurrent)
839	{
840	if (pCurrState.isNull())
841	throw p->setError(VBOX_E_OBJECT_NOT_FOUND);
842	machineList.append(pCurrState);
843	}
844	else
845	{
846	rc = pSnapshot->COMGETTER(Machine)(d->pOldMachineState.asOutParam());
847	if (FAILED(rc)) throw rc;
848	}
849	}
850	}
851	}
852
853	/* We have different approaches for getting the medias which needs to
854	* be replicated based on the clone mode the user requested (this is
855	* mostly about the full clone mode).
856	* MachineState:
857	* - Only the images which are directly attached to an source VM will
858	* be cloned. Any parent disks in the original chain will be merged
859	* into the final cloned disk.
860	* MachineAndChildStates:
861	* - In this case we search for images which have more than one
862	* children in the cloned VM or are directly attached to the new VM.
863	* All others will be merged into the remaining images which are
864	* cloned.
865	* This case is the most complicated one and needs several iterations
866	* to make sure we are only cloning images which are really
867	* necessary.
868	* AllStates:
869	* - All disks which are directly or indirectly attached to the
870	* original VM are cloned.
871	*
872	* Note: If you change something generic in one of the methods its
873	* likely that it need to be changed in the others as well! */
874	ULONG uCount = 2; /* One init task and the machine creation. */
875	ULONG uTotalWeight = 2; /* The init task and the machine creation is worth one. */
876	bool fAttachLinked = d->options.contains(CloneOptions_Link); /* Linked clones requested? */
877	switch (d->mode)
878	{
879	case CloneMode_MachineState: d->queryMediasForMachineState(machineList, fAttachLinked, uCount, uTotalWeight); break;
880	case CloneMode_MachineAndChildStates: d->queryMediasForMachineAndChildStates(machineList, fAttachLinked, uCount, uTotalWeight); break;
881	case CloneMode_AllStates: d->queryMediasForAllStates(machineList, fAttachLinked, uCount, uTotalWeight); break;
882	}
883
884	/* Now create the progress project, so the user knows whats going on. */
885	rc = d->pProgress.createObject();
886	if (FAILED(rc)) throw rc;
887	rc = d->pProgress->init(p->getVirtualBox(),
888	static_cast<IMachine>(d->pSrcMachine) / aInitiator */,
889	Bstr(p->tr("Cloning Machine")).raw(),
890	true /* fCancellable */,
891	uCount,
892	uTotalWeight,
893	Bstr(p->tr("Initialize Cloning")).raw(),
894	1);
895	if (FAILED(rc)) throw rc;
896
897	int vrc = d->startWorker();
898
899	if (RT_FAILURE(vrc))
900	p->setError(VBOX_E_IPRT_ERROR, "Could not create machine clone thread (%Rrc)", vrc);
901	}
902	catch (HRESULT rc2)
903	{
904	rc = rc2;
905	}
906
907	if (SUCCEEDED(rc))
908	d->pProgress.queryInterfaceTo(pProgress);
909
910	return rc;
911	}
912
913	HRESULT MachineCloneVM::run()
914	{
915	DPTR(MachineCloneVM);
916	ComObjPtr<Machine> &p = d->p;
917
918	AutoCaller autoCaller(p);
919	if (FAILED(autoCaller.rc())) return autoCaller.rc();
920
921	AutoReadLock srcLock(p COMMA_LOCKVAL_SRC_POS);
922	AutoWriteLock trgLock(d->pTrgMachine COMMA_LOCKVAL_SRC_POS);
923
924	HRESULT rc = S_OK;
925
926	/*
927	* Todo:
928	* - What about log files?
929	*/
930
931	/* Where should all the media go? */
932	Utf8Str strTrgSnapshotFolder;
933	Utf8Str strTrgMachineFolder = d->pTrgMachine->getSettingsFileFull();
934	strTrgMachineFolder.stripFilename();
935
936	RTCList<ComObjPtr<Medium> > newMedia; /* All created images */
937	RTCList<Utf8Str> newFiles; /* All extra created files (save states, ...) */
938	try
939	{
940	/* Copy all the configuration from this machine to an empty
941	* configuration dataset. */
942	settings::MachineConfigFile trgMCF = *d->pSrcMachine->mData->pMachineConfigFile;
943
944	/* Reset media registry. */
945	trgMCF.mediaRegistry.llHardDisks.clear();
946	/* If we got a valid snapshot id, replace the hardware/storage section
947	* with the stuff from the snapshot. */
948	settings::Snapshot sn;
949	if (!d->snapshotId.isEmpty())
950	if (!d->findSnapshot(trgMCF.llFirstSnapshot, d->snapshotId, sn))
951	throw p->setError(E_FAIL,
952	p->tr("Could not find data to snapshots '%s'"), d->snapshotId.toString().c_str());
953
954
955
956	if (d->mode == CloneMode_MachineState)
957	{
958	if (!sn.uuid.isEmpty())
959	{
960	trgMCF.hardwareMachine = sn.hardware;
961	trgMCF.storageMachine = sn.storage;
962	}
963
964	/* Remove any hint on snapshots. */
965	trgMCF.llFirstSnapshot.clear();
966	trgMCF.uuidCurrentSnapshot.clear();
967	}
968	else if ( d->mode == CloneMode_MachineAndChildStates
969	&& !sn.uuid.isEmpty())
970	{
971	if (!d->pOldMachineState.isNull())
972	{
973	/* Copy the snapshot data to the current machine. */
974	trgMCF.hardwareMachine = sn.hardware;
975	trgMCF.storageMachine = sn.storage;
976
977	/* Current state is under root snapshot. */
978	trgMCF.uuidCurrentSnapshot = sn.uuid;
979	/* There will be created a new differencing image based on this
980	* snapshot. So reset the modified state. */
981	trgMCF.fCurrentStateModified = false;
982	}
983	/* The snapshot will be the root one. */
984	trgMCF.llFirstSnapshot.clear();
985	trgMCF.llFirstSnapshot.push_back(sn);
986	}
987
988	/* Generate new MAC addresses for all machines when not forbidden. */
989	if (!d->options.contains(CloneOptions_KeepAllMACs))
990	{
991	d->updateMACAddresses(trgMCF.hardwareMachine.llNetworkAdapters);
992	d->updateMACAddresses(trgMCF.llFirstSnapshot);
993	}
994
995	/* When the current snapshot folder is absolute we reset it to the
996	* default relative folder. */
997	if (RTPathStartsWithRoot(trgMCF.machineUserData.strSnapshotFolder.c_str()))
998	trgMCF.machineUserData.strSnapshotFolder = "Snapshots";
999	trgMCF.strStateFile = "";
1000	/* Set the new name. */
1001	const Utf8Str strOldVMName = trgMCF.machineUserData.strName;
1002	trgMCF.machineUserData.strName = d->pTrgMachine->mUserData->s.strName;
1003	trgMCF.uuid = d->pTrgMachine->mData->mUuid;
1004
1005	Bstr bstrSrcSnapshotFolder;
1006	rc = d->pSrcMachine->COMGETTER(SnapshotFolder)(bstrSrcSnapshotFolder.asOutParam());
1007	if (FAILED(rc)) throw rc;
1008	/* The absolute name of the snapshot folder. */
1009	strTrgSnapshotFolder = Utf8StrFmt("%s%c%s", strTrgMachineFolder.c_str(), RTPATH_DELIMITER, trgMCF.machineUserData.strSnapshotFolder.c_str());
1010
1011	/* Should we rename the disk names. */
1012	bool fKeepDiskNames = d->options.contains(CloneOptions_KeepDiskNames);
1013
1014	/* We need to create a map with the already created medias. This is
1015	* necessary, cause different snapshots could have the same
1016	* parents/parent chain. If a medium is in this map already, it isn't
1017	* cloned a second time, but simply used. */
1018	typedef std::map<Utf8Str, ComObjPtr<Medium> > TStrMediumMap;
1019	typedef std::pair<Utf8Str, ComObjPtr<Medium> > TStrMediumPair;
1020	TStrMediumMap map;
1021	GuidList llRegistriesThatNeedSaving;
1022	size_t cDisks = 0;
1023	for (size_t i = 0; i < d->llMedias.size(); ++i)
1024	{
1025	const MEDIUMTASKCHAIN &mtc = d->llMedias.at(i);
1026	ComObjPtr<Medium> pNewParent;
1027	uint32_t uSrcParentIdx = UINT32_MAX;
1028	uint32_t uTrgParentIdx = UINT32_MAX;
1029	for (size_t a = mtc.chain.size(); a > 0; --a)
1030	{
1031	const MEDIUMTASK &mt = mtc.chain.at(a - 1);
1032	ComPtr<IMedium> pMedium = mt.pMedium;
1033
1034	Bstr bstrSrcName;
1035	rc = pMedium->COMGETTER(Name)(bstrSrcName.asOutParam());
1036	if (FAILED(rc)) throw rc;
1037
1038	rc = d->pProgress->SetNextOperation(BstrFmt(p->tr("Cloning Disk '%ls' ..."), bstrSrcName.raw()).raw(), mt.uWeight);
1039	if (FAILED(rc)) throw rc;
1040
1041	Bstr bstrSrcId;
1042	rc = pMedium->COMGETTER(Id)(bstrSrcId.asOutParam());
1043	if (FAILED(rc)) throw rc;
1044
1045	if (mtc.fAttachLinked)
1046	{
1047	IMedium *pTmp = pMedium;
1048	ComObjPtr<Medium> pLMedium = static_cast<Medium*>(pTmp);
1049	if (pLMedium.isNull())
1050	throw p->setError(VBOX_E_OBJECT_NOT_FOUND);
1051	ComObjPtr<Medium> pBase = pLMedium->getBase();
1052	if (pBase->isReadOnly())
1053	{
1054	ComObjPtr<Medium> pDiff;
1055	/* create the diff under the snapshot medium */
1056	rc = d->createDifferencingMedium(pLMedium, strTrgSnapshotFolder,
1057	newMedia, &pDiff);
1058	if (FAILED(rc)) throw rc;
1059	map.insert(TStrMediumPair(Utf8Str(bstrSrcId), pDiff));
1060	/* diff image has to be used... */
1061	pNewParent = pDiff;
1062	}
1063	else
1064	{
1065	/* Attach the medium directly, as its type is not
1066	* subject to diff creation. */
1067	newMedia.append(pLMedium);
1068	map.insert(TStrMediumPair(Utf8Str(bstrSrcId), pLMedium));
1069	pNewParent = pLMedium;
1070	}
1071	}
1072	else
1073	{
1074	/* Is a clone already there? */
1075	TStrMediumMap::iterator it = map.find(Utf8Str(bstrSrcId));
1076	if (it != map.end())
1077	pNewParent = it->second;
1078	else
1079	{
1080	ComPtr<IMediumFormat> pSrcFormat;
1081	rc = pMedium->COMGETTER(MediumFormat)(pSrcFormat.asOutParam());
1082	ULONG uSrcCaps = 0;
1083	rc = pSrcFormat->COMGETTER(Capabilities)(&uSrcCaps);
1084	if (FAILED(rc)) throw rc;
1085
1086	/* Default format? */
1087	Utf8Str strDefaultFormat;
1088	p->mParent->getDefaultHardDiskFormat(strDefaultFormat);
1089	Bstr bstrSrcFormat(strDefaultFormat);
1090	ULONG srcVar = MediumVariant_Standard;
1091	/* Is the source file based? */
1092	if ((uSrcCaps & MediumFormatCapabilities_File) == MediumFormatCapabilities_File)
1093	{
1094	/* Yes, just use the source format. Otherwise the defaults
1095	* will be used. */
1096	rc = pMedium->COMGETTER(Format)(bstrSrcFormat.asOutParam());
1097	if (FAILED(rc)) throw rc;
1098	rc = pMedium->COMGETTER(Variant)(&srcVar);
1099	if (FAILED(rc)) throw rc;
1100	}
1101
1102	Guid newId;
1103	newId.create();
1104	Utf8Str strNewName(bstrSrcName);
1105	if (!fKeepDiskNames)
1106	{
1107	Utf8Str strSrcTest = bstrSrcName;
1108	/* Check if we have to use another name. */
1109	if (!mt.strBaseName.isEmpty())
1110	strSrcTest = mt.strBaseName;
1111	strSrcTest.stripExt();
1112	/* If the old disk name was in {uuid} format we also
1113	* want the new name in this format, but with the
1114	* updated id of course. If the old disk was called
1115	* like the VM name, we change it to the new VM name.
1116	* For all other disks we rename them with this
1117	* template: "new name-disk1.vdi". */
1118	if (strSrcTest == strOldVMName)
1119	strNewName = Utf8StrFmt("%s%s", trgMCF.machineUserData.strName.c_str(), RTPathExt(Utf8Str(bstrSrcName).c_str()));
1120	else if ( strSrcTest.startsWith("{")
1121	&& strSrcTest.endsWith("}"))
1122	{
1123	strSrcTest = strSrcTest.substr(1, strSrcTest.length() - 2);
1124	if (isValidGuid(strSrcTest))
1125	strNewName = Utf8StrFmt("%s%s", newId.toStringCurly().c_str(), RTPathExt(strNewName.c_str()));
1126	}
1127	else
1128	strNewName = Utf8StrFmt("%s-disk%d%s", trgMCF.machineUserData.strName.c_str(), ++cDisks, RTPathExt(Utf8Str(bstrSrcName).c_str()));
1129	}
1130
1131	/* Check if this medium comes from the snapshot folder, if
1132	* so, put it there in the cloned machine as well.
1133	* Otherwise it goes to the machine folder. */
1134	Bstr bstrSrcPath;
1135	Utf8Str strFile = Utf8StrFmt("%s%c%s", strTrgMachineFolder.c_str(), RTPATH_DELIMITER, strNewName.c_str());
1136	rc = pMedium->COMGETTER(Location)(bstrSrcPath.asOutParam());
1137	if (FAILED(rc)) throw rc;
1138	if ( !bstrSrcPath.isEmpty()
1139	&& RTPathStartsWith(Utf8Str(bstrSrcPath).c_str(), Utf8Str(bstrSrcSnapshotFolder).c_str())
1140	&& (fKeepDiskNames \|\| mt.strBaseName.isEmpty()))
1141	strFile = Utf8StrFmt("%s%c%s", strTrgSnapshotFolder.c_str(), RTPATH_DELIMITER, strNewName.c_str());
1142
1143	/* Start creating the clone. */
1144	ComObjPtr<Medium> pTarget;
1145	rc = pTarget.createObject();
1146	if (FAILED(rc)) throw rc;
1147
1148	rc = pTarget->init(p->mParent,
1149	Utf8Str(bstrSrcFormat),
1150	strFile,
1151	Guid::Empty, /* empty media registry */
1152	NULL /* llRegistriesThatNeedSaving */);
1153	if (FAILED(rc)) throw rc;
1154
1155	/* Update the new uuid. */
1156	pTarget->updateId(newId);
1157
1158	srcLock.release();
1159	/* Do the disk cloning. */
1160	ComPtr<IProgress> progress2;
1161
1162	ComObjPtr<Medium> pLMedium = static_cast<Medium>((IMedium)pMedium);
1163	rc = pLMedium->cloneToEx(pTarget,
1164	srcVar,
1165	pNewParent,
1166	progress2.asOutParam(),
1167	uSrcParentIdx,
1168	uTrgParentIdx);
1169	if (FAILED(rc)) throw rc;
1170
1171	/* Wait until the async process has finished. */
1172	rc = d->pProgress->WaitForAsyncProgressCompletion(progress2);
1173	srcLock.acquire();
1174	if (FAILED(rc)) throw rc;
1175
1176	/* Check the result of the async process. */
1177	LONG iRc;
1178	rc = progress2->COMGETTER(ResultCode)(&iRc);
1179	if (FAILED(rc)) throw rc;
1180	/* If the thread of the progress object has an error, then
1181	* retrieve the error info from there, or it'll be lost. */
1182	if (FAILED(iRc))
1183	throw p->setError(ProgressErrorInfo(progress2));
1184	/* Remember created medium. */
1185	newMedia.append(pTarget);
1186	/* Get the medium type from the source and set it to the
1187	* new medium. */
1188	MediumType_T type;
1189	rc = pMedium->COMGETTER(Type)(&type);
1190	if (FAILED(rc)) throw rc;
1191	rc = pTarget->COMSETTER(Type)(type);
1192	if (FAILED(rc)) throw rc;
1193	map.insert(TStrMediumPair(Utf8Str(bstrSrcId), pTarget));
1194	/* register the new harddisk */
1195	{
1196	AutoWriteLock tlock(p->mParent->getMediaTreeLockHandle() COMMA_LOCKVAL_SRC_POS);
1197	rc = p->mParent->registerHardDisk(pTarget, NULL /* pllRegistriesThatNeedSaving */);
1198	if (FAILED(rc)) throw rc;
1199	}
1200	/* This medium becomes the parent of the next medium in the
1201	* chain. */
1202	pNewParent = pTarget;
1203	}
1204	}
1205	/* Save the current source medium index as the new parent
1206	* medium index. */
1207	uSrcParentIdx = mt.uIdx;
1208	/* Simply increase the target index. */
1209	++uTrgParentIdx;
1210	}
1211
1212	Bstr bstrSrcId;
1213	rc = mtc.chain.first().pMedium->COMGETTER(Id)(bstrSrcId.asOutParam());
1214	if (FAILED(rc)) throw rc;
1215	Bstr bstrTrgId;
1216	rc = pNewParent->COMGETTER(Id)(bstrTrgId.asOutParam());
1217	if (FAILED(rc)) throw rc;
1218	/* update snapshot configuration */
1219	d->updateSnapshotStorageLists(trgMCF.llFirstSnapshot, bstrSrcId, bstrTrgId);
1220
1221	/* create new 'Current State' diff for caller defined place */
1222	if (mtc.fCreateDiffs)
1223	{
1224	const MEDIUMTASK &mt = mtc.chain.first();
1225	ComObjPtr<Medium> pLMedium = static_cast<Medium>((IMedium)mt.pMedium);
1226	if (pLMedium.isNull())
1227	throw p->setError(E_POINTER, "Returned object is empty");
1228	ComObjPtr<Medium> pBase = pLMedium->getBase();
1229	if (pBase->isReadOnly())
1230	{
1231	ComObjPtr<Medium> pDiff;
1232	rc = d->createDifferencingMedium(pNewParent, strTrgSnapshotFolder,
1233	newMedia, &pDiff);
1234	if (FAILED(rc)) throw rc;
1235	/* diff image has to be used... */
1236	pNewParent = pDiff;
1237	}
1238	else
1239	{
1240	/* Attach the medium directly, as its type is not
1241	* subject to diff creation. */
1242	newMedia.append(pNewParent);
1243	}
1244
1245	rc = pNewParent->COMGETTER(Id)(bstrTrgId.asOutParam());
1246	if (FAILED(rc)) throw rc;
1247	}
1248	/* update 'Current State' configuration */
1249	d->updateStorageLists(trgMCF.storageMachine.llStorageControllers, bstrSrcId, bstrTrgId);
1250	}
1251	/* Make sure all disks know of the new machine uuid. We do this last to
1252	* be able to change the medium type above. */
1253	for (size_t i = newMedia.size(); i > 0; --i)
1254	{
1255	const ComObjPtr<Medium> &pMedium = newMedia.at(i - 1);
1256	AutoCaller mac(pMedium);
1257	if (FAILED(mac.rc())) throw mac.rc();
1258	AutoWriteLock mlock(pMedium COMMA_LOCKVAL_SRC_POS);
1259	Guid uuid = d->pTrgMachine->mData->mUuid;
1260	if (d->options.contains(CloneOptions_Link))
1261	{
1262	ComObjPtr<Medium> pParent = pMedium->getParent();
1263	mlock.release();
1264	if (!pParent.isNull())
1265	{
1266	AutoCaller mac2(pParent);
1267	if (FAILED(mac2.rc())) throw mac2.rc();
1268	AutoReadLock mlock2(pParent COMMA_LOCKVAL_SRC_POS);
1269	if (pParent->getFirstRegistryMachineId(uuid))
1270	VirtualBox::addGuidToListUniquely(llRegistriesThatNeedSaving, uuid);
1271	}
1272	mlock.acquire();
1273	}
1274	pMedium->addRegistry(uuid, false /* fRecurse */);
1275	}
1276	/* Check if a snapshot folder is necessary and if so doesn't already
1277	* exists. */
1278	if ( !d->llSaveStateFiles.isEmpty()
1279	&& !RTDirExists(strTrgSnapshotFolder.c_str()))
1280	{
1281	int vrc = RTDirCreateFullPath(strTrgSnapshotFolder.c_str(), 0777);
1282	if (RT_FAILURE(vrc))
1283	throw p->setError(VBOX_E_IPRT_ERROR,
1284	p->tr("Could not create snapshots folder '%s' (%Rrc)"), strTrgSnapshotFolder.c_str(), vrc);
1285	}
1286	/* Clone all save state files. */
1287	for (size_t i = 0; i < d->llSaveStateFiles.size(); ++i)
1288	{
1289	SAVESTATETASK sst = d->llSaveStateFiles.at(i);
1290	const Utf8Str &strTrgSaveState = Utf8StrFmt("%s%c%s", strTrgSnapshotFolder.c_str(), RTPATH_DELIMITER, RTPathFilename(sst.strSaveStateFile.c_str()));
1291
1292	/* Move to next sub-operation. */
1293	rc = d->pProgress->SetNextOperation(BstrFmt(p->tr("Copy save state file '%s' ..."), RTPathFilename(sst.strSaveStateFile.c_str())).raw(), sst.uWeight);
1294	if (FAILED(rc)) throw rc;
1295	/* Copy the file only if it was not copied already. */
1296	if (!newFiles.contains(strTrgSaveState.c_str()))
1297	{
1298	int vrc = RTFileCopyEx(sst.strSaveStateFile.c_str(), strTrgSaveState.c_str(), 0, MachineCloneVMPrivate::copyStateFileProgress, &d->pProgress);
1299	if (RT_FAILURE(vrc))
1300	throw p->setError(VBOX_E_IPRT_ERROR,
1301	p->tr("Could not copy state file '%s' to '%s' (%Rrc)"), sst.strSaveStateFile.c_str(), strTrgSaveState.c_str(), vrc);
1302	newFiles.append(strTrgSaveState);
1303	}
1304	/* Update the path in the configuration either for the current
1305	* machine state or the snapshots. */
1306	if (sst.snapshotUuid.isEmpty())
1307	trgMCF.strStateFile = strTrgSaveState;
1308	else
1309	d->updateStateFile(trgMCF.llFirstSnapshot, sst.snapshotUuid, strTrgSaveState);
1310	}
1311
1312	{
1313	rc = d->pProgress->SetNextOperation(BstrFmt(p->tr("Create Machine Clone '%s' ..."), trgMCF.machineUserData.strName.c_str()).raw(), 1);
1314	if (FAILED(rc)) throw rc;
1315	/* After modifying the new machine config, we can copy the stuff
1316	* over to the new machine. The machine have to be mutable for
1317	* this. */
1318	rc = d->pTrgMachine->checkStateDependency(p->MutableStateDep);
1319	if (FAILED(rc)) throw rc;
1320	rc = d->pTrgMachine->loadMachineDataFromSettings(trgMCF,
1321	&d->pTrgMachine->mData->mUuid);
1322	if (FAILED(rc)) throw rc;
1323	/* save all VM data */
1324	bool fNeedsGlobalSaveSettings = false;
1325	rc = d->pTrgMachine->saveSettings(&fNeedsGlobalSaveSettings, Machine::SaveS_Force);
1326	if (FAILED(rc)) throw rc;
1327	/* Release all locks */
1328	trgLock.release();
1329	srcLock.release();
1330	if (fNeedsGlobalSaveSettings)
1331	{
1332	/* save the global settings; for that we should hold only the
1333	* VirtualBox lock */
1334	AutoWriteLock vlock(p->mParent COMMA_LOCKVAL_SRC_POS);
1335	rc = p->mParent->saveSettings();
1336	if (FAILED(rc)) throw rc;
1337	}
1338	}
1339
1340	/* Any additional machines need saving? */
1341	if (!llRegistriesThatNeedSaving.empty())
1342	{
1343	rc = p->mParent->saveRegistries(llRegistriesThatNeedSaving);
1344	if (FAILED(rc)) throw rc;
1345	}
1346	}
1347	catch (HRESULT rc2)
1348	{
1349	rc = rc2;
1350	}
1351	catch (...)
1352	{
1353	rc = VirtualBox::handleUnexpectedExceptions(RT_SRC_POS);
1354	}
1355
1356	MultiResult mrc(rc);
1357	/* Cleanup on failure (CANCEL also) */
1358	if (FAILED(rc))
1359	{
1360	int vrc = VINF_SUCCESS;
1361	/* Delete all created files. */
1362	for (size_t i = 0; i < newFiles.size(); ++i)
1363	{
1364	vrc = RTFileDelete(newFiles.at(i).c_str());
1365	if (RT_FAILURE(vrc))
1366	mrc = p->setError(VBOX_E_IPRT_ERROR, p->tr("Could not delete file '%s' (%Rrc)"), newFiles.at(i).c_str(), vrc);
1367	}
1368	/* Delete all already created medias. (Reverse, cause there could be
1369	* parent->child relations.) */
1370	for (size_t i = newMedia.size(); i > 0; --i)
1371	{
1372	const ComObjPtr<Medium> &pMedium = newMedia.at(i - 1);
1373	mrc = pMedium->deleteStorage(NULL /* aProgress */,
1374	true /* aWait */,
1375	NULL /* llRegistriesThatNeedSaving */);
1376	pMedium->Close();
1377	}
1378	/* Delete the snapshot folder when not empty. */
1379	if (!strTrgSnapshotFolder.isEmpty())
1380	RTDirRemove(strTrgSnapshotFolder.c_str());
1381	/* Delete the machine folder when not empty. */
1382	RTDirRemove(strTrgMachineFolder.c_str());
1383	}
1384
1385	return mrc;
1386	}
1387
1388	void MachineCloneVM::destroy()
1389	{
1390	delete this;
1391	}
1392

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/Main/src-server/MachineImplCloneVM.cpp@ 38534

Download in other formats: