VirtualBox

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

Last change on this file since 25414 was 25348, checked in by vboxsync, 14 years ago

iprt/xml_cpp.h -> iprt/cpp/xml.h
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 16.9 KB
Line 
1/* $Id: ovfreader.h 25348 2009-12-13 17:15:06Z vboxsync $ */
2/** @file
3 * OVF reader declarations.
4 *
5 * Depends only on IPRT, including the iprt::MiniString and IPRT XML classes.
6 */
7
8/*
9 * Copyright (C) 2008-2009 Sun Microsystems, Inc.
10 *
11 * This file is part of VirtualBox Open Source Edition (OSE), as
12 * available from http://www.virtualbox.org. This file is free software;
13 * you can redistribute it and/or modify it under the terms of the GNU
14 * General Public License (GPL) as published by the Free Software
15 * Foundation, in version 2 as it comes in the "COPYING" file of the
16 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
17 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
18 *
19 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
20 * Clara, CA 95054 USA or visit http://www.sun.com if you need
21 * additional information or have any questions.
22 */
23
24#ifndef ____H_OVFREADER
25#define ____H_OVFREADER
26
27#include "iprt/cpp/xml.h"
28#include <map>
29
30////////////////////////////////////////////////////////////////////////////////
31//
32// Enumerations
33//
34////////////////////////////////////////////////////////////////////////////////
35
36enum CIMOSType_T
37{ CIMOSType_CIMOS_Unknown = 0,
38 CIMOSType_CIMOS_Other = 1,
39 CIMOSType_CIMOS_MACOS = 2,
40 CIMOSType_CIMOS_ATTUNIX = 3,
41 CIMOSType_CIMOS_DGUX = 4,
42 CIMOSType_CIMOS_DECNT = 5,
43 CIMOSType_CIMOS_Tru64UNIX = 6,
44 CIMOSType_CIMOS_OpenVMS = 7,
45 CIMOSType_CIMOS_HPUX = 8,
46 CIMOSType_CIMOS_AIX = 9,
47 CIMOSType_CIMOS_MVS = 10,
48 CIMOSType_CIMOS_OS400 = 11,
49 CIMOSType_CIMOS_OS2 = 12,
50 CIMOSType_CIMOS_JavaVM = 13,
51 CIMOSType_CIMOS_MSDOS = 14,
52 CIMOSType_CIMOS_WIN3x = 15,
53 CIMOSType_CIMOS_WIN95 = 16,
54 CIMOSType_CIMOS_WIN98 = 17,
55 CIMOSType_CIMOS_WINNT = 18,
56 CIMOSType_CIMOS_WINCE = 19,
57 CIMOSType_CIMOS_NCR3000 = 20,
58 CIMOSType_CIMOS_NetWare = 21,
59 CIMOSType_CIMOS_OSF = 22,
60 CIMOSType_CIMOS_DCOS = 23,
61 CIMOSType_CIMOS_ReliantUNIX = 24,
62 CIMOSType_CIMOS_SCOUnixWare = 25,
63 CIMOSType_CIMOS_SCOOpenServer = 26,
64 CIMOSType_CIMOS_Sequent = 27,
65 CIMOSType_CIMOS_IRIX = 28,
66 CIMOSType_CIMOS_Solaris = 29,
67 CIMOSType_CIMOS_SunOS = 30,
68 CIMOSType_CIMOS_U6000 = 31,
69 CIMOSType_CIMOS_ASERIES = 32,
70 CIMOSType_CIMOS_HPNonStopOS = 33,
71 CIMOSType_CIMOS_HPNonStopOSS = 34,
72 CIMOSType_CIMOS_BS2000 = 35,
73 CIMOSType_CIMOS_LINUX = 36,
74 CIMOSType_CIMOS_Lynx = 37,
75 CIMOSType_CIMOS_XENIX = 38,
76 CIMOSType_CIMOS_VM = 39,
77 CIMOSType_CIMOS_InteractiveUNIX = 40,
78 CIMOSType_CIMOS_BSDUNIX = 41,
79 CIMOSType_CIMOS_FreeBSD = 42,
80 CIMOSType_CIMOS_NetBSD = 43,
81 CIMOSType_CIMOS_GNUHurd = 44,
82 CIMOSType_CIMOS_OS9 = 45,
83 CIMOSType_CIMOS_MACHKernel = 46,
84 CIMOSType_CIMOS_Inferno = 47,
85 CIMOSType_CIMOS_QNX = 48,
86 CIMOSType_CIMOS_EPOC = 49,
87 CIMOSType_CIMOS_IxWorks = 50,
88 CIMOSType_CIMOS_VxWorks = 51,
89 CIMOSType_CIMOS_MiNT = 52,
90 CIMOSType_CIMOS_BeOS = 53,
91 CIMOSType_CIMOS_HPMPE = 54,
92 CIMOSType_CIMOS_NextStep = 55,
93 CIMOSType_CIMOS_PalmPilot = 56,
94 CIMOSType_CIMOS_Rhapsody = 57,
95 CIMOSType_CIMOS_Windows2000 = 58,
96 CIMOSType_CIMOS_Dedicated = 59,
97 CIMOSType_CIMOS_OS390 = 60,
98 CIMOSType_CIMOS_VSE = 61,
99 CIMOSType_CIMOS_TPF = 62,
100 CIMOSType_CIMOS_WindowsMe = 63,
101 CIMOSType_CIMOS_CalderaOpenUNIX = 64,
102 CIMOSType_CIMOS_OpenBSD = 65,
103 CIMOSType_CIMOS_NotApplicable = 66,
104 CIMOSType_CIMOS_WindowsXP = 67,
105 CIMOSType_CIMOS_zOS = 68,
106 CIMOSType_CIMOS_MicrosoftWindowsServer2003 = 69,
107 CIMOSType_CIMOS_MicrosoftWindowsServer2003_64 = 70,
108 CIMOSType_CIMOS_WindowsXP_64 = 71,
109 CIMOSType_CIMOS_WindowsXPEmbedded = 72,
110 CIMOSType_CIMOS_WindowsVista = 73,
111 CIMOSType_CIMOS_WindowsVista_64 = 74,
112 CIMOSType_CIMOS_WindowsEmbeddedforPointofService = 75,
113 CIMOSType_CIMOS_MicrosoftWindowsServer2008 = 76,
114 CIMOSType_CIMOS_MicrosoftWindowsServer2008_64 = 77,
115 CIMOSType_CIMOS_FreeBSD_64 = 78,
116 CIMOSType_CIMOS_RedHatEnterpriseLinux = 79,
117 CIMOSType_CIMOS_RedHatEnterpriseLinux_64 = 80,
118 CIMOSType_CIMOS_Solaris_64 = 81,
119 CIMOSType_CIMOS_SUSE = 82,
120 CIMOSType_CIMOS_SUSE_64 = 83,
121 CIMOSType_CIMOS_SLES = 84,
122 CIMOSType_CIMOS_SLES_64 = 85,
123 CIMOSType_CIMOS_NovellOES = 86,
124 CIMOSType_CIMOS_NovellLinuxDesktop = 87,
125 CIMOSType_CIMOS_SunJavaDesktopSystem = 88,
126 CIMOSType_CIMOS_Mandriva = 89,
127 CIMOSType_CIMOS_Mandriva_64 = 90,
128 CIMOSType_CIMOS_TurboLinux = 91,
129 CIMOSType_CIMOS_TurboLinux_64 = 92,
130 CIMOSType_CIMOS_Ubuntu = 93,
131 CIMOSType_CIMOS_Ubuntu_64 = 94,
132 CIMOSType_CIMOS_Debian = 95,
133 CIMOSType_CIMOS_Debian_64 = 96,
134 CIMOSType_CIMOS_Linux_2_4_x = 97,
135 CIMOSType_CIMOS_Linux_2_4_x_64 = 98,
136 CIMOSType_CIMOS_Linux_2_6_x = 99,
137 CIMOSType_CIMOS_Linux_2_6_x_64 = 100,
138 CIMOSType_CIMOS_Linux_64 = 101,
139 CIMOSType_CIMOS_Other_64 = 102
140};
141
142
143////////////////////////////////////////////////////////////////////////////////
144//
145// Hardware definition structs
146//
147////////////////////////////////////////////////////////////////////////////////
148
149struct DiskImage
150{
151 iprt::MiniString strDiskId; // value from DiskSection/Disk/@diskId
152 int64_t iCapacity; // value from DiskSection/Disk/@capacity;
153 // (maximum size for dynamic images, I guess; we always translate this to bytes)
154 int64_t iPopulatedSize; // optional value from DiskSection/Disk/@populatedSize
155 // (actual used size of disk, always in bytes; can be an estimate of used disk
156 // space, but cannot be larger than iCapacity; -1 if not set)
157 iprt::MiniString strFormat; // value from DiskSection/Disk/@format
158 // typically http://www.vmware.com/specifications/vmdk.html#sparse
159
160 // fields from /References/File; the spec says the file reference from disk can be empty,
161 // so in that case, strFilename will be empty, then a new disk should be created
162 iprt::MiniString strHref; // value from /References/File/@href (filename); if empty, then the remaining fields are ignored
163 int64_t iSize; // value from /References/File/@size (optional according to spec; then we set -1 here)
164 int64_t iChunkSize; // value from /References/File/@chunkSize (optional, unsupported)
165 iprt::MiniString strCompression; // value from /References/File/@compression (optional, can be "gzip" according to spec)
166};
167
168enum OVFResourceType_T
169{ OVFResourceType_Other = 1,
170 OVFResourceType_ComputerSystem = 2,
171 OVFResourceType_Processor = 3,
172 OVFResourceType_Memory = 4,
173 OVFResourceType_IDEController = 5,
174 OVFResourceType_ParallelSCSIHBA = 6,
175 OVFResourceType_FCHBA = 7,
176 OVFResourceType_iSCSIHBA = 8,
177 OVFResourceType_IBHCA = 9,
178 OVFResourceType_EthernetAdapter = 10,
179 OVFResourceType_OtherNetworkAdapter = 11,
180 OVFResourceType_IOSlot = 12,
181 OVFResourceType_IODevice = 13,
182 OVFResourceType_FloppyDrive = 14,
183 OVFResourceType_CDDrive = 15,
184 OVFResourceType_DVDDrive = 16,
185 OVFResourceType_HardDisk = 17,
186 OVFResourceType_OtherStorageDevice = 20,
187 OVFResourceType_USBController = 23,
188 OVFResourceType_SoundCard = 35
189};
190
191struct VirtualHardwareItem
192{
193 iprt::MiniString strDescription;
194 iprt::MiniString strCaption;
195 iprt::MiniString strElementName;
196
197 uint32_t ulInstanceID;
198 uint32_t ulParent;
199
200 OVFResourceType_T resourceType;
201 iprt::MiniString strOtherResourceType;
202 iprt::MiniString strResourceSubType;
203
204 iprt::MiniString strHostResource; // "Abstractly specifies how a device shall connect to a resource on the deployment platform.
205 // Not all devices need a backing." Used with disk items, for which this references a virtual
206 // disk from the Disks section.
207 bool fAutomaticAllocation;
208 bool fAutomaticDeallocation;
209 iprt::MiniString strConnection; // "All Ethernet adapters that specify the same abstract network connection name within an OVF
210 // package shall be deployed on the same network. The abstract network connection name shall be
211 // listed in the NetworkSection at the outermost envelope level." We ignore this and only set up
212 // a network adapter depending on the network name.
213 iprt::MiniString strAddress; // "Device-specific. For an Ethernet adapter, this specifies the MAC address."
214 iprt::MiniString strAddressOnParent; // "For a device, this specifies its location on the controller."
215 iprt::MiniString strAllocationUnits; // "Specifies the units of allocation used. For example, “byte * 2^20”."
216 uint64_t ullVirtualQuantity; // "Specifies the quantity of resources presented. For example, “256”."
217 uint64_t ullReservation; // "Specifies the minimum quantity of resources guaranteed to be available."
218 uint64_t ullLimit; // "Specifies the maximum quantity of resources that will be granted."
219 uint64_t ullWeight; // "Specifies a relative priority for this allocation in relation to other allocations."
220
221 iprt::MiniString strConsumerVisibility;
222 iprt::MiniString strMappingBehavior;
223 iprt::MiniString strPoolID;
224 uint32_t ulBusNumber; // seen with IDE controllers, but not listed in OVF spec
225
226 uint32_t ulLineNumber; // line number of <Item> element in XML source; cached for error messages
227
228 VirtualHardwareItem()
229 : ulInstanceID(0), fAutomaticAllocation(false), fAutomaticDeallocation(false), ullVirtualQuantity(0), ullReservation(0), ullLimit(0), ullWeight(0), ulBusNumber(0), ulLineNumber(0)
230 {};
231};
232
233typedef std::map<iprt::MiniString, DiskImage> DiskImagesMap;
234
235struct VirtualSystem;
236
237typedef std::map<uint32_t, VirtualHardwareItem> HardwareItemsMap;
238
239struct HardDiskController
240{
241 uint32_t idController; // instance ID (Item/InstanceId); this gets referenced from HardDisk
242 enum ControllerSystemType { IDE, SATA, SCSI };
243 ControllerSystemType system; // one of IDE, SATA, SCSI
244 iprt::MiniString strControllerType; // controller subtype (Item/ResourceSubType); e.g. "LsiLogic"; can be empty (esp. for IDE)
245 iprt::MiniString strAddress; // for IDE
246 uint32_t ulBusNumber; // for IDE
247
248 HardDiskController()
249 : idController(0),
250 ulBusNumber(0)
251 {
252 }
253};
254
255typedef std::map<uint32_t, HardDiskController> ControllersMap;
256
257struct VirtualDisk
258{
259 uint32_t idController; // SCSI (or IDE) controller this disk is connected to;
260 // points into VirtualSystem.mapControllers
261 uint32_t ulAddressOnParent; // parsed strAddressOnParent of hardware item; will be 0 or 1 for IDE
262 // and possibly higher for disks attached to SCSI controllers (untested)
263 iprt::MiniString strDiskId; // if the hard disk has an ovf:/disk/<id> reference,
264 // this receives the <id> component; points to one of the
265 // references in Appliance::Data.mapDisks
266};
267
268typedef std::map<iprt::MiniString, VirtualDisk> VirtualDisksMap;
269
270/**
271 * A list of EthernetAdapters is contained in VirtualSystem, representing the
272 * ethernet adapters in the virtual system.
273 */
274struct EthernetAdapter
275{
276 iprt::MiniString strAdapterType; // "PCNet32" or "E1000" or whatever; from <rasd:ResourceSubType>
277 iprt::MiniString strNetworkName; // from <rasd:Connection>
278};
279
280typedef std::list<EthernetAdapter> EthernetAdaptersList;
281
282/**
283 * A list of VirtualSystem structs is created by OVFReader::read(). Each refers to
284 * a <VirtualSystem> block in the OVF file.
285 */
286struct VirtualSystem
287{
288 iprt::MiniString strName; // copy of VirtualSystem/@id
289
290 iprt::MiniString strDescription; // copy of VirtualSystem/Info content
291
292 CIMOSType_T cimos;
293 iprt::MiniString strCimosDesc; // readable description of the cimos type in the case of cimos = 0/1/102
294 iprt::MiniString strVirtualSystemType; // generic hardware description; OVF says this can be something like "vmx-4" or "xen";
295 // VMware Workstation 6.5 is "vmx-07"
296
297 HardwareItemsMap mapHardwareItems; // map of virtual hardware items, sorted by unique instance ID
298
299 uint64_t ullMemorySize; // always in bytes, copied from llHardwareItems; default = 0 (unspecified)
300 uint16_t cCPUs; // no. of CPUs, copied from llHardwareItems; default = 1
301
302 EthernetAdaptersList llEthernetAdapters; // (one for each VirtualSystem/Item[@ResourceType=10]element)
303
304 ControllersMap mapControllers;
305 // list of hard disk controllers
306 // (one for each VirtualSystem/Item[@ResourceType=6] element with accumulated data from children)
307
308 VirtualDisksMap mapVirtualDisks;
309 // (one for each VirtualSystem/Item[@ResourceType=17] element with accumulated data from children)
310
311 bool fHasFloppyDrive; // true if there's a floppy item in mapHardwareItems
312 bool fHasCdromDrive; // true if there's a CD-ROM item in mapHardwareItems; ISO images are not yet supported by OVFtool
313 bool fHasUsbController; // true if there's a USB controller item in mapHardwareItems
314
315 iprt::MiniString strSoundCardType; // if not empty, then the system wants a soundcard; this then specifies the hardware;
316 // VMware Workstation 6.5 uses "ensoniq1371" for example
317
318 iprt::MiniString strLicenseText; // license info if any; receives contents of VirtualSystem/EulaSection/License
319
320 iprt::MiniString strProduct; // product info if any; receives contents of VirtualSystem/ProductSection/Product
321 iprt::MiniString strVendor; // product info if any; receives contents of VirtualSystem/ProductSection/Vendor
322 iprt::MiniString strVersion; // product info if any; receives contents of VirtualSystem/ProductSection/Version
323 iprt::MiniString strProductUrl; // product info if any; receives contents of VirtualSystem/ProductSection/ProductUrl
324 iprt::MiniString strVendorUrl; // product info if any; receives contents of VirtualSystem/ProductSection/VendorUrl
325
326 VirtualSystem()
327 : ullMemorySize(0), cCPUs(1), fHasFloppyDrive(false), fHasCdromDrive(false), fHasUsbController(false)
328 {
329 }
330};
331
332////////////////////////////////////////////////////////////////////////////////
333//
334// Class OVFReader
335//
336////////////////////////////////////////////////////////////////////////////////
337
338/**
339 * OVFReader attempts to open, read in and parse an OVF XML file. This is all done
340 * in the constructor; if there is any kind of error in the file -- filesystem error
341 * from IPRT, XML parsing errors from libxml, or OVF logical errors --, exceptions
342 * are thrown. These are all based on xml::Error.
343 *
344 * Hence, use this class as follows:
345<code>
346 OVFReader *pReader = NULL;
347 try
348 {
349 pReader = new("/path/to/file.ovf");
350 }
351 catch (xml::Error &e)
352 {
353 printf("A terrible thing happened: %s", e.what());
354 }
355 // now go look at pReader->m_llVirtualSystem and what's in there
356 if (pReader)
357 delete pReader;
358</code>
359 */
360
361class OVFReader
362{
363public:
364 OVFReader(const iprt::MiniString &path);
365 ~OVFReader();
366
367 void LoopThruSections(const xml::ElementNode *pReferencesElem, const xml::ElementNode *pCurElem);
368 void HandleDiskSection(const xml::ElementNode *pReferencesElem, const xml::ElementNode *pSectionElem);
369 void HandleNetworkSection(const xml::ElementNode *pSectionElem);
370 void HandleVirtualSystemContent(const xml::ElementNode *pContentElem);
371
372 // Data fields
373 iprt::MiniString m_strPath; // file name given to constructor
374 DiskImagesMap m_mapDisks; // map of DiskImage structs, sorted by DiskImage.strDiskId
375 std::list<VirtualSystem> m_llVirtualSystems; // list of virtual systems, created by and valid after read()
376};
377
378////////////////////////////////////////////////////////////////////////////////
379//
380// Errors
381//
382////////////////////////////////////////////////////////////////////////////////
383
384/**
385 * Thrown by OVFReader for any kind of error that is not an XML error but
386 * still makes the OVF impossible to parse. Based on xml::LogicError so
387 * that one catch() for all xml::LogicError can handle all possible errors.
388 */
389
390class OVFLogicError : public xml::LogicError
391{
392public:
393 OVFLogicError(const char *aFormat, ...);
394};
395
396#endif // ____H_OVFREADER
Note: See TracBrowser for help on using the repository browser.

© 2023 Oracle
Contact – Privacy policy – Terms of Use