1 //===-- DynamicRegisterInfo.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_DYNAMICREGISTERINFO_H
10 #define LLDB_SOURCE_PLUGINS_PROCESS_UTILITY_DYNAMICREGISTERINFO_H
11 
12 #include <map>
13 #include <vector>
14 
15 #include "lldb/Utility/ConstString.h"
16 #include "lldb/Utility/StructuredData.h"
17 #include "lldb/lldb-private.h"
18 
19 class DynamicRegisterInfo {
20 public:
21   DynamicRegisterInfo() = default;
22 
23   DynamicRegisterInfo(const lldb_private::StructuredData::Dictionary &dict,
24                       const lldb_private::ArchSpec &arch);
25 
26   virtual ~DynamicRegisterInfo() = default;
27 
28   DynamicRegisterInfo(DynamicRegisterInfo &) = delete;
29   void operator=(DynamicRegisterInfo &) = delete;
30 
31   DynamicRegisterInfo(DynamicRegisterInfo &&info);
32   DynamicRegisterInfo &operator=(DynamicRegisterInfo &&info);
33 
34   size_t SetRegisterInfo(const lldb_private::StructuredData::Dictionary &dict,
35                          const lldb_private::ArchSpec &arch);
36 
37   void AddRegister(lldb_private::RegisterInfo &reg_info,
38                    lldb_private::ConstString &reg_name,
39                    lldb_private::ConstString &reg_alt_name,
40                    lldb_private::ConstString &set_name);
41 
42   void Finalize(const lldb_private::ArchSpec &arch);
43 
44   size_t GetNumRegisters() const;
45 
46   size_t GetNumRegisterSets() const;
47 
48   size_t GetRegisterDataByteSize() const;
49 
50   const lldb_private::RegisterInfo *GetRegisterInfoAtIndex(uint32_t i) const;
51 
52   lldb_private::RegisterInfo *GetRegisterInfoAtIndex(uint32_t i);
53 
54   const lldb_private::RegisterSet *GetRegisterSet(uint32_t i) const;
55 
56   uint32_t GetRegisterSetIndexByName(lldb_private::ConstString &set_name,
57                                      bool can_create);
58 
59   uint32_t ConvertRegisterKindToRegisterNumber(uint32_t kind,
60                                                uint32_t num) const;
61 
62   void Dump() const;
63 
64   void Clear();
65 
66 protected:
67   // Classes that inherit from DynamicRegisterInfo can see and modify these
68   typedef std::vector<lldb_private::RegisterInfo> reg_collection;
69   typedef std::vector<lldb_private::RegisterSet> set_collection;
70   typedef std::vector<uint32_t> reg_num_collection;
71   typedef std::vector<reg_num_collection> set_reg_num_collection;
72   typedef std::vector<lldb_private::ConstString> name_collection;
73   typedef std::map<uint32_t, reg_num_collection> reg_to_regs_map;
74   typedef std::vector<uint8_t> dwarf_opcode;
75   typedef std::map<uint32_t, dwarf_opcode> dynamic_reg_size_map;
76 
77   const lldb_private::RegisterInfo *
78   GetRegisterInfo(lldb_private::ConstString reg_name) const;
79 
80   void MoveFrom(DynamicRegisterInfo &&info);
81 
82   reg_collection m_regs;
83   set_collection m_sets;
84   set_reg_num_collection m_set_reg_nums;
85   name_collection m_set_names;
86   reg_to_regs_map m_value_regs_map;
87   reg_to_regs_map m_invalidate_regs_map;
88   dynamic_reg_size_map m_dynamic_reg_size_map;
89   size_t m_reg_data_byte_size = 0u; // The number of bytes required to store
90                                     // all registers
91   bool m_finalized = false;
92 };
93 #endif // LLDB_SOURCE_PLUGINS_PROCESS_UTILITY_DYNAMICREGISTERINFO_H
94