1 /*
2 * Copyright 1997-2009 Sun Microsystems, Inc. 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
20 * CA 95054 USA or visit www.sun.com if you need additional information or
21 * have any 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 // Runtime support
113
114 // length = invoke bytecode length (to advance to next bytecode)
115 static address deopt_entry (TosState state, int length) { ShouldNotReachHere(); return NULL; }
116 static address return_entry (TosState state, int length) { ShouldNotReachHere(); return NULL; }
117
118 static address rethrow_exception_entry() { return _rethrow_exception_entry; }
119
120 // Activation size in words for a method that is just being called.
121 // Parameters haven't been pushed so count them too.
122 static int size_top_interpreter_activation(methodOop method);
123
124 // Deoptimization support
125 static address continuation_for(methodOop method,
126 address bcp,
127 int callee_parameters,
128 bool is_top_frame,
129 bool& use_next_mdp);
130
131 // share implementation of size_activation and layout_activation:
132 static int size_activation(methodOop method,
133 int temps,
134 int popframe_args,
135 int monitors,
136 int callee_params,
137 int callee_locals,
138 bool is_top_frame);
139
140 static int layout_activation(methodOop method,
141 int temps,
142 int popframe_args,
143 int monitors,
144 int callee_params,
145 int callee_locals,
146 frame* caller,
147 frame* interpreter_frame,
148 bool is_top_frame);
149
150 // Runtime support
151 static bool is_not_reached( methodHandle method, int bci);
152 // Safepoint support
153 static void notice_safepoints() { ShouldNotReachHere(); } // stops the thread when reaching a safepoint
154 static void ignore_safepoints() { ShouldNotReachHere(); } // ignores safepoints
155
156 // Support for native calls
157 static address slow_signature_handler() { return _slow_signature_handler; }
158 static address result_handler(BasicType type) { return _native_abi_to_tosca[BasicType_as_index(type)]; }
159 static int BasicType_as_index(BasicType type); // computes index into result_handler_by_index table
160 static bool in_native_entry(address pc) { return _native_entry_begin <= pc && pc < _native_entry_end; }
161 // Debugging/printing
162 static void print(); // prints the interpreter code
163
164 // Support for Tagged Stacks
165 //
166 // Tags are stored on the Java Expression stack above the value:
167 //
168 // tag
169 // value
170 //
171 // For double values:
172 //
173 // tag2
174 // high word
175 // tag1
176 // low word
177
178 public:
179 static int stackElementWords() { return TaggedStackInterpreter ? 2 : 1; }
180 static int stackElementSize() { return stackElementWords()*wordSize; }
181 static int logStackElementSize() { return
182 TaggedStackInterpreter? LogBytesPerWord+1 : LogBytesPerWord; }
183
184 // Tag is at pointer, value is one below for a stack growing down
185 // (or above for stack growing up)
186 static int value_offset_in_bytes() {
187 return TaggedStackInterpreter ?
188 frame::interpreter_frame_expression_stack_direction() * wordSize : 0;
189 }
190 static int tag_offset_in_bytes() {
191 assert(TaggedStackInterpreter, "should not call this");
192 return 0;
193 }
194
195 // Tagged Locals
196 // Locals are stored relative to Llocals:
197 //
198 // tag <- Llocals[n]
199 // value
200 //
201 // Category 2 types are indexed as:
202 //
203 // tag <- Llocals[-n]
204 // high word
205 // tag <- Llocals[-n+1]
206 // low word
207 //
208
209 // Local values relative to locals[n]
210 static int local_offset_in_bytes(int n) {
211 return ((frame::interpreter_frame_expression_stack_direction() * n) *
212 stackElementSize()) + value_offset_in_bytes();
213 }
214 static int local_tag_offset_in_bytes(int n) {
215 assert(TaggedStackInterpreter, "should not call this");
216 return ((frame::interpreter_frame_expression_stack_direction() * n) *
217 stackElementSize()) + tag_offset_in_bytes();
218 }
219
220 // access to stacked values according to type:
221 static oop* oop_addr_in_slot(intptr_t* slot_addr) {
222 return (oop*) slot_addr;
223 }
224 static jint* int_addr_in_slot(intptr_t* slot_addr) {
225 if ((int) sizeof(jint) < wordSize && !Bytes::is_Java_byte_ordering_different())
226 // big-endian LP64
227 return (jint*)(slot_addr + 1) - 1;
228 else
229 return (jint*) slot_addr;
230 }
231 static jlong long_in_slot(intptr_t* slot_addr) {
232 if (sizeof(intptr_t) >= sizeof(jlong)) {
233 return *(jlong*) slot_addr;
234 } else if (!TaggedStackInterpreter) {
235 return Bytes::get_native_u8((address)slot_addr);
236 } else {
237 assert(sizeof(intptr_t) * 2 == sizeof(jlong), "ILP32");
238 // assemble the long in memory order (not arithmetic order)
239 union { jlong j; jint i[2]; } u;
240 u.i[0] = (jint) slot_addr[0*stackElementSize()];
241 u.i[1] = (jint) slot_addr[1*stackElementSize()];
242 return u.j;
243 }
244 }
245 static void set_long_in_slot(intptr_t* slot_addr, jlong value) {
246 if (sizeof(intptr_t) >= sizeof(jlong)) {
247 *(jlong*) slot_addr = value;
248 } else if (!TaggedStackInterpreter) {
249 Bytes::put_native_u8((address)slot_addr, value);
250 } else {
251 assert(sizeof(intptr_t) * 2 == sizeof(jlong), "ILP32");
252 // assemble the long in memory order (not arithmetic order)
253 union { jlong j; jint i[2]; } u;
254 u.j = value;
255 slot_addr[0*stackElementSize()] = (intptr_t) u.i[0];
256 slot_addr[1*stackElementSize()] = (intptr_t) u.i[1];
257 }
258 }
259 static void get_jvalue_in_slot(intptr_t* slot_addr, BasicType type, jvalue* value) {
260 switch (type) {
261 case T_BOOLEAN: value->z = *int_addr_in_slot(slot_addr); break;
262 case T_CHAR: value->c = *int_addr_in_slot(slot_addr); break;
263 case T_BYTE: value->b = *int_addr_in_slot(slot_addr); break;
264 case T_SHORT: value->s = *int_addr_in_slot(slot_addr); break;
265 case T_INT: value->i = *int_addr_in_slot(slot_addr); break;
266 case T_LONG: value->j = long_in_slot(slot_addr); break;
267 case T_FLOAT: value->f = *(jfloat*)int_addr_in_slot(slot_addr); break;
268 case T_DOUBLE: value->d = jdouble_cast(long_in_slot(slot_addr)); break;
269 case T_OBJECT: value->l = (jobject)*oop_addr_in_slot(slot_addr); break;
270 default: ShouldNotReachHere();
271 }
272 }
273 static void set_jvalue_in_slot(intptr_t* slot_addr, BasicType type, jvalue* value) {
274 switch (type) {
275 case T_BOOLEAN: *int_addr_in_slot(slot_addr) = (value->z != 0); break;
276 case T_CHAR: *int_addr_in_slot(slot_addr) = value->c; break;
277 case T_BYTE: *int_addr_in_slot(slot_addr) = value->b; break;
278 case T_SHORT: *int_addr_in_slot(slot_addr) = value->s; break;
279 case T_INT: *int_addr_in_slot(slot_addr) = value->i; break;
280 case T_LONG: set_long_in_slot(slot_addr, value->j); break;
281 case T_FLOAT: *(jfloat*)int_addr_in_slot(slot_addr) = value->f; break;
282 case T_DOUBLE: set_long_in_slot(slot_addr, jlong_cast(value->d)); break;
283 case T_OBJECT: *oop_addr_in_slot(slot_addr) = (oop) value->l; break;
284 default: ShouldNotReachHere();
285 }
286 }
287 };
288
289 //------------------------------------------------------------------------------------------------------------------------
290 // The interpreter generator.
291
292 class Template;
293 class AbstractInterpreterGenerator: public StackObj {
294 protected:
295 InterpreterMacroAssembler* _masm;
296
297 // shared code sequences
298 // Converter for native abi result to tosca result
299 address generate_result_handler_for(BasicType type);
300 address generate_slow_signature_handler();
301
302 // entry point generator
303 address generate_method_entry(AbstractInterpreter::MethodKind kind);
304
305 void bang_stack_shadow_pages(bool native_call);
306
307 void generate_all();
308
309 public:
310 AbstractInterpreterGenerator(StubQueue* _code);
311 };