VirtualBox

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

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

Main: make BIOSSettings 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: 18.8 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 : fEnabled(false),
335 ulIOBase(0),
336 ulIRQ(0),
337 portMode(PortMode_Disconnected),
338 fServer(false)
339 {}
340
341 uint32_t ulSlot;
342
343 bool fEnabled;
344 uint32_t ulIOBase;
345 uint32_t ulIRQ;
346 PortMode_T portMode;
347 com::Utf8Str strPath;
348 bool fServer;
349};
350typedef std::list<SerialPort> SerialPortsList;
351
352struct ParallelPort
353{
354 ParallelPort()
355 : fEnabled(false),
356 ulIOBase(0),
357 ulIRQ(0)
358 {}
359
360 uint32_t ulSlot;
361
362 bool fEnabled;
363 uint32_t ulIOBase;
364 uint32_t ulIRQ;
365 com::Utf8Str strPath;
366};
367typedef std::list<ParallelPort> ParallelPortsList;
368
369struct AudioAdapter
370{
371 AudioAdapter()
372 : fEnabled(true),
373 controllerType(AudioControllerType_AC97),
374 driverType(AudioDriverType_Null)
375 {}
376
377 bool fEnabled;
378 AudioControllerType_T controllerType;
379 AudioDriverType_T driverType;
380};
381
382struct SharedFolder
383{
384 SharedFolder()
385 : fWritable(false)
386 {}
387
388 com::Utf8Str strName,
389 strHostPath;
390 bool fWritable;
391};
392typedef std::list<SharedFolder> SharedFoldersList;
393
394struct GuestProperty
395{
396 GuestProperty()
397 : timestamp(0)
398 {};
399
400 com::Utf8Str strName,
401 strValue;
402 uint64_t timestamp;
403 com::Utf8Str strFlags;
404};
405typedef std::list<GuestProperty> GuestPropertiesList;
406
407typedef std::map<uint32_t, DeviceType_T> BootOrderMap;
408
409struct CpuIdLeaf
410{
411 CpuIdLeaf()
412 : ulId(UINT32_MAX),
413 ulEax(0),
414 ulEbx(0),
415 ulEcx(0),
416 ulEdx(0)
417 {}
418
419 uint32_t ulId;
420 uint32_t ulEax;
421 uint32_t ulEbx;
422 uint32_t ulEcx;
423 uint32_t ulEdx;
424};
425typedef std::list<CpuIdLeaf> CpuIdLeafsList;
426
427struct Hardware
428{
429 Hardware();
430
431 com::Utf8Str strVersion; // hardware version, optional
432 com::Guid uuid; // hardware uuid, optional (null).
433
434 bool fHardwareVirt,
435 fHardwareVirtExclusive,
436 fNestedPaging,
437 fVPID,
438 fSyntheticCpu,
439 fPAE;
440 uint32_t cCPUs;
441 CpuIdLeafsList llCpuIdLeafs;
442
443 uint32_t ulMemorySizeMB;
444
445 BootOrderMap mapBootOrder; // item 0 has highest priority
446
447 uint32_t ulVRAMSizeMB;
448 uint32_t cMonitors;
449 bool fAccelerate3D,
450 fAccelerate2DVideo; // requires settings version 1.8 (VirtualBox 3.1)
451 FirmwareType_T firmwareType; // requires settings version 1.9 (VirtualBox 3.1)
452
453 VRDPSettings vrdpSettings;
454
455 BIOSSettings biosSettings;
456 USBController usbController;
457 NetworkAdaptersList llNetworkAdapters;
458 SerialPortsList llSerialPorts;
459 ParallelPortsList llParallelPorts;
460 AudioAdapter audioAdapter;
461
462 // technically these two have no business in the hardware section, but for some
463 // clever reason <Hardware> is where they are in the XML....
464 SharedFoldersList llSharedFolders;
465 ClipboardMode_T clipboardMode;
466
467 uint32_t ulMemoryBalloonSize;
468 uint32_t ulStatisticsUpdateInterval;
469
470 GuestPropertiesList llGuestProperties;
471 com::Utf8Str strNotificationPatterns;
472};
473
474/**
475 * A device attached to a storage controller. This can either be a
476 * hard disk or a DVD drive or a floppy drive and also specifies
477 * which medium is "in" the drive; as a result, this is a combination
478 * of the Main IMedium and IMediumAttachment interfaces.
479 */
480struct AttachedDevice
481{
482 AttachedDevice()
483 : deviceType(DeviceType_Null),
484 fPassThrough(false),
485 lPort(0),
486 lDevice(0)
487 {}
488
489 DeviceType_T deviceType; // only HardDisk, DVD or Floppy are allowed
490
491 // DVDs can be in pass-through mode:
492 bool fPassThrough;
493
494 int32_t lPort;
495 int32_t lDevice;
496
497 // if an image file is attached to the device (ISO, RAW, or hard disk image such as VDI),
498 // this is its UUID; it depends on deviceType which media registry this then needs to
499 // be looked up in. If no image file (only permitted for DVDs and floppies), then the UUID is NULL
500 com::Guid uuid;
501
502 // for DVDs and floppies, the attachment can also be a host device:
503 com::Utf8Str strHostDriveSrc; // if != NULL, value of <HostDrive>/@src
504};
505typedef std::list<AttachedDevice> AttachedDevicesList;
506
507struct StorageController
508{
509 StorageController()
510 : storageBus(StorageBus_IDE),
511 controllerType(StorageControllerType_PIIX3),
512 ulPortCount(2),
513 ulInstance(0),
514 lIDE0MasterEmulationPort(0),
515 lIDE0SlaveEmulationPort(0),
516 lIDE1MasterEmulationPort(0),
517 lIDE1SlaveEmulationPort(0)
518 {}
519
520 com::Utf8Str strName;
521 StorageBus_T storageBus; // _SATA, _SCSI, _IDE
522 StorageControllerType_T controllerType;
523 uint32_t ulPortCount;
524 uint32_t ulInstance;
525
526 // only for when controllerType == StorageControllerType_IntelAhci:
527 int32_t lIDE0MasterEmulationPort,
528 lIDE0SlaveEmulationPort,
529 lIDE1MasterEmulationPort,
530 lIDE1SlaveEmulationPort;
531
532 AttachedDevicesList llAttachedDevices;
533};
534typedef std::list<StorageController> StorageControllersList;
535
536// wrap the list into an extra struct so we can use the struct without
537// having to define the typedef above in headers
538struct Storage
539{
540 StorageControllersList llStorageControllers;
541};
542
543struct Snapshot;
544typedef std::list<Snapshot> SnapshotsList;
545
546struct Snapshot
547{
548 com::Guid uuid;
549 com::Utf8Str strName,
550 strDescription; // optional
551 RTTIMESPEC timestamp;
552
553 com::Utf8Str strStateFile; // for online snapshots only
554
555 Hardware hardware;
556 Storage storage;
557
558 SnapshotsList llChildSnapshots;
559};
560
561
562class MachineConfigFile : public ConfigFileBase
563{
564public:
565 MachineConfigFile(const com::Utf8Str *pstrFilename);
566
567 void readNetworkAdapters(const xml::ElementNode &elmHardware, NetworkAdaptersList &ll);
568 void readCpuIdTree(const xml::ElementNode &elmCpuid, CpuIdLeafsList &ll);
569 void readSerialPorts(const xml::ElementNode &elmUART, SerialPortsList &ll);
570 void readParallelPorts(const xml::ElementNode &elmLPT, ParallelPortsList &ll);
571 void readGuestProperties(const xml::ElementNode &elmGuestProperties, Hardware &hw);
572 void readStorageControllerAttributes(const xml::ElementNode &elmStorageController, StorageController &sctl);
573 void readHardware(const xml::ElementNode &elmHardware, Hardware &hw, Storage &strg);
574 void readHardDiskAttachments_pre1_7(const xml::ElementNode &elmHardDiskAttachments, Storage &strg);
575 void readStorageControllers(const xml::ElementNode &elmStorageControllers, Storage &strg);
576 void readDVDAndFloppies_pre1_9(const xml::ElementNode &elmHardware, Storage &strg);
577 void readSnapshot(const xml::ElementNode &elmSnapshot, Snapshot &snap);
578 void convertOldOSType_pre1_5(com::Utf8Str &str);
579 void readMachine(const xml::ElementNode &elmMachine);
580
581 void writeHardware(xml::ElementNode &elmParent, const Hardware &hw, const Storage &strg);
582 void writeStorageControllers(xml::ElementNode &elmParent, const Storage &st);
583 void writeSnapshot(xml::ElementNode &elmParent, const Snapshot &snap);
584 void bumpSettingsVersionIfNeeded();
585 void write(const com::Utf8Str &strFilename);
586
587 com::Guid uuid;
588 com::Utf8Str strName;
589 bool fNameSync;
590 com::Utf8Str strDescription;
591 com::Utf8Str strOsType;
592 com::Utf8Str strStateFile;
593 com::Guid uuidCurrentSnapshot;
594 com::Utf8Str strSnapshotFolder;
595 bool fTeleporterEnabled;
596 uint32_t uTeleporterPort;
597 com::Utf8Str strTeleporterAddress;
598 com::Utf8Str strTeleporterPassword;
599
600 bool fCurrentStateModified; // optional, default is true
601 RTTIMESPEC timeLastStateChange; // optional, defaults to now
602 bool fAborted; // optional, default is false
603
604 Hardware hardwareMachine;
605 Storage storageMachine;
606
607 ExtraDataItemsMap mapExtraDataItems;
608
609 SnapshotsList llFirstSnapshot; // first snapshot or empty list if there's none
610};
611
612} // namespace settings
613
614
615#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