1 /*
   2  * Copyright (c) 2014, 2017, Oracle and/or its affiliates. All rights reserved.
   3  * Copyright (c) 2015 SAP SE. All rights reserved.
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This code is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License version 2 only, as
   8  * published by the Free Software Foundation.
   9  *
  10  * This code is distributed in the hope that it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  13  * version 2 for more details (a copy is included in the LICENSE file that
  14  * accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License version
  17  * 2 along with this work; if not, write to the Free Software Foundation,
  18  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  19  *
  20  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  21  * or visit www.oracle.com if you need additional information or have any
  22  * questions.
  23  *
  24  */
  25 
  26 #include "precompiled.hpp"
  27 #include "interpreter/interpreter.hpp"
  28 #include "oops/constMethod.hpp"
  29 #include "oops/method.hpp"
  30 #include "runtime/frame.inline.hpp"
  31 #include "utilities/debug.hpp"
  32 #include "utilities/macros.hpp"
  33 
  34 int AbstractInterpreter::BasicType_as_index(BasicType type) {
  35   int i = 0;
  36   switch (type) {
  37     case T_BOOLEAN: i = 0; break;
  38     case T_CHAR   : i = 1; break;
  39     case T_BYTE   : i = 2; break;
  40     case T_SHORT  : i = 3; break;
  41     case T_INT    : i = 4; break;
  42     case T_LONG   : i = 5; break;
  43     case T_VOID   : i = 6; break;
  44     case T_FLOAT  : i = 7; break;
  45     case T_DOUBLE : i = 8; break;
  46     case T_OBJECT : i = 9; break;
  47     case T_ARRAY  : i = 9; break;
  48     default       : ShouldNotReachHere();
  49   }
  50   assert(0 <= i && i < AbstractInterpreter::number_of_result_handlers, "index out of bounds");
  51   return i;
  52 }
  53 
  54 // How much stack a method activation needs in stack slots.
  55 // We must calc this exactly like in generate_fixed_frame.
  56 // Note: This returns the conservative size assuming maximum alignment.
  57 int AbstractInterpreter::size_top_interpreter_activation(Method* method) {
  58   const int max_alignment_size = 2;
  59   const int abi_scratch = frame::abi_reg_args_size;
  60   return method->max_locals() + method->max_stack() +
  61          frame::interpreter_frame_monitor_size() + max_alignment_size + abi_scratch;
  62 }
  63 
  64 // Returns number of stackElementWords needed for the interpreter frame with the
  65 // given sections.
  66 // This overestimates the stack by one slot in case of alignments.
  67 int AbstractInterpreter::size_activation(int max_stack,
  68                                          int temps,
  69                                          int extra_args,
  70                                          int monitors,
  71                                          int callee_params,
  72                                          int callee_locals,
  73                                          bool is_top_frame) {
  74   // Note: This calculation must exactly parallel the frame setup
  75   // in TemplateInterpreterGenerator::generate_fixed_frame.
  76   assert(Interpreter::stackElementWords == 1, "sanity");
  77   const int max_alignment_space = StackAlignmentInBytes / Interpreter::stackElementSize;
  78   const int abi_scratch = is_top_frame ? (frame::abi_reg_args_size / Interpreter::stackElementSize) :
  79                                          (frame::abi_minframe_size / Interpreter::stackElementSize);
  80   const int size =
  81     max_stack                                                +
  82     (callee_locals - callee_params)                          +
  83     monitors * frame::interpreter_frame_monitor_size()       +
  84     max_alignment_space                                      +
  85     abi_scratch                                              +
  86     frame::ijava_state_size / Interpreter::stackElementSize;
  87 
  88   // Fixed size of an interpreter frame, align to 16-byte.
  89   return (size & -2);
  90 }
  91 
  92 // Fills a sceletal interpreter frame generated during deoptimizations.
  93 //
  94 // Parameters:
  95 //
  96 // interpreter_frame != NULL:
  97 //   set up the method, locals, and monitors.
  98 //   The frame interpreter_frame, if not NULL, is guaranteed to be the
  99 //   right size, as determined by a previous call to this method.
 100 //   It is also guaranteed to be walkable even though it is in a skeletal state
 101 //
 102 // is_top_frame == true:
 103 //   We're processing the *oldest* interpreter frame!
 104 //
 105 // pop_frame_extra_args:
 106 //   If this is != 0 we are returning to a deoptimized frame by popping
 107 //   off the callee frame. We want to re-execute the call that called the
 108 //   callee interpreted, but since the return to the interpreter would pop
 109 //   the arguments off advance the esp by dummy popframe_extra_args slots.
 110 //   Popping off those will establish the stack layout as it was before the call.
 111 //
 112 void AbstractInterpreter::layout_activation(Method* method,
 113                                             int tempcount,
 114                                             int popframe_extra_args,
 115                                             int moncount,
 116                                             int caller_actual_parameters,
 117                                             int callee_param_count,
 118                                             int callee_locals_count,
 119                                             frame* caller,
 120                                             frame* interpreter_frame,
 121                                             bool is_top_frame,
 122                                             bool is_bottom_frame) {
 123 
 124   const int abi_scratch = is_top_frame ? (frame::abi_reg_args_size / Interpreter::stackElementSize) :
 125                                          (frame::abi_minframe_size / Interpreter::stackElementSize);
 126 
 127   intptr_t* locals_base  = (caller->is_interpreted_frame()) ?
 128     caller->interpreter_frame_esp() + caller_actual_parameters :
 129     caller->sp() + method->max_locals() - 1 + (frame::abi_minframe_size / Interpreter::stackElementSize);
 130 
 131   intptr_t* monitor_base = caller->sp() - frame::ijava_state_size / Interpreter::stackElementSize;
 132   intptr_t* monitor      = monitor_base - (moncount * frame::interpreter_frame_monitor_size());
 133   intptr_t* esp_base     = monitor - 1;
 134   intptr_t* esp          = esp_base - tempcount - popframe_extra_args;
 135   intptr_t* sp           = (intptr_t *) (((intptr_t) (esp_base - callee_locals_count + callee_param_count - method->max_stack()- abi_scratch)) & -StackAlignmentInBytes);
 136   intptr_t* sender_sp    = caller->sp() + (frame::abi_minframe_size - frame::abi_reg_args_size) / Interpreter::stackElementSize;
 137   intptr_t* top_frame_sp = is_top_frame ? sp : sp + (frame::abi_minframe_size - frame::abi_reg_args_size) / Interpreter::stackElementSize;
 138 
 139   interpreter_frame->interpreter_frame_set_method(method);
 140   interpreter_frame->interpreter_frame_set_mirror(method->method_holder()->java_mirror());
 141   interpreter_frame->interpreter_frame_set_locals(locals_base);
 142   interpreter_frame->interpreter_frame_set_cpcache(method->constants()->cache());
 143   interpreter_frame->interpreter_frame_set_esp(esp);
 144   interpreter_frame->interpreter_frame_set_monitor_end((BasicObjectLock *)monitor);
 145   interpreter_frame->interpreter_frame_set_top_frame_sp(top_frame_sp);
 146   if (!is_bottom_frame) {
 147     interpreter_frame->interpreter_frame_set_sender_sp(sender_sp);
 148   }
 149 }