mono/metadata/sgen-conf.h

   1 /*
   2  * sgen-conf.h: Tunable parameters and debugging switches.
   3  *
   4  * Copyright 2001-2003 Ximian, Inc
   5  * Copyright 2003-2010 Novell, Inc.
   6  * Copyright 2011 Xamarin Inc (http://www.xamarin.com)
   7  * Copyright (C) 2012 Xamarin Inc
   8  *
   9  * This library is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Library General Public
  11  * License 2.0 as published by the Free Software Foundation;
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License 2.0 along with this library; if not, write to the Free
  20  * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21  */
  22 #ifndef __MONO_SGENCONF_H__
  23 #define __MONO_SGENCONF_H__
  24
  25 #include <glib.h>
  26
  27 /*Basic defines and static tunables */
  28
  29 #if SIZEOF_VOID_P == 4
  30 typedef guint32 mword;
  31 #define MWORD_MAX_VALUE ((uint32_t) 0xffffffff)
  32 #else
  33 typedef guint64 mword;
  34 #define MWORD_MAX_VALUE (G_MAXUINT64)
  35 #endif
  36
  37
  38 /*
  39  * Turning on heavy statistics will turn off the managed allocator and
  40  * the managed write barrier.
  41  */
  42 // #define HEAVY_STATISTICS
  43
  44 #ifdef HEAVY_STATISTICS
  45 #define HEAVY_STAT(x)   x
  46 #else
  47 #define HEAVY_STAT(x)
  48 #endif
  49
  50 /*
  51  * Define this to allow the user to change the nursery size by
  52  * specifying its value in the MONO_GC_PARAMS environmental
  53  * variable. See mono_gc_base_init for details.
  54  */
  55 #define USER_CONFIG 1
  56
  57
  58 /*
  59  * If this is set, the nursery is aligned to an address aligned to its size, ie.
  60  * a 1MB nursery will be aligned to an address divisible by 1MB. This allows us to
  61  * speed up ptr_in_nursery () checks which are very frequent. This requires the
  62  * nursery size to be a compile time constant.
  63  */
  64 #define SGEN_ALIGN_NURSERY 1
  65
  66 /*
  67  * The binary protocol enables logging a lot of the GC ativity in a way that is not very
  68  * intrusive and produces a compact file that can be searched using a custom tool.  This
  69  * option enables very fine-grained binary protocol events, which will make the GC a tiny
  70  * bit less efficient even if no binary protocol file is generated.
  71  */
  72 //#define SGEN_HEAVY_BINARY_PROTOCOL
  73
  74 /*
  75  * This enables checks whenever objects are enqueued in gray queues.
  76  * Right now the only check done is that we never enqueue nursery
  77  * pointers in the concurrent collector.
  78  */
  79 //#define SGEN_CHECK_GRAY_OBJECT_ENQUEUE
  80
  81 /*
  82  * This keeps track of where a gray object queue section is and
  83  * whether it is where it should be.
  84  */
  85 //#define SGEN_CHECK_GRAY_OBJECT_SECTIONS
  86
  87 /*
  88  * Define this and use the "xdomain-checks" MONO_GC_DEBUG option to
  89  * have cross-domain checks in the write barrier.
  90  */
  91 //#define XDOMAIN_CHECKS_IN_WBARRIER
  92
  93 /*
  94  * Define this to get number of objects marked information in the
  95  * concurrent GC DTrace probes.  Has a small performance impact, so
  96  * it's disabled by default.
  97  */
  98 //#define SGEN_COUNT_NUMBER_OF_MAJOR_OBJECTS_MARKED
  99
 100 /*
 101  * Object layout statistics gather a histogram of reference locations
 102  * over all scanned objects.  We use this information to improve GC
 103  * descriptors to speed up scanning.  This does not provide any
 104  * troubleshooting assistance (unless you are troubled in highly
 105  * unusual ways) and makes scanning slower.
 106  */
 107 //#define SGEN_OBJECT_LAYOUT_STATISTICS
 108
 109 #ifndef SGEN_HEAVY_BINARY_PROTOCOL
 110 #ifndef HEAVY_STATISTICS
 111 #define MANAGED_ALLOCATION
 112 #ifndef XDOMAIN_CHECKS_IN_WBARRIER
 113 #define MANAGED_WBARRIER
 114 #endif
 115 #endif
 116 #endif
 117
 118 /*
 119  * Maximum level of debug to enable on this build.
 120  * Making this a constant enables us to put logging in a lot of places and
 121  * not pay its cost on release builds.
 122  */
 123 #define SGEN_MAX_DEBUG_LEVEL 2
 124
 125 /*
 126  * Maximum level of asserts to enable on this build.
 127  * FIXME replace all magic numbers with defines.
 128  */
 129 #define SGEN_MAX_ASSERT_LEVEL 5
 130
 131
 132 #define GC_BITS_PER_WORD (sizeof (mword) * 8)
 133
 134 /*Size of the section used by the copying GC. */
 135 #define SGEN_SIZEOF_GC_MEM_SECTION      ((sizeof (GCMemSection) + 7) & ~7)
 136
 137 /*
 138  * to quickly find the head of an object pinned by a conservative
 139  * address we keep track of the objects allocated for each
 140  * SGEN_SCAN_START_SIZE memory chunk in the nursery or other memory
 141  * sections. Larger values have less memory overhead and bigger
 142  * runtime cost. 4-8 KB are reasonable values.
 143  */
 144 #define SGEN_SCAN_START_SIZE (4096*2)
 145
 146 /*
 147  * Objects bigger then this go into the large object space.  This size
 148  * has a few constraints.  It must fit into the major heap, which in
 149  * the case of the copying collector means that it must fit into a
 150  * pinned chunk.  It must also play well with the GC descriptors, some
 151  * of which (DESC_TYPE_RUN_LENGTH, DESC_TYPE_SMALL_BITMAP) encode the
 152  * object size.
 153  */
 154 #define SGEN_MAX_SMALL_OBJ_SIZE 8000
 155
 156 /*
 157  * This is the maximum ammount of memory we're willing to waste in order to speed up allocation.
 158  * Wastage comes in thre forms:
 159  *
 160  * -when building the nursery fragment list, small regions are discarded;
 161  * -when allocating memory from a fragment if it ends up below the threshold, we remove it from the fragment list; and
 162  * -when allocating a new tlab, we discard the remaining space of the old one
 163  *
 164  * Increasing this value speeds up allocation but will cause more frequent nursery collections as less space will be used.
 165  * Descreasing this value will cause allocation to be slower since we'll have to cycle thru more fragments.
 166  * 512 annedoctally keeps wastage under control and doesn't impact allocation performance too much.
 167 */
 168 #define SGEN_MAX_NURSERY_WASTE 512
 169
 170
 171 /*
 172  * Minimum allowance for nursery allocations, as a multiple of the size of nursery.
 173  *
 174  * We allow at least this much allocation to happen to the major heap from multiple
 175  * minor collections before triggering a major collection.
 176  *
 177  * Bigger values increases throughput by allowing more garbage to sit in the major heap.
 178  * Smaller values leads to better memory effiency but more frequent major collections.
 179  */
 180 #define SGEN_DEFAULT_ALLOWANCE_NURSERY_SIZE_RATIO 4.0
 181
 182 #define SGEN_MIN_ALLOWANCE_NURSERY_SIZE_RATIO 1.0
 183 #define SGEN_MAX_ALLOWANCE_NURSERY_SIZE_RATIO 10.0
 184
 185 /*
 186  * Default ratio of memory we want to release in a major collection in relation to the the current heap size.
 187  *
 188  * A major collection target is to free a given amount of memory. This amount is a ratio of the major heap size.
 189  *
 190  * Values above 0.5 cause the heap to agressively grow when it's small and waste memory when it's big.
 191  * Lower values will produce more reasonable sized heaps when it's small, but will be suboptimal at large
 192  * sizes as they will use a small fraction only.
 193  *
 194  */
 195 #define SGEN_DEFAULT_SAVE_TARGET_RATIO 0.5
 196
 197 #define SGEN_MIN_SAVE_TARGET_RATIO 0.1
 198 #define SGEN_MAX_SAVE_TARGET_RATIO 2.0
 199
 200 /*
 201  * Configurable cementing parameters.
 202  *
 203  * If there are too many pinned nursery objects with many references
 204  * from the major heap, the hash table size must be increased.
 205  *
 206  * The threshold is the number of references from the major heap to a
 207  * pinned nursery object which triggers cementing: if there are more
 208  * than that number of references, the pinned object is cemented until
 209  * the next major collection.
 210  */
 211 #define SGEN_CEMENT_HASH_SHIFT  6
 212 #define SGEN_CEMENT_HASH_SIZE   (1 << SGEN_CEMENT_HASH_SHIFT)
 213 #define SGEN_CEMENT_HASH(hv)    (((hv) ^ ((hv) >> SGEN_CEMENT_HASH_SHIFT)) & (SGEN_CEMENT_HASH_SIZE - 1))
 214 #define SGEN_CEMENT_THRESHOLD   1000
 215
 216 #endif