1 /*
  2  * Copyright (c) 2022, 2023, 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_RISCV_CONTINUATIONHELPER_RISCV_INLINE_HPP
 26 #define CPU_RISCV_CONTINUATIONHELPER_RISCV_INLINE_HPP
 27 
 28 #include "runtime/continuationHelper.hpp"
 29 
 30 #include "runtime/continuationEntry.inline.hpp"
 31 #include "runtime/frame.inline.hpp"
 32 #include "runtime/registerMap.hpp"
 33 #include "utilities/macros.hpp"
 34 
 35 template<typename FKind>
 36 static inline intptr_t** link_address(const frame& f) {
 37   assert(FKind::is_instance(f), "");
 38   return FKind::interpreted
 39             ? (intptr_t**)(f.fp() + frame::link_offset)
 40             : (intptr_t**)(f.unextended_sp() + f.cb()->frame_size() - 2);
 41 }
 42 
 43 static inline void patch_return_pc_with_preempt_stub(frame& f) {
 44   Unimplemented();
 45 }
 46 
 47 inline int ContinuationHelper::frame_align_words(int size) {
 48 #ifdef _LP64
 49   return size & 1;
 50 #else
 51   return 0;
 52 #endif
 53 }
 54 
 55 inline intptr_t* ContinuationHelper::frame_align_pointer(intptr_t* sp) {
 56 #ifdef _LP64
 57   sp = align_down(sp, frame::frame_alignment);
 58 #endif
 59   return sp;
 60 }
 61 
 62 template<typename FKind>
 63 inline void ContinuationHelper::update_register_map(const frame& f, RegisterMap* map) {
 64   frame::update_map_with_saved_link(map, link_address<FKind>(f));
 65 }
 66 
 67 inline void ContinuationHelper::update_register_map_with_callee(const frame& f, RegisterMap* map) {
 68   frame::update_map_with_saved_link(map, ContinuationHelper::Frame::callee_link_address(f));
 69 }
 70 
 71 inline void ContinuationHelper::push_pd(const frame& f) {
 72   *(intptr_t**)(f.sp() - 2) = f.fp();
 73 }
 74 
 75 inline void ContinuationHelper::set_anchor_to_entry_pd(JavaFrameAnchor* anchor, ContinuationEntry* entry) {
 76   anchor->set_last_Java_fp(entry->entry_fp());
 77 }
 78 
 79 inline void ContinuationHelper::set_anchor_pd(JavaFrameAnchor* anchor, intptr_t* sp) {
 80   intptr_t* fp = *(intptr_t**)(sp - 2);
 81   anchor->set_last_Java_fp(fp);
 82 }
 83 
 84 #ifdef ASSERT
 85 inline bool ContinuationHelper::Frame::assert_frame_laid_out(frame f) {
 86   intptr_t* sp = f.sp();
 87   address pc = *(address*)(sp - frame::sender_sp_ret_address_offset());
 88   intptr_t* fp = *(intptr_t**)(sp - 2);
 89   assert(f.raw_pc() == pc, "f.ra_pc: " INTPTR_FORMAT " actual: " INTPTR_FORMAT, p2i(f.raw_pc()), p2i(pc));
 90   assert(f.fp() == fp, "f.fp: " INTPTR_FORMAT " actual: " INTPTR_FORMAT, p2i(f.fp()), p2i(fp));
 91   return f.raw_pc() == pc && f.fp() == fp;
 92 }
 93 #endif
 94 
 95 inline intptr_t** ContinuationHelper::Frame::callee_link_address(const frame& f) {
 96   return (intptr_t**)(f.sp() - 2);
 97 }
 98 
 99 inline address* ContinuationHelper::Frame::return_pc_address(const frame& f) {
100   return (address*)(f.real_fp() - 1);
101 }
102 
103 inline address* ContinuationHelper::InterpretedFrame::return_pc_address(const frame& f) {
104   return (address*)(f.fp() + frame::return_addr_offset);
105 }
106 
107 inline void ContinuationHelper::InterpretedFrame::patch_sender_sp(frame& f, const frame& caller) {
108   intptr_t* sp = caller.unextended_sp();
109   assert(f.is_interpreted_frame(), "");
110   intptr_t* la = f.addr_at(frame::interpreter_frame_sender_sp_offset);
111   *la = f.is_heap_frame() ? (intptr_t)(sp - f.fp()) : (intptr_t)sp;
112 }
113 
114 inline address ContinuationHelper::Frame::real_pc(const frame& f) {
115   address* pc_addr = &(((address*) f.sp())[-1]);
116   return *pc_addr;
117 }
118 
119 inline void ContinuationHelper::Frame::patch_pc(const frame& f, address pc) {
120   address* pc_addr = &(((address*) f.sp())[-1]);
121   *pc_addr = pc;
122 }
123 
124 inline intptr_t* ContinuationHelper::InterpretedFrame::frame_top(const frame& f, InterpreterOopMap* mask) { // inclusive; this will be copied with the frame
125   // interpreter_frame_last_sp_offset, points to unextended_sp includes arguments in the frame
126   // interpreter_frame_initial_sp_offset excludes expression stack slots
127   int expression_stack_sz = expression_stack_size(f, mask);
128   intptr_t* res = (intptr_t*)f.at_relative(frame::interpreter_frame_initial_sp_offset) - expression_stack_sz;
129   assert(res == (intptr_t*)f.interpreter_frame_monitor_end() - expression_stack_sz, "");
130   assert(res >= f.unextended_sp(),
131     "res: " INTPTR_FORMAT " initial_sp: " INTPTR_FORMAT " last_sp: " INTPTR_FORMAT " unextended_sp: " INTPTR_FORMAT " expression_stack_size: %d",
132     p2i(res), p2i(f.addr_at(frame::interpreter_frame_initial_sp_offset)), f.at_relative_or_null(frame::interpreter_frame_last_sp_offset),
133     p2i(f.unextended_sp()), expression_stack_sz);
134   return res;
135 }
136 
137 inline intptr_t* ContinuationHelper::InterpretedFrame::frame_bottom(const frame& f) { // exclusive; this will not be copied with the frame
138   return (intptr_t*)f.at_relative(frame::interpreter_frame_locals_offset) + 1; // exclusive, so we add 1 word
139 }
140 
141 inline intptr_t* ContinuationHelper::InterpretedFrame::frame_top(const frame& f, int callee_argsize, bool callee_interpreted) {
142   return f.unextended_sp() + (callee_interpreted ? callee_argsize : 0);
143 }
144 
145 inline intptr_t* ContinuationHelper::InterpretedFrame::callers_sp(const frame& f) {
146   return f.fp();
147 }
148 
149 #endif // CPU_RISCV_CONTINUATIONFRAMEHELPERS_RISCV_INLINE_HPP