ApplianceImplImport.cpp revision 7dacd16ae8d54957b120ee4168702f2e0321c0f5
/* $Id$ */
/** @file
*
* IAppliance and IVirtualSystem COM class implementations.
*/
/*
* Copyright (C) 2008-2010 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*/
#include <iprt/manifest.h>
#include "ApplianceImpl.h"
#include "VirtualBoxImpl.h"
#include "GuestOSTypeImpl.h"
#include "ProgressImpl.h"
#include "MachineImpl.h"
#include "MediumImpl.h"
#include "MediumFormatImpl.h"
#include "SystemPropertiesImpl.h"
#include "AutoCaller.h"
#include "Logging.h"
#include "ApplianceImplPrivate.h"
#include <VBox/settings.h>
using namespace std;
////////////////////////////////////////////////////////////////////////////////
//
// IAppliance public methods
//
////////////////////////////////////////////////////////////////////////////////
/**
* Public method implementation. This opens the OVF with ovfreader.cpp.
* Thread implementation is in Appliance::readImpl().
*
* @param path
* @return
*/
{
AutoCaller autoCaller(this);
if (!isApplianceIdle())
return E_ACCESSDENIED;
if (m->pReader)
{
delete m->pReader;
}
return setError(VBOX_E_FILE_ERROR,
tr("Appliance file must have .ovf extension"));
try
{
/* Parse all necessary info out of the URI */
}
{
}
/* Return progress to the caller */
return S_OK;
}
/**
* Public method implementation. This looks at the output of ovfreader.cpp and creates
* VirtualSystemDescription instances.
* @return
*/
{
// @todo:
// - don't use COM methods but the methods directly (faster, but needs appropriate locking of that objects itself (s. HardDisk))
// - Appropriate handle errors like not supported file formats
AutoCaller autoCaller(this);
if (!isApplianceIdle())
return E_ACCESSDENIED;
/* Clear any previous virtual system descriptions */
if (!m->pReader)
tr("Cannot interpret appliance without reading it first (call read() before interpret())"));
// Change the appliance state so we can safely leave the lock while doing time-consuming
// disk imports; also the below method calls do all kinds of locking which conflicts with
// the appliance object lock
try
{
/* Iterate through all virtual systems */
++it)
{
// if the virtual system in OVF had a <vbox:Machine> element, have the
// VirtualBox settings code parse that XML now
if (vsysThis.pelmVboxMachine)
// Guest OS type
// This is taken from one of three places, in this order:
// 1) If there is a <vbox:Machine>, then use the type from there.
if ( vsysThis.pelmVboxMachine
)
// 2) Otherwise, if there is OperatingSystemSection/vbox:OSType, use that one.
// 3) Otherwise, make a best guess what the vbox type is from the OVF (CIM) OS type.
else
"",
/* VM name */
/* If there is a <vbox:Machine>, we always prefer the setting from there. */
if ( vsysThis.pelmVboxMachine
else
/* If the there isn't any name specified create a default one out
* of the OS type */
"",
nameVBox);
/* Based on the VM name, create a target machine path. */
NULL,
/* Determine the machine folder from that */
/* VM Product */
"",
/* VM Vendor */
"",
/* VM Version */
"",
/* VM ProductUrl */
"",
/* VM VendorUrl */
"",
/* VM description */
"",
/* VM license */
"",
/* Now that we know the OS type, get our internal defaults based on that. */
/* CPU count */
/* If there is a <vbox:Machine>, we always prefer the setting from there. */
if ( vsysThis.pelmVboxMachine
else
/* Check for the constraints */
{
addWarning(tr("The virtual system \"%s\" claims support for %u CPU's, but VirtualBox has support for max %u CPU's only."),
}
cpuCountVBox = 1;
"",
/* RAM */
/* If there is a <vbox:Machine>, we always prefer the setting from there. */
if ( vsysThis.pelmVboxMachine
else
/* Check for the constraints */
if ( ullMemSizeVBox != 0
&& ( ullMemSizeVBox < MM_RAM_MIN_IN_MB
)
)
{
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."),
}
if (vsysThis.ullMemorySize == 0)
{
/* If the RAM of the OVF is zero, use our predefined values */
/* VBox stores that in MByte */
}
"",
/* Audio */
/* If there is a <vbox:Machine>, we always prefer the setting from there. */
if ( vsysThis.pelmVboxMachine
strSoundCard = Utf8StrFmt("%RU32", (uint32_t)pNewDesc->m->pConfig->hardwareMachine.audioAdapter.controllerType);
{
/* Set the AC97 always for the simple OVF case.
* @todo: figure out the hardware which could be possible */
}
if (strSoundCard.isNotEmpty())
"",
#ifdef VBOX_WITH_USB
/* USB Controller */
/* If there is a <vbox:Machine>, we always prefer the setting from there. */
if ( ( vsysThis.pelmVboxMachine
#endif /* VBOX_WITH_USB */
/* Network Controller */
/* If there is a <vbox:Machine>, we always prefer the setting from there. */
if (vsysThis.pelmVboxMachine)
{
const settings::NetworkAdaptersList &llNetworkAdapters = pNewDesc->m->pConfig->hardwareMachine.llNetworkAdapters;
/* Check for the constrains */
addWarning(tr("The virtual system \"%s\" claims support for %zu network adapters, but VirtualBox has support for max %u network adapter only."),
/* Iterate through all network adapters. */
size_t a = 0;
++it1, ++a)
{
{
"", // ref
strMode, // orig
0,
}
}
}
/* else we use the ovf configuration. */
{
/* Check for the constrains */
addWarning(tr("The virtual system \"%s\" claims support for %zu network adapters, but VirtualBox has support for max %u network adapter only."),
/* Get the default network adapter type for the selected guest OS */
/* Iterate through all abstract networks. We support 8 network
* adapters at the maximum, so the first 8 will be added only. */
size_t a = 0;
++itEA, ++a)
{
// make sure it's one of these two
)
/* Figure out the hardware type */
{
/* If the default adapter is already one of the two
* PCNet adapters use the default one. If not use the
* Am79C970A as fallback. */
if (!(defaultAdapterVBox == NetworkAdapterType_Am79C970A ||
}
#ifdef VBOX_WITH_E1000
/* VMWare accidentally write this with VirtualCenter 3.5,
so make sure in this case always to use the VMWare one */
{
/* Check if this OVF was written by VirtualBox */
{
/* If the default adapter is already one of the three
* E1000 adapters use the default one. If not use the
* I82545EM as fallback. */
if (!(defaultAdapterVBox == NetworkAdapterType_I82540EM ||
}
else
/* Always use this one since it's what VMware uses */
}
#endif /* VBOX_WITH_E1000 */
"", // ref
0,
}
}
/* If there is a <vbox:Machine>, we always prefer the setting from there. */
bool fFloppy = false;
bool fDVD = false;
if (vsysThis.pelmVboxMachine)
{
settings::StorageControllersList &llControllers = pNewDesc->m->pConfig->storageMachine.llStorageControllers;
++it3)
{
++it4)
{
break;
}
break;
}
}
else
{
}
/* Floppy Drive */
if (fFloppy)
/* CD Drive */
if (fDVD)
/* Hard disk Controller */
/* Iterate through all hard disk controllers */
++hdcIt)
{
{
/* Check for the constrains */
if (cIDEused < 4)
{
// @todo: figure out the IDE types
/* Use PIIX4 as default */
strType = "PIIX3";
strType = "ICH6";
strControllerID, // strRef
strType); // aVboxValue
}
else
/* Warn only once */
if (cIDEused == 2)
addWarning(tr("The virtual \"%s\" system requests support for more than two IDE controller channels, but VirtualBox supports only two."),
++cIDEused;
break;
/* Check for the constrains */
if (cSATAused < 1)
{
// @todo: figure out the SATA types
/* We only support a plain AHCI controller, so use them always */
"AHCI");
}
else
{
/* Warn only once */
if (cSATAused == 1)
addWarning(tr("The virtual system \"%s\" requests support for more than one SATA controller, but VirtualBox has support for only one"),
}
++cSATAused;
break;
/* Check for the constrains */
if (cSCSIused < 1)
{
{
// OVF considers SAS a variant of SCSI but VirtualBox considers it a class of its own
hdcController = "LsiLogicSas";
}
hdcController = "BusLogic";
}
else
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."),
strControllerID.c_str());
++cSCSIused;
break;
}
}
/* Hard disks */
{
/* Iterate through all hard disks ()*/
++itVD)
{
/* Get the associated disk image */
// @todo:
// - figure out all possible vmdk formats we also support
// - figure out if there is a url specifier for vhd already
// - we need a url specifier for the vdi format
if ( di.strFormat.compare("http://www.vmware.com/specifications/vmdk.html#sparse", Utf8Str::CaseInsensitive)
|| di.strFormat.compare("http://www.vmware.com/interfaces/specifications/vmdk.html#streamOptimized", Utf8Str::CaseInsensitive)
|| di.strFormat.compare("http://www.vmware.com/specifications/vmdk.html#compressed", Utf8Str::CaseInsensitive)
|| di.strFormat.compare("http://www.vmware.com/interfaces/specifications/vmdk.html#compressed", Utf8Str::CaseInsensitive)
)
{
/* If the href is empty use the VM name as filename */
if (!strFilename.length())
/* find the description for the hard disk controller
* that has the same ID as hd.idController */
tr("Cannot find hard disk controller with OVF instance ID %RI32 to which disk \"%s\" should be attached"),
/* controller to attach to, and the bus within that controller */
}
else
throw setError(VBOX_E_FILE_ERROR,
}
}
}
}
{
/* On error we clear the list & return */
}
// reset the appliance state
return rc;
}
/**
* Public method implementation. This creates one or more new machines according to the
* VirtualSystemScription instances created by Appliance::Interpret().
* Thread implementation is in Appliance::importImpl().
* @param aProgress
* @return
*/
{
AutoCaller autoCaller(this);
// do not allow entering this method if the appliance is busy reading or writing
if (!isApplianceIdle())
return E_ACCESSDENIED;
if (!m->pReader)
tr("Cannot import machines without reading it first (call read() before importMachines())"));
try
{
}
{
}
/* Return progress to the caller */
return rc;
}
////////////////////////////////////////////////////////////////////////////////
//
// Appliance private methods
//
////////////////////////////////////////////////////////////////////////////////
/*******************************************************************************
* Read stuff
******************************************************************************/
/**
* Implementation for reading an OVF. This starts a new thread which will call
* Appliance::taskThreadImportOrExport() which will then call readFS() or readS3().
* This will then open the OVF with ovfreader.cpp.
*
* This is in a separate private method because it is used from three locations:
*
* 1) from the public Appliance::Read().
*
* 2) in a second worker thread; in that case, Appliance::ImportMachines() called Appliance::importImpl(), which
* called Appliance::readFSOVA(), which called Appliance::importImpl(), which then called this again.
*
* 3) from Appliance::readS3(), which got called from a previous instance of Appliance::taskThreadImportOrExport().
*
* @param aLocInfo
* @param aProgress
* @return
*/
{
/* Create the progress object */
/* 1 operation only */
TRUE /* aCancelable */);
else
/* 4/5 is downloading, 1/5 is reading */
TRUE /* aCancelable */,
2, // ULONG cOperations,
5, // ULONG ulTotalOperationsWeight,
4); // ULONG ulFirstOperationWeight,
/* Initialize our worker task */
/* Don't destruct on success */
return rc;
}
/**
* Actual worker code for reading an OVF from disk. This is called from Appliance::taskThreadImportOrExport()
* and therefore runs on the OVF read worker thread. This opens the OVF with ovfreader.cpp.
*
* This runs in two contexts:
*
* 1) in a first worker thread; in that case, Appliance::Read() called Appliance::readImpl();
*
* 2) in a second worker thread; in that case, Appliance::Read() called Appliance::readImpl(), which
* called Appliance::readS3(), which called Appliance::readImpl(), which then called this.
*
* @param pTask
* @return
*/
{
LogFlowFunc(("Appliance %p\n", this));
AutoCaller autoCaller(this);
else
return rc;
}
{
do
{
if (!pSha1Callbacks)
{
rc = E_OUTOFMEMORY;
break;
}
if (!pFileCallbacks)
{
rc = E_OUTOFMEMORY;
break;
}
0, &storage.pVDImageIfaces);
if (RT_FAILURE(vrc))
{
break;
}
}while(0);
/* Cleanup */
if (pSha1Callbacks)
if (pFileCallbacks)
return rc;
}
{
int vrc = RTTarOpen(&tar, pTask->locInfo.strPath.c_str(), RTFILE_O_OPEN | RTFILE_O_READ | RTFILE_O_DENY_NONE, true);
if (RT_FAILURE(vrc))
return setError(VBOX_E_FILE_ERROR,
tr("Could not open OVA file '%s' (%Rrc)"),
do
{
if (!pSha1Callbacks)
{
rc = E_OUTOFMEMORY;
break;
}
if (!pTarCallbacks)
{
rc = E_OUTOFMEMORY;
break;
}
if (RT_FAILURE(vrc))
{
break;
}
}while(0);
/* Cleanup */
if (pSha1Callbacks)
if (pTarCallbacks)
return rc;
}
{
pStorage->fCreateDigest = true;
void *pvTmpBuf = 0;
try
{
/* Read the OVF into a memory buffer */
if ( RT_FAILURE(vrc)
|| !pvTmpBuf)
throw setError(VBOX_E_FILE_ERROR,
tr("Could not read OVF file '%s' (%Rrc)"),
/* Copy the SHA1 sum of the OVF file for later validation */
/* Read & parse the XML structure of the OVF file */
}
{
x.what());
}
{
}
/* Cleanup */
if (pvTmpBuf)
return rc;
}
#ifdef VBOX_WITH_S3
/**
* Worker code for reading OVF from the cloud. This is called from Appliance::taskThreadImportOrExport()
* in S3 mode and therefore runs on the OVF read worker thread. This then starts a second worker
* thread to create temporary files (see Appliance::readFS()).
*
* @param pTask
* @return
*/
{
LogFlowFunc(("Appliance %p\n", this));
AutoCaller autoCaller(this);
int vrc = VINF_SUCCESS;
char szOSTmpDir[RTPATH_MAX];
/* The template for the temporary directory created below */
try
{
/* Extract the bucket */
/* We need a temporary directory which we can put the OVF file & all
* disk images in */
if (RT_FAILURE(vrc))
throw setError(VBOX_E_FILE_ERROR,
/* The temporary name of the target OVF file */
/* Next we have to download the OVF */
vrc = RTS3Create(&hS3, pTask->locInfo.strUsername.c_str(), pTask->locInfo.strPassword.c_str(), pTask->locInfo.strHostname.c_str(), "virtualbox-agent/"VBOX_VERSION_STRING);
if (RT_FAILURE(vrc))
throw setError(VBOX_E_IPRT_ERROR,
tr("Cannot create S3 service handler"));
/* Get it */
if (RT_FAILURE(vrc))
{
if (vrc == VERR_S3_CANCELED)
throw S_OK; /* todo: !!!!!!!!!!!!! */
else if (vrc == VERR_S3_ACCESS_DENIED)
throw setError(E_ACCESSDENIED,
tr("Cannot download file '%s' from S3 storage server (Access denied). Make sure that your credentials are right."
"Also check that your host clock is properly synced"),
else if (vrc == VERR_S3_NOT_FOUND)
throw setError(VBOX_E_FILE_ERROR,
else
throw setError(VBOX_E_IPRT_ERROR,
}
/* Close the connection early */
/* Prepare the temporary reading of the OVF */
/* Start the reading from the fs */
/* Unlock the appliance for the reading thread */
/* Wait until the reading is done, but report the progress back to the
caller */
/* Again lock the appliance for the next steps */
}
{
}
/* Cleanup */
/* Delete all files which where temporary created */
{
if (RT_FAILURE(vrc))
}
/* Delete the temporary directory */
if (RTPathExists(pszTmpDir))
{
if (RT_FAILURE(vrc))
}
if (pszTmpDir)
return rc;
}
#endif /* VBOX_WITH_S3 */
/*******************************************************************************
* Import stuff
******************************************************************************/
/**
* Implementation for importing OVF data into VirtualBox. This starts a new thread which will call
* Appliance::taskThreadImportOrExport().
*
* This creates one or more new machines according to the VirtualSystemScription instances created by
* Appliance::Interpret().
*
* This is in a separate private method because it is used from two locations:
*
* 1) from the public Appliance::ImportMachines().
* 2) from Appliance::importS3(), which got called from a previous instance of Appliance::taskThreadImportOrExport().
*
* @param aLocInfo
* @param aProgress
* @return
*/
{
mode = ImportFile;
else
mode);
/* Initialize our worker task */
/* Don't destruct on success */
return rc;
}
/**
* Actual worker code for importing OVF data into VirtualBox. This is called from Appliance::taskThreadImportOrExport()
* and therefore runs on the OVF import worker thread. This creates one or more new machines according to the
* VirtualSystemScription instances created by Appliance::Interpret().
*
* This runs in three contexts:
*
* 1) in a first worker thread; in that case, Appliance::ImportMachines() called Appliance::importImpl();
*
* 2) in a second worker thread; in that case, Appliance::ImportMachines() called Appliance::importImpl(), which
* called Appliance::importFSOVA(), which called Appliance::importImpl(), which then called this again.
*
* 3) in a second worker thread; in that case, Appliance::ImportMachines() called Appliance::importImpl(), which
* called Appliance::importS3(), which called Appliance::importImpl(), which then called this again.
*
* @param pTask
* @return
*/
{
LogFlowFunc(("Appliance %p\n", this));
AutoCaller autoCaller(this);
/* Change the appliance state so we can safely leave the lock while doing
* time-consuming disk imports; also the below method calls do all kinds of
* locking which conflicts with the appliance object lock. */
/* Check if the appliance is currently busy. */
if (!isApplianceIdle())
return E_ACCESSDENIED;
/* Set the internal state to importing. */
/* Clear the list of imported machines, if any */
m->llGuidsMachinesCreated.clear();
else
{
/* With _whatever_ error we've had, do a complete roll-back of
* machines and disks we've created */
++itID)
{
{
rc2 = failedMachine->Unregister(CleanupMode_DetachAllReturnHardDisksOnly, ComSafeArrayAsOutParam(aMedia));
}
}
}
/* Reset the state so others can call methods again */
return rc;
}
{
void *pvMfBuf = 0;
try
{
/* Create the necessary file access interfaces. */
if (!pSha1Callbacks)
throw E_OUTOFMEMORY;
if (!pFileCallbacks)
throw E_OUTOFMEMORY;
storage.fCreateDigest = true;
0, &storage.pVDImageIfaces);
if (RT_FAILURE(vrc))
throw E_FAIL;
/* Create the import stack for the rollback on errors. */
/* Do we need the digest information? */
/* Now import the appliance. */
/* Read & verify the manifest file, if there is one. */
if (storage.fCreateDigest)
{
/* Add the ovf file to the digest list. */
}
}
{
}
/* Cleanup */
if (pvMfBuf)
if (pSha1Callbacks)
if (pFileCallbacks)
return rc;
}
{
int vrc = RTTarOpen(&tar, pTask->locInfo.strPath.c_str(), RTFILE_O_OPEN | RTFILE_O_READ | RTFILE_O_DENY_NONE, true);
if (RT_FAILURE(vrc))
return setError(VBOX_E_FILE_ERROR,
tr("Could not open OVA file '%s' (%Rrc)"),
void *pvMfBuf = 0;
try
{
/* Create the necessary file access interfaces. */
if (!pSha1Callbacks)
throw E_OUTOFMEMORY;
if (!pTarCallbacks)
throw E_OUTOFMEMORY;
if (RT_FAILURE(vrc))
/* Skip the OVF file, cause this was read in IAppliance::Read already. */
if ( RT_FAILURE(vrc)
&& vrc != VERR_TAR_END_OF_FILE)
/* We always need to create the digest, cause we didn't know if there
* is a manifest file in the stream. */
pStorage->fCreateDigest = true;
/* Create the import stack for the rollback on errors. */
/*
* Try to read the manifest file. First try.
*
* Note: This isn't fatal if the file is not found. The standard
* defines 3 cases.
* 1. no manifest file
* 2. manifest file after the OVF file
* 3. manifest file after all disk files
* If we want streaming capabilities, we can't check if it is there by
* searching for it. We have to try to open it on all possible places.
* If it fails here, we will try it again after all disks where read.
*/
/* Now import the appliance. */
/* Try to read the manifest file. Second try. */
if (!pvMfBuf)
{
}
/* If we were able to read a manifest file we can check it now. */
if (pvMfBuf)
{
/* Add the ovf file to the digest list. */
stack.llSrcDisksDigest.push_front(STRPAIR(Utf8Str(pTask->locInfo.strPath).stripExt().append(".ovf"), m->strOVFSHA1Digest));
}
}
{
}
/* Cleanup */
if (pvMfBuf)
if (pSha1Callbacks)
if (pTarCallbacks)
return rc;
}
#ifdef VBOX_WITH_S3
/**
* Worker code for importing OVF from the cloud. This is called from Appliance::taskThreadImportOrExport()
* in S3 mode and therefore runs on the OVF import worker thread. This then starts a second worker
* thread to import from temporary files (see Appliance::importFS()).
* @param pTask
* @return
*/
{
LogFlowFunc(("Appliance %p\n", this));
AutoCaller autoCaller(this);
int vrc = VINF_SUCCESS;
char szOSTmpDir[RTPATH_MAX];
/* The template for the temporary directory created below */
try
{
/* Extract the bucket */
/* We need a temporary directory which we can put the all disk images
* in */
if (RT_FAILURE(vrc))
throw setError(VBOX_E_FILE_ERROR,
/* Add every disks of every virtual system to an internal list */
++it)
{
std::list<VirtualSystemDescriptionEntry*> avsdeHDs = vsdescThis->findByType(VirtualSystemDescriptionType_HardDiskImage);
++itH)
{
if (!strTargetFile.isEmpty())
{
/* The temporary name of the target disk file */
}
}
}
/* Next we have to download the disk images */
vrc = RTS3Create(&hS3, pTask->locInfo.strUsername.c_str(), pTask->locInfo.strPassword.c_str(), pTask->locInfo.strHostname.c_str(), "virtualbox-agent/"VBOX_VERSION_STRING);
if (RT_FAILURE(vrc))
throw setError(VBOX_E_IPRT_ERROR,
tr("Cannot create S3 service handler"));
/* Download all files */
for (list< pair<Utf8Str, ULONG> >::const_iterator it1 = filesList.begin(); it1 != filesList.end(); ++it1)
{
/* Construct the source file name */
/* Advance to the next operation */
pTask->pProgress->SetNextOperation(BstrFmt(tr("Downloading file '%s'"), pszFilename).raw(), s.second);
if (RT_FAILURE(vrc))
{
if (vrc == VERR_S3_CANCELED)
throw S_OK; /* todo: !!!!!!!!!!!!! */
else if (vrc == VERR_S3_ACCESS_DENIED)
throw setError(E_ACCESSDENIED,
tr("Cannot download file '%s' from S3 storage server (Access denied). "
"Make sure that your credentials are right. Also check that your host clock is properly synced"),
else if (vrc == VERR_S3_NOT_FOUND)
throw setError(VBOX_E_FILE_ERROR,
tr("Cannot download file '%s' from S3 storage server (File not found)"),
else
throw setError(VBOX_E_IPRT_ERROR,
tr("Cannot download file '%s' from S3 storage server (%Rrc)"),
pszFilename, vrc);
}
}
/* Provide a OVF file (haven't to exist) so the import routine can
/* Now check if there is an manifest file. This is optional. */
// Utf8Str strManifestFile = queryManifestFileName(strTmpOvf);
/* Try to download it. If the error is VERR_S3_NOT_FOUND, it isn't fatal. */
if (RT_SUCCESS(vrc))
else if (RT_FAILURE(vrc))
{
if (vrc == VERR_S3_CANCELED)
throw S_OK; /* todo: !!!!!!!!!!!!! */
else if (vrc == VERR_S3_NOT_FOUND)
else if (vrc == VERR_S3_ACCESS_DENIED)
throw setError(E_ACCESSDENIED,
tr("Cannot download file '%s' from S3 storage server (Access denied)."
"Make sure that your credentials are right. Also check that your host clock is properly synced"),
else
throw setError(VBOX_E_IPRT_ERROR,
tr("Cannot download file '%s' from S3 storage server (%Rrc)"),
pszFilename, vrc);
}
/* Close the connection early */
pTask->pProgress->SetNextOperation(BstrFmt(tr("Importing appliance")).raw(), m->ulWeightForXmlOperation);
/* Import the whole temporary OVF & the disk images */
/* Unlock the appliance for the fs import thread */
/* Wait until the import is done, but report the progress back to the
caller */
/* Again lock the appliance for the next steps */
}
{
}
/* Cleanup */
/* Delete all files which where temporary created */
for (list< pair<Utf8Str, ULONG> >::const_iterator it1 = filesList.begin(); it1 != filesList.end(); ++it1)
{
if (RTPathExists(pszFilePath))
{
if (RT_FAILURE(vrc))
}
}
/* Delete the temporary directory */
if (RTPathExists(pszTmpDir))
{
if (RT_FAILURE(vrc))
}
if (pszTmpDir)
return rc;
}
#endif /* VBOX_WITH_S3 */
HRESULT Appliance::readManifestFile(const Utf8Str &strFile, void **ppvBuf, size_t *pcbSize, PVDINTERFACEIO pCallbacks, PSHA1STORAGE pStorage)
{
if ( RT_FAILURE(vrc)
&& vrc != VERR_FILE_NOT_FOUND)
tr("Could not read manifest file '%s' (%Rrc)"),
return rc;
}
HRESULT Appliance::readTarManifestFile(RTTAR tar, const Utf8Str &strFile, void **ppvBuf, size_t *pcbSize, PVDINTERFACEIO pCallbacks, PSHA1STORAGE pStorage)
{
char *pszCurFile;
if (RT_SUCCESS(vrc))
{
}
else if (vrc != VERR_TAR_END_OF_FILE)
return rc;
}
HRESULT Appliance::verifyManifestFile(const Utf8Str &strFile, ImportStack &stack, void *pvBuf, size_t cbSize)
{
PRTMANIFESTTEST paTests = (PRTMANIFESTTEST)RTMemAlloc(sizeof(RTMANIFESTTEST) * stack.llSrcDisksDigest.size());
if (!paTests)
return E_OUTOFMEMORY;
size_t i = 0;
++it1, ++i)
{
}
int vrc = RTManifestVerifyFilesBuf(pvBuf, cbSize, paTests, stack.llSrcDisksDigest.size(), &iFailed);
tr("The SHA1 digest of '%s' does not match the one in '%s' (%Rrc)"),
else if (RT_FAILURE(vrc))
tr("Could not verify the content of '%s' against the available files (%Rrc)"),
return rc;
}
/**
* Helper that converts VirtualSystem attachment values into VirtualBox attachment values.
* Throws HRESULT values on errors!
*
* @param hdc in: the HardDiskController structure to attach to.
* @param ulAddressOnParent in: the AddressOnParent parameter from OVF.
* @param controllerType out: the name of the hard disk controller to attach to (e.g. "IDE Controller").
* @param lControllerPort out: the channel (controller port) of the controller to attach to.
* @param lDevice out: the device number to attach to.
*/
{
Log(("Appliance::convertDiskAttachmentValues: hdc.system=%d, hdc.fPrimary=%d, ulAddressOnParent=%d\n", hdc.system, hdc.fPrimary, ulAddressOnParent));
{
// For the IDE bus, the port parameter can be either 0 or 1, to specify the primary
// or secondary IDE controller, respectively. For the primary controller of the IDE bus,
// the device number can be either 0 or 1, to specify the master or the slave device,
// respectively. For the secondary IDE controller, the device number is always 1 because
// the master device is reserved for the CD-ROM drive.
switch (ulAddressOnParent)
{
case 0: // master
{
// secondary master
lControllerPort = (long)1;
lDevice = (long)0;
}
else // primary master
{
lControllerPort = (long)0;
lDevice = (long)0;
}
break;
case 1: // slave
{
// secondary slave
lControllerPort = (long)1;
lDevice = (long)1;
}
else // primary slave
{
lControllerPort = (long)0;
lDevice = (long)1;
}
break;
// used by older VBox exports
case 2: // interpret this as secondary master
lControllerPort = (long)1;
lDevice = (long)0;
break;
// used by older VBox exports
case 3: // interpret this as secondary slave
lControllerPort = (long)1;
lDevice = (long)1;
break;
default:
throw setError(VBOX_E_NOT_SUPPORTED,
tr("Invalid channel %RI16 specified; IDE controllers support only 0, 1 or 2"),
break;
}
break;
lControllerPort = (long)ulAddressOnParent;
lDevice = (long)0;
break;
lControllerPort = (long)ulAddressOnParent;
lDevice = (long)0;
break;
default: break;
}
}
/**
* Imports one disk image. This is common code shared between
* -- importMachineGeneric() for the OVF case; in that case the information comes from
* the OVF virtual systems;
* -- importVBoxMachine(); in that case, the information comes from the <vbox:Machine>
* tag.
*
* Both ways of describing machines use the OVF disk references section, so in both cases
* the caller needs to pass in the ovf::DiskImage structure from ovfreader.cpp.
*
* As a result, in both cases, if di.strHref is empty, we create a new disk as per the OVF
* spec, even though this cannot really happen in the vbox:Machine case since such data
* would never have been exported.
*
* This advances stack.pProgress by one operation with the disk's weight.
*
* @param di ovfreader.cpp structure describing the disk image from the OVF that is to be imported
* @param ulSizeMB Size of the disk image (for progress reporting)
* @param strTargetPath Where to create the target image.
* @param pTargetHD out: The newly created target disk. This also gets pushed on stack.llHardDisksCreated for cleanup.
* @param stack
*/
const Utf8Str &strTargetPath,
{
HRESULT rc = pProgress->init(mVirtualBox, static_cast<IAppliance*>(this), BstrFmt(tr("Creating medium '%s'"), strTargetPath.c_str()).raw(), TRUE);
/* Get the system properties. */
/* First of all check if the path is an UUID. If so, the user like to
* import the disk into an existing path. This is useful for iSCSI for
* example. */
if (vrc == VINF_SUCCESS)
{
}
else
{
{
/* Figure out which format the user like to have. Default is VMDK. */
throw setError(VBOX_E_NOT_SUPPORTED,
tr("Could not find a valid medium format for the target disk '%s'"),
strTargetPath.c_str());
/* Check the capabilities. We need create capabilities. */
throw setError(VBOX_E_NOT_SUPPORTED,
tr("Could not find a valid medium format for the target disk '%s'"),
strTargetPath.c_str());
}
/* Create an IMedium object. */
NULL /* llRegistriesThatNeedSaving */);
/* Now create an empty hard disk. */
}
/* Construct source file path */
Utf8StrFmt strSrcFilePath("%s%c%s", stack.strSourceDir.c_str(), RTPATH_DELIMITER, strSourceOVF.c_str());
/* If strHref is empty we have to create a new file. */
if (strSourceOVF.isEmpty())
{
/* Create a dynamic growing disk image with the given capacity. */
rc = pTargetHD->CreateBaseStorage(di.iCapacity / _1M, MediumVariant_Standard, ComPtr<IProgress>(pProgress).asOutParam());
/* Advance to the next operation. */
stack.pProgress->SetNextOperation(BstrFmt(tr("Creating disk image '%s'"), strTargetPath.c_str()).raw(),
}
else
{
/* We need a proper source format description */
/* Which format to use? */
if ( di.strFormat.compare("http://www.vmware.com/specifications/vmdk.html#sparse", Utf8Str::CaseInsensitive)
|| di.strFormat.compare("http://www.vmware.com/interfaces/specifications/vmdk.html#streamOptimized", Utf8Str::CaseInsensitive)
|| di.strFormat.compare("http://www.vmware.com/specifications/vmdk.html#compressed", Utf8Str::CaseInsensitive)
|| di.strFormat.compare("http://www.vmware.com/interfaces/specifications/vmdk.html#compressed", Utf8Str::CaseInsensitive)
)
strSrcFormat = "VMDK";
throw setError(VBOX_E_NOT_SUPPORTED,
tr("Could not find a valid medium format for the source disk '%s'"),
/* Clone the source disk image */
/* Advance to the next operation. */
stack.pProgress->SetNextOperation(BstrFmt(tr("Importing virtual disk image '%s'"), RTPathFilename(strSrcFilePath.c_str())).raw(),
}
/* Now wait for the background disk operation to complete; this throws
* HRESULTs on error. */
/* Add the newly create disk path + a corresponding digest the our list for
* later manifest verification. */
}
/**
* Imports one OVF virtual system (described by the given ovf::VirtualSystem and VirtualSystemDescription)
* into VirtualBox by creating an IMachine instance, which is returned.
*
* This throws HRESULT error codes for anything that goes wrong, in which case the caller must clean
* up any leftovers from this function. For this, the given ImportStack instance has received information
* about what needs cleaning up (to support rollback).
*
* @param vsysThis OVF virtual system (machine) to import.
* @param vsdescThis Matching virtual system description (machine) to import.
* @param pNewMachine out: Newly created machine.
* @param stack Cleanup stack for when this throws.
*/
{
// Get the instance of IGuestOSType which matches our string guest OS type so we
// can use recommended defaults for the new machine where OVF doesn't provide any
/* Create the machine */
NULL, /* uuid */
FALSE, /* fForceOverwrite */
// set the description
{
}
// CPU count
if (stack.fForceHWVirt)
{
}
// RAM
/* VRAM */
/* Get the recommended VRAM for this guest OS type */
/* Set the VRAM */
// I/O APIC: Generic OVF has no setting for this. Enable it if we
// import a Windows VM because if if Windows was installed without IOAPIC,
// it will not mind finding an one later on, but if Windows was installed
// _with_ an IOAPIC, it will bluescreen if it's not found
if (!stack.fForceIOAPIC)
{
if (bstrFamilyId == "Windows")
stack.fForceIOAPIC = true;
}
if (stack.fForceIOAPIC)
{
}
{
}
#ifdef VBOX_WITH_USB
/* USB Controller */
#endif /* VBOX_WITH_USB */
/* Change the network adapters */
std::list<VirtualSystemDescriptionEntry*> vsdeNW = vsdescThis->findByType(VirtualSystemDescriptionType_NetworkAdapter);
{
/* No network adapters, so we have to disable our default one */
}
throw setError(VBOX_E_FILE_ERROR,
tr("Too many network adapters: OVF requests %d network adapters, but VirtualBox only supports %d"),
else
{
size_t a = 0;
++nwIt, ++a)
{
/* Enable the network card & set the adapter type */
// default is NAT; change to "bridged" if extra conf says so
{
/* Attach to the right interface */
// We search for the first host network interface which
// is usable for bridged networking
for (size_t j = 0;
j < nwInterfaces.size();
++j)
{
{
/* Set the interface name to attach to */
break;
}
}
}
/* Next test for host only interfaces */
{
/* Attach to the right interface */
// We search for the first host network interface which
// is usable for host only networking
for (size_t j = 0;
j < nwInterfaces.size();
++j)
{
{
/* Set the interface name to attach to */
break;
}
}
}
/* Next test for internal interfaces */
{
/* Attach to the right interface */
}
/* Next test for VDE interfaces */
{
/* Attach to the right interface */
}
}
}
// IDE Hard disk controller
std::list<VirtualSystemDescriptionEntry*> vsdeHDCIDE = vsdescThis->findByType(VirtualSystemDescriptionType_HardDiskControllerIDE);
// In OVF (at least VMware's version of it), an IDE controller has two ports, so VirtualBox's single IDE controller
// with two channels and two ports each counts as two OVF IDE controllers -- so we accept one or two such IDE controllers
if (cIDEControllers > 2)
throw setError(VBOX_E_FILE_ERROR,
tr("Too many IDE controllers in OVF; import facility only supports two"));
if (vsdeHDCIDE.size() > 0)
{
// one or two IDE controllers present in OVF: add one VirtualBox controller
rc = pNewMachine->AddStorageController(Bstr("IDE Controller").raw(), StorageBus_IDE, pController.asOutParam());
else
throw setError(VBOX_E_FILE_ERROR,
tr("Invalid IDE controller type \"%s\""),
}
/* Hard disk controller SATA */
std::list<VirtualSystemDescriptionEntry*> vsdeHDCSATA = vsdescThis->findByType(VirtualSystemDescriptionType_HardDiskControllerSATA);
throw setError(VBOX_E_FILE_ERROR,
tr("Too many SATA controllers in OVF; import facility only supports one"));
if (vsdeHDCSATA.size() > 0)
{
if (hdcVBox == "AHCI")
{
rc = pNewMachine->AddStorageController(Bstr("SATA Controller").raw(), StorageBus_SATA, pController.asOutParam());
}
else
throw setError(VBOX_E_FILE_ERROR,
tr("Invalid SATA controller type \"%s\""),
}
/* Hard disk controller SCSI */
std::list<VirtualSystemDescriptionEntry*> vsdeHDCSCSI = vsdescThis->findByType(VirtualSystemDescriptionType_HardDiskControllerSCSI);
throw setError(VBOX_E_FILE_ERROR,
tr("Too many SCSI controllers in OVF; import facility only supports one"));
if (vsdeHDCSCSI.size() > 0)
{
if (hdcVBox == "LsiLogic")
else if (hdcVBox == "LsiLogicSas")
{
// OVF treats LsiLogicSas as a SCSI controller but VBox considers it a class of its own
bstrName = L"SAS Controller";
}
else if (hdcVBox == "BusLogic")
else
throw setError(VBOX_E_FILE_ERROR,
tr("Invalid SCSI controller type \"%s\""),
}
/* Hard disk controller SAS */
std::list<VirtualSystemDescriptionEntry*> vsdeHDCSAS = vsdescThis->findByType(VirtualSystemDescriptionType_HardDiskControllerSAS);
throw setError(VBOX_E_FILE_ERROR,
tr("Too many SAS controllers in OVF; import facility only supports one"));
if (vsdeHDCSAS.size() > 0)
{
rc = pNewMachine->AddStorageController(Bstr(L"SAS Controller").raw(), StorageBus_SAS, pController.asOutParam());
}
/* Now its time to register the machine before we add any hard disks */
// store new machine for roll-back in case of errors
// Add floppies and CD-ROMs to the appropriate controllers.
std::list<VirtualSystemDescriptionEntry*> vsdeFloppy = vsdescThis->findByType(VirtualSystemDescriptionType_Floppy);
throw setError(VBOX_E_FILE_ERROR,
tr("Too many floppy controllers in OVF; import facility only supports one"));
std::list<VirtualSystemDescriptionEntry*> vsdeCDROM = vsdescThis->findByType(VirtualSystemDescriptionType_CDROM);
if ( (vsdeFloppy.size() > 0)
)
{
// If there's an error here we need to close the session, so
try
{
// to attach things we need to open a session for the new machine
stack.fSessionOpen = true;
// floppy first
{
rc = sMachine->AddStorageController(Bstr("Floppy Controller").raw(), StorageBus_Floppy, pController.asOutParam());
// this is for rollback later
mhda.lControllerPort = 0;
Log(("Attaching floppy\n"));
NULL);
}
// CD-ROMs next
++jt)
{
// for now always attach to secondary master on IDE controller;
// there seems to be no useful information in OVF where else to
// attach it (@todo test with latest versions of OVF software)
// find the IDE controller
++kt)
{
{
break;
}
}
if (!pController)
throw setError(VBOX_E_FILE_ERROR,
tr("OVF wants a CD-ROM drive but cannot find IDE controller, which is required in this version of VirtualBox"));
// this is for rollback later
2, // interpreted as secondary master
NULL);
} // end for (itHD = avsdeHDs.begin();
// only now that we're done with all disks, close the session
stack.fSessionOpen = false;
}
catch(HRESULT /* aRC */)
{
if (stack.fSessionOpen)
throw;
}
}
// create the hard disks & connect them to the appropriate controllers
std::list<VirtualSystemDescriptionEntry*> avsdeHDs = vsdescThis->findByType(VirtualSystemDescriptionType_HardDiskImage);
{
// If there's an error here we need to close the session, so
try
{
// to attach things we need to open a session for the new machine
stack.fSessionOpen = true;
/* Iterate over all given disk images */
++itHD)
{
// vsdeHD->strRef contains the disk identifier (e.g. "vmdisk1"), which should exist
// in the virtual system's disks map under that ID and also in the global images map
// and find the disk from the OVF's disk list
)
tr("Internal inconsistency looking up disk image '%s'"),
pStorage);
// now use the new uuid to attach the disk image to our new machine
// find the hard disk controller to which we should attach
// this is for rollback later
Log(("Attaching disk %s to port %d on device %d\n", vsdeHD->strVboxCurrent.c_str(), mhda.lControllerPort, mhda.lDevice));
DeviceType_HardDisk, // DeviceType_T type
} // end for (itHD = avsdeHDs.begin();
// only now that we're done with all disks, close the session
stack.fSessionOpen = false;
}
catch(HRESULT /* aRC */)
{
if (stack.fSessionOpen)
throw;
}
}
}
/**
* Imports one OVF virtual system (described by a vbox:Machine tag represented by the given config
* structure) into VirtualBox by creating an IMachine instance, which is returned.
*
* This throws HRESULT error codes for anything that goes wrong, in which case the caller must clean
* up any leftovers from this function. For this, the given ImportStack instance has received information
* about what needs cleaning up (to support rollback).
*
* The machine config stored in the settings::MachineConfigFile structure contains the UUIDs of
* the disk attachments used by the machine when it was exported. We also add vbox:uuid attributes
* to the OVF disks sections so we can look them up. While importing these UUIDs into a second host
* will most probably work, reimporting them into the same host will cause conflicts, so we always
* generate new ones on import. This involves the following:
*
* 1) Scan the machine config for disk attachments.
*
* 2) For each disk attachment found, look up the OVF disk image from the disk references section
* and import the disk into VirtualBox, which creates a new UUID for it. In the machine config,
* replace the old UUID with the new one.
*
* 3) Change the machine config according to the OVF virtual system descriptions, in case the
* caller has modified them using setFinalValues().
*
* 4) Create the VirtualBox machine with the modfified machine config.
*
* @param config
* @param pNewMachine
* @param stack
*/
{
/*
*
* step 1): modify machine config according to OVF config, in case the user
* has modified them using setFinalValues()
*
*/
/* OS Type */
/* Description */
/* CPU count & extented attributes */
if (stack.fForceIOAPIC)
if (stack.fForceIOAPIC)
/* RAM size */
/*
<const name="HardDiskControllerIDE" value="14" />
<const name="HardDiskControllerSATA" value="15" />
<const name="HardDiskControllerSCSI" value="16" />
<const name="HardDiskControllerSAS" value="17" />
*/
#ifdef VBOX_WITH_USB
/* USB controller */
#endif
/* Audio adapter */
{
config.hardwareMachine.audioAdapter.controllerType = (AudioControllerType_T)stack.strAudioAdapter.toUInt32();
}
else
/* Network adapter */
/* First disable all network cards, they will be enabled below again. */
/* Now iterate over all network entries. */
std::list<VirtualSystemDescriptionEntry*> avsdeNWs = vsdescThis->findByType(VirtualSystemDescriptionType_NetworkAdapter);
{
/* Iterate through all network adapter entries and search for the
* corrosponding one in the machine config. If one is found, configure
* it based on the user settings. */
++itNW)
{
{
/* Iterate through all network adapters in the machine config. */
++it1)
{
/* Compare the slots. */
{
break;
}
}
}
}
}
/* Floppy controller */
/* DVD controller */
/* Iterate over all storage controller check the attachments and remove
* them when necessary. */
++it3)
{
++it4)
{
if ( ( !fDVD
||
( !fFloppy
}
}
/*
*
* step 2: scan the machine config for media attachments
*
*/
// for each storage controller...
for (settings::StorageControllersList::iterator sit = config.storageMachine.llStorageControllers.begin();
++sit)
{
// find the OVF virtual system description entry for this storage controller
switch (sc.storageBus)
{
case StorageBus_SATA:
break;
case StorageBus_SCSI:
break;
case StorageBus_IDE:
break;
case StorageBus_SAS:
break;
}
/* Get all hard disk descriptions. */
std::list<VirtualSystemDescriptionEntry*> avsdeHDs = vsdescThis->findByType(VirtualSystemDescriptionType_HardDiskImage);
// for each medium attachment to this controller...
++dit)
{
// empty DVD and floppy media
continue;
// convert the Guid to string
// there must be an image in the OVF disk structs with the same UUID
bool fFound = false;
++oit)
{
{
/* Iterate over all given disk images of the virtual system
* disks description. We need to find the target disk path,
* which could be changed by the user. */
++itHD)
{
{
break;
}
}
if (!vsdeTargetHD)
tr("Internal inconsistency looking up disk image '%s'"),
/*
*
* step 3: import disk
*
*/
pStorage);
// ... and replace the old UUID in the machine config with the one of
// the imported disk that was just created
fFound = true;
break;
}
}
// no disk with such a UUID found:
if (!fFound)
tr("<vbox:Machine> element in OVF contains a medium attachment for the disk image %s but the OVF describes no such image"),
} // for (settings::AttachedDevicesList::const_iterator dit = sc.llAttachedDevices.begin();
} // for (settings::StorageControllersList::const_iterator sit = config.storageMachine.llStorageControllers.begin();
/*
*
* step 4): create the machine and have it import the config
*
*/
// this magic constructor fills the new machine object with the MachineConfig
// instance that we created from the vbox:Machine
stack.strNameVBox, // name from OVF preparations; can be suffixed to avoid duplicates, or changed by user
config); // the whole machine config
// and register it
// store new machine for roll-back in case of errors
}
{
// this is safe to access because this thread only gets started
// if pReader != NULL
// create a session for the machine + disks we manipulate below
/* Iterate through all virtual systems of that appliance */
size_t i = 0;
{
// there are two ways in which we can create a vbox machine from OVF:
// -- either this OVF was written by vbox 3.2 or later, in which case there is a <vbox:Machine> element
// in the <VirtualSystem>; then the VirtualSystemDescription::Data has a settings::MachineConfigFile
// with all the machine config pretty-parsed;
// -- or this is an OVF from an older vbox or an external source, and then we need to translate the
// VirtualSystemDescriptionEntry and do import work
// Even for the vbox:Machine case, there are a number of configuration items that will be taken from
// the OVF because otherwise the "override import parameters" mechanism in the GUI won't work.
// VM name
std::list<VirtualSystemDescriptionEntry*> vsdeName = vsdescThis->findByType(VirtualSystemDescriptionType_Name);
throw setError(VBOX_E_FILE_ERROR,
tr("Missing VM name"));
// have VirtualBox suggest where the filename would be placed so we can
// put the disk images in the same directory
NULL,
// and determine the machine folder from that
// guest OS type
throw setError(VBOX_E_FILE_ERROR,
tr("Missing guest OS type"));
// CPU count
std::list<VirtualSystemDescriptionEntry*> vsdeCPU = vsdescThis->findByType(VirtualSystemDescriptionType_CPU);
// We need HWVirt & IO-APIC if more than one CPU is requested
{
stack.fForceHWVirt = true;
stack.fForceIOAPIC = true;
}
// RAM
std::list<VirtualSystemDescriptionEntry*> vsdeRAM = vsdescThis->findByType(VirtualSystemDescriptionType_Memory);
#ifdef VBOX_WITH_USB
// USB controller
std::list<VirtualSystemDescriptionEntry*> vsdeUSBController = vsdescThis->findByType(VirtualSystemDescriptionType_USBController);
// USB support is enabled if there's at least one such entry; to disable USB support,
// the type of the USB item would have been changed to "ignore"
#endif
// audio adapter
std::list<VirtualSystemDescriptionEntry*> vsdeAudioAdapter = vsdescThis->findByType(VirtualSystemDescriptionType_SoundCard);
/* @todo: we support one audio adapter only */
if (vsdeAudioAdapter.size() > 0)
// for the description of the new machine, always use the OVF entry, the user may have changed it in the import config
std::list<VirtualSystemDescriptionEntry*> vsdeDescription = vsdescThis->findByType(VirtualSystemDescriptionType_Description);
if (vsdeDescription.size())
// import vbox:machine or OVF now
if (vsdescThis->m->pConfig)
// vbox:Machine config
else
// generic OVF config
} // for (it = pAppliance->m->llVirtualSystems.begin() ...
}