1 /*
   2  * Copyright 1999-2009 Sun Microsystems, Inc.  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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  20  * CA 95054 USA or visit www.sun.com if you need additional information or
  21  * have any questions.
  22  *
  23  */
  24 
  25 class CompileTask;
  26 
  27 // ciEnv
  28 //
  29 // This class is the top level broker for requests from the compiler
  30 // to the VM.
  31 class ciEnv : StackObj {
  32   CI_PACKAGE_ACCESS_TO
  33 
  34   friend class CompileBroker;
  35   friend class Dependencies;  // for get_object, during logging
  36 
  37 private:
  38   Arena*           _arena;       // Alias for _ciEnv_arena except in init_shared_objects()
  39   Arena            _ciEnv_arena;
  40   int              _system_dictionary_modification_counter;
  41   ciObjectFactory* _factory;
  42   OopRecorder*     _oop_recorder;
  43   DebugInformationRecorder* _debug_info;
  44   Dependencies*    _dependencies;
  45   const char*      _failure_reason;
  46   int              _compilable;
  47   bool             _break_at_compile;
  48   int              _num_inlined_bytecodes;
  49   CompileTask*     _task;           // faster access to CompilerThread::task
  50   CompileLog*      _log;            // faster access to CompilerThread::log
  51   void*            _compiler_data;  // compiler-specific stuff, if any
  52 
  53   char* _name_buffer;
  54   int   _name_buffer_len;
  55 
  56   // Cache Jvmti state
  57   bool  _jvmti_can_hotswap_or_post_breakpoint;
  58   bool  _jvmti_can_examine_or_deopt_anywhere;
  59   bool  _jvmti_can_access_local_variables;
  60   bool  _jvmti_can_post_exceptions;
  61 
  62   // Cache DTrace flags
  63   bool  _dtrace_extended_probes;
  64   bool  _dtrace_monitor_probes;
  65   bool  _dtrace_method_probes;
  66   bool  _dtrace_alloc_probes;
  67 
  68   // Distinguished instances of certain ciObjects..
  69   static ciObject*              _null_object_instance;
  70   static ciMethodKlass*         _method_klass_instance;
  71   static ciSymbolKlass*         _symbol_klass_instance;
  72   static ciKlassKlass*          _klass_klass_instance;
  73   static ciInstanceKlassKlass*  _instance_klass_klass_instance;
  74   static ciTypeArrayKlassKlass* _type_array_klass_klass_instance;
  75   static ciObjArrayKlassKlass*  _obj_array_klass_klass_instance;
  76 
  77   static ciInstanceKlass* _ArrayStoreException;
  78   static ciInstanceKlass* _Class;
  79   static ciInstanceKlass* _ClassCastException;
  80   static ciInstanceKlass* _Object;
  81   static ciInstanceKlass* _Throwable;
  82   static ciInstanceKlass* _Thread;
  83   static ciInstanceKlass* _OutOfMemoryError;
  84   static ciInstanceKlass* _String;
  85   static ciInstanceKlass* _StringBuffer;
  86   static ciInstanceKlass* _StringBuilder;
  87   static ciInstanceKlass* _Integer;
  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(ciInstanceKlass* loading_klass,
 124                                 int klass_index,
 125                                 bool& is_accessible);
 126   ciConstant get_constant_by_index(ciInstanceKlass* loading_klass,
 127                                    int constant_index);
 128   bool       is_unresolved_string(ciInstanceKlass* loading_klass,
 129                                    int constant_index) const;
 130   bool       is_unresolved_klass(ciInstanceKlass* loading_klass,
 131                                    int constant_index) const;
 132   ciField*   get_field_by_index(ciInstanceKlass* loading_klass,
 133                                 int field_index);
 134   ciMethod*  get_method_by_index(ciInstanceKlass* loading_klass,
 135                                  int method_index, Bytecodes::Code bc);
 136 
 137   // Implementation methods for loading and constant pool access.
 138   ciKlass* get_klass_by_name_impl(ciKlass* accessing_klass,
 139                                   ciSymbol* klass_name,
 140                                   bool require_local);
 141   ciKlass*   get_klass_by_index_impl(ciInstanceKlass* loading_klass,
 142                                      int klass_index,
 143                                      bool& is_accessible);
 144   ciConstant get_constant_by_index_impl(ciInstanceKlass* loading_klass,
 145                                         int constant_index);
 146   bool       is_unresolved_string_impl (instanceKlass* loading_klass,
 147                                         int constant_index) const;
 148   bool       is_unresolved_klass_impl (instanceKlass* loading_klass,
 149                                         int constant_index) const;
 150   ciField*   get_field_by_index_impl(ciInstanceKlass* loading_klass,
 151                                      int field_index);
 152   ciMethod*  get_method_by_index_impl(ciInstanceKlass* loading_klass,
 153                                       int method_index, Bytecodes::Code bc);
 154 
 155   // Helper methods
 156   bool       check_klass_accessibility(ciKlass* accessing_klass,
 157                                       klassOop resolved_klassOop);
 158   methodOop  lookup_method(instanceKlass*  accessor,
 159                            instanceKlass*  holder,
 160                            symbolOop       name,
 161                            symbolOop       sig,
 162                            Bytecodes::Code bc);
 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   ciMethod* get_method_from_handle(jobject method);
 175 
 176   ciInstance* get_or_create_exception(jobject& handle, symbolHandle name);
 177 
 178   // Get a ciMethod representing either an unfound method or
 179   // a method with an unloaded holder.  Ensures uniqueness of
 180   // the result.
 181   ciMethod* get_unloaded_method(ciInstanceKlass* holder,
 182                                 ciSymbol*        name,
 183                                 ciSymbol*        signature) {
 184     return _factory->get_unloaded_method(holder, name, signature);
 185   }
 186 
 187   // Get a ciKlass representing an unloaded klass.
 188   // Ensures uniqueness of the result.
 189   ciKlass* get_unloaded_klass(ciKlass* accessing_klass,
 190                               ciSymbol* name) {
 191     return _factory->get_unloaded_klass(accessing_klass, name, true);
 192   }
 193 
 194   // See if we already have an unloaded klass for the given name
 195   // or return NULL if not.
 196   ciKlass *check_get_unloaded_klass(ciKlass* accessing_klass, ciSymbol* name) {
 197     return _factory->get_unloaded_klass(accessing_klass, name, false);
 198   }
 199 
 200   // Get a ciReturnAddress corresponding to the given bci.
 201   // Ensures uniqueness of the result.
 202   ciReturnAddress* get_return_address(int bci) {
 203     return _factory->get_return_address(bci);
 204   }
 205 
 206   // Get a ciMethodData representing the methodData for a method
 207   // with none.
 208   ciMethodData* get_empty_methodData() {
 209     return _factory->get_empty_methodData();
 210   }
 211 
 212   // General utility : get a buffer of some required length.
 213   // Used in symbol creation.
 214   char* name_buffer(int req_len);
 215 
 216   // Is this thread currently in the VM state?
 217   static bool is_in_vm();
 218 
 219   // Helper routine for determining the validity of a compilation
 220   // with respect to concurrent class loading.
 221   void check_for_system_dictionary_modification(ciMethod* target);
 222 
 223 public:
 224   enum {
 225     MethodCompilable,
 226     MethodCompilable_not_at_tier,
 227     MethodCompilable_never
 228   };
 229 
 230   ciEnv(CompileTask* task, int system_dictionary_modification_counter);
 231   // Used only during initialization of the ci
 232   ciEnv(Arena* arena);
 233   ~ciEnv();
 234 
 235   OopRecorder* oop_recorder() { return _oop_recorder; }
 236   void set_oop_recorder(OopRecorder* r) { _oop_recorder = r; }
 237 
 238   DebugInformationRecorder* debug_info() { return _debug_info; }
 239   void set_debug_info(DebugInformationRecorder* i) { _debug_info = i; }
 240 
 241   Dependencies* dependencies() { return _dependencies; }
 242   void set_dependencies(Dependencies* d) { _dependencies = d; }
 243 
 244   // This is true if the compilation is not going to produce code.
 245   // (It is reasonable to retry failed compilations.)
 246   bool failing() { return _failure_reason != NULL; }
 247 
 248   // Reason this compilation is failing, such as "too many basic blocks".
 249   const char* failure_reason() { return _failure_reason; }
 250 
 251   // Return state of appropriate compilability
 252   int compilable() { return _compilable; }
 253 
 254   bool break_at_compile() { return _break_at_compile; }
 255   void set_break_at_compile(bool z) { _break_at_compile = z; }
 256 
 257   // Cache Jvmti state
 258   void  cache_jvmti_state();
 259   bool  jvmti_can_hotswap_or_post_breakpoint() const { return _jvmti_can_hotswap_or_post_breakpoint; }
 260   bool  jvmti_can_examine_or_deopt_anywhere()  const { return _jvmti_can_examine_or_deopt_anywhere; }
 261   bool  jvmti_can_access_local_variables()     const { return _jvmti_can_access_local_variables; }
 262   bool  jvmti_can_post_exceptions()            const { return _jvmti_can_post_exceptions; }
 263 
 264   // Cache DTrace flags
 265   void  cache_dtrace_flags();
 266   bool  dtrace_extended_probes() const { return _dtrace_extended_probes; }
 267   bool  dtrace_monitor_probes()  const { return _dtrace_monitor_probes; }
 268   bool  dtrace_method_probes()   const { return _dtrace_method_probes; }
 269   bool  dtrace_alloc_probes()    const { return _dtrace_alloc_probes; }
 270 
 271   // The compiler task which has created this env.
 272   // May be useful to find out compile_id, comp_level, etc.
 273   CompileTask* task() { return _task; }
 274   // Handy forwards to the task:
 275   int comp_level();   // task()->comp_level()
 276   uint compile_id();  // task()->compile_id()
 277 
 278   // Register the result of a compilation.
 279   void register_method(ciMethod*                 target,
 280                        int                       entry_bci,
 281                        CodeOffsets*              offsets,
 282                        int                       orig_pc_offset,
 283                        CodeBuffer*               code_buffer,
 284                        int                       frame_words,
 285                        OopMapSet*                oop_map_set,
 286                        ExceptionHandlerTable*    handler_table,
 287                        ImplicitExceptionTable*   inc_table,
 288                        AbstractCompiler*         compiler,
 289                        int                       comp_level,
 290                        bool                      has_debug_info = true,
 291                        bool                      has_unsafe_access = false);
 292 
 293 
 294   // Access to certain well known ciObjects.
 295   ciInstanceKlass* ArrayStoreException_klass() {
 296     return _ArrayStoreException;
 297   }
 298   ciInstanceKlass* Class_klass() {
 299     return _Class;
 300   }
 301   ciInstanceKlass* ClassCastException_klass() {
 302     return _ClassCastException;
 303   }
 304   ciInstanceKlass* Object_klass() {
 305     return _Object;
 306   }
 307   ciInstanceKlass* Throwable_klass() {
 308     return _Throwable;
 309   }
 310   ciInstanceKlass* Thread_klass() {
 311     return _Thread;
 312   }
 313   ciInstanceKlass* OutOfMemoryError_klass() {
 314     return _OutOfMemoryError;
 315   }
 316   ciInstanceKlass* String_klass() {
 317     return _String;
 318   }
 319   ciInstanceKlass* StringBuilder_klass() {
 320     return _StringBuilder;
 321   }
 322   ciInstanceKlass* StringBuffer_klass() {
 323     return _StringBuffer;
 324   }
 325   ciInstanceKlass* Integer_klass() {
 326     return _Integer;
 327   }
 328   ciInstance* NullPointerException_instance() {
 329     assert(_NullPointerException_instance != NULL, "initialization problem");
 330     return _NullPointerException_instance;
 331   }
 332   ciInstance* ArithmeticException_instance() {
 333     assert(_ArithmeticException_instance != NULL, "initialization problem");
 334     return _ArithmeticException_instance;
 335   }
 336 
 337   // Lazy constructors:
 338   ciInstance* ArrayIndexOutOfBoundsException_instance();
 339   ciInstance* ArrayStoreException_instance();
 340   ciInstance* ClassCastException_instance();
 341 
 342   ciInstance* the_null_string();
 343   ciInstance* the_min_jint_string();
 344 
 345   static ciSymbol* unloaded_cisymbol() {
 346     return _unloaded_cisymbol;
 347   }
 348   static ciObjArrayKlass* unloaded_ciobjarrayklass() {
 349     return _unloaded_ciobjarrayklass;
 350   }
 351   static ciInstanceKlass* unloaded_ciinstance_klass() {
 352     return _unloaded_ciinstance_klass;
 353   }
 354 
 355   ciKlass*  find_system_klass(ciSymbol* klass_name);
 356   // Note:  To find a class from its name string, use ciSymbol::make,
 357   // but consider adding to vmSymbols.hpp instead.
 358 
 359   // Use this to make a holder for non-perm compile time constants.
 360   // The resulting array is guaranteed to satisfy "can_be_constant".
 361   ciArray*  make_system_array(GrowableArray<ciObject*>* objects);
 362 
 363   // converts the ciKlass* representing the holder of a method into a
 364   // ciInstanceKlass*.  This is needed since the holder of a method in
 365   // the bytecodes could be an array type.  Basically this converts
 366   // array types into java/lang/Object and other types stay as they are.
 367   static ciInstanceKlass* get_instance_klass_for_declared_method_holder(ciKlass* klass);
 368 
 369   // Return the machine-level offset of o, which must be an element of a.
 370   // This may be used to form constant-loading expressions in lieu of simpler encodings.
 371   int       array_element_offset_in_bytes(ciArray* a, ciObject* o);
 372 
 373   // Access to the compile-lifetime allocation arena.
 374   Arena*    arena() { return _arena; }
 375 
 376   // What is the current compilation environment?
 377   static ciEnv* current() { return CompilerThread::current()->env(); }
 378 
 379   // Overload with current thread argument
 380   static ciEnv* current(CompilerThread *thread) { return thread->env(); }
 381 
 382   // Per-compiler data.  (Used by C2 to publish the Compile* pointer.)
 383   void* compiler_data() { return _compiler_data; }
 384   void set_compiler_data(void* x) { _compiler_data = x; }
 385 
 386   // Notice that a method has been inlined in the current compile;
 387   // used only for statistics.
 388   void notice_inlined_method(ciMethod* method);
 389 
 390   // Total number of bytecodes in inlined methods in this compile
 391   int num_inlined_bytecodes() const;
 392 
 393   // Output stream for logging compilation info.
 394   CompileLog* log() { return _log; }
 395   void set_log(CompileLog* log) { _log = log; }
 396 
 397   // Check for changes to the system dictionary during compilation
 398   bool system_dictionary_modification_counter_changed();
 399 
 400   void record_failure(const char* reason);
 401   void record_method_not_compilable(const char* reason, bool all_tiers = true);
 402   void record_out_of_memory_failure();
 403 };