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