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