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