1 /*
  2  * Copyright (c) 2017, 2020, 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_VM_OOPS_INLINEKLASS_HPP
 26 #define SHARE_VM_OOPS_INLINEKLASS_HPP
 27 
 28 #include "classfile/javaClasses.hpp"
 29 #include "oops/instanceKlass.hpp"
 30 #include "oops/method.hpp"
 31 #include "runtime/registerMap.hpp"
 32 //#include "oops/oop.inline.hpp"
 33 
 34 // An InlineKlass is a specialized InstanceKlass for inline types.
 35 
 36 
 37 class InlineKlass: public InstanceKlass {
 38   friend class VMStructs;
 39   friend class InstanceKlass;
 40 
 41  public:
 42   InlineKlass() { assert(DumpSharedSpaces || UseSharedSpaces, "only for CDS"); }
 43 
 44  private:
 45 
 46   // Constructor
 47   InlineKlass(const ClassFileParser& parser);
 48 
 49   inline InlineKlassFixedBlock* inlineklass_static_block() const;
 50   inline address adr_return_regs() const;
 51 
 52   address adr_extended_sig() const {
 53     assert(_adr_inlineklass_fixed_block != NULL, "Should have been initialized");
 54     return ((address)_adr_inlineklass_fixed_block) + in_bytes(byte_offset_of(InlineKlassFixedBlock, _extended_sig));
 55   }
 56 
 57   // pack and unpack handlers for inline types return
 58   address adr_pack_handler() const {
 59     assert(_adr_inlineklass_fixed_block != NULL, "Should have been initialized");
 60     return ((address)_adr_inlineklass_fixed_block) + in_bytes(byte_offset_of(InlineKlassFixedBlock, _pack_handler));
 61   }
 62 
 63   address adr_pack_handler_jobject() const {
 64     assert(_adr_inlineklass_fixed_block != NULL, "Should have been initialized");
 65     return ((address)_adr_inlineklass_fixed_block) + in_bytes(byte_offset_of(InlineKlassFixedBlock, _pack_handler_jobject));
 66   }
 67 
 68   address adr_unpack_handler() const {
 69     assert(_adr_inlineklass_fixed_block != NULL, "Should have been initialized");
 70     return ((address)_adr_inlineklass_fixed_block) + in_bytes(byte_offset_of(InlineKlassFixedBlock, _unpack_handler));
 71   }
 72 
 73   address adr_default_value_offset() const {
 74     assert(_adr_inlineklass_fixed_block != NULL, "Should have been initialized");
 75     return ((address)_adr_inlineklass_fixed_block) + in_bytes(default_value_offset_offset());
 76   }
 77 
 78   ArrayKlass* volatile* adr_value_array_klasses() const {
 79     assert(_adr_inlineklass_fixed_block != NULL, "Should have been initialized");
 80     return (ArrayKlass* volatile*) ((address)_adr_inlineklass_fixed_block) + in_bytes(byte_offset_of(InlineKlassFixedBlock, _null_free_inline_array_klasses));
 81   }
 82 
 83   ArrayKlass* value_array_klasses() const {
 84     return *adr_value_array_klasses();
 85   }
 86 
 87   address adr_alignment() const {
 88     assert(_adr_inlineklass_fixed_block != NULL, "Should have been initialized");
 89     return ((address)_adr_inlineklass_fixed_block) + in_bytes(byte_offset_of(InlineKlassFixedBlock, _alignment));
 90   }
 91 
 92   address adr_first_field_offset() const {
 93     assert(_adr_inlineklass_fixed_block != NULL, "Should have been initialized");
 94     return ((address)_adr_inlineklass_fixed_block) + in_bytes(byte_offset_of(InlineKlassFixedBlock, _first_field_offset));
 95   }
 96 
 97   address adr_exact_size_in_bytes() const {
 98     assert(_adr_inlineklass_fixed_block != NULL, "Should have been initialized");
 99     return ((address)_adr_inlineklass_fixed_block) + in_bytes(byte_offset_of(InlineKlassFixedBlock, _exact_size_in_bytes));
100   }
101 
102  public:
103   int get_alignment() const {
104     return *(int*)adr_alignment();
105   }
106 
107   void set_alignment(int alignment) {
108     *(int*)adr_alignment() = alignment;
109   }
110 
111   int first_field_offset() const {
112     int offset = *(int*)adr_first_field_offset();
113     assert(offset != 0, "Must be initialized before use");
114     return *(int*)adr_first_field_offset();
115   }
116 
117   void set_first_field_offset(int offset) {
118     *(int*)adr_first_field_offset() = offset;
119   }
120 
121   int get_exact_size_in_bytes() const {
122     return *(int*)adr_exact_size_in_bytes();
123   }
124 
125   void set_exact_size_in_bytes(int exact_size) {
126     *(int*)adr_exact_size_in_bytes() = exact_size;
127   }
128 
129   int first_field_offset_old();
130 
131   virtual void remove_unshareable_info();
132   virtual void remove_java_mirror();
133   virtual void restore_unshareable_info(ClassLoaderData* loader_data, Handle protection_domain, PackageEntry* pkg_entry, TRAPS);
134   virtual void metaspace_pointers_do(MetaspaceClosure* it);
135 
136  private:
137   int collect_fields(GrowableArray<SigEntry>* sig, int base_off = 0);
138 
139   void cleanup_blobs();
140 
141  public:
142   // Type testing
143   bool is_inline_klass_slow() const        { return true; }
144   bool is_null_free() const { return access_flags().is_primitive_class(); }
145 
146   // ref and val mirror
147   oop ref_mirror() const { return java_mirror(); }
148   oop val_mirror() const { return java_lang_Class::secondary_mirror(java_mirror()); }
149 
150   // naming
151   const char* ref_signature_name() const {
152     return InstanceKlass::signature_name_of_carrier(JVM_SIGNATURE_CLASS);
153   }
154   const char* val_signature_name() const {
155     return InstanceKlass::signature_name_of_carrier(JVM_SIGNATURE_PRIMITIVE_OBJECT);
156   }
157 
158   // Casting from Klass*
159   static InlineKlass* cast(Klass* k);
160 
161   // Use this to return the size of an instance in heap words.
162   // Note that this size only applies to heap allocated stand-alone instances.
163   virtual int size_helper() const {
164     return layout_helper_to_size_helper(layout_helper());
165   }
166 
167   // allocate_instance() allocates a stand alone value in the Java heap
168   // initialized to default value (cleared memory)
169   instanceOop allocate_instance(TRAPS);
170   // allocates a stand alone inline buffer in the Java heap
171   // DOES NOT have memory cleared, user MUST initialize payload before
172   // returning to Java (i.e.: inline_copy)
173   instanceOop allocate_instance_buffer(TRAPS);
174 
175   address data_for_oop(oop o) const;
176 
177   // Query if this class promises atomicity one way or another
178   bool is_atomic() { return is_naturally_atomic() || is_declared_atomic(); }
179 
180   bool flatten_array();
181 
182   bool contains_oops() const { return nonstatic_oop_map_count() > 0; }
183   int nonstatic_oop_count();
184 
185   // null free inline arrays...
186   //
187 
188   // null free inline array klass, akin to InstanceKlass::array_klass()
189   // Returns the array class for the n'th dimension
190   Klass* value_array_klass(int n, TRAPS);
191   Klass* value_array_klass_or_null(int n);
192 
193   // Returns the array class with this class as element type
194   Klass* value_array_klass(TRAPS);
195   Klass* value_array_klass_or_null();
196 
197 
198   // General store methods
199   //
200   // Normally loads and store methods would be found in *Oops classes, but since values can be
201   // "in-lined" (flattened) into containing oops, these methods reside here in InlineKlass.
202   //
203   // "inline_copy_*_to_new_*" assume new memory (i.e. IS_DEST_UNINITIALIZED for write barriers)
204 
205   void inline_copy_payload_to_new_oop(void* src, oop dst);
206   void inline_copy_oop_to_new_oop(oop src, oop dst);
207   void inline_copy_oop_to_new_payload(oop src, void* dst);
208   void inline_copy_oop_to_payload(oop src, void* dst);
209 
210   oop read_inlined_field(oop obj, int offset, TRAPS);
211   void write_inlined_field(oop obj, int offset, oop value, TRAPS);
212 
213   // oop iterate raw inline type data pointer (where oop_addr may not be an oop, but backing/array-element)
214   template <typename T, class OopClosureType>
215   inline void oop_iterate_specialized(const address oop_addr, OopClosureType* closure);
216 
217   template <typename T, class OopClosureType>
218   inline void oop_iterate_specialized_bounded(const address oop_addr, OopClosureType* closure, void* lo, void* hi);
219 
220   // calling convention support
221   void initialize_calling_convention(TRAPS);
222   Array<SigEntry>* extended_sig() const {
223     return *((Array<SigEntry>**)adr_extended_sig());
224   }
225   inline Array<VMRegPair>* return_regs() const;
226   bool can_be_passed_as_fields() const;
227   bool can_be_returned_as_fields(bool init = false) const;
228   void save_oop_fields(const RegisterMap& map, GrowableArray<Handle>& handles) const;
229   void restore_oop_results(RegisterMap& map, GrowableArray<Handle>& handles) const;
230   oop realloc_result(const RegisterMap& reg_map, const GrowableArray<Handle>& handles, TRAPS);
231   static InlineKlass* returned_inline_klass(const RegisterMap& reg_map);
232 
233   address pack_handler() const {
234     return *(address*)adr_pack_handler();
235   }
236 
237   address unpack_handler() const {
238     return *(address*)adr_unpack_handler();
239   }
240 
241   // pack and unpack handlers. Need to be loadable from generated code
242   // so at a fixed offset from the base of the klass pointer.
243   static ByteSize pack_handler_offset() {
244     return byte_offset_of(InlineKlassFixedBlock, _pack_handler);
245   }
246 
247   static ByteSize pack_handler_jobject_offset() {
248     return byte_offset_of(InlineKlassFixedBlock, _pack_handler_jobject);
249   }
250 
251   static ByteSize unpack_handler_offset() {
252     return byte_offset_of(InlineKlassFixedBlock, _unpack_handler);
253   }
254 
255   static ByteSize default_value_offset_offset() {
256     return byte_offset_of(InlineKlassFixedBlock, _default_value_offset);
257   }
258 
259   static ByteSize first_field_offset_offset() {
260     return byte_offset_of(InlineKlassFixedBlock, _first_field_offset);
261   }
262 
263   void set_default_value_offset(int offset) {
264     *((int*)adr_default_value_offset()) = offset;
265   }
266 
267   int default_value_offset() {
268     int offset = *((int*)adr_default_value_offset());
269     assert(offset != 0, "must not be called if not initialized");
270     return offset;
271   }
272 
273   void set_default_value(oop val) {
274     java_mirror()->obj_field_put(default_value_offset(), val);
275   }
276 
277   oop default_value();
278   void deallocate_contents(ClassLoaderData* loader_data);
279   static void cleanup(InlineKlass* ik) ;
280 
281   // Verification
282   void verify_on(outputStream* st);
283   void oop_verify_on(oop obj, outputStream* st);
284 
285 };
286 
287 #endif /* SHARE_VM_OOPS_INLINEKLASS_HPP */