VirtualBox

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

Last change on this file since 70772 was 70768, checked in by vboxsync, 6 years ago

Main/xml/Settings.cpp: Make sure the passthrough flag is initialised like the rest of the attachment settings or the read settings might get inconsistent

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

© 2023 Oracle
ContactPrivacy policyTerms of Use