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