1 /*
2 * Copyright (c) 1999, 2026, 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
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 ciInstance* _NullPointerException_instance;
98 ciInstance* _ArithmeticException_instance;
99 ciInstance* _ArrayIndexOutOfBoundsException_instance;
100 ciInstance* _ArrayStoreException_instance;
101 ciInstance* _ClassCastException_instance;
102
103 ciInstance* _the_null_string; // The Java string "null"
104 ciInstance* _the_min_jint_string; // The Java string "-2147483648"
105
106 // Look up a klass by name from a particular class loader (the accessor's).
107 // If require_local, result must be defined in that class loader, or null.
108 // If !require_local, a result from remote class loader may be reported,
109 // if sufficient class loader constraints exist such that initiating
110 // a class loading request from the given loader is bound to return
111 // the class defined in the remote loader (or throw an error).
112 //
113 // Return an unloaded klass if !require_local and no class at all is found.
114 //
115 // The CI treats a klass as loaded if it is consistently defined in
116 // another loader, even if it hasn't yet been loaded in all loaders
117 // that could potentially see it via delegation.
118 ciKlass* get_klass_by_name(ciKlass* accessing_klass,
119 ciSymbol* klass_name,
120 bool require_local);
121
122 // Constant pool access.
123 ciKlass* get_klass_by_index(const constantPoolHandle& cpool,
124 int klass_index,
125 bool& is_accessible,
126 ciInstanceKlass* loading_klass);
127 ciConstant get_constant_by_index(const constantPoolHandle& cpool,
128 int pool_index, int cache_index,
129 ciInstanceKlass* accessor);
130 ciField* get_field_by_index(ciInstanceKlass* loading_klass,
131 int field_index, Bytecodes::Code bc);
132 ciMethod* get_method_by_index(const constantPoolHandle& cpool,
133 int method_index, Bytecodes::Code bc,
134 ciInstanceKlass* loading_klass);
135
136 // Implementation methods for loading and constant pool access.
137 ciKlass* get_klass_by_name_impl(ciKlass* accessing_klass,
138 const constantPoolHandle& cpool,
139 ciSymbol* klass_name,
140 bool require_local);
141 ciKlass* get_klass_by_index_impl(const constantPoolHandle& cpool,
142 int klass_index,
143 bool& is_accessible,
144 ciInstanceKlass* loading_klass);
145 ciConstant get_constant_by_index_impl(const constantPoolHandle& cpool,
146 int pool_index, int cache_index,
147 ciInstanceKlass* loading_klass);
148 ciField* get_field_by_index_impl(ciInstanceKlass* loading_klass,
149 int field_index, Bytecodes::Code bc);
150 ciMethod* get_method_by_index_impl(const constantPoolHandle& cpool,
151 int method_index, Bytecodes::Code bc,
152 ciInstanceKlass* loading_klass);
153
154 // Helper methods
155 bool check_klass_accessibility(ciKlass* accessing_klass,
156 Klass* resolved_klass);
157 Method* lookup_method(ciInstanceKlass* accessor,
158 ciKlass* holder,
159 Symbol* name,
160 Symbol* sig,
161 Bytecodes::Code bc,
162 constantTag tag);
163
164 ciConstant unbox_primitive_value(ciObject* cibox, BasicType expected_bt = T_ILLEGAL);
165 ciConstant get_resolved_constant(const constantPoolHandle& cpool, int obj_index);
166
167 // Get a ciObject from the object factory. Ensures uniqueness
168 // of ciObjects.
169 ciObject* get_object(oop o) {
170 if (o == nullptr) {
171 return _null_object_instance;
172 } else {
173 return _factory->get(o);
174 }
175 }
176
177 ciSymbol* get_symbol(Symbol* o) {
178 if (o == nullptr) {
179 ShouldNotReachHere();
180 return nullptr;
181 } else {
182 return _factory->get_symbol(o);
183 }
184 }
185
186 ciMetadata* get_metadata(Metadata* o) {
187 if (o == nullptr) {
188 return nullptr;
189 } else {
190 return _factory->get_metadata(o);
191 }
192 }
193
194 ciMetadata* cached_metadata(Metadata* o) {
195 return _factory->cached_metadata(o);
196 }
197
198 ciInstance* get_instance(oop o) {
199 if (o == nullptr) return nullptr;
200 return get_object(o)->as_instance();
201 }
202 ciObjArrayKlass* get_obj_array_klass(Klass* o) {
203 if (o == nullptr) return nullptr;
204 return get_metadata(o)->as_obj_array_klass();
205 }
206 ciTypeArrayKlass* get_type_array_klass(Klass* o) {
207 if (o == nullptr) return nullptr;
208 return get_metadata(o)->as_type_array_klass();
209 }
210 ciKlass* get_klass(Klass* o) {
211 if (o == nullptr) return nullptr;
212 return get_metadata(o)->as_klass();
213 }
214 ciInstanceKlass* get_instance_klass(Klass* o) {
215 if (o == nullptr) return nullptr;
216 return get_metadata(o)->as_instance_klass();
217 }
218 ciMethod* get_method(Method* o) {
219 if (o == nullptr) return nullptr;
220 return get_metadata(o)->as_method();
221 }
222 ciMethodData* get_method_data(MethodData* o) {
223 if (o == nullptr) return nullptr;
224 return get_metadata(o)->as_method_data();
225 }
226
227 ciMethod* get_method_from_handle(Method* method);
228
229 // Get a ciMethod representing either an unfound method or
230 // a method with an unloaded holder. Ensures uniqueness of
231 // the result.
232 ciMethod* get_unloaded_method(ciKlass* holder,
233 ciSymbol* name,
234 ciSymbol* signature,
235 ciInstanceKlass* accessor) {
236 ciInstanceKlass* declared_holder = get_instance_klass_for_declared_method_holder(holder);
237 return _factory->get_unloaded_method(declared_holder, name, signature, accessor);
238 }
239 InstanceKlass::ClassState get_cached_init_state(uint id) {
240 return (InstanceKlass::ClassState)_factory->cached_init_state(id);
241 }
242
243 // Get a ciKlass representing an unloaded klass.
244 // Ensures uniqueness of the result.
245 ciKlass* get_unloaded_klass(ciKlass* accessing_klass,
246 ciSymbol* name) {
247 return _factory->get_unloaded_klass(accessing_klass, name, true);
248 }
249
250 // Get a ciKlass representing an unloaded klass mirror.
251 // Result is not necessarily unique, but will be unloaded.
252 ciInstance* get_unloaded_klass_mirror(ciKlass* type) {
253 return _factory->get_unloaded_klass_mirror(type);
254 }
255
256 // Get a ciInstance representing an unresolved method handle constant.
257 ciInstance* get_unloaded_method_handle_constant(ciKlass* holder,
258 ciSymbol* name,
259 ciSymbol* signature,
260 int ref_kind) {
261 return _factory->get_unloaded_method_handle_constant(holder, name, signature, ref_kind);
262 }
263
264 // Get a ciInstance representing an unresolved method type constant.
265 ciInstance* get_unloaded_method_type_constant(ciSymbol* signature) {
266 return _factory->get_unloaded_method_type_constant(signature);
267 }
268
269 // See if we already have an unloaded klass for the given name
270 // or return null if not.
271 ciKlass *check_get_unloaded_klass(ciKlass* accessing_klass, ciSymbol* name) {
272 return _factory->get_unloaded_klass(accessing_klass, name, false);
273 }
274
275 // Get a ciReturnAddress corresponding to the given bci.
276 // Ensures uniqueness of the result.
277 ciReturnAddress* get_return_address(int bci) {
278 return _factory->get_return_address(bci);
279 }
280
281 // Get a ciMethodData representing the methodData for a method
282 // with none.
283 ciMethodData* get_empty_methodData() {
284 return _factory->get_empty_methodData();
285 }
286
287 // General utility : get a buffer of some required length.
288 // Used in symbol creation.
289 char* name_buffer(int req_len);
290
291 // Is this thread currently in the VM state?
292 static bool is_in_vm();
293
294 // Helper routine for determining the validity of a compilation with
295 // respect to method dependencies (e.g. concurrent class loading).
296 void validate_compile_task_dependencies(ciMethod* target);
297 public:
298 enum {
299 MethodCompilable,
300 MethodCompilable_not_at_tier,
301 MethodCompilable_never
302 };
303
304 ciEnv(CompileTask* task);
305 // Used only during initialization of the ci
306 ciEnv(Arena* arena);
307 ~ciEnv();
308
309 OopRecorder* oop_recorder() { return _oop_recorder; }
310 void set_oop_recorder(OopRecorder* r) { _oop_recorder = r; }
311
312 DebugInformationRecorder* debug_info() { return _debug_info; }
313 void set_debug_info(DebugInformationRecorder* i) { _debug_info = i; }
314
315 Dependencies* dependencies() { return _dependencies; }
316 void set_dependencies(Dependencies* d) { _dependencies = d; }
317
318 // This is true if the compilation is not going to produce code.
319 // (It is reasonable to retry failed compilations.)
320 bool failing() const { return _failure_reason.get() != nullptr; }
321
322 // Reason this compilation is failing, such as "too many basic blocks".
323 const char* failure_reason() const { return _failure_reason.get(); }
324
325 // Return state of appropriate compatibility
326 int compilable() { return _compilable; }
327
328 const char* retry_message() const {
329 switch (_compilable) {
330 case ciEnv::MethodCompilable_not_at_tier:
331 return "retry at different tier";
332 case ciEnv::MethodCompilable_never:
333 return "not retryable";
334 case ciEnv::MethodCompilable:
335 return nullptr;
336 default:
337 ShouldNotReachHere();
338 return nullptr;
339 }
340 }
341
342 bool break_at_compile() { return _break_at_compile; }
343 void set_break_at_compile(bool z) { _break_at_compile = z; }
344
345 // Cache Jvmti state
346 bool cache_jvmti_state();
347 bool jvmti_state_changed() const;
348 bool should_retain_local_variables() const {
349 return _jvmti_can_access_local_variables || _jvmti_can_pop_frame;
350 }
351 bool jvmti_can_hotswap_or_post_breakpoint() const { return _jvmti_can_hotswap_or_post_breakpoint; }
352 bool jvmti_can_post_on_exceptions() const { return _jvmti_can_post_on_exceptions; }
353 bool jvmti_can_get_owned_monitor_info() const { return _jvmti_can_get_owned_monitor_info; }
354 bool jvmti_can_walk_any_space() const { return _jvmti_can_walk_any_space; }
355
356 // Cache DTrace flags
357 void cache_dtrace_flags();
358 bool dtrace_method_probes() const { return _dtrace_method_probes; }
359 bool dtrace_alloc_probes() const { return _dtrace_alloc_probes; }
360
361 // The compiler task which has created this env.
362 // May be useful to find out compile_id, comp_level, etc.
363 CompileTask* task() const { return _task; }
364
365 // Handy forwards to the task:
366 int comp_level(); // task()->comp_level()
367 int compile_id(); // task()->compile_id()
368
369 // Register the result of a compilation.
370 void register_method(ciMethod* target,
371 int entry_bci,
372 CodeOffsets* offsets,
373 int orig_pc_offset,
374 CodeBuffer* code_buffer,
375 int frame_words,
376 OopMapSet* oop_map_set,
377 ExceptionHandlerTable* handler_table,
378 ImplicitExceptionTable* inc_table,
379 AbstractCompiler* compiler,
380 bool has_unsafe_access,
381 bool has_wide_vectors,
382 bool has_monitors,
383 bool has_scoped_access,
384 int immediate_oops_patched);
385
386 // Access to certain well known ciObjects.
387 #define VM_CLASS_FUNC(name, ignore_s) \
388 ciInstanceKlass* name() { \
389 return _##name;\
390 }
391 VM_CLASSES_DO(VM_CLASS_FUNC)
392 #undef VM_CLASS_FUNC
393
394 ciInstance* NullPointerException_instance() {
395 assert(_NullPointerException_instance != nullptr, "initialization problem");
396 return _NullPointerException_instance;
397 }
398 ciInstance* ArithmeticException_instance() {
399 assert(_ArithmeticException_instance != nullptr, "initialization problem");
400 return _ArithmeticException_instance;
401 }
402 ciInstance* ArrayIndexOutOfBoundsException_instance() {
403 assert(_ArrayIndexOutOfBoundsException_instance != nullptr, "initialization problem");
404 return _ArrayIndexOutOfBoundsException_instance;
405 }
406 ciInstance* ArrayStoreException_instance() {
407 assert(_ArrayStoreException_instance != nullptr, "initialization problem");
408 return _ArrayStoreException_instance;
409 }
410 ciInstance* ClassCastException_instance() {
411 assert(_ClassCastException_instance != nullptr, "initialization problem");
412 return _ClassCastException_instance;
413 }
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 const char *dyno_name(const InstanceKlass* ik) const;
507 const char *replay_name(const InstanceKlass* ik) const;
508 const char *replay_name(ciKlass* i) const;
509
510 void record_lambdaform(Thread* thread, oop obj);
511 void record_member(Thread* thread, oop obj);
512 void record_mh(Thread* thread, oop obj);
513 void record_call_site_obj(Thread* thread, oop obj);
514 void record_call_site_method(Thread* thread, Method* adapter);
515 void process_invokedynamic(const constantPoolHandle &cp, int index, JavaThread* thread);
516 void process_invokehandle(const constantPoolHandle &cp, int index, JavaThread* thread);
517 void find_dynamic_call_sites();
518 };
519
520 #endif // SHARE_CI_CIENV_HPP