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