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