src/share/vm/memory/referenceProcessor.cpp

Mon, 09 Mar 2009 13:28:46 -0700

author
xdono
date
Mon, 09 Mar 2009 13:28:46 -0700
changeset 1014
0fbdb4381b99
parent 969
5cfd8d19e546
child 1280
df6caf649ff7
permissions
-rw-r--r--

6814575: Update copyright year
Summary: Update copyright for files that have been modified in 2009, up to 03/09
Reviewed-by: katleman, tbell, ohair

duke@435 1 /*
xdono@1014 2 * Copyright 2001-2009 Sun Microsystems, Inc. All Rights Reserved.
duke@435 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@435 4 *
duke@435 5 * This code is free software; you can redistribute it and/or modify it
duke@435 6 * under the terms of the GNU General Public License version 2 only, as
duke@435 7 * published by the Free Software Foundation.
duke@435 8 *
duke@435 9 * This code is distributed in the hope that it will be useful, but WITHOUT
duke@435 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@435 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@435 12 * version 2 for more details (a copy is included in the LICENSE file that
duke@435 13 * accompanied this code).
duke@435 14 *
duke@435 15 * You should have received a copy of the GNU General Public License version
duke@435 16 * 2 along with this work; if not, write to the Free Software Foundation,
duke@435 17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@435 18 *
duke@435 19 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@435 20 * CA 95054 USA or visit www.sun.com if you need additional information or
duke@435 21 * have any questions.
duke@435 22 *
duke@435 23 */
duke@435 24
duke@435 25 # include "incls/_precompiled.incl"
duke@435 26 # include "incls/_referenceProcessor.cpp.incl"
duke@435 27
ysr@888 28 ReferencePolicy* ReferenceProcessor::_always_clear_soft_ref_policy = NULL;
ysr@888 29 ReferencePolicy* ReferenceProcessor::_default_soft_ref_policy = NULL;
ysr@888 30 oop ReferenceProcessor::_sentinelRef = NULL;
ysr@888 31 const int subclasses_of_ref = REF_PHANTOM - REF_OTHER;
ysr@888 32
duke@435 33 // List of discovered references.
duke@435 34 class DiscoveredList {
duke@435 35 public:
coleenp@548 36 DiscoveredList() : _len(0), _compressed_head(0), _oop_head(NULL) { }
coleenp@548 37 oop head() const {
coleenp@548 38 return UseCompressedOops ? oopDesc::decode_heap_oop_not_null(_compressed_head) :
coleenp@548 39 _oop_head;
coleenp@548 40 }
coleenp@548 41 HeapWord* adr_head() {
coleenp@548 42 return UseCompressedOops ? (HeapWord*)&_compressed_head :
coleenp@548 43 (HeapWord*)&_oop_head;
coleenp@548 44 }
coleenp@548 45 void set_head(oop o) {
coleenp@548 46 if (UseCompressedOops) {
coleenp@548 47 // Must compress the head ptr.
coleenp@548 48 _compressed_head = oopDesc::encode_heap_oop_not_null(o);
coleenp@548 49 } else {
coleenp@548 50 _oop_head = o;
coleenp@548 51 }
coleenp@548 52 }
coleenp@548 53 bool empty() const { return head() == ReferenceProcessor::sentinel_ref(); }
duke@435 54 size_t length() { return _len; }
ysr@887 55 void set_length(size_t len) { _len = len; }
ysr@887 56 void inc_length(size_t inc) { _len += inc; assert(_len > 0, "Error"); }
ysr@887 57 void dec_length(size_t dec) { _len -= dec; }
duke@435 58 private:
coleenp@548 59 // Set value depending on UseCompressedOops. This could be a template class
coleenp@548 60 // but then we have to fix all the instantiations and declarations that use this class.
coleenp@548 61 oop _oop_head;
coleenp@548 62 narrowOop _compressed_head;
duke@435 63 size_t _len;
duke@435 64 };
duke@435 65
duke@435 66 void referenceProcessor_init() {
duke@435 67 ReferenceProcessor::init_statics();
duke@435 68 }
duke@435 69
duke@435 70 void ReferenceProcessor::init_statics() {
coleenp@548 71 assert(_sentinelRef == NULL, "should be initialized precisely once");
duke@435 72 EXCEPTION_MARK;
duke@435 73 _sentinelRef = instanceKlass::cast(
coleenp@548 74 SystemDictionary::reference_klass())->
coleenp@548 75 allocate_permanent_instance(THREAD);
duke@435 76
duke@435 77 // Initialize the master soft ref clock.
duke@435 78 java_lang_ref_SoftReference::set_clock(os::javaTimeMillis());
duke@435 79
duke@435 80 if (HAS_PENDING_EXCEPTION) {
duke@435 81 Handle ex(THREAD, PENDING_EXCEPTION);
duke@435 82 vm_exit_during_initialization(ex);
duke@435 83 }
duke@435 84 assert(_sentinelRef != NULL && _sentinelRef->is_oop(),
duke@435 85 "Just constructed it!");
ysr@888 86 _always_clear_soft_ref_policy = new AlwaysClearPolicy();
ysr@888 87 _default_soft_ref_policy = new COMPILER2_PRESENT(LRUMaxHeapPolicy())
ysr@888 88 NOT_COMPILER2(LRUCurrentHeapPolicy());
ysr@888 89 if (_always_clear_soft_ref_policy == NULL || _default_soft_ref_policy == NULL) {
ysr@888 90 vm_exit_during_initialization("Could not allocate reference policy object");
ysr@888 91 }
duke@435 92 guarantee(RefDiscoveryPolicy == ReferenceBasedDiscovery ||
duke@435 93 RefDiscoveryPolicy == ReferentBasedDiscovery,
duke@435 94 "Unrecongnized RefDiscoveryPolicy");
duke@435 95 }
duke@435 96
coleenp@548 97 ReferenceProcessor*
coleenp@548 98 ReferenceProcessor::create_ref_processor(MemRegion span,
coleenp@548 99 bool atomic_discovery,
coleenp@548 100 bool mt_discovery,
coleenp@548 101 BoolObjectClosure* is_alive_non_header,
coleenp@548 102 int parallel_gc_threads,
ysr@777 103 bool mt_processing,
ysr@777 104 bool dl_needs_barrier) {
duke@435 105 int mt_degree = 1;
duke@435 106 if (parallel_gc_threads > 1) {
duke@435 107 mt_degree = parallel_gc_threads;
duke@435 108 }
duke@435 109 ReferenceProcessor* rp =
duke@435 110 new ReferenceProcessor(span, atomic_discovery,
duke@435 111 mt_discovery, mt_degree,
ysr@777 112 mt_processing && (parallel_gc_threads > 0),
ysr@777 113 dl_needs_barrier);
duke@435 114 if (rp == NULL) {
duke@435 115 vm_exit_during_initialization("Could not allocate ReferenceProcessor object");
duke@435 116 }
duke@435 117 rp->set_is_alive_non_header(is_alive_non_header);
ysr@892 118 rp->setup_policy(false /* default soft ref policy */);
duke@435 119 return rp;
duke@435 120 }
duke@435 121
duke@435 122 ReferenceProcessor::ReferenceProcessor(MemRegion span,
coleenp@548 123 bool atomic_discovery,
coleenp@548 124 bool mt_discovery,
coleenp@548 125 int mt_degree,
ysr@777 126 bool mt_processing,
ysr@777 127 bool discovered_list_needs_barrier) :
duke@435 128 _discovering_refs(false),
duke@435 129 _enqueuing_is_done(false),
duke@435 130 _is_alive_non_header(NULL),
ysr@777 131 _discovered_list_needs_barrier(discovered_list_needs_barrier),
ysr@777 132 _bs(NULL),
duke@435 133 _processing_is_mt(mt_processing),
duke@435 134 _next_id(0)
duke@435 135 {
duke@435 136 _span = span;
duke@435 137 _discovery_is_atomic = atomic_discovery;
duke@435 138 _discovery_is_mt = mt_discovery;
duke@435 139 _num_q = mt_degree;
duke@435 140 _discoveredSoftRefs = NEW_C_HEAP_ARRAY(DiscoveredList, _num_q * subclasses_of_ref);
duke@435 141 if (_discoveredSoftRefs == NULL) {
duke@435 142 vm_exit_during_initialization("Could not allocated RefProc Array");
duke@435 143 }
duke@435 144 _discoveredWeakRefs = &_discoveredSoftRefs[_num_q];
duke@435 145 _discoveredFinalRefs = &_discoveredWeakRefs[_num_q];
duke@435 146 _discoveredPhantomRefs = &_discoveredFinalRefs[_num_q];
coleenp@548 147 assert(sentinel_ref() != NULL, "_sentinelRef is NULL");
duke@435 148 // Initialized all entries to _sentinelRef
duke@435 149 for (int i = 0; i < _num_q * subclasses_of_ref; i++) {
coleenp@548 150 _discoveredSoftRefs[i].set_head(sentinel_ref());
duke@435 151 _discoveredSoftRefs[i].set_length(0);
duke@435 152 }
ysr@777 153 // If we do barreirs, cache a copy of the barrier set.
ysr@777 154 if (discovered_list_needs_barrier) {
ysr@777 155 _bs = Universe::heap()->barrier_set();
ysr@777 156 }
duke@435 157 }
duke@435 158
duke@435 159 #ifndef PRODUCT
duke@435 160 void ReferenceProcessor::verify_no_references_recorded() {
duke@435 161 guarantee(!_discovering_refs, "Discovering refs?");
duke@435 162 for (int i = 0; i < _num_q * subclasses_of_ref; i++) {
duke@435 163 guarantee(_discoveredSoftRefs[i].empty(),
duke@435 164 "Found non-empty discovered list");
duke@435 165 }
duke@435 166 }
duke@435 167 #endif
duke@435 168
duke@435 169 void ReferenceProcessor::weak_oops_do(OopClosure* f) {
duke@435 170 for (int i = 0; i < _num_q * subclasses_of_ref; i++) {
coleenp@548 171 if (UseCompressedOops) {
coleenp@548 172 f->do_oop((narrowOop*)_discoveredSoftRefs[i].adr_head());
coleenp@548 173 } else {
coleenp@548 174 f->do_oop((oop*)_discoveredSoftRefs[i].adr_head());
coleenp@548 175 }
duke@435 176 }
duke@435 177 }
duke@435 178
duke@435 179 void ReferenceProcessor::oops_do(OopClosure* f) {
coleenp@548 180 f->do_oop(adr_sentinel_ref());
duke@435 181 }
duke@435 182
coleenp@548 183 void ReferenceProcessor::update_soft_ref_master_clock() {
duke@435 184 // Update (advance) the soft ref master clock field. This must be done
duke@435 185 // after processing the soft ref list.
duke@435 186 jlong now = os::javaTimeMillis();
duke@435 187 jlong clock = java_lang_ref_SoftReference::clock();
duke@435 188 NOT_PRODUCT(
duke@435 189 if (now < clock) {
duke@435 190 warning("time warp: %d to %d", clock, now);
duke@435 191 }
duke@435 192 )
duke@435 193 // In product mode, protect ourselves from system time being adjusted
duke@435 194 // externally and going backward; see note in the implementation of
duke@435 195 // GenCollectedHeap::time_since_last_gc() for the right way to fix
duke@435 196 // this uniformly throughout the VM; see bug-id 4741166. XXX
duke@435 197 if (now > clock) {
duke@435 198 java_lang_ref_SoftReference::set_clock(now);
duke@435 199 }
duke@435 200 // Else leave clock stalled at its old value until time progresses
duke@435 201 // past clock value.
duke@435 202 }
duke@435 203
coleenp@548 204 void ReferenceProcessor::process_discovered_references(
duke@435 205 BoolObjectClosure* is_alive,
duke@435 206 OopClosure* keep_alive,
duke@435 207 VoidClosure* complete_gc,
duke@435 208 AbstractRefProcTaskExecutor* task_executor) {
duke@435 209 NOT_PRODUCT(verify_ok_to_handle_reflists());
duke@435 210
duke@435 211 assert(!enqueuing_is_done(), "If here enqueuing should not be complete");
duke@435 212 // Stop treating discovered references specially.
duke@435 213 disable_discovery();
duke@435 214
duke@435 215 bool trace_time = PrintGCDetails && PrintReferenceGC;
duke@435 216 // Soft references
duke@435 217 {
duke@435 218 TraceTime tt("SoftReference", trace_time, false, gclog_or_tty);
ysr@888 219 process_discovered_reflist(_discoveredSoftRefs, _current_soft_ref_policy, true,
duke@435 220 is_alive, keep_alive, complete_gc, task_executor);
duke@435 221 }
duke@435 222
duke@435 223 update_soft_ref_master_clock();
duke@435 224
duke@435 225 // Weak references
duke@435 226 {
duke@435 227 TraceTime tt("WeakReference", trace_time, false, gclog_or_tty);
duke@435 228 process_discovered_reflist(_discoveredWeakRefs, NULL, true,
duke@435 229 is_alive, keep_alive, complete_gc, task_executor);
duke@435 230 }
duke@435 231
duke@435 232 // Final references
duke@435 233 {
duke@435 234 TraceTime tt("FinalReference", trace_time, false, gclog_or_tty);
duke@435 235 process_discovered_reflist(_discoveredFinalRefs, NULL, false,
duke@435 236 is_alive, keep_alive, complete_gc, task_executor);
duke@435 237 }
duke@435 238
duke@435 239 // Phantom references
duke@435 240 {
duke@435 241 TraceTime tt("PhantomReference", trace_time, false, gclog_or_tty);
duke@435 242 process_discovered_reflist(_discoveredPhantomRefs, NULL, false,
duke@435 243 is_alive, keep_alive, complete_gc, task_executor);
duke@435 244 }
duke@435 245
duke@435 246 // Weak global JNI references. It would make more sense (semantically) to
duke@435 247 // traverse these simultaneously with the regular weak references above, but
duke@435 248 // that is not how the JDK1.2 specification is. See #4126360. Native code can
duke@435 249 // thus use JNI weak references to circumvent the phantom references and
duke@435 250 // resurrect a "post-mortem" object.
duke@435 251 {
duke@435 252 TraceTime tt("JNI Weak Reference", trace_time, false, gclog_or_tty);
duke@435 253 if (task_executor != NULL) {
duke@435 254 task_executor->set_single_threaded_mode();
duke@435 255 }
duke@435 256 process_phaseJNI(is_alive, keep_alive, complete_gc);
duke@435 257 }
duke@435 258 }
duke@435 259
duke@435 260 #ifndef PRODUCT
duke@435 261 // Calculate the number of jni handles.
coleenp@548 262 uint ReferenceProcessor::count_jni_refs() {
duke@435 263 class AlwaysAliveClosure: public BoolObjectClosure {
duke@435 264 public:
coleenp@548 265 virtual bool do_object_b(oop obj) { return true; }
coleenp@548 266 virtual void do_object(oop obj) { assert(false, "Don't call"); }
duke@435 267 };
duke@435 268
duke@435 269 class CountHandleClosure: public OopClosure {
duke@435 270 private:
duke@435 271 int _count;
duke@435 272 public:
duke@435 273 CountHandleClosure(): _count(0) {}
coleenp@548 274 void do_oop(oop* unused) { _count++; }
coleenp@548 275 void do_oop(narrowOop* unused) { ShouldNotReachHere(); }
duke@435 276 int count() { return _count; }
duke@435 277 };
duke@435 278 CountHandleClosure global_handle_count;
duke@435 279 AlwaysAliveClosure always_alive;
duke@435 280 JNIHandles::weak_oops_do(&always_alive, &global_handle_count);
duke@435 281 return global_handle_count.count();
duke@435 282 }
duke@435 283 #endif
duke@435 284
duke@435 285 void ReferenceProcessor::process_phaseJNI(BoolObjectClosure* is_alive,
duke@435 286 OopClosure* keep_alive,
duke@435 287 VoidClosure* complete_gc) {
duke@435 288 #ifndef PRODUCT
duke@435 289 if (PrintGCDetails && PrintReferenceGC) {
duke@435 290 unsigned int count = count_jni_refs();
duke@435 291 gclog_or_tty->print(", %u refs", count);
duke@435 292 }
duke@435 293 #endif
duke@435 294 JNIHandles::weak_oops_do(is_alive, keep_alive);
duke@435 295 // Finally remember to keep sentinel around
coleenp@548 296 keep_alive->do_oop(adr_sentinel_ref());
duke@435 297 complete_gc->do_void();
duke@435 298 }
duke@435 299
coleenp@548 300
coleenp@548 301 template <class T>
coleenp@548 302 static bool enqueue_discovered_ref_helper(ReferenceProcessor* ref,
coleenp@548 303 AbstractRefProcTaskExecutor* task_executor) {
coleenp@548 304
duke@435 305 // Remember old value of pending references list
coleenp@548 306 T* pending_list_addr = (T*)java_lang_ref_Reference::pending_list_addr();
coleenp@548 307 T old_pending_list_value = *pending_list_addr;
duke@435 308
duke@435 309 // Enqueue references that are not made active again, and
duke@435 310 // clear the decks for the next collection (cycle).
coleenp@548 311 ref->enqueue_discovered_reflists((HeapWord*)pending_list_addr, task_executor);
duke@435 312 // Do the oop-check on pending_list_addr missed in
duke@435 313 // enqueue_discovered_reflist. We should probably
duke@435 314 // do a raw oop_check so that future such idempotent
duke@435 315 // oop_stores relying on the oop-check side-effect
duke@435 316 // may be elided automatically and safely without
duke@435 317 // affecting correctness.
coleenp@548 318 oop_store(pending_list_addr, oopDesc::load_decode_heap_oop(pending_list_addr));
duke@435 319
duke@435 320 // Stop treating discovered references specially.
coleenp@548 321 ref->disable_discovery();
duke@435 322
duke@435 323 // Return true if new pending references were added
duke@435 324 return old_pending_list_value != *pending_list_addr;
duke@435 325 }
duke@435 326
coleenp@548 327 bool ReferenceProcessor::enqueue_discovered_references(AbstractRefProcTaskExecutor* task_executor) {
coleenp@548 328 NOT_PRODUCT(verify_ok_to_handle_reflists());
coleenp@548 329 if (UseCompressedOops) {
coleenp@548 330 return enqueue_discovered_ref_helper<narrowOop>(this, task_executor);
coleenp@548 331 } else {
coleenp@548 332 return enqueue_discovered_ref_helper<oop>(this, task_executor);
coleenp@548 333 }
coleenp@548 334 }
coleenp@548 335
duke@435 336 void ReferenceProcessor::enqueue_discovered_reflist(DiscoveredList& refs_list,
coleenp@548 337 HeapWord* pending_list_addr) {
duke@435 338 // Given a list of refs linked through the "discovered" field
duke@435 339 // (java.lang.ref.Reference.discovered) chain them through the
duke@435 340 // "next" field (java.lang.ref.Reference.next) and prepend
duke@435 341 // to the pending list.
duke@435 342 if (TraceReferenceGC && PrintGCDetails) {
duke@435 343 gclog_or_tty->print_cr("ReferenceProcessor::enqueue_discovered_reflist list "
duke@435 344 INTPTR_FORMAT, (address)refs_list.head());
duke@435 345 }
duke@435 346 oop obj = refs_list.head();
duke@435 347 // Walk down the list, copying the discovered field into
duke@435 348 // the next field and clearing it (except for the last
duke@435 349 // non-sentinel object which is treated specially to avoid
duke@435 350 // confusion with an active reference).
coleenp@548 351 while (obj != sentinel_ref()) {
duke@435 352 assert(obj->is_instanceRef(), "should be reference object");
duke@435 353 oop next = java_lang_ref_Reference::discovered(obj);
duke@435 354 if (TraceReferenceGC && PrintGCDetails) {
coleenp@548 355 gclog_or_tty->print_cr(" obj " INTPTR_FORMAT "/next " INTPTR_FORMAT,
coleenp@548 356 obj, next);
duke@435 357 }
coleenp@548 358 assert(java_lang_ref_Reference::next(obj) == NULL,
coleenp@548 359 "The reference should not be enqueued");
coleenp@548 360 if (next == sentinel_ref()) { // obj is last
duke@435 361 // Swap refs_list into pendling_list_addr and
duke@435 362 // set obj's next to what we read from pending_list_addr.
coleenp@548 363 oop old = oopDesc::atomic_exchange_oop(refs_list.head(), pending_list_addr);
duke@435 364 // Need oop_check on pending_list_addr above;
duke@435 365 // see special oop-check code at the end of
duke@435 366 // enqueue_discovered_reflists() further below.
duke@435 367 if (old == NULL) {
duke@435 368 // obj should be made to point to itself, since
duke@435 369 // pending list was empty.
duke@435 370 java_lang_ref_Reference::set_next(obj, obj);
duke@435 371 } else {
duke@435 372 java_lang_ref_Reference::set_next(obj, old);
duke@435 373 }
duke@435 374 } else {
duke@435 375 java_lang_ref_Reference::set_next(obj, next);
duke@435 376 }
duke@435 377 java_lang_ref_Reference::set_discovered(obj, (oop) NULL);
duke@435 378 obj = next;
duke@435 379 }
duke@435 380 }
duke@435 381
duke@435 382 // Parallel enqueue task
duke@435 383 class RefProcEnqueueTask: public AbstractRefProcTaskExecutor::EnqueueTask {
duke@435 384 public:
duke@435 385 RefProcEnqueueTask(ReferenceProcessor& ref_processor,
duke@435 386 DiscoveredList discovered_refs[],
coleenp@548 387 HeapWord* pending_list_addr,
duke@435 388 oop sentinel_ref,
duke@435 389 int n_queues)
duke@435 390 : EnqueueTask(ref_processor, discovered_refs,
duke@435 391 pending_list_addr, sentinel_ref, n_queues)
duke@435 392 { }
duke@435 393
coleenp@548 394 virtual void work(unsigned int work_id) {
duke@435 395 assert(work_id < (unsigned int)_ref_processor.num_q(), "Index out-of-bounds");
duke@435 396 // Simplest first cut: static partitioning.
duke@435 397 int index = work_id;
duke@435 398 for (int j = 0; j < subclasses_of_ref; j++, index += _n_queues) {
duke@435 399 _ref_processor.enqueue_discovered_reflist(
duke@435 400 _refs_lists[index], _pending_list_addr);
duke@435 401 _refs_lists[index].set_head(_sentinel_ref);
duke@435 402 _refs_lists[index].set_length(0);
duke@435 403 }
duke@435 404 }
duke@435 405 };
duke@435 406
duke@435 407 // Enqueue references that are not made active again
coleenp@548 408 void ReferenceProcessor::enqueue_discovered_reflists(HeapWord* pending_list_addr,
duke@435 409 AbstractRefProcTaskExecutor* task_executor) {
duke@435 410 if (_processing_is_mt && task_executor != NULL) {
duke@435 411 // Parallel code
duke@435 412 RefProcEnqueueTask tsk(*this, _discoveredSoftRefs,
coleenp@548 413 pending_list_addr, sentinel_ref(), _num_q);
duke@435 414 task_executor->execute(tsk);
duke@435 415 } else {
duke@435 416 // Serial code: call the parent class's implementation
duke@435 417 for (int i = 0; i < _num_q * subclasses_of_ref; i++) {
duke@435 418 enqueue_discovered_reflist(_discoveredSoftRefs[i], pending_list_addr);
coleenp@548 419 _discoveredSoftRefs[i].set_head(sentinel_ref());
duke@435 420 _discoveredSoftRefs[i].set_length(0);
duke@435 421 }
duke@435 422 }
duke@435 423 }
duke@435 424
duke@435 425 // Iterator for the list of discovered references.
duke@435 426 class DiscoveredListIterator {
duke@435 427 public:
duke@435 428 inline DiscoveredListIterator(DiscoveredList& refs_list,
duke@435 429 OopClosure* keep_alive,
duke@435 430 BoolObjectClosure* is_alive);
duke@435 431
duke@435 432 // End Of List.
coleenp@548 433 inline bool has_next() const { return _next != ReferenceProcessor::sentinel_ref(); }
duke@435 434
duke@435 435 // Get oop to the Reference object.
coleenp@548 436 inline oop obj() const { return _ref; }
duke@435 437
duke@435 438 // Get oop to the referent object.
coleenp@548 439 inline oop referent() const { return _referent; }
duke@435 440
duke@435 441 // Returns true if referent is alive.
duke@435 442 inline bool is_referent_alive() const;
duke@435 443
duke@435 444 // Loads data for the current reference.
duke@435 445 // The "allow_null_referent" argument tells us to allow for the possibility
duke@435 446 // of a NULL referent in the discovered Reference object. This typically
duke@435 447 // happens in the case of concurrent collectors that may have done the
ysr@887 448 // discovery concurrently, or interleaved, with mutator execution.
duke@435 449 inline void load_ptrs(DEBUG_ONLY(bool allow_null_referent));
duke@435 450
duke@435 451 // Move to the next discovered reference.
duke@435 452 inline void next();
duke@435 453
ysr@887 454 // Remove the current reference from the list
duke@435 455 inline void remove();
duke@435 456
duke@435 457 // Make the Reference object active again.
duke@435 458 inline void make_active() { java_lang_ref_Reference::set_next(_ref, NULL); }
duke@435 459
duke@435 460 // Make the referent alive.
coleenp@548 461 inline void make_referent_alive() {
coleenp@548 462 if (UseCompressedOops) {
coleenp@548 463 _keep_alive->do_oop((narrowOop*)_referent_addr);
coleenp@548 464 } else {
coleenp@548 465 _keep_alive->do_oop((oop*)_referent_addr);
coleenp@548 466 }
coleenp@548 467 }
duke@435 468
duke@435 469 // Update the discovered field.
coleenp@548 470 inline void update_discovered() {
coleenp@548 471 // First _prev_next ref actually points into DiscoveredList (gross).
coleenp@548 472 if (UseCompressedOops) {
coleenp@548 473 _keep_alive->do_oop((narrowOop*)_prev_next);
coleenp@548 474 } else {
coleenp@548 475 _keep_alive->do_oop((oop*)_prev_next);
coleenp@548 476 }
coleenp@548 477 }
duke@435 478
duke@435 479 // NULL out referent pointer.
coleenp@548 480 inline void clear_referent() { oop_store_raw(_referent_addr, NULL); }
duke@435 481
duke@435 482 // Statistics
duke@435 483 NOT_PRODUCT(
duke@435 484 inline size_t processed() const { return _processed; }
duke@435 485 inline size_t removed() const { return _removed; }
duke@435 486 )
duke@435 487
duke@435 488 inline void move_to_next();
duke@435 489
duke@435 490 private:
duke@435 491 DiscoveredList& _refs_list;
coleenp@548 492 HeapWord* _prev_next;
duke@435 493 oop _ref;
coleenp@548 494 HeapWord* _discovered_addr;
duke@435 495 oop _next;
coleenp@548 496 HeapWord* _referent_addr;
duke@435 497 oop _referent;
duke@435 498 OopClosure* _keep_alive;
duke@435 499 BoolObjectClosure* _is_alive;
duke@435 500 DEBUG_ONLY(
duke@435 501 oop _first_seen; // cyclic linked list check
duke@435 502 )
duke@435 503 NOT_PRODUCT(
duke@435 504 size_t _processed;
duke@435 505 size_t _removed;
duke@435 506 )
duke@435 507 };
duke@435 508
duke@435 509 inline DiscoveredListIterator::DiscoveredListIterator(DiscoveredList& refs_list,
duke@435 510 OopClosure* keep_alive,
duke@435 511 BoolObjectClosure* is_alive)
duke@435 512 : _refs_list(refs_list),
coleenp@548 513 _prev_next(refs_list.adr_head()),
duke@435 514 _ref(refs_list.head()),
duke@435 515 #ifdef ASSERT
duke@435 516 _first_seen(refs_list.head()),
duke@435 517 #endif
duke@435 518 #ifndef PRODUCT
duke@435 519 _processed(0),
duke@435 520 _removed(0),
duke@435 521 #endif
duke@435 522 _next(refs_list.head()),
duke@435 523 _keep_alive(keep_alive),
duke@435 524 _is_alive(is_alive)
duke@435 525 { }
duke@435 526
coleenp@548 527 inline bool DiscoveredListIterator::is_referent_alive() const {
duke@435 528 return _is_alive->do_object_b(_referent);
duke@435 529 }
duke@435 530
coleenp@548 531 inline void DiscoveredListIterator::load_ptrs(DEBUG_ONLY(bool allow_null_referent)) {
duke@435 532 _discovered_addr = java_lang_ref_Reference::discovered_addr(_ref);
coleenp@548 533 oop discovered = java_lang_ref_Reference::discovered(_ref);
coleenp@548 534 assert(_discovered_addr && discovered->is_oop_or_null(),
duke@435 535 "discovered field is bad");
coleenp@548 536 _next = discovered;
duke@435 537 _referent_addr = java_lang_ref_Reference::referent_addr(_ref);
coleenp@548 538 _referent = java_lang_ref_Reference::referent(_ref);
duke@435 539 assert(Universe::heap()->is_in_reserved_or_null(_referent),
duke@435 540 "Wrong oop found in java.lang.Reference object");
duke@435 541 assert(allow_null_referent ?
duke@435 542 _referent->is_oop_or_null()
duke@435 543 : _referent->is_oop(),
duke@435 544 "bad referent");
duke@435 545 }
duke@435 546
coleenp@548 547 inline void DiscoveredListIterator::next() {
duke@435 548 _prev_next = _discovered_addr;
duke@435 549 move_to_next();
duke@435 550 }
duke@435 551
coleenp@548 552 inline void DiscoveredListIterator::remove() {
duke@435 553 assert(_ref->is_oop(), "Dropping a bad reference");
coleenp@548 554 oop_store_raw(_discovered_addr, NULL);
coleenp@548 555 // First _prev_next ref actually points into DiscoveredList (gross).
coleenp@548 556 if (UseCompressedOops) {
coleenp@548 557 // Remove Reference object from list.
coleenp@548 558 oopDesc::encode_store_heap_oop_not_null((narrowOop*)_prev_next, _next);
coleenp@548 559 } else {
coleenp@548 560 // Remove Reference object from list.
coleenp@548 561 oopDesc::store_heap_oop((oop*)_prev_next, _next);
coleenp@548 562 }
duke@435 563 NOT_PRODUCT(_removed++);
ysr@887 564 _refs_list.dec_length(1);
duke@435 565 }
duke@435 566
coleenp@548 567 inline void DiscoveredListIterator::move_to_next() {
duke@435 568 _ref = _next;
duke@435 569 assert(_ref != _first_seen, "cyclic ref_list found");
duke@435 570 NOT_PRODUCT(_processed++);
duke@435 571 }
duke@435 572
duke@435 573 // NOTE: process_phase*() are largely similar, and at a high level
duke@435 574 // merely iterate over the extant list applying a predicate to
duke@435 575 // each of its elements and possibly removing that element from the
duke@435 576 // list and applying some further closures to that element.
duke@435 577 // We should consider the possibility of replacing these
duke@435 578 // process_phase*() methods by abstracting them into
duke@435 579 // a single general iterator invocation that receives appropriate
duke@435 580 // closures that accomplish this work.
duke@435 581
duke@435 582 // (SoftReferences only) Traverse the list and remove any SoftReferences whose
duke@435 583 // referents are not alive, but that should be kept alive for policy reasons.
duke@435 584 // Keep alive the transitive closure of all such referents.
duke@435 585 void
coleenp@548 586 ReferenceProcessor::process_phase1(DiscoveredList& refs_list,
duke@435 587 ReferencePolicy* policy,
duke@435 588 BoolObjectClosure* is_alive,
duke@435 589 OopClosure* keep_alive,
duke@435 590 VoidClosure* complete_gc) {
duke@435 591 assert(policy != NULL, "Must have a non-NULL policy");
coleenp@548 592 DiscoveredListIterator iter(refs_list, keep_alive, is_alive);
duke@435 593 // Decide which softly reachable refs should be kept alive.
duke@435 594 while (iter.has_next()) {
duke@435 595 iter.load_ptrs(DEBUG_ONLY(!discovery_is_atomic() /* allow_null_referent */));
duke@435 596 bool referent_is_dead = (iter.referent() != NULL) && !iter.is_referent_alive();
duke@435 597 if (referent_is_dead && !policy->should_clear_reference(iter.obj())) {
duke@435 598 if (TraceReferenceGC) {
duke@435 599 gclog_or_tty->print_cr("Dropping reference (" INTPTR_FORMAT ": %s" ") by policy",
coleenp@548 600 iter.obj(), iter.obj()->blueprint()->internal_name());
duke@435 601 }
ysr@887 602 // Remove Reference object from list
ysr@887 603 iter.remove();
duke@435 604 // Make the Reference object active again
duke@435 605 iter.make_active();
duke@435 606 // keep the referent around
duke@435 607 iter.make_referent_alive();
ysr@887 608 iter.move_to_next();
duke@435 609 } else {
duke@435 610 iter.next();
duke@435 611 }
duke@435 612 }
duke@435 613 // Close the reachable set
duke@435 614 complete_gc->do_void();
duke@435 615 NOT_PRODUCT(
duke@435 616 if (PrintGCDetails && TraceReferenceGC) {
duke@435 617 gclog_or_tty->print(" Dropped %d dead Refs out of %d "
duke@435 618 "discovered Refs by policy ", iter.removed(), iter.processed());
duke@435 619 }
duke@435 620 )
duke@435 621 }
duke@435 622
duke@435 623 // Traverse the list and remove any Refs that are not active, or
duke@435 624 // whose referents are either alive or NULL.
duke@435 625 void
coleenp@548 626 ReferenceProcessor::pp2_work(DiscoveredList& refs_list,
duke@435 627 BoolObjectClosure* is_alive,
coleenp@548 628 OopClosure* keep_alive) {
duke@435 629 assert(discovery_is_atomic(), "Error");
coleenp@548 630 DiscoveredListIterator iter(refs_list, keep_alive, is_alive);
duke@435 631 while (iter.has_next()) {
duke@435 632 iter.load_ptrs(DEBUG_ONLY(false /* allow_null_referent */));
coleenp@548 633 DEBUG_ONLY(oop next = java_lang_ref_Reference::next(iter.obj());)
coleenp@548 634 assert(next == NULL, "Should not discover inactive Reference");
duke@435 635 if (iter.is_referent_alive()) {
duke@435 636 if (TraceReferenceGC) {
duke@435 637 gclog_or_tty->print_cr("Dropping strongly reachable reference (" INTPTR_FORMAT ": %s)",
coleenp@548 638 iter.obj(), iter.obj()->blueprint()->internal_name());
duke@435 639 }
duke@435 640 // The referent is reachable after all.
ysr@887 641 // Remove Reference object from list.
ysr@887 642 iter.remove();
duke@435 643 // Update the referent pointer as necessary: Note that this
duke@435 644 // should not entail any recursive marking because the
duke@435 645 // referent must already have been traversed.
duke@435 646 iter.make_referent_alive();
ysr@887 647 iter.move_to_next();
duke@435 648 } else {
duke@435 649 iter.next();
duke@435 650 }
duke@435 651 }
duke@435 652 NOT_PRODUCT(
duke@435 653 if (PrintGCDetails && TraceReferenceGC) {
duke@435 654 gclog_or_tty->print(" Dropped %d active Refs out of %d "
duke@435 655 "Refs in discovered list ", iter.removed(), iter.processed());
duke@435 656 }
duke@435 657 )
duke@435 658 }
duke@435 659
duke@435 660 void
coleenp@548 661 ReferenceProcessor::pp2_work_concurrent_discovery(DiscoveredList& refs_list,
coleenp@548 662 BoolObjectClosure* is_alive,
coleenp@548 663 OopClosure* keep_alive,
coleenp@548 664 VoidClosure* complete_gc) {
duke@435 665 assert(!discovery_is_atomic(), "Error");
coleenp@548 666 DiscoveredListIterator iter(refs_list, keep_alive, is_alive);
duke@435 667 while (iter.has_next()) {
duke@435 668 iter.load_ptrs(DEBUG_ONLY(true /* allow_null_referent */));
coleenp@548 669 HeapWord* next_addr = java_lang_ref_Reference::next_addr(iter.obj());
coleenp@548 670 oop next = java_lang_ref_Reference::next(iter.obj());
duke@435 671 if ((iter.referent() == NULL || iter.is_referent_alive() ||
coleenp@548 672 next != NULL)) {
coleenp@548 673 assert(next->is_oop_or_null(), "bad next field");
duke@435 674 // Remove Reference object from list
duke@435 675 iter.remove();
duke@435 676 // Trace the cohorts
duke@435 677 iter.make_referent_alive();
coleenp@548 678 if (UseCompressedOops) {
coleenp@548 679 keep_alive->do_oop((narrowOop*)next_addr);
coleenp@548 680 } else {
coleenp@548 681 keep_alive->do_oop((oop*)next_addr);
coleenp@548 682 }
ysr@887 683 iter.move_to_next();
duke@435 684 } else {
duke@435 685 iter.next();
duke@435 686 }
duke@435 687 }
duke@435 688 // Now close the newly reachable set
duke@435 689 complete_gc->do_void();
duke@435 690 NOT_PRODUCT(
duke@435 691 if (PrintGCDetails && TraceReferenceGC) {
duke@435 692 gclog_or_tty->print(" Dropped %d active Refs out of %d "
duke@435 693 "Refs in discovered list ", iter.removed(), iter.processed());
duke@435 694 }
duke@435 695 )
duke@435 696 }
duke@435 697
duke@435 698 // Traverse the list and process the referents, by either
coleenp@548 699 // clearing them or keeping them (and their reachable
duke@435 700 // closure) alive.
duke@435 701 void
coleenp@548 702 ReferenceProcessor::process_phase3(DiscoveredList& refs_list,
duke@435 703 bool clear_referent,
duke@435 704 BoolObjectClosure* is_alive,
duke@435 705 OopClosure* keep_alive,
duke@435 706 VoidClosure* complete_gc) {
coleenp@548 707 DiscoveredListIterator iter(refs_list, keep_alive, is_alive);
duke@435 708 while (iter.has_next()) {
duke@435 709 iter.update_discovered();
duke@435 710 iter.load_ptrs(DEBUG_ONLY(false /* allow_null_referent */));
duke@435 711 if (clear_referent) {
duke@435 712 // NULL out referent pointer
duke@435 713 iter.clear_referent();
duke@435 714 } else {
duke@435 715 // keep the referent around
duke@435 716 iter.make_referent_alive();
duke@435 717 }
duke@435 718 if (TraceReferenceGC) {
duke@435 719 gclog_or_tty->print_cr("Adding %sreference (" INTPTR_FORMAT ": %s) as pending",
duke@435 720 clear_referent ? "cleared " : "",
coleenp@548 721 iter.obj(), iter.obj()->blueprint()->internal_name());
duke@435 722 }
duke@435 723 assert(iter.obj()->is_oop(UseConcMarkSweepGC), "Adding a bad reference");
duke@435 724 iter.next();
duke@435 725 }
duke@435 726 // Remember to keep sentinel pointer around
duke@435 727 iter.update_discovered();
duke@435 728 // Close the reachable set
duke@435 729 complete_gc->do_void();
duke@435 730 }
duke@435 731
duke@435 732 void
coleenp@548 733 ReferenceProcessor::abandon_partial_discovered_list(DiscoveredList& refs_list) {
coleenp@548 734 oop obj = refs_list.head();
coleenp@548 735 while (obj != sentinel_ref()) {
coleenp@548 736 oop discovered = java_lang_ref_Reference::discovered(obj);
coleenp@548 737 java_lang_ref_Reference::set_discovered_raw(obj, NULL);
coleenp@548 738 obj = discovered;
duke@435 739 }
coleenp@548 740 refs_list.set_head(sentinel_ref());
coleenp@548 741 refs_list.set_length(0);
duke@435 742 }
duke@435 743
ysr@777 744 void ReferenceProcessor::abandon_partial_discovery() {
ysr@777 745 // loop over the lists
ysr@777 746 for (int i = 0; i < _num_q * subclasses_of_ref; i++) {
ysr@777 747 if (TraceReferenceGC && PrintGCDetails && ((i % _num_q) == 0)) {
ysr@777 748 gclog_or_tty->print_cr(
ysr@777 749 "\nAbandoning %s discovered list",
ysr@777 750 list_name(i));
ysr@777 751 }
ysr@777 752 abandon_partial_discovered_list(_discoveredSoftRefs[i]);
duke@435 753 }
duke@435 754 }
duke@435 755
duke@435 756 class RefProcPhase1Task: public AbstractRefProcTaskExecutor::ProcessTask {
duke@435 757 public:
duke@435 758 RefProcPhase1Task(ReferenceProcessor& ref_processor,
duke@435 759 DiscoveredList refs_lists[],
duke@435 760 ReferencePolicy* policy,
duke@435 761 bool marks_oops_alive)
duke@435 762 : ProcessTask(ref_processor, refs_lists, marks_oops_alive),
duke@435 763 _policy(policy)
duke@435 764 { }
duke@435 765 virtual void work(unsigned int i, BoolObjectClosure& is_alive,
duke@435 766 OopClosure& keep_alive,
duke@435 767 VoidClosure& complete_gc)
duke@435 768 {
duke@435 769 _ref_processor.process_phase1(_refs_lists[i], _policy,
duke@435 770 &is_alive, &keep_alive, &complete_gc);
duke@435 771 }
duke@435 772 private:
duke@435 773 ReferencePolicy* _policy;
duke@435 774 };
duke@435 775
duke@435 776 class RefProcPhase2Task: public AbstractRefProcTaskExecutor::ProcessTask {
duke@435 777 public:
duke@435 778 RefProcPhase2Task(ReferenceProcessor& ref_processor,
duke@435 779 DiscoveredList refs_lists[],
duke@435 780 bool marks_oops_alive)
duke@435 781 : ProcessTask(ref_processor, refs_lists, marks_oops_alive)
duke@435 782 { }
duke@435 783 virtual void work(unsigned int i, BoolObjectClosure& is_alive,
duke@435 784 OopClosure& keep_alive,
duke@435 785 VoidClosure& complete_gc)
duke@435 786 {
duke@435 787 _ref_processor.process_phase2(_refs_lists[i],
duke@435 788 &is_alive, &keep_alive, &complete_gc);
duke@435 789 }
duke@435 790 };
duke@435 791
duke@435 792 class RefProcPhase3Task: public AbstractRefProcTaskExecutor::ProcessTask {
duke@435 793 public:
duke@435 794 RefProcPhase3Task(ReferenceProcessor& ref_processor,
duke@435 795 DiscoveredList refs_lists[],
duke@435 796 bool clear_referent,
duke@435 797 bool marks_oops_alive)
duke@435 798 : ProcessTask(ref_processor, refs_lists, marks_oops_alive),
duke@435 799 _clear_referent(clear_referent)
duke@435 800 { }
duke@435 801 virtual void work(unsigned int i, BoolObjectClosure& is_alive,
duke@435 802 OopClosure& keep_alive,
duke@435 803 VoidClosure& complete_gc)
duke@435 804 {
duke@435 805 _ref_processor.process_phase3(_refs_lists[i], _clear_referent,
duke@435 806 &is_alive, &keep_alive, &complete_gc);
duke@435 807 }
duke@435 808 private:
duke@435 809 bool _clear_referent;
duke@435 810 };
duke@435 811
duke@435 812 // Balances reference queues.
duke@435 813 void ReferenceProcessor::balance_queues(DiscoveredList ref_lists[])
duke@435 814 {
duke@435 815 // calculate total length
duke@435 816 size_t total_refs = 0;
duke@435 817 for (int i = 0; i < _num_q; ++i) {
duke@435 818 total_refs += ref_lists[i].length();
duke@435 819 }
duke@435 820 size_t avg_refs = total_refs / _num_q + 1;
duke@435 821 int to_idx = 0;
duke@435 822 for (int from_idx = 0; from_idx < _num_q; from_idx++) {
duke@435 823 while (ref_lists[from_idx].length() > avg_refs) {
duke@435 824 assert(to_idx < _num_q, "Sanity Check!");
duke@435 825 if (ref_lists[to_idx].length() < avg_refs) {
duke@435 826 // move superfluous refs
duke@435 827 size_t refs_to_move =
duke@435 828 MIN2(ref_lists[from_idx].length() - avg_refs,
duke@435 829 avg_refs - ref_lists[to_idx].length());
duke@435 830 oop move_head = ref_lists[from_idx].head();
duke@435 831 oop move_tail = move_head;
duke@435 832 oop new_head = move_head;
duke@435 833 // find an element to split the list on
duke@435 834 for (size_t j = 0; j < refs_to_move; ++j) {
duke@435 835 move_tail = new_head;
coleenp@548 836 new_head = java_lang_ref_Reference::discovered(new_head);
duke@435 837 }
duke@435 838 java_lang_ref_Reference::set_discovered(move_tail, ref_lists[to_idx].head());
duke@435 839 ref_lists[to_idx].set_head(move_head);
ysr@887 840 ref_lists[to_idx].inc_length(refs_to_move);
duke@435 841 ref_lists[from_idx].set_head(new_head);
ysr@887 842 ref_lists[from_idx].dec_length(refs_to_move);
duke@435 843 } else {
duke@435 844 ++to_idx;
duke@435 845 }
duke@435 846 }
duke@435 847 }
duke@435 848 }
duke@435 849
duke@435 850 void
duke@435 851 ReferenceProcessor::process_discovered_reflist(
duke@435 852 DiscoveredList refs_lists[],
duke@435 853 ReferencePolicy* policy,
duke@435 854 bool clear_referent,
duke@435 855 BoolObjectClosure* is_alive,
duke@435 856 OopClosure* keep_alive,
duke@435 857 VoidClosure* complete_gc,
duke@435 858 AbstractRefProcTaskExecutor* task_executor)
duke@435 859 {
duke@435 860 bool mt = task_executor != NULL && _processing_is_mt;
duke@435 861 if (mt && ParallelRefProcBalancingEnabled) {
duke@435 862 balance_queues(refs_lists);
duke@435 863 }
duke@435 864 if (PrintReferenceGC && PrintGCDetails) {
duke@435 865 size_t total = 0;
duke@435 866 for (int i = 0; i < _num_q; ++i) {
duke@435 867 total += refs_lists[i].length();
duke@435 868 }
duke@435 869 gclog_or_tty->print(", %u refs", total);
duke@435 870 }
duke@435 871
duke@435 872 // Phase 1 (soft refs only):
duke@435 873 // . Traverse the list and remove any SoftReferences whose
duke@435 874 // referents are not alive, but that should be kept alive for
duke@435 875 // policy reasons. Keep alive the transitive closure of all
duke@435 876 // such referents.
duke@435 877 if (policy != NULL) {
duke@435 878 if (mt) {
duke@435 879 RefProcPhase1Task phase1(*this, refs_lists, policy, true /*marks_oops_alive*/);
duke@435 880 task_executor->execute(phase1);
duke@435 881 } else {
duke@435 882 for (int i = 0; i < _num_q; i++) {
duke@435 883 process_phase1(refs_lists[i], policy,
duke@435 884 is_alive, keep_alive, complete_gc);
duke@435 885 }
duke@435 886 }
duke@435 887 } else { // policy == NULL
duke@435 888 assert(refs_lists != _discoveredSoftRefs,
duke@435 889 "Policy must be specified for soft references.");
duke@435 890 }
duke@435 891
duke@435 892 // Phase 2:
duke@435 893 // . Traverse the list and remove any refs whose referents are alive.
duke@435 894 if (mt) {
duke@435 895 RefProcPhase2Task phase2(*this, refs_lists, !discovery_is_atomic() /*marks_oops_alive*/);
duke@435 896 task_executor->execute(phase2);
duke@435 897 } else {
duke@435 898 for (int i = 0; i < _num_q; i++) {
duke@435 899 process_phase2(refs_lists[i], is_alive, keep_alive, complete_gc);
duke@435 900 }
duke@435 901 }
duke@435 902
duke@435 903 // Phase 3:
duke@435 904 // . Traverse the list and process referents as appropriate.
duke@435 905 if (mt) {
duke@435 906 RefProcPhase3Task phase3(*this, refs_lists, clear_referent, true /*marks_oops_alive*/);
duke@435 907 task_executor->execute(phase3);
duke@435 908 } else {
duke@435 909 for (int i = 0; i < _num_q; i++) {
duke@435 910 process_phase3(refs_lists[i], clear_referent,
duke@435 911 is_alive, keep_alive, complete_gc);
duke@435 912 }
duke@435 913 }
duke@435 914 }
duke@435 915
duke@435 916 void ReferenceProcessor::clean_up_discovered_references() {
duke@435 917 // loop over the lists
duke@435 918 for (int i = 0; i < _num_q * subclasses_of_ref; i++) {
duke@435 919 if (TraceReferenceGC && PrintGCDetails && ((i % _num_q) == 0)) {
duke@435 920 gclog_or_tty->print_cr(
duke@435 921 "\nScrubbing %s discovered list of Null referents",
duke@435 922 list_name(i));
duke@435 923 }
duke@435 924 clean_up_discovered_reflist(_discoveredSoftRefs[i]);
duke@435 925 }
duke@435 926 }
duke@435 927
duke@435 928 void ReferenceProcessor::clean_up_discovered_reflist(DiscoveredList& refs_list) {
duke@435 929 assert(!discovery_is_atomic(), "Else why call this method?");
duke@435 930 DiscoveredListIterator iter(refs_list, NULL, NULL);
duke@435 931 while (iter.has_next()) {
duke@435 932 iter.load_ptrs(DEBUG_ONLY(true /* allow_null_referent */));
coleenp@548 933 oop next = java_lang_ref_Reference::next(iter.obj());
coleenp@548 934 assert(next->is_oop_or_null(), "bad next field");
duke@435 935 // If referent has been cleared or Reference is not active,
duke@435 936 // drop it.
coleenp@548 937 if (iter.referent() == NULL || next != NULL) {
duke@435 938 debug_only(
duke@435 939 if (PrintGCDetails && TraceReferenceGC) {
duke@435 940 gclog_or_tty->print_cr("clean_up_discovered_list: Dropping Reference: "
duke@435 941 INTPTR_FORMAT " with next field: " INTPTR_FORMAT
duke@435 942 " and referent: " INTPTR_FORMAT,
coleenp@548 943 iter.obj(), next, iter.referent());
duke@435 944 }
duke@435 945 )
duke@435 946 // Remove Reference object from list
duke@435 947 iter.remove();
ysr@887 948 iter.move_to_next();
duke@435 949 } else {
duke@435 950 iter.next();
duke@435 951 }
duke@435 952 }
duke@435 953 NOT_PRODUCT(
duke@435 954 if (PrintGCDetails && TraceReferenceGC) {
duke@435 955 gclog_or_tty->print(
duke@435 956 " Removed %d Refs with NULL referents out of %d discovered Refs",
duke@435 957 iter.removed(), iter.processed());
duke@435 958 }
duke@435 959 )
duke@435 960 }
duke@435 961
duke@435 962 inline DiscoveredList* ReferenceProcessor::get_discovered_list(ReferenceType rt) {
duke@435 963 int id = 0;
duke@435 964 // Determine the queue index to use for this object.
duke@435 965 if (_discovery_is_mt) {
duke@435 966 // During a multi-threaded discovery phase,
duke@435 967 // each thread saves to its "own" list.
duke@435 968 Thread* thr = Thread::current();
duke@435 969 assert(thr->is_GC_task_thread(),
duke@435 970 "Dubious cast from Thread* to WorkerThread*?");
duke@435 971 id = ((WorkerThread*)thr)->id();
duke@435 972 } else {
duke@435 973 // single-threaded discovery, we save in round-robin
duke@435 974 // fashion to each of the lists.
duke@435 975 if (_processing_is_mt) {
duke@435 976 id = next_id();
duke@435 977 }
duke@435 978 }
duke@435 979 assert(0 <= id && id < _num_q, "Id is out-of-bounds (call Freud?)");
duke@435 980
duke@435 981 // Get the discovered queue to which we will add
duke@435 982 DiscoveredList* list = NULL;
duke@435 983 switch (rt) {
duke@435 984 case REF_OTHER:
duke@435 985 // Unknown reference type, no special treatment
duke@435 986 break;
duke@435 987 case REF_SOFT:
duke@435 988 list = &_discoveredSoftRefs[id];
duke@435 989 break;
duke@435 990 case REF_WEAK:
duke@435 991 list = &_discoveredWeakRefs[id];
duke@435 992 break;
duke@435 993 case REF_FINAL:
duke@435 994 list = &_discoveredFinalRefs[id];
duke@435 995 break;
duke@435 996 case REF_PHANTOM:
duke@435 997 list = &_discoveredPhantomRefs[id];
duke@435 998 break;
duke@435 999 case REF_NONE:
duke@435 1000 // we should not reach here if we are an instanceRefKlass
duke@435 1001 default:
duke@435 1002 ShouldNotReachHere();
duke@435 1003 }
duke@435 1004 return list;
duke@435 1005 }
duke@435 1006
coleenp@548 1007 inline void
coleenp@548 1008 ReferenceProcessor::add_to_discovered_list_mt(DiscoveredList& refs_list,
coleenp@548 1009 oop obj,
coleenp@548 1010 HeapWord* discovered_addr) {
duke@435 1011 assert(_discovery_is_mt, "!_discovery_is_mt should have been handled by caller");
duke@435 1012 // First we must make sure this object is only enqueued once. CAS in a non null
duke@435 1013 // discovered_addr.
ysr@777 1014 oop current_head = refs_list.head();
ysr@777 1015
ysr@777 1016 // Note: In the case of G1, this pre-barrier is strictly
ysr@777 1017 // not necessary because the only case we are interested in
ysr@777 1018 // here is when *discovered_addr is NULL, so this will expand to
ysr@777 1019 // nothing. As a result, I am just manually eliding this out for G1.
ysr@777 1020 if (_discovered_list_needs_barrier && !UseG1GC) {
ysr@777 1021 _bs->write_ref_field_pre((void*)discovered_addr, current_head); guarantee(false, "Needs to be fixed: YSR");
ysr@777 1022 }
ysr@777 1023 oop retest = oopDesc::atomic_compare_exchange_oop(current_head, discovered_addr,
coleenp@548 1024 NULL);
duke@435 1025 if (retest == NULL) {
duke@435 1026 // This thread just won the right to enqueue the object.
duke@435 1027 // We have separate lists for enqueueing so no synchronization
duke@435 1028 // is necessary.
coleenp@548 1029 refs_list.set_head(obj);
ysr@887 1030 refs_list.inc_length(1);
ysr@777 1031 if (_discovered_list_needs_barrier) {
ysr@777 1032 _bs->write_ref_field((void*)discovered_addr, current_head); guarantee(false, "Needs to be fixed: YSR");
ysr@777 1033 }
ysr@777 1034
duke@435 1035 } else {
duke@435 1036 // If retest was non NULL, another thread beat us to it:
duke@435 1037 // The reference has already been discovered...
duke@435 1038 if (TraceReferenceGC) {
duke@435 1039 gclog_or_tty->print_cr("Already enqueued reference (" INTPTR_FORMAT ": %s)",
duke@435 1040 obj, obj->blueprint()->internal_name());
duke@435 1041 }
duke@435 1042 }
duke@435 1043 }
duke@435 1044
duke@435 1045 // We mention two of several possible choices here:
duke@435 1046 // #0: if the reference object is not in the "originating generation"
duke@435 1047 // (or part of the heap being collected, indicated by our "span"
duke@435 1048 // we don't treat it specially (i.e. we scan it as we would
duke@435 1049 // a normal oop, treating its references as strong references).
duke@435 1050 // This means that references can't be enqueued unless their
duke@435 1051 // referent is also in the same span. This is the simplest,
duke@435 1052 // most "local" and most conservative approach, albeit one
duke@435 1053 // that may cause weak references to be enqueued least promptly.
duke@435 1054 // We call this choice the "ReferenceBasedDiscovery" policy.
duke@435 1055 // #1: the reference object may be in any generation (span), but if
duke@435 1056 // the referent is in the generation (span) being currently collected
duke@435 1057 // then we can discover the reference object, provided
duke@435 1058 // the object has not already been discovered by
duke@435 1059 // a different concurrently running collector (as may be the
duke@435 1060 // case, for instance, if the reference object is in CMS and
duke@435 1061 // the referent in DefNewGeneration), and provided the processing
duke@435 1062 // of this reference object by the current collector will
duke@435 1063 // appear atomic to every other collector in the system.
duke@435 1064 // (Thus, for instance, a concurrent collector may not
duke@435 1065 // discover references in other generations even if the
duke@435 1066 // referent is in its own generation). This policy may,
duke@435 1067 // in certain cases, enqueue references somewhat sooner than
duke@435 1068 // might Policy #0 above, but at marginally increased cost
duke@435 1069 // and complexity in processing these references.
duke@435 1070 // We call this choice the "RefeferentBasedDiscovery" policy.
duke@435 1071 bool ReferenceProcessor::discover_reference(oop obj, ReferenceType rt) {
duke@435 1072 // We enqueue references only if we are discovering refs
duke@435 1073 // (rather than processing discovered refs).
duke@435 1074 if (!_discovering_refs || !RegisterReferences) {
duke@435 1075 return false;
duke@435 1076 }
duke@435 1077 // We only enqueue active references.
coleenp@548 1078 oop next = java_lang_ref_Reference::next(obj);
coleenp@548 1079 if (next != NULL) {
duke@435 1080 return false;
duke@435 1081 }
duke@435 1082
duke@435 1083 HeapWord* obj_addr = (HeapWord*)obj;
duke@435 1084 if (RefDiscoveryPolicy == ReferenceBasedDiscovery &&
duke@435 1085 !_span.contains(obj_addr)) {
duke@435 1086 // Reference is not in the originating generation;
duke@435 1087 // don't treat it specially (i.e. we want to scan it as a normal
duke@435 1088 // object with strong references).
duke@435 1089 return false;
duke@435 1090 }
duke@435 1091
duke@435 1092 // We only enqueue references whose referents are not (yet) strongly
duke@435 1093 // reachable.
duke@435 1094 if (is_alive_non_header() != NULL) {
duke@435 1095 oop referent = java_lang_ref_Reference::referent(obj);
ysr@888 1096 // In the case of non-concurrent discovery, the last
ysr@888 1097 // disjunct below should hold. It may not hold in the
ysr@888 1098 // case of concurrent discovery because mutators may
ysr@888 1099 // concurrently clear() a Reference.
ysr@888 1100 assert(UseConcMarkSweepGC || UseG1GC || referent != NULL,
ysr@888 1101 "Refs with null referents already filtered");
duke@435 1102 if (is_alive_non_header()->do_object_b(referent)) {
duke@435 1103 return false; // referent is reachable
duke@435 1104 }
duke@435 1105 }
ysr@888 1106 if (rt == REF_SOFT) {
ysr@888 1107 // For soft refs we can decide now if these are not
ysr@888 1108 // current candidates for clearing, in which case we
ysr@888 1109 // can mark through them now, rather than delaying that
ysr@888 1110 // to the reference-processing phase. Since all current
ysr@888 1111 // time-stamp policies advance the soft-ref clock only
ysr@888 1112 // at a major collection cycle, this is always currently
ysr@888 1113 // accurate.
ysr@888 1114 if (!_current_soft_ref_policy->should_clear_reference(obj)) {
ysr@888 1115 return false;
ysr@888 1116 }
ysr@888 1117 }
duke@435 1118
ysr@777 1119 HeapWord* const discovered_addr = java_lang_ref_Reference::discovered_addr(obj);
ysr@777 1120 const oop discovered = java_lang_ref_Reference::discovered(obj);
coleenp@548 1121 assert(discovered->is_oop_or_null(), "bad discovered field");
coleenp@548 1122 if (discovered != NULL) {
duke@435 1123 // The reference has already been discovered...
duke@435 1124 if (TraceReferenceGC) {
duke@435 1125 gclog_or_tty->print_cr("Already enqueued reference (" INTPTR_FORMAT ": %s)",
coleenp@548 1126 obj, obj->blueprint()->internal_name());
duke@435 1127 }
duke@435 1128 if (RefDiscoveryPolicy == ReferentBasedDiscovery) {
duke@435 1129 // assumes that an object is not processed twice;
duke@435 1130 // if it's been already discovered it must be on another
duke@435 1131 // generation's discovered list; so we won't discover it.
duke@435 1132 return false;
duke@435 1133 } else {
duke@435 1134 assert(RefDiscoveryPolicy == ReferenceBasedDiscovery,
duke@435 1135 "Unrecognized policy");
duke@435 1136 // Check assumption that an object is not potentially
duke@435 1137 // discovered twice except by concurrent collectors that potentially
duke@435 1138 // trace the same Reference object twice.
duke@435 1139 assert(UseConcMarkSweepGC,
ysr@777 1140 "Only possible with an incremental-update concurrent collector");
duke@435 1141 return true;
duke@435 1142 }
duke@435 1143 }
duke@435 1144
duke@435 1145 if (RefDiscoveryPolicy == ReferentBasedDiscovery) {
duke@435 1146 oop referent = java_lang_ref_Reference::referent(obj);
duke@435 1147 assert(referent->is_oop(), "bad referent");
duke@435 1148 // enqueue if and only if either:
duke@435 1149 // reference is in our span or
duke@435 1150 // we are an atomic collector and referent is in our span
duke@435 1151 if (_span.contains(obj_addr) ||
duke@435 1152 (discovery_is_atomic() && _span.contains(referent))) {
duke@435 1153 // should_enqueue = true;
duke@435 1154 } else {
duke@435 1155 return false;
duke@435 1156 }
duke@435 1157 } else {
duke@435 1158 assert(RefDiscoveryPolicy == ReferenceBasedDiscovery &&
duke@435 1159 _span.contains(obj_addr), "code inconsistency");
duke@435 1160 }
duke@435 1161
duke@435 1162 // Get the right type of discovered queue head.
duke@435 1163 DiscoveredList* list = get_discovered_list(rt);
duke@435 1164 if (list == NULL) {
duke@435 1165 return false; // nothing special needs to be done
duke@435 1166 }
duke@435 1167
duke@435 1168 if (_discovery_is_mt) {
duke@435 1169 add_to_discovered_list_mt(*list, obj, discovered_addr);
duke@435 1170 } else {
ysr@777 1171 // If "_discovered_list_needs_barrier", we do write barriers when
ysr@777 1172 // updating the discovered reference list. Otherwise, we do a raw store
ysr@777 1173 // here: the field will be visited later when processing the discovered
ysr@777 1174 // references.
ysr@777 1175 oop current_head = list->head();
ysr@777 1176 // As in the case further above, since we are over-writing a NULL
ysr@777 1177 // pre-value, we can safely elide the pre-barrier here for the case of G1.
ysr@777 1178 assert(discovered == NULL, "control point invariant");
ysr@777 1179 if (_discovered_list_needs_barrier && !UseG1GC) { // safe to elide for G1
ysr@777 1180 _bs->write_ref_field_pre((oop*)discovered_addr, current_head);
ysr@777 1181 }
ysr@777 1182 oop_store_raw(discovered_addr, current_head);
ysr@777 1183 if (_discovered_list_needs_barrier) {
ysr@777 1184 _bs->write_ref_field((oop*)discovered_addr, current_head);
ysr@777 1185 }
duke@435 1186 list->set_head(obj);
ysr@887 1187 list->inc_length(1);
duke@435 1188 }
duke@435 1189
duke@435 1190 // In the MT discovery case, it is currently possible to see
duke@435 1191 // the following message multiple times if several threads
duke@435 1192 // discover a reference about the same time. Only one will
duke@435 1193 // however have actually added it to the disocvered queue.
duke@435 1194 // One could let add_to_discovered_list_mt() return an
duke@435 1195 // indication for success in queueing (by 1 thread) or
duke@435 1196 // failure (by all other threads), but I decided the extra
duke@435 1197 // code was not worth the effort for something that is
duke@435 1198 // only used for debugging support.
duke@435 1199 if (TraceReferenceGC) {
duke@435 1200 oop referent = java_lang_ref_Reference::referent(obj);
duke@435 1201 if (PrintGCDetails) {
duke@435 1202 gclog_or_tty->print_cr("Enqueued reference (" INTPTR_FORMAT ": %s)",
coleenp@548 1203 obj, obj->blueprint()->internal_name());
duke@435 1204 }
duke@435 1205 assert(referent->is_oop(), "Enqueued a bad referent");
duke@435 1206 }
duke@435 1207 assert(obj->is_oop(), "Enqueued a bad reference");
duke@435 1208 return true;
duke@435 1209 }
duke@435 1210
duke@435 1211 // Preclean the discovered references by removing those
duke@435 1212 // whose referents are alive, and by marking from those that
duke@435 1213 // are not active. These lists can be handled here
duke@435 1214 // in any order and, indeed, concurrently.
duke@435 1215 void ReferenceProcessor::preclean_discovered_references(
duke@435 1216 BoolObjectClosure* is_alive,
duke@435 1217 OopClosure* keep_alive,
duke@435 1218 VoidClosure* complete_gc,
duke@435 1219 YieldClosure* yield) {
duke@435 1220
duke@435 1221 NOT_PRODUCT(verify_ok_to_handle_reflists());
duke@435 1222
duke@435 1223 // Soft references
duke@435 1224 {
duke@435 1225 TraceTime tt("Preclean SoftReferences", PrintGCDetails && PrintReferenceGC,
duke@435 1226 false, gclog_or_tty);
duke@435 1227 for (int i = 0; i < _num_q; i++) {
ysr@887 1228 if (yield->should_return()) {
ysr@887 1229 return;
ysr@887 1230 }
duke@435 1231 preclean_discovered_reflist(_discoveredSoftRefs[i], is_alive,
duke@435 1232 keep_alive, complete_gc, yield);
duke@435 1233 }
duke@435 1234 }
duke@435 1235
duke@435 1236 // Weak references
duke@435 1237 {
duke@435 1238 TraceTime tt("Preclean WeakReferences", PrintGCDetails && PrintReferenceGC,
duke@435 1239 false, gclog_or_tty);
duke@435 1240 for (int i = 0; i < _num_q; i++) {
ysr@887 1241 if (yield->should_return()) {
ysr@887 1242 return;
ysr@887 1243 }
duke@435 1244 preclean_discovered_reflist(_discoveredWeakRefs[i], is_alive,
duke@435 1245 keep_alive, complete_gc, yield);
duke@435 1246 }
duke@435 1247 }
duke@435 1248
duke@435 1249 // Final references
duke@435 1250 {
duke@435 1251 TraceTime tt("Preclean FinalReferences", PrintGCDetails && PrintReferenceGC,
duke@435 1252 false, gclog_or_tty);
duke@435 1253 for (int i = 0; i < _num_q; i++) {
ysr@887 1254 if (yield->should_return()) {
ysr@887 1255 return;
ysr@887 1256 }
duke@435 1257 preclean_discovered_reflist(_discoveredFinalRefs[i], is_alive,
duke@435 1258 keep_alive, complete_gc, yield);
duke@435 1259 }
duke@435 1260 }
duke@435 1261
duke@435 1262 // Phantom references
duke@435 1263 {
duke@435 1264 TraceTime tt("Preclean PhantomReferences", PrintGCDetails && PrintReferenceGC,
duke@435 1265 false, gclog_or_tty);
duke@435 1266 for (int i = 0; i < _num_q; i++) {
ysr@887 1267 if (yield->should_return()) {
ysr@887 1268 return;
ysr@887 1269 }
duke@435 1270 preclean_discovered_reflist(_discoveredPhantomRefs[i], is_alive,
duke@435 1271 keep_alive, complete_gc, yield);
duke@435 1272 }
duke@435 1273 }
duke@435 1274 }
duke@435 1275
duke@435 1276 // Walk the given discovered ref list, and remove all reference objects
duke@435 1277 // whose referents are still alive, whose referents are NULL or which
ysr@887 1278 // are not active (have a non-NULL next field). NOTE: When we are
ysr@887 1279 // thus precleaning the ref lists (which happens single-threaded today),
ysr@887 1280 // we do not disable refs discovery to honour the correct semantics of
ysr@887 1281 // java.lang.Reference. As a result, we need to be careful below
ysr@887 1282 // that ref removal steps interleave safely with ref discovery steps
ysr@887 1283 // (in this thread).
coleenp@548 1284 void
coleenp@548 1285 ReferenceProcessor::preclean_discovered_reflist(DiscoveredList& refs_list,
coleenp@548 1286 BoolObjectClosure* is_alive,
coleenp@548 1287 OopClosure* keep_alive,
coleenp@548 1288 VoidClosure* complete_gc,
coleenp@548 1289 YieldClosure* yield) {
duke@435 1290 DiscoveredListIterator iter(refs_list, keep_alive, is_alive);
duke@435 1291 while (iter.has_next()) {
duke@435 1292 iter.load_ptrs(DEBUG_ONLY(true /* allow_null_referent */));
coleenp@548 1293 oop obj = iter.obj();
coleenp@548 1294 oop next = java_lang_ref_Reference::next(obj);
duke@435 1295 if (iter.referent() == NULL || iter.is_referent_alive() ||
coleenp@548 1296 next != NULL) {
duke@435 1297 // The referent has been cleared, or is alive, or the Reference is not
duke@435 1298 // active; we need to trace and mark its cohort.
duke@435 1299 if (TraceReferenceGC) {
duke@435 1300 gclog_or_tty->print_cr("Precleaning Reference (" INTPTR_FORMAT ": %s)",
duke@435 1301 iter.obj(), iter.obj()->blueprint()->internal_name());
duke@435 1302 }
duke@435 1303 // Remove Reference object from list
duke@435 1304 iter.remove();
duke@435 1305 // Keep alive its cohort.
duke@435 1306 iter.make_referent_alive();
coleenp@548 1307 if (UseCompressedOops) {
coleenp@548 1308 narrowOop* next_addr = (narrowOop*)java_lang_ref_Reference::next_addr(obj);
coleenp@548 1309 keep_alive->do_oop(next_addr);
coleenp@548 1310 } else {
coleenp@548 1311 oop* next_addr = (oop*)java_lang_ref_Reference::next_addr(obj);
coleenp@548 1312 keep_alive->do_oop(next_addr);
coleenp@548 1313 }
ysr@887 1314 iter.move_to_next();
duke@435 1315 } else {
duke@435 1316 iter.next();
duke@435 1317 }
duke@435 1318 }
duke@435 1319 // Close the reachable set
duke@435 1320 complete_gc->do_void();
duke@435 1321
duke@435 1322 NOT_PRODUCT(
duke@435 1323 if (PrintGCDetails && PrintReferenceGC) {
duke@435 1324 gclog_or_tty->print(" Dropped %d Refs out of %d "
duke@435 1325 "Refs in discovered list ", iter.removed(), iter.processed());
duke@435 1326 }
duke@435 1327 )
duke@435 1328 }
duke@435 1329
duke@435 1330 const char* ReferenceProcessor::list_name(int i) {
duke@435 1331 assert(i >= 0 && i <= _num_q * subclasses_of_ref, "Out of bounds index");
duke@435 1332 int j = i / _num_q;
duke@435 1333 switch (j) {
duke@435 1334 case 0: return "SoftRef";
duke@435 1335 case 1: return "WeakRef";
duke@435 1336 case 2: return "FinalRef";
duke@435 1337 case 3: return "PhantomRef";
duke@435 1338 }
duke@435 1339 ShouldNotReachHere();
duke@435 1340 return NULL;
duke@435 1341 }
duke@435 1342
duke@435 1343 #ifndef PRODUCT
duke@435 1344 void ReferenceProcessor::verify_ok_to_handle_reflists() {
duke@435 1345 // empty for now
duke@435 1346 }
duke@435 1347 #endif
duke@435 1348
duke@435 1349 void ReferenceProcessor::verify() {
coleenp@548 1350 guarantee(sentinel_ref() != NULL && sentinel_ref()->is_oop(), "Lost _sentinelRef");
duke@435 1351 }
duke@435 1352
duke@435 1353 #ifndef PRODUCT
duke@435 1354 void ReferenceProcessor::clear_discovered_references() {
duke@435 1355 guarantee(!_discovering_refs, "Discovering refs?");
duke@435 1356 for (int i = 0; i < _num_q * subclasses_of_ref; i++) {
duke@435 1357 oop obj = _discoveredSoftRefs[i].head();
coleenp@548 1358 while (obj != sentinel_ref()) {
duke@435 1359 oop next = java_lang_ref_Reference::discovered(obj);
duke@435 1360 java_lang_ref_Reference::set_discovered(obj, (oop) NULL);
duke@435 1361 obj = next;
duke@435 1362 }
coleenp@548 1363 _discoveredSoftRefs[i].set_head(sentinel_ref());
duke@435 1364 _discoveredSoftRefs[i].set_length(0);
duke@435 1365 }
duke@435 1366 }
duke@435 1367 #endif // PRODUCT

mercurial