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