VirtualBox

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

Last change on this file since 47470 was 47401, checked in by vboxsync, 11 years ago

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

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