VirtualBox

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

Last change on this file since 37989 was 37862, checked in by vboxsync, 13 years ago

Main-OVF;FE/*: allow to specify if MAC addresses should be reinitialized on OVF/OVA import

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