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