ApplianceImplExport.cpp@ 44824

Last change on this file since 44824 was 44528, checked in by vboxsync, 12 years ago
header (C) fixes
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 90.1 KB

Line
1	/* $Id: ApplianceImplExport.cpp 44528 2013-02-04 14:27:54Z vboxsync $ */
2	/** @file
3	*
4	* IAppliance and IVirtualSystem COM class implementations.
5	*/
6
7	/*
8	* Copyright (C) 2008-2012 Oracle Corporation
9	*
10	* This file is part of VirtualBox Open Source Edition (OSE), as
11	* available from http://www.virtualbox.org. This file is free software;
12	* you can redistribute it and/or modify it under the terms of the GNU
13	* General Public License (GPL) as published by the Free Software
14	* Foundation, in version 2 as it comes in the "COPYING" file of the
15	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
16	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
17	*/
18
19	#include <iprt/path.h>
20	#include <iprt/dir.h>
21	#include <iprt/param.h>
22	#include <iprt/s3.h>
23	#include <iprt/manifest.h>
24	#include <iprt/tar.h>
25	#include <iprt/stream.h>
26
27	#include <VBox/version.h>
28
29	#include "ApplianceImpl.h"
30	#include "VirtualBoxImpl.h"
31
32	#include "ProgressImpl.h"
33	#include "MachineImpl.h"
34	#include "MediumImpl.h"
35	#include "MediumFormatImpl.h"
36	#include "Global.h"
37	#include "SystemPropertiesImpl.h"
38
39	#include "AutoCaller.h"
40	#include "Logging.h"
41
42	#include "ApplianceImplPrivate.h"
43
44	using namespace std;
45
46	////////////////////////////////////////////////////////////////////////////////
47	//
48	// IMachine public methods
49	//
50	////////////////////////////////////////////////////////////////////////////////
51
52	// This code is here so we won't have to include the appliance headers in the
53	// IMachine implementation, and we also need to access private appliance data.
54
55	/**
56	* Public method implementation.
57	* @param appliance
58	* @return
59	*/
60	STDMETHODIMP Machine::Export(IAppliance aAppliance, IN_BSTR location, IVirtualSystemDescription *aDescription)
61	{
62	HRESULT rc = S_OK;
63
64	if (!aAppliance)
65	return E_POINTER;
66
67	AutoCaller autoCaller(this);
68	if (FAILED(autoCaller.rc())) return autoCaller.rc();
69
70	ComObjPtr<VirtualSystemDescription> pNewDesc;
71
72	try
73	{
74	Appliance pAppliance = static_cast<Appliance>(aAppliance);
75	AutoCaller autoCaller1(pAppliance);
76	if (FAILED(autoCaller1.rc())) return autoCaller1.rc();
77
78	LocationInfo locInfo;
79	parseURI(location, locInfo);
80	// create a new virtual system to store in the appliance
81	rc = pNewDesc.createObject();
82	if (FAILED(rc)) throw rc;
83	rc = pNewDesc->init();
84	if (FAILED(rc)) throw rc;
85
86	// store the machine object so we can dump the XML in Appliance::Write()
87	pNewDesc->m->pMachine = this;
88
89	// now fill it with description items
90	Bstr bstrName1;
91	Bstr bstrDescription;
92	Bstr bstrGuestOSType;
93	uint32_t cCPUs;
94	uint32_t ulMemSizeMB;
95	BOOL fUSBEnabled;
96	BOOL fAudioEnabled;
97	AudioControllerType_T audioController;
98
99	ComPtr<IUSBController> pUsbController;
100	ComPtr<IAudioAdapter> pAudioAdapter;
101
102	// first, call the COM methods, as they request locks
103	rc = COMGETTER(USBController)(pUsbController.asOutParam());
104	if (FAILED(rc))
105	fUSBEnabled = false;
106	else
107	rc = pUsbController->COMGETTER(Enabled)(&fUSBEnabled);
108
109	// request the machine lock while accessing internal members
110	AutoReadLock alock1(this COMMA_LOCKVAL_SRC_POS);
111
112	pAudioAdapter = mAudioAdapter;
113	rc = pAudioAdapter->COMGETTER(Enabled)(&fAudioEnabled);
114	if (FAILED(rc)) throw rc;
115	rc = pAudioAdapter->COMGETTER(AudioController)(&audioController);
116	if (FAILED(rc)) throw rc;
117
118	// get name
119	Utf8Str strVMName = mUserData->s.strName;
120	// get description
121	Utf8Str strDescription = mUserData->s.strDescription;
122	// get guest OS
123	Utf8Str strOsTypeVBox = mUserData->s.strOsType;
124	// CPU count
125	cCPUs = mHWData->mCPUCount;
126	// memory size in MB
127	ulMemSizeMB = mHWData->mMemorySize;
128	// VRAM size?
129	// BIOS settings?
130	// 3D acceleration enabled?
131	// hardware virtualization enabled?
132	// nested paging enabled?
133	// HWVirtExVPIDEnabled?
134	// PAEEnabled?
135	// snapshotFolder?
136	// VRDPServer?
137
138	/* Guest OS type */
139	ovf::CIMOSType_T cim = convertVBoxOSType2CIMOSType(strOsTypeVBox.c_str());
140	pNewDesc->addEntry(VirtualSystemDescriptionType_OS,
141	"",
142	Utf8StrFmt("%RI32", cim),
143	strOsTypeVBox);
144
145	/* VM name */
146	pNewDesc->addEntry(VirtualSystemDescriptionType_Name,
147	"",
148	strVMName,
149	strVMName);
150
151	// description
152	pNewDesc->addEntry(VirtualSystemDescriptionType_Description,
153	"",
154	strDescription,
155	strDescription);
156
157	/* CPU count*/
158	Utf8Str strCpuCount = Utf8StrFmt("%RI32", cCPUs);
159	pNewDesc->addEntry(VirtualSystemDescriptionType_CPU,
160	"",
161	strCpuCount,
162	strCpuCount);
163
164	/* Memory */
165	Utf8Str strMemory = Utf8StrFmt("%RI64", (uint64_t)ulMemSizeMB * _1M);
166	pNewDesc->addEntry(VirtualSystemDescriptionType_Memory,
167	"",
168	strMemory,
169	strMemory);
170
171	// the one VirtualBox IDE controller has two channels with two ports each, which is
172	// considered two IDE controllers with two ports each by OVF, so export it as two
173	int32_t lIDEControllerPrimaryIndex = 0;
174	int32_t lIDEControllerSecondaryIndex = 0;
175	int32_t lSATAControllerIndex = 0;
176	int32_t lSCSIControllerIndex = 0;
177
178	/* Fetch all available storage controllers */
179	com::SafeIfaceArray<IStorageController> nwControllers;
180	rc = COMGETTER(StorageControllers)(ComSafeArrayAsOutParam(nwControllers));
181	if (FAILED(rc)) throw rc;
182
183	ComPtr<IStorageController> pIDEController;
184	ComPtr<IStorageController> pSATAController;
185	ComPtr<IStorageController> pSCSIController;
186	ComPtr<IStorageController> pSASController;
187	for (size_t j = 0; j < nwControllers.size(); ++j)
188	{
189	StorageBus_T eType;
190	rc = nwControllers[j]->COMGETTER(Bus)(&eType);
191	if (FAILED(rc)) throw rc;
192	if ( eType == StorageBus_IDE
193	&& pIDEController.isNull())
194	pIDEController = nwControllers[j];
195	else if ( eType == StorageBus_SATA
196	&& pSATAController.isNull())
197	pSATAController = nwControllers[j];
198	else if ( eType == StorageBus_SCSI
199	&& pSATAController.isNull())
200	pSCSIController = nwControllers[j];
201	else if ( eType == StorageBus_SAS
202	&& pSASController.isNull())
203	pSASController = nwControllers[j];
204	}
205
206	// <const name="HardDiskControllerIDE" value="6" />
207	if (!pIDEController.isNull())
208	{
209	Utf8Str strVbox;
210	StorageControllerType_T ctlr;
211	rc = pIDEController->COMGETTER(ControllerType)(&ctlr);
212	if (FAILED(rc)) throw rc;
213	switch(ctlr)
214	{
215	case StorageControllerType_PIIX3: strVbox = "PIIX3"; break;
216	case StorageControllerType_PIIX4: strVbox = "PIIX4"; break;
217	case StorageControllerType_ICH6: strVbox = "ICH6"; break;
218	}
219
220	if (strVbox.length())
221	{
222	lIDEControllerPrimaryIndex = (int32_t)pNewDesc->m->llDescriptions.size();
223	pNewDesc->addEntry(VirtualSystemDescriptionType_HardDiskControllerIDE,
224	Utf8StrFmt("%d", lIDEControllerPrimaryIndex), // strRef
225	strVbox, // aOvfValue
226	strVbox); // aVboxValue
227	lIDEControllerSecondaryIndex = lIDEControllerPrimaryIndex + 1;
228	pNewDesc->addEntry(VirtualSystemDescriptionType_HardDiskControllerIDE,
229	Utf8StrFmt("%d", lIDEControllerSecondaryIndex),
230	strVbox,
231	strVbox);
232	}
233	}
234
235	// <const name="HardDiskControllerSATA" value="7" />
236	if (!pSATAController.isNull())
237	{
238	Utf8Str strVbox = "AHCI";
239	lSATAControllerIndex = (int32_t)pNewDesc->m->llDescriptions.size();
240	pNewDesc->addEntry(VirtualSystemDescriptionType_HardDiskControllerSATA,
241	Utf8StrFmt("%d", lSATAControllerIndex),
242	strVbox,
243	strVbox);
244	}
245
246	// <const name="HardDiskControllerSCSI" value="8" />
247	if (!pSCSIController.isNull())
248	{
249	StorageControllerType_T ctlr;
250	rc = pSCSIController->COMGETTER(ControllerType)(&ctlr);
251	if (SUCCEEDED(rc))
252	{
253	Utf8Str strVbox = "LsiLogic"; // the default in VBox
254	switch(ctlr)
255	{
256	case StorageControllerType_LsiLogic: strVbox = "LsiLogic"; break;
257	case StorageControllerType_BusLogic: strVbox = "BusLogic"; break;
258	}
259	lSCSIControllerIndex = (int32_t)pNewDesc->m->llDescriptions.size();
260	pNewDesc->addEntry(VirtualSystemDescriptionType_HardDiskControllerSCSI,
261	Utf8StrFmt("%d", lSCSIControllerIndex),
262	strVbox,
263	strVbox);
264	}
265	else
266	throw rc;
267	}
268
269	if (!pSASController.isNull())
270	{
271	// VirtualBox considers the SAS controller a class of its own but in OVF
272	// it should be a SCSI controller
273	Utf8Str strVbox = "LsiLogicSas";
274	lSCSIControllerIndex = (int32_t)pNewDesc->m->llDescriptions.size();
275	pNewDesc->addEntry(VirtualSystemDescriptionType_HardDiskControllerSAS,
276	Utf8StrFmt("%d", lSCSIControllerIndex),
277	strVbox,
278	strVbox);
279	}
280
281	// <const name="HardDiskImage" value="9" />
282	// <const name="Floppy" value="18" />
283	// <const name="CDROM" value="19" />
284
285	MediaData::AttachmentList::iterator itA;
286	for (itA = mMediaData->mAttachments.begin();
287	itA != mMediaData->mAttachments.end();
288	++itA)
289	{
290	ComObjPtr<MediumAttachment> pHDA = *itA;
291
292	// the attachment's data
293	ComPtr<IMedium> pMedium;
294	ComPtr<IStorageController> ctl;
295	Bstr controllerName;
296
297	rc = pHDA->COMGETTER(Controller)(controllerName.asOutParam());
298	if (FAILED(rc)) throw rc;
299
300	rc = GetStorageControllerByName(controllerName.raw(), ctl.asOutParam());
301	if (FAILED(rc)) throw rc;
302
303	StorageBus_T storageBus;
304	DeviceType_T deviceType;
305	LONG lChannel;
306	LONG lDevice;
307
308	rc = ctl->COMGETTER(Bus)(&storageBus);
309	if (FAILED(rc)) throw rc;
310
311	rc = pHDA->COMGETTER(Type)(&deviceType);
312	if (FAILED(rc)) throw rc;
313
314	rc = pHDA->COMGETTER(Medium)(pMedium.asOutParam());
315	if (FAILED(rc)) throw rc;
316
317	rc = pHDA->COMGETTER(Port)(&lChannel);
318	if (FAILED(rc)) throw rc;
319
320	rc = pHDA->COMGETTER(Device)(&lDevice);
321	if (FAILED(rc)) throw rc;
322
323	Utf8Str strTargetVmdkName;
324	Utf8Str strLocation;
325	LONG64 llSize = 0;
326
327	if ( deviceType == DeviceType_HardDisk
328	&& pMedium
329	)
330	{
331	Bstr bstrLocation;
332	rc = pMedium->COMGETTER(Location)(bstrLocation.asOutParam());
333	if (FAILED(rc)) throw rc;
334	strLocation = bstrLocation;
335
336	// find the source's base medium for two things:
337	// 1) we'll use its name to determine the name of the target disk, which is readable,
338	// as opposed to the UUID filename of a differencing image, if pMedium is one
339	// 2) we need the size of the base image so we can give it to addEntry(), and later
340	// on export, the progress will be based on that (and not the diff image)
341	ComPtr<IMedium> pBaseMedium;
342	rc = pMedium->COMGETTER(Base)(pBaseMedium.asOutParam());
343	// returns pMedium if there are no diff images
344	if (FAILED(rc)) throw rc;
345
346	Bstr bstrBaseName;
347	rc = pBaseMedium->COMGETTER(Name)(bstrBaseName.asOutParam());
348	if (FAILED(rc)) throw rc;
349
350	Utf8Str strTargetName = Utf8Str(locInfo.strPath).stripPath().stripExt();
351	strTargetVmdkName = Utf8StrFmt("%s-disk%d.vmdk", strTargetName.c_str(), ++pAppliance->m->cDisks);
352
353	// force reading state, or else size will be returned as 0
354	MediumState_T ms;
355	rc = pBaseMedium->RefreshState(&ms);
356	if (FAILED(rc)) throw rc;
357
358	rc = pBaseMedium->COMGETTER(Size)(&llSize);
359	if (FAILED(rc)) throw rc;
360	}
361
362	// and how this translates to the virtual system
363	int32_t lControllerVsys = 0;
364	LONG lChannelVsys;
365
366	switch (storageBus)
367	{
368	case StorageBus_IDE:
369	// this is the exact reverse to what we're doing in Appliance::taskThreadImportMachines,
370	// and it must be updated when that is changed!
371	// Before 3.2 we exported one IDE controller with channel 0-3, but we now maintain
372	// compatibility with what VMware does and export two IDE controllers with two channels each
373
374	if (lChannel == 0 && lDevice == 0) // primary master
375	{
376	lControllerVsys = lIDEControllerPrimaryIndex;
377	lChannelVsys = 0;
378	}
379	else if (lChannel == 0 && lDevice == 1) // primary slave
380	{
381	lControllerVsys = lIDEControllerPrimaryIndex;
382	lChannelVsys = 1;
383	}
384	else if (lChannel == 1 && lDevice == 0) // secondary master; by default this is the CD-ROM but as of VirtualBox 3.1 that can change
385	{
386	lControllerVsys = lIDEControllerSecondaryIndex;
387	lChannelVsys = 0;
388	}
389	else if (lChannel == 1 && lDevice == 1) // secondary slave
390	{
391	lControllerVsys = lIDEControllerSecondaryIndex;
392	lChannelVsys = 1;
393	}
394	else
395	throw setError(VBOX_E_NOT_SUPPORTED,
396	tr("Cannot handle medium attachment: channel is %d, device is %d"), lChannel, lDevice);
397	break;
398
399	case StorageBus_SATA:
400	lChannelVsys = lChannel; // should be between 0 and 29
401	lControllerVsys = lSATAControllerIndex;
402	break;
403
404	case StorageBus_SCSI:
405	case StorageBus_SAS:
406	lChannelVsys = lChannel; // should be between 0 and 15
407	lControllerVsys = lSCSIControllerIndex;
408	break;
409
410	case StorageBus_Floppy:
411	lChannelVsys = 0;
412	lControllerVsys = 0;
413	break;
414
415	default:
416	throw setError(VBOX_E_NOT_SUPPORTED,
417	tr("Cannot handle medium attachment: storageBus is %d, channel is %d, device is %d"), storageBus, lChannel, lDevice);
418	break;
419	}
420
421	Utf8StrFmt strExtra("controller=%RI32;channel=%RI32", lControllerVsys, lChannelVsys);
422	Utf8Str strEmpty;
423
424	switch (deviceType)
425	{
426	case DeviceType_HardDisk:
427	Log(("Adding VirtualSystemDescriptionType_HardDiskImage, disk size: %RI64\n", llSize));
428	pNewDesc->addEntry(VirtualSystemDescriptionType_HardDiskImage,
429	strTargetVmdkName, // disk ID: let's use the name
430	strTargetVmdkName, // OVF value:
431	strLocation, // vbox value: media path
432	(uint32_t)(llSize / _1M),
433	strExtra);
434	break;
435
436	case DeviceType_DVD:
437	pNewDesc->addEntry(VirtualSystemDescriptionType_CDROM,
438	strEmpty, // disk ID
439	strEmpty, // OVF value
440	strEmpty, // vbox value
441	1, // ulSize
442	strExtra);
443	break;
444
445	case DeviceType_Floppy:
446	pNewDesc->addEntry(VirtualSystemDescriptionType_Floppy,
447	strEmpty, // disk ID
448	strEmpty, // OVF value
449	strEmpty, // vbox value
450	1, // ulSize
451	strExtra);
452	break;
453	}
454	}
455
456	// <const name="NetworkAdapter" />
457	uint32_t maxNetworkAdapters = Global::getMaxNetworkAdapters(getChipsetType());
458	size_t a;
459	for (a = 0; a < maxNetworkAdapters; ++a)
460	{
461	ComPtr<INetworkAdapter> pNetworkAdapter;
462	BOOL fEnabled;
463	NetworkAdapterType_T adapterType;
464	NetworkAttachmentType_T attachmentType;
465
466	rc = GetNetworkAdapter((ULONG)a, pNetworkAdapter.asOutParam());
467	if (FAILED(rc)) throw rc;
468	/* Enable the network card & set the adapter type */
469	rc = pNetworkAdapter->COMGETTER(Enabled)(&fEnabled);
470	if (FAILED(rc)) throw rc;
471
472	if (fEnabled)
473	{
474	rc = pNetworkAdapter->COMGETTER(AdapterType)(&adapterType);
475	if (FAILED(rc)) throw rc;
476
477	rc = pNetworkAdapter->COMGETTER(AttachmentType)(&attachmentType);
478	if (FAILED(rc)) throw rc;
479
480	Utf8Str strAttachmentType = convertNetworkAttachmentTypeToString(attachmentType);
481	pNewDesc->addEntry(VirtualSystemDescriptionType_NetworkAdapter,
482	"", // ref
483	strAttachmentType, // orig
484	Utf8StrFmt("%RI32", (uint32_t)adapterType), // conf
485	0,
486	Utf8StrFmt("type=%s", strAttachmentType.c_str())); // extra conf
487	}
488	}
489
490	// <const name="USBController" />
491	#ifdef VBOX_WITH_USB
492	if (fUSBEnabled)
493	pNewDesc->addEntry(VirtualSystemDescriptionType_USBController, "", "", "");
494	#endif /* VBOX_WITH_USB */
495
496	// <const name="SoundCard" />
497	if (fAudioEnabled)
498	pNewDesc->addEntry(VirtualSystemDescriptionType_SoundCard,
499	"",
500	"ensoniq1371", // this is what OVFTool writes and VMware supports
501	Utf8StrFmt("%RI32", audioController));
502
503	/* We return the new description to the caller */
504	ComPtr<IVirtualSystemDescription> copy(pNewDesc);
505	copy.queryInterfaceTo(aDescription);
506
507	AutoWriteLock alock(pAppliance COMMA_LOCKVAL_SRC_POS);
508	// finally, add the virtual system to the appliance
509	pAppliance->m->virtualSystemDescriptions.push_back(pNewDesc);
510	}
511	catch(HRESULT arc)
512	{
513	rc = arc;
514	}
515
516	return rc;
517	}
518
519	////////////////////////////////////////////////////////////////////////////////
520	//
521	// IAppliance public methods
522	//
523	////////////////////////////////////////////////////////////////////////////////
524
525	/**
526	* Public method implementation.
527	* @param format
528	* @param path
529	* @param aProgress
530	* @return
531	*/
532	STDMETHODIMP Appliance::Write(IN_BSTR format, BOOL fManifest, IN_BSTR path, IProgress **aProgress)
533	{
534	if (!path) return E_POINTER;
535	CheckComArgOutPointerValid(aProgress);
536
537	AutoCaller autoCaller(this);
538	if (FAILED(autoCaller.rc())) return autoCaller.rc();
539
540	AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
541
542	// do not allow entering this method if the appliance is busy reading or writing
543	if (!isApplianceIdle())
544	return E_ACCESSDENIED;
545
546	// see if we can handle this file; for now we insist it has an ".ovf" extension
547	Utf8Str strPath = path;
548	if (!( strPath.endsWith(".ovf", Utf8Str::CaseInsensitive)
549	\|\| strPath.endsWith(".ova", Utf8Str::CaseInsensitive)))
550	return setError(VBOX_E_FILE_ERROR,
551	tr("Appliance file must have .ovf or .ova extension"));
552
553	m->fManifest = !!fManifest;
554	Utf8Str strFormat(format);
555	OVFFormat ovfF;
556	if (strFormat == "ovf-0.9")
557	ovfF = OVF_0_9;
558	else if (strFormat == "ovf-1.0")
559	ovfF = OVF_1_0;
560	else if (strFormat == "ovf-2.0")
561	ovfF = OVF_2_0;
562	else
563	return setError(VBOX_E_FILE_ERROR,
564	tr("Invalid format \"%s\" specified"), strFormat.c_str());
565
566	/* as of OVF 2.0 we have to use SHA256 */
567	m->fSha256 = ovfF >= OVF_2_0;
568
569	ComObjPtr<Progress> progress;
570	HRESULT rc = S_OK;
571	try
572	{
573	/* Parse all necessary info out of the URI */
574	parseURI(strPath, m->locInfo);
575	rc = writeImpl(ovfF, m->locInfo, progress);
576	}
577	catch (HRESULT aRC)
578	{
579	rc = aRC;
580	}
581
582	if (SUCCEEDED(rc))
583	/* Return progress to the caller */
584	progress.queryInterfaceTo(aProgress);
585
586	return rc;
587	}
588
589	////////////////////////////////////////////////////////////////////////////////
590	//
591	// Appliance private methods
592	//
593	////////////////////////////////////////////////////////////////////////////////
594
595	/*******************************************************************************
596	* Export stuff
597	******************************************************************************/
598
599	/**
600	* Implementation for writing out the OVF to disk. This starts a new thread which will call
601	* Appliance::taskThreadWriteOVF().
602	*
603	* This is in a separate private method because it is used from two locations:
604	*
605	* 1) from the public Appliance::Write().
606	*
607	* 2) in a second worker thread; in that case, Appliance::Write() called Appliance::writeImpl(), which
608	* called Appliance::writeFSOVA(), which called Appliance::writeImpl(), which then called this again.
609	*
610	* 3) from Appliance::writeS3(), which got called from a previous instance of Appliance::taskThreadWriteOVF().
611	*
612	* @param aFormat
613	* @param aLocInfo
614	* @param aProgress
615	* @return
616	*/
617	HRESULT Appliance::writeImpl(OVFFormat aFormat, const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress)
618	{
619	HRESULT rc = S_OK;
620	try
621	{
622	rc = setUpProgress(aProgress,
623	BstrFmt(tr("Export appliance '%s'"), aLocInfo.strPath.c_str()),
624	(aLocInfo.storageType == VFSType_File) ? WriteFile : WriteS3);
625
626	/* Initialize our worker task */
627	std::auto_ptr<TaskOVF> task(new TaskOVF(this, TaskOVF::Write, aLocInfo, aProgress));
628	/* The OVF version to write */
629	task->enFormat = aFormat;
630
631	rc = task->startThread();
632	if (FAILED(rc)) throw rc;
633
634	/* Don't destruct on success */
635	task.release();
636	}
637	catch (HRESULT aRC)
638	{
639	rc = aRC;
640	}
641
642	return rc;
643	}
644
645	/**
646	* Called from Appliance::writeFS() for creating a XML document for this
647	* Appliance.
648	*
649	* @param writeLock The current write lock.
650	* @param doc The xml document to fill.
651	* @param stack Structure for temporary private
652	* data shared with caller.
653	* @param strPath Path to the target OVF.
654	* instance for which to write XML.
655	* @param enFormat OVF format (0.9 or 1.0).
656	*/
657	void Appliance::buildXML(AutoWriteLockBase& writeLock,
658	xml::Document &doc,
659	XMLStack &stack,
660	const Utf8Str &strPath,
661	OVFFormat enFormat)
662	{
663	xml::ElementNode *pelmRoot = doc.createRootElement("Envelope");
664
665	pelmRoot->setAttribute("ovf:version", enFormat == OVF_2_0 ? "2.0"
666	: enFormat == OVF_1_0 ? "1.0"
667	: "0.9");
668	pelmRoot->setAttribute("xml:lang", "en-US");
669
670	Utf8Str strNamespace = (enFormat == OVF_0_9)
671	? "http://www.vmware.com/schema/ovf/1/envelope" // 0.9
672	: "http://schemas.dmtf.org/ovf/envelope/1"; // 1.0
673	pelmRoot->setAttribute("xmlns", strNamespace);
674	pelmRoot->setAttribute("xmlns:ovf", strNamespace);
675
676	// pelmRoot->setAttribute("xmlns:ovfstr", "http://schema.dmtf.org/ovf/strings/1");
677	pelmRoot->setAttribute("xmlns:rasd", "http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData");
678	pelmRoot->setAttribute("xmlns:vssd", "http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_VirtualSystemSettingData");
679	pelmRoot->setAttribute("xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance");
680	pelmRoot->setAttribute("xmlns:vbox", "http://www.virtualbox.org/ovf/machine");
681	// pelmRoot->setAttribute("xsi:schemaLocation", "http://schemas.dmtf.org/ovf/envelope/1 ../ovf-envelope.xsd");
682
683	// <Envelope>/<References>
684	xml::ElementNode *pelmReferences = pelmRoot->createChild("References"); // 0.9 and 1.0
685
686	/* <Envelope>/<DiskSection>:
687	<DiskSection>
688	<Info>List of the virtual disks used in the package</Info>
689	<Disk ovf:capacity="4294967296" ovf:diskId="lamp" ovf:format="..." ovf:populatedSize="1924967692"/>
690	</DiskSection> */
691	xml::ElementNode *pelmDiskSection;
692	if (enFormat == OVF_0_9)
693	{
694	// <Section xsi:type="ovf:DiskSection_Type">
695	pelmDiskSection = pelmRoot->createChild("Section");
696	pelmDiskSection->setAttribute("xsi:type", "ovf:DiskSection_Type");
697	}
698	else
699	pelmDiskSection = pelmRoot->createChild("DiskSection");
700
701	xml::ElementNode *pelmDiskSectionInfo = pelmDiskSection->createChild("Info");
702	pelmDiskSectionInfo->addContent("List of the virtual disks used in the package");
703
704	/* <Envelope>/<NetworkSection>:
705	<NetworkSection>
706	<Info>Logical networks used in the package</Info>
707	<Network ovf:name="VM Network">
708	<Description>The network that the LAMP Service will be available on</Description>
709	</Network>
710	</NetworkSection> */
711	xml::ElementNode *pelmNetworkSection;
712	if (enFormat == OVF_0_9)
713	{
714	// <Section xsi:type="ovf:NetworkSection_Type">
715	pelmNetworkSection = pelmRoot->createChild("Section");
716	pelmNetworkSection->setAttribute("xsi:type", "ovf:NetworkSection_Type");
717	}
718	else
719	pelmNetworkSection = pelmRoot->createChild("NetworkSection");
720
721	xml::ElementNode *pelmNetworkSectionInfo = pelmNetworkSection->createChild("Info");
722	pelmNetworkSectionInfo->addContent("Logical networks used in the package");
723
724	// and here come the virtual systems:
725
726	// write a collection if we have more than one virtual system _and_ we're
727	// writing OVF 1.0; otherwise fail since ovftool can't import more than
728	// one machine, it seems
729	xml::ElementNode *pelmToAddVirtualSystemsTo;
730	if (m->virtualSystemDescriptions.size() > 1)
731	{
732	if (enFormat == OVF_0_9)
733	throw setError(VBOX_E_FILE_ERROR,
734	tr("Cannot export more than one virtual system with OVF 0.9, use OVF 1.0"));
735
736	pelmToAddVirtualSystemsTo = pelmRoot->createChild("VirtualSystemCollection");
737	pelmToAddVirtualSystemsTo->setAttribute("ovf:name", "ExportedVirtualBoxMachines"); // whatever
738	}
739	else
740	pelmToAddVirtualSystemsTo = pelmRoot; // add virtual system directly under root element
741
742	// this list receives pointers to the XML elements in the machine XML which
743	// might have UUIDs that need fixing after we know the UUIDs of the exported images
744	std::list<xml::ElementNode*> llElementsWithUuidAttributes;
745
746	list< ComObjPtr<VirtualSystemDescription> >::const_iterator it;
747	/* Iterate through all virtual systems of that appliance */
748	for (it = m->virtualSystemDescriptions.begin();
749	it != m->virtualSystemDescriptions.end();
750	++it)
751	{
752	ComObjPtr<VirtualSystemDescription> vsdescThis = *it;
753	buildXMLForOneVirtualSystem(writeLock,
754	*pelmToAddVirtualSystemsTo,
755	&llElementsWithUuidAttributes,
756	vsdescThis,
757	enFormat,
758	stack); // disks and networks stack
759	}
760
761	// now, fill in the network section we set up empty above according
762	// to the networks we found with the hardware items
763	map<Utf8Str, bool>::const_iterator itN;
764	for (itN = stack.mapNetworks.begin();
765	itN != stack.mapNetworks.end();
766	++itN)
767	{
768	const Utf8Str &strNetwork = itN->first;
769	xml::ElementNode *pelmNetwork = pelmNetworkSection->createChild("Network");
770	pelmNetwork->setAttribute("ovf:name", strNetwork.c_str());
771	pelmNetwork->createChild("Description")->addContent("Logical network used by this appliance.");
772	}
773
774	// Finally, write out the disk info
775	list<Utf8Str> diskList;
776	map<Utf8Str, const VirtualSystemDescriptionEntry*>::const_iterator itS;
777	uint32_t ulFile = 1;
778	for (itS = stack.mapDisks.begin();
779	itS != stack.mapDisks.end();
780	++itS)
781	{
782	const Utf8Str &strDiskID = itS->first;
783	const VirtualSystemDescriptionEntry *pDiskEntry = itS->second;
784
785	// source path: where the VBox image is
786	const Utf8Str &strSrcFilePath = pDiskEntry->strVboxCurrent;
787	Bstr bstrSrcFilePath(strSrcFilePath);
788
789	// Do NOT check here whether the file exists. FindMedium will figure
790	// that out, and filesystem-based tests are simply wrong in the
791	// general case (think of iSCSI).
792
793	// We need some info from the source disks
794	ComPtr<IMedium> pSourceDisk;
795
796	Log(("Finding source disk \"%ls\"\n", bstrSrcFilePath.raw()));
797	HRESULT rc = mVirtualBox->OpenMedium(bstrSrcFilePath.raw(), DeviceType_HardDisk, AccessMode_ReadWrite, FALSE /* fForceNewUuid */, pSourceDisk.asOutParam());
798	if (FAILED(rc)) throw rc;
799
800	Bstr uuidSource;
801	rc = pSourceDisk->COMGETTER(Id)(uuidSource.asOutParam());
802	if (FAILED(rc)) throw rc;
803	Guid guidSource(uuidSource);
804
805	// output filename
806	const Utf8Str &strTargetFileNameOnly = pDiskEntry->strOvf;
807	// target path needs to be composed from where the output OVF is
808	Utf8Str strTargetFilePath(strPath);
809	strTargetFilePath.stripFilename();
810	strTargetFilePath.append("/");
811	strTargetFilePath.append(strTargetFileNameOnly);
812
813	// We are always exporting to VMDK stream optimized for now
814	Bstr bstrSrcFormat = L"VMDK";
815
816	diskList.push_back(strTargetFilePath);
817
818	LONG64 cbCapacity = 0; // size reported to guest
819	rc = pSourceDisk->COMGETTER(LogicalSize)(&cbCapacity);
820	if (FAILED(rc)) throw rc;
821	// Todo r=poetzsch: wrong it is reported in bytes ...
822	// capacity is reported in megabytes, so...
823	//cbCapacity *= _1M;
824
825	Guid guidTarget; /* Creates a new uniq number for the target disk. */
826	guidTarget.create();
827
828	// now handle the XML for the disk:
829	Utf8StrFmt strFileRef("file%RI32", ulFile++);
830	// <File ovf:href="WindowsXpProfessional-disk1.vmdk" ovf:id="file1" ovf:size="1710381056"/>
831	xml::ElementNode *pelmFile = pelmReferences->createChild("File");
832	pelmFile->setAttribute("ovf:href", strTargetFileNameOnly);
833	pelmFile->setAttribute("ovf:id", strFileRef);
834	// Todo: the actual size is not available at this point of time,
835	// cause the disk will be compressed. The 1.0 standard says this is
836	// optional! 1.1 isn't fully clear if the "gzip" format is used.
837	// Need to be checked. */
838	// pelmFile->setAttribute("ovf:size", Utf8StrFmt("%RI64", cbFile).c_str());
839
840	// add disk to XML Disks section
841	// <Disk ovf:capacity="8589934592" ovf:diskId="vmdisk1" ovf:fileRef="file1" ovf:format="..."/>
842	xml::ElementNode *pelmDisk = pelmDiskSection->createChild("Disk");
843	pelmDisk->setAttribute("ovf:capacity", Utf8StrFmt("%RI64", cbCapacity).c_str());
844	pelmDisk->setAttribute("ovf:diskId", strDiskID);
845	pelmDisk->setAttribute("ovf:fileRef", strFileRef);
846	pelmDisk->setAttribute("ovf:format",
847	(enFormat == OVF_0_9)
848	? "http://www.vmware.com/specifications/vmdk.html#sparse" // must be sparse or ovftool chokes
849	: "http://www.vmware.com/interfaces/specifications/vmdk.html#streamOptimized"
850	// correct string as communicated to us by VMware (public bug #6612)
851	);
852
853	// add the UUID of the newly target image to the OVF disk element, but in the
854	// vbox: namespace since it's not part of the standard
855	pelmDisk->setAttribute("vbox:uuid", Utf8StrFmt("%RTuuid", guidTarget.raw()).c_str());
856
857	// now, we might have other XML elements from vbox:Machine pointing to this image,
858	// but those would refer to the UUID of the _source_ image (which we created the
859	// export image from); those UUIDs need to be fixed to the export image
860	Utf8Str strGuidSourceCurly = guidSource.toStringCurly();
861	for (std::list<xml::ElementNode*>::iterator eit = llElementsWithUuidAttributes.begin();
862	eit != llElementsWithUuidAttributes.end();
863	++eit)
864	{
865	xml::ElementNode pelmImage = eit;
866	Utf8Str strUUID;
867	pelmImage->getAttributeValue("uuid", strUUID);
868	if (strUUID == strGuidSourceCurly)
869	// overwrite existing uuid attribute
870	pelmImage->setAttribute("uuid", guidTarget.toStringCurly());
871	}
872	}
873	}
874
875	/**
876	* Called from Appliance::buildXML() for each virtual system (machine) that
877	* needs XML written out.
878	*
879	* @param writeLock The current write lock.
880	* @param elmToAddVirtualSystemsTo XML element to append elements to.
881	* @param pllElementsWithUuidAttributes out: list of XML elements produced here
882	* with UUID attributes for quick
883	* fixing by caller later
884	* @param vsdescThis The IVirtualSystemDescription
885	* instance for which to write XML.
886	* @param enFormat OVF format (0.9 or 1.0).
887	* @param stack Structure for temporary private
888	* data shared with caller.
889	*/
890	void Appliance::buildXMLForOneVirtualSystem(AutoWriteLockBase& writeLock,
891	xml::ElementNode &elmToAddVirtualSystemsTo,
892	std::list<xml::ElementNode> pllElementsWithUuidAttributes,
893	ComObjPtr<VirtualSystemDescription> &vsdescThis,
894	OVFFormat enFormat,
895	XMLStack &stack)
896	{
897	LogFlowFunc(("ENTER appliance %p\n", this));
898
899	xml::ElementNode *pelmVirtualSystem;
900	if (enFormat == OVF_0_9)
901	{
902	// <Section xsi:type="ovf:NetworkSection_Type">
903	pelmVirtualSystem = elmToAddVirtualSystemsTo.createChild("Content");
904	pelmVirtualSystem->setAttribute("xsi:type", "ovf:VirtualSystem_Type");
905	}
906	else
907	pelmVirtualSystem = elmToAddVirtualSystemsTo.createChild("VirtualSystem");
908
909	/xml::ElementNode pelmVirtualSystemInfo =*/ pelmVirtualSystem->createChild("Info")->addContent("A virtual machine");
910
911	std::list<VirtualSystemDescriptionEntry*> llName = vsdescThis->findByType(VirtualSystemDescriptionType_Name);
912	if (llName.size() != 1)
913	throw setError(VBOX_E_NOT_SUPPORTED,
914	tr("Missing VM name"));
915	Utf8Str &strVMName = llName.front()->strVboxCurrent;
916	pelmVirtualSystem->setAttribute("ovf:id", strVMName);
917
918	// product info
919	std::list<VirtualSystemDescriptionEntry*> llProduct = vsdescThis->findByType(VirtualSystemDescriptionType_Product);
920	std::list<VirtualSystemDescriptionEntry*> llProductUrl = vsdescThis->findByType(VirtualSystemDescriptionType_ProductUrl);
921	std::list<VirtualSystemDescriptionEntry*> llVendor = vsdescThis->findByType(VirtualSystemDescriptionType_Vendor);
922	std::list<VirtualSystemDescriptionEntry*> llVendorUrl = vsdescThis->findByType(VirtualSystemDescriptionType_VendorUrl);
923	std::list<VirtualSystemDescriptionEntry*> llVersion = vsdescThis->findByType(VirtualSystemDescriptionType_Version);
924	bool fProduct = llProduct.size() && !llProduct.front()->strVboxCurrent.isEmpty();
925	bool fProductUrl = llProductUrl.size() && !llProductUrl.front()->strVboxCurrent.isEmpty();
926	bool fVendor = llVendor.size() && !llVendor.front()->strVboxCurrent.isEmpty();
927	bool fVendorUrl = llVendorUrl.size() && !llVendorUrl.front()->strVboxCurrent.isEmpty();
928	bool fVersion = llVersion.size() && !llVersion.front()->strVboxCurrent.isEmpty();
929	if (fProduct \|\|
930	fProductUrl \|\|
931	fVersion \|\|
932	fVendorUrl \|\|
933	fVersion)
934	{
935	/* <Section ovf:required="false" xsi:type="ovf:ProductSection_Type">
936	<Info>Meta-information about the installed software</Info>
937	<Product>VAtest</Product>
938	<Vendor>SUN Microsystems</Vendor>
939	<Version>10.0</Version>
940	<ProductUrl>http://blogs.sun.com/VirtualGuru</ProductUrl>
941	<VendorUrl>http://www.sun.com</VendorUrl>
942	</Section> */
943	xml::ElementNode *pelmAnnotationSection;
944	if (enFormat == OVF_0_9)
945	{
946	// <Section ovf:required="false" xsi:type="ovf:ProductSection_Type">
947	pelmAnnotationSection = pelmVirtualSystem->createChild("Section");
948	pelmAnnotationSection->setAttribute("xsi:type", "ovf:ProductSection_Type");
949	}
950	else
951	pelmAnnotationSection = pelmVirtualSystem->createChild("ProductSection");
952
953	pelmAnnotationSection->createChild("Info")->addContent("Meta-information about the installed software");
954	if (fProduct)
955	pelmAnnotationSection->createChild("Product")->addContent(llProduct.front()->strVboxCurrent);
956	if (fVendor)
957	pelmAnnotationSection->createChild("Vendor")->addContent(llVendor.front()->strVboxCurrent);
958	if (fVersion)
959	pelmAnnotationSection->createChild("Version")->addContent(llVersion.front()->strVboxCurrent);
960	if (fProductUrl)
961	pelmAnnotationSection->createChild("ProductUrl")->addContent(llProductUrl.front()->strVboxCurrent);
962	if (fVendorUrl)
963	pelmAnnotationSection->createChild("VendorUrl")->addContent(llVendorUrl.front()->strVboxCurrent);
964	}
965
966	// description
967	std::list<VirtualSystemDescriptionEntry*> llDescription = vsdescThis->findByType(VirtualSystemDescriptionType_Description);
968	if (llDescription.size() &&
969	!llDescription.front()->strVboxCurrent.isEmpty())
970	{
971	/* <Section ovf:required="false" xsi:type="ovf:AnnotationSection_Type">
972	<Info>A human-readable annotation</Info>
973	<Annotation>Plan 9</Annotation>
974	</Section> */
975	xml::ElementNode *pelmAnnotationSection;
976	if (enFormat == OVF_0_9)
977	{
978	// <Section ovf:required="false" xsi:type="ovf:AnnotationSection_Type">
979	pelmAnnotationSection = pelmVirtualSystem->createChild("Section");
980	pelmAnnotationSection->setAttribute("xsi:type", "ovf:AnnotationSection_Type");
981	}
982	else
983	pelmAnnotationSection = pelmVirtualSystem->createChild("AnnotationSection");
984
985	pelmAnnotationSection->createChild("Info")->addContent("A human-readable annotation");
986	pelmAnnotationSection->createChild("Annotation")->addContent(llDescription.front()->strVboxCurrent);
987	}
988
989	// license
990	std::list<VirtualSystemDescriptionEntry*> llLicense = vsdescThis->findByType(VirtualSystemDescriptionType_License);
991	if (llLicense.size() &&
992	!llLicense.front()->strVboxCurrent.isEmpty())
993	{
994	/* <EulaSection>
995	<Info ovf:msgid="6">License agreement for the Virtual System.</Info>
996	<License ovf:msgid="1">License terms can go in here.</License>
997	</EulaSection> */
998	xml::ElementNode *pelmEulaSection;
999	if (enFormat == OVF_0_9)
1000	{
1001	pelmEulaSection = pelmVirtualSystem->createChild("Section");
1002	pelmEulaSection->setAttribute("xsi:type", "ovf:EulaSection_Type");
1003	}
1004	else
1005	pelmEulaSection = pelmVirtualSystem->createChild("EulaSection");
1006
1007	pelmEulaSection->createChild("Info")->addContent("License agreement for the virtual system");
1008	pelmEulaSection->createChild("License")->addContent(llLicense.front()->strVboxCurrent);
1009	}
1010
1011	// operating system
1012	std::list<VirtualSystemDescriptionEntry*> llOS = vsdescThis->findByType(VirtualSystemDescriptionType_OS);
1013	if (llOS.size() != 1)
1014	throw setError(VBOX_E_NOT_SUPPORTED,
1015	tr("Missing OS type"));
1016	/* <OperatingSystemSection ovf:id="82">
1017	<Info>Guest Operating System</Info>
1018	<Description>Linux 2.6.x</Description>
1019	</OperatingSystemSection> */
1020	VirtualSystemDescriptionEntry *pvsdeOS = llOS.front();
1021	xml::ElementNode *pelmOperatingSystemSection;
1022	if (enFormat == OVF_0_9)
1023	{
1024	pelmOperatingSystemSection = pelmVirtualSystem->createChild("Section");
1025	pelmOperatingSystemSection->setAttribute("xsi:type", "ovf:OperatingSystemSection_Type");
1026	}
1027	else
1028	pelmOperatingSystemSection = pelmVirtualSystem->createChild("OperatingSystemSection");
1029
1030	pelmOperatingSystemSection->setAttribute("ovf:id", pvsdeOS->strOvf);
1031	pelmOperatingSystemSection->createChild("Info")->addContent("The kind of installed guest operating system");
1032	Utf8Str strOSDesc;
1033	convertCIMOSType2VBoxOSType(strOSDesc, (ovf::CIMOSType_T)pvsdeOS->strOvf.toInt32(), "");
1034	pelmOperatingSystemSection->createChild("Description")->addContent(strOSDesc);
1035	// add the VirtualBox ostype in a custom tag in a different namespace
1036	xml::ElementNode *pelmVBoxOSType = pelmOperatingSystemSection->createChild("vbox:OSType");
1037	pelmVBoxOSType->setAttribute("ovf:required", "false");
1038	pelmVBoxOSType->addContent(pvsdeOS->strVboxCurrent);
1039
1040	// <VirtualHardwareSection ovf:id="hw1" ovf:transport="iso">
1041	xml::ElementNode *pelmVirtualHardwareSection;
1042	if (enFormat == OVF_0_9)
1043	{
1044	// <Section xsi:type="ovf:VirtualHardwareSection_Type">
1045	pelmVirtualHardwareSection = pelmVirtualSystem->createChild("Section");
1046	pelmVirtualHardwareSection->setAttribute("xsi:type", "ovf:VirtualHardwareSection_Type");
1047	}
1048	else
1049	pelmVirtualHardwareSection = pelmVirtualSystem->createChild("VirtualHardwareSection");
1050
1051	pelmVirtualHardwareSection->createChild("Info")->addContent("Virtual hardware requirements for a virtual machine");
1052
1053	/* <System>
1054	<vssd:Description>Description of the virtual hardware section.</vssd:Description>
1055	<vssd:ElementName>vmware</vssd:ElementName>
1056	<vssd:InstanceID>1</vssd:InstanceID>
1057	<vssd:VirtualSystemIdentifier>MyLampService</vssd:VirtualSystemIdentifier>
1058	<vssd:VirtualSystemType>vmx-4</vssd:VirtualSystemType>
1059	</System> */
1060	xml::ElementNode *pelmSystem = pelmVirtualHardwareSection->createChild("System");
1061
1062	pelmSystem->createChild("vssd:ElementName")->addContent("Virtual Hardware Family"); // required OVF 1.0
1063
1064	// <vssd:InstanceId>0</vssd:InstanceId>
1065	if (enFormat == OVF_0_9)
1066	pelmSystem->createChild("vssd:InstanceId")->addContent("0");
1067	else // capitalization changed...
1068	pelmSystem->createChild("vssd:InstanceID")->addContent("0");
1069
1070	// <vssd:VirtualSystemIdentifier>VAtest</vssd:VirtualSystemIdentifier>
1071	pelmSystem->createChild("vssd:VirtualSystemIdentifier")->addContent(strVMName);
1072	// <vssd:VirtualSystemType>vmx-4</vssd:VirtualSystemType>
1073	const char *pcszHardware = "virtualbox-2.2";
1074	if (enFormat == OVF_0_9)
1075	// pretend to be vmware compatible then
1076	pcszHardware = "vmx-6";
1077	pelmSystem->createChild("vssd:VirtualSystemType")->addContent(pcszHardware);
1078
1079	// loop thru all description entries twice; once to write out all
1080	// devices _except_ disk images, and a second time to assign the
1081	// disk images; this is because disk images need to reference
1082	// IDE controllers, and we can't know their instance IDs without
1083	// assigning them first
1084
1085	uint32_t idIDEPrimaryController = 0;
1086	int32_t lIDEPrimaryControllerIndex = 0;
1087	uint32_t idIDESecondaryController = 0;
1088	int32_t lIDESecondaryControllerIndex = 0;
1089	uint32_t idSATAController = 0;
1090	int32_t lSATAControllerIndex = 0;
1091	uint32_t idSCSIController = 0;
1092	int32_t lSCSIControllerIndex = 0;
1093
1094	uint32_t ulInstanceID = 1;
1095
1096	uint32_t cDVDs = 0;
1097
1098	for (size_t uLoop = 1; uLoop <= 2; ++uLoop)
1099	{
1100	int32_t lIndexThis = 0;
1101	list<VirtualSystemDescriptionEntry>::const_iterator itD;
1102	for (itD = vsdescThis->m->llDescriptions.begin();
1103	itD != vsdescThis->m->llDescriptions.end();
1104	++itD, ++lIndexThis)
1105	{
1106	const VirtualSystemDescriptionEntry &desc = *itD;
1107
1108	LogFlowFunc(("Loop %u: handling description entry ulIndex=%u, type=%s, strRef=%s, strOvf=%s, strVbox=%s, strExtraConfig=%s\n",
1109	uLoop,
1110	desc.ulIndex,
1111	( desc.type == VirtualSystemDescriptionType_HardDiskControllerIDE ? "HardDiskControllerIDE"
1112	: desc.type == VirtualSystemDescriptionType_HardDiskControllerSATA ? "HardDiskControllerSATA"
1113	: desc.type == VirtualSystemDescriptionType_HardDiskControllerSCSI ? "HardDiskControllerSCSI"
1114	: desc.type == VirtualSystemDescriptionType_HardDiskControllerSAS ? "HardDiskControllerSAS"
1115	: desc.type == VirtualSystemDescriptionType_HardDiskImage ? "HardDiskImage"
1116	: Utf8StrFmt("%d", desc.type).c_str()),
1117	desc.strRef.c_str(),
1118	desc.strOvf.c_str(),
1119	desc.strVboxCurrent.c_str(),
1120	desc.strExtraConfigCurrent.c_str()));
1121
1122	ovf::ResourceType_T type = (ovf::ResourceType_T)0; // if this becomes != 0 then we do stuff
1123	Utf8Str strResourceSubType;
1124
1125	Utf8Str strDescription; // results in <rasd:Description>...</rasd:Description> block
1126	Utf8Str strCaption; // results in <rasd:Caption>...</rasd:Caption> block
1127
1128	uint32_t ulParent = 0;
1129
1130	int32_t lVirtualQuantity = -1;
1131	Utf8Str strAllocationUnits;
1132
1133	int32_t lAddress = -1;
1134	int32_t lBusNumber = -1;
1135	int32_t lAddressOnParent = -1;
1136
1137	int32_t lAutomaticAllocation = -1; // 0 means "false", 1 means "true"
1138	Utf8Str strConnection; // results in <rasd:Connection>...</rasd:Connection> block
1139	Utf8Str strHostResource;
1140
1141	uint64_t uTemp;
1142
1143	switch (desc.type)
1144	{
1145	case VirtualSystemDescriptionType_CPU:
1146	/* <Item>
1147	<rasd:Caption>1 virtual CPU</rasd:Caption>
1148	<rasd:Description>Number of virtual CPUs</rasd:Description>
1149	<rasd:ElementName>virtual CPU</rasd:ElementName>
1150	<rasd:InstanceID>1</rasd:InstanceID>
1151	<rasd:ResourceType>3</rasd:ResourceType>
1152	<rasd:VirtualQuantity>1</rasd:VirtualQuantity>
1153	</Item> */
1154	if (uLoop == 1)
1155	{
1156	strDescription = "Number of virtual CPUs";
1157	type = ovf::ResourceType_Processor; // 3
1158	desc.strVboxCurrent.toInt(uTemp);
1159	lVirtualQuantity = (int32_t)uTemp;
1160	strCaption = Utf8StrFmt("%d virtual CPU", lVirtualQuantity); // without this ovftool won't eat the item
1161	}
1162	break;
1163
1164	case VirtualSystemDescriptionType_Memory:
1165	/* <Item>
1166	<rasd:AllocationUnits>MegaBytes</rasd:AllocationUnits>
1167	<rasd:Caption>256 MB of memory</rasd:Caption>
1168	<rasd:Description>Memory Size</rasd:Description>
1169	<rasd:ElementName>Memory</rasd:ElementName>
1170	<rasd:InstanceID>2</rasd:InstanceID>
1171	<rasd:ResourceType>4</rasd:ResourceType>
1172	<rasd:VirtualQuantity>256</rasd:VirtualQuantity>
1173	</Item> */
1174	if (uLoop == 1)
1175	{
1176	strDescription = "Memory Size";
1177	type = ovf::ResourceType_Memory; // 4
1178	desc.strVboxCurrent.toInt(uTemp);
1179	lVirtualQuantity = (int32_t)(uTemp / _1M);
1180	strAllocationUnits = "MegaBytes";
1181	strCaption = Utf8StrFmt("%d MB of memory", lVirtualQuantity); // without this ovftool won't eat the item
1182	}
1183	break;
1184
1185	case VirtualSystemDescriptionType_HardDiskControllerIDE:
1186	/* <Item>
1187	<rasd:Caption>ideController1</rasd:Caption>
1188	<rasd:Description>IDE Controller</rasd:Description>
1189	<rasd:InstanceId>5</rasd:InstanceId>
1190	<rasd:ResourceType>5</rasd:ResourceType>
1191	<rasd:Address>1</rasd:Address>
1192	<rasd:BusNumber>1</rasd:BusNumber>
1193	</Item> */
1194	if (uLoop == 1)
1195	{
1196	strDescription = "IDE Controller";
1197	type = ovf::ResourceType_IDEController; // 5
1198	strResourceSubType = desc.strVboxCurrent;
1199
1200	if (!lIDEPrimaryControllerIndex)
1201	{
1202	// first IDE controller:
1203	strCaption = "ideController0";
1204	lAddress = 0;
1205	lBusNumber = 0;
1206	// remember this ID
1207	idIDEPrimaryController = ulInstanceID;
1208	lIDEPrimaryControllerIndex = lIndexThis;
1209	}
1210	else
1211	{
1212	// second IDE controller:
1213	strCaption = "ideController1";
1214	lAddress = 1;
1215	lBusNumber = 1;
1216	// remember this ID
1217	idIDESecondaryController = ulInstanceID;
1218	lIDESecondaryControllerIndex = lIndexThis;
1219	}
1220	}
1221	break;
1222
1223	case VirtualSystemDescriptionType_HardDiskControllerSATA:
1224	/* <Item>
1225	<rasd:Caption>sataController0</rasd:Caption>
1226	<rasd:Description>SATA Controller</rasd:Description>
1227	<rasd:InstanceId>4</rasd:InstanceId>
1228	<rasd:ResourceType>20</rasd:ResourceType>
1229	<rasd:ResourceSubType>ahci</rasd:ResourceSubType>
1230	<rasd:Address>0</rasd:Address>
1231	<rasd:BusNumber>0</rasd:BusNumber>
1232	</Item>
1233	*/
1234	if (uLoop == 1)
1235	{
1236	strDescription = "SATA Controller";
1237	strCaption = "sataController0";
1238	type = ovf::ResourceType_OtherStorageDevice; // 20
1239	// it seems that OVFTool always writes these two, and since we can only
1240	// have one SATA controller, we'll use this as well
1241	lAddress = 0;
1242	lBusNumber = 0;
1243
1244	if ( desc.strVboxCurrent.isEmpty() // AHCI is the default in VirtualBox
1245	\|\| (!desc.strVboxCurrent.compare("ahci", Utf8Str::CaseInsensitive))
1246	)
1247	strResourceSubType = "AHCI";
1248	else
1249	throw setError(VBOX_E_NOT_SUPPORTED,
1250	tr("Invalid config string \"%s\" in SATA controller"), desc.strVboxCurrent.c_str());
1251
1252	// remember this ID
1253	idSATAController = ulInstanceID;
1254	lSATAControllerIndex = lIndexThis;
1255	}
1256	break;
1257
1258	case VirtualSystemDescriptionType_HardDiskControllerSCSI:
1259	case VirtualSystemDescriptionType_HardDiskControllerSAS:
1260	/* <Item>
1261	<rasd:Caption>scsiController0</rasd:Caption>
1262	<rasd:Description>SCSI Controller</rasd:Description>
1263	<rasd:InstanceId>4</rasd:InstanceId>
1264	<rasd:ResourceType>6</rasd:ResourceType>
1265	<rasd:ResourceSubType>buslogic</rasd:ResourceSubType>
1266	<rasd:Address>0</rasd:Address>
1267	<rasd:BusNumber>0</rasd:BusNumber>
1268	</Item>
1269	*/
1270	if (uLoop == 1)
1271	{
1272	strDescription = "SCSI Controller";
1273	strCaption = "scsiController0";
1274	type = ovf::ResourceType_ParallelSCSIHBA; // 6
1275	// it seems that OVFTool always writes these two, and since we can only
1276	// have one SATA controller, we'll use this as well
1277	lAddress = 0;
1278	lBusNumber = 0;
1279
1280	if ( desc.strVboxCurrent.isEmpty() // LsiLogic is the default in VirtualBox
1281	\|\| (!desc.strVboxCurrent.compare("lsilogic", Utf8Str::CaseInsensitive))
1282	)
1283	strResourceSubType = "lsilogic";
1284	else if (!desc.strVboxCurrent.compare("buslogic", Utf8Str::CaseInsensitive))
1285	strResourceSubType = "buslogic";
1286	else if (!desc.strVboxCurrent.compare("lsilogicsas", Utf8Str::CaseInsensitive))
1287	strResourceSubType = "lsilogicsas";
1288	else
1289	throw setError(VBOX_E_NOT_SUPPORTED,
1290	tr("Invalid config string \"%s\" in SCSI/SAS controller"), desc.strVboxCurrent.c_str());
1291
1292	// remember this ID
1293	idSCSIController = ulInstanceID;
1294	lSCSIControllerIndex = lIndexThis;
1295	}
1296	break;
1297
1298	case VirtualSystemDescriptionType_HardDiskImage:
1299	/* <Item>
1300	<rasd:Caption>disk1</rasd:Caption>
1301	<rasd:InstanceId>8</rasd:InstanceId>
1302	<rasd:ResourceType>17</rasd:ResourceType>
1303	<rasd:HostResource>/disk/vmdisk1</rasd:HostResource>
1304	<rasd:Parent>4</rasd:Parent>
1305	<rasd:AddressOnParent>0</rasd:AddressOnParent>
1306	</Item> */
1307	if (uLoop == 2)
1308	{
1309	uint32_t cDisks = stack.mapDisks.size();
1310	Utf8Str strDiskID = Utf8StrFmt("vmdisk%RI32", ++cDisks);
1311
1312	strDescription = "Disk Image";
1313	strCaption = Utf8StrFmt("disk%RI32", cDisks); // this is not used for anything else
1314	type = ovf::ResourceType_HardDisk; // 17
1315
1316	// the following references the "<Disks>" XML block
1317	strHostResource = Utf8StrFmt("/disk/%s", strDiskID.c_str());
1318
1319	// controller=<index>;channel=<c>
1320	size_t pos1 = desc.strExtraConfigCurrent.find("controller=");
1321	size_t pos2 = desc.strExtraConfigCurrent.find("channel=");
1322	int32_t lControllerIndex = -1;
1323	if (pos1 != Utf8Str::npos)
1324	{
1325	RTStrToInt32Ex(desc.strExtraConfigCurrent.c_str() + pos1 + 11, NULL, 0, &lControllerIndex);
1326	if (lControllerIndex == lIDEPrimaryControllerIndex)
1327	ulParent = idIDEPrimaryController;
1328	else if (lControllerIndex == lIDESecondaryControllerIndex)
1329	ulParent = idIDESecondaryController;
1330	else if (lControllerIndex == lSCSIControllerIndex)
1331	ulParent = idSCSIController;
1332	else if (lControllerIndex == lSATAControllerIndex)
1333	ulParent = idSATAController;
1334	}
1335	if (pos2 != Utf8Str::npos)
1336	RTStrToInt32Ex(desc.strExtraConfigCurrent.c_str() + pos2 + 8, NULL, 0, &lAddressOnParent);
1337
1338	LogFlowFunc(("HardDiskImage details: pos1=%d, pos2=%d, lControllerIndex=%d, lIDEPrimaryControllerIndex=%d, lIDESecondaryControllerIndex=%d, ulParent=%d, lAddressOnParent=%d\n",
1339	pos1, pos2, lControllerIndex, lIDEPrimaryControllerIndex, lIDESecondaryControllerIndex, ulParent, lAddressOnParent));
1340
1341	if ( !ulParent
1342	\|\| lAddressOnParent == -1
1343	)
1344	throw setError(VBOX_E_NOT_SUPPORTED,
1345	tr("Missing or bad extra config string in hard disk image: \"%s\""), desc.strExtraConfigCurrent.c_str());
1346
1347	stack.mapDisks[strDiskID] = &desc;
1348	}
1349	break;
1350
1351	case VirtualSystemDescriptionType_Floppy:
1352	if (uLoop == 1)
1353	{
1354	strDescription = "Floppy Drive";
1355	strCaption = "floppy0"; // this is what OVFTool writes
1356	type = ovf::ResourceType_FloppyDrive; // 14
1357	lAutomaticAllocation = 0;
1358	lAddressOnParent = 0; // this is what OVFTool writes
1359	}
1360	break;
1361
1362	case VirtualSystemDescriptionType_CDROM:
1363	if (uLoop == 2)
1364	{
1365	strDescription = "CD-ROM Drive";
1366	strCaption = Utf8StrFmt("cdrom%RI32", ++cDVDs); // OVFTool starts with 1
1367	type = ovf::ResourceType_CDDrive; // 15
1368	lAutomaticAllocation = 1;
1369
1370	// controller=<index>;channel=<c>
1371	size_t pos1 = desc.strExtraConfigCurrent.find("controller=");
1372	size_t pos2 = desc.strExtraConfigCurrent.find("channel=");
1373	int32_t lControllerIndex = -1;
1374	if (pos1 != Utf8Str::npos)
1375	{
1376	RTStrToInt32Ex(desc.strExtraConfigCurrent.c_str() + pos1 + 11, NULL, 0, &lControllerIndex);
1377	if (lControllerIndex == lIDEPrimaryControllerIndex)
1378	ulParent = idIDEPrimaryController;
1379	else if (lControllerIndex == lIDESecondaryControllerIndex)
1380	ulParent = idIDESecondaryController;
1381	else if (lControllerIndex == lSCSIControllerIndex)
1382	ulParent = idSCSIController;
1383	else if (lControllerIndex == lSATAControllerIndex)
1384	ulParent = idSATAController;
1385	}
1386	if (pos2 != Utf8Str::npos)
1387	RTStrToInt32Ex(desc.strExtraConfigCurrent.c_str() + pos2 + 8, NULL, 0, &lAddressOnParent);
1388
1389	LogFlowFunc(("DVD drive details: pos1=%d, pos2=%d, lControllerIndex=%d, lIDEPrimaryControllerIndex=%d, lIDESecondaryControllerIndex=%d, ulParent=%d, lAddressOnParent=%d\n",
1390	pos1, pos2, lControllerIndex, lIDEPrimaryControllerIndex, lIDESecondaryControllerIndex, ulParent, lAddressOnParent));
1391
1392	if ( !ulParent
1393	\|\| lAddressOnParent == -1
1394	)
1395	throw setError(VBOX_E_NOT_SUPPORTED,
1396	tr("Missing or bad extra config string in DVD drive medium: \"%s\""), desc.strExtraConfigCurrent.c_str());
1397
1398	// there is no DVD drive map to update because it is
1399	// handled completely with this entry.
1400	}
1401	break;
1402
1403	case VirtualSystemDescriptionType_NetworkAdapter:
1404	/* <Item>
1405	<rasd:AutomaticAllocation>true</rasd:AutomaticAllocation>
1406	<rasd:Caption>Ethernet adapter on 'VM Network'</rasd:Caption>
1407	<rasd:Connection>VM Network</rasd:Connection>
1408	<rasd:ElementName>VM network</rasd:ElementName>
1409	<rasd:InstanceID>3</rasd:InstanceID>
1410	<rasd:ResourceType>10</rasd:ResourceType>
1411	</Item> */
1412	if (uLoop == 1)
1413	{
1414	lAutomaticAllocation = 1;
1415	strCaption = Utf8StrFmt("Ethernet adapter on '%s'", desc.strOvf.c_str());
1416	type = ovf::ResourceType_EthernetAdapter; // 10
1417	/* Set the hardware type to something useful.
1418	* To be compatible with vmware & others we set
1419	* PCNet32 for our PCNet types & E1000 for the
1420	* E1000 cards. */
1421	switch (desc.strVboxCurrent.toInt32())
1422	{
1423	case NetworkAdapterType_Am79C970A:
1424	case NetworkAdapterType_Am79C973: strResourceSubType = "PCNet32"; break;
1425	#ifdef VBOX_WITH_E1000
1426	case NetworkAdapterType_I82540EM:
1427	case NetworkAdapterType_I82545EM:
1428	case NetworkAdapterType_I82543GC: strResourceSubType = "E1000"; break;
1429	#endif /* VBOX_WITH_E1000 */
1430	}
1431	strConnection = desc.strOvf;
1432
1433	stack.mapNetworks[desc.strOvf] = true;
1434	}
1435	break;
1436
1437	case VirtualSystemDescriptionType_USBController:
1438	/* <Item ovf:required="false">
1439	<rasd:Caption>usb</rasd:Caption>
1440	<rasd:Description>USB Controller</rasd:Description>
1441	<rasd:InstanceId>3</rasd:InstanceId>
1442	<rasd:ResourceType>23</rasd:ResourceType>
1443	<rasd:Address>0</rasd:Address>
1444	<rasd:BusNumber>0</rasd:BusNumber>
1445	</Item> */
1446	if (uLoop == 1)
1447	{
1448	strDescription = "USB Controller";
1449	strCaption = "usb";
1450	type = ovf::ResourceType_USBController; // 23
1451	lAddress = 0; // this is what OVFTool writes
1452	lBusNumber = 0; // this is what OVFTool writes
1453	}
1454	break;
1455
1456	case VirtualSystemDescriptionType_SoundCard:
1457	/* <Item ovf:required="false">
1458	<rasd:Caption>sound</rasd:Caption>
1459	<rasd:Description>Sound Card</rasd:Description>
1460	<rasd:InstanceId>10</rasd:InstanceId>
1461	<rasd:ResourceType>35</rasd:ResourceType>
1462	<rasd:ResourceSubType>ensoniq1371</rasd:ResourceSubType>
1463	<rasd:AutomaticAllocation>false</rasd:AutomaticAllocation>
1464	<rasd:AddressOnParent>3</rasd:AddressOnParent>
1465	</Item> */
1466	if (uLoop == 1)
1467	{
1468	strDescription = "Sound Card";
1469	strCaption = "sound";
1470	type = ovf::ResourceType_SoundCard; // 35
1471	strResourceSubType = desc.strOvf; // e.g. ensoniq1371
1472	lAutomaticAllocation = 0;
1473	lAddressOnParent = 3; // what gives? this is what OVFTool writes
1474	}
1475	break;
1476	}
1477
1478	if (type)
1479	{
1480	xml::ElementNode *pItem;
1481
1482	pItem = pelmVirtualHardwareSection->createChild("Item");
1483
1484	// NOTE: DO NOT CHANGE THE ORDER of these items! The OVF standards prescribes that
1485	// the elements from the rasd: namespace must be sorted by letter, and VMware
1486	// actually requires this as well (see public bug #6612)
1487
1488	if (lAddress != -1)
1489	pItem->createChild("rasd:Address")->addContent(Utf8StrFmt("%d", lAddress));
1490
1491	if (lAddressOnParent != -1)
1492	pItem->createChild("rasd:AddressOnParent")->addContent(Utf8StrFmt("%d", lAddressOnParent));
1493
1494	if (!strAllocationUnits.isEmpty())
1495	pItem->createChild("rasd:AllocationUnits")->addContent(strAllocationUnits);
1496
1497	if (lAutomaticAllocation != -1)
1498	pItem->createChild("rasd:AutomaticAllocation")->addContent( (lAutomaticAllocation) ? "true" : "false" );
1499
1500	if (lBusNumber != -1)
1501	if (enFormat == OVF_0_9) // BusNumber is invalid OVF 1.0 so only write it in 0.9 mode for OVFTool compatibility
1502	pItem->createChild("rasd:BusNumber")->addContent(Utf8StrFmt("%d", lBusNumber));
1503
1504	if (!strCaption.isEmpty())
1505	pItem->createChild("rasd:Caption")->addContent(strCaption);
1506
1507	if (!strConnection.isEmpty())
1508	pItem->createChild("rasd:Connection")->addContent(strConnection);
1509
1510	if (!strDescription.isEmpty())
1511	pItem->createChild("rasd:Description")->addContent(strDescription);
1512
1513	if (!strCaption.isEmpty())
1514	if (enFormat == OVF_1_0)
1515	pItem->createChild("rasd:ElementName")->addContent(strCaption);
1516
1517	if (!strHostResource.isEmpty())
1518	pItem->createChild("rasd:HostResource")->addContent(strHostResource);
1519
1520	// <rasd:InstanceID>1</rasd:InstanceID>
1521	xml::ElementNode *pelmInstanceID;
1522	if (enFormat == OVF_0_9)
1523	pelmInstanceID = pItem->createChild("rasd:InstanceId");
1524	else
1525	pelmInstanceID = pItem->createChild("rasd:InstanceID"); // capitalization changed...
1526	pelmInstanceID->addContent(Utf8StrFmt("%d", ulInstanceID++));
1527
1528	if (ulParent)
1529	pItem->createChild("rasd:Parent")->addContent(Utf8StrFmt("%d", ulParent));
1530
1531	if (!strResourceSubType.isEmpty())
1532	pItem->createChild("rasd:ResourceSubType")->addContent(strResourceSubType);
1533
1534	// <rasd:ResourceType>3</rasd:ResourceType>
1535	pItem->createChild("rasd:ResourceType")->addContent(Utf8StrFmt("%d", type));
1536
1537	// <rasd:VirtualQuantity>1</rasd:VirtualQuantity>
1538	if (lVirtualQuantity != -1)
1539	pItem->createChild("rasd:VirtualQuantity")->addContent(Utf8StrFmt("%d", lVirtualQuantity));
1540	}
1541	}
1542	} // for (size_t uLoop = 1; uLoop <= 2; ++uLoop)
1543
1544	// now that we're done with the official OVF <Item> tags under <VirtualSystem>, write out VirtualBox XML
1545	// under the vbox: namespace
1546	xml::ElementNode *pelmVBoxMachine = pelmVirtualSystem->createChild("vbox:Machine");
1547	// ovf:required="false" tells other OVF parsers that they can ignore this thing
1548	pelmVBoxMachine->setAttribute("ovf:required", "false");
1549	// ovf:Info element is required or VMware will bail out on the vbox:Machine element
1550	pelmVBoxMachine->createChild("ovf:Info")->addContent("Complete VirtualBox machine configuration in VirtualBox format");
1551
1552	// create an empty machine config
1553	settings::MachineConfigFile *pConfig = new settings::MachineConfigFile(NULL);
1554
1555	writeLock.release();
1556	try
1557	{
1558	AutoWriteLock machineLock(vsdescThis->m->pMachine COMMA_LOCKVAL_SRC_POS);
1559	// fill the machine config
1560	vsdescThis->m->pMachine->copyMachineDataToSettings(*pConfig);
1561	// write the machine config to the vbox:Machine element
1562	pConfig->buildMachineXML(*pelmVBoxMachine,
1563	settings::MachineConfigFile::BuildMachineXML_WriteVboxVersionAttribute
1564	\| settings::MachineConfigFile::BuildMachineXML_SkipRemovableMedia
1565	\| settings::MachineConfigFile::BuildMachineXML_SuppressSavedState,
1566	// but not BuildMachineXML_IncludeSnapshots nor BuildMachineXML_MediaRegistry
1567	pllElementsWithUuidAttributes);
1568	delete pConfig;
1569	}
1570	catch (...)
1571	{
1572	writeLock.acquire();
1573	delete pConfig;
1574	throw;
1575	}
1576	writeLock.acquire();
1577	}
1578
1579	/**
1580	* Actual worker code for writing out OVF/OVA to disk. This is called from Appliance::taskThreadWriteOVF()
1581	* and therefore runs on the OVF/OVA write worker thread. This runs in two contexts:
1582	*
1583	* 1) in a first worker thread; in that case, Appliance::Write() called Appliance::writeImpl();
1584	*
1585	* 2) in a second worker thread; in that case, Appliance::Write() called Appliance::writeImpl(), which
1586	* called Appliance::writeS3(), which called Appliance::writeImpl(), which then called this. In other
1587	* words, to write to the cloud, the first worker thread first starts a second worker thread to create
1588	* temporary files and then uploads them to the S3 cloud server.
1589	*
1590	* @param pTask
1591	* @return
1592	*/
1593	HRESULT Appliance::writeFS(TaskOVF *pTask)
1594	{
1595	LogFlowFuncEnter();
1596	LogFlowFunc(("ENTER appliance %p\n", this));
1597
1598	AutoCaller autoCaller(this);
1599	if (FAILED(autoCaller.rc())) return autoCaller.rc();
1600
1601	HRESULT rc = S_OK;
1602
1603	// Lock the media tree early to make sure nobody else tries to make changes
1604	// to the tree. Also lock the IAppliance object for writing.
1605	AutoMultiWriteLock2 multiLock(&mVirtualBox->getMediaTreeLockHandle(), this->lockHandle() COMMA_LOCKVAL_SRC_POS);
1606	// Additional protect the IAppliance object, cause we leave the lock
1607	// when starting the disk export and we don't won't block other
1608	// callers on this lengthy operations.
1609	m->state = Data::ApplianceExporting;
1610
1611	if (pTask->locInfo.strPath.endsWith(".ovf", Utf8Str::CaseInsensitive))
1612	rc = writeFSOVF(pTask, multiLock);
1613	else
1614	rc = writeFSOVA(pTask, multiLock);
1615
1616	// reset the state so others can call methods again
1617	m->state = Data::ApplianceIdle;
1618
1619	LogFlowFunc(("rc=%Rhrc\n", rc));
1620	LogFlowFuncLeave();
1621	return rc;
1622	}
1623
1624	HRESULT Appliance::writeFSOVF(TaskOVF *pTask, AutoWriteLockBase& writeLock)
1625	{
1626	LogFlowFuncEnter();
1627
1628	HRESULT rc = S_OK;
1629
1630	PVDINTERFACEIO pShaIo = 0;
1631	PVDINTERFACEIO pFileIo = 0;
1632	do
1633	{
1634	pShaIo = ShaCreateInterface();
1635	if (!pShaIo)
1636	{
1637	rc = E_OUTOFMEMORY;
1638	break;
1639	}
1640	pFileIo = FileCreateInterface();
1641	if (!pFileIo)
1642	{
1643	rc = E_OUTOFMEMORY;
1644	break;
1645	}
1646
1647	SHASTORAGE storage;
1648	RT_ZERO(storage);
1649	storage.fCreateDigest = m->fManifest;
1650	storage.fSha256 = m->fSha256;
1651	int vrc = VDInterfaceAdd(&pFileIo->Core, "Appliance::IOFile",
1652	VDINTERFACETYPE_IO, 0, sizeof(VDINTERFACEIO),
1653	&storage.pVDImageIfaces);
1654	if (RT_FAILURE(vrc))
1655	{
1656	rc = E_FAIL;
1657	break;
1658	}
1659	rc = writeFSImpl(pTask, writeLock, pShaIo, &storage);
1660	}while(0);
1661
1662	/* Cleanup */
1663	if (pShaIo)
1664	RTMemFree(pShaIo);
1665	if (pFileIo)
1666	RTMemFree(pFileIo);
1667
1668	LogFlowFuncLeave();
1669	return rc;
1670	}
1671
1672	HRESULT Appliance::writeFSOVA(TaskOVF *pTask, AutoWriteLockBase& writeLock)
1673	{
1674	LogFlowFuncEnter();
1675
1676	RTTAR tar;
1677	int vrc = RTTarOpen(&tar, pTask->locInfo.strPath.c_str(), RTFILE_O_CREATE \| RTFILE_O_WRITE \| RTFILE_O_DENY_ALL, false);
1678	if (RT_FAILURE(vrc))
1679	return setError(VBOX_E_FILE_ERROR,
1680	tr("Could not create OVA file '%s' (%Rrc)"),
1681	pTask->locInfo.strPath.c_str(), vrc);
1682
1683	HRESULT rc = S_OK;
1684
1685	PVDINTERFACEIO pShaIo = 0;
1686	PVDINTERFACEIO pTarIo = 0;
1687	do
1688	{
1689	pShaIo = ShaCreateInterface();
1690	if (!pShaIo)
1691	{
1692	rc = E_OUTOFMEMORY;
1693	break;
1694	}
1695	pTarIo = TarCreateInterface();
1696	if (!pTarIo)
1697	{
1698	rc = E_OUTOFMEMORY;
1699	break;
1700	}
1701	SHASTORAGE storage;
1702	RT_ZERO(storage);
1703	storage.fCreateDigest = m->fManifest;
1704	storage.fSha256 = m->fSha256;
1705	vrc = VDInterfaceAdd(&pTarIo->Core, "Appliance::IOTar",
1706	VDINTERFACETYPE_IO, tar, sizeof(VDINTERFACEIO),
1707	&storage.pVDImageIfaces);
1708	if (RT_FAILURE(vrc))
1709	{
1710	rc = E_FAIL;
1711	break;
1712	}
1713	rc = writeFSImpl(pTask, writeLock, pShaIo, &storage);
1714	}while(0);
1715
1716	RTTarClose(tar);
1717
1718	/* Cleanup */
1719	if (pShaIo)
1720	RTMemFree(pShaIo);
1721	if (pTarIo)
1722	RTMemFree(pTarIo);
1723
1724	/* Delete ova file on error */
1725	if(FAILED(rc))
1726	RTFileDelete(pTask->locInfo.strPath.c_str());
1727
1728	LogFlowFuncLeave();
1729	return rc;
1730	}
1731
1732	HRESULT Appliance::writeFSImpl(TaskOVF *pTask, AutoWriteLockBase& writeLock, PVDINTERFACEIO pIfIo, PSHASTORAGE pStorage)
1733	{
1734	LogFlowFuncEnter();
1735
1736	HRESULT rc = S_OK;
1737
1738	list<STRPAIR> fileList;
1739	try
1740	{
1741	int vrc;
1742	// the XML stack contains two maps for disks and networks, which allows us to
1743	// a) have a list of unique disk names (to make sure the same disk name is only added once)
1744	// and b) keep a list of all networks
1745	XMLStack stack;
1746	// Scope this to free the memory as soon as this is finished
1747	{
1748	// Create a xml document
1749	xml::Document doc;
1750	// Now fully build a valid ovf document in memory
1751	buildXML(writeLock, doc, stack, pTask->locInfo.strPath, pTask->enFormat);
1752	/* Extract the path */
1753	Utf8Str strOvfFile = Utf8Str(pTask->locInfo.strPath).stripExt().append(".ovf");
1754	// Create a memory buffer containing the XML. */
1755	void *pvBuf = 0;
1756	size_t cbSize;
1757	xml::XmlMemWriter writer;
1758	writer.write(doc, &pvBuf, &cbSize);
1759	if (RT_UNLIKELY(!pvBuf))
1760	throw setError(VBOX_E_FILE_ERROR,
1761	tr("Could not create OVF file '%s'"),
1762	strOvfFile.c_str());
1763	/* Write the ovf file to disk. */
1764	vrc = ShaWriteBuf(strOvfFile.c_str(), pvBuf, cbSize, pIfIo, pStorage);
1765	if (RT_FAILURE(vrc))
1766	throw setError(VBOX_E_FILE_ERROR,
1767	tr("Could not create OVF file '%s' (%Rrc)"),
1768	strOvfFile.c_str(), vrc);
1769	fileList.push_back(STRPAIR(strOvfFile, pStorage->strDigest));
1770	}
1771
1772	// We need a proper format description
1773	ComObjPtr<MediumFormat> format;
1774	// Scope for the AutoReadLock
1775	{
1776	SystemProperties *pSysProps = mVirtualBox->getSystemProperties();
1777	AutoReadLock propsLock(pSysProps COMMA_LOCKVAL_SRC_POS);
1778	// We are always exporting to VMDK stream optimized for now
1779	format = pSysProps->mediumFormat("VMDK");
1780	if (format.isNull())
1781	throw setError(VBOX_E_NOT_SUPPORTED,
1782	tr("Invalid medium storage format"));
1783	}
1784
1785	// Finally, write out the disks!
1786	map<Utf8Str, const VirtualSystemDescriptionEntry*>::const_iterator itS;
1787	for (itS = stack.mapDisks.begin();
1788	itS != stack.mapDisks.end();
1789	++itS)
1790	{
1791	const VirtualSystemDescriptionEntry *pDiskEntry = itS->second;
1792
1793	// source path: where the VBox image is
1794	const Utf8Str &strSrcFilePath = pDiskEntry->strVboxCurrent;
1795
1796	// Do NOT check here whether the file exists. findHardDisk will
1797	// figure that out, and filesystem-based tests are simply wrong
1798	// in the general case (think of iSCSI).
1799
1800	// clone the disk:
1801	ComObjPtr<Medium> pSourceDisk;
1802
1803	Log(("Finding source disk \"%s\"\n", strSrcFilePath.c_str()));
1804	rc = mVirtualBox->findHardDiskByLocation(strSrcFilePath, true, &pSourceDisk);
1805	if (FAILED(rc)) throw rc;
1806
1807	Bstr uuidSource;
1808	rc = pSourceDisk->COMGETTER(Id)(uuidSource.asOutParam());
1809	if (FAILED(rc)) throw rc;
1810	Guid guidSource(uuidSource);
1811
1812	// output filename
1813	const Utf8Str &strTargetFileNameOnly = pDiskEntry->strOvf;
1814	// target path needs to be composed from where the output OVF is
1815	Utf8Str strTargetFilePath(pTask->locInfo.strPath);
1816	strTargetFilePath.stripFilename()
1817	.append("/")
1818	.append(strTargetFileNameOnly);
1819
1820	// The exporting requests a lock on the media tree. So leave our lock temporary.
1821	writeLock.release();
1822	try
1823	{
1824	ComObjPtr<Progress> pProgress2;
1825	pProgress2.createObject();
1826	rc = pProgress2->init(mVirtualBox, static_cast<IAppliance*>(this), BstrFmt(tr("Creating medium '%s'"), strTargetFilePath.c_str()).raw(), TRUE);
1827	if (FAILED(rc)) throw rc;
1828
1829	// advance to the next operation
1830	pTask->pProgress->SetNextOperation(BstrFmt(tr("Exporting to disk image '%s'"), RTPathFilename(strTargetFilePath.c_str())).raw(),
1831	pDiskEntry->ulSizeMB); // operation's weight, as set up with the IProgress originally
1832
1833	// create a flat copy of the source disk image
1834	rc = pSourceDisk->exportFile(strTargetFilePath.c_str(), format, MediumVariant_VmdkStreamOptimized, pIfIo, pStorage, pProgress2);
1835	if (FAILED(rc)) throw rc;
1836
1837	ComPtr<IProgress> pProgress3(pProgress2);
1838	// now wait for the background disk operation to complete; this throws HRESULTs on error
1839	waitForAsyncProgress(pTask->pProgress, pProgress3);
1840	}
1841	catch (HRESULT rc3)
1842	{
1843	writeLock.acquire();
1844	// Todo: file deletion on error? If not, we can remove that whole try/catch block.
1845	throw rc3;
1846	}
1847	// Finished, lock again (so nobody mess around with the medium tree
1848	// in the meantime)
1849	writeLock.acquire();
1850	fileList.push_back(STRPAIR(strTargetFilePath, pStorage->strDigest));
1851	}
1852
1853	if (m->fManifest)
1854	{
1855	// Create & write the manifest file
1856	Utf8Str strMfFilePath = Utf8Str(pTask->locInfo.strPath).stripExt().append(".mf");
1857	Utf8Str strMfFileName = Utf8Str(strMfFilePath).stripPath();
1858	pTask->pProgress->SetNextOperation(BstrFmt(tr("Creating manifest file '%s'"), strMfFileName.c_str()).raw(),
1859	m->ulWeightForManifestOperation); // operation's weight, as set up with the IProgress originally);
1860	PRTMANIFESTTEST paManifestFiles = (PRTMANIFESTTEST)RTMemAlloc(sizeof(RTMANIFESTTEST) * fileList.size());
1861	size_t i = 0;
1862	list<STRPAIR>::const_iterator it1;
1863	for (it1 = fileList.begin();
1864	it1 != fileList.end();
1865	++it1, ++i)
1866	{
1867	paManifestFiles[i].pszTestFile = (*it1).first.c_str();
1868	paManifestFiles[i].pszTestDigest = (*it1).second.c_str();
1869	}
1870	void *pvBuf;
1871	size_t cbSize;
1872	vrc = RTManifestWriteFilesBuf(&pvBuf, &cbSize, m->fSha256 ? RTDIGESTTYPE_SHA256 : RTDIGESTTYPE_SHA1,
1873	paManifestFiles, fileList.size());
1874	RTMemFree(paManifestFiles);
1875	if (RT_FAILURE(vrc))
1876	throw setError(VBOX_E_FILE_ERROR,
1877	tr("Could not create manifest file '%s' (%Rrc)"),
1878	strMfFileName.c_str(), vrc);
1879	/* Disable digest creation for the manifest file. */
1880	pStorage->fCreateDigest = false;
1881	/* Write the manifest file to disk. */
1882	vrc = ShaWriteBuf(strMfFilePath.c_str(), pvBuf, cbSize, pIfIo, pStorage);
1883	RTMemFree(pvBuf);
1884	if (RT_FAILURE(vrc))
1885	throw setError(VBOX_E_FILE_ERROR,
1886	tr("Could not create manifest file '%s' (%Rrc)"),
1887	strMfFilePath.c_str(), vrc);
1888	}
1889	}
1890	catch (RTCError &x) // includes all XML exceptions
1891	{
1892	rc = setError(VBOX_E_FILE_ERROR,
1893	x.what());
1894	}
1895	catch (HRESULT aRC)
1896	{
1897	rc = aRC;
1898	}
1899
1900	/* Cleanup on error */
1901	if (FAILED(rc))
1902	{
1903	list<STRPAIR>::const_iterator it1;
1904	for (it1 = fileList.begin();
1905	it1 != fileList.end();
1906	++it1)
1907	pIfIo->pfnDelete(pStorage, (*it1).first.c_str());
1908	}
1909
1910	LogFlowFunc(("rc=%Rhrc\n", rc));
1911	LogFlowFuncLeave();
1912
1913	return rc;
1914	}
1915
1916	#ifdef VBOX_WITH_S3
1917	/**
1918	* Worker code for writing out OVF to the cloud. This is called from Appliance::taskThreadWriteOVF()
1919	* in S3 mode and therefore runs on the OVF write worker thread. This then starts a second worker
1920	* thread to create temporary files (see Appliance::writeFS()).
1921	*
1922	* @param pTask
1923	* @return
1924	*/
1925	HRESULT Appliance::writeS3(TaskOVF *pTask)
1926	{
1927	LogFlowFuncEnter();
1928	LogFlowFunc(("Appliance %p\n", this));
1929
1930	AutoCaller autoCaller(this);
1931	if (FAILED(autoCaller.rc())) return autoCaller.rc();
1932
1933	HRESULT rc = S_OK;
1934
1935	AutoWriteLock appLock(this COMMA_LOCKVAL_SRC_POS);
1936
1937	int vrc = VINF_SUCCESS;
1938	RTS3 hS3 = NIL_RTS3;
1939	char szOSTmpDir[RTPATH_MAX];
1940	RTPathTemp(szOSTmpDir, sizeof(szOSTmpDir));
1941	/* The template for the temporary directory created below */
1942	char *pszTmpDir = RTPathJoinA(szOSTmpDir, "vbox-ovf-XXXXXX");
1943	list< pair<Utf8Str, ULONG> > filesList;
1944
1945	// todo:
1946	// - usable error codes
1947	// - seems snapshot filenames are problematic {uuid}.vdi
1948	try
1949	{
1950	/* Extract the bucket */
1951	Utf8Str tmpPath = pTask->locInfo.strPath;
1952	Utf8Str bucket;
1953	parseBucket(tmpPath, bucket);
1954
1955	/* We need a temporary directory which we can put the OVF file & all
1956	* disk images in */
1957	vrc = RTDirCreateTemp(pszTmpDir, 0700);
1958	if (RT_FAILURE(vrc))
1959	throw setError(VBOX_E_FILE_ERROR,
1960	tr("Cannot create temporary directory '%s' (%Rrc)"), pszTmpDir, vrc);
1961
1962	/* The temporary name of the target OVF file */
1963	Utf8StrFmt strTmpOvf("%s/%s", pszTmpDir, RTPathFilename(tmpPath.c_str()));
1964
1965	/* Prepare the temporary writing of the OVF */
1966	ComObjPtr<Progress> progress;
1967	/* Create a temporary file based location info for the sub task */
1968	LocationInfo li;
1969	li.strPath = strTmpOvf;
1970	rc = writeImpl(pTask->enFormat, li, progress);
1971	if (FAILED(rc)) throw rc;
1972
1973	/* Unlock the appliance for the writing thread */
1974	appLock.release();
1975	/* Wait until the writing is done, but report the progress back to the
1976	caller */
1977	ComPtr<IProgress> progressInt(progress);
1978	waitForAsyncProgress(pTask->pProgress, progressInt); /* Any errors will be thrown */
1979
1980	/* Again lock the appliance for the next steps */
1981	appLock.acquire();
1982
1983	vrc = RTPathExists(strTmpOvf.c_str()); /* Paranoid check */
1984	if (RT_FAILURE(vrc))
1985	throw setError(VBOX_E_FILE_ERROR,
1986	tr("Cannot find source file '%s' (%Rrc)"), strTmpOvf.c_str(), vrc);
1987	/* Add the OVF file */
1988	filesList.push_back(pair<Utf8Str, ULONG>(strTmpOvf, m->ulWeightForXmlOperation)); /* Use 1% of the total for the OVF file upload */
1989	/* Add the manifest file */
1990	if (m->fManifest)
1991	{
1992	Utf8Str strMfFile = Utf8Str(strTmpOvf).stripExt().append(".mf");
1993	filesList.push_back(pair<Utf8Str, ULONG>(strMfFile , m->ulWeightForXmlOperation)); /* Use 1% of the total for the manifest file upload */
1994	}
1995
1996	/* Now add every disks of every virtual system */
1997	list< ComObjPtr<VirtualSystemDescription> >::const_iterator it;
1998	for (it = m->virtualSystemDescriptions.begin();
1999	it != m->virtualSystemDescriptions.end();
2000	++it)
2001	{
2002	ComObjPtr<VirtualSystemDescription> vsdescThis = (*it);
2003	std::list<VirtualSystemDescriptionEntry*> avsdeHDs = vsdescThis->findByType(VirtualSystemDescriptionType_HardDiskImage);
2004	std::list<VirtualSystemDescriptionEntry*>::const_iterator itH;
2005	for (itH = avsdeHDs.begin();
2006	itH != avsdeHDs.end();
2007	++itH)
2008	{
2009	const Utf8Str &strTargetFileNameOnly = (*itH)->strOvf;
2010	/* Target path needs to be composed from where the output OVF is */
2011	Utf8Str strTargetFilePath(strTmpOvf);
2012	strTargetFilePath.stripFilename();
2013	strTargetFilePath.append("/");
2014	strTargetFilePath.append(strTargetFileNameOnly);
2015	vrc = RTPathExists(strTargetFilePath.c_str()); /* Paranoid check */
2016	if (RT_FAILURE(vrc))
2017	throw setError(VBOX_E_FILE_ERROR,
2018	tr("Cannot find source file '%s' (%Rrc)"), strTargetFilePath.c_str(), vrc);
2019	filesList.push_back(pair<Utf8Str, ULONG>(strTargetFilePath, (*itH)->ulSizeMB));
2020	}
2021	}
2022	/* Next we have to upload the OVF & all disk images */
2023	vrc = RTS3Create(&hS3, pTask->locInfo.strUsername.c_str(), pTask->locInfo.strPassword.c_str(), pTask->locInfo.strHostname.c_str(), "virtualbox-agent/"VBOX_VERSION_STRING);
2024	if (RT_FAILURE(vrc))
2025	throw setError(VBOX_E_IPRT_ERROR,
2026	tr("Cannot create S3 service handler"));
2027	RTS3SetProgressCallback(hS3, pTask->updateProgress, &pTask);
2028
2029	/* Upload all files */
2030	for (list< pair<Utf8Str, ULONG> >::const_iterator it1 = filesList.begin(); it1 != filesList.end(); ++it1)
2031	{
2032	const pair<Utf8Str, ULONG> &s = (*it1);
2033	char *pszFilename = RTPathFilename(s.first.c_str());
2034	/* Advance to the next operation */
2035	pTask->pProgress->SetNextOperation(BstrFmt(tr("Uploading file '%s'"), pszFilename).raw(), s.second);
2036	vrc = RTS3PutKey(hS3, bucket.c_str(), pszFilename, s.first.c_str());
2037	if (RT_FAILURE(vrc))
2038	{
2039	if (vrc == VERR_S3_CANCELED)
2040	break;
2041	else if (vrc == VERR_S3_ACCESS_DENIED)
2042	throw setError(E_ACCESSDENIED,
2043	tr("Cannot upload file '%s' to S3 storage server (Access denied). Make sure that your credentials are right. Also check that your host clock is properly synced"), pszFilename);
2044	else if (vrc == VERR_S3_NOT_FOUND)
2045	throw setError(VBOX_E_FILE_ERROR,
2046	tr("Cannot upload file '%s' to S3 storage server (File not found)"), pszFilename);
2047	else
2048	throw setError(VBOX_E_IPRT_ERROR,
2049	tr("Cannot upload file '%s' to S3 storage server (%Rrc)"), pszFilename, vrc);
2050	}
2051	}
2052	}
2053	catch(HRESULT aRC)
2054	{
2055	rc = aRC;
2056	}
2057	/* Cleanup */
2058	RTS3Destroy(hS3);
2059	/* Delete all files which where temporary created */
2060	for (list< pair<Utf8Str, ULONG> >::const_iterator it1 = filesList.begin(); it1 != filesList.end(); ++it1)
2061	{
2062	const char pszFilePath = (it1).first.c_str();
2063	if (RTPathExists(pszFilePath))
2064	{
2065	vrc = RTFileDelete(pszFilePath);
2066	if (RT_FAILURE(vrc))
2067	rc = setError(VBOX_E_FILE_ERROR,
2068	tr("Cannot delete file '%s' (%Rrc)"), pszFilePath, vrc);
2069	}
2070	}
2071	/* Delete the temporary directory */
2072	if (RTPathExists(pszTmpDir))
2073	{
2074	vrc = RTDirRemove(pszTmpDir);
2075	if (RT_FAILURE(vrc))
2076	rc = setError(VBOX_E_FILE_ERROR,
2077	tr("Cannot delete temporary directory '%s' (%Rrc)"), pszTmpDir, vrc);
2078	}
2079	if (pszTmpDir)
2080	RTStrFree(pszTmpDir);
2081
2082	LogFlowFunc(("rc=%Rhrc\n", rc));
2083	LogFlowFuncLeave();
2084
2085	return rc;
2086	}
2087	#endif /* VBOX_WITH_S3 */

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

source: vbox/trunk/src/VBox/Main/src-server/ApplianceImplExport.cpp@ 44824

Download in other formats: