1 /*
2 * Copyright (c) 1997, 2024, 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_KLASS_HPP
26 #define SHARE_OOPS_KLASS_HPP
27
28 #include "memory/iterator.hpp"
29 #include "memory/memRegion.hpp"
30 #include "oops/klassFlags.hpp"
31 #include "oops/markWord.hpp"
32 #include "oops/metadata.hpp"
33 #include "oops/oop.hpp"
34 #include "oops/oopHandle.hpp"
35 #include "utilities/accessFlags.hpp"
36 #include "utilities/macros.hpp"
37 #if INCLUDE_JFR
38 #include "jfr/support/jfrTraceIdExtension.hpp"
39 #endif
40
41 //
42 // A Klass provides:
43 // 1: language level class object (method dictionary etc.)
44 // 2: provide vm dispatch behavior for the object
45 // Both functions are combined into one C++ class.
46
47 // One reason for the oop/klass dichotomy in the implementation is
48 // that we don't want a C++ vtbl pointer in every object. Thus,
49 // normal oops don't have any virtual functions. Instead, they
50 // forward all "virtual" functions to their klass, which does have
51 // a vtbl and does the C++ dispatch depending on the object's
52 // actual type. (See oop.inline.hpp for some of the forwarding code.)
53 // ALL FUNCTIONS IMPLEMENTING THIS DISPATCH ARE PREFIXED WITH "oop_"!
54
55 // Forward declarations.
56 template <class T> class Array;
57 template <class T> class GrowableArray;
58 class ClassLoaderData;
59 class fieldDescriptor;
60 class klassVtable;
61 class ModuleEntry;
62 class PackageEntry;
63 class ParCompactionManager;
64 class PSPromotionManager;
65 class vtableEntry;
66
67 class Klass : public Metadata {
68
69 friend class VMStructs;
70 friend class JVMCIVMStructs;
71 public:
72 // Klass Kinds for all subclasses of Klass
73 enum KlassKind {
74 InstanceKlassKind,
75 InlineKlassKind,
76 InstanceRefKlassKind,
77 InstanceMirrorKlassKind,
78 InstanceClassLoaderKlassKind,
79 InstanceStackChunkKlassKind,
80 TypeArrayKlassKind,
81 FlatArrayKlassKind,
82 ObjArrayKlassKind,
83 UnknownKlassKind
84 };
85
86 static const uint KLASS_KIND_COUNT = ObjArrayKlassKind + 1;
87 protected:
88
89 // If you add a new field that points to any metaspace object, you
90 // must add this field to Klass::metaspace_pointers_do().
91
92 // note: put frequently-used fields together at start of klass structure
93 // for better cache behavior (may not make much of a difference but sure won't hurt)
94 enum { _primary_super_limit = 8 };
95
96 // The "layout helper" is a combined descriptor of object layout.
97 // For klasses which are neither instance nor array, the value is zero.
98 //
99 // For instances, layout helper is a positive number, the instance size.
100 // This size is already passed through align_object_size and scaled to bytes.
101 // The low order bit is set if instances of this class cannot be
102 // allocated using the fastpath.
103 //
104 // For arrays, layout helper is a negative number, containing four
105 // distinct bytes, as follows:
106 // MSB:[tag, hsz, ebt, log2(esz)]:LSB
107 // where:
108 // tag is 0x80 if the elements are oops, 0xC0 if non-oops, 0xA0 if value types
109 // hsz is array header size in bytes (i.e., offset of first element)
110 // ebt is the BasicType of the elements
111 // esz is the element size in bytes
112 // This packed word is arranged so as to be quickly unpacked by the
113 // various fast paths that use the various subfields.
114 //
115 // The esz bits can be used directly by a SLL instruction, without masking.
116 //
117 // Note that the array-kind tag looks like 0x00 for instance klasses,
118 // since their length in bytes is always less than 24Mb.
119 //
120 // Final note: This comes first, immediately after C++ vtable,
121 // because it is frequently queried.
122 jint _layout_helper;
123
124 // Klass kind used to resolve the runtime type of the instance.
125 // - Used to implement devirtualized oop closure dispatching.
126 // - Various type checking in the JVM
127 const KlassKind _kind;
128
129 // Processed access flags, for use by Class.getModifiers.
130 jint _modifier_flags;
131
132 // The fields _super_check_offset, _secondary_super_cache, _secondary_supers
133 // and _primary_supers all help make fast subtype checks. See big discussion
134 // in doc/server_compiler/checktype.txt
135 //
136 // Where to look to observe a supertype (it is &_secondary_super_cache for
137 // secondary supers, else is &_primary_supers[depth()].
138 juint _super_check_offset;
139
140 // Class name. Instance classes: java/lang/String, etc. Array classes: [I,
141 // [Ljava/lang/String;, etc. Set to zero for all other kinds of classes.
142 Symbol* _name;
143
144 // Cache of last observed secondary supertype
145 Klass* _secondary_super_cache;
146 // Array of all secondary supertypes
147 Array<Klass*>* _secondary_supers;
148 // Ordered list of all primary supertypes
149 Klass* _primary_supers[_primary_super_limit];
150 // java/lang/Class instance mirroring this class
151 OopHandle _java_mirror;
152 // Superclass
153 Klass* _super;
154 // First subclass (null if none); _subklass->next_sibling() is next one
155 Klass* volatile _subklass;
156 // Sibling link (or null); links all subklasses of a klass
157 Klass* volatile _next_sibling;
158
159 // All klasses loaded by a class loader are chained through these links
160 Klass* _next_link;
161
162 // The VM's representation of the ClassLoader used to load this class.
163 // Provide access the corresponding instance java.lang.ClassLoader.
164 ClassLoaderData* _class_loader_data;
165
166 // Bitmap and hash code used by hashed secondary supers.
167 uintx _secondary_supers_bitmap;
168 uint8_t _hash_slot;
169
170 int _vtable_len; // vtable length. This field may be read very often when we
171 // have lots of itable dispatches (e.g., lambdas and streams).
172 // Keep it away from the beginning of a Klass to avoid cacheline
173 // contention that may happen when a nearby object is modified.
174 AccessFlags _access_flags; // Access flags. The class/interface distinction is stored here.
175 // Some flags created by the JVM, not in the class file itself,
176 // are in _misc_flags below.
177
178 JFR_ONLY(DEFINE_TRACE_ID_FIELD;)
179
180 markWord _prototype_header; // inline type and inline array mark patterns
181 private:
182 // This is an index into FileMapHeader::_shared_path_table[], to
183 // associate this class with the JAR file where it's loaded from during
184 // dump time. If a class is not loaded from the shared archive, this field is
185 // -1.
186 s2 _shared_class_path_index;
187
188 #if INCLUDE_CDS
189 // Various attributes for shared classes. Should be zero for a non-shared class.
190 u2 _shared_class_flags;
191 enum CDSSharedClassFlags {
192 _is_shared_class = 1 << 0, // shadows MetaspaceObj::is_shared
193 _archived_lambda_proxy_is_available = 1 << 1,
194 _has_value_based_class_annotation = 1 << 2,
195 _verified_at_dump_time = 1 << 3,
196 _has_archived_enum_objs = 1 << 4,
197 // This class was not loaded from a classfile in the module image
198 // or classpath.
199 _is_generated_shared_class = 1 << 5
200 };
201 #endif
202
203 KlassFlags _misc_flags;
204
205 CDS_JAVA_HEAP_ONLY(int _archived_mirror_index;)
206
207 protected:
208
209 Klass(KlassKind kind);
210 Klass();
211
212 public:
213 int kind() { return _kind; }
214
215 enum class DefaultsLookupMode { find, skip };
216 enum class OverpassLookupMode { find, skip };
217 enum class StaticLookupMode { find, skip };
218 enum class PrivateLookupMode { find, skip };
219
220 virtual bool is_klass() const { return true; }
221
222 // super() cannot be InstanceKlass* -- Java arrays are covariant, and _super is used
223 // to implement that. NB: the _super of "[Ljava/lang/Integer;" is "[Ljava/lang/Number;"
224 // If this is not what your code expects, you're probably looking for Klass::java_super().
225 Klass* super() const { return _super; }
226 void set_super(Klass* k) { _super = k; }
227
228 // initializes _super link, _primary_supers & _secondary_supers arrays
229 void initialize_supers(Klass* k, Array<InstanceKlass*>* transitive_interfaces, TRAPS);
230
231 // klass-specific helper for initializing _secondary_supers
232 virtual GrowableArray<Klass*>* compute_secondary_supers(int num_extra_slots,
233 Array<InstanceKlass*>* transitive_interfaces);
234
235 // java_super is the Java-level super type as specified by Class.getSuperClass.
236 virtual InstanceKlass* java_super() const { return nullptr; }
237
238 juint super_check_offset() const { return _super_check_offset; }
239 void set_super_check_offset(juint o) { _super_check_offset = o; }
240
241 Klass* secondary_super_cache() const { return _secondary_super_cache; }
242 void set_secondary_super_cache(Klass* k) { _secondary_super_cache = k; }
243
244 Array<Klass*>* secondary_supers() const { return _secondary_supers; }
245 void set_secondary_supers(Array<Klass*>* k, uintx bitmap);
246
247 uint8_t hash_slot() const { return _hash_slot; }
248
249 // Return the element of the _super chain of the given depth.
250 // If there is no such element, return either null or this.
251 Klass* primary_super_of_depth(juint i) const {
252 assert(i < primary_super_limit(), "oob");
253 Klass* super = _primary_supers[i];
254 assert(super == nullptr || super->super_depth() == i, "correct display");
255 return super;
256 }
257
258 // Can this klass be a primary super? False for interfaces and arrays of
259 // interfaces. False also for arrays or classes with long super chains.
260 bool can_be_primary_super() const {
261 const juint secondary_offset = in_bytes(secondary_super_cache_offset());
262 return super_check_offset() != secondary_offset;
263 }
264 virtual bool can_be_primary_super_slow() const;
265
266 // Returns number of primary supers; may be a number in the inclusive range [0, primary_super_limit].
267 juint super_depth() const {
268 if (!can_be_primary_super()) {
269 return primary_super_limit();
270 } else {
271 juint d = (super_check_offset() - in_bytes(primary_supers_offset())) / sizeof(Klass*);
272 assert(d < primary_super_limit(), "oob");
273 assert(_primary_supers[d] == this, "proper init");
274 return d;
275 }
276 }
277
278 // java mirror
279 oop java_mirror() const;
280 oop java_mirror_no_keepalive() const;
281 void set_java_mirror(Handle m);
282
283 oop archived_java_mirror() NOT_CDS_JAVA_HEAP_RETURN_(nullptr);
284 void set_archived_java_mirror(int mirror_index) NOT_CDS_JAVA_HEAP_RETURN;
285
286 // Temporary mirror switch used by RedefineClasses
287 OopHandle java_mirror_handle() const { return _java_mirror; }
288 void swap_java_mirror_handle(OopHandle& mirror) { _java_mirror.swap(mirror); }
289
290 // Set java mirror OopHandle to null for CDS
291 // This leaves the OopHandle in the CLD, but that's ok, you can't release them.
292 void clear_java_mirror_handle() { _java_mirror = OopHandle(); }
293
294 // modifier flags
295 jint modifier_flags() const { return _modifier_flags; }
296 void set_modifier_flags(jint flags) { _modifier_flags = flags; }
297
298 // size helper
299 int layout_helper() const { return _layout_helper; }
300 void set_layout_helper(int lh) { _layout_helper = lh; }
301
302 // Note: for instances layout_helper() may include padding.
303 // Use InstanceKlass::contains_field_offset to classify field offsets.
304
305 // sub/superklass links
306 Klass* subklass(bool log = false) const;
307 Klass* next_sibling(bool log = false) const;
308
309 InstanceKlass* superklass() const;
310 void append_to_sibling_list(); // add newly created receiver to superklass' subklass list
311
312 void set_next_link(Klass* k) { _next_link = k; }
313 Klass* next_link() const { return _next_link; } // The next klass defined by the class loader.
314 Klass** next_link_addr() { return &_next_link; }
315
316 // class loader data
317 ClassLoaderData* class_loader_data() const { return _class_loader_data; }
318 void set_class_loader_data(ClassLoaderData* loader_data) { _class_loader_data = loader_data; }
319
320 s2 shared_classpath_index() const {
321 return _shared_class_path_index;
322 };
323
324 void set_shared_classpath_index(s2 index) {
325 _shared_class_path_index = index;
326 };
327
328 bool has_archived_mirror_index() const {
329 CDS_JAVA_HEAP_ONLY(return _archived_mirror_index >= 0;)
330 NOT_CDS_JAVA_HEAP(return false);
331 }
332
333 void clear_archived_mirror_index() NOT_CDS_JAVA_HEAP_RETURN;
334
335 void set_lambda_proxy_is_available() {
336 CDS_ONLY(_shared_class_flags |= _archived_lambda_proxy_is_available;)
337 }
338 void clear_lambda_proxy_is_available() {
339 CDS_ONLY(_shared_class_flags &= (u2)(~_archived_lambda_proxy_is_available);)
340 }
341 bool lambda_proxy_is_available() const {
342 CDS_ONLY(return (_shared_class_flags & _archived_lambda_proxy_is_available) != 0;)
343 NOT_CDS(return false;)
344 }
345
346 void set_has_value_based_class_annotation() {
347 CDS_ONLY(_shared_class_flags |= _has_value_based_class_annotation;)
348 }
349 void clear_has_value_based_class_annotation() {
350 CDS_ONLY(_shared_class_flags &= (u2)(~_has_value_based_class_annotation);)
351 }
352 bool has_value_based_class_annotation() const {
353 CDS_ONLY(return (_shared_class_flags & _has_value_based_class_annotation) != 0;)
354 NOT_CDS(return false;)
355 }
356
357 void set_verified_at_dump_time() {
358 CDS_ONLY(_shared_class_flags |= _verified_at_dump_time;)
359 }
360 bool verified_at_dump_time() const {
361 CDS_ONLY(return (_shared_class_flags & _verified_at_dump_time) != 0;)
362 NOT_CDS(return false;)
363 }
364
365 void set_has_archived_enum_objs() {
366 CDS_ONLY(_shared_class_flags |= _has_archived_enum_objs;)
367 }
368 bool has_archived_enum_objs() const {
369 CDS_ONLY(return (_shared_class_flags & _has_archived_enum_objs) != 0;)
370 NOT_CDS(return false;)
371 }
372
373 void set_is_generated_shared_class() {
374 CDS_ONLY(_shared_class_flags |= _is_generated_shared_class;)
375 }
376 bool is_generated_shared_class() const {
377 CDS_ONLY(return (_shared_class_flags & _is_generated_shared_class) != 0;)
378 NOT_CDS(return false;)
379 }
380
381 bool is_shared() const { // shadows MetaspaceObj::is_shared)()
382 CDS_ONLY(return (_shared_class_flags & _is_shared_class) != 0;)
383 NOT_CDS(return false;)
384 }
385
386 void set_is_shared() {
387 CDS_ONLY(_shared_class_flags |= _is_shared_class;)
388 }
389
390 // Obtain the module or package for this class
391 virtual ModuleEntry* module() const = 0;
392 virtual PackageEntry* package() const = 0;
393
394 protected: // internal accessors
395 void set_subklass(Klass* s);
396 void set_next_sibling(Klass* s);
397
398 private:
399 static uint8_t compute_hash_slot(Symbol* s);
400 static void hash_insert(Klass* klass, GrowableArray<Klass*>* secondaries, uintx& bitmap);
401 static uintx hash_secondary_supers(Array<Klass*>* secondaries, bool rewrite);
402
403 bool search_secondary_supers(Klass* k) const;
404 bool lookup_secondary_supers_table(Klass *k) const;
405 bool linear_search_secondary_supers(const Klass* k) const;
406 bool fallback_search_secondary_supers(const Klass* k, int index, uintx rotated_bitmap) const;
407
408 public:
409 // Secondary supers table support
410 static Array<Klass*>* pack_secondary_supers(ClassLoaderData* loader_data,
411 GrowableArray<Klass*>* primaries,
412 GrowableArray<Klass*>* secondaries,
413 uintx& bitmap,
414 TRAPS);
415
416 static uintx compute_secondary_supers_bitmap(Array<Klass*>* secondary_supers);
417 static uint8_t compute_home_slot(Klass* k, uintx bitmap);
418
419 static constexpr int SECONDARY_SUPERS_TABLE_SIZE = sizeof(_secondary_supers_bitmap) * 8;
420 static constexpr int SECONDARY_SUPERS_TABLE_MASK = SECONDARY_SUPERS_TABLE_SIZE - 1;
421
422 static constexpr uintx SECONDARY_SUPERS_BITMAP_EMPTY = 0;
423 static constexpr uintx SECONDARY_SUPERS_BITMAP_FULL = ~(uintx)0;
424
425 // Compiler support
426 static ByteSize super_offset() { return byte_offset_of(Klass, _super); }
427 static ByteSize super_check_offset_offset() { return byte_offset_of(Klass, _super_check_offset); }
428 static ByteSize primary_supers_offset() { return byte_offset_of(Klass, _primary_supers); }
429 static ByteSize secondary_super_cache_offset() { return byte_offset_of(Klass, _secondary_super_cache); }
430 static ByteSize secondary_supers_offset() { return byte_offset_of(Klass, _secondary_supers); }
431 static ByteSize java_mirror_offset() { return byte_offset_of(Klass, _java_mirror); }
432 static ByteSize class_loader_data_offset() { return byte_offset_of(Klass, _class_loader_data); }
433 static ByteSize modifier_flags_offset() { return byte_offset_of(Klass, _modifier_flags); }
434 static ByteSize layout_helper_offset() { return byte_offset_of(Klass, _layout_helper); }
435 static ByteSize access_flags_offset() { return byte_offset_of(Klass, _access_flags); }
436 #if INCLUDE_JVMCI
437 static ByteSize subklass_offset() { return byte_offset_of(Klass, _subklass); }
438 static ByteSize next_sibling_offset() { return byte_offset_of(Klass, _next_sibling); }
439 #endif
440 static ByteSize secondary_supers_bitmap_offset()
441 { return byte_offset_of(Klass, _secondary_supers_bitmap); }
442 static ByteSize hash_slot_offset() { return byte_offset_of(Klass, _hash_slot); }
443 static ByteSize misc_flags_offset() { return byte_offset_of(Klass, _misc_flags._flags); }
444
445 // Unpacking layout_helper:
446 static const int _lh_neutral_value = 0; // neutral non-array non-instance value
447 static const int _lh_instance_slow_path_bit = 0x01;
448 static const int _lh_log2_element_size_shift = BitsPerByte*0;
449 static const int _lh_log2_element_size_mask = BitsPerLong-1;
450 static const int _lh_element_type_shift = BitsPerByte*1;
451 static const int _lh_element_type_mask = right_n_bits(BitsPerByte); // shifted mask
452 static const int _lh_header_size_shift = BitsPerByte*2;
453 static const int _lh_header_size_mask = right_n_bits(BitsPerByte); // shifted mask
454 static const int _lh_array_tag_bits = 3;
455 static const int _lh_array_tag_shift = BitsPerInt - _lh_array_tag_bits;
456
457 static const unsigned int _lh_array_tag_type_value = 0Xfffffffc;
458 static const unsigned int _lh_array_tag_vt_value = 0Xfffffffd;
459 static const unsigned int _lh_array_tag_obj_value = 0Xfffffffe;
460
461 // null-free array flag bit under the array tag bits, shift one more to get array tag value
462 static const int _lh_null_free_shift = _lh_array_tag_shift - 1;
463 static const int _lh_null_free_mask = 1;
464
465 static const jint _lh_array_tag_flat_value_bit_inplace = (jint) (1 << _lh_array_tag_shift);
466
467 static int layout_helper_size_in_bytes(jint lh) {
468 assert(lh > (jint)_lh_neutral_value, "must be instance");
469 return (int) lh & ~_lh_instance_slow_path_bit;
470 }
471 static bool layout_helper_needs_slow_path(jint lh) {
472 assert(lh > (jint)_lh_neutral_value, "must be instance");
473 return (lh & _lh_instance_slow_path_bit) != 0;
474 }
475 static bool layout_helper_is_instance(jint lh) {
476 return (jint)lh > (jint)_lh_neutral_value;
477 }
478 static bool layout_helper_is_array(jint lh) {
479 return (jint)lh < (jint)_lh_neutral_value;
480 }
481 static bool layout_helper_is_typeArray(jint lh) {
482 return (juint) _lh_array_tag_type_value == (juint)(lh >> _lh_array_tag_shift);
483 }
484 static bool layout_helper_is_objArray(jint lh) {
485 return (juint)_lh_array_tag_obj_value == (juint)(lh >> _lh_array_tag_shift);
486 }
487 static bool layout_helper_is_flatArray(jint lh) {
488 return (juint)_lh_array_tag_vt_value == (juint)(lh >> _lh_array_tag_shift);
489 }
490 static bool layout_helper_is_null_free(jint lh) {
491 assert(layout_helper_is_flatArray(lh) || layout_helper_is_objArray(lh), "must be array of inline types");
492 return ((lh >> _lh_null_free_shift) & _lh_null_free_mask);
493 }
494 static jint layout_helper_set_null_free(jint lh) {
495 lh |= (_lh_null_free_mask << _lh_null_free_shift);
496 assert(layout_helper_is_null_free(lh), "Bad encoding");
497 return lh;
498 }
499 static int layout_helper_header_size(jint lh) {
500 assert(lh < (jint)_lh_neutral_value, "must be array");
501 int hsize = (lh >> _lh_header_size_shift) & _lh_header_size_mask;
502 assert(hsize > 0 && hsize < (int)sizeof(oopDesc)*3, "sanity");
503 return hsize;
504 }
505 static BasicType layout_helper_element_type(jint lh) {
506 assert(lh < (jint)_lh_neutral_value, "must be array");
507 int btvalue = (lh >> _lh_element_type_shift) & _lh_element_type_mask;
508 assert((btvalue >= T_BOOLEAN && btvalue <= T_OBJECT) || btvalue == T_PRIMITIVE_OBJECT, "sanity");
509 return (BasicType) btvalue;
510 }
511
512 // Want a pattern to quickly diff against layout header in register
513 // find something less clever!
514 static int layout_helper_boolean_diffbit() {
515 jint zlh = array_layout_helper(T_BOOLEAN);
516 jint blh = array_layout_helper(T_BYTE);
517 assert(zlh != blh, "array layout helpers must differ");
518 int diffbit = 1;
519 while ((diffbit & (zlh ^ blh)) == 0 && (diffbit & zlh) == 0) {
520 diffbit <<= 1;
521 assert(diffbit != 0, "make sure T_BOOLEAN has a different bit than T_BYTE");
522 }
523 return diffbit;
524 }
525
526 static int layout_helper_log2_element_size(jint lh) {
527 assert(lh < (jint)_lh_neutral_value, "must be array");
528 int l2esz = (lh >> _lh_log2_element_size_shift) & _lh_log2_element_size_mask;
529 assert(layout_helper_element_type(lh) == T_PRIMITIVE_OBJECT || l2esz <= LogBytesPerLong,
530 "sanity. l2esz: 0x%x for lh: 0x%x", (uint)l2esz, (uint)lh);
531 return l2esz;
532 }
533 static jint array_layout_helper(jint tag, bool null_free, int hsize, BasicType etype, int log2_esize) {
534 return (tag << _lh_array_tag_shift)
535 | ((null_free ? 1 : 0) << _lh_null_free_shift)
536 | (hsize << _lh_header_size_shift)
537 | ((int)etype << _lh_element_type_shift)
538 | (log2_esize << _lh_log2_element_size_shift);
539 }
540 static jint instance_layout_helper(jint size, bool slow_path_flag) {
541 return (size << LogBytesPerWord)
542 | (slow_path_flag ? _lh_instance_slow_path_bit : 0);
543 }
544 static int layout_helper_to_size_helper(jint lh) {
545 assert(lh > (jint)_lh_neutral_value, "must be instance");
546 // Note that the following expression discards _lh_instance_slow_path_bit.
547 return lh >> LogBytesPerWord;
548 }
549 // Out-of-line version computes everything based on the etype:
550 static jint array_layout_helper(BasicType etype);
551
552 // What is the maximum number of primary superclasses any klass can have?
553 static juint primary_super_limit() { return _primary_super_limit; }
554
555 // vtables
556 klassVtable vtable() const;
557 int vtable_length() const { return _vtable_len; }
558
559 // subclass check
560 bool is_subclass_of(const Klass* k) const;
561
562 // subtype check: true if is_subclass_of, or if k is interface and receiver implements it
563 bool is_subtype_of(Klass* k) const;
564
565 public:
566 // Find LCA in class hierarchy
567 Klass *LCA( Klass *k );
568
569 // Check whether reflection/jni/jvm code is allowed to instantiate this class;
570 // if not, throw either an Error or an Exception.
571 virtual void check_valid_for_instantiation(bool throwError, TRAPS);
572
573 // array copying
574 virtual void copy_array(arrayOop s, int src_pos, arrayOop d, int dst_pos, int length, TRAPS);
575
576 // tells if the class should be initialized
577 virtual bool should_be_initialized() const { return false; }
578 // initializes the klass
579 virtual void initialize(TRAPS);
580 virtual Klass* find_field(Symbol* name, Symbol* signature, fieldDescriptor* fd) const;
581 virtual Method* uncached_lookup_method(const Symbol* name, const Symbol* signature,
582 OverpassLookupMode overpass_mode,
583 PrivateLookupMode = PrivateLookupMode::find) const;
584 public:
585 Method* lookup_method(const Symbol* name, const Symbol* signature) const {
586 return uncached_lookup_method(name, signature, OverpassLookupMode::find);
587 }
588
589 // array class with specific rank
590 virtual ArrayKlass* array_klass(int rank, TRAPS) = 0;
591
592 // array class with this klass as element type
593 virtual ArrayKlass* array_klass(TRAPS) = 0;
594
595 // These will return null instead of allocating on the heap:
596 virtual ArrayKlass* array_klass_or_null(int rank) = 0;
597 virtual ArrayKlass* array_klass_or_null() = 0;
598
599 virtual oop protection_domain() const = 0;
600
601 oop class_loader() const;
602
603 inline oop klass_holder() const;
604
605 protected:
606
607 // Error handling when length > max_length or length < 0
608 static void check_array_allocation_length(int length, int max_length, TRAPS);
609
610 void set_vtable_length(int len) { _vtable_len= len; }
611
612 vtableEntry* start_of_vtable() const;
613 #if INCLUDE_CDS
614 void restore_unshareable_info(ClassLoaderData* loader_data, Handle protection_domain, TRAPS);
615 #endif
616 public:
617 Method* method_at_vtable(int index);
618
619 static ByteSize vtable_start_offset();
620 static ByteSize vtable_length_offset() {
621 return byte_offset_of(Klass, _vtable_len);
622 }
623
624 #if INCLUDE_CDS
625 // CDS support - remove and restore oops from metadata. Oops are not shared.
626 virtual void remove_unshareable_info();
627 virtual void remove_java_mirror();
628
629 bool is_unshareable_info_restored() const {
630 assert(is_shared(), "use this for shared classes only");
631 if (has_archived_mirror_index()) {
632 // _java_mirror is not a valid OopHandle but rather an encoded reference in the shared heap
633 return false;
634 } else if (_java_mirror.is_empty()) {
635 return false;
636 } else {
637 return true;
638 }
639 }
640 #endif // INCLUDE_CDS
641
642 public:
643 // ALL FUNCTIONS BELOW THIS POINT ARE DISPATCHED FROM AN OOP
644 // These functions describe behavior for the oop not the KLASS.
645
646 // actual oop size of obj in memory in word size.
647 virtual size_t oop_size(oop obj) const = 0;
648
649 // Size of klass in word size.
650 virtual int size() const = 0;
651
652 // Returns the Java name for a class (Resource allocated)
653 // For arrays, this returns the name of the element with a leading '['.
654 // For classes, this returns the name with the package separators
655 // turned into '.'s.
656 const char* external_name() const;
657 // Returns the name for a class (Resource allocated) as the class
658 // would appear in a signature.
659 // For arrays, this returns the name of the element with a leading '['.
660 // For classes, this returns the name with a leading 'L' and a trailing ';'
661 // and the package separators as '/'.
662 virtual const char* signature_name() const;
663
664 const char* joint_in_module_of_loader(const Klass* class2, bool include_parent_loader = false) const;
665 const char* class_in_module_of_loader(bool use_are = false, bool include_parent_loader = false) const;
666
667 // Returns "interface", "abstract class" or "class".
668 const char* external_kind() const;
669
670 // type testing operations
671 #ifdef ASSERT
672 protected:
673 virtual bool is_instance_klass_slow() const { return false; }
674 virtual bool is_array_klass_slow() const { return false; }
675 virtual bool is_objArray_klass_slow() const { return false; }
676 virtual bool is_typeArray_klass_slow() const { return false; }
677 virtual bool is_flatArray_klass_slow() const { return false; }
678 #endif // ASSERT
679 // current implementation uses this method even in non debug builds
680 virtual bool is_inline_klass_slow() const { return false; }
681 public:
682
683 // Fast non-virtual versions
684 #ifndef ASSERT
685 #define assert_same_query(xval, xcheck) xval
686 #else
687 private:
688 static bool assert_same_query(bool xval, bool xslow) {
689 assert(xval == xslow, "slow and fast queries agree");
690 return xval;
691 }
692 public:
693 #endif
694
695 bool is_instance_klass() const { return assert_same_query(_kind <= InstanceStackChunkKlassKind, is_instance_klass_slow()); }
696 bool is_inline_klass() const { return assert_same_query(_kind == InlineKlassKind, is_inline_klass_slow()); }
697 bool is_reference_instance_klass() const { return _kind == InstanceRefKlassKind; }
698 bool is_mirror_instance_klass() const { return _kind == InstanceMirrorKlassKind; }
699 bool is_class_loader_instance_klass() const { return _kind == InstanceClassLoaderKlassKind; }
700 bool is_array_klass() const { return assert_same_query( _kind >= TypeArrayKlassKind, is_array_klass_slow()); }
701 bool is_stack_chunk_instance_klass() const { return _kind == InstanceStackChunkKlassKind; }
702 bool is_flatArray_klass() const { return assert_same_query( _kind == FlatArrayKlassKind, is_flatArray_klass_slow()); }
703 bool is_objArray_klass() const { return assert_same_query( _kind == ObjArrayKlassKind, is_objArray_klass_slow()); }
704 bool is_typeArray_klass() const { return assert_same_query( _kind == TypeArrayKlassKind, is_typeArray_klass_slow()); }
705 #undef assert_same_query
706
707 inline bool is_null_free_array_klass() const { return layout_helper_is_null_free(layout_helper()); }
708
709 // Access flags
710 AccessFlags access_flags() const { return _access_flags; }
711 void set_access_flags(AccessFlags flags) { _access_flags = flags; }
712
713 bool is_public() const { return _access_flags.is_public(); }
714 bool is_final() const { return _access_flags.is_final(); }
715 bool is_interface() const { return _access_flags.is_interface(); }
716 bool is_abstract() const { return _access_flags.is_abstract(); }
717 bool is_synthetic() const { return _access_flags.is_synthetic(); }
718 bool is_identity_class() const { return _access_flags.is_identity_class(); }
719 void set_is_synthetic() { _access_flags.set_is_synthetic(); }
720 bool has_finalizer() const { return _misc_flags.has_finalizer(); }
721 void set_has_finalizer() { _misc_flags.set_has_finalizer(true); }
722 bool is_hidden() const { return _misc_flags.is_hidden_class(); }
723 void set_is_hidden() { _misc_flags.set_is_hidden_class(true); }
724 bool is_value_based() const { return _misc_flags.is_value_based_class(); }
725 void set_is_value_based() { _misc_flags.set_is_value_based_class(true); }
726
727 klass_flags_t misc_flags() const { return _misc_flags.value(); }
728
729 inline bool is_non_strong_hidden() const;
730
731 bool is_cloneable() const;
732 void set_is_cloneable();
733
734 // inline types and inline type array patterns
735 markWord prototype_header() const {
736 return _prototype_header;
737 }
738 static inline markWord default_prototype_header(Klass* k) {
739 return (k == nullptr) ? markWord::prototype() : k->prototype_header();
740 }
741
742 inline void set_prototype_header(markWord header);
743 static ByteSize prototype_header_offset() { return in_ByteSize(offset_of(Klass, _prototype_header)); }
744
745 JFR_ONLY(DEFINE_TRACE_ID_METHODS;)
746
747 virtual void metaspace_pointers_do(MetaspaceClosure* iter);
748 virtual MetaspaceObj::Type type() const { return ClassType; }
749
750 inline bool is_loader_alive() const;
751
752 void clean_subklass();
753
754 static void clean_weak_klass_links(bool unloading_occurred, bool clean_alive_klasses = true);
755 static void clean_subklass_tree() {
756 clean_weak_klass_links(/*unloading_occurred*/ true , /* clean_alive_klasses */ false);
757 }
758
759 // Return self, except for abstract classes with exactly 1
760 // implementor. Then return the 1 concrete implementation.
761 Klass *up_cast_abstract();
762
763 // klass name
764 Symbol* name() const { return _name; }
765 void set_name(Symbol* n);
766
767 virtual void release_C_heap_structures(bool release_constant_pool = true);
768
769 public:
770 virtual jint compute_modifier_flags() const = 0;
771
772 // JVMTI support
773 virtual jint jvmti_class_status() const;
774
775 // Printing
776 virtual void print_on(outputStream* st) const;
777
778 virtual void oop_print_value_on(oop obj, outputStream* st);
779 virtual void oop_print_on (oop obj, outputStream* st);
780
781 void print_secondary_supers_on(outputStream* st) const;
782
783 virtual const char* internal_name() const = 0;
784
785 // Verification
786 virtual void verify_on(outputStream* st);
787 void verify() { verify_on(tty); }
788
789 #ifndef PRODUCT
790 bool verify_vtable_index(int index);
791 #endif
792
793 virtual void oop_verify_on(oop obj, outputStream* st);
794
795 // for error reporting
796 static bool is_valid(Klass* k);
797
798 static void on_secondary_supers_verification_failure(Klass* super, Klass* sub, bool linear_result, bool table_result, const char* msg);
799 };
800
801 #endif // SHARE_OOPS_KLASS_HPP