1 /*
2 * Copyright (c) 2015, 2023, 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_CLASSFILE_JAVACLASSES_INLINE_HPP
26 #define SHARE_CLASSFILE_JAVACLASSES_INLINE_HPP
27
28 #include "classfile/javaClasses.hpp"
29
30 #include "memory/referenceType.hpp"
31 #include "oops/access.inline.hpp"
32 #include "oops/instanceKlass.inline.hpp"
33 #include "oops/method.hpp"
34 #include "oops/oop.inline.hpp"
35 #include "oops/oopsHierarchy.hpp"
36 #include "oops/typeArrayOop.inline.hpp"
37
38 void java_lang_String::set_coder(oop string, jbyte coder) {
39 string->byte_field_put(_coder_offset, coder);
40 }
41
42 void java_lang_String::set_value(oop string, typeArrayOop buffer) {
43 string->obj_field_put(_value_offset, buffer);
44 }
45
46 bool java_lang_String::hash_is_set(oop java_string) {
47 return java_string->int_field(_hash_offset) != 0 || java_string->bool_field(_hashIsZero_offset) != 0;
48 }
49
50 // Accessors
51 bool java_lang_String::value_equals(typeArrayOop str_value1, typeArrayOop str_value2) {
52 return ((str_value1 == str_value2) ||
53 (str_value1->length() == str_value2->length() &&
54 (!memcmp(str_value1->base(T_BYTE),
55 str_value2->base(T_BYTE),
56 str_value2->length() * sizeof(jbyte)))));
57 }
58
59 typeArrayOop java_lang_String::value(oop java_string) {
60 assert(is_instance(java_string), "must be java_string");
61 return (typeArrayOop) java_string->obj_field(_value_offset);
62 }
63
64 typeArrayOop java_lang_String::value_no_keepalive(oop java_string) {
65 assert(is_instance(java_string), "must be java_string");
66 return (typeArrayOop) java_string->obj_field_access<AS_NO_KEEPALIVE>(_value_offset);
67 }
68
69 bool java_lang_String::is_latin1(oop java_string) {
70 assert(is_instance(java_string), "must be java_string");
71 jbyte coder = java_string->byte_field(_coder_offset);
72 assert(CompactStrings || coder == CODER_UTF16, "Must be UTF16 without CompactStrings");
73 return coder == CODER_LATIN1;
74 }
75
76 uint8_t* java_lang_String::flags_addr(oop java_string) {
77 assert(_initialized, "Must be initialized");
78 assert(is_instance(java_string), "Must be java string");
79 return java_string->field_addr<uint8_t>(_flags_offset);
80 }
81
82 bool java_lang_String::is_flag_set(oop java_string, uint8_t flag_mask) {
83 return (Atomic::load(flags_addr(java_string)) & flag_mask) != 0;
84 }
85
86 bool java_lang_String::deduplication_forbidden(oop java_string) {
87 return is_flag_set(java_string, _deduplication_forbidden_mask);
88 }
89
90 bool java_lang_String::deduplication_requested(oop java_string) {
91 return is_flag_set(java_string, _deduplication_requested_mask);
92 }
93
94 void java_lang_String::set_deduplication_forbidden(oop java_string) {
95 test_and_set_flag(java_string, _deduplication_forbidden_mask);
96 }
97
98 bool java_lang_String::test_and_set_deduplication_requested(oop java_string) {
99 return test_and_set_flag(java_string, _deduplication_requested_mask);
100 }
101
102 int java_lang_String::length(oop java_string, typeArrayOop value) {
103 assert(_initialized, "Must be initialized");
104 assert(is_instance(java_string), "must be java_string");
105 assert(value_equals(value, java_lang_String::value(java_string)),
106 "value must be equal to java_lang_String::value(java_string)");
107 if (value == nullptr) {
108 return 0;
109 }
110 int arr_length = value->length();
111 if (!is_latin1(java_string)) {
112 assert((arr_length & 1) == 0, "should be even for UTF16 string");
113 arr_length >>= 1; // convert number of bytes to number of elements
114 }
115 return arr_length;
116 }
117
118 int java_lang_String::length(oop java_string) {
119 assert(_initialized, "Must be initialized");
120 assert(is_instance(java_string), "must be java_string");
121 typeArrayOop value = java_lang_String::value_no_keepalive(java_string);
122 return length(java_string, value);
123 }
124
125 bool java_lang_String::is_instance(oop obj) {
126 return obj != nullptr && obj->klass() == vmClasses::String_klass();
127 }
128
129 // Accessors
130
131 oop java_lang_ref_Reference::weak_referent_no_keepalive(oop ref) {
132 assert(java_lang_ref_Reference::is_weak(ref) || java_lang_ref_Reference::is_soft(ref), "must be Weak or Soft Reference");
133 return ref->obj_field_access<ON_WEAK_OOP_REF | AS_NO_KEEPALIVE>(_referent_offset);
134 }
135
136 oop java_lang_ref_Reference::weak_referent(oop ref) {
137 assert(java_lang_ref_Reference::is_weak(ref) || java_lang_ref_Reference::is_soft(ref), "must be Weak or Soft Reference");
138 return ref->obj_field_access<ON_WEAK_OOP_REF>(_referent_offset);
139 }
140
141 oop java_lang_ref_Reference::phantom_referent_no_keepalive(oop ref) {
142 assert(java_lang_ref_Reference::is_phantom(ref), "must be Phantom Reference");
143 return ref->obj_field_access<ON_PHANTOM_OOP_REF | AS_NO_KEEPALIVE>(_referent_offset);
144 }
145
146 oop java_lang_ref_Reference::unknown_referent_no_keepalive(oop ref) {
147 return ref->obj_field_access<ON_UNKNOWN_OOP_REF | AS_NO_KEEPALIVE>(_referent_offset);
148 }
149
150 void java_lang_ref_Reference::clear_referent(oop ref) {
151 HeapAccess<ON_UNKNOWN_OOP_REF | AS_NO_KEEPALIVE>::oop_store_at(ref, _referent_offset, nullptr);
152 }
153
154 void java_lang_ref_Reference::clear_referent_raw(oop ref) {
155 ref->obj_field_put_raw(_referent_offset, nullptr);
156 }
157
158 HeapWord* java_lang_ref_Reference::referent_addr_raw(oop ref) {
159 return ref->field_addr<HeapWord>(_referent_offset);
160 }
161
162 oop java_lang_ref_Reference::next(oop ref) {
163 return ref->obj_field(_next_offset);
164 }
165
166 void java_lang_ref_Reference::set_next(oop ref, oop value) {
167 ref->obj_field_put(_next_offset, value);
168 }
169
170 void java_lang_ref_Reference::set_next_raw(oop ref, oop value) {
171 ref->obj_field_put_raw(_next_offset, value);
172 }
173
174 HeapWord* java_lang_ref_Reference::next_addr_raw(oop ref) {
175 return ref->field_addr<HeapWord>(_next_offset);
176 }
177
178 oop java_lang_ref_Reference::discovered(oop ref) {
179 return ref->obj_field(_discovered_offset);
180 }
181
182 void java_lang_ref_Reference::set_discovered(oop ref, oop value) {
183 ref->obj_field_put(_discovered_offset, value);
184 }
185
186 void java_lang_ref_Reference::set_discovered_raw(oop ref, oop value) {
187 ref->obj_field_put_raw(_discovered_offset, value);
188 }
189
190 HeapWord* java_lang_ref_Reference::discovered_addr_raw(oop ref) {
191 return ref->field_addr<HeapWord>(_discovered_offset);
192 }
193
194 bool java_lang_ref_Reference::is_final(oop ref) {
195 return InstanceKlass::cast(ref->klass())->reference_type() == REF_FINAL;
196 }
197
198 bool java_lang_ref_Reference::is_phantom(oop ref) {
199 return InstanceKlass::cast(ref->klass())->reference_type() == REF_PHANTOM;
200 }
201
202 bool java_lang_ref_Reference::is_weak(oop ref) {
203 return InstanceKlass::cast(ref->klass())->reference_type() == REF_WEAK;
204 }
205
206 bool java_lang_ref_Reference::is_soft(oop ref) {
207 return InstanceKlass::cast(ref->klass())->reference_type() == REF_SOFT;
208 }
209
210 inline oop java_lang_Thread::continuation(oop java_thread) {
211 return java_thread->obj_field(_continuation_offset);
212 }
213
214 inline int64_t java_lang_Thread::thread_id(oop java_thread) {
215 return java_thread->long_field(_tid_offset);
216 }
217
218 inline oop java_lang_VirtualThread::vthread_scope() {
219 oop base = vmClasses::VirtualThread_klass()->static_field_base_raw();
220 return base->obj_field(static_vthread_scope_offset);
221 }
222
223 inline ObjectWaiter* java_lang_VirtualThread::objectWaiter(oop vthread) {
224 return (ObjectWaiter*)vthread->address_field(_objectWaiter_offset);
225 }
226
227 inline void java_lang_VirtualThread::set_objectWaiter(oop vthread, ObjectWaiter* value) {
228 vthread->address_field_put(_objectWaiter_offset, (address)value);
229 }
230
231 #if INCLUDE_JFR
232 inline u2 java_lang_Thread::jfr_epoch(oop ref) {
233 return ref->short_field(_jfr_epoch_offset);
234 }
235
236 inline void java_lang_Thread::set_jfr_epoch(oop ref, u2 epoch) {
237 ref->short_field_put(_jfr_epoch_offset, epoch);
238 }
239 #endif // INCLUDE_JFR
240
241
242 inline void java_lang_invoke_CallSite::set_target_volatile(oop site, oop target) {
243 site->obj_field_put_volatile(_target_offset, target);
244 }
245
246 inline oop java_lang_invoke_CallSite::target(oop site) {
247 return site->obj_field(_target_offset);
248 }
249
250 inline void java_lang_invoke_CallSite::set_target(oop site, oop target) {
251 site->obj_field_put(_target_offset, target);
252 }
253
254 inline bool java_lang_invoke_CallSite::is_instance(oop obj) {
255 return obj != nullptr && is_subclass(obj->klass());
256 }
257
258 inline jboolean java_lang_invoke_ConstantCallSite::is_frozen(oop site) {
259 return site->bool_field(_is_frozen_offset);
260 }
261
262 inline bool java_lang_invoke_ConstantCallSite::is_instance(oop obj) {
263 return obj != nullptr && is_subclass(obj->klass());
264 }
265
266 inline bool java_lang_invoke_MethodHandleNatives_CallSiteContext::is_instance(oop obj) {
267 return obj != nullptr && is_subclass(obj->klass());
268 }
269
270 inline bool java_lang_invoke_MemberName::is_instance(oop obj) {
271 return obj != nullptr && obj->klass() == vmClasses::MemberName_klass();
272 }
273
274 inline bool java_lang_invoke_ResolvedMethodName::is_instance(oop obj) {
275 return obj != nullptr && obj->klass() == vmClasses::ResolvedMethodName_klass();
276 }
277
278 inline bool java_lang_invoke_MethodType::is_instance(oop obj) {
279 return obj != nullptr && obj->klass() == vmClasses::MethodType_klass();
280 }
281
282 inline bool java_lang_invoke_MethodHandle::is_instance(oop obj) {
283 return obj != nullptr && is_subclass(obj->klass());
284 }
285
286 inline bool java_lang_Class::is_instance(oop obj) {
287 return obj != nullptr && obj->klass() == vmClasses::Class_klass();
288 }
289
290 inline Klass* java_lang_Class::as_Klass(oop java_class) {
291 //%note memory_2
292 assert(java_lang_Class::is_instance(java_class), "must be a Class object");
293 Klass* k = ((Klass*)java_class->metadata_field(_klass_offset));
294 assert(k == nullptr || k->is_klass(), "type check");
295 return k;
296 }
297
298 inline bool java_lang_Class::is_primitive(oop java_class) {
299 // should assert:
300 //assert(java_lang_Class::is_instance(java_class), "must be a Class object");
301 bool is_primitive = (java_class->metadata_field(_klass_offset) == nullptr);
302
303 #ifdef ASSERT
304 if (is_primitive) {
305 Klass* k = ((Klass*)java_class->metadata_field(_array_klass_offset));
306 assert(k == nullptr || is_java_primitive(ArrayKlass::cast(k)->element_type()),
307 "Should be either the T_VOID primitive or a java primitive");
308 }
309 #endif
310
311 return is_primitive;
312 }
313
314 inline size_t java_lang_Class::oop_size(oop java_class) {
315 assert(_oop_size_offset != 0, "must be set");
316 int size = java_class->int_field(_oop_size_offset);
317 assert(size > 0, "Oop size must be greater than zero, not %d", size);
318 return size;
319 }
320
321 inline bool java_lang_invoke_DirectMethodHandle::is_instance(oop obj) {
322 return obj != nullptr && is_subclass(obj->klass());
323 }
324
325 inline bool java_lang_Module::is_instance(oop obj) {
326 return obj != nullptr && obj->klass() == vmClasses::Module_klass();
327 }
328
329 inline int Backtrace::merge_bci_and_version(int bci, int version) {
330 // only store u2 for version, checking for overflow.
331 if (version > USHRT_MAX || version < 0) version = USHRT_MAX;
332 assert((u2)bci == bci, "bci should be short");
333 return build_int_from_shorts((u2)version, (u2)bci);
334 }
335
336 inline int Backtrace::merge_mid_and_cpref(int mid, int cpref) {
337 // only store u2 for mid and cpref, checking for overflow.
338 assert((u2)mid == mid, "mid should be short");
339 assert((u2)cpref == cpref, "cpref should be short");
340 return build_int_from_shorts((u2)cpref, (u2)mid);
341 }
342
343 inline int Backtrace::bci_at(unsigned int merged) {
344 return extract_high_short_from_int(merged);
345 }
346
347 inline int Backtrace::version_at(unsigned int merged) {
348 return extract_low_short_from_int(merged);
349 }
350
351 inline int Backtrace::mid_at(unsigned int merged) {
352 return extract_high_short_from_int(merged);
353 }
354
355 inline int Backtrace::cpref_at(unsigned int merged) {
356 return extract_low_short_from_int(merged);
357 }
358
359 inline int Backtrace::get_line_number(Method* method, int bci) {
360 int line_number = 0;
361 if (method->is_native()) {
362 // Negative value different from -1 below, enabling Java code in
363 // class java.lang.StackTraceElement to distinguish "native" from
364 // "no LineNumberTable". JDK tests for -2.
365 line_number = -2;
366 } else {
367 // Returns -1 if no LineNumberTable, and otherwise actual line number
368 line_number = method->line_number_from_bci(bci);
369 }
370 return line_number;
371 }
372
373 inline Symbol* Backtrace::get_source_file_name(InstanceKlass* holder, int version) {
374 // RedefineClasses() currently permits redefine operations to
375 // happen in parallel using a "last one wins" philosophy. That
376 // spec laxness allows the constant pool entry associated with
377 // the source_file_name_index for any older constant pool version
378 // to be unstable so we shouldn't try to use it.
379 if (holder->constants()->version() != version) {
380 return nullptr;
381 } else {
382 return holder->source_file_name();
383 }
384 }
385
386 #endif // SHARE_CLASSFILE_JAVACLASSES_INLINE_HPP