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