VirtualBox

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

Last change on this file since 5240 was 5240, checked in by vboxsync, 17 years ago

GCFGM mock-up.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 14.8 KB
Line 
1/** @file
2 * VMM - The Virtual Machine Monitor.
3 */
4
5/*
6 * Copyright (C) 2006-2007 innotek GmbH
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 as published by the Free Software Foundation,
12 * in version 2 as it comes in the "COPYING" file of the VirtualBox OSE
13 * distribution. VirtualBox OSE is distributed in the hope that it will
14 * be useful, but WITHOUT ANY WARRANTY of any kind.
15 */
16
17#ifndef ___VBox_vmm_h
18#define ___VBox_vmm_h
19
20#include <VBox/cdefs.h>
21#include <VBox/types.h>
22#include <VBox/vmapi.h>
23#include <VBox/sup.h>
24#include <iprt/stdarg.h>
25
26__BEGIN_DECLS
27
28/** @defgroup grp_vmm The Virtual Machine Monitor API
29 * @{
30 */
31
32/**
33 * World switcher identifiers.
34 */
35typedef enum VMMSWITCHER
36{
37 /** The usual invalid 0. */
38 VMMSWITCHER_INVALID = 0,
39 /** Switcher for 32-bit host to 32-bit shadow paging. */
40 VMMSWITCHER_32_TO_32,
41 /** Switcher for 32-bit host paging to PAE shadow paging. */
42 VMMSWITCHER_32_TO_PAE,
43 /** Switcher for 32-bit host paging to AMD64 shadow paging. */
44 VMMSWITCHER_32_TO_AMD64,
45 /** Switcher for PAE host to 32-bit shadow paging. */
46 VMMSWITCHER_PAE_TO_32,
47 /** Switcher for PAE host to PAE shadow paging. */
48 VMMSWITCHER_PAE_TO_PAE,
49 /** Switcher for PAE host paging to AMD64 shadow paging. */
50 VMMSWITCHER_PAE_TO_AMD64,
51 /** Switcher for AMD64 host paging to PAE shadow paging. */
52 VMMSWITCHER_AMD64_TO_PAE,
53 /** Switcher for AMD64 host paging to AMD64 shadow paging. */
54 VMMSWITCHER_AMD64_TO_AMD64,
55 /** Used to make a count for array declarations and suchlike. */
56 VMMSWITCHER_MAX,
57 /** The usual 32-bit paranoia. */
58 VMMSWITCHER_32BIT_HACK = 0x7fffffff
59} VMMSWITCHER;
60
61
62/**
63 * VMMGCCallHost operations.
64 */
65typedef enum VMMCALLHOST
66{
67 /** Invalid operation. */
68 VMMCALLHOST_INVALID = 0,
69 /** Acquire the PDM lock. */
70 VMMCALLHOST_PDM_LOCK,
71 /** Call PDMR3QueueFlushWorker. */
72 VMMCALLHOST_PDM_QUEUE_FLUSH,
73 /** Acquire the PGM lock. */
74 VMMCALLHOST_PGM_LOCK,
75 /** Grow the PGM shadow page pool. */
76 VMMCALLHOST_PGM_POOL_GROW,
77 /** Maps a chunk into ring-3. */
78 VMMCALLHOST_PGM_MAP_CHUNK,
79 /** Allocates more handy pages. */
80 VMMCALLHOST_PGM_ALLOCATE_HANDY_PAGES,
81#ifndef NEW_PHYS_CODE
82 /** Dynamically allocate physical guest RAM. */
83 VMMCALLHOST_PGM_RAM_GROW_RANGE,
84#endif
85 /** Replay the REM handler notifications. */
86 VMMCALLHOST_REM_REPLAY_HANDLER_NOTIFICATIONS,
87 /** Flush the GC/R0 logger. */
88 VMMCALLHOST_VMM_LOGGER_FLUSH,
89 /** Set the VM error message. */
90 VMMCALLHOST_VM_SET_ERROR,
91 /** Set the VM runtime error message. */
92 VMMCALLHOST_VM_SET_RUNTIME_ERROR,
93 /** Signal a ring 0 hypervisor assertion. */
94 VMMCALLHOST_VM_R0_HYPER_ASSERTION,
95 /** The usual 32-bit hack. */
96 VMMCALLHOST_32BIT_HACK = 0x7fffffff
97} VMMCALLHOST;
98
99
100
101/**
102 * Gets the bottom of the hypervisor stack - GC Ptr.
103 * I.e. the returned address is not actually writable.
104 *
105 * @returns bottom of the stack.
106 * @param pVM The VM handle.
107 */
108RTGCPTR VMMGetStackGC(PVM pVM);
109
110/**
111 * Gets the bottom of the hypervisor stack - HC Ptr.
112 * I.e. the returned address is not actually writable.
113 *
114 * @returns bottom of the stack.
115 * @param pVM The VM handle.
116 */
117RTHCPTR VMMGetHCStack(PVM pVM);
118
119
120
121#ifdef IN_RING3
122/** @defgroup grp_vmm_r3 The VMM Host Context Ring 3 API
123 * @ingroup grp_vmm
124 * @{
125 */
126
127/**
128 * Initializes the VMM.
129 *
130 * @returns VBox status code.
131 * @param pVM The VM to operate on.
132 */
133VMMR3DECL(int) VMMR3Init(PVM pVM);
134
135/**
136 * Ring-3 init finalizing.
137 *
138 * @returns VBox status code.
139 * @param pVM The VM handle.
140 */
141VMMR3DECL(int) VMMR3InitFinalize(PVM pVM);
142
143/**
144 * Initializes the R0 VMM.
145 *
146 * @returns VBox status code.
147 * @param pVM The VM to operate on.
148 */
149VMMR3DECL(int) VMMR3InitR0(PVM pVM);
150
151/**
152 * Initializes the GC VMM.
153 *
154 * @returns VBox status code.
155 * @param pVM The VM to operate on.
156 */
157VMMR3DECL(int) VMMR3InitGC(PVM pVM);
158
159/**
160 * Destroy the VMM bits.
161 *
162 * @returns VINF_SUCCESS.
163 * @param pVM The VM handle.
164 */
165VMMR3DECL(int) VMMR3Term(PVM pVM);
166
167/**
168 * Applies relocations to data and code managed by this
169 * component. This function will be called at init and
170 * whenever the VMM need to relocate it self inside the GC.
171 *
172 * The VMM will need to apply relocations to the core code.
173 *
174 * @param pVM The VM handle.
175 * @param offDelta The relocation delta.
176 */
177VMMR3DECL(void) VMMR3Relocate(PVM pVM, RTGCINTPTR offDelta);
178
179/**
180 * Updates the settings for the GC (and R0?) loggers.
181 *
182 * @returns VBox status code.
183 * @param pVM The VM handle.
184 */
185VMMR3DECL(int) VMMR3UpdateLoggers(PVM pVM);
186
187/**
188 * Gets the pointer to g_szRTAssertMsg1 in GC.
189 * @returns Pointer to VMMGC::g_szRTAssertMsg1.
190 * Returns NULL if not present.
191 * @param pVM The VM handle.
192 */
193VMMR3DECL(const char *) VMMR3GetGCAssertMsg1(PVM pVM);
194
195/**
196 * Gets the pointer to g_szRTAssertMsg2 in GC.
197 * @returns Pointer to VMMGC::g_szRTAssertMsg2.
198 * Returns NULL if not present.
199 * @param pVM The VM handle.
200 */
201VMMR3DECL(const char *) VMMR3GetGCAssertMsg2(PVM pVM);
202
203/**
204 * Resolve a builtin GC symbol.
205 * Called by PDM when loading or relocating GC modules.
206 *
207 * @returns VBox status.
208 * @param pVM VM Handle.
209 * @param pszSymbol Symbol to resolv
210 * @param pGCPtrValue Where to store the symbol value.
211 * @remark This has to work before VMMR3Relocate() is called.
212 */
213VMMR3DECL(int) VMMR3GetImportGC(PVM pVM, const char *pszSymbol, PRTGCPTR pGCPtrValue);
214
215/**
216 * Selects the switcher to be used for switching to GC.
217 *
218 * @returns VBox status code.
219 * @param pVM VM handle.
220 * @param enmSwitcher The new switcher.
221 * @remark This function may be called before the VMM is initialized.
222 */
223VMMR3DECL(int) VMMR3SelectSwitcher(PVM pVM, VMMSWITCHER enmSwitcher);
224
225/**
226 * Disable the switcher logic permanently.
227 *
228 * @returns VBox status code.
229 * @param pVM VM handle.
230 */
231VMMR3DECL(int) VMMR3DisableSwitcher(PVM pVM);
232
233/**
234 * Executes guest code.
235 *
236 * @param pVM VM handle.
237 */
238VMMR3DECL(int) VMMR3RawRunGC(PVM pVM);
239
240/**
241 * Executes guest code (Intel VMX and AMD SVM).
242 *
243 * @param pVM VM handle.
244 */
245VMMR3DECL(int) VMMR3HwAccRunGC(PVM pVM);
246
247/**
248 * Calls GC a function.
249 *
250 * @param pVM The VM handle.
251 * @param GCPtrEntry The GC function address.
252 * @param cArgs The number of arguments in the ....
253 * @param ... Arguments to the function.
254 */
255VMMR3DECL(int) VMMR3CallGC(PVM pVM, RTGCPTR GCPtrEntry, unsigned cArgs, ...);
256
257/**
258 * Calls GC a function.
259 *
260 * @param pVM The VM handle.
261 * @param GCPtrEntry The GC function address.
262 * @param cArgs The number of arguments in the ....
263 * @param args Arguments to the function.
264 */
265VMMR3DECL(int) VMMR3CallGCV(PVM pVM, RTGCPTR GCPtrEntry, unsigned cArgs, va_list args);
266
267/**
268 * Resumes executing hypervisor code when interrupted
269 * by a queue flush or a debug event.
270 *
271 * @returns VBox status code.
272 * @param pVM VM handle.
273 */
274VMMR3DECL(int) VMMR3ResumeHyper(PVM pVM);
275
276/**
277 * Dumps the VM state on a fatal error.
278 *
279 * @param pVM VM Handle.
280 * @param rcErr VBox status code.
281 */
282VMMR3DECL(void) VMMR3FatalDump(PVM pVM, int rcErr);
283
284/**
285 * Acquire global VM lock
286 *
287 * @returns VBox status code
288 * @param pVM The VM to operate on.
289 */
290VMMR3DECL(int) VMMR3Lock(PVM pVM);
291
292/**
293 * Release global VM lock
294 *
295 * @returns VBox status code
296 * @param pVM The VM to operate on.
297 */
298VMMR3DECL(int) VMMR3Unlock(PVM pVM);
299
300/**
301 * Return global VM lock owner
302 *
303 * @returns NIL_RTNATIVETHREAD -> no owner, otherwise thread id of owner
304 * @param pVM The VM to operate on.
305 */
306VMMR3DECL(RTNATIVETHREAD) VMMR3LockGetOwner(PVM pVM);
307
308/**
309 * Checks if the current thread is the owner of the global VM lock.
310 *
311 * @returns true if owner.
312 * @returns false if not owner.
313 * @param pVM The VM to operate on.
314 */
315VMMR3DECL(bool) VMMR3LockIsOwner(PVM pVM);
316
317/**
318 * Suspends the the CPU yielder.
319 *
320 * @param pVM The VM handle.
321 */
322VMMR3DECL(void) VMMR3YieldSuspend(PVM pVM);
323
324/**
325 * Stops the the CPU yielder.
326 *
327 * @param pVM The VM handle.
328 */
329VMMR3DECL(void) VMMR3YieldStop(PVM pVM);
330
331/**
332 * Resumes the CPU yielder when it has been a suspended or stopped.
333 *
334 * @param pVM The VM handle.
335 */
336VMMR3DECL(void) VMMR3YieldResume(PVM pVM);
337
338/** @} */
339#endif
340
341/** @defgroup grp_vmm_r0 The VMM Host Context Ring 0 API
342 * @ingroup grp_vmm
343 * @{
344 */
345
346/**
347 * The VMMR0Entry() codes.
348 */
349typedef enum VMMR0OPERATION
350{
351 /** Run guest context. */
352 VMMR0_DO_RAW_RUN = SUP_VMMR0_DO_RAW_RUN,
353 /** Run guest code using the available hardware acceleration technology. */
354 VMMR0_DO_HWACC_RUN = SUP_VMMR0_DO_HWACC_RUN,
355 /** Official NOP that we use for profiling. */
356 VMMR0_DO_NOP = SUP_VMMR0_DO_NOP,
357
358 /** Ask the GVMM to create a new VM. */
359 VMMR0_DO_GVMM_CREATE_VM,
360 /** Ask the GVMM to destroy the VM. */
361 VMMR0_DO_GVMM_DESTROY_VM,
362 /** Call GVMMR0SchedHalt(). */
363 VMMR0_DO_GVMM_SCHED_HALT,
364 /** Call GVMMR0SchedWakeUp(). */
365 VMMR0_DO_GVMM_SCHED_WAKE_UP,
366 /** Call GVMMR0SchedPoll(). */
367 VMMR0_DO_GVMM_SCHED_POLL,
368 /** Call GVMMR0QueryStatistics(). */
369 VMMR0_DO_GVMM_QUERY_STATISTICS,
370 /** Call GVMMR0ResetStatistics(). */
371 VMMR0_DO_GVMM_RESET_STATISTICS,
372
373 /** Call VMMR0 Per VM Init. */
374 VMMR0_DO_VMMR0_INIT,
375 /** Call VMMR0 Per VM Termination. */
376 VMMR0_DO_VMMR0_TERM,
377 /** Setup the hardware accelerated raw-mode session. */
378 VMMR0_DO_HWACC_SETUP_VM,
379 /** Calls function in the hypervisor.
380 * The caller must setup the hypervisor context so the call will be performed.
381 * The difference between VMMR0_DO_RUN_GC and this one is the handling of
382 * the return GC code. The return code will not be interpreted by this operation.
383 */
384 VMMR0_DO_CALL_HYPERVISOR,
385
386 /** Call PGMR0PhysAllocateHandyPages(). */
387 VMMR0_DO_PGM_ALLOCATE_HANDY_PAGES,
388
389 /** Call GMMR0InitialReservation(). */
390 VMMR0_DO_GMM_INITIAL_RESERVATION,
391 /** Call GMMR0UpdateReservation(). */
392 VMMR0_DO_GMM_UPDATE_RESERVATION,
393 /** Call GMMR0AllocatePages(). */
394 VMMR0_DO_GMM_ALLOCATE_PAGES,
395 /** Call GMMR0FreePages(). */
396 VMMR0_DO_GMM_FREE_PAGES,
397 /** Call GMMR0BalloonedPages(). */
398 VMMR0_DO_GMM_BALLOONED_PAGES,
399 /** Call GMMR0DeflatedBalloon(). */
400 VMMR0_DO_GMM_DEFLATED_BALLOON,
401 /** Call GMMR0MapUnmapChunk(). */
402 VMMR0_DO_GMM_MAP_UNMAP_CHUNK,
403 /** Call GMMR0SeedChunk(). */
404 VMMR0_DO_GMM_SEED_CHUNK,
405
406 /** Set a GVMM or GMM configuration value. */
407 VMMR0_DO_GCFGM_SET_VALUE,
408 /** Query a GVMM or GMM configuration value. */
409 VMMR0_DO_GCFGM_QUERY_VALUE,
410
411 /** The start of the R0 service operations. */
412 VMMR0_DO_SRV_START,
413 /** Call INTNETR0Open(). */
414 VMMR0_DO_INTNET_OPEN,
415 /** Call INTNETR0IfClose(). */
416 VMMR0_DO_INTNET_IF_CLOSE,
417 /** Call INTNETR0IfGetRing3Buffer(). */
418 VMMR0_DO_INTNET_IF_GET_RING3_BUFFER,
419 /** Call INTNETR0IfSetPromiscuousMode(). */
420 VMMR0_DO_INTNET_IF_SET_PROMISCUOUS_MODE,
421 /** Call INTNETR0IfSend(). */
422 VMMR0_DO_INTNET_IF_SEND,
423 /** Call INTNETR0IfWait(). */
424 VMMR0_DO_INTNET_IF_WAIT,
425 /** The end of the R0 service operations. */
426 VMMR0_DO_SRV_END,
427
428 /** Official call we use for testing Ring-0 APIs. */
429 VMMR0_DO_TESTS,
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 */
440typedef 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 */
456typedef GCFGMVALUEREQ *PGCFGMVALUEREQ;
457
458
459/**
460 * The Ring 0 entry point, called by the interrupt gate.
461 *
462 * @returns VBox status code.
463 * @param pVM The VM to operate on.
464 * @param enmOperation Which operation to execute.
465 * @param pvArg Argument to the operation.
466 * @remarks Assume called with interrupts disabled.
467 */
468VMMR0DECL(int) VMMR0EntryInt(PVM pVM, VMMR0OPERATION enmOperation, void *pvArg);
469
470/**
471 * The Ring 0 entry point, called by the fast-ioctl path.
472 *
473 * @returns VBox status code.
474 * @param pVM The VM to operate on.
475 * @param enmOperation Which operation to execute.
476 * @remarks Assume called with interrupts _enabled_.
477 */
478VMMR0DECL(int) VMMR0EntryFast(PVM pVM, VMMR0OPERATION enmOperation);
479
480/**
481 * The Ring 0 entry point, called by the support library (SUP).
482 *
483 * @returns VBox status code.
484 * @param pVM The VM to operate on.
485 * @param enmOperation Which operation to execute.
486 * @param pReq This points to a SUPVMMR0REQHDR packet. Optional.
487 * @param u64Arg Some simple constant argument.
488 * @remarks Assume called with interrupts _enabled_.
489 */
490VMMR0DECL(int) VMMR0EntryEx(PVM pVM, VMMR0OPERATION enmOperation, PSUPVMMR0REQHDR pReq, uint64_t u64Arg);
491
492/**
493 * Calls the ring-3 host code.
494 *
495 * @returns VBox status code of the ring-3 call.
496 * @param pVM The VM handle.
497 * @param enmOperation The operation.
498 * @param uArg The argument to the operation.
499 */
500VMMR0DECL(int) VMMR0CallHost(PVM pVM, VMMCALLHOST enmOperation, uint64_t uArg);
501
502/** @} */
503
504
505#ifdef IN_GC
506/** @defgroup grp_vmm_gc The VMM Guest Context API
507 * @ingroup grp_vmm
508 * @{
509 */
510
511/**
512 * The GC entry point.
513 *
514 * @returns VBox status code.
515 * @param pVM The VM to operate on.
516 * @param uOperation Which operation to execute (VMMGCOPERATION).
517 * @param uArg Argument to that operation.
518 * @param ... Additional arguments.
519 */
520VMMGCDECL(int) VMMGCEntry(PVM pVM, unsigned uOperation, unsigned uArg, ...);
521
522/**
523 * Switches from guest context to host context.
524 *
525 * @param pVM The VM handle.
526 * @param rc The status code.
527 */
528VMMGCDECL(void) VMMGCGuestToHost(PVM pVM, int rc);
529
530/**
531 * Calls the ring-3 host code.
532 *
533 * @returns VBox status code of the ring-3 call.
534 * @param pVM The VM handle.
535 * @param enmOperation The operation.
536 * @param uArg The argument to the operation.
537 */
538VMMGCDECL(int) VMMGCCallHost(PVM pVM, VMMCALLHOST enmOperation, uint64_t uArg);
539
540/** @} */
541#endif
542
543
544/** @} */
545__END_DECLS
546
547
548#endif
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