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