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