vmm.h@ 92248

Last change on this file since 92248 was 92248, checked in by vboxsync, 3 years ago
VMM/GMM: Removed all the legacy mode code (disabled everywhere since r146982). bugref:10093
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 24.1 KB

Line
1	/** @file
2	* VMM - The Virtual Machine Monitor.
3	*/
4
5	/*
6	* Copyright (C) 2006-2020 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_INCLUDED_vmm_vmm_h
27	#define VBOX_INCLUDED_vmm_vmm_h
28	#ifndef RT_WITHOUT_PRAGMA_ONCE
29	# pragma once
30	#endif
31
32	#include <VBox/types.h>
33	#include <VBox/vmm/vmapi.h>
34	#include <VBox/sup.h>
35	#include <VBox/log.h>
36	#include <iprt/stdarg.h>
37	#include <iprt/thread.h>
38
39	RT_C_DECLS_BEGIN
40
41	/** @defgroup grp_vmm The Virtual Machine Monitor
42	* @{
43	*/
44
45	/** @defgroup grp_vmm_api The Virtual Machine Monitor API
46	* @{
47	*/
48
49
50	/**
51	* VMMRZCallRing3 operations.
52	*/
53	typedef enum VMMCALLRING3
54	{
55	/** Invalid operation. */
56	VMMCALLRING3_INVALID = 0,
57	/** Signal a ring 0 assertion. */
58	VMMCALLRING3_VM_R0_ASSERTION,
59
60	/** Allocates more handy pages. */
61	VMMCALLRING3_PGM_ALLOCATE_HANDY_PAGES,
62	/** Allocates a large (2MB) page. */
63	VMMCALLRING3_PGM_ALLOCATE_LARGE_HANDY_PAGE,
64	/** The usual 32-bit hack. */
65	VMMCALLRING3_32BIT_HACK = 0x7fffffff
66	} VMMCALLRING3;
67
68	/**
69	* VMMRZCallRing3 notification callback.
70	*
71	* @returns VBox status code.
72	* @param pVCpu The cross context virtual CPU structure.
73	* @param enmOperation The operation causing the ring-3 jump.
74	* @param pvUser The user argument.
75	*/
76	typedef DECLCALLBACKTYPE(int, FNVMMR0CALLRING3NOTIFICATION,(PVMCPUCC pVCpu, VMMCALLRING3 enmOperation, void *pvUser));
77	/** Pointer to a FNRTMPNOTIFICATION(). */
78	typedef FNVMMR0CALLRING3NOTIFICATION *PFNVMMR0CALLRING3NOTIFICATION;
79
80	/**
81	* Rendezvous callback.
82	*
83	* @returns VBox strict status code - EM scheduling. Do not return
84	* informational status code other than the ones used by EM for
85	* scheduling.
86	*
87	* @param pVM The cross context VM structure.
88	* @param pVCpu The cross context virtual CPU structure of the calling EMT.
89	* @param pvUser The user argument.
90	*/
91	typedef DECLCALLBACKTYPE(VBOXSTRICTRC, FNVMMEMTRENDEZVOUS,(PVM pVM, PVMCPU pVCpu, void *pvUser));
92	/** Pointer to a rendezvous callback function. */
93	typedef FNVMMEMTRENDEZVOUS *PFNVMMEMTRENDEZVOUS;
94
95	/**
96	* Method table that the VMM uses to call back the user of the VMM.
97	*/
98	typedef struct VMM2USERMETHODS
99	{
100	/** Magic value (VMM2USERMETHODS_MAGIC). */
101	uint32_t u32Magic;
102	/** Structure version (VMM2USERMETHODS_VERSION). */
103	uint32_t u32Version;
104
105	/**
106	* Save the VM state.
107	*
108	* @returns VBox status code.
109	* @param pThis Pointer to the callback method table.
110	* @param pUVM The user mode VM handle.
111	*
112	* @remarks This member shall be set to NULL if the operation is not
113	* supported.
114	*/
115	DECLR3CALLBACKMEMBER(int, pfnSaveState,(PCVMM2USERMETHODS pThis, PUVM pUVM));
116	/** @todo Move pfnVMAtError and pfnCFGMConstructor here? */
117
118	/**
119	* EMT initialization notification callback.
120	*
121	* This is intended for doing per-thread initialization for EMTs (like COM
122	* init).
123	*
124	* @param pThis Pointer to the callback method table.
125	* @param pUVM The user mode VM handle.
126	* @param pUVCpu The user mode virtual CPU handle.
127	*
128	* @remarks This is optional and shall be set to NULL if not wanted.
129	*/
130	DECLR3CALLBACKMEMBER(void, pfnNotifyEmtInit,(PCVMM2USERMETHODS pThis, PUVM pUVM, PUVMCPU pUVCpu));
131
132	/**
133	* EMT termination notification callback.
134	*
135	* This is intended for doing per-thread cleanups for EMTs (like COM).
136	*
137	* @param pThis Pointer to the callback method table.
138	* @param pUVM The user mode VM handle.
139	* @param pUVCpu The user mode virtual CPU handle.
140	*
141	* @remarks This is optional and shall be set to NULL if not wanted.
142	*/
143	DECLR3CALLBACKMEMBER(void, pfnNotifyEmtTerm,(PCVMM2USERMETHODS pThis, PUVM pUVM, PUVMCPU pUVCpu));
144
145	/**
146	* PDM thread initialization notification callback.
147	*
148	* This is intended for doing per-thread initialization (like COM init).
149	*
150	* @param pThis Pointer to the callback method table.
151	* @param pUVM The user mode VM handle.
152	*
153	* @remarks This is optional and shall be set to NULL if not wanted.
154	*/
155	DECLR3CALLBACKMEMBER(void, pfnNotifyPdmtInit,(PCVMM2USERMETHODS pThis, PUVM pUVM));
156
157	/**
158	* EMT termination notification callback.
159	*
160	* This is intended for doing per-thread cleanups for EMTs (like COM).
161	*
162	* @param pThis Pointer to the callback method table.
163	* @param pUVM The user mode VM handle.
164	*
165	* @remarks This is optional and shall be set to NULL if not wanted.
166	*/
167	DECLR3CALLBACKMEMBER(void, pfnNotifyPdmtTerm,(PCVMM2USERMETHODS pThis, PUVM pUVM));
168
169	/**
170	* Notification callback that that a VM reset will be turned into a power off.
171	*
172	* @param pThis Pointer to the callback method table.
173	* @param pUVM The user mode VM handle.
174	*
175	* @remarks This is optional and shall be set to NULL if not wanted.
176	*/
177	DECLR3CALLBACKMEMBER(void, pfnNotifyResetTurnedIntoPowerOff,(PCVMM2USERMETHODS pThis, PUVM pUVM));
178
179	/**
180	* Generic object query by UUID.
181	*
182	* @returns pointer to queried the object on success, NULL if not found.
183	*
184	* @param pThis Pointer to the callback method table.
185	* @param pUVM The user mode VM handle.
186	* @param pUuid The UUID of what's being queried. The UUIDs and the
187	* usage conventions are defined by the user.
188	*
189	* @remarks This is optional and shall be set to NULL if not wanted.
190	*/
191	DECLR3CALLBACKMEMBER(void *, pfnQueryGenericObject,(PCVMM2USERMETHODS pThis, PUVM pUVM, PCRTUUID pUuid));
192
193	/** Magic value (VMM2USERMETHODS_MAGIC) marking the end of the structure. */
194	uint32_t u32EndMagic;
195	} VMM2USERMETHODS;
196
197	/** Magic value of the VMM2USERMETHODS (Franz Kafka). */
198	#define VMM2USERMETHODS_MAGIC UINT32_C(0x18830703)
199	/** The VMM2USERMETHODS structure version. */
200	#define VMM2USERMETHODS_VERSION UINT32_C(0x00030000)
201
202
203	/**
204	* Checks whether we've armed the ring-0 long jump machinery.
205	*
206	* @returns @c true / @c false
207	* @param a_pVCpu The caller's cross context virtual CPU structure.
208	* @thread EMT
209	* @sa VMMR0IsLongJumpArmed
210	*/
211	#ifdef IN_RING0
212	# define VMMIsLongJumpArmed(a_pVCpu) VMMR0IsLongJumpArmed(a_pVCpu)
213	#else
214	# define VMMIsLongJumpArmed(a_pVCpu) (false)
215	#endif
216
217
218	VMMDECL(VMCPUID) VMMGetCpuId(PVMCC pVM);
219	VMMDECL(PVMCPUCC) VMMGetCpu(PVMCC pVM);
220	VMMDECL(PVMCPUCC) VMMGetCpu0(PVMCC pVM);
221	VMMDECL(PVMCPUCC) VMMGetCpuById(PVMCC pVM, VMCPUID idCpu);
222	VMMR3DECL(PVMCPUCC) VMMR3GetCpuByIdU(PUVM pVM, VMCPUID idCpu);
223	VMM_INT_DECL(uint32_t) VMMGetSvnRev(void);
224	VMM_INT_DECL(bool) VMMIsInRing3Call(PVMCPUCC pVCpu);
225	VMM_INT_DECL(void) VMMTrashVolatileXMMRegs(void);
226
227
228	/** @defgroup grp_vmm_api_r0 The VMM Host Context Ring 0 API
229	* @{
230	*/
231
232	/**
233	* The VMMR0Entry() codes.
234	*/
235	typedef enum VMMR0OPERATION
236	{
237	/** Run guest code using the available hardware acceleration technology. */
238	VMMR0_DO_HM_RUN = SUP_VMMR0_DO_HM_RUN,
239	/** Official NOP that we use for profiling. */
240	VMMR0_DO_NEM_RUN = SUP_VMMR0_DO_NEM_RUN,
241	/** Official NOP that we use for profiling. */
242	VMMR0_DO_NOP = SUP_VMMR0_DO_NOP,
243	/** Official slow iocl NOP that we use for profiling. */
244	VMMR0_DO_SLOW_NOP,
245
246	/** Ask the GVMM to create a new VM. */
247	VMMR0_DO_GVMM_CREATE_VM = 32,
248	/** Ask the GVMM to destroy the VM. */
249	VMMR0_DO_GVMM_DESTROY_VM,
250	/** Call GVMMR0RegisterVCpu(). */
251	VMMR0_DO_GVMM_REGISTER_VMCPU,
252	/** Call GVMMR0DeregisterVCpu(). */
253	VMMR0_DO_GVMM_DEREGISTER_VMCPU,
254	/** Call GVMMR0RegisterWorkerThread(). */
255	VMMR0_DO_GVMM_REGISTER_WORKER_THREAD,
256	/** Call GVMMR0DeregisterWorkerThread(). */
257	VMMR0_DO_GVMM_DEREGISTER_WORKER_THREAD,
258	/** Call GVMMR0SchedHalt(). */
259	VMMR0_DO_GVMM_SCHED_HALT,
260	/** Call GVMMR0SchedWakeUp(). */
261	VMMR0_DO_GVMM_SCHED_WAKE_UP,
262	/** Call GVMMR0SchedPoke(). */
263	VMMR0_DO_GVMM_SCHED_POKE,
264	/** Call GVMMR0SchedWakeUpAndPokeCpus(). */
265	VMMR0_DO_GVMM_SCHED_WAKE_UP_AND_POKE_CPUS,
266	/** Call GVMMR0SchedPoll(). */
267	VMMR0_DO_GVMM_SCHED_POLL,
268	/** Call GVMMR0QueryStatistics(). */
269	VMMR0_DO_GVMM_QUERY_STATISTICS,
270	/** Call GVMMR0ResetStatistics(). */
271	VMMR0_DO_GVMM_RESET_STATISTICS,
272
273	/** Call VMMR0 Per VM Init. */
274	VMMR0_DO_VMMR0_INIT = 64,
275	/** Call VMMR0 Per VM EMT Init */
276	VMMR0_DO_VMMR0_INIT_EMT,
277	/** Call VMMR0 Per VM Termination. */
278	VMMR0_DO_VMMR0_TERM,
279	/** Copy logger settings from userland, VMMR0UpdateLoggersReq(). */
280	VMMR0_DO_VMMR0_UPDATE_LOGGERS,
281	/** Used by the log flusher, VMMR0LogFlusher. */
282	VMMR0_DO_VMMR0_LOG_FLUSHER,
283	/** Used by EMTs to wait for the log flusher to finish, VMMR0LogWaitFlushed. */
284	VMMR0_DO_VMMR0_LOG_WAIT_FLUSHED,
285
286	/** Setup hardware-assisted VM session. */
287	VMMR0_DO_HM_SETUP_VM = 128,
288	/** Attempt to enable or disable hardware-assisted mode. */
289	VMMR0_DO_HM_ENABLE,
290
291	/** Call PGMR0PhysAllocateHandyPages(). */
292	VMMR0_DO_PGM_ALLOCATE_HANDY_PAGES = 192,
293	/** Call PGMR0PhysFlushHandyPages(). */
294	VMMR0_DO_PGM_FLUSH_HANDY_PAGES,
295	/** Call PGMR0AllocateLargePage(). */
296	VMMR0_DO_PGM_ALLOCATE_LARGE_HANDY_PAGE,
297	/** Call PGMR0PhysSetupIommu(). */
298	VMMR0_DO_PGM_PHYS_SETUP_IOMMU,
299	/** Call PGMR0PoolGrow(). */
300	VMMR0_DO_PGM_POOL_GROW,
301
302	/** Call GMMR0InitialReservation(). */
303	VMMR0_DO_GMM_INITIAL_RESERVATION = 256,
304	/** Call GMMR0UpdateReservation(). */
305	VMMR0_DO_GMM_UPDATE_RESERVATION,
306	/** Call GMMR0AllocatePages(). */
307	VMMR0_DO_GMM_ALLOCATE_PAGES,
308	/** Call GMMR0FreePages(). */
309	VMMR0_DO_GMM_FREE_PAGES,
310	/** Call GMMR0FreeLargePage(). */
311	VMMR0_DO_GMM_FREE_LARGE_PAGE,
312	/** Call GMMR0QueryHypervisorMemoryStatsReq(). */
313	VMMR0_DO_GMM_QUERY_HYPERVISOR_MEM_STATS,
314	/** Call GMMR0QueryMemoryStatsReq(). */
315	VMMR0_DO_GMM_QUERY_MEM_STATS,
316	/** Call GMMR0BalloonedPages(). */
317	VMMR0_DO_GMM_BALLOONED_PAGES,
318	/** Call GMMR0MapUnmapChunk(). */
319	VMMR0_DO_GMM_MAP_UNMAP_CHUNK,
320	/** Call GMMR0RegisterSharedModule. */
321	VMMR0_DO_GMM_REGISTER_SHARED_MODULE,
322	/** Call GMMR0UnregisterSharedModule. */
323	VMMR0_DO_GMM_UNREGISTER_SHARED_MODULE,
324	/** Call GMMR0ResetSharedModules. */
325	VMMR0_DO_GMM_RESET_SHARED_MODULES,
326	/** Call GMMR0CheckSharedModules. */
327	VMMR0_DO_GMM_CHECK_SHARED_MODULES,
328	/** Call GMMR0FindDuplicatePage. */
329	VMMR0_DO_GMM_FIND_DUPLICATE_PAGE,
330	/** Call GMMR0QueryStatistics(). */
331	VMMR0_DO_GMM_QUERY_STATISTICS,
332	/** Call GMMR0ResetStatistics(). */
333	VMMR0_DO_GMM_RESET_STATISTICS,
334
335	/** Call PDMR0DriverCallReqHandler. */
336	VMMR0_DO_PDM_DRIVER_CALL_REQ_HANDLER = 320,
337	/** Call PDMR0DeviceCreateReqHandler. */
338	VMMR0_DO_PDM_DEVICE_CREATE,
339	/** Call PDMR0DeviceGenCallReqHandler. */
340	VMMR0_DO_PDM_DEVICE_GEN_CALL,
341	/** Old style device compat: Set ring-0 critical section. */
342	VMMR0_DO_PDM_DEVICE_COMPAT_SET_CRITSECT,
343
344	/** Set a GVMM or GMM configuration value. */
345	VMMR0_DO_GCFGM_SET_VALUE = 400,
346	/** Query a GVMM or GMM configuration value. */
347	VMMR0_DO_GCFGM_QUERY_VALUE,
348
349	/** The start of the R0 service operations. */
350	VMMR0_DO_SRV_START = 448,
351	/** Call IntNetR0Open(). */
352	VMMR0_DO_INTNET_OPEN,
353	/** Call IntNetR0IfClose(). */
354	VMMR0_DO_INTNET_IF_CLOSE,
355	/** Call IntNetR0IfGetBufferPtrs(). */
356	VMMR0_DO_INTNET_IF_GET_BUFFER_PTRS,
357	/** Call IntNetR0IfSetPromiscuousMode(). */
358	VMMR0_DO_INTNET_IF_SET_PROMISCUOUS_MODE,
359	/** Call IntNetR0IfSetMacAddress(). */
360	VMMR0_DO_INTNET_IF_SET_MAC_ADDRESS,
361	/** Call IntNetR0IfSetActive(). */
362	VMMR0_DO_INTNET_IF_SET_ACTIVE,
363	/** Call IntNetR0IfSend(). */
364	VMMR0_DO_INTNET_IF_SEND,
365	/** Call IntNetR0IfWait(). */
366	VMMR0_DO_INTNET_IF_WAIT,
367	/** Call IntNetR0IfAbortWait(). */
368	VMMR0_DO_INTNET_IF_ABORT_WAIT,
369
370	#if 0
371	/** Forward call to the PCI driver */
372	VMMR0_DO_PCIRAW_REQ = 512,
373	#endif
374
375	/** The end of the R0 service operations. */
376	VMMR0_DO_SRV_END,
377
378	/** Call NEMR0InitVM() (host specific). */
379	VMMR0_DO_NEM_INIT_VM = 576,
380	/** Call NEMR0InitVMPart2() (host specific). */
381	VMMR0_DO_NEM_INIT_VM_PART_2,
382	/** Call NEMR0MapPages() (host specific). */
383	VMMR0_DO_NEM_MAP_PAGES,
384	/** Call NEMR0UnmapPages() (host specific). */
385	VMMR0_DO_NEM_UNMAP_PAGES,
386	/** Call NEMR0ExportState() (host specific). */
387	VMMR0_DO_NEM_EXPORT_STATE,
388	/** Call NEMR0ImportState() (host specific). */
389	VMMR0_DO_NEM_IMPORT_STATE,
390	/** Call NEMR0QueryCpuTick() (host specific). */
391	VMMR0_DO_NEM_QUERY_CPU_TICK,
392	/** Call NEMR0ResumeCpuTickOnAll() (host specific). */
393	VMMR0_DO_NEM_RESUME_CPU_TICK_ON_ALL,
394	/** Call NEMR0UpdateStatistics() (host specific). */
395	VMMR0_DO_NEM_UPDATE_STATISTICS,
396	/** Call NEMR0DoExperiment() (host specific, experimental, debug only). */
397	VMMR0_DO_NEM_EXPERIMENT,
398
399	/** Grow the I/O port registration tables. */
400	VMMR0_DO_IOM_GROW_IO_PORTS = 640,
401	/** Grow the I/O port statistics tables. */
402	VMMR0_DO_IOM_GROW_IO_PORT_STATS,
403	/** Grow the MMIO registration tables. */
404	VMMR0_DO_IOM_GROW_MMIO_REGS,
405	/** Grow the MMIO statistics tables. */
406	VMMR0_DO_IOM_GROW_MMIO_STATS,
407	/** Synchronize statistics indices for I/O ports and MMIO regions. */
408	VMMR0_DO_IOM_SYNC_STATS_INDICES,
409
410	/** Call DBGFR0TraceCreateReqHandler. */
411	VMMR0_DO_DBGF_TRACER_CREATE = 704,
412	/** Call DBGFR0TraceCallReqHandler. */
413	VMMR0_DO_DBGF_TRACER_CALL_REQ_HANDLER,
414	/** Call DBGFR0BpInitReqHandler(). */
415	VMMR0_DO_DBGF_BP_INIT,
416	/** Call DBGFR0BpChunkAllocReqHandler(). */
417	VMMR0_DO_DBGF_BP_CHUNK_ALLOC,
418	/** Call DBGFR0BpL2TblChunkAllocReqHandler(). */
419	VMMR0_DO_DBGF_BP_L2_TBL_CHUNK_ALLOC,
420	/** Call DBGFR0BpOwnerInitReqHandler(). */
421	VMMR0_DO_DBGF_BP_OWNER_INIT,
422	/** Call DBGFR0BpPortIoInitReqHandler(). */
423	VMMR0_DO_DBGF_BP_PORTIO_INIT,
424
425	/** Grow a timer queue. */
426	VMMR0_DO_TM_GROW_TIMER_QUEUE = 768,
427
428	/** Official call we use for testing Ring-0 APIs. */
429	VMMR0_DO_TESTS = 2048,
430
431	/** The usual 32-bit type blow up. */
432	VMMR0_DO_32BIT_HACK = 0x7fffffff
433	} VMMR0OPERATION;
434
435
436	/**
437	* Request buffer for VMMR0_DO_GCFGM_SET_VALUE and VMMR0_DO_GCFGM_QUERY_VALUE.
438	* @todo Move got GCFGM.h when it's implemented.
439	*/
440	typedef struct GCFGMVALUEREQ
441	{
442	/** The request header.*/
443	SUPVMMR0REQHDR Hdr;
444	/** The support driver session handle. */
445	PSUPDRVSESSION pSession;
446	/** The value.
447	* This is input for the set request and output for the query. */
448	uint64_t u64Value;
449	/** The variable name.
450	* This is fixed sized just to make things simple for the mock-up. */
451	char szName[48];
452	} GCFGMVALUEREQ;
453	/** Pointer to a VMMR0_DO_GCFGM_SET_VALUE and VMMR0_DO_GCFGM_QUERY_VALUE request buffer.
454	* @todo Move got GCFGM.h when it's implemented.
455	*/
456	typedef GCFGMVALUEREQ *PGCFGMVALUEREQ;
457
458
459	/**
460	* Request package for VMMR0_DO_VMMR0_UPDATE_LOGGERS.
461	*
462	* In addition the u64Arg selects the logger sets: @c false for debug, @c true
463	* for release.
464	*/
465	typedef struct VMMR0UPDATELOGGERSREQ
466	{
467	/** The request header. */
468	SUPVMMR0REQHDR Hdr;
469	/** The current logger flags (RTLOGFLAGS). */
470	uint64_t fFlags;
471	/** Groups, assuming same group layout as ring-3. */
472	uint32_t cGroups;
473	/** CRC32 of the group names. */
474	uint32_t uGroupCrc32;
475	/** Per-group settings, variable size. */
476	RT_FLEXIBLE_ARRAY_EXTENSION
477	uint32_t afGroups[RT_FLEXIBLE_ARRAY];
478	} VMMR0UPDATELOGGERSREQ;
479	/** Pointer to a VMMR0_DO_VMMR0_UPDATE_LOGGERS request. */
480	typedef VMMR0UPDATELOGGERSREQ *PVMMR0UPDATELOGGERSREQ;
481
482	#if defined(IN_RING0) \|\| defined(DOXYGEN_RUNNING)
483
484	/**
485	* Structure VMMR0EmtPrepareToBlock uses to pass info to
486	* VMMR0EmtResumeAfterBlocking.
487	*/
488	typedef struct VMMR0EMTBLOCKCTX
489	{
490	/** Magic value (VMMR0EMTBLOCKCTX_MAGIC). */
491	uint32_t uMagic;
492	/** Set if we were in HM context, clear if not. */
493	bool fWasInHmContext;
494	} VMMR0EMTBLOCKCTX;
495	/** Pointer to a VMMR0EmtPrepareToBlock context structure. */
496	typedef VMMR0EMTBLOCKCTX *PVMMR0EMTBLOCKCTX;
497	/** Magic value for VMMR0EMTBLOCKCTX::uMagic (Paul Desmond). */
498	#define VMMR0EMTBLOCKCTX_MAGIC UINT32_C(0x19261125)
499	/** Magic value for VMMR0EMTBLOCKCTX::uMagic when its out of context. */
500	#define VMMR0EMTBLOCKCTX_MAGIC_DEAD UINT32_C(0x19770530)
501
502	VMMR0DECL(void) VMMR0EntryFast(PGVM pGVM, PVMCC pVM, VMCPUID idCpu, VMMR0OPERATION enmOperation);
503	VMMR0DECL(int) VMMR0EntryEx(PGVM pGVM, PVMCC pVM, VMCPUID idCpu, VMMR0OPERATION enmOperation,
504	PSUPVMMR0REQHDR pReq, uint64_t u64Arg, PSUPDRVSESSION);
505	VMMR0_INT_DECL(int) VMMR0InitPerVMData(PGVM pGVM);
506	VMMR0_INT_DECL(int) VMMR0TermVM(PGVM pGVM, VMCPUID idCpu);
507	VMMR0_INT_DECL(void) VMMR0CleanupVM(PGVM pGVM);
508	VMMR0_INT_DECL(bool) VMMR0IsLongJumpArmed(PVMCPUCC pVCpu);
509	VMMR0_INT_DECL(bool) VMMR0IsInRing3LongJump(PVMCPUCC pVCpu);
510	VMMR0_INT_DECL(int) VMMR0ThreadCtxHookCreateForEmt(PVMCPUCC pVCpu);
511	VMMR0_INT_DECL(void) VMMR0ThreadCtxHookDestroyForEmt(PVMCPUCC pVCpu);
512	VMMR0_INT_DECL(void) VMMR0ThreadCtxHookDisable(PVMCPUCC pVCpu);
513	VMMR0_INT_DECL(bool) VMMR0ThreadCtxHookIsEnabled(PVMCPUCC pVCpu);
514	VMMR0_INT_DECL(int) VMMR0EmtPrepareToBlock(PVMCPUCC pVCpu, int rcBusy, const char pszCaller, void pvLock,
515	PVMMR0EMTBLOCKCTX pCtx);
516	VMMR0_INT_DECL(void) VMMR0EmtResumeAfterBlocking(PVMCPUCC pVCpu, PVMMR0EMTBLOCKCTX pCtx);
517	VMMR0_INT_DECL(int) VMMR0EmtWaitEventInner(PGVMCPU pGVCpu, uint32_t fFlags, RTSEMEVENT hEvent, RTMSINTERVAL cMsTimeout);
518	VMMR0_INT_DECL(int) VMMR0EmtSignalSupEvent(PGVM pGVM, PGVMCPU pGVCpu, SUPSEMEVENT hEvent);
519	VMMR0_INT_DECL(int) VMMR0EmtSignalSupEventByGVM(PGVM pGVM, SUPSEMEVENT hEvent);
520
521	/** @name VMMR0EMTWAIT_F_XXX - flags for VMMR0EmtWaitEventInner and friends.
522	* @{ */
523	/** Try suppress VERR_INTERRUPTED for a little while (~10 sec). */
524	#define VMMR0EMTWAIT_F_TRY_SUPPRESS_INTERRUPTED RT_BIT_32(0)
525	/** @} */
526	#endif /* IN_RING0 */
527
528	VMMR0_INT_DECL(PRTLOGGER) VMMR0GetReleaseLogger(PVMCPUCC pVCpu);
529	/** @} */
530
531
532	#if defined(IN_RING3) \|\| defined(DOXYGEN_RUNNING)
533	/** @defgroup grp_vmm_api_r3 The VMM Host Context Ring 3 API
534	* @{
535	*/
536	VMMR3_INT_DECL(int) VMMR3Init(PVM pVM);
537	VMMR3_INT_DECL(int) VMMR3InitR0(PVM pVM);
538	VMMR3_INT_DECL(int) VMMR3InitCompleted(PVM pVM, VMINITCOMPLETED enmWhat);
539	VMMR3_INT_DECL(int) VMMR3Term(PVM pVM);
540	VMMR3_INT_DECL(void) VMMR3Relocate(PVM pVM, RTGCINTPTR offDelta);
541	VMMR3_INT_DECL(int) VMMR3UpdateLoggers(PVM pVM);
542	VMMR3DECL(const char *) VMMR3GetRZAssertMsg1(PVM pVM);
543	VMMR3DECL(const char *) VMMR3GetRZAssertMsg2(PVM pVM);
544	VMMR3_INT_DECL(int) VMMR3HmRunGC(PVM pVM, PVMCPU pVCpu);
545	VMMR3DECL(int) VMMR3CallR0(PVM pVM, uint32_t uOperation, uint64_t u64Arg, PSUPVMMR0REQHDR pReqHdr);
546	VMMR3_INT_DECL(int) VMMR3CallR0Emt(PVM pVM, PVMCPU pVCpu, VMMR0OPERATION enmOperation, uint64_t u64Arg, PSUPVMMR0REQHDR pReqHdr);
547	VMMR3_INT_DECL(VBOXSTRICTRC) VMMR3CallR0EmtFast(PVM pVM, PVMCPU pVCpu, VMMR0OPERATION enmOperation);
548	VMMR3DECL(void) VMMR3FatalDump(PVM pVM, PVMCPU pVCpu, int rcErr);
549	VMMR3_INT_DECL(void) VMMR3YieldSuspend(PVM pVM);
550	VMMR3_INT_DECL(void) VMMR3YieldStop(PVM pVM);
551	VMMR3_INT_DECL(void) VMMR3YieldResume(PVM pVM);
552	VMMR3_INT_DECL(void) VMMR3SendStartupIpi(PVM pVM, VMCPUID idCpu, uint32_t uVector);
553	VMMR3_INT_DECL(void) VMMR3SendInitIpi(PVM pVM, VMCPUID idCpu);
554	VMMR3DECL(int) VMMR3RegisterPatchMemory(PVM pVM, RTGCPTR pPatchMem, unsigned cbPatchMem);
555	VMMR3DECL(int) VMMR3DeregisterPatchMemory(PVM pVM, RTGCPTR pPatchMem, unsigned cbPatchMem);
556	VMMR3DECL(int) VMMR3EmtRendezvous(PVM pVM, uint32_t fFlags, PFNVMMEMTRENDEZVOUS pfnRendezvous, void *pvUser);
557	/** @defgroup grp_VMMR3EmtRendezvous_fFlags VMMR3EmtRendezvous flags
558	* @{ */
559	/** Execution type mask. */
560	#define VMMEMTRENDEZVOUS_FLAGS_TYPE_MASK UINT32_C(0x00000007)
561	/** Invalid execution type. */
562	#define VMMEMTRENDEZVOUS_FLAGS_TYPE_INVALID UINT32_C(0)
563	/** Let the EMTs execute the callback one by one (in no particular order).
564	* Recursion from within the callback possible. */
565	#define VMMEMTRENDEZVOUS_FLAGS_TYPE_ONE_BY_ONE UINT32_C(1)
566	/** Let all the EMTs execute the callback at the same time.
567	* Cannot recurse from the callback. */
568	#define VMMEMTRENDEZVOUS_FLAGS_TYPE_ALL_AT_ONCE UINT32_C(2)
569	/** Only execute the callback on one EMT (no particular one).
570	* Recursion from within the callback possible. */
571	#define VMMEMTRENDEZVOUS_FLAGS_TYPE_ONCE UINT32_C(3)
572	/** Let the EMTs execute the callback one by one in ascending order.
573	* Recursion from within the callback possible. */
574	#define VMMEMTRENDEZVOUS_FLAGS_TYPE_ASCENDING UINT32_C(4)
575	/** Let the EMTs execute the callback one by one in descending order.
576	* Recursion from within the callback possible. */
577	#define VMMEMTRENDEZVOUS_FLAGS_TYPE_DESCENDING UINT32_C(5)
578	/** Stop after the first error.
579	* This is not valid for any execution type where more than one EMT is active
580	* at a time. */
581	#define VMMEMTRENDEZVOUS_FLAGS_STOP_ON_ERROR UINT32_C(0x00000008)
582	/** Use VMREQFLAGS_PRIORITY when contacting the EMTs. */
583	#define VMMEMTRENDEZVOUS_FLAGS_PRIORITY UINT32_C(0x00000010)
584	/** The valid flags. */
585	#define VMMEMTRENDEZVOUS_FLAGS_VALID_MASK UINT32_C(0x0000001f)
586	/** @} */
587	VMMR3_INT_DECL(int) VMMR3EmtRendezvousFF(PVM pVM, PVMCPU pVCpu);
588	VMMR3_INT_DECL(void) VMMR3SetMayHaltInRing0(PVMCPU pVCpu, bool fMayHaltInRing0, uint32_t cNsSpinBlockThreshold);
589	VMMR3_INT_DECL(int) VMMR3ReadR0Stack(PVM pVM, VMCPUID idCpu, RTHCUINTPTR R0Addr, void *pvBuf, size_t cbRead);
590	VMMR3_INT_DECL(void) VMMR3InitR0StackUnwindState(PUVM pUVM, VMCPUID idCpu, PRTDBGUNWINDSTATE pState);
591	/** @} */
592	#endif /* IN_RING3 */
593
594
595	#if defined(IN_RC) \|\| defined(IN_RING0) \|\| defined(DOXYGEN_RUNNING)
596	/** @defgroup grp_vmm_api_rz The VMM Raw-Mode and Ring-0 Context API
597	* @{
598	*/
599	VMMRZDECL(int) VMMRZCallRing3(PVMCC pVMCC, PVMCPUCC pVCpu, VMMCALLRING3 enmOperation, uint64_t uArg);
600	VMMRZDECL(int) VMMRZCallRing3NoCpu(PVMCC pVM, VMMCALLRING3 enmOperation, uint64_t uArg);
601	VMMRZDECL(void) VMMRZCallRing3Disable(PVMCPUCC pVCpu);
602	VMMRZDECL(void) VMMRZCallRing3Enable(PVMCPUCC pVCpu);
603	VMMRZDECL(bool) VMMRZCallRing3IsEnabled(PVMCPUCC pVCpu);
604	VMMRZDECL(int) VMMRZCallRing3SetNotification(PVMCPUCC pVCpu, R0PTRTYPE(PFNVMMR0CALLRING3NOTIFICATION) pfnCallback, RTR0PTR pvUser);
605	VMMRZDECL(void) VMMRZCallRing3RemoveNotification(PVMCPUCC pVCpu);
606	VMMRZDECL(bool) VMMRZCallRing3IsNotificationSet(PVMCPUCC pVCpu);
607	/** @} */
608	#endif
609
610
611	/** Wrapper around AssertReleaseMsgReturn that avoid tripping up in the
612	* kernel when we don't have a setjmp in place. */
613	#ifdef IN_RING0
614	# define VMM_ASSERT_RELEASE_MSG_RETURN(a_pVM, a_Expr, a_Msg, a_rc) do { \
615	if (RT_LIKELY(a_Expr)) { /* likely */ } \
616	else \
617	{ \
618	PVMCPUCC pVCpuAssert = VMMGetCpu(a_pVM); \
619	if (pVCpuAssert && VMMR0IsLongJumpArmed(pVCpuAssert)) \
620	AssertReleaseMsg(a_Expr, a_Msg); \
621	else \
622	AssertLogRelMsg(a_Expr, a_Msg); \
623	return (a_rc); \
624	} \
625	} while (0)
626	#else
627	# define VMM_ASSERT_RELEASE_MSG_RETURN(a_pVM, a_Expr, a_Msg, a_rc) AssertReleaseMsgReturn(a_Expr, a_Msg, a_rc)
628	#endif
629
630	/** @} */
631
632	/** @} */
633	RT_C_DECLS_END
634
635	#endif /* !VBOX_INCLUDED_vmm_vmm_h */

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

source: vbox/trunk/include/VBox/vmm/vmm.h@ 92248

Download in other formats: