1 /*
2 * Copyright (c) 1997, 2017, 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 #include "precompiled.hpp"
26 #include "interpreter/interpreter.hpp"
27 #include "interpreter/interpreterRuntime.hpp"
28 #include "interpreter/interp_masm.hpp"
29 #include "interpreter/templateInterpreter.hpp"
30 #include "interpreter/templateInterpreterGenerator.hpp"
31 #include "interpreter/templateTable.hpp"
32 #include "memory/resourceArea.hpp"
33 #include "runtime/timerTrace.hpp"
34
35 #ifndef CC_INTERP
36
37 # define __ _masm->
38
39 void TemplateInterpreter::initialize() {
40 if (_code != NULL) return;
41 // assertions
42 assert((int)Bytecodes::number_of_codes <= (int)DispatchTable::length,
43 "dispatch table too small");
44
45 AbstractInterpreter::initialize();
46
47 TemplateTable::initialize();
48
49 // generate interpreter
50 { ResourceMark rm;
51 TraceTime timer("Interpreter generation", TRACETIME_LOG(Info, startuptime));
52 int code_size = InterpreterCodeSize;
53 NOT_PRODUCT(code_size *= 4;) // debug uses extra interpreter code space
54 _code = new StubQueue(new InterpreterCodeletInterface, code_size, NULL,
55 "Interpreter");
56 TemplateInterpreterGenerator g(_code);
57 // Free the unused memory not occupied by the interpreter and the stubs
58 _code->deallocate_unused_tail();
59 }
60
61 if (PrintInterpreter) {
62 ResourceMark rm;
63 print();
64 }
65
66 // initialize dispatch table
67 _active_table = _normal_table;
68 }
69
70 //------------------------------------------------------------------------------------------------------------------------
71 // Implementation of EntryPoint
72
73 EntryPoint::EntryPoint() {
74 assert(number_of_states == 10, "check the code below");
75 _entry[btos] = NULL;
76 _entry[ztos] = NULL;
77 _entry[ctos] = NULL;
78 _entry[stos] = NULL;
79 _entry[atos] = NULL;
80 _entry[itos] = NULL;
81 _entry[ltos] = NULL;
82 _entry[ftos] = NULL;
83 _entry[dtos] = NULL;
84 _entry[vtos] = NULL;
85 }
86
87
88 EntryPoint::EntryPoint(address bentry, address zentry, address centry, address sentry, address aentry, address ientry, address lentry, address fentry, address dentry, address ventry) {
89 assert(number_of_states == 10, "check the code below");
90 _entry[btos] = bentry;
91 _entry[ztos] = zentry;
92 _entry[ctos] = centry;
93 _entry[stos] = sentry;
94 _entry[atos] = aentry;
95 _entry[itos] = ientry;
96 _entry[ltos] = lentry;
97 _entry[ftos] = fentry;
98 _entry[dtos] = dentry;
99 _entry[vtos] = ventry;
100 }
101
102
103 void EntryPoint::set_entry(TosState state, address entry) {
104 assert(0 <= state && state < number_of_states, "state out of bounds");
105 _entry[state] = entry;
106 }
107
108
109 address EntryPoint::entry(TosState state) const {
110 assert(0 <= state && state < number_of_states, "state out of bounds");
111 return _entry[state];
112 }
113
114
115 void EntryPoint::print() {
116 tty->print("[");
117 for (int i = 0; i < number_of_states; i++) {
118 if (i > 0) tty->print(", ");
119 tty->print(INTPTR_FORMAT, p2i(_entry[i]));
120 }
121 tty->print("]");
122 }
123
124
125 bool EntryPoint::operator == (const EntryPoint& y) {
126 int i = number_of_states;
127 while (i-- > 0) {
128 if (_entry[i] != y._entry[i]) return false;
129 }
130 return true;
131 }
132
133
134 //------------------------------------------------------------------------------------------------------------------------
135 // Implementation of DispatchTable
136
137 EntryPoint DispatchTable::entry(int i) const {
138 assert(0 <= i && i < length, "index out of bounds");
139 return
140 EntryPoint(
141 _table[btos][i],
142 _table[ztos][i],
143 _table[ctos][i],
144 _table[stos][i],
145 _table[atos][i],
146 _table[itos][i],
147 _table[ltos][i],
148 _table[ftos][i],
149 _table[dtos][i],
150 _table[vtos][i]
151 );
152 }
153
154
155 void DispatchTable::set_entry(int i, EntryPoint& entry) {
156 assert(0 <= i && i < length, "index out of bounds");
157 assert(number_of_states == 10, "check the code below");
158 _table[btos][i] = entry.entry(btos);
159 _table[ztos][i] = entry.entry(ztos);
160 _table[ctos][i] = entry.entry(ctos);
161 _table[stos][i] = entry.entry(stos);
162 _table[atos][i] = entry.entry(atos);
163 _table[itos][i] = entry.entry(itos);
164 _table[ltos][i] = entry.entry(ltos);
165 _table[ftos][i] = entry.entry(ftos);
166 _table[dtos][i] = entry.entry(dtos);
167 _table[vtos][i] = entry.entry(vtos);
168 }
169
170
171 bool DispatchTable::operator == (DispatchTable& y) {
172 int i = length;
173 while (i-- > 0) {
174 EntryPoint t = y.entry(i); // for compiler compatibility (BugId 4150096)
175 if (!(entry(i) == t)) return false;
176 }
177 return true;
178 }
179
180 address TemplateInterpreter::_remove_activation_entry = NULL;
181 address TemplateInterpreter::_remove_activation_preserving_args_entry = NULL;
182
183
184 address TemplateInterpreter::_throw_ArrayIndexOutOfBoundsException_entry = NULL;
185 address TemplateInterpreter::_throw_ArrayStoreException_entry = NULL;
186 address TemplateInterpreter::_throw_ArithmeticException_entry = NULL;
187 address TemplateInterpreter::_throw_ClassCastException_entry = NULL;
188 address TemplateInterpreter::_throw_NullPointerException_entry = NULL;
189 address TemplateInterpreter::_throw_StackOverflowError_entry = NULL;
190 address TemplateInterpreter::_throw_exception_entry = NULL;
191
192 #ifndef PRODUCT
193 EntryPoint TemplateInterpreter::_trace_code;
194 #endif // !PRODUCT
195 EntryPoint TemplateInterpreter::_return_entry[TemplateInterpreter::number_of_return_entries];
196 EntryPoint TemplateInterpreter::_return_entryX[TemplateInterpreter::number_of_return_entries];
197 EntryPoint TemplateInterpreter::_earlyret_entry;
198 EntryPoint TemplateInterpreter::_deopt_entry [TemplateInterpreter::number_of_deopt_entries ];
199 address TemplateInterpreter::_deopt_reexecute_return_entry;
200 EntryPoint TemplateInterpreter::_safept_entry;
201
202 address TemplateInterpreter::_invoke_return_entry[TemplateInterpreter::number_of_return_addrs];
203 address TemplateInterpreter::_invoke_return_entryX[TemplateInterpreter::number_of_return_addrs];
204 address TemplateInterpreter::_invokeinterface_return_entry[TemplateInterpreter::number_of_return_addrs];
205 address TemplateInterpreter::_invokedynamic_return_entry[TemplateInterpreter::number_of_return_addrs];
206
207 DispatchTable TemplateInterpreter::_active_table;
208 DispatchTable TemplateInterpreter::_normal_table;
209 DispatchTable TemplateInterpreter::_safept_table;
210 address TemplateInterpreter::_wentry_point[DispatchTable::length];
211
212
213 //------------------------------------------------------------------------------------------------------------------------
214 // Entry points
215
216 /**
217 * Returns the return entry table for the given invoke bytecode.
218 */
219 address* TemplateInterpreter::invoke_return_entry_table_for(Bytecodes::Code code) {
220 switch (code) {
221 case Bytecodes::_invokestatic:
222 case Bytecodes::_invokespecial:
223 case Bytecodes::_invokevirtual:
224 case Bytecodes::_invokehandle:
225 return Interpreter::invoke_return_entry_table();
226 case Bytecodes::_invokeinterface:
227 return Interpreter::invokeinterface_return_entry_table();
228 case Bytecodes::_invokedynamic:
229 return Interpreter::invokedynamic_return_entry_table();
230 default:
231 fatal("invalid bytecode: %s", Bytecodes::name(code));
232 return NULL;
233 }
234 }
235
236 /**
237 * Returns the return entry address for the given top-of-stack state and bytecode.
238 */
239 address TemplateInterpreter::return_entry(TosState state, int length, Bytecodes::Code code) {
240 return return_entry(state, length, code, false);
241 }
242
243 address TemplateInterpreter::return_entry(TosState state, int length, Bytecodes::Code code, bool X) {
244 guarantee(0 <= length && length < Interpreter::number_of_return_entries, "illegal length");
245 const int index = TosState_as_index(state);
246 switch (code) {
247 case Bytecodes::_invokestatic:
248 case Bytecodes::_invokespecial:
249 case Bytecodes::_invokevirtual:
250 case Bytecodes::_invokehandle:
251 return X ? _invoke_return_entryX[index] : _invoke_return_entry[index];
252 case Bytecodes::_invokeinterface:
253 return _invokeinterface_return_entry[index];
254 case Bytecodes::_invokedynamic:
255 return _invokedynamic_return_entry[index];
256 default:
257 assert(!Bytecodes::is_invoke(code), "invoke instructions should be handled separately: %s", Bytecodes::name(code));
258 address entry = (X ? _return_entryX[length] : _return_entry[length]).entry(state);
259 vmassert(entry != NULL, "unsupported return entry requested, length=%d state=%d", length, index);
260 return entry;
261 }
262 }
263
264
265 address TemplateInterpreter::deopt_entry(TosState state, int length) {
266 guarantee(0 <= length && length < Interpreter::number_of_deopt_entries, "illegal length");
267 address entry = _deopt_entry[length].entry(state);
268 vmassert(entry != NULL, "unsupported deopt entry requested, length=%d state=%d", length, TosState_as_index(state));
269 return entry;
270 }
271
272 //------------------------------------------------------------------------------------------------------------------------
273 // Suport for invokes
274
275 int TemplateInterpreter::TosState_as_index(TosState state) {
276 assert( state < number_of_states , "Invalid state in TosState_as_index");
277 assert(0 <= (int)state && (int)state < TemplateInterpreter::number_of_return_addrs, "index out of bounds");
278 return (int)state;
279 }
280
281
282 //------------------------------------------------------------------------------------------------------------------------
283 // Safepoint suppport
284
285 static inline void copy_table(address* from, address* to, int size) {
286 // Copy non-overlapping tables. The copy has to occur word wise for MT safety.
287 while (size-- > 0) *to++ = *from++;
288 }
289
290 void TemplateInterpreter::notice_safepoints() {
291 if (!_notice_safepoints) {
292 // switch to safepoint dispatch table
293 _notice_safepoints = true;
294 copy_table((address*)&_safept_table, (address*)&_active_table, sizeof(_active_table) / sizeof(address));
295 }
296 }
297
298 // switch from the dispatch table which notices safepoints back to the
299 // normal dispatch table. So that we can notice single stepping points,
300 // keep the safepoint dispatch table if we are single stepping in JVMTI.
301 // Note that the should_post_single_step test is exactly as fast as the
302 // JvmtiExport::_enabled test and covers both cases.
303 void TemplateInterpreter::ignore_safepoints() {
304 if (_notice_safepoints) {
305 if (!JvmtiExport::should_post_single_step()) {
306 // switch to normal dispatch table
307 _notice_safepoints = false;
308 copy_table((address*)&_normal_table, (address*)&_active_table, sizeof(_active_table) / sizeof(address));
309 }
310 }
311 }
312
313 //------------------------------------------------------------------------------------------------------------------------
314 // Deoptimization support
315
316 // If deoptimization happens, this function returns the point of next bytecode to continue execution
317 address TemplateInterpreter::deopt_continue_after_entry(Method* method, address bcp, int callee_parameters, bool is_top_frame) {
318 return AbstractInterpreter::deopt_continue_after_entry(method, bcp, callee_parameters, is_top_frame);
319 }
320
321 // If deoptimization happens, this function returns the point where the interpreter reexecutes
322 // the bytecode.
323 // Note: Bytecodes::_athrow (C1 only) and Bytecodes::_return are the special cases
324 // that do not return "Interpreter::deopt_entry(vtos, 0)"
325 address TemplateInterpreter::deopt_reexecute_entry(Method* method, address bcp) {
326 assert(method->contains(bcp), "just checkin'");
327 Bytecodes::Code code = Bytecodes::code_at(method, bcp);
328 if (code == Bytecodes::_return_register_finalizer) {
329 // This is used for deopt during registration of finalizers
330 // during Object.<init>. We simply need to resume execution at
331 // the standard return vtos bytecode to pop the frame normally.
332 // reexecuting the real bytecode would cause double registration
333 // of the finalizable object.
334 return Interpreter::deopt_reexecute_return_entry();
335 } else {
336 return AbstractInterpreter::deopt_reexecute_entry(method, bcp);
337 }
338 }
339
340 // If deoptimization happens, the interpreter should reexecute this bytecode.
341 // This function mainly helps the compilers to set up the reexecute bit.
342 bool TemplateInterpreter::bytecode_should_reexecute(Bytecodes::Code code) {
343 if (code == Bytecodes::_return) {
344 //Yes, we consider Bytecodes::_return as a special case of reexecution
345 return true;
346 } else {
347 return AbstractInterpreter::bytecode_should_reexecute(code);
348 }
349 }
350
351 InterpreterCodelet* TemplateInterpreter::codelet_containing(address pc) {
352 return (InterpreterCodelet*)_code->stub_containing(pc);
353 }
354
355 #endif // !CC_INTERP