1 /*
2 * Copyright (c) 2003, 2017, Oracle and/or its affiliates. All rights reserved.
3 * Copyright (c) 2014, 2015, Red Hat Inc. All rights reserved.
4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5 *
6 * This code is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License version 2 only, as
8 * published by the Free Software Foundation.
9 *
10 * This code is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * version 2 for more details (a copy is included in the LICENSE file that
14 * accompanied this code).
15 *
16 * You should have received a copy of the GNU General Public License version
17 * 2 along with this work; if not, write to the Free Software Foundation,
18 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
19 *
20 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
21 * or visit www.oracle.com if you need additional information or have any
22 * questions.
23 *
24 */
25
26 #ifndef CPU_AARCH64_VM_INTERP_MASM_AARCH64_64_HPP
27 #define CPU_AARCH64_VM_INTERP_MASM_AARCH64_64_HPP
28
29 #include "asm/macroAssembler.hpp"
30 #include "asm/macroAssembler.inline.hpp"
31 #include "interpreter/invocationCounter.hpp"
32 #include "runtime/frame.hpp"
33
34 // This file specializes the assember with interpreter-specific macros
35
36 typedef ByteSize (*OffsetFunction)(uint);
37
38 class InterpreterMacroAssembler: public MacroAssembler {
39 protected:
40
41 protected:
42 using MacroAssembler::call_VM_leaf_base;
43
44 // Interpreter specific version of call_VM_base
45 using MacroAssembler::call_VM_leaf_base;
46
47 virtual void call_VM_leaf_base(address entry_point,
48 int number_of_arguments);
49
50 virtual void call_VM_base(Register oop_result,
51 Register java_thread,
52 Register last_java_sp,
53 address entry_point,
54 int number_of_arguments,
55 bool check_exceptions);
56
57 // base routine for all dispatches
58 void dispatch_base(TosState state, address* table, bool verifyoop = true);
59
60 public:
61 InterpreterMacroAssembler(CodeBuffer* code) : MacroAssembler(code) {}
62
63 void load_earlyret_value(TosState state);
64
65 void jump_to_entry(address entry);
66
67 virtual void check_and_handle_popframe(Register java_thread);
68 virtual void check_and_handle_earlyret(Register java_thread);
69
70 // Interpreter-specific registers
71 void save_bcp() {
72 str(rbcp, Address(rfp, frame::interpreter_frame_bcp_offset * wordSize));
73 }
74
75 void restore_bcp() {
76 ldr(rbcp, Address(rfp, frame::interpreter_frame_bcp_offset * wordSize));
77 }
78
79 void restore_locals() {
80 ldr(rlocals, Address(rfp, frame::interpreter_frame_locals_offset * wordSize));
81 }
82
83 void restore_constant_pool_cache() {
84 ldr(rcpool, Address(rfp, frame::interpreter_frame_cache_offset * wordSize));
85 }
86
87 void get_dispatch();
88
89 // Helpers for runtime call arguments/results
90
91 // Helpers for runtime call arguments/results
92 void get_method(Register reg) {
93 ldr(reg, Address(rfp, frame::interpreter_frame_method_offset * wordSize));
94 }
95
96 void get_const(Register reg) {
97 get_method(reg);
98 ldr(reg, Address(reg, in_bytes(Method::const_offset())));
99 }
100
101 void get_constant_pool(Register reg) {
102 get_const(reg);
103 ldr(reg, Address(reg, in_bytes(ConstMethod::constants_offset())));
104 }
105
106 void get_constant_pool_cache(Register reg) {
107 get_constant_pool(reg);
108 ldr(reg, Address(reg, ConstantPool::cache_offset_in_bytes()));
109 }
110
111 void get_cpool_and_tags(Register cpool, Register tags) {
112 get_constant_pool(cpool);
113 ldr(tags, Address(cpool, ConstantPool::tags_offset_in_bytes()));
114 }
115
116 void get_unsigned_2_byte_index_at_bcp(Register reg, int bcp_offset);
117 void get_cache_and_index_at_bcp(Register cache, Register index, int bcp_offset, size_t index_size = sizeof(u2));
118 void get_cache_and_index_and_bytecode_at_bcp(Register cache, Register index, Register bytecode, int byte_no, int bcp_offset, size_t index_size = sizeof(u2));
119 void get_cache_entry_pointer_at_bcp(Register cache, Register tmp, int bcp_offset, size_t index_size = sizeof(u2));
120 void get_cache_index_at_bcp(Register index, int bcp_offset, size_t index_size = sizeof(u2));
121 void get_method_counters(Register method, Register mcs, Label& skip);
122
123 // load cpool->resolved_references(index);
124 void load_resolved_reference_at_index(Register result, Register index);
125
126 // load cpool->resolved_klass_at(index);
127 void load_resolved_klass_at_offset(Register cpool, Register index, Register klass, Register temp);
128
129 void pop_ptr(Register r = r0);
130 void pop_i(Register r = r0);
131 void pop_l(Register r = r0);
132 void pop_f(FloatRegister r = v0);
133 void pop_d(FloatRegister r = v0);
134 void push_ptr(Register r = r0);
135 void push_i(Register r = r0);
136 void push_l(Register r = r0);
137 void push_f(FloatRegister r = v0);
138 void push_d(FloatRegister r = v0);
139
140 void pop(Register r ) { ((MacroAssembler*)this)->pop(r); }
141
142 void push(Register r ) { ((MacroAssembler*)this)->push(r); }
143
144 void pop(TosState state); // transition vtos -> state
145 void push(TosState state); // transition state -> vtos
146
147 void pop(RegSet regs, Register stack) { ((MacroAssembler*)this)->pop(regs, stack); }
148 void push(RegSet regs, Register stack) { ((MacroAssembler*)this)->push(regs, stack); }
149
150 void empty_expression_stack() {
151 ldr(esp, Address(rfp, frame::interpreter_frame_monitor_block_top_offset * wordSize));
152 // NULL last_sp until next java call
153 str(zr, Address(rfp, frame::interpreter_frame_last_sp_offset * wordSize));
154 }
155
156 // Helpers for swap and dup
157 void load_ptr(int n, Register val);
158 void store_ptr(int n, Register val);
159
160 // Generate a subtype check: branch to ok_is_subtype if sub_klass is
161 // a subtype of super_klass.
162 void gen_subtype_check( Register sub_klass, Label &ok_is_subtype );
163
164 // Dispatching
165 void dispatch_prolog(TosState state, int step = 0);
166 void dispatch_epilog(TosState state, int step = 0);
167 // dispatch via rscratch1
168 void dispatch_only(TosState state);
169 // dispatch normal table via rscratch1 (assume rscratch1 is loaded already)
170 void dispatch_only_normal(TosState state);
171 void dispatch_only_noverify(TosState state);
172 // load rscratch1 from [rbcp + step] and dispatch via rscratch1
173 void dispatch_next(TosState state, int step = 0);
174 // load rscratch1 from [esi] and dispatch via rscratch1 and table
175 void dispatch_via (TosState state, address* table);
176
177 // jump to an invoked target
178 void prepare_to_jump_from_interpreted();
179 void jump_from_interpreted(Register method, Register temp);
180
181
182 // Returning from interpreted functions
183 //
184 // Removes the current activation (incl. unlocking of monitors)
185 // and sets up the return address. This code is also used for
186 // exception unwindwing. In that case, we do not want to throw
187 // IllegalMonitorStateExceptions, since that might get us into an
188 // infinite rethrow exception loop.
189 // Additionally this code is used for popFrame and earlyReturn.
190 // In popFrame case we want to skip throwing an exception,
191 // installing an exception, and notifying jvmdi.
192 // In earlyReturn case we only want to skip throwing an exception
193 // and installing an exception.
194 void remove_activation(TosState state,
195 bool throw_monitor_exception = true,
196 bool install_monitor_exception = true,
197 bool notify_jvmdi = true);
198
199 // FIXME: Give us a valid frame at a null check.
200 virtual void null_check(Register reg, int offset = -1) {
201 // #ifdef ASSERT
202 // save_bcp();
203 // set_last_Java_frame(esp, rfp, (address) pc());
204 // #endif
205 MacroAssembler::null_check(reg, offset);
206 // #ifdef ASSERT
207 // reset_last_Java_frame(true);
208 // #endif
209 }
210
211 // Object locking
212 void lock_object (Register lock_reg);
213 void unlock_object(Register lock_reg);
214
215 // Interpreter profiling operations
216 void set_method_data_pointer_for_bcp();
217 void test_method_data_pointer(Register mdp, Label& zero_continue);
218 void verify_method_data_pointer();
219
220 void set_mdp_data_at(Register mdp_in, int constant, Register value);
221 void increment_mdp_data_at(Address data, bool decrement = false);
222 void increment_mdp_data_at(Register mdp_in, int constant,
223 bool decrement = false);
224 void increment_mdp_data_at(Register mdp_in, Register reg, int constant,
225 bool decrement = false);
226 void increment_mask_and_jump(Address counter_addr,
227 int increment, Address mask,
228 Register scratch, Register scratch2,
229 bool preloaded, Condition cond,
230 Label* where);
231 void set_mdp_flag_at(Register mdp_in, int flag_constant);
232 void test_mdp_data_at(Register mdp_in, int offset, Register value,
233 Register test_value_out,
234 Label& not_equal_continue);
235
236 void record_klass_in_profile(Register receiver, Register mdp,
237 Register reg2, bool is_virtual_call);
238 void record_klass_in_profile_helper(Register receiver, Register mdp,
239 Register reg2, int start_row,
240 Label& done, bool is_virtual_call);
241 void record_item_in_profile_helper(Register item, Register mdp,
242 Register reg2, int start_row, Label& done, int total_rows,
243 OffsetFunction item_offset_fn, OffsetFunction item_count_offset_fn,
244 int non_profiled_offset);
245
246 void update_mdp_by_offset(Register mdp_in, int offset_of_offset);
247 void update_mdp_by_offset(Register mdp_in, Register reg, int offset_of_disp);
248 void update_mdp_by_constant(Register mdp_in, int constant);
249 void update_mdp_for_ret(Register return_bci);
250
251 // narrow int return value
252 void narrow(Register result);
253
254 void profile_taken_branch(Register mdp, Register bumped_count);
255 void profile_not_taken_branch(Register mdp);
256 void profile_call(Register mdp);
257 void profile_final_call(Register mdp);
258 void profile_virtual_call(Register receiver, Register mdp,
259 Register scratch2,
260 bool receiver_can_be_null = false);
261 void profile_called_method(Register method, Register mdp, Register reg2) NOT_JVMCI_RETURN;
262 void profile_ret(Register return_bci, Register mdp);
263 void profile_null_seen(Register mdp);
264 void profile_typecheck(Register mdp, Register klass, Register scratch);
265 void profile_typecheck_failed(Register mdp);
266 void profile_switch_default(Register mdp);
267 void profile_switch_case(Register index_in_scratch, Register mdp,
268 Register scratch2);
269
270 void profile_obj_type(Register obj, const Address& mdo_addr);
271 void profile_arguments_type(Register mdp, Register callee, Register tmp, bool is_virtual);
272 void profile_return_type(Register mdp, Register ret, Register tmp);
273 void profile_parameters_type(Register mdp, Register tmp1, Register tmp2);
274
275 // Debugging
276 // only if +VerifyOops && state == atos
277 void verify_oop(Register reg, TosState state = atos);
278 // only if +VerifyFPU && (state == ftos || state == dtos)
279 void verify_FPU(int stack_depth, TosState state = ftos);
280
281 typedef enum { NotifyJVMTI, SkipNotifyJVMTI } NotifyMethodExitMode;
282
283 // support for jvmti/dtrace
284 void notify_method_entry();
285 void notify_method_exit(TosState state, NotifyMethodExitMode mode);
286
287 virtual void _call_Unimplemented(address call_site) {
288 save_bcp();
289 set_last_Java_frame(esp, rfp, (address) pc(), rscratch1);
290 MacroAssembler::_call_Unimplemented(call_site);
291 }
292 };
293
294 #endif // CPU_AARCH64_VM_INTERP_MASM_AARCH64_64_HPP