settings.h@ 37502

Last change on this file since 37502 was 37502, checked in by vboxsync, 13 years ago
Main;Settings: make the settings copyable
Property svn:eol-style set to `native` Property svn:keywords set to `Date Revision Author Id`
File size: 34.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 was all new with VirtualBox 3.1 and allows us
6	* to finally make the XML reader version-independent and read VirtualBox XML files
7	* from earlier and even newer (future) versions without requiring complicated,
8	* tedious and error-prone XSLT conversions.
9	*
10	* It is this file that defines all structures that map VirtualBox global and
11	* machine settings to XML files. These structures are used by the rest of Main,
12	* even though this header file does not require anything else in Main.
13	*
14	* Note: Headers in Main code have been tweaked to only declare the structures
15	* defined here so that this header need only be included from code files that
16	* actually use these structures.
17	*/
18
19	/*
20	* Copyright (C) 2007-2011 Oracle Corporation
21	*
22	* This file is part of VirtualBox Open Source Edition (OSE), as
23	* available from http://www.virtualbox.org. This file is free software;
24	* you can redistribute it and/or modify it under the terms of the GNU
25	* General Public License (GPL) as published by the Free Software
26	* Foundation, in version 2 as it comes in the "COPYING" file of the
27	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
28	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
29	*
30	* The contents of this file may alternatively be used under the terms
31	* of the Common Development and Distribution License Version 1.0
32	* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
33	* VirtualBox OSE distribution, in which case the provisions of the
34	* CDDL are applicable instead of those of the GPL.
35	*
36	* You may elect to license modified versions of this file under the
37	* terms and conditions of either the GPL or the CDDL or both.
38	*/
39
40	#ifndef ___VBox_settings_h
41	#define ___VBox_settings_h
42
43	#include <iprt/time.h>
44
45	#include "VBox/com/VirtualBox.h"
46
47	#include <VBox/com/Guid.h>
48	#include <VBox/com/string.h>
49
50	#include <list>
51	#include <map>
52
53	namespace xml
54	{
55	class ElementNode;
56	}
57
58	namespace settings
59	{
60
61	class ConfigFileError;
62
63	////////////////////////////////////////////////////////////////////////////////
64	//
65	// Structures shared between Machine XML and VirtualBox.xml
66	//
67	////////////////////////////////////////////////////////////////////////////////
68
69	/**
70	* USB device filter definition. This struct is used both in MainConfigFile
71	* (for global USB filters) and MachineConfigFile (for machine filters).
72	*
73	* NOTE: If you add any fields in here, you must update a) the constructor and b)
74	* the operator== which is used by MachineConfigFile::operator==(), or otherwise
75	* your settings might never get saved.
76	*/
77	struct USBDeviceFilter
78	{
79	USBDeviceFilter()
80	: fActive(false),
81	action(USBDeviceFilterAction_Null),
82	ulMaskedInterfaces(0)
83	{}
84
85	bool operator==(const USBDeviceFilter&u) const;
86
87	com::Utf8Str strName;
88	bool fActive;
89	com::Utf8Str strVendorId,
90	strProductId,
91	strRevision,
92	strManufacturer,
93	strProduct,
94	strSerialNumber,
95	strPort;
96	USBDeviceFilterAction_T action; // only used with host USB filters
97	com::Utf8Str strRemote; // irrelevant for host USB objects
98	uint32_t ulMaskedInterfaces; // irrelevant for host USB objects
99	};
100
101	typedef std::map<com::Utf8Str, com::Utf8Str> StringsMap;
102
103	// ExtraDataItem (used by both VirtualBox.xml and machines XML)
104	struct USBDeviceFilter;
105	typedef std::list<USBDeviceFilter> USBDeviceFiltersList;
106
107	struct Medium;
108	typedef std::list<Medium> MediaList;
109
110	/**
111	* NOTE: If you add any fields in here, you must update a) the constructor and b)
112	* the operator== which is used by MachineConfigFile::operator==(), or otherwise
113	* your settings might never get saved.
114	*/
115	struct Medium
116	{
117	com::Guid uuid;
118	com::Utf8Str strLocation;
119	com::Utf8Str strDescription;
120
121	// the following are for hard disks only:
122	com::Utf8Str strFormat;
123	bool fAutoReset; // optional, only for diffs, default is false
124	StringsMap properties;
125	MediumType_T hdType;
126
127	MediaList llChildren; // only used with hard disks
128
129	bool operator==(const Medium &m) const;
130	};
131
132	/**
133	* A media registry. Starting with VirtualBox 3.3, this can appear in both the
134	* VirtualBox.xml file as well as machine XML files with settings version 1.11
135	* or higher, so these lists are now in ConfigFileBase.
136	*
137	* NOTE: If you add any fields in here, you must update a) the constructor and b)
138	* the operator== which is used by MachineConfigFile::operator==(), or otherwise
139	* your settings might never get saved.
140	*/
141	struct MediaRegistry
142	{
143	MediaList llHardDisks,
144	llDvdImages,
145	llFloppyImages;
146
147	bool operator==(const MediaRegistry &m) const;
148	};
149
150	/**
151	* Common base class for both MainConfigFile and MachineConfigFile
152	* which contains some common logic for both.
153	*/
154	class ConfigFileBase
155	{
156	public:
157	bool fileExists();
158
159	void copyBaseFrom(const ConfigFileBase &b);
160
161	protected:
162	ConfigFileBase(const com::Utf8Str *pstrFilename);
163	/* Note: this copy constructor doesn't create a full copy of other, cause
164	* the file based stuff (xml doc) could not be copied. */
165	ConfigFileBase(const ConfigFileBase &other);
166
167	~ConfigFileBase();
168
169	void parseUUID(com::Guid &guid,
170	const com::Utf8Str &strUUID) const;
171	void parseTimestamp(RTTIMESPEC &timestamp,
172	const com::Utf8Str &str) const;
173
174	com::Utf8Str makeString(const RTTIMESPEC &tm);
175
176	void readExtraData(const xml::ElementNode &elmExtraData,
177	StringsMap &map);
178	void readUSBDeviceFilters(const xml::ElementNode &elmDeviceFilters,
179	USBDeviceFiltersList &ll);
180	typedef enum {Error, HardDisk, DVDImage, FloppyImage} MediaType;
181	void readMedium(MediaType t, const xml::ElementNode &elmMedium, MediaList &llMedia);
182	void readMediaRegistry(const xml::ElementNode &elmMediaRegistry, MediaRegistry &mr);
183
184	void setVersionAttribute(xml::ElementNode &elm);
185	void createStubDocument();
186
187	void buildExtraData(xml::ElementNode &elmParent, const StringsMap &me);
188	void buildUSBDeviceFilters(xml::ElementNode &elmParent,
189	const USBDeviceFiltersList &ll,
190	bool fHostMode);
191	void buildMedium(xml::ElementNode &elmMedium,
192	DeviceType_T devType,
193	const Medium &m,
194	uint32_t level);
195	void buildMediaRegistry(xml::ElementNode &elmParent,
196	const MediaRegistry &mr);
197	void clearDocument();
198
199	struct Data;
200	Data *m;
201
202	friend class ConfigFileError;
203	};
204
205	////////////////////////////////////////////////////////////////////////////////
206	//
207	// VirtualBox.xml structures
208	//
209	////////////////////////////////////////////////////////////////////////////////
210
211	struct Host
212	{
213	USBDeviceFiltersList llUSBDeviceFilters;
214	};
215
216	struct SystemProperties
217	{
218	SystemProperties()
219	: ulLogHistoryCount(3)
220	{}
221
222	com::Utf8Str strDefaultMachineFolder;
223	com::Utf8Str strDefaultHardDiskFolder;
224	com::Utf8Str strDefaultHardDiskFormat;
225	com::Utf8Str strVRDEAuthLibrary;
226	com::Utf8Str strWebServiceAuthLibrary;
227	com::Utf8Str strDefaultVRDEExtPack;
228	uint32_t ulLogHistoryCount;
229	};
230
231	struct MachineRegistryEntry
232	{
233	com::Guid uuid;
234	com::Utf8Str strSettingsFile;
235	};
236	typedef std::list<MachineRegistryEntry> MachinesRegistry;
237
238	struct DHCPServer
239	{
240	com::Utf8Str strNetworkName,
241	strIPAddress,
242	strIPNetworkMask,
243	strIPLower,
244	strIPUpper;
245	bool fEnabled;
246	};
247	typedef std::list<DHCPServer> DHCPServersList;
248
249	class MainConfigFile : public ConfigFileBase
250	{
251	public:
252	MainConfigFile(const com::Utf8Str *pstrFilename);
253
254	void readMachineRegistry(const xml::ElementNode &elmMachineRegistry);
255	void readDHCPServers(const xml::ElementNode &elmDHCPServers);
256
257	void write(const com::Utf8Str strFilename);
258
259	Host host;
260	SystemProperties systemProperties;
261	MediaRegistry mediaRegistry;
262	MachinesRegistry llMachines;
263	DHCPServersList llDhcpServers;
264	StringsMap mapExtraDataItems;
265	};
266
267	////////////////////////////////////////////////////////////////////////////////
268	//
269	// Machine XML structures
270	//
271	////////////////////////////////////////////////////////////////////////////////
272
273	/**
274	* NOTE: If you add any fields in here, you must update a) the constructor and b)
275	* the operator== which is used by MachineConfigFile::operator==(), or otherwise
276	* your settings might never get saved.
277	*/
278	struct VRDESettings
279	{
280	VRDESettings()
281	: fEnabled(true),
282	authType(AuthType_Null),
283	ulAuthTimeout(5000),
284	fAllowMultiConnection(false),
285	fReuseSingleConnection(false)
286	{}
287
288	bool operator==(const VRDESettings& v) const;
289
290	bool fEnabled;
291	AuthType_T authType;
292	uint32_t ulAuthTimeout;
293	com::Utf8Str strAuthLibrary;
294	bool fAllowMultiConnection,
295	fReuseSingleConnection;
296	com::Utf8Str strVrdeExtPack;
297	StringsMap mapProperties;
298	};
299
300	/**
301	* NOTE: If you add any fields in here, you must update a) the constructor and b)
302	* the operator== which is used by MachineConfigFile::operator==(), or otherwise
303	* your settings might never get saved.
304	*/
305	struct BIOSSettings
306	{
307	BIOSSettings()
308	: fACPIEnabled(true),
309	fIOAPICEnabled(false),
310	fLogoFadeIn(true),
311	fLogoFadeOut(true),
312	ulLogoDisplayTime(0),
313	biosBootMenuMode(BIOSBootMenuMode_MessageAndMenu),
314	fPXEDebugEnabled(false),
315	llTimeOffset(0)
316	{}
317
318	bool operator==(const BIOSSettings &d) const;
319
320	bool fACPIEnabled,
321	fIOAPICEnabled,
322	fLogoFadeIn,
323	fLogoFadeOut;
324	uint32_t ulLogoDisplayTime;
325	com::Utf8Str strLogoImagePath;
326	BIOSBootMenuMode_T biosBootMenuMode;
327	bool fPXEDebugEnabled;
328	int64_t llTimeOffset;
329	};
330
331	/**
332	* NOTE: If you add any fields in here, you must update a) the constructor and b)
333	* the operator== which is used by MachineConfigFile::operator==(), or otherwise
334	* your settings might never get saved.
335	*/
336	struct USBController
337	{
338	USBController()
339	: fEnabled(false),
340	fEnabledEHCI(false)
341	{}
342
343	bool operator==(const USBController &u) const;
344
345	bool fEnabled;
346	bool fEnabledEHCI;
347	USBDeviceFiltersList llDeviceFilters;
348	};
349
350	struct NATRule
351	{
352	NATRule(): proto(NATProtocol_TCP),
353	u16HostPort(0),
354	u16GuestPort(0){}
355	com::Utf8Str strName;
356	NATProtocol_T proto;
357	uint16_t u16HostPort;
358	com::Utf8Str strHostIP;
359	uint16_t u16GuestPort;
360	com::Utf8Str strGuestIP;
361	bool operator==(const NATRule &r) const
362	{
363	return strName == r.strName
364	&& proto == r.proto
365	&& u16HostPort == r.u16HostPort
366	&& strHostIP == r.strHostIP
367	&& u16GuestPort == r.u16GuestPort
368	&& strGuestIP == r.strGuestIP;
369	}
370	};
371	typedef std::list<NATRule> NATRuleList;
372
373	struct NAT
374	{
375	NAT() : u32Mtu(0),
376	u32SockRcv(0),
377	u32SockSnd(0),
378	u32TcpRcv(0),
379	u32TcpSnd(0),
380	fDnsPassDomain(true), /* historically this value is true */
381	fDnsProxy(false),
382	fDnsUseHostResolver(false),
383	fAliasLog(false),
384	fAliasProxyOnly(false),
385	fAliasUseSamePorts(false)
386	{}
387
388	com::Utf8Str strNetwork;
389	com::Utf8Str strBindIP;
390	uint32_t u32Mtu;
391	uint32_t u32SockRcv;
392	uint32_t u32SockSnd;
393	uint32_t u32TcpRcv;
394	uint32_t u32TcpSnd;
395	com::Utf8Str strTftpPrefix;
396	com::Utf8Str strTftpBootFile;
397	com::Utf8Str strTftpNextServer;
398	bool fDnsPassDomain;
399	bool fDnsProxy;
400	bool fDnsUseHostResolver;
401	bool fAliasLog;
402	bool fAliasProxyOnly;
403	bool fAliasUseSamePorts;
404	NATRuleList llRules;
405	bool operator==(const NAT &n) const
406	{
407	return strNetwork == n.strNetwork
408	&& strBindIP == n.strBindIP
409	&& u32Mtu == n.u32Mtu
410	&& u32SockRcv == n.u32SockRcv
411	&& u32SockSnd == n.u32SockSnd
412	&& u32TcpSnd == n.u32TcpSnd
413	&& u32TcpRcv == n.u32TcpRcv
414	&& strTftpPrefix == n.strTftpPrefix
415	&& strTftpBootFile == n.strTftpBootFile
416	&& strTftpNextServer == n.strTftpNextServer
417	&& fDnsPassDomain == n.fDnsPassDomain
418	&& fDnsProxy == n.fDnsProxy
419	&& fDnsUseHostResolver == n.fDnsUseHostResolver
420	&& fAliasLog == n.fAliasLog
421	&& fAliasProxyOnly == n.fAliasProxyOnly
422	&& fAliasUseSamePorts == n.fAliasUseSamePorts
423	&& llRules == n.llRules;
424	}
425	};
426	/**
427	* NOTE: If you add any fields in here, you must update a) the constructor and b)
428	* the operator== which is used by MachineConfigFile::operator==(), or otherwise
429	* your settings might never get saved.
430	*/
431	struct NetworkAdapter
432	{
433	NetworkAdapter()
434	: ulSlot(0),
435	type(NetworkAdapterType_Am79C970A),
436	fEnabled(false),
437	fCableConnected(false),
438	ulLineSpeed(0),
439	enmPromiscModePolicy(NetworkAdapterPromiscModePolicy_Deny),
440	fTraceEnabled(false),
441	mode(NetworkAttachmentType_Null),
442	ulBootPriority(0)
443	{}
444
445	bool operator==(const NetworkAdapter &n) const;
446
447	uint32_t ulSlot;
448
449	NetworkAdapterType_T type;
450	bool fEnabled;
451	com::Utf8Str strMACAddress;
452	bool fCableConnected;
453	uint32_t ulLineSpeed;
454	NetworkAdapterPromiscModePolicy_T enmPromiscModePolicy;
455	bool fTraceEnabled;
456	com::Utf8Str strTraceFile;
457
458	NetworkAttachmentType_T mode;
459	NAT nat;
460	com::Utf8Str strBridgedName;
461	com::Utf8Str strHostOnlyName;
462	com::Utf8Str strInternalNetworkName;
463	com::Utf8Str strGenericDriver;
464	StringsMap genericProperties;
465	uint32_t ulBootPriority;
466	com::Utf8Str strBandwidthGroup; // requires settings version 1.13 (VirtualBox 4.2)
467	};
468	typedef std::list<NetworkAdapter> NetworkAdaptersList;
469
470	/**
471	* NOTE: If you add any fields in here, you must update a) the constructor and b)
472	* the operator== which is used by MachineConfigFile::operator==(), or otherwise
473	* your settings might never get saved.
474	*/
475	struct SerialPort
476	{
477	SerialPort()
478	: ulSlot(0),
479	fEnabled(false),
480	ulIOBase(0x3f8),
481	ulIRQ(4),
482	portMode(PortMode_Disconnected),
483	fServer(false)
484	{}
485
486	bool operator==(const SerialPort &n) const;
487
488	uint32_t ulSlot;
489
490	bool fEnabled;
491	uint32_t ulIOBase;
492	uint32_t ulIRQ;
493	PortMode_T portMode;
494	com::Utf8Str strPath;
495	bool fServer;
496	};
497	typedef std::list<SerialPort> SerialPortsList;
498
499	/**
500	* NOTE: If you add any fields in here, you must update a) the constructor and b)
501	* the operator== which is used by MachineConfigFile::operator==(), or otherwise
502	* your settings might never get saved.
503	*/
504	struct ParallelPort
505	{
506	ParallelPort()
507	: ulSlot(0),
508	fEnabled(false),
509	ulIOBase(0x378),
510	ulIRQ(4)
511	{}
512
513	bool operator==(const ParallelPort &d) const;
514
515	uint32_t ulSlot;
516
517	bool fEnabled;
518	uint32_t ulIOBase;
519	uint32_t ulIRQ;
520	com::Utf8Str strPath;
521	};
522	typedef std::list<ParallelPort> ParallelPortsList;
523
524	/**
525	* NOTE: If you add any fields in here, you must update a) the constructor and b)
526	* the operator== which is used by MachineConfigFile::operator==(), or otherwise
527	* your settings might never get saved.
528	*/
529	struct AudioAdapter
530	{
531	AudioAdapter()
532	: fEnabled(true),
533	controllerType(AudioControllerType_AC97),
534	driverType(AudioDriverType_Null)
535	{}
536
537	bool operator==(const AudioAdapter &a) const
538	{
539	return (this == &a)
540	\|\| ( (fEnabled == a.fEnabled)
541	&& (controllerType == a.controllerType)
542	&& (driverType == a.driverType)
543	);
544	}
545
546	bool fEnabled;
547	AudioControllerType_T controllerType;
548	AudioDriverType_T driverType;
549	};
550
551	/**
552	* NOTE: If you add any fields in here, you must update a) the constructor and b)
553	* the operator== which is used by MachineConfigFile::operator==(), or otherwise
554	* your settings might never get saved.
555	*/
556	struct SharedFolder
557	{
558	SharedFolder()
559	: fWritable(false)
560	, fAutoMount(false)
561	{}
562
563	bool operator==(const SharedFolder &a) const;
564
565	com::Utf8Str strName,
566	strHostPath;
567	bool fWritable;
568	bool fAutoMount;
569	};
570	typedef std::list<SharedFolder> SharedFoldersList;
571
572	/**
573	* NOTE: If you add any fields in here, you must update a) the constructor and b)
574	* the operator== which is used by MachineConfigFile::operator==(), or otherwise
575	* your settings might never get saved.
576	*/
577	struct GuestProperty
578	{
579	GuestProperty()
580	: timestamp(0)
581	{};
582
583	bool operator==(const GuestProperty &g) const;
584
585	com::Utf8Str strName,
586	strValue;
587	uint64_t timestamp;
588	com::Utf8Str strFlags;
589	};
590	typedef std::list<GuestProperty> GuestPropertiesList;
591
592	typedef std::map<uint32_t, DeviceType_T> BootOrderMap;
593
594	/**
595	* NOTE: If you add any fields in here, you must update a) the constructor and b)
596	* the operator== which is used by MachineConfigFile::operator==(), or otherwise
597	* your settings might never get saved.
598	*/
599	struct CpuIdLeaf
600	{
601	CpuIdLeaf()
602	: ulId(UINT32_MAX),
603	ulEax(0),
604	ulEbx(0),
605	ulEcx(0),
606	ulEdx(0)
607	{}
608
609	bool operator==(const CpuIdLeaf &c) const
610	{
611	return ( (this == &c)
612	\|\| ( (ulId == c.ulId)
613	&& (ulEax == c.ulEax)
614	&& (ulEbx == c.ulEbx)
615	&& (ulEcx == c.ulEcx)
616	&& (ulEdx == c.ulEdx)
617	)
618	);
619	}
620
621	uint32_t ulId;
622	uint32_t ulEax;
623	uint32_t ulEbx;
624	uint32_t ulEcx;
625	uint32_t ulEdx;
626	};
627	typedef std::list<CpuIdLeaf> CpuIdLeafsList;
628
629	/**
630	* NOTE: If you add any fields in here, you must update a) the constructor and b)
631	* the operator== which is used by MachineConfigFile::operator==(), or otherwise
632	* your settings might never get saved.
633	*/
634	struct Cpu
635	{
636	Cpu()
637	: ulId(UINT32_MAX)
638	{}
639
640	bool operator==(const Cpu &c) const
641	{
642	return (ulId == c.ulId);
643	}
644
645	uint32_t ulId;
646	};
647	typedef std::list<Cpu> CpuList;
648
649	/**
650	* NOTE: If you add any fields in here, you must update a) the constructor and b)
651	* the operator== which is used by MachineConfigFile::operator==(), or otherwise
652	* your settings might never get saved.
653	*/
654	struct BandwidthGroup
655	{
656	BandwidthGroup()
657	: cMaxMbPerSec(0),
658	enmType(BandwidthGroupType_Null)
659	{}
660
661	bool operator==(const BandwidthGroup &i) const
662	{
663	return ( (strName == i.strName)
664	&& (cMaxMbPerSec == i.cMaxMbPerSec)
665	&& (enmType == i.enmType));
666	}
667
668	com::Utf8Str strName;
669	uint32_t cMaxMbPerSec;
670	BandwidthGroupType_T enmType;
671	};
672	typedef std::list<BandwidthGroup> BandwidthGroupList;
673
674	/**
675	* NOTE: If you add any fields in here, you must update a) the constructor and b)
676	* the operator== which is used by MachineConfigFile::operator==(), or otherwise
677	* your settings might never get saved.
678	*/
679	struct IoSettings
680	{
681	IoSettings();
682
683	bool operator==(const IoSettings &i) const
684	{
685	return ( (fIoCacheEnabled == i.fIoCacheEnabled)
686	&& (ulIoCacheSize == i.ulIoCacheSize)
687	&& (llBandwidthGroups == i.llBandwidthGroups));
688	}
689
690	bool fIoCacheEnabled;
691	uint32_t ulIoCacheSize;
692	BandwidthGroupList llBandwidthGroups;
693	};
694
695	/**
696	* NOTE: If you add any fields in here, you must update a) the constructor and b)
697	* the operator== which is used by MachineConfigFile::operator==(), or otherwise
698	* your settings might never get saved.
699	*/
700	struct HostPciDeviceAttachment
701	{
702	HostPciDeviceAttachment()
703	: uHostAddress(0),
704	uGuestAddress(0)
705	{}
706
707	bool operator==(const HostPciDeviceAttachment &a) const
708	{
709	return ( (uHostAddress == a.uHostAddress)
710	&& (uGuestAddress == a.uGuestAddress)
711	&& (strDeviceName == a.strDeviceName)
712	);
713	}
714
715	com::Utf8Str strDeviceName;
716	uint32_t uHostAddress;
717	uint32_t uGuestAddress;
718	};
719	typedef std::list<HostPciDeviceAttachment> HostPciDeviceAttachmentList;
720
721	/**
722	* Representation of Machine hardware; this is used in the MachineConfigFile.hardwareMachine
723	* field.
724	*
725	* NOTE: If you add any fields in here, you must update a) the constructor and b)
726	* the operator== which is used by MachineConfigFile::operator==(), or otherwise
727	* your settings might never get saved.
728	*/
729	struct Hardware
730	{
731	Hardware();
732
733	bool operator==(const Hardware&) const;
734
735	com::Utf8Str strVersion; // hardware version, optional
736	com::Guid uuid; // hardware uuid, optional (null).
737
738	bool fHardwareVirt,
739	fHardwareVirtExclusive,
740	fNestedPaging,
741	fLargePages,
742	fVPID,
743	fHardwareVirtForce,
744	fSyntheticCpu,
745	fPAE;
746	uint32_t cCPUs;
747	bool fCpuHotPlug; // requires settings version 1.10 (VirtualBox 3.2)
748	CpuList llCpus; // requires settings version 1.10 (VirtualBox 3.2)
749	bool fHpetEnabled; // requires settings version 1.10 (VirtualBox 3.2)
750	uint32_t ulCpuExecutionCap; // requires settings version 1.11 (VirtualBox 3.3)
751
752	CpuIdLeafsList llCpuIdLeafs;
753
754	uint32_t ulMemorySizeMB;
755
756	BootOrderMap mapBootOrder; // item 0 has highest priority
757
758	uint32_t ulVRAMSizeMB;
759	uint32_t cMonitors;
760	bool fAccelerate3D,
761	fAccelerate2DVideo; // requires settings version 1.8 (VirtualBox 3.1)
762	FirmwareType_T firmwareType; // requires settings version 1.9 (VirtualBox 3.1)
763
764	PointingHidType_T pointingHidType; // requires settings version 1.10 (VirtualBox 3.2)
765	KeyboardHidType_T keyboardHidType; // requires settings version 1.10 (VirtualBox 3.2)
766
767	ChipsetType_T chipsetType; // requires settings version 1.11 (VirtualBox 4.0)
768
769	VRDESettings vrdeSettings;
770
771	BIOSSettings biosSettings;
772	USBController usbController;
773	NetworkAdaptersList llNetworkAdapters;
774	SerialPortsList llSerialPorts;
775	ParallelPortsList llParallelPorts;
776	AudioAdapter audioAdapter;
777
778	// technically these two have no business in the hardware section, but for some
779	// clever reason <Hardware> is where they are in the XML....
780	SharedFoldersList llSharedFolders;
781	ClipboardMode_T clipboardMode;
782
783	uint32_t ulMemoryBalloonSize;
784	bool fPageFusionEnabled;
785
786	GuestPropertiesList llGuestProperties;
787	com::Utf8Str strNotificationPatterns;
788
789	IoSettings ioSettings; // requires settings version 1.10 (VirtualBox 3.2)
790	HostPciDeviceAttachmentList pciAttachments; // requires settings version 1.12 (VirtualBox 4.1)
791	};
792
793	/**
794	* A device attached to a storage controller. This can either be a
795	* hard disk or a DVD drive or a floppy drive and also specifies
796	* which medium is "in" the drive; as a result, this is a combination
797	* of the Main IMedium and IMediumAttachment interfaces.
798	*
799	* NOTE: If you add any fields in here, you must update a) the constructor and b)
800	* the operator== which is used by MachineConfigFile::operator==(), or otherwise
801	* your settings might never get saved.
802	*/
803	struct AttachedDevice
804	{
805	AttachedDevice()
806	: deviceType(DeviceType_Null),
807	fPassThrough(false),
808	lPort(0),
809	lDevice(0)
810	{}
811
812	bool operator==(const AttachedDevice &a) const;
813
814	DeviceType_T deviceType; // only HardDisk, DVD or Floppy are allowed
815
816	// DVDs can be in pass-through mode:
817	bool fPassThrough;
818
819	int32_t lPort;
820	int32_t lDevice;
821
822	// if an image file is attached to the device (ISO, RAW, or hard disk image such as VDI),
823	// this is its UUID; it depends on deviceType which media registry this then needs to
824	// be looked up in. If no image file (only permitted for DVDs and floppies), then the UUID is NULL
825	com::Guid uuid;
826
827	// for DVDs and floppies, the attachment can also be a host device:
828	com::Utf8Str strHostDriveSrc; // if != NULL, value of <HostDrive>/@src
829
830	// Bandwidth group the device is attached to.
831	com::Utf8Str strBwGroup;
832	};
833	typedef std::list<AttachedDevice> AttachedDevicesList;
834
835	/**
836	* NOTE: If you add any fields in here, you must update a) the constructor and b)
837	* the operator== which is used by MachineConfigFile::operator==(), or otherwise
838	* your settings might never get saved.
839	*/
840	struct StorageController
841	{
842	StorageController()
843	: storageBus(StorageBus_IDE),
844	controllerType(StorageControllerType_PIIX3),
845	ulPortCount(2),
846	ulInstance(0),
847	fUseHostIOCache(true),
848	fBootable(true),
849	lIDE0MasterEmulationPort(0),
850	lIDE0SlaveEmulationPort(0),
851	lIDE1MasterEmulationPort(0),
852	lIDE1SlaveEmulationPort(0)
853	{}
854
855	bool operator==(const StorageController &s) const;
856
857	com::Utf8Str strName;
858	StorageBus_T storageBus; // _SATA, _SCSI, _IDE, _SAS
859	StorageControllerType_T controllerType;
860	uint32_t ulPortCount;
861	uint32_t ulInstance;
862	bool fUseHostIOCache;
863	bool fBootable;
864
865	// only for when controllerType == StorageControllerType_IntelAhci:
866	int32_t lIDE0MasterEmulationPort,
867	lIDE0SlaveEmulationPort,
868	lIDE1MasterEmulationPort,
869	lIDE1SlaveEmulationPort;
870
871	AttachedDevicesList llAttachedDevices;
872	};
873	typedef std::list<StorageController> StorageControllersList;
874
875	/**
876	* We wrap the storage controllers list into an extra struct so we can
877	* use an undefined struct without needing std::list<> in all the headers.
878	*
879	* NOTE: If you add any fields in here, you must update a) the constructor and b)
880	* the operator== which is used by MachineConfigFile::operator==(), or otherwise
881	* your settings might never get saved.
882	*/
883	struct Storage
884	{
885	bool operator==(const Storage &s) const;
886
887	StorageControllersList llStorageControllers;
888	};
889
890	struct Snapshot;
891	typedef std::list<Snapshot> SnapshotsList;
892
893	/**
894	* NOTE: If you add any fields in here, you must update a) the constructor and b)
895	* the operator== which is used by MachineConfigFile::operator==(), or otherwise
896	* your settings might never get saved.
897	*/
898	struct Snapshot
899	{
900	bool operator==(const Snapshot &s) const;
901
902	com::Guid uuid;
903	com::Utf8Str strName,
904	strDescription; // optional
905	RTTIMESPEC timestamp;
906
907	com::Utf8Str strStateFile; // for online snapshots only
908
909	Hardware hardware;
910	Storage storage;
911
912	SnapshotsList llChildSnapshots;
913	};
914
915	struct MachineUserData
916	{
917	MachineUserData()
918	: fNameSync(true),
919	fTeleporterEnabled(false),
920	uTeleporterPort(0),
921	enmFaultToleranceState(FaultToleranceState_Inactive),
922	uFaultTolerancePort(0),
923	uFaultToleranceInterval(0),
924	fRTCUseUTC(false)
925	{ }
926
927	bool operator==(const MachineUserData &c) const
928	{
929	return (strName == c.strName)
930	&& (fNameSync == c.fNameSync)
931	&& (strDescription == c.strDescription)
932	&& (strOsType == c.strOsType)
933	&& (strSnapshotFolder == c.strSnapshotFolder)
934	&& (fTeleporterEnabled == c.fTeleporterEnabled)
935	&& (uTeleporterPort == c.uTeleporterPort)
936	&& (strTeleporterAddress == c.strTeleporterAddress)
937	&& (strTeleporterPassword == c.strTeleporterPassword)
938	&& (enmFaultToleranceState == c.enmFaultToleranceState)
939	&& (uFaultTolerancePort == c.uFaultTolerancePort)
940	&& (uFaultToleranceInterval == c.uFaultToleranceInterval)
941	&& (strFaultToleranceAddress == c.strFaultToleranceAddress)
942	&& (strFaultTolerancePassword == c.strFaultTolerancePassword)
943	&& (fRTCUseUTC == c.fRTCUseUTC);
944	}
945
946	com::Utf8Str strName;
947	bool fNameSync;
948	com::Utf8Str strDescription;
949	com::Utf8Str strOsType;
950	com::Utf8Str strSnapshotFolder;
951	bool fTeleporterEnabled;
952	uint32_t uTeleporterPort;
953	com::Utf8Str strTeleporterAddress;
954	com::Utf8Str strTeleporterPassword;
955	FaultToleranceState_T enmFaultToleranceState;
956	uint32_t uFaultTolerancePort;
957	com::Utf8Str strFaultToleranceAddress;
958	com::Utf8Str strFaultTolerancePassword;
959	uint32_t uFaultToleranceInterval;
960	bool fRTCUseUTC;
961	};
962
963	/**
964	* MachineConfigFile represents an XML machine configuration. All the machine settings
965	* that go out to the XML (or are read from it) are in here.
966	*
967	* NOTE: If you add any fields in here, you must update a) the constructor and b)
968	* the operator== which is used by Machine::saveSettings(), or otherwise your settings
969	* might never get saved.
970	*/
971	class MachineConfigFile : public ConfigFileBase
972	{
973	public:
974	com::Guid uuid;
975
976	MachineUserData machineUserData;
977
978	com::Utf8Str strStateFile;
979	bool fCurrentStateModified; // optional, default is true
980	RTTIMESPEC timeLastStateChange; // optional, defaults to now
981	bool fAborted; // optional, default is false
982
983	com::Guid uuidCurrentSnapshot;
984
985	Hardware hardwareMachine;
986	Storage storageMachine;
987	MediaRegistry mediaRegistry;
988
989	StringsMap mapExtraDataItems;
990
991	SnapshotsList llFirstSnapshot; // first snapshot or empty list if there's none
992
993	MachineConfigFile(const com::Utf8Str *pstrFilename);
994
995	bool operator==(const MachineConfigFile &m) const;
996
997	bool canHaveOwnMediaRegistry() const;
998
999	void importMachineXML(const xml::ElementNode &elmMachine);
1000
1001	void write(const com::Utf8Str &strFilename);
1002
1003	enum
1004	{
1005	BuildMachineXML_IncludeSnapshots = 0x01,
1006	BuildMachineXML_WriteVboxVersionAttribute = 0x02,
1007	BuildMachineXML_SkipRemovableMedia = 0x04,
1008	BuildMachineXML_MediaRegistry = 0x08,
1009	BuildMachineXML_SuppressSavedState = 0x10
1010	};
1011	void buildMachineXML(xml::ElementNode &elmMachine,
1012	uint32_t fl,
1013	std::list<xml::ElementNode> pllElementsWithUuidAttributes);
1014
1015	static bool isAudioDriverAllowedOnThisHost(AudioDriverType_T drv);
1016	static AudioDriverType_T getHostDefaultAudioDriver();
1017
1018	private:
1019	void readNetworkAdapters(const xml::ElementNode &elmHardware, NetworkAdaptersList &ll);
1020	void readAttachedNetworkMode(const xml::ElementNode &pelmMode, bool fEnabled, NetworkAdapter &nic);
1021	void readCpuIdTree(const xml::ElementNode &elmCpuid, CpuIdLeafsList &ll);
1022	void readCpuTree(const xml::ElementNode &elmCpu, CpuList &ll);
1023	void readSerialPorts(const xml::ElementNode &elmUART, SerialPortsList &ll);
1024	void readParallelPorts(const xml::ElementNode &elmLPT, ParallelPortsList &ll);
1025	void readAudioAdapter(const xml::ElementNode &elmAudioAdapter, AudioAdapter &aa);
1026	void readGuestProperties(const xml::ElementNode &elmGuestProperties, Hardware &hw);
1027	void readStorageControllerAttributes(const xml::ElementNode &elmStorageController, StorageController &sctl);
1028	void readHardware(const xml::ElementNode &elmHardware, Hardware &hw, Storage &strg);
1029	void readHardDiskAttachments_pre1_7(const xml::ElementNode &elmHardDiskAttachments, Storage &strg);
1030	void readStorageControllers(const xml::ElementNode &elmStorageControllers, Storage &strg);
1031	void readDVDAndFloppies_pre1_9(const xml::ElementNode &elmHardware, Storage &strg);
1032	void readSnapshot(const xml::ElementNode &elmSnapshot, Snapshot &snap);
1033	void convertOldOSType_pre1_5(com::Utf8Str &str);
1034	void readMachine(const xml::ElementNode &elmMachine);
1035
1036	void buildHardwareXML(xml::ElementNode &elmParent, const Hardware &hw, const Storage &strg);
1037	void buildNetworkXML(NetworkAttachmentType_T mode, xml::ElementNode &elmParent, bool fEnabled, const NetworkAdapter &nic);
1038	void buildStorageControllersXML(xml::ElementNode &elmParent,
1039	const Storage &st,
1040	bool fSkipRemovableMedia,
1041	std::list<xml::ElementNode> pllElementsWithUuidAttributes);
1042	void buildSnapshotXML(xml::ElementNode &elmParent, const Snapshot &snap);
1043
1044	void bumpSettingsVersionIfNeeded();
1045	};
1046
1047	} // namespace settings
1048
1049
1050	#endif /* ___VBox_settings_h */

Note: See TracBrowser for help on using the repository browser.

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

Download in other formats: