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