1 /*
2 * Copyright (c) 1997, 2019, 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_RUNTIME_STUBROUTINES_HPP
26 #define SHARE_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 // Dependencies
82 friend class StubGenerator;
83
84 #include CPU_HEADER(stubRoutines)
85
86 static jint _verify_oop_count;
87 static address _verify_oop_subroutine_entry;
88
89 static address _call_stub_return_address; // the return PC, when returning to a call stub
90 static address _call_stub_entry;
91 static address _forward_exception_entry;
92 static address _catch_exception_entry;
93 static address _throw_AbstractMethodError_entry;
94 static address _throw_IncompatibleClassChangeError_entry;
95 static address _throw_NullPointerException_at_call_entry;
96 static address _throw_StackOverflowError_entry;
97 static address _throw_delayed_StackOverflowError_entry;
98
99 static address _atomic_xchg_entry;
100 static address _atomic_xchg_long_entry;
101 static address _atomic_store_entry;
102 static address _atomic_cmpxchg_entry;
103 static address _atomic_cmpxchg_byte_entry;
104 static address _atomic_cmpxchg_long_entry;
105 static address _atomic_add_entry;
106 static address _atomic_add_long_entry;
107 static address _fence_entry;
108 static address _d2i_wrapper;
109 static address _d2l_wrapper;
110
111 static jint _fpu_cntrl_wrd_std;
112 static jint _fpu_cntrl_wrd_24;
113 static jint _fpu_cntrl_wrd_trunc;
114 static jint _mxcsr_std;
115 static jint _fpu_subnormal_bias1[3];
116 static jint _fpu_subnormal_bias2[3];
117
118 static BufferBlob* _code1; // code buffer for initial routines
119 static BufferBlob* _code2; // code buffer for all other routines
120
121 // Leaf routines which implement arraycopy and their addresses
122 // arraycopy operands aligned on element type boundary
123 static address _jbyte_arraycopy;
124 static address _jshort_arraycopy;
125 static address _jint_arraycopy;
126 static address _jlong_arraycopy;
127 static address _oop_arraycopy, _oop_arraycopy_uninit;
128 static address _jbyte_disjoint_arraycopy;
129 static address _jshort_disjoint_arraycopy;
130 static address _jint_disjoint_arraycopy;
131 static address _jlong_disjoint_arraycopy;
132 static address _oop_disjoint_arraycopy, _oop_disjoint_arraycopy_uninit;
133
134 // arraycopy operands aligned on zero'th element boundary
135 // These are identical to the ones aligned aligned on an
136 // element type boundary, except that they assume that both
137 // source and destination are HeapWord aligned.
138 static address _arrayof_jbyte_arraycopy;
139 static address _arrayof_jshort_arraycopy;
140 static address _arrayof_jint_arraycopy;
141 static address _arrayof_jlong_arraycopy;
142 static address _arrayof_oop_arraycopy, _arrayof_oop_arraycopy_uninit;
143 static address _arrayof_jbyte_disjoint_arraycopy;
144 static address _arrayof_jshort_disjoint_arraycopy;
145 static address _arrayof_jint_disjoint_arraycopy;
146 static address _arrayof_jlong_disjoint_arraycopy;
147 static address _arrayof_oop_disjoint_arraycopy, _arrayof_oop_disjoint_arraycopy_uninit;
148
149 // these are recommended but optional:
150 static address _checkcast_arraycopy, _checkcast_arraycopy_uninit;
151 static address _unsafe_arraycopy;
152 static address _generic_arraycopy;
153
154 static address _jbyte_fill;
155 static address _jshort_fill;
156 static address _jint_fill;
157 static address _arrayof_jbyte_fill;
158 static address _arrayof_jshort_fill;
159 static address _arrayof_jint_fill;
160
161 // zero heap space aligned to jlong (8 bytes)
162 static address _zero_aligned_words;
163
164 static address _aescrypt_encryptBlock;
165 static address _aescrypt_decryptBlock;
166 static address _cipherBlockChaining_encryptAESCrypt;
167 static address _cipherBlockChaining_decryptAESCrypt;
168 static address _counterMode_AESCrypt;
169 static address _ghash_processBlocks;
170 static address _base64_encodeBlock;
171
172 static address _sha1_implCompress;
173 static address _sha1_implCompressMB;
174 static address _sha256_implCompress;
175 static address _sha256_implCompressMB;
176 static address _sha512_implCompress;
177 static address _sha512_implCompressMB;
178
179 static address _updateBytesCRC32;
180 static address _crc_table_adr;
181
182 static address _crc32c_table_addr;
183 static address _updateBytesCRC32C;
184 static address _updateBytesAdler32;
185
186 static address _multiplyToLen;
187 static address _squareToLen;
188 static address _mulAdd;
189 static address _montgomeryMultiply;
190 static address _montgomerySquare;
191
192 static address _vectorizedMismatch;
193
194 static address _dexp;
195 static address _dlog;
196 static address _dlog10;
197 static address _dpow;
198 static address _dsin;
199 static address _dcos;
200 static address _dlibm_sin_cos_huge;
201 static address _dlibm_reduce_pi04l;
202 static address _dlibm_tan_cot_huge;
203 static address _dtan;
204
205 // Safefetch stubs.
206 static address _safefetch32_entry;
207 static address _safefetch32_fault_pc;
208 static address _safefetch32_continuation_pc;
209 static address _safefetchN_entry;
210 static address _safefetchN_fault_pc;
211 static address _safefetchN_continuation_pc;
212
213 static address _load_value_type_fields_in_regs;
214 static address _store_value_type_fields_to_buf;
215
216 public:
217 // Initialization/Testing
218 static void initialize1(); // must happen before universe::genesis
219 static void initialize2(); // must happen after universe::genesis
220
221 static bool is_stub_code(address addr) { return contains(addr); }
222
223 static bool contains(address addr) {
224 return
225 (_code1 != NULL && _code1->blob_contains(addr)) ||
226 (_code2 != NULL && _code2->blob_contains(addr)) ;
227 }
228
229 static RuntimeBlob* code1() { return _code1; }
230 static RuntimeBlob* code2() { return _code2; }
231
232 // Debugging
233 static jint verify_oop_count() { return _verify_oop_count; }
234 static jint* verify_oop_count_addr() { return &_verify_oop_count; }
235 // a subroutine for debugging the GC
236 static address verify_oop_subroutine_entry_address() { return (address)&_verify_oop_subroutine_entry; }
237
238 static address catch_exception_entry() { return _catch_exception_entry; }
239
240 // Calls to Java
241 typedef void (*CallStub)(
242 address link,
243 intptr_t* result,
244 BasicType result_type,
245 Method* method,
246 address entry_point,
247 intptr_t* parameters,
248 int size_of_parameters,
249 TRAPS
250 );
251
252 static CallStub call_stub() { return CAST_TO_FN_PTR(CallStub, _call_stub_entry); }
253
254 // Exceptions
255 static address forward_exception_entry() { return _forward_exception_entry; }
256 // Implicit exceptions
257 static address throw_AbstractMethodError_entry() { return _throw_AbstractMethodError_entry; }
258 static address throw_IncompatibleClassChangeError_entry(){ return _throw_IncompatibleClassChangeError_entry; }
259 static address throw_NullPointerException_at_call_entry(){ return _throw_NullPointerException_at_call_entry; }
260 static address throw_StackOverflowError_entry() { return _throw_StackOverflowError_entry; }
261 static address throw_delayed_StackOverflowError_entry() { return _throw_delayed_StackOverflowError_entry; }
262
263 static address atomic_xchg_entry() { return _atomic_xchg_entry; }
264 static address atomic_xchg_long_entry() { return _atomic_xchg_long_entry; }
265 static address atomic_store_entry() { return _atomic_store_entry; }
266 static address atomic_cmpxchg_entry() { return _atomic_cmpxchg_entry; }
267 static address atomic_cmpxchg_byte_entry() { return _atomic_cmpxchg_byte_entry; }
268 static address atomic_cmpxchg_long_entry() { return _atomic_cmpxchg_long_entry; }
269 static address atomic_add_entry() { return _atomic_add_entry; }
270 static address atomic_add_long_entry() { return _atomic_add_long_entry; }
271 static address fence_entry() { return _fence_entry; }
272
273 static address d2i_wrapper() { return _d2i_wrapper; }
274 static address d2l_wrapper() { return _d2l_wrapper; }
275 static jint fpu_cntrl_wrd_std() { return _fpu_cntrl_wrd_std; }
276 static address addr_fpu_cntrl_wrd_std() { return (address)&_fpu_cntrl_wrd_std; }
277 static address addr_fpu_cntrl_wrd_24() { return (address)&_fpu_cntrl_wrd_24; }
278 static address addr_fpu_cntrl_wrd_trunc() { return (address)&_fpu_cntrl_wrd_trunc; }
279 static address addr_mxcsr_std() { return (address)&_mxcsr_std; }
280 static address addr_fpu_subnormal_bias1() { return (address)&_fpu_subnormal_bias1; }
281 static address addr_fpu_subnormal_bias2() { return (address)&_fpu_subnormal_bias2; }
282
283
284 static address select_arraycopy_function(BasicType t, bool aligned, bool disjoint, const char* &name, bool dest_uninitialized);
285
286 static address jbyte_arraycopy() { return _jbyte_arraycopy; }
287 static address jshort_arraycopy() { return _jshort_arraycopy; }
288 static address jint_arraycopy() { return _jint_arraycopy; }
289 static address jlong_arraycopy() { return _jlong_arraycopy; }
290 static address oop_arraycopy(bool dest_uninitialized = false) {
291 return dest_uninitialized ? _oop_arraycopy_uninit : _oop_arraycopy;
292 }
293 static address jbyte_disjoint_arraycopy() { return _jbyte_disjoint_arraycopy; }
294 static address jshort_disjoint_arraycopy() { return _jshort_disjoint_arraycopy; }
295 static address jint_disjoint_arraycopy() { return _jint_disjoint_arraycopy; }
296 static address jlong_disjoint_arraycopy() { return _jlong_disjoint_arraycopy; }
297 static address oop_disjoint_arraycopy(bool dest_uninitialized = false) {
298 return dest_uninitialized ? _oop_disjoint_arraycopy_uninit : _oop_disjoint_arraycopy;
299 }
300
301 static address arrayof_jbyte_arraycopy() { return _arrayof_jbyte_arraycopy; }
302 static address arrayof_jshort_arraycopy() { return _arrayof_jshort_arraycopy; }
303 static address arrayof_jint_arraycopy() { return _arrayof_jint_arraycopy; }
304 static address arrayof_jlong_arraycopy() { return _arrayof_jlong_arraycopy; }
305 static address arrayof_oop_arraycopy(bool dest_uninitialized = false) {
306 return dest_uninitialized ? _arrayof_oop_arraycopy_uninit : _arrayof_oop_arraycopy;
307 }
308
309 static address arrayof_jbyte_disjoint_arraycopy() { return _arrayof_jbyte_disjoint_arraycopy; }
310 static address arrayof_jshort_disjoint_arraycopy() { return _arrayof_jshort_disjoint_arraycopy; }
311 static address arrayof_jint_disjoint_arraycopy() { return _arrayof_jint_disjoint_arraycopy; }
312 static address arrayof_jlong_disjoint_arraycopy() { return _arrayof_jlong_disjoint_arraycopy; }
313 static address arrayof_oop_disjoint_arraycopy(bool dest_uninitialized = false) {
314 return dest_uninitialized ? _arrayof_oop_disjoint_arraycopy_uninit : _arrayof_oop_disjoint_arraycopy;
315 }
316
317 static address checkcast_arraycopy(bool dest_uninitialized = false) {
318 return dest_uninitialized ? _checkcast_arraycopy_uninit : _checkcast_arraycopy;
319 }
320 static address unsafe_arraycopy() { return _unsafe_arraycopy; }
321 static address generic_arraycopy() { return _generic_arraycopy; }
322
323 static address jbyte_fill() { return _jbyte_fill; }
324 static address jshort_fill() { return _jshort_fill; }
325 static address jint_fill() { return _jint_fill; }
326 static address arrayof_jbyte_fill() { return _arrayof_jbyte_fill; }
327 static address arrayof_jshort_fill() { return _arrayof_jshort_fill; }
328 static address arrayof_jint_fill() { return _arrayof_jint_fill; }
329
330 static address aescrypt_encryptBlock() { return _aescrypt_encryptBlock; }
331 static address aescrypt_decryptBlock() { return _aescrypt_decryptBlock; }
332 static address cipherBlockChaining_encryptAESCrypt() { return _cipherBlockChaining_encryptAESCrypt; }
333 static address cipherBlockChaining_decryptAESCrypt() { return _cipherBlockChaining_decryptAESCrypt; }
334 static address counterMode_AESCrypt() { return _counterMode_AESCrypt; }
335 static address ghash_processBlocks() { return _ghash_processBlocks; }
336 static address base64_encodeBlock() { return _base64_encodeBlock; }
337 static address sha1_implCompress() { return _sha1_implCompress; }
338 static address sha1_implCompressMB() { return _sha1_implCompressMB; }
339 static address sha256_implCompress() { return _sha256_implCompress; }
340 static address sha256_implCompressMB() { return _sha256_implCompressMB; }
341 static address sha512_implCompress() { return _sha512_implCompress; }
342 static address sha512_implCompressMB() { return _sha512_implCompressMB; }
343
344 static address updateBytesCRC32() { return _updateBytesCRC32; }
345 static address crc_table_addr() { return _crc_table_adr; }
346
347 static address crc32c_table_addr() { return _crc32c_table_addr; }
348 static address updateBytesCRC32C() { return _updateBytesCRC32C; }
349 static address updateBytesAdler32() { return _updateBytesAdler32; }
350
351 static address multiplyToLen() { return _multiplyToLen; }
352 static address squareToLen() { return _squareToLen; }
353 static address mulAdd() { return _mulAdd; }
354 static address montgomeryMultiply() { return _montgomeryMultiply; }
355 static address montgomerySquare() { return _montgomerySquare; }
356
357 static address vectorizedMismatch() { return _vectorizedMismatch; }
358
359 static address dexp() { return _dexp; }
360 static address dlog() { return _dlog; }
361 static address dlog10() { return _dlog10; }
362 static address dpow() { return _dpow; }
363 static address dsin() { return _dsin; }
364 static address dcos() { return _dcos; }
365 static address dlibm_reduce_pi04l() { return _dlibm_reduce_pi04l; }
366 static address dlibm_sin_cos_huge() { return _dlibm_sin_cos_huge; }
367 static address dlibm_tan_cot_huge() { return _dlibm_tan_cot_huge; }
368 static address dtan() { return _dtan; }
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 //
375 // Safefetch stub support
376 //
377
378 typedef int (*SafeFetch32Stub)(int* adr, int errValue);
379 typedef intptr_t (*SafeFetchNStub) (intptr_t* adr, intptr_t errValue);
380
381 static SafeFetch32Stub SafeFetch32_stub() { return CAST_TO_FN_PTR(SafeFetch32Stub, _safefetch32_entry); }
382 static SafeFetchNStub SafeFetchN_stub() { return CAST_TO_FN_PTR(SafeFetchNStub, _safefetchN_entry); }
383
384 static bool is_safefetch_fault(address pc) {
385 return pc != NULL &&
386 (pc == _safefetch32_fault_pc ||
387 pc == _safefetchN_fault_pc);
388 }
389
390 static address continuation_for_safefetch_fault(address pc) {
391 assert(_safefetch32_continuation_pc != NULL &&
392 _safefetchN_continuation_pc != NULL,
393 "not initialized");
394
395 if (pc == _safefetch32_fault_pc) return _safefetch32_continuation_pc;
396 if (pc == _safefetchN_fault_pc) return _safefetchN_continuation_pc;
397
398 ShouldNotReachHere();
399 return NULL;
400 }
401
402 //
403 // Default versions of the above arraycopy functions for platforms which do
404 // not have specialized versions
405 //
406 static void jbyte_copy (jbyte* src, jbyte* dest, size_t count);
407 static void jshort_copy (jshort* src, jshort* dest, size_t count);
408 static void jint_copy (jint* src, jint* dest, size_t count);
409 static void jlong_copy (jlong* src, jlong* dest, size_t count);
410 static void oop_copy (oop* src, oop* dest, size_t count);
411 static void oop_copy_uninit(oop* src, oop* dest, size_t count);
412
413 static void arrayof_jbyte_copy (HeapWord* src, HeapWord* dest, size_t count);
414 static void arrayof_jshort_copy (HeapWord* src, HeapWord* dest, size_t count);
415 static void arrayof_jint_copy (HeapWord* src, HeapWord* dest, size_t count);
416 static void arrayof_jlong_copy (HeapWord* src, HeapWord* dest, size_t count);
417 static void arrayof_oop_copy (HeapWord* src, HeapWord* dest, size_t count);
418 static void arrayof_oop_copy_uninit(HeapWord* src, HeapWord* dest, size_t count);
419
420 static address load_value_type_fields_in_regs() { return _load_value_type_fields_in_regs; }
421 static address store_value_type_fields_to_buf() { return _store_value_type_fields_to_buf; }
422 };
423
424 // Safefetch allows to load a value from a location that's not known
425 // to be valid. If the load causes a fault, the error value is returned.
426 inline int SafeFetch32(int* adr, int errValue) {
427 assert(StubRoutines::SafeFetch32_stub(), "stub not yet generated");
428 return StubRoutines::SafeFetch32_stub()(adr, errValue);
429 }
430 inline intptr_t SafeFetchN(intptr_t* adr, intptr_t errValue) {
431 assert(StubRoutines::SafeFetchN_stub(), "stub not yet generated");
432 return StubRoutines::SafeFetchN_stub()(adr, errValue);
433 }
434
435
436 // returns true if SafeFetch32 and SafeFetchN can be used safely (stubroutines are already generated)
437 inline bool CanUseSafeFetch32() {
438 return StubRoutines::SafeFetch32_stub() ? true : false;
439 }
440
441 inline bool CanUseSafeFetchN() {
442 return StubRoutines::SafeFetchN_stub() ? true : false;
443 }
444 #endif // SHARE_RUNTIME_STUBROUTINES_HPP