1 /* 2 * Copyright (c) 1997, 2023, 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_RUNTIME_STUBROUTINES_HPP 26 #define SHARE_RUNTIME_STUBROUTINES_HPP 27 28 #include "code/codeBlob.hpp" 29 #include "memory/allocation.hpp" 30 #include "prims/vectorSupport.hpp" 31 #include "runtime/frame.hpp" 32 #include "runtime/mutexLocker.hpp" 33 #include "runtime/stubCodeGenerator.hpp" 34 #include "utilities/macros.hpp" 35 36 // StubRoutines provides entry points to assembly routines used by 37 // compiled code and the run-time system. Platform-specific entry 38 // points are defined in the platform-specific inner class. 39 // 40 // Class scheme: 41 // 42 // platform-independent platform-dependent 43 // 44 // stubRoutines.hpp <-- included -- stubRoutines_<arch>.hpp 45 // ^ ^ 46 // | | 47 // implements implements 48 // | | 49 // | | 50 // stubRoutines.cpp stubRoutines_<arch>.cpp 51 // stubRoutines_<os_family>.cpp stubGenerator_<arch>.cpp 52 // stubRoutines_<os_arch>.cpp 53 // 54 // Note 1: The important thing is a clean decoupling between stub 55 // entry points (interfacing to the whole vm; i.e., 1-to-n 56 // relationship) and stub generators (interfacing only to 57 // the entry points implementation; i.e., 1-to-1 relationship). 58 // This significantly simplifies changes in the generator 59 // structure since the rest of the vm is not affected. 60 // 61 // Note 2: stubGenerator_<arch>.cpp contains a minimal portion of 62 // machine-independent code; namely the generator calls of 63 // the generator functions that are used platform-independently. 64 // However, it comes with the advantage of having a 1-file 65 // implementation of the generator. It should be fairly easy 66 // to change, should it become a problem later. 67 // 68 // Scheme for adding a new entry point: 69 // 70 // 1. determine if it's a platform-dependent or independent entry point 71 // a) if platform independent: make subsequent changes in the independent files 72 // b) if platform dependent: make subsequent changes in the dependent files 73 // 2. add a private instance variable holding the entry point address 74 // 3. add a public accessor function to the instance variable 75 // 4. implement the corresponding generator function in the platform-dependent 76 // stubGenerator_<arch>.cpp file and call the function in generate_all() of that file 77 78 class UnsafeCopyMemory : public CHeapObj<mtCode> { 79 private: 80 address _start_pc; 81 address _end_pc; 82 address _error_exit_pc; 83 public: 84 static address _common_exit_stub_pc; 85 static UnsafeCopyMemory* _table; 86 static int _table_length; 87 static int _table_max_length; 88 UnsafeCopyMemory() : _start_pc(nullptr), _end_pc(nullptr), _error_exit_pc(nullptr) {} 89 void set_start_pc(address pc) { _start_pc = pc; } 90 void set_end_pc(address pc) { _end_pc = pc; } 91 void set_error_exit_pc(address pc) { _error_exit_pc = pc; } 92 address start_pc() const { return _start_pc; } 93 address end_pc() const { return _end_pc; } 94 address error_exit_pc() const { return _error_exit_pc; } 95 96 static void set_common_exit_stub_pc(address pc) { _common_exit_stub_pc = pc; } 97 static address common_exit_stub_pc() { return _common_exit_stub_pc; } 98 99 static UnsafeCopyMemory* add_to_table(address start_pc, address end_pc, address error_exit_pc) { 100 guarantee(_table_length < _table_max_length, "Incorrect UnsafeCopyMemory::_table_max_length"); 101 UnsafeCopyMemory* entry = &_table[_table_length]; 102 entry->set_start_pc(start_pc); 103 entry->set_end_pc(end_pc); 104 entry->set_error_exit_pc(error_exit_pc); 105 106 _table_length++; 107 return entry; 108 } 109 110 static bool contains_pc(address pc); 111 static address page_error_continue_pc(address pc); 112 static void create_table(int max_size); 113 }; 114 115 class UnsafeCopyMemoryMark : public StackObj { 116 private: 117 UnsafeCopyMemory* _ucm_entry; 118 StubCodeGenerator* _cgen; 119 public: 120 UnsafeCopyMemoryMark(StubCodeGenerator* cgen, bool add_entry, bool continue_at_scope_end, address error_exit_pc = nullptr); 121 ~UnsafeCopyMemoryMark(); 122 }; 123 124 class StubRoutines: AllStatic { 125 126 public: 127 // Dependencies 128 friend class StubGenerator; 129 130 #include CPU_HEADER(stubRoutines) 131 132 static jint _verify_oop_count; 133 static address _verify_oop_subroutine_entry; 134 135 static address _call_stub_return_address; // the return PC, when returning to a call stub 136 static address _call_stub_entry; 137 static address _forward_exception_entry; 138 static address _catch_exception_entry; 139 static address _throw_AbstractMethodError_entry; 140 static address _throw_IncompatibleClassChangeError_entry; 141 static address _throw_NullPointerException_at_call_entry; 142 static address _throw_StackOverflowError_entry; 143 static address _throw_delayed_StackOverflowError_entry; 144 145 static address _atomic_xchg_entry; 146 static address _atomic_cmpxchg_entry; 147 static address _atomic_cmpxchg_long_entry; 148 static address _atomic_add_entry; 149 static address _fence_entry; 150 151 static BufferBlob* _initial_stubs_code; // code buffer for initial routines 152 static BufferBlob* _continuation_stubs_code; // code buffer for continuation stubs 153 static BufferBlob* _compiler_stubs_code; // code buffer for C2 intrinsics 154 static BufferBlob* _final_stubs_code; // code buffer for all other routines 155 156 // Leaf routines which implement arraycopy and their addresses 157 // arraycopy operands aligned on element type boundary 158 static address _jbyte_arraycopy; 159 static address _jshort_arraycopy; 160 static address _jint_arraycopy; 161 static address _jlong_arraycopy; 162 static address _oop_arraycopy, _oop_arraycopy_uninit; 163 static address _jbyte_disjoint_arraycopy; 164 static address _jshort_disjoint_arraycopy; 165 static address _jint_disjoint_arraycopy; 166 static address _jlong_disjoint_arraycopy; 167 static address _oop_disjoint_arraycopy, _oop_disjoint_arraycopy_uninit; 168 169 // arraycopy operands aligned on zero'th element boundary 170 // These are identical to the ones aligned aligned on an 171 // element type boundary, except that they assume that both 172 // source and destination are HeapWord aligned. 173 static address _arrayof_jbyte_arraycopy; 174 static address _arrayof_jshort_arraycopy; 175 static address _arrayof_jint_arraycopy; 176 static address _arrayof_jlong_arraycopy; 177 static address _arrayof_oop_arraycopy, _arrayof_oop_arraycopy_uninit; 178 static address _arrayof_jbyte_disjoint_arraycopy; 179 static address _arrayof_jshort_disjoint_arraycopy; 180 static address _arrayof_jint_disjoint_arraycopy; 181 static address _arrayof_jlong_disjoint_arraycopy; 182 static address _arrayof_oop_disjoint_arraycopy, _arrayof_oop_disjoint_arraycopy_uninit; 183 184 // cache line writeback 185 static address _data_cache_writeback; 186 static address _data_cache_writeback_sync; 187 188 // these are recommended but optional: 189 static address _checkcast_arraycopy, _checkcast_arraycopy_uninit; 190 static address _unsafe_arraycopy; 191 static address _generic_arraycopy; 192 193 static address _jbyte_fill; 194 static address _jshort_fill; 195 static address _jint_fill; 196 static address _arrayof_jbyte_fill; 197 static address _arrayof_jshort_fill; 198 static address _arrayof_jint_fill; 199 200 static address _aescrypt_encryptBlock; 201 static address _aescrypt_decryptBlock; 202 static address _cipherBlockChaining_encryptAESCrypt; 203 static address _cipherBlockChaining_decryptAESCrypt; 204 static address _electronicCodeBook_encryptAESCrypt; 205 static address _electronicCodeBook_decryptAESCrypt; 206 static address _counterMode_AESCrypt; 207 static address _galoisCounterMode_AESCrypt; 208 static address _ghash_processBlocks; 209 static address _chacha20Block; 210 static address _base64_encodeBlock; 211 static address _base64_decodeBlock; 212 static address _poly1305_processBlocks; 213 214 static address _md5_implCompress; 215 static address _md5_implCompressMB; 216 static address _sha1_implCompress; 217 static address _sha1_implCompressMB; 218 static address _sha256_implCompress; 219 static address _sha256_implCompressMB; 220 static address _sha512_implCompress; 221 static address _sha512_implCompressMB; 222 static address _sha3_implCompress; 223 static address _sha3_implCompressMB; 224 225 static address _updateBytesCRC32; 226 static address _crc_table_adr; 227 228 static address _crc32c_table_addr; 229 static address _updateBytesCRC32C; 230 static address _updateBytesAdler32; 231 232 static address _multiplyToLen; 233 static address _squareToLen; 234 static address _mulAdd; 235 static address _montgomeryMultiply; 236 static address _montgomerySquare; 237 static address _bigIntegerRightShiftWorker; 238 static address _bigIntegerLeftShiftWorker; 239 240 static address _vectorizedMismatch; 241 242 static address _dexp; 243 static address _dlog; 244 static address _dlog10; 245 static address _dpow; 246 static address _dsin; 247 static address _dcos; 248 static address _dlibm_sin_cos_huge; 249 static address _dlibm_reduce_pi04l; 250 static address _dlibm_tan_cot_huge; 251 static address _dtan; 252 static address _fmod; 253 254 static address _f2hf; 255 static address _hf2f; 256 257 static address _cont_thaw; 258 static address _cont_returnBarrier; 259 static address _cont_returnBarrierExc; 260 261 JFR_ONLY(static RuntimeStub* _jfr_write_checkpoint_stub;) 262 JFR_ONLY(static address _jfr_write_checkpoint;) 263 JFR_ONLY(static RuntimeStub* _jfr_return_lease_stub;) 264 JFR_ONLY(static address _jfr_return_lease;) 265 266 static address _load_inline_type_fields_in_regs; 267 static address _store_inline_type_fields_to_buf; 268 269 // Vector Math Routines 270 static address _vector_f_math[VectorSupport::NUM_VEC_SIZES][VectorSupport::NUM_SVML_OP]; 271 static address _vector_d_math[VectorSupport::NUM_VEC_SIZES][VectorSupport::NUM_SVML_OP]; 272 273 public: 274 // Initialization/Testing 275 static void initialize_initial_stubs(); // must happen before universe::genesis 276 static void initialize_continuation_stubs(); // must happen after universe::genesis 277 static void initialize_compiler_stubs(); // must happen after universe::genesis 278 static void initialize_final_stubs(); // must happen after universe::genesis 279 280 static bool is_stub_code(address addr) { return contains(addr); } 281 282 static bool contains(address addr) { 283 return 284 (_initial_stubs_code != nullptr && _initial_stubs_code->blob_contains(addr)) || 285 (_continuation_stubs_code != nullptr && _continuation_stubs_code->blob_contains(addr)) || 286 (_compiler_stubs_code != nullptr && _compiler_stubs_code->blob_contains(addr)) || 287 (_final_stubs_code != nullptr && _final_stubs_code->blob_contains(addr)) ; 288 } 289 290 static RuntimeBlob* initial_stubs_code() { return _initial_stubs_code; } 291 static RuntimeBlob* continuation_stubs_code() { return _continuation_stubs_code; } 292 static RuntimeBlob* compiler_stubs_code() { return _compiler_stubs_code; } 293 static RuntimeBlob* final_stubs_code() { return _final_stubs_code; } 294 295 // Debugging 296 static jint verify_oop_count() { return _verify_oop_count; } 297 static jint* verify_oop_count_addr() { return &_verify_oop_count; } 298 // a subroutine for debugging the GC 299 static address verify_oop_subroutine_entry_address() { return (address)&_verify_oop_subroutine_entry; } 300 301 static address catch_exception_entry() { return _catch_exception_entry; } 302 303 // Calls to Java 304 typedef void (*CallStub)( 305 address link, 306 intptr_t* result, 307 int result_type, /* BasicType on 4 bytes */ 308 Method* method, 309 address entry_point, 310 intptr_t* parameters, 311 int size_of_parameters, 312 TRAPS 313 ); 314 315 static CallStub call_stub() { return CAST_TO_FN_PTR(CallStub, _call_stub_entry); } 316 317 // Exceptions 318 static address forward_exception_entry() { return _forward_exception_entry; } 319 // Implicit exceptions 320 static address throw_AbstractMethodError_entry() { return _throw_AbstractMethodError_entry; } 321 static address throw_IncompatibleClassChangeError_entry(){ return _throw_IncompatibleClassChangeError_entry; } 322 static address throw_NullPointerException_at_call_entry(){ return _throw_NullPointerException_at_call_entry; } 323 static address throw_StackOverflowError_entry() { return _throw_StackOverflowError_entry; } 324 static address throw_delayed_StackOverflowError_entry() { return _throw_delayed_StackOverflowError_entry; } 325 326 static address atomic_xchg_entry() { return _atomic_xchg_entry; } 327 static address atomic_cmpxchg_entry() { return _atomic_cmpxchg_entry; } 328 static address atomic_cmpxchg_long_entry() { return _atomic_cmpxchg_long_entry; } 329 static address atomic_add_entry() { return _atomic_add_entry; } 330 static address fence_entry() { return _fence_entry; } 331 332 static address select_arraycopy_function(BasicType t, bool aligned, bool disjoint, const char* &name, bool dest_uninitialized); 333 334 static address jbyte_arraycopy() { return _jbyte_arraycopy; } 335 static address jshort_arraycopy() { return _jshort_arraycopy; } 336 static address jint_arraycopy() { return _jint_arraycopy; } 337 static address jlong_arraycopy() { return _jlong_arraycopy; } 338 static address oop_arraycopy(bool dest_uninitialized = false) { 339 return dest_uninitialized ? _oop_arraycopy_uninit : _oop_arraycopy; 340 } 341 static address jbyte_disjoint_arraycopy() { return _jbyte_disjoint_arraycopy; } 342 static address jshort_disjoint_arraycopy() { return _jshort_disjoint_arraycopy; } 343 static address jint_disjoint_arraycopy() { return _jint_disjoint_arraycopy; } 344 static address jlong_disjoint_arraycopy() { return _jlong_disjoint_arraycopy; } 345 static address oop_disjoint_arraycopy(bool dest_uninitialized = false) { 346 return dest_uninitialized ? _oop_disjoint_arraycopy_uninit : _oop_disjoint_arraycopy; 347 } 348 349 static address arrayof_jbyte_arraycopy() { return _arrayof_jbyte_arraycopy; } 350 static address arrayof_jshort_arraycopy() { return _arrayof_jshort_arraycopy; } 351 static address arrayof_jint_arraycopy() { return _arrayof_jint_arraycopy; } 352 static address arrayof_jlong_arraycopy() { return _arrayof_jlong_arraycopy; } 353 static address arrayof_oop_arraycopy(bool dest_uninitialized = false) { 354 return dest_uninitialized ? _arrayof_oop_arraycopy_uninit : _arrayof_oop_arraycopy; 355 } 356 357 static address arrayof_jbyte_disjoint_arraycopy() { return _arrayof_jbyte_disjoint_arraycopy; } 358 static address arrayof_jshort_disjoint_arraycopy() { return _arrayof_jshort_disjoint_arraycopy; } 359 static address arrayof_jint_disjoint_arraycopy() { return _arrayof_jint_disjoint_arraycopy; } 360 static address arrayof_jlong_disjoint_arraycopy() { return _arrayof_jlong_disjoint_arraycopy; } 361 static address arrayof_oop_disjoint_arraycopy(bool dest_uninitialized = false) { 362 return dest_uninitialized ? _arrayof_oop_disjoint_arraycopy_uninit : _arrayof_oop_disjoint_arraycopy; 363 } 364 static address data_cache_writeback() { return _data_cache_writeback; } 365 static address data_cache_writeback_sync() { return _data_cache_writeback_sync; } 366 367 typedef void (*DataCacheWritebackStub)(void *); 368 static DataCacheWritebackStub DataCacheWriteback_stub() { return CAST_TO_FN_PTR(DataCacheWritebackStub, _data_cache_writeback); } 369 typedef void (*DataCacheWritebackSyncStub)(bool); 370 static DataCacheWritebackSyncStub DataCacheWritebackSync_stub() { return CAST_TO_FN_PTR(DataCacheWritebackSyncStub, _data_cache_writeback_sync); } 371 372 static address checkcast_arraycopy(bool dest_uninitialized = false) { 373 return dest_uninitialized ? _checkcast_arraycopy_uninit : _checkcast_arraycopy; 374 } 375 static address unsafe_arraycopy() { return _unsafe_arraycopy; } 376 377 typedef void (*UnsafeArrayCopyStub)(const void* src, void* dst, size_t count); 378 static UnsafeArrayCopyStub UnsafeArrayCopy_stub() { return CAST_TO_FN_PTR(UnsafeArrayCopyStub, _unsafe_arraycopy); } 379 380 static address generic_arraycopy() { return _generic_arraycopy; } 381 382 static address jbyte_fill() { return _jbyte_fill; } 383 static address jshort_fill() { return _jshort_fill; } 384 static address jint_fill() { return _jint_fill; } 385 static address arrayof_jbyte_fill() { return _arrayof_jbyte_fill; } 386 static address arrayof_jshort_fill() { return _arrayof_jshort_fill; } 387 static address arrayof_jint_fill() { return _arrayof_jint_fill; } 388 389 static address aescrypt_encryptBlock() { return _aescrypt_encryptBlock; } 390 static address aescrypt_decryptBlock() { return _aescrypt_decryptBlock; } 391 static address cipherBlockChaining_encryptAESCrypt() { return _cipherBlockChaining_encryptAESCrypt; } 392 static address cipherBlockChaining_decryptAESCrypt() { return _cipherBlockChaining_decryptAESCrypt; } 393 static address electronicCodeBook_encryptAESCrypt() { return _electronicCodeBook_encryptAESCrypt; } 394 static address electronicCodeBook_decryptAESCrypt() { return _electronicCodeBook_decryptAESCrypt; } 395 static address poly1305_processBlocks() { return _poly1305_processBlocks; } 396 static address counterMode_AESCrypt() { return _counterMode_AESCrypt; } 397 static address ghash_processBlocks() { return _ghash_processBlocks; } 398 static address chacha20Block() { return _chacha20Block; } 399 static address base64_encodeBlock() { return _base64_encodeBlock; } 400 static address base64_decodeBlock() { return _base64_decodeBlock; } 401 static address md5_implCompress() { return _md5_implCompress; } 402 static address md5_implCompressMB() { return _md5_implCompressMB; } 403 static address sha1_implCompress() { return _sha1_implCompress; } 404 static address sha1_implCompressMB() { return _sha1_implCompressMB; } 405 static address sha256_implCompress() { return _sha256_implCompress; } 406 static address sha256_implCompressMB() { return _sha256_implCompressMB; } 407 static address sha512_implCompress() { return _sha512_implCompress; } 408 static address sha512_implCompressMB() { return _sha512_implCompressMB; } 409 static address sha3_implCompress() { return _sha3_implCompress; } 410 static address sha3_implCompressMB() { return _sha3_implCompressMB; } 411 412 static address updateBytesCRC32() { return _updateBytesCRC32; } 413 static address crc_table_addr() { return _crc_table_adr; } 414 415 static address crc32c_table_addr() { return _crc32c_table_addr; } 416 static address updateBytesCRC32C() { return _updateBytesCRC32C; } 417 static address updateBytesAdler32() { return _updateBytesAdler32; } 418 419 static address multiplyToLen() { return _multiplyToLen; } 420 static address squareToLen() { return _squareToLen; } 421 static address mulAdd() { return _mulAdd; } 422 static address montgomeryMultiply() { return _montgomeryMultiply; } 423 static address montgomerySquare() { return _montgomerySquare; } 424 static address bigIntegerRightShift() { return _bigIntegerRightShiftWorker; } 425 static address bigIntegerLeftShift() { return _bigIntegerLeftShiftWorker; } 426 static address galoisCounterMode_AESCrypt() { return _galoisCounterMode_AESCrypt; } 427 428 static address vectorizedMismatch() { return _vectorizedMismatch; } 429 430 static address dexp() { return _dexp; } 431 static address dlog() { return _dlog; } 432 static address dlog10() { return _dlog10; } 433 static address dpow() { return _dpow; } 434 static address fmod() { return _fmod; } 435 static address dsin() { return _dsin; } 436 static address dcos() { return _dcos; } 437 static address dlibm_reduce_pi04l() { return _dlibm_reduce_pi04l; } 438 static address dlibm_sin_cos_huge() { return _dlibm_sin_cos_huge; } 439 static address dlibm_tan_cot_huge() { return _dlibm_tan_cot_huge; } 440 static address dtan() { return _dtan; } 441 442 // These are versions of the java.lang.Float::floatToFloat16() and float16ToFloat() 443 // methods which perform the same operations as the intrinsic version. 444 // They are used for constant folding in JIT compiler to ensure equivalence. 445 // 446 static address f2hf_adr() { return _f2hf; } 447 static address hf2f_adr() { return _hf2f; } 448 449 static jshort f2hf(jfloat x) { 450 assert(_f2hf != nullptr, "stub is not implemented on this platform"); 451 typedef jshort (*f2hf_stub_t)(jfloat x); 452 return ((f2hf_stub_t)_f2hf)(x); 453 } 454 static jfloat hf2f(jshort x) { 455 assert(_hf2f != nullptr, "stub is not implemented on this platform"); 456 typedef jfloat (*hf2f_stub_t)(jshort x); 457 return ((hf2f_stub_t)_hf2f)(x); 458 } 459 460 static address cont_thaw() { return _cont_thaw; } 461 static address cont_returnBarrier() { return _cont_returnBarrier; } 462 static address cont_returnBarrierExc(){return _cont_returnBarrierExc; } 463 464 JFR_ONLY(static address jfr_write_checkpoint() { return _jfr_write_checkpoint; }) 465 JFR_ONLY(static address jfr_return_lease() { return _jfr_return_lease; }) 466 467 static address select_fill_function(BasicType t, bool aligned, const char* &name); 468 469 // 470 // Default versions of the above arraycopy functions for platforms which do 471 // not have specialized versions 472 // 473 static void jbyte_copy (jbyte* src, jbyte* dest, size_t count); 474 static void jshort_copy (jshort* src, jshort* dest, size_t count); 475 static void jint_copy (jint* src, jint* dest, size_t count); 476 static void jlong_copy (jlong* src, jlong* dest, size_t count); 477 static void oop_copy (oop* src, oop* dest, size_t count); 478 static void oop_copy_uninit(oop* src, oop* dest, size_t count); 479 480 static void arrayof_jbyte_copy (HeapWord* src, HeapWord* dest, size_t count); 481 static void arrayof_jshort_copy (HeapWord* src, HeapWord* dest, size_t count); 482 static void arrayof_jint_copy (HeapWord* src, HeapWord* dest, size_t count); 483 static void arrayof_jlong_copy (HeapWord* src, HeapWord* dest, size_t count); 484 static void arrayof_oop_copy (HeapWord* src, HeapWord* dest, size_t count); 485 static void arrayof_oop_copy_uninit(HeapWord* src, HeapWord* dest, size_t count); 486 487 static address load_inline_type_fields_in_regs() { return _load_inline_type_fields_in_regs; } 488 static address store_inline_type_fields_to_buf() { return _store_inline_type_fields_to_buf; } 489 }; 490 491 #endif // SHARE_RUNTIME_STUBROUTINES_HPP