1 /*
2 * Copyright (c) 1997, 2010, 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
44 // StubRoutines provides entry points to assembly routines used by
45 // compiled code and the run-time system. Platform-specific entry
46 // points are defined in the platform-specific inner class.
47 //
48 // Class scheme:
49 //
50 // platform-independent platform-dependent
51 //
52 // stubRoutines.hpp <-- included -- stubRoutines_<arch>.hpp
53 // ^ ^
54 // | |
55 // implements implements
56 // | |
57 // | |
58 // stubRoutines.cpp stubRoutines_<arch>.cpp
59 // stubRoutines_<os_family>.cpp stubGenerator_<arch>.cpp
60 // stubRoutines_<os_arch>.cpp
61 //
62 // Note 1: The important thing is a clean decoupling between stub
63 // entry points (interfacing to the whole vm; i.e., 1-to-n
64 // relationship) and stub generators (interfacing only to
65 // the entry points implementation; i.e., 1-to-1 relationship).
66 // This significantly simplifies changes in the generator
67 // structure since the rest of the vm is not affected.
68 //
69 // Note 2: stubGenerator_<arch>.cpp contains a minimal portion of
70 // machine-independent code; namely the generator calls of
71 // the generator functions that are used platform-independently.
72 // However, it comes with the advantage of having a 1-file
73 // implementation of the generator. It should be fairly easy
74 // to change, should it become a problem later.
75 //
76 // Scheme for adding a new entry point:
77 //
78 // 1. determine if it's a platform-dependent or independent entry point
79 // a) if platform independent: make subsequent changes in the independent files
80 // b) if platform dependent: make subsequent changes in the dependent files
81 // 2. add a private instance variable holding the entry point address
82 // 3. add a public accessor function to the instance variable
83 // 4. implement the corresponding generator function in the platform-dependent
84 // stubGenerator_<arch>.cpp file and call the function in generate_all() of that file
85
86
87 class StubRoutines: AllStatic {
88
89 public:
90 enum platform_independent_constants {
91 max_size_of_parameters = 256 // max. parameter size supported by megamorphic lookups
92 };
93
94 // Dependencies
95 friend class StubGenerator;
96 #ifdef TARGET_ARCH_MODEL_x86_32
97 # include "stubRoutines_x86_32.hpp"
98 #endif
99 #ifdef TARGET_ARCH_MODEL_x86_64
100 # include "stubRoutines_x86_64.hpp"
101 #endif
102 #ifdef TARGET_ARCH_MODEL_sparc
103 # include "stubRoutines_sparc.hpp"
104 #endif
105 #ifdef TARGET_ARCH_MODEL_zero
106 # include "stubRoutines_zero.hpp"
107 #endif
108
109
110 static jint _verify_oop_count;
111 static address _verify_oop_subroutine_entry;
112
113 static address _call_stub_return_address; // the return PC, when returning to a call stub
114 static address _call_stub_entry;
115 static address _forward_exception_entry;
116 static address _catch_exception_entry;
117 static address _throw_AbstractMethodError_entry;
118 static address _throw_IncompatibleClassChangeError_entry;
119 static address _throw_ArithmeticException_entry;
120 static address _throw_NullPointerException_entry;
121 static address _throw_NullPointerException_at_call_entry;
122 static address _throw_StackOverflowError_entry;
123 static address _handler_for_unsafe_access_entry;
124
125 static address _atomic_xchg_entry;
126 static address _atomic_xchg_ptr_entry;
127 static address _atomic_store_entry;
128 static address _atomic_store_ptr_entry;
129 static address _atomic_cmpxchg_entry;
130 static address _atomic_cmpxchg_ptr_entry;
131 static address _atomic_cmpxchg_long_entry;
132 static address _atomic_add_entry;
133 static address _atomic_add_ptr_entry;
134 static address _fence_entry;
135 static address _d2i_wrapper;
136 static address _d2l_wrapper;
137
138 static jint _fpu_cntrl_wrd_std;
139 static jint _fpu_cntrl_wrd_24;
140 static jint _fpu_cntrl_wrd_64;
141 static jint _fpu_cntrl_wrd_trunc;
142 static jint _mxcsr_std;
143 static jint _fpu_subnormal_bias1[3];
144 static jint _fpu_subnormal_bias2[3];
145
146 static BufferBlob* _code1; // code buffer for initial routines
147 static BufferBlob* _code2; // code buffer for all other routines
148
149 // Leaf routines which implement arraycopy and their addresses
150 // arraycopy operands aligned on element type boundary
151 static address _jbyte_arraycopy;
152 static address _jshort_arraycopy;
153 static address _jint_arraycopy;
154 static address _jlong_arraycopy;
155 static address _oop_arraycopy;
156 static address _jbyte_disjoint_arraycopy;
157 static address _jshort_disjoint_arraycopy;
158 static address _jint_disjoint_arraycopy;
159 static address _jlong_disjoint_arraycopy;
160 static address _oop_disjoint_arraycopy;
161
162 // arraycopy operands aligned on zero'th element boundary
163 // These are identical to the ones aligned aligned on an
164 // element type boundary, except that they assume that both
165 // source and destination are HeapWord aligned.
166 static address _arrayof_jbyte_arraycopy;
167 static address _arrayof_jshort_arraycopy;
168 static address _arrayof_jint_arraycopy;
169 static address _arrayof_jlong_arraycopy;
170 static address _arrayof_oop_arraycopy;
171 static address _arrayof_jbyte_disjoint_arraycopy;
172 static address _arrayof_jshort_disjoint_arraycopy;
173 static address _arrayof_jint_disjoint_arraycopy;
174 static address _arrayof_jlong_disjoint_arraycopy;
175 static address _arrayof_oop_disjoint_arraycopy;
176
177 // these are recommended but optional:
178 static address _checkcast_arraycopy;
179 static address _unsafe_arraycopy;
180 static address _generic_arraycopy;
181
182 static address _jbyte_fill;
183 static address _jshort_fill;
184 static address _jint_fill;
185 static address _arrayof_jbyte_fill;
186 static address _arrayof_jshort_fill;
187 static address _arrayof_jint_fill;
188
189 // These are versions of the java.lang.Math methods which perform
190 // the same operations as the intrinsic version. They are used for
191 // constant folding in the compiler to ensure equivalence. If the
192 // intrinsic version returns the same result as the strict version
193 // then they can be set to the appropriate function from
194 // SharedRuntime.
195 static double (*_intrinsic_log)(double);
196 static double (*_intrinsic_log10)(double);
197 static double (*_intrinsic_exp)(double);
198 static double (*_intrinsic_pow)(double, double);
199 static double (*_intrinsic_sin)(double);
200 static double (*_intrinsic_cos)(double);
201 static double (*_intrinsic_tan)(double);
202
203 public:
204 // Initialization/Testing
205 static void initialize1(); // must happen before universe::genesis
206 static void initialize2(); // must happen after universe::genesis
207
208 static bool contains(address addr) {
209 return
210 (_code1 != NULL && _code1->blob_contains(addr)) ||
211 (_code2 != NULL && _code2->blob_contains(addr)) ;
212 }
213
214 // Debugging
215 static jint verify_oop_count() { return _verify_oop_count; }
216 static jint* verify_oop_count_addr() { return &_verify_oop_count; }
217 // a subroutine for debugging the GC
218 static address verify_oop_subroutine_entry_address() { return (address)&_verify_oop_subroutine_entry; }
219
220 static address catch_exception_entry() { return _catch_exception_entry; }
221
222 // Calls to Java
223 typedef void (*CallStub)(
224 address link,
225 intptr_t* result,
226 BasicType result_type,
227 methodOopDesc* method,
228 address entry_point,
229 intptr_t* parameters,
230 int size_of_parameters,
231 TRAPS
232 );
233
234 static CallStub call_stub() { return CAST_TO_FN_PTR(CallStub, _call_stub_entry); }
235
236 // Exceptions
237 static address forward_exception_entry() { return _forward_exception_entry; }
238 // Implicit exceptions
239 static address throw_AbstractMethodError_entry() { return _throw_AbstractMethodError_entry; }
240 static address throw_IncompatibleClassChangeError_entry(){ return _throw_IncompatibleClassChangeError_entry; }
241 static address throw_ArithmeticException_entry() { return _throw_ArithmeticException_entry; }
242 static address throw_NullPointerException_entry() { return _throw_NullPointerException_entry; }
243 static address throw_NullPointerException_at_call_entry(){ return _throw_NullPointerException_at_call_entry; }
244 static address throw_StackOverflowError_entry() { return _throw_StackOverflowError_entry; }
245
246 // Exceptions during unsafe access - should throw Java exception rather
247 // than crash.
248 static address handler_for_unsafe_access() { return _handler_for_unsafe_access_entry; }
249
250 static address atomic_xchg_entry() { return _atomic_xchg_entry; }
251 static address atomic_xchg_ptr_entry() { return _atomic_xchg_ptr_entry; }
252 static address atomic_store_entry() { return _atomic_store_entry; }
253 static address atomic_store_ptr_entry() { return _atomic_store_ptr_entry; }
254 static address atomic_cmpxchg_entry() { return _atomic_cmpxchg_entry; }
255 static address atomic_cmpxchg_ptr_entry() { return _atomic_cmpxchg_ptr_entry; }
256 static address atomic_cmpxchg_long_entry() { return _atomic_cmpxchg_long_entry; }
257 static address atomic_add_entry() { return _atomic_add_entry; }
258 static address atomic_add_ptr_entry() { return _atomic_add_ptr_entry; }
259 static address fence_entry() { return _fence_entry; }
260
261 static address d2i_wrapper() { return _d2i_wrapper; }
262 static address d2l_wrapper() { return _d2l_wrapper; }
263 static jint fpu_cntrl_wrd_std() { return _fpu_cntrl_wrd_std; }
264 static address addr_fpu_cntrl_wrd_std() { return (address)&_fpu_cntrl_wrd_std; }
265 static address addr_fpu_cntrl_wrd_24() { return (address)&_fpu_cntrl_wrd_24; }
266 static address addr_fpu_cntrl_wrd_64() { return (address)&_fpu_cntrl_wrd_64; }
267 static address addr_fpu_cntrl_wrd_trunc() { return (address)&_fpu_cntrl_wrd_trunc; }
268 static address addr_mxcsr_std() { return (address)&_mxcsr_std; }
269 static address addr_fpu_subnormal_bias1() { return (address)&_fpu_subnormal_bias1; }
270 static address addr_fpu_subnormal_bias2() { return (address)&_fpu_subnormal_bias2; }
271
272
273 static address jbyte_arraycopy() { return _jbyte_arraycopy; }
274 static address jshort_arraycopy() { return _jshort_arraycopy; }
275 static address jint_arraycopy() { return _jint_arraycopy; }
276 static address jlong_arraycopy() { return _jlong_arraycopy; }
277 static address oop_arraycopy() { return _oop_arraycopy; }
278 static address jbyte_disjoint_arraycopy() { return _jbyte_disjoint_arraycopy; }
279 static address jshort_disjoint_arraycopy() { return _jshort_disjoint_arraycopy; }
280 static address jint_disjoint_arraycopy() { return _jint_disjoint_arraycopy; }
281 static address jlong_disjoint_arraycopy() { return _jlong_disjoint_arraycopy; }
282 static address oop_disjoint_arraycopy() { return _oop_disjoint_arraycopy; }
283
284 static address arrayof_jbyte_arraycopy() { return _arrayof_jbyte_arraycopy; }
285 static address arrayof_jshort_arraycopy() { return _arrayof_jshort_arraycopy; }
286 static address arrayof_jint_arraycopy() { return _arrayof_jint_arraycopy; }
287 static address arrayof_jlong_arraycopy() { return _arrayof_jlong_arraycopy; }
288 static address arrayof_oop_arraycopy() { return _arrayof_oop_arraycopy; }
289
290 static address arrayof_jbyte_disjoint_arraycopy() { return _arrayof_jbyte_disjoint_arraycopy; }
291 static address arrayof_jshort_disjoint_arraycopy() { return _arrayof_jshort_disjoint_arraycopy; }
292 static address arrayof_jint_disjoint_arraycopy() { return _arrayof_jint_disjoint_arraycopy; }
293 static address arrayof_jlong_disjoint_arraycopy() { return _arrayof_jlong_disjoint_arraycopy; }
294 static address arrayof_oop_disjoint_arraycopy() { return _arrayof_oop_disjoint_arraycopy; }
295
296 static address checkcast_arraycopy() { return _checkcast_arraycopy; }
297 static address unsafe_arraycopy() { return _unsafe_arraycopy; }
298 static address generic_arraycopy() { return _generic_arraycopy; }
299
300 static address jbyte_fill() { return _jbyte_fill; }
301 static address jshort_fill() { return _jshort_fill; }
302 static address jint_fill() { return _jint_fill; }
303 static address arrayof_jbyte_fill() { return _arrayof_jbyte_fill; }
304 static address arrayof_jshort_fill() { return _arrayof_jshort_fill; }
305 static address arrayof_jint_fill() { return _arrayof_jint_fill; }
306
307 static address select_fill_function(BasicType t, bool aligned, const char* &name);
308
309
310 static double intrinsic_log(double d) {
311 assert(_intrinsic_log != NULL, "must be defined");
312 return _intrinsic_log(d);
313 }
314 static double intrinsic_log10(double d) {
315 assert(_intrinsic_log != NULL, "must be defined");
316 return _intrinsic_log10(d);
317 }
318 static double intrinsic_exp(double d) {
319 assert(_intrinsic_exp != NULL, "must be defined");
320 return _intrinsic_exp(d);
321 }
322 static double intrinsic_pow(double d, double d2) {
323 assert(_intrinsic_pow != NULL, "must be defined");
324 return _intrinsic_pow(d, d2);
325 }
326 static double intrinsic_sin(double d) {
327 assert(_intrinsic_sin != NULL, "must be defined");
328 return _intrinsic_sin(d);
329 }
330 static double intrinsic_cos(double d) {
331 assert(_intrinsic_cos != NULL, "must be defined");
332 return _intrinsic_cos(d);
333 }
334 static double intrinsic_tan(double d) {
335 assert(_intrinsic_tan != NULL, "must be defined");
336 return _intrinsic_tan(d);
337 }
338
339 //
340 // Default versions of the above arraycopy functions for platforms which do
341 // not have specialized versions
342 //
343 static void jbyte_copy (jbyte* src, jbyte* dest, size_t count);
344 static void jshort_copy(jshort* src, jshort* dest, size_t count);
345 static void jint_copy (jint* src, jint* dest, size_t count);
346 static void jlong_copy (jlong* src, jlong* dest, size_t count);
347 static void oop_copy (oop* src, oop* dest, size_t count);
348
349 static void arrayof_jbyte_copy (HeapWord* src, HeapWord* dest, size_t count);
350 static void arrayof_jshort_copy(HeapWord* src, HeapWord* dest, size_t count);
351 static void arrayof_jint_copy (HeapWord* src, HeapWord* dest, size_t count);
352 static void arrayof_jlong_copy (HeapWord* src, HeapWord* dest, size_t count);
353 static void arrayof_oop_copy (HeapWord* src, HeapWord* dest, size_t count);
354 };
355
356 #endif // SHARE_VM_RUNTIME_STUBROUTINES_HPP