1 /*
2 * Copyright (c) 1999, 2019, 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/systemDictionary.hpp"
31 #include "code/debugInfoRec.hpp"
32 #include "code/dependencies.hpp"
33 #include "code/exceptionHandlerTable.hpp"
34 #include "compiler/oopMap.hpp"
35 #include "oops/methodData.hpp"
36 #include "runtime/thread.hpp"
37
38 class CompileTask;
39
40 // ciEnv
41 //
42 // This class is the top level broker for requests from the compiler
43 // to the VM.
44 class ciEnv : StackObj {
45 CI_PACKAGE_ACCESS_TO
46
47 friend class CompileBroker;
48 friend class Dependencies; // for get_object, during logging
49 friend class PrepareExtraDataClosure;
50
51 private:
52 Arena* _arena; // Alias for _ciEnv_arena except in init_shared_objects()
53 Arena _ciEnv_arena;
54 int _system_dictionary_modification_counter;
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 bool _jvmti_can_hotswap_or_post_breakpoint;
73 bool _jvmti_can_access_local_variables;
74 bool _jvmti_can_post_on_exceptions;
75 bool _jvmti_can_pop_frame;
76
77 // Cache DTrace flags
78 bool _dtrace_extended_probes;
79 bool _dtrace_monitor_probes;
80 bool _dtrace_method_probes;
81 bool _dtrace_alloc_probes;
82
83 // Distinguished instances of certain ciObjects..
84 static ciObject* _null_object_instance;
85
86 #define WK_KLASS_DECL(name, ignore_s) static ciInstanceKlass* _##name;
87 WK_KLASSES_DO(WK_KLASS_DECL)
88 #undef WK_KLASS_DECL
89
90 static ciSymbol* _unloaded_cisymbol;
91 static ciInstanceKlass* _unloaded_ciinstance_klass;
92 static ciObjArrayKlass* _unloaded_ciobjarrayklass;
93
94 static jobject _ArrayIndexOutOfBoundsException_handle;
95 static jobject _ArrayStoreException_handle;
96 static jobject _ClassCastException_handle;
97
98 ciInstance* _NullPointerException_instance;
99 ciInstance* _ArithmeticException_instance;
100 ciInstance* _ArrayIndexOutOfBoundsException_instance;
101 ciInstance* _ArrayStoreException_instance;
102 ciInstance* _ClassCastException_instance;
103
104 ciInstance* _the_null_string; // The Java string "null"
105 ciInstance* _the_min_jint_string; // The Java string "-2147483648"
106
107 // Look up a klass by name from a particular class loader (the accessor's).
108 // If require_local, result must be defined in that class loader, or NULL.
109 // If !require_local, a result from remote class loader may be reported,
110 // if sufficient class loader constraints exist such that initiating
111 // a class loading request from the given loader is bound to return
112 // the class defined in the remote loader (or throw an error).
113 //
114 // Return an unloaded klass if !require_local and no class at all is found.
115 //
116 // The CI treats a klass as loaded if it is consistently defined in
117 // another loader, even if it hasn't yet been loaded in all loaders
118 // that could potentially see it via delegation.
119 ciKlass* get_klass_by_name(ciKlass* accessing_klass,
120 ciSymbol* klass_name,
121 bool require_local);
122
123 // Constant pool access.
124 ciKlass* get_klass_by_index(const constantPoolHandle& cpool,
125 int klass_index,
126 bool& is_accessible,
127 ciInstanceKlass* loading_klass);
128 ciConstant get_constant_by_index(const constantPoolHandle& cpool,
129 int pool_index, int cache_index,
130 ciInstanceKlass* accessor);
131 ciField* get_field_by_index(ciInstanceKlass* loading_klass,
132 int field_index);
133 ciMethod* get_method_by_index(const constantPoolHandle& cpool,
134 int method_index, Bytecodes::Code bc,
135 ciInstanceKlass* loading_klass);
136 bool is_klass_never_null(const constantPoolHandle& cpool,
137 int klass_index);
138
139 // Implementation methods for loading and constant pool access.
140 ciKlass* get_klass_by_name_impl(ciKlass* accessing_klass,
141 const constantPoolHandle& cpool,
142 ciSymbol* klass_name,
143 bool require_local);
144 ciKlass* get_klass_by_index_impl(const constantPoolHandle& cpool,
145 int klass_index,
146 bool& is_accessible,
147 ciInstanceKlass* loading_klass);
148 ciConstant get_constant_by_index_impl(const constantPoolHandle& cpool,
149 int pool_index, int cache_index,
150 ciInstanceKlass* loading_klass);
151 ciField* get_field_by_index_impl(ciInstanceKlass* loading_klass,
152 int field_index);
153 ciMethod* get_method_by_index_impl(const constantPoolHandle& cpool,
154 int method_index, Bytecodes::Code bc,
155 ciInstanceKlass* loading_klass);
156 bool is_klass_never_null_impl(const constantPoolHandle& cpool,
157 int klass_index);
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 ciValueArrayKlass* get_value_array_klass(Klass* o) {
205 if (o == NULL) return NULL;
206 return get_metadata(o)->as_value_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
303 // Call internally when Compile_lock is already held.
304 bool system_dictionary_modification_counter_changed_locked();
305 public:
306 enum {
307 MethodCompilable,
308 MethodCompilable_not_at_tier,
309 MethodCompilable_never
310 };
311
312 ciEnv(CompileTask* task, int system_dictionary_modification_counter);
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 != NULL; }
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 compilability
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 NULL;
344 default:
345 ShouldNotReachHere();
346 return NULL;
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 void 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
362 // Cache DTrace flags
363 void cache_dtrace_flags();
364 bool dtrace_extended_probes() const { return _dtrace_extended_probes; }
365 bool dtrace_monitor_probes() const { return _dtrace_monitor_probes; }
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 uint 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 RTMState rtm_state = NoRTM);
391
392
393 // Access to certain well known ciObjects.
394 #define WK_KLASS_FUNC(name, ignore_s) \
395 ciInstanceKlass* name() { \
396 return _##name;\
397 }
398 WK_KLASSES_DO(WK_KLASS_FUNC)
399 #undef WK_KLASS_FUNC
400
401 ciInstance* NullPointerException_instance() {
402 assert(_NullPointerException_instance != NULL, "initialization problem");
403 return _NullPointerException_instance;
404 }
405 ciInstance* ArithmeticException_instance() {
406 assert(_ArithmeticException_instance != NULL, "initialization problem");
407 return _ArithmeticException_instance;
408 }
409
410 // Lazy constructors:
411 ciInstance* ArrayIndexOutOfBoundsException_instance();
412 ciInstance* ArrayStoreException_instance();
413 ciInstance* ClassCastException_instance();
414
415 ciInstance* the_null_string();
416 ciInstance* the_min_jint_string();
417
418 static ciSymbol* unloaded_cisymbol() {
419 return _unloaded_cisymbol;
420 }
421 static ciObjArrayKlass* unloaded_ciobjarrayklass() {
422 return _unloaded_ciobjarrayklass;
423 }
424 static ciInstanceKlass* unloaded_ciinstance_klass() {
425 return _unloaded_ciinstance_klass;
426 }
427 ciInstance* unloaded_ciinstance();
428
429 ciKlass* find_system_klass(ciSymbol* klass_name);
430 // Note: To find a class from its name string, use ciSymbol::make,
431 // but consider adding to vmSymbols.hpp instead.
432
433 // converts the ciKlass* representing the holder of a method into a
434 // ciInstanceKlass*. This is needed since the holder of a method in
435 // the bytecodes could be an array type. Basically this converts
436 // array types into java/lang/Object and other types stay as they are.
437 static ciInstanceKlass* get_instance_klass_for_declared_method_holder(ciKlass* klass);
438
439 // Return the machine-level offset of o, which must be an element of a.
440 // This may be used to form constant-loading expressions in lieu of simpler encodings.
441 int array_element_offset_in_bytes(ciArray* a, ciObject* o);
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 // Check for changes to the system dictionary during compilation
468 bool system_dictionary_modification_counter_changed();
469
470 void record_failure(const char* reason); // Record failure and report later
471 void report_failure(const char* reason); // Report failure immediately
472 void record_method_not_compilable(const char* reason, bool all_tiers = true);
473 void record_out_of_memory_failure();
474
475 // RedefineClasses support
476 void metadata_do(void f(Metadata*)) { _factory->metadata_do(f); }
477
478 // Dump the compilation replay data for the ciEnv to the stream.
479 void dump_replay_data(int compile_id);
480 void dump_inline_data(int compile_id);
481 void dump_replay_data(outputStream* out);
482 void dump_replay_data_unsafe(outputStream* out);
483 void dump_compile_data(outputStream* out);
484
485 ciWrapper* make_never_null_wrapper(ciType* type) {
486 return _factory->make_never_null_wrapper(type);
487 }
488 };
489
490 #endif // SHARE_CI_CIENV_HPP