1 /*
2 * Copyright (c) 1997, 2013, 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 #ifndef SHARE_VM_INTERPRETER_ABSTRACTINTERPRETER_HPP
26 #define SHARE_VM_INTERPRETER_ABSTRACTINTERPRETER_HPP
27
28 #include "code/stubs.hpp"
29 #include "interpreter/bytecodes.hpp"
30 #include "runtime/thread.inline.hpp"
31 #include "runtime/vmThread.hpp"
32 #include "utilities/top.hpp"
33 #ifdef TARGET_ARCH_MODEL_x86_32
34 # include "interp_masm_x86_32.hpp"
35 #endif
36 #ifdef TARGET_ARCH_MODEL_x86_64
37 # include "interp_masm_x86_64.hpp"
38 #endif
39 #ifdef TARGET_ARCH_MODEL_sparc
40 # include "interp_masm_sparc.hpp"
41 #endif
42 #ifdef TARGET_ARCH_MODEL_zero
43 # include "interp_masm_zero.hpp"
44 #endif
45 #ifdef TARGET_ARCH_MODEL_arm
46 # include "interp_masm_arm.hpp"
47 #endif
48 #ifdef TARGET_ARCH_MODEL_ppc
49 # include "interp_masm_ppc.hpp"
50 #endif
51
52 // This file contains the platform-independent parts
53 // of the abstract interpreter and the abstract interpreter generator.
54
55 // Organization of the interpreter(s). There exists two different interpreters in hotpot
56 // an assembly language version (aka template interpreter) and a high level language version
57 // (aka c++ interpreter). Th division of labor is as follows:
58
59 // Template Interpreter C++ Interpreter Functionality
60 //
61 // templateTable* bytecodeInterpreter* actual interpretation of bytecodes
62 //
63 // templateInterpreter* cppInterpreter* generation of assembly code that creates
64 // and manages interpreter runtime frames.
65 // Also code for populating interpreter
66 // frames created during deoptimization.
67 //
68 // For both template and c++ interpreter. There are common files for aspects of the interpreter
69 // that are generic to both interpreters. This is the layout:
70 //
71 // abstractInterpreter.hpp: generic description of the interpreter.
72 // interpreter*: generic frame creation and handling.
73 //
74
75 //------------------------------------------------------------------------------------------------------------------------
76 // The C++ interface to the bytecode interpreter(s).
77
78 class AbstractInterpreter: AllStatic {
79 friend class VMStructs;
80 friend class Interpreter;
81 friend class CppInterpreterGenerator;
82 public:
83 enum MethodKind {
84 zerolocals, // method needs locals initialization
85 zerolocals_synchronized, // method needs locals initialization & is synchronized
86 native, // native method
87 native_synchronized, // native method & is synchronized
88 empty, // empty method (code: _return)
89 accessor, // accessor method (code: _aload_0, _getfield, _(a|i)return)
90 abstract, // abstract method (throws an AbstractMethodException)
91 method_handle_invoke_FIRST, // java.lang.invoke.MethodHandles::invokeExact, etc.
92 method_handle_invoke_LAST = (method_handle_invoke_FIRST
93 + (vmIntrinsics::LAST_MH_SIG_POLY
94 - vmIntrinsics::FIRST_MH_SIG_POLY)),
95 java_lang_math_sin, // implementation of java.lang.Math.sin (x)
96 java_lang_math_cos, // implementation of java.lang.Math.cos (x)
97 java_lang_math_tan, // implementation of java.lang.Math.tan (x)
98 java_lang_math_abs, // implementation of java.lang.Math.abs (x)
99 java_lang_math_sqrt, // implementation of java.lang.Math.sqrt (x)
100 java_lang_math_log, // implementation of java.lang.Math.log (x)
101 java_lang_math_log10, // implementation of java.lang.Math.log10 (x)
102 java_lang_math_pow, // implementation of java.lang.Math.pow (x,y)
103 java_lang_math_exp, // implementation of java.lang.Math.exp (x)
104 java_lang_ref_reference_get, // implementation of java.lang.ref.Reference.get()
105 java_util_zip_CRC32_update, // implementation of java.util.zip.CRC32.update()
106 java_util_zip_CRC32_updateBytes, // implementation of java.util.zip.CRC32.updateBytes()
107 java_util_zip_CRC32_updateByteBuffer, // implementation of java.util.zip.CRC32.updateByteBuffer()
108 number_of_method_entries,
109 invalid = -1
110 };
111
112 // Conversion from the part of the above enum to vmIntrinsics::_invokeExact, etc.
113 static vmIntrinsics::ID method_handle_intrinsic(MethodKind kind) {
114 if (kind >= method_handle_invoke_FIRST && kind <= method_handle_invoke_LAST)
115 return (vmIntrinsics::ID)( vmIntrinsics::FIRST_MH_SIG_POLY + (kind - method_handle_invoke_FIRST) );
116 else
117 return vmIntrinsics::_none;
118 }
119
120 enum SomeConstants {
121 number_of_result_handlers = 10 // number of result handlers for native calls
122 };
123
124 protected:
125 static StubQueue* _code; // the interpreter code (codelets)
126
127 static bool _notice_safepoints; // true if safepoints are activated
128
129 static address _native_entry_begin; // Region for native entry code
130 static address _native_entry_end;
131
132 // method entry points
133 static address _entry_table[number_of_method_entries]; // entry points for a given method
134 static address _native_abi_to_tosca[number_of_result_handlers]; // for native method result handlers
135 static address _slow_signature_handler; // the native method generic (slow) signature handler
136
137 static address _rethrow_exception_entry; // rethrows an activation in previous frame
138
139 friend class AbstractInterpreterGenerator;
140 friend class InterpreterGenerator;
141 friend class InterpreterMacroAssembler;
142
143 public:
144 // Initialization/debugging
145 static void initialize();
146 static StubQueue* code() { return _code; }
147
148
149 // Method activation
150 static MethodKind method_kind(methodHandle m);
151 static address entry_for_kind(MethodKind k) { assert(0 <= k && k < number_of_method_entries, "illegal kind"); return _entry_table[k]; }
152 static address entry_for_method(methodHandle m) { return entry_for_kind(method_kind(m)); }
153
154 // used for bootstrapping method handles:
155 static void set_entry_for_kind(MethodKind k, address e);
156
157 static void print_method_kind(MethodKind kind) PRODUCT_RETURN;
158
159 static bool can_be_compiled(methodHandle m);
160
161 // Runtime support
162
163 // length = invoke bytecode length (to advance to next bytecode)
164 static address deopt_entry(TosState state, int length) { ShouldNotReachHere(); return NULL; }
165 static address return_entry(TosState state, int length, Bytecodes::Code code) { ShouldNotReachHere(); return NULL; }
166
167 static address rethrow_exception_entry() { return _rethrow_exception_entry; }
168
169 // Activation size in words for a method that is just being called.
170 // Parameters haven't been pushed so count them too.
171 static int size_top_interpreter_activation(Method* method);
172
173 // Deoptimization support
174 // Compute the entry address for continuation after
175 static address deopt_continue_after_entry(Method* method,
176 address bcp,
177 int callee_parameters,
178 bool is_top_frame);
179 // Compute the entry address for reexecution
180 static address deopt_reexecute_entry(Method* method, address bcp);
181 // Deoptimization should reexecute this bytecode
182 static bool bytecode_should_reexecute(Bytecodes::Code code);
183
184 // share implementation of size_activation and layout_activation:
185 static int size_activation(Method* method,
186 int temps,
187 int popframe_args,
188 int monitors,
189 int caller_actual_parameters,
190 int callee_params,
191 int callee_locals,
192 bool is_top_frame,
193 bool is_bottom_frame) {
194 return layout_activation(method,
195 temps,
196 popframe_args,
197 monitors,
198 caller_actual_parameters,
199 callee_params,
200 callee_locals,
201 (frame*)NULL,
202 (frame*)NULL,
203 is_top_frame,
204 is_bottom_frame);
205 }
206
207 static int layout_activation(Method* method,
208 int temps,
209 int popframe_args,
210 int monitors,
211 int caller_actual_parameters,
212 int callee_params,
213 int callee_locals,
214 frame* caller,
215 frame* interpreter_frame,
216 bool is_top_frame,
217 bool is_bottom_frame);
218
219 // Runtime support
220 static bool is_not_reached( methodHandle method, int bci);
221 // Safepoint support
222 static void notice_safepoints() { ShouldNotReachHere(); } // stops the thread when reaching a safepoint
223 static void ignore_safepoints() { ShouldNotReachHere(); } // ignores safepoints
224
225 // Support for native calls
226 static address slow_signature_handler() { return _slow_signature_handler; }
227 static address result_handler(BasicType type) { return _native_abi_to_tosca[BasicType_as_index(type)]; }
228 static int BasicType_as_index(BasicType type); // computes index into result_handler_by_index table
229 static bool in_native_entry(address pc) { return _native_entry_begin <= pc && pc < _native_entry_end; }
230 // Debugging/printing
231 static void print(); // prints the interpreter code
232
233 public:
234 // Interpreter helpers
235 const static int stackElementWords = 1;
236 const static int stackElementSize = stackElementWords * wordSize;
237 const static int logStackElementSize = LogBytesPerWord;
238
239 // Local values relative to locals[n]
240 static int local_offset_in_bytes(int n) {
241 return ((frame::interpreter_frame_expression_stack_direction() * n) * stackElementSize);
242 }
243
244 // access to stacked values according to type:
245 static oop* oop_addr_in_slot(intptr_t* slot_addr) {
246 return (oop*) slot_addr;
247 }
248 static jint* int_addr_in_slot(intptr_t* slot_addr) {
249 if ((int) sizeof(jint) < wordSize && !Bytes::is_Java_byte_ordering_different())
250 // big-endian LP64
251 return (jint*)(slot_addr + 1) - 1;
252 else
253 return (jint*) slot_addr;
254 }
255 static jlong long_in_slot(intptr_t* slot_addr) {
256 if (sizeof(intptr_t) >= sizeof(jlong)) {
257 return *(jlong*) slot_addr;
258 } else {
259 return Bytes::get_native_u8((address)slot_addr);
260 }
261 }
262 static void set_long_in_slot(intptr_t* slot_addr, jlong value) {
263 if (sizeof(intptr_t) >= sizeof(jlong)) {
264 *(jlong*) slot_addr = value;
265 } else {
266 Bytes::put_native_u8((address)slot_addr, value);
267 }
268 }
269 static void get_jvalue_in_slot(intptr_t* slot_addr, BasicType type, jvalue* value) {
270 switch (type) {
271 case T_BOOLEAN: value->z = *int_addr_in_slot(slot_addr); break;
272 case T_CHAR: value->c = *int_addr_in_slot(slot_addr); break;
273 case T_BYTE: value->b = *int_addr_in_slot(slot_addr); break;
274 case T_SHORT: value->s = *int_addr_in_slot(slot_addr); break;
275 case T_INT: value->i = *int_addr_in_slot(slot_addr); break;
276 case T_LONG: value->j = long_in_slot(slot_addr); break;
277 case T_FLOAT: value->f = *(jfloat*)int_addr_in_slot(slot_addr); break;
278 case T_DOUBLE: value->d = jdouble_cast(long_in_slot(slot_addr)); break;
279 case T_OBJECT: value->l = (jobject)*oop_addr_in_slot(slot_addr); break;
280 default: ShouldNotReachHere();
281 }
282 }
283 static void set_jvalue_in_slot(intptr_t* slot_addr, BasicType type, jvalue* value) {
284 switch (type) {
285 case T_BOOLEAN: *int_addr_in_slot(slot_addr) = (value->z != 0); break;
286 case T_CHAR: *int_addr_in_slot(slot_addr) = value->c; break;
287 case T_BYTE: *int_addr_in_slot(slot_addr) = value->b; break;
288 case T_SHORT: *int_addr_in_slot(slot_addr) = value->s; break;
289 case T_INT: *int_addr_in_slot(slot_addr) = value->i; break;
290 case T_LONG: set_long_in_slot(slot_addr, value->j); break;
291 case T_FLOAT: *(jfloat*)int_addr_in_slot(slot_addr) = value->f; break;
292 case T_DOUBLE: set_long_in_slot(slot_addr, jlong_cast(value->d)); break;
293 case T_OBJECT: *oop_addr_in_slot(slot_addr) = (oop) value->l; break;
294 default: ShouldNotReachHere();
295 }
296 }
297 };
298
299 //------------------------------------------------------------------------------------------------------------------------
300 // The interpreter generator.
301
302 class Template;
303 class AbstractInterpreterGenerator: public StackObj {
304 protected:
305 InterpreterMacroAssembler* _masm;
306
307 // shared code sequences
308 // Converter for native abi result to tosca result
309 address generate_result_handler_for(BasicType type);
310 address generate_slow_signature_handler();
311
312 // entry point generator
313 address generate_method_entry(AbstractInterpreter::MethodKind kind);
314
315 void bang_stack_shadow_pages(bool native_call);
316
317 void generate_all();
318 void initialize_method_handle_entries();
319
320 public:
321 AbstractInterpreterGenerator(StubQueue* _code);
322 };
323
324 #endif // SHARE_VM_INTERPRETER_ABSTRACTINTERPRETER_HPP