ubuntu/vbox/include/VBox/param.h

   1 /** @file
   2  * VirtualBox Parameter Definitions. (VMM,+)
   3  *
   4  * param.mac is generated from this file by running 'kmk incs' in the root.
   5  */
   6
   7 /*
   8  * Copyright (C) 2006-2016 Oracle Corporation
   9  *
  10  * This file is part of VirtualBox Open Source Edition (OSE), as
  11  * available from http://www.virtualbox.org. This file is free software;
  12  * you can redistribute it and/or modify it under the terms of the GNU
  13  * General Public License (GPL) as published by the Free Software
  14  * Foundation, in version 2 as it comes in the "COPYING" file of the
  15  * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
  16  * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
  17  *
  18  * The contents of this file may alternatively be used under the terms
  19  * of the Common Development and Distribution License Version 1.0
  20  * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
  21  * VirtualBox OSE distribution, in which case the provisions of the
  22  * CDDL are applicable instead of those of the GPL.
  23  *
  24  * You may elect to license modified versions of this file under the
  25  * terms and conditions of either the GPL or the CDDL or both.
  26  */
  27
  28 #ifndef ___VBox_param_h
  29 #define ___VBox_param_h
  30
  31 #include <iprt/param.h>
  32 #include <iprt/cdefs.h>
  33
  34
  35 /** @defgroup   grp_vbox_param  VBox Parameter Definition
  36  * @{
  37  */
  38
  39 /** The maximum number of pages that can be allocated and mapped
  40  * by various MM, PGM and SUP APIs. */
  41 #if ARCH_BITS == 64
  42 # define VBOX_MAX_ALLOC_PAGE_COUNT   (_512M / PAGE_SIZE)
  43 #else
  44 # define VBOX_MAX_ALLOC_PAGE_COUNT   (_256M / PAGE_SIZE)
  45 #endif
  46
  47 /** @def VBOX_WITH_PAGE_SHARING
  48  * Enables the page sharing code.
  49  * @remarks This must match GMMR0Init; currently we only support page fusion on
  50  *          all 64-bit hosts except Mac OS X */
  51 #if (   HC_ARCH_BITS == 64          /* ASM-NOINC */ \
  52      && (defined(RT_OS_FREEBSD) || defined(RT_OS_LINUX) || defined(RT_OS_SOLARIS) || defined(RT_OS_WINDOWS)) ) /* ASM-NOINC */ \
  53  || defined(DOXYGEN_RUNNING)        /* ASM-NOINC */
  54 # define VBOX_WITH_PAGE_SHARING     /* ASM-NOINC */
  55 #endif                              /* ASM-NOINC */
  56
  57
  58 /** @defgroup   grp_vbox_param_mm  Memory Monitor Parameters
  59  * @{
  60  */
  61 /** Initial address of Hypervisor Memory Area.
  62  * MUST BE PAGE TABLE ALIGNED! */
  63 #define MM_HYPER_AREA_ADDRESS       UINT32_C(0xa0000000)
  64
  65 /** The max size of the hypervisor memory area. */
  66 #define MM_HYPER_AREA_MAX_SIZE      (40U * _1M) /**< @todo Readjust when floating RAMRANGEs have been implemented. Used to be 20 * _1MB */
  67
  68 /** Maximum number of bytes we can dynamically map into the hypervisor region.
  69  * This must be a power of 2 number of pages!
  70  */
  71 #define MM_HYPER_DYNAMIC_SIZE       (16U * PAGE_SIZE)
  72
  73 /** The minimum guest RAM size in bytes. */
  74 #define MM_RAM_MIN                  UINT32_C(0x00400000)
  75 /** The maximum guest RAM size in bytes. */
  76 #if HC_ARCH_BITS == 64
  77 # define MM_RAM_MAX                 UINT64_C(0x20000000000)
  78 #else
  79 # define MM_RAM_MAX                 UINT64_C(0x000E0000000)
  80 #endif
  81 /** The minimum guest RAM size in MBs. */
  82 #define MM_RAM_MIN_IN_MB            UINT32_C(4)
  83 /** The maximum guest RAM size in MBs. */
  84 #if HC_ARCH_BITS == 64
  85 # define MM_RAM_MAX_IN_MB           UINT32_C(2097152)
  86 #else
  87 # define MM_RAM_MAX_IN_MB           UINT32_C(3584)
  88 #endif
  89 /** The default size of the below 4GB RAM hole. */
  90 #define MM_RAM_HOLE_SIZE_DEFAULT    (512U * _1M)
  91 /** The maximum 64-bit MMIO BAR size.
  92  * @remarks There isn't really any limit here other than the size of the
  93  *          tracking structures we need (around 1/256 of the size). */
  94 #if HC_ARCH_BITS == 64
  95 # define MM_MMIO_64_MAX             _1T
  96 #else
  97 # define MM_MMIO_64_MAX             (_1G64 * 16)
  98 #endif
  99 /** The maximum 32-bit MMIO BAR size. */
 100 #define MM_MMIO_32_MAX              _2G
 101
 102 /** @} */
 103
 104
 105 /** @defgroup   grp_vbox_param_pgm  Page Manager Parameters
 106  * @{
 107  */
 108 /** The number of handy pages.
 109  * This should be a power of two. */
 110 #define PGM_HANDY_PAGES             128
 111 /** The threshold at which allocation of more handy pages is flagged. */
 112 #define PGM_HANDY_PAGES_SET_FF      32
 113 /** The threshold at which we will allocate more when in ring-3.
 114  * This is must be smaller than both PGM_HANDY_PAGES_SET_FF and
 115  * PGM_HANDY_PAGES_MIN. */
 116 #define PGM_HANDY_PAGES_R3_ALLOC    8
 117 /** The threshold at which we will allocate more when in ring-0 or raw mode.
 118  * The idea is that we should never go below this threshold while in ring-0 or
 119  * raw mode because of PGM_HANDY_PAGES_RZ_TO_R3. However, should this happen and
 120  * we are actually out of memory, we will have 8 page to get out of whatever
 121  * code we're executing.
 122  *
 123  * This is must be smaller than both PGM_HANDY_PAGES_SET_FF and
 124  * PGM_HANDY_PAGES_MIN. */
 125 #define PGM_HANDY_PAGES_RZ_ALLOC    8
 126 /** The threshold at which we force return to R3 ASAP.
 127  * The idea is that this should be large enough to get out of any code and up to
 128  * the main EM loop when we are out of memory.
 129  * This must be less or equal to PGM_HANDY_PAGES_MIN. */
 130 #define PGM_HANDY_PAGES_RZ_TO_R3    24
 131 /** The minimum number of handy pages (after allocation).
 132  * This must be greater or equal to PGM_HANDY_PAGES_SET_FF.
 133  * Another name would be PGM_HANDY_PAGES_EXTRA_RESERVATION or _PARANOIA. :-) */
 134 #define PGM_HANDY_PAGES_MIN         32
 135 /** @} */
 136
 137
 138 /** @defgroup   grp_vbox_param_vmm  VMM Parameters
 139  * @{
 140  */
 141 /** VMM stack size. */
 142 #ifdef RT_OS_DARWIN
 143 # define VMM_STACK_SIZE             16384U
 144 #else
 145 # define VMM_STACK_SIZE             8192U
 146 #endif
 147 /** Min number of Virtual CPUs. */
 148 #define VMM_MIN_CPU_COUNT           1
 149 /** Max number of Virtual CPUs. */
 150 #define VMM_MAX_CPU_COUNT           64
 151
 152 /** @} */
 153
 154
 155 /** @defgroup   grp_vbox_pci        PCI Identifiers
 156  * @{ */
 157 /** VirtualBox PCI vendor ID. */
 158 #define VBOX_PCI_VENDORID           (0x80ee)
 159
 160 /** @name VirtualBox graphics card identifiers
 161  * @{ */
 162 #define VBOX_VENDORID               VBOX_PCI_VENDORID   /**< @todo wonderful choice of name! Please squeeze a _VGA_ or something in there, please. */
 163 #define VBOX_DEVICEID               (0xbeef)            /**< @todo ditto. */
 164 #define VBOX_VESA_VENDORID          VBOX_PCI_VENDORID
 165 #define VBOX_VESA_DEVICEID          (0xbeef)
 166 /** @} */
 167
 168 /** @name VMMDev PCI card identifiers
 169  * @{ */
 170 #define VMMDEV_VENDORID             VBOX_PCI_VENDORID
 171 #define VMMDEV_DEVICEID             (0xcafe)
 172 /** @} */
 173
 174 /** @} */
 175
 176
 177 /** @defgroup grp_vbox_param_misc  Misc
 178  * @{ */
 179
 180 /** The maximum size of a generic segment offload (GSO) frame.  This limit is
 181  *  imposed by the 16-bit frame size in internal networking header. */
 182 #define VBOX_MAX_GSO_SIZE           0xfff0
 183
 184 /** @} */
 185
 186
 187 /** @} */
 188
 189 #endif
 190