1 /*
   2  * Copyright (c) 1997, 2015, 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 "interpreter/interpreter.hpp"
  27 #include "interpreter/interpreterGenerator.hpp"
  28 #include "oops/constMethod.hpp"
  29 #include "oops/method.hpp"
  30 #include "runtime/arguments.hpp"
  31 #include "runtime/frame.inline.hpp"
  32 #include "runtime/synchronizer.hpp"
  33 #include "utilities/macros.hpp"
  34 
  35 
  36 int AbstractInterpreter::BasicType_as_index(BasicType type) {
  37   int i = 0;
  38   switch (type) {
  39     case T_BOOLEAN: i = 0; break;
  40     case T_CHAR   : i = 1; break;
  41     case T_BYTE   : i = 2; break;
  42     case T_SHORT  : i = 3; break;
  43     case T_INT    : i = 4; break;
  44     case T_LONG   : i = 5; break;
  45     case T_VOID   : i = 6; break;
  46     case T_FLOAT  : i = 7; break;
  47     case T_DOUBLE : i = 8; break;
  48     case T_OBJECT : i = 9; break;
  49     case T_ARRAY  : i = 9; break;
  50     default       : ShouldNotReachHere();
  51   }
  52   assert(0 <= i && i < AbstractInterpreter::number_of_result_handlers, "index out of bounds");
  53   return i;
  54 }
  55 
  56 bool AbstractInterpreter::can_be_compiled(methodHandle m) {
  57   // No special entry points that preclude compilation
  58   return true;
  59 }
  60 
  61 static int size_activation_helper(int callee_extra_locals, int max_stack, int monitor_size) {
  62 
  63   // Figure out the size of an interpreter frame (in words) given that we have a fully allocated
  64   // expression stack, the callee will have callee_extra_locals (so we can account for
  65   // frame extension) and monitor_size for monitors. Basically we need to calculate
  66   // this exactly like generate_fixed_frame/generate_compute_interpreter_state.
  67   //
  68   //
  69   // The big complicating thing here is that we must ensure that the stack stays properly
  70   // aligned. This would be even uglier if monitor size wasn't modulo what the stack
  71   // needs to be aligned for). We are given that the sp (fp) is already aligned by
  72   // the caller so we must ensure that it is properly aligned for our callee.
  73   //
  74   const int rounded_vm_local_words =
  75        round_to(frame::interpreter_frame_vm_local_words,WordsPerLong);
  76   // callee_locals and max_stack are counts, not the size in frame.
  77   const int locals_size =
  78        round_to(callee_extra_locals * Interpreter::stackElementWords, WordsPerLong);
  79   const int max_stack_words = max_stack * Interpreter::stackElementWords;
  80   return (round_to((max_stack_words
  81                    + rounded_vm_local_words
  82                    + frame::memory_parameter_word_sp_offset), WordsPerLong)
  83                    // already rounded
  84                    + locals_size + monitor_size);
  85 }
  86 
  87 // How much stack a method top interpreter activation needs in words.
  88 int AbstractInterpreter::size_top_interpreter_activation(Method* method) {
  89 
  90   // See call_stub code
  91   int call_stub_size  = round_to(7 + frame::memory_parameter_word_sp_offset,
  92                                  WordsPerLong);    // 7 + register save area
  93 
  94   // Save space for one monitor to get into the interpreted method in case
  95   // the method is synchronized
  96   int monitor_size    = method->is_synchronized() ?
  97                                 1*frame::interpreter_frame_monitor_size() : 0;
  98   return size_activation_helper(method->max_locals(), method->max_stack(),
  99                                 monitor_size) + call_stub_size;
 100 }
 101 
 102 int AbstractInterpreter::size_activation(int max_stack,
 103                                          int temps,
 104                                          int extra_args,
 105                                          int monitors,
 106                                          int callee_params,
 107                                          int callee_locals,
 108                                          bool is_top_frame) {
 109   // Note: This calculation must exactly parallel the frame setup
 110   // in InterpreterGenerator::generate_fixed_frame.
 111 
 112   int monitor_size           = monitors * frame::interpreter_frame_monitor_size();
 113 
 114   assert(monitor_size == round_to(monitor_size, WordsPerLong), "must align");
 115 
 116   //
 117   // Note: if you look closely this appears to be doing something much different
 118   // than generate_fixed_frame. What is happening is this. On sparc we have to do
 119   // this dance with interpreter_sp_adjustment because the window save area would
 120   // appear just below the bottom (tos) of the caller's java expression stack. Because
 121   // the interpreter want to have the locals completely contiguous generate_fixed_frame
 122   // will adjust the caller's sp for the "extra locals" (max_locals - parameter_size).
 123   // Now in generate_fixed_frame the extension of the caller's sp happens in the callee.
 124   // In this code the opposite occurs the caller adjusts it's own stack base on the callee.
 125   // This is mostly ok but it does cause a problem when we get to the initial frame (the oldest)
 126   // because the oldest frame would have adjust its callers frame and yet that frame
 127   // already exists and isn't part of this array of frames we are unpacking. So at first
 128   // glance this would seem to mess up that frame. However Deoptimization::fetch_unroll_info_helper()
 129   // will after it calculates all of the frame's on_stack_size()'s will then figure out the
 130   // amount to adjust the caller of the initial (oldest) frame and the calculation will all
 131   // add up. It does seem like it simpler to account for the adjustment here (and remove the
 132   // callee... parameters here). However this would mean that this routine would have to take
 133   // the caller frame as input so we could adjust its sp (and set it's interpreter_sp_adjustment)
 134   // and run the calling loop in the reverse order. This would also would appear to mean making
 135   // this code aware of what the interactions are when that initial caller fram was an osr or
 136   // other adapter frame. deoptimization is complicated enough and  hard enough to debug that
 137   // there is no sense in messing working code.
 138   //
 139 
 140   int rounded_cls = round_to((callee_locals - callee_params), WordsPerLong);
 141   assert(rounded_cls == round_to(rounded_cls, WordsPerLong), "must align");
 142 
 143   int raw_frame_size = size_activation_helper(rounded_cls, max_stack, monitor_size);
 144 
 145   return raw_frame_size;
 146 }
 147 
 148 void AbstractInterpreter::layout_activation(Method* method,
 149                                             int tempcount,
 150                                             int popframe_extra_args,
 151                                             int moncount,
 152                                             int caller_actual_parameters,
 153                                             int callee_param_count,
 154                                             int callee_local_count,
 155                                             frame* caller,
 156                                             frame* interpreter_frame,
 157                                             bool is_top_frame,
 158                                             bool is_bottom_frame) {
 159   // Set up the following variables:
 160   //   - Lmethod
 161   //   - Llocals
 162   //   - Lmonitors (to the indicated number of monitors)
 163   //   - Lesp (to the indicated number of temps)
 164   // The frame caller on entry is a description of the caller of the
 165   // frame we are about to layout. We are guaranteed that we will be
 166   // able to fill in a new interpreter frame as its callee (i.e. the
 167   // stack space is allocated and the amount was determined by an
 168   // earlier call to the size_activation() method).  On return caller
 169   // while describe the interpreter frame we just layed out.
 170 
 171   // The skeleton frame must already look like an interpreter frame
 172   // even if not fully filled out.
 173   assert(interpreter_frame->is_interpreted_frame(), "Must be interpreted frame");
 174 
 175   int rounded_vm_local_words = round_to(frame::interpreter_frame_vm_local_words,WordsPerLong);
 176   int monitor_size           = moncount * frame::interpreter_frame_monitor_size();
 177   assert(monitor_size == round_to(monitor_size, WordsPerLong), "must align");
 178 
 179   intptr_t* fp = interpreter_frame->fp();
 180 
 181   JavaThread* thread = JavaThread::current();
 182   RegisterMap map(thread, false);
 183   // More verification that skeleton frame is properly walkable
 184   assert(fp == caller->sp(), "fp must match");
 185 
 186   intptr_t* montop     = fp - rounded_vm_local_words;
 187 
 188   // preallocate monitors (cf. __ add_monitor_to_stack)
 189   intptr_t* monitors = montop - monitor_size;
 190 
 191   // preallocate stack space
 192   intptr_t*  esp = monitors - 1 -
 193     (tempcount * Interpreter::stackElementWords) -
 194     popframe_extra_args;
 195 
 196   int local_words = method->max_locals() * Interpreter::stackElementWords;
 197   NEEDS_CLEANUP;
 198   intptr_t* locals;
 199   if (caller->is_interpreted_frame()) {
 200     // Can force the locals area to end up properly overlapping the top of the expression stack.
 201     intptr_t* Lesp_ptr = caller->interpreter_frame_tos_address() - 1;
 202     // Note that this computation means we replace size_of_parameters() values from the caller
 203     // interpreter frame's expression stack with our argument locals
 204     int parm_words  = caller_actual_parameters * Interpreter::stackElementWords;
 205     locals = Lesp_ptr + parm_words;
 206     int delta = local_words - parm_words;
 207     int computed_sp_adjustment = (delta > 0) ? round_to(delta, WordsPerLong) : 0;
 208     *interpreter_frame->register_addr(I5_savedSP)    = (intptr_t) (fp + computed_sp_adjustment) - STACK_BIAS;
 209     if (!is_bottom_frame) {
 210       // Llast_SP is set below for the current frame to SP (with the
 211       // extra space for the callee's locals). Here we adjust
 212       // Llast_SP for the caller's frame, removing the extra space
 213       // for the current method's locals.
 214       *caller->register_addr(Llast_SP) = *interpreter_frame->register_addr(I5_savedSP);
 215     } else {
 216       assert(*caller->register_addr(Llast_SP) >= *interpreter_frame->register_addr(I5_savedSP), "strange Llast_SP");
 217     }
 218   } else {
 219     assert(caller->is_compiled_frame() || caller->is_entry_frame(), "only possible cases");
 220     // Don't have Lesp available; lay out locals block in the caller
 221     // adjacent to the register window save area.
 222     //
 223     // Compiled frames do not allocate a varargs area which is why this if
 224     // statement is needed.
 225     //
 226     if (caller->is_compiled_frame()) {
 227       locals = fp + frame::register_save_words + local_words - 1;
 228     } else {
 229       locals = fp + frame::memory_parameter_word_sp_offset + local_words - 1;
 230     }
 231     if (!caller->is_entry_frame()) {
 232       // Caller wants his own SP back
 233       int caller_frame_size = caller->cb()->frame_size();
 234       *interpreter_frame->register_addr(I5_savedSP) = (intptr_t)(caller->fp() - caller_frame_size) - STACK_BIAS;
 235     }
 236   }
 237   if (TraceDeoptimization) {
 238     if (caller->is_entry_frame()) {
 239       // make sure I5_savedSP and the entry frames notion of saved SP
 240       // agree.  This assertion duplicate a check in entry frame code
 241       // but catches the failure earlier.
 242       assert(*caller->register_addr(Lscratch) == *interpreter_frame->register_addr(I5_savedSP),
 243              "would change callers SP");
 244     }
 245     if (caller->is_entry_frame()) {
 246       tty->print("entry ");
 247     }
 248     if (caller->is_compiled_frame()) {
 249       tty->print("compiled ");
 250       if (caller->is_deoptimized_frame()) {
 251         tty->print("(deopt) ");
 252       }
 253     }
 254     if (caller->is_interpreted_frame()) {
 255       tty->print("interpreted ");
 256     }
 257     tty->print_cr("caller fp=" INTPTR_FORMAT " sp=" INTPTR_FORMAT, p2i(caller->fp()), p2i(caller->sp()));
 258     tty->print_cr("save area = " INTPTR_FORMAT ", " INTPTR_FORMAT, p2i(caller->sp()), p2i(caller->sp() + 16));
 259     tty->print_cr("save area = " INTPTR_FORMAT ", " INTPTR_FORMAT, p2i(caller->fp()), p2i(caller->fp() + 16));
 260     tty->print_cr("interpreter fp=" INTPTR_FORMAT ", " INTPTR_FORMAT, p2i(interpreter_frame->fp()), p2i(interpreter_frame->sp()));
 261     tty->print_cr("save area = " INTPTR_FORMAT ", " INTPTR_FORMAT, p2i(interpreter_frame->sp()), p2i(interpreter_frame->sp() + 16));
 262     tty->print_cr("save area = " INTPTR_FORMAT ", " INTPTR_FORMAT, p2i(interpreter_frame->fp()), p2i(interpreter_frame->fp() + 16));
 263     tty->print_cr("Llocals = " INTPTR_FORMAT, p2i(locals));
 264     tty->print_cr("Lesp = " INTPTR_FORMAT, p2i(esp));
 265     tty->print_cr("Lmonitors = " INTPTR_FORMAT, p2i(monitors));
 266   }
 267 
 268   if (method->max_locals() > 0) {
 269     assert(locals < caller->sp() || locals >= (caller->sp() + 16), "locals in save area");
 270     assert(locals < caller->fp() || locals > (caller->fp() + 16), "locals in save area");
 271     assert(locals < interpreter_frame->sp() || locals > (interpreter_frame->sp() + 16), "locals in save area");
 272     assert(locals < interpreter_frame->fp() || locals >= (interpreter_frame->fp() + 16), "locals in save area");
 273   }
 274 #ifdef _LP64
 275   assert(*interpreter_frame->register_addr(I5_savedSP) & 1, "must be odd");
 276 #endif
 277 
 278   *interpreter_frame->register_addr(Lmethod)     = (intptr_t) method;
 279   *interpreter_frame->register_addr(Llocals)     = (intptr_t) locals;
 280   *interpreter_frame->register_addr(Lmonitors)   = (intptr_t) monitors;
 281   *interpreter_frame->register_addr(Lesp)        = (intptr_t) esp;
 282   // Llast_SP will be same as SP as there is no adapter space
 283   *interpreter_frame->register_addr(Llast_SP)    = (intptr_t) interpreter_frame->sp() - STACK_BIAS;
 284   *interpreter_frame->register_addr(LcpoolCache) = (intptr_t) method->constants()->cache();
 285 #ifdef FAST_DISPATCH
 286   *interpreter_frame->register_addr(IdispatchTables) = (intptr_t) Interpreter::dispatch_table();
 287 #endif
 288 
 289 
 290 #ifdef ASSERT
 291   BasicObjectLock* mp = (BasicObjectLock*)monitors;
 292 
 293   assert(interpreter_frame->interpreter_frame_method() == method, "method matches");
 294   assert(interpreter_frame->interpreter_frame_local_at(9) == (intptr_t *)((intptr_t)locals - (9 * Interpreter::stackElementSize)), "locals match");
 295   assert(interpreter_frame->interpreter_frame_monitor_end()   == mp, "monitor_end matches");
 296   assert(((intptr_t *)interpreter_frame->interpreter_frame_monitor_begin()) == ((intptr_t *)mp)+monitor_size, "monitor_begin matches");
 297   assert(interpreter_frame->interpreter_frame_tos_address()-1 == esp, "esp matches");
 298 
 299   // check bounds
 300   intptr_t* lo = interpreter_frame->sp() + (frame::memory_parameter_word_sp_offset - 1);
 301   intptr_t* hi = interpreter_frame->fp() - rounded_vm_local_words;
 302   assert(lo < monitors && montop <= hi, "monitors in bounds");
 303   assert(lo <= esp && esp < monitors, "esp in bounds");
 304 #endif // ASSERT
 305 }