Thu, 13 Jan 2011 22:15:41 -0800
4926272: methodOopDesc::method_from_bcp is unsafe
Reviewed-by: coleenp, jrose, kvn, dcubed
1 /*
2 * Copyright (c) 1997, 2011, 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 */
25 #ifndef SHARE_VM_INTERPRETER_BYTECODE_HPP
26 #define SHARE_VM_INTERPRETER_BYTECODE_HPP
28 #include "interpreter/bytecodes.hpp"
29 #include "memory/allocation.hpp"
30 #include "oops/methodOop.hpp"
31 #ifdef TARGET_ARCH_x86
32 # include "bytes_x86.hpp"
33 #endif
34 #ifdef TARGET_ARCH_sparc
35 # include "bytes_sparc.hpp"
36 #endif
37 #ifdef TARGET_ARCH_zero
38 # include "bytes_zero.hpp"
39 #endif
41 class ciBytecodeStream;
43 // The base class for different kinds of bytecode abstractions.
44 // Provides the primitive operations to manipulate code relative
45 // to the bcp.
47 class Bytecode: public StackObj {
48 protected:
49 const address _bcp;
50 const Bytecodes::Code _code;
52 // Address computation
53 address addr_at (int offset) const { return (address)_bcp + offset; }
54 u_char byte_at(int offset) const { return *addr_at(offset); }
55 address aligned_addr_at (int offset) const { return (address)round_to((intptr_t)addr_at(offset), jintSize); }
56 int aligned_offset (int offset) const { return aligned_addr_at(offset) - addr_at(0); }
58 // Word access:
59 int get_Java_u2_at (int offset) const { return Bytes::get_Java_u2(addr_at(offset)); }
60 int get_Java_u4_at (int offset) const { return Bytes::get_Java_u4(addr_at(offset)); }
61 int get_native_u2_at (int offset) const { return Bytes::get_native_u2(addr_at(offset)); }
62 int get_native_u4_at (int offset) const { return Bytes::get_native_u4(addr_at(offset)); }
64 public:
65 Bytecode(methodOop method, address bcp): _bcp(bcp), _code(Bytecodes::code_at(method, addr_at(0))) {
66 assert(method != NULL, "this form requires a valid methodOop");
67 }
68 // Defined in ciStreams.hpp
69 inline Bytecode(const ciBytecodeStream* stream, address bcp = NULL);
71 // Attributes
72 address bcp() const { return _bcp; }
73 int instruction_size() const { return Bytecodes::length_for_code_at(_code, bcp()); }
75 Bytecodes::Code code() const { return _code; }
76 Bytecodes::Code java_code() const { return Bytecodes::java_code(code()); }
78 // Static functions for parsing bytecodes in place.
79 int get_index_u1(Bytecodes::Code bc) const {
80 assert_same_format_as(bc); assert_index_size(1, bc);
81 return *(jubyte*)addr_at(1);
82 }
83 int get_index_u2(Bytecodes::Code bc, bool is_wide = false) const {
84 assert_same_format_as(bc, is_wide); assert_index_size(2, bc, is_wide);
85 address p = addr_at(is_wide ? 2 : 1);
86 if (can_use_native_byte_order(bc, is_wide))
87 return Bytes::get_native_u2(p);
88 else return Bytes::get_Java_u2(p);
89 }
90 int get_index_u1_cpcache(Bytecodes::Code bc) const {
91 assert_same_format_as(bc); assert_index_size(1, bc);
92 return *(jubyte*)addr_at(1) + constantPoolOopDesc::CPCACHE_INDEX_TAG;
93 }
94 int get_index_u2_cpcache(Bytecodes::Code bc) const {
95 assert_same_format_as(bc); assert_index_size(2, bc); assert_native_index(bc);
96 return Bytes::get_native_u2(addr_at(1)) + constantPoolOopDesc::CPCACHE_INDEX_TAG;
97 }
98 int get_index_u4(Bytecodes::Code bc) const {
99 assert_same_format_as(bc); assert_index_size(4, bc);
100 assert(can_use_native_byte_order(bc), "");
101 return Bytes::get_native_u4(addr_at(1));
102 }
103 bool has_index_u4(Bytecodes::Code bc) const {
104 return bc == Bytecodes::_invokedynamic;
105 }
107 int get_offset_s2(Bytecodes::Code bc) const {
108 assert_same_format_as(bc); assert_offset_size(2, bc);
109 return (jshort) Bytes::get_Java_u2(addr_at(1));
110 }
111 int get_offset_s4(Bytecodes::Code bc) const {
112 assert_same_format_as(bc); assert_offset_size(4, bc);
113 return (jint) Bytes::get_Java_u4(addr_at(1));
114 }
116 int get_constant_u1(int offset, Bytecodes::Code bc) const {
117 assert_same_format_as(bc); assert_constant_size(1, offset, bc);
118 return *(jbyte*)addr_at(offset);
119 }
120 int get_constant_u2(int offset, Bytecodes::Code bc, bool is_wide = false) const {
121 assert_same_format_as(bc, is_wide); assert_constant_size(2, offset, bc, is_wide);
122 return (jshort) Bytes::get_Java_u2(addr_at(offset));
123 }
125 // These are used locally and also from bytecode streams.
126 void assert_same_format_as(Bytecodes::Code testbc, bool is_wide = false) const NOT_DEBUG_RETURN;
127 static void assert_index_size(int required_size, Bytecodes::Code bc, bool is_wide = false) NOT_DEBUG_RETURN;
128 static void assert_offset_size(int required_size, Bytecodes::Code bc, bool is_wide = false) NOT_DEBUG_RETURN;
129 static void assert_constant_size(int required_size, int where, Bytecodes::Code bc, bool is_wide = false) NOT_DEBUG_RETURN;
130 static void assert_native_index(Bytecodes::Code bc, bool is_wide = false) NOT_DEBUG_RETURN;
131 static bool can_use_native_byte_order(Bytecodes::Code bc, bool is_wide = false) {
132 return (!Bytes::is_Java_byte_ordering_different() || Bytecodes::native_byte_order(bc /*, is_wide*/));
133 }
134 };
137 // Abstractions for lookupswitch bytecode
138 class LookupswitchPair VALUE_OBJ_CLASS_SPEC {
139 private:
140 const address _bcp;
142 address addr_at (int offset) const { return _bcp + offset; }
143 int get_Java_u4_at (int offset) const { return Bytes::get_Java_u4(addr_at(offset)); }
145 public:
146 LookupswitchPair(address bcp): _bcp(bcp) {}
147 int match() const { return get_Java_u4_at(0 * jintSize); }
148 int offset() const { return get_Java_u4_at(1 * jintSize); }
149 };
152 class Bytecode_lookupswitch: public Bytecode {
153 public:
154 Bytecode_lookupswitch(methodOop method, address bcp): Bytecode(method, bcp) { verify(); }
155 // Defined in ciStreams.hpp
156 inline Bytecode_lookupswitch(const ciBytecodeStream* stream);
157 void verify() const PRODUCT_RETURN;
159 // Attributes
160 int default_offset() const { return get_Java_u4_at(aligned_offset(1 + 0*jintSize)); }
161 int number_of_pairs() const { return get_Java_u4_at(aligned_offset(1 + 1*jintSize)); }
162 LookupswitchPair pair_at(int i) const {
163 assert(0 <= i && i < number_of_pairs(), "pair index out of bounds");
164 return LookupswitchPair(aligned_addr_at(1 + (1 + i)*2*jintSize));
165 }
166 };
168 class Bytecode_tableswitch: public Bytecode {
169 public:
170 Bytecode_tableswitch(methodOop method, address bcp): Bytecode(method, bcp) { verify(); }
171 // Defined in ciStreams.hpp
172 inline Bytecode_tableswitch(const ciBytecodeStream* stream);
173 void verify() const PRODUCT_RETURN;
175 // Attributes
176 int default_offset() const { return get_Java_u4_at(aligned_offset(1 + 0*jintSize)); }
177 int low_key() const { return get_Java_u4_at(aligned_offset(1 + 1*jintSize)); }
178 int high_key() const { return get_Java_u4_at(aligned_offset(1 + 2*jintSize)); }
179 int dest_offset_at(int i) const;
180 int length() { return high_key()-low_key()+1; }
181 };
183 // Common code for decoding invokes and field references.
185 class Bytecode_member_ref: public Bytecode {
186 protected:
187 const methodHandle _method; // method containing the bytecode
189 Bytecode_member_ref(methodHandle method, int bci) : Bytecode(method(), method()->bcp_from(bci)), _method(method) {}
191 methodHandle method() const { return _method; }
193 public:
194 int index() const; // cache index (loaded from instruction)
195 int pool_index() const; // constant pool index
196 symbolOop name() const; // returns the name of the method or field
197 symbolOop signature() const; // returns the signature of the method or field
199 BasicType result_type(Thread* thread) const; // returns the result type of the getfield or invoke
200 };
202 // Abstraction for invoke_{virtual, static, interface, special}
204 class Bytecode_invoke: public Bytecode_member_ref {
205 protected:
206 // Constructor that skips verification
207 Bytecode_invoke(methodHandle method, int bci, bool unused) : Bytecode_member_ref(method, bci) {}
209 public:
210 Bytecode_invoke(methodHandle method, int bci) : Bytecode_member_ref(method, bci) { verify(); }
211 void verify() const;
213 // Attributes
214 methodHandle static_target(TRAPS); // "specified" method (from constant pool)
216 // Testers
217 bool is_invokeinterface() const { return java_code() == Bytecodes::_invokeinterface; }
218 bool is_invokevirtual() const { return java_code() == Bytecodes::_invokevirtual; }
219 bool is_invokestatic() const { return java_code() == Bytecodes::_invokestatic; }
220 bool is_invokespecial() const { return java_code() == Bytecodes::_invokespecial; }
221 bool is_invokedynamic() const { return java_code() == Bytecodes::_invokedynamic; }
223 bool has_receiver() const { return !is_invokestatic() && !is_invokedynamic(); }
225 bool is_valid() const { return is_invokeinterface() ||
226 is_invokevirtual() ||
227 is_invokestatic() ||
228 is_invokespecial() ||
229 is_invokedynamic(); }
231 // Helper to skip verification. Used is_valid() to check if the result is really an invoke
232 inline friend Bytecode_invoke Bytecode_invoke_check(methodHandle method, int bci);
233 };
235 inline Bytecode_invoke Bytecode_invoke_check(methodHandle method, int bci) {
236 return Bytecode_invoke(method, bci, false);
237 }
240 // Abstraction for all field accesses (put/get field/static)
241 class Bytecode_field: public Bytecode_member_ref {
242 public:
243 Bytecode_field(methodHandle method, int bci) : Bytecode_member_ref(method, bci) { verify(); }
245 // Testers
246 bool is_getfield() const { return java_code() == Bytecodes::_getfield; }
247 bool is_putfield() const { return java_code() == Bytecodes::_putfield; }
248 bool is_getstatic() const { return java_code() == Bytecodes::_getstatic; }
249 bool is_putstatic() const { return java_code() == Bytecodes::_putstatic; }
251 bool is_getter() const { return is_getfield() || is_getstatic(); }
252 bool is_static() const { return is_getstatic() || is_putstatic(); }
254 bool is_valid() const { return is_getfield() ||
255 is_putfield() ||
256 is_getstatic() ||
257 is_putstatic(); }
258 void verify() const;
259 };
261 // Abstraction for checkcast
262 class Bytecode_checkcast: public Bytecode {
263 public:
264 Bytecode_checkcast(methodOop method, address bcp): Bytecode(method, bcp) { verify(); }
265 void verify() const { assert(Bytecodes::java_code(code()) == Bytecodes::_checkcast, "check checkcast"); }
267 // Returns index
268 long index() const { return get_index_u2(Bytecodes::_checkcast); };
269 };
271 // Abstraction for instanceof
272 class Bytecode_instanceof: public Bytecode {
273 public:
274 Bytecode_instanceof(methodOop method, address bcp): Bytecode(method, bcp) { verify(); }
275 void verify() const { assert(code() == Bytecodes::_instanceof, "check instanceof"); }
277 // Returns index
278 long index() const { return get_index_u2(Bytecodes::_instanceof); };
279 };
281 class Bytecode_new: public Bytecode {
282 public:
283 Bytecode_new(methodOop method, address bcp): Bytecode(method, bcp) { verify(); }
284 void verify() const { assert(java_code() == Bytecodes::_new, "check new"); }
286 // Returns index
287 long index() const { return get_index_u2(Bytecodes::_new); };
288 };
290 class Bytecode_multianewarray: public Bytecode {
291 public:
292 Bytecode_multianewarray(methodOop method, address bcp): Bytecode(method, bcp) { verify(); }
293 void verify() const { assert(java_code() == Bytecodes::_multianewarray, "check new"); }
295 // Returns index
296 long index() const { return get_index_u2(Bytecodes::_multianewarray); };
297 };
299 class Bytecode_anewarray: public Bytecode {
300 public:
301 Bytecode_anewarray(methodOop method, address bcp): Bytecode(method, bcp) { verify(); }
302 void verify() const { assert(java_code() == Bytecodes::_anewarray, "check anewarray"); }
304 // Returns index
305 long index() const { return get_index_u2(Bytecodes::_anewarray); };
306 };
308 // Abstraction for ldc, ldc_w and ldc2_w
309 class Bytecode_loadconstant: public Bytecode {
310 private:
311 const methodHandle _method;
313 int raw_index() const;
315 public:
316 Bytecode_loadconstant(methodHandle method, int bci): Bytecode(method(), method->bcp_from(bci)), _method(method) { verify(); }
318 void verify() const {
319 assert(_method.not_null(), "must supply method");
320 Bytecodes::Code stdc = Bytecodes::java_code(code());
321 assert(stdc == Bytecodes::_ldc ||
322 stdc == Bytecodes::_ldc_w ||
323 stdc == Bytecodes::_ldc2_w, "load constant");
324 }
326 // Only non-standard bytecodes (fast_aldc) have CP cache indexes.
327 bool has_cache_index() const { return code() >= Bytecodes::number_of_java_codes; }
329 int pool_index() const; // index into constant pool
330 int cache_index() const { // index into CP cache (or -1 if none)
331 return has_cache_index() ? raw_index() : -1;
332 }
334 BasicType result_type() const; // returns the result type of the ldc
336 oop resolve_constant(TRAPS) const;
337 };
339 #endif // SHARE_VM_INTERPRETER_BYTECODE_HPP