src/hotspot/cpu/riscv/interp_masm_riscv.hpp - openjdk/jdk25u - Git at Google

 /*
  * Copyright (c) 2003, 2024, Oracle and/or its affiliates. All rights reserved.
  * Copyright (c) 2014, 2015, Red Hat Inc. All rights reserved.
  * Copyright (c) 2020, 2021, Huawei Technologies Co., Ltd. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
  * under the terms of the GNU General Public License version 2 only, as
  * published by the Free Software Foundation.
  *
  * This code is distributed in the hope that it will be useful, but WITHOUT
  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * version 2 for more details (a copy is included in the LICENSE file that
  * accompanied this code).
  *
  * You should have received a copy of the GNU General Public License version
  * 2 along with this work; if not, write to the Free Software Foundation,
  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  *
  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  * or visit www.oracle.com if you need additional information or have any
  * questions.
  *
  */

 #ifndef CPU_RISCV_INTERP_MASM_RISCV_HPP
 #define CPU_RISCV_INTERP_MASM_RISCV_HPP

 #include "asm/macroAssembler.hpp"
 #include "interpreter/invocationCounter.hpp"
 #include "runtime/frame.hpp"

 // This file specializes the assembler with interpreter-specific macros

 typedef ByteSize (*OffsetFunction)(uint);

 class InterpreterMacroAssembler: public MacroAssembler {
  protected:
   // Interpreter specific version of call_VM_base
   using MacroAssembler::call_VM_leaf_base;

   virtual void call_VM_leaf_base(address entry_point,
                                  int number_of_arguments);

   virtual void call_VM_base(Register oop_result,
                             Register java_thread,
                             Register last_java_sp,
                             address  entry_point,
                             int number_of_arguments,
                             bool check_exceptions);

   // base routine for all dispatches
   void dispatch_base(TosState state, address* table, bool verifyoop = true,
                      bool generate_poll = false, Register Rs = t0);

  public:
   InterpreterMacroAssembler(CodeBuffer* code) : MacroAssembler(code) {}

   void load_earlyret_value(TosState state);

   void call_VM_preemptable(Register oop_result,
                            address entry_point,
                            Register arg_1);
   void restore_after_resume(bool is_native);

   void jump_to_entry(address entry);

   virtual void check_and_handle_popframe(Register java_thread);
   virtual void check_and_handle_earlyret(Register java_thread);

   // Interpreter-specific registers
   void save_bcp() {
     sd(xbcp, Address(fp, frame::interpreter_frame_bcp_offset * wordSize));
   }

   void restore_bcp() {
     ld(xbcp, Address(fp, frame::interpreter_frame_bcp_offset * wordSize));
   }

   void restore_locals() {
     ld(xlocals, Address(fp, frame::interpreter_frame_locals_offset * wordSize));
     shadd(xlocals, xlocals, fp, t0, LogBytesPerWord);
   }

   void restore_constant_pool_cache() {
     ld(xcpool, Address(fp, frame::interpreter_frame_cache_offset * wordSize));
   }

   void restore_sp_after_call() {
     Label L;
     ld(t0, Address(fp, frame::interpreter_frame_extended_sp_offset * wordSize));
     shadd(t0, t0, fp, t0, LogBytesPerWord);
 #ifdef ASSERT
     bnez(t0, L);
     stop("SP is null");
 #endif
     bind(L);
     mv(sp, t0);
   }

   void check_extended_sp(const char* msg = "check extended SP") {
 #ifdef ASSERT
     Label L;
     ld(t0, Address(fp, frame::interpreter_frame_extended_sp_offset * wordSize));
     shadd(t0, t0, fp, t0, LogBytesPerWord);
     beq(sp, t0, L);
     stop(msg);
     bind(L);
 #endif
   }

 #define check_extended_sp()                                                                    \
   check_extended_sp("SP does not match extended SP in frame at " __FILE__ ":" XSTR(__LINE__))

   void get_dispatch();

   // Helpers for runtime call arguments/results
   void get_method(Register reg) {
     ld(reg, Address(fp, frame::interpreter_frame_method_offset * wordSize));
   }

   void get_const(Register reg) {
     get_method(reg);
     ld(reg, Address(reg, in_bytes(Method::const_offset())));
   }

   void get_constant_pool(Register reg) {
     get_const(reg);
     ld(reg, Address(reg, in_bytes(ConstMethod::constants_offset())));
   }

   void get_constant_pool_cache(Register reg) {
     get_constant_pool(reg);
     ld(reg, Address(reg, ConstantPool::cache_offset()));
   }

   void get_cpool_and_tags(Register cpool, Register tags) {
     get_constant_pool(cpool);
     ld(tags, Address(cpool, ConstantPool::tags_offset()));
   }

   void get_unsigned_2_byte_index_at_bcp(Register reg, int bcp_offset);
   void get_cache_index_at_bcp(Register index, Register tmp, int bcp_offset, size_t index_size = sizeof(u2));
   void get_method_counters(Register method, Register mcs, Label& skip);

   // Load cpool->resolved_references(index).
   void load_resolved_reference_at_index(Register result, Register index, Register tmp = x15);

   // Load cpool->resolved_klass_at(index).
   void load_resolved_klass_at_offset(Register cpool, Register index, Register klass, Register temp);

   void pop_ptr(Register r = x10);
   void pop_i(Register r = x10);
   void pop_l(Register r = x10);
   void pop_f(FloatRegister r = f10);
   void pop_d(FloatRegister r = f10);
   void push_ptr(Register r = x10);
   void push_i(Register r = x10);
   void push_l(Register r = x10);
   void push_f(FloatRegister r = f10);
   void push_d(FloatRegister r = f10);

   void pop(TosState state); // transition vtos -> state
   void push(TosState state); // transition state -> vtos

   void empty_expression_stack() {
     ld(t0, Address(fp, frame::interpreter_frame_monitor_block_top_offset * wordSize));
     shadd(esp, t0, fp, t0, LogBytesPerWord);
     // null last_sp until next java call
     sd(zr, Address(fp, frame::interpreter_frame_last_sp_offset * wordSize));
   }

   // Helpers for swap and dup
   void load_ptr(int n, Register val);
   void store_ptr(int n, Register val);

   // Load float value from 'address'. The value is loaded onto the fp register f10.
   void load_float(Address src);
   void load_double(Address src);

   // Generate a subtype check: branch to ok_is_subtype if sub_klass is
   // a subtype of super_klass.
   void gen_subtype_check( Register sub_klass, Label &ok_is_subtype );

   // Dispatching
   void dispatch_prolog(TosState state, int step = 0);
   void dispatch_epilog(TosState state, int step = 0);
   // dispatch via t0
   void dispatch_only(TosState state, bool generate_poll = false, Register Rs = t0);
   // dispatch normal table via t0 (assume t0 is loaded already)
   void dispatch_only_normal(TosState state, Register Rs = t0);
   void dispatch_only_noverify(TosState state, Register Rs = t0);
   // load t0 from [xbcp + step] and dispatch via t0
   void dispatch_next(TosState state, int step = 0, bool generate_poll = false);
   // load t0 from [xbcp] and dispatch via t0 and table
   void dispatch_via (TosState state, address* table);

   // jump to an invoked target
   void prepare_to_jump_from_interpreted();
   void jump_from_interpreted(Register method);


   // Returning from interpreted functions
   //
   // Removes the current activation (incl. unlocking of monitors)
   // and sets up the return address.  This code is also used for
   // exception unwindwing. In that case, we do not want to throw
   // IllegalMonitorStateExceptions, since that might get us into an
   // infinite rethrow exception loop.
   // Additionally this code is used for popFrame and earlyReturn.
   // In popFrame case we want to skip throwing an exception,
   // installing an exception, and notifying jvmdi.
   // In earlyReturn case we only want to skip throwing an exception
   // and installing an exception.
   void remove_activation(TosState state,
                          bool throw_monitor_exception = true,
                          bool install_monitor_exception = true,
                          bool notify_jvmdi = true);

   // FIXME: Give us a valid frame at a null check.
   virtual void null_check(Register reg, int offset = -1) {
         MacroAssembler::null_check(reg, offset);
   }

   // Object locking
   void lock_object  (Register lock_reg);
   void unlock_object(Register lock_reg);

   // Interpreter profiling operations
   void set_method_data_pointer_for_bcp();
   void test_method_data_pointer(Register mdp, Label& zero_continue);
   void verify_method_data_pointer();

   void set_mdp_data_at(Register mdp_in, int constant, Register value);
   void increment_mdp_data_at(Register mdp_in, int constant);
   void increment_mdp_data_at(Register mdp_in, Register index, int constant);
   void increment_mask_and_jump(Address counter_addr,
                                int increment, Address mask,
                                Register tmp1, Register tmp2,
                                bool preloaded, Label* where);

   void set_mdp_flag_at(Register mdp_in, int flag_constant);
   void test_mdp_data_at(Register mdp_in, int offset, Register value,
                         Register test_value_out,
                         Label& not_equal_continue);

   void record_klass_in_profile(Register receiver, Register mdp,
                                Register reg2);
   void record_klass_in_profile_helper(Register receiver, Register mdp,
                                       Register reg2, Label& done);
   void record_item_in_profile_helper(Register item, Register mdp,
                                      Register reg2, int start_row, Label& done, int total_rows,
                                      OffsetFunction item_offset_fn, OffsetFunction item_count_offset_fn);

   void update_mdp_by_offset(Register mdp_in, int offset_of_offset);
   void update_mdp_by_offset(Register mdp_in, Register reg, int offset_of_disp);
   void update_mdp_by_constant(Register mdp_in, int constant);
   void update_mdp_for_ret(Register return_bci);

   // narrow int return value
   void narrow(Register result);

   void profile_taken_branch(Register mdp, Register bumped_count);
   void profile_not_taken_branch(Register mdp);
   void profile_call(Register mdp);
   void profile_final_call(Register mdp);
   void profile_virtual_call(Register receiver, Register mdp,
                             Register t1,
                             bool receiver_can_be_null = false);
   void profile_ret(Register return_bci, Register mdp);
   void profile_null_seen(Register mdp);
   void profile_typecheck(Register mdp, Register klass, Register temp);
   void profile_typecheck_failed(Register mdp);
   void profile_switch_default(Register mdp);
   void profile_switch_case(Register index_in_scratch, Register mdp,
                            Register temp);

   void profile_obj_type(Register obj, const Address& mdo_addr, Register tmp);
   void profile_arguments_type(Register mdp, Register callee, Register tmp, bool is_virtual);
   void profile_return_type(Register mdp, Register ret, Register tmp);
   void profile_parameters_type(Register mdp, Register tmp1, Register tmp2, Register tmp3);

   typedef enum { NotifyJVMTI, SkipNotifyJVMTI } NotifyMethodExitMode;

   // support for jvmti/dtrace
   void notify_method_entry();
   void notify_method_exit(TosState state, NotifyMethodExitMode mode);

   JFR_ONLY(void enter_jfr_critical_section();)
   JFR_ONLY(void leave_jfr_critical_section();)

   virtual void _call_Unimplemented(address call_site) {
     save_bcp();
     set_last_Java_frame(esp, fp, (address) pc(), t0);
     MacroAssembler::_call_Unimplemented(call_site);
   }

   void load_resolved_indy_entry(Register cache, Register index);
   void load_field_entry(Register cache, Register index, int bcp_offset = 1);
   void load_method_entry(Register cache, Register index, int bcp_offset = 1);

   void verify_field_offset(Register reg) NOT_DEBUG_RETURN;

 #ifdef ASSERT
   void verify_access_flags(Register access_flags, uint32_t flag,
                            const char* msg, bool stop_by_hit = true);
   void verify_frame_setup();
 #endif
 };

 #endif // CPU_RISCV_INTERP_MASM_RISCV_HPP
	/*
	* Copyright (c) 2003, 2024, Oracle and/or its affiliates. All rights reserved.
	* Copyright (c) 2014, 2015, Red Hat Inc. All rights reserved.
	* Copyright (c) 2020, 2021, Huawei Technologies Co., Ltd. All rights reserved.
	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
	*
	* This code is free software; you can redistribute it and/or modify it
	* under the terms of the GNU General Public License version 2 only, as
	* published by the Free Software Foundation.
	*
	* This code is distributed in the hope that it will be useful, but WITHOUT
	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
	* version 2 for more details (a copy is included in the LICENSE file that
	* accompanied this code).
	*
	* You should have received a copy of the GNU General Public License version
	* 2 along with this work; if not, write to the Free Software Foundation,
	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
	*
	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
	* or visit www.oracle.com if you need additional information or have any
	* questions.
	*
	*/

	#ifndef CPU_RISCV_INTERP_MASM_RISCV_HPP
	#define CPU_RISCV_INTERP_MASM_RISCV_HPP

	#include "asm/macroAssembler.hpp"
	#include "interpreter/invocationCounter.hpp"
	#include "runtime/frame.hpp"

	// This file specializes the assembler with interpreter-specific macros

	typedef ByteSize (*OffsetFunction)(uint);

	class InterpreterMacroAssembler: public MacroAssembler {
	protected:
	// Interpreter specific version of call_VM_base
	using MacroAssembler::call_VM_leaf_base;

	virtual void call_VM_leaf_base(address entry_point,
	int number_of_arguments);

	virtual void call_VM_base(Register oop_result,
	Register java_thread,
	Register last_java_sp,
	address entry_point,
	int number_of_arguments,
	bool check_exceptions);

	// base routine for all dispatches
	void dispatch_base(TosState state, address* table, bool verifyoop = true,
	bool generate_poll = false, Register Rs = t0);

	public:
	InterpreterMacroAssembler(CodeBuffer* code) : MacroAssembler(code) {}

	void load_earlyret_value(TosState state);

	void call_VM_preemptable(Register oop_result,
	address entry_point,
	Register arg_1);
	void restore_after_resume(bool is_native);

	void jump_to_entry(address entry);

	virtual void check_and_handle_popframe(Register java_thread);
	virtual void check_and_handle_earlyret(Register java_thread);

	// Interpreter-specific registers
	void save_bcp() {
	sd(xbcp, Address(fp, frame::interpreter_frame_bcp_offset * wordSize));
	}

	void restore_bcp() {
	ld(xbcp, Address(fp, frame::interpreter_frame_bcp_offset * wordSize));
	}

	void restore_locals() {
	ld(xlocals, Address(fp, frame::interpreter_frame_locals_offset * wordSize));
	shadd(xlocals, xlocals, fp, t0, LogBytesPerWord);
	}

	void restore_constant_pool_cache() {
	ld(xcpool, Address(fp, frame::interpreter_frame_cache_offset * wordSize));
	}

	void restore_sp_after_call() {
	Label L;
	ld(t0, Address(fp, frame::interpreter_frame_extended_sp_offset * wordSize));
	shadd(t0, t0, fp, t0, LogBytesPerWord);
	#ifdef ASSERT
	bnez(t0, L);
	stop("SP is null");
	#endif
	bind(L);
	mv(sp, t0);
	}

	void check_extended_sp(const char* msg = "check extended SP") {
	#ifdef ASSERT
	Label L;
	ld(t0, Address(fp, frame::interpreter_frame_extended_sp_offset * wordSize));
	shadd(t0, t0, fp, t0, LogBytesPerWord);
	beq(sp, t0, L);
	stop(msg);
	bind(L);
	#endif
	}

	#define check_extended_sp() \
	check_extended_sp("SP does not match extended SP in frame at " __FILE__ ":" XSTR(__LINE__))

	void get_dispatch();

	// Helpers for runtime call arguments/results
	void get_method(Register reg) {
	ld(reg, Address(fp, frame::interpreter_frame_method_offset * wordSize));
	}

	void get_const(Register reg) {
	get_method(reg);
	ld(reg, Address(reg, in_bytes(Method::const_offset())));
	}

	void get_constant_pool(Register reg) {
	get_const(reg);
	ld(reg, Address(reg, in_bytes(ConstMethod::constants_offset())));
	}

	void get_constant_pool_cache(Register reg) {
	get_constant_pool(reg);
	ld(reg, Address(reg, ConstantPool::cache_offset()));
	}

	void get_cpool_and_tags(Register cpool, Register tags) {
	get_constant_pool(cpool);
	ld(tags, Address(cpool, ConstantPool::tags_offset()));
	}

	void get_unsigned_2_byte_index_at_bcp(Register reg, int bcp_offset);
	void get_cache_index_at_bcp(Register index, Register tmp, int bcp_offset, size_t index_size = sizeof(u2));
	void get_method_counters(Register method, Register mcs, Label& skip);

	// Load cpool->resolved_references(index).
	void load_resolved_reference_at_index(Register result, Register index, Register tmp = x15);

	// Load cpool->resolved_klass_at(index).
	void load_resolved_klass_at_offset(Register cpool, Register index, Register klass, Register temp);

	void pop_ptr(Register r = x10);
	void pop_i(Register r = x10);
	void pop_l(Register r = x10);
	void pop_f(FloatRegister r = f10);
	void pop_d(FloatRegister r = f10);
	void push_ptr(Register r = x10);
	void push_i(Register r = x10);
	void push_l(Register r = x10);
	void push_f(FloatRegister r = f10);
	void push_d(FloatRegister r = f10);

	void pop(TosState state); // transition vtos -> state
	void push(TosState state); // transition state -> vtos

	void empty_expression_stack() {
	ld(t0, Address(fp, frame::interpreter_frame_monitor_block_top_offset * wordSize));
	shadd(esp, t0, fp, t0, LogBytesPerWord);
	// null last_sp until next java call
	sd(zr, Address(fp, frame::interpreter_frame_last_sp_offset * wordSize));
	}

	// Helpers for swap and dup
	void load_ptr(int n, Register val);
	void store_ptr(int n, Register val);

	// Load float value from 'address'. The value is loaded onto the fp register f10.
	void load_float(Address src);
	void load_double(Address src);

	// Generate a subtype check: branch to ok_is_subtype if sub_klass is
	// a subtype of super_klass.
	void gen_subtype_check( Register sub_klass, Label &ok_is_subtype );

	// Dispatching
	void dispatch_prolog(TosState state, int step = 0);
	void dispatch_epilog(TosState state, int step = 0);
	// dispatch via t0
	void dispatch_only(TosState state, bool generate_poll = false, Register Rs = t0);
	// dispatch normal table via t0 (assume t0 is loaded already)
	void dispatch_only_normal(TosState state, Register Rs = t0);
	void dispatch_only_noverify(TosState state, Register Rs = t0);
	// load t0 from [xbcp + step] and dispatch via t0
	void dispatch_next(TosState state, int step = 0, bool generate_poll = false);
	// load t0 from [xbcp] and dispatch via t0 and table
	void dispatch_via (TosState state, address* table);

	// jump to an invoked target
	void prepare_to_jump_from_interpreted();
	void jump_from_interpreted(Register method);


	// Returning from interpreted functions
	//
	// Removes the current activation (incl. unlocking of monitors)
	// and sets up the return address. This code is also used for
	// exception unwindwing. In that case, we do not want to throw
	// IllegalMonitorStateExceptions, since that might get us into an
	// infinite rethrow exception loop.
	// Additionally this code is used for popFrame and earlyReturn.
	// In popFrame case we want to skip throwing an exception,
	// installing an exception, and notifying jvmdi.
	// In earlyReturn case we only want to skip throwing an exception
	// and installing an exception.
	void remove_activation(TosState state,
	bool throw_monitor_exception = true,
	bool install_monitor_exception = true,
	bool notify_jvmdi = true);

	// FIXME: Give us a valid frame at a null check.
	virtual void null_check(Register reg, int offset = -1) {
	MacroAssembler::null_check(reg, offset);
	}

	// Object locking
	void lock_object (Register lock_reg);
	void unlock_object(Register lock_reg);

	// Interpreter profiling operations
	void set_method_data_pointer_for_bcp();
	void test_method_data_pointer(Register mdp, Label& zero_continue);
	void verify_method_data_pointer();

	void set_mdp_data_at(Register mdp_in, int constant, Register value);
	void increment_mdp_data_at(Register mdp_in, int constant);
	void increment_mdp_data_at(Register mdp_in, Register index, int constant);
	void increment_mask_and_jump(Address counter_addr,
	int increment, Address mask,
	Register tmp1, Register tmp2,
	bool preloaded, Label* where);

	void set_mdp_flag_at(Register mdp_in, int flag_constant);
	void test_mdp_data_at(Register mdp_in, int offset, Register value,
	Register test_value_out,
	Label& not_equal_continue);

	void record_klass_in_profile(Register receiver, Register mdp,
	Register reg2);
	void record_klass_in_profile_helper(Register receiver, Register mdp,
	Register reg2, Label& done);
	void record_item_in_profile_helper(Register item, Register mdp,
	Register reg2, int start_row, Label& done, int total_rows,
	OffsetFunction item_offset_fn, OffsetFunction item_count_offset_fn);

	void update_mdp_by_offset(Register mdp_in, int offset_of_offset);
	void update_mdp_by_offset(Register mdp_in, Register reg, int offset_of_disp);
	void update_mdp_by_constant(Register mdp_in, int constant);
	void update_mdp_for_ret(Register return_bci);

	// narrow int return value
	void narrow(Register result);

	void profile_taken_branch(Register mdp, Register bumped_count);
	void profile_not_taken_branch(Register mdp);
	void profile_call(Register mdp);
	void profile_final_call(Register mdp);
	void profile_virtual_call(Register receiver, Register mdp,
	Register t1,
	bool receiver_can_be_null = false);
	void profile_ret(Register return_bci, Register mdp);
	void profile_null_seen(Register mdp);
	void profile_typecheck(Register mdp, Register klass, Register temp);
	void profile_typecheck_failed(Register mdp);
	void profile_switch_default(Register mdp);
	void profile_switch_case(Register index_in_scratch, Register mdp,
	Register temp);

	void profile_obj_type(Register obj, const Address& mdo_addr, Register tmp);
	void profile_arguments_type(Register mdp, Register callee, Register tmp, bool is_virtual);
	void profile_return_type(Register mdp, Register ret, Register tmp);
	void profile_parameters_type(Register mdp, Register tmp1, Register tmp2, Register tmp3);

	typedef enum { NotifyJVMTI, SkipNotifyJVMTI } NotifyMethodExitMode;

	// support for jvmti/dtrace
	void notify_method_entry();
	void notify_method_exit(TosState state, NotifyMethodExitMode mode);

	JFR_ONLY(void enter_jfr_critical_section();)
	JFR_ONLY(void leave_jfr_critical_section();)

	virtual void _call_Unimplemented(address call_site) {
	save_bcp();
	set_last_Java_frame(esp, fp, (address) pc(), t0);
	MacroAssembler::_call_Unimplemented(call_site);
	}

	void load_resolved_indy_entry(Register cache, Register index);
	void load_field_entry(Register cache, Register index, int bcp_offset = 1);
	void load_method_entry(Register cache, Register index, int bcp_offset = 1);

	void verify_field_offset(Register reg) NOT_DEBUG_RETURN;

	#ifdef ASSERT
	void verify_access_flags(Register access_flags, uint32_t flag,
	const char* msg, bool stop_by_hit = true);
	void verify_frame_setup();
	#endif
	};

	#endif // CPU_RISCV_INTERP_MASM_RISCV_HPP