ApplianceImplExport.cpp@ 29087

Last change on this file since 29087 was 29087, checked in by vboxsync, 15 years ago
Main/OVF: support LsiLogicSas controller import & export; remove obsolete ifdefs
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 76.8 KB

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

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

source: vbox/trunk/src/VBox/Main/ApplianceImplExport.cpp@ 29087

Download in other formats: