1 /*
2 * Copyright (c) 2002, 2013, Oracle and/or its affiliates. All rights reserved.
3 * Copyright 2012, 2014 SAP AG. 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_PPC_VM_INTERP_MASM_PPC_64_HPP
27 #define CPU_PPC_VM_INTERP_MASM_PPC_64_HPP
28
29 #include "asm/macroAssembler.hpp"
30 #include "interpreter/invocationCounter.hpp"
31
32 // This file specializes the assembler with interpreter-specific macros.
33
34
35 class InterpreterMacroAssembler: public MacroAssembler {
36
37 public:
38 InterpreterMacroAssembler(CodeBuffer* code) : MacroAssembler(code) {}
39
40 void null_check_throw(Register a, int offset, Register temp_reg);
41
42 void branch_to_entry(address entry, Register Rscratch);
43
44 // Handy address generation macros.
45 #define thread_(field_name) in_bytes(JavaThread::field_name ## _offset()), R16_thread
46 #define method_(field_name) in_bytes(Method::field_name ## _offset()), R19_method
47
48 #ifdef CC_INTERP
49 #define state_(field_name) in_bytes(byte_offset_of(BytecodeInterpreter, field_name)), R14_state
50 #define prev_state_(field_name) in_bytes(byte_offset_of(BytecodeInterpreter, field_name)), R15_prev_state
51 void pop (TosState state) {}; // Not needed.
52 void push(TosState state) {}; // Not needed.
53 #endif
54
55 #ifndef CC_INTERP
56 virtual void check_and_handle_popframe(Register java_thread);
57 virtual void check_and_handle_earlyret(Register java_thread);
58
59 // Base routine for all dispatches.
60 void dispatch_base(TosState state, address* table);
61
62 void load_earlyret_value(TosState state, Register Rscratch1);
63
64 static const Address l_tmp;
65 static const Address d_tmp;
66
67 // dispatch routines
68 void dispatch_next(TosState state, int step = 0);
69 void dispatch_via (TosState state, address* table);
70 void load_dispatch_table(Register dst, address* table);
71 void dispatch_Lbyte_code(TosState state, Register bytecode, address* table, bool verify = false);
72
73 // Called by shared interpreter generator.
74 void dispatch_prolog(TosState state, int step = 0);
75 void dispatch_epilog(TosState state, int step = 0);
76
77 // Super call_VM calls - correspond to MacroAssembler::call_VM(_leaf) calls.
78 void super_call_VM_leaf(Register thread_cache, address entry_point, Register arg_1);
79 void super_call_VM(Register thread_cache, Register oop_result, Register last_java_sp,
80 address entry_point, Register arg_1, Register arg_2, bool check_exception = true);
81
82 // Generate a subtype check: branch to ok_is_subtype if sub_klass is
83 // a subtype of super_klass. Blows registers tmp1, tmp2 and tmp3.
84 void gen_subtype_check(Register sub_klass, Register super_klass,
85 Register tmp1, Register tmp2, Register tmp3, Label &ok_is_subtype);
86
87 // Load object from cpool->resolved_references(index).
88 void load_resolved_reference_at_index(Register result, Register index);
89
90 void generate_stack_overflow_check_with_compare_and_throw(Register Rmem_frame_size, Register Rscratch1);
91 void load_receiver(Register Rparam_count, Register Rrecv_dst);
92
93 // helpers for expression stack
94 void pop_i( Register r = R17_tos);
95 void pop_ptr( Register r = R17_tos);
96 void pop_l( Register r = R17_tos);
97 void pop_f(FloatRegister f = F15_ftos);
98 void pop_d(FloatRegister f = F15_ftos );
99
100 void push_i( Register r = R17_tos);
101 void push_ptr( Register r = R17_tos);
102 void push_l( Register r = R17_tos);
103 void push_f(FloatRegister f = F15_ftos );
104 void push_d(FloatRegister f = F15_ftos);
105
106 void push_2ptrs(Register first, Register second);
107
108 void push_l_pop_d(Register l = R17_tos, FloatRegister d = F15_ftos);
109 void push_d_pop_l(FloatRegister d = F15_ftos, Register l = R17_tos);
110
111 void pop (TosState state); // transition vtos -> state
112 void push(TosState state); // transition state -> vtos
113 void empty_expression_stack(); // Resets both Lesp and SP.
114
115 public:
116 // Load values from bytecode stream:
117
118 enum signedOrNot { Signed, Unsigned };
119 enum setCCOrNot { set_CC, dont_set_CC };
120
121 void get_2_byte_integer_at_bcp(int bcp_offset,
122 Register Rdst,
123 signedOrNot is_signed);
124
125 void get_4_byte_integer_at_bcp(int bcp_offset,
126 Register Rdst,
127 signedOrNot is_signed = Unsigned);
128
129 void get_cache_index_at_bcp(Register Rdst, int bcp_offset, size_t index_size);
130
131 void get_cache_and_index_at_bcp(Register cache, int bcp_offset, size_t index_size = sizeof(u2));
132
133 void get_u4(Register Rdst, Register Rsrc, int offset, signedOrNot is_signed);
134
135 // common code
136
137 void field_offset_at(int n, Register tmp, Register dest, Register base);
138 int field_offset_at(Register object, address bcp, int offset);
139 void fast_iaaccess(int n, address bcp);
140 void fast_iagetfield(address bcp);
141 void fast_iaputfield(address bcp, bool do_store_check);
142
143 void index_check(Register array, Register index, int index_shift, Register tmp, Register res);
144 void index_check_without_pop(Register array, Register index, int index_shift, Register tmp, Register res);
145
146 void get_const(Register Rdst);
147 void get_constant_pool(Register Rdst);
148 void get_constant_pool_cache(Register Rdst);
149 void get_cpool_and_tags(Register Rcpool, Register Rtags);
150 void is_a(Label& L);
151
152 // Java Call Helpers
153 void call_from_interpreter(Register Rtarget_method, Register Rret_addr, Register Rscratch1, Register Rscratch2);
154
155 // --------------------------------------------------
156
157 void unlock_if_synchronized_method(TosState state, bool throw_monitor_exception = true,
158 bool install_monitor_exception = true);
159
160 // Removes the current activation (incl. unlocking of monitors).
161 // Additionally this code is used for earlyReturn in which case we
162 // want to skip throwing an exception and installing an exception.
163 void remove_activation(TosState state,
164 bool throw_monitor_exception = true,
165 bool install_monitor_exception = true);
166 void merge_frames(Register Rtop_frame_sp, Register return_pc, Register Rscratch1, Register Rscratch2); // merge top frames
167
168 void add_monitor_to_stack(bool stack_is_empty, Register Rtemp1, Register Rtemp2);
169
170 // Local variable access helpers
171 void load_local_int(Register Rdst_value, Register Rdst_address, Register Rindex);
172 void load_local_long(Register Rdst_value, Register Rdst_address, Register Rindex);
173 void load_local_ptr(Register Rdst_value, Register Rdst_address, Register Rindex);
174 void load_local_float(FloatRegister Rdst_value, Register Rdst_address, Register Rindex);
175 void load_local_double(FloatRegister Rdst_value, Register Rdst_address, Register Rindex);
176 void store_local_int(Register Rvalue, Register Rindex);
177 void store_local_long(Register Rvalue, Register Rindex);
178 void store_local_ptr(Register Rvalue, Register Rindex);
179 void store_local_float(FloatRegister Rvalue, Register Rindex);
180 void store_local_double(FloatRegister Rvalue, Register Rindex);
181
182 // Call VM for std frames
183 // Special call VM versions that check for exceptions and forward exception
184 // via short cut (not via expensive forward exception stub).
185 void check_and_forward_exception(Register Rscratch1, Register Rscratch2);
186 void call_VM(Register oop_result, address entry_point, bool check_exceptions = true);
187 void call_VM(Register oop_result, address entry_point, Register arg_1, bool check_exceptions = true);
188 void call_VM(Register oop_result, address entry_point, Register arg_1, Register arg_2, bool check_exceptions = true);
189 void call_VM(Register oop_result, address entry_point, Register arg_1, Register arg_2, Register arg_3, bool check_exceptions = true);
190 // Should not be used:
191 void call_VM(Register oop_result, Register last_java_sp, address entry_point, bool check_exceptions = true) {ShouldNotReachHere();}
192 void call_VM(Register oop_result, Register last_java_sp, address entry_point, Register arg_1, bool check_exceptions = true) {ShouldNotReachHere();}
193 void call_VM(Register oop_result, Register last_java_sp, address entry_point, Register arg_1, Register arg_2, bool check_exceptions = true) {ShouldNotReachHere();}
194 void call_VM(Register oop_result, Register last_java_sp, address entry_point, Register arg_1, Register arg_2, Register arg_3, bool check_exceptions = true) {ShouldNotReachHere();}
195
196 Address first_local_in_stack();
197
198 enum LoadOrStore { load, store };
199 void static_iload_or_store(int which_local, LoadOrStore direction, Register Rtmp);
200 void static_aload_or_store(int which_local, LoadOrStore direction, Register Rtmp);
201 void static_dload_or_store(int which_local, LoadOrStore direction);
202
203 void save_interpreter_state(Register scratch);
204 void restore_interpreter_state(Register scratch, bool bcp_and_mdx_only = false);
205
206 void increment_backedge_counter(const Register Rcounters, Register Rtmp, Register Rtmp2, Register Rscratch);
207 void test_backedge_count_for_osr(Register backedge_count, Register branch_bcp, Register Rtmp);
208
209 void record_static_call_in_profile(Register Rentry, Register Rtmp);
210 void record_receiver_call_in_profile(Register Rklass, Register Rentry, Register Rtmp);
211 #endif // !CC_INTERP
212
213 void get_method_counters(Register method, Register Rcounters, Label& skip);
214 void increment_invocation_counter(Register iv_be_count, Register Rtmp1, Register Rtmp2_r0);
215
216 // Object locking
217 void lock_object (Register lock_reg, Register obj_reg);
218 void unlock_object(Register lock_reg, bool check_for_exceptions = true);
219
220 #ifndef CC_INTERP
221
222 // Interpreter profiling operations
223 void set_method_data_pointer_for_bcp();
224 void test_method_data_pointer(Label& zero_continue);
225 void verify_method_data_pointer();
226 void test_invocation_counter_for_mdp(Register invocation_count, Register Rscratch, Label &profile_continue);
227
228 void set_mdp_data_at(int constant, Register value);
229
230 void increment_mdp_data_at(int constant, Register counter_addr, Register Rbumped_count, bool decrement = false);
231
232 void increment_mdp_data_at(Register counter_addr, Register Rbumped_count, bool decrement = false);
233 void increment_mdp_data_at(Register reg, int constant, Register scratch, Register Rbumped_count, bool decrement = false);
234
235 void set_mdp_flag_at(int flag_constant, Register scratch);
236 void test_mdp_data_at(int offset, Register value, Label& not_equal_continue, Register test_out);
237
238 void update_mdp_by_offset(int offset_of_disp, Register scratch);
239 void update_mdp_by_offset(Register reg, int offset_of_disp,
240 Register scratch);
241 void update_mdp_by_constant(int constant);
242 void update_mdp_for_ret(TosState state, Register return_bci);
243
244 void profile_taken_branch(Register scratch, Register bumped_count);
245 void profile_not_taken_branch(Register scratch1, Register scratch2);
246 void profile_call(Register scratch1, Register scratch2);
247 void profile_final_call(Register scratch1, Register scratch2);
248 void profile_virtual_call(Register Rreceiver, Register Rscratch1, Register Rscratch2, bool receiver_can_be_null);
249 void profile_typecheck(Register Rklass, Register Rscratch1, Register Rscratch2);
250 void profile_typecheck_failed(Register Rscratch1, Register Rscratch2);
251 void profile_ret(TosState state, Register return_bci, Register scratch1, Register scratch2);
252 void profile_switch_default(Register scratch1, Register scratch2);
253 void profile_switch_case(Register index, Register scratch1,Register scratch2, Register scratch3);
254 void profile_null_seen(Register Rscratch1, Register Rscratch2);
255 void record_klass_in_profile(Register receiver, Register scratch1, Register scratch2, bool is_virtual_call);
256 void record_klass_in_profile_helper(Register receiver, Register scratch1, Register scratch2, int start_row, Label& done, bool is_virtual_call);
257
258 #endif // !CC_INTERP
259
260 // Debugging
261 void verify_oop(Register reg, TosState state = atos); // only if +VerifyOops && state == atos
262 #ifndef CC_INTERP
263 void verify_oop_or_return_address(Register reg, Register rtmp); // for astore
264 void verify_FPU(int stack_depth, TosState state = ftos);
265 #endif // !CC_INTERP
266
267 typedef enum { NotifyJVMTI, SkipNotifyJVMTI } NotifyMethodExitMode;
268
269 // Support for jvmdi/jvmpi.
270 void notify_method_entry();
271 void notify_method_exit(bool is_native_method, TosState state,
272 NotifyMethodExitMode mode, bool check_exceptions);
273
274 #ifdef CC_INTERP
275 // Convert the current TOP_IJAVA_FRAME into a PARENT_IJAVA_FRAME
276 // (using parent_frame_resize) and push a new interpreter
277 // TOP_IJAVA_FRAME (using frame_size).
278 void push_interpreter_frame(Register top_frame_size, Register parent_frame_resize,
279 Register tmp1, Register tmp2, Register tmp3, Register tmp4, Register pc=noreg);
280
281 // Pop the topmost TOP_IJAVA_FRAME and convert the previous
282 // PARENT_IJAVA_FRAME back into a TOP_IJAVA_FRAME.
283 void pop_interpreter_frame(Register tmp1, Register tmp2, Register tmp3, Register tmp4);
284
285 // Turn state's interpreter frame into the current TOP_IJAVA_FRAME.
286 void pop_interpreter_frame_to_state(Register state, Register tmp1, Register tmp2, Register tmp3);
287
288 // Set SP to initial caller's sp, but before fix the back chain.
289 void resize_frame_to_initial_caller(Register tmp1, Register tmp2);
290
291 // Pop the current interpreter state (without popping the
292 // correspoding frame) and restore R14_state and R15_prev_state
293 // accordingly. Use prev_state_may_be_0 to indicate whether
294 // prev_state may be 0 in order to generate an extra check before
295 // retrieving prev_state_(_prev_link).
296 void pop_interpreter_state(bool prev_state_may_be_0);
297
298 void restore_prev_state();
299 #endif
300 };
301
302 #endif // CPU_PPC_VM_INTERP_MASM_PPC_64_HPP