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