vmm.h@ 81605

Last change on this file since 81605 was 81519, checked in by vboxsync, 5 years ago
DevSmc,PDM: Converted the SMC device to the new style. Converted PDMDevHlpCallR0 to use PDMDEVREGR0::pfnRequest and ditch the inefficient symbol resolving stuff. The SMC device was the only user I could find for this helper. bugref:9218
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 21.4 KB

Line
1	/** @file
2	* VMM - The Virtual Machine Monitor.
3	*/
4
5	/*
6	* Copyright (C) 2006-2019 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	/** Acquire the PDM lock. */
58	VMMCALLRING3_PDM_LOCK,
59	/** Acquire the critical section specified as argument. */
60	VMMCALLRING3_PDM_CRIT_SECT_ENTER,
61	/** Enter the R/W critical section (in argument) exclusively. */
62	VMMCALLRING3_PDM_CRIT_SECT_RW_ENTER_EXCL,
63	/** Enter the R/W critical section (in argument) shared. */
64	VMMCALLRING3_PDM_CRIT_SECT_RW_ENTER_SHARED,
65	/** Acquire the PGM lock. */
66	VMMCALLRING3_PGM_LOCK,
67	/** Grow the PGM shadow page pool. */
68	VMMCALLRING3_PGM_POOL_GROW,
69	/** Maps a chunk into ring-3. */
70	VMMCALLRING3_PGM_MAP_CHUNK,
71	/** Allocates more handy pages. */
72	VMMCALLRING3_PGM_ALLOCATE_HANDY_PAGES,
73	/** Allocates a large (2MB) page. */
74	VMMCALLRING3_PGM_ALLOCATE_LARGE_HANDY_PAGE,
75	/** Acquire the MM hypervisor heap lock. */
76	VMMCALLRING3_MMHYPER_LOCK,
77	/** Flush the GC/R0 logger. */
78	VMMCALLRING3_VMM_LOGGER_FLUSH,
79	/** Set the VM error message. */
80	VMMCALLRING3_VM_SET_ERROR,
81	/** Set the VM runtime error message. */
82	VMMCALLRING3_VM_SET_RUNTIME_ERROR,
83	/** Signal a ring 0 assertion. */
84	VMMCALLRING3_VM_R0_ASSERTION,
85	/** Ring switch to force preemption. This is also used by PDMCritSect to
86	* handle VERR_INTERRUPTED in kernel context. */
87	VMMCALLRING3_VM_R0_PREEMPT,
88	/** The usual 32-bit hack. */
89	VMMCALLRING3_32BIT_HACK = 0x7fffffff
90	} VMMCALLRING3;
91
92	/**
93	* VMMRZCallRing3 notification callback.
94	*
95	* @returns VBox status code.
96	* @param pVCpu The cross context virtual CPU structure.
97	* @param enmOperation The operation causing the ring-3 jump.
98	* @param pvUser The user argument.
99	*/
100	typedef DECLCALLBACK(int) FNVMMR0CALLRING3NOTIFICATION(PVMCPUCC pVCpu, VMMCALLRING3 enmOperation, void *pvUser);
101	/** Pointer to a FNRTMPNOTIFICATION(). */
102	typedef FNVMMR0CALLRING3NOTIFICATION *PFNVMMR0CALLRING3NOTIFICATION;
103
104	/**
105	* Rendezvous callback.
106	*
107	* @returns VBox strict status code - EM scheduling. Do not return
108	* informational status code other than the ones used by EM for
109	* scheduling.
110	*
111	* @param pVM The cross context VM structure.
112	* @param pVCpu The cross context virtual CPU structure of the calling EMT.
113	* @param pvUser The user argument.
114	*/
115	typedef DECLCALLBACK(VBOXSTRICTRC) FNVMMEMTRENDEZVOUS(PVM pVM, PVMCPU pVCpu, void *pvUser);
116	/** Pointer to a rendezvous callback function. */
117	typedef FNVMMEMTRENDEZVOUS *PFNVMMEMTRENDEZVOUS;
118
119	/**
120	* Method table that the VMM uses to call back the user of the VMM.
121	*/
122	typedef struct VMM2USERMETHODS
123	{
124	/** Magic value (VMM2USERMETHODS_MAGIC). */
125	uint32_t u32Magic;
126	/** Structure version (VMM2USERMETHODS_VERSION). */
127	uint32_t u32Version;
128
129	/**
130	* Save the VM state.
131	*
132	* @returns VBox status code.
133	* @param pThis Pointer to the callback method table.
134	* @param pUVM The user mode VM handle.
135	*
136	* @remarks This member shall be set to NULL if the operation is not
137	* supported.
138	*/
139	DECLR3CALLBACKMEMBER(int, pfnSaveState,(PCVMM2USERMETHODS pThis, PUVM pUVM));
140	/** @todo Move pfnVMAtError and pfnCFGMConstructor here? */
141
142	/**
143	* EMT initialization notification callback.
144	*
145	* This is intended for doing per-thread initialization for EMTs (like COM
146	* init).
147	*
148	* @param pThis Pointer to the callback method table.
149	* @param pUVM The user mode VM handle.
150	* @param pUVCpu The user mode virtual CPU handle.
151	*
152	* @remarks This is optional and shall be set to NULL if not wanted.
153	*/
154	DECLR3CALLBACKMEMBER(void, pfnNotifyEmtInit,(PCVMM2USERMETHODS pThis, PUVM pUVM, PUVMCPU pUVCpu));
155
156	/**
157	* EMT termination notification callback.
158	*
159	* This is intended for doing per-thread cleanups for EMTs (like COM).
160	*
161	* @param pThis Pointer to the callback method table.
162	* @param pUVM The user mode VM handle.
163	* @param pUVCpu The user mode virtual CPU handle.
164	*
165	* @remarks This is optional and shall be set to NULL if not wanted.
166	*/
167	DECLR3CALLBACKMEMBER(void, pfnNotifyEmtTerm,(PCVMM2USERMETHODS pThis, PUVM pUVM, PUVMCPU pUVCpu));
168
169	/**
170	* PDM thread initialization notification callback.
171	*
172	* This is intended for doing per-thread initialization (like COM init).
173	*
174	* @param pThis Pointer to the callback method table.
175	* @param pUVM The user mode VM handle.
176	*
177	* @remarks This is optional and shall be set to NULL if not wanted.
178	*/
179	DECLR3CALLBACKMEMBER(void, pfnNotifyPdmtInit,(PCVMM2USERMETHODS pThis, PUVM pUVM));
180
181	/**
182	* EMT termination notification callback.
183	*
184	* This is intended for doing per-thread cleanups for EMTs (like COM).
185	*
186	* @param pThis Pointer to the callback method table.
187	* @param pUVM The user mode VM handle.
188	*
189	* @remarks This is optional and shall be set to NULL if not wanted.
190	*/
191	DECLR3CALLBACKMEMBER(void, pfnNotifyPdmtTerm,(PCVMM2USERMETHODS pThis, PUVM pUVM));
192
193	/**
194	* Notification callback that that a VM reset will be turned into a power off.
195	*
196	* @param pThis Pointer to the callback method table.
197	* @param pUVM The user mode VM handle.
198	*
199	* @remarks This is optional and shall be set to NULL if not wanted.
200	*/
201	DECLR3CALLBACKMEMBER(void, pfnNotifyResetTurnedIntoPowerOff,(PCVMM2USERMETHODS pThis, PUVM pUVM));
202
203	/**
204	* Generic object query by UUID.
205	*
206	* @returns pointer to queried the object on success, NULL if not found.
207	*
208	* @param pThis Pointer to the callback method table.
209	* @param pUVM The user mode VM handle.
210	* @param pUuid The UUID of what's being queried. The UUIDs and the
211	* usage conventions are defined by the user.
212	*
213	* @remarks This is optional and shall be set to NULL if not wanted.
214	*/
215	DECLR3CALLBACKMEMBER(void *, pfnQueryGenericObject,(PCVMM2USERMETHODS pThis, PUVM pUVM, PCRTUUID pUuid));
216
217	/** Magic value (VMM2USERMETHODS_MAGIC) marking the end of the structure. */
218	uint32_t u32EndMagic;
219	} VMM2USERMETHODS;
220
221	/** Magic value of the VMM2USERMETHODS (Franz Kafka). */
222	#define VMM2USERMETHODS_MAGIC UINT32_C(0x18830703)
223	/** The VMM2USERMETHODS structure version. */
224	#define VMM2USERMETHODS_VERSION UINT32_C(0x00030000)
225
226
227	/**
228	* Checks whether we've armed the ring-0 long jump machinery.
229	*
230	* @returns @c true / @c false
231	* @param a_pVCpu The caller's cross context virtual CPU structure.
232	* @thread EMT
233	* @sa VMMR0IsLongJumpArmed
234	*/
235	#ifdef IN_RING0
236	# define VMMIsLongJumpArmed(a_pVCpu) VMMR0IsLongJumpArmed(a_pVCpu)
237	#else
238	# define VMMIsLongJumpArmed(a_pVCpu) (false)
239	#endif
240
241
242	VMMDECL(VMCPUID) VMMGetCpuId(PVMCC pVM);
243	VMMDECL(PVMCPUCC) VMMGetCpu(PVMCC pVM);
244	VMMDECL(PVMCPUCC) VMMGetCpu0(PVMCC pVM);
245	VMMDECL(PVMCPUCC) VMMGetCpuById(PVMCC pVM, VMCPUID idCpu);
246	VMMR3DECL(PVMCPUCC) VMMR3GetCpuByIdU(PUVM pVM, VMCPUID idCpu);
247	VMM_INT_DECL(uint32_t) VMMGetSvnRev(void);
248	VMM_INT_DECL(bool) VMMIsInRing3Call(PVMCPUCC pVCpu);
249	VMM_INT_DECL(void) VMMTrashVolatileXMMRegs(void);
250
251
252	/** @defgroup grp_vmm_api_r0 The VMM Host Context Ring 0 API
253	* @{
254	*/
255
256	/**
257	* The VMMR0Entry() codes.
258	*/
259	typedef enum VMMR0OPERATION
260	{
261	/** Run guest code using the available hardware acceleration technology. */
262	VMMR0_DO_HM_RUN = SUP_VMMR0_DO_HM_RUN,
263	/** Official NOP that we use for profiling. */
264	VMMR0_DO_NEM_RUN = SUP_VMMR0_DO_NEM_RUN,
265	/** Official NOP that we use for profiling. */
266	VMMR0_DO_NOP = SUP_VMMR0_DO_NOP,
267	/** Official slow iocl NOP that we use for profiling. */
268	VMMR0_DO_SLOW_NOP,
269
270	/** Ask the GVMM to create a new VM. */
271	VMMR0_DO_GVMM_CREATE_VM = 32,
272	/** Ask the GVMM to destroy the VM. */
273	VMMR0_DO_GVMM_DESTROY_VM,
274	/** Call GVMMR0RegisterVCpu(). */
275	VMMR0_DO_GVMM_REGISTER_VMCPU,
276	/** Call GVMMR0DeregisterVCpu(). */
277	VMMR0_DO_GVMM_DEREGISTER_VMCPU,
278	/** Call GVMMR0SchedHalt(). */
279	VMMR0_DO_GVMM_SCHED_HALT,
280	/** Call GVMMR0SchedWakeUp(). */
281	VMMR0_DO_GVMM_SCHED_WAKE_UP,
282	/** Call GVMMR0SchedPoke(). */
283	VMMR0_DO_GVMM_SCHED_POKE,
284	/** Call GVMMR0SchedWakeUpAndPokeCpus(). */
285	VMMR0_DO_GVMM_SCHED_WAKE_UP_AND_POKE_CPUS,
286	/** Call GVMMR0SchedPoll(). */
287	VMMR0_DO_GVMM_SCHED_POLL,
288	/** Call GVMMR0QueryStatistics(). */
289	VMMR0_DO_GVMM_QUERY_STATISTICS,
290	/** Call GVMMR0ResetStatistics(). */
291	VMMR0_DO_GVMM_RESET_STATISTICS,
292
293	/** Call VMMR0 Per VM Init. */
294	VMMR0_DO_VMMR0_INIT = 64,
295	/** Call VMMR0 Per VM EMT Init */
296	VMMR0_DO_VMMR0_INIT_EMT,
297	/** Call VMMR0 Per VM Termination. */
298	VMMR0_DO_VMMR0_TERM,
299
300	/** Setup hardware-assisted VM session. */
301	VMMR0_DO_HM_SETUP_VM = 128,
302	/** Attempt to enable or disable hardware-assisted mode. */
303	VMMR0_DO_HM_ENABLE,
304
305	/** Call PGMR0PhysAllocateHandyPages(). */
306	VMMR0_DO_PGM_ALLOCATE_HANDY_PAGES = 192,
307	/** Call PGMR0PhysFlushHandyPages(). */
308	VMMR0_DO_PGM_FLUSH_HANDY_PAGES,
309	/** Call PGMR0AllocateLargePage(). */
310	VMMR0_DO_PGM_ALLOCATE_LARGE_HANDY_PAGE,
311	/** Call PGMR0PhysSetupIommu(). */
312	VMMR0_DO_PGM_PHYS_SETUP_IOMMU,
313
314	/** Call GMMR0InitialReservation(). */
315	VMMR0_DO_GMM_INITIAL_RESERVATION = 256,
316	/** Call GMMR0UpdateReservation(). */
317	VMMR0_DO_GMM_UPDATE_RESERVATION,
318	/** Call GMMR0AllocatePages(). */
319	VMMR0_DO_GMM_ALLOCATE_PAGES,
320	/** Call GMMR0FreePages(). */
321	VMMR0_DO_GMM_FREE_PAGES,
322	/** Call GMMR0FreeLargePage(). */
323	VMMR0_DO_GMM_FREE_LARGE_PAGE,
324	/** Call GMMR0QueryHypervisorMemoryStatsReq(). */
325	VMMR0_DO_GMM_QUERY_HYPERVISOR_MEM_STATS,
326	/** Call GMMR0QueryMemoryStatsReq(). */
327	VMMR0_DO_GMM_QUERY_MEM_STATS,
328	/** Call GMMR0BalloonedPages(). */
329	VMMR0_DO_GMM_BALLOONED_PAGES,
330	/** Call GMMR0MapUnmapChunk(). */
331	VMMR0_DO_GMM_MAP_UNMAP_CHUNK,
332	/** Call GMMR0SeedChunk(). */
333	VMMR0_DO_GMM_SEED_CHUNK,
334	/** Call GMMR0RegisterSharedModule. */
335	VMMR0_DO_GMM_REGISTER_SHARED_MODULE,
336	/** Call GMMR0UnregisterSharedModule. */
337	VMMR0_DO_GMM_UNREGISTER_SHARED_MODULE,
338	/** Call GMMR0ResetSharedModules. */
339	VMMR0_DO_GMM_RESET_SHARED_MODULES,
340	/** Call GMMR0CheckSharedModules. */
341	VMMR0_DO_GMM_CHECK_SHARED_MODULES,
342	/** Call GMMR0FindDuplicatePage. */
343	VMMR0_DO_GMM_FIND_DUPLICATE_PAGE,
344	/** Call GMMR0QueryStatistics(). */
345	VMMR0_DO_GMM_QUERY_STATISTICS,
346	/** Call GMMR0ResetStatistics(). */
347	VMMR0_DO_GMM_RESET_STATISTICS,
348
349	/** Call PDMR0DriverCallReqHandler. */
350	VMMR0_DO_PDM_DRIVER_CALL_REQ_HANDLER = 320,
351	/** Call PDMR0DeviceCreateReqHandler. */
352	VMMR0_DO_PDM_DEVICE_CREATE,
353	/** Call PDMR0DeviceGenCallReqHandler. */
354	VMMR0_DO_PDM_DEVICE_GEN_CALL,
355	/** Old style device compat: Set ring-0 critical section. */
356	VMMR0_DO_PDM_DEVICE_COMPAT_SET_CRITSECT,
357
358	/** Set a GVMM or GMM configuration value. */
359	VMMR0_DO_GCFGM_SET_VALUE = 400,
360	/** Query a GVMM or GMM configuration value. */
361	VMMR0_DO_GCFGM_QUERY_VALUE,
362
363	/** The start of the R0 service operations. */
364	VMMR0_DO_SRV_START = 448,
365	/** Call IntNetR0Open(). */
366	VMMR0_DO_INTNET_OPEN,
367	/** Call IntNetR0IfClose(). */
368	VMMR0_DO_INTNET_IF_CLOSE,
369	/** Call IntNetR0IfGetBufferPtrs(). */
370	VMMR0_DO_INTNET_IF_GET_BUFFER_PTRS,
371	/** Call IntNetR0IfSetPromiscuousMode(). */
372	VMMR0_DO_INTNET_IF_SET_PROMISCUOUS_MODE,
373	/** Call IntNetR0IfSetMacAddress(). */
374	VMMR0_DO_INTNET_IF_SET_MAC_ADDRESS,
375	/** Call IntNetR0IfSetActive(). */
376	VMMR0_DO_INTNET_IF_SET_ACTIVE,
377	/** Call IntNetR0IfSend(). */
378	VMMR0_DO_INTNET_IF_SEND,
379	/** Call IntNetR0IfWait(). */
380	VMMR0_DO_INTNET_IF_WAIT,
381	/** Call IntNetR0IfAbortWait(). */
382	VMMR0_DO_INTNET_IF_ABORT_WAIT,
383
384	/** Forward call to the PCI driver */
385	VMMR0_DO_PCIRAW_REQ = 512,
386
387	/** The end of the R0 service operations. */
388	VMMR0_DO_SRV_END,
389
390	/** Call NEMR0InitVM() (host specific). */
391	VMMR0_DO_NEM_INIT_VM = 576,
392	/** Call NEMR0InitVMPart2() (host specific). */
393	VMMR0_DO_NEM_INIT_VM_PART_2,
394	/** Call NEMR0MapPages() (host specific). */
395	VMMR0_DO_NEM_MAP_PAGES,
396	/** Call NEMR0UnmapPages() (host specific). */
397	VMMR0_DO_NEM_UNMAP_PAGES,
398	/** Call NEMR0ExportState() (host specific). */
399	VMMR0_DO_NEM_EXPORT_STATE,
400	/** Call NEMR0ImportState() (host specific). */
401	VMMR0_DO_NEM_IMPORT_STATE,
402	/** Call NEMR0QueryCpuTick() (host specific). */
403	VMMR0_DO_NEM_QUERY_CPU_TICK,
404	/** Call NEMR0ResumeCpuTickOnAll() (host specific). */
405	VMMR0_DO_NEM_RESUME_CPU_TICK_ON_ALL,
406	/** Call NEMR0UpdateStatistics() (host specific). */
407	VMMR0_DO_NEM_UPDATE_STATISTICS,
408	/** Call NEMR0DoExperiment() (host specific, experimental, debug only). */
409	VMMR0_DO_NEM_EXPERIMENT,
410
411	/** Grow the I/O port registration tables. */
412	VMMR0_DO_IOM_GROW_IO_PORTS = 640,
413	/** Grow the I/O port statistics tables. */
414	VMMR0_DO_IOM_GROW_IO_PORT_STATS,
415	/** Grow the MMIO registration tables. */
416	VMMR0_DO_IOM_GROW_MMIO_REGS,
417	/** Grow the MMIO statistics tables. */
418	VMMR0_DO_IOM_GROW_MMIO_STATS,
419	/** Synchronize statistics indices for I/O ports and MMIO regions. */
420	VMMR0_DO_IOM_SYNC_STATS_INDICES,
421
422	/** Official call we use for testing Ring-0 APIs. */
423	VMMR0_DO_TESTS = 704,
424
425	/** The usual 32-bit type blow up. */
426	VMMR0_DO_32BIT_HACK = 0x7fffffff
427	} VMMR0OPERATION;
428
429
430	/**
431	* Request buffer for VMMR0_DO_GCFGM_SET_VALUE and VMMR0_DO_GCFGM_QUERY_VALUE.
432	* @todo Move got GCFGM.h when it's implemented.
433	*/
434	typedef struct GCFGMVALUEREQ
435	{
436	/** The request header.*/
437	SUPVMMR0REQHDR Hdr;
438	/** The support driver session handle. */
439	PSUPDRVSESSION pSession;
440	/** The value.
441	* This is input for the set request and output for the query. */
442	uint64_t u64Value;
443	/** The variable name.
444	* This is fixed sized just to make things simple for the mock-up. */
445	char szName[48];
446	} GCFGMVALUEREQ;
447	/** Pointer to a VMMR0_DO_GCFGM_SET_VALUE and VMMR0_DO_GCFGM_QUERY_VALUE request buffer.
448	* @todo Move got GCFGM.h when it's implemented.
449	*/
450	typedef GCFGMVALUEREQ *PGCFGMVALUEREQ;
451
452	#if defined(IN_RING0) \|\| defined(DOXYGEN_RUNNING)
453	VMMR0DECL(void) VMMR0EntryFast(PGVM pGVM, PVMCC pVM, VMCPUID idCpu, VMMR0OPERATION enmOperation);
454	VMMR0DECL(int) VMMR0EntryEx(PGVM pGVM, PVMCC pVM, VMCPUID idCpu, VMMR0OPERATION enmOperation,
455	PSUPVMMR0REQHDR pReq, uint64_t u64Arg, PSUPDRVSESSION);
456	VMMR0_INT_DECL(int) VMMR0TermVM(PGVM pGVM, VMCPUID idCpu);
457	VMMR0_INT_DECL(bool) VMMR0IsLongJumpArmed(PVMCPUCC pVCpu);
458	VMMR0_INT_DECL(bool) VMMR0IsInRing3LongJump(PVMCPUCC pVCpu);
459	VMMR0_INT_DECL(int) VMMR0ThreadCtxHookCreateForEmt(PVMCPUCC pVCpu);
460	VMMR0_INT_DECL(void) VMMR0ThreadCtxHookDestroyForEmt(PVMCPUCC pVCpu);
461	VMMR0_INT_DECL(void) VMMR0ThreadCtxHookDisable(PVMCPUCC pVCpu);
462	VMMR0_INT_DECL(bool) VMMR0ThreadCtxHookIsEnabled(PVMCPUCC pVCpu);
463
464	# ifdef LOG_ENABLED
465	VMMR0_INT_DECL(void) VMMR0LogFlushDisable(PVMCPUCC pVCpu);
466	VMMR0_INT_DECL(void) VMMR0LogFlushEnable(PVMCPUCC pVCpu);
467	VMMR0_INT_DECL(bool) VMMR0IsLogFlushDisabled(PVMCPUCC pVCpu);
468	# else
469	# define VMMR0LogFlushDisable(pVCpu) do { } while(0)
470	# define VMMR0LogFlushEnable(pVCpu) do { } while(0)
471	# define VMMR0IsLogFlushDisabled(pVCpu) (true)
472	# endif /* LOG_ENABLED */
473	#endif /* IN_RING0 */
474
475	/** @} */
476
477
478	#if defined(IN_RING3) \|\| defined(DOXYGEN_RUNNING)
479	/** @defgroup grp_vmm_api_r3 The VMM Host Context Ring 3 API
480	* @{
481	*/
482	VMMR3_INT_DECL(int) VMMR3Init(PVM pVM);
483	VMMR3_INT_DECL(int) VMMR3InitR0(PVM pVM);
484	VMMR3_INT_DECL(int) VMMR3InitCompleted(PVM pVM, VMINITCOMPLETED enmWhat);
485	VMMR3_INT_DECL(int) VMMR3Term(PVM pVM);
486	VMMR3_INT_DECL(void) VMMR3Relocate(PVM pVM, RTGCINTPTR offDelta);
487	VMMR3_INT_DECL(int) VMMR3UpdateLoggers(PVM pVM);
488	VMMR3DECL(const char *) VMMR3GetRZAssertMsg1(PVM pVM);
489	VMMR3DECL(const char *) VMMR3GetRZAssertMsg2(PVM pVM);
490	VMMR3_INT_DECL(int) VMMR3HmRunGC(PVM pVM, PVMCPU pVCpu);
491	VMMR3DECL(int) VMMR3CallR0(PVM pVM, uint32_t uOperation, uint64_t u64Arg, PSUPVMMR0REQHDR pReqHdr);
492	VMMR3_INT_DECL(int) VMMR3CallR0Emt(PVM pVM, PVMCPU pVCpu, VMMR0OPERATION enmOperation, uint64_t u64Arg, PSUPVMMR0REQHDR pReqHdr);
493	VMMR3_INT_DECL(VBOXSTRICTRC) VMMR3CallR0EmtFast(PVM pVM, PVMCPU pVCpu, VMMR0OPERATION enmOperation);
494	VMMR3DECL(void) VMMR3FatalDump(PVM pVM, PVMCPU pVCpu, int rcErr);
495	VMMR3_INT_DECL(void) VMMR3YieldSuspend(PVM pVM);
496	VMMR3_INT_DECL(void) VMMR3YieldStop(PVM pVM);
497	VMMR3_INT_DECL(void) VMMR3YieldResume(PVM pVM);
498	VMMR3_INT_DECL(void) VMMR3SendStartupIpi(PVM pVM, VMCPUID idCpu, uint32_t uVector);
499	VMMR3_INT_DECL(void) VMMR3SendInitIpi(PVM pVM, VMCPUID idCpu);
500	VMMR3DECL(int) VMMR3RegisterPatchMemory(PVM pVM, RTGCPTR pPatchMem, unsigned cbPatchMem);
501	VMMR3DECL(int) VMMR3DeregisterPatchMemory(PVM pVM, RTGCPTR pPatchMem, unsigned cbPatchMem);
502	VMMR3DECL(int) VMMR3EmtRendezvous(PVM pVM, uint32_t fFlags, PFNVMMEMTRENDEZVOUS pfnRendezvous, void *pvUser);
503	/** @defgroup grp_VMMR3EmtRendezvous_fFlags VMMR3EmtRendezvous flags
504	* @{ */
505	/** Execution type mask. */
506	#define VMMEMTRENDEZVOUS_FLAGS_TYPE_MASK UINT32_C(0x00000007)
507	/** Invalid execution type. */
508	#define VMMEMTRENDEZVOUS_FLAGS_TYPE_INVALID UINT32_C(0)
509	/** Let the EMTs execute the callback one by one (in no particular order).
510	* Recursion from within the callback possible. */
511	#define VMMEMTRENDEZVOUS_FLAGS_TYPE_ONE_BY_ONE UINT32_C(1)
512	/** Let all the EMTs execute the callback at the same time.
513	* Cannot recurse from the callback. */
514	#define VMMEMTRENDEZVOUS_FLAGS_TYPE_ALL_AT_ONCE UINT32_C(2)
515	/** Only execute the callback on one EMT (no particular one).
516	* Recursion from within the callback possible. */
517	#define VMMEMTRENDEZVOUS_FLAGS_TYPE_ONCE UINT32_C(3)
518	/** Let the EMTs execute the callback one by one in ascending order.
519	* Recursion from within the callback possible. */
520	#define VMMEMTRENDEZVOUS_FLAGS_TYPE_ASCENDING UINT32_C(4)
521	/** Let the EMTs execute the callback one by one in descending order.
522	* Recursion from within the callback possible. */
523	#define VMMEMTRENDEZVOUS_FLAGS_TYPE_DESCENDING UINT32_C(5)
524	/** Stop after the first error.
525	* This is not valid for any execution type where more than one EMT is active
526	* at a time. */
527	#define VMMEMTRENDEZVOUS_FLAGS_STOP_ON_ERROR UINT32_C(0x00000008)
528	/** Use VMREQFLAGS_PRIORITY when contacting the EMTs. */
529	#define VMMEMTRENDEZVOUS_FLAGS_PRIORITY UINT32_C(0x00000010)
530	/** The valid flags. */
531	#define VMMEMTRENDEZVOUS_FLAGS_VALID_MASK UINT32_C(0x0000001f)
532	/** @} */
533	VMMR3_INT_DECL(int) VMMR3EmtRendezvousFF(PVM pVM, PVMCPU pVCpu);
534	VMMR3_INT_DECL(void) VMMR3SetMayHaltInRing0(PVMCPU pVCpu, bool fMayHaltInRing0, uint32_t cNsSpinBlockThreshold);
535	VMMR3_INT_DECL(int) VMMR3ReadR0Stack(PVM pVM, VMCPUID idCpu, RTHCUINTPTR R0Addr, void *pvBuf, size_t cbRead);
536	VMMR3_INT_DECL(void) VMMR3InitR0StackUnwindState(PUVM pUVM, VMCPUID idCpu, PRTDBGUNWINDSTATE pState);
537	/** @} */
538	#endif /* IN_RING3 */
539
540
541	#if defined(IN_RC) \|\| defined(IN_RING0) \|\| defined(DOXYGEN_RUNNING)
542	/** @defgroup grp_vmm_api_rz The VMM Raw-Mode and Ring-0 Context API
543	* @{
544	*/
545	VMMRZDECL(int) VMMRZCallRing3(PVMCC pVMCC, PVMCPUCC pVCpu, VMMCALLRING3 enmOperation, uint64_t uArg);
546	VMMRZDECL(int) VMMRZCallRing3NoCpu(PVMCC pVM, VMMCALLRING3 enmOperation, uint64_t uArg);
547	VMMRZDECL(void) VMMRZCallRing3Disable(PVMCPUCC pVCpu);
548	VMMRZDECL(void) VMMRZCallRing3Enable(PVMCPUCC pVCpu);
549	VMMRZDECL(bool) VMMRZCallRing3IsEnabled(PVMCPUCC pVCpu);
550	VMMRZDECL(int) VMMRZCallRing3SetNotification(PVMCPUCC pVCpu, R0PTRTYPE(PFNVMMR0CALLRING3NOTIFICATION) pfnCallback, RTR0PTR pvUser);
551	VMMRZDECL(void) VMMRZCallRing3RemoveNotification(PVMCPUCC pVCpu);
552	VMMRZDECL(bool) VMMRZCallRing3IsNotificationSet(PVMCPUCC pVCpu);
553	/** @} */
554	#endif
555
556
557	/** @} */
558
559	/** @} */
560	RT_C_DECLS_END
561
562	#endif /* !VBOX_INCLUDED_vmm_vmm_h */

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

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

Download in other formats: