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