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