1 /* 2 * Copyright (c) 2022, 2024, 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_CONTINUATIONHELPER_X86_INLINE_HPP 26 #define CPU_X86_CONTINUATIONHELPER_X86_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() - frame::sender_sp_offset); 41 } 42 43 static inline void patch_return_pc_with_preempt_stub(frame& f) { 44 if (f.is_runtime_frame()) { 45 // Patch the pc of the now old last Java frame (we already set the anchor to enterSpecial) 46 // so that when target goes back to Java it will actually return to the preempt cleanup stub. 47 intptr_t* sp = f.sp(); 48 sp[-1] = (intptr_t)StubRoutines::cont_preempt_stub(); 49 } else { 50 // The target will check for preemption once it returns to the interpreter 51 // or the native wrapper code and will manually jump to the preempt stub. 52 JavaThread *thread = JavaThread::current(); 53 DEBUG_ONLY(Method* m = f.is_interpreted_frame() ? f.interpreter_frame_method() : f.cb()->as_nmethod()->method();) 54 assert(m->is_object_wait0() || thread->interp_at_preemptable_vmcall_cnt() > 0, 55 "preemptable VM call not using call_VM_preemptable"); 56 thread->set_preempt_alternate_return(StubRoutines::cont_preempt_stub()); 57 } 58 } 59 60 inline int ContinuationHelper::frame_align_words(int size) { 61 return size & 1; 62 } 63 64 inline intptr_t* ContinuationHelper::frame_align_pointer(intptr_t* sp) { 65 return align_down(sp, frame::frame_alignment); 66 } 67 68 template<typename FKind> 69 inline void ContinuationHelper::update_register_map(const frame& f, RegisterMap* map) { 70 frame::update_map_with_saved_link(map, link_address<FKind>(f)); 71 } 72 73 inline void ContinuationHelper::update_register_map_with_callee(const frame& f, RegisterMap* map) { 74 frame::update_map_with_saved_link(map, ContinuationHelper::Frame::callee_link_address(f)); 75 } 76 77 inline void ContinuationHelper::push_pd(const frame& f) { 78 *(intptr_t**)(f.sp() - frame::sender_sp_offset) = f.fp(); 79 } 80 81 inline void ContinuationHelper::set_anchor_to_entry_pd(JavaFrameAnchor* anchor, ContinuationEntry* entry) { 82 anchor->set_last_Java_fp(entry->entry_fp()); 83 } 84 85 inline void ContinuationHelper::set_anchor_pd(JavaFrameAnchor* anchor, intptr_t* sp) { 86 intptr_t* fp = *(intptr_t**)(sp - frame::sender_sp_offset); 87 anchor->set_last_Java_fp(fp); 88 } 89 90 #ifdef ASSERT 91 inline bool ContinuationHelper::Frame::assert_frame_laid_out(frame f) { 92 intptr_t* sp = f.sp(); 93 address pc = *(address*)(sp - frame::sender_sp_ret_address_offset()); 94 intptr_t* fp = *(intptr_t**)(sp - frame::sender_sp_offset); 95 assert(f.raw_pc() == pc, "f.ra_pc: " INTPTR_FORMAT " actual: " INTPTR_FORMAT, p2i(f.raw_pc()), p2i(pc)); 96 assert(f.fp() == fp, "f.fp: " INTPTR_FORMAT " actual: " INTPTR_FORMAT, p2i(f.fp()), p2i(fp)); 97 return f.raw_pc() == pc && f.fp() == fp; 98 } 99 #endif 100 101 inline intptr_t** ContinuationHelper::Frame::callee_link_address(const frame& f) { 102 return (intptr_t**)(f.sp() - frame::sender_sp_offset); 103 } 104 105 inline address* ContinuationHelper::Frame::return_pc_address(const frame& f) { 106 return (address*)(f.real_fp() - 1); 107 } 108 109 inline address* ContinuationHelper::InterpretedFrame::return_pc_address(const frame& f) { 110 return (address*)(f.fp() + frame::return_addr_offset); 111 } 112 113 inline void ContinuationHelper::InterpretedFrame::patch_sender_sp(frame& f, const frame& caller) { 114 intptr_t* sp = caller.unextended_sp(); 115 assert(f.is_interpreted_frame(), ""); 116 intptr_t* la = f.addr_at(frame::interpreter_frame_sender_sp_offset); 117 *la = f.is_heap_frame() ? (intptr_t)(sp - f.fp()) : (intptr_t)sp; 118 } 119 120 inline address ContinuationHelper::Frame::real_pc(const frame& f) { 121 address* pc_addr = &(((address*) f.sp())[-1]); 122 return *pc_addr; 123 } 124 125 inline void ContinuationHelper::Frame::patch_pc(const frame& f, address pc) { 126 address* pc_addr = &(((address*) f.sp())[-1]); 127 *pc_addr = pc; 128 } 129 130 inline intptr_t* ContinuationHelper::InterpretedFrame::frame_top(const frame& f, InterpreterOopMap* mask) { // inclusive; this will be copied with the frame 131 // interpreter_frame_last_sp_offset, points to unextended_sp includes arguments in the frame 132 // interpreter_frame_initial_sp_offset excludes expression stack slots 133 int expression_stack_sz = expression_stack_size(f, mask); 134 intptr_t* res = (intptr_t*)f.at_relative(frame::interpreter_frame_initial_sp_offset) - expression_stack_sz; 135 assert(res == (intptr_t*)f.interpreter_frame_monitor_end() - expression_stack_sz, ""); 136 assert(res >= f.unextended_sp(), 137 "res: " INTPTR_FORMAT " initial_sp: " INTPTR_FORMAT " last_sp: " INTPTR_FORMAT " unextended_sp: " INTPTR_FORMAT " expression_stack_size: %d", 138 p2i(res), p2i(f.addr_at(frame::interpreter_frame_initial_sp_offset)), f.at_relative_or_null(frame::interpreter_frame_last_sp_offset), 139 p2i(f.unextended_sp()), expression_stack_sz); 140 return res; 141 } 142 143 inline intptr_t* ContinuationHelper::InterpretedFrame::frame_bottom(const frame& f) { // exclusive; this will not be copied with the frame 144 return (intptr_t*)f.at_relative(frame::interpreter_frame_locals_offset) + 1; // exclusive, so we add 1 word 145 } 146 147 inline intptr_t* ContinuationHelper::InterpretedFrame::frame_top(const frame& f, int callee_argsize, bool callee_interpreted) { 148 return f.unextended_sp() + (callee_interpreted ? callee_argsize : 0); 149 } 150 151 inline intptr_t* ContinuationHelper::InterpretedFrame::callers_sp(const frame& f) { 152 return f.fp() + frame::metadata_words; 153 } 154 155 #endif // CPU_X86_CONTINUATIONHELPER_X86_INLINE_HPP