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_INSTANCEKLASS_HPP
26 #define SHARE_OOPS_INSTANCEKLASS_HPP
27
28 #include "memory/allocation.hpp"
29 #include "memory/referenceType.hpp"
30 #include "oops/annotations.hpp"
31 #include "oops/constMethod.hpp"
32 #include "oops/fieldInfo.hpp"
33 #include "oops/instanceKlassFlags.hpp"
34 #include "oops/instanceOop.hpp"
35 #include "runtime/handles.hpp"
36 #include "runtime/javaThread.hpp"
37 #include "utilities/accessFlags.hpp"
38 #include "utilities/align.hpp"
39 #include "utilities/growableArray.hpp"
40 #include "utilities/macros.hpp"
41 #if INCLUDE_JFR
42 #include "jfr/support/jfrKlassExtension.hpp"
43 #endif
44
45 class ConstantPool;
46 class DeoptimizationScope;
47 class klassItable;
48 class RecordComponent;
49
50 // An InstanceKlass is the VM level representation of a Java class.
51 // It contains all information needed for at class at execution runtime.
52
53 // InstanceKlass embedded field layout (after declared fields):
54 // [EMBEDDED Java vtable ] size in words = vtable_len
55 // [EMBEDDED nonstatic oop-map blocks] size in words = nonstatic_oop_map_size
56 // The embedded nonstatic oop-map blocks are short pairs (offset, length)
57 // indicating where oops are located in instances of this klass.
58 // [EMBEDDED implementor of the interface] only exist for interface
59
60
61 // forward declaration for class -- see below for definition
62 #if INCLUDE_JVMTI
63 class BreakpointInfo;
64 #endif
65 class ClassFileParser;
66 class ClassFileStream;
67 class KlassDepChange;
68 class DependencyContext;
69 class fieldDescriptor;
70 class JNIid;
71 class JvmtiCachedClassFieldMap;
72 class nmethodBucket;
73 class OopMapCache;
74 class InterpreterOopMap;
75 class PackageEntry;
76 class ModuleEntry;
77
78 // This is used in iterators below.
79 class FieldClosure: public StackObj {
80 public:
81 virtual void do_field(fieldDescriptor* fd) = 0;
82 };
83
84 // Print fields.
85 // If "obj" argument to constructor is null, prints static fields, otherwise prints non-static fields.
86 class FieldPrinter: public FieldClosure {
87 oop _obj;
88 outputStream* _st;
89 public:
90 FieldPrinter(outputStream* st, oop obj = nullptr) : _obj(obj), _st(st) {}
91 void do_field(fieldDescriptor* fd);
92 };
93
94 // Describes where oops are located in instances of this klass.
95 class OopMapBlock {
96 public:
97 // Byte offset of the first oop mapped by this block.
98 int offset() const { return _offset; }
99 void set_offset(int offset) { _offset = offset; }
100
101 // Number of oops in this block.
102 uint count() const { return _count; }
103 void set_count(uint count) { _count = count; }
104
105 void increment_count(int diff) { _count += diff; }
106
107 int offset_span() const { return _count * heapOopSize; }
108
109 int end_offset() const {
110 return offset() + offset_span();
111 }
112
113 bool is_contiguous(int another_offset) const {
114 return another_offset == end_offset();
115 }
116
117 // sizeof(OopMapBlock) in words.
118 static int size_in_words() {
119 return align_up((int)sizeof(OopMapBlock), wordSize) >>
120 LogBytesPerWord;
121 }
122
123 static int compare_offset(const OopMapBlock* a, const OopMapBlock* b) {
124 return a->offset() - b->offset();
125 }
126
127 private:
128 int _offset;
129 uint _count;
130 };
131
132 struct JvmtiCachedClassFileData;
133
134 class InstanceKlass: public Klass {
135 friend class VMStructs;
136 friend class JVMCIVMStructs;
137 friend class ClassFileParser;
138 friend class CompileReplay;
139
140 public:
141 static const KlassKind Kind = InstanceKlassKind;
142
143 protected:
144 InstanceKlass(const ClassFileParser& parser, KlassKind kind = Kind, ReferenceType reference_type = REF_NONE);
145
146 public:
147 InstanceKlass();
148
149 // See "The Java Virtual Machine Specification" section 2.16.2-5 for a detailed description
150 // of the class loading & initialization procedure, and the use of the states.
151 enum ClassState : u1 {
152 allocated, // allocated (but not yet linked)
153 loaded, // loaded and inserted in class hierarchy (but not linked yet)
154 linked, // successfully linked/verified (but not initialized yet)
155 being_initialized, // currently running class initializer
156 fully_initialized, // initialized (successful final state)
157 initialization_error // error happened during initialization
158 };
159
160 private:
161 static InstanceKlass* allocate_instance_klass(const ClassFileParser& parser, TRAPS);
162
163 protected:
164 // If you add a new field that points to any metaspace object, you
165 // must add this field to InstanceKlass::metaspace_pointers_do().
166
167 // Annotations for this class
168 Annotations* _annotations;
169 // Package this class is defined in
170 PackageEntry* _package_entry;
171 // Array classes holding elements of this class.
172 ObjArrayKlass* volatile _array_klasses;
173 // Constant pool for this class.
174 ConstantPool* _constants;
175 // The InnerClasses attribute and EnclosingMethod attribute. The
176 // _inner_classes is an array of shorts. If the class has InnerClasses
177 // attribute, then the _inner_classes array begins with 4-tuples of shorts
178 // [inner_class_info_index, outer_class_info_index,
179 // inner_name_index, inner_class_access_flags] for the InnerClasses
180 // attribute. If the EnclosingMethod attribute exists, it occupies the
181 // last two shorts [class_index, method_index] of the array. If only
182 // the InnerClasses attribute exists, the _inner_classes array length is
183 // number_of_inner_classes * 4. If the class has both InnerClasses
184 // and EnclosingMethod attributes the _inner_classes array length is
185 // number_of_inner_classes * 4 + enclosing_method_attribute_size.
186 Array<jushort>* _inner_classes;
187
188 // The NestMembers attribute. An array of shorts, where each is a
189 // class info index for the class that is a nest member. This data
190 // has not been validated.
191 Array<jushort>* _nest_members;
192
193 // Resolved nest-host klass: either true nest-host or self if we are not
194 // nested, or an error occurred resolving or validating the nominated
195 // nest-host. Can also be set directly by JDK API's that establish nest
196 // relationships.
197 // By always being set it makes nest-member access checks simpler.
198 InstanceKlass* _nest_host;
199
200 // The PermittedSubclasses attribute. An array of shorts, where each is a
201 // class info index for the class that is a permitted subclass.
202 Array<jushort>* _permitted_subclasses;
203
204 // The contents of the Record attribute.
205 Array<RecordComponent*>* _record_components;
206
207 // the source debug extension for this klass, null if not specified.
208 // Specified as UTF-8 string without terminating zero byte in the classfile,
209 // it is stored in the instanceklass as a null-terminated UTF-8 string
210 const char* _source_debug_extension;
211
212 // Number of heapOopSize words used by non-static fields in this klass
213 // (including inherited fields but after header_size()).
214 int _nonstatic_field_size;
215 int _static_field_size; // number words used by static fields (oop and non-oop) in this klass
216 int _nonstatic_oop_map_size; // size in words of nonstatic oop map blocks
217 int _itable_len; // length of Java itable (in words)
218
219 // The NestHost attribute. The class info index for the class
220 // that is the nest-host of this class. This data has not been validated.
221 u2 _nest_host_index;
222 u2 _this_class_index; // constant pool entry
223 u2 _static_oop_field_count; // number of static oop fields in this klass
224
225 volatile u2 _idnum_allocated_count; // JNI/JVMTI: increments with the addition of methods, old ids don't change
226
227 // Class states are defined as ClassState (see above).
228 // Place the _init_state here to utilize the unused 2-byte after
229 // _idnum_allocated_count.
230 volatile ClassState _init_state; // state of class
231
232 u1 _reference_type; // reference type
233
234 AccessFlags _access_flags; // Access flags. The class/interface distinction is stored here.
235
236 // State is set either at parse time or while executing, atomically to not disturb other state
237 InstanceKlassFlags _misc_flags;
238
239 JavaThread* volatile _init_thread; // Pointer to current thread doing initialization (to handle recursive initialization)
240
241 OopMapCache* volatile _oop_map_cache; // OopMapCache for all methods in the klass (allocated lazily)
242 JNIid* _jni_ids; // First JNI identifier for static fields in this class
243 jmethodID* volatile _methods_jmethod_ids; // jmethodIDs corresponding to method_idnum, or null if none
244 nmethodBucket* volatile _dep_context; // packed DependencyContext structure
245 uint64_t volatile _dep_context_last_cleaned;
246 nmethod* _osr_nmethods_head; // Head of list of on-stack replacement nmethods for this class
247 #if INCLUDE_JVMTI
248 BreakpointInfo* _breakpoints; // bpt lists, managed by Method*
249 // Linked instanceKlasses of previous versions
250 InstanceKlass* _previous_versions;
251 // JVMTI fields can be moved to their own structure - see 6315920
252 // JVMTI: cached class file, before retransformable agent modified it in CFLH
253 JvmtiCachedClassFileData* _cached_class_file;
254 #endif
255
256 #if INCLUDE_JVMTI
257 JvmtiCachedClassFieldMap* _jvmti_cached_class_field_map; // JVMTI: used during heap iteration
258 #endif
259
260 NOT_PRODUCT(int _verify_count;) // to avoid redundant verifies
261 NOT_PRODUCT(volatile int _shared_class_load_count;) // ensure a shared class is loaded only once
262
263 // Method array.
264 Array<Method*>* _methods;
265 // Default Method Array, concrete methods inherited from interfaces
266 Array<Method*>* _default_methods;
267 // Interfaces (InstanceKlass*s) this class declares locally to implement.
268 Array<InstanceKlass*>* _local_interfaces;
269 // Interfaces (InstanceKlass*s) this class implements transitively.
270 Array<InstanceKlass*>* _transitive_interfaces;
271 // Int array containing the original order of method in the class file (for JVMTI).
272 Array<int>* _method_ordering;
273 // Int array containing the vtable_indices for default_methods
274 // offset matches _default_methods offset
275 Array<int>* _default_vtable_indices;
276
277 // Fields information is stored in an UNSIGNED5 encoded stream (see fieldInfo.hpp)
278 Array<u1>* _fieldinfo_stream;
279 Array<u1>* _fieldinfo_search_table;
280 Array<FieldStatus>* _fields_status;
281
282 // embedded Java vtable follows here
283 // embedded Java itables follows here
284 // embedded static fields follows here
285 // embedded nonstatic oop-map blocks follows here
286 // embedded implementor of this interface follows here
287 // The embedded implementor only exists if the current klass is an
288 // interface. The possible values of the implementor fall into following
289 // three cases:
290 // null: no implementor.
291 // A Klass* that's not itself: one implementor.
292 // Itself: more than one implementors.
293 //
294
295 friend class SystemDictionary;
296
297 static bool _disable_method_binary_search;
298
299 // Controls finalizer registration
300 static bool _finalization_enabled;
301
302 public:
303
304 // Queries finalization state
305 static bool is_finalization_enabled() { return _finalization_enabled; }
306
307 // Sets finalization state
308 static void set_finalization_enabled(bool val) { _finalization_enabled = val; }
309
310 // Access flags
311 AccessFlags access_flags() const { return _access_flags; }
312 void set_access_flags(AccessFlags flags) { _access_flags = flags; }
313
314 bool is_public() const { return _access_flags.is_public(); }
315 bool is_final() const { return _access_flags.is_final(); }
316 bool is_interface() const override { return _access_flags.is_interface(); }
317 bool is_abstract() const override { return _access_flags.is_abstract(); }
318 bool is_super() const { return _access_flags.is_super(); }
319 bool is_synthetic() const { return _access_flags.is_synthetic(); }
320 void set_is_synthetic() { _access_flags.set_is_synthetic(); }
321
322 static ByteSize access_flags_offset() { return byte_offset_of(InstanceKlass, _access_flags); }
323
324 void set_is_cloneable();
325
326 // Quick checks for the loader that defined this class (without switching on this->class_loader())
327 bool defined_by_boot_loader() const { return _misc_flags.defined_by_boot_loader(); }
328 bool defined_by_platform_loader() const { return _misc_flags.defined_by_platform_loader(); }
329 bool defined_by_app_loader() const { return _misc_flags.defined_by_app_loader(); }
330 bool defined_by_other_loaders() const { return _misc_flags.defined_by_other_loaders(); }
331 void set_class_loader_type() { _misc_flags.set_class_loader_type(_class_loader_data); }
332
333 // Check if the class can be shared in CDS
334 bool is_shareable() const;
335
336 bool shared_loading_failed() const { return _misc_flags.shared_loading_failed(); }
337
338 void set_shared_loading_failed() { _misc_flags.set_shared_loading_failed(true); }
339
340 bool has_nonstatic_fields() const { return _misc_flags.has_nonstatic_fields(); }
341 void set_has_nonstatic_fields(bool b) { _misc_flags.set_has_nonstatic_fields(b); }
342
343 bool has_localvariable_table() const { return _misc_flags.has_localvariable_table(); }
344 void set_has_localvariable_table(bool b) { _misc_flags.set_has_localvariable_table(b); }
345
346 // field sizes
347 int nonstatic_field_size() const { return _nonstatic_field_size; }
348 void set_nonstatic_field_size(int size) { _nonstatic_field_size = size; }
349
350 int static_field_size() const { return _static_field_size; }
351 void set_static_field_size(int size) { _static_field_size = size; }
352
353 int static_oop_field_count() const { return (int)_static_oop_field_count; }
354 void set_static_oop_field_count(u2 size) { _static_oop_field_count = size; }
355
356 bool trust_final_fields() { return _misc_flags.trust_final_fields(); }
357 void set_trust_final_fields(bool value) { _misc_flags.set_trust_final_fields(value); }
358
359 // Java itable
360 int itable_length() const { return _itable_len; }
361 void set_itable_length(int len) { _itable_len = len; }
362
363 // array klasses
364 ObjArrayKlass* array_klasses() const { return _array_klasses; }
365 inline ObjArrayKlass* array_klasses_acquire() const; // load with acquire semantics
366 inline void release_set_array_klasses(ObjArrayKlass* k); // store with release semantics
367 void set_array_klasses(ObjArrayKlass* k) { _array_klasses = k; }
368
369 // methods
370 Array<Method*>* methods() const { return _methods; }
371 void set_methods(Array<Method*>* a) { _methods = a; }
372 Method* method_with_idnum(int idnum) const;
373 Method* method_with_orig_idnum(int idnum) const;
374 Method* method_with_orig_idnum(int idnum, int version) const;
375
376 // method ordering
377 Array<int>* method_ordering() const { return _method_ordering; }
378 void set_method_ordering(Array<int>* m) { _method_ordering = m; }
379 void copy_method_ordering(const intArray* m, TRAPS);
380
381 // default_methods
382 Array<Method*>* default_methods() const { return _default_methods; }
383 void set_default_methods(Array<Method*>* a) { _default_methods = a; }
384
385 // default method vtable_indices
386 Array<int>* default_vtable_indices() const { return _default_vtable_indices; }
387 void set_default_vtable_indices(Array<int>* v) { _default_vtable_indices = v; }
388 Array<int>* create_new_default_vtable_indices(int len, TRAPS);
389
390 // interfaces
391 Array<InstanceKlass*>* local_interfaces() const { return _local_interfaces; }
392 void set_local_interfaces(Array<InstanceKlass*>* a) {
393 guarantee(_local_interfaces == nullptr || a == nullptr, "Just checking");
394 _local_interfaces = a; }
395
396 Array<InstanceKlass*>* transitive_interfaces() const { return _transitive_interfaces; }
397 void set_transitive_interfaces(Array<InstanceKlass*>* a) {
398 guarantee(_transitive_interfaces == nullptr || a == nullptr, "Just checking");
399 _transitive_interfaces = a;
400 }
401
402 private:
403 friend class fieldDescriptor;
404 FieldInfo field(int index) const;
405
406 public:
407 int field_offset (int index) const { return field(index).offset(); }
408 int field_access_flags(int index) const { return field(index).access_flags().as_field_flags(); }
409 FieldInfo::FieldFlags field_flags(int index) const { return field(index).field_flags(); }
410 FieldStatus field_status(int index) const { return fields_status()->at(index); }
411 inline Symbol* field_name (int index) const;
412 inline Symbol* field_signature (int index) const;
413
414 // Number of Java declared fields
415 int java_fields_count() const;
416 int total_fields_count() const;
417
418 Array<u1>* fieldinfo_stream() const { return _fieldinfo_stream; }
419 void set_fieldinfo_stream(Array<u1>* fis) { _fieldinfo_stream = fis; }
420
421 Array<u1>* fieldinfo_search_table() const { return _fieldinfo_search_table; }
422 void set_fieldinfo_search_table(Array<u1>* table) { _fieldinfo_search_table = table; }
423
424 Array<FieldStatus>* fields_status() const {return _fields_status; }
425 void set_fields_status(Array<FieldStatus>* array) { _fields_status = array; }
426
427 // inner classes
428 Array<u2>* inner_classes() const { return _inner_classes; }
429 void set_inner_classes(Array<u2>* f) { _inner_classes = f; }
430
431 // nest members
432 Array<u2>* nest_members() const { return _nest_members; }
433 void set_nest_members(Array<u2>* m) { _nest_members = m; }
434
435 // nest-host index
436 jushort nest_host_index() const { return _nest_host_index; }
437 void set_nest_host_index(u2 i) { _nest_host_index = i; }
438 // dynamic nest member support
439 void set_nest_host(InstanceKlass* host);
440
441 // record components
442 Array<RecordComponent*>* record_components() const { return _record_components; }
443 void set_record_components(Array<RecordComponent*>* record_components) {
444 _record_components = record_components;
445 }
446 bool is_record() const;
447
448 // test for enum class (or possibly an anonymous subclass within a sealed enum)
449 bool is_enum_subclass() const;
450
451 // permitted subclasses
452 Array<u2>* permitted_subclasses() const { return _permitted_subclasses; }
453 void set_permitted_subclasses(Array<u2>* s) { _permitted_subclasses = s; }
454
455 private:
456 // Called to verify that k is a member of this nest - does not look at k's nest-host,
457 // nor does it resolve any CP entries or load any classes.
458 bool has_nest_member(JavaThread* current, InstanceKlass* k) const;
459
460 public:
461 // Call this only if you know that the nest host has been initialized.
462 InstanceKlass* nest_host_not_null() {
463 assert(_nest_host != nullptr, "must be");
464 return _nest_host;
465 }
466 InstanceKlass* nest_host_or_null() {
467 return _nest_host;
468 }
469 // Used to construct informative IllegalAccessError messages at a higher level,
470 // if there was an issue resolving or validating the nest host.
471 // Returns null if there was no error.
472 const char* nest_host_error();
473 // Returns nest-host class, resolving and validating it if needed.
474 // Returns null if resolution is not possible from the calling context.
475 InstanceKlass* nest_host(TRAPS);
476 // Check if this klass is a nestmate of k - resolves this nest-host and k's
477 bool has_nestmate_access_to(InstanceKlass* k, TRAPS);
478
479 // Called to verify that k is a permitted subclass of this class.
480 // The incoming stringStream is used for logging, and for the caller to create
481 // a detailed exception message on failure.
482 bool has_as_permitted_subclass(const InstanceKlass* k, stringStream& ss) const;
483
484 enum InnerClassAttributeOffset {
485 // From http://mirror.eng/products/jdk/1.1/docs/guide/innerclasses/spec/innerclasses.doc10.html#18814
486 inner_class_inner_class_info_offset = 0,
487 inner_class_outer_class_info_offset = 1,
488 inner_class_inner_name_offset = 2,
489 inner_class_access_flags_offset = 3,
490 inner_class_next_offset = 4
491 };
492
493 enum EnclosingMethodAttributeOffset {
494 enclosing_method_class_index_offset = 0,
495 enclosing_method_method_index_offset = 1,
496 enclosing_method_attribute_size = 2
497 };
498
499 // package
500 PackageEntry* package() const override { return _package_entry; }
501 ModuleEntry* module() const override;
502 bool in_javabase_module() const;
503 bool in_unnamed_package() const { return (_package_entry == nullptr); }
504 void set_package(ClassLoaderData* loader_data, PackageEntry* pkg_entry, TRAPS);
505 // If the package for the InstanceKlass is in the boot loader's package entry
506 // table then sets the classpath_index field so that
507 // get_system_package() will know to return a non-null value for the
508 // package's location. And, so that the package will be added to the list of
509 // packages returned by get_system_packages().
510 // For packages whose classes are loaded from the boot loader class path, the
511 // classpath_index indicates which entry on the boot loader class path.
512 void set_classpath_index(s2 path_index);
513 bool is_same_class_package(const Klass* class2) const;
514 bool is_same_class_package(oop other_class_loader, const Symbol* other_class_name) const;
515
516 // find an enclosing class
517 InstanceKlass* compute_enclosing_class(bool* inner_is_member, TRAPS) const;
518
519 // Find InnerClasses attribute and return outer_class_info_index & inner_name_index.
520 bool find_inner_classes_attr(int* ooff, int* noff, TRAPS) const;
521
522 private:
523 // Check prohibited package ("java/" only loadable by boot or platform loaders)
524 static void check_prohibited_package(Symbol* class_name,
525 ClassLoaderData* loader_data,
526 TRAPS);
527
528 JavaThread* init_thread() { return AtomicAccess::load(&_init_thread); }
529 const char* init_thread_name() {
530 return init_thread()->name_raw();
531 }
532
533 public:
534 // initialization state
535 bool is_loaded() const { return init_state() >= loaded; }
536 bool is_linked() const { return init_state() >= linked; }
537 bool is_initialized() const { return init_state() == fully_initialized; }
538 bool is_not_initialized() const { return init_state() < being_initialized; }
539 bool is_being_initialized() const { return init_state() == being_initialized; }
540 bool is_in_error_state() const { return init_state() == initialization_error; }
541 bool is_reentrant_initialization(Thread *thread) { return thread == _init_thread; }
542 ClassState init_state() const { return AtomicAccess::load_acquire(&_init_state); }
543 const char* init_state_name() const;
544 bool is_rewritten() const { return _misc_flags.rewritten(); }
545
546 static const char* state2name(ClassState state);
547
548 // is this a sealed class
549 bool is_sealed() const;
550
551 // defineClass specified verification
552 bool should_verify_class() const { return _misc_flags.should_verify_class(); }
553 void set_should_verify_class(bool value) { _misc_flags.set_should_verify_class(value); }
554
555 // marking
556 bool is_marked_dependent() const { return _misc_flags.is_marked_dependent(); }
557 void set_is_marked_dependent(bool value) { _misc_flags.set_is_marked_dependent(value); }
558
559 // initialization (virtuals from Klass)
560 bool should_be_initialized() const override; // means that initialize should be called
561 void initialize_with_aot_initialized_mirror(TRAPS);
562 void assert_no_clinit_will_run_for_aot_initialized_class() const NOT_DEBUG_RETURN;
563 void initialize(TRAPS) override;
564 void initialize_preemptable(TRAPS) override;
565 void link_class(TRAPS);
566 bool link_class_or_fail(TRAPS); // returns false on failure
567 void rewrite_class(TRAPS);
568 void link_methods(TRAPS);
569 Method* class_initializer() const;
570 bool interface_needs_clinit_execution_as_super(bool also_check_supers=true) const;
571
572 // reference type
573 ReferenceType reference_type() const { return (ReferenceType)_reference_type; }
574
575 // this class cp index
576 u2 this_class_index() const { return _this_class_index; }
577 void set_this_class_index(u2 index) { _this_class_index = index; }
578
579 static ByteSize reference_type_offset() { return byte_offset_of(InstanceKlass, _reference_type); }
580
581 // find local field, returns true if found
582 bool find_local_field(Symbol* name, Symbol* sig, fieldDescriptor* fd) const;
583 // find field in direct superinterfaces, returns the interface in which the field is defined
584 Klass* find_interface_field(Symbol* name, Symbol* sig, fieldDescriptor* fd) const;
585 // find field according to JVM spec 5.4.3.2, returns the klass in which the field is defined
586 Klass* find_field(Symbol* name, Symbol* sig, fieldDescriptor* fd) const override;
587 // find instance or static fields according to JVM spec 5.4.3.2, returns the klass in which the field is defined
588 Klass* find_field(Symbol* name, Symbol* sig, bool is_static, fieldDescriptor* fd) const;
589
590 // find a non-static or static field given its offset within the class.
591 bool contains_field_offset(int offset);
592
593 bool find_local_field_from_offset(int offset, bool is_static, fieldDescriptor* fd) const;
594 bool find_field_from_offset(int offset, bool is_static, fieldDescriptor* fd) const;
595
596 private:
597 inline static int quick_search(const Array<Method*>* methods, const Symbol* name);
598
599 public:
600 static void disable_method_binary_search() {
601 _disable_method_binary_search = true;
602 }
603
604 // find a local method (returns null if not found)
605 Method* find_method(const Symbol* name, const Symbol* signature) const;
606 static Method* find_method(const Array<Method*>* methods,
607 const Symbol* name,
608 const Symbol* signature);
609
610 // find a local method, but skip static methods
611 Method* find_instance_method(const Symbol* name, const Symbol* signature,
612 PrivateLookupMode private_mode) const;
613 static Method* find_instance_method(const Array<Method*>* methods,
614 const Symbol* name,
615 const Symbol* signature,
616 PrivateLookupMode private_mode);
617
618 // find a local method (returns null if not found)
619 Method* find_local_method(const Symbol* name,
620 const Symbol* signature,
621 OverpassLookupMode overpass_mode,
622 StaticLookupMode static_mode,
623 PrivateLookupMode private_mode) const;
624
625 // find a local method from given methods array (returns null if not found)
626 static Method* find_local_method(const Array<Method*>* methods,
627 const Symbol* name,
628 const Symbol* signature,
629 OverpassLookupMode overpass_mode,
630 StaticLookupMode static_mode,
631 PrivateLookupMode private_mode);
632
633 // find a local method index in methods or default_methods (returns -1 if not found)
634 static int find_method_index(const Array<Method*>* methods,
635 const Symbol* name,
636 const Symbol* signature,
637 OverpassLookupMode overpass_mode,
638 StaticLookupMode static_mode,
639 PrivateLookupMode private_mode);
640
641 // lookup operation (returns null if not found)
642 Method* uncached_lookup_method(const Symbol* name,
643 const Symbol* signature,
644 OverpassLookupMode overpass_mode,
645 PrivateLookupMode private_mode = PrivateLookupMode::find) const override;
646
647 // lookup a method in all the interfaces that this class implements
648 // (returns null if not found)
649 Method* lookup_method_in_all_interfaces(Symbol* name, Symbol* signature, DefaultsLookupMode defaults_mode) const;
650
651 // lookup a method in local defaults then in all interfaces
652 // (returns null if not found)
653 Method* lookup_method_in_ordered_interfaces(Symbol* name, Symbol* signature) const;
654
655 // Find method indices by name. If a method with the specified name is
656 // found the index to the first method is returned, and 'end' is filled in
657 // with the index of first non-name-matching method. If no method is found
658 // -1 is returned.
659 int find_method_by_name(const Symbol* name, int* end) const;
660 static int find_method_by_name(const Array<Method*>* methods,
661 const Symbol* name, int* end);
662
663 // constant pool
664 ConstantPool* constants() const { return _constants; }
665 void set_constants(ConstantPool* c) { _constants = c; }
666
667 // protection domain
668 oop protection_domain() const override;
669
670 // signers
671 objArrayOop signers() const;
672
673 bool is_contended() const { return _misc_flags.is_contended(); }
674 void set_is_contended(bool value) { _misc_flags.set_is_contended(value); }
675
676 // source file name
677 Symbol* source_file_name() const;
678 u2 source_file_name_index() const;
679 void set_source_file_name_index(u2 sourcefile_index);
680
681 // minor and major version numbers of class file
682 u2 minor_version() const;
683 void set_minor_version(u2 minor_version);
684 u2 major_version() const;
685 void set_major_version(u2 major_version);
686
687 // source debug extension
688 const char* source_debug_extension() const { return _source_debug_extension; }
689 void set_source_debug_extension(const char* array, int length);
690
691 // nonstatic oop-map blocks
692 static int nonstatic_oop_map_size(unsigned int oop_map_count) {
693 return oop_map_count * OopMapBlock::size_in_words();
694 }
695 unsigned int nonstatic_oop_map_count() const {
696 return _nonstatic_oop_map_size / OopMapBlock::size_in_words();
697 }
698 int nonstatic_oop_map_size() const { return _nonstatic_oop_map_size; }
699 void set_nonstatic_oop_map_size(int words) {
700 _nonstatic_oop_map_size = words;
701 }
702
703 bool has_contended_annotations() const { return _misc_flags.has_contended_annotations(); }
704 void set_has_contended_annotations(bool value) { _misc_flags.set_has_contended_annotations(value); }
705
706 #if INCLUDE_JVMTI
707 // Redefinition locking. Class can only be redefined by one thread at a time.
708 bool is_being_redefined() const { return _misc_flags.is_being_redefined(); }
709 void set_is_being_redefined(bool value) { _misc_flags.set_is_being_redefined(value); }
710
711 // RedefineClasses() support for previous versions:
712 void add_previous_version(InstanceKlass* ik, int emcp_method_count);
713 void purge_previous_version_list();
714
715 InstanceKlass* previous_versions() const { return _previous_versions; }
716 #else
717 InstanceKlass* previous_versions() const { return nullptr; }
718 #endif
719
720 const InstanceKlass* get_klass_version(int version) const;
721
722 bool has_been_redefined() const { return _misc_flags.has_been_redefined(); }
723 void set_has_been_redefined() { _misc_flags.set_has_been_redefined(true); }
724
725 bool is_scratch_class() const { return _misc_flags.is_scratch_class(); }
726 void set_is_scratch_class() { _misc_flags.set_is_scratch_class(true); }
727
728 bool has_resolved_methods() const { return _misc_flags.has_resolved_methods(); }
729 void set_has_resolved_methods() { _misc_flags.set_has_resolved_methods(true); }
730 void set_has_resolved_methods(bool value) { _misc_flags.set_has_resolved_methods(value); }
731
732 public:
733 #if INCLUDE_JVMTI
734
735 void init_previous_versions() {
736 _previous_versions = nullptr;
737 }
738
739 private:
740 static bool _should_clean_previous_versions;
741 public:
742 static void purge_previous_versions(InstanceKlass* ik) {
743 if (ik->has_been_redefined()) {
744 ik->purge_previous_version_list();
745 }
746 }
747
748 static bool should_clean_previous_versions_and_reset();
749 static bool should_clean_previous_versions() { return _should_clean_previous_versions; }
750
751 // JVMTI: Support for caching a class file before it is modified by an agent that can do retransformation
752 void set_cached_class_file(JvmtiCachedClassFileData *data) {
753 _cached_class_file = data;
754 }
755 JvmtiCachedClassFileData * get_cached_class_file();
756 jint get_cached_class_file_len();
757 unsigned char * get_cached_class_file_bytes();
758
759 // JVMTI: Support for caching of field indices, types, and offsets
760 void set_jvmti_cached_class_field_map(JvmtiCachedClassFieldMap* descriptor) {
761 _jvmti_cached_class_field_map = descriptor;
762 }
763 JvmtiCachedClassFieldMap* jvmti_cached_class_field_map() const {
764 return _jvmti_cached_class_field_map;
765 }
766 #else // INCLUDE_JVMTI
767
768 static void purge_previous_versions(InstanceKlass* ik) { return; };
769 static bool should_clean_previous_versions_and_reset() { return false; }
770
771 void set_cached_class_file(JvmtiCachedClassFileData *data) {
772 assert(data == nullptr, "unexpected call with JVMTI disabled");
773 }
774 JvmtiCachedClassFileData * get_cached_class_file() { return (JvmtiCachedClassFileData *)nullptr; }
775
776 #endif // INCLUDE_JVMTI
777
778 bool has_nonstatic_concrete_methods() const { return _misc_flags.has_nonstatic_concrete_methods(); }
779 void set_has_nonstatic_concrete_methods(bool b) { _misc_flags.set_has_nonstatic_concrete_methods(b); }
780
781 bool declares_nonstatic_concrete_methods() const { return _misc_flags.declares_nonstatic_concrete_methods(); }
782 void set_declares_nonstatic_concrete_methods(bool b) { _misc_flags.set_declares_nonstatic_concrete_methods(b); }
783
784 bool has_miranda_methods () const { return _misc_flags.has_miranda_methods(); }
785 void set_has_miranda_methods() { _misc_flags.set_has_miranda_methods(true); }
786 bool has_final_method() const { return _misc_flags.has_final_method(); }
787 void set_has_final_method() { _misc_flags.set_has_final_method(true); }
788
789 // for adding methods, ConstMethod::UNSET_IDNUM means no more ids available
790 inline u2 next_method_idnum();
791 void set_initial_method_idnum(u2 value) { _idnum_allocated_count = value; }
792
793 // generics support
794 Symbol* generic_signature() const;
795 u2 generic_signature_index() const;
796 void set_generic_signature_index(u2 sig_index);
797
798 u2 enclosing_method_data(int offset) const;
799 u2 enclosing_method_class_index() const {
800 return enclosing_method_data(enclosing_method_class_index_offset);
801 }
802 u2 enclosing_method_method_index() {
803 return enclosing_method_data(enclosing_method_method_index_offset);
804 }
805 void set_enclosing_method_indices(u2 class_index,
806 u2 method_index);
807
808 // jmethodID support
809 jmethodID get_jmethod_id(Method* method);
810 void make_methods_jmethod_ids();
811 jmethodID jmethod_id_or_null(Method* method);
812 void update_methods_jmethod_cache();
813
814 // annotations support
815 Annotations* annotations() const { return _annotations; }
816 void set_annotations(Annotations* anno) { _annotations = anno; }
817
818 AnnotationArray* class_annotations() const {
819 return (_annotations != nullptr) ? _annotations->class_annotations() : nullptr;
820 }
821 Array<AnnotationArray*>* fields_annotations() const {
822 return (_annotations != nullptr) ? _annotations->fields_annotations() : nullptr;
823 }
824 AnnotationArray* class_type_annotations() const {
825 return (_annotations != nullptr) ? _annotations->class_type_annotations() : nullptr;
826 }
827 Array<AnnotationArray*>* fields_type_annotations() const {
828 return (_annotations != nullptr) ? _annotations->fields_type_annotations() : nullptr;
829 }
830 // allocation
831 instanceOop allocate_instance(TRAPS);
832 static instanceOop allocate_instance(oop cls, const char* who, TRAPS);
833
834 // additional member function to return a handle
835 instanceHandle allocate_instance_handle(TRAPS);
836
837 // Helper function
838 static instanceOop register_finalizer(instanceOop i, TRAPS);
839
840 // Check whether reflection/jni/jvm code is allowed to instantiate this class;
841 // if not, throw either an Error or an Exception.
842 void check_valid_for_instantiation(bool throwError, TRAPS) override;
843
844 // initialization
845 void call_class_initializer(TRAPS);
846 void set_initialization_state_and_notify(ClassState state, TRAPS);
847
848 // OopMapCache support
849 OopMapCache* oop_map_cache() { return _oop_map_cache; }
850 void set_oop_map_cache(OopMapCache *cache) { _oop_map_cache = cache; }
851 void mask_for(const methodHandle& method, int bci, InterpreterOopMap* entry);
852
853 // JNI identifier support (for static fields - for jni performance)
854 JNIid* jni_ids() { return _jni_ids; }
855 void set_jni_ids(JNIid* ids) { _jni_ids = ids; }
856 JNIid* jni_id_for(int offset);
857
858 public:
859 // maintenance of deoptimization dependencies
860 inline DependencyContext dependencies();
861 void mark_dependent_nmethods(DeoptimizationScope* deopt_scope, KlassDepChange& changes);
862 void add_dependent_nmethod(nmethod* nm);
863 void clean_dependency_context();
864 // Setup link to hierarchy and deoptimize
865 void add_to_hierarchy(JavaThread* current);
866
867 // On-stack replacement support
868 nmethod* osr_nmethods_head() const { return _osr_nmethods_head; };
869 void set_osr_nmethods_head(nmethod* h) { _osr_nmethods_head = h; };
870 void add_osr_nmethod(nmethod* n);
871 bool remove_osr_nmethod(nmethod* n);
872 int mark_osr_nmethods(DeoptimizationScope* deopt_scope, const Method* m);
873 nmethod* lookup_osr_nmethod(const Method* m, int bci, int level, bool match_level) const;
874
875 #if INCLUDE_JVMTI
876 // Breakpoint support (see methods on Method* for details)
877 BreakpointInfo* breakpoints() const { return _breakpoints; };
878 void set_breakpoints(BreakpointInfo* bps) { _breakpoints = bps; };
879 #endif
880
881 // support for stub routines
882 static ByteSize init_state_offset() { return byte_offset_of(InstanceKlass, _init_state); }
883 JFR_ONLY(DEFINE_KLASS_TRACE_ID_OFFSET;)
884 static ByteSize init_thread_offset() { return byte_offset_of(InstanceKlass, _init_thread); }
885
886 // subclass/subinterface checks
887 bool implements_interface(Klass* k) const;
888 bool is_same_or_direct_interface(Klass* k) const;
889
890 #ifdef ASSERT
891 // check whether this class or one of its superclasses was redefined
892 bool has_redefined_this_or_super() const;
893 #endif
894
895 // Access to the implementor of an interface.
896 InstanceKlass* implementor() const;
897 void set_implementor(InstanceKlass* ik);
898 int nof_implementors() const;
899 void add_implementor(InstanceKlass* ik); // ik is a new class that implements this interface
900 void init_implementor(); // initialize
901
902 private:
903 // link this class into the implementors list of every interface it implements
904 void process_interfaces();
905
906 public:
907 // virtual operations from Klass
908 GrowableArray<Klass*>* compute_secondary_supers(int num_extra_slots,
909 Array<InstanceKlass*>* transitive_interfaces) override;
910 bool can_be_primary_super_slow() const override;
911 size_t oop_size(oop obj) const override { return size_helper(); }
912 // slow because it's a virtual call and used for verifying the layout_helper.
913 // Using the layout_helper bits, we can call is_instance_klass without a virtual call.
914 DEBUG_ONLY(bool is_instance_klass_slow() const override { return true; })
915
916 // Iterators
917 void do_local_static_fields(FieldClosure* cl);
918 void do_nonstatic_fields(FieldClosure* cl); // including inherited fields
919 void do_local_static_fields(void f(fieldDescriptor*, Handle, TRAPS), Handle, TRAPS);
920 void print_nonstatic_fields(FieldClosure* cl); // including inherited and injected fields
921
922 void methods_do(void f(Method* method));
923
924 static InstanceKlass* cast(Klass* k) {
925 return const_cast<InstanceKlass*>(cast(const_cast<const Klass*>(k)));
926 }
927
928 static const InstanceKlass* cast(const Klass* k) {
929 assert(k != nullptr, "k should not be null");
930 assert(k->is_instance_klass(), "cast to InstanceKlass");
931 return static_cast<const InstanceKlass*>(k);
932 }
933
934 // This hides Klass::super(). The _super of an InstanceKlass is
935 // always an InstanceKlass (or nullptr)
936 InstanceKlass* super() const {
937 return (Klass::super() == nullptr) ? nullptr : InstanceKlass::cast(Klass::super());
938 }
939
940 InstanceKlass* java_super() const override {
941 return InstanceKlass::super();
942 }
943
944 // Sizing (in words)
945 static int header_size() { return sizeof(InstanceKlass)/wordSize; }
946
947 static int size(int vtable_length, int itable_length,
948 int nonstatic_oop_map_size,
949 bool is_interface) {
950 return align_metadata_size(header_size() +
951 vtable_length +
952 itable_length +
953 nonstatic_oop_map_size +
954 (is_interface ? (int)sizeof(Klass*)/wordSize : 0));
955 }
956
957 int size() const override { return size(vtable_length(),
958 itable_length(),
959 nonstatic_oop_map_size(),
960 is_interface());
961 }
962
963
964 inline intptr_t* start_of_itable() const;
965 inline intptr_t* end_of_itable() const;
966 inline oop static_field_base_raw();
967
968 inline OopMapBlock* start_of_nonstatic_oop_maps() const;
969 inline Klass** end_of_nonstatic_oop_maps() const;
970
971 inline InstanceKlass* volatile* adr_implementor() const;
972
973 // Use this to return the size of an instance in heap words:
974 int size_helper() const {
975 return layout_helper_to_size_helper(layout_helper());
976 }
977
978 // This bit is initialized in classFileParser.cpp.
979 // It is false under any of the following conditions:
980 // - the class is abstract (including any interface)
981 // - the class size is larger than FastAllocateSizeLimit
982 // - the class is java/lang/Class, which cannot be allocated directly
983 bool can_be_fastpath_allocated() const {
984 return !layout_helper_needs_slow_path(layout_helper());
985 }
986
987 // Java itable
988 klassItable itable() const; // return klassItable wrapper
989 Method* method_at_itable(InstanceKlass* holder, int index, TRAPS);
990 Method* method_at_itable_or_null(InstanceKlass* holder, int index, bool& itable_entry_found);
991 int vtable_index_of_interface_method(Method* method);
992
993 #if INCLUDE_JVMTI
994 void adjust_default_methods(bool* trace_name_printed);
995 #endif // INCLUDE_JVMTI
996
997 void clean_weak_instanceklass_links();
998 private:
999 void clean_implementors_list();
1000 void clean_method_data();
1001
1002 public:
1003 // Explicit metaspace deallocation of fields
1004 // For RedefineClasses and class file parsing errors, we need to deallocate
1005 // instanceKlasses and the metadata they point to.
1006 void deallocate_contents(ClassLoaderData* loader_data);
1007 static void deallocate_methods(ClassLoaderData* loader_data,
1008 Array<Method*>* methods);
1009 void static deallocate_interfaces(ClassLoaderData* loader_data,
1010 const InstanceKlass* super_klass,
1011 Array<InstanceKlass*>* local_interfaces,
1012 Array<InstanceKlass*>* transitive_interfaces);
1013 void static deallocate_record_components(ClassLoaderData* loader_data,
1014 Array<RecordComponent*>* record_component);
1015
1016 bool on_stack() const override;
1017
1018 // callbacks for actions during class unloading
1019 static void unload_class(InstanceKlass* ik);
1020
1021 void release_C_heap_structures(bool release_sub_metadata = true) override;
1022
1023 // Naming
1024 const char* signature_name() const override;
1025
1026 // Oop fields (and metadata) iterators
1027 //
1028 // The InstanceKlass iterators also visits the Object's klass.
1029
1030 // Forward iteration
1031 public:
1032 // Iterate over all oop fields in the oop maps.
1033 template <typename T, class OopClosureType>
1034 inline void oop_oop_iterate_oop_maps(oop obj, OopClosureType* closure);
1035
1036 // Iterate over all oop fields and metadata.
1037 template <typename T, class OopClosureType>
1038 inline void oop_oop_iterate(oop obj, OopClosureType* closure);
1039
1040 // Iterate over all oop fields in one oop map.
1041 template <typename T, class OopClosureType>
1042 inline void oop_oop_iterate_oop_map(OopMapBlock* map, oop obj, OopClosureType* closure);
1043
1044
1045 // Reverse iteration
1046 // Iterate over all oop fields and metadata.
1047 template <typename T, class OopClosureType>
1048 inline void oop_oop_iterate_reverse(oop obj, OopClosureType* closure);
1049
1050 private:
1051 // Iterate over all oop fields in the oop maps.
1052 template <typename T, class OopClosureType>
1053 inline void oop_oop_iterate_oop_maps_reverse(oop obj, OopClosureType* closure);
1054
1055 // Iterate over all oop fields in one oop map.
1056 template <typename T, class OopClosureType>
1057 inline void oop_oop_iterate_oop_map_reverse(OopMapBlock* map, oop obj, OopClosureType* closure);
1058
1059
1060 // Bounded range iteration
1061 public:
1062 // Iterate over all oop fields in the oop maps.
1063 template <typename T, class OopClosureType>
1064 inline void oop_oop_iterate_oop_maps_bounded(oop obj, OopClosureType* closure, MemRegion mr);
1065
1066 // Iterate over all oop fields and metadata.
1067 template <typename T, class OopClosureType>
1068 inline void oop_oop_iterate_bounded(oop obj, OopClosureType* closure, MemRegion mr);
1069
1070 private:
1071 // Iterate over all oop fields in one oop map.
1072 template <typename T, class OopClosureType>
1073 inline void oop_oop_iterate_oop_map_bounded(OopMapBlock* map, oop obj, OopClosureType* closure, MemRegion mr);
1074
1075
1076 public:
1077 u2 idnum_allocated_count() const { return _idnum_allocated_count; }
1078
1079 private:
1080 // initialization state
1081 void set_init_state(ClassState state);
1082 void set_rewritten() { _misc_flags.set_rewritten(true); }
1083 void set_init_thread(JavaThread *thread) {
1084 assert((thread == JavaThread::current() && _init_thread == nullptr) ||
1085 (thread == nullptr && _init_thread == JavaThread::current()), "Only one thread is allowed to own initialization");
1086 AtomicAccess::store(&_init_thread, thread);
1087 }
1088
1089 jmethodID* methods_jmethod_ids_acquire() const;
1090 void release_set_methods_jmethod_ids(jmethodID* jmeths);
1091 // This nulls out obsolete jmethodIDs for all methods in 'klass'.
1092 static void clear_obsolete_jmethod_ids(InstanceKlass* klass);
1093 jmethodID update_jmethod_id(jmethodID* jmeths, Method* method, int idnum);
1094
1095 public:
1096 // Lock for (1) initialization; (2) access to the ConstantPool of this class.
1097 // Must be one per class and it has to be a VM internal object so java code
1098 // cannot lock it (like the mirror).
1099 // It has to be an object not a Mutex because it's held through java calls.
1100 oop init_lock() const;
1101
1102 // Returns the array class for the n'th dimension
1103 ArrayKlass* array_klass(int n, TRAPS) override;
1104 ArrayKlass* array_klass_or_null(int n) override;
1105
1106 // Returns the array class with this class as element type
1107 ArrayKlass* array_klass(TRAPS) override;
1108 ArrayKlass* array_klass_or_null() override;
1109
1110 static void clean_initialization_error_table();
1111 private:
1112 void fence_and_clear_init_lock();
1113
1114 bool link_class_impl (TRAPS);
1115 bool verify_code (TRAPS);
1116 void initialize_impl (TRAPS);
1117 void initialize_super_interfaces (TRAPS);
1118
1119 void add_initialization_error(JavaThread* current, Handle exception);
1120 oop get_initialization_error(JavaThread* current);
1121
1122 // find a local method (returns null if not found)
1123 Method* find_method_impl(const Symbol* name,
1124 const Symbol* signature,
1125 OverpassLookupMode overpass_mode,
1126 StaticLookupMode static_mode,
1127 PrivateLookupMode private_mode) const;
1128
1129 static Method* find_method_impl(const Array<Method*>* methods,
1130 const Symbol* name,
1131 const Symbol* signature,
1132 OverpassLookupMode overpass_mode,
1133 StaticLookupMode static_mode,
1134 PrivateLookupMode private_mode);
1135
1136 #if INCLUDE_JVMTI
1137 // RedefineClasses support
1138 void link_previous_versions(InstanceKlass* pv) { _previous_versions = pv; }
1139 void mark_newly_obsolete_methods(Array<Method*>* old_methods, int emcp_method_count);
1140 #endif
1141 // log class name to classlist
1142 void log_to_classlist() const;
1143 public:
1144
1145 #if INCLUDE_CDS
1146 // CDS support - remove and restore oops from metadata. Oops are not shared.
1147 void remove_unshareable_info() override;
1148 void remove_unshareable_flags();
1149 void remove_java_mirror() override;
1150 void restore_unshareable_info(ClassLoaderData* loader_data, Handle protection_domain, PackageEntry* pkg_entry, TRAPS);
1151 void init_shared_package_entry();
1152 bool can_be_verified_at_dumptime() const;
1153 void compute_has_loops_flag_for_methods();
1154 #endif
1155 bool has_init_deps_processed() const { return _misc_flags.has_init_deps_processed(); }
1156 void set_has_init_deps_processed() {
1157 assert(is_initialized(), "");
1158 assert(!has_init_deps_processed(), "already set"); // one-off action
1159 _misc_flags.set_has_init_deps_processed(true);
1160 }
1161
1162 u2 compute_modifier_flags() const override;
1163
1164 public:
1165 // JVMTI support
1166 jint jvmti_class_status() const override;
1167
1168 void metaspace_pointers_do(MetaspaceClosure* iter) override;
1169
1170 public:
1171 // Printing
1172 void print_on(outputStream* st) const override;
1173 void print_value_on(outputStream* st) const override;
1174
1175 void oop_print_value_on(oop obj, outputStream* st) override;
1176
1177 void oop_print_on (oop obj, outputStream* st) override;
1178
1179 #ifndef PRODUCT
1180 void print_dependent_nmethods(bool verbose = false);
1181 bool is_dependent_nmethod(nmethod* nm);
1182 bool verify_itable_index(int index);
1183 #endif
1184
1185 const char* internal_name() const override;
1186
1187 // Verification
1188 void verify_on(outputStream* st) override;
1189
1190 void oop_verify_on(oop obj, outputStream* st) override;
1191
1192 // Logging
1193 void print_class_load_logging(ClassLoaderData* loader_data,
1194 const ModuleEntry* module_entry,
1195 const ClassFileStream* cfs) const;
1196 private:
1197 void print_class_load_cause_logging() const;
1198 void print_class_load_helper(ClassLoaderData* loader_data,
1199 const ModuleEntry* module_entry,
1200 const ClassFileStream* cfs) const;
1201 };
1202
1203 // for adding methods
1204 // UNSET_IDNUM return means no more ids available
1205 inline u2 InstanceKlass::next_method_idnum() {
1206 if (_idnum_allocated_count == ConstMethod::MAX_IDNUM) {
1207 return ConstMethod::UNSET_IDNUM; // no more ids available
1208 } else {
1209 return _idnum_allocated_count++;
1210 }
1211 }
1212
1213 class PrintClassClosure : public KlassClosure {
1214 private:
1215 outputStream* _st;
1216 bool _verbose;
1217 public:
1218 PrintClassClosure(outputStream* st, bool verbose);
1219
1220 void do_klass(Klass* k);
1221 };
1222
1223 /* JNIid class for jfieldIDs only */
1224 class JNIid: public CHeapObj<mtClass> {
1225 friend class VMStructs;
1226 private:
1227 InstanceKlass* _holder;
1228 JNIid* _next;
1229 int _offset;
1230 #ifdef ASSERT
1231 bool _is_static_field_id;
1232 #endif
1233
1234 public:
1235 // Accessors
1236 InstanceKlass* holder() const { return _holder; }
1237 int offset() const { return _offset; }
1238 JNIid* next() { return _next; }
1239 // Constructor
1240 JNIid(InstanceKlass* holder, int offset, JNIid* next);
1241 // Identifier lookup
1242 JNIid* find(int offset);
1243
1244 bool find_local_field(fieldDescriptor* fd) {
1245 return InstanceKlass::cast(holder())->find_local_field_from_offset(offset(), true, fd);
1246 }
1247
1248 static void deallocate(JNIid* id);
1249 // Debugging
1250 #ifdef ASSERT
1251 bool is_static_field_id() const { return _is_static_field_id; }
1252 void set_is_static_field_id() { _is_static_field_id = true; }
1253 #endif
1254 void verify(InstanceKlass* holder);
1255 };
1256
1257 // An iterator that's used to access the inner classes indices in the
1258 // InstanceKlass::_inner_classes array.
1259 class InnerClassesIterator : public StackObj {
1260 private:
1261 Array<jushort>* _inner_classes;
1262 int _length;
1263 int _idx;
1264 public:
1265
1266 InnerClassesIterator(const InstanceKlass* k) {
1267 _inner_classes = k->inner_classes();
1268 if (k->inner_classes() != nullptr) {
1269 _length = _inner_classes->length();
1270 // The inner class array's length should be the multiple of
1271 // inner_class_next_offset if it only contains the InnerClasses
1272 // attribute data, or it should be
1273 // n*inner_class_next_offset+enclosing_method_attribute_size
1274 // if it also contains the EnclosingMethod data.
1275 assert((_length % InstanceKlass::inner_class_next_offset == 0 ||
1276 _length % InstanceKlass::inner_class_next_offset == InstanceKlass::enclosing_method_attribute_size),
1277 "just checking");
1278 // Remove the enclosing_method portion if exists.
1279 if (_length % InstanceKlass::inner_class_next_offset == InstanceKlass::enclosing_method_attribute_size) {
1280 _length -= InstanceKlass::enclosing_method_attribute_size;
1281 }
1282 } else {
1283 _length = 0;
1284 }
1285 _idx = 0;
1286 }
1287
1288 int length() const {
1289 return _length;
1290 }
1291
1292 void next() {
1293 _idx += InstanceKlass::inner_class_next_offset;
1294 }
1295
1296 bool done() const {
1297 return (_idx >= _length);
1298 }
1299
1300 u2 inner_class_info_index() const {
1301 return _inner_classes->at(
1302 _idx + InstanceKlass::inner_class_inner_class_info_offset);
1303 }
1304
1305 void set_inner_class_info_index(u2 index) {
1306 _inner_classes->at_put(
1307 _idx + InstanceKlass::inner_class_inner_class_info_offset, index);
1308 }
1309
1310 u2 outer_class_info_index() const {
1311 return _inner_classes->at(
1312 _idx + InstanceKlass::inner_class_outer_class_info_offset);
1313 }
1314
1315 void set_outer_class_info_index(u2 index) {
1316 _inner_classes->at_put(
1317 _idx + InstanceKlass::inner_class_outer_class_info_offset, index);
1318 }
1319
1320 u2 inner_name_index() const {
1321 return _inner_classes->at(
1322 _idx + InstanceKlass::inner_class_inner_name_offset);
1323 }
1324
1325 void set_inner_name_index(u2 index) {
1326 _inner_classes->at_put(
1327 _idx + InstanceKlass::inner_class_inner_name_offset, index);
1328 }
1329
1330 u2 inner_access_flags() const {
1331 return _inner_classes->at(
1332 _idx + InstanceKlass::inner_class_access_flags_offset);
1333 }
1334 };
1335
1336 // Iterator over class hierarchy under a particular class. Implements depth-first pre-order traversal.
1337 // Usage:
1338 // for (ClassHierarchyIterator iter(root_klass); !iter.done(); iter.next()) {
1339 // Klass* k = iter.klass();
1340 // ...
1341 // }
1342 class ClassHierarchyIterator : public StackObj {
1343 private:
1344 InstanceKlass* _root;
1345 Klass* _current;
1346 bool _visit_subclasses;
1347
1348 public:
1349 ClassHierarchyIterator(InstanceKlass* root) : _root(root), _current(root), _visit_subclasses(true) {
1350 assert(_root == _current, "required"); // initial state
1351 }
1352
1353 bool done() {
1354 return (_current == nullptr);
1355 }
1356
1357 // Make a step iterating over the class hierarchy under the root class.
1358 // Skips subclasses if requested.
1359 void next();
1360
1361 Klass* klass() {
1362 assert(!done(), "sanity");
1363 return _current;
1364 }
1365
1366 // Skip subclasses of the current class.
1367 void skip_subclasses() {
1368 _visit_subclasses = false;
1369 }
1370 };
1371
1372 #endif // SHARE_OOPS_INSTANCEKLASS_HPP