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