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 "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 #if defined INTERP_MASM_MD_HPP
34 # include INTERP_MASM_MD_HPP
35 #elif defined TARGET_ARCH_x86
36 # include "interp_masm_x86.hpp"
37 #elif defined TARGET_ARCH_MODEL_sparc
38 # include "interp_masm_sparc.hpp"
39 #elif defined TARGET_ARCH_MODEL_zero
40 # include "interp_masm_zero.hpp"
41 #elif defined TARGET_ARCH_MODEL_ppc_64
42 # include "interp_masm_ppc_64.hpp"
43 #endif
44
45 // This file contains the platform-independent parts
46 // of the abstract interpreter and the abstract interpreter generator.
47
48 // Organization of the interpreter(s). There exists two different interpreters in hotpot
49 // an assembly language version (aka template interpreter) and a high level language version
50 // (aka c++ interpreter). Th division of labor is as follows:
51
52 // Template Interpreter C++ Interpreter Functionality
53 //
54 // templateTable* bytecodeInterpreter* actual interpretation of bytecodes
55 //
56 // templateInterpreter* cppInterpreter* generation of assembly code that creates
57 // and manages interpreter runtime frames.
58 // Also code for populating interpreter
59 // frames created during deoptimization.
60 //
61 // For both template and c++ interpreter. There are common files for aspects of the interpreter
62 // that are generic to both interpreters. This is the layout:
63 //
64 // abstractInterpreter.hpp: generic description of the interpreter.
65 // interpreter*: generic frame creation and handling.
66 //
67
68 //------------------------------------------------------------------------------------------------------------------------
69 // The C++ interface to the bytecode interpreter(s).
70
71 class AbstractInterpreter: AllStatic {
72 friend class VMStructs;
73 friend class Interpreter;
74 friend class CppInterpreterGenerator;
75 public:
76 enum MethodKind {
77 zerolocals, // method needs locals initialization
78 zerolocals_synchronized, // method needs locals initialization & is synchronized
79 native, // native method
80 native_synchronized, // native method & is synchronized
81 empty, // empty method (code: _return)
82 accessor, // accessor method (code: _aload_0, _getfield, _(a|i)return)
83 abstract, // abstract method (throws an AbstractMethodException)
84 method_handle_invoke_FIRST, // java.lang.invoke.MethodHandles::invokeExact, etc.
85 method_handle_invoke_LAST = (method_handle_invoke_FIRST
86 + (vmIntrinsics::LAST_MH_SIG_POLY
87 - vmIntrinsics::FIRST_MH_SIG_POLY)),
88 java_lang_math_sin, // implementation of java.lang.Math.sin (x)
89 java_lang_math_cos, // implementation of java.lang.Math.cos (x)
90 java_lang_math_tan, // implementation of java.lang.Math.tan (x)
91 java_lang_math_abs, // implementation of java.lang.Math.abs (x)
92 java_lang_math_sqrt, // implementation of java.lang.Math.sqrt (x)
93 java_lang_math_log, // implementation of java.lang.Math.log (x)
94 java_lang_math_log10, // implementation of java.lang.Math.log10 (x)
95 java_lang_math_pow, // implementation of java.lang.Math.pow (x,y)
96 java_lang_math_exp, // implementation of java.lang.Math.exp (x)
97 java_lang_ref_reference_get, // implementation of java.lang.ref.Reference.get()
98 java_util_zip_CRC32_update, // implementation of java.util.zip.CRC32.update()
99 java_util_zip_CRC32_updateBytes, // implementation of java.util.zip.CRC32.updateBytes()
100 java_util_zip_CRC32_updateByteBuffer, // implementation of java.util.zip.CRC32.updateByteBuffer()
101 number_of_method_entries,
102 invalid = -1
103 };
104
105 // Conversion from the part of the above enum to vmIntrinsics::_invokeExact, etc.
106 static vmIntrinsics::ID method_handle_intrinsic(MethodKind kind) {
107 if (kind >= method_handle_invoke_FIRST && kind <= method_handle_invoke_LAST)
108 return (vmIntrinsics::ID)( vmIntrinsics::FIRST_MH_SIG_POLY + (kind - method_handle_invoke_FIRST) );
109 else
110 return vmIntrinsics::_none;
111 }
112
113 enum SomeConstants {
114 number_of_result_handlers = 10 // number of result handlers for native calls
115 };
116
117 protected:
118 static StubQueue* _code; // the interpreter code (codelets)
119
120 static bool _notice_safepoints; // true if safepoints are activated
121
122 static address _native_entry_begin; // Region for native entry code
123 static address _native_entry_end;
124
125 // method entry points
126 static address _entry_table[number_of_method_entries]; // entry points for a given method
127 static address _native_abi_to_tosca[number_of_result_handlers]; // for native method result handlers
128 static address _slow_signature_handler; // the native method generic (slow) signature handler
129
130 static address _rethrow_exception_entry; // rethrows an activation in previous frame
131
132 friend class AbstractInterpreterGenerator;
133 friend class InterpreterGenerator;
134 friend class InterpreterMacroAssembler;
135
136 public:
137 // Initialization/debugging
138 static void initialize();
139 static StubQueue* code() { return _code; }
140
141
142 // Method activation
143 static MethodKind method_kind(methodHandle m);
144 static address entry_for_kind(MethodKind k) { assert(0 <= k && k < number_of_method_entries, "illegal kind"); return _entry_table[k]; }
145 static address entry_for_method(methodHandle m) { return entry_for_kind(method_kind(m)); }
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( 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 // Local values relative to locals[n]
219 static int local_offset_in_bytes(int n) {
220 return ((frame::interpreter_frame_expression_stack_direction() * n) * stackElementSize);
221 }
222
223 // access to stacked values according to type:
224 static oop* oop_addr_in_slot(intptr_t* slot_addr) {
225 return (oop*) slot_addr;
226 }
227 static jint* int_addr_in_slot(intptr_t* slot_addr) {
228 if ((int) sizeof(jint) < wordSize && !Bytes::is_Java_byte_ordering_different())
229 // big-endian LP64
230 return (jint*)(slot_addr + 1) - 1;
231 else
232 return (jint*) slot_addr;
233 }
234 static jlong long_in_slot(intptr_t* slot_addr) {
235 if (sizeof(intptr_t) >= sizeof(jlong)) {
236 return *(jlong*) slot_addr;
237 } else {
238 return Bytes::get_native_u8((address)slot_addr);
239 }
240 }
241 static void set_long_in_slot(intptr_t* slot_addr, jlong value) {
242 if (sizeof(intptr_t) >= sizeof(jlong)) {
243 *(jlong*) slot_addr = value;
244 } else {
245 Bytes::put_native_u8((address)slot_addr, value);
246 }
247 }
248 static void get_jvalue_in_slot(intptr_t* slot_addr, BasicType type, jvalue* value) {
249 switch (type) {
250 case T_BOOLEAN: value->z = *int_addr_in_slot(slot_addr); break;
251 case T_CHAR: value->c = *int_addr_in_slot(slot_addr); break;
252 case T_BYTE: value->b = *int_addr_in_slot(slot_addr); break;
253 case T_SHORT: value->s = *int_addr_in_slot(slot_addr); break;
254 case T_INT: value->i = *int_addr_in_slot(slot_addr); break;
255 case T_LONG: value->j = long_in_slot(slot_addr); break;
256 case T_FLOAT: value->f = *(jfloat*)int_addr_in_slot(slot_addr); break;
257 case T_DOUBLE: value->d = jdouble_cast(long_in_slot(slot_addr)); break;
258 case T_OBJECT: value->l = (jobject)*oop_addr_in_slot(slot_addr); break;
259 default: ShouldNotReachHere();
260 }
261 }
262 static void set_jvalue_in_slot(intptr_t* slot_addr, BasicType type, jvalue* value) {
263 switch (type) {
264 case T_BOOLEAN: *int_addr_in_slot(slot_addr) = (value->z != 0); break;
265 case T_CHAR: *int_addr_in_slot(slot_addr) = value->c; break;
266 case T_BYTE: *int_addr_in_slot(slot_addr) = value->b; break;
267 case T_SHORT: *int_addr_in_slot(slot_addr) = value->s; break;
268 case T_INT: *int_addr_in_slot(slot_addr) = value->i; break;
269 case T_LONG: set_long_in_slot(slot_addr, value->j); break;
270 case T_FLOAT: *(jfloat*)int_addr_in_slot(slot_addr) = value->f; break;
271 case T_DOUBLE: set_long_in_slot(slot_addr, jlong_cast(value->d)); break;
272 case T_OBJECT: *oop_addr_in_slot(slot_addr) = (oop) value->l; break;
273 default: ShouldNotReachHere();
274 }
275 }
276 };
277
278 //------------------------------------------------------------------------------------------------------------------------
279 // The interpreter generator.
280
281 class Template;
282 class AbstractInterpreterGenerator: public StackObj {
283 protected:
284 InterpreterMacroAssembler* _masm;
285
286 // shared code sequences
287 // Converter for native abi result to tosca result
288 address generate_result_handler_for(BasicType type);
289 address generate_slow_signature_handler();
290
291 // entry point generator
292 address generate_method_entry(AbstractInterpreter::MethodKind kind);
293
294 void bang_stack_shadow_pages(bool native_call);
295
296 void generate_all();
297 void initialize_method_handle_entries();
298
299 public:
300 AbstractInterpreterGenerator(StubQueue* _code);
301 };
302
303 #endif // SHARE_VM_INTERPRETER_ABSTRACTINTERPRETER_HPP