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