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