VirtualBox

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

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

Setings: add multi-touch setting and fix combo mouse somewhat.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Date Revision Author Id
File size: 230.4 KB
Line 
1/* $Id: Settings.cpp 47246 2013-07-19 09:43:01Z 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.GlobalDhcpOptions[DhcpOpt_SubnetMask]))
1305 && (pelmServer->getAttributeValue("lowerIP", srv.strIPLower))
1306 && (pelmServer->getAttributeValue("upperIP", srv.strIPUpper))
1307 && (pelmServer->getAttributeValue("enabled", srv.fEnabled))
1308 )
1309 {
1310 xml::NodesLoop nlOptions(*pelmServer, "Options");
1311 const xml::ElementNode *options;
1312 /* XXX: Options are in 1:1 relation to DHCPServer */
1313
1314 while ((options = nlOptions.forAllNodes()))
1315 {
1316 readDhcpOptions(srv.GlobalDhcpOptions, *options);
1317 } /* end of forall("Options") */
1318 xml::NodesLoop nlConfig(*pelmServer, "Config");
1319 const xml::ElementNode *cfg;
1320 while ((cfg = nlConfig.forAllNodes()))
1321 {
1322 com::Utf8Str strVmName;
1323 uint32_t u32Slot;
1324 cfg->getAttributeValue("vm-name", strVmName);
1325 cfg->getAttributeValue("slot", (uint32_t&)u32Slot);
1326 readDhcpOptions(srv.VmSlot2OptionsM[VmNameSlotKey(strVmName, u32Slot)],
1327 *cfg);
1328 }
1329 llDhcpServers.push_back(srv);
1330 }
1331 else
1332 throw ConfigFileError(this, pelmServer, N_("Required DHCPServer/@networkName, @IPAddress, @networkMask, @lowerIP, @upperIP or @enabled attribute is missing"));
1333 }
1334 }
1335}
1336
1337void MainConfigFile::readDhcpOptions(DhcpOptionMap& map,
1338 const xml::ElementNode& options)
1339{
1340 xml::NodesLoop nl2(options, "Option");
1341 const xml::ElementNode *opt;
1342 while((opt = nl2.forAllNodes()))
1343 {
1344 DhcpOpt_T OptName;
1345 com::Utf8Str OptValue;
1346 opt->getAttributeValue("name", (uint32_t&)OptName);
1347
1348 if (OptName == DhcpOpt_SubnetMask)
1349 continue;
1350
1351 opt->getAttributeValue("value", OptValue);
1352
1353 map.insert(
1354 std::map<DhcpOpt_T, Utf8Str>::value_type(OptName, OptValue));
1355 } /* end of forall("Option") */
1356
1357}
1358
1359/**
1360 * Reads in the <NATNetworks> chunk.
1361 * @param elmNATNetworks
1362 */
1363void MainConfigFile::readNATNetworks(const xml::ElementNode &elmNATNetworks)
1364{
1365 xml::NodesLoop nl1(elmNATNetworks);
1366 const xml::ElementNode *pelmNet;
1367 while ((pelmNet = nl1.forAllNodes()))
1368 {
1369 if (pelmNet->nameEquals("NATNetwork"))
1370 {
1371 NATNetwork net;
1372 if ( (pelmNet->getAttributeValue("networkName", net.strNetworkName))
1373 && (pelmNet->getAttributeValue("enabled", net.fEnabled))
1374 && (pelmNet->getAttributeValue("network", net.strNetwork))
1375 && (pelmNet->getAttributeValue("ipv6", net.fIPv6))
1376 && (pelmNet->getAttributeValue("ipv6prefix", net.strIPv6Prefix))
1377 && (pelmNet->getAttributeValue("advertiseDefaultIPv6Route", net.fAdvertiseDefaultIPv6Route))
1378 && (pelmNet->getAttributeValue("needDhcp", net.fNeedDhcpServer))
1379 )
1380 {
1381 const xml::ElementNode *pelmPortForwardRules4;
1382 if ((pelmPortForwardRules4 = pelmNet->findChildElement("PortForwarding4")))
1383 readNATForwardRuleList(*pelmPortForwardRules4,
1384 net.llPortForwardRules4);
1385
1386 const xml::ElementNode *pelmPortForwardRules6;
1387 if ((pelmPortForwardRules6 = pelmNet->findChildElement("PortForwarding6")))
1388 readNATForwardRuleList(*pelmPortForwardRules6,
1389 net.llPortForwardRules6);
1390
1391 llNATNetworks.push_back(net);
1392 }
1393 else
1394 throw ConfigFileError(this, pelmNet, N_("Required NATNetwork/@networkName, @gateway, @network,@advertiseDefaultIpv6Route , @needDhcp or @enabled attribute is missing"));
1395 }
1396 }
1397}
1398
1399/**
1400 * Constructor.
1401 *
1402 * If pstrFilename is != NULL, this reads the given settings file into the member
1403 * variables and various substructures and lists. Otherwise, the member variables
1404 * are initialized with default values.
1405 *
1406 * Throws variants of xml::Error for I/O, XML and logical content errors, which
1407 * the caller should catch; if this constructor does not throw, then the member
1408 * variables contain meaningful values (either from the file or defaults).
1409 *
1410 * @param strFilename
1411 */
1412MainConfigFile::MainConfigFile(const Utf8Str *pstrFilename)
1413 : ConfigFileBase(pstrFilename)
1414{
1415 if (pstrFilename)
1416 {
1417 // the ConfigFileBase constructor has loaded the XML file, so now
1418 // we need only analyze what is in there
1419 xml::NodesLoop nlRootChildren(*m->pelmRoot);
1420 const xml::ElementNode *pelmRootChild;
1421 while ((pelmRootChild = nlRootChildren.forAllNodes()))
1422 {
1423 if (pelmRootChild->nameEquals("Global"))
1424 {
1425 xml::NodesLoop nlGlobalChildren(*pelmRootChild);
1426 const xml::ElementNode *pelmGlobalChild;
1427 while ((pelmGlobalChild = nlGlobalChildren.forAllNodes()))
1428 {
1429 if (pelmGlobalChild->nameEquals("SystemProperties"))
1430 {
1431 pelmGlobalChild->getAttributeValue("defaultMachineFolder", systemProperties.strDefaultMachineFolder);
1432 pelmGlobalChild->getAttributeValue("LoggingLevel", systemProperties.strLoggingLevel);
1433 pelmGlobalChild->getAttributeValue("defaultHardDiskFormat", systemProperties.strDefaultHardDiskFormat);
1434 if (!pelmGlobalChild->getAttributeValue("VRDEAuthLibrary", systemProperties.strVRDEAuthLibrary))
1435 // pre-1.11 used @remoteDisplayAuthLibrary instead
1436 pelmGlobalChild->getAttributeValue("remoteDisplayAuthLibrary", systemProperties.strVRDEAuthLibrary);
1437 pelmGlobalChild->getAttributeValue("webServiceAuthLibrary", systemProperties.strWebServiceAuthLibrary);
1438 pelmGlobalChild->getAttributeValue("defaultVRDEExtPack", systemProperties.strDefaultVRDEExtPack);
1439 pelmGlobalChild->getAttributeValue("LogHistoryCount", systemProperties.ulLogHistoryCount);
1440 pelmGlobalChild->getAttributeValue("autostartDatabasePath", systemProperties.strAutostartDatabasePath);
1441 pelmGlobalChild->getAttributeValue("defaultFrontend", systemProperties.strDefaultFrontend);
1442 }
1443 else if (pelmGlobalChild->nameEquals("ExtraData"))
1444 readExtraData(*pelmGlobalChild, mapExtraDataItems);
1445 else if (pelmGlobalChild->nameEquals("MachineRegistry"))
1446 readMachineRegistry(*pelmGlobalChild);
1447 else if ( (pelmGlobalChild->nameEquals("MediaRegistry"))
1448 || ( (m->sv < SettingsVersion_v1_4)
1449 && (pelmGlobalChild->nameEquals("DiskRegistry"))
1450 )
1451 )
1452 readMediaRegistry(*pelmGlobalChild, mediaRegistry);
1453 else if (pelmGlobalChild->nameEquals("NetserviceRegistry"))
1454 {
1455 xml::NodesLoop nlLevel4(*pelmGlobalChild);
1456 const xml::ElementNode *pelmLevel4Child;
1457 while ((pelmLevel4Child = nlLevel4.forAllNodes()))
1458 {
1459 if (pelmLevel4Child->nameEquals("DHCPServers"))
1460 readDHCPServers(*pelmLevel4Child);
1461 if (pelmLevel4Child->nameEquals("NATNetworks"))
1462 readNATNetworks(*pelmLevel4Child);
1463 }
1464 }
1465 else if (pelmGlobalChild->nameEquals("USBDeviceFilters"))
1466 readUSBDeviceFilters(*pelmGlobalChild, host.llUSBDeviceFilters);
1467 }
1468 } // end if (pelmRootChild->nameEquals("Global"))
1469 }
1470
1471 clearDocument();
1472 }
1473
1474 // DHCP servers were introduced with settings version 1.7; if we're loading
1475 // from an older version OR this is a fresh install, then add one DHCP server
1476 // with default settings
1477 if ( (!llDhcpServers.size())
1478 && ( (!pstrFilename) // empty VirtualBox.xml file
1479 || (m->sv < SettingsVersion_v1_7) // upgrading from before 1.7
1480 )
1481 )
1482 {
1483 DHCPServer srv;
1484 srv.strNetworkName =
1485#ifdef RT_OS_WINDOWS
1486 "HostInterfaceNetworking-VirtualBox Host-Only Ethernet Adapter";
1487#else
1488 "HostInterfaceNetworking-vboxnet0";
1489#endif
1490 srv.strIPAddress = "192.168.56.100";
1491 srv.GlobalDhcpOptions[DhcpOpt_SubnetMask] = "255.255.255.0";
1492 srv.strIPLower = "192.168.56.101";
1493 srv.strIPUpper = "192.168.56.254";
1494 srv.fEnabled = true;
1495 llDhcpServers.push_back(srv);
1496 }
1497}
1498
1499/**
1500 * Called from the IVirtualBox interface to write out VirtualBox.xml. This
1501 * builds an XML DOM tree and writes it out to disk.
1502 */
1503void MainConfigFile::write(const com::Utf8Str strFilename)
1504{
1505 m->strFilename = strFilename;
1506 createStubDocument();
1507
1508 xml::ElementNode *pelmGlobal = m->pelmRoot->createChild("Global");
1509
1510 buildExtraData(*pelmGlobal, mapExtraDataItems);
1511
1512 xml::ElementNode *pelmMachineRegistry = pelmGlobal->createChild("MachineRegistry");
1513 for (MachinesRegistry::const_iterator it = llMachines.begin();
1514 it != llMachines.end();
1515 ++it)
1516 {
1517 // <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"/>
1518 const MachineRegistryEntry &mre = *it;
1519 xml::ElementNode *pelmMachineEntry = pelmMachineRegistry->createChild("MachineEntry");
1520 pelmMachineEntry->setAttribute("uuid", mre.uuid.toStringCurly());
1521 pelmMachineEntry->setAttribute("src", mre.strSettingsFile);
1522 }
1523
1524 buildMediaRegistry(*pelmGlobal, mediaRegistry);
1525
1526 xml::ElementNode *pelmNetserviceRegistry = pelmGlobal->createChild("NetserviceRegistry");
1527 xml::ElementNode *pelmDHCPServers = pelmNetserviceRegistry->createChild("DHCPServers");
1528 for (DHCPServersList::const_iterator it = llDhcpServers.begin();
1529 it != llDhcpServers.end();
1530 ++it)
1531 {
1532 const DHCPServer &d = *it;
1533 xml::ElementNode *pelmThis = pelmDHCPServers->createChild("DHCPServer");
1534 DhcpOptConstIterator itOpt;
1535 itOpt = d.GlobalDhcpOptions.find(DhcpOpt_SubnetMask);
1536
1537 pelmThis->setAttribute("networkName", d.strNetworkName);
1538 pelmThis->setAttribute("IPAddress", d.strIPAddress);
1539 if (itOpt != d.GlobalDhcpOptions.end())
1540 pelmThis->setAttribute("networkMask", itOpt->second);
1541 pelmThis->setAttribute("lowerIP", d.strIPLower);
1542 pelmThis->setAttribute("upperIP", d.strIPUpper);
1543 pelmThis->setAttribute("enabled", (d.fEnabled) ? 1 : 0); // too bad we chose 1 vs. 0 here
1544 /* We assume that if there're only 1 element it means that */
1545 int cOpt = d.GlobalDhcpOptions.size();
1546 /* We don't want duplicate validation check of networkMask here*/
1547 if ( ( itOpt == d.GlobalDhcpOptions.end()
1548 && cOpt > 0)
1549 || cOpt > 1)
1550 {
1551 xml::ElementNode *pelmOptions = pelmThis->createChild("Options");
1552 for (itOpt = d.GlobalDhcpOptions.begin();
1553 itOpt != d.GlobalDhcpOptions.end();
1554 ++itOpt)
1555 {
1556 if (itOpt->first == DhcpOpt_SubnetMask)
1557 continue;
1558
1559 xml::ElementNode *pelmOpt = pelmOptions->createChild("Option");
1560
1561 if (!pelmOpt)
1562 break;
1563
1564 pelmOpt->setAttribute("name", itOpt->first);
1565 pelmOpt->setAttribute("value", itOpt->second);
1566 }
1567 } /* end of if */
1568
1569 if (d.VmSlot2OptionsM.size() > 0)
1570 {
1571 VmSlot2OptionsConstIterator itVmSlot;
1572 DhcpOptConstIterator itOpt1;
1573 for(itVmSlot = d.VmSlot2OptionsM.begin();
1574 itVmSlot != d.VmSlot2OptionsM.end();
1575 ++itVmSlot)
1576 {
1577 xml::ElementNode *pelmCfg = pelmThis->createChild("Config");
1578 pelmCfg->setAttribute("vm-name", itVmSlot->first.VmName);
1579 pelmCfg->setAttribute("slot", itVmSlot->first.Slot);
1580
1581 for (itOpt1 = itVmSlot->second.begin();
1582 itOpt1 != itVmSlot->second.end();
1583 ++itOpt1)
1584 {
1585 xml::ElementNode *pelmOpt = pelmCfg->createChild("Option");
1586 pelmOpt->setAttribute("name", itOpt1->first);
1587 pelmOpt->setAttribute("value", itOpt1->second);
1588 }
1589 }
1590 } /* and of if */
1591
1592 }
1593
1594 /* TODO: bump main version ? */
1595 xml::ElementNode *pelmNATNetworks;
1596 /* don't create entry if no NAT networks are registered. */
1597 if (!llNATNetworks.empty())
1598 {
1599 pelmNATNetworks = pelmNetserviceRegistry->createChild("NATNetworks");
1600 for (NATNetworksList::const_iterator it = llNATNetworks.begin();
1601 it != llNATNetworks.end();
1602 ++it)
1603 {
1604 const NATNetwork &n = *it;
1605 xml::ElementNode *pelmThis = pelmNATNetworks->createChild("NATNetwork");
1606 pelmThis->setAttribute("networkName", n.strNetworkName);
1607 pelmThis->setAttribute("network", n.strNetwork);
1608 pelmThis->setAttribute("ipv6", n.fIPv6 ? 1 : 0);
1609 pelmThis->setAttribute("ipv6prefix", n.strIPv6Prefix);
1610 pelmThis->setAttribute("advertiseDefaultIPv6Route", (n.fAdvertiseDefaultIPv6Route)? 1 : 0);
1611 pelmThis->setAttribute("needDhcp", (n.fNeedDhcpServer) ? 1 : 0);
1612 pelmThis->setAttribute("enabled", (n.fEnabled) ? 1 : 0); // too bad we chose 1 vs. 0 here
1613 if (n.llPortForwardRules4.size())
1614 {
1615 xml::ElementNode *pelmPf4 = pelmThis->createChild("PortForwarding4");
1616 buildNATForwardRuleList(*pelmPf4, n.llPortForwardRules4);
1617 }
1618 if (n.llPortForwardRules6.size())
1619 {
1620 xml::ElementNode *pelmPf6 = pelmThis->createChild("PortForwarding6");
1621 buildNATForwardRuleList(*pelmPf6, n.llPortForwardRules6);
1622 }
1623 }
1624 }
1625
1626
1627 xml::ElementNode *pelmSysProps = pelmGlobal->createChild("SystemProperties");
1628 if (systemProperties.strDefaultMachineFolder.length())
1629 pelmSysProps->setAttribute("defaultMachineFolder", systemProperties.strDefaultMachineFolder);
1630 if (systemProperties.strLoggingLevel.length())
1631 pelmSysProps->setAttribute("LoggingLevel", systemProperties.strLoggingLevel);
1632 if (systemProperties.strDefaultHardDiskFormat.length())
1633 pelmSysProps->setAttribute("defaultHardDiskFormat", systemProperties.strDefaultHardDiskFormat);
1634 if (systemProperties.strVRDEAuthLibrary.length())
1635 pelmSysProps->setAttribute("VRDEAuthLibrary", systemProperties.strVRDEAuthLibrary);
1636 if (systemProperties.strWebServiceAuthLibrary.length())
1637 pelmSysProps->setAttribute("webServiceAuthLibrary", systemProperties.strWebServiceAuthLibrary);
1638 if (systemProperties.strDefaultVRDEExtPack.length())
1639 pelmSysProps->setAttribute("defaultVRDEExtPack", systemProperties.strDefaultVRDEExtPack);
1640 pelmSysProps->setAttribute("LogHistoryCount", systemProperties.ulLogHistoryCount);
1641 if (systemProperties.strAutostartDatabasePath.length())
1642 pelmSysProps->setAttribute("autostartDatabasePath", systemProperties.strAutostartDatabasePath);
1643 if (systemProperties.strDefaultFrontend.length())
1644 pelmSysProps->setAttribute("defaultFrontend", systemProperties.strDefaultFrontend);
1645
1646 buildUSBDeviceFilters(*pelmGlobal->createChild("USBDeviceFilters"),
1647 host.llUSBDeviceFilters,
1648 true); // fHostMode
1649
1650 // now go write the XML
1651 xml::XmlFileWriter writer(*m->pDoc);
1652 writer.write(m->strFilename.c_str(), true /*fSafe*/);
1653
1654 m->fFileExists = true;
1655
1656 clearDocument();
1657}
1658
1659////////////////////////////////////////////////////////////////////////////////
1660//
1661// Machine XML structures
1662//
1663////////////////////////////////////////////////////////////////////////////////
1664
1665/**
1666 * Comparison operator. This gets called from MachineConfigFile::operator==,
1667 * which in turn gets called from Machine::saveSettings to figure out whether
1668 * machine settings have really changed and thus need to be written out to disk.
1669 */
1670bool VRDESettings::operator==(const VRDESettings& v) const
1671{
1672 return ( (this == &v)
1673 || ( (fEnabled == v.fEnabled)
1674 && (authType == v.authType)
1675 && (ulAuthTimeout == v.ulAuthTimeout)
1676 && (strAuthLibrary == v.strAuthLibrary)
1677 && (fAllowMultiConnection == v.fAllowMultiConnection)
1678 && (fReuseSingleConnection == v.fReuseSingleConnection)
1679 && (strVrdeExtPack == v.strVrdeExtPack)
1680 && (mapProperties == v.mapProperties)
1681 )
1682 );
1683}
1684
1685/**
1686 * Comparison operator. This gets called from MachineConfigFile::operator==,
1687 * which in turn gets called from Machine::saveSettings to figure out whether
1688 * machine settings have really changed and thus need to be written out to disk.
1689 */
1690bool BIOSSettings::operator==(const BIOSSettings &d) const
1691{
1692 return ( (this == &d)
1693 || ( fACPIEnabled == d.fACPIEnabled
1694 && fIOAPICEnabled == d.fIOAPICEnabled
1695 && fLogoFadeIn == d.fLogoFadeIn
1696 && fLogoFadeOut == d.fLogoFadeOut
1697 && ulLogoDisplayTime == d.ulLogoDisplayTime
1698 && strLogoImagePath == d.strLogoImagePath
1699 && biosBootMenuMode == d.biosBootMenuMode
1700 && fPXEDebugEnabled == d.fPXEDebugEnabled
1701 && llTimeOffset == d.llTimeOffset)
1702 );
1703}
1704
1705/**
1706 * Comparison operator. This gets called from MachineConfigFile::operator==,
1707 * which in turn gets called from Machine::saveSettings to figure out whether
1708 * machine settings have really changed and thus need to be written out to disk.
1709 */
1710bool USBController::operator==(const USBController &u) const
1711{
1712 return ( (this == &u)
1713 || ( (fEnabled == u.fEnabled)
1714 && (fEnabledEHCI == u.fEnabledEHCI)
1715 && (llDeviceFilters == u.llDeviceFilters)
1716 )
1717 );
1718}
1719
1720/**
1721 * Comparison operator. This gets called from MachineConfigFile::operator==,
1722 * which in turn gets called from Machine::saveSettings to figure out whether
1723 * machine settings have really changed and thus need to be written out to disk.
1724 */
1725bool NetworkAdapter::operator==(const NetworkAdapter &n) const
1726{
1727 return ( (this == &n)
1728 || ( (ulSlot == n.ulSlot)
1729 && (type == n.type)
1730 && (fEnabled == n.fEnabled)
1731 && (strMACAddress == n.strMACAddress)
1732 && (fCableConnected == n.fCableConnected)
1733 && (ulLineSpeed == n.ulLineSpeed)
1734 && (enmPromiscModePolicy == n.enmPromiscModePolicy)
1735 && (fTraceEnabled == n.fTraceEnabled)
1736 && (strTraceFile == n.strTraceFile)
1737 && (mode == n.mode)
1738 && (nat == n.nat)
1739 && (strBridgedName == n.strBridgedName)
1740 && (strHostOnlyName == n.strHostOnlyName)
1741 && (strInternalNetworkName == n.strInternalNetworkName)
1742 && (strGenericDriver == n.strGenericDriver)
1743 && (genericProperties == n.genericProperties)
1744 && (ulBootPriority == n.ulBootPriority)
1745 && (strBandwidthGroup == n.strBandwidthGroup)
1746 )
1747 );
1748}
1749
1750/**
1751 * Comparison operator. This gets called from MachineConfigFile::operator==,
1752 * which in turn gets called from Machine::saveSettings to figure out whether
1753 * machine settings have really changed and thus need to be written out to disk.
1754 */
1755bool SerialPort::operator==(const SerialPort &s) const
1756{
1757 return ( (this == &s)
1758 || ( (ulSlot == s.ulSlot)
1759 && (fEnabled == s.fEnabled)
1760 && (ulIOBase == s.ulIOBase)
1761 && (ulIRQ == s.ulIRQ)
1762 && (portMode == s.portMode)
1763 && (strPath == s.strPath)
1764 && (fServer == s.fServer)
1765 )
1766 );
1767}
1768
1769/**
1770 * Comparison operator. This gets called from MachineConfigFile::operator==,
1771 * which in turn gets called from Machine::saveSettings to figure out whether
1772 * machine settings have really changed and thus need to be written out to disk.
1773 */
1774bool ParallelPort::operator==(const ParallelPort &s) const
1775{
1776 return ( (this == &s)
1777 || ( (ulSlot == s.ulSlot)
1778 && (fEnabled == s.fEnabled)
1779 && (ulIOBase == s.ulIOBase)
1780 && (ulIRQ == s.ulIRQ)
1781 && (strPath == s.strPath)
1782 )
1783 );
1784}
1785
1786/**
1787 * Comparison operator. This gets called from MachineConfigFile::operator==,
1788 * which in turn gets called from Machine::saveSettings to figure out whether
1789 * machine settings have really changed and thus need to be written out to disk.
1790 */
1791bool SharedFolder::operator==(const SharedFolder &g) const
1792{
1793 return ( (this == &g)
1794 || ( (strName == g.strName)
1795 && (strHostPath == g.strHostPath)
1796 && (fWritable == g.fWritable)
1797 && (fAutoMount == g.fAutoMount)
1798 )
1799 );
1800}
1801
1802/**
1803 * Comparison operator. This gets called from MachineConfigFile::operator==,
1804 * which in turn gets called from Machine::saveSettings to figure out whether
1805 * machine settings have really changed and thus need to be written out to disk.
1806 */
1807bool GuestProperty::operator==(const GuestProperty &g) const
1808{
1809 return ( (this == &g)
1810 || ( (strName == g.strName)
1811 && (strValue == g.strValue)
1812 && (timestamp == g.timestamp)
1813 && (strFlags == g.strFlags)
1814 )
1815 );
1816}
1817
1818// use a define for the platform-dependent default value of
1819// hwvirt exclusivity, since we'll need to check that value
1820// in bumpSettingsVersionIfNeeded()
1821#if defined(RT_OS_DARWIN) || defined(RT_OS_WINDOWS)
1822 #define HWVIRTEXCLUSIVEDEFAULT false
1823#else
1824 #define HWVIRTEXCLUSIVEDEFAULT true
1825#endif
1826
1827Hardware::Hardware()
1828 : strVersion("1"),
1829 fHardwareVirt(true),
1830 fHardwareVirtExclusive(HWVIRTEXCLUSIVEDEFAULT),
1831 fNestedPaging(true),
1832 fVPID(true),
1833 fUnrestrictedExecution(true),
1834 fHardwareVirtForce(false),
1835 fSyntheticCpu(false),
1836 fPAE(false),
1837 enmLongMode(HC_ARCH_BITS == 64 ? Hardware::LongMode_Enabled : Hardware::LongMode_Disabled),
1838 cCPUs(1),
1839 fCpuHotPlug(false),
1840 fHPETEnabled(false),
1841 ulCpuExecutionCap(100),
1842 ulMemorySizeMB((uint32_t)-1),
1843 graphicsControllerType(GraphicsControllerType_VBoxVGA),
1844 ulVRAMSizeMB(8),
1845 cMonitors(1),
1846 fAccelerate3D(false),
1847 fAccelerate2DVideo(false),
1848 ulVideoCaptureHorzRes(1024),
1849 ulVideoCaptureVertRes(768),
1850 ulVideoCaptureRate(512),
1851 ulVideoCaptureFPS(25),
1852 fVideoCaptureEnabled(false),
1853 u64VideoCaptureScreens(UINT64_C(0xffffffffffffffff)),
1854 strVideoCaptureFile(""),
1855 firmwareType(FirmwareType_BIOS),
1856 pointingHIDType(PointingHIDType_PS2Mouse),
1857 keyboardHIDType(KeyboardHIDType_PS2Keyboard),
1858 chipsetType(ChipsetType_PIIX3),
1859 fEmulatedUSBWebcam(false),
1860 fEmulatedUSBCardReader(false),
1861 clipboardMode(ClipboardMode_Disabled),
1862 dragAndDropMode(DragAndDropMode_Disabled),
1863 ulMemoryBalloonSize(0),
1864 fPageFusionEnabled(false)
1865{
1866 mapBootOrder[0] = DeviceType_Floppy;
1867 mapBootOrder[1] = DeviceType_DVD;
1868 mapBootOrder[2] = DeviceType_HardDisk;
1869
1870 /* The default value for PAE depends on the host:
1871 * - 64 bits host -> always true
1872 * - 32 bits host -> true for Windows & Darwin (masked off if the host cpu doesn't support it anyway)
1873 */
1874#if HC_ARCH_BITS == 64 || defined(RT_OS_WINDOWS) || defined(RT_OS_DARWIN)
1875 fPAE = true;
1876#endif
1877
1878 /* The default value of large page supports depends on the host:
1879 * - 64 bits host -> true, unless it's Linux (pending further prediction work due to excessively expensive large page allocations)
1880 * - 32 bits host -> false
1881 */
1882#if HC_ARCH_BITS == 64 && !defined(RT_OS_LINUX)
1883 fLargePages = true;
1884#else
1885 /* Not supported on 32 bits hosts. */
1886 fLargePages = false;
1887#endif
1888}
1889
1890/**
1891 * Comparison operator. This gets called from MachineConfigFile::operator==,
1892 * which in turn gets called from Machine::saveSettings to figure out whether
1893 * machine settings have really changed and thus need to be written out to disk.
1894 */
1895bool Hardware::operator==(const Hardware& h) const
1896{
1897 return ( (this == &h)
1898 || ( (strVersion == h.strVersion)
1899 && (uuid == h.uuid)
1900 && (fHardwareVirt == h.fHardwareVirt)
1901 && (fHardwareVirtExclusive == h.fHardwareVirtExclusive)
1902 && (fNestedPaging == h.fNestedPaging)
1903 && (fLargePages == h.fLargePages)
1904 && (fVPID == h.fVPID)
1905 && (fUnrestrictedExecution == h.fUnrestrictedExecution)
1906 && (fHardwareVirtForce == h.fHardwareVirtForce)
1907 && (fSyntheticCpu == h.fSyntheticCpu)
1908 && (fPAE == h.fPAE)
1909 && (enmLongMode == h.enmLongMode)
1910 && (cCPUs == h.cCPUs)
1911 && (fCpuHotPlug == h.fCpuHotPlug)
1912 && (ulCpuExecutionCap == h.ulCpuExecutionCap)
1913 && (fHPETEnabled == h.fHPETEnabled)
1914 && (llCpus == h.llCpus)
1915 && (llCpuIdLeafs == h.llCpuIdLeafs)
1916 && (ulMemorySizeMB == h.ulMemorySizeMB)
1917 && (mapBootOrder == h.mapBootOrder)
1918 && (graphicsControllerType == h.graphicsControllerType)
1919 && (ulVRAMSizeMB == h.ulVRAMSizeMB)
1920 && (cMonitors == h.cMonitors)
1921 && (fAccelerate3D == h.fAccelerate3D)
1922 && (fAccelerate2DVideo == h.fAccelerate2DVideo)
1923 && (fVideoCaptureEnabled == h.fVideoCaptureEnabled)
1924 && (u64VideoCaptureScreens == h.u64VideoCaptureScreens)
1925 && (strVideoCaptureFile == h.strVideoCaptureFile)
1926 && (ulVideoCaptureHorzRes == h.ulVideoCaptureHorzRes)
1927 && (ulVideoCaptureVertRes == h.ulVideoCaptureVertRes)
1928 && (ulVideoCaptureRate == h.ulVideoCaptureRate)
1929 && (ulVideoCaptureFPS == h.ulVideoCaptureFPS)
1930 && (firmwareType == h.firmwareType)
1931 && (pointingHIDType == h.pointingHIDType)
1932 && (keyboardHIDType == h.keyboardHIDType)
1933 && (chipsetType == h.chipsetType)
1934 && (fEmulatedUSBWebcam == h.fEmulatedUSBWebcam)
1935 && (fEmulatedUSBCardReader == h.fEmulatedUSBCardReader)
1936 && (vrdeSettings == h.vrdeSettings)
1937 && (biosSettings == h.biosSettings)
1938 && (usbController == h.usbController)
1939 && (llNetworkAdapters == h.llNetworkAdapters)
1940 && (llSerialPorts == h.llSerialPorts)
1941 && (llParallelPorts == h.llParallelPorts)
1942 && (audioAdapter == h.audioAdapter)
1943 && (llSharedFolders == h.llSharedFolders)
1944 && (clipboardMode == h.clipboardMode)
1945 && (dragAndDropMode == h.dragAndDropMode)
1946 && (ulMemoryBalloonSize == h.ulMemoryBalloonSize)
1947 && (fPageFusionEnabled == h.fPageFusionEnabled)
1948 && (llGuestProperties == h.llGuestProperties)
1949 && (strNotificationPatterns == h.strNotificationPatterns)
1950 && (ioSettings == h.ioSettings)
1951 && (pciAttachments == h.pciAttachments)
1952 && (strDefaultFrontend == h.strDefaultFrontend)
1953 )
1954 );
1955}
1956
1957/**
1958 * Comparison operator. This gets called from MachineConfigFile::operator==,
1959 * which in turn gets called from Machine::saveSettings to figure out whether
1960 * machine settings have really changed and thus need to be written out to disk.
1961 */
1962bool AttachedDevice::operator==(const AttachedDevice &a) const
1963{
1964 return ( (this == &a)
1965 || ( (deviceType == a.deviceType)
1966 && (fPassThrough == a.fPassThrough)
1967 && (fTempEject == a.fTempEject)
1968 && (fNonRotational == a.fNonRotational)
1969 && (fDiscard == a.fDiscard)
1970 && (lPort == a.lPort)
1971 && (lDevice == a.lDevice)
1972 && (uuid == a.uuid)
1973 && (strHostDriveSrc == a.strHostDriveSrc)
1974 && (strBwGroup == a.strBwGroup)
1975 )
1976 );
1977}
1978
1979/**
1980 * Comparison operator. This gets called from MachineConfigFile::operator==,
1981 * which in turn gets called from Machine::saveSettings to figure out whether
1982 * machine settings have really changed and thus need to be written out to disk.
1983 */
1984bool StorageController::operator==(const StorageController &s) const
1985{
1986 return ( (this == &s)
1987 || ( (strName == s.strName)
1988 && (storageBus == s.storageBus)
1989 && (controllerType == s.controllerType)
1990 && (ulPortCount == s.ulPortCount)
1991 && (ulInstance == s.ulInstance)
1992 && (fUseHostIOCache == s.fUseHostIOCache)
1993 && (lIDE0MasterEmulationPort == s.lIDE0MasterEmulationPort)
1994 && (lIDE0SlaveEmulationPort == s.lIDE0SlaveEmulationPort)
1995 && (lIDE1MasterEmulationPort == s.lIDE1MasterEmulationPort)
1996 && (lIDE1SlaveEmulationPort == s.lIDE1SlaveEmulationPort)
1997 && (llAttachedDevices == s.llAttachedDevices)
1998 )
1999 );
2000}
2001
2002/**
2003 * Comparison operator. This gets called from MachineConfigFile::operator==,
2004 * which in turn gets called from Machine::saveSettings to figure out whether
2005 * machine settings have really changed and thus need to be written out to disk.
2006 */
2007bool Storage::operator==(const Storage &s) const
2008{
2009 return ( (this == &s)
2010 || (llStorageControllers == s.llStorageControllers) // deep compare
2011 );
2012}
2013
2014/**
2015 * Comparison operator. This gets called from MachineConfigFile::operator==,
2016 * which in turn gets called from Machine::saveSettings to figure out whether
2017 * machine settings have really changed and thus need to be written out to disk.
2018 */
2019bool Snapshot::operator==(const Snapshot &s) const
2020{
2021 return ( (this == &s)
2022 || ( (uuid == s.uuid)
2023 && (strName == s.strName)
2024 && (strDescription == s.strDescription)
2025 && (RTTimeSpecIsEqual(&timestamp, &s.timestamp))
2026 && (strStateFile == s.strStateFile)
2027 && (hardware == s.hardware) // deep compare
2028 && (storage == s.storage) // deep compare
2029 && (llChildSnapshots == s.llChildSnapshots) // deep compare
2030 && debugging == s.debugging
2031 && autostart == s.autostart
2032 )
2033 );
2034}
2035
2036/**
2037 * IOSettings constructor.
2038 */
2039IOSettings::IOSettings()
2040{
2041 fIOCacheEnabled = true;
2042 ulIOCacheSize = 5;
2043}
2044
2045////////////////////////////////////////////////////////////////////////////////
2046//
2047// MachineConfigFile
2048//
2049////////////////////////////////////////////////////////////////////////////////
2050
2051/**
2052 * Constructor.
2053 *
2054 * If pstrFilename is != NULL, this reads the given settings file into the member
2055 * variables and various substructures and lists. Otherwise, the member variables
2056 * are initialized with default values.
2057 *
2058 * Throws variants of xml::Error for I/O, XML and logical content errors, which
2059 * the caller should catch; if this constructor does not throw, then the member
2060 * variables contain meaningful values (either from the file or defaults).
2061 *
2062 * @param strFilename
2063 */
2064MachineConfigFile::MachineConfigFile(const Utf8Str *pstrFilename)
2065 : ConfigFileBase(pstrFilename),
2066 fCurrentStateModified(true),
2067 fAborted(false)
2068{
2069 RTTimeNow(&timeLastStateChange);
2070
2071 if (pstrFilename)
2072 {
2073 // the ConfigFileBase constructor has loaded the XML file, so now
2074 // we need only analyze what is in there
2075
2076 xml::NodesLoop nlRootChildren(*m->pelmRoot);
2077 const xml::ElementNode *pelmRootChild;
2078 while ((pelmRootChild = nlRootChildren.forAllNodes()))
2079 {
2080 if (pelmRootChild->nameEquals("Machine"))
2081 readMachine(*pelmRootChild);
2082 }
2083
2084 // clean up memory allocated by XML engine
2085 clearDocument();
2086 }
2087}
2088
2089/**
2090 * Public routine which returns true if this machine config file can have its
2091 * own media registry (which is true for settings version v1.11 and higher,
2092 * i.e. files created by VirtualBox 4.0 and higher).
2093 * @return
2094 */
2095bool MachineConfigFile::canHaveOwnMediaRegistry() const
2096{
2097 return (m->sv >= SettingsVersion_v1_11);
2098}
2099
2100/**
2101 * Public routine which allows for importing machine XML from an external DOM tree.
2102 * Use this after having called the constructor with a NULL argument.
2103 *
2104 * This is used by the OVF code if a <vbox:Machine> element has been encountered
2105 * in an OVF VirtualSystem element.
2106 *
2107 * @param elmMachine
2108 */
2109void MachineConfigFile::importMachineXML(const xml::ElementNode &elmMachine)
2110{
2111 readMachine(elmMachine);
2112}
2113
2114/**
2115 * Comparison operator. This gets called from Machine::saveSettings to figure out
2116 * whether machine settings have really changed and thus need to be written out to disk.
2117 *
2118 * Even though this is called operator==, this does NOT compare all fields; the "equals"
2119 * should be understood as "has the same machine config as". The following fields are
2120 * NOT compared:
2121 * -- settings versions and file names inherited from ConfigFileBase;
2122 * -- fCurrentStateModified because that is considered separately in Machine::saveSettings!!
2123 *
2124 * The "deep" comparisons marked below will invoke the operator== functions of the
2125 * structs defined in this file, which may in turn go into comparing lists of
2126 * other structures. As a result, invoking this can be expensive, but it's
2127 * less expensive than writing out XML to disk.
2128 */
2129bool MachineConfigFile::operator==(const MachineConfigFile &c) const
2130{
2131 return ( (this == &c)
2132 || ( (uuid == c.uuid)
2133 && (machineUserData == c.machineUserData)
2134 && (strStateFile == c.strStateFile)
2135 && (uuidCurrentSnapshot == c.uuidCurrentSnapshot)
2136 // skip fCurrentStateModified!
2137 && (RTTimeSpecIsEqual(&timeLastStateChange, &c.timeLastStateChange))
2138 && (fAborted == c.fAborted)
2139 && (hardwareMachine == c.hardwareMachine) // this one's deep
2140 && (storageMachine == c.storageMachine) // this one's deep
2141 && (mediaRegistry == c.mediaRegistry) // this one's deep
2142 && (mapExtraDataItems == c.mapExtraDataItems) // this one's deep
2143 && (llFirstSnapshot == c.llFirstSnapshot) // this one's deep
2144 )
2145 );
2146}
2147
2148/**
2149 * Called from MachineConfigFile::readHardware() to read cpu information.
2150 * @param elmCpuid
2151 * @param ll
2152 */
2153void MachineConfigFile::readCpuTree(const xml::ElementNode &elmCpu,
2154 CpuList &ll)
2155{
2156 xml::NodesLoop nl1(elmCpu, "Cpu");
2157 const xml::ElementNode *pelmCpu;
2158 while ((pelmCpu = nl1.forAllNodes()))
2159 {
2160 Cpu cpu;
2161
2162 if (!pelmCpu->getAttributeValue("id", cpu.ulId))
2163 throw ConfigFileError(this, pelmCpu, N_("Required Cpu/@id attribute is missing"));
2164
2165 ll.push_back(cpu);
2166 }
2167}
2168
2169/**
2170 * Called from MachineConfigFile::readHardware() to cpuid information.
2171 * @param elmCpuid
2172 * @param ll
2173 */
2174void MachineConfigFile::readCpuIdTree(const xml::ElementNode &elmCpuid,
2175 CpuIdLeafsList &ll)
2176{
2177 xml::NodesLoop nl1(elmCpuid, "CpuIdLeaf");
2178 const xml::ElementNode *pelmCpuIdLeaf;
2179 while ((pelmCpuIdLeaf = nl1.forAllNodes()))
2180 {
2181 CpuIdLeaf leaf;
2182
2183 if (!pelmCpuIdLeaf->getAttributeValue("id", leaf.ulId))
2184 throw ConfigFileError(this, pelmCpuIdLeaf, N_("Required CpuId/@id attribute is missing"));
2185
2186 pelmCpuIdLeaf->getAttributeValue("eax", leaf.ulEax);
2187 pelmCpuIdLeaf->getAttributeValue("ebx", leaf.ulEbx);
2188 pelmCpuIdLeaf->getAttributeValue("ecx", leaf.ulEcx);
2189 pelmCpuIdLeaf->getAttributeValue("edx", leaf.ulEdx);
2190
2191 ll.push_back(leaf);
2192 }
2193}
2194
2195/**
2196 * Called from MachineConfigFile::readHardware() to network information.
2197 * @param elmNetwork
2198 * @param ll
2199 */
2200void MachineConfigFile::readNetworkAdapters(const xml::ElementNode &elmNetwork,
2201 NetworkAdaptersList &ll)
2202{
2203 xml::NodesLoop nl1(elmNetwork, "Adapter");
2204 const xml::ElementNode *pelmAdapter;
2205 while ((pelmAdapter = nl1.forAllNodes()))
2206 {
2207 NetworkAdapter nic;
2208
2209 if (!pelmAdapter->getAttributeValue("slot", nic.ulSlot))
2210 throw ConfigFileError(this, pelmAdapter, N_("Required Adapter/@slot attribute is missing"));
2211
2212 Utf8Str strTemp;
2213 if (pelmAdapter->getAttributeValue("type", strTemp))
2214 {
2215 if (strTemp == "Am79C970A")
2216 nic.type = NetworkAdapterType_Am79C970A;
2217 else if (strTemp == "Am79C973")
2218 nic.type = NetworkAdapterType_Am79C973;
2219 else if (strTemp == "82540EM")
2220 nic.type = NetworkAdapterType_I82540EM;
2221 else if (strTemp == "82543GC")
2222 nic.type = NetworkAdapterType_I82543GC;
2223 else if (strTemp == "82545EM")
2224 nic.type = NetworkAdapterType_I82545EM;
2225 else if (strTemp == "virtio")
2226 nic.type = NetworkAdapterType_Virtio;
2227 else
2228 throw ConfigFileError(this, pelmAdapter, N_("Invalid value '%s' in Adapter/@type attribute"), strTemp.c_str());
2229 }
2230
2231 pelmAdapter->getAttributeValue("enabled", nic.fEnabled);
2232 pelmAdapter->getAttributeValue("MACAddress", nic.strMACAddress);
2233 pelmAdapter->getAttributeValue("cable", nic.fCableConnected);
2234 pelmAdapter->getAttributeValue("speed", nic.ulLineSpeed);
2235
2236 if (pelmAdapter->getAttributeValue("promiscuousModePolicy", strTemp))
2237 {
2238 if (strTemp == "Deny")
2239 nic.enmPromiscModePolicy = NetworkAdapterPromiscModePolicy_Deny;
2240 else if (strTemp == "AllowNetwork")
2241 nic.enmPromiscModePolicy = NetworkAdapterPromiscModePolicy_AllowNetwork;
2242 else if (strTemp == "AllowAll")
2243 nic.enmPromiscModePolicy = NetworkAdapterPromiscModePolicy_AllowAll;
2244 else
2245 throw ConfigFileError(this, pelmAdapter,
2246 N_("Invalid value '%s' in Adapter/@promiscuousModePolicy attribute"), strTemp.c_str());
2247 }
2248
2249 pelmAdapter->getAttributeValue("trace", nic.fTraceEnabled);
2250 pelmAdapter->getAttributeValue("tracefile", nic.strTraceFile);
2251 pelmAdapter->getAttributeValue("bootPriority", nic.ulBootPriority);
2252 pelmAdapter->getAttributeValue("bandwidthGroup", nic.strBandwidthGroup);
2253
2254 xml::ElementNodesList llNetworkModes;
2255 pelmAdapter->getChildElements(llNetworkModes);
2256 xml::ElementNodesList::iterator it;
2257 /* We should have only active mode descriptor and disabled modes set */
2258 if (llNetworkModes.size() > 2)
2259 {
2260 throw ConfigFileError(this, pelmAdapter, N_("Invalid number of modes ('%d') attached to Adapter attribute"), llNetworkModes.size());
2261 }
2262 for (it = llNetworkModes.begin(); it != llNetworkModes.end(); ++it)
2263 {
2264 const xml::ElementNode *pelmNode = *it;
2265 if (pelmNode->nameEquals("DisabledModes"))
2266 {
2267 xml::ElementNodesList llDisabledNetworkModes;
2268 xml::ElementNodesList::iterator itDisabled;
2269 pelmNode->getChildElements(llDisabledNetworkModes);
2270 /* run over disabled list and load settings */
2271 for (itDisabled = llDisabledNetworkModes.begin();
2272 itDisabled != llDisabledNetworkModes.end(); ++itDisabled)
2273 {
2274 const xml::ElementNode *pelmDisabledNode = *itDisabled;
2275 readAttachedNetworkMode(*pelmDisabledNode, false, nic);
2276 }
2277 }
2278 else
2279 readAttachedNetworkMode(*pelmNode, true, nic);
2280 }
2281 // else: default is NetworkAttachmentType_Null
2282
2283 ll.push_back(nic);
2284 }
2285}
2286
2287void MachineConfigFile::readAttachedNetworkMode(const xml::ElementNode &elmMode, bool fEnabled, NetworkAdapter &nic)
2288{
2289 NetworkAttachmentType_T enmAttachmentType = NetworkAttachmentType_Null;
2290
2291 if (elmMode.nameEquals("NAT"))
2292 {
2293 enmAttachmentType = NetworkAttachmentType_NAT;
2294
2295 elmMode.getAttributeValue("network", nic.nat.strNetwork);
2296 elmMode.getAttributeValue("hostip", nic.nat.strBindIP);
2297 elmMode.getAttributeValue("mtu", nic.nat.u32Mtu);
2298 elmMode.getAttributeValue("sockrcv", nic.nat.u32SockRcv);
2299 elmMode.getAttributeValue("socksnd", nic.nat.u32SockSnd);
2300 elmMode.getAttributeValue("tcprcv", nic.nat.u32TcpRcv);
2301 elmMode.getAttributeValue("tcpsnd", nic.nat.u32TcpSnd);
2302 const xml::ElementNode *pelmDNS;
2303 if ((pelmDNS = elmMode.findChildElement("DNS")))
2304 {
2305 pelmDNS->getAttributeValue("pass-domain", nic.nat.fDNSPassDomain);
2306 pelmDNS->getAttributeValue("use-proxy", nic.nat.fDNSProxy);
2307 pelmDNS->getAttributeValue("use-host-resolver", nic.nat.fDNSUseHostResolver);
2308 }
2309 const xml::ElementNode *pelmAlias;
2310 if ((pelmAlias = elmMode.findChildElement("Alias")))
2311 {
2312 pelmAlias->getAttributeValue("logging", nic.nat.fAliasLog);
2313 pelmAlias->getAttributeValue("proxy-only", nic.nat.fAliasProxyOnly);
2314 pelmAlias->getAttributeValue("use-same-ports", nic.nat.fAliasUseSamePorts);
2315 }
2316 const xml::ElementNode *pelmTFTP;
2317 if ((pelmTFTP = elmMode.findChildElement("TFTP")))
2318 {
2319 pelmTFTP->getAttributeValue("prefix", nic.nat.strTFTPPrefix);
2320 pelmTFTP->getAttributeValue("boot-file", nic.nat.strTFTPBootFile);
2321 pelmTFTP->getAttributeValue("next-server", nic.nat.strTFTPNextServer);
2322 }
2323
2324 readNATForwardRuleList(elmMode, nic.nat.llRules);
2325 }
2326 else if ( (elmMode.nameEquals("HostInterface"))
2327 || (elmMode.nameEquals("BridgedInterface")))
2328 {
2329 enmAttachmentType = NetworkAttachmentType_Bridged;
2330
2331 elmMode.getAttributeValue("name", nic.strBridgedName); // optional bridged interface name
2332 }
2333 else if (elmMode.nameEquals("InternalNetwork"))
2334 {
2335 enmAttachmentType = NetworkAttachmentType_Internal;
2336
2337 if (!elmMode.getAttributeValue("name", nic.strInternalNetworkName)) // required network name
2338 throw ConfigFileError(this, &elmMode, N_("Required InternalNetwork/@name element is missing"));
2339 }
2340 else if (elmMode.nameEquals("HostOnlyInterface"))
2341 {
2342 enmAttachmentType = NetworkAttachmentType_HostOnly;
2343
2344 if (!elmMode.getAttributeValue("name", nic.strHostOnlyName)) // required network name
2345 throw ConfigFileError(this, &elmMode, N_("Required HostOnlyInterface/@name element is missing"));
2346 }
2347 else if (elmMode.nameEquals("GenericInterface"))
2348 {
2349 enmAttachmentType = NetworkAttachmentType_Generic;
2350
2351 elmMode.getAttributeValue("driver", nic.strGenericDriver); // optional network attachment driver
2352
2353 // get all properties
2354 xml::NodesLoop nl(elmMode);
2355 const xml::ElementNode *pelmModeChild;
2356 while ((pelmModeChild = nl.forAllNodes()))
2357 {
2358 if (pelmModeChild->nameEquals("Property"))
2359 {
2360 Utf8Str strPropName, strPropValue;
2361 if ( (pelmModeChild->getAttributeValue("name", strPropName))
2362 && (pelmModeChild->getAttributeValue("value", strPropValue))
2363 )
2364 nic.genericProperties[strPropName] = strPropValue;
2365 else
2366 throw ConfigFileError(this, pelmModeChild, N_("Required GenericInterface/Property/@name or @value attribute is missing"));
2367 }
2368 }
2369 }
2370 else if (elmMode.nameEquals("VDE"))
2371 {
2372 enmAttachmentType = NetworkAttachmentType_Generic;
2373
2374 com::Utf8Str strVDEName;
2375 elmMode.getAttributeValue("network", strVDEName); // optional network name
2376 nic.strGenericDriver = "VDE";
2377 nic.genericProperties["network"] = strVDEName;
2378 }
2379
2380 if (fEnabled && enmAttachmentType != NetworkAttachmentType_Null)
2381 nic.mode = enmAttachmentType;
2382}
2383
2384/**
2385 * Called from MachineConfigFile::readHardware() to read serial port information.
2386 * @param elmUART
2387 * @param ll
2388 */
2389void MachineConfigFile::readSerialPorts(const xml::ElementNode &elmUART,
2390 SerialPortsList &ll)
2391{
2392 xml::NodesLoop nl1(elmUART, "Port");
2393 const xml::ElementNode *pelmPort;
2394 while ((pelmPort = nl1.forAllNodes()))
2395 {
2396 SerialPort port;
2397 if (!pelmPort->getAttributeValue("slot", port.ulSlot))
2398 throw ConfigFileError(this, pelmPort, N_("Required UART/Port/@slot attribute is missing"));
2399
2400 // slot must be unique
2401 for (SerialPortsList::const_iterator it = ll.begin();
2402 it != ll.end();
2403 ++it)
2404 if ((*it).ulSlot == port.ulSlot)
2405 throw ConfigFileError(this, pelmPort, N_("Invalid value %RU32 in UART/Port/@slot attribute: value is not unique"), port.ulSlot);
2406
2407 if (!pelmPort->getAttributeValue("enabled", port.fEnabled))
2408 throw ConfigFileError(this, pelmPort, N_("Required UART/Port/@enabled attribute is missing"));
2409 if (!pelmPort->getAttributeValue("IOBase", port.ulIOBase))
2410 throw ConfigFileError(this, pelmPort, N_("Required UART/Port/@IOBase attribute is missing"));
2411 if (!pelmPort->getAttributeValue("IRQ", port.ulIRQ))
2412 throw ConfigFileError(this, pelmPort, N_("Required UART/Port/@IRQ attribute is missing"));
2413
2414 Utf8Str strPortMode;
2415 if (!pelmPort->getAttributeValue("hostMode", strPortMode))
2416 throw ConfigFileError(this, pelmPort, N_("Required UART/Port/@hostMode attribute is missing"));
2417 if (strPortMode == "RawFile")
2418 port.portMode = PortMode_RawFile;
2419 else if (strPortMode == "HostPipe")
2420 port.portMode = PortMode_HostPipe;
2421 else if (strPortMode == "HostDevice")
2422 port.portMode = PortMode_HostDevice;
2423 else if (strPortMode == "Disconnected")
2424 port.portMode = PortMode_Disconnected;
2425 else
2426 throw ConfigFileError(this, pelmPort, N_("Invalid value '%s' in UART/Port/@hostMode attribute"), strPortMode.c_str());
2427
2428 pelmPort->getAttributeValue("path", port.strPath);
2429 pelmPort->getAttributeValue("server", port.fServer);
2430
2431 ll.push_back(port);
2432 }
2433}
2434
2435/**
2436 * Called from MachineConfigFile::readHardware() to read parallel port information.
2437 * @param elmLPT
2438 * @param ll
2439 */
2440void MachineConfigFile::readParallelPorts(const xml::ElementNode &elmLPT,
2441 ParallelPortsList &ll)
2442{
2443 xml::NodesLoop nl1(elmLPT, "Port");
2444 const xml::ElementNode *pelmPort;
2445 while ((pelmPort = nl1.forAllNodes()))
2446 {
2447 ParallelPort port;
2448 if (!pelmPort->getAttributeValue("slot", port.ulSlot))
2449 throw ConfigFileError(this, pelmPort, N_("Required LPT/Port/@slot attribute is missing"));
2450
2451 // slot must be unique
2452 for (ParallelPortsList::const_iterator it = ll.begin();
2453 it != ll.end();
2454 ++it)
2455 if ((*it).ulSlot == port.ulSlot)
2456 throw ConfigFileError(this, pelmPort, N_("Invalid value %RU32 in LPT/Port/@slot attribute: value is not unique"), port.ulSlot);
2457
2458 if (!pelmPort->getAttributeValue("enabled", port.fEnabled))
2459 throw ConfigFileError(this, pelmPort, N_("Required LPT/Port/@enabled attribute is missing"));
2460 if (!pelmPort->getAttributeValue("IOBase", port.ulIOBase))
2461 throw ConfigFileError(this, pelmPort, N_("Required LPT/Port/@IOBase attribute is missing"));
2462 if (!pelmPort->getAttributeValue("IRQ", port.ulIRQ))
2463 throw ConfigFileError(this, pelmPort, N_("Required LPT/Port/@IRQ attribute is missing"));
2464
2465 pelmPort->getAttributeValue("path", port.strPath);
2466
2467 ll.push_back(port);
2468 }
2469}
2470
2471/**
2472 * Called from MachineConfigFile::readHardware() to read audio adapter information
2473 * and maybe fix driver information depending on the current host hardware.
2474 *
2475 * @param elmAudioAdapter "AudioAdapter" XML element.
2476 * @param hw
2477 */
2478void MachineConfigFile::readAudioAdapter(const xml::ElementNode &elmAudioAdapter,
2479 AudioAdapter &aa)
2480{
2481 elmAudioAdapter.getAttributeValue("enabled", aa.fEnabled);
2482
2483 Utf8Str strTemp;
2484 if (elmAudioAdapter.getAttributeValue("controller", strTemp))
2485 {
2486 if (strTemp == "SB16")
2487 aa.controllerType = AudioControllerType_SB16;
2488 else if (strTemp == "AC97")
2489 aa.controllerType = AudioControllerType_AC97;
2490 else if (strTemp == "HDA")
2491 aa.controllerType = AudioControllerType_HDA;
2492 else
2493 throw ConfigFileError(this, &elmAudioAdapter, N_("Invalid value '%s' in AudioAdapter/@controller attribute"), strTemp.c_str());
2494 }
2495
2496 if (elmAudioAdapter.getAttributeValue("driver", strTemp))
2497 {
2498 // settings before 1.3 used lower case so make sure this is case-insensitive
2499 strTemp.toUpper();
2500 if (strTemp == "NULL")
2501 aa.driverType = AudioDriverType_Null;
2502 else if (strTemp == "WINMM")
2503 aa.driverType = AudioDriverType_WinMM;
2504 else if ( (strTemp == "DIRECTSOUND") || (strTemp == "DSOUND") )
2505 aa.driverType = AudioDriverType_DirectSound;
2506 else if (strTemp == "SOLAUDIO")
2507 aa.driverType = AudioDriverType_SolAudio;
2508 else if (strTemp == "ALSA")
2509 aa.driverType = AudioDriverType_ALSA;
2510 else if (strTemp == "PULSE")
2511 aa.driverType = AudioDriverType_Pulse;
2512 else if (strTemp == "OSS")
2513 aa.driverType = AudioDriverType_OSS;
2514 else if (strTemp == "COREAUDIO")
2515 aa.driverType = AudioDriverType_CoreAudio;
2516 else if (strTemp == "MMPM")
2517 aa.driverType = AudioDriverType_MMPM;
2518 else
2519 throw ConfigFileError(this, &elmAudioAdapter, N_("Invalid value '%s' in AudioAdapter/@driver attribute"), strTemp.c_str());
2520
2521 // now check if this is actually supported on the current host platform;
2522 // people might be opening a file created on a Windows host, and that
2523 // VM should still start on a Linux host
2524 if (!isAudioDriverAllowedOnThisHost(aa.driverType))
2525 aa.driverType = getHostDefaultAudioDriver();
2526 }
2527}
2528
2529/**
2530 * Called from MachineConfigFile::readHardware() to read guest property information.
2531 * @param elmGuestProperties
2532 * @param hw
2533 */
2534void MachineConfigFile::readGuestProperties(const xml::ElementNode &elmGuestProperties,
2535 Hardware &hw)
2536{
2537 xml::NodesLoop nl1(elmGuestProperties, "GuestProperty");
2538 const xml::ElementNode *pelmProp;
2539 while ((pelmProp = nl1.forAllNodes()))
2540 {
2541 GuestProperty prop;
2542 pelmProp->getAttributeValue("name", prop.strName);
2543 pelmProp->getAttributeValue("value", prop.strValue);
2544
2545 pelmProp->getAttributeValue("timestamp", prop.timestamp);
2546 pelmProp->getAttributeValue("flags", prop.strFlags);
2547 hw.llGuestProperties.push_back(prop);
2548 }
2549
2550 elmGuestProperties.getAttributeValue("notificationPatterns", hw.strNotificationPatterns);
2551}
2552
2553/**
2554 * Helper function to read attributes that are common to <SATAController> (pre-1.7)
2555 * and <StorageController>.
2556 * @param elmStorageController
2557 * @param strg
2558 */
2559void MachineConfigFile::readStorageControllerAttributes(const xml::ElementNode &elmStorageController,
2560 StorageController &sctl)
2561{
2562 elmStorageController.getAttributeValue("PortCount", sctl.ulPortCount);
2563 elmStorageController.getAttributeValue("IDE0MasterEmulationPort", sctl.lIDE0MasterEmulationPort);
2564 elmStorageController.getAttributeValue("IDE0SlaveEmulationPort", sctl.lIDE0SlaveEmulationPort);
2565 elmStorageController.getAttributeValue("IDE1MasterEmulationPort", sctl.lIDE1MasterEmulationPort);
2566 elmStorageController.getAttributeValue("IDE1SlaveEmulationPort", sctl.lIDE1SlaveEmulationPort);
2567
2568 elmStorageController.getAttributeValue("useHostIOCache", sctl.fUseHostIOCache);
2569}
2570
2571/**
2572 * Reads in a <Hardware> block and stores it in the given structure. Used
2573 * both directly from readMachine and from readSnapshot, since snapshots
2574 * have their own hardware sections.
2575 *
2576 * For legacy pre-1.7 settings we also need a storage structure because
2577 * the IDE and SATA controllers used to be defined under <Hardware>.
2578 *
2579 * @param elmHardware
2580 * @param hw
2581 */
2582void MachineConfigFile::readHardware(const xml::ElementNode &elmHardware,
2583 Hardware &hw,
2584 Storage &strg)
2585{
2586 if (!elmHardware.getAttributeValue("version", hw.strVersion))
2587 {
2588 /* KLUDGE ALERT! For a while during the 3.1 development this was not
2589 written because it was thought to have a default value of "2". For
2590 sv <= 1.3 it defaults to "1" because the attribute didn't exist,
2591 while for 1.4+ it is sort of mandatory. Now, the buggy XML writer
2592 code only wrote 1.7 and later. So, if it's a 1.7+ XML file and it's
2593 missing the hardware version, then it probably should be "2" instead
2594 of "1". */
2595 if (m->sv < SettingsVersion_v1_7)
2596 hw.strVersion = "1";
2597 else
2598 hw.strVersion = "2";
2599 }
2600 Utf8Str strUUID;
2601 if (elmHardware.getAttributeValue("uuid", strUUID))
2602 parseUUID(hw.uuid, strUUID);
2603
2604 xml::NodesLoop nl1(elmHardware);
2605 const xml::ElementNode *pelmHwChild;
2606 while ((pelmHwChild = nl1.forAllNodes()))
2607 {
2608 if (pelmHwChild->nameEquals("CPU"))
2609 {
2610 if (!pelmHwChild->getAttributeValue("count", hw.cCPUs))
2611 {
2612 // pre-1.5 variant; not sure if this actually exists in the wild anywhere
2613 const xml::ElementNode *pelmCPUChild;
2614 if ((pelmCPUChild = pelmHwChild->findChildElement("CPUCount")))
2615 pelmCPUChild->getAttributeValue("count", hw.cCPUs);
2616 }
2617
2618 pelmHwChild->getAttributeValue("hotplug", hw.fCpuHotPlug);
2619 pelmHwChild->getAttributeValue("executionCap", hw.ulCpuExecutionCap);
2620
2621 const xml::ElementNode *pelmCPUChild;
2622 if (hw.fCpuHotPlug)
2623 {
2624 if ((pelmCPUChild = pelmHwChild->findChildElement("CpuTree")))
2625 readCpuTree(*pelmCPUChild, hw.llCpus);
2626 }
2627
2628 if ((pelmCPUChild = pelmHwChild->findChildElement("HardwareVirtEx")))
2629 {
2630 pelmCPUChild->getAttributeValue("enabled", hw.fHardwareVirt);
2631 pelmCPUChild->getAttributeValue("exclusive", hw.fHardwareVirtExclusive); // settings version 1.9
2632 }
2633 if ((pelmCPUChild = pelmHwChild->findChildElement("HardwareVirtExNestedPaging")))
2634 pelmCPUChild->getAttributeValue("enabled", hw.fNestedPaging);
2635 if ((pelmCPUChild = pelmHwChild->findChildElement("HardwareVirtExLargePages")))
2636 pelmCPUChild->getAttributeValue("enabled", hw.fLargePages);
2637 if ((pelmCPUChild = pelmHwChild->findChildElement("HardwareVirtExVPID")))
2638 pelmCPUChild->getAttributeValue("enabled", hw.fVPID);
2639 if ((pelmCPUChild = pelmHwChild->findChildElement("HardwareVirtExUX")))
2640 pelmCPUChild->getAttributeValue("enabled", hw.fUnrestrictedExecution);
2641 if ((pelmCPUChild = pelmHwChild->findChildElement("HardwareVirtForce")))
2642 pelmCPUChild->getAttributeValue("enabled", hw.fHardwareVirtForce);
2643
2644 if (!(pelmCPUChild = pelmHwChild->findChildElement("PAE")))
2645 {
2646 /* The default for pre 3.1 was false, so we must respect that. */
2647 if (m->sv < SettingsVersion_v1_9)
2648 hw.fPAE = false;
2649 }
2650 else
2651 pelmCPUChild->getAttributeValue("enabled", hw.fPAE);
2652
2653 bool fLongMode;
2654 if ( (pelmCPUChild = pelmHwChild->findChildElement("LongMode"))
2655 && pelmCPUChild->getAttributeValue("enabled", fLongMode) )
2656 hw.enmLongMode = fLongMode ? Hardware::LongMode_Enabled : Hardware::LongMode_Disabled;
2657 else
2658 hw.enmLongMode = Hardware::LongMode_Legacy;
2659
2660 if ((pelmCPUChild = pelmHwChild->findChildElement("SyntheticCpu")))
2661 pelmCPUChild->getAttributeValue("enabled", hw.fSyntheticCpu);
2662 if ((pelmCPUChild = pelmHwChild->findChildElement("CpuIdTree")))
2663 readCpuIdTree(*pelmCPUChild, hw.llCpuIdLeafs);
2664 }
2665 else if (pelmHwChild->nameEquals("Memory"))
2666 {
2667 pelmHwChild->getAttributeValue("RAMSize", hw.ulMemorySizeMB);
2668 pelmHwChild->getAttributeValue("PageFusion", hw.fPageFusionEnabled);
2669 }
2670 else if (pelmHwChild->nameEquals("Firmware"))
2671 {
2672 Utf8Str strFirmwareType;
2673 if (pelmHwChild->getAttributeValue("type", strFirmwareType))
2674 {
2675 if ( (strFirmwareType == "BIOS")
2676 || (strFirmwareType == "1") // some trunk builds used the number here
2677 )
2678 hw.firmwareType = FirmwareType_BIOS;
2679 else if ( (strFirmwareType == "EFI")
2680 || (strFirmwareType == "2") // some trunk builds used the number here
2681 )
2682 hw.firmwareType = FirmwareType_EFI;
2683 else if ( strFirmwareType == "EFI32")
2684 hw.firmwareType = FirmwareType_EFI32;
2685 else if ( strFirmwareType == "EFI64")
2686 hw.firmwareType = FirmwareType_EFI64;
2687 else if ( strFirmwareType == "EFIDUAL")
2688 hw.firmwareType = FirmwareType_EFIDUAL;
2689 else
2690 throw ConfigFileError(this,
2691 pelmHwChild,
2692 N_("Invalid value '%s' in Firmware/@type"),
2693 strFirmwareType.c_str());
2694 }
2695 }
2696 else if (pelmHwChild->nameEquals("HID"))
2697 {
2698 Utf8Str strHIDType;
2699 if (pelmHwChild->getAttributeValue("Keyboard", strHIDType))
2700 {
2701 if (strHIDType == "None")
2702 hw.keyboardHIDType = KeyboardHIDType_None;
2703 else if (strHIDType == "USBKeyboard")
2704 hw.keyboardHIDType = KeyboardHIDType_USBKeyboard;
2705 else if (strHIDType == "PS2Keyboard")
2706 hw.keyboardHIDType = KeyboardHIDType_PS2Keyboard;
2707 else if (strHIDType == "ComboKeyboard")
2708 hw.keyboardHIDType = KeyboardHIDType_ComboKeyboard;
2709 else
2710 throw ConfigFileError(this,
2711 pelmHwChild,
2712 N_("Invalid value '%s' in HID/Keyboard/@type"),
2713 strHIDType.c_str());
2714 }
2715 if (pelmHwChild->getAttributeValue("Pointing", strHIDType))
2716 {
2717 if (strHIDType == "None")
2718 hw.pointingHIDType = PointingHIDType_None;
2719 else if (strHIDType == "USBMouse")
2720 hw.pointingHIDType = PointingHIDType_USBMouse;
2721 else if (strHIDType == "USBTablet")
2722 hw.pointingHIDType = PointingHIDType_USBTablet;
2723 else if (strHIDType == "PS2Mouse")
2724 hw.pointingHIDType = PointingHIDType_PS2Mouse;
2725 else if (strHIDType == "ComboMouse")
2726 hw.pointingHIDType = PointingHIDType_ComboMouse;
2727 else if (strHIDType == "USBMultiTouch")
2728 hw.pointingHIDType = PointingHIDType_USBMultiTouch;
2729 else
2730 throw ConfigFileError(this,
2731 pelmHwChild,
2732 N_("Invalid value '%s' in HID/Pointing/@type"),
2733 strHIDType.c_str());
2734 }
2735 }
2736 else if (pelmHwChild->nameEquals("Chipset"))
2737 {
2738 Utf8Str strChipsetType;
2739 if (pelmHwChild->getAttributeValue("type", strChipsetType))
2740 {
2741 if (strChipsetType == "PIIX3")
2742 hw.chipsetType = ChipsetType_PIIX3;
2743 else if (strChipsetType == "ICH9")
2744 hw.chipsetType = ChipsetType_ICH9;
2745 else
2746 throw ConfigFileError(this,
2747 pelmHwChild,
2748 N_("Invalid value '%s' in Chipset/@type"),
2749 strChipsetType.c_str());
2750 }
2751 }
2752 else if (pelmHwChild->nameEquals("HPET"))
2753 {
2754 pelmHwChild->getAttributeValue("enabled", hw.fHPETEnabled);
2755 }
2756 else if (pelmHwChild->nameEquals("Boot"))
2757 {
2758 hw.mapBootOrder.clear();
2759
2760 xml::NodesLoop nl2(*pelmHwChild, "Order");
2761 const xml::ElementNode *pelmOrder;
2762 while ((pelmOrder = nl2.forAllNodes()))
2763 {
2764 uint32_t ulPos;
2765 Utf8Str strDevice;
2766 if (!pelmOrder->getAttributeValue("position", ulPos))
2767 throw ConfigFileError(this, pelmOrder, N_("Required Boot/Order/@position attribute is missing"));
2768
2769 if ( ulPos < 1
2770 || ulPos > SchemaDefs::MaxBootPosition
2771 )
2772 throw ConfigFileError(this,
2773 pelmOrder,
2774 N_("Invalid value '%RU32' in Boot/Order/@position: must be greater than 0 and less than %RU32"),
2775 ulPos,
2776 SchemaDefs::MaxBootPosition + 1);
2777 // XML is 1-based but internal data is 0-based
2778 --ulPos;
2779
2780 if (hw.mapBootOrder.find(ulPos) != hw.mapBootOrder.end())
2781 throw ConfigFileError(this, pelmOrder, N_("Invalid value '%RU32' in Boot/Order/@position: value is not unique"), ulPos);
2782
2783 if (!pelmOrder->getAttributeValue("device", strDevice))
2784 throw ConfigFileError(this, pelmOrder, N_("Required Boot/Order/@device attribute is missing"));
2785
2786 DeviceType_T type;
2787 if (strDevice == "None")
2788 type = DeviceType_Null;
2789 else if (strDevice == "Floppy")
2790 type = DeviceType_Floppy;
2791 else if (strDevice == "DVD")
2792 type = DeviceType_DVD;
2793 else if (strDevice == "HardDisk")
2794 type = DeviceType_HardDisk;
2795 else if (strDevice == "Network")
2796 type = DeviceType_Network;
2797 else
2798 throw ConfigFileError(this, pelmOrder, N_("Invalid value '%s' in Boot/Order/@device attribute"), strDevice.c_str());
2799 hw.mapBootOrder[ulPos] = type;
2800 }
2801 }
2802 else if (pelmHwChild->nameEquals("Display"))
2803 {
2804 Utf8Str strGraphicsControllerType;
2805 if (!pelmHwChild->getAttributeValue("controller", strGraphicsControllerType))
2806 hw.graphicsControllerType = GraphicsControllerType_VBoxVGA;
2807 else
2808 {
2809 strGraphicsControllerType.toUpper();
2810 GraphicsControllerType_T type;
2811 if (strGraphicsControllerType == "VBOXVGA")
2812 type = GraphicsControllerType_VBoxVGA;
2813 else if (strGraphicsControllerType == "NONE")
2814 type = GraphicsControllerType_Null;
2815 else
2816 throw ConfigFileError(this, pelmHwChild, N_("Invalid value '%s' in Display/@controller attribute"), strGraphicsControllerType.c_str());
2817 hw.graphicsControllerType = type;
2818 }
2819 pelmHwChild->getAttributeValue("VRAMSize", hw.ulVRAMSizeMB);
2820 if (!pelmHwChild->getAttributeValue("monitorCount", hw.cMonitors))
2821 pelmHwChild->getAttributeValue("MonitorCount", hw.cMonitors); // pre-v1.5 variant
2822 if (!pelmHwChild->getAttributeValue("accelerate3D", hw.fAccelerate3D))
2823 pelmHwChild->getAttributeValue("Accelerate3D", hw.fAccelerate3D); // pre-v1.5 variant
2824 pelmHwChild->getAttributeValue("accelerate2DVideo", hw.fAccelerate2DVideo);
2825 }
2826 else if (pelmHwChild->nameEquals("VideoCapture"))
2827 {
2828 pelmHwChild->getAttributeValue("enabled", hw.fVideoCaptureEnabled);
2829 pelmHwChild->getAttributeValue("screens", hw.u64VideoCaptureScreens);
2830 pelmHwChild->getAttributeValuePath("file", hw.strVideoCaptureFile);
2831 pelmHwChild->getAttributeValue("horzRes", hw.ulVideoCaptureHorzRes);
2832 pelmHwChild->getAttributeValue("vertRes", hw.ulVideoCaptureVertRes);
2833 pelmHwChild->getAttributeValue("rate", hw.ulVideoCaptureRate);
2834 pelmHwChild->getAttributeValue("fps", hw.ulVideoCaptureFPS);
2835 }
2836 else if (pelmHwChild->nameEquals("RemoteDisplay"))
2837 {
2838 pelmHwChild->getAttributeValue("enabled", hw.vrdeSettings.fEnabled);
2839
2840 Utf8Str str;
2841 if (pelmHwChild->getAttributeValue("port", str))
2842 hw.vrdeSettings.mapProperties["TCP/Ports"] = str;
2843 if (pelmHwChild->getAttributeValue("netAddress", str))
2844 hw.vrdeSettings.mapProperties["TCP/Address"] = str;
2845
2846 Utf8Str strAuthType;
2847 if (pelmHwChild->getAttributeValue("authType", strAuthType))
2848 {
2849 // settings before 1.3 used lower case so make sure this is case-insensitive
2850 strAuthType.toUpper();
2851 if (strAuthType == "NULL")
2852 hw.vrdeSettings.authType = AuthType_Null;
2853 else if (strAuthType == "GUEST")
2854 hw.vrdeSettings.authType = AuthType_Guest;
2855 else if (strAuthType == "EXTERNAL")
2856 hw.vrdeSettings.authType = AuthType_External;
2857 else
2858 throw ConfigFileError(this, pelmHwChild, N_("Invalid value '%s' in RemoteDisplay/@authType attribute"), strAuthType.c_str());
2859 }
2860
2861 pelmHwChild->getAttributeValue("authLibrary", hw.vrdeSettings.strAuthLibrary);
2862 pelmHwChild->getAttributeValue("authTimeout", hw.vrdeSettings.ulAuthTimeout);
2863 pelmHwChild->getAttributeValue("allowMultiConnection", hw.vrdeSettings.fAllowMultiConnection);
2864 pelmHwChild->getAttributeValue("reuseSingleConnection", hw.vrdeSettings.fReuseSingleConnection);
2865
2866 /* 3.2 and 4.0 betas, 4.0 has this information in VRDEProperties. */
2867 const xml::ElementNode *pelmVideoChannel;
2868 if ((pelmVideoChannel = pelmHwChild->findChildElement("VideoChannel")))
2869 {
2870 bool fVideoChannel = false;
2871 pelmVideoChannel->getAttributeValue("enabled", fVideoChannel);
2872 hw.vrdeSettings.mapProperties["VideoChannel/Enabled"] = fVideoChannel? "true": "false";
2873
2874 uint32_t ulVideoChannelQuality = 75;
2875 pelmVideoChannel->getAttributeValue("quality", ulVideoChannelQuality);
2876 ulVideoChannelQuality = RT_CLAMP(ulVideoChannelQuality, 10, 100);
2877 char *pszBuffer = NULL;
2878 if (RTStrAPrintf(&pszBuffer, "%d", ulVideoChannelQuality) >= 0)
2879 {
2880 hw.vrdeSettings.mapProperties["VideoChannel/Quality"] = pszBuffer;
2881 RTStrFree(pszBuffer);
2882 }
2883 else
2884 hw.vrdeSettings.mapProperties["VideoChannel/Quality"] = "75";
2885 }
2886 pelmHwChild->getAttributeValue("VRDEExtPack", hw.vrdeSettings.strVrdeExtPack);
2887
2888 const xml::ElementNode *pelmProperties = pelmHwChild->findChildElement("VRDEProperties");
2889 if (pelmProperties != NULL)
2890 {
2891 xml::NodesLoop nl(*pelmProperties);
2892 const xml::ElementNode *pelmProperty;
2893 while ((pelmProperty = nl.forAllNodes()))
2894 {
2895 if (pelmProperty->nameEquals("Property"))
2896 {
2897 /* <Property name="TCP/Ports" value="3000-3002"/> */
2898 Utf8Str strName, strValue;
2899 if ( ((pelmProperty->getAttributeValue("name", strName)))
2900 && ((pelmProperty->getAttributeValue("value", strValue)))
2901 )
2902 hw.vrdeSettings.mapProperties[strName] = strValue;
2903 else
2904 throw ConfigFileError(this, pelmProperty, N_("Required VRDE Property/@name or @value attribute is missing"));
2905 }
2906 }
2907 }
2908 }
2909 else if (pelmHwChild->nameEquals("BIOS"))
2910 {
2911 const xml::ElementNode *pelmBIOSChild;
2912 if ((pelmBIOSChild = pelmHwChild->findChildElement("ACPI")))
2913 pelmBIOSChild->getAttributeValue("enabled", hw.biosSettings.fACPIEnabled);
2914 if ((pelmBIOSChild = pelmHwChild->findChildElement("IOAPIC")))
2915 pelmBIOSChild->getAttributeValue("enabled", hw.biosSettings.fIOAPICEnabled);
2916 if ((pelmBIOSChild = pelmHwChild->findChildElement("Logo")))
2917 {
2918 pelmBIOSChild->getAttributeValue("fadeIn", hw.biosSettings.fLogoFadeIn);
2919 pelmBIOSChild->getAttributeValue("fadeOut", hw.biosSettings.fLogoFadeOut);
2920 pelmBIOSChild->getAttributeValue("displayTime", hw.biosSettings.ulLogoDisplayTime);
2921 pelmBIOSChild->getAttributeValue("imagePath", hw.biosSettings.strLogoImagePath);
2922 }
2923 if ((pelmBIOSChild = pelmHwChild->findChildElement("BootMenu")))
2924 {
2925 Utf8Str strBootMenuMode;
2926 if (pelmBIOSChild->getAttributeValue("mode", strBootMenuMode))
2927 {
2928 // settings before 1.3 used lower case so make sure this is case-insensitive
2929 strBootMenuMode.toUpper();
2930 if (strBootMenuMode == "DISABLED")
2931 hw.biosSettings.biosBootMenuMode = BIOSBootMenuMode_Disabled;
2932 else if (strBootMenuMode == "MENUONLY")
2933 hw.biosSettings.biosBootMenuMode = BIOSBootMenuMode_MenuOnly;
2934 else if (strBootMenuMode == "MESSAGEANDMENU")
2935 hw.biosSettings.biosBootMenuMode = BIOSBootMenuMode_MessageAndMenu;
2936 else
2937 throw ConfigFileError(this, pelmBIOSChild, N_("Invalid value '%s' in BootMenu/@mode attribute"), strBootMenuMode.c_str());
2938 }
2939 }
2940 if ((pelmBIOSChild = pelmHwChild->findChildElement("PXEDebug")))
2941 pelmBIOSChild->getAttributeValue("enabled", hw.biosSettings.fPXEDebugEnabled);
2942 if ((pelmBIOSChild = pelmHwChild->findChildElement("TimeOffset")))
2943 pelmBIOSChild->getAttributeValue("value", hw.biosSettings.llTimeOffset);
2944
2945 // legacy BIOS/IDEController (pre 1.7)
2946 if ( (m->sv < SettingsVersion_v1_7)
2947 && ((pelmBIOSChild = pelmHwChild->findChildElement("IDEController")))
2948 )
2949 {
2950 StorageController sctl;
2951 sctl.strName = "IDE Controller";
2952 sctl.storageBus = StorageBus_IDE;
2953
2954 Utf8Str strType;
2955 if (pelmBIOSChild->getAttributeValue("type", strType))
2956 {
2957 if (strType == "PIIX3")
2958 sctl.controllerType = StorageControllerType_PIIX3;
2959 else if (strType == "PIIX4")
2960 sctl.controllerType = StorageControllerType_PIIX4;
2961 else if (strType == "ICH6")
2962 sctl.controllerType = StorageControllerType_ICH6;
2963 else
2964 throw ConfigFileError(this, pelmBIOSChild, N_("Invalid value '%s' for IDEController/@type attribute"), strType.c_str());
2965 }
2966 sctl.ulPortCount = 2;
2967 strg.llStorageControllers.push_back(sctl);
2968 }
2969 }
2970 else if (pelmHwChild->nameEquals("USBController"))
2971 {
2972 pelmHwChild->getAttributeValue("enabled", hw.usbController.fEnabled);
2973 pelmHwChild->getAttributeValue("enabledEhci", hw.usbController.fEnabledEHCI);
2974
2975 readUSBDeviceFilters(*pelmHwChild,
2976 hw.usbController.llDeviceFilters);
2977 }
2978 else if ( (m->sv < SettingsVersion_v1_7)
2979 && (pelmHwChild->nameEquals("SATAController"))
2980 )
2981 {
2982 bool f;
2983 if ( (pelmHwChild->getAttributeValue("enabled", f))
2984 && (f)
2985 )
2986 {
2987 StorageController sctl;
2988 sctl.strName = "SATA Controller";
2989 sctl.storageBus = StorageBus_SATA;
2990 sctl.controllerType = StorageControllerType_IntelAhci;
2991
2992 readStorageControllerAttributes(*pelmHwChild, sctl);
2993
2994 strg.llStorageControllers.push_back(sctl);
2995 }
2996 }
2997 else if (pelmHwChild->nameEquals("Network"))
2998 readNetworkAdapters(*pelmHwChild, hw.llNetworkAdapters);
2999 else if (pelmHwChild->nameEquals("RTC"))
3000 {
3001 Utf8Str strLocalOrUTC;
3002 machineUserData.fRTCUseUTC = pelmHwChild->getAttributeValue("localOrUTC", strLocalOrUTC)
3003 && strLocalOrUTC == "UTC";
3004 }
3005 else if ( (pelmHwChild->nameEquals("UART"))
3006 || (pelmHwChild->nameEquals("Uart")) // used before 1.3
3007 )
3008 readSerialPorts(*pelmHwChild, hw.llSerialPorts);
3009 else if ( (pelmHwChild->nameEquals("LPT"))
3010 || (pelmHwChild->nameEquals("Lpt")) // used before 1.3
3011 )
3012 readParallelPorts(*pelmHwChild, hw.llParallelPorts);
3013 else if (pelmHwChild->nameEquals("AudioAdapter"))
3014 readAudioAdapter(*pelmHwChild, hw.audioAdapter);
3015 else if (pelmHwChild->nameEquals("SharedFolders"))
3016 {
3017 xml::NodesLoop nl2(*pelmHwChild, "SharedFolder");
3018 const xml::ElementNode *pelmFolder;
3019 while ((pelmFolder = nl2.forAllNodes()))
3020 {
3021 SharedFolder sf;
3022 pelmFolder->getAttributeValue("name", sf.strName);
3023 pelmFolder->getAttributeValue("hostPath", sf.strHostPath);
3024 pelmFolder->getAttributeValue("writable", sf.fWritable);
3025 pelmFolder->getAttributeValue("autoMount", sf.fAutoMount);
3026 hw.llSharedFolders.push_back(sf);
3027 }
3028 }
3029 else if (pelmHwChild->nameEquals("Clipboard"))
3030 {
3031 Utf8Str strTemp;
3032 if (pelmHwChild->getAttributeValue("mode", strTemp))
3033 {
3034 if (strTemp == "Disabled")
3035 hw.clipboardMode = ClipboardMode_Disabled;
3036 else if (strTemp == "HostToGuest")
3037 hw.clipboardMode = ClipboardMode_HostToGuest;
3038 else if (strTemp == "GuestToHost")
3039 hw.clipboardMode = ClipboardMode_GuestToHost;
3040 else if (strTemp == "Bidirectional")
3041 hw.clipboardMode = ClipboardMode_Bidirectional;
3042 else
3043 throw ConfigFileError(this, pelmHwChild, N_("Invalid value '%s' in Clipboard/@mode attribute"), strTemp.c_str());
3044 }
3045 }
3046 else if (pelmHwChild->nameEquals("DragAndDrop"))
3047 {
3048 Utf8Str strTemp;
3049 if (pelmHwChild->getAttributeValue("mode", strTemp))
3050 {
3051 if (strTemp == "Disabled")
3052 hw.dragAndDropMode = DragAndDropMode_Disabled;
3053 else if (strTemp == "HostToGuest")
3054 hw.dragAndDropMode = DragAndDropMode_HostToGuest;
3055 else if (strTemp == "GuestToHost")
3056 hw.dragAndDropMode = DragAndDropMode_GuestToHost;
3057 else if (strTemp == "Bidirectional")
3058 hw.dragAndDropMode = DragAndDropMode_Bidirectional;
3059 else
3060 throw ConfigFileError(this, pelmHwChild, N_("Invalid value '%s' in DragAndDrop/@mode attribute"), strTemp.c_str());
3061 }
3062 }
3063 else if (pelmHwChild->nameEquals("Guest"))
3064 {
3065 if (!pelmHwChild->getAttributeValue("memoryBalloonSize", hw.ulMemoryBalloonSize))
3066 pelmHwChild->getAttributeValue("MemoryBalloonSize", hw.ulMemoryBalloonSize); // used before 1.3
3067 }
3068 else if (pelmHwChild->nameEquals("GuestProperties"))
3069 readGuestProperties(*pelmHwChild, hw);
3070 else if (pelmHwChild->nameEquals("IO"))
3071 {
3072 const xml::ElementNode *pelmBwGroups;
3073 const xml::ElementNode *pelmIOChild;
3074
3075 if ((pelmIOChild = pelmHwChild->findChildElement("IoCache")))
3076 {
3077 pelmIOChild->getAttributeValue("enabled", hw.ioSettings.fIOCacheEnabled);
3078 pelmIOChild->getAttributeValue("size", hw.ioSettings.ulIOCacheSize);
3079 }
3080
3081 if ((pelmBwGroups = pelmHwChild->findChildElement("BandwidthGroups")))
3082 {
3083 xml::NodesLoop nl2(*pelmBwGroups, "BandwidthGroup");
3084 const xml::ElementNode *pelmBandwidthGroup;
3085 while ((pelmBandwidthGroup = nl2.forAllNodes()))
3086 {
3087 BandwidthGroup gr;
3088 Utf8Str strTemp;
3089
3090 pelmBandwidthGroup->getAttributeValue("name", gr.strName);
3091
3092 if (pelmBandwidthGroup->getAttributeValue("type", strTemp))
3093 {
3094 if (strTemp == "Disk")
3095 gr.enmType = BandwidthGroupType_Disk;
3096 else if (strTemp == "Network")
3097 gr.enmType = BandwidthGroupType_Network;
3098 else
3099 throw ConfigFileError(this, pelmBandwidthGroup, N_("Invalid value '%s' in BandwidthGroup/@type attribute"), strTemp.c_str());
3100 }
3101 else
3102 throw ConfigFileError(this, pelmBandwidthGroup, N_("Missing BandwidthGroup/@type attribute"));
3103
3104 if (!pelmBandwidthGroup->getAttributeValue("maxBytesPerSec", gr.cMaxBytesPerSec))
3105 {
3106 pelmBandwidthGroup->getAttributeValue("maxMbPerSec", gr.cMaxBytesPerSec);
3107 gr.cMaxBytesPerSec *= _1M;
3108 }
3109 hw.ioSettings.llBandwidthGroups.push_back(gr);
3110 }
3111 }
3112 } else if (pelmHwChild->nameEquals("HostPci")) {
3113 const xml::ElementNode *pelmDevices;
3114
3115 if ((pelmDevices = pelmHwChild->findChildElement("Devices")))
3116 {
3117 xml::NodesLoop nl2(*pelmDevices, "Device");
3118 const xml::ElementNode *pelmDevice;
3119 while ((pelmDevice = nl2.forAllNodes()))
3120 {
3121 HostPCIDeviceAttachment hpda;
3122
3123 if (!pelmDevice->getAttributeValue("host", hpda.uHostAddress))
3124 throw ConfigFileError(this, pelmDevice, N_("Missing Device/@host attribute"));
3125
3126 if (!pelmDevice->getAttributeValue("guest", hpda.uGuestAddress))
3127 throw ConfigFileError(this, pelmDevice, N_("Missing Device/@guest attribute"));
3128
3129 /* name is optional */
3130 pelmDevice->getAttributeValue("name", hpda.strDeviceName);
3131
3132 hw.pciAttachments.push_back(hpda);
3133 }
3134 }
3135 }
3136 else if (pelmHwChild->nameEquals("EmulatedUSB"))
3137 {
3138 const xml::ElementNode *pelmCardReader, *pelmWebcam;
3139
3140 if ((pelmCardReader = pelmHwChild->findChildElement("CardReader")))
3141 {
3142 pelmCardReader->getAttributeValue("enabled", hw.fEmulatedUSBCardReader);
3143 }
3144
3145 if ((pelmWebcam = pelmHwChild->findChildElement("Webcam")))
3146 {
3147 pelmWebcam->getAttributeValue("enabled", hw.fEmulatedUSBWebcam);
3148 }
3149 }
3150 else if (pelmHwChild->nameEquals("Frontend"))
3151 {
3152 const xml::ElementNode *pelmDefault;
3153
3154 if ((pelmDefault = pelmHwChild->findChildElement("Default")))
3155 {
3156 pelmDefault->getAttributeValue("type", hw.strDefaultFrontend);
3157 }
3158 }
3159 }
3160
3161 if (hw.ulMemorySizeMB == (uint32_t)-1)
3162 throw ConfigFileError(this, &elmHardware, N_("Required Memory/@RAMSize element/attribute is missing"));
3163}
3164
3165/**
3166 * This gets called instead of readStorageControllers() for legacy pre-1.7 settings
3167 * files which have a <HardDiskAttachments> node and storage controller settings
3168 * hidden in the <Hardware> settings. We set the StorageControllers fields just the
3169 * same, just from different sources.
3170 * @param elmHardware <Hardware> XML node.
3171 * @param elmHardDiskAttachments <HardDiskAttachments> XML node.
3172 * @param strg
3173 */
3174void MachineConfigFile::readHardDiskAttachments_pre1_7(const xml::ElementNode &elmHardDiskAttachments,
3175 Storage &strg)
3176{
3177 StorageController *pIDEController = NULL;
3178 StorageController *pSATAController = NULL;
3179
3180 for (StorageControllersList::iterator it = strg.llStorageControllers.begin();
3181 it != strg.llStorageControllers.end();
3182 ++it)
3183 {
3184 StorageController &s = *it;
3185 if (s.storageBus == StorageBus_IDE)
3186 pIDEController = &s;
3187 else if (s.storageBus == StorageBus_SATA)
3188 pSATAController = &s;
3189 }
3190
3191 xml::NodesLoop nl1(elmHardDiskAttachments, "HardDiskAttachment");
3192 const xml::ElementNode *pelmAttachment;
3193 while ((pelmAttachment = nl1.forAllNodes()))
3194 {
3195 AttachedDevice att;
3196 Utf8Str strUUID, strBus;
3197
3198 if (!pelmAttachment->getAttributeValue("hardDisk", strUUID))
3199 throw ConfigFileError(this, pelmAttachment, N_("Required HardDiskAttachment/@hardDisk attribute is missing"));
3200 parseUUID(att.uuid, strUUID);
3201
3202 if (!pelmAttachment->getAttributeValue("bus", strBus))
3203 throw ConfigFileError(this, pelmAttachment, N_("Required HardDiskAttachment/@bus attribute is missing"));
3204 // pre-1.7 'channel' is now port
3205 if (!pelmAttachment->getAttributeValue("channel", att.lPort))
3206 throw ConfigFileError(this, pelmAttachment, N_("Required HardDiskAttachment/@channel attribute is missing"));
3207 // pre-1.7 'device' is still device
3208 if (!pelmAttachment->getAttributeValue("device", att.lDevice))
3209 throw ConfigFileError(this, pelmAttachment, N_("Required HardDiskAttachment/@device attribute is missing"));
3210
3211 att.deviceType = DeviceType_HardDisk;
3212
3213 if (strBus == "IDE")
3214 {
3215 if (!pIDEController)
3216 throw ConfigFileError(this, pelmAttachment, N_("HardDiskAttachment/@bus is 'IDE' but cannot find IDE controller"));
3217 pIDEController->llAttachedDevices.push_back(att);
3218 }
3219 else if (strBus == "SATA")
3220 {
3221 if (!pSATAController)
3222 throw ConfigFileError(this, pelmAttachment, N_("HardDiskAttachment/@bus is 'SATA' but cannot find SATA controller"));
3223 pSATAController->llAttachedDevices.push_back(att);
3224 }
3225 else
3226 throw ConfigFileError(this, pelmAttachment, N_("HardDiskAttachment/@bus attribute has illegal value '%s'"), strBus.c_str());
3227 }
3228}
3229
3230/**
3231 * Reads in a <StorageControllers> block and stores it in the given Storage structure.
3232 * Used both directly from readMachine and from readSnapshot, since snapshots
3233 * have their own storage controllers sections.
3234 *
3235 * This is only called for settings version 1.7 and above; see readHardDiskAttachments_pre1_7()
3236 * for earlier versions.
3237 *
3238 * @param elmStorageControllers
3239 */
3240void MachineConfigFile::readStorageControllers(const xml::ElementNode &elmStorageControllers,
3241 Storage &strg)
3242{
3243 xml::NodesLoop nlStorageControllers(elmStorageControllers, "StorageController");
3244 const xml::ElementNode *pelmController;
3245 while ((pelmController = nlStorageControllers.forAllNodes()))
3246 {
3247 StorageController sctl;
3248
3249 if (!pelmController->getAttributeValue("name", sctl.strName))
3250 throw ConfigFileError(this, pelmController, N_("Required StorageController/@name attribute is missing"));
3251 // canonicalize storage controller names for configs in the switchover
3252 // period.
3253 if (m->sv < SettingsVersion_v1_9)
3254 {
3255 if (sctl.strName == "IDE")
3256 sctl.strName = "IDE Controller";
3257 else if (sctl.strName == "SATA")
3258 sctl.strName = "SATA Controller";
3259 else if (sctl.strName == "SCSI")
3260 sctl.strName = "SCSI Controller";
3261 }
3262
3263 pelmController->getAttributeValue("Instance", sctl.ulInstance);
3264 // default from constructor is 0
3265
3266 pelmController->getAttributeValue("Bootable", sctl.fBootable);
3267 // default from constructor is true which is true
3268 // for settings below version 1.11 because they allowed only
3269 // one controller per type.
3270
3271 Utf8Str strType;
3272 if (!pelmController->getAttributeValue("type", strType))
3273 throw ConfigFileError(this, pelmController, N_("Required StorageController/@type attribute is missing"));
3274
3275 if (strType == "AHCI")
3276 {
3277 sctl.storageBus = StorageBus_SATA;
3278 sctl.controllerType = StorageControllerType_IntelAhci;
3279 }
3280 else if (strType == "LsiLogic")
3281 {
3282 sctl.storageBus = StorageBus_SCSI;
3283 sctl.controllerType = StorageControllerType_LsiLogic;
3284 }
3285 else if (strType == "BusLogic")
3286 {
3287 sctl.storageBus = StorageBus_SCSI;
3288 sctl.controllerType = StorageControllerType_BusLogic;
3289 }
3290 else if (strType == "PIIX3")
3291 {
3292 sctl.storageBus = StorageBus_IDE;
3293 sctl.controllerType = StorageControllerType_PIIX3;
3294 }
3295 else if (strType == "PIIX4")
3296 {
3297 sctl.storageBus = StorageBus_IDE;
3298 sctl.controllerType = StorageControllerType_PIIX4;
3299 }
3300 else if (strType == "ICH6")
3301 {
3302 sctl.storageBus = StorageBus_IDE;
3303 sctl.controllerType = StorageControllerType_ICH6;
3304 }
3305 else if ( (m->sv >= SettingsVersion_v1_9)
3306 && (strType == "I82078")
3307 )
3308 {
3309 sctl.storageBus = StorageBus_Floppy;
3310 sctl.controllerType = StorageControllerType_I82078;
3311 }
3312 else if (strType == "LsiLogicSas")
3313 {
3314 sctl.storageBus = StorageBus_SAS;
3315 sctl.controllerType = StorageControllerType_LsiLogicSas;
3316 }
3317 else
3318 throw ConfigFileError(this, pelmController, N_("Invalid value '%s' for StorageController/@type attribute"), strType.c_str());
3319
3320 readStorageControllerAttributes(*pelmController, sctl);
3321
3322 xml::NodesLoop nlAttached(*pelmController, "AttachedDevice");
3323 const xml::ElementNode *pelmAttached;
3324 while ((pelmAttached = nlAttached.forAllNodes()))
3325 {
3326 AttachedDevice att;
3327 Utf8Str strTemp;
3328 pelmAttached->getAttributeValue("type", strTemp);
3329
3330 att.fDiscard = false;
3331 att.fNonRotational = false;
3332
3333 if (strTemp == "HardDisk")
3334 {
3335 att.deviceType = DeviceType_HardDisk;
3336 pelmAttached->getAttributeValue("nonrotational", att.fNonRotational);
3337 pelmAttached->getAttributeValue("discard", att.fDiscard);
3338 }
3339 else if (m->sv >= SettingsVersion_v1_9)
3340 {
3341 // starting with 1.9 we list DVD and floppy drive info + attachments under <StorageControllers>
3342 if (strTemp == "DVD")
3343 {
3344 att.deviceType = DeviceType_DVD;
3345 pelmAttached->getAttributeValue("passthrough", att.fPassThrough);
3346 pelmAttached->getAttributeValue("tempeject", att.fTempEject);
3347 }
3348 else if (strTemp == "Floppy")
3349 att.deviceType = DeviceType_Floppy;
3350 }
3351
3352 if (att.deviceType != DeviceType_Null)
3353 {
3354 const xml::ElementNode *pelmImage;
3355 // all types can have images attached, but for HardDisk it's required
3356 if (!(pelmImage = pelmAttached->findChildElement("Image")))
3357 {
3358 if (att.deviceType == DeviceType_HardDisk)
3359 throw ConfigFileError(this, pelmImage, N_("Required AttachedDevice/Image element is missing"));
3360 else
3361 {
3362 // DVDs and floppies can also have <HostDrive> instead of <Image>
3363 const xml::ElementNode *pelmHostDrive;
3364 if ((pelmHostDrive = pelmAttached->findChildElement("HostDrive")))
3365 if (!pelmHostDrive->getAttributeValue("src", att.strHostDriveSrc))
3366 throw ConfigFileError(this, pelmHostDrive, N_("Required AttachedDevice/HostDrive/@src attribute is missing"));
3367 }
3368 }
3369 else
3370 {
3371 if (!pelmImage->getAttributeValue("uuid", strTemp))
3372 throw ConfigFileError(this, pelmImage, N_("Required AttachedDevice/Image/@uuid attribute is missing"));
3373 parseUUID(att.uuid, strTemp);
3374 }
3375
3376 if (!pelmAttached->getAttributeValue("port", att.lPort))
3377 throw ConfigFileError(this, pelmImage, N_("Required AttachedDevice/@port attribute is missing"));
3378 if (!pelmAttached->getAttributeValue("device", att.lDevice))
3379 throw ConfigFileError(this, pelmImage, N_("Required AttachedDevice/@device attribute is missing"));
3380
3381 pelmAttached->getAttributeValue("bandwidthGroup", att.strBwGroup);
3382 sctl.llAttachedDevices.push_back(att);
3383 }
3384 }
3385
3386 strg.llStorageControllers.push_back(sctl);
3387 }
3388}
3389
3390/**
3391 * This gets called for legacy pre-1.9 settings files after having parsed the
3392 * <Hardware> and <StorageControllers> sections to parse <Hardware> once more
3393 * for the <DVDDrive> and <FloppyDrive> sections.
3394 *
3395 * Before settings version 1.9, DVD and floppy drives were specified separately
3396 * under <Hardware>; we then need this extra loop to make sure the storage
3397 * controller structs are already set up so we can add stuff to them.
3398 *
3399 * @param elmHardware
3400 * @param strg
3401 */
3402void MachineConfigFile::readDVDAndFloppies_pre1_9(const xml::ElementNode &elmHardware,
3403 Storage &strg)
3404{
3405 xml::NodesLoop nl1(elmHardware);
3406 const xml::ElementNode *pelmHwChild;
3407 while ((pelmHwChild = nl1.forAllNodes()))
3408 {
3409 if (pelmHwChild->nameEquals("DVDDrive"))
3410 {
3411 // create a DVD "attached device" and attach it to the existing IDE controller
3412 AttachedDevice att;
3413 att.deviceType = DeviceType_DVD;
3414 // legacy DVD drive is always secondary master (port 1, device 0)
3415 att.lPort = 1;
3416 att.lDevice = 0;
3417 pelmHwChild->getAttributeValue("passthrough", att.fPassThrough);
3418 pelmHwChild->getAttributeValue("tempeject", att.fTempEject);
3419
3420 const xml::ElementNode *pDriveChild;
3421 Utf8Str strTmp;
3422 if ( ((pDriveChild = pelmHwChild->findChildElement("Image")))
3423 && (pDriveChild->getAttributeValue("uuid", strTmp))
3424 )
3425 parseUUID(att.uuid, strTmp);
3426 else if ((pDriveChild = pelmHwChild->findChildElement("HostDrive")))
3427 pDriveChild->getAttributeValue("src", att.strHostDriveSrc);
3428
3429 // find the IDE controller and attach the DVD drive
3430 bool fFound = false;
3431 for (StorageControllersList::iterator it = strg.llStorageControllers.begin();
3432 it != strg.llStorageControllers.end();
3433 ++it)
3434 {
3435 StorageController &sctl = *it;
3436 if (sctl.storageBus == StorageBus_IDE)
3437 {
3438 sctl.llAttachedDevices.push_back(att);
3439 fFound = true;
3440 break;
3441 }
3442 }
3443
3444 if (!fFound)
3445 throw ConfigFileError(this, pelmHwChild, N_("Internal error: found DVD drive but IDE controller does not exist"));
3446 // shouldn't happen because pre-1.9 settings files always had at least one IDE controller in the settings
3447 // which should have gotten parsed in <StorageControllers> before this got called
3448 }
3449 else if (pelmHwChild->nameEquals("FloppyDrive"))
3450 {
3451 bool fEnabled;
3452 if ( (pelmHwChild->getAttributeValue("enabled", fEnabled))
3453 && (fEnabled)
3454 )
3455 {
3456 // create a new floppy controller and attach a floppy "attached device"
3457 StorageController sctl;
3458 sctl.strName = "Floppy Controller";
3459 sctl.storageBus = StorageBus_Floppy;
3460 sctl.controllerType = StorageControllerType_I82078;
3461 sctl.ulPortCount = 1;
3462
3463 AttachedDevice att;
3464 att.deviceType = DeviceType_Floppy;
3465 att.lPort = 0;
3466 att.lDevice = 0;
3467
3468 const xml::ElementNode *pDriveChild;
3469 Utf8Str strTmp;
3470 if ( ((pDriveChild = pelmHwChild->findChildElement("Image")))
3471 && (pDriveChild->getAttributeValue("uuid", strTmp))
3472 )
3473 parseUUID(att.uuid, strTmp);
3474 else if ((pDriveChild = pelmHwChild->findChildElement("HostDrive")))
3475 pDriveChild->getAttributeValue("src", att.strHostDriveSrc);
3476
3477 // store attachment with controller
3478 sctl.llAttachedDevices.push_back(att);
3479 // store controller with storage
3480 strg.llStorageControllers.push_back(sctl);
3481 }
3482 }
3483 }
3484}
3485
3486/**
3487 * Called for reading the <Teleporter> element under <Machine>.
3488 */
3489void MachineConfigFile::readTeleporter(const xml::ElementNode *pElmTeleporter,
3490 MachineUserData *pUserData)
3491{
3492 pElmTeleporter->getAttributeValue("enabled", pUserData->fTeleporterEnabled);
3493 pElmTeleporter->getAttributeValue("port", pUserData->uTeleporterPort);
3494 pElmTeleporter->getAttributeValue("address", pUserData->strTeleporterAddress);
3495 pElmTeleporter->getAttributeValue("password", pUserData->strTeleporterPassword);
3496
3497 if ( pUserData->strTeleporterPassword.isNotEmpty()
3498 && !VBoxIsPasswordHashed(&pUserData->strTeleporterPassword))
3499 VBoxHashPassword(&pUserData->strTeleporterPassword);
3500}
3501
3502/**
3503 * Called for reading the <Debugging> element under <Machine> or <Snapshot>.
3504 */
3505void MachineConfigFile::readDebugging(const xml::ElementNode *pElmDebugging, Debugging *pDbg)
3506{
3507 if (!pElmDebugging || m->sv < SettingsVersion_v1_13)
3508 return;
3509
3510 const xml::ElementNode * const pelmTracing = pElmDebugging->findChildElement("Tracing");
3511 if (pelmTracing)
3512 {
3513 pelmTracing->getAttributeValue("enabled", pDbg->fTracingEnabled);
3514 pelmTracing->getAttributeValue("allowTracingToAccessVM", pDbg->fAllowTracingToAccessVM);
3515 pelmTracing->getAttributeValue("config", pDbg->strTracingConfig);
3516 }
3517}
3518
3519/**
3520 * Called for reading the <Autostart> element under <Machine> or <Snapshot>.
3521 */
3522void MachineConfigFile::readAutostart(const xml::ElementNode *pElmAutostart, Autostart *pAutostart)
3523{
3524 Utf8Str strAutostop;
3525
3526 if (!pElmAutostart || m->sv < SettingsVersion_v1_13)
3527 return;
3528
3529 pElmAutostart->getAttributeValue("enabled", pAutostart->fAutostartEnabled);
3530 pElmAutostart->getAttributeValue("delay", pAutostart->uAutostartDelay);
3531 pElmAutostart->getAttributeValue("autostop", strAutostop);
3532 if (strAutostop == "Disabled")
3533 pAutostart->enmAutostopType = AutostopType_Disabled;
3534 else if (strAutostop == "SaveState")
3535 pAutostart->enmAutostopType = AutostopType_SaveState;
3536 else if (strAutostop == "PowerOff")
3537 pAutostart->enmAutostopType = AutostopType_PowerOff;
3538 else if (strAutostop == "AcpiShutdown")
3539 pAutostart->enmAutostopType = AutostopType_AcpiShutdown;
3540 else
3541 throw ConfigFileError(this, pElmAutostart, N_("Invalid value '%s' for Autostart/@autostop attribute"), strAutostop.c_str());
3542}
3543
3544/**
3545 * Called for reading the <Groups> element under <Machine>.
3546 */
3547void MachineConfigFile::readGroups(const xml::ElementNode *pElmGroups, StringsList *pllGroups)
3548{
3549 pllGroups->clear();
3550 if (!pElmGroups || m->sv < SettingsVersion_v1_13)
3551 {
3552 pllGroups->push_back("/");
3553 return;
3554 }
3555
3556 xml::NodesLoop nlGroups(*pElmGroups);
3557 const xml::ElementNode *pelmGroup;
3558 while ((pelmGroup = nlGroups.forAllNodes()))
3559 {
3560 if (pelmGroup->nameEquals("Group"))
3561 {
3562 Utf8Str strGroup;
3563 if (!pelmGroup->getAttributeValue("name", strGroup))
3564 throw ConfigFileError(this, pelmGroup, N_("Required Group/@name attribute is missing"));
3565 pllGroups->push_back(strGroup);
3566 }
3567 }
3568}
3569
3570/**
3571 * Called initially for the <Snapshot> element under <Machine>, if present,
3572 * to store the snapshot's data into the given Snapshot structure (which is
3573 * then the one in the Machine struct). This might then recurse if
3574 * a <Snapshots> (plural) element is found in the snapshot, which should
3575 * contain a list of child snapshots; such lists are maintained in the
3576 * Snapshot structure.
3577 *
3578 * @param depth
3579 * @param elmSnapshot
3580 * @param snap
3581 */
3582void MachineConfigFile::readSnapshot(uint32_t depth,
3583 const xml::ElementNode &elmSnapshot,
3584 Snapshot &snap)
3585{
3586 if (depth > SETTINGS_SNAPSHOT_DEPTH_MAX)
3587 throw ConfigFileError(this, &elmSnapshot, N_("Maximum snapshot tree depth of %u exceeded"), depth);
3588
3589 Utf8Str strTemp;
3590
3591 if (!elmSnapshot.getAttributeValue("uuid", strTemp))
3592 throw ConfigFileError(this, &elmSnapshot, N_("Required Snapshot/@uuid attribute is missing"));
3593 parseUUID(snap.uuid, strTemp);
3594
3595 if (!elmSnapshot.getAttributeValue("name", snap.strName))
3596 throw ConfigFileError(this, &elmSnapshot, N_("Required Snapshot/@name attribute is missing"));
3597
3598 // earlier 3.1 trunk builds had a bug and added Description as an attribute, read it silently and write it back as an element
3599 elmSnapshot.getAttributeValue("Description", snap.strDescription);
3600
3601 if (!elmSnapshot.getAttributeValue("timeStamp", strTemp))
3602 throw ConfigFileError(this, &elmSnapshot, N_("Required Snapshot/@timeStamp attribute is missing"));
3603 parseTimestamp(snap.timestamp, strTemp);
3604
3605 elmSnapshot.getAttributeValuePath("stateFile", snap.strStateFile); // online snapshots only
3606
3607 // parse Hardware before the other elements because other things depend on it
3608 const xml::ElementNode *pelmHardware;
3609 if (!(pelmHardware = elmSnapshot.findChildElement("Hardware")))
3610 throw ConfigFileError(this, &elmSnapshot, N_("Required Snapshot/@Hardware element is missing"));
3611 readHardware(*pelmHardware, snap.hardware, snap.storage);
3612
3613 xml::NodesLoop nlSnapshotChildren(elmSnapshot);
3614 const xml::ElementNode *pelmSnapshotChild;
3615 while ((pelmSnapshotChild = nlSnapshotChildren.forAllNodes()))
3616 {
3617 if (pelmSnapshotChild->nameEquals("Description"))
3618 snap.strDescription = pelmSnapshotChild->getValue();
3619 else if ( (m->sv < SettingsVersion_v1_7)
3620 && (pelmSnapshotChild->nameEquals("HardDiskAttachments"))
3621 )
3622 readHardDiskAttachments_pre1_7(*pelmSnapshotChild, snap.storage);
3623 else if ( (m->sv >= SettingsVersion_v1_7)
3624 && (pelmSnapshotChild->nameEquals("StorageControllers"))
3625 )
3626 readStorageControllers(*pelmSnapshotChild, snap.storage);
3627 else if (pelmSnapshotChild->nameEquals("Snapshots"))
3628 {
3629 xml::NodesLoop nlChildSnapshots(*pelmSnapshotChild);
3630 const xml::ElementNode *pelmChildSnapshot;
3631 while ((pelmChildSnapshot = nlChildSnapshots.forAllNodes()))
3632 {
3633 if (pelmChildSnapshot->nameEquals("Snapshot"))
3634 {
3635 // Use the heap to reduce the stack footprint. Each
3636 // recursion needs over 1K, and there can be VMs with
3637 // deeply nested snapshots. The stack can be quite
3638 // small, especially with XPCOM.
3639 Snapshot *child = new Snapshot();
3640 readSnapshot(depth + 1, *pelmChildSnapshot, *child);
3641 snap.llChildSnapshots.push_back(*child);
3642 delete child;
3643 }
3644 }
3645 }
3646 }
3647
3648 if (m->sv < SettingsVersion_v1_9)
3649 // go through Hardware once more to repair the settings controller structures
3650 // with data from old DVDDrive and FloppyDrive elements
3651 readDVDAndFloppies_pre1_9(*pelmHardware, snap.storage);
3652
3653 readDebugging(elmSnapshot.findChildElement("Debugging"), &snap.debugging);
3654 readAutostart(elmSnapshot.findChildElement("Autostart"), &snap.autostart);
3655 // note: Groups exist only for Machine, not for Snapshot
3656}
3657
3658const struct {
3659 const char *pcszOld;
3660 const char *pcszNew;
3661} aConvertOSTypes[] =
3662{
3663 { "unknown", "Other" },
3664 { "dos", "DOS" },
3665 { "win31", "Windows31" },
3666 { "win95", "Windows95" },
3667 { "win98", "Windows98" },
3668 { "winme", "WindowsMe" },
3669 { "winnt4", "WindowsNT4" },
3670 { "win2k", "Windows2000" },
3671 { "winxp", "WindowsXP" },
3672 { "win2k3", "Windows2003" },
3673 { "winvista", "WindowsVista" },
3674 { "win2k8", "Windows2008" },
3675 { "os2warp3", "OS2Warp3" },
3676 { "os2warp4", "OS2Warp4" },
3677 { "os2warp45", "OS2Warp45" },
3678 { "ecs", "OS2eCS" },
3679 { "linux22", "Linux22" },
3680 { "linux24", "Linux24" },
3681 { "linux26", "Linux26" },
3682 { "archlinux", "ArchLinux" },
3683 { "debian", "Debian" },
3684 { "opensuse", "OpenSUSE" },
3685 { "fedoracore", "Fedora" },
3686 { "gentoo", "Gentoo" },
3687 { "mandriva", "Mandriva" },
3688 { "redhat", "RedHat" },
3689 { "ubuntu", "Ubuntu" },
3690 { "xandros", "Xandros" },
3691 { "freebsd", "FreeBSD" },
3692 { "openbsd", "OpenBSD" },
3693 { "netbsd", "NetBSD" },
3694 { "netware", "Netware" },
3695 { "solaris", "Solaris" },
3696 { "opensolaris", "OpenSolaris" },
3697 { "l4", "L4" }
3698};
3699
3700void MachineConfigFile::convertOldOSType_pre1_5(Utf8Str &str)
3701{
3702 for (unsigned u = 0;
3703 u < RT_ELEMENTS(aConvertOSTypes);
3704 ++u)
3705 {
3706 if (str == aConvertOSTypes[u].pcszOld)
3707 {
3708 str = aConvertOSTypes[u].pcszNew;
3709 break;
3710 }
3711 }
3712}
3713
3714/**
3715 * Called from the constructor to actually read in the <Machine> element
3716 * of a machine config file.
3717 * @param elmMachine
3718 */
3719void MachineConfigFile::readMachine(const xml::ElementNode &elmMachine)
3720{
3721 Utf8Str strUUID;
3722 if ( (elmMachine.getAttributeValue("uuid", strUUID))
3723 && (elmMachine.getAttributeValue("name", machineUserData.strName))
3724 )
3725 {
3726 parseUUID(uuid, strUUID);
3727
3728 elmMachine.getAttributeValue("directoryIncludesUUID", machineUserData.fDirectoryIncludesUUID);
3729 elmMachine.getAttributeValue("nameSync", machineUserData.fNameSync);
3730
3731 Utf8Str str;
3732 elmMachine.getAttributeValue("Description", machineUserData.strDescription);
3733 elmMachine.getAttributeValue("Icon", machineUserData.ovIcon);
3734
3735 elmMachine.getAttributeValue("OSType", machineUserData.strOsType);
3736 if (m->sv < SettingsVersion_v1_5)
3737 convertOldOSType_pre1_5(machineUserData.strOsType);
3738
3739 elmMachine.getAttributeValuePath("stateFile", strStateFile);
3740
3741 if (elmMachine.getAttributeValue("currentSnapshot", str))
3742 parseUUID(uuidCurrentSnapshot, str);
3743
3744 elmMachine.getAttributeValuePath("snapshotFolder", machineUserData.strSnapshotFolder);
3745
3746 if (!elmMachine.getAttributeValue("currentStateModified", fCurrentStateModified))
3747 fCurrentStateModified = true;
3748 if (elmMachine.getAttributeValue("lastStateChange", str))
3749 parseTimestamp(timeLastStateChange, str);
3750 // constructor has called RTTimeNow(&timeLastStateChange) before
3751 if (elmMachine.getAttributeValue("aborted", fAborted))
3752 fAborted = true;
3753
3754 // parse Hardware before the other elements because other things depend on it
3755 const xml::ElementNode *pelmHardware;
3756 if (!(pelmHardware = elmMachine.findChildElement("Hardware")))
3757 throw ConfigFileError(this, &elmMachine, N_("Required Machine/Hardware element is missing"));
3758 readHardware(*pelmHardware, hardwareMachine, storageMachine);
3759
3760 xml::NodesLoop nlRootChildren(elmMachine);
3761 const xml::ElementNode *pelmMachineChild;
3762 while ((pelmMachineChild = nlRootChildren.forAllNodes()))
3763 {
3764 if (pelmMachineChild->nameEquals("ExtraData"))
3765 readExtraData(*pelmMachineChild,
3766 mapExtraDataItems);
3767 else if ( (m->sv < SettingsVersion_v1_7)
3768 && (pelmMachineChild->nameEquals("HardDiskAttachments"))
3769 )
3770 readHardDiskAttachments_pre1_7(*pelmMachineChild, storageMachine);
3771 else if ( (m->sv >= SettingsVersion_v1_7)
3772 && (pelmMachineChild->nameEquals("StorageControllers"))
3773 )
3774 readStorageControllers(*pelmMachineChild, storageMachine);
3775 else if (pelmMachineChild->nameEquals("Snapshot"))
3776 {
3777 Snapshot snap;
3778 // this will recurse into child snapshots, if necessary
3779 readSnapshot(1, *pelmMachineChild, snap);
3780 llFirstSnapshot.push_back(snap);
3781 }
3782 else if (pelmMachineChild->nameEquals("Description"))
3783 machineUserData.strDescription = pelmMachineChild->getValue();
3784 else if (pelmMachineChild->nameEquals("Teleporter"))
3785 readTeleporter(pelmMachineChild, &machineUserData);
3786 else if (pelmMachineChild->nameEquals("FaultTolerance"))
3787 {
3788 Utf8Str strFaultToleranceSate;
3789 if (pelmMachineChild->getAttributeValue("state", strFaultToleranceSate))
3790 {
3791 if (strFaultToleranceSate == "master")
3792 machineUserData.enmFaultToleranceState = FaultToleranceState_Master;
3793 else
3794 if (strFaultToleranceSate == "standby")
3795 machineUserData.enmFaultToleranceState = FaultToleranceState_Standby;
3796 else
3797 machineUserData.enmFaultToleranceState = FaultToleranceState_Inactive;
3798 }
3799 pelmMachineChild->getAttributeValue("port", machineUserData.uFaultTolerancePort);
3800 pelmMachineChild->getAttributeValue("address", machineUserData.strFaultToleranceAddress);
3801 pelmMachineChild->getAttributeValue("interval", machineUserData.uFaultToleranceInterval);
3802 pelmMachineChild->getAttributeValue("password", machineUserData.strFaultTolerancePassword);
3803 }
3804 else if (pelmMachineChild->nameEquals("MediaRegistry"))
3805 readMediaRegistry(*pelmMachineChild, mediaRegistry);
3806 else if (pelmMachineChild->nameEquals("Debugging"))
3807 readDebugging(pelmMachineChild, &debugging);
3808 else if (pelmMachineChild->nameEquals("Autostart"))
3809 readAutostart(pelmMachineChild, &autostart);
3810 else if (pelmMachineChild->nameEquals("Groups"))
3811 readGroups(pelmMachineChild, &machineUserData.llGroups);
3812 }
3813
3814 if (m->sv < SettingsVersion_v1_9)
3815 // go through Hardware once more to repair the settings controller structures
3816 // with data from old DVDDrive and FloppyDrive elements
3817 readDVDAndFloppies_pre1_9(*pelmHardware, storageMachine);
3818 }
3819 else
3820 throw ConfigFileError(this, &elmMachine, N_("Required Machine/@uuid or @name attributes is missing"));
3821}
3822
3823/**
3824 * Creates a <Hardware> node under elmParent and then writes out the XML
3825 * keys under that. Called for both the <Machine> node and for snapshots.
3826 * @param elmParent
3827 * @param st
3828 */
3829void MachineConfigFile::buildHardwareXML(xml::ElementNode &elmParent,
3830 const Hardware &hw,
3831 const Storage &strg)
3832{
3833 xml::ElementNode *pelmHardware = elmParent.createChild("Hardware");
3834
3835 if (m->sv >= SettingsVersion_v1_4)
3836 pelmHardware->setAttribute("version", hw.strVersion);
3837
3838 if ((m->sv >= SettingsVersion_v1_9)
3839 && !hw.uuid.isZero()
3840 && hw.uuid.isValid()
3841 )
3842 pelmHardware->setAttribute("uuid", hw.uuid.toStringCurly());
3843
3844 xml::ElementNode *pelmCPU = pelmHardware->createChild("CPU");
3845
3846 xml::ElementNode *pelmHwVirtEx = pelmCPU->createChild("HardwareVirtEx");
3847 pelmHwVirtEx->setAttribute("enabled", hw.fHardwareVirt);
3848 if (m->sv >= SettingsVersion_v1_9)
3849 pelmHwVirtEx->setAttribute("exclusive", hw.fHardwareVirtExclusive);
3850
3851 pelmCPU->createChild("HardwareVirtExNestedPaging")->setAttribute("enabled", hw.fNestedPaging);
3852 pelmCPU->createChild("HardwareVirtExVPID")->setAttribute("enabled", hw.fVPID);
3853 pelmCPU->createChild("HardwareVirtExUX")->setAttribute("enabled", hw.fUnrestrictedExecution);
3854 pelmCPU->createChild("PAE")->setAttribute("enabled", hw.fPAE);
3855 if (m->sv >= SettingsVersion_v1_14 && hw.enmLongMode != Hardware::LongMode_Legacy)
3856 pelmCPU->createChild("LongMode")->setAttribute("enabled", hw.enmLongMode == Hardware::LongMode_Enabled);
3857
3858 if (hw.fSyntheticCpu)
3859 pelmCPU->createChild("SyntheticCpu")->setAttribute("enabled", hw.fSyntheticCpu);
3860 pelmCPU->setAttribute("count", hw.cCPUs);
3861 if (hw.ulCpuExecutionCap != 100)
3862 pelmCPU->setAttribute("executionCap", hw.ulCpuExecutionCap);
3863
3864 /* Always save this setting as we have changed the default in 4.0 (on for large memory 64-bit systems). */
3865 pelmCPU->createChild("HardwareVirtExLargePages")->setAttribute("enabled", hw.fLargePages);
3866
3867 if (m->sv >= SettingsVersion_v1_9)
3868 pelmCPU->createChild("HardwareVirtForce")->setAttribute("enabled", hw.fHardwareVirtForce);
3869
3870 if (m->sv >= SettingsVersion_v1_10)
3871 {
3872 pelmCPU->setAttribute("hotplug", hw.fCpuHotPlug);
3873
3874 xml::ElementNode *pelmCpuTree = NULL;
3875 for (CpuList::const_iterator it = hw.llCpus.begin();
3876 it != hw.llCpus.end();
3877 ++it)
3878 {
3879 const Cpu &cpu = *it;
3880
3881 if (pelmCpuTree == NULL)
3882 pelmCpuTree = pelmCPU->createChild("CpuTree");
3883
3884 xml::ElementNode *pelmCpu = pelmCpuTree->createChild("Cpu");
3885 pelmCpu->setAttribute("id", cpu.ulId);
3886 }
3887 }
3888
3889 xml::ElementNode *pelmCpuIdTree = NULL;
3890 for (CpuIdLeafsList::const_iterator it = hw.llCpuIdLeafs.begin();
3891 it != hw.llCpuIdLeafs.end();
3892 ++it)
3893 {
3894 const CpuIdLeaf &leaf = *it;
3895
3896 if (pelmCpuIdTree == NULL)
3897 pelmCpuIdTree = pelmCPU->createChild("CpuIdTree");
3898
3899 xml::ElementNode *pelmCpuIdLeaf = pelmCpuIdTree->createChild("CpuIdLeaf");
3900 pelmCpuIdLeaf->setAttribute("id", leaf.ulId);
3901 pelmCpuIdLeaf->setAttribute("eax", leaf.ulEax);
3902 pelmCpuIdLeaf->setAttribute("ebx", leaf.ulEbx);
3903 pelmCpuIdLeaf->setAttribute("ecx", leaf.ulEcx);
3904 pelmCpuIdLeaf->setAttribute("edx", leaf.ulEdx);
3905 }
3906
3907 xml::ElementNode *pelmMemory = pelmHardware->createChild("Memory");
3908 pelmMemory->setAttribute("RAMSize", hw.ulMemorySizeMB);
3909 if (m->sv >= SettingsVersion_v1_10)
3910 {
3911 pelmMemory->setAttribute("PageFusion", hw.fPageFusionEnabled);
3912 }
3913
3914 if ( (m->sv >= SettingsVersion_v1_9)
3915 && (hw.firmwareType >= FirmwareType_EFI)
3916 )
3917 {
3918 xml::ElementNode *pelmFirmware = pelmHardware->createChild("Firmware");
3919 const char *pcszFirmware;
3920
3921 switch (hw.firmwareType)
3922 {
3923 case FirmwareType_EFI: pcszFirmware = "EFI"; break;
3924 case FirmwareType_EFI32: pcszFirmware = "EFI32"; break;
3925 case FirmwareType_EFI64: pcszFirmware = "EFI64"; break;
3926 case FirmwareType_EFIDUAL: pcszFirmware = "EFIDUAL"; break;
3927 default: pcszFirmware = "None"; break;
3928 }
3929 pelmFirmware->setAttribute("type", pcszFirmware);
3930 }
3931
3932 if ( (m->sv >= SettingsVersion_v1_10)
3933 )
3934 {
3935 xml::ElementNode *pelmHID = pelmHardware->createChild("HID");
3936 const char *pcszHID;
3937
3938 switch (hw.pointingHIDType)
3939 {
3940 case PointingHIDType_USBMouse: pcszHID = "USBMouse"; break;
3941 case PointingHIDType_USBTablet: pcszHID = "USBTablet"; break;
3942 case PointingHIDType_PS2Mouse: pcszHID = "PS2Mouse"; break;
3943 case PointingHIDType_ComboMouse: pcszHID = "ComboMouse"; break;
3944 case PointingHIDType_USBMultiTouch: pcszHID = "USBMultiTouch";break;
3945 case PointingHIDType_None: pcszHID = "None"; break;
3946 default: Assert(false); pcszHID = "PS2Mouse"; break;
3947 }
3948 pelmHID->setAttribute("Pointing", pcszHID);
3949
3950 switch (hw.keyboardHIDType)
3951 {
3952 case KeyboardHIDType_USBKeyboard: pcszHID = "USBKeyboard"; break;
3953 case KeyboardHIDType_PS2Keyboard: pcszHID = "PS2Keyboard"; break;
3954 case KeyboardHIDType_ComboKeyboard: pcszHID = "ComboKeyboard"; break;
3955 case KeyboardHIDType_None: pcszHID = "None"; break;
3956 default: Assert(false); pcszHID = "PS2Keyboard"; break;
3957 }
3958 pelmHID->setAttribute("Keyboard", pcszHID);
3959 }
3960
3961 if ( (m->sv >= SettingsVersion_v1_10)
3962 )
3963 {
3964 xml::ElementNode *pelmHPET = pelmHardware->createChild("HPET");
3965 pelmHPET->setAttribute("enabled", hw.fHPETEnabled);
3966 }
3967
3968 if ( (m->sv >= SettingsVersion_v1_11)
3969 )
3970 {
3971 xml::ElementNode *pelmChipset = pelmHardware->createChild("Chipset");
3972 const char *pcszChipset;
3973
3974 switch (hw.chipsetType)
3975 {
3976 case ChipsetType_PIIX3: pcszChipset = "PIIX3"; break;
3977 case ChipsetType_ICH9: pcszChipset = "ICH9"; break;
3978 default: Assert(false); pcszChipset = "PIIX3"; break;
3979 }
3980 pelmChipset->setAttribute("type", pcszChipset);
3981 }
3982
3983 xml::ElementNode *pelmBoot = pelmHardware->createChild("Boot");
3984 for (BootOrderMap::const_iterator it = hw.mapBootOrder.begin();
3985 it != hw.mapBootOrder.end();
3986 ++it)
3987 {
3988 uint32_t i = it->first;
3989 DeviceType_T type = it->second;
3990 const char *pcszDevice;
3991
3992 switch (type)
3993 {
3994 case DeviceType_Floppy: pcszDevice = "Floppy"; break;
3995 case DeviceType_DVD: pcszDevice = "DVD"; break;
3996 case DeviceType_HardDisk: pcszDevice = "HardDisk"; break;
3997 case DeviceType_Network: pcszDevice = "Network"; break;
3998 default: /*case DeviceType_Null:*/ pcszDevice = "None"; break;
3999 }
4000
4001 xml::ElementNode *pelmOrder = pelmBoot->createChild("Order");
4002 pelmOrder->setAttribute("position",
4003 i + 1); // XML is 1-based but internal data is 0-based
4004 pelmOrder->setAttribute("device", pcszDevice);
4005 }
4006
4007 xml::ElementNode *pelmDisplay = pelmHardware->createChild("Display");
4008 if (hw.graphicsControllerType != GraphicsControllerType_VBoxVGA)
4009 {
4010 const char *pcszGraphics;
4011 switch (hw.graphicsControllerType)
4012 {
4013 case GraphicsControllerType_VBoxVGA: pcszGraphics = "VBoxVGA"; break;
4014 default: /*case GraphicsControllerType_Null:*/ pcszGraphics = "None"; break;
4015 }
4016 pelmDisplay->setAttribute("controller", pcszGraphics);
4017 }
4018 pelmDisplay->setAttribute("VRAMSize", hw.ulVRAMSizeMB);
4019 pelmDisplay->setAttribute("monitorCount", hw.cMonitors);
4020 pelmDisplay->setAttribute("accelerate3D", hw.fAccelerate3D);
4021
4022 if (m->sv >= SettingsVersion_v1_8)
4023 pelmDisplay->setAttribute("accelerate2DVideo", hw.fAccelerate2DVideo);
4024 xml::ElementNode *pelmVideoCapture = pelmHardware->createChild("VideoCapture");
4025
4026 if (m->sv >= SettingsVersion_v1_14)
4027 {
4028 pelmVideoCapture->setAttribute("enabled", hw.fVideoCaptureEnabled);
4029 pelmVideoCapture->setAttribute("screens", hw.u64VideoCaptureScreens);
4030 if (!hw.strVideoCaptureFile.isEmpty())
4031 pelmVideoCapture->setAttributePath("file", hw.strVideoCaptureFile);
4032 pelmVideoCapture->setAttribute("horzRes", hw.ulVideoCaptureHorzRes);
4033 pelmVideoCapture->setAttribute("vertRes", hw.ulVideoCaptureVertRes);
4034 pelmVideoCapture->setAttribute("rate", hw.ulVideoCaptureRate);
4035 pelmVideoCapture->setAttribute("fps", hw.ulVideoCaptureFPS);
4036 }
4037
4038 xml::ElementNode *pelmVRDE = pelmHardware->createChild("RemoteDisplay");
4039 pelmVRDE->setAttribute("enabled", hw.vrdeSettings.fEnabled);
4040 if (m->sv < SettingsVersion_v1_11)
4041 {
4042 /* In VBox 4.0 these attributes are replaced with "Properties". */
4043 Utf8Str strPort;
4044 StringsMap::const_iterator it = hw.vrdeSettings.mapProperties.find("TCP/Ports");
4045 if (it != hw.vrdeSettings.mapProperties.end())
4046 strPort = it->second;
4047 if (!strPort.length())
4048 strPort = "3389";
4049 pelmVRDE->setAttribute("port", strPort);
4050
4051 Utf8Str strAddress;
4052 it = hw.vrdeSettings.mapProperties.find("TCP/Address");
4053 if (it != hw.vrdeSettings.mapProperties.end())
4054 strAddress = it->second;
4055 if (strAddress.length())
4056 pelmVRDE->setAttribute("netAddress", strAddress);
4057 }
4058 const char *pcszAuthType;
4059 switch (hw.vrdeSettings.authType)
4060 {
4061 case AuthType_Guest: pcszAuthType = "Guest"; break;
4062 case AuthType_External: pcszAuthType = "External"; break;
4063 default: /*case AuthType_Null:*/ pcszAuthType = "Null"; break;
4064 }
4065 pelmVRDE->setAttribute("authType", pcszAuthType);
4066
4067 if (hw.vrdeSettings.ulAuthTimeout != 0)
4068 pelmVRDE->setAttribute("authTimeout", hw.vrdeSettings.ulAuthTimeout);
4069 if (hw.vrdeSettings.fAllowMultiConnection)
4070 pelmVRDE->setAttribute("allowMultiConnection", hw.vrdeSettings.fAllowMultiConnection);
4071 if (hw.vrdeSettings.fReuseSingleConnection)
4072 pelmVRDE->setAttribute("reuseSingleConnection", hw.vrdeSettings.fReuseSingleConnection);
4073
4074 if (m->sv == SettingsVersion_v1_10)
4075 {
4076 xml::ElementNode *pelmVideoChannel = pelmVRDE->createChild("VideoChannel");
4077
4078 /* In 4.0 videochannel settings were replaced with properties, so look at properties. */
4079 Utf8Str str;
4080 StringsMap::const_iterator it = hw.vrdeSettings.mapProperties.find("VideoChannel/Enabled");
4081 if (it != hw.vrdeSettings.mapProperties.end())
4082 str = it->second;
4083 bool fVideoChannel = RTStrICmp(str.c_str(), "true") == 0
4084 || RTStrCmp(str.c_str(), "1") == 0;
4085 pelmVideoChannel->setAttribute("enabled", fVideoChannel);
4086
4087 it = hw.vrdeSettings.mapProperties.find("VideoChannel/Quality");
4088 if (it != hw.vrdeSettings.mapProperties.end())
4089 str = it->second;
4090 uint32_t ulVideoChannelQuality = RTStrToUInt32(str.c_str()); /* This returns 0 on invalid string which is ok. */
4091 if (ulVideoChannelQuality == 0)
4092 ulVideoChannelQuality = 75;
4093 else
4094 ulVideoChannelQuality = RT_CLAMP(ulVideoChannelQuality, 10, 100);
4095 pelmVideoChannel->setAttribute("quality", ulVideoChannelQuality);
4096 }
4097 if (m->sv >= SettingsVersion_v1_11)
4098 {
4099 if (hw.vrdeSettings.strAuthLibrary.length())
4100 pelmVRDE->setAttribute("authLibrary", hw.vrdeSettings.strAuthLibrary);
4101 if (hw.vrdeSettings.strVrdeExtPack.isNotEmpty())
4102 pelmVRDE->setAttribute("VRDEExtPack", hw.vrdeSettings.strVrdeExtPack);
4103 if (hw.vrdeSettings.mapProperties.size() > 0)
4104 {
4105 xml::ElementNode *pelmProperties = pelmVRDE->createChild("VRDEProperties");
4106 for (StringsMap::const_iterator it = hw.vrdeSettings.mapProperties.begin();
4107 it != hw.vrdeSettings.mapProperties.end();
4108 ++it)
4109 {
4110 const Utf8Str &strName = it->first;
4111 const Utf8Str &strValue = it->second;
4112 xml::ElementNode *pelm = pelmProperties->createChild("Property");
4113 pelm->setAttribute("name", strName);
4114 pelm->setAttribute("value", strValue);
4115 }
4116 }
4117 }
4118
4119 xml::ElementNode *pelmBIOS = pelmHardware->createChild("BIOS");
4120 pelmBIOS->createChild("ACPI")->setAttribute("enabled", hw.biosSettings.fACPIEnabled);
4121 pelmBIOS->createChild("IOAPIC")->setAttribute("enabled", hw.biosSettings.fIOAPICEnabled);
4122
4123 xml::ElementNode *pelmLogo = pelmBIOS->createChild("Logo");
4124 pelmLogo->setAttribute("fadeIn", hw.biosSettings.fLogoFadeIn);
4125 pelmLogo->setAttribute("fadeOut", hw.biosSettings.fLogoFadeOut);
4126 pelmLogo->setAttribute("displayTime", hw.biosSettings.ulLogoDisplayTime);
4127 if (hw.biosSettings.strLogoImagePath.length())
4128 pelmLogo->setAttribute("imagePath", hw.biosSettings.strLogoImagePath);
4129
4130 const char *pcszBootMenu;
4131 switch (hw.biosSettings.biosBootMenuMode)
4132 {
4133 case BIOSBootMenuMode_Disabled: pcszBootMenu = "Disabled"; break;
4134 case BIOSBootMenuMode_MenuOnly: pcszBootMenu = "MenuOnly"; break;
4135 default: /*BIOSBootMenuMode_MessageAndMenu*/ pcszBootMenu = "MessageAndMenu"; break;
4136 }
4137 pelmBIOS->createChild("BootMenu")->setAttribute("mode", pcszBootMenu);
4138 pelmBIOS->createChild("TimeOffset")->setAttribute("value", hw.biosSettings.llTimeOffset);
4139 pelmBIOS->createChild("PXEDebug")->setAttribute("enabled", hw.biosSettings.fPXEDebugEnabled);
4140
4141 if (m->sv < SettingsVersion_v1_9)
4142 {
4143 // settings formats before 1.9 had separate DVDDrive and FloppyDrive items under Hardware;
4144 // run thru the storage controllers to see if we have a DVD or floppy drives
4145 size_t cDVDs = 0;
4146 size_t cFloppies = 0;
4147
4148 xml::ElementNode *pelmDVD = pelmHardware->createChild("DVDDrive");
4149 xml::ElementNode *pelmFloppy = pelmHardware->createChild("FloppyDrive");
4150
4151 for (StorageControllersList::const_iterator it = strg.llStorageControllers.begin();
4152 it != strg.llStorageControllers.end();
4153 ++it)
4154 {
4155 const StorageController &sctl = *it;
4156 // in old settings format, the DVD drive could only have been under the IDE controller
4157 if (sctl.storageBus == StorageBus_IDE)
4158 {
4159 for (AttachedDevicesList::const_iterator it2 = sctl.llAttachedDevices.begin();
4160 it2 != sctl.llAttachedDevices.end();
4161 ++it2)
4162 {
4163 const AttachedDevice &att = *it2;
4164 if (att.deviceType == DeviceType_DVD)
4165 {
4166 if (cDVDs > 0)
4167 throw ConfigFileError(this, NULL, N_("Internal error: cannot save more than one DVD drive with old settings format"));
4168
4169 ++cDVDs;
4170
4171 pelmDVD->setAttribute("passthrough", att.fPassThrough);
4172 if (att.fTempEject)
4173 pelmDVD->setAttribute("tempeject", att.fTempEject);
4174
4175 if (!att.uuid.isZero() && att.uuid.isValid())
4176 pelmDVD->createChild("Image")->setAttribute("uuid", att.uuid.toStringCurly());
4177 else if (att.strHostDriveSrc.length())
4178 pelmDVD->createChild("HostDrive")->setAttribute("src", att.strHostDriveSrc);
4179 }
4180 }
4181 }
4182 else if (sctl.storageBus == StorageBus_Floppy)
4183 {
4184 size_t cFloppiesHere = sctl.llAttachedDevices.size();
4185 if (cFloppiesHere > 1)
4186 throw ConfigFileError(this, NULL, N_("Internal error: floppy controller cannot have more than one device attachment"));
4187 if (cFloppiesHere)
4188 {
4189 const AttachedDevice &att = sctl.llAttachedDevices.front();
4190 pelmFloppy->setAttribute("enabled", true);
4191
4192 if (!att.uuid.isZero() && att.uuid.isValid())
4193 pelmFloppy->createChild("Image")->setAttribute("uuid", att.uuid.toStringCurly());
4194 else if (att.strHostDriveSrc.length())
4195 pelmFloppy->createChild("HostDrive")->setAttribute("src", att.strHostDriveSrc);
4196 }
4197
4198 cFloppies += cFloppiesHere;
4199 }
4200 }
4201
4202 if (cFloppies == 0)
4203 pelmFloppy->setAttribute("enabled", false);
4204 else if (cFloppies > 1)
4205 throw ConfigFileError(this, NULL, N_("Internal error: cannot save more than one floppy drive with old settings format"));
4206 }
4207
4208 xml::ElementNode *pelmUSB = pelmHardware->createChild("USBController");
4209 pelmUSB->setAttribute("enabled", hw.usbController.fEnabled);
4210 pelmUSB->setAttribute("enabledEhci", hw.usbController.fEnabledEHCI);
4211
4212 buildUSBDeviceFilters(*pelmUSB,
4213 hw.usbController.llDeviceFilters,
4214 false); // fHostMode
4215
4216 xml::ElementNode *pelmNetwork = pelmHardware->createChild("Network");
4217 for (NetworkAdaptersList::const_iterator it = hw.llNetworkAdapters.begin();
4218 it != hw.llNetworkAdapters.end();
4219 ++it)
4220 {
4221 const NetworkAdapter &nic = *it;
4222
4223 xml::ElementNode *pelmAdapter = pelmNetwork->createChild("Adapter");
4224 pelmAdapter->setAttribute("slot", nic.ulSlot);
4225 pelmAdapter->setAttribute("enabled", nic.fEnabled);
4226 pelmAdapter->setAttribute("MACAddress", nic.strMACAddress);
4227 pelmAdapter->setAttribute("cable", nic.fCableConnected);
4228 pelmAdapter->setAttribute("speed", nic.ulLineSpeed);
4229 if (nic.ulBootPriority != 0)
4230 {
4231 pelmAdapter->setAttribute("bootPriority", nic.ulBootPriority);
4232 }
4233 if (nic.fTraceEnabled)
4234 {
4235 pelmAdapter->setAttribute("trace", nic.fTraceEnabled);
4236 pelmAdapter->setAttribute("tracefile", nic.strTraceFile);
4237 }
4238 if (nic.strBandwidthGroup.isNotEmpty())
4239 pelmAdapter->setAttribute("bandwidthGroup", nic.strBandwidthGroup);
4240
4241 const char *pszPolicy;
4242 switch (nic.enmPromiscModePolicy)
4243 {
4244 case NetworkAdapterPromiscModePolicy_Deny: pszPolicy = NULL; break;
4245 case NetworkAdapterPromiscModePolicy_AllowNetwork: pszPolicy = "AllowNetwork"; break;
4246 case NetworkAdapterPromiscModePolicy_AllowAll: pszPolicy = "AllowAll"; break;
4247 default: pszPolicy = NULL; AssertFailed(); break;
4248 }
4249 if (pszPolicy)
4250 pelmAdapter->setAttribute("promiscuousModePolicy", pszPolicy);
4251
4252 const char *pcszType;
4253 switch (nic.type)
4254 {
4255 case NetworkAdapterType_Am79C973: pcszType = "Am79C973"; break;
4256 case NetworkAdapterType_I82540EM: pcszType = "82540EM"; break;
4257 case NetworkAdapterType_I82543GC: pcszType = "82543GC"; break;
4258 case NetworkAdapterType_I82545EM: pcszType = "82545EM"; break;
4259 case NetworkAdapterType_Virtio: pcszType = "virtio"; break;
4260 default: /*case NetworkAdapterType_Am79C970A:*/ pcszType = "Am79C970A"; break;
4261 }
4262 pelmAdapter->setAttribute("type", pcszType);
4263
4264 xml::ElementNode *pelmNAT;
4265 if (m->sv < SettingsVersion_v1_10)
4266 {
4267 switch (nic.mode)
4268 {
4269 case NetworkAttachmentType_NAT:
4270 pelmNAT = pelmAdapter->createChild("NAT");
4271 if (nic.nat.strNetwork.length())
4272 pelmNAT->setAttribute("network", nic.nat.strNetwork);
4273 break;
4274
4275 case NetworkAttachmentType_Bridged:
4276 pelmAdapter->createChild("BridgedInterface")->setAttribute("name", nic.strBridgedName);
4277 break;
4278
4279 case NetworkAttachmentType_Internal:
4280 pelmAdapter->createChild("InternalNetwork")->setAttribute("name", nic.strInternalNetworkName);
4281 break;
4282
4283 case NetworkAttachmentType_HostOnly:
4284 pelmAdapter->createChild("HostOnlyInterface")->setAttribute("name", nic.strHostOnlyName);
4285 break;
4286
4287 default: /*case NetworkAttachmentType_Null:*/
4288 break;
4289 }
4290 }
4291 else
4292 {
4293 /* m->sv >= SettingsVersion_v1_10 */
4294 xml::ElementNode *pelmDisabledNode = NULL;
4295 pelmDisabledNode = pelmAdapter->createChild("DisabledModes");
4296 if (nic.mode != NetworkAttachmentType_NAT)
4297 buildNetworkXML(NetworkAttachmentType_NAT, *pelmDisabledNode, false, nic);
4298 if (nic.mode != NetworkAttachmentType_Bridged)
4299 buildNetworkXML(NetworkAttachmentType_Bridged, *pelmDisabledNode, false, nic);
4300 if (nic.mode != NetworkAttachmentType_Internal)
4301 buildNetworkXML(NetworkAttachmentType_Internal, *pelmDisabledNode, false, nic);
4302 if (nic.mode != NetworkAttachmentType_HostOnly)
4303 buildNetworkXML(NetworkAttachmentType_HostOnly, *pelmDisabledNode, false, nic);
4304 if (nic.mode != NetworkAttachmentType_Generic)
4305 buildNetworkXML(NetworkAttachmentType_Generic, *pelmDisabledNode, false, nic);
4306 buildNetworkXML(nic.mode, *pelmAdapter, true, nic);
4307 }
4308 }
4309
4310 xml::ElementNode *pelmPorts = pelmHardware->createChild("UART");
4311 for (SerialPortsList::const_iterator it = hw.llSerialPorts.begin();
4312 it != hw.llSerialPorts.end();
4313 ++it)
4314 {
4315 const SerialPort &port = *it;
4316 xml::ElementNode *pelmPort = pelmPorts->createChild("Port");
4317 pelmPort->setAttribute("slot", port.ulSlot);
4318 pelmPort->setAttribute("enabled", port.fEnabled);
4319 pelmPort->setAttributeHex("IOBase", port.ulIOBase);
4320 pelmPort->setAttribute("IRQ", port.ulIRQ);
4321
4322 const char *pcszHostMode;
4323 switch (port.portMode)
4324 {
4325 case PortMode_HostPipe: pcszHostMode = "HostPipe"; break;
4326 case PortMode_HostDevice: pcszHostMode = "HostDevice"; break;
4327 case PortMode_RawFile: pcszHostMode = "RawFile"; break;
4328 default: /*case PortMode_Disconnected:*/ pcszHostMode = "Disconnected"; break;
4329 }
4330 switch (port.portMode)
4331 {
4332 case PortMode_HostPipe:
4333 pelmPort->setAttribute("server", port.fServer);
4334 /* no break */
4335 case PortMode_HostDevice:
4336 case PortMode_RawFile:
4337 pelmPort->setAttribute("path", port.strPath);
4338 break;
4339
4340 default:
4341 break;
4342 }
4343 pelmPort->setAttribute("hostMode", pcszHostMode);
4344 }
4345
4346 pelmPorts = pelmHardware->createChild("LPT");
4347 for (ParallelPortsList::const_iterator it = hw.llParallelPorts.begin();
4348 it != hw.llParallelPorts.end();
4349 ++it)
4350 {
4351 const ParallelPort &port = *it;
4352 xml::ElementNode *pelmPort = pelmPorts->createChild("Port");
4353 pelmPort->setAttribute("slot", port.ulSlot);
4354 pelmPort->setAttribute("enabled", port.fEnabled);
4355 pelmPort->setAttributeHex("IOBase", port.ulIOBase);
4356 pelmPort->setAttribute("IRQ", port.ulIRQ);
4357 if (port.strPath.length())
4358 pelmPort->setAttribute("path", port.strPath);
4359 }
4360
4361 xml::ElementNode *pelmAudio = pelmHardware->createChild("AudioAdapter");
4362 const char *pcszController;
4363 switch (hw.audioAdapter.controllerType)
4364 {
4365 case AudioControllerType_SB16:
4366 pcszController = "SB16";
4367 break;
4368 case AudioControllerType_HDA:
4369 if (m->sv >= SettingsVersion_v1_11)
4370 {
4371 pcszController = "HDA";
4372 break;
4373 }
4374 /* fall through */
4375 case AudioControllerType_AC97:
4376 default:
4377 pcszController = "AC97";
4378 break;
4379 }
4380 pelmAudio->setAttribute("controller", pcszController);
4381
4382 if (m->sv >= SettingsVersion_v1_10)
4383 {
4384 xml::ElementNode *pelmRTC = pelmHardware->createChild("RTC");
4385 pelmRTC->setAttribute("localOrUTC", machineUserData.fRTCUseUTC ? "UTC" : "local");
4386 }
4387
4388 const char *pcszDriver;
4389 switch (hw.audioAdapter.driverType)
4390 {
4391 case AudioDriverType_WinMM: pcszDriver = "WinMM"; break;
4392 case AudioDriverType_DirectSound: pcszDriver = "DirectSound"; break;
4393 case AudioDriverType_SolAudio: pcszDriver = "SolAudio"; break;
4394 case AudioDriverType_ALSA: pcszDriver = "ALSA"; break;
4395 case AudioDriverType_Pulse: pcszDriver = "Pulse"; break;
4396 case AudioDriverType_OSS: pcszDriver = "OSS"; break;
4397 case AudioDriverType_CoreAudio: pcszDriver = "CoreAudio"; break;
4398 case AudioDriverType_MMPM: pcszDriver = "MMPM"; break;
4399 default: /*case AudioDriverType_Null:*/ pcszDriver = "Null"; break;
4400 }
4401 pelmAudio->setAttribute("driver", pcszDriver);
4402
4403 pelmAudio->setAttribute("enabled", hw.audioAdapter.fEnabled);
4404
4405 xml::ElementNode *pelmSharedFolders = pelmHardware->createChild("SharedFolders");
4406 for (SharedFoldersList::const_iterator it = hw.llSharedFolders.begin();
4407 it != hw.llSharedFolders.end();
4408 ++it)
4409 {
4410 const SharedFolder &sf = *it;
4411 xml::ElementNode *pelmThis = pelmSharedFolders->createChild("SharedFolder");
4412 pelmThis->setAttribute("name", sf.strName);
4413 pelmThis->setAttribute("hostPath", sf.strHostPath);
4414 pelmThis->setAttribute("writable", sf.fWritable);
4415 pelmThis->setAttribute("autoMount", sf.fAutoMount);
4416 }
4417
4418 xml::ElementNode *pelmClip = pelmHardware->createChild("Clipboard");
4419 const char *pcszClip;
4420 switch (hw.clipboardMode)
4421 {
4422 default: /*case ClipboardMode_Disabled:*/ pcszClip = "Disabled"; break;
4423 case ClipboardMode_HostToGuest: pcszClip = "HostToGuest"; break;
4424 case ClipboardMode_GuestToHost: pcszClip = "GuestToHost"; break;
4425 case ClipboardMode_Bidirectional: pcszClip = "Bidirectional"; break;
4426 }
4427 pelmClip->setAttribute("mode", pcszClip);
4428
4429 xml::ElementNode *pelmDragAndDrop = pelmHardware->createChild("DragAndDrop");
4430 const char *pcszDragAndDrop;
4431 switch (hw.dragAndDropMode)
4432 {
4433 default: /*case DragAndDropMode_Disabled:*/ pcszDragAndDrop = "Disabled"; break;
4434 case DragAndDropMode_HostToGuest: pcszDragAndDrop = "HostToGuest"; break;
4435 case DragAndDropMode_GuestToHost: pcszDragAndDrop = "GuestToHost"; break;
4436 case DragAndDropMode_Bidirectional: pcszDragAndDrop = "Bidirectional"; break;
4437 }
4438 pelmDragAndDrop->setAttribute("mode", pcszDragAndDrop);
4439
4440 if (m->sv >= SettingsVersion_v1_10)
4441 {
4442 xml::ElementNode *pelmIO = pelmHardware->createChild("IO");
4443 xml::ElementNode *pelmIOCache;
4444
4445 pelmIOCache = pelmIO->createChild("IoCache");
4446 pelmIOCache->setAttribute("enabled", hw.ioSettings.fIOCacheEnabled);
4447 pelmIOCache->setAttribute("size", hw.ioSettings.ulIOCacheSize);
4448
4449 if (m->sv >= SettingsVersion_v1_11)
4450 {
4451 xml::ElementNode *pelmBandwidthGroups = pelmIO->createChild("BandwidthGroups");
4452 for (BandwidthGroupList::const_iterator it = hw.ioSettings.llBandwidthGroups.begin();
4453 it != hw.ioSettings.llBandwidthGroups.end();
4454 ++it)
4455 {
4456 const BandwidthGroup &gr = *it;
4457 const char *pcszType;
4458 xml::ElementNode *pelmThis = pelmBandwidthGroups->createChild("BandwidthGroup");
4459 pelmThis->setAttribute("name", gr.strName);
4460 switch (gr.enmType)
4461 {
4462 case BandwidthGroupType_Network: pcszType = "Network"; break;
4463 default: /* BandwidthGrouptype_Disk */ pcszType = "Disk"; break;
4464 }
4465 pelmThis->setAttribute("type", pcszType);
4466 if (m->sv >= SettingsVersion_v1_13)
4467 pelmThis->setAttribute("maxBytesPerSec", gr.cMaxBytesPerSec);
4468 else
4469 pelmThis->setAttribute("maxMbPerSec", gr.cMaxBytesPerSec / _1M);
4470 }
4471 }
4472 }
4473
4474 if (m->sv >= SettingsVersion_v1_12)
4475 {
4476 xml::ElementNode *pelmPCI = pelmHardware->createChild("HostPci");
4477 xml::ElementNode *pelmPCIDevices = pelmPCI->createChild("Devices");
4478
4479 for (HostPCIDeviceAttachmentList::const_iterator it = hw.pciAttachments.begin();
4480 it != hw.pciAttachments.end();
4481 ++it)
4482 {
4483 const HostPCIDeviceAttachment &hpda = *it;
4484
4485 xml::ElementNode *pelmThis = pelmPCIDevices->createChild("Device");
4486
4487 pelmThis->setAttribute("host", hpda.uHostAddress);
4488 pelmThis->setAttribute("guest", hpda.uGuestAddress);
4489 pelmThis->setAttribute("name", hpda.strDeviceName);
4490 }
4491 }
4492
4493 if (m->sv >= SettingsVersion_v1_12)
4494 {
4495 xml::ElementNode *pelmEmulatedUSB = pelmHardware->createChild("EmulatedUSB");
4496
4497 xml::ElementNode *pelmCardReader = pelmEmulatedUSB->createChild("CardReader");
4498 pelmCardReader->setAttribute("enabled", hw.fEmulatedUSBCardReader);
4499
4500 if (m->sv >= SettingsVersion_v1_13)
4501 {
4502 xml::ElementNode *pelmWebcam = pelmEmulatedUSB->createChild("Webcam");
4503 pelmWebcam->setAttribute("enabled", hw.fEmulatedUSBWebcam);
4504 }
4505 }
4506
4507 if ( m->sv >= SettingsVersion_v1_14
4508 && !hw.strDefaultFrontend.isEmpty())
4509 {
4510 xml::ElementNode *pelmFrontend = pelmHardware->createChild("Frontend");
4511 xml::ElementNode *pelmDefault = pelmFrontend->createChild("Default");
4512 pelmDefault->setAttribute("type", hw.strDefaultFrontend);
4513 }
4514
4515 xml::ElementNode *pelmGuest = pelmHardware->createChild("Guest");
4516 pelmGuest->setAttribute("memoryBalloonSize", hw.ulMemoryBalloonSize);
4517
4518 xml::ElementNode *pelmGuestProps = pelmHardware->createChild("GuestProperties");
4519 for (GuestPropertiesList::const_iterator it = hw.llGuestProperties.begin();
4520 it != hw.llGuestProperties.end();
4521 ++it)
4522 {
4523 const GuestProperty &prop = *it;
4524 xml::ElementNode *pelmProp = pelmGuestProps->createChild("GuestProperty");
4525 pelmProp->setAttribute("name", prop.strName);
4526 pelmProp->setAttribute("value", prop.strValue);
4527 pelmProp->setAttribute("timestamp", prop.timestamp);
4528 pelmProp->setAttribute("flags", prop.strFlags);
4529 }
4530
4531 if (hw.strNotificationPatterns.length())
4532 pelmGuestProps->setAttribute("notificationPatterns", hw.strNotificationPatterns);
4533}
4534
4535/**
4536 * Fill a <Network> node. Only relevant for XML version >= v1_10.
4537 * @param mode
4538 * @param elmParent
4539 * @param fEnabled
4540 * @param nic
4541 */
4542void MachineConfigFile::buildNetworkXML(NetworkAttachmentType_T mode,
4543 xml::ElementNode &elmParent,
4544 bool fEnabled,
4545 const NetworkAdapter &nic)
4546{
4547 switch (mode)
4548 {
4549 case NetworkAttachmentType_NAT:
4550 xml::ElementNode *pelmNAT;
4551 pelmNAT = elmParent.createChild("NAT");
4552
4553 if (nic.nat.strNetwork.length())
4554 pelmNAT->setAttribute("network", nic.nat.strNetwork);
4555 if (nic.nat.strBindIP.length())
4556 pelmNAT->setAttribute("hostip", nic.nat.strBindIP);
4557 if (nic.nat.u32Mtu)
4558 pelmNAT->setAttribute("mtu", nic.nat.u32Mtu);
4559 if (nic.nat.u32SockRcv)
4560 pelmNAT->setAttribute("sockrcv", nic.nat.u32SockRcv);
4561 if (nic.nat.u32SockSnd)
4562 pelmNAT->setAttribute("socksnd", nic.nat.u32SockSnd);
4563 if (nic.nat.u32TcpRcv)
4564 pelmNAT->setAttribute("tcprcv", nic.nat.u32TcpRcv);
4565 if (nic.nat.u32TcpSnd)
4566 pelmNAT->setAttribute("tcpsnd", nic.nat.u32TcpSnd);
4567 xml::ElementNode *pelmDNS;
4568 pelmDNS = pelmNAT->createChild("DNS");
4569 pelmDNS->setAttribute("pass-domain", nic.nat.fDNSPassDomain);
4570 pelmDNS->setAttribute("use-proxy", nic.nat.fDNSProxy);
4571 pelmDNS->setAttribute("use-host-resolver", nic.nat.fDNSUseHostResolver);
4572
4573 xml::ElementNode *pelmAlias;
4574 pelmAlias = pelmNAT->createChild("Alias");
4575 pelmAlias->setAttribute("logging", nic.nat.fAliasLog);
4576 pelmAlias->setAttribute("proxy-only", nic.nat.fAliasProxyOnly);
4577 pelmAlias->setAttribute("use-same-ports", nic.nat.fAliasUseSamePorts);
4578
4579 if ( nic.nat.strTFTPPrefix.length()
4580 || nic.nat.strTFTPBootFile.length()
4581 || nic.nat.strTFTPNextServer.length())
4582 {
4583 xml::ElementNode *pelmTFTP;
4584 pelmTFTP = pelmNAT->createChild("TFTP");
4585 if (nic.nat.strTFTPPrefix.length())
4586 pelmTFTP->setAttribute("prefix", nic.nat.strTFTPPrefix);
4587 if (nic.nat.strTFTPBootFile.length())
4588 pelmTFTP->setAttribute("boot-file", nic.nat.strTFTPBootFile);
4589 if (nic.nat.strTFTPNextServer.length())
4590 pelmTFTP->setAttribute("next-server", nic.nat.strTFTPNextServer);
4591 }
4592 buildNATForwardRuleList(*pelmNAT, nic.nat.llRules);
4593 break;
4594
4595 case NetworkAttachmentType_Bridged:
4596 if (fEnabled || !nic.strBridgedName.isEmpty())
4597 elmParent.createChild("BridgedInterface")->setAttribute("name", nic.strBridgedName);
4598 break;
4599
4600 case NetworkAttachmentType_Internal:
4601 if (fEnabled || !nic.strInternalNetworkName.isEmpty())
4602 elmParent.createChild("InternalNetwork")->setAttribute("name", nic.strInternalNetworkName);
4603 break;
4604
4605 case NetworkAttachmentType_HostOnly:
4606 if (fEnabled || !nic.strHostOnlyName.isEmpty())
4607 elmParent.createChild("HostOnlyInterface")->setAttribute("name", nic.strHostOnlyName);
4608 break;
4609
4610 case NetworkAttachmentType_Generic:
4611 if (fEnabled || !nic.strGenericDriver.isEmpty() || nic.genericProperties.size())
4612 {
4613 xml::ElementNode *pelmMode = elmParent.createChild("GenericInterface");
4614 pelmMode->setAttribute("driver", nic.strGenericDriver);
4615 for (StringsMap::const_iterator it = nic.genericProperties.begin();
4616 it != nic.genericProperties.end();
4617 ++it)
4618 {
4619 xml::ElementNode *pelmProp = pelmMode->createChild("Property");
4620 pelmProp->setAttribute("name", it->first);
4621 pelmProp->setAttribute("value", it->second);
4622 }
4623 }
4624 break;
4625
4626 default: /*case NetworkAttachmentType_Null:*/
4627 break;
4628 }
4629}
4630
4631/**
4632 * Creates a <StorageControllers> node under elmParent and then writes out the XML
4633 * keys under that. Called for both the <Machine> node and for snapshots.
4634 * @param elmParent
4635 * @param st
4636 * @param fSkipRemovableMedia If true, DVD and floppy attachments are skipped and
4637 * an empty drive is always written instead. This is for the OVF export case.
4638 * This parameter is ignored unless the settings version is at least v1.9, which
4639 * is always the case when this gets called for OVF export.
4640 * @param pllElementsWithUuidAttributes If not NULL, must point to a list of element node
4641 * pointers to which we will append all elements that we created here that contain
4642 * UUID attributes. This allows the OVF export code to quickly replace the internal
4643 * media UUIDs with the UUIDs of the media that were exported.
4644 */
4645void MachineConfigFile::buildStorageControllersXML(xml::ElementNode &elmParent,
4646 const Storage &st,
4647 bool fSkipRemovableMedia,
4648 std::list<xml::ElementNode*> *pllElementsWithUuidAttributes)
4649{
4650 xml::ElementNode *pelmStorageControllers = elmParent.createChild("StorageControllers");
4651
4652 for (StorageControllersList::const_iterator it = st.llStorageControllers.begin();
4653 it != st.llStorageControllers.end();
4654 ++it)
4655 {
4656 const StorageController &sc = *it;
4657
4658 if ( (m->sv < SettingsVersion_v1_9)
4659 && (sc.controllerType == StorageControllerType_I82078)
4660 )
4661 // floppy controller already got written into <Hardware>/<FloppyController> in buildHardwareXML()
4662 // for pre-1.9 settings
4663 continue;
4664
4665 xml::ElementNode *pelmController = pelmStorageControllers->createChild("StorageController");
4666 com::Utf8Str name = sc.strName;
4667 if (m->sv < SettingsVersion_v1_8)
4668 {
4669 // pre-1.8 settings use shorter controller names, they are
4670 // expanded when reading the settings
4671 if (name == "IDE Controller")
4672 name = "IDE";
4673 else if (name == "SATA Controller")
4674 name = "SATA";
4675 else if (name == "SCSI Controller")
4676 name = "SCSI";
4677 }
4678 pelmController->setAttribute("name", sc.strName);
4679
4680 const char *pcszType;
4681 switch (sc.controllerType)
4682 {
4683 case StorageControllerType_IntelAhci: pcszType = "AHCI"; break;
4684 case StorageControllerType_LsiLogic: pcszType = "LsiLogic"; break;
4685 case StorageControllerType_BusLogic: pcszType = "BusLogic"; break;
4686 case StorageControllerType_PIIX4: pcszType = "PIIX4"; break;
4687 case StorageControllerType_ICH6: pcszType = "ICH6"; break;
4688 case StorageControllerType_I82078: pcszType = "I82078"; break;
4689 case StorageControllerType_LsiLogicSas: pcszType = "LsiLogicSas"; break;
4690 default: /*case StorageControllerType_PIIX3:*/ pcszType = "PIIX3"; break;
4691 }
4692 pelmController->setAttribute("type", pcszType);
4693
4694 pelmController->setAttribute("PortCount", sc.ulPortCount);
4695
4696 if (m->sv >= SettingsVersion_v1_9)
4697 if (sc.ulInstance)
4698 pelmController->setAttribute("Instance", sc.ulInstance);
4699
4700 if (m->sv >= SettingsVersion_v1_10)
4701 pelmController->setAttribute("useHostIOCache", sc.fUseHostIOCache);
4702
4703 if (m->sv >= SettingsVersion_v1_11)
4704 pelmController->setAttribute("Bootable", sc.fBootable);
4705
4706 if (sc.controllerType == StorageControllerType_IntelAhci)
4707 {
4708 pelmController->setAttribute("IDE0MasterEmulationPort", sc.lIDE0MasterEmulationPort);
4709 pelmController->setAttribute("IDE0SlaveEmulationPort", sc.lIDE0SlaveEmulationPort);
4710 pelmController->setAttribute("IDE1MasterEmulationPort", sc.lIDE1MasterEmulationPort);
4711 pelmController->setAttribute("IDE1SlaveEmulationPort", sc.lIDE1SlaveEmulationPort);
4712 }
4713
4714 for (AttachedDevicesList::const_iterator it2 = sc.llAttachedDevices.begin();
4715 it2 != sc.llAttachedDevices.end();
4716 ++it2)
4717 {
4718 const AttachedDevice &att = *it2;
4719
4720 // For settings version before 1.9, DVDs and floppies are in hardware, not storage controllers,
4721 // so we shouldn't write them here; we only get here for DVDs though because we ruled out
4722 // the floppy controller at the top of the loop
4723 if ( att.deviceType == DeviceType_DVD
4724 && m->sv < SettingsVersion_v1_9
4725 )
4726 continue;
4727
4728 xml::ElementNode *pelmDevice = pelmController->createChild("AttachedDevice");
4729
4730 pcszType = NULL;
4731
4732 switch (att.deviceType)
4733 {
4734 case DeviceType_HardDisk:
4735 pcszType = "HardDisk";
4736 if (att.fNonRotational)
4737 pelmDevice->setAttribute("nonrotational", att.fNonRotational);
4738 if (att.fDiscard)
4739 pelmDevice->setAttribute("discard", att.fDiscard);
4740 break;
4741
4742 case DeviceType_DVD:
4743 pcszType = "DVD";
4744 pelmDevice->setAttribute("passthrough", att.fPassThrough);
4745 if (att.fTempEject)
4746 pelmDevice->setAttribute("tempeject", att.fTempEject);
4747 break;
4748
4749 case DeviceType_Floppy:
4750 pcszType = "Floppy";
4751 break;
4752 }
4753
4754 pelmDevice->setAttribute("type", pcszType);
4755
4756 pelmDevice->setAttribute("port", att.lPort);
4757 pelmDevice->setAttribute("device", att.lDevice);
4758
4759 if (att.strBwGroup.length())
4760 pelmDevice->setAttribute("bandwidthGroup", att.strBwGroup);
4761
4762 // attached image, if any
4763 if (!att.uuid.isZero()
4764 && att.uuid.isValid()
4765 && (att.deviceType == DeviceType_HardDisk
4766 || !fSkipRemovableMedia
4767 )
4768 )
4769 {
4770 xml::ElementNode *pelmImage = pelmDevice->createChild("Image");
4771 pelmImage->setAttribute("uuid", att.uuid.toStringCurly());
4772
4773 // if caller wants a list of UUID elements, give it to them
4774 if (pllElementsWithUuidAttributes)
4775 pllElementsWithUuidAttributes->push_back(pelmImage);
4776 }
4777 else if ( (m->sv >= SettingsVersion_v1_9)
4778 && (att.strHostDriveSrc.length())
4779 )
4780 pelmDevice->createChild("HostDrive")->setAttribute("src", att.strHostDriveSrc);
4781 }
4782 }
4783}
4784
4785/**
4786 * Creates a <Debugging> node under elmParent and then writes out the XML
4787 * keys under that. Called for both the <Machine> node and for snapshots.
4788 *
4789 * @param pElmParent Pointer to the parent element.
4790 * @param pDbg Pointer to the debugging settings.
4791 */
4792void MachineConfigFile::buildDebuggingXML(xml::ElementNode *pElmParent, const Debugging *pDbg)
4793{
4794 if (m->sv < SettingsVersion_v1_13 || pDbg->areDefaultSettings())
4795 return;
4796
4797 xml::ElementNode *pElmDebugging = pElmParent->createChild("Debugging");
4798 xml::ElementNode *pElmTracing = pElmDebugging->createChild("Tracing");
4799 pElmTracing->setAttribute("enabled", pDbg->fTracingEnabled);
4800 pElmTracing->setAttribute("allowTracingToAccessVM", pDbg->fAllowTracingToAccessVM);
4801 pElmTracing->setAttribute("config", pDbg->strTracingConfig);
4802}
4803
4804/**
4805 * Creates a <Autostart> node under elmParent and then writes out the XML
4806 * keys under that. Called for both the <Machine> node and for snapshots.
4807 *
4808 * @param pElmParent Pointer to the parent element.
4809 * @param pAutostart Pointer to the autostart settings.
4810 */
4811void MachineConfigFile::buildAutostartXML(xml::ElementNode *pElmParent, const Autostart *pAutostart)
4812{
4813 const char *pcszAutostop = NULL;
4814
4815 if (m->sv < SettingsVersion_v1_13 || pAutostart->areDefaultSettings())
4816 return;
4817
4818 xml::ElementNode *pElmAutostart = pElmParent->createChild("Autostart");
4819 pElmAutostart->setAttribute("enabled", pAutostart->fAutostartEnabled);
4820 pElmAutostart->setAttribute("delay", pAutostart->uAutostartDelay);
4821
4822 switch (pAutostart->enmAutostopType)
4823 {
4824 case AutostopType_Disabled: pcszAutostop = "Disabled"; break;
4825 case AutostopType_SaveState: pcszAutostop = "SaveState"; break;
4826 case AutostopType_PowerOff: pcszAutostop = "PowerOff"; break;
4827 case AutostopType_AcpiShutdown: pcszAutostop = "AcpiShutdown"; break;
4828 default: Assert(false); pcszAutostop = "Disabled"; break;
4829 }
4830 pElmAutostart->setAttribute("autostop", pcszAutostop);
4831}
4832
4833/**
4834 * Creates a <Groups> node under elmParent and then writes out the XML
4835 * keys under that. Called for the <Machine> node only.
4836 *
4837 * @param pElmParent Pointer to the parent element.
4838 * @param pllGroups Pointer to the groups list.
4839 */
4840void MachineConfigFile::buildGroupsXML(xml::ElementNode *pElmParent, const StringsList *pllGroups)
4841{
4842 if ( m->sv < SettingsVersion_v1_13 || pllGroups->size() == 0
4843 || (pllGroups->size() == 1 && pllGroups->front() == "/"))
4844 return;
4845
4846 xml::ElementNode *pElmGroups = pElmParent->createChild("Groups");
4847 for (StringsList::const_iterator it = pllGroups->begin();
4848 it != pllGroups->end();
4849 ++it)
4850 {
4851 const Utf8Str &group = *it;
4852 xml::ElementNode *pElmGroup = pElmGroups->createChild("Group");
4853 pElmGroup->setAttribute("name", group);
4854 }
4855}
4856
4857/**
4858 * Writes a single snapshot into the DOM tree. Initially this gets called from MachineConfigFile::write()
4859 * for the root snapshot of a machine, if present; elmParent then points to the <Snapshots> node under the
4860 * <Machine> node to which <Snapshot> must be added. This may then recurse for child snapshots.
4861 *
4862 * @param depth
4863 * @param elmParent
4864 * @param snap
4865 */
4866void MachineConfigFile::buildSnapshotXML(uint32_t depth,
4867 xml::ElementNode &elmParent,
4868 const Snapshot &snap)
4869{
4870 if (depth > SETTINGS_SNAPSHOT_DEPTH_MAX)
4871 throw ConfigFileError(this, NULL, N_("Maximum snapshot tree depth of %u exceeded"), SETTINGS_SNAPSHOT_DEPTH_MAX);
4872
4873 xml::ElementNode *pelmSnapshot = elmParent.createChild("Snapshot");
4874
4875 pelmSnapshot->setAttribute("uuid", snap.uuid.toStringCurly());
4876 pelmSnapshot->setAttribute("name", snap.strName);
4877 pelmSnapshot->setAttribute("timeStamp", makeString(snap.timestamp));
4878
4879 if (snap.strStateFile.length())
4880 pelmSnapshot->setAttributePath("stateFile", snap.strStateFile);
4881
4882 if (snap.strDescription.length())
4883 pelmSnapshot->createChild("Description")->addContent(snap.strDescription);
4884
4885 buildHardwareXML(*pelmSnapshot, snap.hardware, snap.storage);
4886 buildStorageControllersXML(*pelmSnapshot,
4887 snap.storage,
4888 false /* fSkipRemovableMedia */,
4889 NULL); /* pllElementsWithUuidAttributes */
4890 // we only skip removable media for OVF, but we never get here for OVF
4891 // since snapshots never get written then
4892 buildDebuggingXML(pelmSnapshot, &snap.debugging);
4893 buildAutostartXML(pelmSnapshot, &snap.autostart);
4894 // note: Groups exist only for Machine, not for Snapshot
4895
4896 if (snap.llChildSnapshots.size())
4897 {
4898 xml::ElementNode *pelmChildren = pelmSnapshot->createChild("Snapshots");
4899 for (SnapshotsList::const_iterator it = snap.llChildSnapshots.begin();
4900 it != snap.llChildSnapshots.end();
4901 ++it)
4902 {
4903 const Snapshot &child = *it;
4904 buildSnapshotXML(depth + 1, *pelmChildren, child);
4905 }
4906 }
4907}
4908
4909/**
4910 * Builds the XML DOM tree for the machine config under the given XML element.
4911 *
4912 * This has been separated out from write() so it can be called from elsewhere,
4913 * such as the OVF code, to build machine XML in an existing XML tree.
4914 *
4915 * As a result, this gets called from two locations:
4916 *
4917 * -- MachineConfigFile::write();
4918 *
4919 * -- Appliance::buildXMLForOneVirtualSystem()
4920 *
4921 * In fl, the following flag bits are recognized:
4922 *
4923 * -- BuildMachineXML_MediaRegistry: If set, the machine's media registry will
4924 * be written, if present. This is not set when called from OVF because OVF
4925 * has its own variant of a media registry. This flag is ignored unless the
4926 * settings version is at least v1.11 (VirtualBox 4.0).
4927 *
4928 * -- BuildMachineXML_IncludeSnapshots: If set, descend into the snapshots tree
4929 * of the machine and write out <Snapshot> and possibly more snapshots under
4930 * that, if snapshots are present. Otherwise all snapshots are suppressed
4931 * (when called from OVF).
4932 *
4933 * -- BuildMachineXML_WriteVboxVersionAttribute: If set, add a settingsVersion
4934 * attribute to the machine tag with the vbox settings version. This is for
4935 * the OVF export case in which we don't have the settings version set in
4936 * the root element.
4937 *
4938 * -- BuildMachineXML_SkipRemovableMedia: If set, removable media attachments
4939 * (DVDs, floppies) are silently skipped. This is for the OVF export case
4940 * until we support copying ISO and RAW media as well. This flag is ignored
4941 * unless the settings version is at least v1.9, which is always the case
4942 * when this gets called for OVF export.
4943 *
4944 * -- BuildMachineXML_SuppressSavedState: If set, the Machine/@stateFile
4945 * attribute is never set. This is also for the OVF export case because we
4946 * cannot save states with OVF.
4947 *
4948 * @param elmMachine XML <Machine> element to add attributes and elements to.
4949 * @param fl Flags.
4950 * @param pllElementsWithUuidAttributes pointer to list that should receive UUID elements or NULL;
4951 * see buildStorageControllersXML() for details.
4952 */
4953void MachineConfigFile::buildMachineXML(xml::ElementNode &elmMachine,
4954 uint32_t fl,
4955 std::list<xml::ElementNode*> *pllElementsWithUuidAttributes)
4956{
4957 if (fl & BuildMachineXML_WriteVboxVersionAttribute)
4958 // add settings version attribute to machine element
4959 setVersionAttribute(elmMachine);
4960
4961 elmMachine.setAttribute("uuid", uuid.toStringCurly());
4962 elmMachine.setAttribute("name", machineUserData.strName);
4963 if (machineUserData.fDirectoryIncludesUUID)
4964 elmMachine.setAttribute("directoryIncludesUUID", machineUserData.fDirectoryIncludesUUID);
4965 if (!machineUserData.fNameSync)
4966 elmMachine.setAttribute("nameSync", machineUserData.fNameSync);
4967 if (machineUserData.strDescription.length())
4968 elmMachine.createChild("Description")->addContent(machineUserData.strDescription);
4969 if (machineUserData.ovIcon.length())
4970 elmMachine.setAttribute("Icon", machineUserData.ovIcon);
4971 elmMachine.setAttribute("OSType", machineUserData.strOsType);
4972 if ( strStateFile.length()
4973 && !(fl & BuildMachineXML_SuppressSavedState)
4974 )
4975 elmMachine.setAttributePath("stateFile", strStateFile);
4976
4977 if ((fl & BuildMachineXML_IncludeSnapshots)
4978 && !uuidCurrentSnapshot.isZero()
4979 && uuidCurrentSnapshot.isValid())
4980 elmMachine.setAttribute("currentSnapshot", uuidCurrentSnapshot.toStringCurly());
4981
4982 if (machineUserData.strSnapshotFolder.length())
4983 elmMachine.setAttributePath("snapshotFolder", machineUserData.strSnapshotFolder);
4984 if (!fCurrentStateModified)
4985 elmMachine.setAttribute("currentStateModified", fCurrentStateModified);
4986 elmMachine.setAttribute("lastStateChange", makeString(timeLastStateChange));
4987 if (fAborted)
4988 elmMachine.setAttribute("aborted", fAborted);
4989 if ( m->sv >= SettingsVersion_v1_9
4990 && ( machineUserData.fTeleporterEnabled
4991 || machineUserData.uTeleporterPort
4992 || !machineUserData.strTeleporterAddress.isEmpty()
4993 || !machineUserData.strTeleporterPassword.isEmpty()
4994 )
4995 )
4996 {
4997 xml::ElementNode *pelmTeleporter = elmMachine.createChild("Teleporter");
4998 pelmTeleporter->setAttribute("enabled", machineUserData.fTeleporterEnabled);
4999 pelmTeleporter->setAttribute("port", machineUserData.uTeleporterPort);
5000 pelmTeleporter->setAttribute("address", machineUserData.strTeleporterAddress);
5001 pelmTeleporter->setAttribute("password", machineUserData.strTeleporterPassword);
5002 }
5003
5004 if ( m->sv >= SettingsVersion_v1_11
5005 && ( machineUserData.enmFaultToleranceState != FaultToleranceState_Inactive
5006 || machineUserData.uFaultTolerancePort
5007 || machineUserData.uFaultToleranceInterval
5008 || !machineUserData.strFaultToleranceAddress.isEmpty()
5009 )
5010 )
5011 {
5012 xml::ElementNode *pelmFaultTolerance = elmMachine.createChild("FaultTolerance");
5013 switch (machineUserData.enmFaultToleranceState)
5014 {
5015 case FaultToleranceState_Inactive:
5016 pelmFaultTolerance->setAttribute("state", "inactive");
5017 break;
5018 case FaultToleranceState_Master:
5019 pelmFaultTolerance->setAttribute("state", "master");
5020 break;
5021 case FaultToleranceState_Standby:
5022 pelmFaultTolerance->setAttribute("state", "standby");
5023 break;
5024 }
5025
5026 pelmFaultTolerance->setAttribute("port", machineUserData.uFaultTolerancePort);
5027 pelmFaultTolerance->setAttribute("address", machineUserData.strFaultToleranceAddress);
5028 pelmFaultTolerance->setAttribute("interval", machineUserData.uFaultToleranceInterval);
5029 pelmFaultTolerance->setAttribute("password", machineUserData.strFaultTolerancePassword);
5030 }
5031
5032 if ( (fl & BuildMachineXML_MediaRegistry)
5033 && (m->sv >= SettingsVersion_v1_11)
5034 )
5035 buildMediaRegistry(elmMachine, mediaRegistry);
5036
5037 buildExtraData(elmMachine, mapExtraDataItems);
5038
5039 if ( (fl & BuildMachineXML_IncludeSnapshots)
5040 && llFirstSnapshot.size())
5041 buildSnapshotXML(1, elmMachine, llFirstSnapshot.front());
5042
5043 buildHardwareXML(elmMachine, hardwareMachine, storageMachine);
5044 buildStorageControllersXML(elmMachine,
5045 storageMachine,
5046 !!(fl & BuildMachineXML_SkipRemovableMedia),
5047 pllElementsWithUuidAttributes);
5048 buildDebuggingXML(&elmMachine, &debugging);
5049 buildAutostartXML(&elmMachine, &autostart);
5050 buildGroupsXML(&elmMachine, &machineUserData.llGroups);
5051}
5052
5053/**
5054 * Returns true only if the given AudioDriverType is supported on
5055 * the current host platform. For example, this would return false
5056 * for AudioDriverType_DirectSound when compiled on a Linux host.
5057 * @param drv AudioDriverType_* enum to test.
5058 * @return true only if the current host supports that driver.
5059 */
5060/*static*/
5061bool MachineConfigFile::isAudioDriverAllowedOnThisHost(AudioDriverType_T drv)
5062{
5063 switch (drv)
5064 {
5065 case AudioDriverType_Null:
5066#ifdef RT_OS_WINDOWS
5067# ifdef VBOX_WITH_WINMM
5068 case AudioDriverType_WinMM:
5069# endif
5070 case AudioDriverType_DirectSound:
5071#endif /* RT_OS_WINDOWS */
5072#ifdef RT_OS_SOLARIS
5073 case AudioDriverType_SolAudio:
5074#endif
5075#ifdef RT_OS_LINUX
5076# ifdef VBOX_WITH_ALSA
5077 case AudioDriverType_ALSA:
5078# endif
5079# ifdef VBOX_WITH_PULSE
5080 case AudioDriverType_Pulse:
5081# endif
5082#endif /* RT_OS_LINUX */
5083#if defined (RT_OS_LINUX) || defined (RT_OS_FREEBSD) || defined(VBOX_WITH_SOLARIS_OSS)
5084 case AudioDriverType_OSS:
5085#endif
5086#ifdef RT_OS_FREEBSD
5087# ifdef VBOX_WITH_PULSE
5088 case AudioDriverType_Pulse:
5089# endif
5090#endif
5091#ifdef RT_OS_DARWIN
5092 case AudioDriverType_CoreAudio:
5093#endif
5094#ifdef RT_OS_OS2
5095 case AudioDriverType_MMPM:
5096#endif
5097 return true;
5098 }
5099
5100 return false;
5101}
5102
5103/**
5104 * Returns the AudioDriverType_* which should be used by default on this
5105 * host platform. On Linux, this will check at runtime whether PulseAudio
5106 * or ALSA are actually supported on the first call.
5107 * @return
5108 */
5109/*static*/
5110AudioDriverType_T MachineConfigFile::getHostDefaultAudioDriver()
5111{
5112#if defined(RT_OS_WINDOWS)
5113# ifdef VBOX_WITH_WINMM
5114 return AudioDriverType_WinMM;
5115# else /* VBOX_WITH_WINMM */
5116 return AudioDriverType_DirectSound;
5117# endif /* !VBOX_WITH_WINMM */
5118#elif defined(RT_OS_SOLARIS)
5119 return AudioDriverType_SolAudio;
5120#elif defined(RT_OS_LINUX)
5121 // on Linux, we need to check at runtime what's actually supported...
5122 static RTCLockMtx s_mtx;
5123 static AudioDriverType_T s_linuxDriver = -1;
5124 RTCLock lock(s_mtx);
5125 if (s_linuxDriver == (AudioDriverType_T)-1)
5126 {
5127# if defined(VBOX_WITH_PULSE)
5128 /* Check for the pulse library & that the pulse audio daemon is running. */
5129 if (RTProcIsRunningByName("pulseaudio") &&
5130 RTLdrIsLoadable("libpulse.so.0"))
5131 s_linuxDriver = AudioDriverType_Pulse;
5132 else
5133# endif /* VBOX_WITH_PULSE */
5134# if defined(VBOX_WITH_ALSA)
5135 /* Check if we can load the ALSA library */
5136 if (RTLdrIsLoadable("libasound.so.2"))
5137 s_linuxDriver = AudioDriverType_ALSA;
5138 else
5139# endif /* VBOX_WITH_ALSA */
5140 s_linuxDriver = AudioDriverType_OSS;
5141 }
5142 return s_linuxDriver;
5143// end elif defined(RT_OS_LINUX)
5144#elif defined(RT_OS_DARWIN)
5145 return AudioDriverType_CoreAudio;
5146#elif defined(RT_OS_OS2)
5147 return AudioDriverType_MMPM;
5148#elif defined(RT_OS_FREEBSD)
5149 return AudioDriverType_OSS;
5150#else
5151 return AudioDriverType_Null;
5152#endif
5153}
5154
5155/**
5156 * Called from write() before calling ConfigFileBase::createStubDocument().
5157 * This adjusts the settings version in m->sv if incompatible settings require
5158 * a settings bump, whereas otherwise we try to preserve the settings version
5159 * to avoid breaking compatibility with older versions.
5160 *
5161 * We do the checks in here in reverse order: newest first, oldest last, so
5162 * that we avoid unnecessary checks since some of these are expensive.
5163 */
5164void MachineConfigFile::bumpSettingsVersionIfNeeded()
5165{
5166 if (m->sv < SettingsVersion_v1_14)
5167 {
5168 // VirtualBox 4.3 adds default frontend setting, graphics controller
5169 // setting, explicit long mode setting and video capturing.
5170 if ( !hardwareMachine.strDefaultFrontend.isEmpty()
5171 || hardwareMachine.graphicsControllerType != GraphicsControllerType_VBoxVGA
5172 || hardwareMachine.enmLongMode != Hardware::LongMode_Legacy
5173 || machineUserData.ovIcon.length() > 0
5174 || hardwareMachine.fVideoCaptureEnabled)
5175 m->sv = SettingsVersion_v1_14;
5176 }
5177
5178 if (m->sv < SettingsVersion_v1_13)
5179 {
5180 // VirtualBox 4.2 adds tracing, autostart, UUID in directory and groups.
5181 if ( !debugging.areDefaultSettings()
5182 || !autostart.areDefaultSettings()
5183 || machineUserData.fDirectoryIncludesUUID
5184 || machineUserData.llGroups.size() > 1
5185 || machineUserData.llGroups.front() != "/")
5186 m->sv = SettingsVersion_v1_13;
5187 }
5188
5189 if (m->sv < SettingsVersion_v1_13)
5190 {
5191 // VirtualBox 4.2 changes the units for bandwidth group limits.
5192 for (BandwidthGroupList::const_iterator it = hardwareMachine.ioSettings.llBandwidthGroups.begin();
5193 it != hardwareMachine.ioSettings.llBandwidthGroups.end();
5194 ++it)
5195 {
5196 const BandwidthGroup &gr = *it;
5197 if (gr.cMaxBytesPerSec % _1M)
5198 {
5199 // Bump version if a limit cannot be expressed in megabytes
5200 m->sv = SettingsVersion_v1_13;
5201 break;
5202 }
5203 }
5204 }
5205
5206 if (m->sv < SettingsVersion_v1_13)
5207 {
5208 /* 4.2: Emulated USB Webcam. */
5209 if (hardwareMachine.fEmulatedUSBWebcam)
5210 m->sv = SettingsVersion_v1_13;
5211 }
5212
5213 if (m->sv < SettingsVersion_v1_12)
5214 {
5215 // VirtualBox 4.1 adds PCI passthrough and emulated USB Smart Card reader
5216 if ( hardwareMachine.pciAttachments.size()
5217 || hardwareMachine.fEmulatedUSBCardReader)
5218 m->sv = SettingsVersion_v1_12;
5219 }
5220
5221 if (m->sv < SettingsVersion_v1_12)
5222 {
5223 // VirtualBox 4.1 adds a promiscuous mode policy to the network
5224 // adapters and a generic network driver transport.
5225 NetworkAdaptersList::const_iterator netit;
5226 for (netit = hardwareMachine.llNetworkAdapters.begin();
5227 netit != hardwareMachine.llNetworkAdapters.end();
5228 ++netit)
5229 {
5230 if ( netit->enmPromiscModePolicy != NetworkAdapterPromiscModePolicy_Deny
5231 || netit->mode == NetworkAttachmentType_Generic
5232 || !netit->strGenericDriver.isEmpty()
5233 || netit->genericProperties.size()
5234 )
5235 {
5236 m->sv = SettingsVersion_v1_12;
5237 break;
5238 }
5239 }
5240 }
5241
5242 if (m->sv < SettingsVersion_v1_11)
5243 {
5244 // VirtualBox 4.0 adds HD audio, CPU priorities, fault tolerance,
5245 // per-machine media registries, VRDE, JRockitVE, bandwidth groups,
5246 // ICH9 chipset
5247 if ( hardwareMachine.audioAdapter.controllerType == AudioControllerType_HDA
5248 || hardwareMachine.ulCpuExecutionCap != 100
5249 || machineUserData.enmFaultToleranceState != FaultToleranceState_Inactive
5250 || machineUserData.uFaultTolerancePort
5251 || machineUserData.uFaultToleranceInterval
5252 || !machineUserData.strFaultToleranceAddress.isEmpty()
5253 || mediaRegistry.llHardDisks.size()
5254 || mediaRegistry.llDvdImages.size()
5255 || mediaRegistry.llFloppyImages.size()
5256 || !hardwareMachine.vrdeSettings.strVrdeExtPack.isEmpty()
5257 || !hardwareMachine.vrdeSettings.strAuthLibrary.isEmpty()
5258 || machineUserData.strOsType == "JRockitVE"
5259 || hardwareMachine.ioSettings.llBandwidthGroups.size()
5260 || hardwareMachine.chipsetType == ChipsetType_ICH9
5261 )
5262 m->sv = SettingsVersion_v1_11;
5263 }
5264
5265 if (m->sv < SettingsVersion_v1_10)
5266 {
5267 /* If the properties contain elements other than "TCP/Ports" and "TCP/Address",
5268 * then increase the version to at least VBox 3.2, which can have video channel properties.
5269 */
5270 unsigned cOldProperties = 0;
5271
5272 StringsMap::const_iterator it = hardwareMachine.vrdeSettings.mapProperties.find("TCP/Ports");
5273 if (it != hardwareMachine.vrdeSettings.mapProperties.end())
5274 cOldProperties++;
5275 it = hardwareMachine.vrdeSettings.mapProperties.find("TCP/Address");
5276 if (it != hardwareMachine.vrdeSettings.mapProperties.end())
5277 cOldProperties++;
5278
5279 if (hardwareMachine.vrdeSettings.mapProperties.size() != cOldProperties)
5280 m->sv = SettingsVersion_v1_10;
5281 }
5282
5283 if (m->sv < SettingsVersion_v1_11)
5284 {
5285 /* If the properties contain elements other than "TCP/Ports", "TCP/Address",
5286 * "VideoChannel/Enabled" and "VideoChannel/Quality" then increase the version to VBox 4.0.
5287 */
5288 unsigned cOldProperties = 0;
5289
5290 StringsMap::const_iterator it = hardwareMachine.vrdeSettings.mapProperties.find("TCP/Ports");
5291 if (it != hardwareMachine.vrdeSettings.mapProperties.end())
5292 cOldProperties++;
5293 it = hardwareMachine.vrdeSettings.mapProperties.find("TCP/Address");
5294 if (it != hardwareMachine.vrdeSettings.mapProperties.end())
5295 cOldProperties++;
5296 it = hardwareMachine.vrdeSettings.mapProperties.find("VideoChannel/Enabled");
5297 if (it != hardwareMachine.vrdeSettings.mapProperties.end())
5298 cOldProperties++;
5299 it = hardwareMachine.vrdeSettings.mapProperties.find("VideoChannel/Quality");
5300 if (it != hardwareMachine.vrdeSettings.mapProperties.end())
5301 cOldProperties++;
5302
5303 if (hardwareMachine.vrdeSettings.mapProperties.size() != cOldProperties)
5304 m->sv = SettingsVersion_v1_11;
5305 }
5306
5307 // settings version 1.9 is required if there is not exactly one DVD
5308 // or more than one floppy drive present or the DVD is not at the secondary
5309 // master; this check is a bit more complicated
5310 //
5311 // settings version 1.10 is required if the host cache should be disabled
5312 //
5313 // settings version 1.11 is required for bandwidth limits and if more than
5314 // one controller of each type is present.
5315 if (m->sv < SettingsVersion_v1_11)
5316 {
5317 // count attached DVDs and floppies (only if < v1.9)
5318 size_t cDVDs = 0;
5319 size_t cFloppies = 0;
5320
5321 // count storage controllers (if < v1.11)
5322 size_t cSata = 0;
5323 size_t cScsiLsi = 0;
5324 size_t cScsiBuslogic = 0;
5325 size_t cSas = 0;
5326 size_t cIde = 0;
5327 size_t cFloppy = 0;
5328
5329 // need to run thru all the storage controllers and attached devices to figure this out
5330 for (StorageControllersList::const_iterator it = storageMachine.llStorageControllers.begin();
5331 it != storageMachine.llStorageControllers.end();
5332 ++it)
5333 {
5334 const StorageController &sctl = *it;
5335
5336 // count storage controllers of each type; 1.11 is required if more than one
5337 // controller of one type is present
5338 switch (sctl.storageBus)
5339 {
5340 case StorageBus_IDE:
5341 cIde++;
5342 break;
5343 case StorageBus_SATA:
5344 cSata++;
5345 break;
5346 case StorageBus_SAS:
5347 cSas++;
5348 break;
5349 case StorageBus_SCSI:
5350 if (sctl.controllerType == StorageControllerType_LsiLogic)
5351 cScsiLsi++;
5352 else
5353 cScsiBuslogic++;
5354 break;
5355 case StorageBus_Floppy:
5356 cFloppy++;
5357 break;
5358 default:
5359 // Do nothing
5360 break;
5361 }
5362
5363 if ( cSata > 1
5364 || cScsiLsi > 1
5365 || cScsiBuslogic > 1
5366 || cSas > 1
5367 || cIde > 1
5368 || cFloppy > 1)
5369 {
5370 m->sv = SettingsVersion_v1_11;
5371 break; // abort the loop -- we will not raise the version further
5372 }
5373
5374 for (AttachedDevicesList::const_iterator it2 = sctl.llAttachedDevices.begin();
5375 it2 != sctl.llAttachedDevices.end();
5376 ++it2)
5377 {
5378 const AttachedDevice &att = *it2;
5379
5380 // Bandwidth limitations are new in VirtualBox 4.0 (1.11)
5381 if (m->sv < SettingsVersion_v1_11)
5382 {
5383 if (att.strBwGroup.length() != 0)
5384 {
5385 m->sv = SettingsVersion_v1_11;
5386 break; // abort the loop -- we will not raise the version further
5387 }
5388 }
5389
5390 // disabling the host IO cache requires settings version 1.10
5391 if ( (m->sv < SettingsVersion_v1_10)
5392 && (!sctl.fUseHostIOCache)
5393 )
5394 m->sv = SettingsVersion_v1_10;
5395
5396 // we can only write the StorageController/@Instance attribute with v1.9
5397 if ( (m->sv < SettingsVersion_v1_9)
5398 && (sctl.ulInstance != 0)
5399 )
5400 m->sv = SettingsVersion_v1_9;
5401
5402 if (m->sv < SettingsVersion_v1_9)
5403 {
5404 if (att.deviceType == DeviceType_DVD)
5405 {
5406 if ( (sctl.storageBus != StorageBus_IDE) // DVD at bus other than DVD?
5407 || (att.lPort != 1) // DVDs not at secondary master?
5408 || (att.lDevice != 0)
5409 )
5410 m->sv = SettingsVersion_v1_9;
5411
5412 ++cDVDs;
5413 }
5414 else if (att.deviceType == DeviceType_Floppy)
5415 ++cFloppies;
5416 }
5417 }
5418
5419 if (m->sv >= SettingsVersion_v1_11)
5420 break; // abort the loop -- we will not raise the version further
5421 }
5422
5423 // VirtualBox before 3.1 had zero or one floppy and exactly one DVD,
5424 // so any deviation from that will require settings version 1.9
5425 if ( (m->sv < SettingsVersion_v1_9)
5426 && ( (cDVDs != 1)
5427 || (cFloppies > 1)
5428 )
5429 )
5430 m->sv = SettingsVersion_v1_9;
5431 }
5432
5433 // VirtualBox 3.2: Check for non default I/O settings
5434 if (m->sv < SettingsVersion_v1_10)
5435 {
5436 if ( (hardwareMachine.ioSettings.fIOCacheEnabled != true)
5437 || (hardwareMachine.ioSettings.ulIOCacheSize != 5)
5438 // and page fusion
5439 || (hardwareMachine.fPageFusionEnabled)
5440 // and CPU hotplug, RTC timezone control, HID type and HPET
5441 || machineUserData.fRTCUseUTC
5442 || hardwareMachine.fCpuHotPlug
5443 || hardwareMachine.pointingHIDType != PointingHIDType_PS2Mouse
5444 || hardwareMachine.keyboardHIDType != KeyboardHIDType_PS2Keyboard
5445 || hardwareMachine.fHPETEnabled
5446 )
5447 m->sv = SettingsVersion_v1_10;
5448 }
5449
5450 // VirtualBox 3.2 adds NAT and boot priority to the NIC config in Main
5451 // VirtualBox 4.0 adds network bandwitdth
5452 if (m->sv < SettingsVersion_v1_11)
5453 {
5454 NetworkAdaptersList::const_iterator netit;
5455 for (netit = hardwareMachine.llNetworkAdapters.begin();
5456 netit != hardwareMachine.llNetworkAdapters.end();
5457 ++netit)
5458 {
5459 if ( (m->sv < SettingsVersion_v1_12)
5460 && (netit->strBandwidthGroup.isNotEmpty())
5461 )
5462 {
5463 /* New in VirtualBox 4.1 */
5464 m->sv = SettingsVersion_v1_12;
5465 break;
5466 }
5467 else if ( (m->sv < SettingsVersion_v1_10)
5468 && (netit->fEnabled)
5469 && (netit->mode == NetworkAttachmentType_NAT)
5470 && ( netit->nat.u32Mtu != 0
5471 || netit->nat.u32SockRcv != 0
5472 || netit->nat.u32SockSnd != 0
5473 || netit->nat.u32TcpRcv != 0
5474 || netit->nat.u32TcpSnd != 0
5475 || !netit->nat.fDNSPassDomain
5476 || netit->nat.fDNSProxy
5477 || netit->nat.fDNSUseHostResolver
5478 || netit->nat.fAliasLog
5479 || netit->nat.fAliasProxyOnly
5480 || netit->nat.fAliasUseSamePorts
5481 || netit->nat.strTFTPPrefix.length()
5482 || netit->nat.strTFTPBootFile.length()
5483 || netit->nat.strTFTPNextServer.length()
5484 || netit->nat.llRules.size()
5485 )
5486 )
5487 {
5488 m->sv = SettingsVersion_v1_10;
5489 // no break because we still might need v1.11 above
5490 }
5491 else if ( (m->sv < SettingsVersion_v1_10)
5492 && (netit->fEnabled)
5493 && (netit->ulBootPriority != 0)
5494 )
5495 {
5496 m->sv = SettingsVersion_v1_10;
5497 // no break because we still might need v1.11 above
5498 }
5499 }
5500 }
5501
5502 // all the following require settings version 1.9
5503 if ( (m->sv < SettingsVersion_v1_9)
5504 && ( (hardwareMachine.firmwareType >= FirmwareType_EFI)
5505 || (hardwareMachine.fHardwareVirtExclusive != HWVIRTEXCLUSIVEDEFAULT)
5506 || machineUserData.fTeleporterEnabled
5507 || machineUserData.uTeleporterPort
5508 || !machineUserData.strTeleporterAddress.isEmpty()
5509 || !machineUserData.strTeleporterPassword.isEmpty()
5510 || (!hardwareMachine.uuid.isZero() && hardwareMachine.uuid.isValid())
5511 )
5512 )
5513 m->sv = SettingsVersion_v1_9;
5514
5515 // "accelerate 2d video" requires settings version 1.8
5516 if ( (m->sv < SettingsVersion_v1_8)
5517 && (hardwareMachine.fAccelerate2DVideo)
5518 )
5519 m->sv = SettingsVersion_v1_8;
5520
5521 // The hardware versions other than "1" requires settings version 1.4 (2.1+).
5522 if ( m->sv < SettingsVersion_v1_4
5523 && hardwareMachine.strVersion != "1"
5524 )
5525 m->sv = SettingsVersion_v1_4;
5526}
5527
5528/**
5529 * Called from Main code to write a machine config file to disk. This builds a DOM tree from
5530 * the member variables and then writes the XML file; it throws xml::Error instances on errors,
5531 * in particular if the file cannot be written.
5532 */
5533void MachineConfigFile::write(const com::Utf8Str &strFilename)
5534{
5535 try
5536 {
5537 // createStubDocument() sets the settings version to at least 1.7; however,
5538 // we might need to enfore a later settings version if incompatible settings
5539 // are present:
5540 bumpSettingsVersionIfNeeded();
5541
5542 m->strFilename = strFilename;
5543 createStubDocument();
5544
5545 xml::ElementNode *pelmMachine = m->pelmRoot->createChild("Machine");
5546 buildMachineXML(*pelmMachine,
5547 MachineConfigFile::BuildMachineXML_IncludeSnapshots
5548 | MachineConfigFile::BuildMachineXML_MediaRegistry,
5549 // but not BuildMachineXML_WriteVboxVersionAttribute
5550 NULL); /* pllElementsWithUuidAttributes */
5551
5552 // now go write the XML
5553 xml::XmlFileWriter writer(*m->pDoc);
5554 writer.write(m->strFilename.c_str(), true /*fSafe*/);
5555
5556 m->fFileExists = true;
5557 clearDocument();
5558 }
5559 catch (...)
5560 {
5561 clearDocument();
5562 throw;
5563 }
5564}
Note: See TracBrowser for help on using the repository browser.

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