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