1 /*
  2  * Copyright (c) 1997, 2021, 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 #include "precompiled.hpp"
 26 #include "cds/heapShared.inline.hpp"
 27 #include "classfile/altHashing.hpp"
 28 #include "classfile/javaClasses.inline.hpp"
 29 #include "memory/resourceArea.hpp"
 30 #include "memory/universe.hpp"
 31 #include "oops/access.inline.hpp"
 32 #include "oops/compressedOops.inline.hpp"
 33 #include "oops/oop.inline.hpp"
 34 #include "oops/verifyOopClosure.hpp"
 35 #include "runtime/handles.inline.hpp"
 36 #include "runtime/thread.inline.hpp"
 37 #include "utilities/copy.hpp"
 38 #include "utilities/macros.hpp"
 39 
 40 void oopDesc::print_on(outputStream* st) const {
 41   klass()->oop_print_on(const_cast<oopDesc*>(this), st);
 42 }
 43 
 44 void oopDesc::print_address_on(outputStream* st) const {
 45   st->print("{" INTPTR_FORMAT "}", p2i(this));
 46 
 47 }
 48 
 49 void oopDesc::print()         { print_on(tty);         }
 50 
 51 void oopDesc::print_address() { print_address_on(tty); }
 52 
 53 char* oopDesc::print_string() {
 54   stringStream st;
 55   print_on(&st);
 56   return st.as_string();
 57 }
 58 
 59 void oopDesc::print_value() {
 60   print_value_on(tty);
 61 }
 62 
 63 char* oopDesc::print_value_string() {
 64   char buf[100];
 65   stringStream st(buf, sizeof(buf));
 66   print_value_on(&st);
 67   return st.as_string();
 68 }
 69 
 70 void oopDesc::print_value_on(outputStream* st) const {
 71   oop obj = const_cast<oopDesc*>(this);
 72   if (java_lang_String::is_instance(obj)) {
 73     java_lang_String::print(obj, st);
 74     print_address_on(st);
 75   } else {
 76     klass()->oop_print_value_on(obj, st);
 77   }
 78 }
 79 
 80 
 81 void oopDesc::verify_on(outputStream* st, oopDesc* oop_desc) {
 82   if (oop_desc != NULL) {
 83     oop_desc->klass()->oop_verify_on(oop_desc, st);
 84   }
 85 }
 86 
 87 
 88 void oopDesc::verify(oopDesc* oop_desc) {
 89   verify_on(tty, oop_desc);
 90 }
 91 
 92 intptr_t oopDesc::slow_identity_hash() {
 93   // slow case; we have to acquire the micro lock in order to locate the header
 94   Thread* current = Thread::current();
 95   ResetNoHandleMark rnm; // Might be called from LEAF/QUICK ENTRY
 96   HandleMark hm(current);
 97   Handle object(current, this);
 98   return ObjectSynchronizer::identity_hash_value_for(object);
 99 }
100 
101 // used only for asserts and guarantees
102 bool oopDesc::is_oop(oop obj, bool ignore_mark_word) {
103   if (!Universe::heap()->is_oop(obj)) {
104     return false;
105   }
106 
107   // Header verification: the mark is typically non-zero. If we're
108   // at a safepoint, it must not be zero, except when using the new lightweight locking.
109   // Outside of a safepoint, the header could be changing (for example,
110   // another thread could be inflating a lock on this object).
111   if (ignore_mark_word) {
112     return true;
113   }
114   if (obj->mark().value() != 0) {
115     return true;
116   }
117   return LockingMode == LM_LIGHTWEIGHT || !SafepointSynchronize::is_at_safepoint();
118 }
119 
120 // used only for asserts and guarantees
121 bool oopDesc::is_oop_or_null(oop obj, bool ignore_mark_word) {
122   return obj == NULL ? true : is_oop(obj, ignore_mark_word);
123 }
124 
125 VerifyOopClosure VerifyOopClosure::verify_oop;
126 
127 template <class T> void VerifyOopClosure::do_oop_work(T* p) {
128   oop obj = RawAccess<>::oop_load(p);
129   guarantee(oopDesc::is_oop_or_null(obj), "invalid oop: " INTPTR_FORMAT, p2i((oopDesc*) obj));
130 }
131 
132 void VerifyOopClosure::do_oop(oop* p)       { VerifyOopClosure::do_oop_work(p); }
133 void VerifyOopClosure::do_oop(narrowOop* p) { VerifyOopClosure::do_oop_work(p); }
134 
135 // type test operations that doesn't require inclusion of oop.inline.hpp.
136 bool oopDesc::is_instance_noinline()          const { return is_instance();            }
137 bool oopDesc::is_array_noinline()             const { return is_array();               }
138 bool oopDesc::is_objArray_noinline()          const { return is_objArray();            }
139 bool oopDesc::is_typeArray_noinline()         const { return is_typeArray();           }
140 
141 bool oopDesc::has_klass_gap() {
142   // Only has a klass gap when compressed class pointers are used, but
143   // only if not using compact headers..
144   return UseCompressedClassPointers && !UseCompactObjectHeaders;
145 }
146 
147 #if INCLUDE_CDS_JAVA_HEAP
148 void oopDesc::set_narrow_klass(narrowKlass nk) {
149   assert(DumpSharedSpaces, "Used by CDS only. Do not abuse!");
150   assert(UseCompressedClassPointers, "must be");
151   assert(!UseCompactObjectHeaders, "not with compact headers");
152   _metadata._compressed_klass = nk;
153 }
154 #endif
155 
156 void* oopDesc::load_klass_raw(oop obj) {
157   // TODO: Remove method altogether and replace with calls to obj->klass() ?
158   // OTOH, we may eventually get rid of locking in header, and then no
159   // longer have to deal with that anymore.
160 #ifdef _LP64
161   return obj->klass();
162 #else
163   return obj->_metadata._klass;
164 #endif
165 }
166 
167 void* oopDesc::load_oop_raw(oop obj, int offset) {
168   uintptr_t addr = (uintptr_t)(void*)obj + (uint)offset;
169   if (UseCompressedOops) {
170     narrowOop narrow_oop = *(narrowOop*)addr;
171     if (CompressedOops::is_null(narrow_oop)) return NULL;
172     return (void*)CompressedOops::decode_raw(narrow_oop);
173   } else {
174     return *(void**)addr;
175   }
176 }
177 
178 oop oopDesc::obj_field_acquire(int offset) const                      { return HeapAccess<MO_ACQUIRE>::oop_load_at(as_oop(), offset); }
179 
180 void oopDesc::obj_field_put_raw(int offset, oop value)                { RawAccess<>::oop_store_at(as_oop(), offset, value); }
181 void oopDesc::release_obj_field_put(int offset, oop value)            { HeapAccess<MO_RELEASE>::oop_store_at(as_oop(), offset, value); }
182 void oopDesc::obj_field_put_volatile(int offset, oop value)           { HeapAccess<MO_SEQ_CST>::oop_store_at(as_oop(), offset, value); }
183 
184 address oopDesc::address_field(int offset) const                      { return HeapAccess<>::load_at(as_oop(), offset); }
185 address oopDesc::address_field_acquire(int offset) const              { return HeapAccess<MO_ACQUIRE>::load_at(as_oop(), offset); }
186 
187 void oopDesc::address_field_put(int offset, address value)            { HeapAccess<>::store_at(as_oop(), offset, value); }
188 void oopDesc::release_address_field_put(int offset, address value)    { HeapAccess<MO_RELEASE>::store_at(as_oop(), offset, value); }
189 
190 Metadata* oopDesc::metadata_field(int offset) const                   { return HeapAccess<>::load_at(as_oop(), offset); }
191 Metadata* oopDesc::metadata_field_raw(int offset) const               { return RawAccess<>::load_at(as_oop(), offset); }
192 void oopDesc::metadata_field_put(int offset, Metadata* value)         { HeapAccess<>::store_at(as_oop(), offset, value); }
193 
194 Metadata* oopDesc::metadata_field_acquire(int offset) const           { return HeapAccess<MO_ACQUIRE>::load_at(as_oop(), offset); }
195 void oopDesc::release_metadata_field_put(int offset, Metadata* value) { HeapAccess<MO_RELEASE>::store_at(as_oop(), offset, value); }
196 
197 jbyte oopDesc::byte_field_acquire(int offset) const                   { return HeapAccess<MO_ACQUIRE>::load_at(as_oop(), offset); }
198 void oopDesc::release_byte_field_put(int offset, jbyte value)         { HeapAccess<MO_RELEASE>::store_at(as_oop(), offset, value); }
199 
200 jchar oopDesc::char_field_acquire(int offset) const                   { return HeapAccess<MO_ACQUIRE>::load_at(as_oop(), offset); }
201 void oopDesc::release_char_field_put(int offset, jchar value)         { HeapAccess<MO_RELEASE>::store_at(as_oop(), offset, value); }
202 
203 jboolean oopDesc::bool_field_acquire(int offset) const                { return HeapAccess<MO_ACQUIRE>::load_at(as_oop(), offset); }
204 void oopDesc::release_bool_field_put(int offset, jboolean value)      { HeapAccess<MO_RELEASE>::store_at(as_oop(), offset, jboolean(value & 1)); }
205 
206 jint oopDesc::int_field_acquire(int offset) const                     { return HeapAccess<MO_ACQUIRE>::load_at(as_oop(), offset); }
207 void oopDesc::release_int_field_put(int offset, jint value)           { HeapAccess<MO_RELEASE>::store_at(as_oop(), offset, value); }
208 
209 jshort oopDesc::short_field_acquire(int offset) const                 { return HeapAccess<MO_ACQUIRE>::load_at(as_oop(), offset); }
210 void oopDesc::release_short_field_put(int offset, jshort value)       { HeapAccess<MO_RELEASE>::store_at(as_oop(), offset, value); }
211 
212 jlong oopDesc::long_field_acquire(int offset) const                   { return HeapAccess<MO_ACQUIRE>::load_at(as_oop(), offset); }
213 void oopDesc::release_long_field_put(int offset, jlong value)         { HeapAccess<MO_RELEASE>::store_at(as_oop(), offset, value); }
214 
215 jfloat oopDesc::float_field_acquire(int offset) const                 { return HeapAccess<MO_ACQUIRE>::load_at(as_oop(), offset); }
216 void oopDesc::release_float_field_put(int offset, jfloat value)       { HeapAccess<MO_RELEASE>::store_at(as_oop(), offset, value); }
217 
218 jdouble oopDesc::double_field_acquire(int offset) const               { return HeapAccess<MO_ACQUIRE>::load_at(as_oop(), offset); }
219 void oopDesc::release_double_field_put(int offset, jdouble value)     { HeapAccess<MO_RELEASE>::store_at(as_oop(), offset, value); }
220 
221 #ifdef ASSERT
222 void oopDesc::verify_forwardee(oop forwardee) {
223 #if INCLUDE_CDS_JAVA_HEAP
224   assert(!HeapShared::is_archived_object(forwardee) && !HeapShared::is_archived_object(this),
225          "forwarding archive object");
226 #endif
227 }
228 
229 bool oopDesc::get_UseParallelGC() { return UseParallelGC; }
230 bool oopDesc::get_UseG1GC()       { return UseG1GC;       }
231 #endif