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