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