1 //===-- RegisterContextLinux_x86_64.cpp ------------------------*- 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 #include "RegisterContextLinux_x86_64.h"
10 #include "RegisterContextLinux_i386.h"
11 #include "RegisterContextPOSIX_x86.h"
12 #include <vector>
13 
14 using namespace lldb_private;
15 using namespace lldb;
16 
17 typedef struct _GPR {
18   uint64_t r15;
19   uint64_t r14;
20   uint64_t r13;
21   uint64_t r12;
22   uint64_t rbp;
23   uint64_t rbx;
24   uint64_t r11;
25   uint64_t r10;
26   uint64_t r9;
27   uint64_t r8;
28   uint64_t rax;
29   uint64_t rcx;
30   uint64_t rdx;
31   uint64_t rsi;
32   uint64_t rdi;
33   uint64_t orig_rax;
34   uint64_t rip;
35   uint64_t cs;
36   uint64_t rflags;
37   uint64_t rsp;
38   uint64_t ss;
39   uint64_t fs_base;
40   uint64_t gs_base;
41   uint64_t ds;
42   uint64_t es;
43   uint64_t fs;
44   uint64_t gs;
45 } GPR;
46 
47 struct DBG {
48   uint64_t dr[8];
49 };
50 
51 struct UserArea {
52   GPR gpr;         // General purpose registers.
53   int32_t fpvalid; // True if FPU is being used.
54   int32_t pad0;
55   FXSAVE fpr; // General purpose floating point registers (see FPR for extended
56               // register sets).
57   uint64_t tsize;       // Text segment size.
58   uint64_t dsize;       // Data segment size.
59   uint64_t ssize;       // Stack segment size.
60   uint64_t start_code;  // VM address of text.
61   uint64_t start_stack; // VM address of stack bottom (top in rsp).
62   int64_t signal;       // Signal causing core dump.
63   int32_t reserved;     // Unused.
64   int32_t pad1;
65   uint64_t ar0;           // Location of GPR's.
66   FXSAVE *fpstate;        // Location of FPR's.
67   uint64_t magic;         // Identifier for core dumps.
68   char u_comm[32];        // Command causing core dump.
69   DBG dbg;                // Debug registers.
70   uint64_t error_code;    // CPU error code.
71   uint64_t fault_address; // Control register CR3.
72 };
73 
74 #define DR_OFFSET(reg_index)                                                   \
75   (LLVM_EXTENSION offsetof(UserArea, dbg) +                                    \
76    LLVM_EXTENSION offsetof(DBG, dr[reg_index]))
77 
78 //---------------------------------------------------------------------------
79 // Include RegisterInfos_x86_64 to declare our g_register_infos_x86_64
80 // structure.
81 //---------------------------------------------------------------------------
82 #define DECLARE_REGISTER_INFOS_X86_64_STRUCT
83 #include "RegisterInfos_x86_64.h"
84 #undef DECLARE_REGISTER_INFOS_X86_64_STRUCT
85 
86 static std::vector<lldb_private::RegisterInfo> &GetPrivateRegisterInfoVector() {
87   static std::vector<lldb_private::RegisterInfo> g_register_infos;
88   return g_register_infos;
89 }
90 
91 static const RegisterInfo *
92 GetRegisterInfo_i386(const lldb_private::ArchSpec &arch) {
93   std::vector<lldb_private::RegisterInfo> &g_register_infos =
94       GetPrivateRegisterInfoVector();
95 
96   // Allocate RegisterInfo only once
97   if (g_register_infos.empty()) {
98     // Copy the register information from base class
99     std::unique_ptr<RegisterContextLinux_i386> reg_interface(
100         new RegisterContextLinux_i386(arch));
101     const RegisterInfo *base_info = reg_interface->GetRegisterInfo();
102     g_register_infos.insert(g_register_infos.end(), &base_info[0],
103                             &base_info[k_num_registers_i386]);
104 
105 //---------------------------------------------------------------------------
106 // Include RegisterInfos_x86_64 to update the g_register_infos structure
107 //  with x86_64 offsets.
108 //---------------------------------------------------------------------------
109 #define UPDATE_REGISTER_INFOS_I386_STRUCT_WITH_X86_64_OFFSETS
110 #include "RegisterInfos_x86_64.h"
111 #undef UPDATE_REGISTER_INFOS_I386_STRUCT_WITH_X86_64_OFFSETS
112   }
113 
114   return &g_register_infos[0];
115 }
116 
117 static const RegisterInfo *GetRegisterInfoPtr(const ArchSpec &target_arch) {
118   switch (target_arch.GetMachine()) {
119   case llvm::Triple::x86:
120     return GetRegisterInfo_i386(target_arch);
121   case llvm::Triple::x86_64:
122     return g_register_infos_x86_64;
123   default:
124     assert(false && "Unhandled target architecture.");
125     return nullptr;
126   }
127 }
128 
129 static uint32_t GetRegisterInfoCount(const ArchSpec &target_arch) {
130   switch (target_arch.GetMachine()) {
131   case llvm::Triple::x86: {
132     assert(!GetPrivateRegisterInfoVector().empty() &&
133            "i386 register info not yet filled.");
134     return static_cast<uint32_t>(GetPrivateRegisterInfoVector().size());
135   }
136   case llvm::Triple::x86_64:
137     return static_cast<uint32_t>(sizeof(g_register_infos_x86_64) /
138                                  sizeof(g_register_infos_x86_64[0]));
139   default:
140     assert(false && "Unhandled target architecture.");
141     return 0;
142   }
143 }
144 
145 static uint32_t GetUserRegisterInfoCount(const ArchSpec &target_arch) {
146   switch (target_arch.GetMachine()) {
147   case llvm::Triple::x86:
148     return static_cast<uint32_t>(k_num_user_registers_i386);
149   case llvm::Triple::x86_64:
150     return static_cast<uint32_t>(k_num_user_registers_x86_64);
151   default:
152     assert(false && "Unhandled target architecture.");
153     return 0;
154   }
155 }
156 
157 RegisterContextLinux_x86_64::RegisterContextLinux_x86_64(
158     const ArchSpec &target_arch)
159     : lldb_private::RegisterInfoInterface(target_arch),
160       m_register_info_p(GetRegisterInfoPtr(target_arch)),
161       m_register_info_count(GetRegisterInfoCount(target_arch)),
162       m_user_register_count(GetUserRegisterInfoCount(target_arch)) {
163   RegisterInfo orig_ax = {"orig_rax",
164                           NULL,
165                           sizeof(((GPR *)NULL)->orig_rax),
166                           (LLVM_EXTENSION offsetof(GPR, orig_rax)),
167                           eEncodingUint,
168                           eFormatHex,
169                           {LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM,
170                            LLDB_INVALID_REGNUM, LLDB_INVALID_REGNUM,
171                            LLDB_INVALID_REGNUM},
172                           nullptr,
173                           nullptr,
174                           nullptr,
175                           0};
176   d_register_infos.push_back(orig_ax);
177 }
178 
179 size_t RegisterContextLinux_x86_64::GetGPRSize() const { return sizeof(GPR); }
180 
181 const std::vector<lldb_private::RegisterInfo> *
182 RegisterContextLinux_x86_64::GetDynamicRegisterInfoP() const {
183   return &d_register_infos;
184 }
185 
186 const RegisterInfo *RegisterContextLinux_x86_64::GetRegisterInfo() const {
187   return m_register_info_p;
188 }
189 
190 uint32_t RegisterContextLinux_x86_64::GetRegisterCount() const {
191   return m_register_info_count;
192 }
193 
194 uint32_t RegisterContextLinux_x86_64::GetUserRegisterCount() const {
195   return m_user_register_count;
196 }
197