src/share/vm/memory/referenceProcessor.cpp

Thu, 05 Jun 2008 15:57:56 -0700

author
ysr
date
Thu, 05 Jun 2008 15:57:56 -0700
changeset 777
37f87013dfd8
parent 548
ba764ed4b6f2
child 791
1ee8caae33af
permissions
-rw-r--r--

6711316: Open source the Garbage-First garbage collector
Summary: First mercurial integration of the code for the Garbage-First garbage collector.
Reviewed-by: apetrusenko, iveresov, jmasa, sgoldman, tonyp, ysr

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

mercurial