src/hotspot/share/oops/instanceKlass.hpp - master - githubmirror/panama-vector

src/hotspot/share/oops/instanceKlass.hpp
1 500 строк61 KB
Marc Chevalier
8388709: [lworld] replay parts of JDK-8350865
03 авг 2026, 10:09
03 авг 2026, 10:0981c9ea0
/*
 * Copyright (c) 1997, 2026, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 *
 */

#ifndef SHARE_OOPS_INSTANCEKLASS_HPP
#define SHARE_OOPS_INSTANCEKLASS_HPP

#include "code/vmreg.hpp"
#include "memory/allocation.hpp"
#include "memory/referenceType.hpp"
#include "oops/annotations.hpp"
#include "oops/arrayKlass.hpp"
#include "oops/constMethod.hpp"
#include "oops/fieldInfo.hpp"
#include "oops/instanceKlassFlags.hpp"
#include "oops/instanceOop.hpp"
#include "oops/refArrayKlass.hpp"
#include "runtime/handles.hpp"
#include "runtime/javaThread.hpp"
#include "utilities/accessFlags.hpp"
#include "utilities/align.hpp"
#include "utilities/growableArray.hpp"
#include "utilities/macros.hpp"
#if INCLUDE_JFR
#include "jfr/support/jfrKlassExtension.hpp"
#endif

class ConstantPool;
class DeoptimizationScope;
class klassItable;
class RecordComponent;

// An InstanceKlass is the VM level representation of a Java class.
// It contains all information needed for at class at execution runtime.

//  InstanceKlass embedded field layout (after declared fields):
//    [EMBEDDED Java vtable             ] size in words = vtable_len
//    [EMBEDDED Java itable             ] size in words = itable_len
//    [EMBEDDED nonstatic oop-map blocks] size in words = nonstatic_oop_map_size
//      The embedded nonstatic oop-map blocks are short pairs (offset, length)
//      indicating where oops are located in instances of this klass.
//    [EMBEDDED implementor of the interface] only exists for interface
//    [EMBEDDED InlineKlass::Members] only if is an InlineKlass instance


// forward declaration for class -- see below for definition
#if INCLUDE_JVMTI
class BreakpointInfo;
#endif
class ClassFileParser;
class ClassFileStream;
class KlassDepChange;
class DependencyContext;
class fieldDescriptor;
class JNIid;
class JvmtiCachedClassFieldMap;
class nmethodBucket;
class OopMapCache;
class InterpreterOopMap;
class PackageEntry;
class ModuleEntry;

// This is used in iterators below.
class FieldClosure: public StackObj {
public:
  virtual void do_field(fieldDescriptor* fd) = 0;
};

// Print fields.
// If "obj" argument to constructor is null, prints fields as if they are static fields,
// otherwise prints non-static fields. It is possible to print non-static fields the same
// way as static fields when no oops are available, such as when debug printing classes.
class FieldPrinter: public FieldClosure {
   oop _obj;
   outputStream* _st;
   int _indent;
   int _base_offset;
 public:
   FieldPrinter(outputStream* st, oop obj = nullptr, int indent = 0, int base_offset = 0) :
                 _obj(obj), _st(st), _indent(indent), _base_offset(base_offset) {}
   void do_field(fieldDescriptor* fd);
};

// Describes where oops are located in instances of this klass.
class OopMapBlock {
 public:
  // Byte offset of the first oop mapped by this block.
  int offset() const          { return _offset; }
  void set_offset(int offset) { _offset = offset; }

  // Number of oops in this block.
  uint count() const         { return _count; }
  void set_count(uint count) { _count = count; }

  void increment_count(int diff) { _count += diff; }

  int offset_span() const { return _count * heapOopSize; }

  int end_offset() const {
    return offset() + offset_span();
  }

  bool is_contiguous(int another_offset) const {
    return another_offset == end_offset();
  }

  // sizeof(OopMapBlock) in words.
  static int size_in_words() {
    return align_up((int)sizeof(OopMapBlock), wordSize) >>
      LogBytesPerWord;
  }

  static int compare_offset(const OopMapBlock* a, const OopMapBlock* b) {
    return a->offset() - b->offset();
  }

 private:
  int  _offset;
  uint _count;
};

struct JvmtiCachedClassFileData;

class InlineLayoutInfo : public MetaspaceObj {
  InlineKlass* _klass;
  LayoutKind _kind;
  int _null_marker_offset; // null marker offset for this field, relative to the beginning of the current container

 public:
  InlineLayoutInfo(): _klass(nullptr), _kind(LayoutKind::UNKNOWN), _null_marker_offset(-1)  {}

  InlineKlass* klass() const { return _klass; }
  void set_klass(InlineKlass* k) { _klass = k; }

  LayoutKind kind() const {
    assert(_kind != LayoutKind::UNKNOWN, "Not set");
    return _kind;
  }
  void set_kind(LayoutKind lk) { _kind = lk; }

  int null_marker_offset() const {
    assert(_null_marker_offset != -1, "Not set");
    return _null_marker_offset;
  }
  void set_null_marker_offset(int o) { _null_marker_offset = o; }

  void metaspace_pointers_do(MetaspaceClosure* it);
  MetaspaceObj::Type type() const { return InlineLayoutInfoType; }

  static ByteSize klass_offset() { return byte_offset_of(InlineLayoutInfo, _klass); }
  static ByteSize null_marker_offset_offset() { return byte_offset_of(InlineLayoutInfo, _null_marker_offset); }

  // Print
  void print() const;
  void print_on(outputStream* st) const;
};

class InstanceKlass: public Klass {
  friend class VMStructs;
  friend class ClassFileParser;
  friend class CompileReplay;
  friend class TemplateTable;

 public:
  static const KlassKind Kind = InstanceKlassKind;

 protected:
  InstanceKlass(const ClassFileParser& parser, KlassKind kind = Kind, markWord prototype = markWord::prototype(), ReferenceType reference_type = REF_NONE);

 public:
  InstanceKlass();

  // See "The Java Virtual Machine Specification" section 2.16.2-5 for a detailed description
  // of the class loading & initialization procedure, and the use of the states.
  enum ClassState : u1 {
    allocated,                          // allocated (but not yet linked)
    loaded,                             // loaded and inserted in class hierarchy (but not linked yet)
    linked,                             // successfully linked/verified (but not initialized yet)
    being_initialized,                  // currently running class initializer
    fully_initialized,                  // initialized (successful final state)
    initialization_error                // error happened during initialization
  };

 private:
  static InstanceKlass* allocate_instance_klass(const ClassFileParser& parser, TRAPS);

 protected:
  // If you add a new field that points to any metaspace object, you
  // must add this field to InstanceKlass::metaspace_pointers_do().

  // Annotations for this class
  Annotations*    _annotations;
  // Package this class is defined in
  PackageEntry*   _package_entry;
  // Array classes holding elements of this class.
  ObjArrayKlass* volatile _array_klasses;
  // Constant pool for this class.
  ConstantPool* _constants;
  // The InnerClasses attribute and EnclosingMethod attribute. The
  // _inner_classes is an array of shorts. If the class has InnerClasses
  // attribute, then the _inner_classes array begins with 4-tuples of shorts
  // [inner_class_info_index, outer_class_info_index,
  // inner_name_index, inner_class_access_flags] for the InnerClasses
  // attribute. If the EnclosingMethod attribute exists, it occupies the
  // last two shorts [class_index, method_index] of the array. If only
  // the InnerClasses attribute exists, the _inner_classes array length is
  // number_of_inner_classes * 4. If the class has both InnerClasses
  // and EnclosingMethod attributes the _inner_classes array length is
  // number_of_inner_classes * 4 + enclosing_method_attribute_size.
  Array<jushort>* _inner_classes;

