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