VMMDevState.h@ 63495

Last change on this file since 63495 was 62503, checked in by vboxsync, 8 years ago
(C) 2016
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 12.8 KB

Line
1	/* $Id: VMMDevState.h 62503 2016-07-22 19:09:20Z vboxsync $ */
2	/** @file
3	* VMMDev - Guest <-> VMM/Host communication device, internal header.
4	*/
5
6	/*
7	* Copyright (C) 2006-2016 Oracle Corporation
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.virtualbox.org. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*/
17
18	#ifndef ___VMMDev_VMMDevState_h
19	#define ___VMMDev_VMMDevState_h
20
21	#include <VBox/VMMDev.h>
22	#include <VBox/vmm/pdmdev.h>
23	#include <VBox/vmm/pdmifs.h>
24	#ifndef VBOX_WITHOUT_TESTING_FEATURES
25	# include <iprt/test.h>
26	# include <VBox/VMMDevTesting.h>
27	#endif
28
29	#define VMMDEV_WITH_ALT_TIMESYNC
30
31	typedef struct DISPLAYCHANGEINFO
32	{
33	uint32_t xres;
34	uint32_t yres;
35	uint32_t bpp;
36	uint32_t display;
37	int32_t xOrigin;
38	int32_t yOrigin;
39	bool fEnabled;
40	bool fChangeOrigin;
41	} DISPLAYCHANGEINFO;
42
43	typedef struct DISPLAYCHANGEREQUEST
44	{
45	bool fPending;
46	bool afAlignment[3];
47	DISPLAYCHANGEINFO displayChangeRequest;
48	DISPLAYCHANGEINFO lastReadDisplayChangeRequest;
49	} DISPLAYCHANGEREQUEST;
50
51	typedef struct DISPLAYCHANGEDATA
52	{
53	/* Which monitor is being reported to the guest. */
54	int iCurrentMonitor;
55
56	/** true if the guest responded to VMMDEV_EVENT_DISPLAY_CHANGE_REQUEST at least once */
57	bool fGuestSentChangeEventAck;
58	bool afAlignment[3];
59
60	DISPLAYCHANGEREQUEST aRequests[64]; /// @todo maxMonitors
61	} DISPLAYCHANGEDATA;
62
63
64	/**
65	* Credentials for automatic guest logon and host configured logon (?).
66	*
67	* This is not stored in the same block as the instance data in order to make it
68	* harder to access.
69	*/
70	typedef struct VMMDEVCREDS
71	{
72	/** credentials for guest logon purposes */
73	struct
74	{
75	char szUserName[VMMDEV_CREDENTIALS_SZ_SIZE];
76	char szPassword[VMMDEV_CREDENTIALS_SZ_SIZE];
77	char szDomain[VMMDEV_CREDENTIALS_SZ_SIZE];
78	bool fAllowInteractiveLogon;
79	} Logon;
80
81	/** credentials for verification by guest */
82	struct
83	{
84	char szUserName[VMMDEV_CREDENTIALS_SZ_SIZE];
85	char szPassword[VMMDEV_CREDENTIALS_SZ_SIZE];
86	char szDomain[VMMDEV_CREDENTIALS_SZ_SIZE];
87	} Judge;
88	} VMMDEVCREDS;
89
90
91	/**
92	* Facility status entry.
93	*/
94	typedef struct VMMDEVFACILITYSTATUSENTRY
95	{
96	/** The facility (may contain values other than the defined ones). */
97	VBoxGuestFacilityType enmFacility;
98	/** The status (may contain values other than the defined ones). */
99	VBoxGuestFacilityStatus enmStatus;
100	/** Whether this entry is fixed and cannot be reused when inactive. */
101	bool fFixed;
102	/** Explicit alignment padding / reserved for future use. MBZ. */
103	bool afPadding[3];
104	/** The facility flags (yet to be defined). */
105	uint32_t fFlags;
106	/** Last update timestamp. */
107	RTTIMESPEC TimeSpecTS;
108	} VMMDEVFACILITYSTATUSENTRY;
109	/** Pointer to a facility status entry. */
110	typedef VMMDEVFACILITYSTATUSENTRY *PVMMDEVFACILITYSTATUSENTRY;
111
112
113	/** device structure containing all state information */
114	typedef struct VMMDevState
115	{
116	/** The PCI device structure. */
117	PCIDevice PciDev;
118	/** The critical section for this device.
119	* @remarks We use this rather than the default one, it's simpler with all
120	* the driver interfaces where we have to waste time digging out the
121	* PDMDEVINS structure. */
122	PDMCRITSECT CritSect;
123
124	/** hypervisor address space size */
125	uint32_t hypervisorSize;
126
127	/** mouse capabilities of host and guest */
128	uint32_t mouseCapabilities;
129	/** absolute mouse position in pixels */
130	int32_t mouseXAbs;
131	int32_t mouseYAbs;
132	/** Does the guest currently want the host pointer to be shown? */
133	uint32_t fHostCursorRequested;
134
135	/** Alignment padding. */
136	uint32_t u32Alignment0;
137
138	/** Pointer to device instance. */
139	PPDMDEVINSR3 pDevIns;
140	/** LUN\#0 + Status: VMMDev port base interface. */
141	PDMIBASE IBase;
142	/** LUN\#0: VMMDev port interface. */
143	PDMIVMMDEVPORT IPort;
144	#ifdef VBOX_WITH_HGCM
145	/** LUN\#0: HGCM port interface. */
146	PDMIHGCMPORT IHGCMPort;
147	#endif
148	/** Pointer to base interface of the driver. */
149	R3PTRTYPE(PPDMIBASE) pDrvBase;
150	/** VMMDev connector interface */
151	R3PTRTYPE(PPDMIVMMDEVCONNECTOR) pDrv;
152	#ifdef VBOX_WITH_HGCM
153	/** HGCM connector interface */
154	R3PTRTYPE(PPDMIHGCMCONNECTOR) pHGCMDrv;
155	#endif
156	/** Alignment padding. */
157	RTR3PTR PtrR3Alignment1;
158	/** message buffer for backdoor logging. */
159	char szMsg[512];
160	/** message buffer index. */
161	uint32_t iMsg;
162	/** Alignment padding. */
163	uint32_t u32Alignment2;
164
165	/** IRQ number assigned to the device */
166	uint32_t irq;
167	/** Current host side event flags */
168	uint32_t u32HostEventFlags;
169	/** Mask of events guest is interested in.
170	* @note The HGCM events are enabled automatically by the VMMDev device when
171	* guest issues HGCM commands. */
172	uint32_t u32GuestFilterMask;
173	/** Delayed mask of guest events */
174	uint32_t u32NewGuestFilterMask;
175	/** Flag whether u32NewGuestFilterMask is valid */
176	bool fNewGuestFilterMask;
177	/** Alignment padding. */
178	bool afAlignment3[3];
179
180	/** GC physical address of VMMDev RAM area */
181	RTGCPHYS32 GCPhysVMMDevRAM;
182	/** R3 pointer to VMMDev RAM area */
183	R3PTRTYPE(VMMDevMemory *) pVMMDevRAMR3;
184
185	/** R3 pointer to VMMDev Heap RAM area
186	*/
187	R3PTRTYPE(VMMDevMemory *) pVMMDevHeapR3;
188	/** GC physical address of VMMDev Heap RAM area */
189	RTGCPHYS32 GCPhysVMMDevHeap;
190
191	/** Information reported by guest via VMMDevReportGuestInfo generic request.
192	* Until this information is reported the VMMDev refuses any other requests.
193	*/
194	VBoxGuestInfo guestInfo;
195	/** Information report \#2, chewed a litte. */
196	struct
197	{
198	uint32_t uFullVersion; /*< non-zero if info is present. /
199	uint32_t uRevision;
200	uint32_t fFeatures;
201	char szName[128];
202	} guestInfo2;
203
204	/** Array of guest facility statuses. */
205	VMMDEVFACILITYSTATUSENTRY aFacilityStatuses[32];
206	/** The number of valid entries in the facility status array. */
207	uint32_t cFacilityStatuses;
208
209	/** Information reported by guest via VMMDevReportGuestCapabilities. */
210	uint32_t guestCaps;
211
212	/** "Additions are Ok" indicator, set to true after processing VMMDevReportGuestInfo,
213	* if additions version is compatible. This flag is here to avoid repeated comparing
214	* of the version in guestInfo.
215	*/
216	uint32_t fu32AdditionsOk;
217
218	/** Video acceleration status set by guest. */
219	uint32_t u32VideoAccelEnabled;
220
221	DISPLAYCHANGEDATA displayChangeData;
222
223	/** Pointer to the credentials. */
224	R3PTRTYPE(VMMDEVCREDS *) pCredentials;
225
226	bool afAlignment4[HC_ARCH_BITS == 32 ? 3 : 7];
227
228	/* memory balloon change request */
229	uint32_t cMbMemoryBalloon;
230	/** The last balloon size queried by the guest additions. */
231	uint32_t cMbMemoryBalloonLast;
232
233	/* guest ram size */
234	uint64_t cbGuestRAM;
235
236	/* unique session id; the id will be different after each start, reset or restore of the VM. */
237	uint64_t idSession;
238
239	/* statistics interval change request */
240	uint32_t u32StatIntervalSize, u32LastStatIntervalSize;
241
242	/* seamless mode change request */
243	bool fLastSeamlessEnabled, fSeamlessEnabled;
244	bool afAlignment5[1];
245
246	bool fVRDPEnabled;
247	uint32_t uVRDPExperienceLevel;
248
249	#ifdef VMMDEV_WITH_ALT_TIMESYNC
250	uint64_t hostTime;
251	bool fTimesyncBackdoorLo;
252	bool afAlignment6[3];
253	#endif
254	/** Set if GetHostTime should fail.
255	* Loaded from the GetHostTimeDisabled configuration value. */
256	bool fGetHostTimeDisabled;
257
258	/** Set if backdoor logging should be disabled (output will be ignored then) */
259	bool fBackdoorLogDisabled;
260
261	/** Don't clear credentials */
262	bool fKeepCredentials;
263
264	/** Heap enabled. */
265	bool fHeapEnabled;
266
267	/** Guest Core Dumping enabled. */
268	bool fGuestCoreDumpEnabled;
269
270	/** Guest Core Dump location. */
271	char szGuestCoreDumpDir[RTPATH_MAX];
272
273	/** Number of additional cores to keep around. */
274	uint32_t cGuestCoreDumps;
275
276	bool afAlignment7[1];
277
278	#ifdef VBOX_WITH_HGCM
279	/** List of pending HGCM requests, used for saving the HGCM state. */
280	R3PTRTYPE(PVBOXHGCMCMD) pHGCMCmdList;
281	/** Critical section to protect the list. */
282	RTCRITSECT critsectHGCMCmdList;
283	/** Whether the HGCM events are already automatically enabled. */
284	uint32_t u32HGCMEnabled;
285	/** Alignment padding. */
286	uint32_t u32Alignment7;
287	#endif /* VBOX_WITH_HGCM */
288
289	/** Status LUN: Shared folders LED */
290	struct
291	{
292	/** The LED. */
293	PDMLED Led;
294	/** The LED ports. */
295	PDMILEDPORTS ILeds;
296	/** Partner of ILeds. */
297	R3PTRTYPE(PPDMILEDCONNECTORS) pLedsConnector;
298	} SharedFolders;
299
300	/** FLag whether CPU hotplug events are monitored */
301	bool fCpuHotPlugEventsEnabled;
302	/** Alignment padding. */
303	bool afPadding8[3];
304	/** CPU hotplug event */
305	VMMDevCpuEventType enmCpuHotPlugEvent;
306	/** Core id of the CPU to change */
307	uint32_t idCpuCore;
308	/** Package id of the CPU to change */
309	uint32_t idCpuPackage;
310
311	uint32_t StatMemBalloonChunks;
312
313	/** Set if RC/R0 is enabled. */
314	bool fRZEnabled;
315	/** Set if testing is enabled. */
316	bool fTestingEnabled;
317	/** Set if testing the MMIO testing range is enabled. */
318	bool fTestingMMIO;
319	/** Alignment padding. */
320	bool afPadding9[HC_ARCH_BITS == 32 ? 1 : 5];
321	#ifndef VBOX_WITHOUT_TESTING_FEATURES
322	/** The high timestamp value. */
323	uint32_t u32TestingHighTimestamp;
324	/** The current testing command (VMMDEV_TESTING_CMD_XXX). */
325	uint32_t u32TestingCmd;
326	/** The testing data offset (command specific). */
327	uint32_t offTestingData;
328	/** For buffering the what comes in over the testing data port. */
329	union
330	{
331	char padding[1024];
332
333	/** VMMDEV_TESTING_CMD_INIT, VMMDEV_TESTING_CMD_SUB_NEW,
334	* VMMDEV_TESTING_CMD_FAILED. */
335	struct
336	{
337	char sz[1024];
338	} String, Init, SubNew, Failed;
339
340	/** VMMDEV_TESTING_CMD_TERM, VMMDEV_TESTING_CMD_SUB_DONE. */
341	struct
342	{
343	uint32_t c;
344	} Error, Term, SubDone;
345
346	/** VMMDEV_TESTING_CMD_VALUE. */
347	struct
348	{
349	RTUINT64U u64Value;
350	uint32_t u32Unit;
351	char szName[1024 - 8 - 4];
352	} Value;
353
354	/** The read back register (VMMDEV_TESTING_MMIO_OFF_READBACK,
355	* VMMDEV_TESTING_MMIO_OFF_READBACK_R3). */
356	uint8_t abReadBack[VMMDEV_TESTING_READBACK_SIZE];
357	} TestingData;
358	/** The XML output file name (can be a named pipe, doesn't matter to us). */
359	R3PTRTYPE(char *) pszTestingXmlOutput;
360	/** Testing instance for dealing with the output. */
361	RTTEST hTestingTest;
362	#endif /* !VBOX_WITHOUT_TESTING_FEATURES */
363
364	/** @name Heartbeat
365	* @{ */
366	/** Timestamp of the last heartbeat from guest in nanosec. */
367	uint64_t volatile nsLastHeartbeatTS;
368	/** Indicates whether we missed HB from guest on last check. */
369	bool volatile fFlatlined;
370	/** Indicates whether heartbeat check is active. */
371	bool volatile fHeartbeatActive;
372	/** Alignment padding. */
373	bool afAlignment8[6];
374	/** Guest heartbeat interval in nanoseconds.
375	* This is the interval the guest is told to produce heartbeats at. */
376	uint64_t cNsHeartbeatInterval;
377	/** The amount of time without a heartbeat (nanoseconds) before we
378	* conclude the guest is doing a Dixie Flatline (Neuromancer) impression. */
379	uint64_t cNsHeartbeatTimeout;
380	/** Timer for signalling a flatlined guest. */
381	PTMTIMERR3 pFlatlinedTimer;
382	/** @} */
383	} VMMDevState;
384	typedef VMMDevState VMMDEV;
385	/** Pointer to the VMM device state. */
386	typedef VMMDEV *PVMMDEV;
387	AssertCompileMemberAlignment(VMMDEV, CritSect, 8);
388	AssertCompileMemberAlignment(VMMDEV, cbGuestRAM, 8);
389	AssertCompileMemberAlignment(VMMDEV, enmCpuHotPlugEvent, 4);
390	AssertCompileMemberAlignment(VMMDEV, aFacilityStatuses, 8);
391	#ifndef VBOX_WITHOUT_TESTING_FEATURES
392	AssertCompileMemberAlignment(VMMDEV, TestingData.Value.u64Value, 8);
393	#endif
394
395
396	void VMMDevNotifyGuest(VMMDEV *pVMMDevState, uint32_t u32EventMask);
397	void VMMDevCtlSetGuestFilterMask(VMMDEV *pVMMDevState, uint32_t u32OrMask, uint32_t u32NotMask);
398
399	#endif /* !___VMMDev_VMMDevState_h */
400

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

source: vbox/trunk/src/VBox/Devices/VMMDev/VMMDevState.h@ 63495

Download in other formats: