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