1 /*
2 * Copyright (c) 2000, 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_LIRASSEMBLER_HPP
26 #define SHARE_C1_C1_LIRASSEMBLER_HPP
27
28 #include "c1/c1_CodeStubs.hpp"
29 #include "ci/ciMethodData.hpp"
30 #include "oops/methodData.hpp"
31 #include "utilities/macros.hpp"
32
33 class Compilation;
34 class ScopeValue;
35
36 class LIR_Assembler: public CompilationResourceObj {
37 private:
38 C1_MacroAssembler* _masm;
39 CodeStubList* _slow_case_stubs;
40
41 Compilation* _compilation;
42 FrameMap* _frame_map;
43 BlockBegin* _current_block;
44
45 Instruction* _pending_non_safepoint;
46 int _pending_non_safepoint_offset;
47 int _immediate_oops_patched;
48
49 Label _unwind_handler_entry;
50
51 #ifdef ASSERT
52 BlockList _branch_target_blocks;
53 void check_no_unbound_labels();
54 #endif
55
56 FrameMap* frame_map() const { return _frame_map; }
57
58 void set_current_block(BlockBegin* b) { _current_block = b; }
59 BlockBegin* current_block() const { return _current_block; }
60
61 // non-safepoint debug info management
62 void flush_debug_info(int before_pc_offset) {
63 if (_pending_non_safepoint != nullptr) {
64 if (_pending_non_safepoint_offset < before_pc_offset)
65 record_non_safepoint_debug_info();
66 _pending_non_safepoint = nullptr;
67 }
68 }
69 void process_debug_info(LIR_Op* op);
70 void record_non_safepoint_debug_info();
71
72 // unified bailout support
73 void bailout(const char* msg) const { compilation()->bailout(msg); }
74 bool bailed_out() const { return compilation()->bailed_out(); }
75
76 // code emission patterns and accessors
77 void check_codespace();
78 bool needs_icache(ciMethod* method) const;
79
80 // returns offset of icache check
81 int check_icache();
82
83 bool needs_clinit_barrier_on_entry(ciMethod* method) const;
84 void clinit_barrier(ciMethod* method);
85
86 void jobject2reg(jobject o, Register reg);
87 void jobject2reg_with_patching(Register reg, CodeEmitInfo* info);
88
89 void metadata2reg(Metadata* o, Register reg);
90 void klass2reg_with_patching(Register reg, CodeEmitInfo* info);
91
92 void emit_stubs(CodeStubList* stub_list);
93
94 public:
95 // addresses
96 Address as_Address(LIR_Address* addr);
97 Address as_Address_lo(LIR_Address* addr);
98 Address as_Address_hi(LIR_Address* addr);
99
100 // debug information
101 void add_call_info(int pc_offset, CodeEmitInfo* cinfo);
102 void add_debug_info_for_branch(CodeEmitInfo* info);
103 void add_debug_info_for_div0(int pc_offset, CodeEmitInfo* cinfo);
104 void add_debug_info_for_div0_here(CodeEmitInfo* info);
105 ImplicitNullCheckStub* add_debug_info_for_null_check(int pc_offset, CodeEmitInfo* cinfo);
106 ImplicitNullCheckStub* add_debug_info_for_null_check_here(CodeEmitInfo* info);
107
108 private:
109 void breakpoint();
110 void push(LIR_Opr opr);
111 void pop(LIR_Opr opr);
112
113 // patching
114 void append_patching_stub(PatchingStub* stub);
115 void patching_epilog(PatchingStub* patch, LIR_PatchCode patch_code, Register obj, CodeEmitInfo* info);
116
117 void comp_op(LIR_Condition condition, LIR_Opr src, LIR_Opr result, LIR_Op2* op);
118
119 PatchingStub::PatchID patching_id(CodeEmitInfo* info);
120
121 public:
122 LIR_Assembler(Compilation* c);
123 ~LIR_Assembler();
124 C1_MacroAssembler* masm() const { return _masm; }
125 Compilation* compilation() const { return _compilation; }
126 ciMethod* method() const { return compilation()->method(); }
127
128 CodeOffsets* offsets() const { return _compilation->offsets(); }
129 int code_offset() const;
130 address pc() const;
131
132 int initial_frame_size_in_bytes() const;
133 int bang_size_in_bytes() const;
134
135 // test for constants which can be encoded directly in instructions
136 static bool is_small_constant(LIR_Opr opr);
137
138 static LIR_Opr receiverOpr();
139 static LIR_Opr osrBufferPointer();
140
141 // stubs
142 void emit_slow_case_stubs();
143 void emit_static_call_stub();
144 void append_code_stub(CodeStub* op);
145 void add_call_info_here(CodeEmitInfo* info) { add_call_info(code_offset(), info); }
146
147 // code patterns
148 int emit_exception_handler();
149 int emit_unwind_handler();
150 void emit_exception_entries(ExceptionInfoList* info_list);
151 int emit_deopt_handler();
152
153 void emit_code(BlockList* hir);
154 void emit_block(BlockBegin* block);
155 void emit_lir_list(LIR_List* list);
156
157 // any last minute peephole optimizations are performed here. In
158 // particular sparc uses this for delay slot filling.
159 void peephole(LIR_List* list);
160
161 void return_op(LIR_Opr result, C1SafepointPollStub* code_stub);
162
163 // returns offset of poll instruction
164 int safepoint_poll(LIR_Opr result, CodeEmitInfo* info);
165
166 void const2reg (LIR_Opr src, LIR_Opr dest, LIR_PatchCode patch_code, CodeEmitInfo* info);
167 void const2stack(LIR_Opr src, LIR_Opr dest);
168 void const2mem (LIR_Opr src, LIR_Opr dest, BasicType type, CodeEmitInfo* info, bool wide);
169 void reg2stack (LIR_Opr src, LIR_Opr dest, BasicType type, bool pop_fpu_stack);
170 void reg2reg (LIR_Opr src, LIR_Opr dest);
171 void reg2mem (LIR_Opr src, LIR_Opr dest, BasicType type,
172 LIR_PatchCode patch_code, CodeEmitInfo* info,
173 bool pop_fpu_stack, bool wide);
174 void stack2reg (LIR_Opr src, LIR_Opr dest, BasicType type);
175 void stack2stack(LIR_Opr src, LIR_Opr dest, BasicType type);
176 void mem2reg (LIR_Opr src, LIR_Opr dest, BasicType type,
177 LIR_PatchCode patch_code,
178 CodeEmitInfo* info, bool wide);
179
180 void shift_op(LIR_Code code, LIR_Opr left, LIR_Opr count, LIR_Opr dest, LIR_Opr tmp);
181 void shift_op(LIR_Code code, LIR_Opr left, jint count, LIR_Opr dest);
182
183 void move_regs(Register from_reg, Register to_reg);
184 void swap_reg(Register a, Register b);
185
186 void emit_op0(LIR_Op0* op);
187 void emit_op1(LIR_Op1* op);
188 void emit_op2(LIR_Op2* op);
189 void emit_op3(LIR_Op3* op);
190 void emit_op4(LIR_Op4* op);
191 void emit_opBranch(LIR_OpBranch* op);
192 void emit_opLabel(LIR_OpLabel* op);
193 void emit_arraycopy(LIR_OpArrayCopy* op);
194 void emit_updatecrc32(LIR_OpUpdateCRC32* op);
195 void emit_opConvert(LIR_OpConvert* op);
196 void emit_alloc_obj(LIR_OpAllocObj* op);
197 void emit_alloc_array(LIR_OpAllocArray* op);
198 void emit_opTypeCheck(LIR_OpTypeCheck* op);
199 void emit_typecheck_helper(LIR_OpTypeCheck *op, Label* success, Label* failure, Label* obj_is_null);
200 void emit_compare_and_swap(LIR_OpCompareAndSwap* op);
201 void emit_lock(LIR_OpLock* op);
202 void emit_load_klass(LIR_OpLoadKlass* op);
203 void emit_call(LIR_OpJavaCall* op);
204 void emit_rtcall(LIR_OpRTCall* op);
205 void emit_profile_call(LIR_OpProfileCall* op);
206 void emit_profile_type(LIR_OpProfileType* op);
207 void emit_delay(LIR_OpDelay* op);
208
209 void arith_op(LIR_Code code, LIR_Opr left, LIR_Opr right, LIR_Opr dest, CodeEmitInfo* info, bool pop_fpu_stack);
210 void arithmetic_idiv(LIR_Code code, LIR_Opr left, LIR_Opr right, LIR_Opr temp, LIR_Opr result, CodeEmitInfo* info);
211 void intrinsic_op(LIR_Code code, LIR_Opr value, LIR_Opr unused, LIR_Opr dest, LIR_Op* op);
212 #ifdef ASSERT
213 void emit_assert(LIR_OpAssert* op);
214 #endif
215
216 void logic_op(LIR_Code code, LIR_Opr left, LIR_Opr right, LIR_Opr dest);
217
218 void roundfp_op(LIR_Opr src, LIR_Opr tmp, LIR_Opr dest, bool pop_fpu_stack);
219 void move_op(LIR_Opr src, LIR_Opr result, BasicType type,
220 LIR_PatchCode patch_code, CodeEmitInfo* info, bool pop_fpu_stack, bool wide);
221 void volatile_move_op(LIR_Opr src, LIR_Opr result, BasicType type, CodeEmitInfo* info);
222 void comp_mem_op(LIR_Opr src, LIR_Opr result, BasicType type, CodeEmitInfo* info); // info set for null exceptions
223 void comp_fl2i(LIR_Code code, LIR_Opr left, LIR_Opr right, LIR_Opr result, LIR_Op2* op);
224 void cmove(LIR_Condition code, LIR_Opr left, LIR_Opr right, LIR_Opr result, BasicType type,
225 LIR_Opr cmp_opr1 = LIR_OprFact::illegalOpr, LIR_Opr cmp_opr2 = LIR_OprFact::illegalOpr);
226 void call( LIR_OpJavaCall* op, relocInfo::relocType rtype);
227 void ic_call( LIR_OpJavaCall* op);
228 void vtable_call( LIR_OpJavaCall* op);
229
230 void osr_entry();
231
232 void build_frame();
233
234 void throw_op(LIR_Opr exceptionPC, LIR_Opr exceptionOop, CodeEmitInfo* info);
235 void unwind_op(LIR_Opr exceptionOop);
236 void monitor_address(int monitor_ix, LIR_Opr dst);
237
238 void align_backward_branch_target();
239 void align_call(LIR_Code code);
240
241 void negate(LIR_Opr left, LIR_Opr dest, LIR_Opr tmp = LIR_OprFact::illegalOpr);
242 void leal(LIR_Opr src, LIR_Opr dest, LIR_PatchCode patch_code = lir_patch_none, CodeEmitInfo* info = nullptr);
243
244 void rt_call(LIR_Opr result, address dest, const LIR_OprList* args, LIR_Opr tmp, CodeEmitInfo* info);
245
246 void membar();
247 void membar_acquire();
248 void membar_release();
249 void membar_loadload();
250 void membar_storestore();
251 void membar_loadstore();
252 void membar_storeload();
253 void on_spin_wait();
254 void get_thread(LIR_Opr result);
255
256 void verify_oop_map(CodeEmitInfo* info);
257
258 void atomic_op(LIR_Code code, LIR_Opr src, LIR_Opr data, LIR_Opr dest, LIR_Opr tmp);
259
260 #include CPU_HEADER(c1_LIRAssembler)
261
262 public:
263 int nr_immediate_oops_patched() const { return _immediate_oops_patched; }
264
265 static int call_stub_size() {
266 return _call_stub_size;
267 }
268
269 static int exception_handler_size() {
270 return _exception_handler_size;
271 }
272
273 static int deopt_handler_size() {
274 return _deopt_handler_size;
275 }
276 };
277
278 #endif // SHARE_C1_C1_LIRASSEMBLER_HPP