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