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