1 /* 2 * Copyright (c) 2001, 2017, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. 8 * 9 * This code is distributed in the hope that it will be useful, but WITHOUT 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 12 * version 2 for more details (a copy is included in the LICENSE file that 13 * accompanied this code). 14 * 15 * You should have received a copy of the GNU General Public License version 16 * 2 along with this work; if not, write to the Free Software Foundation, 17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 18 * 19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 20 * or visit www.oracle.com if you need additional information or have any 21 * questions. 22 * 23 */ 24 25 #ifndef SHARE_VM_GC_SHARED_COLLECTEDHEAP_HPP 26 #define SHARE_VM_GC_SHARED_COLLECTEDHEAP_HPP 27 28 #include "gc/shared/gcCause.hpp" 29 #include "gc/shared/gcWhen.hpp" 30 #include "memory/allocation.hpp" 31 #include "runtime/handles.hpp" 32 #include "runtime/perfData.hpp" 33 #include "runtime/safepoint.hpp" 34 #include "utilities/debug.hpp" 35 #include "utilities/events.hpp" 36 #include "utilities/formatBuffer.hpp" 37 38 // A "CollectedHeap" is an implementation of a java heap for HotSpot. This 39 // is an abstract class: there may be many different kinds of heaps. This 40 // class defines the functions that a heap must implement, and contains 41 // infrastructure common to all heaps. 42 43 class AdaptiveSizePolicy; 44 class BarrierSet; 45 class CollectorPolicy; 46 class GCHeapSummary; 47 class GCTimer; 48 class GCTracer; 49 class MetaspaceSummary; 50 class Thread; 51 class ThreadClosure; 52 class VirtualSpaceSummary; 53 class WorkGang; 54 class nmethod; 55 56 class GCMessage : public FormatBuffer<1024> { 57 public: 58 bool is_before; 59 60 public: 61 GCMessage() {} 62 }; 63 64 class CollectedHeap; 65 66 class GCHeapLog : public EventLogBase<GCMessage> { 67 private: 68 void log_heap(CollectedHeap* heap, bool before); 69 70 public: 71 GCHeapLog() : EventLogBase<GCMessage>("GC Heap History") {} 72 73 void log_heap_before(CollectedHeap* heap) { 74 log_heap(heap, true); 75 } 76 void log_heap_after(CollectedHeap* heap) { 77 log_heap(heap, false); 78 } 79 }; 80 81 // 82 // CollectedHeap 83 // GenCollectedHeap 84 // G1CollectedHeap 85 // ParallelScavengeHeap 86 // CMSHeap 87 // 88 class CollectedHeap : public CHeapObj<mtInternal> { 89 friend class VMStructs; 90 friend class JVMCIVMStructs; 91 friend class IsGCActiveMark; // Block structured external access to _is_gc_active 92 93 private: 94 #ifdef ASSERT 95 static int _fire_out_of_memory_count; 96 #endif 97 98 GCHeapLog* _gc_heap_log; 99 100 // Used in support of ReduceInitialCardMarks; only consulted if COMPILER2 101 // or INCLUDE_JVMCI is being used 102 bool _defer_initial_card_mark; 103 104 MemRegion _reserved; 105 106 protected: 107 BarrierSet* _barrier_set; 108 bool _is_gc_active; 109 110 // Used for filler objects (static, but initialized in ctor). 111 static size_t _filler_array_max_size; 112 113 unsigned int _total_collections; // ... started 114 unsigned int _total_full_collections; // ... started 115 NOT_PRODUCT(volatile size_t _promotion_failure_alot_count;) 116 NOT_PRODUCT(volatile size_t _promotion_failure_alot_gc_number;) 117 118 // Reason for current garbage collection. Should be set to 119 // a value reflecting no collection between collections. 120 GCCause::Cause _gc_cause; 121 GCCause::Cause _gc_lastcause; 122 PerfStringVariable* _perf_gc_cause; 123 PerfStringVariable* _perf_gc_lastcause; 124 125 // Constructor 126 CollectedHeap(); 127 128 // Do common initializations that must follow instance construction, 129 // for example, those needing virtual calls. 130 // This code could perhaps be moved into initialize() but would 131 // be slightly more awkward because we want the latter to be a 132 // pure virtual. 133 void pre_initialize(); 134 135 // Create a new tlab. All TLAB allocations must go through this. 136 virtual HeapWord* allocate_new_tlab(size_t size); 137 138 // Accumulate statistics on all tlabs. 139 virtual void accumulate_statistics_all_tlabs(); 140 141 // Reinitialize tlabs before resuming mutators. 142 virtual void resize_all_tlabs(); 143 144 // Allocate from the current thread's TLAB, with broken-out slow path. 145 inline static HeapWord* allocate_from_tlab(Klass* klass, Thread* thread, size_t size); 146 static HeapWord* allocate_from_tlab_slow(Klass* klass, Thread* thread, size_t size); 147 148 // Sample the allocation via HeapMonitoring. 149 // overflowed_words represents the number of HeapWords that went passed the 150 // sampling boundary. This is used to fix the next sampling rate. 151 static void sample_allocation(Thread* thread, HeapWord* obj, size_t size, 152 size_t overflowed_words = 0); 153 // Try to allocate the object we want to sample in this tlab, returns NULL if 154 // fails to allocate. 155 static HeapWord* allocate_sampled_object(Thread* thread, size_t size); 156 157 // Allocate an uninitialized block of the given size, or returns NULL if 158 // this is impossible. 159 inline static HeapWord* common_mem_allocate_noinit(Klass* klass, size_t size, TRAPS); 160 161 // Like allocate_init, but the block returned by a successful allocation 162 // is guaranteed initialized to zeros. 163 inline static HeapWord* common_mem_allocate_init(Klass* klass, size_t size, TRAPS); 164 165 // Helper functions for (VM) allocation. 166 inline static void post_allocation_setup_common(Klass* klass, HeapWord* obj); 167 inline static void post_allocation_setup_no_klass_install(Klass* klass, 168 HeapWord* objPtr); 169 170 inline static void post_allocation_setup_obj(Klass* klass, HeapWord* obj, int size); 171 172 inline static void post_allocation_setup_array(Klass* klass, 173 HeapWord* obj, int length); 174 175 inline static void post_allocation_setup_class(Klass* klass, HeapWord* obj, int size); 176 177 // Clears an allocated object. 178 inline static void init_obj(HeapWord* obj, size_t size); 179 180 // Filler object utilities. 181 static inline size_t filler_array_hdr_size(); 182 static inline size_t filler_array_min_size(); 183 184 DEBUG_ONLY(static void fill_args_check(HeapWord* start, size_t words);) 185 DEBUG_ONLY(static void zap_filler_array(HeapWord* start, size_t words, bool zap = true);) 186 187 // Fill with a single array; caller must ensure filler_array_min_size() <= 188 // words <= filler_array_max_size(). 189 static inline void fill_with_array(HeapWord* start, size_t words, bool zap = true); 190 191 // Fill with a single object (either an int array or a java.lang.Object). 192 static inline void fill_with_object_impl(HeapWord* start, size_t words, bool zap = true); 193 194 virtual void trace_heap(GCWhen::Type when, const GCTracer* tracer); 195 196 // Verification functions 197 virtual void check_for_bad_heap_word_value(HeapWord* addr, size_t size) 198 PRODUCT_RETURN; 199 virtual void check_for_non_bad_heap_word_value(HeapWord* addr, size_t size) 200 PRODUCT_RETURN; 201 debug_only(static void check_for_valid_allocation_state();) 202 203 public: 204 enum Name { 205 GenCollectedHeap, 206 ParallelScavengeHeap, 207 G1CollectedHeap, 208 CMSHeap 209 }; 210 211 static inline size_t filler_array_max_size() { 212 return _filler_array_max_size; 213 } 214 215 virtual Name kind() const = 0; 216 217 virtual const char* name() const = 0; 218 219 /** 220 * Returns JNI error code JNI_ENOMEM if memory could not be allocated, 221 * and JNI_OK on success. 222 */ 223 virtual jint initialize() = 0; 224 225 // In many heaps, there will be a need to perform some initialization activities 226 // after the Universe is fully formed, but before general heap allocation is allowed. 227 // This is the correct place to place such initialization methods. 228 virtual void post_initialize() = 0; 229 230 // Stop any onging concurrent work and prepare for exit. 231 virtual void stop() {} 232 233 // Stop and resume concurrent GC threads interfering with safepoint operations 234 virtual void safepoint_synchronize_begin() {} 235 virtual void safepoint_synchronize_end() {} 236 237 void initialize_reserved_region(HeapWord *start, HeapWord *end); 238 MemRegion reserved_region() const { return _reserved; } 239 address base() const { return (address)reserved_region().start(); } 240 241 virtual size_t capacity() const = 0; 242 virtual size_t used() const = 0; 243 244 // Return "true" if the part of the heap that allocates Java 245 // objects has reached the maximal committed limit that it can 246 // reach, without a garbage collection. 247 virtual bool is_maximal_no_gc() const = 0; 248 249 // Support for java.lang.Runtime.maxMemory(): return the maximum amount of 250 // memory that the vm could make available for storing 'normal' java objects. 251 // This is based on the reserved address space, but should not include space 252 // that the vm uses internally for bookkeeping or temporary storage 253 // (e.g., in the case of the young gen, one of the survivor 254 // spaces). 255 virtual size_t max_capacity() const = 0; 256 257 // Returns "TRUE" if "p" points into the reserved area of the heap. 258 bool is_in_reserved(const void* p) const { 259 return _reserved.contains(p); 260 } 261 262 bool is_in_reserved_or_null(const void* p) const { 263 return p == NULL || is_in_reserved(p); 264 } 265 266 // Returns "TRUE" iff "p" points into the committed areas of the heap. 267 // This method can be expensive so avoid using it in performance critical 268 // code. 269 virtual bool is_in(const void* p) const = 0; 270 271 DEBUG_ONLY(bool is_in_or_null(const void* p) const { return p == NULL || is_in(p); }) 272 273 // Let's define some terms: a "closed" subset of a heap is one that 274 // 275 // 1) contains all currently-allocated objects, and 276 // 277 // 2) is closed under reference: no object in the closed subset 278 // references one outside the closed subset. 279 // 280 // Membership in a heap's closed subset is useful for assertions. 281 // Clearly, the entire heap is a closed subset, so the default 282 // implementation is to use "is_in_reserved". But this may not be too 283 // liberal to perform useful checking. Also, the "is_in" predicate 284 // defines a closed subset, but may be too expensive, since "is_in" 285 // verifies that its argument points to an object head. The 286 // "closed_subset" method allows a heap to define an intermediate 287 // predicate, allowing more precise checking than "is_in_reserved" at 288 // lower cost than "is_in." 289 290 // One important case is a heap composed of disjoint contiguous spaces, 291 // such as the Garbage-First collector. Such heaps have a convenient 292 // closed subset consisting of the allocated portions of those 293 // contiguous spaces. 294 295 // Return "TRUE" iff the given pointer points into the heap's defined 296 // closed subset (which defaults to the entire heap). 297 virtual bool is_in_closed_subset(const void* p) const { 298 return is_in_reserved(p); 299 } 300 301 bool is_in_closed_subset_or_null(const void* p) const { 302 return p == NULL || is_in_closed_subset(p); 303 } 304 305 void set_gc_cause(GCCause::Cause v) { 306 if (UsePerfData) { 307 _gc_lastcause = _gc_cause; 308 _perf_gc_lastcause->set_value(GCCause::to_string(_gc_lastcause)); 309 _perf_gc_cause->set_value(GCCause::to_string(v)); 310 } 311 _gc_cause = v; 312 } 313 GCCause::Cause gc_cause() { return _gc_cause; } 314 315 // General obj/array allocation facilities. 316 inline static oop obj_allocate(Klass* klass, int size, TRAPS); 317 inline static oop array_allocate(Klass* klass, int size, int length, TRAPS); 318 inline static oop array_allocate_nozero(Klass* klass, int size, int length, TRAPS); 319 inline static oop class_allocate(Klass* klass, int size, TRAPS); 320 321 // Raw memory allocation facilities 322 // The obj and array allocate methods are covers for these methods. 323 // mem_allocate() should never be 324 // called to allocate TLABs, only individual objects. 325 virtual HeapWord* mem_allocate(size_t size, 326 bool* gc_overhead_limit_was_exceeded) = 0; 327 328 // Utilities for turning raw memory into filler objects. 329 // 330 // min_fill_size() is the smallest region that can be filled. 331 // fill_with_objects() can fill arbitrary-sized regions of the heap using 332 // multiple objects. fill_with_object() is for regions known to be smaller 333 // than the largest array of integers; it uses a single object to fill the 334 // region and has slightly less overhead. 335 static size_t min_fill_size() { 336 return size_t(align_object_size(oopDesc::header_size())); 337 } 338 339 static void fill_with_objects(HeapWord* start, size_t words, bool zap = true); 340 341 static void fill_with_object(HeapWord* start, size_t words, bool zap = true); 342 static void fill_with_object(MemRegion region, bool zap = true) { 343 fill_with_object(region.start(), region.word_size(), zap); 344 } 345 static void fill_with_object(HeapWord* start, HeapWord* end, bool zap = true) { 346 fill_with_object(start, pointer_delta(end, start), zap); 347 } 348 349 // Return the address "addr" aligned by "alignment_in_bytes" if such 350 // an address is below "end". Return NULL otherwise. 351 inline static HeapWord* align_allocation_or_fail(HeapWord* addr, 352 HeapWord* end, 353 unsigned short alignment_in_bytes); 354 355 // Some heaps may offer a contiguous region for shared non-blocking 356 // allocation, via inlined code (by exporting the address of the top and 357 // end fields defining the extent of the contiguous allocation region.) 358 359 // This function returns "true" iff the heap supports this kind of 360 // allocation. (Default is "no".) 361 virtual bool supports_inline_contig_alloc() const { 362 return false; 363 } 364 // These functions return the addresses of the fields that define the 365 // boundaries of the contiguous allocation area. (These fields should be 366 // physically near to one another.) 367 virtual HeapWord* volatile* top_addr() const { 368 guarantee(false, "inline contiguous allocation not supported"); 369 return NULL; 370 } 371 virtual HeapWord** end_addr() const { 372 guarantee(false, "inline contiguous allocation not supported"); 373 return NULL; 374 } 375 376 // Some heaps may be in an unparseable state at certain times between 377 // collections. This may be necessary for efficient implementation of 378 // certain allocation-related activities. Calling this function before 379 // attempting to parse a heap ensures that the heap is in a parsable 380 // state (provided other concurrent activity does not introduce 381 // unparsability). It is normally expected, therefore, that this 382 // method is invoked with the world stopped. 383 // NOTE: if you override this method, make sure you call 384 // super::ensure_parsability so that the non-generational 385 // part of the work gets done. See implementation of 386 // CollectedHeap::ensure_parsability and, for instance, 387 // that of GenCollectedHeap::ensure_parsability(). 388 // The argument "retire_tlabs" controls whether existing TLABs 389 // are merely filled or also retired, thus preventing further 390 // allocation from them and necessitating allocation of new TLABs. 391 virtual void ensure_parsability(bool retire_tlabs); 392 393 // Section on thread-local allocation buffers (TLABs) 394 // If the heap supports thread-local allocation buffers, it should override 395 // the following methods: 396 // Returns "true" iff the heap supports thread-local allocation buffers. 397 // The default is "no". 398 virtual bool supports_tlab_allocation() const = 0; 399 400 // The amount of space available for thread-local allocation buffers. 401 virtual size_t tlab_capacity(Thread *thr) const = 0; 402 403 // The amount of used space for thread-local allocation buffers for the given thread. 404 virtual size_t tlab_used(Thread *thr) const = 0; 405 406 virtual size_t max_tlab_size() const; 407 408 // An estimate of the maximum allocation that could be performed 409 // for thread-local allocation buffers without triggering any 410 // collection or expansion activity. 411 virtual size_t unsafe_max_tlab_alloc(Thread *thr) const { 412 guarantee(false, "thread-local allocation buffers not supported"); 413 return 0; 414 } 415 416 // Can a compiler initialize a new object without store barriers? 417 // This permission only extends from the creation of a new object 418 // via a TLAB up to the first subsequent safepoint. If such permission 419 // is granted for this heap type, the compiler promises to call 420 // defer_store_barrier() below on any slow path allocation of 421 // a new object for which such initializing store barriers will 422 // have been elided. 423 virtual bool can_elide_tlab_store_barriers() const = 0; 424 425 // If a compiler is eliding store barriers for TLAB-allocated objects, 426 // there is probably a corresponding slow path which can produce 427 // an object allocated anywhere. The compiler's runtime support 428 // promises to call this function on such a slow-path-allocated 429 // object before performing initializations that have elided 430 // store barriers. Returns new_obj, or maybe a safer copy thereof. 431 virtual oop new_store_pre_barrier(JavaThread* thread, oop new_obj); 432 433 // Answers whether an initializing store to a new object currently 434 // allocated at the given address doesn't need a store 435 // barrier. Returns "true" if it doesn't need an initializing 436 // store barrier; answers "false" if it does. 437 virtual bool can_elide_initializing_store_barrier(oop new_obj) = 0; 438 439 // If a compiler is eliding store barriers for TLAB-allocated objects, 440 // we will be informed of a slow-path allocation by a call 441 // to new_store_pre_barrier() above. Such a call precedes the 442 // initialization of the object itself, and no post-store-barriers will 443 // be issued. Some heap types require that the barrier strictly follows 444 // the initializing stores. (This is currently implemented by deferring the 445 // barrier until the next slow-path allocation or gc-related safepoint.) 446 // This interface answers whether a particular heap type needs the card 447 // mark to be thus strictly sequenced after the stores. 448 virtual bool card_mark_must_follow_store() const = 0; 449 450 // If the CollectedHeap was asked to defer a store barrier above, 451 // this informs it to flush such a deferred store barrier to the 452 // remembered set. 453 virtual void flush_deferred_store_barrier(JavaThread* thread); 454 455 // Perform a collection of the heap; intended for use in implementing 456 // "System.gc". This probably implies as full a collection as the 457 // "CollectedHeap" supports. 458 virtual void collect(GCCause::Cause cause) = 0; 459 460 // Perform a full collection 461 virtual void do_full_collection(bool clear_all_soft_refs) = 0; 462 463 // This interface assumes that it's being called by the 464 // vm thread. It collects the heap assuming that the 465 // heap lock is already held and that we are executing in 466 // the context of the vm thread. 467 virtual void collect_as_vm_thread(GCCause::Cause cause); 468 469 // Returns the barrier set for this heap 470 BarrierSet* barrier_set() { return _barrier_set; } 471 void set_barrier_set(BarrierSet* barrier_set); 472 473 // Returns "true" iff there is a stop-world GC in progress. (I assume 474 // that it should answer "false" for the concurrent part of a concurrent 475 // collector -- dld). 476 bool is_gc_active() const { return _is_gc_active; } 477 478 // Total number of GC collections (started) 479 unsigned int total_collections() const { return _total_collections; } 480 unsigned int total_full_collections() const { return _total_full_collections;} 481 482 // Increment total number of GC collections (started) 483 // Should be protected but used by PSMarkSweep - cleanup for 1.4.2 484 void increment_total_collections(bool full = false) { 485 _total_collections++; 486 if (full) { 487 increment_total_full_collections(); 488 } 489 } 490 491 void increment_total_full_collections() { _total_full_collections++; } 492 493 // Return the CollectorPolicy for the heap 494 virtual CollectorPolicy* collector_policy() const = 0; 495 496 // Iterate over all objects, calling "cl.do_object" on each. 497 virtual void object_iterate(ObjectClosure* cl) = 0; 498 499 // Similar to object_iterate() except iterates only 500 // over live objects. 501 virtual void safe_object_iterate(ObjectClosure* cl) = 0; 502 503 // NOTE! There is no requirement that a collector implement these 504 // functions. 505 // 506 // A CollectedHeap is divided into a dense sequence of "blocks"; that is, 507 // each address in the (reserved) heap is a member of exactly 508 // one block. The defining characteristic of a block is that it is 509 // possible to find its size, and thus to progress forward to the next 510 // block. (Blocks may be of different sizes.) Thus, blocks may 511 // represent Java objects, or they might be free blocks in a 512 // free-list-based heap (or subheap), as long as the two kinds are 513 // distinguishable and the size of each is determinable. 514 515 // Returns the address of the start of the "block" that contains the 516 // address "addr". We say "blocks" instead of "object" since some heaps 517 // may not pack objects densely; a chunk may either be an object or a 518 // non-object. 519 virtual HeapWord* block_start(const void* addr) const = 0; 520 521 // Requires "addr" to be the start of a chunk, and returns its size. 522 // "addr + size" is required to be the start of a new chunk, or the end 523 // of the active area of the heap. 524 virtual size_t block_size(const HeapWord* addr) const = 0; 525 526 // Requires "addr" to be the start of a block, and returns "TRUE" iff 527 // the block is an object. 528 virtual bool block_is_obj(const HeapWord* addr) const = 0; 529 530 // Returns the longest time (in ms) that has elapsed since the last 531 // time that any part of the heap was examined by a garbage collection. 532 virtual jlong millis_since_last_gc() = 0; 533 534 // Perform any cleanup actions necessary before allowing a verification. 535 virtual void prepare_for_verify() = 0; 536 537 // Generate any dumps preceding or following a full gc 538 private: 539 void full_gc_dump(GCTimer* timer, bool before); 540 public: 541 void pre_full_gc_dump(GCTimer* timer); 542 void post_full_gc_dump(GCTimer* timer); 543 544 VirtualSpaceSummary create_heap_space_summary(); 545 GCHeapSummary create_heap_summary(); 546 547 MetaspaceSummary create_metaspace_summary(); 548 549 // Print heap information on the given outputStream. 550 virtual void print_on(outputStream* st) const = 0; 551 // The default behavior is to call print_on() on tty. 552 virtual void print() const { 553 print_on(tty); 554 } 555 // Print more detailed heap information on the given 556 // outputStream. The default behavior is to call print_on(). It is 557 // up to each subclass to override it and add any additional output 558 // it needs. 559 virtual void print_extended_on(outputStream* st) const { 560 print_on(st); 561 } 562 563 virtual void print_on_error(outputStream* st) const; 564 565 // Print all GC threads (other than the VM thread) 566 // used by this heap. 567 virtual void print_gc_threads_on(outputStream* st) const = 0; 568 // The default behavior is to call print_gc_threads_on() on tty. 569 void print_gc_threads() { 570 print_gc_threads_on(tty); 571 } 572 // Iterator for all GC threads (other than VM thread) 573 virtual void gc_threads_do(ThreadClosure* tc) const = 0; 574 575 // Print any relevant tracing info that flags imply. 576 // Default implementation does nothing. 577 virtual void print_tracing_info() const = 0; 578 579 void print_heap_before_gc(); 580 void print_heap_after_gc(); 581 582 // An object is scavengable if its location may move during a scavenge. 583 // (A scavenge is a GC which is not a full GC.) 584 virtual bool is_scavengable(oop obj) = 0; 585 // Registering and unregistering an nmethod (compiled code) with the heap. 586 // Override with specific mechanism for each specialized heap type. 587 virtual void register_nmethod(nmethod* nm) {} 588 virtual void unregister_nmethod(nmethod* nm) {} 589 virtual void verify_nmethod(nmethod* nmethod) {} 590 591 void trace_heap_before_gc(const GCTracer* gc_tracer); 592 void trace_heap_after_gc(const GCTracer* gc_tracer); 593 594 // Heap verification 595 virtual void verify(VerifyOption option) = 0; 596 597 // Return true if concurrent phase control (via 598 // request_concurrent_phase_control) is supported by this collector. 599 // The default implementation returns false. 600 virtual bool supports_concurrent_phase_control() const; 601 602 // Return a NULL terminated array of concurrent phase names provided 603 // by this collector. Supports Whitebox testing. These are the 604 // names recognized by request_concurrent_phase(). The default 605 // implementation returns an array of one NULL element. 606 virtual const char* const* concurrent_phases() const; 607 608 // Request the collector enter the indicated concurrent phase, and 609 // wait until it does so. Supports WhiteBox testing. Only one 610 // request may be active at a time. Phases are designated by name; 611 // the set of names and their meaning is GC-specific. Once the 612 // requested phase has been reached, the collector will attempt to 613 // avoid transitioning to a new phase until a new request is made. 614 // [Note: A collector might not be able to remain in a given phase. 615 // For example, a full collection might cancel an in-progress 616 // concurrent collection.] 617 // 618 // Returns true when the phase is reached. Returns false for an 619 // unknown phase. The default implementation returns false. 620 virtual bool request_concurrent_phase(const char* phase); 621 622 // Provides a thread pool to SafepointSynchronize to use 623 // for parallel safepoint cleanup. 624 // GCs that use a GC worker thread pool may want to share 625 // it for use during safepoint cleanup. This is only possible 626 // if the GC can pause and resume concurrent work (e.g. G1 627 // concurrent marking) for an intermittent non-GC safepoint. 628 // If this method returns NULL, SafepointSynchronize will 629 // perform cleanup tasks serially in the VMThread. 630 virtual WorkGang* get_safepoint_workers() { return NULL; } 631 632 // Non product verification and debugging. 633 #ifndef PRODUCT 634 // Support for PromotionFailureALot. Return true if it's time to cause a 635 // promotion failure. The no-argument version uses 636 // this->_promotion_failure_alot_count as the counter. 637 inline bool promotion_should_fail(volatile size_t* count); 638 inline bool promotion_should_fail(); 639 640 // Reset the PromotionFailureALot counters. Should be called at the end of a 641 // GC in which promotion failure occurred. 642 inline void reset_promotion_should_fail(volatile size_t* count); 643 inline void reset_promotion_should_fail(); 644 #endif // #ifndef PRODUCT 645 646 #ifdef ASSERT 647 static int fired_fake_oom() { 648 return (CIFireOOMAt > 1 && _fire_out_of_memory_count >= CIFireOOMAt); 649 } 650 #endif 651 652 public: 653 // Copy the current allocation context statistics for the specified contexts. 654 // For each context in contexts, set the corresponding entries in the totals 655 // and accuracy arrays to the current values held by the statistics. Each 656 // array should be of length len. 657 // Returns true if there are more stats available. 658 virtual bool copy_allocation_context_stats(const jint* contexts, 659 jlong* totals, 660 jbyte* accuracy, 661 jint len) { 662 return false; 663 } 664 665 }; 666 667 // Class to set and reset the GC cause for a CollectedHeap. 668 669 class GCCauseSetter : StackObj { 670 CollectedHeap* _heap; 671 GCCause::Cause _previous_cause; 672 public: 673 GCCauseSetter(CollectedHeap* heap, GCCause::Cause cause) { 674 assert(SafepointSynchronize::is_at_safepoint(), 675 "This method manipulates heap state without locking"); 676 _heap = heap; 677 _previous_cause = _heap->gc_cause(); 678 _heap->set_gc_cause(cause); 679 } 680 681 ~GCCauseSetter() { 682 assert(SafepointSynchronize::is_at_safepoint(), 683 "This method manipulates heap state without locking"); 684 _heap->set_gc_cause(_previous_cause); 685 } 686 }; 687 688 #endif // SHARE_VM_GC_SHARED_COLLECTEDHEAP_HPP