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