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