tonyp@2472: /* tonyp@3457: * Copyright (c) 2011, 2012, Oracle and/or its affiliates. All rights reserved. tonyp@2472: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. tonyp@2472: * tonyp@2472: * This code is free software; you can redistribute it and/or modify it tonyp@2472: * under the terms of the GNU General Public License version 2 only, as tonyp@2472: * published by the Free Software Foundation. tonyp@2472: * tonyp@2472: * This code is distributed in the hope that it will be useful, but WITHOUT tonyp@2472: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or tonyp@2472: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License tonyp@2472: * version 2 for more details (a copy is included in the LICENSE file that tonyp@2472: * accompanied this code). tonyp@2472: * tonyp@2472: * You should have received a copy of the GNU General Public License version tonyp@2472: * 2 along with this work; if not, write to the Free Software Foundation, tonyp@2472: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. tonyp@2472: * tonyp@2472: * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA tonyp@2472: * or visit www.oracle.com if you need additional information or have any tonyp@2472: * questions. tonyp@2472: * tonyp@2472: */ tonyp@2472: tonyp@2472: #ifndef SHARE_VM_GC_IMPLEMENTATION_G1_HEAPREGIONSET_HPP tonyp@2472: #define SHARE_VM_GC_IMPLEMENTATION_G1_HEAPREGIONSET_HPP tonyp@2472: tonyp@2472: #include "gc_implementation/g1/heapRegion.hpp" tonyp@2472: tonyp@2472: // Large buffer for some cases where the output might be larger than normal. tonyp@2643: #define HRS_ERR_MSG_BUFSZ 512 tonyp@2643: typedef FormatBuffer hrs_err_msg; tonyp@2472: tonyp@2472: // Set verification will be forced either if someone defines tonyp@2472: // HEAP_REGION_SET_FORCE_VERIFY to be 1, or in builds in which tonyp@2472: // asserts are compiled in. tonyp@2472: #ifndef HEAP_REGION_SET_FORCE_VERIFY tonyp@2472: #define HEAP_REGION_SET_FORCE_VERIFY defined(ASSERT) tonyp@2472: #endif // HEAP_REGION_SET_FORCE_VERIFY tonyp@2472: tonyp@2472: //////////////////// HeapRegionSetBase //////////////////// tonyp@2472: tonyp@2472: // Base class for all the classes that represent heap region sets. It tonyp@2472: // contains the basic attributes that each set needs to maintain tonyp@2472: // (e.g., length, region num, used bytes sum) plus any shared tonyp@2472: // functionality (e.g., verification). tonyp@2472: tonyp@2643: class hrs_ext_msg; tonyp@2472: tonyp@3268: typedef enum { tonyp@3268: HRSPhaseNone, tonyp@3268: HRSPhaseEvacuation, tonyp@3268: HRSPhaseCleanup, tonyp@3268: HRSPhaseFullGC tonyp@3268: } HRSPhase; tonyp@3268: tonyp@3268: class HRSPhaseSetter; tonyp@3268: tonyp@2472: class HeapRegionSetBase VALUE_OBJ_CLASS_SPEC { tonyp@2643: friend class hrs_ext_msg; tonyp@3268: friend class HRSPhaseSetter; tonyp@3457: friend class VMStructs; tonyp@2472: tonyp@2472: protected: tonyp@3713: static uint _unrealistically_long_length; tonyp@2472: tonyp@2472: // The number of regions added to the set. If the set contains tonyp@2472: // only humongous regions, this reflects only 'starts humongous' tonyp@2472: // regions and does not include 'continues humongous' ones. tonyp@3713: uint _length; tonyp@2472: tonyp@2472: // The total number of regions represented by the set. If the set tonyp@2472: // does not contain humongous regions, this should be the same as tonyp@2472: // _length. If the set contains only humongous regions, this will tonyp@2472: // include the 'continues humongous' regions. tonyp@3713: uint _region_num; tonyp@2472: tonyp@2472: // We don't keep track of the total capacity explicitly, we instead tonyp@2472: // recalculate it based on _region_num and the heap region size. tonyp@2472: tonyp@2472: // The sum of used bytes in the all the regions in the set. tonyp@2472: size_t _total_used_bytes; tonyp@2472: tonyp@2472: const char* _name; tonyp@2472: tonyp@2472: bool _verify_in_progress; tonyp@3713: uint _calc_length; tonyp@3713: uint _calc_region_num; tonyp@2472: size_t _calc_total_capacity_bytes; tonyp@2472: size_t _calc_total_used_bytes; tonyp@2472: tonyp@3268: // This is here so that it can be used in the subclasses to assert tonyp@3268: // something different depending on which phase the GC is in. This tonyp@3268: // can be particularly helpful in the check_mt_safety() methods. tonyp@3268: static HRSPhase _phase; tonyp@3268: tonyp@3268: // Only used by HRSPhaseSetter. tonyp@3268: static void clear_phase(); tonyp@3268: static void set_phase(HRSPhase phase); tonyp@3268: tonyp@2472: // verify_region() is used to ensure that the contents of a region tonyp@2472: // added to / removed from a set are consistent. Different sets tonyp@2472: // make different assumptions about the regions added to them. So tonyp@2472: // each set can override verify_region_extra(), which is called tonyp@2472: // from verify_region(), and do any extra verification it needs to tonyp@2472: // perform in that. tonyp@2472: virtual const char* verify_region_extra(HeapRegion* hr) { return NULL; } tonyp@2472: bool verify_region(HeapRegion* hr, tonyp@2472: HeapRegionSetBase* expected_containing_set); tonyp@2472: tonyp@2472: // Indicates whether all regions in the set should be humongous or tonyp@2472: // not. Only used during verification. tonyp@2472: virtual bool regions_humongous() = 0; tonyp@2472: tonyp@2472: // Indicates whether all regions in the set should be empty or tonyp@2472: // not. Only used during verification. tonyp@2472: virtual bool regions_empty() = 0; tonyp@2472: tonyp@2472: // Subclasses can optionally override this to do MT safety protocol tonyp@2472: // checks. It is called in an assert from all methods that perform tonyp@2472: // updates on the set (and subclasses should also call it too). tonyp@2472: virtual bool check_mt_safety() { return true; } tonyp@2472: tonyp@2472: // fill_in_ext_msg() writes the the values of the set's attributes tonyp@2643: // in the custom err_msg (hrs_ext_msg). fill_in_ext_msg_extra() tonyp@2472: // allows subclasses to append further information. tonyp@2643: virtual void fill_in_ext_msg_extra(hrs_ext_msg* msg) { } tonyp@2643: void fill_in_ext_msg(hrs_ext_msg* msg, const char* message); tonyp@2472: tonyp@2472: // It updates the fields of the set to reflect hr being added to tonyp@2472: // the set. tonyp@2472: inline void update_for_addition(HeapRegion* hr); tonyp@2472: tonyp@2472: // It updates the fields of the set to reflect hr being added to tonyp@2472: // the set and tags the region appropriately. tonyp@2472: inline void add_internal(HeapRegion* hr); tonyp@2472: tonyp@2472: // It updates the fields of the set to reflect hr being removed tonyp@2472: // from the set. tonyp@2472: inline void update_for_removal(HeapRegion* hr); tonyp@2472: tonyp@2472: // It updates the fields of the set to reflect hr being removed tonyp@2472: // from the set and tags the region appropriately. tonyp@2472: inline void remove_internal(HeapRegion* hr); tonyp@2472: tonyp@2472: // It clears all the fields of the sets. Note: it will not iterate tonyp@2472: // over the set and remove regions from it. It assumes that the tonyp@2472: // caller has already done so. It will literally just clear the fields. tonyp@2472: virtual void clear(); tonyp@2472: tonyp@2472: HeapRegionSetBase(const char* name); tonyp@2472: tonyp@2472: public: tonyp@3713: static void set_unrealistically_long_length(uint len); tonyp@2472: tonyp@2472: const char* name() { return _name; } tonyp@2472: tonyp@3713: uint length() { return _length; } tonyp@2472: tonyp@2472: bool is_empty() { return _length == 0; } tonyp@2472: tonyp@3713: uint region_num() { return _region_num; } tonyp@2472: tonyp@2472: size_t total_capacity_bytes() { tonyp@3713: return (size_t) region_num() << HeapRegion::LogOfHRGrainBytes; tonyp@2472: } tonyp@2472: tonyp@2472: size_t total_used_bytes() { return _total_used_bytes; } tonyp@2472: tonyp@2472: virtual void verify(); tonyp@2472: void verify_start(); tonyp@2472: void verify_next_region(HeapRegion* hr); tonyp@2472: void verify_end(); tonyp@2472: tonyp@2472: #if HEAP_REGION_SET_FORCE_VERIFY tonyp@2472: void verify_optional() { tonyp@2472: verify(); tonyp@2472: } tonyp@2472: #else // HEAP_REGION_SET_FORCE_VERIFY tonyp@2472: void verify_optional() { } tonyp@2472: #endif // HEAP_REGION_SET_FORCE_VERIFY tonyp@2472: tonyp@2472: virtual void print_on(outputStream* out, bool print_contents = false); tonyp@2472: }; tonyp@2472: tonyp@2472: // Customized err_msg for heap region sets. Apart from a tonyp@2472: // assert/guarantee-specific message it also prints out the values of tonyp@2472: // the fields of the associated set. This can be very helpful in tonyp@2472: // diagnosing failures. tonyp@2472: tonyp@2643: class hrs_ext_msg : public hrs_err_msg { tonyp@2472: public: tonyp@2643: hrs_ext_msg(HeapRegionSetBase* set, const char* message) : hrs_err_msg("") { tonyp@2472: set->fill_in_ext_msg(this, message); tonyp@2472: } tonyp@2472: }; tonyp@2472: tonyp@3268: class HRSPhaseSetter { tonyp@3268: public: tonyp@3268: HRSPhaseSetter(HRSPhase phase) { tonyp@3268: HeapRegionSetBase::set_phase(phase); tonyp@3268: } tonyp@3268: ~HRSPhaseSetter() { tonyp@3268: HeapRegionSetBase::clear_phase(); tonyp@3268: } tonyp@3268: }; tonyp@3268: tonyp@2472: // These two macros are provided for convenience, to keep the uses of tonyp@2472: // these two asserts a bit more concise. tonyp@2472: tonyp@2643: #define hrs_assert_mt_safety_ok(_set_) \ tonyp@2472: do { \ tonyp@2643: assert((_set_)->check_mt_safety(), hrs_ext_msg((_set_), "MT safety")); \ tonyp@2472: } while (0) tonyp@2472: tonyp@2643: #define hrs_assert_region_ok(_set_, _hr_, _expected_) \ tonyp@2472: do { \ tonyp@2472: assert((_set_)->verify_region((_hr_), (_expected_)), \ tonyp@2643: hrs_ext_msg((_set_), "region verification")); \ tonyp@2472: } while (0) tonyp@2472: tonyp@2472: //////////////////// HeapRegionSet //////////////////// tonyp@2472: tonyp@2643: #define hrs_assert_sets_match(_set1_, _set2_) \ tonyp@2472: do { \ tonyp@2472: assert(((_set1_)->regions_humongous() == \ tonyp@2472: (_set2_)->regions_humongous()) && \ tonyp@2472: ((_set1_)->regions_empty() == (_set2_)->regions_empty()), \ tonyp@2643: hrs_err_msg("the contents of set %s and set %s should match", \ tonyp@2472: (_set1_)->name(), (_set2_)->name())); \ tonyp@2472: } while (0) tonyp@2472: tonyp@2472: // This class represents heap region sets whose members are not tonyp@2472: // explicitly tracked. It's helpful to group regions using such sets tonyp@2472: // so that we can reason about all the region groups in the heap using tonyp@2472: // the same interface (namely, the HeapRegionSetBase API). tonyp@2472: tonyp@2472: class HeapRegionSet : public HeapRegionSetBase { tonyp@2472: protected: tonyp@2472: virtual const char* verify_region_extra(HeapRegion* hr) { tonyp@2472: if (hr->next() != NULL) { tonyp@2472: return "next() should always be NULL as we do not link the regions"; tonyp@2472: } tonyp@2472: tonyp@2472: return HeapRegionSetBase::verify_region_extra(hr); tonyp@2472: } tonyp@2472: tonyp@2472: HeapRegionSet(const char* name) : HeapRegionSetBase(name) { tonyp@2472: clear(); tonyp@2472: } tonyp@2472: tonyp@2472: public: tonyp@2472: // It adds hr to the set. The region should not be a member of tonyp@2472: // another set. tonyp@2472: inline void add(HeapRegion* hr); tonyp@2472: tonyp@2472: // It removes hr from the set. The region should be a member of tonyp@2472: // this set. tonyp@2472: inline void remove(HeapRegion* hr); tonyp@2472: tonyp@2472: // It removes a region from the set. Instead of updating the fields tonyp@2472: // of the set to reflect this removal, it accumulates the updates tonyp@2472: // in proxy_set. The idea is that proxy_set is thread-local to tonyp@2472: // avoid multiple threads updating the fields of the set tonyp@2472: // concurrently and having to synchronize. The method tonyp@2472: // update_from_proxy() will update the fields of the set from the tonyp@2472: // proxy_set. tonyp@2472: inline void remove_with_proxy(HeapRegion* hr, HeapRegionSet* proxy_set); tonyp@2472: tonyp@2472: // After multiple calls to remove_with_proxy() the updates to the tonyp@2472: // fields of the set are accumulated in proxy_set. This call tonyp@2472: // updates the fields of the set from proxy_set. tonyp@2472: void update_from_proxy(HeapRegionSet* proxy_set); tonyp@2472: }; tonyp@2472: tonyp@2472: //////////////////// HeapRegionLinkedList //////////////////// tonyp@2472: tonyp@2472: // A set that links all the regions added to it in a singly-linked tonyp@2472: // list. We should try to avoid doing operations that iterate over tonyp@2472: // such lists in performance critical paths. Typically we should tonyp@2472: // add / remove one region at a time or concatenate two lists. All tonyp@2472: // those operations are done in constant time. tonyp@2472: tonyp@2472: class HeapRegionLinkedListIterator; tonyp@2472: tonyp@2472: class HeapRegionLinkedList : public HeapRegionSetBase { tonyp@2472: friend class HeapRegionLinkedListIterator; tonyp@2472: tonyp@2472: private: tonyp@2472: HeapRegion* _head; tonyp@2472: HeapRegion* _tail; tonyp@2472: tonyp@2472: // These are provided for use by the friend classes. tonyp@2472: HeapRegion* head() { return _head; } tonyp@2472: HeapRegion* tail() { return _tail; } tonyp@2472: tonyp@2472: protected: tonyp@2643: virtual void fill_in_ext_msg_extra(hrs_ext_msg* msg); tonyp@2472: tonyp@2472: // See the comment for HeapRegionSetBase::clear() tonyp@2472: virtual void clear(); tonyp@2472: tonyp@2472: HeapRegionLinkedList(const char* name) : HeapRegionSetBase(name) { tonyp@2472: clear(); tonyp@2472: } tonyp@2472: tonyp@2472: public: tonyp@2714: // It adds hr to the list as the new head. The region should not be tonyp@2714: // a member of another set. tonyp@2714: inline void add_as_head(HeapRegion* hr); tonyp@2714: tonyp@2472: // It adds hr to the list as the new tail. The region should not be tonyp@2472: // a member of another set. tonyp@2472: inline void add_as_tail(HeapRegion* hr); tonyp@2472: tonyp@2472: // It removes and returns the head of the list. It assumes that the tonyp@2472: // list is not empty so it will return a non-NULL value. tonyp@2472: inline HeapRegion* remove_head(); tonyp@2472: tonyp@2472: // Convenience method. tonyp@2472: inline HeapRegion* remove_head_or_null(); tonyp@2472: tonyp@2472: // It moves the regions from from_list to this list and empties tonyp@2472: // from_list. The new regions will appear in the same order as they tonyp@2714: // were in from_list and be linked in the beginning of this list. tonyp@2714: void add_as_head(HeapRegionLinkedList* from_list); tonyp@2714: tonyp@2714: // It moves the regions from from_list to this list and empties tonyp@2714: // from_list. The new regions will appear in the same order as they tonyp@2472: // were in from_list and be linked in the end of this list. tonyp@2472: void add_as_tail(HeapRegionLinkedList* from_list); tonyp@2472: tonyp@2472: // It empties the list by removing all regions from it. tonyp@2472: void remove_all(); tonyp@2472: tonyp@2472: // It removes all regions in the list that are pending for removal tonyp@2472: // (i.e., they have been tagged with "pending_removal"). The list tonyp@2472: // must not be empty, target_count should reflect the exact number tonyp@2472: // of regions that are pending for removal in the list, and tonyp@2472: // target_count should be > 1 (currently, we never need to remove a tonyp@2472: // single region using this). tonyp@3713: void remove_all_pending(uint target_count); tonyp@2472: tonyp@2472: virtual void verify(); tonyp@2472: tonyp@2472: virtual void print_on(outputStream* out, bool print_contents = false); tonyp@2472: }; tonyp@2472: tonyp@2643: //////////////////// HeapRegionLinkedListIterator //////////////////// tonyp@2472: tonyp@2643: // Iterator class that provides a convenient way to iterate over the tonyp@2643: // regions of a HeapRegionLinkedList instance. tonyp@2472: tonyp@2472: class HeapRegionLinkedListIterator : public StackObj { tonyp@2472: private: tonyp@2472: HeapRegionLinkedList* _list; tonyp@2472: HeapRegion* _curr; tonyp@2472: tonyp@2472: public: tonyp@2472: bool more_available() { tonyp@2472: return _curr != NULL; tonyp@2472: } tonyp@2472: tonyp@2472: HeapRegion* get_next() { tonyp@2472: assert(more_available(), tonyp@2472: "get_next() should be called when more regions are available"); tonyp@2472: tonyp@2472: // If we are going to introduce a count in the iterator we should tonyp@2472: // do the "cycle" check. tonyp@2472: tonyp@2472: HeapRegion* hr = _curr; tonyp@2472: assert(_list->verify_region(hr, _list), "region verification"); tonyp@2472: _curr = hr->next(); tonyp@2472: return hr; tonyp@2472: } tonyp@2472: tonyp@2472: HeapRegionLinkedListIterator(HeapRegionLinkedList* list) tonyp@2472: : _curr(NULL), _list(list) { tonyp@2472: _curr = list->head(); tonyp@2472: } tonyp@2472: }; tonyp@2472: tonyp@2472: #endif // SHARE_VM_GC_IMPLEMENTATION_G1_HEAPREGIONSET_HPP