1 /* 2 * Copyright (c) 1997, 2014, 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 #ifdef TARGET_ARCH_MODEL_x86_32 88 # include "stubRoutines_x86_32.hpp" 89 #endif 90 #ifdef TARGET_ARCH_MODEL_x86_64 91 # include "stubRoutines_x86_64.hpp" 92 #endif 93 #ifdef TARGET_ARCH_MODEL_sparc 94 # include "stubRoutines_sparc.hpp" 95 #endif 96 #ifdef TARGET_ARCH_MODEL_zero 97 # include "stubRoutines_zero.hpp" 98 #endif 99 #ifdef TARGET_ARCH_MODEL_arm 100 # include "stubRoutines_arm.hpp" 101 #endif 102 #ifdef TARGET_ARCH_MODEL_ppc_32 103 # include "stubRoutines_ppc_32.hpp" 104 #endif 105 #ifdef TARGET_ARCH_MODEL_ppc_64 106 # include "stubRoutines_ppc_64.hpp" 107 #endif 108 109 110 static jint _verify_oop_count; 111 static address _verify_oop_subroutine_entry; 112 113 static address _call_stub_return_address; // the return PC, when returning to a call stub 114 static address _call_stub_entry; 115 static address _forward_exception_entry; 116 static address _catch_exception_entry; 117 static address _throw_AbstractMethodError_entry; 118 static address _throw_IncompatibleClassChangeError_entry; 119 static address _throw_NullPointerException_at_call_entry; 120 static address _throw_StackOverflowError_entry; 121 static address _handler_for_unsafe_access_entry; 122 123 static address _atomic_xchg_entry; 124 static address _atomic_xchg_ptr_entry; 125 static address _atomic_store_entry; 126 static address _atomic_store_ptr_entry; 127 static address _atomic_cmpxchg_entry; 128 static address _atomic_cmpxchg_ptr_entry; 129 static address _atomic_cmpxchg_long_entry; 130 static address _atomic_add_entry; 131 static address _atomic_add_ptr_entry; 132 static address _fence_entry; 133 static address _d2i_wrapper; 134 static address _d2l_wrapper; 135 136 static jint _fpu_cntrl_wrd_std; 137 static jint _fpu_cntrl_wrd_24; 138 static jint _fpu_cntrl_wrd_64; 139 static jint _fpu_cntrl_wrd_trunc; 140 static jint _mxcsr_std; 141 static jint _fpu_subnormal_bias1[3]; 142 static jint _fpu_subnormal_bias2[3]; 143 144 static BufferBlob* _code1; // code buffer for initial routines 145 static BufferBlob* _code2; // code buffer for all other routines 146 147 // Leaf routines which implement arraycopy and their addresses 148 // arraycopy operands aligned on element type boundary 149 static address _jbyte_arraycopy; 150 static address _jshort_arraycopy; 151 static address _jint_arraycopy; 152 static address _jlong_arraycopy; 153 static address _oop_arraycopy, _oop_arraycopy_uninit; 154 static address _jbyte_disjoint_arraycopy; 155 static address _jshort_disjoint_arraycopy; 156 static address _jint_disjoint_arraycopy; 157 static address _jlong_disjoint_arraycopy; 158 static address _oop_disjoint_arraycopy, _oop_disjoint_arraycopy_uninit; 159 160 // arraycopy operands aligned on zero'th element boundary 161 // These are identical to the ones aligned aligned on an 162 // element type boundary, except that they assume that both 163 // source and destination are HeapWord aligned. 164 static address _arrayof_jbyte_arraycopy; 165 static address _arrayof_jshort_arraycopy; 166 static address _arrayof_jint_arraycopy; 167 static address _arrayof_jlong_arraycopy; 168 static address _arrayof_oop_arraycopy, _arrayof_oop_arraycopy_uninit; 169 static address _arrayof_jbyte_disjoint_arraycopy; 170 static address _arrayof_jshort_disjoint_arraycopy; 171 static address _arrayof_jint_disjoint_arraycopy; 172 static address _arrayof_jlong_disjoint_arraycopy; 173 static address _arrayof_oop_disjoint_arraycopy, _arrayof_oop_disjoint_arraycopy_uninit; 174 175 // these are recommended but optional: 176 static address _checkcast_arraycopy, _checkcast_arraycopy_uninit; 177 static address _unsafe_arraycopy; 178 static address _generic_arraycopy; 179 180 static address _jbyte_fill; 181 static address _jshort_fill; 182 static address _jint_fill; 183 static address _arrayof_jbyte_fill; 184 static address _arrayof_jshort_fill; 185 static address _arrayof_jint_fill; 186 187 // zero heap space aligned to jlong (8 bytes) 188 static address _zero_aligned_words; 189 190 static address _aescrypt_encryptBlock; 191 static address _aescrypt_decryptBlock; 192 static address _cipherBlockChaining_encryptAESCrypt; 193 static address _cipherBlockChaining_decryptAESCrypt; 194 195 static address _sha1_implCompress; 196 static address _sha1_implCompressMB; 197 static address _sha256_implCompress; 198 static address _sha256_implCompressMB; 199 static address _sha512_implCompress; 200 static address _sha512_implCompressMB; 201 202 static address _updateBytesCRC32; 203 static address _crc_table_adr; 204 205 static address _multiplyToLen; 206 207 // These are versions of the java.lang.Math methods which perform 208 // the same operations as the intrinsic version. They are used for 209 // constant folding in the compiler to ensure equivalence. If the 210 // intrinsic version returns the same result as the strict version 211 // then they can be set to the appropriate function from 212 // SharedRuntime. 213 static double (*_intrinsic_log)(double); 214 static double (*_intrinsic_log10)(double); 215 static double (*_intrinsic_exp)(double); 216 static double (*_intrinsic_pow)(double, double); 217 static double (*_intrinsic_sin)(double); 218 static double (*_intrinsic_cos)(double); 219 static double (*_intrinsic_tan)(double); 220 221 // Safefetch stubs. 222 static address _safefetch32_entry; 223 static address _safefetch32_fault_pc; 224 static address _safefetch32_continuation_pc; 225 static address _safefetchN_entry; 226 static address _safefetchN_fault_pc; 227 static address _safefetchN_continuation_pc; 228 229 public: 230 // Initialization/Testing 231 static void initialize1(); // must happen before universe::genesis 232 static void initialize2(); // must happen after universe::genesis 233 234 static bool is_stub_code(address addr) { return contains(addr); } 235 236 static bool contains(address addr) { 237 return 238 (_code1 != NULL && _code1->blob_contains(addr)) || 239 (_code2 != NULL && _code2->blob_contains(addr)) ; 240 } 241 242 static CodeBlob* code1() { return _code1; } 243 static CodeBlob* code2() { return _code2; } 244 245 // Debugging 246 static jint verify_oop_count() { return _verify_oop_count; } 247 static jint* verify_oop_count_addr() { return &_verify_oop_count; } 248 // a subroutine for debugging the GC 249 static address verify_oop_subroutine_entry_address() { return (address)&_verify_oop_subroutine_entry; } 250 251 static address catch_exception_entry() { return _catch_exception_entry; } 252 253 // Calls to Java 254 typedef void (*CallStub)( 255 address link, 256 intptr_t* result, 257 BasicType result_type, 258 Method* method, 259 address entry_point, 260 intptr_t* parameters, 261 int size_of_parameters, 262 TRAPS 263 ); 264 265 static CallStub call_stub() { return CAST_TO_FN_PTR(CallStub, _call_stub_entry); } 266 267 // Exceptions 268 static address forward_exception_entry() { return _forward_exception_entry; } 269 // Implicit exceptions 270 static address throw_AbstractMethodError_entry() { return _throw_AbstractMethodError_entry; } 271 static address throw_IncompatibleClassChangeError_entry(){ return _throw_IncompatibleClassChangeError_entry; } 272 static address throw_NullPointerException_at_call_entry(){ return _throw_NullPointerException_at_call_entry; } 273 static address throw_StackOverflowError_entry() { return _throw_StackOverflowError_entry; } 274 275 // Exceptions during unsafe access - should throw Java exception rather 276 // than crash. 277 static address handler_for_unsafe_access() { return _handler_for_unsafe_access_entry; } 278 279 static address atomic_xchg_entry() { return _atomic_xchg_entry; } 280 static address atomic_xchg_ptr_entry() { return _atomic_xchg_ptr_entry; } 281 static address atomic_store_entry() { return _atomic_store_entry; } 282 static address atomic_store_ptr_entry() { return _atomic_store_ptr_entry; } 283 static address atomic_cmpxchg_entry() { return _atomic_cmpxchg_entry; } 284 static address atomic_cmpxchg_ptr_entry() { return _atomic_cmpxchg_ptr_entry; } 285 static address atomic_cmpxchg_long_entry() { return _atomic_cmpxchg_long_entry; } 286 static address atomic_add_entry() { return _atomic_add_entry; } 287 static address atomic_add_ptr_entry() { return _atomic_add_ptr_entry; } 288 static address fence_entry() { return _fence_entry; } 289 290 static address d2i_wrapper() { return _d2i_wrapper; } 291 static address d2l_wrapper() { return _d2l_wrapper; } 292 static jint fpu_cntrl_wrd_std() { return _fpu_cntrl_wrd_std; } 293 static address addr_fpu_cntrl_wrd_std() { return (address)&_fpu_cntrl_wrd_std; } 294 static address addr_fpu_cntrl_wrd_24() { return (address)&_fpu_cntrl_wrd_24; } 295 static address addr_fpu_cntrl_wrd_64() { return (address)&_fpu_cntrl_wrd_64; } 296 static address addr_fpu_cntrl_wrd_trunc() { return (address)&_fpu_cntrl_wrd_trunc; } 297 static address addr_mxcsr_std() { return (address)&_mxcsr_std; } 298 static address addr_fpu_subnormal_bias1() { return (address)&_fpu_subnormal_bias1; } 299 static address addr_fpu_subnormal_bias2() { return (address)&_fpu_subnormal_bias2; } 300 301 302 static address select_arraycopy_function(BasicType t, bool aligned, bool disjoint, const char* &name, bool dest_uninitialized); 303 304 static address jbyte_arraycopy() { return _jbyte_arraycopy; } 305 static address jshort_arraycopy() { return _jshort_arraycopy; } 306 static address jint_arraycopy() { return _jint_arraycopy; } 307 static address jlong_arraycopy() { return _jlong_arraycopy; } 308 static address oop_arraycopy(bool dest_uninitialized = false) { 309 return dest_uninitialized ? _oop_arraycopy_uninit : _oop_arraycopy; 310 } 311 static address jbyte_disjoint_arraycopy() { return _jbyte_disjoint_arraycopy; } 312 static address jshort_disjoint_arraycopy() { return _jshort_disjoint_arraycopy; } 313 static address jint_disjoint_arraycopy() { return _jint_disjoint_arraycopy; } 314 static address jlong_disjoint_arraycopy() { return _jlong_disjoint_arraycopy; } 315 static address oop_disjoint_arraycopy(bool dest_uninitialized = false) { 316 return dest_uninitialized ? _oop_disjoint_arraycopy_uninit : _oop_disjoint_arraycopy; 317 } 318 319 static address arrayof_jbyte_arraycopy() { return _arrayof_jbyte_arraycopy; } 320 static address arrayof_jshort_arraycopy() { return _arrayof_jshort_arraycopy; } 321 static address arrayof_jint_arraycopy() { return _arrayof_jint_arraycopy; } 322 static address arrayof_jlong_arraycopy() { return _arrayof_jlong_arraycopy; } 323 static address arrayof_oop_arraycopy(bool dest_uninitialized = false) { 324 return dest_uninitialized ? _arrayof_oop_arraycopy_uninit : _arrayof_oop_arraycopy; 325 } 326 327 static address arrayof_jbyte_disjoint_arraycopy() { return _arrayof_jbyte_disjoint_arraycopy; } 328 static address arrayof_jshort_disjoint_arraycopy() { return _arrayof_jshort_disjoint_arraycopy; } 329 static address arrayof_jint_disjoint_arraycopy() { return _arrayof_jint_disjoint_arraycopy; } 330 static address arrayof_jlong_disjoint_arraycopy() { return _arrayof_jlong_disjoint_arraycopy; } 331 static address arrayof_oop_disjoint_arraycopy(bool dest_uninitialized = false) { 332 return dest_uninitialized ? _arrayof_oop_disjoint_arraycopy_uninit : _arrayof_oop_disjoint_arraycopy; 333 } 334 335 static address checkcast_arraycopy(bool dest_uninitialized = false) { 336 return dest_uninitialized ? _checkcast_arraycopy_uninit : _checkcast_arraycopy; 337 } 338 static address unsafe_arraycopy() { return _unsafe_arraycopy; } 339 static address generic_arraycopy() { return _generic_arraycopy; } 340 341 static address jbyte_fill() { return _jbyte_fill; } 342 static address jshort_fill() { return _jshort_fill; } 343 static address jint_fill() { return _jint_fill; } 344 static address arrayof_jbyte_fill() { return _arrayof_jbyte_fill; } 345 static address arrayof_jshort_fill() { return _arrayof_jshort_fill; } 346 static address arrayof_jint_fill() { return _arrayof_jint_fill; } 347 348 static address aescrypt_encryptBlock() { return _aescrypt_encryptBlock; } 349 static address aescrypt_decryptBlock() { return _aescrypt_decryptBlock; } 350 static address cipherBlockChaining_encryptAESCrypt() { return _cipherBlockChaining_encryptAESCrypt; } 351 static address cipherBlockChaining_decryptAESCrypt() { return _cipherBlockChaining_decryptAESCrypt; } 352 353 static address sha1_implCompress() { return _sha1_implCompress; } 354 static address sha1_implCompressMB() { return _sha1_implCompressMB; } 355 static address sha256_implCompress() { return _sha256_implCompress; } 356 static address sha256_implCompressMB() { return _sha256_implCompressMB; } 357 static address sha512_implCompress() { return _sha512_implCompress; } 358 static address sha512_implCompressMB() { return _sha512_implCompressMB; } 359 360 static address updateBytesCRC32() { return _updateBytesCRC32; } 361 static address crc_table_addr() { return _crc_table_adr; } 362 363 static address multiplyToLen() {return _multiplyToLen; } 364 365 static address select_fill_function(BasicType t, bool aligned, const char* &name); 366 367 static address zero_aligned_words() { return _zero_aligned_words; } 368 369 static double intrinsic_log(double d) { 370 assert(_intrinsic_log != NULL, "must be defined"); 371 return _intrinsic_log(d); 372 } 373 static double intrinsic_log10(double d) { 374 assert(_intrinsic_log != NULL, "must be defined"); 375 return _intrinsic_log10(d); 376 } 377 static double intrinsic_exp(double d) { 378 assert(_intrinsic_exp != NULL, "must be defined"); 379 return _intrinsic_exp(d); 380 } 381 static double intrinsic_pow(double d, double d2) { 382 assert(_intrinsic_pow != NULL, "must be defined"); 383 return _intrinsic_pow(d, d2); 384 } 385 static double intrinsic_sin(double d) { 386 assert(_intrinsic_sin != NULL, "must be defined"); 387 return _intrinsic_sin(d); 388 } 389 static double intrinsic_cos(double d) { 390 assert(_intrinsic_cos != NULL, "must be defined"); 391 return _intrinsic_cos(d); 392 } 393 static double intrinsic_tan(double d) { 394 assert(_intrinsic_tan != NULL, "must be defined"); 395 return _intrinsic_tan(d); 396 } 397 398 // 399 // Safefetch stub support 400 // 401 402 typedef int (*SafeFetch32Stub)(int* adr, int errValue); 403 typedef intptr_t (*SafeFetchNStub) (intptr_t* adr, intptr_t errValue); 404 405 static SafeFetch32Stub SafeFetch32_stub() { return CAST_TO_FN_PTR(SafeFetch32Stub, _safefetch32_entry); } 406 static SafeFetchNStub SafeFetchN_stub() { return CAST_TO_FN_PTR(SafeFetchNStub, _safefetchN_entry); } 407 408 static bool is_safefetch_fault(address pc) { 409 return pc != NULL && 410 (pc == _safefetch32_fault_pc || 411 pc == _safefetchN_fault_pc); 412 } 413 414 static address continuation_for_safefetch_fault(address pc) { 415 assert(_safefetch32_continuation_pc != NULL && 416 _safefetchN_continuation_pc != NULL, 417 "not initialized"); 418 419 if (pc == _safefetch32_fault_pc) return _safefetch32_continuation_pc; 420 if (pc == _safefetchN_fault_pc) return _safefetchN_continuation_pc; 421 422 ShouldNotReachHere(); 423 return NULL; 424 } 425 426 // 427 // Default versions of the above arraycopy functions for platforms which do 428 // not have specialized versions 429 // 430 static void jbyte_copy (jbyte* src, jbyte* dest, size_t count); 431 static void jshort_copy (jshort* src, jshort* dest, size_t count); 432 static void jint_copy (jint* src, jint* dest, size_t count); 433 static void jlong_copy (jlong* src, jlong* dest, size_t count); 434 static void oop_copy (oop* src, oop* dest, size_t count); 435 static void oop_copy_uninit(oop* src, oop* dest, size_t count); 436 437 static void arrayof_jbyte_copy (HeapWord* src, HeapWord* dest, size_t count); 438 static void arrayof_jshort_copy (HeapWord* src, HeapWord* dest, size_t count); 439 static void arrayof_jint_copy (HeapWord* src, HeapWord* dest, size_t count); 440 static void arrayof_jlong_copy (HeapWord* src, HeapWord* dest, size_t count); 441 static void arrayof_oop_copy (HeapWord* src, HeapWord* dest, size_t count); 442 static void arrayof_oop_copy_uninit(HeapWord* src, HeapWord* dest, size_t count); 443 }; 444 445 // Safefetch allows to load a value from a location that's not known 446 // to be valid. If the load causes a fault, the error value is returned. 447 inline int SafeFetch32(int* adr, int errValue) { 448 assert(StubRoutines::SafeFetch32_stub(), "stub not yet generated"); 449 return StubRoutines::SafeFetch32_stub()(adr, errValue); 450 } 451 inline intptr_t SafeFetchN(intptr_t* adr, intptr_t errValue) { 452 assert(StubRoutines::SafeFetchN_stub(), "stub not yet generated"); 453 return StubRoutines::SafeFetchN_stub()(adr, errValue); 454 } 455 456 #endif // SHARE_VM_RUNTIME_STUBROUTINES_HPP