1 /*
   2  * Copyright (c) 2000, 2014, 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 #include "precompiled.hpp"
  26 #include "c1/c1_FrameMap.hpp"
  27 #include "c1/c1_LIR.hpp"
  28 #include "code/vmreg.inline.hpp"
  29 #include "runtime/sharedRuntime.hpp"
  30 
  31 //-----------------------------------------------------
  32 
  33 // Convert method signature into an array of BasicTypes for the arguments
  34 BasicTypeArray* FrameMap::signature_type_array_for(const ciMethod* method) {
  35   ciSignature* sig = method->signature();
  36   BasicTypeList* sta = new BasicTypeList(method->arg_size());
  37   // add receiver, if any
  38   if (!method->is_static()) sta->append(T_OBJECT);
  39   // add remaining arguments
  40   for (int i = 0; i < sig->count(); i++) {
  41     ciType* type = sig->type_at(i);
  42     BasicType t = type->basic_type();
  43     if (t == T_ARRAY) {
  44       t = T_OBJECT;
  45     }
  46     sta->append(t);
  47   }
  48   // done
  49   return sta;
  50 }
  51 
  52 
  53 CallingConvention* FrameMap::java_calling_convention(const BasicTypeArray* signature, bool outgoing) {
  54   // compute the size of the arguments first.  The signature array
  55   // that java_calling_convention takes includes a T_VOID after double
  56   // work items but our signatures do not.
  57   int i;
  58   int sizeargs = 0;
  59   for (i = 0; i < signature->length(); i++) {
  60     sizeargs += type2size[signature->at(i)];
  61   }
  62 
  63   BasicType* sig_bt = NEW_RESOURCE_ARRAY(BasicType, sizeargs);
  64   VMRegPair* regs = NEW_RESOURCE_ARRAY(VMRegPair, sizeargs);
  65   int sig_index = 0;
  66   for (i = 0; i < sizeargs; i++, sig_index++) {
  67     sig_bt[i] = signature->at(sig_index);
  68     if (sig_bt[i] == T_LONG || sig_bt[i] == T_DOUBLE) {
  69       sig_bt[i + 1] = T_VOID;
  70       i++;
  71     }
  72   }
  73 
  74   intptr_t out_preserve = SharedRuntime::java_calling_convention(sig_bt, regs, sizeargs, outgoing);
  75   LIR_OprList* args = new LIR_OprList(signature->length());
  76   for (i = 0; i < sizeargs;) {
  77     BasicType t = sig_bt[i];
  78     assert(t != T_VOID, "should be skipping these");
  79     LIR_Opr opr = map_to_opr(t, regs + i, outgoing);
  80     args->append(opr);
  81     if (opr->is_address()) {
  82       LIR_Address* addr = opr->as_address_ptr();
  83       assert(addr->disp() == (int)addr->disp(), "out of range value");
  84       out_preserve = MAX2(out_preserve, (intptr_t)(addr->disp() - STACK_BIAS) / 4);
  85     }
  86     i += type2size[t];
  87   }
  88   assert(args->length() == signature->length(), "size mismatch");
  89   out_preserve += SharedRuntime::out_preserve_stack_slots();
  90 
  91   if (outgoing) {
  92     // update the space reserved for arguments.
  93     update_reserved_argument_area_size(out_preserve * BytesPerWord);
  94   }
  95   return new CallingConvention(args, out_preserve);
  96 }
  97 
  98 
  99 CallingConvention* FrameMap::c_calling_convention(const BasicTypeArray* signature) {
 100   // compute the size of the arguments first.  The signature array
 101   // that java_calling_convention takes includes a T_VOID after double
 102   // work items but our signatures do not.
 103   int i;
 104   int sizeargs = 0;
 105   for (i = 0; i < signature->length(); i++) {
 106     sizeargs += type2size[signature->at(i)];
 107   }
 108 
 109   BasicType* sig_bt = NEW_RESOURCE_ARRAY(BasicType, sizeargs);
 110   VMRegPair* regs = NEW_RESOURCE_ARRAY(VMRegPair, sizeargs);
 111   int sig_index = 0;
 112   for (i = 0; i < sizeargs; i++, sig_index++) {
 113     sig_bt[i] = signature->at(sig_index);
 114     if (sig_bt[i] == T_LONG || sig_bt[i] == T_DOUBLE) {
 115       sig_bt[i + 1] = T_VOID;
 116       i++;
 117     }
 118   }
 119 
 120   intptr_t out_preserve = SharedRuntime::c_calling_convention(sig_bt, regs, NULL, sizeargs);
 121   LIR_OprList* args = new LIR_OprList(signature->length());
 122   for (i = 0; i < sizeargs;) {
 123     BasicType t = sig_bt[i];
 124     assert(t != T_VOID, "should be skipping these");
 125 
 126     // C calls are always outgoing
 127     bool outgoing = true;
 128     LIR_Opr opr = map_to_opr(t, regs + i, outgoing);
 129     // they might be of different types if for instance floating point
 130     // values are passed in cpu registers, but the sizes must match.
 131     assert(type2size[opr->type()] == type2size[t], "type mismatch");
 132     args->append(opr);
 133     if (opr->is_address()) {
 134       LIR_Address* addr = opr->as_address_ptr();
 135       out_preserve = MAX2(out_preserve, (intptr_t)(addr->disp() - STACK_BIAS) / 4);
 136     }
 137     i += type2size[t];
 138   }
 139   assert(args->length() == signature->length(), "size mismatch");
 140   out_preserve += SharedRuntime::out_preserve_stack_slots();
 141   update_reserved_argument_area_size(out_preserve * BytesPerWord);
 142   return new CallingConvention(args, out_preserve);
 143 }
 144 
 145 
 146 //--------------------------------------------------------
 147 //               FrameMap
 148 //--------------------------------------------------------
 149 
 150 bool      FrameMap::_init_done = false;
 151 Register  FrameMap::_cpu_rnr2reg [FrameMap::nof_cpu_regs];
 152 int       FrameMap::_cpu_reg2rnr [FrameMap::nof_cpu_regs];
 153 
 154 
 155 FrameMap::FrameMap(ciMethod* method, int monitors, int reserved_argument_area_size) {
 156   assert(_init_done, "should already be completed");
 157 
 158   _framesize = -1;
 159   _num_spills = -1;
 160 
 161   assert(monitors >= 0, "not set");
 162   _num_monitors = monitors;
 163   assert(reserved_argument_area_size >= 0, "not set");
 164   _reserved_argument_area_size = MAX2(4, reserved_argument_area_size) * BytesPerWord;
 165 
 166   _argcount = method->arg_size();
 167   _argument_locations = new intArray(_argcount, -1);
 168   _incoming_arguments = java_calling_convention(signature_type_array_for(method), false);
 169   _oop_map_arg_count = _incoming_arguments->reserved_stack_slots();
 170 
 171   int java_index = 0;
 172   for (int i = 0; i < _incoming_arguments->length(); i++) {
 173     LIR_Opr opr = _incoming_arguments->at(i);
 174     if (opr->is_address()) {
 175       LIR_Address* address = opr->as_address_ptr();
 176       _argument_locations->at_put(java_index, address->disp() - STACK_BIAS);
 177       _incoming_arguments->args()->at_put(i, LIR_OprFact::stack(java_index, as_BasicType(as_ValueType(address->type()))));
 178     }
 179     java_index += type2size[opr->type()];
 180   }
 181 
 182 }
 183 
 184 
 185 bool FrameMap::finalize_frame(int nof_slots) {
 186   assert(nof_slots >= 0, "must be positive");
 187   assert(_num_spills == -1, "can only be set once");
 188   _num_spills = nof_slots;
 189   assert(_framesize == -1, "should only be calculated once");
 190   _framesize =  round_to(in_bytes(sp_offset_for_monitor_base(0)) +
 191                          _num_monitors * sizeof(BasicObjectLock) +
 192                          sizeof(intptr_t) +                        // offset of deopt orig pc
 193                          frame_pad_in_bytes,
 194                          StackAlignmentInBytes) / 4;
 195   int java_index = 0;
 196   for (int i = 0; i < _incoming_arguments->length(); i++) {
 197     LIR_Opr opr = _incoming_arguments->at(i);
 198     if (opr->is_stack()) {
 199       _argument_locations->at_put(java_index, in_bytes(framesize_in_bytes()) +
 200                                   _argument_locations->at(java_index));
 201     }
 202     java_index += type2size[opr->type()];
 203   }
 204   // make sure it's expressible on the platform
 205   return validate_frame();
 206 }
 207 
 208 VMReg FrameMap::sp_offset2vmreg(ByteSize offset) const {
 209   int offset_in_bytes = in_bytes(offset);
 210   assert(offset_in_bytes % 4 == 0, "must be multiple of 4 bytes");
 211   assert(offset_in_bytes / 4 < framesize() + oop_map_arg_count(), "out of range");
 212   return VMRegImpl::stack2reg(offset_in_bytes / 4);
 213 }
 214 
 215 
 216 bool FrameMap::location_for_sp_offset(ByteSize byte_offset_from_sp,
 217                                       Location::Type loc_type,
 218                                       Location* loc) const {
 219   int offset = in_bytes(byte_offset_from_sp);
 220   assert(offset >= 0, "incorrect offset");
 221   if (!Location::legal_offset_in_bytes(offset)) {
 222     return false;
 223   }
 224   Location tmp_loc = Location::new_stk_loc(loc_type, offset);
 225   *loc = tmp_loc;
 226   return true;
 227 }
 228 
 229 
 230 bool FrameMap::locations_for_slot  (int index, Location::Type loc_type,
 231                                      Location* loc, Location* second) const {
 232   ByteSize offset_from_sp = sp_offset_for_slot(index);
 233   if (!location_for_sp_offset(offset_from_sp, loc_type, loc)) {
 234     return false;
 235   }
 236   if (second != NULL) {
 237     // two word item
 238     offset_from_sp = offset_from_sp + in_ByteSize(4);
 239     return location_for_sp_offset(offset_from_sp, loc_type, second);
 240   }
 241   return true;
 242 }
 243 
 244 //////////////////////
 245 // Public accessors //
 246 //////////////////////
 247 
 248 
 249 ByteSize FrameMap::sp_offset_for_slot(const int index) const {
 250   if (index < argcount()) {
 251     int offset = _argument_locations->at(index);
 252     assert(offset != -1, "not a memory argument");
 253     assert(offset >= framesize() * 4, "argument inside of frame");
 254     return in_ByteSize(offset);
 255   }
 256   ByteSize offset = sp_offset_for_spill(index - argcount());
 257   assert(in_bytes(offset) < framesize() * 4, "spill outside of frame");
 258   return offset;
 259 }
 260 
 261 
 262 ByteSize FrameMap::sp_offset_for_double_slot(const int index) const {
 263   ByteSize offset = sp_offset_for_slot(index);
 264   if (index >= argcount()) {
 265     assert(in_bytes(offset) + 4 < framesize() * 4, "spill outside of frame");
 266   }
 267   return offset;
 268 }
 269 
 270 
 271 ByteSize FrameMap::sp_offset_for_spill(const int index) const {
 272   assert(index >= 0 && index < _num_spills, "out of range");
 273   int offset = round_to(first_available_sp_in_frame + _reserved_argument_area_size, sizeof(double)) +
 274     index * spill_slot_size_in_bytes;
 275   return in_ByteSize(offset);
 276 }
 277 
 278 ByteSize FrameMap::sp_offset_for_monitor_base(const int index) const {
 279   int end_of_spills = round_to(first_available_sp_in_frame + _reserved_argument_area_size, sizeof(double)) +
 280     _num_spills * spill_slot_size_in_bytes;
 281   int offset = (int) round_to(end_of_spills, HeapWordSize) + index * sizeof(BasicObjectLock);
 282   return in_ByteSize(offset);
 283 }
 284 
 285 ByteSize FrameMap::sp_offset_for_monitor_lock(int index) const {
 286   check_monitor_index(index);
 287   return sp_offset_for_monitor_base(index) + in_ByteSize(BasicObjectLock::lock_offset_in_bytes());;
 288 }
 289 
 290 ByteSize FrameMap::sp_offset_for_monitor_object(int index) const {
 291   check_monitor_index(index);
 292   return sp_offset_for_monitor_base(index) + in_ByteSize(BasicObjectLock::obj_offset_in_bytes());
 293 }
 294 
 295 
 296 // For OopMaps, map a local variable or spill index to an VMReg.
 297 // This is the offset from sp() in the frame of the slot for the index,
 298 // skewed by SharedInfo::stack0 to indicate a stack location (vs.a register.)
 299 //
 300 //         C ABI size +
 301 //         framesize +     framesize +
 302 //         stack0          stack0         stack0          0 <- VMReg->value()
 303 //            |              |              | <registers> |
 304 //  ..........|..............|..............|.............|
 305 //    0 1 2 3 | <C ABI area> | 4 5 6 ...... |               <- local indices
 306 //    ^                        ^          sp()
 307 //    |                        |
 308 //  arguments            non-argument locals
 309 
 310 
 311 VMReg FrameMap::regname(LIR_Opr opr) const {
 312   if (opr->is_single_cpu()) {
 313     assert(!opr->is_virtual(), "should not see virtual registers here");
 314     return opr->as_register()->as_VMReg();
 315   } else if (opr->is_single_stack()) {
 316     return sp_offset2vmreg(sp_offset_for_slot(opr->single_stack_ix()));
 317   } else if (opr->is_address()) {
 318     LIR_Address* addr = opr->as_address_ptr();
 319     assert(addr->base() == stack_pointer(), "sp based addressing only");
 320     return sp_offset2vmreg(in_ByteSize(addr->index()->as_jint()));
 321   }
 322   ShouldNotReachHere();
 323   return VMRegImpl::Bad();
 324 }
 325 
 326 
 327 
 328 
 329 // ------------ extra spill slots ---------------