VirtualBox

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

Last change on this file since 20984 was 20874, checked in by vboxsync, 16 years ago

VMMR0CallHost -> VMMRZCallRing3[NoCpu]; VMMCALLHOST -> VMMCALLRING3.

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