  // The NestMembers attribute. An array of shorts, where each is a
  // class info index for the class that is a nest member. This data
  // has not been validated.
  Array<jushort>* _nest_members;

  // Resolved nest-host klass: either true nest-host or self if we are not
  // nested, or an error occurred resolving or validating the nominated
  // nest-host. Can also be set directly by JDK API's that establish nest
  // relationships.
  // By always being set it makes nest-member access checks simpler.
  InstanceKlass* _nest_host;

  // The PermittedSubclasses attribute. An array of shorts, where each is a
  // class info index for the class that is a permitted subclass.
  Array<jushort>* _permitted_subclasses;

  // The contents of the Record attribute.
  Array<RecordComponent*>* _record_components;

  // the source debug extension for this klass, null if not specified.
  // Specified as UTF-8 string without terminating zero byte in the classfile,
  // it is stored in the instanceklass as a null-terminated UTF-8 string
  const char*     _source_debug_extension;

  // Number of heapOopSize words used by non-static fields in this klass
  // (including inherited fields but after header_size()).
  int             _nonstatic_field_size;
  int             _static_field_size;       // number words used by static fields (oop and non-oop) in this klass
  int             _nonstatic_oop_map_size;  // size in words of nonstatic oop map blocks
  int             _itable_len;              // length of Java itable (in words)

  // The NestHost attribute. The class info index for the class
  // that is the nest-host of this class. This data has not been validated.
  u2              _nest_host_index;
  u2              _this_class_index;        // constant pool entry
  u2              _static_oop_field_count;  // number of static oop fields in this klass

  volatile u2     _idnum_allocated_count;   // JNI/JVMTI: increments with the addition of methods, old ids don't change

  // Class states are defined as ClassState (see above).
  // Place the _init_state here to utilize the unused 2-byte after
  // _idnum_allocated_count.
  volatile ClassState _init_state;          // state of class

  u1              _reference_type;          // reference type
  int             _acmp_maps_offset;        // offset to injected static field storing .acmp_maps for value classes
                                            // unfortunately, abstract values need one too so it cannot be stored in
                                            // the InlineKlass::Members that only exist for InlineKlass.

  AccessFlags        _access_flags;    // Access flags. The class/interface distinction is stored here.

  // State is set either at parse time or while executing, atomically to not disturb other state
  InstanceKlassFlags _misc_flags;

  JavaThread* volatile _init_thread;        // Pointer to current thread doing initialization (to handle recursive initialization)

  OopMapCache*    volatile _oop_map_cache;   // OopMapCache for all methods in the klass (allocated lazily)
  JNIid*          _jni_ids;                  // First JNI identifier for static fields in this class
  jmethodID* volatile _methods_jmethod_ids;  // jmethodIDs corresponding to method_idnum, or null if none
  nmethodBucket*  volatile _dep_context;     // packed DependencyContext structure
  uint64_t        volatile _dep_context_last_cleaned;
  nmethod*        _osr_nmethods_head;    // Head of list of on-stack replacement nmethods for this class
#if INCLUDE_JVMTI
  BreakpointInfo* _breakpoints;          // bpt lists, managed by Method*
  // Linked instanceKlasses of previous versions
  InstanceKlass* _previous_versions;
  // JVMTI fields can be moved to their own structure - see 6315920
  // JVMTI: cached class file, before retransformable agent modified it in CFLH
  JvmtiCachedClassFileData* _cached_class_file;
#endif

#if INCLUDE_JVMTI
  JvmtiCachedClassFieldMap* _jvmti_cached_class_field_map;  // JVMTI: used during heap iteration
#endif

  NOT_PRODUCT(int _verify_count;)  // to avoid redundant verifies
  NOT_PRODUCT(volatile int _shared_class_load_count;) // ensure a shared class is loaded only once

  // Method array.
  Array<Method*>* _methods;
  // Default Method Array, concrete methods inherited from interfaces
  Array<Method*>* _default_methods;
  // Interfaces (InstanceKlass*s) this class declares locally to implement.
  Array<InstanceKlass*>* _local_interfaces;
  // Interfaces (InstanceKlass*s) this class implements transitively.
  Array<InstanceKlass*>* _transitive_interfaces;
  // Int array containing the original order of method in the class file (for JVMTI).
  Array<int>*     _method_ordering;
  // Int array containing the vtable_indices for default_methods
  // offset matches _default_methods offset
  Array<int>*     _default_vtable_indices;

  // Fields information is stored in an UNSIGNED5 encoded stream (see fieldInfo.hpp)
  Array<u1>*          _fieldinfo_stream;
  Array<u1>*          _fieldinfo_search_table;
  Array<FieldStatus>* _fields_status;

  Array<InlineLayoutInfo>* _inline_layout_info_array;
  Array<u2>* _loadable_descriptors;
  Array<int>* _acmp_maps_array; // Metadata copy of the acmp_maps oop used in value classes.
                                // When loading an inline klass from the CDS/AOT archive
                                // this copy can be used to regenerate the ".acmp_maps" oop
                                // if it is not stored in the archive.

  // Located here because sub-klasses can't have their own C++ fields
  address _adr_inline_klass_members;

  friend class SystemDictionary;

  static bool _disable_method_binary_search;

  // Controls finalizer registration
  static bool _finalization_enabled;

 public:

  // Queries finalization state
  static bool is_finalization_enabled() { return _finalization_enabled; }

  // Sets finalization state
  static void set_finalization_enabled(bool val) { _finalization_enabled = val; }

  // Access flags
  AccessFlags access_flags() const         { return _access_flags;  }
  void set_access_flags(AccessFlags flags) { _access_flags = flags; }

  bool is_public() const                { return _access_flags.is_public(); }
  bool is_final() const                 { return _access_flags.is_final(); }
  bool is_interface() const override    { return _access_flags.is_interface(); }
  bool is_abstract() const override     { return _access_flags.is_abstract(); }
  bool is_synthetic() const             { return _access_flags.is_synthetic(); }
  void set_is_synthetic()               { _access_flags.set_is_synthetic(); }
  bool is_identity_class() const override { return _access_flags.is_identity_class(); }

  static ByteSize access_flags_offset() { return byte_offset_of(InstanceKlass, _access_flags); }

  void set_is_cloneable();

  // Quick checks for the loader that defined this class (without switching on this->class_loader())
  bool defined_by_boot_loader() const      { return _misc_flags.defined_by_boot_loader(); }
  bool defined_by_platform_loader() const  { return _misc_flags.defined_by_platform_loader(); }
  bool defined_by_app_loader() const       { return _misc_flags.defined_by_app_loader(); }
  bool defined_by_other_loaders() const    { return _misc_flags.defined_by_other_loaders(); }
  void set_class_loader_type()             { _misc_flags.set_class_loader_type(_class_loader_data); }

  bool shared_loading_failed() const { return _misc_flags.shared_loading_failed(); }

  void set_shared_loading_failed() { _misc_flags.set_shared_loading_failed(true); }

  bool has_nonstatic_fields() const        { return _misc_flags.has_nonstatic_fields(); }
  void set_has_nonstatic_fields(bool b)    { _misc_flags.set_has_nonstatic_fields(b); }

  bool has_localvariable_table() const     { return _misc_flags.has_localvariable_table(); }
  void set_has_localvariable_table(bool b) { _misc_flags.set_has_localvariable_table(b); }

