gmm.h@ 78976

Last change on this file since 78976 was 76585, checked in by vboxsync, 6 years ago
*: scm --fix-header-guard-endif
Property svn:eol-style set to `native` Property svn:keywords set to `Id Revision`
File size: 30.3 KB

Line
1	/** @file
2	* GMM - The Global Memory Manager.
3	*/
4
5	/*
6	* Copyright (C) 2007-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_gmm_h
27	#define VBOX_INCLUDED_vmm_gmm_h
28	#ifndef RT_WITHOUT_PRAGMA_ONCE
29	# pragma once
30	#endif
31
32	#include <VBox/vmm/gvmm.h>
33	#include <VBox/sup.h>
34	#include <VBox/param.h>
35	#include <VBox/ostypes.h>
36	#include <iprt/avl.h>
37
38
39	RT_C_DECLS_BEGIN
40
41	/** @defgroup grp_gmm GMM - The Global Memory Manager
42	* @ingroup grp_vmm
43	* @{
44	*/
45
46	/** @def IN_GMM_R0
47	* Used to indicate whether we're inside the same link module as the ring 0
48	* part of the Global Memory Manager or not.
49	*/
50	#ifdef DOXYGEN_RUNNING
51	# define IN_GMM_R0
52	#endif
53	/** @def GMMR0DECL
54	* Ring 0 GMM export or import declaration.
55	* @param type The return type of the function declaration.
56	*/
57	#ifdef IN_GMM_R0
58	# define GMMR0DECL(type) DECLEXPORT(type) VBOXCALL
59	#else
60	# define GMMR0DECL(type) DECLIMPORT(type) VBOXCALL
61	#endif
62
63	/** @def IN_GMM_R3
64	* Used to indicate whether we're inside the same link module as the ring 3
65	* part of the Global Memory Manager or not.
66	*/
67	#ifdef DOXYGEN_RUNNING
68	# define IN_GMM_R3
69	#endif
70	/** @def GMMR3DECL
71	* Ring 3 GMM export or import declaration.
72	* @param type The return type of the function declaration.
73	*/
74	#ifdef IN_GMM_R3
75	# define GMMR3DECL(type) DECLEXPORT(type) VBOXCALL
76	#else
77	# define GMMR3DECL(type) DECLIMPORT(type) VBOXCALL
78	#endif
79
80
81	/** The chunk shift. (2^21 = 2 MB) */
82	#define GMM_CHUNK_SHIFT 21
83	/** The allocation chunk size. */
84	#define GMM_CHUNK_SIZE (1U << GMM_CHUNK_SHIFT)
85	/** The allocation chunk size in pages. */
86	#define GMM_CHUNK_NUM_PAGES (1U << (GMM_CHUNK_SHIFT - PAGE_SHIFT))
87	/** The shift factor for converting a page id into a chunk id. */
88	#define GMM_CHUNKID_SHIFT (GMM_CHUNK_SHIFT - PAGE_SHIFT)
89	/** The last valid Chunk ID value. */
90	#define GMM_CHUNKID_LAST (GMM_PAGEID_LAST >> GMM_CHUNKID_SHIFT)
91	/** The last valid Page ID value.
92	* The current limit is 2^28 - 1, or almost 1TB if you like.
93	* The constraints are currently dictated by PGMPAGE. */
94	#define GMM_PAGEID_LAST (RT_BIT_32(28) - 1)
95	/** Mask out the page index from the Page ID. */
96	#define GMM_PAGEID_IDX_MASK ((1U << GMM_CHUNKID_SHIFT) - 1)
97	/** The NIL Chunk ID value. */
98	#define NIL_GMM_CHUNKID 0
99	/** The NIL Page ID value. */
100	#define NIL_GMM_PAGEID 0
101
102	#if 0 /* wrong - these are guest page pfns and not page ids! */
103	/** Special Page ID used by unassigned pages. */
104	#define GMM_PAGEID_UNASSIGNED 0x0fffffffU
105	/** Special Page ID used by unsharable pages.
106	* Like MMIO2, shadow and heap. This is for later, obviously. */
107	#define GMM_PAGEID_UNSHARABLE 0x0ffffffeU
108	/** The end of the valid Page IDs. This is the first special one. */
109	#define GMM_PAGEID_END 0x0ffffff0U
110	#endif
111
112
113	/** @def GMM_GCPHYS_LAST
114	* The last of the valid guest physical address as it applies to GMM pages.
115	*
116	* This must reflect the constraints imposed by the RTGCPHYS type and
117	* the guest page frame number used internally in GMMPAGE.
118	*
119	* @note Note this corresponds to GMM_PAGE_PFN_LAST. */
120	#if HC_ARCH_BITS == 64
121	# define GMM_GCPHYS_LAST UINT64_C(0x00000fffffff0000) /* 2^44 (16TB) - 0x10000 */
122	#else
123	# define GMM_GCPHYS_LAST UINT64_C(0x0000000fffff0000) /* 2^36 (64GB) - 0x10000 */
124	#endif
125
126	/**
127	* Over-commitment policy.
128	*/
129	typedef enum GMMOCPOLICY
130	{
131	/** The usual invalid 0 value. */
132	GMMOCPOLICY_INVALID = 0,
133	/** No over-commitment, fully backed.
134	* The GMM guarantees that it will be able to allocate all of the
135	* guest RAM for a VM with OC policy. */
136	GMMOCPOLICY_NO_OC,
137	/** to-be-determined. */
138	GMMOCPOLICY_TBD,
139	/** The end of the valid policy range. */
140	GMMOCPOLICY_END,
141	/** The usual 32-bit hack. */
142	GMMOCPOLICY_32BIT_HACK = 0x7fffffff
143	} GMMOCPOLICY;
144
145	/**
146	* VM / Memory priority.
147	*/
148	typedef enum GMMPRIORITY
149	{
150	/** The usual invalid 0 value. */
151	GMMPRIORITY_INVALID = 0,
152	/** High.
153	* When ballooning, ask these VMs last.
154	* When running out of memory, try not to interrupt these VMs. */
155	GMMPRIORITY_HIGH,
156	/** Normal.
157	* When ballooning, don't wait to ask these.
158	* When running out of memory, pause, save and/or kill these VMs. */
159	GMMPRIORITY_NORMAL,
160	/** Low.
161	* When ballooning, maximize these first.
162	* When running out of memory, save or kill these VMs. */
163	GMMPRIORITY_LOW,
164	/** The end of the valid priority range. */
165	GMMPRIORITY_END,
166	/** The custom 32-bit type blowup. */
167	GMMPRIORITY_32BIT_HACK = 0x7fffffff
168	} GMMPRIORITY;
169
170
171	/**
172	* GMM Memory Accounts.
173	*/
174	typedef enum GMMACCOUNT
175	{
176	/** The customary invalid zero entry. */
177	GMMACCOUNT_INVALID = 0,
178	/** Account with the base allocations. */
179	GMMACCOUNT_BASE,
180	/** Account with the shadow allocations. */
181	GMMACCOUNT_SHADOW,
182	/** Account with the fixed allocations. */
183	GMMACCOUNT_FIXED,
184	/** The end of the valid values. */
185	GMMACCOUNT_END,
186	/** The usual 32-bit value to finish it off. */
187	GMMACCOUNT_32BIT_HACK = 0x7fffffff
188	} GMMACCOUNT;
189
190
191	/**
192	* Balloon actions.
193	*/
194	typedef enum
195	{
196	/** Invalid zero entry. */
197	GMMBALLOONACTION_INVALID = 0,
198	/** Inflate the balloon. */
199	GMMBALLOONACTION_INFLATE,
200	/** Deflate the balloon. */
201	GMMBALLOONACTION_DEFLATE,
202	/** Puncture the balloon because of VM reset. */
203	GMMBALLOONACTION_RESET,
204	/** End of the valid actions. */
205	GMMBALLOONACTION_END,
206	/** hack forcing the size of the enum to 32-bits. */
207	GMMBALLOONACTION_MAKE_32BIT_HACK = 0x7fffffff
208	} GMMBALLOONACTION;
209
210
211	/**
212	* A page descriptor for use when freeing pages.
213	* See GMMR0FreePages, GMMR0BalloonedPages.
214	*/
215	typedef struct GMMFREEPAGEDESC
216	{
217	/** The Page ID of the page to be freed. */
218	uint32_t idPage;
219	} GMMFREEPAGEDESC;
220	/** Pointer to a page descriptor for freeing pages. */
221	typedef GMMFREEPAGEDESC *PGMMFREEPAGEDESC;
222
223
224	/**
225	* A page descriptor for use when updating and allocating pages.
226	*
227	* This is a bit complicated because we want to do as much as possible
228	* with the same structure.
229	*/
230	typedef struct GMMPAGEDESC
231	{
232	/** The physical address of the page.
233	*
234	* @input GMMR0AllocateHandyPages expects the guest physical address
235	* to update the GMMPAGE structure with. Pass GMM_GCPHYS_UNSHAREABLE
236	* when appropriate and NIL_RTHCPHYS when the page wasn't used
237	* for any specific guest address.
238	*
239	* GMMR0AllocatePage expects the guest physical address to put in
240	* the GMMPAGE structure for the page it allocates for this entry.
241	* Pass NIL_RTHCPHYS and GMM_GCPHYS_UNSHAREABLE as above.
242	*
243	* @output The host physical address of the allocated page.
244	* NIL_RTHCPHYS on allocation failure.
245	*
246	* ASSUMES: sizeof(RTHCPHYS) >= sizeof(RTGCPHYS).
247	*/
248	RTHCPHYS HCPhysGCPhys;
249
250	/** The Page ID.
251	*
252	* @input GMMR0AllocateHandyPages expects the Page ID of the page to
253	* update here. NIL_GMM_PAGEID means no page should be updated.
254	*
255	* GMMR0AllocatePages requires this to be initialized to
256	* NIL_GMM_PAGEID currently.
257	*
258	* @output The ID of the page, NIL_GMM_PAGEID if the allocation failed.
259	*/
260	uint32_t idPage;
261
262	/** The Page ID of the shared page was replaced by this page.
263	*
264	* @input GMMR0AllocateHandyPages expects this to indicate a shared
265	* page that has been replaced by this page and should have its
266	* reference counter decremented and perhaps be freed up. Use
267	* NIL_GMM_PAGEID if no shared page was involved.
268	*
269	* All other APIs expects NIL_GMM_PAGEID here.
270	*
271	* @output All APIs sets this to NIL_GMM_PAGEID.
272	*/
273	uint32_t idSharedPage;
274	} GMMPAGEDESC;
275	AssertCompileSize(GMMPAGEDESC, 16);
276	/** Pointer to a page allocation. */
277	typedef GMMPAGEDESC *PGMMPAGEDESC;
278
279	/** GMMPAGEDESC::HCPhysGCPhys value that indicates that the page is unsharable.
280	* @note This corresponds to GMM_PAGE_PFN_UNSHAREABLE. */
281	#if HC_ARCH_BITS == 64
282	# define GMM_GCPHYS_UNSHAREABLE UINT64_C(0x00000fffffff1000)
283	#else
284	# define GMM_GCPHYS_UNSHAREABLE UINT64_C(0x0000000fffff1000)
285	#endif
286
287
288	/**
289	* The allocation sizes.
290	*/
291	typedef struct GMMVMSIZES
292	{
293	/** The number of pages of base memory.
294	* This is the sum of RAM, ROMs and handy pages. */
295	uint64_t cBasePages;
296	/** The number of pages for the shadow pool. (Can be squeezed for memory.) */
297	uint32_t cShadowPages;
298	/** The number of pages for fixed allocations like MMIO2 and the hyper heap. */
299	uint32_t cFixedPages;
300	} GMMVMSIZES;
301	/** Pointer to a GMMVMSIZES. */
302	typedef GMMVMSIZES *PGMMVMSIZES;
303
304
305	/**
306	* GMM VM statistics.
307	*/
308	typedef struct GMMVMSTATS
309	{
310	/** The reservations. */
311	GMMVMSIZES Reserved;
312	/** The actual allocations.
313	* This includes both private and shared page allocations. */
314	GMMVMSIZES Allocated;
315
316	/** The current number of private pages. */
317	uint64_t cPrivatePages;
318	/** The current number of shared pages. */
319	uint64_t cSharedPages;
320	/** The current number of ballooned pages. */
321	uint64_t cBalloonedPages;
322	/** The max number of pages that can be ballooned. */
323	uint64_t cMaxBalloonedPages;
324	/** The number of pages we've currently requested the guest to give us.
325	* This is 0 if no pages currently requested. */
326	uint64_t cReqBalloonedPages;
327	/** The number of pages the guest has given us in response to the request.
328	* This is not reset on request completed and may be used in later decisions. */
329	uint64_t cReqActuallyBalloonedPages;
330	/** The number of pages we've currently requested the guest to take back. */
331	uint64_t cReqDeflatePages;
332	/** The number of shareable module tracked by this VM. */
333	uint32_t cShareableModules;
334
335	/** The current over-commitment policy. */
336	GMMOCPOLICY enmPolicy;
337	/** The VM priority for arbitrating VMs in low and out of memory situation.
338	* Like which VMs to start squeezing first. */
339	GMMPRIORITY enmPriority;
340	/** Whether ballooning is enabled or not. */
341	bool fBallooningEnabled;
342	/** Whether shared paging is enabled or not. */
343	bool fSharedPagingEnabled;
344	/** Whether the VM is allowed to allocate memory or not.
345	* This is used when the reservation update request fails or when the VM has
346	* been told to suspend/save/die in an out-of-memory case. */
347	bool fMayAllocate;
348	/** Explicit alignment. */
349	bool afReserved[1];
350
351
352	} GMMVMSTATS;
353
354
355	/**
356	* The GMM statistics.
357	*/
358	typedef struct GMMSTATS
359	{
360	/** The maximum number of pages we're allowed to allocate
361	* (GMM::cMaxPages). */
362	uint64_t cMaxPages;
363	/** The number of pages that has been reserved (GMM::cReservedPages). */
364	uint64_t cReservedPages;
365	/** The number of pages that we have over-committed in reservations
366	* (GMM::cOverCommittedPages). */
367	uint64_t cOverCommittedPages;
368	/** The number of actually allocated (committed if you like) pages
369	* (GMM::cAllocatedPages). */
370	uint64_t cAllocatedPages;
371	/** The number of pages that are shared. A subset of cAllocatedPages.
372	* (GMM::cSharedPages) */
373	uint64_t cSharedPages;
374	/** The number of pages that are actually shared between VMs.
375	* (GMM:cDuplicatePages) */
376	uint64_t cDuplicatePages;
377	/** The number of pages that are shared that has been left behind by
378	* VMs not doing proper cleanups (GMM::cLeftBehindSharedPages). */
379	uint64_t cLeftBehindSharedPages;
380	/** The number of current ballooned pages (GMM::cBalloonedPages). */
381	uint64_t cBalloonedPages;
382	/** The number of allocation chunks (GMM::cChunks). */
383	uint32_t cChunks;
384	/** The number of freed chunks ever (GMM::cFreedChunks). */
385	uint32_t cFreedChunks;
386	/** The number of shareable modules (GMM:cShareableModules). */
387	uint64_t cShareableModules;
388	/** Space reserved for later. */
389	uint64_t au64Reserved[2];
390
391	/** Statistics for the specified VM. (Zero filled if not requested.) */
392	GMMVMSTATS VMStats;
393	} GMMSTATS;
394	/** Pointer to the GMM statistics. */
395	typedef GMMSTATS *PGMMSTATS;
396	/** Const pointer to the GMM statistics. */
397	typedef const GMMSTATS *PCGMMSTATS;
398
399
400	GMMR0DECL(int) GMMR0Init(void);
401	GMMR0DECL(void) GMMR0Term(void);
402	GMMR0DECL(void) GMMR0InitPerVMData(PGVM pGVM);
403	GMMR0DECL(void) GMMR0CleanupVM(PGVM pGVM);
404	GMMR0DECL(int) GMMR0InitialReservation(PGVM pGVM, PVM pVM, VMCPUID idCpu, uint64_t cBasePages, uint32_t cShadowPages, uint32_t cFixedPages,
405	GMMOCPOLICY enmPolicy, GMMPRIORITY enmPriority);
406	GMMR0DECL(int) GMMR0UpdateReservation(PGVM pGVM, PVM pVM, VMCPUID idCpu, uint64_t cBasePages, uint32_t cShadowPages, uint32_t cFixedPages);
407	GMMR0DECL(int) GMMR0AllocateHandyPages(PGVM pGVM, PVM pVM, VMCPUID idCpu, uint32_t cPagesToUpdate,
408	uint32_t cPagesToAlloc, PGMMPAGEDESC paPages);
409	GMMR0DECL(int) GMMR0AllocatePages(PGVM pGVM, PVM pVM, VMCPUID idCpu, uint32_t cPages, PGMMPAGEDESC paPages, GMMACCOUNT enmAccount);
410	GMMR0DECL(int) GMMR0AllocateLargePage(PGVM pGVM, PVM pVM, VMCPUID idCpu, uint32_t cbPage, uint32_t pIdPage, RTHCPHYS pHCPhys);
411	GMMR0DECL(int) GMMR0FreePages(PGVM pGVM, PVM pVM, VMCPUID idCpu, uint32_t cPages, PGMMFREEPAGEDESC paPages, GMMACCOUNT enmAccount);
412	GMMR0DECL(int) GMMR0FreeLargePage(PGVM pGVM, PVM pVM, VMCPUID idCpu, uint32_t idPage);
413	GMMR0DECL(int) GMMR0BalloonedPages(PGVM pGVM, PVM pVM, VMCPUID idCpu, GMMBALLOONACTION enmAction, uint32_t cBalloonedPages);
414	GMMR0DECL(int) GMMR0MapUnmapChunk(PGVM pGVM, PVM pVM, uint32_t idChunkMap, uint32_t idChunkUnmap, PRTR3PTR ppvR3);
415	GMMR0DECL(int) GMMR0SeedChunk(PGVM pGVM, PVM pVM, VMCPUID idCpu, RTR3PTR pvR3);
416	GMMR0DECL(int) GMMR0RegisterSharedModule(PGVM pGVM, PVM pVM, VMCPUID idCpu, VBOXOSFAMILY enmGuestOS, char *pszModuleName,
417	char *pszVersion, RTGCPTR GCBaseAddr, uint32_t cbModule, uint32_t cRegions,
418	struct VMMDEVSHAREDREGIONDESC const *paRegions);
419	GMMR0DECL(int) GMMR0UnregisterSharedModule(PGVM pGVM, PVM pVM, VMCPUID idCpu, char pszModuleName, char pszVersion,
420	RTGCPTR GCBaseAddr, uint32_t cbModule);
421	GMMR0DECL(int) GMMR0UnregisterAllSharedModules(PGVM pGVM, PVM pVM, VMCPUID idCpu);
422	GMMR0DECL(int) GMMR0CheckSharedModules(PGVM pGVM, PVM pVM, VMCPUID idCpu);
423	GMMR0DECL(int) GMMR0ResetSharedModules(PGVM pGVM, PVM pVM, VMCPUID idCpu);
424	GMMR0DECL(int) GMMR0QueryStatistics(PGMMSTATS pStats, PSUPDRVSESSION pSession);
425	GMMR0DECL(int) GMMR0ResetStatistics(PCGMMSTATS pStats, PSUPDRVSESSION pSession);
426
427	/**
428	* Request buffer for GMMR0InitialReservationReq / VMMR0_DO_GMM_INITIAL_RESERVATION.
429	* @see GMMR0InitialReservation
430	*/
431	typedef struct GMMINITIALRESERVATIONREQ
432	{
433	/** The header. */
434	SUPVMMR0REQHDR Hdr;
435	uint64_t cBasePages; /*< @see GMMR0InitialReservation /
436	uint32_t cShadowPages; /*< @see GMMR0InitialReservation /
437	uint32_t cFixedPages; /*< @see GMMR0InitialReservation /
438	GMMOCPOLICY enmPolicy; /*< @see GMMR0InitialReservation /
439	GMMPRIORITY enmPriority; /*< @see GMMR0InitialReservation /
440	} GMMINITIALRESERVATIONREQ;
441	/** Pointer to a GMMR0InitialReservationReq / VMMR0_DO_GMM_INITIAL_RESERVATION request buffer. */
442	typedef GMMINITIALRESERVATIONREQ *PGMMINITIALRESERVATIONREQ;
443
444	GMMR0DECL(int) GMMR0InitialReservationReq(PGVM pGVM, PVM pVM, VMCPUID idCpu, PGMMINITIALRESERVATIONREQ pReq);
445
446
447	/**
448	* Request buffer for GMMR0UpdateReservationReq / VMMR0_DO_GMM_UPDATE_RESERVATION.
449	* @see GMMR0UpdateReservation
450	*/
451	typedef struct GMMUPDATERESERVATIONREQ
452	{
453	/** The header. */
454	SUPVMMR0REQHDR Hdr;
455	uint64_t cBasePages; /*< @see GMMR0UpdateReservation /
456	uint32_t cShadowPages; /*< @see GMMR0UpdateReservation /
457	uint32_t cFixedPages; /*< @see GMMR0UpdateReservation /
458	} GMMUPDATERESERVATIONREQ;
459	/** Pointer to a GMMR0InitialReservationReq / VMMR0_DO_GMM_INITIAL_RESERVATION request buffer. */
460	typedef GMMUPDATERESERVATIONREQ *PGMMUPDATERESERVATIONREQ;
461
462	GMMR0DECL(int) GMMR0UpdateReservationReq(PGVM pGVM, PVM pVM, VMCPUID idCpu, PGMMUPDATERESERVATIONREQ pReq);
463
464
465	/**
466	* Request buffer for GMMR0AllocatePagesReq / VMMR0_DO_GMM_ALLOCATE_PAGES.
467	* @see GMMR0AllocatePages.
468	*/
469	typedef struct GMMALLOCATEPAGESREQ
470	{
471	/** The header. */
472	SUPVMMR0REQHDR Hdr;
473	/** The account to charge the allocation to. */
474	GMMACCOUNT enmAccount;
475	/** The number of pages to allocate. */
476	uint32_t cPages;
477	/** Array of page descriptors. */
478	GMMPAGEDESC aPages[1];
479	} GMMALLOCATEPAGESREQ;
480	/** Pointer to a GMMR0AllocatePagesReq / VMMR0_DO_GMM_ALLOCATE_PAGES request buffer. */
481	typedef GMMALLOCATEPAGESREQ *PGMMALLOCATEPAGESREQ;
482
483	GMMR0DECL(int) GMMR0AllocatePagesReq(PGVM pGVM, PVM pVM, VMCPUID idCpu, PGMMALLOCATEPAGESREQ pReq);
484
485
486	/**
487	* Request buffer for GMMR0FreePagesReq / VMMR0_DO_GMM_FREE_PAGES.
488	* @see GMMR0FreePages.
489	*/
490	typedef struct GMMFREEPAGESREQ
491	{
492	/** The header. */
493	SUPVMMR0REQHDR Hdr;
494	/** The account this relates to. */
495	GMMACCOUNT enmAccount;
496	/** The number of pages to free. */
497	uint32_t cPages;
498	/** Array of free page descriptors. */
499	GMMFREEPAGEDESC aPages[1];
500	} GMMFREEPAGESREQ;
501	/** Pointer to a GMMR0FreePagesReq / VMMR0_DO_GMM_FREE_PAGES request buffer. */
502	typedef GMMFREEPAGESREQ *PGMMFREEPAGESREQ;
503
504	GMMR0DECL(int) GMMR0FreePagesReq(PGVM pGVM, PVM pVM, VMCPUID idCpu, PGMMFREEPAGESREQ pReq);
505
506	/**
507	* Request buffer for GMMR0BalloonedPagesReq / VMMR0_DO_GMM_BALLOONED_PAGES.
508	* @see GMMR0BalloonedPages.
509	*/
510	typedef struct GMMBALLOONEDPAGESREQ
511	{
512	/** The header. */
513	SUPVMMR0REQHDR Hdr;
514	/** The number of ballooned pages. */
515	uint32_t cBalloonedPages;
516	/** Inflate or deflate the balloon. */
517	GMMBALLOONACTION enmAction;
518	} GMMBALLOONEDPAGESREQ;
519	/** Pointer to a GMMR0BalloonedPagesReq / VMMR0_DO_GMM_BALLOONED_PAGES request buffer. */
520	typedef GMMBALLOONEDPAGESREQ *PGMMBALLOONEDPAGESREQ;
521
522	GMMR0DECL(int) GMMR0BalloonedPagesReq(PGVM pGVM, PVM pVM, VMCPUID idCpu, PGMMBALLOONEDPAGESREQ pReq);
523
524
525	/**
526	* Request buffer for GMMR0QueryHypervisorMemoryStatsReq / VMMR0_DO_GMM_QUERY_VMM_MEM_STATS.
527	* @see GMMR0QueryHypervisorMemoryStatsReq.
528	*/
529	typedef struct GMMMEMSTATSREQ
530	{
531	/** The header. */
532	SUPVMMR0REQHDR Hdr;
533	/** The number of allocated pages (out). */
534	uint64_t cAllocPages;
535	/** The number of free pages (out). */
536	uint64_t cFreePages;
537	/** The number of ballooned pages (out). */
538	uint64_t cBalloonedPages;
539	/** The number of shared pages (out). */
540	uint64_t cSharedPages;
541	/** Maximum nr of pages (out). */
542	uint64_t cMaxPages;
543	} GMMMEMSTATSREQ;
544	/** Pointer to a GMMR0QueryHypervisorMemoryStatsReq / VMMR0_DO_GMM_QUERY_HYPERVISOR_MEM_STATS request buffer. */
545	typedef GMMMEMSTATSREQ *PGMMMEMSTATSREQ;
546
547	GMMR0DECL(int) GMMR0QueryHypervisorMemoryStatsReq(PGMMMEMSTATSREQ pReq);
548	GMMR0DECL(int) GMMR0QueryMemoryStatsReq(PGVM pGVM, PVM pVM, VMCPUID idCpu, PGMMMEMSTATSREQ pReq);
549
550	/**
551	* Request buffer for GMMR0MapUnmapChunkReq / VMMR0_DO_GMM_MAP_UNMAP_CHUNK.
552	* @see GMMR0MapUnmapChunk
553	*/
554	typedef struct GMMMAPUNMAPCHUNKREQ
555	{
556	/** The header. */
557	SUPVMMR0REQHDR Hdr;
558	/** The chunk to map, NIL_GMM_CHUNKID if unmap only. (IN) */
559	uint32_t idChunkMap;
560	/** The chunk to unmap, NIL_GMM_CHUNKID if map only. (IN) */
561	uint32_t idChunkUnmap;
562	/** Where the mapping address is returned. (OUT) */
563	RTR3PTR pvR3;
564	} GMMMAPUNMAPCHUNKREQ;
565	/** Pointer to a GMMR0MapUnmapChunkReq / VMMR0_DO_GMM_MAP_UNMAP_CHUNK request buffer. */
566	typedef GMMMAPUNMAPCHUNKREQ *PGMMMAPUNMAPCHUNKREQ;
567
568	GMMR0DECL(int) GMMR0MapUnmapChunkReq(PGVM pGVM, PVM pVM, PGMMMAPUNMAPCHUNKREQ pReq);
569
570
571	/**
572	* Request buffer for GMMR0FreeLargePageReq / VMMR0_DO_GMM_FREE_LARGE_PAGE.
573	* @see GMMR0FreeLargePage.
574	*/
575	typedef struct GMMFREELARGEPAGEREQ
576	{
577	/** The header. */
578	SUPVMMR0REQHDR Hdr;
579	/** The Page ID. */
580	uint32_t idPage;
581	} GMMFREELARGEPAGEREQ;
582	/** Pointer to a GMMR0FreePagesReq / VMMR0_DO_GMM_FREE_PAGES request buffer. */
583	typedef GMMFREELARGEPAGEREQ *PGMMFREELARGEPAGEREQ;
584
585	GMMR0DECL(int) GMMR0FreeLargePageReq(PGVM pGVM, PVM pVM, VMCPUID idCpu, PGMMFREELARGEPAGEREQ pReq);
586
587	/** Maximum length of the shared module name string, terminator included. */
588	#define GMM_SHARED_MODULE_MAX_NAME_STRING 128
589	/** Maximum length of the shared module version string, terminator included. */
590	#define GMM_SHARED_MODULE_MAX_VERSION_STRING 16
591
592	/**
593	* Request buffer for GMMR0RegisterSharedModuleReq / VMMR0_DO_GMM_REGISTER_SHARED_MODULE.
594	* @see GMMR0RegisterSharedModule.
595	*/
596	typedef struct GMMREGISTERSHAREDMODULEREQ
597	{
598	/** The header. */
599	SUPVMMR0REQHDR Hdr;
600	/** Shared module size. */
601	uint32_t cbModule;
602	/** Number of included region descriptors */
603	uint32_t cRegions;
604	/** Base address of the shared module. */
605	RTGCPTR64 GCBaseAddr;
606	/** Guest OS type. */
607	VBOXOSFAMILY enmGuestOS;
608	/** return code. */
609	uint32_t rc;
610	/** Module name */
611	char szName[GMM_SHARED_MODULE_MAX_NAME_STRING];
612	/** Module version */
613	char szVersion[GMM_SHARED_MODULE_MAX_VERSION_STRING];
614	/** Shared region descriptor(s). */
615	VMMDEVSHAREDREGIONDESC aRegions[1];
616	} GMMREGISTERSHAREDMODULEREQ;
617	/** Pointer to a GMMR0RegisterSharedModuleReq / VMMR0_DO_GMM_REGISTER_SHARED_MODULE request buffer. */
618	typedef GMMREGISTERSHAREDMODULEREQ *PGMMREGISTERSHAREDMODULEREQ;
619
620	GMMR0DECL(int) GMMR0RegisterSharedModuleReq(PGVM pGVM, PVM pVM, VMCPUID idCpu, PGMMREGISTERSHAREDMODULEREQ pReq);
621
622	/**
623	* Shared region descriptor
624	*/
625	typedef struct GMMSHAREDREGIONDESC
626	{
627	/** The page offset where the region starts. */
628	uint32_t off;
629	/** Region size - adjusted by the region offset and rounded up to a
630	* page. */
631	uint32_t cb;
632	/** Pointer to physical GMM page ID array. */
633	uint32_t *paidPages;
634	} GMMSHAREDREGIONDESC;
635	/** Pointer to a GMMSHAREDREGIONDESC. */
636	typedef GMMSHAREDREGIONDESC *PGMMSHAREDREGIONDESC;
637
638
639	/**
640	* Shared module registration info (global)
641	*/
642	typedef struct GMMSHAREDMODULE
643	{
644	/** Tree node (keyed by a hash of name & version). */
645	AVLLU32NODECORE Core;
646	/** Shared module size. */
647	uint32_t cbModule;
648	/** Number of included region descriptors */
649	uint32_t cRegions;
650	/** Number of users (VMs). */
651	uint32_t cUsers;
652	/** Guest OS family type. */
653	VBOXOSFAMILY enmGuestOS;
654	/** Module name */
655	char szName[GMM_SHARED_MODULE_MAX_NAME_STRING];
656	/** Module version */
657	char szVersion[GMM_SHARED_MODULE_MAX_VERSION_STRING];
658	/** Shared region descriptor(s). */
659	GMMSHAREDREGIONDESC aRegions[1];
660	} GMMSHAREDMODULE;
661	/** Pointer to a GMMSHAREDMODULE. */
662	typedef GMMSHAREDMODULE *PGMMSHAREDMODULE;
663
664	/**
665	* Page descriptor for GMMR0SharedModuleCheckRange
666	*/
667	typedef struct GMMSHAREDPAGEDESC
668	{
669	/** HC Physical address (in/out) */
670	RTHCPHYS HCPhys;
671	/** GC Physical address (in) */
672	RTGCPHYS GCPhys;
673	/** GMM page id. (in/out) */
674	uint32_t idPage;
675	/** CRC32 of the page in strict builds (0 if page not available).
676	* In non-strict build this serves as structure alignment. */
677	uint32_t u32StrictChecksum;
678	} GMMSHAREDPAGEDESC;
679	/** Pointer to a GMMSHAREDPAGEDESC. */
680	typedef GMMSHAREDPAGEDESC *PGMMSHAREDPAGEDESC;
681
682	GMMR0DECL(int) GMMR0SharedModuleCheckPage(PGVM pGVM, PGMMSHAREDMODULE pModule, uint32_t idxRegion, uint32_t idxPage,
683	PGMMSHAREDPAGEDESC pPageDesc);
684
685	/**
686	* Request buffer for GMMR0UnregisterSharedModuleReq / VMMR0_DO_GMM_UNREGISTER_SHARED_MODULE.
687	* @see GMMR0UnregisterSharedModule.
688	*/
689	typedef struct GMMUNREGISTERSHAREDMODULEREQ
690	{
691	/** The header. */
692	SUPVMMR0REQHDR Hdr;
693	/** Shared module size. */
694	uint32_t cbModule;
695	/** Align at 8 byte boundary. */
696	uint32_t u32Alignment;
697	/** Base address of the shared module. */
698	RTGCPTR64 GCBaseAddr;
699	/** Module name */
700	char szName[GMM_SHARED_MODULE_MAX_NAME_STRING];
701	/** Module version */
702	char szVersion[GMM_SHARED_MODULE_MAX_VERSION_STRING];
703	} GMMUNREGISTERSHAREDMODULEREQ;
704	/** Pointer to a GMMR0UnregisterSharedModuleReq / VMMR0_DO_GMM_UNREGISTER_SHARED_MODULE request buffer. */
705	typedef GMMUNREGISTERSHAREDMODULEREQ *PGMMUNREGISTERSHAREDMODULEREQ;
706
707	GMMR0DECL(int) GMMR0UnregisterSharedModuleReq(PGVM pGVM, PVM pVM, VMCPUID idCpu, PGMMUNREGISTERSHAREDMODULEREQ pReq);
708
709	#if defined(VBOX_STRICT) && HC_ARCH_BITS == 64
710	/**
711	* Request buffer for GMMR0FindDuplicatePageReq / VMMR0_DO_GMM_FIND_DUPLICATE_PAGE.
712	* @see GMMR0FindDuplicatePage.
713	*/
714	typedef struct GMMFINDDUPLICATEPAGEREQ
715	{
716	/** The header. */
717	SUPVMMR0REQHDR Hdr;
718	/** Page id. */
719	uint32_t idPage;
720	/** Duplicate flag (out) */
721	bool fDuplicate;
722	} GMMFINDDUPLICATEPAGEREQ;
723	/** Pointer to a GMMR0FindDuplicatePageReq / VMMR0_DO_GMM_FIND_DUPLICATE_PAGE request buffer. */
724	typedef GMMFINDDUPLICATEPAGEREQ *PGMMFINDDUPLICATEPAGEREQ;
725
726	GMMR0DECL(int) GMMR0FindDuplicatePageReq(PGVM pGVM, PVM pVM, PGMMFINDDUPLICATEPAGEREQ pReq);
727	#endif /* VBOX_STRICT && HC_ARCH_BITS == 64 */
728
729
730	/**
731	* Request buffer for GMMR0QueryStatisticsReq / VMMR0_DO_GMM_QUERY_STATISTICS.
732	* @see GMMR0QueryStatistics.
733	*/
734	typedef struct GMMQUERYSTATISTICSSREQ
735	{
736	/** The header. */
737	SUPVMMR0REQHDR Hdr;
738	/** The support driver session. */
739	PSUPDRVSESSION pSession;
740	/** The statistics. */
741	GMMSTATS Stats;
742	} GMMQUERYSTATISTICSSREQ;
743	/** Pointer to a GMMR0QueryStatisticsReq / VMMR0_DO_GMM_QUERY_STATISTICS
744	* request buffer. */
745	typedef GMMQUERYSTATISTICSSREQ *PGMMQUERYSTATISTICSSREQ;
746
747	GMMR0DECL(int) GMMR0QueryStatisticsReq(PGVM pGVM, PVM pVM, PGMMQUERYSTATISTICSSREQ pReq);
748
749
750	/**
751	* Request buffer for GMMR0ResetStatisticsReq / VMMR0_DO_GMM_RESET_STATISTICS.
752	* @see GMMR0ResetStatistics.
753	*/
754	typedef struct GMMRESETSTATISTICSSREQ
755	{
756	/** The header. */
757	SUPVMMR0REQHDR Hdr;
758	/** The support driver session. */
759	PSUPDRVSESSION pSession;
760	/** The statistics to reset.
761	* Any non-zero entry will be reset (if permitted). */
762	GMMSTATS Stats;
763	} GMMRESETSTATISTICSSREQ;
764	/** Pointer to a GMMR0ResetStatisticsReq / VMMR0_DO_GMM_RESET_STATISTICS
765	* request buffer. */
766	typedef GMMRESETSTATISTICSSREQ *PGMMRESETSTATISTICSSREQ;
767
768	GMMR0DECL(int) GMMR0ResetStatisticsReq(PGVM pGVM, PVM pVM, PGMMRESETSTATISTICSSREQ pReq);
769
770
771
772	#ifdef IN_RING3
773	/** @defgroup grp_gmm_r3 The Global Memory Manager Ring-3 API Wrappers
774	* @{
775	*/
776	GMMR3DECL(int) GMMR3InitialReservation(PVM pVM, uint64_t cBasePages, uint32_t cShadowPages, uint32_t cFixedPages,
777	GMMOCPOLICY enmPolicy, GMMPRIORITY enmPriority);
778	GMMR3DECL(int) GMMR3UpdateReservation(PVM pVM, uint64_t cBasePages, uint32_t cShadowPages, uint32_t cFixedPages);
779	GMMR3DECL(int) GMMR3AllocatePagesPrepare(PVM pVM, PGMMALLOCATEPAGESREQ *ppReq, uint32_t cPages, GMMACCOUNT enmAccount);
780	GMMR3DECL(int) GMMR3AllocatePagesPerform(PVM pVM, PGMMALLOCATEPAGESREQ pReq);
781	GMMR3DECL(void) GMMR3AllocatePagesCleanup(PGMMALLOCATEPAGESREQ pReq);
782	GMMR3DECL(int) GMMR3FreePagesPrepare(PVM pVM, PGMMFREEPAGESREQ *ppReq, uint32_t cPages, GMMACCOUNT enmAccount);
783	GMMR3DECL(void) GMMR3FreePagesRePrep(PVM pVM, PGMMFREEPAGESREQ pReq, uint32_t cPages, GMMACCOUNT enmAccount);
784	GMMR3DECL(int) GMMR3FreePagesPerform(PVM pVM, PGMMFREEPAGESREQ pReq, uint32_t cActualPages);
785	GMMR3DECL(void) GMMR3FreePagesCleanup(PGMMFREEPAGESREQ pReq);
786	GMMR3DECL(void) GMMR3FreeAllocatedPages(PVM pVM, GMMALLOCATEPAGESREQ const *pAllocReq);
787	GMMR3DECL(int) GMMR3AllocateLargePage(PVM pVM, uint32_t cbPage);
788	GMMR3DECL(int) GMMR3FreeLargePage(PVM pVM, uint32_t idPage);
789	GMMR3DECL(int) GMMR3MapUnmapChunk(PVM pVM, uint32_t idChunkMap, uint32_t idChunkUnmap, PRTR3PTR ppvR3);
790	GMMR3DECL(int) GMMR3SeedChunk(PVM pVM, RTR3PTR pvR3);
791	GMMR3DECL(int) GMMR3QueryHypervisorMemoryStats(PVM pVM, uint64_t pcTotalAllocPages, uint64_t pcTotalFreePages, uint64_t pcTotalBalloonPages, uint64_t puTotalBalloonSize);
792	GMMR3DECL(int) GMMR3QueryMemoryStats(PVM pVM, uint64_t pcAllocPages, uint64_t pcMaxPages, uint64_t *pcBalloonPages);
793	GMMR3DECL(int) GMMR3BalloonedPages(PVM pVM, GMMBALLOONACTION enmAction, uint32_t cBalloonedPages);
794	GMMR3DECL(int) GMMR3RegisterSharedModule(PVM pVM, PGMMREGISTERSHAREDMODULEREQ pReq);
795	GMMR3DECL(int) GMMR3UnregisterSharedModule(PVM pVM, PGMMUNREGISTERSHAREDMODULEREQ pReq);
796	GMMR3DECL(int) GMMR3CheckSharedModules(PVM pVM);
797	GMMR3DECL(int) GMMR3ResetSharedModules(PVM pVM);
798
799	# if defined(VBOX_STRICT) && HC_ARCH_BITS == 64
800	GMMR3DECL(bool) GMMR3IsDuplicatePage(PVM pVM, uint32_t idPage);
801	# endif
802
803	/** @} */
804	#endif /* IN_RING3 */
805
806	/** @} */
807
808	RT_C_DECLS_END
809
810	#endif /* !VBOX_INCLUDED_vmm_gmm_h */
811

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

source: vbox/trunk/include/VBox/vmm/gmm.h@ 78976

Download in other formats: