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