1 /* 2 * Copyright (c) 1997, 2019, 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 #include "precompiled.hpp" 26 #include "interpreter/interpreter.hpp" 27 #include "interpreter/interpreterRuntime.hpp" 28 #include "interpreter/interp_masm.hpp" 29 #include "interpreter/templateInterpreter.hpp" 30 #include "interpreter/templateInterpreterGenerator.hpp" 31 #include "interpreter/templateTable.hpp" 32 #include "logging/log.hpp" 33 #include "memory/resourceArea.hpp" 34 #include "runtime/safepoint.hpp" 35 #include "runtime/timerTrace.hpp" 36 #include "utilities/copy.hpp" 37 38 #ifndef CC_INTERP 39 40 # define __ _masm-> 41 42 void TemplateInterpreter::initialize() { 43 if (_code != NULL) return; 44 // assertions 45 assert((int)Bytecodes::number_of_codes <= (int)DispatchTable::length, 46 "dispatch table too small"); 47 48 AbstractInterpreter::initialize(); 49 50 TemplateTable::initialize(); 51 52 // generate interpreter 53 { ResourceMark rm; 54 TraceTime timer("Interpreter generation", TRACETIME_LOG(Info, startuptime)); 55 int code_size = InterpreterCodeSize; 56 NOT_PRODUCT(code_size *= 4;) // debug uses extra interpreter code space 57 _code = new StubQueue(new InterpreterCodeletInterface, code_size, NULL, 58 "Interpreter"); 59 TemplateInterpreterGenerator g(_code); 60 // Free the unused memory not occupied by the interpreter and the stubs 61 _code->deallocate_unused_tail(); 62 } 63 64 if (PrintInterpreter) { 65 ResourceMark rm; 66 print(); 67 } 68 69 // initialize dispatch table 70 _active_table = _normal_table; 71 } 72 73 //------------------------------------------------------------------------------------------------------------------------ 74 // Implementation of EntryPoint 75 76 EntryPoint::EntryPoint() { 77 assert(number_of_states == 10, "check the code below"); 78 _entry[btos] = NULL; 79 _entry[ztos] = NULL; 80 _entry[ctos] = NULL; 81 _entry[stos] = NULL; 82 _entry[atos] = NULL; 83 _entry[itos] = NULL; 84 _entry[ltos] = NULL; 85 _entry[ftos] = NULL; 86 _entry[dtos] = NULL; 87 _entry[vtos] = NULL; 88 } 89 90 91 EntryPoint::EntryPoint(address bentry, address zentry, address centry, address sentry, address aentry, address ientry, address lentry, address fentry, address dentry, address ventry) { 92 assert(number_of_states == 10, "check the code below"); 93 _entry[btos] = bentry; 94 _entry[ztos] = zentry; 95 _entry[ctos] = centry; 96 _entry[stos] = sentry; 97 _entry[atos] = aentry; 98 _entry[itos] = ientry; 99 _entry[ltos] = lentry; 100 _entry[ftos] = fentry; 101 _entry[dtos] = dentry; 102 _entry[vtos] = ventry; 103 } 104 105 106 void EntryPoint::set_entry(TosState state, address entry) { 107 assert(0 <= state && state < number_of_states, "state out of bounds"); 108 _entry[state] = entry; 109 } 110 111 112 address EntryPoint::entry(TosState state) const { 113 assert(0 <= state && state < number_of_states, "state out of bounds"); 114 return _entry[state]; 115 } 116 117 118 void EntryPoint::print() { 119 tty->print("["); 120 for (int i = 0; i < number_of_states; i++) { 121 if (i > 0) tty->print(", "); 122 tty->print(INTPTR_FORMAT, p2i(_entry[i])); 123 } 124 tty->print("]"); 125 } 126 127 128 bool EntryPoint::operator == (const EntryPoint& y) { 129 int i = number_of_states; 130 while (i-- > 0) { 131 if (_entry[i] != y._entry[i]) return false; 132 } 133 return true; 134 } 135 136 137 //------------------------------------------------------------------------------------------------------------------------ 138 // Implementation of DispatchTable 139 140 EntryPoint DispatchTable::entry(int i) const { 141 assert(0 <= i && i < length, "index out of bounds"); 142 return 143 EntryPoint( 144 _table[btos][i], 145 _table[ztos][i], 146 _table[ctos][i], 147 _table[stos][i], 148 _table[atos][i], 149 _table[itos][i], 150 _table[ltos][i], 151 _table[ftos][i], 152 _table[dtos][i], 153 _table[vtos][i] 154 ); 155 } 156 157 158 void DispatchTable::set_entry(int i, EntryPoint& entry) { 159 assert(0 <= i && i < length, "index out of bounds"); 160 assert(number_of_states == 10, "check the code below"); 161 _table[btos][i] = entry.entry(btos); 162 _table[ztos][i] = entry.entry(ztos); 163 _table[ctos][i] = entry.entry(ctos); 164 _table[stos][i] = entry.entry(stos); 165 _table[atos][i] = entry.entry(atos); 166 _table[itos][i] = entry.entry(itos); 167 _table[ltos][i] = entry.entry(ltos); 168 _table[ftos][i] = entry.entry(ftos); 169 _table[dtos][i] = entry.entry(dtos); 170 _table[vtos][i] = entry.entry(vtos); 171 } 172 173 174 bool DispatchTable::operator == (DispatchTable& y) { 175 int i = length; 176 while (i-- > 0) { 177 EntryPoint t = y.entry(i); // for compiler compatibility (BugId 4150096) 178 if (!(entry(i) == t)) return false; 179 } 180 return true; 181 } 182 183 address TemplateInterpreter::_remove_activation_entry = NULL; 184 address TemplateInterpreter::_remove_activation_preserving_args_entry = NULL; 185 186 187 address TemplateInterpreter::_throw_ArrayIndexOutOfBoundsException_entry = NULL; 188 address TemplateInterpreter::_throw_ArrayStoreException_entry = NULL; 189 address TemplateInterpreter::_throw_ArithmeticException_entry = NULL; 190 address TemplateInterpreter::_throw_ClassCastException_entry = NULL; 191 address TemplateInterpreter::_throw_NullPointerException_entry = NULL; 192 address TemplateInterpreter::_throw_StackOverflowError_entry = NULL; 193 address TemplateInterpreter::_throw_exception_entry = NULL; 194 195 #ifndef PRODUCT 196 EntryPoint TemplateInterpreter::_trace_code; 197 #endif // !PRODUCT 198 EntryPoint TemplateInterpreter::_return_entry[TemplateInterpreter::number_of_return_entries]; 199 EntryPoint TemplateInterpreter::_earlyret_entry; 200 EntryPoint TemplateInterpreter::_deopt_entry [TemplateInterpreter::number_of_deopt_entries ]; 201 address TemplateInterpreter::_deopt_reexecute_return_entry; 202 EntryPoint TemplateInterpreter::_safept_entry; 203 204 address TemplateInterpreter::_invoke_return_entry[TemplateInterpreter::number_of_return_addrs]; 205 address TemplateInterpreter::_invokeinterface_return_entry[TemplateInterpreter::number_of_return_addrs]; 206 address TemplateInterpreter::_invokedynamic_return_entry[TemplateInterpreter::number_of_return_addrs]; 207 208 DispatchTable TemplateInterpreter::_active_table; 209 DispatchTable TemplateInterpreter::_normal_table; 210 DispatchTable TemplateInterpreter::_safept_table; 211 address TemplateInterpreter::_wentry_point[DispatchTable::length]; 212 213 214 //------------------------------------------------------------------------------------------------------------------------ 215 // Entry points 216 217 /** 218 * Returns the return entry table for the given invoke bytecode. 219 */ 220 address* TemplateInterpreter::invoke_return_entry_table_for(Bytecodes::Code code) { 221 switch (code) { 222 case Bytecodes::_invokestatic: 223 case Bytecodes::_invokespecial: 224 case Bytecodes::_invokevirtual: 225 case Bytecodes::_invokehandle: 226 return Interpreter::invoke_return_entry_table(); 227 case Bytecodes::_invokeinterface: 228 return Interpreter::invokeinterface_return_entry_table(); 229 case Bytecodes::_invokedynamic: 230 return Interpreter::invokedynamic_return_entry_table(); 231 default: 232 fatal("invalid bytecode: %s", Bytecodes::name(code)); 233 return NULL; 234 } 235 } 236 237 /** 238 * Returns the return entry address for the given top-of-stack state and bytecode. 239 */ 240 address TemplateInterpreter::return_entry(TosState state, int length, Bytecodes::Code code) { 241 guarantee(0 <= length && length < Interpreter::number_of_return_entries, "illegal length"); 242 const int index = TosState_as_index(state); 243 switch (code) { 244 case Bytecodes::_invokestatic: 245 case Bytecodes::_invokespecial: 246 case Bytecodes::_invokevirtual: 247 case Bytecodes::_invokehandle: 248 return _invoke_return_entry[index]; 249 case Bytecodes::_invokeinterface: 250 return _invokeinterface_return_entry[index]; 251 case Bytecodes::_invokedynamic: 252 return _invokedynamic_return_entry[index]; 253 default: 254 assert(!Bytecodes::is_invoke(code), "invoke instructions should be handled separately: %s", Bytecodes::name(code)); 255 address entry = _return_entry[length].entry(state); 256 vmassert(entry != NULL, "unsupported return entry requested, length=%d state=%d", length, index); 257 return entry; 258 } 259 } 260 261 262 address TemplateInterpreter::deopt_entry(TosState state, int length) { 263 guarantee(0 <= length && length < Interpreter::number_of_deopt_entries, "illegal length"); 264 address entry = _deopt_entry[length].entry(state); 265 vmassert(entry != NULL, "unsupported deopt entry requested, length=%d state=%d", length, TosState_as_index(state)); 266 return entry; 267 } 268 269 //------------------------------------------------------------------------------------------------------------------------ 270 // Suport for invokes 271 272 int TemplateInterpreter::TosState_as_index(TosState state) { 273 assert( state < number_of_states , "Invalid state in TosState_as_index"); 274 assert(0 <= (int)state && (int)state < TemplateInterpreter::number_of_return_addrs, "index out of bounds"); 275 return (int)state; 276 } 277 278 279 //------------------------------------------------------------------------------------------------------------------------ 280 // Safepoint support 281 282 static inline void copy_table(address* from, address* to, int size) { 283 // Copy non-overlapping tables. 284 if (SafepointSynchronize::is_at_safepoint()) { 285 // Nothing is using the table at a safepoint so skip atomic word copy. 286 Copy::disjoint_words((HeapWord*)from, (HeapWord*)to, (size_t)size); 287 } else { 288 // Use atomic word copy when not at a safepoint for safety. 289 Copy::disjoint_words_atomic((HeapWord*)from, (HeapWord*)to, (size_t)size); 290 } 291 } 292 293 void TemplateInterpreter::notice_safepoints() { 294 if (!_notice_safepoints) { 295 log_debug(interpreter, safepoint)("switching active_table to safept_table."); 296 // switch to safepoint dispatch table 297 _notice_safepoints = true; 298 copy_table((address*)&_safept_table, (address*)&_active_table, sizeof(_active_table) / sizeof(address)); 299 } else { 300 log_debug(interpreter, safepoint)("active_table is already safept_table; " 301 "notice_safepoints() call is no-op."); 302 } 303 } 304 305 // switch from the dispatch table which notices safepoints back to the 306 // normal dispatch table. So that we can notice single stepping points, 307 // keep the safepoint dispatch table if we are single stepping in JVMTI. 308 // Note that the should_post_single_step test is exactly as fast as the 309 // JvmtiExport::_enabled test and covers both cases. 310 void TemplateInterpreter::ignore_safepoints() { 311 if (_notice_safepoints) { 312 if (!JvmtiExport::should_post_single_step()) { 313 log_debug(interpreter, safepoint)("switching active_table to normal_table."); 314 // switch to normal dispatch table 315 _notice_safepoints = false; 316 copy_table((address*)&_normal_table, (address*)&_active_table, sizeof(_active_table) / sizeof(address)); 317 } else { 318 log_debug(interpreter, safepoint)("single stepping is still active; " 319 "ignoring ignore_safepoints() call."); 320 } 321 } else { 322 log_debug(interpreter, safepoint)("active_table is already normal_table; " 323 "ignore_safepoints() call is no-op."); 324 } 325 } 326 327 //------------------------------------------------------------------------------------------------------------------------ 328 // Deoptimization support 329 330 // If deoptimization happens, this function returns the point of next bytecode to continue execution 331 address TemplateInterpreter::deopt_continue_after_entry(Method* method, address bcp, int callee_parameters, bool is_top_frame) { 332 return AbstractInterpreter::deopt_continue_after_entry(method, bcp, callee_parameters, is_top_frame); 333 } 334 335 // If deoptimization happens, this function returns the point where the interpreter reexecutes 336 // the bytecode. 337 // Note: Bytecodes::_athrow (C1 only) and Bytecodes::_return are the special cases 338 // that do not return "Interpreter::deopt_entry(vtos, 0)" 339 address TemplateInterpreter::deopt_reexecute_entry(Method* method, address bcp) { 340 assert(method->contains(bcp), "just checkin'"); 341 Bytecodes::Code code = Bytecodes::code_at(method, bcp); 342 if (code == Bytecodes::_return_register_finalizer) { 343 // This is used for deopt during registration of finalizers 344 // during Object.<init>. We simply need to resume execution at 345 // the standard return vtos bytecode to pop the frame normally. 346 // reexecuting the real bytecode would cause double registration 347 // of the finalizable object. 348 return Interpreter::deopt_reexecute_return_entry(); 349 } else { 350 return AbstractInterpreter::deopt_reexecute_entry(method, bcp); 351 } 352 } 353 354 // If deoptimization happens, the interpreter should reexecute this bytecode. 355 // This function mainly helps the compilers to set up the reexecute bit. 356 bool TemplateInterpreter::bytecode_should_reexecute(Bytecodes::Code code) { 357 if (code == Bytecodes::_return) { 358 //Yes, we consider Bytecodes::_return as a special case of reexecution 359 return true; 360 } else { 361 return AbstractInterpreter::bytecode_should_reexecute(code); 362 } 363 } 364 365 InterpreterCodelet* TemplateInterpreter::codelet_containing(address pc) { 366 return (InterpreterCodelet*)_code->stub_containing(pc); 367 } 368 369 #endif // !CC_INTERP