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