1 /*
2 * Copyright (c) 2002, 2015, Oracle and/or its affiliates. All rights reserved.
3 * Copyright (c) 2012, 2015 SAP SE. 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 jump_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 virtual void check_and_handle_popframe(Register java_thread);
49 virtual void check_and_handle_earlyret(Register java_thread);
50
51 // Base routine for all dispatches.
52 void dispatch_base(TosState state, address* table);
53
54 void load_earlyret_value(TosState state, Register Rscratch1);
55
56 static const Address l_tmp;
57 static const Address d_tmp;
58
59 // dispatch routines
60 void dispatch_next(TosState state, int step = 0);
61 void dispatch_via (TosState state, address* table);
62 void load_dispatch_table(Register dst, address* table);
63 void dispatch_Lbyte_code(TosState state, Register bytecode, address* table, bool verify = false);
64
65 // Called by shared interpreter generator.
66 void dispatch_prolog(TosState state, int step = 0);
67 void dispatch_epilog(TosState state, int step = 0);
68
69 // Super call_VM calls - correspond to MacroAssembler::call_VM(_leaf) calls.
70 void super_call_VM_leaf(Register thread_cache, address entry_point, Register arg_1);
71 void super_call_VM(Register thread_cache, Register oop_result, Register last_java_sp,
72 address entry_point, Register arg_1, Register arg_2, bool check_exception = true);
73
74 // Generate a subtype check: branch to ok_is_subtype if sub_klass is
75 // a subtype of super_klass. Blows registers tmp1, tmp2 and tmp3.
76 void gen_subtype_check(Register sub_klass, Register super_klass,
77 Register tmp1, Register tmp2, Register tmp3, Label &ok_is_subtype);
78
79 // Load object from cpool->resolved_references(index).
80 void load_resolved_reference_at_index(Register result, Register index, Label *is_null = NULL);
81
82 void generate_stack_overflow_check_with_compare_and_throw(Register Rmem_frame_size, Register Rscratch1);
83 void load_receiver(Register Rparam_count, Register Rrecv_dst);
84
85 // helpers for expression stack
86 void pop_i( Register r = R17_tos);
87 void pop_ptr( Register r = R17_tos);
88 void pop_l( Register r = R17_tos);
89 void pop_f(FloatRegister f = F15_ftos);
90 void pop_d(FloatRegister f = F15_ftos );
91
92 void push_i( Register r = R17_tos);
93 void push_ptr( Register r = R17_tos);
94 void push_l( Register r = R17_tos);
95 void push_f(FloatRegister f = F15_ftos );
96 void push_d(FloatRegister f = F15_ftos);
97
98 void push_2ptrs(Register first, Register second);
99
100 void push_l_pop_d(Register l = R17_tos, FloatRegister d = F15_ftos);
101 void push_d_pop_l(FloatRegister d = F15_ftos, Register l = R17_tos);
102
103 void pop (TosState state); // transition vtos -> state
104 void push(TosState state); // transition state -> vtos
105 void empty_expression_stack(); // Resets both Lesp and SP.
106
107 public:
108 // Load values from bytecode stream:
109
110 enum signedOrNot { Signed, Unsigned };
111 enum setCCOrNot { set_CC, dont_set_CC };
112
113 void get_2_byte_integer_at_bcp(int bcp_offset,
114 Register Rdst,
115 signedOrNot is_signed);
116
117 void get_4_byte_integer_at_bcp(int bcp_offset,
118 Register Rdst,
119 signedOrNot is_signed = Unsigned);
120
121 void get_cache_index_at_bcp(Register Rdst, int bcp_offset, size_t index_size);
122
123 void get_cache_and_index_at_bcp(Register cache, int bcp_offset, size_t index_size = sizeof(u2));
124
125 void get_u4(Register Rdst, Register Rsrc, int offset, signedOrNot is_signed);
126
127 // common code
128
129 void field_offset_at(int n, Register tmp, Register dest, Register base);
130 int field_offset_at(Register object, address bcp, int offset);
131 void fast_iaaccess(int n, address bcp);
132 void fast_iaputfield(address bcp, bool do_store_check);
133
134 void index_check(Register array, Register index, int index_shift, Register tmp, Register res);
135 void index_check_without_pop(Register array, Register index, int index_shift, Register tmp, Register res);
136
137 void get_const(Register Rdst);
138 void get_constant_pool(Register Rdst);
139 void get_constant_pool_cache(Register Rdst);
140 void get_cpool_and_tags(Register Rcpool, Register Rtags);
141 void is_a(Label& L);
142
143 // Java Call Helpers
144 void call_from_interpreter(Register Rtarget_method, Register Rret_addr, Register Rscratch1, Register Rscratch2);
145
146 // --------------------------------------------------
147
148 void unlock_if_synchronized_method(TosState state, bool throw_monitor_exception = true,
149 bool install_monitor_exception = true);
150
151 // Removes the current activation (incl. unlocking of monitors).
152 // Additionally this code is used for earlyReturn in which case we
153 // want to skip throwing an exception and installing an exception.
154 void remove_activation(TosState state,
155 bool throw_monitor_exception = true,
156 bool install_monitor_exception = true);
157 void merge_frames(Register Rtop_frame_sp, Register return_pc, Register Rscratch1, Register Rscratch2); // merge top frames
158
159 void add_monitor_to_stack(bool stack_is_empty, Register Rtemp1, Register Rtemp2);
160
161 // Local variable access helpers
162 void load_local_int(Register Rdst_value, Register Rdst_address, Register Rindex);
163 void load_local_long(Register Rdst_value, Register Rdst_address, Register Rindex);
164 void load_local_ptr(Register Rdst_value, Register Rdst_address, Register Rindex);
165 void load_local_float(FloatRegister Rdst_value, Register Rdst_address, Register Rindex);
166 void load_local_double(FloatRegister Rdst_value, Register Rdst_address, Register Rindex);
167 void store_local_int(Register Rvalue, Register Rindex);
168 void store_local_long(Register Rvalue, Register Rindex);
169 void store_local_ptr(Register Rvalue, Register Rindex);
170 void store_local_float(FloatRegister Rvalue, Register Rindex);
171 void store_local_double(FloatRegister Rvalue, Register Rindex);
172
173 // Call VM for std frames
174 // Special call VM versions that check for exceptions and forward exception
175 // via short cut (not via expensive forward exception stub).
176 void check_and_forward_exception(Register Rscratch1, Register Rscratch2);
177 void call_VM(Register oop_result, address entry_point, bool check_exceptions = true);
178 void call_VM(Register oop_result, address entry_point, Register arg_1, bool check_exceptions = true);
179 void call_VM(Register oop_result, address entry_point, Register arg_1, Register arg_2, bool check_exceptions = true);
180 void call_VM(Register oop_result, address entry_point, Register arg_1, Register arg_2, Register arg_3, bool check_exceptions = true);
181 // Should not be used:
182 void call_VM(Register oop_result, Register last_java_sp, address entry_point, bool check_exceptions = true) {ShouldNotReachHere();}
183 void call_VM(Register oop_result, Register last_java_sp, address entry_point, Register arg_1, bool check_exceptions = true) {ShouldNotReachHere();}
184 void call_VM(Register oop_result, Register last_java_sp, address entry_point, Register arg_1, Register arg_2, bool check_exceptions = true) {ShouldNotReachHere();}
185 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();}
186
187 Address first_local_in_stack();
188
189 enum LoadOrStore { load, store };
190 void static_iload_or_store(int which_local, LoadOrStore direction, Register Rtmp);
191 void static_aload_or_store(int which_local, LoadOrStore direction, Register Rtmp);
192 void static_dload_or_store(int which_local, LoadOrStore direction);
193
194 void save_interpreter_state(Register scratch);
195 void restore_interpreter_state(Register scratch, bool bcp_and_mdx_only = false);
196
197 void increment_backedge_counter(const Register Rcounters, Register Rtmp, Register Rtmp2, Register Rscratch);
198 void test_backedge_count_for_osr(Register backedge_count, Register method_counters, Register target_bcp, Register disp, Register Rtmp);
199
200 void record_static_call_in_profile(Register Rentry, Register Rtmp);
201 void record_receiver_call_in_profile(Register Rklass, Register Rentry, Register Rtmp);
202
203 void get_method_counters(Register method, Register Rcounters, Label& skip);
204 void increment_invocation_counter(Register iv_be_count, Register Rtmp1, Register Rtmp2_r0);
205
206 // Object locking
207 void lock_object (Register lock_reg, Register obj_reg);
208 void unlock_object(Register lock_reg, bool check_for_exceptions = true);
209
210 // Interpreter profiling operations
211 void set_method_data_pointer_for_bcp();
212 void test_method_data_pointer(Label& zero_continue);
213 void verify_method_data_pointer();
214 void test_invocation_counter_for_mdp(Register invocation_count, Register method_counters, Register Rscratch, Label &profile_continue);
215
216 void set_mdp_data_at(int constant, Register value);
217
218 void increment_mdp_data_at(int constant, Register counter_addr, Register Rbumped_count, bool decrement = false);
219
220 void increment_mdp_data_at(Register counter_addr, Register Rbumped_count, bool decrement = false);
221 void increment_mdp_data_at(Register reg, int constant, Register scratch, Register Rbumped_count, bool decrement = false);
222
223 void set_mdp_flag_at(int flag_constant, Register scratch);
224 void test_mdp_data_at(int offset, Register value, Label& not_equal_continue, Register test_out);
225
226 void update_mdp_by_offset(int offset_of_disp, Register scratch);
227 void update_mdp_by_offset(Register reg, int offset_of_disp,
228 Register scratch);
229 void update_mdp_by_constant(int constant);
230 void update_mdp_for_ret(TosState state, Register return_bci);
231
232 void profile_taken_branch(Register scratch, Register bumped_count);
233 void profile_not_taken_branch(Register scratch1, Register scratch2);
234 void profile_call(Register scratch1, Register scratch2);
235 void profile_final_call(Register scratch1, Register scratch2);
236 void profile_virtual_call(Register Rreceiver, Register Rscratch1, Register Rscratch2, bool receiver_can_be_null);
237 void profile_typecheck(Register Rklass, Register Rscratch1, Register Rscratch2);
238 void profile_typecheck_failed(Register Rscratch1, Register Rscratch2);
239 void profile_ret(TosState state, Register return_bci, Register scratch1, Register scratch2);
240 void profile_switch_default(Register scratch1, Register scratch2);
241 void profile_switch_case(Register index, Register scratch1,Register scratch2, Register scratch3);
242 void profile_null_seen(Register Rscratch1, Register Rscratch2);
243 void record_klass_in_profile(Register receiver, Register scratch1, Register scratch2, bool is_virtual_call);
244 void record_klass_in_profile_helper(Register receiver, Register scratch1, Register scratch2, int start_row, Label& done, bool is_virtual_call);
245
246 // Argument and return type profiling.
247 void profile_obj_type(Register obj, Register mdo_addr_base, RegisterOrConstant mdo_addr_offs, Register tmp, Register tmp2);
248 void profile_arguments_type(Register callee, Register tmp1, Register tmp2, bool is_virtual);
249 void profile_return_type(Register ret, Register tmp1, Register tmp2);
250 void profile_parameters_type(Register tmp1, Register tmp2, Register tmp3, Register tmp4);
251
252 // Debugging
253 void verify_oop(Register reg, TosState state = atos); // only if +VerifyOops && state == atos
254 void verify_oop_or_return_address(Register reg, Register rtmp); // for astore
255 void verify_FPU(int stack_depth, TosState state = ftos);
256
257 typedef enum { NotifyJVMTI, SkipNotifyJVMTI } NotifyMethodExitMode;
258
259 // Support for jvmdi/jvmpi.
260 void notify_method_entry();
261 void notify_method_exit(bool is_native_method, TosState state,
262 NotifyMethodExitMode mode, bool check_exceptions);
263 };
264
265 #endif // CPU_PPC_VM_INTERP_MASM_PPC_64_HPP