ovfreader.h@ 96910

Last change on this file since 96910 was 96407, checked in by vboxsync, 2 years ago
scm copyright and license note update
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 26.2 KB

Line
1	/* $Id: ovfreader.h 96407 2022-08-22 17:43:14Z vboxsync $ */
2	/** @file
3	* VirtualBox Main - OVF reader declarations.
4	*
5	* Depends only on IPRT, including the RTCString and IPRT XML classes.
6	*/
7
8	/*
9	* Copyright (C) 2008-2022 Oracle and/or its affiliates.
10	*
11	* This file is part of VirtualBox base platform packages, as
12	* available from https://www.virtualbox.org.
13	*
14	* This program is free software; you can redistribute it and/or
15	* modify it under the terms of the GNU General Public License
16	* as published by the Free Software Foundation, in version 3 of the
17	* License.
18	*
19	* This program is distributed in the hope that it will be useful, but
20	* WITHOUT ANY WARRANTY; without even the implied warranty of
21	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22	* General Public License for more details.
23	*
24	* You should have received a copy of the GNU General Public License
25	* along with this program; if not, see <https://www.gnu.org/licenses>.
26	*
27	* SPDX-License-Identifier: GPL-3.0-only
28	*/
29
30	#ifndef MAIN_INCLUDED_ovfreader_h
31	#define MAIN_INCLUDED_ovfreader_h
32	#ifndef RT_WITHOUT_PRAGMA_ONCE
33	# pragma once
34	#endif
35
36	#include "iprt/cpp/xml.h"
37	#include <map>
38	#include <vector>
39
40	namespace ovf
41	{
42
43	////////////////////////////////////////////////////////////////////////////////
44	//
45	// Errors
46	//
47	////////////////////////////////////////////////////////////////////////////////
48
49	/**
50	* Thrown by OVFReader for any kind of error that is not an XML error but
51	* still makes the OVF impossible to parse. Based on xml::LogicError so
52	* that one catch() for all xml::LogicError can handle all possible errors.
53	*/
54	class OVFLogicError : public xml::LogicError
55	{
56	public:
57	OVFLogicError(const char *aFormat, ...);
58	};
59
60
61	////////////////////////////////////////////////////////////////////////////////
62	//
63	// Enumerations
64	//
65	////////////////////////////////////////////////////////////////////////////////
66
67	/**
68	* CIM OS values.
69	*
70	* The OVF 1.10 spec refers to some CIM_OperatingSystem.mof doc. Could this be it:
71	* http://cvs.opengroup.org/cgi-bin/cvsweb.cgi/pegasus/Schemas/CIM231/DMTF/System/CIM_OperatingSystem.mof
72	*
73	* @todo r=bird: Why are the values are repeating 'CIMOS'. CIMOSType_T is also
74	* repeating it self, 'Type' and '_T'. Why not call it kCIOMOpSys,
75	* easier to read as well.
76	* Then also apply: s/CIMOSType_CIMOS_/kCIMOpSys_/g
77	*/
78	enum CIMOSType_T
79	{
80	CIMOSType_CIMOS_Unknown = 0,
81	CIMOSType_CIMOS_Other = 1,
82	CIMOSType_CIMOS_MACOS = 2,
83	CIMOSType_CIMOS_ATTUNIX = 3,
84	CIMOSType_CIMOS_DGUX = 4,
85	CIMOSType_CIMOS_DECNT = 5,
86	CIMOSType_CIMOS_Tru64UNIX = 6,
87	CIMOSType_CIMOS_OpenVMS = 7,
88	CIMOSType_CIMOS_HPUX = 8,
89	CIMOSType_CIMOS_AIX = 9,
90	CIMOSType_CIMOS_MVS = 10,
91	CIMOSType_CIMOS_OS400 = 11,
92	CIMOSType_CIMOS_OS2 = 12,
93	CIMOSType_CIMOS_JavaVM = 13,
94	CIMOSType_CIMOS_MSDOS = 14,
95	CIMOSType_CIMOS_WIN3x = 15,
96	CIMOSType_CIMOS_WIN95 = 16,
97	CIMOSType_CIMOS_WIN98 = 17,
98	CIMOSType_CIMOS_WINNT = 18,
99	CIMOSType_CIMOS_WINCE = 19,
100	CIMOSType_CIMOS_NCR3000 = 20,
101	CIMOSType_CIMOS_NetWare = 21,
102	CIMOSType_CIMOS_OSF = 22,
103	CIMOSType_CIMOS_DCOS = 23,
104	CIMOSType_CIMOS_ReliantUNIX = 24,
105	CIMOSType_CIMOS_SCOUnixWare = 25,
106	CIMOSType_CIMOS_SCOOpenServer = 26,
107	CIMOSType_CIMOS_Sequent = 27,
108	CIMOSType_CIMOS_IRIX = 28,
109	CIMOSType_CIMOS_Solaris = 29,
110	CIMOSType_CIMOS_SunOS = 30,
111	CIMOSType_CIMOS_U6000 = 31,
112	CIMOSType_CIMOS_ASERIES = 32,
113	CIMOSType_CIMOS_HPNonStopOS = 33,
114	CIMOSType_CIMOS_HPNonStopOSS = 34,
115	CIMOSType_CIMOS_BS2000 = 35,
116	CIMOSType_CIMOS_LINUX = 36,
117	CIMOSType_CIMOS_Lynx = 37,
118	CIMOSType_CIMOS_XENIX = 38,
119	CIMOSType_CIMOS_VM = 39,
120	CIMOSType_CIMOS_InteractiveUNIX = 40,
121	CIMOSType_CIMOS_BSDUNIX = 41,
122	CIMOSType_CIMOS_FreeBSD = 42,
123	CIMOSType_CIMOS_NetBSD = 43,
124	CIMOSType_CIMOS_GNUHurd = 44,
125	CIMOSType_CIMOS_OS9 = 45,
126	CIMOSType_CIMOS_MACHKernel = 46,
127	CIMOSType_CIMOS_Inferno = 47,
128	CIMOSType_CIMOS_QNX = 48,
129	CIMOSType_CIMOS_EPOC = 49,
130	CIMOSType_CIMOS_IxWorks = 50,
131	CIMOSType_CIMOS_VxWorks = 51,
132	CIMOSType_CIMOS_MiNT = 52,
133	CIMOSType_CIMOS_BeOS = 53,
134	CIMOSType_CIMOS_HPMPE = 54,
135	CIMOSType_CIMOS_NextStep = 55,
136	CIMOSType_CIMOS_PalmPilot = 56,
137	CIMOSType_CIMOS_Rhapsody = 57,
138	CIMOSType_CIMOS_Windows2000 = 58,
139	CIMOSType_CIMOS_Dedicated = 59,
140	CIMOSType_CIMOS_OS390 = 60,
141	CIMOSType_CIMOS_VSE = 61,
142	CIMOSType_CIMOS_TPF = 62,
143	CIMOSType_CIMOS_WindowsMe = 63,
144	CIMOSType_CIMOS_CalderaOpenUNIX = 64,
145	CIMOSType_CIMOS_OpenBSD = 65,
146	CIMOSType_CIMOS_NotApplicable = 66,
147	CIMOSType_CIMOS_WindowsXP = 67,
148	CIMOSType_CIMOS_zOS = 68,
149	CIMOSType_CIMOS_MicrosoftWindowsServer2003 = 69,
150	CIMOSType_CIMOS_MicrosoftWindowsServer2003_64 = 70,
151	CIMOSType_CIMOS_WindowsXP_64 = 71,
152	CIMOSType_CIMOS_WindowsXPEmbedded = 72,
153	CIMOSType_CIMOS_WindowsVista = 73,
154	CIMOSType_CIMOS_WindowsVista_64 = 74,
155	CIMOSType_CIMOS_WindowsEmbeddedforPointofService = 75,
156	CIMOSType_CIMOS_MicrosoftWindowsServer2008 = 76,
157	CIMOSType_CIMOS_MicrosoftWindowsServer2008_64 = 77,
158	CIMOSType_CIMOS_FreeBSD_64 = 78,
159	CIMOSType_CIMOS_RedHatEnterpriseLinux = 79,
160	CIMOSType_CIMOS_RedHatEnterpriseLinux_64 = 80,
161	CIMOSType_CIMOS_Solaris_64 = 81,
162	CIMOSType_CIMOS_SUSE = 82,
163	CIMOSType_CIMOS_SUSE_64 = 83,
164	CIMOSType_CIMOS_SLES = 84,
165	CIMOSType_CIMOS_SLES_64 = 85,
166	CIMOSType_CIMOS_NovellOES = 86,
167	CIMOSType_CIMOS_NovellLinuxDesktop = 87,
168	CIMOSType_CIMOS_SunJavaDesktopSystem = 88,
169	CIMOSType_CIMOS_Mandriva = 89,
170	CIMOSType_CIMOS_Mandriva_64 = 90,
171	CIMOSType_CIMOS_TurboLinux = 91,
172	CIMOSType_CIMOS_TurboLinux_64 = 92,
173	CIMOSType_CIMOS_Ubuntu = 93,
174	CIMOSType_CIMOS_Ubuntu_64 = 94,
175	CIMOSType_CIMOS_Debian = 95,
176	CIMOSType_CIMOS_Debian_64 = 96,
177	CIMOSType_CIMOS_Linux_2_4_x = 97,
178	CIMOSType_CIMOS_Linux_2_4_x_64 = 98,
179	CIMOSType_CIMOS_Linux_2_6_x = 99,
180	CIMOSType_CIMOS_Linux_2_6_x_64 = 100,
181	CIMOSType_CIMOS_Linux_64 = 101,
182	CIMOSType_CIMOS_Other_64 = 102,
183	// types added with CIM 2.25.0 follow:
184	CIMOSType_CIMOS_WindowsServer2008R2 = 103,
185	CIMOSType_CIMOS_VMwareESXi = 104,
186	CIMOSType_CIMOS_Windows7 = 105,
187	CIMOSType_CIMOS_CentOS = 106,
188	CIMOSType_CIMOS_CentOS_64 = 107,
189	CIMOSType_CIMOS_OracleLinux = 108,
190	CIMOSType_CIMOS_OracleLinux_64 = 109,
191	CIMOSType_CIMOS_eComStation = 110,
192	// no new types added with CIM 2.26.0
193	CIMOSType_CIMOS_WindowsServer2011 = 111,
194	CIMOSType_CIMOS_WindowsServer2012 = 112,
195	CIMOSType_CIMOS_Windows8 = 113,
196	CIMOSType_CIMOS_Windows8_64 = 114,
197	CIMOSType_CIMOS_WindowsServer2012R2 = 115,
198	CIMOSType_CIMOS_Windows8_1 = 116,
199	CIMOSType_CIMOS_Windows8_1_64 = 117,
200	CIMOSType_CIMOS_WindowsServer2016 = 118,
201	CIMOSType_CIMOS_Windows10 = 119,
202	CIMOSType_CIMOS_Windows10_64 = 120,
203	// the above covers up to CIM 2.52.0, without checking when it was added
204	};
205
206	enum OVFVersion_T
207	{
208	OVFVersion_unknown,
209	OVFVersion_0_9,
210	OVFVersion_1_0,
211	OVFVersion_2_0
212	};
213
214	const char* const OVF09_URI_string = "http://www.vmware.com/schema/ovf/1/envelope";
215	const char* const OVF10_URI_string = "http://schemas.dmtf.org/ovf/envelope/1";
216	const char* const OVF20_URI_string = "http://schemas.dmtf.org/ovf/envelope/2";
217
218	const char* const DTMF_SPECS_URI = "http://schemas.dmtf.org/wbem/cim-html/2/";
219
220	////////////////////////////////////////////////////////////////////////////////
221	//
222	// Envelope data
223	//
224	////////////////////////////////////////////////////////////////////////////////
225	struct EnvelopeData
226	{
227	OVFVersion_T version;//OVF standard version, it is used internally only by VirtualBox
228	RTCString lang;//language
229
230	OVFVersion_T getOVFVersion() const
231	{
232	return version;
233	}
234
235
236	RTCString getStringOVFVersion() const
237	{
238	if (version == OVFVersion_0_9)
239	return "0.9";
240	else if (version == OVFVersion_1_0)
241	return "1.0";
242	else if (version == OVFVersion_2_0)
243	return "2.0";
244	else
245	return "";
246	}
247
248	void setOVFVersion(OVFVersion_T v)
249	{
250	version = v;
251	}
252	};
253
254
255	struct FileReference
256	{
257	RTCString strHref; // value from /References/File/@href (filename)
258	RTCString strDiskId; // value from /References/File/@id ()
259	};
260
261	typedef std::map<uint32_t, FileReference> FileReferenceMap;
262
263	////////////////////////////////////////////////////////////////////////////////
264	//
265	// Hardware definition structs
266	//
267	////////////////////////////////////////////////////////////////////////////////
268
269	struct DiskImage
270	{
271	// fields from /DiskSection/Disk
272	RTCString strDiskId; // value from DiskSection/Disk/@diskId
273	int64_t iCapacity; // value from DiskSection/Disk/@capacity;
274	// (maximum size for dynamic images, I guess; we always translate this to bytes)
275	int64_t iPopulatedSize; // optional value from DiskSection/Disk/@populatedSize
276	// (actual used size of disk, always in bytes; can be an estimate of used disk
277	// space, but cannot be larger than iCapacity; -1 if not set)
278	RTCString strFormat; // value from DiskSection/Disk/@format
279	// typically http://www.vmware.com/interfaces/specifications/vmdk.html#streamOptimized
280	RTCString uuidVBox; // optional; if the file was exported by VirtualBox >= 3.2,
281	// then this has the UUID with which the disk was registered
282
283	// fields from /References/File; the spec says the file reference from disk can be empty,
284	// so in that case, strFilename will be empty, then a new disk should be created
285	RTCString strHref; // value from /References/File/@href (filename); if empty, then the remaining fields are ignored
286	int64_t iSize; // value from /References/File/@size (optional according to spec; then we set -1 here)
287	int64_t iChunkSize; // value from /References/File/@chunkSize (optional, unsupported)
288	RTCString strCompression; // value from /References/File/@compression (optional, can be "gzip" according to spec)
289
290	// additional field which has a descriptive size in megabytes derived from the above; this can be used for progress reports
291	uint32_t ulSuggestedSizeMB;
292	};
293
294	enum ResourceType_T
295	{
296	ResourceType_Other = 1,
297	ResourceType_ComputerSystem = 2,
298	ResourceType_Processor = 3,
299	ResourceType_Memory = 4,
300	ResourceType_IDEController = 5,
301	ResourceType_ParallelSCSIHBA = 6,
302	ResourceType_FCHBA = 7,
303	ResourceType_iSCSIHBA = 8,
304	ResourceType_IBHCA = 9,
305	ResourceType_EthernetAdapter = 10,
306	ResourceType_OtherNetworkAdapter = 11,
307	ResourceType_IOSlot = 12,
308	ResourceType_IODevice = 13,
309	ResourceType_FloppyDrive = 14,
310	ResourceType_CDDrive = 15,
311	ResourceType_DVDDrive = 16,
312	ResourceType_HardDisk = 17,
313	ResourceType_TapeDrive = 18,
314	ResourceType_StorageExtent = 19,
315	ResourceType_OtherStorageDevice = 20,
316	ResourceType_SerialPort = 21,
317	ResourceType_ParallelPort = 22,
318	ResourceType_USBController = 23,
319	ResourceType_GraphicsController = 24,
320	ResourceType_IEEE1394Controller = 25,
321	ResourceType_PartitionableUnit = 26,
322	ResourceType_BasePartitionableUnit = 27,
323	ResourceType_Power = 28,
324	ResourceType_CoolingCapacity = 29,
325	ResourceType_EthernetSwitchPort = 30,
326	ResourceType_LogicalDisk = 31,
327	ResourceType_StorageVolume = 32,
328	ResourceType_EthernetConnection = 33,
329	ResourceType_SoundCard = 35 /*< @todo r=klaus: Not part of OVF/CIM spec, should use "Other" or some value from 0x8000..0xffff. /
330	};
331
332
333	enum StorageAccessType_T
334	{ StorageAccessType_Unknown = 0,
335	StorageAccessType_Readable = 1,
336	StorageAccessType_Writeable = 2,
337	StorageAccessType_ReadWrite = 3
338	};
339
340	enum ComplianceType_T
341	{ ComplianceType_No = 0,
342	ComplianceType_Soft = 1,
343	ComplianceType_Medium = 2,
344	ComplianceType_Strong = 3
345	};
346
347	class VirtualHardwareItem
348	{
349	public:
350	RTCString strDescription;
351	RTCString strCaption;
352	RTCString strElementName;
353
354	RTCString strInstanceID;
355	RTCString strParent;
356
357	ResourceType_T resourceType;
358	RTCString strOtherResourceType;
359	RTCString strResourceSubType;
360	bool fResourceRequired;
361
362	RTCString strHostResource; ///< "Abstractly specifies how a device shall connect to a resource on the deployment platform.
363	/// Not all devices need a backing." Used with disk items, for which this
364	/// references a virtual disk from the Disks section.
365	bool fAutomaticAllocation;
366	bool fAutomaticDeallocation;
367	RTCString strConnection; ///< "All Ethernet adapters that specify the same abstract network connection name within an OVF
368	/// package shall be deployed on the same network. The abstract network connection name shall be
369	/// listed in the NetworkSection at the outermost envelope level." We ignore this and only set up
370	/// a network adapter depending on the network name.
371	RTCString strAddress; ///< "Device-specific. For an Ethernet adapter, this specifies the MAC address."
372	int32_t lAddress; ///< strAddress as an integer, if applicable.
373	RTCString strAddressOnParent;///< "For a device, this specifies its location on the controller."
374	RTCString strAllocationUnits;///< "Specifies the units of allocation used. For example, “byte * 2^20”."
375	uint64_t ullVirtualQuantity; ///< "Specifies the quantity of resources presented. For example, “256”."
376	uint64_t ullReservation; ///< "Specifies the minimum quantity of resources guaranteed to be available."
377	uint64_t ullLimit; ///< "Specifies the maximum quantity of resources that will be granted."
378	uint64_t ullWeight; ///< "Specifies a relative priority for this allocation in relation to other allocations."
379
380	RTCString strConsumerVisibility;
381	RTCString strMappingBehavior;
382	RTCString strPoolID;
383	uint32_t ulBusNumber; ///< seen with IDE controllers, but not listed in OVF spec
384
385	int m_iLineNumber; ///< line number of \<Item\> element in XML source; cached for error messages
386
387	VirtualHardwareItem()
388	: fResourceRequired(false)
389	, fAutomaticAllocation(false)
390	, fAutomaticDeallocation(false)
391	, ullVirtualQuantity(0)
392	, ullReservation(0)
393	, ullLimit(0)
394	, ullWeight(0)
395	, ulBusNumber(0)
396	, m_iLineNumber(0)
397	, fDefault(false)
398	{
399	itemName = "Item";
400	}
401
402	virtual ~VirtualHardwareItem() { /* Makes MSC happy. */ }
403
404	void fillItem(const xml::ElementNode *item);
405
406	void setDefaultFlag()
407	{
408	fDefault = true;
409	}
410
411	bool isThereDefaultValues() const
412	{
413	return fDefault;
414	}
415
416	void checkConsistencyAndCompliance() RT_THROW(OVFLogicError)
417	{
418	_checkConsistencyAndCompliance();
419	}
420
421	protected:
422	virtual void _checkConsistencyAndCompliance() RT_THROW(OVFLogicError);
423	virtual const RTCString& getItemName()
424	{
425	return _getItemName();
426	}
427
428	private:
429	RTCString itemName;
430	bool fDefault;//true means that some fields were absent in the XML and some default values were assigned to.
431
432	virtual const RTCString& _getItemName()
433	{
434	return itemName;
435	}
436	};
437
438	class StorageItem: public VirtualHardwareItem
439	{
440	//see DMTF Schema Documentation http://schemas.dmtf.org/wbem/cim-html/2/
441	StorageAccessType_T accessType;
442	RTCString strHostExtentName;
443	#if 0 /* unused */
444	int16_t hostExtentNameFormat;
445	int16_t hostExtentNameNamespace;
446	int64_t hostExtentStartingAddress;
447	#endif
448	int64_t hostResourceBlockSize;
449	int64_t limit;
450	RTCString strOtherHostExtentNameFormat;
451	RTCString strOtherHostExtentNameNamespace;
452	int64_t reservation;
453	int64_t virtualQuantity;
454	RTCString strVirtualQuantityUnits;
455	int64_t virtualResourceBlockSize;
456
457	public:
458	StorageItem()
459	: VirtualHardwareItem()
460	, accessType(StorageAccessType_Unknown)
461	#if 0 /* unused */
462	, hostExtentNameFormat(-1)
463	, hostExtentNameNamespace(-1)
464	, hostExtentStartingAddress(-1)
465	#endif
466	, hostResourceBlockSize(-1)
467	, limit(-1)
468	, reservation(-1)
469	, virtualQuantity(-1)
470	, virtualResourceBlockSize(-1)
471	{
472	itemName = "StorageItem";
473	};
474
475	void fillItem(const xml::ElementNode *item);
476
477	protected:
478	virtual void _checkConsistencyAndCompliance() RT_THROW(OVFLogicError);
479	private:
480	RTCString itemName;
481
482	virtual const RTCString& _getItemName()
483	{
484	return itemName;
485	}
486	};
487
488
489	class EthernetPortItem: public VirtualHardwareItem
490	{
491	//see DMTF Schema Documentation http://schemas.dmtf.org/wbem/cim-html/2/
492	#if 0 /* unused */
493	uint16_t DefaultPortVID;
494	uint16_t DefaultPriority;
495	uint16_t DesiredVLANEndpointMode;
496	uint32_t GroupID;
497	uint32_t ManagerID;
498	uint16_t NetworkPortProfileIDType;
499	#endif
500	RTCString strNetworkPortProfileID;
501	RTCString strOtherEndpointMode;
502	RTCString strOtherNetworkPortProfileIDTypeInfo;
503	RTCString strPortCorrelationID;
504	#if 0 /* unused */
505	uint16_t PortVID;
506	bool Promiscuous;
507	uint64_t ReceiveBandwidthLimit;
508	uint16_t ReceiveBandwidthReservation;
509	bool SourceMACFilteringEnabled;
510	uint32_t VSITypeID;
511	uint8_t VSITypeIDVersion;
512	uint16_t AllowedPriorities[256];
513	uint16_t AllowedToReceiveVLANs[256];
514	uint16_t AllowedToTransmitVLANs[256];
515	#endif
516	RTCString strAllowedToReceiveMACAddresses;
517	RTCString strAllowedToTransmitMACAddresses;
518
519	public:
520	EthernetPortItem() : VirtualHardwareItem()
521	{
522	itemName = "EthernetPortItem";
523	};
524
525	void fillItem(const xml::ElementNode *item);
526
527	protected:
528	virtual void _checkConsistencyAndCompliance() RT_THROW(OVFLogicError);
529	private:
530	RTCString itemName;
531
532	virtual const RTCString& _getItemName()
533	{
534	return itemName;
535	}
536	};
537
538	typedef std::map<RTCString, DiskImage> DiskImagesMap;
539
540	struct VirtualSystem;
541
542
543	/**
544	* VirtualHardwareItem pointer vector with safe cleanup.
545	*
546	* We need to use object pointers because we also want EthernetPortItem and
547	* StorageItems to go into the container.
548	*/
549	class HardwareItemVector : public std::vector<VirtualHardwareItem *>
550	{
551	public:
552	HardwareItemVector() : std::vector<VirtualHardwareItem *>() { }
553	~HardwareItemVector()
554	{
555	for (iterator it = begin(); it != end(); ++it)
556	delete(*it);
557	clear();
558	}
559
560	/* There is no copying of this vector. We'd need something like shared_ptr for that. */
561	private:
562	HardwareItemVector(const VirtualSystem &);
563
564	};
565
566	struct HardDiskController
567	{
568	RTCString strIdController; // instance ID (Item/InstanceId); this gets referenced from VirtualDisk
569
570	enum ControllerSystemType { IDE, SATA, SCSI, VIRTIOSCSI };
571	ControllerSystemType system; // one of IDE, SATA, SCSI, VIRTIOSCSI
572
573	RTCString strControllerType;
574	// controller subtype (Item/ResourceSubType); e.g. "LsiLogic"; can be empty (esp. for IDE)
575	// note that we treat LsiLogicSAS as a SCSI controller (system == SCSI) even though VirtualBox
576	// treats it as a fourth class besides IDE, SATA, SCSI
577
578	int32_t lAddress; // value from OVF "Address" element
579	bool fPrimary; // controller index; this is determined heuristically by the OVF reader and will
580	// be true for the first controller of this type (e.g. IDE primary ctler) or
581	// false for the next (e.g. IDE secondary ctler)
582
583	HardDiskController()
584	: lAddress(0),
585	fPrimary(true)
586	{ }
587	};
588
589	typedef std::map<RTCString, HardDiskController> ControllersMap;
590
591	struct VirtualDisk
592	{
593	RTCString strIdController; // SCSI (or IDE) controller this disk is connected to;
594	// this must match HardDiskController.strIdController and
595	// points into VirtualSystem.mapControllers
596	uint32_t ulAddressOnParent; // parsed strAddressOnParent of hardware item; will be 0 or 1 for IDE
597	// and possibly higher for disks attached to SCSI controllers (untested)
598	RTCString strDiskId; // if the hard disk has an ovf:/disk/<id> reference,
599	// this receives the <id> component; points to one of the
600	// references in Appliance::Data.mapDisks
601	bool fEmpty; //true - empty disk, e.g. the component <rasd:HostResource>...</rasd:HostResource> is absent.
602	};
603
604	typedef std::map<RTCString, VirtualDisk> VirtualDisksMap;
605
606	/**
607	* A list of EthernetAdapters is contained in VirtualSystem, representing the
608	* ethernet adapters in the virtual system.
609	*/
610	struct EthernetAdapter
611	{
612	RTCString strAdapterType; // "PCNet32" or "E1000" or whatever; from <rasd:ResourceSubType>
613	RTCString strNetworkName; // from <rasd:Connection>
614	};
615
616	typedef std::list<EthernetAdapter> EthernetAdaptersList;
617
618	/**
619	* A list of VirtualSystem structs is created by OVFReader::read(). Each refers to
620	* a \<VirtualSystem\> block in the OVF file.
621	*/
622	struct VirtualSystem
623	{
624	RTCString strName; // copy of VirtualSystem/@id
625
626	RTCString strDescription; // copy of VirtualSystem/AnnotationSection content, if any
627
628	CIMOSType_T cimos;
629	RTCString strCimosDesc; // readable description of the cimos type in the case of cimos = 0/1/102
630	RTCString strTypeVBox; // optional type from @vbox:ostype attribute (VirtualBox 4.0 or higher)
631
632	RTCString strVirtualSystemType; // generic hardware description; OVF says this can be something like "vmx-4" or "xen";
633	// VMware Workstation 6.5 is "vmx-07"
634
635	HardwareItemVector vecHardwareItems; //< vector containing all virtual hardware items in parsing order.
636
637	uint64_t ullMemorySize; // always in bytes, copied from llHardwareItems; default = 0 (unspecified)
638	uint16_t cCPUs; // no. of CPUs, copied from llHardwareItems; default = 1
639
640	EthernetAdaptersList llEthernetAdapters; // (one for each VirtualSystem/Item[@ResourceType=10]element)
641
642	ControllersMap mapControllers;
643	// list of hard disk controllers
644	// (one for each VirtualSystem/Item[@ResourceType=6] element with accumulated data from children)
645
646	VirtualDisksMap mapVirtualDisks;
647	// (one for each VirtualSystem/Item[@ResourceType=17] element with accumulated data from children)
648
649	bool fHasFloppyDrive; // true if there's a floppy item in mapHardwareItems
650	bool fHasCdromDrive; // true if there's a CD-ROM item in mapHardwareItems; ISO images are not yet supported by OVFtool
651	bool fHasUsbController; // true if there's a USB controller item in mapHardwareItems
652
653	RTCString strSoundCardType; // if not empty, then the system wants a soundcard; this then specifies the hardware;
654	// VMware Workstation 6.5 uses "ensoniq1371" for example
655
656	RTCString strLicenseText; // license info if any; receives contents of VirtualSystem/EulaSection/License
657
658	RTCString strProduct; // product info if any; receives contents of VirtualSystem/ProductSection/Product
659	RTCString strVendor; // product info if any; receives contents of VirtualSystem/ProductSection/Vendor
660	RTCString strVersion; // product info if any; receives contents of VirtualSystem/ProductSection/Version
661	RTCString strProductUrl; // product info if any; receives contents of VirtualSystem/ProductSection/ProductUrl
662	RTCString strVendorUrl; // product info if any; receives contents of VirtualSystem/ProductSection/VendorUrl
663
664	const xml::ElementNode *pelmVBoxMachine; // pointer to <vbox:Machine> element under <VirtualSystem> element or NULL if not present
665
666	VirtualSystem()
667	: cimos(CIMOSType_CIMOS_Unknown),
668	ullMemorySize(0),
669	cCPUs(1),
670	fHasFloppyDrive(false),
671	fHasCdromDrive(false),
672	fHasUsbController(false),
673	pelmVBoxMachine(NULL)
674	{
675	}
676	};
677
678	////////////////////////////////////////////////////////////////////////////////
679	//
680	// Class OVFReader
681	//
682	////////////////////////////////////////////////////////////////////////////////
683
684	/**
685	* OVFReader attempts to open, read in and parse an OVF XML file. This is all done
686	* in the constructor; if there is any kind of error in the file -- filesystem error
687	* from IPRT, XML parsing errors from libxml, or OVF logical errors --, exceptions
688	* are thrown. These are all based on xml::Error.
689	*
690	* Hence, use this class as follows:
691	<code>
692	OVFReader *pReader = NULL;
693	try
694	{
695	pReader = new("/path/to/file.ovf");
696	}
697	catch (xml::Error &e)
698	{
699	printf("A terrible thing happened: %s", e.what());
700	}
701	// now go look at pReader->m_llVirtualSystem and what's in there
702	if (pReader)
703	delete pReader;
704	</code>
705	*/
706	class OVFReader
707	{
708	public:
709	OVFReader();
710	OVFReader(const void *pvBuf, size_t cbSize, const RTCString &path);
711	OVFReader(const RTCString &path);
712
713	// Data fields
714	EnvelopeData m_envelopeData; //data of root element "Envelope"
715	RTCString m_strPath; // file name given to constructor
716	DiskImagesMap m_mapDisks; // map of DiskImage structs, sorted by DiskImage.strDiskId
717	std::list<VirtualSystem> m_llVirtualSystems; // list of virtual systems, created by and valid after read()
718
719	private:
720	xml::Document m_doc;
721
722	void parse();
723	void LoopThruSections(const xml::ElementNode pReferencesElem, const xml::ElementNode pCurElem);
724	void HandleDiskSection(const xml::ElementNode pReferencesElem, const xml::ElementNode pSectionElem);
725	void HandleNetworkSection(const xml::ElementNode *pSectionElem);
726	void HandleVirtualSystemContent(const xml::ElementNode *pContentElem);
727	};
728
729	} // end namespace ovf
730
731	#endif /* !MAIN_INCLUDED_ovfreader_h */
732

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

source: vbox/trunk/src/VBox/Main/include/ovfreader.h@ 96910

Download in other formats: