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