1 /*
2 * Copyright (c) 2023, 2025, 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_OOPS_RESOLVEDFIELDENTRY_HPP
26 #define SHARE_OOPS_RESOLVEDFIELDENTRY_HPP
27
28 #include "interpreter/bytecodes.hpp"
29 #include "oops/instanceKlass.hpp"
30 #include "runtime/atomicAccess.hpp"
31 #include "utilities/checkedCast.hpp"
32 #include "utilities/sizes.hpp"
33
34 // ResolvedFieldEntry contains the resolution information for field related bytecodes like
35 // like getfield, putfield, getstatic, and putstatic. A member of this class can be initialized
36 // with the constant pool index associated with the bytecode before any resolution is done, where
37 // "resolution" refers to populating the getcode and putcode fields and other relevant information.
38 // The field's type (TOS), offset, holder klass, and index within that class can all be acquired
39 // together and are used to populate this structure. These entries are contained
40 // within the ConstantPoolCache and are accessed with indices added to the bytecode after
41 // rewriting.
42
43 // Field bytecodes start with a constant pool index as their operand, which is then rewritten to
44 // a "field index", which is an index into the array of ResolvedFieldEntry.
45
46 // The explicit paddings are necessary for generating deterministic CDS archives. They prevent
47 // the C++ compiler from potentially inserting random values in unused gaps.
48
49 //class InstanceKlass;
50 class ResolvedFieldEntry {
51 friend class VMStructs;
52
53 InstanceKlass* _field_holder; // Field holder klass
54 int _field_offset; // Field offset in bytes
55 u2 _field_index; // Index into field information in holder InstanceKlass
56 u2 _cpool_index; // Constant pool index
57 u1 _tos_state; // TOS state
58 u1 _flags; // Flags: [000|has_null_marker|is_null_free_inline_type|is_flat|is_final|is_volatile]
59 u1 _get_code, _put_code; // Get and Put bytecodes of the field
60 #ifdef _LP64
61 u4 _padding;
62 #endif
63
64 public:
65 ResolvedFieldEntry(u2 cpi) :
66 _field_holder(nullptr),
67 _field_offset(0),
68 _field_index(0),
69 _cpool_index(cpi),
70 _tos_state(0),
71 _flags(0),
72 _get_code(0),
73 _put_code(0)
74 #ifdef _LP64
75 , _padding(0)
76 #endif
77 {}
78
79 ResolvedFieldEntry() :
80 ResolvedFieldEntry(0) {}
81
82 // Bit shift to get flags
83 // Note: Only two flags exists at the moment but more could be added
84 enum {
85 is_volatile_shift = 0,
86 is_final_shift = 1, // unused
87 is_flat_shift = 2,
88 is_null_free_inline_type_shift = 3,
89 has_null_marker_shift = 4,
90 max_flag_shift = has_null_marker_shift
91 };
92
93 // Getters
94 InstanceKlass* field_holder() const { return _field_holder; }
95 int field_offset() const { return _field_offset; }
96 u2 field_index() const { return _field_index; }
97 u2 constant_pool_index() const { return _cpool_index; }
98 u1 tos_state() const { return _tos_state; }
99 u1 get_code() const { return AtomicAccess::load_acquire(&_get_code); }
100 u1 put_code() const { return AtomicAccess::load_acquire(&_put_code); }
101 bool is_final() const { return (_flags & (1 << is_final_shift)) != 0; }
102 bool is_volatile () const { return (_flags & (1 << is_volatile_shift)) != 0; }
103 bool is_flat() const { return (_flags & (1 << is_flat_shift)) != 0; }
104 bool is_null_free_inline_type() const { return (_flags & (1 << is_null_free_inline_type_shift)) != 0; }
105 bool has_null_marker() const { return (_flags & (1 << has_null_marker_shift)) != 0; }
106 bool is_resolved(Bytecodes::Code code) const {
107 switch(code) {
108 case Bytecodes::_getstatic:
109 case Bytecodes::_getfield:
110 return (get_code() == code);
111 case Bytecodes::_putstatic:
112 case Bytecodes::_putfield:
113 return (put_code() == code);
114 default:
115 ShouldNotReachHere();
116 return false;
117 }
118 }
119
120 // Printing
121 void print_on(outputStream* st) const;
122
123 void set_flags(bool is_final_flag, bool is_volatile_flag, bool is_flat_flag, bool is_null_free_inline_type_flag,
124 bool has_null_marker_flag) {
125 u1 new_flags = ((is_final_flag ? 1 : 0) << is_final_shift) | static_cast<int>(is_volatile_flag) |
126 ((is_flat_flag ? 1 : 0) << is_flat_shift) |
127 ((is_null_free_inline_type_flag ? 1 : 0) << is_null_free_inline_type_shift) |
128 ((has_null_marker_flag ? 1 : 0) << has_null_marker_shift);
129 _flags = checked_cast<u1>(new_flags);
130 assert(is_final() == is_final_flag, "Must be");
131 assert(is_volatile() == is_volatile_flag, "Must be");
132 assert(is_flat() == is_flat_flag, "Must be");
133 assert(is_null_free_inline_type() == is_null_free_inline_type_flag, "Must be");
134 assert(has_null_marker() == has_null_marker_flag, "Must be");
135 }
136
137 inline void set_bytecode(u1* code, u1 new_code) {
138 #ifdef ASSERT
139 // Read once.
140 volatile Bytecodes::Code c = (Bytecodes::Code)*code;
141 assert(c == 0 || c == new_code || new_code == 0, "update must be consistent");
142 #endif
143 AtomicAccess::release_store(code, new_code);
144 }
145
146 // Populate the structure with resolution information
147 void fill_in(InstanceKlass* klass, int offset, u2 index, u1 tos_state, u1 b1, u1 b2) {
148 _field_holder = klass;
149 _field_offset = offset;
150 _field_index = index;
151 _tos_state = tos_state;
152
153 // These must be set after the other fields
154 set_bytecode(&_get_code, b1);
155 set_bytecode(&_put_code, b2);
156 assert(is_valid(), "invalid");
157 }
158
159 // CDS
160 #if INCLUDE_CDS
161 void remove_unshareable_info();
162 void mark_and_relocate();
163 #endif
164
165 // Offsets
166 static ByteSize field_holder_offset() { return byte_offset_of(ResolvedFieldEntry, _field_holder); }
167 static ByteSize field_offset_offset() { return byte_offset_of(ResolvedFieldEntry, _field_offset); }
168 static ByteSize field_index_offset() { return byte_offset_of(ResolvedFieldEntry, _field_index); }
169 static ByteSize get_code_offset() { return byte_offset_of(ResolvedFieldEntry, _get_code); }
170 static ByteSize put_code_offset() { return byte_offset_of(ResolvedFieldEntry, _put_code); }
171 static ByteSize type_offset() { return byte_offset_of(ResolvedFieldEntry, _tos_state); }
172 static ByteSize flags_offset() { return byte_offset_of(ResolvedFieldEntry, _flags); }
173
174 // Debug help
175 bool is_valid() const;
176 };
177
178 #endif //SHARE_OOPS_RESOLVEDFIELDENTRY_HPP