1 /*
2 * Copyright (c) 1997, 2023, 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_INTERPRETER_BYTECODES_HPP
26 #define SHARE_INTERPRETER_BYTECODES_HPP
27
28 #include "memory/allStatic.hpp"
29 #include "utilities/globalDefinitions.hpp"
30
31 // Bytecodes specifies all bytecodes used in the VM and
32 // provides utility functions to get bytecode attributes.
33
34 class Method;
35
36 // NOTE: replicated in SA in vm/agent/sun/jvm/hotspot/interpreter/Bytecodes.java
37 class Bytecodes: AllStatic {
38 public:
39 enum Code {
40 _illegal = -1,
41
42 // Java bytecodes
43 _nop = 0, // 0x00
44 _aconst_null = 1, // 0x01
45 _iconst_m1 = 2, // 0x02
46 _iconst_0 = 3, // 0x03
47 _iconst_1 = 4, // 0x04
48 _iconst_2 = 5, // 0x05
49 _iconst_3 = 6, // 0x06
50 _iconst_4 = 7, // 0x07
51 _iconst_5 = 8, // 0x08
52 _lconst_0 = 9, // 0x09
53 _lconst_1 = 10, // 0x0a
54 _fconst_0 = 11, // 0x0b
55 _fconst_1 = 12, // 0x0c
56 _fconst_2 = 13, // 0x0d
57 _dconst_0 = 14, // 0x0e
58 _dconst_1 = 15, // 0x0f
59 _bipush = 16, // 0x10
60 _sipush = 17, // 0x11
61 _ldc = 18, // 0x12
62 _ldc_w = 19, // 0x13
63 _ldc2_w = 20, // 0x14
64 _iload = 21, // 0x15
65 _lload = 22, // 0x16
66 _fload = 23, // 0x17
67 _dload = 24, // 0x18
68 _aload = 25, // 0x19
69 _iload_0 = 26, // 0x1a
70 _iload_1 = 27, // 0x1b
71 _iload_2 = 28, // 0x1c
72 _iload_3 = 29, // 0x1d
73 _lload_0 = 30, // 0x1e
74 _lload_1 = 31, // 0x1f
75 _lload_2 = 32, // 0x20
76 _lload_3 = 33, // 0x21
77 _fload_0 = 34, // 0x22
78 _fload_1 = 35, // 0x23
79 _fload_2 = 36, // 0x24
80 _fload_3 = 37, // 0x25
81 _dload_0 = 38, // 0x26
82 _dload_1 = 39, // 0x27
83 _dload_2 = 40, // 0x28
84 _dload_3 = 41, // 0x29
85 _aload_0 = 42, // 0x2a
86 _aload_1 = 43, // 0x2b
87 _aload_2 = 44, // 0x2c
88 _aload_3 = 45, // 0x2d
89 _iaload = 46, // 0x2e
90 _laload = 47, // 0x2f
91 _faload = 48, // 0x30
92 _daload = 49, // 0x31
93 _aaload = 50, // 0x32
94 _baload = 51, // 0x33
95 _caload = 52, // 0x34
96 _saload = 53, // 0x35
97 _istore = 54, // 0x36
98 _lstore = 55, // 0x37
99 _fstore = 56, // 0x38
100 _dstore = 57, // 0x39
101 _astore = 58, // 0x3a
102 _istore_0 = 59, // 0x3b
103 _istore_1 = 60, // 0x3c
104 _istore_2 = 61, // 0x3d
105 _istore_3 = 62, // 0x3e
106 _lstore_0 = 63, // 0x3f
107 _lstore_1 = 64, // 0x40
108 _lstore_2 = 65, // 0x41
109 _lstore_3 = 66, // 0x42
110 _fstore_0 = 67, // 0x43
111 _fstore_1 = 68, // 0x44
112 _fstore_2 = 69, // 0x45
113 _fstore_3 = 70, // 0x46
114 _dstore_0 = 71, // 0x47
115 _dstore_1 = 72, // 0x48
116 _dstore_2 = 73, // 0x49
117 _dstore_3 = 74, // 0x4a
118 _astore_0 = 75, // 0x4b
119 _astore_1 = 76, // 0x4c
120 _astore_2 = 77, // 0x4d
121 _astore_3 = 78, // 0x4e
122 _iastore = 79, // 0x4f
123 _lastore = 80, // 0x50
124 _fastore = 81, // 0x51
125 _dastore = 82, // 0x52
126 _aastore = 83, // 0x53
127 _bastore = 84, // 0x54
128 _castore = 85, // 0x55
129 _sastore = 86, // 0x56
130 _pop = 87, // 0x57
131 _pop2 = 88, // 0x58
132 _dup = 89, // 0x59
133 _dup_x1 = 90, // 0x5a
134 _dup_x2 = 91, // 0x5b
135 _dup2 = 92, // 0x5c
136 _dup2_x1 = 93, // 0x5d
137 _dup2_x2 = 94, // 0x5e
138 _swap = 95, // 0x5f
139 _iadd = 96, // 0x60
140 _ladd = 97, // 0x61
141 _fadd = 98, // 0x62
142 _dadd = 99, // 0x63
143 _isub = 100, // 0x64
144 _lsub = 101, // 0x65
145 _fsub = 102, // 0x66
146 _dsub = 103, // 0x67
147 _imul = 104, // 0x68
148 _lmul = 105, // 0x69
149 _fmul = 106, // 0x6a
150 _dmul = 107, // 0x6b
151 _idiv = 108, // 0x6c
152 _ldiv = 109, // 0x6d
153 _fdiv = 110, // 0x6e
154 _ddiv = 111, // 0x6f
155 _irem = 112, // 0x70
156 _lrem = 113, // 0x71
157 _frem = 114, // 0x72
158 _drem = 115, // 0x73
159 _ineg = 116, // 0x74
160 _lneg = 117, // 0x75
161 _fneg = 118, // 0x76
162 _dneg = 119, // 0x77
163 _ishl = 120, // 0x78
164 _lshl = 121, // 0x79
165 _ishr = 122, // 0x7a
166 _lshr = 123, // 0x7b
167 _iushr = 124, // 0x7c
168 _lushr = 125, // 0x7d
169 _iand = 126, // 0x7e
170 _land = 127, // 0x7f
171 _ior = 128, // 0x80
172 _lor = 129, // 0x81
173 _ixor = 130, // 0x82
174 _lxor = 131, // 0x83
175 _iinc = 132, // 0x84
176 _i2l = 133, // 0x85
177 _i2f = 134, // 0x86
178 _i2d = 135, // 0x87
179 _l2i = 136, // 0x88
180 _l2f = 137, // 0x89
181 _l2d = 138, // 0x8a
182 _f2i = 139, // 0x8b
183 _f2l = 140, // 0x8c
184 _f2d = 141, // 0x8d
185 _d2i = 142, // 0x8e
186 _d2l = 143, // 0x8f
187 _d2f = 144, // 0x90
188 _i2b = 145, // 0x91
189 _i2c = 146, // 0x92
190 _i2s = 147, // 0x93
191 _lcmp = 148, // 0x94
192 _fcmpl = 149, // 0x95
193 _fcmpg = 150, // 0x96
194 _dcmpl = 151, // 0x97
195 _dcmpg = 152, // 0x98
196 _ifeq = 153, // 0x99
197 _ifne = 154, // 0x9a
198 _iflt = 155, // 0x9b
199 _ifge = 156, // 0x9c
200 _ifgt = 157, // 0x9d
201 _ifle = 158, // 0x9e
202 _if_icmpeq = 159, // 0x9f
203 _if_icmpne = 160, // 0xa0
204 _if_icmplt = 161, // 0xa1
205 _if_icmpge = 162, // 0xa2
206 _if_icmpgt = 163, // 0xa3
207 _if_icmple = 164, // 0xa4
208 _if_acmpeq = 165, // 0xa5
209 _if_acmpne = 166, // 0xa6
210 _goto = 167, // 0xa7
211 _jsr = 168, // 0xa8
212 _ret = 169, // 0xa9
213 _tableswitch = 170, // 0xaa
214 _lookupswitch = 171, // 0xab
215 _ireturn = 172, // 0xac
216 _lreturn = 173, // 0xad
217 _freturn = 174, // 0xae
218 _dreturn = 175, // 0xaf
219 _areturn = 176, // 0xb0
220 _return = 177, // 0xb1
221 _getstatic = 178, // 0xb2
222 _putstatic = 179, // 0xb3
223 _getfield = 180, // 0xb4
224 _putfield = 181, // 0xb5
225 _invokevirtual = 182, // 0xb6
226 _invokespecial = 183, // 0xb7
227 _invokestatic = 184, // 0xb8
228 _invokeinterface = 185, // 0xb9
229 _invokedynamic = 186, // 0xba
230 _new = 187, // 0xbb
231 _newarray = 188, // 0xbc
232 _anewarray = 189, // 0xbd
233 _arraylength = 190, // 0xbe
234 _athrow = 191, // 0xbf
235 _checkcast = 192, // 0xc0
236 _instanceof = 193, // 0xc1
237 _monitorenter = 194, // 0xc2
238 _monitorexit = 195, // 0xc3
239 _wide = 196, // 0xc4
240 _multianewarray = 197, // 0xc5
241 _ifnull = 198, // 0xc6
242 _ifnonnull = 199, // 0xc7
243 _goto_w = 200, // 0xc8
244 _jsr_w = 201, // 0xc9
245 _breakpoint = 202, // 0xca
246
247 number_of_java_codes,
248
249 // JVM bytecodes
250 _fast_agetfield = number_of_java_codes,
251 _fast_bgetfield ,
252 _fast_cgetfield ,
253 _fast_dgetfield ,
254 _fast_fgetfield ,
255 _fast_igetfield ,
256 _fast_lgetfield ,
257 _fast_sgetfield ,
258
259 _fast_aputfield ,
260 _fast_bputfield ,
261 _fast_zputfield ,
262 _fast_cputfield ,
263 _fast_dputfield ,
264 _fast_fputfield ,
265 _fast_iputfield ,
266 _fast_lputfield ,
267 _fast_sputfield ,
268
269 _fast_aload_0 ,
270 _fast_iaccess_0 ,
271 _fast_aaccess_0 ,
272 _fast_faccess_0 ,
273
274 _fast_iload ,
275 _fast_iload2 ,
276 _fast_icaload ,
277
278 _fast_invokevfinal ,
279 _fast_linearswitch ,
280 _fast_binaryswitch ,
281
282 // special handling of oop constants:
283 _fast_aldc ,
284 _fast_aldc_w ,
285
286 _return_register_finalizer ,
287
288 // special handling of signature-polymorphic methods:
289 _invokehandle ,
290
291 // These bytecodes are rewritten at CDS dump time, so that we can prevent them from being
292 // rewritten at run time. This way, the ConstMethods can be placed in the CDS ReadOnly
293 // section, and RewriteByteCodes/RewriteFrequentPairs can rewrite non-CDS bytecodes
294 // at run time.
295 //
296 // Rewritten at CDS dump time to | Original bytecode
297 // _invoke_virtual rewritten on sparc, will be disabled if UseSharedSpaces turned on.
298 // ------------------------------+------------------
299 _nofast_getfield , // <- _getfield
300 _nofast_putfield , // <- _putfield
301 _nofast_aload_0 , // <- _aload_0
302 _nofast_iload , // <- _iload
303
304 _shouldnotreachhere , // For debugging
305
306
307 number_of_codes
308 };
309
310 static_assert(number_of_codes <= 256, "too many bytecodes");
311
312 // Flag bits derived from format strings, can_trap, can_rewrite, etc.:
313 enum Flags : jchar {
314 // semantic flags:
315 _bc_can_trap = 1<<0, // bytecode execution can trap or block
316 _bc_can_rewrite = 1<<1, // bytecode execution has an alternate form
317
318 // format bits (determined only by the format string):
319 _fmt_has_c = 1<<2, // constant, such as sipush "bcc"
320 _fmt_has_j = 1<<3, // constant pool cache index, such as getfield "bjj"
321 _fmt_has_k = 1<<4, // constant pool index, such as ldc "bk"
322 _fmt_has_i = 1<<5, // local index, such as iload
323 _fmt_has_o = 1<<6, // offset, such as ifeq
324 _fmt_has_nbo = 1<<7, // contains native-order field(s)
325 _fmt_has_u2 = 1<<8, // contains double-byte field(s)
326 _fmt_has_u4 = 1<<9, // contains quad-byte field
327 _fmt_not_variable = 1<<10, // not of variable length (simple or wide)
328 _fmt_not_simple = 1<<11, // either wide or variable length
329 _all_fmt_bits = (_fmt_not_simple*2 - _fmt_has_c),
330
331 // Example derived format syndromes:
332 _fmt_b = _fmt_not_variable,
333 _fmt_bc = _fmt_b | _fmt_has_c,
334 _fmt_bi = _fmt_b | _fmt_has_i,
335 _fmt_bkk = _fmt_b | _fmt_has_k | _fmt_has_u2,
336 _fmt_bJJ = _fmt_b | _fmt_has_j | _fmt_has_u2 | _fmt_has_nbo,
337 _fmt_bo2 = _fmt_b | _fmt_has_o | _fmt_has_u2,
338 _fmt_bo4 = _fmt_b | _fmt_has_o | _fmt_has_u4
339 };
340
341 private:
342 static bool _is_initialized;
343 static const char* const _name [number_of_codes];
344 static const BasicType _result_type[number_of_codes];
345 static const s_char _depth [number_of_codes];
346 static const u_char _lengths [number_of_codes];
347 static const Code _java_code [number_of_codes];
348 static jchar _flags [(1<<BitsPerByte)*2]; // all second page for wide formats
349
350 static void def_flags(Code code, const char* format, const char* wide_format, bool can_trap, Code java_code);
351
352 // Verify that bcp points into method
353 #ifdef ASSERT
354 static bool check_method(const Method* method, address bcp);
355 #endif
356 static bool check_must_rewrite(Bytecodes::Code bc);
357 static jchar compute_flags (const char* format, jchar more_flags); // compute the flags
358
359 public:
360 // Conversion
361 static void check (Code code) { assert(is_defined(code), "illegal code: %d", (int)code); }
362 static void wide_check (Code code) { assert(wide_is_defined(code), "illegal code: %d", (int)code); }
363 static Code cast (int code) { return (Code)code; }
364
365
366 // Fetch a bytecode, hiding breakpoints as necessary. The method
367 // argument is used for conversion of breakpoints into the original
368 // bytecode. The CI uses these methods but guarantees that
369 // breakpoints are hidden so the method argument should be passed as
370 // null since in that case the bcp and Method* are unrelated
371 // memory.
372 static Code code_at(const Method* method, address bcp) {
373 assert(method == nullptr || check_method(method, bcp), "bcp must point into method");
374 Code code = cast(*bcp);
375 assert(code != _breakpoint || method != nullptr, "need Method* to decode breakpoint");
376 return (code != _breakpoint) ? code : non_breakpoint_code_at(method, bcp);
377 }
378 static Code java_code_at(const Method* method, address bcp) {
379 return java_code(code_at(method, bcp));
380 }
381
382 // Fetch a bytecode or a breakpoint:
383 static Code code_or_bp_at(address bcp) { return (Code)cast(*bcp); }
384
385 static Code code_at(Method* method, int bci);
386
387 // find a bytecode, behind a breakpoint if necessary:
388 static Code non_breakpoint_code_at(const Method* method, address bcp);
389
390 // Bytecode attributes
391 static bool is_valid (int code) { return 0 <= code && code < number_of_codes; }
392 static bool is_defined (int code) { return is_valid(code) && flags(code, false) != 0; }
393 static bool wide_is_defined(int code) { return is_defined(code) && flags(code, true) != 0; }
394 static const char* name (Code code) { check(code); return _name [code]; }
395 static BasicType result_type (Code code) { check(code); return _result_type [code]; }
396 static int depth (Code code) { check(code); return _depth [code]; }
397 // Note: Length functions must return <=0 for invalid bytecodes.
398 // Calling check(code) in length functions would throw an unwanted assert.
399 static int length_for (Code code) { return is_valid(code) ? _lengths[code] & 0xF : -1; }
400 static int wide_length_for(Code code) { return is_valid(code) ? _lengths[code] >> 4 : -1; }
401 static bool can_trap (Code code) { check(code); return has_all_flags(code, _bc_can_trap, false); }
402 static Code java_code (Code code) { check(code); return _java_code [code]; }
403 static bool can_rewrite (Code code) { check(code); return has_all_flags(code, _bc_can_rewrite, false); }
404 static bool must_rewrite(Bytecodes::Code code) { return can_rewrite(code) && check_must_rewrite(code); }
405 static bool native_byte_order(Code code) { check(code); return has_all_flags(code, _fmt_has_nbo, false); }
406 static bool uses_cp_cache (Code code) { check(code); return has_all_flags(code, _fmt_has_j, false); }
407 // if 'end' is provided, it indicates the end of the code buffer which
408 // should not be read past when parsing.
409 static int special_length_at(Bytecodes::Code code, address bcp, address end = nullptr);
410 static int raw_special_length_at(address bcp, address end = nullptr);
411 static int length_for_code_at(Bytecodes::Code code, address bcp) { int l = length_for(code); return l > 0 ? l : special_length_at(code, bcp); }
412 static int length_at (Method* method, address bcp) { return length_for_code_at(code_at(method, bcp), bcp); }
413 static int java_length_at (Method* method, address bcp) { return length_for_code_at(java_code_at(method, bcp), bcp); }
414 static bool is_java_code (Code code) { return 0 <= code && code < number_of_java_codes; }
415
416 static bool is_store_into_local(Code code){ return (_istore <= code && code <= _astore_3); }
417 static bool is_const (Code code) { return (_aconst_null <= code && code <= _ldc2_w); }
418 static bool is_zero_const (Code code) { return (code == _aconst_null || code == _iconst_0
419 || code == _fconst_0 || code == _dconst_0); }
420 static bool is_return (Code code) { return (_ireturn <= code && code <= _return); }
421 static bool is_invoke (Code code) { return (_invokevirtual <= code && code <= _invokedynamic); }
422 static bool is_field_code (Code code) { return (_getstatic <= java_code(code) && java_code(code) <= _putfield); }
423 static bool has_receiver (Code code) { assert(is_invoke(code), ""); return code == _invokevirtual ||
424 code == _invokespecial ||
425 code == _invokeinterface; }
426 static bool has_optional_appendix(Code code) { return code == _invokedynamic || code == _invokehandle; }
427
428 static int flags (int code, bool is_wide) {
429 assert(code == (u_char)code, "must be a byte");
430 return _flags[code + (is_wide ? (1<<BitsPerByte) : 0)];
431 }
432 static bool has_all_flags (Code code, int test_flags, bool is_wide) {
433 return (flags(code, is_wide) & test_flags) == test_flags;
434 }
435
436 // Initialization
437 static void initialize ();
438 };
439
440 #endif // SHARE_INTERPRETER_BYTECODES_HPP