1 /* 2 * Copyright (c) 2000, 2013, 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 "memory/collectorPolicy.hpp" 30 #include "memory/generation.hpp" 31 #include "memory/sharedHeap.hpp" 32 33 class SubTasksDone; 34 35 // A "GenCollectedHeap" is a SharedHeap that uses generational 36 // collection. It is represented with a sequence of Generation's. 37 class GenCollectedHeap : public SharedHeap { 38 friend class GenCollectorPolicy; 39 friend class Generation; 40 friend class DefNewGeneration; 41 friend class TenuredGeneration; 42 friend class ConcurrentMarkSweepGeneration; 43 friend class CMSCollector; 44 friend class GenMarkSweep; 45 friend class VM_GenCollectForAllocation; 46 friend class VM_GenCollectFull; 47 friend class VM_GenCollectFullConcurrent; 48 friend class VM_GC_HeapInspection; 49 friend class VM_HeapDumper; 50 friend class HeapInspection; 51 friend class GCCauseSetter; 52 friend class VMStructs; 53 public: 54 enum SomeConstants { 55 max_gens = 10 56 }; 57 58 friend class VM_PopulateDumpSharedSpace; 59 60 protected: 61 // Fields: 62 static GenCollectedHeap* _gch; 63 64 private: 65 int _n_gens; 66 Generation* _gens[max_gens]; 67 GenerationSpec** _gen_specs; 68 69 // The generational collector policy. 70 GenCollectorPolicy* _gen_policy; 71 72 // Indicates that the most recent previous incremental collection failed. 73 // The flag is cleared when an action is taken that might clear the 74 // condition that caused that incremental collection to fail. 75 bool _incremental_collection_failed; 76 77 // In support of ExplicitGCInvokesConcurrent functionality 78 unsigned int _full_collections_completed; 79 80 // Data structure for claiming the (potentially) parallel tasks in 81 // (gen-specific) strong roots processing. 82 SubTasksDone* _gen_process_strong_tasks; 83 SubTasksDone* gen_process_strong_tasks() { return _gen_process_strong_tasks; } 84 85 // In block contents verification, the number of header words to skip 86 NOT_PRODUCT(static size_t _skip_header_HeapWords;) 87 88 protected: 89 // Directs each generation up to and including "collectedGen" to recompute 90 // its desired size. 91 void compute_new_generation_sizes(int collectedGen); 92 93 // Helper functions for allocation 94 HeapWord* attempt_allocation(size_t size, 95 bool is_tlab, 96 bool first_only); 97 98 // Helper function for two callbacks below. 99 // Considers collection of the first max_level+1 generations. 100 void do_collection(bool full, 101 bool clear_all_soft_refs, 102 size_t size, 103 bool is_tlab, 104 int max_level); 105 106 // Callback from VM_GenCollectForAllocation operation. 107 // This function does everything necessary/possible to satisfy an 108 // allocation request that failed in the youngest generation that should 109 // have handled it (including collection, expansion, etc.) 110 HeapWord* satisfy_failed_allocation(size_t size, bool is_tlab); 111 112 // Callback from VM_GenCollectFull operation. 113 // Perform a full collection of the first max_level+1 generations. 114 virtual void do_full_collection(bool clear_all_soft_refs); 115 void do_full_collection(bool clear_all_soft_refs, int max_level); 116 117 // Does the "cause" of GC indicate that 118 // we absolutely __must__ clear soft refs? 119 bool must_clear_all_soft_refs(); 120 121 public: 122 GenCollectedHeap(GenCollectorPolicy *policy); 123 124 GCStats* gc_stats(int level) const; 125 126 // Returns JNI_OK on success 127 virtual jint initialize(); 128 char* allocate(size_t alignment, 129 size_t* _total_reserved, int* _n_covered_regions, 130 ReservedSpace* heap_rs); 131 132 // Does operations required after initialization has been done. 133 void post_initialize(); 134 135 // Initialize ("weak") refs processing support 136 virtual void ref_processing_init(); 137 138 virtual CollectedHeap::Name kind() const { 139 return CollectedHeap::GenCollectedHeap; 140 } 141 142 // The generational collector policy. 143 GenCollectorPolicy* gen_policy() const { return _gen_policy; } 144 virtual CollectorPolicy* collector_policy() const { return (CollectorPolicy*) gen_policy(); } 145 146 // Adaptive size policy 147 virtual AdaptiveSizePolicy* size_policy() { 148 return gen_policy()->size_policy(); 149 } 150 151 // Return the (conservative) maximum heap alignment 152 static size_t conservative_max_heap_alignment() { 153 return Generation::GenGrain; 154 } 155 156 size_t capacity() const; 157 size_t used() const; 158 159 // Save the "used_region" for generations level and lower. 160 void save_used_regions(int level); 161 162 size_t max_capacity() const; 163 164 HeapWord* mem_allocate(size_t size, 165 bool* gc_overhead_limit_was_exceeded); 166 167 // We may support a shared contiguous allocation area, if the youngest 168 // generation does. 169 bool supports_inline_contig_alloc() const; 170 HeapWord** top_addr() const; 171 HeapWord** end_addr() const; 172 173 // Return an estimate of the maximum allocation that could be performed 174 // without triggering any collection activity. In a generational 175 // collector, for example, this is probably the largest allocation that 176 // could be supported in the youngest generation. It is "unsafe" because 177 // no locks are taken; the result should be treated as an approximation, 178 // not a guarantee. 179 size_t unsafe_max_alloc(); 180 181 // Does this heap support heap inspection? (+PrintClassHistogram) 182 virtual bool supports_heap_inspection() const { return true; } 183 184 // Perform a full collection of the heap; intended for use in implementing 185 // "System.gc". This implies as full a collection as the CollectedHeap 186 // supports. Caller does not hold the Heap_lock on entry. 187 void collect(GCCause::Cause cause); 188 189 // The same as above but assume that the caller holds the Heap_lock. 190 void collect_locked(GCCause::Cause cause); 191 192 // Perform a full collection of the first max_level+1 generations. 193 // Mostly used for testing purposes. Caller does not hold the Heap_lock on entry. 194 void collect(GCCause::Cause cause, int max_level); 195 196 // Returns "TRUE" iff "p" points into the committed areas of the heap. 197 // The methods is_in(), is_in_closed_subset() and is_in_youngest() may 198 // be expensive to compute in general, so, to prevent 199 // their inadvertent use in product jvm's, we restrict their use to 200 // assertion checking or verification only. 201 bool is_in(const void* p) const; 202 203 // override 204 bool is_in_closed_subset(const void* p) const { 205 if (UseConcMarkSweepGC) { 206 return is_in_reserved(p); 207 } else { 208 return is_in(p); 209 } 210 } 211 212 // Returns true if the reference is to an object in the reserved space 213 // for the young generation. 214 // Assumes the the young gen address range is less than that of the old gen. 215 bool is_in_young(oop p); 216 217 #ifdef ASSERT 218 virtual bool is_in_partial_collection(const void* p); 219 #endif 220 221 virtual bool is_scavengable(const void* addr) { 222 return is_in_young((oop)addr); 223 } 224 225 // Iteration functions. 226 void oop_iterate(ExtendedOopClosure* cl); 227 void oop_iterate(MemRegion mr, ExtendedOopClosure* cl); 228 void object_iterate(ObjectClosure* cl); 229 void safe_object_iterate(ObjectClosure* cl); 230 Space* space_containing(const void* addr) const; 231 232 // A CollectedHeap is divided into a dense sequence of "blocks"; that is, 233 // each address in the (reserved) heap is a member of exactly 234 // one block. The defining characteristic of a block is that it is 235 // possible to find its size, and thus to progress forward to the next 236 // block. (Blocks may be of different sizes.) Thus, blocks may 237 // represent Java objects, or they might be free blocks in a 238 // free-list-based heap (or subheap), as long as the two kinds are 239 // distinguishable and the size of each is determinable. 240 241 // Returns the address of the start of the "block" that contains the 242 // address "addr". We say "blocks" instead of "object" since some heaps 243 // may not pack objects densely; a chunk may either be an object or a 244 // non-object. 245 virtual HeapWord* block_start(const void* addr) const; 246 247 // Requires "addr" to be the start of a chunk, and returns its size. 248 // "addr + size" is required to be the start of a new chunk, or the end 249 // of the active area of the heap. Assumes (and verifies in non-product 250 // builds) that addr is in the allocated part of the heap and is 251 // the start of a chunk. 252 virtual size_t block_size(const HeapWord* addr) const; 253 254 // Requires "addr" to be the start of a block, and returns "TRUE" iff 255 // the block is an object. Assumes (and verifies in non-product 256 // builds) that addr is in the allocated part of the heap and is 257 // the start of a chunk. 258 virtual bool block_is_obj(const HeapWord* addr) const; 259 260 // Section on TLAB's. 261 virtual bool supports_tlab_allocation() const; 262 virtual size_t tlab_capacity(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,ParNew}+{Tenured,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(UseParNewGC || 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 constituent generations 322 // to "now". 323 void update_time_of_last_gc(jlong now) { 324 for (int i = 0; i < _n_gens; i++) { 325 _gens[i]->update_time_of_last_gc(now); 326 } 327 } 328 329 // Update the gc statistics for each generation. 330 // "level" is the level of the lastest collection 331 void update_gc_stats(int current_level, bool full) { 332 for (int i = 0; i < _n_gens; i++) { 333 _gens[i]->update_gc_stats(current_level, full); 334 } 335 } 336 337 // Override. 338 bool no_gc_in_progress() { return !is_gc_active(); } 339 340 // Override. 341 void prepare_for_verify(); 342 343 // Override. 344 void verify(bool silent, VerifyOption option); 345 346 // Override. 347 virtual void print_on(outputStream* st) const; 348 virtual void print_gc_threads_on(outputStream* st) const; 349 virtual void gc_threads_do(ThreadClosure* tc) const; 350 virtual void print_tracing_info() const; 351 virtual void print_on_error(outputStream* st) const; 352 353 // PrintGC, PrintGCDetails support 354 void print_heap_change(size_t prev_used) const; 355 356 // The functions below are helper functions that a subclass of 357 // "CollectedHeap" can use in the implementation of its virtual 358 // functions. 359 360 class GenClosure : public StackObj { 361 public: 362 virtual void do_generation(Generation* gen) = 0; 363 }; 364 365 // Apply "cl.do_generation" to all generations in the heap 366 // If "old_to_young" determines the order. 367 void generation_iterate(GenClosure* cl, bool old_to_young); 368 369 void space_iterate(SpaceClosure* cl); 370 371 // Return "true" if all generations have reached the 372 // maximal committed limit that they can reach, without a garbage 373 // collection. 374 virtual bool is_maximal_no_gc() const; 375 376 // Return the generation before "gen". 377 Generation* prev_gen(Generation* gen) const { 378 int l = gen->level(); 379 guarantee(l > 0, "Out of bounds"); 380 return _gens[l-1]; 381 } 382 383 // Return the generation after "gen". 384 Generation* next_gen(Generation* gen) const { 385 int l = gen->level() + 1; 386 guarantee(l < _n_gens, "Out of bounds"); 387 return _gens[l]; 388 } 389 390 Generation* get_gen(int i) const { 391 guarantee(i >= 0 && i < _n_gens, "Out of bounds"); 392 return _gens[i]; 393 } 394 395 int n_gens() const { 396 assert(_n_gens == gen_policy()->number_of_generations(), "Sanity"); 397 return _n_gens; 398 } 399 400 // Convenience function to be used in situations where the heap type can be 401 // asserted to be this type. 402 static GenCollectedHeap* heap(); 403 404 void set_par_threads(uint t); 405 406 // Invoke the "do_oop" method of one of the closures "not_older_gens" 407 // or "older_gens" on root locations for the generation at 408 // "level". (The "older_gens" closure is used for scanning references 409 // from older generations; "not_older_gens" is used everywhere else.) 410 // If "younger_gens_as_roots" is false, younger generations are 411 // not scanned as roots; in this case, the caller must be arranging to 412 // scan the younger generations itself. (For example, a generation might 413 // explicitly mark reachable objects in younger generations, to avoid 414 // excess storage retention.) 415 // The "so" argument determines which of the roots 416 // the closure is applied to: 417 // "SO_None" does none; 418 // "SO_AllClasses" applies the closure to all entries in the SystemDictionary; 419 // "SO_SystemClasses" to all the "system" classes and loaders; 420 // "SO_Strings" applies the closure to all entries in the StringTable. 421 void gen_process_strong_roots(int level, 422 bool younger_gens_as_roots, 423 // The remaining arguments are in an order 424 // consistent with SharedHeap::process_strong_roots: 425 bool activate_scope, 426 bool is_scavenging, 427 SharedHeap::ScanningOption so, 428 OopsInGenClosure* not_older_gens, 429 bool do_code_roots, 430 OopsInGenClosure* older_gens, 431 KlassClosure* klass_closure); 432 433 // Apply "blk" to all the weak roots of the system. These include 434 // JNI weak roots, the code cache, system dictionary, symbol table, 435 // string table, and referents of reachable weak refs. 436 void gen_process_weak_roots(OopClosure* root_closure, 437 CodeBlobClosure* code_roots); 438 439 // Set the saved marks of generations, if that makes sense. 440 // In particular, if any generation might iterate over the oops 441 // in other generations, it should call this method. 442 void save_marks(); 443 444 // Apply "cur->do_oop" or "older->do_oop" to all the oops in objects 445 // allocated since the last call to save_marks in generations at or above 446 // "level". The "cur" closure is 447 // applied to references in the generation at "level", and the "older" 448 // closure to older generations. 449 #define GCH_SINCE_SAVE_MARKS_ITERATE_DECL(OopClosureType, nv_suffix) \ 450 void oop_since_save_marks_iterate(int level, \ 451 OopClosureType* cur, \ 452 OopClosureType* older); 453 454 ALL_SINCE_SAVE_MARKS_CLOSURES(GCH_SINCE_SAVE_MARKS_ITERATE_DECL) 455 456 #undef GCH_SINCE_SAVE_MARKS_ITERATE_DECL 457 458 // Returns "true" iff no allocations have occurred in any generation at 459 // "level" or above since the last 460 // call to "save_marks". 461 bool no_allocs_since_save_marks(int level); 462 463 // Returns true if an incremental collection is likely to fail. 464 // We optionally consult the young gen, if asked to do so; 465 // otherwise we base our answer on whether the previous incremental 466 // collection attempt failed with no corrective action as of yet. 467 bool incremental_collection_will_fail(bool consult_young) { 468 // Assumes a 2-generation system; the first disjunct remembers if an 469 // incremental collection failed, even when we thought (second disjunct) 470 // that it would not. 471 assert(heap()->collector_policy()->is_two_generation_policy(), 472 "the following definition may not be suitable for an n(>2)-generation system"); 473 return incremental_collection_failed() || 474 (consult_young && !get_gen(0)->collection_attempt_is_safe()); 475 } 476 477 // If a generation bails out of an incremental collection, 478 // it sets this flag. 479 bool incremental_collection_failed() const { 480 return _incremental_collection_failed; 481 } 482 void set_incremental_collection_failed() { 483 _incremental_collection_failed = true; 484 } 485 void clear_incremental_collection_failed() { 486 _incremental_collection_failed = false; 487 } 488 489 // Promotion of obj into gen failed. Try to promote obj to higher 490 // gens in ascending order; return the new location of obj if successful. 491 // Otherwise, try expand-and-allocate for obj in both the young and old 492 // generation; return the new location of obj if successful. Otherwise, return NULL. 493 oop handle_failed_promotion(Generation* old_gen, 494 oop obj, 495 size_t obj_size); 496 497 private: 498 // Accessor for memory state verification support 499 NOT_PRODUCT( 500 static size_t skip_header_HeapWords() { return _skip_header_HeapWords; } 501 ) 502 503 // Override 504 void check_for_non_bad_heap_word_value(HeapWord* addr, 505 size_t size) PRODUCT_RETURN; 506 507 // For use by mark-sweep. As implemented, mark-sweep-compact is global 508 // in an essential way: compaction is performed across generations, by 509 // iterating over spaces. 510 void prepare_for_compaction(); 511 512 // Perform a full collection of the first max_level+1 generations. 513 // This is the low level interface used by the public versions of 514 // collect() and collect_locked(). Caller holds the Heap_lock on entry. 515 void collect_locked(GCCause::Cause cause, int max_level); 516 517 // Returns success or failure. 518 bool create_cms_collector(); 519 520 // In support of ExplicitGCInvokesConcurrent functionality 521 bool should_do_concurrent_full_gc(GCCause::Cause cause); 522 void collect_mostly_concurrent(GCCause::Cause cause); 523 524 // Save the tops of the spaces in all generations 525 void record_gen_tops_before_GC() PRODUCT_RETURN; 526 527 protected: 528 virtual void gc_prologue(bool full); 529 virtual void gc_epilogue(bool full); 530 }; 531 532 #endif // SHARE_VM_MEMORY_GENCOLLECTEDHEAP_HPP