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