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