1 /*
2 * Copyright (c) 2003, 2019, 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 #include "precompiled.hpp"
26 #include "classfile/stackMapFrame.hpp"
27 #include "classfile/verifier.hpp"
28 #include "memory/resourceArea.hpp"
29 #include "oops/oop.inline.hpp"
30 #include "oops/symbol.hpp"
31 #include "runtime/handles.inline.hpp"
32 #include "utilities/globalDefinitions.hpp"
33
34 StackMapFrame::StackMapFrame(u2 max_locals, u2 max_stack, ClassVerifier* v) :
35 _offset(0), _locals_size(0), _stack_size(0),
36 _stack_mark(0), _max_locals(max_locals),
37 _max_stack(max_stack), _flags(0), _verifier(v) {
38 Thread* thr = v->thread();
39 _locals = NEW_RESOURCE_ARRAY_IN_THREAD(thr, VerificationType, max_locals);
40 _stack = NEW_RESOURCE_ARRAY_IN_THREAD(thr, VerificationType, max_stack);
41 int32_t i;
42 for(i = 0; i < max_locals; i++) {
43 _locals[i] = VerificationType::bogus_type();
44 }
45 for(i = 0; i < max_stack; i++) {
46 _stack[i] = VerificationType::bogus_type();
47 }
48 }
49
50 StackMapFrame* StackMapFrame::frame_in_exception_handler(u1 flags) {
51 Thread* thr = _verifier->thread();
52 VerificationType* stack = NEW_RESOURCE_ARRAY_IN_THREAD(thr, VerificationType, 1);
53 StackMapFrame* frame = new StackMapFrame(_offset, flags, _locals_size, 0, _max_locals, _max_stack, _locals, stack, _verifier);
54 return frame;
55 }
56
57 void StackMapFrame::initialize_object(
58 VerificationType old_object, VerificationType new_object) {
59 int32_t i;
60 for (i = 0; i < _max_locals; i++) {
61 if (_locals[i].equals(old_object)) {
62 _locals[i] = new_object;
63 }
64 }
65 for (i = 0; i < _stack_size; i++) {
66 if (_stack[i].equals(old_object)) {
67 _stack[i] = new_object;
68 }
69 }
70 if (old_object == VerificationType::uninitialized_this_type()) {
71 // "this" has been initialized - reset flags
72 _flags = 0;
73 }
74 }
75
76 VerificationType StackMapFrame::set_locals_from_arg(
77 const methodHandle& m, VerificationType thisKlass, TRAPS) {
78 SignatureStream ss(m->signature());
79 int init_local_num = 0;
80 if (!m->is_static()) {
81 init_local_num++;
82 // add one extra argument for instance method
83 if (m->is_object_constructor() &&
84 thisKlass.name() != vmSymbols::java_lang_Object()) {
85 _locals[0] = VerificationType::uninitialized_this_type();
86 _flags |= FLAG_THIS_UNINIT;
87 } else {
88 _locals[0] = thisKlass;
89 }
90 }
91
92 // local num may be greater than size of parameters because long/double occupies two slots
93 while(!ss.at_return_type()) {
94 init_local_num += _verifier->change_sig_to_verificationType(
95 &ss, &_locals[init_local_num],
96 CHECK_VERIFY_(verifier(), VerificationType::bogus_type()));
97 ss.next();
98 }
99 _locals_size = init_local_num;
100
101 switch (ss.type()) {
102 case T_OBJECT:
103 case T_ARRAY:
104 case T_VALUETYPE:
105 {
106 Symbol* sig = ss.as_symbol(CHECK_(VerificationType::bogus_type()));
107 if (!sig->is_permanent()) {
108 // Create another symbol to save as signature stream unreferences
109 // this symbol.
110 Symbol *sig_copy =
111 verifier()->create_temporary_symbol(sig, 0, sig->utf8_length(),
112 CHECK_(VerificationType::bogus_type()));
113 assert(sig_copy == sig, "symbols don't match");
114 sig = sig_copy;
115 }
116 if (ss.type() == T_VALUETYPE) {
117 return VerificationType::valuetype_type(sig);
118 }
119 return VerificationType::reference_type(sig);
120 }
121 case T_INT: return VerificationType::integer_type();
122 case T_BYTE: return VerificationType::byte_type();
123 case T_CHAR: return VerificationType::char_type();
124 case T_SHORT: return VerificationType::short_type();
125 case T_BOOLEAN: return VerificationType::boolean_type();
126 case T_FLOAT: return VerificationType::float_type();
127 case T_DOUBLE: return VerificationType::double_type();
128 case T_LONG: return VerificationType::long_type();
129 case T_VOID: return VerificationType::bogus_type();
130 default:
131 ShouldNotReachHere();
132 }
133 return VerificationType::bogus_type();
134 }
135
136 void StackMapFrame::copy_locals(const StackMapFrame* src) {
137 int32_t len = src->locals_size() < _locals_size ?
138 src->locals_size() : _locals_size;
139 for (int32_t i = 0; i < len; i++) {
140 _locals[i] = src->locals()[i];
141 }
142 }
143
144 void StackMapFrame::copy_stack(const StackMapFrame* src) {
145 int32_t len = src->stack_size() < _stack_size ?
146 src->stack_size() : _stack_size;
147 for (int32_t i = 0; i < len; i++) {
148 _stack[i] = src->stack()[i];
149 }
150 }
151
152 // Returns the location of the first mismatch, or 'len' if there are no
153 // mismatches
154 int StackMapFrame::is_assignable_to(
155 VerificationType* from, VerificationType* to, int32_t len, TRAPS) const {
156 int32_t i = 0;
157 for (i = 0; i < len; i++) {
158 if (!to[i].is_assignable_from(from[i], verifier(), false, THREAD)) {
159 break;
160 }
161 }
162 return i;
163 }
164
165 bool StackMapFrame::is_assignable_to(
166 const StackMapFrame* target, ErrorContext* ctx, TRAPS) const {
167 if (_max_locals != target->max_locals()) {
168 *ctx = ErrorContext::locals_size_mismatch(
169 _offset, (StackMapFrame*)this, (StackMapFrame*)target);
170 return false;
171 }
172 if (_stack_size != target->stack_size()) {
173 *ctx = ErrorContext::stack_size_mismatch(
174 _offset, (StackMapFrame*)this, (StackMapFrame*)target);
175 return false;
176 }
177 // Only need to compare type elements up to target->locals() or target->stack().
178 // The remaining type elements in this state can be ignored because they are
179 // assignable to bogus type.
180 int mismatch_loc;
181 mismatch_loc = is_assignable_to(
182 _locals, target->locals(), target->locals_size(), THREAD);
183 if (mismatch_loc != target->locals_size()) {
184 *ctx = ErrorContext::bad_type(target->offset(),
185 TypeOrigin::local(mismatch_loc, (StackMapFrame*)this),
186 TypeOrigin::sm_local(mismatch_loc, (StackMapFrame*)target));
187 return false;
188 }
189 mismatch_loc = is_assignable_to(_stack, target->stack(), _stack_size, THREAD);
190 if (mismatch_loc != _stack_size) {
191 *ctx = ErrorContext::bad_type(target->offset(),
192 TypeOrigin::stack(mismatch_loc, (StackMapFrame*)this),
193 TypeOrigin::sm_stack(mismatch_loc, (StackMapFrame*)target));
194 return false;
195 }
196
197 if ((_flags | target->flags()) == target->flags()) {
198 return true;
199 } else {
200 *ctx = ErrorContext::bad_flags(target->offset(),
201 (StackMapFrame*)this, (StackMapFrame*)target);
202 return false;
203 }
204 }
205
206 VerificationType StackMapFrame::pop_stack_ex(VerificationType type, TRAPS) {
207 if (_stack_size <= 0) {
208 verifier()->verify_error(
209 ErrorContext::stack_underflow(_offset, this),
210 "Operand stack underflow");
211 return VerificationType::bogus_type();
212 }
213 VerificationType top = _stack[--_stack_size];
214 bool subtype = type.is_assignable_from(
215 top, verifier(), false, CHECK_(VerificationType::bogus_type()));
216 if (!subtype) {
217 verifier()->verify_error(
218 ErrorContext::bad_type(_offset, stack_top_ctx(),
219 TypeOrigin::implicit(type)),
220 "Bad type on operand stack");
221 return VerificationType::bogus_type();
222 }
223 return top;
224 }
225
226 VerificationType StackMapFrame::get_local(
227 int32_t index, VerificationType type, TRAPS) {
228 if (index >= _max_locals) {
229 verifier()->verify_error(
230 ErrorContext::bad_local_index(_offset, index),
231 "Local variable table overflow");
232 return VerificationType::bogus_type();
233 }
234 bool subtype = type.is_assignable_from(_locals[index],
235 verifier(), false, CHECK_(VerificationType::bogus_type()));
236 if (!subtype) {
237 verifier()->verify_error(
238 ErrorContext::bad_type(_offset,
239 TypeOrigin::local(index, this),
240 TypeOrigin::implicit(type)),
241 "Bad local variable type");
242 return VerificationType::bogus_type();
243 }
244 if(index >= _locals_size) { _locals_size = index + 1; }
245 return _locals[index];
246 }
247
248 void StackMapFrame::get_local_2(
249 int32_t index, VerificationType type1, VerificationType type2, TRAPS) {
250 assert(type1.is_long() || type1.is_double(), "must be long/double");
251 assert(type2.is_long2() || type2.is_double2(), "must be long/double_2");
252 if (index >= _locals_size - 1) {
253 verifier()->verify_error(
254 ErrorContext::bad_local_index(_offset, index),
255 "get long/double overflows locals");
256 return;
257 }
258 bool subtype = type1.is_assignable_from(_locals[index], verifier(), false, CHECK);
259 if (!subtype) {
260 verifier()->verify_error(
261 ErrorContext::bad_type(_offset,
262 TypeOrigin::local(index, this), TypeOrigin::implicit(type1)),
263 "Bad local variable type");
264 } else {
265 subtype = type2.is_assignable_from(_locals[index + 1], verifier(), false, CHECK);
266 if (!subtype) {
267 /* Unreachable? All local store routines convert a split long or double
268 * into a TOP during the store. So we should never end up seeing an
269 * orphaned half. */
270 verifier()->verify_error(
271 ErrorContext::bad_type(_offset,
272 TypeOrigin::local(index + 1, this), TypeOrigin::implicit(type2)),
273 "Bad local variable type");
274 }
275 }
276 }
277
278 void StackMapFrame::set_local(int32_t index, VerificationType type, TRAPS) {
279 assert(!type.is_check(), "Must be a real type");
280 if (index >= _max_locals) {
281 verifier()->verify_error(
282 ErrorContext::bad_local_index(_offset, index),
283 "Local variable table overflow");
284 return;
285 }
286 // If type at index is double or long, set the next location to be unusable
287 if (_locals[index].is_double() || _locals[index].is_long()) {
288 assert((index + 1) < _locals_size, "Local variable table overflow");
289 _locals[index + 1] = VerificationType::bogus_type();
290 }
291 // If type at index is double_2 or long_2, set the previous location to be unusable
292 if (_locals[index].is_double2() || _locals[index].is_long2()) {
293 assert(index >= 1, "Local variable table underflow");
294 _locals[index - 1] = VerificationType::bogus_type();
295 }
296 _locals[index] = type;
297 if (index >= _locals_size) {
298 #ifdef ASSERT
299 for (int i=_locals_size; i<index; i++) {
300 assert(_locals[i] == VerificationType::bogus_type(),
301 "holes must be bogus type");
302 }
303 #endif
304 _locals_size = index + 1;
305 }
306 }
307
308 void StackMapFrame::set_local_2(
309 int32_t index, VerificationType type1, VerificationType type2, TRAPS) {
310 assert(type1.is_long() || type1.is_double(), "must be long/double");
311 assert(type2.is_long2() || type2.is_double2(), "must be long/double_2");
312 if (index >= _max_locals - 1) {
313 verifier()->verify_error(
314 ErrorContext::bad_local_index(_offset, index),
315 "Local variable table overflow");
316 return;
317 }
318 // If type at index+1 is double or long, set the next location to be unusable
319 if (_locals[index+1].is_double() || _locals[index+1].is_long()) {
320 assert((index + 2) < _locals_size, "Local variable table overflow");
321 _locals[index + 2] = VerificationType::bogus_type();
322 }
323 // If type at index is double_2 or long_2, set the previous location to be unusable
324 if (_locals[index].is_double2() || _locals[index].is_long2()) {
325 assert(index >= 1, "Local variable table underflow");
326 _locals[index - 1] = VerificationType::bogus_type();
327 }
328 _locals[index] = type1;
329 _locals[index+1] = type2;
330 if (index >= _locals_size - 1) {
331 #ifdef ASSERT
332 for (int i=_locals_size; i<index; i++) {
333 assert(_locals[i] == VerificationType::bogus_type(),
334 "holes must be bogus type");
335 }
336 #endif
337 _locals_size = index + 2;
338 }
339 }
340
341 TypeOrigin StackMapFrame::stack_top_ctx() {
342 return TypeOrigin::stack(_stack_size, this);
343 }
344
345 void StackMapFrame::print_on(outputStream* str) const {
346 str->indent().print_cr("bci: @%d", _offset);
347 str->indent().print_cr("flags: {%s }",
348 flag_this_uninit() ? " flagThisUninit" : "");
349 str->indent().print("locals: {");
350 for (int32_t i = 0; i < _locals_size; ++i) {
351 str->print(" ");
352 _locals[i].print_on(str);
353 if (i != _locals_size - 1) {
354 str->print(",");
355 }
356 }
357 str->print_cr(" }");
358 str->indent().print("stack: {");
359 for (int32_t j = 0; j < _stack_size; ++j) {
360 str->print(" ");
361 _stack[j].print_on(str);
362 if (j != _stack_size - 1) {
363 str->print(",");
364 }
365 }
366 str->print_cr(" }");
367 }