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