VirtualBox

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

Last change on this file since 29567 was 29521, checked in by vboxsync, 15 years ago

PDM: Added PDMDevHlpCallR0 and PDMDEV_VALIDATE_CONFIG_RETURN.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 15.4 KB
Line 
1/** @file
2 * VMM - The Virtual Machine Monitor. (VMM)
3 */
4
5/*
6 * Copyright (C) 2006-2010 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_h
27#define ___VBox_vmm_h
28
29#include <VBox/cdefs.h>
30#include <VBox/types.h>
31#include <VBox/vmapi.h>
32#include <VBox/sup.h>
33#include <VBox/log.h>
34#include <iprt/stdarg.h>
35
36RT_C_DECLS_BEGIN
37
38/** @defgroup grp_vmm The Virtual Machine Monitor API
39 * @{
40 */
41
42/**
43 * World switcher identifiers.
44 */
45typedef enum VMMSWITCHER
46{
47 /** The usual invalid 0. */
48 VMMSWITCHER_INVALID = 0,
49 /** Switcher for 32-bit host to 32-bit shadow paging. */
50 VMMSWITCHER_32_TO_32,
51 /** Switcher for 32-bit host paging to PAE shadow paging. */
52 VMMSWITCHER_32_TO_PAE,
53 /** Switcher for 32-bit host paging to AMD64 shadow paging. */
54 VMMSWITCHER_32_TO_AMD64,
55 /** Switcher for PAE host to 32-bit shadow paging. */
56 VMMSWITCHER_PAE_TO_32,
57 /** Switcher for PAE host to PAE shadow paging. */
58 VMMSWITCHER_PAE_TO_PAE,
59 /** Switcher for PAE host paging to AMD64 shadow paging. */
60 VMMSWITCHER_PAE_TO_AMD64,
61 /** Switcher for AMD64 host paging to 32-bit shadow paging. */
62 VMMSWITCHER_AMD64_TO_32,
63 /** Switcher for AMD64 host paging to PAE shadow paging. */
64 VMMSWITCHER_AMD64_TO_PAE,
65 /** Switcher for AMD64 host paging to AMD64 shadow paging. */
66 VMMSWITCHER_AMD64_TO_AMD64,
67 /** Used to make a count for array declarations and suchlike. */
68 VMMSWITCHER_MAX,
69 /** The usual 32-bit paranoia. */
70 VMMSWITCHER_32BIT_HACK = 0x7fffffff
71} VMMSWITCHER;
72
73
74/**
75 * VMMRZCallRing3 operations.
76 */
77typedef enum VMMCALLRING3
78{
79 /** Invalid operation. */
80 VMMCALLRING3_INVALID = 0,
81 /** Acquire the PDM lock. */
82 VMMCALLRING3_PDM_LOCK,
83 /** Call PDMR3QueueFlushWorker. */
84 VMMCALLRING3_PDM_QUEUE_FLUSH,
85 /** Acquire the PGM lock. */
86 VMMCALLRING3_PGM_LOCK,
87 /** Grow the PGM shadow page pool. */
88 VMMCALLRING3_PGM_POOL_GROW,
89 /** Maps a chunk into ring-3. */
90 VMMCALLRING3_PGM_MAP_CHUNK,
91 /** Allocates more handy pages. */
92 VMMCALLRING3_PGM_ALLOCATE_HANDY_PAGES,
93 /** Allocates a large (2MB) page. */
94 VMMCALLRING3_PGM_ALLOCATE_LARGE_HANDY_PAGE,
95 /** Acquire the MM hypervisor heap lock. */
96 VMMCALLRING3_MMHYPER_LOCK,
97 /** Replay the REM handler notifications. */
98 VMMCALLRING3_REM_REPLAY_HANDLER_NOTIFICATIONS,
99 /** Flush the GC/R0 logger. */
100 VMMCALLRING3_VMM_LOGGER_FLUSH,
101 /** Set the VM error message. */
102 VMMCALLRING3_VM_SET_ERROR,
103 /** Set the VM runtime error message. */
104 VMMCALLRING3_VM_SET_RUNTIME_ERROR,
105 /** Signal a ring 0 assertion. */
106 VMMCALLRING3_VM_R0_ASSERTION,
107 /** Ring switch to force preemption. */
108 VMMCALLRING3_VM_R0_PREEMPT,
109 /** The usual 32-bit hack. */
110 VMMCALLRING3_32BIT_HACK = 0x7fffffff
111} VMMCALLRING3;
112
113/**
114 * VMMR3AtomicExecuteHandler callback function.
115 *
116 * @returns VBox status code.
117 * @param pVM Pointer to the shared VM structure.
118 * @param pvUser User specified argument
119 *
120 * @todo missing prefix.
121 */
122typedef DECLCALLBACK(int) FNATOMICHANDLER(PVM pVM, void *pvUser);
123/** Pointer to a FNMMATOMICHANDLER(). */
124typedef FNATOMICHANDLER *PFNATOMICHANDLER;
125
126/**
127 * Rendezvous callback.
128 *
129 * @returns VBox strict status code - EM scheduling. Do not return
130 * informational status code other than the ones used by EM for
131 * scheduling.
132 *
133 * @param pVM The VM handle.
134 * @param pVCpu The handle of the calling virtual CPU.
135 * @param pvUser The user argument.
136 */
137typedef DECLCALLBACK(VBOXSTRICTRC) FNVMMEMTRENDEZVOUS(PVM pVM, PVMCPU pVCpu, void *pvUser);
138/** Pointer to a rendezvous callback function. */
139typedef FNVMMEMTRENDEZVOUS *PFNVMMEMTRENDEZVOUS;
140
141
142VMMDECL(RTRCPTR) VMMGetStackRC(PVM pVM);
143VMMDECL(VMCPUID) VMMGetCpuId(PVM pVM);
144VMMDECL(PVMCPU) VMMGetCpu(PVM pVM);
145VMMDECL(PVMCPU) VMMGetCpu0(PVM pVM);
146VMMDECL(PVMCPU) VMMGetCpuById(PVM pVM, VMCPUID idCpu);
147VMMDECL(uint32_t) VMMGetSvnRev(void);
148VMMDECL(VMMSWITCHER) VMMGetSwitcher(PVM pVM);
149VMMDECL(void) VMMTrashVolatileXMMRegs(void);
150
151/** @def VMMIsHwVirtExtForced
152 * Checks if forced to use the hardware assisted virtualization extensions.
153 *
154 * This is intended for making setup decisions where we can save resources when
155 * using hardware assisted virtualization.
156 *
157 * @returns true / false.
158 * @param pVM Pointer to the shared VM structure.
159 */
160#define VMMIsHwVirtExtForced(pVM) ((pVM)->fHwVirtExtForced)
161
162
163#ifdef IN_RING3
164/** @defgroup grp_vmm_r3 The VMM Host Context Ring 3 API
165 * @ingroup grp_vmm
166 * @{
167 */
168VMMR3DECL(int) VMMR3Init(PVM pVM);
169VMMR3DECL(int) VMMR3InitCPU(PVM pVM);
170VMMR3DECL(int) VMMR3InitFinalize(PVM pVM);
171VMMR3DECL(int) VMMR3InitR0(PVM pVM);
172VMMR3DECL(int) VMMR3InitRC(PVM pVM);
173VMMR3DECL(int) VMMR3Term(PVM pVM);
174VMMR3DECL(int) VMMR3TermCPU(PVM pVM);
175VMMR3DECL(void) VMMR3Relocate(PVM pVM, RTGCINTPTR offDelta);
176VMMR3DECL(int) VMMR3UpdateLoggers(PVM pVM);
177VMMR3DECL(const char *) VMMR3GetRZAssertMsg1(PVM pVM);
178VMMR3DECL(const char *) VMMR3GetRZAssertMsg2(PVM pVM);
179VMMR3DECL(int) VMMR3GetImportRC(PVM pVM, const char *pszSymbol, PRTRCPTR pRCPtrValue);
180VMMR3DECL(int) VMMR3SelectSwitcher(PVM pVM, VMMSWITCHER enmSwitcher);
181VMMR3DECL(int) VMMR3DisableSwitcher(PVM pVM);
182VMMR3DECL(RTR0PTR) VMMR3GetHostToGuestSwitcher(PVM pVM, VMMSWITCHER enmSwitcher);
183VMMR3DECL(int) VMMR3RawRunGC(PVM pVM, PVMCPU pVCpu);
184VMMR3DECL(int) VMMR3HwAccRunGC(PVM pVM, PVMCPU pVCpu);
185VMMR3DECL(int) VMMR3CallRC(PVM pVM, RTRCPTR RCPtrEntry, unsigned cArgs, ...);
186VMMR3DECL(int) VMMR3CallRCV(PVM pVM, RTRCPTR RCPtrEntry, unsigned cArgs, va_list args);
187VMMR3DECL(int) VMMR3CallR0(PVM pVM, uint32_t uOperation, uint64_t u64Arg, PSUPVMMR0REQHDR pReqHdr);
188VMMR3DECL(int) VMMR3ResumeHyper(PVM pVM, PVMCPU pVCpu);
189VMMR3DECL(void) VMMR3FatalDump(PVM pVM, PVMCPU pVCpu, int rcErr);
190VMMR3DECL(void) VMMR3YieldSuspend(PVM pVM);
191VMMR3DECL(void) VMMR3YieldStop(PVM pVM);
192VMMR3DECL(void) VMMR3YieldResume(PVM pVM);
193VMMR3DECL(void) VMMR3SendSipi(PVM pVM, VMCPUID idCpu, uint32_t uVector);
194VMMR3DECL(void) VMMR3SendInitIpi(PVM pVM, VMCPUID idCpu);
195VMMR3DECL(int) VMMR3RegisterPatchMemory(PVM pVM, RTGCPTR pPatchMem, unsigned cbPatchMem);
196VMMR3DECL(int) VMMR3DeregisterPatchMemory(PVM pVM, RTGCPTR pPatchMem, unsigned cbPatchMem);
197VMMR3DECL(int) VMMR3AtomicExecuteHandler(PVM pVM, PFNATOMICHANDLER pfnHandler, void *pvUser);
198VMMR3DECL(int) VMMR3EmtRendezvous(PVM pVM, uint32_t fFlags, PFNVMMEMTRENDEZVOUS pfnRendezvous, void *pvUser);
199/** @defgroup grp_VMMR3EmtRendezvous_fFlags VMMR3EmtRendezvous flags
200 * @{ */
201/** Execution type mask. */
202#define VMMEMTRENDEZVOUS_FLAGS_TYPE_MASK UINT32_C(0x00000007)
203/** Invalid execution type. */
204#define VMMEMTRENDEZVOUS_FLAGS_TYPE_INVALID UINT32_C(0)
205/** Let the EMTs execute the callback one by one (in no particular order). */
206#define VMMEMTRENDEZVOUS_FLAGS_TYPE_ONE_BY_ONE UINT32_C(1)
207/** Let all the EMTs execute the callback at the same time. */
208#define VMMEMTRENDEZVOUS_FLAGS_TYPE_ALL_AT_ONCE UINT32_C(2)
209/** Only execute the callback on one EMT (no particular one). */
210#define VMMEMTRENDEZVOUS_FLAGS_TYPE_ONCE UINT32_C(3)
211/** Let the EMTs execute the callback one by one in ascending order. */
212#define VMMEMTRENDEZVOUS_FLAGS_TYPE_ASCENDING UINT32_C(4)
213/** Let the EMTs execute the callback one by one in descending order. */
214#define VMMEMTRENDEZVOUS_FLAGS_TYPE_DESCENDING UINT32_C(5)
215/** Stop after the first error.
216 * This is not valid for any execution type where more than one EMT is active
217 * at a time. */
218#define VMMEMTRENDEZVOUS_FLAGS_STOP_ON_ERROR UINT32_C(0x00000008)
219/** The valid flags. */
220#define VMMEMTRENDEZVOUS_FLAGS_VALID_MASK UINT32_C(0x0000000f)
221/** @} */
222VMMR3DECL(int) VMMR3EmtRendezvousFF(PVM pVM, PVMCPU pVCpu);
223VMMR3DECL(int) VMMR3ReadR0Stack(PVM pVM, VMCPUID idCpu, RTHCUINTPTR pAddress, void *pvBuf, size_t cbRead);
224/** @} */
225#endif /* IN_RING3 */
226
227
228/** @defgroup grp_vmm_r0 The VMM Host Context Ring 0 API
229 * @ingroup grp_vmm
230 * @{
231 */
232
233/**
234 * The VMMR0Entry() codes.
235 */
236typedef enum VMMR0OPERATION
237{
238 /** Run guest context. */
239 VMMR0_DO_RAW_RUN = SUP_VMMR0_DO_RAW_RUN,
240 /** Run guest code using the available hardware acceleration technology. */
241 VMMR0_DO_HWACC_RUN = SUP_VMMR0_DO_HWACC_RUN,
242 /** Official NOP that we use for profiling. */
243 VMMR0_DO_NOP = SUP_VMMR0_DO_NOP,
244 /** Official slow iocl NOP that we use for profiling. */
245 VMMR0_DO_SLOW_NOP,
246
247 /** Ask the GVMM to create a new VM. */
248 VMMR0_DO_GVMM_CREATE_VM,
249 /** Ask the GVMM to destroy the VM. */
250 VMMR0_DO_GVMM_DESTROY_VM,
251 /** Call GVMMR0SchedHalt(). */
252 VMMR0_DO_GVMM_SCHED_HALT,
253 /** Call GVMMR0SchedWakeUp(). */
254 VMMR0_DO_GVMM_SCHED_WAKE_UP,
255 /** Call GVMMR0SchedPoke(). */
256 VMMR0_DO_GVMM_SCHED_POKE,
257 /** Call GVMMR0SchedWakeUpAndPokeCpus(). */
258 VMMR0_DO_GVMM_SCHED_WAKE_UP_AND_POKE_CPUS,
259 /** Call GVMMR0SchedPoll(). */
260 VMMR0_DO_GVMM_SCHED_POLL,
261 /** Call GVMMR0QueryStatistics(). */
262 VMMR0_DO_GVMM_QUERY_STATISTICS,
263 /** Call GVMMR0ResetStatistics(). */
264 VMMR0_DO_GVMM_RESET_STATISTICS,
265 /** Call GVMMR0RegisterVCpu(). */
266 VMMR0_DO_GVMM_REGISTER_VMCPU,
267
268 /** Call VMMR0 Per VM Init. */
269 VMMR0_DO_VMMR0_INIT,
270 /** Call VMMR0 Per VM Termination. */
271 VMMR0_DO_VMMR0_TERM,
272 /** Setup the hardware accelerated raw-mode session. */
273 VMMR0_DO_HWACC_SETUP_VM,
274 /** Attempt to enable or disable hardware accelerated raw-mode. */
275 VMMR0_DO_HWACC_ENABLE,
276 /** Calls function in the hypervisor.
277 * The caller must setup the hypervisor context so the call will be performed.
278 * The difference between VMMR0_DO_RUN_GC and this one is the handling of
279 * the return GC code. The return code will not be interpreted by this operation.
280 */
281 VMMR0_DO_CALL_HYPERVISOR,
282
283 /** Call PGMR0PhysAllocateHandyPages(). */
284 VMMR0_DO_PGM_ALLOCATE_HANDY_PAGES,
285 /** Call PGMR0AllocateLargePage(). */
286 VMMR0_DO_PGM_ALLOCATE_LARGE_HANDY_PAGE,
287
288 /** Call GMMR0InitialReservation(). */
289 VMMR0_DO_GMM_INITIAL_RESERVATION,
290 /** Call GMMR0UpdateReservation(). */
291 VMMR0_DO_GMM_UPDATE_RESERVATION,
292 /** Call GMMR0AllocatePages(). */
293 VMMR0_DO_GMM_ALLOCATE_PAGES,
294 /** Call GMMR0FreePages(). */
295 VMMR0_DO_GMM_FREE_PAGES,
296 /** Call GMMR0FreeLargePage(). */
297 VMMR0_DO_GMM_FREE_LARGE_PAGE,
298 /** Call GMMR0QueryHypervisorMemoryStatsReq(). */
299 VMMR0_DO_GMM_QUERY_HYPERVISOR_MEM_STATS,
300 /** Call GMMR0QueryMemoryStatsReq(). */
301 VMMR0_DO_GMM_QUERY_MEM_STATS,
302 /** Call GMMR0BalloonedPages(). */
303 VMMR0_DO_GMM_BALLOONED_PAGES,
304 /** Call GMMR0MapUnmapChunk(). */
305 VMMR0_DO_GMM_MAP_UNMAP_CHUNK,
306 /** Call GMMR0SeedChunk(). */
307 VMMR0_DO_GMM_SEED_CHUNK,
308 /** Call GMMR0RegisterSharedModule. */
309 VMMR0_DO_GMM_REGISTER_SHARED_MODULE,
310 /** Call GMMR0UnregisterSharedModule. */
311 VMMR0_DO_GMM_UNREGISTER_SHARED_MODULE,
312 /** Call GMMR0ResetSharedModules. */
313 VMMR0_DO_GMM_RESET_SHARED_MODULES,
314 /** Call GMMR0CheckSharedModules. */
315 VMMR0_DO_GMM_CHECK_SHARED_MODULES,
316
317 /** Set a GVMM or GMM configuration value. */
318 VMMR0_DO_GCFGM_SET_VALUE,
319 /** Query a GVMM or GMM configuration value. */
320 VMMR0_DO_GCFGM_QUERY_VALUE,
321
322 /** Call PDMR0DriverCallReqHandler. */
323 VMMR0_DO_PDM_DRIVER_CALL_REQ_HANDLER,
324 /** Call PDMR0DeviceCallReqHandler. */
325 VMMR0_DO_PDM_DEVICE_CALL_REQ_HANDLER,
326
327 /** The start of the R0 service operations. */
328 VMMR0_DO_SRV_START,
329 /** Call IntNetR0Open(). */
330 VMMR0_DO_INTNET_OPEN,
331 /** Call IntNetR0IfClose(). */
332 VMMR0_DO_INTNET_IF_CLOSE,
333 /** Call IntNetR0IfGetBufferPtrs(). */
334 VMMR0_DO_INTNET_IF_GET_BUFFER_PTRS,
335 /** Call IntNetR0IfSetPromiscuousMode(). */
336 VMMR0_DO_INTNET_IF_SET_PROMISCUOUS_MODE,
337 /** Call IntNetR0IfSetMacAddress(). */
338 VMMR0_DO_INTNET_IF_SET_MAC_ADDRESS,
339 /** Call IntNetR0IfSetActive(). */
340 VMMR0_DO_INTNET_IF_SET_ACTIVE,
341 /** Call IntNetR0IfSend(). */
342 VMMR0_DO_INTNET_IF_SEND,
343 /** Call IntNetR0IfWait(). */
344 VMMR0_DO_INTNET_IF_WAIT,
345 /** The end of the R0 service operations. */
346 VMMR0_DO_SRV_END,
347
348 /** Official call we use for testing Ring-0 APIs. */
349 VMMR0_DO_TESTS,
350 /** Test the 32->64 bits switcher. */
351 VMMR0_DO_TEST_SWITCHER3264,
352
353 /** The usual 32-bit type blow up. */
354 VMMR0_DO_32BIT_HACK = 0x7fffffff
355} VMMR0OPERATION;
356
357
358/**
359 * Request buffer for VMMR0_DO_GCFGM_SET_VALUE and VMMR0_DO_GCFGM_QUERY_VALUE.
360 * @todo Move got GCFGM.h when it's implemented.
361 */
362typedef struct GCFGMVALUEREQ
363{
364 /** The request header.*/
365 SUPVMMR0REQHDR Hdr;
366 /** The support driver session handle. */
367 PSUPDRVSESSION pSession;
368 /** The value.
369 * This is input for the set request and output for the query. */
370 uint64_t u64Value;
371 /** The variable name.
372 * This is fixed sized just to make things simple for the mock-up. */
373 char szName[48];
374} GCFGMVALUEREQ;
375/** Pointer to a VMMR0_DO_GCFGM_SET_VALUE and VMMR0_DO_GCFGM_QUERY_VALUE request buffer.
376 * @todo Move got GCFGM.h when it's implemented.
377 */
378typedef GCFGMVALUEREQ *PGCFGMVALUEREQ;
379
380VMMR0DECL(int) VMMR0EntryInt(PVM pVM, VMMR0OPERATION enmOperation, void *pvArg);
381VMMR0DECL(void) VMMR0EntryFast(PVM pVM, VMCPUID idCpu, VMMR0OPERATION enmOperation);
382VMMR0DECL(int) VMMR0EntryEx(PVM pVM, VMCPUID idCpu, VMMR0OPERATION enmOperation, PSUPVMMR0REQHDR pReq, uint64_t u64Arg, PSUPDRVSESSION);
383VMMR0DECL(int) VMMR0TermVM(PVM pVM, PGVM pGVM);
384
385#ifdef LOG_ENABLED
386VMMR0DECL(void) VMMR0LogFlushDisable(PVMCPU pVCpu);
387VMMR0DECL(void) VMMR0LogFlushEnable(PVMCPU pVCpu);
388#else
389#define VMMR0LogFlushDisable(pVCpu) do { } while(0)
390#define VMMR0LogFlushEnable(pVCpu) do { } while(0)
391#endif
392
393/** @} */
394
395
396#ifdef IN_RC
397/** @defgroup grp_vmm_rc The VMM Raw-Mode Context API
398 * @ingroup grp_vmm
399 * @{
400 */
401VMMRCDECL(int) VMMGCEntry(PVM pVM, unsigned uOperation, unsigned uArg, ...);
402VMMRCDECL(void) VMMGCGuestToHost(PVM pVM, int rc);
403VMMRCDECL(void) VMMGCLogFlushIfFull(PVM pVM);
404/** @} */
405#endif /* IN_RC */
406
407#if defined(IN_RC) || defined(IN_RING0)
408/** @defgroup grp_vmm_rz The VMM Raw-Mode and Ring-0 Context API
409 * @ingroup grp_vmm
410 * @{
411 */
412VMMRZDECL(int) VMMRZCallRing3(PVM pVM, PVMCPU pVCpu, VMMCALLRING3 enmOperation, uint64_t uArg);
413VMMRZDECL(int) VMMRZCallRing3NoCpu(PVM pVM, VMMCALLRING3 enmOperation, uint64_t uArg);
414VMMRZDECL(void) VMMRZCallRing3Disable(PVMCPU pVCpu);
415VMMRZDECL(void) VMMRZCallRing3Enable(PVMCPU pVCpu);
416VMMRZDECL(bool) VMMRZCallRing3IsEnabled(PVMCPU pVCpu);
417/** @} */
418#endif
419
420
421/** @} */
422RT_C_DECLS_END
423
424#endif
425
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette