LLDB mainline
RegisterInfoPOSIX_arm64.h
Go to the documentation of this file.
1//===-- RegisterInfoPOSIX_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#ifndef LLDB_SOURCE_PLUGINS_PROCESS_UTILITY_REGISTERINFOPOSIX_ARM64_H
10#define LLDB_SOURCE_PLUGINS_PROCESS_UTILITY_REGISTERINFOPOSIX_ARM64_H
11
14#include "lldb/Utility/Flags.h"
15#include "lldb/lldb-private.h"
16#include <map>
17
18enum class SVEState : uint8_t { Unknown, Disabled, FPSIMD, Full, Streaming };
19
22public:
23 enum { GPRegSet = 0, FPRegSet };
24
25 // AArch64 register set mask value
26 enum {
38 };
39
40 // AArch64 Register set FP/SIMD feature configuration
41 enum {
45 };
46
47 // based on RegisterContextDarwin_arm64.h
48 LLVM_PACKED_START
49 struct GPR {
50 uint64_t x[29]; // x0-x28
51 uint64_t fp; // x29
52 uint64_t lr; // x30
53 uint64_t sp; // x31
54 uint64_t pc; // pc
55 uint32_t cpsr; // cpsr
56 uint32_t pad;
57 };
58 LLVM_PACKED_END
59
60 // based on RegisterContextDarwin_arm64.h
61 struct VReg {
62 uint8_t bytes[16];
63 };
64
65 // based on RegisterContextDarwin_arm64.h
66 struct FPU {
67 VReg v[32];
68 uint32_t fpsr;
69 uint32_t fpcr;
70 };
71
72 // based on RegisterContextDarwin_arm64.h
73 struct EXC {
74 uint64_t far; // Virtual Fault Address
75 uint32_t esr; // Exception syndrome
76 uint32_t exception; // number of arm exception token
77 };
78
79 // based on RegisterContextDarwin_arm64.h
80 struct DBG {
81 uint64_t bvr[16];
82 uint64_t bcr[16];
83 uint64_t wvr[16];
84 uint64_t wcr[16];
85 uint64_t mdscr_el1;
86 };
87
89 lldb_private::Flags opt_regsets);
90
91 static size_t GetGPRSizeStatic();
92 size_t GetGPRSize() const override { return GetGPRSizeStatic(); }
93
94 size_t GetFPRSize() const override;
95
96 const lldb_private::RegisterInfo *GetRegisterInfo() const override;
97
98 uint32_t GetRegisterCount() const override;
99
101 GetRegisterSet(size_t reg_set) const override;
102
103 size_t GetRegisterSetCount() const override;
104
105 size_t GetRegisterSetFromRegisterIndex(uint32_t reg_index) const override;
106
107 void AddRegSetPAuth();
108
109 void AddRegSetMTE();
110
111 void AddRegSetTLS(bool has_tpidr2);
112
113 void AddRegSetSME(bool has_zt);
114
115 void AddRegSetFPMR();
116
117 void AddRegSetGCS();
118
119 uint32_t ConfigureVectorLengthSVE(uint32_t sve_vq);
120
121 void ConfigureVectorLengthZA(uint32_t za_vq);
122
123 bool VectorSizeIsValid(uint32_t vq) {
124 // coverity[unsigned_compare]
126 return true;
127 return false;
128 }
129
139
140 bool IsSVEReg(unsigned reg) const;
141 bool IsSVEZReg(unsigned reg) const;
142 bool IsSVEPReg(unsigned reg) const;
143 bool IsSVERegVG(unsigned reg) const;
144 bool IsPAuthReg(unsigned reg) const;
145 bool IsMTEReg(unsigned reg) const;
146 bool IsTLSReg(unsigned reg) const;
147 bool IsSMEReg(unsigned reg) const;
148 bool IsSMERegZA(unsigned reg) const;
149 bool IsSMERegZT(unsigned reg) const;
150 bool IsFPMRReg(unsigned reg) const;
151 bool IsGCSReg(unsigned reg) const;
152
153 uint32_t GetRegNumSVEZ0() const;
154 uint32_t GetRegNumSVEFFR() const;
155 uint32_t GetRegNumFPCR() const;
156 uint32_t GetRegNumFPSR() const;
157 uint32_t GetRegNumSVEVG() const;
158 uint32_t GetRegNumSMESVG() const;
159 uint32_t GetPAuthOffset() const;
160 uint32_t GetMTEOffset() const;
161 uint32_t GetTLSOffset() const;
162 uint32_t GetSMEOffset() const;
163 uint32_t GetFPMROffset() const;
164 uint32_t GetGCSOffset() const;
165
166private:
167 typedef std::map<uint32_t, std::vector<lldb_private::RegisterInfo>>
169
171
174
175 // In normal operation this is const. Only when SVE or SME registers change
176 // size is it either replaced or the content modified.
179
182
183 // Contains pair of [start, end] register numbers of a register set with start
184 // and end included.
185 std::map<uint32_t, std::pair<uint32_t, uint32_t>> m_per_regset_regnum_range;
186
188
189 std::vector<lldb_private::RegisterInfo> m_dynamic_reg_infos;
190 std::vector<lldb_private::RegisterSet> m_dynamic_reg_sets;
191
192 std::vector<uint32_t> pauth_regnum_collection;
193 std::vector<uint32_t> m_mte_regnum_collection;
194 std::vector<uint32_t> m_tls_regnum_collection;
195 std::vector<uint32_t> m_sme_regnum_collection;
196 std::vector<uint32_t> m_fpmr_regnum_collection;
197 std::vector<uint32_t> m_gcs_regnum_collection;
198};
199
200#endif
std::map< uint32_t, std::pair< uint32_t, uint32_t > > m_per_regset_regnum_range
std::vector< lldb_private::RegisterInfo > m_dynamic_reg_infos
bool IsSVERegVG(unsigned reg) const
lldb_private::Flags m_opt_regsets
bool IsSMERegZT(unsigned reg) const
void AddRegSetTLS(bool has_tpidr2)
const lldb_private::RegisterInfo * m_register_info_p
uint32_t ConfigureVectorLengthSVE(uint32_t sve_vq)
std::vector< uint32_t > m_tls_regnum_collection
void ConfigureVectorLengthZA(uint32_t za_vq)
std::vector< lldb_private::RegisterSet > m_dynamic_reg_sets
std::vector< uint32_t > m_mte_regnum_collection
const lldb_private::RegisterInfo * GetRegisterInfo() const override
bool IsSVEZReg(unsigned reg) const
bool IsPAuthReg(unsigned reg) const
bool IsSMERegZA(unsigned reg) const
size_t GetRegisterSetCount() const override
bool IsGCSReg(unsigned reg) const
const lldb_private::RegisterSet * m_register_set_p
size_t GetGPRSize() const override
std::vector< uint32_t > pauth_regnum_collection
std::map< uint32_t, std::vector< lldb_private::RegisterInfo > > per_vq_register_infos
bool IsSVEReg(unsigned reg) const
bool IsSVEPReg(unsigned reg) const
std::vector< uint32_t > m_gcs_regnum_collection
bool IsTLSReg(unsigned reg) const
bool IsMTEReg(unsigned reg) const
size_t GetRegisterSetFromRegisterIndex(uint32_t reg_index) const override
per_vq_register_infos m_per_vq_reg_infos
uint32_t GetRegisterCount() const override
size_t GetFPRSize() const override
const lldb_private::RegisterSet * GetRegisterSet(size_t reg_set) const override
std::vector< uint32_t > m_sme_regnum_collection
bool IsSMEReg(unsigned reg) const
std::vector< uint32_t > m_fpmr_regnum_collection
bool IsFPMRReg(unsigned reg) const
An architecture specification class.
Definition: ArchSpec.h:31
A class to manage flags.
Definition: Flags.h:22
bool AnySet(ValueType mask) const
Test one or more flags.
Definition: Flags.h:90
Every register is described in detail including its name, alternate name (optional),...
Registers are grouped into register sets.