ciEnv.hpp revision 3064:aa3d708d67c4
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 37class CompileTask; 38 39// ciEnv 40// 41// This class is the top level broker for requests from the compiler 42// to the VM. 43class ciEnv : StackObj { 44 CI_PACKAGE_ACCESS_TO 45 46 friend class CompileBroker; 47 friend class Dependencies; // for get_object, during logging 48 49private: 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 ciInstanceKlass* accessor); 158 159 // Helper methods 160 bool check_klass_accessibility(ciKlass* accessing_klass, 161 klassOop resolved_klassOop); 162 methodOop lookup_method(instanceKlass* accessor, 163 instanceKlass* holder, 164 Symbol* name, 165 Symbol* sig, 166 Bytecodes::Code bc); 167 168 // Get a ciObject from the object factory. Ensures uniqueness 169 // of ciObjects. 170 ciObject* get_object(oop o) { 171 if (o == NULL) { 172 return _null_object_instance; 173 } else { 174 return _factory->get(o); 175 } 176 } 177 178 ciSymbol* get_symbol(Symbol* o) { 179 if (o == NULL) { 180 ShouldNotReachHere(); 181 return NULL; 182 } else { 183 return _factory->get_symbol(o); 184 } 185 } 186 187 ciMethod* get_method_from_handle(jobject method); 188 189 ciInstance* get_or_create_exception(jobject& handle, Symbol* name); 190 191 // Get a ciMethod representing either an unfound method or 192 // a method with an unloaded holder. Ensures uniqueness of 193 // the result. 194 ciMethod* get_unloaded_method(ciInstanceKlass* holder, 195 ciSymbol* name, 196 ciSymbol* signature, 197 ciInstanceKlass* accessor) { 198 return _factory->get_unloaded_method(holder, name, signature, accessor); 199 } 200 201 // Get a ciKlass representing an unloaded klass. 202 // Ensures uniqueness of the result. 203 ciKlass* get_unloaded_klass(ciKlass* accessing_klass, 204 ciSymbol* name) { 205 return _factory->get_unloaded_klass(accessing_klass, name, true); 206 } 207 208 // Get a ciKlass representing an unloaded klass mirror. 209 // Result is not necessarily unique, but will be unloaded. 210 ciInstance* get_unloaded_klass_mirror(ciKlass* type) { 211 return _factory->get_unloaded_klass_mirror(type); 212 } 213 214 // Get a ciInstance representing an unresolved method handle constant. 215 ciInstance* get_unloaded_method_handle_constant(ciKlass* holder, 216 ciSymbol* name, 217 ciSymbol* signature, 218 int ref_kind) { 219 return _factory->get_unloaded_method_handle_constant(holder, name, signature, ref_kind); 220 } 221 222 // Get a ciInstance representing an unresolved method type constant. 223 ciInstance* get_unloaded_method_type_constant(ciSymbol* signature) { 224 return _factory->get_unloaded_method_type_constant(signature); 225 } 226 227 // See if we already have an unloaded klass for the given name 228 // or return NULL if not. 229 ciKlass *check_get_unloaded_klass(ciKlass* accessing_klass, ciSymbol* name) { 230 return _factory->get_unloaded_klass(accessing_klass, name, false); 231 } 232 233 // Get a ciReturnAddress corresponding to the given bci. 234 // Ensures uniqueness of the result. 235 ciReturnAddress* get_return_address(int bci) { 236 return _factory->get_return_address(bci); 237 } 238 239 // Get a ciMethodData representing the methodData for a method 240 // with none. 241 ciMethodData* get_empty_methodData() { 242 return _factory->get_empty_methodData(); 243 } 244 245 // General utility : get a buffer of some required length. 246 // Used in symbol creation. 247 char* name_buffer(int req_len); 248 249 // Is this thread currently in the VM state? 250 static bool is_in_vm(); 251 252 // Helper routine for determining the validity of a compilation with 253 // respect to method dependencies (e.g. concurrent class loading). 254 void validate_compile_task_dependencies(ciMethod* target); 255 256public: 257 enum { 258 MethodCompilable, 259 MethodCompilable_not_at_tier, 260 MethodCompilable_never 261 }; 262 263 ciEnv(CompileTask* task, int system_dictionary_modification_counter); 264 // Used only during initialization of the ci 265 ciEnv(Arena* arena); 266 ~ciEnv(); 267 268 OopRecorder* oop_recorder() { return _oop_recorder; } 269 void set_oop_recorder(OopRecorder* r) { _oop_recorder = r; } 270 271 DebugInformationRecorder* debug_info() { return _debug_info; } 272 void set_debug_info(DebugInformationRecorder* i) { _debug_info = i; } 273 274 Dependencies* dependencies() { return _dependencies; } 275 void set_dependencies(Dependencies* d) { _dependencies = d; } 276 277 // This is true if the compilation is not going to produce code. 278 // (It is reasonable to retry failed compilations.) 279 bool failing() { return _failure_reason != NULL; } 280 281 // Reason this compilation is failing, such as "too many basic blocks". 282 const char* failure_reason() { return _failure_reason; } 283 284 // Return state of appropriate compilability 285 int compilable() { return _compilable; } 286 287 const char* retry_message() const { 288 switch (_compilable) { 289 case ciEnv::MethodCompilable_not_at_tier: 290 return "retry at different tier"; 291 case ciEnv::MethodCompilable_never: 292 return "not retryable"; 293 case ciEnv::MethodCompilable: 294 return NULL; 295 default: 296 ShouldNotReachHere(); 297 return NULL; 298 } 299 } 300 301 bool break_at_compile() { return _break_at_compile; } 302 void set_break_at_compile(bool z) { _break_at_compile = z; } 303 304 // Cache Jvmti state 305 void cache_jvmti_state(); 306 bool jvmti_can_hotswap_or_post_breakpoint() const { return _jvmti_can_hotswap_or_post_breakpoint; } 307 bool jvmti_can_access_local_variables() const { return _jvmti_can_access_local_variables; } 308 bool jvmti_can_post_on_exceptions() const { return _jvmti_can_post_on_exceptions; } 309 310 // Cache DTrace flags 311 void cache_dtrace_flags(); 312 bool dtrace_extended_probes() const { return _dtrace_extended_probes; } 313 bool dtrace_monitor_probes() const { return _dtrace_monitor_probes; } 314 bool dtrace_method_probes() const { return _dtrace_method_probes; } 315 bool dtrace_alloc_probes() const { return _dtrace_alloc_probes; } 316 317 // The compiler task which has created this env. 318 // May be useful to find out compile_id, comp_level, etc. 319 CompileTask* task() { return _task; } 320 // Handy forwards to the task: 321 int comp_level(); // task()->comp_level() 322 uint compile_id(); // task()->compile_id() 323 324 // Register the result of a compilation. 325 void register_method(ciMethod* target, 326 int entry_bci, 327 CodeOffsets* offsets, 328 int orig_pc_offset, 329 CodeBuffer* code_buffer, 330 int frame_words, 331 OopMapSet* oop_map_set, 332 ExceptionHandlerTable* handler_table, 333 ImplicitExceptionTable* inc_table, 334 AbstractCompiler* compiler, 335 int comp_level, 336 bool has_unsafe_access); 337 338 339 // Access to certain well known ciObjects. 340#define WK_KLASS_FUNC(name, ignore_s, ignore_o) \ 341 ciInstanceKlass* name() { \ 342 return _##name;\ 343 } 344 WK_KLASSES_DO(WK_KLASS_FUNC) 345#undef WK_KLASS_FUNC 346 347 ciInstance* NullPointerException_instance() { 348 assert(_NullPointerException_instance != NULL, "initialization problem"); 349 return _NullPointerException_instance; 350 } 351 ciInstance* ArithmeticException_instance() { 352 assert(_ArithmeticException_instance != NULL, "initialization problem"); 353 return _ArithmeticException_instance; 354 } 355 356 // Lazy constructors: 357 ciInstance* ArrayIndexOutOfBoundsException_instance(); 358 ciInstance* ArrayStoreException_instance(); 359 ciInstance* ClassCastException_instance(); 360 361 ciInstance* the_null_string(); 362 ciInstance* the_min_jint_string(); 363 364 static ciSymbol* unloaded_cisymbol() { 365 return _unloaded_cisymbol; 366 } 367 static ciObjArrayKlass* unloaded_ciobjarrayklass() { 368 return _unloaded_ciobjarrayklass; 369 } 370 static ciInstanceKlass* unloaded_ciinstance_klass() { 371 return _unloaded_ciinstance_klass; 372 } 373 374 ciKlass* find_system_klass(ciSymbol* klass_name); 375 // Note: To find a class from its name string, use ciSymbol::make, 376 // but consider adding to vmSymbols.hpp instead. 377 378 // Use this to make a holder for non-perm compile time constants. 379 // The resulting array is guaranteed to satisfy "can_be_constant". 380 ciArray* make_system_array(GrowableArray<ciObject*>* objects); 381 382 // converts the ciKlass* representing the holder of a method into a 383 // ciInstanceKlass*. This is needed since the holder of a method in 384 // the bytecodes could be an array type. Basically this converts 385 // array types into java/lang/Object and other types stay as they are. 386 static ciInstanceKlass* get_instance_klass_for_declared_method_holder(ciKlass* klass); 387 388 // Return the machine-level offset of o, which must be an element of a. 389 // This may be used to form constant-loading expressions in lieu of simpler encodings. 390 int array_element_offset_in_bytes(ciArray* a, ciObject* o); 391 392 // Access to the compile-lifetime allocation arena. 393 Arena* arena() { return _arena; } 394 395 // What is the current compilation environment? 396 static ciEnv* current() { return CompilerThread::current()->env(); } 397 398 // Overload with current thread argument 399 static ciEnv* current(CompilerThread *thread) { return thread->env(); } 400 401 // Per-compiler data. (Used by C2 to publish the Compile* pointer.) 402 void* compiler_data() { return _compiler_data; } 403 void set_compiler_data(void* x) { _compiler_data = x; } 404 405 // Notice that a method has been inlined in the current compile; 406 // used only for statistics. 407 void notice_inlined_method(ciMethod* method); 408 409 // Total number of bytecodes in inlined methods in this compile 410 int num_inlined_bytecodes() const; 411 412 // Output stream for logging compilation info. 413 CompileLog* log() { return _log; } 414 void set_log(CompileLog* log) { _log = log; } 415 416 // Check for changes to the system dictionary during compilation 417 bool system_dictionary_modification_counter_changed(); 418 419 void record_failure(const char* reason); 420 void record_method_not_compilable(const char* reason, bool all_tiers = true); 421 void record_out_of_memory_failure(); 422}; 423 424#endif // SHARE_VM_CI_CIENV_HPP 425