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