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