Fri, 17 Apr 2009 12:22:18 -0700
6831604: missing null check in guarantee
Reviewed-by: kvn
1 /*
2 * Copyright 2000-2009 Sun Microsystems, Inc. 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
20 * CA 95054 USA or visit www.sun.com if you need additional information or
21 * have any questions.
22 *
23 */
25 class SubTasksDone;
27 // A "GenCollectedHeap" is a SharedHeap that uses generational
28 // collection. It is represented with a sequence of Generation's.
29 class GenCollectedHeap : public SharedHeap {
30 friend class GenCollectorPolicy;
31 friend class Generation;
32 friend class DefNewGeneration;
33 friend class TenuredGeneration;
34 friend class ConcurrentMarkSweepGeneration;
35 friend class CMSCollector;
36 friend class GenMarkSweep;
37 friend class VM_GenCollectForAllocation;
38 friend class VM_GenCollectForPermanentAllocation;
39 friend class VM_GenCollectFull;
40 friend class VM_GenCollectFullConcurrent;
41 friend class VM_GC_HeapInspection;
42 friend class VM_HeapDumper;
43 friend class HeapInspection;
44 friend class GCCauseSetter;
45 friend class VMStructs;
46 public:
47 enum SomeConstants {
48 max_gens = 10
49 };
51 friend class VM_PopulateDumpSharedSpace;
53 protected:
54 // Fields:
55 static GenCollectedHeap* _gch;
57 private:
58 int _n_gens;
59 Generation* _gens[max_gens];
60 GenerationSpec** _gen_specs;
62 // The generational collector policy.
63 GenCollectorPolicy* _gen_policy;
65 // If a generation would bail out of an incremental collection,
66 // it sets this flag. If the flag is set, satisfy_failed_allocation
67 // will attempt allocating in all generations before doing a full GC.
68 bool _incremental_collection_will_fail;
69 bool _last_incremental_collection_failed;
71 // In support of ExplicitGCInvokesConcurrent functionality
72 unsigned int _full_collections_completed;
74 // Data structure for claiming the (potentially) parallel tasks in
75 // (gen-specific) strong roots processing.
76 SubTasksDone* _gen_process_strong_tasks;
78 // In block contents verification, the number of header words to skip
79 NOT_PRODUCT(static size_t _skip_header_HeapWords;)
81 // GC is not allowed during the dump of the shared classes. Keep track
82 // of this in order to provide an reasonable error message when terminating.
83 bool _preloading_shared_classes;
85 protected:
86 // Directs each generation up to and including "collectedGen" to recompute
87 // its desired size.
88 void compute_new_generation_sizes(int collectedGen);
90 // Helper functions for allocation
91 HeapWord* attempt_allocation(size_t size,
92 bool is_tlab,
93 bool first_only);
95 // Helper function for two callbacks below.
96 // Considers collection of the first max_level+1 generations.
97 void do_collection(bool full,
98 bool clear_all_soft_refs,
99 size_t size,
100 bool is_tlab,
101 int max_level);
103 // Callback from VM_GenCollectForAllocation operation.
104 // This function does everything necessary/possible to satisfy an
105 // allocation request that failed in the youngest generation that should
106 // have handled it (including collection, expansion, etc.)
107 HeapWord* satisfy_failed_allocation(size_t size, bool is_tlab);
109 // Callback from VM_GenCollectFull operation.
110 // Perform a full collection of the first max_level+1 generations.
111 void do_full_collection(bool clear_all_soft_refs, int max_level);
113 // Does the "cause" of GC indicate that
114 // we absolutely __must__ clear soft refs?
115 bool must_clear_all_soft_refs();
117 public:
118 GenCollectedHeap(GenCollectorPolicy *policy);
120 GCStats* gc_stats(int level) const;
122 // Returns JNI_OK on success
123 virtual jint initialize();
124 char* allocate(size_t alignment, PermanentGenerationSpec* perm_gen_spec,
125 size_t* _total_reserved, int* _n_covered_regions,
126 ReservedSpace* heap_rs);
128 // Does operations required after initialization has been done.
129 void post_initialize();
131 // Initialize ("weak") refs processing support
132 virtual void ref_processing_init();
134 virtual CollectedHeap::Name kind() const {
135 return CollectedHeap::GenCollectedHeap;
136 }
138 // The generational collector policy.
139 GenCollectorPolicy* gen_policy() const { return _gen_policy; }
141 // Adaptive size policy
142 virtual AdaptiveSizePolicy* size_policy() {
143 return gen_policy()->size_policy();
144 }
146 size_t capacity() const;
147 size_t used() const;
149 // Save the "used_region" for generations level and lower,
150 // and, if perm is true, for perm gen.
151 void save_used_regions(int level, bool perm);
153 size_t max_capacity() const;
155 HeapWord* mem_allocate(size_t size,
156 bool is_large_noref,
157 bool is_tlab,
158 bool* gc_overhead_limit_was_exceeded);
160 // We may support a shared contiguous allocation area, if the youngest
161 // generation does.
162 bool supports_inline_contig_alloc() const;
163 HeapWord** top_addr() const;
164 HeapWord** end_addr() const;
166 // Return an estimate of the maximum allocation that could be performed
167 // without triggering any collection activity. In a generational
168 // collector, for example, this is probably the largest allocation that
169 // could be supported in the youngest generation. It is "unsafe" because
170 // no locks are taken; the result should be treated as an approximation,
171 // not a guarantee.
172 size_t unsafe_max_alloc();
174 // Does this heap support heap inspection? (+PrintClassHistogram)
175 virtual bool supports_heap_inspection() const { return true; }
177 // Perform a full collection of the heap; intended for use in implementing
178 // "System.gc". This implies as full a collection as the CollectedHeap
179 // supports. Caller does not hold the Heap_lock on entry.
180 void collect(GCCause::Cause cause);
182 // This interface assumes that it's being called by the
183 // vm thread. It collects the heap assuming that the
184 // heap lock is already held and that we are executing in
185 // the context of the vm thread.
186 void collect_as_vm_thread(GCCause::Cause cause);
188 // The same as above but assume that the caller holds the Heap_lock.
189 void collect_locked(GCCause::Cause cause);
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);
195 // Returns "TRUE" iff "p" points into the allocated area 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;
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 }
211 // Returns "TRUE" iff "p" points into the youngest generation.
212 bool is_in_youngest(void* p);
214 // Iteration functions.
215 void oop_iterate(OopClosure* cl);
216 void oop_iterate(MemRegion mr, OopClosure* cl);
217 void object_iterate(ObjectClosure* cl);
218 void safe_object_iterate(ObjectClosure* cl);
219 void object_iterate_since_last_GC(ObjectClosure* cl);
220 Space* space_containing(const void* addr) const;
222 // A CollectedHeap is divided into a dense sequence of "blocks"; that is,
223 // each address in the (reserved) heap is a member of exactly
224 // one block. The defining characteristic of a block is that it is
225 // possible to find its size, and thus to progress forward to the next
226 // block. (Blocks may be of different sizes.) Thus, blocks may
227 // represent Java objects, or they might be free blocks in a
228 // free-list-based heap (or subheap), as long as the two kinds are
229 // distinguishable and the size of each is determinable.
231 // Returns the address of the start of the "block" that contains the
232 // address "addr". We say "blocks" instead of "object" since some heaps
233 // may not pack objects densely; a chunk may either be an object or a
234 // non-object.
235 virtual HeapWord* block_start(const void* addr) const;
237 // Requires "addr" to be the start of a chunk, and returns its size.
238 // "addr + size" is required to be the start of a new chunk, or the end
239 // of the active area of the heap. Assumes (and verifies in non-product
240 // builds) that addr is in the allocated part of the heap and is
241 // the start of a chunk.
242 virtual size_t block_size(const HeapWord* addr) const;
244 // Requires "addr" to be the start of a block, and returns "TRUE" iff
245 // the block is an object. Assumes (and verifies in non-product
246 // builds) that addr is in the allocated part of the heap and is
247 // the start of a chunk.
248 virtual bool block_is_obj(const HeapWord* addr) const;
250 // Section on TLAB's.
251 virtual bool supports_tlab_allocation() const;
252 virtual size_t tlab_capacity(Thread* thr) const;
253 virtual size_t unsafe_max_tlab_alloc(Thread* thr) const;
254 virtual HeapWord* allocate_new_tlab(size_t size);
256 // Can a compiler initialize a new object without store barriers?
257 // This permission only extends from the creation of a new object
258 // via a TLAB up to the first subsequent safepoint.
259 virtual bool can_elide_tlab_store_barriers() const {
260 return true;
261 }
263 // Can a compiler elide a store barrier when it writes
264 // a permanent oop into the heap? Applies when the compiler
265 // is storing x to the heap, where x->is_perm() is true.
266 virtual bool can_elide_permanent_oop_store_barriers() const {
267 // CMS needs to see all, even intra-generational, ref updates.
268 return !UseConcMarkSweepGC;
269 }
271 // The "requestor" generation is performing some garbage collection
272 // action for which it would be useful to have scratch space. The
273 // requestor promises to allocate no more than "max_alloc_words" in any
274 // older generation (via promotion say.) Any blocks of space that can
275 // be provided are returned as a list of ScratchBlocks, sorted by
276 // decreasing size.
277 ScratchBlock* gather_scratch(Generation* requestor, size_t max_alloc_words);
278 // Allow each generation to reset any scratch space that it has
279 // contributed as it needs.
280 void release_scratch();
282 size_t large_typearray_limit();
284 // Ensure parsability: override
285 virtual void ensure_parsability(bool retire_tlabs);
287 // Time in ms since the longest time a collector ran in
288 // in any generation.
289 virtual jlong millis_since_last_gc();
291 // Total number of full collections completed.
292 unsigned int total_full_collections_completed() {
293 assert(_full_collections_completed <= _total_full_collections,
294 "Can't complete more collections than were started");
295 return _full_collections_completed;
296 }
298 // Update above counter, as appropriate, at the end of a stop-world GC cycle
299 unsigned int update_full_collections_completed();
300 // Update above counter, as appropriate, at the end of a concurrent GC cycle
301 unsigned int update_full_collections_completed(unsigned int count);
303 // Update "time of last gc" for all constituent generations
304 // to "now".
305 void update_time_of_last_gc(jlong now) {
306 for (int i = 0; i < _n_gens; i++) {
307 _gens[i]->update_time_of_last_gc(now);
308 }
309 perm_gen()->update_time_of_last_gc(now);
310 }
312 // Update the gc statistics for each generation.
313 // "level" is the level of the lastest collection
314 void update_gc_stats(int current_level, bool full) {
315 for (int i = 0; i < _n_gens; i++) {
316 _gens[i]->update_gc_stats(current_level, full);
317 }
318 perm_gen()->update_gc_stats(current_level, full);
319 }
321 // Override.
322 bool no_gc_in_progress() { return !is_gc_active(); }
324 // Override.
325 void prepare_for_verify();
327 // Override.
328 void verify(bool allow_dirty, bool silent);
330 // Override.
331 void print() const;
332 void print_on(outputStream* st) const;
333 virtual void print_gc_threads_on(outputStream* st) const;
334 virtual void gc_threads_do(ThreadClosure* tc) const;
335 virtual void print_tracing_info() const;
337 // PrintGC, PrintGCDetails support
338 void print_heap_change(size_t prev_used) const;
339 void print_perm_heap_change(size_t perm_prev_used) const;
341 // The functions below are helper functions that a subclass of
342 // "CollectedHeap" can use in the implementation of its virtual
343 // functions.
345 class GenClosure : public StackObj {
346 public:
347 virtual void do_generation(Generation* gen) = 0;
348 };
350 // Apply "cl.do_generation" to all generations in the heap (not including
351 // the permanent generation). If "old_to_young" determines the order.
352 void generation_iterate(GenClosure* cl, bool old_to_young);
354 void space_iterate(SpaceClosure* cl);
356 // Return "true" if all generations (but perm) have reached the
357 // maximal committed limit that they can reach, without a garbage
358 // collection.
359 virtual bool is_maximal_no_gc() const;
361 // Return the generation before "gen", or else NULL.
362 Generation* prev_gen(Generation* gen) const {
363 int l = gen->level();
364 if (l == 0) return NULL;
365 else return _gens[l-1];
366 }
368 // Return the generation after "gen", or else NULL.
369 Generation* next_gen(Generation* gen) const {
370 int l = gen->level() + 1;
371 if (l == _n_gens) return NULL;
372 else return _gens[l];
373 }
375 Generation* get_gen(int i) const {
376 if (i >= 0 && i < _n_gens)
377 return _gens[i];
378 else
379 return NULL;
380 }
382 int n_gens() const {
383 assert(_n_gens == gen_policy()->number_of_generations(), "Sanity");
384 return _n_gens;
385 }
387 // Convenience function to be used in situations where the heap type can be
388 // asserted to be this type.
389 static GenCollectedHeap* heap();
391 void set_par_threads(int t);
394 // Invoke the "do_oop" method of one of the closures "not_older_gens"
395 // or "older_gens" on root locations for the generation at
396 // "level". (The "older_gens" closure is used for scanning references
397 // from older generations; "not_older_gens" is used everywhere else.)
398 // If "younger_gens_as_roots" is false, younger generations are
399 // not scanned as roots; in this case, the caller must be arranging to
400 // scan the younger generations itself. (For example, a generation might
401 // explicitly mark reachable objects in younger generations, to avoid
402 // excess storage retention.) If "collecting_perm_gen" is false, then
403 // roots that may only contain references to permGen objects are not
404 // scanned. The "so" argument determines which of the roots
405 // the closure is applied to:
406 // "SO_None" does none;
407 // "SO_AllClasses" applies the closure to all entries in the SystemDictionary;
408 // "SO_SystemClasses" to all the "system" classes and loaders;
409 // "SO_Symbols_and_Strings" applies the closure to all entries in
410 // SymbolsTable and StringTable.
411 void gen_process_strong_roots(int level, bool younger_gens_as_roots,
412 bool collecting_perm_gen,
413 SharedHeap::ScanningOption so,
414 OopsInGenClosure* older_gens,
415 OopsInGenClosure* not_older_gens);
417 // Apply "blk" to all the weak roots of the system. These include
418 // JNI weak roots, the code cache, system dictionary, symbol table,
419 // string table, and referents of reachable weak refs.
420 void gen_process_weak_roots(OopClosure* root_closure,
421 OopClosure* non_root_closure);
423 // Set the saved marks of generations, if that makes sense.
424 // In particular, if any generation might iterate over the oops
425 // in other generations, it should call this method.
426 void save_marks();
428 // Apply "cur->do_oop" or "older->do_oop" to all the oops in objects
429 // allocated since the last call to save_marks in generations at or above
430 // "level" (including the permanent generation.) The "cur" closure is
431 // applied to references in the generation at "level", and the "older"
432 // closure to older (and permanent) generations.
433 #define GCH_SINCE_SAVE_MARKS_ITERATE_DECL(OopClosureType, nv_suffix) \
434 void oop_since_save_marks_iterate(int level, \
435 OopClosureType* cur, \
436 OopClosureType* older);
438 ALL_SINCE_SAVE_MARKS_CLOSURES(GCH_SINCE_SAVE_MARKS_ITERATE_DECL)
440 #undef GCH_SINCE_SAVE_MARKS_ITERATE_DECL
442 // Returns "true" iff no allocations have occurred in any generation at
443 // "level" or above (including the permanent generation) since the last
444 // call to "save_marks".
445 bool no_allocs_since_save_marks(int level);
447 // If a generation bails out of an incremental collection,
448 // it sets this flag.
449 bool incremental_collection_will_fail() {
450 return _incremental_collection_will_fail;
451 }
452 void set_incremental_collection_will_fail() {
453 _incremental_collection_will_fail = true;
454 }
455 void clear_incremental_collection_will_fail() {
456 _incremental_collection_will_fail = false;
457 }
459 bool last_incremental_collection_failed() const {
460 return _last_incremental_collection_failed;
461 }
462 void set_last_incremental_collection_failed() {
463 _last_incremental_collection_failed = true;
464 }
465 void clear_last_incremental_collection_failed() {
466 _last_incremental_collection_failed = false;
467 }
469 // Promotion of obj into gen failed. Try to promote obj to higher non-perm
470 // gens in ascending order; return the new location of obj if successful.
471 // Otherwise, try expand-and-allocate for obj in each generation starting at
472 // gen; return the new location of obj if successful. Otherwise, return NULL.
473 oop handle_failed_promotion(Generation* gen,
474 oop obj,
475 size_t obj_size);
477 private:
478 // Accessor for memory state verification support
479 NOT_PRODUCT(
480 static size_t skip_header_HeapWords() { return _skip_header_HeapWords; }
481 )
483 // Override
484 void check_for_non_bad_heap_word_value(HeapWord* addr,
485 size_t size) PRODUCT_RETURN;
487 // For use by mark-sweep. As implemented, mark-sweep-compact is global
488 // in an essential way: compaction is performed across generations, by
489 // iterating over spaces.
490 void prepare_for_compaction();
492 // Perform a full collection of the first max_level+1 generations.
493 // This is the low level interface used by the public versions of
494 // collect() and collect_locked(). Caller holds the Heap_lock on entry.
495 void collect_locked(GCCause::Cause cause, int max_level);
497 // Returns success or failure.
498 bool create_cms_collector();
500 // In support of ExplicitGCInvokesConcurrent functionality
501 bool should_do_concurrent_full_gc(GCCause::Cause cause);
502 void collect_mostly_concurrent(GCCause::Cause cause);
504 // Save the tops of the spaces in all generations
505 void record_gen_tops_before_GC() PRODUCT_RETURN;
507 protected:
508 virtual void gc_prologue(bool full);
509 virtual void gc_epilogue(bool full);
511 public:
512 virtual void preload_and_dump(TRAPS) KERNEL_RETURN;
513 };