VirtualBox

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

Last change on this file since 23699 was 23643, checked in by vboxsync, 16 years ago

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

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