0N/A/*
2362N/A * Copyright (c) 2011, 2012, Oracle and/or its affiliates. All rights reserved.
0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0N/A *
0N/A * This code is free software; you can redistribute it and/or modify it
0N/A * under the terms of the GNU General Public License version 2 only, as
2362N/A * published by the Free Software Foundation.
0N/A *
2362N/A * This code is distributed in the hope that it will be useful, but WITHOUT
0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0N/A * version 2 for more details (a copy is included in the LICENSE file that
0N/A * accompanied this code).
0N/A *
0N/A * You should have received a copy of the GNU General Public License version
0N/A * 2 along with this work; if not, write to the Free Software Foundation,
0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
0N/A *
0N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
0N/A * or visit www.oracle.com if you need additional information or have any
2362N/A * questions.
2362N/A *
2362N/A */
0N/A
0N/A#include "precompiled.hpp"
0N/A#include "gc_implementation/g1/heapRegionSet.inline.hpp"
0N/A
0N/Auint HeapRegionSetBase::_unrealistically_long_length = 0;
0N/AHRSPhase HeapRegionSetBase::_phase = HRSPhaseNone;
0N/A
0N/A//////////////////// HeapRegionSetBase ////////////////////
0N/A
0N/Avoid HeapRegionSetBase::set_unrealistically_long_length(uint len) {
0N/A guarantee(_unrealistically_long_length == 0, "should only be set once");
0N/A _unrealistically_long_length = len;
0N/A}
0N/A
0N/Avoid HeapRegionSetBase::fill_in_ext_msg(hrs_ext_msg* msg, const char* message) {
0N/A msg->append("[%s] %s ln: %u rn: %u cy: "SIZE_FORMAT" ud: "SIZE_FORMAT,
0N/A name(), message, length(), region_num(),
0N/A total_capacity_bytes(), total_used_bytes());
0N/A fill_in_ext_msg_extra(msg);
0N/A}
0N/A
0N/Abool HeapRegionSetBase::verify_region(HeapRegion* hr,
0N/A HeapRegionSetBase* expected_containing_set) {
0N/A const char* error_message = NULL;
0N/A
0N/A if (!regions_humongous()) {
0N/A if (hr->isHumongous()) {
0N/A error_message = "the region should not be humongous";
0N/A }
0N/A } else {
0N/A if (!hr->isHumongous() || !hr->startsHumongous()) {
0N/A error_message = "the region should be 'starts humongous'";
0N/A }
0N/A }
0N/A
0N/A if (!regions_empty()) {
0N/A if (hr->is_empty()) {
0N/A error_message = "the region should not be empty";
0N/A }
0N/A } else {
0N/A if (!hr->is_empty()) {
0N/A error_message = "the region should be empty";
0N/A }
0N/A }
0N/A
0N/A#ifdef ASSERT
0N/A // The _containing_set field is only available when ASSERT is defined.
0N/A if (hr->containing_set() != expected_containing_set) {
0N/A error_message = "inconsistent containing set found";
0N/A }
0N/A#endif // ASSERT
0N/A
0N/A const char* extra_error_message = verify_region_extra(hr);
0N/A if (extra_error_message != NULL) {
0N/A error_message = extra_error_message;
0N/A }
0N/A
0N/A if (error_message != NULL) {
0N/A outputStream* out = tty;
0N/A out->cr();
0N/A out->print_cr("## [%s] %s", name(), error_message);
0N/A out->print_cr("## Offending Region: "PTR_FORMAT, hr);
0N/A out->print_cr(" "HR_FORMAT, HR_FORMAT_PARAMS(hr));
0N/A#ifdef ASSERT
0N/A out->print_cr(" containing set: "PTR_FORMAT, hr->containing_set());
0N/A#endif // ASSERT
0N/A out->print_cr("## Offending Region Set: "PTR_FORMAT, this);
0N/A print_on(out);
0N/A return false;
0N/A } else {
0N/A return true;
0N/A }
0N/A}
0N/A
0N/Avoid HeapRegionSetBase::verify() {
0N/A // It's important that we also observe the MT safety protocol even
0N/A // for the verification calls. If we do verification without the
0N/A // appropriate locks and the set changes underneath our feet
0N/A // verification might fail and send us on a wild goose chase.
0N/A hrs_assert_mt_safety_ok(this);
0N/A
0N/A guarantee(( is_empty() && length() == 0 && region_num() == 0 &&
0N/A total_used_bytes() == 0 && total_capacity_bytes() == 0) ||
0N/A (!is_empty() && length() >= 0 && region_num() >= 0 &&
0N/A total_used_bytes() >= 0 && total_capacity_bytes() >= 0),
0N/A hrs_ext_msg(this, "invariant"));
0N/A
0N/A guarantee((!regions_humongous() && region_num() == length()) ||
0N/A ( regions_humongous() && region_num() >= length()),
0N/A hrs_ext_msg(this, "invariant"));
0N/A
0N/A guarantee(!regions_empty() || total_used_bytes() == 0,
0N/A hrs_ext_msg(this, "invariant"));
0N/A
0N/A guarantee(total_used_bytes() <= total_capacity_bytes(),
0N/A hrs_ext_msg(this, "invariant"));
0N/A}
0N/A
0N/Avoid HeapRegionSetBase::verify_start() {
0N/A // See comment in verify() about MT safety and verification.
0N/A hrs_assert_mt_safety_ok(this);
0N/A assert(!_verify_in_progress,
0N/A hrs_ext_msg(this, "verification should not be in progress"));
0N/A
0N/A // Do the basic verification first before we do the checks over the regions.
0N/A HeapRegionSetBase::verify();
0N/A
0N/A _calc_length = 0;
0N/A _calc_region_num = 0;
0N/A _calc_total_capacity_bytes = 0;
0N/A _calc_total_used_bytes = 0;
0N/A _verify_in_progress = true;
0N/A}
0N/A
0N/Avoid HeapRegionSetBase::verify_next_region(HeapRegion* hr) {
0N/A // See comment in verify() about MT safety and verification.
0N/A hrs_assert_mt_safety_ok(this);
0N/A assert(_verify_in_progress,
0N/A hrs_ext_msg(this, "verification should be in progress"));
0N/A
0N/A guarantee(verify_region(hr, this), hrs_ext_msg(this, "region verification"));
0N/A
0N/A _calc_length += 1;
0N/A _calc_region_num += hr->region_num();
0N/A _calc_total_capacity_bytes += hr->capacity();
0N/A _calc_total_used_bytes += hr->used();
0N/A}
0N/A
0N/Avoid HeapRegionSetBase::verify_end() {
0N/A // See comment in verify() about MT safety and verification.
0N/A hrs_assert_mt_safety_ok(this);
0N/A assert(_verify_in_progress,
0N/A hrs_ext_msg(this, "verification should be in progress"));
0N/A
0N/A guarantee(length() == _calc_length,
0N/A hrs_err_msg("[%s] length: %u should be == calc length: %u",
0N/A name(), length(), _calc_length));
0N/A
0N/A guarantee(region_num() == _calc_region_num,
0N/A hrs_err_msg("[%s] region num: %u should be == calc region num: %u",
0N/A name(), region_num(), _calc_region_num));
0N/A
0N/A guarantee(total_capacity_bytes() == _calc_total_capacity_bytes,
0N/A hrs_err_msg("[%s] capacity bytes: "SIZE_FORMAT" should be == "
0N/A "calc capacity bytes: "SIZE_FORMAT,
0N/A name(),
0N/A total_capacity_bytes(), _calc_total_capacity_bytes));
0N/A
0N/A guarantee(total_used_bytes() == _calc_total_used_bytes,
0N/A hrs_err_msg("[%s] used bytes: "SIZE_FORMAT" should be == "
0N/A "calc used bytes: "SIZE_FORMAT,
0N/A name(), total_used_bytes(), _calc_total_used_bytes));
0N/A
0N/A _verify_in_progress = false;
0N/A}
0N/A
0N/Avoid HeapRegionSetBase::clear_phase() {
0N/A assert(_phase != HRSPhaseNone, "pre-condition");
0N/A _phase = HRSPhaseNone;
0N/A}
0N/A
0N/Avoid HeapRegionSetBase::set_phase(HRSPhase phase) {
0N/A assert(_phase == HRSPhaseNone, "pre-condition");
0N/A assert(phase != HRSPhaseNone, "pre-condition");
0N/A _phase = phase;
0N/A}
0N/A
0N/Avoid HeapRegionSetBase::print_on(outputStream* out, bool print_contents) {
0N/A out->cr();
0N/A out->print_cr("Set: %s ("PTR_FORMAT")", name(), this);
0N/A out->print_cr(" Region Assumptions");
0N/A out->print_cr(" humongous : %s", BOOL_TO_STR(regions_humongous()));
0N/A out->print_cr(" empty : %s", BOOL_TO_STR(regions_empty()));
0N/A out->print_cr(" Attributes");
0N/A out->print_cr(" length : %14u", length());
0N/A out->print_cr(" region num : %14u", region_num());
0N/A out->print_cr(" total capacity : "SIZE_FORMAT_W(14)" bytes",
0N/A total_capacity_bytes());
0N/A out->print_cr(" total used : "SIZE_FORMAT_W(14)" bytes",
0N/A total_used_bytes());
0N/A}
0N/A
0N/Avoid HeapRegionSetBase::clear() {
0N/A _length = 0;
0N/A _region_num = 0;
0N/A _total_used_bytes = 0;
0N/A}
0N/A
0N/AHeapRegionSetBase::HeapRegionSetBase(const char* name)
0N/A : _name(name), _verify_in_progress(false),
0N/A _calc_length(0), _calc_region_num(0),
0N/A _calc_total_capacity_bytes(0), _calc_total_used_bytes(0) { }
0N/A
0N/A//////////////////// HeapRegionSet ////////////////////
0N/A
0N/Avoid HeapRegionSet::update_from_proxy(HeapRegionSet* proxy_set) {
0N/A hrs_assert_mt_safety_ok(this);
0N/A hrs_assert_mt_safety_ok(proxy_set);
0N/A hrs_assert_sets_match(this, proxy_set);
0N/A
0N/A verify_optional();
0N/A proxy_set->verify_optional();
0N/A
0N/A if (proxy_set->is_empty()) return;
0N/A
0N/A assert(proxy_set->length() <= _length,
0N/A hrs_err_msg("[%s] proxy set length: %u should be <= length: %u",
0N/A name(), proxy_set->length(), _length));
0N/A _length -= proxy_set->length();
assert(proxy_set->region_num() <= _region_num,
hrs_err_msg("[%s] proxy set region num: %u should be <= region num: %u",
name(), proxy_set->region_num(), _region_num));
_region_num -= proxy_set->region_num();
assert(proxy_set->total_used_bytes() <= _total_used_bytes,
hrs_err_msg("[%s] proxy set used bytes: "SIZE_FORMAT" "
"should be <= used bytes: "SIZE_FORMAT,
name(), proxy_set->total_used_bytes(),
_total_used_bytes));
_total_used_bytes -= proxy_set->total_used_bytes();
proxy_set->clear();
verify_optional();
proxy_set->verify_optional();
}
//////////////////// HeapRegionLinkedList ////////////////////
void HeapRegionLinkedList::fill_in_ext_msg_extra(hrs_ext_msg* msg) {
msg->append(" hd: "PTR_FORMAT" tl: "PTR_FORMAT, head(), tail());
}
void HeapRegionLinkedList::add_as_head(HeapRegionLinkedList* from_list) {
hrs_assert_mt_safety_ok(this);
hrs_assert_mt_safety_ok(from_list);
verify_optional();
from_list->verify_optional();
if (from_list->is_empty()) return;
#ifdef ASSERT
HeapRegionLinkedListIterator iter(from_list);
while (iter.more_available()) {
HeapRegion* hr = iter.get_next();
// In set_containing_set() we check that we either set the value
// from NULL to non-NULL or vice versa to catch bugs. So, we have
// to NULL it first before setting it to the value.
hr->set_containing_set(NULL);
hr->set_containing_set(this);
}
#endif // ASSERT
if (_head != NULL) {
assert(length() > 0 && _tail != NULL, hrs_ext_msg(this, "invariant"));
from_list->_tail->set_next(_head);
} else {
assert(length() == 0 && _tail == NULL, hrs_ext_msg(this, "invariant"));
_tail = from_list->_tail;
}
_head = from_list->_head;
_length += from_list->length();
_region_num += from_list->region_num();
_total_used_bytes += from_list->total_used_bytes();
from_list->clear();
verify_optional();
from_list->verify_optional();
}
void HeapRegionLinkedList::add_as_tail(HeapRegionLinkedList* from_list) {
hrs_assert_mt_safety_ok(this);
hrs_assert_mt_safety_ok(from_list);
verify_optional();
from_list->verify_optional();
if (from_list->is_empty()) return;
#ifdef ASSERT
HeapRegionLinkedListIterator iter(from_list);
while (iter.more_available()) {
HeapRegion* hr = iter.get_next();
// In set_containing_set() we check that we either set the value
// from NULL to non-NULL or vice versa to catch bugs. So, we have
// to NULL it first before setting it to the value.
hr->set_containing_set(NULL);
hr->set_containing_set(this);
}
#endif // ASSERT
if (_tail != NULL) {
assert(length() > 0 && _head != NULL, hrs_ext_msg(this, "invariant"));
_tail->set_next(from_list->_head);
} else {
assert(length() == 0 && _head == NULL, hrs_ext_msg(this, "invariant"));
_head = from_list->_head;
}
_tail = from_list->_tail;
_length += from_list->length();
_region_num += from_list->region_num();
_total_used_bytes += from_list->total_used_bytes();
from_list->clear();
verify_optional();
from_list->verify_optional();
}
void HeapRegionLinkedList::remove_all() {
hrs_assert_mt_safety_ok(this);
verify_optional();
HeapRegion* curr = _head;
while (curr != NULL) {
hrs_assert_region_ok(this, curr, this);
HeapRegion* next = curr->next();
curr->set_next(NULL);
curr->set_containing_set(NULL);
curr = next;
}
clear();
verify_optional();
}
void HeapRegionLinkedList::remove_all_pending(uint target_count) {
hrs_assert_mt_safety_ok(this);
assert(target_count > 1, hrs_ext_msg(this, "pre-condition"));
assert(!is_empty(), hrs_ext_msg(this, "pre-condition"));
verify_optional();
DEBUG_ONLY(uint old_length = length();)
HeapRegion* curr = _head;
HeapRegion* prev = NULL;
uint count = 0;
while (curr != NULL) {
hrs_assert_region_ok(this, curr, this);
HeapRegion* next = curr->next();
if (curr->pending_removal()) {
assert(count < target_count,
hrs_err_msg("[%s] should not come across more regions "
"pending for removal than target_count: %u",
name(), target_count));
if (prev == NULL) {
assert(_head == curr, hrs_ext_msg(this, "invariant"));
_head = next;
} else {
assert(_head != curr, hrs_ext_msg(this, "invariant"));
prev->set_next(next);
}
if (next == NULL) {
assert(_tail == curr, hrs_ext_msg(this, "invariant"));
_tail = prev;
} else {
assert(_tail != curr, hrs_ext_msg(this, "invariant"));
}
curr->set_next(NULL);
remove_internal(curr);
curr->set_pending_removal(false);
count += 1;
// If we have come across the target number of regions we can
// just bail out. However, for debugging purposes, we can just
// carry on iterating to make sure there are not more regions
// tagged with pending removal.
DEBUG_ONLY(if (count == target_count) break;)
} else {
prev = curr;
}
curr = next;
}
assert(count == target_count,
hrs_err_msg("[%s] count: %u should be == target_count: %u",
name(), count, target_count));
assert(length() + target_count == old_length,
hrs_err_msg("[%s] new length should be consistent "
"new length: %u old length: %u target_count: %u",
name(), length(), old_length, target_count));
verify_optional();
}
void HeapRegionLinkedList::verify() {
// See comment in HeapRegionSetBase::verify() about MT safety and
// verification.
hrs_assert_mt_safety_ok(this);
// This will also do the basic verification too.
verify_start();
HeapRegion* curr = _head;
HeapRegion* prev1 = NULL;
HeapRegion* prev0 = NULL;
uint count = 0;
while (curr != NULL) {
verify_next_region(curr);
count += 1;
guarantee(count < _unrealistically_long_length,
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()));
prev1 = prev0;
prev0 = curr;
curr = curr->next();
}
guarantee(_tail == prev0, hrs_ext_msg(this, "post-condition"));
verify_end();
}
void HeapRegionLinkedList::clear() {
HeapRegionSetBase::clear();
_head = NULL;
_tail = NULL;
}
void HeapRegionLinkedList::print_on(outputStream* out, bool print_contents) {
HeapRegionSetBase::print_on(out, print_contents);
out->print_cr(" Linking");
out->print_cr(" head : "PTR_FORMAT, _head);
out->print_cr(" tail : "PTR_FORMAT, _tail);
if (print_contents) {
out->print_cr(" Contents");
HeapRegionLinkedListIterator iter(this);
while (iter.more_available()) {
HeapRegion* hr = iter.get_next();
hr->print_on(out);
}
}
}