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