GMMR0Internal.h revision 209c11e4b5dbb310116c99a42d773163928e002b
/* $Id$ */
/** @file
* GMM - The Global Memory Manager, Internal Header.
*/
/*
* Copyright (C) 2007 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* you can redistribute it and/or modify it under the terms of the GNU
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*/
#ifndef ___GMMR0Internal_h
#define ___GMMR0Internal_h
#include <VBox/gmm.h>
#include <iprt/avl.h>
/**
* The allocation sizes.
*/
typedef struct GMMVMSIZES
{
/** The number of pages of base memory.
* This is the sum of RAM, ROMs and handy pages. */
uint64_t cBasePages;
/** The number of pages for the shadow pool. (Can be sequeezed for memory.) */
uint32_t cShadowPages;
/** The number of pages for fixed allocations like MMIO2 and the hyper heap. */
uint32_t cFixedPages;
} GMMVMSIZES;
/** Pointer to a GMMVMSIZES. */
typedef GMMVMSIZES *PGMMVMSIZES;
/**
* Shared region descriptor
*/
typedef struct GMMSHAREDREGIONDESC
{
/** Region base address. */
RTGCPTR64 GCRegionAddr;
/** Region size. */
uint32_t cbRegion;
/** Alignment. */
uint32_t u32Alignment;
/** Pointer to physical page address array. */
PRTHCPHYS paHCPhysAndPageID;
} GMMSHAREDREGIONDESC;
/** Pointer to a GMMSHAREDREGIONDESC. */
typedef GMMSHAREDREGIONDESC *PGMMSHAREDREGIONDESC;
/**
* Shared module registration info (global)
*/
typedef struct GMMSHAREDMODULE
{
/* Tree node. */
AVLGCPTRNODECORE Core;
/** Shared module size. */
uint32_t cbModule;
/** Number of included region descriptors */
uint32_t cRegions;
/** Number of users (VMs). */
uint32_t cUsers;
/** Align. */
uint32_t u32Align;
/** Module name */
char szName[GMM_SHARED_MODULE_MAX_NAME_STRING];
/** Module version */
char szVersion[GMM_SHARED_MODULE_MAX_VERSION_STRING];
/** Shared region descriptor(s). */
GMMSHAREDREGIONDESC aRegions[1];
} GMMSHAREDMODULE;
/** Pointer to a GMMSHAREDMODULE. */
typedef GMMSHAREDMODULE *PGMMSHAREDMODULE;
/**
* Shared module registration info (per VM)
*/
typedef struct GMMSHAREDMODULEPERVM
{
/* Tree node. */
AVLGCPTRNODECORE Core;
/* Pointer to global shared module info. */
PGMMSHAREDMODULE pSharedModule;
/* Set if another VM registered a different shared module at the same base address. */
bool fCollision;
/** Align at 8 byte boundary */
bool abAlignment[7];
/** Number of regions in the aRegions array. */
unsigned cRegions;
/** Shared region descriptor(s). */
GMMSHAREDREGIONDESC aRegions[1];
} GMMSHAREDMODULEPERVM;
/** Pointer to a GMMSHAREDMODULEPERVM. */
typedef GMMSHAREDMODULEPERVM *PGMMSHAREDMODULEPERVM;
/**
* The per-VM GMM data.
*/
typedef struct GMMPERVM
{
/** The reservations. */
GMMVMSIZES Reserved;
/** The actual allocations.
* This includes both private and shared page allocations. */
GMMVMSIZES Allocated;
/** The current number of private pages. */
uint64_t cPrivatePages;
/** The current number of shared pages. */
uint64_t cSharedPages;
/** The current over-comitment policy. */
GMMOCPOLICY enmPolicy;
/** The VM priority for arbitrating VMs in low and out of memory situation.
* Like which VMs to start sequeezing first. */
GMMPRIORITY enmPriority;
/** The current number of ballooned pages. */
uint64_t cBalloonedPages;
/** The max number of pages that can be ballooned. */
uint64_t cMaxBalloonedPages;
/** The number of pages we've currently requested the guest to give us.
* This is 0 if no pages currently requested. */
uint64_t cReqBalloonedPages;
/** The number of pages the guest has given us in response to the request.
* This is not reset on request completed and may be used in later decisions. */
uint64_t cReqActuallyBalloonedPages;
/** The number of pages we've currently requested the guest to take back. */
uint64_t cReqDeflatePages;
/** Shared module tree (per-vm). */
PAVLGCPTRNODECORE pSharedModuleTree;
/** Whether ballooning is enabled or not. */
bool fBallooningEnabled;
/** Whether shared paging is enabled or not. */
bool fSharedPagingEnabled;
/** Whether the VM is allowed to allocate memory or not.
* This is used when the reservation update request fails or when the VM has
* been told to suspend/save/die in an out-of-memory case. */
bool fMayAllocate;
} GMMPERVM;
/** Pointer to the per-VM GMM data. */
typedef GMMPERVM *PGMMPERVM;
#endif