1 /*
2 * Copyright (c) 1997, 2017, 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 CPU_SPARC_VM_INTERP_MASM_SPARC_HPP
26 #define CPU_SPARC_VM_INTERP_MASM_SPARC_HPP
27
28 #include "asm/macroAssembler.inline.hpp"
29 #include "interpreter/invocationCounter.hpp"
30
31 // This file specializes the assember with interpreter-specific macros
32
33 typedef ByteSize (*OffsetFunction)(uint);
34
35 REGISTER_DECLARATION( Register, Otos_i , O0); // tos for ints, etc
36 REGISTER_DECLARATION( Register, Otos_l , O0); // for longs
37 REGISTER_DECLARATION( Register, Otos_l1, O0); // for 1st part of longs
38 REGISTER_DECLARATION( Register, Otos_l2, O1); // for 2nd part of longs
39 REGISTER_DECLARATION(FloatRegister, Ftos_f , F0); // for floats
40 REGISTER_DECLARATION(FloatRegister, Ftos_d , F0); // for doubles
41 REGISTER_DECLARATION(FloatRegister, Ftos_d1, F0); // for 1st part of double
42 REGISTER_DECLARATION(FloatRegister, Ftos_d2, F1); // for 2nd part of double
43
44 #ifndef DONT_USE_REGISTER_DEFINES
45 #define Otos_i O0
46 #define Otos_l O0
47 #define Otos_l1 O0
48 #define Otos_l2 O1
49 #define Ftos_f F0
50 #define Ftos_d F0
51 #define Ftos_d1 F0
52 #define Ftos_d2 F1
53 #endif // DONT_USE_REGISTER_DEFINES
54
55 class InterpreterMacroAssembler: public MacroAssembler {
56 protected:
57 // Interpreter specific version of call_VM_base
58 virtual void call_VM_leaf_base(
59 Register java_thread,
60 address entry_point,
61 int number_of_arguments
62 );
63
64 virtual void call_VM_base(
65 Register oop_result,
66 Register java_thread,
67 Register last_java_sp,
68 address entry_point,
69 int number_of_arguments,
70 bool check_exception=true
71 );
72
73 // base routine for all dispatches
74 void dispatch_base(TosState state, address* table);
75
76 public:
77 InterpreterMacroAssembler(CodeBuffer* c)
78 : MacroAssembler(c) {}
79
80 virtual void check_and_handle_popframe(Register scratch_reg);
81 virtual void check_and_handle_earlyret(Register scratch_reg);
82
83 void jump_to_entry(address entry);
84
85 virtual void load_earlyret_value(TosState state);
86
87 static const Address l_tmp ;
88 static const Address d_tmp ;
89
90 // helper routine for frame allocation/deallocation
91 // compute the delta by which the caller's SP has to
92 // be adjusted to accomodate for the non-argument
93 // locals
94 void compute_extra_locals_size_in_bytes(Register args_size, Register locals_size, Register delta);
95
96 // dispatch routines
97 void dispatch_prolog(TosState state, int step = 0);
98 void dispatch_epilog(TosState state, int step = 0);
99 void dispatch_only(TosState state);
100 void dispatch_normal(TosState state);
101 void dispatch_next(TosState state, int step = 0);
102 void dispatch_next_noverify_oop(TosState state, int step = 0);
103 void dispatch_via (TosState state, address* table);
104
105
106 void narrow(Register result);
107
108 // Removes the current activation (incl. unlocking of monitors).
109 // Additionally this code is used for earlyReturn in which case we
110 // want to skip throwing an exception and installing an exception.
111 void remove_activation(TosState state,
112 bool throw_monitor_exception = true,
113 bool install_monitor_exception = true);
114
115 protected:
116 void dispatch_Lbyte_code(TosState state, address* table, int bcp_incr = 0, bool verify = true);
117
118 public:
119 // Super call_VM calls - correspond to MacroAssembler::call_VM(_leaf) calls
120 void super_call_VM(Register thread_cache,
121 Register oop_result,
122 Register last_java_sp,
123 address entry_point,
124 Register arg_1,
125 Register arg_2,
126 bool check_exception = true);
127
128 void super_call_VM_leaf(Register thread_cache, address entry_point, Register arg_1, Register arg_2);
129
130 // Generate a subtype check: branch to ok_is_subtype if sub_klass is
131 // a subtype of super_klass. Blows registers tmp1, tmp2 and tmp3.
132 void gen_subtype_check( Register sub_klass, Register super_klass, Register tmp1, Register tmp2, Register tmp3, Label &ok_is_subtype );
133
134 // helpers for tossing exceptions
135 void throw_if_not_1_icc( Condition ok_condition, Label& ok );
136 void throw_if_not_1_xcc( Condition ok_condition, Label& ok );
137 void throw_if_not_1_x ( Condition ok_condition, Label& ok ); // chooses icc or xcc based on _LP64
138
139 void throw_if_not_2( address throw_entry_point, Register Rscratch, Label& ok);
140
141 void throw_if_not_icc( Condition ok_condition, address throw_entry_point, Register Rscratch );
142 void throw_if_not_xcc( Condition ok_condition, address throw_entry_point, Register Rscratch );
143 void throw_if_not_x ( Condition ok_condition, address throw_entry_point, Register Rscratch );
144
145 // helpers for expression stack
146
147 void pop_i( Register r = Otos_i);
148 void pop_ptr( Register r = Otos_i, Register scratch = O4);
149 void pop_l( Register r = Otos_l1);
150 // G4_scratch and Lscratch are used at call sites!!
151 void pop_f(FloatRegister f = Ftos_f, Register scratch = G1_scratch);
152 void pop_d(FloatRegister f = Ftos_d1, Register scratch = G1_scratch);
153
154 void push_i( Register r = Otos_i);
155 void push_ptr( Register r = Otos_i);
156 void push_l( Register r = Otos_l1);
157 void push_f(FloatRegister f = Ftos_f);
158 void push_d(FloatRegister f = Ftos_d1);
159
160
161 void pop (TosState state); // transition vtos -> state
162 void push(TosState state); // transition state -> vtos
163 void empty_expression_stack(); // resets both Lesp and SP
164
165 #ifdef ASSERT
166 void verify_sp(Register Rsp, Register Rtemp);
167 void verify_esp(Register Resp); // verify that Lesp points to a word in the temp stack
168 #endif // ASSERT
169
170 public:
171 void if_cmp(Condition cc, bool ptr_compare);
172
173 // Load values from bytecode stream:
174
175 enum signedOrNot { Signed, Unsigned };
176 enum setCCOrNot { set_CC, dont_set_CC };
177
178 void get_2_byte_integer_at_bcp( int bcp_offset,
179 Register Rtmp,
180 Register Rdst,
181 signedOrNot is_signed,
182 setCCOrNot should_set_CC = dont_set_CC );
183
184 void get_4_byte_integer_at_bcp( int bcp_offset,
185 Register Rtmp,
186 Register Rdst,
187 setCCOrNot should_set_CC = dont_set_CC );
188
189 // Note: "get_cache_and_index" really means "get the index, use it to get the cache entry, and throw away the index".
190 void get_cache_and_index_at_bcp(Register cache, Register tmp, int bcp_offset, size_t index_size = sizeof(u2));
191 void get_cache_and_index_and_bytecode_at_bcp(Register cache, Register temp, Register bytecode, int byte_no, int bcp_offset, size_t index_size = sizeof(u2));
192 void get_cache_entry_pointer_at_bcp(Register cache, Register tmp, int bcp_offset, size_t index_size = sizeof(u2));
193 // Note: This one does not fetch the cache. The first argument is a temp which may be killed.
194 void get_cache_index_at_bcp(Register temp, Register index, int bcp_offset, size_t index_size = sizeof(u2));
195
196 // load cpool->resolved_references(index);
197 void load_resolved_reference_at_index(Register result, Register index);
198
199 // common code
200
201 void field_offset_at(int n, Register tmp, Register dest, Register base);
202 int field_offset_at(Register object, address bcp, int offset);
203 void fast_iaaccess(int n, address bcp);
204 void fast_iaputfield(address bcp, bool do_store_check );
205
206 void index_check(Register array, Register index, int index_shift, Register tmp, Register res);
207 void index_check_without_pop(Register array, Register index, int index_shift, Register tmp, Register res);
208
209 void get_const(Register Rdst);
210 void get_constant_pool(Register Rdst);
211 void get_constant_pool_cache(Register Rdst);
212 void get_cpool_and_tags(Register Rcpool, Register Rtags);
213 void is_a(Label& L);
214
215 // Load compiled (i2c) or interpreter entry and call from interpreted
216 void call_from_interpreter(Register target, Register scratch, Register Rret);
217
218 // --------------------------------------------------
219
220 void unlock_if_synchronized_method(TosState state, bool throw_monitor_exception = true, bool install_monitor_exception = true);
221
222 void add_monitor_to_stack( bool stack_is_empty,
223 Register Rtemp,
224 Register Rtemp2 );
225
226 // Load/store aligned in _LP64 but unaligned otherwise
227 // These only apply to the Interpreter expression stack and locals!
228 void load_unaligned_double(Register r1, int offset, FloatRegister d);
229 void store_unaligned_double(FloatRegister d, Register r1, int offset );
230
231 // Load/store aligned in _LP64 but unaligned otherwise
232 void load_unaligned_long(Register r1, int offset, Register d);
233 void store_unaligned_long(Register d, Register r1, int offset );
234
235 void access_local_int( Register index, Register dst );
236 void access_local_ptr( Register index, Register dst );
237 void access_local_returnAddress( Register index, Register dst );
238 void access_local_long( Register index, Register dst );
239 void access_local_float( Register index, FloatRegister dst );
240 void access_local_double( Register index, FloatRegister dst );
241 #ifdef ASSERT
242 void check_for_regarea_stomp( Register Rindex, int offset, Register Rlimit, Register Rscratch, Register Rscratch1);
243 #endif // ASSERT
244 void store_local_int( Register index, Register src );
245 void store_local_ptr( Register index, Register src );
246 void store_local_ptr( int n, Register src );
247 void store_local_long( Register index, Register src );
248 void store_local_float( Register index, FloatRegister src );
249 void store_local_double( Register index, FloatRegister src );
250
251 // Helpers for swap and dup
252 void load_ptr(int n, Register val);
253 void store_ptr(int n, Register val);
254
255 // Helper for getting receiver in register.
256 void load_receiver(Register param_count, Register recv);
257
258 static int top_most_monitor_byte_offset(); // offset in bytes to top of monitor block
259 Address top_most_monitor();
260 void compute_stack_base( Register Rdest );
261
262 void get_method_counters(Register method, Register Rcounters, Label& skip);
263 void increment_invocation_counter( Register Rcounters, Register Rtmp, Register Rtmp2 );
264 void increment_backedge_counter( Register Rcounters, Register Rtmp, Register Rtmp2 );
265 void test_backedge_count_for_osr(Register backedge_count, Register method_counters, Register branch_bcp, Register Rtmp );
266
267 // Object locking
268 void lock_object (Register lock_reg, Register obj_reg);
269 void unlock_object(Register lock_reg);
270
271 // Interpreter profiling operations
272 void set_method_data_pointer();
273 void set_method_data_pointer_for_bcp();
274 void test_method_data_pointer(Label& zero_continue);
275 void verify_method_data_pointer();
276 void test_invocation_counter_for_mdp(Register invocation_count, Register method_counters, Register Rtmp, Label &profile_continue);
277
278 void set_mdp_data_at(int constant, Register value);
279 void increment_mdp_data_at(Address counter, Register bumped_count,
280 bool decrement = false);
281 void increment_mdp_data_at(int constant, Register bumped_count,
282 bool decrement = false);
283 void increment_mdp_data_at(Register reg, int constant,
284 Register bumped_count, Register scratch2,
285 bool decrement = false);
286 void increment_mask_and_jump(Address counter_addr,
287 int increment, Address mask_addr,
288 Register scratch1, Register scratch2,
289 Condition cond, Label *where);
290 void set_mdp_flag_at(int flag_constant, Register scratch);
291 void test_mdp_data_at(int offset, Register value, Label& not_equal_continue,
292 Register scratch);
293
294 void record_klass_in_profile(Register receiver, Register scratch, bool is_virtual_call);
295 void record_klass_in_profile_helper(Register receiver, Register scratch,
296 Label& done, bool is_virtual_call);
297 void record_item_in_profile_helper(Register item,
298 Register scratch, int start_row, Label& done, int total_rows,
299 OffsetFunction item_offset_fn, OffsetFunction item_count_offset_fn,
300 int non_profiled_offset);
301
302 void update_mdp_by_offset(int offset_of_disp, Register scratch);
303 void update_mdp_by_offset(Register reg, int offset_of_disp,
304 Register scratch);
305 void update_mdp_by_constant(int constant);
306 void update_mdp_for_ret(TosState state, Register return_bci);
307
308 void profile_taken_branch(Register scratch, Register bumped_count);
309 void profile_not_taken_branch(Register scratch);
310 void profile_call(Register scratch);
311 void profile_final_call(Register scratch);
312 void profile_virtual_call(Register receiver, Register scratch, bool receiver_can_be_null = false);
313 void profile_called_method(Register method, Register scratch) NOT_JVMCI_RETURN;
314 void profile_ret(TosState state, Register return_bci, Register scratch);
315 void profile_null_seen(Register scratch);
316 void profile_typecheck(Register klass, Register scratch);
317 void profile_typecheck_failed(Register scratch);
318 void profile_switch_default(Register scratch);
319 void profile_switch_case(Register index,
320 Register scratch1,
321 Register scratch2,
322 Register scratch3);
323
324 void profile_obj_type(Register obj, const Address& mdo_addr, Register tmp);
325 void profile_arguments_type(Register callee, Register tmp1, Register tmp2, bool is_virtual);
326 void profile_return_type(Register ret, Register tmp1, Register tmp2);
327 void profile_parameters_type(Register tmp1, Register tmp2, Register tmp3, Register tmp4);
328
329 // Debugging
330 void interp_verify_oop(Register reg, TosState state, const char * file, int line); // only if +VerifyOops && state == atos
331 void verify_oop_or_return_address(Register reg, Register rtmp); // for astore
332 void verify_FPU(int stack_depth, TosState state = ftos); // only if +VerifyFPU && (state == ftos || state == dtos)
333
334 // support for JVMTI/Dtrace
335 typedef enum { NotifyJVMTI, SkipNotifyJVMTI } NotifyMethodExitMode;
336 void notify_method_entry();
337 void notify_method_exit(
338 bool save_result, TosState state, NotifyMethodExitMode mode);
339
340 void save_return_value(TosState state, bool is_native_call);
341 void restore_return_value(TosState state, bool is_native_call);
342
343 };
344
345 #endif // CPU_SPARC_VM_INTERP_MASM_SPARC_HPP