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