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/locks.h"
23 #include "base/macros.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 class String;
38 }  // namespace mirror
39 
40 class ArtMethod;
41 template<class MirrorType> class GcRoot;
42 template<class MirrorType> class StackReference;
43 class Thread;
44 
45 // Pointers to functions that are called by quick compiler generated code via thread-local storage.
46 struct PACKED(4) QuickEntryPoints {
47 #define ENTRYPOINT_ENUM(name, rettype, ...) rettype ( * p ## name )( __VA_ARGS__ );
48 #include "quick_entrypoints_list.h"
49   QUICK_ENTRYPOINT_LIST(ENTRYPOINT_ENUM)
50 #undef QUICK_ENTRYPOINT_LIST
51 #undef ENTRYPOINT_ENUM
52 };
53 
54 
55 // JNI entrypoints.
56 // TODO: NO_THREAD_SAFETY_ANALYSIS due to different control paths depending on fast JNI.
57 extern uint32_t JniMethodStart(Thread* self) NO_THREAD_SAFETY_ANALYSIS HOT_ATTR;
58 extern uint32_t JniMethodFastStart(Thread* self) NO_THREAD_SAFETY_ANALYSIS HOT_ATTR;
59 extern uint32_t JniMethodStartSynchronized(jobject to_lock, Thread* self)
60     NO_THREAD_SAFETY_ANALYSIS HOT_ATTR;
61 extern void JniMethodEnd(uint32_t saved_local_ref_cookie, Thread* self)
62     NO_THREAD_SAFETY_ANALYSIS HOT_ATTR;
63 extern void JniMethodFastEnd(uint32_t saved_local_ref_cookie, Thread* self)
64     NO_THREAD_SAFETY_ANALYSIS HOT_ATTR;
65 extern void JniMethodEndSynchronized(uint32_t saved_local_ref_cookie, jobject locked,
66                                      Thread* self)
67     NO_THREAD_SAFETY_ANALYSIS HOT_ATTR;
68 extern mirror::Object* JniMethodEndWithReference(jobject result, uint32_t saved_local_ref_cookie,
69                                                  Thread* self)
70     NO_THREAD_SAFETY_ANALYSIS HOT_ATTR;
71 extern mirror::Object* JniMethodFastEndWithReference(jobject result,
72                                                      uint32_t saved_local_ref_cookie,
73                                                      Thread* self)
74     NO_THREAD_SAFETY_ANALYSIS HOT_ATTR;
75 
76 
77 extern mirror::Object* JniMethodEndWithReferenceSynchronized(jobject result,
78                                                              uint32_t saved_local_ref_cookie,
79                                                              jobject locked, Thread* self)
80     NO_THREAD_SAFETY_ANALYSIS HOT_ATTR;
81 
82 extern "C" mirror::String* artStringBuilderAppend(uint32_t format,
83                                                   const uint32_t* args,
84                                                   Thread* self)
85     REQUIRES_SHARED(Locks::mutator_lock_) HOT_ATTR;
86 
87 extern void ReadBarrierJni(mirror::CompressedReference<mirror::Object>* handle_on_stack,
88                            Thread* self)
89     NO_THREAD_SAFETY_ANALYSIS HOT_ATTR;
90 
91 
92 // Read barrier entrypoints.
93 //
94 // Compilers for ARM, ARM64 can insert a call to these
95 // functions directly.  For x86 and x86-64, compilers need a wrapper
96 // assembly function, to handle mismatch in ABI.
97 
98 // Mark the heap reference `obj`. This entry point is used by read
99 // barrier fast path implementations generated by the compiler to mark
100 // an object that is referenced by a field of a gray object.
101 extern "C" mirror::Object* artReadBarrierMark(mirror::Object* obj)
102     REQUIRES_SHARED(Locks::mutator_lock_) HOT_ATTR;
103 
104 // Read barrier entrypoint for heap references.
105 // This is the read barrier slow path for instance and static fields
106 // and reference type arrays.
107 extern "C" mirror::Object* artReadBarrierSlow(mirror::Object* ref,
108                                               mirror::Object* obj,
109                                               uint32_t offset)
110     REQUIRES_SHARED(Locks::mutator_lock_) HOT_ATTR;
111 
112 // Read barrier entrypoint for GC roots.
113 extern "C" mirror::Object* artReadBarrierForRootSlow(GcRoot<mirror::Object>* root)
114     REQUIRES_SHARED(Locks::mutator_lock_) HOT_ATTR;
115 
116 }  // namespace art
117 
118 #endif  // ART_RUNTIME_ENTRYPOINTS_QUICK_QUICK_ENTRYPOINTS_H_
119