1 /*
2 * Copyright (c) 1999, 2010, 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 class CompileTask;
26
27 // ciEnv
28 //
29 // This class is the top level broker for requests from the compiler
30 // to the VM.
31 class ciEnv : StackObj {
32 CI_PACKAGE_ACCESS_TO
33
34 friend class CompileBroker;
35 friend class Dependencies; // for get_object, during logging
36
37 private:
38 Arena* _arena; // Alias for _ciEnv_arena except in init_shared_objects()
39 Arena _ciEnv_arena;
40 int _system_dictionary_modification_counter;
41 ciObjectFactory* _factory;
42 OopRecorder* _oop_recorder;
43 DebugInformationRecorder* _debug_info;
44 Dependencies* _dependencies;
45 const char* _failure_reason;
46 int _compilable;
47 bool _break_at_compile;
48 int _num_inlined_bytecodes;
49 CompileTask* _task; // faster access to CompilerThread::task
50 CompileLog* _log; // faster access to CompilerThread::log
51 void* _compiler_data; // compiler-specific stuff, if any
52
53 char* _name_buffer;
54 int _name_buffer_len;
55
56 // Cache Jvmti state
57 bool _jvmti_can_hotswap_or_post_breakpoint;
58 bool _jvmti_can_access_local_variables;
59 bool _jvmti_can_post_on_exceptions;
60
61 // Cache DTrace flags
62 bool _dtrace_extended_probes;
63 bool _dtrace_monitor_probes;
64 bool _dtrace_method_probes;
65 bool _dtrace_alloc_probes;
66
67 // Distinguished instances of certain ciObjects..
68 static ciObject* _null_object_instance;
69 static ciMethodKlass* _method_klass_instance;
70 static ciSymbolKlass* _symbol_klass_instance;
71 static ciKlassKlass* _klass_klass_instance;
72 static ciInstanceKlassKlass* _instance_klass_klass_instance;
73 static ciTypeArrayKlassKlass* _type_array_klass_klass_instance;
74 static ciObjArrayKlassKlass* _obj_array_klass_klass_instance;
75
76 #define WK_KLASS_DECL(name, ignore_s, ignore_o) static ciInstanceKlass* _##name;
77 WK_KLASSES_DO(WK_KLASS_DECL)
78 #undef WK_KLASS_DECL
79
80 static ciSymbol* _unloaded_cisymbol;
81 static ciInstanceKlass* _unloaded_ciinstance_klass;
82 static ciObjArrayKlass* _unloaded_ciobjarrayklass;
83
84 static jobject _ArrayIndexOutOfBoundsException_handle;
85 static jobject _ArrayStoreException_handle;
86 static jobject _ClassCastException_handle;
87
88 ciInstance* _NullPointerException_instance;
89 ciInstance* _ArithmeticException_instance;
90 ciInstance* _ArrayIndexOutOfBoundsException_instance;
91 ciInstance* _ArrayStoreException_instance;
92 ciInstance* _ClassCastException_instance;
93
94 ciInstance* _the_null_string; // The Java string "null"
95 ciInstance* _the_min_jint_string; // The Java string "-2147483648"
96
97 // Look up a klass by name from a particular class loader (the accessor's).
98 // If require_local, result must be defined in that class loader, or NULL.
99 // If !require_local, a result from remote class loader may be reported,
100 // if sufficient class loader constraints exist such that initiating
101 // a class loading request from the given loader is bound to return
102 // the class defined in the remote loader (or throw an error).
103 //
104 // Return an unloaded klass if !require_local and no class at all is found.
105 //
106 // The CI treats a klass as loaded if it is consistently defined in
107 // another loader, even if it hasn't yet been loaded in all loaders
108 // that could potentially see it via delegation.
109 ciKlass* get_klass_by_name(ciKlass* accessing_klass,
110 ciSymbol* klass_name,
111 bool require_local);
112
113 // Constant pool access.
114 ciKlass* get_klass_by_index(constantPoolHandle cpool,
115 int klass_index,
116 bool& is_accessible,
117 ciInstanceKlass* loading_klass);
118 ciConstant get_constant_by_index(constantPoolHandle cpool,
119 int pool_index, int cache_index,
120 ciInstanceKlass* accessor);
121 ciField* get_field_by_index(ciInstanceKlass* loading_klass,
122 int field_index);
123 ciMethod* get_method_by_index(constantPoolHandle cpool,
124 int method_index, Bytecodes::Code bc,
125 ciInstanceKlass* loading_klass);
126
127 // Implementation methods for loading and constant pool access.
128 ciKlass* get_klass_by_name_impl(ciKlass* accessing_klass,
129 ciSymbol* klass_name,
130 bool require_local);
131 ciKlass* get_klass_by_index_impl(constantPoolHandle cpool,
132 int klass_index,
133 bool& is_accessible,
134 ciInstanceKlass* loading_klass);
135 ciConstant get_constant_by_index_impl(constantPoolHandle cpool,
136 int pool_index, int cache_index,
137 ciInstanceKlass* loading_klass);
138 ciField* get_field_by_index_impl(ciInstanceKlass* loading_klass,
139 int field_index);
140 ciMethod* get_method_by_index_impl(constantPoolHandle cpool,
141 int method_index, Bytecodes::Code bc,
142 ciInstanceKlass* loading_klass);
143 ciMethod* get_fake_invokedynamic_method_impl(constantPoolHandle cpool,
144 int index, Bytecodes::Code bc);
145
146 // Helper methods
147 bool check_klass_accessibility(ciKlass* accessing_klass,
148 klassOop resolved_klassOop);
149 methodOop lookup_method(instanceKlass* accessor,
150 instanceKlass* holder,
151 symbolOop name,
152 symbolOop sig,
153 Bytecodes::Code bc);
154
155 // Get a ciObject from the object factory. Ensures uniqueness
156 // of ciObjects.
157 ciObject* get_object(oop o) {
158 if (o == NULL) {
159 return _null_object_instance;
160 } else {
161 return _factory->get(o);
162 }
163 }
164
165 ciMethod* get_method_from_handle(jobject method);
166
167 ciInstance* get_or_create_exception(jobject& handle, symbolHandle name);
168
169 // Get a ciMethod representing either an unfound method or
170 // a method with an unloaded holder. Ensures uniqueness of
171 // the result.
172 ciMethod* get_unloaded_method(ciInstanceKlass* holder,
173 ciSymbol* name,
174 ciSymbol* signature) {
175 return _factory->get_unloaded_method(holder, name, signature);
176 }
177
178 // Get a ciKlass representing an unloaded klass.
179 // Ensures uniqueness of the result.
180 ciKlass* get_unloaded_klass(ciKlass* accessing_klass,
181 ciSymbol* name) {
182 return _factory->get_unloaded_klass(accessing_klass, name, true);
183 }
184
185 // Get a ciKlass representing an unloaded klass mirror.
186 // Result is not necessarily unique, but will be unloaded.
187 ciInstance* get_unloaded_klass_mirror(ciKlass* type) {
188 return _factory->get_unloaded_klass_mirror(type);
189 }
190
191 // Get a ciInstance representing an unresolved method handle constant.
192 ciInstance* get_unloaded_method_handle_constant(ciKlass* holder,
193 ciSymbol* name,
194 ciSymbol* signature,
195 int ref_kind) {
196 return _factory->get_unloaded_method_handle_constant(holder, name, signature, ref_kind);
197 }
198
199 // Get a ciInstance representing an unresolved method type constant.
200 ciInstance* get_unloaded_method_type_constant(ciSymbol* signature) {
201 return _factory->get_unloaded_method_type_constant(signature);
202 }
203
204 // See if we already have an unloaded klass for the given name
205 // or return NULL if not.
206 ciKlass *check_get_unloaded_klass(ciKlass* accessing_klass, ciSymbol* name) {
207 return _factory->get_unloaded_klass(accessing_klass, name, false);
208 }
209
210 // Get a ciReturnAddress corresponding to the given bci.
211 // Ensures uniqueness of the result.
212 ciReturnAddress* get_return_address(int bci) {
213 return _factory->get_return_address(bci);
214 }
215
216 // Get a ciMethodData representing the methodData for a method
217 // with none.
218 ciMethodData* get_empty_methodData() {
219 return _factory->get_empty_methodData();
220 }
221
222 // General utility : get a buffer of some required length.
223 // Used in symbol creation.
224 char* name_buffer(int req_len);
225
226 // Is this thread currently in the VM state?
227 static bool is_in_vm();
228
229 // Helper routine for determining the validity of a compilation
230 // with respect to concurrent class loading.
231 void check_for_system_dictionary_modification(ciMethod* target);
232
233 public:
234 enum {
235 MethodCompilable,
236 MethodCompilable_not_at_tier,
237 MethodCompilable_never
238 };
239
240 ciEnv(CompileTask* task, int system_dictionary_modification_counter);
241 // Used only during initialization of the ci
242 ciEnv(Arena* arena);
243 ~ciEnv();
244
245 OopRecorder* oop_recorder() { return _oop_recorder; }
246 void set_oop_recorder(OopRecorder* r) { _oop_recorder = r; }
247
248 DebugInformationRecorder* debug_info() { return _debug_info; }
249 void set_debug_info(DebugInformationRecorder* i) { _debug_info = i; }
250
251 Dependencies* dependencies() { return _dependencies; }
252 void set_dependencies(Dependencies* d) { _dependencies = d; }
253
254 // This is true if the compilation is not going to produce code.
255 // (It is reasonable to retry failed compilations.)
256 bool failing() { return _failure_reason != NULL; }
257
258 // Reason this compilation is failing, such as "too many basic blocks".
259 const char* failure_reason() { return _failure_reason; }
260
261 // Return state of appropriate compilability
262 int compilable() { return _compilable; }
263
264 bool break_at_compile() { return _break_at_compile; }
265 void set_break_at_compile(bool z) { _break_at_compile = z; }
266
267 // Cache Jvmti state
268 void cache_jvmti_state();
269 bool jvmti_can_hotswap_or_post_breakpoint() const { return _jvmti_can_hotswap_or_post_breakpoint; }
270 bool jvmti_can_access_local_variables() const { return _jvmti_can_access_local_variables; }
271 bool jvmti_can_post_on_exceptions() const { return _jvmti_can_post_on_exceptions; }
272
273 // Cache DTrace flags
274 void cache_dtrace_flags();
275 bool dtrace_extended_probes() const { return _dtrace_extended_probes; }
276 bool dtrace_monitor_probes() const { return _dtrace_monitor_probes; }
277 bool dtrace_method_probes() const { return _dtrace_method_probes; }
278 bool dtrace_alloc_probes() const { return _dtrace_alloc_probes; }
279
280 // The compiler task which has created this env.
281 // May be useful to find out compile_id, comp_level, etc.
282 CompileTask* task() { return _task; }
283 // Handy forwards to the task:
284 int comp_level(); // task()->comp_level()
285 uint compile_id(); // task()->compile_id()
286
287 // Register the result of a compilation.
288 void register_method(ciMethod* target,
289 int entry_bci,
290 CodeOffsets* offsets,
291 int orig_pc_offset,
292 CodeBuffer* code_buffer,
293 int frame_words,
294 OopMapSet* oop_map_set,
295 ExceptionHandlerTable* handler_table,
296 ImplicitExceptionTable* inc_table,
297 AbstractCompiler* compiler,
298 int comp_level,
299 bool has_debug_info = true,
300 bool has_unsafe_access = false);
301
302
303 // Access to certain well known ciObjects.
304 #define WK_KLASS_FUNC(name, ignore_s, ignore_o) \
305 ciInstanceKlass* name() { \
306 return _##name;\
307 }
308 WK_KLASSES_DO(WK_KLASS_FUNC)
309 #undef WK_KLASS_FUNC
310
311 ciInstance* NullPointerException_instance() {
312 assert(_NullPointerException_instance != NULL, "initialization problem");
313 return _NullPointerException_instance;
314 }
315 ciInstance* ArithmeticException_instance() {
316 assert(_ArithmeticException_instance != NULL, "initialization problem");
317 return _ArithmeticException_instance;
318 }
319
320 // Lazy constructors:
321 ciInstance* ArrayIndexOutOfBoundsException_instance();
322 ciInstance* ArrayStoreException_instance();
323 ciInstance* ClassCastException_instance();
324
325 ciInstance* the_null_string();
326 ciInstance* the_min_jint_string();
327
328 static ciSymbol* unloaded_cisymbol() {
329 return _unloaded_cisymbol;
330 }
331 static ciObjArrayKlass* unloaded_ciobjarrayklass() {
332 return _unloaded_ciobjarrayklass;
333 }
334 static ciInstanceKlass* unloaded_ciinstance_klass() {
335 return _unloaded_ciinstance_klass;
336 }
337
338 ciKlass* find_system_klass(ciSymbol* klass_name);
339 // Note: To find a class from its name string, use ciSymbol::make,
340 // but consider adding to vmSymbols.hpp instead.
341
342 // Use this to make a holder for non-perm compile time constants.
343 // The resulting array is guaranteed to satisfy "can_be_constant".
344 ciArray* make_system_array(GrowableArray<ciObject*>* objects);
345
346 // converts the ciKlass* representing the holder of a method into a
347 // ciInstanceKlass*. This is needed since the holder of a method in
348 // the bytecodes could be an array type. Basically this converts
349 // array types into java/lang/Object and other types stay as they are.
350 static ciInstanceKlass* get_instance_klass_for_declared_method_holder(ciKlass* klass);
351
352 // Return the machine-level offset of o, which must be an element of a.
353 // This may be used to form constant-loading expressions in lieu of simpler encodings.
354 int array_element_offset_in_bytes(ciArray* a, ciObject* o);
355
356 // Access to the compile-lifetime allocation arena.
357 Arena* arena() { return _arena; }
358
359 // What is the current compilation environment?
360 static ciEnv* current() { return CompilerThread::current()->env(); }
361
362 // Overload with current thread argument
363 static ciEnv* current(CompilerThread *thread) { return thread->env(); }
364
365 // Per-compiler data. (Used by C2 to publish the Compile* pointer.)
366 void* compiler_data() { return _compiler_data; }
367 void set_compiler_data(void* x) { _compiler_data = x; }
368
369 // Notice that a method has been inlined in the current compile;
370 // used only for statistics.
371 void notice_inlined_method(ciMethod* method);
372
373 // Total number of bytecodes in inlined methods in this compile
374 int num_inlined_bytecodes() const;
375
376 // Output stream for logging compilation info.
377 CompileLog* log() { return _log; }
378 void set_log(CompileLog* log) { _log = log; }
379
380 // Check for changes to the system dictionary during compilation
381 bool system_dictionary_modification_counter_changed();
382
383 void record_failure(const char* reason);
384 void record_method_not_compilable(const char* reason, bool all_tiers = true);
385 void record_out_of_memory_failure();
386 };