1 /* 2 * Copyright (c) 1999, 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 #ifndef SHARE_C1_C1_CODESTUBS_HPP 26 #define SHARE_C1_C1_CODESTUBS_HPP 27 28 #include "c1/c1_FrameMap.hpp" 29 #include "c1/c1_IR.hpp" 30 #include "c1/c1_Instruction.hpp" 31 #include "c1/c1_LIR.hpp" 32 #include "c1/c1_Runtime1.hpp" 33 #include "code/nativeInst.hpp" 34 #include "utilities/growableArray.hpp" 35 #include "utilities/macros.hpp" 36 37 class CodeEmitInfo; 38 class LIR_Assembler; 39 class LIR_OpVisitState; 40 41 // CodeStubs are little 'out-of-line' pieces of code that 42 // usually handle slow cases of operations. All code stubs 43 // are collected and code is emitted at the end of the 44 // nmethod. 45 46 class CodeStub: public CompilationResourceObj { 47 protected: 48 Label _entry; // label at the stub entry point 49 Label _continuation; // label where stub continues, if any 50 51 public: 52 CodeStub() {} 53 54 // code generation 55 void assert_no_unbound_labels() { assert(!_entry.is_unbound() && !_continuation.is_unbound(), "unbound label"); } 56 virtual void emit_code(LIR_Assembler* e) = 0; 57 virtual CodeEmitInfo* info() const { return NULL; } 58 virtual bool is_exception_throw_stub() const { return false; } 59 virtual bool is_range_check_stub() const { return false; } 60 virtual bool is_divbyzero_stub() const { return false; } 61 virtual bool is_simple_exception_stub() const { return false; } 62 #ifndef PRODUCT 63 virtual void print_name(outputStream* out) const = 0; 64 #endif 65 66 // label access 67 Label* entry() { return &_entry; } 68 Label* continuation() { return &_continuation; } 69 // for LIR 70 virtual void visit(LIR_OpVisitState* visit) { 71 #ifndef PRODUCT 72 if (LIRTracePeephole && Verbose) { 73 tty->print("no visitor for "); 74 print_name(tty); 75 tty->cr(); 76 } 77 #endif 78 } 79 }; 80 81 class CodeStubList: public GrowableArray<CodeStub*> { 82 public: 83 CodeStubList(): GrowableArray<CodeStub*>() {} 84 85 void append(CodeStub* stub) { 86 if (!contains(stub)) { 87 GrowableArray<CodeStub*>::append(stub); 88 } 89 } 90 }; 91 92 class CounterOverflowStub: public CodeStub { 93 private: 94 CodeEmitInfo* _info; 95 int _bci; 96 LIR_Opr _method; 97 98 public: 99 CounterOverflowStub(CodeEmitInfo* info, int bci, LIR_Opr method) : _info(info), _bci(bci), _method(method) { 100 } 101 102 virtual void emit_code(LIR_Assembler* e); 103 104 virtual void visit(LIR_OpVisitState* visitor) { 105 visitor->do_slow_case(_info); 106 visitor->do_input(_method); 107 } 108 109 #ifndef PRODUCT 110 virtual void print_name(outputStream* out) const { out->print("CounterOverflowStub"); } 111 #endif // PRODUCT 112 113 }; 114 115 class ConversionStub: public CodeStub { 116 private: 117 Bytecodes::Code _bytecode; 118 LIR_Opr _input; 119 LIR_Opr _result; 120 121 static float float_zero; 122 static double double_zero; 123 public: 124 ConversionStub(Bytecodes::Code bytecode, LIR_Opr input, LIR_Opr result) 125 : _bytecode(bytecode), _input(input), _result(result) { 126 } 127 128 Bytecodes::Code bytecode() { return _bytecode; } 129 LIR_Opr input() { return _input; } 130 LIR_Opr result() { return _result; } 131 132 virtual void emit_code(LIR_Assembler* e); 133 virtual void visit(LIR_OpVisitState* visitor) { 134 visitor->do_slow_case(); 135 visitor->do_input(_input); 136 visitor->do_output(_result); 137 } 138 #ifndef PRODUCT 139 virtual void print_name(outputStream* out) const { out->print("ConversionStub"); } 140 #endif // PRODUCT 141 }; 142 143 144 // Throws ArrayIndexOutOfBoundsException by default but can be 145 // configured to throw IndexOutOfBoundsException in constructor 146 class RangeCheckStub: public CodeStub { 147 private: 148 CodeEmitInfo* _info; 149 LIR_Opr _index; 150 LIR_Opr _array; 151 bool _throw_index_out_of_bounds_exception; 152 153 public: 154 // For ArrayIndexOutOfBoundsException. 155 RangeCheckStub(CodeEmitInfo* info, LIR_Opr index, LIR_Opr array); 156 // For IndexOutOfBoundsException. 157 RangeCheckStub(CodeEmitInfo* info, LIR_Opr index); 158 virtual void emit_code(LIR_Assembler* e); 159 virtual CodeEmitInfo* info() const { return _info; } 160 virtual bool is_exception_throw_stub() const { return true; } 161 virtual bool is_range_check_stub() const { return true; } 162 virtual void visit(LIR_OpVisitState* visitor) { 163 visitor->do_slow_case(_info); 164 visitor->do_input(_index); 165 if (_array) { visitor->do_input(_array); } 166 } 167 #ifndef PRODUCT 168 virtual void print_name(outputStream* out) const { out->print("RangeCheckStub"); } 169 #endif // PRODUCT 170 }; 171 172 // stub used when predicate fails and deoptimization is needed 173 class PredicateFailedStub: public CodeStub { 174 private: 175 CodeEmitInfo* _info; 176 177 public: 178 PredicateFailedStub(CodeEmitInfo* info); 179 virtual void emit_code(LIR_Assembler* e); 180 virtual CodeEmitInfo* info() const { return _info; } 181 virtual void visit(LIR_OpVisitState* visitor) { 182 visitor->do_slow_case(_info); 183 } 184 #ifndef PRODUCT 185 virtual void print_name(outputStream* out) const { out->print("PredicateFailedStub"); } 186 #endif // PRODUCT 187 }; 188 189 class DivByZeroStub: public CodeStub { 190 private: 191 CodeEmitInfo* _info; 192 int _offset; 193 194 public: 195 DivByZeroStub(CodeEmitInfo* info) 196 : _info(info), _offset(-1) { 197 } 198 DivByZeroStub(int offset, CodeEmitInfo* info) 199 : _info(info), _offset(offset) { 200 } 201 virtual void emit_code(LIR_Assembler* e); 202 virtual CodeEmitInfo* info() const { return _info; } 203 virtual bool is_exception_throw_stub() const { return true; } 204 virtual bool is_divbyzero_stub() const { return true; } 205 virtual void visit(LIR_OpVisitState* visitor) { 206 visitor->do_slow_case(_info); 207 } 208 #ifndef PRODUCT 209 virtual void print_name(outputStream* out) const { out->print("DivByZeroStub"); } 210 #endif // PRODUCT 211 }; 212 213 214 class ImplicitNullCheckStub: public CodeStub { 215 private: 216 CodeEmitInfo* _info; 217 int _offset; 218 219 public: 220 ImplicitNullCheckStub(int offset, CodeEmitInfo* info) 221 : _info(info), _offset(offset) { 222 } 223 virtual void emit_code(LIR_Assembler* e); 224 virtual CodeEmitInfo* info() const { return _info; } 225 virtual bool is_exception_throw_stub() const { return true; } 226 virtual void visit(LIR_OpVisitState* visitor) { 227 visitor->do_slow_case(_info); 228 } 229 #ifndef PRODUCT 230 virtual void print_name(outputStream* out) const { out->print("ImplicitNullCheckStub"); } 231 #endif // PRODUCT 232 }; 233 234 235 class LoadFlattenedArrayStub: public CodeStub { 236 private: 237 LIR_Opr _array; 238 LIR_Opr _index; 239 LIR_Opr _result; 240 CodeEmitInfo* _info; 241 242 public: 243 LoadFlattenedArrayStub(LIR_Opr array, LIR_Opr index, LIR_Opr result, CodeEmitInfo* info); 244 virtual void emit_code(LIR_Assembler* e); 245 virtual CodeEmitInfo* info() const { return _info; } 246 virtual void visit(LIR_OpVisitState* visitor) { 247 visitor->do_slow_case(_info); 248 visitor->do_input(_array); 249 visitor->do_input(_index); 250 visitor->do_output(_result); 251 } 252 #ifndef PRODUCT 253 virtual void print_name(outputStream* out) const { out->print("LoadFlattenedArrayStub"); } 254 #endif // PRODUCT 255 }; 256 257 258 class StoreFlattenedArrayStub: public CodeStub { 259 private: 260 LIR_Opr _array; 261 LIR_Opr _index; 262 LIR_Opr _value; 263 CodeEmitInfo* _info; 264 265 public: 266 StoreFlattenedArrayStub(LIR_Opr array, LIR_Opr index, LIR_Opr value, CodeEmitInfo* info); 267 virtual void emit_code(LIR_Assembler* e); 268 virtual CodeEmitInfo* info() const { return _info; } 269 virtual void visit(LIR_OpVisitState* visitor) { 270 visitor->do_slow_case(_info); 271 visitor->do_input(_array); 272 visitor->do_input(_index); 273 visitor->do_input(_value); 274 } 275 #ifndef PRODUCT 276 virtual void print_name(outputStream* out) const { out->print("StoreFlattenedArrayStub"); } 277 #endif // PRODUCT 278 }; 279 280 281 class NewInstanceStub: public CodeStub { 282 private: 283 ciInstanceKlass* _klass; 284 LIR_Opr _klass_reg; 285 LIR_Opr _result; 286 CodeEmitInfo* _info; 287 Runtime1::StubID _stub_id; 288 289 public: 290 NewInstanceStub(LIR_Opr klass_reg, LIR_Opr result, ciInstanceKlass* klass, CodeEmitInfo* info, Runtime1::StubID stub_id); 291 virtual void emit_code(LIR_Assembler* e); 292 virtual CodeEmitInfo* info() const { return _info; } 293 virtual void visit(LIR_OpVisitState* visitor) { 294 visitor->do_slow_case(_info); 295 visitor->do_input(_klass_reg); 296 visitor->do_output(_result); 297 } 298 #ifndef PRODUCT 299 virtual void print_name(outputStream* out) const { out->print("NewInstanceStub"); } 300 #endif // PRODUCT 301 }; 302 303 304 class NewTypeArrayStub: public CodeStub { 305 private: 306 LIR_Opr _klass_reg; 307 LIR_Opr _length; 308 LIR_Opr _result; 309 CodeEmitInfo* _info; 310 311 public: 312 NewTypeArrayStub(LIR_Opr klass_reg, LIR_Opr length, LIR_Opr result, CodeEmitInfo* info); 313 virtual void emit_code(LIR_Assembler* e); 314 virtual CodeEmitInfo* info() const { return _info; } 315 virtual void visit(LIR_OpVisitState* visitor) { 316 visitor->do_slow_case(_info); 317 visitor->do_input(_klass_reg); 318 visitor->do_input(_length); 319 assert(_result->is_valid(), "must be valid"); visitor->do_output(_result); 320 } 321 #ifndef PRODUCT 322 virtual void print_name(outputStream* out) const { out->print("NewTypeArrayStub"); } 323 #endif // PRODUCT 324 }; 325 326 327 class NewObjectArrayStub: public CodeStub { 328 private: 329 LIR_Opr _klass_reg; 330 LIR_Opr _length; 331 LIR_Opr _result; 332 CodeEmitInfo* _info; 333 bool _is_value_type; 334 public: 335 NewObjectArrayStub(LIR_Opr klass_reg, LIR_Opr length, LIR_Opr result, CodeEmitInfo* info, bool is_value_type); 336 virtual void emit_code(LIR_Assembler* e); 337 virtual CodeEmitInfo* info() const { return _info; } 338 virtual void visit(LIR_OpVisitState* visitor) { 339 visitor->do_slow_case(_info); 340 visitor->do_input(_klass_reg); 341 visitor->do_input(_length); 342 assert(_result->is_valid(), "must be valid"); visitor->do_output(_result); 343 } 344 #ifndef PRODUCT 345 virtual void print_name(outputStream* out) const { out->print("NewObjectArrayStub"); } 346 #endif // PRODUCT 347 }; 348 349 350 class MonitorAccessStub: public CodeStub { 351 protected: 352 LIR_Opr _obj_reg; 353 LIR_Opr _lock_reg; 354 355 public: 356 MonitorAccessStub(LIR_Opr obj_reg, LIR_Opr lock_reg) { 357 _obj_reg = obj_reg; 358 _lock_reg = lock_reg; 359 } 360 361 #ifndef PRODUCT 362 virtual void print_name(outputStream* out) const { out->print("MonitorAccessStub"); } 363 #endif // PRODUCT 364 }; 365 366 367 class MonitorEnterStub: public MonitorAccessStub { 368 private: 369 CodeEmitInfo* _info; 370 CodeStub* _throw_imse_stub; 371 LIR_Opr _scratch_reg; 372 373 public: 374 MonitorEnterStub(LIR_Opr obj_reg, LIR_Opr lock_reg, CodeEmitInfo* info, CodeStub* throw_imse_stub = NULL, LIR_Opr scratch_reg = LIR_OprFact::illegalOpr); 375 376 virtual void emit_code(LIR_Assembler* e); 377 virtual CodeEmitInfo* info() const { return _info; } 378 virtual void visit(LIR_OpVisitState* visitor) { 379 visitor->do_input(_obj_reg); 380 visitor->do_input(_lock_reg); 381 if (_scratch_reg != LIR_OprFact::illegalOpr) { 382 visitor->do_temp(_scratch_reg); 383 } 384 visitor->do_slow_case(_info); 385 } 386 #ifndef PRODUCT 387 virtual void print_name(outputStream* out) const { out->print("MonitorEnterStub"); } 388 #endif // PRODUCT 389 }; 390 391 392 class MonitorExitStub: public MonitorAccessStub { 393 private: 394 bool _compute_lock; 395 int _monitor_ix; 396 397 public: 398 MonitorExitStub(LIR_Opr lock_reg, bool compute_lock, int monitor_ix) 399 : MonitorAccessStub(LIR_OprFact::illegalOpr, lock_reg), 400 _compute_lock(compute_lock), _monitor_ix(monitor_ix) { } 401 virtual void emit_code(LIR_Assembler* e); 402 virtual void visit(LIR_OpVisitState* visitor) { 403 assert(_obj_reg->is_illegal(), "unused"); 404 if (_compute_lock) { 405 visitor->do_temp(_lock_reg); 406 } else { 407 visitor->do_input(_lock_reg); 408 } 409 } 410 #ifndef PRODUCT 411 virtual void print_name(outputStream* out) const { out->print("MonitorExitStub"); } 412 #endif // PRODUCT 413 }; 414 415 416 class PatchingStub: public CodeStub { 417 public: 418 enum PatchID { 419 access_field_id, 420 load_klass_id, 421 load_mirror_id, 422 load_appendix_id 423 }; 424 enum constants { 425 patch_info_size = 3 426 }; 427 private: 428 PatchID _id; 429 address _pc_start; 430 int _bytes_to_copy; 431 Label _patched_code_entry; 432 Label _patch_site_entry; 433 Label _patch_site_continuation; 434 Register _obj; 435 CodeEmitInfo* _info; 436 int _index; // index of the patchable oop or Klass* in nmethod oop or metadata table if needed 437 static int _patch_info_offset; 438 439 void align_patch_site(MacroAssembler* masm); 440 441 public: 442 static int patch_info_offset() { return _patch_info_offset; } 443 444 PatchingStub(MacroAssembler* masm, PatchID id, int index = -1): 445 _id(id) 446 , _info(NULL) 447 , _index(index) { 448 // force alignment of patch sites so we 449 // can guarantee atomic writes to the patch site. 450 align_patch_site(masm); 451 _pc_start = masm->pc(); 452 masm->bind(_patch_site_entry); 453 } 454 455 void install(MacroAssembler* masm, LIR_PatchCode patch_code, Register obj, CodeEmitInfo* info) { 456 _info = info; 457 _obj = obj; 458 masm->bind(_patch_site_continuation); 459 _bytes_to_copy = masm->pc() - pc_start(); 460 if (_id == PatchingStub::access_field_id) { 461 // embed a fixed offset to handle long patches which need to be offset by a word. 462 // the patching code will just add the field offset field to this offset so 463 // that we can refernce either the high or low word of a double word field. 464 int field_offset = 0; 465 switch (patch_code) { 466 case lir_patch_low: field_offset = lo_word_offset_in_bytes; break; 467 case lir_patch_high: field_offset = hi_word_offset_in_bytes; break; 468 case lir_patch_normal: field_offset = 0; break; 469 default: ShouldNotReachHere(); 470 } 471 NativeMovRegMem* n_move = nativeMovRegMem_at(pc_start()); 472 n_move->set_offset(field_offset); 473 } else if (_id == load_klass_id || _id == load_mirror_id || _id == load_appendix_id) { 474 assert(_obj != noreg, "must have register object for load_klass/load_mirror"); 475 #ifdef ASSERT 476 // verify that we're pointing at a NativeMovConstReg 477 nativeMovConstReg_at(pc_start()); 478 #endif 479 } else { 480 ShouldNotReachHere(); 481 } 482 assert(_bytes_to_copy <= (masm->pc() - pc_start()), "not enough bytes"); 483 } 484 485 address pc_start() const { return _pc_start; } 486 PatchID id() const { return _id; } 487 488 virtual void emit_code(LIR_Assembler* e); 489 virtual CodeEmitInfo* info() const { return _info; } 490 virtual void visit(LIR_OpVisitState* visitor) { 491 visitor->do_slow_case(_info); 492 } 493 #ifndef PRODUCT 494 virtual void print_name(outputStream* out) const { out->print("PatchingStub"); } 495 #endif // PRODUCT 496 }; 497 498 499 //------------------------------------------------------------------------------ 500 // DeoptimizeStub 501 // 502 class DeoptimizeStub : public CodeStub { 503 private: 504 CodeEmitInfo* _info; 505 jint _trap_request; 506 507 public: 508 DeoptimizeStub(CodeEmitInfo* info, Deoptimization::DeoptReason reason, Deoptimization::DeoptAction action) : 509 _info(new CodeEmitInfo(info)), _trap_request(Deoptimization::make_trap_request(reason, action)) {} 510 511 virtual void emit_code(LIR_Assembler* e); 512 virtual CodeEmitInfo* info() const { return _info; } 513 virtual bool is_exception_throw_stub() const { return true; } 514 virtual void visit(LIR_OpVisitState* visitor) { 515 visitor->do_slow_case(_info); 516 } 517 #ifndef PRODUCT 518 virtual void print_name(outputStream* out) const { out->print("DeoptimizeStub"); } 519 #endif // PRODUCT 520 }; 521 522 523 class SimpleExceptionStub: public CodeStub { 524 private: 525 LIR_Opr _obj; 526 Runtime1::StubID _stub; 527 CodeEmitInfo* _info; 528 529 public: 530 SimpleExceptionStub(Runtime1::StubID stub, LIR_Opr obj, CodeEmitInfo* info): 531 _obj(obj), _stub(stub), _info(info) { 532 } 533 534 void set_obj(LIR_Opr obj) { 535 _obj = obj; 536 } 537 538 virtual void emit_code(LIR_Assembler* e); 539 virtual CodeEmitInfo* info() const { return _info; } 540 virtual bool is_exception_throw_stub() const { return true; } 541 virtual bool is_simple_exception_stub() const { return true; } 542 virtual void visit(LIR_OpVisitState* visitor) { 543 if (_obj->is_valid()) visitor->do_input(_obj); 544 visitor->do_slow_case(_info); 545 } 546 #ifndef PRODUCT 547 virtual void print_name(outputStream* out) const { out->print("SimpleExceptionStub"); } 548 #endif // PRODUCT 549 }; 550 551 552 553 class ArrayStoreExceptionStub: public SimpleExceptionStub { 554 private: 555 CodeEmitInfo* _info; 556 557 public: 558 ArrayStoreExceptionStub(LIR_Opr obj, CodeEmitInfo* info): SimpleExceptionStub(Runtime1::throw_array_store_exception_id, obj, info) {} 559 #ifndef PRODUCT 560 virtual void print_name(outputStream* out) const { out->print("ArrayStoreExceptionStub"); } 561 #endif // PRODUCT 562 }; 563 564 565 class ArrayCopyStub: public CodeStub { 566 private: 567 LIR_OpArrayCopy* _op; 568 569 public: 570 ArrayCopyStub(LIR_OpArrayCopy* op): _op(op) { } 571 572 LIR_Opr src() const { return _op->src(); } 573 LIR_Opr src_pos() const { return _op->src_pos(); } 574 LIR_Opr dst() const { return _op->dst(); } 575 LIR_Opr dst_pos() const { return _op->dst_pos(); } 576 LIR_Opr length() const { return _op->length(); } 577 LIR_Opr tmp() const { return _op->tmp(); } 578 579 virtual void emit_code(LIR_Assembler* e); 580 virtual CodeEmitInfo* info() const { return _op->info(); } 581 virtual void visit(LIR_OpVisitState* visitor) { 582 // don't pass in the code emit info since it's processed in the fast path 583 visitor->do_slow_case(); 584 } 585 #ifndef PRODUCT 586 virtual void print_name(outputStream* out) const { out->print("ArrayCopyStub"); } 587 #endif // PRODUCT 588 }; 589 590 #endif // SHARE_C1_C1_CODESTUBS_HPP