1 #ifdef USE_PRAGMA_IDENT_HDR
2 #pragma ident "@(#)c1_GraphBuilder.hpp 1.75 07/05/17 15:49:37 JVM"
3 #endif
4 /*
5 * Copyright 1999-2006 Sun Microsystems, Inc. All Rights Reserved.
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
7 *
8 * This code is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License version 2 only, as
10 * published by the Free Software Foundation.
11 *
12 * This code is distributed in the hope that it will be useful, but WITHOUT
13 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15 * version 2 for more details (a copy is included in the LICENSE file that
16 * accompanied this code).
17 *
18 * You should have received a copy of the GNU General Public License version
19 * 2 along with this work; if not, write to the Free Software Foundation,
20 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
21 *
22 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23 * CA 95054 USA or visit www.sun.com if you need additional information or
24 * have any questions.
25 *
26 */
27
28 class MemoryBuffer;
29
30 class GraphBuilder VALUE_OBJ_CLASS_SPEC {
31 private:
32 // Per-scope data. These are pushed and popped as we descend into
33 // inlined methods. Currently in order to generate good code in the
34 // inliner we have to attempt to inline methods directly into the
35 // basic block we are parsing; this adds complexity.
36 class ScopeData: public CompilationResourceObj {
37 private:
38 ScopeData* _parent;
39 // bci-to-block mapping
40 BlockList* _bci2block;
41 // Scope
42 IRScope* _scope;
43 // Whether this scope or any parent scope has exception handlers
44 bool _has_handler;
45 // The bytecodes
46 ciBytecodeStream* _stream;
47
48 // Work list
49 BlockList* _work_list;
50
51 // Maximum inline size for this scope
52 intx _max_inline_size;
53 // Expression stack depth at point where inline occurred
54 int _caller_stack_size;
55
56 // The continuation point for the inline. Currently only used in
57 // multi-block inlines, but eventually would like to use this for
58 // all inlines for uniformity and simplicity; in this case would
59 // get the continuation point from the BlockList instead of
60 // fabricating it anew because Invokes would be considered to be
61 // BlockEnds.
62 BlockBegin* _continuation;
63
64 // Without return value of inlined method on stack
65 ValueStack* _continuation_state;
66
67 // Was this ScopeData created only for the parsing and inlining of
68 // a jsr?
69 bool _parsing_jsr;
70 // We track the destination bci of the jsr only to determine
71 // bailout conditions, since we only handle a subset of all of the
72 // possible jsr-ret control structures. Recursive invocations of a
73 // jsr are disallowed by the verifier.
74 int _jsr_entry_bci;
75 // We need to track the local variable in which the return address
76 // was stored to ensure we can handle inlining the jsr, because we
77 // don't handle arbitrary jsr/ret constructs.
78 int _jsr_ret_addr_local;
79 // If we are parsing a jsr, the continuation point for rets
80 BlockBegin* _jsr_continuation;
81 // Cloned XHandlers for jsr-related ScopeDatas
82 XHandlers* _jsr_xhandlers;
83
84 // Number of returns seen in this scope
85 int _num_returns;
86
87 // In order to generate profitable code for inlining, we currently
88 // have to perform an optimization for single-block inlined
89 // methods where we continue parsing into the same block. This
90 // allows us to perform CSE across inlined scopes and to avoid
91 // storing parameters to the stack. Having a global register
92 // allocator and being able to perform global CSE would allow this
93 // code to be removed and thereby simplify the inliner.
94 BlockBegin* _cleanup_block; // The block to which the return was added
95 Instruction* _cleanup_return_prev; // Instruction before return instruction
96 ValueStack* _cleanup_state; // State of that block (not yet pinned)
97
98 public:
99 ScopeData(ScopeData* parent);
100
101 ScopeData* parent() const { return _parent; }
102
103 BlockList* bci2block() const { return _bci2block; }
104 void set_bci2block(BlockList* bci2block) { _bci2block = bci2block; }
105
106 // NOTE: this has a different effect when parsing jsrs
107 BlockBegin* block_at(int bci);
108
109 IRScope* scope() const { return _scope; }
110 // Has side-effect of setting has_handler flag
111 void set_scope(IRScope* scope);
112
113 // Whether this or any parent scope has exception handlers
114 bool has_handler() const { return _has_handler; }
115 void set_has_handler() { _has_handler = true; }
116
117 // Exception handlers list to be used for this scope
118 XHandlers* xhandlers() const;
119
120 // How to get a block to be parsed
121 void add_to_work_list(BlockBegin* block);
122 // How to remove the next block to be parsed; returns NULL if none left
123 BlockBegin* remove_from_work_list();
124 // Indicates parse is over
125 bool is_work_list_empty() const;
126
127 ciBytecodeStream* stream() { return _stream; }
128 void set_stream(ciBytecodeStream* stream) { _stream = stream; }
129
130 intx max_inline_size() const { return _max_inline_size; }
131 int caller_stack_size() const;
132
133 BlockBegin* continuation() const { return _continuation; }
134 void set_continuation(BlockBegin* cont) { _continuation = cont; }
135
136 ValueStack* continuation_state() const { return _continuation_state; }
137 void set_continuation_state(ValueStack* s) { _continuation_state = s; }
138
139 // Indicates whether this ScopeData was pushed only for the
140 // parsing and inlining of a jsr
141 bool parsing_jsr() const { return _parsing_jsr; }
142 void set_parsing_jsr() { _parsing_jsr = true; }
143 int jsr_entry_bci() const { return _jsr_entry_bci; }
144 void set_jsr_entry_bci(int bci) { _jsr_entry_bci = bci; }
145 void set_jsr_return_address_local(int local_no){ _jsr_ret_addr_local = local_no; }
146 int jsr_return_address_local() const { return _jsr_ret_addr_local; }
147 // Must be called after scope is set up for jsr ScopeData
148 void setup_jsr_xhandlers();
149
150 // The jsr continuation is only used when parsing_jsr is true, and
151 // is different from the "normal" continuation since we can end up
152 // doing a return (rather than a ret) from within a subroutine
153 BlockBegin* jsr_continuation() const { return _jsr_continuation; }
154 void set_jsr_continuation(BlockBegin* cont) { _jsr_continuation = cont; }
155
156 int num_returns();
157 void incr_num_returns();
158
159 void set_inline_cleanup_info(BlockBegin* block,
160 Instruction* return_prev,
161 ValueStack* return_state);
162 BlockBegin* inline_cleanup_block() const { return _cleanup_block; }
163 Instruction* inline_cleanup_return_prev() const{ return _cleanup_return_prev; }
164 ValueStack* inline_cleanup_state() const { return _cleanup_state; }
165 };
166
167 // for all GraphBuilders
168 static bool _is_initialized; // true if trap tables were initialized, false otherwise
169 static bool _can_trap[Bytecodes::number_of_java_codes];
170 static bool _is_async[Bytecodes::number_of_java_codes];
171
172 // for each instance of GraphBuilder
173 ScopeData* _scope_data; // Per-scope data; used for inlining
174 Compilation* _compilation; // the current compilation
175 ValueMap* _vmap; // the map of values encountered (for CSE)
176 MemoryBuffer* _memory;
177 const char* _inline_bailout_msg; // non-null if most recent inline attempt failed
178 int _instruction_count; // for bailing out in pathological jsr/ret cases
179 BlockBegin* _start; // the start block
180 BlockBegin* _osr_entry; // the osr entry block block
181 ValueStack* _initial_state; // The state for the start block
182
183 // for each call to connect_to_end; can also be set by inliner
184 BlockBegin* _block; // the current block
185 ValueStack* _state; // the current execution state
186 ValueStack* _exception_state; // state that will be used by handle_exception
187 Instruction* _last; // the last instruction added
188 bool _skip_block; // skip processing of the rest of this block
189
190 // accessors
191 ScopeData* scope_data() const { return _scope_data; }
192 Compilation* compilation() const { return _compilation; }
193 BlockList* bci2block() const { return scope_data()->bci2block(); }
194 ValueMap* vmap() const { assert(UseLocalValueNumbering, "should not access otherwise"); return _vmap; }
195 bool has_handler() const { return scope_data()->has_handler(); }
196
197 BlockBegin* block() const { return _block; }
198 ValueStack* state() const { return _state; }
199 void set_state(ValueStack* state) { _state = state; }
200 IRScope* scope() const { return scope_data()->scope(); }
201 ValueStack* exception_state() const { return _exception_state; }
202 void set_exception_state(ValueStack* s) { _exception_state = s; }
203 ciMethod* method() const { return scope()->method(); }
204 ciBytecodeStream* stream() const { return scope_data()->stream(); }
205 Instruction* last() const { return _last; }
206 Bytecodes::Code code() const { return stream()->cur_bc(); }
207 int bci() const { return stream()->cur_bci(); }
208 int next_bci() const { return stream()->next_bci(); }
209
210 // unified bailout support
211 void bailout(const char* msg) const { compilation()->bailout(msg); }
212 bool bailed_out() const { return compilation()->bailed_out(); }
213
214 // stack manipulation helpers
215 void ipush(Value t) const { state()->ipush(t); }
216 void lpush(Value t) const { state()->lpush(t); }
217 void fpush(Value t) const { state()->fpush(t); }
218 void dpush(Value t) const { state()->dpush(t); }
219 void apush(Value t) const { state()->apush(t); }
220 void push(ValueType* type, Value t) const { state()-> push(type, t); }
221
222 Value ipop() { return state()->ipop(); }
223 Value lpop() { return state()->lpop(); }
224 Value fpop() { return state()->fpop(); }
225 Value dpop() { return state()->dpop(); }
226 Value apop() { return state()->apop(); }
227 Value pop(ValueType* type) { return state()-> pop(type); }
228
229 // instruction helpers
230 void load_constant();
231 void load_local(ValueType* type, int index);
232 void store_local(ValueType* type, int index);
233 void store_local(ValueStack* state, Value value, ValueType* type, int index);
234 void load_indexed (BasicType type);
235 void store_indexed(BasicType type);
236 void stack_op(Bytecodes::Code code);
237 void arithmetic_op(ValueType* type, Bytecodes::Code code, ValueStack* lock_stack = NULL);
238 void negate_op(ValueType* type);
239 void shift_op(ValueType* type, Bytecodes::Code code);
240 void logic_op(ValueType* type, Bytecodes::Code code);
241 void compare_op(ValueType* type, Bytecodes::Code code);
242 void convert(Bytecodes::Code op, BasicType from, BasicType to);
243 void increment();
244 void _goto(int from_bci, int to_bci);
245 void if_node(Value x, If::Condition cond, Value y, ValueStack* stack_before);
246 void if_zero(ValueType* type, If::Condition cond);
247 void if_null(ValueType* type, If::Condition cond);
248 void if_same(ValueType* type, If::Condition cond);
249 void jsr(int dest);
250 void ret(int local_index);
251 void table_switch();
252 void lookup_switch();
253 void method_return(Value x);
254 void call_register_finalizer();
255 void access_field(Bytecodes::Code code);
256 void invoke(Bytecodes::Code code);
257 void new_instance(int klass_index);
258 void new_type_array();
259 void new_object_array();
260 void check_cast(int klass_index);
261 void instance_of(int klass_index);
262 void monitorenter(Value x, int bci);
263 void monitorexit(Value x, int bci);
264 void new_multi_array(int dimensions);
265 void throw_op(int bci);
266 Value round_fp(Value fp_value);
267
268 // stack/code manipulation helpers
269 Instruction* append_with_bci(Instruction* instr, int bci);
270 Instruction* append(Instruction* instr);
271 Instruction* append_split(StateSplit* instr);
272
273 // other helpers
274 static bool is_initialized() { return _is_initialized; }
275 static bool is_async(Bytecodes::Code code) {
276 assert(0 <= code && code < Bytecodes::number_of_java_codes, "illegal bytecode");
277 return _is_async[code];
278 }
279 BlockBegin* block_at(int bci) { return scope_data()->block_at(bci); }
280 XHandlers* handle_exception(int bci);
281 void connect_to_end(BlockBegin* beg);
282 void null_check(Value value);
283 void eliminate_redundant_phis(BlockBegin* start);
284 BlockEnd* iterate_bytecodes_for_block(int bci);
285 void iterate_all_blocks(bool start_in_current_block_for_inlining = false);
286 Dependencies* dependency_recorder() const; // = compilation()->dependencies()
287 bool direct_compare(ciKlass* k);
288
289 void kill_field(ciField* field);
290 void kill_array(Value value);
291 void kill_all();
292
293 ValueStack* lock_stack();
294
295 //
296 // Inlining support
297 //
298
299 // accessors
300 bool parsing_jsr() const { return scope_data()->parsing_jsr(); }
301 BlockBegin* continuation() const { return scope_data()->continuation(); }
302 ValueStack* continuation_state() const { return scope_data()->continuation_state(); }
303 BlockBegin* jsr_continuation() const { return scope_data()->jsr_continuation(); }
304 int caller_stack_size() const { return scope_data()->caller_stack_size(); }
305 void set_continuation(BlockBegin* continuation) { scope_data()->set_continuation(continuation); }
306 void set_inline_cleanup_info(BlockBegin* block,
307 Instruction* return_prev,
308 ValueStack* return_state) { scope_data()->set_inline_cleanup_info(block,
309 return_prev,
310 return_state); }
311 BlockBegin* inline_cleanup_block() const { return scope_data()->inline_cleanup_block(); }
312 Instruction* inline_cleanup_return_prev() const { return scope_data()->inline_cleanup_return_prev(); }
313 ValueStack* inline_cleanup_state() const { return scope_data()->inline_cleanup_state(); }
314 void incr_num_returns() { scope_data()->incr_num_returns(); }
315 int num_returns() const { return scope_data()->num_returns(); }
316 intx max_inline_size() const { return scope_data()->max_inline_size(); }
317 int inline_level() const { return scope()->level(); }
318 int recursive_inline_level(ciMethod* callee) const;
319
320 // inlining of synchronized methods
321 void inline_sync_entry(Value lock, BlockBegin* sync_handler);
322 void fill_sync_handler(Value lock, BlockBegin* sync_handler, bool default_handler = false);
323
324 // inliners
325 bool try_inline(ciMethod* callee, bool holder_known);
326 bool try_inline_intrinsics(ciMethod* callee);
327 bool try_inline_full (ciMethod* callee, bool holder_known);
328 bool try_inline_jsr(int jsr_dest_bci);
329
330 // helpers
331 void inline_bailout(const char* msg);
332 BlockBegin* header_block(BlockBegin* entry, BlockBegin::Flag f, ValueStack* state);
333 BlockBegin* setup_start_block(int osr_bci, BlockBegin* std_entry, BlockBegin* osr_entry, ValueStack* init_state);
334 void setup_osr_entry_block();
335 void clear_inline_bailout();
336 ValueStack* state_at_entry();
337 void push_root_scope(IRScope* scope, BlockList* bci2block, BlockBegin* start);
338 void push_scope(ciMethod* callee, BlockBegin* continuation);
339 void push_scope_for_jsr(BlockBegin* jsr_continuation, int jsr_dest_bci);
340 void pop_scope();
341 void pop_scope_for_jsr();
342
343 bool append_unsafe_get_obj(ciMethod* callee, BasicType t, bool is_volatile);
344 bool append_unsafe_put_obj(ciMethod* callee, BasicType t, bool is_volatile);
345 bool append_unsafe_get_raw(ciMethod* callee, BasicType t);
346 bool append_unsafe_put_raw(ciMethod* callee, BasicType t);
347 bool append_unsafe_prefetch(ciMethod* callee, bool is_store, bool is_static);
348 void append_unsafe_CAS(ciMethod* callee);
349
350 NOT_PRODUCT(void print_inline_result(ciMethod* callee, bool res);)
351
352 // methodDataOop profiling helpers
353 void profile_call(Value recv, ciKlass* predicted_holder);
354 void profile_invocation(ciMethod* method);
355 void profile_bci(int bci);
356
357 // Helpers for generation of profile information
358 bool profile_branches() {
359 return _compilation->env()->comp_level() == CompLevel_fast_compile &&
360 Tier1UpdateMethodData && Tier1ProfileBranches;
361 }
362 bool profile_calls() {
363 return _compilation->env()->comp_level() == CompLevel_fast_compile &&
364 Tier1UpdateMethodData && Tier1ProfileCalls;
365 }
366 bool profile_inlined_calls() {
367 return profile_calls() && Tier1ProfileInlinedCalls;
368 }
369 bool profile_checkcasts() {
370 return _compilation->env()->comp_level() == CompLevel_fast_compile &&
371 Tier1UpdateMethodData && Tier1ProfileCheckcasts;
372 }
373
374 public:
375 NOT_PRODUCT(void print_stats();)
376
377 // initialization
378 static void initialize();
379
380 // public
381 static bool can_trap(ciMethod* method, Bytecodes::Code code) {
382 assert(0 <= code && code < Bytecodes::number_of_java_codes, "illegal bytecode");
383 if (_can_trap[code]) return true;
384 // special handling for finalizer registration
385 return code == Bytecodes::_return && method->intrinsic_id() == vmIntrinsics::_Object_init;
386 }
387
388 // creation
389 GraphBuilder(Compilation* compilation, IRScope* scope);
390 static void sort_top_into_worklist(BlockList* worklist, BlockBegin* top);
391
392 BlockBegin* start() const { return _start; }
393 };
394