  bool has_inlined_fields() const { return _misc_flags.has_inlined_fields(); }
  void set_has_inlined_fields()   { _misc_flags.set_has_inlined_fields(true); }

  bool has_null_restricted_static_fields() const { return _misc_flags.has_null_restricted_static_fields(); }
  void set_has_null_restricted_static_fields()   { _misc_flags.set_has_null_restricted_static_fields(true); }

  bool is_naturally_atomic(bool null_free) const;
  void set_is_naturally_atomic()    { _misc_flags.set_is_naturally_atomic(true); }

  // Query if this class has atomicity requirements (default is yes)
  // This bit can occur anywhere, but is only significant
  // for inline classes *and* their super types.
  // It inherits from supers.
  // Its value depends on the ForceNonTearable VM option, the LooselyConsistentValue annotation
  // and the presence of flat fields with atomicity requirements
  bool must_be_atomic() const { return _misc_flags.must_be_atomic(); }
  void set_must_be_atomic()   { _misc_flags.set_must_be_atomic(true); }

  bool fail_over_verified() const { return _misc_flags.fail_over_verified(); }
  void set_fail_over_verified() { _misc_flags.set_fail_over_verified(true); }

  // field sizes
  int nonstatic_field_size() const         { return _nonstatic_field_size; }
  void set_nonstatic_field_size(int size)  { _nonstatic_field_size = size; }

  int static_field_size() const            { return _static_field_size; }
  void set_static_field_size(int size)     { _static_field_size = size; }

  int static_oop_field_count() const       { return (int)_static_oop_field_count; }
  void set_static_oop_field_count(u2 size) { _static_oop_field_count = size; }

  bool trust_final_fields()                { return _misc_flags.trust_final_fields(); }
  void set_trust_final_fields(bool value)  { _misc_flags.set_trust_final_fields(value); }

  // Java itable
  int  itable_length() const               { return _itable_len; }
  void set_itable_length(int len)          { _itable_len = len; }

  // array klasses
  ObjArrayKlass* array_klasses() const     { return _array_klasses; }
  inline ObjArrayKlass* array_klasses_acquire() const; // load with acquire semantics
  inline void release_set_array_klasses(ObjArrayKlass* k); // store with release semantics
  void set_array_klasses(ObjArrayKlass* k) { _array_klasses = k; }

  // methods
  Array<Method*>* methods() const          { return _methods; }
  void set_methods(Array<Method*>* a)      { _methods = a; }
  Method* method_with_idnum(int idnum) const;
  Method* method_with_orig_idnum(int idnum) const;
  Method* method_with_orig_idnum(int idnum, int version) const;

  // method ordering
  Array<int>* method_ordering() const     { return _method_ordering; }
  void set_method_ordering(Array<int>* m) { _method_ordering = m; }
  void copy_method_ordering(const intArray* m, TRAPS);

  // default_methods
  Array<Method*>* default_methods() const  { return _default_methods; }
  void set_default_methods(Array<Method*>* a) { _default_methods = a; }

  // default method vtable_indices
  Array<int>* default_vtable_indices() const { return _default_vtable_indices; }
  void set_default_vtable_indices(Array<int>* v) { _default_vtable_indices = v; }
  Array<int>* create_new_default_vtable_indices(int len, TRAPS);

  // interfaces
  Array<InstanceKlass*>* local_interfaces() const          { return _local_interfaces; }
  void set_local_interfaces(Array<InstanceKlass*>* a)      {
    guarantee(_local_interfaces == nullptr || a == nullptr, "Just checking");
    _local_interfaces = a; }

  Array<InstanceKlass*>* transitive_interfaces() const     { return _transitive_interfaces; }
  void set_transitive_interfaces(Array<InstanceKlass*>* a) {
    guarantee(_transitive_interfaces == nullptr || a == nullptr, "Just checking");
    _transitive_interfaces = a;
  }

 private:
  friend class fieldDescriptor;
  FieldInfo field(int index) const;

 public:
  int     field_offset      (int index) const { return field(index).offset(); }
  int     field_access_flags(int index) const { return field(index).access_flags().as_field_flags(); }
  FieldInfo::FieldFlags field_flags(int index) const { return field(index).field_flags(); }
  FieldStatus field_status(int index)   const { return fields_status()->at(index); }
  inline Symbol* field_name        (int index) const;
  inline Symbol* field_signature   (int index) const;
  bool field_is_flat(int index) const { return field_flags(index).is_flat(); }
  bool field_has_null_marker(int index) const { return field_flags(index).has_null_marker(); }
  bool field_is_null_free_inline_type(int index) const;
  bool is_class_in_loadable_descriptors_attribute(Symbol* name) const;

  int field_null_marker_offset(int index) const { return inline_layout_info(index).null_marker_offset(); }

  // Number of Java declared fields
  int java_fields_count() const;
  int total_fields_count() const;

  Array<u1>* fieldinfo_stream() const { return _fieldinfo_stream; }
  void set_fieldinfo_stream(Array<u1>* fis) { _fieldinfo_stream = fis; }

  Array<u1>* fieldinfo_search_table() const { return _fieldinfo_search_table; }
  void set_fieldinfo_search_table(Array<u1>* table) { _fieldinfo_search_table = table; }

  Array<FieldStatus>* fields_status() const {return _fields_status; }
  void set_fields_status(Array<FieldStatus>* array) { _fields_status = array; }

  Array<u2>* loadable_descriptors() const { return _loadable_descriptors; }
  void set_loadable_descriptors(Array<u2>* c) { _loadable_descriptors = c; }

  Array<int>* acmp_maps_array() const { return _acmp_maps_array; }
  void set_acmp_maps_array(Array<int>* array) { _acmp_maps_array = array; }

  // inner classes
  Array<u2>* inner_classes() const       { return _inner_classes; }
  void set_inner_classes(Array<u2>* f)   { _inner_classes = f; }

  // nest members
  Array<u2>* nest_members() const     { return _nest_members; }
  void set_nest_members(Array<u2>* m) { _nest_members = m; }

  // nest-host index
  jushort nest_host_index() const { return _nest_host_index; }
  void set_nest_host_index(u2 i)  { _nest_host_index = i; }
  // dynamic nest member support
  void set_nest_host(InstanceKlass* host);

  // record components
  Array<RecordComponent*>* record_components() const { return _record_components; }
  void set_record_components(Array<RecordComponent*>* record_components) {
    _record_components = record_components;
  }
  bool is_record() const;

  // test for enum class (or possibly an anonymous subclass within a sealed enum)
  bool is_enum_subclass() const;

  // permitted subclasses
  Array<u2>* permitted_subclasses() const     { return _permitted_subclasses; }
  void set_permitted_subclasses(Array<u2>* s) { _permitted_subclasses = s; }

private:
  // Called to verify that k is a member of this nest - does not look at k's nest-host,
  // nor does it resolve any CP entries or load any classes.
  bool has_nest_member(JavaThread* current, InstanceKlass* k) const;

public:
  // Call this only if you know that the nest host has been initialized.
  InstanceKlass* nest_host_not_null() {
    assert(_nest_host != nullptr, "must be");
    return _nest_host;
  }
  InstanceKlass* nest_host_or_null() {
    return _nest_host;
  }
  // Used to construct informative IllegalAccessError messages at a higher level,
  // if there was an issue resolving or validating the nest host.
  // Returns null if there was no error.
  const char* nest_host_error();
  // Returns nest-host class, resolving and validating it if needed.
  // Returns null if resolution is not possible from the calling context.
  InstanceKlass* nest_host(TRAPS);
  // Check if this klass is a nestmate of k - resolves this nest-host and k's
  bool has_nestmate_access_to(InstanceKlass* k, TRAPS);

