Thu, 17 Jan 2013 19:04:48 -0800
8006537: Assert when dumping archive with default methods
Reviewed-by: coleenp
1 /*
2 * Copyright (c) 2001, 2012, 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 */
25 #ifndef SHARE_VM_MEMORY_COLLECTORPOLICY_HPP
26 #define SHARE_VM_MEMORY_COLLECTORPOLICY_HPP
28 #include "memory/allocation.hpp"
29 #include "memory/barrierSet.hpp"
30 #include "memory/generationSpec.hpp"
31 #include "memory/genRemSet.hpp"
33 // This class (or more correctly, subtypes of this class)
34 // are used to define global garbage collector attributes.
35 // This includes initialization of generations and any other
36 // shared resources they may need.
37 //
38 // In general, all flag adjustment and validation should be
39 // done in initialize_flags(), which is called prior to
40 // initialize_size_info().
41 //
42 // This class is not fully developed yet. As more collector(s)
43 // are added, it is expected that we will come across further
44 // behavior that requires global attention. The correct place
45 // to deal with those issues is this class.
47 // Forward declarations.
48 class GenCollectorPolicy;
49 class TwoGenerationCollectorPolicy;
50 class AdaptiveSizePolicy;
51 #ifndef SERIALGC
52 class ConcurrentMarkSweepPolicy;
53 class G1CollectorPolicy;
54 #endif // SERIALGC
56 class GCPolicyCounters;
57 class MarkSweepPolicy;
59 class CollectorPolicy : public CHeapObj<mtGC> {
60 protected:
61 GCPolicyCounters* _gc_policy_counters;
63 // Requires that the concrete subclass sets the alignment constraints
64 // before calling.
65 virtual void initialize_flags();
66 virtual void initialize_size_info();
68 size_t _initial_heap_byte_size;
69 size_t _max_heap_byte_size;
70 size_t _min_heap_byte_size;
72 size_t _min_alignment;
73 size_t _max_alignment;
75 // The sizing of the heap are controlled by a sizing policy.
76 AdaptiveSizePolicy* _size_policy;
78 // Set to true when policy wants soft refs cleared.
79 // Reset to false by gc after it clears all soft refs.
80 bool _should_clear_all_soft_refs;
81 // Set to true by the GC if the just-completed gc cleared all
82 // softrefs. This is set to true whenever a gc clears all softrefs, and
83 // set to false each time gc returns to the mutator. For example, in the
84 // ParallelScavengeHeap case the latter would be done toward the end of
85 // mem_allocate() where it returns op.result()
86 bool _all_soft_refs_clear;
88 CollectorPolicy() :
89 _min_alignment(1),
90 _max_alignment(1),
91 _initial_heap_byte_size(0),
92 _max_heap_byte_size(0),
93 _min_heap_byte_size(0),
94 _size_policy(NULL),
95 _should_clear_all_soft_refs(false),
96 _all_soft_refs_clear(false)
97 {}
99 public:
100 void set_min_alignment(size_t align) { _min_alignment = align; }
101 size_t min_alignment() { return _min_alignment; }
102 void set_max_alignment(size_t align) { _max_alignment = align; }
103 size_t max_alignment() { return _max_alignment; }
105 size_t initial_heap_byte_size() { return _initial_heap_byte_size; }
106 void set_initial_heap_byte_size(size_t v) { _initial_heap_byte_size = v; }
107 size_t max_heap_byte_size() { return _max_heap_byte_size; }
108 void set_max_heap_byte_size(size_t v) { _max_heap_byte_size = v; }
109 size_t min_heap_byte_size() { return _min_heap_byte_size; }
110 void set_min_heap_byte_size(size_t v) { _min_heap_byte_size = v; }
112 enum Name {
113 CollectorPolicyKind,
114 TwoGenerationCollectorPolicyKind,
115 ConcurrentMarkSweepPolicyKind,
116 ASConcurrentMarkSweepPolicyKind,
117 G1CollectorPolicyKind
118 };
120 AdaptiveSizePolicy* size_policy() { return _size_policy; }
121 bool should_clear_all_soft_refs() { return _should_clear_all_soft_refs; }
122 void set_should_clear_all_soft_refs(bool v) { _should_clear_all_soft_refs = v; }
123 // Returns the current value of _should_clear_all_soft_refs.
124 // _should_clear_all_soft_refs is set to false as a side effect.
125 bool use_should_clear_all_soft_refs(bool v);
126 bool all_soft_refs_clear() { return _all_soft_refs_clear; }
127 void set_all_soft_refs_clear(bool v) { _all_soft_refs_clear = v; }
129 // Called by the GC after Soft Refs have been cleared to indicate
130 // that the request in _should_clear_all_soft_refs has been fulfilled.
131 void cleared_all_soft_refs();
133 // Identification methods.
134 virtual GenCollectorPolicy* as_generation_policy() { return NULL; }
135 virtual TwoGenerationCollectorPolicy* as_two_generation_policy() { return NULL; }
136 virtual MarkSweepPolicy* as_mark_sweep_policy() { return NULL; }
137 #ifndef SERIALGC
138 virtual ConcurrentMarkSweepPolicy* as_concurrent_mark_sweep_policy() { return NULL; }
139 virtual G1CollectorPolicy* as_g1_policy() { return NULL; }
140 #endif // SERIALGC
141 // Note that these are not virtual.
142 bool is_generation_policy() { return as_generation_policy() != NULL; }
143 bool is_two_generation_policy() { return as_two_generation_policy() != NULL; }
144 bool is_mark_sweep_policy() { return as_mark_sweep_policy() != NULL; }
145 #ifndef SERIALGC
146 bool is_concurrent_mark_sweep_policy() { return as_concurrent_mark_sweep_policy() != NULL; }
147 bool is_g1_policy() { return as_g1_policy() != NULL; }
148 #else // SERIALGC
149 bool is_concurrent_mark_sweep_policy() { return false; }
150 bool is_g1_policy() { return false; }
151 #endif // SERIALGC
154 virtual BarrierSet::Name barrier_set_name() = 0;
155 virtual GenRemSet::Name rem_set_name() = 0;
157 // Create the remembered set (to cover the given reserved region,
158 // allowing breaking up into at most "max_covered_regions").
159 virtual GenRemSet* create_rem_set(MemRegion reserved,
160 int max_covered_regions);
162 // This method controls how a collector satisfies a request
163 // for a block of memory. "gc_time_limit_was_exceeded" will
164 // be set to true if the adaptive size policy determine that
165 // an excessive amount of time is being spent doing collections
166 // and caused a NULL to be returned. If a NULL is not returned,
167 // "gc_time_limit_was_exceeded" has an undefined meaning.
168 virtual HeapWord* mem_allocate_work(size_t size,
169 bool is_tlab,
170 bool* gc_overhead_limit_was_exceeded) = 0;
172 // This method controls how a collector handles one or more
173 // of its generations being fully allocated.
174 virtual HeapWord *satisfy_failed_allocation(size_t size, bool is_tlab) = 0;
175 // This method controls how a collector handles a metadata allocation
176 // failure.
177 virtual MetaWord* satisfy_failed_metadata_allocation(ClassLoaderData* loader_data,
178 size_t size,
179 Metaspace::MetadataType mdtype);
181 // Performace Counter support
182 GCPolicyCounters* counters() { return _gc_policy_counters; }
184 // Create the jstat counters for the GC policy. By default, policy's
185 // don't have associated counters, and we complain if this is invoked.
186 virtual void initialize_gc_policy_counters() {
187 ShouldNotReachHere();
188 }
190 virtual CollectorPolicy::Name kind() {
191 return CollectorPolicy::CollectorPolicyKind;
192 }
194 // Returns true if a collector has eden space with soft end.
195 virtual bool has_soft_ended_eden() {
196 return false;
197 }
199 };
201 class ClearedAllSoftRefs : public StackObj {
202 bool _clear_all_soft_refs;
203 CollectorPolicy* _collector_policy;
204 public:
205 ClearedAllSoftRefs(bool clear_all_soft_refs,
206 CollectorPolicy* collector_policy) :
207 _clear_all_soft_refs(clear_all_soft_refs),
208 _collector_policy(collector_policy) {}
210 ~ClearedAllSoftRefs() {
211 if (_clear_all_soft_refs) {
212 _collector_policy->cleared_all_soft_refs();
213 }
214 }
215 };
217 class GenCollectorPolicy : public CollectorPolicy {
218 protected:
219 size_t _min_gen0_size;
220 size_t _initial_gen0_size;
221 size_t _max_gen0_size;
223 GenerationSpec **_generations;
225 // Return true if an allocation should be attempted in the older
226 // generation if it fails in the younger generation. Return
227 // false, otherwise.
228 virtual bool should_try_older_generation_allocation(size_t word_size) const;
230 void initialize_flags();
231 void initialize_size_info();
233 // Try to allocate space by expanding the heap.
234 virtual HeapWord* expand_heap_and_allocate(size_t size, bool is_tlab);
236 // compute max heap alignment
237 size_t compute_max_alignment();
239 // Scale the base_size by NewRation according to
240 // result = base_size / (NewRatio + 1)
241 // and align by min_alignment()
242 size_t scale_by_NewRatio_aligned(size_t base_size);
244 // Bound the value by the given maximum minus the
245 // min_alignment.
246 size_t bound_minus_alignment(size_t desired_size, size_t maximum_size);
248 public:
249 // Accessors
250 size_t min_gen0_size() { return _min_gen0_size; }
251 void set_min_gen0_size(size_t v) { _min_gen0_size = v; }
252 size_t initial_gen0_size() { return _initial_gen0_size; }
253 void set_initial_gen0_size(size_t v) { _initial_gen0_size = v; }
254 size_t max_gen0_size() { return _max_gen0_size; }
255 void set_max_gen0_size(size_t v) { _max_gen0_size = v; }
257 virtual int number_of_generations() = 0;
259 virtual GenerationSpec **generations() {
260 assert(_generations != NULL, "Sanity check");
261 return _generations;
262 }
264 virtual GenCollectorPolicy* as_generation_policy() { return this; }
266 virtual void initialize_generations() = 0;
268 virtual void initialize_all() {
269 initialize_flags();
270 initialize_size_info();
271 initialize_generations();
272 }
274 HeapWord* mem_allocate_work(size_t size,
275 bool is_tlab,
276 bool* gc_overhead_limit_was_exceeded);
278 HeapWord *satisfy_failed_allocation(size_t size, bool is_tlab);
280 // Adaptive size policy
281 virtual void initialize_size_policy(size_t init_eden_size,
282 size_t init_promo_size,
283 size_t init_survivor_size);
284 };
286 // All of hotspot's current collectors are subtypes of this
287 // class. Currently, these collectors all use the same gen[0],
288 // but have different gen[1] types. If we add another subtype
289 // of CollectorPolicy, this class should be broken out into
290 // its own file.
292 class TwoGenerationCollectorPolicy : public GenCollectorPolicy {
293 protected:
294 size_t _min_gen1_size;
295 size_t _initial_gen1_size;
296 size_t _max_gen1_size;
298 void initialize_flags();
299 void initialize_size_info();
300 void initialize_generations() { ShouldNotReachHere(); }
302 public:
303 // Accessors
304 size_t min_gen1_size() { return _min_gen1_size; }
305 void set_min_gen1_size(size_t v) { _min_gen1_size = v; }
306 size_t initial_gen1_size() { return _initial_gen1_size; }
307 void set_initial_gen1_size(size_t v) { _initial_gen1_size = v; }
308 size_t max_gen1_size() { return _max_gen1_size; }
309 void set_max_gen1_size(size_t v) { _max_gen1_size = v; }
311 // Inherited methods
312 TwoGenerationCollectorPolicy* as_two_generation_policy() { return this; }
314 int number_of_generations() { return 2; }
315 BarrierSet::Name barrier_set_name() { return BarrierSet::CardTableModRef; }
316 GenRemSet::Name rem_set_name() { return GenRemSet::CardTable; }
318 virtual CollectorPolicy::Name kind() {
319 return CollectorPolicy::TwoGenerationCollectorPolicyKind;
320 }
322 // Returns true is gen0 sizes were adjusted
323 bool adjust_gen0_sizes(size_t* gen0_size_ptr, size_t* gen1_size_ptr,
324 size_t heap_size, size_t min_gen1_size);
325 };
327 class MarkSweepPolicy : public TwoGenerationCollectorPolicy {
328 protected:
329 void initialize_generations();
331 public:
332 MarkSweepPolicy();
334 MarkSweepPolicy* as_mark_sweep_policy() { return this; }
336 void initialize_gc_policy_counters();
337 };
339 #endif // SHARE_VM_MEMORY_COLLECTORPOLICY_HPP