VirtualBox

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

Last change on this file since 45733 was 45731, checked in by vboxsync, 12 years ago

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