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