1 /* 2 * Copyright (c) 1997, 2018, 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_TEMPLATEINTERPRETER_HPP 26 #define SHARE_VM_INTERPRETER_TEMPLATEINTERPRETER_HPP 27 28 #include "interpreter/abstractInterpreter.hpp" 29 #include "interpreter/templateTable.hpp" 30 31 // This file contains the platform-independent parts 32 // of the template interpreter and the template interpreter generator. 33 34 #ifndef CC_INTERP 35 36 class InterpreterMacroAssembler; 37 class InterpreterCodelet; 38 39 //------------------------------------------------------------------------------------------------------------------------ 40 // A little wrapper class to group tosca-specific entry points into a unit. 41 // (tosca = Top-Of-Stack CAche) 42 43 class EntryPoint { 44 private: 45 address _entry[number_of_states]; 46 47 public: 48 // Construction 49 EntryPoint(); 50 EntryPoint(address bentry, address zentry, address centry, address sentry, address aentry, address ientry, address lentry, address fentry, address dentry, address ventry); 51 52 // Attributes 53 address entry(TosState state) const; // return target address for a given tosca state 54 void set_entry(TosState state, address entry); // set target address for a given tosca state 55 void print(); 56 57 // Comparison 58 bool operator == (const EntryPoint& y); // for debugging only 59 }; 60 61 62 //------------------------------------------------------------------------------------------------------------------------ 63 // A little wrapper class to group tosca-specific dispatch tables into a unit. 64 65 class DispatchTable { 66 public: 67 enum { length = 1 << BitsPerByte }; // an entry point for each byte value (also for undefined bytecodes) 68 69 private: 70 address _table[number_of_states][length]; // dispatch tables, indexed by tosca and bytecode 71 72 public: 73 // Attributes 74 EntryPoint entry(int i) const; // return entry point for a given bytecode i 75 void set_entry(int i, EntryPoint& entry); // set entry point for a given bytecode i table_for(TosState state)76 address* table_for(TosState state) { return _table[state]; } table_for()77 address* table_for() { return table_for((TosState)0); } distance_from(address * table)78 int distance_from(address *table) { return table - table_for(); } distance_from(TosState state)79 int distance_from(TosState state) { return distance_from(table_for(state)); } 80 81 // Comparison 82 bool operator == (DispatchTable& y); // for debugging only 83 }; 84 85 class TemplateInterpreter: public AbstractInterpreter { 86 friend class VMStructs; 87 friend class InterpreterMacroAssembler; 88 friend class TemplateInterpreterGenerator; 89 friend class TemplateTable; 90 friend class CodeCacheExtensions; 91 // friend class Interpreter; 92 public: 93 94 enum MoreConstants { 95 max_invoke_length = 5, // invokedynamic is the longest 96 max_bytecode_length = 6, // worse case is wide iinc, "reexecute" bytecodes are excluded because "skip" will be 0 97 number_of_return_entries = max_invoke_length + 1, // number of return entry points 98 number_of_deopt_entries = max_bytecode_length + 1, // number of deoptimization entry points 99 number_of_return_addrs = number_of_states // number of return addresses 100 }; 101 102 protected: 103 104 static address _throw_ArrayIndexOutOfBoundsException_entry; 105 static address _throw_ArrayStoreException_entry; 106 static address _throw_ArithmeticException_entry; 107 static address _throw_ClassCastException_entry; 108 static address _throw_NullPointerException_entry; 109 static address _throw_exception_entry; 110 111 static address _throw_StackOverflowError_entry; 112 113 static address _remove_activation_entry; // continuation address if an exception is not handled by current frame 114 #ifdef HOTSWAP 115 static address _remove_activation_preserving_args_entry; // continuation address when current frame is being popped 116 #endif // HOTSWAP 117 118 #ifndef PRODUCT 119 static EntryPoint _trace_code; 120 #endif // !PRODUCT 121 static EntryPoint _return_entry[number_of_return_entries]; // entry points to return to from a call 122 static EntryPoint _earlyret_entry; // entry point to return early from a call 123 static EntryPoint _deopt_entry[number_of_deopt_entries]; // entry points to return to from a deoptimization 124 static address _deopt_reexecute_return_entry; 125 static EntryPoint _safept_entry; 126 127 static address _invoke_return_entry[number_of_return_addrs]; // for invokestatic, invokespecial, invokevirtual return entries 128 static address _invokeinterface_return_entry[number_of_return_addrs]; // for invokeinterface return entries 129 static address _invokedynamic_return_entry[number_of_return_addrs]; // for invokedynamic return entries 130 131 static DispatchTable _active_table; // the active dispatch table (used by the interpreter for dispatch) 132 static DispatchTable _normal_table; // the normal dispatch table (used to set the active table in normal mode) 133 static DispatchTable _safept_table; // the safepoint dispatch table (used to set the active table for safepoints) 134 static address _wentry_point[DispatchTable::length]; // wide instructions only (vtos tosca always) 135 136 137 public: 138 // Initialization/debugging 139 static void initialize(); 140 // this only returns whether a pc is within generated code for the interpreter. contains(address pc)141 static bool contains(address pc) { return _code != NULL && _code->contains(pc); } 142 // Debugging/printing 143 static InterpreterCodelet* codelet_containing(address pc); 144 145 146 public: 147 remove_activation_early_entry(TosState state)148 static address remove_activation_early_entry(TosState state) { return _earlyret_entry.entry(state); } 149 #ifdef HOTSWAP remove_activation_preserving_args_entry()150 static address remove_activation_preserving_args_entry() { return _remove_activation_preserving_args_entry; } 151 #endif // HOTSWAP 152 remove_activation_entry()153 static address remove_activation_entry() { return _remove_activation_entry; } throw_exception_entry()154 static address throw_exception_entry() { return _throw_exception_entry; } throw_ArithmeticException_entry()155 static address throw_ArithmeticException_entry() { return _throw_ArithmeticException_entry; } throw_NullPointerException_entry()156 static address throw_NullPointerException_entry() { return _throw_NullPointerException_entry; } throw_StackOverflowError_entry()157 static address throw_StackOverflowError_entry() { return _throw_StackOverflowError_entry; } 158 159 // Code generation 160 #ifndef PRODUCT trace_code(TosState state)161 static address trace_code (TosState state) { return _trace_code.entry(state); } 162 #endif // !PRODUCT dispatch_table(TosState state)163 static address* dispatch_table(TosState state) { return _active_table.table_for(state); } dispatch_table()164 static address* dispatch_table() { return _active_table.table_for(); } distance_from_dispatch_table(TosState state)165 static int distance_from_dispatch_table(TosState state){ return _active_table.distance_from(state); } normal_table(TosState state)166 static address* normal_table(TosState state) { return _normal_table.table_for(state); } normal_table()167 static address* normal_table() { return _normal_table.table_for(); } safept_table(TosState state)168 static address* safept_table(TosState state) { return _safept_table.table_for(state); } 169 170 // Support for invokes invoke_return_entry_table()171 static address* invoke_return_entry_table() { return _invoke_return_entry; } invokeinterface_return_entry_table()172 static address* invokeinterface_return_entry_table() { return _invokeinterface_return_entry; } invokedynamic_return_entry_table()173 static address* invokedynamic_return_entry_table() { return _invokedynamic_return_entry; } 174 static int TosState_as_index(TosState state); 175 176 static address* invoke_return_entry_table_for(Bytecodes::Code code); 177 178 static address deopt_entry(TosState state, int length); deopt_reexecute_return_entry()179 static address deopt_reexecute_return_entry() { return _deopt_reexecute_return_entry; } 180 static address return_entry(TosState state, int length, Bytecodes::Code code); 181 182 // Safepoint support 183 static void notice_safepoints(); // stops the thread when reaching a safepoint 184 static void ignore_safepoints(); // ignores safepoints 185 186 // Deoptimization support 187 // Compute the entry address for continuation after 188 static address deopt_continue_after_entry(Method* method, 189 address bcp, 190 int callee_parameters, 191 bool is_top_frame); 192 // Deoptimization should reexecute this bytecode 193 static bool bytecode_should_reexecute(Bytecodes::Code code); 194 // Compute the address for reexecution 195 static address deopt_reexecute_entry(Method* method, address bcp); 196 197 // Size of interpreter code. Max size with JVMTI 198 static int InterpreterCodeSize; 199 }; 200 201 #endif // !CC_INTERP 202 203 #endif // SHARE_VM_INTERPRETER_TEMPLATEINTERPRETER_HPP 204