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