stubRoutines.hpp revision 2073:b92c45f2bc75 
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#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
93class 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_ArithmeticException_entry;
132  static address _throw_NullPointerException_entry;
133  static address _throw_NullPointerException_at_call_entry;
134  static address _throw_StackOverflowError_entry;
135  static address _handler_for_unsafe_access_entry;
136
137  static address _atomic_xchg_entry;
138  static address _atomic_xchg_ptr_entry;
139  static address _atomic_store_entry;
140  static address _atomic_store_ptr_entry;
141  static address _atomic_cmpxchg_entry;
142  static address _atomic_cmpxchg_ptr_entry;
143  static address _atomic_cmpxchg_long_entry;
144  static address _atomic_add_entry;
145  static address _atomic_add_ptr_entry;
146  static address _fence_entry;
147  static address _d2i_wrapper;
148  static address _d2l_wrapper;
149
150  static jint    _fpu_cntrl_wrd_std;
151  static jint    _fpu_cntrl_wrd_24;
152  static jint    _fpu_cntrl_wrd_64;
153  static jint    _fpu_cntrl_wrd_trunc;
154  static jint    _mxcsr_std;
155  static jint    _fpu_subnormal_bias1[3];
156  static jint    _fpu_subnormal_bias2[3];
157
158  static BufferBlob* _code1;                               // code buffer for initial routines
159  static BufferBlob* _code2;                               // code buffer for all other routines
160
161  // Leaf routines which implement arraycopy and their addresses
162  // arraycopy operands aligned on element type boundary
163  static address _jbyte_arraycopy;
164  static address _jshort_arraycopy;
165  static address _jint_arraycopy;
166  static address _jlong_arraycopy;
167  static address _oop_arraycopy;
168  static address _jbyte_disjoint_arraycopy;
169  static address _jshort_disjoint_arraycopy;
170  static address _jint_disjoint_arraycopy;
171  static address _jlong_disjoint_arraycopy;
172  static address _oop_disjoint_arraycopy;
173
174  // arraycopy operands aligned on zero'th element boundary
175  // These are identical to the ones aligned aligned on an
176  // element type boundary, except that they assume that both
177  // source and destination are HeapWord aligned.
178  static address _arrayof_jbyte_arraycopy;
179  static address _arrayof_jshort_arraycopy;
180  static address _arrayof_jint_arraycopy;
181  static address _arrayof_jlong_arraycopy;
182  static address _arrayof_oop_arraycopy;
183  static address _arrayof_jbyte_disjoint_arraycopy;
184  static address _arrayof_jshort_disjoint_arraycopy;
185  static address _arrayof_jint_disjoint_arraycopy;
186  static address _arrayof_jlong_disjoint_arraycopy;
187  static address _arrayof_oop_disjoint_arraycopy;
188
189  // these are recommended but optional:
190  static address _checkcast_arraycopy;
191  static address _unsafe_arraycopy;
192  static address _generic_arraycopy;
193
194  static address _jbyte_fill;
195  static address _jshort_fill;
196  static address _jint_fill;
197  static address _arrayof_jbyte_fill;
198  static address _arrayof_jshort_fill;
199  static address _arrayof_jint_fill;
200
201  // These are versions of the java.lang.Math methods which perform
202  // the same operations as the intrinsic version.  They are used for
203  // constant folding in the compiler to ensure equivalence.  If the
204  // intrinsic version returns the same result as the strict version
205  // then they can be set to the appropriate function from
206  // SharedRuntime.
207  static double (*_intrinsic_log)(double);
208  static double (*_intrinsic_log10)(double);
209  static double (*_intrinsic_exp)(double);
210  static double (*_intrinsic_pow)(double, double);
211  static double (*_intrinsic_sin)(double);
212  static double (*_intrinsic_cos)(double);
213  static double (*_intrinsic_tan)(double);
214
215 public:
216  // Initialization/Testing
217  static void    initialize1();                            // must happen before universe::genesis
218  static void    initialize2();                            // must happen after  universe::genesis
219
220  static bool contains(address addr) {
221    return
222      (_code1 != NULL && _code1->blob_contains(addr)) ||
223      (_code2 != NULL && _code2->blob_contains(addr)) ;
224  }
225
226  // Debugging
227  static jint    verify_oop_count()                        { return _verify_oop_count; }
228  static jint*   verify_oop_count_addr()                   { return &_verify_oop_count; }
229  // a subroutine for debugging the GC
230  static address verify_oop_subroutine_entry_address()    { return (address)&_verify_oop_subroutine_entry; }
231
232  static address catch_exception_entry()                   { return _catch_exception_entry; }
233
234  // Calls to Java
235  typedef void (*CallStub)(
236    address   link,
237    intptr_t* result,
238    BasicType result_type,
239    methodOopDesc* method,
240    address   entry_point,
241    intptr_t* parameters,
242    int       size_of_parameters,
243    TRAPS
244  );
245
246  static CallStub call_stub()                              { return CAST_TO_FN_PTR(CallStub, _call_stub_entry); }
247
248  // Exceptions
249  static address forward_exception_entry()                 { return _forward_exception_entry; }
250  // Implicit exceptions
251  static address throw_AbstractMethodError_entry()         { return _throw_AbstractMethodError_entry; }
252  static address throw_IncompatibleClassChangeError_entry(){ return _throw_IncompatibleClassChangeError_entry; }
253  static address throw_ArithmeticException_entry()         { return _throw_ArithmeticException_entry; }
254  static address throw_NullPointerException_entry()        { return _throw_NullPointerException_entry; }
255  static address throw_NullPointerException_at_call_entry(){ return _throw_NullPointerException_at_call_entry; }
256  static address throw_StackOverflowError_entry()          { return _throw_StackOverflowError_entry; }
257
258  // Exceptions during unsafe access - should throw Java exception rather
259  // than crash.
260  static address handler_for_unsafe_access()               { return _handler_for_unsafe_access_entry; }
261
262  static address atomic_xchg_entry()                       { return _atomic_xchg_entry; }
263  static address atomic_xchg_ptr_entry()                   { return _atomic_xchg_ptr_entry; }
264  static address atomic_store_entry()                      { return _atomic_store_entry; }
265  static address atomic_store_ptr_entry()                  { return _atomic_store_ptr_entry; }
266  static address atomic_cmpxchg_entry()                    { return _atomic_cmpxchg_entry; }
267  static address atomic_cmpxchg_ptr_entry()                { return _atomic_cmpxchg_ptr_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_ptr_entry()                    { return _atomic_add_ptr_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_64()                   { return (address)&_fpu_cntrl_wrd_64;   }
279  static address addr_fpu_cntrl_wrd_trunc()                { return (address)&_fpu_cntrl_wrd_trunc; }
280  static address addr_mxcsr_std()                          { return (address)&_mxcsr_std; }
281  static address addr_fpu_subnormal_bias1()                { return (address)&_fpu_subnormal_bias1; }
282  static address addr_fpu_subnormal_bias2()                { return (address)&_fpu_subnormal_bias2; }
283
284
285  static address jbyte_arraycopy()  { return _jbyte_arraycopy; }
286  static address jshort_arraycopy() { return _jshort_arraycopy; }
287  static address jint_arraycopy()   { return _jint_arraycopy; }
288  static address jlong_arraycopy()  { return _jlong_arraycopy; }
289  static address oop_arraycopy()    { return _oop_arraycopy; }
290  static address jbyte_disjoint_arraycopy()  { return _jbyte_disjoint_arraycopy; }
291  static address jshort_disjoint_arraycopy() { return _jshort_disjoint_arraycopy; }
292  static address jint_disjoint_arraycopy()   { return _jint_disjoint_arraycopy; }
293  static address jlong_disjoint_arraycopy()  { return _jlong_disjoint_arraycopy; }
294  static address oop_disjoint_arraycopy()    { return _oop_disjoint_arraycopy; }
295
296  static address arrayof_jbyte_arraycopy()  { return _arrayof_jbyte_arraycopy; }
297  static address arrayof_jshort_arraycopy() { return _arrayof_jshort_arraycopy; }
298  static address arrayof_jint_arraycopy()   { return _arrayof_jint_arraycopy; }
299  static address arrayof_jlong_arraycopy()  { return _arrayof_jlong_arraycopy; }
300  static address arrayof_oop_arraycopy()    { return _arrayof_oop_arraycopy; }
301
302  static address arrayof_jbyte_disjoint_arraycopy()  { return _arrayof_jbyte_disjoint_arraycopy; }
303  static address arrayof_jshort_disjoint_arraycopy() { return _arrayof_jshort_disjoint_arraycopy; }
304  static address arrayof_jint_disjoint_arraycopy()   { return _arrayof_jint_disjoint_arraycopy; }
305  static address arrayof_jlong_disjoint_arraycopy()  { return _arrayof_jlong_disjoint_arraycopy; }
306  static address arrayof_oop_disjoint_arraycopy()    { return _arrayof_oop_disjoint_arraycopy; }
307
308  static address checkcast_arraycopy()     { return _checkcast_arraycopy; }
309  static address unsafe_arraycopy()        { return _unsafe_arraycopy; }
310  static address generic_arraycopy()       { return _generic_arraycopy; }
311
312  static address jbyte_fill()          { return _jbyte_fill; }
313  static address jshort_fill()         { return _jshort_fill; }
314  static address jint_fill()           { return _jint_fill; }
315  static address arrayof_jbyte_fill()  { return _arrayof_jbyte_fill; }
316  static address arrayof_jshort_fill() { return _arrayof_jshort_fill; }
317  static address arrayof_jint_fill()   { return _arrayof_jint_fill; }
318
319  static address select_fill_function(BasicType t, bool aligned, const char* &name);
320
321
322  static double  intrinsic_log(double d) {
323    assert(_intrinsic_log != NULL, "must be defined");
324    return _intrinsic_log(d);
325  }
326  static double  intrinsic_log10(double d) {
327    assert(_intrinsic_log != NULL, "must be defined");
328    return _intrinsic_log10(d);
329  }
330  static double  intrinsic_exp(double d) {
331    assert(_intrinsic_exp != NULL, "must be defined");
332    return _intrinsic_exp(d);
333  }
334  static double  intrinsic_pow(double d, double d2) {
335    assert(_intrinsic_pow != NULL, "must be defined");
336    return _intrinsic_pow(d, d2);
337  }
338  static double  intrinsic_sin(double d) {
339    assert(_intrinsic_sin != NULL, "must be defined");
340    return _intrinsic_sin(d);
341  }
342  static double  intrinsic_cos(double d) {
343    assert(_intrinsic_cos != NULL, "must be defined");
344    return _intrinsic_cos(d);
345  }
346  static double  intrinsic_tan(double d) {
347    assert(_intrinsic_tan != NULL, "must be defined");
348    return _intrinsic_tan(d);
349  }
350
351  //
352  // Default versions of the above arraycopy functions for platforms which do
353  // not have specialized versions
354  //
355  static void jbyte_copy (jbyte*  src, jbyte*  dest, size_t count);
356  static void jshort_copy(jshort* src, jshort* dest, size_t count);
357  static void jint_copy  (jint*   src, jint*   dest, size_t count);
358  static void jlong_copy (jlong*  src, jlong*  dest, size_t count);
359  static void oop_copy   (oop*    src, oop*    dest, size_t count);
360
361  static void arrayof_jbyte_copy (HeapWord* src, HeapWord* dest, size_t count);
362  static void arrayof_jshort_copy(HeapWord* src, HeapWord* dest, size_t count);
363  static void arrayof_jint_copy  (HeapWord* src, HeapWord* dest, size_t count);
364  static void arrayof_jlong_copy (HeapWord* src, HeapWord* dest, size_t count);
365  static void arrayof_oop_copy   (HeapWord* src, HeapWord* dest, size_t count);
366};
367
368#endif // SHARE_VM_RUNTIME_STUBROUTINES_HPP
369