Print this page
Split |
Close |
Expand all |
Collapse all |
--- old/src/share/vm/memory/referenceProcessor.hpp
+++ new/src/share/vm/memory/referenceProcessor.hpp
1 1 /*
2 2 * Copyright (c) 2001, 2011, Oracle and/or its affiliates. All rights reserved.
3 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 4 *
5 5 * This code is free software; you can redistribute it and/or modify it
6 6 * under the terms of the GNU General Public License version 2 only, as
7 7 * published by the Free Software Foundation.
8 8 *
9 9 * This code is distributed in the hope that it will be useful, but WITHOUT
10 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
12 12 * version 2 for more details (a copy is included in the LICENSE file that
13 13 * accompanied this code).
14 14 *
15 15 * You should have received a copy of the GNU General Public License version
16 16 * 2 along with this work; if not, write to the Free Software Foundation,
17 17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18 18 *
19 19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20 20 * or visit www.oracle.com if you need additional information or have any
21 21 * questions.
22 22 *
23 23 */
24 24
25 25 #ifndef SHARE_VM_MEMORY_REFERENCEPROCESSOR_HPP
26 26 #define SHARE_VM_MEMORY_REFERENCEPROCESSOR_HPP
27 27
28 28 #include "memory/referencePolicy.hpp"
29 29 #include "oops/instanceRefKlass.hpp"
30 30
31 31 // ReferenceProcessor class encapsulates the per-"collector" processing
32 32 // of java.lang.Reference objects for GC. The interface is useful for supporting
33 33 // a generational abstraction, in particular when there are multiple
34 34 // generations that are being independently collected -- possibly
35 35 // concurrently and/or incrementally. Note, however, that the
36 36 // ReferenceProcessor class abstracts away from a generational setting
37 37 // by using only a heap interval (called "span" below), thus allowing
38 38 // its use in a straightforward manner in a general, non-generational
39 39 // setting.
40 40 //
41 41 // The basic idea is that each ReferenceProcessor object concerns
42 42 // itself with ("weak") reference processing in a specific "span"
43 43 // of the heap of interest to a specific collector. Currently,
44 44 // the span is a convex interval of the heap, but, efficiency
↓ open down ↓ |
44 lines elided |
↑ open up ↑ |
45 45 // apart, there seems to be no reason it couldn't be extended
46 46 // (with appropriate modifications) to any "non-convex interval".
47 47
48 48 // forward references
49 49 class ReferencePolicy;
50 50 class AbstractRefProcTaskExecutor;
51 51 class DiscoveredList;
52 52
53 53 class ReferenceProcessor : public CHeapObj {
54 54 protected:
55 + // Compatibility with pre-4965777 JDK's
56 + static bool _pending_list_uses_discovered_field;
55 57 MemRegion _span; // (right-open) interval of heap
56 58 // subject to wkref discovery
57 59 bool _discovering_refs; // true when discovery enabled
58 60 bool _discovery_is_atomic; // if discovery is atomic wrt
59 61 // other collectors in configuration
60 62 bool _discovery_is_mt; // true if reference discovery is MT.
61 63 // If true, setting "next" field of a discovered refs list requires
62 64 // write barrier(s). (Must be true if used in a collector in which
63 65 // elements of a discovered list may be moved during discovery: for
64 66 // example, a collector like Garbage-First that moves objects during a
65 67 // long-term concurrent marking phase that does weak reference
66 68 // discovery.)
67 69 bool _discovered_list_needs_barrier;
68 70 BarrierSet* _bs; // Cached copy of BarrierSet.
69 71 bool _enqueuing_is_done; // true if all weak references enqueued
70 72 bool _processing_is_mt; // true during phases when
71 73 // reference processing is MT.
72 74 int _next_id; // round-robin mod _num_q counter in
73 75 // support of work distribution
74 76
75 77 // For collectors that do not keep GC marking information
76 78 // in the object header, this field holds a closure that
77 79 // helps the reference processor determine the reachability
78 80 // of an oop (the field is currently initialized to NULL for
79 81 // all collectors but the CMS collector).
80 82 BoolObjectClosure* _is_alive_non_header;
81 83
82 84 // Soft ref clearing policies
83 85 // . the default policy
84 86 static ReferencePolicy* _default_soft_ref_policy;
85 87 // . the "clear all" policy
86 88 static ReferencePolicy* _always_clear_soft_ref_policy;
87 89 // . the current policy below is either one of the above
88 90 ReferencePolicy* _current_soft_ref_policy;
89 91
90 92 // The discovered ref lists themselves
91 93
92 94 // The active MT'ness degree of the queues below
93 95 int _num_q;
94 96 // The maximum MT'ness degree of the queues below
95 97 int _max_num_q;
96 98 // Arrays of lists of oops, one per thread
97 99 DiscoveredList* _discoveredSoftRefs;
98 100 DiscoveredList* _discoveredWeakRefs;
99 101 DiscoveredList* _discoveredFinalRefs;
100 102 DiscoveredList* _discoveredPhantomRefs;
101 103
102 104 public:
103 105 int num_q() { return _num_q; }
↓ open down ↓ |
39 lines elided |
↑ open up ↑ |
104 106 int max_num_q() { return _max_num_q; }
105 107 void set_active_mt_degree(int v) { _num_q = v; }
106 108 DiscoveredList* discovered_soft_refs() { return _discoveredSoftRefs; }
107 109 ReferencePolicy* setup_policy(bool always_clear) {
108 110 _current_soft_ref_policy = always_clear ?
109 111 _always_clear_soft_ref_policy : _default_soft_ref_policy;
110 112 _current_soft_ref_policy->setup(); // snapshot the policy threshold
111 113 return _current_soft_ref_policy;
112 114 }
113 115
114 - public:
115 116 // Process references with a certain reachability level.
116 117 void process_discovered_reflist(DiscoveredList refs_lists[],
117 118 ReferencePolicy* policy,
118 119 bool clear_referent,
119 120 BoolObjectClosure* is_alive,
120 121 OopClosure* keep_alive,
121 122 VoidClosure* complete_gc,
122 123 AbstractRefProcTaskExecutor* task_executor);
123 124
124 125 void process_phaseJNI(BoolObjectClosure* is_alive,
125 126 OopClosure* keep_alive,
126 127 VoidClosure* complete_gc);
127 128
128 129 // Work methods used by the method process_discovered_reflist
129 130 // Phase1: keep alive all those referents that are otherwise
130 131 // dead but which must be kept alive by policy (and their closure).
131 132 void process_phase1(DiscoveredList& refs_list,
132 133 ReferencePolicy* policy,
133 134 BoolObjectClosure* is_alive,
134 135 OopClosure* keep_alive,
135 136 VoidClosure* complete_gc);
136 137 // Phase2: remove all those references whose referents are
137 138 // reachable.
138 139 inline void process_phase2(DiscoveredList& refs_list,
139 140 BoolObjectClosure* is_alive,
140 141 OopClosure* keep_alive,
141 142 VoidClosure* complete_gc) {
142 143 if (discovery_is_atomic()) {
143 144 // complete_gc is ignored in this case for this phase
144 145 pp2_work(refs_list, is_alive, keep_alive);
145 146 } else {
146 147 assert(complete_gc != NULL, "Error");
147 148 pp2_work_concurrent_discovery(refs_list, is_alive,
148 149 keep_alive, complete_gc);
149 150 }
150 151 }
151 152 // Work methods in support of process_phase2
152 153 void pp2_work(DiscoveredList& refs_list,
153 154 BoolObjectClosure* is_alive,
154 155 OopClosure* keep_alive);
155 156 void pp2_work_concurrent_discovery(
156 157 DiscoveredList& refs_list,
157 158 BoolObjectClosure* is_alive,
158 159 OopClosure* keep_alive,
159 160 VoidClosure* complete_gc);
160 161 // Phase3: process the referents by either clearing them
161 162 // or keeping them alive (and their closure)
162 163 void process_phase3(DiscoveredList& refs_list,
163 164 bool clear_referent,
164 165 BoolObjectClosure* is_alive,
165 166 OopClosure* keep_alive,
166 167 VoidClosure* complete_gc);
167 168
168 169 // Enqueue references with a certain reachability level
169 170 void enqueue_discovered_reflist(DiscoveredList& refs_list, HeapWord* pending_list_addr);
170 171
171 172 // "Preclean" all the discovered reference lists
172 173 // by removing references with strongly reachable referents.
173 174 // The first argument is a predicate on an oop that indicates
174 175 // its (strong) reachability and the second is a closure that
175 176 // may be used to incrementalize or abort the precleaning process.
176 177 // The caller is responsible for taking care of potential
177 178 // interference with concurrent operations on these lists
178 179 // (or predicates involved) by other threads. Currently
179 180 // only used by the CMS collector. should_unload_classes is
180 181 // used to aid assertion checking when classes are collected.
181 182 void preclean_discovered_references(BoolObjectClosure* is_alive,
182 183 OopClosure* keep_alive,
183 184 VoidClosure* complete_gc,
184 185 YieldClosure* yield,
185 186 bool should_unload_classes);
186 187
187 188 // Delete entries in the discovered lists that have
188 189 // either a null referent or are not active. Such
189 190 // Reference objects can result from the clearing
190 191 // or enqueueing of Reference objects concurrent
191 192 // with their discovery by a (concurrent) collector.
192 193 // For a definition of "active" see java.lang.ref.Reference;
193 194 // Refs are born active, become inactive when enqueued,
194 195 // and never become active again. The state of being
195 196 // active is encoded as follows: A Ref is active
196 197 // if and only if its "next" field is NULL.
197 198 void clean_up_discovered_references();
198 199 void clean_up_discovered_reflist(DiscoveredList& refs_list);
199 200
200 201 // Returns the name of the discovered reference list
201 202 // occupying the i / _num_q slot.
202 203 const char* list_name(int i);
203 204
204 205 void enqueue_discovered_reflists(HeapWord* pending_list_addr, AbstractRefProcTaskExecutor* task_executor);
205 206
206 207 protected:
207 208 // "Preclean" the given discovered reference list
208 209 // by removing references with strongly reachable referents.
209 210 // Currently used in support of CMS only.
210 211 void preclean_discovered_reflist(DiscoveredList& refs_list,
211 212 BoolObjectClosure* is_alive,
212 213 OopClosure* keep_alive,
213 214 VoidClosure* complete_gc,
214 215 YieldClosure* yield);
215 216
216 217 // round-robin mod _num_q (not: _not_ mode _max_num_q)
217 218 int next_id() {
218 219 int id = _next_id;
219 220 if (++_next_id == _num_q) {
220 221 _next_id = 0;
221 222 }
222 223 return id;
223 224 }
224 225 DiscoveredList* get_discovered_list(ReferenceType rt);
225 226 inline void add_to_discovered_list_mt(DiscoveredList& refs_list, oop obj,
226 227 HeapWord* discovered_addr);
227 228 void verify_ok_to_handle_reflists() PRODUCT_RETURN;
228 229
229 230 void clear_discovered_references(DiscoveredList& refs_list);
230 231 void abandon_partial_discovered_list(DiscoveredList& refs_list);
231 232
232 233 // Calculate the number of jni handles.
233 234 unsigned int count_jni_refs();
234 235
235 236 // Balances reference queues.
236 237 void balance_queues(DiscoveredList ref_lists[]);
237 238
238 239 // Update (advance) the soft ref master clock field.
239 240 void update_soft_ref_master_clock();
240 241
241 242 public:
242 243 // constructor
243 244 ReferenceProcessor():
244 245 _span((HeapWord*)NULL, (HeapWord*)NULL),
245 246 _discoveredSoftRefs(NULL), _discoveredWeakRefs(NULL),
246 247 _discoveredFinalRefs(NULL), _discoveredPhantomRefs(NULL),
247 248 _discovering_refs(false),
248 249 _discovery_is_atomic(true),
249 250 _enqueuing_is_done(false),
250 251 _discovery_is_mt(false),
251 252 _discovered_list_needs_barrier(false),
252 253 _bs(NULL),
253 254 _is_alive_non_header(NULL),
254 255 _num_q(0),
255 256 _max_num_q(0),
256 257 _processing_is_mt(false),
257 258 _next_id(0)
258 259 { }
259 260
260 261 // Default parameters give you a vanilla reference processor.
261 262 ReferenceProcessor(MemRegion span,
262 263 bool mt_processing = false, int mt_processing_degree = 1,
263 264 bool mt_discovery = false, int mt_discovery_degree = 1,
264 265 bool atomic_discovery = true,
265 266 BoolObjectClosure* is_alive_non_header = NULL,
266 267 bool discovered_list_needs_barrier = false);
267 268
268 269 // RefDiscoveryPolicy values
269 270 enum DiscoveryPolicy {
270 271 ReferenceBasedDiscovery = 0,
271 272 ReferentBasedDiscovery = 1,
272 273 DiscoveryPolicyMin = ReferenceBasedDiscovery,
273 274 DiscoveryPolicyMax = ReferentBasedDiscovery
274 275 };
275 276
276 277 static void init_statics();
277 278
278 279 public:
279 280 // get and set "is_alive_non_header" field
280 281 BoolObjectClosure* is_alive_non_header() {
281 282 return _is_alive_non_header;
282 283 }
283 284 void set_is_alive_non_header(BoolObjectClosure* is_alive_non_header) {
284 285 _is_alive_non_header = is_alive_non_header;
285 286 }
286 287
287 288 // get and set span
288 289 MemRegion span() { return _span; }
289 290 void set_span(MemRegion span) { _span = span; }
↓ open down ↓ |
165 lines elided |
↑ open up ↑ |
290 291
291 292 // start and stop weak ref discovery
292 293 void enable_discovery() { _discovering_refs = true; }
293 294 void disable_discovery() { _discovering_refs = false; }
294 295 bool discovery_enabled() { return _discovering_refs; }
295 296
296 297 // whether discovery is atomic wrt other collectors
297 298 bool discovery_is_atomic() const { return _discovery_is_atomic; }
298 299 void set_atomic_discovery(bool atomic) { _discovery_is_atomic = atomic; }
299 300
301 + // whether the JDK in which we are embedded is a pre-4965777 JDK,
302 + // and thus whether ir not it uses the discovered field to chain
303 + // the entries in the pending list.
304 + static bool pending_list_uses_discovered_field() {
305 + return _pending_list_uses_discovered_field;
306 + }
307 +
300 308 // whether discovery is done by multiple threads same-old-timeously
301 309 bool discovery_is_mt() const { return _discovery_is_mt; }
302 310 void set_mt_discovery(bool mt) { _discovery_is_mt = mt; }
303 311
304 312 // Whether we are in a phase when _processing_ is MT.
305 313 bool processing_is_mt() const { return _processing_is_mt; }
306 314 void set_mt_processing(bool mt) { _processing_is_mt = mt; }
307 315
308 316 // whether all enqueuing of weak references is complete
309 317 bool enqueuing_is_done() { return _enqueuing_is_done; }
310 318 void set_enqueuing_is_done(bool v) { _enqueuing_is_done = v; }
311 319
312 320 // iterate over oops
313 321 void weak_oops_do(OopClosure* f); // weak roots
314 322
315 323 // Balance each of the discovered lists.
316 324 void balance_all_queues();
317 325
318 326 // Discover a Reference object, using appropriate discovery criteria
319 327 bool discover_reference(oop obj, ReferenceType rt);
320 328
321 329 // Process references found during GC (called by the garbage collector)
322 330 void process_discovered_references(BoolObjectClosure* is_alive,
323 331 OopClosure* keep_alive,
324 332 VoidClosure* complete_gc,
325 333 AbstractRefProcTaskExecutor* task_executor);
326 334
327 335 public:
328 336 // Enqueue references at end of GC (called by the garbage collector)
329 337 bool enqueue_discovered_references(AbstractRefProcTaskExecutor* task_executor = NULL);
330 338
331 339 // If a discovery is in process that is being superceded, abandon it: all
332 340 // the discovered lists will be empty, and all the objects on them will
333 341 // have NULL discovered fields. Must be called only at a safepoint.
334 342 void abandon_partial_discovery();
335 343
336 344 // debugging
337 345 void verify_no_references_recorded() PRODUCT_RETURN;
338 346 void verify_referent(oop obj) PRODUCT_RETURN;
339 347
340 348 // clear the discovered lists (unlinking each entry).
341 349 void clear_discovered_references() PRODUCT_RETURN;
342 350 };
343 351
344 352 // A utility class to disable reference discovery in
345 353 // the scope which contains it, for given ReferenceProcessor.
346 354 class NoRefDiscovery: StackObj {
347 355 private:
348 356 ReferenceProcessor* _rp;
349 357 bool _was_discovering_refs;
350 358 public:
351 359 NoRefDiscovery(ReferenceProcessor* rp) : _rp(rp) {
352 360 _was_discovering_refs = _rp->discovery_enabled();
353 361 if (_was_discovering_refs) {
354 362 _rp->disable_discovery();
355 363 }
356 364 }
357 365
358 366 ~NoRefDiscovery() {
359 367 if (_was_discovering_refs) {
360 368 _rp->enable_discovery();
361 369 }
362 370 }
363 371 };
364 372
365 373
366 374 // A utility class to temporarily mutate the span of the
367 375 // given ReferenceProcessor in the scope that contains it.
368 376 class ReferenceProcessorSpanMutator: StackObj {
369 377 private:
370 378 ReferenceProcessor* _rp;
371 379 MemRegion _saved_span;
372 380
373 381 public:
374 382 ReferenceProcessorSpanMutator(ReferenceProcessor* rp,
375 383 MemRegion span):
376 384 _rp(rp) {
377 385 _saved_span = _rp->span();
378 386 _rp->set_span(span);
379 387 }
380 388
381 389 ~ReferenceProcessorSpanMutator() {
382 390 _rp->set_span(_saved_span);
383 391 }
384 392 };
385 393
386 394 // A utility class to temporarily change the MT'ness of
387 395 // reference discovery for the given ReferenceProcessor
388 396 // in the scope that contains it.
389 397 class ReferenceProcessorMTDiscoveryMutator: StackObj {
390 398 private:
391 399 ReferenceProcessor* _rp;
392 400 bool _saved_mt;
393 401
394 402 public:
395 403 ReferenceProcessorMTDiscoveryMutator(ReferenceProcessor* rp,
396 404 bool mt):
397 405 _rp(rp) {
398 406 _saved_mt = _rp->discovery_is_mt();
399 407 _rp->set_mt_discovery(mt);
400 408 }
401 409
402 410 ~ReferenceProcessorMTDiscoveryMutator() {
403 411 _rp->set_mt_discovery(_saved_mt);
404 412 }
405 413 };
406 414
407 415
408 416 // A utility class to temporarily change the disposition
409 417 // of the "is_alive_non_header" closure field of the
410 418 // given ReferenceProcessor in the scope that contains it.
411 419 class ReferenceProcessorIsAliveMutator: StackObj {
412 420 private:
413 421 ReferenceProcessor* _rp;
414 422 BoolObjectClosure* _saved_cl;
415 423
416 424 public:
417 425 ReferenceProcessorIsAliveMutator(ReferenceProcessor* rp,
418 426 BoolObjectClosure* cl):
419 427 _rp(rp) {
420 428 _saved_cl = _rp->is_alive_non_header();
421 429 _rp->set_is_alive_non_header(cl);
422 430 }
423 431
424 432 ~ReferenceProcessorIsAliveMutator() {
425 433 _rp->set_is_alive_non_header(_saved_cl);
426 434 }
427 435 };
428 436
429 437 // A utility class to temporarily change the disposition
430 438 // of the "discovery_is_atomic" field of the
431 439 // given ReferenceProcessor in the scope that contains it.
432 440 class ReferenceProcessorAtomicMutator: StackObj {
433 441 private:
434 442 ReferenceProcessor* _rp;
435 443 bool _saved_atomic_discovery;
436 444
437 445 public:
438 446 ReferenceProcessorAtomicMutator(ReferenceProcessor* rp,
439 447 bool atomic):
440 448 _rp(rp) {
441 449 _saved_atomic_discovery = _rp->discovery_is_atomic();
442 450 _rp->set_atomic_discovery(atomic);
443 451 }
444 452
445 453 ~ReferenceProcessorAtomicMutator() {
446 454 _rp->set_atomic_discovery(_saved_atomic_discovery);
447 455 }
448 456 };
449 457
450 458
451 459 // A utility class to temporarily change the MT processing
452 460 // disposition of the given ReferenceProcessor instance
453 461 // in the scope that contains it.
454 462 class ReferenceProcessorMTProcMutator: StackObj {
455 463 private:
456 464 ReferenceProcessor* _rp;
457 465 bool _saved_mt;
458 466
459 467 public:
460 468 ReferenceProcessorMTProcMutator(ReferenceProcessor* rp,
461 469 bool mt):
462 470 _rp(rp) {
463 471 _saved_mt = _rp->processing_is_mt();
464 472 _rp->set_mt_processing(mt);
465 473 }
466 474
467 475 ~ReferenceProcessorMTProcMutator() {
468 476 _rp->set_mt_processing(_saved_mt);
469 477 }
470 478 };
471 479
472 480
473 481 // This class is an interface used to implement task execution for the
474 482 // reference processing.
475 483 class AbstractRefProcTaskExecutor {
476 484 public:
477 485
478 486 // Abstract tasks to execute.
479 487 class ProcessTask;
480 488 class EnqueueTask;
481 489
482 490 // Executes a task using worker threads.
483 491 virtual void execute(ProcessTask& task) = 0;
484 492 virtual void execute(EnqueueTask& task) = 0;
485 493
486 494 // Switch to single threaded mode.
487 495 virtual void set_single_threaded_mode() { };
488 496 };
489 497
490 498 // Abstract reference processing task to execute.
491 499 class AbstractRefProcTaskExecutor::ProcessTask {
492 500 protected:
493 501 ProcessTask(ReferenceProcessor& ref_processor,
494 502 DiscoveredList refs_lists[],
495 503 bool marks_oops_alive)
496 504 : _ref_processor(ref_processor),
497 505 _refs_lists(refs_lists),
498 506 _marks_oops_alive(marks_oops_alive)
499 507 { }
500 508
501 509 public:
502 510 virtual void work(unsigned int work_id, BoolObjectClosure& is_alive,
503 511 OopClosure& keep_alive,
504 512 VoidClosure& complete_gc) = 0;
505 513
506 514 // Returns true if a task marks some oops as alive.
507 515 bool marks_oops_alive() const
508 516 { return _marks_oops_alive; }
509 517
510 518 protected:
511 519 ReferenceProcessor& _ref_processor;
512 520 DiscoveredList* _refs_lists;
513 521 const bool _marks_oops_alive;
514 522 };
515 523
516 524 // Abstract reference processing task to execute.
517 525 class AbstractRefProcTaskExecutor::EnqueueTask {
518 526 protected:
519 527 EnqueueTask(ReferenceProcessor& ref_processor,
520 528 DiscoveredList refs_lists[],
521 529 HeapWord* pending_list_addr,
522 530 int n_queues)
523 531 : _ref_processor(ref_processor),
524 532 _refs_lists(refs_lists),
525 533 _pending_list_addr(pending_list_addr),
526 534 _n_queues(n_queues)
527 535 { }
528 536
529 537 public:
530 538 virtual void work(unsigned int work_id) = 0;
531 539
532 540 protected:
533 541 ReferenceProcessor& _ref_processor;
534 542 DiscoveredList* _refs_lists;
535 543 HeapWord* _pending_list_addr;
536 544 int _n_queues;
537 545 };
538 546
539 547 #endif // SHARE_VM_MEMORY_REFERENCEPROCESSOR_HPP
↓ open down ↓ |
230 lines elided |
↑ open up ↑ |
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX