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