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