1 /*
2 * Copyright (c) 1997, 2021, 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_INTERP_MASM_X86_HPP
26 #define CPU_X86_INTERP_MASM_X86_HPP
27
28 #include "asm/macroAssembler.hpp"
29 #include "interpreter/invocationCounter.hpp"
30 #include "oops/method.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, bool generate_poll = false);
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, Register tmp = rscratch2);
126
127 // load cpool->resolved_klass_at(index)
128 void load_resolved_klass_at_index(Register klass, // contains the Klass on return
129 Register cpool, // the constant pool (corrupted on return)
130 Register index); // the constant pool index (corrupted on return)
131
132 void load_resolved_method_at_index(int byte_no,
133 Register method,
134 Register cache,
135 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
144 // On x86, pushing a ptr or an int is semantically identical, but we
145 // maintain a distinction for clarity and for making it easier to change
146 // semantics in the future
147 void push_ptr(Register r = rax);
148 void push_i(Register r = rax);
149
150 // push_i_or_ptr is provided for when explicitly allowing either a ptr or
151 // an int might have some advantage, while still documenting the fact that a
152 // ptr might be pushed to the stack.
153 void push_i_or_ptr(Register r = rax);
154
155 void push_f(XMMRegister r);
156 void pop_f(XMMRegister r);
157 void pop_d(XMMRegister r);
158 void push_d(XMMRegister r);
159 #ifdef _LP64
160 void pop_l(Register r = rax);
161 void push_l(Register r = rax);
162 #else
163 void pop_l(Register lo = rax, Register hi = rdx);
164 void pop_f();
165 void pop_d();
166
167 void push_l(Register lo = rax, Register hi = rdx);
168 void push_d();
169 void push_f();
170 #endif // _LP64
171
172 void pop(Register r) { ((MacroAssembler*)this)->pop(r); }
173 void push(Register r) { ((MacroAssembler*)this)->push(r); }
174 void push(int32_t imm ) { ((MacroAssembler*)this)->push(imm); }
175
176 void pop(TosState state); // transition vtos -> state
177 void push(TosState state); // transition state -> vtos
178
179 // These are dummies to prevent surprise implicit conversions to Register
180 void pop(void* v); // Add unimplemented ambiguous method
181 void push(void* v); // Add unimplemented ambiguous method
182
183 void empty_expression_stack() {
184 movptr(rsp, Address(rbp, frame::interpreter_frame_monitor_block_top_offset * wordSize));
185 // NULL last_sp until next java call
186 movptr(Address(rbp, frame::interpreter_frame_last_sp_offset * wordSize), (int32_t)NULL_WORD);
187 NOT_LP64(empty_FPU_stack());
188 }
189
190 // Helpers for swap and dup
191 void load_ptr(int n, Register val);
192 void store_ptr(int n, Register val);
193
194 // Generate a subtype check: branch to ok_is_subtype if sub_klass is
195 // a subtype of super_klass.
196 void gen_subtype_check(Register sub_klass, Label &ok_is_subtype, bool profile = true);
197
198 // Dispatching
199 void dispatch_prolog(TosState state, int step = 0);
200 void dispatch_epilog(TosState state, int step = 0);
201 // dispatch via rbx (assume rbx is loaded already)
202 void dispatch_only(TosState state, bool generate_poll = false);
203 // dispatch normal table via rbx (assume rbx is loaded already)
204 void dispatch_only_normal(TosState state);
205 void dispatch_only_noverify(TosState state);
206 // load rbx from [_bcp_register + step] and dispatch via rbx
207 void dispatch_next(TosState state, int step = 0, bool generate_poll = false);
208 // load rbx from [_bcp_register] and dispatch via rbx and table
209 void dispatch_via (TosState state, address* table);
210
211 // jump to an invoked target
212 void prepare_to_jump_from_interpreted();
213 void jump_from_interpreted(Register method, Register temp);
214
215 // narrow int return value
216 void narrow(Register result);
217
218 // Returning from interpreted functions
219 //
220 // Removes the current activation (incl. unlocking of monitors)
221 // and sets up the return address. This code is also used for
222 // exception unwindwing. In that case, we do not want to throw
223 // IllegalMonitorStateExceptions, since that might get us into an
224 // infinite rethrow exception loop.
225 // Additionally this code is used for popFrame and earlyReturn.
226 // In popFrame case we want to skip throwing an exception,
227 // installing an exception, and notifying jvmdi.
228 // In earlyReturn case we only want to skip throwing an exception
229 // and installing an exception.
230 void remove_activation(TosState state, Register ret_addr,
231 bool throw_monitor_exception = true,
232 bool install_monitor_exception = true,
233 bool notify_jvmdi = true);
234 void get_method_counters(Register method, Register mcs, Label& skip);
235
236 // Kills t1 and t2, perserves klass, return allocation in new_obj
237 void allocate_instance(Register klass, Register new_obj,
238 Register t1, Register t2,
239 bool clear_fields, Label& alloc_failed);
240 // Allocate instance in "obj" and read in the content of the inline field
241 // NOTES:
242 // - input holder object via "obj", which must be rax,
243 // will return new instance via the same reg
244 // - assumes holder_klass and valueKlass field klass have both been resolved
245 // - 32 bits: kills rdi and rsi
246 void read_inlined_field(Register holder_klass,
247 Register field_index, Register field_offset,
248 Register obj = rax);
249
250 // Allocate value buffer in "obj" and read in flattened element at the given index
251 // NOTES:
252 // - Return via "obj" must be rax
253 // - kills all given regs
254 // - 32 bits: kills rdi and rsi
255 void read_flattened_element(Register array, Register index,
256 Register t1, Register t2,
257 Register obj = rax);
258
259 // Object locking
260 void lock_object (Register lock_reg);
261 void unlock_object(Register lock_reg);
262
263 // Interpreter profiling operations
264 void set_method_data_pointer_for_bcp();
265 void test_method_data_pointer(Register mdp, Label& zero_continue);
266 void verify_method_data_pointer();
267
268 void set_mdp_data_at(Register mdp_in, int constant, Register value);
269 void increment_mdp_data_at(Address data, bool decrement = false);
270 void increment_mdp_data_at(Register mdp_in, int constant,
271 bool decrement = false);
272 void increment_mdp_data_at(Register mdp_in, Register reg, int constant,
273 bool decrement = false);
274 void increment_mask_and_jump(Address counter_addr, Address mask,
275 Register scratch, Label* where);
276 void set_mdp_flag_at(Register mdp_in, int flag_constant);
277 void test_mdp_data_at(Register mdp_in, int offset, Register value,
278 Register test_value_out,
279 Label& not_equal_continue);
280
281 void record_klass_in_profile(Register receiver, Register mdp,
282 Register reg2, bool is_virtual_call);
283 void record_klass_in_profile_helper(Register receiver, Register mdp,
284 Register reg2, int start_row,
285 Label& done, bool is_virtual_call);
286 void record_item_in_profile_helper(Register item, Register mdp,
287 Register reg2, int start_row, Label& done, int total_rows,
288 OffsetFunction item_offset_fn, OffsetFunction item_count_offset_fn,
289 int non_profiled_offset);
290
291 void update_mdp_by_offset(Register mdp_in, int offset_of_offset);
292 void update_mdp_by_offset(Register mdp_in, Register reg, int offset_of_disp);
293 void update_mdp_by_constant(Register mdp_in, int constant);
294 void update_mdp_for_ret(Register return_bci);
295
296 void profile_taken_branch(Register mdp, Register bumped_count);
297 void profile_not_taken_branch(Register mdp, bool acmp = false);
298 void profile_call(Register mdp);
299 void profile_final_call(Register mdp);
300 void profile_virtual_call(Register receiver, Register mdp,
301 Register scratch2,
302 bool receiver_can_be_null = false);
303 void profile_ret(Register return_bci, Register mdp);
304 void profile_null_seen(Register mdp);
305 void profile_typecheck(Register mdp, Register klass, Register scratch);
306 void profile_typecheck_failed(Register mdp);
307 void profile_switch_default(Register mdp);
308 void profile_switch_case(Register index_in_scratch, Register mdp,
309 Register scratch2);
310 void profile_array(Register mdp, Register array, Register tmp);
311 void profile_element(Register mdp, Register element, Register tmp);
312 void profile_acmp(Register mdp, Register left, Register right, Register tmp);
313
314 // Debugging
315 // only if +VerifyOops && state == atos
316 #define interp_verify_oop(reg, state) _interp_verify_oop(reg, state, __FILE__, __LINE__);
317 void _interp_verify_oop(Register reg, TosState state, const char* file, int line);
318 // only if +VerifyFPU && (state == ftos || state == dtos)
319 void verify_FPU(int stack_depth, TosState state = ftos);
320
321 typedef enum { NotifyJVMTI, SkipNotifyJVMTI } NotifyMethodExitMode;
322
323 // support for jvmti/dtrace
324 void notify_method_entry();
325 void notify_method_exit(TosState state, NotifyMethodExitMode mode);
326
327 private:
328
329 Register _locals_register; // register that contains the pointer to the locals
330 Register _bcp_register; // register that contains the bcp
331
332 public:
333 void profile_obj_type(Register obj, const Address& mdo_addr);
334 void profile_arguments_type(Register mdp, Register callee, Register tmp, bool is_virtual);
335 void profile_return_type(Register mdp, Register ret, Register tmp);
336 void profile_parameters_type(Register mdp, Register tmp1, Register tmp2);
337
338 };
339
340 #endif // CPU_X86_INTERP_MASM_X86_HPP