  // Called to verify that k is a permitted subclass of this class.
  // The incoming stringStream is used for logging, and for the caller to create
  // a detailed exception message on failure.
  bool has_as_permitted_subclass(const InstanceKlass* k, stringStream& ss) const;

  enum InnerClassAttributeOffset {
    // From http://mirror.eng/products/jdk/1.1/docs/guide/innerclasses/spec/innerclasses.doc10.html#18814
    inner_class_inner_class_info_offset = 0,
    inner_class_outer_class_info_offset = 1,
    inner_class_inner_name_offset = 2,
    inner_class_access_flags_offset = 3,
    inner_class_next_offset = 4
  };

  enum EnclosingMethodAttributeOffset {
    enclosing_method_class_index_offset = 0,
    enclosing_method_method_index_offset = 1,
    enclosing_method_attribute_size = 2
  };

  // package
  PackageEntry* package() const override { return _package_entry; }
  ModuleEntry* module() const override;
  bool in_javabase_module() const;
  bool in_unnamed_package() const   { return (_package_entry == nullptr); }
  void set_package(ClassLoaderData* loader_data, PackageEntry* pkg_entry, TRAPS);
  // If the package for the InstanceKlass is in the boot loader's package entry
  // table then sets the classpath_index field so that
  // get_system_package() will know to return a non-null value for the
  // package's location.  And, so that the package will be added to the list of
  // packages returned by get_system_packages().
  // For packages whose classes are loaded from the boot loader class path, the
  // classpath_index indicates which entry on the boot loader class path.
  void set_classpath_index(s2 path_index);
  bool is_same_class_package(const Klass* class2) const;
  bool is_same_class_package(oop other_class_loader, const Symbol* other_class_name) const;

  // find an enclosing class
  InstanceKlass* compute_enclosing_class(bool* inner_is_member, TRAPS) const;

  // Find InnerClasses attribute and return outer_class_info_index & inner_name_index.
  bool find_inner_classes_attr(int* ooff, int* noff, TRAPS) const;

  // Check if this klass can be null-free
  static void check_can_be_annotated_with_NullRestricted(InstanceKlass* type, Symbol* container_klass_name, TRAPS);

 private:
  // Check prohibited package ("java/" only loadable by boot or platform loaders)
  static void check_prohibited_package(Symbol* class_name,
                                       ClassLoaderData* loader_data,
                                       TRAPS);

  JavaThread* init_thread()  { return AtomicAccess::load(&_init_thread); }
  const char* init_thread_name() {
    return init_thread()->name_raw();
  }

 public:
  // initialization state
  bool is_loaded() const                   { return init_state() >= loaded; }
  bool is_linked() const                   { return init_state() >= linked; }
  bool is_initialized() const              { return init_state() == fully_initialized; }
  bool is_not_initialized() const          { return init_state() <  being_initialized; }
  bool is_being_initialized() const        { return init_state() == being_initialized; }
  bool is_in_error_state() const           { return init_state() == initialization_error; }
  bool is_reentrant_initialization(Thread *thread)  { return thread == _init_thread; }
  ClassState  init_state() const           { return AtomicAccess::load_acquire(&_init_state); }
  const char* init_state_name() const;
  bool is_rewritten() const                { return _misc_flags.rewritten(); }

  // is this a sealed class
  bool is_sealed() const;

  // defineClass specified verification
  bool should_verify_class() const         { return _misc_flags.should_verify_class(); }
  void set_should_verify_class(bool value) { _misc_flags.set_should_verify_class(value); }

  // marking
  bool is_marked_dependent() const         { return _misc_flags.is_marked_dependent(); }
  void set_is_marked_dependent(bool value) { _misc_flags.set_is_marked_dependent(value); }

  static ByteSize kind_offset() { return byte_offset_of(InstanceKlass, _kind); }
  static ByteSize misc_flags_offset() { return byte_offset_of(InstanceKlass, _misc_flags); }

  // initialization (virtuals from Klass)
  bool should_be_initialized() const override;  // means that initialize should be called
  void initialize_with_aot_initialized_mirror(bool early_init, TRAPS);
  void assert_no_clinit_will_run_for_aot_initialized_class() const NOT_DEBUG_RETURN;
  void initialize(TRAPS) override;
  void initialize_preemptable(TRAPS) override;
  void link_class(TRAPS);
  bool link_class_or_fail(TRAPS); // returns false on failure
  void rewrite_class(TRAPS);
  void link_methods(TRAPS);
  Method* class_initializer() const;
  bool interface_needs_clinit_execution_as_super(bool also_check_supers=true) const;

  // reference type
  ReferenceType reference_type() const     { return (ReferenceType)_reference_type; }

  bool has_acmp_maps_offset() const {
    return _acmp_maps_offset != 0;
  }

  int acmp_maps_offset() const {
    assert(_acmp_maps_offset != 0, "Not initialized");
    return _acmp_maps_offset;
  }
  void set_acmp_maps_offset(int offset) { _acmp_maps_offset = offset; }
  static ByteSize acmp_maps_offset_offset() { return byte_offset_of(InstanceKlass, _acmp_maps_offset); }

  // this class cp index
  u2 this_class_index() const             { return _this_class_index; }
  void set_this_class_index(u2 index)     { _this_class_index = index; }

  static ByteSize reference_type_offset() { return byte_offset_of(InstanceKlass, _reference_type); }

  // find local field, returns true if found
  bool find_local_field(Symbol* name, Symbol* sig, fieldDescriptor* fd) const;
  // find local field, returns true if found
  bool find_local_field(Symbol* name, Symbol* sig, fieldDescriptor* fd, bool also_internal) const;
  // find field in direct superinterfaces, returns the interface in which the field is defined
  Klass* find_interface_field(Symbol* name, Symbol* sig, fieldDescriptor* fd) const;
  // find field according to JVM spec 5.4.3.2, returns the klass in which the field is defined
  Klass* find_field(Symbol* name, Symbol* sig, fieldDescriptor* fd) const override;
  // find instance or static fields according to JVM spec 5.4.3.2, returns the klass in which the field is defined
  Klass* find_field(Symbol* name, Symbol* sig, bool is_static, fieldDescriptor* fd) const;

  // find a non-static or static field given its offset within the class.
  bool contains_field_offset(int offset);

  bool find_local_field_from_offset(int offset, bool is_static, fieldDescriptor* fd) const;
  bool find_field_from_offset(int offset, bool is_static, fieldDescriptor* fd) const;

  bool find_local_flat_field_containing_offset(int offset, fieldDescriptor* fd) const;
  bool find_flat_field_containing_offset(int offset, fieldDescriptor* fd) const;

 private:
  inline static int quick_search(const Array<Method*>* methods, const Symbol* name);

 public:
  static void disable_method_binary_search() {
    _disable_method_binary_search = true;
  }

  // find a local method (returns null if not found)
  Method* find_method(const Symbol* name, const Symbol* signature) const;
  static Method* find_method(const Array<Method*>* methods,
                             const Symbol* name,
                             const Symbol* signature);

  // find a local method, but skip static methods
  Method* find_instance_method(const Symbol* name, const Symbol* signature,
                               PrivateLookupMode private_mode) const;
  static Method* find_instance_method(const Array<Method*>* methods,
                                      const Symbol* name,
                                      const Symbol* signature,
                                      PrivateLookupMode private_mode);

