1 //===-- NativeRegisterContextLinux_arm64.h ---------------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #if defined(__arm64__) || defined(__aarch64__)
10 
11 #ifndef lldb_NativeRegisterContextLinux_arm64_h
12 #define lldb_NativeRegisterContextLinux_arm64_h
13 
14 #include "Plugins/Process/Linux/NativeRegisterContextLinux.h"
15 #include "Plugins/Process/Utility/NativeRegisterContextDBReg_arm64.h"
16 #include "Plugins/Process/Utility/RegisterInfoPOSIX_arm64.h"
17 
18 #include <asm/ptrace.h>
19 
20 namespace lldb_private {
21 namespace process_linux {
22 
23 class NativeProcessLinux;
24 
25 class NativeRegisterContextLinux_arm64
26     : public NativeRegisterContextLinux,
27       public NativeRegisterContextDBReg_arm64 {
28 public:
29   NativeRegisterContextLinux_arm64(const ArchSpec &target_arch,
30                                    NativeThreadProtocol &native_thread);
31 
32   uint32_t GetRegisterSetCount() const override;
33 
34   uint32_t GetUserRegisterCount() const override;
35 
36   const RegisterSet *GetRegisterSet(uint32_t set_index) const override;
37 
38   Status ReadRegister(const RegisterInfo *reg_info,
39                       RegisterValue &reg_value) override;
40 
41   Status WriteRegister(const RegisterInfo *reg_info,
42                        const RegisterValue &reg_value) override;
43 
44   Status ReadAllRegisterValues(lldb::DataBufferSP &data_sp) override;
45 
46   Status WriteAllRegisterValues(const lldb::DataBufferSP &data_sp) override;
47 
48   void InvalidateAllRegisters() override;
49 
50   std::vector<uint32_t>
51   GetExpeditedRegisters(ExpeditedRegs expType) const override;
52 
53   bool RegisterOffsetIsDynamic() const override { return true; }
54 
55 protected:
56   Status ReadGPR() override;
57 
58   Status WriteGPR() override;
59 
60   Status ReadFPR() override;
61 
62   Status WriteFPR() override;
63 
64   void *GetGPRBuffer() override { return &m_gpr_arm64; }
65 
66   // GetGPRBufferSize returns sizeof arm64 GPR ptrace buffer, it is different
67   // from GetGPRSize which returns sizeof RegisterInfoPOSIX_arm64::GPR.
68   size_t GetGPRBufferSize() { return sizeof(m_gpr_arm64); }
69 
70   void *GetFPRBuffer() override { return &m_fpr; }
71 
72   size_t GetFPRSize() override { return sizeof(m_fpr); }
73 
74 private:
75   bool m_gpr_is_valid;
76   bool m_fpu_is_valid;
77   bool m_sve_buffer_is_valid;
78 
79   bool m_sve_header_is_valid;
80 
81   struct user_pt_regs m_gpr_arm64; // 64-bit general purpose registers.
82 
83   RegisterInfoPOSIX_arm64::FPU
84       m_fpr; // floating-point registers including extended register sets.
85 
86   SVEState m_sve_state;
87   struct user_sve_header m_sve_header;
88   std::vector<uint8_t> m_sve_ptrace_payload;
89 
90   bool m_refresh_hwdebug_info;
91 
92   bool IsGPR(unsigned reg) const;
93 
94   bool IsFPR(unsigned reg) const;
95 
96   Status ReadAllSVE();
97 
98   Status WriteAllSVE();
99 
100   Status ReadSVEHeader();
101 
102   Status WriteSVEHeader();
103 
104   bool IsSVE(unsigned reg) const;
105 
106   uint64_t GetSVERegVG() { return m_sve_header.vl / 8; }
107 
108   void SetSVERegVG(uint64_t vg) { m_sve_header.vl = vg * 8; }
109 
110   void *GetSVEHeader() { return &m_sve_header; }
111 
112   void *GetSVEBuffer();
113 
114   size_t GetSVEHeaderSize() { return sizeof(m_sve_header); }
115 
116   size_t GetSVEBufferSize() { return m_sve_ptrace_payload.size(); }
117 
118   llvm::Error ReadHardwareDebugInfo() override;
119 
120   llvm::Error WriteHardwareDebugRegs(DREGType hwbType) override;
121 
122   uint32_t CalculateFprOffset(const RegisterInfo *reg_info) const;
123 
124   RegisterInfoPOSIX_arm64 &GetRegisterInfo() const;
125 
126   void ConfigureRegisterContext();
127 
128   uint32_t CalculateSVEOffset(const RegisterInfo *reg_info) const;
129 };
130 
131 } // namespace process_linux
132 } // namespace lldb_private
133 
134 #endif // #ifndef lldb_NativeRegisterContextLinux_arm64_h
135 
136 #endif // defined (__arm64__) || defined (__aarch64__)
137