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