src/share/vm/gc_implementation/g1/heapRegionSet.hpp

Fri, 14 Mar 2014 10:15:46 +0100

author
brutisso
date
Fri, 14 Mar 2014 10:15:46 +0100
changeset 6385
58fc1b1523dc
parent 3957
a2f7274eb6ef
child 6422
8ee855b4e667
permissions
-rw-r--r--

8034079: G1: Refactor the HeapRegionSet hierarchy
Reviewed-by: tschatzl, pliden

tonyp@2472 1 /*
tonyp@3457 2 * Copyright (c) 2011, 2012, Oracle and/or its affiliates. All rights reserved.
tonyp@2472 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
tonyp@2472 4 *
tonyp@2472 5 * This code is free software; you can redistribute it and/or modify it
tonyp@2472 6 * under the terms of the GNU General Public License version 2 only, as
tonyp@2472 7 * published by the Free Software Foundation.
tonyp@2472 8 *
tonyp@2472 9 * This code is distributed in the hope that it will be useful, but WITHOUT
tonyp@2472 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
tonyp@2472 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
tonyp@2472 12 * version 2 for more details (a copy is included in the LICENSE file that
tonyp@2472 13 * accompanied this code).
tonyp@2472 14 *
tonyp@2472 15 * You should have received a copy of the GNU General Public License version
tonyp@2472 16 * 2 along with this work; if not, write to the Free Software Foundation,
tonyp@2472 17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
tonyp@2472 18 *
tonyp@2472 19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
tonyp@2472 20 * or visit www.oracle.com if you need additional information or have any
tonyp@2472 21 * questions.
tonyp@2472 22 *
tonyp@2472 23 */
tonyp@2472 24
tonyp@2472 25 #ifndef SHARE_VM_GC_IMPLEMENTATION_G1_HEAPREGIONSET_HPP
tonyp@2472 26 #define SHARE_VM_GC_IMPLEMENTATION_G1_HEAPREGIONSET_HPP
tonyp@2472 27
tonyp@2472 28 #include "gc_implementation/g1/heapRegion.hpp"
tonyp@2472 29
tonyp@2472 30 // Large buffer for some cases where the output might be larger than normal.
tonyp@2643 31 #define HRS_ERR_MSG_BUFSZ 512
tonyp@2643 32 typedef FormatBuffer<HRS_ERR_MSG_BUFSZ> hrs_err_msg;
tonyp@2472 33
tonyp@2472 34 // Set verification will be forced either if someone defines
tonyp@2472 35 // HEAP_REGION_SET_FORCE_VERIFY to be 1, or in builds in which
tonyp@2472 36 // asserts are compiled in.
tonyp@2472 37 #ifndef HEAP_REGION_SET_FORCE_VERIFY
tonyp@2472 38 #define HEAP_REGION_SET_FORCE_VERIFY defined(ASSERT)
tonyp@2472 39 #endif // HEAP_REGION_SET_FORCE_VERIFY
tonyp@2472 40
brutisso@6385 41 class hrs_ext_msg;
brutisso@6385 42
brutisso@6385 43 class HRSMtSafeChecker : public CHeapObj<mtGC> {
brutisso@6385 44 public:
brutisso@6385 45 virtual void check() = 0;
brutisso@6385 46 };
brutisso@6385 47
brutisso@6385 48 class MasterFreeRegionListMtSafeChecker : public HRSMtSafeChecker { public: void check(); };
brutisso@6385 49 class SecondaryFreeRegionListMtSafeChecker : public HRSMtSafeChecker { public: void check(); };
brutisso@6385 50 class HumongousRegionSetMtSafeChecker : public HRSMtSafeChecker { public: void check(); };
brutisso@6385 51 class OldRegionSetMtSafeChecker : public HRSMtSafeChecker { public: void check(); };
brutisso@6385 52
brutisso@6385 53 class HeapRegionSetCount VALUE_OBJ_CLASS_SPEC {
brutisso@6385 54 friend class VMStructs;
brutisso@6385 55 uint _length;
brutisso@6385 56 size_t _capacity;
brutisso@6385 57
brutisso@6385 58 public:
brutisso@6385 59 HeapRegionSetCount() : _length(0), _capacity(0) { }
brutisso@6385 60
brutisso@6385 61 const uint length() const { return _length; }
brutisso@6385 62 const size_t capacity() const { return _capacity; }
brutisso@6385 63
brutisso@6385 64 void increment(uint length_to_add, size_t capacity_to_add) {
brutisso@6385 65 _length += length_to_add;
brutisso@6385 66 _capacity += capacity_to_add;
brutisso@6385 67 }
brutisso@6385 68
brutisso@6385 69 void decrement(const uint length_to_remove, const size_t capacity_to_remove) {
brutisso@6385 70 _length -= length_to_remove;
brutisso@6385 71 _capacity -= capacity_to_remove;
brutisso@6385 72 }
brutisso@6385 73 };
tonyp@2472 74
tonyp@2472 75 // Base class for all the classes that represent heap region sets. It
tonyp@2472 76 // contains the basic attributes that each set needs to maintain
tonyp@2472 77 // (e.g., length, region num, used bytes sum) plus any shared
tonyp@2472 78 // functionality (e.g., verification).
tonyp@2472 79
tonyp@2472 80 class HeapRegionSetBase VALUE_OBJ_CLASS_SPEC {
tonyp@3457 81 friend class VMStructs;
brutisso@6385 82 private:
brutisso@6385 83 bool _is_humongous;
brutisso@6385 84 bool _is_empty;
brutisso@6385 85 HRSMtSafeChecker* _mt_safety_checker;
tonyp@2472 86
tonyp@2472 87 protected:
tonyp@2472 88 // The number of regions added to the set. If the set contains
tonyp@2472 89 // only humongous regions, this reflects only 'starts humongous'
tonyp@2472 90 // regions and does not include 'continues humongous' ones.
brutisso@6385 91 HeapRegionSetCount _count;
tonyp@2472 92
tonyp@2472 93 const char* _name;
tonyp@2472 94
brutisso@6385 95 bool _verify_in_progress;
tonyp@3268 96
tonyp@2472 97 // verify_region() is used to ensure that the contents of a region
brutisso@6385 98 // added to / removed from a set are consistent.
brutisso@6385 99 void verify_region(HeapRegion* hr) PRODUCT_RETURN;
tonyp@2472 100
tonyp@2472 101 // Indicates whether all regions in the set should be humongous or
tonyp@2472 102 // not. Only used during verification.
brutisso@6385 103 bool regions_humongous() { return _is_humongous; }
tonyp@2472 104
tonyp@2472 105 // Indicates whether all regions in the set should be empty or
tonyp@2472 106 // not. Only used during verification.
brutisso@6385 107 bool regions_empty() { return _is_empty; }
tonyp@2472 108
brutisso@6385 109 void check_mt_safety() {
brutisso@6385 110 if (_mt_safety_checker != NULL) {
brutisso@6385 111 _mt_safety_checker->check();
brutisso@6385 112 }
brutisso@6385 113 }
brutisso@6385 114
brutisso@6385 115 virtual void fill_in_ext_msg_extra(hrs_ext_msg* msg) { }
brutisso@6385 116
brutisso@6385 117 HeapRegionSetBase(const char* name, bool humongous, bool empty, HRSMtSafeChecker* mt_safety_checker);
brutisso@6385 118
brutisso@6385 119 public:
brutisso@6385 120 const char* name() { return _name; }
brutisso@6385 121
brutisso@6385 122 uint length() { return _count.length(); }
brutisso@6385 123
brutisso@6385 124 bool is_empty() { return _count.length() == 0; }
brutisso@6385 125
brutisso@6385 126 size_t total_capacity_bytes() {
brutisso@6385 127 return _count.capacity();
brutisso@6385 128 }
brutisso@6385 129
brutisso@6385 130 // It updates the fields of the set to reflect hr being added to
brutisso@6385 131 // the set and tags the region appropriately.
brutisso@6385 132 inline void add(HeapRegion* hr);
brutisso@6385 133
brutisso@6385 134 // It updates the fields of the set to reflect hr being removed
brutisso@6385 135 // from the set and tags the region appropriately.
brutisso@6385 136 inline void remove(HeapRegion* hr);
tonyp@2472 137
tonyp@2472 138 // fill_in_ext_msg() writes the the values of the set's attributes
tonyp@2643 139 // in the custom err_msg (hrs_ext_msg). fill_in_ext_msg_extra()
tonyp@2472 140 // allows subclasses to append further information.
tonyp@2643 141 void fill_in_ext_msg(hrs_ext_msg* msg, const char* message);
tonyp@2472 142
tonyp@2472 143 virtual void verify();
tonyp@2472 144 void verify_start();
tonyp@2472 145 void verify_next_region(HeapRegion* hr);
tonyp@2472 146 void verify_end();
tonyp@2472 147
tonyp@2472 148 #if HEAP_REGION_SET_FORCE_VERIFY
tonyp@2472 149 void verify_optional() {
tonyp@2472 150 verify();
tonyp@2472 151 }
tonyp@2472 152 #else // HEAP_REGION_SET_FORCE_VERIFY
tonyp@2472 153 void verify_optional() { }
tonyp@2472 154 #endif // HEAP_REGION_SET_FORCE_VERIFY
tonyp@2472 155
tonyp@2472 156 virtual void print_on(outputStream* out, bool print_contents = false);
tonyp@2472 157 };
tonyp@2472 158
tonyp@2472 159 // Customized err_msg for heap region sets. Apart from a
tonyp@2472 160 // assert/guarantee-specific message it also prints out the values of
tonyp@2472 161 // the fields of the associated set. This can be very helpful in
tonyp@2472 162 // diagnosing failures.
tonyp@2643 163 class hrs_ext_msg : public hrs_err_msg {
tonyp@2472 164 public:
tonyp@2643 165 hrs_ext_msg(HeapRegionSetBase* set, const char* message) : hrs_err_msg("") {
tonyp@2472 166 set->fill_in_ext_msg(this, message);
tonyp@2472 167 }
tonyp@2472 168 };
tonyp@2472 169
tonyp@2643 170 #define hrs_assert_sets_match(_set1_, _set2_) \
tonyp@2472 171 do { \
tonyp@2472 172 assert(((_set1_)->regions_humongous() == \
tonyp@2472 173 (_set2_)->regions_humongous()) && \
tonyp@2472 174 ((_set1_)->regions_empty() == (_set2_)->regions_empty()), \
tonyp@2643 175 hrs_err_msg("the contents of set %s and set %s should match", \
tonyp@2472 176 (_set1_)->name(), (_set2_)->name())); \
tonyp@2472 177 } while (0)
tonyp@2472 178
tonyp@2472 179 // This class represents heap region sets whose members are not
tonyp@2472 180 // explicitly tracked. It's helpful to group regions using such sets
tonyp@2472 181 // so that we can reason about all the region groups in the heap using
tonyp@2472 182 // the same interface (namely, the HeapRegionSetBase API).
tonyp@2472 183
tonyp@2472 184 class HeapRegionSet : public HeapRegionSetBase {
brutisso@6385 185 public:
brutisso@6385 186 HeapRegionSet(const char* name, bool humongous, HRSMtSafeChecker* mt_safety_checker):
brutisso@6385 187 HeapRegionSetBase(name, humongous, false /* empty */, mt_safety_checker) { }
tonyp@2472 188
brutisso@6385 189 void bulk_remove(const HeapRegionSetCount& removed) {
brutisso@6385 190 _count.decrement(removed.length(), removed.capacity());
tonyp@2472 191 }
tonyp@2472 192 };
tonyp@2472 193
tonyp@2472 194 // A set that links all the regions added to it in a singly-linked
tonyp@2472 195 // list. We should try to avoid doing operations that iterate over
tonyp@2472 196 // such lists in performance critical paths. Typically we should
tonyp@2472 197 // add / remove one region at a time or concatenate two lists. All
tonyp@2472 198 // those operations are done in constant time.
tonyp@2472 199
brutisso@6385 200 class FreeRegionListIterator;
tonyp@2472 201
brutisso@6385 202 class FreeRegionList : public HeapRegionSetBase {
brutisso@6385 203 friend class FreeRegionListIterator;
tonyp@2472 204
tonyp@2472 205 private:
tonyp@2472 206 HeapRegion* _head;
tonyp@2472 207 HeapRegion* _tail;
tonyp@2472 208
brutisso@6385 209 static uint _unrealistically_long_length;
brutisso@6385 210
brutisso@6385 211 void add_as_head_or_tail(FreeRegionList* from_list, bool as_head);
tonyp@2472 212
tonyp@2472 213 protected:
tonyp@2643 214 virtual void fill_in_ext_msg_extra(hrs_ext_msg* msg);
tonyp@2472 215
tonyp@2472 216 // See the comment for HeapRegionSetBase::clear()
tonyp@2472 217 virtual void clear();
tonyp@2472 218
brutisso@6385 219 public:
brutisso@6385 220 FreeRegionList(const char* name, HRSMtSafeChecker* mt_safety_checker = NULL):
brutisso@6385 221 HeapRegionSetBase(name, false /* humongous */, true /* empty */, mt_safety_checker) {
tonyp@2472 222 clear();
tonyp@2472 223 }
tonyp@2472 224
brutisso@6385 225 void verify_list();
brutisso@6385 226
brutisso@6385 227 HeapRegion* head() { return _head; }
brutisso@6385 228 HeapRegion* tail() { return _tail; }
brutisso@6385 229
brutisso@6385 230 static void set_unrealistically_long_length(uint len);
brutisso@6385 231
tonyp@2714 232 // It adds hr to the list as the new head. The region should not be
tonyp@2714 233 // a member of another set.
tonyp@2714 234 inline void add_as_head(HeapRegion* hr);
tonyp@2714 235
tonyp@2472 236 // It adds hr to the list as the new tail. The region should not be
tonyp@2472 237 // a member of another set.
tonyp@2472 238 inline void add_as_tail(HeapRegion* hr);
tonyp@2472 239
tonyp@2472 240 // It removes and returns the head of the list. It assumes that the
tonyp@2472 241 // list is not empty so it will return a non-NULL value.
tonyp@2472 242 inline HeapRegion* remove_head();
tonyp@2472 243
tonyp@2472 244 // Convenience method.
tonyp@2472 245 inline HeapRegion* remove_head_or_null();
tonyp@2472 246
tonyp@2472 247 // It moves the regions from from_list to this list and empties
tonyp@2472 248 // from_list. The new regions will appear in the same order as they
tonyp@2714 249 // were in from_list and be linked in the beginning of this list.
brutisso@6385 250 void add_as_head(FreeRegionList* from_list);
tonyp@2714 251
tonyp@2714 252 // It moves the regions from from_list to this list and empties
tonyp@2714 253 // from_list. The new regions will appear in the same order as they
tonyp@2472 254 // were in from_list and be linked in the end of this list.
brutisso@6385 255 void add_as_tail(FreeRegionList* from_list);
tonyp@2472 256
tonyp@2472 257 // It empties the list by removing all regions from it.
tonyp@2472 258 void remove_all();
tonyp@2472 259
tonyp@2472 260 // It removes all regions in the list that are pending for removal
tonyp@2472 261 // (i.e., they have been tagged with "pending_removal"). The list
tonyp@2472 262 // must not be empty, target_count should reflect the exact number
tonyp@2472 263 // of regions that are pending for removal in the list, and
tonyp@2472 264 // target_count should be > 1 (currently, we never need to remove a
tonyp@2472 265 // single region using this).
tonyp@3713 266 void remove_all_pending(uint target_count);
tonyp@2472 267
tonyp@2472 268 virtual void verify();
tonyp@2472 269
tonyp@2472 270 virtual void print_on(outputStream* out, bool print_contents = false);
tonyp@2472 271 };
tonyp@2472 272
tonyp@2643 273 // Iterator class that provides a convenient way to iterate over the
tonyp@2643 274 // regions of a HeapRegionLinkedList instance.
tonyp@2472 275
brutisso@6385 276 class FreeRegionListIterator : public StackObj {
tonyp@2472 277 private:
brutisso@6385 278 FreeRegionList* _list;
tonyp@2472 279 HeapRegion* _curr;
tonyp@2472 280
tonyp@2472 281 public:
tonyp@2472 282 bool more_available() {
tonyp@2472 283 return _curr != NULL;
tonyp@2472 284 }
tonyp@2472 285
tonyp@2472 286 HeapRegion* get_next() {
tonyp@2472 287 assert(more_available(),
tonyp@2472 288 "get_next() should be called when more regions are available");
tonyp@2472 289
tonyp@2472 290 // If we are going to introduce a count in the iterator we should
tonyp@2472 291 // do the "cycle" check.
tonyp@2472 292
tonyp@2472 293 HeapRegion* hr = _curr;
brutisso@6385 294 _list->verify_region(hr);
tonyp@2472 295 _curr = hr->next();
tonyp@2472 296 return hr;
tonyp@2472 297 }
tonyp@2472 298
brutisso@6385 299 FreeRegionListIterator(FreeRegionList* list)
tonyp@2472 300 : _curr(NULL), _list(list) {
tonyp@2472 301 _curr = list->head();
tonyp@2472 302 }
tonyp@2472 303 };
tonyp@2472 304
tonyp@2472 305 #endif // SHARE_VM_GC_IMPLEMENTATION_G1_HEAPREGIONSET_HPP

mercurial