  // find a local method (returns null if not found)
  Method* find_local_method(const Symbol* name,
                            const Symbol* signature,
                            OverpassLookupMode overpass_mode,
                            StaticLookupMode static_mode,
                            PrivateLookupMode private_mode) const;

  // find a local method from given methods array (returns null if not found)
  static Method* find_local_method(const Array<Method*>* methods,
                                   const Symbol* name,
                                   const Symbol* signature,
                                   OverpassLookupMode overpass_mode,
                                   StaticLookupMode static_mode,
                                   PrivateLookupMode private_mode);

  // find a local method index in methods or default_methods (returns -1 if not found)
  static int find_method_index(const Array<Method*>* methods,
                               const Symbol* name,
                               const Symbol* signature,
                               OverpassLookupMode overpass_mode,
                               StaticLookupMode static_mode,
                               PrivateLookupMode private_mode);

  // lookup operation (returns null if not found)
  Method* uncached_lookup_method(const Symbol* name,
                                 const Symbol* signature,
                                 OverpassLookupMode overpass_mode,
                                 PrivateLookupMode private_mode = PrivateLookupMode::find) const override;

  // lookup a method in all the interfaces that this class implements
  // (returns null if not found)
  Method* lookup_method_in_all_interfaces(Symbol* name, Symbol* signature, DefaultsLookupMode defaults_mode) const;

  // lookup a method in local defaults then in all interfaces
  // (returns null if not found)
  Method* lookup_method_in_ordered_interfaces(Symbol* name, Symbol* signature) const;

  // Find method indices by name.  If a method with the specified name is
  // found the index to the first method is returned, and 'end' is filled in
  // with the index of first non-name-matching method.  If no method is found
  // -1 is returned.
  int find_method_by_name(const Symbol* name, int* end) const;
  static int find_method_by_name(const Array<Method*>* methods,
                                 const Symbol* name, int* end);

  // constant pool
  ConstantPool* constants() const        { return _constants; }
  void set_constants(ConstantPool* c)    { _constants = c; }

  // protection domain
  oop protection_domain() const override;

  // signers
  objArrayOop signers() const;

  bool is_contended() const                { return _misc_flags.is_contended(); }
  void set_is_contended(bool value)        { _misc_flags.set_is_contended(value); }

  // source file name
  Symbol* source_file_name() const;
  u2 source_file_name_index() const;
  void set_source_file_name_index(u2 sourcefile_index);

  // minor and major version numbers of class file
  u2 minor_version() const;
  void set_minor_version(u2 minor_version);
  u2 major_version() const;
  void set_major_version(u2 major_version);

  bool supports_inline_types() const;

  // source debug extension
  const char* source_debug_extension() const { return _source_debug_extension; }
  void set_source_debug_extension(const char* array, int length);

  // nonstatic oop-map blocks
  static int nonstatic_oop_map_size(unsigned int oop_map_count) {
    return oop_map_count * OopMapBlock::size_in_words();
  }
  unsigned int nonstatic_oop_map_count() const {
    return _nonstatic_oop_map_size / OopMapBlock::size_in_words();
  }
  int nonstatic_oop_map_size() const { return _nonstatic_oop_map_size; }
  void set_nonstatic_oop_map_size(int words) {
    _nonstatic_oop_map_size = words;
  }

  bool has_contended_annotations() const { return _misc_flags.has_contended_annotations(); }
  void set_has_contended_annotations(bool value)  { _misc_flags.set_has_contended_annotations(value); }

#if INCLUDE_JVMTI
  // Redefinition locking.  Class can only be redefined by one thread at a time.
  bool is_being_redefined() const          { return _misc_flags.is_being_redefined(); }
  void set_is_being_redefined(bool value)  { _misc_flags.set_is_being_redefined(value); }

  // RedefineClasses() support for previous versions:
  void add_previous_version(InstanceKlass* ik, int emcp_method_count);
  void purge_previous_version_list();

  InstanceKlass* previous_versions() const { return _previous_versions; }
#else
  InstanceKlass* previous_versions() const { return nullptr; }
#endif

  const InstanceKlass* get_klass_version(int version) const;

  bool has_been_redefined() const { return _misc_flags.has_been_redefined(); }
  void set_has_been_redefined() { _misc_flags.set_has_been_redefined(true); }

  bool is_scratch_class() const { return _misc_flags.is_scratch_class(); }
  void set_is_scratch_class() { _misc_flags.set_is_scratch_class(true); }

  bool has_resolved_methods() const { return _misc_flags.has_resolved_methods(); }
  void set_has_resolved_methods()   { _misc_flags.set_has_resolved_methods(true); }
  void set_has_resolved_methods(bool value)   { _misc_flags.set_has_resolved_methods(value); }

public:
#if INCLUDE_JVMTI

  void init_previous_versions() {
    _previous_versions = nullptr;
  }

 private:
  static bool  _should_clean_previous_versions;
 public:
  static void purge_previous_versions(InstanceKlass* ik) {
    if (ik->has_been_redefined()) {
      ik->purge_previous_version_list();
    }
  }

  static bool should_clean_previous_versions_and_reset();
  static bool should_clean_previous_versions() { return _should_clean_previous_versions; }

  // JVMTI: Support for caching a class file before it is modified by an agent that can do retransformation
  void set_cached_class_file(JvmtiCachedClassFileData *data) {
    _cached_class_file = data;
  }
  JvmtiCachedClassFileData * get_cached_class_file();
  jint get_cached_class_file_len();
  unsigned char * get_cached_class_file_bytes();

  // JVMTI: Support for caching of field indices, types, and offsets
  void set_jvmti_cached_class_field_map(JvmtiCachedClassFieldMap* descriptor) {
    _jvmti_cached_class_field_map = descriptor;
  }
  JvmtiCachedClassFieldMap* jvmti_cached_class_field_map() const {
    return _jvmti_cached_class_field_map;
  }
#else // INCLUDE_JVMTI

  static void purge_previous_versions(InstanceKlass* ik) { return; };
  static bool should_clean_previous_versions_and_reset() { return false; }

  void set_cached_class_file(JvmtiCachedClassFileData *data) {
    assert(data == nullptr, "unexpected call with JVMTI disabled");
  }
  JvmtiCachedClassFileData * get_cached_class_file() { return (JvmtiCachedClassFileData *)nullptr; }

#endif // INCLUDE_JVMTI

  bool has_nonstatic_concrete_methods() const { return _misc_flags.has_nonstatic_concrete_methods(); }
  void set_has_nonstatic_concrete_methods(bool b) { _misc_flags.set_has_nonstatic_concrete_methods(b); }

  bool declares_nonstatic_concrete_methods() const { return _misc_flags.declares_nonstatic_concrete_methods(); }
  void set_declares_nonstatic_concrete_methods(bool b) { _misc_flags.set_declares_nonstatic_concrete_methods(b); }

  bool has_miranda_methods () const     { return _misc_flags.has_miranda_methods(); }
  void set_has_miranda_methods()        { _misc_flags.set_has_miranda_methods(true); }
  bool has_final_method() const         { return _misc_flags.has_final_method(); }
  void set_has_final_method()           { _misc_flags.set_has_final_method(true); }

  // for adding methods, ConstMethod::UNSET_IDNUM means no more ids available
  inline u2 next_method_idnum();
  void set_initial_method_idnum(u2 value)             { _idnum_allocated_count = value; }

