param.h revision 0f36c619d6b7b56483b663420233deccf2f974cd
/** @file
* VirtualBox Parameter Definitions. (VMM,+)
*
* param.mac is generated from this file by running 'kmk incs' in the root.
*/
/*
* Copyright (C) 2006-2009 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* 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.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
* VirtualBox OSE distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*/
#ifndef ___VBox_param_h
#define ___VBox_param_h
/** @defgroup grp_vbox_param VBox Parameter Definition
* @{
*/
/** The maximum number of pages that can be allocated and mapped
* by various MM, PGM and SUP APIs. */
/** @def VBOX_WITH_PAGE_SHARING
* Enables the page sharing code.
* @remarks This must match GMMR0Init; currently we only support page fusion on
* all 64-bit hosts except Mac OS X */
#if ( HC_ARCH_BITS == 64 \
&& (defined(RT_OS_FREEBSD) || defined(RT_OS_LINUX) || defined(RT_OS_SOLARIS) || defined(RT_OS_WINDOWS)) ) \
|| defined(DOXYGEN_RUNNING)
# define VBOX_WITH_PAGE_SHARING
#endif
/** @defgroup grp_vbox_param_mm Memory Monitor Parameters
* @ingroup grp_vbox_param
* @{
*/
/** Initial address of Hypervisor Memory Area.
* MUST BE PAGE TABLE ALIGNED! */
/** The max size of the hypervisor memory area. */
#define MM_HYPER_AREA_MAX_SIZE (40U * _1M) /**< @todo Readjust when floating RAMRANGEs have been implemented. Used to be 20 * _1MB */
/** Maximum number of bytes we can dynamically map into the hypervisor region.
* This must be a power of 2 number of pages!
*/
/** The minimum guest RAM size in bytes. */
/** The maximum guest RAM size in bytes. */
#if HC_ARCH_BITS == 64
#else
#endif
/** The minimum guest RAM size in MBs. */
/** The maximum guest RAM size in MBs. */
#if HC_ARCH_BITS == 64
#else
#endif
/** The default size of the below 4GB RAM hole. */
/** @} */
/** @defgroup grp_vbox_param_pgm Page Manager Parameters
* @ingroup grp_vbox_param
* @{
*/
/** The number of handy pages.
* This should be a power of two. */
#define PGM_HANDY_PAGES 128
/** The threshold at which allocation of more handy pages is flagged. */
#define PGM_HANDY_PAGES_SET_FF 32
/** The threshold at which we will allocate more when in ring-3.
* This is must be smaller than both PGM_HANDY_PAGES_SET_FF and
* PGM_HANDY_PAGES_MIN. */
#define PGM_HANDY_PAGES_R3_ALLOC 8
/** The threshold at which we will allocate more when in ring-0 or raw mode.
* The idea is that we should never go below this threshold while in ring-0 or
* raw mode because of PGM_HANDY_PAGES_RZ_TO_R3. However, should this happen and
* we are actually out of memory, we will have 8 page to get out of whatever
* code we're executing.
*
* This is must be smaller than both PGM_HANDY_PAGES_SET_FF and
* PGM_HANDY_PAGES_MIN. */
#define PGM_HANDY_PAGES_RZ_ALLOC 8
/** The threshold at which we force return to R3 ASAP.
* The idea is that this should be large enough to get out of any code and up to
* the main EM loop when we are out of memory.
* This must be less or equal to PGM_HANDY_PAGES_MIN. */
#define PGM_HANDY_PAGES_RZ_TO_R3 24
/** The minimum number of handy pages (after allocation).
* This must be greater or equal to PGM_HANDY_PAGES_SET_FF.
* Another name would be PGM_HANDY_PAGES_EXTRA_RESERVATION or _PARANOIA. :-) */
#define PGM_HANDY_PAGES_MIN 32
/** @} */
/** @defgroup grp_vbox_param_vmm VMM Parameters
* @ingroup grp_vbox_param
* @{
*/
/** VMM stack size. */
#ifdef RT_OS_DARWIN
# define VMM_STACK_SIZE 16384U
#else
# define VMM_STACK_SIZE 8192U
#endif
/** Min number of Virtual CPUs. */
#define VMM_MIN_CPU_COUNT 1
/** Max number of Virtual CPUs. */
#define VMM_MAX_CPU_COUNT 32
/** @} */
/** @defgroup grp_vbox_pci PCI Identifiers
* @{ */
/** VirtualBox PCI vendor ID. */
#define VBOX_PCI_VENDORID (0x80ee)
/** @name VirtualBox graphics card identifiers
* @{ */
#define VBOX_VENDORID VBOX_PCI_VENDORID /**< @todo wonderful choice of name! Please squeeze a _VGA_ or something in there, please. */
#define VBOX_VESA_VENDORID VBOX_PCI_VENDORID
#define VBOX_VESA_DEVICEID (0xbeef)
/** @} */
/** @name VMMDev PCI card identifiers
* @{ */
#define VMMDEV_VENDORID VBOX_PCI_VENDORID
#define VMMDEV_DEVICEID (0xcafe)
/** @} */
/** @} */
/** @defgroup grp_vbox_param_misc Misc
* @{ */
/** The maximum size of a generic segment offload (GSO) frame. This limit is
* imposed by the 16-bit frame size in internal networking header. */
#define VBOX_MAX_GSO_SIZE 0xfff0
/** @} */
/** @} */
#endif