1 /*
2 * Copyright (c) 2020, 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_RUNTIME_STACKCHUNKFRAMESTREAM_HPP
26 #define SHARE_RUNTIME_STACKCHUNKFRAMESTREAM_HPP
27
28 #include "memory/allocation.hpp"
29 #include "oops/oopsHierarchy.hpp"
30 #include "utilities/globalDefinitions.hpp"
31 #include "utilities/macros.hpp"
32
33 class CodeBlob;
34 class frame;
35 class ImmutableOopMap;
36 class RegisterMap;
37 class VMRegImpl;
38 typedef VMRegImpl* VMReg;
39
40 enum ChunkFrames { CompiledOnly, Mixed };
41
42 template <ChunkFrames frame_kind>
43 class StackChunkFrameStream : public StackObj {
44 private:
45 intptr_t* _end;
46 intptr_t* _sp;
47 intptr_t* _unextended_sp; // used only when mixed
48 CodeBlob* _cb;
49 mutable const ImmutableOopMap* _oopmap;
50
51 #ifndef PRODUCT
52 stackChunkOop _chunk;
53 int _index;
54 #endif
55
56 #ifdef ASSERT
57 int _has_stub;
58 #endif
59
60 public:
61 StackChunkFrameStream() { NOT_PRODUCT(_chunk = nullptr; _index = -1;) DEBUG_ONLY(_has_stub = false;) }
62 inline StackChunkFrameStream(stackChunkOop chunk);
63 inline StackChunkFrameStream(stackChunkOop chunk, const frame& f);
64
65 bool is_done() const { return _sp >= _end; }
66
67 // Query
68 intptr_t* sp() const { return _sp; }
69 inline address pc() const { return get_pc(); }
70 inline intptr_t* fp() const;
71 inline intptr_t* unextended_sp() const { return frame_kind == ChunkFrames::Mixed ? _unextended_sp : _sp; }
72 inline address orig_pc() const;
73
74 inline bool is_interpreted() const;
75 inline bool is_stub() const;
76 inline bool is_compiled() const;
77 CodeBlob* cb() const { return _cb; }
78 const ImmutableOopMap* oopmap() const { if (_oopmap == nullptr) get_oopmap(); return _oopmap; }
79 inline int frame_size() const;
80 inline int stack_argsize() const;
81 inline int num_oops() const;
82
83 inline void initialize_register_map(RegisterMap* map);
84 template <typename RegisterMapT> inline void next(RegisterMapT* map, bool stop = false);
85
86 template <typename RegisterMapT> inline void update_reg_map(RegisterMapT* map);
87
88 void handle_deopted() const;
89
90 inline frame to_frame() const;
91
92 #ifdef ASSERT
93 bool is_in_frame(void* p) const;
94 template <typename RegisterMapT> bool is_in_oops(void* p, const RegisterMapT* map) const;
95 #endif
96
97 void print_on(outputStream* st) const PRODUCT_RETURN;
98
99 private:
100 inline address get_pc() const;
101 inline void get_cb();
102
103 inline int interpreter_frame_size() const;
104 inline int interpreter_frame_num_oops() const;
105 inline int interpreter_frame_stack_argsize() const;
106 inline void next_for_interpreter_frame();
107 inline intptr_t* unextended_sp_for_interpreter_frame() const;
108 inline intptr_t* derelativize(int offset) const;
109 inline void get_oopmap() const;
110 inline void get_oopmap(address pc, int oopmap_slot) const;
111
112 template <typename RegisterMapT> inline void update_reg_map_pd(RegisterMapT* map);
113
114 template <typename RegisterMapT>
115 inline void* reg_to_loc(VMReg reg, const RegisterMapT* map) const;
116
117 void assert_is_interpreted_and_frame_type_mixed() const NOT_DEBUG_RETURN;
118
119 public:
120 template <class OopClosureType, class RegisterMapT>
121 inline void iterate_oops(OopClosureType* closure, const RegisterMapT* map) const;
122 template <class DerivedOopClosureType, class RegisterMapT>
123 inline void iterate_derived_pointers(DerivedOopClosureType* closure, const RegisterMapT* map) const;
124 };
125
126 #endif // SHARE_RUNTIME_STACKCHUNKFRAMESTREAM_HPP