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  */
  24 
  25 #ifndef SHARE_VM_GC_INTERFACE_COLLECTEDHEAP_INLINE_HPP
  26 #define SHARE_VM_GC_INTERFACE_COLLECTEDHEAP_INLINE_HPP
  27 
  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
  49 
  50 // Inline allocation implementations.
  51 
  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 }
  57 
  58 void CollectedHeap::post_allocation_setup_no_klass_install(KlassHandle klass,
  59                                                            HeapWord* objPtr) {
  60   oop obj = (oop)objPtr;
  61 
  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 }
  70 
  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(obj != NULL, "NULL object pointer");
  78   obj->set_klass(klass());
  79   assert(!Universe::is_fully_initialized() || obj->klass() != NULL,
  80          "missing klass");
  81 }
  82 
  83 // Support for jvmti and dtrace
  84 inline void post_allocation_notify(KlassHandle klass, oop obj) {
  85   // support low memory notifications (no-op if not enabled)
  86   LowMemoryDetector::detect_low_memory_for_collected_pools();
  87 
  88   // support for JVMTI VMObjectAlloc event (no-op if not enabled)
  89   JvmtiExport::vm_object_alloc_event_collector(obj);
  90 
  91   if (DTraceAllocProbes) {
  92     // support for Dtrace object alloc event (no-op most of the time)
  93     if (klass() != NULL && klass()->name() != NULL) {
  94       SharedRuntime::dtrace_object_alloc(obj);
  95     }
  96   }
  97 }
  98 
  99 void CollectedHeap::post_allocation_setup_obj(KlassHandle klass,
 100                                               HeapWord* obj) {
 101   post_allocation_setup_common(klass, obj);
 102   assert(Universe::is_bootstrapping() ||
 103          !((oop)obj)->is_array(), "must not be an array");
 104   // notify jvmti and dtrace
 105   post_allocation_notify(klass, (oop)obj);
 106 }
 107 
 108 void CollectedHeap::post_allocation_setup_array(KlassHandle klass,
 109                                                 HeapWord* obj,
 110                                                 int length) {
 111   // Set array length before setting the _klass field
 112   // in post_allocation_setup_common() because the klass field
 113   // indicates that the object is parsable by concurrent GC.
 114   assert(length >= 0, "length should be non-negative");
 115   ((arrayOop)obj)->set_length(length);
 116   post_allocation_setup_common(klass, obj);
 117   assert(((oop)obj)->is_array(), "must be an array");
 118   // notify jvmti and dtrace (must be after length is set for dtrace)
 119   post_allocation_notify(klass, (oop)obj);
 120 }
 121 
 122 HeapWord* CollectedHeap::common_mem_allocate_noinit(size_t size, TRAPS) {
 123 
 124   // Clear unhandled oops for memory allocation.  Memory allocation might
 125   // not take out a lock if from tlab, so clear here.
 126   CHECK_UNHANDLED_OOPS_ONLY(THREAD->clear_unhandled_oops();)
 127 
 128   if (HAS_PENDING_EXCEPTION) {
 129     NOT_PRODUCT(guarantee(false, "Should not allocate with exception pending"));
 130     return NULL;  // caller does a CHECK_0 too
 131   }
 132 
 133   HeapWord* result = NULL;
 134   if (UseTLAB) {
 135     result = CollectedHeap::allocate_from_tlab(THREAD, size);
 136     if (result != NULL) {
 137       assert(!HAS_PENDING_EXCEPTION,
 138              "Unexpected exception, will result in uninitialized storage");
 139       return result;
 140     }
 141   }
 142   bool gc_overhead_limit_was_exceeded = false;
 143   result = Universe::heap()->mem_allocate(size,
 144                                           &gc_overhead_limit_was_exceeded);
 145   if (result != NULL) {
 146     NOT_PRODUCT(Universe::heap()->
 147       check_for_non_bad_heap_word_value(result, size));
 148     assert(!HAS_PENDING_EXCEPTION,
 149            "Unexpected exception, will result in uninitialized storage");
 150     THREAD->incr_allocated_bytes(size * HeapWordSize);
 151     return result;
 152   }
 153 
 154 
 155   if (!gc_overhead_limit_was_exceeded) {
 156     // -XX:+HeapDumpOnOutOfMemoryError and -XX:OnOutOfMemoryError support
 157     report_java_out_of_memory("Java heap space");
 158 
 159     if (JvmtiExport::should_post_resource_exhausted()) {
 160       JvmtiExport::post_resource_exhausted(
 161         JVMTI_RESOURCE_EXHAUSTED_OOM_ERROR | JVMTI_RESOURCE_EXHAUSTED_JAVA_HEAP,
 162         "Java heap space");
 163     }
 164 
 165     THROW_OOP_0(Universe::out_of_memory_error_java_heap());
 166   } else {
 167     // -XX:+HeapDumpOnOutOfMemoryError and -XX:OnOutOfMemoryError support
 168     report_java_out_of_memory("GC overhead limit exceeded");
 169 
 170     if (JvmtiExport::should_post_resource_exhausted()) {
 171       JvmtiExport::post_resource_exhausted(
 172         JVMTI_RESOURCE_EXHAUSTED_OOM_ERROR | JVMTI_RESOURCE_EXHAUSTED_JAVA_HEAP,
 173         "GC overhead limit exceeded");
 174     }
 175 
 176     THROW_OOP_0(Universe::out_of_memory_error_gc_overhead_limit());
 177   }
 178 }
 179 
 180 HeapWord* CollectedHeap::common_mem_allocate_init(size_t size, TRAPS) {
 181   HeapWord* obj = common_mem_allocate_noinit(size, CHECK_NULL);
 182   init_obj(obj, size);
 183   return obj;
 184 }
 185 
 186 HeapWord* CollectedHeap::allocate_from_tlab(Thread* thread, size_t size) {
 187   assert(UseTLAB, "should use UseTLAB");
 188 
 189   HeapWord* obj = thread->tlab().allocate(size);
 190   if (obj != NULL) {
 191     return obj;
 192   }
 193   // Otherwise...
 194   return allocate_from_tlab_slow(thread, size);
 195 }
 196 
 197 void CollectedHeap::init_obj(HeapWord* obj, size_t size) {
 198   assert(obj != NULL, "cannot initialize NULL object");
 199   const size_t hs = oopDesc::header_size();
 200   assert(size >= hs, "unexpected object size");
 201   ((oop)obj)->set_klass_gap(0);
 202   Copy::fill_to_aligned_words(obj + hs, size - hs);
 203 }
 204 
 205 oop CollectedHeap::obj_allocate(KlassHandle klass, int size, TRAPS) {
 206   debug_only(check_for_valid_allocation_state());
 207   assert(!Universe::heap()->is_gc_active(), "Allocation during gc not allowed");
 208   assert(size >= 0, "int won't convert to size_t");
 209   HeapWord* obj = common_mem_allocate_init(size, CHECK_NULL);
 210   post_allocation_setup_obj(klass, obj);
 211   NOT_PRODUCT(Universe::heap()->check_for_bad_heap_word_value(obj, size));
 212   return (oop)obj;
 213 }
 214 
 215 oop CollectedHeap::array_allocate(KlassHandle klass,
 216                                   int size,
 217                                   int length,
 218                                   TRAPS) {
 219   debug_only(check_for_valid_allocation_state());
 220   assert(!Universe::heap()->is_gc_active(), "Allocation during gc not allowed");
 221   assert(size >= 0, "int won't convert to size_t");
 222   HeapWord* obj = common_mem_allocate_init(size, CHECK_NULL);
 223   post_allocation_setup_array(klass, obj, length);
 224   NOT_PRODUCT(Universe::heap()->check_for_bad_heap_word_value(obj, size));
 225   return (oop)obj;
 226 }
 227 
 228 oop CollectedHeap::array_allocate_nozero(KlassHandle klass,
 229                                          int size,
 230                                          int length,
 231                                          TRAPS) {
 232   debug_only(check_for_valid_allocation_state());
 233   assert(!Universe::heap()->is_gc_active(), "Allocation during gc not allowed");
 234   assert(size >= 0, "int won't convert to size_t");
 235   HeapWord* obj = common_mem_allocate_noinit(size, CHECK_NULL);
 236   ((oop)obj)->set_klass_gap(0);
 237   post_allocation_setup_array(klass, obj, length);
 238 #ifndef PRODUCT
 239   const size_t hs = oopDesc::header_size()+1;
 240   Universe::heap()->check_for_non_bad_heap_word_value(obj+hs, size-hs);
 241 #endif
 242   return (oop)obj;
 243 }
 244 
 245 // Returns "TRUE" if "p" is a method oop in the
 246 // current heap with high probability. NOTE: The main
 247 // current consumers of this interface are Forte::
 248 // and ThreadProfiler::. In these cases, the
 249 // interpreter frame from which "p" came, may be
 250 // under construction when sampled asynchronously, so
 251 // the clients want to check that it represents a
 252 // valid method before using it. Nonetheless since
 253 // the clients do not typically lock out GC, the
 254 // predicate is_valid_method() is not stable, so
 255 // it is possible that by the time "p" is used, it
 256 // is no longer valid.
 257 inline bool CollectedHeap::is_valid_method(Method* p) const {
 258   return
 259     p != NULL &&
 260 
 261     // Check whether "method" is metadata
 262     p->is_metadata() &&
 263 
 264     // See if GC is active; however, there is still an
 265     // apparently unavoidable window after this call
 266     // and before the client of this interface uses "p".
 267     // If the client chooses not to lock out GC, then
 268     // it's a risk the client must accept.
 269     !is_gc_active() &&
 270 
 271     // Check that p is a Method*.
 272     p->is_method();
 273 }
 274 
 275 inline void CollectedHeap::oop_iterate_no_header(OopClosure* cl) {
 276   NoHeaderExtendedOopClosure no_header_cl(cl);
 277   oop_iterate(&no_header_cl);
 278 }
 279 
 280 #ifndef PRODUCT
 281 
 282 inline bool
 283 CollectedHeap::promotion_should_fail(volatile size_t* count) {
 284   // Access to count is not atomic; the value does not have to be exact.
 285   if (PromotionFailureALot) {
 286     const size_t gc_num = total_collections();
 287     const size_t elapsed_gcs = gc_num - _promotion_failure_alot_gc_number;
 288     if (elapsed_gcs >= PromotionFailureALotInterval) {
 289       // Test for unsigned arithmetic wrap-around.
 290       if (++*count >= PromotionFailureALotCount) {
 291         *count = 0;
 292         return true;
 293       }
 294     }
 295   }
 296   return false;
 297 }
 298 
 299 inline bool CollectedHeap::promotion_should_fail() {
 300   return promotion_should_fail(&_promotion_failure_alot_count);
 301 }
 302 
 303 inline void CollectedHeap::reset_promotion_should_fail(volatile size_t* count) {
 304   if (PromotionFailureALot) {
 305     _promotion_failure_alot_gc_number = total_collections();
 306     *count = 0;
 307   }
 308 }
 309 
 310 inline void CollectedHeap::reset_promotion_should_fail() {
 311   reset_promotion_should_fail(&_promotion_failure_alot_count);
 312 }
 313 #endif  // #ifndef PRODUCT
 314 
 315 #endif // SHARE_VM_GC_INTERFACE_COLLECTEDHEAP_INLINE_HPP