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