VirtualBox

source: vbox/trunk/include/VBox/settings.h@ 25203

Last change on this file since 25203 was 25203, checked in by vboxsync, 15 years ago

Main: make SerialPort instance data private and make it use the XML settings struct for simplicity
  • Property svn:eol-style set to native
  • Property svn:keywords set to Date Revision Author Id
File size: 19.6 KB
Line 
1/** @file
2 * Settings file data structures.
3 *
4 * These structures are created by the settings file loader and filled with values
5 * copied from the raw XML data. This allows us to finally make the XML reader
6 * version-independent and read VirtualBox XML files from earlier versions without
7 * requiring complicated, tedious and error-prone XSLT conversions.
8 *
9 * Note: Headers in Main code have been tweaked to only declare the structures
10 * defined here so that this header need only be included from code files that
11 * actually use these structures.
12 */
13
14/*
15 * Copyright (C) 2007-2009 Sun Microsystems, Inc.
16 *
17 * This file is part of VirtualBox Open Source Edition (OSE), as
18 * available from http://www.virtualbox.org. This file is free software;
19 * you can redistribute it and/or modify it under the terms of the GNU
20 * General Public License (GPL) as published by the Free Software
21 * Foundation, in version 2 as it comes in the "COPYING" file of the
22 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
23 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
24 *
25 * The contents of this file may alternatively be used under the terms
26 * of the Common Development and Distribution License Version 1.0
27 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
28 * VirtualBox OSE distribution, in which case the provisions of the
29 * CDDL are applicable instead of those of the GPL.
30 *
31 * You may elect to license modified versions of this file under the
32 * terms and conditions of either the GPL or the CDDL or both.
33 *
34 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
35 * Clara, CA 95054 USA or visit http://www.sun.com if you need
36 * additional information or have any questions.
37 */
38
39#ifndef ___VBox_settings_h
40#define ___VBox_settings_h
41
42#include <iprt/time.h>
43
44#include "VBox/com/VirtualBox.h"
45
46#include <VBox/com/Guid.h>
47#include <VBox/com/string.h>
48
49#include <list>
50#include <map>
51#include <vector>
52
53namespace xml
54{
55 class ElementNode;
56}
57
58namespace settings
59{
60
61class ConfigFileError;
62
63////////////////////////////////////////////////////////////////////////////////
64//
65// Helper classes
66//
67////////////////////////////////////////////////////////////////////////////////
68
69// ExtraDataItem (used by both VirtualBox.xml and machines XML)
70typedef std::map<com::Utf8Str, com::Utf8Str> ExtraDataItemsMap;
71struct USBDeviceFilter;
72typedef std::list<USBDeviceFilter> USBDeviceFiltersList;
73
74/**
75 * Common base class for both MainConfigFile and MachineConfigFile
76 * which contains some common logic for both.
77 */
78class ConfigFileBase
79{
80public:
81 bool fileExists();
82
83protected:
84 ConfigFileBase(const com::Utf8Str *pstrFilename);
85 ~ConfigFileBase();
86
87 void parseUUID(com::Guid &guid,
88 const com::Utf8Str &strUUID) const;
89 void parseTimestamp(RTTIMESPEC &timestamp,
90 const com::Utf8Str &str) const;
91
92 com::Utf8Str makeString(const RTTIMESPEC &tm);
93 com::Utf8Str makeString(const com::Guid &guid);
94
95 void readExtraData(const xml::ElementNode &elmExtraData,
96 ExtraDataItemsMap &map);
97 void readUSBDeviceFilters(const xml::ElementNode &elmDeviceFilters,
98 USBDeviceFiltersList &ll);
99
100 void createStubDocument();
101
102 void writeExtraData(xml::ElementNode &elmParent, const ExtraDataItemsMap &me);
103 void writeUSBDeviceFilters(xml::ElementNode &elmParent,
104 const USBDeviceFiltersList &ll,
105 bool fHostMode);
106
107 void clearDocument();
108
109 struct Data;
110 Data *m;
111
112 friend class ConfigFileError;
113};
114
115////////////////////////////////////////////////////////////////////////////////
116//
117// VirtualBox.xml structures
118//
119////////////////////////////////////////////////////////////////////////////////
120
121struct USBDeviceFilter
122{
123 USBDeviceFilter()
124 : fActive(false),
125 action(USBDeviceFilterAction_Null),
126 ulMaskedInterfaces(0)
127 {}
128
129 com::Utf8Str strName;
130 bool fActive;
131 com::Utf8Str strVendorId,
132 strProductId,
133 strRevision,
134 strManufacturer,
135 strProduct,
136 strSerialNumber,
137 strPort;
138 USBDeviceFilterAction_T action; // only used with host USB filters
139 com::Utf8Str strRemote; // irrelevant for host USB objects
140 uint32_t ulMaskedInterfaces; // irrelevant for host USB objects
141};
142
143struct Host
144{
145 USBDeviceFiltersList llUSBDeviceFilters;
146};
147
148struct SystemProperties
149{
150 SystemProperties()
151 : ulLogHistoryCount(3)
152 {}
153
154 com::Utf8Str strDefaultMachineFolder;
155 com::Utf8Str strDefaultHardDiskFolder;
156 com::Utf8Str strDefaultHardDiskFormat;
157 com::Utf8Str strRemoteDisplayAuthLibrary;
158 com::Utf8Str strWebServiceAuthLibrary;
159 uint32_t ulLogHistoryCount;
160};
161
162typedef std::map<com::Utf8Str, com::Utf8Str> PropertiesMap;
163
164struct Medium;
165typedef std::list<Medium> MediaList;
166
167struct Medium
168{
169 com::Guid uuid;
170 com::Utf8Str strLocation;
171 com::Utf8Str strDescription;
172
173 // the following are for hard disks only:
174 com::Utf8Str strFormat;
175 bool fAutoReset; // optional, only for diffs, default is false
176 PropertiesMap properties;
177 MediumType_T hdType;
178
179 MediaList llChildren; // only used with hard disks
180};
181
182struct MachineRegistryEntry
183{
184 com::Guid uuid;
185 com::Utf8Str strSettingsFile;
186};
187typedef std::list<MachineRegistryEntry> MachinesRegistry;
188
189struct DHCPServer
190{
191 com::Utf8Str strNetworkName,
192 strIPAddress,
193 strIPNetworkMask,
194 strIPLower,
195 strIPUpper;
196 bool fEnabled;
197};
198typedef std::list<DHCPServer> DHCPServersList;
199
200class MainConfigFile : public ConfigFileBase
201{
202public:
203 MainConfigFile(const com::Utf8Str *pstrFilename);
204
205 typedef enum {Error, HardDisk, DVDImage, FloppyImage} MediaType;
206 void readMedium(MediaType t, const xml::ElementNode &elmMedium, MediaList &llMedia);
207 void readMediaRegistry(const xml::ElementNode &elmMediaRegistry);
208 void readMachineRegistry(const xml::ElementNode &elmMachineRegistry);
209 void readDHCPServers(const xml::ElementNode &elmDHCPServers);
210
211 void writeHardDisk(xml::ElementNode &elmMedium,
212 const Medium &m,
213 uint32_t level);
214 void write(const com::Utf8Str strFilename);
215
216 Host host;
217 SystemProperties systemProperties;
218 MediaList llHardDisks,
219 llDvdImages,
220 llFloppyImages;
221 MachinesRegistry llMachines;
222 DHCPServersList llDhcpServers;
223 ExtraDataItemsMap mapExtraDataItems;
224};
225
226////////////////////////////////////////////////////////////////////////////////
227//
228// Machine XML structures
229//
230////////////////////////////////////////////////////////////////////////////////
231
232struct VRDPSettings
233{
234 VRDPSettings()
235 : fEnabled(true),
236 authType(VRDPAuthType_Null),
237 ulAuthTimeout(5000),
238 fAllowMultiConnection(false),
239 fReuseSingleConnection(false)
240 {}
241
242 bool fEnabled;
243 com::Utf8Str strPort;
244 com::Utf8Str strNetAddress;
245 VRDPAuthType_T authType;
246 uint32_t ulAuthTimeout;
247 bool fAllowMultiConnection,
248 fReuseSingleConnection;
249};
250
251struct BIOSSettings
252{
253 BIOSSettings()
254 : fACPIEnabled(true),
255 fIOAPICEnabled(false),
256 fLogoFadeIn(true),
257 fLogoFadeOut(false),
258 ulLogoDisplayTime(0),
259 biosBootMenuMode(BIOSBootMenuMode_MessageAndMenu),
260 fPXEDebugEnabled(false),
261 llTimeOffset(0)
262 {}
263
264 bool operator==(const BIOSSettings &d) const
265 {
266 return ( this == &d
267 || ( fACPIEnabled == d.fACPIEnabled
268 && fIOAPICEnabled == d.fIOAPICEnabled
269 && fLogoFadeIn == d.fLogoFadeIn
270 && fLogoFadeOut == d.fLogoFadeOut
271 && ulLogoDisplayTime == d.ulLogoDisplayTime
272 && strLogoImagePath == d.strLogoImagePath
273 && biosBootMenuMode == d.biosBootMenuMode
274 && fPXEDebugEnabled == d.fPXEDebugEnabled
275 && llTimeOffset == d.llTimeOffset)
276 );
277 }
278
279 bool fACPIEnabled,
280 fIOAPICEnabled,
281 fLogoFadeIn,
282 fLogoFadeOut;
283 uint32_t ulLogoDisplayTime;
284 com::Utf8Str strLogoImagePath;
285 BIOSBootMenuMode_T biosBootMenuMode;
286 bool fPXEDebugEnabled;
287 int64_t llTimeOffset;
288};
289
290struct USBController
291{
292 USBController()
293 : fEnabled(false),
294 fEnabledEHCI(false)
295 {}
296
297 bool fEnabled;
298 bool fEnabledEHCI;
299 USBDeviceFiltersList llDeviceFilters;
300};
301
302struct NetworkAdapter
303{
304 NetworkAdapter()
305 : ulSlot(0),
306 type(NetworkAdapterType_Am79C970A),
307 fEnabled(false),
308 fCableConnected(false),
309 ulLineSpeed(0),
310 fTraceEnabled(false),
311 mode(NetworkAttachmentType_Null)
312 {}
313
314 uint32_t ulSlot;
315
316 NetworkAdapterType_T type;
317 bool fEnabled;
318 com::Utf8Str strMACAddress;
319 bool fCableConnected;
320 uint32_t ulLineSpeed;
321 bool fTraceEnabled;
322 com::Utf8Str strTraceFile;
323
324 NetworkAttachmentType_T mode;
325 com::Utf8Str strName; // with NAT: nat network or empty;
326 // with bridged: host interface or empty;
327 // otherwise: network name (required)
328};
329typedef std::list<NetworkAdapter> NetworkAdaptersList;
330
331struct SerialPort
332{
333 SerialPort()
334 : ulSlot(0),
335 fEnabled(false),
336 ulIOBase(4),
337 ulIRQ(0x3f8),
338 portMode(PortMode_Disconnected),
339 fServer(false)
340 {}
341
342 bool operator==(const SerialPort &d) const
343 {
344 return (this == &d)
345 || ( ulSlot == d.ulSlot
346 && fEnabled == d.fEnabled
347 && ulIOBase == d.ulIOBase
348 && ulIRQ == d.ulIRQ
349 && portMode == d.portMode
350 && strPath == d.strPath
351 && fServer == d.fServer
352 );
353 }
354
355 uint32_t ulSlot;
356
357 bool fEnabled;
358 uint32_t ulIOBase;
359 uint32_t ulIRQ;
360 PortMode_T portMode;
361 com::Utf8Str strPath;
362 bool fServer;
363};
364typedef std::list<SerialPort> SerialPortsList;
365
366struct ParallelPort
367{
368 ParallelPort()
369 : ulSlot(0),
370 fEnabled(false),
371 ulIOBase(0x378),
372 ulIRQ(4)
373 {}
374
375 bool operator==(const ParallelPort &d) const
376 {
377 return (this == &d)
378 || ( ulSlot == d.ulSlot
379 && fEnabled == d.fEnabled
380 && ulIOBase == d.ulIOBase
381 && ulIRQ == d.ulIRQ
382 && strPath == d.strPath
383 );
384 }
385
386 uint32_t ulSlot;
387
388 bool fEnabled;
389 uint32_t ulIOBase;
390 uint32_t ulIRQ;
391 com::Utf8Str strPath;
392};
393typedef std::list<ParallelPort> ParallelPortsList;
394
395struct AudioAdapter
396{
397 AudioAdapter()
398 : fEnabled(true),
399 controllerType(AudioControllerType_AC97),
400 driverType(AudioDriverType_Null)
401 {}
402
403 bool fEnabled;
404 AudioControllerType_T controllerType;
405 AudioDriverType_T driverType;
406};
407
408struct SharedFolder
409{
410 SharedFolder()
411 : fWritable(false)
412 {}
413
414 com::Utf8Str strName,
415 strHostPath;
416 bool fWritable;
417};
418typedef std::list<SharedFolder> SharedFoldersList;
419
420struct GuestProperty
421{
422 GuestProperty()
423 : timestamp(0)
424 {};
425
426 com::Utf8Str strName,
427 strValue;
428 uint64_t timestamp;
429 com::Utf8Str strFlags;
430};
431typedef std::list<GuestProperty> GuestPropertiesList;
432
433typedef std::map<uint32_t, DeviceType_T> BootOrderMap;
434
435struct CpuIdLeaf
436{
437 CpuIdLeaf()
438 : ulId(UINT32_MAX),
439 ulEax(0),
440 ulEbx(0),
441 ulEcx(0),
442 ulEdx(0)
443 {}
444
445 uint32_t ulId;
446 uint32_t ulEax;
447 uint32_t ulEbx;
448 uint32_t ulEcx;
449 uint32_t ulEdx;
450};
451typedef std::list<CpuIdLeaf> CpuIdLeafsList;
452
453struct Hardware
454{
455 Hardware();
456
457 com::Utf8Str strVersion; // hardware version, optional
458 com::Guid uuid; // hardware uuid, optional (null).
459
460 bool fHardwareVirt,
461 fHardwareVirtExclusive,
462 fNestedPaging,
463 fVPID,
464 fSyntheticCpu,
465 fPAE;
466 uint32_t cCPUs;
467 CpuIdLeafsList llCpuIdLeafs;
468
469 uint32_t ulMemorySizeMB;
470
471 BootOrderMap mapBootOrder; // item 0 has highest priority
472
473 uint32_t ulVRAMSizeMB;
474 uint32_t cMonitors;
475 bool fAccelerate3D,
476 fAccelerate2DVideo; // requires settings version 1.8 (VirtualBox 3.1)
477 FirmwareType_T firmwareType; // requires settings version 1.9 (VirtualBox 3.1)
478
479 VRDPSettings vrdpSettings;
480
481 BIOSSettings biosSettings;
482 USBController usbController;
483 NetworkAdaptersList llNetworkAdapters;
484 SerialPortsList llSerialPorts;
485 ParallelPortsList llParallelPorts;
486 AudioAdapter audioAdapter;
487
488 // technically these two have no business in the hardware section, but for some
489 // clever reason <Hardware> is where they are in the XML....
490 SharedFoldersList llSharedFolders;
491 ClipboardMode_T clipboardMode;
492
493 uint32_t ulMemoryBalloonSize;
494 uint32_t ulStatisticsUpdateInterval;
495
496 GuestPropertiesList llGuestProperties;
497 com::Utf8Str strNotificationPatterns;
498};
499
500/**
501 * A device attached to a storage controller. This can either be a
502 * hard disk or a DVD drive or a floppy drive and also specifies
503 * which medium is "in" the drive; as a result, this is a combination
504 * of the Main IMedium and IMediumAttachment interfaces.
505 */
506struct AttachedDevice
507{
508 AttachedDevice()
509 : deviceType(DeviceType_Null),
510 fPassThrough(false),
511 lPort(0),
512 lDevice(0)
513 {}
514
515 DeviceType_T deviceType; // only HardDisk, DVD or Floppy are allowed
516
517 // DVDs can be in pass-through mode:
518 bool fPassThrough;
519
520 int32_t lPort;
521 int32_t lDevice;
522
523 // if an image file is attached to the device (ISO, RAW, or hard disk image such as VDI),
524 // this is its UUID; it depends on deviceType which media registry this then needs to
525 // be looked up in. If no image file (only permitted for DVDs and floppies), then the UUID is NULL
526 com::Guid uuid;
527
528 // for DVDs and floppies, the attachment can also be a host device:
529 com::Utf8Str strHostDriveSrc; // if != NULL, value of <HostDrive>/@src
530};
531typedef std::list<AttachedDevice> AttachedDevicesList;
532
533struct StorageController
534{
535 StorageController()
536 : storageBus(StorageBus_IDE),
537 controllerType(StorageControllerType_PIIX3),
538 ulPortCount(2),
539 ulInstance(0),
540 lIDE0MasterEmulationPort(0),
541 lIDE0SlaveEmulationPort(0),
542 lIDE1MasterEmulationPort(0),
543 lIDE1SlaveEmulationPort(0)
544 {}
545
546 com::Utf8Str strName;
547 StorageBus_T storageBus; // _SATA, _SCSI, _IDE
548 StorageControllerType_T controllerType;
549 uint32_t ulPortCount;
550 uint32_t ulInstance;
551
552 // only for when controllerType == StorageControllerType_IntelAhci:
553 int32_t lIDE0MasterEmulationPort,
554 lIDE0SlaveEmulationPort,
555 lIDE1MasterEmulationPort,
556 lIDE1SlaveEmulationPort;
557
558 AttachedDevicesList llAttachedDevices;
559};
560typedef std::list<StorageController> StorageControllersList;
561
562// wrap the list into an extra struct so we can use the struct without
563// having to define the typedef above in headers
564struct Storage
565{
566 StorageControllersList llStorageControllers;
567};
568
569struct Snapshot;
570typedef std::list<Snapshot> SnapshotsList;
571
572struct Snapshot
573{
574 com::Guid uuid;
575 com::Utf8Str strName,
576 strDescription; // optional
577 RTTIMESPEC timestamp;
578
579 com::Utf8Str strStateFile; // for online snapshots only
580
581 Hardware hardware;
582 Storage storage;
583
584 SnapshotsList llChildSnapshots;
585};
586
587
588class MachineConfigFile : public ConfigFileBase
589{
590public:
591 MachineConfigFile(const com::Utf8Str *pstrFilename);
592
593 void readNetworkAdapters(const xml::ElementNode &elmHardware, NetworkAdaptersList &ll);
594 void readCpuIdTree(const xml::ElementNode &elmCpuid, CpuIdLeafsList &ll);
595 void readSerialPorts(const xml::ElementNode &elmUART, SerialPortsList &ll);
596 void readParallelPorts(const xml::ElementNode &elmLPT, ParallelPortsList &ll);
597 void readGuestProperties(const xml::ElementNode &elmGuestProperties, Hardware &hw);
598 void readStorageControllerAttributes(const xml::ElementNode &elmStorageController, StorageController &sctl);
599 void readHardware(const xml::ElementNode &elmHardware, Hardware &hw, Storage &strg);
600 void readHardDiskAttachments_pre1_7(const xml::ElementNode &elmHardDiskAttachments, Storage &strg);
601 void readStorageControllers(const xml::ElementNode &elmStorageControllers, Storage &strg);
602 void readDVDAndFloppies_pre1_9(const xml::ElementNode &elmHardware, Storage &strg);
603 void readSnapshot(const xml::ElementNode &elmSnapshot, Snapshot &snap);
604 void convertOldOSType_pre1_5(com::Utf8Str &str);
605 void readMachine(const xml::ElementNode &elmMachine);
606
607 void writeHardware(xml::ElementNode &elmParent, const Hardware &hw, const Storage &strg);
608 void writeStorageControllers(xml::ElementNode &elmParent, const Storage &st);
609 void writeSnapshot(xml::ElementNode &elmParent, const Snapshot &snap);
610 void bumpSettingsVersionIfNeeded();
611 void write(const com::Utf8Str &strFilename);
612
613 com::Guid uuid;
614 com::Utf8Str strName;
615 bool fNameSync;
616 com::Utf8Str strDescription;
617 com::Utf8Str strOsType;
618 com::Utf8Str strStateFile;
619 com::Guid uuidCurrentSnapshot;
620 com::Utf8Str strSnapshotFolder;
621 bool fTeleporterEnabled;
622 uint32_t uTeleporterPort;
623 com::Utf8Str strTeleporterAddress;
624 com::Utf8Str strTeleporterPassword;
625
626 bool fCurrentStateModified; // optional, default is true
627 RTTIMESPEC timeLastStateChange; // optional, defaults to now
628 bool fAborted; // optional, default is false
629
630 Hardware hardwareMachine;
631 Storage storageMachine;
632
633 ExtraDataItemsMap mapExtraDataItems;
634
635 SnapshotsList llFirstSnapshot; // first snapshot or empty list if there's none
636};
637
638} // namespace settings
639
640
641#endif /* ___VBox_settings_h */
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