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 39 class 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 44 class 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 81 class 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 static void vload(); 148 149 static void locals_index_wide(Register reg); 150 static void wide_iload(); 151 static void wide_lload(); 152 static void wide_fload(); 153 static void wide_dload(); 154 static void wide_aload(); 155 static void wide_vload(); 156 157 static void iaload(); 158 static void laload(); 159 static void faload(); 160 static void daload(); 161 static void aaload(); 162 static void vaload(); 163 static void baload(); 164 static void caload(); 165 static void saload(); 166 167 static void iload(int n); 168 static void lload(int n); 169 static void fload(int n); 170 static void dload(int n); 171 static void aload(int n); 172 static void aload_0(); 173 static void nofast_aload_0(); 174 static void nofast_iload(); 175 static void iload_internal(RewriteControl rc = may_rewrite); 176 static void aload_0_internal(RewriteControl rc = may_rewrite); 177 178 static void istore(); 179 static void lstore(); 180 static void fstore(); 181 static void dstore(); 182 static void astore(); 183 static void vstore(); 184 185 static void wide_istore(); 186 static void wide_lstore(); 187 static void wide_fstore(); 188 static void wide_dstore(); 189 static void wide_astore(); 190 static void wide_vstore(); 191 192 static void iastore(); 193 static void lastore(); 194 static void fastore(); 195 static void dastore(); 196 static void aastore(); 197 static void vastore(); 198 static void bastore(); 199 static void castore(); 200 static void sastore(); 201 202 static void istore(int n); 203 static void lstore(int n); 204 static void fstore(int n); 205 static void dstore(int n); 206 static void astore(int n); 207 208 static void pop(); 209 static void pop2(); 210 static void dup(); 211 static void dup_x1(); 212 static void dup_x2(); 213 static void dup2(); 214 static void dup2_x1(); 215 static void dup2_x2(); 216 static void swap(); 217 218 static void iop2(Operation op); 219 static void lop2(Operation op); 220 static void fop2(Operation op); 221 static void dop2(Operation op); 222 223 static void idiv(); 224 static void irem(); 225 226 static void lmul(); 227 static void ldiv(); 228 static void lrem(); 229 static void lshl(); 230 static void lshr(); 231 static void lushr(); 232 233 static void ineg(); 234 static void lneg(); 235 static void fneg(); 236 static void dneg(); 237 238 static void iinc(); 239 static void wide_iinc(); 240 static void convert(); 241 static void lcmp(); 242 243 static void float_cmp (bool is_float, int unordered_result); 244 static void float_cmp (int unordered_result); 245 static void double_cmp(int unordered_result); 246 247 static void count_calls(Register method, Register temp); 248 static void branch(bool is_jsr, bool is_wide); 249 static void if_0cmp (Condition cc); 250 static void if_icmp (Condition cc); 251 static void if_nullcmp(Condition cc); 252 static void if_acmp (Condition cc); 253 254 static void _goto(); 255 static void jsr(); 256 static void ret(); 257 static void wide_ret(); 258 259 static void goto_w(); 260 static void jsr_w(); 261 262 static void tableswitch(); 263 static void lookupswitch(); 264 static void fast_linearswitch(); 265 static void fast_binaryswitch(); 266 267 static void _return(TosState state); 268 269 static void resolve_cache_and_index(int byte_no, // one of 1,2,11 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 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); 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 condy_helper(Label& Done); // shared by ldc instances 305 static void vwithfield(); 306 307 static void _new(); 308 static void vdefault(); 309 static void newarray(); 310 static void anewarray(); 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 #include CPU_HEADER(templateTable) 366 367 }; 368 #endif /* !CC_INTERP */ 369 370 #endif // SHARE_VM_INTERPRETER_TEMPLATETABLE_HPP