1 /*
2  * Copyright (C) 2014 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 #include <stdint.h>
18 
19 #include "context_arm64.h"
20 
21 #include "base/bit_utils.h"
22 #include "base/bit_utils_iterator.h"
23 #include "quick/quick_method_frame_info.h"
24 #include "thread-current-inl.h"
25 
26 namespace art {
27 namespace arm64 {
28 
29 static constexpr uint64_t gZero = 0;
30 
Reset()31 void Arm64Context::Reset() {
32   std::fill_n(gprs_, arraysize(gprs_), nullptr);
33   std::fill_n(fprs_, arraysize(fprs_), nullptr);
34   gprs_[SP] = &sp_;
35   gprs_[kPC] = &pc_;
36   gprs_[X0] = &arg0_;
37   // Initialize registers with easy to spot debug values.
38   sp_ = Arm64Context::kBadGprBase + SP;
39   pc_ = Arm64Context::kBadGprBase + kPC;
40   arg0_ = 0;
41 }
42 
FillCalleeSaves(uint8_t * frame,const QuickMethodFrameInfo & frame_info)43 void Arm64Context::FillCalleeSaves(uint8_t* frame, const QuickMethodFrameInfo& frame_info) {
44   int spill_pos = 0;
45 
46   // Core registers come first, from the highest down to the lowest.
47   for (uint32_t core_reg : HighToLowBits(frame_info.CoreSpillMask())) {
48     gprs_[core_reg] = CalleeSaveAddress(frame, spill_pos, frame_info.FrameSizeInBytes());
49     ++spill_pos;
50   }
51   DCHECK_EQ(spill_pos, POPCOUNT(frame_info.CoreSpillMask()));
52 
53   // FP registers come second, from the highest down to the lowest.
54   for (uint32_t fp_reg : HighToLowBits(frame_info.FpSpillMask())) {
55     fprs_[fp_reg] = CalleeSaveAddress(frame, spill_pos, frame_info.FrameSizeInBytes());
56     ++spill_pos;
57   }
58   DCHECK_EQ(spill_pos, POPCOUNT(frame_info.CoreSpillMask()) + POPCOUNT(frame_info.FpSpillMask()));
59 }
60 
SetGPR(uint32_t reg,uintptr_t value)61 void Arm64Context::SetGPR(uint32_t reg, uintptr_t value) {
62   DCHECK_LT(reg, arraysize(gprs_));
63   // Note: we use kPC == XZR, so do not ensure that reg != XZR.
64   DCHECK(IsAccessibleGPR(reg));
65   DCHECK_NE(gprs_[reg], &gZero);  // Can't overwrite this static value since they are never reset.
66   *gprs_[reg] = value;
67 }
68 
SetFPR(uint32_t reg,uintptr_t value)69 void Arm64Context::SetFPR(uint32_t reg, uintptr_t value) {
70   DCHECK_LT(reg, static_cast<uint32_t>(kNumberOfDRegisters));
71   DCHECK(IsAccessibleFPR(reg));
72   DCHECK_NE(fprs_[reg], &gZero);  // Can't overwrite this static value since they are never reset.
73   *fprs_[reg] = value;
74 }
75 
SmashCallerSaves()76 void Arm64Context::SmashCallerSaves() {
77   // This needs to be 0 because we want a null/zero return value.
78   gprs_[X0] = const_cast<uint64_t*>(&gZero);
79   gprs_[X1] = nullptr;
80   gprs_[X2] = nullptr;
81   gprs_[X3] = nullptr;
82   gprs_[X4] = nullptr;
83   gprs_[X5] = nullptr;
84   gprs_[X6] = nullptr;
85   gprs_[X7] = nullptr;
86   gprs_[X8] = nullptr;
87   gprs_[X9] = nullptr;
88   gprs_[X10] = nullptr;
89   gprs_[X11] = nullptr;
90   gprs_[X12] = nullptr;
91   gprs_[X13] = nullptr;
92   gprs_[X14] = nullptr;
93   gprs_[X15] = nullptr;
94   gprs_[X18] = nullptr;
95 
96   // d0-d7, d16-d31 are caller-saved; d8-d15 are callee-saved.
97 
98   fprs_[D0] = nullptr;
99   fprs_[D1] = nullptr;
100   fprs_[D2] = nullptr;
101   fprs_[D3] = nullptr;
102   fprs_[D4] = nullptr;
103   fprs_[D5] = nullptr;
104   fprs_[D6] = nullptr;
105   fprs_[D7] = nullptr;
106 
107   fprs_[D16] = nullptr;
108   fprs_[D17] = nullptr;
109   fprs_[D18] = nullptr;
110   fprs_[D19] = nullptr;
111   fprs_[D20] = nullptr;
112   fprs_[D21] = nullptr;
113   fprs_[D22] = nullptr;
114   fprs_[D23] = nullptr;
115   fprs_[D24] = nullptr;
116   fprs_[D25] = nullptr;
117   fprs_[D26] = nullptr;
118   fprs_[D27] = nullptr;
119   fprs_[D28] = nullptr;
120   fprs_[D29] = nullptr;
121   fprs_[D30] = nullptr;
122   fprs_[D31] = nullptr;
123 }
124 
125 extern "C" NO_RETURN void art_quick_do_long_jump(uint64_t*, uint64_t*);
126 
DoLongJump()127 void Arm64Context::DoLongJump() {
128   uint64_t gprs[arraysize(gprs_)];
129   uint64_t fprs[kNumberOfDRegisters];
130 
131   // The long jump routine called below expects to find the value for SP at index 31.
132   DCHECK_EQ(SP, 31);
133 
134   for (size_t i = 0; i < arraysize(gprs_); ++i) {
135     gprs[i] = gprs_[i] != nullptr ? *gprs_[i] : Arm64Context::kBadGprBase + i;
136   }
137   for (size_t i = 0; i < kNumberOfDRegisters; ++i) {
138     fprs[i] = fprs_[i] != nullptr ? *fprs_[i] : Arm64Context::kBadFprBase + i;
139   }
140   // Ensure the Thread Register contains the address of the current thread.
141   DCHECK_EQ(reinterpret_cast<uintptr_t>(Thread::Current()), gprs[TR]);
142   // The Marking Register will be updated by art_quick_do_long_jump.
143   art_quick_do_long_jump(gprs, fprs);
144 }
145 
146 }  // namespace arm64
147 }  // namespace art
148