1 /*
2 * Copyright (c) 2003, 2016, 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->name() == vmSymbols::object_initializer_name() &&
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 {
105 Symbol* sig = ss.as_symbol(CHECK_(VerificationType::bogus_type()));
106 if (!sig->is_permanent()) {
107 // Create another symbol to save as signature stream unreferences
108 // this symbol.
109 Symbol *sig_copy =
110 verifier()->create_temporary_symbol(sig, 0, sig->utf8_length(),
111 CHECK_(VerificationType::bogus_type()));
112 assert(sig_copy == sig, "symbols don't match");
113 sig = sig_copy;
114 }
115 return VerificationType::reference_type(sig);
116 }
117 case T_INT: return VerificationType::integer_type();
118 case T_BYTE: return VerificationType::byte_type();
119 case T_CHAR: return VerificationType::char_type();
120 case T_SHORT: return VerificationType::short_type();
121 case T_BOOLEAN: return VerificationType::boolean_type();
122 case T_FLOAT: return VerificationType::float_type();
123 case T_DOUBLE: return VerificationType::double_type();
124 case T_LONG: return VerificationType::long_type();
125 case T_VOID: return VerificationType::bogus_type();
126 default:
127 ShouldNotReachHere();
128 }
129 return VerificationType::bogus_type();
130 }
131
132 void StackMapFrame::copy_locals(const StackMapFrame* src) {
133 int32_t len = src->locals_size() < _locals_size ?
134 src->locals_size() : _locals_size;
135 for (int32_t i = 0; i < len; i++) {
136 _locals[i] = src->locals()[i];
137 }
138 }
139
140 void StackMapFrame::copy_stack(const StackMapFrame* src) {
141 int32_t len = src->stack_size() < _stack_size ?
142 src->stack_size() : _stack_size;
143 for (int32_t i = 0; i < len; i++) {
144 _stack[i] = src->stack()[i];
145 }
146 }
147
148 // Returns the location of the first mismatch, or 'len' if there are no
149 // mismatches
150 int StackMapFrame::is_assignable_to(
151 VerificationType* from, VerificationType* to, int32_t len, TRAPS) const {
152 int32_t i = 0;
153 for (i = 0; i < len; i++) {
154 if (!to[i].is_assignable_from(from[i], verifier(), false, THREAD)) {
155 break;
156 }
157 }
158 return i;
159 }
160
161 bool StackMapFrame::is_assignable_to(
162 const StackMapFrame* target, ErrorContext* ctx, TRAPS) const {
163 if (_max_locals != target->max_locals()) {
164 *ctx = ErrorContext::locals_size_mismatch(
165 _offset, (StackMapFrame*)this, (StackMapFrame*)target);
166 return false;
167 }
168 if (_stack_size != target->stack_size()) {
169 *ctx = ErrorContext::stack_size_mismatch(
170 _offset, (StackMapFrame*)this, (StackMapFrame*)target);
171 return false;
172 }
173 // Only need to compare type elements up to target->locals() or target->stack().
174 // The remaining type elements in this state can be ignored because they are
175 // assignable to bogus type.
176 int mismatch_loc;
177 mismatch_loc = is_assignable_to(
178 _locals, target->locals(), target->locals_size(), THREAD);
179 if (mismatch_loc != target->locals_size()) {
180 *ctx = ErrorContext::bad_type(target->offset(),
181 TypeOrigin::local(mismatch_loc, (StackMapFrame*)this),
182 TypeOrigin::sm_local(mismatch_loc, (StackMapFrame*)target));
183 return false;
184 }
185 mismatch_loc = is_assignable_to(_stack, target->stack(), _stack_size, THREAD);
186 if (mismatch_loc != _stack_size) {
187 *ctx = ErrorContext::bad_type(target->offset(),
188 TypeOrigin::stack(mismatch_loc, (StackMapFrame*)this),
189 TypeOrigin::sm_stack(mismatch_loc, (StackMapFrame*)target));
190 return false;
191 }
192
193 if ((_flags | target->flags()) == target->flags()) {
194 return true;
195 } else {
196 *ctx = ErrorContext::bad_flags(target->offset(),
197 (StackMapFrame*)this, (StackMapFrame*)target);
198 return false;
199 }
200 }
201
202 VerificationType StackMapFrame::pop_stack_ex(VerificationType type, TRAPS) {
203 if (_stack_size <= 0) {
204 verifier()->verify_error(
205 ErrorContext::stack_underflow(_offset, this),
206 "Operand stack underflow");
207 return VerificationType::bogus_type();
208 }
209 VerificationType top = _stack[--_stack_size];
210 bool subtype = type.is_assignable_from(
211 top, verifier(), false, CHECK_(VerificationType::bogus_type()));
212 if (!subtype) {
213 verifier()->verify_error(
214 ErrorContext::bad_type(_offset, stack_top_ctx(),
215 TypeOrigin::implicit(type)),
216 "Bad type on operand stack");
217 return VerificationType::bogus_type();
218 }
219 return top;
220 }
221
222 VerificationType StackMapFrame::get_local(
223 int32_t index, VerificationType type, TRAPS) {
224 if (index >= _max_locals) {
225 verifier()->verify_error(
226 ErrorContext::bad_local_index(_offset, index),
227 "Local variable table overflow");
228 return VerificationType::bogus_type();
229 }
230 bool subtype = type.is_assignable_from(_locals[index],
231 verifier(), false, CHECK_(VerificationType::bogus_type()));
232 if (!subtype) {
233 verifier()->verify_error(
234 ErrorContext::bad_type(_offset,
235 TypeOrigin::local(index, this),
236 TypeOrigin::implicit(type)),
237 "Bad local variable type");
238 return VerificationType::bogus_type();
239 }
240 if(index >= _locals_size) { _locals_size = index + 1; }
241 return _locals[index];
242 }
243
244 void StackMapFrame::get_local_2(
245 int32_t index, VerificationType type1, VerificationType type2, TRAPS) {
246 assert(type1.is_long() || type1.is_double(), "must be long/double");
247 assert(type2.is_long2() || type2.is_double2(), "must be long/double_2");
248 if (index >= _locals_size - 1) {
249 verifier()->verify_error(
250 ErrorContext::bad_local_index(_offset, index),
251 "get long/double overflows locals");
252 return;
253 }
254 bool subtype = type1.is_assignable_from(_locals[index], verifier(), false, CHECK);
255 if (!subtype) {
256 verifier()->verify_error(
257 ErrorContext::bad_type(_offset,
258 TypeOrigin::local(index, this), TypeOrigin::implicit(type1)),
259 "Bad local variable type");
260 } else {
261 subtype = type2.is_assignable_from(_locals[index + 1], verifier(), false, CHECK);
262 if (!subtype) {
263 /* Unreachable? All local store routines convert a split long or double
264 * into a TOP during the store. So we should never end up seeing an
265 * orphaned half. */
266 verifier()->verify_error(
267 ErrorContext::bad_type(_offset,
268 TypeOrigin::local(index + 1, this), TypeOrigin::implicit(type2)),
269 "Bad local variable type");
270 }
271 }
272 }
273
274 void StackMapFrame::set_local(int32_t index, VerificationType type, TRAPS) {
275 assert(!type.is_check(), "Must be a real type");
276 if (index >= _max_locals) {
277 verifier()->verify_error(
278 ErrorContext::bad_local_index(_offset, index),
279 "Local variable table overflow");
280 return;
281 }
282 // If type at index is double or long, set the next location to be unusable
283 if (_locals[index].is_double() || _locals[index].is_long()) {
284 assert((index + 1) < _locals_size, "Local variable table overflow");
285 _locals[index + 1] = VerificationType::bogus_type();
286 }
287 // If type at index is double_2 or long_2, set the previous location to be unusable
288 if (_locals[index].is_double2() || _locals[index].is_long2()) {
289 assert(index >= 1, "Local variable table underflow");
290 _locals[index - 1] = VerificationType::bogus_type();
291 }
292 _locals[index] = type;
293 if (index >= _locals_size) {
294 #ifdef ASSERT
295 for (int i=_locals_size; i<index; i++) {
296 assert(_locals[i] == VerificationType::bogus_type(),
297 "holes must be bogus type");
298 }
299 #endif
300 _locals_size = index + 1;
301 }
302 }
303
304 void StackMapFrame::set_local_2(
305 int32_t index, VerificationType type1, VerificationType type2, TRAPS) {
306 assert(type1.is_long() || type1.is_double(), "must be long/double");
307 assert(type2.is_long2() || type2.is_double2(), "must be long/double_2");
308 if (index >= _max_locals - 1) {
309 verifier()->verify_error(
310 ErrorContext::bad_local_index(_offset, index),
311 "Local variable table overflow");
312 return;
313 }
314 // If type at index+1 is double or long, set the next location to be unusable
315 if (_locals[index+1].is_double() || _locals[index+1].is_long()) {
316 assert((index + 2) < _locals_size, "Local variable table overflow");
317 _locals[index + 2] = VerificationType::bogus_type();
318 }
319 // If type at index is double_2 or long_2, set the previous location to be unusable
320 if (_locals[index].is_double2() || _locals[index].is_long2()) {
321 assert(index >= 1, "Local variable table underflow");
322 _locals[index - 1] = VerificationType::bogus_type();
323 }
324 _locals[index] = type1;
325 _locals[index+1] = type2;
326 if (index >= _locals_size - 1) {
327 #ifdef ASSERT
328 for (int i=_locals_size; i<index; i++) {
329 assert(_locals[i] == VerificationType::bogus_type(),
330 "holes must be bogus type");
331 }
332 #endif
333 _locals_size = index + 2;
334 }
335 }
336
337 TypeOrigin StackMapFrame::stack_top_ctx() {
338 return TypeOrigin::stack(_stack_size, this);
339 }
340
341 void StackMapFrame::print_on(outputStream* str) const {
342 str->indent().print_cr("bci: @%d", _offset);
343 str->indent().print_cr("flags: {%s }",
344 flag_this_uninit() ? " flagThisUninit" : "");
345 str->indent().print("locals: {");
346 for (int32_t i = 0; i < _locals_size; ++i) {
347 str->print(" ");
348 _locals[i].print_on(str);
349 if (i != _locals_size - 1) {
350 str->print(",");
351 }
352 }
353 str->print_cr(" }");
354 str->indent().print("stack: {");
355 for (int32_t j = 0; j < _stack_size; ++j) {
356 str->print(" ");
357 _stack[j].print_on(str);
358 if (j != _stack_size - 1) {
359 str->print(",");
360 }
361 }
362 str->print_cr(" }");
363 }