1 /*
   2  * Copyright (c) 1997, 2017, 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/macros.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 
  88 #include CPU_HEADER(stubRoutines)
  89 
  90   static jint    _verify_oop_count;
  91   static address _verify_oop_subroutine_entry;
  92 
  93   static address _call_stub_return_address;                // the return PC, when returning to a call stub
  94   static address _call_stub_entry;
  95   static address _forward_exception_entry;
  96   static address _catch_exception_entry;
  97   static address _throw_AbstractMethodError_entry;
  98   static address _throw_IncompatibleClassChangeError_entry;
  99   static address _throw_NullPointerException_at_call_entry;
 100   static address _throw_StackOverflowError_entry;
 101   static address _throw_delayed_StackOverflowError_entry;
 102 
 103   static address _atomic_xchg_entry;
 104   static address _atomic_xchg_long_entry;
 105   static address _atomic_store_entry;
 106   static address _atomic_cmpxchg_entry;
 107   static address _atomic_cmpxchg_byte_entry;
 108   static address _atomic_cmpxchg_long_entry;
 109   static address _atomic_add_entry;
 110   static address _atomic_add_long_entry;
 111   static address _fence_entry;
 112   static address _d2i_wrapper;
 113   static address _d2l_wrapper;
 114 
 115   static jint    _fpu_cntrl_wrd_std;
 116   static jint    _fpu_cntrl_wrd_24;
 117   static jint    _fpu_cntrl_wrd_64;
 118   static jint    _fpu_cntrl_wrd_trunc;
 119   static jint    _mxcsr_std;
 120   static jint    _fpu_subnormal_bias1[3];
 121   static jint    _fpu_subnormal_bias2[3];
 122 
 123   static BufferBlob* _code1;                               // code buffer for initial routines
 124   static BufferBlob* _code2;                               // code buffer for all other routines
 125 
 126   // Leaf routines which implement arraycopy and their addresses
 127   // arraycopy operands aligned on element type boundary
 128   static address _jbyte_arraycopy;
 129   static address _jshort_arraycopy;
 130   static address _jint_arraycopy;
 131   static address _jlong_arraycopy;
 132   static address _oop_arraycopy, _oop_arraycopy_uninit;
 133   static address _jbyte_disjoint_arraycopy;
 134   static address _jshort_disjoint_arraycopy;
 135   static address _jint_disjoint_arraycopy;
 136   static address _jlong_disjoint_arraycopy;
 137   static address _oop_disjoint_arraycopy, _oop_disjoint_arraycopy_uninit;
 138 
 139   // arraycopy operands aligned on zero'th element boundary
 140   // These are identical to the ones aligned aligned on an
 141   // element type boundary, except that they assume that both
 142   // source and destination are HeapWord aligned.
 143   static address _arrayof_jbyte_arraycopy;
 144   static address _arrayof_jshort_arraycopy;
 145   static address _arrayof_jint_arraycopy;
 146   static address _arrayof_jlong_arraycopy;
 147   static address _arrayof_oop_arraycopy, _arrayof_oop_arraycopy_uninit;
 148   static address _arrayof_jbyte_disjoint_arraycopy;
 149   static address _arrayof_jshort_disjoint_arraycopy;
 150   static address _arrayof_jint_disjoint_arraycopy;
 151   static address _arrayof_jlong_disjoint_arraycopy;
 152   static address _arrayof_oop_disjoint_arraycopy, _arrayof_oop_disjoint_arraycopy_uninit;
 153 
 154   // these are recommended but optional:
 155   static address _checkcast_arraycopy, _checkcast_arraycopy_uninit;
 156   static address _unsafe_arraycopy;
 157   static address _generic_arraycopy;
 158 
 159   static address _jbyte_fill;
 160   static address _jshort_fill;
 161   static address _jint_fill;
 162   static address _arrayof_jbyte_fill;
 163   static address _arrayof_jshort_fill;
 164   static address _arrayof_jint_fill;
 165 
 166   // zero heap space aligned to jlong (8 bytes)
 167   static address _zero_aligned_words;
 168 
 169   static address _aescrypt_encryptBlock;
 170   static address _aescrypt_decryptBlock;
 171   static address _cipherBlockChaining_encryptAESCrypt;
 172   static address _cipherBlockChaining_decryptAESCrypt;
 173   static address _counterMode_AESCrypt;
 174   static address _ghash_processBlocks;
 175   static address _base64_encodeBlock;
 176 
 177   static address _sha1_implCompress;
 178   static address _sha1_implCompressMB;
 179   static address _sha256_implCompress;
 180   static address _sha256_implCompressMB;
 181   static address _sha512_implCompress;
 182   static address _sha512_implCompressMB;
 183 
 184   static address _updateBytesCRC32;
 185   static address _crc_table_adr;
 186 
 187   static address _crc32c_table_addr;
 188   static address _updateBytesCRC32C;
 189   static address _updateBytesAdler32;
 190 
 191   static address _multiplyToLen;
 192   static address _squareToLen;
 193   static address _mulAdd;
 194   static address _montgomeryMultiply;
 195   static address _montgomerySquare;
 196 
 197   static address _vectorizedMismatch;
 198 



 199   static address _dexp;
 200   static address _dlog;
 201   static address _dlog10;
 202   static address _dpow;
 203   static address _dsin;
 204   static address _dcos;
 205   static address _dlibm_sin_cos_huge;
 206   static address _dlibm_reduce_pi04l;
 207   static address _dlibm_tan_cot_huge;
 208   static address _dtan;
 209 
 210   // These are versions of the java.lang.Math methods which perform
 211   // the same operations as the intrinsic version.  They are used for
 212   // constant folding in the compiler to ensure equivalence.  If the
 213   // intrinsic version returns the same result as the strict version
 214   // then they can be set to the appropriate function from
 215   // SharedRuntime.
 216   static double (*_intrinsic_log10)(double);
 217   static double (*_intrinsic_pow)(double, double);
 218   static double (*_intrinsic_sin)(double);
 219   static double (*_intrinsic_cos)(double);
 220   static double (*_intrinsic_tan)(double);
 221 
 222   // Safefetch stubs.
 223   static address _safefetch32_entry;
 224   static address _safefetch32_fault_pc;
 225   static address _safefetch32_continuation_pc;
 226   static address _safefetchN_entry;
 227   static address _safefetchN_fault_pc;
 228   static address _safefetchN_continuation_pc;
 229 
 230  public:
 231   // Initialization/Testing
 232   static void    initialize1();                            // must happen before universe::genesis
 233   static void    initialize2();                            // must happen after  universe::genesis
 234 
 235   static bool is_stub_code(address addr)                   { return contains(addr); }
 236 
 237   static bool contains(address addr) {
 238     return
 239       (_code1 != NULL && _code1->blob_contains(addr)) ||
 240       (_code2 != NULL && _code2->blob_contains(addr)) ;
 241   }
 242 
 243   static RuntimeBlob* code1() { return _code1; }
 244   static RuntimeBlob* code2() { return _code2; }
 245 
 246   // Debugging
 247   static jint    verify_oop_count()                        { return _verify_oop_count; }
 248   static jint*   verify_oop_count_addr()                   { return &_verify_oop_count; }
 249   // a subroutine for debugging the GC
 250   static address verify_oop_subroutine_entry_address()     { return (address)&_verify_oop_subroutine_entry; }
 251 
 252   static address catch_exception_entry()                   { return _catch_exception_entry; }
 253 
 254   // Calls to Java
 255   typedef void (*CallStub)(
 256     address   link,
 257     intptr_t* result,
 258     BasicType result_type,
 259     Method* method,
 260     address   entry_point,
 261     intptr_t* parameters,
 262     int       size_of_parameters,
 263     TRAPS
 264   );
 265 
 266   static CallStub call_stub()                              { return CAST_TO_FN_PTR(CallStub, _call_stub_entry); }
 267 
 268   // Exceptions
 269   static address forward_exception_entry()                 { return _forward_exception_entry; }
 270   // Implicit exceptions
 271   static address throw_AbstractMethodError_entry()         { return _throw_AbstractMethodError_entry; }
 272   static address throw_IncompatibleClassChangeError_entry(){ return _throw_IncompatibleClassChangeError_entry; }
 273   static address throw_NullPointerException_at_call_entry(){ return _throw_NullPointerException_at_call_entry; }
 274   static address throw_StackOverflowError_entry()          { return _throw_StackOverflowError_entry; }
 275   static address throw_delayed_StackOverflowError_entry()  { return _throw_delayed_StackOverflowError_entry; }
 276 
 277   static address atomic_xchg_entry()                       { return _atomic_xchg_entry; }
 278   static address atomic_xchg_long_entry()                  { return _atomic_xchg_long_entry; }
 279   static address atomic_store_entry()                      { return _atomic_store_entry; }
 280   static address atomic_cmpxchg_entry()                    { return _atomic_cmpxchg_entry; }
 281   static address atomic_cmpxchg_byte_entry()               { return _atomic_cmpxchg_byte_entry; }
 282   static address atomic_cmpxchg_long_entry()               { return _atomic_cmpxchg_long_entry; }
 283   static address atomic_add_entry()                        { return _atomic_add_entry; }
 284   static address atomic_add_long_entry()                   { return _atomic_add_long_entry; }
 285   static address fence_entry()                             { return _fence_entry; }
 286 
 287   static address d2i_wrapper()                             { return _d2i_wrapper; }
 288   static address d2l_wrapper()                             { return _d2l_wrapper; }
 289   static jint    fpu_cntrl_wrd_std()                       { return _fpu_cntrl_wrd_std;   }
 290   static address addr_fpu_cntrl_wrd_std()                  { return (address)&_fpu_cntrl_wrd_std;   }
 291   static address addr_fpu_cntrl_wrd_24()                   { return (address)&_fpu_cntrl_wrd_24;   }
 292   static address addr_fpu_cntrl_wrd_64()                   { return (address)&_fpu_cntrl_wrd_64;   }
 293   static address addr_fpu_cntrl_wrd_trunc()                { return (address)&_fpu_cntrl_wrd_trunc; }
 294   static address addr_mxcsr_std()                          { return (address)&_mxcsr_std; }
 295   static address addr_fpu_subnormal_bias1()                { return (address)&_fpu_subnormal_bias1; }
 296   static address addr_fpu_subnormal_bias2()                { return (address)&_fpu_subnormal_bias2; }
 297 
 298 
 299   static address select_arraycopy_function(BasicType t, bool aligned, bool disjoint, const char* &name, bool dest_uninitialized);
 300 
 301   static address jbyte_arraycopy()  { return _jbyte_arraycopy; }
 302   static address jshort_arraycopy() { return _jshort_arraycopy; }
 303   static address jint_arraycopy()   { return _jint_arraycopy; }
 304   static address jlong_arraycopy()  { return _jlong_arraycopy; }
 305   static address oop_arraycopy(bool dest_uninitialized = false) {
 306     return dest_uninitialized ? _oop_arraycopy_uninit : _oop_arraycopy;
 307   }
 308   static address jbyte_disjoint_arraycopy()  { return _jbyte_disjoint_arraycopy; }
 309   static address jshort_disjoint_arraycopy() { return _jshort_disjoint_arraycopy; }
 310   static address jint_disjoint_arraycopy()   { return _jint_disjoint_arraycopy; }
 311   static address jlong_disjoint_arraycopy()  { return _jlong_disjoint_arraycopy; }
 312   static address oop_disjoint_arraycopy(bool dest_uninitialized = false) {
 313     return dest_uninitialized ?  _oop_disjoint_arraycopy_uninit : _oop_disjoint_arraycopy;
 314   }
 315 
 316   static address arrayof_jbyte_arraycopy()  { return _arrayof_jbyte_arraycopy; }
 317   static address arrayof_jshort_arraycopy() { return _arrayof_jshort_arraycopy; }
 318   static address arrayof_jint_arraycopy()   { return _arrayof_jint_arraycopy; }
 319   static address arrayof_jlong_arraycopy()  { return _arrayof_jlong_arraycopy; }
 320   static address arrayof_oop_arraycopy(bool dest_uninitialized = false) {
 321     return dest_uninitialized ? _arrayof_oop_arraycopy_uninit : _arrayof_oop_arraycopy;
 322   }
 323 
 324   static address arrayof_jbyte_disjoint_arraycopy()  { return _arrayof_jbyte_disjoint_arraycopy; }
 325   static address arrayof_jshort_disjoint_arraycopy() { return _arrayof_jshort_disjoint_arraycopy; }
 326   static address arrayof_jint_disjoint_arraycopy()   { return _arrayof_jint_disjoint_arraycopy; }
 327   static address arrayof_jlong_disjoint_arraycopy()  { return _arrayof_jlong_disjoint_arraycopy; }
 328   static address arrayof_oop_disjoint_arraycopy(bool dest_uninitialized = false) {
 329     return dest_uninitialized ? _arrayof_oop_disjoint_arraycopy_uninit : _arrayof_oop_disjoint_arraycopy;
 330   }
 331 
 332   static address checkcast_arraycopy(bool dest_uninitialized = false) {
 333     return dest_uninitialized ? _checkcast_arraycopy_uninit : _checkcast_arraycopy;
 334   }
 335   static address unsafe_arraycopy()    { return _unsafe_arraycopy; }
 336   static address generic_arraycopy()   { return _generic_arraycopy; }
 337 
 338   static address jbyte_fill()          { return _jbyte_fill; }
 339   static address jshort_fill()         { return _jshort_fill; }
 340   static address jint_fill()           { return _jint_fill; }
 341   static address arrayof_jbyte_fill()  { return _arrayof_jbyte_fill; }
 342   static address arrayof_jshort_fill() { return _arrayof_jshort_fill; }
 343   static address arrayof_jint_fill()   { return _arrayof_jint_fill; }
 344 
 345   static address aescrypt_encryptBlock()                { return _aescrypt_encryptBlock; }
 346   static address aescrypt_decryptBlock()                { return _aescrypt_decryptBlock; }
 347   static address cipherBlockChaining_encryptAESCrypt()  { return _cipherBlockChaining_encryptAESCrypt; }
 348   static address cipherBlockChaining_decryptAESCrypt()  { return _cipherBlockChaining_decryptAESCrypt; }
 349   static address counterMode_AESCrypt()  { return _counterMode_AESCrypt; }
 350   static address ghash_processBlocks()   { return _ghash_processBlocks; }
 351   static address base64_encodeBlock()    { return _base64_encodeBlock; }
 352   static address sha1_implCompress()     { return _sha1_implCompress; }
 353   static address sha1_implCompressMB()   { return _sha1_implCompressMB; }
 354   static address sha256_implCompress()   { return _sha256_implCompress; }
 355   static address sha256_implCompressMB() { return _sha256_implCompressMB; }
 356   static address sha512_implCompress()   { return _sha512_implCompress; }
 357   static address sha512_implCompressMB() { return _sha512_implCompressMB; }
 358 
 359   static address updateBytesCRC32()    { return _updateBytesCRC32; }
 360   static address crc_table_addr()      { return _crc_table_adr; }
 361 
 362   static address crc32c_table_addr()   { return _crc32c_table_addr; }
 363   static address updateBytesCRC32C()   { return _updateBytesCRC32C; }
 364   static address updateBytesAdler32()  { return _updateBytesAdler32; }
 365 
 366   static address multiplyToLen()       { return _multiplyToLen; }
 367   static address squareToLen()         { return _squareToLen; }
 368   static address mulAdd()              { return _mulAdd; }
 369   static address montgomeryMultiply()  { return _montgomeryMultiply; }
 370   static address montgomerySquare()    { return _montgomerySquare; }
 371 
 372   static address vectorizedMismatch()  { return _vectorizedMismatch; }



 373 
 374   static address dexp()                { return _dexp; }
 375   static address dlog()                { return _dlog; }
 376   static address dlog10()              { return _dlog10; }
 377   static address dpow()                { return _dpow; }
 378   static address dsin()                { return _dsin; }
 379   static address dcos()                { return _dcos; }
 380   static address dlibm_reduce_pi04l()  { return _dlibm_reduce_pi04l; }
 381   static address dlibm_sin_cos_huge()  { return _dlibm_sin_cos_huge; }
 382   static address dlibm_tan_cot_huge()  { return _dlibm_tan_cot_huge; }
 383   static address dtan()                { return _dtan; }
 384 
 385   static address select_fill_function(BasicType t, bool aligned, const char* &name);
 386 
 387   static address zero_aligned_words()  { return _zero_aligned_words; }
 388 
 389   static double  intrinsic_log10(double d) {
 390     assert(_intrinsic_log10 != NULL, "must be defined");
 391     return _intrinsic_log10(d);
 392   }
 393   static double  intrinsic_pow(double d, double d2) {
 394     assert(_intrinsic_pow != NULL, "must be defined");
 395     return _intrinsic_pow(d, d2);
 396   }
 397   static double  intrinsic_sin(double d) {
 398     assert(_intrinsic_sin != NULL, "must be defined");
 399     return _intrinsic_sin(d);
 400   }
 401   static double  intrinsic_cos(double d) {
 402     assert(_intrinsic_cos != NULL, "must be defined");
 403     return _intrinsic_cos(d);
 404   }
 405   static double  intrinsic_tan(double d) {
 406     assert(_intrinsic_tan != NULL, "must be defined");
 407     return _intrinsic_tan(d);
 408   }
 409 
 410   //
 411   // Safefetch stub support
 412   //
 413 
 414   typedef int      (*SafeFetch32Stub)(int*      adr, int      errValue);
 415   typedef intptr_t (*SafeFetchNStub) (intptr_t* adr, intptr_t errValue);
 416 
 417   static SafeFetch32Stub SafeFetch32_stub() { return CAST_TO_FN_PTR(SafeFetch32Stub, _safefetch32_entry); }
 418   static SafeFetchNStub  SafeFetchN_stub()  { return CAST_TO_FN_PTR(SafeFetchNStub,  _safefetchN_entry); }
 419 
 420   static bool is_safefetch_fault(address pc) {
 421     return pc != NULL &&
 422           (pc == _safefetch32_fault_pc ||
 423            pc == _safefetchN_fault_pc);
 424   }
 425 
 426   static address continuation_for_safefetch_fault(address pc) {
 427     assert(_safefetch32_continuation_pc != NULL &&
 428            _safefetchN_continuation_pc  != NULL,
 429            "not initialized");
 430 
 431     if (pc == _safefetch32_fault_pc) return _safefetch32_continuation_pc;
 432     if (pc == _safefetchN_fault_pc)  return _safefetchN_continuation_pc;
 433 
 434     ShouldNotReachHere();
 435     return NULL;
 436   }
 437 
 438   //
 439   // Default versions of the above arraycopy functions for platforms which do
 440   // not have specialized versions
 441   //
 442   static void jbyte_copy     (jbyte*  src, jbyte*  dest, size_t count);
 443   static void jshort_copy    (jshort* src, jshort* dest, size_t count);
 444   static void jint_copy      (jint*   src, jint*   dest, size_t count);
 445   static void jlong_copy     (jlong*  src, jlong*  dest, size_t count);
 446   static void oop_copy       (oop*    src, oop*    dest, size_t count);
 447   static void oop_copy_uninit(oop*    src, oop*    dest, size_t count);
 448 
 449   static void arrayof_jbyte_copy     (HeapWord* src, HeapWord* dest, size_t count);
 450   static void arrayof_jshort_copy    (HeapWord* src, HeapWord* dest, size_t count);
 451   static void arrayof_jint_copy      (HeapWord* src, HeapWord* dest, size_t count);
 452   static void arrayof_jlong_copy     (HeapWord* src, HeapWord* dest, size_t count);
 453   static void arrayof_oop_copy       (HeapWord* src, HeapWord* dest, size_t count);
 454   static void arrayof_oop_copy_uninit(HeapWord* src, HeapWord* dest, size_t count);
 455 };
 456 
 457 // Safefetch allows to load a value from a location that's not known
 458 // to be valid. If the load causes a fault, the error value is returned.
 459 inline int SafeFetch32(int* adr, int errValue) {
 460   assert(StubRoutines::SafeFetch32_stub(), "stub not yet generated");
 461   return StubRoutines::SafeFetch32_stub()(adr, errValue);
 462 }
 463 inline intptr_t SafeFetchN(intptr_t* adr, intptr_t errValue) {
 464   assert(StubRoutines::SafeFetchN_stub(), "stub not yet generated");
 465   return StubRoutines::SafeFetchN_stub()(adr, errValue);
 466 }
 467 
 468 
 469 // returns true if SafeFetch32 and SafeFetchN can be used safely (stubroutines are already generated)
 470 inline bool CanUseSafeFetch32() {
 471   return StubRoutines::SafeFetch32_stub() ? true : false;
 472 }
 473 
 474 inline bool CanUseSafeFetchN() {
 475   return StubRoutines::SafeFetchN_stub() ? true : false;
 476 }
 477 #endif // SHARE_VM_RUNTIME_STUBROUTINES_HPP
--- EOF ---