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