1 /*
  2  * Copyright (c) 1999, 2023, Oracle and/or its affiliates. All rights reserved.
  3  * Copyright (c) 2014, 2015, Red Hat Inc. All rights reserved.
  4  * Copyright (c) 2020, 2022, Huawei Technologies Co., Ltd. All rights reserved.
  5  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  6  *
  7  * This code is free software; you can redistribute it and/or modify it
  8  * under the terms of the GNU General Public License version 2 only, as
  9  * published by the Free Software Foundation.
 10  *
 11  * This code is distributed in the hope that it will be useful, but WITHOUT
 12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 14  * version 2 for more details (a copy is included in the LICENSE file that
 15  * accompanied this code).
 16  *
 17  * You should have received a copy of the GNU General Public License version
 18  * 2 along with this work; if not, write to the Free Software Foundation,
 19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 20  *
 21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 22  * or visit www.oracle.com if you need additional information or have any
 23  * questions.
 24  *
 25  */
 26 
 27 #ifndef CPU_RISCV_C1_MACROASSEMBLER_RISCV_HPP
 28 #define CPU_RISCV_C1_MACROASSEMBLER_RISCV_HPP
 29 
 30 using MacroAssembler::build_frame;
 31 using MacroAssembler::null_check;
 32 
 33 // C1_MacroAssembler contains high-level macros for C1
 34 
 35  private:
 36   int _rsp_offset;    // track rsp changes
 37   // initialization
 38   void pd_init() { _rsp_offset = 0; }
 39 
 40 
 41  public:
 42   void try_allocate(
 43     Register obj,                      // result: pointer to object after successful allocation
 44     Register var_size_in_bytes,        // object size in bytes if unknown at compile time; invalid otherwise
 45     int      con_size_in_bytes,        // object size in bytes if known at compile time
 46     Register tmp1,                     // temp register
 47     Register tmp2,                     // temp register
 48     Label&   slow_case                 // continuation point if fast allocation fails
 49   );
 50 
 51   void initialize_header(Register obj, Register klass, Register len, Register tmp1, Register tmp2);
 52   void initialize_body(Register obj, Register len_in_bytes, int hdr_size_in_bytes, Register tmp);
 53 
 54   void float_cmp(bool is_float, int unordered_result,
 55                  FloatRegister f0, FloatRegister f1,
 56                  Register result);
 57 
 58   // locking
 59   // hdr     : must be x10, contents destroyed
 60   // obj     : must point to the object to lock, contents preserved
 61   // disp_hdr: must point to the displaced header location, contents preserved
 62   // temp : temporary register, must not be scratch register t0 or t1
 63   // returns code offset at which to add null check debug information
 64   int lock_object(Register swap, Register obj, Register disp_hdr, Register temp, Label& slow_case);
 65 
 66   // unlocking
 67   // hdr     : contents destroyed
 68   // obj     : must point to the object to lock, contents preserved
 69   // disp_hdr: must be x10 & must point to the displaced header location, contents destroyed
 70   // temp : temporary register, must not be scratch register t0 or t1
 71   void unlock_object(Register swap, Register obj, Register lock, Register temp, Label& slow_case);
 72 
 73   void initialize_object(
 74     Register obj,                      // result: pointer to object after successful allocation
 75     Register klass,                    // object klass
 76     Register var_size_in_bytes,        // object size in bytes if unknown at compile time; invalid otherwise
 77     int      con_size_in_bytes,        // object size in bytes if   known at compile time
 78     Register tmp1,                     // temp register
 79     Register tmp2,                     // temp register
 80     bool     is_tlab_allocated         // the object was allocated in a TLAB; relevant for the implementation of ZeroTLAB
 81   );
 82 
 83   // allocation of fixed-size objects
 84   // (can also be used to allocate fixed-size arrays, by setting
 85   // hdr_size correctly and storing the array length afterwards)
 86   // obj        : will contain pointer to allocated object
 87   // t1, t2     : temp registers - contents destroyed
 88   // header_size: size of object header in words
 89   // object_size: total size of object in words
 90   // slow_case  : exit to slow case implementation if fast allocation fails
 91   void allocate_object(Register obj, Register tmp1, Register tmp2, int header_size, int object_size, Register klass, Label& slow_case);
 92 
 93   enum {
 94     max_array_allocation_length = 0x00FFFFFF
 95   };
 96 
 97   // allocation of arrays
 98   // obj        : will contain pointer to allocated object
 99   // len        : array length in number of elements
100   // t          : temp register - contents destroyed
101   // header_size: size of object header in words
102   // f          : element scale factor
103   // slow_case  : exit to slow case implementation if fast allocation fails
104   void allocate_array(Register obj, Register len, Register tmp1, Register tmp2, int header_size, int f, Register klass, Label& slow_case);
105 
106   int  rsp_offset() const { return _rsp_offset; }
107 
108   void invalidate_registers(bool inv_r0, bool inv_r19, bool inv_r2, bool inv_r3, bool inv_r4, bool inv_r5) PRODUCT_RETURN;
109 
110   // This platform only uses signal-based null checks. The Label is not needed.
111   void null_check(Register r, Label *Lnull = nullptr) { MacroAssembler::null_check(r); }
112 
113   void load_parameter(int offset_in_words, Register reg);
114 
115   void inline_cache_check(Register receiver, Register iCache, Label &L);
116 
117   static const int c1_double_branch_mask = 1 << 3; // depend on c1_float_cond_branch
118   void c1_cmp_branch(int cmpFlag, Register op1, Register op2, Label& label, BasicType type, bool is_far);
119   void c1_float_cmp_branch(int cmpFlag, FloatRegister op1, FloatRegister op2, Label& label,
120                            bool is_far, bool is_unordered = false);
121 
122 #endif // CPU_RISCV_C1_MACROASSEMBLER_RISCV_HPP