src/share/vm/memory/referenceProcessor.hpp

Tue, 24 Feb 2015 15:04:52 -0500

author
dlong
date
Tue, 24 Feb 2015 15:04:52 -0500
changeset 7598
ddce0b7cee93
parent 7476
c2844108a708
child 7535
7ae4e26cb1e0
permissions
-rw-r--r--

8072383: resolve conflicts between open and closed ports
Summary: refactor close to remove references to closed ports
Reviewed-by: kvn, simonis, sgehwolf, dholmes

duke@435 1 /*
sla@5237 2 * Copyright (c) 2001, 2013, Oracle and/or its affiliates. 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 *
trims@1907 19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
trims@1907 20 * or visit www.oracle.com if you need additional information or have any
trims@1907 21 * questions.
duke@435 22 *
duke@435 23 */
duke@435 24
stefank@2314 25 #ifndef SHARE_VM_MEMORY_REFERENCEPROCESSOR_HPP
stefank@2314 26 #define SHARE_VM_MEMORY_REFERENCEPROCESSOR_HPP
stefank@2314 27
brutisso@6904 28 #include "gc_implementation/shared/gcTrace.hpp"
stefank@2314 29 #include "memory/referencePolicy.hpp"
sla@5237 30 #include "memory/referenceProcessorStats.hpp"
sla@5237 31 #include "memory/referenceType.hpp"
stefank@2314 32 #include "oops/instanceRefKlass.hpp"
stefank@2314 33
sla@5237 34 class GCTimer;
sla@5237 35
duke@435 36 // ReferenceProcessor class encapsulates the per-"collector" processing
ysr@888 37 // of java.lang.Reference objects for GC. The interface is useful for supporting
duke@435 38 // a generational abstraction, in particular when there are multiple
duke@435 39 // generations that are being independently collected -- possibly
duke@435 40 // concurrently and/or incrementally. Note, however, that the
duke@435 41 // ReferenceProcessor class abstracts away from a generational setting
duke@435 42 // by using only a heap interval (called "span" below), thus allowing
duke@435 43 // its use in a straightforward manner in a general, non-generational
duke@435 44 // setting.
duke@435 45 //
duke@435 46 // The basic idea is that each ReferenceProcessor object concerns
duke@435 47 // itself with ("weak") reference processing in a specific "span"
duke@435 48 // of the heap of interest to a specific collector. Currently,
duke@435 49 // the span is a convex interval of the heap, but, efficiency
duke@435 50 // apart, there seems to be no reason it couldn't be extended
duke@435 51 // (with appropriate modifications) to any "non-convex interval".
duke@435 52
duke@435 53 // forward references
duke@435 54 class ReferencePolicy;
duke@435 55 class AbstractRefProcTaskExecutor;
johnc@3175 56
johnc@3175 57 // List of discovered references.
johnc@3175 58 class DiscoveredList {
johnc@3175 59 public:
johnc@3175 60 DiscoveredList() : _len(0), _compressed_head(0), _oop_head(NULL) { }
johnc@3175 61 oop head() const {
johnc@3175 62 return UseCompressedOops ? oopDesc::decode_heap_oop(_compressed_head) :
johnc@3175 63 _oop_head;
johnc@3175 64 }
johnc@3175 65 HeapWord* adr_head() {
johnc@3175 66 return UseCompressedOops ? (HeapWord*)&_compressed_head :
johnc@3175 67 (HeapWord*)&_oop_head;
johnc@3175 68 }
johnc@3175 69 void set_head(oop o) {
johnc@3175 70 if (UseCompressedOops) {
johnc@3175 71 // Must compress the head ptr.
johnc@3175 72 _compressed_head = oopDesc::encode_heap_oop(o);
johnc@3175 73 } else {
johnc@3175 74 _oop_head = o;
johnc@3175 75 }
johnc@3175 76 }
johnc@3175 77 bool is_empty() const { return head() == NULL; }
johnc@3175 78 size_t length() { return _len; }
johnc@3175 79 void set_length(size_t len) { _len = len; }
johnc@3175 80 void inc_length(size_t inc) { _len += inc; assert(_len > 0, "Error"); }
johnc@3175 81 void dec_length(size_t dec) { _len -= dec; }
johnc@3175 82 private:
johnc@3175 83 // Set value depending on UseCompressedOops. This could be a template class
johnc@3175 84 // but then we have to fix all the instantiations and declarations that use this class.
johnc@3175 85 oop _oop_head;
johnc@3175 86 narrowOop _compressed_head;
johnc@3175 87 size_t _len;
johnc@3175 88 };
johnc@3175 89
johnc@3175 90 // Iterator for the list of discovered references.
johnc@3175 91 class DiscoveredListIterator {
johnc@3175 92 private:
johnc@3175 93 DiscoveredList& _refs_list;
johnc@3175 94 HeapWord* _prev_next;
johnc@3175 95 oop _prev;
johnc@3175 96 oop _ref;
johnc@3175 97 HeapWord* _discovered_addr;
johnc@3175 98 oop _next;
johnc@3175 99 HeapWord* _referent_addr;
johnc@3175 100 oop _referent;
johnc@3175 101 OopClosure* _keep_alive;
johnc@3175 102 BoolObjectClosure* _is_alive;
johnc@3175 103
johnc@3175 104 DEBUG_ONLY(
johnc@3175 105 oop _first_seen; // cyclic linked list check
johnc@3175 106 )
johnc@3175 107
johnc@3175 108 NOT_PRODUCT(
johnc@3175 109 size_t _processed;
johnc@3175 110 size_t _removed;
johnc@3175 111 )
johnc@3175 112
johnc@3175 113 public:
johnc@3175 114 inline DiscoveredListIterator(DiscoveredList& refs_list,
johnc@3175 115 OopClosure* keep_alive,
brutisso@6719 116 BoolObjectClosure* is_alive):
johnc@3175 117 _refs_list(refs_list),
johnc@3175 118 _prev_next(refs_list.adr_head()),
johnc@3175 119 _prev(NULL),
johnc@3175 120 _ref(refs_list.head()),
johnc@3175 121 #ifdef ASSERT
johnc@3175 122 _first_seen(refs_list.head()),
johnc@3175 123 #endif
johnc@3175 124 #ifndef PRODUCT
johnc@3175 125 _processed(0),
johnc@3175 126 _removed(0),
johnc@3175 127 #endif
johnc@3175 128 _next(NULL),
johnc@3175 129 _keep_alive(keep_alive),
brutisso@6719 130 _is_alive(is_alive)
johnc@3175 131 { }
johnc@3175 132
johnc@3175 133 // End Of List.
johnc@3175 134 inline bool has_next() const { return _ref != NULL; }
johnc@3175 135
johnc@3175 136 // Get oop to the Reference object.
johnc@3175 137 inline oop obj() const { return _ref; }
johnc@3175 138
johnc@3175 139 // Get oop to the referent object.
johnc@3175 140 inline oop referent() const { return _referent; }
johnc@3175 141
johnc@3175 142 // Returns true if referent is alive.
johnc@3175 143 inline bool is_referent_alive() const {
johnc@3175 144 return _is_alive->do_object_b(_referent);
johnc@3175 145 }
johnc@3175 146
johnc@3175 147 // Loads data for the current reference.
johnc@3175 148 // The "allow_null_referent" argument tells us to allow for the possibility
johnc@3175 149 // of a NULL referent in the discovered Reference object. This typically
johnc@3175 150 // happens in the case of concurrent collectors that may have done the
johnc@3175 151 // discovery concurrently, or interleaved, with mutator execution.
johnc@3175 152 void load_ptrs(DEBUG_ONLY(bool allow_null_referent));
johnc@3175 153
johnc@3175 154 // Move to the next discovered reference.
johnc@3175 155 inline void next() {
johnc@3175 156 _prev_next = _discovered_addr;
johnc@3175 157 _prev = _ref;
johnc@3175 158 move_to_next();
johnc@3175 159 }
johnc@3175 160
johnc@3175 161 // Remove the current reference from the list
johnc@3175 162 void remove();
johnc@3175 163
johnc@3175 164 // Make the Reference object active again.
johnc@3175 165 void make_active();
johnc@3175 166
johnc@3175 167 // Make the referent alive.
johnc@3175 168 inline void make_referent_alive() {
johnc@3175 169 if (UseCompressedOops) {
johnc@3175 170 _keep_alive->do_oop((narrowOop*)_referent_addr);
johnc@3175 171 } else {
johnc@3175 172 _keep_alive->do_oop((oop*)_referent_addr);
johnc@3175 173 }
johnc@3175 174 }
johnc@3175 175
johnc@3175 176 // Update the discovered field.
johnc@3175 177 inline void update_discovered() {
johnc@3175 178 // First _prev_next ref actually points into DiscoveredList (gross).
johnc@3175 179 if (UseCompressedOops) {
johnc@3175 180 if (!oopDesc::is_null(*(narrowOop*)_prev_next)) {
johnc@3175 181 _keep_alive->do_oop((narrowOop*)_prev_next);
johnc@3175 182 }
johnc@3175 183 } else {
johnc@3175 184 if (!oopDesc::is_null(*(oop*)_prev_next)) {
johnc@3175 185 _keep_alive->do_oop((oop*)_prev_next);
johnc@3175 186 }
johnc@3175 187 }
johnc@3175 188 }
johnc@3175 189
johnc@3175 190 // NULL out referent pointer.
johnc@3175 191 void clear_referent();
johnc@3175 192
johnc@3175 193 // Statistics
johnc@3175 194 NOT_PRODUCT(
johnc@3175 195 inline size_t processed() const { return _processed; }
johnc@3175 196 inline size_t removed() const { return _removed; }
johnc@3175 197 )
johnc@3175 198
johnc@3175 199 inline void move_to_next() {
johnc@3175 200 if (_ref == _next) {
johnc@3175 201 // End of the list.
johnc@3175 202 _ref = NULL;
johnc@3175 203 } else {
johnc@3175 204 _ref = _next;
johnc@3175 205 }
johnc@3175 206 assert(_ref != _first_seen, "cyclic ref_list found");
johnc@3175 207 NOT_PRODUCT(_processed++);
johnc@3175 208 }
johnc@3175 209 };
duke@435 210
zgu@3900 211 class ReferenceProcessor : public CHeapObj<mtGC> {
sla@5237 212
sla@5237 213 private:
sla@5237 214 size_t total_count(DiscoveredList lists[]);
sla@5237 215
duke@435 216 protected:
ysr@3117 217 // Compatibility with pre-4965777 JDK's
ysr@3117 218 static bool _pending_list_uses_discovered_field;
johnc@3175 219
johnc@3188 220 // The SoftReference master timestamp clock
johnc@3188 221 static jlong _soft_ref_timestamp_clock;
johnc@3188 222
johnc@3175 223 MemRegion _span; // (right-open) interval of heap
johnc@3175 224 // subject to wkref discovery
johnc@3175 225
johnc@3175 226 bool _discovering_refs; // true when discovery enabled
johnc@3175 227 bool _discovery_is_atomic; // if discovery is atomic wrt
johnc@3175 228 // other collectors in configuration
johnc@3175 229 bool _discovery_is_mt; // true if reference discovery is MT.
johnc@3175 230
johnc@3175 231 bool _enqueuing_is_done; // true if all weak references enqueued
johnc@3175 232 bool _processing_is_mt; // true during phases when
johnc@3175 233 // reference processing is MT.
jmasa@3357 234 uint _next_id; // round-robin mod _num_q counter in
johnc@3175 235 // support of work distribution
johnc@3175 236
johnc@3175 237 // For collectors that do not keep GC liveness information
duke@435 238 // in the object header, this field holds a closure that
duke@435 239 // helps the reference processor determine the reachability
johnc@3175 240 // of an oop. It is currently initialized to NULL for all
johnc@3175 241 // collectors except for CMS and G1.
duke@435 242 BoolObjectClosure* _is_alive_non_header;
duke@435 243
ysr@888 244 // Soft ref clearing policies
ysr@888 245 // . the default policy
ysr@888 246 static ReferencePolicy* _default_soft_ref_policy;
ysr@888 247 // . the "clear all" policy
ysr@888 248 static ReferencePolicy* _always_clear_soft_ref_policy;
ysr@888 249 // . the current policy below is either one of the above
ysr@888 250 ReferencePolicy* _current_soft_ref_policy;
ysr@888 251
duke@435 252 // The discovered ref lists themselves
coleenp@548 253
jmasa@2188 254 // The active MT'ness degree of the queues below
jmasa@3357 255 uint _num_q;
jmasa@2188 256 // The maximum MT'ness degree of the queues below
jmasa@3357 257 uint _max_num_q;
johnc@3210 258
johnc@3210 259 // Master array of discovered oops
johnc@3210 260 DiscoveredList* _discovered_refs;
johnc@3210 261
johnc@3210 262 // Arrays of lists of oops, one per thread (pointers into master array above)
coleenp@548 263 DiscoveredList* _discoveredSoftRefs;
duke@435 264 DiscoveredList* _discoveredWeakRefs;
duke@435 265 DiscoveredList* _discoveredFinalRefs;
duke@435 266 DiscoveredList* _discoveredPhantomRefs;
jmasa@7469 267 DiscoveredList* _discoveredCleanerRefs;
duke@435 268
duke@435 269 public:
jmasa@7469 270 static int number_of_subclasses_of_ref() { return (REF_CLEANER - REF_OTHER); }
johnc@3175 271
jmasa@3357 272 uint num_q() { return _num_q; }
jmasa@3357 273 uint max_num_q() { return _max_num_q; }
jmasa@3357 274 void set_active_mt_degree(uint v) { _num_q = v; }
johnc@3210 275
johnc@3210 276 DiscoveredList* discovered_refs() { return _discovered_refs; }
johnc@3175 277
ysr@892 278 ReferencePolicy* setup_policy(bool always_clear) {
ysr@888 279 _current_soft_ref_policy = always_clear ?
ysr@888 280 _always_clear_soft_ref_policy : _default_soft_ref_policy;
ysr@892 281 _current_soft_ref_policy->setup(); // snapshot the policy threshold
ysr@888 282 return _current_soft_ref_policy;
ysr@888 283 }
duke@435 284
duke@435 285 // Process references with a certain reachability level.
sla@5237 286 size_t process_discovered_reflist(DiscoveredList refs_lists[],
sla@5237 287 ReferencePolicy* policy,
sla@5237 288 bool clear_referent,
sla@5237 289 BoolObjectClosure* is_alive,
sla@5237 290 OopClosure* keep_alive,
sla@5237 291 VoidClosure* complete_gc,
sla@5237 292 AbstractRefProcTaskExecutor* task_executor);
duke@435 293
duke@435 294 void process_phaseJNI(BoolObjectClosure* is_alive,
duke@435 295 OopClosure* keep_alive,
duke@435 296 VoidClosure* complete_gc);
duke@435 297
duke@435 298 // Work methods used by the method process_discovered_reflist
duke@435 299 // Phase1: keep alive all those referents that are otherwise
duke@435 300 // dead but which must be kept alive by policy (and their closure).
coleenp@548 301 void process_phase1(DiscoveredList& refs_list,
duke@435 302 ReferencePolicy* policy,
duke@435 303 BoolObjectClosure* is_alive,
duke@435 304 OopClosure* keep_alive,
duke@435 305 VoidClosure* complete_gc);
duke@435 306 // Phase2: remove all those references whose referents are
duke@435 307 // reachable.
coleenp@548 308 inline void process_phase2(DiscoveredList& refs_list,
duke@435 309 BoolObjectClosure* is_alive,
duke@435 310 OopClosure* keep_alive,
duke@435 311 VoidClosure* complete_gc) {
duke@435 312 if (discovery_is_atomic()) {
duke@435 313 // complete_gc is ignored in this case for this phase
coleenp@548 314 pp2_work(refs_list, is_alive, keep_alive);
duke@435 315 } else {
duke@435 316 assert(complete_gc != NULL, "Error");
coleenp@548 317 pp2_work_concurrent_discovery(refs_list, is_alive,
duke@435 318 keep_alive, complete_gc);
duke@435 319 }
duke@435 320 }
duke@435 321 // Work methods in support of process_phase2
coleenp@548 322 void pp2_work(DiscoveredList& refs_list,
duke@435 323 BoolObjectClosure* is_alive,
duke@435 324 OopClosure* keep_alive);
duke@435 325 void pp2_work_concurrent_discovery(
coleenp@548 326 DiscoveredList& refs_list,
duke@435 327 BoolObjectClosure* is_alive,
duke@435 328 OopClosure* keep_alive,
duke@435 329 VoidClosure* complete_gc);
duke@435 330 // Phase3: process the referents by either clearing them
duke@435 331 // or keeping them alive (and their closure)
coleenp@548 332 void process_phase3(DiscoveredList& refs_list,
duke@435 333 bool clear_referent,
duke@435 334 BoolObjectClosure* is_alive,
duke@435 335 OopClosure* keep_alive,
duke@435 336 VoidClosure* complete_gc);
duke@435 337
duke@435 338 // Enqueue references with a certain reachability level
coleenp@548 339 void enqueue_discovered_reflist(DiscoveredList& refs_list, HeapWord* pending_list_addr);
duke@435 340
duke@435 341 // "Preclean" all the discovered reference lists
duke@435 342 // by removing references with strongly reachable referents.
duke@435 343 // The first argument is a predicate on an oop that indicates
duke@435 344 // its (strong) reachability and the second is a closure that
duke@435 345 // may be used to incrementalize or abort the precleaning process.
duke@435 346 // The caller is responsible for taking care of potential
duke@435 347 // interference with concurrent operations on these lists
duke@435 348 // (or predicates involved) by other threads. Currently
coleenp@4037 349 // only used by the CMS collector.
duke@435 350 void preclean_discovered_references(BoolObjectClosure* is_alive,
duke@435 351 OopClosure* keep_alive,
duke@435 352 VoidClosure* complete_gc,
sla@5237 353 YieldClosure* yield,
brutisso@6904 354 GCTimer* gc_timer,
brutisso@6904 355 GCId gc_id);
duke@435 356
duke@435 357 // Delete entries in the discovered lists that have
duke@435 358 // either a null referent or are not active. Such
duke@435 359 // Reference objects can result from the clearing
duke@435 360 // or enqueueing of Reference objects concurrent
duke@435 361 // with their discovery by a (concurrent) collector.
duke@435 362 // For a definition of "active" see java.lang.ref.Reference;
duke@435 363 // Refs are born active, become inactive when enqueued,
duke@435 364 // and never become active again. The state of being
duke@435 365 // active is encoded as follows: A Ref is active
duke@435 366 // if and only if its "next" field is NULL.
duke@435 367 void clean_up_discovered_references();
duke@435 368 void clean_up_discovered_reflist(DiscoveredList& refs_list);
duke@435 369
duke@435 370 // Returns the name of the discovered reference list
duke@435 371 // occupying the i / _num_q slot.
jmasa@3357 372 const char* list_name(uint i);
duke@435 373
coleenp@548 374 void enqueue_discovered_reflists(HeapWord* pending_list_addr, AbstractRefProcTaskExecutor* task_executor);
coleenp@548 375
duke@435 376 protected:
duke@435 377 // "Preclean" the given discovered reference list
duke@435 378 // by removing references with strongly reachable referents.
duke@435 379 // Currently used in support of CMS only.
duke@435 380 void preclean_discovered_reflist(DiscoveredList& refs_list,
duke@435 381 BoolObjectClosure* is_alive,
duke@435 382 OopClosure* keep_alive,
duke@435 383 VoidClosure* complete_gc,
duke@435 384 YieldClosure* yield);
duke@435 385
ysr@2651 386 // round-robin mod _num_q (not: _not_ mode _max_num_q)
jmasa@3357 387 uint next_id() {
jmasa@3357 388 uint id = _next_id;
duke@435 389 if (++_next_id == _num_q) {
duke@435 390 _next_id = 0;
duke@435 391 }
duke@435 392 return id;
duke@435 393 }
duke@435 394 DiscoveredList* get_discovered_list(ReferenceType rt);
duke@435 395 inline void add_to_discovered_list_mt(DiscoveredList& refs_list, oop obj,
coleenp@548 396 HeapWord* discovered_addr);
duke@435 397 void verify_ok_to_handle_reflists() PRODUCT_RETURN;
duke@435 398
stefank@3115 399 void clear_discovered_references(DiscoveredList& refs_list);
duke@435 400 void abandon_partial_discovered_list(DiscoveredList& refs_list);
duke@435 401
duke@435 402 // Calculate the number of jni handles.
duke@435 403 unsigned int count_jni_refs();
duke@435 404
duke@435 405 // Balances reference queues.
duke@435 406 void balance_queues(DiscoveredList ref_lists[]);
duke@435 407
duke@435 408 // Update (advance) the soft ref master clock field.
duke@435 409 void update_soft_ref_master_clock();
duke@435 410
duke@435 411 public:
ysr@2651 412 // Default parameters give you a vanilla reference processor.
ysr@2651 413 ReferenceProcessor(MemRegion span,
jmasa@3357 414 bool mt_processing = false, uint mt_processing_degree = 1,
jmasa@3357 415 bool mt_discovery = false, uint mt_discovery_degree = 1,
ysr@2651 416 bool atomic_discovery = true,
brutisso@6719 417 BoolObjectClosure* is_alive_non_header = NULL);
duke@435 418
duke@435 419 // RefDiscoveryPolicy values
johnc@1679 420 enum DiscoveryPolicy {
duke@435 421 ReferenceBasedDiscovery = 0,
johnc@1679 422 ReferentBasedDiscovery = 1,
johnc@1679 423 DiscoveryPolicyMin = ReferenceBasedDiscovery,
johnc@1679 424 DiscoveryPolicyMax = ReferentBasedDiscovery
duke@435 425 };
duke@435 426
duke@435 427 static void init_statics();
duke@435 428
duke@435 429 public:
duke@435 430 // get and set "is_alive_non_header" field
duke@435 431 BoolObjectClosure* is_alive_non_header() {
duke@435 432 return _is_alive_non_header;
duke@435 433 }
duke@435 434 void set_is_alive_non_header(BoolObjectClosure* is_alive_non_header) {
duke@435 435 _is_alive_non_header = is_alive_non_header;
duke@435 436 }
duke@435 437
duke@435 438 // get and set span
duke@435 439 MemRegion span() { return _span; }
duke@435 440 void set_span(MemRegion span) { _span = span; }
duke@435 441
duke@435 442 // start and stop weak ref discovery
johnc@3188 443 void enable_discovery(bool verify_disabled, bool check_no_refs);
duke@435 444 void disable_discovery() { _discovering_refs = false; }
duke@435 445 bool discovery_enabled() { return _discovering_refs; }
duke@435 446
duke@435 447 // whether discovery is atomic wrt other collectors
duke@435 448 bool discovery_is_atomic() const { return _discovery_is_atomic; }
duke@435 449 void set_atomic_discovery(bool atomic) { _discovery_is_atomic = atomic; }
duke@435 450
ysr@3117 451 // whether the JDK in which we are embedded is a pre-4965777 JDK,
ysr@3117 452 // and thus whether or not it uses the discovered field to chain
ysr@3117 453 // the entries in the pending list.
ysr@3117 454 static bool pending_list_uses_discovered_field() {
ysr@3117 455 return _pending_list_uses_discovered_field;
ysr@3117 456 }
ysr@3117 457
duke@435 458 // whether discovery is done by multiple threads same-old-timeously
duke@435 459 bool discovery_is_mt() const { return _discovery_is_mt; }
duke@435 460 void set_mt_discovery(bool mt) { _discovery_is_mt = mt; }
duke@435 461
duke@435 462 // Whether we are in a phase when _processing_ is MT.
duke@435 463 bool processing_is_mt() const { return _processing_is_mt; }
duke@435 464 void set_mt_processing(bool mt) { _processing_is_mt = mt; }
duke@435 465
duke@435 466 // whether all enqueuing of weak references is complete
duke@435 467 bool enqueuing_is_done() { return _enqueuing_is_done; }
duke@435 468 void set_enqueuing_is_done(bool v) { _enqueuing_is_done = v; }
duke@435 469
duke@435 470 // iterate over oops
duke@435 471 void weak_oops_do(OopClosure* f); // weak roots
duke@435 472
jmasa@2188 473 // Balance each of the discovered lists.
jmasa@2188 474 void balance_all_queues();
coleenp@4037 475 void verify_list(DiscoveredList& ref_list);
jmasa@2188 476
duke@435 477 // Discover a Reference object, using appropriate discovery criteria
duke@435 478 bool discover_reference(oop obj, ReferenceType rt);
duke@435 479
duke@435 480 // Process references found during GC (called by the garbage collector)
sla@5237 481 ReferenceProcessorStats
sla@5237 482 process_discovered_references(BoolObjectClosure* is_alive,
sla@5237 483 OopClosure* keep_alive,
sla@5237 484 VoidClosure* complete_gc,
sla@5237 485 AbstractRefProcTaskExecutor* task_executor,
brutisso@6904 486 GCTimer *gc_timer,
brutisso@6904 487 GCId gc_id);
duke@435 488
duke@435 489 // Enqueue references at end of GC (called by the garbage collector)
duke@435 490 bool enqueue_discovered_references(AbstractRefProcTaskExecutor* task_executor = NULL);
duke@435 491
ysr@777 492 // If a discovery is in process that is being superceded, abandon it: all
ysr@777 493 // the discovered lists will be empty, and all the objects on them will
ysr@777 494 // have NULL discovered fields. Must be called only at a safepoint.
ysr@777 495 void abandon_partial_discovery();
ysr@777 496
duke@435 497 // debugging
duke@435 498 void verify_no_references_recorded() PRODUCT_RETURN;
ysr@2337 499 void verify_referent(oop obj) PRODUCT_RETURN;
duke@435 500
duke@435 501 // clear the discovered lists (unlinking each entry).
duke@435 502 void clear_discovered_references() PRODUCT_RETURN;
duke@435 503 };
duke@435 504
duke@435 505 // A utility class to disable reference discovery in
duke@435 506 // the scope which contains it, for given ReferenceProcessor.
duke@435 507 class NoRefDiscovery: StackObj {
duke@435 508 private:
duke@435 509 ReferenceProcessor* _rp;
duke@435 510 bool _was_discovering_refs;
duke@435 511 public:
duke@435 512 NoRefDiscovery(ReferenceProcessor* rp) : _rp(rp) {
twisti@2144 513 _was_discovering_refs = _rp->discovery_enabled();
twisti@2144 514 if (_was_discovering_refs) {
duke@435 515 _rp->disable_discovery();
duke@435 516 }
duke@435 517 }
duke@435 518
duke@435 519 ~NoRefDiscovery() {
duke@435 520 if (_was_discovering_refs) {
johnc@3175 521 _rp->enable_discovery(true /*verify_disabled*/, false /*check_no_refs*/);
duke@435 522 }
duke@435 523 }
duke@435 524 };
duke@435 525
duke@435 526
duke@435 527 // A utility class to temporarily mutate the span of the
duke@435 528 // given ReferenceProcessor in the scope that contains it.
duke@435 529 class ReferenceProcessorSpanMutator: StackObj {
duke@435 530 private:
duke@435 531 ReferenceProcessor* _rp;
duke@435 532 MemRegion _saved_span;
duke@435 533
duke@435 534 public:
duke@435 535 ReferenceProcessorSpanMutator(ReferenceProcessor* rp,
duke@435 536 MemRegion span):
duke@435 537 _rp(rp) {
duke@435 538 _saved_span = _rp->span();
duke@435 539 _rp->set_span(span);
duke@435 540 }
duke@435 541
duke@435 542 ~ReferenceProcessorSpanMutator() {
duke@435 543 _rp->set_span(_saved_span);
duke@435 544 }
duke@435 545 };
duke@435 546
duke@435 547 // A utility class to temporarily change the MT'ness of
duke@435 548 // reference discovery for the given ReferenceProcessor
duke@435 549 // in the scope that contains it.
ysr@2651 550 class ReferenceProcessorMTDiscoveryMutator: StackObj {
duke@435 551 private:
duke@435 552 ReferenceProcessor* _rp;
duke@435 553 bool _saved_mt;
duke@435 554
duke@435 555 public:
ysr@2651 556 ReferenceProcessorMTDiscoveryMutator(ReferenceProcessor* rp,
ysr@2651 557 bool mt):
duke@435 558 _rp(rp) {
duke@435 559 _saved_mt = _rp->discovery_is_mt();
duke@435 560 _rp->set_mt_discovery(mt);
duke@435 561 }
duke@435 562
ysr@2651 563 ~ReferenceProcessorMTDiscoveryMutator() {
duke@435 564 _rp->set_mt_discovery(_saved_mt);
duke@435 565 }
duke@435 566 };
duke@435 567
duke@435 568
duke@435 569 // A utility class to temporarily change the disposition
duke@435 570 // of the "is_alive_non_header" closure field of the
duke@435 571 // given ReferenceProcessor in the scope that contains it.
duke@435 572 class ReferenceProcessorIsAliveMutator: StackObj {
duke@435 573 private:
duke@435 574 ReferenceProcessor* _rp;
duke@435 575 BoolObjectClosure* _saved_cl;
duke@435 576
duke@435 577 public:
duke@435 578 ReferenceProcessorIsAliveMutator(ReferenceProcessor* rp,
duke@435 579 BoolObjectClosure* cl):
duke@435 580 _rp(rp) {
duke@435 581 _saved_cl = _rp->is_alive_non_header();
duke@435 582 _rp->set_is_alive_non_header(cl);
duke@435 583 }
duke@435 584
duke@435 585 ~ReferenceProcessorIsAliveMutator() {
duke@435 586 _rp->set_is_alive_non_header(_saved_cl);
duke@435 587 }
duke@435 588 };
duke@435 589
duke@435 590 // A utility class to temporarily change the disposition
duke@435 591 // of the "discovery_is_atomic" field of the
duke@435 592 // given ReferenceProcessor in the scope that contains it.
duke@435 593 class ReferenceProcessorAtomicMutator: StackObj {
duke@435 594 private:
duke@435 595 ReferenceProcessor* _rp;
duke@435 596 bool _saved_atomic_discovery;
duke@435 597
duke@435 598 public:
duke@435 599 ReferenceProcessorAtomicMutator(ReferenceProcessor* rp,
duke@435 600 bool atomic):
duke@435 601 _rp(rp) {
duke@435 602 _saved_atomic_discovery = _rp->discovery_is_atomic();
duke@435 603 _rp->set_atomic_discovery(atomic);
duke@435 604 }
duke@435 605
duke@435 606 ~ReferenceProcessorAtomicMutator() {
duke@435 607 _rp->set_atomic_discovery(_saved_atomic_discovery);
duke@435 608 }
duke@435 609 };
duke@435 610
duke@435 611
duke@435 612 // A utility class to temporarily change the MT processing
duke@435 613 // disposition of the given ReferenceProcessor instance
duke@435 614 // in the scope that contains it.
duke@435 615 class ReferenceProcessorMTProcMutator: StackObj {
duke@435 616 private:
duke@435 617 ReferenceProcessor* _rp;
duke@435 618 bool _saved_mt;
duke@435 619
duke@435 620 public:
duke@435 621 ReferenceProcessorMTProcMutator(ReferenceProcessor* rp,
duke@435 622 bool mt):
duke@435 623 _rp(rp) {
duke@435 624 _saved_mt = _rp->processing_is_mt();
duke@435 625 _rp->set_mt_processing(mt);
duke@435 626 }
duke@435 627
duke@435 628 ~ReferenceProcessorMTProcMutator() {
duke@435 629 _rp->set_mt_processing(_saved_mt);
duke@435 630 }
duke@435 631 };
duke@435 632
duke@435 633
duke@435 634 // This class is an interface used to implement task execution for the
duke@435 635 // reference processing.
duke@435 636 class AbstractRefProcTaskExecutor {
duke@435 637 public:
duke@435 638
duke@435 639 // Abstract tasks to execute.
duke@435 640 class ProcessTask;
duke@435 641 class EnqueueTask;
duke@435 642
duke@435 643 // Executes a task using worker threads.
duke@435 644 virtual void execute(ProcessTask& task) = 0;
duke@435 645 virtual void execute(EnqueueTask& task) = 0;
duke@435 646
duke@435 647 // Switch to single threaded mode.
duke@435 648 virtual void set_single_threaded_mode() { };
duke@435 649 };
duke@435 650
duke@435 651 // Abstract reference processing task to execute.
duke@435 652 class AbstractRefProcTaskExecutor::ProcessTask {
duke@435 653 protected:
duke@435 654 ProcessTask(ReferenceProcessor& ref_processor,
duke@435 655 DiscoveredList refs_lists[],
duke@435 656 bool marks_oops_alive)
duke@435 657 : _ref_processor(ref_processor),
duke@435 658 _refs_lists(refs_lists),
duke@435 659 _marks_oops_alive(marks_oops_alive)
duke@435 660 { }
duke@435 661
duke@435 662 public:
duke@435 663 virtual void work(unsigned int work_id, BoolObjectClosure& is_alive,
duke@435 664 OopClosure& keep_alive,
duke@435 665 VoidClosure& complete_gc) = 0;
duke@435 666
duke@435 667 // Returns true if a task marks some oops as alive.
duke@435 668 bool marks_oops_alive() const
duke@435 669 { return _marks_oops_alive; }
duke@435 670
duke@435 671 protected:
duke@435 672 ReferenceProcessor& _ref_processor;
duke@435 673 DiscoveredList* _refs_lists;
duke@435 674 const bool _marks_oops_alive;
duke@435 675 };
duke@435 676
duke@435 677 // Abstract reference processing task to execute.
duke@435 678 class AbstractRefProcTaskExecutor::EnqueueTask {
duke@435 679 protected:
duke@435 680 EnqueueTask(ReferenceProcessor& ref_processor,
duke@435 681 DiscoveredList refs_lists[],
coleenp@548 682 HeapWord* pending_list_addr,
duke@435 683 int n_queues)
duke@435 684 : _ref_processor(ref_processor),
duke@435 685 _refs_lists(refs_lists),
duke@435 686 _pending_list_addr(pending_list_addr),
duke@435 687 _n_queues(n_queues)
duke@435 688 { }
duke@435 689
duke@435 690 public:
duke@435 691 virtual void work(unsigned int work_id) = 0;
duke@435 692
duke@435 693 protected:
duke@435 694 ReferenceProcessor& _ref_processor;
duke@435 695 DiscoveredList* _refs_lists;
coleenp@548 696 HeapWord* _pending_list_addr;
duke@435 697 int _n_queues;
duke@435 698 };
stefank@2314 699
stefank@2314 700 #endif // SHARE_VM_MEMORY_REFERENCEPROCESSOR_HPP

mercurial