VirtualBox

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

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

Introduced feature.h

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 29.2 KB
Line 
1/** @file
2 * PGM - Page Monitor / Monitor. (VMM)
3 */
4
5/*
6 * Copyright (C) 2006-2007 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_pgm_h
27#define ___VBox_pgm_h
28
29#include <VBox/cdefs.h>
30#include <VBox/types.h>
31#include <VBox/sup.h>
32#include <VBox/vmapi.h>
33#include <VBox/x86.h>
34#include <VBox/hwacc_vmx.h>
35#include <VBox/VMMDev.h> /* for VMMDEVSHAREDREGIONDESC */
36#include <VBox/gmm.h> /* for PGMMREGISTERSHAREDMODULEREQ */
37#include <VBox/feature.h>
38
39RT_C_DECLS_BEGIN
40
41/** @defgroup grp_pgm The Page Monitor / Manager API
42 * @{
43 */
44
45/** Chunk size for dynamically allocated physical memory. */
46#define PGM_DYNAMIC_CHUNK_SIZE (1*1024*1024)
47/** Shift GC physical address by 20 bits to get the offset into the pvHCChunkHC array. */
48#define PGM_DYNAMIC_CHUNK_SHIFT 20
49/** Dynamic chunk offset mask. */
50#define PGM_DYNAMIC_CHUNK_OFFSET_MASK 0xfffff
51/** Dynamic chunk base mask. */
52#define PGM_DYNAMIC_CHUNK_BASE_MASK (~(RTGCPHYS)PGM_DYNAMIC_CHUNK_OFFSET_MASK)
53
54
55/**
56 * FNPGMRELOCATE callback mode.
57 */
58typedef enum PGMRELOCATECALL
59{
60 /** The callback is for checking if the suggested address is suitable. */
61 PGMRELOCATECALL_SUGGEST = 1,
62 /** The callback is for executing the relocation. */
63 PGMRELOCATECALL_RELOCATE
64} PGMRELOCATECALL;
65
66
67/**
68 * Callback function which will be called when PGM is trying to find
69 * a new location for the mapping.
70 *
71 * The callback is called in two modes, 1) the check mode and 2) the relocate mode.
72 * In 1) the callback should say if it objects to a suggested new location. If it
73 * accepts the new location, it is called again for doing it's relocation.
74 *
75 *
76 * @returns true if the location is ok.
77 * @returns false if another location should be found.
78 * @param GCPtrOld The old virtual address.
79 * @param GCPtrNew The new virtual address.
80 * @param enmMode Used to indicate the callback mode.
81 * @param pvUser User argument.
82 * @remark The return value is no a failure indicator, it's an acceptance
83 * indicator. Relocation can not fail!
84 */
85typedef DECLCALLBACK(bool) FNPGMRELOCATE(PVM pVM, RTGCPTR GCPtrOld, RTGCPTR GCPtrNew, PGMRELOCATECALL enmMode, void *pvUser);
86/** Pointer to a relocation callback function. */
87typedef FNPGMRELOCATE *PFNPGMRELOCATE;
88
89
90/**
91 * Physical page access handler type.
92 */
93typedef enum PGMPHYSHANDLERTYPE
94{
95 /** MMIO range. Pages are not present, all access is done in interpreter or recompiler. */
96 PGMPHYSHANDLERTYPE_MMIO = 1,
97 /** Handler all write access to a physical page range. */
98 PGMPHYSHANDLERTYPE_PHYSICAL_WRITE,
99 /** Handler all access to a physical page range. */
100 PGMPHYSHANDLERTYPE_PHYSICAL_ALL
101
102} PGMPHYSHANDLERTYPE;
103
104/**
105 * \#PF Handler callback for physical access handler ranges in RC.
106 *
107 * @returns VBox status code (appropriate for RC return).
108 * @param pVM VM Handle.
109 * @param uErrorCode CPU Error code.
110 * @param pRegFrame Trap register frame.
111 * NULL on DMA and other non CPU access.
112 * @param pvFault The fault address (cr2).
113 * @param GCPhysFault The GC physical address corresponding to pvFault.
114 * @param pvUser User argument.
115 */
116typedef DECLCALLBACK(int) FNPGMRCPHYSHANDLER(PVM pVM, RTGCUINT uErrorCode, PCPUMCTXCORE pRegFrame, RTGCPTR pvFault, RTGCPHYS GCPhysFault, void *pvUser);
117/** Pointer to PGM access callback. */
118typedef FNPGMRCPHYSHANDLER *PFNPGMRCPHYSHANDLER;
119
120/**
121 * \#PF Handler callback for physical access handler ranges in R0.
122 *
123 * @returns VBox status code (appropriate for R0 return).
124 * @param pVM VM Handle.
125 * @param uErrorCode CPU Error code.
126 * @param pRegFrame Trap register frame.
127 * NULL on DMA and other non CPU access.
128 * @param pvFault The fault address (cr2).
129 * @param GCPhysFault The GC physical address corresponding to pvFault.
130 * @param pvUser User argument.
131 */
132typedef DECLCALLBACK(int) FNPGMR0PHYSHANDLER(PVM pVM, RTGCUINT uErrorCode, PCPUMCTXCORE pRegFrame, RTGCPTR pvFault, RTGCPHYS GCPhysFault, void *pvUser);
133/** Pointer to PGM access callback. */
134typedef FNPGMR0PHYSHANDLER *PFNPGMR0PHYSHANDLER;
135
136/**
137 * Guest Access type
138 */
139typedef enum PGMACCESSTYPE
140{
141 /** Read access. */
142 PGMACCESSTYPE_READ = 1,
143 /** Write access. */
144 PGMACCESSTYPE_WRITE
145} PGMACCESSTYPE;
146
147/**
148 * \#PF Handler callback for physical access handler ranges (MMIO among others) in HC.
149 *
150 * The handler can not raise any faults, it's mainly for monitoring write access
151 * to certain pages.
152 *
153 * @returns VINF_SUCCESS if the handler have carried out the operation.
154 * @returns VINF_PGM_HANDLER_DO_DEFAULT if the caller should carry out the access operation.
155 * @param pVM VM Handle.
156 * @param GCPhys The physical address the guest is writing to.
157 * @param pvPhys The HC mapping of that address.
158 * @param pvBuf What the guest is reading/writing.
159 * @param cbBuf How much it's reading/writing.
160 * @param enmAccessType The access type.
161 * @param pvUser User argument.
162 */
163typedef DECLCALLBACK(int) FNPGMR3PHYSHANDLER(PVM pVM, RTGCPHYS GCPhys, void *pvPhys, void *pvBuf, size_t cbBuf, PGMACCESSTYPE enmAccessType, void *pvUser);
164/** Pointer to PGM access callback. */
165typedef FNPGMR3PHYSHANDLER *PFNPGMR3PHYSHANDLER;
166
167
168/**
169 * Virtual access handler type.
170 */
171typedef enum PGMVIRTHANDLERTYPE
172{
173 /** Write access handled. */
174 PGMVIRTHANDLERTYPE_WRITE = 1,
175 /** All access handled. */
176 PGMVIRTHANDLERTYPE_ALL,
177 /** Hypervisor write access handled.
178 * This is used to catch the guest trying to write to LDT, TSS and any other
179 * system structure which the brain dead intel guys let unprivilegde code find. */
180 PGMVIRTHANDLERTYPE_HYPERVISOR
181} PGMVIRTHANDLERTYPE;
182
183/**
184 * \#PF Handler callback for virtual access handler ranges, RC.
185 *
186 * Important to realize that a physical page in a range can have aliases, and
187 * for ALL and WRITE handlers these will also trigger.
188 *
189 * @returns VBox status code (appropriate for GC return).
190 * @param pVM VM Handle.
191 * @param uErrorCode CPU Error code.
192 * @param pRegFrame Trap register frame.
193 * @param pvFault The fault address (cr2).
194 * @param pvRange The base address of the handled virtual range.
195 * @param offRange The offset of the access into this range.
196 * (If it's a EIP range this's the EIP, if not it's pvFault.)
197 */
198typedef DECLCALLBACK(int) FNPGMRCVIRTHANDLER(PVM pVM, RTGCUINT uErrorCode, PCPUMCTXCORE pRegFrame, RTGCPTR pvFault, RTGCPTR pvRange, uintptr_t offRange);
199/** Pointer to PGM access callback. */
200typedef FNPGMRCVIRTHANDLER *PFNPGMRCVIRTHANDLER;
201
202/**
203 * \#PF Handler callback for virtual access handler ranges, R3.
204 *
205 * Important to realize that a physical page in a range can have aliases, and
206 * for ALL and WRITE handlers these will also trigger.
207 *
208 * @returns VINF_SUCCESS if the handler have carried out the operation.
209 * @returns VINF_PGM_HANDLER_DO_DEFAULT if the caller should carry out the access operation.
210 * @param pVM VM Handle.
211 * @param GCPtr The virtual address the guest is writing to. (not correct if it's an alias!)
212 * @param pvPtr The HC mapping of that address.
213 * @param pvBuf What the guest is reading/writing.
214 * @param cbBuf How much it's reading/writing.
215 * @param enmAccessType The access type.
216 * @param pvUser User argument.
217 */
218typedef DECLCALLBACK(int) FNPGMR3VIRTHANDLER(PVM pVM, RTGCPTR GCPtr, void *pvPtr, void *pvBuf, size_t cbBuf, PGMACCESSTYPE enmAccessType, void *pvUser);
219/** Pointer to PGM access callback. */
220typedef FNPGMR3VIRTHANDLER *PFNPGMR3VIRTHANDLER;
221
222
223/**
224 * \#PF Handler callback for invalidation of virtual access handler ranges.
225 *
226 * @param pVM VM Handle.
227 * @param GCPtr The virtual address the guest has changed.
228 */
229typedef DECLCALLBACK(int) FNPGMR3VIRTINVALIDATE(PVM pVM, RTGCPTR GCPtr);
230/** Pointer to PGM invalidation callback. */
231typedef FNPGMR3VIRTINVALIDATE *PFNPGMR3VIRTINVALIDATE;
232
233/**
234 * Paging mode.
235 */
236typedef enum PGMMODE
237{
238 /** The usual invalid value. */
239 PGMMODE_INVALID = 0,
240 /** Real mode. */
241 PGMMODE_REAL,
242 /** Protected mode, no paging. */
243 PGMMODE_PROTECTED,
244 /** 32-bit paging. */
245 PGMMODE_32_BIT,
246 /** PAE paging. */
247 PGMMODE_PAE,
248 /** PAE paging with NX enabled. */
249 PGMMODE_PAE_NX,
250 /** 64-bit AMD paging (long mode). */
251 PGMMODE_AMD64,
252 /** 64-bit AMD paging (long mode) with NX enabled. */
253 PGMMODE_AMD64_NX,
254 /** Nested paging mode (shadow only; guest physical to host physical). */
255 PGMMODE_NESTED,
256 /** Extended paging (Intel) mode. */
257 PGMMODE_EPT,
258 /** The max number of modes */
259 PGMMODE_MAX,
260 /** 32bit hackishness. */
261 PGMMODE_32BIT_HACK = 0x7fffffff
262} PGMMODE;
263
264/** Macro for checking if the guest is using paging.
265 * @param enmMode PGMMODE_*.
266 * @remark ASSUMES certain order of the PGMMODE_* values.
267 */
268#define PGMMODE_WITH_PAGING(enmMode) ((enmMode) >= PGMMODE_32_BIT)
269
270/** Macro for checking if it's one of the long mode modes.
271 * @param enmMode PGMMODE_*.
272 */
273#define PGMMODE_IS_LONG_MODE(enmMode) ((enmMode) == PGMMODE_AMD64_NX || (enmMode) == PGMMODE_AMD64)
274
275/**
276 * Is the ROM mapped (true) or is the shadow RAM mapped (false).
277 *
278 * @returns boolean.
279 * @param enmProt The PGMROMPROT value, must be valid.
280 */
281#define PGMROMPROT_IS_ROM(enmProt) \
282 ( (enmProt) == PGMROMPROT_READ_ROM_WRITE_IGNORE \
283 || (enmProt) == PGMROMPROT_READ_ROM_WRITE_RAM )
284
285
286
287VMMDECL(bool) PGMIsLocked(PVM pVM);
288VMMDECL(bool) PGMIsLockOwner(PVM pVM);
289
290VMMDECL(int) PGMRegisterStringFormatTypes(void);
291VMMDECL(void) PGMDeregisterStringFormatTypes(void);
292VMMDECL(RTHCPHYS) PGMGetHyperCR3(PVMCPU pVCpu);
293VMMDECL(RTHCPHYS) PGMGetNestedCR3(PVMCPU pVCpu, PGMMODE enmShadowMode);
294VMMDECL(RTHCPHYS) PGMGetInterHCCR3(PVM pVM);
295VMMDECL(RTHCPHYS) PGMGetInterRCCR3(PVM pVM, PVMCPU pVCpu);
296VMMDECL(RTHCPHYS) PGMGetInter32BitCR3(PVM pVM);
297VMMDECL(RTHCPHYS) PGMGetInterPaeCR3(PVM pVM);
298VMMDECL(RTHCPHYS) PGMGetInterAmd64CR3(PVM pVM);
299VMMDECL(int) PGMTrap0eHandler(PVMCPU pVCpu, RTGCUINT uErr, PCPUMCTXCORE pRegFrame, RTGCPTR pvFault);
300VMMDECL(int) PGMPrefetchPage(PVMCPU pVCpu, RTGCPTR GCPtrPage);
301VMMDECL(int) PGMVerifyAccess(PVMCPU pVCpu, RTGCPTR Addr, uint32_t cbSize, uint32_t fAccess);
302VMMDECL(int) PGMIsValidAccess(PVMCPU pVCpu, RTGCPTR Addr, uint32_t cbSize, uint32_t fAccess);
303VMMDECL(int) PGMInterpretInstruction(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame, RTGCPTR pvFault);
304VMMDECL(int) PGMMap(PVM pVM, RTGCPTR GCPtr, RTHCPHYS HCPhys, uint32_t cbPages, unsigned fFlags);
305VMMDECL(int) PGMMapSetPage(PVM pVM, RTGCPTR GCPtr, uint64_t cb, uint64_t fFlags);
306VMMDECL(int) PGMMapModifyPage(PVM pVM, RTGCPTR GCPtr, size_t cb, uint64_t fFlags, uint64_t fMask);
307#ifndef IN_RING0
308VMMDECL(bool) PGMMapHasConflicts(PVM pVM);
309#endif
310#ifdef VBOX_STRICT
311VMMDECL(void) PGMMapCheck(PVM pVM);
312#endif
313VMMDECL(int) PGMShwGetPage(PVMCPU pVCpu, RTGCPTR GCPtr, uint64_t *pfFlags, PRTHCPHYS pHCPhys);
314VMMDECL(int) PGMShwSetPage(PVMCPU pVCpu, RTGCPTR GCPtr, size_t cb, uint64_t fFlags);
315VMMDECL(int) PGMShwModifyPage(PVMCPU pVCpu, RTGCPTR GCPtr, size_t cb, uint64_t fFlags, uint64_t fMask);
316VMMDECL(int) PGMGstGetPage(PVMCPU pVCpu, RTGCPTR GCPtr, uint64_t *pfFlags, PRTGCPHYS pGCPhys);
317VMMDECL(bool) PGMGstIsPagePresent(PVMCPU pVCpu, RTGCPTR GCPtr);
318VMMDECL(int) PGMGstSetPage(PVMCPU pVCpu, RTGCPTR GCPtr, size_t cb, uint64_t fFlags);
319VMMDECL(int) PGMGstModifyPage(PVMCPU pVCpu, RTGCPTR GCPtr, size_t cb, uint64_t fFlags, uint64_t fMask);
320VMMDECL(X86PDPE) PGMGstGetPaePDPtr(PVMCPU pVCpu, unsigned iPdPt);
321
322VMMDECL(int) PGMInvalidatePage(PVMCPU pVCpu, RTGCPTR GCPtrPage);
323VMMDECL(int) PGMFlushTLB(PVMCPU pVCpu, uint64_t cr3, bool fGlobal);
324VMMDECL(int) PGMSyncCR3(PVMCPU pVCpu, uint64_t cr0, uint64_t cr3, uint64_t cr4, bool fGlobal);
325VMMDECL(int) PGMUpdateCR3(PVMCPU pVCpu, uint64_t cr3);
326VMMDECL(int) PGMChangeMode(PVMCPU pVCpu, uint64_t cr0, uint64_t cr4, uint64_t efer);
327VMMDECL(PGMMODE) PGMGetGuestMode(PVMCPU pVCpu);
328VMMDECL(PGMMODE) PGMGetShadowMode(PVMCPU pVCpu);
329VMMDECL(PGMMODE) PGMGetHostMode(PVM pVM);
330VMMDECL(const char *) PGMGetModeName(PGMMODE enmMode);
331VMMDECL(bool) PGMHasDirtyPages(PVM pVM);
332VMMDECL(int) PGMHandlerPhysicalRegisterEx(PVM pVM, PGMPHYSHANDLERTYPE enmType, RTGCPHYS GCPhys, RTGCPHYS GCPhysLast,
333 R3PTRTYPE(PFNPGMR3PHYSHANDLER) pfnHandlerR3, RTR3PTR pvUserR3,
334 R0PTRTYPE(PFNPGMR0PHYSHANDLER) pfnHandlerR0, RTR0PTR pvUserR0,
335 RCPTRTYPE(PFNPGMRCPHYSHANDLER) pfnHandlerRC, RTRCPTR pvUserRC,
336 R3PTRTYPE(const char *) pszDesc);
337VMMDECL(int) PGMHandlerPhysicalModify(PVM pVM, RTGCPHYS GCPhysCurrent, RTGCPHYS GCPhys, RTGCPHYS GCPhysLast);
338VMMDECL(int) PGMHandlerPhysicalDeregister(PVM pVM, RTGCPHYS GCPhys);
339VMMDECL(int) PGMHandlerPhysicalChangeCallbacks(PVM pVM, RTGCPHYS GCPhys,
340 R3PTRTYPE(PFNPGMR3PHYSHANDLER) pfnHandlerR3, RTR3PTR pvUserR3,
341 R0PTRTYPE(PFNPGMR0PHYSHANDLER) pfnHandlerR0, RTR0PTR pvUserR0,
342 RCPTRTYPE(PFNPGMRCPHYSHANDLER) pfnHandlerRC, RTRCPTR pvUserRC,
343 R3PTRTYPE(const char *) pszDesc);
344VMMDECL(int) PGMHandlerPhysicalSplit(PVM pVM, RTGCPHYS GCPhys, RTGCPHYS GCPhysSplit);
345VMMDECL(int) PGMHandlerPhysicalJoin(PVM pVM, RTGCPHYS GCPhys1, RTGCPHYS GCPhys2);
346VMMDECL(int) PGMHandlerPhysicalPageTempOff(PVM pVM, RTGCPHYS GCPhys, RTGCPHYS GCPhysPage);
347VMMDECL(int) PGMHandlerPhysicalPageAlias(PVM pVM, RTGCPHYS GCPhys, RTGCPHYS GCPhysPage, RTGCPHYS GCPhysPageRemap);
348VMMDECL(int) PGMHandlerPhysicalPageAliasHC(PVM pVM, RTGCPHYS GCPhys, RTGCPHYS GCPhysPage, RTHCPHYS HCPhysPageRemap);
349VMMDECL(int) PGMHandlerPhysicalReset(PVM pVM, RTGCPHYS GCPhys);
350VMMDECL(bool) PGMHandlerPhysicalIsRegistered(PVM pVM, RTGCPHYS GCPhys);
351VMMDECL(bool) PGMHandlerVirtualIsRegistered(PVM pVM, RTGCPTR GCPtr);
352VMMDECL(bool) PGMPhysIsA20Enabled(PVMCPU pVCpu);
353VMMDECL(bool) PGMPhysIsGCPhysValid(PVM pVM, RTGCPHYS GCPhys);
354VMMDECL(bool) PGMPhysIsGCPhysNormal(PVM pVM, RTGCPHYS GCPhys);
355VMMDECL(int) PGMPhysGCPhys2HCPhys(PVM pVM, RTGCPHYS GCPhys, PRTHCPHYS pHCPhys);
356VMMDECL(int) PGMPhysGCPtr2GCPhys(PVMCPU pVCpu, RTGCPTR GCPtr, PRTGCPHYS pGCPhys);
357VMMDECL(int) PGMPhysGCPtr2HCPhys(PVMCPU pVCpu, RTGCPTR GCPtr, PRTHCPHYS pHCPhys);
358VMMDECL(void) PGMPhysInvalidatePageMapTLB(PVM pVM);
359VMMDECL(void) PGMPhysInvalidatePageMapTLBEntry(PVM pVM, RTGCPHYS GCPhys);
360VMMDECL(int) PGMPhysGCPhys2CCPtr(PVM pVM, RTGCPHYS GCPhys, void **ppv, PPGMPAGEMAPLOCK pLock);
361VMMDECL(int) PGMPhysGCPhys2CCPtrReadOnly(PVM pVM, RTGCPHYS GCPhys, void const **ppv, PPGMPAGEMAPLOCK pLock);
362VMMDECL(int) PGMPhysGCPtr2CCPtr(PVMCPU pVCpu, RTGCPTR GCPtr, void **ppv, PPGMPAGEMAPLOCK pLock);
363VMMDECL(int) PGMPhysGCPtr2CCPtrReadOnly(PVMCPU pVCpu, RTGCPTR GCPtr, void const **ppv, PPGMPAGEMAPLOCK pLock);
364VMMDECL(void) PGMPhysReleasePageMappingLock(PVM pVM, PPGMPAGEMAPLOCK pLock);
365VMMDECL(int) PGMPhysGCPhys2R3Ptr(PVM pVM, RTGCPHYS GCPhys, RTUINT cbRange, PRTR3PTR pR3Ptr);
366#ifdef VBOX_STRICT
367VMMDECL(RTR3PTR) PGMPhysGCPhys2R3PtrAssert(PVM pVM, RTGCPHYS GCPhys, RTUINT cbRange);
368#endif
369VMMDECL(int) PGMPhysGCPtr2R3Ptr(PVMCPU pVCpu, RTGCPTR GCPtr, PRTR3PTR pR3Ptr);
370VMMDECL(int) PGMPhysRead(PVM pVM, RTGCPHYS GCPhys, void *pvBuf, size_t cbRead);
371VMMDECL(int) PGMPhysWrite(PVM pVM, RTGCPHYS GCPhys, const void *pvBuf, size_t cbWrite);
372VMMDECL(int) PGMPhysSimpleReadGCPhys(PVM pVM, void *pvDst, RTGCPHYS GCPhysSrc, size_t cb);
373VMMDECL(int) PGMPhysSimpleWriteGCPhys(PVM pVM, RTGCPHYS GCPhysDst, const void *pvSrc, size_t cb);
374VMMDECL(int) PGMPhysSimpleReadGCPtr(PVMCPU pVCpu, void *pvDst, RTGCPTR GCPtrSrc, size_t cb);
375VMMDECL(int) PGMPhysSimpleWriteGCPtr(PVMCPU pVCpu, RTGCPTR GCPtrDst, const void *pvSrc, size_t cb);
376VMMDECL(int) PGMPhysReadGCPtr(PVMCPU pVCpu, void *pvDst, RTGCPTR GCPtrSrc, size_t cb);
377VMMDECL(int) PGMPhysWriteGCPtr(PVMCPU pVCpu, RTGCPTR GCPtrDst, const void *pvSrc, size_t cb);
378VMMDECL(int) PGMPhysSimpleDirtyWriteGCPtr(PVMCPU pVCpu, RTGCPTR GCPtrDst, const void *pvSrc, size_t cb);
379VMMDECL(int) PGMPhysInterpretedRead(PVMCPU pVCpu, PCPUMCTXCORE pCtxCore, void *pvDst, RTGCPTR GCPtrSrc, size_t cb);
380VMMDECL(int) PGMPhysInterpretedReadNoHandlers(PVMCPU pVCpu, PCPUMCTXCORE pCtxCore, void *pvDst, RTGCUINTPTR GCPtrSrc, size_t cb, bool fRaiseTrap);
381VMMDECL(int) PGMPhysInterpretedWriteNoHandlers(PVMCPU pVCpu, PCPUMCTXCORE pCtxCore, RTGCPTR GCPtrDst, void const *pvSrc, size_t cb, bool fRaiseTrap);
382#ifdef VBOX_STRICT
383VMMDECL(unsigned) PGMAssertHandlerAndFlagsInSync(PVM pVM);
384VMMDECL(unsigned) PGMAssertNoMappingConflicts(PVM pVM);
385VMMDECL(unsigned) PGMAssertCR3(PVM pVM, PVMCPU pVCpu, uint64_t cr3, uint64_t cr4);
386#endif /* VBOX_STRICT */
387
388#if defined(IN_RC) || defined(VBOX_WITH_2X_4GB_ADDR_SPACE)
389VMMDECL(int) PGMDynMapGCPage(PVM pVM, RTGCPHYS GCPhys, void **ppv);
390VMMDECL(int) PGMDynMapGCPageOff(PVM pVM, RTGCPHYS GCPhys, void **ppv);
391# ifdef IN_RC
392VMMDECL(int) PGMDynMapHCPage(PVM pVM, RTHCPHYS HCPhys, void **ppv);
393VMMDECL(void) PGMDynLockHCPage(PVM pVM, RCPTRTYPE(uint8_t *) GCPage);
394VMMDECL(void) PGMDynUnlockHCPage(PVM pVM, RCPTRTYPE(uint8_t *) GCPage);
395# ifdef VBOX_STRICT
396VMMDECL(void) PGMDynCheckLocks(PVM pVM);
397# endif
398# endif
399VMMDECL(void) PGMDynMapStartAutoSet(PVMCPU pVCpu);
400VMMDECL(bool) PGMDynMapStartOrMigrateAutoSet(PVMCPU pVCpu);
401VMMDECL(void) PGMDynMapReleaseAutoSet(PVMCPU pVCpu);
402VMMDECL(void) PGMDynMapFlushAutoSet(PVMCPU pVCpu);
403VMMDECL(void) PGMDynMapMigrateAutoSet(PVMCPU pVCpu);
404VMMDECL(uint32_t) PGMDynMapPushAutoSubset(PVMCPU pVCpu);
405VMMDECL(void) PGMDynMapPopAutoSubset(PVMCPU pVCpu, uint32_t iPrevSubset);
406#endif
407
408
409VMMDECL(void) PGMSetLargePageUsage(PVM pVM, bool fUseLargePages);
410
411/**
412 * Query large page usage state
413 *
414 * @returns 0 - disabled, 1 - enabled
415 * @param pVM The VM to operate on.
416 */
417#define PGMIsUsingLargePages(pVM) (pVM->fUseLargePages)
418
419
420#ifdef IN_RC
421/** @defgroup grp_pgm_gc The PGM Guest Context API
422 * @ingroup grp_pgm
423 * @{
424 */
425/** @} */
426#endif /* IN_RC */
427
428
429#ifdef IN_RING0
430/** @defgroup grp_pgm_r0 The PGM Host Context Ring-0 API
431 * @ingroup grp_pgm
432 * @{
433 */
434VMMR0DECL(int) PGMR0PhysAllocateHandyPages(PVM pVM, PVMCPU pVCpu);
435VMMR0DECL(int) PGMR0PhysAllocateLargeHandyPage(PVM pVM, PVMCPU pVCpu);
436VMMR0DECL(int) PGMR0SharedModuleCheckRegion(PVM pVM, VMCPUID idCpu, PGMMSHAREDMODULE pModule, PGVM pGVM);
437VMMR0DECL(int) PGMR0Trap0eHandlerNestedPaging(PVM pVM, PVMCPU pVCpu, PGMMODE enmShwPagingMode, RTGCUINT uErr, PCPUMCTXCORE pRegFrame, RTGCPHYS pvFault);
438# ifdef VBOX_WITH_2X_4GB_ADDR_SPACE
439VMMR0DECL(int) PGMR0DynMapInit(void);
440VMMR0DECL(void) PGMR0DynMapTerm(void);
441VMMR0DECL(int) PGMR0DynMapInitVM(PVM pVM);
442VMMR0DECL(void) PGMR0DynMapTermVM(PVM pVM);
443VMMR0DECL(int) PGMR0DynMapAssertIntegrity(void);
444# endif
445/** @} */
446#endif /* IN_RING0 */
447
448
449
450#ifdef IN_RING3
451/** @defgroup grp_pgm_r3 The PGM Host Context Ring-3 API
452 * @ingroup grp_pgm
453 * @{
454 */
455VMMR3DECL(int) PGMR3Init(PVM pVM);
456VMMR3DECL(int) PGMR3InitCPU(PVM pVM);
457VMMR3DECL(int) PGMR3InitDynMap(PVM pVM);
458VMMR3DECL(int) PGMR3InitFinalize(PVM pVM);
459VMMR3DECL(void) PGMR3Relocate(PVM pVM, RTGCINTPTR offDelta);
460VMMR3DECL(void) PGMR3ResetUnpluggedCpu(PVM pVM, PVMCPU pVCpu);
461VMMR3DECL(void) PGMR3Reset(PVM pVM);
462VMMR3DECL(int) PGMR3Term(PVM pVM);
463VMMR3DECL(int) PGMR3TermCPU(PVM pVM);
464VMMR3DECL(int) PGMR3LockCall(PVM pVM);
465VMMR3DECL(int) PGMR3ChangeMode(PVM pVM, PVMCPU pVCpu, PGMMODE enmGuestMode);
466
467VMMR3DECL(int) PGMR3PhysRegisterRam(PVM pVM, RTGCPHYS GCPhys, RTGCPHYS cb, const char *pszDesc);
468VMMR3DECL(int) PGMR3PhysChangeMemBalloon(PVM pVM, bool fInflate, unsigned cPages, RTGCPHYS *paPhysPage);
469VMMR3DECL(int) PGMR3QueryVMMMemoryStats(PVM pVM, uint64_t *puTotalAllocSize, uint64_t *puTotalFreeSize, uint64_t *puTotalBalloonSize);
470VMMR3DECL(int) PGMR3PhysMMIORegister(PVM pVM, RTGCPHYS GCPhys, RTGCPHYS cb,
471 R3PTRTYPE(PFNPGMR3PHYSHANDLER) pfnHandlerR3, RTR3PTR pvUserR3,
472 R0PTRTYPE(PFNPGMR0PHYSHANDLER) pfnHandlerR0, RTR0PTR pvUserR0,
473 RCPTRTYPE(PFNPGMRCPHYSHANDLER) pfnHandlerRC, RTRCPTR pvUserRC,
474 R3PTRTYPE(const char *) pszDesc);
475VMMR3DECL(int) PGMR3PhysMMIODeregister(PVM pVM, RTGCPHYS GCPhys, RTGCPHYS cb);
476VMMR3DECL(int) PGMR3PhysMMIO2Register(PVM pVM, PPDMDEVINS pDevIns, uint32_t iRegion, RTGCPHYS cb, uint32_t fFlags, void **ppv, const char *pszDesc);
477VMMR3DECL(int) PGMR3PhysMMIO2Deregister(PVM pVM, PPDMDEVINS pDevIns, uint32_t iRegion);
478VMMR3DECL(int) PGMR3PhysMMIO2Map(PVM pVM, PPDMDEVINS pDevIns, uint32_t iRegion, RTGCPHYS GCPhys);
479VMMR3DECL(int) PGMR3PhysMMIO2Unmap(PVM pVM, PPDMDEVINS pDevIns, uint32_t iRegion, RTGCPHYS GCPhys);
480VMMR3DECL(bool) PGMR3PhysMMIO2IsBase(PVM pVM, PPDMDEVINS pDevIns, RTGCPHYS GCPhys);
481VMMR3DECL(int) PGMR3PhysMMIO2GetHCPhys(PVM pVM, PPDMDEVINS pDevIns, uint32_t iRegion, RTGCPHYS off, PRTHCPHYS pHCPhys);
482VMMR3DECL(int) PGMR3PhysMMIO2MapKernel(PVM pVM, PPDMDEVINS pDevIns, uint32_t iRegion, RTGCPHYS off, RTGCPHYS cb, const char *pszDesc, PRTR0PTR pR0Ptr);
483
484/** @name PGMR3PhysRegisterRom flags.
485 * @{ */
486/** Inidicates that ROM shadowing should be enabled. */
487#define PGMPHYS_ROM_FLAGS_SHADOWED RT_BIT_32(0)
488/** Indicates that what pvBinary points to won't go away
489 * and can be used for strictness checks. */
490#define PGMPHYS_ROM_FLAGS_PERMANENT_BINARY RT_BIT_32(1)
491/** @} */
492
493VMMR3DECL(int) PGMR3PhysRomRegister(PVM pVM, PPDMDEVINS pDevIns, RTGCPHYS GCPhys, RTGCPHYS cb,
494 const void *pvBinary, uint32_t fFlags, const char *pszDesc);
495VMMR3DECL(int) PGMR3PhysRomProtect(PVM pVM, RTGCPHYS GCPhys, RTGCPHYS cb, PGMROMPROT enmProt);
496VMMR3DECL(int) PGMR3PhysRegister(PVM pVM, void *pvRam, RTGCPHYS GCPhys, size_t cb, unsigned fFlags, const SUPPAGE *paPages, const char *pszDesc);
497VMMDECL(void) PGMR3PhysSetA20(PVMCPU pVCpu, bool fEnable);
498/** @name PGMR3MapPT flags.
499 * @{ */
500/** The mapping may be unmapped later. The default is permanent mappings. */
501#define PGMR3MAPPT_FLAGS_UNMAPPABLE RT_BIT(0)
502/** @} */
503VMMR3DECL(int) PGMR3MapPT(PVM pVM, RTGCPTR GCPtr, uint32_t cb, uint32_t fFlags, PFNPGMRELOCATE pfnRelocate, void *pvUser, const char *pszDesc);
504VMMR3DECL(int) PGMR3UnmapPT(PVM pVM, RTGCPTR GCPtr);
505VMMR3DECL(int) PGMR3FinalizeMappings(PVM pVM);
506VMMR3DECL(int) PGMR3MappingsDisable(PVM pVM);
507VMMR3DECL(int) PGMR3MappingsSize(PVM pVM, uint32_t *pcb);
508VMMR3DECL(int) PGMR3MappingsFix(PVM pVM, RTGCPTR GCPtrBase, uint32_t cb);
509VMMR3DECL(int) PGMR3MappingsUnfix(PVM pVM);
510VMMR3DECL(bool) PGMR3MappingsNeedReFixing(PVM pVM);
511VMMR3DECL(int) PGMR3MapIntermediate(PVM pVM, RTUINTPTR Addr, RTHCPHYS HCPhys, unsigned cbPages);
512VMMR3DECL(int) PGMR3MapRead(PVM pVM, void *pvDst, RTGCPTR GCPtrSrc, size_t cb);
513
514VMMR3DECL(int) PGMR3HandlerPhysicalRegister(PVM pVM, PGMPHYSHANDLERTYPE enmType, RTGCPHYS GCPhys, RTGCPHYS GCPhysLast,
515 PFNPGMR3PHYSHANDLER pfnHandlerR3, void *pvUserR3,
516 const char *pszModR0, const char *pszHandlerR0, RTR0PTR pvUserR0,
517 const char *pszModRC, const char *pszHandlerRC, RTRCPTR pvUserRC, const char *pszDesc);
518VMMDECL(int) PGMR3HandlerVirtualRegisterEx(PVM pVM, PGMVIRTHANDLERTYPE enmType, RTGCPTR GCPtr, RTGCPTR GCPtrLast,
519 R3PTRTYPE(PFNPGMR3VIRTINVALIDATE) pfnInvalidateR3,
520 R3PTRTYPE(PFNPGMR3VIRTHANDLER) pfnHandlerR3,
521 RCPTRTYPE(PFNPGMRCVIRTHANDLER) pfnHandlerRC,
522 R3PTRTYPE(const char *) pszDesc);
523VMMR3DECL(int) PGMR3HandlerVirtualRegister(PVM pVM, PGMVIRTHANDLERTYPE enmType, RTGCPTR GCPtr, RTGCPTR GCPtrLast,
524 PFNPGMR3VIRTINVALIDATE pfnInvalidateR3,
525 PFNPGMR3VIRTHANDLER pfnHandlerR3,
526 const char *pszHandlerRC, const char *pszModRC, const char *pszDesc);
527VMMDECL(int) PGMHandlerVirtualChangeInvalidateCallback(PVM pVM, RTGCPTR GCPtr, R3PTRTYPE(PFNPGMR3VIRTINVALIDATE) pfnInvalidateR3);
528VMMDECL(int) PGMHandlerVirtualDeregister(PVM pVM, RTGCPTR GCPtr);
529VMMR3DECL(int) PGMR3PoolGrow(PVM pVM);
530#ifdef ___VBox_dbgf_h /** @todo fix this! */
531VMMR3DECL(int) PGMR3DumpHierarchyHC(PVM pVM, uint64_t cr3, uint64_t cr4, bool fLongMode, unsigned cMaxDepth, PCDBGFINFOHLP pHlp);
532#endif
533VMMR3DECL(int) PGMR3DumpHierarchyGC(PVM pVM, uint64_t cr3, uint64_t cr4, RTGCPHYS PhysSearch);
534
535VMMR3DECL(int) PGMR3PhysTlbGCPhys2Ptr(PVM pVM, RTGCPHYS GCPhys, bool fWritable, void **ppv);
536VMMR3DECL(uint8_t) PGMR3PhysReadU8(PVM pVM, RTGCPHYS GCPhys);
537VMMR3DECL(uint16_t) PGMR3PhysReadU16(PVM pVM, RTGCPHYS GCPhys);
538VMMR3DECL(uint32_t) PGMR3PhysReadU32(PVM pVM, RTGCPHYS GCPhys);
539VMMR3DECL(uint64_t) PGMR3PhysReadU64(PVM pVM, RTGCPHYS GCPhys);
540VMMR3DECL(void) PGMR3PhysWriteU8(PVM pVM, RTGCPHYS GCPhys, uint8_t Value);
541VMMR3DECL(void) PGMR3PhysWriteU16(PVM pVM, RTGCPHYS GCPhys, uint16_t Value);
542VMMR3DECL(void) PGMR3PhysWriteU32(PVM pVM, RTGCPHYS GCPhys, uint32_t Value);
543VMMR3DECL(void) PGMR3PhysWriteU64(PVM pVM, RTGCPHYS GCPhys, uint64_t Value);
544VMMR3DECL(int) PGMR3PhysReadExternal(PVM pVM, RTGCPHYS GCPhys, void *pvBuf, size_t cbRead);
545VMMR3DECL(int) PGMR3PhysWriteExternal(PVM pVM, RTGCPHYS GCPhys, const void *pvBuf, size_t cbWrite, const char *pszWho);
546VMMR3DECL(int) PGMR3PhysGCPhys2CCPtrExternal(PVM pVM, RTGCPHYS GCPhys, void **ppv, PPGMPAGEMAPLOCK pLock);
547VMMR3DECL(int) PGMR3PhysGCPhys2CCPtrReadOnlyExternal(PVM pVM, RTGCPHYS GCPhys, void const **ppv, PPGMPAGEMAPLOCK pLock);
548VMMR3DECL(int) PGMR3PhysChunkMap(PVM pVM, uint32_t idChunk);
549VMMR3DECL(void) PGMR3PhysChunkInvalidateTLB(PVM pVM);
550VMMR3DECL(int) PGMR3PhysAllocateHandyPages(PVM pVM);
551VMMR3DECL(int) PGMR3PhysAllocateLargeHandyPage(PVM pVM, RTGCPHYS GCPhys);
552
553VMMR3DECL(void) PGMR3ReleaseOwnedLocks(PVM pVM);
554
555VMMR3DECL(int) PGMR3CheckIntegrity(PVM pVM);
556
557VMMR3DECL(int) PGMR3DbgR3Ptr2GCPhys(PVM pVM, RTR3PTR R3Ptr, PRTGCPHYS pGCPhys);
558VMMR3DECL(int) PGMR3DbgR3Ptr2HCPhys(PVM pVM, RTR3PTR R3Ptr, PRTHCPHYS pHCPhys);
559VMMR3DECL(int) PGMR3DbgHCPhys2GCPhys(PVM pVM, RTHCPHYS HCPhys, PRTGCPHYS pGCPhys);
560VMMR3DECL(int) PGMR3DbgReadGCPhys(PVM pVM, void *pvDst, RTGCPHYS GCPhysSrc, size_t cb, uint32_t fFlags, size_t *pcbRead);
561VMMR3DECL(int) PGMR3DbgWriteGCPhys(PVM pVM, RTGCPHYS GCPhysDst, const void *pvSrc, size_t cb, uint32_t fFlags, size_t *pcbWritten);
562VMMR3DECL(int) PGMR3DbgReadGCPtr(PVM pVM, void *pvDst, RTGCPTR GCPtrSrc, size_t cb, uint32_t fFlags, size_t *pcbRead);
563VMMR3DECL(int) PGMR3DbgWriteGCPtr(PVM pVM, RTGCPTR GCPtrDst, void const *pvSrc, size_t cb, uint32_t fFlags, size_t *pcbWritten);
564VMMR3DECL(int) PGMR3DbgScanPhysical(PVM pVM, RTGCPHYS GCPhys, RTGCPHYS cbRange, RTGCPHYS GCPhysAlign, const uint8_t *pabNeedle, size_t cbNeedle, PRTGCPHYS pGCPhysHit);
565VMMR3DECL(int) PGMR3DbgScanVirtual(PVM pVM, PVMCPU pVCpu, RTGCPTR GCPtr, RTGCPTR cbRange, RTGCPTR GCPtrAlign, const uint8_t *pabNeedle, size_t cbNeedle, PRTGCUINTPTR pGCPhysHit);
566
567
568/** @name Page sharing
569 * @{ */
570VMMR3DECL(int) PGMR3SharedModuleRegister(PVM pVM, VBOXOSFAMILY enmGuestOS, char *pszModuleName, char *pszVersion, RTGCPTR GCBaseAddr, uint32_t cbModule, unsigned cRegions, VMMDEVSHAREDREGIONDESC *pRegions);
571VMMR3DECL(int) PGMR3SharedModuleUnregister(PVM pVM, char *pszModuleName, char *pszVersion, RTGCPTR GCBaseAddr, uint32_t cbModule);
572VMMR3DECL(int) PGMR3SharedModuleCheckAll(PVM pVM);
573/** @} */
574
575/** @} */
576#endif /* IN_RING3 */
577
578RT_C_DECLS_END
579
580/** @} */
581#endif
582
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