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