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_CIENV_HPP
  26 #define SHARE_CI_CIENV_HPP
  27 
  28 #include "ci/ciClassList.hpp"
  29 #include "ci/ciObjectFactory.hpp"
  30 #include "classfile/systemDictionary.hpp"
  31 #include "code/debugInfoRec.hpp"
  32 #include "code/dependencies.hpp"
  33 #include "code/exceptionHandlerTable.hpp"
  34 #include "compiler/oopMap.hpp"
  35 #include "oops/methodData.hpp"
  36 #include "runtime/thread.hpp"
  37 
  38 class CompileTask;
  39 
  40 // ciEnv
  41 //
  42 // This class is the top level broker for requests from the compiler
  43 // to the VM.
  44 class ciEnv : StackObj {
  45   CI_PACKAGE_ACCESS_TO
  46 
  47   friend class CompileBroker;
  48   friend class Dependencies;  // for get_object, during logging
  49   friend class PrepareExtraDataClosure;
  50 
  51 private:
  52   Arena*           _arena;       // Alias for _ciEnv_arena except in init_shared_objects()
  53   Arena            _ciEnv_arena;
  54   ciObjectFactory* _factory;
  55   OopRecorder*     _oop_recorder;
  56   DebugInformationRecorder* _debug_info;
  57   Dependencies*    _dependencies;
  58   const char*      _failure_reason;
  59   bool             _inc_decompile_count_on_failure;
  60   int              _compilable;
  61   bool             _break_at_compile;
  62   int              _num_inlined_bytecodes;
  63   CompileTask*     _task;           // faster access to CompilerThread::task
  64   CompileLog*      _log;            // faster access to CompilerThread::log
  65   void*            _compiler_data;  // compiler-specific stuff, if any
  66 
  67   char* _name_buffer;
  68   int   _name_buffer_len;
  69 
  70   // Cache Jvmti state
  71   bool  _jvmti_can_hotswap_or_post_breakpoint;
  72   bool  _jvmti_can_access_local_variables;
  73   bool  _jvmti_can_post_on_exceptions;
  74   bool  _jvmti_can_pop_frame;
  75 
  76   // Cache DTrace flags
  77   bool  _dtrace_extended_probes;
  78   bool  _dtrace_monitor_probes;
  79   bool  _dtrace_method_probes;
  80   bool  _dtrace_alloc_probes;
  81 
  82   // Distinguished instances of certain ciObjects..
  83   static ciObject*              _null_object_instance;
  84 
  85 #define WK_KLASS_DECL(name, ignore_s) static ciInstanceKlass* _##name;
  86   WK_KLASSES_DO(WK_KLASS_DECL)
  87 #undef WK_KLASS_DECL
  88 
  89   static ciSymbol*        _unloaded_cisymbol;
  90   static ciInstanceKlass* _unloaded_ciinstance_klass;
  91   static ciObjArrayKlass* _unloaded_ciobjarrayklass;
  92 
  93   static jobject _ArrayIndexOutOfBoundsException_handle;
  94   static jobject _ArrayStoreException_handle;
  95   static jobject _ClassCastException_handle;
  96 
  97   ciInstance* _NullPointerException_instance;
  98   ciInstance* _ArithmeticException_instance;
  99   ciInstance* _ArrayIndexOutOfBoundsException_instance;
 100   ciInstance* _ArrayStoreException_instance;
 101   ciInstance* _ClassCastException_instance;
 102 
 103   ciInstance* _the_null_string;      // The Java string "null"
 104   ciInstance* _the_min_jint_string; // The Java string "-2147483648"
 105 
 106   // Look up a klass by name from a particular class loader (the accessor's).
 107   // If require_local, result must be defined in that class loader, or NULL.
 108   // If !require_local, a result from remote class loader may be reported,
 109   // if sufficient class loader constraints exist such that initiating
 110   // a class loading request from the given loader is bound to return
 111   // the class defined in the remote loader (or throw an error).
 112   //
 113   // Return an unloaded klass if !require_local and no class at all is found.
 114   //
 115   // The CI treats a klass as loaded if it is consistently defined in
 116   // another loader, even if it hasn't yet been loaded in all loaders
 117   // that could potentially see it via delegation.
 118   ciKlass* get_klass_by_name(ciKlass* accessing_klass,
 119                              ciSymbol* klass_name,
 120                              bool require_local);
 121 
 122   // Constant pool access.
 123   ciKlass*   get_klass_by_index(const constantPoolHandle& cpool,
 124                                 int klass_index,
 125                                 bool& is_accessible,
 126                                 ciInstanceKlass* loading_klass);
 127   ciConstant get_constant_by_index(const constantPoolHandle& cpool,
 128                                    int pool_index, int cache_index,
 129                                    ciInstanceKlass* accessor);
 130   ciField*   get_field_by_index(ciInstanceKlass* loading_klass,
 131                                 int field_index);
 132   ciMethod*  get_method_by_index(const constantPoolHandle& cpool,
 133                                  int method_index, Bytecodes::Code bc,
 134                                  ciInstanceKlass* loading_klass);
 135 
 136   // Implementation methods for loading and constant pool access.
 137   ciKlass* get_klass_by_name_impl(ciKlass* accessing_klass,
 138                                   const constantPoolHandle& cpool,
 139                                   ciSymbol* klass_name,
 140                                   bool require_local);
 141   ciKlass*   get_klass_by_index_impl(const constantPoolHandle& cpool,
 142                                      int klass_index,
 143                                      bool& is_accessible,
 144                                      ciInstanceKlass* loading_klass);
 145   ciConstant get_constant_by_index_impl(const constantPoolHandle& cpool,
 146                                         int pool_index, int cache_index,
 147                                         ciInstanceKlass* loading_klass);
 148   ciField*   get_field_by_index_impl(ciInstanceKlass* loading_klass,
 149                                      int field_index);
 150   ciMethod*  get_method_by_index_impl(const constantPoolHandle& cpool,
 151                                       int method_index, Bytecodes::Code bc,
 152                                       ciInstanceKlass* loading_klass);
 153 
 154   // Helper methods
 155   bool       check_klass_accessibility(ciKlass* accessing_klass,
 156                                       Klass* resolved_klass);
 157   Method*    lookup_method(ciInstanceKlass* accessor,
 158                            ciKlass*         holder,
 159                            Symbol*          name,
 160                            Symbol*          sig,
 161                            Bytecodes::Code  bc,
 162                            constantTag      tag);
 163 
 164   // Get a ciObject from the object factory.  Ensures uniqueness
 165   // of ciObjects.
 166   ciObject* get_object(oop o) {
 167     if (o == NULL) {
 168       return _null_object_instance;
 169     } else {
 170       return _factory->get(o);
 171     }
 172   }
 173 
 174   ciSymbol* get_symbol(Symbol* o) {
 175     if (o == NULL) {
 176       ShouldNotReachHere();
 177       return NULL;
 178     } else {
 179       return _factory->get_symbol(o);
 180     }
 181   }
 182 
 183   ciMetadata* get_metadata(Metadata* o) {
 184     if (o == NULL) {
 185       return NULL;
 186     } else {
 187       return _factory->get_metadata(o);
 188     }
 189   }
 190 
 191   ciMetadata* cached_metadata(Metadata* o) {
 192     return _factory->cached_metadata(o);
 193   }
 194 
 195   ciInstance* get_instance(oop o) {
 196     if (o == NULL) return NULL;
 197     return get_object(o)->as_instance();
 198   }
 199   ciObjArrayKlass* get_obj_array_klass(Klass* o) {
 200     if (o == NULL) return NULL;
 201     return get_metadata(o)->as_obj_array_klass();
 202   }
 203   ciTypeArrayKlass* get_type_array_klass(Klass* o) {
 204     if (o == NULL) return NULL;
 205     return get_metadata(o)->as_type_array_klass();
 206   }
 207   ciKlass* get_klass(Klass* o) {
 208     if (o == NULL) return NULL;
 209     return get_metadata(o)->as_klass();
 210   }
 211   ciInstanceKlass* get_instance_klass(Klass* o) {
 212     if (o == NULL) return NULL;
 213     return get_metadata(o)->as_instance_klass();
 214   }
 215   ciMethod* get_method(Method* o) {
 216     if (o == NULL) return NULL;
 217     return get_metadata(o)->as_method();
 218   }
 219   ciMethodData* get_method_data(MethodData* o) {
 220     if (o == NULL) return NULL;
 221     return get_metadata(o)->as_method_data();
 222   }
 223 
 224   ciMethod* get_method_from_handle(Method* method);
 225 
 226   ciInstance* get_or_create_exception(jobject& handle, Symbol* name);
 227 
 228   // Get a ciMethod representing either an unfound method or
 229   // a method with an unloaded holder.  Ensures uniqueness of
 230   // the result.
 231   ciMethod* get_unloaded_method(ciKlass*         holder,
 232                                 ciSymbol*        name,
 233                                 ciSymbol*        signature,
 234                                 ciInstanceKlass* accessor) {
 235     ciInstanceKlass* declared_holder = get_instance_klass_for_declared_method_holder(holder);
 236     return _factory->get_unloaded_method(declared_holder, name, signature, accessor);
 237   }
 238 
 239   // Get a ciKlass representing an unloaded klass.
 240   // Ensures uniqueness of the result.
 241   ciKlass* get_unloaded_klass(ciKlass*  accessing_klass,
 242                               ciSymbol* name) {
 243     return _factory->get_unloaded_klass(accessing_klass, name, true);
 244   }
 245 
 246   // Get a ciKlass representing an unloaded klass mirror.
 247   // Result is not necessarily unique, but will be unloaded.
 248   ciInstance* get_unloaded_klass_mirror(ciKlass* type) {
 249     return _factory->get_unloaded_klass_mirror(type);
 250   }
 251 
 252   // Get a ciInstance representing an unresolved method handle constant.
 253   ciInstance* get_unloaded_method_handle_constant(ciKlass*  holder,
 254                                                   ciSymbol* name,
 255                                                   ciSymbol* signature,
 256                                                   int       ref_kind) {
 257     return _factory->get_unloaded_method_handle_constant(holder, name, signature, ref_kind);
 258   }
 259 
 260   // Get a ciInstance representing an unresolved method type constant.
 261   ciInstance* get_unloaded_method_type_constant(ciSymbol* signature) {
 262     return _factory->get_unloaded_method_type_constant(signature);
 263   }
 264 
 265   // See if we already have an unloaded klass for the given name
 266   // or return NULL if not.
 267   ciKlass *check_get_unloaded_klass(ciKlass*  accessing_klass, ciSymbol* name) {
 268     return _factory->get_unloaded_klass(accessing_klass, name, false);
 269   }
 270 
 271   // Get a ciReturnAddress corresponding to the given bci.
 272   // Ensures uniqueness of the result.
 273   ciReturnAddress* get_return_address(int bci) {
 274     return _factory->get_return_address(bci);
 275   }
 276 
 277   // Get a ciMethodData representing the methodData for a method
 278   // with none.
 279   ciMethodData* get_empty_methodData() {
 280     return _factory->get_empty_methodData();
 281   }
 282 
 283   // General utility : get a buffer of some required length.
 284   // Used in symbol creation.
 285   char* name_buffer(int req_len);
 286 
 287   // Is this thread currently in the VM state?
 288   static bool is_in_vm();
 289 
 290   // Helper routine for determining the validity of a compilation with
 291   // respect to method dependencies (e.g. concurrent class loading).
 292   void validate_compile_task_dependencies(ciMethod* target);
 293 public:
 294   enum {
 295     MethodCompilable,
 296     MethodCompilable_not_at_tier,
 297     MethodCompilable_never
 298   };
 299 
 300   ciEnv(CompileTask* task);
 301   // Used only during initialization of the ci
 302   ciEnv(Arena* arena);
 303   ~ciEnv();
 304 
 305   OopRecorder* oop_recorder() { return _oop_recorder; }
 306   void set_oop_recorder(OopRecorder* r) { _oop_recorder = r; }
 307 
 308   DebugInformationRecorder* debug_info() { return _debug_info; }
 309   void set_debug_info(DebugInformationRecorder* i) { _debug_info = i; }
 310 
 311   Dependencies* dependencies() { return _dependencies; }
 312   void set_dependencies(Dependencies* d) { _dependencies = d; }
 313 
 314   // This is true if the compilation is not going to produce code.
 315   // (It is reasonable to retry failed compilations.)
 316   bool failing() { return _failure_reason != NULL; }
 317 
 318   // Reason this compilation is failing, such as "too many basic blocks".
 319   const char* failure_reason() { return _failure_reason; }
 320 
 321   // Return state of appropriate compilability
 322   int compilable() { return _compilable; }
 323 
 324   const char* retry_message() const {
 325     switch (_compilable) {
 326       case ciEnv::MethodCompilable_not_at_tier:
 327         return "retry at different tier";
 328       case ciEnv::MethodCompilable_never:
 329         return "not retryable";
 330       case ciEnv::MethodCompilable:
 331         return NULL;
 332       default:
 333         ShouldNotReachHere();
 334         return NULL;
 335     }
 336   }
 337 
 338   bool break_at_compile() { return _break_at_compile; }
 339   void set_break_at_compile(bool z) { _break_at_compile = z; }
 340 
 341   // Cache Jvmti state
 342   void  cache_jvmti_state();
 343   bool  jvmti_state_changed() const;
 344   bool  should_retain_local_variables() const {
 345     return _jvmti_can_access_local_variables || _jvmti_can_pop_frame;
 346   }
 347   bool  jvmti_can_hotswap_or_post_breakpoint() const { return _jvmti_can_hotswap_or_post_breakpoint; }
 348   bool  jvmti_can_post_on_exceptions()         const { return _jvmti_can_post_on_exceptions; }
 349 
 350   // Cache DTrace flags
 351   void  cache_dtrace_flags();
 352   bool  dtrace_extended_probes() const { return _dtrace_extended_probes; }
 353   bool  dtrace_monitor_probes()  const { return _dtrace_monitor_probes; }
 354   bool  dtrace_method_probes()   const { return _dtrace_method_probes; }
 355   bool  dtrace_alloc_probes()    const { return _dtrace_alloc_probes; }
 356 
 357   // The compiler task which has created this env.
 358   // May be useful to find out compile_id, comp_level, etc.
 359   CompileTask* task() { return _task; }
 360 
 361   // Handy forwards to the task:
 362   int comp_level();   // task()->comp_level()
 363   uint compile_id();  // task()->compile_id()
 364 
 365   // Register the result of a compilation.
 366   void register_method(ciMethod*                 target,
 367                        int                       entry_bci,
 368                        CodeOffsets*              offsets,
 369                        int                       orig_pc_offset,
 370                        CodeBuffer*               code_buffer,
 371                        int                       frame_words,
 372                        OopMapSet*                oop_map_set,
 373                        ExceptionHandlerTable*    handler_table,
 374                        ImplicitExceptionTable*   inc_table,
 375                        AbstractCompiler*         compiler,
 376                        bool                      has_unsafe_access,
 377                        bool                      has_wide_vectors,
 378                        bool                      has_monitors,
 379                        int                       immediate_oops_patched,
 380                        RTMState                  rtm_state = NoRTM);
 381 
 382 
 383   // Access to certain well known ciObjects.
 384 #define WK_KLASS_FUNC(name, ignore_s) \
 385   ciInstanceKlass* name() { \
 386     return _##name;\
 387   }
 388   WK_KLASSES_DO(WK_KLASS_FUNC)
 389 #undef WK_KLASS_FUNC
 390 
 391   ciInstance* NullPointerException_instance() {
 392     assert(_NullPointerException_instance != NULL, "initialization problem");
 393     return _NullPointerException_instance;
 394   }
 395   ciInstance* ArithmeticException_instance() {
 396     assert(_ArithmeticException_instance != NULL, "initialization problem");
 397     return _ArithmeticException_instance;
 398   }
 399 
 400   // Lazy constructors:
 401   ciInstance* ArrayIndexOutOfBoundsException_instance();
 402   ciInstance* ArrayStoreException_instance();
 403   ciInstance* ClassCastException_instance();
 404 
 405   ciInstance* the_null_string();
 406   ciInstance* the_min_jint_string();
 407 
 408   static ciSymbol* unloaded_cisymbol() {
 409     return _unloaded_cisymbol;
 410   }
 411   static ciObjArrayKlass* unloaded_ciobjarrayklass() {
 412     return _unloaded_ciobjarrayklass;
 413   }
 414   static ciInstanceKlass* unloaded_ciinstance_klass() {
 415     return _unloaded_ciinstance_klass;
 416   }
 417   ciInstance* unloaded_ciinstance();
 418 
 419   ciKlass*  find_system_klass(ciSymbol* klass_name);
 420   // Note:  To find a class from its name string, use ciSymbol::make,
 421   // but consider adding to vmSymbols.hpp instead.
 422 
 423   // converts the ciKlass* representing the holder of a method into a
 424   // ciInstanceKlass*.  This is needed since the holder of a method in
 425   // the bytecodes could be an array type.  Basically this converts
 426   // array types into java/lang/Object and other types stay as they are.
 427   static ciInstanceKlass* get_instance_klass_for_declared_method_holder(ciKlass* klass);
 428 
 429   // Return the machine-level offset of o, which must be an element of a.
 430   // This may be used to form constant-loading expressions in lieu of simpler encodings.
 431   int       array_element_offset_in_bytes(ciArray* a, ciObject* o);
 432 
 433   // Access to the compile-lifetime allocation arena.
 434   Arena*    arena() { return _arena; }
 435 
 436   // What is the current compilation environment?
 437   static ciEnv* current() { return CompilerThread::current()->env(); }
 438 
 439   // Overload with current thread argument
 440   static ciEnv* current(CompilerThread *thread) { return thread->env(); }
 441 
 442   // Per-compiler data.  (Used by C2 to publish the Compile* pointer.)
 443   void* compiler_data() { return _compiler_data; }
 444   void set_compiler_data(void* x) { _compiler_data = x; }
 445 
 446   // Notice that a method has been inlined in the current compile;
 447   // used only for statistics.
 448   void notice_inlined_method(ciMethod* method);
 449 
 450   // Total number of bytecodes in inlined methods in this compile
 451   int num_inlined_bytecodes() const;
 452 
 453   // Output stream for logging compilation info.
 454   CompileLog* log() { return _log; }
 455   void set_log(CompileLog* log) { _log = log; }
 456 
 457   void record_failure(const char* reason);      // Record failure and report later
 458   void report_failure(const char* reason);      // Report failure immediately
 459   void record_method_not_compilable(const char* reason, bool all_tiers = true);
 460   void record_out_of_memory_failure();
 461 
 462   // RedefineClasses support
 463   void metadata_do(MetadataClosure* f) { _factory->metadata_do(f); }
 464 
 465   // Dump the compilation replay data for the ciEnv to the stream.
 466   void dump_replay_data(int compile_id);
 467   void dump_inline_data(int compile_id);
 468   void dump_replay_data(outputStream* out);
 469   void dump_replay_data_unsafe(outputStream* out);
 470   void dump_compile_data(outputStream* out);
 471 };
 472 
 473 #endif // SHARE_CI_CIENV_HPP