  // runtime support for strict statics
  bool has_strict_static_fields() const     { return _misc_flags.has_strict_static_fields(); }
  void set_has_strict_static_fields(bool b) { _misc_flags.set_has_strict_static_fields(b); }
  void notify_strict_static_access(int field_index, bool is_writing, TRAPS);
  const char* format_strict_static_message(Symbol* field_name, const char* doing_what = nullptr);
  void throw_strict_static_exception(Symbol* field_name, const char* when, TRAPS);

  // generics support
  Symbol* generic_signature() const;
  u2 generic_signature_index() const;
  void set_generic_signature_index(u2 sig_index);

  u2 enclosing_method_data(int offset) const;
  u2 enclosing_method_class_index() const {
    return enclosing_method_data(enclosing_method_class_index_offset);
  }
  u2 enclosing_method_method_index() {
    return enclosing_method_data(enclosing_method_method_index_offset);
  }
  void set_enclosing_method_indices(u2 class_index,
                                    u2 method_index);

  // jmethodID support
  jmethodID get_jmethod_id(Method* method);
  void make_methods_jmethod_ids();
  jmethodID jmethod_id_or_null(Method* method);
  void update_methods_jmethod_cache();

  // annotations support
  Annotations* annotations() const          { return _annotations; }
  void set_annotations(Annotations* anno)   { _annotations = anno; }

  AnnotationArray* class_annotations() const {
    return (_annotations != nullptr) ? _annotations->class_annotations() : nullptr;
  }
  Array<AnnotationArray*>* fields_annotations() const {
    return (_annotations != nullptr) ? _annotations->fields_annotations() : nullptr;
  }
  AnnotationArray* class_type_annotations() const {
    return (_annotations != nullptr) ? _annotations->class_type_annotations() : nullptr;
  }
  Array<AnnotationArray*>* fields_type_annotations() const {
    return (_annotations != nullptr) ? _annotations->fields_type_annotations() : nullptr;
  }
  // allocation
  instanceOop allocate_instance(TRAPS);
  static instanceOop allocate_instance(oop cls, TRAPS);

  // additional member function to return a handle
  instanceHandle allocate_instance_handle(TRAPS);

  // Helper function
  static instanceOop register_finalizer(instanceOop i, TRAPS);

  // Check whether reflection/jni/jvm code is allowed to instantiate this class;
  // if not, throw either an Error or an Exception.
  void check_valid_for_instantiation(bool throwError, TRAPS) override;

  // initialization
  void call_class_initializer(TRAPS);
  void set_initialization_state_and_notify(ClassState state, TRAPS);

  // OopMapCache support
  OopMapCache* oop_map_cache()               { return _oop_map_cache; }
  void set_oop_map_cache(OopMapCache *cache) { _oop_map_cache = cache; }
  void mask_for(const methodHandle& method, int bci, InterpreterOopMap* entry);

  // JNI identifier support (for static fields - for jni performance)
  JNIid* jni_ids()                               { return _jni_ids; }
  void set_jni_ids(JNIid* ids)                   { _jni_ids = ids; }
  JNIid* jni_id_for(int offset);

 public:
  // maintenance of deoptimization dependencies
  inline DependencyContext dependencies();
  void mark_dependent_nmethods(DeoptimizationScope* deopt_scope, KlassDepChange& changes);
  void add_dependent_nmethod(nmethod* nm);
  void clean_dependency_context();
  // Setup link to hierarchy and deoptimize
  void add_to_hierarchy(JavaThread* current);

  // On-stack replacement support
  nmethod* osr_nmethods_head() const         { return _osr_nmethods_head; };
  void set_osr_nmethods_head(nmethod* h)     { _osr_nmethods_head = h; };
  void add_osr_nmethod(nmethod* n);
  bool remove_osr_nmethod(nmethod* n);
  int mark_osr_nmethods(DeoptimizationScope* deopt_scope, const Method* m);
  nmethod* lookup_osr_nmethod(const Method* m, int bci, int level, bool match_level) const;

#if INCLUDE_JVMTI
  // Breakpoint support (see methods on Method* for details)
  BreakpointInfo* breakpoints() const       { return _breakpoints; };
  void set_breakpoints(BreakpointInfo* bps) { _breakpoints = bps; };
#endif

  // support for stub routines
  static ByteSize init_state_offset()  { return byte_offset_of(InstanceKlass, _init_state); }
  JFR_ONLY(DEFINE_KLASS_TRACE_ID_OFFSET;)
  static ByteSize init_thread_offset() { return byte_offset_of(InstanceKlass, _init_thread); }

  static ByteSize inline_layout_info_array_offset() { return byte_offset_of(InstanceKlass, _inline_layout_info_array); }
  static ByteSize adr_inline_klass_members_offset() { return byte_offset_of(InstanceKlass, _adr_inline_klass_members); }

  // subclass/subinterface checks
  bool implements_interface(Klass* k) const;
  bool is_same_or_direct_interface(Klass* k) const;

#ifdef ASSERT
  // check whether this class or one of its superclasses was redefined
  bool has_redefined_this_or_super() const;
#endif

  // Access to the implementor of an interface.
  //   The embedded implementor only exists if the current klass is an
  //   interface. The possible values of the implementor fall into following
  //   three cases:
  //     null: no implementor.
  //     A Klass* that's not itself: one implementor.
  //     Itself: more than one implementors.
  //
  InstanceKlass* implementor() const;
  void set_implementor(InstanceKlass* ik);
  int  nof_implementors() const;
  void add_implementor(InstanceKlass* ik);  // ik is a new class that implements this interface
  void init_implementor();           // initialize

 private:
  // link this class into the implementors list of every interface it implements
  void process_interfaces();

 public:
  // virtual operations from Klass
  GrowableArray<Klass*>* compute_secondary_supers(int num_extra_slots,
                                                  Array<InstanceKlass*>* transitive_interfaces) override;
  bool can_be_primary_super_slow() const override;
  size_t oop_size(oop obj)  const override    { return size_helper(); }
  // slow because it's a virtual call and used for verifying the layout_helper.
  // Using the layout_helper bits, we can call is_instance_klass without a virtual call.
  DEBUG_ONLY(bool is_instance_klass_slow() const override { return true; })

  // Iterators
  void do_local_static_fields(FieldClosure* cl);
  void do_nonstatic_fields(FieldClosure* cl); // including inherited fields
  void do_local_static_fields(void f(fieldDescriptor*, Handle, TRAPS), Handle, TRAPS);
  void print_nonstatic_fields(FieldClosure* cl); // including inherited and injected fields

  void methods_do(void f(Method* method));

  static InstanceKlass* cast(Klass* k) {
    return const_cast<InstanceKlass*>(cast(const_cast<const Klass*>(k)));
  }

  static const InstanceKlass* cast(const Klass* k) {
    assert(k != nullptr, "k should not be null");
    assert(k->is_instance_klass(), "cast to InstanceKlass");
    return static_cast<const InstanceKlass*>(k);
  }

  // This hides Klass::super(). The _super of an InstanceKlass is
  // always an InstanceKlass (or nullptr)
  InstanceKlass* super() const {
    return (Klass::super() == nullptr) ? nullptr : InstanceKlass::cast(Klass::super());
  }

  InstanceKlass* java_super() const override {
    return InstanceKlass::super();
  }

  // Sizing (in words)
  static int header_size() { return sizeof(InstanceKlass) / wordSize; }

  static int size(int vtable_length,
                  int itable_length,
                  int nonstatic_oop_map_size,
                  bool is_interface,
                  bool is_inline_type);

  int size() const override;


