1 /*
  2  * Copyright (c) 2003, 2020, Oracle and/or its affiliates. All rights reserved.
  3  * Copyright (c) 2014, Red Hat Inc. 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/klass.inline.hpp"
 30 #include "oops/method.hpp"
 31 #include "runtime/frame.inline.hpp"
 32 #include "utilities/align.hpp"
 33 #include "utilities/debug.hpp"
 34 #include "utilities/macros.hpp"
 35 
 36 
 37 int AbstractInterpreter::BasicType_as_index(BasicType type) {
 38   int i = 0;
 39   switch (type) {
 40     case T_BOOLEAN: i = 0; break;
 41     case T_CHAR   : i = 1; break;
 42     case T_BYTE   : i = 2; break;
 43     case T_SHORT  : i = 3; break;
 44     case T_INT    : i = 4; break;
 45     case T_LONG   : i = 5; break;
 46     case T_VOID   : i = 6; break;
 47     case T_FLOAT  : i = 7; break;
 48     case T_DOUBLE : i = 8; break;
 49     case T_OBJECT : i = 9; break;
 50     case T_ARRAY  : i = 9; break;
 51     case T_INLINE_TYPE : i = 10; break;
 52     default       : ShouldNotReachHere();
 53   }
 54   assert(0 <= i && i < AbstractInterpreter::number_of_result_handlers,
 55          "index out of bounds");
 56   return i;
 57 }
 58 
 59 // How much stack a method activation needs in words.
 60 int AbstractInterpreter::size_top_interpreter_activation(Method* method) {
 61   const int entry_size = frame::interpreter_frame_monitor_size();
 62 
 63   // total overhead size: entry_size + (saved rfp thru expr stack
 64   // bottom).  be sure to change this if you add/subtract anything
 65   // to/from the overhead area
 66   const int overhead_size =
 67     -(frame::interpreter_frame_initial_sp_offset) + entry_size;
 68 
 69   const int stub_code = frame::entry_frame_after_call_words;
 70   const int method_stack = (method->max_locals() + method->max_stack()) *
 71                            Interpreter::stackElementWords;
 72   return (overhead_size + method_stack + stub_code);
 73 }
 74 
 75 // asm based interpreter deoptimization helpers
 76 int AbstractInterpreter::size_activation(int max_stack,
 77                                          int temps,
 78                                          int extra_args,
 79                                          int monitors,
 80                                          int callee_params,
 81                                          int callee_locals,
 82                                          bool is_top_frame) {
 83   // Note: This calculation must exactly parallel the frame setup
 84   // in TemplateInterpreterGenerator::generate_method_entry.
 85 
 86   // fixed size of an interpreter frame:
 87   int overhead = frame::sender_sp_offset -
 88                  frame::interpreter_frame_initial_sp_offset;
 89   // Our locals were accounted for by the caller (or last_frame_adjust
 90   // on the transistion) Since the callee parameters already account
 91   // for the callee's params we only need to account for the extra
 92   // locals.
 93   int size = overhead +
 94          (callee_locals - callee_params) +
 95          monitors * frame::interpreter_frame_monitor_size() +
 96          // On the top frame, at all times SP <= ESP, and SP is
 97          // 16-aligned.  We ensure this by adjusting SP on method
 98          // entry and re-entry to allow room for the maximum size of
 99          // the expression stack.  When we call another method we bump
100          // SP so that no stack space is wasted.  So, only on the top
101          // frame do we need to allow max_stack words.
102          (is_top_frame ? max_stack : temps + extra_args);
103 
104   // On AArch64 we always keep the stack pointer 16-aligned, so we
105   // must round up here.
106   size = align_up(size, 2);
107 
108   return size;
109 }
110 
111 void AbstractInterpreter::layout_activation(Method* method,
112                                             int tempcount,
113                                             int popframe_extra_args,
114                                             int moncount,
115                                             int caller_actual_parameters,
116                                             int callee_param_count,
117                                             int callee_locals,
118                                             frame* caller,
119                                             frame* interpreter_frame,
120                                             bool is_top_frame,
121                                             bool is_bottom_frame) {
122   // The frame interpreter_frame is guaranteed to be the right size,
123   // as determined by a previous call to the size_activation() method.
124   // It is also guaranteed to be walkable even though it is in a
125   // skeletal state
126 
127   int max_locals = method->max_locals() * Interpreter::stackElementWords;
128   int extra_locals = (method->max_locals() - method->size_of_parameters()) *
129     Interpreter::stackElementWords;
130 
131 #ifdef ASSERT
132   assert(caller->sp() == interpreter_frame->sender_sp(), "Frame not properly walkable");
133 #endif
134 
135   interpreter_frame->interpreter_frame_set_method(method);
136   // NOTE the difference in using sender_sp and
137   // interpreter_frame_sender_sp interpreter_frame_sender_sp is
138   // the original sp of the caller (the unextended_sp) and
139   // sender_sp is fp+8/16 (32bit/64bit) XXX
140   //
141   // The interpreted method entry on AArch64 aligns SP to 16 bytes
142   // before generating the fixed part of the activation frame. So there
143   // may be a gap between the locals block and the saved sender SP. For
144   // an interpreted caller we need to recreate this gap and exactly
145   // align the incoming parameters with the caller's temporary
146   // expression stack. For other types of caller frame it doesn't
147   // matter.
148   intptr_t* locals;
149   if (caller->is_interpreted_frame()) {
150     locals = caller->interpreter_frame_last_sp() + caller_actual_parameters - 1;
151   } else {
152     locals = interpreter_frame->sender_sp() + max_locals - 1;
153   }
154 
155 #ifdef ASSERT
156   if (caller->is_interpreted_frame()) {
157     assert(locals < caller->fp() + frame::interpreter_frame_initial_sp_offset, "bad placement");
158   }
159 #endif
160 
161   interpreter_frame->interpreter_frame_set_locals(locals);
162   BasicObjectLock* montop = interpreter_frame->interpreter_frame_monitor_begin();
163   BasicObjectLock* monbot = montop - moncount;
164   interpreter_frame->interpreter_frame_set_monitor_end(monbot);
165 
166   // Set last_sp
167   intptr_t*  esp = (intptr_t*) monbot -
168     tempcount*Interpreter::stackElementWords -
169     popframe_extra_args;
170   interpreter_frame->interpreter_frame_set_last_sp(esp);
171 
172   // All frames but the initial (oldest) interpreter frame we fill in have
173   // a value for sender_sp that allows walking the stack but isn't
174   // truly correct. Correct the value here.
175   if (extra_locals != 0 &&
176       interpreter_frame->sender_sp() ==
177       interpreter_frame->interpreter_frame_sender_sp()) {
178     interpreter_frame->set_interpreter_frame_sender_sp(caller->sp() +
179                                                        extra_locals);
180   }
181   *interpreter_frame->interpreter_frame_cache_addr() =
182     method->constants()->cache();
183   *interpreter_frame->interpreter_frame_mirror_addr() =
184     method->method_holder()->java_mirror();
185 }