VirtualBox

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

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

Main: be stricter with bumping settings version to 1.9 when incompatible floppy or DVD settings are detected
  • Property svn:eol-style set to native
  • Property svn:keywords set to Date Revision Author Id
File size: 17.2 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 ulPort(0),
237 authType(VRDPAuthType_Null),
238 ulAuthTimeout(5000),
239 fAllowMultiConnection(false),
240 fReuseSingleConnection(false)
241 {}
242
243 bool fEnabled;
244 uint32_t ulPort;
245 com::Utf8Str strNetAddress;
246 VRDPAuthType_T authType;
247 uint32_t ulAuthTimeout;
248 bool fAllowMultiConnection,
249 fReuseSingleConnection;
250};
251
252struct BIOSSettings
253{
254 BIOSSettings()
255 : fACPIEnabled(true),
256 fIOAPICEnabled(false),
257 fLogoFadeIn(true),
258 fLogoFadeOut(false),
259 ulLogoDisplayTime(0),
260 biosBootMenuMode(BIOSBootMenuMode_MessageAndMenu),
261 fPXEDebugEnabled(false),
262 llTimeOffset(0)
263 {}
264
265 bool fACPIEnabled,
266 fIOAPICEnabled,
267 fLogoFadeIn,
268 fLogoFadeOut;
269 uint32_t ulLogoDisplayTime;
270 com::Utf8Str strLogoImagePath;
271 BIOSBootMenuMode_T biosBootMenuMode;
272 bool fPXEDebugEnabled;
273 int64_t llTimeOffset;
274};
275
276struct USBController
277{
278 USBController()
279 : fEnabled(false),
280 fEnabledEHCI(false)
281 {}
282
283 bool fEnabled;
284 bool fEnabledEHCI;
285 USBDeviceFiltersList llDeviceFilters;
286};
287
288struct NetworkAdapter
289{
290 NetworkAdapter()
291 : ulSlot(0),
292 type(NetworkAdapterType_Am79C970A),
293 fEnabled(false),
294 fCableConnected(false),
295 ulLineSpeed(0),
296 fTraceEnabled(false),
297 mode(NetworkAttachmentType_Null)
298 {}
299
300 uint32_t ulSlot;
301
302 NetworkAdapterType_T type;
303 bool fEnabled;
304 com::Utf8Str strMACAddress;
305 bool fCableConnected;
306 uint32_t ulLineSpeed;
307 bool fTraceEnabled;
308 com::Utf8Str strTraceFile;
309
310 NetworkAttachmentType_T mode;
311 com::Utf8Str strName; // with NAT: nat network or empty;
312 // with bridged: host interface or empty;
313 // otherwise: network name (required)
314};
315typedef std::list<NetworkAdapter> NetworkAdaptersList;
316
317struct SerialPort
318{
319 SerialPort()
320 : fEnabled(false),
321 ulIOBase(0),
322 ulIRQ(0),
323 portMode(PortMode_Disconnected),
324 fServer(false)
325 {}
326
327 uint32_t ulSlot;
328
329 bool fEnabled;
330 uint32_t ulIOBase;
331 uint32_t ulIRQ;
332 PortMode_T portMode;
333 com::Utf8Str strPath;
334 bool fServer;
335};
336typedef std::list<SerialPort> SerialPortsList;
337
338struct ParallelPort
339{
340 ParallelPort()
341 : fEnabled(false),
342 ulIOBase(0),
343 ulIRQ(0)
344 {}
345
346 uint32_t ulSlot;
347
348 bool fEnabled;
349 uint32_t ulIOBase;
350 uint32_t ulIRQ;
351 com::Utf8Str strPath;
352};
353typedef std::list<ParallelPort> ParallelPortsList;
354
355struct AudioAdapter
356{
357 AudioAdapter()
358 : fEnabled(true),
359 controllerType(AudioControllerType_AC97),
360 driverType(AudioDriverType_Null)
361 {}
362
363 bool fEnabled;
364 AudioControllerType_T controllerType;
365 AudioDriverType_T driverType;
366};
367
368struct SharedFolder
369{
370 SharedFolder()
371 : fWritable(false)
372 {}
373
374 com::Utf8Str strName,
375 strHostPath;
376 bool fWritable;
377};
378typedef std::list<SharedFolder> SharedFoldersList;
379
380struct GuestProperty
381{
382 GuestProperty()
383 : timestamp(0)
384 {};
385
386 com::Utf8Str strName,
387 strValue;
388 uint64_t timestamp;
389 com::Utf8Str strFlags;
390};
391typedef std::list<GuestProperty> GuestPropertiesList;
392
393typedef std::map<uint32_t, DeviceType_T> BootOrderMap;
394
395struct Hardware
396{
397 Hardware();
398
399 com::Utf8Str strVersion; // hardware version, optional
400
401 bool fHardwareVirt,
402 fNestedPaging,
403 fVPID,
404 fPAE;
405 uint32_t cCPUs;
406
407 uint32_t ulMemorySizeMB;
408
409 BootOrderMap mapBootOrder; // item 0 has highest priority
410
411 uint32_t ulVRAMSizeMB;
412 uint32_t cMonitors;
413 bool fAccelerate3D,
414 fAccelerate2DVideo; // requires settings version 1.8 (VirtualBox 3.1)
415 FirmwareType_T firmwareType; // requires settings version 1.9 (VirtualBox 3.1)
416
417 VRDPSettings vrdpSettings;
418
419 BIOSSettings biosSettings;
420 USBController usbController;
421 NetworkAdaptersList llNetworkAdapters;
422 SerialPortsList llSerialPorts;
423 ParallelPortsList llParallelPorts;
424 AudioAdapter audioAdapter;
425
426 // technically these two have no business in the hardware section, but for some
427 // clever reason <Hardware> is where they are in the XML....
428 SharedFoldersList llSharedFolders;
429 ClipboardMode_T clipboardMode;
430
431 uint32_t ulMemoryBalloonSize;
432 uint32_t ulStatisticsUpdateInterval;
433
434 GuestPropertiesList llGuestProperties;
435 com::Utf8Str strNotificationPatterns;
436};
437
438/**
439 * A device attached to a storage controller. This can either be a
440 * hard disk or a DVD drive or a floppy drive and also specifies
441 * which medium is "in" the drive; as a result, this is a combination
442 * of the Main IMedium and IMediumAttachment interfaces.
443 */
444struct AttachedDevice
445{
446 AttachedDevice()
447 : deviceType(DeviceType_Null),
448 fPassThrough(false),
449 lPort(0),
450 lDevice(0)
451 {}
452
453 DeviceType_T deviceType; // only HardDisk, DVD or Floppy are allowed
454
455 // DVDs can be in pass-through mode:
456 bool fPassThrough;
457
458 int32_t lPort;
459 int32_t lDevice;
460
461 // if an image file is attached to the device (ISO, RAW, or hard disk image such as VDI),
462 // this is its UUID; it depends on deviceType which media registry this then needs to
463 // be looked up in. If no image file (only permitted for DVDs and floppies), then the UUID is NULL
464 com::Guid uuid;
465
466 // for DVDs and floppies, the attachment can also be a host device:
467 com::Utf8Str strHostDriveSrc; // if != NULL, value of <HostDrive>/@src
468};
469typedef std::list<AttachedDevice> AttachedDevicesList;
470
471struct StorageController
472{
473 StorageController()
474 : storageBus(StorageBus_IDE),
475 controllerType(StorageControllerType_PIIX3),
476 ulPortCount(2),
477 lIDE0MasterEmulationPort(0),
478 lIDE0SlaveEmulationPort(0),
479 lIDE1MasterEmulationPort(0),
480 lIDE1SlaveEmulationPort(0)
481 {}
482
483 com::Utf8Str strName;
484 StorageBus_T storageBus; // _SATA, _SCSI, _IDE
485 StorageControllerType_T controllerType;
486 uint32_t ulPortCount;
487
488 // only for when controllerType == StorageControllerType_IntelAhci:
489 int32_t lIDE0MasterEmulationPort,
490 lIDE0SlaveEmulationPort,
491 lIDE1MasterEmulationPort,
492 lIDE1SlaveEmulationPort;
493
494 AttachedDevicesList llAttachedDevices;
495};
496typedef std::list<StorageController> StorageControllersList;
497
498// wrap the list into an extra struct so we can use the struct without
499// having to define the typedef above in headers
500struct Storage
501{
502 StorageControllersList llStorageControllers;
503};
504
505struct Snapshot;
506typedef std::list<Snapshot> SnapshotsList;
507
508struct Snapshot
509{
510 com::Guid uuid;
511 com::Utf8Str strName,
512 strDescription; // optional
513 RTTIMESPEC timestamp;
514
515 com::Utf8Str strStateFile; // for online snapshots only
516
517 Hardware hardware;
518 Storage storage;
519
520 SnapshotsList llChildSnapshots;
521};
522
523
524class MachineConfigFile : public ConfigFileBase
525{
526public:
527 MachineConfigFile(const com::Utf8Str *pstrFilename);
528
529 void readNetworkAdapters(const xml::ElementNode &elmHardware, NetworkAdaptersList &ll);
530 void readSerialPorts(const xml::ElementNode &elmUART, SerialPortsList &ll);
531 void readParallelPorts(const xml::ElementNode &elmLPT, ParallelPortsList &ll);
532 void readGuestProperties(const xml::ElementNode &elmGuestProperties, Hardware &hw);
533 void readStorageControllerAttributes(const xml::ElementNode &elmStorageController, StorageController &sctl);
534 void readHardware(const xml::ElementNode &elmHardware, Hardware &hw, Storage &strg);
535 void readHardDiskAttachments_pre1_7(const xml::ElementNode &elmHardDiskAttachments, Storage &strg);
536 void readStorageControllers(const xml::ElementNode &elmStorageControllers, Storage &strg);
537 void readDVDAndFloppies_pre1_9(const xml::ElementNode &elmHardware, Storage &strg);
538 void readSnapshot(const xml::ElementNode &elmSnapshot, Snapshot &snap);
539 void convertOldOSType_pre1_5(com::Utf8Str &str);
540 void readMachine(const xml::ElementNode &elmMachine);
541
542 void writeHardware(xml::ElementNode &elmParent, const Hardware &hw, const Storage &strg);
543 void writeStorageControllers(xml::ElementNode &elmParent, const Storage &st);
544 void writeSnapshot(xml::ElementNode &elmParent, const Snapshot &snap);
545 void bumpSettingsVersionIfNeeded();
546 void write(const com::Utf8Str &strFilename);
547
548 com::Guid uuid;
549 com::Utf8Str strName;
550 bool fNameSync;
551 com::Utf8Str strDescription;
552 com::Utf8Str strOsType;
553 com::Utf8Str strStateFile;
554 com::Guid uuidCurrentSnapshot;
555 com::Utf8Str strSnapshotFolder;
556
557 bool fCurrentStateModified; // optional, default is true
558 RTTIMESPEC timeLastStateChange; // optional, defaults to now
559 bool fAborted; // optional, default is false
560
561 Hardware hardwareMachine;
562 Storage storageMachine;
563
564 ExtraDataItemsMap mapExtraDataItems;
565
566 SnapshotsList llFirstSnapshot; // first snapshot or empty list if there's none
567};
568
569} // namespace settings
570
571
572#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