1 /*
2 * Copyright (c) 1997, 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 #ifndef SHARE_VM_INTERPRETER_TEMPLATETABLE_HPP
26 #define SHARE_VM_INTERPRETER_TEMPLATETABLE_HPP
27
28 #include "interpreter/bytecodes.hpp"
29 #include "memory/allocation.hpp"
30 #include "runtime/frame.hpp"
31
32 #ifndef CC_INTERP
33 // All the necessary definitions used for (bytecode) template generation. Instead of
34 // spreading the implementation functionality for each bytecode in the interpreter
35 // and the snippet generator, a template is assigned to each bytecode which can be
36 // used to generate the bytecode's implementation if needed.
37
38 class InterpreterMacroAssembler;
39
40 // A Template describes the properties of a code template for a given bytecode
41 // and provides a generator to generate the code template.
42
43 class Template VALUE_OBJ_CLASS_SPEC {
44 private:
45 enum Flags {
46 uses_bcp_bit, // set if template needs the bcp pointing to bytecode
47 does_dispatch_bit, // set if template dispatches on its own
48 calls_vm_bit, // set if template calls the vm
49 wide_bit // set if template belongs to a wide instruction
50 };
51
52 typedef void (*generator)(int arg);
53
54 int _flags; // describes interpreter template properties (bcp unknown)
55 TosState _tos_in; // tos cache state before template execution
56 TosState _tos_out; // tos cache state after template execution
57 generator _gen; // template code generator
58 int _arg; // argument for template code generator
59
60 void initialize(int flags, TosState tos_in, TosState tos_out, generator gen, int arg);
61
62 friend class TemplateTable;
63
64 public:
65 Bytecodes::Code bytecode() const;
66 bool is_valid() const { return _gen != NULL; }
67 bool uses_bcp() const { return (_flags & (1 << uses_bcp_bit )) != 0; }
68 bool does_dispatch() const { return (_flags & (1 << does_dispatch_bit)) != 0; }
69 bool calls_vm() const { return (_flags & (1 << calls_vm_bit )) != 0; }
70 bool is_wide() const { return (_flags & (1 << wide_bit )) != 0; }
71 TosState tos_in() const { return _tos_in; }
72 TosState tos_out() const { return _tos_out; }
73 void generate(InterpreterMacroAssembler* masm);
74 };
75
76
77 // The TemplateTable defines all Templates and provides accessor functions
78 // to get the template for a given bytecode.
79
80 class TemplateTable: AllStatic {
81 public:
82 enum Operation { add, sub, mul, div, rem, _and, _or, _xor, shl, shr, ushr };
83 enum Condition { equal, not_equal, less, less_equal, greater, greater_equal };
84 enum CacheByte { f1_byte = 1, f2_byte = 2 }; // byte_no codes
85 enum RewriteControl { may_rewrite, may_not_rewrite }; // control for fast code under CDS
86
87 private:
88 static bool _is_initialized; // true if TemplateTable has been initialized
89 static Template _template_table [Bytecodes::number_of_codes];
90 static Template _template_table_wide[Bytecodes::number_of_codes];
91
92 static Template* _desc; // the current template to be generated
93 static Bytecodes::Code bytecode() { return _desc->bytecode(); }
94
95 static BarrierSet* _bs; // Cache the barrier set.
96 public:
97 //%note templates_1
98 static InterpreterMacroAssembler* _masm; // the assembler used when generating templates
99
100 private:
101
102 // special registers
103 static inline Address at_bcp(int offset);
104
105 // helpers
106 static void unimplemented_bc();
107 static void patch_bytecode(Bytecodes::Code bc, Register bc_reg,
108 Register temp_reg, bool load_bc_into_bc_reg = true, int byte_no = -1);
109
110 // C calls
111 static void call_VM(Register oop_result, address entry_point);
112 static void call_VM(Register oop_result, address entry_point, Register arg_1);
113 static void call_VM(Register oop_result, address entry_point, Register arg_1, Register arg_2);
114 static void call_VM(Register oop_result, address entry_point, Register arg_1, Register arg_2, Register arg_3);
115
116 // these overloadings are not presently used on SPARC:
117 static void call_VM(Register oop_result, Register last_java_sp, address entry_point);
118 static void call_VM(Register oop_result, Register last_java_sp, address entry_point, Register arg_1);
119 static void call_VM(Register oop_result, Register last_java_sp, address entry_point, Register arg_1, Register arg_2);
120 static void call_VM(Register oop_result, Register last_java_sp, address entry_point, Register arg_1, Register arg_2, Register arg_3);
121
122 // bytecodes
123 static void nop();
124
125 static void aconst_null();
126 static void iconst(int value);
127 static void lconst(int value);
128 static void fconst(int value);
129 static void dconst(int value);
130
131 static void bipush();
132 static void sipush();
133 static void ldc(bool wide);
134 static void ldc2_w();
135 static void fast_aldc(bool wide);
136
137 static void locals_index(Register reg, int offset = 1);
138 static void iload();
139 static void fast_iload();
140 static void fast_iload2();
141 static void fast_icaload();
142 static void lload();
143 static void fload();
144 static void dload();
145 static void aload();
146 static void vload();
147
148 static void locals_index_wide(Register reg);
149 static void wide_iload();
150 static void wide_lload();
151 static void wide_fload();
152 static void wide_dload();
153 static void wide_aload();
154 static void wide_vload();
155
156 static void iaload();
157 static void laload();
158 static void faload();
159 static void daload();
160 static void aaload();
161 static void vaload();
162 static void baload();
163 static void caload();
164 static void saload();
165
166 static void iload(int n);
167 static void lload(int n);
168 static void fload(int n);
169 static void dload(int n);
170 static void aload(int n);
171 static void aload_0();
172 static void nofast_aload_0();
173 static void nofast_iload();
174 static void iload_internal(RewriteControl rc = may_rewrite);
175 static void aload_0_internal(RewriteControl rc = may_rewrite);
176
177 static void istore();
178 static void lstore();
179 static void fstore();
180 static void dstore();
181 static void astore();
182 static void vstore();
183
184 static void wide_istore();
185 static void wide_lstore();
186 static void wide_fstore();
187 static void wide_dstore();
188 static void wide_astore();
189 static void wide_vstore();
190
191 static void iastore();
192 static void lastore();
193 static void fastore();
194 static void dastore();
195 static void aastore();
196 static void vastore();
197 static void bastore();
198 static void castore();
199 static void sastore();
200
201 static void istore(int n);
202 static void lstore(int n);
203 static void fstore(int n);
204 static void dstore(int n);
205 static void astore(int n);
206
207 static void pop();
208 static void pop2();
209 static void dup();
210 static void dup_x1();
211 static void dup_x2();
212 static void dup2();
213 static void dup2_x1();
214 static void dup2_x2();
215 static void swap();
216
217 static void iop2(Operation op);
218 static void lop2(Operation op);
219 static void fop2(Operation op);
220 static void dop2(Operation op);
221
222 static void idiv();
223 static void irem();
224
225 static void lmul();
226 static void ldiv();
227 static void lrem();
228 static void lshl();
229 static void lshr();
230 static void lushr();
231
232 static void ineg();
233 static void lneg();
234 static void fneg();
235 static void dneg();
236
237 static void iinc();
238 static void wide_iinc();
239 static void convert();
240 static void lcmp();
241
242 static void float_cmp (bool is_float, int unordered_result);
243 static void float_cmp (int unordered_result);
244 static void double_cmp(int unordered_result);
245
246 static void count_calls(Register method, Register temp);
247 static void branch(bool is_jsr, bool is_wide);
248 static void if_0cmp (Condition cc);
249 static void if_icmp (Condition cc);
250 static void if_nullcmp(Condition cc);
251 static void if_acmp (Condition cc);
252
253 static void _goto();
254 static void jsr();
255 static void ret();
256 static void wide_ret();
257
258 static void goto_w();
259 static void jsr_w();
260
261 static void tableswitch();
262 static void lookupswitch();
263 static void fast_linearswitch();
264 static void fast_binaryswitch();
265
266 static void _return(TosState state);
267
268 static void resolve_cache_and_index(int byte_no, // one of 1,2,11
269 Register cache, // output for CP cache
270 Register index, // output for CP index
271 size_t index_size); // one of 1,2,4
272 static void load_invoke_cp_cache_entry(int byte_no,
273 Register method,
274 Register itable_index,
275 Register flags,
276 bool is_invokevirtual,
277 bool is_virtual_final,
278 bool is_invokedynamic);
279 static void load_field_cp_cache_entry(Register obj,
280 Register cache,
281 Register index,
282 Register offset,
283 Register flags,
284 bool is_static);
285 static void invokevirtual(int byte_no);
286 static void invokedirect(int byte_no);
287 static void invokespecial(int byte_no);
288 static void invokestatic(int byte_no);
289 static void invokeinterface(int byte_no);
290 static void invokedynamic(int byte_no);
291 static void invokehandle(int byte_no);
292 static void fast_invokevfinal(int byte_no);
293
294 static void getfield_or_static(int byte_no, bool is_static, RewriteControl rc = may_rewrite, bool is_vgetfield = false);
295 static void putfield_or_static(int byte_no, bool is_static, RewriteControl rc = may_rewrite);
296
297 static void getfield(int byte_no);
298 static void putfield(int byte_no);
299 static void nofast_getfield(int byte_no);
300 static void nofast_putfield(int byte_no);
301 static void getstatic(int byte_no);
302 static void putstatic(int byte_no);
303 static void pop_and_check_object(Register obj);
304 static void vgetfield(int byte_no);
305
306 static void _new();
307 static void _vnew();
308 static void newarray();
309 static void anewarray();
310 static void vnewarray();
311 static void arraylength();
312 static void checkcast();
313 static void instanceof();
314
315 static void _vbox();
316 static void _vunbox();
317
318 static void athrow();
319
320 static void monitorenter();
321 static void monitorexit();
322
323 static void wide();
324 static void multianewarray();
325
326 static void fast_xaccess(TosState state);
327 static void fast_accessfield(TosState state);
328 static void fast_storefield(TosState state);
329
330 static void _breakpoint();
331
332 static void shouldnotreachhere();
333
334 // jvmti support
335 static void jvmti_post_field_access(Register cache, Register index, bool is_static, bool has_tos);
336 static void jvmti_post_field_mod(Register cache, Register index, bool is_static);
337 static void jvmti_post_fast_field_mod();
338
339 // debugging of TemplateGenerator
340 static void transition(TosState tos_in, TosState tos_out);// checks if in/out states expected by template generator correspond to table entries
341
342 // initialization helpers
343 static void def(Bytecodes::Code code, int flags, TosState in, TosState out, void (*gen)( ), char filler );
344 static void def(Bytecodes::Code code, int flags, TosState in, TosState out, void (*gen)(int arg ), int arg );
345 static void def(Bytecodes::Code code, int flags, TosState in, TosState out, void (*gen)(bool arg ), bool arg );
346 static void def(Bytecodes::Code code, int flags, TosState in, TosState out, void (*gen)(TosState tos), TosState tos);
347 static void def(Bytecodes::Code code, int flags, TosState in, TosState out, void (*gen)(Operation op), Operation op);
348 static void def(Bytecodes::Code code, int flags, TosState in, TosState out, void (*gen)(Condition cc), Condition cc);
349
350 friend class Template;
351
352 // InterpreterMacroAssembler::is_a(), etc., need TemplateTable::call_VM().
353 friend class InterpreterMacroAssembler;
354
355 public:
356 // Initialization
357 static void initialize();
358 static void pd_initialize();
359
360 // Templates
361 static Template* template_for (Bytecodes::Code code) { Bytecodes::check (code); return &_template_table [code]; }
362 static Template* template_for_wide(Bytecodes::Code code) { Bytecodes::wide_check(code); return &_template_table_wide[code]; }
363
364 // Platform specifics
365 #if defined TEMPLATETABLE_MD_HPP
366 # include TEMPLATETABLE_MD_HPP
367 #elif defined (TARGET_ARCH_MODEL_x86_32) || defined (TARGET_ARCH_MODEL_x86_64)
368 # include "templateTable_x86.hpp"
369 #elif defined TARGET_ARCH_MODEL_sparc
370 # include "templateTable_sparc.hpp"
371 #elif defined TARGET_ARCH_MODEL_ppc_64
372 # include "templateTable_ppc_64.hpp"
373 #elif defined TARGET_ARCH_MODEL_aarch64
374 # include "templateTable_aarch64.hpp"
375 #endif
376
377 };
378 #endif /* !CC_INTERP */
379
380 #endif // SHARE_VM_INTERPRETER_TEMPLATETABLE_HPP