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
34 #ifndef CC_INTERP
35
36 # define __ _masm->
37
38 TemplateInterpreterGenerator::TemplateInterpreterGenerator(StubQueue* _code): AbstractInterpreterGenerator(_code) {
39 _unimplemented_bytecode = NULL;
40 _illegal_bytecode_sequence = NULL;
41 generate_all();
42 }
43
44 static const BasicType types[Interpreter::number_of_result_handlers] = {
45 T_BOOLEAN,
46 T_CHAR ,
47 T_BYTE ,
48 T_SHORT ,
49 T_INT ,
50 T_LONG ,
51 T_VOID ,
52 T_FLOAT ,
53 T_DOUBLE ,
54 T_OBJECT
55 };
56
57 void TemplateInterpreterGenerator::generate_all() {
58 // Loop, in case we need several variants of the interpreter entries
59 do {
60 if (!CodeCacheExtensions::skip_code_generation()) {
61 // bypass code generation when useless
62 { CodeletMark cm(_masm, "slow signature handler");
63 AbstractInterpreter::_slow_signature_handler = generate_slow_signature_handler();
64 }
65
66 { CodeletMark cm(_masm, "error exits");
67 _unimplemented_bytecode = generate_error_exit("unimplemented bytecode");
68 _illegal_bytecode_sequence = generate_error_exit("illegal bytecode sequence - method not verified");
69 }
70
71 #ifndef PRODUCT
72 if (TraceBytecodes) {
73 CodeletMark cm(_masm, "bytecode tracing support");
74 Interpreter::_trace_code =
75 EntryPoint(
76 generate_trace_code(btos),
77 generate_trace_code(ztos),
78 generate_trace_code(ctos),
79 generate_trace_code(stos),
80 generate_trace_code(atos),
81 generate_trace_code(itos),
82 generate_trace_code(ltos),
83 generate_trace_code(ftos),
84 generate_trace_code(dtos),
85 generate_trace_code(vtos)
86 );
87 }
88 #endif // !PRODUCT
89
90 { CodeletMark cm(_masm, "return entry points");
91 const int index_size = sizeof(u2);
92 for (int i = 0; i < Interpreter::number_of_return_entries; i++) {
93 Interpreter::_return_entry[i] =
94 EntryPoint(
95 generate_return_entry_for(itos, i, index_size),
96 generate_return_entry_for(itos, i, index_size),
97 generate_return_entry_for(itos, i, index_size),
98 generate_return_entry_for(itos, i, index_size),
99 generate_return_entry_for(atos, i, index_size),
100 generate_return_entry_for(itos, i, index_size),
101 generate_return_entry_for(ltos, i, index_size),
102 generate_return_entry_for(ftos, i, index_size),
103 generate_return_entry_for(dtos, i, index_size),
104 generate_return_entry_for(vtos, i, index_size)
105 );
106 }
107 }
108
109 { CodeletMark cm(_masm, "invoke return entry points");
110 // These states are in order specified in TosState, except btos/ztos/ctos/stos are
111 // really the same as itos since there is no top of stack optimization for these types
112 const TosState states[] = {itos, itos, itos, itos, itos, ltos, ftos, dtos, atos, vtos, ilgl};
113 const int invoke_length = Bytecodes::length_for(Bytecodes::_invokestatic);
114 const int invokeinterface_length = Bytecodes::length_for(Bytecodes::_invokeinterface);
115 const int invokedynamic_length = Bytecodes::length_for(Bytecodes::_invokedynamic);
116
117 for (int i = 0; i < Interpreter::number_of_return_addrs; i++) {
118 TosState state = states[i];
119 assert(state != ilgl, "states array is wrong above");
120 Interpreter::_invoke_return_entry[i] = generate_return_entry_for(state, invoke_length, sizeof(u2));
121 Interpreter::_invokeinterface_return_entry[i] = generate_return_entry_for(state, invokeinterface_length, sizeof(u2));
122 Interpreter::_invokedynamic_return_entry[i] = generate_return_entry_for(state, invokedynamic_length, sizeof(u4));
123 }
124 }
125
126 { CodeletMark cm(_masm, "earlyret entry points");
127 Interpreter::_earlyret_entry =
128 EntryPoint(
129 generate_earlyret_entry_for(btos),
130 generate_earlyret_entry_for(ztos),
131 generate_earlyret_entry_for(ctos),
132 generate_earlyret_entry_for(stos),
133 generate_earlyret_entry_for(atos),
134 generate_earlyret_entry_for(itos),
135 generate_earlyret_entry_for(ltos),
136 generate_earlyret_entry_for(ftos),
137 generate_earlyret_entry_for(dtos),
138 generate_earlyret_entry_for(vtos)
139 );
140 }
141
142 { CodeletMark cm(_masm, "deoptimization entry points");
143 for (int i = 0; i < Interpreter::number_of_deopt_entries; i++) {
144 Interpreter::_deopt_entry[i] =
145 EntryPoint(
146 generate_deopt_entry_for(itos, i),
147 generate_deopt_entry_for(itos, i),
148 generate_deopt_entry_for(itos, i),
149 generate_deopt_entry_for(itos, i),
150 generate_deopt_entry_for(atos, i),
151 generate_deopt_entry_for(itos, i),
152 generate_deopt_entry_for(ltos, i),
153 generate_deopt_entry_for(ftos, i),
154 generate_deopt_entry_for(dtos, i),
155 generate_deopt_entry_for(vtos, i)
156 );
157 }
158 }
159
160 { CodeletMark cm(_masm, "result handlers for native calls");
161 // The various result converter stublets.
162 int is_generated[Interpreter::number_of_result_handlers];
163 memset(is_generated, 0, sizeof(is_generated));
164
165 for (int i = 0; i < Interpreter::number_of_result_handlers; i++) {
166 BasicType type = types[i];
167 if (!is_generated[Interpreter::BasicType_as_index(type)]++) {
168 Interpreter::_native_abi_to_tosca[Interpreter::BasicType_as_index(type)] = generate_result_handler_for(type);
169 }
170 }
171 }
172
173 { CodeletMark cm(_masm, "continuation entry points");
174 Interpreter::_continuation_entry =
175 EntryPoint(
176 generate_continuation_for(btos),
177 generate_continuation_for(ztos),
178 generate_continuation_for(ctos),
179 generate_continuation_for(stos),
180 generate_continuation_for(atos),
181 generate_continuation_for(itos),
182 generate_continuation_for(ltos),
183 generate_continuation_for(ftos),
184 generate_continuation_for(dtos),
185 generate_continuation_for(vtos)
186 );
187 }
188
189 { CodeletMark cm(_masm, "safepoint entry points");
190 Interpreter::_safept_entry =
191 EntryPoint(
192 generate_safept_entry_for(btos, CAST_FROM_FN_PTR(address, InterpreterRuntime::at_safepoint)),
193 generate_safept_entry_for(ztos, CAST_FROM_FN_PTR(address, InterpreterRuntime::at_safepoint)),
194 generate_safept_entry_for(ctos, CAST_FROM_FN_PTR(address, InterpreterRuntime::at_safepoint)),
195 generate_safept_entry_for(stos, CAST_FROM_FN_PTR(address, InterpreterRuntime::at_safepoint)),
196 generate_safept_entry_for(atos, CAST_FROM_FN_PTR(address, InterpreterRuntime::at_safepoint)),
197 generate_safept_entry_for(itos, CAST_FROM_FN_PTR(address, InterpreterRuntime::at_safepoint)),
198 generate_safept_entry_for(ltos, CAST_FROM_FN_PTR(address, InterpreterRuntime::at_safepoint)),
199 generate_safept_entry_for(ftos, CAST_FROM_FN_PTR(address, InterpreterRuntime::at_safepoint)),
200 generate_safept_entry_for(dtos, CAST_FROM_FN_PTR(address, InterpreterRuntime::at_safepoint)),
201 generate_safept_entry_for(vtos, CAST_FROM_FN_PTR(address, InterpreterRuntime::at_safepoint))
202 );
203 }
204
205 { CodeletMark cm(_masm, "exception handling");
206 // (Note: this is not safepoint safe because thread may return to compiled code)
207 generate_throw_exception();
208 }
209
210 { CodeletMark cm(_masm, "throw exception entrypoints");
211 Interpreter::_throw_ArrayIndexOutOfBoundsException_entry = generate_ArrayIndexOutOfBounds_handler("java/lang/ArrayIndexOutOfBoundsException");
212 Interpreter::_throw_ArrayStoreException_entry = generate_klass_exception_handler("java/lang/ArrayStoreException" );
213 Interpreter::_throw_ArithmeticException_entry = generate_exception_handler("java/lang/ArithmeticException" , "/ by zero");
214 Interpreter::_throw_ClassCastException_entry = generate_ClassCastException_handler();
215 Interpreter::_throw_NullPointerException_entry = generate_exception_handler("java/lang/NullPointerException" , NULL );
216 Interpreter::_throw_StackOverflowError_entry = generate_StackOverflowError_handler();
217 }
218
219
220
221 #define method_entry(kind) \
222 { CodeletMark cm(_masm, "method entry point (kind = " #kind ")"); \
223 Interpreter::_entry_table[Interpreter::kind] = generate_method_entry(Interpreter::kind); \
224 Interpreter::update_cds_entry_table(Interpreter::kind); \
225 }
226
227 // all non-native method kinds
228 method_entry(zerolocals)
229 method_entry(zerolocals_synchronized)
230 method_entry(empty)
231 method_entry(accessor)
232 method_entry(abstract)
233 method_entry(java_lang_math_sin )
234 method_entry(java_lang_math_cos )
235 method_entry(java_lang_math_tan )
236 method_entry(java_lang_math_abs )
237 method_entry(java_lang_math_sqrt )
238 method_entry(java_lang_math_log )
239 method_entry(java_lang_math_log10)
240 method_entry(java_lang_math_exp )
241 method_entry(java_lang_math_pow )
242 method_entry(java_lang_math_fmaF )
243 method_entry(java_lang_math_fmaD )
244 method_entry(java_lang_ref_reference_get)
245
246 AbstractInterpreter::initialize_method_handle_entries();
247
248 // all native method kinds (must be one contiguous block)
249 Interpreter::_native_entry_begin = Interpreter::code()->code_end();
250 method_entry(native)
251 method_entry(native_synchronized)
252 Interpreter::_native_entry_end = Interpreter::code()->code_end();
253
254 method_entry(java_util_zip_CRC32_update)
255 method_entry(java_util_zip_CRC32_updateBytes)
256 method_entry(java_util_zip_CRC32_updateByteBuffer)
257 method_entry(java_util_zip_CRC32C_updateBytes)
258 method_entry(java_util_zip_CRC32C_updateDirectByteBuffer)
259
260 method_entry(java_lang_Float_intBitsToFloat);
261 method_entry(java_lang_Float_floatToRawIntBits);
262 method_entry(java_lang_Double_longBitsToDouble);
263 method_entry(java_lang_Double_doubleToRawLongBits);
264
265 #undef method_entry
266
267 // Bytecodes
268 set_entry_points_for_all_bytes();
269 }
270 } while (CodeCacheExtensions::needs_other_interpreter_variant());
271
272 // installation of code in other places in the runtime
273 // (ExcutableCodeManager calls not needed to copy the entries)
274 set_safepoints_for_all_bytes();
275 }
276
277 //------------------------------------------------------------------------------------------------------------------------
278
279 address TemplateInterpreterGenerator::generate_error_exit(const char* msg) {
280 address entry = __ pc();
281 __ stop(msg);
282 return entry;
283 }
284
285
286 //------------------------------------------------------------------------------------------------------------------------
287
288 void TemplateInterpreterGenerator::set_entry_points_for_all_bytes() {
289 for (int i = 0; i < DispatchTable::length; i++) {
290 Bytecodes::Code code = (Bytecodes::Code)i;
291 if (Bytecodes::is_defined(code)) {
292 set_entry_points(code);
293 } else {
294 set_unimplemented(i);
295 }
296 }
297 }
298
299
300 void TemplateInterpreterGenerator::set_safepoints_for_all_bytes() {
301 for (int i = 0; i < DispatchTable::length; i++) {
302 Bytecodes::Code code = (Bytecodes::Code)i;
303 if (Bytecodes::is_defined(code)) Interpreter::_safept_table.set_entry(code, Interpreter::_safept_entry);
304 }
305 }
306
307
308 void TemplateInterpreterGenerator::set_unimplemented(int i) {
309 address e = _unimplemented_bytecode;
310 EntryPoint entry(e, e, e, e, e, e, e, e, e, e);
311 Interpreter::_normal_table.set_entry(i, entry);
312 Interpreter::_wentry_point[i] = _unimplemented_bytecode;
313 }
314
315
316 void TemplateInterpreterGenerator::set_entry_points(Bytecodes::Code code) {
317 if (CodeCacheExtensions::skip_template_interpreter_entries(code)) {
318 return;
319 }
320 CodeletMark cm(_masm, Bytecodes::name(code), code);
321 // initialize entry points
322 assert(_unimplemented_bytecode != NULL, "should have been generated before");
323 assert(_illegal_bytecode_sequence != NULL, "should have been generated before");
324 address bep = _illegal_bytecode_sequence;
325 address zep = _illegal_bytecode_sequence;
326 address cep = _illegal_bytecode_sequence;
327 address sep = _illegal_bytecode_sequence;
328 address aep = _illegal_bytecode_sequence;
329 address iep = _illegal_bytecode_sequence;
330 address lep = _illegal_bytecode_sequence;
331 address fep = _illegal_bytecode_sequence;
332 address dep = _illegal_bytecode_sequence;
333 address vep = _unimplemented_bytecode;
334 address wep = _unimplemented_bytecode;
335 // code for short & wide version of bytecode
336 if (Bytecodes::is_defined(code)) {
337 Template* t = TemplateTable::template_for(code);
338 assert(t->is_valid(), "just checking");
339 set_short_entry_points(t, bep, cep, sep, aep, iep, lep, fep, dep, vep);
340 }
341 if (Bytecodes::wide_is_defined(code)) {
342 Template* t = TemplateTable::template_for_wide(code);
343 assert(t->is_valid(), "just checking");
344 set_wide_entry_point(t, wep);
345 }
346 // set entry points
347 EntryPoint entry(bep, zep, cep, sep, aep, iep, lep, fep, dep, vep);
348 Interpreter::_normal_table.set_entry(code, entry);
349 Interpreter::_wentry_point[code] = wep;
350 CodeCacheExtensions::completed_template_interpreter_entries(_masm, code);
351 }
352
353
354 void TemplateInterpreterGenerator::set_wide_entry_point(Template* t, address& wep) {
355 assert(t->is_valid(), "template must exist");
356 assert(t->tos_in() == vtos, "only vtos tos_in supported for wide instructions");
357 wep = __ pc(); generate_and_dispatch(t);
358 }
359
360
361 void TemplateInterpreterGenerator::set_short_entry_points(Template* t, address& bep, address& cep, address& sep, address& aep, address& iep, address& lep, address& fep, address& dep, address& vep) {
362 assert(t->is_valid(), "template must exist");
363 switch (t->tos_in()) {
364 case btos:
365 case ztos:
366 case ctos:
367 case stos:
368 ShouldNotReachHere(); // btos/ctos/stos should use itos.
369 break;
370 case atos: vep = __ pc(); __ pop(atos); aep = __ pc(); generate_and_dispatch(t); break;
371 case itos: vep = __ pc(); __ pop(itos); iep = __ pc(); generate_and_dispatch(t); break;
372 case ltos: vep = __ pc(); __ pop(ltos); lep = __ pc(); generate_and_dispatch(t); break;
373 case ftos: vep = __ pc(); __ pop(ftos); fep = __ pc(); generate_and_dispatch(t); break;
374 case dtos: vep = __ pc(); __ pop(dtos); dep = __ pc(); generate_and_dispatch(t); break;
375 case vtos: set_vtos_entry_points(t, bep, cep, sep, aep, iep, lep, fep, dep, vep); break;
376 default : ShouldNotReachHere(); break;
377 }
378 }
379
380
381 //------------------------------------------------------------------------------------------------------------------------
382
383 void TemplateInterpreterGenerator::generate_and_dispatch(Template* t, TosState tos_out) {
384 if (PrintBytecodeHistogram) histogram_bytecode(t);
385 #ifndef PRODUCT
386 // debugging code
387 if (CountBytecodes || TraceBytecodes || StopInterpreterAt > 0) count_bytecode();
388 if (PrintBytecodePairHistogram) histogram_bytecode_pair(t);
389 if (TraceBytecodes) trace_bytecode(t);
390 if (StopInterpreterAt > 0) stop_interpreter_at();
391 __ verify_FPU(1, t->tos_in());
392 #endif // !PRODUCT
393 int step = 0;
394 if (!t->does_dispatch()) {
395 step = t->is_wide() ? Bytecodes::wide_length_for(t->bytecode()) : Bytecodes::length_for(t->bytecode());
396 if (tos_out == ilgl) tos_out = t->tos_out();
397 // compute bytecode size
398 assert(step > 0, "just checkin'");
399 // setup stuff for dispatching next bytecode
400 if (ProfileInterpreter && VerifyDataPointer
401 && MethodData::bytecode_has_profile(t->bytecode())) {
402 __ verify_method_data_pointer();
403 }
404 __ dispatch_prolog(tos_out, step);
405 }
406 // generate template
407 t->generate(_masm);
408 // advance
409 if (t->does_dispatch()) {
410 #ifdef ASSERT
411 // make sure execution doesn't go beyond this point if code is broken
412 __ should_not_reach_here();
413 #endif // ASSERT
414 } else {
415 // dispatch to next bytecode
416 __ dispatch_epilog(tos_out, step);
417 }
418 }
419
420 // Generate method entries
421 address TemplateInterpreterGenerator::generate_method_entry(
422 AbstractInterpreter::MethodKind kind) {
423 // determine code generation flags
424 bool native = false;
425 bool synchronized = false;
426 address entry_point = NULL;
427
428 switch (kind) {
429 case Interpreter::zerolocals : break;
430 case Interpreter::zerolocals_synchronized: synchronized = true; break;
431 case Interpreter::native : native = true; break;
432 case Interpreter::native_synchronized : native = true; synchronized = true; break;
433 case Interpreter::empty : break;
434 case Interpreter::accessor : break;
435 case Interpreter::abstract : entry_point = generate_abstract_entry(); break;
436
437 case Interpreter::java_lang_math_sin : // fall thru
438 case Interpreter::java_lang_math_cos : // fall thru
439 case Interpreter::java_lang_math_tan : // fall thru
440 case Interpreter::java_lang_math_abs : // fall thru
441 case Interpreter::java_lang_math_log : // fall thru
442 case Interpreter::java_lang_math_log10 : // fall thru
443 case Interpreter::java_lang_math_sqrt : // fall thru
444 case Interpreter::java_lang_math_pow : // fall thru
445 case Interpreter::java_lang_math_exp : // fall thru
446 case Interpreter::java_lang_math_fmaD : // fall thru
447 case Interpreter::java_lang_math_fmaF : entry_point = generate_math_entry(kind); break;
448 case Interpreter::java_lang_ref_reference_get
449 : entry_point = generate_Reference_get_entry(); break;
450 case Interpreter::java_util_zip_CRC32_update
451 : native = true; entry_point = generate_CRC32_update_entry(); break;
452 case Interpreter::java_util_zip_CRC32_updateBytes
453 : // fall thru
454 case Interpreter::java_util_zip_CRC32_updateByteBuffer
455 : native = true; entry_point = generate_CRC32_updateBytes_entry(kind); break;
456 case Interpreter::java_util_zip_CRC32C_updateBytes
457 : // fall thru
458 case Interpreter::java_util_zip_CRC32C_updateDirectByteBuffer
459 : entry_point = generate_CRC32C_updateBytes_entry(kind); break;
460 #ifdef IA32
461 // On x86_32 platforms, a special entry is generated for the following four methods.
462 // On other platforms the normal entry is used to enter these methods.
463 case Interpreter::java_lang_Float_intBitsToFloat
464 : native = true; entry_point = generate_Float_intBitsToFloat_entry(); break;
465 case Interpreter::java_lang_Float_floatToRawIntBits
466 : native = true; entry_point = generate_Float_floatToRawIntBits_entry(); break;
467 case Interpreter::java_lang_Double_longBitsToDouble
468 : native = true; entry_point = generate_Double_longBitsToDouble_entry(); break;
469 case Interpreter::java_lang_Double_doubleToRawLongBits
470 : native = true; entry_point = generate_Double_doubleToRawLongBits_entry(); break;
471 #else
472 case Interpreter::java_lang_Float_intBitsToFloat:
473 case Interpreter::java_lang_Float_floatToRawIntBits:
474 case Interpreter::java_lang_Double_longBitsToDouble:
475 case Interpreter::java_lang_Double_doubleToRawLongBits:
476 native = true;
477 break;
478 #endif // !IA32
479 default:
480 fatal("unexpected method kind: %d", kind);
481 break;
482 }
483
484 if (entry_point) {
485 return entry_point;
486 }
487
488 // We expect the normal and native entry points to be generated first so we can reuse them.
489 if (native) {
490 entry_point = Interpreter::entry_for_kind(synchronized ? Interpreter::native_synchronized : Interpreter::native);
491 if (entry_point == NULL) {
492 entry_point = generate_native_entry(synchronized);
493 }
494 } else {
495 entry_point = Interpreter::entry_for_kind(synchronized ? Interpreter::zerolocals_synchronized : Interpreter::zerolocals);
496 if (entry_point == NULL) {
497 entry_point = generate_normal_entry(synchronized);
498 }
499 }
500
501 return entry_point;
502 }
503 #endif // !CC_INTERP