tonyp@2472: /* jwilhelm@6422: * Copyright (c) 2011, 2014, 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: #include "precompiled.hpp" tschatzl@7050: #include "gc_implementation/g1/g1CollectedHeap.inline.hpp" brutisso@6385: #include "gc_implementation/g1/heapRegionRemSet.hpp" tonyp@2472: #include "gc_implementation/g1/heapRegionSet.inline.hpp" tonyp@2472: drchase@6680: PRAGMA_FORMAT_MUTE_WARNINGS_FOR_GCC drchase@6680: brutisso@6385: uint FreeRegionList::_unrealistically_long_length = 0; tonyp@2472: tonyp@2643: void HeapRegionSetBase::fill_in_ext_msg(hrs_ext_msg* msg, const char* message) { brutisso@6385: msg->append("[%s] %s ln: %u cy: "SIZE_FORMAT, brutisso@6385: name(), message, length(), total_capacity_bytes()); tonyp@2472: fill_in_ext_msg_extra(msg); tonyp@2472: } tonyp@2472: brutisso@6385: #ifndef PRODUCT brutisso@6385: void HeapRegionSetBase::verify_region(HeapRegion* hr) { tschatzl@7091: assert(hr->containing_set() == this, err_msg("Inconsistent containing set for %u", hr->hrm_index())); tschatzl@7091: assert(!hr->is_young(), err_msg("Adding young region %u", hr->hrm_index())); // currently we don't use these sets for young regions tschatzl@7091: assert(hr->isHumongous() == regions_humongous(), err_msg("Wrong humongous state for region %u and set %s", hr->hrm_index(), name())); tschatzl@7091: assert(hr->is_empty() == regions_empty(), err_msg("Wrong empty state for region %u and set %s", hr->hrm_index(), name())); tschatzl@7091: assert(hr->rem_set()->verify_ready_for_par_iteration(), err_msg("Wrong iteration state %u", hr->hrm_index())); tonyp@2472: } brutisso@6385: #endif tonyp@2472: tonyp@2472: void HeapRegionSetBase::verify() { tonyp@2472: // It's important that we also observe the MT safety protocol even tonyp@2472: // for the verification calls. If we do verification without the tonyp@2472: // appropriate locks and the set changes underneath our feet tonyp@2472: // verification might fail and send us on a wild goose chase. brutisso@6385: check_mt_safety(); tonyp@2472: brutisso@6385: guarantee(( is_empty() && length() == 0 && total_capacity_bytes() == 0) || brutisso@6385: (!is_empty() && length() >= 0 && total_capacity_bytes() >= 0), tonyp@2643: hrs_ext_msg(this, "invariant")); tonyp@2472: } tonyp@2472: tonyp@2472: void HeapRegionSetBase::verify_start() { tonyp@2472: // See comment in verify() about MT safety and verification. brutisso@6385: check_mt_safety(); tonyp@2472: assert(!_verify_in_progress, tonyp@2643: hrs_ext_msg(this, "verification should not be in progress")); tonyp@2472: tonyp@2472: // Do the basic verification first before we do the checks over the regions. tonyp@2472: HeapRegionSetBase::verify(); tonyp@2472: tschatzl@7050: _verify_in_progress = true; tonyp@2472: } tonyp@2472: tonyp@2472: void HeapRegionSetBase::verify_end() { tonyp@2472: // See comment in verify() about MT safety and verification. brutisso@6385: check_mt_safety(); tonyp@2472: assert(_verify_in_progress, tonyp@2643: hrs_ext_msg(this, "verification should be in progress")); tonyp@2472: tonyp@2472: _verify_in_progress = false; tonyp@2472: } tonyp@2472: tonyp@2472: void HeapRegionSetBase::print_on(outputStream* out, bool print_contents) { tonyp@2472: out->cr(); tonyp@2472: out->print_cr("Set: %s ("PTR_FORMAT")", name(), this); tonyp@2472: out->print_cr(" Region Assumptions"); tonyp@2472: out->print_cr(" humongous : %s", BOOL_TO_STR(regions_humongous())); tonyp@2472: out->print_cr(" empty : %s", BOOL_TO_STR(regions_empty())); tonyp@2472: out->print_cr(" Attributes"); tonyp@3713: out->print_cr(" length : %14u", length()); tonyp@2472: out->print_cr(" total capacity : "SIZE_FORMAT_W(14)" bytes", tonyp@2472: total_capacity_bytes()); tonyp@2472: } tonyp@2472: brutisso@6385: HeapRegionSetBase::HeapRegionSetBase(const char* name, bool humongous, bool empty, HRSMtSafeChecker* mt_safety_checker) brutisso@6385: : _name(name), _verify_in_progress(false), brutisso@6385: _is_humongous(humongous), _is_empty(empty), _mt_safety_checker(mt_safety_checker), brutisso@6385: _count() brutisso@6385: { } brutisso@6385: brutisso@6385: void FreeRegionList::set_unrealistically_long_length(uint len) { brutisso@6385: guarantee(_unrealistically_long_length == 0, "should only be set once"); brutisso@6385: _unrealistically_long_length = len; tonyp@2472: } tonyp@2472: brutisso@6385: void FreeRegionList::fill_in_ext_msg_extra(hrs_ext_msg* msg) { tschatzl@7050: msg->append(" hd: "PTR_FORMAT" tl: "PTR_FORMAT, _head, _tail); brutisso@6385: } brutisso@6385: brutisso@6385: void FreeRegionList::remove_all() { brutisso@6385: check_mt_safety(); tonyp@2472: verify_optional(); tonyp@2472: tonyp@2472: HeapRegion* curr = _head; tonyp@2472: while (curr != NULL) { brutisso@6385: verify_region(curr); tonyp@2472: tonyp@2472: HeapRegion* next = curr->next(); tonyp@2472: curr->set_next(NULL); jwilhelm@6422: curr->set_prev(NULL); tonyp@2472: curr->set_containing_set(NULL); tonyp@2472: curr = next; tonyp@2472: } tonyp@2472: clear(); tonyp@2472: tonyp@2472: verify_optional(); tonyp@2472: } tonyp@2472: jwilhelm@6422: void FreeRegionList::add_ordered(FreeRegionList* from_list) { jwilhelm@6422: check_mt_safety(); jwilhelm@6422: from_list->check_mt_safety(); jwilhelm@6422: jwilhelm@6422: verify_optional(); jwilhelm@6422: from_list->verify_optional(); jwilhelm@6422: jwilhelm@6422: if (from_list->is_empty()) { jwilhelm@6422: return; jwilhelm@6422: } jwilhelm@6422: jwilhelm@6422: #ifdef ASSERT jwilhelm@6422: FreeRegionListIterator iter(from_list); jwilhelm@6422: while (iter.more_available()) { jwilhelm@6422: HeapRegion* hr = iter.get_next(); jwilhelm@6422: // In set_containing_set() we check that we either set the value jwilhelm@6422: // from NULL to non-NULL or vice versa to catch bugs. So, we have jwilhelm@6422: // to NULL it first before setting it to the value. jwilhelm@6422: hr->set_containing_set(NULL); jwilhelm@6422: hr->set_containing_set(this); jwilhelm@6422: } jwilhelm@6422: #endif // ASSERT jwilhelm@6422: tschatzl@7050: if (is_empty()) { tschatzl@7050: assert(length() == 0 && _tail == NULL, hrs_ext_msg(this, "invariant")); tschatzl@7050: _head = from_list->_head; tschatzl@7050: _tail = from_list->_tail; tschatzl@7050: } else { tschatzl@7050: HeapRegion* curr_to = _head; tschatzl@7050: HeapRegion* curr_from = from_list->_head; jwilhelm@6422: tschatzl@7050: while (curr_from != NULL) { tschatzl@7091: while (curr_to != NULL && curr_to->hrm_index() < curr_from->hrm_index()) { tschatzl@7050: curr_to = curr_to->next(); tschatzl@7050: } tschatzl@7050: tschatzl@7050: if (curr_to == NULL) { tschatzl@7050: // The rest of the from list should be added as tail tschatzl@7050: _tail->set_next(curr_from); tschatzl@7050: curr_from->set_prev(_tail); tschatzl@7050: curr_from = NULL; tschatzl@7050: } else { tschatzl@7050: HeapRegion* next_from = curr_from->next(); tschatzl@7050: tschatzl@7050: curr_from->set_next(curr_to); tschatzl@7050: curr_from->set_prev(curr_to->prev()); tschatzl@7050: if (curr_to->prev() == NULL) { tschatzl@7050: _head = curr_from; tschatzl@7050: } else { tschatzl@7050: curr_to->prev()->set_next(curr_from); tschatzl@7050: } tschatzl@7050: curr_to->set_prev(curr_from); tschatzl@7050: tschatzl@7050: curr_from = next_from; tschatzl@7050: } jwilhelm@6422: } jwilhelm@6422: tschatzl@7091: if (_tail->hrm_index() < from_list->_tail->hrm_index()) { tschatzl@7050: _tail = from_list->_tail; jwilhelm@6422: } jwilhelm@6422: } jwilhelm@6422: jwilhelm@6422: _count.increment(from_list->length(), from_list->total_capacity_bytes()); jwilhelm@6422: from_list->clear(); jwilhelm@6422: jwilhelm@6422: verify_optional(); jwilhelm@6422: from_list->verify_optional(); jwilhelm@6422: } jwilhelm@6422: tschatzl@7050: void FreeRegionList::remove_starting_at(HeapRegion* first, uint num_regions) { brutisso@6385: check_mt_safety(); tschatzl@7050: assert(num_regions >= 1, hrs_ext_msg(this, "pre-condition")); tonyp@2643: assert(!is_empty(), hrs_ext_msg(this, "pre-condition")); tonyp@2472: tonyp@2472: verify_optional(); tonyp@3713: DEBUG_ONLY(uint old_length = length();) tonyp@2472: tschatzl@7050: HeapRegion* curr = first; tonyp@3713: uint count = 0; tschatzl@7050: while (count < num_regions) { brutisso@6385: verify_region(curr); tonyp@2472: HeapRegion* next = curr->next(); jwilhelm@6422: HeapRegion* prev = curr->prev(); tonyp@2472: tschatzl@7050: assert(count < num_regions, tschatzl@7050: hrs_err_msg("[%s] should not come across more regions " tschatzl@7050: "pending for removal than num_regions: %u", tschatzl@7050: name(), num_regions)); tonyp@2472: tschatzl@7050: if (prev == NULL) { tschatzl@7050: assert(_head == curr, hrs_ext_msg(this, "invariant")); tschatzl@7050: _head = next; tschatzl@7050: } else { tschatzl@7050: assert(_head != curr, hrs_ext_msg(this, "invariant")); tschatzl@7050: prev->set_next(next); tschatzl@7050: } tschatzl@7050: if (next == NULL) { tschatzl@7050: assert(_tail == curr, hrs_ext_msg(this, "invariant")); tschatzl@7050: _tail = prev; tschatzl@7050: } else { tschatzl@7050: assert(_tail != curr, hrs_ext_msg(this, "invariant")); tschatzl@7050: next->set_prev(prev); tschatzl@7050: } tschatzl@7050: if (_last = curr) { tschatzl@7050: _last = NULL; tschatzl@7050: } tonyp@2472: tschatzl@7050: curr->set_next(NULL); tschatzl@7050: curr->set_prev(NULL); tschatzl@7050: remove(curr); tonyp@2472: tschatzl@7050: count++; tonyp@2472: curr = next; tonyp@2472: } tonyp@2472: tschatzl@7050: assert(count == num_regions, tschatzl@7050: hrs_err_msg("[%s] count: %u should be == num_regions: %u", tschatzl@7050: name(), count, num_regions)); tschatzl@7050: assert(length() + num_regions == old_length, tonyp@2643: hrs_err_msg("[%s] new length should be consistent " tschatzl@7050: "new length: %u old length: %u num_regions: %u", tschatzl@7050: name(), length(), old_length, num_regions)); tonyp@2472: tonyp@2472: verify_optional(); tonyp@2472: } tonyp@2472: brutisso@6385: void FreeRegionList::verify() { tonyp@2472: // See comment in HeapRegionSetBase::verify() about MT safety and tonyp@2472: // verification. brutisso@6385: check_mt_safety(); tonyp@2472: tonyp@2472: // This will also do the basic verification too. tonyp@2472: verify_start(); tonyp@2472: brutisso@6385: verify_list(); tonyp@2472: tonyp@2472: verify_end(); tonyp@2472: } tonyp@2472: brutisso@6385: void FreeRegionList::clear() { brutisso@6385: _count = HeapRegionSetCount(); tonyp@2472: _head = NULL; tonyp@2472: _tail = NULL; jwilhelm@6422: _last = NULL; tonyp@2472: } tonyp@2472: brutisso@6385: void FreeRegionList::print_on(outputStream* out, bool print_contents) { tonyp@2472: HeapRegionSetBase::print_on(out, print_contents); tonyp@2472: out->print_cr(" Linking"); tonyp@2472: out->print_cr(" head : "PTR_FORMAT, _head); tonyp@2472: out->print_cr(" tail : "PTR_FORMAT, _tail); tonyp@2472: tonyp@2472: if (print_contents) { tonyp@2472: out->print_cr(" Contents"); brutisso@6385: FreeRegionListIterator iter(this); tonyp@2472: while (iter.more_available()) { tonyp@2472: HeapRegion* hr = iter.get_next(); tonyp@2472: hr->print_on(out); tonyp@2472: } tonyp@2472: } tschatzl@7050: tschatzl@7050: out->cr(); tonyp@2472: } brutisso@6386: brutisso@6386: void FreeRegionList::verify_list() { tschatzl@7050: HeapRegion* curr = _head; brutisso@6386: HeapRegion* prev1 = NULL; brutisso@6386: HeapRegion* prev0 = NULL; brutisso@6386: uint count = 0; brutisso@6386: size_t capacity = 0; jwilhelm@6422: uint last_index = 0; jwilhelm@6422: jwilhelm@6422: guarantee(_head == NULL || _head->prev() == NULL, "_head should not have a prev"); brutisso@6386: while (curr != NULL) { brutisso@6386: verify_region(curr); brutisso@6386: brutisso@6386: count++; brutisso@6386: guarantee(count < _unrealistically_long_length, brutisso@6386: hrs_err_msg("[%s] the calculated length: %u seems very long, is there maybe a cycle? curr: "PTR_FORMAT" prev0: "PTR_FORMAT" " "prev1: "PTR_FORMAT" length: %u", name(), count, curr, prev0, prev1, length())); brutisso@6386: jwilhelm@6422: if (curr->next() != NULL) { jwilhelm@6422: guarantee(curr->next()->prev() == curr, "Next or prev pointers messed up"); jwilhelm@6422: } tschatzl@7091: guarantee(curr->hrm_index() == 0 || curr->hrm_index() > last_index, "List should be sorted"); tschatzl@7091: last_index = curr->hrm_index(); jwilhelm@6422: brutisso@6386: capacity += curr->capacity(); brutisso@6386: brutisso@6386: prev1 = prev0; brutisso@6386: prev0 = curr; brutisso@6386: curr = curr->next(); brutisso@6386: } brutisso@6386: tschatzl@7091: guarantee(_tail == prev0, err_msg("Expected %s to end with %u but it ended with %u.", name(), _tail->hrm_index(), prev0->hrm_index())); jwilhelm@6422: guarantee(_tail == NULL || _tail->next() == NULL, "_tail should not have a next"); brutisso@6386: guarantee(length() == count, err_msg("%s count mismatch. Expected %u, actual %u.", name(), length(), count)); brutisso@6386: guarantee(total_capacity_bytes() == capacity, err_msg("%s capacity mismatch. Expected " SIZE_FORMAT ", actual " SIZE_FORMAT, brutisso@6386: name(), total_capacity_bytes(), capacity)); brutisso@6386: } brutisso@6386: brutisso@6386: // Note on the check_mt_safety() methods below: brutisso@6386: // brutisso@6386: // Verification of the "master" heap region sets / lists that are brutisso@6386: // maintained by G1CollectedHeap is always done during a STW pause and brutisso@6386: // by the VM thread at the start / end of the pause. The standard brutisso@6386: // verification methods all assert check_mt_safety(). This is brutisso@6386: // important as it ensures that verification is done without brutisso@6386: // concurrent updates taking place at the same time. It follows, that, brutisso@6386: // for the "master" heap region sets / lists, the check_mt_safety() brutisso@6386: // method should include the VM thread / STW case. brutisso@6386: brutisso@6386: void MasterFreeRegionListMtSafeChecker::check() { brutisso@6386: // Master Free List MT safety protocol: brutisso@6386: // (a) If we're at a safepoint, operations on the master free list brutisso@6386: // should be invoked by either the VM thread (which will serialize brutisso@6386: // them) or by the GC workers while holding the brutisso@6386: // FreeList_lock. brutisso@6386: // (b) If we're not at a safepoint, operations on the master free brutisso@6386: // list should be invoked while holding the Heap_lock. brutisso@6386: brutisso@6386: if (SafepointSynchronize::is_at_safepoint()) { brutisso@6386: guarantee(Thread::current()->is_VM_thread() || brutisso@6386: FreeList_lock->owned_by_self(), "master free list MT safety protocol at a safepoint"); brutisso@6386: } else { brutisso@6386: guarantee(Heap_lock->owned_by_self(), "master free list MT safety protocol outside a safepoint"); brutisso@6386: } brutisso@6386: } brutisso@6386: brutisso@6386: void SecondaryFreeRegionListMtSafeChecker::check() { brutisso@6386: // Secondary Free List MT safety protocol: brutisso@6386: // Operations on the secondary free list should always be invoked brutisso@6386: // while holding the SecondaryFreeList_lock. brutisso@6386: brutisso@6386: guarantee(SecondaryFreeList_lock->owned_by_self(), "secondary free list MT safety protocol"); brutisso@6386: } brutisso@6386: brutisso@6386: void OldRegionSetMtSafeChecker::check() { brutisso@6386: // Master Old Set MT safety protocol: brutisso@6386: // (a) If we're at a safepoint, operations on the master old set brutisso@6386: // should be invoked: brutisso@6386: // - by the VM thread (which will serialize them), or brutisso@6386: // - by the GC workers while holding the FreeList_lock, if we're brutisso@6386: // at a safepoint for an evacuation pause (this lock is taken brutisso@6386: // anyway when an GC alloc region is retired so that a new one brutisso@6386: // is allocated from the free list), or brutisso@6386: // - by the GC workers while holding the OldSets_lock, if we're at a brutisso@6386: // safepoint for a cleanup pause. brutisso@6386: // (b) If we're not at a safepoint, operations on the master old set brutisso@6386: // should be invoked while holding the Heap_lock. brutisso@6386: brutisso@6386: if (SafepointSynchronize::is_at_safepoint()) { brutisso@6386: guarantee(Thread::current()->is_VM_thread() brutisso@6386: || FreeList_lock->owned_by_self() || OldSets_lock->owned_by_self(), brutisso@6386: "master old set MT safety protocol at a safepoint"); brutisso@6386: } else { brutisso@6386: guarantee(Heap_lock->owned_by_self(), "master old set MT safety protocol outside a safepoint"); brutisso@6386: } brutisso@6386: } brutisso@6386: brutisso@6386: void HumongousRegionSetMtSafeChecker::check() { brutisso@6386: // Humongous Set MT safety protocol: brutisso@6386: // (a) If we're at a safepoint, operations on the master humongous brutisso@6386: // set should be invoked by either the VM thread (which will brutisso@6386: // serialize them) or by the GC workers while holding the brutisso@6386: // OldSets_lock. brutisso@6386: // (b) If we're not at a safepoint, operations on the master brutisso@6386: // humongous set should be invoked while holding the Heap_lock. brutisso@6386: brutisso@6386: if (SafepointSynchronize::is_at_safepoint()) { brutisso@6386: guarantee(Thread::current()->is_VM_thread() || brutisso@6386: OldSets_lock->owned_by_self(), brutisso@6386: "master humongous set MT safety protocol at a safepoint"); brutisso@6386: } else { brutisso@6386: guarantee(Heap_lock->owned_by_self(), brutisso@6386: "master humongous set MT safety protocol outside a safepoint"); brutisso@6386: } brutisso@6386: } tschatzl@7051: tschatzl@7051: void FreeRegionList_test() { tschatzl@7051: FreeRegionList l("test"); tschatzl@7051: tschatzl@7051: const uint num_regions_in_test = 5; tschatzl@7051: // Create a fake heap. It does not need to be valid, as the HeapRegion constructor tschatzl@7051: // does not access it. tschatzl@7051: MemRegion heap(NULL, num_regions_in_test * HeapRegion::GrainWords); tschatzl@7051: // Allocate a fake BOT because the HeapRegion constructor initializes tschatzl@7051: // the BOT. tschatzl@7051: size_t bot_size = G1BlockOffsetSharedArray::compute_size(heap.word_size()); tschatzl@7051: HeapWord* bot_data = NEW_C_HEAP_ARRAY(HeapWord, bot_size, mtGC); tschatzl@7051: ReservedSpace bot_rs(G1BlockOffsetSharedArray::compute_size(heap.word_size())); tschatzl@7051: G1RegionToSpaceMapper* bot_storage = tschatzl@7051: G1RegionToSpaceMapper::create_mapper(bot_rs, tschatzl@7051: os::vm_page_size(), tschatzl@7051: HeapRegion::GrainBytes, tschatzl@7051: G1BlockOffsetSharedArray::N_bytes, tschatzl@7051: mtGC); tschatzl@7051: G1BlockOffsetSharedArray oa(heap, bot_storage); tschatzl@7051: bot_storage->commit_regions(0, num_regions_in_test); tschatzl@7051: HeapRegion hr0(0, &oa, heap); tschatzl@7051: HeapRegion hr1(1, &oa, heap); tschatzl@7051: HeapRegion hr2(2, &oa, heap); tschatzl@7051: HeapRegion hr3(3, &oa, heap); tschatzl@7051: HeapRegion hr4(4, &oa, heap); tschatzl@7051: l.add_ordered(&hr1); tschatzl@7051: l.add_ordered(&hr0); tschatzl@7051: l.add_ordered(&hr3); tschatzl@7051: l.add_ordered(&hr4); tschatzl@7051: l.add_ordered(&hr2); tschatzl@7051: assert(l.length() == num_regions_in_test, "wrong length"); tschatzl@7051: l.verify_list(); tschatzl@7051: tschatzl@7051: bot_storage->uncommit_regions(0, num_regions_in_test); tschatzl@7051: delete bot_storage; tschatzl@7051: FREE_C_HEAP_ARRAY(HeapWord, bot_data, mtGC); tschatzl@7051: }