1 /*
2 * Copyright (c) 1999, 2018, 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_VM_CI_CIENV_HPP
26 #define SHARE_VM_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
50 private:
51 Arena* _arena; // Alias for _ciEnv_arena except in init_shared_objects()
52 Arena _ciEnv_arena;
53 int _system_dictionary_modification_counter;
54 ciObjectFactory* _factory;
55 OopRecorder* _oop_recorder;
56 DebugInformationRecorder* _debug_info;
57 Dependencies* _dependencies;
58 const char* _failure_reason;
59 bool _inc_decompile_count_on_failure;
60 int _compilable;
61 bool _break_at_compile;
62 int _num_inlined_bytecodes;
63 CompileTask* _task; // faster access to CompilerThread::task
64 CompileLog* _log; // faster access to CompilerThread::log
65 void* _compiler_data; // compiler-specific stuff, if any
66
67 char* _name_buffer;
68 int _name_buffer_len;
69
70 // Cache Jvmti state
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
76 // Cache DTrace flags
77 bool _dtrace_extended_probes;
78 bool _dtrace_monitor_probes;
79 bool _dtrace_method_probes;
80 bool _dtrace_alloc_probes;
81
82 // Distinguished instances of certain ciObjects..
83 static ciObject* _null_object_instance;
84
85 #define WK_KLASS_DECL(name, ignore_s) static ciInstanceKlass* _##name;
86 WK_KLASSES_DO(WK_KLASS_DECL)
87 #undef WK_KLASS_DECL
88
89 static ciSymbol* _unloaded_cisymbol;
90 static ciInstanceKlass* _unloaded_ciinstance_klass;
91 static ciObjArrayKlass* _unloaded_ciobjarrayklass;
92
93 static jobject _ArrayIndexOutOfBoundsException_handle;
94 static jobject _ArrayStoreException_handle;
95 static jobject _ClassCastException_handle;
96
97 ciInstance* _NullPointerException_instance;
98 ciInstance* _ArithmeticException_instance;
99 ciInstance* _ArrayIndexOutOfBoundsException_instance;
100 ciInstance* _ArrayStoreException_instance;
101 ciInstance* _ClassCastException_instance;
102
103 ciInstance* _the_null_string; // The Java string "null"
104 ciInstance* _the_min_jint_string; // The Java string "-2147483648"
105
106 // Look up a klass by name from a particular class loader (the accessor's).
107 // If require_local, result must be defined in that class loader, or NULL.
108 // If !require_local, a result from remote class loader may be reported,
109 // if sufficient class loader constraints exist such that initiating
110 // a class loading request from the given loader is bound to return
111 // the class defined in the remote loader (or throw an error).
112 //
113 // Return an unloaded klass if !require_local and no class at all is found.
114 //
115 // The CI treats a klass as loaded if it is consistently defined in
116 // another loader, even if it hasn't yet been loaded in all loaders
117 // that could potentially see it via delegation.
118 ciKlass* get_klass_by_name(ciKlass* accessing_klass,
119 ciSymbol* klass_name,
120 bool require_local);
121
122 // Constant pool access.
123 ciKlass* get_klass_by_index(const constantPoolHandle& cpool,
124 int klass_index,
125 bool& is_accessible,
126 ciInstanceKlass* loading_klass);
127 ciConstant get_constant_by_index(const constantPoolHandle& cpool,
128 int pool_index, int cache_index,
129 ciInstanceKlass* accessor);
130 ciField* get_field_by_index(ciInstanceKlass* loading_klass,
131 int field_index);
132 ciMethod* get_method_by_index(const constantPoolHandle& cpool,
133 int method_index, Bytecodes::Code bc,
134 ciInstanceKlass* loading_klass);
135 bool get_never_null(const constantPoolHandle& cpool,
136 int klass_index);
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 bool is_value_type = false);
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 get_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 ciInstance* get_instance(oop o) {
197 if (o == NULL) return NULL;
198 return get_object(o)->as_instance();
199 }
200 ciValueArrayKlass* get_value_array_klass(Klass* o) {
201 if (o == NULL) return NULL;
202 return get_metadata(o)->as_value_array_klass();
203 }
204 ciObjArrayKlass* get_obj_array_klass(Klass* o) {
205 if (o == NULL) return NULL;
206 return get_metadata(o)->as_obj_array_klass();
207 }
208 ciTypeArrayKlass* get_type_array_klass(Klass* o) {
209 if (o == NULL) return NULL;
210 return get_metadata(o)->as_type_array_klass();
211 }
212 ciKlass* get_klass(Klass* o) {
213 if (o == NULL) return NULL;
214 return get_metadata(o)->as_klass();
215 }
216 ciInstanceKlass* get_instance_klass(Klass* o) {
217 if (o == NULL) return NULL;
218 return get_metadata(o)->as_instance_klass();
219 }
220 ciMethod* get_method(Method* o) {
221 if (o == NULL) return NULL;
222 return get_metadata(o)->as_method();
223 }
224 ciMethodData* get_method_data(MethodData* o) {
225 if (o == NULL) return NULL;
226 return get_metadata(o)->as_method_data();
227 }
228
229 ciMethod* get_method_from_handle(Method* method);
230
231 ciInstance* get_or_create_exception(jobject& handle, Symbol* name);
232
233 // Get a ciMethod representing either an unfound method or
234 // a method with an unloaded holder. Ensures uniqueness of
235 // the result.
236 ciMethod* get_unloaded_method(ciKlass* holder,
237 ciSymbol* name,
238 ciSymbol* signature,
239 ciInstanceKlass* accessor) {
240 ciInstanceKlass* declared_holder = get_instance_klass_for_declared_method_holder(holder);
241 return _factory->get_unloaded_method(declared_holder, name, signature, accessor);
242 }
243
244 // Get a ciKlass representing an unloaded klass.
245 // Ensures uniqueness of the result.
246 ciKlass* get_unloaded_klass(ciKlass* accessing_klass,
247 ciSymbol* name, bool is_value_type = false) {
248 return _factory->get_unloaded_klass(accessing_klass, name, true, is_value_type);
249 }
250
251 // Get a ciKlass representing an unloaded klass mirror.
252 // Result is not necessarily unique, but will be unloaded.
253 ciInstance* get_unloaded_klass_mirror(ciKlass* type) {
254 return _factory->get_unloaded_klass_mirror(type);
255 }
256
257 // Get a ciInstance representing an unresolved method handle constant.
258 ciInstance* get_unloaded_method_handle_constant(ciKlass* holder,
259 ciSymbol* name,
260 ciSymbol* signature,
261 int ref_kind) {
262 return _factory->get_unloaded_method_handle_constant(holder, name, signature, ref_kind);
263 }
264
265 // Get a ciInstance representing an unresolved method type constant.
266 ciInstance* get_unloaded_method_type_constant(ciSymbol* signature) {
267 return _factory->get_unloaded_method_type_constant(signature);
268 }
269
270 // See if we already have an unloaded klass for the given name
271 // or return NULL if not.
272 ciKlass *check_get_unloaded_klass(ciKlass* accessing_klass, ciSymbol* name) {
273 return _factory->get_unloaded_klass(accessing_klass, name, false);
274 }
275
276 // Get a ciReturnAddress corresponding to the given bci.
277 // Ensures uniqueness of the result.
278 ciReturnAddress* get_return_address(int bci) {
279 return _factory->get_return_address(bci);
280 }
281
282 // Get a ciMethodData representing the methodData for a method
283 // with none.
284 ciMethodData* get_empty_methodData() {
285 return _factory->get_empty_methodData();
286 }
287
288 // General utility : get a buffer of some required length.
289 // Used in symbol creation.
290 char* name_buffer(int req_len);
291
292 // Is this thread currently in the VM state?
293 static bool is_in_vm();
294
295 // Helper routine for determining the validity of a compilation with
296 // respect to method dependencies (e.g. concurrent class loading).
297 void validate_compile_task_dependencies(ciMethod* target);
298
299 public:
300 enum {
301 MethodCompilable,
302 MethodCompilable_not_at_tier,
303 MethodCompilable_never
304 };
305
306 ciEnv(CompileTask* task, int system_dictionary_modification_counter);
307 // Used only during initialization of the ci
308 ciEnv(Arena* arena);
309 ~ciEnv();
310
311 OopRecorder* oop_recorder() { return _oop_recorder; }
312 void set_oop_recorder(OopRecorder* r) { _oop_recorder = r; }
313
314 DebugInformationRecorder* debug_info() { return _debug_info; }
315 void set_debug_info(DebugInformationRecorder* i) { _debug_info = i; }
316
317 Dependencies* dependencies() { return _dependencies; }
318 void set_dependencies(Dependencies* d) { _dependencies = d; }
319
320 // This is true if the compilation is not going to produce code.
321 // (It is reasonable to retry failed compilations.)
322 bool failing() { return _failure_reason != NULL; }
323
324 // Reason this compilation is failing, such as "too many basic blocks".
325 const char* failure_reason() { return _failure_reason; }
326
327 // Return state of appropriate compilability
328 int compilable() { return _compilable; }
329
330 const char* retry_message() const {
331 switch (_compilable) {
332 case ciEnv::MethodCompilable_not_at_tier:
333 return "retry at different tier";
334 case ciEnv::MethodCompilable_never:
335 return "not retryable";
336 case ciEnv::MethodCompilable:
337 return NULL;
338 default:
339 ShouldNotReachHere();
340 return NULL;
341 }
342 }
343
344 bool break_at_compile() { return _break_at_compile; }
345 void set_break_at_compile(bool z) { _break_at_compile = z; }
346
347 // Cache Jvmti state
348 void cache_jvmti_state();
349 bool jvmti_state_changed() const;
350 bool should_retain_local_variables() const;
351 bool jvmti_can_hotswap_or_post_breakpoint() const { return _jvmti_can_hotswap_or_post_breakpoint; }
352 bool jvmti_can_post_on_exceptions() const { return _jvmti_can_post_on_exceptions; }
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 // Check for changes to the system dictionary during compilation
460 bool system_dictionary_modification_counter_changed();
461
462 void record_failure(const char* reason); // Record failure and report later
463 void report_failure(const char* reason); // Report failure immediately
464 void record_method_not_compilable(const char* reason, bool all_tiers = true);
465 void record_out_of_memory_failure();
466
467 // RedefineClasses support
468 void metadata_do(void f(Metadata*)) { _factory->metadata_do(f); }
469
470 // Dump the compilation replay data for the ciEnv to the stream.
471 void dump_replay_data(int compile_id);
472 void dump_inline_data(int compile_id);
473 void dump_replay_data(outputStream* out);
474 void dump_replay_data_unsafe(outputStream* out);
475 void dump_compile_data(outputStream* out);
476 };
477
478 #endif // SHARE_VM_CI_CIENV_HPP