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 loader_type_bits() {
 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   u2 loader_type() {
 357     return _misc_flags & loader_type_bits();
 358   }
 359 
 360   bool is_shared_boot_class() const {
 361     return (_misc_flags & _misc_is_shared_boot_class) != 0;
 362   }
 363   bool is_shared_platform_class() const {
 364     return (_misc_flags & _misc_is_shared_platform_class) != 0;
 365   }
 366   bool is_shared_app_class() const {
 367     return (_misc_flags & _misc_is_shared_app_class) != 0;
 368   }
 369 
 370   void clear_class_loader_type() {
 371     _misc_flags &= ~loader_type_bits();
 372   }
 373 
 374   void set_class_loader_type(s2 loader_type);
 375 
 376   bool has_nonstatic_fields() const        {
 377     return (_misc_flags & _misc_has_nonstatic_fields) != 0;
 378   }
 379   void set_has_nonstatic_fields(bool b)    {
 380     if (b) {
 381       _misc_flags |= _misc_has_nonstatic_fields;
 382     } else {
 383       _misc_flags &= ~_misc_has_nonstatic_fields;
 384     }
 385   }
 386 
 387   // field sizes
 388   int nonstatic_field_size() const         { return _nonstatic_field_size; }
 389   void set_nonstatic_field_size(int size)  { _nonstatic_field_size = size; }
 390 
 391   int static_field_size() const            { return _static_field_size; }
 392   void set_static_field_size(int size)     { _static_field_size = size; }
 393 
 394   int static_oop_field_count() const       { return (int)_static_oop_field_count; }
 395   void set_static_oop_field_count(u2 size) { _static_oop_field_count = size; }
 396 
 397   // Java itable
 398   int  itable_length() const               { return _itable_len; }
 399   void set_itable_length(int len)          { _itable_len = len; }
 400 
 401   // array klasses
 402   Klass* array_klasses() const             { return _array_klasses; }
 403   inline Klass* array_klasses_acquire() const; // load with acquire semantics
 404   void set_array_klasses(Klass* k)         { _array_klasses = k; }
 405   inline void release_set_array_klasses(Klass* k); // store with release semantics
 406 
 407   // methods
 408   Array<Method*>* methods() const          { return _methods; }
 409   void set_methods(Array<Method*>* a)      { _methods = a; }
 410   Method* method_with_idnum(int idnum);
 411   Method* method_with_orig_idnum(int idnum);
 412   Method* method_with_orig_idnum(int idnum, int version);
 413 
 414   // method ordering
 415   Array<int>* method_ordering() const     { return _method_ordering; }
 416   void set_method_ordering(Array<int>* m) { _method_ordering = m; }
 417   void copy_method_ordering(const intArray* m, TRAPS);
 418 
 419   // default_methods
 420   Array<Method*>* default_methods() const  { return _default_methods; }
 421   void set_default_methods(Array<Method*>* a) { _default_methods = a; }
 422 
 423   // default method vtable_indices
 424   Array<int>* default_vtable_indices() const { return _default_vtable_indices; }
 425   void set_default_vtable_indices(Array<int>* v) { _default_vtable_indices = v; }
 426   Array<int>* create_new_default_vtable_indices(int len, TRAPS);
 427 
 428   // interfaces
 429   Array<InstanceKlass*>* local_interfaces() const          { return _local_interfaces; }
 430   void set_local_interfaces(Array<InstanceKlass*>* a)      {
 431     guarantee(_local_interfaces == NULL || a == NULL, "Just checking");
 432     _local_interfaces = a; }
 433 
 434   Array<InstanceKlass*>* transitive_interfaces() const     { return _transitive_interfaces; }
 435   void set_transitive_interfaces(Array<InstanceKlass*>* a) {
 436     guarantee(_transitive_interfaces == NULL || a == NULL, "Just checking");
 437     _transitive_interfaces = a;
 438   }
 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   // record components
 473   Array<RecordComponent*>* record_components() const { return _record_components; }
 474   void set_record_components(Array<RecordComponent*>* record_components) {
 475     _record_components = record_components;
 476   }
 477   bool is_record() const { return _record_components != NULL; }
 478 
 479 private:
 480   // Called to verify that k is a member of this nest - does not look at k's nest-host
 481   bool has_nest_member(InstanceKlass* k, TRAPS) const;
 482 
 483 public:
 484   // Returns nest-host class, resolving and validating it if needed
 485   // Returns NULL if an exception occurs during loading, or validation fails
 486   InstanceKlass* nest_host(Symbol* validationException, TRAPS);
 487   // Check if this klass is a nestmate of k - resolves this nest-host and k's
 488   bool has_nestmate_access_to(InstanceKlass* k, TRAPS);
 489 
 490   enum InnerClassAttributeOffset {
 491     // From http://mirror.eng/products/jdk/1.1/docs/guide/innerclasses/spec/innerclasses.doc10.html#18814
 492     inner_class_inner_class_info_offset = 0,
 493     inner_class_outer_class_info_offset = 1,
 494     inner_class_inner_name_offset = 2,
 495     inner_class_access_flags_offset = 3,
 496     inner_class_next_offset = 4
 497   };
 498 
 499   enum EnclosingMethodAttributeOffset {
 500     enclosing_method_class_index_offset = 0,
 501     enclosing_method_method_index_offset = 1,
 502     enclosing_method_attribute_size = 2
 503   };
 504 
 505   // method override check
 506   bool is_override(const methodHandle& super_method, Handle targetclassloader, Symbol* targetclassname, TRAPS);
 507 
 508   // package
 509   PackageEntry* package() const     { return _package_entry; }
 510   ModuleEntry* module() const;
 511   bool in_unnamed_package() const   { return (_package_entry == NULL); }
 512   void set_package(PackageEntry* p) { _package_entry = p; }
 513   void set_package(ClassLoaderData* loader_data, TRAPS);
 514   bool is_same_class_package(const Klass* class2) const;
 515   bool is_same_class_package(oop other_class_loader, const Symbol* other_class_name) const;
 516 
 517   // find an enclosing class
 518   InstanceKlass* compute_enclosing_class(bool* inner_is_member, TRAPS) const;
 519 
 520   // Find InnerClasses attribute and return outer_class_info_index & inner_name_index.
 521   bool find_inner_classes_attr(int* ooff, int* noff, TRAPS) const;
 522 
 523  private:
 524   // Check prohibited package ("java/" only loadable by boot or platform loaders)
 525   static void check_prohibited_package(Symbol* class_name,
 526                                        ClassLoaderData* loader_data,
 527                                        TRAPS);
 528  public:
 529   // initialization state
 530   bool is_loaded() const                   { return _init_state >= loaded; }
 531   bool is_linked() const                   { return _init_state >= linked; }
 532   bool is_initialized() const              { return _init_state == fully_initialized; }
 533   bool is_not_initialized() const          { return _init_state <  being_initialized; }
 534   bool is_being_initialized() const        { return _init_state == being_initialized; }
 535   bool is_in_error_state() const           { return _init_state == initialization_error; }
 536   bool is_reentrant_initialization(Thread *thread)  { return thread == _init_thread; }
 537   ClassState  init_state()                 { return (ClassState)_init_state; }
 538   bool is_rewritten() const                { return (_misc_flags & _misc_rewritten) != 0; }
 539 
 540   // defineClass specified verification
 541   bool should_verify_class() const         {
 542     return (_misc_flags & _misc_should_verify_class) != 0;
 543   }
 544   void set_should_verify_class(bool value) {
 545     if (value) {
 546       _misc_flags |= _misc_should_verify_class;
 547     } else {
 548       _misc_flags &= ~_misc_should_verify_class;
 549     }
 550   }
 551 
 552   // marking
 553   bool is_marked_dependent() const         { return _is_marked_dependent; }
 554   void set_is_marked_dependent(bool value) { _is_marked_dependent = value; }
 555 
 556   // initialization (virtuals from Klass)
 557   bool should_be_initialized() const;  // means that initialize should be called
 558   void initialize(TRAPS);
 559   void link_class(TRAPS);
 560   bool link_class_or_fail(TRAPS); // returns false on failure
 561   void rewrite_class(TRAPS);
 562   void link_methods(TRAPS);
 563   Method* class_initializer() const;
 564 
 565   // set the class to initialized if no static initializer is present
 566   void eager_initialize(Thread *thread);
 567 
 568   // reference type
 569   ReferenceType reference_type() const     { return (ReferenceType)_reference_type; }
 570   void set_reference_type(ReferenceType t) {
 571     assert(t == (u1)t, "overflow");
 572     _reference_type = (u1)t;
 573   }
 574 
 575   // this class cp index
 576   u2 this_class_index() const             { return _this_class_index; }
 577   void set_this_class_index(u2 index)     { _this_class_index = index; }
 578 
 579   static ByteSize reference_type_offset() { return in_ByteSize(offset_of(InstanceKlass, _reference_type)); }
 580 
 581   // find local field, returns true if found
 582   bool find_local_field(Symbol* name, Symbol* sig, fieldDescriptor* fd) const;
 583   // find field in direct superinterfaces, returns the interface in which the field is defined
 584   Klass* find_interface_field(Symbol* name, Symbol* sig, fieldDescriptor* fd) const;
 585   // find field according to JVM spec 5.4.3.2, returns the klass in which the field is defined
 586   Klass* find_field(Symbol* name, Symbol* sig, fieldDescriptor* fd) const;
 587   // find instance or static fields according to JVM spec 5.4.3.2, returns the klass in which the field is defined
 588   Klass* find_field(Symbol* name, Symbol* sig, bool is_static, fieldDescriptor* fd) const;
 589 
 590   // find a non-static or static field given its offset within the class.
 591   bool contains_field_offset(int offset);
 592 
 593   bool find_local_field_from_offset(int offset, bool is_static, fieldDescriptor* fd) const;
 594   bool find_field_from_offset(int offset, bool is_static, fieldDescriptor* fd) const;
 595 
 596  private:
 597   inline static int quick_search(const Array<Method*>* methods, const Symbol* name);
 598 
 599  public:
 600   static void disable_method_binary_search() {
 601     _disable_method_binary_search = true;
 602   }
 603 
 604   // find a local method (returns NULL if not found)
 605   Method* find_method(const Symbol* name, const Symbol* signature) const;
 606   static Method* find_method(const Array<Method*>* methods,
 607                              const Symbol* name,
 608                              const Symbol* signature);
 609 
 610   // find a local method, but skip static methods
 611   Method* find_instance_method(const Symbol* name, const Symbol* signature,
 612                                PrivateLookupMode private_mode = find_private) const;
 613   static Method* find_instance_method(const Array<Method*>* methods,
 614                                       const Symbol* name,
 615                                       const Symbol* signature,
 616                                       PrivateLookupMode private_mode = find_private);
 617 
 618   // find a local method (returns NULL if not found)
 619   Method* find_local_method(const Symbol* name,
 620                             const Symbol* signature,
 621                             OverpassLookupMode overpass_mode,
 622                             StaticLookupMode static_mode,
 623                             PrivateLookupMode private_mode) const;
 624 
 625   // find a local method from given methods array (returns NULL if not found)
 626   static Method* find_local_method(const Array<Method*>* methods,
 627                                    const Symbol* name,
 628                                    const Symbol* signature,
 629                                    OverpassLookupMode overpass_mode,
 630                                    StaticLookupMode static_mode,
 631                                    PrivateLookupMode private_mode);
 632 
 633   // find a local method index in methods or default_methods (returns -1 if not found)
 634   static int find_method_index(const Array<Method*>* methods,
 635                                const Symbol* name,
 636                                const Symbol* signature,
 637                                OverpassLookupMode overpass_mode,
 638                                StaticLookupMode static_mode,
 639                                PrivateLookupMode private_mode);
 640 
 641   // lookup operation (returns NULL if not found)
 642   Method* uncached_lookup_method(const Symbol* name,
 643                                  const Symbol* signature,
 644                                  OverpassLookupMode overpass_mode,
 645                                  PrivateLookupMode private_mode = find_private) const;
 646 
 647   // lookup a method in all the interfaces that this class implements
 648   // (returns NULL if not found)
 649   Method* lookup_method_in_all_interfaces(Symbol* name, Symbol* signature, DefaultsLookupMode defaults_mode) const;
 650 
 651   // lookup a method in local defaults then in all interfaces
 652   // (returns NULL if not found)
 653   Method* lookup_method_in_ordered_interfaces(Symbol* name, Symbol* signature) const;
 654 
 655   // Find method indices by name.  If a method with the specified name is
 656   // found the index to the first method is returned, and 'end' is filled in
 657   // with the index of first non-name-matching method.  If no method is found
 658   // -1 is returned.
 659   int find_method_by_name(const Symbol* name, int* end) const;
 660   static int find_method_by_name(const Array<Method*>* methods,
 661                                  const Symbol* name, int* end);
 662 
 663   // constant pool
 664   ConstantPool* constants() const        { return _constants; }
 665   void set_constants(ConstantPool* c)    { _constants = c; }
 666 
 667   // protection domain
 668   oop protection_domain() const;
 669 
 670   // signers
 671   objArrayOop signers() const;
 672 
 673   // host class
 674   InstanceKlass* unsafe_anonymous_host() const {
 675     InstanceKlass** hk = adr_unsafe_anonymous_host();
 676     if (hk == NULL) {
 677       assert(!is_unsafe_anonymous(), "Unsafe anonymous classes have host klasses");
 678       return NULL;
 679     } else {
 680       assert(*hk != NULL, "host klass should always be set if the address is not null");
 681       assert(is_unsafe_anonymous(), "Only unsafe anonymous classes have host klasses");
 682       return *hk;
 683     }
 684   }
 685   void set_unsafe_anonymous_host(const InstanceKlass* host) {
 686     assert(is_unsafe_anonymous(), "not unsafe anonymous");
 687     const InstanceKlass** addr = (const InstanceKlass **)adr_unsafe_anonymous_host();
 688     assert(addr != NULL, "no reversed space");
 689     if (addr != NULL) {
 690       *addr = host;
 691     }
 692   }
 693   bool is_unsafe_anonymous() const                {
 694     return (_misc_flags & _misc_is_unsafe_anonymous) != 0;
 695   }
 696   void set_is_unsafe_anonymous(bool value)        {
 697     if (value) {
 698       _misc_flags |= _misc_is_unsafe_anonymous;
 699     } else {
 700       _misc_flags &= ~_misc_is_unsafe_anonymous;
 701     }
 702   }
 703 
 704   bool is_contended() const                {
 705     return (_misc_flags & _misc_is_contended) != 0;
 706   }
 707   void set_is_contended(bool value)        {
 708     if (value) {
 709       _misc_flags |= _misc_is_contended;
 710     } else {
 711       _misc_flags &= ~_misc_is_contended;
 712     }
 713   }
 714 
 715   // source file name
 716   Symbol* source_file_name() const               {
 717     return (_source_file_name_index == 0) ?
 718       (Symbol*)NULL : _constants->symbol_at(_source_file_name_index);
 719   }
 720   u2 source_file_name_index() const              {
 721     return _source_file_name_index;
 722   }
 723   void set_source_file_name_index(u2 sourcefile_index) {
 724     _source_file_name_index = sourcefile_index;
 725   }
 726 
 727   // minor and major version numbers of class file
 728   u2 minor_version() const                 { return _minor_version; }
 729   void set_minor_version(u2 minor_version) { _minor_version = minor_version; }
 730   u2 major_version() const                 { return _major_version; }
 731   void set_major_version(u2 major_version) { _major_version = major_version; }
 732 
 733   // source debug extension
 734   const char* source_debug_extension() const { return _source_debug_extension; }
 735   void set_source_debug_extension(const char* array, int length);
 736 
 737   // symbol unloading support (refcount already added)
 738   Symbol* array_name()                     { return _array_name; }
 739   void set_array_name(Symbol* name)        { assert(_array_name == NULL  || name == NULL, "name already created"); _array_name = name; }
 740 
 741   // nonstatic oop-map blocks
 742   static int nonstatic_oop_map_size(unsigned int oop_map_count) {
 743     return oop_map_count * OopMapBlock::size_in_words();
 744   }
 745   unsigned int nonstatic_oop_map_count() const {
 746     return _nonstatic_oop_map_size / OopMapBlock::size_in_words();
 747   }
 748   int nonstatic_oop_map_size() const { return _nonstatic_oop_map_size; }
 749   void set_nonstatic_oop_map_size(int words) {
 750     _nonstatic_oop_map_size = words;
 751   }
 752 
 753   bool has_contended_annotations() const {
 754     return ((_misc_flags & _misc_has_contended_annotations) != 0);
 755   }
 756   void set_has_contended_annotations(bool value)  {
 757     if (value) {
 758       _misc_flags |= _misc_has_contended_annotations;
 759     } else {
 760       _misc_flags &= ~_misc_has_contended_annotations;
 761     }
 762   }
 763 
 764 #if INCLUDE_JVMTI
 765   // Redefinition locking.  Class can only be redefined by one thread at a time.
 766   bool is_being_redefined() const          {
 767     return ((_misc_flags & _misc_is_being_redefined) != 0);
 768   }
 769   void set_is_being_redefined(bool value)  {
 770     if (value) {
 771       _misc_flags |= _misc_is_being_redefined;
 772     } else {
 773       _misc_flags &= ~_misc_is_being_redefined;
 774     }
 775   }
 776 
 777   // RedefineClasses() support for previous versions:
 778   void add_previous_version(InstanceKlass* ik, int emcp_method_count);
 779   void purge_previous_version_list();
 780 
 781   InstanceKlass* previous_versions() const { return _previous_versions; }
 782 #else
 783   InstanceKlass* previous_versions() const { return NULL; }
 784 #endif
 785 
 786   InstanceKlass* get_klass_version(int version) {
 787     for (InstanceKlass* ik = this; ik != NULL; ik = ik->previous_versions()) {
 788       if (ik->constants()->version() == version) {
 789         return ik;
 790       }
 791     }
 792     return NULL;
 793   }
 794 
 795   bool has_been_redefined() const {
 796     return (_misc_flags & _misc_has_been_redefined) != 0;
 797   }
 798   void set_has_been_redefined() {
 799     _misc_flags |= _misc_has_been_redefined;
 800   }
 801 
 802   bool has_passed_fingerprint_check() const {
 803     return (_misc_flags & _misc_has_passed_fingerprint_check) != 0;
 804   }
 805   void set_has_passed_fingerprint_check(bool b) {
 806     if (b) {
 807       _misc_flags |= _misc_has_passed_fingerprint_check;
 808     } else {
 809       _misc_flags &= ~_misc_has_passed_fingerprint_check;
 810     }
 811   }
 812   bool supers_have_passed_fingerprint_checks();
 813 
 814   static bool should_store_fingerprint(bool is_unsafe_anonymous);
 815   bool should_store_fingerprint() const { return should_store_fingerprint(is_unsafe_anonymous()); }
 816   bool has_stored_fingerprint() const;
 817   uint64_t get_stored_fingerprint() const;
 818   void store_fingerprint(uint64_t fingerprint);
 819 
 820   bool is_scratch_class() const {
 821     return (_misc_flags & _misc_is_scratch_class) != 0;
 822   }
 823 
 824   void set_is_scratch_class() {
 825     _misc_flags |= _misc_is_scratch_class;
 826   }
 827 
 828   bool has_resolved_methods() const {
 829     return (_misc_flags & _misc_has_resolved_methods) != 0;
 830   }
 831 
 832   void set_has_resolved_methods() {
 833     _misc_flags |= _misc_has_resolved_methods;
 834   }
 835 private:
 836 
 837   void set_kind(unsigned kind) {
 838     assert(kind <= _misc_kind_field_mask, "Invalid InstanceKlass kind");
 839     unsigned fmask = _misc_kind_field_mask << _misc_kind_field_pos;
 840     unsigned flags = _misc_flags & ~fmask;
 841     _misc_flags = (flags | (kind << _misc_kind_field_pos));
 842   }
 843 
 844   bool is_kind(unsigned desired) const {
 845     unsigned kind = (_misc_flags >> _misc_kind_field_pos) & _misc_kind_field_mask;
 846     return kind == desired;
 847   }
 848 
 849 public:
 850 
 851   // Other is anything that is not one of the more specialized kinds of InstanceKlass.
 852   bool is_other_instance_klass() const        { return is_kind(_misc_kind_other); }
 853   bool is_reference_instance_klass() const    { return is_kind(_misc_kind_reference); }
 854   bool is_mirror_instance_klass() const       { return is_kind(_misc_kind_mirror); }
 855   bool is_class_loader_instance_klass() const { return is_kind(_misc_kind_class_loader); }
 856 
 857 #if INCLUDE_JVMTI
 858 
 859   void init_previous_versions() {
 860     _previous_versions = NULL;
 861   }
 862 
 863  private:
 864   static bool  _has_previous_versions;
 865  public:
 866   static void purge_previous_versions(InstanceKlass* ik) {
 867     if (ik->has_been_redefined()) {
 868       ik->purge_previous_version_list();
 869     }
 870   }
 871 
 872   static bool has_previous_versions_and_reset();
 873   static bool has_previous_versions() { return _has_previous_versions; }
 874 
 875   // JVMTI: Support for caching a class file before it is modified by an agent that can do retransformation
 876   void set_cached_class_file(JvmtiCachedClassFileData *data) {
 877     _cached_class_file = data;
 878   }
 879   JvmtiCachedClassFileData * get_cached_class_file();
 880   jint get_cached_class_file_len();
 881   unsigned char * get_cached_class_file_bytes();
 882 
 883   // JVMTI: Support for caching of field indices, types, and offsets
 884   void set_jvmti_cached_class_field_map(JvmtiCachedClassFieldMap* descriptor) {
 885     _jvmti_cached_class_field_map = descriptor;
 886   }
 887   JvmtiCachedClassFieldMap* jvmti_cached_class_field_map() const {
 888     return _jvmti_cached_class_field_map;
 889   }
 890 #else // INCLUDE_JVMTI
 891 
 892   static void purge_previous_versions(InstanceKlass* ik) { return; };
 893   static bool has_previous_versions_and_reset() { return false; }
 894 
 895   void set_cached_class_file(JvmtiCachedClassFileData *data) {
 896     assert(data == NULL, "unexpected call with JVMTI disabled");
 897   }
 898   JvmtiCachedClassFileData * get_cached_class_file() { return (JvmtiCachedClassFileData *)NULL; }
 899 
 900 #endif // INCLUDE_JVMTI
 901 
 902   bool has_nonstatic_concrete_methods() const {
 903     return (_misc_flags & _misc_has_nonstatic_concrete_methods) != 0;
 904   }
 905   void set_has_nonstatic_concrete_methods(bool b) {
 906     if (b) {
 907       _misc_flags |= _misc_has_nonstatic_concrete_methods;
 908     } else {
 909       _misc_flags &= ~_misc_has_nonstatic_concrete_methods;
 910     }
 911   }
 912 
 913   bool declares_nonstatic_concrete_methods() const {
 914     return (_misc_flags & _misc_declares_nonstatic_concrete_methods) != 0;
 915   }
 916   void set_declares_nonstatic_concrete_methods(bool b) {
 917     if (b) {
 918       _misc_flags |= _misc_declares_nonstatic_concrete_methods;
 919     } else {
 920       _misc_flags &= ~_misc_declares_nonstatic_concrete_methods;
 921     }
 922   }
 923 
 924   // for adding methods, ConstMethod::UNSET_IDNUM means no more ids available
 925   inline u2 next_method_idnum();
 926   void set_initial_method_idnum(u2 value)             { _idnum_allocated_count = value; }
 927 
 928   // generics support
 929   Symbol* generic_signature() const                   {
 930     return (_generic_signature_index == 0) ?
 931       (Symbol*)NULL : _constants->symbol_at(_generic_signature_index);
 932   }
 933   u2 generic_signature_index() const                  {
 934     return _generic_signature_index;
 935   }
 936   void set_generic_signature_index(u2 sig_index)      {
 937     _generic_signature_index = sig_index;
 938   }
 939 
 940   u2 enclosing_method_data(int offset) const;
 941   u2 enclosing_method_class_index() const {
 942     return enclosing_method_data(enclosing_method_class_index_offset);
 943   }
 944   u2 enclosing_method_method_index() {
 945     return enclosing_method_data(enclosing_method_method_index_offset);
 946   }
 947   void set_enclosing_method_indices(u2 class_index,
 948                                     u2 method_index);
 949 
 950   // jmethodID support
 951   jmethodID get_jmethod_id(const methodHandle& method_h);
 952   jmethodID get_jmethod_id_fetch_or_update(size_t idnum,
 953                      jmethodID new_id, jmethodID* new_jmeths,
 954                      jmethodID* to_dealloc_id_p,
 955                      jmethodID** to_dealloc_jmeths_p);
 956   static void get_jmethod_id_length_value(jmethodID* cache, size_t idnum,
 957                 size_t *length_p, jmethodID* id_p);
 958   void ensure_space_for_methodids(int start_offset = 0);
 959   jmethodID jmethod_id_or_null(Method* method);
 960 
 961   // annotations support
 962   Annotations* annotations() const          { return _annotations; }
 963   void set_annotations(Annotations* anno)   { _annotations = anno; }
 964 
 965   AnnotationArray* class_annotations() const {
 966     return (_annotations != NULL) ? _annotations->class_annotations() : NULL;
 967   }
 968   Array<AnnotationArray*>* fields_annotations() const {
 969     return (_annotations != NULL) ? _annotations->fields_annotations() : NULL;
 970   }
 971   AnnotationArray* class_type_annotations() const {
 972     return (_annotations != NULL) ? _annotations->class_type_annotations() : NULL;
 973   }
 974   Array<AnnotationArray*>* fields_type_annotations() const {
 975     return (_annotations != NULL) ? _annotations->fields_type_annotations() : NULL;
 976   }
 977   // allocation
 978   instanceOop allocate_instance(TRAPS);
 979 
 980   // additional member function to return a handle
 981   instanceHandle allocate_instance_handle(TRAPS);
 982 
 983   objArrayOop allocate_objArray(int n, int length, TRAPS);
 984   // Helper function
 985   static instanceOop register_finalizer(instanceOop i, TRAPS);
 986 
 987   // Check whether reflection/jni/jvm code is allowed to instantiate this class;
 988   // if not, throw either an Error or an Exception.
 989   virtual void check_valid_for_instantiation(bool throwError, TRAPS);
 990 
 991   // initialization
 992   void call_class_initializer(TRAPS);
 993   void set_initialization_state_and_notify(ClassState state, TRAPS);
 994 
 995   // OopMapCache support
 996   OopMapCache* oop_map_cache()               { return _oop_map_cache; }
 997   void set_oop_map_cache(OopMapCache *cache) { _oop_map_cache = cache; }
 998   void mask_for(const methodHandle& method, int bci, InterpreterOopMap* entry);
 999 
1000   // JNI identifier support (for static fields - for jni performance)
1001   JNIid* jni_ids()                               { return _jni_ids; }
1002   void set_jni_ids(JNIid* ids)                   { _jni_ids = ids; }
1003   JNIid* jni_id_for(int offset);
1004 
1005   // maintenance of deoptimization dependencies
1006   inline DependencyContext dependencies();
1007   int  mark_dependent_nmethods(KlassDepChange& changes);
1008   void add_dependent_nmethod(nmethod* nm);
1009   void remove_dependent_nmethod(nmethod* nm);
1010   void clean_dependency_context();
1011 
1012   // On-stack replacement support
1013   nmethod* osr_nmethods_head() const         { return _osr_nmethods_head; };
1014   void set_osr_nmethods_head(nmethod* h)     { _osr_nmethods_head = h; };
1015   void add_osr_nmethod(nmethod* n);
1016   bool remove_osr_nmethod(nmethod* n);
1017   int mark_osr_nmethods(const Method* m);
1018   nmethod* lookup_osr_nmethod(const Method* m, int bci, int level, bool match_level) const;
1019 
1020 #if INCLUDE_JVMTI
1021   // Breakpoint support (see methods on Method* for details)
1022   BreakpointInfo* breakpoints() const       { return _breakpoints; };
1023   void set_breakpoints(BreakpointInfo* bps) { _breakpoints = bps; };
1024 #endif
1025 
1026   // support for stub routines
1027   static ByteSize init_state_offset()  { return in_ByteSize(offset_of(InstanceKlass, _init_state)); }
1028   JFR_ONLY(DEFINE_KLASS_TRACE_ID_OFFSET;)
1029   static ByteSize init_thread_offset() { return in_ByteSize(offset_of(InstanceKlass, _init_thread)); }
1030 
1031   // subclass/subinterface checks
1032   bool implements_interface(Klass* k) const;
1033   bool is_same_or_direct_interface(Klass* k) const;
1034 
1035 #ifdef ASSERT
1036   // check whether this class or one of its superclasses was redefined
1037   bool has_redefined_this_or_super() const;
1038 #endif
1039 
1040   // Access to the implementor of an interface.
1041   Klass* implementor() const;
1042   void set_implementor(Klass* k);
1043   int  nof_implementors() const;
1044   void add_implementor(Klass* k);  // k is a new class that implements this interface
1045   void init_implementor();           // initialize
1046 
1047   // link this class into the implementors list of every interface it implements
1048   void process_interfaces(Thread *thread);
1049 
1050   // virtual operations from Klass
1051   GrowableArray<Klass*>* compute_secondary_supers(int num_extra_slots,
1052                                                   Array<InstanceKlass*>* transitive_interfaces);
1053   bool can_be_primary_super_slow() const;
1054   int oop_size(oop obj)  const             { return size_helper(); }
1055   // slow because it's a virtual call and used for verifying the layout_helper.
1056   // Using the layout_helper bits, we can call is_instance_klass without a virtual call.
1057   DEBUG_ONLY(bool is_instance_klass_slow() const      { return true; })
1058 
1059   // Iterators
1060   void do_local_static_fields(FieldClosure* cl);
1061   void do_nonstatic_fields(FieldClosure* cl); // including inherited fields
1062   void do_local_static_fields(void f(fieldDescriptor*, Handle, TRAPS), Handle, TRAPS);
1063 
1064   void methods_do(void f(Method* method));
1065   void array_klasses_do(void f(Klass* k));
1066   void array_klasses_do(void f(Klass* k, TRAPS), TRAPS);
1067 
1068   static InstanceKlass* cast(Klass* k) {
1069     return const_cast<InstanceKlass*>(cast(const_cast<const Klass*>(k)));
1070   }
1071 
1072   static const InstanceKlass* cast(const Klass* k) {
1073     assert(k != NULL, "k should not be null");
1074     assert(k->is_instance_klass(), "cast to InstanceKlass");
1075     return static_cast<const InstanceKlass*>(k);
1076   }
1077 
1078   virtual InstanceKlass* java_super() const {
1079     return (super() == NULL) ? NULL : cast(super());
1080   }
1081 
1082   // Sizing (in words)
1083   static int header_size()            { return sizeof(InstanceKlass)/wordSize; }
1084 
1085   static int size(int vtable_length, int itable_length,
1086                   int nonstatic_oop_map_size,
1087                   bool is_interface, bool is_unsafe_anonymous, bool has_stored_fingerprint) {
1088     return align_metadata_size(header_size() +
1089            vtable_length +
1090            itable_length +
1091            nonstatic_oop_map_size +
1092            (is_interface ? (int)sizeof(Klass*)/wordSize : 0) +
1093            (is_unsafe_anonymous ? (int)sizeof(Klass*)/wordSize : 0) +
1094            (has_stored_fingerprint ? (int)sizeof(uint64_t*)/wordSize : 0));
1095   }
1096   int size() const                    { return size(vtable_length(),
1097                                                itable_length(),
1098                                                nonstatic_oop_map_size(),
1099                                                is_interface(),
1100                                                is_unsafe_anonymous(),
1101                                                has_stored_fingerprint());
1102   }
1103 
1104   intptr_t* start_of_itable()   const { return (intptr_t*)start_of_vtable() + vtable_length(); }
1105   intptr_t* end_of_itable()     const { return start_of_itable() + itable_length(); }
1106 
1107   int  itable_offset_in_words() const { return start_of_itable() - (intptr_t*)this; }
1108 
1109   oop static_field_base_raw() { return java_mirror(); }
1110 
1111   OopMapBlock* start_of_nonstatic_oop_maps() const {
1112     return (OopMapBlock*)(start_of_itable() + itable_length());
1113   }
1114 
1115   Klass** end_of_nonstatic_oop_maps() const {
1116     return (Klass**)(start_of_nonstatic_oop_maps() +
1117                      nonstatic_oop_map_count());
1118   }
1119 
1120   Klass* volatile* adr_implementor() const {
1121     if (is_interface()) {
1122       return (Klass* volatile*)end_of_nonstatic_oop_maps();
1123     } else {
1124       return NULL;
1125     }
1126   };
1127 
1128   InstanceKlass** adr_unsafe_anonymous_host() const {
1129     if (is_unsafe_anonymous()) {
1130       InstanceKlass** adr_impl = (InstanceKlass**)adr_implementor();
1131       if (adr_impl != NULL) {
1132         return adr_impl + 1;
1133       } else {
1134         return (InstanceKlass **)end_of_nonstatic_oop_maps();
1135       }
1136     } else {
1137       return NULL;
1138     }
1139   }
1140 
1141   address adr_fingerprint() const {
1142     if (has_stored_fingerprint()) {
1143       InstanceKlass** adr_host = adr_unsafe_anonymous_host();
1144       if (adr_host != NULL) {
1145         return (address)(adr_host + 1);
1146       }
1147 
1148       Klass* volatile* adr_impl = adr_implementor();
1149       if (adr_impl != NULL) {
1150         return (address)(adr_impl + 1);
1151       }
1152 
1153       return (address)end_of_nonstatic_oop_maps();
1154     } else {
1155       return NULL;
1156     }
1157   }
1158 
1159   // Use this to return the size of an instance in heap words:
1160   int size_helper() const {
1161     return layout_helper_to_size_helper(layout_helper());
1162   }
1163 
1164   // This bit is initialized in classFileParser.cpp.
1165   // It is false under any of the following conditions:
1166   //  - the class is abstract (including any interface)
1167   //  - the class has a finalizer (if !RegisterFinalizersAtInit)
1168   //  - the class size is larger than FastAllocateSizeLimit
1169   //  - the class is java/lang/Class, which cannot be allocated directly
1170   bool can_be_fastpath_allocated() const {
1171     return !layout_helper_needs_slow_path(layout_helper());
1172   }
1173 
1174   // Java itable
1175   klassItable itable() const;        // return klassItable wrapper
1176   Method* method_at_itable(Klass* holder, int index, TRAPS);
1177 
1178 #if INCLUDE_JVMTI
1179   void adjust_default_methods(bool* trace_name_printed);
1180 #endif // INCLUDE_JVMTI
1181 
1182   void clean_weak_instanceklass_links();
1183  private:
1184   void clean_implementors_list();
1185   void clean_method_data();
1186 
1187  public:
1188   // Explicit metaspace deallocation of fields
1189   // For RedefineClasses and class file parsing errors, we need to deallocate
1190   // instanceKlasses and the metadata they point to.
1191   void deallocate_contents(ClassLoaderData* loader_data);
1192   static void deallocate_methods(ClassLoaderData* loader_data,
1193                                  Array<Method*>* methods);
1194   void static deallocate_interfaces(ClassLoaderData* loader_data,
1195                                     const Klass* super_klass,
1196                                     Array<InstanceKlass*>* local_interfaces,
1197                                     Array<InstanceKlass*>* transitive_interfaces);
1198   void static deallocate_record_components(ClassLoaderData* loader_data,
1199                                            Array<RecordComponent*>* record_component);
1200 
1201   // The constant pool is on stack if any of the methods are executing or
1202   // referenced by handles.
1203   bool on_stack() const { return _constants->on_stack(); }
1204 
1205   // callbacks for actions during class unloading
1206   static void unload_class(InstanceKlass* ik);
1207   static void release_C_heap_structures(InstanceKlass* ik);
1208 
1209   // Naming
1210   const char* signature_name() const;
1211   static Symbol* package_from_name(const Symbol* name, TRAPS);
1212 
1213   // Oop fields (and metadata) iterators
1214   //
1215   // The InstanceKlass iterators also visits the Object's klass.
1216 
1217   // Forward iteration
1218  public:
1219   // Iterate over all oop fields in the oop maps.
1220   template <typename T, class OopClosureType>
1221   inline void oop_oop_iterate_oop_maps(oop obj, OopClosureType* closure);
1222 
1223   // Iterate over all oop fields and metadata.
1224   template <typename T, class OopClosureType>
1225   inline void oop_oop_iterate(oop obj, OopClosureType* closure);
1226 
1227   // Iterate over all oop fields in one oop map.
1228   template <typename T, class OopClosureType>
1229   inline void oop_oop_iterate_oop_map(OopMapBlock* map, oop obj, OopClosureType* closure);
1230 
1231 
1232   // Reverse iteration
1233   // Iterate over all oop fields and metadata.
1234   template <typename T, class OopClosureType>
1235   inline void oop_oop_iterate_reverse(oop obj, OopClosureType* closure);
1236 
1237  private:
1238   // Iterate over all oop fields in the oop maps.
1239   template <typename T, class OopClosureType>
1240   inline void oop_oop_iterate_oop_maps_reverse(oop obj, OopClosureType* closure);
1241 
1242   // Iterate over all oop fields in one oop map.
1243   template <typename T, class OopClosureType>
1244   inline void oop_oop_iterate_oop_map_reverse(OopMapBlock* map, oop obj, OopClosureType* closure);
1245 
1246 
1247   // Bounded range iteration
1248  public:
1249   // Iterate over all oop fields in the oop maps.
1250   template <typename T, class OopClosureType>
1251   inline void oop_oop_iterate_oop_maps_bounded(oop obj, OopClosureType* closure, MemRegion mr);
1252 
1253   // Iterate over all oop fields and metadata.
1254   template <typename T, class OopClosureType>
1255   inline void oop_oop_iterate_bounded(oop obj, OopClosureType* closure, MemRegion mr);
1256 
1257  private:
1258   // Iterate over all oop fields in one oop map.
1259   template <typename T, class OopClosureType>
1260   inline void oop_oop_iterate_oop_map_bounded(OopMapBlock* map, oop obj, OopClosureType* closure, MemRegion mr);
1261 
1262 
1263  public:
1264   u2 idnum_allocated_count() const      { return _idnum_allocated_count; }
1265 
1266 public:
1267   void set_in_error_state() {
1268     assert(DumpSharedSpaces, "only call this when dumping archive");
1269     _init_state = initialization_error;
1270   }
1271   bool check_sharing_error_state();
1272 
1273 private:
1274   // initialization state
1275   void set_init_state(ClassState state);
1276   void set_rewritten()                  { _misc_flags |= _misc_rewritten; }
1277   void set_init_thread(Thread *thread)  { _init_thread = thread; }
1278 
1279   // The RedefineClasses() API can cause new method idnums to be needed
1280   // which will cause the caches to grow. Safety requires different
1281   // cache management logic if the caches can grow instead of just
1282   // going from NULL to non-NULL.
1283   bool idnum_can_increment() const      { return has_been_redefined(); }
1284   inline jmethodID* methods_jmethod_ids_acquire() const;
1285   inline void release_set_methods_jmethod_ids(jmethodID* jmeths);
1286 
1287   // Lock during initialization
1288 public:
1289   // Lock for (1) initialization; (2) access to the ConstantPool of this class.
1290   // Must be one per class and it has to be a VM internal object so java code
1291   // cannot lock it (like the mirror).
1292   // It has to be an object not a Mutex because it's held through java calls.
1293   oop init_lock() const;
1294 private:
1295   void fence_and_clear_init_lock();
1296 
1297   bool link_class_impl                           (TRAPS);
1298   bool verify_code                               (TRAPS);
1299   void initialize_impl                           (TRAPS);
1300   void initialize_super_interfaces               (TRAPS);
1301   void eager_initialize_impl                     ();
1302   /* jni_id_for_impl for jfieldID only */
1303   JNIid* jni_id_for_impl                         (int offset);
1304 
1305   // Returns the array class for the n'th dimension
1306   Klass* array_klass_impl(bool or_null, int n, TRAPS);
1307 
1308   // Returns the array class with this class as element type
1309   Klass* array_klass_impl(bool or_null, TRAPS);
1310 
1311   // find a local method (returns NULL if not found)
1312   Method* find_method_impl(const Symbol* name,
1313                            const Symbol* signature,
1314                            OverpassLookupMode overpass_mode,
1315                            StaticLookupMode static_mode,
1316                            PrivateLookupMode private_mode) const;
1317 
1318   static Method* find_method_impl(const Array<Method*>* methods,
1319                                   const Symbol* name,
1320                                   const Symbol* signature,
1321                                   OverpassLookupMode overpass_mode,
1322                                   StaticLookupMode static_mode,
1323                                   PrivateLookupMode private_mode);
1324 
1325   // Free CHeap allocated fields.
1326   void release_C_heap_structures();
1327 
1328 #if INCLUDE_JVMTI
1329   // RedefineClasses support
1330   void link_previous_versions(InstanceKlass* pv) { _previous_versions = pv; }
1331   void mark_newly_obsolete_methods(Array<Method*>* old_methods, int emcp_method_count);
1332 #endif
1333 public:
1334   // CDS support - remove and restore oops from metadata. Oops are not shared.
1335   virtual void remove_unshareable_info();
1336   virtual void remove_java_mirror();
1337   virtual void restore_unshareable_info(ClassLoaderData* loader_data, Handle protection_domain, TRAPS);
1338 
1339   // jvm support
1340   jint compute_modifier_flags(TRAPS) const;
1341 
1342 public:
1343   // JVMTI support
1344   jint jvmti_class_status() const;
1345 
1346   virtual void metaspace_pointers_do(MetaspaceClosure* iter);
1347 
1348  public:
1349   // Printing
1350 #ifndef PRODUCT
1351   void print_on(outputStream* st) const;
1352 #endif
1353   void print_value_on(outputStream* st) const;
1354 
1355   void oop_print_value_on(oop obj, outputStream* st);
1356 
1357 #ifndef PRODUCT
1358   void oop_print_on      (oop obj, outputStream* st);
1359 
1360   void print_dependent_nmethods(bool verbose = false);
1361   bool is_dependent_nmethod(nmethod* nm);
1362   bool verify_itable_index(int index);
1363 #endif
1364 
1365   const char* internal_name() const;
1366 
1367   // Verification
1368   void verify_on(outputStream* st);
1369 
1370   void oop_verify_on(oop obj, outputStream* st);
1371 
1372   // Logging
1373   void print_class_load_logging(ClassLoaderData* loader_data,
1374                                 const char* module_name,
1375                                 const ClassFileStream* cfs) const;
1376 };
1377 
1378 // for adding methods
1379 // UNSET_IDNUM return means no more ids available
1380 inline u2 InstanceKlass::next_method_idnum() {
1381   if (_idnum_allocated_count == ConstMethod::MAX_IDNUM) {
1382     return ConstMethod::UNSET_IDNUM; // no more ids available
1383   } else {
1384     return _idnum_allocated_count++;
1385   }
1386 }
1387 
1388 
1389 /* JNIid class for jfieldIDs only */
1390 class JNIid: public CHeapObj<mtClass> {
1391   friend class VMStructs;
1392  private:
1393   Klass*             _holder;
1394   JNIid*             _next;
1395   int                _offset;
1396 #ifdef ASSERT
1397   bool               _is_static_field_id;
1398 #endif
1399 
1400  public:
1401   // Accessors
1402   Klass* holder() const           { return _holder; }
1403   int offset() const              { return _offset; }
1404   JNIid* next()                   { return _next; }
1405   // Constructor
1406   JNIid(Klass* holder, int offset, JNIid* next);
1407   // Identifier lookup
1408   JNIid* find(int offset);
1409 
1410   bool find_local_field(fieldDescriptor* fd) {
1411     return InstanceKlass::cast(holder())->find_local_field_from_offset(offset(), true, fd);
1412   }
1413 
1414   static void deallocate(JNIid* id);
1415   // Debugging
1416 #ifdef ASSERT
1417   bool is_static_field_id() const { return _is_static_field_id; }
1418   void set_is_static_field_id()   { _is_static_field_id = true; }
1419 #endif
1420   void verify(Klass* holder);
1421 };
1422 
1423 // An iterator that's used to access the inner classes indices in the
1424 // InstanceKlass::_inner_classes array.
1425 class InnerClassesIterator : public StackObj {
1426  private:
1427   Array<jushort>* _inner_classes;
1428   int _length;
1429   int _idx;
1430  public:
1431 
1432   InnerClassesIterator(const InstanceKlass* k) {
1433     _inner_classes = k->inner_classes();
1434     if (k->inner_classes() != NULL) {
1435       _length = _inner_classes->length();
1436       // The inner class array's length should be the multiple of
1437       // inner_class_next_offset if it only contains the InnerClasses
1438       // attribute data, or it should be
1439       // n*inner_class_next_offset+enclosing_method_attribute_size
1440       // if it also contains the EnclosingMethod data.
1441       assert((_length % InstanceKlass::inner_class_next_offset == 0 ||
1442               _length % InstanceKlass::inner_class_next_offset == InstanceKlass::enclosing_method_attribute_size),
1443              "just checking");
1444       // Remove the enclosing_method portion if exists.
1445       if (_length % InstanceKlass::inner_class_next_offset == InstanceKlass::enclosing_method_attribute_size) {
1446         _length -= InstanceKlass::enclosing_method_attribute_size;
1447       }
1448     } else {
1449       _length = 0;
1450     }
1451     _idx = 0;
1452   }
1453 
1454   int length() const {
1455     return _length;
1456   }
1457 
1458   void next() {
1459     _idx += InstanceKlass::inner_class_next_offset;
1460   }
1461 
1462   bool done() const {
1463     return (_idx >= _length);
1464   }
1465 
1466   u2 inner_class_info_index() const {
1467     return _inner_classes->at(
1468                _idx + InstanceKlass::inner_class_inner_class_info_offset);
1469   }
1470 
1471   void set_inner_class_info_index(u2 index) {
1472     _inner_classes->at_put(
1473                _idx + InstanceKlass::inner_class_inner_class_info_offset, index);
1474   }
1475 
1476   u2 outer_class_info_index() const {
1477     return _inner_classes->at(
1478                _idx + InstanceKlass::inner_class_outer_class_info_offset);
1479   }
1480 
1481   void set_outer_class_info_index(u2 index) {
1482     _inner_classes->at_put(
1483                _idx + InstanceKlass::inner_class_outer_class_info_offset, index);
1484   }
1485 
1486   u2 inner_name_index() const {
1487     return _inner_classes->at(
1488                _idx + InstanceKlass::inner_class_inner_name_offset);
1489   }
1490 
1491   void set_inner_name_index(u2 index) {
1492     _inner_classes->at_put(
1493                _idx + InstanceKlass::inner_class_inner_name_offset, index);
1494   }
1495 
1496   u2 inner_access_flags() const {
1497     return _inner_classes->at(
1498                _idx + InstanceKlass::inner_class_access_flags_offset);
1499   }
1500 };
1501 
1502 #endif // SHARE_OOPS_INSTANCEKLASS_HPP