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