VirtualBox

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

Last change on this file since 55346 was 55259, checked in by vboxsync, 10 years ago

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