1 /*
2 * Copyright (c) 1999, 2020, 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 "code/debugInfoRec.hpp"
31 #include "code/dependencies.hpp"
32 #include "code/exceptionHandlerTable.hpp"
33 #include "compiler/oopMap.hpp"
34 #include "oops/methodData.hpp"
35 #include "runtime/thread.hpp"
36
37 class CompileTask;
38
39 // ciEnv
40 //
41 // This class is the top level broker for requests from the compiler
42 // to the VM.
43 class ciEnv : StackObj {
44 CI_PACKAGE_ACCESS_TO
45
46 friend class CompileBroker;
47 friend class Dependencies; // for get_object, during logging
48 friend class PrepareExtraDataClosure;
49
50 private:
51 Arena* _arena; // Alias for _ciEnv_arena except in init_shared_objects()
52 Arena _ciEnv_arena;
53 ciObjectFactory* _factory;
54 OopRecorder* _oop_recorder;
55 DebugInformationRecorder* _debug_info;
56 Dependencies* _dependencies;
57 const char* _failure_reason;
58 bool _inc_decompile_count_on_failure;
59 int _compilable;
60 bool _break_at_compile;
61 int _num_inlined_bytecodes;
62 CompileTask* _task; // faster access to CompilerThread::task
63 CompileLog* _log; // faster access to CompilerThread::log
64 void* _compiler_data; // compiler-specific stuff, if any
65
66 char* _name_buffer;
67 int _name_buffer_len;
68
69 // Cache Jvmti state
70 uint64_t _jvmti_redefinition_count;
71 bool _jvmti_can_hotswap_or_post_breakpoint;
72 bool _jvmti_can_access_local_variables;
73 bool _jvmti_can_post_on_exceptions;
74 bool _jvmti_can_pop_frame;
75 bool _jvmti_can_get_owned_monitor_info; // includes can_get_owned_monitor_stack_depth_info
76 bool _jvmti_can_walk_any_space;
77
78 // Cache DTrace flags
79 bool _dtrace_extended_probes;
80 bool _dtrace_monitor_probes;
81 bool _dtrace_method_probes;
82 bool _dtrace_alloc_probes;
83
84 // Distinguished instances of certain ciObjects..
85 static ciObject* _null_object_instance;
86
87 #define WK_KLASS_DECL(name, ignore_s) static ciInstanceKlass* _##name;
88 WK_KLASSES_DO(WK_KLASS_DECL)
89 #undef WK_KLASS_DECL
90
91 static ciSymbol* _unloaded_cisymbol;
92 static ciInstanceKlass* _unloaded_ciinstance_klass;
93 static ciObjArrayKlass* _unloaded_ciobjarrayklass;
94
95 static jobject _ArrayIndexOutOfBoundsException_handle;
96 static jobject _ArrayStoreException_handle;
97 static jobject _ClassCastException_handle;
98
99 ciInstance* _NullPointerException_instance;
100 ciInstance* _ArithmeticException_instance;
101 ciInstance* _ArrayIndexOutOfBoundsException_instance;
102 ciInstance* _ArrayStoreException_instance;
103 ciInstance* _ClassCastException_instance;
104
105 ciInstance* _the_null_string; // The Java string "null"
106 ciInstance* _the_min_jint_string; // The Java string "-2147483648"
107
108 // Look up a klass by name from a particular class loader (the accessor's).
109 // If require_local, result must be defined in that class loader, or NULL.
110 // If !require_local, a result from remote class loader may be reported,
111 // if sufficient class loader constraints exist such that initiating
112 // a class loading request from the given loader is bound to return
113 // the class defined in the remote loader (or throw an error).
114 //
115 // Return an unloaded klass if !require_local and no class at all is found.
116 //
117 // The CI treats a klass as loaded if it is consistently defined in
118 // another loader, even if it hasn't yet been loaded in all loaders
119 // that could potentially see it via delegation.
120 ciKlass* get_klass_by_name(ciKlass* accessing_klass,
121 ciSymbol* klass_name,
122 bool require_local);
123
124 // Constant pool access.
125 ciKlass* get_klass_by_index(const constantPoolHandle& cpool,
126 int klass_index,
127 bool& is_accessible,
128 ciInstanceKlass* loading_klass);
129 ciConstant get_constant_by_index(const constantPoolHandle& cpool,
130 int pool_index, int cache_index,
131 ciInstanceKlass* accessor);
132 ciField* get_field_by_index(ciInstanceKlass* loading_klass,
133 int field_index);
134 ciMethod* get_method_by_index(const constantPoolHandle& cpool,
135 int method_index, Bytecodes::Code bc,
136 ciInstanceKlass* loading_klass);
137
138 // Implementation methods for loading and constant pool access.
139 ciKlass* get_klass_by_name_impl(ciKlass* accessing_klass,
140 const constantPoolHandle& cpool,
141 ciSymbol* klass_name,
142 bool require_local);
143 ciKlass* get_klass_by_index_impl(const constantPoolHandle& cpool,
144 int klass_index,
145 bool& is_accessible,
146 ciInstanceKlass* loading_klass);
147 ciConstant get_constant_by_index_impl(const constantPoolHandle& cpool,
148 int pool_index, int cache_index,
149 ciInstanceKlass* loading_klass);
150 ciField* get_field_by_index_impl(ciInstanceKlass* loading_klass,
151 int field_index);
152 ciMethod* get_method_by_index_impl(const constantPoolHandle& cpool,
153 int method_index, Bytecodes::Code bc,
154 ciInstanceKlass* loading_klass);
155
156 // Helper methods
157 bool check_klass_accessibility(ciKlass* accessing_klass,
158 Klass* resolved_klass);
159 Method* lookup_method(ciInstanceKlass* accessor,
160 ciKlass* holder,
161 Symbol* name,
162 Symbol* sig,
163 Bytecodes::Code bc,
164 constantTag tag);
165
166 // Get a ciObject from the object factory. Ensures uniqueness
167 // of ciObjects.
168 ciObject* get_object(oop o) {
169 if (o == NULL) {
170 return _null_object_instance;
171 } else {
172 return _factory->get(o);
173 }
174 }
175
176 ciSymbol* get_symbol(Symbol* o) {
177 if (o == NULL) {
178 ShouldNotReachHere();
179 return NULL;
180 } else {
181 return _factory->get_symbol(o);
182 }
183 }
184
185 ciMetadata* get_metadata(Metadata* o) {
186 if (o == NULL) {
187 return NULL;
188 } else {
189 return _factory->get_metadata(o);
190 }
191 }
192
193 ciMetadata* cached_metadata(Metadata* o) {
194 return _factory->cached_metadata(o);
195 }
196
197 ciInstance* get_instance(oop o) {
198 if (o == NULL) return NULL;
199 return get_object(o)->as_instance();
200 }
201 ciObjArrayKlass* get_obj_array_klass(Klass* o) {
202 if (o == NULL) return NULL;
203 return get_metadata(o)->as_obj_array_klass();
204 }
205 ciTypeArrayKlass* get_type_array_klass(Klass* o) {
206 if (o == NULL) return NULL;
207 return get_metadata(o)->as_type_array_klass();
208 }
209 ciKlass* get_klass(Klass* o) {
210 if (o == NULL) return NULL;
211 return get_metadata(o)->as_klass();
212 }
213 ciInstanceKlass* get_instance_klass(Klass* o) {
214 if (o == NULL) return NULL;
215 return get_metadata(o)->as_instance_klass();
216 }
217 ciMethod* get_method(Method* o) {
218 if (o == NULL) return NULL;
219 return get_metadata(o)->as_method();
220 }
221 ciMethodData* get_method_data(MethodData* o) {
222 if (o == NULL) return NULL;
223 return get_metadata(o)->as_method_data();
224 }
225
226 ciMethod* get_method_from_handle(Method* method);
227
228 ciInstance* get_or_create_exception(jobject& handle, Symbol* name);
229
230 // Get a ciMethod representing either an unfound method or
231 // a method with an unloaded holder. Ensures uniqueness of
232 // the result.
233 ciMethod* get_unloaded_method(ciKlass* holder,
234 ciSymbol* name,
235 ciSymbol* signature,
236 ciInstanceKlass* accessor) {
237 ciInstanceKlass* declared_holder = get_instance_klass_for_declared_method_holder(holder);
238 return _factory->get_unloaded_method(declared_holder, name, signature, accessor);
239 }
240
241 // Get a ciKlass representing an unloaded klass.
242 // Ensures uniqueness of the result.
243 ciKlass* get_unloaded_klass(ciKlass* accessing_klass,
244 ciSymbol* name) {
245 return _factory->get_unloaded_klass(accessing_klass, name, true);
246 }
247
248 // Get a ciKlass representing an unloaded klass mirror.
249 // Result is not necessarily unique, but will be unloaded.
250 ciInstance* get_unloaded_klass_mirror(ciKlass* type) {
251 return _factory->get_unloaded_klass_mirror(type);
252 }
253
254 // Get a ciInstance representing an unresolved method handle constant.
255 ciInstance* get_unloaded_method_handle_constant(ciKlass* holder,
256 ciSymbol* name,
257 ciSymbol* signature,
258 int ref_kind) {
259 return _factory->get_unloaded_method_handle_constant(holder, name, signature, ref_kind);
260 }
261
262 // Get a ciInstance representing an unresolved method type constant.
263 ciInstance* get_unloaded_method_type_constant(ciSymbol* signature) {
264 return _factory->get_unloaded_method_type_constant(signature);
265 }
266
267 // See if we already have an unloaded klass for the given name
268 // or return NULL if not.
269 ciKlass *check_get_unloaded_klass(ciKlass* accessing_klass, ciSymbol* name) {
270 return _factory->get_unloaded_klass(accessing_klass, name, false);
271 }
272
273 // Get a ciReturnAddress corresponding to the given bci.
274 // Ensures uniqueness of the result.
275 ciReturnAddress* get_return_address(int bci) {
276 return _factory->get_return_address(bci);
277 }
278
279 // Get a ciMethodData representing the methodData for a method
280 // with none.
281 ciMethodData* get_empty_methodData() {
282 return _factory->get_empty_methodData();
283 }
284
285 // General utility : get a buffer of some required length.
286 // Used in symbol creation.
287 char* name_buffer(int req_len);
288
289 // Is this thread currently in the VM state?
290 static bool is_in_vm();
291
292 // Helper routine for determining the validity of a compilation with
293 // respect to method dependencies (e.g. concurrent class loading).
294 void validate_compile_task_dependencies(ciMethod* target);
295 public:
296 enum {
297 MethodCompilable,
298 MethodCompilable_not_at_tier,
299 MethodCompilable_never
300 };
301
302 ciEnv(CompileTask* task);
303 // Used only during initialization of the ci
304 ciEnv(Arena* arena);
305 ~ciEnv();
306
307 OopRecorder* oop_recorder() { return _oop_recorder; }
308 void set_oop_recorder(OopRecorder* r) { _oop_recorder = r; }
309
310 DebugInformationRecorder* debug_info() { return _debug_info; }
311 void set_debug_info(DebugInformationRecorder* i) { _debug_info = i; }
312
313 Dependencies* dependencies() { return _dependencies; }
314 void set_dependencies(Dependencies* d) { _dependencies = d; }
315
316 // This is true if the compilation is not going to produce code.
317 // (It is reasonable to retry failed compilations.)
318 bool failing() { return _failure_reason != NULL; }
319
320 // Reason this compilation is failing, such as "too many basic blocks".
321 const char* failure_reason() { return _failure_reason; }
322
323 // Return state of appropriate compilability
324 int compilable() { return _compilable; }
325
326 const char* retry_message() const {
327 switch (_compilable) {
328 case ciEnv::MethodCompilable_not_at_tier:
329 return "retry at different tier";
330 case ciEnv::MethodCompilable_never:
331 return "not retryable";
332 case ciEnv::MethodCompilable:
333 return NULL;
334 default:
335 ShouldNotReachHere();
336 return NULL;
337 }
338 }
339
340 bool break_at_compile() { return _break_at_compile; }
341 void set_break_at_compile(bool z) { _break_at_compile = z; }
342
343 // Cache Jvmti state
344 bool cache_jvmti_state();
345 bool jvmti_state_changed() const;
346 bool should_retain_local_variables() const {
347 return _jvmti_can_access_local_variables || _jvmti_can_pop_frame;
348 }
349 bool jvmti_can_hotswap_or_post_breakpoint() const { return _jvmti_can_hotswap_or_post_breakpoint; }
350 bool jvmti_can_post_on_exceptions() const { return _jvmti_can_post_on_exceptions; }
351 bool jvmti_can_get_owned_monitor_info() const { return _jvmti_can_get_owned_monitor_info; }
352 bool jvmti_can_walk_any_space() const { return _jvmti_can_walk_any_space; }
353
354 // Cache DTrace flags
355 void cache_dtrace_flags();
356 bool dtrace_extended_probes() const { return _dtrace_extended_probes; }
357 bool dtrace_monitor_probes() const { return _dtrace_monitor_probes; }
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() { return _task; }
364
365 // Handy forwards to the task:
366 int comp_level(); // task()->comp_level()
367 uint 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 RTMState rtm_state = NoRTM);
383
384
385 // Access to certain well known ciObjects.
386 #define WK_KLASS_FUNC(name, ignore_s) \
387 ciInstanceKlass* name() { \
388 return _##name;\
389 }
390 WK_KLASSES_DO(WK_KLASS_FUNC)
391 #undef WK_KLASS_FUNC
392
393 ciInstance* NullPointerException_instance() {
394 assert(_NullPointerException_instance != NULL, "initialization problem");
395 return _NullPointerException_instance;
396 }
397 ciInstance* ArithmeticException_instance() {
398 assert(_ArithmeticException_instance != NULL, "initialization problem");
399 return _ArithmeticException_instance;
400 }
401
402 // Lazy constructors:
403 ciInstance* ArrayIndexOutOfBoundsException_instance();
404 ciInstance* ArrayStoreException_instance();
405 ciInstance* ClassCastException_instance();
406
407 ciInstance* the_null_string();
408 ciInstance* the_min_jint_string();
409
410 static ciSymbol* unloaded_cisymbol() {
411 return _unloaded_cisymbol;
412 }
413 static ciObjArrayKlass* unloaded_ciobjarrayklass() {
414 return _unloaded_ciobjarrayklass;
415 }
416 static ciInstanceKlass* unloaded_ciinstance_klass() {
417 return _unloaded_ciinstance_klass;
418 }
419 ciInstance* unloaded_ciinstance();
420
421 ciKlass* find_system_klass(ciSymbol* klass_name);
422 // Note: To find a class from its name string, use ciSymbol::make,
423 // but consider adding to vmSymbols.hpp instead.
424
425 // converts the ciKlass* representing the holder of a method into a
426 // ciInstanceKlass*. This is needed since the holder of a method in
427 // the bytecodes could be an array type. Basically this converts
428 // array types into java/lang/Object and other types stay as they are.
429 static ciInstanceKlass* get_instance_klass_for_declared_method_holder(ciKlass* klass);
430
431 // Return the machine-level offset of o, which must be an element of a.
432 // This may be used to form constant-loading expressions in lieu of simpler encodings.
433 int array_element_offset_in_bytes(ciArray* a, ciObject* o);
434
435 // Access to the compile-lifetime allocation arena.
436 Arena* arena() { return _arena; }
437
438 // What is the current compilation environment?
439 static ciEnv* current() { return CompilerThread::current()->env(); }
440
441 // Overload with current thread argument
442 static ciEnv* current(CompilerThread *thread) { return thread->env(); }
443
444 // Per-compiler data. (Used by C2 to publish the Compile* pointer.)
445 void* compiler_data() { return _compiler_data; }
446 void set_compiler_data(void* x) { _compiler_data = x; }
447
448 // Notice that a method has been inlined in the current compile;
449 // used only for statistics.
450 void notice_inlined_method(ciMethod* method);
451
452 // Total number of bytecodes in inlined methods in this compile
453 int num_inlined_bytecodes() const;
454
455 // Output stream for logging compilation info.
456 CompileLog* log() { return _log; }
457 void set_log(CompileLog* log) { _log = log; }
458
459 void record_failure(const char* reason); // Record failure and report later
460 void report_failure(const char* reason); // Report failure immediately
461 void record_method_not_compilable(const char* reason, bool all_tiers = true);
462 void record_out_of_memory_failure();
463
464 // RedefineClasses support
465 void metadata_do(MetadataClosure* f) { _factory->metadata_do(f); }
466
467 // Dump the compilation replay data for the ciEnv to the stream.
468 void dump_replay_data(int compile_id);
469 void dump_inline_data(int compile_id);
470 void dump_replay_data(outputStream* out);
471 void dump_replay_data_unsafe(outputStream* out);
472 void dump_compile_data(outputStream* out);
473 };
474
475 #endif // SHARE_CI_CIENV_HPP