1 /*
2 * Copyright (c) 1997, 2010, 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_VFRAMEARRAY_HPP
26 #define SHARE_VM_RUNTIME_VFRAMEARRAY_HPP
27
28 #include "oops/arrayOop.hpp"
29 #include "runtime/deoptimization.hpp"
30 #include "runtime/frame.inline.hpp"
31 #include "runtime/monitorChunk.hpp"
32 #include "utilities/growableArray.hpp"
33
34 // A vframeArray is an array used for momentarily storing off stack Java method activations
35 // during deoptimization. Essentially it is an array of vframes where each vframe
36 // data is stored off stack. This structure will never exist across a safepoint so
37 // there is no need to gc any oops that are stored in the structure.
38
39
40 class LocalsClosure;
41 class ExpressionStackClosure;
42 class MonitorStackClosure;
43 class MonitorArrayElement;
44 class StackValueCollection;
45
46 // A vframeArrayElement is an element of a vframeArray. Each element
47 // represent an interpreter frame which will eventually be created.
48
49 class vframeArrayElement : public _ValueObj {
50 private:
51
52 frame _frame; // the interpreter frame we will unpack into
53 int _bci; // raw bci for this vframe
54 bool _reexecute; // whether sould we reexecute this bytecode
55 methodOop _method; // the method for this vframe
56 MonitorChunk* _monitors; // active monitors for this vframe
57 StackValueCollection* _locals;
58 StackValueCollection* _expressions;
59
60 public:
61
62 frame* iframe(void) { return &_frame; }
63
64 int bci(void) const;
65
66 int raw_bci(void) const { return _bci; }
67 bool should_reexecute(void) const { return _reexecute; }
68
69 methodOop method(void) const { return _method; }
70
71 MonitorChunk* monitors(void) const { return _monitors; }
72
73 void free_monitors(JavaThread* jt);
74
75 StackValueCollection* locals(void) const { return _locals; }
76
77 StackValueCollection* expressions(void) const { return _expressions; }
78
79 void fill_in(compiledVFrame* vf);
80
81 // Formerly part of deoptimizedVFrame
82
83
84 // Returns the on stack word size for this frame
85 // callee_parameters is the number of callee locals residing inside this frame
86 int on_stack_size(int callee_parameters,
87 int callee_locals,
88 bool is_top_frame,
89 int popframe_extra_stack_expression_els) const;
90
91 // Unpacks the element to skeletal interpreter frame
92 void unpack_on_stack(int callee_parameters,
93 int callee_locals,
94 frame* caller,
95 bool is_top_frame,
96 int exec_mode);
97
98 #ifndef PRODUCT
99 void print(outputStream* st);
100 #endif /* PRODUCT */
101 };
102
103 // this can be a ResourceObj if we don't save the last one...
104 // but it does make debugging easier even if we can't look
105 // at the data in each vframeElement
106
107 class vframeArray: public CHeapObj {
108 private:
109
110
111 // Here is what a vframeArray looks like in memory
112
113 /*
114 fixed part
115 description of the original frame
116 _frames - number of vframes in this array
117 adapter info
118 callee register save area
119 variable part
120 vframeArrayElement [ 0 ]
121 ...
122 vframeArrayElement [_frames - 1]
123
124 */
125
126 JavaThread* _owner_thread;
127 vframeArray* _next;
128 frame _original; // the original frame of the deoptee
129 frame _caller; // caller of root frame in vframeArray
130 frame _sender;
131
132 Deoptimization::UnrollBlock* _unroll_block;
133 int _frame_size;
134
135 int _frames; // number of javavframes in the array (does not count any adapter)
136
137 intptr_t _callee_registers[RegisterMap::reg_count];
138 unsigned char _valid[RegisterMap::reg_count];
139
140 vframeArrayElement _elements[1]; // First variable section.
141
142 void fill_in_element(int index, compiledVFrame* vf);
143
144 bool is_location_valid(int i) const { return _valid[i] != 0; }
145 void set_location_valid(int i, bool valid) { _valid[i] = valid; }
146
147 public:
148
149
150 // Tells whether index is within bounds.
151 bool is_within_bounds(int index) const { return 0 <= index && index < frames(); }
152
153 // Accessores for instance variable
154 int frames() const { return _frames; }
155
156 static vframeArray* allocate(JavaThread* thread, int frame_size, GrowableArray<compiledVFrame*>* chunk,
157 RegisterMap* reg_map, frame sender, frame caller, frame self);
158
159
160 vframeArrayElement* element(int index) { assert(is_within_bounds(index), "Bad index"); return &_elements[index]; }
161
162 // Allocates a new vframe in the array and fills the array with vframe information in chunk
163 void fill_in(JavaThread* thread, int frame_size, GrowableArray<compiledVFrame*>* chunk, const RegisterMap *reg_map);
164
165 // Returns the owner of this vframeArray
166 JavaThread* owner_thread() const { return _owner_thread; }
167
168 // Accessors for next
169 vframeArray* next() const { return _next; }
170 void set_next(vframeArray* value) { _next = value; }
171
172 // Accessors for sp
173 intptr_t* sp() const { return _original.sp(); }
174
175 intptr_t* unextended_sp() const { return _original.unextended_sp(); }
176
177 address original_pc() const { return _original.pc(); }
178
179 frame original() const { return _original; }
180
181 frame caller() const { return _caller; }
182
183 frame sender() const { return _sender; }
184
185 // Accessors for unroll block
186 Deoptimization::UnrollBlock* unroll_block() const { return _unroll_block; }
187 void set_unroll_block(Deoptimization::UnrollBlock* block) { _unroll_block = block; }
188
189 // Returns the size of the frame that got deoptimized
190 int frame_size() const { return _frame_size; }
191
192 // Unpack the array on the stack passed in stack interval
193 void unpack_to_stack(frame &unpack_frame, int exec_mode);
194
195 // Deallocates monitor chunks allocated during deoptimization.
196 // This should be called when the array is not used anymore.
197 void deallocate_monitor_chunks();
198
199
200
201 // Accessor for register map
202 address register_location(int i) const;
203
204 void print_on_2(outputStream* st) PRODUCT_RETURN;
205 void print_value_on(outputStream* st) const PRODUCT_RETURN;
206
207 #ifndef PRODUCT
208 // Comparing
209 bool structural_compare(JavaThread* thread, GrowableArray<compiledVFrame*>* chunk);
210 #endif
211
212 };
213
214 #endif // SHARE_VM_RUNTIME_VFRAMEARRAY_HPP