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