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