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