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 SHARE_VM_RUNTIME_CONTINUATIONHELPER_HPP
26 #define SHARE_VM_RUNTIME_CONTINUATIONHELPER_HPP
27
28 #include "code/scopeDesc.hpp"
29 #include "compiler/oopMap.hpp"
30 #include "memory/allStatic.hpp"
31 #include "runtime/frame.hpp"
32 #include "runtime/stackValue.hpp"
33
34 // Helper, all-static
35 class ContinuationEntry;
36
37 class ContinuationHelper {
38 public:
39 static inline void set_anchor_pd(JavaFrameAnchor* anchor, intptr_t* sp);
40 static inline void set_anchor_to_entry_pd(JavaFrameAnchor* anchor, ContinuationEntry* entry);
41
42 template<typename FKind> static void update_register_map(const frame& f, RegisterMap* map);
43 static inline void update_register_map_with_callee(const frame& f, RegisterMap* map);
44
45 static inline void push_pd(const frame& f);
46
47 static inline address return_address_at(intptr_t* sp);
48 static inline void patch_return_address_at(intptr_t* sp, address pc);
49
50 static inline int frame_align_words(int size);
51 static inline intptr_t* frame_align_pointer(intptr_t* sp);
52
53 // Abstract helpers for describing frames in general
54 class Frame;
55 class NonInterpretedFrame;
56
57 // Concrete helpers for describing concrete types of frames
58 class InterpretedFrame;
59 class NonInterpretedUnknownFrame;
60 class CompiledFrame;
61 class StubFrame;
62 };
63
64 class ContinuationHelper::Frame : public AllStatic {
65 public:
66 static const bool interpreted = false;
67 static const bool stub = false;
68
69 static inline intptr_t** callee_link_address(const frame& f);
70 static Method* frame_method(const frame& f);
71 static inline address real_pc(const frame& f);
72 static inline void patch_pc(const frame& f, address pc);
73 static address* return_pc_address(const frame& f);
74 static address return_pc(const frame& f);
75 static bool is_stub(CodeBlob* cb);
76
77 #ifdef ASSERT
78 static inline intptr_t* frame_top(const frame &f);
79 static inline bool is_deopt_return(address pc, const frame& sender);
80 static bool assert_frame_laid_out(frame f);
81 #endif
82 };
83
84 class ContinuationHelper::InterpretedFrame : public ContinuationHelper::Frame {
85 public:
86 static const bool interpreted = true;
87
88 static inline intptr_t* frame_top(const frame& f, InterpreterOopMap* mask);
89 static inline intptr_t* frame_top(const frame& f);
90 static inline intptr_t* frame_top(const frame& f, int callee_argsize, bool callee_interpreted);
91 static inline intptr_t* frame_bottom(const frame& f);
92 static inline intptr_t* callers_sp(const frame& f);
93 static inline int stack_argsize(const frame& f);
94
95 static inline address* return_pc_address(const frame& f);
96 static address return_pc(const frame& f);
97 static void patch_sender_sp(frame& f, const frame& caller);
98
99 static int size(const frame& f);
100 static inline int expression_stack_size(const frame &f, InterpreterOopMap* mask);
101
102 #ifdef ASSERT
103 static bool is_owning_locks(const frame& f);
104 #endif
105
106 static bool is_instance(const frame& f);
107
108 typedef InterpreterOopMap* ExtraT;
109 };
110
111 class ContinuationHelper::NonInterpretedFrame : public ContinuationHelper::Frame {
112 public:
113 static inline intptr_t* frame_top(const frame& f, int callee_argsize, bool callee_interpreted);
114 static inline intptr_t* frame_top(const frame& f);
115 static inline intptr_t* frame_bottom(const frame& f);
116
117 static inline int size(const frame& f);
118 static inline int stack_argsize(const frame& f);
119 };
120
121 class ContinuationHelper::NonInterpretedUnknownFrame : public ContinuationHelper::NonInterpretedFrame {
122 public:
123 static bool is_instance(const frame& f);
124 };
125
126 class ContinuationHelper::CompiledFrame : public ContinuationHelper::NonInterpretedFrame {
127 public:
128 static bool is_instance(const frame& f);
129
130 #ifdef ASSERT
131 template <typename RegisterMapT>
132 static bool is_owning_locks(JavaThread* thread, RegisterMapT* map, const frame& f);
133 #endif
134 };
135
136 class ContinuationHelper::StubFrame : public ContinuationHelper::NonInterpretedFrame {
137 public:
138 static const bool stub = true;
139
140 static bool is_instance(const frame& f);
141 };
142
143 #endif // SHARE_VM_RUNTIME_CONTINUATIONHELPER_HPP