1 /*
   2  * Copyright (c) 1999, 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_CI_CIINSTANCEKLASS_HPP
  26 #define SHARE_VM_CI_CIINSTANCEKLASS_HPP
  27 
  28 #include "ci/ciConstantPoolCache.hpp"
  29 #include "ci/ciFlags.hpp"
  30 #include "ci/ciKlass.hpp"
  31 #include "ci/ciSymbol.hpp"
  32 
  33 // ciInstanceKlass
  34 //
  35 // This class represents a Klass* in the HotSpot virtual machine
  36 // whose Klass part is an InstanceKlass.  It may or may not
  37 // be loaded.
  38 class ciInstanceKlass : public ciKlass {
  39   CI_PACKAGE_ACCESS
  40   friend class ciBytecodeStream;
  41   friend class ciEnv;
  42   friend class ciExceptionHandler;
  43   friend class ciMethod;
  44   friend class ciField;
  45 
  46 private:
  47   jobject                _loader;
  48   jobject                _protection_domain;
  49 
  50   InstanceKlass::ClassState _init_state;           // state of class
  51   bool                   _is_shared;
  52   bool                   _has_finalizer;
  53   bool                   _has_subklass;
  54   bool                   _has_nonstatic_fields;
  55   bool                   _has_nonstatic_concrete_methods;
  56   bool                   _is_anonymous;
  57 
  58   ciFlags                _flags;
  59   jint                   _nonstatic_field_size;
  60   jint                   _nonstatic_oop_map_size;
  61 
  62   // Lazy fields get filled in only upon request.
  63   ciInstanceKlass*       _super;
  64   ciInstance*            _java_mirror;
  65 
  66   ciConstantPoolCache*   _field_cache;  // cached map index->field
  67   GrowableArray<ciField*>* _nonstatic_fields;
  68   int                    _nof_declared_nonstatic_fields; // Number of nonstatic fields declared in the bytecode
  69                                                          // i.e., without value types flattened into the instance.
  70 
  71   int                    _has_injected_fields; // any non static injected fields? lazily initialized.
  72 
  73   ciInstanceKlass*       _vcc_klass; // points to the value-capable class corresponding to the current derived value type class.
  74 
  75   // The possible values of the _implementor fall into following three cases:
  76   //   NULL: no implementor.
  77   //   A ciInstanceKlass that's not itself: one implementor.
  78   //   Itsef: more than one implementors.
  79   ciInstanceKlass*       _implementor;
  80 
  81   void compute_injected_fields();
  82   bool compute_injected_fields_helper();
  83 
  84 protected:
  85   ciInstanceKlass(Klass* k);
  86   ciInstanceKlass(ciSymbol* name, jobject loader, jobject protection_domain);
  87 
  88   InstanceKlass* get_instanceKlass() const {
  89     return InstanceKlass::cast(get_Klass());
  90   }
  91 
  92   oop loader();
  93   jobject loader_handle();
  94 
  95   oop protection_domain();
  96   jobject protection_domain_handle();
  97 
  98   const char* type_string() { return "ciInstanceKlass"; }
  99 
 100   bool is_in_package_impl(const char* packagename, int len);
 101 
 102   void print_impl(outputStream* st);
 103 
 104   ciConstantPoolCache* field_cache();
 105 
 106   bool is_shared() { return _is_shared; }
 107 
 108   void compute_shared_init_state();
 109   bool compute_shared_has_subklass();
 110   int  compute_nonstatic_fields();
 111   GrowableArray<ciField*>* compute_nonstatic_fields_impl(GrowableArray<ciField*>* super_fields);
 112 
 113   // Update the init_state for shared klasses
 114   void update_if_shared(InstanceKlass::ClassState expected) {
 115     if (_is_shared && _init_state != expected) {
 116       if (is_loaded()) compute_shared_init_state();
 117     }
 118   }
 119 
 120 public:
 121   // Has this klass been initialized?
 122   bool                   is_initialized() {
 123     update_if_shared(InstanceKlass::fully_initialized);
 124     return _init_state == InstanceKlass::fully_initialized;
 125   }
 126   // Is this klass being initialized?
 127   bool                   is_being_initialized() {
 128     update_if_shared(InstanceKlass::being_initialized);
 129     return _init_state == InstanceKlass::being_initialized;
 130   }
 131   // Has this klass been linked?
 132   bool                   is_linked() {
 133     update_if_shared(InstanceKlass::linked);
 134     return _init_state >= InstanceKlass::linked;
 135   }
 136 
 137   // General klass information.
 138   ciFlags                flags()          {
 139     assert(is_loaded(), "must be loaded");
 140     return _flags;
 141   }
 142   bool                   has_finalizer()  {
 143     assert(is_loaded(), "must be loaded");
 144     return _has_finalizer; }
 145   bool                   has_subklass()   {
 146     assert(is_loaded(), "must be loaded");
 147     if (_is_shared && !_has_subklass) {
 148       if (flags().is_final()) {
 149         return false;
 150       } else {
 151         return compute_shared_has_subklass();
 152       }
 153     }
 154     return _has_subklass;
 155   }
 156   jint                   size_helper()  {
 157     return (Klass::layout_helper_size_in_bytes(layout_helper())
 158             >> LogHeapWordSize);
 159   }
 160   jint                   nonstatic_field_size()  {
 161     assert(is_loaded(), "must be loaded");
 162     return _nonstatic_field_size; }
 163   jint                   has_nonstatic_fields()  {
 164     assert(is_loaded(), "must be loaded");
 165     return _has_nonstatic_fields; }
 166   jint                   nonstatic_oop_map_size()  {
 167     assert(is_loaded(), "must be loaded");
 168     return _nonstatic_oop_map_size; }
 169   ciInstanceKlass*       super();
 170   jint                   nof_implementors() {
 171     ciInstanceKlass* impl;
 172     assert(is_loaded(), "must be loaded");
 173     impl = implementor();
 174     if (impl == NULL) {
 175       return 0;
 176     } else if (impl != this) {
 177       return 1;
 178     } else {
 179       return 2;
 180     }
 181   }
 182   bool has_nonstatic_concrete_methods()  {
 183     assert(is_loaded(), "must be loaded");
 184     return _has_nonstatic_concrete_methods;
 185   }
 186 
 187   bool is_anonymous() {
 188     return _is_anonymous;
 189   }
 190 
 191   ciInstanceKlass* get_canonical_holder(int offset);
 192   ciField* get_field_by_offset(int field_offset, bool is_static);
 193   ciType*  get_field_type_by_offset(int field_offset);
 194   ciField* get_field_by_name(ciSymbol* name, ciSymbol* signature, bool is_static);
 195 
 196   // total number of nonstatic fields (including inherited):
 197   int nof_nonstatic_fields() {
 198     if (_nonstatic_fields == NULL)
 199       return compute_nonstatic_fields();
 200     else
 201       return _nonstatic_fields->length();
 202   }
 203 
 204   int nof_declared_nonstatic_fields() {
 205     if (_nonstatic_fields == NULL) {
 206       compute_nonstatic_fields();
 207     }
 208     assert(_nof_declared_nonstatic_fields >= 0, "after lazy initialization _nof_declared_nonstatic_fields must be at least 0");
 209     return _nof_declared_nonstatic_fields;
 210   }
 211 
 212   bool has_injected_fields() {
 213     if (_has_injected_fields == -1) {
 214       compute_injected_fields();
 215     }
 216     return _has_injected_fields > 0 ? true : false;
 217   }
 218 
 219   // nth nonstatic field (presented by ascending address)
 220   ciField* nonstatic_field_at(int i) {
 221     assert(_nonstatic_fields != NULL, "");
 222     return _nonstatic_fields->at(i);
 223   }
 224 
 225   ciInstanceKlass* unique_concrete_subklass();
 226   bool has_finalizable_subclass();
 227 
 228   bool contains_field_offset(int offset) {
 229     return instanceOopDesc::contains_field_offset(offset, nonstatic_field_size(), is_valuetype());
 230   }
 231 
 232   // Get the instance of java.lang.Class corresponding to
 233   // this klass.  This instance is used for locking of
 234   // synchronized static methods of this klass.
 235   ciInstance*            java_mirror();
 236 
 237   // Java access flags
 238   bool is_public      () { return flags().is_public(); }
 239   bool is_final       () { return flags().is_final(); }
 240   bool is_super       () { return flags().is_super(); }
 241   bool is_interface   () { return flags().is_interface(); }
 242   bool is_abstract    () { return flags().is_abstract(); }
 243 
 244   ciMethod* find_method(ciSymbol* name, ciSymbol* signature);
 245   // Note:  To find a method from name and type strings, use ciSymbol::make,
 246   // but consider adding to vmSymbols.hpp instead.
 247 
 248   bool is_leaf_type();
 249   ciInstanceKlass* implementor();
 250   ciInstanceKlass* vcc_klass();
 251 
 252   // Is the defining class loader of this class the default loader?
 253   bool uses_default_loader() const;
 254 
 255   bool is_java_lang_Object() const;
 256 
 257   BasicType box_klass_type() const;
 258   bool is_box_klass() const;
 259   bool is_boxed_value_offset(int offset) const;
 260 
 261   // Is this klass in the given package?
 262   bool is_in_package(const char* packagename) {
 263     return is_in_package(packagename, (int) strlen(packagename));
 264   }
 265   bool is_in_package(const char* packagename, int len);
 266 
 267   // What kind of ciObject is this?
 268   bool is_instance_klass() const { return true; }
 269   bool is_java_klass() const     { return true; }
 270 
 271   virtual ciKlass* exact_klass() {
 272     if (is_loaded() && is_final() && !is_interface()) {
 273       return this;
 274     }
 275     return NULL;
 276   }
 277 
 278   ciInstanceKlass* host_klass();
 279 
 280   bool can_be_instantiated() {
 281     assert(is_loaded(), "must be loaded");
 282     return !is_interface() && !is_abstract();
 283   }
 284 
 285   // Dump the current state of this klass for compilation replay.
 286   virtual void dump_replay_data(outputStream* out);
 287 };
 288 
 289 #endif // SHARE_VM_CI_CIINSTANCEKLASS_HPP