1 /*
2 * Copyright (c) 1997, 2010, 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 #ifdef TARGET_ARCH_MODEL_x86_32
32 # include "interp_masm_x86_32.hpp"
33 #endif
34 #ifdef TARGET_ARCH_MODEL_x86_64
35 # include "interp_masm_x86_64.hpp"
36 #endif
37 #ifdef TARGET_ARCH_MODEL_sparc
38 # include "interp_masm_sparc.hpp"
39 #endif
40 #ifdef TARGET_ARCH_MODEL_zero
41 # include "interp_masm_zero.hpp"
42 #endif
43
44 #ifndef CC_INTERP
45 // All the necessary definitions used for (bytecode) template generation. Instead of
46 // spreading the implementation functionality for each bytecode in the interpreter
47 // and the snippet generator, a template is assigned to each bytecode which can be
48 // used to generate the bytecode's implementation if needed.
49
50
51 // A Template describes the properties of a code template for a given bytecode
52 // and provides a generator to generate the code template.
53
54 class Template VALUE_OBJ_CLASS_SPEC {
55 private:
56 enum Flags {
57 uses_bcp_bit, // set if template needs the bcp pointing to bytecode
58 does_dispatch_bit, // set if template dispatches on its own
59 calls_vm_bit, // set if template calls the vm
60 wide_bit // set if template belongs to a wide instruction
61 };
62
63 typedef void (*generator)(int arg);
64
65 int _flags; // describes interpreter template properties (bcp unknown)
66 TosState _tos_in; // tos cache state before template execution
67 TosState _tos_out; // tos cache state after template execution
68 generator _gen; // template code generator
69 int _arg; // argument for template code generator
70
71 void initialize(int flags, TosState tos_in, TosState tos_out, generator gen, int arg);
72
73 friend class TemplateTable;
74
75 public:
76 Bytecodes::Code bytecode() const;
77 bool is_valid() const { return _gen != NULL; }
78 bool uses_bcp() const { return (_flags & (1 << uses_bcp_bit )) != 0; }
79 bool does_dispatch() const { return (_flags & (1 << does_dispatch_bit)) != 0; }
80 bool calls_vm() const { return (_flags & (1 << calls_vm_bit )) != 0; }
81 bool is_wide() const { return (_flags & (1 << wide_bit )) != 0; }
82 TosState tos_in() const { return _tos_in; }
83 TosState tos_out() const { return _tos_out; }
84 void generate(InterpreterMacroAssembler* masm);
85 };
86
87
88 // The TemplateTable defines all Templates and provides accessor functions
89 // to get the template for a given bytecode.
90
91 class TemplateTable: AllStatic {
92 public:
93 enum Operation { add, sub, mul, div, rem, _and, _or, _xor, shl, shr, ushr };
94 enum Condition { equal, not_equal, less, less_equal, greater, greater_equal };
95 enum CacheByte { f1_byte = 1, f2_byte = 2, f1_oop = 0x11 }; // byte_no codes
96
97 private:
98 static bool _is_initialized; // true if TemplateTable has been initialized
99 static Template _template_table [Bytecodes::number_of_codes];
100 static Template _template_table_wide[Bytecodes::number_of_codes];
101
102 static Template* _desc; // the current template to be generated
103 static Bytecodes::Code bytecode() { return _desc->bytecode(); }
104
105 static BarrierSet* _bs; // Cache the barrier set.
106 public:
107 //%note templates_1
108 static InterpreterMacroAssembler* _masm; // the assembler used when generating templates
109
110 private:
111
112 // special registers
113 static inline Address at_bcp(int offset);
114
115 // helpers
116 static void unimplemented_bc();
117 static void patch_bytecode(Bytecodes::Code bc, Register scratch1,
118 Register scratch2, bool load_bc_in_scratch = true);
119
120 // C calls
121 static void call_VM(Register oop_result, address entry_point);
122 static void call_VM(Register oop_result, address entry_point, Register arg_1);
123 static void call_VM(Register oop_result, address entry_point, Register arg_1, Register arg_2);
124 static void call_VM(Register oop_result, address entry_point, Register arg_1, Register arg_2, Register arg_3);
125
126 // these overloadings are not presently used on SPARC:
127 static void call_VM(Register oop_result, Register last_java_sp, address entry_point);
128 static void call_VM(Register oop_result, Register last_java_sp, address entry_point, Register arg_1);
129 static void call_VM(Register oop_result, Register last_java_sp, address entry_point, Register arg_1, Register arg_2);
130 static void call_VM(Register oop_result, Register last_java_sp, address entry_point, Register arg_1, Register arg_2, Register arg_3);
131
132 // bytecodes
133 static void nop();
134
135 static void aconst_null();
136 static void iconst(int value);
137 static void lconst(int value);
138 static void fconst(int value);
139 static void dconst(int value);
140
141 static void bipush();
142 static void sipush();
143 static void ldc(bool wide);
144 static void ldc2_w();
145 static void fast_aldc(bool wide);
146
147 static void locals_index(Register reg, int offset = 1);
148 static void iload();
149 static void fast_iload();
150 static void fast_iload2();
151 static void fast_icaload();
152 static void lload();
153 static void fload();
154 static void dload();
155 static void aload();
156
157 static void locals_index_wide(Register reg);
158 static void wide_iload();
159 static void wide_lload();
160 static void wide_fload();
161 static void wide_dload();
162 static void wide_aload();
163
164 static void iaload();
165 static void laload();
166 static void faload();
167 static void daload();
168 static void aaload();
169 static void baload();
170 static void caload();
171 static void saload();
172
173 static void iload(int n);
174 static void lload(int n);
175 static void fload(int n);
176 static void dload(int n);
177 static void aload(int n);
178 static void aload_0();
179
180 static void istore();
181 static void lstore();
182 static void fstore();
183 static void dstore();
184 static void astore();
185
186 static void wide_istore();
187 static void wide_lstore();
188 static void wide_fstore();
189 static void wide_dstore();
190 static void wide_astore();
191
192 static void iastore();
193 static void lastore();
194 static void fastore();
195 static void dastore();
196 static void aastore();
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 result , // either noreg or output for f1/f2
270 Register cache, // output for CP cache
271 Register index, // output for CP index
272 size_t index_size); // one of 1,2,4
273 static void load_invoke_cp_cache_entry(int byte_no,
274 Register method,
275 Register itable_index,
276 Register flags,
277 bool is_invokevirtual,
278 bool is_virtual_final,
279 bool is_invokedynamic);
280 static void load_field_cp_cache_entry(Register obj,
281 Register cache,
282 Register index,
283 Register offset,
284 Register flags,
285 bool is_static);
286 static void invokevirtual(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 fast_invokevfinal(int byte_no);
292
293 static void getfield_or_static(int byte_no, bool is_static);
294 static void putfield_or_static(int byte_no, bool is_static);
295 static void getfield(int byte_no);
296 static void putfield(int byte_no);
297 static void getstatic(int byte_no);
298 static void putstatic(int byte_no);
299 static void pop_and_check_object(Register obj);
300
301 static void _new();
302 static void newarray();
303 static void anewarray();
304 static void arraylength();
305 static void checkcast();
306 static void instanceof();
307
308 static void athrow();
309
310 static void monitorenter();
311 static void monitorexit();
312
313 static void wide();
314 static void multianewarray();
315
316 static void fast_xaccess(TosState state);
317 static void fast_accessfield(TosState state);
318 static void fast_storefield(TosState state);
319
320 static void _breakpoint();
321
322 static void shouldnotreachhere();
323
324 // jvmti support
325 static void jvmti_post_field_access(Register cache, Register index, bool is_static, bool has_tos);
326 static void jvmti_post_field_mod(Register cache, Register index, bool is_static);
327 static void jvmti_post_fast_field_mod();
328
329 // debugging of TemplateGenerator
330 static void transition(TosState tos_in, TosState tos_out);// checks if in/out states expected by template generator correspond to table entries
331
332 // initialization helpers
333 static void def(Bytecodes::Code code, int flags, TosState in, TosState out, void (*gen)( ), char filler );
334 static void def(Bytecodes::Code code, int flags, TosState in, TosState out, void (*gen)(int arg ), int arg );
335 static void def(Bytecodes::Code code, int flags, TosState in, TosState out, void (*gen)(bool arg ), bool arg );
336 static void def(Bytecodes::Code code, int flags, TosState in, TosState out, void (*gen)(TosState tos), TosState tos);
337 static void def(Bytecodes::Code code, int flags, TosState in, TosState out, void (*gen)(Operation op), Operation op);
338 static void def(Bytecodes::Code code, int flags, TosState in, TosState out, void (*gen)(Condition cc), Condition cc);
339
340 friend class Template;
341
342 // InterpreterMacroAssembler::is_a(), etc., need TemplateTable::call_VM().
343 friend class InterpreterMacroAssembler;
344
345 public:
346 // Initialization
347 static void initialize();
348 static void pd_initialize();
349
350 // Templates
351 static Template* template_for (Bytecodes::Code code) { Bytecodes::check (code); return &_template_table [code]; }
352 static Template* template_for_wide(Bytecodes::Code code) { Bytecodes::wide_check(code); return &_template_table_wide[code]; }
353
354 // Platform specifics
355 #ifdef TARGET_ARCH_MODEL_x86_32
356 # include "templateTable_x86_32.hpp"
357 #endif
358 #ifdef TARGET_ARCH_MODEL_x86_64
359 # include "templateTable_x86_64.hpp"
360 #endif
361 #ifdef TARGET_ARCH_MODEL_sparc
362 # include "templateTable_sparc.hpp"
363 #endif
364 #ifdef TARGET_ARCH_MODEL_zero
365 # include "templateTable_zero.hpp"
366 #endif
367
368 };
369 #endif /* !CC_INTERP */
370
371 #endif // SHARE_VM_INTERPRETER_TEMPLATETABLE_HPP