VirtualBox

source: vbox/trunk/src/VBox/Main/src-server/ApplianceImplImport.cpp@ 44124

Last change on this file since 44124 was 44039, checked in by vboxsync, 12 years ago

Main: renavation com::Guid class. PR5744

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 120.8 KB
Line 
1/* $Id: ApplianceImplImport.cpp 44039 2012-12-05 12:08:52Z 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/file.h>
22#include <iprt/s3.h>
23#include <iprt/sha.h>
24#include <iprt/manifest.h>
25#include <iprt/tar.h>
26#include <iprt/stream.h>
27
28#include <VBox/vd.h>
29#include <VBox/com/array.h>
30
31#include "ApplianceImpl.h"
32#include "VirtualBoxImpl.h"
33#include "GuestOSTypeImpl.h"
34#include "ProgressImpl.h"
35#include "MachineImpl.h"
36#include "MediumImpl.h"
37#include "MediumFormatImpl.h"
38#include "SystemPropertiesImpl.h"
39#include "HostImpl.h"
40
41#include "AutoCaller.h"
42#include "Logging.h"
43
44#include "ApplianceImplPrivate.h"
45
46#include <VBox/param.h>
47#include <VBox/version.h>
48#include <VBox/settings.h>
49
50using namespace std;
51
52////////////////////////////////////////////////////////////////////////////////
53//
54// IAppliance public methods
55//
56////////////////////////////////////////////////////////////////////////////////
57
58/**
59 * Public method implementation. This opens the OVF with ovfreader.cpp.
60 * Thread implementation is in Appliance::readImpl().
61 *
62 * @param path
63 * @return
64 */
65STDMETHODIMP Appliance::Read(IN_BSTR path, IProgress **aProgress)
66{
67 if (!path) return E_POINTER;
68 CheckComArgOutPointerValid(aProgress);
69
70 AutoCaller autoCaller(this);
71 if (FAILED(autoCaller.rc())) return autoCaller.rc();
72
73 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
74
75 if (!isApplianceIdle())
76 return E_ACCESSDENIED;
77
78 if (m->pReader)
79 {
80 delete m->pReader;
81 m->pReader = NULL;
82 }
83
84 // see if we can handle this file; for now we insist it has an ovf/ova extension
85 Utf8Str strPath (path);
86 if (!( strPath.endsWith(".ovf", Utf8Str::CaseInsensitive)
87 || strPath.endsWith(".ova", Utf8Str::CaseInsensitive)))
88 return setError(VBOX_E_FILE_ERROR,
89 tr("Appliance file must have .ovf extension"));
90
91 ComObjPtr<Progress> progress;
92 HRESULT rc = S_OK;
93 try
94 {
95 /* Parse all necessary info out of the URI */
96 parseURI(strPath, m->locInfo);
97 rc = readImpl(m->locInfo, progress);
98 }
99 catch (HRESULT aRC)
100 {
101 rc = aRC;
102 }
103
104 if (SUCCEEDED(rc))
105 /* Return progress to the caller */
106 progress.queryInterfaceTo(aProgress);
107
108 return S_OK;
109}
110
111/**
112 * Public method implementation. This looks at the output of ovfreader.cpp and creates
113 * VirtualSystemDescription instances.
114 * @return
115 */
116STDMETHODIMP Appliance::Interpret()
117{
118 // @todo:
119 // - don't use COM methods but the methods directly (faster, but needs appropriate locking of that objects itself (s. HardDisk))
120 // - Appropriate handle errors like not supported file formats
121 AutoCaller autoCaller(this);
122 if (FAILED(autoCaller.rc())) return autoCaller.rc();
123
124 AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS);
125
126 if (!isApplianceIdle())
127 return E_ACCESSDENIED;
128
129 HRESULT rc = S_OK;
130
131 /* Clear any previous virtual system descriptions */
132 m->virtualSystemDescriptions.clear();
133
134 if (!m->pReader)
135 return setError(E_FAIL,
136 tr("Cannot interpret appliance without reading it first (call read() before interpret())"));
137
138 // Change the appliance state so we can safely leave the lock while doing time-consuming
139 // disk imports; also the below method calls do all kinds of locking which conflicts with
140 // the appliance object lock
141 m->state = Data::ApplianceImporting;
142 alock.release();
143
144 /* Try/catch so we can clean up on error */
145 try
146 {
147 list<ovf::VirtualSystem>::const_iterator it;
148 /* Iterate through all virtual systems */
149 for (it = m->pReader->m_llVirtualSystems.begin();
150 it != m->pReader->m_llVirtualSystems.end();
151 ++it)
152 {
153 const ovf::VirtualSystem &vsysThis = *it;
154
155 ComObjPtr<VirtualSystemDescription> pNewDesc;
156 rc = pNewDesc.createObject();
157 if (FAILED(rc)) throw rc;
158 rc = pNewDesc->init();
159 if (FAILED(rc)) throw rc;
160
161 // if the virtual system in OVF had a <vbox:Machine> element, have the
162 // VirtualBox settings code parse that XML now
163 if (vsysThis.pelmVboxMachine)
164 pNewDesc->importVboxMachineXML(*vsysThis.pelmVboxMachine);
165
166 // Guest OS type
167 // This is taken from one of three places, in this order:
168 Utf8Str strOsTypeVBox;
169 Utf8StrFmt strCIMOSType("%RU32", (uint32_t)vsysThis.cimos);
170 // 1) If there is a <vbox:Machine>, then use the type from there.
171 if ( vsysThis.pelmVboxMachine
172 && pNewDesc->m->pConfig->machineUserData.strOsType.isNotEmpty()
173 )
174 strOsTypeVBox = pNewDesc->m->pConfig->machineUserData.strOsType;
175 // 2) Otherwise, if there is OperatingSystemSection/vbox:OSType, use that one.
176 else if (vsysThis.strTypeVbox.isNotEmpty()) // OVFReader has found vbox:OSType
177 strOsTypeVBox = vsysThis.strTypeVbox;
178 // 3) Otherwise, make a best guess what the vbox type is from the OVF (CIM) OS type.
179 else
180 convertCIMOSType2VBoxOSType(strOsTypeVBox, vsysThis.cimos, vsysThis.strCimosDesc);
181 pNewDesc->addEntry(VirtualSystemDescriptionType_OS,
182 "",
183 strCIMOSType,
184 strOsTypeVBox);
185
186 /* VM name */
187 Utf8Str nameVBox;
188 /* If there is a <vbox:Machine>, we always prefer the setting from there. */
189 if ( vsysThis.pelmVboxMachine
190 && pNewDesc->m->pConfig->machineUserData.strName.isNotEmpty())
191 nameVBox = pNewDesc->m->pConfig->machineUserData.strName;
192 else
193 nameVBox = vsysThis.strName;
194 /* If there isn't any name specified create a default one out
195 * of the OS type */
196 if (nameVBox.isEmpty())
197 nameVBox = strOsTypeVBox;
198 searchUniqueVMName(nameVBox);
199 pNewDesc->addEntry(VirtualSystemDescriptionType_Name,
200 "",
201 vsysThis.strName,
202 nameVBox);
203
204 /* Based on the VM name, create a target machine path. */
205 Bstr bstrMachineFilename;
206 rc = mVirtualBox->ComposeMachineFilename(Bstr(nameVBox).raw(),
207 NULL /* aGroup */,
208 NULL /* aCreateFlags */,
209 NULL /* aBaseFolder */,
210 bstrMachineFilename.asOutParam());
211 if (FAILED(rc)) throw rc;
212 /* Determine the machine folder from that */
213 Utf8Str strMachineFolder = Utf8Str(bstrMachineFilename).stripFilename();
214
215 /* VM Product */
216 if (!vsysThis.strProduct.isEmpty())
217 pNewDesc->addEntry(VirtualSystemDescriptionType_Product,
218 "",
219 vsysThis.strProduct,
220 vsysThis.strProduct);
221
222 /* VM Vendor */
223 if (!vsysThis.strVendor.isEmpty())
224 pNewDesc->addEntry(VirtualSystemDescriptionType_Vendor,
225 "",
226 vsysThis.strVendor,
227 vsysThis.strVendor);
228
229 /* VM Version */
230 if (!vsysThis.strVersion.isEmpty())
231 pNewDesc->addEntry(VirtualSystemDescriptionType_Version,
232 "",
233 vsysThis.strVersion,
234 vsysThis.strVersion);
235
236 /* VM ProductUrl */
237 if (!vsysThis.strProductUrl.isEmpty())
238 pNewDesc->addEntry(VirtualSystemDescriptionType_ProductUrl,
239 "",
240 vsysThis.strProductUrl,
241 vsysThis.strProductUrl);
242
243 /* VM VendorUrl */
244 if (!vsysThis.strVendorUrl.isEmpty())
245 pNewDesc->addEntry(VirtualSystemDescriptionType_VendorUrl,
246 "",
247 vsysThis.strVendorUrl,
248 vsysThis.strVendorUrl);
249
250 /* VM description */
251 if (!vsysThis.strDescription.isEmpty())
252 pNewDesc->addEntry(VirtualSystemDescriptionType_Description,
253 "",
254 vsysThis.strDescription,
255 vsysThis.strDescription);
256
257 /* VM license */
258 if (!vsysThis.strLicenseText.isEmpty())
259 pNewDesc->addEntry(VirtualSystemDescriptionType_License,
260 "",
261 vsysThis.strLicenseText,
262 vsysThis.strLicenseText);
263
264 /* Now that we know the OS type, get our internal defaults based on that. */
265 ComPtr<IGuestOSType> pGuestOSType;
266 rc = mVirtualBox->GetGuestOSType(Bstr(strOsTypeVBox).raw(), pGuestOSType.asOutParam());
267 if (FAILED(rc)) throw rc;
268
269 /* CPU count */
270 ULONG cpuCountVBox;
271 /* If there is a <vbox:Machine>, we always prefer the setting from there. */
272 if ( vsysThis.pelmVboxMachine
273 && pNewDesc->m->pConfig->hardwareMachine.cCPUs)
274 cpuCountVBox = pNewDesc->m->pConfig->hardwareMachine.cCPUs;
275 else
276 cpuCountVBox = vsysThis.cCPUs;
277 /* Check for the constraints */
278 if (cpuCountVBox > SchemaDefs::MaxCPUCount)
279 {
280 addWarning(tr("The virtual system \"%s\" claims support for %u CPU's, but VirtualBox has support for max %u CPU's only."),
281 vsysThis.strName.c_str(), cpuCountVBox, SchemaDefs::MaxCPUCount);
282 cpuCountVBox = SchemaDefs::MaxCPUCount;
283 }
284 if (vsysThis.cCPUs == 0)
285 cpuCountVBox = 1;
286 pNewDesc->addEntry(VirtualSystemDescriptionType_CPU,
287 "",
288 Utf8StrFmt("%RU32", (uint32_t)vsysThis.cCPUs),
289 Utf8StrFmt("%RU32", (uint32_t)cpuCountVBox));
290
291 /* RAM */
292 uint64_t ullMemSizeVBox;
293 /* If there is a <vbox:Machine>, we always prefer the setting from there. */
294 if ( vsysThis.pelmVboxMachine
295 && pNewDesc->m->pConfig->hardwareMachine.ulMemorySizeMB)
296 ullMemSizeVBox = pNewDesc->m->pConfig->hardwareMachine.ulMemorySizeMB;
297 else
298 ullMemSizeVBox = vsysThis.ullMemorySize / _1M;
299 /* Check for the constraints */
300 if ( ullMemSizeVBox != 0
301 && ( ullMemSizeVBox < MM_RAM_MIN_IN_MB
302 || ullMemSizeVBox > MM_RAM_MAX_IN_MB
303 )
304 )
305 {
306 addWarning(tr("The virtual system \"%s\" claims support for %llu MB RAM size, but VirtualBox has support for min %u & max %u MB RAM size only."),
307 vsysThis.strName.c_str(), ullMemSizeVBox, MM_RAM_MIN_IN_MB, MM_RAM_MAX_IN_MB);
308 ullMemSizeVBox = RT_MIN(RT_MAX(ullMemSizeVBox, MM_RAM_MIN_IN_MB), MM_RAM_MAX_IN_MB);
309 }
310 if (vsysThis.ullMemorySize == 0)
311 {
312 /* If the RAM of the OVF is zero, use our predefined values */
313 ULONG memSizeVBox2;
314 rc = pGuestOSType->COMGETTER(RecommendedRAM)(&memSizeVBox2);
315 if (FAILED(rc)) throw rc;
316 /* VBox stores that in MByte */
317 ullMemSizeVBox = (uint64_t)memSizeVBox2;
318 }
319 pNewDesc->addEntry(VirtualSystemDescriptionType_Memory,
320 "",
321 Utf8StrFmt("%RU64", (uint64_t)vsysThis.ullMemorySize),
322 Utf8StrFmt("%RU64", (uint64_t)ullMemSizeVBox));
323
324 /* Audio */
325 Utf8Str strSoundCard;
326 Utf8Str strSoundCardOrig;
327 /* If there is a <vbox:Machine>, we always prefer the setting from there. */
328 if ( vsysThis.pelmVboxMachine
329 && pNewDesc->m->pConfig->hardwareMachine.audioAdapter.fEnabled)
330 strSoundCard = Utf8StrFmt("%RU32", (uint32_t)pNewDesc->m->pConfig->hardwareMachine.audioAdapter.controllerType);
331 else if (vsysThis.strSoundCardType.isNotEmpty())
332 {
333 /* Set the AC97 always for the simple OVF case.
334 * @todo: figure out the hardware which could be possible */
335 strSoundCard = Utf8StrFmt("%RU32", (uint32_t)AudioControllerType_AC97);
336 strSoundCardOrig = vsysThis.strSoundCardType;
337 }
338 if (strSoundCard.isNotEmpty())
339 pNewDesc->addEntry(VirtualSystemDescriptionType_SoundCard,
340 "",
341 strSoundCardOrig,
342 strSoundCard);
343
344#ifdef VBOX_WITH_USB
345 /* USB Controller */
346 /* If there is a <vbox:Machine>, we always prefer the setting from there. */
347 if ( ( vsysThis.pelmVboxMachine
348 && pNewDesc->m->pConfig->hardwareMachine.usbController.fEnabled)
349 || vsysThis.fHasUsbController)
350 pNewDesc->addEntry(VirtualSystemDescriptionType_USBController, "", "", "");
351#endif /* VBOX_WITH_USB */
352
353 /* Network Controller */
354 /* If there is a <vbox:Machine>, we always prefer the setting from there. */
355 if (vsysThis.pelmVboxMachine)
356 {
357 uint32_t maxNetworkAdapters = Global::getMaxNetworkAdapters(pNewDesc->m->pConfig->hardwareMachine.chipsetType);
358
359 const settings::NetworkAdaptersList &llNetworkAdapters = pNewDesc->m->pConfig->hardwareMachine.llNetworkAdapters;
360 /* Check for the constrains */
361 if (llNetworkAdapters.size() > maxNetworkAdapters)
362 addWarning(tr("The virtual system \"%s\" claims support for %zu network adapters, but VirtualBox has support for max %u network adapter only."),
363 vsysThis.strName.c_str(), llNetworkAdapters.size(), maxNetworkAdapters);
364 /* Iterate through all network adapters. */
365 settings::NetworkAdaptersList::const_iterator it1;
366 size_t a = 0;
367 for (it1 = llNetworkAdapters.begin();
368 it1 != llNetworkAdapters.end() && a < maxNetworkAdapters;
369 ++it1, ++a)
370 {
371 if (it1->fEnabled)
372 {
373 Utf8Str strMode = convertNetworkAttachmentTypeToString(it1->mode);
374 pNewDesc->addEntry(VirtualSystemDescriptionType_NetworkAdapter,
375 "", // ref
376 strMode, // orig
377 Utf8StrFmt("%RU32", (uint32_t)it1->type), // conf
378 0,
379 Utf8StrFmt("slot=%RU32;type=%s", it1->ulSlot, strMode.c_str())); // extra conf
380 }
381 }
382 }
383 /* else we use the ovf configuration. */
384 else if (size_t cEthernetAdapters = vsysThis.llEthernetAdapters.size() > 0)
385 {
386 uint32_t maxNetworkAdapters = Global::getMaxNetworkAdapters(ChipsetType_PIIX3);
387
388 /* Check for the constrains */
389 if (cEthernetAdapters > maxNetworkAdapters)
390 addWarning(tr("The virtual system \"%s\" claims support for %zu network adapters, but VirtualBox has support for max %u network adapter only."),
391 vsysThis.strName.c_str(), cEthernetAdapters, maxNetworkAdapters);
392
393 /* Get the default network adapter type for the selected guest OS */
394 NetworkAdapterType_T defaultAdapterVBox = NetworkAdapterType_Am79C970A;
395 rc = pGuestOSType->COMGETTER(AdapterType)(&defaultAdapterVBox);
396 if (FAILED(rc)) throw rc;
397
398 ovf::EthernetAdaptersList::const_iterator itEA;
399 /* Iterate through all abstract networks. Ignore network cards
400 * which exceed the limit of VirtualBox. */
401 size_t a = 0;
402 for (itEA = vsysThis.llEthernetAdapters.begin();
403 itEA != vsysThis.llEthernetAdapters.end() && a < maxNetworkAdapters;
404 ++itEA, ++a)
405 {
406 const ovf::EthernetAdapter &ea = *itEA; // logical network to connect to
407 Utf8Str strNetwork = ea.strNetworkName;
408 // make sure it's one of these two
409 if ( (strNetwork.compare("Null", Utf8Str::CaseInsensitive))
410 && (strNetwork.compare("NAT", Utf8Str::CaseInsensitive))
411 && (strNetwork.compare("Bridged", Utf8Str::CaseInsensitive))
412 && (strNetwork.compare("Internal", Utf8Str::CaseInsensitive))
413 && (strNetwork.compare("HostOnly", Utf8Str::CaseInsensitive))
414 && (strNetwork.compare("Generic", Utf8Str::CaseInsensitive))
415 )
416 strNetwork = "Bridged"; // VMware assumes this is the default apparently
417
418 /* Figure out the hardware type */
419 NetworkAdapterType_T nwAdapterVBox = defaultAdapterVBox;
420 if (!ea.strAdapterType.compare("PCNet32", Utf8Str::CaseInsensitive))
421 {
422 /* If the default adapter is already one of the two
423 * PCNet adapters use the default one. If not use the
424 * Am79C970A as fallback. */
425 if (!(defaultAdapterVBox == NetworkAdapterType_Am79C970A ||
426 defaultAdapterVBox == NetworkAdapterType_Am79C973))
427 nwAdapterVBox = NetworkAdapterType_Am79C970A;
428 }
429#ifdef VBOX_WITH_E1000
430 /* VMWare accidentally write this with VirtualCenter 3.5,
431 so make sure in this case always to use the VMWare one */
432 else if (!ea.strAdapterType.compare("E10000", Utf8Str::CaseInsensitive))
433 nwAdapterVBox = NetworkAdapterType_I82545EM;
434 else if (!ea.strAdapterType.compare("E1000", Utf8Str::CaseInsensitive))
435 {
436 /* Check if this OVF was written by VirtualBox */
437 if (Utf8Str(vsysThis.strVirtualSystemType).contains("virtualbox", Utf8Str::CaseInsensitive))
438 {
439 /* If the default adapter is already one of the three
440 * E1000 adapters use the default one. If not use the
441 * I82545EM as fallback. */
442 if (!(defaultAdapterVBox == NetworkAdapterType_I82540EM ||
443 defaultAdapterVBox == NetworkAdapterType_I82543GC ||
444 defaultAdapterVBox == NetworkAdapterType_I82545EM))
445 nwAdapterVBox = NetworkAdapterType_I82540EM;
446 }
447 else
448 /* Always use this one since it's what VMware uses */
449 nwAdapterVBox = NetworkAdapterType_I82545EM;
450 }
451#endif /* VBOX_WITH_E1000 */
452
453 pNewDesc->addEntry(VirtualSystemDescriptionType_NetworkAdapter,
454 "", // ref
455 ea.strNetworkName, // orig
456 Utf8StrFmt("%RU32", (uint32_t)nwAdapterVBox), // conf
457 0,
458 Utf8StrFmt("type=%s", strNetwork.c_str())); // extra conf
459 }
460 }
461
462 /* If there is a <vbox:Machine>, we always prefer the setting from there. */
463 bool fFloppy = false;
464 bool fDVD = false;
465 if (vsysThis.pelmVboxMachine)
466 {
467 settings::StorageControllersList &llControllers = pNewDesc->m->pConfig->storageMachine.llStorageControllers;
468 settings::StorageControllersList::iterator it3;
469 for (it3 = llControllers.begin();
470 it3 != llControllers.end();
471 ++it3)
472 {
473 settings::AttachedDevicesList &llAttachments = it3->llAttachedDevices;
474 settings::AttachedDevicesList::iterator it4;
475 for (it4 = llAttachments.begin();
476 it4 != llAttachments.end();
477 ++it4)
478 {
479 fDVD |= it4->deviceType == DeviceType_DVD;
480 fFloppy |= it4->deviceType == DeviceType_Floppy;
481 if (fFloppy && fDVD)
482 break;
483 }
484 if (fFloppy && fDVD)
485 break;
486 }
487 }
488 else
489 {
490 fFloppy = vsysThis.fHasFloppyDrive;
491 fDVD = vsysThis.fHasCdromDrive;
492 }
493 /* Floppy Drive */
494 if (fFloppy)
495 pNewDesc->addEntry(VirtualSystemDescriptionType_Floppy, "", "", "");
496 /* CD Drive */
497 if (fDVD)
498 pNewDesc->addEntry(VirtualSystemDescriptionType_CDROM, "", "", "");
499
500 /* Hard disk Controller */
501 uint16_t cIDEused = 0;
502 uint16_t cSATAused = 0; NOREF(cSATAused);
503 uint16_t cSCSIused = 0; NOREF(cSCSIused);
504 ovf::ControllersMap::const_iterator hdcIt;
505 /* Iterate through all hard disk controllers */
506 for (hdcIt = vsysThis.mapControllers.begin();
507 hdcIt != vsysThis.mapControllers.end();
508 ++hdcIt)
509 {
510 const ovf::HardDiskController &hdc = hdcIt->second;
511 Utf8Str strControllerID = Utf8StrFmt("%RI32", (uint32_t)hdc.idController);
512
513 switch (hdc.system)
514 {
515 case ovf::HardDiskController::IDE:
516 /* Check for the constrains */
517 if (cIDEused < 4)
518 {
519 // @todo: figure out the IDE types
520 /* Use PIIX4 as default */
521 Utf8Str strType = "PIIX4";
522 if (!hdc.strControllerType.compare("PIIX3", Utf8Str::CaseInsensitive))
523 strType = "PIIX3";
524 else if (!hdc.strControllerType.compare("ICH6", Utf8Str::CaseInsensitive))
525 strType = "ICH6";
526 pNewDesc->addEntry(VirtualSystemDescriptionType_HardDiskControllerIDE,
527 strControllerID, // strRef
528 hdc.strControllerType, // aOvfValue
529 strType); // aVboxValue
530 }
531 else
532 /* Warn only once */
533 if (cIDEused == 2)
534 addWarning(tr("The virtual \"%s\" system requests support for more than two IDE controller channels, but VirtualBox supports only two."),
535 vsysThis.strName.c_str());
536
537 ++cIDEused;
538 break;
539
540 case ovf::HardDiskController::SATA:
541 /* Check for the constrains */
542 if (cSATAused < 1)
543 {
544 // @todo: figure out the SATA types
545 /* We only support a plain AHCI controller, so use them always */
546 pNewDesc->addEntry(VirtualSystemDescriptionType_HardDiskControllerSATA,
547 strControllerID,
548 hdc.strControllerType,
549 "AHCI");
550 }
551 else
552 {
553 /* Warn only once */
554 if (cSATAused == 1)
555 addWarning(tr("The virtual system \"%s\" requests support for more than one SATA controller, but VirtualBox has support for only one"),
556 vsysThis.strName.c_str());
557
558 }
559 ++cSATAused;
560 break;
561
562 case ovf::HardDiskController::SCSI:
563 /* Check for the constrains */
564 if (cSCSIused < 1)
565 {
566 VirtualSystemDescriptionType_T vsdet = VirtualSystemDescriptionType_HardDiskControllerSCSI;
567 Utf8Str hdcController = "LsiLogic";
568 if (!hdc.strControllerType.compare("lsilogicsas", Utf8Str::CaseInsensitive))
569 {
570 // OVF considers SAS a variant of SCSI but VirtualBox considers it a class of its own
571 vsdet = VirtualSystemDescriptionType_HardDiskControllerSAS;
572 hdcController = "LsiLogicSas";
573 }
574 else if (!hdc.strControllerType.compare("BusLogic", Utf8Str::CaseInsensitive))
575 hdcController = "BusLogic";
576 pNewDesc->addEntry(vsdet,
577 strControllerID,
578 hdc.strControllerType,
579 hdcController);
580 }
581 else
582 addWarning(tr("The virtual system \"%s\" requests support for an additional SCSI controller of type \"%s\" with ID %s, but VirtualBox presently supports only one SCSI controller."),
583 vsysThis.strName.c_str(),
584 hdc.strControllerType.c_str(),
585 strControllerID.c_str());
586 ++cSCSIused;
587 break;
588 }
589 }
590
591 /* Hard disks */
592 if (vsysThis.mapVirtualDisks.size() > 0)
593 {
594 ovf::VirtualDisksMap::const_iterator itVD;
595 /* Iterate through all hard disks ()*/
596 for (itVD = vsysThis.mapVirtualDisks.begin();
597 itVD != vsysThis.mapVirtualDisks.end();
598 ++itVD)
599 {
600 const ovf::VirtualDisk &hd = itVD->second;
601 /* Get the associated disk image */
602 const ovf::DiskImage &di = m->pReader->m_mapDisks[hd.strDiskId];
603
604 // @todo:
605 // - figure out all possible vmdk formats we also support
606 // - figure out if there is a url specifier for vhd already
607 // - we need a url specifier for the vdi format
608 if ( di.strFormat.compare("http://www.vmware.com/specifications/vmdk.html#sparse", Utf8Str::CaseInsensitive)
609 || di.strFormat.compare("http://www.vmware.com/interfaces/specifications/vmdk.html#streamOptimized", Utf8Str::CaseInsensitive)
610 || di.strFormat.compare("http://www.vmware.com/specifications/vmdk.html#compressed", Utf8Str::CaseInsensitive)
611 || di.strFormat.compare("http://www.vmware.com/interfaces/specifications/vmdk.html#compressed", Utf8Str::CaseInsensitive)
612 )
613 {
614 /* If the href is empty use the VM name as filename */
615 Utf8Str strFilename = di.strHref;
616 if (!strFilename.length())
617 strFilename = Utf8StrFmt("%s.vmdk", nameVBox.c_str());
618
619 Utf8Str strTargetPath = Utf8Str(strMachineFolder)
620 .append(RTPATH_DELIMITER)
621 .append(di.strHref);
622 searchUniqueDiskImageFilePath(strTargetPath);
623
624 /* find the description for the hard disk controller
625 * that has the same ID as hd.idController */
626 const VirtualSystemDescriptionEntry *pController;
627 if (!(pController = pNewDesc->findControllerFromID(hd.idController)))
628 throw setError(E_FAIL,
629 tr("Cannot find hard disk controller with OVF instance ID %RI32 to which disk \"%s\" should be attached"),
630 hd.idController,
631 di.strHref.c_str());
632
633 /* controller to attach to, and the bus within that controller */
634 Utf8StrFmt strExtraConfig("controller=%RI16;channel=%RI16",
635 pController->ulIndex,
636 hd.ulAddressOnParent);
637 pNewDesc->addEntry(VirtualSystemDescriptionType_HardDiskImage,
638 hd.strDiskId,
639 di.strHref,
640 strTargetPath,
641 di.ulSuggestedSizeMB,
642 strExtraConfig);
643 }
644 else
645 throw setError(VBOX_E_FILE_ERROR,
646 tr("Unsupported format for virtual disk image in OVF: \"%s\"", di.strFormat.c_str()));
647 }
648 }
649
650 m->virtualSystemDescriptions.push_back(pNewDesc);
651 }
652 }
653 catch (HRESULT aRC)
654 {
655 /* On error we clear the list & return */
656 m->virtualSystemDescriptions.clear();
657 rc = aRC;
658 }
659
660 // reset the appliance state
661 alock.acquire();
662 m->state = Data::ApplianceIdle;
663
664 return rc;
665}
666
667/**
668 * Public method implementation. This creates one or more new machines according to the
669 * VirtualSystemScription instances created by Appliance::Interpret().
670 * Thread implementation is in Appliance::importImpl().
671 * @param aProgress
672 * @return
673 */
674STDMETHODIMP Appliance::ImportMachines(ComSafeArrayIn(ImportOptions_T, options), IProgress **aProgress)
675{
676 CheckComArgOutPointerValid(aProgress);
677
678 AutoCaller autoCaller(this);
679 if (FAILED(autoCaller.rc())) return autoCaller.rc();
680
681 if (options != NULL)
682 m->optList = com::SafeArray<ImportOptions_T>(ComSafeArrayInArg(options)).toList();
683
684 AssertReturn(!(m->optList.contains(ImportOptions_KeepAllMACs) && m->optList.contains(ImportOptions_KeepNATMACs)), E_INVALIDARG);
685
686 AutoReadLock alock(this COMMA_LOCKVAL_SRC_POS);
687
688 // do not allow entering this method if the appliance is busy reading or writing
689 if (!isApplianceIdle())
690 return E_ACCESSDENIED;
691
692 if (!m->pReader)
693 return setError(E_FAIL,
694 tr("Cannot import machines without reading it first (call read() before importMachines())"));
695
696 ComObjPtr<Progress> progress;
697 HRESULT rc = S_OK;
698 try
699 {
700 rc = importImpl(m->locInfo, progress);
701 }
702 catch (HRESULT aRC)
703 {
704 rc = aRC;
705 }
706
707 if (SUCCEEDED(rc))
708 /* Return progress to the caller */
709 progress.queryInterfaceTo(aProgress);
710
711 return rc;
712}
713
714////////////////////////////////////////////////////////////////////////////////
715//
716// Appliance private methods
717//
718////////////////////////////////////////////////////////////////////////////////
719
720
721/*******************************************************************************
722 * Read stuff
723 ******************************************************************************/
724
725/**
726 * Implementation for reading an OVF. This starts a new thread which will call
727 * Appliance::taskThreadImportOrExport() which will then call readFS() or readS3().
728 * This will then open the OVF with ovfreader.cpp.
729 *
730 * This is in a separate private method because it is used from three locations:
731 *
732 * 1) from the public Appliance::Read().
733 *
734 * 2) in a second worker thread; in that case, Appliance::ImportMachines() called Appliance::importImpl(), which
735 * called Appliance::readFSOVA(), which called Appliance::importImpl(), which then called this again.
736 *
737 * 3) from Appliance::readS3(), which got called from a previous instance of Appliance::taskThreadImportOrExport().
738 *
739 * @param aLocInfo
740 * @param aProgress
741 * @return
742 */
743HRESULT Appliance::readImpl(const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress)
744{
745 BstrFmt bstrDesc = BstrFmt(tr("Reading appliance '%s'"),
746 aLocInfo.strPath.c_str());
747 HRESULT rc;
748 /* Create the progress object */
749 aProgress.createObject();
750 if (aLocInfo.storageType == VFSType_File)
751 /* 1 operation only */
752 rc = aProgress->init(mVirtualBox, static_cast<IAppliance*>(this),
753 bstrDesc.raw(),
754 TRUE /* aCancelable */);
755 else
756 /* 4/5 is downloading, 1/5 is reading */
757 rc = aProgress->init(mVirtualBox, static_cast<IAppliance*>(this),
758 bstrDesc.raw(),
759 TRUE /* aCancelable */,
760 2, // ULONG cOperations,
761 5, // ULONG ulTotalOperationsWeight,
762 BstrFmt(tr("Download appliance '%s'"),
763 aLocInfo.strPath.c_str()).raw(), // CBSTR bstrFirstOperationDescription,
764 4); // ULONG ulFirstOperationWeight,
765 if (FAILED(rc)) throw rc;
766
767 /* Initialize our worker task */
768 std::auto_ptr<TaskOVF> task(new TaskOVF(this, TaskOVF::Read, aLocInfo, aProgress));
769
770 rc = task->startThread();
771 if (FAILED(rc)) throw rc;
772
773 /* Don't destruct on success */
774 task.release();
775
776 return rc;
777}
778
779/**
780 * Actual worker code for reading an OVF from disk. This is called from Appliance::taskThreadImportOrExport()
781 * and therefore runs on the OVF read worker thread. This opens the OVF with ovfreader.cpp.
782 *
783 * This runs in two contexts:
784 *
785 * 1) in a first worker thread; in that case, Appliance::Read() called Appliance::readImpl();
786 *
787 * 2) in a second worker thread; in that case, Appliance::Read() called Appliance::readImpl(), which
788 * called Appliance::readS3(), which called Appliance::readImpl(), which then called this.
789 *
790 * @param pTask
791 * @return
792 */
793HRESULT Appliance::readFS(TaskOVF *pTask)
794{
795 LogFlowFuncEnter();
796 LogFlowFunc(("Appliance %p\n", this));
797
798 AutoCaller autoCaller(this);
799 if (FAILED(autoCaller.rc())) return autoCaller.rc();
800
801 AutoWriteLock appLock(this COMMA_LOCKVAL_SRC_POS);
802
803 HRESULT rc = S_OK;
804
805 if (pTask->locInfo.strPath.endsWith(".ovf", Utf8Str::CaseInsensitive))
806 rc = readFSOVF(pTask);
807 else
808 rc = readFSOVA(pTask);
809
810 LogFlowFunc(("rc=%Rhrc\n", rc));
811 LogFlowFuncLeave();
812
813 return rc;
814}
815
816HRESULT Appliance::readFSOVF(TaskOVF *pTask)
817{
818 LogFlowFuncEnter();
819
820 HRESULT rc = S_OK;
821
822 PVDINTERFACEIO pShaIo = 0;
823 PVDINTERFACEIO pFileIo = 0;
824 do
825 {
826 pShaIo = ShaCreateInterface();
827 if (!pShaIo)
828 {
829 rc = E_OUTOFMEMORY;
830 break;
831 }
832 pFileIo = FileCreateInterface();
833 if (!pFileIo)
834 {
835 rc = E_OUTOFMEMORY;
836 break;
837 }
838 SHASTORAGE storage;
839 RT_ZERO(storage);
840 int vrc = VDInterfaceAdd(&pFileIo->Core, "Appliance::IOFile",
841 VDINTERFACETYPE_IO, 0, sizeof(VDINTERFACEIO),
842 &storage.pVDImageIfaces);
843 if (RT_FAILURE(vrc))
844 {
845 rc = setError(VBOX_E_IPRT_ERROR, "Creation of the VD interface failed (%Rrc)", vrc);
846 break;
847 }
848
849 rc = readFSImpl(pTask, pTask->locInfo.strPath, pShaIo, &storage);
850 }while(0);
851
852 /* Cleanup */
853 if (pShaIo)
854 RTMemFree(pShaIo);
855 if (pFileIo)
856 RTMemFree(pFileIo);
857
858 LogFlowFunc(("rc=%Rhrc\n", rc));
859 LogFlowFuncLeave();
860
861 return rc;
862}
863
864HRESULT Appliance::readFSOVA(TaskOVF *pTask)
865{
866 LogFlowFuncEnter();
867
868 RTTAR tar;
869 int vrc = RTTarOpen(&tar, pTask->locInfo.strPath.c_str(), RTFILE_O_OPEN | RTFILE_O_READ | RTFILE_O_DENY_NONE, true);
870 if (RT_FAILURE(vrc))
871 return setError(VBOX_E_FILE_ERROR,
872 tr("Could not open OVA file '%s' (%Rrc)"),
873 pTask->locInfo.strPath.c_str(), vrc);
874
875 HRESULT rc = S_OK;
876
877 PVDINTERFACEIO pShaIo = 0;
878 PVDINTERFACEIO pTarIo = 0;
879 char *pszFilename = 0;
880 do
881 {
882 vrc = RTTarCurrentFile(tar, &pszFilename);
883 if (RT_FAILURE(vrc))
884 {
885 rc = VBOX_E_FILE_ERROR;
886 break;
887 }
888 pShaIo = ShaCreateInterface();
889 if (!pShaIo)
890 {
891 rc = E_OUTOFMEMORY;
892 break;
893 }
894 pTarIo = TarCreateInterface();
895 if (!pTarIo)
896 {
897 rc = E_OUTOFMEMORY;
898 break;
899 }
900 SHASTORAGE storage;
901 RT_ZERO(storage);
902 vrc = VDInterfaceAdd(&pTarIo->Core, "Appliance::IOTar",
903 VDINTERFACETYPE_IO, tar, sizeof(VDINTERFACEIO),
904 &storage.pVDImageIfaces);
905 if (RT_FAILURE(vrc))
906 {
907 rc = setError(VBOX_E_IPRT_ERROR, "Creation of the VD interface failed (%Rrc)", vrc);
908 break;
909 }
910 rc = readFSImpl(pTask, pszFilename, pShaIo, &storage);
911 }while(0);
912
913 RTTarClose(tar);
914
915 /* Cleanup */
916 if (pszFilename)
917 RTMemFree(pszFilename);
918 if (pShaIo)
919 RTMemFree(pShaIo);
920 if (pTarIo)
921 RTMemFree(pTarIo);
922
923 LogFlowFunc(("rc=%Rhrc\n", rc));
924 LogFlowFuncLeave();
925
926 return rc;
927}
928
929HRESULT Appliance::readFSImpl(TaskOVF *pTask, const RTCString &strFilename, PVDINTERFACEIO pIfIo, PSHASTORAGE pStorage)
930{
931 LogFlowFuncEnter();
932
933 HRESULT rc = S_OK;
934
935 pStorage->fCreateDigest = true;
936
937 void *pvTmpBuf = 0;
938 try
939 {
940 /* Read the OVF into a memory buffer */
941 size_t cbSize = 0;
942 int vrc = ShaReadBuf(strFilename.c_str(), &pvTmpBuf, &cbSize, pIfIo, pStorage);
943 if ( RT_FAILURE(vrc)
944 || !pvTmpBuf)
945 throw setError(VBOX_E_FILE_ERROR,
946 tr("Could not read OVF file '%s' (%Rrc)"),
947 RTPathFilename(strFilename.c_str()), vrc);
948 /* Copy the SHA1/SHA256 sum of the OVF file for later validation */
949 m->strOVFSHADigest = pStorage->strDigest;
950 /* Read & parse the XML structure of the OVF file */
951 m->pReader = new ovf::OVFReader(pvTmpBuf, cbSize, pTask->locInfo.strPath);
952 }
953 catch (RTCError &x) // includes all XML exceptions
954 {
955 rc = setError(VBOX_E_FILE_ERROR,
956 x.what());
957 }
958 catch (HRESULT aRC)
959 {
960 rc = aRC;
961 }
962
963 /* Cleanup */
964 if (pvTmpBuf)
965 RTMemFree(pvTmpBuf);
966
967 LogFlowFunc(("rc=%Rhrc\n", rc));
968 LogFlowFuncLeave();
969
970 return rc;
971}
972
973#ifdef VBOX_WITH_S3
974/**
975 * Worker code for reading OVF from the cloud. This is called from Appliance::taskThreadImportOrExport()
976 * in S3 mode and therefore runs on the OVF read worker thread. This then starts a second worker
977 * thread to create temporary files (see Appliance::readFS()).
978 *
979 * @param pTask
980 * @return
981 */
982HRESULT Appliance::readS3(TaskOVF *pTask)
983{
984 LogFlowFuncEnter();
985 LogFlowFunc(("Appliance %p\n", this));
986
987 AutoCaller autoCaller(this);
988 if (FAILED(autoCaller.rc())) return autoCaller.rc();
989
990 AutoWriteLock appLock(this COMMA_LOCKVAL_SRC_POS);
991
992 HRESULT rc = S_OK;
993 int vrc = VINF_SUCCESS;
994 RTS3 hS3 = NIL_RTS3;
995 char szOSTmpDir[RTPATH_MAX];
996 RTPathTemp(szOSTmpDir, sizeof(szOSTmpDir));
997 /* The template for the temporary directory created below */
998 char *pszTmpDir = RTPathJoinA(szOSTmpDir, "vbox-ovf-XXXXXX");
999 list< pair<Utf8Str, ULONG> > filesList;
1000 Utf8Str strTmpOvf;
1001
1002 try
1003 {
1004 /* Extract the bucket */
1005 Utf8Str tmpPath = pTask->locInfo.strPath;
1006 Utf8Str bucket;
1007 parseBucket(tmpPath, bucket);
1008
1009 /* We need a temporary directory which we can put the OVF file & all
1010 * disk images in */
1011 vrc = RTDirCreateTemp(pszTmpDir, 0700);
1012 if (RT_FAILURE(vrc))
1013 throw setError(VBOX_E_FILE_ERROR,
1014 tr("Cannot create temporary directory '%s'"), pszTmpDir);
1015
1016 /* The temporary name of the target OVF file */
1017 strTmpOvf = Utf8StrFmt("%s/%s", pszTmpDir, RTPathFilename(tmpPath.c_str()));
1018
1019 /* Next we have to download the OVF */
1020 vrc = RTS3Create(&hS3, pTask->locInfo.strUsername.c_str(), pTask->locInfo.strPassword.c_str(), pTask->locInfo.strHostname.c_str(), "virtualbox-agent/"VBOX_VERSION_STRING);
1021 if (RT_FAILURE(vrc))
1022 throw setError(VBOX_E_IPRT_ERROR,
1023 tr("Cannot create S3 service handler"));
1024 RTS3SetProgressCallback(hS3, pTask->updateProgress, &pTask);
1025
1026 /* Get it */
1027 char *pszFilename = RTPathFilename(strTmpOvf.c_str());
1028 vrc = RTS3GetKey(hS3, bucket.c_str(), pszFilename, strTmpOvf.c_str());
1029 if (RT_FAILURE(vrc))
1030 {
1031 if (vrc == VERR_S3_CANCELED)
1032 throw S_OK; /* todo: !!!!!!!!!!!!! */
1033 else if (vrc == VERR_S3_ACCESS_DENIED)
1034 throw setError(E_ACCESSDENIED,
1035 tr("Cannot download file '%s' from S3 storage server (Access denied). Make sure that your credentials are right."
1036 "Also check that your host clock is properly synced"),
1037 pszFilename);
1038 else if (vrc == VERR_S3_NOT_FOUND)
1039 throw setError(VBOX_E_FILE_ERROR,
1040 tr("Cannot download file '%s' from S3 storage server (File not found)"), pszFilename);
1041 else
1042 throw setError(VBOX_E_IPRT_ERROR,
1043 tr("Cannot download file '%s' from S3 storage server (%Rrc)"), pszFilename, vrc);
1044 }
1045
1046 /* Close the connection early */
1047 RTS3Destroy(hS3);
1048 hS3 = NIL_RTS3;
1049
1050 pTask->pProgress->SetNextOperation(Bstr(tr("Reading")).raw(), 1);
1051
1052 /* Prepare the temporary reading of the OVF */
1053 ComObjPtr<Progress> progress;
1054 LocationInfo li;
1055 li.strPath = strTmpOvf;
1056 /* Start the reading from the fs */
1057 rc = readImpl(li, progress);
1058 if (FAILED(rc)) throw rc;
1059
1060 /* Unlock the appliance for the reading thread */
1061 appLock.release();
1062 /* Wait until the reading is done, but report the progress back to the
1063 caller */
1064 ComPtr<IProgress> progressInt(progress);
1065 waitForAsyncProgress(pTask->pProgress, progressInt); /* Any errors will be thrown */
1066
1067 /* Again lock the appliance for the next steps */
1068 appLock.acquire();
1069 }
1070 catch(HRESULT aRC)
1071 {
1072 rc = aRC;
1073 }
1074 /* Cleanup */
1075 RTS3Destroy(hS3);
1076 /* Delete all files which where temporary created */
1077 if (RTPathExists(strTmpOvf.c_str()))
1078 {
1079 vrc = RTFileDelete(strTmpOvf.c_str());
1080 if (RT_FAILURE(vrc))
1081 rc = setError(VBOX_E_FILE_ERROR,
1082 tr("Cannot delete file '%s' (%Rrc)"), strTmpOvf.c_str(), vrc);
1083 }
1084 /* Delete the temporary directory */
1085 if (RTPathExists(pszTmpDir))
1086 {
1087 vrc = RTDirRemove(pszTmpDir);
1088 if (RT_FAILURE(vrc))
1089 rc = setError(VBOX_E_FILE_ERROR,
1090 tr("Cannot delete temporary directory '%s' (%Rrc)"), pszTmpDir, vrc);
1091 }
1092 if (pszTmpDir)
1093 RTStrFree(pszTmpDir);
1094
1095 LogFlowFunc(("rc=%Rhrc\n", rc));
1096 LogFlowFuncLeave();
1097
1098 return rc;
1099}
1100#endif /* VBOX_WITH_S3 */
1101
1102/*******************************************************************************
1103 * Import stuff
1104 ******************************************************************************/
1105
1106/**
1107 * Implementation for importing OVF data into VirtualBox. This starts a new thread which will call
1108 * Appliance::taskThreadImportOrExport().
1109 *
1110 * This creates one or more new machines according to the VirtualSystemScription instances created by
1111 * Appliance::Interpret().
1112 *
1113 * This is in a separate private method because it is used from two locations:
1114 *
1115 * 1) from the public Appliance::ImportMachines().
1116 * 2) from Appliance::importS3(), which got called from a previous instance of Appliance::taskThreadImportOrExport().
1117 *
1118 * @param aLocInfo
1119 * @param aProgress
1120 * @return
1121 */
1122HRESULT Appliance::importImpl(const LocationInfo &locInfo,
1123 ComObjPtr<Progress> &progress)
1124{
1125 HRESULT rc = S_OK;
1126
1127 SetUpProgressMode mode;
1128 if (locInfo.storageType == VFSType_File)
1129 mode = ImportFile;
1130 else
1131 mode = ImportS3;
1132
1133 rc = setUpProgress(progress,
1134 BstrFmt(tr("Importing appliance '%s'"), locInfo.strPath.c_str()),
1135 mode);
1136 if (FAILED(rc)) throw rc;
1137
1138 /* Initialize our worker task */
1139 std::auto_ptr<TaskOVF> task(new TaskOVF(this, TaskOVF::Import, locInfo, progress));
1140
1141 rc = task->startThread();
1142 if (FAILED(rc)) throw rc;
1143
1144 /* Don't destruct on success */
1145 task.release();
1146
1147 return rc;
1148}
1149
1150/**
1151 * Actual worker code for importing OVF data into VirtualBox. This is called from Appliance::taskThreadImportOrExport()
1152 * and therefore runs on the OVF import worker thread. This creates one or more new machines according to the
1153 * VirtualSystemScription instances created by Appliance::Interpret().
1154 *
1155 * This runs in three contexts:
1156 *
1157 * 1) in a first worker thread; in that case, Appliance::ImportMachines() called Appliance::importImpl();
1158 *
1159 * 2) in a second worker thread; in that case, Appliance::ImportMachines() called Appliance::importImpl(), which
1160 * called Appliance::importFSOVA(), which called Appliance::importImpl(), which then called this again.
1161 *
1162 * 3) in a second worker thread; in that case, Appliance::ImportMachines() called Appliance::importImpl(), which
1163 * called Appliance::importS3(), which called Appliance::importImpl(), which then called this again.
1164 *
1165 * @param pTask
1166 * @return
1167 */
1168HRESULT Appliance::importFS(TaskOVF *pTask)
1169{
1170
1171 LogFlowFuncEnter();
1172 LogFlowFunc(("Appliance %p\n", this));
1173
1174 AutoCaller autoCaller(this);
1175 if (FAILED(autoCaller.rc())) return autoCaller.rc();
1176
1177 /* Change the appliance state so we can safely leave the lock while doing
1178 * time-consuming disk imports; also the below method calls do all kinds of
1179 * locking which conflicts with the appliance object lock. */
1180 AutoWriteLock writeLock(this COMMA_LOCKVAL_SRC_POS);
1181 /* Check if the appliance is currently busy. */
1182 if (!isApplianceIdle())
1183 return E_ACCESSDENIED;
1184 /* Set the internal state to importing. */
1185 m->state = Data::ApplianceImporting;
1186
1187 HRESULT rc = S_OK;
1188
1189 /* Clear the list of imported machines, if any */
1190 m->llGuidsMachinesCreated.clear();
1191
1192 if (pTask->locInfo.strPath.endsWith(".ovf", Utf8Str::CaseInsensitive))
1193 rc = importFSOVF(pTask, writeLock);
1194 else
1195 rc = importFSOVA(pTask, writeLock);
1196
1197 if (FAILED(rc))
1198 {
1199 /* With _whatever_ error we've had, do a complete roll-back of
1200 * machines and disks we've created */
1201 writeLock.release();
1202 for (list<Guid>::iterator itID = m->llGuidsMachinesCreated.begin();
1203 itID != m->llGuidsMachinesCreated.end();
1204 ++itID)
1205 {
1206 Guid guid = *itID;
1207 Bstr bstrGuid = guid.toUtf16();
1208 ComPtr<IMachine> failedMachine;
1209 HRESULT rc2 = mVirtualBox->FindMachine(bstrGuid.raw(), failedMachine.asOutParam());
1210 if (SUCCEEDED(rc2))
1211 {
1212 SafeIfaceArray<IMedium> aMedia;
1213 rc2 = failedMachine->Unregister(CleanupMode_DetachAllReturnHardDisksOnly, ComSafeArrayAsOutParam(aMedia));
1214 ComPtr<IProgress> pProgress2;
1215 rc2 = failedMachine->Delete(ComSafeArrayAsInParam(aMedia), pProgress2.asOutParam());
1216 pProgress2->WaitForCompletion(-1);
1217 }
1218 }
1219 writeLock.acquire();
1220 }
1221
1222 /* Reset the state so others can call methods again */
1223 m->state = Data::ApplianceIdle;
1224
1225 LogFlowFunc(("rc=%Rhrc\n", rc));
1226 LogFlowFuncLeave();
1227
1228 return rc;
1229}
1230
1231HRESULT Appliance::importFSOVF(TaskOVF *pTask, AutoWriteLockBase& writeLock)
1232{
1233 LogFlowFuncEnter();
1234
1235 HRESULT rc = S_OK;
1236
1237 PVDINTERFACEIO pShaIo = NULL;
1238 PVDINTERFACEIO pFileIo = NULL;
1239 void *pvMfBuf = NULL;
1240 writeLock.release();
1241 try
1242 {
1243 /* Create the necessary file access interfaces. */
1244 pFileIo = FileCreateInterface();
1245 if (!pFileIo)
1246 throw setError(E_OUTOFMEMORY);
1247
1248 Utf8Str strMfFile = Utf8Str(pTask->locInfo.strPath).stripExt().append(".mf");
1249 /* Create the import stack for the rollback on errors. */
1250 ImportStack stack(pTask->locInfo, m->pReader->m_mapDisks, pTask->pProgress);
1251
1252 if (RTFileExists(strMfFile.c_str()))
1253 {
1254 SHASTORAGE storage;
1255 RT_ZERO(storage);
1256
1257 pShaIo = ShaCreateInterface();
1258 if (!pShaIo)
1259 throw setError(E_OUTOFMEMORY);
1260
1261 storage.fCreateDigest = true;
1262 int vrc = VDInterfaceAdd(&pFileIo->Core, "Appliance::IOFile",
1263 VDINTERFACETYPE_IO, 0, sizeof(VDINTERFACEIO),
1264 &storage.pVDImageIfaces);
1265 if (RT_FAILURE(vrc))
1266 throw setError(VBOX_E_IPRT_ERROR, "Creation of the VD interface failed (%Rrc)", vrc);
1267
1268 size_t cbMfSize = 0;
1269 storage.fCreateDigest = true;
1270 /* Now import the appliance. */
1271 importMachines(stack, pShaIo, &storage);
1272 /* Read & verify the manifest file. */
1273 /* Add the ovf file to the digest list. */
1274 stack.llSrcDisksDigest.push_front(STRPAIR(pTask->locInfo.strPath, m->strOVFSHADigest));
1275 rc = readManifestFile(strMfFile, &pvMfBuf, &cbMfSize, pShaIo, &storage);
1276 if (FAILED(rc)) throw rc;
1277 rc = verifyManifestFile(strMfFile, stack, pvMfBuf, cbMfSize);
1278 if (FAILED(rc)) throw rc;
1279 }
1280 else
1281 importMachines(stack, pFileIo, NULL);
1282 }
1283 catch (HRESULT rc2)
1284 {
1285 rc = rc2;
1286 }
1287 writeLock.acquire();
1288
1289 /* Cleanup */
1290 if (pvMfBuf)
1291 RTMemFree(pvMfBuf);
1292 if (pShaIo)
1293 RTMemFree(pShaIo);
1294 if (pFileIo)
1295 RTMemFree(pFileIo);
1296
1297 LogFlowFunc(("rc=%Rhrc\n", rc));
1298 LogFlowFuncLeave();
1299
1300 return rc;
1301}
1302
1303HRESULT Appliance::importFSOVA(TaskOVF *pTask, AutoWriteLockBase& writeLock)
1304{
1305 LogFlowFuncEnter();
1306
1307 RTTAR tar;
1308 int vrc = RTTarOpen(&tar, pTask->locInfo.strPath.c_str(), RTFILE_O_OPEN | RTFILE_O_READ | RTFILE_O_DENY_NONE, true);
1309 if (RT_FAILURE(vrc))
1310 return setError(VBOX_E_FILE_ERROR,
1311 tr("Could not open OVA file '%s' (%Rrc)"),
1312 pTask->locInfo.strPath.c_str(), vrc);
1313
1314 HRESULT rc = S_OK;
1315
1316 PVDINTERFACEIO pShaIo = 0;
1317 PVDINTERFACEIO pTarIo = 0;
1318 char *pszFilename = 0;
1319 void *pvMfBuf = 0;
1320 writeLock.release();
1321 try
1322 {
1323 /* Create the necessary file access interfaces. */
1324 pShaIo = ShaCreateInterface();
1325 if (!pShaIo)
1326 throw setError(E_OUTOFMEMORY);
1327 pTarIo = TarCreateInterface();
1328 if (!pTarIo)
1329 throw setError(E_OUTOFMEMORY);
1330
1331 SHASTORAGE storage;
1332 RT_ZERO(storage);
1333 vrc = VDInterfaceAdd(&pTarIo->Core, "Appliance::IOTar",
1334 VDINTERFACETYPE_IO, tar, sizeof(VDINTERFACEIO),
1335 &storage.pVDImageIfaces);
1336 if (RT_FAILURE(vrc))
1337 throw setError(VBOX_E_IPRT_ERROR,
1338 tr("Creation of the VD interface failed (%Rrc)"), vrc);
1339
1340 /* Read the file name of the first file (need to be the ovf file). This
1341 * is how all internal files are named. */
1342 vrc = RTTarCurrentFile(tar, &pszFilename);
1343 if (RT_FAILURE(vrc))
1344 throw setError(VBOX_E_IPRT_ERROR,
1345 tr("Getting the current file within the archive failed (%Rrc)"), vrc);
1346 /* Skip the OVF file, cause this was read in IAppliance::Read already. */
1347 vrc = RTTarSeekNextFile(tar);
1348 if ( RT_FAILURE(vrc)
1349 && vrc != VERR_TAR_END_OF_FILE)
1350 throw setError(VBOX_E_IPRT_ERROR,
1351 tr("Seeking within the archive failed (%Rrc)"), vrc);
1352
1353 PVDINTERFACEIO pCallbacks = pShaIo;
1354 PSHASTORAGE pStorage = &storage;
1355
1356 /* We always need to create the digest, cause we didn't know if there
1357 * is a manifest file in the stream. */
1358 pStorage->fCreateDigest = true;
1359
1360 size_t cbMfSize = 0;
1361 Utf8Str strMfFile = Utf8Str(pszFilename).stripExt().append(".mf");
1362 /* Create the import stack for the rollback on errors. */
1363 ImportStack stack(pTask->locInfo, m->pReader->m_mapDisks, pTask->pProgress);
1364 /*
1365 * Try to read the manifest file. First try.
1366 *
1367 * Note: This isn't fatal if the file is not found. The standard
1368 * defines 3 cases.
1369 * 1. no manifest file
1370 * 2. manifest file after the OVF file
1371 * 3. manifest file after all disk files
1372 * If we want streaming capabilities, we can't check if it is there by
1373 * searching for it. We have to try to open it on all possible places.
1374 * If it fails here, we will try it again after all disks where read.
1375 */
1376 rc = readTarManifestFile(tar, strMfFile, &pvMfBuf, &cbMfSize, pCallbacks, pStorage);
1377 if (FAILED(rc)) throw rc;
1378 /* Now import the appliance. */
1379 importMachines(stack, pCallbacks, pStorage);
1380 /* Try to read the manifest file. Second try. */
1381 if (!pvMfBuf)
1382 {
1383 rc = readTarManifestFile(tar, strMfFile, &pvMfBuf, &cbMfSize, pCallbacks, pStorage);
1384 if (FAILED(rc)) throw rc;
1385 }
1386 /* If we were able to read a manifest file we can check it now. */
1387 if (pvMfBuf)
1388 {
1389 /* Add the ovf file to the digest list. */
1390 stack.llSrcDisksDigest.push_front(STRPAIR(Utf8Str(pszFilename).stripExt().append(".ovf"), m->strOVFSHADigest));
1391 rc = verifyManifestFile(strMfFile, stack, pvMfBuf, cbMfSize);
1392 if (FAILED(rc)) throw rc;
1393 }
1394 }
1395 catch (HRESULT rc2)
1396 {
1397 rc = rc2;
1398 }
1399 writeLock.acquire();
1400
1401 RTTarClose(tar);
1402
1403 /* Cleanup */
1404 if (pszFilename)
1405 RTMemFree(pszFilename);
1406 if (pvMfBuf)
1407 RTMemFree(pvMfBuf);
1408 if (pShaIo)
1409 RTMemFree(pShaIo);
1410 if (pTarIo)
1411 RTMemFree(pTarIo);
1412
1413 LogFlowFunc(("rc=%Rhrc\n", rc));
1414 LogFlowFuncLeave();
1415
1416 return rc;
1417}
1418
1419#ifdef VBOX_WITH_S3
1420/**
1421 * Worker code for importing OVF from the cloud. This is called from Appliance::taskThreadImportOrExport()
1422 * in S3 mode and therefore runs on the OVF import worker thread. This then starts a second worker
1423 * thread to import from temporary files (see Appliance::importFS()).
1424 * @param pTask
1425 * @return
1426 */
1427HRESULT Appliance::importS3(TaskOVF *pTask)
1428{
1429 LogFlowFuncEnter();
1430 LogFlowFunc(("Appliance %p\n", this));
1431
1432 AutoCaller autoCaller(this);
1433 if (FAILED(autoCaller.rc())) return autoCaller.rc();
1434
1435 AutoWriteLock appLock(this COMMA_LOCKVAL_SRC_POS);
1436
1437 int vrc = VINF_SUCCESS;
1438 RTS3 hS3 = NIL_RTS3;
1439 char szOSTmpDir[RTPATH_MAX];
1440 RTPathTemp(szOSTmpDir, sizeof(szOSTmpDir));
1441 /* The template for the temporary directory created below */
1442 char *pszTmpDir = RTPathJoinA(szOSTmpDir, "vbox-ovf-XXXXXX");
1443 list< pair<Utf8Str, ULONG> > filesList;
1444
1445 HRESULT rc = S_OK;
1446 try
1447 {
1448 /* Extract the bucket */
1449 Utf8Str tmpPath = pTask->locInfo.strPath;
1450 Utf8Str bucket;
1451 parseBucket(tmpPath, bucket);
1452
1453 /* We need a temporary directory which we can put the all disk images
1454 * in */
1455 vrc = RTDirCreateTemp(pszTmpDir, 0700);
1456 if (RT_FAILURE(vrc))
1457 throw setError(VBOX_E_FILE_ERROR,
1458 tr("Cannot create temporary directory '%s' (%Rrc)"), pszTmpDir, vrc);
1459
1460 /* Add every disks of every virtual system to an internal list */
1461 list< ComObjPtr<VirtualSystemDescription> >::const_iterator it;
1462 for (it = m->virtualSystemDescriptions.begin();
1463 it != m->virtualSystemDescriptions.end();
1464 ++it)
1465 {
1466 ComObjPtr<VirtualSystemDescription> vsdescThis = (*it);
1467 std::list<VirtualSystemDescriptionEntry*> avsdeHDs = vsdescThis->findByType(VirtualSystemDescriptionType_HardDiskImage);
1468 std::list<VirtualSystemDescriptionEntry*>::const_iterator itH;
1469 for (itH = avsdeHDs.begin();
1470 itH != avsdeHDs.end();
1471 ++itH)
1472 {
1473 const Utf8Str &strTargetFile = (*itH)->strOvf;
1474 if (!strTargetFile.isEmpty())
1475 {
1476 /* The temporary name of the target disk file */
1477 Utf8StrFmt strTmpDisk("%s/%s", pszTmpDir, RTPathFilename(strTargetFile.c_str()));
1478 filesList.push_back(pair<Utf8Str, ULONG>(strTmpDisk, (*itH)->ulSizeMB));
1479 }
1480 }
1481 }
1482
1483 /* Next we have to download the disk images */
1484 vrc = RTS3Create(&hS3, pTask->locInfo.strUsername.c_str(), pTask->locInfo.strPassword.c_str(), pTask->locInfo.strHostname.c_str(), "virtualbox-agent/"VBOX_VERSION_STRING);
1485 if (RT_FAILURE(vrc))
1486 throw setError(VBOX_E_IPRT_ERROR,
1487 tr("Cannot create S3 service handler"));
1488 RTS3SetProgressCallback(hS3, pTask->updateProgress, &pTask);
1489
1490 /* Download all files */
1491 for (list< pair<Utf8Str, ULONG> >::const_iterator it1 = filesList.begin(); it1 != filesList.end(); ++it1)
1492 {
1493 const pair<Utf8Str, ULONG> &s = (*it1);
1494 const Utf8Str &strSrcFile = s.first;
1495 /* Construct the source file name */
1496 char *pszFilename = RTPathFilename(strSrcFile.c_str());
1497 /* Advance to the next operation */
1498 if (!pTask->pProgress.isNull())
1499 pTask->pProgress->SetNextOperation(BstrFmt(tr("Downloading file '%s'"), pszFilename).raw(), s.second);
1500
1501 vrc = RTS3GetKey(hS3, bucket.c_str(), pszFilename, strSrcFile.c_str());
1502 if (RT_FAILURE(vrc))
1503 {
1504 if (vrc == VERR_S3_CANCELED)
1505 throw S_OK; /* todo: !!!!!!!!!!!!! */
1506 else if (vrc == VERR_S3_ACCESS_DENIED)
1507 throw setError(E_ACCESSDENIED,
1508 tr("Cannot download file '%s' from S3 storage server (Access denied). "
1509 "Make sure that your credentials are right. Also check that your host clock is properly synced"),
1510 pszFilename);
1511 else if (vrc == VERR_S3_NOT_FOUND)
1512 throw setError(VBOX_E_FILE_ERROR,
1513 tr("Cannot download file '%s' from S3 storage server (File not found)"),
1514 pszFilename);
1515 else
1516 throw setError(VBOX_E_IPRT_ERROR,
1517 tr("Cannot download file '%s' from S3 storage server (%Rrc)"),
1518 pszFilename, vrc);
1519 }
1520 }
1521
1522 /* Provide a OVF file (haven't to exist) so the import routine can
1523 * figure out where the disk images/manifest file are located. */
1524 Utf8StrFmt strTmpOvf("%s/%s", pszTmpDir, RTPathFilename(tmpPath.c_str()));
1525 /* Now check if there is an manifest file. This is optional. */
1526 Utf8Str strManifestFile; //= queryManifestFileName(strTmpOvf);
1527// Utf8Str strManifestFile = queryManifestFileName(strTmpOvf);
1528 char *pszFilename = RTPathFilename(strManifestFile.c_str());
1529 if (!pTask->pProgress.isNull())
1530 pTask->pProgress->SetNextOperation(BstrFmt(tr("Downloading file '%s'"), pszFilename).raw(), 1);
1531
1532 /* Try to download it. If the error is VERR_S3_NOT_FOUND, it isn't fatal. */
1533 vrc = RTS3GetKey(hS3, bucket.c_str(), pszFilename, strManifestFile.c_str());
1534 if (RT_SUCCESS(vrc))
1535 filesList.push_back(pair<Utf8Str, ULONG>(strManifestFile, 0));
1536 else if (RT_FAILURE(vrc))
1537 {
1538 if (vrc == VERR_S3_CANCELED)
1539 throw S_OK; /* todo: !!!!!!!!!!!!! */
1540 else if (vrc == VERR_S3_NOT_FOUND)
1541 vrc = VINF_SUCCESS; /* Not found is ok */
1542 else if (vrc == VERR_S3_ACCESS_DENIED)
1543 throw setError(E_ACCESSDENIED,
1544 tr("Cannot download file '%s' from S3 storage server (Access denied)."
1545 "Make sure that your credentials are right. Also check that your host clock is properly synced"),
1546 pszFilename);
1547 else
1548 throw setError(VBOX_E_IPRT_ERROR,
1549 tr("Cannot download file '%s' from S3 storage server (%Rrc)"),
1550 pszFilename, vrc);
1551 }
1552
1553 /* Close the connection early */
1554 RTS3Destroy(hS3);
1555 hS3 = NIL_RTS3;
1556
1557 pTask->pProgress->SetNextOperation(BstrFmt(tr("Importing appliance")).raw(), m->ulWeightForXmlOperation);
1558
1559 ComObjPtr<Progress> progress;
1560 /* Import the whole temporary OVF & the disk images */
1561 LocationInfo li;
1562 li.strPath = strTmpOvf;
1563 rc = importImpl(li, progress);
1564 if (FAILED(rc)) throw rc;
1565
1566 /* Unlock the appliance for the fs import thread */
1567 appLock.release();
1568 /* Wait until the import is done, but report the progress back to the
1569 caller */
1570 ComPtr<IProgress> progressInt(progress);
1571 waitForAsyncProgress(pTask->pProgress, progressInt); /* Any errors will be thrown */
1572
1573 /* Again lock the appliance for the next steps */
1574 appLock.acquire();
1575 }
1576 catch(HRESULT aRC)
1577 {
1578 rc = aRC;
1579 }
1580 /* Cleanup */
1581 RTS3Destroy(hS3);
1582 /* Delete all files which where temporary created */
1583 for (list< pair<Utf8Str, ULONG> >::const_iterator it1 = filesList.begin(); it1 != filesList.end(); ++it1)
1584 {
1585 const char *pszFilePath = (*it1).first.c_str();
1586 if (RTPathExists(pszFilePath))
1587 {
1588 vrc = RTFileDelete(pszFilePath);
1589 if (RT_FAILURE(vrc))
1590 rc = setError(VBOX_E_FILE_ERROR,
1591 tr("Cannot delete file '%s' (%Rrc)"), pszFilePath, vrc);
1592 }
1593 }
1594 /* Delete the temporary directory */
1595 if (RTPathExists(pszTmpDir))
1596 {
1597 vrc = RTDirRemove(pszTmpDir);
1598 if (RT_FAILURE(vrc))
1599 rc = setError(VBOX_E_FILE_ERROR,
1600 tr("Cannot delete temporary directory '%s' (%Rrc)"), pszTmpDir, vrc);
1601 }
1602 if (pszTmpDir)
1603 RTStrFree(pszTmpDir);
1604
1605 LogFlowFunc(("rc=%Rhrc\n", rc));
1606 LogFlowFuncLeave();
1607
1608 return rc;
1609}
1610#endif /* VBOX_WITH_S3 */
1611
1612HRESULT Appliance::readManifestFile(const Utf8Str &strFile, void **ppvBuf, size_t *pcbSize, PVDINTERFACEIO pCallbacks, PSHASTORAGE pStorage)
1613{
1614 HRESULT rc = S_OK;
1615
1616 bool fOldDigest = pStorage->fCreateDigest;
1617 pStorage->fCreateDigest = false; /* No digest for the manifest file */
1618 int vrc = ShaReadBuf(strFile.c_str(), ppvBuf, pcbSize, pCallbacks, pStorage);
1619 if ( RT_FAILURE(vrc)
1620 && vrc != VERR_FILE_NOT_FOUND)
1621 rc = setError(VBOX_E_FILE_ERROR,
1622 tr("Could not read manifest file '%s' (%Rrc)"),
1623 RTPathFilename(strFile.c_str()), vrc);
1624 pStorage->fCreateDigest = fOldDigest; /* Restore the old digest creation behavior again. */
1625
1626 return rc;
1627}
1628
1629HRESULT Appliance::readTarManifestFile(RTTAR tar, const Utf8Str &strFile, void **ppvBuf, size_t *pcbSize, PVDINTERFACEIO pCallbacks, PSHASTORAGE pStorage)
1630{
1631 HRESULT rc = S_OK;
1632
1633 char *pszCurFile;
1634 int vrc = RTTarCurrentFile(tar, &pszCurFile);
1635 if (RT_SUCCESS(vrc))
1636 {
1637 if (!strcmp(pszCurFile, RTPathFilename(strFile.c_str())))
1638 rc = readManifestFile(strFile, ppvBuf, pcbSize, pCallbacks, pStorage);
1639 RTStrFree(pszCurFile);
1640 }
1641 else if (vrc != VERR_TAR_END_OF_FILE)
1642 rc = setError(VBOX_E_IPRT_ERROR, "Seeking within the archive failed (%Rrc)", vrc);
1643
1644 return rc;
1645}
1646
1647HRESULT Appliance::verifyManifestFile(const Utf8Str &strFile, ImportStack &stack, void *pvBuf, size_t cbSize)
1648{
1649 HRESULT rc = S_OK;
1650
1651 PRTMANIFESTTEST paTests = (PRTMANIFESTTEST)RTMemAlloc(sizeof(RTMANIFESTTEST) * stack.llSrcDisksDigest.size());
1652 if (!paTests)
1653 return E_OUTOFMEMORY;
1654
1655 size_t i = 0;
1656 list<STRPAIR>::const_iterator it1;
1657 for (it1 = stack.llSrcDisksDigest.begin();
1658 it1 != stack.llSrcDisksDigest.end();
1659 ++it1, ++i)
1660 {
1661 paTests[i].pszTestFile = (*it1).first.c_str();
1662 paTests[i].pszTestDigest = (*it1).second.c_str();
1663 }
1664 size_t iFailed;
1665 int vrc = RTManifestVerifyFilesBuf(pvBuf, cbSize, paTests, stack.llSrcDisksDigest.size(), &iFailed);
1666 if (RT_UNLIKELY(vrc == VERR_MANIFEST_DIGEST_MISMATCH))
1667 rc = setError(VBOX_E_FILE_ERROR,
1668 tr("The SHA1 digest of '%s' does not match the one in '%s' (%Rrc)"),
1669 RTPathFilename(paTests[iFailed].pszTestFile), RTPathFilename(strFile.c_str()), vrc);
1670 else if (RT_FAILURE(vrc))
1671 rc = setError(VBOX_E_FILE_ERROR,
1672 tr("Could not verify the content of '%s' against the available files (%Rrc)"),
1673 RTPathFilename(strFile.c_str()), vrc);
1674
1675 RTMemFree(paTests);
1676
1677 return rc;
1678}
1679
1680
1681/**
1682 * Helper that converts VirtualSystem attachment values into VirtualBox attachment values.
1683 * Throws HRESULT values on errors!
1684 *
1685 * @param hdc in: the HardDiskController structure to attach to.
1686 * @param ulAddressOnParent in: the AddressOnParent parameter from OVF.
1687 * @param controllerType out: the name of the hard disk controller to attach to (e.g. "IDE Controller").
1688 * @param lControllerPort out: the channel (controller port) of the controller to attach to.
1689 * @param lDevice out: the device number to attach to.
1690 */
1691void Appliance::convertDiskAttachmentValues(const ovf::HardDiskController &hdc,
1692 uint32_t ulAddressOnParent,
1693 Bstr &controllerType,
1694 int32_t &lControllerPort,
1695 int32_t &lDevice)
1696{
1697 Log(("Appliance::convertDiskAttachmentValues: hdc.system=%d, hdc.fPrimary=%d, ulAddressOnParent=%d\n", hdc.system, hdc.fPrimary, ulAddressOnParent));
1698
1699 switch (hdc.system)
1700 {
1701 case ovf::HardDiskController::IDE:
1702 // For the IDE bus, the port parameter can be either 0 or 1, to specify the primary
1703 // or secondary IDE controller, respectively. For the primary controller of the IDE bus,
1704 // the device number can be either 0 or 1, to specify the master or the slave device,
1705 // respectively. For the secondary IDE controller, the device number is always 1 because
1706 // the master device is reserved for the CD-ROM drive.
1707 controllerType = Bstr("IDE Controller");
1708 switch (ulAddressOnParent)
1709 {
1710 case 0: // master
1711 if (!hdc.fPrimary)
1712 {
1713 // secondary master
1714 lControllerPort = (long)1;
1715 lDevice = (long)0;
1716 }
1717 else // primary master
1718 {
1719 lControllerPort = (long)0;
1720 lDevice = (long)0;
1721 }
1722 break;
1723
1724 case 1: // slave
1725 if (!hdc.fPrimary)
1726 {
1727 // secondary slave
1728 lControllerPort = (long)1;
1729 lDevice = (long)1;
1730 }
1731 else // primary slave
1732 {
1733 lControllerPort = (long)0;
1734 lDevice = (long)1;
1735 }
1736 break;
1737
1738 // used by older VBox exports
1739 case 2: // interpret this as secondary master
1740 lControllerPort = (long)1;
1741 lDevice = (long)0;
1742 break;
1743
1744 // used by older VBox exports
1745 case 3: // interpret this as secondary slave
1746 lControllerPort = (long)1;
1747 lDevice = (long)1;
1748 break;
1749
1750 default:
1751 throw setError(VBOX_E_NOT_SUPPORTED,
1752 tr("Invalid channel %RI16 specified; IDE controllers support only 0, 1 or 2"),
1753 ulAddressOnParent);
1754 break;
1755 }
1756 break;
1757
1758 case ovf::HardDiskController::SATA:
1759 controllerType = Bstr("SATA Controller");
1760 lControllerPort = (long)ulAddressOnParent;
1761 lDevice = (long)0;
1762 break;
1763
1764 case ovf::HardDiskController::SCSI:
1765 controllerType = Bstr("SCSI Controller");
1766 lControllerPort = (long)ulAddressOnParent;
1767 lDevice = (long)0;
1768 break;
1769
1770 default: break;
1771 }
1772
1773 Log(("=> lControllerPort=%d, lDevice=%d\n", lControllerPort, lDevice));
1774}
1775
1776/**
1777 * Imports one disk image. This is common code shared between
1778 * -- importMachineGeneric() for the OVF case; in that case the information comes from
1779 * the OVF virtual systems;
1780 * -- importVBoxMachine(); in that case, the information comes from the <vbox:Machine>
1781 * tag.
1782 *
1783 * Both ways of describing machines use the OVF disk references section, so in both cases
1784 * the caller needs to pass in the ovf::DiskImage structure from ovfreader.cpp.
1785 *
1786 * As a result, in both cases, if di.strHref is empty, we create a new disk as per the OVF
1787 * spec, even though this cannot really happen in the vbox:Machine case since such data
1788 * would never have been exported.
1789 *
1790 * This advances stack.pProgress by one operation with the disk's weight.
1791 *
1792 * @param di ovfreader.cpp structure describing the disk image from the OVF that is to be imported
1793 * @param ulSizeMB Size of the disk image (for progress reporting)
1794 * @param strTargetPath Where to create the target image.
1795 * @param pTargetHD out: The newly created target disk. This also gets pushed on stack.llHardDisksCreated for cleanup.
1796 * @param stack
1797 */
1798void Appliance::importOneDiskImage(const ovf::DiskImage &di,
1799 const Utf8Str &strTargetPath,
1800 ComObjPtr<Medium> &pTargetHD,
1801 ImportStack &stack,
1802 PVDINTERFACEIO pCallbacks,
1803 PSHASTORAGE pStorage)
1804{
1805 ComObjPtr<Progress> pProgress;
1806 pProgress.createObject();
1807 HRESULT rc = pProgress->init(mVirtualBox, static_cast<IAppliance*>(this), BstrFmt(tr("Creating medium '%s'"), strTargetPath.c_str()).raw(), TRUE);
1808 if (FAILED(rc)) throw rc;
1809
1810 /* Get the system properties. */
1811 SystemProperties *pSysProps = mVirtualBox->getSystemProperties();
1812
1813 /* First of all check if the path is an UUID. If so, the user like to
1814 * import the disk into an existing path. This is useful for iSCSI for
1815 * example. */
1816 RTUUID uuid;
1817 int vrc = RTUuidFromStr(&uuid, strTargetPath.c_str());
1818 if (vrc == VINF_SUCCESS)
1819 {
1820 rc = mVirtualBox->findHardDiskById(Guid(uuid), true, &pTargetHD);
1821 if (FAILED(rc)) throw rc;
1822 }
1823 else
1824 {
1825 Utf8Str strTrgFormat = "VMDK";
1826 if (RTPathHaveExt(strTargetPath.c_str()))
1827 {
1828 char *pszExt = RTPathExt(strTargetPath.c_str());
1829 /* Figure out which format the user like to have. Default is VMDK. */
1830 ComObjPtr<MediumFormat> trgFormat = pSysProps->mediumFormatFromExtension(&pszExt[1]);
1831 if (trgFormat.isNull())
1832 throw setError(VBOX_E_NOT_SUPPORTED,
1833 tr("Could not find a valid medium format for the target disk '%s'"),
1834 strTargetPath.c_str());
1835 /* Check the capabilities. We need create capabilities. */
1836 ULONG lCabs = 0;
1837 rc = trgFormat->COMGETTER(Capabilities)(&lCabs);
1838 if (FAILED(rc)) throw rc;
1839 if (!( ((lCabs & MediumFormatCapabilities_CreateFixed) == MediumFormatCapabilities_CreateFixed)
1840 || ((lCabs & MediumFormatCapabilities_CreateDynamic) == MediumFormatCapabilities_CreateDynamic)))
1841 throw setError(VBOX_E_NOT_SUPPORTED,
1842 tr("Could not find a valid medium format for the target disk '%s'"),
1843 strTargetPath.c_str());
1844 Bstr bstrFormatName;
1845 rc = trgFormat->COMGETTER(Name)(bstrFormatName.asOutParam());
1846 if (FAILED(rc)) throw rc;
1847 strTrgFormat = Utf8Str(bstrFormatName);
1848 }
1849
1850 /* Create an IMedium object. */
1851 pTargetHD.createObject();
1852 rc = pTargetHD->init(mVirtualBox,
1853 strTrgFormat,
1854 strTargetPath,
1855 Guid::Empty /* media registry: none yet */);
1856 if (FAILED(rc)) throw rc;
1857
1858 /* Now create an empty hard disk. */
1859 rc = mVirtualBox->CreateHardDisk(NULL,
1860 Bstr(strTargetPath).raw(),
1861 ComPtr<IMedium>(pTargetHD).asOutParam());
1862 if (FAILED(rc)) throw rc;
1863 }
1864
1865 const Utf8Str &strSourceOVF = di.strHref;
1866 /* Construct source file path */
1867 Utf8StrFmt strSrcFilePath("%s%c%s", stack.strSourceDir.c_str(), RTPATH_DELIMITER, strSourceOVF.c_str());
1868
1869 /* If strHref is empty we have to create a new file. */
1870 if (strSourceOVF.isEmpty())
1871 {
1872 /* Create a dynamic growing disk image with the given capacity. */
1873 rc = pTargetHD->CreateBaseStorage(di.iCapacity / _1M, MediumVariant_Standard, ComPtr<IProgress>(pProgress).asOutParam());
1874 if (FAILED(rc)) throw rc;
1875
1876 /* Advance to the next operation. */
1877 stack.pProgress->SetNextOperation(BstrFmt(tr("Creating disk image '%s'"), strTargetPath.c_str()).raw(),
1878 di.ulSuggestedSizeMB); // operation's weight, as set up with the IProgress originally
1879 }
1880 else
1881 {
1882 /* We need a proper source format description */
1883 ComObjPtr<MediumFormat> srcFormat;
1884 /* Which format to use? */
1885 Utf8Str strSrcFormat = "VDI";
1886 if ( di.strFormat.compare("http://www.vmware.com/specifications/vmdk.html#sparse", Utf8Str::CaseInsensitive)
1887 || di.strFormat.compare("http://www.vmware.com/interfaces/specifications/vmdk.html#streamOptimized", Utf8Str::CaseInsensitive)
1888 || di.strFormat.compare("http://www.vmware.com/specifications/vmdk.html#compressed", Utf8Str::CaseInsensitive)
1889 || di.strFormat.compare("http://www.vmware.com/interfaces/specifications/vmdk.html#compressed", Utf8Str::CaseInsensitive)
1890 )
1891 strSrcFormat = "VMDK";
1892 srcFormat = pSysProps->mediumFormat(strSrcFormat);
1893 if (srcFormat.isNull())
1894 throw setError(VBOX_E_NOT_SUPPORTED,
1895 tr("Could not find a valid medium format for the source disk '%s'"),
1896 RTPathFilename(strSrcFilePath.c_str()));
1897
1898 /* Clone the source disk image */
1899 ComObjPtr<Medium> nullParent;
1900 rc = pTargetHD->importFile(strSrcFilePath.c_str(),
1901 srcFormat,
1902 MediumVariant_Standard,
1903 pCallbacks, pStorage,
1904 nullParent,
1905 pProgress);
1906 if (FAILED(rc)) throw rc;
1907
1908 /* Advance to the next operation. */
1909 stack.pProgress->SetNextOperation(BstrFmt(tr("Importing virtual disk image '%s'"), RTPathFilename(strSrcFilePath.c_str())).raw(),
1910 di.ulSuggestedSizeMB); // operation's weight, as set up with the IProgress originally);
1911 }
1912
1913 /* Now wait for the background disk operation to complete; this throws
1914 * HRESULTs on error. */
1915 ComPtr<IProgress> pp(pProgress);
1916 waitForAsyncProgress(stack.pProgress, pp);
1917
1918 /* Add the newly create disk path + a corresponding digest the our list for
1919 * later manifest verification. */
1920 stack.llSrcDisksDigest.push_back(STRPAIR(strSrcFilePath, pStorage ? pStorage->strDigest : ""));
1921}
1922
1923/**
1924 * Imports one OVF virtual system (described by the given ovf::VirtualSystem and VirtualSystemDescription)
1925 * into VirtualBox by creating an IMachine instance, which is returned.
1926 *
1927 * This throws HRESULT error codes for anything that goes wrong, in which case the caller must clean
1928 * up any leftovers from this function. For this, the given ImportStack instance has received information
1929 * about what needs cleaning up (to support rollback).
1930 *
1931 * @param vsysThis OVF virtual system (machine) to import.
1932 * @param vsdescThis Matching virtual system description (machine) to import.
1933 * @param pNewMachine out: Newly created machine.
1934 * @param stack Cleanup stack for when this throws.
1935 */
1936void Appliance::importMachineGeneric(const ovf::VirtualSystem &vsysThis,
1937 ComObjPtr<VirtualSystemDescription> &vsdescThis,
1938 ComPtr<IMachine> &pNewMachine,
1939 ImportStack &stack,
1940 PVDINTERFACEIO pCallbacks,
1941 PSHASTORAGE pStorage)
1942{
1943 HRESULT rc;
1944
1945 // Get the instance of IGuestOSType which matches our string guest OS type so we
1946 // can use recommended defaults for the new machine where OVF doesn't provide any
1947 ComPtr<IGuestOSType> osType;
1948 rc = mVirtualBox->GetGuestOSType(Bstr(stack.strOsTypeVBox).raw(), osType.asOutParam());
1949 if (FAILED(rc)) throw rc;
1950
1951 /* Create the machine */
1952 SafeArray<BSTR> groups; /* no groups */
1953 rc = mVirtualBox->CreateMachine(NULL, /* machine name: use default */
1954 Bstr(stack.strNameVBox).raw(),
1955 ComSafeArrayAsInParam(groups),
1956 Bstr(stack.strOsTypeVBox).raw(),
1957 NULL, /* aCreateFlags */
1958 pNewMachine.asOutParam());
1959 if (FAILED(rc)) throw rc;
1960
1961 // set the description
1962 if (!stack.strDescription.isEmpty())
1963 {
1964 rc = pNewMachine->COMSETTER(Description)(Bstr(stack.strDescription).raw());
1965 if (FAILED(rc)) throw rc;
1966 }
1967
1968 // CPU count
1969 rc = pNewMachine->COMSETTER(CPUCount)(stack.cCPUs);
1970 if (FAILED(rc)) throw rc;
1971
1972 if (stack.fForceHWVirt)
1973 {
1974 rc = pNewMachine->SetHWVirtExProperty(HWVirtExPropertyType_Enabled, TRUE);
1975 if (FAILED(rc)) throw rc;
1976 }
1977
1978 // RAM
1979 rc = pNewMachine->COMSETTER(MemorySize)(stack.ulMemorySizeMB);
1980 if (FAILED(rc)) throw rc;
1981
1982 /* VRAM */
1983 /* Get the recommended VRAM for this guest OS type */
1984 ULONG vramVBox;
1985 rc = osType->COMGETTER(RecommendedVRAM)(&vramVBox);
1986 if (FAILED(rc)) throw rc;
1987
1988 /* Set the VRAM */
1989 rc = pNewMachine->COMSETTER(VRAMSize)(vramVBox);
1990 if (FAILED(rc)) throw rc;
1991
1992 // I/O APIC: Generic OVF has no setting for this. Enable it if we
1993 // import a Windows VM because if if Windows was installed without IOAPIC,
1994 // it will not mind finding an one later on, but if Windows was installed
1995 // _with_ an IOAPIC, it will bluescreen if it's not found
1996 if (!stack.fForceIOAPIC)
1997 {
1998 Bstr bstrFamilyId;
1999 rc = osType->COMGETTER(FamilyId)(bstrFamilyId.asOutParam());
2000 if (FAILED(rc)) throw rc;
2001 if (bstrFamilyId == "Windows")
2002 stack.fForceIOAPIC = true;
2003 }
2004
2005 if (stack.fForceIOAPIC)
2006 {
2007 ComPtr<IBIOSSettings> pBIOSSettings;
2008 rc = pNewMachine->COMGETTER(BIOSSettings)(pBIOSSettings.asOutParam());
2009 if (FAILED(rc)) throw rc;
2010
2011 rc = pBIOSSettings->COMSETTER(IOAPICEnabled)(TRUE);
2012 if (FAILED(rc)) throw rc;
2013 }
2014
2015 if (!stack.strAudioAdapter.isEmpty())
2016 if (stack.strAudioAdapter.compare("null", Utf8Str::CaseInsensitive) != 0)
2017 {
2018 uint32_t audio = RTStrToUInt32(stack.strAudioAdapter.c_str()); // should be 0 for AC97
2019 ComPtr<IAudioAdapter> audioAdapter;
2020 rc = pNewMachine->COMGETTER(AudioAdapter)(audioAdapter.asOutParam());
2021 if (FAILED(rc)) throw rc;
2022 rc = audioAdapter->COMSETTER(Enabled)(true);
2023 if (FAILED(rc)) throw rc;
2024 rc = audioAdapter->COMSETTER(AudioController)(static_cast<AudioControllerType_T>(audio));
2025 if (FAILED(rc)) throw rc;
2026 }
2027
2028#ifdef VBOX_WITH_USB
2029 /* USB Controller */
2030 ComPtr<IUSBController> usbController;
2031 rc = pNewMachine->COMGETTER(USBController)(usbController.asOutParam());
2032 if (FAILED(rc)) throw rc;
2033 rc = usbController->COMSETTER(Enabled)(stack.fUSBEnabled);
2034 if (FAILED(rc)) throw rc;
2035#endif /* VBOX_WITH_USB */
2036
2037 /* Change the network adapters */
2038 uint32_t maxNetworkAdapters = Global::getMaxNetworkAdapters(ChipsetType_PIIX3);
2039
2040 std::list<VirtualSystemDescriptionEntry*> vsdeNW = vsdescThis->findByType(VirtualSystemDescriptionType_NetworkAdapter);
2041 if (vsdeNW.size() == 0)
2042 {
2043 /* No network adapters, so we have to disable our default one */
2044 ComPtr<INetworkAdapter> nwVBox;
2045 rc = pNewMachine->GetNetworkAdapter(0, nwVBox.asOutParam());
2046 if (FAILED(rc)) throw rc;
2047 rc = nwVBox->COMSETTER(Enabled)(false);
2048 if (FAILED(rc)) throw rc;
2049 }
2050 else if (vsdeNW.size() > maxNetworkAdapters)
2051 throw setError(VBOX_E_FILE_ERROR,
2052 tr("Too many network adapters: OVF requests %d network adapters, but VirtualBox only supports %d"),
2053 vsdeNW.size(), maxNetworkAdapters);
2054 else
2055 {
2056 list<VirtualSystemDescriptionEntry*>::const_iterator nwIt;
2057 size_t a = 0;
2058 for (nwIt = vsdeNW.begin();
2059 nwIt != vsdeNW.end();
2060 ++nwIt, ++a)
2061 {
2062 const VirtualSystemDescriptionEntry* pvsys = *nwIt;
2063
2064 const Utf8Str &nwTypeVBox = pvsys->strVboxCurrent;
2065 uint32_t tt1 = RTStrToUInt32(nwTypeVBox.c_str());
2066 ComPtr<INetworkAdapter> pNetworkAdapter;
2067 rc = pNewMachine->GetNetworkAdapter((ULONG)a, pNetworkAdapter.asOutParam());
2068 if (FAILED(rc)) throw rc;
2069 /* Enable the network card & set the adapter type */
2070 rc = pNetworkAdapter->COMSETTER(Enabled)(true);
2071 if (FAILED(rc)) throw rc;
2072 rc = pNetworkAdapter->COMSETTER(AdapterType)(static_cast<NetworkAdapterType_T>(tt1));
2073 if (FAILED(rc)) throw rc;
2074
2075 // default is NAT; change to "bridged" if extra conf says so
2076 if (pvsys->strExtraConfigCurrent.endsWith("type=Bridged", Utf8Str::CaseInsensitive))
2077 {
2078 /* Attach to the right interface */
2079 rc = pNetworkAdapter->COMSETTER(AttachmentType)(NetworkAttachmentType_Bridged);
2080 if (FAILED(rc)) throw rc;
2081 ComPtr<IHost> host;
2082 rc = mVirtualBox->COMGETTER(Host)(host.asOutParam());
2083 if (FAILED(rc)) throw rc;
2084 com::SafeIfaceArray<IHostNetworkInterface> nwInterfaces;
2085 rc = host->COMGETTER(NetworkInterfaces)(ComSafeArrayAsOutParam(nwInterfaces));
2086 if (FAILED(rc)) throw rc;
2087 // We search for the first host network interface which
2088 // is usable for bridged networking
2089 for (size_t j = 0;
2090 j < nwInterfaces.size();
2091 ++j)
2092 {
2093 HostNetworkInterfaceType_T itype;
2094 rc = nwInterfaces[j]->COMGETTER(InterfaceType)(&itype);
2095 if (FAILED(rc)) throw rc;
2096 if (itype == HostNetworkInterfaceType_Bridged)
2097 {
2098 Bstr name;
2099 rc = nwInterfaces[j]->COMGETTER(Name)(name.asOutParam());
2100 if (FAILED(rc)) throw rc;
2101 /* Set the interface name to attach to */
2102 pNetworkAdapter->COMSETTER(BridgedInterface)(name.raw());
2103 if (FAILED(rc)) throw rc;
2104 break;
2105 }
2106 }
2107 }
2108 /* Next test for host only interfaces */
2109 else if (pvsys->strExtraConfigCurrent.endsWith("type=HostOnly", Utf8Str::CaseInsensitive))
2110 {
2111 /* Attach to the right interface */
2112 rc = pNetworkAdapter->COMSETTER(AttachmentType)(NetworkAttachmentType_HostOnly);
2113 if (FAILED(rc)) throw rc;
2114 ComPtr<IHost> host;
2115 rc = mVirtualBox->COMGETTER(Host)(host.asOutParam());
2116 if (FAILED(rc)) throw rc;
2117 com::SafeIfaceArray<IHostNetworkInterface> nwInterfaces;
2118 rc = host->COMGETTER(NetworkInterfaces)(ComSafeArrayAsOutParam(nwInterfaces));
2119 if (FAILED(rc)) throw rc;
2120 // We search for the first host network interface which
2121 // is usable for host only networking
2122 for (size_t j = 0;
2123 j < nwInterfaces.size();
2124 ++j)
2125 {
2126 HostNetworkInterfaceType_T itype;
2127 rc = nwInterfaces[j]->COMGETTER(InterfaceType)(&itype);
2128 if (FAILED(rc)) throw rc;
2129 if (itype == HostNetworkInterfaceType_HostOnly)
2130 {
2131 Bstr name;
2132 rc = nwInterfaces[j]->COMGETTER(Name)(name.asOutParam());
2133 if (FAILED(rc)) throw rc;
2134 /* Set the interface name to attach to */
2135 pNetworkAdapter->COMSETTER(HostOnlyInterface)(name.raw());
2136 if (FAILED(rc)) throw rc;
2137 break;
2138 }
2139 }
2140 }
2141 /* Next test for internal interfaces */
2142 else if (pvsys->strExtraConfigCurrent.endsWith("type=Internal", Utf8Str::CaseInsensitive))
2143 {
2144 /* Attach to the right interface */
2145 rc = pNetworkAdapter->COMSETTER(AttachmentType)(NetworkAttachmentType_Internal);
2146 if (FAILED(rc)) throw rc;
2147 }
2148 /* Next test for Generic interfaces */
2149 else if (pvsys->strExtraConfigCurrent.endsWith("type=Generic", Utf8Str::CaseInsensitive))
2150 {
2151 /* Attach to the right interface */
2152 rc = pNetworkAdapter->COMSETTER(AttachmentType)(NetworkAttachmentType_Generic);
2153 if (FAILED(rc)) throw rc;
2154 }
2155 }
2156 }
2157
2158 // IDE Hard disk controller
2159 std::list<VirtualSystemDescriptionEntry*> vsdeHDCIDE = vsdescThis->findByType(VirtualSystemDescriptionType_HardDiskControllerIDE);
2160 // In OVF (at least VMware's version of it), an IDE controller has two ports, so VirtualBox's single IDE controller
2161 // with two channels and two ports each counts as two OVF IDE controllers -- so we accept one or two such IDE controllers
2162 size_t cIDEControllers = vsdeHDCIDE.size();
2163 if (cIDEControllers > 2)
2164 throw setError(VBOX_E_FILE_ERROR,
2165 tr("Too many IDE controllers in OVF; import facility only supports two"));
2166 if (vsdeHDCIDE.size() > 0)
2167 {
2168 // one or two IDE controllers present in OVF: add one VirtualBox controller
2169 ComPtr<IStorageController> pController;
2170 rc = pNewMachine->AddStorageController(Bstr("IDE Controller").raw(), StorageBus_IDE, pController.asOutParam());
2171 if (FAILED(rc)) throw rc;
2172
2173 const char *pcszIDEType = vsdeHDCIDE.front()->strVboxCurrent.c_str();
2174 if (!strcmp(pcszIDEType, "PIIX3"))
2175 rc = pController->COMSETTER(ControllerType)(StorageControllerType_PIIX3);
2176 else if (!strcmp(pcszIDEType, "PIIX4"))
2177 rc = pController->COMSETTER(ControllerType)(StorageControllerType_PIIX4);
2178 else if (!strcmp(pcszIDEType, "ICH6"))
2179 rc = pController->COMSETTER(ControllerType)(StorageControllerType_ICH6);
2180 else
2181 throw setError(VBOX_E_FILE_ERROR,
2182 tr("Invalid IDE controller type \"%s\""),
2183 pcszIDEType);
2184 if (FAILED(rc)) throw rc;
2185 }
2186
2187 /* Hard disk controller SATA */
2188 std::list<VirtualSystemDescriptionEntry*> vsdeHDCSATA = vsdescThis->findByType(VirtualSystemDescriptionType_HardDiskControllerSATA);
2189 if (vsdeHDCSATA.size() > 1)
2190 throw setError(VBOX_E_FILE_ERROR,
2191 tr("Too many SATA controllers in OVF; import facility only supports one"));
2192 if (vsdeHDCSATA.size() > 0)
2193 {
2194 ComPtr<IStorageController> pController;
2195 const Utf8Str &hdcVBox = vsdeHDCSATA.front()->strVboxCurrent;
2196 if (hdcVBox == "AHCI")
2197 {
2198 rc = pNewMachine->AddStorageController(Bstr("SATA Controller").raw(), StorageBus_SATA, pController.asOutParam());
2199 if (FAILED(rc)) throw rc;
2200 }
2201 else
2202 throw setError(VBOX_E_FILE_ERROR,
2203 tr("Invalid SATA controller type \"%s\""),
2204 hdcVBox.c_str());
2205 }
2206
2207 /* Hard disk controller SCSI */
2208 std::list<VirtualSystemDescriptionEntry*> vsdeHDCSCSI = vsdescThis->findByType(VirtualSystemDescriptionType_HardDiskControllerSCSI);
2209 if (vsdeHDCSCSI.size() > 1)
2210 throw setError(VBOX_E_FILE_ERROR,
2211 tr("Too many SCSI controllers in OVF; import facility only supports one"));
2212 if (vsdeHDCSCSI.size() > 0)
2213 {
2214 ComPtr<IStorageController> pController;
2215 Bstr bstrName(L"SCSI Controller");
2216 StorageBus_T busType = StorageBus_SCSI;
2217 StorageControllerType_T controllerType;
2218 const Utf8Str &hdcVBox = vsdeHDCSCSI.front()->strVboxCurrent;
2219 if (hdcVBox == "LsiLogic")
2220 controllerType = StorageControllerType_LsiLogic;
2221 else if (hdcVBox == "LsiLogicSas")
2222 {
2223 // OVF treats LsiLogicSas as a SCSI controller but VBox considers it a class of its own
2224 bstrName = L"SAS Controller";
2225 busType = StorageBus_SAS;
2226 controllerType = StorageControllerType_LsiLogicSas;
2227 }
2228 else if (hdcVBox == "BusLogic")
2229 controllerType = StorageControllerType_BusLogic;
2230 else
2231 throw setError(VBOX_E_FILE_ERROR,
2232 tr("Invalid SCSI controller type \"%s\""),
2233 hdcVBox.c_str());
2234
2235 rc = pNewMachine->AddStorageController(bstrName.raw(), busType, pController.asOutParam());
2236 if (FAILED(rc)) throw rc;
2237 rc = pController->COMSETTER(ControllerType)(controllerType);
2238 if (FAILED(rc)) throw rc;
2239 }
2240
2241 /* Hard disk controller SAS */
2242 std::list<VirtualSystemDescriptionEntry*> vsdeHDCSAS = vsdescThis->findByType(VirtualSystemDescriptionType_HardDiskControllerSAS);
2243 if (vsdeHDCSAS.size() > 1)
2244 throw setError(VBOX_E_FILE_ERROR,
2245 tr("Too many SAS controllers in OVF; import facility only supports one"));
2246 if (vsdeHDCSAS.size() > 0)
2247 {
2248 ComPtr<IStorageController> pController;
2249 rc = pNewMachine->AddStorageController(Bstr(L"SAS Controller").raw(), StorageBus_SAS, pController.asOutParam());
2250 if (FAILED(rc)) throw rc;
2251 rc = pController->COMSETTER(ControllerType)(StorageControllerType_LsiLogicSas);
2252 if (FAILED(rc)) throw rc;
2253 }
2254
2255 /* Now its time to register the machine before we add any hard disks */
2256 rc = mVirtualBox->RegisterMachine(pNewMachine);
2257 if (FAILED(rc)) throw rc;
2258
2259 // store new machine for roll-back in case of errors
2260 Bstr bstrNewMachineId;
2261 rc = pNewMachine->COMGETTER(Id)(bstrNewMachineId.asOutParam());
2262 if (FAILED(rc)) throw rc;
2263 Guid uuidNewMachine(bstrNewMachineId);
2264 m->llGuidsMachinesCreated.push_back(uuidNewMachine);
2265
2266 // Add floppies and CD-ROMs to the appropriate controllers.
2267 std::list<VirtualSystemDescriptionEntry*> vsdeFloppy = vsdescThis->findByType(VirtualSystemDescriptionType_Floppy);
2268 if (vsdeFloppy.size() > 1)
2269 throw setError(VBOX_E_FILE_ERROR,
2270 tr("Too many floppy controllers in OVF; import facility only supports one"));
2271 std::list<VirtualSystemDescriptionEntry*> vsdeCDROM = vsdescThis->findByType(VirtualSystemDescriptionType_CDROM);
2272 if ( (vsdeFloppy.size() > 0)
2273 || (vsdeCDROM.size() > 0)
2274 )
2275 {
2276 // If there's an error here we need to close the session, so
2277 // we need another try/catch block.
2278
2279 try
2280 {
2281 // to attach things we need to open a session for the new machine
2282 rc = pNewMachine->LockMachine(stack.pSession, LockType_Write);
2283 if (FAILED(rc)) throw rc;
2284 stack.fSessionOpen = true;
2285
2286 ComPtr<IMachine> sMachine;
2287 rc = stack.pSession->COMGETTER(Machine)(sMachine.asOutParam());
2288 if (FAILED(rc)) throw rc;
2289
2290 // floppy first
2291 if (vsdeFloppy.size() == 1)
2292 {
2293 ComPtr<IStorageController> pController;
2294 rc = sMachine->AddStorageController(Bstr("Floppy Controller").raw(), StorageBus_Floppy, pController.asOutParam());
2295 if (FAILED(rc)) throw rc;
2296
2297 Bstr bstrName;
2298 rc = pController->COMGETTER(Name)(bstrName.asOutParam());
2299 if (FAILED(rc)) throw rc;
2300
2301 // this is for rollback later
2302 MyHardDiskAttachment mhda;
2303 mhda.pMachine = pNewMachine;
2304 mhda.controllerType = bstrName;
2305 mhda.lControllerPort = 0;
2306 mhda.lDevice = 0;
2307
2308 Log(("Attaching floppy\n"));
2309
2310 rc = sMachine->AttachDevice(mhda.controllerType.raw(),
2311 mhda.lControllerPort,
2312 mhda.lDevice,
2313 DeviceType_Floppy,
2314 NULL);
2315 if (FAILED(rc)) throw rc;
2316
2317 stack.llHardDiskAttachments.push_back(mhda);
2318 }
2319
2320 // CD-ROMs next
2321 for (std::list<VirtualSystemDescriptionEntry*>::const_iterator jt = vsdeCDROM.begin();
2322 jt != vsdeCDROM.end();
2323 ++jt)
2324 {
2325 // for now always attach to secondary master on IDE controller;
2326 // there seems to be no useful information in OVF where else to
2327 // attach it (@todo test with latest versions of OVF software)
2328
2329 // find the IDE controller
2330 const ovf::HardDiskController *pController = NULL;
2331 for (ovf::ControllersMap::const_iterator kt = vsysThis.mapControllers.begin();
2332 kt != vsysThis.mapControllers.end();
2333 ++kt)
2334 {
2335 if (kt->second.system == ovf::HardDiskController::IDE)
2336 {
2337 pController = &kt->second;
2338 break;
2339 }
2340 }
2341
2342 if (!pController)
2343 throw setError(VBOX_E_FILE_ERROR,
2344 tr("OVF wants a CD-ROM drive but cannot find IDE controller, which is required in this version of VirtualBox"));
2345
2346 // this is for rollback later
2347 MyHardDiskAttachment mhda;
2348 mhda.pMachine = pNewMachine;
2349
2350 convertDiskAttachmentValues(*pController,
2351 2, // interpreted as secondary master
2352 mhda.controllerType, // Bstr
2353 mhda.lControllerPort,
2354 mhda.lDevice);
2355
2356 Log(("Attaching CD-ROM to port %d on device %d\n", mhda.lControllerPort, mhda.lDevice));
2357
2358 rc = sMachine->AttachDevice(mhda.controllerType.raw(),
2359 mhda.lControllerPort,
2360 mhda.lDevice,
2361 DeviceType_DVD,
2362 NULL);
2363 if (FAILED(rc)) throw rc;
2364
2365 stack.llHardDiskAttachments.push_back(mhda);
2366 } // end for (itHD = avsdeHDs.begin();
2367
2368 rc = sMachine->SaveSettings();
2369 if (FAILED(rc)) throw rc;
2370
2371 // only now that we're done with all disks, close the session
2372 rc = stack.pSession->UnlockMachine();
2373 if (FAILED(rc)) throw rc;
2374 stack.fSessionOpen = false;
2375 }
2376 catch(HRESULT /* aRC */)
2377 {
2378 if (stack.fSessionOpen)
2379 stack.pSession->UnlockMachine();
2380
2381 throw;
2382 }
2383 }
2384
2385 // create the hard disks & connect them to the appropriate controllers
2386 std::list<VirtualSystemDescriptionEntry*> avsdeHDs = vsdescThis->findByType(VirtualSystemDescriptionType_HardDiskImage);
2387 if (avsdeHDs.size() > 0)
2388 {
2389 // If there's an error here we need to close the session, so
2390 // we need another try/catch block.
2391 try
2392 {
2393 // to attach things we need to open a session for the new machine
2394 rc = pNewMachine->LockMachine(stack.pSession, LockType_Write);
2395 if (FAILED(rc)) throw rc;
2396 stack.fSessionOpen = true;
2397
2398 /* Iterate over all given disk images */
2399 list<VirtualSystemDescriptionEntry*>::const_iterator itHD;
2400 for (itHD = avsdeHDs.begin();
2401 itHD != avsdeHDs.end();
2402 ++itHD)
2403 {
2404 VirtualSystemDescriptionEntry *vsdeHD = *itHD;
2405
2406 // vsdeHD->strRef contains the disk identifier (e.g. "vmdisk1"), which should exist
2407 // in the virtual system's disks map under that ID and also in the global images map
2408 ovf::VirtualDisksMap::const_iterator itVirtualDisk = vsysThis.mapVirtualDisks.find(vsdeHD->strRef);
2409 // and find the disk from the OVF's disk list
2410 ovf::DiskImagesMap::const_iterator itDiskImage = stack.mapDisks.find(vsdeHD->strRef);
2411 if ( (itVirtualDisk == vsysThis.mapVirtualDisks.end())
2412 || (itDiskImage == stack.mapDisks.end())
2413 )
2414 throw setError(E_FAIL,
2415 tr("Internal inconsistency looking up disk image '%s'"),
2416 vsdeHD->strRef.c_str());
2417
2418 const ovf::DiskImage &ovfDiskImage = itDiskImage->second;
2419 const ovf::VirtualDisk &ovfVdisk = itVirtualDisk->second;
2420
2421 ComObjPtr<Medium> pTargetHD;
2422 importOneDiskImage(ovfDiskImage,
2423 vsdeHD->strVboxCurrent,
2424 pTargetHD,
2425 stack,
2426 pCallbacks,
2427 pStorage);
2428
2429 // now use the new uuid to attach the disk image to our new machine
2430 ComPtr<IMachine> sMachine;
2431 rc = stack.pSession->COMGETTER(Machine)(sMachine.asOutParam());
2432 if (FAILED(rc)) throw rc;
2433
2434 // find the hard disk controller to which we should attach
2435 ovf::HardDiskController hdc = (*vsysThis.mapControllers.find(ovfVdisk.idController)).second;
2436
2437 // this is for rollback later
2438 MyHardDiskAttachment mhda;
2439 mhda.pMachine = pNewMachine;
2440
2441 convertDiskAttachmentValues(hdc,
2442 ovfVdisk.ulAddressOnParent,
2443 mhda.controllerType, // Bstr
2444 mhda.lControllerPort,
2445 mhda.lDevice);
2446
2447 Log(("Attaching disk %s to port %d on device %d\n", vsdeHD->strVboxCurrent.c_str(), mhda.lControllerPort, mhda.lDevice));
2448
2449 rc = sMachine->AttachDevice(mhda.controllerType.raw(), // wstring name
2450 mhda.lControllerPort, // long controllerPort
2451 mhda.lDevice, // long device
2452 DeviceType_HardDisk, // DeviceType_T type
2453 pTargetHD);
2454 if (FAILED(rc)) throw rc;
2455
2456 stack.llHardDiskAttachments.push_back(mhda);
2457
2458 rc = sMachine->SaveSettings();
2459 if (FAILED(rc)) throw rc;
2460 } // end for (itHD = avsdeHDs.begin();
2461
2462 // only now that we're done with all disks, close the session
2463 rc = stack.pSession->UnlockMachine();
2464 if (FAILED(rc)) throw rc;
2465 stack.fSessionOpen = false;
2466 }
2467 catch(HRESULT /* aRC */)
2468 {
2469 if (stack.fSessionOpen)
2470 stack.pSession->UnlockMachine();
2471
2472 throw;
2473 }
2474 }
2475}
2476
2477/**
2478 * Imports one OVF virtual system (described by a vbox:Machine tag represented by the given config
2479 * structure) into VirtualBox by creating an IMachine instance, which is returned.
2480 *
2481 * This throws HRESULT error codes for anything that goes wrong, in which case the caller must clean
2482 * up any leftovers from this function. For this, the given ImportStack instance has received information
2483 * about what needs cleaning up (to support rollback).
2484 *
2485 * The machine config stored in the settings::MachineConfigFile structure contains the UUIDs of
2486 * the disk attachments used by the machine when it was exported. We also add vbox:uuid attributes
2487 * to the OVF disks sections so we can look them up. While importing these UUIDs into a second host
2488 * will most probably work, reimporting them into the same host will cause conflicts, so we always
2489 * generate new ones on import. This involves the following:
2490 *
2491 * 1) Scan the machine config for disk attachments.
2492 *
2493 * 2) For each disk attachment found, look up the OVF disk image from the disk references section
2494 * and import the disk into VirtualBox, which creates a new UUID for it. In the machine config,
2495 * replace the old UUID with the new one.
2496 *
2497 * 3) Change the machine config according to the OVF virtual system descriptions, in case the
2498 * caller has modified them using setFinalValues().
2499 *
2500 * 4) Create the VirtualBox machine with the modfified machine config.
2501 *
2502 * @param config
2503 * @param pNewMachine
2504 * @param stack
2505 */
2506void Appliance::importVBoxMachine(ComObjPtr<VirtualSystemDescription> &vsdescThis,
2507 ComPtr<IMachine> &pReturnNewMachine,
2508 ImportStack &stack,
2509 PVDINTERFACEIO pCallbacks,
2510 PSHASTORAGE pStorage)
2511{
2512 Assert(vsdescThis->m->pConfig);
2513
2514 HRESULT rc = S_OK;
2515
2516 settings::MachineConfigFile &config = *vsdescThis->m->pConfig;
2517
2518 /*
2519 *
2520 * step 1): modify machine config according to OVF config, in case the user
2521 * has modified them using setFinalValues()
2522 *
2523 */
2524
2525 /* OS Type */
2526 config.machineUserData.strOsType = stack.strOsTypeVBox;
2527 /* Description */
2528 config.machineUserData.strDescription = stack.strDescription;
2529 /* CPU count & extented attributes */
2530 config.hardwareMachine.cCPUs = stack.cCPUs;
2531 if (stack.fForceIOAPIC)
2532 config.hardwareMachine.fHardwareVirt = true;
2533 if (stack.fForceIOAPIC)
2534 config.hardwareMachine.biosSettings.fIOAPICEnabled = true;
2535 /* RAM size */
2536 config.hardwareMachine.ulMemorySizeMB = stack.ulMemorySizeMB;
2537
2538/*
2539 <const name="HardDiskControllerIDE" value="14" />
2540 <const name="HardDiskControllerSATA" value="15" />
2541 <const name="HardDiskControllerSCSI" value="16" />
2542 <const name="HardDiskControllerSAS" value="17" />
2543*/
2544
2545#ifdef VBOX_WITH_USB
2546 /* USB controller */
2547 config.hardwareMachine.usbController.fEnabled = stack.fUSBEnabled;
2548#endif
2549 /* Audio adapter */
2550 if (stack.strAudioAdapter.isNotEmpty())
2551 {
2552 config.hardwareMachine.audioAdapter.fEnabled = true;
2553 config.hardwareMachine.audioAdapter.controllerType = (AudioControllerType_T)stack.strAudioAdapter.toUInt32();
2554 }
2555 else
2556 config.hardwareMachine.audioAdapter.fEnabled = false;
2557 /* Network adapter */
2558 settings::NetworkAdaptersList &llNetworkAdapters = config.hardwareMachine.llNetworkAdapters;
2559 /* First disable all network cards, they will be enabled below again. */
2560 settings::NetworkAdaptersList::iterator it1;
2561 bool fKeepAllMACs = m->optList.contains(ImportOptions_KeepAllMACs);
2562 bool fKeepNATMACs = m->optList.contains(ImportOptions_KeepNATMACs);
2563 for (it1 = llNetworkAdapters.begin(); it1 != llNetworkAdapters.end(); ++it1)
2564 {
2565 it1->fEnabled = false;
2566 if (!( fKeepAllMACs
2567 || (fKeepNATMACs && it1->mode == NetworkAttachmentType_NAT)))
2568 Host::generateMACAddress(it1->strMACAddress);
2569 }
2570 /* Now iterate over all network entries. */
2571 std::list<VirtualSystemDescriptionEntry*> avsdeNWs = vsdescThis->findByType(VirtualSystemDescriptionType_NetworkAdapter);
2572 if (avsdeNWs.size() > 0)
2573 {
2574 /* Iterate through all network adapter entries and search for the
2575 * corresponding one in the machine config. If one is found, configure
2576 * it based on the user settings. */
2577 list<VirtualSystemDescriptionEntry*>::const_iterator itNW;
2578 for (itNW = avsdeNWs.begin();
2579 itNW != avsdeNWs.end();
2580 ++itNW)
2581 {
2582 VirtualSystemDescriptionEntry *vsdeNW = *itNW;
2583 if ( vsdeNW->strExtraConfigCurrent.startsWith("slot=", Utf8Str::CaseInsensitive)
2584 && vsdeNW->strExtraConfigCurrent.length() > 6)
2585 {
2586 uint32_t iSlot = vsdeNW->strExtraConfigCurrent.substr(5, 1).toUInt32();
2587 /* Iterate through all network adapters in the machine config. */
2588 for (it1 = llNetworkAdapters.begin();
2589 it1 != llNetworkAdapters.end();
2590 ++it1)
2591 {
2592 /* Compare the slots. */
2593 if (it1->ulSlot == iSlot)
2594 {
2595 it1->fEnabled = true;
2596 it1->type = (NetworkAdapterType_T)vsdeNW->strVboxCurrent.toUInt32();
2597 break;
2598 }
2599 }
2600 }
2601 }
2602 }
2603
2604 /* Floppy controller */
2605 bool fFloppy = vsdescThis->findByType(VirtualSystemDescriptionType_Floppy).size() > 0;
2606 /* DVD controller */
2607 bool fDVD = vsdescThis->findByType(VirtualSystemDescriptionType_CDROM).size() > 0;
2608 /* Iterate over all storage controller check the attachments and remove
2609 * them when necessary. Also detect broken configs with more than one
2610 * attachment. Old VirtualBox versions (prior to 3.2.10) had all disk
2611 * attachments pointing to the last hard disk image, which causes import
2612 * failures. A long fixed bug, however the OVF files are long lived. */
2613 settings::StorageControllersList &llControllers = config.storageMachine.llStorageControllers;
2614 Guid hdUuid;
2615 uint32_t cHardDisks = 0;
2616 bool fInconsistent = false;
2617 bool fRepairDuplicate = false;
2618 settings::StorageControllersList::iterator it3;
2619 for (it3 = llControllers.begin();
2620 it3 != llControllers.end();
2621 ++it3)
2622 {
2623 settings::AttachedDevicesList &llAttachments = it3->llAttachedDevices;
2624 settings::AttachedDevicesList::iterator it4 = llAttachments.begin();
2625 while (it4 != llAttachments.end())
2626 {
2627 if ( ( !fDVD
2628 && it4->deviceType == DeviceType_DVD)
2629 ||
2630 ( !fFloppy
2631 && it4->deviceType == DeviceType_Floppy))
2632 {
2633 it4 = llAttachments.erase(it4);
2634 continue;
2635 }
2636 else if (it4->deviceType == DeviceType_HardDisk)
2637 {
2638 const Guid &thisUuid = it4->uuid;
2639 cHardDisks++;
2640 if (cHardDisks == 1)
2641 {
2642 if (hdUuid.isZero())
2643 hdUuid = thisUuid;
2644 else
2645 fInconsistent = true;
2646 }
2647 else
2648 {
2649 if (thisUuid.isZero())
2650 fInconsistent = true;
2651 else if (thisUuid == hdUuid)
2652 fRepairDuplicate = true;
2653 }
2654 }
2655 ++it4;
2656 }
2657 }
2658 /* paranoia... */
2659 if (fInconsistent || cHardDisks == 1)
2660 fRepairDuplicate = false;
2661
2662 /*
2663 *
2664 * step 2: scan the machine config for media attachments
2665 *
2666 */
2667
2668 /* Get all hard disk descriptions. */
2669 std::list<VirtualSystemDescriptionEntry*> avsdeHDs = vsdescThis->findByType(VirtualSystemDescriptionType_HardDiskImage);
2670 std::list<VirtualSystemDescriptionEntry*>::iterator avsdeHDsIt = avsdeHDs.begin();
2671 /* paranoia - if there is no 1:1 match do not try to repair. */
2672 if (cHardDisks != avsdeHDs.size())
2673 fRepairDuplicate = false;
2674
2675 // for each storage controller...
2676 for (settings::StorageControllersList::iterator sit = config.storageMachine.llStorageControllers.begin();
2677 sit != config.storageMachine.llStorageControllers.end();
2678 ++sit)
2679 {
2680 settings::StorageController &sc = *sit;
2681
2682 // find the OVF virtual system description entry for this storage controller
2683 switch (sc.storageBus)
2684 {
2685 case StorageBus_SATA:
2686 break;
2687 case StorageBus_SCSI:
2688 break;
2689 case StorageBus_IDE:
2690 break;
2691 case StorageBus_SAS:
2692 break;
2693 }
2694
2695 // for each medium attachment to this controller...
2696 for (settings::AttachedDevicesList::iterator dit = sc.llAttachedDevices.begin();
2697 dit != sc.llAttachedDevices.end();
2698 ++dit)
2699 {
2700 settings::AttachedDevice &d = *dit;
2701
2702 if (d.uuid.isZero())
2703 // empty DVD and floppy media
2704 continue;
2705
2706 // When repairing a broken VirtualBox xml config section (written
2707 // by VirtualBox versions earlier than 3.2.10) assume the disks
2708 // show up in the same order as in the OVF description.
2709 if (fRepairDuplicate)
2710 {
2711 VirtualSystemDescriptionEntry *vsdeHD = *avsdeHDsIt;
2712 ovf::DiskImagesMap::const_iterator itDiskImage = stack.mapDisks.find(vsdeHD->strRef);
2713 if (itDiskImage != stack.mapDisks.end())
2714 {
2715 const ovf::DiskImage &di = itDiskImage->second;
2716 d.uuid = Guid(di.uuidVbox);
2717 }
2718 ++avsdeHDsIt;
2719 }
2720
2721 // convert the Guid to string
2722 Utf8Str strUuid = d.uuid.toString();
2723
2724 // there must be an image in the OVF disk structs with the same UUID
2725 bool fFound = false;
2726 for (ovf::DiskImagesMap::const_iterator oit = stack.mapDisks.begin();
2727 oit != stack.mapDisks.end();
2728 ++oit)
2729 {
2730 const ovf::DiskImage &di = oit->second;
2731
2732 if (di.uuidVbox == strUuid)
2733 {
2734 VirtualSystemDescriptionEntry *vsdeTargetHD = 0;
2735
2736 /* Iterate over all given disk images of the virtual system
2737 * disks description. We need to find the target disk path,
2738 * which could be changed by the user. */
2739 list<VirtualSystemDescriptionEntry*>::const_iterator itHD;
2740 for (itHD = avsdeHDs.begin();
2741 itHD != avsdeHDs.end();
2742 ++itHD)
2743 {
2744 VirtualSystemDescriptionEntry *vsdeHD = *itHD;
2745 if (vsdeHD->strRef == oit->first)
2746 {
2747 vsdeTargetHD = vsdeHD;
2748 break;
2749 }
2750 }
2751 if (!vsdeTargetHD)
2752 throw setError(E_FAIL,
2753 tr("Internal inconsistency looking up disk image '%s'"),
2754 oit->first.c_str());
2755
2756 /*
2757 *
2758 * step 3: import disk
2759 *
2760 */
2761 ComObjPtr<Medium> pTargetHD;
2762 importOneDiskImage(di,
2763 vsdeTargetHD->strVboxCurrent,
2764 pTargetHD,
2765 stack,
2766 pCallbacks,
2767 pStorage);
2768
2769 // ... and replace the old UUID in the machine config with the one of
2770 // the imported disk that was just created
2771 Bstr hdId;
2772 rc = pTargetHD->COMGETTER(Id)(hdId.asOutParam());
2773 if (FAILED(rc)) throw rc;
2774
2775 d.uuid = hdId;
2776
2777 fFound = true;
2778 break;
2779 }
2780 }
2781
2782 // no disk with such a UUID found:
2783 if (!fFound)
2784 throw setError(E_FAIL,
2785 tr("<vbox:Machine> element in OVF contains a medium attachment for the disk image %s but the OVF describes no such image"),
2786 strUuid.c_str());
2787 } // for (settings::AttachedDevicesList::const_iterator dit = sc.llAttachedDevices.begin();
2788 } // for (settings::StorageControllersList::const_iterator sit = config.storageMachine.llStorageControllers.begin();
2789
2790 /*
2791 *
2792 * step 4): create the machine and have it import the config
2793 *
2794 */
2795
2796 ComObjPtr<Machine> pNewMachine;
2797 rc = pNewMachine.createObject();
2798 if (FAILED(rc)) throw rc;
2799
2800 // this magic constructor fills the new machine object with the MachineConfig
2801 // instance that we created from the vbox:Machine
2802 rc = pNewMachine->init(mVirtualBox,
2803 stack.strNameVBox, // name from OVF preparations; can be suffixed to avoid duplicates, or changed by user
2804 config); // the whole machine config
2805 if (FAILED(rc)) throw rc;
2806
2807 pReturnNewMachine = ComPtr<IMachine>(pNewMachine);
2808
2809 // and register it
2810 rc = mVirtualBox->RegisterMachine(pNewMachine);
2811 if (FAILED(rc)) throw rc;
2812
2813 // store new machine for roll-back in case of errors
2814 Bstr bstrNewMachineId;
2815 rc = pNewMachine->COMGETTER(Id)(bstrNewMachineId.asOutParam());
2816 if (FAILED(rc)) throw rc;
2817 m->llGuidsMachinesCreated.push_back(Guid(bstrNewMachineId));
2818}
2819
2820void Appliance::importMachines(ImportStack &stack,
2821 PVDINTERFACEIO pCallbacks,
2822 PSHASTORAGE pStorage)
2823{
2824 HRESULT rc = S_OK;
2825
2826 // this is safe to access because this thread only gets started
2827 // if pReader != NULL
2828 const ovf::OVFReader &reader = *m->pReader;
2829
2830 // create a session for the machine + disks we manipulate below
2831 rc = stack.pSession.createInprocObject(CLSID_Session);
2832 if (FAILED(rc)) throw rc;
2833
2834 list<ovf::VirtualSystem>::const_iterator it;
2835 list< ComObjPtr<VirtualSystemDescription> >::const_iterator it1;
2836 /* Iterate through all virtual systems of that appliance */
2837 size_t i = 0;
2838 for (it = reader.m_llVirtualSystems.begin(),
2839 it1 = m->virtualSystemDescriptions.begin();
2840 it != reader.m_llVirtualSystems.end();
2841 ++it, ++it1, ++i)
2842 {
2843 const ovf::VirtualSystem &vsysThis = *it;
2844 ComObjPtr<VirtualSystemDescription> vsdescThis = (*it1);
2845
2846 ComPtr<IMachine> pNewMachine;
2847
2848 // there are two ways in which we can create a vbox machine from OVF:
2849 // -- either this OVF was written by vbox 3.2 or later, in which case there is a <vbox:Machine> element
2850 // in the <VirtualSystem>; then the VirtualSystemDescription::Data has a settings::MachineConfigFile
2851 // with all the machine config pretty-parsed;
2852 // -- or this is an OVF from an older vbox or an external source, and then we need to translate the
2853 // VirtualSystemDescriptionEntry and do import work
2854
2855 // Even for the vbox:Machine case, there are a number of configuration items that will be taken from
2856 // the OVF because otherwise the "override import parameters" mechanism in the GUI won't work.
2857
2858 // VM name
2859 std::list<VirtualSystemDescriptionEntry*> vsdeName = vsdescThis->findByType(VirtualSystemDescriptionType_Name);
2860 if (vsdeName.size() < 1)
2861 throw setError(VBOX_E_FILE_ERROR,
2862 tr("Missing VM name"));
2863 stack.strNameVBox = vsdeName.front()->strVboxCurrent;
2864
2865 // have VirtualBox suggest where the filename would be placed so we can
2866 // put the disk images in the same directory
2867 Bstr bstrMachineFilename;
2868 rc = mVirtualBox->ComposeMachineFilename(Bstr(stack.strNameVBox).raw(),
2869 NULL /* aGroup */,
2870 NULL /* aCreateFlags */,
2871 NULL /* aBaseFolder */,
2872 bstrMachineFilename.asOutParam());
2873 if (FAILED(rc)) throw rc;
2874 // and determine the machine folder from that
2875 stack.strMachineFolder = bstrMachineFilename;
2876 stack.strMachineFolder.stripFilename();
2877
2878 // guest OS type
2879 std::list<VirtualSystemDescriptionEntry*> vsdeOS;
2880 vsdeOS = vsdescThis->findByType(VirtualSystemDescriptionType_OS);
2881 if (vsdeOS.size() < 1)
2882 throw setError(VBOX_E_FILE_ERROR,
2883 tr("Missing guest OS type"));
2884 stack.strOsTypeVBox = vsdeOS.front()->strVboxCurrent;
2885
2886 // CPU count
2887 std::list<VirtualSystemDescriptionEntry*> vsdeCPU = vsdescThis->findByType(VirtualSystemDescriptionType_CPU);
2888 if (vsdeCPU.size() != 1)
2889 throw setError(VBOX_E_FILE_ERROR, tr("CPU count missing"));
2890
2891 stack.cCPUs = vsdeCPU.front()->strVboxCurrent.toUInt32();
2892 // We need HWVirt & IO-APIC if more than one CPU is requested
2893 if (stack.cCPUs > 1)
2894 {
2895 stack.fForceHWVirt = true;
2896 stack.fForceIOAPIC = true;
2897 }
2898
2899 // RAM
2900 std::list<VirtualSystemDescriptionEntry*> vsdeRAM = vsdescThis->findByType(VirtualSystemDescriptionType_Memory);
2901 if (vsdeRAM.size() != 1)
2902 throw setError(VBOX_E_FILE_ERROR, tr("RAM size missing"));
2903 stack.ulMemorySizeMB = (ULONG)vsdeRAM.front()->strVboxCurrent.toUInt64();
2904
2905#ifdef VBOX_WITH_USB
2906 // USB controller
2907 std::list<VirtualSystemDescriptionEntry*> vsdeUSBController = vsdescThis->findByType(VirtualSystemDescriptionType_USBController);
2908 // USB support is enabled if there's at least one such entry; to disable USB support,
2909 // the type of the USB item would have been changed to "ignore"
2910 stack.fUSBEnabled = vsdeUSBController.size() > 0;
2911#endif
2912 // audio adapter
2913 std::list<VirtualSystemDescriptionEntry*> vsdeAudioAdapter = vsdescThis->findByType(VirtualSystemDescriptionType_SoundCard);
2914 /* @todo: we support one audio adapter only */
2915 if (vsdeAudioAdapter.size() > 0)
2916 stack.strAudioAdapter = vsdeAudioAdapter.front()->strVboxCurrent;
2917
2918 // for the description of the new machine, always use the OVF entry, the user may have changed it in the import config
2919 std::list<VirtualSystemDescriptionEntry*> vsdeDescription = vsdescThis->findByType(VirtualSystemDescriptionType_Description);
2920 if (vsdeDescription.size())
2921 stack.strDescription = vsdeDescription.front()->strVboxCurrent;
2922
2923 // import vbox:machine or OVF now
2924 if (vsdescThis->m->pConfig)
2925 // vbox:Machine config
2926 importVBoxMachine(vsdescThis, pNewMachine, stack, pCallbacks, pStorage);
2927 else
2928 // generic OVF config
2929 importMachineGeneric(vsysThis, vsdescThis, pNewMachine, stack, pCallbacks, pStorage);
2930
2931 } // for (it = pAppliance->m->llVirtualSystems.begin() ...
2932}
2933
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette