1 /*
2 * Copyright (c) 1997, 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 "classfile/vmSymbols.hpp"
26 #include "memory/resourceArea.hpp"
27 #include "oops/annotations.hpp"
28 #include "oops/constantPool.hpp"
29 #include "oops/fieldStreams.inline.hpp"
30 #include "oops/inlineKlass.inline.hpp"
31 #include "oops/instanceKlass.hpp"
32 #include "oops/klass.inline.hpp"
33 #include "oops/oop.inline.hpp"
34 #include "runtime/fieldDescriptor.inline.hpp"
35 #include "runtime/handles.inline.hpp"
36 #include "runtime/signature.hpp"
37
38 Symbol* fieldDescriptor::generic_signature() const {
39 if (!has_generic_signature()) {
40 return nullptr;
41 }
42 return _cp->symbol_at(_fieldinfo.generic_signature_index());
43 }
44
45 bool fieldDescriptor::is_trusted_final() const {
46 InstanceKlass* ik = field_holder();
47 return is_final() && (is_static() || ik->is_hidden() || ik->is_record() || ik->is_inline_klass()
48 || (ik->is_abstract() && !ik->is_identity_class() && !ik->is_interface()));
49 }
50
51 bool fieldDescriptor::is_mutable_static_final() const {
52 InstanceKlass* ik = field_holder();
53 // write protected fields (JLS 17.5.4)
54 if (is_final() && is_static() && ik == vmClasses::System_klass() &&
55 (offset() == java_lang_System::in_offset() || offset() == java_lang_System::out_offset() || offset() == java_lang_System::err_offset())) {
56 return true;
57 }
58 return false;
59 }
60
61 AnnotationArray* fieldDescriptor::annotations() const {
62 InstanceKlass* ik = field_holder();
63 Array<AnnotationArray*>* md = ik->fields_annotations();
64 if (md == nullptr)
65 return nullptr;
66 return md->at(index());
67 }
68
69 AnnotationArray* fieldDescriptor::type_annotations() const {
70 InstanceKlass* ik = field_holder();
71 Array<AnnotationArray*>* type_annos = ik->fields_type_annotations();
72 if (type_annos == nullptr)
73 return nullptr;
74 return type_annos->at(index());
75 }
76
77 constantTag fieldDescriptor::initial_value_tag() const {
78 return constants()->tag_at(initial_value_index());
79 }
80
81 jint fieldDescriptor::int_initial_value() const {
82 return constants()->int_at(initial_value_index());
83 }
84
85 jlong fieldDescriptor::long_initial_value() const {
86 return constants()->long_at(initial_value_index());
87 }
88
89 jfloat fieldDescriptor::float_initial_value() const {
90 return constants()->float_at(initial_value_index());
91 }
92
93 jdouble fieldDescriptor::double_initial_value() const {
94 return constants()->double_at(initial_value_index());
95 }
96
97 oop fieldDescriptor::string_initial_value(TRAPS) const {
98 return constants()->uncached_string_at(initial_value_index(), THREAD);
99 }
100
101 void fieldDescriptor::reinitialize(InstanceKlass* ik, const FieldInfo& fieldinfo) {
102 if (_cp.is_null() || field_holder() != ik) {
103 _cp = constantPoolHandle(Thread::current(), ik->constants());
104 // _cp should now reference ik's constant pool; i.e., ik is now field_holder.
105 // If the class is a scratch class, the constant pool points to the original class,
106 // but that's ok because of constant pool merging.
107 assert(field_holder() == ik || ik->is_scratch_class(), "must be already initialized to this class");
108 }
109 _fieldinfo = fieldinfo;
110 guarantee(_fieldinfo.name_index() != 0 && _fieldinfo.signature_index() != 0, "bad constant pool index for fieldDescriptor");
111 }
112
113 void fieldDescriptor::print_on(outputStream* st, int base_offset) const {
114 access_flags().print_on(st);
115 if (field_flags().is_injected()) st->print("injected ");
116 bool flat = field_flags().is_flat();
117 if (flat) st->print("flat ");
118 name()->print_value_on(st);
119 st->print(" (fields 0x%08x) ", field_flags().as_uint());
120 signature()->print_value_on(st);
121 st->print(" @%d ", offset() + base_offset);
122 if (WizardMode && has_initial_value()) {
123 st->print("(initval ");
124 constantTag t = initial_value_tag();
125 if (t.is_int()) {
126 st->print("int %d)", int_initial_value());
127 } else if (t.is_long()){
128 st->print_jlong(long_initial_value());
129 } else if (t.is_float()){
130 st->print("float %f)", float_initial_value());
131 } else if (t.is_double()){
132 st->print("double %lf)", double_initial_value());
133 }
134 st->print(" ");
135 }
136 if (flat) LayoutKindHelper::print_on(layout_kind(), st);
137 }
138
139 void fieldDescriptor::print() const { print_on(tty); }
140
141 void fieldDescriptor::print_on_for(outputStream* st, oop obj, int indent, int base_offset) {
142 BasicType ft = field_type();
143 print_on(st, base_offset);
144 st->print(" ");
145 jint as_int = 0;
146 switch (ft) {
147 case T_BYTE:
148 st->print("%d", obj->byte_field(offset()));
149 break;
150 case T_CHAR:
151 {
152 jchar c = obj->char_field(offset());
153 st->print("%c %d", isprint(c) ? c : ' ', c);
154 }
155 break;
156 case T_DOUBLE:
157 st->print("%lf", obj->double_field(offset()));
158 break;
159 case T_FLOAT:
160 st->print("%f", obj->float_field(offset()));
161 break;
162 case T_INT:
163 st->print("%d", obj->int_field(offset()));
164 break;
165 case T_LONG:
166 st->print_jlong(obj->long_field(offset()));
167 break;
168 case T_SHORT:
169 st->print("%d", obj->short_field(offset()));
170 break;
171 case T_BOOLEAN:
172 st->print("%s", obj->bool_field(offset()) ? "true" : "false");
173 break;
174 case T_ARRAY:
175 case T_OBJECT:
176 if (is_flat()) { // only some inline types can be flat
177 InlineKlass* vk = InlineKlass::cast(field_holder()->get_inline_type_field_klass(index()));
178 st->print("Flat inline type field '%s':", vk->name()->as_C_string());
179 if (!is_null_free_inline_type()) {
180 assert(has_null_marker(), "should have null marker");
181 InlineLayoutInfo* li = field_holder()->inline_layout_info_adr(index());
182 int nm_offset = li->null_marker_offset();
183 if (obj->byte_field_acquire(nm_offset) == 0) {
184 st->print_cr(" null");
185 return;
186 }
187 }
188 st->cr();
189 // Print fields of flat field (recursively)
190 int field_offset = offset() - vk->payload_offset();
191 obj = cast_to_oop(cast_from_oop<address>(obj) + field_offset);
192 FieldPrinter print_field(st, obj, indent + 1, base_offset + field_offset );
193 vk->do_nonstatic_fields(&print_field);
194 if (this->field_flags().has_null_marker()) {
195 for (int i = 0; i < indent + 1; i++) st->print(" ");
196 st->print_cr(" - [null_marker] @%d %s",
197 vk->null_marker_offset() - base_offset + field_offset,
198 obj->bool_field(vk->null_marker_offset()) ? "Field marked as non-null" : "Field marked as null");
199 }
200 return; // Do not print underlying representation
201 }
202 // Not flat inline type field, fall through
203 if (obj->obj_field(offset()) != nullptr) {
204 obj->obj_field(offset())->print_value_on(st);
205 } else {
206 st->print("null");
207 }
208 break;
209 default:
210 ShouldNotReachHere();
211 break;
212 }
213
214 // Print a hint as to the underlying integer representation.
215 if (is_reference_type(ft)) {
216 #ifdef _LP64
217 if (UseCompressedOops) {
218 st->print(" (" INT32_FORMAT_X_0 ")", obj->int_field(offset()));
219 } else {
220 st->print(" (" INT64_FORMAT_X_0 ")", (int64_t)obj->long_field(offset()));
221 }
222 #else
223 st->print(" (" INT32_FORMAT_X_0 ")", obj->int_field(offset()));
224 #endif
225 } else { // Primitives
226 switch (ft) {
227 case T_LONG: st->print(" (" INT64_FORMAT_X_0 ")", (int64_t)obj->long_field(offset())); break;
228 case T_DOUBLE: st->print(" (" INT64_FORMAT_X_0 ")", (int64_t)obj->long_field(offset())); break;
229 case T_BYTE: st->print(" (" INT8_FORMAT_X_0 ")", obj->byte_field(offset())); break;
230 case T_CHAR: st->print(" (" INT16_FORMAT_X_0 ")", obj->char_field(offset())); break;
231 case T_FLOAT: st->print(" (" INT32_FORMAT_X_0 ")", obj->int_field(offset())); break;
232 case T_INT: st->print(" (" INT32_FORMAT_X_0 ")", obj->int_field(offset())); break;
233 case T_SHORT: st->print(" (" INT16_FORMAT_X_0 ")", obj->short_field(offset())); break;
234 case T_BOOLEAN: st->print(" (" INT8_FORMAT_X_0 ")", obj->bool_field(offset())); break;
235 default:
236 ShouldNotReachHere();
237 break;
238 }
239 }
240 }