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