1 /*
2 * Copyright (c) 2003, 2011, 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 #ifndef CC_INTERP
40 protected:
41
42 protected:
43 using MacroAssembler::call_VM_leaf_base;
44
45 // Interpreter specific version of call_VM_base
46 using MacroAssembler::call_VM_leaf_base;
47
48 virtual void call_VM_leaf_base(address entry_point,
49 int number_of_arguments);
50
51 virtual void call_VM_base(Register oop_result,
52 Register java_thread,
53 Register last_java_sp,
54 address entry_point,
55 int number_of_arguments,
56 bool check_exceptions);
57
58 virtual void check_and_handle_popframe(Register java_thread);
59 virtual void check_and_handle_earlyret(Register java_thread);
60
61 // base routine for all dispatches
62 void dispatch_base(TosState state, address* table, bool verifyoop = true);
63 #endif // CC_INTERP
64
65 public:
66 InterpreterMacroAssembler(CodeBuffer* code) : MacroAssembler(code) {}
67
68 void load_earlyret_value(TosState state);
69
70 void jump_to_entry(address entry);
71
72 #ifdef CC_INTERP
73 void save_bcp() { /* not needed in c++ interpreter and harmless */ }
74 void restore_bcp() { /* not needed in c++ interpreter and harmless */ }
75
76 // Helpers for runtime call arguments/results
77 void get_method(Register reg);
78
79 #else
80
81 // Interpreter-specific registers
82 void save_bcp() {
83 str(rbcp, Address(rfp, frame::interpreter_frame_bcp_offset * wordSize));
84 }
85
86 void restore_bcp() {
87 ldr(rbcp, Address(rfp, frame::interpreter_frame_bcp_offset * wordSize));
88 }
89
90 void restore_locals() {
91 ldr(rlocals, Address(rfp, frame::interpreter_frame_locals_offset * wordSize));
92 }
93
94 void restore_constant_pool_cache() {
95 ldr(rcpool, Address(rfp, frame::interpreter_frame_cache_offset * wordSize));
96 }
97
98 void get_dispatch();
99
100 // Helpers for runtime call arguments/results
101
102 // Helpers for runtime call arguments/results
103 void get_method(Register reg) {
104 ldr(reg, Address(rfp, frame::interpreter_frame_method_offset * wordSize));
105 }
106
107 void get_const(Register reg) {
108 get_method(reg);
109 ldr(reg, Address(reg, in_bytes(Method::const_offset())));
110 }
111
112 void get_constant_pool(Register reg) {
113 get_const(reg);
114 ldr(reg, Address(reg, in_bytes(ConstMethod::constants_offset())));
115 }
116
117 void get_constant_pool_cache(Register reg) {
118 get_constant_pool(reg);
119 ldr(reg, Address(reg, ConstantPool::cache_offset_in_bytes()));
120 }
121
122 void get_cpool_and_tags(Register cpool, Register tags) {
123 get_constant_pool(cpool);
124 ldr(tags, Address(cpool, ConstantPool::tags_offset_in_bytes()));
125 }
126
127 void get_unsigned_2_byte_index_at_bcp(Register reg, int bcp_offset);
128 void get_cache_and_index_at_bcp(Register cache, Register index, int bcp_offset, size_t index_size = sizeof(u2));
129 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));
130 void get_cache_entry_pointer_at_bcp(Register cache, Register tmp, int bcp_offset, size_t index_size = sizeof(u2));
131 void get_cache_index_at_bcp(Register index, int bcp_offset, size_t index_size = sizeof(u2));
132 void get_method_counters(Register method, Register mcs, Label& skip);
133
134 // load cpool->resolved_references(index);
135 void load_resolved_reference_at_index(Register result, Register index);
136
137 void pop_ptr(Register r = r0);
138 void pop_i(Register r = r0);
139 void pop_l(Register r = r0);
140 void pop_f(FloatRegister r = v0);
141 void pop_d(FloatRegister r = v0);
142 void push_ptr(Register r = r0);
143 void push_i(Register r = r0);
144 void push_l(Register r = r0);
145 void push_f(FloatRegister r = v0);
146 void push_d(FloatRegister r = v0);
147
148 void pop(Register r ) { ((MacroAssembler*)this)->pop(r); }
149
150 void push(Register r ) { ((MacroAssembler*)this)->push(r); }
151
152 void pop(TosState state); // transition vtos -> state
153 void push(TosState state); // transition state -> vtos
154
155 void pop(RegSet regs, Register stack) { ((MacroAssembler*)this)->pop(regs, stack); }
156 void push(RegSet regs, Register stack) { ((MacroAssembler*)this)->push(regs, stack); }
157
158 void empty_expression_stack() {
159 ldr(esp, Address(rfp, frame::interpreter_frame_monitor_block_top_offset * wordSize));
160 // NULL last_sp until next java call
161 str(zr, Address(rfp, frame::interpreter_frame_last_sp_offset * wordSize));
162 }
163
164 // Helpers for swap and dup
165 void load_ptr(int n, Register val);
166 void store_ptr(int n, Register val);
167
168 // Generate a subtype check: branch to ok_is_subtype if sub_klass is
169 // a subtype of super_klass.
170 void gen_subtype_check( Register sub_klass, Label &ok_is_subtype );
171
172 // Dispatching
173 void dispatch_prolog(TosState state, int step = 0);
174 void dispatch_epilog(TosState state, int step = 0);
175 // dispatch via rscratch1
176 void dispatch_only(TosState state);
177 // dispatch normal table via rscratch1 (assume rscratch1 is loaded already)
178 void dispatch_only_normal(TosState state);
179 void dispatch_only_noverify(TosState state);
180 // load rscratch1 from [rbcp + step] and dispatch via rscratch1
181 void dispatch_next(TosState state, int step = 0);
182 // load rscratch1 from [esi] and dispatch via rscratch1 and table
183 void dispatch_via (TosState state, address* table);
184
185 // jump to an invoked target
186 void prepare_to_jump_from_interpreted();
187 void jump_from_interpreted(Register method, Register temp);
188
189
190 // Returning from interpreted functions
191 //
192 // Removes the current activation (incl. unlocking of monitors)
193 // and sets up the return address. This code is also used for
194 // exception unwindwing. In that case, we do not want to throw
195 // IllegalMonitorStateExceptions, since that might get us into an
196 // infinite rethrow exception loop.
197 // Additionally this code is used for popFrame and earlyReturn.
198 // In popFrame case we want to skip throwing an exception,
199 // installing an exception, and notifying jvmdi.
200 // In earlyReturn case we only want to skip throwing an exception
201 // and installing an exception.
202 void remove_activation(TosState state,
203 bool throw_monitor_exception = true,
204 bool install_monitor_exception = true,
205 bool notify_jvmdi = true);
206 #endif // CC_INTERP
207
208 // FIXME: Give us a valid frame at a null check.
209 virtual void null_check(Register reg, int offset = -1) {
210 // #ifdef ASSERT
211 // save_bcp();
212 // set_last_Java_frame(esp, rfp, (address) pc());
213 // #endif
214 MacroAssembler::null_check(reg, offset);
215 // #ifdef ASSERT
216 // reset_last_Java_frame(true, false);
217 // #endif
218 }
219
220 // Object locking
221 void lock_object (Register lock_reg);
222 void unlock_object(Register lock_reg);
223
224 #ifndef CC_INTERP
225
226 // Interpreter profiling operations
227 void set_method_data_pointer_for_bcp();
228 void test_method_data_pointer(Register mdp, Label& zero_continue);
229 void verify_method_data_pointer();
230
231 void set_mdp_data_at(Register mdp_in, int constant, Register value);
232 void increment_mdp_data_at(Address data, bool decrement = false);
233 void increment_mdp_data_at(Register mdp_in, int constant,
234 bool decrement = false);
235 void increment_mdp_data_at(Register mdp_in, Register reg, int constant,
236 bool decrement = false);
237 void increment_mask_and_jump(Address counter_addr,
238 int increment, Address mask,
239 Register scratch, Register scratch2,
240 bool preloaded, Condition cond,
241 Label* where);
242 void set_mdp_flag_at(Register mdp_in, int flag_constant);
243 void test_mdp_data_at(Register mdp_in, int offset, Register value,
244 Register test_value_out,
245 Label& not_equal_continue);
246
247 void record_klass_in_profile(Register receiver, Register mdp,
248 Register reg2, bool is_virtual_call);
249 void record_klass_in_profile_helper(Register receiver, Register mdp,
250 Register reg2, int start_row,
251 Label& done, bool is_virtual_call);
252 void record_item_in_profile_helper(Register item, Register mdp,
253 Register reg2, int start_row, Label& done, int total_rows,
254 OffsetFunction item_offset_fn, OffsetFunction item_count_offset_fn,
255 int non_profiled_offset);
256
257 void update_mdp_by_offset(Register mdp_in, int offset_of_offset);
258 void update_mdp_by_offset(Register mdp_in, Register reg, int offset_of_disp);
259 void update_mdp_by_constant(Register mdp_in, int constant);
260 void update_mdp_for_ret(Register return_bci);
261
262 void profile_taken_branch(Register mdp, Register bumped_count);
263 void profile_not_taken_branch(Register mdp);
264 void profile_call(Register mdp);
265 void profile_final_call(Register mdp);
266 void profile_virtual_call(Register receiver, Register mdp,
267 Register scratch2,
268 bool receiver_can_be_null = false);
269 void profile_called_method(Register method, Register mdp, Register reg2) NOT_JVMCI_RETURN;
270 void profile_ret(Register return_bci, Register mdp);
271 void profile_null_seen(Register mdp);
272 void profile_typecheck(Register mdp, Register klass, Register scratch);
273 void profile_typecheck_failed(Register mdp);
274 void profile_switch_default(Register mdp);
275 void profile_switch_case(Register index_in_scratch, Register mdp,
276 Register scratch2);
277
278 void profile_obj_type(Register obj, const Address& mdo_addr);
279 void profile_arguments_type(Register mdp, Register callee, Register tmp, bool is_virtual);
280 void profile_return_type(Register mdp, Register ret, Register tmp);
281 void profile_parameters_type(Register mdp, Register tmp1, Register tmp2);
282
283 // Debugging
284 // only if +VerifyOops && state == atos
285 void verify_oop(Register reg, TosState state = atos);
286 // only if +VerifyFPU && (state == ftos || state == dtos)
287 void verify_FPU(int stack_depth, TosState state = ftos);
288
289 #endif // !CC_INTERP
290
291 typedef enum { NotifyJVMTI, SkipNotifyJVMTI } NotifyMethodExitMode;
292
293 // support for jvmti/dtrace
294 void notify_method_entry();
295 void notify_method_exit(TosState state, NotifyMethodExitMode mode);
296
297 virtual void _call_Unimplemented(address call_site) {
298 save_bcp();
299 set_last_Java_frame(esp, rfp, (address) pc(), rscratch1);
300 MacroAssembler::_call_Unimplemented(call_site);
301 }
302 };
303
304 #endif // CPU_AARCH64_VM_INTERP_MASM_AARCH64_64_HPP