1 /* 2 * Copyright (c) 2000, 2015, 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_MEMORY_GENCOLLECTEDHEAP_HPP 26 #define SHARE_VM_MEMORY_GENCOLLECTEDHEAP_HPP 27 28 #include "gc_implementation/shared/adaptiveSizePolicy.hpp" 29 #include "gc_interface/collectedHeap.hpp" 30 #include "memory/collectorPolicy.hpp" 31 #include "memory/generation.hpp" 32 33 class SubTasksDone; 34 class FlexibleWorkGang; 35 36 // A "GenCollectedHeap" is a CollectedHeap that uses generational 37 // collection. It has two generations, young and old. 38 class GenCollectedHeap : public CollectedHeap { 39 friend class GenCollectorPolicy; 40 friend class Generation; 41 friend class DefNewGeneration; 42 friend class TenuredGeneration; 43 friend class ConcurrentMarkSweepGeneration; 44 friend class CMSCollector; 45 friend class GenMarkSweep; 46 friend class VM_GenCollectForAllocation; 47 friend class VM_GenCollectFull; 48 friend class VM_GenCollectFullConcurrent; 49 friend class VM_GC_HeapInspection; 50 friend class VM_HeapDumper; 51 friend class HeapInspection; 52 friend class GCCauseSetter; 53 friend class VMStructs; 54 public: 55 friend class VM_PopulateDumpSharedSpace; 56 57 protected: 58 // Fields: 59 static GenCollectedHeap* _gch; 60 61 private: 62 Generation* _young_gen; 63 Generation* _old_gen; 64 65 // The singleton Gen Remembered Set. 66 GenRemSet* _rem_set; 67 68 // The generational collector policy. 69 GenCollectorPolicy* _gen_policy; 70 71 // Indicates that the most recent previous incremental collection failed. 72 // The flag is cleared when an action is taken that might clear the 73 // condition that caused that incremental collection to fail. 74 bool _incremental_collection_failed; 75 76 // In support of ExplicitGCInvokesConcurrent functionality 77 unsigned int _full_collections_completed; 78 79 // Data structure for claiming the (potentially) parallel tasks in 80 // (gen-specific) roots processing. 81 SubTasksDone* _process_strong_tasks; 82 83 // Collects the given generation. 84 void collect_generation(Generation* gen, bool full, size_t size, bool is_tlab, 85 bool run_verification, bool clear_soft_refs, 86 bool restore_marks_for_biased_locking); 87 88 // In block contents verification, the number of header words to skip 89 NOT_PRODUCT(static size_t _skip_header_HeapWords;) 90 91 FlexibleWorkGang* _workers; 92 93 protected: 94 // Helper functions for allocation 95 HeapWord* attempt_allocation(size_t size, 96 bool is_tlab, 97 bool first_only); 98 99 // Helper function for two callbacks below. 100 // Considers collection of the first max_level+1 generations. 101 void do_collection(bool full, 102 bool clear_all_soft_refs, 103 size_t size, 104 bool is_tlab, 105 int max_level); 106 107 // Callback from VM_GenCollectForAllocation operation. 108 // This function does everything necessary/possible to satisfy an 109 // allocation request that failed in the youngest generation that should 110 // have handled it (including collection, expansion, etc.) 111 HeapWord* satisfy_failed_allocation(size_t size, bool is_tlab); 112 113 // Callback from VM_GenCollectFull operation. 114 // Perform a full collection of the first max_level+1 generations. 115 virtual void do_full_collection(bool clear_all_soft_refs); 116 void do_full_collection(bool clear_all_soft_refs, int max_level); 117 118 // Does the "cause" of GC indicate that 119 // we absolutely __must__ clear soft refs? 120 bool must_clear_all_soft_refs(); 121 122 public: 123 GenCollectedHeap(GenCollectorPolicy *policy); 124 125 FlexibleWorkGang* workers() const { return _workers; } 126 127 GCStats* gc_stats(int level) const; 128 129 // Returns JNI_OK on success 130 virtual jint initialize(); 131 132 // Reserve aligned space for the heap as needed by the contained generations. 133 char* allocate(size_t alignment, ReservedSpace* heap_rs); 134 135 // Does operations required after initialization has been done. 136 void post_initialize(); 137 138 // Initialize ("weak") refs processing support 139 virtual void ref_processing_init(); 140 141 virtual Name kind() const { 142 return CollectedHeap::GenCollectedHeap; 143 } 144 145 Generation* young_gen() const { return _young_gen; } 146 Generation* old_gen() const { return _old_gen; } 147 148 // The generational collector policy. 149 GenCollectorPolicy* gen_policy() const { return _gen_policy; } 150 151 virtual CollectorPolicy* collector_policy() const { return (CollectorPolicy*) gen_policy(); } 152 153 // Adaptive size policy 154 virtual AdaptiveSizePolicy* size_policy() { 155 return gen_policy()->size_policy(); 156 } 157 158 // Return the (conservative) maximum heap alignment 159 static size_t conservative_max_heap_alignment() { 160 return Generation::GenGrain; 161 } 162 163 size_t capacity() const; 164 size_t used() const; 165 166 // Save the "used_region" for generations level and lower. 167 void save_used_regions(int level); 168 169 size_t max_capacity() const; 170 171 HeapWord* mem_allocate(size_t size, 172 bool* gc_overhead_limit_was_exceeded); 173 174 // We may support a shared contiguous allocation area, if the youngest 175 // generation does. 176 bool supports_inline_contig_alloc() const; 177 HeapWord** top_addr() const; 178 HeapWord** end_addr() const; 179 180 // Does this heap support heap inspection? (+PrintClassHistogram) 181 virtual bool supports_heap_inspection() const { return true; } 182 183 // Perform a full collection of the heap; intended for use in implementing 184 // "System.gc". This implies as full a collection as the CollectedHeap 185 // supports. Caller does not hold the Heap_lock on entry. 186 void collect(GCCause::Cause cause); 187 188 // The same as above but assume that the caller holds the Heap_lock. 189 void collect_locked(GCCause::Cause cause); 190 191 // Perform a full collection of the first max_level+1 generations. 192 // Mostly used for testing purposes. Caller does not hold the Heap_lock on entry. 193 void collect(GCCause::Cause cause, int max_level); 194 195 // Returns "TRUE" iff "p" points into the committed areas of the heap. 196 // The methods is_in(), is_in_closed_subset() and is_in_youngest() may 197 // be expensive to compute in general, so, to prevent 198 // their inadvertent use in product jvm's, we restrict their use to 199 // assertion checking or verification only. 200 bool is_in(const void* p) const; 201 202 // override 203 bool is_in_closed_subset(const void* p) const { 204 if (UseConcMarkSweepGC) { 205 return is_in_reserved(p); 206 } else { 207 return is_in(p); 208 } 209 } 210 211 // Returns true if the reference is to an object in the reserved space 212 // for the young generation. 213 // Assumes the the young gen address range is less than that of the old gen. 214 bool is_in_young(oop p); 215 216 #ifdef ASSERT 217 bool is_in_partial_collection(const void* p); 218 #endif 219 220 virtual bool is_scavengable(const void* addr) { 221 return is_in_young((oop)addr); 222 } 223 224 // Iteration functions. 225 void oop_iterate_no_header(OopClosure* cl); 226 void oop_iterate(ExtendedOopClosure* cl); 227 void object_iterate(ObjectClosure* cl); 228 void safe_object_iterate(ObjectClosure* cl); 229 Space* space_containing(const void* addr) const; 230 231 // A CollectedHeap is divided into a dense sequence of "blocks"; that is, 232 // each address in the (reserved) heap is a member of exactly 233 // one block. The defining characteristic of a block is that it is 234 // possible to find its size, and thus to progress forward to the next 235 // block. (Blocks may be of different sizes.) Thus, blocks may 236 // represent Java objects, or they might be free blocks in a 237 // free-list-based heap (or subheap), as long as the two kinds are 238 // distinguishable and the size of each is determinable. 239 240 // Returns the address of the start of the "block" that contains the 241 // address "addr". We say "blocks" instead of "object" since some heaps 242 // may not pack objects densely; a chunk may either be an object or a 243 // non-object. 244 virtual HeapWord* block_start(const void* addr) const; 245 246 // Requires "addr" to be the start of a chunk, and returns its size. 247 // "addr + size" is required to be the start of a new chunk, or the end 248 // of the active area of the heap. Assumes (and verifies in non-product 249 // builds) that addr is in the allocated part of the heap and is 250 // the start of a chunk. 251 virtual size_t block_size(const HeapWord* addr) const; 252 253 // Requires "addr" to be the start of a block, and returns "TRUE" iff 254 // the block is an object. Assumes (and verifies in non-product 255 // builds) that addr is in the allocated part of the heap and is 256 // the start of a chunk. 257 virtual bool block_is_obj(const HeapWord* addr) const; 258 259 // Section on TLAB's. 260 virtual bool supports_tlab_allocation() const; 261 virtual size_t tlab_capacity(Thread* thr) const; 262 virtual size_t tlab_used(Thread* thr) const; 263 virtual size_t unsafe_max_tlab_alloc(Thread* thr) const; 264 virtual HeapWord* allocate_new_tlab(size_t size); 265 266 // Can a compiler initialize a new object without store barriers? 267 // This permission only extends from the creation of a new object 268 // via a TLAB up to the first subsequent safepoint. 269 virtual bool can_elide_tlab_store_barriers() const { 270 return true; 271 } 272 273 virtual bool card_mark_must_follow_store() const { 274 return UseConcMarkSweepGC; 275 } 276 277 // We don't need barriers for stores to objects in the 278 // young gen and, a fortiori, for initializing stores to 279 // objects therein. This applies to DefNew+Tenured and ParNew+CMS 280 // only and may need to be re-examined in case other 281 // kinds of collectors are implemented in the future. 282 virtual bool can_elide_initializing_store_barrier(oop new_obj) { 283 // We wanted to assert that:- 284 // assert(UseSerialGC || UseConcMarkSweepGC, 285 // "Check can_elide_initializing_store_barrier() for this collector"); 286 // but unfortunately the flag UseSerialGC need not necessarily always 287 // be set when DefNew+Tenured are being used. 288 return is_in_young(new_obj); 289 } 290 291 // The "requestor" generation is performing some garbage collection 292 // action for which it would be useful to have scratch space. The 293 // requestor promises to allocate no more than "max_alloc_words" in any 294 // older generation (via promotion say.) Any blocks of space that can 295 // be provided are returned as a list of ScratchBlocks, sorted by 296 // decreasing size. 297 ScratchBlock* gather_scratch(Generation* requestor, size_t max_alloc_words); 298 // Allow each generation to reset any scratch space that it has 299 // contributed as it needs. 300 void release_scratch(); 301 302 // Ensure parsability: override 303 virtual void ensure_parsability(bool retire_tlabs); 304 305 // Time in ms since the longest time a collector ran in 306 // in any generation. 307 virtual jlong millis_since_last_gc(); 308 309 // Total number of full collections completed. 310 unsigned int total_full_collections_completed() { 311 assert(_full_collections_completed <= _total_full_collections, 312 "Can't complete more collections than were started"); 313 return _full_collections_completed; 314 } 315 316 // Update above counter, as appropriate, at the end of a stop-world GC cycle 317 unsigned int update_full_collections_completed(); 318 // Update above counter, as appropriate, at the end of a concurrent GC cycle 319 unsigned int update_full_collections_completed(unsigned int count); 320 321 // Update "time of last gc" for all generations to "now". 322 void update_time_of_last_gc(jlong now) { 323 _young_gen->update_time_of_last_gc(now); 324 _old_gen->update_time_of_last_gc(now); 325 } 326 327 // Update the gc statistics for each generation. 328 // "level" is the level of the latest collection. 329 void update_gc_stats(int current_level, bool full) { 330 _young_gen->update_gc_stats(current_level, full); 331 _old_gen->update_gc_stats(current_level, full); 332 } 333 334 bool no_gc_in_progress() { return !is_gc_active(); } 335 336 // Override. 337 void prepare_for_verify(); 338 339 // Override. 340 void verify(bool silent, VerifyOption option); 341 342 // Override. 343 virtual void print_on(outputStream* st) const; 344 virtual void print_gc_threads_on(outputStream* st) const; 345 virtual void gc_threads_do(ThreadClosure* tc) const; 346 virtual void print_tracing_info() const; 347 virtual void print_on_error(outputStream* st) const; 348 349 // PrintGC, PrintGCDetails support 350 void print_heap_change(size_t prev_used) const; 351 352 // The functions below are helper functions that a subclass of 353 // "CollectedHeap" can use in the implementation of its virtual 354 // functions. 355 356 class GenClosure : public StackObj { 357 public: 358 virtual void do_generation(Generation* gen) = 0; 359 }; 360 361 // Apply "cl.do_generation" to all generations in the heap 362 // If "old_to_young" determines the order. 363 void generation_iterate(GenClosure* cl, bool old_to_young); 364 365 // Return "true" if all generations have reached the 366 // maximal committed limit that they can reach, without a garbage 367 // collection. 368 virtual bool is_maximal_no_gc() const; 369 370 // This function returns the "GenRemSet" object that allows us to scan 371 // generations in a fully generational heap. 372 GenRemSet* rem_set() { return _rem_set; } 373 374 // Convenience function to be used in situations where the heap type can be 375 // asserted to be this type. 376 static GenCollectedHeap* heap(); 377 378 void set_par_threads(uint t); 379 void set_n_termination(uint t); 380 381 // Invoke the "do_oop" method of one of the closures "not_older_gens" 382 // or "older_gens" on root locations for the generation at 383 // "level". (The "older_gens" closure is used for scanning references 384 // from older generations; "not_older_gens" is used everywhere else.) 385 // If "younger_gens_as_roots" is false, younger generations are 386 // not scanned as roots; in this case, the caller must be arranging to 387 // scan the younger generations itself. (For example, a generation might 388 // explicitly mark reachable objects in younger generations, to avoid 389 // excess storage retention.) 390 // The "so" argument determines which of the roots 391 // the closure is applied to: 392 // "SO_None" does none; 393 enum ScanningOption { 394 SO_None = 0x0, 395 SO_AllCodeCache = 0x8, 396 SO_ScavengeCodeCache = 0x10 397 }; 398 399 private: 400 void process_roots(bool activate_scope, 401 ScanningOption so, 402 OopClosure* strong_roots, 403 OopClosure* weak_roots, 404 CLDClosure* strong_cld_closure, 405 CLDClosure* weak_cld_closure, 406 CodeBlobClosure* code_roots); 407 408 void gen_process_roots(int level, 409 bool younger_gens_as_roots, 410 bool activate_scope, 411 ScanningOption so, 412 OopsInGenClosure* not_older_gens, 413 OopsInGenClosure* weak_roots, 414 OopsInGenClosure* older_gens, 415 CLDClosure* cld_closure, 416 CLDClosure* weak_cld_closure, 417 CodeBlobClosure* code_closure); 418 419 public: 420 static const bool StrongAndWeakRoots = false; 421 static const bool StrongRootsOnly = true; 422 423 void gen_process_roots(int level, 424 bool younger_gens_as_roots, 425 bool activate_scope, 426 ScanningOption so, 427 bool only_strong_roots, 428 OopsInGenClosure* not_older_gens, 429 OopsInGenClosure* older_gens, 430 CLDClosure* cld_closure); 431 432 // Apply "root_closure" to all the weak roots of the system. 433 // These include JNI weak roots, string table, 434 // and referents of reachable weak refs. 435 void gen_process_weak_roots(OopClosure* root_closure); 436 437 // Set the saved marks of generations, if that makes sense. 438 // In particular, if any generation might iterate over the oops 439 // in other generations, it should call this method. 440 void save_marks(); 441 442 // Apply "cur->do_oop" or "older->do_oop" to all the oops in objects 443 // allocated since the last call to save_marks in generations at or above 444 // "level". The "cur" closure is 445 // applied to references in the generation at "level", and the "older" 446 // closure to older generations. 447 #define GCH_SINCE_SAVE_MARKS_ITERATE_DECL(OopClosureType, nv_suffix) \ 448 void oop_since_save_marks_iterate(int level, \ 449 OopClosureType* cur, \ 450 OopClosureType* older); 451 452 ALL_SINCE_SAVE_MARKS_CLOSURES(GCH_SINCE_SAVE_MARKS_ITERATE_DECL) 453 454 #undef GCH_SINCE_SAVE_MARKS_ITERATE_DECL 455 456 // Returns "true" iff no allocations have occurred in any generation at 457 // "level" or above since the last 458 // call to "save_marks". 459 bool no_allocs_since_save_marks(int level); 460 461 // Returns true if an incremental collection is likely to fail. 462 // We optionally consult the young gen, if asked to do so; 463 // otherwise we base our answer on whether the previous incremental 464 // collection attempt failed with no corrective action as of yet. 465 bool incremental_collection_will_fail(bool consult_young) { 466 // Assumes a 2-generation system; the first disjunct remembers if an 467 // incremental collection failed, even when we thought (second disjunct) 468 // that it would not. 469 assert(heap()->collector_policy()->is_generation_policy(), 470 "the following definition may not be suitable for an n(>2)-generation system"); 471 return incremental_collection_failed() || 472 (consult_young && !_young_gen->collection_attempt_is_safe()); 473 } 474 475 // If a generation bails out of an incremental collection, 476 // it sets this flag. 477 bool incremental_collection_failed() const { 478 return _incremental_collection_failed; 479 } 480 void set_incremental_collection_failed() { 481 _incremental_collection_failed = true; 482 } 483 void clear_incremental_collection_failed() { 484 _incremental_collection_failed = false; 485 } 486 487 // Promotion of obj into gen failed. Try to promote obj to higher 488 // gens in ascending order; return the new location of obj if successful. 489 // Otherwise, try expand-and-allocate for obj in both the young and old 490 // generation; return the new location of obj if successful. Otherwise, return NULL. 491 oop handle_failed_promotion(Generation* old_gen, 492 oop obj, 493 size_t obj_size); 494 495 private: 496 // Accessor for memory state verification support 497 NOT_PRODUCT( 498 static size_t skip_header_HeapWords() { return _skip_header_HeapWords; } 499 ) 500 501 // Override 502 void check_for_non_bad_heap_word_value(HeapWord* addr, 503 size_t size) PRODUCT_RETURN; 504 505 // For use by mark-sweep. As implemented, mark-sweep-compact is global 506 // in an essential way: compaction is performed across generations, by 507 // iterating over spaces. 508 void prepare_for_compaction(); 509 510 // Perform a full collection of the first max_level+1 generations. 511 // This is the low level interface used by the public versions of 512 // collect() and collect_locked(). Caller holds the Heap_lock on entry. 513 void collect_locked(GCCause::Cause cause, int max_level); 514 515 // Returns success or failure. 516 bool create_cms_collector(); 517 518 // In support of ExplicitGCInvokesConcurrent functionality 519 bool should_do_concurrent_full_gc(GCCause::Cause cause); 520 void collect_mostly_concurrent(GCCause::Cause cause); 521 522 // Save the tops of the spaces in all generations 523 void record_gen_tops_before_GC() PRODUCT_RETURN; 524 525 protected: 526 void gc_prologue(bool full); 527 void gc_epilogue(bool full); 528 }; 529 530 #endif // SHARE_VM_MEMORY_GENCOLLECTEDHEAP_HPP