  inline intptr_t* start_of_itable() const;
  inline intptr_t* end_of_itable() const;
  inline oop static_field_base_raw();

  inline OopMapBlock* start_of_nonstatic_oop_maps() const;
  inline Klass** end_of_nonstatic_oop_maps() const;

  inline InstanceKlass* volatile* adr_implementor() const;

  // The end of the memory block that belongs to this InstanceKlass.
  // Sub-klasses can place their fields after this address.
  inline address end_of_instance_klass() const;

  void set_inline_layout_info_array(Array<InlineLayoutInfo>* array) { _inline_layout_info_array = array; }
  Array<InlineLayoutInfo>* inline_layout_info_array() const { return _inline_layout_info_array; }

  InlineLayoutInfo inline_layout_info(int index) const {
    assert(_inline_layout_info_array != nullptr, "Array not created");
    return _inline_layout_info_array->at(index);
  }

  InlineLayoutInfo* inline_layout_info_adr(int index) {
    assert(_inline_layout_info_array != nullptr, "Array not created");
    return _inline_layout_info_array->adr_at(index);
  }

  inline InlineKlass* get_inline_type_field_klass(int idx) const ;
  inline InlineKlass* get_inline_type_field_klass_or_null(int idx) const;

  // Use this to return the size of an instance in heap words:
  int size_helper() const {
    return layout_helper_to_size_helper(layout_helper());
  }

  // This bit is initialized in classFileParser.cpp.
  // It is false under any of the following conditions:
  //  - the class is abstract (including any interface)
  //  - the class size is larger than FastAllocateSizeLimit
  //  - the class is java/lang/Class, which cannot be allocated directly
  bool can_be_fastpath_allocated() const {
    return !layout_helper_needs_slow_path(layout_helper());
  }

  // Java itable
  klassItable itable() const;        // return klassItable wrapper
  Method* method_at_itable(InstanceKlass* holder, int index, TRAPS);
  Method* method_at_itable_or_null(InstanceKlass* holder, int index, bool& itable_entry_found);
  int vtable_index_of_interface_method(Method* method);

#if INCLUDE_JVMTI
  void adjust_default_methods(bool* trace_name_printed);
#endif // INCLUDE_JVMTI

  void clean_weak_instanceklass_links();
 private:
  void clean_implementors_list();
  void clean_method_data();

 public:
  // Explicit metaspace deallocation of fields
  // For RedefineClasses and class file parsing errors, we need to deallocate
  // instanceKlasses and the metadata they point to.
  void deallocate_contents(ClassLoaderData* loader_data);
  static void deallocate_methods(ClassLoaderData* loader_data,
                                 Array<Method*>* methods);
  void static deallocate_interfaces(ClassLoaderData* loader_data,
                                    const InstanceKlass* super_klass,
                                    Array<InstanceKlass*>* local_interfaces,
                                    Array<InstanceKlass*>* transitive_interfaces);
  void static deallocate_record_components(ClassLoaderData* loader_data,
                                           Array<RecordComponent*>* record_component);

  bool on_stack() const override;

  // callbacks for actions during class unloading
  static void unload_class(InstanceKlass* ik);

  void release_C_heap_structures(bool release_sub_metadata = true) override;

  // Naming
  const char* signature_name() const override;

  // Oop fields (and metadata) iterators
  //
  // The InstanceKlass iterators also visits the Object's klass.

  // Forward iteration
 public:
  // Iterate over all oop fields in the oop maps.
  template <typename T, class OopClosureType>
  inline void oop_oop_iterate_oop_maps(oop obj, OopClosureType* closure);

  // Iterate over all oop fields and metadata.
  template <typename T, class OopClosureType>
  inline void oop_oop_iterate(oop obj, OopClosureType* closure);

  // Iterate over all oop fields in one oop map.
  template <typename T, class OopClosureType>
  inline void oop_oop_iterate_oop_map(OopMapBlock* map, oop obj, OopClosureType* closure);


  // Reverse iteration
  // Iterate over all oop fields and metadata.
  template <typename T, class OopClosureType>
  inline void oop_oop_iterate_reverse(oop obj, OopClosureType* closure);

 private:
  // Iterate over all oop fields in the oop maps.
  template <typename T, class OopClosureType>
  inline void oop_oop_iterate_oop_maps_reverse(oop obj, OopClosureType* closure);

  // Iterate over all oop fields in one oop map.
  template <typename T, class OopClosureType>
  inline void oop_oop_iterate_oop_map_reverse(OopMapBlock* map, oop obj, OopClosureType* closure);


  // Bounded range iteration
 public:
  // Iterate over all oop fields in the oop maps.
  template <typename T, class OopClosureType>
  inline void oop_oop_iterate_oop_maps_bounded(oop obj, OopClosureType* closure, MemRegion mr);

  // Iterate over all oop fields and metadata.
  template <typename T, class OopClosureType>
  inline void oop_oop_iterate_bounded(oop obj, OopClosureType* closure, MemRegion mr);

 private:
  // Iterate over all oop fields in one oop map.
  template <typename T, class OopClosureType>
  inline void oop_oop_iterate_oop_map_bounded(OopMapBlock* map, oop obj, OopClosureType* closure, MemRegion mr);


 public:
  u2 idnum_allocated_count() const      { return _idnum_allocated_count; }

private:
  // initialization state
  void set_init_state(ClassState state);
  void set_rewritten()                  { _misc_flags.set_rewritten(true); }
  void set_init_thread(JavaThread *thread)  {
    assert((thread == JavaThread::current() && _init_thread == nullptr) ||
           (thread == nullptr && _init_thread == JavaThread::current()), "Only one thread is allowed to own initialization");
    AtomicAccess::store(&_init_thread, thread);
  }

  jmethodID* methods_jmethod_ids_acquire() const;
  void release_set_methods_jmethod_ids(jmethodID* jmeths);
  // This nulls out obsolete jmethodIDs for all methods in 'klass'.
  static void clear_obsolete_jmethod_ids(InstanceKlass* klass);
  jmethodID update_jmethod_id(jmethodID* jmeths, Method* method, int idnum);

public:
  // Lock for (1) initialization; (2) access to the ConstantPool of this class.
  // Must be one per class and it has to be a VM internal object so java code
  // cannot lock it (like the mirror).
  // It has to be an object not a Mutex because it's held through java calls.
  oop init_lock() const;

  // Returns the array class for the n'th dimension
  ArrayKlass* array_klass(int n, TRAPS) override;
  ArrayKlass* array_klass_or_null(int n) override;

  // Returns the array class with this class as element type
  ArrayKlass* array_klass(TRAPS) override;
  ArrayKlass* array_klass_or_null() override;

  static void clean_initialization_error_table();
private:
  void fence_and_clear_init_lock();

  bool link_class_impl                           (TRAPS);
  bool verify_code                               (TRAPS);
  void initialize_impl                           (TRAPS);
  void initialize_super_interfaces               (TRAPS);

  void add_initialization_error(JavaThread* current, Handle exception);
  oop get_initialization_error(JavaThread* current);

  // find a local method (returns null if not found)
  Method* find_method_impl(const Symbol* name,
                           const Symbol* signature,
                           OverpassLookupMode overpass_mode,
                           StaticLookupMode static_mode,
                           PrivateLookupMode private_mode) const;

