vm.h@ 62958

Last change on this file since 62958 was 62476, 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: 51.2 KB

Line
1	/** @file
2	* VM - The Virtual Machine, data.
3	*/
4
5	/*
6	* Copyright (C) 2006-2016 Oracle Corporation
7	*
8	* This file is part of VirtualBox Open Source Edition (OSE), as
9	* available from http://www.virtualbox.org. This file is free software;
10	* you can redistribute it and/or modify it under the terms of the GNU
11	* General Public License (GPL) as published by the Free Software
12	* Foundation, in version 2 as it comes in the "COPYING" file of the
13	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15	*
16	* The contents of this file may alternatively be used under the terms
17	* of the Common Development and Distribution License Version 1.0
18	* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19	* VirtualBox OSE distribution, in which case the provisions of the
20	* CDDL are applicable instead of those of the GPL.
21	*
22	* You may elect to license modified versions of this file under the
23	* terms and conditions of either the GPL or the CDDL or both.
24	*/
25
26	#ifndef ___VBox_vmm_vm_h
27	#define ___VBox_vmm_vm_h
28
29	#ifndef VBOX_FOR_DTRACE_LIB
30	# include <iprt/param.h>
31	# include <VBox/types.h>
32	# include <VBox/vmm/cpum.h>
33	# include <VBox/vmm/stam.h>
34	# include <VBox/vmm/vmapi.h>
35	# include <VBox/vmm/vmm.h>
36	# include <VBox/sup.h>
37	#else
38	# pragma D depends_on library vbox-types.d
39	# pragma D depends_on library CPUMInternal.d
40	# define ___CPUMInternal_h
41	#endif
42
43
44
45	/** @defgroup grp_vm The Virtual Machine
46	* @ingroup grp_vmm
47	* @{
48	*/
49
50	/**
51	* The state of a Virtual CPU.
52	*
53	* The basic state indicated here is whether the CPU has been started or not. In
54	* addition, there are sub-states when started for assisting scheduling (GVMM
55	* mostly).
56	*
57	* The transition out of the STOPPED state is done by a vmR3PowerOn.
58	* The transition back to the STOPPED state is done by vmR3PowerOff.
59	*
60	* (Alternatively we could let vmR3PowerOn start CPU 0 only and let the SPIP
61	* handling switch on the other CPUs. Then vmR3Reset would stop all but CPU 0.)
62	*/
63	typedef enum VMCPUSTATE
64	{
65	/** The customary invalid zero. */
66	VMCPUSTATE_INVALID = 0,
67
68	/** Virtual CPU has not yet been started. */
69	VMCPUSTATE_STOPPED,
70
71	/** CPU started. */
72	VMCPUSTATE_STARTED,
73	/** CPU started in HM context. */
74	VMCPUSTATE_STARTED_HM,
75	/** Executing guest code and can be poked (RC or STI bits of HM). */
76	VMCPUSTATE_STARTED_EXEC,
77	/** Executing guest code in the recompiler. */
78	VMCPUSTATE_STARTED_EXEC_REM,
79	/** Halted. */
80	VMCPUSTATE_STARTED_HALTED,
81
82	/** The end of valid virtual CPU states. */
83	VMCPUSTATE_END,
84
85	/** Ensure 32-bit type. */
86	VMCPUSTATE_32BIT_HACK = 0x7fffffff
87	} VMCPUSTATE;
88
89
90	/**
91	* The cross context virtual CPU structure.
92	*
93	* Run 'kmk run-struct-tests' (from src/VBox/VMM if you like) after updating!
94	*/
95	typedef struct VMCPU
96	{
97	/** Per CPU forced action.
98	* See the VMCPU_FF_* \#defines. Updated atomically. */
99	uint32_t volatile fLocalForcedActions; /* 0 */
100	/** The CPU state. */
101	VMCPUSTATE volatile enmState; /* 4 */
102
103	/** Pointer to the ring-3 UVMCPU structure. */
104	PUVMCPU pUVCpu; /* 8 */
105	/** Ring-3 Host Context VM Pointer. */
106	PVMR3 pVMR3; /* 16 / 12 */
107	/** Ring-0 Host Context VM Pointer. */
108	PVMR0 pVMR0; /* 24 / 16 */
109	/** Raw-mode Context VM Pointer. */
110	PVMRC pVMRC; /* 32 / 20 */
111	/** The CPU ID.
112	* This is the index into the VM::aCpu array. */
113	VMCPUID idCpu; /* 36 / 24 */
114	/** The native thread handle. */
115	RTNATIVETHREAD hNativeThread; /* 40 / 28 */
116	/** The native R0 thread handle. (different from the R3 handle!) */
117	RTNATIVETHREAD hNativeThreadR0; /* 48 / 32 */
118	/** Which host CPU ID is this EMT running on.
119	* Only valid when in RC or HMR0 with scheduling disabled. */
120	RTCPUID volatile idHostCpu; /* 56 / 36 */
121	/** The CPU set index corresponding to idHostCpu, UINT32_MAX if not valid.
122	* @remarks Best to make sure iHostCpuSet shares cache line with idHostCpu! */
123	uint32_t volatile iHostCpuSet; /* 60 / 40 */
124
125	#if HC_ARCH_BITS == 32
126	/** Align the structures below bit on a 64-byte boundary and make sure it starts
127	* at the same offset in both 64-bit and 32-bit builds.
128	*
129	* @remarks The alignments of the members that are larger than 48 bytes should be
130	* 64-byte for cache line reasons. structs containing small amounts of
131	* data could be lumped together at the end with a < 64 byte padding
132	* following it (to grow into and align the struct size).
133	*/
134	uint8_t abAlignment1[HC_ARCH_BITS == 64 ? 0 : 20];
135	#endif
136
137	/** IEM part.
138	* @remarks This comes first as it allows the use of 8-bit immediates for the
139	* first 64 bytes of the structure, reducing code size a wee bit. */
140	#ifdef ___IEMInternal_h /* For PDB hacking. */
141	union VMCPUUNIONIEMFULL
142	#else
143	union VMCPUUNIONIEMSTUB
144	#endif
145	{
146	#ifdef ___IEMInternal_h
147	struct IEMCPU s;
148	#endif
149	uint8_t padding[18496]; /* multiple of 64 */
150	} iem;
151
152	/** HM part. */
153	union VMCPUUNIONHM
154	{
155	#ifdef ___HMInternal_h
156	struct HMCPU s;
157	#endif
158	uint8_t padding[5760]; /* multiple of 64 */
159	} hm;
160
161	/** EM part. */
162	union VMCPUUNIONEM
163	{
164	#ifdef ___EMInternal_h
165	struct EMCPU s;
166	#endif
167	uint8_t padding[1408]; /* multiple of 64 */
168	} em;
169
170	/** TRPM part. */
171	union VMCPUUNIONTRPM
172	{
173	#ifdef ___TRPMInternal_h
174	struct TRPMCPU s;
175	#endif
176	uint8_t padding[128]; /* multiple of 64 */
177	} trpm;
178
179	/** TM part. */
180	union VMCPUUNIONTM
181	{
182	#ifdef ___TMInternal_h
183	struct TMCPU s;
184	#endif
185	uint8_t padding[384]; /* multiple of 64 */
186	} tm;
187
188	/** VMM part. */
189	union VMCPUUNIONVMM
190	{
191	#ifdef ___VMMInternal_h
192	struct VMMCPU s;
193	#endif
194	uint8_t padding[704]; /* multiple of 64 */
195	} vmm;
196
197	/** PDM part. */
198	union VMCPUUNIONPDM
199	{
200	#ifdef ___PDMInternal_h
201	struct PDMCPU s;
202	#endif
203	uint8_t padding[256]; /* multiple of 64 */
204	} pdm;
205
206	/** IOM part. */
207	union VMCPUUNIONIOM
208	{
209	#ifdef ___IOMInternal_h
210	struct IOMCPU s;
211	#endif
212	uint8_t padding[512]; /* multiple of 64 */
213	} iom;
214
215	/** DBGF part.
216	* @todo Combine this with other tiny structures. */
217	union VMCPUUNIONDBGF
218	{
219	#ifdef ___DBGFInternal_h
220	struct DBGFCPU s;
221	#endif
222	uint8_t padding[256]; /* multiple of 64 */
223	} dbgf;
224
225	/** GIM part. */
226	union VMCPUUNIONGIM
227	{
228	#ifdef ___GIMInternal_h
229	struct GIMCPU s;
230	#endif
231	uint8_t padding[256]; /* multiple of 64 */
232	} gim;
233
234	/** APIC part. */
235	union VMCPUUNIONAPIC
236	{
237	#ifdef ___APICInternal_h
238	struct APICCPU s;
239	#endif
240	uint8_t padding[768]; /* multiple of 64 */
241	} apic;
242
243	/*
244	* Some less frequently used global members that doesn't need to take up
245	* precious space at the head of the structure.
246	*/
247
248	/** Trace groups enable flags. */
249	uint32_t fTraceGroups; /* 64 / 44 */
250	/** State data for use by ad hoc profiling. */
251	uint32_t uAdHoc;
252	/** Profiling samples for use by ad hoc profiling. */
253	STAMPROFILEADV aStatAdHoc[8]; /* size: 408 = 320 /
254
255	/** Align the following members on page boundary. */
256	uint8_t abAlignment2[3448];
257
258	/** PGM part. */
259	union VMCPUUNIONPGM
260	{
261	#ifdef ___PGMInternal_h
262	struct PGMCPU s;
263	#endif
264	uint8_t padding[4096]; /* multiple of 4096 */
265	} pgm;
266
267	/** CPUM part. */
268	union VMCPUUNIONCPUM
269	{
270	#ifdef ___CPUMInternal_h
271	struct CPUMCPU s;
272	#endif
273	#ifdef VMCPU_INCL_CPUM_GST_CTX
274	/** The guest CPUM context for direct use by execution engines.
275	* This is not for general consumption, but for HM, REM, IEM, and maybe a few
276	* others. The rest will use the function based CPUM API. */
277	CPUMCTX GstCtx;
278	#endif
279	uint8_t padding[4096]; /* multiple of 4096 */
280	} cpum;
281	} VMCPU;
282
283
284	#ifndef VBOX_FOR_DTRACE_LIB
285
286	/** @name Operations on VMCPU::enmState
287	* @{ */
288	/** Gets the VMCPU state. */
289	#define VMCPU_GET_STATE(pVCpu) ( (pVCpu)->enmState )
290	/** Sets the VMCPU state. */
291	#define VMCPU_SET_STATE(pVCpu, enmNewState) \
292	ASMAtomicWriteU32((uint32_t volatile *)&(pVCpu)->enmState, (enmNewState))
293	/** Cmpares and sets the VMCPU state. */
294	#define VMCPU_CMPXCHG_STATE(pVCpu, enmNewState, enmOldState) \
295	ASMAtomicCmpXchgU32((uint32_t volatile *)&(pVCpu)->enmState, (enmNewState), (enmOldState))
296	/** Checks the VMCPU state. */
297	#ifdef VBOX_STRICT
298	# define VMCPU_ASSERT_STATE(pVCpu, enmExpectedState) \
299	do { \
300	VMCPUSTATE enmState = VMCPU_GET_STATE(pVCpu); \
301	AssertMsg(enmState == (enmExpectedState), \
302	("enmState=%d enmExpectedState=%d idCpu=%u\n", \
303	enmState, enmExpectedState, (pVCpu)->idCpu)); \
304	} while (0)
305	#else
306	# define VMCPU_ASSERT_STATE(pVCpu, enmExpectedState) do { } while (0)
307	#endif
308	/** Tests if the state means that the CPU is started. */
309	#define VMCPUSTATE_IS_STARTED(enmState) ( (enmState) > VMCPUSTATE_STOPPED )
310	/** Tests if the state means that the CPU is stopped. */
311	#define VMCPUSTATE_IS_STOPPED(enmState) ( (enmState) == VMCPUSTATE_STOPPED )
312	/** @} */
313
314
315	/** The name of the raw-mode context VMM Core module. */
316	#define VMMRC_MAIN_MODULE_NAME "VMMRC.rc"
317	/** The name of the ring-0 context VMM Core module. */
318	#define VMMR0_MAIN_MODULE_NAME "VMMR0.r0"
319
320	/**
321	* Wrapper macro for avoiding too much \#ifdef VBOX_WITH_RAW_MODE.
322	*/
323	#ifdef VBOX_WITH_RAW_MODE
324	# define VM_WHEN_RAW_MODE(a_WithExpr, a_WithoutExpr) a_WithExpr
325	#else
326	# define VM_WHEN_RAW_MODE(a_WithExpr, a_WithoutExpr) a_WithoutExpr
327	#endif
328
329
330	/** VM Forced Action Flags.
331	*
332	* Use the VM_FF_SET() and VM_FF_CLEAR() macros to change the force
333	* action mask of a VM.
334	*
335	* Available VM bits:
336	* 0, 1, 5, 6, 7, 13, 14, 15, 16, 17, 21, 22, 23, 24, 25, 26, 27, 28, 30
337	*
338	*
339	* Available VMCPU bits:
340	* 11, 14, 15, 31
341	*
342	* @todo If we run low on VMCPU, we may consider merging the SELM bits
343	*
344	* @{
345	*/
346	/** The virtual sync clock has been stopped, go to TM until it has been
347	* restarted... */
348	#define VM_FF_TM_VIRTUAL_SYNC RT_BIT_32(2)
349	/** PDM Queues are pending. */
350	#define VM_FF_PDM_QUEUES RT_BIT_32(VM_FF_PDM_QUEUES_BIT)
351	/** The bit number for VM_FF_PDM_QUEUES. */
352	#define VM_FF_PDM_QUEUES_BIT 3
353	/** PDM DMA transfers are pending. */
354	#define VM_FF_PDM_DMA RT_BIT_32(VM_FF_PDM_DMA_BIT)
355	/** The bit number for VM_FF_PDM_DMA. */
356	#define VM_FF_PDM_DMA_BIT 4
357	/** This action forces the VM to call DBGF so DBGF can service debugger
358	* requests in the emulation thread.
359	* This action flag stays asserted till DBGF clears it.*/
360	#define VM_FF_DBGF RT_BIT_32(VM_FF_DBGF_BIT)
361	/** The bit number for VM_FF_DBGF. */
362	#define VM_FF_DBGF_BIT 8
363	/** This action forces the VM to service pending requests from other
364	* thread or requests which must be executed in another context. */
365	#define VM_FF_REQUEST RT_BIT_32(9)
366	/** Check for VM state changes and take appropriate action. */
367	#define VM_FF_CHECK_VM_STATE RT_BIT_32(VM_FF_CHECK_VM_STATE_BIT)
368	/** The bit number for VM_FF_CHECK_VM_STATE. */
369	#define VM_FF_CHECK_VM_STATE_BIT 10
370	/** Reset the VM. (postponed) */
371	#define VM_FF_RESET RT_BIT_32(VM_FF_RESET_BIT)
372	/** The bit number for VM_FF_RESET. */
373	#define VM_FF_RESET_BIT 11
374	/** EMT rendezvous in VMM. */
375	#define VM_FF_EMT_RENDEZVOUS RT_BIT_32(VM_FF_EMT_RENDEZVOUS_BIT)
376	/** The bit number for VM_FF_EMT_RENDEZVOUS. */
377	#define VM_FF_EMT_RENDEZVOUS_BIT 12
378
379	/** PGM needs to allocate handy pages. */
380	#define VM_FF_PGM_NEED_HANDY_PAGES RT_BIT_32(18)
381	/** PGM is out of memory.
382	* Abandon all loops and code paths which can be resumed and get up to the EM
383	* loops. */
384	#define VM_FF_PGM_NO_MEMORY RT_BIT_32(19)
385	/** PGM is about to perform a lightweight pool flush
386	* Guest SMP: all EMT threads should return to ring 3
387	*/
388	#define VM_FF_PGM_POOL_FLUSH_PENDING RT_BIT_32(20)
389	/** REM needs to be informed about handler changes. */
390	#define VM_FF_REM_HANDLER_NOTIFY RT_BIT_32(VM_FF_REM_HANDLER_NOTIFY_BIT)
391	/** The bit number for VM_FF_REM_HANDLER_NOTIFY. */
392	#define VM_FF_REM_HANDLER_NOTIFY_BIT 29
393	/** Suspend the VM - debug only. */
394	#define VM_FF_DEBUG_SUSPEND RT_BIT_32(31)
395
396
397	/** This action forces the VM to check any pending interrupts on the APIC. */
398	#define VMCPU_FF_INTERRUPT_APIC RT_BIT_32(0)
399	/** This action forces the VM to check any pending interrups on the PIC. */
400	#define VMCPU_FF_INTERRUPT_PIC RT_BIT_32(1)
401	/** This action forces the VM to schedule and run pending timer (TM).
402	* @remarks Don't move - PATM compatibility. */
403	#define VMCPU_FF_TIMER RT_BIT_32(2)
404	/** This action forces the VM to check any pending NMIs. */
405	#define VMCPU_FF_INTERRUPT_NMI_BIT 3
406	#define VMCPU_FF_INTERRUPT_NMI RT_BIT_32(VMCPU_FF_INTERRUPT_NMI_BIT)
407	/** This action forces the VM to check any pending SMIs. */
408	#define VMCPU_FF_INTERRUPT_SMI_BIT 4
409	#define VMCPU_FF_INTERRUPT_SMI RT_BIT_32(VMCPU_FF_INTERRUPT_SMI_BIT)
410	/** PDM critical section unlocking is pending, process promptly upon return to R3. */
411	#define VMCPU_FF_PDM_CRITSECT RT_BIT_32(5)
412	/** This action forces the VCPU out of the halted state. */
413	#define VMCPU_FF_UNHALT RT_BIT_32(6)
414	/** Pending IEM action (bit number). */
415	#define VMCPU_FF_IEM_BIT 7
416	/** Pending IEM action (mask). */
417	#define VMCPU_FF_IEM RT_BIT_32(VMCPU_FF_IEM_BIT)
418	/** Pending APIC action (bit number). */
419	#define VMCPU_FF_UPDATE_APIC_BIT 8
420	/** This action forces the VM to update APIC's asynchronously arrived
421	* interrupts as pending interrupts. */
422	#define VMCPU_FF_UPDATE_APIC RT_BIT_32(VMCPU_FF_UPDATE_APIC_BIT)
423	/** This action forces the VM to service pending requests from other
424	* thread or requests which must be executed in another context. */
425	#define VMCPU_FF_REQUEST RT_BIT_32(9)
426	/** Pending DBGF event (alternative to passing VINF_EM_DBG_EVENT around). */
427	#define VMCPU_FF_DBGF RT_BIT_32(VMCPU_FF_DBGF_BIT)
428	/** The bit number for VMCPU_FF_DBGF. */
429	#define VMCPU_FF_DBGF_BIT 10
430	/** This action forces the VM to service any pending updates to CR3 (used only
431	* by HM). */
432	#define VMCPU_FF_HM_UPDATE_CR3 RT_BIT_32(12)
433	/** This action forces the VM to service any pending updates to PAE PDPEs (used
434	* only by HM). */
435	#define VMCPU_FF_HM_UPDATE_PAE_PDPES RT_BIT_32(13)
436	/** This action forces the VM to resync the page tables before going
437	* back to execute guest code. (GLOBAL FLUSH) */
438	#define VMCPU_FF_PGM_SYNC_CR3 RT_BIT_32(16)
439	/** Same as VM_FF_PGM_SYNC_CR3 except that global pages can be skipped.
440	* (NON-GLOBAL FLUSH) */
441	#define VMCPU_FF_PGM_SYNC_CR3_NON_GLOBAL RT_BIT_32(17)
442	/** Check for pending TLB shootdown actions (deprecated)
443	* Reserved for furture HM re-use if necessary / safe.
444	* Consumer: HM */
445	#define VMCPU_FF_TLB_SHOOTDOWN_UNUSED RT_BIT_32(18)
446	/** Check for pending TLB flush action.
447	* Consumer: HM
448	* @todo rename to VMCPU_FF_HM_TLB_FLUSH */
449	#define VMCPU_FF_TLB_FLUSH RT_BIT_32(VMCPU_FF_TLB_FLUSH_BIT)
450	/** The bit number for VMCPU_FF_TLB_FLUSH. */
451	#define VMCPU_FF_TLB_FLUSH_BIT 19
452	#ifdef VBOX_WITH_RAW_MODE
453	/** Check the interrupt and trap gates */
454	# define VMCPU_FF_TRPM_SYNC_IDT RT_BIT_32(20)
455	/** Check Guest's TSS ring 0 stack */
456	# define VMCPU_FF_SELM_SYNC_TSS RT_BIT_32(21)
457	/** Check Guest's GDT table */
458	# define VMCPU_FF_SELM_SYNC_GDT RT_BIT_32(22)
459	/** Check Guest's LDT table */
460	# define VMCPU_FF_SELM_SYNC_LDT RT_BIT_32(23)
461	#endif /* VBOX_WITH_RAW_MODE */
462	/** Inhibit interrupts pending. See EMGetInhibitInterruptsPC(). */
463	#define VMCPU_FF_INHIBIT_INTERRUPTS RT_BIT_32(24)
464	/** Block injection of non-maskable interrupts to the guest. */
465	#define VMCPU_FF_BLOCK_NMIS RT_BIT_32(25)
466	#ifdef VBOX_WITH_RAW_MODE
467	/** CSAM needs to scan the page that's being executed */
468	# define VMCPU_FF_CSAM_SCAN_PAGE RT_BIT_32(26)
469	/** CSAM needs to do some homework. */
470	# define VMCPU_FF_CSAM_PENDING_ACTION RT_BIT_32(27)
471	#endif /* VBOX_WITH_RAW_MODE */
472	/** Force return to Ring-3. */
473	#define VMCPU_FF_TO_R3 RT_BIT_32(28)
474	/** Force return to ring-3 to service pending I/O or MMIO write.
475	* This is a backup for mechanism VINF_IOM_R3_IOPORT_COMMIT_WRITE and
476	* VINF_IOM_R3_MMIO_COMMIT_WRITE, allowing VINF_EM_DBG_BREAKPOINT and similar
477	* status codes to be propagated at the same time without loss. */
478	#define VMCPU_FF_IOM RT_BIT_32(29)
479	#ifdef VBOX_WITH_RAW_MODE
480	/** CPUM need to adjust CR0.TS/EM before executing raw-mode code again. */
481	# define VMCPU_FF_CPUM RT_BIT_32(VMCPU_FF_CPUM_BIT)
482	/** The bit number for VMCPU_FF_CPUM. */
483	# define VMCPU_FF_CPUM_BIT 30
484	#endif /* VBOX_WITH_RAW_MODE */
485
486	/** Externally VM forced actions. Used to quit the idle/wait loop. */
487	#define VM_FF_EXTERNAL_SUSPENDED_MASK ( VM_FF_CHECK_VM_STATE \| VM_FF_DBGF \| VM_FF_REQUEST \| VM_FF_EMT_RENDEZVOUS )
488	/** Externally VMCPU forced actions. Used to quit the idle/wait loop. */
489	#define VMCPU_FF_EXTERNAL_SUSPENDED_MASK ( VMCPU_FF_REQUEST \| VMCPU_FF_DBGF )
490
491	/** Externally forced VM actions. Used to quit the idle/wait loop. */
492	#define VM_FF_EXTERNAL_HALTED_MASK ( VM_FF_CHECK_VM_STATE \| VM_FF_DBGF \| VM_FF_REQUEST \
493	\| VM_FF_PDM_QUEUES \| VM_FF_PDM_DMA \| VM_FF_EMT_RENDEZVOUS )
494	/** Externally forced VMCPU actions. Used to quit the idle/wait loop. */
495	#define VMCPU_FF_EXTERNAL_HALTED_MASK ( VMCPU_FF_UPDATE_APIC \| VMCPU_FF_INTERRUPT_APIC \| VMCPU_FF_INTERRUPT_PIC \
496	\| VMCPU_FF_REQUEST \| VMCPU_FF_INTERRUPT_NMI \| VMCPU_FF_INTERRUPT_SMI \
497	\| VMCPU_FF_UNHALT \| VMCPU_FF_TIMER \| VMCPU_FF_DBGF )
498
499	/** High priority VM pre-execution actions. */
500	#define VM_FF_HIGH_PRIORITY_PRE_MASK ( VM_FF_CHECK_VM_STATE \| VM_FF_DBGF \| VM_FF_TM_VIRTUAL_SYNC \
501	\| VM_FF_DEBUG_SUSPEND \| VM_FF_PGM_NEED_HANDY_PAGES \| VM_FF_PGM_NO_MEMORY \
502	\| VM_FF_EMT_RENDEZVOUS )
503	/** High priority VMCPU pre-execution actions. */
504	#define VMCPU_FF_HIGH_PRIORITY_PRE_MASK ( VMCPU_FF_TIMER \| VMCPU_FF_INTERRUPT_APIC \| VMCPU_FF_INTERRUPT_PIC \
505	\| VMCPU_FF_UPDATE_APIC \| VMCPU_FF_INHIBIT_INTERRUPTS \| VMCPU_FF_DBGF \
506	\| VMCPU_FF_PGM_SYNC_CR3 \| VMCPU_FF_PGM_SYNC_CR3_NON_GLOBAL \
507	\| VM_WHEN_RAW_MODE( VMCPU_FF_SELM_SYNC_TSS \| VMCPU_FF_TRPM_SYNC_IDT \
508	\| VMCPU_FF_SELM_SYNC_GDT \| VMCPU_FF_SELM_SYNC_LDT, 0 ) )
509
510	/** High priority VM pre raw-mode execution mask. */
511	#define VM_FF_HIGH_PRIORITY_PRE_RAW_MASK ( VM_FF_PGM_NEED_HANDY_PAGES \| VM_FF_PGM_NO_MEMORY )
512	/** High priority VMCPU pre raw-mode execution mask. */
513	#define VMCPU_FF_HIGH_PRIORITY_PRE_RAW_MASK ( VMCPU_FF_PGM_SYNC_CR3 \| VMCPU_FF_PGM_SYNC_CR3_NON_GLOBAL \
514	\| VMCPU_FF_INHIBIT_INTERRUPTS \
515	\| VM_WHEN_RAW_MODE( VMCPU_FF_SELM_SYNC_TSS \| VMCPU_FF_TRPM_SYNC_IDT \
516	\| VMCPU_FF_SELM_SYNC_GDT \| VMCPU_FF_SELM_SYNC_LDT, 0) )
517
518	/** High priority post-execution actions. */
519	#define VM_FF_HIGH_PRIORITY_POST_MASK ( VM_FF_PGM_NO_MEMORY )
520	/** High priority post-execution actions. */
521	#define VMCPU_FF_HIGH_PRIORITY_POST_MASK ( VMCPU_FF_PDM_CRITSECT \| VM_WHEN_RAW_MODE(VMCPU_FF_CSAM_PENDING_ACTION, 0) \
522	\| VMCPU_FF_HM_UPDATE_CR3 \| VMCPU_FF_HM_UPDATE_PAE_PDPES \
523	\| VMCPU_FF_IEM \| VMCPU_FF_IOM )
524
525	/** Normal priority VM post-execution actions. */
526	#define VM_FF_NORMAL_PRIORITY_POST_MASK ( VM_FF_CHECK_VM_STATE \| VM_FF_DBGF \| VM_FF_RESET \
527	\| VM_FF_PGM_NO_MEMORY \| VM_FF_EMT_RENDEZVOUS)
528	/** Normal priority VMCPU post-execution actions. */
529	#define VMCPU_FF_NORMAL_PRIORITY_POST_MASK ( VM_WHEN_RAW_MODE(VMCPU_FF_CSAM_SCAN_PAGE, 0) \| VMCPU_FF_DBGF )
530
531	/** Normal priority VM actions. */
532	#define VM_FF_NORMAL_PRIORITY_MASK ( VM_FF_REQUEST \| VM_FF_PDM_QUEUES \| VM_FF_PDM_DMA \
533	\| VM_FF_REM_HANDLER_NOTIFY \| VM_FF_EMT_RENDEZVOUS)
534	/** Normal priority VMCPU actions. */
535	#define VMCPU_FF_NORMAL_PRIORITY_MASK ( VMCPU_FF_REQUEST \| VMCPU_FF_UNHALT )
536
537	/** Flags to clear before resuming guest execution. */
538	#define VMCPU_FF_RESUME_GUEST_MASK ( VMCPU_FF_TO_R3 )
539
540
541	/** VM flags that cause the REP[\|NE\|E] STRINS loops to yield immediately. */
542	#define VM_FF_HIGH_PRIORITY_POST_REPSTR_MASK ( VM_FF_TM_VIRTUAL_SYNC \| VM_FF_PGM_NEED_HANDY_PAGES \| VM_FF_PGM_NO_MEMORY \
543	\| VM_FF_EMT_RENDEZVOUS \| VM_FF_PGM_POOL_FLUSH_PENDING \| VM_FF_RESET)
544	/** VM flags that cause the REP[\|NE\|E] STRINS loops to yield. */
545	#define VM_FF_YIELD_REPSTR_MASK ( VM_FF_HIGH_PRIORITY_POST_REPSTR_MASK \
546	\| VM_FF_PDM_QUEUES \| VM_FF_PDM_DMA \| VM_FF_DBGF \| VM_FF_DEBUG_SUSPEND )
547	/** VMCPU flags that cause the REP[\|NE\|E] STRINS loops to yield immediately. */
548	#ifdef IN_RING3
549	# define VMCPU_FF_HIGH_PRIORITY_POST_REPSTR_MASK ( VMCPU_FF_PGM_SYNC_CR3 \| VMCPU_FF_PGM_SYNC_CR3_NON_GLOBAL \| VMCPU_FF_DBGF )
550	#else
551	# define VMCPU_FF_HIGH_PRIORITY_POST_REPSTR_MASK ( VMCPU_FF_TO_R3 \| VMCPU_FF_IEM \| VMCPU_FF_IOM \| VMCPU_FF_PGM_SYNC_CR3 \
552	\| VMCPU_FF_PGM_SYNC_CR3_NON_GLOBAL \| VMCPU_FF_DBGF )
553	#endif
554	/** VMCPU flags that cause the REP[\|NE\|E] STRINS loops to yield, interrupts
555	* enabled. */
556	#define VMCPU_FF_YIELD_REPSTR_MASK ( VMCPU_FF_HIGH_PRIORITY_POST_REPSTR_MASK \
557	\| VMCPU_FF_INTERRUPT_APIC \| VMCPU_FF_UPDATE_APIC \| VMCPU_FF_INTERRUPT_PIC \
558	\| VMCPU_FF_INTERRUPT_NMI \| VMCPU_FF_INTERRUPT_SMI \| VMCPU_FF_PDM_CRITSECT \
559	\| VMCPU_FF_TIMER \| VMCPU_FF_REQUEST )
560	/** VMCPU flags that cause the REP[\|NE\|E] STRINS loops to yield, interrupts
561	* disabled. */
562	#define VMCPU_FF_YIELD_REPSTR_NOINT_MASK ( VMCPU_FF_YIELD_REPSTR_MASK \
563	& ~(VMCPU_FF_INTERRUPT_APIC \| VMCPU_FF_UPDATE_APIC \| VMCPU_FF_INTERRUPT_PIC) )
564
565	/** VM Flags that cause the HM loops to go back to ring-3. */
566	#define VM_FF_HM_TO_R3_MASK ( VM_FF_TM_VIRTUAL_SYNC \| VM_FF_PGM_NEED_HANDY_PAGES \| VM_FF_PGM_NO_MEMORY \
567	\| VM_FF_PDM_QUEUES \| VM_FF_EMT_RENDEZVOUS)
568	/** VMCPU Flags that cause the HM loops to go back to ring-3. */
569	#define VMCPU_FF_HM_TO_R3_MASK ( VMCPU_FF_TO_R3 \| VMCPU_FF_TIMER \| VMCPU_FF_PDM_CRITSECT \
570	\| VMCPU_FF_IEM \| VMCPU_FF_IOM)
571
572	/** High priority ring-0 VM pre HM-mode execution mask. */
573	#define VM_FF_HP_R0_PRE_HM_MASK (VM_FF_HM_TO_R3_MASK \| VM_FF_REQUEST \| VM_FF_PGM_POOL_FLUSH_PENDING \| VM_FF_PDM_DMA)
574	/** High priority ring-0 VMCPU pre HM-mode execution mask. */
575	#define VMCPU_FF_HP_R0_PRE_HM_MASK ( VMCPU_FF_HM_TO_R3_MASK \| VMCPU_FF_PGM_SYNC_CR3 \
576	\| VMCPU_FF_PGM_SYNC_CR3_NON_GLOBAL \| VMCPU_FF_REQUEST)
577	/** High priority ring-0 VM pre HM-mode execution mask, single stepping. */
578	#define VM_FF_HP_R0_PRE_HM_STEP_MASK (VM_FF_HP_R0_PRE_HM_MASK & ~( VM_FF_TM_VIRTUAL_SYNC \| VM_FF_PDM_QUEUES \
579	\| VM_FF_EMT_RENDEZVOUS \| VM_FF_REQUEST \
580	\| VM_FF_PDM_DMA) )
581	/** High priority ring-0 VMCPU pre HM-mode execution mask, single stepping. */
582	#define VMCPU_FF_HP_R0_PRE_HM_STEP_MASK (VMCPU_FF_HP_R0_PRE_HM_MASK & ~( VMCPU_FF_TO_R3 \| VMCPU_FF_TIMER \
583	\| VMCPU_FF_PDM_CRITSECT \| VMCPU_FF_REQUEST) )
584
585	/** All the forced VM flags. */
586	#define VM_FF_ALL_MASK (UINT32_MAX)
587	/** All the forced VMCPU flags. */
588	#define VMCPU_FF_ALL_MASK (UINT32_MAX)
589
590	/** All the forced VM flags except those related to raw-mode and hardware
591	* assisted execution. */
592	#define VM_FF_ALL_REM_MASK (~(VM_FF_HIGH_PRIORITY_PRE_RAW_MASK) \| VM_FF_PGM_NEED_HANDY_PAGES \| VM_FF_PGM_NO_MEMORY)
593	/** All the forced VMCPU flags except those related to raw-mode and hardware
594	* assisted execution. */
595	#define VMCPU_FF_ALL_REM_MASK (~( VMCPU_FF_HIGH_PRIORITY_PRE_RAW_MASK \| VMCPU_FF_PDM_CRITSECT \
596	\| VMCPU_FF_TLB_FLUSH \| VM_WHEN_RAW_MODE(VMCPU_FF_CSAM_PENDING_ACTION, 0) ))
597	/** @} */
598
599	/** @def VM_FF_SET
600	* Sets a force action flag.
601	*
602	* @param pVM The cross context VM structure.
603	* @param fFlag The flag to set.
604	*/
605	#if 1
606	# define VM_FF_SET(pVM, fFlag) ASMAtomicOrU32(&(pVM)->fGlobalForcedActions, (fFlag))
607	#else
608	# define VM_FF_SET(pVM, fFlag) \
609	do { ASMAtomicOrU32(&(pVM)->fGlobalForcedActions, (fFlag)); \
610	RTLogPrintf("VM_FF_SET : %08x %s - %s(%d) %s\n", (pVM)->fGlobalForcedActions, #fFlag, __FILE__, __LINE__, __FUNCTION__); \
611	} while (0)
612	#endif
613
614	/** @def VMCPU_FF_SET
615	* Sets a force action flag for the given VCPU.
616	*
617	* @param pVCpu The cross context virtual CPU structure.
618	* @param fFlag The flag to set.
619	*/
620	#define VMCPU_FF_SET(pVCpu, fFlag) ASMAtomicOrU32(&(pVCpu)->fLocalForcedActions, (fFlag))
621
622	/** @def VM_FF_CLEAR
623	* Clears a force action flag.
624	*
625	* @param pVM The cross context VM structure.
626	* @param fFlag The flag to clear.
627	*/
628	#if 1
629	# define VM_FF_CLEAR(pVM, fFlag) ASMAtomicAndU32(&(pVM)->fGlobalForcedActions, ~(fFlag))
630	#else
631	# define VM_FF_CLEAR(pVM, fFlag) \
632	do { ASMAtomicAndU32(&(pVM)->fGlobalForcedActions, ~(fFlag)); \
633	RTLogPrintf("VM_FF_CLEAR: %08x %s - %s(%d) %s\n", (pVM)->fGlobalForcedActions, #fFlag, __FILE__, __LINE__, __FUNCTION__); \
634	} while (0)
635	#endif
636
637	/** @def VMCPU_FF_CLEAR
638	* Clears a force action flag for the given VCPU.
639	*
640	* @param pVCpu The cross context virtual CPU structure.
641	* @param fFlag The flag to clear.
642	*/
643	#define VMCPU_FF_CLEAR(pVCpu, fFlag) ASMAtomicAndU32(&(pVCpu)->fLocalForcedActions, ~(fFlag))
644
645	/** @def VM_FF_IS_SET
646	* Checks if a force action flag is set.
647	*
648	* @param pVM The cross context VM structure.
649	* @param fFlag The flag to check.
650	*/
651	#define VM_FF_IS_SET(pVM, fFlag) (((pVM)->fGlobalForcedActions & (fFlag)) == (fFlag))
652
653	/** @def VMCPU_FF_IS_SET
654	* Checks if a force action flag is set for the given VCPU.
655	*
656	* @param pVCpu The cross context virtual CPU structure.
657	* @param fFlag The flag to check.
658	*/
659	#define VMCPU_FF_IS_SET(pVCpu, fFlag) (((pVCpu)->fLocalForcedActions & (fFlag)) == (fFlag))
660
661	/** @def VM_FF_IS_PENDING
662	* Checks if one or more force action in the specified set is pending.
663	*
664	* @param pVM The cross context VM structure.
665	* @param fFlags The flags to check for.
666	*/
667	#define VM_FF_IS_PENDING(pVM, fFlags) RT_BOOL((pVM)->fGlobalForcedActions & (fFlags))
668
669	/** @def VM_FF_TEST_AND_CLEAR
670	* Checks if one (!) force action in the specified set is pending and clears it atomically
671	*
672	* @returns true if the bit was set.
673	* @returns false if the bit was clear.
674	* @param pVM The cross context VM structure.
675	* @param iBit Bit position to check and clear
676	*/
677	#define VM_FF_TEST_AND_CLEAR(pVM, iBit) (ASMAtomicBitTestAndClear(&(pVM)->fGlobalForcedActions, iBit##_BIT))
678
679	/** @def VMCPU_FF_TEST_AND_CLEAR
680	* Checks if one (!) force action in the specified set is pending and clears it atomically
681	*
682	* @returns true if the bit was set.
683	* @returns false if the bit was clear.
684	* @param pVCpu The cross context virtual CPU structure.
685	* @param iBit Bit position to check and clear
686	*/
687	#define VMCPU_FF_TEST_AND_CLEAR(pVCpu, iBit) (ASMAtomicBitTestAndClear(&(pVCpu)->fLocalForcedActions, iBit##_BIT))
688
689	/** @def VMCPU_FF_IS_PENDING
690	* Checks if one or more force action in the specified set is pending for the given VCPU.
691	*
692	* @param pVCpu The cross context virtual CPU structure.
693	* @param fFlags The flags to check for.
694	*/
695	#define VMCPU_FF_IS_PENDING(pVCpu, fFlags) RT_BOOL((pVCpu)->fLocalForcedActions & (fFlags))
696
697	/** @def VM_FF_IS_PENDING_EXCEPT
698	* Checks if one or more force action in the specified set is pending while one
699	* or more other ones are not.
700	*
701	* @param pVM The cross context VM structure.
702	* @param fFlags The flags to check for.
703	* @param fExcpt The flags that should not be set.
704	*/
705	#define VM_FF_IS_PENDING_EXCEPT(pVM, fFlags, fExcpt) ( ((pVM)->fGlobalForcedActions & (fFlags)) && !((pVM)->fGlobalForcedActions & (fExcpt)) )
706
707	/** @def VMCPU_FF_IS_PENDING_EXCEPT
708	* Checks if one or more force action in the specified set is pending for the given
709	* VCPU while one or more other ones are not.
710	*
711	* @param pVCpu The cross context virtual CPU structure.
712	* @param fFlags The flags to check for.
713	* @param fExcpt The flags that should not be set.
714	*/
715	#define VMCPU_FF_IS_PENDING_EXCEPT(pVCpu, fFlags, fExcpt) ( ((pVCpu)->fLocalForcedActions & (fFlags)) && !((pVCpu)->fLocalForcedActions & (fExcpt)) )
716
717	/** @def VM_IS_EMT
718	* Checks if the current thread is the emulation thread (EMT).
719	*
720	* @remark The ring-0 variation will need attention if we expand the ring-0
721	* code to let threads other than EMT mess around with the VM.
722	*/
723	#ifdef IN_RC
724	# define VM_IS_EMT(pVM) true
725	#else
726	# define VM_IS_EMT(pVM) (VMMGetCpu(pVM) != NULL)
727	#endif
728
729	/** @def VMCPU_IS_EMT
730	* Checks if the current thread is the emulation thread (EMT) for the specified
731	* virtual CPU.
732	*/
733	#ifdef IN_RC
734	# define VMCPU_IS_EMT(pVCpu) true
735	#else
736	# define VMCPU_IS_EMT(pVCpu) ((pVCpu) && ((pVCpu) == VMMGetCpu((pVCpu)->CTX_SUFF(pVM))))
737	#endif
738
739	/** @def VM_ASSERT_EMT
740	* Asserts that the current thread IS the emulation thread (EMT).
741	*/
742	#ifdef IN_RC
743	# define VM_ASSERT_EMT(pVM) Assert(VM_IS_EMT(pVM))
744	#elif defined(IN_RING0)
745	# define VM_ASSERT_EMT(pVM) Assert(VM_IS_EMT(pVM))
746	#else
747	# define VM_ASSERT_EMT(pVM) \
748	AssertMsg(VM_IS_EMT(pVM), \
749	("Not emulation thread! Thread=%RTnthrd ThreadEMT=%RTnthrd\n", RTThreadNativeSelf(), VMR3GetVMCPUNativeThread(pVM)))
750	#endif
751
752	/** @def VMCPU_ASSERT_EMT
753	* Asserts that the current thread IS the emulation thread (EMT) of the
754	* specified virtual CPU.
755	*/
756	#ifdef IN_RC
757	# define VMCPU_ASSERT_EMT(pVCpu) Assert(VMCPU_IS_EMT(pVCpu))
758	#elif defined(IN_RING0)
759	# define VMCPU_ASSERT_EMT(pVCpu) AssertMsg(VMCPU_IS_EMT(pVCpu), \
760	("Not emulation thread! Thread=%RTnthrd ThreadEMT=%RTnthrd idCpu=%u\n", \
761	RTThreadNativeSelf(), (pVCpu) ? (pVCpu)->hNativeThreadR0 : 0, \
762	(pVCpu) ? (pVCpu)->idCpu : 0))
763	#else
764	# define VMCPU_ASSERT_EMT(pVCpu) AssertMsg(VMCPU_IS_EMT(pVCpu), \
765	("Not emulation thread! Thread=%RTnthrd ThreadEMT=%RTnthrd idCpu=%#x\n", \
766	RTThreadNativeSelf(), (pVCpu)->hNativeThread, (pVCpu)->idCpu))
767	#endif
768
769	/** @def VM_ASSERT_EMT_RETURN
770	* Asserts that the current thread IS the emulation thread (EMT) and returns if it isn't.
771	*/
772	#ifdef IN_RC
773	# define VM_ASSERT_EMT_RETURN(pVM, rc) AssertReturn(VM_IS_EMT(pVM), (rc))
774	#elif defined(IN_RING0)
775	# define VM_ASSERT_EMT_RETURN(pVM, rc) AssertReturn(VM_IS_EMT(pVM), (rc))
776	#else
777	# define VM_ASSERT_EMT_RETURN(pVM, rc) \
778	AssertMsgReturn(VM_IS_EMT(pVM), \
779	("Not emulation thread! Thread=%RTnthrd ThreadEMT=%RTnthrd\n", RTThreadNativeSelf(), VMR3GetVMCPUNativeThread(pVM)), \
780	(rc))
781	#endif
782
783	/** @def VMCPU_ASSERT_EMT_RETURN
784	* Asserts that the current thread IS the emulation thread (EMT) and returns if it isn't.
785	*/
786	#ifdef IN_RC
787	# define VMCPU_ASSERT_EMT_RETURN(pVCpu, rc) AssertReturn(VMCPU_IS_EMT(pVCpu), (rc))
788	#elif defined(IN_RING0)
789	# define VMCPU_ASSERT_EMT_RETURN(pVCpu, rc) AssertReturn(VMCPU_IS_EMT(pVCpu), (rc))
790	#else
791	# define VMCPU_ASSERT_EMT_RETURN(pVCpu, rc) \
792	AssertMsgReturn(VMCPU_IS_EMT(pVCpu), \
793	("Not emulation thread! Thread=%RTnthrd ThreadEMT=%RTnthrd idCpu=%#x\n", \
794	RTThreadNativeSelf(), (pVCpu)->hNativeThread, (pVCpu)->idCpu), \
795	(rc))
796	#endif
797
798	/** @def VMCPU_ASSERT_EMT_OR_GURU
799	* Asserts that the current thread IS the emulation thread (EMT) of the
800	* specified virtual CPU.
801	*/
802	#if defined(IN_RC) \|\| defined(IN_RING0)
803	# define VMCPU_ASSERT_EMT_OR_GURU(pVCpu) Assert( VMCPU_IS_EMT(pVCpu) \
804	\|\| pVCpu->CTX_SUFF(pVM)->enmVMState == VMSTATE_GURU_MEDITATION \
805	\|\| pVCpu->CTX_SUFF(pVM)->enmVMState == VMSTATE_GURU_MEDITATION_LS )
806	#else
807	# define VMCPU_ASSERT_EMT_OR_GURU(pVCpu) \
808	AssertMsg( VMCPU_IS_EMT(pVCpu) \
809	\|\| pVCpu->CTX_SUFF(pVM)->enmVMState == VMSTATE_GURU_MEDITATION \
810	\|\| pVCpu->CTX_SUFF(pVM)->enmVMState == VMSTATE_GURU_MEDITATION_LS, \
811	("Not emulation thread! Thread=%RTnthrd ThreadEMT=%RTnthrd idCpu=%#x\n", \
812	RTThreadNativeSelf(), (pVCpu)->hNativeThread, (pVCpu)->idCpu))
813	#endif
814
815	/** @def VMCPU_ASSERT_EMT_OR_NOT_RUNNING
816	* Asserts that the current thread IS the emulation thread (EMT) of the
817	* specified virtual CPU or the VM is not running.
818	*/
819	#if defined(IN_RC) \|\| defined(IN_RING0)
820	# define VMCPU_ASSERT_EMT_OR_NOT_RUNNING(pVCpu) \
821	Assert( VMCPU_IS_EMT(pVCpu) \
822	\|\| !VM_IS_RUNNING((pVCpu)->CTX_SUFF(pVM)) )
823	#else
824	# define VMCPU_ASSERT_EMT_OR_NOT_RUNNING(pVCpu) \
825	AssertMsg( VMCPU_IS_EMT(pVCpu) \
826	\|\| !VM_IS_RUNNING((pVCpu)->CTX_SUFF(pVM)), \
827	("Not emulation thread! Thread=%RTnthrd ThreadEMT=%RTnthrd idCpu=%#x\n", \
828	RTThreadNativeSelf(), (pVCpu)->hNativeThread, (pVCpu)->idCpu))
829	#endif
830
831	/** @def VM_IS_RUNNING
832	* Checks if the the VM is running.
833	*/
834	#define VM_IS_RUNNING(pVM) ( (pVM)->enmVMState == VMSTATE_RUNNING \
835	\|\| (pVM)->enmVMState == VMSTATE_RUNNING_LS \
836	\|\| (pVM)->enmVMState == VMSTATE_RUNNING_FT)
837
838	/** @def VM_ASSERT_IS_NOT_RUNNING
839	* Asserts that the VM is not running.
840	*/
841	#if defined(IN_RC) \|\| defined(IN_RING0)
842	#define VM_ASSERT_IS_NOT_RUNNING(pVM) Assert(!VM_IS_RUNNING(pVM))
843	#else
844	#define VM_ASSERT_IS_NOT_RUNNING(pVM) AssertMsg(!VM_IS_RUNNING(pVM), ("VM is running. enmVMState=%d\n", \
845	(pVM)->enmVMState))
846	#endif
847
848	/** @def VM_ASSERT_EMT0
849	* Asserts that the current thread IS emulation thread \#0 (EMT0).
850	*/
851	#define VM_ASSERT_EMT0(pVM) VMCPU_ASSERT_EMT(&(pVM)->aCpus[0])
852
853	/** @def VM_ASSERT_EMT0_RETURN
854	* Asserts that the current thread IS emulation thread \#0 (EMT0) and returns if
855	* it isn't.
856	*/
857	#define VM_ASSERT_EMT0_RETURN(pVM, rc) VMCPU_ASSERT_EMT_RETURN(&(pVM)->aCpus[0], (rc))
858
859
860	/**
861	* Asserts that the current thread is NOT the emulation thread.
862	*/
863	#define VM_ASSERT_OTHER_THREAD(pVM) \
864	AssertMsg(!VM_IS_EMT(pVM), ("Not other thread!!\n"))
865
866
867	/** @def VM_ASSERT_STATE
868	* Asserts a certain VM state.
869	*/
870	#define VM_ASSERT_STATE(pVM, _enmState) \
871	AssertMsg((pVM)->enmVMState == (_enmState), \
872	("state %s, expected %s\n", VMGetStateName((pVM)->enmVMState), VMGetStateName(_enmState)))
873
874	/** @def VM_ASSERT_STATE_RETURN
875	* Asserts a certain VM state and returns if it doesn't match.
876	*/
877	#define VM_ASSERT_STATE_RETURN(pVM, _enmState, rc) \
878	AssertMsgReturn((pVM)->enmVMState == (_enmState), \
879	("state %s, expected %s\n", VMGetStateName((pVM)->enmVMState), VMGetStateName(_enmState)), \
880	(rc))
881
882	/** @def VM_IS_VALID_EXT
883	* Asserts a the VM handle is valid for external access, i.e. not being destroy
884	* or terminated. */
885	#define VM_IS_VALID_EXT(pVM) \
886	( RT_VALID_ALIGNED_PTR(pVM, PAGE_SIZE) \
887	&& ( (unsigned)(pVM)->enmVMState < (unsigned)VMSTATE_DESTROYING \
888	\|\| ( (unsigned)(pVM)->enmVMState == (unsigned)VMSTATE_DESTROYING \
889	&& VM_IS_EMT(pVM))) )
890
891	/** @def VM_ASSERT_VALID_EXT_RETURN
892	* Asserts a the VM handle is valid for external access, i.e. not being
893	* destroy or terminated.
894	*/
895	#define VM_ASSERT_VALID_EXT_RETURN(pVM, rc) \
896	AssertMsgReturn(VM_IS_VALID_EXT(pVM), \
897	("pVM=%p state %s\n", (pVM), RT_VALID_ALIGNED_PTR(pVM, PAGE_SIZE) \
898	? VMGetStateName(pVM->enmVMState) : ""), \
899	(rc))
900
901	/** @def VMCPU_ASSERT_VALID_EXT_RETURN
902	* Asserts a the VMCPU handle is valid for external access, i.e. not being
903	* destroy or terminated.
904	*/
905	#define VMCPU_ASSERT_VALID_EXT_RETURN(pVCpu, rc) \
906	AssertMsgReturn( RT_VALID_ALIGNED_PTR(pVCpu, 64) \
907	&& RT_VALID_ALIGNED_PTR((pVCpu)->CTX_SUFF(pVM), PAGE_SIZE) \
908	&& (unsigned)(pVCpu)->CTX_SUFF(pVM)->enmVMState < (unsigned)VMSTATE_DESTROYING, \
909	("pVCpu=%p pVM=%p state %s\n", (pVCpu), RT_VALID_ALIGNED_PTR(pVCpu, 64) ? (pVCpu)->CTX_SUFF(pVM) : NULL, \
910	RT_VALID_ALIGNED_PTR(pVCpu, 64) && RT_VALID_ALIGNED_PTR((pVCpu)->CTX_SUFF(pVM), PAGE_SIZE) \
911	? VMGetStateName((pVCpu)->pVMR3->enmVMState) : ""), \
912	(rc))
913
914	#endif /* !VBOX_FOR_DTRACE_LIB */
915
916
917
918	/**
919	* The cross context VM structure.
920	*
921	* It contains all the VM data which have to be available in all contexts.
922	* Even if it contains all the data the idea is to use APIs not to modify all
923	* the members all around the place. Therefore we make use of unions to hide
924	* everything which isn't local to the current source module. This means we'll
925	* have to pay a little bit of attention when adding new members to structures
926	* in the unions and make sure to keep the padding sizes up to date.
927	*
928	* Run 'kmk run-struct-tests' (from src/VBox/VMM if you like) after updating!
929	*/
930	typedef struct VM
931	{
932	/** The state of the VM.
933	* This field is read only to everyone except the VM and EM. */
934	VMSTATE volatile enmVMState;
935	/** Forced action flags.
936	* See the VM_FF_* \#defines. Updated atomically.
937	*/
938	volatile uint32_t fGlobalForcedActions;
939	/** Pointer to the array of page descriptors for the VM structure allocation. */
940	R3PTRTYPE(PSUPPAGE) paVMPagesR3;
941	/** Session handle. For use when calling SUPR0 APIs. */
942	PSUPDRVSESSION pSession;
943	/** Pointer to the ring-3 VM structure. */
944	PUVM pUVM;
945	/** Ring-3 Host Context VM Pointer. */
946	R3PTRTYPE(struct VM *) pVMR3;
947	/** Ring-0 Host Context VM Pointer. */
948	R0PTRTYPE(struct VM *) pVMR0;
949	/** Raw-mode Context VM Pointer. */
950	RCPTRTYPE(struct VM *) pVMRC;
951
952	/** The GVM VM handle. Only the GVM should modify this field. */
953	uint32_t hSelf;
954	/** Number of virtual CPUs. */
955	uint32_t cCpus;
956	/** CPU excution cap (1-100) */
957	uint32_t uCpuExecutionCap;
958
959	/** Size of the VM structure including the VMCPU array. */
960	uint32_t cbSelf;
961
962	/** Offset to the VMCPU array starting from beginning of this structure. */
963	uint32_t offVMCPU;
964
965	/**
966	* VMMSwitcher assembly entry point returning to host context.
967	*
968	* Depending on how the host handles the rc status given in @a eax, this may
969	* return and let the caller resume whatever it was doing prior to the call.
970	*
971	*
972	* @param eax The return code, register.
973	* @remark Assume interrupts disabled.
974	* @remark This method pointer lives here because TRPM needs it.
975	*/
976	RTRCPTR pfnVMMRCToHostAsm/(int32_t eax)/;
977
978	/**
979	* VMMSwitcher assembly entry point returning to host context without saving the
980	* raw-mode context (hyper) registers.
981	*
982	* Unlike pfnVMMRC2HCAsm, this will not return to the caller. Instead it
983	* expects the caller to save a RC context in CPUM where one might return if the
984	* return code indicate that this is possible.
985	*
986	* This method pointer lives here because TRPM needs it.
987	*
988	* @param eax The return code, register.
989	* @remark Assume interrupts disabled.
990	* @remark This method pointer lives here because TRPM needs it.
991	*/
992	RTRCPTR pfnVMMRCToHostAsmNoReturn/(int32_t eax)/;
993
994	/** @name Various items that are frequently accessed.
995	* @{ */
996	/** Whether to recompile user mode code or run it raw/hm. */
997	bool fRecompileUser;
998	/** Whether to recompile supervisor mode code or run it raw/hm. */
999	bool fRecompileSupervisor;
1000	/** Whether raw mode supports ring-1 code or not. */
1001	bool fRawRing1Enabled;
1002	/** PATM enabled flag.
1003	* This is placed here for performance reasons. */
1004	bool fPATMEnabled;
1005	/** CSAM enabled flag.
1006	* This is placed here for performance reasons. */
1007	bool fCSAMEnabled;
1008	/** Hardware VM support is available and enabled.
1009	* Determined very early during init.
1010	* This is placed here for performance reasons. */
1011	bool fHMEnabled;
1012	/** For asserting on fHMEnable usage. */
1013	bool fHMEnabledFixed;
1014	/** Hardware VM support requires a minimal raw-mode context.
1015	* This is never set on 64-bit hosts, only 32-bit hosts requires it. */
1016	bool fHMNeedRawModeCtx;
1017	/** Set when this VM is the master FT node.
1018	* @todo This doesn't need to be here, FTM should store it in it's own
1019	* structures instead. */
1020	bool fFaultTolerantMaster;
1021	/** Large page enabled flag.
1022	* @todo This doesn't need to be here, PGM should store it in it's own
1023	* structures instead. */
1024	bool fUseLargePages;
1025	/** @} */
1026
1027	/** Alignment padding. */
1028	uint8_t uPadding1[2];
1029
1030	/** @name Debugging
1031	* @{ */
1032	/** Raw-mode Context VM Pointer. */
1033	RCPTRTYPE(RTTRACEBUF) hTraceBufRC;
1034	/** Ring-3 Host Context VM Pointer. */
1035	R3PTRTYPE(RTTRACEBUF) hTraceBufR3;
1036	/** Ring-0 Host Context VM Pointer. */
1037	R0PTRTYPE(RTTRACEBUF) hTraceBufR0;
1038	/** @} */
1039
1040	#if HC_ARCH_BITS == 32
1041	/** Alignment padding. */
1042	uint32_t uPadding2;
1043	#endif
1044
1045	/** @name Switcher statistics (remove)
1046	* @{ */
1047	/** Profiling the total time from Qemu to GC. */
1048	STAMPROFILEADV StatTotalQemuToGC;
1049	/** Profiling the total time from GC to Qemu. */
1050	STAMPROFILEADV StatTotalGCToQemu;
1051	/** Profiling the total time spent in GC. */
1052	STAMPROFILEADV StatTotalInGC;
1053	/** Profiling the total time spent not in Qemu. */
1054	STAMPROFILEADV StatTotalInQemu;
1055	/** Profiling the VMMSwitcher code for going to GC. */
1056	STAMPROFILEADV StatSwitcherToGC;
1057	/** Profiling the VMMSwitcher code for going to HC. */
1058	STAMPROFILEADV StatSwitcherToHC;
1059	STAMPROFILEADV StatSwitcherSaveRegs;
1060	STAMPROFILEADV StatSwitcherSysEnter;
1061	STAMPROFILEADV StatSwitcherDebug;
1062	STAMPROFILEADV StatSwitcherCR0;
1063	STAMPROFILEADV StatSwitcherCR4;
1064	STAMPROFILEADV StatSwitcherJmpCR3;
1065	STAMPROFILEADV StatSwitcherRstrRegs;
1066	STAMPROFILEADV StatSwitcherLgdt;
1067	STAMPROFILEADV StatSwitcherLidt;
1068	STAMPROFILEADV StatSwitcherLldt;
1069	STAMPROFILEADV StatSwitcherTSS;
1070	/** @} */
1071
1072	/** Padding - the unions must be aligned on a 64 bytes boundary and the unions
1073	* must start at the same offset on both 64-bit and 32-bit hosts. */
1074	uint8_t abAlignment3[(HC_ARCH_BITS == 32 ? 24 : 0) + 40];
1075
1076	/** CPUM part. */
1077	union
1078	{
1079	#ifdef ___CPUMInternal_h
1080	struct CPUM s;
1081	#endif
1082	#ifdef ___VBox_vmm_cpum_h
1083	/** Read only info exposed about the host and guest CPUs. */
1084	struct
1085	{
1086	/** Padding for hidden fields. */
1087	uint8_t abHidden0[64];
1088	/** Host CPU feature information. */
1089	CPUMFEATURES HostFeatures;
1090	/** Guest CPU feature information. */
1091	CPUMFEATURES GuestFeatures;
1092	} const ro;
1093	#endif
1094	uint8_t padding[1536]; /* multiple of 64 */
1095	} cpum;
1096
1097	/** VMM part. */
1098	union
1099	{
1100	#ifdef ___VMMInternal_h
1101	struct VMM s;
1102	#endif
1103	uint8_t padding[1600]; /* multiple of 64 */
1104	} vmm;
1105
1106	/** PGM part. */
1107	union
1108	{
1109	#ifdef ___PGMInternal_h
1110	struct PGM s;
1111	#endif
1112	uint8_t padding[40962+6080]; / multiple of 64 */
1113	} pgm;
1114
1115	/** HM part. */
1116	union
1117	{
1118	#ifdef ___HMInternal_h
1119	struct HM s;
1120	#endif
1121	uint8_t padding[5440]; /* multiple of 64 */
1122	} hm;
1123
1124	/** TRPM part. */
1125	union
1126	{
1127	#ifdef ___TRPMInternal_h
1128	struct TRPM s;
1129	#endif
1130	uint8_t padding[5248]; /* multiple of 64 */
1131	} trpm;
1132
1133	/** SELM part. */
1134	union
1135	{
1136	#ifdef ___SELMInternal_h
1137	struct SELM s;
1138	#endif
1139	uint8_t padding[768]; /* multiple of 64 */
1140	} selm;
1141
1142	/** MM part. */
1143	union
1144	{
1145	#ifdef ___MMInternal_h
1146	struct MM s;
1147	#endif
1148	uint8_t padding[192]; /* multiple of 64 */
1149	} mm;
1150
1151	/** PDM part. */
1152	union
1153	{
1154	#ifdef ___PDMInternal_h
1155	struct PDM s;
1156	#endif
1157	uint8_t padding[1920]; /* multiple of 64 */
1158	} pdm;
1159
1160	/** IOM part. */
1161	union
1162	{
1163	#ifdef ___IOMInternal_h
1164	struct IOM s;
1165	#endif
1166	uint8_t padding[896]; /* multiple of 64 */
1167	} iom;
1168
1169	/** EM part. */
1170	union
1171	{
1172	#ifdef ___EMInternal_h
1173	struct EM s;
1174	#endif
1175	uint8_t padding[256]; /* multiple of 64 */
1176	} em;
1177
1178	/** TM part. */
1179	union
1180	{
1181	#ifdef ___TMInternal_h
1182	struct TM s;
1183	#endif
1184	uint8_t padding[2496]; /* multiple of 64 */
1185	} tm;
1186
1187	/** DBGF part. */
1188	union
1189	{
1190	#ifdef ___DBGFInternal_h
1191	struct DBGF s;
1192	#endif
1193	#ifdef ___VBox_vmm_dbgf_h
1194	/** Read only info exposed about interrupt breakpoints and selected events. */
1195	struct
1196	{
1197	/** Bitmap of enabled hardware interrupt breakpoints. */
1198	uint32_t bmHardIntBreakpoints[256 / 32];
1199	/** Bitmap of enabled software interrupt breakpoints. */
1200	uint32_t bmSoftIntBreakpoints[256 / 32];
1201	/** Bitmap of selected events.
1202	* This includes non-selectable events too for simplicity, we maintain the
1203	* state for some of these, as it may come in handy. */
1204	uint64_t bmSelectedEvents[(DBGFEVENT_END + 63) / 64];
1205	/** Enabled hardware interrupt breakpoints. */
1206	uint32_t cHardIntBreakpoints;
1207	/** Enabled software interrupt breakpoints. */
1208	uint32_t cSoftIntBreakpoints;
1209	/** Number of selected events. */
1210	uint32_t cSelectedEvents;
1211	} const ro;
1212	#endif
1213	uint8_t padding[2368]; /* multiple of 64 */
1214	} dbgf;
1215
1216	/** SSM part. */
1217	union
1218	{
1219	#ifdef ___SSMInternal_h
1220	struct SSM s;
1221	#endif
1222	uint8_t padding[128]; /* multiple of 64 */
1223	} ssm;
1224
1225	/** FTM part. */
1226	union
1227	{
1228	#ifdef ___FTMInternal_h
1229	struct FTM s;
1230	#endif
1231	uint8_t padding[512]; /* multiple of 64 */
1232	} ftm;
1233
1234	#ifdef VBOX_WITH_RAW_MODE
1235	/** PATM part. */
1236	union
1237	{
1238	# ifdef ___PATMInternal_h
1239	struct PATM s;
1240	# endif
1241	uint8_t padding[768]; /* multiple of 64 */
1242	} patm;
1243
1244	/** CSAM part. */
1245	union
1246	{
1247	# ifdef ___CSAMInternal_h
1248	struct CSAM s;
1249	# endif
1250	uint8_t padding[1088]; /* multiple of 64 */
1251	} csam;
1252	#endif
1253
1254	#ifdef VBOX_WITH_REM
1255	/** REM part. */
1256	union
1257	{
1258	# ifdef ___REMInternal_h
1259	struct REM s;
1260	# endif
1261	uint8_t padding[0x11100]; /* multiple of 64 */
1262	} rem;
1263	#endif
1264
1265	union
1266	{
1267	#ifdef ___GIMInternal_h
1268	struct GIM s;
1269	#endif
1270	uint8_t padding[448]; /* multiple of 64 */
1271	} gim;
1272
1273	union
1274	{
1275	#ifdef ___APICInternal_h
1276	struct APIC s;
1277	#endif
1278	uint8_t padding[128]; /* multiple of 8 */
1279	} apic;
1280
1281	/* ---- begin small stuff ---- */
1282
1283	/** VM part. */
1284	union
1285	{
1286	#ifdef ___VMInternal_h
1287	struct VMINT s;
1288	#endif
1289	uint8_t padding[24]; /* multiple of 8 */
1290	} vm;
1291
1292	/** CFGM part. */
1293	union
1294	{
1295	#ifdef ___CFGMInternal_h
1296	struct CFGM s;
1297	#endif
1298	uint8_t padding[8]; /* multiple of 8 */
1299	} cfgm;
1300
1301	/** Padding for aligning the cpu array on a page boundary. */
1302	#if defined(VBOX_WITH_REM) && defined(VBOX_WITH_RAW_MODE)
1303	uint8_t abAlignment2[3870];
1304	#elif defined(VBOX_WITH_REM) && !defined(VBOX_WITH_RAW_MODE)
1305	uint8_t abAlignment2[1630];
1306	#elif !defined(VBOX_WITH_REM) && defined(VBOX_WITH_RAW_MODE)
1307	uint8_t abAlignment2[30];
1308	#else
1309	uint8_t abAlignment2[1886];
1310	#endif
1311
1312	/* ---- end small stuff ---- */
1313
1314	/** VMCPU array for the configured number of virtual CPUs.
1315	* Must be aligned on a page boundary for TLB hit reasons as well as
1316	* alignment of VMCPU members. */
1317	VMCPU aCpus[1];
1318	} VM;
1319
1320
1321	#ifdef IN_RC
1322	RT_C_DECLS_BEGIN
1323
1324	/** The VM structure.
1325	* This is imported from the VMMRCBuiltin module, i.e. it's a one of those magic
1326	* globals which we should avoid using.
1327	*/
1328	extern DECLIMPORT(VM) g_VM;
1329
1330	RT_C_DECLS_END
1331	#endif
1332
1333	/** @} */
1334
1335	#endif
1336

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

source: vbox/trunk/include/VBox/vmm/vm.h@ 62958

Download in other formats: