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