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