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