Tue, 27 Mar 2012 10:29:59 +0200
7156764: Remove unused size parameter from some CollectedHeap methods
Summary: Some minor cleanups
Reviewed-by: tonyp, jwilhelm
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_GC_INTERFACE_COLLECTEDHEAP_INLINE_HPP
26 #define SHARE_VM_GC_INTERFACE_COLLECTEDHEAP_INLINE_HPP
28 #include "gc_interface/collectedHeap.hpp"
29 #include "memory/threadLocalAllocBuffer.inline.hpp"
30 #include "memory/universe.hpp"
31 #include "oops/arrayOop.hpp"
32 #include "prims/jvmtiExport.hpp"
33 #include "runtime/sharedRuntime.hpp"
34 #include "runtime/thread.hpp"
35 #include "services/lowMemoryDetector.hpp"
36 #include "utilities/copy.hpp"
37 #ifdef TARGET_OS_FAMILY_linux
38 # include "thread_linux.inline.hpp"
39 #endif
40 #ifdef TARGET_OS_FAMILY_solaris
41 # include "thread_solaris.inline.hpp"
42 #endif
43 #ifdef TARGET_OS_FAMILY_windows
44 # include "thread_windows.inline.hpp"
45 #endif
46 #ifdef TARGET_OS_FAMILY_bsd
47 # include "thread_bsd.inline.hpp"
48 #endif
50 // Inline allocation implementations.
52 void CollectedHeap::post_allocation_setup_common(KlassHandle klass,
53 HeapWord* obj) {
54 post_allocation_setup_no_klass_install(klass, obj);
55 post_allocation_install_obj_klass(klass, oop(obj));
56 }
58 void CollectedHeap::post_allocation_setup_no_klass_install(KlassHandle klass,
59 HeapWord* objPtr) {
60 oop obj = (oop)objPtr;
62 assert(obj != NULL, "NULL object pointer");
63 if (UseBiasedLocking && (klass() != NULL)) {
64 obj->set_mark(klass->prototype_header());
65 } else {
66 // May be bootstrapping
67 obj->set_mark(markOopDesc::prototype());
68 }
69 }
71 void CollectedHeap::post_allocation_install_obj_klass(KlassHandle klass,
72 oop obj) {
73 // These asserts are kind of complicated because of klassKlass
74 // and the beginning of the world.
75 assert(klass() != NULL || !Universe::is_fully_initialized(), "NULL klass");
76 assert(klass() == NULL || klass()->is_klass(), "not a klass");
77 assert(klass() == NULL || klass()->klass_part() != NULL, "not a klass");
78 assert(obj != NULL, "NULL object pointer");
79 obj->set_klass(klass());
80 assert(!Universe::is_fully_initialized() || obj->blueprint() != NULL,
81 "missing blueprint");
82 }
84 // Support for jvmti and dtrace
85 inline void post_allocation_notify(KlassHandle klass, oop obj) {
86 // support low memory notifications (no-op if not enabled)
87 LowMemoryDetector::detect_low_memory_for_collected_pools();
89 // support for JVMTI VMObjectAlloc event (no-op if not enabled)
90 JvmtiExport::vm_object_alloc_event_collector(obj);
92 if (DTraceAllocProbes) {
93 // support for Dtrace object alloc event (no-op most of the time)
94 if (klass() != NULL && klass()->klass_part()->name() != NULL) {
95 SharedRuntime::dtrace_object_alloc(obj);
96 }
97 }
98 }
100 void CollectedHeap::post_allocation_setup_obj(KlassHandle klass,
101 HeapWord* obj) {
102 post_allocation_setup_common(klass, obj);
103 assert(Universe::is_bootstrapping() ||
104 !((oop)obj)->blueprint()->oop_is_array(), "must not be an array");
105 // notify jvmti and dtrace
106 post_allocation_notify(klass, (oop)obj);
107 }
109 void CollectedHeap::post_allocation_setup_array(KlassHandle klass,
110 HeapWord* obj,
111 int length) {
112 // Set array length before setting the _klass field
113 // in post_allocation_setup_common() because the klass field
114 // indicates that the object is parsable by concurrent GC.
115 assert(length >= 0, "length should be non-negative");
116 ((arrayOop)obj)->set_length(length);
117 post_allocation_setup_common(klass, obj);
118 assert(((oop)obj)->blueprint()->oop_is_array(), "must be an array");
119 // notify jvmti and dtrace (must be after length is set for dtrace)
120 post_allocation_notify(klass, (oop)obj);
121 }
123 HeapWord* CollectedHeap::common_mem_allocate_noinit(size_t size, TRAPS) {
125 // Clear unhandled oops for memory allocation. Memory allocation might
126 // not take out a lock if from tlab, so clear here.
127 CHECK_UNHANDLED_OOPS_ONLY(THREAD->clear_unhandled_oops();)
129 if (HAS_PENDING_EXCEPTION) {
130 NOT_PRODUCT(guarantee(false, "Should not allocate with exception pending"));
131 return NULL; // caller does a CHECK_0 too
132 }
134 HeapWord* result = NULL;
135 if (UseTLAB) {
136 result = CollectedHeap::allocate_from_tlab(THREAD, size);
137 if (result != NULL) {
138 assert(!HAS_PENDING_EXCEPTION,
139 "Unexpected exception, will result in uninitialized storage");
140 return result;
141 }
142 }
143 bool gc_overhead_limit_was_exceeded = false;
144 result = Universe::heap()->mem_allocate(size,
145 &gc_overhead_limit_was_exceeded);
146 if (result != NULL) {
147 NOT_PRODUCT(Universe::heap()->
148 check_for_non_bad_heap_word_value(result, size));
149 assert(!HAS_PENDING_EXCEPTION,
150 "Unexpected exception, will result in uninitialized storage");
151 THREAD->incr_allocated_bytes(size * HeapWordSize);
152 return result;
153 }
156 if (!gc_overhead_limit_was_exceeded) {
157 // -XX:+HeapDumpOnOutOfMemoryError and -XX:OnOutOfMemoryError support
158 report_java_out_of_memory("Java heap space");
160 if (JvmtiExport::should_post_resource_exhausted()) {
161 JvmtiExport::post_resource_exhausted(
162 JVMTI_RESOURCE_EXHAUSTED_OOM_ERROR | JVMTI_RESOURCE_EXHAUSTED_JAVA_HEAP,
163 "Java heap space");
164 }
166 THROW_OOP_0(Universe::out_of_memory_error_java_heap());
167 } else {
168 // -XX:+HeapDumpOnOutOfMemoryError and -XX:OnOutOfMemoryError support
169 report_java_out_of_memory("GC overhead limit exceeded");
171 if (JvmtiExport::should_post_resource_exhausted()) {
172 JvmtiExport::post_resource_exhausted(
173 JVMTI_RESOURCE_EXHAUSTED_OOM_ERROR | JVMTI_RESOURCE_EXHAUSTED_JAVA_HEAP,
174 "GC overhead limit exceeded");
175 }
177 THROW_OOP_0(Universe::out_of_memory_error_gc_overhead_limit());
178 }
179 }
181 HeapWord* CollectedHeap::common_mem_allocate_init(size_t size, TRAPS) {
182 HeapWord* obj = common_mem_allocate_noinit(size, CHECK_NULL);
183 init_obj(obj, size);
184 return obj;
185 }
187 // Need to investigate, do we really want to throw OOM exception here?
188 HeapWord* CollectedHeap::common_permanent_mem_allocate_noinit(size_t size, TRAPS) {
189 if (HAS_PENDING_EXCEPTION) {
190 NOT_PRODUCT(guarantee(false, "Should not allocate with exception pending"));
191 return NULL; // caller does a CHECK_NULL too
192 }
194 #ifdef ASSERT
195 if (CIFireOOMAt > 0 && THREAD->is_Compiler_thread() &&
196 ++_fire_out_of_memory_count >= CIFireOOMAt) {
197 // For testing of OOM handling in the CI throw an OOM and see how
198 // it does. Historically improper handling of these has resulted
199 // in crashes which we really don't want to have in the CI.
200 THROW_OOP_0(Universe::out_of_memory_error_perm_gen());
201 }
202 #endif
204 HeapWord* result = Universe::heap()->permanent_mem_allocate(size);
205 if (result != NULL) {
206 NOT_PRODUCT(Universe::heap()->
207 check_for_non_bad_heap_word_value(result, size));
208 assert(!HAS_PENDING_EXCEPTION,
209 "Unexpected exception, will result in uninitialized storage");
210 return result;
211 }
212 // -XX:+HeapDumpOnOutOfMemoryError and -XX:OnOutOfMemoryError support
213 report_java_out_of_memory("PermGen space");
215 if (JvmtiExport::should_post_resource_exhausted()) {
216 JvmtiExport::post_resource_exhausted(
217 JVMTI_RESOURCE_EXHAUSTED_OOM_ERROR,
218 "PermGen space");
219 }
221 THROW_OOP_0(Universe::out_of_memory_error_perm_gen());
222 }
224 HeapWord* CollectedHeap::common_permanent_mem_allocate_init(size_t size, TRAPS) {
225 HeapWord* obj = common_permanent_mem_allocate_noinit(size, CHECK_NULL);
226 init_obj(obj, size);
227 return obj;
228 }
230 HeapWord* CollectedHeap::allocate_from_tlab(Thread* thread, size_t size) {
231 assert(UseTLAB, "should use UseTLAB");
233 HeapWord* obj = thread->tlab().allocate(size);
234 if (obj != NULL) {
235 return obj;
236 }
237 // Otherwise...
238 return allocate_from_tlab_slow(thread, size);
239 }
241 void CollectedHeap::init_obj(HeapWord* obj, size_t size) {
242 assert(obj != NULL, "cannot initialize NULL object");
243 const size_t hs = oopDesc::header_size();
244 assert(size >= hs, "unexpected object size");
245 ((oop)obj)->set_klass_gap(0);
246 Copy::fill_to_aligned_words(obj + hs, size - hs);
247 }
249 oop CollectedHeap::obj_allocate(KlassHandle klass, int size, TRAPS) {
250 debug_only(check_for_valid_allocation_state());
251 assert(!Universe::heap()->is_gc_active(), "Allocation during gc not allowed");
252 assert(size >= 0, "int won't convert to size_t");
253 HeapWord* obj = common_mem_allocate_init(size, CHECK_NULL);
254 post_allocation_setup_obj(klass, obj);
255 NOT_PRODUCT(Universe::heap()->check_for_bad_heap_word_value(obj, size));
256 return (oop)obj;
257 }
259 oop CollectedHeap::array_allocate(KlassHandle klass,
260 int size,
261 int length,
262 TRAPS) {
263 debug_only(check_for_valid_allocation_state());
264 assert(!Universe::heap()->is_gc_active(), "Allocation during gc not allowed");
265 assert(size >= 0, "int won't convert to size_t");
266 HeapWord* obj = common_mem_allocate_init(size, CHECK_NULL);
267 post_allocation_setup_array(klass, obj, length);
268 NOT_PRODUCT(Universe::heap()->check_for_bad_heap_word_value(obj, size));
269 return (oop)obj;
270 }
272 oop CollectedHeap::array_allocate_nozero(KlassHandle klass,
273 int size,
274 int length,
275 TRAPS) {
276 debug_only(check_for_valid_allocation_state());
277 assert(!Universe::heap()->is_gc_active(), "Allocation during gc not allowed");
278 assert(size >= 0, "int won't convert to size_t");
279 HeapWord* obj = common_mem_allocate_noinit(size, CHECK_NULL);
280 ((oop)obj)->set_klass_gap(0);
281 post_allocation_setup_array(klass, obj, length);
282 #ifndef PRODUCT
283 const size_t hs = oopDesc::header_size()+1;
284 Universe::heap()->check_for_non_bad_heap_word_value(obj+hs, size-hs);
285 #endif
286 return (oop)obj;
287 }
289 oop CollectedHeap::permanent_obj_allocate(KlassHandle klass, int size, TRAPS) {
290 oop obj = permanent_obj_allocate_no_klass_install(klass, size, CHECK_NULL);
291 post_allocation_install_obj_klass(klass, obj);
292 NOT_PRODUCT(Universe::heap()->check_for_bad_heap_word_value((HeapWord*) obj,
293 size));
294 return obj;
295 }
297 oop CollectedHeap::permanent_obj_allocate_no_klass_install(KlassHandle klass,
298 int size,
299 TRAPS) {
300 debug_only(check_for_valid_allocation_state());
301 assert(!Universe::heap()->is_gc_active(), "Allocation during gc not allowed");
302 assert(size >= 0, "int won't convert to size_t");
303 HeapWord* obj = common_permanent_mem_allocate_init(size, CHECK_NULL);
304 post_allocation_setup_no_klass_install(klass, obj);
305 #ifndef PRODUCT
306 const size_t hs = oopDesc::header_size();
307 Universe::heap()->check_for_bad_heap_word_value(obj+hs, size-hs);
308 #endif
309 return (oop)obj;
310 }
312 oop CollectedHeap::permanent_array_allocate(KlassHandle klass,
313 int size,
314 int length,
315 TRAPS) {
316 debug_only(check_for_valid_allocation_state());
317 assert(!Universe::heap()->is_gc_active(), "Allocation during gc not allowed");
318 assert(size >= 0, "int won't convert to size_t");
319 HeapWord* obj = common_permanent_mem_allocate_init(size, CHECK_NULL);
320 post_allocation_setup_array(klass, obj, length);
321 NOT_PRODUCT(Universe::heap()->check_for_bad_heap_word_value(obj, size));
322 return (oop)obj;
323 }
325 // Returns "TRUE" if "p" is a method oop in the
326 // current heap with high probability. NOTE: The main
327 // current consumers of this interface are Forte::
328 // and ThreadProfiler::. In these cases, the
329 // interpreter frame from which "p" came, may be
330 // under construction when sampled asynchronously, so
331 // the clients want to check that it represents a
332 // valid method before using it. Nonetheless since
333 // the clients do not typically lock out GC, the
334 // predicate is_valid_method() is not stable, so
335 // it is possible that by the time "p" is used, it
336 // is no longer valid.
337 inline bool CollectedHeap::is_valid_method(oop p) const {
338 return
339 p != NULL &&
341 // Check whether it is aligned at a HeapWord boundary.
342 Space::is_aligned(p) &&
344 // Check whether "method" is in the allocated part of the
345 // permanent generation -- this needs to be checked before
346 // p->klass() below to avoid a SEGV (but see below
347 // for a potential window of vulnerability).
348 is_permanent((void*)p) &&
350 // See if GC is active; however, there is still an
351 // apparently unavoidable window after this call
352 // and before the client of this interface uses "p".
353 // If the client chooses not to lock out GC, then
354 // it's a risk the client must accept.
355 !is_gc_active() &&
357 // Check that p is a methodOop.
358 p->klass() == Universe::methodKlassObj();
359 }
362 #ifndef PRODUCT
364 inline bool
365 CollectedHeap::promotion_should_fail(volatile size_t* count) {
366 // Access to count is not atomic; the value does not have to be exact.
367 if (PromotionFailureALot) {
368 const size_t gc_num = total_collections();
369 const size_t elapsed_gcs = gc_num - _promotion_failure_alot_gc_number;
370 if (elapsed_gcs >= PromotionFailureALotInterval) {
371 // Test for unsigned arithmetic wrap-around.
372 if (++*count >= PromotionFailureALotCount) {
373 *count = 0;
374 return true;
375 }
376 }
377 }
378 return false;
379 }
381 inline bool CollectedHeap::promotion_should_fail() {
382 return promotion_should_fail(&_promotion_failure_alot_count);
383 }
385 inline void CollectedHeap::reset_promotion_should_fail(volatile size_t* count) {
386 if (PromotionFailureALot) {
387 _promotion_failure_alot_gc_number = total_collections();
388 *count = 0;
389 }
390 }
392 inline void CollectedHeap::reset_promotion_should_fail() {
393 reset_promotion_should_fail(&_promotion_failure_alot_count);
394 }
395 #endif // #ifndef PRODUCT
397 #endif // SHARE_VM_GC_INTERFACE_COLLECTEDHEAP_INLINE_HPP