VirtualBox

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

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

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