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