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