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