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/methodCounters.hpp"
38 #include "oops/methodData.hpp"
39 #include "runtime/javaThread.hpp"
40
41 class CompileTask;
42 class OopMapSet;
43 class AOTCodeEntry;
44 class AOTCodeReader;
45
46 // ciEnv
47 //
48 // This class is the top level broker for requests from the compiler
49 // to the VM.
50 class ciEnv : StackObj {
51 CI_PACKAGE_ACCESS_TO
52 friend class CompileBroker;
53 friend class Dependencies; // for get_object, during logging
54 friend class RecordLocation;
55 friend class PrepareExtraDataClosure;
56
57 private:
58 Arena* _arena; // Alias for _ciEnv_arena except in init_shared_objects()
59 Arena _ciEnv_arena;
60 ciObjectFactory* _factory;
61 OopRecorder* _oop_recorder;
62 DebugInformationRecorder* _debug_info;
63 Dependencies* _dependencies;
64 CHeapStringHolder _failure_reason;
65 bool _inc_decompile_count_on_failure;
66 int _compilable;
67 bool _break_at_compile;
68 int _num_inlined_bytecodes;
69 CompileTask* _task; // faster access to CompilerThread::task
70 CompileLog* _log; // faster access to CompilerThread::log
71 void* _compiler_data; // compiler-specific stuff, if any
72
73 char* _name_buffer;
74 int _name_buffer_len;
75
76 // Cache Jvmti state
77 uint64_t _jvmti_redefinition_count;
78 bool _jvmti_can_hotswap_or_post_breakpoint;
79 bool _jvmti_can_access_local_variables;
80 bool _jvmti_can_post_on_exceptions;
81 bool _jvmti_can_pop_frame;
82 bool _jvmti_can_get_owned_monitor_info; // includes can_get_owned_monitor_stack_depth_info
83 bool _jvmti_can_walk_any_space;
84
85 // Cache DTrace flags
86 bool _dtrace_method_probes;
87 bool _dtrace_alloc_probes;
88
89 // Distinguished instances of certain ciObjects..
90 static ciObject* _null_object_instance;
91
92 #define VM_CLASS_DECL(name, ignore_s) static ciInstanceKlass* _##name;
93 VM_CLASSES_DO(VM_CLASS_DECL)
94 #undef VM_CLASS_DECL
95
96 static ciSymbol* _unloaded_cisymbol;
97 static ciInstanceKlass* _unloaded_ciinstance_klass;
98 static ciObjArrayKlass* _unloaded_ciobjarrayklass;
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 ciObjArrayKlass* get_obj_array_klass(Klass* o) {
206 if (o == nullptr) return nullptr;
207 return get_metadata(o)->as_obj_array_klass();
208 }
209 ciTypeArrayKlass* get_type_array_klass(Klass* o) {
210 if (o == nullptr) return nullptr;
211 return get_metadata(o)->as_type_array_klass();
212 }
213 ciKlass* get_klass(Klass* o) {
214 if (o == nullptr) return nullptr;
215 return get_metadata(o)->as_klass();
216 }
217 ciInstanceKlass* get_instance_klass(Klass* o) {
218 if (o == nullptr) return nullptr;
219 return get_metadata(o)->as_instance_klass();
220 }
221 ciMethod* get_method(Method* o) {
222 if (o == nullptr) return nullptr;
223 return get_metadata(o)->as_method();
224 }
225 ciMethodData* get_method_data(MethodData* o) {
226 if (o == nullptr) return nullptr;
227 return get_metadata(o)->as_method_data();
228 }
229 ciMetadata* get_method_counters(MethodCounters* o) {
230 if (o == nullptr) return nullptr;
231 return get_metadata((Metadata*)o);
232 }
233
234 ciMethod* get_method_from_handle(Method* method);
235
236 // Get a ciMethod representing either an unfound method or
237 // a method with an unloaded holder. Ensures uniqueness of
238 // the result.
239 ciMethod* get_unloaded_method(ciKlass* holder,
240 ciSymbol* name,
241 ciSymbol* signature,
242 ciInstanceKlass* accessor) {
243 ciInstanceKlass* declared_holder = get_instance_klass_for_declared_method_holder(holder);
244 return _factory->get_unloaded_method(declared_holder, name, signature, accessor);
245 }
246
247 // Get a ciKlass representing an unloaded klass.
248 // Ensures uniqueness of the result.
249 ciKlass* get_unloaded_klass(ciKlass* accessing_klass,
250 ciSymbol* name) {
251 return _factory->get_unloaded_klass(accessing_klass, name, true);
252 }
253
254 // Get a ciKlass representing an unloaded klass mirror.
255 // Result is not necessarily unique, but will be unloaded.
256 ciInstance* get_unloaded_klass_mirror(ciKlass* type) {
257 return _factory->get_unloaded_klass_mirror(type);
258 }
259
260 // Get a ciInstance representing an unresolved method handle constant.
261 ciInstance* get_unloaded_method_handle_constant(ciKlass* holder,
262 ciSymbol* name,
263 ciSymbol* signature,
264 int ref_kind) {
265 return _factory->get_unloaded_method_handle_constant(holder, name, signature, ref_kind);
266 }
267
268 // Get a ciInstance representing an unresolved method type constant.
269 ciInstance* get_unloaded_method_type_constant(ciSymbol* signature) {
270 return _factory->get_unloaded_method_type_constant(signature);
271 }
272
273 // See if we already have an unloaded klass for the given name
274 // or return null if not.
275 ciKlass *check_get_unloaded_klass(ciKlass* accessing_klass, ciSymbol* name) {
276 return _factory->get_unloaded_klass(accessing_klass, name, false);
277 }
278
279 // Get a ciReturnAddress corresponding to the given bci.
280 // Ensures uniqueness of the result.
281 ciReturnAddress* get_return_address(int bci) {
282 return _factory->get_return_address(bci);
283 }
284
285 // Get a ciMethodData representing the methodData for a method
286 // with none.
287 ciMethodData* get_empty_methodData() {
288 return _factory->get_empty_methodData();
289 }
290
291 // General utility : get a buffer of some required length.
292 // Used in symbol creation.
293 char* name_buffer(int req_len);
294
295 // Is this thread currently in the VM state?
296 static bool is_in_vm();
297
298 // Helper routine for determining the validity of a compilation with
299 // respect to method dependencies (e.g. concurrent class loading).
300 void validate_compile_task_dependencies(ciMethod* target);
301
302 // Helper rountimes to factor out common code used by routines that register a method
303 // i.e. register_aot_method() and register_method()
304 bool is_compilation_valid(JavaThread* thread, ciMethod* target, bool install_code, bool is_loading_aot_code, bool preload);
305 void make_code_usable(JavaThread* thread, ciMethod* target, bool preload, int entry_bci, AOTCodeEntry* aot_code_entry, nmethod* nm);
306
307 public:
308 enum {
309 MethodCompilable,
310 MethodCompilable_not_at_tier,
311 MethodCompilable_never
312 };
313
314 ciEnv(CompileTask* task);
315 // Used only during initialization of the ci
316 ciEnv(Arena* arena);
317 ~ciEnv();
318
319 OopRecorder* oop_recorder() { return _oop_recorder; }
320 void set_oop_recorder(OopRecorder* r) { _oop_recorder = r; }
321
322 DebugInformationRecorder* debug_info() { return _debug_info; }
323 void set_debug_info(DebugInformationRecorder* i) { _debug_info = i; }
324
325 Dependencies* dependencies() { return _dependencies; }
326 void set_dependencies(Dependencies* d) { _dependencies = d; }
327
328 // This is true if the compilation is not going to produce code.
329 // (It is reasonable to retry failed compilations.)
330 bool failing() const { return _failure_reason.get() != nullptr; }
331
332 // Reason this compilation is failing, such as "too many basic blocks".
333 const char* failure_reason() const { return _failure_reason.get(); }
334
335 // Return state of appropriate compatibility
336 int compilable() { return _compilable; }
337
338 const char* retry_message() const {
339 switch (_compilable) {
340 case ciEnv::MethodCompilable_not_at_tier:
341 return "retry at different tier";
342 case ciEnv::MethodCompilable_never:
343 return "not retryable";
344 case ciEnv::MethodCompilable:
345 return nullptr;
346 default:
347 ShouldNotReachHere();
348 return nullptr;
349 }
350 }
351
352 bool break_at_compile() { return _break_at_compile; }
353 void set_break_at_compile(bool z) { _break_at_compile = z; }
354
355 // Cache Jvmti state
356 bool cache_jvmti_state();
357 bool jvmti_state_changed() const;
358 bool should_retain_local_variables() const {
359 return _jvmti_can_access_local_variables || _jvmti_can_pop_frame;
360 }
361 bool jvmti_can_hotswap_or_post_breakpoint() const { return _jvmti_can_hotswap_or_post_breakpoint; }
362 bool jvmti_can_post_on_exceptions() const { return _jvmti_can_post_on_exceptions; }
363 bool jvmti_can_get_owned_monitor_info() const { return _jvmti_can_get_owned_monitor_info; }
364 bool jvmti_can_walk_any_space() const { return _jvmti_can_walk_any_space; }
365
366 // Cache DTrace flags
367 void cache_dtrace_flags();
368 bool dtrace_method_probes() const { return _dtrace_method_probes; }
369 bool dtrace_alloc_probes() const { return _dtrace_alloc_probes; }
370
371 // The compiler task which has created this env.
372 // May be useful to find out compile_id, comp_level, etc.
373 CompileTask* task() const { return _task; }
374
375 // Handy forwards to the task:
376 int comp_level(); // task()->comp_level()
377 int compile_id(); // task()->compile_id()
378
379 // Register method loaded from AOT code cache
380 nmethod* register_aot_method(JavaThread* thread,
381 ciMethod* target,
382 AbstractCompiler* compiler,
383 nmethod* archived_nm,
384 address reloc_data,
385 GrowableArray<Handle>& oop_list,
386 GrowableArray<Metadata*>& metadata_list,
387 ImmutableOopMapSet* oopmaps,
388 address immutable_data,
389 GrowableArray<Handle>& reloc_imm_oop_list,
390 GrowableArray<Metadata*>& reloc_imm_metadata_list,
391 AOTCodeReader* aot_code_reader);
392
393 // Register the result of a compilation.
394 void register_method(ciMethod* target,
395 int entry_bci,
396 CodeOffsets* offsets,
397 int orig_pc_offset,
398 CodeBuffer* code_buffer,
399 int frame_words,
400 OopMapSet* oop_map_set,
401 ExceptionHandlerTable* handler_table,
402 ImplicitExceptionTable* inc_table,
403 AbstractCompiler* compiler,
404 bool has_clinit_barriers,
405 bool for_preload,
406 bool has_unsafe_access,
407 bool has_wide_vectors,
408 bool has_monitors,
409 bool has_scoped_access,
410 int immediate_oops_patched,
411 bool install_code);
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 // Replay support
502 private:
503 static int klass_compare(const InstanceKlass* const &ik1, const InstanceKlass* const &ik2) {
504 if (ik1 > ik2) {
505 return 1;
506 } else if (ik1 < ik2) {
507 return -1;
508 } else {
509 return 0;
510 }
511 }
512 bool dyno_loc(const InstanceKlass* ik, const char *&loc) const;
513 void set_dyno_loc(const InstanceKlass* ik);
514 void record_best_dyno_loc(const InstanceKlass* ik);
515 bool print_dyno_loc(outputStream* out, const InstanceKlass* ik) const;
516
517 GrowableArray<const InstanceKlass*>* _dyno_klasses;
518 GrowableArray<const char *>* _dyno_locs;
519
520 #define MAX_DYNO_NAME_LENGTH 1024
521 char _dyno_name[MAX_DYNO_NAME_LENGTH+1];
522
523 public:
524 // Dump the compilation replay data for the ciEnv to the stream.
525 void dump_replay_data(int compile_id);
526 void dump_inline_data(int compile_id);
527 void dump_replay_data(outputStream* out);
528 void dump_replay_data_unsafe(outputStream* out);
529 void dump_replay_data_helper(outputStream* out);
530 void dump_compile_data(outputStream* out);
531 void dump_replay_data_version(outputStream* out);
532
533 const char *dyno_name(const InstanceKlass* ik) const;
534 const char *replay_name(const InstanceKlass* ik) const;
535 const char *replay_name(ciKlass* i) const;
536
537 void record_lambdaform(Thread* thread, oop obj);
538 void record_member(Thread* thread, oop obj);
539 void record_mh(Thread* thread, oop obj);
540 void record_call_site_obj(Thread* thread, oop obj);
541 void record_call_site_method(Thread* thread, Method* adapter);
542 void process_invokedynamic(const constantPoolHandle &cp, int index, JavaThread* thread);
543 void process_invokehandle(const constantPoolHandle &cp, int index, JavaThread* thread);
544 void find_dynamic_call_sites();
545
546 bool is_precompile();
547 InstanceKlass::ClassState compute_init_state_for_precompiled(InstanceKlass* ik);
548 };
549
550 #endif // SHARE_CI_CIENV_HPP