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