VirtualBox

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

Last change on this file since 68537 was 68537, checked in by vboxsync, 8 years ago

xml/Settings.cpp: audio in/out enable, fix default handling to give backwards compatibility (everything enabled by default) and be paranoid for new VMs (everything disabled by default)
Main/AudioAdapter: since new VMs are created with old settings version, make sure that the paranoid defaults for audio in/out enable are applied

  • Property svn:eol-style set to native
  • Property svn:keywords set to Date Revision Author Id
File size: 296.8 KB
Line 
1/* $Id: Settings.cpp 68537 2017-08-28 13:50:35Z 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-2016 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 ulId(UINT32_MAX),
2638 ulEax(0),
2639 ulEbx(0),
2640 ulEcx(0),
2641 ulEdx(0)
2642{
2643}
2644
2645/**
2646 * Comparison operator. This gets called from MachineConfigFile::operator==,
2647 * which in turn gets called from Machine::saveSettings to figure out whether
2648 * machine settings have really changed and thus need to be written out to disk.
2649 */
2650bool CpuIdLeaf::operator==(const CpuIdLeaf &c) const
2651{
2652 return (this == &c)
2653 || ( ulId == c.ulId
2654 && ulEax == c.ulEax
2655 && ulEbx == c.ulEbx
2656 && ulEcx == c.ulEcx
2657 && ulEdx == c.ulEdx);
2658}
2659
2660/**
2661 * Constructor. Needs to set sane defaults which stand the test of time.
2662 */
2663Cpu::Cpu() :
2664 ulId(UINT32_MAX)
2665{
2666}
2667
2668/**
2669 * Comparison operator. This gets called from MachineConfigFile::operator==,
2670 * which in turn gets called from Machine::saveSettings to figure out whether
2671 * machine settings have really changed and thus need to be written out to disk.
2672 */
2673bool Cpu::operator==(const Cpu &c) const
2674{
2675 return (this == &c)
2676 || (ulId == c.ulId);
2677}
2678
2679/**
2680 * Constructor. Needs to set sane defaults which stand the test of time.
2681 */
2682BandwidthGroup::BandwidthGroup() :
2683 cMaxBytesPerSec(0),
2684 enmType(BandwidthGroupType_Null)
2685{
2686}
2687
2688/**
2689 * Comparison operator. This gets called from MachineConfigFile::operator==,
2690 * which in turn gets called from Machine::saveSettings to figure out whether
2691 * machine settings have really changed and thus need to be written out to disk.
2692 */
2693bool BandwidthGroup::operator==(const BandwidthGroup &i) const
2694{
2695 return (this == &i)
2696 || ( strName == i.strName
2697 && cMaxBytesPerSec == i.cMaxBytesPerSec
2698 && enmType == i.enmType);
2699}
2700
2701/**
2702 * IOSettings constructor.
2703 */
2704IOSettings::IOSettings() :
2705 fIOCacheEnabled(true),
2706 ulIOCacheSize(5)
2707{
2708}
2709
2710/**
2711 * Check if all IO Cache settings have default values.
2712 */
2713bool IOSettings::areIOCacheDefaultSettings() const
2714{
2715 return fIOCacheEnabled
2716 && ulIOCacheSize == 5;
2717}
2718
2719/**
2720 * Check if all settings have default values.
2721 */
2722bool IOSettings::areDefaultSettings() const
2723{
2724 return areIOCacheDefaultSettings()
2725 && llBandwidthGroups.size() == 0;
2726}
2727
2728/**
2729 * Comparison operator. This gets called from MachineConfigFile::operator==,
2730 * which in turn gets called from Machine::saveSettings to figure out whether
2731 * machine settings have really changed and thus need to be written out to disk.
2732 */
2733bool IOSettings::operator==(const IOSettings &i) const
2734{
2735 return (this == &i)
2736 || ( fIOCacheEnabled == i.fIOCacheEnabled
2737 && ulIOCacheSize == i.ulIOCacheSize
2738 && llBandwidthGroups == i.llBandwidthGroups);
2739}
2740
2741/**
2742 * Constructor. Needs to set sane defaults which stand the test of time.
2743 */
2744HostPCIDeviceAttachment::HostPCIDeviceAttachment() :
2745 uHostAddress(0),
2746 uGuestAddress(0)
2747{
2748}
2749
2750/**
2751 * Comparison operator. This gets called from MachineConfigFile::operator==,
2752 * which in turn gets called from Machine::saveSettings to figure out whether
2753 * machine settings have really changed and thus need to be written out to disk.
2754 */
2755bool HostPCIDeviceAttachment::operator==(const HostPCIDeviceAttachment &a) const
2756{
2757 return (this == &a)
2758 || ( uHostAddress == a.uHostAddress
2759 && uGuestAddress == a.uGuestAddress
2760 && strDeviceName == a.strDeviceName);
2761}
2762
2763
2764/**
2765 * Constructor. Needs to set sane defaults which stand the test of time.
2766 */
2767Hardware::Hardware() :
2768 strVersion("1"),
2769 fHardwareVirt(true),
2770 fNestedPaging(true),
2771 fVPID(true),
2772 fUnrestrictedExecution(true),
2773 fHardwareVirtForce(false),
2774 fTripleFaultReset(false),
2775 fPAE(false),
2776 fAPIC(true),
2777 fX2APIC(false),
2778 enmLongMode(HC_ARCH_BITS == 64 ? Hardware::LongMode_Enabled : Hardware::LongMode_Disabled),
2779 cCPUs(1),
2780 fCpuHotPlug(false),
2781 fHPETEnabled(false),
2782 ulCpuExecutionCap(100),
2783 uCpuIdPortabilityLevel(0),
2784 strCpuProfile("host"),
2785 ulMemorySizeMB((uint32_t)-1),
2786 graphicsControllerType(GraphicsControllerType_VBoxVGA),
2787 ulVRAMSizeMB(8),
2788 cMonitors(1),
2789 fAccelerate3D(false),
2790 fAccelerate2DVideo(false),
2791 ulVideoCaptureHorzRes(1024),
2792 ulVideoCaptureVertRes(768),
2793 ulVideoCaptureRate(512),
2794 ulVideoCaptureFPS(25),
2795 ulVideoCaptureMaxTime(0),
2796 ulVideoCaptureMaxSize(0),
2797 fVideoCaptureEnabled(false),
2798 u64VideoCaptureScreens(UINT64_C(0xffffffffffffffff)),
2799 strVideoCaptureFile(""),
2800 firmwareType(FirmwareType_BIOS),
2801 pointingHIDType(PointingHIDType_PS2Mouse),
2802 keyboardHIDType(KeyboardHIDType_PS2Keyboard),
2803 chipsetType(ChipsetType_PIIX3),
2804 paravirtProvider(ParavirtProvider_Legacy), // default for old VMs, for new ones it's ParavirtProvider_Default
2805 strParavirtDebug(""),
2806 fEmulatedUSBCardReader(false),
2807 clipboardMode(ClipboardMode_Disabled),
2808 dndMode(DnDMode_Disabled),
2809 ulMemoryBalloonSize(0),
2810 fPageFusionEnabled(false)
2811{
2812 mapBootOrder[0] = DeviceType_Floppy;
2813 mapBootOrder[1] = DeviceType_DVD;
2814 mapBootOrder[2] = DeviceType_HardDisk;
2815
2816 /* The default value for PAE depends on the host:
2817 * - 64 bits host -> always true
2818 * - 32 bits host -> true for Windows & Darwin (masked off if the host cpu doesn't support it anyway)
2819 */
2820#if HC_ARCH_BITS == 64 || defined(RT_OS_WINDOWS) || defined(RT_OS_DARWIN)
2821 fPAE = true;
2822#endif
2823
2824 /* The default value of large page supports depends on the host:
2825 * - 64 bits host -> true, unless it's Linux (pending further prediction work due to excessively expensive large page allocations)
2826 * - 32 bits host -> false
2827 */
2828#if HC_ARCH_BITS == 64 && !defined(RT_OS_LINUX)
2829 fLargePages = true;
2830#else
2831 /* Not supported on 32 bits hosts. */
2832 fLargePages = false;
2833#endif
2834}
2835
2836/**
2837 * Check if all Paravirt settings have default values.
2838 */
2839bool Hardware::areParavirtDefaultSettings(SettingsVersion_T sv) const
2840{
2841 // 5.0 didn't save the paravirt settings if it is ParavirtProvider_Legacy,
2842 // so this default must be kept. Later versions don't save the setting if
2843 // it's at the default value.
2844 return ( (sv >= SettingsVersion_v1_16 && paravirtProvider == ParavirtProvider_Default)
2845 || (sv < SettingsVersion_v1_16 && paravirtProvider == ParavirtProvider_Legacy))
2846 && strParavirtDebug.isEmpty();
2847}
2848
2849/**
2850 * Check if all Boot Order settings have default values.
2851 */
2852bool Hardware::areBootOrderDefaultSettings() const
2853{
2854 BootOrderMap::const_iterator it0 = mapBootOrder.find(0);
2855 BootOrderMap::const_iterator it1 = mapBootOrder.find(1);
2856 BootOrderMap::const_iterator it2 = mapBootOrder.find(2);
2857 BootOrderMap::const_iterator it3 = mapBootOrder.find(3);
2858 return ( mapBootOrder.size() == 3
2859 || ( mapBootOrder.size() == 4
2860 && (it3 != mapBootOrder.end() && it3->second == DeviceType_Null)))
2861 && (it0 != mapBootOrder.end() && it0->second == DeviceType_Floppy)
2862 && (it1 != mapBootOrder.end() && it1->second == DeviceType_DVD)
2863 && (it2 != mapBootOrder.end() && it2->second == DeviceType_HardDisk);
2864}
2865
2866/**
2867 * Check if all Display settings have default values.
2868 */
2869bool Hardware::areDisplayDefaultSettings() const
2870{
2871 return graphicsControllerType == GraphicsControllerType_VBoxVGA
2872 && ulVRAMSizeMB == 8
2873 && cMonitors <= 1
2874 && !fAccelerate3D
2875 && !fAccelerate2DVideo;
2876}
2877
2878/**
2879 * Check if all Video Capture settings have default values.
2880 */
2881bool Hardware::areVideoCaptureDefaultSettings() const
2882{
2883 return !fVideoCaptureEnabled
2884 && u64VideoCaptureScreens == UINT64_C(0xffffffffffffffff)
2885 && strVideoCaptureFile.isEmpty()
2886 && ulVideoCaptureHorzRes == 1024
2887 && ulVideoCaptureVertRes == 768
2888 && ulVideoCaptureRate == 512
2889 && ulVideoCaptureFPS == 25
2890 && ulVideoCaptureMaxTime == 0
2891 && ulVideoCaptureMaxSize == 0;
2892}
2893
2894/**
2895 * Check if all Network Adapter settings have default values.
2896 */
2897bool Hardware::areAllNetworkAdaptersDefaultSettings(SettingsVersion_T sv) const
2898{
2899 for (NetworkAdaptersList::const_iterator it = llNetworkAdapters.begin();
2900 it != llNetworkAdapters.end();
2901 ++it)
2902 {
2903 if (!it->areDefaultSettings(sv))
2904 return false;
2905 }
2906 return true;
2907}
2908
2909/**
2910 * Comparison operator. This gets called from MachineConfigFile::operator==,
2911 * which in turn gets called from Machine::saveSettings to figure out whether
2912 * machine settings have really changed and thus need to be written out to disk.
2913 */
2914bool Hardware::operator==(const Hardware& h) const
2915{
2916 return (this == &h)
2917 || ( strVersion == h.strVersion
2918 && uuid == h.uuid
2919 && fHardwareVirt == h.fHardwareVirt
2920 && fNestedPaging == h.fNestedPaging
2921 && fLargePages == h.fLargePages
2922 && fVPID == h.fVPID
2923 && fUnrestrictedExecution == h.fUnrestrictedExecution
2924 && fHardwareVirtForce == h.fHardwareVirtForce
2925 && fPAE == h.fPAE
2926 && enmLongMode == h.enmLongMode
2927 && fTripleFaultReset == h.fTripleFaultReset
2928 && fAPIC == h.fAPIC
2929 && fX2APIC == h.fX2APIC
2930 && cCPUs == h.cCPUs
2931 && fCpuHotPlug == h.fCpuHotPlug
2932 && ulCpuExecutionCap == h.ulCpuExecutionCap
2933 && uCpuIdPortabilityLevel == h.uCpuIdPortabilityLevel
2934 && strCpuProfile == h.strCpuProfile
2935 && fHPETEnabled == h.fHPETEnabled
2936 && llCpus == h.llCpus
2937 && llCpuIdLeafs == h.llCpuIdLeafs
2938 && ulMemorySizeMB == h.ulMemorySizeMB
2939 && mapBootOrder == h.mapBootOrder
2940 && graphicsControllerType == h.graphicsControllerType
2941 && ulVRAMSizeMB == h.ulVRAMSizeMB
2942 && cMonitors == h.cMonitors
2943 && fAccelerate3D == h.fAccelerate3D
2944 && fAccelerate2DVideo == h.fAccelerate2DVideo
2945 && fVideoCaptureEnabled == h.fVideoCaptureEnabled
2946 && u64VideoCaptureScreens == h.u64VideoCaptureScreens
2947 && strVideoCaptureFile == h.strVideoCaptureFile
2948 && ulVideoCaptureHorzRes == h.ulVideoCaptureHorzRes
2949 && ulVideoCaptureVertRes == h.ulVideoCaptureVertRes
2950 && ulVideoCaptureRate == h.ulVideoCaptureRate
2951 && ulVideoCaptureFPS == h.ulVideoCaptureFPS
2952 && ulVideoCaptureMaxTime == h.ulVideoCaptureMaxTime
2953 && ulVideoCaptureMaxSize == h.ulVideoCaptureMaxTime
2954 && firmwareType == h.firmwareType
2955 && pointingHIDType == h.pointingHIDType
2956 && keyboardHIDType == h.keyboardHIDType
2957 && chipsetType == h.chipsetType
2958 && paravirtProvider == h.paravirtProvider
2959 && strParavirtDebug == h.strParavirtDebug
2960 && fEmulatedUSBCardReader == h.fEmulatedUSBCardReader
2961 && vrdeSettings == h.vrdeSettings
2962 && biosSettings == h.biosSettings
2963 && usbSettings == h.usbSettings
2964 && llNetworkAdapters == h.llNetworkAdapters
2965 && llSerialPorts == h.llSerialPorts
2966 && llParallelPorts == h.llParallelPorts
2967 && audioAdapter == h.audioAdapter
2968 && storage == h.storage
2969 && llSharedFolders == h.llSharedFolders
2970 && clipboardMode == h.clipboardMode
2971 && dndMode == h.dndMode
2972 && ulMemoryBalloonSize == h.ulMemoryBalloonSize
2973 && fPageFusionEnabled == h.fPageFusionEnabled
2974 && llGuestProperties == h.llGuestProperties
2975 && ioSettings == h.ioSettings
2976 && pciAttachments == h.pciAttachments
2977 && strDefaultFrontend == h.strDefaultFrontend);
2978}
2979
2980/**
2981 * Constructor. Needs to set sane defaults which stand the test of time.
2982 */
2983AttachedDevice::AttachedDevice() :
2984 deviceType(DeviceType_Null),
2985 fPassThrough(false),
2986 fTempEject(false),
2987 fNonRotational(false),
2988 fDiscard(false),
2989 fHotPluggable(false),
2990 lPort(0),
2991 lDevice(0)
2992{
2993}
2994
2995/**
2996 * Comparison operator. This gets called from MachineConfigFile::operator==,
2997 * which in turn gets called from Machine::saveSettings to figure out whether
2998 * machine settings have really changed and thus need to be written out to disk.
2999 */
3000bool AttachedDevice::operator==(const AttachedDevice &a) const
3001{
3002 return (this == &a)
3003 || ( deviceType == a.deviceType
3004 && fPassThrough == a.fPassThrough
3005 && fTempEject == a.fTempEject
3006 && fNonRotational == a.fNonRotational
3007 && fDiscard == a.fDiscard
3008 && fHotPluggable == a.fHotPluggable
3009 && lPort == a.lPort
3010 && lDevice == a.lDevice
3011 && uuid == a.uuid
3012 && strHostDriveSrc == a.strHostDriveSrc
3013 && strBwGroup == a.strBwGroup);
3014}
3015
3016/**
3017 * Constructor. Needs to set sane defaults which stand the test of time.
3018 */
3019StorageController::StorageController() :
3020 storageBus(StorageBus_IDE),
3021 controllerType(StorageControllerType_PIIX3),
3022 ulPortCount(2),
3023 ulInstance(0),
3024 fUseHostIOCache(true),
3025 fBootable(true)
3026{
3027}
3028
3029/**
3030 * Comparison operator. This gets called from MachineConfigFile::operator==,
3031 * which in turn gets called from Machine::saveSettings to figure out whether
3032 * machine settings have really changed and thus need to be written out to disk.
3033 */
3034bool StorageController::operator==(const StorageController &s) const
3035{
3036 return (this == &s)
3037 || ( strName == s.strName
3038 && storageBus == s.storageBus
3039 && controllerType == s.controllerType
3040 && ulPortCount == s.ulPortCount
3041 && ulInstance == s.ulInstance
3042 && fUseHostIOCache == s.fUseHostIOCache
3043 && llAttachedDevices == s.llAttachedDevices);
3044}
3045
3046/**
3047 * Comparison operator. This gets called from MachineConfigFile::operator==,
3048 * which in turn gets called from Machine::saveSettings to figure out whether
3049 * machine settings have really changed and thus need to be written out to disk.
3050 */
3051bool Storage::operator==(const Storage &s) const
3052{
3053 return (this == &s)
3054 || (llStorageControllers == s.llStorageControllers); // deep compare
3055}
3056
3057/**
3058 * Constructor. Needs to set sane defaults which stand the test of time.
3059 */
3060Debugging::Debugging() :
3061 fTracingEnabled(false),
3062 fAllowTracingToAccessVM(false),
3063 strTracingConfig()
3064{
3065}
3066
3067/**
3068 * Check if all settings have default values.
3069 */
3070bool Debugging::areDefaultSettings() const
3071{
3072 return !fTracingEnabled
3073 && !fAllowTracingToAccessVM
3074 && strTracingConfig.isEmpty();
3075}
3076
3077/**
3078 * Comparison operator. This gets called from MachineConfigFile::operator==,
3079 * which in turn gets called from Machine::saveSettings to figure out whether
3080 * machine settings have really changed and thus need to be written out to disk.
3081 */
3082bool Debugging::operator==(const Debugging &d) const
3083{
3084 return (this == &d)
3085 || ( fTracingEnabled == d.fTracingEnabled
3086 && fAllowTracingToAccessVM == d.fAllowTracingToAccessVM
3087 && strTracingConfig == d.strTracingConfig);
3088}
3089
3090/**
3091 * Constructor. Needs to set sane defaults which stand the test of time.
3092 */
3093Autostart::Autostart() :
3094 fAutostartEnabled(false),
3095 uAutostartDelay(0),
3096 enmAutostopType(AutostopType_Disabled)
3097{
3098}
3099
3100/**
3101 * Check if all settings have default values.
3102 */
3103bool Autostart::areDefaultSettings() const
3104{
3105 return !fAutostartEnabled
3106 && !uAutostartDelay
3107 && enmAutostopType == AutostopType_Disabled;
3108}
3109
3110/**
3111 * Comparison operator. This gets called from MachineConfigFile::operator==,
3112 * which in turn gets called from Machine::saveSettings to figure out whether
3113 * machine settings have really changed and thus need to be written out to disk.
3114 */
3115bool Autostart::operator==(const Autostart &a) const
3116{
3117 return (this == &a)
3118 || ( fAutostartEnabled == a.fAutostartEnabled
3119 && uAutostartDelay == a.uAutostartDelay
3120 && enmAutostopType == a.enmAutostopType);
3121}
3122
3123/**
3124 * Constructor. Needs to set sane defaults which stand the test of time.
3125 */
3126Snapshot::Snapshot()
3127{
3128 RTTimeSpecSetNano(&timestamp, 0);
3129}
3130
3131/**
3132 * Comparison operator. This gets called from MachineConfigFile::operator==,
3133 * which in turn gets called from Machine::saveSettings to figure out whether
3134 * machine settings have really changed and thus need to be written out to disk.
3135 */
3136bool Snapshot::operator==(const Snapshot &s) const
3137{
3138 return (this == &s)
3139 || ( uuid == s.uuid
3140 && strName == s.strName
3141 && strDescription == s.strDescription
3142 && RTTimeSpecIsEqual(&timestamp, &s.timestamp)
3143 && strStateFile == s.strStateFile
3144 && hardware == s.hardware // deep compare
3145 && llChildSnapshots == s.llChildSnapshots // deep compare
3146 && debugging == s.debugging
3147 && autostart == s.autostart);
3148}
3149
3150const struct Snapshot settings::Snapshot::Empty; /* default ctor is OK */
3151
3152/**
3153 * Constructor. Needs to set sane defaults which stand the test of time.
3154 */
3155MachineUserData::MachineUserData() :
3156 fDirectoryIncludesUUID(false),
3157 fNameSync(true),
3158 fTeleporterEnabled(false),
3159 uTeleporterPort(0),
3160 enmFaultToleranceState(FaultToleranceState_Inactive),
3161 uFaultTolerancePort(0),
3162 uFaultToleranceInterval(0),
3163 fRTCUseUTC(false),
3164 strVMPriority()
3165{
3166 llGroups.push_back("/");
3167}
3168
3169/**
3170 * Comparison operator. This gets called from MachineConfigFile::operator==,
3171 * which in turn gets called from Machine::saveSettings to figure out whether
3172 * machine settings have really changed and thus need to be written out to disk.
3173 */
3174bool MachineUserData::operator==(const MachineUserData &c) const
3175{
3176 return (this == &c)
3177 || ( strName == c.strName
3178 && fDirectoryIncludesUUID == c.fDirectoryIncludesUUID
3179 && fNameSync == c.fNameSync
3180 && strDescription == c.strDescription
3181 && llGroups == c.llGroups
3182 && strOsType == c.strOsType
3183 && strSnapshotFolder == c.strSnapshotFolder
3184 && fTeleporterEnabled == c.fTeleporterEnabled
3185 && uTeleporterPort == c.uTeleporterPort
3186 && strTeleporterAddress == c.strTeleporterAddress
3187 && strTeleporterPassword == c.strTeleporterPassword
3188 && enmFaultToleranceState == c.enmFaultToleranceState
3189 && uFaultTolerancePort == c.uFaultTolerancePort
3190 && uFaultToleranceInterval == c.uFaultToleranceInterval
3191 && strFaultToleranceAddress == c.strFaultToleranceAddress
3192 && strFaultTolerancePassword == c.strFaultTolerancePassword
3193 && fRTCUseUTC == c.fRTCUseUTC
3194 && ovIcon == c.ovIcon
3195 && strVMPriority == c.strVMPriority);
3196}
3197
3198
3199////////////////////////////////////////////////////////////////////////////////
3200//
3201// MachineConfigFile
3202//
3203////////////////////////////////////////////////////////////////////////////////
3204
3205/**
3206 * Constructor.
3207 *
3208 * If pstrFilename is != NULL, this reads the given settings file into the member
3209 * variables and various substructures and lists. Otherwise, the member variables
3210 * are initialized with default values.
3211 *
3212 * Throws variants of xml::Error for I/O, XML and logical content errors, which
3213 * the caller should catch; if this constructor does not throw, then the member
3214 * variables contain meaningful values (either from the file or defaults).
3215 *
3216 * @param pstrFilename
3217 */
3218MachineConfigFile::MachineConfigFile(const Utf8Str *pstrFilename)
3219 : ConfigFileBase(pstrFilename),
3220 fCurrentStateModified(true),
3221 fAborted(false)
3222{
3223 RTTimeNow(&timeLastStateChange);
3224
3225 if (pstrFilename)
3226 {
3227 // the ConfigFileBase constructor has loaded the XML file, so now
3228 // we need only analyze what is in there
3229
3230 xml::NodesLoop nlRootChildren(*m->pelmRoot);
3231 const xml::ElementNode *pelmRootChild;
3232 while ((pelmRootChild = nlRootChildren.forAllNodes()))
3233 {
3234 if (pelmRootChild->nameEquals("Machine"))
3235 readMachine(*pelmRootChild);
3236 }
3237
3238 // clean up memory allocated by XML engine
3239 clearDocument();
3240 }
3241}
3242
3243/**
3244 * Public routine which returns true if this machine config file can have its
3245 * own media registry (which is true for settings version v1.11 and higher,
3246 * i.e. files created by VirtualBox 4.0 and higher).
3247 * @return
3248 */
3249bool MachineConfigFile::canHaveOwnMediaRegistry() const
3250{
3251 return (m->sv >= SettingsVersion_v1_11);
3252}
3253
3254/**
3255 * Public routine which allows for importing machine XML from an external DOM tree.
3256 * Use this after having called the constructor with a NULL argument.
3257 *
3258 * This is used by the OVF code if a <vbox:Machine> element has been encountered
3259 * in an OVF VirtualSystem element.
3260 *
3261 * @param elmMachine
3262 */
3263void MachineConfigFile::importMachineXML(const xml::ElementNode &elmMachine)
3264{
3265 // Ideally the version should be mandatory, but since VirtualBox didn't
3266 // care about it until 5.1 came with different defaults, there are OVF
3267 // files created by magicians (not using VirtualBox, which always wrote it)
3268 // which lack this information. Let's hope that they learn to add the
3269 // version when they switch to the newer settings style/defaults of 5.1.
3270 if (!(elmMachine.getAttributeValue("version", m->strSettingsVersionFull)))
3271 m->strSettingsVersionFull = VBOX_XML_IMPORT_VERSION_FULL;
3272
3273 LogRel(("Import settings with version \"%s\"\n", m->strSettingsVersionFull.c_str()));
3274
3275 m->sv = parseVersion(m->strSettingsVersionFull, &elmMachine);
3276
3277 // remember the settings version we read in case it gets upgraded later,
3278 // so we know when to make backups
3279 m->svRead = m->sv;
3280
3281 readMachine(elmMachine);
3282}
3283
3284/**
3285 * Comparison operator. This gets called from Machine::saveSettings to figure out
3286 * whether machine settings have really changed and thus need to be written out to disk.
3287 *
3288 * Even though this is called operator==, this does NOT compare all fields; the "equals"
3289 * should be understood as "has the same machine config as". The following fields are
3290 * NOT compared:
3291 * -- settings versions and file names inherited from ConfigFileBase;
3292 * -- fCurrentStateModified because that is considered separately in Machine::saveSettings!!
3293 *
3294 * The "deep" comparisons marked below will invoke the operator== functions of the
3295 * structs defined in this file, which may in turn go into comparing lists of
3296 * other structures. As a result, invoking this can be expensive, but it's
3297 * less expensive than writing out XML to disk.
3298 */
3299bool MachineConfigFile::operator==(const MachineConfigFile &c) const
3300{
3301 return (this == &c)
3302 || ( uuid == c.uuid
3303 && machineUserData == c.machineUserData
3304 && strStateFile == c.strStateFile
3305 && uuidCurrentSnapshot == c.uuidCurrentSnapshot
3306 // skip fCurrentStateModified!
3307 && RTTimeSpecIsEqual(&timeLastStateChange, &c.timeLastStateChange)
3308 && fAborted == c.fAborted
3309 && hardwareMachine == c.hardwareMachine // this one's deep
3310 && mediaRegistry == c.mediaRegistry // this one's deep
3311 // skip mapExtraDataItems! there is no old state available as it's always forced
3312 && llFirstSnapshot == c.llFirstSnapshot); // this one's deep
3313}
3314
3315/**
3316 * Called from MachineConfigFile::readHardware() to read cpu information.
3317 * @param elmCpu
3318 * @param ll
3319 */
3320void MachineConfigFile::readCpuTree(const xml::ElementNode &elmCpu,
3321 CpuList &ll)
3322{
3323 xml::NodesLoop nl1(elmCpu, "Cpu");
3324 const xml::ElementNode *pelmCpu;
3325 while ((pelmCpu = nl1.forAllNodes()))
3326 {
3327 Cpu cpu;
3328
3329 if (!pelmCpu->getAttributeValue("id", cpu.ulId))
3330 throw ConfigFileError(this, pelmCpu, N_("Required Cpu/@id attribute is missing"));
3331
3332 ll.push_back(cpu);
3333 }
3334}
3335
3336/**
3337 * Called from MachineConfigFile::readHardware() to cpuid information.
3338 * @param elmCpuid
3339 * @param ll
3340 */
3341void MachineConfigFile::readCpuIdTree(const xml::ElementNode &elmCpuid,
3342 CpuIdLeafsList &ll)
3343{
3344 xml::NodesLoop nl1(elmCpuid, "CpuIdLeaf");
3345 const xml::ElementNode *pelmCpuIdLeaf;
3346 while ((pelmCpuIdLeaf = nl1.forAllNodes()))
3347 {
3348 CpuIdLeaf leaf;
3349
3350 if (!pelmCpuIdLeaf->getAttributeValue("id", leaf.ulId))
3351 throw ConfigFileError(this, pelmCpuIdLeaf, N_("Required CpuId/@id attribute is missing"));
3352
3353 pelmCpuIdLeaf->getAttributeValue("eax", leaf.ulEax);
3354 pelmCpuIdLeaf->getAttributeValue("ebx", leaf.ulEbx);
3355 pelmCpuIdLeaf->getAttributeValue("ecx", leaf.ulEcx);
3356 pelmCpuIdLeaf->getAttributeValue("edx", leaf.ulEdx);
3357
3358 ll.push_back(leaf);
3359 }
3360}
3361
3362/**
3363 * Called from MachineConfigFile::readHardware() to network information.
3364 * @param elmNetwork
3365 * @param ll
3366 */
3367void MachineConfigFile::readNetworkAdapters(const xml::ElementNode &elmNetwork,
3368 NetworkAdaptersList &ll)
3369{
3370 xml::NodesLoop nl1(elmNetwork, "Adapter");
3371 const xml::ElementNode *pelmAdapter;
3372 while ((pelmAdapter = nl1.forAllNodes()))
3373 {
3374 NetworkAdapter nic;
3375
3376 if (m->sv >= SettingsVersion_v1_16)
3377 {
3378 /* Starting with VirtualBox 5.1 the default is cable connected and
3379 * PCnet-FAST III. Needs to match NetworkAdapter.areDefaultSettings(). */
3380 nic.fCableConnected = true;
3381 nic.type = NetworkAdapterType_Am79C973;
3382 }
3383
3384 if (!pelmAdapter->getAttributeValue("slot", nic.ulSlot))
3385 throw ConfigFileError(this, pelmAdapter, N_("Required Adapter/@slot attribute is missing"));
3386
3387 Utf8Str strTemp;
3388 if (pelmAdapter->getAttributeValue("type", strTemp))
3389 {
3390 if (strTemp == "Am79C970A")
3391 nic.type = NetworkAdapterType_Am79C970A;
3392 else if (strTemp == "Am79C973")
3393 nic.type = NetworkAdapterType_Am79C973;
3394 else if (strTemp == "82540EM")
3395 nic.type = NetworkAdapterType_I82540EM;
3396 else if (strTemp == "82543GC")
3397 nic.type = NetworkAdapterType_I82543GC;
3398 else if (strTemp == "82545EM")
3399 nic.type = NetworkAdapterType_I82545EM;
3400 else if (strTemp == "virtio")
3401 nic.type = NetworkAdapterType_Virtio;
3402 else
3403 throw ConfigFileError(this, pelmAdapter, N_("Invalid value '%s' in Adapter/@type attribute"), strTemp.c_str());
3404 }
3405
3406 pelmAdapter->getAttributeValue("enabled", nic.fEnabled);
3407 pelmAdapter->getAttributeValue("MACAddress", nic.strMACAddress);
3408 pelmAdapter->getAttributeValue("cable", nic.fCableConnected);
3409 pelmAdapter->getAttributeValue("speed", nic.ulLineSpeed);
3410
3411 if (pelmAdapter->getAttributeValue("promiscuousModePolicy", strTemp))
3412 {
3413 if (strTemp == "Deny")
3414 nic.enmPromiscModePolicy = NetworkAdapterPromiscModePolicy_Deny;
3415 else if (strTemp == "AllowNetwork")
3416 nic.enmPromiscModePolicy = NetworkAdapterPromiscModePolicy_AllowNetwork;
3417 else if (strTemp == "AllowAll")
3418 nic.enmPromiscModePolicy = NetworkAdapterPromiscModePolicy_AllowAll;
3419 else
3420 throw ConfigFileError(this, pelmAdapter,
3421 N_("Invalid value '%s' in Adapter/@promiscuousModePolicy attribute"), strTemp.c_str());
3422 }
3423
3424 pelmAdapter->getAttributeValue("trace", nic.fTraceEnabled);
3425 pelmAdapter->getAttributeValue("tracefile", nic.strTraceFile);
3426 pelmAdapter->getAttributeValue("bootPriority", nic.ulBootPriority);
3427 pelmAdapter->getAttributeValue("bandwidthGroup", nic.strBandwidthGroup);
3428
3429 xml::ElementNodesList llNetworkModes;
3430 pelmAdapter->getChildElements(llNetworkModes);
3431 xml::ElementNodesList::iterator it;
3432 /* We should have only active mode descriptor and disabled modes set */
3433 if (llNetworkModes.size() > 2)
3434 {
3435 throw ConfigFileError(this, pelmAdapter, N_("Invalid number of modes ('%d') attached to Adapter attribute"), llNetworkModes.size());
3436 }
3437 for (it = llNetworkModes.begin(); it != llNetworkModes.end(); ++it)
3438 {
3439 const xml::ElementNode *pelmNode = *it;
3440 if (pelmNode->nameEquals("DisabledModes"))
3441 {
3442 xml::ElementNodesList llDisabledNetworkModes;
3443 xml::ElementNodesList::iterator itDisabled;
3444 pelmNode->getChildElements(llDisabledNetworkModes);
3445 /* run over disabled list and load settings */
3446 for (itDisabled = llDisabledNetworkModes.begin();
3447 itDisabled != llDisabledNetworkModes.end(); ++itDisabled)
3448 {
3449 const xml::ElementNode *pelmDisabledNode = *itDisabled;
3450 readAttachedNetworkMode(*pelmDisabledNode, false, nic);
3451 }
3452 }
3453 else
3454 readAttachedNetworkMode(*pelmNode, true, nic);
3455 }
3456 // else: default is NetworkAttachmentType_Null
3457
3458 ll.push_back(nic);
3459 }
3460}
3461
3462void MachineConfigFile::readAttachedNetworkMode(const xml::ElementNode &elmMode, bool fEnabled, NetworkAdapter &nic)
3463{
3464 NetworkAttachmentType_T enmAttachmentType = NetworkAttachmentType_Null;
3465
3466 if (elmMode.nameEquals("NAT"))
3467 {
3468 enmAttachmentType = NetworkAttachmentType_NAT;
3469
3470 elmMode.getAttributeValue("network", nic.nat.strNetwork);
3471 elmMode.getAttributeValue("hostip", nic.nat.strBindIP);
3472 elmMode.getAttributeValue("mtu", nic.nat.u32Mtu);
3473 elmMode.getAttributeValue("sockrcv", nic.nat.u32SockRcv);
3474 elmMode.getAttributeValue("socksnd", nic.nat.u32SockSnd);
3475 elmMode.getAttributeValue("tcprcv", nic.nat.u32TcpRcv);
3476 elmMode.getAttributeValue("tcpsnd", nic.nat.u32TcpSnd);
3477 const xml::ElementNode *pelmDNS;
3478 if ((pelmDNS = elmMode.findChildElement("DNS")))
3479 {
3480 pelmDNS->getAttributeValue("pass-domain", nic.nat.fDNSPassDomain);
3481 pelmDNS->getAttributeValue("use-proxy", nic.nat.fDNSProxy);
3482 pelmDNS->getAttributeValue("use-host-resolver", nic.nat.fDNSUseHostResolver);
3483 }
3484 const xml::ElementNode *pelmAlias;
3485 if ((pelmAlias = elmMode.findChildElement("Alias")))
3486 {
3487 pelmAlias->getAttributeValue("logging", nic.nat.fAliasLog);
3488 pelmAlias->getAttributeValue("proxy-only", nic.nat.fAliasProxyOnly);
3489 pelmAlias->getAttributeValue("use-same-ports", nic.nat.fAliasUseSamePorts);
3490 }
3491 const xml::ElementNode *pelmTFTP;
3492 if ((pelmTFTP = elmMode.findChildElement("TFTP")))
3493 {
3494 pelmTFTP->getAttributeValue("prefix", nic.nat.strTFTPPrefix);
3495 pelmTFTP->getAttributeValue("boot-file", nic.nat.strTFTPBootFile);
3496 pelmTFTP->getAttributeValue("next-server", nic.nat.strTFTPNextServer);
3497 }
3498
3499 readNATForwardRulesMap(elmMode, nic.nat.mapRules);
3500 }
3501 else if ( elmMode.nameEquals("HostInterface")
3502 || elmMode.nameEquals("BridgedInterface"))
3503 {
3504 enmAttachmentType = NetworkAttachmentType_Bridged;
3505
3506 // optional network name, cannot be required or we have trouble with
3507 // settings which are saved before configuring the network name
3508 elmMode.getAttributeValue("name", nic.strBridgedName);
3509 }
3510 else if (elmMode.nameEquals("InternalNetwork"))
3511 {
3512 enmAttachmentType = NetworkAttachmentType_Internal;
3513
3514 // optional network name, cannot be required or we have trouble with
3515 // settings which are saved before configuring the network name
3516 elmMode.getAttributeValue("name", nic.strInternalNetworkName);
3517 }
3518 else if (elmMode.nameEquals("HostOnlyInterface"))
3519 {
3520 enmAttachmentType = NetworkAttachmentType_HostOnly;
3521
3522 // optional network name, cannot be required or we have trouble with
3523 // settings which are saved before configuring the network name
3524 elmMode.getAttributeValue("name", nic.strHostOnlyName);
3525 }
3526 else if (elmMode.nameEquals("GenericInterface"))
3527 {
3528 enmAttachmentType = NetworkAttachmentType_Generic;
3529
3530 elmMode.getAttributeValue("driver", nic.strGenericDriver); // optional network attachment driver
3531
3532 // get all properties
3533 xml::NodesLoop nl(elmMode);
3534 const xml::ElementNode *pelmModeChild;
3535 while ((pelmModeChild = nl.forAllNodes()))
3536 {
3537 if (pelmModeChild->nameEquals("Property"))
3538 {
3539 Utf8Str strPropName, strPropValue;
3540 if ( pelmModeChild->getAttributeValue("name", strPropName)
3541 && pelmModeChild->getAttributeValue("value", strPropValue) )
3542 nic.genericProperties[strPropName] = strPropValue;
3543 else
3544 throw ConfigFileError(this, pelmModeChild, N_("Required GenericInterface/Property/@name or @value attribute is missing"));
3545 }
3546 }
3547 }
3548 else if (elmMode.nameEquals("NATNetwork"))
3549 {
3550 enmAttachmentType = NetworkAttachmentType_NATNetwork;
3551
3552 // optional network name, cannot be required or we have trouble with
3553 // settings which are saved before configuring the network name
3554 elmMode.getAttributeValue("name", nic.strNATNetworkName);
3555 }
3556 else if (elmMode.nameEquals("VDE"))
3557 {
3558 // inofficial hack (VDE networking was never part of the official
3559 // settings, so it's not mentioned in VirtualBox-settings.xsd)
3560 enmAttachmentType = NetworkAttachmentType_Generic;
3561
3562 com::Utf8Str strVDEName;
3563 elmMode.getAttributeValue("network", strVDEName); // optional network name
3564 nic.strGenericDriver = "VDE";
3565 nic.genericProperties["network"] = strVDEName;
3566 }
3567
3568 if (fEnabled && enmAttachmentType != NetworkAttachmentType_Null)
3569 nic.mode = enmAttachmentType;
3570}
3571
3572/**
3573 * Called from MachineConfigFile::readHardware() to read serial port information.
3574 * @param elmUART
3575 * @param ll
3576 */
3577void MachineConfigFile::readSerialPorts(const xml::ElementNode &elmUART,
3578 SerialPortsList &ll)
3579{
3580 xml::NodesLoop nl1(elmUART, "Port");
3581 const xml::ElementNode *pelmPort;
3582 while ((pelmPort = nl1.forAllNodes()))
3583 {
3584 SerialPort port;
3585 if (!pelmPort->getAttributeValue("slot", port.ulSlot))
3586 throw ConfigFileError(this, pelmPort, N_("Required UART/Port/@slot attribute is missing"));
3587
3588 // slot must be unique
3589 for (SerialPortsList::const_iterator it = ll.begin();
3590 it != ll.end();
3591 ++it)
3592 if ((*it).ulSlot == port.ulSlot)
3593 throw ConfigFileError(this, pelmPort, N_("Invalid value %RU32 in UART/Port/@slot attribute: value is not unique"), port.ulSlot);
3594
3595 if (!pelmPort->getAttributeValue("enabled", port.fEnabled))
3596 throw ConfigFileError(this, pelmPort, N_("Required UART/Port/@enabled attribute is missing"));
3597 if (!pelmPort->getAttributeValue("IOBase", port.ulIOBase))
3598 throw ConfigFileError(this, pelmPort, N_("Required UART/Port/@IOBase attribute is missing"));
3599 if (!pelmPort->getAttributeValue("IRQ", port.ulIRQ))
3600 throw ConfigFileError(this, pelmPort, N_("Required UART/Port/@IRQ attribute is missing"));
3601
3602 Utf8Str strPortMode;
3603 if (!pelmPort->getAttributeValue("hostMode", strPortMode))
3604 throw ConfigFileError(this, pelmPort, N_("Required UART/Port/@hostMode attribute is missing"));
3605 if (strPortMode == "RawFile")
3606 port.portMode = PortMode_RawFile;
3607 else if (strPortMode == "HostPipe")
3608 port.portMode = PortMode_HostPipe;
3609 else if (strPortMode == "HostDevice")
3610 port.portMode = PortMode_HostDevice;
3611 else if (strPortMode == "Disconnected")
3612 port.portMode = PortMode_Disconnected;
3613 else if (strPortMode == "TCP")
3614 port.portMode = PortMode_TCP;
3615 else
3616 throw ConfigFileError(this, pelmPort, N_("Invalid value '%s' in UART/Port/@hostMode attribute"), strPortMode.c_str());
3617
3618 pelmPort->getAttributeValue("path", port.strPath);
3619 pelmPort->getAttributeValue("server", port.fServer);
3620
3621 ll.push_back(port);
3622 }
3623}
3624
3625/**
3626 * Called from MachineConfigFile::readHardware() to read parallel port information.
3627 * @param elmLPT
3628 * @param ll
3629 */
3630void MachineConfigFile::readParallelPorts(const xml::ElementNode &elmLPT,
3631 ParallelPortsList &ll)
3632{
3633 xml::NodesLoop nl1(elmLPT, "Port");
3634 const xml::ElementNode *pelmPort;
3635 while ((pelmPort = nl1.forAllNodes()))
3636 {
3637 ParallelPort port;
3638 if (!pelmPort->getAttributeValue("slot", port.ulSlot))
3639 throw ConfigFileError(this, pelmPort, N_("Required LPT/Port/@slot attribute is missing"));
3640
3641 // slot must be unique
3642 for (ParallelPortsList::const_iterator it = ll.begin();
3643 it != ll.end();
3644 ++it)
3645 if ((*it).ulSlot == port.ulSlot)
3646 throw ConfigFileError(this, pelmPort, N_("Invalid value %RU32 in LPT/Port/@slot attribute: value is not unique"), port.ulSlot);
3647
3648 if (!pelmPort->getAttributeValue("enabled", port.fEnabled))
3649 throw ConfigFileError(this, pelmPort, N_("Required LPT/Port/@enabled attribute is missing"));
3650 if (!pelmPort->getAttributeValue("IOBase", port.ulIOBase))
3651 throw ConfigFileError(this, pelmPort, N_("Required LPT/Port/@IOBase attribute is missing"));
3652 if (!pelmPort->getAttributeValue("IRQ", port.ulIRQ))
3653 throw ConfigFileError(this, pelmPort, N_("Required LPT/Port/@IRQ attribute is missing"));
3654
3655 pelmPort->getAttributeValue("path", port.strPath);
3656
3657 ll.push_back(port);
3658 }
3659}
3660
3661/**
3662 * Called from MachineConfigFile::readHardware() to read audio adapter information
3663 * and maybe fix driver information depending on the current host hardware.
3664 *
3665 * @param elmAudioAdapter "AudioAdapter" XML element.
3666 * @param aa
3667 */
3668void MachineConfigFile::readAudioAdapter(const xml::ElementNode &elmAudioAdapter,
3669 AudioAdapter &aa)
3670{
3671 if (m->sv >= SettingsVersion_v1_15)
3672 {
3673 // get all properties
3674 xml::NodesLoop nl1(elmAudioAdapter, "Property");
3675 const xml::ElementNode *pelmModeChild;
3676 while ((pelmModeChild = nl1.forAllNodes()))
3677 {
3678 Utf8Str strPropName, strPropValue;
3679 if ( pelmModeChild->getAttributeValue("name", strPropName)
3680 && pelmModeChild->getAttributeValue("value", strPropValue) )
3681 aa.properties[strPropName] = strPropValue;
3682 else
3683 throw ConfigFileError(this, pelmModeChild, N_("Required AudioAdapter/Property/@name or @value attribute "
3684 "is missing"));
3685 }
3686 }
3687
3688 elmAudioAdapter.getAttributeValue("enabled", aa.fEnabled);
3689 elmAudioAdapter.getAttributeValue("enabledIn", aa.fEnabledIn);
3690 elmAudioAdapter.getAttributeValue("enabledOut", aa.fEnabledOut);
3691
3692 Utf8Str strTemp;
3693 if (elmAudioAdapter.getAttributeValue("controller", strTemp))
3694 {
3695 if (strTemp == "SB16")
3696 aa.controllerType = AudioControllerType_SB16;
3697 else if (strTemp == "AC97")
3698 aa.controllerType = AudioControllerType_AC97;
3699 else if (strTemp == "HDA")
3700 aa.controllerType = AudioControllerType_HDA;
3701 else
3702 throw ConfigFileError(this, &elmAudioAdapter, N_("Invalid value '%s' in AudioAdapter/@controller attribute"), strTemp.c_str());
3703 }
3704
3705 if (elmAudioAdapter.getAttributeValue("codec", strTemp))
3706 {
3707 if (strTemp == "SB16")
3708 aa.codecType = AudioCodecType_SB16;
3709 else if (strTemp == "STAC9700")
3710 aa.codecType = AudioCodecType_STAC9700;
3711 else if (strTemp == "AD1980")
3712 aa.codecType = AudioCodecType_AD1980;
3713 else if (strTemp == "STAC9221")
3714 aa.codecType = AudioCodecType_STAC9221;
3715 else
3716 throw ConfigFileError(this, &elmAudioAdapter, N_("Invalid value '%s' in AudioAdapter/@codec attribute"), strTemp.c_str());
3717 }
3718 else
3719 {
3720 /* No codec attribute provided; use defaults. */
3721 switch (aa.controllerType)
3722 {
3723 case AudioControllerType_AC97:
3724 aa.codecType = AudioCodecType_STAC9700;
3725 break;
3726 case AudioControllerType_SB16:
3727 aa.codecType = AudioCodecType_SB16;
3728 break;
3729 case AudioControllerType_HDA:
3730 aa.codecType = AudioCodecType_STAC9221;
3731 break;
3732 default:
3733 Assert(false); /* We just checked the controller type above. */
3734 }
3735 }
3736
3737 if (elmAudioAdapter.getAttributeValue("driver", strTemp))
3738 {
3739 // settings before 1.3 used lower case so make sure this is case-insensitive
3740 strTemp.toUpper();
3741 if (strTemp == "NULL")
3742 aa.driverType = AudioDriverType_Null;
3743 else if (strTemp == "WINMM")
3744 aa.driverType = AudioDriverType_WinMM;
3745 else if ( (strTemp == "DIRECTSOUND") || (strTemp == "DSOUND") )
3746 aa.driverType = AudioDriverType_DirectSound;
3747 else if (strTemp == "SOLAUDIO") /* Deprecated -- Solaris will use OSS by default now. */
3748 aa.driverType = AudioDriverType_SolAudio;
3749 else if (strTemp == "ALSA")
3750 aa.driverType = AudioDriverType_ALSA;
3751 else if (strTemp == "PULSE")
3752 aa.driverType = AudioDriverType_Pulse;
3753 else if (strTemp == "OSS")
3754 aa.driverType = AudioDriverType_OSS;
3755 else if (strTemp == "COREAUDIO")
3756 aa.driverType = AudioDriverType_CoreAudio;
3757 else if (strTemp == "MMPM")
3758 aa.driverType = AudioDriverType_MMPM;
3759 else
3760 throw ConfigFileError(this, &elmAudioAdapter, N_("Invalid value '%s' in AudioAdapter/@driver attribute"), strTemp.c_str());
3761
3762 // now check if this is actually supported on the current host platform;
3763 // people might be opening a file created on a Windows host, and that
3764 // VM should still start on a Linux host
3765 if (!isAudioDriverAllowedOnThisHost(aa.driverType))
3766 aa.driverType = getHostDefaultAudioDriver();
3767 }
3768}
3769
3770/**
3771 * Called from MachineConfigFile::readHardware() to read guest property information.
3772 * @param elmGuestProperties
3773 * @param hw
3774 */
3775void MachineConfigFile::readGuestProperties(const xml::ElementNode &elmGuestProperties,
3776 Hardware &hw)
3777{
3778 xml::NodesLoop nl1(elmGuestProperties, "GuestProperty");
3779 const xml::ElementNode *pelmProp;
3780 while ((pelmProp = nl1.forAllNodes()))
3781 {
3782 GuestProperty prop;
3783 pelmProp->getAttributeValue("name", prop.strName);
3784 pelmProp->getAttributeValue("value", prop.strValue);
3785
3786 pelmProp->getAttributeValue("timestamp", prop.timestamp);
3787 pelmProp->getAttributeValue("flags", prop.strFlags);
3788 hw.llGuestProperties.push_back(prop);
3789 }
3790}
3791
3792/**
3793 * Helper function to read attributes that are common to \<SATAController\> (pre-1.7)
3794 * and \<StorageController\>.
3795 * @param elmStorageController
3796 * @param sctl
3797 */
3798void MachineConfigFile::readStorageControllerAttributes(const xml::ElementNode &elmStorageController,
3799 StorageController &sctl)
3800{
3801 elmStorageController.getAttributeValue("PortCount", sctl.ulPortCount);
3802 elmStorageController.getAttributeValue("useHostIOCache", sctl.fUseHostIOCache);
3803}
3804
3805/**
3806 * Reads in a \<Hardware\> block and stores it in the given structure. Used
3807 * both directly from readMachine and from readSnapshot, since snapshots
3808 * have their own hardware sections.
3809 *
3810 * For legacy pre-1.7 settings we also need a storage structure because
3811 * the IDE and SATA controllers used to be defined under \<Hardware\>.
3812 *
3813 * @param elmHardware
3814 * @param hw
3815 */
3816void MachineConfigFile::readHardware(const xml::ElementNode &elmHardware,
3817 Hardware &hw)
3818{
3819 if (m->sv >= SettingsVersion_v1_16)
3820 {
3821 /* Starting with VirtualBox 5.1 the default is Default, before it was
3822 * Legacy. This needs to matched by areParavirtDefaultSettings(). */
3823 hw.paravirtProvider = ParavirtProvider_Default;
3824 /* The new default is disabled, before it was enabled by default. */
3825 hw.vrdeSettings.fEnabled = false;
3826 /* The new default is disabled, before it was enabled by default. */
3827 hw.audioAdapter.fEnabled = false;
3828 /* The new default is disabled, before it was enabled by default. */
3829 hw.audioAdapter.fEnabledIn = false;
3830 /* The new default is disabled, before it was enabled by default. */
3831 hw.audioAdapter.fEnabledOut = false;
3832 }
3833
3834 if (!elmHardware.getAttributeValue("version", hw.strVersion))
3835 {
3836 /* KLUDGE ALERT! For a while during the 3.1 development this was not
3837 written because it was thought to have a default value of "2". For
3838 sv <= 1.3 it defaults to "1" because the attribute didn't exist,
3839 while for 1.4+ it is sort of mandatory. Now, the buggy XML writer
3840 code only wrote 1.7 and later. So, if it's a 1.7+ XML file and it's
3841 missing the hardware version, then it probably should be "2" instead
3842 of "1". */
3843 if (m->sv < SettingsVersion_v1_7)
3844 hw.strVersion = "1";
3845 else
3846 hw.strVersion = "2";
3847 }
3848 Utf8Str strUUID;
3849 if (elmHardware.getAttributeValue("uuid", strUUID))
3850 parseUUID(hw.uuid, strUUID, &elmHardware);
3851
3852 xml::NodesLoop nl1(elmHardware);
3853 const xml::ElementNode *pelmHwChild;
3854 while ((pelmHwChild = nl1.forAllNodes()))
3855 {
3856 if (pelmHwChild->nameEquals("CPU"))
3857 {
3858 if (!pelmHwChild->getAttributeValue("count", hw.cCPUs))
3859 {
3860 // pre-1.5 variant; not sure if this actually exists in the wild anywhere
3861 const xml::ElementNode *pelmCPUChild;
3862 if ((pelmCPUChild = pelmHwChild->findChildElement("CPUCount")))
3863 pelmCPUChild->getAttributeValue("count", hw.cCPUs);
3864 }
3865
3866 pelmHwChild->getAttributeValue("hotplug", hw.fCpuHotPlug);
3867 pelmHwChild->getAttributeValue("executionCap", hw.ulCpuExecutionCap);
3868
3869 const xml::ElementNode *pelmCPUChild;
3870 if (hw.fCpuHotPlug)
3871 {
3872 if ((pelmCPUChild = pelmHwChild->findChildElement("CpuTree")))
3873 readCpuTree(*pelmCPUChild, hw.llCpus);
3874 }
3875
3876 if ((pelmCPUChild = pelmHwChild->findChildElement("HardwareVirtEx")))
3877 {
3878 pelmCPUChild->getAttributeValue("enabled", hw.fHardwareVirt);
3879 }
3880 if ((pelmCPUChild = pelmHwChild->findChildElement("HardwareVirtExNestedPaging")))
3881 pelmCPUChild->getAttributeValue("enabled", hw.fNestedPaging);
3882 if ((pelmCPUChild = pelmHwChild->findChildElement("HardwareVirtExLargePages")))
3883 pelmCPUChild->getAttributeValue("enabled", hw.fLargePages);
3884 if ((pelmCPUChild = pelmHwChild->findChildElement("HardwareVirtExVPID")))
3885 pelmCPUChild->getAttributeValue("enabled", hw.fVPID);
3886 if ((pelmCPUChild = pelmHwChild->findChildElement("HardwareVirtExUX")))
3887 pelmCPUChild->getAttributeValue("enabled", hw.fUnrestrictedExecution);
3888 if ((pelmCPUChild = pelmHwChild->findChildElement("HardwareVirtForce")))
3889 pelmCPUChild->getAttributeValue("enabled", hw.fHardwareVirtForce);
3890
3891 if (!(pelmCPUChild = pelmHwChild->findChildElement("PAE")))
3892 {
3893 /* The default for pre 3.1 was false, so we must respect that. */
3894 if (m->sv < SettingsVersion_v1_9)
3895 hw.fPAE = false;
3896 }
3897 else
3898 pelmCPUChild->getAttributeValue("enabled", hw.fPAE);
3899
3900 bool fLongMode;
3901 if ( (pelmCPUChild = pelmHwChild->findChildElement("LongMode"))
3902 && pelmCPUChild->getAttributeValue("enabled", fLongMode) )
3903 hw.enmLongMode = fLongMode ? Hardware::LongMode_Enabled : Hardware::LongMode_Disabled;
3904 else
3905 hw.enmLongMode = Hardware::LongMode_Legacy;
3906
3907 if ((pelmCPUChild = pelmHwChild->findChildElement("SyntheticCpu")))
3908 {
3909 bool fSyntheticCpu = false;
3910 pelmCPUChild->getAttributeValue("enabled", fSyntheticCpu);
3911 hw.uCpuIdPortabilityLevel = fSyntheticCpu ? 1 : 0;
3912 }
3913 pelmHwChild->getAttributeValue("CpuIdPortabilityLevel", hw.uCpuIdPortabilityLevel);
3914 pelmHwChild->getAttributeValue("CpuProfile", hw.strCpuProfile);
3915
3916 if ((pelmCPUChild = pelmHwChild->findChildElement("TripleFaultReset")))
3917 pelmCPUChild->getAttributeValue("enabled", hw.fTripleFaultReset);
3918
3919 if ((pelmCPUChild = pelmHwChild->findChildElement("APIC")))
3920 pelmCPUChild->getAttributeValue("enabled", hw.fAPIC);
3921 if ((pelmCPUChild = pelmHwChild->findChildElement("X2APIC")))
3922 pelmCPUChild->getAttributeValue("enabled", hw.fX2APIC);
3923 if (hw.fX2APIC)
3924 hw.fAPIC = true;
3925
3926 if ((pelmCPUChild = pelmHwChild->findChildElement("CpuIdTree")))
3927 readCpuIdTree(*pelmCPUChild, hw.llCpuIdLeafs);
3928 }
3929 else if (pelmHwChild->nameEquals("Memory"))
3930 {
3931 pelmHwChild->getAttributeValue("RAMSize", hw.ulMemorySizeMB);
3932 pelmHwChild->getAttributeValue("PageFusion", hw.fPageFusionEnabled);
3933 }
3934 else if (pelmHwChild->nameEquals("Firmware"))
3935 {
3936 Utf8Str strFirmwareType;
3937 if (pelmHwChild->getAttributeValue("type", strFirmwareType))
3938 {
3939 if ( (strFirmwareType == "BIOS")
3940 || (strFirmwareType == "1") // some trunk builds used the number here
3941 )
3942 hw.firmwareType = FirmwareType_BIOS;
3943 else if ( (strFirmwareType == "EFI")
3944 || (strFirmwareType == "2") // some trunk builds used the number here
3945 )
3946 hw.firmwareType = FirmwareType_EFI;
3947 else if ( strFirmwareType == "EFI32")
3948 hw.firmwareType = FirmwareType_EFI32;
3949 else if ( strFirmwareType == "EFI64")
3950 hw.firmwareType = FirmwareType_EFI64;
3951 else if ( strFirmwareType == "EFIDUAL")
3952 hw.firmwareType = FirmwareType_EFIDUAL;
3953 else
3954 throw ConfigFileError(this,
3955 pelmHwChild,
3956 N_("Invalid value '%s' in Firmware/@type"),
3957 strFirmwareType.c_str());
3958 }
3959 }
3960 else if (pelmHwChild->nameEquals("HID"))
3961 {
3962 Utf8Str strHIDType;
3963 if (pelmHwChild->getAttributeValue("Keyboard", strHIDType))
3964 {
3965 if (strHIDType == "None")
3966 hw.keyboardHIDType = KeyboardHIDType_None;
3967 else if (strHIDType == "USBKeyboard")
3968 hw.keyboardHIDType = KeyboardHIDType_USBKeyboard;
3969 else if (strHIDType == "PS2Keyboard")
3970 hw.keyboardHIDType = KeyboardHIDType_PS2Keyboard;
3971 else if (strHIDType == "ComboKeyboard")
3972 hw.keyboardHIDType = KeyboardHIDType_ComboKeyboard;
3973 else
3974 throw ConfigFileError(this,
3975 pelmHwChild,
3976 N_("Invalid value '%s' in HID/Keyboard/@type"),
3977 strHIDType.c_str());
3978 }
3979 if (pelmHwChild->getAttributeValue("Pointing", strHIDType))
3980 {
3981 if (strHIDType == "None")
3982 hw.pointingHIDType = PointingHIDType_None;
3983 else if (strHIDType == "USBMouse")
3984 hw.pointingHIDType = PointingHIDType_USBMouse;
3985 else if (strHIDType == "USBTablet")
3986 hw.pointingHIDType = PointingHIDType_USBTablet;
3987 else if (strHIDType == "PS2Mouse")
3988 hw.pointingHIDType = PointingHIDType_PS2Mouse;
3989 else if (strHIDType == "ComboMouse")
3990 hw.pointingHIDType = PointingHIDType_ComboMouse;
3991 else if (strHIDType == "USBMultiTouch")
3992 hw.pointingHIDType = PointingHIDType_USBMultiTouch;
3993 else
3994 throw ConfigFileError(this,
3995 pelmHwChild,
3996 N_("Invalid value '%s' in HID/Pointing/@type"),
3997 strHIDType.c_str());
3998 }
3999 }
4000 else if (pelmHwChild->nameEquals("Chipset"))
4001 {
4002 Utf8Str strChipsetType;
4003 if (pelmHwChild->getAttributeValue("type", strChipsetType))
4004 {
4005 if (strChipsetType == "PIIX3")
4006 hw.chipsetType = ChipsetType_PIIX3;
4007 else if (strChipsetType == "ICH9")
4008 hw.chipsetType = ChipsetType_ICH9;
4009 else
4010 throw ConfigFileError(this,
4011 pelmHwChild,
4012 N_("Invalid value '%s' in Chipset/@type"),
4013 strChipsetType.c_str());
4014 }
4015 }
4016 else if (pelmHwChild->nameEquals("Paravirt"))
4017 {
4018 Utf8Str strProvider;
4019 if (pelmHwChild->getAttributeValue("provider", strProvider))
4020 {
4021 if (strProvider == "None")
4022 hw.paravirtProvider = ParavirtProvider_None;
4023 else if (strProvider == "Default")
4024 hw.paravirtProvider = ParavirtProvider_Default;
4025 else if (strProvider == "Legacy")
4026 hw.paravirtProvider = ParavirtProvider_Legacy;
4027 else if (strProvider == "Minimal")
4028 hw.paravirtProvider = ParavirtProvider_Minimal;
4029 else if (strProvider == "HyperV")
4030 hw.paravirtProvider = ParavirtProvider_HyperV;
4031 else if (strProvider == "KVM")
4032 hw.paravirtProvider = ParavirtProvider_KVM;
4033 else
4034 throw ConfigFileError(this,
4035 pelmHwChild,
4036 N_("Invalid value '%s' in Paravirt/@provider attribute"),
4037 strProvider.c_str());
4038 }
4039
4040 pelmHwChild->getAttributeValue("debug", hw.strParavirtDebug);
4041 }
4042 else if (pelmHwChild->nameEquals("HPET"))
4043 {
4044 pelmHwChild->getAttributeValue("enabled", hw.fHPETEnabled);
4045 }
4046 else if (pelmHwChild->nameEquals("Boot"))
4047 {
4048 hw.mapBootOrder.clear();
4049
4050 xml::NodesLoop nl2(*pelmHwChild, "Order");
4051 const xml::ElementNode *pelmOrder;
4052 while ((pelmOrder = nl2.forAllNodes()))
4053 {
4054 uint32_t ulPos;
4055 Utf8Str strDevice;
4056 if (!pelmOrder->getAttributeValue("position", ulPos))
4057 throw ConfigFileError(this, pelmOrder, N_("Required Boot/Order/@position attribute is missing"));
4058
4059 if ( ulPos < 1
4060 || ulPos > SchemaDefs::MaxBootPosition
4061 )
4062 throw ConfigFileError(this,
4063 pelmOrder,
4064 N_("Invalid value '%RU32' in Boot/Order/@position: must be greater than 0 and less than %RU32"),
4065 ulPos,
4066 SchemaDefs::MaxBootPosition + 1);
4067 // XML is 1-based but internal data is 0-based
4068 --ulPos;
4069
4070 if (hw.mapBootOrder.find(ulPos) != hw.mapBootOrder.end())
4071 throw ConfigFileError(this, pelmOrder, N_("Invalid value '%RU32' in Boot/Order/@position: value is not unique"), ulPos);
4072
4073 if (!pelmOrder->getAttributeValue("device", strDevice))
4074 throw ConfigFileError(this, pelmOrder, N_("Required Boot/Order/@device attribute is missing"));
4075
4076 DeviceType_T type;
4077 if (strDevice == "None")
4078 type = DeviceType_Null;
4079 else if (strDevice == "Floppy")
4080 type = DeviceType_Floppy;
4081 else if (strDevice == "DVD")
4082 type = DeviceType_DVD;
4083 else if (strDevice == "HardDisk")
4084 type = DeviceType_HardDisk;
4085 else if (strDevice == "Network")
4086 type = DeviceType_Network;
4087 else
4088 throw ConfigFileError(this, pelmOrder, N_("Invalid value '%s' in Boot/Order/@device attribute"), strDevice.c_str());
4089 hw.mapBootOrder[ulPos] = type;
4090 }
4091 }
4092 else if (pelmHwChild->nameEquals("Display"))
4093 {
4094 Utf8Str strGraphicsControllerType;
4095 if (!pelmHwChild->getAttributeValue("controller", strGraphicsControllerType))
4096 hw.graphicsControllerType = GraphicsControllerType_VBoxVGA;
4097 else
4098 {
4099 strGraphicsControllerType.toUpper();
4100 GraphicsControllerType_T type;
4101 if (strGraphicsControllerType == "VBOXVGA")
4102 type = GraphicsControllerType_VBoxVGA;
4103 else if (strGraphicsControllerType == "VMSVGA")
4104 type = GraphicsControllerType_VMSVGA;
4105 else if (strGraphicsControllerType == "NONE")
4106 type = GraphicsControllerType_Null;
4107 else
4108 throw ConfigFileError(this, pelmHwChild, N_("Invalid value '%s' in Display/@controller attribute"), strGraphicsControllerType.c_str());
4109 hw.graphicsControllerType = type;
4110 }
4111 pelmHwChild->getAttributeValue("VRAMSize", hw.ulVRAMSizeMB);
4112 if (!pelmHwChild->getAttributeValue("monitorCount", hw.cMonitors))
4113 pelmHwChild->getAttributeValue("MonitorCount", hw.cMonitors); // pre-v1.5 variant
4114 if (!pelmHwChild->getAttributeValue("accelerate3D", hw.fAccelerate3D))
4115 pelmHwChild->getAttributeValue("Accelerate3D", hw.fAccelerate3D); // pre-v1.5 variant
4116 pelmHwChild->getAttributeValue("accelerate2DVideo", hw.fAccelerate2DVideo);
4117 }
4118 else if (pelmHwChild->nameEquals("VideoCapture"))
4119 {
4120 pelmHwChild->getAttributeValue("enabled", hw.fVideoCaptureEnabled);
4121 pelmHwChild->getAttributeValue("screens", hw.u64VideoCaptureScreens);
4122 pelmHwChild->getAttributeValuePath("file", hw.strVideoCaptureFile);
4123 pelmHwChild->getAttributeValue("horzRes", hw.ulVideoCaptureHorzRes);
4124 pelmHwChild->getAttributeValue("vertRes", hw.ulVideoCaptureVertRes);
4125 pelmHwChild->getAttributeValue("rate", hw.ulVideoCaptureRate);
4126 pelmHwChild->getAttributeValue("fps", hw.ulVideoCaptureFPS);
4127 pelmHwChild->getAttributeValue("maxTime", hw.ulVideoCaptureMaxTime);
4128 pelmHwChild->getAttributeValue("maxSize", hw.ulVideoCaptureMaxSize);
4129 }
4130 else if (pelmHwChild->nameEquals("RemoteDisplay"))
4131 {
4132 pelmHwChild->getAttributeValue("enabled", hw.vrdeSettings.fEnabled);
4133
4134 Utf8Str str;
4135 if (pelmHwChild->getAttributeValue("port", str))
4136 hw.vrdeSettings.mapProperties["TCP/Ports"] = str;
4137 if (pelmHwChild->getAttributeValue("netAddress", str))
4138 hw.vrdeSettings.mapProperties["TCP/Address"] = str;
4139
4140 Utf8Str strAuthType;
4141 if (pelmHwChild->getAttributeValue("authType", strAuthType))
4142 {
4143 // settings before 1.3 used lower case so make sure this is case-insensitive
4144 strAuthType.toUpper();
4145 if (strAuthType == "NULL")
4146 hw.vrdeSettings.authType = AuthType_Null;
4147 else if (strAuthType == "GUEST")
4148 hw.vrdeSettings.authType = AuthType_Guest;
4149 else if (strAuthType == "EXTERNAL")
4150 hw.vrdeSettings.authType = AuthType_External;
4151 else
4152 throw ConfigFileError(this, pelmHwChild, N_("Invalid value '%s' in RemoteDisplay/@authType attribute"), strAuthType.c_str());
4153 }
4154
4155 pelmHwChild->getAttributeValue("authLibrary", hw.vrdeSettings.strAuthLibrary);
4156 pelmHwChild->getAttributeValue("authTimeout", hw.vrdeSettings.ulAuthTimeout);
4157 pelmHwChild->getAttributeValue("allowMultiConnection", hw.vrdeSettings.fAllowMultiConnection);
4158 pelmHwChild->getAttributeValue("reuseSingleConnection", hw.vrdeSettings.fReuseSingleConnection);
4159
4160 /* 3.2 and 4.0 betas, 4.0 has this information in VRDEProperties. */
4161 const xml::ElementNode *pelmVideoChannel;
4162 if ((pelmVideoChannel = pelmHwChild->findChildElement("VideoChannel")))
4163 {
4164 bool fVideoChannel = false;
4165 pelmVideoChannel->getAttributeValue("enabled", fVideoChannel);
4166 hw.vrdeSettings.mapProperties["VideoChannel/Enabled"] = fVideoChannel? "true": "false";
4167
4168 uint32_t ulVideoChannelQuality = 75;
4169 pelmVideoChannel->getAttributeValue("quality", ulVideoChannelQuality);
4170 ulVideoChannelQuality = RT_CLAMP(ulVideoChannelQuality, 10, 100);
4171 char *pszBuffer = NULL;
4172 if (RTStrAPrintf(&pszBuffer, "%d", ulVideoChannelQuality) >= 0)
4173 {
4174 hw.vrdeSettings.mapProperties["VideoChannel/Quality"] = pszBuffer;
4175 RTStrFree(pszBuffer);
4176 }
4177 else
4178 hw.vrdeSettings.mapProperties["VideoChannel/Quality"] = "75";
4179 }
4180 pelmHwChild->getAttributeValue("VRDEExtPack", hw.vrdeSettings.strVrdeExtPack);
4181
4182 const xml::ElementNode *pelmProperties = pelmHwChild->findChildElement("VRDEProperties");
4183 if (pelmProperties != NULL)
4184 {
4185 xml::NodesLoop nl(*pelmProperties);
4186 const xml::ElementNode *pelmProperty;
4187 while ((pelmProperty = nl.forAllNodes()))
4188 {
4189 if (pelmProperty->nameEquals("Property"))
4190 {
4191 /* <Property name="TCP/Ports" value="3000-3002"/> */
4192 Utf8Str strName, strValue;
4193 if ( pelmProperty->getAttributeValue("name", strName)
4194 && pelmProperty->getAttributeValue("value", strValue))
4195 hw.vrdeSettings.mapProperties[strName] = strValue;
4196 else
4197 throw ConfigFileError(this, pelmProperty, N_("Required VRDE Property/@name or @value attribute is missing"));
4198 }
4199 }
4200 }
4201 }
4202 else if (pelmHwChild->nameEquals("BIOS"))
4203 {
4204 const xml::ElementNode *pelmBIOSChild;
4205 if ((pelmBIOSChild = pelmHwChild->findChildElement("ACPI")))
4206 pelmBIOSChild->getAttributeValue("enabled", hw.biosSettings.fACPIEnabled);
4207 if ((pelmBIOSChild = pelmHwChild->findChildElement("IOAPIC")))
4208 pelmBIOSChild->getAttributeValue("enabled", hw.biosSettings.fIOAPICEnabled);
4209 if ((pelmBIOSChild = pelmHwChild->findChildElement("APIC")))
4210 {
4211 Utf8Str strAPIC;
4212 if (pelmBIOSChild->getAttributeValue("mode", strAPIC))
4213 {
4214 strAPIC.toUpper();
4215 if (strAPIC == "DISABLED")
4216 hw.biosSettings.apicMode = APICMode_Disabled;
4217 else if (strAPIC == "APIC")
4218 hw.biosSettings.apicMode = APICMode_APIC;
4219 else if (strAPIC == "X2APIC")
4220 hw.biosSettings.apicMode = APICMode_X2APIC;
4221 else
4222 throw ConfigFileError(this, pelmBIOSChild, N_("Invalid value '%s' in APIC/@mode attribute"), strAPIC.c_str());
4223 }
4224 }
4225 if ((pelmBIOSChild = pelmHwChild->findChildElement("Logo")))
4226 {
4227 pelmBIOSChild->getAttributeValue("fadeIn", hw.biosSettings.fLogoFadeIn);
4228 pelmBIOSChild->getAttributeValue("fadeOut", hw.biosSettings.fLogoFadeOut);
4229 pelmBIOSChild->getAttributeValue("displayTime", hw.biosSettings.ulLogoDisplayTime);
4230 pelmBIOSChild->getAttributeValue("imagePath", hw.biosSettings.strLogoImagePath);
4231 }
4232 if ((pelmBIOSChild = pelmHwChild->findChildElement("BootMenu")))
4233 {
4234 Utf8Str strBootMenuMode;
4235 if (pelmBIOSChild->getAttributeValue("mode", strBootMenuMode))
4236 {
4237 // settings before 1.3 used lower case so make sure this is case-insensitive
4238 strBootMenuMode.toUpper();
4239 if (strBootMenuMode == "DISABLED")
4240 hw.biosSettings.biosBootMenuMode = BIOSBootMenuMode_Disabled;
4241 else if (strBootMenuMode == "MENUONLY")
4242 hw.biosSettings.biosBootMenuMode = BIOSBootMenuMode_MenuOnly;
4243 else if (strBootMenuMode == "MESSAGEANDMENU")
4244 hw.biosSettings.biosBootMenuMode = BIOSBootMenuMode_MessageAndMenu;
4245 else
4246 throw ConfigFileError(this, pelmBIOSChild, N_("Invalid value '%s' in BootMenu/@mode attribute"), strBootMenuMode.c_str());
4247 }
4248 }
4249 if ((pelmBIOSChild = pelmHwChild->findChildElement("PXEDebug")))
4250 pelmBIOSChild->getAttributeValue("enabled", hw.biosSettings.fPXEDebugEnabled);
4251 if ((pelmBIOSChild = pelmHwChild->findChildElement("TimeOffset")))
4252 pelmBIOSChild->getAttributeValue("value", hw.biosSettings.llTimeOffset);
4253
4254 // legacy BIOS/IDEController (pre 1.7)
4255 if ( (m->sv < SettingsVersion_v1_7)
4256 && (pelmBIOSChild = pelmHwChild->findChildElement("IDEController"))
4257 )
4258 {
4259 StorageController sctl;
4260 sctl.strName = "IDE Controller";
4261 sctl.storageBus = StorageBus_IDE;
4262
4263 Utf8Str strType;
4264 if (pelmBIOSChild->getAttributeValue("type", strType))
4265 {
4266 if (strType == "PIIX3")
4267 sctl.controllerType = StorageControllerType_PIIX3;
4268 else if (strType == "PIIX4")
4269 sctl.controllerType = StorageControllerType_PIIX4;
4270 else if (strType == "ICH6")
4271 sctl.controllerType = StorageControllerType_ICH6;
4272 else
4273 throw ConfigFileError(this, pelmBIOSChild, N_("Invalid value '%s' for IDEController/@type attribute"), strType.c_str());
4274 }
4275 sctl.ulPortCount = 2;
4276 hw.storage.llStorageControllers.push_back(sctl);
4277 }
4278 }
4279 else if ( (m->sv <= SettingsVersion_v1_14)
4280 && pelmHwChild->nameEquals("USBController"))
4281 {
4282 bool fEnabled = false;
4283
4284 pelmHwChild->getAttributeValue("enabled", fEnabled);
4285 if (fEnabled)
4286 {
4287 /* Create OHCI controller with default name. */
4288 USBController ctrl;
4289
4290 ctrl.strName = "OHCI";
4291 ctrl.enmType = USBControllerType_OHCI;
4292 hw.usbSettings.llUSBControllers.push_back(ctrl);
4293 }
4294
4295 pelmHwChild->getAttributeValue("enabledEhci", fEnabled);
4296 if (fEnabled)
4297 {
4298 /* Create OHCI controller with default name. */
4299 USBController ctrl;
4300
4301 ctrl.strName = "EHCI";
4302 ctrl.enmType = USBControllerType_EHCI;
4303 hw.usbSettings.llUSBControllers.push_back(ctrl);
4304 }
4305
4306 readUSBDeviceFilters(*pelmHwChild,
4307 hw.usbSettings.llDeviceFilters);
4308 }
4309 else if (pelmHwChild->nameEquals("USB"))
4310 {
4311 const xml::ElementNode *pelmUSBChild;
4312
4313 if ((pelmUSBChild = pelmHwChild->findChildElement("Controllers")))
4314 {
4315 xml::NodesLoop nl2(*pelmUSBChild, "Controller");
4316 const xml::ElementNode *pelmCtrl;
4317
4318 while ((pelmCtrl = nl2.forAllNodes()))
4319 {
4320 USBController ctrl;
4321 com::Utf8Str strCtrlType;
4322
4323 pelmCtrl->getAttributeValue("name", ctrl.strName);
4324
4325 if (pelmCtrl->getAttributeValue("type", strCtrlType))
4326 {
4327 if (strCtrlType == "OHCI")
4328 ctrl.enmType = USBControllerType_OHCI;
4329 else if (strCtrlType == "EHCI")
4330 ctrl.enmType = USBControllerType_EHCI;
4331 else if (strCtrlType == "XHCI")
4332 ctrl.enmType = USBControllerType_XHCI;
4333 else
4334 throw ConfigFileError(this, pelmCtrl, N_("Invalid value '%s' for Controller/@type attribute"), strCtrlType.c_str());
4335 }
4336
4337 hw.usbSettings.llUSBControllers.push_back(ctrl);
4338 }
4339 }
4340
4341 if ((pelmUSBChild = pelmHwChild->findChildElement("DeviceFilters")))
4342 readUSBDeviceFilters(*pelmUSBChild, hw.usbSettings.llDeviceFilters);
4343 }
4344 else if ( m->sv < SettingsVersion_v1_7
4345 && pelmHwChild->nameEquals("SATAController"))
4346 {
4347 bool f;
4348 if ( pelmHwChild->getAttributeValue("enabled", f)
4349 && f)
4350 {
4351 StorageController sctl;
4352 sctl.strName = "SATA Controller";
4353 sctl.storageBus = StorageBus_SATA;
4354 sctl.controllerType = StorageControllerType_IntelAhci;
4355
4356 readStorageControllerAttributes(*pelmHwChild, sctl);
4357
4358 hw.storage.llStorageControllers.push_back(sctl);
4359 }
4360 }
4361 else if (pelmHwChild->nameEquals("Network"))
4362 readNetworkAdapters(*pelmHwChild, hw.llNetworkAdapters);
4363 else if (pelmHwChild->nameEquals("RTC"))
4364 {
4365 Utf8Str strLocalOrUTC;
4366 machineUserData.fRTCUseUTC = pelmHwChild->getAttributeValue("localOrUTC", strLocalOrUTC)
4367 && strLocalOrUTC == "UTC";
4368 }
4369 else if ( pelmHwChild->nameEquals("UART")
4370 || pelmHwChild->nameEquals("Uart") // used before 1.3
4371 )
4372 readSerialPorts(*pelmHwChild, hw.llSerialPorts);
4373 else if ( pelmHwChild->nameEquals("LPT")
4374 || pelmHwChild->nameEquals("Lpt") // used before 1.3
4375 )
4376 readParallelPorts(*pelmHwChild, hw.llParallelPorts);
4377 else if (pelmHwChild->nameEquals("AudioAdapter"))
4378 readAudioAdapter(*pelmHwChild, hw.audioAdapter);
4379 else if (pelmHwChild->nameEquals("SharedFolders"))
4380 {
4381 xml::NodesLoop nl2(*pelmHwChild, "SharedFolder");
4382 const xml::ElementNode *pelmFolder;
4383 while ((pelmFolder = nl2.forAllNodes()))
4384 {
4385 SharedFolder sf;
4386 pelmFolder->getAttributeValue("name", sf.strName);
4387 pelmFolder->getAttributeValue("hostPath", sf.strHostPath);
4388 pelmFolder->getAttributeValue("writable", sf.fWritable);
4389 pelmFolder->getAttributeValue("autoMount", sf.fAutoMount);
4390 hw.llSharedFolders.push_back(sf);
4391 }
4392 }
4393 else if (pelmHwChild->nameEquals("Clipboard"))
4394 {
4395 Utf8Str strTemp;
4396 if (pelmHwChild->getAttributeValue("mode", strTemp))
4397 {
4398 if (strTemp == "Disabled")
4399 hw.clipboardMode = ClipboardMode_Disabled;
4400 else if (strTemp == "HostToGuest")
4401 hw.clipboardMode = ClipboardMode_HostToGuest;
4402 else if (strTemp == "GuestToHost")
4403 hw.clipboardMode = ClipboardMode_GuestToHost;
4404 else if (strTemp == "Bidirectional")
4405 hw.clipboardMode = ClipboardMode_Bidirectional;
4406 else
4407 throw ConfigFileError(this, pelmHwChild, N_("Invalid value '%s' in Clipboard/@mode attribute"), strTemp.c_str());
4408 }
4409 }
4410 else if (pelmHwChild->nameEquals("DragAndDrop"))
4411 {
4412 Utf8Str strTemp;
4413 if (pelmHwChild->getAttributeValue("mode", strTemp))
4414 {
4415 if (strTemp == "Disabled")
4416 hw.dndMode = DnDMode_Disabled;
4417 else if (strTemp == "HostToGuest")
4418 hw.dndMode = DnDMode_HostToGuest;
4419 else if (strTemp == "GuestToHost")
4420 hw.dndMode = DnDMode_GuestToHost;
4421 else if (strTemp == "Bidirectional")
4422 hw.dndMode = DnDMode_Bidirectional;
4423 else
4424 throw ConfigFileError(this, pelmHwChild, N_("Invalid value '%s' in DragAndDrop/@mode attribute"), strTemp.c_str());
4425 }
4426 }
4427 else if (pelmHwChild->nameEquals("Guest"))
4428 {
4429 if (!pelmHwChild->getAttributeValue("memoryBalloonSize", hw.ulMemoryBalloonSize))
4430 pelmHwChild->getAttributeValue("MemoryBalloonSize", hw.ulMemoryBalloonSize); // used before 1.3
4431 }
4432 else if (pelmHwChild->nameEquals("GuestProperties"))
4433 readGuestProperties(*pelmHwChild, hw);
4434 else if (pelmHwChild->nameEquals("IO"))
4435 {
4436 const xml::ElementNode *pelmBwGroups;
4437 const xml::ElementNode *pelmIOChild;
4438
4439 if ((pelmIOChild = pelmHwChild->findChildElement("IoCache")))
4440 {
4441 pelmIOChild->getAttributeValue("enabled", hw.ioSettings.fIOCacheEnabled);
4442 pelmIOChild->getAttributeValue("size", hw.ioSettings.ulIOCacheSize);
4443 }
4444
4445 if ((pelmBwGroups = pelmHwChild->findChildElement("BandwidthGroups")))
4446 {
4447 xml::NodesLoop nl2(*pelmBwGroups, "BandwidthGroup");
4448 const xml::ElementNode *pelmBandwidthGroup;
4449 while ((pelmBandwidthGroup = nl2.forAllNodes()))
4450 {
4451 BandwidthGroup gr;
4452 Utf8Str strTemp;
4453
4454 pelmBandwidthGroup->getAttributeValue("name", gr.strName);
4455
4456 if (pelmBandwidthGroup->getAttributeValue("type", strTemp))
4457 {
4458 if (strTemp == "Disk")
4459 gr.enmType = BandwidthGroupType_Disk;
4460 else if (strTemp == "Network")
4461 gr.enmType = BandwidthGroupType_Network;
4462 else
4463 throw ConfigFileError(this, pelmBandwidthGroup, N_("Invalid value '%s' in BandwidthGroup/@type attribute"), strTemp.c_str());
4464 }
4465 else
4466 throw ConfigFileError(this, pelmBandwidthGroup, N_("Missing BandwidthGroup/@type attribute"));
4467
4468 if (!pelmBandwidthGroup->getAttributeValue("maxBytesPerSec", gr.cMaxBytesPerSec))
4469 {
4470 pelmBandwidthGroup->getAttributeValue("maxMbPerSec", gr.cMaxBytesPerSec);
4471 gr.cMaxBytesPerSec *= _1M;
4472 }
4473 hw.ioSettings.llBandwidthGroups.push_back(gr);
4474 }
4475 }
4476 }
4477 else if (pelmHwChild->nameEquals("HostPci"))
4478 {
4479 const xml::ElementNode *pelmDevices;
4480
4481 if ((pelmDevices = pelmHwChild->findChildElement("Devices")))
4482 {
4483 xml::NodesLoop nl2(*pelmDevices, "Device");
4484 const xml::ElementNode *pelmDevice;
4485 while ((pelmDevice = nl2.forAllNodes()))
4486 {
4487 HostPCIDeviceAttachment hpda;
4488
4489 if (!pelmDevice->getAttributeValue("host", hpda.uHostAddress))
4490 throw ConfigFileError(this, pelmDevice, N_("Missing Device/@host attribute"));
4491
4492 if (!pelmDevice->getAttributeValue("guest", hpda.uGuestAddress))
4493 throw ConfigFileError(this, pelmDevice, N_("Missing Device/@guest attribute"));
4494
4495 /* name is optional */
4496 pelmDevice->getAttributeValue("name", hpda.strDeviceName);
4497
4498 hw.pciAttachments.push_back(hpda);
4499 }
4500 }
4501 }
4502 else if (pelmHwChild->nameEquals("EmulatedUSB"))
4503 {
4504 const xml::ElementNode *pelmCardReader;
4505
4506 if ((pelmCardReader = pelmHwChild->findChildElement("CardReader")))
4507 {
4508 pelmCardReader->getAttributeValue("enabled", hw.fEmulatedUSBCardReader);
4509 }
4510 }
4511 else if (pelmHwChild->nameEquals("Frontend"))
4512 {
4513 const xml::ElementNode *pelmDefault;
4514
4515 if ((pelmDefault = pelmHwChild->findChildElement("Default")))
4516 {
4517 pelmDefault->getAttributeValue("type", hw.strDefaultFrontend);
4518 }
4519 }
4520 else if (pelmHwChild->nameEquals("StorageControllers"))
4521 readStorageControllers(*pelmHwChild, hw.storage);
4522 }
4523
4524 if (hw.ulMemorySizeMB == (uint32_t)-1)
4525 throw ConfigFileError(this, &elmHardware, N_("Required Memory/@RAMSize element/attribute is missing"));
4526}
4527
4528/**
4529 * This gets called instead of readStorageControllers() for legacy pre-1.7 settings
4530 * files which have a \<HardDiskAttachments\> node and storage controller settings
4531 * hidden in the \<Hardware\> settings. We set the StorageControllers fields just the
4532 * same, just from different sources.
4533 * @param elmHardDiskAttachments \<HardDiskAttachments\> XML node.
4534 * @param strg
4535 */
4536void MachineConfigFile::readHardDiskAttachments_pre1_7(const xml::ElementNode &elmHardDiskAttachments,
4537 Storage &strg)
4538{
4539 StorageController *pIDEController = NULL;
4540 StorageController *pSATAController = NULL;
4541
4542 for (StorageControllersList::iterator it = strg.llStorageControllers.begin();
4543 it != strg.llStorageControllers.end();
4544 ++it)
4545 {
4546 StorageController &s = *it;
4547 if (s.storageBus == StorageBus_IDE)
4548 pIDEController = &s;
4549 else if (s.storageBus == StorageBus_SATA)
4550 pSATAController = &s;
4551 }
4552
4553 xml::NodesLoop nl1(elmHardDiskAttachments, "HardDiskAttachment");
4554 const xml::ElementNode *pelmAttachment;
4555 while ((pelmAttachment = nl1.forAllNodes()))
4556 {
4557 AttachedDevice att;
4558 Utf8Str strUUID, strBus;
4559
4560 if (!pelmAttachment->getAttributeValue("hardDisk", strUUID))
4561 throw ConfigFileError(this, pelmAttachment, N_("Required HardDiskAttachment/@hardDisk attribute is missing"));
4562 parseUUID(att.uuid, strUUID, pelmAttachment);
4563
4564 if (!pelmAttachment->getAttributeValue("bus", strBus))
4565 throw ConfigFileError(this, pelmAttachment, N_("Required HardDiskAttachment/@bus attribute is missing"));
4566 // pre-1.7 'channel' is now port
4567 if (!pelmAttachment->getAttributeValue("channel", att.lPort))
4568 throw ConfigFileError(this, pelmAttachment, N_("Required HardDiskAttachment/@channel attribute is missing"));
4569 // pre-1.7 'device' is still device
4570 if (!pelmAttachment->getAttributeValue("device", att.lDevice))
4571 throw ConfigFileError(this, pelmAttachment, N_("Required HardDiskAttachment/@device attribute is missing"));
4572
4573 att.deviceType = DeviceType_HardDisk;
4574
4575 if (strBus == "IDE")
4576 {
4577 if (!pIDEController)
4578 throw ConfigFileError(this, pelmAttachment, N_("HardDiskAttachment/@bus is 'IDE' but cannot find IDE controller"));
4579 pIDEController->llAttachedDevices.push_back(att);
4580 }
4581 else if (strBus == "SATA")
4582 {
4583 if (!pSATAController)
4584 throw ConfigFileError(this, pelmAttachment, N_("HardDiskAttachment/@bus is 'SATA' but cannot find SATA controller"));
4585 pSATAController->llAttachedDevices.push_back(att);
4586 }
4587 else
4588 throw ConfigFileError(this, pelmAttachment, N_("HardDiskAttachment/@bus attribute has illegal value '%s'"), strBus.c_str());
4589 }
4590}
4591
4592/**
4593 * Reads in a \<StorageControllers\> block and stores it in the given Storage structure.
4594 * Used both directly from readMachine and from readSnapshot, since snapshots
4595 * have their own storage controllers sections.
4596 *
4597 * This is only called for settings version 1.7 and above; see readHardDiskAttachments_pre1_7()
4598 * for earlier versions.
4599 *
4600 * @param elmStorageControllers
4601 * @param strg
4602 */
4603void MachineConfigFile::readStorageControllers(const xml::ElementNode &elmStorageControllers,
4604 Storage &strg)
4605{
4606 xml::NodesLoop nlStorageControllers(elmStorageControllers, "StorageController");
4607 const xml::ElementNode *pelmController;
4608 while ((pelmController = nlStorageControllers.forAllNodes()))
4609 {
4610 StorageController sctl;
4611
4612 if (!pelmController->getAttributeValue("name", sctl.strName))
4613 throw ConfigFileError(this, pelmController, N_("Required StorageController/@name attribute is missing"));
4614 // canonicalize storage controller names for configs in the switchover
4615 // period.
4616 if (m->sv < SettingsVersion_v1_9)
4617 {
4618 if (sctl.strName == "IDE")
4619 sctl.strName = "IDE Controller";
4620 else if (sctl.strName == "SATA")
4621 sctl.strName = "SATA Controller";
4622 else if (sctl.strName == "SCSI")
4623 sctl.strName = "SCSI Controller";
4624 }
4625
4626 pelmController->getAttributeValue("Instance", sctl.ulInstance);
4627 // default from constructor is 0
4628
4629 pelmController->getAttributeValue("Bootable", sctl.fBootable);
4630 // default from constructor is true which is true
4631 // for settings below version 1.11 because they allowed only
4632 // one controller per type.
4633
4634 Utf8Str strType;
4635 if (!pelmController->getAttributeValue("type", strType))
4636 throw ConfigFileError(this, pelmController, N_("Required StorageController/@type attribute is missing"));
4637
4638 if (strType == "AHCI")
4639 {
4640 sctl.storageBus = StorageBus_SATA;
4641 sctl.controllerType = StorageControllerType_IntelAhci;
4642 }
4643 else if (strType == "LsiLogic")
4644 {
4645 sctl.storageBus = StorageBus_SCSI;
4646 sctl.controllerType = StorageControllerType_LsiLogic;
4647 }
4648 else if (strType == "BusLogic")
4649 {
4650 sctl.storageBus = StorageBus_SCSI;
4651 sctl.controllerType = StorageControllerType_BusLogic;
4652 }
4653 else if (strType == "PIIX3")
4654 {
4655 sctl.storageBus = StorageBus_IDE;
4656 sctl.controllerType = StorageControllerType_PIIX3;
4657 }
4658 else if (strType == "PIIX4")
4659 {
4660 sctl.storageBus = StorageBus_IDE;
4661 sctl.controllerType = StorageControllerType_PIIX4;
4662 }
4663 else if (strType == "ICH6")
4664 {
4665 sctl.storageBus = StorageBus_IDE;
4666 sctl.controllerType = StorageControllerType_ICH6;
4667 }
4668 else if ( (m->sv >= SettingsVersion_v1_9)
4669 && (strType == "I82078")
4670 )
4671 {
4672 sctl.storageBus = StorageBus_Floppy;
4673 sctl.controllerType = StorageControllerType_I82078;
4674 }
4675 else if (strType == "LsiLogicSas")
4676 {
4677 sctl.storageBus = StorageBus_SAS;
4678 sctl.controllerType = StorageControllerType_LsiLogicSas;
4679 }
4680 else if (strType == "USB")
4681 {
4682 sctl.storageBus = StorageBus_USB;
4683 sctl.controllerType = StorageControllerType_USB;
4684 }
4685 else if (strType == "NVMe")
4686 {
4687 sctl.storageBus = StorageBus_PCIe;
4688 sctl.controllerType = StorageControllerType_NVMe;
4689 }
4690 else
4691 throw ConfigFileError(this, pelmController, N_("Invalid value '%s' for StorageController/@type attribute"), strType.c_str());
4692
4693 readStorageControllerAttributes(*pelmController, sctl);
4694
4695 xml::NodesLoop nlAttached(*pelmController, "AttachedDevice");
4696 const xml::ElementNode *pelmAttached;
4697 while ((pelmAttached = nlAttached.forAllNodes()))
4698 {
4699 AttachedDevice att;
4700 Utf8Str strTemp;
4701 pelmAttached->getAttributeValue("type", strTemp);
4702
4703 att.fDiscard = false;
4704 att.fNonRotational = false;
4705 att.fHotPluggable = false;
4706
4707 if (strTemp == "HardDisk")
4708 {
4709 att.deviceType = DeviceType_HardDisk;
4710 pelmAttached->getAttributeValue("nonrotational", att.fNonRotational);
4711 pelmAttached->getAttributeValue("discard", att.fDiscard);
4712 }
4713 else if (m->sv >= SettingsVersion_v1_9)
4714 {
4715 // starting with 1.9 we list DVD and floppy drive info + attachments under <StorageControllers>
4716 if (strTemp == "DVD")
4717 {
4718 att.deviceType = DeviceType_DVD;
4719 pelmAttached->getAttributeValue("passthrough", att.fPassThrough);
4720 pelmAttached->getAttributeValue("tempeject", att.fTempEject);
4721 }
4722 else if (strTemp == "Floppy")
4723 att.deviceType = DeviceType_Floppy;
4724 }
4725
4726 if (att.deviceType != DeviceType_Null)
4727 {
4728 const xml::ElementNode *pelmImage;
4729 // all types can have images attached, but for HardDisk it's required
4730 if (!(pelmImage = pelmAttached->findChildElement("Image")))
4731 {
4732 if (att.deviceType == DeviceType_HardDisk)
4733 throw ConfigFileError(this, pelmImage, N_("Required AttachedDevice/Image element is missing"));
4734 else
4735 {
4736 // DVDs and floppies can also have <HostDrive> instead of <Image>
4737 const xml::ElementNode *pelmHostDrive;
4738 if ((pelmHostDrive = pelmAttached->findChildElement("HostDrive")))
4739 if (!pelmHostDrive->getAttributeValue("src", att.strHostDriveSrc))
4740 throw ConfigFileError(this, pelmHostDrive, N_("Required AttachedDevice/HostDrive/@src attribute is missing"));
4741 }
4742 }
4743 else
4744 {
4745 if (!pelmImage->getAttributeValue("uuid", strTemp))
4746 throw ConfigFileError(this, pelmImage, N_("Required AttachedDevice/Image/@uuid attribute is missing"));
4747 parseUUID(att.uuid, strTemp, pelmImage);
4748 }
4749
4750 if (!pelmAttached->getAttributeValue("port", att.lPort))
4751 throw ConfigFileError(this, pelmImage, N_("Required AttachedDevice/@port attribute is missing"));
4752 if (!pelmAttached->getAttributeValue("device", att.lDevice))
4753 throw ConfigFileError(this, pelmImage, N_("Required AttachedDevice/@device attribute is missing"));
4754
4755 /* AHCI controller ports are hotpluggable by default, keep compatibility with existing settings. */
4756 if (m->sv >= SettingsVersion_v1_15)
4757 pelmAttached->getAttributeValue("hotpluggable", att.fHotPluggable);
4758 else if (sctl.controllerType == StorageControllerType_IntelAhci)
4759 att.fHotPluggable = true;
4760
4761 pelmAttached->getAttributeValue("bandwidthGroup", att.strBwGroup);
4762 sctl.llAttachedDevices.push_back(att);
4763 }
4764 }
4765
4766 strg.llStorageControllers.push_back(sctl);
4767 }
4768}
4769
4770/**
4771 * This gets called for legacy pre-1.9 settings files after having parsed the
4772 * \<Hardware\> and \<StorageControllers\> sections to parse \<Hardware\> once more
4773 * for the \<DVDDrive\> and \<FloppyDrive\> sections.
4774 *
4775 * Before settings version 1.9, DVD and floppy drives were specified separately
4776 * under \<Hardware\>; we then need this extra loop to make sure the storage
4777 * controller structs are already set up so we can add stuff to them.
4778 *
4779 * @param elmHardware
4780 * @param strg
4781 */
4782void MachineConfigFile::readDVDAndFloppies_pre1_9(const xml::ElementNode &elmHardware,
4783 Storage &strg)
4784{
4785 xml::NodesLoop nl1(elmHardware);
4786 const xml::ElementNode *pelmHwChild;
4787 while ((pelmHwChild = nl1.forAllNodes()))
4788 {
4789 if (pelmHwChild->nameEquals("DVDDrive"))
4790 {
4791 // create a DVD "attached device" and attach it to the existing IDE controller
4792 AttachedDevice att;
4793 att.deviceType = DeviceType_DVD;
4794 // legacy DVD drive is always secondary master (port 1, device 0)
4795 att.lPort = 1;
4796 att.lDevice = 0;
4797 pelmHwChild->getAttributeValue("passthrough", att.fPassThrough);
4798 pelmHwChild->getAttributeValue("tempeject", att.fTempEject);
4799
4800 const xml::ElementNode *pDriveChild;
4801 Utf8Str strTmp;
4802 if ( (pDriveChild = pelmHwChild->findChildElement("Image")) != NULL
4803 && pDriveChild->getAttributeValue("uuid", strTmp))
4804 parseUUID(att.uuid, strTmp, pDriveChild);
4805 else if ((pDriveChild = pelmHwChild->findChildElement("HostDrive")))
4806 pDriveChild->getAttributeValue("src", att.strHostDriveSrc);
4807
4808 // find the IDE controller and attach the DVD drive
4809 bool fFound = false;
4810 for (StorageControllersList::iterator it = strg.llStorageControllers.begin();
4811 it != strg.llStorageControllers.end();
4812 ++it)
4813 {
4814 StorageController &sctl = *it;
4815 if (sctl.storageBus == StorageBus_IDE)
4816 {
4817 sctl.llAttachedDevices.push_back(att);
4818 fFound = true;
4819 break;
4820 }
4821 }
4822
4823 if (!fFound)
4824 throw ConfigFileError(this, pelmHwChild, N_("Internal error: found DVD drive but IDE controller does not exist"));
4825 // shouldn't happen because pre-1.9 settings files always had at least one IDE controller in the settings
4826 // which should have gotten parsed in <StorageControllers> before this got called
4827 }
4828 else if (pelmHwChild->nameEquals("FloppyDrive"))
4829 {
4830 bool fEnabled;
4831 if ( pelmHwChild->getAttributeValue("enabled", fEnabled)
4832 && fEnabled)
4833 {
4834 // create a new floppy controller and attach a floppy "attached device"
4835 StorageController sctl;
4836 sctl.strName = "Floppy Controller";
4837 sctl.storageBus = StorageBus_Floppy;
4838 sctl.controllerType = StorageControllerType_I82078;
4839 sctl.ulPortCount = 1;
4840
4841 AttachedDevice att;
4842 att.deviceType = DeviceType_Floppy;
4843 att.lPort = 0;
4844 att.lDevice = 0;
4845
4846 const xml::ElementNode *pDriveChild;
4847 Utf8Str strTmp;
4848 if ( (pDriveChild = pelmHwChild->findChildElement("Image"))
4849 && pDriveChild->getAttributeValue("uuid", strTmp) )
4850 parseUUID(att.uuid, strTmp, pDriveChild);
4851 else if ((pDriveChild = pelmHwChild->findChildElement("HostDrive")))
4852 pDriveChild->getAttributeValue("src", att.strHostDriveSrc);
4853
4854 // store attachment with controller
4855 sctl.llAttachedDevices.push_back(att);
4856 // store controller with storage
4857 strg.llStorageControllers.push_back(sctl);
4858 }
4859 }
4860 }
4861}
4862
4863/**
4864 * Called for reading the \<Teleporter\> element under \<Machine\>.
4865 */
4866void MachineConfigFile::readTeleporter(const xml::ElementNode *pElmTeleporter,
4867 MachineUserData *pUserData)
4868{
4869 pElmTeleporter->getAttributeValue("enabled", pUserData->fTeleporterEnabled);
4870 pElmTeleporter->getAttributeValue("port", pUserData->uTeleporterPort);
4871 pElmTeleporter->getAttributeValue("address", pUserData->strTeleporterAddress);
4872 pElmTeleporter->getAttributeValue("password", pUserData->strTeleporterPassword);
4873
4874 if ( pUserData->strTeleporterPassword.isNotEmpty()
4875 && !VBoxIsPasswordHashed(&pUserData->strTeleporterPassword))
4876 VBoxHashPassword(&pUserData->strTeleporterPassword);
4877}
4878
4879/**
4880 * Called for reading the \<Debugging\> element under \<Machine\> or \<Snapshot\>.
4881 */
4882void MachineConfigFile::readDebugging(const xml::ElementNode *pElmDebugging, Debugging *pDbg)
4883{
4884 if (!pElmDebugging || m->sv < SettingsVersion_v1_13)
4885 return;
4886
4887 const xml::ElementNode * const pelmTracing = pElmDebugging->findChildElement("Tracing");
4888 if (pelmTracing)
4889 {
4890 pelmTracing->getAttributeValue("enabled", pDbg->fTracingEnabled);
4891 pelmTracing->getAttributeValue("allowTracingToAccessVM", pDbg->fAllowTracingToAccessVM);
4892 pelmTracing->getAttributeValue("config", pDbg->strTracingConfig);
4893 }
4894}
4895
4896/**
4897 * Called for reading the \<Autostart\> element under \<Machine\> or \<Snapshot\>.
4898 */
4899void MachineConfigFile::readAutostart(const xml::ElementNode *pElmAutostart, Autostart *pAutostart)
4900{
4901 Utf8Str strAutostop;
4902
4903 if (!pElmAutostart || m->sv < SettingsVersion_v1_13)
4904 return;
4905
4906 pElmAutostart->getAttributeValue("enabled", pAutostart->fAutostartEnabled);
4907 pElmAutostart->getAttributeValue("delay", pAutostart->uAutostartDelay);
4908 pElmAutostart->getAttributeValue("autostop", strAutostop);
4909 if (strAutostop == "Disabled")
4910 pAutostart->enmAutostopType = AutostopType_Disabled;
4911 else if (strAutostop == "SaveState")
4912 pAutostart->enmAutostopType = AutostopType_SaveState;
4913 else if (strAutostop == "PowerOff")
4914 pAutostart->enmAutostopType = AutostopType_PowerOff;
4915 else if (strAutostop == "AcpiShutdown")
4916 pAutostart->enmAutostopType = AutostopType_AcpiShutdown;
4917 else
4918 throw ConfigFileError(this, pElmAutostart, N_("Invalid value '%s' for Autostart/@autostop attribute"), strAutostop.c_str());
4919}
4920
4921/**
4922 * Called for reading the \<Groups\> element under \<Machine\>.
4923 */
4924void MachineConfigFile::readGroups(const xml::ElementNode *pElmGroups, StringsList *pllGroups)
4925{
4926 pllGroups->clear();
4927 if (!pElmGroups || m->sv < SettingsVersion_v1_13)
4928 {
4929 pllGroups->push_back("/");
4930 return;
4931 }
4932
4933 xml::NodesLoop nlGroups(*pElmGroups);
4934 const xml::ElementNode *pelmGroup;
4935 while ((pelmGroup = nlGroups.forAllNodes()))
4936 {
4937 if (pelmGroup->nameEquals("Group"))
4938 {
4939 Utf8Str strGroup;
4940 if (!pelmGroup->getAttributeValue("name", strGroup))
4941 throw ConfigFileError(this, pelmGroup, N_("Required Group/@name attribute is missing"));
4942 pllGroups->push_back(strGroup);
4943 }
4944 }
4945}
4946
4947/**
4948 * Called initially for the \<Snapshot\> element under \<Machine\>, if present,
4949 * to store the snapshot's data into the given Snapshot structure (which is
4950 * then the one in the Machine struct). This might then recurse if
4951 * a \<Snapshots\> (plural) element is found in the snapshot, which should
4952 * contain a list of child snapshots; such lists are maintained in the
4953 * Snapshot structure.
4954 *
4955 * @param curSnapshotUuid
4956 * @param depth
4957 * @param elmSnapshot
4958 * @param snap
4959 * @returns true if curSnapshotUuid is in this snapshot subtree, otherwise false
4960 */
4961bool MachineConfigFile::readSnapshot(const Guid &curSnapshotUuid,
4962 uint32_t depth,
4963 const xml::ElementNode &elmSnapshot,
4964 Snapshot &snap)
4965{
4966 if (depth > SETTINGS_SNAPSHOT_DEPTH_MAX)
4967 throw ConfigFileError(this, &elmSnapshot, N_("Maximum snapshot tree depth of %u exceeded"), SETTINGS_SNAPSHOT_DEPTH_MAX);
4968
4969 Utf8Str strTemp;
4970
4971 if (!elmSnapshot.getAttributeValue("uuid", strTemp))
4972 throw ConfigFileError(this, &elmSnapshot, N_("Required Snapshot/@uuid attribute is missing"));
4973 parseUUID(snap.uuid, strTemp, &elmSnapshot);
4974 bool foundCurrentSnapshot = (snap.uuid == curSnapshotUuid);
4975
4976 if (!elmSnapshot.getAttributeValue("name", snap.strName))
4977 throw ConfigFileError(this, &elmSnapshot, N_("Required Snapshot/@name attribute is missing"));
4978
4979 // 3.1 dev builds added Description as an attribute, read it silently
4980 // and write it back as an element
4981 elmSnapshot.getAttributeValue("Description", snap.strDescription);
4982
4983 if (!elmSnapshot.getAttributeValue("timeStamp", strTemp))
4984 throw ConfigFileError(this, &elmSnapshot, N_("Required Snapshot/@timeStamp attribute is missing"));
4985 parseTimestamp(snap.timestamp, strTemp, &elmSnapshot);
4986
4987 elmSnapshot.getAttributeValuePath("stateFile", snap.strStateFile); // online snapshots only
4988
4989 // parse Hardware before the other elements because other things depend on it
4990 const xml::ElementNode *pelmHardware;
4991 if (!(pelmHardware = elmSnapshot.findChildElement("Hardware")))
4992 throw ConfigFileError(this, &elmSnapshot, N_("Required Snapshot/@Hardware element is missing"));
4993 readHardware(*pelmHardware, snap.hardware);
4994
4995 xml::NodesLoop nlSnapshotChildren(elmSnapshot);
4996 const xml::ElementNode *pelmSnapshotChild;
4997 while ((pelmSnapshotChild = nlSnapshotChildren.forAllNodes()))
4998 {
4999 if (pelmSnapshotChild->nameEquals("Description"))
5000 snap.strDescription = pelmSnapshotChild->getValue();
5001 else if ( m->sv < SettingsVersion_v1_7
5002 && pelmSnapshotChild->nameEquals("HardDiskAttachments"))
5003 readHardDiskAttachments_pre1_7(*pelmSnapshotChild, snap.hardware.storage);
5004 else if ( m->sv >= SettingsVersion_v1_7
5005 && pelmSnapshotChild->nameEquals("StorageControllers"))
5006 readStorageControllers(*pelmSnapshotChild, snap.hardware.storage);
5007 else if (pelmSnapshotChild->nameEquals("Snapshots"))
5008 {
5009 xml::NodesLoop nlChildSnapshots(*pelmSnapshotChild);
5010 const xml::ElementNode *pelmChildSnapshot;
5011 while ((pelmChildSnapshot = nlChildSnapshots.forAllNodes()))
5012 {
5013 if (pelmChildSnapshot->nameEquals("Snapshot"))
5014 {
5015 // recurse with this element and put the child at the
5016 // end of the list. XPCOM has very small stack, avoid
5017 // big local variables and use the list element.
5018 snap.llChildSnapshots.push_back(Snapshot::Empty);
5019 bool found = readSnapshot(curSnapshotUuid, depth + 1, *pelmChildSnapshot, snap.llChildSnapshots.back());
5020 foundCurrentSnapshot = foundCurrentSnapshot || found;
5021 }
5022 }
5023 }
5024 }
5025
5026 if (m->sv < SettingsVersion_v1_9)
5027 // go through Hardware once more to repair the settings controller structures
5028 // with data from old DVDDrive and FloppyDrive elements
5029 readDVDAndFloppies_pre1_9(*pelmHardware, snap.hardware.storage);
5030
5031 readDebugging(elmSnapshot.findChildElement("Debugging"), &snap.debugging);
5032 readAutostart(elmSnapshot.findChildElement("Autostart"), &snap.autostart);
5033 // note: Groups exist only for Machine, not for Snapshot
5034
5035 return foundCurrentSnapshot;
5036}
5037
5038const struct {
5039 const char *pcszOld;
5040 const char *pcszNew;
5041} aConvertOSTypes[] =
5042{
5043 { "unknown", "Other" },
5044 { "dos", "DOS" },
5045 { "win31", "Windows31" },
5046 { "win95", "Windows95" },
5047 { "win98", "Windows98" },
5048 { "winme", "WindowsMe" },
5049 { "winnt4", "WindowsNT4" },
5050 { "win2k", "Windows2000" },
5051 { "winxp", "WindowsXP" },
5052 { "win2k3", "Windows2003" },
5053 { "winvista", "WindowsVista" },
5054 { "win2k8", "Windows2008" },
5055 { "os2warp3", "OS2Warp3" },
5056 { "os2warp4", "OS2Warp4" },
5057 { "os2warp45", "OS2Warp45" },
5058 { "ecs", "OS2eCS" },
5059 { "linux22", "Linux22" },
5060 { "linux24", "Linux24" },
5061 { "linux26", "Linux26" },
5062 { "archlinux", "ArchLinux" },
5063 { "debian", "Debian" },
5064 { "opensuse", "OpenSUSE" },
5065 { "fedoracore", "Fedora" },
5066 { "gentoo", "Gentoo" },
5067 { "mandriva", "Mandriva" },
5068 { "redhat", "RedHat" },
5069 { "ubuntu", "Ubuntu" },
5070 { "xandros", "Xandros" },
5071 { "freebsd", "FreeBSD" },
5072 { "openbsd", "OpenBSD" },
5073 { "netbsd", "NetBSD" },
5074 { "netware", "Netware" },
5075 { "solaris", "Solaris" },
5076 { "opensolaris", "OpenSolaris" },
5077 { "l4", "L4" }
5078};
5079
5080void MachineConfigFile::convertOldOSType_pre1_5(Utf8Str &str)
5081{
5082 for (unsigned u = 0;
5083 u < RT_ELEMENTS(aConvertOSTypes);
5084 ++u)
5085 {
5086 if (str == aConvertOSTypes[u].pcszOld)
5087 {
5088 str = aConvertOSTypes[u].pcszNew;
5089 break;
5090 }
5091 }
5092}
5093
5094/**
5095 * Called from the constructor to actually read in the \<Machine\> element
5096 * of a machine config file.
5097 * @param elmMachine
5098 */
5099void MachineConfigFile::readMachine(const xml::ElementNode &elmMachine)
5100{
5101 Utf8Str strUUID;
5102 if ( elmMachine.getAttributeValue("uuid", strUUID)
5103 && elmMachine.getAttributeValue("name", machineUserData.strName))
5104 {
5105 parseUUID(uuid, strUUID, &elmMachine);
5106
5107 elmMachine.getAttributeValue("directoryIncludesUUID", machineUserData.fDirectoryIncludesUUID);
5108 elmMachine.getAttributeValue("nameSync", machineUserData.fNameSync);
5109
5110 Utf8Str str;
5111 elmMachine.getAttributeValue("Description", machineUserData.strDescription);
5112 elmMachine.getAttributeValue("OSType", machineUserData.strOsType);
5113 if (m->sv < SettingsVersion_v1_5)
5114 convertOldOSType_pre1_5(machineUserData.strOsType);
5115
5116 elmMachine.getAttributeValuePath("stateFile", strStateFile);
5117
5118 if (elmMachine.getAttributeValue("currentSnapshot", str))
5119 parseUUID(uuidCurrentSnapshot, str, &elmMachine);
5120
5121 elmMachine.getAttributeValuePath("snapshotFolder", machineUserData.strSnapshotFolder);
5122
5123 if (!elmMachine.getAttributeValue("currentStateModified", fCurrentStateModified))
5124 fCurrentStateModified = true;
5125 if (elmMachine.getAttributeValue("lastStateChange", str))
5126 parseTimestamp(timeLastStateChange, str, &elmMachine);
5127 // constructor has called RTTimeNow(&timeLastStateChange) before
5128 if (elmMachine.getAttributeValue("aborted", fAborted))
5129 fAborted = true;
5130
5131 elmMachine.getAttributeValue("processPriority", machineUserData.strVMPriority);
5132
5133 str.setNull();
5134 elmMachine.getAttributeValue("icon", str);
5135 parseBase64(machineUserData.ovIcon, str, &elmMachine);
5136
5137 // parse Hardware before the other elements because other things depend on it
5138 const xml::ElementNode *pelmHardware;
5139 if (!(pelmHardware = elmMachine.findChildElement("Hardware")))
5140 throw ConfigFileError(this, &elmMachine, N_("Required Machine/Hardware element is missing"));
5141 readHardware(*pelmHardware, hardwareMachine);
5142
5143 xml::NodesLoop nlRootChildren(elmMachine);
5144 const xml::ElementNode *pelmMachineChild;
5145 while ((pelmMachineChild = nlRootChildren.forAllNodes()))
5146 {
5147 if (pelmMachineChild->nameEquals("ExtraData"))
5148 readExtraData(*pelmMachineChild,
5149 mapExtraDataItems);
5150 else if ( (m->sv < SettingsVersion_v1_7)
5151 && (pelmMachineChild->nameEquals("HardDiskAttachments"))
5152 )
5153 readHardDiskAttachments_pre1_7(*pelmMachineChild, hardwareMachine.storage);
5154 else if ( (m->sv >= SettingsVersion_v1_7)
5155 && (pelmMachineChild->nameEquals("StorageControllers"))
5156 )
5157 readStorageControllers(*pelmMachineChild, hardwareMachine.storage);
5158 else if (pelmMachineChild->nameEquals("Snapshot"))
5159 {
5160 if (uuidCurrentSnapshot.isZero())
5161 throw ConfigFileError(this, &elmMachine, N_("Snapshots present but required Machine/@currentSnapshot attribute is missing"));
5162 bool foundCurrentSnapshot = false;
5163 Snapshot snap;
5164 // this will recurse into child snapshots, if necessary
5165 foundCurrentSnapshot = readSnapshot(uuidCurrentSnapshot, 1, *pelmMachineChild, snap);
5166 if (!foundCurrentSnapshot)
5167 throw ConfigFileError(this, &elmMachine, N_("Snapshots present but none matches the UUID in the Machine/@currentSnapshot attribute"));
5168 llFirstSnapshot.push_back(snap);
5169 }
5170 else if (pelmMachineChild->nameEquals("Description"))
5171 machineUserData.strDescription = pelmMachineChild->getValue();
5172 else if (pelmMachineChild->nameEquals("Teleporter"))
5173 readTeleporter(pelmMachineChild, &machineUserData);
5174 else if (pelmMachineChild->nameEquals("FaultTolerance"))
5175 {
5176 Utf8Str strFaultToleranceSate;
5177 if (pelmMachineChild->getAttributeValue("state", strFaultToleranceSate))
5178 {
5179 if (strFaultToleranceSate == "master")
5180 machineUserData.enmFaultToleranceState = FaultToleranceState_Master;
5181 else
5182 if (strFaultToleranceSate == "standby")
5183 machineUserData.enmFaultToleranceState = FaultToleranceState_Standby;
5184 else
5185 machineUserData.enmFaultToleranceState = FaultToleranceState_Inactive;
5186 }
5187 pelmMachineChild->getAttributeValue("port", machineUserData.uFaultTolerancePort);
5188 pelmMachineChild->getAttributeValue("address", machineUserData.strFaultToleranceAddress);
5189 pelmMachineChild->getAttributeValue("interval", machineUserData.uFaultToleranceInterval);
5190 pelmMachineChild->getAttributeValue("password", machineUserData.strFaultTolerancePassword);
5191 }
5192 else if (pelmMachineChild->nameEquals("MediaRegistry"))
5193 readMediaRegistry(*pelmMachineChild, mediaRegistry);
5194 else if (pelmMachineChild->nameEquals("Debugging"))
5195 readDebugging(pelmMachineChild, &debugging);
5196 else if (pelmMachineChild->nameEquals("Autostart"))
5197 readAutostart(pelmMachineChild, &autostart);
5198 else if (pelmMachineChild->nameEquals("Groups"))
5199 readGroups(pelmMachineChild, &machineUserData.llGroups);
5200 }
5201
5202 if (m->sv < SettingsVersion_v1_9)
5203 // go through Hardware once more to repair the settings controller structures
5204 // with data from old DVDDrive and FloppyDrive elements
5205 readDVDAndFloppies_pre1_9(*pelmHardware, hardwareMachine.storage);
5206 }
5207 else
5208 throw ConfigFileError(this, &elmMachine, N_("Required Machine/@uuid or @name attributes is missing"));
5209}
5210
5211/**
5212 * Creates a \<Hardware\> node under elmParent and then writes out the XML
5213 * keys under that. Called for both the \<Machine\> node and for snapshots.
5214 * @param elmParent
5215 * @param hw
5216 * @param fl
5217 * @param pllElementsWithUuidAttributes
5218 */
5219void MachineConfigFile::buildHardwareXML(xml::ElementNode &elmParent,
5220 const Hardware &hw,
5221 uint32_t fl,
5222 std::list<xml::ElementNode*> *pllElementsWithUuidAttributes)
5223{
5224 xml::ElementNode *pelmHardware = elmParent.createChild("Hardware");
5225
5226 if ( m->sv >= SettingsVersion_v1_4
5227 && (m->sv < SettingsVersion_v1_7 ? hw.strVersion != "1" : hw.strVersion != "2"))
5228 pelmHardware->setAttribute("version", hw.strVersion);
5229
5230 if ((m->sv >= SettingsVersion_v1_9)
5231 && !hw.uuid.isZero()
5232 && hw.uuid.isValid()
5233 )
5234 pelmHardware->setAttribute("uuid", hw.uuid.toStringCurly());
5235
5236 xml::ElementNode *pelmCPU = pelmHardware->createChild("CPU");
5237
5238 if (!hw.fHardwareVirt)
5239 pelmCPU->createChild("HardwareVirtEx")->setAttribute("enabled", hw.fHardwareVirt);
5240 if (!hw.fNestedPaging)
5241 pelmCPU->createChild("HardwareVirtExNestedPaging")->setAttribute("enabled", hw.fNestedPaging);
5242 if (!hw.fVPID)
5243 pelmCPU->createChild("HardwareVirtExVPID")->setAttribute("enabled", hw.fVPID);
5244 if (!hw.fUnrestrictedExecution)
5245 pelmCPU->createChild("HardwareVirtExUX")->setAttribute("enabled", hw.fUnrestrictedExecution);
5246 // PAE has too crazy default handling, must always save this setting.
5247 pelmCPU->createChild("PAE")->setAttribute("enabled", hw.fPAE);
5248 if (m->sv >= SettingsVersion_v1_16)
5249 {
5250 }
5251 if (m->sv >= SettingsVersion_v1_14 && hw.enmLongMode != Hardware::LongMode_Legacy)
5252 {
5253 // LongMode has too crazy default handling, must always save this setting.
5254 pelmCPU->createChild("LongMode")->setAttribute("enabled", hw.enmLongMode == Hardware::LongMode_Enabled);
5255 }
5256
5257 if (hw.fTripleFaultReset)
5258 pelmCPU->createChild("TripleFaultReset")->setAttribute("enabled", hw.fTripleFaultReset);
5259 if (m->sv >= SettingsVersion_v1_14)
5260 {
5261 if (hw.fX2APIC)
5262 pelmCPU->createChild("X2APIC")->setAttribute("enabled", hw.fX2APIC);
5263 else if (!hw.fAPIC)
5264 pelmCPU->createChild("APIC")->setAttribute("enabled", hw.fAPIC);
5265 }
5266 if (hw.cCPUs > 1)
5267 pelmCPU->setAttribute("count", hw.cCPUs);
5268 if (hw.ulCpuExecutionCap != 100)
5269 pelmCPU->setAttribute("executionCap", hw.ulCpuExecutionCap);
5270 if (hw.uCpuIdPortabilityLevel != 0)
5271 pelmCPU->setAttribute("CpuIdPortabilityLevel", hw.uCpuIdPortabilityLevel);
5272 if (!hw.strCpuProfile.equals("host") && hw.strCpuProfile.isNotEmpty())
5273 pelmCPU->setAttribute("CpuProfile", hw.strCpuProfile);
5274
5275 // HardwareVirtExLargePages has too crazy default handling, must always save this setting.
5276 pelmCPU->createChild("HardwareVirtExLargePages")->setAttribute("enabled", hw.fLargePages);
5277
5278 if (m->sv >= SettingsVersion_v1_9)
5279 {
5280 if (hw.fHardwareVirtForce)
5281 pelmCPU->createChild("HardwareVirtForce")->setAttribute("enabled", hw.fHardwareVirtForce);
5282 }
5283
5284 if (m->sv >= SettingsVersion_v1_10)
5285 {
5286 if (hw.fCpuHotPlug)
5287 pelmCPU->setAttribute("hotplug", hw.fCpuHotPlug);
5288
5289 xml::ElementNode *pelmCpuTree = NULL;
5290 for (CpuList::const_iterator it = hw.llCpus.begin();
5291 it != hw.llCpus.end();
5292 ++it)
5293 {
5294 const Cpu &cpu = *it;
5295
5296 if (pelmCpuTree == NULL)
5297 pelmCpuTree = pelmCPU->createChild("CpuTree");
5298
5299 xml::ElementNode *pelmCpu = pelmCpuTree->createChild("Cpu");
5300 pelmCpu->setAttribute("id", cpu.ulId);
5301 }
5302 }
5303
5304 xml::ElementNode *pelmCpuIdTree = NULL;
5305 for (CpuIdLeafsList::const_iterator it = hw.llCpuIdLeafs.begin();
5306 it != hw.llCpuIdLeafs.end();
5307 ++it)
5308 {
5309 const CpuIdLeaf &leaf = *it;
5310
5311 if (pelmCpuIdTree == NULL)
5312 pelmCpuIdTree = pelmCPU->createChild("CpuIdTree");
5313
5314 xml::ElementNode *pelmCpuIdLeaf = pelmCpuIdTree->createChild("CpuIdLeaf");
5315 pelmCpuIdLeaf->setAttribute("id", leaf.ulId);
5316 pelmCpuIdLeaf->setAttribute("eax", leaf.ulEax);
5317 pelmCpuIdLeaf->setAttribute("ebx", leaf.ulEbx);
5318 pelmCpuIdLeaf->setAttribute("ecx", leaf.ulEcx);
5319 pelmCpuIdLeaf->setAttribute("edx", leaf.ulEdx);
5320 }
5321
5322 xml::ElementNode *pelmMemory = pelmHardware->createChild("Memory");
5323 pelmMemory->setAttribute("RAMSize", hw.ulMemorySizeMB);
5324 if (m->sv >= SettingsVersion_v1_10)
5325 {
5326 if (hw.fPageFusionEnabled)
5327 pelmMemory->setAttribute("PageFusion", hw.fPageFusionEnabled);
5328 }
5329
5330 if ( (m->sv >= SettingsVersion_v1_9)
5331 && (hw.firmwareType >= FirmwareType_EFI)
5332 )
5333 {
5334 xml::ElementNode *pelmFirmware = pelmHardware->createChild("Firmware");
5335 const char *pcszFirmware;
5336
5337 switch (hw.firmwareType)
5338 {
5339 case FirmwareType_EFI: pcszFirmware = "EFI"; break;
5340 case FirmwareType_EFI32: pcszFirmware = "EFI32"; break;
5341 case FirmwareType_EFI64: pcszFirmware = "EFI64"; break;
5342 case FirmwareType_EFIDUAL: pcszFirmware = "EFIDUAL"; break;
5343 default: pcszFirmware = "None"; break;
5344 }
5345 pelmFirmware->setAttribute("type", pcszFirmware);
5346 }
5347
5348 if ( m->sv >= SettingsVersion_v1_10
5349 && ( hw.pointingHIDType != PointingHIDType_PS2Mouse
5350 || hw.keyboardHIDType != KeyboardHIDType_PS2Keyboard))
5351 {
5352 xml::ElementNode *pelmHID = pelmHardware->createChild("HID");
5353 const char *pcszHID;
5354
5355 if (hw.pointingHIDType != PointingHIDType_PS2Mouse)
5356 {
5357 switch (hw.pointingHIDType)
5358 {
5359 case PointingHIDType_USBMouse: pcszHID = "USBMouse"; break;
5360 case PointingHIDType_USBTablet: pcszHID = "USBTablet"; break;
5361 case PointingHIDType_PS2Mouse: pcszHID = "PS2Mouse"; break;
5362 case PointingHIDType_ComboMouse: pcszHID = "ComboMouse"; break;
5363 case PointingHIDType_USBMultiTouch: pcszHID = "USBMultiTouch";break;
5364 case PointingHIDType_None: pcszHID = "None"; break;
5365 default: Assert(false); pcszHID = "PS2Mouse"; break;
5366 }
5367 pelmHID->setAttribute("Pointing", pcszHID);
5368 }
5369
5370 if (hw.keyboardHIDType != KeyboardHIDType_PS2Keyboard)
5371 {
5372 switch (hw.keyboardHIDType)
5373 {
5374 case KeyboardHIDType_USBKeyboard: pcszHID = "USBKeyboard"; break;
5375 case KeyboardHIDType_PS2Keyboard: pcszHID = "PS2Keyboard"; break;
5376 case KeyboardHIDType_ComboKeyboard: pcszHID = "ComboKeyboard"; break;
5377 case KeyboardHIDType_None: pcszHID = "None"; break;
5378 default: Assert(false); pcszHID = "PS2Keyboard"; break;
5379 }
5380 pelmHID->setAttribute("Keyboard", pcszHID);
5381 }
5382 }
5383
5384 if ( (m->sv >= SettingsVersion_v1_10)
5385 && hw.fHPETEnabled
5386 )
5387 {
5388 xml::ElementNode *pelmHPET = pelmHardware->createChild("HPET");
5389 pelmHPET->setAttribute("enabled", hw.fHPETEnabled);
5390 }
5391
5392 if ( (m->sv >= SettingsVersion_v1_11)
5393 )
5394 {
5395 if (hw.chipsetType != ChipsetType_PIIX3)
5396 {
5397 xml::ElementNode *pelmChipset = pelmHardware->createChild("Chipset");
5398 const char *pcszChipset;
5399
5400 switch (hw.chipsetType)
5401 {
5402 case ChipsetType_PIIX3: pcszChipset = "PIIX3"; break;
5403 case ChipsetType_ICH9: pcszChipset = "ICH9"; break;
5404 default: Assert(false); pcszChipset = "PIIX3"; break;
5405 }
5406 pelmChipset->setAttribute("type", pcszChipset);
5407 }
5408 }
5409
5410 if ( (m->sv >= SettingsVersion_v1_15)
5411 && !hw.areParavirtDefaultSettings(m->sv)
5412 )
5413 {
5414 const char *pcszParavirtProvider;
5415 switch (hw.paravirtProvider)
5416 {
5417 case ParavirtProvider_None: pcszParavirtProvider = "None"; break;
5418 case ParavirtProvider_Default: pcszParavirtProvider = "Default"; break;
5419 case ParavirtProvider_Legacy: pcszParavirtProvider = "Legacy"; break;
5420 case ParavirtProvider_Minimal: pcszParavirtProvider = "Minimal"; break;
5421 case ParavirtProvider_HyperV: pcszParavirtProvider = "HyperV"; break;
5422 case ParavirtProvider_KVM: pcszParavirtProvider = "KVM"; break;
5423 default: Assert(false); pcszParavirtProvider = "None"; break;
5424 }
5425
5426 xml::ElementNode *pelmParavirt = pelmHardware->createChild("Paravirt");
5427 pelmParavirt->setAttribute("provider", pcszParavirtProvider);
5428
5429 if ( m->sv >= SettingsVersion_v1_16
5430 && hw.strParavirtDebug.isNotEmpty())
5431 pelmParavirt->setAttribute("debug", hw.strParavirtDebug);
5432 }
5433
5434 if (!hw.areBootOrderDefaultSettings())
5435 {
5436 xml::ElementNode *pelmBoot = pelmHardware->createChild("Boot");
5437 for (BootOrderMap::const_iterator it = hw.mapBootOrder.begin();
5438 it != hw.mapBootOrder.end();
5439 ++it)
5440 {
5441 uint32_t i = it->first;
5442 DeviceType_T type = it->second;
5443 const char *pcszDevice;
5444
5445 switch (type)
5446 {
5447 case DeviceType_Floppy: pcszDevice = "Floppy"; break;
5448 case DeviceType_DVD: pcszDevice = "DVD"; break;
5449 case DeviceType_HardDisk: pcszDevice = "HardDisk"; break;
5450 case DeviceType_Network: pcszDevice = "Network"; break;
5451 default: /*case DeviceType_Null:*/ pcszDevice = "None"; break;
5452 }
5453
5454 xml::ElementNode *pelmOrder = pelmBoot->createChild("Order");
5455 pelmOrder->setAttribute("position",
5456 i + 1); // XML is 1-based but internal data is 0-based
5457 pelmOrder->setAttribute("device", pcszDevice);
5458 }
5459 }
5460
5461 if (!hw.areDisplayDefaultSettings())
5462 {
5463 xml::ElementNode *pelmDisplay = pelmHardware->createChild("Display");
5464 if (hw.graphicsControllerType != GraphicsControllerType_VBoxVGA)
5465 {
5466 const char *pcszGraphics;
5467 switch (hw.graphicsControllerType)
5468 {
5469 case GraphicsControllerType_VBoxVGA: pcszGraphics = "VBoxVGA"; break;
5470 case GraphicsControllerType_VMSVGA: pcszGraphics = "VMSVGA"; break;
5471 default: /*case GraphicsControllerType_Null:*/ pcszGraphics = "None"; break;
5472 }
5473 pelmDisplay->setAttribute("controller", pcszGraphics);
5474 }
5475 if (hw.ulVRAMSizeMB != 8)
5476 pelmDisplay->setAttribute("VRAMSize", hw.ulVRAMSizeMB);
5477 if (hw.cMonitors > 1)
5478 pelmDisplay->setAttribute("monitorCount", hw.cMonitors);
5479 if (hw.fAccelerate3D)
5480 pelmDisplay->setAttribute("accelerate3D", hw.fAccelerate3D);
5481
5482 if (m->sv >= SettingsVersion_v1_8)
5483 {
5484 if (hw.fAccelerate2DVideo)
5485 pelmDisplay->setAttribute("accelerate2DVideo", hw.fAccelerate2DVideo);
5486 }
5487 }
5488
5489 if (m->sv >= SettingsVersion_v1_14 && !hw.areVideoCaptureDefaultSettings())
5490 {
5491 xml::ElementNode *pelmVideoCapture = pelmHardware->createChild("VideoCapture");
5492 if (hw.fVideoCaptureEnabled)
5493 pelmVideoCapture->setAttribute("enabled", hw.fVideoCaptureEnabled);
5494 if (hw.u64VideoCaptureScreens != UINT64_C(0xffffffffffffffff))
5495 pelmVideoCapture->setAttribute("screens", hw.u64VideoCaptureScreens);
5496 if (!hw.strVideoCaptureFile.isEmpty())
5497 pelmVideoCapture->setAttributePath("file", hw.strVideoCaptureFile);
5498 if (hw.ulVideoCaptureHorzRes != 1024 || hw.ulVideoCaptureVertRes != 768)
5499 {
5500 pelmVideoCapture->setAttribute("horzRes", hw.ulVideoCaptureHorzRes);
5501 pelmVideoCapture->setAttribute("vertRes", hw.ulVideoCaptureVertRes);
5502 }
5503 if (hw.ulVideoCaptureRate != 512)
5504 pelmVideoCapture->setAttribute("rate", hw.ulVideoCaptureRate);
5505 if (hw.ulVideoCaptureFPS)
5506 pelmVideoCapture->setAttribute("fps", hw.ulVideoCaptureFPS);
5507 if (hw.ulVideoCaptureMaxTime)
5508 pelmVideoCapture->setAttribute("maxTime", hw.ulVideoCaptureMaxTime);
5509 if (hw.ulVideoCaptureMaxSize)
5510 pelmVideoCapture->setAttribute("maxSize", hw.ulVideoCaptureMaxSize);
5511 }
5512
5513 if (!hw.vrdeSettings.areDefaultSettings(m->sv))
5514 {
5515 xml::ElementNode *pelmVRDE = pelmHardware->createChild("RemoteDisplay");
5516 if (m->sv < SettingsVersion_v1_16 ? !hw.vrdeSettings.fEnabled : hw.vrdeSettings.fEnabled)
5517 pelmVRDE->setAttribute("enabled", hw.vrdeSettings.fEnabled);
5518 if (m->sv < SettingsVersion_v1_11)
5519 {
5520 /* In VBox 4.0 these attributes are replaced with "Properties". */
5521 Utf8Str strPort;
5522 StringsMap::const_iterator it = hw.vrdeSettings.mapProperties.find("TCP/Ports");
5523 if (it != hw.vrdeSettings.mapProperties.end())
5524 strPort = it->second;
5525 if (!strPort.length())
5526 strPort = "3389";
5527 pelmVRDE->setAttribute("port", strPort);
5528
5529 Utf8Str strAddress;
5530 it = hw.vrdeSettings.mapProperties.find("TCP/Address");
5531 if (it != hw.vrdeSettings.mapProperties.end())
5532 strAddress = it->second;
5533 if (strAddress.length())
5534 pelmVRDE->setAttribute("netAddress", strAddress);
5535 }
5536 if (hw.vrdeSettings.authType != AuthType_Null)
5537 {
5538 const char *pcszAuthType;
5539 switch (hw.vrdeSettings.authType)
5540 {
5541 case AuthType_Guest: pcszAuthType = "Guest"; break;
5542 case AuthType_External: pcszAuthType = "External"; break;
5543 default: /*case AuthType_Null:*/ pcszAuthType = "Null"; break;
5544 }
5545 pelmVRDE->setAttribute("authType", pcszAuthType);
5546 }
5547
5548 if (hw.vrdeSettings.ulAuthTimeout != 0 && hw.vrdeSettings.ulAuthTimeout != 5000)
5549 pelmVRDE->setAttribute("authTimeout", hw.vrdeSettings.ulAuthTimeout);
5550 if (hw.vrdeSettings.fAllowMultiConnection)
5551 pelmVRDE->setAttribute("allowMultiConnection", hw.vrdeSettings.fAllowMultiConnection);
5552 if (hw.vrdeSettings.fReuseSingleConnection)
5553 pelmVRDE->setAttribute("reuseSingleConnection", hw.vrdeSettings.fReuseSingleConnection);
5554
5555 if (m->sv == SettingsVersion_v1_10)
5556 {
5557 xml::ElementNode *pelmVideoChannel = pelmVRDE->createChild("VideoChannel");
5558
5559 /* In 4.0 videochannel settings were replaced with properties, so look at properties. */
5560 Utf8Str str;
5561 StringsMap::const_iterator it = hw.vrdeSettings.mapProperties.find("VideoChannel/Enabled");
5562 if (it != hw.vrdeSettings.mapProperties.end())
5563 str = it->second;
5564 bool fVideoChannel = RTStrICmp(str.c_str(), "true") == 0
5565 || RTStrCmp(str.c_str(), "1") == 0;
5566 pelmVideoChannel->setAttribute("enabled", fVideoChannel);
5567
5568 it = hw.vrdeSettings.mapProperties.find("VideoChannel/Quality");
5569 if (it != hw.vrdeSettings.mapProperties.end())
5570 str = it->second;
5571 uint32_t ulVideoChannelQuality = RTStrToUInt32(str.c_str()); /* This returns 0 on invalid string which is ok. */
5572 if (ulVideoChannelQuality == 0)
5573 ulVideoChannelQuality = 75;
5574 else
5575 ulVideoChannelQuality = RT_CLAMP(ulVideoChannelQuality, 10, 100);
5576 pelmVideoChannel->setAttribute("quality", ulVideoChannelQuality);
5577 }
5578 if (m->sv >= SettingsVersion_v1_11)
5579 {
5580 if (hw.vrdeSettings.strAuthLibrary.length())
5581 pelmVRDE->setAttribute("authLibrary", hw.vrdeSettings.strAuthLibrary);
5582 if (hw.vrdeSettings.strVrdeExtPack.isNotEmpty())
5583 pelmVRDE->setAttribute("VRDEExtPack", hw.vrdeSettings.strVrdeExtPack);
5584 if (hw.vrdeSettings.mapProperties.size() > 0)
5585 {
5586 xml::ElementNode *pelmProperties = pelmVRDE->createChild("VRDEProperties");
5587 for (StringsMap::const_iterator it = hw.vrdeSettings.mapProperties.begin();
5588 it != hw.vrdeSettings.mapProperties.end();
5589 ++it)
5590 {
5591 const Utf8Str &strName = it->first;
5592 const Utf8Str &strValue = it->second;
5593 xml::ElementNode *pelm = pelmProperties->createChild("Property");
5594 pelm->setAttribute("name", strName);
5595 pelm->setAttribute("value", strValue);
5596 }
5597 }
5598 }
5599 }
5600
5601 if (!hw.biosSettings.areDefaultSettings())
5602 {
5603 xml::ElementNode *pelmBIOS = pelmHardware->createChild("BIOS");
5604 if (!hw.biosSettings.fACPIEnabled)
5605 pelmBIOS->createChild("ACPI")->setAttribute("enabled", hw.biosSettings.fACPIEnabled);
5606 if (hw.biosSettings.fIOAPICEnabled)
5607 pelmBIOS->createChild("IOAPIC")->setAttribute("enabled", hw.biosSettings.fIOAPICEnabled);
5608 if (hw.biosSettings.apicMode != APICMode_APIC)
5609 {
5610 const char *pcszAPIC;
5611 switch (hw.biosSettings.apicMode)
5612 {
5613 case APICMode_Disabled:
5614 pcszAPIC = "Disabled";
5615 break;
5616 case APICMode_APIC:
5617 default:
5618 pcszAPIC = "APIC";
5619 break;
5620 case APICMode_X2APIC:
5621 pcszAPIC = "X2APIC";
5622 break;
5623 }
5624 pelmBIOS->createChild("APIC")->setAttribute("mode", pcszAPIC);
5625 }
5626
5627 if ( !hw.biosSettings.fLogoFadeIn
5628 || !hw.biosSettings.fLogoFadeOut
5629 || hw.biosSettings.ulLogoDisplayTime
5630 || !hw.biosSettings.strLogoImagePath.isEmpty())
5631 {
5632 xml::ElementNode *pelmLogo = pelmBIOS->createChild("Logo");
5633 pelmLogo->setAttribute("fadeIn", hw.biosSettings.fLogoFadeIn);
5634 pelmLogo->setAttribute("fadeOut", hw.biosSettings.fLogoFadeOut);
5635 pelmLogo->setAttribute("displayTime", hw.biosSettings.ulLogoDisplayTime);
5636 if (!hw.biosSettings.strLogoImagePath.isEmpty())
5637 pelmLogo->setAttribute("imagePath", hw.biosSettings.strLogoImagePath);
5638 }
5639
5640 if (hw.biosSettings.biosBootMenuMode != BIOSBootMenuMode_MessageAndMenu)
5641 {
5642 const char *pcszBootMenu;
5643 switch (hw.biosSettings.biosBootMenuMode)
5644 {
5645 case BIOSBootMenuMode_Disabled: pcszBootMenu = "Disabled"; break;
5646 case BIOSBootMenuMode_MenuOnly: pcszBootMenu = "MenuOnly"; break;
5647 default: /*BIOSBootMenuMode_MessageAndMenu*/ pcszBootMenu = "MessageAndMenu"; break;
5648 }
5649 pelmBIOS->createChild("BootMenu")->setAttribute("mode", pcszBootMenu);
5650 }
5651 if (hw.biosSettings.llTimeOffset)
5652 pelmBIOS->createChild("TimeOffset")->setAttribute("value", hw.biosSettings.llTimeOffset);
5653 if (hw.biosSettings.fPXEDebugEnabled)
5654 pelmBIOS->createChild("PXEDebug")->setAttribute("enabled", hw.biosSettings.fPXEDebugEnabled);
5655 }
5656
5657 if (m->sv < SettingsVersion_v1_9)
5658 {
5659 // settings formats before 1.9 had separate DVDDrive and FloppyDrive items under Hardware;
5660 // run thru the storage controllers to see if we have a DVD or floppy drives
5661 size_t cDVDs = 0;
5662 size_t cFloppies = 0;
5663
5664 xml::ElementNode *pelmDVD = pelmHardware->createChild("DVDDrive");
5665 xml::ElementNode *pelmFloppy = pelmHardware->createChild("FloppyDrive");
5666
5667 for (StorageControllersList::const_iterator it = hw.storage.llStorageControllers.begin();
5668 it != hw.storage.llStorageControllers.end();
5669 ++it)
5670 {
5671 const StorageController &sctl = *it;
5672 // in old settings format, the DVD drive could only have been under the IDE controller
5673 if (sctl.storageBus == StorageBus_IDE)
5674 {
5675 for (AttachedDevicesList::const_iterator it2 = sctl.llAttachedDevices.begin();
5676 it2 != sctl.llAttachedDevices.end();
5677 ++it2)
5678 {
5679 const AttachedDevice &att = *it2;
5680 if (att.deviceType == DeviceType_DVD)
5681 {
5682 if (cDVDs > 0)
5683 throw ConfigFileError(this, NULL, N_("Internal error: cannot save more than one DVD drive with old settings format"));
5684
5685 ++cDVDs;
5686
5687 pelmDVD->setAttribute("passthrough", att.fPassThrough);
5688 if (att.fTempEject)
5689 pelmDVD->setAttribute("tempeject", att.fTempEject);
5690
5691 if (!att.uuid.isZero() && att.uuid.isValid())
5692 pelmDVD->createChild("Image")->setAttribute("uuid", att.uuid.toStringCurly());
5693 else if (att.strHostDriveSrc.length())
5694 pelmDVD->createChild("HostDrive")->setAttribute("src", att.strHostDriveSrc);
5695 }
5696 }
5697 }
5698 else if (sctl.storageBus == StorageBus_Floppy)
5699 {
5700 size_t cFloppiesHere = sctl.llAttachedDevices.size();
5701 if (cFloppiesHere > 1)
5702 throw ConfigFileError(this, NULL, N_("Internal error: floppy controller cannot have more than one device attachment"));
5703 if (cFloppiesHere)
5704 {
5705 const AttachedDevice &att = sctl.llAttachedDevices.front();
5706 pelmFloppy->setAttribute("enabled", true);
5707
5708 if (!att.uuid.isZero() && att.uuid.isValid())
5709 pelmFloppy->createChild("Image")->setAttribute("uuid", att.uuid.toStringCurly());
5710 else if (att.strHostDriveSrc.length())
5711 pelmFloppy->createChild("HostDrive")->setAttribute("src", att.strHostDriveSrc);
5712 }
5713
5714 cFloppies += cFloppiesHere;
5715 }
5716 }
5717
5718 if (cFloppies == 0)
5719 pelmFloppy->setAttribute("enabled", false);
5720 else if (cFloppies > 1)
5721 throw ConfigFileError(this, NULL, N_("Internal error: cannot save more than one floppy drive with old settings format"));
5722 }
5723
5724 if (m->sv < SettingsVersion_v1_14)
5725 {
5726 bool fOhciEnabled = false;
5727 bool fEhciEnabled = false;
5728 xml::ElementNode *pelmUSB = pelmHardware->createChild("USBController");
5729
5730 for (USBControllerList::const_iterator it = hw.usbSettings.llUSBControllers.begin();
5731 it != hw.usbSettings.llUSBControllers.end();
5732 ++it)
5733 {
5734 const USBController &ctrl = *it;
5735
5736 switch (ctrl.enmType)
5737 {
5738 case USBControllerType_OHCI:
5739 fOhciEnabled = true;
5740 break;
5741 case USBControllerType_EHCI:
5742 fEhciEnabled = true;
5743 break;
5744 default:
5745 AssertMsgFailed(("Unknown USB controller type %d\n", ctrl.enmType));
5746 }
5747 }
5748
5749 pelmUSB->setAttribute("enabled", fOhciEnabled);
5750 pelmUSB->setAttribute("enabledEhci", fEhciEnabled);
5751
5752 buildUSBDeviceFilters(*pelmUSB, hw.usbSettings.llDeviceFilters, false /* fHostMode */);
5753 }
5754 else
5755 {
5756 if ( hw.usbSettings.llUSBControllers.size()
5757 || hw.usbSettings.llDeviceFilters.size())
5758 {
5759 xml::ElementNode *pelmUSB = pelmHardware->createChild("USB");
5760 if (hw.usbSettings.llUSBControllers.size())
5761 {
5762 xml::ElementNode *pelmCtrls = pelmUSB->createChild("Controllers");
5763
5764 for (USBControllerList::const_iterator it = hw.usbSettings.llUSBControllers.begin();
5765 it != hw.usbSettings.llUSBControllers.end();
5766 ++it)
5767 {
5768 const USBController &ctrl = *it;
5769 com::Utf8Str strType;
5770 xml::ElementNode *pelmCtrl = pelmCtrls->createChild("Controller");
5771
5772 switch (ctrl.enmType)
5773 {
5774 case USBControllerType_OHCI:
5775 strType = "OHCI";
5776 break;
5777 case USBControllerType_EHCI:
5778 strType = "EHCI";
5779 break;
5780 case USBControllerType_XHCI:
5781 strType = "XHCI";
5782 break;
5783 default:
5784 AssertMsgFailed(("Unknown USB controller type %d\n", ctrl.enmType));
5785 }
5786
5787 pelmCtrl->setAttribute("name", ctrl.strName);
5788 pelmCtrl->setAttribute("type", strType);
5789 }
5790 }
5791
5792 if (hw.usbSettings.llDeviceFilters.size())
5793 {
5794 xml::ElementNode *pelmFilters = pelmUSB->createChild("DeviceFilters");
5795 buildUSBDeviceFilters(*pelmFilters, hw.usbSettings.llDeviceFilters, false /* fHostMode */);
5796 }
5797 }
5798 }
5799
5800 if ( hw.llNetworkAdapters.size()
5801 && !hw.areAllNetworkAdaptersDefaultSettings(m->sv))
5802 {
5803 xml::ElementNode *pelmNetwork = pelmHardware->createChild("Network");
5804 for (NetworkAdaptersList::const_iterator it = hw.llNetworkAdapters.begin();
5805 it != hw.llNetworkAdapters.end();
5806 ++it)
5807 {
5808 const NetworkAdapter &nic = *it;
5809
5810 if (!nic.areDefaultSettings(m->sv))
5811 {
5812 xml::ElementNode *pelmAdapter = pelmNetwork->createChild("Adapter");
5813 pelmAdapter->setAttribute("slot", nic.ulSlot);
5814 if (nic.fEnabled)
5815 pelmAdapter->setAttribute("enabled", nic.fEnabled);
5816 if (!nic.strMACAddress.isEmpty())
5817 pelmAdapter->setAttribute("MACAddress", nic.strMACAddress);
5818 if ( (m->sv >= SettingsVersion_v1_16 && !nic.fCableConnected)
5819 || (m->sv < SettingsVersion_v1_16 && nic.fCableConnected))
5820 pelmAdapter->setAttribute("cable", nic.fCableConnected);
5821 if (nic.ulLineSpeed)
5822 pelmAdapter->setAttribute("speed", nic.ulLineSpeed);
5823 if (nic.ulBootPriority != 0)
5824 pelmAdapter->setAttribute("bootPriority", nic.ulBootPriority);
5825 if (nic.fTraceEnabled)
5826 {
5827 pelmAdapter->setAttribute("trace", nic.fTraceEnabled);
5828 pelmAdapter->setAttribute("tracefile", nic.strTraceFile);
5829 }
5830 if (nic.strBandwidthGroup.isNotEmpty())
5831 pelmAdapter->setAttribute("bandwidthGroup", nic.strBandwidthGroup);
5832
5833 const char *pszPolicy;
5834 switch (nic.enmPromiscModePolicy)
5835 {
5836 case NetworkAdapterPromiscModePolicy_Deny: pszPolicy = NULL; break;
5837 case NetworkAdapterPromiscModePolicy_AllowNetwork: pszPolicy = "AllowNetwork"; break;
5838 case NetworkAdapterPromiscModePolicy_AllowAll: pszPolicy = "AllowAll"; break;
5839 default: pszPolicy = NULL; AssertFailed(); break;
5840 }
5841 if (pszPolicy)
5842 pelmAdapter->setAttribute("promiscuousModePolicy", pszPolicy);
5843
5844 if ( (m->sv >= SettingsVersion_v1_16 && nic.type != NetworkAdapterType_Am79C973)
5845 || (m->sv < SettingsVersion_v1_16 && nic.type != NetworkAdapterType_Am79C970A))
5846 {
5847 const char *pcszType;
5848 switch (nic.type)
5849 {
5850 case NetworkAdapterType_Am79C973: pcszType = "Am79C973"; break;
5851 case NetworkAdapterType_I82540EM: pcszType = "82540EM"; break;
5852 case NetworkAdapterType_I82543GC: pcszType = "82543GC"; break;
5853 case NetworkAdapterType_I82545EM: pcszType = "82545EM"; break;
5854 case NetworkAdapterType_Virtio: pcszType = "virtio"; break;
5855 default: /*case NetworkAdapterType_Am79C970A:*/ pcszType = "Am79C970A"; break;
5856 }
5857 pelmAdapter->setAttribute("type", pcszType);
5858 }
5859
5860 xml::ElementNode *pelmNAT;
5861 if (m->sv < SettingsVersion_v1_10)
5862 {
5863 switch (nic.mode)
5864 {
5865 case NetworkAttachmentType_NAT:
5866 pelmNAT = pelmAdapter->createChild("NAT");
5867 if (nic.nat.strNetwork.length())
5868 pelmNAT->setAttribute("network", nic.nat.strNetwork);
5869 break;
5870
5871 case NetworkAttachmentType_Bridged:
5872 pelmAdapter->createChild("BridgedInterface")->setAttribute("name", nic.strBridgedName);
5873 break;
5874
5875 case NetworkAttachmentType_Internal:
5876 pelmAdapter->createChild("InternalNetwork")->setAttribute("name", nic.strInternalNetworkName);
5877 break;
5878
5879 case NetworkAttachmentType_HostOnly:
5880 pelmAdapter->createChild("HostOnlyInterface")->setAttribute("name", nic.strHostOnlyName);
5881 break;
5882
5883 default: /*case NetworkAttachmentType_Null:*/
5884 break;
5885 }
5886 }
5887 else
5888 {
5889 /* m->sv >= SettingsVersion_v1_10 */
5890 if (!nic.areDisabledDefaultSettings())
5891 {
5892 xml::ElementNode *pelmDisabledNode = pelmAdapter->createChild("DisabledModes");
5893 if (nic.mode != NetworkAttachmentType_NAT)
5894 buildNetworkXML(NetworkAttachmentType_NAT, false, *pelmDisabledNode, nic);
5895 if (nic.mode != NetworkAttachmentType_Bridged)
5896 buildNetworkXML(NetworkAttachmentType_Bridged, false, *pelmDisabledNode, nic);
5897 if (nic.mode != NetworkAttachmentType_Internal)
5898 buildNetworkXML(NetworkAttachmentType_Internal, false, *pelmDisabledNode, nic);
5899 if (nic.mode != NetworkAttachmentType_HostOnly)
5900 buildNetworkXML(NetworkAttachmentType_HostOnly, false, *pelmDisabledNode, nic);
5901 if (nic.mode != NetworkAttachmentType_Generic)
5902 buildNetworkXML(NetworkAttachmentType_Generic, false, *pelmDisabledNode, nic);
5903 if (nic.mode != NetworkAttachmentType_NATNetwork)
5904 buildNetworkXML(NetworkAttachmentType_NATNetwork, false, *pelmDisabledNode, nic);
5905 }
5906 buildNetworkXML(nic.mode, true, *pelmAdapter, nic);
5907 }
5908 }
5909 }
5910 }
5911
5912 if (hw.llSerialPorts.size())
5913 {
5914 xml::ElementNode *pelmPorts = pelmHardware->createChild("UART");
5915 for (SerialPortsList::const_iterator it = hw.llSerialPorts.begin();
5916 it != hw.llSerialPorts.end();
5917 ++it)
5918 {
5919 const SerialPort &port = *it;
5920 xml::ElementNode *pelmPort = pelmPorts->createChild("Port");
5921 pelmPort->setAttribute("slot", port.ulSlot);
5922 pelmPort->setAttribute("enabled", port.fEnabled);
5923 pelmPort->setAttributeHex("IOBase", port.ulIOBase);
5924 pelmPort->setAttribute("IRQ", port.ulIRQ);
5925
5926 const char *pcszHostMode;
5927 switch (port.portMode)
5928 {
5929 case PortMode_HostPipe: pcszHostMode = "HostPipe"; break;
5930 case PortMode_HostDevice: pcszHostMode = "HostDevice"; break;
5931 case PortMode_TCP: pcszHostMode = "TCP"; break;
5932 case PortMode_RawFile: pcszHostMode = "RawFile"; break;
5933 default: /*case PortMode_Disconnected:*/ pcszHostMode = "Disconnected"; break;
5934 }
5935 switch (port.portMode)
5936 {
5937 case PortMode_TCP:
5938 case PortMode_HostPipe:
5939 pelmPort->setAttribute("server", port.fServer);
5940 /* fall thru */
5941 case PortMode_HostDevice:
5942 case PortMode_RawFile:
5943 pelmPort->setAttribute("path", port.strPath);
5944 break;
5945
5946 default:
5947 break;
5948 }
5949 pelmPort->setAttribute("hostMode", pcszHostMode);
5950 }
5951 }
5952
5953 if (hw.llParallelPorts.size())
5954 {
5955 xml::ElementNode *pelmPorts = pelmHardware->createChild("LPT");
5956 for (ParallelPortsList::const_iterator it = hw.llParallelPorts.begin();
5957 it != hw.llParallelPorts.end();
5958 ++it)
5959 {
5960 const ParallelPort &port = *it;
5961 xml::ElementNode *pelmPort = pelmPorts->createChild("Port");
5962 pelmPort->setAttribute("slot", port.ulSlot);
5963 pelmPort->setAttribute("enabled", port.fEnabled);
5964 pelmPort->setAttributeHex("IOBase", port.ulIOBase);
5965 pelmPort->setAttribute("IRQ", port.ulIRQ);
5966 if (port.strPath.length())
5967 pelmPort->setAttribute("path", port.strPath);
5968 }
5969 }
5970
5971 /* Always write the AudioAdapter config, intentionally not checking if
5972 * the settings are at the default, because that would be problematic
5973 * for the configured host driver type, which would automatically change
5974 * if the default host driver is detected differently. */
5975 {
5976 xml::ElementNode *pelmAudio = pelmHardware->createChild("AudioAdapter");
5977
5978 const char *pcszController;
5979 switch (hw.audioAdapter.controllerType)
5980 {
5981 case AudioControllerType_SB16:
5982 pcszController = "SB16";
5983 break;
5984 case AudioControllerType_HDA:
5985 if (m->sv >= SettingsVersion_v1_11)
5986 {
5987 pcszController = "HDA";
5988 break;
5989 }
5990 /* fall through */
5991 case AudioControllerType_AC97:
5992 default:
5993 pcszController = NULL;
5994 break;
5995 }
5996 if (pcszController)
5997 pelmAudio->setAttribute("controller", pcszController);
5998
5999 const char *pcszCodec;
6000 switch (hw.audioAdapter.codecType)
6001 {
6002 /* Only write out the setting for non-default AC'97 codec
6003 * and leave the rest alone.
6004 */
6005#if 0
6006 case AudioCodecType_SB16:
6007 pcszCodec = "SB16";
6008 break;
6009 case AudioCodecType_STAC9221:
6010 pcszCodec = "STAC9221";
6011 break;
6012 case AudioCodecType_STAC9700:
6013 pcszCodec = "STAC9700";
6014 break;
6015#endif
6016 case AudioCodecType_AD1980:
6017 pcszCodec = "AD1980";
6018 break;
6019 default:
6020 /* Don't write out anything if unknown. */
6021 pcszCodec = NULL;
6022 }
6023 if (pcszCodec)
6024 pelmAudio->setAttribute("codec", pcszCodec);
6025
6026 const char *pcszDriver;
6027 switch (hw.audioAdapter.driverType)
6028 {
6029 case AudioDriverType_WinMM: pcszDriver = "WinMM"; break;
6030 case AudioDriverType_DirectSound: pcszDriver = "DirectSound"; break;
6031 case AudioDriverType_SolAudio: pcszDriver = "SolAudio"; break;
6032 case AudioDriverType_ALSA: pcszDriver = "ALSA"; break;
6033 case AudioDriverType_Pulse: pcszDriver = "Pulse"; break;
6034 case AudioDriverType_OSS: pcszDriver = "OSS"; break;
6035 case AudioDriverType_CoreAudio: pcszDriver = "CoreAudio"; break;
6036 case AudioDriverType_MMPM: pcszDriver = "MMPM"; break;
6037 default: /*case AudioDriverType_Null:*/ pcszDriver = "Null"; break;
6038 }
6039 /* Deliberately have the audio driver explicitly in the config file,
6040 * otherwise an unwritten default driver triggers auto-detection. */
6041 pelmAudio->setAttribute("driver", pcszDriver);
6042
6043 if (hw.audioAdapter.fEnabled || m->sv < SettingsVersion_v1_16)
6044 pelmAudio->setAttribute("enabled", hw.audioAdapter.fEnabled);
6045
6046 if ( (m->sv <= SettingsVersion_v1_16 && !hw.audioAdapter.fEnabledIn)
6047 || (m->sv > SettingsVersion_v1_16 && hw.audioAdapter.fEnabledIn))
6048 pelmAudio->setAttribute("enabledIn", hw.audioAdapter.fEnabledIn);
6049
6050 if ( (m->sv <= SettingsVersion_v1_16 && !hw.audioAdapter.fEnabledOut)
6051 || (m->sv > SettingsVersion_v1_16 && hw.audioAdapter.fEnabledOut))
6052 pelmAudio->setAttribute("enabledOut", hw.audioAdapter.fEnabledOut);
6053
6054 if (m->sv >= SettingsVersion_v1_15 && hw.audioAdapter.properties.size() > 0)
6055 {
6056 for (StringsMap::const_iterator it = hw.audioAdapter.properties.begin();
6057 it != hw.audioAdapter.properties.end();
6058 ++it)
6059 {
6060 const Utf8Str &strName = it->first;
6061 const Utf8Str &strValue = it->second;
6062 xml::ElementNode *pelm = pelmAudio->createChild("Property");
6063 pelm->setAttribute("name", strName);
6064 pelm->setAttribute("value", strValue);
6065 }
6066 }
6067 }
6068
6069 if (m->sv >= SettingsVersion_v1_10 && machineUserData.fRTCUseUTC)
6070 {
6071 xml::ElementNode *pelmRTC = pelmHardware->createChild("RTC");
6072 pelmRTC->setAttribute("localOrUTC", machineUserData.fRTCUseUTC ? "UTC" : "local");
6073 }
6074
6075 if (hw.llSharedFolders.size())
6076 {
6077 xml::ElementNode *pelmSharedFolders = pelmHardware->createChild("SharedFolders");
6078 for (SharedFoldersList::const_iterator it = hw.llSharedFolders.begin();
6079 it != hw.llSharedFolders.end();
6080 ++it)
6081 {
6082 const SharedFolder &sf = *it;
6083 xml::ElementNode *pelmThis = pelmSharedFolders->createChild("SharedFolder");
6084 pelmThis->setAttribute("name", sf.strName);
6085 pelmThis->setAttribute("hostPath", sf.strHostPath);
6086 pelmThis->setAttribute("writable", sf.fWritable);
6087 pelmThis->setAttribute("autoMount", sf.fAutoMount);
6088 }
6089 }
6090
6091 if (hw.clipboardMode != ClipboardMode_Disabled)
6092 {
6093 xml::ElementNode *pelmClip = pelmHardware->createChild("Clipboard");
6094 const char *pcszClip;
6095 switch (hw.clipboardMode)
6096 {
6097 default: /*case ClipboardMode_Disabled:*/ pcszClip = "Disabled"; break;
6098 case ClipboardMode_HostToGuest: pcszClip = "HostToGuest"; break;
6099 case ClipboardMode_GuestToHost: pcszClip = "GuestToHost"; break;
6100 case ClipboardMode_Bidirectional: pcszClip = "Bidirectional"; break;
6101 }
6102 pelmClip->setAttribute("mode", pcszClip);
6103 }
6104
6105 if (hw.dndMode != DnDMode_Disabled)
6106 {
6107 xml::ElementNode *pelmDragAndDrop = pelmHardware->createChild("DragAndDrop");
6108 const char *pcszDragAndDrop;
6109 switch (hw.dndMode)
6110 {
6111 default: /*case DnDMode_Disabled:*/ pcszDragAndDrop = "Disabled"; break;
6112 case DnDMode_HostToGuest: pcszDragAndDrop = "HostToGuest"; break;
6113 case DnDMode_GuestToHost: pcszDragAndDrop = "GuestToHost"; break;
6114 case DnDMode_Bidirectional: pcszDragAndDrop = "Bidirectional"; break;
6115 }
6116 pelmDragAndDrop->setAttribute("mode", pcszDragAndDrop);
6117 }
6118
6119 if ( m->sv >= SettingsVersion_v1_10
6120 && !hw.ioSettings.areDefaultSettings())
6121 {
6122 xml::ElementNode *pelmIO = pelmHardware->createChild("IO");
6123 xml::ElementNode *pelmIOCache;
6124
6125 if (!hw.ioSettings.areDefaultSettings())
6126 {
6127 pelmIOCache = pelmIO->createChild("IoCache");
6128 if (!hw.ioSettings.fIOCacheEnabled)
6129 pelmIOCache->setAttribute("enabled", hw.ioSettings.fIOCacheEnabled);
6130 if (hw.ioSettings.ulIOCacheSize != 5)
6131 pelmIOCache->setAttribute("size", hw.ioSettings.ulIOCacheSize);
6132 }
6133
6134 if ( m->sv >= SettingsVersion_v1_11
6135 && hw.ioSettings.llBandwidthGroups.size())
6136 {
6137 xml::ElementNode *pelmBandwidthGroups = pelmIO->createChild("BandwidthGroups");
6138 for (BandwidthGroupList::const_iterator it = hw.ioSettings.llBandwidthGroups.begin();
6139 it != hw.ioSettings.llBandwidthGroups.end();
6140 ++it)
6141 {
6142 const BandwidthGroup &gr = *it;
6143 const char *pcszType;
6144 xml::ElementNode *pelmThis = pelmBandwidthGroups->createChild("BandwidthGroup");
6145 pelmThis->setAttribute("name", gr.strName);
6146 switch (gr.enmType)
6147 {
6148 case BandwidthGroupType_Network: pcszType = "Network"; break;
6149 default: /* BandwidthGrouptype_Disk */ pcszType = "Disk"; break;
6150 }
6151 pelmThis->setAttribute("type", pcszType);
6152 if (m->sv >= SettingsVersion_v1_13)
6153 pelmThis->setAttribute("maxBytesPerSec", gr.cMaxBytesPerSec);
6154 else
6155 pelmThis->setAttribute("maxMbPerSec", gr.cMaxBytesPerSec / _1M);
6156 }
6157 }
6158 }
6159
6160 if ( m->sv >= SettingsVersion_v1_12
6161 && hw.pciAttachments.size())
6162 {
6163 xml::ElementNode *pelmPCI = pelmHardware->createChild("HostPci");
6164 xml::ElementNode *pelmPCIDevices = pelmPCI->createChild("Devices");
6165
6166 for (HostPCIDeviceAttachmentList::const_iterator it = hw.pciAttachments.begin();
6167 it != hw.pciAttachments.end();
6168 ++it)
6169 {
6170 const HostPCIDeviceAttachment &hpda = *it;
6171
6172 xml::ElementNode *pelmThis = pelmPCIDevices->createChild("Device");
6173
6174 pelmThis->setAttribute("host", hpda.uHostAddress);
6175 pelmThis->setAttribute("guest", hpda.uGuestAddress);
6176 pelmThis->setAttribute("name", hpda.strDeviceName);
6177 }
6178 }
6179
6180 if ( m->sv >= SettingsVersion_v1_12
6181 && hw.fEmulatedUSBCardReader)
6182 {
6183 xml::ElementNode *pelmEmulatedUSB = pelmHardware->createChild("EmulatedUSB");
6184
6185 xml::ElementNode *pelmCardReader = pelmEmulatedUSB->createChild("CardReader");
6186 pelmCardReader->setAttribute("enabled", hw.fEmulatedUSBCardReader);
6187 }
6188
6189 if ( m->sv >= SettingsVersion_v1_14
6190 && !hw.strDefaultFrontend.isEmpty())
6191 {
6192 xml::ElementNode *pelmFrontend = pelmHardware->createChild("Frontend");
6193 xml::ElementNode *pelmDefault = pelmFrontend->createChild("Default");
6194 pelmDefault->setAttribute("type", hw.strDefaultFrontend);
6195 }
6196
6197 if (hw.ulMemoryBalloonSize)
6198 {
6199 xml::ElementNode *pelmGuest = pelmHardware->createChild("Guest");
6200 pelmGuest->setAttribute("memoryBalloonSize", hw.ulMemoryBalloonSize);
6201 }
6202
6203 if (hw.llGuestProperties.size())
6204 {
6205 xml::ElementNode *pelmGuestProps = pelmHardware->createChild("GuestProperties");
6206 for (GuestPropertiesList::const_iterator it = hw.llGuestProperties.begin();
6207 it != hw.llGuestProperties.end();
6208 ++it)
6209 {
6210 const GuestProperty &prop = *it;
6211 xml::ElementNode *pelmProp = pelmGuestProps->createChild("GuestProperty");
6212 pelmProp->setAttribute("name", prop.strName);
6213 pelmProp->setAttribute("value", prop.strValue);
6214 pelmProp->setAttribute("timestamp", prop.timestamp);
6215 pelmProp->setAttribute("flags", prop.strFlags);
6216 }
6217 }
6218
6219 /** @todo In the future (6.0?) place the storage controllers under \<Hardware\>, because
6220 * this is where it always should've been. What else than hardware are they? */
6221 xml::ElementNode &elmStorageParent = (m->sv > SettingsVersion_Future) ? *pelmHardware : elmParent;
6222 buildStorageControllersXML(elmStorageParent,
6223 hw.storage,
6224 !!(fl & BuildMachineXML_SkipRemovableMedia),
6225 pllElementsWithUuidAttributes);
6226}
6227
6228/**
6229 * Fill a \<Network\> node. Only relevant for XML version >= v1_10.
6230 * @param mode
6231 * @param fEnabled
6232 * @param elmParent
6233 * @param nic
6234 */
6235void MachineConfigFile::buildNetworkXML(NetworkAttachmentType_T mode,
6236 bool fEnabled,
6237 xml::ElementNode &elmParent,
6238 const NetworkAdapter &nic)
6239{
6240 switch (mode)
6241 {
6242 case NetworkAttachmentType_NAT:
6243 // For the currently active network attachment type we have to
6244 // generate the tag, otherwise the attachment type is lost.
6245 if (fEnabled || !nic.nat.areDefaultSettings())
6246 {
6247 xml::ElementNode *pelmNAT = elmParent.createChild("NAT");
6248
6249 if (!nic.nat.areDefaultSettings())
6250 {
6251 if (nic.nat.strNetwork.length())
6252 pelmNAT->setAttribute("network", nic.nat.strNetwork);
6253 if (nic.nat.strBindIP.length())
6254 pelmNAT->setAttribute("hostip", nic.nat.strBindIP);
6255 if (nic.nat.u32Mtu)
6256 pelmNAT->setAttribute("mtu", nic.nat.u32Mtu);
6257 if (nic.nat.u32SockRcv)
6258 pelmNAT->setAttribute("sockrcv", nic.nat.u32SockRcv);
6259 if (nic.nat.u32SockSnd)
6260 pelmNAT->setAttribute("socksnd", nic.nat.u32SockSnd);
6261 if (nic.nat.u32TcpRcv)
6262 pelmNAT->setAttribute("tcprcv", nic.nat.u32TcpRcv);
6263 if (nic.nat.u32TcpSnd)
6264 pelmNAT->setAttribute("tcpsnd", nic.nat.u32TcpSnd);
6265 if (!nic.nat.areDNSDefaultSettings())
6266 {
6267 xml::ElementNode *pelmDNS = pelmNAT->createChild("DNS");
6268 if (!nic.nat.fDNSPassDomain)
6269 pelmDNS->setAttribute("pass-domain", nic.nat.fDNSPassDomain);
6270 if (nic.nat.fDNSProxy)
6271 pelmDNS->setAttribute("use-proxy", nic.nat.fDNSProxy);
6272 if (nic.nat.fDNSUseHostResolver)
6273 pelmDNS->setAttribute("use-host-resolver", nic.nat.fDNSUseHostResolver);
6274 }
6275
6276 if (!nic.nat.areAliasDefaultSettings())
6277 {
6278 xml::ElementNode *pelmAlias = pelmNAT->createChild("Alias");
6279 if (nic.nat.fAliasLog)
6280 pelmAlias->setAttribute("logging", nic.nat.fAliasLog);
6281 if (nic.nat.fAliasProxyOnly)
6282 pelmAlias->setAttribute("proxy-only", nic.nat.fAliasProxyOnly);
6283 if (nic.nat.fAliasUseSamePorts)
6284 pelmAlias->setAttribute("use-same-ports", nic.nat.fAliasUseSamePorts);
6285 }
6286
6287 if (!nic.nat.areTFTPDefaultSettings())
6288 {
6289 xml::ElementNode *pelmTFTP;
6290 pelmTFTP = pelmNAT->createChild("TFTP");
6291 if (nic.nat.strTFTPPrefix.length())
6292 pelmTFTP->setAttribute("prefix", nic.nat.strTFTPPrefix);
6293 if (nic.nat.strTFTPBootFile.length())
6294 pelmTFTP->setAttribute("boot-file", nic.nat.strTFTPBootFile);
6295 if (nic.nat.strTFTPNextServer.length())
6296 pelmTFTP->setAttribute("next-server", nic.nat.strTFTPNextServer);
6297 }
6298 buildNATForwardRulesMap(*pelmNAT, nic.nat.mapRules);
6299 }
6300 }
6301 break;
6302
6303 case NetworkAttachmentType_Bridged:
6304 // For the currently active network attachment type we have to
6305 // generate the tag, otherwise the attachment type is lost.
6306 if (fEnabled || !nic.strBridgedName.isEmpty())
6307 {
6308 xml::ElementNode *pelmMode = elmParent.createChild("BridgedInterface");
6309 if (!nic.strBridgedName.isEmpty())
6310 pelmMode->setAttribute("name", nic.strBridgedName);
6311 }
6312 break;
6313
6314 case NetworkAttachmentType_Internal:
6315 // For the currently active network attachment type we have to
6316 // generate the tag, otherwise the attachment type is lost.
6317 if (fEnabled || !nic.strInternalNetworkName.isEmpty())
6318 {
6319 xml::ElementNode *pelmMode = elmParent.createChild("InternalNetwork");
6320 if (!nic.strInternalNetworkName.isEmpty())
6321 pelmMode->setAttribute("name", nic.strInternalNetworkName);
6322 }
6323 break;
6324
6325 case NetworkAttachmentType_HostOnly:
6326 // For the currently active network attachment type we have to
6327 // generate the tag, otherwise the attachment type is lost.
6328 if (fEnabled || !nic.strHostOnlyName.isEmpty())
6329 {
6330 xml::ElementNode *pelmMode = elmParent.createChild("HostOnlyInterface");
6331 if (!nic.strHostOnlyName.isEmpty())
6332 pelmMode->setAttribute("name", nic.strHostOnlyName);
6333 }
6334 break;
6335
6336 case NetworkAttachmentType_Generic:
6337 // For the currently active network attachment type we have to
6338 // generate the tag, otherwise the attachment type is lost.
6339 if (fEnabled || !nic.areGenericDriverDefaultSettings())
6340 {
6341 xml::ElementNode *pelmMode = elmParent.createChild("GenericInterface");
6342 if (!nic.areGenericDriverDefaultSettings())
6343 {
6344 pelmMode->setAttribute("driver", nic.strGenericDriver);
6345 for (StringsMap::const_iterator it = nic.genericProperties.begin();
6346 it != nic.genericProperties.end();
6347 ++it)
6348 {
6349 xml::ElementNode *pelmProp = pelmMode->createChild("Property");
6350 pelmProp->setAttribute("name", it->first);
6351 pelmProp->setAttribute("value", it->second);
6352 }
6353 }
6354 }
6355 break;
6356
6357 case NetworkAttachmentType_NATNetwork:
6358 // For the currently active network attachment type we have to
6359 // generate the tag, otherwise the attachment type is lost.
6360 if (fEnabled || !nic.strNATNetworkName.isEmpty())
6361 {
6362 xml::ElementNode *pelmMode = elmParent.createChild("NATNetwork");
6363 if (!nic.strNATNetworkName.isEmpty())
6364 pelmMode->setAttribute("name", nic.strNATNetworkName);
6365 }
6366 break;
6367
6368 default: /*case NetworkAttachmentType_Null:*/
6369 break;
6370 }
6371}
6372
6373/**
6374 * Creates a \<StorageControllers\> node under elmParent and then writes out the XML
6375 * keys under that. Called for both the \<Machine\> node and for snapshots.
6376 * @param elmParent
6377 * @param st
6378 * @param fSkipRemovableMedia If true, DVD and floppy attachments are skipped and
6379 * an empty drive is always written instead. This is for the OVF export case.
6380 * This parameter is ignored unless the settings version is at least v1.9, which
6381 * is always the case when this gets called for OVF export.
6382 * @param pllElementsWithUuidAttributes If not NULL, must point to a list of element node
6383 * pointers to which we will append all elements that we created here that contain
6384 * UUID attributes. This allows the OVF export code to quickly replace the internal
6385 * media UUIDs with the UUIDs of the media that were exported.
6386 */
6387void MachineConfigFile::buildStorageControllersXML(xml::ElementNode &elmParent,
6388 const Storage &st,
6389 bool fSkipRemovableMedia,
6390 std::list<xml::ElementNode*> *pllElementsWithUuidAttributes)
6391{
6392 if (!st.llStorageControllers.size())
6393 return;
6394 xml::ElementNode *pelmStorageControllers = elmParent.createChild("StorageControllers");
6395
6396 for (StorageControllersList::const_iterator it = st.llStorageControllers.begin();
6397 it != st.llStorageControllers.end();
6398 ++it)
6399 {
6400 const StorageController &sc = *it;
6401
6402 if ( (m->sv < SettingsVersion_v1_9)
6403 && (sc.controllerType == StorageControllerType_I82078)
6404 )
6405 // floppy controller already got written into <Hardware>/<FloppyController> in buildHardwareXML()
6406 // for pre-1.9 settings
6407 continue;
6408
6409 xml::ElementNode *pelmController = pelmStorageControllers->createChild("StorageController");
6410 com::Utf8Str name = sc.strName;
6411 if (m->sv < SettingsVersion_v1_8)
6412 {
6413 // pre-1.8 settings use shorter controller names, they are
6414 // expanded when reading the settings
6415 if (name == "IDE Controller")
6416 name = "IDE";
6417 else if (name == "SATA Controller")
6418 name = "SATA";
6419 else if (name == "SCSI Controller")
6420 name = "SCSI";
6421 }
6422 pelmController->setAttribute("name", sc.strName);
6423
6424 const char *pcszType;
6425 switch (sc.controllerType)
6426 {
6427 case StorageControllerType_IntelAhci: pcszType = "AHCI"; break;
6428 case StorageControllerType_LsiLogic: pcszType = "LsiLogic"; break;
6429 case StorageControllerType_BusLogic: pcszType = "BusLogic"; break;
6430 case StorageControllerType_PIIX4: pcszType = "PIIX4"; break;
6431 case StorageControllerType_ICH6: pcszType = "ICH6"; break;
6432 case StorageControllerType_I82078: pcszType = "I82078"; break;
6433 case StorageControllerType_LsiLogicSas: pcszType = "LsiLogicSas"; break;
6434 case StorageControllerType_USB: pcszType = "USB"; break;
6435 case StorageControllerType_NVMe: pcszType = "NVMe"; break;
6436 default: /*case StorageControllerType_PIIX3:*/ pcszType = "PIIX3"; break;
6437 }
6438 pelmController->setAttribute("type", pcszType);
6439
6440 pelmController->setAttribute("PortCount", sc.ulPortCount);
6441
6442 if (m->sv >= SettingsVersion_v1_9)
6443 if (sc.ulInstance)
6444 pelmController->setAttribute("Instance", sc.ulInstance);
6445
6446 if (m->sv >= SettingsVersion_v1_10)
6447 pelmController->setAttribute("useHostIOCache", sc.fUseHostIOCache);
6448
6449 if (m->sv >= SettingsVersion_v1_11)
6450 pelmController->setAttribute("Bootable", sc.fBootable);
6451
6452 if (sc.controllerType == StorageControllerType_IntelAhci)
6453 {
6454 pelmController->setAttribute("IDE0MasterEmulationPort", 0);
6455 pelmController->setAttribute("IDE0SlaveEmulationPort", 1);
6456 pelmController->setAttribute("IDE1MasterEmulationPort", 2);
6457 pelmController->setAttribute("IDE1SlaveEmulationPort", 3);
6458 }
6459
6460 for (AttachedDevicesList::const_iterator it2 = sc.llAttachedDevices.begin();
6461 it2 != sc.llAttachedDevices.end();
6462 ++it2)
6463 {
6464 const AttachedDevice &att = *it2;
6465
6466 // For settings version before 1.9, DVDs and floppies are in hardware, not storage controllers,
6467 // so we shouldn't write them here; we only get here for DVDs though because we ruled out
6468 // the floppy controller at the top of the loop
6469 if ( att.deviceType == DeviceType_DVD
6470 && m->sv < SettingsVersion_v1_9
6471 )
6472 continue;
6473
6474 xml::ElementNode *pelmDevice = pelmController->createChild("AttachedDevice");
6475
6476 pcszType = NULL;
6477
6478 switch (att.deviceType)
6479 {
6480 case DeviceType_HardDisk:
6481 pcszType = "HardDisk";
6482 if (att.fNonRotational)
6483 pelmDevice->setAttribute("nonrotational", att.fNonRotational);
6484 if (att.fDiscard)
6485 pelmDevice->setAttribute("discard", att.fDiscard);
6486 break;
6487
6488 case DeviceType_DVD:
6489 pcszType = "DVD";
6490 pelmDevice->setAttribute("passthrough", att.fPassThrough);
6491 if (att.fTempEject)
6492 pelmDevice->setAttribute("tempeject", att.fTempEject);
6493 break;
6494
6495 case DeviceType_Floppy:
6496 pcszType = "Floppy";
6497 break;
6498
6499 default: break; /* Shut up MSC. */
6500 }
6501
6502 pelmDevice->setAttribute("type", pcszType);
6503
6504 if (m->sv >= SettingsVersion_v1_15)
6505 pelmDevice->setAttribute("hotpluggable", att.fHotPluggable);
6506
6507 pelmDevice->setAttribute("port", att.lPort);
6508 pelmDevice->setAttribute("device", att.lDevice);
6509
6510 if (att.strBwGroup.length())
6511 pelmDevice->setAttribute("bandwidthGroup", att.strBwGroup);
6512
6513 // attached image, if any
6514 if (!att.uuid.isZero()
6515 && att.uuid.isValid()
6516 && (att.deviceType == DeviceType_HardDisk
6517 || !fSkipRemovableMedia
6518 )
6519 )
6520 {
6521 xml::ElementNode *pelmImage = pelmDevice->createChild("Image");
6522 pelmImage->setAttribute("uuid", att.uuid.toStringCurly());
6523
6524 // if caller wants a list of UUID elements, give it to them
6525 if (pllElementsWithUuidAttributes)
6526 pllElementsWithUuidAttributes->push_back(pelmImage);
6527 }
6528 else if ( (m->sv >= SettingsVersion_v1_9)
6529 && (att.strHostDriveSrc.length())
6530 )
6531 pelmDevice->createChild("HostDrive")->setAttribute("src", att.strHostDriveSrc);
6532 }
6533 }
6534}
6535
6536/**
6537 * Creates a \<Debugging\> node under elmParent and then writes out the XML
6538 * keys under that. Called for both the \<Machine\> node and for snapshots.
6539 *
6540 * @param pElmParent Pointer to the parent element.
6541 * @param pDbg Pointer to the debugging settings.
6542 */
6543void MachineConfigFile::buildDebuggingXML(xml::ElementNode *pElmParent, const Debugging *pDbg)
6544{
6545 if (m->sv < SettingsVersion_v1_13 || pDbg->areDefaultSettings())
6546 return;
6547
6548 xml::ElementNode *pElmDebugging = pElmParent->createChild("Debugging");
6549 xml::ElementNode *pElmTracing = pElmDebugging->createChild("Tracing");
6550 pElmTracing->setAttribute("enabled", pDbg->fTracingEnabled);
6551 pElmTracing->setAttribute("allowTracingToAccessVM", pDbg->fAllowTracingToAccessVM);
6552 pElmTracing->setAttribute("config", pDbg->strTracingConfig);
6553}
6554
6555/**
6556 * Creates a \<Autostart\> node under elmParent and then writes out the XML
6557 * keys under that. Called for both the \<Machine\> node and for snapshots.
6558 *
6559 * @param pElmParent Pointer to the parent element.
6560 * @param pAutostart Pointer to the autostart settings.
6561 */
6562void MachineConfigFile::buildAutostartXML(xml::ElementNode *pElmParent, const Autostart *pAutostart)
6563{
6564 const char *pcszAutostop = NULL;
6565
6566 if (m->sv < SettingsVersion_v1_13 || pAutostart->areDefaultSettings())
6567 return;
6568
6569 xml::ElementNode *pElmAutostart = pElmParent->createChild("Autostart");
6570 pElmAutostart->setAttribute("enabled", pAutostart->fAutostartEnabled);
6571 pElmAutostart->setAttribute("delay", pAutostart->uAutostartDelay);
6572
6573 switch (pAutostart->enmAutostopType)
6574 {
6575 case AutostopType_Disabled: pcszAutostop = "Disabled"; break;
6576 case AutostopType_SaveState: pcszAutostop = "SaveState"; break;
6577 case AutostopType_PowerOff: pcszAutostop = "PowerOff"; break;
6578 case AutostopType_AcpiShutdown: pcszAutostop = "AcpiShutdown"; break;
6579 default: Assert(false); pcszAutostop = "Disabled"; break;
6580 }
6581 pElmAutostart->setAttribute("autostop", pcszAutostop);
6582}
6583
6584/**
6585 * Creates a \<Groups\> node under elmParent and then writes out the XML
6586 * keys under that. Called for the \<Machine\> node only.
6587 *
6588 * @param pElmParent Pointer to the parent element.
6589 * @param pllGroups Pointer to the groups list.
6590 */
6591void MachineConfigFile::buildGroupsXML(xml::ElementNode *pElmParent, const StringsList *pllGroups)
6592{
6593 if ( m->sv < SettingsVersion_v1_13 || pllGroups->size() == 0
6594 || (pllGroups->size() == 1 && pllGroups->front() == "/"))
6595 return;
6596
6597 xml::ElementNode *pElmGroups = pElmParent->createChild("Groups");
6598 for (StringsList::const_iterator it = pllGroups->begin();
6599 it != pllGroups->end();
6600 ++it)
6601 {
6602 const Utf8Str &group = *it;
6603 xml::ElementNode *pElmGroup = pElmGroups->createChild("Group");
6604 pElmGroup->setAttribute("name", group);
6605 }
6606}
6607
6608/**
6609 * Writes a single snapshot into the DOM tree. Initially this gets called from MachineConfigFile::write()
6610 * for the root snapshot of a machine, if present; elmParent then points to the \<Snapshots\> node under the
6611 * \<Machine\> node to which \<Snapshot\> must be added. This may then recurse for child snapshots.
6612 *
6613 * @param depth
6614 * @param elmParent
6615 * @param snap
6616 */
6617void MachineConfigFile::buildSnapshotXML(uint32_t depth,
6618 xml::ElementNode &elmParent,
6619 const Snapshot &snap)
6620{
6621 if (depth > SETTINGS_SNAPSHOT_DEPTH_MAX)
6622 throw ConfigFileError(this, NULL, N_("Maximum snapshot tree depth of %u exceeded"), SETTINGS_SNAPSHOT_DEPTH_MAX);
6623
6624 xml::ElementNode *pelmSnapshot = elmParent.createChild("Snapshot");
6625
6626 pelmSnapshot->setAttribute("uuid", snap.uuid.toStringCurly());
6627 pelmSnapshot->setAttribute("name", snap.strName);
6628 pelmSnapshot->setAttribute("timeStamp", stringifyTimestamp(snap.timestamp));
6629
6630 if (snap.strStateFile.length())
6631 pelmSnapshot->setAttributePath("stateFile", snap.strStateFile);
6632
6633 if (snap.strDescription.length())
6634 pelmSnapshot->createChild("Description")->addContent(snap.strDescription);
6635
6636 // We only skip removable media for OVF, but OVF never includes snapshots.
6637 buildHardwareXML(*pelmSnapshot, snap.hardware, 0 /* fl */, NULL /* pllElementsWithUuidAttributes */);
6638 buildDebuggingXML(pelmSnapshot, &snap.debugging);
6639 buildAutostartXML(pelmSnapshot, &snap.autostart);
6640 // note: Groups exist only for Machine, not for Snapshot
6641
6642 if (snap.llChildSnapshots.size())
6643 {
6644 xml::ElementNode *pelmChildren = pelmSnapshot->createChild("Snapshots");
6645 for (SnapshotsList::const_iterator it = snap.llChildSnapshots.begin();
6646 it != snap.llChildSnapshots.end();
6647 ++it)
6648 {
6649 const Snapshot &child = *it;
6650 buildSnapshotXML(depth + 1, *pelmChildren, child);
6651 }
6652 }
6653}
6654
6655/**
6656 * Builds the XML DOM tree for the machine config under the given XML element.
6657 *
6658 * This has been separated out from write() so it can be called from elsewhere,
6659 * such as the OVF code, to build machine XML in an existing XML tree.
6660 *
6661 * As a result, this gets called from two locations:
6662 *
6663 * -- MachineConfigFile::write();
6664 *
6665 * -- Appliance::buildXMLForOneVirtualSystem()
6666 *
6667 * In fl, the following flag bits are recognized:
6668 *
6669 * -- BuildMachineXML_MediaRegistry: If set, the machine's media registry will
6670 * be written, if present. This is not set when called from OVF because OVF
6671 * has its own variant of a media registry. This flag is ignored unless the
6672 * settings version is at least v1.11 (VirtualBox 4.0).
6673 *
6674 * -- BuildMachineXML_IncludeSnapshots: If set, descend into the snapshots tree
6675 * of the machine and write out \<Snapshot\> and possibly more snapshots under
6676 * that, if snapshots are present. Otherwise all snapshots are suppressed
6677 * (when called from OVF).
6678 *
6679 * -- BuildMachineXML_WriteVBoxVersionAttribute: If set, add a settingsVersion
6680 * attribute to the machine tag with the vbox settings version. This is for
6681 * the OVF export case in which we don't have the settings version set in
6682 * the root element.
6683 *
6684 * -- BuildMachineXML_SkipRemovableMedia: If set, removable media attachments
6685 * (DVDs, floppies) are silently skipped. This is for the OVF export case
6686 * until we support copying ISO and RAW media as well. This flag is ignored
6687 * unless the settings version is at least v1.9, which is always the case
6688 * when this gets called for OVF export.
6689 *
6690 * -- BuildMachineXML_SuppressSavedState: If set, the Machine/stateFile
6691 * attribute is never set. This is also for the OVF export case because we
6692 * cannot save states with OVF.
6693 *
6694 * @param elmMachine XML \<Machine\> element to add attributes and elements to.
6695 * @param fl Flags.
6696 * @param pllElementsWithUuidAttributes pointer to list that should receive UUID elements or NULL;
6697 * see buildStorageControllersXML() for details.
6698 */
6699void MachineConfigFile::buildMachineXML(xml::ElementNode &elmMachine,
6700 uint32_t fl,
6701 std::list<xml::ElementNode*> *pllElementsWithUuidAttributes)
6702{
6703 if (fl & BuildMachineXML_WriteVBoxVersionAttribute)
6704 {
6705 // add settings version attribute to machine element
6706 setVersionAttribute(elmMachine);
6707 LogRel(("Exporting settings file \"%s\" with version \"%s\"\n", m->strFilename.c_str(), m->strSettingsVersionFull.c_str()));
6708 }
6709
6710 elmMachine.setAttribute("uuid", uuid.toStringCurly());
6711 elmMachine.setAttribute("name", machineUserData.strName);
6712 if (machineUserData.fDirectoryIncludesUUID)
6713 elmMachine.setAttribute("directoryIncludesUUID", machineUserData.fDirectoryIncludesUUID);
6714 if (!machineUserData.fNameSync)
6715 elmMachine.setAttribute("nameSync", machineUserData.fNameSync);
6716 if (machineUserData.strDescription.length())
6717 elmMachine.createChild("Description")->addContent(machineUserData.strDescription);
6718 elmMachine.setAttribute("OSType", machineUserData.strOsType);
6719 if ( strStateFile.length()
6720 && !(fl & BuildMachineXML_SuppressSavedState)
6721 )
6722 elmMachine.setAttributePath("stateFile", strStateFile);
6723
6724 if ((fl & BuildMachineXML_IncludeSnapshots)
6725 && !uuidCurrentSnapshot.isZero()
6726 && uuidCurrentSnapshot.isValid())
6727 elmMachine.setAttribute("currentSnapshot", uuidCurrentSnapshot.toStringCurly());
6728
6729 if (machineUserData.strSnapshotFolder.length())
6730 elmMachine.setAttributePath("snapshotFolder", machineUserData.strSnapshotFolder);
6731 if (!fCurrentStateModified)
6732 elmMachine.setAttribute("currentStateModified", fCurrentStateModified);
6733 elmMachine.setAttribute("lastStateChange", stringifyTimestamp(timeLastStateChange));
6734 if (fAborted)
6735 elmMachine.setAttribute("aborted", fAborted);
6736 if (machineUserData.strVMPriority.length())
6737 elmMachine.setAttribute("processPriority", machineUserData.strVMPriority);
6738 // Please keep the icon last so that one doesn't have to check if there
6739 // is anything in the line after this very long attribute in the XML.
6740 if (machineUserData.ovIcon.size())
6741 {
6742 Utf8Str strIcon;
6743 toBase64(strIcon, machineUserData.ovIcon);
6744 elmMachine.setAttribute("icon", strIcon);
6745 }
6746 if ( m->sv >= SettingsVersion_v1_9
6747 && ( machineUserData.fTeleporterEnabled
6748 || machineUserData.uTeleporterPort
6749 || !machineUserData.strTeleporterAddress.isEmpty()
6750 || !machineUserData.strTeleporterPassword.isEmpty()
6751 )
6752 )
6753 {
6754 xml::ElementNode *pelmTeleporter = elmMachine.createChild("Teleporter");
6755 pelmTeleporter->setAttribute("enabled", machineUserData.fTeleporterEnabled);
6756 pelmTeleporter->setAttribute("port", machineUserData.uTeleporterPort);
6757 pelmTeleporter->setAttribute("address", machineUserData.strTeleporterAddress);
6758 pelmTeleporter->setAttribute("password", machineUserData.strTeleporterPassword);
6759 }
6760
6761 if ( m->sv >= SettingsVersion_v1_11
6762 && ( machineUserData.enmFaultToleranceState != FaultToleranceState_Inactive
6763 || machineUserData.uFaultTolerancePort
6764 || machineUserData.uFaultToleranceInterval
6765 || !machineUserData.strFaultToleranceAddress.isEmpty()
6766 )
6767 )
6768 {
6769 xml::ElementNode *pelmFaultTolerance = elmMachine.createChild("FaultTolerance");
6770 switch (machineUserData.enmFaultToleranceState)
6771 {
6772 case FaultToleranceState_Inactive:
6773 pelmFaultTolerance->setAttribute("state", "inactive");
6774 break;
6775 case FaultToleranceState_Master:
6776 pelmFaultTolerance->setAttribute("state", "master");
6777 break;
6778 case FaultToleranceState_Standby:
6779 pelmFaultTolerance->setAttribute("state", "standby");
6780 break;
6781 }
6782
6783 pelmFaultTolerance->setAttribute("port", machineUserData.uFaultTolerancePort);
6784 pelmFaultTolerance->setAttribute("address", machineUserData.strFaultToleranceAddress);
6785 pelmFaultTolerance->setAttribute("interval", machineUserData.uFaultToleranceInterval);
6786 pelmFaultTolerance->setAttribute("password", machineUserData.strFaultTolerancePassword);
6787 }
6788
6789 if ( (fl & BuildMachineXML_MediaRegistry)
6790 && (m->sv >= SettingsVersion_v1_11)
6791 )
6792 buildMediaRegistry(elmMachine, mediaRegistry);
6793
6794 buildExtraData(elmMachine, mapExtraDataItems);
6795
6796 if ( (fl & BuildMachineXML_IncludeSnapshots)
6797 && llFirstSnapshot.size())
6798 buildSnapshotXML(1, elmMachine, llFirstSnapshot.front());
6799
6800 buildHardwareXML(elmMachine, hardwareMachine, fl, pllElementsWithUuidAttributes);
6801 buildDebuggingXML(&elmMachine, &debugging);
6802 buildAutostartXML(&elmMachine, &autostart);
6803 buildGroupsXML(&elmMachine, &machineUserData.llGroups);
6804}
6805
6806/**
6807 * Returns true only if the given AudioDriverType is supported on
6808 * the current host platform. For example, this would return false
6809 * for AudioDriverType_DirectSound when compiled on a Linux host.
6810 * @param drv AudioDriverType_* enum to test.
6811 * @return true only if the current host supports that driver.
6812 */
6813/*static*/
6814bool MachineConfigFile::isAudioDriverAllowedOnThisHost(AudioDriverType_T drv)
6815{
6816 switch (drv)
6817 {
6818 case AudioDriverType_Null:
6819#ifdef RT_OS_WINDOWS
6820 case AudioDriverType_DirectSound:
6821#endif
6822#ifdef VBOX_WITH_AUDIO_OSS
6823 case AudioDriverType_OSS:
6824#endif
6825#ifdef VBOX_WITH_AUDIO_ALSA
6826 case AudioDriverType_ALSA:
6827#endif
6828#ifdef VBOX_WITH_AUDIO_PULSE
6829 case AudioDriverType_Pulse:
6830#endif
6831#ifdef RT_OS_DARWIN
6832 case AudioDriverType_CoreAudio:
6833#endif
6834#ifdef RT_OS_OS2
6835 case AudioDriverType_MMPM:
6836#endif
6837 return true;
6838 default: break; /* Shut up MSC. */
6839 }
6840
6841 return false;
6842}
6843
6844/**
6845 * Returns the AudioDriverType_* which should be used by default on this
6846 * host platform. On Linux, this will check at runtime whether PulseAudio
6847 * or ALSA are actually supported on the first call.
6848 *
6849 * @return Default audio driver type for this host platform.
6850 */
6851/*static*/
6852AudioDriverType_T MachineConfigFile::getHostDefaultAudioDriver()
6853{
6854#if defined(RT_OS_WINDOWS)
6855 return AudioDriverType_DirectSound;
6856
6857#elif defined(RT_OS_LINUX)
6858 /* On Linux, we need to check at runtime what's actually supported. */
6859 static RTCLockMtx s_mtx;
6860 static AudioDriverType_T s_linuxDriver = -1;
6861 RTCLock lock(s_mtx);
6862 if (s_linuxDriver == (AudioDriverType_T)-1)
6863 {
6864# ifdef VBOX_WITH_AUDIO_PULSE
6865 /* Check for the pulse library & that the pulse audio daemon is running. */
6866 if (RTProcIsRunningByName("pulseaudio") &&
6867 RTLdrIsLoadable("libpulse.so.0"))
6868 s_linuxDriver = AudioDriverType_Pulse;
6869 else
6870# endif /* VBOX_WITH_AUDIO_PULSE */
6871# ifdef VBOX_WITH_AUDIO_ALSA
6872 /* Check if we can load the ALSA library */
6873 if (RTLdrIsLoadable("libasound.so.2"))
6874 s_linuxDriver = AudioDriverType_ALSA;
6875 else
6876# endif /* VBOX_WITH_AUDIO_ALSA */
6877 s_linuxDriver = AudioDriverType_OSS;
6878 }
6879 return s_linuxDriver;
6880
6881#elif defined(RT_OS_DARWIN)
6882 return AudioDriverType_CoreAudio;
6883
6884#elif defined(RT_OS_OS2)
6885 return AudioDriverType_MMPM;
6886
6887#else /* All other platforms. */
6888# ifdef VBOX_WITH_AUDIO_OSS
6889 return AudioDriverType_OSS;
6890# else
6891 /* Return NULL driver as a fallback if nothing of the above is available. */
6892 return AudioDriverType_Null;
6893# endif
6894#endif
6895}
6896
6897/**
6898 * Called from write() before calling ConfigFileBase::createStubDocument().
6899 * This adjusts the settings version in m->sv if incompatible settings require
6900 * a settings bump, whereas otherwise we try to preserve the settings version
6901 * to avoid breaking compatibility with older versions.
6902 *
6903 * We do the checks in here in reverse order: newest first, oldest last, so
6904 * that we avoid unnecessary checks since some of these are expensive.
6905 */
6906void MachineConfigFile::bumpSettingsVersionIfNeeded()
6907{
6908 if (m->sv < SettingsVersion_v1_16)
6909 {
6910 // VirtualBox 5.1 adds a NVMe storage controller, paravirt debug
6911 // options, cpu profile, APIC settings (CPU capability and BIOS).
6912
6913 if ( hardwareMachine.strParavirtDebug.isNotEmpty()
6914 || (!hardwareMachine.strCpuProfile.equals("host") && hardwareMachine.strCpuProfile.isNotEmpty())
6915 || hardwareMachine.biosSettings.apicMode != APICMode_APIC
6916 || !hardwareMachine.fAPIC
6917 || hardwareMachine.fX2APIC)
6918 {
6919 m->sv = SettingsVersion_v1_16;
6920 return;
6921 }
6922
6923 for (StorageControllersList::const_iterator it = hardwareMachine.storage.llStorageControllers.begin();
6924 it != hardwareMachine.storage.llStorageControllers.end();
6925 ++it)
6926 {
6927 const StorageController &sctl = *it;
6928
6929 if (sctl.controllerType == StorageControllerType_NVMe)
6930 {
6931 m->sv = SettingsVersion_v1_16;
6932 return;
6933 }
6934 }
6935 }
6936
6937 if (m->sv < SettingsVersion_v1_15)
6938 {
6939 // VirtualBox 5.0 adds paravirt providers, explicit AHCI port hotplug
6940 // setting, USB storage controller, xHCI, serial port TCP backend
6941 // and VM process priority.
6942
6943 /*
6944 * Check simple configuration bits first, loopy stuff afterwards.
6945 */
6946 if ( hardwareMachine.paravirtProvider != ParavirtProvider_Legacy
6947 || hardwareMachine.uCpuIdPortabilityLevel != 0
6948 || machineUserData.strVMPriority.length())
6949 {
6950 m->sv = SettingsVersion_v1_15;
6951 return;
6952 }
6953
6954 /*
6955 * Check whether the hotpluggable flag of all storage devices differs
6956 * from the default for old settings.
6957 * AHCI ports are hotpluggable by default every other device is not.
6958 * Also check if there are USB storage controllers.
6959 */
6960 for (StorageControllersList::const_iterator it = hardwareMachine.storage.llStorageControllers.begin();
6961 it != hardwareMachine.storage.llStorageControllers.end();
6962 ++it)
6963 {
6964 const StorageController &sctl = *it;
6965
6966 if (sctl.controllerType == StorageControllerType_USB)
6967 {
6968 m->sv = SettingsVersion_v1_15;
6969 return;
6970 }
6971
6972 for (AttachedDevicesList::const_iterator it2 = sctl.llAttachedDevices.begin();
6973 it2 != sctl.llAttachedDevices.end();
6974 ++it2)
6975 {
6976 const AttachedDevice &att = *it2;
6977
6978 if ( ( att.fHotPluggable
6979 && sctl.controllerType != StorageControllerType_IntelAhci)
6980 || ( !att.fHotPluggable
6981 && sctl.controllerType == StorageControllerType_IntelAhci))
6982 {
6983 m->sv = SettingsVersion_v1_15;
6984 return;
6985 }
6986 }
6987 }
6988
6989 /*
6990 * Check if there is an xHCI (USB3) USB controller.
6991 */
6992 for (USBControllerList::const_iterator it = hardwareMachine.usbSettings.llUSBControllers.begin();
6993 it != hardwareMachine.usbSettings.llUSBControllers.end();
6994 ++it)
6995 {
6996 const USBController &ctrl = *it;
6997 if (ctrl.enmType == USBControllerType_XHCI)
6998 {
6999 m->sv = SettingsVersion_v1_15;
7000 return;
7001 }
7002 }
7003
7004 /*
7005 * Check if any serial port uses the TCP backend.
7006 */
7007 for (SerialPortsList::const_iterator it = hardwareMachine.llSerialPorts.begin();
7008 it != hardwareMachine.llSerialPorts.end();
7009 ++it)
7010 {
7011 const SerialPort &port = *it;
7012 if (port.portMode == PortMode_TCP)
7013 {
7014 m->sv = SettingsVersion_v1_15;
7015 return;
7016 }
7017 }
7018 }
7019
7020 if (m->sv < SettingsVersion_v1_14)
7021 {
7022 // VirtualBox 4.3 adds default frontend setting, graphics controller
7023 // setting, explicit long mode setting, video capturing and NAT networking.
7024 if ( !hardwareMachine.strDefaultFrontend.isEmpty()
7025 || hardwareMachine.graphicsControllerType != GraphicsControllerType_VBoxVGA
7026 || hardwareMachine.enmLongMode != Hardware::LongMode_Legacy
7027 || machineUserData.ovIcon.size() > 0
7028 || hardwareMachine.fVideoCaptureEnabled)
7029 {
7030 m->sv = SettingsVersion_v1_14;
7031 return;
7032 }
7033 NetworkAdaptersList::const_iterator netit;
7034 for (netit = hardwareMachine.llNetworkAdapters.begin();
7035 netit != hardwareMachine.llNetworkAdapters.end();
7036 ++netit)
7037 {
7038 if (netit->mode == NetworkAttachmentType_NATNetwork)
7039 {
7040 m->sv = SettingsVersion_v1_14;
7041 break;
7042 }
7043 }
7044 }
7045
7046 if (m->sv < SettingsVersion_v1_14)
7047 {
7048 unsigned cOhciCtrls = 0;
7049 unsigned cEhciCtrls = 0;
7050 bool fNonStdName = false;
7051
7052 for (USBControllerList::const_iterator it = hardwareMachine.usbSettings.llUSBControllers.begin();
7053 it != hardwareMachine.usbSettings.llUSBControllers.end();
7054 ++it)
7055 {
7056 const USBController &ctrl = *it;
7057
7058 switch (ctrl.enmType)
7059 {
7060 case USBControllerType_OHCI:
7061 cOhciCtrls++;
7062 if (ctrl.strName != "OHCI")
7063 fNonStdName = true;
7064 break;
7065 case USBControllerType_EHCI:
7066 cEhciCtrls++;
7067 if (ctrl.strName != "EHCI")
7068 fNonStdName = true;
7069 break;
7070 default:
7071 /* Anything unknown forces a bump. */
7072 fNonStdName = true;
7073 }
7074
7075 /* Skip checking other controllers if the settings bump is necessary. */
7076 if (cOhciCtrls > 1 || cEhciCtrls > 1 || fNonStdName)
7077 {
7078 m->sv = SettingsVersion_v1_14;
7079 break;
7080 }
7081 }
7082 }
7083
7084 if (m->sv < SettingsVersion_v1_13)
7085 {
7086 // VirtualBox 4.2 adds tracing, autostart, UUID in directory and groups.
7087 if ( !debugging.areDefaultSettings()
7088 || !autostart.areDefaultSettings()
7089 || machineUserData.fDirectoryIncludesUUID
7090 || machineUserData.llGroups.size() > 1
7091 || machineUserData.llGroups.front() != "/")
7092 m->sv = SettingsVersion_v1_13;
7093 }
7094
7095 if (m->sv < SettingsVersion_v1_13)
7096 {
7097 // VirtualBox 4.2 changes the units for bandwidth group limits.
7098 for (BandwidthGroupList::const_iterator it = hardwareMachine.ioSettings.llBandwidthGroups.begin();
7099 it != hardwareMachine.ioSettings.llBandwidthGroups.end();
7100 ++it)
7101 {
7102 const BandwidthGroup &gr = *it;
7103 if (gr.cMaxBytesPerSec % _1M)
7104 {
7105 // Bump version if a limit cannot be expressed in megabytes
7106 m->sv = SettingsVersion_v1_13;
7107 break;
7108 }
7109 }
7110 }
7111
7112 if (m->sv < SettingsVersion_v1_12)
7113 {
7114 // VirtualBox 4.1 adds PCI passthrough and emulated USB Smart Card reader
7115 if ( hardwareMachine.pciAttachments.size()
7116 || hardwareMachine.fEmulatedUSBCardReader)
7117 m->sv = SettingsVersion_v1_12;
7118 }
7119
7120 if (m->sv < SettingsVersion_v1_12)
7121 {
7122 // VirtualBox 4.1 adds a promiscuous mode policy to the network
7123 // adapters and a generic network driver transport.
7124 NetworkAdaptersList::const_iterator netit;
7125 for (netit = hardwareMachine.llNetworkAdapters.begin();
7126 netit != hardwareMachine.llNetworkAdapters.end();
7127 ++netit)
7128 {
7129 if ( netit->enmPromiscModePolicy != NetworkAdapterPromiscModePolicy_Deny
7130 || netit->mode == NetworkAttachmentType_Generic
7131 || !netit->areGenericDriverDefaultSettings()
7132 )
7133 {
7134 m->sv = SettingsVersion_v1_12;
7135 break;
7136 }
7137 }
7138 }
7139
7140 if (m->sv < SettingsVersion_v1_11)
7141 {
7142 // VirtualBox 4.0 adds HD audio, CPU priorities, fault tolerance,
7143 // per-machine media registries, VRDE, JRockitVE, bandwidth groups,
7144 // ICH9 chipset
7145 if ( hardwareMachine.audioAdapter.controllerType == AudioControllerType_HDA
7146 || hardwareMachine.ulCpuExecutionCap != 100
7147 || machineUserData.enmFaultToleranceState != FaultToleranceState_Inactive
7148 || machineUserData.uFaultTolerancePort
7149 || machineUserData.uFaultToleranceInterval
7150 || !machineUserData.strFaultToleranceAddress.isEmpty()
7151 || mediaRegistry.llHardDisks.size()
7152 || mediaRegistry.llDvdImages.size()
7153 || mediaRegistry.llFloppyImages.size()
7154 || !hardwareMachine.vrdeSettings.strVrdeExtPack.isEmpty()
7155 || !hardwareMachine.vrdeSettings.strAuthLibrary.isEmpty()
7156 || machineUserData.strOsType == "JRockitVE"
7157 || hardwareMachine.ioSettings.llBandwidthGroups.size()
7158 || hardwareMachine.chipsetType == ChipsetType_ICH9
7159 )
7160 m->sv = SettingsVersion_v1_11;
7161 }
7162
7163 if (m->sv < SettingsVersion_v1_10)
7164 {
7165 /* If the properties contain elements other than "TCP/Ports" and "TCP/Address",
7166 * then increase the version to at least VBox 3.2, which can have video channel properties.
7167 */
7168 unsigned cOldProperties = 0;
7169
7170 StringsMap::const_iterator it = hardwareMachine.vrdeSettings.mapProperties.find("TCP/Ports");
7171 if (it != hardwareMachine.vrdeSettings.mapProperties.end())
7172 cOldProperties++;
7173 it = hardwareMachine.vrdeSettings.mapProperties.find("TCP/Address");
7174 if (it != hardwareMachine.vrdeSettings.mapProperties.end())
7175 cOldProperties++;
7176
7177 if (hardwareMachine.vrdeSettings.mapProperties.size() != cOldProperties)
7178 m->sv = SettingsVersion_v1_10;
7179 }
7180
7181 if (m->sv < SettingsVersion_v1_11)
7182 {
7183 /* If the properties contain elements other than "TCP/Ports", "TCP/Address",
7184 * "VideoChannel/Enabled" and "VideoChannel/Quality" then increase the version to VBox 4.0.
7185 */
7186 unsigned cOldProperties = 0;
7187
7188 StringsMap::const_iterator it = hardwareMachine.vrdeSettings.mapProperties.find("TCP/Ports");
7189 if (it != hardwareMachine.vrdeSettings.mapProperties.end())
7190 cOldProperties++;
7191 it = hardwareMachine.vrdeSettings.mapProperties.find("TCP/Address");
7192 if (it != hardwareMachine.vrdeSettings.mapProperties.end())
7193 cOldProperties++;
7194 it = hardwareMachine.vrdeSettings.mapProperties.find("VideoChannel/Enabled");
7195 if (it != hardwareMachine.vrdeSettings.mapProperties.end())
7196 cOldProperties++;
7197 it = hardwareMachine.vrdeSettings.mapProperties.find("VideoChannel/Quality");
7198 if (it != hardwareMachine.vrdeSettings.mapProperties.end())
7199 cOldProperties++;
7200
7201 if (hardwareMachine.vrdeSettings.mapProperties.size() != cOldProperties)
7202 m->sv = SettingsVersion_v1_11;
7203 }
7204
7205 // settings version 1.9 is required if there is not exactly one DVD
7206 // or more than one floppy drive present or the DVD is not at the secondary
7207 // master; this check is a bit more complicated
7208 //
7209 // settings version 1.10 is required if the host cache should be disabled
7210 //
7211 // settings version 1.11 is required for bandwidth limits and if more than
7212 // one controller of each type is present.
7213 if (m->sv < SettingsVersion_v1_11)
7214 {
7215 // count attached DVDs and floppies (only if < v1.9)
7216 size_t cDVDs = 0;
7217 size_t cFloppies = 0;
7218
7219 // count storage controllers (if < v1.11)
7220 size_t cSata = 0;
7221 size_t cScsiLsi = 0;
7222 size_t cScsiBuslogic = 0;
7223 size_t cSas = 0;
7224 size_t cIde = 0;
7225 size_t cFloppy = 0;
7226
7227 // need to run thru all the storage controllers and attached devices to figure this out
7228 for (StorageControllersList::const_iterator it = hardwareMachine.storage.llStorageControllers.begin();
7229 it != hardwareMachine.storage.llStorageControllers.end();
7230 ++it)
7231 {
7232 const StorageController &sctl = *it;
7233
7234 // count storage controllers of each type; 1.11 is required if more than one
7235 // controller of one type is present
7236 switch (sctl.storageBus)
7237 {
7238 case StorageBus_IDE:
7239 cIde++;
7240 break;
7241 case StorageBus_SATA:
7242 cSata++;
7243 break;
7244 case StorageBus_SAS:
7245 cSas++;
7246 break;
7247 case StorageBus_SCSI:
7248 if (sctl.controllerType == StorageControllerType_LsiLogic)
7249 cScsiLsi++;
7250 else
7251 cScsiBuslogic++;
7252 break;
7253 case StorageBus_Floppy:
7254 cFloppy++;
7255 break;
7256 default:
7257 // Do nothing
7258 break;
7259 }
7260
7261 if ( cSata > 1
7262 || cScsiLsi > 1
7263 || cScsiBuslogic > 1
7264 || cSas > 1
7265 || cIde > 1
7266 || cFloppy > 1)
7267 {
7268 m->sv = SettingsVersion_v1_11;
7269 break; // abort the loop -- we will not raise the version further
7270 }
7271
7272 for (AttachedDevicesList::const_iterator it2 = sctl.llAttachedDevices.begin();
7273 it2 != sctl.llAttachedDevices.end();
7274 ++it2)
7275 {
7276 const AttachedDevice &att = *it2;
7277
7278 // Bandwidth limitations are new in VirtualBox 4.0 (1.11)
7279 if (m->sv < SettingsVersion_v1_11)
7280 {
7281 if (att.strBwGroup.length() != 0)
7282 {
7283 m->sv = SettingsVersion_v1_11;
7284 break; // abort the loop -- we will not raise the version further
7285 }
7286 }
7287
7288 // disabling the host IO cache requires settings version 1.10
7289 if ( (m->sv < SettingsVersion_v1_10)
7290 && (!sctl.fUseHostIOCache)
7291 )
7292 m->sv = SettingsVersion_v1_10;
7293
7294 // we can only write the StorageController/@Instance attribute with v1.9
7295 if ( (m->sv < SettingsVersion_v1_9)
7296 && (sctl.ulInstance != 0)
7297 )
7298 m->sv = SettingsVersion_v1_9;
7299
7300 if (m->sv < SettingsVersion_v1_9)
7301 {
7302 if (att.deviceType == DeviceType_DVD)
7303 {
7304 if ( (sctl.storageBus != StorageBus_IDE) // DVD at bus other than DVD?
7305 || (att.lPort != 1) // DVDs not at secondary master?
7306 || (att.lDevice != 0)
7307 )
7308 m->sv = SettingsVersion_v1_9;
7309
7310 ++cDVDs;
7311 }
7312 else if (att.deviceType == DeviceType_Floppy)
7313 ++cFloppies;
7314 }
7315 }
7316
7317 if (m->sv >= SettingsVersion_v1_11)
7318 break; // abort the loop -- we will not raise the version further
7319 }
7320
7321 // VirtualBox before 3.1 had zero or one floppy and exactly one DVD,
7322 // so any deviation from that will require settings version 1.9
7323 if ( (m->sv < SettingsVersion_v1_9)
7324 && ( (cDVDs != 1)
7325 || (cFloppies > 1)
7326 )
7327 )
7328 m->sv = SettingsVersion_v1_9;
7329 }
7330
7331 // VirtualBox 3.2: Check for non default I/O settings
7332 if (m->sv < SettingsVersion_v1_10)
7333 {
7334 if ( (hardwareMachine.ioSettings.fIOCacheEnabled != true)
7335 || (hardwareMachine.ioSettings.ulIOCacheSize != 5)
7336 // and page fusion
7337 || (hardwareMachine.fPageFusionEnabled)
7338 // and CPU hotplug, RTC timezone control, HID type and HPET
7339 || machineUserData.fRTCUseUTC
7340 || hardwareMachine.fCpuHotPlug
7341 || hardwareMachine.pointingHIDType != PointingHIDType_PS2Mouse
7342 || hardwareMachine.keyboardHIDType != KeyboardHIDType_PS2Keyboard
7343 || hardwareMachine.fHPETEnabled
7344 )
7345 m->sv = SettingsVersion_v1_10;
7346 }
7347
7348 // VirtualBox 3.2 adds NAT and boot priority to the NIC config in Main
7349 // VirtualBox 4.0 adds network bandwitdth
7350 if (m->sv < SettingsVersion_v1_11)
7351 {
7352 NetworkAdaptersList::const_iterator netit;
7353 for (netit = hardwareMachine.llNetworkAdapters.begin();
7354 netit != hardwareMachine.llNetworkAdapters.end();
7355 ++netit)
7356 {
7357 if ( (m->sv < SettingsVersion_v1_12)
7358 && (netit->strBandwidthGroup.isNotEmpty())
7359 )
7360 {
7361 /* New in VirtualBox 4.1 */
7362 m->sv = SettingsVersion_v1_12;
7363 break;
7364 }
7365 else if ( (m->sv < SettingsVersion_v1_10)
7366 && (netit->fEnabled)
7367 && (netit->mode == NetworkAttachmentType_NAT)
7368 && ( netit->nat.u32Mtu != 0
7369 || netit->nat.u32SockRcv != 0
7370 || netit->nat.u32SockSnd != 0
7371 || netit->nat.u32TcpRcv != 0
7372 || netit->nat.u32TcpSnd != 0
7373 || !netit->nat.fDNSPassDomain
7374 || netit->nat.fDNSProxy
7375 || netit->nat.fDNSUseHostResolver
7376 || netit->nat.fAliasLog
7377 || netit->nat.fAliasProxyOnly
7378 || netit->nat.fAliasUseSamePorts
7379 || netit->nat.strTFTPPrefix.length()
7380 || netit->nat.strTFTPBootFile.length()
7381 || netit->nat.strTFTPNextServer.length()
7382 || netit->nat.mapRules.size()
7383 )
7384 )
7385 {
7386 m->sv = SettingsVersion_v1_10;
7387 // no break because we still might need v1.11 above
7388 }
7389 else if ( (m->sv < SettingsVersion_v1_10)
7390 && (netit->fEnabled)
7391 && (netit->ulBootPriority != 0)
7392 )
7393 {
7394 m->sv = SettingsVersion_v1_10;
7395 // no break because we still might need v1.11 above
7396 }
7397 }
7398 }
7399
7400 // all the following require settings version 1.9
7401 if ( (m->sv < SettingsVersion_v1_9)
7402 && ( (hardwareMachine.firmwareType >= FirmwareType_EFI)
7403 || machineUserData.fTeleporterEnabled
7404 || machineUserData.uTeleporterPort
7405 || !machineUserData.strTeleporterAddress.isEmpty()
7406 || !machineUserData.strTeleporterPassword.isEmpty()
7407 || (!hardwareMachine.uuid.isZero() && hardwareMachine.uuid.isValid())
7408 )
7409 )
7410 m->sv = SettingsVersion_v1_9;
7411
7412 // "accelerate 2d video" requires settings version 1.8
7413 if ( (m->sv < SettingsVersion_v1_8)
7414 && (hardwareMachine.fAccelerate2DVideo)
7415 )
7416 m->sv = SettingsVersion_v1_8;
7417
7418 // The hardware versions other than "1" requires settings version 1.4 (2.1+).
7419 if ( m->sv < SettingsVersion_v1_4
7420 && hardwareMachine.strVersion != "1"
7421 )
7422 m->sv = SettingsVersion_v1_4;
7423}
7424
7425/**
7426 * Called from Main code to write a machine config file to disk. This builds a DOM tree from
7427 * the member variables and then writes the XML file; it throws xml::Error instances on errors,
7428 * in particular if the file cannot be written.
7429 */
7430void MachineConfigFile::write(const com::Utf8Str &strFilename)
7431{
7432 try
7433 {
7434 // createStubDocument() sets the settings version to at least 1.7; however,
7435 // we might need to enfore a later settings version if incompatible settings
7436 // are present:
7437 bumpSettingsVersionIfNeeded();
7438
7439 m->strFilename = strFilename;
7440 specialBackupIfFirstBump();
7441 createStubDocument();
7442
7443 xml::ElementNode *pelmMachine = m->pelmRoot->createChild("Machine");
7444 buildMachineXML(*pelmMachine,
7445 MachineConfigFile::BuildMachineXML_IncludeSnapshots
7446 | MachineConfigFile::BuildMachineXML_MediaRegistry,
7447 // but not BuildMachineXML_WriteVBoxVersionAttribute
7448 NULL); /* pllElementsWithUuidAttributes */
7449
7450 // now go write the XML
7451 xml::XmlFileWriter writer(*m->pDoc);
7452 writer.write(m->strFilename.c_str(), true /*fSafe*/);
7453
7454 m->fFileExists = true;
7455 clearDocument();
7456 }
7457 catch (...)
7458 {
7459 clearDocument();
7460 throw;
7461 }
7462}
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette