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