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