1 /*
2 * Copyright (c) 1997, 2024, 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 #ifndef SHARE_INTERPRETER_TEMPLATEINTERPRETERGENERATOR_HPP
26 #define SHARE_INTERPRETER_TEMPLATEINTERPRETERGENERATOR_HPP
27
28 // This file contains the platform-independent parts
29 // of the template interpreter generator.
30
31 #ifndef ZERO
32
33 class TemplateInterpreterGenerator: public AbstractInterpreterGenerator {
34 protected:
35
36 // entry points for shared code sequence
37 address _unimplemented_bytecode;
38 address _illegal_bytecode_sequence;
39
40 // shared code sequences
41 // Converter for native abi result to tosca result
42 address generate_result_handler_for(BasicType type);
43 address generate_slow_signature_handler();
44 address generate_error_exit(const char* msg);
45 address generate_StackOverflowError_handler();
46 address generate_exception_handler(const char* name, const char* message) {
47 return generate_exception_handler_common(name, message, false);
48 }
49 address generate_klass_exception_handler(const char* name) {
50 return generate_exception_handler_common(name, nullptr, true);
51 }
52 address generate_exception_handler_common(const char* name, const char* message, bool pass_oop);
53 address generate_ClassCastException_handler();
54 address generate_ArrayIndexOutOfBounds_handler();
55 address generate_return_entry_for(TosState state, int step, size_t index_size);
56 address generate_earlyret_entry_for(TosState state);
57 address generate_deopt_entry_for(TosState state, int step, address continuation = nullptr);
58 address generate_safept_entry_for(TosState state, address runtime_entry);
59 address generate_cont_resume_interpreter_adapter();
60 void generate_throw_exception();
61
62 void lock_method();
63
64 void bang_stack_shadow_pages(bool native_call);
65
66 // Instruction generation
67 void generate_and_dispatch (Template* t, TosState tos_out = ilgl);
68 void set_vtos_entry_points (Template* t, address& bep, address& cep, address& sep, address& aep, address& iep, address& lep, address& fep, address& dep, address& vep);
69 void set_short_entry_points(Template* t, address& bep, address& cep, address& sep, address& aep, address& iep, address& lep, address& fep, address& dep, address& vep);
70 void set_wide_entry_point (Template* t, address& wep);
71
72 void set_entry_points(Bytecodes::Code code);
73 void set_unimplemented(int i);
74 void set_entry_points_for_all_bytes();
75 void set_safepoints_for_all_bytes();
76
77 // Helpers for generate_and_dispatch
78 address generate_trace_code(TosState state) PRODUCT_RETURN_NULL;
79 void count_bytecode();
80 void histogram_bytecode(Template* t);
81 void histogram_bytecode_pair(Template* t) PRODUCT_RETURN;
82 void trace_bytecode(Template* t) PRODUCT_RETURN;
83 void stop_interpreter_at() PRODUCT_RETURN;
84
85 void generate_all();
86
87 // helpers for method entry generation
88 bool is_synchronized_method(AbstractInterpreter::MethodKind kind);
89 bool is_runtime_upcalls_method(AbstractInterpreter::MethodKind kind);
90 bool is_intrinsic_method(AbstractInterpreter::MethodKind kind);
91 bool is_abstract_method(AbstractInterpreter::MethodKind kind);
92
93 // entry point generator
94 address generate_method_entry(AbstractInterpreter::MethodKind kind, bool native);
95
96 // generate intrinsic method entries
97 address generate_intrinsic_entry(AbstractInterpreter::MethodKind kind);
98
99 address generate_normal_entry(bool synchronized, bool runtime_upcalls);
100 address generate_native_entry(bool synchronized, bool runtime_upcalls);
101 address generate_abstract_entry(void);
102 address generate_math_entry(AbstractInterpreter::MethodKind kind);
103 address generate_Reference_get_entry();
104 address generate_CRC32_update_entry();
105 address generate_CRC32_updateBytes_entry(AbstractInterpreter::MethodKind kind);
106 address generate_CRC32C_updateBytes_entry(AbstractInterpreter::MethodKind kind);
107 address generate_currentThread();
108 address generate_Float_intBitsToFloat_entry();
109 address generate_Float_floatToRawIntBits_entry();
110 address generate_Double_longBitsToDouble_entry();
111 address generate_Double_doubleToRawLongBits_entry();
112 address generate_Float_float16ToFloat_entry();
113 address generate_Float_floatToFloat16_entry();
114
115 // Some platforms don't need registers, other need two. Unused function is
116 // left unimplemented.
117 void generate_stack_overflow_check(void);
118 void generate_stack_overflow_check(Register Rframe_size, Register Rscratch);
119
120 void generate_counter_incr(Label* overflow);
121 void generate_counter_overflow(Label& continue_entry);
122
123 void generate_fixed_frame(bool native_call);
124
125 #ifdef AARCH64
126 void generate_transcendental_entry(AbstractInterpreter::MethodKind kind, int fpargs);
127 #endif // AARCH64
128
129 #ifdef ARM32
130 void generate_math_runtime_call(AbstractInterpreter::MethodKind kind);
131 #endif // ARM32
132
133 #ifdef PPC
134 void lock_method(Register Rflags, Register Rscratch1, Register Rscratch2, bool flags_preloaded=false);
135 void generate_fixed_frame(bool native_call, Register Rsize_of_parameters, Register Rsize_of_locals);
136 #endif // PPC
137
138 public:
139 TemplateInterpreterGenerator();
140 };
141
142 #endif // !ZERO
143
144 #endif // SHARE_INTERPRETER_TEMPLATEINTERPRETERGENERATOR_HPP