1 /*
2 * Copyright (c) 1999, 2026, 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 "ci/ciConstant.hpp"
26 #include "ci/ciField.hpp"
27 #include "ci/ciInlineKlass.hpp"
28 #include "ci/ciInstanceKlass.hpp"
29 #include "ci/ciSymbol.hpp"
30 #include "ci/ciSymbols.hpp"
31 #include "ci/ciUtilities.inline.hpp"
32 #include "classfile/javaClasses.hpp"
33 #include "classfile/vmClasses.hpp"
34 #include "gc/shared/collectedHeap.inline.hpp"
35 #include "interpreter/linkResolver.hpp"
36 #include "jvm_io.h"
37 #include "oops/klass.inline.hpp"
38 #include "oops/layoutKind.hpp"
39 #include "oops/oop.inline.hpp"
40 #include "runtime/fieldDescriptor.inline.hpp"
41 #include "runtime/handles.inline.hpp"
42 #include "runtime/reflection.hpp"
43 #include "utilities/globalDefinitions.hpp"
44
45 // ciField
46 //
47 // This class represents the result of a field lookup in the VM.
48 // The lookup may not succeed, in which case the information in
49 // the ciField will be incomplete.
50
51 // The ciObjectFactory cannot create circular data structures in one query.
52 // To avoid vicious circularities, we initialize ciField::_type to null
53 // for reference types and derive it lazily from the ciField::_signature.
54 // Primitive types are eagerly initialized, and basic layout queries
55 // can succeed without initialization, using only the BasicType of the field.
56
57 // Notes on bootstrapping and shared CI objects: A field is shared if and
58 // only if it is (a) non-static and (b) declared by a shared instance klass.
59 // This allows non-static field lists to be cached on shared types.
60 // Because the _type field is lazily initialized, however, there is a
61 // special restriction that a shared field cannot cache an unshared type.
62 // This puts a small performance penalty on shared fields with unshared
63 // types, such as StackTraceElement[] Throwable.stackTrace.
64 // (Throwable is shared because ClassCastException is shared, but
65 // StackTraceElement is not presently shared.)
66
67 // It is not a vicious circularity for a ciField to recursively create
68 // the ciSymbols necessary to represent its name and signature.
69 // Therefore, these items are created eagerly, and the name and signature
70 // of a shared field are themselves shared symbols. This somewhat
71 // pollutes the set of shared CI objects: It grows from 50 to 93 items,
72 // with all of the additional 43 being uninteresting shared ciSymbols.
73 // This adds at most one step to the binary search, an amount which
74 // decreases for complex compilation tasks.
75
76 // ------------------------------------------------------------------
77 // ciField::ciField
78 ciField::ciField(ciInstanceKlass* klass, int index, Bytecodes::Code bc) :
79 _original_holder(nullptr), _is_flat(false), _known_to_link_with_put(nullptr), _known_to_link_with_get(nullptr) {
80 ASSERT_IN_VM;
81 CompilerThread *THREAD = CompilerThread::current();
82
83 assert(ciObjectFactory::is_initialized(), "not a shared field");
84
85 assert(klass->get_instanceKlass()->is_linked(), "must be linked before using its constant-pool");
86
87 constantPoolHandle cpool(THREAD, klass->get_instanceKlass()->constants());
88
89 // Get the field's name, signature, and type.
90 Symbol* name = cpool->name_ref_at(index, bc);
91 _name = ciEnv::current(THREAD)->get_symbol(name);
92
93 int nt_index = cpool->name_and_type_ref_index_at(index, bc);
94 int sig_index = cpool->signature_ref_index_at(nt_index);
95 Symbol* signature = cpool->symbol_at(sig_index);
96 _signature = ciEnv::current(THREAD)->get_symbol(signature);
97
98 BasicType field_type = Signature::basic_type(signature);
99
100 // If the field is a pointer type, get the klass of the
101 // field.
102 if (is_reference_type(field_type)) {
103 bool ignore;
104 // This is not really a class reference; the index always refers to the
105 // field's type signature, as a symbol. Linkage checks do not apply.
106 _type = ciEnv::current(THREAD)->get_klass_by_index(cpool, sig_index, ignore, klass);
107 } else {
108 _type = ciType::make(field_type);
109 }
110
111 _is_null_free = false;
112 _null_marker_offset = -1;
113
114 // Get the field's declared holder.
115 //
116 // Note: we actually create a ciInstanceKlass for this klass,
117 // even though we may not need to.
118 int holder_index = cpool->klass_ref_index_at(index, bc);
119 bool holder_is_accessible;
120
121 ciKlass* generic_declared_holder = ciEnv::current(THREAD)->get_klass_by_index(cpool, holder_index,
122 holder_is_accessible,
123 klass);
124
125 if (generic_declared_holder->is_array_klass()) {
126 // If the declared holder of the field is an array class, assume that
127 // the canonical holder of that field is java.lang.Object. Arrays
128 // do not have fields; java.lang.Object is the only supertype of an
129 // array type that can declare fields and is therefore the canonical
130 // holder of the array type.
131 //
132 // Furthermore, the compilers assume that java.lang.Object does not
133 // have any fields. Therefore, the field is not looked up. Instead,
134 // the method returns partial information that will trigger special
135 // handling in ciField::will_link and will result in a
136 // java.lang.NoSuchFieldError exception being thrown by the compiled
137 // code (the expected behavior in this case).
138 _holder = ciEnv::current(THREAD)->Object_klass();
139 _offset = -1;
140 _is_constant = false;
141 return;
142 }
143
144 ciInstanceKlass* declared_holder = generic_declared_holder->as_instance_klass();
145
146 // The declared holder of this field may not have been loaded.
147 // Bail out with partial field information.
148 if (!holder_is_accessible) {
149 // _type has already been set.
150 // The default values for _flags and _constant_value will suffice.
151 // We need values for _holder, _offset, and _is_constant,
152 _holder = declared_holder;
153 _offset = -1;
154 _is_constant = false;
155 return;
156 }
157
158 InstanceKlass* loaded_decl_holder = declared_holder->get_instanceKlass();
159
160 // Perform the field lookup.
161 fieldDescriptor field_desc;
162 Klass* canonical_holder =
163 loaded_decl_holder->find_field(name, signature, &field_desc);
164 if (canonical_holder == nullptr) {
165 // Field lookup failed. Will be detected by will_link.
166 _holder = declared_holder;
167 _offset = -1;
168 _is_constant = false;
169 return;
170 }
171
172 // Access check based on declared_holder. canonical_holder should not be used
173 // to check access because it can erroneously succeed. If this check fails,
174 // propagate the declared holder to will_link() which in turn will bail out
175 // compilation for this field access.
176 bool can_access = Reflection::verify_member_access(klass->get_Klass(),
177 declared_holder->get_Klass(),
178 canonical_holder,
179 field_desc.access_flags(),
180 true, false, THREAD);
181 if (!can_access) {
182 _holder = declared_holder;
183 _offset = -1;
184 _is_constant = false;
185 // It's possible the access check failed due to a nestmate access check
186 // encountering an exception. We can't propagate the exception from here
187 // so we have to clear it. If the access check happens again in a different
188 // context then the exception will be thrown there.
189 if (HAS_PENDING_EXCEPTION) {
190 CLEAR_PENDING_EXCEPTION;
191 }
192 return;
193 }
194
195 assert(canonical_holder == field_desc.field_holder(), "just checking");
196 initialize_from(&field_desc);
197 }
198
199 ciField::ciField(fieldDescriptor *fd) :
200 _known_to_link_with_put(nullptr), _known_to_link_with_get(nullptr) {
201 ASSERT_IN_VM;
202
203 // Get the field's name, signature, and type.
204 ciEnv* env = CURRENT_ENV;
205 _name = env->get_symbol(fd->name());
206 _signature = env->get_symbol(fd->signature());
207
208 BasicType field_type = fd->field_type();
209
210 // If the field is a pointer type, get the klass of the
211 // field.
212 if (is_reference_type(field_type)) {
213 _type = nullptr; // must call compute_type on first access
214 } else {
215 _type = ciType::make(field_type);
216 }
217
218 initialize_from(fd);
219
220 // Either (a) it is marked shared, or else (b) we are done bootstrapping.
221 assert(is_shared() || ciObjectFactory::is_initialized(),
222 "bootstrap classes must not create & cache unshared fields");
223 }
224
225 // Special copy constructor used to flatten inline type fields by
226 // copying the fields of the inline type to a new holder klass.
227 ciField::ciField(ciField* declared_field, ciField* subfield) {
228 assert(subfield->holder()->is_inlinetype() || subfield->holder()->is_abstract(), "should only be used for inline type field flattening");
229 assert(!subfield->is_flat(), "subfield must not be flat");
230 assert(declared_field->is_flat(), "declared field must be flat");
231
232 _flags = declared_field->flags();
233 _holder = declared_field->holder();
234 _offset = declared_field->offset_in_bytes() + (subfield->offset_in_bytes() - declared_field->type()->as_inline_klass()->payload_offset());
235
236 ResourceMark rm;
237 char buffer[256];
238 jio_snprintf(buffer, sizeof(buffer), "%s.%s", declared_field->name()->as_utf8(), subfield->name()->as_utf8());
239 _name = ciSymbol::make(buffer);
240
241 _signature = subfield->_signature;
242 _type = subfield->_type;
243 _is_constant = (declared_field->is_strict() && declared_field->is_final()) || declared_field->is_constant();
244 _known_to_link_with_put = subfield->_known_to_link_with_put;
245 _known_to_link_with_get = subfield->_known_to_link_with_get;
246 _constant_value = ciConstant();
247
248 _is_flat = false;
249 _is_null_free = false;
250 _null_marker_offset = -1;
251 _original_holder = (subfield->_original_holder != nullptr) ? subfield->_original_holder : subfield->_holder;
252 _layout_kind = LayoutKind::UNKNOWN;
253 }
254
255 // Constructor for the ciField of a null marker
256 ciField::ciField(ciField* declared_field) {
257 assert(declared_field->is_flat(), "declared field must be flat");
258 assert(!declared_field->is_null_free(), "must have a null marker");
259
260 _flags = declared_field->flags();
261 _holder = declared_field->holder();
262 _offset = declared_field->null_marker_offset();
263
264 ResourceMark rm;
265 char buffer[256];
266 jio_snprintf(buffer, sizeof(buffer), "%s.$nullMarker$", declared_field->name()->as_utf8());
267 _name = ciSymbol::make(buffer);
268
269 _signature = ciSymbols::bool_signature();
270 _type = ciType::make(T_BOOLEAN);
271
272 _is_constant = (declared_field->is_strict() && declared_field->is_final()) || declared_field->is_constant();
273 _known_to_link_with_put = nullptr;
274 _known_to_link_with_get = nullptr;
275 _constant_value = ciConstant();
276
277 _is_flat = false;
278 _is_null_free = false;
279 _null_marker_offset = -1;
280 _original_holder = nullptr;
281 _layout_kind = LayoutKind::UNKNOWN;
282 }
283
284 static bool trust_final_nonstatic_fields(ciInstanceKlass* holder) {
285 if (holder == nullptr)
286 return false;
287 if (holder->trust_final_fields()) {
288 // Explicit opt-in from system classes
289 return true;
290 }
291 // Even if general trusting is disabled, trust system-built closures in these packages.
292 if (holder->is_in_package("java/lang/invoke") || holder->is_in_package("sun/invoke") ||
293 holder->is_in_package("java/lang/reflect") || holder->is_in_package("jdk/internal/reflect") ||
294 holder->is_in_package("jdk/internal/foreign/layout") || holder->is_in_package("jdk/internal/foreign") ||
295 holder->is_in_package("jdk/internal/vm/vector") || holder->is_in_package("jdk/incubator/vector") ||
296 holder->is_in_package("java/lang"))
297 return true;
298 // Trust hidden classes. They are created via Lookup.defineHiddenClass and
299 // can't be serialized, so there is no hacking of finals going on with them.
300 if (holder->is_hidden())
301 return true;
302 // Trust final fields in inline type buffers
303 if (holder->is_inlinetype())
304 return true;
305 // Trust final fields in records
306 if (holder->is_record())
307 return true;
308 return TrustFinalNonStaticFields;
309 }
310
311 void ciField::initialize_from(fieldDescriptor* fd) {
312 // Get the flags, offset, and canonical holder of the field.
313 _flags = ciFlags(fd->access_flags(), fd->field_flags().is_stable(), fd->field_status().is_initialized_final_update());
314 _offset = fd->offset();
315 InstanceKlass* field_holder = fd->field_holder();
316 assert(field_holder != nullptr, "null field_holder");
317 _holder = CURRENT_ENV->get_instance_klass(field_holder);
318 _is_flat = fd->is_flat();
319 _is_null_free = fd->is_null_free_inline_type();
320 if (fd->has_null_marker()) {
321 InlineLayoutInfo* li = field_holder->inline_layout_info_adr(fd->index());
322 _null_marker_offset = li->null_marker_offset();
323 } else {
324 _null_marker_offset = -1;
325 }
326 _original_holder = nullptr;
327 _layout_kind = fd->is_flat() ? fd->layout_kind() : LayoutKind::UNKNOWN;
328
329 // Check to see if the field is constant.
330 Klass* k = _holder->get_Klass();
331 bool is_stable_field = FoldStableValues && is_stable();
332 if ((is_final() && !has_initialized_final_update()) || is_stable_field) {
333 if (is_static()) {
334 // This field just may be constant. The only case where it will
335 // not be constant is when the field is a *special* static & final field
336 // whose value may change. The three examples are java.lang.System.in,
337 // java.lang.System.out, and java.lang.System.err.
338 _is_constant = !fd->is_mutable_static_final();
339 } else {
340 // An instance field can be constant if it's a final static field or if
341 // it's a final non-static field of a trusted class (classes in
342 // java.lang.invoke and sun.invoke packages and subpackages).
343 _is_constant = is_stable_field || trust_final_nonstatic_fields(_holder);
344 }
345 } else {
346 // For CallSite objects treat the target field as a compile time constant.
347 assert(vmClasses::CallSite_klass() != nullptr, "should be already initialized");
348 if (k == vmClasses::CallSite_klass() &&
349 _offset == java_lang_invoke_CallSite::target_offset()) {
350 assert(!has_initialized_final_update(), "CallSite is not supposed to have writes to final fields outside initializers");
351 _is_constant = true;
352 } else {
353 // Non-final & non-stable fields are not constants.
354 _is_constant = false;
355 }
356 }
357 }
358
359 // ------------------------------------------------------------------
360 // ciField::constant_value
361 // Get the constant value of a this static field.
362 ciConstant ciField::constant_value() {
363 assert(is_static() && is_constant(), "illegal call to constant_value()");
364 if (!_holder->is_initialized()) {
365 return ciConstant(); // Not initialized yet
366 }
367 if (_constant_value.basic_type() == T_ILLEGAL) {
368 // Static fields are placed in mirror objects.
369 ciInstance* mirror = _holder->java_mirror();
370 _constant_value = mirror->field_value_impl(this);
371 }
372 if (FoldStableValues && is_stable() && _constant_value.is_null_or_zero()) {
373 return ciConstant();
374 }
375 return _constant_value;
376 }
377
378 // ------------------------------------------------------------------
379 // ciField::constant_value_of
380 // Get the constant value of non-static final field in the given object.
381 ciConstant ciField::constant_value_of(ciObject* object) {
382 assert(!is_static() && is_constant(), "only if field is non-static constant");
383 assert(object->is_instance(), "must be instance");
384 ciConstant field_value = object->as_instance()->field_value(this);
385 if (FoldStableValues && is_stable() && field_value.is_null_or_zero()) {
386 return ciConstant();
387 }
388 return field_value;
389 }
390
391 // ------------------------------------------------------------------
392 // ciField::compute_type
393 //
394 // Lazily compute the type, if it is an instance klass.
395 ciType* ciField::compute_type() {
396 GUARDED_VM_ENTRY(return compute_type_impl();)
397 }
398
399 ciType* ciField::compute_type_impl() {
400 // Use original holder for fields that came in through flattening
401 ciKlass* accessing_klass = (_original_holder != nullptr) ? _original_holder : _holder;
402 ciKlass* type = CURRENT_ENV->get_klass_by_name_impl(accessing_klass, constantPoolHandle(), _signature, false);
403 if (!type->is_primitive_type() && is_shared()) {
404 // We must not cache a pointer to an unshared type, in a shared field.
405 bool type_is_also_shared = false;
406 if (type->is_type_array_klass()) {
407 type_is_also_shared = true; // int[] etc. are explicitly bootstrapped
408 } else if (type->is_instance_klass()) {
409 type_is_also_shared = type->as_instance_klass()->is_shared();
410 } else {
411 // Currently there is no 'shared' query for array types.
412 type_is_also_shared = !ciObjectFactory::is_initialized();
413 }
414 if (!type_is_also_shared)
415 return type; // Bummer.
416 }
417 _type = type;
418 return type;
419 }
420
421 bool ciField::is_atomic() {
422 assert(is_flat(), "should not ask this property for non-flat field %s.%s", holder()->name()->as_utf8(), name()->as_utf8());
423 return LayoutKindHelper::is_atomic_flat(_layout_kind) && !type()->as_inline_klass()->is_naturally_atomic(is_null_free());
424 }
425
426 // ------------------------------------------------------------------
427 // ciField::will_link
428 //
429 // Can a specific access to this field be made without causing
430 // link errors?
431 bool ciField::will_link(ciMethod* accessing_method,
432 Bytecodes::Code bc) {
433 VM_ENTRY_MARK;
434 assert(bc == Bytecodes::_getstatic || bc == Bytecodes::_putstatic ||
435 bc == Bytecodes::_getfield || bc == Bytecodes::_putfield,
436 "unexpected bytecode");
437
438 if (_offset == -1) {
439 // at creation we couldn't link to our holder so we need to
440 // maintain that stance, otherwise there's no safe way to use this
441 // ciField.
442 return false;
443 }
444
445 // Check for static/nonstatic mismatch
446 bool is_static = (bc == Bytecodes::_getstatic || bc == Bytecodes::_putstatic);
447 if (is_static != this->is_static()) {
448 return false;
449 }
450
451 // Get and put can have different accessibility rules
452 bool is_put = (bc == Bytecodes::_putfield || bc == Bytecodes::_putstatic);
453 if (is_put) {
454 if (_known_to_link_with_put == accessing_method) {
455 return true;
456 }
457 } else {
458 if (_known_to_link_with_get == accessing_method->holder()) {
459 return true;
460 }
461 }
462
463 LinkInfo link_info(_holder->get_instanceKlass(),
464 _name->get_symbol(), _signature->get_symbol(),
465 methodHandle(THREAD, accessing_method->get_Method()));
466 fieldDescriptor result;
467 LinkResolver::resolve_field(result, link_info, bc, ClassInitMode::dont_init, CHECK_AND_CLEAR_(false));
468
469 // Strict statics may require tracking if their class is not fully initialized.
470 // For now we can bail out of the compiler and let the interpreter handle it.
471 if (is_static && result.is_strict_static_unset()) {
472 // If we left out this logic, we would get (a) spurious <clinit>
473 // failures for C2 code because compiled putstatic would not write
474 // the "unset" bits, and (b) missed failures for too-early reads,
475 // since the compiled getstatic would not check the "unset" bits.
476 // Test C1 on <clinit> with "-XX:TieredStopAtLevel=2 -Xcomp -Xbatch".
477 // Test C2 on <clinit> with "-XX:-TieredCompilation -Xcomp -Xbatch".
478 return false;
479 }
480
481 // update the hit-cache, unless there is a problem with memory scoping:
482 if (accessing_method->holder()->is_shared() || !is_shared()) {
483 if (is_put) {
484 _known_to_link_with_put = accessing_method;
485 } else {
486 _known_to_link_with_get = accessing_method->holder();
487 }
488 }
489
490 return true;
491 }
492
493 bool ciField::is_call_site_target() {
494 ciInstanceKlass* callsite_klass = CURRENT_ENV->CallSite_klass();
495 if (callsite_klass == nullptr)
496 return false;
497 return (holder()->is_subclass_of(callsite_klass) && (name() == ciSymbols::target_name()));
498 }
499
500 bool ciField::is_autobox_cache() {
501 ciSymbol* klass_name = holder()->name();
502 // The box cache is disabled when boxes are value classes.
503 return (!Arguments::is_valhalla_enabled() &&
504 name() == ciSymbols::cache_field_name() &&
505 holder()->uses_default_loader() &&
506 (klass_name == ciSymbols::java_lang_Character_CharacterCache() ||
507 klass_name == ciSymbols::java_lang_Byte_ByteCache() ||
508 klass_name == ciSymbols::java_lang_Short_ShortCache() ||
509 klass_name == ciSymbols::java_lang_Integer_IntegerCache() ||
510 klass_name == ciSymbols::java_lang_Long_LongCache()));
511 }
512
513 // ------------------------------------------------------------------
514 // ciField::print
515 void ciField::print() const {
516 tty->print("<ciField name=");
517 _holder->print_name();
518 tty->print(".");
519 _name->print_symbol();
520 tty->print(" signature=");
521 _signature->print_symbol();
522 tty->print(" offset=%d type=", _offset);
523 if (_type != nullptr)
524 _type->print_name();
525 else
526 tty->print("(reference)");
527 tty->print(" flags=%04x", flags().as_int());
528 tty->print(" is_constant=%s", bool_to_str(_is_constant));
529 if (_is_constant && is_static()) {
530 tty->print(" constant_value=");
531 _constant_value.print();
532 }
533 tty->print(" is_flat=%s", bool_to_str(_is_flat));
534 tty->print(" is_null_free=%s", bool_to_str(_is_null_free));
535 tty->print(" null_marker_offset=%d", _null_marker_offset);
536 tty->print(">");
537 }
538
539 // ------------------------------------------------------------------
540 // ciField::print_name_on
541 //
542 // Print the name of this field
543 void ciField::print_name_on(outputStream* st) {
544 name()->print_symbol_on(st);
545 }