1 /*
2 * Copyright (c) 1997, 2010, 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 // This file contains the platform-independent parts
26 // of the abstract interpreter and the abstract interpreter generator.
27
28 // Organization of the interpreter(s). There exists two different interpreters in hotpot
29 // an assembly language version (aka template interpreter) and a high level language version
30 // (aka c++ interpreter). Th division of labor is as follows:
31
32 // Template Interpreter C++ Interpreter Functionality
33 //
34 // templateTable* bytecodeInterpreter* actual interpretation of bytecodes
35 //
36 // templateInterpreter* cppInterpreter* generation of assembly code that creates
37 // and manages interpreter runtime frames.
38 // Also code for populating interpreter
39 // frames created during deoptimization.
40 //
41 // For both template and c++ interpreter. There are common files for aspects of the interpreter
42 // that are generic to both interpreters. This is the layout:
43 //
44 // abstractInterpreter.hpp: generic description of the interpreter.
45 // interpreter*: generic frame creation and handling.
46 //
47
48 //------------------------------------------------------------------------------------------------------------------------
49 // The C++ interface to the bytecode interpreter(s).
50
51 class AbstractInterpreter: AllStatic {
52 friend class VMStructs;
53 friend class Interpreter;
54 friend class CppInterpreterGenerator;
55 public:
56 enum MethodKind {
57 zerolocals, // method needs locals initialization
58 zerolocals_synchronized, // method needs locals initialization & is synchronized
59 native, // native method
60 native_synchronized, // native method & is synchronized
61 empty, // empty method (code: _return)
62 accessor, // accessor method (code: _aload_0, _getfield, _(a|i)return)
63 abstract, // abstract method (throws an AbstractMethodException)
64 method_handle, // java.dyn.MethodHandles::invoke
65 java_lang_math_sin, // implementation of java.lang.Math.sin (x)
66 java_lang_math_cos, // implementation of java.lang.Math.cos (x)
67 java_lang_math_tan, // implementation of java.lang.Math.tan (x)
68 java_lang_math_abs, // implementation of java.lang.Math.abs (x)
69 java_lang_math_sqrt, // implementation of java.lang.Math.sqrt (x)
70 java_lang_math_log, // implementation of java.lang.Math.log (x)
71 java_lang_math_log10, // implementation of java.lang.Math.log10 (x)
72 number_of_method_entries,
73 invalid = -1
74 };
75
76 enum SomeConstants {
77 number_of_result_handlers = 10 // number of result handlers for native calls
78 };
79
80 protected:
81 static StubQueue* _code; // the interpreter code (codelets)
82
83 static bool _notice_safepoints; // true if safepoints are activated
84
85 static address _native_entry_begin; // Region for native entry code
86 static address _native_entry_end;
87
88 // method entry points
89 static address _entry_table[number_of_method_entries]; // entry points for a given method
90 static address _native_abi_to_tosca[number_of_result_handlers]; // for native method result handlers
91 static address _slow_signature_handler; // the native method generic (slow) signature handler
92
93 static address _rethrow_exception_entry; // rethrows an activation in previous frame
94
95 friend class AbstractInterpreterGenerator;
96 friend class InterpreterGenerator;
97 friend class InterpreterMacroAssembler;
98
99 public:
100 // Initialization/debugging
101 static void initialize();
102 static StubQueue* code() { return _code; }
103
104
105 // Method activation
106 static MethodKind method_kind(methodHandle m);
107 static address entry_for_kind(MethodKind k) { assert(0 <= k && k < number_of_method_entries, "illegal kind"); return _entry_table[k]; }
108 static address entry_for_method(methodHandle m) { return _entry_table[method_kind(m)]; }
109
110 static void print_method_kind(MethodKind kind) PRODUCT_RETURN;
111
112 static bool can_be_compiled(methodHandle m);
113
114 // Runtime support
115
116 // length = invoke bytecode length (to advance to next bytecode)
117 static address deopt_entry (TosState state, int length) { ShouldNotReachHere(); return NULL; }
118 static address return_entry (TosState state, int length) { ShouldNotReachHere(); return NULL; }
119
120 static address rethrow_exception_entry() { return _rethrow_exception_entry; }
121
122 // Activation size in words for a method that is just being called.
123 // Parameters haven't been pushed so count them too.
124 static int size_top_interpreter_activation(methodOop method);
125
126 // Deoptimization support
127 // Compute the entry address for continuation after
128 static address deopt_continue_after_entry(methodOop method,
129 address bcp,
130 int callee_parameters,
131 bool is_top_frame);
132 // Compute the entry address for reexecution
133 static address deopt_reexecute_entry(methodOop method, address bcp);
134 // Deoptimization should reexecute this bytecode
135 static bool bytecode_should_reexecute(Bytecodes::Code code);
136
137 // share implementation of size_activation and layout_activation:
138 static int size_activation(methodOop method,
139 int temps,
140 int popframe_args,
141 int monitors,
142 int callee_params,
143 int callee_locals,
144 bool is_top_frame);
145
146 static int layout_activation(methodOop method,
147 int temps,
148 int popframe_args,
149 int monitors,
150 int callee_params,
151 int callee_locals,
152 frame* caller,
153 frame* interpreter_frame,
154 bool is_top_frame);
155
156 // Runtime support
157 static bool is_not_reached( methodHandle method, int bci);
158 // Safepoint support
159 static void notice_safepoints() { ShouldNotReachHere(); } // stops the thread when reaching a safepoint
160 static void ignore_safepoints() { ShouldNotReachHere(); } // ignores safepoints
161
162 // Support for native calls
163 static address slow_signature_handler() { return _slow_signature_handler; }
164 static address result_handler(BasicType type) { return _native_abi_to_tosca[BasicType_as_index(type)]; }
165 static int BasicType_as_index(BasicType type); // computes index into result_handler_by_index table
166 static bool in_native_entry(address pc) { return _native_entry_begin <= pc && pc < _native_entry_end; }
167 // Debugging/printing
168 static void print(); // prints the interpreter code
169
170 public:
171 // Interpreter helpers
172 const static int stackElementWords = 1;
173 const static int stackElementSize = stackElementWords * wordSize;
174 const static int logStackElementSize = LogBytesPerWord;
175
176 // Local values relative to locals[n]
177 static int local_offset_in_bytes(int n) {
178 return ((frame::interpreter_frame_expression_stack_direction() * n) * stackElementSize);
179 }
180
181 // access to stacked values according to type:
182 static oop* oop_addr_in_slot(intptr_t* slot_addr) {
183 return (oop*) slot_addr;
184 }
185 static jint* int_addr_in_slot(intptr_t* slot_addr) {
186 if ((int) sizeof(jint) < wordSize && !Bytes::is_Java_byte_ordering_different())
187 // big-endian LP64
188 return (jint*)(slot_addr + 1) - 1;
189 else
190 return (jint*) slot_addr;
191 }
192 static jlong long_in_slot(intptr_t* slot_addr) {
193 if (sizeof(intptr_t) >= sizeof(jlong)) {
194 return *(jlong*) slot_addr;
195 } else {
196 return Bytes::get_native_u8((address)slot_addr);
197 }
198 }
199 static void set_long_in_slot(intptr_t* slot_addr, jlong value) {
200 if (sizeof(intptr_t) >= sizeof(jlong)) {
201 *(jlong*) slot_addr = value;
202 } else {
203 Bytes::put_native_u8((address)slot_addr, value);
204 }
205 }
206 static void get_jvalue_in_slot(intptr_t* slot_addr, BasicType type, jvalue* value) {
207 switch (type) {
208 case T_BOOLEAN: value->z = *int_addr_in_slot(slot_addr); break;
209 case T_CHAR: value->c = *int_addr_in_slot(slot_addr); break;
210 case T_BYTE: value->b = *int_addr_in_slot(slot_addr); break;
211 case T_SHORT: value->s = *int_addr_in_slot(slot_addr); break;
212 case T_INT: value->i = *int_addr_in_slot(slot_addr); break;
213 case T_LONG: value->j = long_in_slot(slot_addr); break;
214 case T_FLOAT: value->f = *(jfloat*)int_addr_in_slot(slot_addr); break;
215 case T_DOUBLE: value->d = jdouble_cast(long_in_slot(slot_addr)); break;
216 case T_OBJECT: value->l = (jobject)*oop_addr_in_slot(slot_addr); break;
217 default: ShouldNotReachHere();
218 }
219 }
220 static void set_jvalue_in_slot(intptr_t* slot_addr, BasicType type, jvalue* value) {
221 switch (type) {
222 case T_BOOLEAN: *int_addr_in_slot(slot_addr) = (value->z != 0); break;
223 case T_CHAR: *int_addr_in_slot(slot_addr) = value->c; break;
224 case T_BYTE: *int_addr_in_slot(slot_addr) = value->b; break;
225 case T_SHORT: *int_addr_in_slot(slot_addr) = value->s; break;
226 case T_INT: *int_addr_in_slot(slot_addr) = value->i; break;
227 case T_LONG: set_long_in_slot(slot_addr, value->j); break;
228 case T_FLOAT: *(jfloat*)int_addr_in_slot(slot_addr) = value->f; break;
229 case T_DOUBLE: set_long_in_slot(slot_addr, jlong_cast(value->d)); break;
230 case T_OBJECT: *oop_addr_in_slot(slot_addr) = (oop) value->l; break;
231 default: ShouldNotReachHere();
232 }
233 }
234 };
235
236 //------------------------------------------------------------------------------------------------------------------------
237 // The interpreter generator.
238
239 class Template;
240 class AbstractInterpreterGenerator: public StackObj {
241 protected:
242 InterpreterMacroAssembler* _masm;
243
244 // shared code sequences
245 // Converter for native abi result to tosca result
246 address generate_result_handler_for(BasicType type);
247 address generate_slow_signature_handler();
248
249 // entry point generator
250 address generate_method_entry(AbstractInterpreter::MethodKind kind);
251
252 void bang_stack_shadow_pages(bool native_call);
253
254 void generate_all();
255
256 public:
257 AbstractInterpreterGenerator(StubQueue* _code);
258 };