  static Method* find_method_impl(const Array<Method*>* methods,
                                  const Symbol* name,
                                  const Symbol* signature,
                                  OverpassLookupMode overpass_mode,
                                  StaticLookupMode static_mode,
                                  PrivateLookupMode private_mode);

#if INCLUDE_JVMTI
  // RedefineClasses support
  void link_previous_versions(InstanceKlass* pv) { _previous_versions = pv; }
  void mark_newly_obsolete_methods(Array<Method*>* old_methods, int emcp_method_count);
#endif
public:

#if INCLUDE_CDS
  // CDS support - remove and restore oops from metadata. Oops are not shared.
  void remove_unshareable_info() override;
  void remove_unshareable_flags();
  void remove_java_mirror() override;
  virtual void restore_unshareable_info(ClassLoaderData* loader_data, Handle protection_domain, PackageEntry* pkg_entry, TRAPS);
  void init_shared_package_entry();
  bool can_be_verified_at_dumptime() const;
  void compute_has_loops_flag_for_methods();
#endif
  bool     has_init_deps_processed() const { return _misc_flags.has_init_deps_processed(); }
  void set_has_init_deps_processed() {
    assert(is_initialized(), "");
    assert(!has_init_deps_processed(), "already set"); // one-off action
    _misc_flags.set_has_init_deps_processed(true);
  }

  u2 compute_modifier_flags() const override;

public:
  // JVMTI support
  jint jvmti_class_status() const override;

  void metaspace_pointers_do(MetaspaceClosure* iter) override;

 public:
  // Printing
  void print_on(outputStream* st) const override;
  void print_value_on(outputStream* st) const override;
  void print_class_flags(outputStream* st) const;

  void oop_print_value_on(oop obj, outputStream* st) override;

  void oop_print_on      (oop obj, outputStream* st) override { oop_print_on(obj, st, 0, 0); }
  void oop_print_on      (oop obj, outputStream* st, int indent = 0, int base_offset = 0);

#ifndef PRODUCT
  void print_dependent_nmethods(bool verbose = false);
  bool is_dependent_nmethod(nmethod* nm);
  bool verify_itable_index(int index);
#endif

  const char* internal_name() const override;

  template<typename T, typename TClosureType>
  static void print_array_on(outputStream* st, Array<T>* array, TClosureType elem_printer);

  // Verification
  void verify_on(outputStream* st) override;

  void oop_verify_on(oop obj, outputStream* st) override;

  // Logging
  void print_class_load_logging(ClassLoaderData* loader_data,
                                const ModuleEntry* module_entry,
                                const ClassFileStream* cfs) const;
 private:
  void print_class_load_cause_logging() const;
  void print_class_load_helper(ClassLoaderData* loader_data,
                               const ModuleEntry* module_entry,
                               const ClassFileStream* cfs) const;
};

// for adding methods
// UNSET_IDNUM return means no more ids available
inline u2 InstanceKlass::next_method_idnum() {
  if (_idnum_allocated_count == ConstMethod::MAX_IDNUM) {
    return ConstMethod::UNSET_IDNUM; // no more ids available
  } else {
    return _idnum_allocated_count++;
  }
}

class PrintClassClosure : public KlassClosure {
private:
  outputStream* _st;
  bool _verbose;
public:
  PrintClassClosure(outputStream* st, bool verbose);

  void do_klass(Klass* k);
};

/* JNIid class for jfieldIDs only */
class JNIid: public CHeapObj<mtClass> {
  friend class VMStructs;
 private:
  InstanceKlass*     _holder;
  JNIid*             _next;
  int                _offset;
#ifdef ASSERT
  bool               _is_static_field_id;
#endif

 public:
  // Accessors
  InstanceKlass* holder() const   { return _holder; }
  int offset() const              { return _offset; }
  JNIid* next()                   { return _next; }
  // Constructor
  JNIid(InstanceKlass* holder, int offset, JNIid* next);
  // Identifier lookup
  JNIid* find(int offset);

  bool find_local_field(fieldDescriptor* fd) {
    return InstanceKlass::cast(holder())->find_local_field_from_offset(offset(), true, fd);
  }

  static void deallocate(JNIid* id);
  // Debugging
#ifdef ASSERT
  bool is_static_field_id() const { return _is_static_field_id; }
  void set_is_static_field_id()   { _is_static_field_id = true; }
#endif
  void verify(InstanceKlass* holder);
};

// An iterator that's used to access the inner classes indices in the
// InstanceKlass::_inner_classes array.
class InnerClassesIterator : public StackObj {
 private:
  Array<jushort>* _inner_classes;
  int _length;
  int _idx;
 public:

  InnerClassesIterator(const InstanceKlass* k) {
    _inner_classes = k->inner_classes();
    if (k->inner_classes() != nullptr) {
      _length = _inner_classes->length();
      // The inner class array's length should be the multiple of
      // inner_class_next_offset if it only contains the InnerClasses
      // attribute data, or it should be
      // n*inner_class_next_offset+enclosing_method_attribute_size
      // if it also contains the EnclosingMethod data.
      assert((_length % InstanceKlass::inner_class_next_offset == 0 ||
              _length % InstanceKlass::inner_class_next_offset == InstanceKlass::enclosing_method_attribute_size),
             "just checking");
      // Remove the enclosing_method portion if exists.
      if (_length % InstanceKlass::inner_class_next_offset == InstanceKlass::enclosing_method_attribute_size) {
        _length -= InstanceKlass::enclosing_method_attribute_size;
      }
    } else {
      _length = 0;
    }
    _idx = 0;
  }

  int length() const {
    return _length;
  }

  void next() {
    _idx += InstanceKlass::inner_class_next_offset;
  }

  bool done() const {
    return (_idx >= _length);
  }

  u2 inner_class_info_index() const {
    return _inner_classes->at(
               _idx + InstanceKlass::inner_class_inner_class_info_offset);
  }

  void set_inner_class_info_index(u2 index) {
    _inner_classes->at_put(
               _idx + InstanceKlass::inner_class_inner_class_info_offset, index);
  }

  u2 outer_class_info_index() const {
    return _inner_classes->at(
               _idx + InstanceKlass::inner_class_outer_class_info_offset);
  }

  void set_outer_class_info_index(u2 index) {
    _inner_classes->at_put(
               _idx + InstanceKlass::inner_class_outer_class_info_offset, index);
  }

  u2 inner_name_index() const {
    return _inner_classes->at(
               _idx + InstanceKlass::inner_class_inner_name_offset);
  }

  void set_inner_name_index(u2 index) {
    _inner_classes->at_put(
               _idx + InstanceKlass::inner_class_inner_name_offset, index);
  }

  u2 inner_access_flags() const {
    return _inner_classes->at(
               _idx + InstanceKlass::inner_class_access_flags_offset);
  }
};

// Iterator over class hierarchy under a particular class. Implements depth-first pre-order traversal.
// Usage:
//  for (ClassHierarchyIterator iter(root_klass); !iter.done(); iter.next()) {
//    Klass* k = iter.klass();
//    ...
//  }
class ClassHierarchyIterator : public StackObj {
 private:
  InstanceKlass* _root;
  Klass*         _current;
  bool           _visit_subclasses;

 public:
  ClassHierarchyIterator(InstanceKlass* root) : _root(root), _current(root), _visit_subclasses(true) {
    assert(_root == _current, "required"); // initial state
  }

  bool done() {
    return (_current == nullptr);
  }

  // Make a step iterating over the class hierarchy under the root class.
  // Skips subclasses if requested.
  void next();

  Klass* klass() {
    assert(!done(), "sanity");
    return _current;
  }

  // Skip subclasses of the current class.
  void skip_subclasses() {
    _visit_subclasses = false;
  }
};

#endif // SHARE_OOPS_INSTANCEKLASS_HPP