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