1 /*
  2  * Copyright (c) 2000, 2021, 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_FRAMEMAP_HPP
 26 #define SHARE_C1_C1_FRAMEMAP_HPP
 27 
 28 #include "asm/macroAssembler.hpp"
 29 #include "c1/c1_Defs.hpp"
 30 #include "c1/c1_LIR.hpp"
 31 #include "code/vmreg.hpp"
 32 #include "memory/allocation.hpp"
 33 #include "runtime/frame.hpp"
 34 #include "runtime/synchronizer.hpp"
 35 #include "utilities/globalDefinitions.hpp"
 36 #include "utilities/macros.hpp"
 37 
 38 class ciMethod;
 39 class CallingConvention;
 40 
 41 //--------------------------------------------------------
 42 //               FrameMap
 43 //--------------------------------------------------------
 44 
 45 //  This class is responsible of mapping items (locals, monitors, spill
 46 //  slots and registers) to their frame location
 47 //
 48 //  The monitors are specified by a consecutive index, although each monitor entry
 49 //  occupies two words. The monitor_index is 0.._num_monitors
 50 //  The spill index is similar to local index; it is in range 0..(open)
 51 //
 52 //  The CPU registers are mapped using a fixed table; register with number 0
 53 //  is the most used one.
 54 
 55 
 56 //   stack grow direction -->                                        SP
 57 //  +----------+---+----------+-------+------------------------+-----+
 58 //  |arguments | x | monitors | spill | reserved argument area | ABI |
 59 //  +----------+---+----------+-------+------------------------+-----+
 60 //
 61 //  x =  ABI area (SPARC) or  return adress and link (i486)
 62 //  ABI  = ABI area (SPARC) or nothing (i486)
 63 
 64 
 65 class FrameMap : public CompilationResourceObj {
 66  public:
 67   enum {
 68     nof_cpu_regs = pd_nof_cpu_regs_frame_map,
 69     nof_fpu_regs = pd_nof_fpu_regs_frame_map,
 70 
 71     nof_cpu_regs_reg_alloc = pd_nof_cpu_regs_reg_alloc,
 72     nof_fpu_regs_reg_alloc = pd_nof_fpu_regs_reg_alloc,
 73 
 74     max_nof_caller_save_cpu_regs = pd_nof_caller_save_cpu_regs_frame_map,
 75     nof_caller_save_fpu_regs     = pd_nof_caller_save_fpu_regs_frame_map,
 76 
 77     spill_slot_size_in_bytes = 4
 78   };
 79 
 80 #include CPU_HEADER(c1_FrameMap)
 81 
 82   friend class LIR_Opr;
 83 
 84  private:
 85   static bool         _init_done;
 86   static Register     _cpu_rnr2reg [nof_cpu_regs];
 87   static int          _cpu_reg2rnr [nof_cpu_regs];
 88 
 89   static LIR_Opr      _caller_save_cpu_regs [max_nof_caller_save_cpu_regs];
 90   static LIR_Opr      _caller_save_fpu_regs [nof_caller_save_fpu_regs];
 91 
 92   int                 _framesize;
 93   int                 _argcount;
 94   int                 _num_monitors;
 95   int                 _num_spills;
 96   int                 _reserved_argument_area_size;
 97   int                 _oop_map_arg_count;
 98 
 99   CallingConvention*  _incoming_arguments;
100   intArray*           _argument_locations;
101 
102   void check_spill_index   (int spill_index)   const { assert(spill_index   >= 0, "bad index"); }
103   void check_monitor_index (int monitor_index) const { assert(monitor_index >= 0 &&
104                                                               monitor_index < _num_monitors, "bad index"); }
105 
106   static Register cpu_rnr2reg (int rnr) {
107     assert(_init_done, "tables not initialized");
108     debug_only(cpu_range_check(rnr);)
109     return _cpu_rnr2reg[rnr];
110   }
111 
112   static int cpu_reg2rnr (Register reg) {
113     assert(_init_done, "tables not initialized");
114     debug_only(cpu_range_check(reg->encoding());)
115     return _cpu_reg2rnr[reg->encoding()];
116   }
117 
118   static void map_register(int rnr, Register reg) {
119     debug_only(cpu_range_check(rnr);)
120     debug_only(cpu_range_check(reg->encoding());)
121     _cpu_rnr2reg[rnr] = reg;
122     _cpu_reg2rnr[reg->encoding()] = rnr;
123   }
124 
125   void update_reserved_argument_area_size (int size) {
126     assert(size >= 0, "check");
127     _reserved_argument_area_size = MAX2(_reserved_argument_area_size, size);
128   }
129 
130  protected:
131 #ifndef PRODUCT
132   static void cpu_range_check (int rnr)          { assert(0 <= rnr && rnr < nof_cpu_regs, "cpu register number is too big"); }
133   static void fpu_range_check (int rnr)          { assert(0 <= rnr && rnr < nof_fpu_regs, "fpu register number is too big"); }
134 #endif
135 
136 
137   ByteSize sp_offset_for_monitor_base(const int idx) const;
138 
139   Address make_new_address(ByteSize sp_offset) const;
140 
141   ByteSize sp_offset_for_slot(const int idx) const;
142   ByteSize sp_offset_for_double_slot(const int idx) const;
143   ByteSize sp_offset_for_spill(const int idx) const;
144   ByteSize sp_offset_for_monitor_lock(int monitor_index) const;
145   ByteSize sp_offset_for_monitor_object(int monitor_index) const;
146 
147   VMReg sp_offset2vmreg(ByteSize offset) const;
148 
149   // platform dependent hook used to check that frame is properly
150   // addressable on the platform.  Used by arm, ppc to verify that all
151   // stack addresses are valid.
152   bool validate_frame();
153 
154   static LIR_Opr map_to_opr(BasicType type, VMRegPair* reg, bool incoming);
155 
156  public:
157   // Opr representing the stack_pointer on this platform
158   static LIR_Opr stack_pointer();
159 
160   // JSR 292
161   static LIR_Opr method_handle_invoke_SP_save_opr();
162 
163   static BasicTypeArray*     signature_type_array_for(const ciMethod* method);
164 
165   // for outgoing calls, these also update the reserved area to
166   // include space for arguments and any ABI area.
167   CallingConvention* c_calling_convention(const BasicTypeArray* signature);
168   CallingConvention* java_calling_convention(const BasicTypeArray* signature, bool outgoing);
169 
170   // deopt support
171   ByteSize sp_offset_for_orig_pc() { return sp_offset_for_monitor_base(_num_monitors); }
172 
173   static LIR_Opr as_opr(Register r) {
174     return LIR_OprFact::single_cpu(cpu_reg2rnr(r));
175   }
176   static LIR_Opr as_oop_opr(Register r) {
177     return LIR_OprFact::single_cpu_oop(cpu_reg2rnr(r));
178   }
179 
180   static LIR_Opr as_metadata_opr(Register r) {
181     return LIR_OprFact::single_cpu_metadata(cpu_reg2rnr(r));
182   }
183 
184   static LIR_Opr as_address_opr(Register r) {
185     return LIR_OprFact::single_cpu_address(cpu_reg2rnr(r));
186   }
187 
188   FrameMap(ciMethod* method, int monitors, int reserved_argument_area_size);
189   bool finalize_frame(int nof_slots);
190 
191   int   reserved_argument_area_size () const     { return _reserved_argument_area_size; }
192   int   framesize                   () const     { assert(_framesize != -1, "hasn't been calculated"); return _framesize; }
193   ByteSize framesize_in_bytes       () const     { return in_ByteSize(framesize() * 4); }
194   int   num_monitors                () const     { return _num_monitors; }
195   int   num_spills                  () const     { assert(_num_spills >= 0, "not set"); return _num_spills; }
196   int   argcount              () const     { assert(_argcount >= 0, "not set"); return _argcount; }
197 
198   int oop_map_arg_count() const { return _oop_map_arg_count; }
199 
200   CallingConvention* incoming_arguments() const  { return _incoming_arguments; }
201 
202   // convenience routines
203   Address address_for_slot(int index, int sp_adjust = 0) const {
204     return make_new_address(sp_offset_for_slot(index) + in_ByteSize(sp_adjust));
205   }
206   Address address_for_double_slot(int index, int sp_adjust = 0) const {
207     return make_new_address(sp_offset_for_double_slot(index) + in_ByteSize(sp_adjust));
208   }
209   Address address_for_monitor_lock(int monitor_index) const {
210     return make_new_address(sp_offset_for_monitor_lock(monitor_index));
211   }
212   Address address_for_monitor_object(int monitor_index) const {
213     return make_new_address(sp_offset_for_monitor_object(monitor_index));
214   }
215 
216   // Creates Location describing desired slot and returns it via pointer
217   // to Location object. Returns true if the stack frame offset was legal
218   // (as defined by Location::legal_offset_in_bytes()), false otherwise.
219   // Do not use the returned location if this returns false.
220   bool location_for_sp_offset(ByteSize byte_offset_from_sp,
221                               Location::Type loc_type, Location* loc) const;
222 
223   bool location_for_monitor_lock  (int monitor_index, Location* loc) const {
224     return location_for_sp_offset(sp_offset_for_monitor_lock(monitor_index), Location::normal, loc);
225   }
226   bool location_for_monitor_object(int monitor_index, Location* loc) const {
227     return location_for_sp_offset(sp_offset_for_monitor_object(monitor_index), Location::oop, loc);
228   }
229   bool locations_for_slot  (int index, Location::Type loc_type,
230                             Location* loc, Location* second = NULL) const;
231 
232   VMReg slot_regname(int index) const {
233     return sp_offset2vmreg(sp_offset_for_slot(index));
234   }
235   VMReg monitor_object_regname(int monitor_index) const {
236     return sp_offset2vmreg(sp_offset_for_monitor_object(monitor_index));
237   }
238   VMReg regname(LIR_Opr opr) const;
239 
240   static LIR_Opr caller_save_cpu_reg_at(int i) {
241     assert(i >= 0 && i < max_nof_caller_save_cpu_regs, "out of bounds");
242     return _caller_save_cpu_regs[i];
243   }
244 
245   static LIR_Opr caller_save_fpu_reg_at(int i) {
246     assert(i >= 0 && i < nof_caller_save_fpu_regs, "out of bounds");
247     return _caller_save_fpu_regs[i];
248   }
249 
250   static void initialize();
251 };
252 
253 //               CallingConvention
254 //--------------------------------------------------------
255 
256 class CallingConvention: public ResourceObj {
257  private:
258   LIR_OprList* _args;
259   int          _reserved_stack_slots;
260 
261  public:
262   CallingConvention (LIR_OprList* args, int reserved_stack_slots)
263     : _args(args)
264     , _reserved_stack_slots(reserved_stack_slots)  {}
265 
266   LIR_OprList* args()       { return _args; }
267 
268   LIR_Opr at(int i) const   { return _args->at(i); }
269   int length() const        { return _args->length(); }
270 
271   // Indicates number of real frame slots used by arguments passed on stack.
272   int reserved_stack_slots() const            { return _reserved_stack_slots; }
273 
274 #ifndef PRODUCT
275   void print () const {
276     for (int i = 0; i < length(); i++) {
277       at(i)->print();
278     }
279   }
280 #endif // PRODUCT
281 };
282 
283 #endif // SHARE_C1_C1_FRAMEMAP_HPP