xref: /aosp_15_r20/system/unwinding/libunwindstack/include/unwindstack/RegsArm64.h (revision eb293b8f56ee8303637c5595cfcdeef8039e85c6)
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 #pragma once
18 
19 #include <stdint.h>
20 
21 #include <functional>
22 
23 #include <unwindstack/Elf.h>
24 #include <unwindstack/MachineArm64.h>
25 #include <unwindstack/Regs.h>
26 
27 namespace unwindstack {
28 
29 // Forward declarations.
30 class Memory;
31 
32 class RegsArm64 : public RegsImpl<uint64_t> {
33  public:
34   RegsArm64();
35   virtual ~RegsArm64() = default;
36 
37   ArchEnum Arch() override final;
38 
39   bool SetPcFromReturnAddress(Memory* process_memory) override;
40 
41   bool StepIfSignalHandler(uint64_t elf_offset, Elf* elf, Memory* process_memory) override;
42 
43   void IterateRegisters(std::function<void(const char*, uint64_t)>) override final;
44 
45   uint64_t pc() override;
46   uint64_t sp() override;
47 
48   void set_pc(uint64_t pc) override;
49   void set_sp(uint64_t sp) override;
50 
51   void fallback_pc() override;
52 
53   void ResetPseudoRegisters() override;
54 
55   bool SetPseudoRegister(uint16_t id, uint64_t value) override;
56 
57   bool GetPseudoRegister(uint16_t id, uint64_t* value) override;
58 
59   bool IsRASigned();
60 
61   void SetPACMask(uint64_t mask);
62 
63   Regs* Clone() override final;
64 
65   static Regs* Read(const void* data);
66 
67   static Regs* CreateFromUcontext(void* ucontext);
68 
69  protected:
70   uint64_t pseudo_regs_[Arm64Reg::ARM64_PREG_LAST - Arm64Reg::ARM64_PREG_FIRST];
71   uint64_t pac_mask_;
72 };
73 
74 }  // namespace unwindstack
75