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   };
 262 
 263  protected:
 264   u1              _extra_flags;
 265 
 266   // The low three bits of _misc_flags contains the kind field.
 267   // This can be used to quickly discriminate among the five kinds of
 268   // InstanceKlass.
 269 
 270   static const unsigned _misc_kind_field_size = 3;
 271   static const unsigned _misc_kind_field_pos  = 0;
 272   static const unsigned _misc_kind_field_mask = (1u << _misc_kind_field_size) - 1u;
 273 
 274   static const unsigned _misc_kind_other        = 0; // concrete InstanceKlass
 275   static const unsigned _misc_kind_reference    = 1; // InstanceRefKlass
 276   static const unsigned _misc_kind_class_loader = 2; // InstanceClassLoaderKlass
 277   static const unsigned _misc_kind_mirror       = 3; // InstanceMirrorKlass
 278   static const unsigned _misc_kind_value_type   = 4; // ValueKlass
 279 
 280   // Start after _misc_kind field.
 281   enum {
 282     _misc_rewritten                           = 1 << 3,  // methods rewritten.
 283     _misc_has_nonstatic_fields                = 1 << 4,  // for sizing with UseCompressedOops
 284     _misc_should_verify_class                 = 1 << 5,  // allow caching of preverification
 285     _misc_is_unsafe_anonymous                 = 1 << 6,  // has embedded _unsafe_anonymous_host field
 286     _misc_is_contended                        = 1 << 7,  // marked with contended annotation
 287     _misc_has_nonstatic_concrete_methods      = 1 << 8,  // class/superclass/implemented interfaces has non-static, concrete methods
 288     _misc_declares_nonstatic_concrete_methods = 1 << 9,  // directly declares non-static, concrete methods
 289     _misc_has_been_redefined                  = 1 << 10,  // class has been redefined
 290     _misc_has_passed_fingerprint_check        = 1 << 11, // when this class was loaded, the fingerprint computed from its
 291                                                          // code source was found to be matching the value recorded by AOT.
 292     _misc_is_scratch_class                    = 1 << 12, // class is the redefined scratch class
 293     _misc_is_shared_boot_class                = 1 << 13, // defining class loader is boot class loader
 294     _misc_is_shared_platform_class            = 1 << 14, // defining class loader is platform class loader
 295     _misc_is_shared_app_class                 = 1 << 15  // defining class loader is app class loader
 296     // u2 _misc_flags full (see _extra_flags)
 297   };
 298   u2 loader_type_bits() {
 299     return _misc_is_shared_boot_class|_misc_is_shared_platform_class|_misc_is_shared_app_class;
 300   }
 301   u2              _misc_flags;
 302   u2              _minor_version;        // minor version number of class file
 303   u2              _major_version;        // major version number of class file
 304   Thread*         _init_thread;          // Pointer to current thread doing initialization (to handle recursive initialization)
 305   OopMapCache*    volatile _oop_map_cache;   // OopMapCache for all methods in the klass (allocated lazily)
 306   JNIid*          _jni_ids;              // First JNI identifier for static fields in this class
 307   jmethodID*      volatile _methods_jmethod_ids;  // jmethodIDs corresponding to method_idnum, or NULL if none
 308   nmethodBucket*  volatile _dep_context;          // packed DependencyContext structure
 309   uint64_t        volatile _dep_context_last_cleaned;
 310   nmethod*        _osr_nmethods_head;    // Head of list of on-stack replacement nmethods for this class
 311 #if INCLUDE_JVMTI
 312   BreakpointInfo* _breakpoints;          // bpt lists, managed by Method*
 313   // Linked instanceKlasses of previous versions
 314   InstanceKlass* _previous_versions;
 315   // JVMTI fields can be moved to their own structure - see 6315920
 316   // JVMTI: cached class file, before retransformable agent modified it in CFLH
 317   JvmtiCachedClassFileData* _cached_class_file;
 318 #endif
 319 
 320   volatile u2     _idnum_allocated_count;         // JNI/JVMTI: increments with the addition of methods, old ids don't change
 321 
 322   // Class states are defined as ClassState (see above).
 323   // Place the _init_state here to utilize the unused 2-byte after
 324   // _idnum_allocated_count.
 325   u1              _init_state;                    // state of class
 326   u1              _reference_type;                // reference type
 327 
 328   u2              _this_class_index;              // constant pool entry
 329 #if INCLUDE_JVMTI
 330   JvmtiCachedClassFieldMap* _jvmti_cached_class_field_map;  // JVMTI: used during heap iteration
 331 #endif
 332 
 333   NOT_PRODUCT(int _verify_count;)  // to avoid redundant verifies
 334 
 335   // Method array.
 336   Array<Method*>* _methods;
 337   // Default Method Array, concrete methods inherited from interfaces
 338   Array<Method*>* _default_methods;
 339   // Interfaces (InstanceKlass*s) this class declares locally to implement.
 340   Array<InstanceKlass*>* _local_interfaces;
 341   // Interfaces (InstanceKlass*s) this class implements transitively.
 342   Array<InstanceKlass*>* _transitive_interfaces;
 343   // Int array containing the original order of method in the class file (for JVMTI).
 344   Array<int>*     _method_ordering;
 345   // Int array containing the vtable_indices for default_methods
 346   // offset matches _default_methods offset
 347   Array<int>*     _default_vtable_indices;
 348 
 349   // Instance and static variable information, starts with 6-tuples of shorts
 350   // [access, name index, sig index, initval index, low_offset, high_offset]
 351   // for all fields, followed by the generic signature data at the end of
 352   // the array. Only fields with generic signature attributes have the generic
 353   // signature data set in the array. The fields array looks like following:
 354   //
 355   // f1: [access, name index, sig index, initial value index, low_offset, high_offset]
 356   // f2: [access, name index, sig index, initial value index, low_offset, high_offset]
 357   //      ...
 358   // fn: [access, name index, sig index, initial value index, low_offset, high_offset]
 359   //     [generic signature index]
 360   //     [generic signature index]
 361   //     ...
 362   Array<u2>*      _fields;
 363 
 364   const ValueKlassFixedBlock* _adr_valueklass_fixed_block;
 365 
 366   // embedded Java vtable follows here
 367   // embedded Java itables follows here
 368   // embedded static fields follows here
 369   // embedded nonstatic oop-map blocks follows here
 370   // embedded implementor of this interface follows here
 371   //   The embedded implementor only exists if the current klass is an
 372   //   iterface. The possible values of the implementor fall into following
 373   //   three cases:
 374   //     NULL: no implementor.
 375   //     A Klass* that's not itself: one implementor.
 376   //     Itself: more than one implementors.
 377   // embedded unsafe_anonymous_host klass follows here
 378   //   The embedded host klass only exists in an unsafe anonymous class for
 379   //   dynamic language support (JSR 292 enabled). The host class grants
 380   //   its access privileges to this class also. The host class is either
 381   //   named, or a previously loaded unsafe anonymous class. A non-anonymous class
 382   //   or an anonymous class loaded through normal classloading does not
 383   //   have this embedded field.
 384   //
 385 
 386   friend class SystemDictionary;
 387 
 388  public:
 389   u2 loader_type() {
 390     return _misc_flags & loader_type_bits();
 391   }
 392 
 393   bool is_shared_boot_class() const {
 394     return (_misc_flags & _misc_is_shared_boot_class) != 0;
 395   }
 396   bool is_shared_platform_class() const {
 397     return (_misc_flags & _misc_is_shared_platform_class) != 0;
 398   }
 399   bool is_shared_app_class() const {
 400     return (_misc_flags & _misc_is_shared_app_class) != 0;
 401   }
 402 
 403   void clear_class_loader_type() {
 404     _misc_flags &= ~loader_type_bits();
 405   }
 406 
 407   void set_class_loader_type(s2 loader_type);
 408 
 409   bool has_nonstatic_fields() const        {
 410     return (_misc_flags & _misc_has_nonstatic_fields) != 0;
 411   }
 412   void set_has_nonstatic_fields(bool b)    {
 413     if (b) {
 414       _misc_flags |= _misc_has_nonstatic_fields;
 415     } else {
 416       _misc_flags &= ~_misc_has_nonstatic_fields;
 417     }
 418   }
 419 
 420   bool has_value_fields() const          {
 421     return (_extra_flags & _extra_has_value_fields) != 0;
 422   }
 423   void set_has_value_fields()  {
 424     _extra_flags |= _extra_has_value_fields;
 425   }
 426 







 427   // field sizes
 428   int nonstatic_field_size() const         { return _nonstatic_field_size; }
 429   void set_nonstatic_field_size(int size)  { _nonstatic_field_size = size; }
 430 
 431   int static_field_size() const            { return _static_field_size; }
 432   void set_static_field_size(int size)     { _static_field_size = size; }
 433 
 434   int static_oop_field_count() const       { return (int)_static_oop_field_count; }
 435   void set_static_oop_field_count(u2 size) { _static_oop_field_count = size; }
 436 
 437   // Java itable
 438   int  itable_length() const               { return _itable_len; }
 439   void set_itable_length(int len)          { _itable_len = len; }
 440 
 441   // array klasses
 442   Klass* array_klasses() const             { return _array_klasses; }
 443   inline Klass* array_klasses_acquire() const; // load with acquire semantics
 444   void set_array_klasses(Klass* k)         { _array_klasses = k; }
 445   inline void release_set_array_klasses(Klass* k); // store with release semantics
 446 
 447   // methods
 448   Array<Method*>* methods() const          { return _methods; }
 449   void set_methods(Array<Method*>* a)      { _methods = a; }
 450   Method* method_with_idnum(int idnum);
 451   Method* method_with_orig_idnum(int idnum);
 452   Method* method_with_orig_idnum(int idnum, int version);
 453 
 454   // method ordering
 455   Array<int>* method_ordering() const     { return _method_ordering; }
 456   void set_method_ordering(Array<int>* m) { _method_ordering = m; }
 457   void copy_method_ordering(const intArray* m, TRAPS);
 458 
 459   // default_methods
 460   Array<Method*>* default_methods() const  { return _default_methods; }
 461   void set_default_methods(Array<Method*>* a) { _default_methods = a; }
 462 
 463   // default method vtable_indices
 464   Array<int>* default_vtable_indices() const { return _default_vtable_indices; }
 465   void set_default_vtable_indices(Array<int>* v) { _default_vtable_indices = v; }
 466   Array<int>* create_new_default_vtable_indices(int len, TRAPS);
 467 
 468   // interfaces
 469   Array<InstanceKlass*>* local_interfaces() const          { return _local_interfaces; }
 470   void set_local_interfaces(Array<InstanceKlass*>* a)      {
 471     guarantee(_local_interfaces == NULL || a == NULL, "Just checking");
 472     _local_interfaces = a; }
 473 
 474   Array<InstanceKlass*>* transitive_interfaces() const     { return _transitive_interfaces; }
 475   void set_transitive_interfaces(Array<InstanceKlass*>* a) {
 476     guarantee(_transitive_interfaces == NULL || a == NULL, "Just checking");
 477     _transitive_interfaces = a;
 478   }
 479 
 480  private:
 481   friend class fieldDescriptor;
 482   FieldInfo* field(int index) const { return FieldInfo::from_field_array(_fields, index); }
 483 
 484  public:
 485   int     field_offset      (int index) const { return field(index)->offset(); }
 486   int     field_access_flags(int index) const { return field(index)->access_flags(); }
 487   Symbol* field_name        (int index) const { return field(index)->name(constants()); }
 488   Symbol* field_signature   (int index) const { return field(index)->signature(constants()); }
 489   bool    field_is_flattened(int index) const { return field(index)->is_flattened(); }
 490   bool    field_is_flattenable(int index) const { return field(index)->is_flattenable(); }
 491 
 492   // Number of Java declared fields
 493   int java_fields_count() const           { return (int)_java_fields_count; }
 494 
 495   Array<u2>* fields() const            { return _fields; }
 496   void set_fields(Array<u2>* f, u2 java_fields_count) {
 497     guarantee(_fields == NULL || f == NULL, "Just checking");
 498     _fields = f;
 499     _java_fields_count = java_fields_count;
 500   }
 501 
 502   // inner classes
 503   Array<u2>* inner_classes() const       { return _inner_classes; }
 504   void set_inner_classes(Array<u2>* f)   { _inner_classes = f; }
 505 
 506   // nest members
 507   Array<u2>* nest_members() const     { return _nest_members; }
 508   void set_nest_members(Array<u2>* m) { _nest_members = m; }
 509 
 510   // nest-host index
 511   jushort nest_host_index() const { return _nest_host_index; }
 512   void set_nest_host_index(u2 i)  { _nest_host_index = i; }
 513 
 514 private:
 515   // Called to verify that k is a member of this nest - does not look at k's nest-host
 516   bool has_nest_member(InstanceKlass* k, TRAPS) const;
 517 public:
 518   // Returns nest-host class, resolving and validating it if needed
 519   // Returns NULL if an exception occurs during loading, or validation fails
 520   InstanceKlass* nest_host(Symbol* validationException, TRAPS);
 521   // Check if this klass is a nestmate of k - resolves this nest-host and k's
 522   bool has_nestmate_access_to(InstanceKlass* k, TRAPS);
 523 
 524   enum InnerClassAttributeOffset {
 525     // From http://mirror.eng/products/jdk/1.1/docs/guide/innerclasses/spec/innerclasses.doc10.html#18814
 526     inner_class_inner_class_info_offset = 0,
 527     inner_class_outer_class_info_offset = 1,
 528     inner_class_inner_name_offset = 2,
 529     inner_class_access_flags_offset = 3,
 530     inner_class_next_offset = 4
 531   };
 532 
 533   enum EnclosingMethodAttributeOffset {
 534     enclosing_method_class_index_offset = 0,
 535     enclosing_method_method_index_offset = 1,
 536     enclosing_method_attribute_size = 2
 537   };
 538 
 539   // method override check
 540   bool is_override(const methodHandle& super_method, Handle targetclassloader, Symbol* targetclassname, TRAPS);
 541 
 542   // package
 543   PackageEntry* package() const     { return _package_entry; }
 544   ModuleEntry* module() const;
 545   bool in_unnamed_package() const   { return (_package_entry == NULL); }
 546   void set_package(PackageEntry* p) { _package_entry = p; }
 547   void set_package(ClassLoaderData* loader_data, TRAPS);
 548   bool is_same_class_package(const Klass* class2) const;
 549   bool is_same_class_package(oop other_class_loader, const Symbol* other_class_name) const;
 550 
 551   // find an enclosing class
 552   InstanceKlass* compute_enclosing_class(bool* inner_is_member, TRAPS) const;
 553 
 554   // Find InnerClasses attribute and return outer_class_info_index & inner_name_index.
 555   bool find_inner_classes_attr(int* ooff, int* noff, TRAPS) const;
 556 
 557  private:
 558   // Check prohibited package ("java/" only loadable by boot or platform loaders)
 559   static void check_prohibited_package(Symbol* class_name,
 560                                        ClassLoaderData* loader_data,
 561                                        TRAPS);
 562  public:
 563   // initialization state
 564   bool is_loaded() const                   { return _init_state >= loaded; }
 565   bool is_linked() const                   { return _init_state >= linked; }
 566   bool is_initialized() const              { return _init_state == fully_initialized; }
 567   bool is_not_initialized() const          { return _init_state <  being_initialized; }
 568   bool is_being_initialized() const        { return _init_state == being_initialized; }
 569   bool is_in_error_state() const           { return _init_state == initialization_error; }
 570   bool is_reentrant_initialization(Thread *thread)  { return thread == _init_thread; }
 571   ClassState  init_state()                 { return (ClassState)_init_state; }
 572   bool is_rewritten() const                { return (_misc_flags & _misc_rewritten) != 0; }
 573 
 574   // defineClass specified verification
 575   bool should_verify_class() const         {
 576     return (_misc_flags & _misc_should_verify_class) != 0;
 577   }
 578   void set_should_verify_class(bool value) {
 579     if (value) {
 580       _misc_flags |= _misc_should_verify_class;
 581     } else {
 582       _misc_flags &= ~_misc_should_verify_class;
 583     }
 584   }
 585 
 586   // marking
 587   bool is_marked_dependent() const         { return _is_marked_dependent; }
 588   void set_is_marked_dependent(bool value) { _is_marked_dependent = value; }
 589 
 590   static ByteSize extra_flags_offset() { return in_ByteSize(offset_of(InstanceKlass, _extra_flags)); }
 591 
 592   // initialization (virtuals from Klass)
 593   bool should_be_initialized() const;  // means that initialize should be called
 594   void initialize(TRAPS);
 595   void link_class(TRAPS);
 596   bool link_class_or_fail(TRAPS); // returns false on failure
 597   void rewrite_class(TRAPS);
 598   void link_methods(TRAPS);
 599   Method* class_initializer() const;
 600 
 601   // set the class to initialized if no static initializer is present
 602   void eager_initialize(Thread *thread);
 603 
 604   // reference type
 605   ReferenceType reference_type() const     { return (ReferenceType)_reference_type; }
 606   void set_reference_type(ReferenceType t) {
 607     assert(t == (u1)t, "overflow");
 608     _reference_type = (u1)t;
 609   }
 610 
 611   // this class cp index
 612   u2 this_class_index() const             { return _this_class_index; }
 613   void set_this_class_index(u2 index)     { _this_class_index = index; }
 614 
 615   static ByteSize reference_type_offset() { return in_ByteSize(offset_of(InstanceKlass, _reference_type)); }
 616 
 617   // find local field, returns true if found
 618   bool find_local_field(Symbol* name, Symbol* sig, fieldDescriptor* fd) const;
 619   // find field in direct superinterfaces, returns the interface in which the field is defined
 620   Klass* find_interface_field(Symbol* name, Symbol* sig, fieldDescriptor* fd) const;
 621   // find field according to JVM spec 5.4.3.2, returns the klass in which the field is defined
 622   Klass* find_field(Symbol* name, Symbol* sig, fieldDescriptor* fd) const;
 623   // find instance or static fields according to JVM spec 5.4.3.2, returns the klass in which the field is defined
 624   Klass* find_field(Symbol* name, Symbol* sig, bool is_static, fieldDescriptor* fd) const;
 625 
 626   // find a non-static or static field given its offset within the class.
 627   bool contains_field_offset(int offset) {
 628     return instanceOopDesc::contains_field_offset(offset, nonstatic_field_size(), is_value());
 629   }
 630 
 631   bool find_local_field_from_offset(int offset, bool is_static, fieldDescriptor* fd) const;
 632   bool find_field_from_offset(int offset, bool is_static, fieldDescriptor* fd) const;
 633 
 634   // find a local method (returns NULL if not found)
 635   Method* find_method(const Symbol* name, const Symbol* signature) const;
 636   static Method* find_method(const Array<Method*>* methods,
 637                              const Symbol* name,
 638                              const Symbol* signature);
 639 
 640   // find a local method, but skip static methods
 641   Method* find_instance_method(const Symbol* name, const Symbol* signature,
 642                                PrivateLookupMode private_mode = find_private) const;
 643   static Method* find_instance_method(const Array<Method*>* methods,
 644                                       const Symbol* name,
 645                                       const Symbol* signature,
 646                                       PrivateLookupMode private_mode = find_private);
 647 
 648   // find a local method (returns NULL if not found)
 649   Method* find_local_method(const Symbol* name,
 650                             const Symbol* signature,
 651                             OverpassLookupMode overpass_mode,
 652                             StaticLookupMode static_mode,
 653                             PrivateLookupMode private_mode) const;
 654 
 655   // find a local method from given methods array (returns NULL if not found)
 656   static Method* find_local_method(const Array<Method*>* methods,
 657                                    const Symbol* name,
 658                                    const Symbol* signature,
 659                                    OverpassLookupMode overpass_mode,
 660                                    StaticLookupMode static_mode,
 661                                    PrivateLookupMode private_mode);
 662 
 663   // find a local method index in methods or default_methods (returns -1 if not found)
 664   static int find_method_index(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   // lookup operation (returns NULL if not found)
 672   Method* uncached_lookup_method(const Symbol* name,
 673                                  const Symbol* signature,
 674                                  OverpassLookupMode overpass_mode,
 675                                  PrivateLookupMode private_mode = find_private) const;
 676 
 677   // lookup a method in all the interfaces that this class implements
 678   // (returns NULL if not found)
 679   Method* lookup_method_in_all_interfaces(Symbol* name, Symbol* signature, DefaultsLookupMode defaults_mode) const;
 680 
 681   // lookup a method in local defaults then in all interfaces
 682   // (returns NULL if not found)
 683   Method* lookup_method_in_ordered_interfaces(Symbol* name, Symbol* signature) const;
 684 
 685   // Find method indices by name.  If a method with the specified name is
 686   // found the index to the first method is returned, and 'end' is filled in
 687   // with the index of first non-name-matching method.  If no method is found
 688   // -1 is returned.
 689   int find_method_by_name(const Symbol* name, int* end) const;
 690   static int find_method_by_name(const Array<Method*>* methods,
 691                                  const Symbol* name, int* end);
 692 
 693   // constant pool
 694   ConstantPool* constants() const        { return _constants; }
 695   void set_constants(ConstantPool* c)    { _constants = c; }
 696 
 697   // protection domain
 698   oop protection_domain() const;
 699 
 700   // signers
 701   objArrayOop signers() const;
 702 
 703   // host class
 704   InstanceKlass* unsafe_anonymous_host() const {
 705     InstanceKlass** hk = adr_unsafe_anonymous_host();
 706     if (hk == NULL) {
 707       assert(!is_unsafe_anonymous(), "Unsafe anonymous classes have host klasses");
 708       return NULL;
 709     } else {
 710       assert(*hk != NULL, "host klass should always be set if the address is not null");
 711       assert(is_unsafe_anonymous(), "Only unsafe anonymous classes have host klasses");
 712       return *hk;
 713     }
 714   }
 715   void set_unsafe_anonymous_host(const InstanceKlass* host) {
 716     assert(is_unsafe_anonymous(), "not unsafe anonymous");
 717     const InstanceKlass** addr = (const InstanceKlass **)adr_unsafe_anonymous_host();
 718     assert(addr != NULL, "no reversed space");
 719     if (addr != NULL) {
 720       *addr = host;
 721     }
 722   }
 723   bool is_unsafe_anonymous() const                {
 724     return (_misc_flags & _misc_is_unsafe_anonymous) != 0;
 725   }
 726   void set_is_unsafe_anonymous(bool value)        {
 727     if (value) {
 728       _misc_flags |= _misc_is_unsafe_anonymous;
 729     } else {
 730       _misc_flags &= ~_misc_is_unsafe_anonymous;
 731     }
 732   }
 733 
 734   bool is_contended() const                {
 735     return (_misc_flags & _misc_is_contended) != 0;
 736   }
 737   void set_is_contended(bool value)        {
 738     if (value) {
 739       _misc_flags |= _misc_is_contended;
 740     } else {
 741       _misc_flags &= ~_misc_is_contended;
 742     }
 743   }
 744 
 745   // source file name
 746   Symbol* source_file_name() const               {
 747     return (_source_file_name_index == 0) ?
 748       (Symbol*)NULL : _constants->symbol_at(_source_file_name_index);
 749   }
 750   u2 source_file_name_index() const              {
 751     return _source_file_name_index;
 752   }
 753   void set_source_file_name_index(u2 sourcefile_index) {
 754     _source_file_name_index = sourcefile_index;
 755   }
 756 
 757   // minor and major version numbers of class file
 758   u2 minor_version() const                 { return _minor_version; }
 759   void set_minor_version(u2 minor_version) { _minor_version = minor_version; }
 760   u2 major_version() const                 { return _major_version; }
 761   void set_major_version(u2 major_version) { _major_version = major_version; }
 762 
 763   // source debug extension
 764   const char* source_debug_extension() const { return _source_debug_extension; }
 765   void set_source_debug_extension(const char* array, int length);
 766 
 767   // symbol unloading support (refcount already added)
 768   Symbol* array_name()                     { return _array_name; }
 769   void set_array_name(Symbol* name)        { assert(_array_name == NULL  || name == NULL, "name already created"); _array_name = name; }
 770 
 771   // nonstatic oop-map blocks
 772   static int nonstatic_oop_map_size(unsigned int oop_map_count) {
 773     return oop_map_count * OopMapBlock::size_in_words();
 774   }
 775   unsigned int nonstatic_oop_map_count() const {
 776     return _nonstatic_oop_map_size / OopMapBlock::size_in_words();
 777   }
 778   int nonstatic_oop_map_size() const { return _nonstatic_oop_map_size; }
 779   void set_nonstatic_oop_map_size(int words) {
 780     _nonstatic_oop_map_size = words;
 781   }
 782 
 783 #if INCLUDE_JVMTI
 784   // Redefinition locking.  Class can only be redefined by one thread at a time.
 785   bool is_being_redefined() const          {
 786     return (_extra_flags & _extra_is_being_redefined);
 787   }
 788   void set_is_being_redefined(bool value)  {
 789     if (value) {
 790       _extra_flags |= _extra_is_being_redefined;
 791     } else {
 792       _extra_flags &= ~_extra_is_being_redefined;
 793     }
 794   }
 795 
 796   // RedefineClasses() support for previous versions:
 797   void add_previous_version(InstanceKlass* ik, int emcp_method_count);
 798   void purge_previous_version_list();
 799 
 800   InstanceKlass* previous_versions() const { return _previous_versions; }
 801 #else
 802   InstanceKlass* previous_versions() const { return NULL; }
 803 #endif
 804 
 805   InstanceKlass* get_klass_version(int version) {
 806     for (InstanceKlass* ik = this; ik != NULL; ik = ik->previous_versions()) {
 807       if (ik->constants()->version() == version) {
 808         return ik;
 809       }
 810     }
 811     return NULL;
 812   }
 813 
 814   bool has_been_redefined() const {
 815     return (_misc_flags & _misc_has_been_redefined) != 0;
 816   }
 817   void set_has_been_redefined() {
 818     _misc_flags |= _misc_has_been_redefined;
 819   }
 820 
 821   bool has_passed_fingerprint_check() const {
 822     return (_misc_flags & _misc_has_passed_fingerprint_check) != 0;
 823   }
 824   void set_has_passed_fingerprint_check(bool b) {
 825     if (b) {
 826       _misc_flags |= _misc_has_passed_fingerprint_check;
 827     } else {
 828       _misc_flags &= ~_misc_has_passed_fingerprint_check;
 829     }
 830   }
 831   bool supers_have_passed_fingerprint_checks();
 832 
 833   static bool should_store_fingerprint(bool is_unsafe_anonymous);
 834   bool should_store_fingerprint() const { return should_store_fingerprint(is_unsafe_anonymous()); }
 835   bool has_stored_fingerprint() const;
 836   uint64_t get_stored_fingerprint() const;
 837   void store_fingerprint(uint64_t fingerprint);
 838 
 839   bool is_scratch_class() const {
 840     return (_misc_flags & _misc_is_scratch_class) != 0;
 841   }
 842 
 843   void set_is_scratch_class() {
 844     _misc_flags |= _misc_is_scratch_class;
 845   }
 846 
 847   bool has_resolved_methods() const {
 848     return (_extra_flags & _extra_has_resolved_methods) != 0;
 849   }
 850 
 851   void set_has_resolved_methods() {
 852     _extra_flags |= _extra_has_resolved_methods;
 853   }
 854 private:
 855 
 856   void set_kind(unsigned kind) {
 857     assert(kind <= _misc_kind_field_mask, "Invalid InstanceKlass kind");
 858     unsigned fmask = _misc_kind_field_mask << _misc_kind_field_pos;
 859     unsigned flags = _misc_flags & ~fmask;
 860     _misc_flags = (flags | (kind << _misc_kind_field_pos));
 861   }
 862 
 863   bool is_kind(unsigned desired) const {
 864     unsigned kind = (_misc_flags >> _misc_kind_field_pos) & _misc_kind_field_mask;
 865     return kind == desired;
 866   }
 867 
 868 public:
 869 
 870   // Other is anything that is not one of the more specialized kinds of InstanceKlass.
 871   bool is_other_instance_klass() const        { return is_kind(_misc_kind_other); }
 872   bool is_reference_instance_klass() const    { return is_kind(_misc_kind_reference); }
 873   bool is_mirror_instance_klass() const       { return is_kind(_misc_kind_mirror); }
 874   bool is_class_loader_instance_klass() const { return is_kind(_misc_kind_class_loader); }
 875   bool is_value_type_klass()            const { return is_kind(_misc_kind_value_type); }
 876 
 877 #if INCLUDE_JVMTI
 878 
 879   void init_previous_versions() {
 880     _previous_versions = NULL;
 881   }
 882 
 883  private:
 884   static bool  _has_previous_versions;
 885  public:
 886   static void purge_previous_versions(InstanceKlass* ik) {
 887     if (ik->has_been_redefined()) {
 888       ik->purge_previous_version_list();
 889     }
 890   }
 891 
 892   static bool has_previous_versions_and_reset();
 893   static bool has_previous_versions() { return _has_previous_versions; }
 894 
 895   // JVMTI: Support for caching a class file before it is modified by an agent that can do retransformation
 896   void set_cached_class_file(JvmtiCachedClassFileData *data) {
 897     _cached_class_file = data;
 898   }
 899   JvmtiCachedClassFileData * get_cached_class_file();
 900   jint get_cached_class_file_len();
 901   unsigned char * get_cached_class_file_bytes();
 902 
 903   // JVMTI: Support for caching of field indices, types, and offsets
 904   void set_jvmti_cached_class_field_map(JvmtiCachedClassFieldMap* descriptor) {
 905     _jvmti_cached_class_field_map = descriptor;
 906   }
 907   JvmtiCachedClassFieldMap* jvmti_cached_class_field_map() const {
 908     return _jvmti_cached_class_field_map;
 909   }
 910 #else // INCLUDE_JVMTI
 911 
 912   static void purge_previous_versions(InstanceKlass* ik) { return; };
 913   static bool has_previous_versions_and_reset() { return false; }
 914 
 915   void set_cached_class_file(JvmtiCachedClassFileData *data) {
 916     assert(data == NULL, "unexpected call with JVMTI disabled");
 917   }
 918   JvmtiCachedClassFileData * get_cached_class_file() { return (JvmtiCachedClassFileData *)NULL; }
 919 
 920 #endif // INCLUDE_JVMTI
 921 
 922   bool has_nonstatic_concrete_methods() const {
 923     return (_misc_flags & _misc_has_nonstatic_concrete_methods) != 0;
 924   }
 925   void set_has_nonstatic_concrete_methods(bool b) {
 926     if (b) {
 927       _misc_flags |= _misc_has_nonstatic_concrete_methods;
 928     } else {
 929       _misc_flags &= ~_misc_has_nonstatic_concrete_methods;
 930     }
 931   }
 932 
 933   bool declares_nonstatic_concrete_methods() const {
 934     return (_misc_flags & _misc_declares_nonstatic_concrete_methods) != 0;
 935   }
 936   void set_declares_nonstatic_concrete_methods(bool b) {
 937     if (b) {
 938       _misc_flags |= _misc_declares_nonstatic_concrete_methods;
 939     } else {
 940       _misc_flags &= ~_misc_declares_nonstatic_concrete_methods;
 941     }
 942   }
 943 
 944   // for adding methods, ConstMethod::UNSET_IDNUM means no more ids available
 945   inline u2 next_method_idnum();
 946   void set_initial_method_idnum(u2 value)             { _idnum_allocated_count = value; }
 947 
 948   // generics support
 949   Symbol* generic_signature() const                   {
 950     return (_generic_signature_index == 0) ?
 951       (Symbol*)NULL : _constants->symbol_at(_generic_signature_index);
 952   }
 953   u2 generic_signature_index() const                  {
 954     return _generic_signature_index;
 955   }
 956   void set_generic_signature_index(u2 sig_index)      {
 957     _generic_signature_index = sig_index;
 958   }
 959 
 960   u2 enclosing_method_data(int offset) const;
 961   u2 enclosing_method_class_index() const {
 962     return enclosing_method_data(enclosing_method_class_index_offset);
 963   }
 964   u2 enclosing_method_method_index() {
 965     return enclosing_method_data(enclosing_method_method_index_offset);
 966   }
 967   void set_enclosing_method_indices(u2 class_index,
 968                                     u2 method_index);
 969 
 970   // jmethodID support
 971   jmethodID get_jmethod_id(const methodHandle& method_h);
 972   jmethodID get_jmethod_id_fetch_or_update(size_t idnum,
 973                      jmethodID new_id, jmethodID* new_jmeths,
 974                      jmethodID* to_dealloc_id_p,
 975                      jmethodID** to_dealloc_jmeths_p);
 976   static void get_jmethod_id_length_value(jmethodID* cache, size_t idnum,
 977                 size_t *length_p, jmethodID* id_p);
 978   void ensure_space_for_methodids(int start_offset = 0);
 979   jmethodID jmethod_id_or_null(Method* method);
 980 
 981   // annotations support
 982   Annotations* annotations() const          { return _annotations; }
 983   void set_annotations(Annotations* anno)   { _annotations = anno; }
 984 
 985   AnnotationArray* class_annotations() const {
 986     return (_annotations != NULL) ? _annotations->class_annotations() : NULL;
 987   }
 988   Array<AnnotationArray*>* fields_annotations() const {
 989     return (_annotations != NULL) ? _annotations->fields_annotations() : NULL;
 990   }
 991   AnnotationArray* class_type_annotations() const {
 992     return (_annotations != NULL) ? _annotations->class_type_annotations() : NULL;
 993   }
 994   Array<AnnotationArray*>* fields_type_annotations() const {
 995     return (_annotations != NULL) ? _annotations->fields_type_annotations() : NULL;
 996   }
 997   // allocation
 998   instanceOop allocate_instance(TRAPS);
 999 
1000   // additional member function to return a handle
1001   instanceHandle allocate_instance_handle(TRAPS);
1002 
1003   objArrayOop allocate_objArray(int n, int length, TRAPS);
1004   // Helper function
1005   static instanceOop register_finalizer(instanceOop i, TRAPS);
1006 
1007   // Check whether reflection/jni/jvm code is allowed to instantiate this class;
1008   // if not, throw either an Error or an Exception.
1009   virtual void check_valid_for_instantiation(bool throwError, TRAPS);
1010 
1011   // initialization
1012   void call_class_initializer(TRAPS);
1013   void set_initialization_state_and_notify(ClassState state, TRAPS);
1014 
1015   // OopMapCache support
1016   OopMapCache* oop_map_cache()               { return _oop_map_cache; }
1017   void set_oop_map_cache(OopMapCache *cache) { _oop_map_cache = cache; }
1018   void mask_for(const methodHandle& method, int bci, InterpreterOopMap* entry);
1019 
1020   // JNI identifier support (for static fields - for jni performance)
1021   JNIid* jni_ids()                               { return _jni_ids; }
1022   void set_jni_ids(JNIid* ids)                   { _jni_ids = ids; }
1023   JNIid* jni_id_for(int offset);
1024 
1025   // maintenance of deoptimization dependencies
1026   inline DependencyContext dependencies();
1027   int  mark_dependent_nmethods(KlassDepChange& changes);
1028   void add_dependent_nmethod(nmethod* nm);
1029   void remove_dependent_nmethod(nmethod* nm);
1030   void clean_dependency_context();
1031 
1032   // On-stack replacement support
1033   nmethod* osr_nmethods_head() const         { return _osr_nmethods_head; };
1034   void set_osr_nmethods_head(nmethod* h)     { _osr_nmethods_head = h; };
1035   void add_osr_nmethod(nmethod* n);
1036   bool remove_osr_nmethod(nmethod* n);
1037   int mark_osr_nmethods(const Method* m);
1038   nmethod* lookup_osr_nmethod(const Method* m, int bci, int level, bool match_level) const;
1039 
1040 #if INCLUDE_JVMTI
1041   // Breakpoint support (see methods on Method* for details)
1042   BreakpointInfo* breakpoints() const       { return _breakpoints; };
1043   void set_breakpoints(BreakpointInfo* bps) { _breakpoints = bps; };
1044 #endif
1045 
1046   // support for stub routines
1047   static ByteSize init_state_offset()  { return in_ByteSize(offset_of(InstanceKlass, _init_state)); }
1048   JFR_ONLY(DEFINE_KLASS_TRACE_ID_OFFSET;)
1049   static ByteSize init_thread_offset() { return in_ByteSize(offset_of(InstanceKlass, _init_thread)); }
1050 
1051   static ByteSize adr_valueklass_fixed_block_offset() { return in_ByteSize(offset_of(InstanceKlass, _adr_valueklass_fixed_block)); }
1052 
1053   // subclass/subinterface checks
1054   bool implements_interface(Klass* k) const;
1055   bool is_same_or_direct_interface(Klass* k) const;
1056 
1057 #ifdef ASSERT
1058   // check whether this class or one of its superclasses was redefined
1059   bool has_redefined_this_or_super() const;
1060 #endif
1061 
1062   // Access to the implementor of an interface.
1063   Klass* implementor() const;
1064   void set_implementor(Klass* k);
1065   int  nof_implementors() const;
1066   void add_implementor(Klass* k);  // k is a new class that implements this interface
1067   void init_implementor();           // initialize
1068 
1069   // link this class into the implementors list of every interface it implements
1070   void process_interfaces(Thread *thread);
1071 
1072   // virtual operations from Klass
1073   bool is_leaf_class() const               { return _subklass == NULL; }
1074   GrowableArray<Klass*>* compute_secondary_supers(int num_extra_slots,
1075                                                   Array<InstanceKlass*>* transitive_interfaces);
1076   bool can_be_primary_super_slow() const;
1077   int oop_size(oop obj)  const             { return size_helper(); }
1078   // slow because it's a virtual call and used for verifying the layout_helper.
1079   // Using the layout_helper bits, we can call is_instance_klass without a virtual call.
1080   DEBUG_ONLY(bool is_instance_klass_slow() const      { return true; })
1081 
1082   // Iterators
1083   void do_local_static_fields(FieldClosure* cl);
1084   void do_nonstatic_fields(FieldClosure* cl); // including inherited fields
1085   void do_local_static_fields(void f(fieldDescriptor*, Handle, TRAPS), Handle, TRAPS);
1086 
1087   void methods_do(void f(Method* method));
1088   virtual void array_klasses_do(void f(Klass* k));
1089 
1090   static InstanceKlass* cast(Klass* k) {
1091     return const_cast<InstanceKlass*>(cast(const_cast<const Klass*>(k)));
1092   }
1093 
1094   static const InstanceKlass* cast(const Klass* k) {
1095     assert(k != NULL, "k should not be null");
1096     assert(k->is_instance_klass(), "cast to InstanceKlass");
1097     return static_cast<const InstanceKlass*>(k);
1098   }
1099 
1100   virtual InstanceKlass* java_super() const {
1101     return (super() == NULL) ? NULL : cast(super());
1102   }
1103 
1104   // Sizing (in words)
1105   static int header_size()            { return sizeof(InstanceKlass)/wordSize; }
1106 
1107   static int size(int vtable_length, int itable_length,
1108                   int nonstatic_oop_map_size,
1109                   bool is_interface, bool is_unsafe_anonymous, bool has_stored_fingerprint,
1110                   int java_fields, bool is_value_type) {
1111     return align_metadata_size(header_size() +
1112            vtable_length +
1113            itable_length +
1114            nonstatic_oop_map_size +
1115            (is_interface ? (int)sizeof(Klass*)/wordSize : 0) +
1116            (is_unsafe_anonymous ? (int)sizeof(Klass*)/wordSize : 0) +
1117            (has_stored_fingerprint ? (int)sizeof(uint64_t*)/wordSize : 0) +
1118            (java_fields * (int)sizeof(Klass*)/wordSize) +
1119            (is_value_type ? (int)sizeof(ValueKlassFixedBlock) : 0));
1120   }
1121   int size() const                    { return size(vtable_length(),
1122                                                itable_length(),
1123                                                nonstatic_oop_map_size(),
1124                                                is_interface(),
1125                                                is_unsafe_anonymous(),
1126                                                has_stored_fingerprint(),
1127                                                has_value_fields() ? java_fields_count() : 0,
1128                                                is_value());
1129   }
1130 #if INCLUDE_SERVICES
1131   virtual void collect_statistics(KlassSizeStats *sz) const;
1132 #endif
1133 
1134   intptr_t* start_of_itable()   const { return (intptr_t*)start_of_vtable() + vtable_length(); }
1135   intptr_t* end_of_itable()     const { return start_of_itable() + itable_length(); }
1136 
1137   int  itable_offset_in_words() const { return start_of_itable() - (intptr_t*)this; }
1138 
1139   oop static_field_base_raw() { return java_mirror(); }
1140 
1141   bool bounds_check(address addr, bool edge_ok = false, intptr_t size_in_bytes = -1) const PRODUCT_RETURN0;
1142 
1143   OopMapBlock* start_of_nonstatic_oop_maps() const {
1144     return (OopMapBlock*)(start_of_itable() + itable_length());
1145   }
1146 
1147   Klass** end_of_nonstatic_oop_maps() const {
1148     return (Klass**)(start_of_nonstatic_oop_maps() +
1149                      nonstatic_oop_map_count());
1150   }
1151 
1152   Klass* volatile* adr_implementor() const {
1153     if (is_interface()) {
1154       return (Klass* volatile*)end_of_nonstatic_oop_maps();
1155     } else {
1156       return NULL;
1157     }
1158   };
1159 
1160   InstanceKlass** adr_unsafe_anonymous_host() const {
1161     if (is_unsafe_anonymous()) {
1162       InstanceKlass** adr_impl = (InstanceKlass**)adr_implementor();
1163       if (adr_impl != NULL) {
1164         return adr_impl + 1;
1165       } else {
1166         return (InstanceKlass **)end_of_nonstatic_oop_maps();
1167       }
1168     } else {
1169       return NULL;
1170     }
1171   }
1172 
1173   address adr_fingerprint() const {
1174     if (has_stored_fingerprint()) {
1175       InstanceKlass** adr_host = adr_unsafe_anonymous_host();
1176       if (adr_host != NULL) {
1177         return (address)(adr_host + 1);
1178       }
1179 
1180       Klass* volatile* adr_impl = adr_implementor();
1181       if (adr_impl != NULL) {
1182         return (address)(adr_impl + 1);
1183       }
1184 
1185       return (address)end_of_nonstatic_oop_maps();
1186     } else {
1187       return NULL;
1188     }
1189   }
1190 
1191   address adr_value_fields_klasses() const {
1192     if (has_value_fields()) {
1193       address adr_fing = adr_fingerprint();
1194       if (adr_fing != NULL) {
1195         return adr_fingerprint() + sizeof(u8);
1196       }
1197 
1198       InstanceKlass** adr_host = adr_unsafe_anonymous_host();
1199       if (adr_host != NULL) {
1200         return (address)(adr_host + 1);
1201       }
1202 
1203       Klass* volatile* adr_impl = adr_implementor();
1204       if (adr_impl != NULL) {
1205         return (address)(adr_impl + 1);
1206       }
1207 
1208       return (address)end_of_nonstatic_oop_maps();
1209     } else {
1210       return NULL;
1211     }
1212   }
1213 
1214   Klass* get_value_field_klass(int idx) const {
1215     assert(has_value_fields(), "Sanity checking");
1216     Klass* k = ((Klass**)adr_value_fields_klasses())[idx];
1217     assert(k != NULL, "Should always be set before being read");
1218     assert(k->is_value(), "Must be a value type");
1219     return k;
1220   }
1221 
1222   Klass* get_value_field_klass_or_null(int idx) const {
1223     assert(has_value_fields(), "Sanity checking");
1224     Klass* k = ((Klass**)adr_value_fields_klasses())[idx];
1225     assert(k == NULL || k->is_value(), "Must be a value type");
1226     return k;
1227   }
1228 
1229   void set_value_field_klass(int idx, Klass* k) {
1230     assert(has_value_fields(), "Sanity checking");
1231     assert(k != NULL, "Should not be set to NULL");
1232     assert(((Klass**)adr_value_fields_klasses())[idx] == NULL, "Should not be set twice");
1233     ((Klass**)adr_value_fields_klasses())[idx] = k;
1234   }
1235 
1236   // Use this to return the size of an instance in heap words:
1237   virtual int size_helper() const {
1238     return layout_helper_to_size_helper(layout_helper());
1239   }
1240 
1241   // This bit is initialized in classFileParser.cpp.
1242   // It is false under any of the following conditions:
1243   //  - the class is abstract (including any interface)
1244   //  - the class has a finalizer (if !RegisterFinalizersAtInit)
1245   //  - the class size is larger than FastAllocateSizeLimit
1246   //  - the class is java/lang/Class, which cannot be allocated directly
1247   bool can_be_fastpath_allocated() const {
1248     return !layout_helper_needs_slow_path(layout_helper());
1249   }
1250 
1251   // Java itable
1252   klassItable itable() const;        // return klassItable wrapper
1253   Method* method_at_itable(Klass* holder, int index, TRAPS);
1254 
1255 #if INCLUDE_JVMTI
1256   void adjust_default_methods(bool* trace_name_printed);
1257 #endif // INCLUDE_JVMTI
1258 
1259   void clean_weak_instanceklass_links();
1260  private:
1261   void clean_implementors_list();
1262   void clean_method_data();
1263 
1264  public:
1265   // Explicit metaspace deallocation of fields
1266   // For RedefineClasses and class file parsing errors, we need to deallocate
1267   // instanceKlasses and the metadata they point to.
1268   void deallocate_contents(ClassLoaderData* loader_data);
1269   static void deallocate_methods(ClassLoaderData* loader_data,
1270                                  Array<Method*>* methods);
1271   void static deallocate_interfaces(ClassLoaderData* loader_data,
1272                                     const Klass* super_klass,
1273                                     Array<InstanceKlass*>* local_interfaces,
1274                                     Array<InstanceKlass*>* transitive_interfaces);
1275 
1276   // The constant pool is on stack if any of the methods are executing or
1277   // referenced by handles.
1278   bool on_stack() const { return _constants->on_stack(); }
1279 
1280   // callbacks for actions during class unloading
1281   static void unload_class(InstanceKlass* ik);
1282   static void release_C_heap_structures(InstanceKlass* ik);
1283 
1284   // Naming
1285   const char* signature_name() const;
1286   const char* signature_name_of(char c) const;
1287   static Symbol* package_from_name(const Symbol* name, TRAPS);
1288 
1289   // Oop fields (and metadata) iterators
1290   //
1291   // The InstanceKlass iterators also visits the Object's klass.
1292 
1293   // Forward iteration
1294  public:
1295   // Iterate over all oop fields in the oop maps.
1296   template <typename T, class OopClosureType>
1297   inline void oop_oop_iterate_oop_maps(oop obj, OopClosureType* closure);
1298 
1299   // Iterate over all oop fields and metadata.
1300   template <typename T, class OopClosureType>
1301   inline void oop_oop_iterate(oop obj, OopClosureType* closure);
1302 
1303   // Iterate over all oop fields in one oop map.
1304   template <typename T, class OopClosureType>
1305   inline void oop_oop_iterate_oop_map(OopMapBlock* map, oop obj, OopClosureType* closure);
1306 
1307 
1308   // Reverse iteration
1309   // Iterate over all oop fields and metadata.
1310   template <typename T, class OopClosureType>
1311   inline void oop_oop_iterate_reverse(oop obj, OopClosureType* closure);
1312 
1313  private:
1314   // Iterate over all oop fields in the oop maps.
1315   template <typename T, class OopClosureType>
1316   inline void oop_oop_iterate_oop_maps_reverse(oop obj, OopClosureType* closure);
1317 
1318   // Iterate over all oop fields in one oop map.
1319   template <typename T, class OopClosureType>
1320   inline void oop_oop_iterate_oop_map_reverse(OopMapBlock* map, oop obj, OopClosureType* closure);
1321 
1322 
1323   // Bounded range iteration
1324  public:
1325   // Iterate over all oop fields in the oop maps.
1326   template <typename T, class OopClosureType>
1327   inline void oop_oop_iterate_oop_maps_bounded(oop obj, OopClosureType* closure, MemRegion mr);
1328 
1329   // Iterate over all oop fields and metadata.
1330   template <typename T, class OopClosureType>
1331   inline void oop_oop_iterate_bounded(oop obj, OopClosureType* closure, MemRegion mr);
1332 
1333  private:
1334   // Iterate over all oop fields in one oop map.
1335   template <typename T, class OopClosureType>
1336   inline void oop_oop_iterate_oop_map_bounded(OopMapBlock* map, oop obj, OopClosureType* closure, MemRegion mr);
1337 
1338 
1339  public:
1340   u2 idnum_allocated_count() const      { return _idnum_allocated_count; }
1341 
1342 public:
1343   void set_in_error_state() {
1344     assert(DumpSharedSpaces, "only call this when dumping archive");
1345     _init_state = initialization_error;
1346   }
1347   bool check_sharing_error_state();
1348 
1349 private:
1350   // initialization state
1351   void set_init_state(ClassState state);
1352   void set_rewritten()                  { _misc_flags |= _misc_rewritten; }
1353   void set_init_thread(Thread *thread)  { _init_thread = thread; }
1354 
1355   // The RedefineClasses() API can cause new method idnums to be needed
1356   // which will cause the caches to grow. Safety requires different
1357   // cache management logic if the caches can grow instead of just
1358   // going from NULL to non-NULL.
1359   bool idnum_can_increment() const      { return has_been_redefined(); }
1360   inline jmethodID* methods_jmethod_ids_acquire() const;
1361   inline void release_set_methods_jmethod_ids(jmethodID* jmeths);
1362 
1363   // Lock during initialization
1364 public:
1365   // Lock for (1) initialization; (2) access to the ConstantPool of this class.
1366   // Must be one per class and it has to be a VM internal object so java code
1367   // cannot lock it (like the mirror).
1368   // It has to be an object not a Mutex because it's held through java calls.
1369   oop init_lock() const;
1370 private:
1371   void fence_and_clear_init_lock();
1372 
1373   bool link_class_impl                           (TRAPS);
1374   bool verify_code                               (TRAPS);
1375   void initialize_impl                           (TRAPS);
1376   void initialize_super_interfaces               (TRAPS);
1377   void eager_initialize_impl                     ();
1378   /* jni_id_for_impl for jfieldID only */
1379   JNIid* jni_id_for_impl                         (int offset);
1380 protected:
1381   // Returns the array class for the n'th dimension
1382   virtual Klass* array_klass_impl(ArrayStorageProperties storage_props, bool or_null, int n, TRAPS);
1383 
1384   // Returns the array class with this class as element type
1385   virtual Klass* array_klass_impl(ArrayStorageProperties storage_props, bool or_null, TRAPS);
1386 
1387 private:
1388 
1389   // find a local method (returns NULL if not found)
1390   Method* find_method_impl(const Symbol* name,
1391                            const Symbol* signature,
1392                            OverpassLookupMode overpass_mode,
1393                            StaticLookupMode static_mode,
1394                            PrivateLookupMode private_mode) const;
1395 
1396   static Method* find_method_impl(const Array<Method*>* methods,
1397                                   const Symbol* name,
1398                                   const Symbol* signature,
1399                                   OverpassLookupMode overpass_mode,
1400                                   StaticLookupMode static_mode,
1401                                   PrivateLookupMode private_mode);
1402 
1403   // Free CHeap allocated fields.
1404   void release_C_heap_structures();
1405 
1406 #if INCLUDE_JVMTI
1407   // RedefineClasses support
1408   void link_previous_versions(InstanceKlass* pv) { _previous_versions = pv; }
1409   void mark_newly_obsolete_methods(Array<Method*>* old_methods, int emcp_method_count);
1410 #endif
1411 public:
1412   // CDS support - remove and restore oops from metadata. Oops are not shared.
1413   virtual void remove_unshareable_info();
1414   virtual void remove_java_mirror();
1415   virtual void restore_unshareable_info(ClassLoaderData* loader_data, Handle protection_domain, TRAPS);
1416 
1417   // jvm support
1418   jint compute_modifier_flags(TRAPS) const;
1419 
1420 public:
1421   // JVMTI support
1422   jint jvmti_class_status() const;
1423 
1424   virtual void metaspace_pointers_do(MetaspaceClosure* iter);
1425 
1426  public:
1427   // Printing
1428 #ifndef PRODUCT
1429   void print_on(outputStream* st) const;
1430 #endif
1431   void print_value_on(outputStream* st) const;
1432 
1433   void oop_print_value_on(oop obj, outputStream* st);
1434 
1435 #ifndef PRODUCT
1436   void oop_print_on      (oop obj, outputStream* st);
1437 
1438   void print_dependent_nmethods(bool verbose = false);
1439   bool is_dependent_nmethod(nmethod* nm);
1440   bool verify_itable_index(int index);
1441 #endif
1442 
1443   const char* internal_name() const;
1444 
1445   // Verification
1446   void verify_on(outputStream* st);
1447 
1448   void oop_verify_on(oop obj, outputStream* st);
1449 
1450   // Logging
1451   void print_class_load_logging(ClassLoaderData* loader_data,
1452                                 const char* module_name,
1453                                 const ClassFileStream* cfs) const;
1454 };
1455 
1456 // for adding methods
1457 // UNSET_IDNUM return means no more ids available
1458 inline u2 InstanceKlass::next_method_idnum() {
1459   if (_idnum_allocated_count == ConstMethod::MAX_IDNUM) {
1460     return ConstMethod::UNSET_IDNUM; // no more ids available
1461   } else {
1462     return _idnum_allocated_count++;
1463   }
1464 }
1465 
1466 
1467 /* JNIid class for jfieldIDs only */
1468 class JNIid: public CHeapObj<mtClass> {
1469   friend class VMStructs;
1470  private:
1471   Klass*             _holder;
1472   JNIid*             _next;
1473   int                _offset;
1474 #ifdef ASSERT
1475   bool               _is_static_field_id;
1476 #endif
1477 
1478  public:
1479   // Accessors
1480   Klass* holder() const           { return _holder; }
1481   int offset() const              { return _offset; }
1482   JNIid* next()                   { return _next; }
1483   // Constructor
1484   JNIid(Klass* holder, int offset, JNIid* next);
1485   // Identifier lookup
1486   JNIid* find(int offset);
1487 
1488   bool find_local_field(fieldDescriptor* fd) {
1489     return InstanceKlass::cast(holder())->find_local_field_from_offset(offset(), true, fd);
1490   }
1491 
1492   static void deallocate(JNIid* id);
1493   // Debugging
1494 #ifdef ASSERT
1495   bool is_static_field_id() const { return _is_static_field_id; }
1496   void set_is_static_field_id()   { _is_static_field_id = true; }
1497 #endif
1498   void verify(Klass* holder);
1499 };
1500 
1501 // An iterator that's used to access the inner classes indices in the
1502 // InstanceKlass::_inner_classes array.
1503 class InnerClassesIterator : public StackObj {
1504  private:
1505   Array<jushort>* _inner_classes;
1506   int _length;
1507   int _idx;
1508  public:
1509 
1510   InnerClassesIterator(const InstanceKlass* k) {
1511     _inner_classes = k->inner_classes();
1512     if (k->inner_classes() != NULL) {
1513       _length = _inner_classes->length();
1514       // The inner class array's length should be the multiple of
1515       // inner_class_next_offset if it only contains the InnerClasses
1516       // attribute data, or it should be
1517       // n*inner_class_next_offset+enclosing_method_attribute_size
1518       // if it also contains the EnclosingMethod data.
1519       assert((_length % InstanceKlass::inner_class_next_offset == 0 ||
1520               _length % InstanceKlass::inner_class_next_offset == InstanceKlass::enclosing_method_attribute_size),
1521              "just checking");
1522       // Remove the enclosing_method portion if exists.
1523       if (_length % InstanceKlass::inner_class_next_offset == InstanceKlass::enclosing_method_attribute_size) {
1524         _length -= InstanceKlass::enclosing_method_attribute_size;
1525       }
1526     } else {
1527       _length = 0;
1528     }
1529     _idx = 0;
1530   }
1531 
1532   int length() const {
1533     return _length;
1534   }
1535 
1536   void next() {
1537     _idx += InstanceKlass::inner_class_next_offset;
1538   }
1539 
1540   bool done() const {
1541     return (_idx >= _length);
1542   }
1543 
1544   u2 inner_class_info_index() const {
1545     return _inner_classes->at(
1546                _idx + InstanceKlass::inner_class_inner_class_info_offset);
1547   }
1548 
1549   void set_inner_class_info_index(u2 index) {
1550     _inner_classes->at_put(
1551                _idx + InstanceKlass::inner_class_inner_class_info_offset, index);
1552   }
1553 
1554   u2 outer_class_info_index() const {
1555     return _inner_classes->at(
1556                _idx + InstanceKlass::inner_class_outer_class_info_offset);
1557   }
1558 
1559   void set_outer_class_info_index(u2 index) {
1560     _inner_classes->at_put(
1561                _idx + InstanceKlass::inner_class_outer_class_info_offset, index);
1562   }
1563 
1564   u2 inner_name_index() const {
1565     return _inner_classes->at(
1566                _idx + InstanceKlass::inner_class_inner_name_offset);
1567   }
1568 
1569   void set_inner_name_index(u2 index) {
1570     _inner_classes->at_put(
1571                _idx + InstanceKlass::inner_class_inner_name_offset, index);
1572   }
1573 
1574   u2 inner_access_flags() const {
1575     return _inner_classes->at(
1576                _idx + InstanceKlass::inner_class_access_flags_offset);
1577   }
1578 };
1579 
1580 #endif // SHARE_OOPS_INSTANCEKLASS_HPP
--- EOF ---