1 /*
2 * Copyright (c) 1997, 2013, 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 #ifdef TARGET_ARCH_x86
35 # include "nativeInst_x86.hpp"
36 #endif
37 #ifdef TARGET_ARCH_sparc
38 # include "nativeInst_sparc.hpp"
39 #endif
40 #ifdef TARGET_ARCH_zero
41 # include "nativeInst_zero.hpp"
42 #endif
43 #ifdef TARGET_ARCH_arm
44 # include "nativeInst_arm.hpp"
45 #endif
46 #ifdef TARGET_ARCH_ppc
47 # include "nativeInst_ppc.hpp"
48 #endif
49
50 // StubRoutines provides entry points to assembly routines used by
51 // compiled code and the run-time system. Platform-specific entry
52 // points are defined in the platform-specific inner class.
53 //
54 // Class scheme:
55 //
56 // platform-independent platform-dependent
57 //
58 // stubRoutines.hpp <-- included -- stubRoutines_<arch>.hpp
59 // ^ ^
60 // | |
61 // implements implements
62 // | |
63 // | |
64 // stubRoutines.cpp stubRoutines_<arch>.cpp
65 // stubRoutines_<os_family>.cpp stubGenerator_<arch>.cpp
66 // stubRoutines_<os_arch>.cpp
67 //
68 // Note 1: The important thing is a clean decoupling between stub
69 // entry points (interfacing to the whole vm; i.e., 1-to-n
70 // relationship) and stub generators (interfacing only to
71 // the entry points implementation; i.e., 1-to-1 relationship).
72 // This significantly simplifies changes in the generator
73 // structure since the rest of the vm is not affected.
74 //
75 // Note 2: stubGenerator_<arch>.cpp contains a minimal portion of
76 // machine-independent code; namely the generator calls of
77 // the generator functions that are used platform-independently.
78 // However, it comes with the advantage of having a 1-file
79 // implementation of the generator. It should be fairly easy
80 // to change, should it become a problem later.
81 //
82 // Scheme for adding a new entry point:
83 //
84 // 1. determine if it's a platform-dependent or independent entry point
85 // a) if platform independent: make subsequent changes in the independent files
86 // b) if platform dependent: make subsequent changes in the dependent files
87 // 2. add a private instance variable holding the entry point address
88 // 3. add a public accessor function to the instance variable
89 // 4. implement the corresponding generator function in the platform-dependent
90 // stubGenerator_<arch>.cpp file and call the function in generate_all() of that file
91
92
93 class StubRoutines: AllStatic {
94
95 public:
96 enum platform_independent_constants {
97 max_size_of_parameters = 256 // max. parameter size supported by megamorphic lookups
98 };
99
100 // Dependencies
101 friend class StubGenerator;
102 #ifdef TARGET_ARCH_MODEL_x86_32
103 # include "stubRoutines_x86_32.hpp"
104 #endif
105 #ifdef TARGET_ARCH_MODEL_x86_64
106 # include "stubRoutines_x86_64.hpp"
107 #endif
108 #ifdef TARGET_ARCH_MODEL_sparc
109 # include "stubRoutines_sparc.hpp"
110 #endif
111 #ifdef TARGET_ARCH_MODEL_zero
112 # include "stubRoutines_zero.hpp"
113 #endif
114 #ifdef TARGET_ARCH_MODEL_arm
115 # include "stubRoutines_arm.hpp"
116 #endif
117 #ifdef TARGET_ARCH_MODEL_ppc
118 # include "stubRoutines_ppc.hpp"
119 #endif
120
121
122 static jint _verify_oop_count;
123 static address _verify_oop_subroutine_entry;
124
125 static address _call_stub_return_address; // the return PC, when returning to a call stub
126 static address _call_stub_entry;
127 static address _forward_exception_entry;
128 static address _catch_exception_entry;
129 static address _throw_AbstractMethodError_entry;
130 static address _throw_IncompatibleClassChangeError_entry;
131 static address _throw_NullPointerException_at_call_entry;
132 static address _throw_StackOverflowError_entry;
133 static address _handler_for_unsafe_access_entry;
134
135 static address _atomic_xchg_entry;
136 static address _atomic_xchg_ptr_entry;
137 static address _atomic_store_entry;
138 static address _atomic_store_ptr_entry;
139 static address _atomic_cmpxchg_entry;
140 static address _atomic_cmpxchg_ptr_entry;
141 static address _atomic_cmpxchg_long_entry;
142 static address _atomic_add_entry;
143 static address _atomic_add_ptr_entry;
144 static address _fence_entry;
145 static address _d2i_wrapper;
146 static address _d2l_wrapper;
147
148 static jint _fpu_cntrl_wrd_std;
149 static jint _fpu_cntrl_wrd_24;
150 static jint _fpu_cntrl_wrd_64;
151 static jint _fpu_cntrl_wrd_trunc;
152 static jint _mxcsr_std;
153 static jint _fpu_subnormal_bias1[3];
154 static jint _fpu_subnormal_bias2[3];
155
156 static BufferBlob* _code1; // code buffer for initial routines
157 static BufferBlob* _code2; // code buffer for all other routines
158
159 // Leaf routines which implement arraycopy and their addresses
160 // arraycopy operands aligned on element type boundary
161 static address _jbyte_arraycopy;
162 static address _jshort_arraycopy;
163 static address _jint_arraycopy;
164 static address _jlong_arraycopy;
165 static address _oop_arraycopy, _oop_arraycopy_uninit;
166 static address _jbyte_disjoint_arraycopy;
167 static address _jshort_disjoint_arraycopy;
168 static address _jint_disjoint_arraycopy;
169 static address _jlong_disjoint_arraycopy;
170 static address _oop_disjoint_arraycopy, _oop_disjoint_arraycopy_uninit;
171
172 // arraycopy operands aligned on zero'th element boundary
173 // These are identical to the ones aligned aligned on an
174 // element type boundary, except that they assume that both
175 // source and destination are HeapWord aligned.
176 static address _arrayof_jbyte_arraycopy;
177 static address _arrayof_jshort_arraycopy;
178 static address _arrayof_jint_arraycopy;
179 static address _arrayof_jlong_arraycopy;
180 static address _arrayof_oop_arraycopy, _arrayof_oop_arraycopy_uninit;
181 static address _arrayof_jbyte_disjoint_arraycopy;
182 static address _arrayof_jshort_disjoint_arraycopy;
183 static address _arrayof_jint_disjoint_arraycopy;
184 static address _arrayof_jlong_disjoint_arraycopy;
185 static address _arrayof_oop_disjoint_arraycopy, _arrayof_oop_disjoint_arraycopy_uninit;
186
187 // these are recommended but optional:
188 static address _checkcast_arraycopy, _checkcast_arraycopy_uninit;
189 static address _unsafe_arraycopy;
190 static address _generic_arraycopy;
191
192 static address _jbyte_fill;
193 static address _jshort_fill;
194 static address _jint_fill;
195 static address _arrayof_jbyte_fill;
196 static address _arrayof_jshort_fill;
197 static address _arrayof_jint_fill;
198
199 // zero heap space aligned to jlong (8 bytes)
200 static address _zero_aligned_words;
201
202 static address _aescrypt_encryptBlock;
203 static address _aescrypt_decryptBlock;
204 static address _cipherBlockChaining_encryptAESCrypt;
205 static address _cipherBlockChaining_decryptAESCrypt;
206
207 static address _updateBytesCRC32;
208 static address _crc_table_adr;
209
210 // These are versions of the java.lang.Math methods which perform
211 // the same operations as the intrinsic version. They are used for
212 // constant folding in the compiler to ensure equivalence. If the
213 // intrinsic version returns the same result as the strict version
214 // then they can be set to the appropriate function from
215 // SharedRuntime.
216 static double (*_intrinsic_log)(double);
217 static double (*_intrinsic_log10)(double);
218 static double (*_intrinsic_exp)(double);
219 static double (*_intrinsic_pow)(double, double);
220 static double (*_intrinsic_sin)(double);
221 static double (*_intrinsic_cos)(double);
222 static double (*_intrinsic_tan)(double);
223
224 public:
225 // Initialization/Testing
226 static void initialize1(); // must happen before universe::genesis
227 static void initialize2(); // must happen after universe::genesis
228
229 static bool is_stub_code(address addr) { return contains(addr); }
230
231 static bool contains(address addr) {
232 return
233 (_code1 != NULL && _code1->blob_contains(addr)) ||
234 (_code2 != NULL && _code2->blob_contains(addr)) ;
235 }
236
237 static CodeBlob* code1() { return _code1; }
238 static CodeBlob* code2() { return _code2; }
239
240 // Debugging
241 static jint verify_oop_count() { return _verify_oop_count; }
242 static jint* verify_oop_count_addr() { return &_verify_oop_count; }
243 // a subroutine for debugging the GC
244 static address verify_oop_subroutine_entry_address() { return (address)&_verify_oop_subroutine_entry; }
245
246 static address catch_exception_entry() { return _catch_exception_entry; }
247
248 // Calls to Java
249 typedef void (*CallStub)(
250 address link,
251 intptr_t* result,
252 BasicType result_type,
253 Method* method,
254 address entry_point,
255 intptr_t* parameters,
256 int size_of_parameters,
257 TRAPS
258 );
259
260 static CallStub call_stub() { return CAST_TO_FN_PTR(CallStub, _call_stub_entry); }
261
262 // Exceptions
263 static address forward_exception_entry() { return _forward_exception_entry; }
264 // Implicit exceptions
265 static address throw_AbstractMethodError_entry() { return _throw_AbstractMethodError_entry; }
266 static address throw_IncompatibleClassChangeError_entry(){ return _throw_IncompatibleClassChangeError_entry; }
267 static address throw_NullPointerException_at_call_entry(){ return _throw_NullPointerException_at_call_entry; }
268 static address throw_StackOverflowError_entry() { return _throw_StackOverflowError_entry; }
269
270 // Exceptions during unsafe access - should throw Java exception rather
271 // than crash.
272 static address handler_for_unsafe_access() { return _handler_for_unsafe_access_entry; }
273
274 static address atomic_xchg_entry() { return _atomic_xchg_entry; }
275 static address atomic_xchg_ptr_entry() { return _atomic_xchg_ptr_entry; }
276 static address atomic_store_entry() { return _atomic_store_entry; }
277 static address atomic_store_ptr_entry() { return _atomic_store_ptr_entry; }
278 static address atomic_cmpxchg_entry() { return _atomic_cmpxchg_entry; }
279 static address atomic_cmpxchg_ptr_entry() { return _atomic_cmpxchg_ptr_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 updateBytesCRC32() { return _updateBytesCRC32; }
349 static address crc_table_addr() { return _crc_table_adr; }
350
351 static address select_fill_function(BasicType t, bool aligned, const char* &name);
352
353 static address zero_aligned_words() { return _zero_aligned_words; }
354
355 static double intrinsic_log(double d) {
356 assert(_intrinsic_log != NULL, "must be defined");
357 return _intrinsic_log(d);
358 }
359 static double intrinsic_log10(double d) {
360 assert(_intrinsic_log != NULL, "must be defined");
361 return _intrinsic_log10(d);
362 }
363 static double intrinsic_exp(double d) {
364 assert(_intrinsic_exp != NULL, "must be defined");
365 return _intrinsic_exp(d);
366 }
367 static double intrinsic_pow(double d, double d2) {
368 assert(_intrinsic_pow != NULL, "must be defined");
369 return _intrinsic_pow(d, d2);
370 }
371 static double intrinsic_sin(double d) {
372 assert(_intrinsic_sin != NULL, "must be defined");
373 return _intrinsic_sin(d);
374 }
375 static double intrinsic_cos(double d) {
376 assert(_intrinsic_cos != NULL, "must be defined");
377 return _intrinsic_cos(d);
378 }
379 static double intrinsic_tan(double d) {
380 assert(_intrinsic_tan != NULL, "must be defined");
381 return _intrinsic_tan(d);
382 }
383
384 //
385 // Default versions of the above arraycopy functions for platforms which do
386 // not have specialized versions
387 //
388 static void jbyte_copy (jbyte* src, jbyte* dest, size_t count);
389 static void jshort_copy (jshort* src, jshort* dest, size_t count);
390 static void jint_copy (jint* src, jint* dest, size_t count);
391 static void jlong_copy (jlong* src, jlong* dest, size_t count);
392 static void oop_copy (oop* src, oop* dest, size_t count);
393 static void oop_copy_uninit(oop* src, oop* dest, size_t count);
394
395 static void arrayof_jbyte_copy (HeapWord* src, HeapWord* dest, size_t count);
396 static void arrayof_jshort_copy (HeapWord* src, HeapWord* dest, size_t count);
397 static void arrayof_jint_copy (HeapWord* src, HeapWord* dest, size_t count);
398 static void arrayof_jlong_copy (HeapWord* src, HeapWord* dest, size_t count);
399 static void arrayof_oop_copy (HeapWord* src, HeapWord* dest, size_t count);
400 static void arrayof_oop_copy_uninit(HeapWord* src, HeapWord* dest, size_t count);
401 };
402
403 #endif // SHARE_VM_RUNTIME_STUBROUTINES_HPP