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