1 /*
2  * Copyright (C) 2012 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef ART_RUNTIME_ENTRYPOINTS_QUICK_QUICK_ENTRYPOINTS_H_
18 #define ART_RUNTIME_ENTRYPOINTS_QUICK_QUICK_ENTRYPOINTS_H_
19 
20 #include <jni.h>
21 
22 #include "base/macros.h"
23 #include "base/mutex.h"
24 #include "deoptimization_kind.h"
25 #include "offsets.h"
26 
27 #define QUICK_ENTRYPOINT_OFFSET(ptr_size, x) \
28     Thread::QuickEntryPointOffset<ptr_size>(OFFSETOF_MEMBER(QuickEntryPoints, x))
29 
30 namespace art {
31 
32 namespace mirror {
33 class Array;
34 class Class;
35 template<class MirrorType> class CompressedReference;
36 class Object;
37 }  // namespace mirror
38 
39 class ArtMethod;
40 template<class MirrorType> class GcRoot;
41 class Thread;
42 
43 // Pointers to functions that are called by quick compiler generated code via thread-local storage.
44 struct PACKED(4) QuickEntryPoints {
45 #define ENTRYPOINT_ENUM(name, rettype, ...) rettype ( * p ## name )( __VA_ARGS__ );
46 #include "quick_entrypoints_list.h"
47   QUICK_ENTRYPOINT_LIST(ENTRYPOINT_ENUM)
48 #undef QUICK_ENTRYPOINT_LIST
49 #undef ENTRYPOINT_ENUM
50 };
51 
52 
53 // JNI entrypoints.
54 // TODO: NO_THREAD_SAFETY_ANALYSIS due to different control paths depending on fast JNI.
55 extern uint32_t JniMethodStart(Thread* self) NO_THREAD_SAFETY_ANALYSIS HOT_ATTR;
56 extern uint32_t JniMethodFastStart(Thread* self) NO_THREAD_SAFETY_ANALYSIS HOT_ATTR;
57 extern uint32_t JniMethodStartSynchronized(jobject to_lock, Thread* self)
58     NO_THREAD_SAFETY_ANALYSIS HOT_ATTR;
59 extern void JniMethodEnd(uint32_t saved_local_ref_cookie, Thread* self)
60     NO_THREAD_SAFETY_ANALYSIS HOT_ATTR;
61 extern void JniMethodFastEnd(uint32_t saved_local_ref_cookie, Thread* self)
62     NO_THREAD_SAFETY_ANALYSIS HOT_ATTR;
63 extern void JniMethodEndSynchronized(uint32_t saved_local_ref_cookie, jobject locked,
64                                      Thread* self)
65     NO_THREAD_SAFETY_ANALYSIS HOT_ATTR;
66 extern mirror::Object* JniMethodEndWithReference(jobject result, uint32_t saved_local_ref_cookie,
67                                                  Thread* self)
68     NO_THREAD_SAFETY_ANALYSIS HOT_ATTR;
69 extern mirror::Object* JniMethodFastEndWithReference(jobject result,
70                                                      uint32_t saved_local_ref_cookie,
71                                                      Thread* self)
72     NO_THREAD_SAFETY_ANALYSIS HOT_ATTR;
73 
74 
75 extern mirror::Object* JniMethodEndWithReferenceSynchronized(jobject result,
76                                                              uint32_t saved_local_ref_cookie,
77                                                              jobject locked, Thread* self)
78     NO_THREAD_SAFETY_ANALYSIS HOT_ATTR;
79 
80 extern void ReadBarrierJni(mirror::CompressedReference<mirror::Object>* handle_on_stack,
81                            Thread* self)
82     NO_THREAD_SAFETY_ANALYSIS HOT_ATTR;
83 
84 
85 // Read barrier entrypoints.
86 //
87 // Compilers for ARM, ARM64, MIPS, MIPS64 can insert a call to these
88 // functions directly.  For x86 and x86-64, compilers need a wrapper
89 // assembly function, to handle mismatch in ABI.
90 
91 // Mark the heap reference `obj`. This entry point is used by read
92 // barrier fast path implementations generated by the compiler to mark
93 // an object that is referenced by a field of a gray object.
94 extern "C" mirror::Object* artReadBarrierMark(mirror::Object* obj)
95     REQUIRES_SHARED(Locks::mutator_lock_) HOT_ATTR;
96 
97 // Read barrier entrypoint for heap references.
98 // This is the read barrier slow path for instance and static fields
99 // and reference type arrays.
100 extern "C" mirror::Object* artReadBarrierSlow(mirror::Object* ref,
101                                               mirror::Object* obj,
102                                               uint32_t offset)
103     REQUIRES_SHARED(Locks::mutator_lock_) HOT_ATTR;
104 
105 // Read barrier entrypoint for GC roots.
106 extern "C" mirror::Object* artReadBarrierForRootSlow(GcRoot<mirror::Object>* root)
107     REQUIRES_SHARED(Locks::mutator_lock_) HOT_ATTR;
108 
109 }  // namespace art
110 
111 #endif  // ART_RUNTIME_ENTRYPOINTS_QUICK_QUICK_ENTRYPOINTS_H_
112