1 /* 2 * Copyright (c) 1997, 2015, 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_RUNTIME_STUBROUTINES_HPP 26 #define SHARE_VM_RUNTIME_STUBROUTINES_HPP 27 28 #include "code/codeBlob.hpp" 29 #include "memory/allocation.hpp" 30 #include "runtime/frame.hpp" 31 #include "runtime/mutexLocker.hpp" 32 #include "runtime/stubCodeGenerator.hpp" 33 #include "utilities/top.hpp" 34 35 // StubRoutines provides entry points to assembly routines used by 36 // compiled code and the run-time system. Platform-specific entry 37 // points are defined in the platform-specific inner class. 38 // 39 // Class scheme: 40 // 41 // platform-independent platform-dependent 42 // 43 // stubRoutines.hpp <-- included -- stubRoutines_<arch>.hpp 44 // ^ ^ 45 // | | 46 // implements implements 47 // | | 48 // | | 49 // stubRoutines.cpp stubRoutines_<arch>.cpp 50 // stubRoutines_<os_family>.cpp stubGenerator_<arch>.cpp 51 // stubRoutines_<os_arch>.cpp 52 // 53 // Note 1: The important thing is a clean decoupling between stub 54 // entry points (interfacing to the whole vm; i.e., 1-to-n 55 // relationship) and stub generators (interfacing only to 56 // the entry points implementation; i.e., 1-to-1 relationship). 57 // This significantly simplifies changes in the generator 58 // structure since the rest of the vm is not affected. 59 // 60 // Note 2: stubGenerator_<arch>.cpp contains a minimal portion of 61 // machine-independent code; namely the generator calls of 62 // the generator functions that are used platform-independently. 63 // However, it comes with the advantage of having a 1-file 64 // implementation of the generator. It should be fairly easy 65 // to change, should it become a problem later. 66 // 67 // Scheme for adding a new entry point: 68 // 69 // 1. determine if it's a platform-dependent or independent entry point 70 // a) if platform independent: make subsequent changes in the independent files 71 // b) if platform dependent: make subsequent changes in the dependent files 72 // 2. add a private instance variable holding the entry point address 73 // 3. add a public accessor function to the instance variable 74 // 4. implement the corresponding generator function in the platform-dependent 75 // stubGenerator_<arch>.cpp file and call the function in generate_all() of that file 76 77 78 class StubRoutines: AllStatic { 79 80 public: 81 enum platform_independent_constants { 82 max_size_of_parameters = 256 // max. parameter size supported by megamorphic lookups 83 }; 84 85 // Dependencies 86 friend class StubGenerator; 87 #if defined STUBROUTINES_MD_HPP 88 # include STUBROUTINES_MD_HPP 89 #elif defined TARGET_ARCH_MODEL_x86_32 90 # include "stubRoutines_x86_32.hpp" 91 #elif defined TARGET_ARCH_MODEL_x86_64 92 # include "stubRoutines_x86_64.hpp" 93 #elif defined TARGET_ARCH_MODEL_sparc 94 # include "stubRoutines_sparc.hpp" 95 #elif defined TARGET_ARCH_MODEL_zero 96 # include "stubRoutines_zero.hpp" 97 #elif defined TARGET_ARCH_MODEL_ppc_64 98 # include "stubRoutines_ppc_64.hpp" 99 #elif defined TARGET_ARCH_MODEL_aarch64 100 # include "stubRoutines_aarch64.hpp" 101 #endif 102 103 static jint _verify_oop_count; 104 static address _verify_oop_subroutine_entry; 105 106 static address _call_stub_return_address; // the return PC, when returning to a call stub 107 static address _call_stub_entry; 108 static address _forward_exception_entry; 109 static address _catch_exception_entry; 110 static address _throw_AbstractMethodError_entry; 111 static address _throw_IncompatibleClassChangeError_entry; 112 static address _throw_NullPointerException_at_call_entry; 113 static address _throw_StackOverflowError_entry; 114 static address _throw_delayed_StackOverflowError_entry; 115 static address _handler_for_unsafe_access_entry; 116 117 static address _atomic_xchg_entry; 118 static address _atomic_xchg_ptr_entry; 119 static address _atomic_store_entry; 120 static address _atomic_store_ptr_entry; 121 static address _atomic_cmpxchg_entry; 122 static address _atomic_cmpxchg_ptr_entry; 123 static address _atomic_cmpxchg_byte_entry; 124 static address _atomic_cmpxchg_long_entry; 125 static address _atomic_add_entry; 126 static address _atomic_add_ptr_entry; 127 static address _fence_entry; 128 static address _d2i_wrapper; 129 static address _d2l_wrapper; 130 131 static jint _fpu_cntrl_wrd_std; 132 static jint _fpu_cntrl_wrd_24; 133 static jint _fpu_cntrl_wrd_64; 134 static jint _fpu_cntrl_wrd_trunc; 135 static jint _mxcsr_std; 136 static jint _fpu_subnormal_bias1[3]; 137 static jint _fpu_subnormal_bias2[3]; 138 139 static BufferBlob* _code1; // code buffer for initial routines 140 static BufferBlob* _code2; // code buffer for all other routines 141 142 // Leaf routines which implement arraycopy and their addresses 143 // arraycopy operands aligned on element type boundary 144 static address _jbyte_arraycopy; 145 static address _jshort_arraycopy; 146 static address _jint_arraycopy; 147 static address _jlong_arraycopy; 148 static address _oop_arraycopy, _oop_arraycopy_uninit; 149 static address _jbyte_disjoint_arraycopy; 150 static address _jshort_disjoint_arraycopy; 151 static address _jint_disjoint_arraycopy; 152 static address _jlong_disjoint_arraycopy; 153 static address _oop_disjoint_arraycopy, _oop_disjoint_arraycopy_uninit; 154 155 // arraycopy operands aligned on zero'th element boundary 156 // These are identical to the ones aligned aligned on an 157 // element type boundary, except that they assume that both 158 // source and destination are HeapWord aligned. 159 static address _arrayof_jbyte_arraycopy; 160 static address _arrayof_jshort_arraycopy; 161 static address _arrayof_jint_arraycopy; 162 static address _arrayof_jlong_arraycopy; 163 static address _arrayof_oop_arraycopy, _arrayof_oop_arraycopy_uninit; 164 static address _arrayof_jbyte_disjoint_arraycopy; 165 static address _arrayof_jshort_disjoint_arraycopy; 166 static address _arrayof_jint_disjoint_arraycopy; 167 static address _arrayof_jlong_disjoint_arraycopy; 168 static address _arrayof_oop_disjoint_arraycopy, _arrayof_oop_disjoint_arraycopy_uninit; 169 170 // these are recommended but optional: 171 static address _checkcast_arraycopy, _checkcast_arraycopy_uninit; 172 static address _unsafe_arraycopy; 173 static address _generic_arraycopy; 174 175 static address _jbyte_fill; 176 static address _jshort_fill; 177 static address _jint_fill; 178 static address _arrayof_jbyte_fill; 179 static address _arrayof_jshort_fill; 180 static address _arrayof_jint_fill; 181 182 // zero heap space aligned to jlong (8 bytes) 183 static address _zero_aligned_words; 184 185 static address _aescrypt_encryptBlock; 186 static address _aescrypt_decryptBlock; 187 static address _cipherBlockChaining_encryptAESCrypt; 188 static address _cipherBlockChaining_decryptAESCrypt; 189 static address _counterMode_AESCrypt; 190 static address _ghash_processBlocks; 191 192 static address _sha1_implCompress; 193 static address _sha1_implCompressMB; 194 static address _sha256_implCompress; 195 static address _sha256_implCompressMB; 196 static address _sha512_implCompress; 197 static address _sha512_implCompressMB; 198 199 static address _updateBytesCRC32; 200 static address _crc_table_adr; 201 202 static address _crc32c_table_addr; 203 static address _updateBytesCRC32C; 204 static address _updateBytesAdler32; 205 206 static address _multiplyToLen; 207 static address _squareToLen; 208 static address _mulAdd; 209 static address _montgomeryMultiply; 210 static address _montgomerySquare; 211 212 static address _vectorizedMismatch; 213 214 static address _dexp; 215 static address _dlog; 216 static address _dlog10; 217 static address _dpow; 218 static address _dsin; 219 static address _dcos; 220 static address _dlibm_sin_cos_huge; 221 static address _dlibm_reduce_pi04l; 222 static address _dlibm_tan_cot_huge; 223 static address _dtan; 224 225 // These are versions of the java.lang.Math methods which perform 226 // the same operations as the intrinsic version. They are used for 227 // constant folding in the compiler to ensure equivalence. If the 228 // intrinsic version returns the same result as the strict version 229 // then they can be set to the appropriate function from 230 // SharedRuntime. 231 static double (*_intrinsic_log10)(double); 232 static double (*_intrinsic_pow)(double, double); 233 static double (*_intrinsic_sin)(double); 234 static double (*_intrinsic_cos)(double); 235 static double (*_intrinsic_tan)(double); 236 237 // Safefetch stubs. 238 static address _safefetch32_entry; 239 static address _safefetch32_fault_pc; 240 static address _safefetch32_continuation_pc; 241 static address _safefetchN_entry; 242 static address _safefetchN_fault_pc; 243 static address _safefetchN_continuation_pc; 244 245 public: 246 // Initialization/Testing 247 static void initialize1(); // must happen before universe::genesis 248 static void initialize2(); // must happen after universe::genesis 249 250 static bool is_stub_code(address addr) { return contains(addr); } 251 252 static bool contains(address addr) { 253 return 254 (_code1 != NULL && _code1->blob_contains(addr)) || 255 (_code2 != NULL && _code2->blob_contains(addr)) ; 256 } 257 258 static CodeBlob* code1() { return _code1; } 259 static CodeBlob* code2() { return _code2; } 260 261 // Debugging 262 static jint verify_oop_count() { return _verify_oop_count; } 263 static jint* verify_oop_count_addr() { return &_verify_oop_count; } 264 // a subroutine for debugging the GC 265 static address verify_oop_subroutine_entry_address() { return (address)&_verify_oop_subroutine_entry; } 266 267 static address catch_exception_entry() { return _catch_exception_entry; } 268 269 // Calls to Java 270 typedef void (*CallStub)( 271 address link, 272 intptr_t* result, 273 BasicType result_type, 274 Method* method, 275 address entry_point, 276 intptr_t* parameters, 277 int size_of_parameters, 278 TRAPS 279 ); 280 281 static CallStub call_stub() { return CAST_TO_FN_PTR(CallStub, _call_stub_entry); } 282 283 // Exceptions 284 static address forward_exception_entry() { return _forward_exception_entry; } 285 // Implicit exceptions 286 static address throw_AbstractMethodError_entry() { return _throw_AbstractMethodError_entry; } 287 static address throw_IncompatibleClassChangeError_entry(){ return _throw_IncompatibleClassChangeError_entry; } 288 static address throw_NullPointerException_at_call_entry(){ return _throw_NullPointerException_at_call_entry; } 289 static address throw_StackOverflowError_entry() { return _throw_StackOverflowError_entry; } 290 static address throw_delayed_StackOverflowError_entry() { return _throw_delayed_StackOverflowError_entry; } 291 292 // Exceptions during unsafe access - should throw Java exception rather 293 // than crash. 294 static address handler_for_unsafe_access() { return _handler_for_unsafe_access_entry; } 295 296 static address atomic_xchg_entry() { return _atomic_xchg_entry; } 297 static address atomic_xchg_ptr_entry() { return _atomic_xchg_ptr_entry; } 298 static address atomic_store_entry() { return _atomic_store_entry; } 299 static address atomic_store_ptr_entry() { return _atomic_store_ptr_entry; } 300 static address atomic_cmpxchg_entry() { return _atomic_cmpxchg_entry; } 301 static address atomic_cmpxchg_ptr_entry() { return _atomic_cmpxchg_ptr_entry; } 302 static address atomic_cmpxchg_byte_entry() { return _atomic_cmpxchg_byte_entry; } 303 static address atomic_cmpxchg_long_entry() { return _atomic_cmpxchg_long_entry; } 304 static address atomic_add_entry() { return _atomic_add_entry; } 305 static address atomic_add_ptr_entry() { return _atomic_add_ptr_entry; } 306 static address fence_entry() { return _fence_entry; } 307 308 static address d2i_wrapper() { return _d2i_wrapper; } 309 static address d2l_wrapper() { return _d2l_wrapper; } 310 static jint fpu_cntrl_wrd_std() { return _fpu_cntrl_wrd_std; } 311 static address addr_fpu_cntrl_wrd_std() { return (address)&_fpu_cntrl_wrd_std; } 312 static address addr_fpu_cntrl_wrd_24() { return (address)&_fpu_cntrl_wrd_24; } 313 static address addr_fpu_cntrl_wrd_64() { return (address)&_fpu_cntrl_wrd_64; } 314 static address addr_fpu_cntrl_wrd_trunc() { return (address)&_fpu_cntrl_wrd_trunc; } 315 static address addr_mxcsr_std() { return (address)&_mxcsr_std; } 316 static address addr_fpu_subnormal_bias1() { return (address)&_fpu_subnormal_bias1; } 317 static address addr_fpu_subnormal_bias2() { return (address)&_fpu_subnormal_bias2; } 318 319 320 static address select_arraycopy_function(BasicType t, bool aligned, bool disjoint, const char* &name, bool dest_uninitialized); 321 322 static address jbyte_arraycopy() { return _jbyte_arraycopy; } 323 static address jshort_arraycopy() { return _jshort_arraycopy; } 324 static address jint_arraycopy() { return _jint_arraycopy; } 325 static address jlong_arraycopy() { return _jlong_arraycopy; } 326 static address oop_arraycopy(bool dest_uninitialized = false) { 327 return dest_uninitialized ? _oop_arraycopy_uninit : _oop_arraycopy; 328 } 329 static address jbyte_disjoint_arraycopy() { return _jbyte_disjoint_arraycopy; } 330 static address jshort_disjoint_arraycopy() { return _jshort_disjoint_arraycopy; } 331 static address jint_disjoint_arraycopy() { return _jint_disjoint_arraycopy; } 332 static address jlong_disjoint_arraycopy() { return _jlong_disjoint_arraycopy; } 333 static address oop_disjoint_arraycopy(bool dest_uninitialized = false) { 334 return dest_uninitialized ? _oop_disjoint_arraycopy_uninit : _oop_disjoint_arraycopy; 335 } 336 337 static address arrayof_jbyte_arraycopy() { return _arrayof_jbyte_arraycopy; } 338 static address arrayof_jshort_arraycopy() { return _arrayof_jshort_arraycopy; } 339 static address arrayof_jint_arraycopy() { return _arrayof_jint_arraycopy; } 340 static address arrayof_jlong_arraycopy() { return _arrayof_jlong_arraycopy; } 341 static address arrayof_oop_arraycopy(bool dest_uninitialized = false) { 342 return dest_uninitialized ? _arrayof_oop_arraycopy_uninit : _arrayof_oop_arraycopy; 343 } 344 345 static address arrayof_jbyte_disjoint_arraycopy() { return _arrayof_jbyte_disjoint_arraycopy; } 346 static address arrayof_jshort_disjoint_arraycopy() { return _arrayof_jshort_disjoint_arraycopy; } 347 static address arrayof_jint_disjoint_arraycopy() { return _arrayof_jint_disjoint_arraycopy; } 348 static address arrayof_jlong_disjoint_arraycopy() { return _arrayof_jlong_disjoint_arraycopy; } 349 static address arrayof_oop_disjoint_arraycopy(bool dest_uninitialized = false) { 350 return dest_uninitialized ? _arrayof_oop_disjoint_arraycopy_uninit : _arrayof_oop_disjoint_arraycopy; 351 } 352 353 static address checkcast_arraycopy(bool dest_uninitialized = false) { 354 return dest_uninitialized ? _checkcast_arraycopy_uninit : _checkcast_arraycopy; 355 } 356 static address unsafe_arraycopy() { return _unsafe_arraycopy; } 357 static address generic_arraycopy() { return _generic_arraycopy; } 358 359 static address jbyte_fill() { return _jbyte_fill; } 360 static address jshort_fill() { return _jshort_fill; } 361 static address jint_fill() { return _jint_fill; } 362 static address arrayof_jbyte_fill() { return _arrayof_jbyte_fill; } 363 static address arrayof_jshort_fill() { return _arrayof_jshort_fill; } 364 static address arrayof_jint_fill() { return _arrayof_jint_fill; } 365 366 static address aescrypt_encryptBlock() { return _aescrypt_encryptBlock; } 367 static address aescrypt_decryptBlock() { return _aescrypt_decryptBlock; } 368 static address cipherBlockChaining_encryptAESCrypt() { return _cipherBlockChaining_encryptAESCrypt; } 369 static address cipherBlockChaining_decryptAESCrypt() { return _cipherBlockChaining_decryptAESCrypt; } 370 static address counterMode_AESCrypt() { return _counterMode_AESCrypt; } 371 static address ghash_processBlocks() { return _ghash_processBlocks; } 372 373 static address sha1_implCompress() { return _sha1_implCompress; } 374 static address sha1_implCompressMB() { return _sha1_implCompressMB; } 375 static address sha256_implCompress() { return _sha256_implCompress; } 376 static address sha256_implCompressMB() { return _sha256_implCompressMB; } 377 static address sha512_implCompress() { return _sha512_implCompress; } 378 static address sha512_implCompressMB() { return _sha512_implCompressMB; } 379 380 static address updateBytesCRC32() { return _updateBytesCRC32; } 381 static address crc_table_addr() { return _crc_table_adr; } 382 383 static address crc32c_table_addr() { return _crc32c_table_addr; } 384 static address updateBytesCRC32C() { return _updateBytesCRC32C; } 385 static address updateBytesAdler32() { return _updateBytesAdler32; } 386 387 static address multiplyToLen() {return _multiplyToLen; } 388 static address squareToLen() {return _squareToLen; } 389 static address mulAdd() {return _mulAdd; } 390 static address montgomeryMultiply() { return _montgomeryMultiply; } 391 static address montgomerySquare() { return _montgomerySquare; } 392 393 static address vectorizedMismatch() { return _vectorizedMismatch; } 394 395 static address dexp() { return _dexp; } 396 static address dlog() { return _dlog; } 397 static address dlog10() { return _dlog10; } 398 static address dpow() { return _dpow; } 399 static address dsin() { return _dsin; } 400 static address dcos() { return _dcos; } 401 static address dlibm_reduce_pi04l() { return _dlibm_reduce_pi04l; } 402 static address dlibm_sin_cos_huge() { return _dlibm_sin_cos_huge; } 403 static address dlibm_tan_cot_huge() { return _dlibm_tan_cot_huge; } 404 static address dtan() { return _dtan; } 405 406 static address select_fill_function(BasicType t, bool aligned, const char* &name); 407 408 static address zero_aligned_words() { return _zero_aligned_words; } 409 410 static double intrinsic_log10(double d) { 411 assert(_intrinsic_log10 != NULL, "must be defined"); 412 return _intrinsic_log10(d); 413 } 414 static double intrinsic_pow(double d, double d2) { 415 assert(_intrinsic_pow != NULL, "must be defined"); 416 return _intrinsic_pow(d, d2); 417 } 418 static double intrinsic_sin(double d) { 419 assert(_intrinsic_sin != NULL, "must be defined"); 420 return _intrinsic_sin(d); 421 } 422 static double intrinsic_cos(double d) { 423 assert(_intrinsic_cos != NULL, "must be defined"); 424 return _intrinsic_cos(d); 425 } 426 static double intrinsic_tan(double d) { 427 assert(_intrinsic_tan != NULL, "must be defined"); 428 return _intrinsic_tan(d); 429 } 430 431 // 432 // Safefetch stub support 433 // 434 435 typedef int (*SafeFetch32Stub)(int* adr, int errValue); 436 typedef intptr_t (*SafeFetchNStub) (intptr_t* adr, intptr_t errValue); 437 438 static SafeFetch32Stub SafeFetch32_stub() { return CAST_TO_FN_PTR(SafeFetch32Stub, _safefetch32_entry); } 439 static SafeFetchNStub SafeFetchN_stub() { return CAST_TO_FN_PTR(SafeFetchNStub, _safefetchN_entry); } 440 441 static bool is_safefetch_fault(address pc) { 442 return pc != NULL && 443 (pc == _safefetch32_fault_pc || 444 pc == _safefetchN_fault_pc); 445 } 446 447 static address continuation_for_safefetch_fault(address pc) { 448 assert(_safefetch32_continuation_pc != NULL && 449 _safefetchN_continuation_pc != NULL, 450 "not initialized"); 451 452 if (pc == _safefetch32_fault_pc) return _safefetch32_continuation_pc; 453 if (pc == _safefetchN_fault_pc) return _safefetchN_continuation_pc; 454 455 ShouldNotReachHere(); 456 return NULL; 457 } 458 459 // 460 // Default versions of the above arraycopy functions for platforms which do 461 // not have specialized versions 462 // 463 static void jbyte_copy (jbyte* src, jbyte* dest, size_t count); 464 static void jshort_copy (jshort* src, jshort* dest, size_t count); 465 static void jint_copy (jint* src, jint* dest, size_t count); 466 static void jlong_copy (jlong* src, jlong* dest, size_t count); 467 static void oop_copy (oop* src, oop* dest, size_t count); 468 static void oop_copy_uninit(oop* src, oop* dest, size_t count); 469 470 static void arrayof_jbyte_copy (HeapWord* src, HeapWord* dest, size_t count); 471 static void arrayof_jshort_copy (HeapWord* src, HeapWord* dest, size_t count); 472 static void arrayof_jint_copy (HeapWord* src, HeapWord* dest, size_t count); 473 static void arrayof_jlong_copy (HeapWord* src, HeapWord* dest, size_t count); 474 static void arrayof_oop_copy (HeapWord* src, HeapWord* dest, size_t count); 475 static void arrayof_oop_copy_uninit(HeapWord* src, HeapWord* dest, size_t count); 476 }; 477 478 // Safefetch allows to load a value from a location that's not known 479 // to be valid. If the load causes a fault, the error value is returned. 480 inline int SafeFetch32(int* adr, int errValue) { 481 assert(StubRoutines::SafeFetch32_stub(), "stub not yet generated"); 482 return StubRoutines::SafeFetch32_stub()(adr, errValue); 483 } 484 inline intptr_t SafeFetchN(intptr_t* adr, intptr_t errValue) { 485 assert(StubRoutines::SafeFetchN_stub(), "stub not yet generated"); 486 return StubRoutines::SafeFetchN_stub()(adr, errValue); 487 } 488 489 490 // returns true if SafeFetch32 and SafeFetchN can be used safely (stubroutines are already generated) 491 inline bool CanUseSafeFetch32() { 492 return StubRoutines::SafeFetch32_stub() ? true : false; 493 } 494 495 inline bool CanUseSafeFetchN() { 496 return StubRoutines::SafeFetchN_stub() ? true : false; 497 } 498 #endif // SHARE_VM_RUNTIME_STUBROUTINES_HPP