1 /*
2 * Copyright (c) 1999, 2023, 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_C1_C1_GRAPHBUILDER_HPP
26 #define SHARE_C1_C1_GRAPHBUILDER_HPP
27
28 #include "c1/c1_IR.hpp"
29 #include "c1/c1_Instruction.hpp"
30 #include "c1/c1_ValueMap.hpp"
31 #include "c1/c1_ValueStack.hpp"
32 #include "ci/ciMethodData.hpp"
33 #include "ci/ciStreams.hpp"
34 #include "compiler/compileLog.hpp"
35
36 class MemoryBuffer;
37
38 class DelayedFieldAccess : public CompilationResourceObj {
39 private:
40 Value _obj;
41 ciInstanceKlass* _holder;
42 int _offset;
43 public:
44 DelayedFieldAccess(Value obj, ciInstanceKlass* holder, int offset)
45 : _obj(obj), _holder(holder) , _offset(offset) { }
46
47 Value obj() const { return _obj; }
48 ciInstanceKlass* holder() const { return _holder; }
49 int offset() const { return _offset; }
50 void inc_offset(int offset) { _offset += offset; }
51 };
52
53 class GraphBuilder {
54 friend class JfrResolution;
55 private:
56 // Per-scope data. These are pushed and popped as we descend into
57 // inlined methods. Currently in order to generate good code in the
58 // inliner we have to attempt to inline methods directly into the
59 // basic block we are parsing; this adds complexity.
60 class ScopeData: public CompilationResourceObj {
61 private:
62 ScopeData* _parent;
63 // bci-to-block mapping
64 BlockList* _bci2block;
65 // Scope
66 IRScope* _scope;
67 // Whether this scope or any parent scope has exception handlers
68 bool _has_handler;
69 // The bytecodes
70 ciBytecodeStream* _stream;
71
72 // Work list
73 BlockList* _work_list;
74
75 // Maximum inline size for this scope
76 intx _max_inline_size;
77 // Expression stack depth at point where inline occurred
78 int _caller_stack_size;
79
80 // The continuation point for the inline. Currently only used in
81 // multi-block inlines, but eventually would like to use this for
82 // all inlines for uniformity and simplicity; in this case would
83 // get the continuation point from the BlockList instead of
84 // fabricating it anew because Invokes would be considered to be
85 // BlockEnds.
86 BlockBegin* _continuation;
87
88 // Was this ScopeData created only for the parsing and inlining of
89 // a jsr?
90 bool _parsing_jsr;
91 // We track the destination bci of the jsr only to determine
92 // bailout conditions, since we only handle a subset of all of the
93 // possible jsr-ret control structures. Recursive invocations of a
94 // jsr are disallowed by the verifier.
95 int _jsr_entry_bci;
96 // We need to track the local variable in which the return address
97 // was stored to ensure we can handle inlining the jsr, because we
98 // don't handle arbitrary jsr/ret constructs.
99 int _jsr_ret_addr_local;
100 // If we are parsing a jsr, the continuation point for rets
101 BlockBegin* _jsr_continuation;
102 // Cloned XHandlers for jsr-related ScopeDatas
103 XHandlers* _jsr_xhandlers;
104
105 // Number of returns seen in this scope
106 int _num_returns;
107
108 // In order to generate profitable code for inlining, we currently
109 // have to perform an optimization for single-block inlined
110 // methods where we continue parsing into the same block. This
111 // allows us to perform CSE across inlined scopes and to avoid
112 // storing parameters to the stack. Having a global register
113 // allocator and being able to perform global CSE would allow this
114 // code to be removed and thereby simplify the inliner.
115 BlockBegin* _cleanup_block; // The block to which the return was added
116 Instruction* _cleanup_return_prev; // Instruction before return instruction
117 ValueStack* _cleanup_state; // State of that block (not yet pinned)
118
119 // When inlining do not push the result on the stack
120 bool _ignore_return;
121
122 public:
123 ScopeData(ScopeData* parent);
124
125 ScopeData* parent() const { return _parent; }
126
127 BlockList* bci2block() const { return _bci2block; }
128 void set_bci2block(BlockList* bci2block) { _bci2block = bci2block; }
129
130 // NOTE: this has a different effect when parsing jsrs
131 BlockBegin* block_at(int bci);
132
133 IRScope* scope() const { return _scope; }
134 // Has side-effect of setting has_handler flag
135 void set_scope(IRScope* scope);
136
137 // Whether this or any parent scope has exception handlers
138 bool has_handler() const { return _has_handler; }
139 void set_has_handler() { _has_handler = true; }
140
141 // Exception handlers list to be used for this scope
142 XHandlers* xhandlers() const;
143
144 // How to get a block to be parsed
145 void add_to_work_list(BlockBegin* block);
146 // How to remove the next block to be parsed; returns null if none left
147 BlockBegin* remove_from_work_list();
148 // Indicates parse is over
149 bool is_work_list_empty() const;
150
151 ciBytecodeStream* stream() { return _stream; }
152 void set_stream(ciBytecodeStream* stream) { _stream = stream; }
153
154 intx max_inline_size() const { return _max_inline_size; }
155
156 BlockBegin* continuation() const { return _continuation; }
157 void set_continuation(BlockBegin* cont) { _continuation = cont; }
158
159 // Indicates whether this ScopeData was pushed only for the
160 // parsing and inlining of a jsr
161 bool parsing_jsr() const { return _parsing_jsr; }
162 void set_parsing_jsr() { _parsing_jsr = true; }
163 int jsr_entry_bci() const { return _jsr_entry_bci; }
164 void set_jsr_entry_bci(int bci) { _jsr_entry_bci = bci; }
165 void set_jsr_return_address_local(int local_no){ _jsr_ret_addr_local = local_no; }
166 int jsr_return_address_local() const { return _jsr_ret_addr_local; }
167 // Must be called after scope is set up for jsr ScopeData
168 void setup_jsr_xhandlers();
169
170 // The jsr continuation is only used when parsing_jsr is true, and
171 // is different from the "normal" continuation since we can end up
172 // doing a return (rather than a ret) from within a subroutine
173 BlockBegin* jsr_continuation() const { return _jsr_continuation; }
174 void set_jsr_continuation(BlockBegin* cont) { _jsr_continuation = cont; }
175
176 int num_returns();
177 void incr_num_returns();
178
179 void set_inline_cleanup_info(BlockBegin* block,
180 Instruction* return_prev,
181 ValueStack* return_state);
182 BlockBegin* inline_cleanup_block() const { return _cleanup_block; }
183 Instruction* inline_cleanup_return_prev() const{ return _cleanup_return_prev; }
184 ValueStack* inline_cleanup_state() const { return _cleanup_state; }
185
186 bool ignore_return() const { return _ignore_return; }
187 void set_ignore_return(bool ignore_return) { _ignore_return = ignore_return; }
188 };
189
190 // for all GraphBuilders
191 static bool _can_trap[Bytecodes::number_of_java_codes];
192
193 // for each instance of GraphBuilder
194 ScopeData* _scope_data; // Per-scope data; used for inlining
195 Compilation* _compilation; // the current compilation
196 ValueMap* _vmap; // the map of values encountered (for CSE)
197 MemoryBuffer* _memory;
198 const char* _inline_bailout_msg; // non-null if most recent inline attempt failed
199 int _instruction_count; // for bailing out in pathological jsr/ret cases
200 BlockBegin* _start; // the start block
201 BlockBegin* _osr_entry; // the osr entry block block
202 ValueStack* _initial_state; // The state for the start block
203
204 // for each call to connect_to_end; can also be set by inliner
205 BlockBegin* _block; // the current block
206 ValueStack* _state; // the current execution state
207 Instruction* _last; // the last instruction added
208 bool _skip_block; // skip processing of the rest of this block
209
210 // support for optimization of accesses to flat fields and flat arrays
211 DelayedFieldAccess* _pending_field_access;
212 DelayedLoadIndexed* _pending_load_indexed;
213
214 // accessors
215 ScopeData* scope_data() const { return _scope_data; }
216 Compilation* compilation() const { return _compilation; }
217 BlockList* bci2block() const { return scope_data()->bci2block(); }
218 ValueMap* vmap() const { assert(UseLocalValueNumbering, "should not access otherwise"); return _vmap; }
219 bool has_handler() const { return scope_data()->has_handler(); }
220
221 BlockBegin* block() const { return _block; }
222 ValueStack* state() const { return _state; }
223 void set_state(ValueStack* state) { _state = state; }
224 IRScope* scope() const { return scope_data()->scope(); }
225 ciMethod* method() const { return scope()->method(); }
226 ciBytecodeStream* stream() const { return scope_data()->stream(); }
227 Instruction* last() const { return _last; }
228 Bytecodes::Code code() const { return stream()->cur_bc(); }
229 int bci() const { return stream()->cur_bci(); }
230 int next_bci() const { return stream()->next_bci(); }
231 bool has_pending_field_access() { return _pending_field_access != nullptr; }
232 DelayedFieldAccess* pending_field_access() { return _pending_field_access; }
233 void set_pending_field_access(DelayedFieldAccess* delayed) { _pending_field_access = delayed; }
234 bool has_pending_load_indexed() { return _pending_load_indexed != nullptr; }
235 DelayedLoadIndexed* pending_load_indexed() { return _pending_load_indexed; }
236 void set_pending_load_indexed(DelayedLoadIndexed* delayed) { _pending_load_indexed = delayed; }
237
238 // unified bailout support
239 void bailout(const char* msg) const { compilation()->bailout(msg); }
240 bool bailed_out() const { return compilation()->bailed_out(); }
241
242 // stack manipulation helpers
243 void ipush(Value t) const { state()->ipush(t); }
244 void lpush(Value t) const { state()->lpush(t); }
245 void fpush(Value t) const { state()->fpush(t); }
246 void dpush(Value t) const { state()->dpush(t); }
247 void apush(Value t) const { state()->apush(t); }
248 void push(ValueType* type, Value t) const { state()-> push(type, t); }
249
250 Value ipop() { return state()->ipop(); }
251 Value lpop() { return state()->lpop(); }
252 Value fpop() { return state()->fpop(); }
253 Value dpop() { return state()->dpop(); }
254 Value apop() { return state()->apop(); }
255 Value pop(ValueType* type) { return state()-> pop(type); }
256
257 // instruction helpers
258 void load_constant();
259 void load_local(ValueType* type, int index);
260 void store_local(ValueType* type, int index);
261 void store_local(ValueStack* state, Value value, int index);
262 void load_indexed (BasicType type);
263 void store_indexed(BasicType type);
264 void stack_op(Bytecodes::Code code);
265 void arithmetic_op(ValueType* type, Bytecodes::Code code, ValueStack* state_before = nullptr);
266 void negate_op(ValueType* type);
267 void shift_op(ValueType* type, Bytecodes::Code code);
268 void logic_op(ValueType* type, Bytecodes::Code code);
269 void compare_op(ValueType* type, Bytecodes::Code code);
270 void convert(Bytecodes::Code op, BasicType from, BasicType to);
271 void increment();
272 void _goto(int from_bci, int to_bci);
273 void if_node(Value x, If::Condition cond, Value y, ValueStack* stack_before);
274 void if_zero(ValueType* type, If::Condition cond);
275 void if_null(ValueType* type, If::Condition cond);
276 void if_same(ValueType* type, If::Condition cond);
277 void jsr(int dest);
278 void ret(int local_index);
279 void table_switch();
280 void lookup_switch();
281 void method_return(Value x, bool ignore_return = false);
282 void call_register_finalizer();
283 void access_field(Bytecodes::Code code);
284 void invoke(Bytecodes::Code code);
285 void new_instance(int klass_index);
286 void new_type_array();
287 void new_object_array();
288 void check_cast(int klass_index);
289 void instance_of(int klass_index);
290 void monitorenter(Value x, int bci);
291 void monitorexit(Value x, int bci);
292 void new_multi_array(int dimensions);
293 void throw_op(int bci);
294 Value round_fp(Value fp_value);
295
296 // inline types
297 void default_value(int klass_index);
298 void withfield(int field_index);
299 void copy_inline_content(ciInlineKlass* vk, Value src, int src_off, Value dest, int dest_off, ValueStack* state_before, ciField* encloding_field = nullptr);
300
301 // stack/code manipulation helpers
302 Instruction* append_with_bci(Instruction* instr, int bci);
303 Instruction* append(Instruction* instr);
304 Instruction* append_split(StateSplit* instr);
305
306 // other helpers
307 BlockBegin* block_at(int bci) { return scope_data()->block_at(bci); }
308 XHandlers* handle_exception(Instruction* instruction);
309 void connect_to_end(BlockBegin* beg);
310 void null_check(Value value);
311 void eliminate_redundant_phis(BlockBegin* start);
312 BlockEnd* iterate_bytecodes_for_block(int bci);
313 void iterate_all_blocks(bool start_in_current_block_for_inlining = false);
314 Dependencies* dependency_recorder() const; // = compilation()->dependencies()
315 bool direct_compare(ciKlass* k);
316 Value make_constant(ciConstant value, ciField* field);
317
318 void kill_all();
319
320 // use of state copy routines (try to minimize unnecessary state
321 // object allocations):
322
323 // - if the instruction unconditionally needs a full copy of the
324 // state (for patching for example), then use copy_state_before*
325
326 // - if the instruction needs a full copy of the state only for
327 // handler generation (Instruction::needs_exception_state() returns
328 // false) then use copy_state_exhandling*
329
330 // - if the instruction needs either a full copy of the state for
331 // handler generation and a least a minimal copy of the state (as
332 // returned by Instruction::exception_state()) for debug info
333 // generation (that is when Instruction::needs_exception_state()
334 // returns true) then use copy_state_for_exception*
335
336 ValueStack* copy_state_before_with_bci(int bci);
337 ValueStack* copy_state_before();
338 ValueStack* copy_state_exhandling_with_bci(int bci);
339 ValueStack* copy_state_exhandling();
340 ValueStack* copy_state_for_exception_with_bci(int bci);
341 ValueStack* copy_state_for_exception();
342 ValueStack* copy_state_if_bb(bool is_bb) { return (is_bb || compilation()->is_optimistic()) ? copy_state_before() : nullptr; }
343 ValueStack* copy_state_indexed_access() { return compilation()->is_optimistic() ? copy_state_before() : copy_state_for_exception(); }
344
345 //
346 // Inlining support
347 //
348
349 // accessors
350 bool parsing_jsr() const { return scope_data()->parsing_jsr(); }
351 BlockBegin* continuation() const { return scope_data()->continuation(); }
352 BlockBegin* jsr_continuation() const { return scope_data()->jsr_continuation(); }
353 void set_continuation(BlockBegin* continuation) { scope_data()->set_continuation(continuation); }
354 void set_inline_cleanup_info(BlockBegin* block,
355 Instruction* return_prev,
356 ValueStack* return_state) { scope_data()->set_inline_cleanup_info(block,
357 return_prev,
358 return_state); }
359 void set_inline_cleanup_info() {
360 set_inline_cleanup_info(_block, _last, _state);
361 }
362 BlockBegin* inline_cleanup_block() const { return scope_data()->inline_cleanup_block(); }
363 Instruction* inline_cleanup_return_prev() const { return scope_data()->inline_cleanup_return_prev(); }
364 ValueStack* inline_cleanup_state() const { return scope_data()->inline_cleanup_state(); }
365 void restore_inline_cleanup_info() {
366 _block = inline_cleanup_block();
367 _last = inline_cleanup_return_prev();
368 _state = inline_cleanup_state();
369 }
370 void incr_num_returns() { scope_data()->incr_num_returns(); }
371 int num_returns() const { return scope_data()->num_returns(); }
372 intx max_inline_size() const { return scope_data()->max_inline_size(); }
373 int inline_level() const { return scope()->level(); }
374 int recursive_inline_level(ciMethod* callee) const;
375
376 // inlining of synchronized methods
377 void inline_sync_entry(Value lock, BlockBegin* sync_handler);
378 void fill_sync_handler(Value lock, BlockBegin* sync_handler, bool default_handler = false);
379
380 void build_graph_for_intrinsic(ciMethod* callee, bool ignore_return);
381
382 // inliners
383 bool try_inline( ciMethod* callee, bool holder_known, bool ignore_return, Bytecodes::Code bc = Bytecodes::_illegal, Value receiver = nullptr);
384 bool try_inline_intrinsics(ciMethod* callee, bool ignore_return = false);
385 bool try_inline_full( ciMethod* callee, bool holder_known, bool ignore_return, Bytecodes::Code bc = Bytecodes::_illegal, Value receiver = nullptr);
386 bool try_inline_jsr(int jsr_dest_bci);
387
388 const char* check_can_parse(ciMethod* callee) const;
389 const char* should_not_inline(ciMethod* callee) const;
390
391 // JSR 292 support
392 bool try_method_handle_inline(ciMethod* callee, bool ignore_return);
393
394 // Inline type support
395 void update_larval_state(Value v) {
396 if (v != nullptr && v->as_NewInlineTypeInstance() != nullptr) {
397 v->as_NewInlineTypeInstance()->set_not_larva_anymore();
398 }
399 }
400 void update_larva_stack_count(Value v) {
401 if (v != nullptr && v->as_NewInlineTypeInstance() != nullptr &&
402 v->as_NewInlineTypeInstance()->in_larval_state()) {
403 v->as_NewInlineTypeInstance()->decrement_on_stack_count();
404 }
405 }
406
407 // helpers
408 void inline_bailout(const char* msg);
409 BlockBegin* header_block(BlockBegin* entry, BlockBegin::Flag f, ValueStack* state);
410 BlockBegin* setup_start_block(int osr_bci, BlockBegin* std_entry, BlockBegin* osr_entry, ValueStack* init_state);
411 void setup_osr_entry_block();
412 void clear_inline_bailout();
413 ValueStack* state_at_entry();
414 void push_root_scope(IRScope* scope, BlockList* bci2block, BlockBegin* start);
415 void push_scope(ciMethod* callee, BlockBegin* continuation);
416 void push_scope_for_jsr(BlockBegin* jsr_continuation, int jsr_dest_bci);
417 void pop_scope();
418 void pop_scope_for_jsr();
419
420 void append_unsafe_get(ciMethod* callee, BasicType t, bool is_volatile);
421 void append_unsafe_put(ciMethod* callee, BasicType t, bool is_volatile);
422 void append_unsafe_CAS(ciMethod* callee);
423 void append_unsafe_get_and_set(ciMethod* callee, bool is_add);
424 void append_char_access(ciMethod* callee, bool is_store);
425
426 void print_inlining(ciMethod* callee, const char* msg, bool success = true);
427
428 void profile_call(ciMethod* callee, Value recv, ciKlass* predicted_holder, Values* obj_args, bool inlined);
429 void profile_return_type(Value ret, ciMethod* callee, ciMethod* m = nullptr, int bci = -1);
430 void profile_invocation(ciMethod* inlinee, ValueStack* state);
431
432 // Shortcuts to profiling control.
433 bool is_profiling() { return _compilation->is_profiling(); }
434 bool profile_branches() { return _compilation->profile_branches(); }
435 bool profile_calls() { return _compilation->profile_calls(); }
436 bool profile_inlined_calls() { return _compilation->profile_inlined_calls(); }
437 bool profile_checkcasts() { return _compilation->profile_checkcasts(); }
438 bool profile_parameters() { return _compilation->profile_parameters(); }
439 bool profile_arguments() { return _compilation->profile_arguments(); }
440 bool profile_return() { return _compilation->profile_return(); }
441 bool profile_array_accesses(){ return _compilation->profile_array_accesses();}
442
443 Values* args_list_for_profiling(ciMethod* target, int& start, bool may_have_receiver);
444 Values* collect_args_for_profiling(Values* args, ciMethod* target, bool may_have_receiver);
445 void check_args_for_profiling(Values* obj_args, int expected);
446
447 public:
448 NOT_PRODUCT(void print_stats();)
449
450 // initialization
451 static void initialize();
452
453 // public
454 static bool can_trap(ciMethod* method, Bytecodes::Code code) {
455 assert(0 <= code && code < Bytecodes::number_of_java_codes, "illegal bytecode");
456 if (_can_trap[code]) return true;
457 // special handling for finalizer registration
458 return code == Bytecodes::_return && method->intrinsic_id() == vmIntrinsics::_Object_init;
459 }
460
461 // creation
462 GraphBuilder(Compilation* compilation, IRScope* scope);
463 static void sort_top_into_worklist(BlockList* worklist, BlockBegin* top);
464
465 BlockBegin* start() const { return _start; }
466 };
467
468 #endif // SHARE_C1_C1_GRAPHBUILDER_HPP