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