VirtualBox

source: vbox/trunk/src/VBox/Main/xml/Settings.cpp@ 41914

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

Main: Implement API to configure autostart/-stop for virtual machines
  • Property svn:eol-style set to native
  • Property svn:keywords set to Date Revision Author Id
File size: 209.9 KB
Line 
1/* $Id: Settings.cpp 41914 2012-06-26 09:17:43Z vboxsync $ */
2/** @file
3 * Settings File Manipulation API.
4 *
5 * Two classes, MainConfigFile and MachineConfigFile, represent the VirtualBox.xml and
6 * machine XML files. They share a common ancestor class, ConfigFileBase, which shares
7 * functionality such as talking to the XML back-end classes and settings version management.
8 *
9 * The code can read all VirtualBox settings files version 1.3 and higher. That version was
10 * written by VirtualBox 2.0. It can write settings version 1.7 (used by VirtualBox 2.2 and
11 * 3.0) and 1.9 (used by VirtualBox 3.1) and newer ones obviously.
12 *
13 * The settings versions enum is defined in src/VBox/Main/idl/VirtualBox.xidl. To introduce
14 * a new settings version (should be necessary at most once per VirtualBox major release,
15 * if at all), add a new SettingsVersion value to that enum and grep for the previously
16 * highest value to see which code in here needs adjusting.
17 *
18 * Certainly ConfigFileBase::ConfigFileBase() will. Change VBOX_XML_VERSION below as well.
19 *
20 * Once a new settings version has been added, these are the rules for introducing a new
21 * setting: If an XML element or attribute or value is introduced that was not present in
22 * previous versions, then settings version checks need to be introduced. See the
23 * SettingsVersion enumeration in src/VBox/Main/idl/VirtualBox.xidl for details about which
24 * version was used when.
25 *
26 * The settings versions checks are necessary because since version 3.1, VirtualBox no longer
27 * automatically converts XML settings files but only if necessary, that is, if settings are
28 * present that the old format does not support. If we write an element or attribute to a
29 * settings file of an older version, then an old VirtualBox (before 3.1) will attempt to
30 * validate it with XML schema, and that will certainly fail.
31 *
32 * So, to introduce a new setting:
33 *
34 * 1) Make sure the constructor of corresponding settings structure has a proper default.
35 *
36 * 2) In the settings reader method, try to read the setting; if it's there, great, if not,
37 * the default value will have been set by the constructor. The rule is to be tolerant
38 * here.
39 *
40 * 3) In MachineConfigFile::bumpSettingsVersionIfNeeded(), check if the new setting has
41 * a non-default value (i.e. that differs from the constructor). If so, bump the
42 * settings version to the current version so the settings writer (4) can write out
43 * the non-default value properly.
44 *
45 * So far a corresponding method for MainConfigFile has not been necessary since there
46 * have been no incompatible changes yet.
47 *
48 * 4) In the settings writer method, write the setting _only_ if the current settings
49 * version (stored in m->sv) is high enough. That is, for VirtualBox 4.0, write it
50 * only if (m->sv >= SettingsVersion_v1_11).
51 */
52
53/*
54 * Copyright (C) 2007-2012 Oracle Corporation
55 *
56 * This file is part of VirtualBox Open Source Edition (OSE), as
57 * available from http://www.virtualbox.org. This file is free software;
58 * you can redistribute it and/or modify it under the terms of the GNU
59 * General Public License (GPL) as published by the Free Software
60 * Foundation, in version 2 as it comes in the "COPYING" file of the
61 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
62 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
63 */
64
65#include "VBox/com/string.h"
66#include "VBox/settings.h"
67#include <iprt/cpp/xml.h>
68#include <iprt/stream.h>
69#include <iprt/ctype.h>
70#include <iprt/file.h>
71#include <iprt/process.h>
72#include <iprt/ldr.h>
73#include <iprt/cpp/lock.h>
74
75// generated header
76#include "SchemaDefs.h"
77
78#include "Logging.h"
79#include "HashedPw.h"
80
81using namespace com;
82using namespace settings;
83
84////////////////////////////////////////////////////////////////////////////////
85//
86// Defines
87//
88////////////////////////////////////////////////////////////////////////////////
89
90/** VirtualBox XML settings namespace */
91#define VBOX_XML_NAMESPACE "http://www.innotek.de/VirtualBox-settings"
92
93/** VirtualBox XML settings version number substring ("x.y") */
94#define VBOX_XML_VERSION "1.12"
95
96/** VirtualBox XML settings version platform substring */
97#if defined (RT_OS_DARWIN)
98# define VBOX_XML_PLATFORM "macosx"
99#elif defined (RT_OS_FREEBSD)
100# define VBOX_XML_PLATFORM "freebsd"
101#elif defined (RT_OS_LINUX)
102# define VBOX_XML_PLATFORM "linux"
103#elif defined (RT_OS_NETBSD)
104# define VBOX_XML_PLATFORM "netbsd"
105#elif defined (RT_OS_OPENBSD)
106# define VBOX_XML_PLATFORM "openbsd"
107#elif defined (RT_OS_OS2)
108# define VBOX_XML_PLATFORM "os2"
109#elif defined (RT_OS_SOLARIS)
110# define VBOX_XML_PLATFORM "solaris"
111#elif defined (RT_OS_WINDOWS)
112# define VBOX_XML_PLATFORM "windows"
113#else
114# error Unsupported platform!
115#endif
116
117/** VirtualBox XML settings full version string ("x.y-platform") */
118#define VBOX_XML_VERSION_FULL VBOX_XML_VERSION "-" VBOX_XML_PLATFORM
119
120////////////////////////////////////////////////////////////////////////////////
121//
122// Internal data
123//
124////////////////////////////////////////////////////////////////////////////////
125
126/**
127 * Opaque data structore for ConfigFileBase (only declared
128 * in header, defined only here).
129 */
130
131struct ConfigFileBase::Data
132{
133 Data()
134 : pDoc(NULL),
135 pelmRoot(NULL),
136 sv(SettingsVersion_Null),
137 svRead(SettingsVersion_Null)
138 {}
139
140 ~Data()
141 {
142 cleanup();
143 }
144
145 RTCString strFilename;
146 bool fFileExists;
147
148 xml::Document *pDoc;
149 xml::ElementNode *pelmRoot;
150
151 com::Utf8Str strSettingsVersionFull; // e.g. "1.7-linux"
152 SettingsVersion_T sv; // e.g. SettingsVersion_v1_7
153
154 SettingsVersion_T svRead; // settings version that the original file had when it was read,
155 // or SettingsVersion_Null if none
156
157 void copyFrom(const Data &d)
158 {
159 strFilename = d.strFilename;
160 fFileExists = d.fFileExists;
161 strSettingsVersionFull = d.strSettingsVersionFull;
162 sv = d.sv;
163 svRead = d.svRead;
164 }
165
166 void cleanup()
167 {
168 if (pDoc)
169 {
170 delete pDoc;
171 pDoc = NULL;
172 pelmRoot = NULL;
173 }
174 }
175};
176
177/**
178 * Private exception class (not in the header file) that makes
179 * throwing xml::LogicError instances easier. That class is public
180 * and should be caught by client code.
181 */
182class settings::ConfigFileError : public xml::LogicError
183{
184public:
185 ConfigFileError(const ConfigFileBase *file,
186 const xml::Node *pNode,
187 const char *pcszFormat, ...)
188 : xml::LogicError()
189 {
190 va_list args;
191 va_start(args, pcszFormat);
192 Utf8Str strWhat(pcszFormat, args);
193 va_end(args);
194
195 Utf8Str strLine;
196 if (pNode)
197 strLine = Utf8StrFmt(" (line %RU32)", pNode->getLineNumber());
198
199 const char *pcsz = strLine.c_str();
200 Utf8StrFmt str(N_("Error in %s%s -- %s"),
201 file->m->strFilename.c_str(),
202 (pcsz) ? pcsz : "",
203 strWhat.c_str());
204
205 setWhat(str.c_str());
206 }
207};
208
209////////////////////////////////////////////////////////////////////////////////
210//
211// MediaRegistry
212//
213////////////////////////////////////////////////////////////////////////////////
214
215bool Medium::operator==(const Medium &m) const
216{
217 return (uuid == m.uuid)
218 && (strLocation == m.strLocation)
219 && (strDescription == m.strDescription)
220 && (strFormat == m.strFormat)
221 && (fAutoReset == m.fAutoReset)
222 && (properties == m.properties)
223 && (hdType == m.hdType)
224 && (llChildren== m.llChildren); // this is deep and recurses
225}
226
227bool MediaRegistry::operator==(const MediaRegistry &m) const
228{
229 return llHardDisks == m.llHardDisks
230 && llDvdImages == m.llDvdImages
231 && llFloppyImages == m.llFloppyImages;
232}
233
234////////////////////////////////////////////////////////////////////////////////
235//
236// ConfigFileBase
237//
238////////////////////////////////////////////////////////////////////////////////
239
240/**
241 * Constructor. Allocates the XML internals, parses the XML file if
242 * pstrFilename is != NULL and reads the settings version from it.
243 * @param strFilename
244 */
245ConfigFileBase::ConfigFileBase(const com::Utf8Str *pstrFilename)
246 : m(new Data)
247{
248 Utf8Str strMajor;
249 Utf8Str strMinor;
250
251 m->fFileExists = false;
252
253 if (pstrFilename)
254 {
255 // reading existing settings file:
256 m->strFilename = *pstrFilename;
257
258 xml::XmlFileParser parser;
259 m->pDoc = new xml::Document;
260 parser.read(*pstrFilename,
261 *m->pDoc);
262
263 m->fFileExists = true;
264
265 m->pelmRoot = m->pDoc->getRootElement();
266 if (!m->pelmRoot || !m->pelmRoot->nameEquals("VirtualBox"))
267 throw ConfigFileError(this, NULL, N_("Root element in VirtualBox settings files must be \"VirtualBox\"."));
268
269 if (!(m->pelmRoot->getAttributeValue("version", m->strSettingsVersionFull)))
270 throw ConfigFileError(this, m->pelmRoot, N_("Required VirtualBox/@version attribute is missing"));
271
272 LogRel(("Loading settings file \"%s\" with version \"%s\"\n", m->strFilename.c_str(), m->strSettingsVersionFull.c_str()));
273
274 // parse settings version; allow future versions but fail if file is older than 1.6
275 m->sv = SettingsVersion_Null;
276 if (m->strSettingsVersionFull.length() > 3)
277 {
278 const char *pcsz = m->strSettingsVersionFull.c_str();
279 char c;
280
281 while ( (c = *pcsz)
282 && RT_C_IS_DIGIT(c)
283 )
284 {
285 strMajor.append(c);
286 ++pcsz;
287 }
288
289 if (*pcsz++ == '.')
290 {
291 while ( (c = *pcsz)
292 && RT_C_IS_DIGIT(c)
293 )
294 {
295 strMinor.append(c);
296 ++pcsz;
297 }
298 }
299
300 uint32_t ulMajor = RTStrToUInt32(strMajor.c_str());
301 uint32_t ulMinor = RTStrToUInt32(strMinor.c_str());
302
303 if (ulMajor == 1)
304 {
305 if (ulMinor == 3)
306 m->sv = SettingsVersion_v1_3;
307 else if (ulMinor == 4)
308 m->sv = SettingsVersion_v1_4;
309 else if (ulMinor == 5)
310 m->sv = SettingsVersion_v1_5;
311 else if (ulMinor == 6)
312 m->sv = SettingsVersion_v1_6;
313 else if (ulMinor == 7)
314 m->sv = SettingsVersion_v1_7;
315 else if (ulMinor == 8)
316 m->sv = SettingsVersion_v1_8;
317 else if (ulMinor == 9)
318 m->sv = SettingsVersion_v1_9;
319 else if (ulMinor == 10)
320 m->sv = SettingsVersion_v1_10;
321 else if (ulMinor == 11)
322 m->sv = SettingsVersion_v1_11;
323 else if (ulMinor == 12)
324 m->sv = SettingsVersion_v1_12;
325 else if (ulMinor > 12)
326 m->sv = SettingsVersion_Future;
327 }
328 else if (ulMajor > 1)
329 m->sv = SettingsVersion_Future;
330
331 Log(("Parsed settings version %d.%d to enum value %d\n", ulMajor, ulMinor, m->sv));
332 }
333
334 if (m->sv == SettingsVersion_Null)
335 throw ConfigFileError(this, m->pelmRoot, N_("Cannot handle settings version '%s'"), m->strSettingsVersionFull.c_str());
336
337 // remember the settings version we read in case it gets upgraded later,
338 // so we know when to make backups
339 m->svRead = m->sv;
340 }
341 else
342 {
343 // creating new settings file:
344 m->strSettingsVersionFull = VBOX_XML_VERSION_FULL;
345 m->sv = SettingsVersion_v1_12;
346 }
347}
348
349ConfigFileBase::ConfigFileBase(const ConfigFileBase &other)
350 : m(new Data)
351{
352 copyBaseFrom(other);
353 m->strFilename = "";
354 m->fFileExists = false;
355}
356
357/**
358 * Clean up.
359 */
360ConfigFileBase::~ConfigFileBase()
361{
362 if (m)
363 {
364 delete m;
365 m = NULL;
366 }
367}
368
369/**
370 * Helper function that parses a UUID in string form into
371 * a com::Guid item. Accepts UUIDs both with and without
372 * "{}" brackets. Throws on errors.
373 * @param guid
374 * @param strUUID
375 */
376void ConfigFileBase::parseUUID(Guid &guid,
377 const Utf8Str &strUUID) const
378{
379 guid = strUUID.c_str();
380 if (guid.isEmpty())
381 throw ConfigFileError(this, NULL, N_("UUID \"%s\" has invalid format"), strUUID.c_str());
382}
383
384/**
385 * Parses the given string in str and attempts to treat it as an ISO
386 * date/time stamp to put into timestamp. Throws on errors.
387 * @param timestamp
388 * @param str
389 */
390void ConfigFileBase::parseTimestamp(RTTIMESPEC &timestamp,
391 const com::Utf8Str &str) const
392{
393 const char *pcsz = str.c_str();
394 // yyyy-mm-ddThh:mm:ss
395 // "2009-07-10T11:54:03Z"
396 // 01234567890123456789
397 // 1
398 if (str.length() > 19)
399 {
400 // timezone must either be unspecified or 'Z' for UTC
401 if ( (pcsz[19])
402 && (pcsz[19] != 'Z')
403 )
404 throw ConfigFileError(this, NULL, N_("Cannot handle ISO timestamp '%s': is not UTC date"), str.c_str());
405
406 int32_t yyyy;
407 uint32_t mm, dd, hh, min, secs;
408 if ( (pcsz[4] == '-')
409 && (pcsz[7] == '-')
410 && (pcsz[10] == 'T')
411 && (pcsz[13] == ':')
412 && (pcsz[16] == ':')
413 )
414 {
415 int rc;
416 if ( (RT_SUCCESS(rc = RTStrToInt32Ex(pcsz, NULL, 0, &yyyy)))
417 // could theoretically be negative but let's assume that nobody
418 // created virtual machines before the Christian era
419 && (RT_SUCCESS(rc = RTStrToUInt32Ex(pcsz + 5, NULL, 0, &mm)))
420 && (RT_SUCCESS(rc = RTStrToUInt32Ex(pcsz + 8, NULL, 0, &dd)))
421 && (RT_SUCCESS(rc = RTStrToUInt32Ex(pcsz + 11, NULL, 0, &hh)))
422 && (RT_SUCCESS(rc = RTStrToUInt32Ex(pcsz + 14, NULL, 0, &min)))
423 && (RT_SUCCESS(rc = RTStrToUInt32Ex(pcsz + 17, NULL, 0, &secs)))
424 )
425 {
426 RTTIME time =
427 {
428 yyyy,
429 (uint8_t)mm,
430 0,
431 0,
432 (uint8_t)dd,
433 (uint8_t)hh,
434 (uint8_t)min,
435 (uint8_t)secs,
436 0,
437 RTTIME_FLAGS_TYPE_UTC,
438 0
439 };
440 if (RTTimeNormalize(&time))
441 if (RTTimeImplode(&timestamp, &time))
442 return;
443 }
444
445 throw ConfigFileError(this, NULL, N_("Cannot parse ISO timestamp '%s': runtime error, %Rra"), str.c_str(), rc);
446 }
447
448 throw ConfigFileError(this, NULL, N_("Cannot parse ISO timestamp '%s': invalid format"), str.c_str());
449 }
450}
451
452/**
453 * Helper to create a string for a RTTIMESPEC for writing out ISO timestamps.
454 * @param stamp
455 * @return
456 */
457com::Utf8Str ConfigFileBase::makeString(const RTTIMESPEC &stamp)
458{
459 RTTIME time;
460 if (!RTTimeExplode(&time, &stamp))
461 throw ConfigFileError(this, NULL, N_("Timespec %lld ms is invalid"), RTTimeSpecGetMilli(&stamp));
462
463 return Utf8StrFmt("%04u-%02u-%02uT%02u:%02u:%02uZ",
464 time.i32Year, time.u8Month, time.u8MonthDay,
465 time.u8Hour, time.u8Minute, time.u8Second);
466}
467
468/**
469 * Helper method to read in an ExtraData subtree and stores its contents
470 * in the given map of extradata items. Used for both main and machine
471 * extradata (MainConfigFile and MachineConfigFile).
472 * @param elmExtraData
473 * @param map
474 */
475void ConfigFileBase::readExtraData(const xml::ElementNode &elmExtraData,
476 StringsMap &map)
477{
478 xml::NodesLoop nlLevel4(elmExtraData);
479 const xml::ElementNode *pelmExtraDataItem;
480 while ((pelmExtraDataItem = nlLevel4.forAllNodes()))
481 {
482 if (pelmExtraDataItem->nameEquals("ExtraDataItem"))
483 {
484 // <ExtraDataItem name="GUI/LastWindowPostion" value="97,88,981,858"/>
485 Utf8Str strName, strValue;
486 if ( ((pelmExtraDataItem->getAttributeValue("name", strName)))
487 && ((pelmExtraDataItem->getAttributeValue("value", strValue)))
488 )
489 map[strName] = strValue;
490 else
491 throw ConfigFileError(this, pelmExtraDataItem, N_("Required ExtraDataItem/@name or @value attribute is missing"));
492 }
493 }
494}
495
496/**
497 * Reads <USBDeviceFilter> entries from under the given elmDeviceFilters node and
498 * stores them in the given linklist. This is in ConfigFileBase because it's used
499 * from both MainConfigFile (for host filters) and MachineConfigFile (for machine
500 * filters).
501 * @param elmDeviceFilters
502 * @param ll
503 */
504void ConfigFileBase::readUSBDeviceFilters(const xml::ElementNode &elmDeviceFilters,
505 USBDeviceFiltersList &ll)
506{
507 xml::NodesLoop nl1(elmDeviceFilters, "DeviceFilter");
508 const xml::ElementNode *pelmLevel4Child;
509 while ((pelmLevel4Child = nl1.forAllNodes()))
510 {
511 USBDeviceFilter flt;
512 flt.action = USBDeviceFilterAction_Ignore;
513 Utf8Str strAction;
514 if ( (pelmLevel4Child->getAttributeValue("name", flt.strName))
515 && (pelmLevel4Child->getAttributeValue("active", flt.fActive))
516 )
517 {
518 if (!pelmLevel4Child->getAttributeValue("vendorId", flt.strVendorId))
519 pelmLevel4Child->getAttributeValue("vendorid", flt.strVendorId); // used before 1.3
520 if (!pelmLevel4Child->getAttributeValue("productId", flt.strProductId))
521 pelmLevel4Child->getAttributeValue("productid", flt.strProductId); // used before 1.3
522 pelmLevel4Child->getAttributeValue("revision", flt.strRevision);
523 pelmLevel4Child->getAttributeValue("manufacturer", flt.strManufacturer);
524 pelmLevel4Child->getAttributeValue("product", flt.strProduct);
525 if (!pelmLevel4Child->getAttributeValue("serialNumber", flt.strSerialNumber))
526 pelmLevel4Child->getAttributeValue("serialnumber", flt.strSerialNumber); // used before 1.3
527 pelmLevel4Child->getAttributeValue("port", flt.strPort);
528
529 // the next 2 are irrelevant for host USB objects
530 pelmLevel4Child->getAttributeValue("remote", flt.strRemote);
531 pelmLevel4Child->getAttributeValue("maskedInterfaces", flt.ulMaskedInterfaces);
532
533 // action is only used with host USB objects
534 if (pelmLevel4Child->getAttributeValue("action", strAction))
535 {
536 if (strAction == "Ignore")
537 flt.action = USBDeviceFilterAction_Ignore;
538 else if (strAction == "Hold")
539 flt.action = USBDeviceFilterAction_Hold;
540 else
541 throw ConfigFileError(this, pelmLevel4Child, N_("Invalid value '%s' in DeviceFilter/@action attribute"), strAction.c_str());
542 }
543
544 ll.push_back(flt);
545 }
546 }
547}
548
549/**
550 * Reads a media registry entry from the main VirtualBox.xml file.
551 *
552 * Whereas the current media registry code is fairly straightforward, it was quite a mess
553 * with settings format before 1.4 (VirtualBox 2.0 used settings format 1.3). The elements
554 * in the media registry were much more inconsistent, and different elements were used
555 * depending on the type of device and image.
556 *
557 * @param t
558 * @param elmMedium
559 * @param llMedia
560 */
561void ConfigFileBase::readMedium(MediaType t,
562 const xml::ElementNode &elmMedium, // HardDisk node if root; if recursing,
563 // child HardDisk node or DiffHardDisk node for pre-1.4
564 MediaList &llMedia) // list to append medium to (root disk or child list)
565{
566 // <HardDisk uuid="{5471ecdb-1ddb-4012-a801-6d98e226868b}" location="/mnt/innotek-unix/vdis/Windows XP.vdi" format="VDI" type="Normal">
567 settings::Medium med;
568 Utf8Str strUUID;
569 if (!(elmMedium.getAttributeValue("uuid", strUUID)))
570 throw ConfigFileError(this, &elmMedium, N_("Required %s/@uuid attribute is missing"), elmMedium.getName());
571
572 parseUUID(med.uuid, strUUID);
573
574 bool fNeedsLocation = true;
575
576 if (t == HardDisk)
577 {
578 if (m->sv < SettingsVersion_v1_4)
579 {
580 // here the system is:
581 // <HardDisk uuid="{....}" type="normal">
582 // <VirtualDiskImage filePath="/path/to/xxx.vdi"/>
583 // </HardDisk>
584
585 fNeedsLocation = false;
586 bool fNeedsFilePath = true;
587 const xml::ElementNode *pelmImage;
588 if ((pelmImage = elmMedium.findChildElement("VirtualDiskImage")))
589 med.strFormat = "VDI";
590 else if ((pelmImage = elmMedium.findChildElement("VMDKImage")))
591 med.strFormat = "VMDK";
592 else if ((pelmImage = elmMedium.findChildElement("VHDImage")))
593 med.strFormat = "VHD";
594 else if ((pelmImage = elmMedium.findChildElement("ISCSIHardDisk")))
595 {
596 med.strFormat = "iSCSI";
597
598 fNeedsFilePath = false;
599 // location is special here: current settings specify an "iscsi://user@server:port/target/lun"
600 // string for the location and also have several disk properties for these, whereas this used
601 // to be hidden in several sub-elements before 1.4, so compose a location string and set up
602 // the properties:
603 med.strLocation = "iscsi://";
604 Utf8Str strUser, strServer, strPort, strTarget, strLun;
605 if (pelmImage->getAttributeValue("userName", strUser))
606 {
607 med.strLocation.append(strUser);
608 med.strLocation.append("@");
609 }
610 Utf8Str strServerAndPort;
611 if (pelmImage->getAttributeValue("server", strServer))
612 {
613 strServerAndPort = strServer;
614 }
615 if (pelmImage->getAttributeValue("port", strPort))
616 {
617 if (strServerAndPort.length())
618 strServerAndPort.append(":");
619 strServerAndPort.append(strPort);
620 }
621 med.strLocation.append(strServerAndPort);
622 if (pelmImage->getAttributeValue("target", strTarget))
623 {
624 med.strLocation.append("/");
625 med.strLocation.append(strTarget);
626 }
627 if (pelmImage->getAttributeValue("lun", strLun))
628 {
629 med.strLocation.append("/");
630 med.strLocation.append(strLun);
631 }
632
633 if (strServer.length() && strPort.length())
634 med.properties["TargetAddress"] = strServerAndPort;
635 if (strTarget.length())
636 med.properties["TargetName"] = strTarget;
637 if (strUser.length())
638 med.properties["InitiatorUsername"] = strUser;
639 Utf8Str strPassword;
640 if (pelmImage->getAttributeValue("password", strPassword))
641 med.properties["InitiatorSecret"] = strPassword;
642 if (strLun.length())
643 med.properties["LUN"] = strLun;
644 }
645 else if ((pelmImage = elmMedium.findChildElement("CustomHardDisk")))
646 {
647 fNeedsFilePath = false;
648 fNeedsLocation = true;
649 // also requires @format attribute, which will be queried below
650 }
651 else
652 throw ConfigFileError(this, &elmMedium, N_("Required %s/VirtualDiskImage element is missing"), elmMedium.getName());
653
654 if (fNeedsFilePath)
655 {
656 if (!(pelmImage->getAttributeValuePath("filePath", med.strLocation)))
657 throw ConfigFileError(this, &elmMedium, N_("Required %s/@filePath attribute is missing"), elmMedium.getName());
658 }
659 }
660
661 if (med.strFormat.isEmpty()) // not set with 1.4 format above, or 1.4 Custom format?
662 if (!(elmMedium.getAttributeValue("format", med.strFormat)))
663 throw ConfigFileError(this, &elmMedium, N_("Required %s/@format attribute is missing"), elmMedium.getName());
664
665 if (!(elmMedium.getAttributeValue("autoReset", med.fAutoReset)))
666 med.fAutoReset = false;
667
668 Utf8Str strType;
669 if ((elmMedium.getAttributeValue("type", strType)))
670 {
671 // pre-1.4 used lower case, so make this case-insensitive
672 strType.toUpper();
673 if (strType == "NORMAL")
674 med.hdType = MediumType_Normal;
675 else if (strType == "IMMUTABLE")
676 med.hdType = MediumType_Immutable;
677 else if (strType == "WRITETHROUGH")
678 med.hdType = MediumType_Writethrough;
679 else if (strType == "SHAREABLE")
680 med.hdType = MediumType_Shareable;
681 else if (strType == "READONLY")
682 med.hdType = MediumType_Readonly;
683 else if (strType == "MULTIATTACH")
684 med.hdType = MediumType_MultiAttach;
685 else
686 throw ConfigFileError(this, &elmMedium, N_("HardDisk/@type attribute must be one of Normal, Immutable, Writethrough, Shareable, Readonly or MultiAttach"));
687 }
688 }
689 else
690 {
691 if (m->sv < SettingsVersion_v1_4)
692 {
693 // DVD and floppy images before 1.4 had "src" attribute instead of "location"
694 if (!(elmMedium.getAttributeValue("src", med.strLocation)))
695 throw ConfigFileError(this, &elmMedium, N_("Required %s/@src attribute is missing"), elmMedium.getName());
696
697 fNeedsLocation = false;
698 }
699
700 if (!(elmMedium.getAttributeValue("format", med.strFormat)))
701 {
702 // DVD and floppy images before 1.11 had no format attribute. assign the default.
703 med.strFormat = "RAW";
704 }
705
706 if (t == DVDImage)
707 med.hdType = MediumType_Readonly;
708 else if (t == FloppyImage)
709 med.hdType = MediumType_Writethrough;
710 }
711
712 if (fNeedsLocation)
713 // current files and 1.4 CustomHardDisk elements must have a location attribute
714 if (!(elmMedium.getAttributeValue("location", med.strLocation)))
715 throw ConfigFileError(this, &elmMedium, N_("Required %s/@location attribute is missing"), elmMedium.getName());
716
717 elmMedium.getAttributeValue("Description", med.strDescription); // optional
718
719 // recurse to handle children
720 xml::NodesLoop nl2(elmMedium);
721 const xml::ElementNode *pelmHDChild;
722 while ((pelmHDChild = nl2.forAllNodes()))
723 {
724 if ( t == HardDisk
725 && ( pelmHDChild->nameEquals("HardDisk")
726 || ( (m->sv < SettingsVersion_v1_4)
727 && (pelmHDChild->nameEquals("DiffHardDisk"))
728 )
729 )
730 )
731 // recurse with this element and push the child onto our current children list
732 readMedium(t,
733 *pelmHDChild,
734 med.llChildren);
735 else if (pelmHDChild->nameEquals("Property"))
736 {
737 Utf8Str strPropName, strPropValue;
738 if ( (pelmHDChild->getAttributeValue("name", strPropName))
739 && (pelmHDChild->getAttributeValue("value", strPropValue))
740 )
741 med.properties[strPropName] = strPropValue;
742 else
743 throw ConfigFileError(this, pelmHDChild, N_("Required HardDisk/Property/@name or @value attribute is missing"));
744 }
745 }
746
747 llMedia.push_back(med);
748}
749
750/**
751 * Reads in the entire <MediaRegistry> chunk and stores its media in the lists
752 * of the given MediaRegistry structure.
753 *
754 * This is used in both MainConfigFile and MachineConfigFile since starting with
755 * VirtualBox 4.0, we can have media registries in both.
756 *
757 * For pre-1.4 files, this gets called with the <DiskRegistry> chunk instead.
758 *
759 * @param elmMediaRegistry
760 */
761void ConfigFileBase::readMediaRegistry(const xml::ElementNode &elmMediaRegistry,
762 MediaRegistry &mr)
763{
764 xml::NodesLoop nl1(elmMediaRegistry);
765 const xml::ElementNode *pelmChild1;
766 while ((pelmChild1 = nl1.forAllNodes()))
767 {
768 MediaType t = Error;
769 if (pelmChild1->nameEquals("HardDisks"))
770 t = HardDisk;
771 else if (pelmChild1->nameEquals("DVDImages"))
772 t = DVDImage;
773 else if (pelmChild1->nameEquals("FloppyImages"))
774 t = FloppyImage;
775 else
776 continue;
777
778 xml::NodesLoop nl2(*pelmChild1);
779 const xml::ElementNode *pelmMedium;
780 while ((pelmMedium = nl2.forAllNodes()))
781 {
782 if ( t == HardDisk
783 && (pelmMedium->nameEquals("HardDisk"))
784 )
785 readMedium(t,
786 *pelmMedium,
787 mr.llHardDisks); // list to append hard disk data to: the root list
788 else if ( t == DVDImage
789 && (pelmMedium->nameEquals("Image"))
790 )
791 readMedium(t,
792 *pelmMedium,
793 mr.llDvdImages); // list to append dvd images to: the root list
794 else if ( t == FloppyImage
795 && (pelmMedium->nameEquals("Image"))
796 )
797 readMedium(t,
798 *pelmMedium,
799 mr.llFloppyImages); // list to append floppy images to: the root list
800 }
801 }
802}
803
804/**
805 * Adds a "version" attribute to the given XML element with the
806 * VirtualBox settings version (e.g. "1.10-linux"). Used by
807 * the XML format for the root element and by the OVF export
808 * for the vbox:Machine element.
809 * @param elm
810 */
811void ConfigFileBase::setVersionAttribute(xml::ElementNode &elm)
812{
813 const char *pcszVersion = NULL;
814 switch (m->sv)
815 {
816 case SettingsVersion_v1_8:
817 pcszVersion = "1.8";
818 break;
819
820 case SettingsVersion_v1_9:
821 pcszVersion = "1.9";
822 break;
823
824 case SettingsVersion_v1_10:
825 pcszVersion = "1.10";
826 break;
827
828 case SettingsVersion_v1_11:
829 pcszVersion = "1.11";
830 break;
831
832 case SettingsVersion_v1_12:
833 pcszVersion = "1.12";
834 break;
835
836 case SettingsVersion_v1_13:
837 pcszVersion = "1.13";
838 break;
839
840 case SettingsVersion_Future:
841 // can be set if this code runs on XML files that were created by a future version of VBox;
842 // in that case, downgrade to current version when writing since we can't write future versions...
843 pcszVersion = "1.13";
844 m->sv = SettingsVersion_v1_13;
845 break;
846
847 default:
848 // silently upgrade if this is less than 1.7 because that's the oldest we can write
849 pcszVersion = "1.7";
850 m->sv = SettingsVersion_v1_7;
851 break;
852 }
853
854 elm.setAttribute("version", Utf8StrFmt("%s-%s",
855 pcszVersion,
856 VBOX_XML_PLATFORM)); // e.g. "linux"
857}
858
859/**
860 * Creates a new stub xml::Document in the m->pDoc member with the
861 * root "VirtualBox" element set up. This is used by both
862 * MainConfigFile and MachineConfigFile at the beginning of writing
863 * out their XML.
864 *
865 * Before calling this, it is the responsibility of the caller to
866 * set the "sv" member to the required settings version that is to
867 * be written. For newly created files, the settings version will be
868 * the latest (1.12); for files read in from disk earlier, it will be
869 * the settings version indicated in the file. However, this method
870 * will silently make sure that the settings version is always
871 * at least 1.7 and change it if necessary, since there is no write
872 * support for earlier settings versions.
873 */
874void ConfigFileBase::createStubDocument()
875{
876 Assert(m->pDoc == NULL);
877 m->pDoc = new xml::Document;
878
879 m->pelmRoot = m->pDoc->createRootElement("VirtualBox",
880 "\n"
881 "** DO NOT EDIT THIS FILE.\n"
882 "** If you make changes to this file while any VirtualBox related application\n"
883 "** is running, your changes will be overwritten later, without taking effect.\n"
884 "** Use VBoxManage or the VirtualBox Manager GUI to make changes.\n"
885);
886 m->pelmRoot->setAttribute("xmlns", VBOX_XML_NAMESPACE);
887
888 // add settings version attribute to root element
889 setVersionAttribute(*m->pelmRoot);
890
891 // since this gets called before the XML document is actually written out,
892 // this is where we must check whether we're upgrading the settings version
893 // and need to make a backup, so the user can go back to an earlier
894 // VirtualBox version and recover his old settings files.
895 if ( (m->svRead != SettingsVersion_Null) // old file exists?
896 && (m->svRead < m->sv) // we're upgrading?
897 )
898 {
899 // compose new filename: strip off trailing ".xml"/".vbox"
900 Utf8Str strFilenameNew;
901 Utf8Str strExt = ".xml";
902 if (m->strFilename.endsWith(".xml"))
903 strFilenameNew = m->strFilename.substr(0, m->strFilename.length() - 4);
904 else if (m->strFilename.endsWith(".vbox"))
905 {
906 strFilenameNew = m->strFilename.substr(0, m->strFilename.length() - 5);
907 strExt = ".vbox";
908 }
909
910 // and append something like "-1.3-linux.xml"
911 strFilenameNew.append("-");
912 strFilenameNew.append(m->strSettingsVersionFull); // e.g. "1.3-linux"
913 strFilenameNew.append(strExt); // .xml for main config, .vbox for machine config
914
915 RTFileMove(m->strFilename.c_str(),
916 strFilenameNew.c_str(),
917 0); // no RTFILEMOVE_FLAGS_REPLACE
918
919 // do this only once
920 m->svRead = SettingsVersion_Null;
921 }
922}
923
924/**
925 * Creates an <ExtraData> node under the given parent element with
926 * <ExtraDataItem> childern according to the contents of the given
927 * map.
928 *
929 * This is in ConfigFileBase because it's used in both MainConfigFile
930 * and MachineConfigFile, which both can have extradata.
931 *
932 * @param elmParent
933 * @param me
934 */
935void ConfigFileBase::buildExtraData(xml::ElementNode &elmParent,
936 const StringsMap &me)
937{
938 if (me.size())
939 {
940 xml::ElementNode *pelmExtraData = elmParent.createChild("ExtraData");
941 for (StringsMap::const_iterator it = me.begin();
942 it != me.end();
943 ++it)
944 {
945 const Utf8Str &strName = it->first;
946 const Utf8Str &strValue = it->second;
947 xml::ElementNode *pelmThis = pelmExtraData->createChild("ExtraDataItem");
948 pelmThis->setAttribute("name", strName);
949 pelmThis->setAttribute("value", strValue);
950 }
951 }
952}
953
954/**
955 * Creates <DeviceFilter> nodes under the given parent element according to
956 * the contents of the given USBDeviceFiltersList. This is in ConfigFileBase
957 * because it's used in both MainConfigFile (for host filters) and
958 * MachineConfigFile (for machine filters).
959 *
960 * If fHostMode is true, this means that we're supposed to write filters
961 * for the IHost interface (respect "action", omit "strRemote" and
962 * "ulMaskedInterfaces" in struct USBDeviceFilter).
963 *
964 * @param elmParent
965 * @param ll
966 * @param fHostMode
967 */
968void ConfigFileBase::buildUSBDeviceFilters(xml::ElementNode &elmParent,
969 const USBDeviceFiltersList &ll,
970 bool fHostMode)
971{
972 for (USBDeviceFiltersList::const_iterator it = ll.begin();
973 it != ll.end();
974 ++it)
975 {
976 const USBDeviceFilter &flt = *it;
977 xml::ElementNode *pelmFilter = elmParent.createChild("DeviceFilter");
978 pelmFilter->setAttribute("name", flt.strName);
979 pelmFilter->setAttribute("active", flt.fActive);
980 if (flt.strVendorId.length())
981 pelmFilter->setAttribute("vendorId", flt.strVendorId);
982 if (flt.strProductId.length())
983 pelmFilter->setAttribute("productId", flt.strProductId);
984 if (flt.strRevision.length())
985 pelmFilter->setAttribute("revision", flt.strRevision);
986 if (flt.strManufacturer.length())
987 pelmFilter->setAttribute("manufacturer", flt.strManufacturer);
988 if (flt.strProduct.length())
989 pelmFilter->setAttribute("product", flt.strProduct);
990 if (flt.strSerialNumber.length())
991 pelmFilter->setAttribute("serialNumber", flt.strSerialNumber);
992 if (flt.strPort.length())
993 pelmFilter->setAttribute("port", flt.strPort);
994
995 if (fHostMode)
996 {
997 const char *pcsz =
998 (flt.action == USBDeviceFilterAction_Ignore) ? "Ignore"
999 : /*(flt.action == USBDeviceFilterAction_Hold) ?*/ "Hold";
1000 pelmFilter->setAttribute("action", pcsz);
1001 }
1002 else
1003 {
1004 if (flt.strRemote.length())
1005 pelmFilter->setAttribute("remote", flt.strRemote);
1006 if (flt.ulMaskedInterfaces)
1007 pelmFilter->setAttribute("maskedInterfaces", flt.ulMaskedInterfaces);
1008 }
1009 }
1010}
1011
1012/**
1013 * Creates a single <HardDisk> element for the given Medium structure
1014 * and recurses to write the child hard disks underneath. Called from
1015 * MainConfigFile::write().
1016 *
1017 * @param elmMedium
1018 * @param m
1019 * @param level
1020 */
1021void ConfigFileBase::buildMedium(xml::ElementNode &elmMedium,
1022 DeviceType_T devType,
1023 const Medium &mdm,
1024 uint32_t level) // 0 for "root" call, incremented with each recursion
1025{
1026 xml::ElementNode *pelmMedium;
1027
1028 if (devType == DeviceType_HardDisk)
1029 pelmMedium = elmMedium.createChild("HardDisk");
1030 else
1031 pelmMedium = elmMedium.createChild("Image");
1032
1033 pelmMedium->setAttribute("uuid", mdm.uuid.toStringCurly());
1034
1035 pelmMedium->setAttributePath("location", mdm.strLocation);
1036
1037 if (devType == DeviceType_HardDisk || RTStrICmp(mdm.strFormat.c_str(), "RAW"))
1038 pelmMedium->setAttribute("format", mdm.strFormat);
1039 if ( devType == DeviceType_HardDisk
1040 && mdm.fAutoReset)
1041 pelmMedium->setAttribute("autoReset", mdm.fAutoReset);
1042 if (mdm.strDescription.length())
1043 pelmMedium->setAttribute("Description", mdm.strDescription);
1044
1045 for (StringsMap::const_iterator it = mdm.properties.begin();
1046 it != mdm.properties.end();
1047 ++it)
1048 {
1049 xml::ElementNode *pelmProp = pelmMedium->createChild("Property");
1050 pelmProp->setAttribute("name", it->first);
1051 pelmProp->setAttribute("value", it->second);
1052 }
1053
1054 // only for base hard disks, save the type
1055 if (level == 0)
1056 {
1057 // no need to save the usual DVD/floppy medium types
1058 if ( ( devType != DeviceType_DVD
1059 || ( mdm.hdType != MediumType_Writethrough // shouldn't happen
1060 && mdm.hdType != MediumType_Readonly))
1061 && ( devType != DeviceType_Floppy
1062 || mdm.hdType != MediumType_Writethrough))
1063 {
1064 const char *pcszType =
1065 mdm.hdType == MediumType_Normal ? "Normal" :
1066 mdm.hdType == MediumType_Immutable ? "Immutable" :
1067 mdm.hdType == MediumType_Writethrough ? "Writethrough" :
1068 mdm.hdType == MediumType_Shareable ? "Shareable" :
1069 mdm.hdType == MediumType_Readonly ? "Readonly" :
1070 mdm.hdType == MediumType_MultiAttach ? "MultiAttach" :
1071 "INVALID";
1072 pelmMedium->setAttribute("type", pcszType);
1073 }
1074 }
1075
1076 for (MediaList::const_iterator it = mdm.llChildren.begin();
1077 it != mdm.llChildren.end();
1078 ++it)
1079 {
1080 // recurse for children
1081 buildMedium(*pelmMedium, // parent
1082 devType, // device type
1083 *it, // settings::Medium
1084 ++level); // recursion level
1085 }
1086}
1087
1088/**
1089 * Creates a <MediaRegistry> node under the given parent and writes out all
1090 * hard disks and DVD and floppy images from the lists in the given MediaRegistry
1091 * structure under it.
1092 *
1093 * This is used in both MainConfigFile and MachineConfigFile since starting with
1094 * VirtualBox 4.0, we can have media registries in both.
1095 *
1096 * @param elmParent
1097 * @param mr
1098 */
1099void ConfigFileBase::buildMediaRegistry(xml::ElementNode &elmParent,
1100 const MediaRegistry &mr)
1101{
1102 xml::ElementNode *pelmMediaRegistry = elmParent.createChild("MediaRegistry");
1103
1104 xml::ElementNode *pelmHardDisks = pelmMediaRegistry->createChild("HardDisks");
1105 for (MediaList::const_iterator it = mr.llHardDisks.begin();
1106 it != mr.llHardDisks.end();
1107 ++it)
1108 {
1109 buildMedium(*pelmHardDisks, DeviceType_HardDisk, *it, 0);
1110 }
1111
1112 xml::ElementNode *pelmDVDImages = pelmMediaRegistry->createChild("DVDImages");
1113 for (MediaList::const_iterator it = mr.llDvdImages.begin();
1114 it != mr.llDvdImages.end();
1115 ++it)
1116 {
1117 buildMedium(*pelmDVDImages, DeviceType_DVD, *it, 0);
1118 }
1119
1120 xml::ElementNode *pelmFloppyImages = pelmMediaRegistry->createChild("FloppyImages");
1121 for (MediaList::const_iterator it = mr.llFloppyImages.begin();
1122 it != mr.llFloppyImages.end();
1123 ++it)
1124 {
1125 buildMedium(*pelmFloppyImages, DeviceType_Floppy, *it, 0);
1126 }
1127}
1128
1129/**
1130 * Cleans up memory allocated by the internal XML parser. To be called by
1131 * descendant classes when they're done analyzing the DOM tree to discard it.
1132 */
1133void ConfigFileBase::clearDocument()
1134{
1135 m->cleanup();
1136}
1137
1138/**
1139 * Returns true only if the underlying config file exists on disk;
1140 * either because the file has been loaded from disk, or it's been written
1141 * to disk, or both.
1142 * @return
1143 */
1144bool ConfigFileBase::fileExists()
1145{
1146 return m->fFileExists;
1147}
1148
1149/**
1150 * Copies the base variables from another instance. Used by Machine::saveSettings
1151 * so that the settings version does not get lost when a copy of the Machine settings
1152 * file is made to see if settings have actually changed.
1153 * @param b
1154 */
1155void ConfigFileBase::copyBaseFrom(const ConfigFileBase &b)
1156{
1157 m->copyFrom(*b.m);
1158}
1159
1160////////////////////////////////////////////////////////////////////////////////
1161//
1162// Structures shared between Machine XML and VirtualBox.xml
1163//
1164////////////////////////////////////////////////////////////////////////////////
1165
1166/**
1167 * Comparison operator. This gets called from MachineConfigFile::operator==,
1168 * which in turn gets called from Machine::saveSettings to figure out whether
1169 * machine settings have really changed and thus need to be written out to disk.
1170 */
1171bool USBDeviceFilter::operator==(const USBDeviceFilter &u) const
1172{
1173 return ( (this == &u)
1174 || ( (strName == u.strName)
1175 && (fActive == u.fActive)
1176 && (strVendorId == u.strVendorId)
1177 && (strProductId == u.strProductId)
1178 && (strRevision == u.strRevision)
1179 && (strManufacturer == u.strManufacturer)
1180 && (strProduct == u.strProduct)
1181 && (strSerialNumber == u.strSerialNumber)
1182 && (strPort == u.strPort)
1183 && (action == u.action)
1184 && (strRemote == u.strRemote)
1185 && (ulMaskedInterfaces == u.ulMaskedInterfaces)
1186 )
1187 );
1188}
1189
1190////////////////////////////////////////////////////////////////////////////////
1191//
1192// MainConfigFile
1193//
1194////////////////////////////////////////////////////////////////////////////////
1195
1196/**
1197 * Reads one <MachineEntry> from the main VirtualBox.xml file.
1198 * @param elmMachineRegistry
1199 */
1200void MainConfigFile::readMachineRegistry(const xml::ElementNode &elmMachineRegistry)
1201{
1202 // <MachineEntry uuid="{ xxx }" src=" xxx "/>
1203 xml::NodesLoop nl1(elmMachineRegistry);
1204 const xml::ElementNode *pelmChild1;
1205 while ((pelmChild1 = nl1.forAllNodes()))
1206 {
1207 if (pelmChild1->nameEquals("MachineEntry"))
1208 {
1209 MachineRegistryEntry mre;
1210 Utf8Str strUUID;
1211 if ( ((pelmChild1->getAttributeValue("uuid", strUUID)))
1212 && ((pelmChild1->getAttributeValue("src", mre.strSettingsFile)))
1213 )
1214 {
1215 parseUUID(mre.uuid, strUUID);
1216 llMachines.push_back(mre);
1217 }
1218 else
1219 throw ConfigFileError(this, pelmChild1, N_("Required MachineEntry/@uuid or @src attribute is missing"));
1220 }
1221 }
1222}
1223
1224/**
1225 * Reads in the <DHCPServers> chunk.
1226 * @param elmDHCPServers
1227 */
1228void MainConfigFile::readDHCPServers(const xml::ElementNode &elmDHCPServers)
1229{
1230 xml::NodesLoop nl1(elmDHCPServers);
1231 const xml::ElementNode *pelmServer;
1232 while ((pelmServer = nl1.forAllNodes()))
1233 {
1234 if (pelmServer->nameEquals("DHCPServer"))
1235 {
1236 DHCPServer srv;
1237 if ( (pelmServer->getAttributeValue("networkName", srv.strNetworkName))
1238 && (pelmServer->getAttributeValue("IPAddress", srv.strIPAddress))
1239 && (pelmServer->getAttributeValue("networkMask", srv.strIPNetworkMask))
1240 && (pelmServer->getAttributeValue("lowerIP", srv.strIPLower))
1241 && (pelmServer->getAttributeValue("upperIP", srv.strIPUpper))
1242 && (pelmServer->getAttributeValue("enabled", srv.fEnabled))
1243 )
1244 llDhcpServers.push_back(srv);
1245 else
1246 throw ConfigFileError(this, pelmServer, N_("Required DHCPServer/@networkName, @IPAddress, @networkMask, @lowerIP, @upperIP or @enabled attribute is missing"));
1247 }
1248 }
1249}
1250
1251/**
1252 * Constructor.
1253 *
1254 * If pstrFilename is != NULL, this reads the given settings file into the member
1255 * variables and various substructures and lists. Otherwise, the member variables
1256 * are initialized with default values.
1257 *
1258 * Throws variants of xml::Error for I/O, XML and logical content errors, which
1259 * the caller should catch; if this constructor does not throw, then the member
1260 * variables contain meaningful values (either from the file or defaults).
1261 *
1262 * @param strFilename
1263 */
1264MainConfigFile::MainConfigFile(const Utf8Str *pstrFilename)
1265 : ConfigFileBase(pstrFilename)
1266{
1267 if (pstrFilename)
1268 {
1269 // the ConfigFileBase constructor has loaded the XML file, so now
1270 // we need only analyze what is in there
1271 xml::NodesLoop nlRootChildren(*m->pelmRoot);
1272 const xml::ElementNode *pelmRootChild;
1273 while ((pelmRootChild = nlRootChildren.forAllNodes()))
1274 {
1275 if (pelmRootChild->nameEquals("Global"))
1276 {
1277 xml::NodesLoop nlGlobalChildren(*pelmRootChild);
1278 const xml::ElementNode *pelmGlobalChild;
1279 while ((pelmGlobalChild = nlGlobalChildren.forAllNodes()))
1280 {
1281 if (pelmGlobalChild->nameEquals("SystemProperties"))
1282 {
1283 pelmGlobalChild->getAttributeValue("defaultMachineFolder", systemProperties.strDefaultMachineFolder);
1284 pelmGlobalChild->getAttributeValue("defaultHardDiskFormat", systemProperties.strDefaultHardDiskFormat);
1285 if (!pelmGlobalChild->getAttributeValue("VRDEAuthLibrary", systemProperties.strVRDEAuthLibrary))
1286 // pre-1.11 used @remoteDisplayAuthLibrary instead
1287 pelmGlobalChild->getAttributeValue("remoteDisplayAuthLibrary", systemProperties.strVRDEAuthLibrary);
1288 pelmGlobalChild->getAttributeValue("webServiceAuthLibrary", systemProperties.strWebServiceAuthLibrary);
1289 pelmGlobalChild->getAttributeValue("defaultVRDEExtPack", systemProperties.strDefaultVRDEExtPack);
1290 pelmGlobalChild->getAttributeValue("LogHistoryCount", systemProperties.ulLogHistoryCount);
1291 }
1292 else if (pelmGlobalChild->nameEquals("ExtraData"))
1293 readExtraData(*pelmGlobalChild, mapExtraDataItems);
1294 else if (pelmGlobalChild->nameEquals("MachineRegistry"))
1295 readMachineRegistry(*pelmGlobalChild);
1296 else if ( (pelmGlobalChild->nameEquals("MediaRegistry"))
1297 || ( (m->sv < SettingsVersion_v1_4)
1298 && (pelmGlobalChild->nameEquals("DiskRegistry"))
1299 )
1300 )
1301 readMediaRegistry(*pelmGlobalChild, mediaRegistry);
1302 else if (pelmGlobalChild->nameEquals("NetserviceRegistry"))
1303 {
1304 xml::NodesLoop nlLevel4(*pelmGlobalChild);
1305 const xml::ElementNode *pelmLevel4Child;
1306 while ((pelmLevel4Child = nlLevel4.forAllNodes()))
1307 {
1308 if (pelmLevel4Child->nameEquals("DHCPServers"))
1309 readDHCPServers(*pelmLevel4Child);
1310 }
1311 }
1312 else if (pelmGlobalChild->nameEquals("USBDeviceFilters"))
1313 readUSBDeviceFilters(*pelmGlobalChild, host.llUSBDeviceFilters);
1314 }
1315 } // end if (pelmRootChild->nameEquals("Global"))
1316 }
1317
1318 clearDocument();
1319 }
1320
1321 // DHCP servers were introduced with settings version 1.7; if we're loading
1322 // from an older version OR this is a fresh install, then add one DHCP server
1323 // with default settings
1324 if ( (!llDhcpServers.size())
1325 && ( (!pstrFilename) // empty VirtualBox.xml file
1326 || (m->sv < SettingsVersion_v1_7) // upgrading from before 1.7
1327 )
1328 )
1329 {
1330 DHCPServer srv;
1331 srv.strNetworkName =
1332#ifdef RT_OS_WINDOWS
1333 "HostInterfaceNetworking-VirtualBox Host-Only Ethernet Adapter";
1334#else
1335 "HostInterfaceNetworking-vboxnet0";
1336#endif
1337 srv.strIPAddress = "192.168.56.100";
1338 srv.strIPNetworkMask = "255.255.255.0";
1339 srv.strIPLower = "192.168.56.101";
1340 srv.strIPUpper = "192.168.56.254";
1341 srv.fEnabled = true;
1342 llDhcpServers.push_back(srv);
1343 }
1344}
1345
1346/**
1347 * Called from the IVirtualBox interface to write out VirtualBox.xml. This
1348 * builds an XML DOM tree and writes it out to disk.
1349 */
1350void MainConfigFile::write(const com::Utf8Str strFilename)
1351{
1352 m->strFilename = strFilename;
1353 createStubDocument();
1354
1355 xml::ElementNode *pelmGlobal = m->pelmRoot->createChild("Global");
1356
1357 buildExtraData(*pelmGlobal, mapExtraDataItems);
1358
1359 xml::ElementNode *pelmMachineRegistry = pelmGlobal->createChild("MachineRegistry");
1360 for (MachinesRegistry::const_iterator it = llMachines.begin();
1361 it != llMachines.end();
1362 ++it)
1363 {
1364 // <MachineEntry uuid="{5f102a55-a51b-48e3-b45a-b28d33469488}" src="/mnt/innotek-unix/vbox-machines/Windows 5.1 XP 1 (Office 2003)/Windows 5.1 XP 1 (Office 2003).xml"/>
1365 const MachineRegistryEntry &mre = *it;
1366 xml::ElementNode *pelmMachineEntry = pelmMachineRegistry->createChild("MachineEntry");
1367 pelmMachineEntry->setAttribute("uuid", mre.uuid.toStringCurly());
1368 pelmMachineEntry->setAttribute("src", mre.strSettingsFile);
1369 }
1370
1371 buildMediaRegistry(*pelmGlobal, mediaRegistry);
1372
1373 xml::ElementNode *pelmNetserviceRegistry = pelmGlobal->createChild("NetserviceRegistry");
1374 xml::ElementNode *pelmDHCPServers = pelmNetserviceRegistry->createChild("DHCPServers");
1375 for (DHCPServersList::const_iterator it = llDhcpServers.begin();
1376 it != llDhcpServers.end();
1377 ++it)
1378 {
1379 const DHCPServer &d = *it;
1380 xml::ElementNode *pelmThis = pelmDHCPServers->createChild("DHCPServer");
1381 pelmThis->setAttribute("networkName", d.strNetworkName);
1382 pelmThis->setAttribute("IPAddress", d.strIPAddress);
1383 pelmThis->setAttribute("networkMask", d.strIPNetworkMask);
1384 pelmThis->setAttribute("lowerIP", d.strIPLower);
1385 pelmThis->setAttribute("upperIP", d.strIPUpper);
1386 pelmThis->setAttribute("enabled", (d.fEnabled) ? 1 : 0); // too bad we chose 1 vs. 0 here
1387 }
1388
1389 xml::ElementNode *pelmSysProps = pelmGlobal->createChild("SystemProperties");
1390 if (systemProperties.strDefaultMachineFolder.length())
1391 pelmSysProps->setAttribute("defaultMachineFolder", systemProperties.strDefaultMachineFolder);
1392 if (systemProperties.strDefaultHardDiskFormat.length())
1393 pelmSysProps->setAttribute("defaultHardDiskFormat", systemProperties.strDefaultHardDiskFormat);
1394 if (systemProperties.strVRDEAuthLibrary.length())
1395 pelmSysProps->setAttribute("VRDEAuthLibrary", systemProperties.strVRDEAuthLibrary);
1396 if (systemProperties.strWebServiceAuthLibrary.length())
1397 pelmSysProps->setAttribute("webServiceAuthLibrary", systemProperties.strWebServiceAuthLibrary);
1398 if (systemProperties.strDefaultVRDEExtPack.length())
1399 pelmSysProps->setAttribute("defaultVRDEExtPack", systemProperties.strDefaultVRDEExtPack);
1400 pelmSysProps->setAttribute("LogHistoryCount", systemProperties.ulLogHistoryCount);
1401
1402 buildUSBDeviceFilters(*pelmGlobal->createChild("USBDeviceFilters"),
1403 host.llUSBDeviceFilters,
1404 true); // fHostMode
1405
1406 // now go write the XML
1407 xml::XmlFileWriter writer(*m->pDoc);
1408 writer.write(m->strFilename.c_str(), true /*fSafe*/);
1409
1410 m->fFileExists = true;
1411
1412 clearDocument();
1413}
1414
1415////////////////////////////////////////////////////////////////////////////////
1416//
1417// Machine XML structures
1418//
1419////////////////////////////////////////////////////////////////////////////////
1420
1421/**
1422 * Comparison operator. This gets called from MachineConfigFile::operator==,
1423 * which in turn gets called from Machine::saveSettings to figure out whether
1424 * machine settings have really changed and thus need to be written out to disk.
1425 */
1426bool VRDESettings::operator==(const VRDESettings& v) const
1427{
1428 return ( (this == &v)
1429 || ( (fEnabled == v.fEnabled)
1430 && (authType == v.authType)
1431 && (ulAuthTimeout == v.ulAuthTimeout)
1432 && (strAuthLibrary == v.strAuthLibrary)
1433 && (fAllowMultiConnection == v.fAllowMultiConnection)
1434 && (fReuseSingleConnection == v.fReuseSingleConnection)
1435 && (strVrdeExtPack == v.strVrdeExtPack)
1436 && (mapProperties == v.mapProperties)
1437 )
1438 );
1439}
1440
1441/**
1442 * Comparison operator. This gets called from MachineConfigFile::operator==,
1443 * which in turn gets called from Machine::saveSettings to figure out whether
1444 * machine settings have really changed and thus need to be written out to disk.
1445 */
1446bool BIOSSettings::operator==(const BIOSSettings &d) const
1447{
1448 return ( (this == &d)
1449 || ( fACPIEnabled == d.fACPIEnabled
1450 && fIOAPICEnabled == d.fIOAPICEnabled
1451 && fLogoFadeIn == d.fLogoFadeIn
1452 && fLogoFadeOut == d.fLogoFadeOut
1453 && ulLogoDisplayTime == d.ulLogoDisplayTime
1454 && strLogoImagePath == d.strLogoImagePath
1455 && biosBootMenuMode == d.biosBootMenuMode
1456 && fPXEDebugEnabled == d.fPXEDebugEnabled
1457 && llTimeOffset == d.llTimeOffset)
1458 );
1459}
1460
1461/**
1462 * Comparison operator. This gets called from MachineConfigFile::operator==,
1463 * which in turn gets called from Machine::saveSettings to figure out whether
1464 * machine settings have really changed and thus need to be written out to disk.
1465 */
1466bool USBController::operator==(const USBController &u) const
1467{
1468 return ( (this == &u)
1469 || ( (fEnabled == u.fEnabled)
1470 && (fEnabledEHCI == u.fEnabledEHCI)
1471 && (llDeviceFilters == u.llDeviceFilters)
1472 )
1473 );
1474}
1475
1476/**
1477 * Comparison operator. This gets called from MachineConfigFile::operator==,
1478 * which in turn gets called from Machine::saveSettings to figure out whether
1479 * machine settings have really changed and thus need to be written out to disk.
1480 */
1481bool NetworkAdapter::operator==(const NetworkAdapter &n) const
1482{
1483 return ( (this == &n)
1484 || ( (ulSlot == n.ulSlot)
1485 && (type == n.type)
1486 && (fEnabled == n.fEnabled)
1487 && (strMACAddress == n.strMACAddress)
1488 && (fCableConnected == n.fCableConnected)
1489 && (ulLineSpeed == n.ulLineSpeed)
1490 && (enmPromiscModePolicy == n.enmPromiscModePolicy)
1491 && (fTraceEnabled == n.fTraceEnabled)
1492 && (strTraceFile == n.strTraceFile)
1493 && (mode == n.mode)
1494 && (nat == n.nat)
1495 && (strBridgedName == n.strBridgedName)
1496 && (strHostOnlyName == n.strHostOnlyName)
1497 && (strInternalNetworkName == n.strInternalNetworkName)
1498 && (strGenericDriver == n.strGenericDriver)
1499 && (genericProperties == n.genericProperties)
1500 && (ulBootPriority == n.ulBootPriority)
1501 && (strBandwidthGroup == n.strBandwidthGroup)
1502 )
1503 );
1504}
1505
1506/**
1507 * Comparison operator. This gets called from MachineConfigFile::operator==,
1508 * which in turn gets called from Machine::saveSettings to figure out whether
1509 * machine settings have really changed and thus need to be written out to disk.
1510 */
1511bool SerialPort::operator==(const SerialPort &s) const
1512{
1513 return ( (this == &s)
1514 || ( (ulSlot == s.ulSlot)
1515 && (fEnabled == s.fEnabled)
1516 && (ulIOBase == s.ulIOBase)
1517 && (ulIRQ == s.ulIRQ)
1518 && (portMode == s.portMode)
1519 && (strPath == s.strPath)
1520 && (fServer == s.fServer)
1521 )
1522 );
1523}
1524
1525/**
1526 * Comparison operator. This gets called from MachineConfigFile::operator==,
1527 * which in turn gets called from Machine::saveSettings to figure out whether
1528 * machine settings have really changed and thus need to be written out to disk.
1529 */
1530bool ParallelPort::operator==(const ParallelPort &s) const
1531{
1532 return ( (this == &s)
1533 || ( (ulSlot == s.ulSlot)
1534 && (fEnabled == s.fEnabled)
1535 && (ulIOBase == s.ulIOBase)
1536 && (ulIRQ == s.ulIRQ)
1537 && (strPath == s.strPath)
1538 )
1539 );
1540}
1541
1542/**
1543 * Comparison operator. This gets called from MachineConfigFile::operator==,
1544 * which in turn gets called from Machine::saveSettings to figure out whether
1545 * machine settings have really changed and thus need to be written out to disk.
1546 */
1547bool SharedFolder::operator==(const SharedFolder &g) const
1548{
1549 return ( (this == &g)
1550 || ( (strName == g.strName)
1551 && (strHostPath == g.strHostPath)
1552 && (fWritable == g.fWritable)
1553 && (fAutoMount == g.fAutoMount)
1554 )
1555 );
1556}
1557
1558/**
1559 * Comparison operator. This gets called from MachineConfigFile::operator==,
1560 * which in turn gets called from Machine::saveSettings to figure out whether
1561 * machine settings have really changed and thus need to be written out to disk.
1562 */
1563bool GuestProperty::operator==(const GuestProperty &g) const
1564{
1565 return ( (this == &g)
1566 || ( (strName == g.strName)
1567 && (strValue == g.strValue)
1568 && (timestamp == g.timestamp)
1569 && (strFlags == g.strFlags)
1570 )
1571 );
1572}
1573
1574// use a define for the platform-dependent default value of
1575// hwvirt exclusivity, since we'll need to check that value
1576// in bumpSettingsVersionIfNeeded()
1577#if defined(RT_OS_DARWIN) || defined(RT_OS_WINDOWS)
1578 #define HWVIRTEXCLUSIVEDEFAULT false
1579#else
1580 #define HWVIRTEXCLUSIVEDEFAULT true
1581#endif
1582
1583/**
1584 * Hardware struct constructor.
1585 */
1586Hardware::Hardware()
1587 : strVersion("1"),
1588 fHardwareVirt(true),
1589 fHardwareVirtExclusive(HWVIRTEXCLUSIVEDEFAULT),
1590 fNestedPaging(true),
1591 fVPID(true),
1592 fHardwareVirtForce(false),
1593 fSyntheticCpu(false),
1594 fPAE(false),
1595 cCPUs(1),
1596 fCpuHotPlug(false),
1597 fHpetEnabled(false),
1598 ulCpuExecutionCap(100),
1599 ulMemorySizeMB((uint32_t)-1),
1600 ulVRAMSizeMB(8),
1601 cMonitors(1),
1602 fAccelerate3D(false),
1603 fAccelerate2DVideo(false),
1604 firmwareType(FirmwareType_BIOS),
1605 pointingHidType(PointingHidType_PS2Mouse),
1606 keyboardHidType(KeyboardHidType_PS2Keyboard),
1607 chipsetType(ChipsetType_PIIX3),
1608 fEmulatedUSBCardReader(false),
1609 clipboardMode(ClipboardMode_Bidirectional),
1610 ulMemoryBalloonSize(0),
1611 fPageFusionEnabled(false)
1612{
1613 mapBootOrder[0] = DeviceType_Floppy;
1614 mapBootOrder[1] = DeviceType_DVD;
1615 mapBootOrder[2] = DeviceType_HardDisk;
1616
1617 /* The default value for PAE depends on the host:
1618 * - 64 bits host -> always true
1619 * - 32 bits host -> true for Windows & Darwin (masked off if the host cpu doesn't support it anyway)
1620 */
1621#if HC_ARCH_BITS == 64 || defined(RT_OS_WINDOWS) || defined(RT_OS_DARWIN)
1622 fPAE = true;
1623#endif
1624
1625 /* The default value of large page supports depends on the host:
1626 * - 64 bits host -> true, unless it's Linux (pending further prediction work due to excessively expensive large page allocations)
1627 * - 32 bits host -> false
1628 */
1629#if HC_ARCH_BITS == 64 && !defined(RT_OS_LINUX)
1630 fLargePages = true;
1631#else
1632 /* Not supported on 32 bits hosts. */
1633 fLargePages = false;
1634#endif
1635}
1636
1637/**
1638 * Comparison operator. This gets called from MachineConfigFile::operator==,
1639 * which in turn gets called from Machine::saveSettings to figure out whether
1640 * machine settings have really changed and thus need to be written out to disk.
1641 */
1642bool Hardware::operator==(const Hardware& h) const
1643{
1644 return ( (this == &h)
1645 || ( (strVersion == h.strVersion)
1646 && (uuid == h.uuid)
1647 && (fHardwareVirt == h.fHardwareVirt)
1648 && (fHardwareVirtExclusive == h.fHardwareVirtExclusive)
1649 && (fNestedPaging == h.fNestedPaging)
1650 && (fLargePages == h.fLargePages)
1651 && (fVPID == h.fVPID)
1652 && (fHardwareVirtForce == h.fHardwareVirtForce)
1653 && (fSyntheticCpu == h.fSyntheticCpu)
1654 && (fPAE == h.fPAE)
1655 && (cCPUs == h.cCPUs)
1656 && (fCpuHotPlug == h.fCpuHotPlug)
1657 && (ulCpuExecutionCap == h.ulCpuExecutionCap)
1658 && (fHpetEnabled == h.fHpetEnabled)
1659 && (llCpus == h.llCpus)
1660 && (llCpuIdLeafs == h.llCpuIdLeafs)
1661 && (ulMemorySizeMB == h.ulMemorySizeMB)
1662 && (mapBootOrder == h.mapBootOrder)
1663 && (ulVRAMSizeMB == h.ulVRAMSizeMB)
1664 && (cMonitors == h.cMonitors)
1665 && (fAccelerate3D == h.fAccelerate3D)
1666 && (fAccelerate2DVideo == h.fAccelerate2DVideo)
1667 && (firmwareType == h.firmwareType)
1668 && (pointingHidType == h.pointingHidType)
1669 && (keyboardHidType == h.keyboardHidType)
1670 && (chipsetType == h.chipsetType)
1671 && (fEmulatedUSBCardReader == h.fEmulatedUSBCardReader)
1672 && (vrdeSettings == h.vrdeSettings)
1673 && (biosSettings == h.biosSettings)
1674 && (usbController == h.usbController)
1675 && (llNetworkAdapters == h.llNetworkAdapters)
1676 && (llSerialPorts == h.llSerialPorts)
1677 && (llParallelPorts == h.llParallelPorts)
1678 && (audioAdapter == h.audioAdapter)
1679 && (llSharedFolders == h.llSharedFolders)
1680 && (clipboardMode == h.clipboardMode)
1681 && (ulMemoryBalloonSize == h.ulMemoryBalloonSize)
1682 && (fPageFusionEnabled == h.fPageFusionEnabled)
1683 && (llGuestProperties == h.llGuestProperties)
1684 && (strNotificationPatterns == h.strNotificationPatterns)
1685 && (ioSettings == h.ioSettings)
1686 && (pciAttachments == h.pciAttachments)
1687 )
1688 );
1689}
1690
1691/**
1692 * Comparison operator. This gets called from MachineConfigFile::operator==,
1693 * which in turn gets called from Machine::saveSettings to figure out whether
1694 * machine settings have really changed and thus need to be written out to disk.
1695 */
1696bool AttachedDevice::operator==(const AttachedDevice &a) const
1697{
1698 return ( (this == &a)
1699 || ( (deviceType == a.deviceType)
1700 && (fPassThrough == a.fPassThrough)
1701 && (fTempEject == a.fTempEject)
1702 && (fNonRotational == a.fNonRotational)
1703 && (fDiscard == a.fDiscard)
1704 && (lPort == a.lPort)
1705 && (lDevice == a.lDevice)
1706 && (uuid == a.uuid)
1707 && (strHostDriveSrc == a.strHostDriveSrc)
1708 && (strBwGroup == a.strBwGroup)
1709 )
1710 );
1711}
1712
1713/**
1714 * Comparison operator. This gets called from MachineConfigFile::operator==,
1715 * which in turn gets called from Machine::saveSettings to figure out whether
1716 * machine settings have really changed and thus need to be written out to disk.
1717 */
1718bool StorageController::operator==(const StorageController &s) const
1719{
1720 return ( (this == &s)
1721 || ( (strName == s.strName)
1722 && (storageBus == s.storageBus)
1723 && (controllerType == s.controllerType)
1724 && (ulPortCount == s.ulPortCount)
1725 && (ulInstance == s.ulInstance)
1726 && (fUseHostIOCache == s.fUseHostIOCache)
1727 && (lIDE0MasterEmulationPort == s.lIDE0MasterEmulationPort)
1728 && (lIDE0SlaveEmulationPort == s.lIDE0SlaveEmulationPort)
1729 && (lIDE1MasterEmulationPort == s.lIDE1MasterEmulationPort)
1730 && (lIDE1SlaveEmulationPort == s.lIDE1SlaveEmulationPort)
1731 && (llAttachedDevices == s.llAttachedDevices)
1732 )
1733 );
1734}
1735
1736/**
1737 * Comparison operator. This gets called from MachineConfigFile::operator==,
1738 * which in turn gets called from Machine::saveSettings to figure out whether
1739 * machine settings have really changed and thus need to be written out to disk.
1740 */
1741bool Storage::operator==(const Storage &s) const
1742{
1743 return ( (this == &s)
1744 || (llStorageControllers == s.llStorageControllers) // deep compare
1745 );
1746}
1747
1748/**
1749 * Comparison operator. This gets called from MachineConfigFile::operator==,
1750 * which in turn gets called from Machine::saveSettings to figure out whether
1751 * machine settings have really changed and thus need to be written out to disk.
1752 */
1753bool Snapshot::operator==(const Snapshot &s) const
1754{
1755 return ( (this == &s)
1756 || ( (uuid == s.uuid)
1757 && (strName == s.strName)
1758 && (strDescription == s.strDescription)
1759 && (RTTimeSpecIsEqual(&timestamp, &s.timestamp))
1760 && (strStateFile == s.strStateFile)
1761 && (hardware == s.hardware) // deep compare
1762 && (storage == s.storage) // deep compare
1763 && (llChildSnapshots == s.llChildSnapshots) // deep compare
1764 && debugging == s.debugging
1765 && autostart == s.autostart
1766 )
1767 );
1768}
1769
1770/**
1771 * IoSettings constructor.
1772 */
1773IoSettings::IoSettings()
1774{
1775 fIoCacheEnabled = true;
1776 ulIoCacheSize = 5;
1777}
1778
1779////////////////////////////////////////////////////////////////////////////////
1780//
1781// MachineConfigFile
1782//
1783////////////////////////////////////////////////////////////////////////////////
1784
1785/**
1786 * Constructor.
1787 *
1788 * If pstrFilename is != NULL, this reads the given settings file into the member
1789 * variables and various substructures and lists. Otherwise, the member variables
1790 * are initialized with default values.
1791 *
1792 * Throws variants of xml::Error for I/O, XML and logical content errors, which
1793 * the caller should catch; if this constructor does not throw, then the member
1794 * variables contain meaningful values (either from the file or defaults).
1795 *
1796 * @param strFilename
1797 */
1798MachineConfigFile::MachineConfigFile(const Utf8Str *pstrFilename)
1799 : ConfigFileBase(pstrFilename),
1800 fCurrentStateModified(true),
1801 fAborted(false)
1802{
1803 RTTimeNow(&timeLastStateChange);
1804
1805 if (pstrFilename)
1806 {
1807 // the ConfigFileBase constructor has loaded the XML file, so now
1808 // we need only analyze what is in there
1809
1810 xml::NodesLoop nlRootChildren(*m->pelmRoot);
1811 const xml::ElementNode *pelmRootChild;
1812 while ((pelmRootChild = nlRootChildren.forAllNodes()))
1813 {
1814 if (pelmRootChild->nameEquals("Machine"))
1815 readMachine(*pelmRootChild);
1816 }
1817
1818 // clean up memory allocated by XML engine
1819 clearDocument();
1820 }
1821}
1822
1823/**
1824 * Public routine which returns true if this machine config file can have its
1825 * own media registry (which is true for settings version v1.11 and higher,
1826 * i.e. files created by VirtualBox 4.0 and higher).
1827 * @return
1828 */
1829bool MachineConfigFile::canHaveOwnMediaRegistry() const
1830{
1831 return (m->sv >= SettingsVersion_v1_11);
1832}
1833
1834/**
1835 * Public routine which allows for importing machine XML from an external DOM tree.
1836 * Use this after having called the constructor with a NULL argument.
1837 *
1838 * This is used by the OVF code if a <vbox:Machine> element has been encountered
1839 * in an OVF VirtualSystem element.
1840 *
1841 * @param elmMachine
1842 */
1843void MachineConfigFile::importMachineXML(const xml::ElementNode &elmMachine)
1844{
1845 readMachine(elmMachine);
1846}
1847
1848/**
1849 * Comparison operator. This gets called from Machine::saveSettings to figure out
1850 * whether machine settings have really changed and thus need to be written out to disk.
1851 *
1852 * Even though this is called operator==, this does NOT compare all fields; the "equals"
1853 * should be understood as "has the same machine config as". The following fields are
1854 * NOT compared:
1855 * -- settings versions and file names inherited from ConfigFileBase;
1856 * -- fCurrentStateModified because that is considered separately in Machine::saveSettings!!
1857 *
1858 * The "deep" comparisons marked below will invoke the operator== functions of the
1859 * structs defined in this file, which may in turn go into comparing lists of
1860 * other structures. As a result, invoking this can be expensive, but it's
1861 * less expensive than writing out XML to disk.
1862 */
1863bool MachineConfigFile::operator==(const MachineConfigFile &c) const
1864{
1865 return ( (this == &c)
1866 || ( (uuid == c.uuid)
1867 && (machineUserData == c.machineUserData)
1868 && (strStateFile == c.strStateFile)
1869 && (uuidCurrentSnapshot == c.uuidCurrentSnapshot)
1870 // skip fCurrentStateModified!
1871 && (RTTimeSpecIsEqual(&timeLastStateChange, &c.timeLastStateChange))
1872 && (fAborted == c.fAborted)
1873 && (hardwareMachine == c.hardwareMachine) // this one's deep
1874 && (storageMachine == c.storageMachine) // this one's deep
1875 && (mediaRegistry == c.mediaRegistry) // this one's deep
1876 && (mapExtraDataItems == c.mapExtraDataItems) // this one's deep
1877 && (llFirstSnapshot == c.llFirstSnapshot) // this one's deep
1878 )
1879 );
1880}
1881
1882/**
1883 * Called from MachineConfigFile::readHardware() to read cpu information.
1884 * @param elmCpuid
1885 * @param ll
1886 */
1887void MachineConfigFile::readCpuTree(const xml::ElementNode &elmCpu,
1888 CpuList &ll)
1889{
1890 xml::NodesLoop nl1(elmCpu, "Cpu");
1891 const xml::ElementNode *pelmCpu;
1892 while ((pelmCpu = nl1.forAllNodes()))
1893 {
1894 Cpu cpu;
1895
1896 if (!pelmCpu->getAttributeValue("id", cpu.ulId))
1897 throw ConfigFileError(this, pelmCpu, N_("Required Cpu/@id attribute is missing"));
1898
1899 ll.push_back(cpu);
1900 }
1901}
1902
1903/**
1904 * Called from MachineConfigFile::readHardware() to cpuid information.
1905 * @param elmCpuid
1906 * @param ll
1907 */
1908void MachineConfigFile::readCpuIdTree(const xml::ElementNode &elmCpuid,
1909 CpuIdLeafsList &ll)
1910{
1911 xml::NodesLoop nl1(elmCpuid, "CpuIdLeaf");
1912 const xml::ElementNode *pelmCpuIdLeaf;
1913 while ((pelmCpuIdLeaf = nl1.forAllNodes()))
1914 {
1915 CpuIdLeaf leaf;
1916
1917 if (!pelmCpuIdLeaf->getAttributeValue("id", leaf.ulId))
1918 throw ConfigFileError(this, pelmCpuIdLeaf, N_("Required CpuId/@id attribute is missing"));
1919
1920 pelmCpuIdLeaf->getAttributeValue("eax", leaf.ulEax);
1921 pelmCpuIdLeaf->getAttributeValue("ebx", leaf.ulEbx);
1922 pelmCpuIdLeaf->getAttributeValue("ecx", leaf.ulEcx);
1923 pelmCpuIdLeaf->getAttributeValue("edx", leaf.ulEdx);
1924
1925 ll.push_back(leaf);
1926 }
1927}
1928
1929/**
1930 * Called from MachineConfigFile::readHardware() to network information.
1931 * @param elmNetwork
1932 * @param ll
1933 */
1934void MachineConfigFile::readNetworkAdapters(const xml::ElementNode &elmNetwork,
1935 NetworkAdaptersList &ll)
1936{
1937 xml::NodesLoop nl1(elmNetwork, "Adapter");
1938 const xml::ElementNode *pelmAdapter;
1939 while ((pelmAdapter = nl1.forAllNodes()))
1940 {
1941 NetworkAdapter nic;
1942
1943 if (!pelmAdapter->getAttributeValue("slot", nic.ulSlot))
1944 throw ConfigFileError(this, pelmAdapter, N_("Required Adapter/@slot attribute is missing"));
1945
1946 Utf8Str strTemp;
1947 if (pelmAdapter->getAttributeValue("type", strTemp))
1948 {
1949 if (strTemp == "Am79C970A")
1950 nic.type = NetworkAdapterType_Am79C970A;
1951 else if (strTemp == "Am79C973")
1952 nic.type = NetworkAdapterType_Am79C973;
1953 else if (strTemp == "82540EM")
1954 nic.type = NetworkAdapterType_I82540EM;
1955 else if (strTemp == "82543GC")
1956 nic.type = NetworkAdapterType_I82543GC;
1957 else if (strTemp == "82545EM")
1958 nic.type = NetworkAdapterType_I82545EM;
1959 else if (strTemp == "virtio")
1960 nic.type = NetworkAdapterType_Virtio;
1961 else
1962 throw ConfigFileError(this, pelmAdapter, N_("Invalid value '%s' in Adapter/@type attribute"), strTemp.c_str());
1963 }
1964
1965 pelmAdapter->getAttributeValue("enabled", nic.fEnabled);
1966 pelmAdapter->getAttributeValue("MACAddress", nic.strMACAddress);
1967 pelmAdapter->getAttributeValue("cable", nic.fCableConnected);
1968 pelmAdapter->getAttributeValue("speed", nic.ulLineSpeed);
1969
1970 if (pelmAdapter->getAttributeValue("promiscuousModePolicy", strTemp))
1971 {
1972 if (strTemp == "Deny")
1973 nic.enmPromiscModePolicy = NetworkAdapterPromiscModePolicy_Deny;
1974 else if (strTemp == "AllowNetwork")
1975 nic.enmPromiscModePolicy = NetworkAdapterPromiscModePolicy_AllowNetwork;
1976 else if (strTemp == "AllowAll")
1977 nic.enmPromiscModePolicy = NetworkAdapterPromiscModePolicy_AllowAll;
1978 else
1979 throw ConfigFileError(this, pelmAdapter,
1980 N_("Invalid value '%s' in Adapter/@promiscuousModePolicy attribute"), strTemp.c_str());
1981 }
1982
1983 pelmAdapter->getAttributeValue("trace", nic.fTraceEnabled);
1984 pelmAdapter->getAttributeValue("tracefile", nic.strTraceFile);
1985 pelmAdapter->getAttributeValue("bootPriority", nic.ulBootPriority);
1986 pelmAdapter->getAttributeValue("bandwidthGroup", nic.strBandwidthGroup);
1987
1988 xml::ElementNodesList llNetworkModes;
1989 pelmAdapter->getChildElements(llNetworkModes);
1990 xml::ElementNodesList::iterator it;
1991 /* We should have only active mode descriptor and disabled modes set */
1992 if (llNetworkModes.size() > 2)
1993 {
1994 throw ConfigFileError(this, pelmAdapter, N_("Invalid number of modes ('%d') attached to Adapter attribute"), llNetworkModes.size());
1995 }
1996 for (it = llNetworkModes.begin(); it != llNetworkModes.end(); ++it)
1997 {
1998 const xml::ElementNode *pelmNode = *it;
1999 if (pelmNode->nameEquals("DisabledModes"))
2000 {
2001 xml::ElementNodesList llDisabledNetworkModes;
2002 xml::ElementNodesList::iterator itDisabled;
2003 pelmNode->getChildElements(llDisabledNetworkModes);
2004 /* run over disabled list and load settings */
2005 for (itDisabled = llDisabledNetworkModes.begin();
2006 itDisabled != llDisabledNetworkModes.end(); ++itDisabled)
2007 {
2008 const xml::ElementNode *pelmDisabledNode = *itDisabled;
2009 readAttachedNetworkMode(*pelmDisabledNode, false, nic);
2010 }
2011 }
2012 else
2013 readAttachedNetworkMode(*pelmNode, true, nic);
2014 }
2015 // else: default is NetworkAttachmentType_Null
2016
2017 ll.push_back(nic);
2018 }
2019}
2020
2021void MachineConfigFile::readAttachedNetworkMode(const xml::ElementNode &elmMode, bool fEnabled, NetworkAdapter &nic)
2022{
2023 NetworkAttachmentType_T enmAttachmentType = NetworkAttachmentType_Null;
2024
2025 if (elmMode.nameEquals("NAT"))
2026 {
2027 enmAttachmentType = NetworkAttachmentType_NAT;
2028
2029 elmMode.getAttributeValue("network", nic.nat.strNetwork);
2030 elmMode.getAttributeValue("hostip", nic.nat.strBindIP);
2031 elmMode.getAttributeValue("mtu", nic.nat.u32Mtu);
2032 elmMode.getAttributeValue("sockrcv", nic.nat.u32SockRcv);
2033 elmMode.getAttributeValue("socksnd", nic.nat.u32SockSnd);
2034 elmMode.getAttributeValue("tcprcv", nic.nat.u32TcpRcv);
2035 elmMode.getAttributeValue("tcpsnd", nic.nat.u32TcpSnd);
2036 const xml::ElementNode *pelmDNS;
2037 if ((pelmDNS = elmMode.findChildElement("DNS")))
2038 {
2039 pelmDNS->getAttributeValue("pass-domain", nic.nat.fDnsPassDomain);
2040 pelmDNS->getAttributeValue("use-proxy", nic.nat.fDnsProxy);
2041 pelmDNS->getAttributeValue("use-host-resolver", nic.nat.fDnsUseHostResolver);
2042 }
2043 const xml::ElementNode *pelmAlias;
2044 if ((pelmAlias = elmMode.findChildElement("Alias")))
2045 {
2046 pelmAlias->getAttributeValue("logging", nic.nat.fAliasLog);
2047 pelmAlias->getAttributeValue("proxy-only", nic.nat.fAliasProxyOnly);
2048 pelmAlias->getAttributeValue("use-same-ports", nic.nat.fAliasUseSamePorts);
2049 }
2050 const xml::ElementNode *pelmTFTP;
2051 if ((pelmTFTP = elmMode.findChildElement("TFTP")))
2052 {
2053 pelmTFTP->getAttributeValue("prefix", nic.nat.strTftpPrefix);
2054 pelmTFTP->getAttributeValue("boot-file", nic.nat.strTftpBootFile);
2055 pelmTFTP->getAttributeValue("next-server", nic.nat.strTftpNextServer);
2056 }
2057 xml::ElementNodesList plstNatPF;
2058 elmMode.getChildElements(plstNatPF, "Forwarding");
2059 for (xml::ElementNodesList::iterator pf = plstNatPF.begin(); pf != plstNatPF.end(); ++pf)
2060 {
2061 NATRule rule;
2062 uint32_t port = 0;
2063 (*pf)->getAttributeValue("name", rule.strName);
2064 (*pf)->getAttributeValue("proto", (uint32_t&)rule.proto);
2065 (*pf)->getAttributeValue("hostip", rule.strHostIP);
2066 (*pf)->getAttributeValue("hostport", port);
2067 rule.u16HostPort = port;
2068 (*pf)->getAttributeValue("guestip", rule.strGuestIP);
2069 (*pf)->getAttributeValue("guestport", port);
2070 rule.u16GuestPort = port;
2071 nic.nat.llRules.push_back(rule);
2072 }
2073 }
2074 else if ( (elmMode.nameEquals("HostInterface"))
2075 || (elmMode.nameEquals("BridgedInterface")))
2076 {
2077 enmAttachmentType = NetworkAttachmentType_Bridged;
2078
2079 elmMode.getAttributeValue("name", nic.strBridgedName); // optional bridged interface name
2080 }
2081 else if (elmMode.nameEquals("InternalNetwork"))
2082 {
2083 enmAttachmentType = NetworkAttachmentType_Internal;
2084
2085 if (!elmMode.getAttributeValue("name", nic.strInternalNetworkName)) // required network name
2086 throw ConfigFileError(this, &elmMode, N_("Required InternalNetwork/@name element is missing"));
2087 }
2088 else if (elmMode.nameEquals("HostOnlyInterface"))
2089 {
2090 enmAttachmentType = NetworkAttachmentType_HostOnly;
2091
2092 if (!elmMode.getAttributeValue("name", nic.strHostOnlyName)) // required network name
2093 throw ConfigFileError(this, &elmMode, N_("Required HostOnlyInterface/@name element is missing"));
2094 }
2095 else if (elmMode.nameEquals("GenericInterface"))
2096 {
2097 enmAttachmentType = NetworkAttachmentType_Generic;
2098
2099 elmMode.getAttributeValue("driver", nic.strGenericDriver); // optional network attachment driver
2100
2101 // get all properties
2102 xml::NodesLoop nl(elmMode);
2103 const xml::ElementNode *pelmModeChild;
2104 while ((pelmModeChild = nl.forAllNodes()))
2105 {
2106 if (pelmModeChild->nameEquals("Property"))
2107 {
2108 Utf8Str strPropName, strPropValue;
2109 if ( (pelmModeChild->getAttributeValue("name", strPropName))
2110 && (pelmModeChild->getAttributeValue("value", strPropValue))
2111 )
2112 nic.genericProperties[strPropName] = strPropValue;
2113 else
2114 throw ConfigFileError(this, pelmModeChild, N_("Required GenericInterface/Property/@name or @value attribute is missing"));
2115 }
2116 }
2117 }
2118 else if (elmMode.nameEquals("VDE"))
2119 {
2120 enmAttachmentType = NetworkAttachmentType_Generic;
2121
2122 com::Utf8Str strVDEName;
2123 elmMode.getAttributeValue("network", strVDEName); // optional network name
2124 nic.strGenericDriver = "VDE";
2125 nic.genericProperties["network"] = strVDEName;
2126 }
2127
2128 if (fEnabled && enmAttachmentType != NetworkAttachmentType_Null)
2129 nic.mode = enmAttachmentType;
2130}
2131
2132/**
2133 * Called from MachineConfigFile::readHardware() to read serial port information.
2134 * @param elmUART
2135 * @param ll
2136 */
2137void MachineConfigFile::readSerialPorts(const xml::ElementNode &elmUART,
2138 SerialPortsList &ll)
2139{
2140 xml::NodesLoop nl1(elmUART, "Port");
2141 const xml::ElementNode *pelmPort;
2142 while ((pelmPort = nl1.forAllNodes()))
2143 {
2144 SerialPort port;
2145 if (!pelmPort->getAttributeValue("slot", port.ulSlot))
2146 throw ConfigFileError(this, pelmPort, N_("Required UART/Port/@slot attribute is missing"));
2147
2148 // slot must be unique
2149 for (SerialPortsList::const_iterator it = ll.begin();
2150 it != ll.end();
2151 ++it)
2152 if ((*it).ulSlot == port.ulSlot)
2153 throw ConfigFileError(this, pelmPort, N_("Invalid value %RU32 in UART/Port/@slot attribute: value is not unique"), port.ulSlot);
2154
2155 if (!pelmPort->getAttributeValue("enabled", port.fEnabled))
2156 throw ConfigFileError(this, pelmPort, N_("Required UART/Port/@enabled attribute is missing"));
2157 if (!pelmPort->getAttributeValue("IOBase", port.ulIOBase))
2158 throw ConfigFileError(this, pelmPort, N_("Required UART/Port/@IOBase attribute is missing"));
2159 if (!pelmPort->getAttributeValue("IRQ", port.ulIRQ))
2160 throw ConfigFileError(this, pelmPort, N_("Required UART/Port/@IRQ attribute is missing"));
2161
2162 Utf8Str strPortMode;
2163 if (!pelmPort->getAttributeValue("hostMode", strPortMode))
2164 throw ConfigFileError(this, pelmPort, N_("Required UART/Port/@hostMode attribute is missing"));
2165 if (strPortMode == "RawFile")
2166 port.portMode = PortMode_RawFile;
2167 else if (strPortMode == "HostPipe")
2168 port.portMode = PortMode_HostPipe;
2169 else if (strPortMode == "HostDevice")
2170 port.portMode = PortMode_HostDevice;
2171 else if (strPortMode == "Disconnected")
2172 port.portMode = PortMode_Disconnected;
2173 else
2174 throw ConfigFileError(this, pelmPort, N_("Invalid value '%s' in UART/Port/@hostMode attribute"), strPortMode.c_str());
2175
2176 pelmPort->getAttributeValue("path", port.strPath);
2177 pelmPort->getAttributeValue("server", port.fServer);
2178
2179 ll.push_back(port);
2180 }
2181}
2182
2183/**
2184 * Called from MachineConfigFile::readHardware() to read parallel port information.
2185 * @param elmLPT
2186 * @param ll
2187 */
2188void MachineConfigFile::readParallelPorts(const xml::ElementNode &elmLPT,
2189 ParallelPortsList &ll)
2190{
2191 xml::NodesLoop nl1(elmLPT, "Port");
2192 const xml::ElementNode *pelmPort;
2193 while ((pelmPort = nl1.forAllNodes()))
2194 {
2195 ParallelPort port;
2196 if (!pelmPort->getAttributeValue("slot", port.ulSlot))
2197 throw ConfigFileError(this, pelmPort, N_("Required LPT/Port/@slot attribute is missing"));
2198
2199 // slot must be unique
2200 for (ParallelPortsList::const_iterator it = ll.begin();
2201 it != ll.end();
2202 ++it)
2203 if ((*it).ulSlot == port.ulSlot)
2204 throw ConfigFileError(this, pelmPort, N_("Invalid value %RU32 in LPT/Port/@slot attribute: value is not unique"), port.ulSlot);
2205
2206 if (!pelmPort->getAttributeValue("enabled", port.fEnabled))
2207 throw ConfigFileError(this, pelmPort, N_("Required LPT/Port/@enabled attribute is missing"));
2208 if (!pelmPort->getAttributeValue("IOBase", port.ulIOBase))
2209 throw ConfigFileError(this, pelmPort, N_("Required LPT/Port/@IOBase attribute is missing"));
2210 if (!pelmPort->getAttributeValue("IRQ", port.ulIRQ))
2211 throw ConfigFileError(this, pelmPort, N_("Required LPT/Port/@IRQ attribute is missing"));
2212
2213 pelmPort->getAttributeValue("path", port.strPath);
2214
2215 ll.push_back(port);
2216 }
2217}
2218
2219/**
2220 * Called from MachineConfigFile::readHardware() to read audio adapter information
2221 * and maybe fix driver information depending on the current host hardware.
2222 *
2223 * @param elmAudioAdapter "AudioAdapter" XML element.
2224 * @param hw
2225 */
2226void MachineConfigFile::readAudioAdapter(const xml::ElementNode &elmAudioAdapter,
2227 AudioAdapter &aa)
2228{
2229 elmAudioAdapter.getAttributeValue("enabled", aa.fEnabled);
2230
2231 Utf8Str strTemp;
2232 if (elmAudioAdapter.getAttributeValue("controller", strTemp))
2233 {
2234 if (strTemp == "SB16")
2235 aa.controllerType = AudioControllerType_SB16;
2236 else if (strTemp == "AC97")
2237 aa.controllerType = AudioControllerType_AC97;
2238 else if (strTemp == "HDA")
2239 aa.controllerType = AudioControllerType_HDA;
2240 else
2241 throw ConfigFileError(this, &elmAudioAdapter, N_("Invalid value '%s' in AudioAdapter/@controller attribute"), strTemp.c_str());
2242 }
2243
2244 if (elmAudioAdapter.getAttributeValue("driver", strTemp))
2245 {
2246 // settings before 1.3 used lower case so make sure this is case-insensitive
2247 strTemp.toUpper();
2248 if (strTemp == "NULL")
2249 aa.driverType = AudioDriverType_Null;
2250 else if (strTemp == "WINMM")
2251 aa.driverType = AudioDriverType_WinMM;
2252 else if ( (strTemp == "DIRECTSOUND") || (strTemp == "DSOUND") )
2253 aa.driverType = AudioDriverType_DirectSound;
2254 else if (strTemp == "SOLAUDIO")
2255 aa.driverType = AudioDriverType_SolAudio;
2256 else if (strTemp == "ALSA")
2257 aa.driverType = AudioDriverType_ALSA;
2258 else if (strTemp == "PULSE")
2259 aa.driverType = AudioDriverType_Pulse;
2260 else if (strTemp == "OSS")
2261 aa.driverType = AudioDriverType_OSS;
2262 else if (strTemp == "COREAUDIO")
2263 aa.driverType = AudioDriverType_CoreAudio;
2264 else if (strTemp == "MMPM")
2265 aa.driverType = AudioDriverType_MMPM;
2266 else
2267 throw ConfigFileError(this, &elmAudioAdapter, N_("Invalid value '%s' in AudioAdapter/@driver attribute"), strTemp.c_str());
2268
2269 // now check if this is actually supported on the current host platform;
2270 // people might be opening a file created on a Windows host, and that
2271 // VM should still start on a Linux host
2272 if (!isAudioDriverAllowedOnThisHost(aa.driverType))
2273 aa.driverType = getHostDefaultAudioDriver();
2274 }
2275}
2276
2277/**
2278 * Called from MachineConfigFile::readHardware() to read guest property information.
2279 * @param elmGuestProperties
2280 * @param hw
2281 */
2282void MachineConfigFile::readGuestProperties(const xml::ElementNode &elmGuestProperties,
2283 Hardware &hw)
2284{
2285 xml::NodesLoop nl1(elmGuestProperties, "GuestProperty");
2286 const xml::ElementNode *pelmProp;
2287 while ((pelmProp = nl1.forAllNodes()))
2288 {
2289 GuestProperty prop;
2290 pelmProp->getAttributeValue("name", prop.strName);
2291 pelmProp->getAttributeValue("value", prop.strValue);
2292
2293 pelmProp->getAttributeValue("timestamp", prop.timestamp);
2294 pelmProp->getAttributeValue("flags", prop.strFlags);
2295 hw.llGuestProperties.push_back(prop);
2296 }
2297
2298 elmGuestProperties.getAttributeValue("notificationPatterns", hw.strNotificationPatterns);
2299}
2300
2301/**
2302 * Helper function to read attributes that are common to <SATAController> (pre-1.7)
2303 * and <StorageController>.
2304 * @param elmStorageController
2305 * @param strg
2306 */
2307void MachineConfigFile::readStorageControllerAttributes(const xml::ElementNode &elmStorageController,
2308 StorageController &sctl)
2309{
2310 elmStorageController.getAttributeValue("PortCount", sctl.ulPortCount);
2311 elmStorageController.getAttributeValue("IDE0MasterEmulationPort", sctl.lIDE0MasterEmulationPort);
2312 elmStorageController.getAttributeValue("IDE0SlaveEmulationPort", sctl.lIDE0SlaveEmulationPort);
2313 elmStorageController.getAttributeValue("IDE1MasterEmulationPort", sctl.lIDE1MasterEmulationPort);
2314 elmStorageController.getAttributeValue("IDE1SlaveEmulationPort", sctl.lIDE1SlaveEmulationPort);
2315
2316 elmStorageController.getAttributeValue("useHostIOCache", sctl.fUseHostIOCache);
2317}
2318
2319/**
2320 * Reads in a <Hardware> block and stores it in the given structure. Used
2321 * both directly from readMachine and from readSnapshot, since snapshots
2322 * have their own hardware sections.
2323 *
2324 * For legacy pre-1.7 settings we also need a storage structure because
2325 * the IDE and SATA controllers used to be defined under <Hardware>.
2326 *
2327 * @param elmHardware
2328 * @param hw
2329 */
2330void MachineConfigFile::readHardware(const xml::ElementNode &elmHardware,
2331 Hardware &hw,
2332 Storage &strg)
2333{
2334 if (!elmHardware.getAttributeValue("version", hw.strVersion))
2335 {
2336 /* KLUDGE ALERT! For a while during the 3.1 development this was not
2337 written because it was thought to have a default value of "2". For
2338 sv <= 1.3 it defaults to "1" because the attribute didn't exist,
2339 while for 1.4+ it is sort of mandatory. Now, the buggy XML writer
2340 code only wrote 1.7 and later. So, if it's a 1.7+ XML file and it's
2341 missing the hardware version, then it probably should be "2" instead
2342 of "1". */
2343 if (m->sv < SettingsVersion_v1_7)
2344 hw.strVersion = "1";
2345 else
2346 hw.strVersion = "2";
2347 }
2348 Utf8Str strUUID;
2349 if (elmHardware.getAttributeValue("uuid", strUUID))
2350 parseUUID(hw.uuid, strUUID);
2351
2352 xml::NodesLoop nl1(elmHardware);
2353 const xml::ElementNode *pelmHwChild;
2354 while ((pelmHwChild = nl1.forAllNodes()))
2355 {
2356 if (pelmHwChild->nameEquals("CPU"))
2357 {
2358 if (!pelmHwChild->getAttributeValue("count", hw.cCPUs))
2359 {
2360 // pre-1.5 variant; not sure if this actually exists in the wild anywhere
2361 const xml::ElementNode *pelmCPUChild;
2362 if ((pelmCPUChild = pelmHwChild->findChildElement("CPUCount")))
2363 pelmCPUChild->getAttributeValue("count", hw.cCPUs);
2364 }
2365
2366 pelmHwChild->getAttributeValue("hotplug", hw.fCpuHotPlug);
2367 pelmHwChild->getAttributeValue("executionCap", hw.ulCpuExecutionCap);
2368
2369 const xml::ElementNode *pelmCPUChild;
2370 if (hw.fCpuHotPlug)
2371 {
2372 if ((pelmCPUChild = pelmHwChild->findChildElement("CpuTree")))
2373 readCpuTree(*pelmCPUChild, hw.llCpus);
2374 }
2375
2376 if ((pelmCPUChild = pelmHwChild->findChildElement("HardwareVirtEx")))
2377 {
2378 pelmCPUChild->getAttributeValue("enabled", hw.fHardwareVirt);
2379 pelmCPUChild->getAttributeValue("exclusive", hw.fHardwareVirtExclusive); // settings version 1.9
2380 }
2381 if ((pelmCPUChild = pelmHwChild->findChildElement("HardwareVirtExNestedPaging")))
2382 pelmCPUChild->getAttributeValue("enabled", hw.fNestedPaging);
2383 if ((pelmCPUChild = pelmHwChild->findChildElement("HardwareVirtExLargePages")))
2384 pelmCPUChild->getAttributeValue("enabled", hw.fLargePages);
2385 if ((pelmCPUChild = pelmHwChild->findChildElement("HardwareVirtExVPID")))
2386 pelmCPUChild->getAttributeValue("enabled", hw.fVPID);
2387 if ((pelmCPUChild = pelmHwChild->findChildElement("HardwareVirtForce")))
2388 pelmCPUChild->getAttributeValue("enabled", hw.fHardwareVirtForce);
2389
2390 if (!(pelmCPUChild = pelmHwChild->findChildElement("PAE")))
2391 {
2392 /* The default for pre 3.1 was false, so we must respect that. */
2393 if (m->sv < SettingsVersion_v1_9)
2394 hw.fPAE = false;
2395 }
2396 else
2397 pelmCPUChild->getAttributeValue("enabled", hw.fPAE);
2398
2399 if ((pelmCPUChild = pelmHwChild->findChildElement("SyntheticCpu")))
2400 pelmCPUChild->getAttributeValue("enabled", hw.fSyntheticCpu);
2401 if ((pelmCPUChild = pelmHwChild->findChildElement("CpuIdTree")))
2402 readCpuIdTree(*pelmCPUChild, hw.llCpuIdLeafs);
2403 }
2404 else if (pelmHwChild->nameEquals("Memory"))
2405 {
2406 pelmHwChild->getAttributeValue("RAMSize", hw.ulMemorySizeMB);
2407 pelmHwChild->getAttributeValue("PageFusion", hw.fPageFusionEnabled);
2408 }
2409 else if (pelmHwChild->nameEquals("Firmware"))
2410 {
2411 Utf8Str strFirmwareType;
2412 if (pelmHwChild->getAttributeValue("type", strFirmwareType))
2413 {
2414 if ( (strFirmwareType == "BIOS")
2415 || (strFirmwareType == "1") // some trunk builds used the number here
2416 )
2417 hw.firmwareType = FirmwareType_BIOS;
2418 else if ( (strFirmwareType == "EFI")
2419 || (strFirmwareType == "2") // some trunk builds used the number here
2420 )
2421 hw.firmwareType = FirmwareType_EFI;
2422 else if ( strFirmwareType == "EFI32")
2423 hw.firmwareType = FirmwareType_EFI32;
2424 else if ( strFirmwareType == "EFI64")
2425 hw.firmwareType = FirmwareType_EFI64;
2426 else if ( strFirmwareType == "EFIDUAL")
2427 hw.firmwareType = FirmwareType_EFIDUAL;
2428 else
2429 throw ConfigFileError(this,
2430 pelmHwChild,
2431 N_("Invalid value '%s' in Firmware/@type"),
2432 strFirmwareType.c_str());
2433 }
2434 }
2435 else if (pelmHwChild->nameEquals("HID"))
2436 {
2437 Utf8Str strHidType;
2438 if (pelmHwChild->getAttributeValue("Keyboard", strHidType))
2439 {
2440 if (strHidType == "None")
2441 hw.keyboardHidType = KeyboardHidType_None;
2442 else if (strHidType == "USBKeyboard")
2443 hw.keyboardHidType = KeyboardHidType_USBKeyboard;
2444 else if (strHidType == "PS2Keyboard")
2445 hw.keyboardHidType = KeyboardHidType_PS2Keyboard;
2446 else if (strHidType == "ComboKeyboard")
2447 hw.keyboardHidType = KeyboardHidType_ComboKeyboard;
2448 else
2449 throw ConfigFileError(this,
2450 pelmHwChild,
2451 N_("Invalid value '%s' in HID/Keyboard/@type"),
2452 strHidType.c_str());
2453 }
2454 if (pelmHwChild->getAttributeValue("Pointing", strHidType))
2455 {
2456 if (strHidType == "None")
2457 hw.pointingHidType = PointingHidType_None;
2458 else if (strHidType == "USBMouse")
2459 hw.pointingHidType = PointingHidType_USBMouse;
2460 else if (strHidType == "USBTablet")
2461 hw.pointingHidType = PointingHidType_USBTablet;
2462 else if (strHidType == "PS2Mouse")
2463 hw.pointingHidType = PointingHidType_PS2Mouse;
2464 else if (strHidType == "ComboMouse")
2465 hw.pointingHidType = PointingHidType_ComboMouse;
2466 else
2467 throw ConfigFileError(this,
2468 pelmHwChild,
2469 N_("Invalid value '%s' in HID/Pointing/@type"),
2470 strHidType.c_str());
2471 }
2472 }
2473 else if (pelmHwChild->nameEquals("Chipset"))
2474 {
2475 Utf8Str strChipsetType;
2476 if (pelmHwChild->getAttributeValue("type", strChipsetType))
2477 {
2478 if (strChipsetType == "PIIX3")
2479 hw.chipsetType = ChipsetType_PIIX3;
2480 else if (strChipsetType == "ICH9")
2481 hw.chipsetType = ChipsetType_ICH9;
2482 else
2483 throw ConfigFileError(this,
2484 pelmHwChild,
2485 N_("Invalid value '%s' in Chipset/@type"),
2486 strChipsetType.c_str());
2487 }
2488 }
2489 else if (pelmHwChild->nameEquals("HPET"))
2490 {
2491 pelmHwChild->getAttributeValue("enabled", hw.fHpetEnabled);
2492 }
2493 else if (pelmHwChild->nameEquals("Boot"))
2494 {
2495 hw.mapBootOrder.clear();
2496
2497 xml::NodesLoop nl2(*pelmHwChild, "Order");
2498 const xml::ElementNode *pelmOrder;
2499 while ((pelmOrder = nl2.forAllNodes()))
2500 {
2501 uint32_t ulPos;
2502 Utf8Str strDevice;
2503 if (!pelmOrder->getAttributeValue("position", ulPos))
2504 throw ConfigFileError(this, pelmOrder, N_("Required Boot/Order/@position attribute is missing"));
2505
2506 if ( ulPos < 1
2507 || ulPos > SchemaDefs::MaxBootPosition
2508 )
2509 throw ConfigFileError(this,
2510 pelmOrder,
2511 N_("Invalid value '%RU32' in Boot/Order/@position: must be greater than 0 and less than %RU32"),
2512 ulPos,
2513 SchemaDefs::MaxBootPosition + 1);
2514 // XML is 1-based but internal data is 0-based
2515 --ulPos;
2516
2517 if (hw.mapBootOrder.find(ulPos) != hw.mapBootOrder.end())
2518 throw ConfigFileError(this, pelmOrder, N_("Invalid value '%RU32' in Boot/Order/@position: value is not unique"), ulPos);
2519
2520 if (!pelmOrder->getAttributeValue("device", strDevice))
2521 throw ConfigFileError(this, pelmOrder, N_("Required Boot/Order/@device attribute is missing"));
2522
2523 DeviceType_T type;
2524 if (strDevice == "None")
2525 type = DeviceType_Null;
2526 else if (strDevice == "Floppy")
2527 type = DeviceType_Floppy;
2528 else if (strDevice == "DVD")
2529 type = DeviceType_DVD;
2530 else if (strDevice == "HardDisk")
2531 type = DeviceType_HardDisk;
2532 else if (strDevice == "Network")
2533 type = DeviceType_Network;
2534 else
2535 throw ConfigFileError(this, pelmOrder, N_("Invalid value '%s' in Boot/Order/@device attribute"), strDevice.c_str());
2536 hw.mapBootOrder[ulPos] = type;
2537 }
2538 }
2539 else if (pelmHwChild->nameEquals("Display"))
2540 {
2541 pelmHwChild->getAttributeValue("VRAMSize", hw.ulVRAMSizeMB);
2542 if (!pelmHwChild->getAttributeValue("monitorCount", hw.cMonitors))
2543 pelmHwChild->getAttributeValue("MonitorCount", hw.cMonitors); // pre-v1.5 variant
2544 if (!pelmHwChild->getAttributeValue("accelerate3D", hw.fAccelerate3D))
2545 pelmHwChild->getAttributeValue("Accelerate3D", hw.fAccelerate3D); // pre-v1.5 variant
2546 pelmHwChild->getAttributeValue("accelerate2DVideo", hw.fAccelerate2DVideo);
2547 }
2548 else if (pelmHwChild->nameEquals("RemoteDisplay"))
2549 {
2550 pelmHwChild->getAttributeValue("enabled", hw.vrdeSettings.fEnabled);
2551
2552 Utf8Str str;
2553 if (pelmHwChild->getAttributeValue("port", str))
2554 hw.vrdeSettings.mapProperties["TCP/Ports"] = str;
2555 if (pelmHwChild->getAttributeValue("netAddress", str))
2556 hw.vrdeSettings.mapProperties["TCP/Address"] = str;
2557
2558 Utf8Str strAuthType;
2559 if (pelmHwChild->getAttributeValue("authType", strAuthType))
2560 {
2561 // settings before 1.3 used lower case so make sure this is case-insensitive
2562 strAuthType.toUpper();
2563 if (strAuthType == "NULL")
2564 hw.vrdeSettings.authType = AuthType_Null;
2565 else if (strAuthType == "GUEST")
2566 hw.vrdeSettings.authType = AuthType_Guest;
2567 else if (strAuthType == "EXTERNAL")
2568 hw.vrdeSettings.authType = AuthType_External;
2569 else
2570 throw ConfigFileError(this, pelmHwChild, N_("Invalid value '%s' in RemoteDisplay/@authType attribute"), strAuthType.c_str());
2571 }
2572
2573 pelmHwChild->getAttributeValue("authLibrary", hw.vrdeSettings.strAuthLibrary);
2574 pelmHwChild->getAttributeValue("authTimeout", hw.vrdeSettings.ulAuthTimeout);
2575 pelmHwChild->getAttributeValue("allowMultiConnection", hw.vrdeSettings.fAllowMultiConnection);
2576 pelmHwChild->getAttributeValue("reuseSingleConnection", hw.vrdeSettings.fReuseSingleConnection);
2577
2578 /* 3.2 and 4.0 betas, 4.0 has this information in VRDEProperties. */
2579 const xml::ElementNode *pelmVideoChannel;
2580 if ((pelmVideoChannel = pelmHwChild->findChildElement("VideoChannel")))
2581 {
2582 bool fVideoChannel = false;
2583 pelmVideoChannel->getAttributeValue("enabled", fVideoChannel);
2584 hw.vrdeSettings.mapProperties["VideoChannel/Enabled"] = fVideoChannel? "true": "false";
2585
2586 uint32_t ulVideoChannelQuality = 75;
2587 pelmVideoChannel->getAttributeValue("quality", ulVideoChannelQuality);
2588 ulVideoChannelQuality = RT_CLAMP(ulVideoChannelQuality, 10, 100);
2589 char *pszBuffer = NULL;
2590 if (RTStrAPrintf(&pszBuffer, "%d", ulVideoChannelQuality) >= 0)
2591 {
2592 hw.vrdeSettings.mapProperties["VideoChannel/Quality"] = pszBuffer;
2593 RTStrFree(pszBuffer);
2594 }
2595 else
2596 hw.vrdeSettings.mapProperties["VideoChannel/Quality"] = "75";
2597 }
2598 pelmHwChild->getAttributeValue("VRDEExtPack", hw.vrdeSettings.strVrdeExtPack);
2599
2600 const xml::ElementNode *pelmProperties = pelmHwChild->findChildElement("VRDEProperties");
2601 if (pelmProperties != NULL)
2602 {
2603 xml::NodesLoop nl(*pelmProperties);
2604 const xml::ElementNode *pelmProperty;
2605 while ((pelmProperty = nl.forAllNodes()))
2606 {
2607 if (pelmProperty->nameEquals("Property"))
2608 {
2609 /* <Property name="TCP/Ports" value="3000-3002"/> */
2610 Utf8Str strName, strValue;
2611 if ( ((pelmProperty->getAttributeValue("name", strName)))
2612 && ((pelmProperty->getAttributeValue("value", strValue)))
2613 )
2614 hw.vrdeSettings.mapProperties[strName] = strValue;
2615 else
2616 throw ConfigFileError(this, pelmProperty, N_("Required VRDE Property/@name or @value attribute is missing"));
2617 }
2618 }
2619 }
2620 }
2621 else if (pelmHwChild->nameEquals("BIOS"))
2622 {
2623 const xml::ElementNode *pelmBIOSChild;
2624 if ((pelmBIOSChild = pelmHwChild->findChildElement("ACPI")))
2625 pelmBIOSChild->getAttributeValue("enabled", hw.biosSettings.fACPIEnabled);
2626 if ((pelmBIOSChild = pelmHwChild->findChildElement("IOAPIC")))
2627 pelmBIOSChild->getAttributeValue("enabled", hw.biosSettings.fIOAPICEnabled);
2628 if ((pelmBIOSChild = pelmHwChild->findChildElement("Logo")))
2629 {
2630 pelmBIOSChild->getAttributeValue("fadeIn", hw.biosSettings.fLogoFadeIn);
2631 pelmBIOSChild->getAttributeValue("fadeOut", hw.biosSettings.fLogoFadeOut);
2632 pelmBIOSChild->getAttributeValue("displayTime", hw.biosSettings.ulLogoDisplayTime);
2633 pelmBIOSChild->getAttributeValue("imagePath", hw.biosSettings.strLogoImagePath);
2634 }
2635 if ((pelmBIOSChild = pelmHwChild->findChildElement("BootMenu")))
2636 {
2637 Utf8Str strBootMenuMode;
2638 if (pelmBIOSChild->getAttributeValue("mode", strBootMenuMode))
2639 {
2640 // settings before 1.3 used lower case so make sure this is case-insensitive
2641 strBootMenuMode.toUpper();
2642 if (strBootMenuMode == "DISABLED")
2643 hw.biosSettings.biosBootMenuMode = BIOSBootMenuMode_Disabled;
2644 else if (strBootMenuMode == "MENUONLY")
2645 hw.biosSettings.biosBootMenuMode = BIOSBootMenuMode_MenuOnly;
2646 else if (strBootMenuMode == "MESSAGEANDMENU")
2647 hw.biosSettings.biosBootMenuMode = BIOSBootMenuMode_MessageAndMenu;
2648 else
2649 throw ConfigFileError(this, pelmBIOSChild, N_("Invalid value '%s' in BootMenu/@mode attribute"), strBootMenuMode.c_str());
2650 }
2651 }
2652 if ((pelmBIOSChild = pelmHwChild->findChildElement("PXEDebug")))
2653 pelmBIOSChild->getAttributeValue("enabled", hw.biosSettings.fPXEDebugEnabled);
2654 if ((pelmBIOSChild = pelmHwChild->findChildElement("TimeOffset")))
2655 pelmBIOSChild->getAttributeValue("value", hw.biosSettings.llTimeOffset);
2656
2657 // legacy BIOS/IDEController (pre 1.7)
2658 if ( (m->sv < SettingsVersion_v1_7)
2659 && ((pelmBIOSChild = pelmHwChild->findChildElement("IDEController")))
2660 )
2661 {
2662 StorageController sctl;
2663 sctl.strName = "IDE Controller";
2664 sctl.storageBus = StorageBus_IDE;
2665
2666 Utf8Str strType;
2667 if (pelmBIOSChild->getAttributeValue("type", strType))
2668 {
2669 if (strType == "PIIX3")
2670 sctl.controllerType = StorageControllerType_PIIX3;
2671 else if (strType == "PIIX4")
2672 sctl.controllerType = StorageControllerType_PIIX4;
2673 else if (strType == "ICH6")
2674 sctl.controllerType = StorageControllerType_ICH6;
2675 else
2676 throw ConfigFileError(this, pelmBIOSChild, N_("Invalid value '%s' for IDEController/@type attribute"), strType.c_str());
2677 }
2678 sctl.ulPortCount = 2;
2679 strg.llStorageControllers.push_back(sctl);
2680 }
2681 }
2682 else if (pelmHwChild->nameEquals("USBController"))
2683 {
2684 pelmHwChild->getAttributeValue("enabled", hw.usbController.fEnabled);
2685 pelmHwChild->getAttributeValue("enabledEhci", hw.usbController.fEnabledEHCI);
2686
2687 readUSBDeviceFilters(*pelmHwChild,
2688 hw.usbController.llDeviceFilters);
2689 }
2690 else if ( (m->sv < SettingsVersion_v1_7)
2691 && (pelmHwChild->nameEquals("SATAController"))
2692 )
2693 {
2694 bool f;
2695 if ( (pelmHwChild->getAttributeValue("enabled", f))
2696 && (f)
2697 )
2698 {
2699 StorageController sctl;
2700 sctl.strName = "SATA Controller";
2701 sctl.storageBus = StorageBus_SATA;
2702 sctl.controllerType = StorageControllerType_IntelAhci;
2703
2704 readStorageControllerAttributes(*pelmHwChild, sctl);
2705
2706 strg.llStorageControllers.push_back(sctl);
2707 }
2708 }
2709 else if (pelmHwChild->nameEquals("Network"))
2710 readNetworkAdapters(*pelmHwChild, hw.llNetworkAdapters);
2711 else if (pelmHwChild->nameEquals("RTC"))
2712 {
2713 Utf8Str strLocalOrUTC;
2714 machineUserData.fRTCUseUTC = pelmHwChild->getAttributeValue("localOrUTC", strLocalOrUTC)
2715 && strLocalOrUTC == "UTC";
2716 }
2717 else if ( (pelmHwChild->nameEquals("UART"))
2718 || (pelmHwChild->nameEquals("Uart")) // used before 1.3
2719 )
2720 readSerialPorts(*pelmHwChild, hw.llSerialPorts);
2721 else if ( (pelmHwChild->nameEquals("LPT"))
2722 || (pelmHwChild->nameEquals("Lpt")) // used before 1.3
2723 )
2724 readParallelPorts(*pelmHwChild, hw.llParallelPorts);
2725 else if (pelmHwChild->nameEquals("AudioAdapter"))
2726 readAudioAdapter(*pelmHwChild, hw.audioAdapter);
2727 else if (pelmHwChild->nameEquals("SharedFolders"))
2728 {
2729 xml::NodesLoop nl2(*pelmHwChild, "SharedFolder");
2730 const xml::ElementNode *pelmFolder;
2731 while ((pelmFolder = nl2.forAllNodes()))
2732 {
2733 SharedFolder sf;
2734 pelmFolder->getAttributeValue("name", sf.strName);
2735 pelmFolder->getAttributeValue("hostPath", sf.strHostPath);
2736 pelmFolder->getAttributeValue("writable", sf.fWritable);
2737 pelmFolder->getAttributeValue("autoMount", sf.fAutoMount);
2738 hw.llSharedFolders.push_back(sf);
2739 }
2740 }
2741 else if (pelmHwChild->nameEquals("Clipboard"))
2742 {
2743 Utf8Str strTemp;
2744 if (pelmHwChild->getAttributeValue("mode", strTemp))
2745 {
2746 if (strTemp == "Disabled")
2747 hw.clipboardMode = ClipboardMode_Disabled;
2748 else if (strTemp == "HostToGuest")
2749 hw.clipboardMode = ClipboardMode_HostToGuest;
2750 else if (strTemp == "GuestToHost")
2751 hw.clipboardMode = ClipboardMode_GuestToHost;
2752 else if (strTemp == "Bidirectional")
2753 hw.clipboardMode = ClipboardMode_Bidirectional;
2754 else
2755 throw ConfigFileError(this, pelmHwChild, N_("Invalid value '%s' in Clipboard/@mode attribute"), strTemp.c_str());
2756 }
2757 }
2758 else if (pelmHwChild->nameEquals("Guest"))
2759 {
2760 if (!pelmHwChild->getAttributeValue("memoryBalloonSize", hw.ulMemoryBalloonSize))
2761 pelmHwChild->getAttributeValue("MemoryBalloonSize", hw.ulMemoryBalloonSize); // used before 1.3
2762 }
2763 else if (pelmHwChild->nameEquals("GuestProperties"))
2764 readGuestProperties(*pelmHwChild, hw);
2765 else if (pelmHwChild->nameEquals("IO"))
2766 {
2767 const xml::ElementNode *pelmBwGroups;
2768 const xml::ElementNode *pelmIoChild;
2769
2770 if ((pelmIoChild = pelmHwChild->findChildElement("IoCache")))
2771 {
2772 pelmIoChild->getAttributeValue("enabled", hw.ioSettings.fIoCacheEnabled);
2773 pelmIoChild->getAttributeValue("size", hw.ioSettings.ulIoCacheSize);
2774 }
2775
2776 if ((pelmBwGroups = pelmHwChild->findChildElement("BandwidthGroups")))
2777 {
2778 xml::NodesLoop nl2(*pelmBwGroups, "BandwidthGroup");
2779 const xml::ElementNode *pelmBandwidthGroup;
2780 while ((pelmBandwidthGroup = nl2.forAllNodes()))
2781 {
2782 BandwidthGroup gr;
2783 Utf8Str strTemp;
2784
2785 pelmBandwidthGroup->getAttributeValue("name", gr.strName);
2786
2787 if (pelmBandwidthGroup->getAttributeValue("type", strTemp))
2788 {
2789 if (strTemp == "Disk")
2790 gr.enmType = BandwidthGroupType_Disk;
2791 else if (strTemp == "Network")
2792 gr.enmType = BandwidthGroupType_Network;
2793 else
2794 throw ConfigFileError(this, pelmBandwidthGroup, N_("Invalid value '%s' in BandwidthGroup/@type attribute"), strTemp.c_str());
2795 }
2796 else
2797 throw ConfigFileError(this, pelmBandwidthGroup, N_("Missing BandwidthGroup/@type attribute"));
2798
2799 if (!pelmBandwidthGroup->getAttributeValue("maxBytesPerSec", gr.cMaxBytesPerSec))
2800 {
2801 pelmBandwidthGroup->getAttributeValue("maxMbPerSec", gr.cMaxBytesPerSec);
2802 gr.cMaxBytesPerSec *= _1M;
2803 }
2804 hw.ioSettings.llBandwidthGroups.push_back(gr);
2805 }
2806 }
2807 } else if (pelmHwChild->nameEquals("HostPci")) {
2808 const xml::ElementNode *pelmDevices;
2809
2810 if ((pelmDevices = pelmHwChild->findChildElement("Devices")))
2811 {
2812 xml::NodesLoop nl2(*pelmDevices, "Device");
2813 const xml::ElementNode *pelmDevice;
2814 while ((pelmDevice = nl2.forAllNodes()))
2815 {
2816 HostPciDeviceAttachment hpda;
2817
2818 if (!pelmDevice->getAttributeValue("host", hpda.uHostAddress))
2819 throw ConfigFileError(this, pelmDevice, N_("Missing Device/@host attribute"));
2820
2821 if (!pelmDevice->getAttributeValue("guest", hpda.uGuestAddress))
2822 throw ConfigFileError(this, pelmDevice, N_("Missing Device/@guest attribute"));
2823
2824 /* name is optional */
2825 pelmDevice->getAttributeValue("name", hpda.strDeviceName);
2826
2827 hw.pciAttachments.push_back(hpda);
2828 }
2829 }
2830 }
2831 else if (pelmHwChild->nameEquals("EmulatedUSB"))
2832 {
2833 const xml::ElementNode *pelmCardReader;
2834
2835 if ((pelmCardReader = pelmHwChild->findChildElement("CardReader")))
2836 {
2837 pelmCardReader->getAttributeValue("enabled", hw.fEmulatedUSBCardReader);
2838 }
2839 }
2840 }
2841
2842 if (hw.ulMemorySizeMB == (uint32_t)-1)
2843 throw ConfigFileError(this, &elmHardware, N_("Required Memory/@RAMSize element/attribute is missing"));
2844}
2845
2846/**
2847 * This gets called instead of readStorageControllers() for legacy pre-1.7 settings
2848 * files which have a <HardDiskAttachments> node and storage controller settings
2849 * hidden in the <Hardware> settings. We set the StorageControllers fields just the
2850 * same, just from different sources.
2851 * @param elmHardware <Hardware> XML node.
2852 * @param elmHardDiskAttachments <HardDiskAttachments> XML node.
2853 * @param strg
2854 */
2855void MachineConfigFile::readHardDiskAttachments_pre1_7(const xml::ElementNode &elmHardDiskAttachments,
2856 Storage &strg)
2857{
2858 StorageController *pIDEController = NULL;
2859 StorageController *pSATAController = NULL;
2860
2861 for (StorageControllersList::iterator it = strg.llStorageControllers.begin();
2862 it != strg.llStorageControllers.end();
2863 ++it)
2864 {
2865 StorageController &s = *it;
2866 if (s.storageBus == StorageBus_IDE)
2867 pIDEController = &s;
2868 else if (s.storageBus == StorageBus_SATA)
2869 pSATAController = &s;
2870 }
2871
2872 xml::NodesLoop nl1(elmHardDiskAttachments, "HardDiskAttachment");
2873 const xml::ElementNode *pelmAttachment;
2874 while ((pelmAttachment = nl1.forAllNodes()))
2875 {
2876 AttachedDevice att;
2877 Utf8Str strUUID, strBus;
2878
2879 if (!pelmAttachment->getAttributeValue("hardDisk", strUUID))
2880 throw ConfigFileError(this, pelmAttachment, N_("Required HardDiskAttachment/@hardDisk attribute is missing"));
2881 parseUUID(att.uuid, strUUID);
2882
2883 if (!pelmAttachment->getAttributeValue("bus", strBus))
2884 throw ConfigFileError(this, pelmAttachment, N_("Required HardDiskAttachment/@bus attribute is missing"));
2885 // pre-1.7 'channel' is now port
2886 if (!pelmAttachment->getAttributeValue("channel", att.lPort))
2887 throw ConfigFileError(this, pelmAttachment, N_("Required HardDiskAttachment/@channel attribute is missing"));
2888 // pre-1.7 'device' is still device
2889 if (!pelmAttachment->getAttributeValue("device", att.lDevice))
2890 throw ConfigFileError(this, pelmAttachment, N_("Required HardDiskAttachment/@device attribute is missing"));
2891
2892 att.deviceType = DeviceType_HardDisk;
2893
2894 if (strBus == "IDE")
2895 {
2896 if (!pIDEController)
2897 throw ConfigFileError(this, pelmAttachment, N_("HardDiskAttachment/@bus is 'IDE' but cannot find IDE controller"));
2898 pIDEController->llAttachedDevices.push_back(att);
2899 }
2900 else if (strBus == "SATA")
2901 {
2902 if (!pSATAController)
2903 throw ConfigFileError(this, pelmAttachment, N_("HardDiskAttachment/@bus is 'SATA' but cannot find SATA controller"));
2904 pSATAController->llAttachedDevices.push_back(att);
2905 }
2906 else
2907 throw ConfigFileError(this, pelmAttachment, N_("HardDiskAttachment/@bus attribute has illegal value '%s'"), strBus.c_str());
2908 }
2909}
2910
2911/**
2912 * Reads in a <StorageControllers> block and stores it in the given Storage structure.
2913 * Used both directly from readMachine and from readSnapshot, since snapshots
2914 * have their own storage controllers sections.
2915 *
2916 * This is only called for settings version 1.7 and above; see readHardDiskAttachments_pre1_7()
2917 * for earlier versions.
2918 *
2919 * @param elmStorageControllers
2920 */
2921void MachineConfigFile::readStorageControllers(const xml::ElementNode &elmStorageControllers,
2922 Storage &strg)
2923{
2924 xml::NodesLoop nlStorageControllers(elmStorageControllers, "StorageController");
2925 const xml::ElementNode *pelmController;
2926 while ((pelmController = nlStorageControllers.forAllNodes()))
2927 {
2928 StorageController sctl;
2929
2930 if (!pelmController->getAttributeValue("name", sctl.strName))
2931 throw ConfigFileError(this, pelmController, N_("Required StorageController/@name attribute is missing"));
2932 // canonicalize storage controller names for configs in the switchover
2933 // period.
2934 if (m->sv < SettingsVersion_v1_9)
2935 {
2936 if (sctl.strName == "IDE")
2937 sctl.strName = "IDE Controller";
2938 else if (sctl.strName == "SATA")
2939 sctl.strName = "SATA Controller";
2940 else if (sctl.strName == "SCSI")
2941 sctl.strName = "SCSI Controller";
2942 }
2943
2944 pelmController->getAttributeValue("Instance", sctl.ulInstance);
2945 // default from constructor is 0
2946
2947 pelmController->getAttributeValue("Bootable", sctl.fBootable);
2948 // default from constructor is true which is true
2949 // for settings below version 1.11 because they allowed only
2950 // one controller per type.
2951
2952 Utf8Str strType;
2953 if (!pelmController->getAttributeValue("type", strType))
2954 throw ConfigFileError(this, pelmController, N_("Required StorageController/@type attribute is missing"));
2955
2956 if (strType == "AHCI")
2957 {
2958 sctl.storageBus = StorageBus_SATA;
2959 sctl.controllerType = StorageControllerType_IntelAhci;
2960 }
2961 else if (strType == "LsiLogic")
2962 {
2963 sctl.storageBus = StorageBus_SCSI;
2964 sctl.controllerType = StorageControllerType_LsiLogic;
2965 }
2966 else if (strType == "BusLogic")
2967 {
2968 sctl.storageBus = StorageBus_SCSI;
2969 sctl.controllerType = StorageControllerType_BusLogic;
2970 }
2971 else if (strType == "PIIX3")
2972 {
2973 sctl.storageBus = StorageBus_IDE;
2974 sctl.controllerType = StorageControllerType_PIIX3;
2975 }
2976 else if (strType == "PIIX4")
2977 {
2978 sctl.storageBus = StorageBus_IDE;
2979 sctl.controllerType = StorageControllerType_PIIX4;
2980 }
2981 else if (strType == "ICH6")
2982 {
2983 sctl.storageBus = StorageBus_IDE;
2984 sctl.controllerType = StorageControllerType_ICH6;
2985 }
2986 else if ( (m->sv >= SettingsVersion_v1_9)
2987 && (strType == "I82078")
2988 )
2989 {
2990 sctl.storageBus = StorageBus_Floppy;
2991 sctl.controllerType = StorageControllerType_I82078;
2992 }
2993 else if (strType == "LsiLogicSas")
2994 {
2995 sctl.storageBus = StorageBus_SAS;
2996 sctl.controllerType = StorageControllerType_LsiLogicSas;
2997 }
2998 else
2999 throw ConfigFileError(this, pelmController, N_("Invalid value '%s' for StorageController/@type attribute"), strType.c_str());
3000
3001 readStorageControllerAttributes(*pelmController, sctl);
3002
3003 xml::NodesLoop nlAttached(*pelmController, "AttachedDevice");
3004 const xml::ElementNode *pelmAttached;
3005 while ((pelmAttached = nlAttached.forAllNodes()))
3006 {
3007 AttachedDevice att;
3008 Utf8Str strTemp;
3009 pelmAttached->getAttributeValue("type", strTemp);
3010
3011 att.fDiscard = false;
3012 att.fNonRotational = false;
3013
3014 if (strTemp == "HardDisk")
3015 {
3016 att.deviceType = DeviceType_HardDisk;
3017 pelmAttached->getAttributeValue("nonrotational", att.fNonRotational);
3018 pelmAttached->getAttributeValue("discard", att.fDiscard);
3019 }
3020 else if (m->sv >= SettingsVersion_v1_9)
3021 {
3022 // starting with 1.9 we list DVD and floppy drive info + attachments under <StorageControllers>
3023 if (strTemp == "DVD")
3024 {
3025 att.deviceType = DeviceType_DVD;
3026 pelmAttached->getAttributeValue("passthrough", att.fPassThrough);
3027 pelmAttached->getAttributeValue("tempeject", att.fTempEject);
3028 }
3029 else if (strTemp == "Floppy")
3030 att.deviceType = DeviceType_Floppy;
3031 }
3032
3033 if (att.deviceType != DeviceType_Null)
3034 {
3035 const xml::ElementNode *pelmImage;
3036 // all types can have images attached, but for HardDisk it's required
3037 if (!(pelmImage = pelmAttached->findChildElement("Image")))
3038 {
3039 if (att.deviceType == DeviceType_HardDisk)
3040 throw ConfigFileError(this, pelmImage, N_("Required AttachedDevice/Image element is missing"));
3041 else
3042 {
3043 // DVDs and floppies can also have <HostDrive> instead of <Image>
3044 const xml::ElementNode *pelmHostDrive;
3045 if ((pelmHostDrive = pelmAttached->findChildElement("HostDrive")))
3046 if (!pelmHostDrive->getAttributeValue("src", att.strHostDriveSrc))
3047 throw ConfigFileError(this, pelmHostDrive, N_("Required AttachedDevice/HostDrive/@src attribute is missing"));
3048 }
3049 }
3050 else
3051 {
3052 if (!pelmImage->getAttributeValue("uuid", strTemp))
3053 throw ConfigFileError(this, pelmImage, N_("Required AttachedDevice/Image/@uuid attribute is missing"));
3054 parseUUID(att.uuid, strTemp);
3055 }
3056
3057 if (!pelmAttached->getAttributeValue("port", att.lPort))
3058 throw ConfigFileError(this, pelmImage, N_("Required AttachedDevice/@port attribute is missing"));
3059 if (!pelmAttached->getAttributeValue("device", att.lDevice))
3060 throw ConfigFileError(this, pelmImage, N_("Required AttachedDevice/@device attribute is missing"));
3061
3062 pelmAttached->getAttributeValue("bandwidthGroup", att.strBwGroup);
3063 sctl.llAttachedDevices.push_back(att);
3064 }
3065 }
3066
3067 strg.llStorageControllers.push_back(sctl);
3068 }
3069}
3070
3071/**
3072 * This gets called for legacy pre-1.9 settings files after having parsed the
3073 * <Hardware> and <StorageControllers> sections to parse <Hardware> once more
3074 * for the <DVDDrive> and <FloppyDrive> sections.
3075 *
3076 * Before settings version 1.9, DVD and floppy drives were specified separately
3077 * under <Hardware>; we then need this extra loop to make sure the storage
3078 * controller structs are already set up so we can add stuff to them.
3079 *
3080 * @param elmHardware
3081 * @param strg
3082 */
3083void MachineConfigFile::readDVDAndFloppies_pre1_9(const xml::ElementNode &elmHardware,
3084 Storage &strg)
3085{
3086 xml::NodesLoop nl1(elmHardware);
3087 const xml::ElementNode *pelmHwChild;
3088 while ((pelmHwChild = nl1.forAllNodes()))
3089 {
3090 if (pelmHwChild->nameEquals("DVDDrive"))
3091 {
3092 // create a DVD "attached device" and attach it to the existing IDE controller
3093 AttachedDevice att;
3094 att.deviceType = DeviceType_DVD;
3095 // legacy DVD drive is always secondary master (port 1, device 0)
3096 att.lPort = 1;
3097 att.lDevice = 0;
3098 pelmHwChild->getAttributeValue("passthrough", att.fPassThrough);
3099 pelmHwChild->getAttributeValue("tempeject", att.fTempEject);
3100
3101 const xml::ElementNode *pDriveChild;
3102 Utf8Str strTmp;
3103 if ( ((pDriveChild = pelmHwChild->findChildElement("Image")))
3104 && (pDriveChild->getAttributeValue("uuid", strTmp))
3105 )
3106 parseUUID(att.uuid, strTmp);
3107 else if ((pDriveChild = pelmHwChild->findChildElement("HostDrive")))
3108 pDriveChild->getAttributeValue("src", att.strHostDriveSrc);
3109
3110 // find the IDE controller and attach the DVD drive
3111 bool fFound = false;
3112 for (StorageControllersList::iterator it = strg.llStorageControllers.begin();
3113 it != strg.llStorageControllers.end();
3114 ++it)
3115 {
3116 StorageController &sctl = *it;
3117 if (sctl.storageBus == StorageBus_IDE)
3118 {
3119 sctl.llAttachedDevices.push_back(att);
3120 fFound = true;
3121 break;
3122 }
3123 }
3124
3125 if (!fFound)
3126 throw ConfigFileError(this, pelmHwChild, N_("Internal error: found DVD drive but IDE controller does not exist"));
3127 // shouldn't happen because pre-1.9 settings files always had at least one IDE controller in the settings
3128 // which should have gotten parsed in <StorageControllers> before this got called
3129 }
3130 else if (pelmHwChild->nameEquals("FloppyDrive"))
3131 {
3132 bool fEnabled;
3133 if ( (pelmHwChild->getAttributeValue("enabled", fEnabled))
3134 && (fEnabled)
3135 )
3136 {
3137 // create a new floppy controller and attach a floppy "attached device"
3138 StorageController sctl;
3139 sctl.strName = "Floppy Controller";
3140 sctl.storageBus = StorageBus_Floppy;
3141 sctl.controllerType = StorageControllerType_I82078;
3142 sctl.ulPortCount = 1;
3143
3144 AttachedDevice att;
3145 att.deviceType = DeviceType_Floppy;
3146 att.lPort = 0;
3147 att.lDevice = 0;
3148
3149 const xml::ElementNode *pDriveChild;
3150 Utf8Str strTmp;
3151 if ( ((pDriveChild = pelmHwChild->findChildElement("Image")))
3152 && (pDriveChild->getAttributeValue("uuid", strTmp))
3153 )
3154 parseUUID(att.uuid, strTmp);
3155 else if ((pDriveChild = pelmHwChild->findChildElement("HostDrive")))
3156 pDriveChild->getAttributeValue("src", att.strHostDriveSrc);
3157
3158 // store attachment with controller
3159 sctl.llAttachedDevices.push_back(att);
3160 // store controller with storage
3161 strg.llStorageControllers.push_back(sctl);
3162 }
3163 }
3164 }
3165}
3166
3167/**
3168 * Called for reading the <Teleporter> element under <Machine>.
3169 */
3170void MachineConfigFile::readTeleporter(const xml::ElementNode *pElmTeleporter,
3171 MachineUserData *pUserData)
3172{
3173 pElmTeleporter->getAttributeValue("enabled", pUserData->fTeleporterEnabled);
3174 pElmTeleporter->getAttributeValue("port", pUserData->uTeleporterPort);
3175 pElmTeleporter->getAttributeValue("address", pUserData->strTeleporterAddress);
3176 pElmTeleporter->getAttributeValue("password", pUserData->strTeleporterPassword);
3177
3178 if ( pUserData->strTeleporterPassword.isNotEmpty()
3179 && !VBoxIsPasswordHashed(&pUserData->strTeleporterPassword))
3180 VBoxHashPassword(&pUserData->strTeleporterPassword);
3181}
3182
3183/**
3184 * Called for reading the <Debugging> element under <Machine> or <Snapshot>.
3185 */
3186void MachineConfigFile::readDebugging(const xml::ElementNode *pElmDebugging, Debugging *pDbg)
3187{
3188 if (!pElmDebugging || m->sv < SettingsVersion_v1_13)
3189 return;
3190
3191 const xml::ElementNode * const pelmTracing = pElmDebugging->findChildElement("Tracing");
3192 if (pelmTracing)
3193 {
3194 pelmTracing->getAttributeValue("enabled", pDbg->fTracingEnabled);
3195 pelmTracing->getAttributeValue("allowTracingToAccessVM", pDbg->fAllowTracingToAccessVM);
3196 pelmTracing->getAttributeValue("config", pDbg->strTracingConfig);
3197 }
3198}
3199
3200/**
3201 * Called for reading the <Autostart> element under <Machine> or <Snapshot>.
3202 */
3203void MachineConfigFile::readAutostart(const xml::ElementNode *pElmAutostart, Autostart *pAutostart)
3204{
3205 Utf8Str strAutostop;
3206
3207 if (!pElmAutostart || m->sv < SettingsVersion_v1_13)
3208 return;
3209
3210 pElmAutostart->getAttributeValue("enabled", pAutostart->fAutostartEnabled);
3211 pElmAutostart->getAttributeValue("delay", pAutostart->uAutostartDelay);
3212 pElmAutostart->getAttributeValue("autostop", strAutostop);
3213 if (strAutostop == "Disabled")
3214 pAutostart->enmAutostopType = AutostopType_Disabled;
3215 else if (strAutostop == "SaveState")
3216 pAutostart->enmAutostopType = AutostopType_SaveState;
3217 else if (strAutostop == "PowerOff")
3218 pAutostart->enmAutostopType = AutostopType_PowerOff;
3219 else if (strAutostop == "AcpiShutdown")
3220 pAutostart->enmAutostopType = AutostopType_AcpiShutdown;
3221 else
3222 throw ConfigFileError(this, pElmAutostart, N_("Invalid value '%s' for Autostart/@autostop attribute"), strAutostop.c_str());
3223}
3224
3225/**
3226 * Called initially for the <Snapshot> element under <Machine>, if present,
3227 * to store the snapshot's data into the given Snapshot structure (which is
3228 * then the one in the Machine struct). This might then recurse if
3229 * a <Snapshots> (plural) element is found in the snapshot, which should
3230 * contain a list of child snapshots; such lists are maintained in the
3231 * Snapshot structure.
3232 *
3233 * @param elmSnapshot
3234 * @param snap
3235 */
3236void MachineConfigFile::readSnapshot(const xml::ElementNode &elmSnapshot,
3237 Snapshot &snap)
3238{
3239 Utf8Str strTemp;
3240
3241 if (!elmSnapshot.getAttributeValue("uuid", strTemp))
3242 throw ConfigFileError(this, &elmSnapshot, N_("Required Snapshot/@uuid attribute is missing"));
3243 parseUUID(snap.uuid, strTemp);
3244
3245 if (!elmSnapshot.getAttributeValue("name", snap.strName))
3246 throw ConfigFileError(this, &elmSnapshot, N_("Required Snapshot/@name attribute is missing"));
3247
3248 // earlier 3.1 trunk builds had a bug and added Description as an attribute, read it silently and write it back as an element
3249 elmSnapshot.getAttributeValue("Description", snap.strDescription);
3250
3251 if (!elmSnapshot.getAttributeValue("timeStamp", strTemp))
3252 throw ConfigFileError(this, &elmSnapshot, N_("Required Snapshot/@timeStamp attribute is missing"));
3253 parseTimestamp(snap.timestamp, strTemp);
3254
3255 elmSnapshot.getAttributeValuePath("stateFile", snap.strStateFile); // online snapshots only
3256
3257 // parse Hardware before the other elements because other things depend on it
3258 const xml::ElementNode *pelmHardware;
3259 if (!(pelmHardware = elmSnapshot.findChildElement("Hardware")))
3260 throw ConfigFileError(this, &elmSnapshot, N_("Required Snapshot/@Hardware element is missing"));
3261 readHardware(*pelmHardware, snap.hardware, snap.storage);
3262
3263 xml::NodesLoop nlSnapshotChildren(elmSnapshot);
3264 const xml::ElementNode *pelmSnapshotChild;
3265 while ((pelmSnapshotChild = nlSnapshotChildren.forAllNodes()))
3266 {
3267 if (pelmSnapshotChild->nameEquals("Description"))
3268 snap.strDescription = pelmSnapshotChild->getValue();
3269 else if ( (m->sv < SettingsVersion_v1_7)
3270 && (pelmSnapshotChild->nameEquals("HardDiskAttachments"))
3271 )
3272 readHardDiskAttachments_pre1_7(*pelmSnapshotChild, snap.storage);
3273 else if ( (m->sv >= SettingsVersion_v1_7)
3274 && (pelmSnapshotChild->nameEquals("StorageControllers"))
3275 )
3276 readStorageControllers(*pelmSnapshotChild, snap.storage);
3277 else if (pelmSnapshotChild->nameEquals("Snapshots"))
3278 {
3279 xml::NodesLoop nlChildSnapshots(*pelmSnapshotChild);
3280 const xml::ElementNode *pelmChildSnapshot;
3281 while ((pelmChildSnapshot = nlChildSnapshots.forAllNodes()))
3282 {
3283 if (pelmChildSnapshot->nameEquals("Snapshot"))
3284 {
3285 Snapshot child;
3286 readSnapshot(*pelmChildSnapshot, child);
3287 snap.llChildSnapshots.push_back(child);
3288 }
3289 }
3290 }
3291 }
3292
3293 if (m->sv < SettingsVersion_v1_9)
3294 // go through Hardware once more to repair the settings controller structures
3295 // with data from old DVDDrive and FloppyDrive elements
3296 readDVDAndFloppies_pre1_9(*pelmHardware, snap.storage);
3297
3298 readDebugging(elmSnapshot.findChildElement("Debugging"), &snap.debugging);
3299 readAutostart(elmSnapshot.findChildElement("Autostart"), &snap.autostart);
3300}
3301
3302const struct {
3303 const char *pcszOld;
3304 const char *pcszNew;
3305} aConvertOSTypes[] =
3306{
3307 { "unknown", "Other" },
3308 { "dos", "DOS" },
3309 { "win31", "Windows31" },
3310 { "win95", "Windows95" },
3311 { "win98", "Windows98" },
3312 { "winme", "WindowsMe" },
3313 { "winnt4", "WindowsNT4" },
3314 { "win2k", "Windows2000" },
3315 { "winxp", "WindowsXP" },
3316 { "win2k3", "Windows2003" },
3317 { "winvista", "WindowsVista" },
3318 { "win2k8", "Windows2008" },
3319 { "os2warp3", "OS2Warp3" },
3320 { "os2warp4", "OS2Warp4" },
3321 { "os2warp45", "OS2Warp45" },
3322 { "ecs", "OS2eCS" },
3323 { "linux22", "Linux22" },
3324 { "linux24", "Linux24" },
3325 { "linux26", "Linux26" },
3326 { "archlinux", "ArchLinux" },
3327 { "debian", "Debian" },
3328 { "opensuse", "OpenSUSE" },
3329 { "fedoracore", "Fedora" },
3330 { "gentoo", "Gentoo" },
3331 { "mandriva", "Mandriva" },
3332 { "redhat", "RedHat" },
3333 { "ubuntu", "Ubuntu" },
3334 { "xandros", "Xandros" },
3335 { "freebsd", "FreeBSD" },
3336 { "openbsd", "OpenBSD" },
3337 { "netbsd", "NetBSD" },
3338 { "netware", "Netware" },
3339 { "solaris", "Solaris" },
3340 { "opensolaris", "OpenSolaris" },
3341 { "l4", "L4" }
3342};
3343
3344void MachineConfigFile::convertOldOSType_pre1_5(Utf8Str &str)
3345{
3346 for (unsigned u = 0;
3347 u < RT_ELEMENTS(aConvertOSTypes);
3348 ++u)
3349 {
3350 if (str == aConvertOSTypes[u].pcszOld)
3351 {
3352 str = aConvertOSTypes[u].pcszNew;
3353 break;
3354 }
3355 }
3356}
3357
3358/**
3359 * Called from the constructor to actually read in the <Machine> element
3360 * of a machine config file.
3361 * @param elmMachine
3362 */
3363void MachineConfigFile::readMachine(const xml::ElementNode &elmMachine)
3364{
3365 Utf8Str strUUID;
3366 if ( (elmMachine.getAttributeValue("uuid", strUUID))
3367 && (elmMachine.getAttributeValue("name", machineUserData.strName))
3368 )
3369 {
3370 parseUUID(uuid, strUUID);
3371
3372 elmMachine.getAttributeValue("nameSync", machineUserData.fNameSync);
3373
3374 Utf8Str str;
3375 elmMachine.getAttributeValue("Description", machineUserData.strDescription);
3376
3377 elmMachine.getAttributeValue("OSType", machineUserData.strOsType);
3378 if (m->sv < SettingsVersion_v1_5)
3379 convertOldOSType_pre1_5(machineUserData.strOsType);
3380
3381 elmMachine.getAttributeValuePath("stateFile", strStateFile);
3382
3383 if (elmMachine.getAttributeValue("currentSnapshot", str))
3384 parseUUID(uuidCurrentSnapshot, str);
3385
3386 elmMachine.getAttributeValuePath("snapshotFolder", machineUserData.strSnapshotFolder);
3387
3388 if (!elmMachine.getAttributeValue("currentStateModified", fCurrentStateModified))
3389 fCurrentStateModified = true;
3390 if (elmMachine.getAttributeValue("lastStateChange", str))
3391 parseTimestamp(timeLastStateChange, str);
3392 // constructor has called RTTimeNow(&timeLastStateChange) before
3393 if (elmMachine.getAttributeValue("aborted", fAborted))
3394 fAborted = true;
3395
3396 // parse Hardware before the other elements because other things depend on it
3397 const xml::ElementNode *pelmHardware;
3398 if (!(pelmHardware = elmMachine.findChildElement("Hardware")))
3399 throw ConfigFileError(this, &elmMachine, N_("Required Machine/Hardware element is missing"));
3400 readHardware(*pelmHardware, hardwareMachine, storageMachine);
3401
3402 xml::NodesLoop nlRootChildren(elmMachine);
3403 const xml::ElementNode *pelmMachineChild;
3404 while ((pelmMachineChild = nlRootChildren.forAllNodes()))
3405 {
3406 if (pelmMachineChild->nameEquals("ExtraData"))
3407 readExtraData(*pelmMachineChild,
3408 mapExtraDataItems);
3409 else if ( (m->sv < SettingsVersion_v1_7)
3410 && (pelmMachineChild->nameEquals("HardDiskAttachments"))
3411 )
3412 readHardDiskAttachments_pre1_7(*pelmMachineChild, storageMachine);
3413 else if ( (m->sv >= SettingsVersion_v1_7)
3414 && (pelmMachineChild->nameEquals("StorageControllers"))
3415 )
3416 readStorageControllers(*pelmMachineChild, storageMachine);
3417 else if (pelmMachineChild->nameEquals("Snapshot"))
3418 {
3419 Snapshot snap;
3420 // this will recurse into child snapshots, if necessary
3421 readSnapshot(*pelmMachineChild, snap);
3422 llFirstSnapshot.push_back(snap);
3423 }
3424 else if (pelmMachineChild->nameEquals("Description"))
3425 machineUserData.strDescription = pelmMachineChild->getValue();
3426 else if (pelmMachineChild->nameEquals("Teleporter"))
3427 readTeleporter(pelmMachineChild, &machineUserData);
3428 else if (pelmMachineChild->nameEquals("FaultTolerance"))
3429 {
3430 Utf8Str strFaultToleranceSate;
3431 if (pelmMachineChild->getAttributeValue("state", strFaultToleranceSate))
3432 {
3433 if (strFaultToleranceSate == "master")
3434 machineUserData.enmFaultToleranceState = FaultToleranceState_Master;
3435 else
3436 if (strFaultToleranceSate == "standby")
3437 machineUserData.enmFaultToleranceState = FaultToleranceState_Standby;
3438 else
3439 machineUserData.enmFaultToleranceState = FaultToleranceState_Inactive;
3440 }
3441 pelmMachineChild->getAttributeValue("port", machineUserData.uFaultTolerancePort);
3442 pelmMachineChild->getAttributeValue("address", machineUserData.strFaultToleranceAddress);
3443 pelmMachineChild->getAttributeValue("interval", machineUserData.uFaultToleranceInterval);
3444 pelmMachineChild->getAttributeValue("password", machineUserData.strFaultTolerancePassword);
3445 }
3446 else if (pelmMachineChild->nameEquals("MediaRegistry"))
3447 readMediaRegistry(*pelmMachineChild, mediaRegistry);
3448 else if (pelmMachineChild->nameEquals("Debugging"))
3449 readDebugging(pelmMachineChild, &debugging);
3450 else if (pelmMachineChild->nameEquals("Autostart"))
3451 readAutostart(pelmMachineChild, &autostart);
3452 }
3453
3454 if (m->sv < SettingsVersion_v1_9)
3455 // go through Hardware once more to repair the settings controller structures
3456 // with data from old DVDDrive and FloppyDrive elements
3457 readDVDAndFloppies_pre1_9(*pelmHardware, storageMachine);
3458 }
3459 else
3460 throw ConfigFileError(this, &elmMachine, N_("Required Machine/@uuid or @name attributes is missing"));
3461}
3462
3463/**
3464 * Creates a <Hardware> node under elmParent and then writes out the XML
3465 * keys under that. Called for both the <Machine> node and for snapshots.
3466 * @param elmParent
3467 * @param st
3468 */
3469void MachineConfigFile::buildHardwareXML(xml::ElementNode &elmParent,
3470 const Hardware &hw,
3471 const Storage &strg)
3472{
3473 xml::ElementNode *pelmHardware = elmParent.createChild("Hardware");
3474
3475 if (m->sv >= SettingsVersion_v1_4)
3476 pelmHardware->setAttribute("version", hw.strVersion);
3477 if ( (m->sv >= SettingsVersion_v1_9)
3478 && (!hw.uuid.isEmpty())
3479 )
3480 pelmHardware->setAttribute("uuid", hw.uuid.toStringCurly());
3481
3482 xml::ElementNode *pelmCPU = pelmHardware->createChild("CPU");
3483
3484 xml::ElementNode *pelmHwVirtEx = pelmCPU->createChild("HardwareVirtEx");
3485 pelmHwVirtEx->setAttribute("enabled", hw.fHardwareVirt);
3486 if (m->sv >= SettingsVersion_v1_9)
3487 pelmHwVirtEx->setAttribute("exclusive", hw.fHardwareVirtExclusive);
3488
3489 pelmCPU->createChild("HardwareVirtExNestedPaging")->setAttribute("enabled", hw.fNestedPaging);
3490 pelmCPU->createChild("HardwareVirtExVPID")->setAttribute("enabled", hw.fVPID);
3491 pelmCPU->createChild("PAE")->setAttribute("enabled", hw.fPAE);
3492
3493 if (hw.fSyntheticCpu)
3494 pelmCPU->createChild("SyntheticCpu")->setAttribute("enabled", hw.fSyntheticCpu);
3495 pelmCPU->setAttribute("count", hw.cCPUs);
3496 if (hw.ulCpuExecutionCap != 100)
3497 pelmCPU->setAttribute("executionCap", hw.ulCpuExecutionCap);
3498
3499 /* Always save this setting as we have changed the default in 4.0 (on for large memory 64-bit systems). */
3500 pelmCPU->createChild("HardwareVirtExLargePages")->setAttribute("enabled", hw.fLargePages);
3501
3502 if (m->sv >= SettingsVersion_v1_9)
3503 pelmCPU->createChild("HardwareVirtForce")->setAttribute("enabled", hw.fHardwareVirtForce);
3504
3505 if (m->sv >= SettingsVersion_v1_10)
3506 {
3507 pelmCPU->setAttribute("hotplug", hw.fCpuHotPlug);
3508
3509 xml::ElementNode *pelmCpuTree = NULL;
3510 for (CpuList::const_iterator it = hw.llCpus.begin();
3511 it != hw.llCpus.end();
3512 ++it)
3513 {
3514 const Cpu &cpu = *it;
3515
3516 if (pelmCpuTree == NULL)
3517 pelmCpuTree = pelmCPU->createChild("CpuTree");
3518
3519 xml::ElementNode *pelmCpu = pelmCpuTree->createChild("Cpu");
3520 pelmCpu->setAttribute("id", cpu.ulId);
3521 }
3522 }
3523
3524 xml::ElementNode *pelmCpuIdTree = NULL;
3525 for (CpuIdLeafsList::const_iterator it = hw.llCpuIdLeafs.begin();
3526 it != hw.llCpuIdLeafs.end();
3527 ++it)
3528 {
3529 const CpuIdLeaf &leaf = *it;
3530
3531 if (pelmCpuIdTree == NULL)
3532 pelmCpuIdTree = pelmCPU->createChild("CpuIdTree");
3533
3534 xml::ElementNode *pelmCpuIdLeaf = pelmCpuIdTree->createChild("CpuIdLeaf");
3535 pelmCpuIdLeaf->setAttribute("id", leaf.ulId);
3536 pelmCpuIdLeaf->setAttribute("eax", leaf.ulEax);
3537 pelmCpuIdLeaf->setAttribute("ebx", leaf.ulEbx);
3538 pelmCpuIdLeaf->setAttribute("ecx", leaf.ulEcx);
3539 pelmCpuIdLeaf->setAttribute("edx", leaf.ulEdx);
3540 }
3541
3542 xml::ElementNode *pelmMemory = pelmHardware->createChild("Memory");
3543 pelmMemory->setAttribute("RAMSize", hw.ulMemorySizeMB);
3544 if (m->sv >= SettingsVersion_v1_10)
3545 {
3546 pelmMemory->setAttribute("PageFusion", hw.fPageFusionEnabled);
3547 }
3548
3549 if ( (m->sv >= SettingsVersion_v1_9)
3550 && (hw.firmwareType >= FirmwareType_EFI)
3551 )
3552 {
3553 xml::ElementNode *pelmFirmware = pelmHardware->createChild("Firmware");
3554 const char *pcszFirmware;
3555
3556 switch (hw.firmwareType)
3557 {
3558 case FirmwareType_EFI: pcszFirmware = "EFI"; break;
3559 case FirmwareType_EFI32: pcszFirmware = "EFI32"; break;
3560 case FirmwareType_EFI64: pcszFirmware = "EFI64"; break;
3561 case FirmwareType_EFIDUAL: pcszFirmware = "EFIDUAL"; break;
3562 default: pcszFirmware = "None"; break;
3563 }
3564 pelmFirmware->setAttribute("type", pcszFirmware);
3565 }
3566
3567 if ( (m->sv >= SettingsVersion_v1_10)
3568 )
3569 {
3570 xml::ElementNode *pelmHid = pelmHardware->createChild("HID");
3571 const char *pcszHid;
3572
3573 switch (hw.pointingHidType)
3574 {
3575 case PointingHidType_USBMouse: pcszHid = "USBMouse"; break;
3576 case PointingHidType_USBTablet: pcszHid = "USBTablet"; break;
3577 case PointingHidType_PS2Mouse: pcszHid = "PS2Mouse"; break;
3578 case PointingHidType_ComboMouse: pcszHid = "ComboMouse"; break;
3579 case PointingHidType_None: pcszHid = "None"; break;
3580 default: Assert(false); pcszHid = "PS2Mouse"; break;
3581 }
3582 pelmHid->setAttribute("Pointing", pcszHid);
3583
3584 switch (hw.keyboardHidType)
3585 {
3586 case KeyboardHidType_USBKeyboard: pcszHid = "USBKeyboard"; break;
3587 case KeyboardHidType_PS2Keyboard: pcszHid = "PS2Keyboard"; break;
3588 case KeyboardHidType_ComboKeyboard: pcszHid = "ComboKeyboard"; break;
3589 case KeyboardHidType_None: pcszHid = "None"; break;
3590 default: Assert(false); pcszHid = "PS2Keyboard"; break;
3591 }
3592 pelmHid->setAttribute("Keyboard", pcszHid);
3593 }
3594
3595 if ( (m->sv >= SettingsVersion_v1_10)
3596 )
3597 {
3598 xml::ElementNode *pelmHpet = pelmHardware->createChild("HPET");
3599 pelmHpet->setAttribute("enabled", hw.fHpetEnabled);
3600 }
3601
3602 if ( (m->sv >= SettingsVersion_v1_11)
3603 )
3604 {
3605 xml::ElementNode *pelmChipset = pelmHardware->createChild("Chipset");
3606 const char *pcszChipset;
3607
3608 switch (hw.chipsetType)
3609 {
3610 case ChipsetType_PIIX3: pcszChipset = "PIIX3"; break;
3611 case ChipsetType_ICH9: pcszChipset = "ICH9"; break;
3612 default: Assert(false); pcszChipset = "PIIX3"; break;
3613 }
3614 pelmChipset->setAttribute("type", pcszChipset);
3615 }
3616
3617 xml::ElementNode *pelmBoot = pelmHardware->createChild("Boot");
3618 for (BootOrderMap::const_iterator it = hw.mapBootOrder.begin();
3619 it != hw.mapBootOrder.end();
3620 ++it)
3621 {
3622 uint32_t i = it->first;
3623 DeviceType_T type = it->second;
3624 const char *pcszDevice;
3625
3626 switch (type)
3627 {
3628 case DeviceType_Floppy: pcszDevice = "Floppy"; break;
3629 case DeviceType_DVD: pcszDevice = "DVD"; break;
3630 case DeviceType_HardDisk: pcszDevice = "HardDisk"; break;
3631 case DeviceType_Network: pcszDevice = "Network"; break;
3632 default: /*case DeviceType_Null:*/ pcszDevice = "None"; break;
3633 }
3634
3635 xml::ElementNode *pelmOrder = pelmBoot->createChild("Order");
3636 pelmOrder->setAttribute("position",
3637 i + 1); // XML is 1-based but internal data is 0-based
3638 pelmOrder->setAttribute("device", pcszDevice);
3639 }
3640
3641 xml::ElementNode *pelmDisplay = pelmHardware->createChild("Display");
3642 pelmDisplay->setAttribute("VRAMSize", hw.ulVRAMSizeMB);
3643 pelmDisplay->setAttribute("monitorCount", hw.cMonitors);
3644 pelmDisplay->setAttribute("accelerate3D", hw.fAccelerate3D);
3645
3646 if (m->sv >= SettingsVersion_v1_8)
3647 pelmDisplay->setAttribute("accelerate2DVideo", hw.fAccelerate2DVideo);
3648
3649 xml::ElementNode *pelmVRDE = pelmHardware->createChild("RemoteDisplay");
3650 pelmVRDE->setAttribute("enabled", hw.vrdeSettings.fEnabled);
3651 if (m->sv < SettingsVersion_v1_11)
3652 {
3653 /* In VBox 4.0 these attributes are replaced with "Properties". */
3654 Utf8Str strPort;
3655 StringsMap::const_iterator it = hw.vrdeSettings.mapProperties.find("TCP/Ports");
3656 if (it != hw.vrdeSettings.mapProperties.end())
3657 strPort = it->second;
3658 if (!strPort.length())
3659 strPort = "3389";
3660 pelmVRDE->setAttribute("port", strPort);
3661
3662 Utf8Str strAddress;
3663 it = hw.vrdeSettings.mapProperties.find("TCP/Address");
3664 if (it != hw.vrdeSettings.mapProperties.end())
3665 strAddress = it->second;
3666 if (strAddress.length())
3667 pelmVRDE->setAttribute("netAddress", strAddress);
3668 }
3669 const char *pcszAuthType;
3670 switch (hw.vrdeSettings.authType)
3671 {
3672 case AuthType_Guest: pcszAuthType = "Guest"; break;
3673 case AuthType_External: pcszAuthType = "External"; break;
3674 default: /*case AuthType_Null:*/ pcszAuthType = "Null"; break;
3675 }
3676 pelmVRDE->setAttribute("authType", pcszAuthType);
3677
3678 if (hw.vrdeSettings.ulAuthTimeout != 0)
3679 pelmVRDE->setAttribute("authTimeout", hw.vrdeSettings.ulAuthTimeout);
3680 if (hw.vrdeSettings.fAllowMultiConnection)
3681 pelmVRDE->setAttribute("allowMultiConnection", hw.vrdeSettings.fAllowMultiConnection);
3682 if (hw.vrdeSettings.fReuseSingleConnection)
3683 pelmVRDE->setAttribute("reuseSingleConnection", hw.vrdeSettings.fReuseSingleConnection);
3684
3685 if (m->sv == SettingsVersion_v1_10)
3686 {
3687 xml::ElementNode *pelmVideoChannel = pelmVRDE->createChild("VideoChannel");
3688
3689 /* In 4.0 videochannel settings were replaced with properties, so look at properties. */
3690 Utf8Str str;
3691 StringsMap::const_iterator it = hw.vrdeSettings.mapProperties.find("VideoChannel/Enabled");
3692 if (it != hw.vrdeSettings.mapProperties.end())
3693 str = it->second;
3694 bool fVideoChannel = RTStrICmp(str.c_str(), "true") == 0
3695 || RTStrCmp(str.c_str(), "1") == 0;
3696 pelmVideoChannel->setAttribute("enabled", fVideoChannel);
3697
3698 it = hw.vrdeSettings.mapProperties.find("VideoChannel/Quality");
3699 if (it != hw.vrdeSettings.mapProperties.end())
3700 str = it->second;
3701 uint32_t ulVideoChannelQuality = RTStrToUInt32(str.c_str()); /* This returns 0 on invalid string which is ok. */
3702 if (ulVideoChannelQuality == 0)
3703 ulVideoChannelQuality = 75;
3704 else
3705 ulVideoChannelQuality = RT_CLAMP(ulVideoChannelQuality, 10, 100);
3706 pelmVideoChannel->setAttribute("quality", ulVideoChannelQuality);
3707 }
3708 if (m->sv >= SettingsVersion_v1_11)
3709 {
3710 if (hw.vrdeSettings.strAuthLibrary.length())
3711 pelmVRDE->setAttribute("authLibrary", hw.vrdeSettings.strAuthLibrary);
3712 if (hw.vrdeSettings.strVrdeExtPack.isNotEmpty())
3713 pelmVRDE->setAttribute("VRDEExtPack", hw.vrdeSettings.strVrdeExtPack);
3714 if (hw.vrdeSettings.mapProperties.size() > 0)
3715 {
3716 xml::ElementNode *pelmProperties = pelmVRDE->createChild("VRDEProperties");
3717 for (StringsMap::const_iterator it = hw.vrdeSettings.mapProperties.begin();
3718 it != hw.vrdeSettings.mapProperties.end();
3719 ++it)
3720 {
3721 const Utf8Str &strName = it->first;
3722 const Utf8Str &strValue = it->second;
3723 xml::ElementNode *pelm = pelmProperties->createChild("Property");
3724 pelm->setAttribute("name", strName);
3725 pelm->setAttribute("value", strValue);
3726 }
3727 }
3728 }
3729
3730 xml::ElementNode *pelmBIOS = pelmHardware->createChild("BIOS");
3731 pelmBIOS->createChild("ACPI")->setAttribute("enabled", hw.biosSettings.fACPIEnabled);
3732 pelmBIOS->createChild("IOAPIC")->setAttribute("enabled", hw.biosSettings.fIOAPICEnabled);
3733
3734 xml::ElementNode *pelmLogo = pelmBIOS->createChild("Logo");
3735 pelmLogo->setAttribute("fadeIn", hw.biosSettings.fLogoFadeIn);
3736 pelmLogo->setAttribute("fadeOut", hw.biosSettings.fLogoFadeOut);
3737 pelmLogo->setAttribute("displayTime", hw.biosSettings.ulLogoDisplayTime);
3738 if (hw.biosSettings.strLogoImagePath.length())
3739 pelmLogo->setAttribute("imagePath", hw.biosSettings.strLogoImagePath);
3740
3741 const char *pcszBootMenu;
3742 switch (hw.biosSettings.biosBootMenuMode)
3743 {
3744 case BIOSBootMenuMode_Disabled: pcszBootMenu = "Disabled"; break;
3745 case BIOSBootMenuMode_MenuOnly: pcszBootMenu = "MenuOnly"; break;
3746 default: /*BIOSBootMenuMode_MessageAndMenu*/ pcszBootMenu = "MessageAndMenu"; break;
3747 }
3748 pelmBIOS->createChild("BootMenu")->setAttribute("mode", pcszBootMenu);
3749 pelmBIOS->createChild("TimeOffset")->setAttribute("value", hw.biosSettings.llTimeOffset);
3750 pelmBIOS->createChild("PXEDebug")->setAttribute("enabled", hw.biosSettings.fPXEDebugEnabled);
3751
3752 if (m->sv < SettingsVersion_v1_9)
3753 {
3754 // settings formats before 1.9 had separate DVDDrive and FloppyDrive items under Hardware;
3755 // run thru the storage controllers to see if we have a DVD or floppy drives
3756 size_t cDVDs = 0;
3757 size_t cFloppies = 0;
3758
3759 xml::ElementNode *pelmDVD = pelmHardware->createChild("DVDDrive");
3760 xml::ElementNode *pelmFloppy = pelmHardware->createChild("FloppyDrive");
3761
3762 for (StorageControllersList::const_iterator it = strg.llStorageControllers.begin();
3763 it != strg.llStorageControllers.end();
3764 ++it)
3765 {
3766 const StorageController &sctl = *it;
3767 // in old settings format, the DVD drive could only have been under the IDE controller
3768 if (sctl.storageBus == StorageBus_IDE)
3769 {
3770 for (AttachedDevicesList::const_iterator it2 = sctl.llAttachedDevices.begin();
3771 it2 != sctl.llAttachedDevices.end();
3772 ++it2)
3773 {
3774 const AttachedDevice &att = *it2;
3775 if (att.deviceType == DeviceType_DVD)
3776 {
3777 if (cDVDs > 0)
3778 throw ConfigFileError(this, NULL, N_("Internal error: cannot save more than one DVD drive with old settings format"));
3779
3780 ++cDVDs;
3781
3782 pelmDVD->setAttribute("passthrough", att.fPassThrough);
3783 if (att.fTempEject)
3784 pelmDVD->setAttribute("tempeject", att.fTempEject);
3785 if (!att.uuid.isEmpty())
3786 pelmDVD->createChild("Image")->setAttribute("uuid", att.uuid.toStringCurly());
3787 else if (att.strHostDriveSrc.length())
3788 pelmDVD->createChild("HostDrive")->setAttribute("src", att.strHostDriveSrc);
3789 }
3790 }
3791 }
3792 else if (sctl.storageBus == StorageBus_Floppy)
3793 {
3794 size_t cFloppiesHere = sctl.llAttachedDevices.size();
3795 if (cFloppiesHere > 1)
3796 throw ConfigFileError(this, NULL, N_("Internal error: floppy controller cannot have more than one device attachment"));
3797 if (cFloppiesHere)
3798 {
3799 const AttachedDevice &att = sctl.llAttachedDevices.front();
3800 pelmFloppy->setAttribute("enabled", true);
3801 if (!att.uuid.isEmpty())
3802 pelmFloppy->createChild("Image")->setAttribute("uuid", att.uuid.toStringCurly());
3803 else if (att.strHostDriveSrc.length())
3804 pelmFloppy->createChild("HostDrive")->setAttribute("src", att.strHostDriveSrc);
3805 }
3806
3807 cFloppies += cFloppiesHere;
3808 }
3809 }
3810
3811 if (cFloppies == 0)
3812 pelmFloppy->setAttribute("enabled", false);
3813 else if (cFloppies > 1)
3814 throw ConfigFileError(this, NULL, N_("Internal error: cannot save more than one floppy drive with old settings format"));
3815 }
3816
3817 xml::ElementNode *pelmUSB = pelmHardware->createChild("USBController");
3818 pelmUSB->setAttribute("enabled", hw.usbController.fEnabled);
3819 pelmUSB->setAttribute("enabledEhci", hw.usbController.fEnabledEHCI);
3820
3821 buildUSBDeviceFilters(*pelmUSB,
3822 hw.usbController.llDeviceFilters,
3823 false); // fHostMode
3824
3825 xml::ElementNode *pelmNetwork = pelmHardware->createChild("Network");
3826 for (NetworkAdaptersList::const_iterator it = hw.llNetworkAdapters.begin();
3827 it != hw.llNetworkAdapters.end();
3828 ++it)
3829 {
3830 const NetworkAdapter &nic = *it;
3831
3832 xml::ElementNode *pelmAdapter = pelmNetwork->createChild("Adapter");
3833 pelmAdapter->setAttribute("slot", nic.ulSlot);
3834 pelmAdapter->setAttribute("enabled", nic.fEnabled);
3835 pelmAdapter->setAttribute("MACAddress", nic.strMACAddress);
3836 pelmAdapter->setAttribute("cable", nic.fCableConnected);
3837 pelmAdapter->setAttribute("speed", nic.ulLineSpeed);
3838 if (nic.ulBootPriority != 0)
3839 {
3840 pelmAdapter->setAttribute("bootPriority", nic.ulBootPriority);
3841 }
3842 if (nic.fTraceEnabled)
3843 {
3844 pelmAdapter->setAttribute("trace", nic.fTraceEnabled);
3845 pelmAdapter->setAttribute("tracefile", nic.strTraceFile);
3846 }
3847 if (nic.strBandwidthGroup.isNotEmpty())
3848 pelmAdapter->setAttribute("bandwidthGroup", nic.strBandwidthGroup);
3849
3850 const char *pszPolicy;
3851 switch (nic.enmPromiscModePolicy)
3852 {
3853 case NetworkAdapterPromiscModePolicy_Deny: pszPolicy = NULL; break;
3854 case NetworkAdapterPromiscModePolicy_AllowNetwork: pszPolicy = "AllowNetwork"; break;
3855 case NetworkAdapterPromiscModePolicy_AllowAll: pszPolicy = "AllowAll"; break;
3856 default: pszPolicy = NULL; AssertFailed(); break;
3857 }
3858 if (pszPolicy)
3859 pelmAdapter->setAttribute("promiscuousModePolicy", pszPolicy);
3860
3861 const char *pcszType;
3862 switch (nic.type)
3863 {
3864 case NetworkAdapterType_Am79C973: pcszType = "Am79C973"; break;
3865 case NetworkAdapterType_I82540EM: pcszType = "82540EM"; break;
3866 case NetworkAdapterType_I82543GC: pcszType = "82543GC"; break;
3867 case NetworkAdapterType_I82545EM: pcszType = "82545EM"; break;
3868 case NetworkAdapterType_Virtio: pcszType = "virtio"; break;
3869 default: /*case NetworkAdapterType_Am79C970A:*/ pcszType = "Am79C970A"; break;
3870 }
3871 pelmAdapter->setAttribute("type", pcszType);
3872
3873 xml::ElementNode *pelmNAT;
3874 if (m->sv < SettingsVersion_v1_10)
3875 {
3876 switch (nic.mode)
3877 {
3878 case NetworkAttachmentType_NAT:
3879 pelmNAT = pelmAdapter->createChild("NAT");
3880 if (nic.nat.strNetwork.length())
3881 pelmNAT->setAttribute("network", nic.nat.strNetwork);
3882 break;
3883
3884 case NetworkAttachmentType_Bridged:
3885 pelmAdapter->createChild("BridgedInterface")->setAttribute("name", nic.strBridgedName);
3886 break;
3887
3888 case NetworkAttachmentType_Internal:
3889 pelmAdapter->createChild("InternalNetwork")->setAttribute("name", nic.strInternalNetworkName);
3890 break;
3891
3892 case NetworkAttachmentType_HostOnly:
3893 pelmAdapter->createChild("HostOnlyInterface")->setAttribute("name", nic.strHostOnlyName);
3894 break;
3895
3896 default: /*case NetworkAttachmentType_Null:*/
3897 break;
3898 }
3899 }
3900 else
3901 {
3902 /* m->sv >= SettingsVersion_v1_10 */
3903 xml::ElementNode *pelmDisabledNode = NULL;
3904 pelmDisabledNode = pelmAdapter->createChild("DisabledModes");
3905 if (nic.mode != NetworkAttachmentType_NAT)
3906 buildNetworkXML(NetworkAttachmentType_NAT, *pelmDisabledNode, false, nic);
3907 if (nic.mode != NetworkAttachmentType_Bridged)
3908 buildNetworkXML(NetworkAttachmentType_Bridged, *pelmDisabledNode, false, nic);
3909 if (nic.mode != NetworkAttachmentType_Internal)
3910 buildNetworkXML(NetworkAttachmentType_HostOnly, *pelmDisabledNode, false, nic);
3911 if (nic.mode != NetworkAttachmentType_HostOnly)
3912 buildNetworkXML(NetworkAttachmentType_HostOnly, *pelmDisabledNode, false, nic);
3913 if (nic.mode != NetworkAttachmentType_Generic)
3914 buildNetworkXML(NetworkAttachmentType_Generic, *pelmDisabledNode, false, nic);
3915 buildNetworkXML(nic.mode, *pelmAdapter, true, nic);
3916 }
3917 }
3918
3919 xml::ElementNode *pelmPorts = pelmHardware->createChild("UART");
3920 for (SerialPortsList::const_iterator it = hw.llSerialPorts.begin();
3921 it != hw.llSerialPorts.end();
3922 ++it)
3923 {
3924 const SerialPort &port = *it;
3925 xml::ElementNode *pelmPort = pelmPorts->createChild("Port");
3926 pelmPort->setAttribute("slot", port.ulSlot);
3927 pelmPort->setAttribute("enabled", port.fEnabled);
3928 pelmPort->setAttributeHex("IOBase", port.ulIOBase);
3929 pelmPort->setAttribute("IRQ", port.ulIRQ);
3930
3931 const char *pcszHostMode;
3932 switch (port.portMode)
3933 {
3934 case PortMode_HostPipe: pcszHostMode = "HostPipe"; break;
3935 case PortMode_HostDevice: pcszHostMode = "HostDevice"; break;
3936 case PortMode_RawFile: pcszHostMode = "RawFile"; break;
3937 default: /*case PortMode_Disconnected:*/ pcszHostMode = "Disconnected"; break;
3938 }
3939 switch (port.portMode)
3940 {
3941 case PortMode_HostPipe:
3942 pelmPort->setAttribute("server", port.fServer);
3943 /* no break */
3944 case PortMode_HostDevice:
3945 case PortMode_RawFile:
3946 pelmPort->setAttribute("path", port.strPath);
3947 break;
3948
3949 default:
3950 break;
3951 }
3952 pelmPort->setAttribute("hostMode", pcszHostMode);
3953 }
3954
3955 pelmPorts = pelmHardware->createChild("LPT");
3956 for (ParallelPortsList::const_iterator it = hw.llParallelPorts.begin();
3957 it != hw.llParallelPorts.end();
3958 ++it)
3959 {
3960 const ParallelPort &port = *it;
3961 xml::ElementNode *pelmPort = pelmPorts->createChild("Port");
3962 pelmPort->setAttribute("slot", port.ulSlot);
3963 pelmPort->setAttribute("enabled", port.fEnabled);
3964 pelmPort->setAttributeHex("IOBase", port.ulIOBase);
3965 pelmPort->setAttribute("IRQ", port.ulIRQ);
3966 if (port.strPath.length())
3967 pelmPort->setAttribute("path", port.strPath);
3968 }
3969
3970 xml::ElementNode *pelmAudio = pelmHardware->createChild("AudioAdapter");
3971 const char *pcszController;
3972 switch (hw.audioAdapter.controllerType)
3973 {
3974 case AudioControllerType_SB16:
3975 pcszController = "SB16";
3976 break;
3977 case AudioControllerType_HDA:
3978 if (m->sv >= SettingsVersion_v1_11)
3979 {
3980 pcszController = "HDA";
3981 break;
3982 }
3983 /* fall through */
3984 case AudioControllerType_AC97:
3985 default:
3986 pcszController = "AC97";
3987 break;
3988 }
3989 pelmAudio->setAttribute("controller", pcszController);
3990
3991 if (m->sv >= SettingsVersion_v1_10)
3992 {
3993 xml::ElementNode *pelmRTC = pelmHardware->createChild("RTC");
3994 pelmRTC->setAttribute("localOrUTC", machineUserData.fRTCUseUTC ? "UTC" : "local");
3995 }
3996
3997 const char *pcszDriver;
3998 switch (hw.audioAdapter.driverType)
3999 {
4000 case AudioDriverType_WinMM: pcszDriver = "WinMM"; break;
4001 case AudioDriverType_DirectSound: pcszDriver = "DirectSound"; break;
4002 case AudioDriverType_SolAudio: pcszDriver = "SolAudio"; break;
4003 case AudioDriverType_ALSA: pcszDriver = "ALSA"; break;
4004 case AudioDriverType_Pulse: pcszDriver = "Pulse"; break;
4005 case AudioDriverType_OSS: pcszDriver = "OSS"; break;
4006 case AudioDriverType_CoreAudio: pcszDriver = "CoreAudio"; break;
4007 case AudioDriverType_MMPM: pcszDriver = "MMPM"; break;
4008 default: /*case AudioDriverType_Null:*/ pcszDriver = "Null"; break;
4009 }
4010 pelmAudio->setAttribute("driver", pcszDriver);
4011
4012 pelmAudio->setAttribute("enabled", hw.audioAdapter.fEnabled);
4013
4014 xml::ElementNode *pelmSharedFolders = pelmHardware->createChild("SharedFolders");
4015 for (SharedFoldersList::const_iterator it = hw.llSharedFolders.begin();
4016 it != hw.llSharedFolders.end();
4017 ++it)
4018 {
4019 const SharedFolder &sf = *it;
4020 xml::ElementNode *pelmThis = pelmSharedFolders->createChild("SharedFolder");
4021 pelmThis->setAttribute("name", sf.strName);
4022 pelmThis->setAttribute("hostPath", sf.strHostPath);
4023 pelmThis->setAttribute("writable", sf.fWritable);
4024 pelmThis->setAttribute("autoMount", sf.fAutoMount);
4025 }
4026
4027 xml::ElementNode *pelmClip = pelmHardware->createChild("Clipboard");
4028 const char *pcszClip;
4029 switch (hw.clipboardMode)
4030 {
4031 case ClipboardMode_Disabled: pcszClip = "Disabled"; break;
4032 case ClipboardMode_HostToGuest: pcszClip = "HostToGuest"; break;
4033 case ClipboardMode_GuestToHost: pcszClip = "GuestToHost"; break;
4034 default: /*case ClipboardMode_Bidirectional:*/ pcszClip = "Bidirectional"; break;
4035 }
4036 pelmClip->setAttribute("mode", pcszClip);
4037
4038 if (m->sv >= SettingsVersion_v1_10)
4039 {
4040 xml::ElementNode *pelmIo = pelmHardware->createChild("IO");
4041 xml::ElementNode *pelmIoCache;
4042
4043 pelmIoCache = pelmIo->createChild("IoCache");
4044 pelmIoCache->setAttribute("enabled", hw.ioSettings.fIoCacheEnabled);
4045 pelmIoCache->setAttribute("size", hw.ioSettings.ulIoCacheSize);
4046
4047 if (m->sv >= SettingsVersion_v1_11)
4048 {
4049 xml::ElementNode *pelmBandwidthGroups = pelmIo->createChild("BandwidthGroups");
4050 for (BandwidthGroupList::const_iterator it = hw.ioSettings.llBandwidthGroups.begin();
4051 it != hw.ioSettings.llBandwidthGroups.end();
4052 ++it)
4053 {
4054 const BandwidthGroup &gr = *it;
4055 const char *pcszType;
4056 xml::ElementNode *pelmThis = pelmBandwidthGroups->createChild("BandwidthGroup");
4057 pelmThis->setAttribute("name", gr.strName);
4058 switch (gr.enmType)
4059 {
4060 case BandwidthGroupType_Network: pcszType = "Network"; break;
4061 default: /* BandwidthGrouptype_Disk */ pcszType = "Disk"; break;
4062 }
4063 pelmThis->setAttribute("type", pcszType);
4064 if (m->sv >= SettingsVersion_v1_13)
4065 pelmThis->setAttribute("maxBytesPerSec", gr.cMaxBytesPerSec);
4066 else
4067 pelmThis->setAttribute("maxMbPerSec", gr.cMaxBytesPerSec / _1M);
4068 }
4069 }
4070 }
4071
4072 if (m->sv >= SettingsVersion_v1_12)
4073 {
4074 xml::ElementNode *pelmPci = pelmHardware->createChild("HostPci");
4075 xml::ElementNode *pelmPciDevices = pelmPci->createChild("Devices");
4076
4077 for (HostPciDeviceAttachmentList::const_iterator it = hw.pciAttachments.begin();
4078 it != hw.pciAttachments.end();
4079 ++it)
4080 {
4081 const HostPciDeviceAttachment &hpda = *it;
4082
4083 xml::ElementNode *pelmThis = pelmPciDevices->createChild("Device");
4084
4085 pelmThis->setAttribute("host", hpda.uHostAddress);
4086 pelmThis->setAttribute("guest", hpda.uGuestAddress);
4087 pelmThis->setAttribute("name", hpda.strDeviceName);
4088 }
4089 }
4090
4091 if (m->sv >= SettingsVersion_v1_12)
4092 {
4093 xml::ElementNode *pelmEmulatedUSB = pelmHardware->createChild("EmulatedUSB");
4094 xml::ElementNode *pelmCardReader = pelmEmulatedUSB->createChild("CardReader");
4095
4096 pelmCardReader->setAttribute("enabled", hw.fEmulatedUSBCardReader);
4097 }
4098
4099 xml::ElementNode *pelmGuest = pelmHardware->createChild("Guest");
4100 pelmGuest->setAttribute("memoryBalloonSize", hw.ulMemoryBalloonSize);
4101
4102 xml::ElementNode *pelmGuestProps = pelmHardware->createChild("GuestProperties");
4103 for (GuestPropertiesList::const_iterator it = hw.llGuestProperties.begin();
4104 it != hw.llGuestProperties.end();
4105 ++it)
4106 {
4107 const GuestProperty &prop = *it;
4108 xml::ElementNode *pelmProp = pelmGuestProps->createChild("GuestProperty");
4109 pelmProp->setAttribute("name", prop.strName);
4110 pelmProp->setAttribute("value", prop.strValue);
4111 pelmProp->setAttribute("timestamp", prop.timestamp);
4112 pelmProp->setAttribute("flags", prop.strFlags);
4113 }
4114
4115 if (hw.strNotificationPatterns.length())
4116 pelmGuestProps->setAttribute("notificationPatterns", hw.strNotificationPatterns);
4117}
4118
4119/**
4120 * Fill a <Network> node. Only relevant for XML version >= v1_10.
4121 * @param mode
4122 * @param elmParent
4123 * @param fEnabled
4124 * @param nic
4125 */
4126void MachineConfigFile::buildNetworkXML(NetworkAttachmentType_T mode,
4127 xml::ElementNode &elmParent,
4128 bool fEnabled,
4129 const NetworkAdapter &nic)
4130{
4131 switch (mode)
4132 {
4133 case NetworkAttachmentType_NAT:
4134 xml::ElementNode *pelmNAT;
4135 pelmNAT = elmParent.createChild("NAT");
4136
4137 if (nic.nat.strNetwork.length())
4138 pelmNAT->setAttribute("network", nic.nat.strNetwork);
4139 if (nic.nat.strBindIP.length())
4140 pelmNAT->setAttribute("hostip", nic.nat.strBindIP);
4141 if (nic.nat.u32Mtu)
4142 pelmNAT->setAttribute("mtu", nic.nat.u32Mtu);
4143 if (nic.nat.u32SockRcv)
4144 pelmNAT->setAttribute("sockrcv", nic.nat.u32SockRcv);
4145 if (nic.nat.u32SockSnd)
4146 pelmNAT->setAttribute("socksnd", nic.nat.u32SockSnd);
4147 if (nic.nat.u32TcpRcv)
4148 pelmNAT->setAttribute("tcprcv", nic.nat.u32TcpRcv);
4149 if (nic.nat.u32TcpSnd)
4150 pelmNAT->setAttribute("tcpsnd", nic.nat.u32TcpSnd);
4151 xml::ElementNode *pelmDNS;
4152 pelmDNS = pelmNAT->createChild("DNS");
4153 pelmDNS->setAttribute("pass-domain", nic.nat.fDnsPassDomain);
4154 pelmDNS->setAttribute("use-proxy", nic.nat.fDnsProxy);
4155 pelmDNS->setAttribute("use-host-resolver", nic.nat.fDnsUseHostResolver);
4156
4157 xml::ElementNode *pelmAlias;
4158 pelmAlias = pelmNAT->createChild("Alias");
4159 pelmAlias->setAttribute("logging", nic.nat.fAliasLog);
4160 pelmAlias->setAttribute("proxy-only", nic.nat.fAliasProxyOnly);
4161 pelmAlias->setAttribute("use-same-ports", nic.nat.fAliasUseSamePorts);
4162
4163 if ( nic.nat.strTftpPrefix.length()
4164 || nic.nat.strTftpBootFile.length()
4165 || nic.nat.strTftpNextServer.length())
4166 {
4167 xml::ElementNode *pelmTFTP;
4168 pelmTFTP = pelmNAT->createChild("TFTP");
4169 if (nic.nat.strTftpPrefix.length())
4170 pelmTFTP->setAttribute("prefix", nic.nat.strTftpPrefix);
4171 if (nic.nat.strTftpBootFile.length())
4172 pelmTFTP->setAttribute("boot-file", nic.nat.strTftpBootFile);
4173 if (nic.nat.strTftpNextServer.length())
4174 pelmTFTP->setAttribute("next-server", nic.nat.strTftpNextServer);
4175 }
4176 for (NATRuleList::const_iterator rule = nic.nat.llRules.begin();
4177 rule != nic.nat.llRules.end(); ++rule)
4178 {
4179 xml::ElementNode *pelmPF;
4180 pelmPF = pelmNAT->createChild("Forwarding");
4181 if ((*rule).strName.length())
4182 pelmPF->setAttribute("name", (*rule).strName);
4183 pelmPF->setAttribute("proto", (*rule).proto);
4184 if ((*rule).strHostIP.length())
4185 pelmPF->setAttribute("hostip", (*rule).strHostIP);
4186 if ((*rule).u16HostPort)
4187 pelmPF->setAttribute("hostport", (*rule).u16HostPort);
4188 if ((*rule).strGuestIP.length())
4189 pelmPF->setAttribute("guestip", (*rule).strGuestIP);
4190 if ((*rule).u16GuestPort)
4191 pelmPF->setAttribute("guestport", (*rule).u16GuestPort);
4192 }
4193 break;
4194
4195 case NetworkAttachmentType_Bridged:
4196 if (fEnabled || !nic.strBridgedName.isEmpty())
4197 elmParent.createChild("BridgedInterface")->setAttribute("name", nic.strBridgedName);
4198 break;
4199
4200 case NetworkAttachmentType_Internal:
4201 if (fEnabled || !nic.strInternalNetworkName.isEmpty())
4202 elmParent.createChild("InternalNetwork")->setAttribute("name", nic.strInternalNetworkName);
4203 break;
4204
4205 case NetworkAttachmentType_HostOnly:
4206 if (fEnabled || !nic.strHostOnlyName.isEmpty())
4207 elmParent.createChild("HostOnlyInterface")->setAttribute("name", nic.strHostOnlyName);
4208 break;
4209
4210 case NetworkAttachmentType_Generic:
4211 if (fEnabled || !nic.strGenericDriver.isEmpty() || nic.genericProperties.size())
4212 {
4213 xml::ElementNode *pelmMode = elmParent.createChild("GenericInterface");
4214 pelmMode->setAttribute("driver", nic.strGenericDriver);
4215 for (StringsMap::const_iterator it = nic.genericProperties.begin();
4216 it != nic.genericProperties.end();
4217 ++it)
4218 {
4219 xml::ElementNode *pelmProp = pelmMode->createChild("Property");
4220 pelmProp->setAttribute("name", it->first);
4221 pelmProp->setAttribute("value", it->second);
4222 }
4223 }
4224 break;
4225
4226 default: /*case NetworkAttachmentType_Null:*/
4227 break;
4228 }
4229}
4230
4231/**
4232 * Creates a <StorageControllers> node under elmParent and then writes out the XML
4233 * keys under that. Called for both the <Machine> node and for snapshots.
4234 * @param elmParent
4235 * @param st
4236 * @param fSkipRemovableMedia If true, DVD and floppy attachments are skipped and
4237 * an empty drive is always written instead. This is for the OVF export case.
4238 * This parameter is ignored unless the settings version is at least v1.9, which
4239 * is always the case when this gets called for OVF export.
4240 * @param pllElementsWithUuidAttributes If not NULL, must point to a list of element node
4241 * pointers to which we will append all elements that we created here that contain
4242 * UUID attributes. This allows the OVF export code to quickly replace the internal
4243 * media UUIDs with the UUIDs of the media that were exported.
4244 */
4245void MachineConfigFile::buildStorageControllersXML(xml::ElementNode &elmParent,
4246 const Storage &st,
4247 bool fSkipRemovableMedia,
4248 std::list<xml::ElementNode*> *pllElementsWithUuidAttributes)
4249{
4250 xml::ElementNode *pelmStorageControllers = elmParent.createChild("StorageControllers");
4251
4252 for (StorageControllersList::const_iterator it = st.llStorageControllers.begin();
4253 it != st.llStorageControllers.end();
4254 ++it)
4255 {
4256 const StorageController &sc = *it;
4257
4258 if ( (m->sv < SettingsVersion_v1_9)
4259 && (sc.controllerType == StorageControllerType_I82078)
4260 )
4261 // floppy controller already got written into <Hardware>/<FloppyController> in writeHardware()
4262 // for pre-1.9 settings
4263 continue;
4264
4265 xml::ElementNode *pelmController = pelmStorageControllers->createChild("StorageController");
4266 com::Utf8Str name = sc.strName;
4267 if (m->sv < SettingsVersion_v1_8)
4268 {
4269 // pre-1.8 settings use shorter controller names, they are
4270 // expanded when reading the settings
4271 if (name == "IDE Controller")
4272 name = "IDE";
4273 else if (name == "SATA Controller")
4274 name = "SATA";
4275 else if (name == "SCSI Controller")
4276 name = "SCSI";
4277 }
4278 pelmController->setAttribute("name", sc.strName);
4279
4280 const char *pcszType;
4281 switch (sc.controllerType)
4282 {
4283 case StorageControllerType_IntelAhci: pcszType = "AHCI"; break;
4284 case StorageControllerType_LsiLogic: pcszType = "LsiLogic"; break;
4285 case StorageControllerType_BusLogic: pcszType = "BusLogic"; break;
4286 case StorageControllerType_PIIX4: pcszType = "PIIX4"; break;
4287 case StorageControllerType_ICH6: pcszType = "ICH6"; break;
4288 case StorageControllerType_I82078: pcszType = "I82078"; break;
4289 case StorageControllerType_LsiLogicSas: pcszType = "LsiLogicSas"; break;
4290 default: /*case StorageControllerType_PIIX3:*/ pcszType = "PIIX3"; break;
4291 }
4292 pelmController->setAttribute("type", pcszType);
4293
4294 pelmController->setAttribute("PortCount", sc.ulPortCount);
4295
4296 if (m->sv >= SettingsVersion_v1_9)
4297 if (sc.ulInstance)
4298 pelmController->setAttribute("Instance", sc.ulInstance);
4299
4300 if (m->sv >= SettingsVersion_v1_10)
4301 pelmController->setAttribute("useHostIOCache", sc.fUseHostIOCache);
4302
4303 if (m->sv >= SettingsVersion_v1_11)
4304 pelmController->setAttribute("Bootable", sc.fBootable);
4305
4306 if (sc.controllerType == StorageControllerType_IntelAhci)
4307 {
4308 pelmController->setAttribute("IDE0MasterEmulationPort", sc.lIDE0MasterEmulationPort);
4309 pelmController->setAttribute("IDE0SlaveEmulationPort", sc.lIDE0SlaveEmulationPort);
4310 pelmController->setAttribute("IDE1MasterEmulationPort", sc.lIDE1MasterEmulationPort);
4311 pelmController->setAttribute("IDE1SlaveEmulationPort", sc.lIDE1SlaveEmulationPort);
4312 }
4313
4314 for (AttachedDevicesList::const_iterator it2 = sc.llAttachedDevices.begin();
4315 it2 != sc.llAttachedDevices.end();
4316 ++it2)
4317 {
4318 const AttachedDevice &att = *it2;
4319
4320 // For settings version before 1.9, DVDs and floppies are in hardware, not storage controllers,
4321 // so we shouldn't write them here; we only get here for DVDs though because we ruled out
4322 // the floppy controller at the top of the loop
4323 if ( att.deviceType == DeviceType_DVD
4324 && m->sv < SettingsVersion_v1_9
4325 )
4326 continue;
4327
4328 xml::ElementNode *pelmDevice = pelmController->createChild("AttachedDevice");
4329
4330 pcszType = NULL;
4331
4332 switch (att.deviceType)
4333 {
4334 case DeviceType_HardDisk:
4335 pcszType = "HardDisk";
4336 if (att.fNonRotational)
4337 pelmDevice->setAttribute("nonrotational", att.fNonRotational);
4338 if (att.fDiscard)
4339 pelmDevice->setAttribute("discard", att.fDiscard);
4340 break;
4341
4342 case DeviceType_DVD:
4343 pcszType = "DVD";
4344 pelmDevice->setAttribute("passthrough", att.fPassThrough);
4345 if (att.fTempEject)
4346 pelmDevice->setAttribute("tempeject", att.fTempEject);
4347 break;
4348
4349 case DeviceType_Floppy:
4350 pcszType = "Floppy";
4351 break;
4352 }
4353
4354 pelmDevice->setAttribute("type", pcszType);
4355
4356 pelmDevice->setAttribute("port", att.lPort);
4357 pelmDevice->setAttribute("device", att.lDevice);
4358
4359 if (att.strBwGroup.length())
4360 pelmDevice->setAttribute("bandwidthGroup", att.strBwGroup);
4361
4362 // attached image, if any
4363 if ( !att.uuid.isEmpty()
4364 && ( att.deviceType == DeviceType_HardDisk
4365 || !fSkipRemovableMedia
4366 )
4367 )
4368 {
4369 xml::ElementNode *pelmImage = pelmDevice->createChild("Image");
4370 pelmImage->setAttribute("uuid", att.uuid.toStringCurly());
4371
4372 // if caller wants a list of UUID elements, give it to them
4373 if (pllElementsWithUuidAttributes)
4374 pllElementsWithUuidAttributes->push_back(pelmImage);
4375 }
4376 else if ( (m->sv >= SettingsVersion_v1_9)
4377 && (att.strHostDriveSrc.length())
4378 )
4379 pelmDevice->createChild("HostDrive")->setAttribute("src", att.strHostDriveSrc);
4380 }
4381 }
4382}
4383
4384/**
4385 * Creates a <Debugging> node under elmParent and then writes out the XML
4386 * keys under that. Called for both the <Machine> node and for snapshots.
4387 *
4388 * @param pElmParent Pointer to the parent element.
4389 * @param pDbg Pointer to the debugging settings.
4390 */
4391void MachineConfigFile::buildDebuggingXML(xml::ElementNode *pElmParent, const Debugging *pDbg)
4392{
4393 if (m->sv < SettingsVersion_v1_13 || pDbg->areDefaultSettings())
4394 return;
4395
4396 xml::ElementNode *pElmDebugging = pElmParent->createChild("Debugging");
4397 xml::ElementNode *pElmTracing = pElmDebugging->createChild("Tracing");
4398 pElmTracing->setAttribute("enabled", pDbg->fTracingEnabled);
4399 pElmTracing->setAttribute("allowTracingToAccessVM", pDbg->fAllowTracingToAccessVM);
4400 pElmTracing->setAttribute("config", pDbg->strTracingConfig);
4401}
4402
4403/**
4404 * Creates a <Autostart> node under elmParent and then writes out the XML
4405 * keys under that. Called for both the <Machine> node and for snapshots.
4406 *
4407 * @param pElmParent Pointer to the parent element.
4408 * @param pAutostart Pointer to the autostart settings.
4409 */
4410void MachineConfigFile::buildAutostartXML(xml::ElementNode *pElmParent, const Autostart *pAutostart)
4411{
4412 const char *pcszAutostop = NULL;
4413
4414 if (m->sv < SettingsVersion_v1_13 || pAutostart->areDefaultSettings())
4415 return;
4416
4417 xml::ElementNode *pElmAutostart = pElmParent->createChild("Autostart");
4418 pElmAutostart->setAttribute("enabled", pAutostart->fAutostartEnabled);
4419 pElmAutostart->setAttribute("delay", pAutostart->uAutostartDelay);
4420
4421 switch (pAutostart->enmAutostopType)
4422 {
4423 case AutostopType_Disabled: pcszAutostop = "Disabled"; break;
4424 case AutostopType_SaveState: pcszAutostop = "SaveState"; break;
4425 case AutostopType_PowerOff: pcszAutostop = "PowerOff"; break;
4426 case AutostopType_AcpiShutdown: pcszAutostop = "AcpiShutdown"; break;
4427 default: Assert(false); pcszAutostop = "Disabled"; break;
4428 }
4429 pElmAutostart->setAttribute("autostop", pcszAutostop);
4430}
4431
4432/**
4433 * Writes a single snapshot into the DOM tree. Initially this gets called from MachineConfigFile::write()
4434 * for the root snapshot of a machine, if present; elmParent then points to the <Snapshots> node under the
4435 * <Machine> node to which <Snapshot> must be added. This may then recurse for child snapshots.
4436 * @param elmParent
4437 * @param snap
4438 */
4439void MachineConfigFile::buildSnapshotXML(xml::ElementNode &elmParent,
4440 const Snapshot &snap)
4441{
4442 xml::ElementNode *pelmSnapshot = elmParent.createChild("Snapshot");
4443
4444 pelmSnapshot->setAttribute("uuid", snap.uuid.toStringCurly());
4445 pelmSnapshot->setAttribute("name", snap.strName);
4446 pelmSnapshot->setAttribute("timeStamp", makeString(snap.timestamp));
4447
4448 if (snap.strStateFile.length())
4449 pelmSnapshot->setAttributePath("stateFile", snap.strStateFile);
4450
4451 if (snap.strDescription.length())
4452 pelmSnapshot->createChild("Description")->addContent(snap.strDescription);
4453
4454 buildHardwareXML(*pelmSnapshot, snap.hardware, snap.storage);
4455 buildStorageControllersXML(*pelmSnapshot,
4456 snap.storage,
4457 false /* fSkipRemovableMedia */,
4458 NULL); /* pllElementsWithUuidAttributes */
4459 // we only skip removable media for OVF, but we never get here for OVF
4460 // since snapshots never get written then
4461 buildDebuggingXML(pelmSnapshot, &snap.debugging);
4462 buildAutostartXML(pelmSnapshot, &snap.autostart);
4463
4464 if (snap.llChildSnapshots.size())
4465 {
4466 xml::ElementNode *pelmChildren = pelmSnapshot->createChild("Snapshots");
4467 for (SnapshotsList::const_iterator it = snap.llChildSnapshots.begin();
4468 it != snap.llChildSnapshots.end();
4469 ++it)
4470 {
4471 const Snapshot &child = *it;
4472 buildSnapshotXML(*pelmChildren, child);
4473 }
4474 }
4475}
4476
4477/**
4478 * Builds the XML DOM tree for the machine config under the given XML element.
4479 *
4480 * This has been separated out from write() so it can be called from elsewhere,
4481 * such as the OVF code, to build machine XML in an existing XML tree.
4482 *
4483 * As a result, this gets called from two locations:
4484 *
4485 * -- MachineConfigFile::write();
4486 *
4487 * -- Appliance::buildXMLForOneVirtualSystem()
4488 *
4489 * In fl, the following flag bits are recognized:
4490 *
4491 * -- BuildMachineXML_MediaRegistry: If set, the machine's media registry will
4492 * be written, if present. This is not set when called from OVF because OVF
4493 * has its own variant of a media registry. This flag is ignored unless the
4494 * settings version is at least v1.11 (VirtualBox 4.0).
4495 *
4496 * -- BuildMachineXML_IncludeSnapshots: If set, descend into the snapshots tree
4497 * of the machine and write out <Snapshot> and possibly more snapshots under
4498 * that, if snapshots are present. Otherwise all snapshots are suppressed
4499 * (when called from OVF).
4500 *
4501 * -- BuildMachineXML_WriteVboxVersionAttribute: If set, add a settingsVersion
4502 * attribute to the machine tag with the vbox settings version. This is for
4503 * the OVF export case in which we don't have the settings version set in
4504 * the root element.
4505 *
4506 * -- BuildMachineXML_SkipRemovableMedia: If set, removable media attachments
4507 * (DVDs, floppies) are silently skipped. This is for the OVF export case
4508 * until we support copying ISO and RAW media as well. This flag is ignored
4509 * unless the settings version is at least v1.9, which is always the case
4510 * when this gets called for OVF export.
4511 *
4512 * -- BuildMachineXML_SuppressSavedState: If set, the Machine/@stateFile
4513 * attribute is never set. This is also for the OVF export case because we
4514 * cannot save states with OVF.
4515 *
4516 * @param elmMachine XML <Machine> element to add attributes and elements to.
4517 * @param fl Flags.
4518 * @param pllElementsWithUuidAttributes pointer to list that should receive UUID elements or NULL;
4519 * see buildStorageControllersXML() for details.
4520 */
4521void MachineConfigFile::buildMachineXML(xml::ElementNode &elmMachine,
4522 uint32_t fl,
4523 std::list<xml::ElementNode*> *pllElementsWithUuidAttributes)
4524{
4525 if (fl & BuildMachineXML_WriteVboxVersionAttribute)
4526 // add settings version attribute to machine element
4527 setVersionAttribute(elmMachine);
4528
4529 elmMachine.setAttribute("uuid", uuid.toStringCurly());
4530 elmMachine.setAttribute("name", machineUserData.strName);
4531 if (!machineUserData.fNameSync)
4532 elmMachine.setAttribute("nameSync", machineUserData.fNameSync);
4533 if (machineUserData.strDescription.length())
4534 elmMachine.createChild("Description")->addContent(machineUserData.strDescription);
4535 elmMachine.setAttribute("OSType", machineUserData.strOsType);
4536 if ( strStateFile.length()
4537 && !(fl & BuildMachineXML_SuppressSavedState)
4538 )
4539 elmMachine.setAttributePath("stateFile", strStateFile);
4540 if ( (fl & BuildMachineXML_IncludeSnapshots)
4541 && !uuidCurrentSnapshot.isEmpty())
4542 elmMachine.setAttribute("currentSnapshot", uuidCurrentSnapshot.toStringCurly());
4543
4544 if (machineUserData.strSnapshotFolder.length())
4545 elmMachine.setAttributePath("snapshotFolder", machineUserData.strSnapshotFolder);
4546 if (!fCurrentStateModified)
4547 elmMachine.setAttribute("currentStateModified", fCurrentStateModified);
4548 elmMachine.setAttribute("lastStateChange", makeString(timeLastStateChange));
4549 if (fAborted)
4550 elmMachine.setAttribute("aborted", fAborted);
4551 if ( m->sv >= SettingsVersion_v1_9
4552 && ( machineUserData.fTeleporterEnabled
4553 || machineUserData.uTeleporterPort
4554 || !machineUserData.strTeleporterAddress.isEmpty()
4555 || !machineUserData.strTeleporterPassword.isEmpty()
4556 )
4557 )
4558 {
4559 xml::ElementNode *pelmTeleporter = elmMachine.createChild("Teleporter");
4560 pelmTeleporter->setAttribute("enabled", machineUserData.fTeleporterEnabled);
4561 pelmTeleporter->setAttribute("port", machineUserData.uTeleporterPort);
4562 pelmTeleporter->setAttribute("address", machineUserData.strTeleporterAddress);
4563 pelmTeleporter->setAttribute("password", machineUserData.strTeleporterPassword);
4564 }
4565
4566 if ( m->sv >= SettingsVersion_v1_11
4567 && ( machineUserData.enmFaultToleranceState != FaultToleranceState_Inactive
4568 || machineUserData.uFaultTolerancePort
4569 || machineUserData.uFaultToleranceInterval
4570 || !machineUserData.strFaultToleranceAddress.isEmpty()
4571 )
4572 )
4573 {
4574 xml::ElementNode *pelmFaultTolerance = elmMachine.createChild("FaultTolerance");
4575 switch (machineUserData.enmFaultToleranceState)
4576 {
4577 case FaultToleranceState_Inactive:
4578 pelmFaultTolerance->setAttribute("state", "inactive");
4579 break;
4580 case FaultToleranceState_Master:
4581 pelmFaultTolerance->setAttribute("state", "master");
4582 break;
4583 case FaultToleranceState_Standby:
4584 pelmFaultTolerance->setAttribute("state", "standby");
4585 break;
4586 }
4587
4588 pelmFaultTolerance->setAttribute("port", machineUserData.uFaultTolerancePort);
4589 pelmFaultTolerance->setAttribute("address", machineUserData.strFaultToleranceAddress);
4590 pelmFaultTolerance->setAttribute("interval", machineUserData.uFaultToleranceInterval);
4591 pelmFaultTolerance->setAttribute("password", machineUserData.strFaultTolerancePassword);
4592 }
4593
4594 if ( (fl & BuildMachineXML_MediaRegistry)
4595 && (m->sv >= SettingsVersion_v1_11)
4596 )
4597 buildMediaRegistry(elmMachine, mediaRegistry);
4598
4599 buildExtraData(elmMachine, mapExtraDataItems);
4600
4601 if ( (fl & BuildMachineXML_IncludeSnapshots)
4602 && llFirstSnapshot.size())
4603 buildSnapshotXML(elmMachine, llFirstSnapshot.front());
4604
4605 buildHardwareXML(elmMachine, hardwareMachine, storageMachine);
4606 buildStorageControllersXML(elmMachine,
4607 storageMachine,
4608 !!(fl & BuildMachineXML_SkipRemovableMedia),
4609 pllElementsWithUuidAttributes);
4610 buildDebuggingXML(&elmMachine, &debugging);
4611 buildAutostartXML(&elmMachine, &autostart);
4612}
4613
4614/**
4615 * Returns true only if the given AudioDriverType is supported on
4616 * the current host platform. For example, this would return false
4617 * for AudioDriverType_DirectSound when compiled on a Linux host.
4618 * @param drv AudioDriverType_* enum to test.
4619 * @return true only if the current host supports that driver.
4620 */
4621/*static*/
4622bool MachineConfigFile::isAudioDriverAllowedOnThisHost(AudioDriverType_T drv)
4623{
4624 switch (drv)
4625 {
4626 case AudioDriverType_Null:
4627#ifdef RT_OS_WINDOWS
4628# ifdef VBOX_WITH_WINMM
4629 case AudioDriverType_WinMM:
4630# endif
4631 case AudioDriverType_DirectSound:
4632#endif /* RT_OS_WINDOWS */
4633#ifdef RT_OS_SOLARIS
4634 case AudioDriverType_SolAudio:
4635#endif
4636#ifdef RT_OS_LINUX
4637# ifdef VBOX_WITH_ALSA
4638 case AudioDriverType_ALSA:
4639# endif
4640# ifdef VBOX_WITH_PULSE
4641 case AudioDriverType_Pulse:
4642# endif
4643#endif /* RT_OS_LINUX */
4644#if defined (RT_OS_LINUX) || defined (RT_OS_FREEBSD) || defined(VBOX_WITH_SOLARIS_OSS)
4645 case AudioDriverType_OSS:
4646#endif
4647#ifdef RT_OS_FREEBSD
4648# ifdef VBOX_WITH_PULSE
4649 case AudioDriverType_Pulse:
4650# endif
4651#endif
4652#ifdef RT_OS_DARWIN
4653 case AudioDriverType_CoreAudio:
4654#endif
4655#ifdef RT_OS_OS2
4656 case AudioDriverType_MMPM:
4657#endif
4658 return true;
4659 }
4660
4661 return false;
4662}
4663
4664/**
4665 * Returns the AudioDriverType_* which should be used by default on this
4666 * host platform. On Linux, this will check at runtime whether PulseAudio
4667 * or ALSA are actually supported on the first call.
4668 * @return
4669 */
4670/*static*/
4671AudioDriverType_T MachineConfigFile::getHostDefaultAudioDriver()
4672{
4673#if defined(RT_OS_WINDOWS)
4674# ifdef VBOX_WITH_WINMM
4675 return AudioDriverType_WinMM;
4676# else /* VBOX_WITH_WINMM */
4677 return AudioDriverType_DirectSound;
4678# endif /* !VBOX_WITH_WINMM */
4679#elif defined(RT_OS_SOLARIS)
4680 return AudioDriverType_SolAudio;
4681#elif defined(RT_OS_LINUX)
4682 // on Linux, we need to check at runtime what's actually supported...
4683 static RTCLockMtx s_mtx;
4684 static AudioDriverType_T s_linuxDriver = -1;
4685 RTCLock lock(s_mtx);
4686 if (s_linuxDriver == (AudioDriverType_T)-1)
4687 {
4688# if defined(VBOX_WITH_PULSE)
4689 /* Check for the pulse library & that the pulse audio daemon is running. */
4690 if (RTProcIsRunningByName("pulseaudio") &&
4691 RTLdrIsLoadable("libpulse.so.0"))
4692 s_linuxDriver = AudioDriverType_Pulse;
4693 else
4694# endif /* VBOX_WITH_PULSE */
4695# if defined(VBOX_WITH_ALSA)
4696 /* Check if we can load the ALSA library */
4697 if (RTLdrIsLoadable("libasound.so.2"))
4698 s_linuxDriver = AudioDriverType_ALSA;
4699 else
4700# endif /* VBOX_WITH_ALSA */
4701 s_linuxDriver = AudioDriverType_OSS;
4702 }
4703 return s_linuxDriver;
4704// end elif defined(RT_OS_LINUX)
4705#elif defined(RT_OS_DARWIN)
4706 return AudioDriverType_CoreAudio;
4707#elif defined(RT_OS_OS2)
4708 return AudioDriverType_MMPM;
4709#elif defined(RT_OS_FREEBSD)
4710 return AudioDriverType_OSS;
4711#else
4712 return AudioDriverType_Null;
4713#endif
4714}
4715
4716/**
4717 * Called from write() before calling ConfigFileBase::createStubDocument().
4718 * This adjusts the settings version in m->sv if incompatible settings require
4719 * a settings bump, whereas otherwise we try to preserve the settings version
4720 * to avoid breaking compatibility with older versions.
4721 *
4722 * We do the checks in here in reverse order: newest first, oldest last, so
4723 * that we avoid unnecessary checks since some of these are expensive.
4724 */
4725void MachineConfigFile::bumpSettingsVersionIfNeeded()
4726{
4727 if (m->sv < SettingsVersion_v1_13)
4728 {
4729 // VirtualBox 4.2 adds tracing and autostart.
4730 if ( !debugging.areDefaultSettings()
4731 || !autostart.areDefaultSettings())
4732 m->sv = SettingsVersion_v1_13;
4733 }
4734
4735 if (m->sv < SettingsVersion_v1_13)
4736 {
4737 // VirtualBox 4.2 changes the units for bandwidth group limits.
4738 for (BandwidthGroupList::const_iterator it = hardwareMachine.ioSettings.llBandwidthGroups.begin();
4739 it != hardwareMachine.ioSettings.llBandwidthGroups.end();
4740 ++it)
4741 {
4742 const BandwidthGroup &gr = *it;
4743 if (gr.cMaxBytesPerSec % _1M)
4744 {
4745 // Bump version if a limit cannot be expressed in megabytes
4746 m->sv = SettingsVersion_v1_13;
4747 break;
4748 }
4749 }
4750 }
4751
4752 if (m->sv < SettingsVersion_v1_12)
4753 {
4754 // 4.1: Emulated USB devices.
4755 if (hardwareMachine.fEmulatedUSBCardReader)
4756 m->sv = SettingsVersion_v1_12;
4757 }
4758
4759 if (m->sv < SettingsVersion_v1_12)
4760 {
4761 // VirtualBox 4.1 adds PCI passthrough.
4762 if (hardwareMachine.pciAttachments.size())
4763 m->sv = SettingsVersion_v1_12;
4764 }
4765
4766 if (m->sv < SettingsVersion_v1_12)
4767 {
4768 // VirtualBox 4.1 adds a promiscuous mode policy to the network
4769 // adapters and a generic network driver transport.
4770 NetworkAdaptersList::const_iterator netit;
4771 for (netit = hardwareMachine.llNetworkAdapters.begin();
4772 netit != hardwareMachine.llNetworkAdapters.end();
4773 ++netit)
4774 {
4775 if ( netit->enmPromiscModePolicy != NetworkAdapterPromiscModePolicy_Deny
4776 || netit->mode == NetworkAttachmentType_Generic
4777 || !netit->strGenericDriver.isEmpty()
4778 || netit->genericProperties.size()
4779 )
4780 {
4781 m->sv = SettingsVersion_v1_12;
4782 break;
4783 }
4784 }
4785 }
4786
4787 if (m->sv < SettingsVersion_v1_11)
4788 {
4789 // VirtualBox 4.0 adds HD audio, CPU priorities, fault tolerance,
4790 // per-machine media registries, VRDE, JRockitVE, bandwidth groups,
4791 // ICH9 chipset
4792 if ( hardwareMachine.audioAdapter.controllerType == AudioControllerType_HDA
4793 || hardwareMachine.ulCpuExecutionCap != 100
4794 || machineUserData.enmFaultToleranceState != FaultToleranceState_Inactive
4795 || machineUserData.uFaultTolerancePort
4796 || machineUserData.uFaultToleranceInterval
4797 || !machineUserData.strFaultToleranceAddress.isEmpty()
4798 || mediaRegistry.llHardDisks.size()
4799 || mediaRegistry.llDvdImages.size()
4800 || mediaRegistry.llFloppyImages.size()
4801 || !hardwareMachine.vrdeSettings.strVrdeExtPack.isEmpty()
4802 || !hardwareMachine.vrdeSettings.strAuthLibrary.isEmpty()
4803 || machineUserData.strOsType == "JRockitVE"
4804 || hardwareMachine.ioSettings.llBandwidthGroups.size()
4805 || hardwareMachine.chipsetType == ChipsetType_ICH9
4806 )
4807 m->sv = SettingsVersion_v1_11;
4808 }
4809
4810 if (m->sv < SettingsVersion_v1_10)
4811 {
4812 /* If the properties contain elements other than "TCP/Ports" and "TCP/Address",
4813 * then increase the version to at least VBox 3.2, which can have video channel properties.
4814 */
4815 unsigned cOldProperties = 0;
4816
4817 StringsMap::const_iterator it = hardwareMachine.vrdeSettings.mapProperties.find("TCP/Ports");
4818 if (it != hardwareMachine.vrdeSettings.mapProperties.end())
4819 cOldProperties++;
4820 it = hardwareMachine.vrdeSettings.mapProperties.find("TCP/Address");
4821 if (it != hardwareMachine.vrdeSettings.mapProperties.end())
4822 cOldProperties++;
4823
4824 if (hardwareMachine.vrdeSettings.mapProperties.size() != cOldProperties)
4825 m->sv = SettingsVersion_v1_10;
4826 }
4827
4828 if (m->sv < SettingsVersion_v1_11)
4829 {
4830 /* If the properties contain elements other than "TCP/Ports", "TCP/Address",
4831 * "VideoChannel/Enabled" and "VideoChannel/Quality" then increase the version to VBox 4.0.
4832 */
4833 unsigned cOldProperties = 0;
4834
4835 StringsMap::const_iterator it = hardwareMachine.vrdeSettings.mapProperties.find("TCP/Ports");
4836 if (it != hardwareMachine.vrdeSettings.mapProperties.end())
4837 cOldProperties++;
4838 it = hardwareMachine.vrdeSettings.mapProperties.find("TCP/Address");
4839 if (it != hardwareMachine.vrdeSettings.mapProperties.end())
4840 cOldProperties++;
4841 it = hardwareMachine.vrdeSettings.mapProperties.find("VideoChannel/Enabled");
4842 if (it != hardwareMachine.vrdeSettings.mapProperties.end())
4843 cOldProperties++;
4844 it = hardwareMachine.vrdeSettings.mapProperties.find("VideoChannel/Quality");
4845 if (it != hardwareMachine.vrdeSettings.mapProperties.end())
4846 cOldProperties++;
4847
4848 if (hardwareMachine.vrdeSettings.mapProperties.size() != cOldProperties)
4849 m->sv = SettingsVersion_v1_11;
4850 }
4851
4852 // settings version 1.9 is required if there is not exactly one DVD
4853 // or more than one floppy drive present or the DVD is not at the secondary
4854 // master; this check is a bit more complicated
4855 //
4856 // settings version 1.10 is required if the host cache should be disabled
4857 //
4858 // settings version 1.11 is required for bandwidth limits and if more than
4859 // one controller of each type is present.
4860 if (m->sv < SettingsVersion_v1_11)
4861 {
4862 // count attached DVDs and floppies (only if < v1.9)
4863 size_t cDVDs = 0;
4864 size_t cFloppies = 0;
4865
4866 // count storage controllers (if < v1.11)
4867 size_t cSata = 0;
4868 size_t cScsiLsi = 0;
4869 size_t cScsiBuslogic = 0;
4870 size_t cSas = 0;
4871 size_t cIde = 0;
4872 size_t cFloppy = 0;
4873
4874 // need to run thru all the storage controllers and attached devices to figure this out
4875 for (StorageControllersList::const_iterator it = storageMachine.llStorageControllers.begin();
4876 it != storageMachine.llStorageControllers.end();
4877 ++it)
4878 {
4879 const StorageController &sctl = *it;
4880
4881 // count storage controllers of each type; 1.11 is required if more than one
4882 // controller of one type is present
4883 switch (sctl.storageBus)
4884 {
4885 case StorageBus_IDE:
4886 cIde++;
4887 break;
4888 case StorageBus_SATA:
4889 cSata++;
4890 break;
4891 case StorageBus_SAS:
4892 cSas++;
4893 break;
4894 case StorageBus_SCSI:
4895 if (sctl.controllerType == StorageControllerType_LsiLogic)
4896 cScsiLsi++;
4897 else
4898 cScsiBuslogic++;
4899 break;
4900 case StorageBus_Floppy:
4901 cFloppy++;
4902 break;
4903 default:
4904 // Do nothing
4905 break;
4906 }
4907
4908 if ( cSata > 1
4909 || cScsiLsi > 1
4910 || cScsiBuslogic > 1
4911 || cSas > 1
4912 || cIde > 1
4913 || cFloppy > 1)
4914 {
4915 m->sv = SettingsVersion_v1_11;
4916 break; // abort the loop -- we will not raise the version further
4917 }
4918
4919 for (AttachedDevicesList::const_iterator it2 = sctl.llAttachedDevices.begin();
4920 it2 != sctl.llAttachedDevices.end();
4921 ++it2)
4922 {
4923 const AttachedDevice &att = *it2;
4924
4925 // Bandwidth limitations are new in VirtualBox 4.0 (1.11)
4926 if (m->sv < SettingsVersion_v1_11)
4927 {
4928 if (att.strBwGroup.length() != 0)
4929 {
4930 m->sv = SettingsVersion_v1_11;
4931 break; // abort the loop -- we will not raise the version further
4932 }
4933 }
4934
4935 // disabling the host IO cache requires settings version 1.10
4936 if ( (m->sv < SettingsVersion_v1_10)
4937 && (!sctl.fUseHostIOCache)
4938 )
4939 m->sv = SettingsVersion_v1_10;
4940
4941 // we can only write the StorageController/@Instance attribute with v1.9
4942 if ( (m->sv < SettingsVersion_v1_9)
4943 && (sctl.ulInstance != 0)
4944 )
4945 m->sv = SettingsVersion_v1_9;
4946
4947 if (m->sv < SettingsVersion_v1_9)
4948 {
4949 if (att.deviceType == DeviceType_DVD)
4950 {
4951 if ( (sctl.storageBus != StorageBus_IDE) // DVD at bus other than DVD?
4952 || (att.lPort != 1) // DVDs not at secondary master?
4953 || (att.lDevice != 0)
4954 )
4955 m->sv = SettingsVersion_v1_9;
4956
4957 ++cDVDs;
4958 }
4959 else if (att.deviceType == DeviceType_Floppy)
4960 ++cFloppies;
4961 }
4962 }
4963
4964 if (m->sv >= SettingsVersion_v1_11)
4965 break; // abort the loop -- we will not raise the version further
4966 }
4967
4968 // VirtualBox before 3.1 had zero or one floppy and exactly one DVD,
4969 // so any deviation from that will require settings version 1.9
4970 if ( (m->sv < SettingsVersion_v1_9)
4971 && ( (cDVDs != 1)
4972 || (cFloppies > 1)
4973 )
4974 )
4975 m->sv = SettingsVersion_v1_9;
4976 }
4977
4978 // VirtualBox 3.2: Check for non default I/O settings
4979 if (m->sv < SettingsVersion_v1_10)
4980 {
4981 if ( (hardwareMachine.ioSettings.fIoCacheEnabled != true)
4982 || (hardwareMachine.ioSettings.ulIoCacheSize != 5)
4983 // and page fusion
4984 || (hardwareMachine.fPageFusionEnabled)
4985 // and CPU hotplug, RTC timezone control, HID type and HPET
4986 || machineUserData.fRTCUseUTC
4987 || hardwareMachine.fCpuHotPlug
4988 || hardwareMachine.pointingHidType != PointingHidType_PS2Mouse
4989 || hardwareMachine.keyboardHidType != KeyboardHidType_PS2Keyboard
4990 || hardwareMachine.fHpetEnabled
4991 )
4992 m->sv = SettingsVersion_v1_10;
4993 }
4994
4995 // VirtualBox 3.2 adds NAT and boot priority to the NIC config in Main
4996 // VirtualBox 4.0 adds network bandwitdth
4997 if (m->sv < SettingsVersion_v1_11)
4998 {
4999 NetworkAdaptersList::const_iterator netit;
5000 for (netit = hardwareMachine.llNetworkAdapters.begin();
5001 netit != hardwareMachine.llNetworkAdapters.end();
5002 ++netit)
5003 {
5004 if ( (m->sv < SettingsVersion_v1_12)
5005 && (netit->strBandwidthGroup.isNotEmpty())
5006 )
5007 {
5008 /* New in VirtualBox 4.1 */
5009 m->sv = SettingsVersion_v1_12;
5010 break;
5011 }
5012 else if ( (m->sv < SettingsVersion_v1_10)
5013 && (netit->fEnabled)
5014 && (netit->mode == NetworkAttachmentType_NAT)
5015 && ( netit->nat.u32Mtu != 0
5016 || netit->nat.u32SockRcv != 0
5017 || netit->nat.u32SockSnd != 0
5018 || netit->nat.u32TcpRcv != 0
5019 || netit->nat.u32TcpSnd != 0
5020 || !netit->nat.fDnsPassDomain
5021 || netit->nat.fDnsProxy
5022 || netit->nat.fDnsUseHostResolver
5023 || netit->nat.fAliasLog
5024 || netit->nat.fAliasProxyOnly
5025 || netit->nat.fAliasUseSamePorts
5026 || netit->nat.strTftpPrefix.length()
5027 || netit->nat.strTftpBootFile.length()
5028 || netit->nat.strTftpNextServer.length()
5029 || netit->nat.llRules.size()
5030 )
5031 )
5032 {
5033 m->sv = SettingsVersion_v1_10;
5034 // no break because we still might need v1.11 above
5035 }
5036 else if ( (m->sv < SettingsVersion_v1_10)
5037 && (netit->fEnabled)
5038 && (netit->ulBootPriority != 0)
5039 )
5040 {
5041 m->sv = SettingsVersion_v1_10;
5042 // no break because we still might need v1.11 above
5043 }
5044 }
5045 }
5046
5047 // all the following require settings version 1.9
5048 if ( (m->sv < SettingsVersion_v1_9)
5049 && ( (hardwareMachine.firmwareType >= FirmwareType_EFI)
5050 || (hardwareMachine.fHardwareVirtExclusive != HWVIRTEXCLUSIVEDEFAULT)
5051 || machineUserData.fTeleporterEnabled
5052 || machineUserData.uTeleporterPort
5053 || !machineUserData.strTeleporterAddress.isEmpty()
5054 || !machineUserData.strTeleporterPassword.isEmpty()
5055 || !hardwareMachine.uuid.isEmpty()
5056 )
5057 )
5058 m->sv = SettingsVersion_v1_9;
5059
5060 // "accelerate 2d video" requires settings version 1.8
5061 if ( (m->sv < SettingsVersion_v1_8)
5062 && (hardwareMachine.fAccelerate2DVideo)
5063 )
5064 m->sv = SettingsVersion_v1_8;
5065
5066 // The hardware versions other than "1" requires settings version 1.4 (2.1+).
5067 if ( m->sv < SettingsVersion_v1_4
5068 && hardwareMachine.strVersion != "1"
5069 )
5070 m->sv = SettingsVersion_v1_4;
5071}
5072
5073/**
5074 * Called from Main code to write a machine config file to disk. This builds a DOM tree from
5075 * the member variables and then writes the XML file; it throws xml::Error instances on errors,
5076 * in particular if the file cannot be written.
5077 */
5078void MachineConfigFile::write(const com::Utf8Str &strFilename)
5079{
5080 try
5081 {
5082 // createStubDocument() sets the settings version to at least 1.7; however,
5083 // we might need to enfore a later settings version if incompatible settings
5084 // are present:
5085 bumpSettingsVersionIfNeeded();
5086
5087 m->strFilename = strFilename;
5088 createStubDocument();
5089
5090 xml::ElementNode *pelmMachine = m->pelmRoot->createChild("Machine");
5091 buildMachineXML(*pelmMachine,
5092 MachineConfigFile::BuildMachineXML_IncludeSnapshots
5093 | MachineConfigFile::BuildMachineXML_MediaRegistry,
5094 // but not BuildMachineXML_WriteVboxVersionAttribute
5095 NULL); /* pllElementsWithUuidAttributes */
5096
5097 // now go write the XML
5098 xml::XmlFileWriter writer(*m->pDoc);
5099 writer.write(m->strFilename.c_str(), true /*fSafe*/);
5100
5101 m->fFileExists = true;
5102 clearDocument();
5103 }
5104 catch (...)
5105 {
5106 clearDocument();
5107 throw;
5108 }
5109}
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