1 /*
2 * Copyright (c) 1999, 2022, 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_extended_probes;
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 static jobject _ArrayIndexOutOfBoundsException_handle;
98 static jobject _ArrayStoreException_handle;
99 static jobject _ClassCastException_handle;
100
101 ciInstance* _NullPointerException_instance;
102 ciInstance* _ArithmeticException_instance;
103 ciInstance* _ArrayIndexOutOfBoundsException_instance;
104 ciInstance* _ArrayStoreException_instance;
105 ciInstance* _ClassCastException_instance;
106
107 ciInstance* _the_null_string; // The Java string "null"
108 ciInstance* _the_min_jint_string; // The Java string "-2147483648"
109
110 // Look up a klass by name from a particular class loader (the accessor's).
111 // If require_local, result must be defined in that class loader, or NULL.
112 // If !require_local, a result from remote class loader may be reported,
113 // if sufficient class loader constraints exist such that initiating
114 // a class loading request from the given loader is bound to return
115 // the class defined in the remote loader (or throw an error).
116 //
117 // Return an unloaded klass if !require_local and no class at all is found.
118 //
119 // The CI treats a klass as loaded if it is consistently defined in
120 // another loader, even if it hasn't yet been loaded in all loaders
121 // that could potentially see it via delegation.
122 ciKlass* get_klass_by_name(ciKlass* accessing_klass,
123 ciSymbol* klass_name,
124 bool require_local);
125
126 // Constant pool access.
127 ciKlass* get_klass_by_index(const constantPoolHandle& cpool,
128 int klass_index,
129 bool& is_accessible,
130 ciInstanceKlass* loading_klass);
131 ciConstant get_constant_by_index(const constantPoolHandle& cpool,
132 int pool_index, int cache_index,
133 ciInstanceKlass* accessor);
134 ciField* get_field_by_index(ciInstanceKlass* loading_klass,
135 int field_index);
136 ciMethod* get_method_by_index(const constantPoolHandle& cpool,
137 int method_index, Bytecodes::Code bc,
138 ciInstanceKlass* loading_klass);
139 bool has_Q_signature(const constantPoolHandle& cpool,
140 int klass_index);
141
142 // Implementation methods for loading and constant pool access.
143 ciKlass* get_klass_by_name_impl(ciKlass* accessing_klass,
144 const constantPoolHandle& cpool,
145 ciSymbol* klass_name,
146 bool require_local);
147 ciKlass* get_klass_by_index_impl(const constantPoolHandle& cpool,
148 int klass_index,
149 bool& is_accessible,
150 ciInstanceKlass* loading_klass);
151 ciConstant get_constant_by_index_impl(const constantPoolHandle& cpool,
152 int pool_index, int cache_index,
153 ciInstanceKlass* loading_klass);
154 ciField* get_field_by_index_impl(ciInstanceKlass* loading_klass,
155 int field_index);
156 ciMethod* get_method_by_index_impl(const constantPoolHandle& cpool,
157 int method_index, Bytecodes::Code bc,
158 ciInstanceKlass* loading_klass);
159
160 // Helper methods
161 bool check_klass_accessibility(ciKlass* accessing_klass,
162 Klass* resolved_klass);
163 Method* lookup_method(ciInstanceKlass* accessor,
164 ciKlass* holder,
165 Symbol* name,
166 Symbol* sig,
167 Bytecodes::Code bc,
168 constantTag tag);
169
170 ciConstant unbox_primitive_value(ciObject* cibox, BasicType expected_bt = T_ILLEGAL);
171 ciConstant get_resolved_constant(const constantPoolHandle& cpool, int obj_index);
172
173 // Get a ciObject from the object factory. Ensures uniqueness
174 // of ciObjects.
175 ciObject* get_object(oop o) {
176 if (o == NULL) {
177 return _null_object_instance;
178 } else {
179 return _factory->get(o);
180 }
181 }
182
183 ciSymbol* get_symbol(Symbol* o) {
184 if (o == NULL) {
185 ShouldNotReachHere();
186 return NULL;
187 } else {
188 return _factory->get_symbol(o);
189 }
190 }
191
192 ciMetadata* get_metadata(Metadata* o) {
193 if (o == NULL) {
194 return NULL;
195 } else {
196 return _factory->get_metadata(o);
197 }
198 }
199
200 ciMetadata* cached_metadata(Metadata* o) {
201 return _factory->cached_metadata(o);
202 }
203
204 ciInstance* get_instance(oop o) {
205 if (o == NULL) return NULL;
206 return get_object(o)->as_instance();
207 }
208 ciFlatArrayKlass* get_flat_array_klass(Klass* o) {
209 if (o == NULL) return NULL;
210 return get_metadata(o)->as_flat_array_klass();
211 }
212 ciObjArrayKlass* get_obj_array_klass(Klass* o) {
213 if (o == NULL) return NULL;
214 return get_metadata(o)->as_obj_array_klass();
215 }
216 ciTypeArrayKlass* get_type_array_klass(Klass* o) {
217 if (o == NULL) return NULL;
218 return get_metadata(o)->as_type_array_klass();
219 }
220 ciKlass* get_klass(Klass* o) {
221 if (o == NULL) return NULL;
222 return get_metadata(o)->as_klass();
223 }
224 ciInstanceKlass* get_instance_klass(Klass* o) {
225 if (o == NULL) return NULL;
226 return get_metadata(o)->as_instance_klass();
227 }
228 ciMethod* get_method(Method* o) {
229 if (o == NULL) return NULL;
230 return get_metadata(o)->as_method();
231 }
232 ciMethodData* get_method_data(MethodData* o) {
233 if (o == NULL) return NULL;
234 return get_metadata(o)->as_method_data();
235 }
236
237 ciMethod* get_method_from_handle(Method* method);
238
239 ciInstance* get_or_create_exception(jobject& handle, Symbol* name);
240
241 // Get a ciMethod representing either an unfound method or
242 // a method with an unloaded holder. Ensures uniqueness of
243 // the result.
244 ciMethod* get_unloaded_method(ciKlass* holder,
245 ciSymbol* name,
246 ciSymbol* signature,
247 ciInstanceKlass* accessor) {
248 ciInstanceKlass* declared_holder = get_instance_klass_for_declared_method_holder(holder);
249 return _factory->get_unloaded_method(declared_holder, name, signature, accessor);
250 }
251
252 // Get a ciKlass representing an unloaded klass.
253 // Ensures uniqueness of the result.
254 ciKlass* get_unloaded_klass(ciKlass* accessing_klass,
255 ciSymbol* name) {
256 return _factory->get_unloaded_klass(accessing_klass, name, true);
257 }
258
259 // Get a ciKlass representing an unloaded klass mirror.
260 // Result is not necessarily unique, but will be unloaded.
261 ciInstance* get_unloaded_klass_mirror(ciKlass* type) {
262 return _factory->get_unloaded_klass_mirror(type);
263 }
264
265 // Get a ciInstance representing an unresolved method handle constant.
266 ciInstance* get_unloaded_method_handle_constant(ciKlass* holder,
267 ciSymbol* name,
268 ciSymbol* signature,
269 int ref_kind) {
270 return _factory->get_unloaded_method_handle_constant(holder, name, signature, ref_kind);
271 }
272
273 // Get a ciInstance representing an unresolved method type constant.
274 ciInstance* get_unloaded_method_type_constant(ciSymbol* signature) {
275 return _factory->get_unloaded_method_type_constant(signature);
276 }
277
278 // See if we already have an unloaded klass for the given name
279 // or return NULL if not.
280 ciKlass *check_get_unloaded_klass(ciKlass* accessing_klass, ciSymbol* name) {
281 return _factory->get_unloaded_klass(accessing_klass, name, false);
282 }
283
284 // Get a ciReturnAddress corresponding to the given bci.
285 // Ensures uniqueness of the result.
286 ciReturnAddress* get_return_address(int bci) {
287 return _factory->get_return_address(bci);
288 }
289
290 // Get a ciMethodData representing the methodData for a method
291 // with none.
292 ciMethodData* get_empty_methodData() {
293 return _factory->get_empty_methodData();
294 }
295
296 // General utility : get a buffer of some required length.
297 // Used in symbol creation.
298 char* name_buffer(int req_len);
299
300 // Is this thread currently in the VM state?
301 static bool is_in_vm();
302
303 // Helper routine for determining the validity of a compilation with
304 // respect to method dependencies (e.g. concurrent class loading).
305 void validate_compile_task_dependencies(ciMethod* target);
306 public:
307 enum {
308 MethodCompilable,
309 MethodCompilable_not_at_tier,
310 MethodCompilable_never
311 };
312
313 ciEnv(CompileTask* task);
314 // Used only during initialization of the ci
315 ciEnv(Arena* arena);
316 ~ciEnv();
317
318 OopRecorder* oop_recorder() { return _oop_recorder; }
319 void set_oop_recorder(OopRecorder* r) { _oop_recorder = r; }
320
321 DebugInformationRecorder* debug_info() { return _debug_info; }
322 void set_debug_info(DebugInformationRecorder* i) { _debug_info = i; }
323
324 Dependencies* dependencies() { return _dependencies; }
325 void set_dependencies(Dependencies* d) { _dependencies = d; }
326
327 // This is true if the compilation is not going to produce code.
328 // (It is reasonable to retry failed compilations.)
329 bool failing() { return _failure_reason != NULL; }
330
331 // Reason this compilation is failing, such as "too many basic blocks".
332 const char* failure_reason() { return _failure_reason; }
333
334 // Return state of appropriate compatibility
335 int compilable() { return _compilable; }
336
337 const char* retry_message() const {
338 switch (_compilable) {
339 case ciEnv::MethodCompilable_not_at_tier:
340 return "retry at different tier";
341 case ciEnv::MethodCompilable_never:
342 return "not retryable";
343 case ciEnv::MethodCompilable:
344 return NULL;
345 default:
346 ShouldNotReachHere();
347 return NULL;
348 }
349 }
350
351 bool break_at_compile() { return _break_at_compile; }
352 void set_break_at_compile(bool z) { _break_at_compile = z; }
353
354 // Cache Jvmti state
355 bool cache_jvmti_state();
356 bool jvmti_state_changed() const;
357 bool should_retain_local_variables() const {
358 return _jvmti_can_access_local_variables || _jvmti_can_pop_frame;
359 }
360 bool jvmti_can_hotswap_or_post_breakpoint() const { return _jvmti_can_hotswap_or_post_breakpoint; }
361 bool jvmti_can_post_on_exceptions() const { return _jvmti_can_post_on_exceptions; }
362 bool jvmti_can_get_owned_monitor_info() const { return _jvmti_can_get_owned_monitor_info; }
363 bool jvmti_can_walk_any_space() const { return _jvmti_can_walk_any_space; }
364
365 // Cache DTrace flags
366 void cache_dtrace_flags();
367 bool dtrace_extended_probes() const { return _dtrace_extended_probes; }
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() { return _task; }
374
375 // Handy forwards to the task:
376 int comp_level(); // task()->comp_level()
377 uint compile_id(); // task()->compile_id()
378
379 // Register the result of a compilation.
380 void register_method(ciMethod* target,
381 int entry_bci,
382 CodeOffsets* offsets,
383 int orig_pc_offset,
384 CodeBuffer* code_buffer,
385 int frame_words,
386 OopMapSet* oop_map_set,
387 ExceptionHandlerTable* handler_table,
388 ImplicitExceptionTable* inc_table,
389 AbstractCompiler* compiler,
390 bool has_unsafe_access,
391 bool has_wide_vectors,
392 bool has_monitors,
393 int immediate_oops_patched,
394 RTMState rtm_state = NoRTM);
395
396 // Access to certain well known ciObjects.
397 #define VM_CLASS_FUNC(name, ignore_s) \
398 ciInstanceKlass* name() { \
399 return _##name;\
400 }
401 VM_CLASSES_DO(VM_CLASS_FUNC)
402 #undef VM_CLASS_FUNC
403
404 ciInstance* NullPointerException_instance() {
405 assert(_NullPointerException_instance != NULL, "initialization problem");
406 return _NullPointerException_instance;
407 }
408 ciInstance* ArithmeticException_instance() {
409 assert(_ArithmeticException_instance != NULL, "initialization problem");
410 return _ArithmeticException_instance;
411 }
412
413 // Lazy constructors:
414 ciInstance* ArrayIndexOutOfBoundsException_instance();
415 ciInstance* ArrayStoreException_instance();
416 ciInstance* ClassCastException_instance();
417
418 ciInstance* the_null_string();
419 ciInstance* the_min_jint_string();
420
421 static ciSymbol* unloaded_cisymbol() {
422 return _unloaded_cisymbol;
423 }
424 static ciObjArrayKlass* unloaded_ciobjarrayklass() {
425 return _unloaded_ciobjarrayklass;
426 }
427 static ciInstanceKlass* unloaded_ciinstance_klass() {
428 return _unloaded_ciinstance_klass;
429 }
430 ciInstance* unloaded_ciinstance();
431
432 ciInstanceKlass* get_box_klass_for_primitive_type(BasicType type);
433
434 ciKlass* find_system_klass(ciSymbol* klass_name);
435
436 // Note: To find a class from its name string, use ciSymbol::make,
437 // but consider adding to vmSymbols.hpp instead.
438
439 // converts the ciKlass* representing the holder of a method into a
440 // ciInstanceKlass*. This is needed since the holder of a method in
441 // the bytecodes could be an array type. Basically this converts
442 // array types into java/lang/Object and other types stay as they are.
443 static ciInstanceKlass* get_instance_klass_for_declared_method_holder(ciKlass* klass);
444
445 // Access to the compile-lifetime allocation arena.
446 Arena* arena() { return _arena; }
447
448 // What is the current compilation environment?
449 static ciEnv* current() { return CompilerThread::current()->env(); }
450
451 // Overload with current thread argument
452 static ciEnv* current(CompilerThread *thread) { return thread->env(); }
453
454 // Per-compiler data. (Used by C2 to publish the Compile* pointer.)
455 void* compiler_data() { return _compiler_data; }
456 void set_compiler_data(void* x) { _compiler_data = x; }
457
458 // Notice that a method has been inlined in the current compile;
459 // used only for statistics.
460 void notice_inlined_method(ciMethod* method);
461
462 // Total number of bytecodes in inlined methods in this compile
463 int num_inlined_bytecodes() const;
464
465 // Output stream for logging compilation info.
466 CompileLog* log() { return _log; }
467 void set_log(CompileLog* log) { _log = log; }
468
469 void record_failure(const char* reason); // Record failure and report later
470 void report_failure(const char* reason); // Report failure immediately
471 void record_method_not_compilable(const char* reason, bool all_tiers = false);
472 void record_out_of_memory_failure();
473
474 // RedefineClasses support
475 void metadata_do(MetadataClosure* f) { _factory->metadata_do(f); }
476
477 // Replay support
478 private:
479 static int klass_compare(const InstanceKlass* const &ik1, const InstanceKlass* const &ik2) {
480 if (ik1 > ik2) {
481 return 1;
482 } else if (ik1 < ik2) {
483 return -1;
484 } else {
485 return 0;
486 }
487 }
488 bool dyno_loc(const InstanceKlass* ik, const char *&loc) const;
489 void set_dyno_loc(const InstanceKlass* ik);
490 void record_best_dyno_loc(const InstanceKlass* ik);
491 bool print_dyno_loc(outputStream* out, const InstanceKlass* ik) const;
492
493 GrowableArray<const InstanceKlass*>* _dyno_klasses;
494 GrowableArray<const char *>* _dyno_locs;
495
496 #define MAX_DYNO_NAME_LENGTH 1024
497 char _dyno_name[MAX_DYNO_NAME_LENGTH+1];
498
499 public:
500 // Dump the compilation replay data for the ciEnv to the stream.
501 void dump_replay_data(int compile_id);
502 void dump_inline_data(int compile_id);
503 void dump_replay_data(outputStream* out);
504 void dump_replay_data_unsafe(outputStream* out);
505 void dump_replay_data_helper(outputStream* out);
506 void dump_compile_data(outputStream* out);
507
508 ciWrapper* make_null_free_wrapper(ciType* type) {
509 return _factory->make_null_free_wrapper(type);
510 }
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
526 #endif // SHARE_CI_CIENV_HPP