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