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