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