1 /*
2  * Copyright (C) 2016 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_COMPILER_UTILS_X86_JNI_MACRO_ASSEMBLER_X86_H_
18 #define ART_COMPILER_UTILS_X86_JNI_MACRO_ASSEMBLER_X86_H_
19 
20 #include <vector>
21 
22 #include "assembler_x86.h"
23 #include "base/arena_containers.h"
24 #include "base/array_ref.h"
25 #include "base/enums.h"
26 #include "base/macros.h"
27 #include "offsets.h"
28 #include "utils/jni_macro_assembler.h"
29 
30 namespace art {
31 namespace x86 {
32 
33 class X86JNIMacroLabel;
34 
35 class X86JNIMacroAssembler final : public JNIMacroAssemblerFwd<X86Assembler, PointerSize::k32> {
36  public:
X86JNIMacroAssembler(ArenaAllocator * allocator)37   explicit X86JNIMacroAssembler(ArenaAllocator* allocator) : JNIMacroAssemblerFwd(allocator) {}
~X86JNIMacroAssembler()38   virtual ~X86JNIMacroAssembler() {}
39 
40   //
41   // Overridden common assembler high-level functionality
42   //
43 
44   // Emit code that will create an activation on the stack
45   void BuildFrame(size_t frame_size,
46                   ManagedRegister method_reg,
47                   ArrayRef<const ManagedRegister> callee_save_regs) override;
48 
49   // Emit code that will remove an activation from the stack
50   void RemoveFrame(size_t frame_size,
51                    ArrayRef<const ManagedRegister> callee_save_regs,
52                    bool may_suspend) override;
53 
54   void IncreaseFrameSize(size_t adjust) override;
55   void DecreaseFrameSize(size_t adjust) override;
56 
57   // Store routines
58   void Store(FrameOffset offs, ManagedRegister src, size_t size) override;
59   void StoreRef(FrameOffset dest, ManagedRegister src) override;
60   void StoreRawPtr(FrameOffset dest, ManagedRegister src) override;
61 
62   void StoreImmediateToFrame(FrameOffset dest, uint32_t imm) override;
63 
64   void StoreStackOffsetToThread(ThreadOffset32 thr_offs, FrameOffset fr_offs) override;
65 
66   void StoreStackPointerToThread(ThreadOffset32 thr_offs) override;
67 
68   void StoreSpanning(FrameOffset dest, ManagedRegister src, FrameOffset in_off) override;
69 
70   // Load routines
71   void Load(ManagedRegister dest, FrameOffset src, size_t size) override;
72 
73   void LoadFromThread(ManagedRegister dest, ThreadOffset32 src, size_t size) override;
74 
75   void LoadRef(ManagedRegister dest, FrameOffset src) override;
76 
77   void LoadRef(ManagedRegister dest, ManagedRegister base, MemberOffset offs,
78                bool unpoison_reference) override;
79 
80   void LoadRawPtr(ManagedRegister dest, ManagedRegister base, Offset offs) override;
81 
82   void LoadRawPtrFromThread(ManagedRegister dest, ThreadOffset32 offs) override;
83 
84   // Copying routines
85   void MoveArguments(ArrayRef<ArgumentLocation> dests, ArrayRef<ArgumentLocation> srcs) override;
86 
87   void Move(ManagedRegister dest, ManagedRegister src, size_t size) override;
88 
89   void CopyRawPtrFromThread(FrameOffset fr_offs, ThreadOffset32 thr_offs) override;
90 
91   void CopyRawPtrToThread(ThreadOffset32 thr_offs, FrameOffset fr_offs, ManagedRegister scratch)
92       override;
93 
94   void CopyRef(FrameOffset dest, FrameOffset src) override;
95   void CopyRef(FrameOffset dest,
96                ManagedRegister base,
97                MemberOffset offs,
98                bool unpoison_reference) override;
99 
100   void Copy(FrameOffset dest, FrameOffset src, size_t size) override;
101 
102   void Copy(FrameOffset dest, ManagedRegister src_base, Offset src_offset, ManagedRegister scratch,
103             size_t size) override;
104 
105   void Copy(ManagedRegister dest_base, Offset dest_offset, FrameOffset src, ManagedRegister scratch,
106             size_t size) override;
107 
108   void Copy(FrameOffset dest, FrameOffset src_base, Offset src_offset, ManagedRegister scratch,
109             size_t size) override;
110 
111   void Copy(ManagedRegister dest, Offset dest_offset, ManagedRegister src, Offset src_offset,
112             ManagedRegister scratch, size_t size) override;
113 
114   void Copy(FrameOffset dest, Offset dest_offset, FrameOffset src, Offset src_offset,
115             ManagedRegister scratch, size_t size) override;
116 
117   void MemoryBarrier(ManagedRegister) override;
118 
119   // Sign extension
120   void SignExtend(ManagedRegister mreg, size_t size) override;
121 
122   // Zero extension
123   void ZeroExtend(ManagedRegister mreg, size_t size) override;
124 
125   // Exploit fast access in managed code to Thread::Current()
126   void GetCurrentThread(ManagedRegister dest) override;
127   void GetCurrentThread(FrameOffset dest_offset) override;
128 
129   // Set up `out_reg` to hold a `jobject` (`StackReference<Object>*` to a spilled value),
130   // or to be null if the value is null and `null_allowed`. `in_reg` holds a possibly
131   // stale reference that can be used to avoid loading the spilled value to
132   // see if the value is null.
133   void CreateJObject(ManagedRegister out_reg,
134                      FrameOffset spilled_reference_offset,
135                      ManagedRegister in_reg,
136                      bool null_allowed) override;
137 
138   // Set up `out_off` to hold a `jobject` (`StackReference<Object>*` to a spilled value),
139   // or to be null if the value is null and `null_allowed`.
140   void CreateJObject(FrameOffset out_off,
141                      FrameOffset spilled_reference_offset,
142                      bool null_allowed) override;
143 
144   // Heap::VerifyObject on src. In some cases (such as a reference to this) we
145   // know that src may not be null.
146   void VerifyObject(ManagedRegister src, bool could_be_null) override;
147   void VerifyObject(FrameOffset src, bool could_be_null) override;
148 
149   // Jump to address held at [base+offset] (used for tail calls).
150   void Jump(ManagedRegister base, Offset offset) override;
151 
152   // Call to address held at [base+offset]
153   void Call(ManagedRegister base, Offset offset) override;
154   void Call(FrameOffset base, Offset offset) override;
155   void CallFromThread(ThreadOffset32 offset) override;
156 
157   // Generate code to check if Thread::Current()->exception_ is non-null
158   // and branch to a ExceptionSlowPath if it is.
159   void ExceptionPoll(size_t stack_adjust) override;
160 
161   // Create a new label that can be used with Jump/Bind calls.
162   std::unique_ptr<JNIMacroLabel> CreateLabel() override;
163   // Emit an unconditional jump to the label.
164   void Jump(JNIMacroLabel* label) override;
165   // Emit a conditional jump to the label by applying a unary condition test to the GC marking flag.
166   void TestGcMarking(JNIMacroLabel* label, JNIMacroUnaryCondition cond) override;
167   // Code at this offset will serve as the target for the Jump call.
168   void Bind(JNIMacroLabel* label) override;
169 
170  private:
171   DISALLOW_COPY_AND_ASSIGN(X86JNIMacroAssembler);
172 };
173 
174 class X86JNIMacroLabel final
175     : public JNIMacroLabelCommon<X86JNIMacroLabel,
176                                  art::Label,
177                                  InstructionSet::kX86> {
178  public:
AsX86()179   art::Label* AsX86() {
180     return AsPlatformLabel();
181   }
182 };
183 
184 }  // namespace x86
185 }  // namespace art
186 
187 #endif  // ART_COMPILER_UTILS_X86_JNI_MACRO_ASSEMBLER_X86_H_
188