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