1 /*
2 * Copyright (c) 2005, 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_LIRGENERATOR_HPP
26 #define SHARE_C1_C1_LIRGENERATOR_HPP
27
28 #include "c1/c1_Decorators.hpp"
29 #include "c1/c1_Instruction.hpp"
30 #include "c1/c1_LIR.hpp"
31 #include "ci/ciMethodData.hpp"
32 #include "gc/shared/barrierSet.hpp"
33 #include "jfr/support/jfrIntrinsics.hpp"
34 #include "utilities/macros.hpp"
35 #include "utilities/sizes.hpp"
36
37 class BarrierSetC1;
38
39 // The classes responsible for code emission and register allocation
40
41
42 class LIRGenerator;
43 class LIREmitter;
44 class Invoke;
45 class LIRItem;
46
47 typedef GrowableArray<LIRItem*> LIRItemList;
48
49 class C1SwitchRange: public CompilationResourceObj {
50 private:
51 int _low_key;
52 int _high_key;
53 BlockBegin* _sux;
54 public:
55 C1SwitchRange(int start_key, BlockBegin* sux): _low_key(start_key), _high_key(start_key), _sux(sux) {}
56 void set_high_key(int key) { _high_key = key; }
57
58 int high_key() const { return _high_key; }
59 int low_key() const { return _low_key; }
60 BlockBegin* sux() const { return _sux; }
61 };
62
63 typedef GrowableArray<C1SwitchRange*> SwitchRangeArray;
64 typedef GrowableArray<C1SwitchRange*> SwitchRangeList;
65
66 class ResolveNode;
67
68 typedef GrowableArray<ResolveNode*> NodeList;
69
70 // Node objects form a directed graph of LIR_Opr
71 // Edges between Nodes represent moves from one Node to its destinations
72 class ResolveNode: public CompilationResourceObj {
73 private:
74 LIR_Opr _operand; // the source or destinaton
75 NodeList _destinations; // for the operand
76 bool _assigned; // Value assigned to this Node?
77 bool _visited; // Node already visited?
78 bool _start_node; // Start node already visited?
79
80 public:
81 ResolveNode(LIR_Opr operand)
82 : _operand(operand)
83 , _assigned(false)
84 , _visited(false)
85 , _start_node(false) {};
86
87 // accessors
88 LIR_Opr operand() const { return _operand; }
89 int no_of_destinations() const { return _destinations.length(); }
90 ResolveNode* destination_at(int i) { return _destinations.at(i); }
91 bool assigned() const { return _assigned; }
92 bool visited() const { return _visited; }
93 bool start_node() const { return _start_node; }
94
95 // modifiers
96 void append(ResolveNode* dest) { _destinations.append(dest); }
97 void set_assigned() { _assigned = true; }
98 void set_visited() { _visited = true; }
99 void set_start_node() { _start_node = true; }
100 };
101
102
103 // This is shared state to be used by the PhiResolver so the operand
104 // arrays don't have to be reallocated for each resolution.
105 class PhiResolverState: public CompilationResourceObj {
106 friend class PhiResolver;
107
108 private:
109 NodeList _virtual_operands; // Nodes where the operand is a virtual register
110 NodeList _other_operands; // Nodes where the operand is not a virtual register
111 NodeList _vreg_table; // Mapping from virtual register to Node
112
113 public:
114 PhiResolverState() {}
115
116 void reset();
117 };
118
119
120 // class used to move value of phi operand to phi function
121 class PhiResolver: public CompilationResourceObj {
122 private:
123 LIRGenerator* _gen;
124 PhiResolverState& _state; // temporary state cached by LIRGenerator
125
126 ResolveNode* _loop;
127 LIR_Opr _temp;
128
129 // access to shared state arrays
130 NodeList& virtual_operands() { return _state._virtual_operands; }
131 NodeList& other_operands() { return _state._other_operands; }
132 NodeList& vreg_table() { return _state._vreg_table; }
133
134 ResolveNode* create_node(LIR_Opr opr, bool source);
135 ResolveNode* source_node(LIR_Opr opr) { return create_node(opr, true); }
136 ResolveNode* destination_node(LIR_Opr opr) { return create_node(opr, false); }
137
138 void emit_move(LIR_Opr src, LIR_Opr dest);
139 void move_to_temp(LIR_Opr src);
140 void move_temp_to(LIR_Opr dest);
141 void move(ResolveNode* src, ResolveNode* dest);
142
143 LIRGenerator* gen() {
144 return _gen;
145 }
146
147 public:
148 PhiResolver(LIRGenerator* _lir_gen);
149 ~PhiResolver();
150
151 void move(LIR_Opr src, LIR_Opr dest);
152 };
153
154
155 // only the classes below belong in the same file
156 class LIRGenerator: public InstructionVisitor, public BlockClosure {
157 // LIRGenerator should never get instatiated on the heap.
158 private:
159 void* operator new(size_t size) throw();
160 void* operator new[](size_t size) throw();
161 void operator delete(void* p) { ShouldNotReachHere(); }
162 void operator delete[](void* p) { ShouldNotReachHere(); }
163
164 Compilation* _compilation;
165 ciMethod* _method; // method that we are compiling
166 PhiResolverState _resolver_state;
167 BlockBegin* _block;
168 int _virtual_register_number;
169 Values _instruction_for_operand;
170 BitMap2D _vreg_flags; // flags which can be set on a per-vreg basis
171 LIR_List* _lir;
172 bool _in_conditional_code;
173
174 LIRGenerator* gen() {
175 return this;
176 }
177
178 void print_if_not_loaded(const NewInstance* new_instance) PRODUCT_RETURN;
179
180 public:
181 #ifdef ASSERT
182 LIR_List* lir(const char * file, int line) const {
183 _lir->set_file_and_line(file, line);
184 return _lir;
185 }
186 #endif
187 LIR_List* lir() const {
188 return _lir;
189 }
190
191 private:
192 // a simple cache of constants used within a block
193 GrowableArray<LIR_Const*> _constants;
194 LIR_OprList _reg_for_constants;
195 Values _unpinned_constants;
196
197 friend class PhiResolver;
198
199 void set_in_conditional_code(bool v);
200 public:
201 // unified bailout support
202 void bailout(const char* msg) const { compilation()->bailout(msg); }
203 bool bailed_out() const { return compilation()->bailed_out(); }
204
205 void block_do_prolog(BlockBegin* block);
206 void block_do_epilog(BlockBegin* block);
207
208 // register allocation
209 LIR_Opr rlock(Value instr); // lock a free register
210 LIR_Opr rlock_result(Value instr);
211 LIR_Opr rlock_result(Value instr, BasicType type);
212 LIR_Opr rlock_byte(BasicType type);
213 LIR_Opr rlock_callee_saved(BasicType type);
214
215 // get a constant into a register and get track of what register was used
216 LIR_Opr load_constant(Constant* x);
217 LIR_Opr load_constant(LIR_Const* constant);
218
219 bool in_conditional_code() { return _in_conditional_code; }
220 // Given an immediate value, return an operand usable in logical ops.
221 LIR_Opr load_immediate(jlong x, BasicType type);
222
223 void set_result(Value x, LIR_Opr opr) {
224 assert(opr->is_valid(), "must set to valid value");
225 assert(x->operand()->is_illegal(), "operand should never change");
226 assert(!opr->is_register() || opr->is_virtual(), "should never set result to a physical register");
227 x->set_operand(opr);
228 assert(opr == x->operand(), "must be");
229 if (opr->is_virtual()) {
230 _instruction_for_operand.at_put_grow(opr->vreg_number(), x, nullptr);
231 }
232 }
233 void set_no_result(Value x) { assert(!x->has_uses(), "can't have use"); x->clear_operand(); }
234
235 friend class LIRItem;
236
237 LIR_Opr round_item(LIR_Opr opr);
238 LIR_Opr force_to_spill(LIR_Opr value, BasicType t);
239
240 PhiResolverState& resolver_state() { return _resolver_state; }
241
242 void move_to_phi(PhiResolver* resolver, Value cur_val, Value sux_val);
243 void move_to_phi(ValueStack* cur_state);
244
245 void load_klass(LIR_Opr obj, LIR_Opr klass, CodeEmitInfo* null_check_info);
246
247 // platform dependent
248 LIR_Opr getThreadPointer();
249
250 private:
251 // code emission
252 void do_ArithmeticOp_Long(ArithmeticOp* x);
253 void do_ArithmeticOp_Int (ArithmeticOp* x);
254 void do_ArithmeticOp_FPU (ArithmeticOp* x);
255
256 void do_RegisterFinalizer(Intrinsic* x);
257 void do_isInstance(Intrinsic* x);
258 void do_isPrimitive(Intrinsic* x);
259 void do_getModifiers(Intrinsic* x);
260 void do_getClass(Intrinsic* x);
261 void do_getObjectSize(Intrinsic* x);
262 void do_currentCarrierThread(Intrinsic* x);
263 void do_scopedValueCache(Intrinsic* x);
264 void do_vthread(Intrinsic* x);
265 void do_JavaThreadField(Intrinsic* x, ByteSize offset);
266 void do_FmaIntrinsic(Intrinsic* x);
267 void do_MathIntrinsic(Intrinsic* x);
268 void do_LibmIntrinsic(Intrinsic* x);
269 void do_ArrayCopy(Intrinsic* x);
270 void do_CompareAndSwap(Intrinsic* x, ValueType* type);
271 void do_PreconditionsCheckIndex(Intrinsic* x, BasicType type);
272 void do_FPIntrinsics(Intrinsic* x);
273 void do_Reference_get(Intrinsic* x);
274 void do_update_CRC32(Intrinsic* x);
275 void do_update_CRC32C(Intrinsic* x);
276 void do_vectorizedMismatch(Intrinsic* x);
277 void do_blackhole(Intrinsic* x);
278
279 bool inline_type_field_access_prolog(AccessField* x);
280 void access_flat_array(bool is_load, LIRItem& array, LIRItem& index, LIRItem& obj_item, ciField* field = nullptr, int offset = 0);
281 void access_sub_element(LIRItem& array, LIRItem& index, LIR_Opr& result, ciField* field, int sub_offset);
282 LIR_Opr get_and_load_element_address(LIRItem& array, LIRItem& index);
283 bool needs_flat_array_store_check(StoreIndexed* x);
284 void check_flat_array(LIR_Opr array, LIR_Opr value, CodeStub* slow_path);
285 bool needs_null_free_array_store_check(StoreIndexed* x);
286 void check_null_free_array(LIRItem& array, LIRItem& value, CodeEmitInfo* info);
287 void substitutability_check(IfOp* x, LIRItem& left, LIRItem& right, LIRItem& t_val, LIRItem& f_val);
288 void substitutability_check(If* x, LIRItem& left, LIRItem& right);
289 void substitutability_check_common(Value left_val, Value right_val, LIRItem& left, LIRItem& right,
290 LIR_Opr equal_result, LIR_Opr not_equal_result, LIR_Opr result, CodeEmitInfo* info);
291 void init_temps_for_substitutability_check(LIR_Opr& tmp1, LIR_Opr& tmp2);
292
293 public:
294 LIR_Opr call_runtime(BasicTypeArray* signature, LIRItemList* args, address entry, ValueType* result_type, CodeEmitInfo* info);
295 LIR_Opr call_runtime(BasicTypeArray* signature, LIR_OprList* args, address entry, ValueType* result_type, CodeEmitInfo* info);
296
297 // convenience functions
298 LIR_Opr call_runtime(Value arg1, address entry, ValueType* result_type, CodeEmitInfo* info);
299 LIR_Opr call_runtime(Value arg1, Value arg2, address entry, ValueType* result_type, CodeEmitInfo* info);
300
301 // Access API
302
303 private:
304 BarrierSetC1 *_barrier_set;
305
306 public:
307 void access_store_at(DecoratorSet decorators, BasicType type,
308 LIRItem& base, LIR_Opr offset, LIR_Opr value,
309 CodeEmitInfo* patch_info = nullptr, CodeEmitInfo* store_emit_info = nullptr);
310
311 void access_load_at(DecoratorSet decorators, BasicType type,
312 LIRItem& base, LIR_Opr offset, LIR_Opr result,
313 CodeEmitInfo* patch_info = nullptr, CodeEmitInfo* load_emit_info = nullptr);
314
315 void access_load(DecoratorSet decorators, BasicType type,
316 LIR_Opr addr, LIR_Opr result);
317
318 LIR_Opr access_atomic_cmpxchg_at(DecoratorSet decorators, BasicType type,
319 LIRItem& base, LIRItem& offset, LIRItem& cmp_value, LIRItem& new_value);
320
321 LIR_Opr access_atomic_xchg_at(DecoratorSet decorators, BasicType type,
322 LIRItem& base, LIRItem& offset, LIRItem& value);
323
324 LIR_Opr access_atomic_add_at(DecoratorSet decorators, BasicType type,
325 LIRItem& base, LIRItem& offset, LIRItem& value);
326
327 // These need to guarantee JMM volatile semantics are preserved on each platform
328 // and requires one implementation per architecture.
329 LIR_Opr atomic_cmpxchg(BasicType type, LIR_Opr addr, LIRItem& cmp_value, LIRItem& new_value);
330 LIR_Opr atomic_xchg(BasicType type, LIR_Opr addr, LIRItem& new_value);
331 LIR_Opr atomic_add(BasicType type, LIR_Opr addr, LIRItem& new_value);
332
333 #ifdef CARDTABLEBARRIERSET_POST_BARRIER_HELPER
334 virtual void CardTableBarrierSet_post_barrier_helper(LIR_Opr addr, LIR_Const* card_table_base);
335 #endif
336
337 // specific implementations
338 void array_store_check(LIR_Opr value, LIR_Opr array, CodeEmitInfo* store_check_info, ciMethod* profiled_method, int profiled_bci);
339
340 static LIR_Opr result_register_for(ValueType* type, bool callee = false);
341
342 ciObject* get_jobject_constant(Value value);
343
344 LIRItemList* invoke_visit_arguments(Invoke* x);
345 void invoke_load_arguments(Invoke* x, LIRItemList* args, const LIR_OprList* arg_list);
346 void invoke_load_one_argument(LIRItem* param, LIR_Opr loc);
347 void trace_block_entry(BlockBegin* block);
348
349 // volatile field operations are never patchable because a klass
350 // must be loaded to know it's volatile which means that the offset
351 // it always known as well.
352 void volatile_field_store(LIR_Opr value, LIR_Address* address, CodeEmitInfo* info);
353 void volatile_field_load(LIR_Address* address, LIR_Opr result, CodeEmitInfo* info);
354
355 void put_Object_unsafe(LIR_Opr src, LIR_Opr offset, LIR_Opr data, BasicType type, bool is_volatile);
356 void get_Object_unsafe(LIR_Opr dest, LIR_Opr src, LIR_Opr offset, BasicType type, bool is_volatile);
357
358 void arithmetic_call_op (Bytecodes::Code code, LIR_Opr result, LIR_OprList* args);
359
360 void increment_counter(address counter, BasicType type, int step = 1);
361 void increment_counter(LIR_Address* addr, int step = 1);
362
363 void arithmetic_op(Bytecodes::Code code, LIR_Opr result, LIR_Opr left, LIR_Opr right, LIR_Opr tmp, CodeEmitInfo* info = nullptr);
364 // machine dependent. returns true if it emitted code for the multiply
365 bool strength_reduce_multiply(LIR_Opr left, jint constant, LIR_Opr result, LIR_Opr tmp);
366
367 void store_stack_parameter (LIR_Opr opr, ByteSize offset_from_sp_in_bytes);
368
369 void klass2reg_with_patching(LIR_Opr r, ciMetadata* obj, CodeEmitInfo* info, bool need_resolve = false);
370
371 // this loads the length and compares against the index
372 void array_range_check (LIR_Opr array, LIR_Opr index, CodeEmitInfo* null_check_info, CodeEmitInfo* range_check_info);
373
374 void arithmetic_op_int (Bytecodes::Code code, LIR_Opr result, LIR_Opr left, LIR_Opr right, LIR_Opr tmp);
375 void arithmetic_op_long (Bytecodes::Code code, LIR_Opr result, LIR_Opr left, LIR_Opr right, CodeEmitInfo* info = nullptr);
376 void arithmetic_op_fpu (Bytecodes::Code code, LIR_Opr result, LIR_Opr left, LIR_Opr right, LIR_Opr tmp = LIR_OprFact::illegalOpr);
377
378 void shift_op (Bytecodes::Code code, LIR_Opr dst_reg, LIR_Opr value, LIR_Opr count, LIR_Opr tmp);
379
380 void logic_op (Bytecodes::Code code, LIR_Opr dst_reg, LIR_Opr left, LIR_Opr right);
381
382 void monitor_enter (LIR_Opr object, LIR_Opr lock, LIR_Opr hdr, LIR_Opr scratch, int monitor_no, CodeEmitInfo* info_for_exception, CodeEmitInfo* info, CodeStub* throw_imse_stub);
383 void monitor_exit (LIR_Opr object, LIR_Opr lock, LIR_Opr hdr, LIR_Opr scratch, int monitor_no);
384
385 void new_instance(LIR_Opr dst, ciInstanceKlass* klass, bool is_unresolved, bool allow_inline, LIR_Opr scratch1, LIR_Opr scratch2, LIR_Opr scratch3, LIR_Opr scratch4, LIR_Opr klass_reg, CodeEmitInfo* info);
386
387 // machine dependent
388 void cmp_mem_int(LIR_Condition condition, LIR_Opr base, int disp, int c, CodeEmitInfo* info);
389 void cmp_reg_mem(LIR_Condition condition, LIR_Opr reg, LIR_Opr base, int disp, BasicType type, CodeEmitInfo* info);
390
391 void arraycopy_helper(Intrinsic* x, int* flags, ciArrayKlass** expected_type);
392
393 // returns a LIR_Address to address an array location. May also
394 // emit some code as part of address calculation. If
395 // needs_card_mark is true then compute the full address for use by
396 // both the store and the card mark.
397 LIR_Address* generate_address(LIR_Opr base,
398 LIR_Opr index, int shift,
399 int disp,
400 BasicType type);
401 LIR_Address* generate_address(LIR_Opr base, int disp, BasicType type) {
402 return generate_address(base, LIR_OprFact::illegalOpr, 0, disp, type);
403 }
404 LIR_Address* emit_array_address(LIR_Opr array_opr, LIR_Opr index_opr, BasicType type);
405
406 // the helper for generate_address
407 void add_large_constant(LIR_Opr src, int c, LIR_Opr dest);
408
409 // machine preferences and characteristics
410 bool can_inline_as_constant(Value i S390_ONLY(COMMA int bits = 20)) const;
411 bool can_inline_as_constant(LIR_Const* c) const;
412 bool can_store_as_constant(Value i, BasicType type) const;
413
414 LIR_Opr safepoint_poll_register();
415
416 void profile_branch(If* if_instr, If::Condition cond);
417 void increment_event_counter_impl(CodeEmitInfo* info,
418 ciMethod *method, LIR_Opr step, int frequency,
419 int bci, bool backedge, bool notify);
420 void increment_event_counter(CodeEmitInfo* info, LIR_Opr step, int bci, bool backedge);
421 void increment_invocation_counter(CodeEmitInfo *info) {
422 if (compilation()->is_profiling()) {
423 increment_event_counter(info, LIR_OprFact::intConst(InvocationCounter::count_increment), InvocationEntryBci, false);
424 }
425 }
426 void increment_backedge_counter(CodeEmitInfo* info, int bci) {
427 if (compilation()->is_profiling()) {
428 increment_event_counter(info, LIR_OprFact::intConst(InvocationCounter::count_increment), bci, true);
429 }
430 }
431 void increment_backedge_counter_conditionally(LIR_Condition cond, LIR_Opr left, LIR_Opr right, CodeEmitInfo* info, int left_bci, int right_bci, int bci);
432 void increment_backedge_counter(CodeEmitInfo* info, LIR_Opr step, int bci) {
433 if (compilation()->is_profiling()) {
434 increment_event_counter(info, step, bci, true);
435 }
436 }
437 CodeEmitInfo* state_for(Instruction* x, ValueStack* state, bool ignore_xhandler = false);
438 CodeEmitInfo* state_for(Instruction* x);
439
440 // allocates a virtual register for this instruction if
441 // one isn't already allocated. Only for Phi and Local.
442 LIR_Opr operand_for_instruction(Instruction *x);
443
444 void set_block(BlockBegin* block) { _block = block; }
445
446 void block_prolog(BlockBegin* block);
447 void block_epilog(BlockBegin* block);
448
449 void do_root (Instruction* instr);
450 void walk (Instruction* instr);
451
452 LIR_Opr new_register(BasicType type);
453 LIR_Opr new_register(Value value) { return new_register(as_BasicType(value->type())); }
454 LIR_Opr new_register(ValueType* type) { return new_register(as_BasicType(type)); }
455
456 // returns a register suitable for doing pointer math
457 LIR_Opr new_pointer_register() {
458 #ifdef _LP64
459 return new_register(T_LONG);
460 #else
461 return new_register(T_INT);
462 #endif
463 }
464
465 static LIR_Condition lir_cond(If::Condition cond) {
466 LIR_Condition l = lir_cond_unknown;
467 switch (cond) {
468 case If::eql: l = lir_cond_equal; break;
469 case If::neq: l = lir_cond_notEqual; break;
470 case If::lss: l = lir_cond_less; break;
471 case If::leq: l = lir_cond_lessEqual; break;
472 case If::geq: l = lir_cond_greaterEqual; break;
473 case If::gtr: l = lir_cond_greater; break;
474 case If::aeq: l = lir_cond_aboveEqual; break;
475 case If::beq: l = lir_cond_belowEqual; break;
476 default: fatal("You must pass valid If::Condition");
477 };
478 return l;
479 }
480
481 #ifdef __SOFTFP__
482 void do_soft_float_compare(If *x);
483 #endif // __SOFTFP__
484
485 SwitchRangeArray* create_lookup_ranges(TableSwitch* x);
486 SwitchRangeArray* create_lookup_ranges(LookupSwitch* x);
487 void do_SwitchRanges(SwitchRangeArray* x, LIR_Opr value, BlockBegin* default_sux);
488
489 void do_RuntimeCall(address routine, Intrinsic* x);
490
491 ciKlass* profile_type(ciMethodData* md, int md_first_offset, int md_offset, intptr_t profiled_k,
492 Value arg, LIR_Opr& mdp, bool not_null, ciKlass* signature_at_call_k,
493 ciKlass* callee_signature_k);
494 void profile_arguments(ProfileCall* x);
495 void profile_parameters(Base* x);
496 void profile_parameters_at_call(ProfileCall* x);
497 void profile_flags(ciMethodData* md, ciProfileData* load_store, int flag, LIR_Condition condition = lir_cond_always);
498 void profile_null_free_array(LIRItem array, ciMethodData* md, ciArrayLoadStoreData* load_store);
499 void profile_array_type(AccessIndexed* x, ciMethodData*& md, ciArrayLoadStoreData*& load_store);
500 void profile_element_type(Value element, ciMethodData* md, ciArrayLoadStoreData* load_store);
501 bool profile_inline_klass(ciMethodData* md, ciProfileData* data, Value value, int flag);
502 LIR_Opr mask_boolean(LIR_Opr array, LIR_Opr value, CodeEmitInfo*& null_check_info);
503
504 public:
505 Compilation* compilation() const { return _compilation; }
506 FrameMap* frame_map() const { return _compilation->frame_map(); }
507 ciMethod* method() const { return _method; }
508 BlockBegin* block() const { return _block; }
509 IRScope* scope() const { return block()->scope(); }
510
511 int max_virtual_register_number() const { return _virtual_register_number; }
512
513 void block_do(BlockBegin* block);
514
515 // Flags that can be set on vregs
516 enum VregFlag {
517 must_start_in_memory = 0 // needs to be assigned a memory location at beginning, but may then be loaded in a register
518 , callee_saved = 1 // must be in a callee saved register
519 , byte_reg = 2 // must be in a byte register
520 , num_vreg_flags
521
522 };
523
524 LIRGenerator(Compilation* compilation, ciMethod* method)
525 : _compilation(compilation)
526 , _method(method)
527 , _virtual_register_number(LIR_Opr::vreg_base)
528 , _vreg_flags(num_vreg_flags)
529 , _in_conditional_code(false)
530 , _barrier_set(BarrierSet::barrier_set()->barrier_set_c1()) {
531 }
532
533 // for virtual registers, maps them back to Phi's or Local's
534 Instruction* instruction_for_opr(LIR_Opr opr);
535 Instruction* instruction_for_vreg(int reg_num);
536
537 void set_vreg_flag (int vreg_num, VregFlag f);
538 bool is_vreg_flag_set(int vreg_num, VregFlag f);
539 void set_vreg_flag (LIR_Opr opr, VregFlag f) { set_vreg_flag(opr->vreg_number(), f); }
540 bool is_vreg_flag_set(LIR_Opr opr, VregFlag f) { return is_vreg_flag_set(opr->vreg_number(), f); }
541
542 // statics
543 static LIR_Opr exceptionOopOpr();
544 static LIR_Opr exceptionPcOpr();
545 static LIR_Opr divInOpr();
546 static LIR_Opr divOutOpr();
547 static LIR_Opr remOutOpr();
548 #ifdef S390
549 // On S390 we can do ldiv, lrem without RT call.
550 static LIR_Opr ldivInOpr();
551 static LIR_Opr ldivOutOpr();
552 static LIR_Opr lremOutOpr();
553 #endif
554 static LIR_Opr shiftCountOpr();
555 LIR_Opr syncLockOpr();
556 LIR_Opr syncTempOpr();
557 LIR_Opr atomicLockOpr();
558
559 // returns a register suitable for saving the thread in a
560 // call_runtime_leaf if one is needed.
561 LIR_Opr getThreadTemp();
562
563 // visitor functionality
564 virtual void do_Phi (Phi* x);
565 virtual void do_Local (Local* x);
566 virtual void do_Constant (Constant* x);
567 virtual void do_LoadField (LoadField* x);
568 virtual void do_StoreField (StoreField* x);
569 virtual void do_ArrayLength (ArrayLength* x);
570 virtual void do_LoadIndexed (LoadIndexed* x);
571 virtual void do_StoreIndexed (StoreIndexed* x);
572 virtual void do_NegateOp (NegateOp* x);
573 virtual void do_ArithmeticOp (ArithmeticOp* x);
574 virtual void do_ShiftOp (ShiftOp* x);
575 virtual void do_LogicOp (LogicOp* x);
576 virtual void do_CompareOp (CompareOp* x);
577 virtual void do_IfOp (IfOp* x);
578 virtual void do_Convert (Convert* x);
579 virtual void do_NullCheck (NullCheck* x);
580 virtual void do_TypeCast (TypeCast* x);
581 virtual void do_Invoke (Invoke* x);
582 virtual void do_NewInstance (NewInstance* x);
583 virtual void do_NewInlineTypeInstance(NewInlineTypeInstance* x);
584 virtual void do_NewTypeArray (NewTypeArray* x);
585 virtual void do_NewObjectArray (NewObjectArray* x);
586 virtual void do_NewMultiArray (NewMultiArray* x);
587 virtual void do_Deoptimize (Deoptimize* x);
588 virtual void do_CheckCast (CheckCast* x);
589 virtual void do_InstanceOf (InstanceOf* x);
590 virtual void do_MonitorEnter (MonitorEnter* x);
591 virtual void do_MonitorExit (MonitorExit* x);
592 virtual void do_Intrinsic (Intrinsic* x);
593 virtual void do_BlockBegin (BlockBegin* x);
594 virtual void do_Goto (Goto* x);
595 virtual void do_If (If* x);
596 virtual void do_TableSwitch (TableSwitch* x);
597 virtual void do_LookupSwitch (LookupSwitch* x);
598 virtual void do_Return (Return* x);
599 virtual void do_Throw (Throw* x);
600 virtual void do_Base (Base* x);
601 virtual void do_OsrEntry (OsrEntry* x);
602 virtual void do_ExceptionObject(ExceptionObject* x);
603 virtual void do_RoundFP (RoundFP* x);
604 virtual void do_UnsafeGet (UnsafeGet* x);
605 virtual void do_UnsafePut (UnsafePut* x);
606 virtual void do_UnsafeGetAndSet(UnsafeGetAndSet* x);
607 virtual void do_ProfileCall (ProfileCall* x);
608 virtual void do_ProfileReturnType (ProfileReturnType* x);
609 virtual void do_ProfileInvoke (ProfileInvoke* x);
610 virtual void do_ProfileACmpTypes(ProfileACmpTypes* x);
611 virtual void do_RuntimeCall (RuntimeCall* x);
612 virtual void do_MemBar (MemBar* x);
613 virtual void do_RangeCheckPredicate(RangeCheckPredicate* x);
614 #ifdef ASSERT
615 virtual void do_Assert (Assert* x);
616 #endif
617
618 #ifdef C1_LIRGENERATOR_MD_HPP
619 #include C1_LIRGENERATOR_MD_HPP
620 #endif
621 };
622
623
624 class LIRItem: public CompilationResourceObj {
625 private:
626 Value _value;
627 LIRGenerator* _gen;
628 LIR_Opr _result;
629 bool _destroys_register;
630 LIR_Opr _new_result;
631
632 LIRGenerator* gen() const { return _gen; }
633
634 public:
635 LIRItem(Value value, LIRGenerator* gen) {
636 _destroys_register = false;
637 _gen = gen;
638 set_instruction(value);
639 }
640
641 LIRItem(LIRGenerator* gen) {
642 _destroys_register = false;
643 _gen = gen;
644 _result = LIR_OprFact::illegalOpr;
645 set_instruction(nullptr);
646 }
647
648 void set_instruction(Value value) {
649 _value = value;
650 _result = LIR_OprFact::illegalOpr;
651 if (_value != nullptr) {
652 _gen->walk(_value);
653 _result = _value->operand();
654 }
655 _new_result = LIR_OprFact::illegalOpr;
656 }
657
658 Value value() const { return _value; }
659 ValueType* type() const { return value()->type(); }
660 LIR_Opr result() {
661 assert(!_destroys_register || (!_result->is_register() || _result->is_virtual()),
662 "shouldn't use set_destroys_register with physical registers");
663 if (_destroys_register && _result->is_register()) {
664 if (_new_result->is_illegal()) {
665 _new_result = _gen->new_register(type());
666 gen()->lir()->move(_result, _new_result);
667 }
668 return _new_result;
669 } else {
670 return _result;
671 }
672 }
673
674 void set_result(LIR_Opr opr);
675
676 void load_item();
677 void load_byte_item();
678 void load_nonconstant(S390_ONLY(int bits = 20));
679 // load any values which can't be expressed as part of a single store instruction
680 void load_for_store(BasicType store_type);
681 void load_item_force(LIR_Opr reg);
682
683 void dont_load_item() {
684 // do nothing
685 }
686
687 void set_destroys_register() {
688 _destroys_register = true;
689 }
690
691 bool is_constant() const { return value()->as_Constant() != nullptr; }
692 bool is_stack() { return result()->is_stack(); }
693 bool is_register() { return result()->is_register(); }
694
695 ciObject* get_jobject_constant() const;
696 jint get_jint_constant() const;
697 jlong get_jlong_constant() const;
698 jfloat get_jfloat_constant() const;
699 jdouble get_jdouble_constant() const;
700 jint get_address_constant() const;
701 };
702
703 #endif // SHARE_C1_C1_LIRGENERATOR_HPP