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