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 #ifndef SHARE_CI_CIFIELD_HPP
26 #define SHARE_CI_CIFIELD_HPP
27
28 #include "ci/ciClassList.hpp"
29 #include "ci/ciConstant.hpp"
30 #include "ci/ciFlags.hpp"
31 #include "ci/ciInstance.hpp"
32 #include "ci/ciUtilities.hpp"
33 #include "oops/layoutKind.hpp"
34
35 // ciField
36 //
37 // This class represents the result of a field lookup in the VM.
38 // The lookup may not succeed, in which case the information in
39 // the ciField will be incomplete.
40 class ciField : public ArenaObj {
41 CI_PACKAGE_ACCESS
42 friend class ciEnv;
43 friend class ciInstanceKlass;
44
45 private:
46 ciFlags _flags;
47 ciInstanceKlass* _holder;
48 ciInstanceKlass* _original_holder; // For fields nested in flat fields
49 ciSymbol* _name;
50 ciSymbol* _signature;
51 ciType* _type;
52 int _offset;
53 LayoutKind _layout_kind;
54 bool _is_constant;
55 bool _is_flat;
56 bool _is_null_free;
57 int _null_marker_offset;
58 ciMethod* _known_to_link_with_put;
59 ciInstanceKlass* _known_to_link_with_get;
60 ciConstant _constant_value;
61
62 ciType* compute_type();
63 ciType* compute_type_impl();
64
65 ciField(ciInstanceKlass* klass, int index, Bytecodes::Code bc);
66 ciField(fieldDescriptor* fd);
67 ciField(ciField* declared_field, ciField* sudfield);
68 ciField(ciField* declared_field);
69
70 // shared constructor code
71 void initialize_from(fieldDescriptor* fd);
72
73 public:
74 ciFlags flags() const { return _flags; }
75
76 // Of which klass is this field a member?
77 //
78 // Usage note: the declared holder of a field is the class
79 // referenced by name in the bytecodes. The canonical holder
80 // is the most general class which holds the field. This
81 // method returns the canonical holder. The declared holder
82 // can be accessed via a method in ciBytecodeStream.
83 //
84 // Ex.
85 // class A {
86 // public int f = 7;
87 // }
88 // class B extends A {
89 // public void test() {
90 // System.out.println(f);
91 // }
92 // }
93 //
94 // A java compiler is permitted to compile the access to
95 // field f as:
96 //
97 // getfield B.f
98 //
99 // In that case the declared holder of f would be B and
100 // the canonical holder of f would be A.
101 ciInstanceKlass* holder() const { return _holder; }
102 ciInstanceKlass* original_holder() const { return _original_holder; }
103
104 // Name of this field?
105 ciSymbol* name() const { return _name; }
106
107 // Signature of this field?
108 ciSymbol* signature() const { return _signature; }
109
110 // Of what type is this field?
111 ciType* type() { return (_type == nullptr) ? compute_type() : _type; }
112
113 // How is this field actually stored in memory?
114 BasicType layout_type() { return type2field[(_type == nullptr) ? T_OBJECT : _type->basic_type()]; }
115
116 // What is the offset of this field? (Fields are aligned to the byte level.)
117 int offset_in_bytes() const {
118 assert(_offset >= 1, "illegal call to offset()");
119 return _offset;
120 }
121
122 // Is this field shared?
123 bool is_shared() {
124 // non-static fields of shared holders are cached
125 return _holder->is_shared() && !is_static();
126 }
127
128 // Is this field a constant?
129 //
130 // Clarification: A field is considered constant if:
131 // 1. The field is both static and final
132 // 2. The field is not one of the special static/final
133 // non-constant fields. These are java.lang.System.in
134 // and java.lang.System.out. Abomination.
135 //
136 // A field is also considered constant if
137 // - it is marked @Stable and is non-null (or non-zero, if a primitive) or
138 // - it is trusted or
139 // - it is the target field of a CallSite object.
140 //
141 // See ciField::initialize_from() for more details.
142 //
143 // A user should also check the field value (constant_value().is_valid()), since
144 // constant fields of non-initialized classes don't have values yet.
145 bool is_constant() const { return _is_constant; }
146
147 // Get the constant value of the static field.
148 ciConstant constant_value();
149
150 bool is_static_constant() {
151 return is_static() && is_constant() && constant_value().is_valid();
152 }
153
154 // Get the constant value of non-static final field in the given
155 // object.
156 ciConstant constant_value_of(ciObject* object);
157
158 // Check for link time errors. Accessing a field from a
159 // certain method via a certain bytecode may or may not be legal.
160 // This call checks to see if an exception may be raised by
161 // an access of this field.
162 //
163 // Usage note: if the same field is accessed multiple times
164 // in the same compilation, will_link will need to be checked
165 // at each point of access.
166 bool will_link(ciMethod* accessing_method,
167 Bytecodes::Code bc);
168
169 // Java access flags
170 bool is_public () const { return flags().is_public(); }
171 bool is_private () const { return flags().is_private(); }
172 bool is_protected () const { return flags().is_protected(); }
173 bool is_static () const { return flags().is_static(); }
174 bool is_final () const { return flags().is_final(); }
175 bool is_stable () const { return flags().is_stable(); }
176 bool is_volatile () const { return flags().is_volatile(); }
177 bool is_transient () const { return flags().is_transient(); }
178 bool is_strict () const { return flags().is_strict(); }
179 bool is_flat () const { return _is_flat; }
180 bool is_null_free () const { return _is_null_free; }
181 int null_marker_offset () const { return _null_marker_offset; }
182 LayoutKind layout_kind () const { return _layout_kind; }
183
184 // Whether this field needs to act atomically. Note that it does not actually need accessing
185 // atomically. For example, if there cannot be racy accesses to this field, then it can be
186 // accessed in a non-atomic manner. Unless this field must be in observably immutable memory,
187 // this method must not depend on the fact that the field cannot be accessed racily (e.g. it is a
188 // strict final field), as if the holder object is flattened as a field that is not strict final,
189 // this property is lost.
190 //
191 // A slice of memory is observably immutable if all stores to it must happen before all loads
192 // from it. A typical example is when the memory is a strict field and its immediate holder is
193 // not a field inside another object.
194 //
195 // For example:
196 // value class A {
197 // int x;
198 // int y;
199 // }
200 // value class AHolder {
201 // A v;
202 // }
203 // class AHolderHolder {
204 // AHolder v;
205 // }
206 // The field AHolder.v is flattened in AHolder, but AHolder cannot be flattened in AHolderHolder
207 // because we cannot access AHolderHolder.v atomically. As a result, we can say that the field is
208 // non-atomic. In this case, AHolder.v has its layout being NULLABLE_NON_ATOMIC_FLAT, this
209 // prevents its holder from being flattened in observably mutable memory.
210 //
211 // Another example:
212 // value class B {
213 // int v;
214 // }
215 // looselyconsistent value class BHolder {
216 // B v;
217 // byte b;
218 // }
219 // class BHolderHolder {
220 // null-free BHolder v;
221 // }
222 // The field BHolder.v is flattened in BHolder, and BHolder can be flattened further in
223 // BHolderHolder. In this case, while BHolder.v can be accessed in a non-atomic manner if BHolder
224 // is a standalone object, it must still be accessed atomically when it is a subfield in
225 // BHolderHolder.v. As a result, the field BHolder.v must still return true for this method, so
226 // that the compiler knows to access it correctly in all circumstances. Implementation-wise,
227 // BHolder.v has its layout being NULLABLE_ATOMIC_FLAT, which still allows its holder to be
228 // flattened in observably mutable memory.
229 bool is_atomic();
230
231 // The field is modified outside of instance initializer methods
232 // (or class/initializer methods if the field is static).
233 bool has_initialized_final_update() const { return flags().has_initialized_final_update(); }
234
235 bool is_call_site_target();
236
237 bool is_autobox_cache();
238
239 // Debugging output
240 void print() const;
241 void print_name_on(outputStream* st);
242 };
243
244 #endif // SHARE_CI_CIFIELD_HPP