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