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