1 //===-- NativeRegisterContextLinux_x86_64.cpp ---------------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
10 #if defined(__i386__) || defined(__x86_64__)
11 
12 #include "NativeRegisterContextLinux_x86_64.h"
13 
14 #include "lldb/Core/RegisterValue.h"
15 #include "lldb/Host/HostInfo.h"
16 #include "lldb/Utility/DataBufferHeap.h"
17 #include "lldb/Utility/Log.h"
18 #include "lldb/Utility/Status.h"
19 
20 #include "Plugins/Process/Utility/RegisterContextLinux_i386.h"
21 #include "Plugins/Process/Utility/RegisterContextLinux_x86_64.h"
22 
23 #include <linux/elf.h>
24 
25 using namespace lldb_private;
26 using namespace lldb_private::process_linux;
27 
28 // ----------------------------------------------------------------------------
29 // Private namespace.
30 // ----------------------------------------------------------------------------
31 
32 namespace {
33 // x86 32-bit general purpose registers.
34 const uint32_t g_gpr_regnums_i386[] = {
35     lldb_eax_i386,      lldb_ebx_i386,    lldb_ecx_i386, lldb_edx_i386,
36     lldb_edi_i386,      lldb_esi_i386,    lldb_ebp_i386, lldb_esp_i386,
37     lldb_eip_i386,      lldb_eflags_i386, lldb_cs_i386,  lldb_fs_i386,
38     lldb_gs_i386,       lldb_ss_i386,     lldb_ds_i386,  lldb_es_i386,
39     lldb_ax_i386,       lldb_bx_i386,     lldb_cx_i386,  lldb_dx_i386,
40     lldb_di_i386,       lldb_si_i386,     lldb_bp_i386,  lldb_sp_i386,
41     lldb_ah_i386,       lldb_bh_i386,     lldb_ch_i386,  lldb_dh_i386,
42     lldb_al_i386,       lldb_bl_i386,     lldb_cl_i386,  lldb_dl_i386,
43     LLDB_INVALID_REGNUM // register sets need to end with this flag
44 };
45 static_assert((sizeof(g_gpr_regnums_i386) / sizeof(g_gpr_regnums_i386[0])) -
46                       1 ==
47                   k_num_gpr_registers_i386,
48               "g_gpr_regnums_i386 has wrong number of register infos");
49 
50 // x86 32-bit floating point registers.
51 const uint32_t g_fpu_regnums_i386[] = {
52     lldb_fctrl_i386,    lldb_fstat_i386,     lldb_ftag_i386,  lldb_fop_i386,
53     lldb_fiseg_i386,    lldb_fioff_i386,     lldb_foseg_i386, lldb_fooff_i386,
54     lldb_mxcsr_i386,    lldb_mxcsrmask_i386, lldb_st0_i386,   lldb_st1_i386,
55     lldb_st2_i386,      lldb_st3_i386,       lldb_st4_i386,   lldb_st5_i386,
56     lldb_st6_i386,      lldb_st7_i386,       lldb_mm0_i386,   lldb_mm1_i386,
57     lldb_mm2_i386,      lldb_mm3_i386,       lldb_mm4_i386,   lldb_mm5_i386,
58     lldb_mm6_i386,      lldb_mm7_i386,       lldb_xmm0_i386,  lldb_xmm1_i386,
59     lldb_xmm2_i386,     lldb_xmm3_i386,      lldb_xmm4_i386,  lldb_xmm5_i386,
60     lldb_xmm6_i386,     lldb_xmm7_i386,
61     LLDB_INVALID_REGNUM // register sets need to end with this flag
62 };
63 static_assert((sizeof(g_fpu_regnums_i386) / sizeof(g_fpu_regnums_i386[0])) -
64                       1 ==
65                   k_num_fpr_registers_i386,
66               "g_fpu_regnums_i386 has wrong number of register infos");
67 
68 // x86 32-bit AVX registers.
69 const uint32_t g_avx_regnums_i386[] = {
70     lldb_ymm0_i386,     lldb_ymm1_i386, lldb_ymm2_i386, lldb_ymm3_i386,
71     lldb_ymm4_i386,     lldb_ymm5_i386, lldb_ymm6_i386, lldb_ymm7_i386,
72     LLDB_INVALID_REGNUM // register sets need to end with this flag
73 };
74 static_assert((sizeof(g_avx_regnums_i386) / sizeof(g_avx_regnums_i386[0])) -
75                       1 ==
76                   k_num_avx_registers_i386,
77               " g_avx_regnums_i386 has wrong number of register infos");
78 
79 // x64 32-bit MPX registers.
80 static const uint32_t g_mpx_regnums_i386[] = {
81     lldb_bnd0_i386,     lldb_bnd1_i386, lldb_bnd2_i386, lldb_bnd3_i386,
82     lldb_bndcfgu_i386,  lldb_bndstatus_i386,
83     LLDB_INVALID_REGNUM // register sets need to end with this flag
84 };
85 static_assert((sizeof(g_mpx_regnums_i386) / sizeof(g_mpx_regnums_i386[0])) -
86                       1 ==
87                   k_num_mpx_registers_i386,
88               "g_mpx_regnums_x86_64 has wrong number of register infos");
89 
90 // x86 64-bit general purpose registers.
91 static const uint32_t g_gpr_regnums_x86_64[] = {
92     lldb_rax_x86_64,    lldb_rbx_x86_64,    lldb_rcx_x86_64, lldb_rdx_x86_64,
93     lldb_rdi_x86_64,    lldb_rsi_x86_64,    lldb_rbp_x86_64, lldb_rsp_x86_64,
94     lldb_r8_x86_64,     lldb_r9_x86_64,     lldb_r10_x86_64, lldb_r11_x86_64,
95     lldb_r12_x86_64,    lldb_r13_x86_64,    lldb_r14_x86_64, lldb_r15_x86_64,
96     lldb_rip_x86_64,    lldb_rflags_x86_64, lldb_cs_x86_64,  lldb_fs_x86_64,
97     lldb_gs_x86_64,     lldb_ss_x86_64,     lldb_ds_x86_64,  lldb_es_x86_64,
98     lldb_eax_x86_64,    lldb_ebx_x86_64,    lldb_ecx_x86_64, lldb_edx_x86_64,
99     lldb_edi_x86_64,    lldb_esi_x86_64,    lldb_ebp_x86_64, lldb_esp_x86_64,
100     lldb_r8d_x86_64,  // Low 32 bits or r8
101     lldb_r9d_x86_64,  // Low 32 bits or r9
102     lldb_r10d_x86_64, // Low 32 bits or r10
103     lldb_r11d_x86_64, // Low 32 bits or r11
104     lldb_r12d_x86_64, // Low 32 bits or r12
105     lldb_r13d_x86_64, // Low 32 bits or r13
106     lldb_r14d_x86_64, // Low 32 bits or r14
107     lldb_r15d_x86_64, // Low 32 bits or r15
108     lldb_ax_x86_64,     lldb_bx_x86_64,     lldb_cx_x86_64,  lldb_dx_x86_64,
109     lldb_di_x86_64,     lldb_si_x86_64,     lldb_bp_x86_64,  lldb_sp_x86_64,
110     lldb_r8w_x86_64,  // Low 16 bits or r8
111     lldb_r9w_x86_64,  // Low 16 bits or r9
112     lldb_r10w_x86_64, // Low 16 bits or r10
113     lldb_r11w_x86_64, // Low 16 bits or r11
114     lldb_r12w_x86_64, // Low 16 bits or r12
115     lldb_r13w_x86_64, // Low 16 bits or r13
116     lldb_r14w_x86_64, // Low 16 bits or r14
117     lldb_r15w_x86_64, // Low 16 bits or r15
118     lldb_ah_x86_64,     lldb_bh_x86_64,     lldb_ch_x86_64,  lldb_dh_x86_64,
119     lldb_al_x86_64,     lldb_bl_x86_64,     lldb_cl_x86_64,  lldb_dl_x86_64,
120     lldb_dil_x86_64,    lldb_sil_x86_64,    lldb_bpl_x86_64, lldb_spl_x86_64,
121     lldb_r8l_x86_64,    // Low 8 bits or r8
122     lldb_r9l_x86_64,    // Low 8 bits or r9
123     lldb_r10l_x86_64,   // Low 8 bits or r10
124     lldb_r11l_x86_64,   // Low 8 bits or r11
125     lldb_r12l_x86_64,   // Low 8 bits or r12
126     lldb_r13l_x86_64,   // Low 8 bits or r13
127     lldb_r14l_x86_64,   // Low 8 bits or r14
128     lldb_r15l_x86_64,   // Low 8 bits or r15
129     LLDB_INVALID_REGNUM // register sets need to end with this flag
130 };
131 static_assert((sizeof(g_gpr_regnums_x86_64) / sizeof(g_gpr_regnums_x86_64[0])) -
132                       1 ==
133                   k_num_gpr_registers_x86_64,
134               "g_gpr_regnums_x86_64 has wrong number of register infos");
135 
136 // x86 64-bit floating point registers.
137 static const uint32_t g_fpu_regnums_x86_64[] = {
138     lldb_fctrl_x86_64,     lldb_fstat_x86_64, lldb_ftag_x86_64,
139     lldb_fop_x86_64,       lldb_fiseg_x86_64, lldb_fioff_x86_64,
140     lldb_foseg_x86_64,     lldb_fooff_x86_64, lldb_mxcsr_x86_64,
141     lldb_mxcsrmask_x86_64, lldb_st0_x86_64,   lldb_st1_x86_64,
142     lldb_st2_x86_64,       lldb_st3_x86_64,   lldb_st4_x86_64,
143     lldb_st5_x86_64,       lldb_st6_x86_64,   lldb_st7_x86_64,
144     lldb_mm0_x86_64,       lldb_mm1_x86_64,   lldb_mm2_x86_64,
145     lldb_mm3_x86_64,       lldb_mm4_x86_64,   lldb_mm5_x86_64,
146     lldb_mm6_x86_64,       lldb_mm7_x86_64,   lldb_xmm0_x86_64,
147     lldb_xmm1_x86_64,      lldb_xmm2_x86_64,  lldb_xmm3_x86_64,
148     lldb_xmm4_x86_64,      lldb_xmm5_x86_64,  lldb_xmm6_x86_64,
149     lldb_xmm7_x86_64,      lldb_xmm8_x86_64,  lldb_xmm9_x86_64,
150     lldb_xmm10_x86_64,     lldb_xmm11_x86_64, lldb_xmm12_x86_64,
151     lldb_xmm13_x86_64,     lldb_xmm14_x86_64, lldb_xmm15_x86_64,
152     LLDB_INVALID_REGNUM // register sets need to end with this flag
153 };
154 static_assert((sizeof(g_fpu_regnums_x86_64) / sizeof(g_fpu_regnums_x86_64[0])) -
155                       1 ==
156                   k_num_fpr_registers_x86_64,
157               "g_fpu_regnums_x86_64 has wrong number of register infos");
158 
159 // x86 64-bit AVX registers.
160 static const uint32_t g_avx_regnums_x86_64[] = {
161     lldb_ymm0_x86_64,   lldb_ymm1_x86_64,  lldb_ymm2_x86_64,  lldb_ymm3_x86_64,
162     lldb_ymm4_x86_64,   lldb_ymm5_x86_64,  lldb_ymm6_x86_64,  lldb_ymm7_x86_64,
163     lldb_ymm8_x86_64,   lldb_ymm9_x86_64,  lldb_ymm10_x86_64, lldb_ymm11_x86_64,
164     lldb_ymm12_x86_64,  lldb_ymm13_x86_64, lldb_ymm14_x86_64, lldb_ymm15_x86_64,
165     LLDB_INVALID_REGNUM // register sets need to end with this flag
166 };
167 static_assert((sizeof(g_avx_regnums_x86_64) / sizeof(g_avx_regnums_x86_64[0])) -
168                       1 ==
169                   k_num_avx_registers_x86_64,
170               "g_avx_regnums_x86_64 has wrong number of register infos");
171 
172 // x86 64-bit MPX registers.
173 static const uint32_t g_mpx_regnums_x86_64[] = {
174     lldb_bnd0_x86_64,    lldb_bnd1_x86_64,    lldb_bnd2_x86_64,
175     lldb_bnd3_x86_64,    lldb_bndcfgu_x86_64, lldb_bndstatus_x86_64,
176     LLDB_INVALID_REGNUM // register sets need to end with this flag
177 };
178 static_assert((sizeof(g_mpx_regnums_x86_64) / sizeof(g_mpx_regnums_x86_64[0])) -
179                       1 ==
180                   k_num_mpx_registers_x86_64,
181               "g_mpx_regnums_x86_64 has wrong number of register infos");
182 
183 // Number of register sets provided by this context.
184 enum { k_num_extended_register_sets = 2, k_num_register_sets = 4 };
185 
186 // Register sets for x86 32-bit.
187 static const RegisterSet g_reg_sets_i386[k_num_register_sets] = {
188     {"General Purpose Registers", "gpr", k_num_gpr_registers_i386,
189      g_gpr_regnums_i386},
190     {"Floating Point Registers", "fpu", k_num_fpr_registers_i386,
191      g_fpu_regnums_i386},
192     {"Advanced Vector Extensions", "avx", k_num_avx_registers_i386,
193      g_avx_regnums_i386},
194     { "Memory Protection Extensions", "mpx", k_num_mpx_registers_i386,
195      g_mpx_regnums_i386}};
196 
197 // Register sets for x86 64-bit.
198 static const RegisterSet g_reg_sets_x86_64[k_num_register_sets] = {
199     {"General Purpose Registers", "gpr", k_num_gpr_registers_x86_64,
200      g_gpr_regnums_x86_64},
201     {"Floating Point Registers", "fpu", k_num_fpr_registers_x86_64,
202      g_fpu_regnums_x86_64},
203     {"Advanced Vector Extensions", "avx", k_num_avx_registers_x86_64,
204      g_avx_regnums_x86_64},
205     { "Memory Protection Extensions", "mpx", k_num_mpx_registers_x86_64,
206      g_mpx_regnums_x86_64}};
207 }
208 
209 #define REG_CONTEXT_SIZE (GetRegisterInfoInterface().GetGPRSize() + sizeof(FPR))
210 
211 // ----------------------------------------------------------------------------
212 // Required ptrace defines.
213 // ----------------------------------------------------------------------------
214 
215 // Support ptrace extensions even when compiled without required kernel support
216 #ifndef NT_X86_XSTATE
217 #define NT_X86_XSTATE 0x202
218 #endif
219 #ifndef NT_PRXFPREG
220 #define NT_PRXFPREG 0x46e62b7f
221 #endif
222 
223 // On x86_64 NT_PRFPREG is used to access the FXSAVE area. On i386, we need to
224 // use NT_PRXFPREG.
225 static inline unsigned int fxsr_regset(const ArchSpec &arch) {
226   return arch.GetAddressByteSize() == 8 ? NT_PRFPREG : NT_PRXFPREG;
227 }
228 
229 // ----------------------------------------------------------------------------
230 // Required MPX define.
231 // ----------------------------------------------------------------------------
232 
233 // Support MPX extensions also if compiled with compiler without MPX support.
234 #ifndef bit_MPX
235 #define bit_MPX 0x4000
236 #endif
237 
238 // ----------------------------------------------------------------------------
239 // XCR0 extended register sets masks.
240 // ----------------------------------------------------------------------------
241 #define mask_XSTATE_AVX (1ULL << 2)
242 #define mask_XSTATE_BNDREGS (1ULL << 3)
243 #define mask_XSTATE_BNDCFG (1ULL << 4)
244 #define mask_XSTATE_MPX (mask_XSTATE_BNDREGS | mask_XSTATE_BNDCFG)
245 
246 NativeRegisterContextLinux *
247 NativeRegisterContextLinux::CreateHostNativeRegisterContextLinux(
248     const ArchSpec &target_arch, NativeThreadProtocol &native_thread,
249     uint32_t concrete_frame_idx) {
250   return new NativeRegisterContextLinux_x86_64(target_arch, native_thread,
251                                                concrete_frame_idx);
252 }
253 
254 // ----------------------------------------------------------------------------
255 // NativeRegisterContextLinux_x86_64 members.
256 // ----------------------------------------------------------------------------
257 
258 static RegisterInfoInterface *
259 CreateRegisterInfoInterface(const ArchSpec &target_arch) {
260   if (HostInfo::GetArchitecture().GetAddressByteSize() == 4) {
261     // 32-bit hosts run with a RegisterContextLinux_i386 context.
262     return new RegisterContextLinux_i386(target_arch);
263   } else {
264     assert((HostInfo::GetArchitecture().GetAddressByteSize() == 8) &&
265            "Register setting path assumes this is a 64-bit host");
266     // X86_64 hosts know how to work with 64-bit and 32-bit EXEs using the
267     // x86_64 register context.
268     return new RegisterContextLinux_x86_64(target_arch);
269   }
270 }
271 
272 NativeRegisterContextLinux_x86_64::NativeRegisterContextLinux_x86_64(
273     const ArchSpec &target_arch, NativeThreadProtocol &native_thread,
274     uint32_t concrete_frame_idx)
275     : NativeRegisterContextLinux(native_thread, concrete_frame_idx,
276                                  CreateRegisterInfoInterface(target_arch)),
277       m_xstate_type(XStateType::Invalid), m_fpr(), m_iovec(), m_ymm_set(),
278       m_mpx_set(), m_reg_info(), m_gpr_x86_64() {
279   // Set up data about ranges of valid registers.
280   switch (target_arch.GetMachine()) {
281   case llvm::Triple::x86:
282     m_reg_info.num_registers = k_num_registers_i386;
283     m_reg_info.num_gpr_registers = k_num_gpr_registers_i386;
284     m_reg_info.num_fpr_registers = k_num_fpr_registers_i386;
285     m_reg_info.num_avx_registers = k_num_avx_registers_i386;
286     m_reg_info.num_mpx_registers = k_num_mpx_registers_i386;
287     m_reg_info.last_gpr = k_last_gpr_i386;
288     m_reg_info.first_fpr = k_first_fpr_i386;
289     m_reg_info.last_fpr = k_last_fpr_i386;
290     m_reg_info.first_st = lldb_st0_i386;
291     m_reg_info.last_st = lldb_st7_i386;
292     m_reg_info.first_mm = lldb_mm0_i386;
293     m_reg_info.last_mm = lldb_mm7_i386;
294     m_reg_info.first_xmm = lldb_xmm0_i386;
295     m_reg_info.last_xmm = lldb_xmm7_i386;
296     m_reg_info.first_ymm = lldb_ymm0_i386;
297     m_reg_info.last_ymm = lldb_ymm7_i386;
298     m_reg_info.first_mpxr = lldb_bnd0_i386;
299     m_reg_info.last_mpxr = lldb_bnd3_i386;
300     m_reg_info.first_mpxc = lldb_bndcfgu_i386;
301     m_reg_info.last_mpxc = lldb_bndstatus_i386;
302     m_reg_info.first_dr = lldb_dr0_i386;
303     m_reg_info.gpr_flags = lldb_eflags_i386;
304     break;
305   case llvm::Triple::x86_64:
306     m_reg_info.num_registers = k_num_registers_x86_64;
307     m_reg_info.num_gpr_registers = k_num_gpr_registers_x86_64;
308     m_reg_info.num_fpr_registers = k_num_fpr_registers_x86_64;
309     m_reg_info.num_avx_registers = k_num_avx_registers_x86_64;
310     m_reg_info.num_mpx_registers = k_num_mpx_registers_x86_64;
311     m_reg_info.last_gpr = k_last_gpr_x86_64;
312     m_reg_info.first_fpr = k_first_fpr_x86_64;
313     m_reg_info.last_fpr = k_last_fpr_x86_64;
314     m_reg_info.first_st = lldb_st0_x86_64;
315     m_reg_info.last_st = lldb_st7_x86_64;
316     m_reg_info.first_mm = lldb_mm0_x86_64;
317     m_reg_info.last_mm = lldb_mm7_x86_64;
318     m_reg_info.first_xmm = lldb_xmm0_x86_64;
319     m_reg_info.last_xmm = lldb_xmm15_x86_64;
320     m_reg_info.first_ymm = lldb_ymm0_x86_64;
321     m_reg_info.last_ymm = lldb_ymm15_x86_64;
322     m_reg_info.first_mpxr = lldb_bnd0_x86_64;
323     m_reg_info.last_mpxr = lldb_bnd3_x86_64;
324     m_reg_info.first_mpxc = lldb_bndcfgu_x86_64;
325     m_reg_info.last_mpxc = lldb_bndstatus_x86_64;
326     m_reg_info.first_dr = lldb_dr0_x86_64;
327     m_reg_info.gpr_flags = lldb_rflags_x86_64;
328     break;
329   default:
330     assert(false && "Unhandled target architecture.");
331     break;
332   }
333 
334   // Initialize m_iovec to point to the buffer and buffer size
335   // using the conventions of Berkeley style UIO structures, as required
336   // by PTRACE extensions.
337   m_iovec.iov_base = &m_fpr.xstate.xsave;
338   m_iovec.iov_len = sizeof(m_fpr.xstate.xsave);
339 
340   // Clear out the FPR state.
341   ::memset(&m_fpr, 0, sizeof(FPR));
342 
343   // Store byte offset of fctrl (i.e. first register of FPR)
344   const RegisterInfo *reg_info_fctrl = GetRegisterInfoByName("fctrl");
345   m_fctrl_offset_in_userarea = reg_info_fctrl->byte_offset;
346 }
347 
348 // CONSIDER after local and llgs debugging are merged, register set support can
349 // be moved into a base x86-64 class with IsRegisterSetAvailable made virtual.
350 uint32_t NativeRegisterContextLinux_x86_64::GetRegisterSetCount() const {
351   uint32_t sets = 0;
352   for (uint32_t set_index = 0; set_index < k_num_register_sets; ++set_index) {
353     if (IsRegisterSetAvailable(set_index))
354       ++sets;
355   }
356 
357   return sets;
358 }
359 
360 uint32_t NativeRegisterContextLinux_x86_64::GetUserRegisterCount() const {
361   uint32_t count = 0;
362   for (uint32_t set_index = 0; set_index < k_num_register_sets; ++set_index) {
363     const RegisterSet *set = GetRegisterSet(set_index);
364     if (set)
365       count += set->num_registers;
366   }
367   return count;
368 }
369 
370 const RegisterSet *
371 NativeRegisterContextLinux_x86_64::GetRegisterSet(uint32_t set_index) const {
372   if (!IsRegisterSetAvailable(set_index))
373     return nullptr;
374 
375   switch (GetRegisterInfoInterface().GetTargetArchitecture().GetMachine()) {
376   case llvm::Triple::x86:
377     return &g_reg_sets_i386[set_index];
378   case llvm::Triple::x86_64:
379     return &g_reg_sets_x86_64[set_index];
380   default:
381     assert(false && "Unhandled target architecture.");
382     return nullptr;
383   }
384 
385   return nullptr;
386 }
387 
388 Status
389 NativeRegisterContextLinux_x86_64::ReadRegister(const RegisterInfo *reg_info,
390                                                 RegisterValue &reg_value) {
391   Status error;
392 
393   if (!reg_info) {
394     error.SetErrorString("reg_info NULL");
395     return error;
396   }
397 
398   const uint32_t reg = reg_info->kinds[lldb::eRegisterKindLLDB];
399   if (reg == LLDB_INVALID_REGNUM) {
400     // This is likely an internal register for lldb use only and should not be
401     // directly queried.
402     error.SetErrorStringWithFormat("register \"%s\" is an internal-only lldb "
403                                    "register, cannot read directly",
404                                    reg_info->name);
405     return error;
406   }
407 
408   if (IsFPR(reg) || IsAVX(reg) || IsMPX(reg)) {
409     error = ReadFPR();
410     if (error.Fail())
411       return error;
412   } else {
413     uint32_t full_reg = reg;
414     bool is_subreg = reg_info->invalidate_regs &&
415                      (reg_info->invalidate_regs[0] != LLDB_INVALID_REGNUM);
416 
417     if (is_subreg) {
418       // Read the full aligned 64-bit register.
419       full_reg = reg_info->invalidate_regs[0];
420     }
421 
422     error = ReadRegisterRaw(full_reg, reg_value);
423 
424     if (error.Success()) {
425       // If our read was not aligned (for ah,bh,ch,dh), shift our returned value
426       // one byte to the right.
427       if (is_subreg && (reg_info->byte_offset & 0x1))
428         reg_value.SetUInt64(reg_value.GetAsUInt64() >> 8);
429 
430       // If our return byte size was greater than the return value reg size,
431       // then
432       // use the type specified by reg_info rather than the uint64_t default
433       if (reg_value.GetByteSize() > reg_info->byte_size)
434         reg_value.SetType(reg_info);
435     }
436     return error;
437   }
438 
439   if (reg_info->encoding == lldb::eEncodingVector) {
440     lldb::ByteOrder byte_order = GetByteOrder();
441 
442     if (byte_order != lldb::eByteOrderInvalid) {
443       if (reg >= m_reg_info.first_st && reg <= m_reg_info.last_st)
444         reg_value.SetBytes(
445             m_fpr.xstate.fxsave.stmm[reg - m_reg_info.first_st].bytes,
446             reg_info->byte_size, byte_order);
447       if (reg >= m_reg_info.first_mm && reg <= m_reg_info.last_mm)
448         reg_value.SetBytes(
449             m_fpr.xstate.fxsave.stmm[reg - m_reg_info.first_mm].bytes,
450             reg_info->byte_size, byte_order);
451       if (reg >= m_reg_info.first_xmm && reg <= m_reg_info.last_xmm)
452         reg_value.SetBytes(
453             m_fpr.xstate.fxsave.xmm[reg - m_reg_info.first_xmm].bytes,
454             reg_info->byte_size, byte_order);
455       if (reg >= m_reg_info.first_ymm && reg <= m_reg_info.last_ymm) {
456         // Concatenate ymm using the register halves in xmm.bytes and ymmh.bytes
457         if (CopyXSTATEtoYMM(reg, byte_order))
458           reg_value.SetBytes(m_ymm_set.ymm[reg - m_reg_info.first_ymm].bytes,
459                              reg_info->byte_size, byte_order);
460         else {
461           error.SetErrorString("failed to copy ymm register value");
462           return error;
463         }
464       }
465       if (reg >= m_reg_info.first_mpxr && reg <= m_reg_info.last_mpxr) {
466         if (CopyXSTATEtoMPX(reg))
467           reg_value.SetBytes(m_mpx_set.mpxr[reg - m_reg_info.first_mpxr].bytes,
468                              reg_info->byte_size, byte_order);
469         else {
470           error.SetErrorString("failed to copy mpx register value");
471           return error;
472         }
473       }
474       if (reg >= m_reg_info.first_mpxc && reg <= m_reg_info.last_mpxc) {
475         if (CopyXSTATEtoMPX(reg))
476           reg_value.SetBytes(m_mpx_set.mpxc[reg - m_reg_info.first_mpxc].bytes,
477                              reg_info->byte_size, byte_order);
478         else {
479           error.SetErrorString("failed to copy mpx register value");
480           return error;
481         }
482       }
483 
484       if (reg_value.GetType() != RegisterValue::eTypeBytes)
485         error.SetErrorString(
486             "write failed - type was expected to be RegisterValue::eTypeBytes");
487 
488       return error;
489     }
490 
491     error.SetErrorString("byte order is invalid");
492     return error;
493   }
494 
495   // Get pointer to m_fpr.xstate.fxsave variable and set the data from it.
496 
497   // Byte offsets of all registers are calculated wrt 'UserArea' structure.
498   // However, ReadFPR() reads fpu registers {using ptrace(PTRACE_GETFPREGS,..)}
499   // and stores them in 'm_fpr' (of type FPR structure). To extract values of
500   // fpu
501   // registers, m_fpr should be read at byte offsets calculated wrt to FPR
502   // structure.
503 
504   // Since, FPR structure is also one of the member of UserArea structure.
505   // byte_offset(fpu wrt FPR) = byte_offset(fpu wrt UserArea) -
506   // byte_offset(fctrl wrt UserArea)
507   assert((reg_info->byte_offset - m_fctrl_offset_in_userarea) < sizeof(m_fpr));
508   uint8_t *src =
509       (uint8_t *)&m_fpr + reg_info->byte_offset - m_fctrl_offset_in_userarea;
510   switch (reg_info->byte_size) {
511   case 1:
512     reg_value.SetUInt8(*(uint8_t *)src);
513     break;
514   case 2:
515     reg_value.SetUInt16(*(uint16_t *)src);
516     break;
517   case 4:
518     reg_value.SetUInt32(*(uint32_t *)src);
519     break;
520   case 8:
521     reg_value.SetUInt64(*(uint64_t *)src);
522     break;
523   default:
524     assert(false && "Unhandled data size.");
525     error.SetErrorStringWithFormat("unhandled byte size: %" PRIu32,
526                                    reg_info->byte_size);
527     break;
528   }
529 
530   return error;
531 }
532 
533 Status NativeRegisterContextLinux_x86_64::WriteRegister(
534     const RegisterInfo *reg_info, const RegisterValue &reg_value) {
535   assert(reg_info && "reg_info is null");
536 
537   const uint32_t reg_index = reg_info->kinds[lldb::eRegisterKindLLDB];
538   if (reg_index == LLDB_INVALID_REGNUM)
539     return Status("no lldb regnum for %s", reg_info && reg_info->name
540                                                ? reg_info->name
541                                                : "<unknown register>");
542 
543   if (IsGPR(reg_index))
544     return WriteRegisterRaw(reg_index, reg_value);
545 
546   if (IsFPR(reg_index) || IsAVX(reg_index) || IsMPX(reg_index)) {
547     if (reg_info->encoding == lldb::eEncodingVector) {
548       if (reg_index >= m_reg_info.first_st && reg_index <= m_reg_info.last_st)
549         ::memcpy(
550             m_fpr.xstate.fxsave.stmm[reg_index - m_reg_info.first_st].bytes,
551             reg_value.GetBytes(), reg_value.GetByteSize());
552 
553       if (reg_index >= m_reg_info.first_mm && reg_index <= m_reg_info.last_mm)
554         ::memcpy(
555             m_fpr.xstate.fxsave.stmm[reg_index - m_reg_info.first_mm].bytes,
556             reg_value.GetBytes(), reg_value.GetByteSize());
557 
558       if (reg_index >= m_reg_info.first_xmm && reg_index <= m_reg_info.last_xmm)
559         ::memcpy(
560             m_fpr.xstate.fxsave.xmm[reg_index - m_reg_info.first_xmm].bytes,
561             reg_value.GetBytes(), reg_value.GetByteSize());
562 
563       if (reg_index >= m_reg_info.first_ymm &&
564           reg_index <= m_reg_info.last_ymm) {
565         // Store ymm register content, and split into the register halves in
566         // xmm.bytes and ymmh.bytes
567         ::memcpy(m_ymm_set.ymm[reg_index - m_reg_info.first_ymm].bytes,
568                  reg_value.GetBytes(), reg_value.GetByteSize());
569         if (!CopyYMMtoXSTATE(reg_index, GetByteOrder()))
570           return Status("CopyYMMtoXSTATE() failed");
571       }
572 
573       if (reg_index >= m_reg_info.first_mpxr &&
574           reg_index <= m_reg_info.last_mpxr) {
575         ::memcpy(m_mpx_set.mpxr[reg_index - m_reg_info.first_mpxr].bytes,
576                  reg_value.GetBytes(), reg_value.GetByteSize());
577         if (!CopyMPXtoXSTATE(reg_index))
578           return Status("CopyMPXtoXSTATE() failed");
579       }
580 
581       if (reg_index >= m_reg_info.first_mpxc &&
582           reg_index <= m_reg_info.last_mpxc) {
583         ::memcpy(m_mpx_set.mpxc[reg_index - m_reg_info.first_mpxc].bytes,
584                  reg_value.GetBytes(), reg_value.GetByteSize());
585         if (!CopyMPXtoXSTATE(reg_index))
586           return Status("CopyMPXtoXSTATE() failed");
587       }
588     } else {
589       // Get pointer to m_fpr.xstate.fxsave variable and set the data to it.
590 
591       // Byte offsets of all registers are calculated wrt 'UserArea' structure.
592       // However, WriteFPR() takes m_fpr (of type FPR structure) and writes only
593       // fpu
594       // registers using ptrace(PTRACE_SETFPREGS,..) API. Hence fpu registers
595       // should
596       // be written in m_fpr at byte offsets calculated wrt FPR structure.
597 
598       // Since, FPR structure is also one of the member of UserArea structure.
599       // byte_offset(fpu wrt FPR) = byte_offset(fpu wrt UserArea) -
600       // byte_offset(fctrl wrt UserArea)
601       assert((reg_info->byte_offset - m_fctrl_offset_in_userarea) <
602              sizeof(m_fpr));
603       uint8_t *dst = (uint8_t *)&m_fpr + reg_info->byte_offset -
604                      m_fctrl_offset_in_userarea;
605       switch (reg_info->byte_size) {
606       case 1:
607         *(uint8_t *)dst = reg_value.GetAsUInt8();
608         break;
609       case 2:
610         *(uint16_t *)dst = reg_value.GetAsUInt16();
611         break;
612       case 4:
613         *(uint32_t *)dst = reg_value.GetAsUInt32();
614         break;
615       case 8:
616         *(uint64_t *)dst = reg_value.GetAsUInt64();
617         break;
618       default:
619         assert(false && "Unhandled data size.");
620         return Status("unhandled register data size %" PRIu32,
621                       reg_info->byte_size);
622       }
623     }
624 
625     Status error = WriteFPR();
626     if (error.Fail())
627       return error;
628 
629     if (IsAVX(reg_index)) {
630       if (!CopyYMMtoXSTATE(reg_index, GetByteOrder()))
631         return Status("CopyYMMtoXSTATE() failed");
632     }
633 
634     if (IsMPX(reg_index)) {
635       if (!CopyMPXtoXSTATE(reg_index))
636         return Status("CopyMPXtoXSTATE() failed");
637     }
638     return Status();
639   }
640   return Status("failed - register wasn't recognized to be a GPR or an FPR, "
641                 "write strategy unknown");
642 }
643 
644 Status NativeRegisterContextLinux_x86_64::ReadAllRegisterValues(
645     lldb::DataBufferSP &data_sp) {
646   Status error;
647 
648   data_sp.reset(new DataBufferHeap(REG_CONTEXT_SIZE, 0));
649   if (!data_sp) {
650     error.SetErrorStringWithFormat(
651         "failed to allocate DataBufferHeap instance of size %" PRIu64,
652         REG_CONTEXT_SIZE);
653     return error;
654   }
655 
656   error = ReadGPR();
657   if (error.Fail())
658     return error;
659 
660   error = ReadFPR();
661   if (error.Fail())
662     return error;
663 
664   uint8_t *dst = data_sp->GetBytes();
665   if (dst == nullptr) {
666     error.SetErrorStringWithFormat("DataBufferHeap instance of size %" PRIu64
667                                    " returned a null pointer",
668                                    REG_CONTEXT_SIZE);
669     return error;
670   }
671 
672   ::memcpy(dst, &m_gpr_x86_64, GetRegisterInfoInterface().GetGPRSize());
673   dst += GetRegisterInfoInterface().GetGPRSize();
674   if (m_xstate_type == XStateType::FXSAVE)
675     ::memcpy(dst, &m_fpr.xstate.fxsave, sizeof(m_fpr.xstate.fxsave));
676   else if (m_xstate_type == XStateType::XSAVE) {
677     lldb::ByteOrder byte_order = GetByteOrder();
678 
679     if (IsCPUFeatureAvailable(RegSet::avx)) {
680       // Assemble the YMM register content from the register halves.
681       for (uint32_t reg = m_reg_info.first_ymm; reg <= m_reg_info.last_ymm;
682            ++reg) {
683         if (!CopyXSTATEtoYMM(reg, byte_order)) {
684           error.SetErrorStringWithFormat(
685               "NativeRegisterContextLinux_x86_64::%s "
686               "CopyXSTATEtoYMM() failed for reg num "
687               "%" PRIu32,
688               __FUNCTION__, reg);
689           return error;
690         }
691       }
692     }
693 
694     if (IsCPUFeatureAvailable(RegSet::mpx)) {
695       for (uint32_t reg = m_reg_info.first_mpxr; reg <= m_reg_info.last_mpxc;
696            ++reg) {
697         if (!CopyXSTATEtoMPX(reg)) {
698           error.SetErrorStringWithFormat(
699               "NativeRegisterContextLinux_x86_64::%s "
700               "CopyXSTATEtoMPX() failed for reg num "
701               "%" PRIu32,
702               __FUNCTION__, reg);
703           return error;
704         }
705       }
706     }
707     // Copy the extended register state including the assembled ymm registers.
708     ::memcpy(dst, &m_fpr, sizeof(m_fpr));
709   } else {
710     assert(false && "how do we save the floating point registers?");
711     error.SetErrorString("unsure how to save the floating point registers");
712   }
713   /** The following code is specific to Linux x86 based architectures,
714    *  where the register orig_eax (32 bit)/orig_rax (64 bit) is set to
715    *  -1 to solve the bug 23659, such a setting prevents the automatic
716    *  decrement of the instruction pointer which was causing the SIGILL
717    *  exception.
718    * **/
719 
720   RegisterValue value((uint64_t)-1);
721   const RegisterInfo *reg_info =
722       GetRegisterInfoInterface().GetDynamicRegisterInfo("orig_eax");
723   if (reg_info == nullptr)
724     reg_info = GetRegisterInfoInterface().GetDynamicRegisterInfo("orig_rax");
725 
726   if (reg_info != nullptr)
727     return DoWriteRegisterValue(reg_info->byte_offset, reg_info->name, value);
728 
729   return error;
730 }
731 
732 Status NativeRegisterContextLinux_x86_64::WriteAllRegisterValues(
733     const lldb::DataBufferSP &data_sp) {
734   Status error;
735 
736   if (!data_sp) {
737     error.SetErrorStringWithFormat(
738         "NativeRegisterContextLinux_x86_64::%s invalid data_sp provided",
739         __FUNCTION__);
740     return error;
741   }
742 
743   if (data_sp->GetByteSize() != REG_CONTEXT_SIZE) {
744     error.SetErrorStringWithFormat(
745         "NativeRegisterContextLinux_x86_64::%s data_sp contained mismatched "
746         "data size, expected %" PRIu64 ", actual %" PRIu64,
747         __FUNCTION__, REG_CONTEXT_SIZE, data_sp->GetByteSize());
748     return error;
749   }
750 
751   uint8_t *src = data_sp->GetBytes();
752   if (src == nullptr) {
753     error.SetErrorStringWithFormat("NativeRegisterContextLinux_x86_64::%s "
754                                    "DataBuffer::GetBytes() returned a null "
755                                    "pointer",
756                                    __FUNCTION__);
757     return error;
758   }
759   ::memcpy(&m_gpr_x86_64, src, GetRegisterInfoInterface().GetGPRSize());
760 
761   error = WriteGPR();
762   if (error.Fail())
763     return error;
764 
765   src += GetRegisterInfoInterface().GetGPRSize();
766   if (m_xstate_type == XStateType::FXSAVE)
767     ::memcpy(&m_fpr.xstate.fxsave, src, sizeof(m_fpr.xstate.fxsave));
768   else if (m_xstate_type == XStateType::XSAVE)
769     ::memcpy(&m_fpr.xstate.xsave, src, sizeof(m_fpr.xstate.xsave));
770 
771   error = WriteFPR();
772   if (error.Fail())
773     return error;
774 
775   if (m_xstate_type == XStateType::XSAVE) {
776     lldb::ByteOrder byte_order = GetByteOrder();
777 
778     if (IsCPUFeatureAvailable(RegSet::avx)) {
779       // Parse the YMM register content from the register halves.
780       for (uint32_t reg = m_reg_info.first_ymm; reg <= m_reg_info.last_ymm;
781            ++reg) {
782         if (!CopyYMMtoXSTATE(reg, byte_order)) {
783           error.SetErrorStringWithFormat(
784               "NativeRegisterContextLinux_x86_64::%s "
785               "CopyYMMtoXSTATE() failed for reg num "
786               "%" PRIu32,
787               __FUNCTION__, reg);
788           return error;
789         }
790       }
791     }
792 
793     if (IsCPUFeatureAvailable(RegSet::mpx)) {
794       for (uint32_t reg = m_reg_info.first_mpxr; reg <= m_reg_info.last_mpxc;
795            ++reg) {
796         if (!CopyMPXtoXSTATE(reg)) {
797           error.SetErrorStringWithFormat(
798               "NativeRegisterContextLinux_x86_64::%s "
799               "CopyMPXtoXSTATE() failed for reg num "
800               "%" PRIu32,
801               __FUNCTION__, reg);
802           return error;
803         }
804       }
805     }
806   }
807 
808   return error;
809 }
810 
811 bool NativeRegisterContextLinux_x86_64::IsCPUFeatureAvailable(
812     RegSet feature_code) const {
813   if (m_xstate_type == XStateType::Invalid) {
814     if (const_cast<NativeRegisterContextLinux_x86_64 *>(this)->ReadFPR().Fail())
815       return false;
816   }
817   switch (feature_code) {
818   case RegSet::gpr:
819   case RegSet::fpu:
820     return true;
821   case RegSet::avx: // Check if CPU has AVX and if there is kernel support, by
822                     // reading in the XCR0 area of XSAVE.
823     if ((m_fpr.xstate.xsave.i387.xcr0 & mask_XSTATE_AVX) == mask_XSTATE_AVX)
824       return true;
825      break;
826   case RegSet::mpx: // Check if CPU has MPX and if there is kernel support, by
827                     // reading in the XCR0 area of XSAVE.
828     if ((m_fpr.xstate.xsave.i387.xcr0 & mask_XSTATE_MPX) == mask_XSTATE_MPX)
829       return true;
830     break;
831   }
832   return false;
833 }
834 
835 bool NativeRegisterContextLinux_x86_64::IsRegisterSetAvailable(
836     uint32_t set_index) const {
837   uint32_t num_sets = k_num_register_sets - k_num_extended_register_sets;
838 
839   switch (static_cast<RegSet>(set_index)) {
840   case RegSet::gpr:
841   case RegSet::fpu:
842     return (set_index < num_sets);
843   case RegSet::avx:
844     return IsCPUFeatureAvailable(RegSet::avx);
845   case RegSet::mpx:
846     return IsCPUFeatureAvailable(RegSet::mpx);
847   }
848   return false;
849 }
850 
851 bool NativeRegisterContextLinux_x86_64::IsGPR(uint32_t reg_index) const {
852   // GPRs come first.
853   return reg_index <= m_reg_info.last_gpr;
854 }
855 
856 bool NativeRegisterContextLinux_x86_64::IsFPR(uint32_t reg_index) const {
857   return (m_reg_info.first_fpr <= reg_index &&
858           reg_index <= m_reg_info.last_fpr);
859 }
860 
861 Status NativeRegisterContextLinux_x86_64::WriteFPR() {
862   switch (m_xstate_type) {
863   case XStateType::FXSAVE:
864     return WriteRegisterSet(
865         &m_iovec, sizeof(m_fpr.xstate.xsave),
866         fxsr_regset(GetRegisterInfoInterface().GetTargetArchitecture()));
867   case XStateType::XSAVE:
868     return WriteRegisterSet(&m_iovec, sizeof(m_fpr.xstate.xsave),
869                             NT_X86_XSTATE);
870   default:
871     return Status("Unrecognized FPR type.");
872   }
873 }
874 
875 bool NativeRegisterContextLinux_x86_64::IsAVX(uint32_t reg_index) const {
876   if (!IsCPUFeatureAvailable(RegSet::avx))
877     return false;
878   return (m_reg_info.first_ymm <= reg_index &&
879           reg_index <= m_reg_info.last_ymm);
880 }
881 
882 bool NativeRegisterContextLinux_x86_64::CopyXSTATEtoYMM(
883     uint32_t reg_index, lldb::ByteOrder byte_order) {
884   if (!IsAVX(reg_index))
885     return false;
886 
887   if (byte_order == lldb::eByteOrderLittle) {
888     ::memcpy(m_ymm_set.ymm[reg_index - m_reg_info.first_ymm].bytes,
889              m_fpr.xstate.fxsave.xmm[reg_index - m_reg_info.first_ymm].bytes,
890              sizeof(XMMReg));
891     ::memcpy(m_ymm_set.ymm[reg_index - m_reg_info.first_ymm].bytes +
892                  sizeof(XMMReg),
893              m_fpr.xstate.xsave.ymmh[reg_index - m_reg_info.first_ymm].bytes,
894              sizeof(YMMHReg));
895     return true;
896   }
897 
898   if (byte_order == lldb::eByteOrderBig) {
899     ::memcpy(m_ymm_set.ymm[reg_index - m_reg_info.first_ymm].bytes +
900                  sizeof(XMMReg),
901              m_fpr.xstate.fxsave.xmm[reg_index - m_reg_info.first_ymm].bytes,
902              sizeof(XMMReg));
903     ::memcpy(m_ymm_set.ymm[reg_index - m_reg_info.first_ymm].bytes,
904              m_fpr.xstate.xsave.ymmh[reg_index - m_reg_info.first_ymm].bytes,
905              sizeof(YMMHReg));
906     return true;
907   }
908   return false; // unsupported or invalid byte order
909 }
910 
911 bool NativeRegisterContextLinux_x86_64::CopyYMMtoXSTATE(
912     uint32_t reg, lldb::ByteOrder byte_order) {
913   if (!IsAVX(reg))
914     return false;
915 
916   if (byte_order == lldb::eByteOrderLittle) {
917     ::memcpy(m_fpr.xstate.fxsave.xmm[reg - m_reg_info.first_ymm].bytes,
918              m_ymm_set.ymm[reg - m_reg_info.first_ymm].bytes, sizeof(XMMReg));
919     ::memcpy(m_fpr.xstate.xsave.ymmh[reg - m_reg_info.first_ymm].bytes,
920              m_ymm_set.ymm[reg - m_reg_info.first_ymm].bytes + sizeof(XMMReg),
921              sizeof(YMMHReg));
922     return true;
923   }
924 
925   if (byte_order == lldb::eByteOrderBig) {
926     ::memcpy(m_fpr.xstate.fxsave.xmm[reg - m_reg_info.first_ymm].bytes,
927              m_ymm_set.ymm[reg - m_reg_info.first_ymm].bytes + sizeof(XMMReg),
928              sizeof(XMMReg));
929     ::memcpy(m_fpr.xstate.xsave.ymmh[reg - m_reg_info.first_ymm].bytes,
930              m_ymm_set.ymm[reg - m_reg_info.first_ymm].bytes, sizeof(YMMHReg));
931     return true;
932   }
933   return false; // unsupported or invalid byte order
934 }
935 
936 void *NativeRegisterContextLinux_x86_64::GetFPRBuffer() {
937   switch (m_xstate_type) {
938   case XStateType::FXSAVE:
939     return &m_fpr.xstate.fxsave;
940   case XStateType::XSAVE:
941     return &m_iovec;
942   default:
943     return nullptr;
944   }
945 }
946 
947 size_t NativeRegisterContextLinux_x86_64::GetFPRSize() {
948   switch (m_xstate_type) {
949   case XStateType::FXSAVE:
950     return sizeof(m_fpr.xstate.fxsave);
951   case XStateType::XSAVE:
952     return sizeof(m_iovec);
953   default:
954     return 0;
955   }
956 }
957 
958 Status NativeRegisterContextLinux_x86_64::ReadFPR() {
959   Status error;
960 
961   // Probe XSAVE and if it is not supported fall back to FXSAVE.
962   if (m_xstate_type != XStateType::FXSAVE) {
963     error =
964         ReadRegisterSet(&m_iovec, sizeof(m_fpr.xstate.xsave), NT_X86_XSTATE);
965     if (!error.Fail()) {
966       m_xstate_type = XStateType::XSAVE;
967       return error;
968     }
969   }
970   error = ReadRegisterSet(
971       &m_iovec, sizeof(m_fpr.xstate.xsave),
972       fxsr_regset(GetRegisterInfoInterface().GetTargetArchitecture()));
973   if (!error.Fail()) {
974     m_xstate_type = XStateType::FXSAVE;
975     return error;
976   }
977   return Status("Unrecognized FPR type.");
978 }
979 
980 bool NativeRegisterContextLinux_x86_64::IsMPX(uint32_t reg_index) const {
981   if (!IsCPUFeatureAvailable(RegSet::mpx))
982     return false;
983   return (m_reg_info.first_mpxr <= reg_index &&
984           reg_index <= m_reg_info.last_mpxc);
985 }
986 
987 bool NativeRegisterContextLinux_x86_64::CopyXSTATEtoMPX(uint32_t reg) {
988   if (!IsMPX(reg))
989     return false;
990 
991   if (reg >= m_reg_info.first_mpxr && reg <= m_reg_info.last_mpxr) {
992     ::memcpy(m_mpx_set.mpxr[reg - m_reg_info.first_mpxr].bytes,
993              m_fpr.xstate.xsave.mpxr[reg - m_reg_info.first_mpxr].bytes,
994              sizeof(MPXReg));
995   } else {
996     ::memcpy(m_mpx_set.mpxc[reg - m_reg_info.first_mpxc].bytes,
997              m_fpr.xstate.xsave.mpxc[reg - m_reg_info.first_mpxc].bytes,
998              sizeof(MPXCsr));
999   }
1000   return true;
1001 }
1002 
1003 bool NativeRegisterContextLinux_x86_64::CopyMPXtoXSTATE(uint32_t reg) {
1004   if (!IsMPX(reg))
1005     return false;
1006 
1007   if (reg >= m_reg_info.first_mpxr && reg <= m_reg_info.last_mpxr) {
1008     ::memcpy(m_fpr.xstate.xsave.mpxr[reg - m_reg_info.first_mpxr].bytes,
1009              m_mpx_set.mpxr[reg - m_reg_info.first_mpxr].bytes, sizeof(MPXReg));
1010   } else {
1011     ::memcpy(m_fpr.xstate.xsave.mpxc[reg - m_reg_info.first_mpxc].bytes,
1012              m_mpx_set.mpxc[reg - m_reg_info.first_mpxc].bytes, sizeof(MPXCsr));
1013   }
1014   return true;
1015 }
1016 
1017 Status NativeRegisterContextLinux_x86_64::IsWatchpointHit(uint32_t wp_index,
1018                                                           bool &is_hit) {
1019   if (wp_index >= NumSupportedHardwareWatchpoints())
1020     return Status("Watchpoint index out of range");
1021 
1022   RegisterValue reg_value;
1023   Status error = ReadRegisterRaw(m_reg_info.first_dr + 6, reg_value);
1024   if (error.Fail()) {
1025     is_hit = false;
1026     return error;
1027   }
1028 
1029   uint64_t status_bits = reg_value.GetAsUInt64();
1030 
1031   is_hit = status_bits & (1 << wp_index);
1032 
1033   return error;
1034 }
1035 
1036 Status NativeRegisterContextLinux_x86_64::GetWatchpointHitIndex(
1037     uint32_t &wp_index, lldb::addr_t trap_addr) {
1038   uint32_t num_hw_wps = NumSupportedHardwareWatchpoints();
1039   for (wp_index = 0; wp_index < num_hw_wps; ++wp_index) {
1040     bool is_hit;
1041     Status error = IsWatchpointHit(wp_index, is_hit);
1042     if (error.Fail()) {
1043       wp_index = LLDB_INVALID_INDEX32;
1044       return error;
1045     } else if (is_hit) {
1046       return error;
1047     }
1048   }
1049   wp_index = LLDB_INVALID_INDEX32;
1050   return Status();
1051 }
1052 
1053 Status NativeRegisterContextLinux_x86_64::IsWatchpointVacant(uint32_t wp_index,
1054                                                              bool &is_vacant) {
1055   if (wp_index >= NumSupportedHardwareWatchpoints())
1056     return Status("Watchpoint index out of range");
1057 
1058   RegisterValue reg_value;
1059   Status error = ReadRegisterRaw(m_reg_info.first_dr + 7, reg_value);
1060   if (error.Fail()) {
1061     is_vacant = false;
1062     return error;
1063   }
1064 
1065   uint64_t control_bits = reg_value.GetAsUInt64();
1066 
1067   is_vacant = !(control_bits & (1 << (2 * wp_index)));
1068 
1069   return error;
1070 }
1071 
1072 Status NativeRegisterContextLinux_x86_64::SetHardwareWatchpointWithIndex(
1073     lldb::addr_t addr, size_t size, uint32_t watch_flags, uint32_t wp_index) {
1074 
1075   if (wp_index >= NumSupportedHardwareWatchpoints())
1076     return Status("Watchpoint index out of range");
1077 
1078   // Read only watchpoints aren't supported on x86_64. Fall back to read/write
1079   // waitchpoints instead.
1080   // TODO: Add logic to detect when a write happens and ignore that watchpoint
1081   // hit.
1082   if (watch_flags == 0x2)
1083     watch_flags = 0x3;
1084 
1085   if (watch_flags != 0x1 && watch_flags != 0x3)
1086     return Status("Invalid read/write bits for watchpoint");
1087 
1088   if (size != 1 && size != 2 && size != 4 && size != 8)
1089     return Status("Invalid size for watchpoint");
1090 
1091   bool is_vacant;
1092   Status error = IsWatchpointVacant(wp_index, is_vacant);
1093   if (error.Fail())
1094     return error;
1095   if (!is_vacant)
1096     return Status("Watchpoint index not vacant");
1097 
1098   RegisterValue reg_value;
1099   error = ReadRegisterRaw(m_reg_info.first_dr + 7, reg_value);
1100   if (error.Fail())
1101     return error;
1102 
1103   // for watchpoints 0, 1, 2, or 3, respectively,
1104   // set bits 1, 3, 5, or 7
1105   uint64_t enable_bit = 1 << (2 * wp_index);
1106 
1107   // set bits 16-17, 20-21, 24-25, or 28-29
1108   // with 0b01 for write, and 0b11 for read/write
1109   uint64_t rw_bits = watch_flags << (16 + 4 * wp_index);
1110 
1111   // set bits 18-19, 22-23, 26-27, or 30-31
1112   // with 0b00, 0b01, 0b10, or 0b11
1113   // for 1, 2, 8 (if supported), or 4 bytes, respectively
1114   uint64_t size_bits = (size == 8 ? 0x2 : size - 1) << (18 + 4 * wp_index);
1115 
1116   uint64_t bit_mask = (0x3 << (2 * wp_index)) | (0xF << (16 + 4 * wp_index));
1117 
1118   uint64_t control_bits = reg_value.GetAsUInt64() & ~bit_mask;
1119 
1120   control_bits |= enable_bit | rw_bits | size_bits;
1121 
1122   error = WriteRegisterRaw(m_reg_info.first_dr + wp_index, RegisterValue(addr));
1123   if (error.Fail())
1124     return error;
1125 
1126   error =
1127       WriteRegisterRaw(m_reg_info.first_dr + 7, RegisterValue(control_bits));
1128   if (error.Fail())
1129     return error;
1130 
1131   error.Clear();
1132   return error;
1133 }
1134 
1135 bool NativeRegisterContextLinux_x86_64::ClearHardwareWatchpoint(
1136     uint32_t wp_index) {
1137   if (wp_index >= NumSupportedHardwareWatchpoints())
1138     return false;
1139 
1140   RegisterValue reg_value;
1141 
1142   // for watchpoints 0, 1, 2, or 3, respectively,
1143   // clear bits 0, 1, 2, or 3 of the debug status register (DR6)
1144   Status error = ReadRegisterRaw(m_reg_info.first_dr + 6, reg_value);
1145   if (error.Fail())
1146     return false;
1147   uint64_t bit_mask = 1 << wp_index;
1148   uint64_t status_bits = reg_value.GetAsUInt64() & ~bit_mask;
1149   error = WriteRegisterRaw(m_reg_info.first_dr + 6, RegisterValue(status_bits));
1150   if (error.Fail())
1151     return false;
1152 
1153   // for watchpoints 0, 1, 2, or 3, respectively,
1154   // clear bits {0-1,16-19}, {2-3,20-23}, {4-5,24-27}, or {6-7,28-31}
1155   // of the debug control register (DR7)
1156   error = ReadRegisterRaw(m_reg_info.first_dr + 7, reg_value);
1157   if (error.Fail())
1158     return false;
1159   bit_mask = (0x3 << (2 * wp_index)) | (0xF << (16 + 4 * wp_index));
1160   uint64_t control_bits = reg_value.GetAsUInt64() & ~bit_mask;
1161   return WriteRegisterRaw(m_reg_info.first_dr + 7, RegisterValue(control_bits))
1162       .Success();
1163 }
1164 
1165 Status NativeRegisterContextLinux_x86_64::ClearAllHardwareWatchpoints() {
1166   RegisterValue reg_value;
1167 
1168   // clear bits {0-4} of the debug status register (DR6)
1169   Status error = ReadRegisterRaw(m_reg_info.first_dr + 6, reg_value);
1170   if (error.Fail())
1171     return error;
1172   uint64_t bit_mask = 0xF;
1173   uint64_t status_bits = reg_value.GetAsUInt64() & ~bit_mask;
1174   error = WriteRegisterRaw(m_reg_info.first_dr + 6, RegisterValue(status_bits));
1175   if (error.Fail())
1176     return error;
1177 
1178   // clear bits {0-7,16-31} of the debug control register (DR7)
1179   error = ReadRegisterRaw(m_reg_info.first_dr + 7, reg_value);
1180   if (error.Fail())
1181     return error;
1182   bit_mask = 0xFF | (0xFFFF << 16);
1183   uint64_t control_bits = reg_value.GetAsUInt64() & ~bit_mask;
1184   return WriteRegisterRaw(m_reg_info.first_dr + 7, RegisterValue(control_bits));
1185 }
1186 
1187 uint32_t NativeRegisterContextLinux_x86_64::SetHardwareWatchpoint(
1188     lldb::addr_t addr, size_t size, uint32_t watch_flags) {
1189   Log *log(GetLogIfAllCategoriesSet(LIBLLDB_LOG_WATCHPOINTS));
1190   const uint32_t num_hw_watchpoints = NumSupportedHardwareWatchpoints();
1191   for (uint32_t wp_index = 0; wp_index < num_hw_watchpoints; ++wp_index) {
1192     bool is_vacant;
1193     Status error = IsWatchpointVacant(wp_index, is_vacant);
1194     if (is_vacant) {
1195       error = SetHardwareWatchpointWithIndex(addr, size, watch_flags, wp_index);
1196       if (error.Success())
1197         return wp_index;
1198     }
1199     if (error.Fail() && log) {
1200       log->Printf("NativeRegisterContextLinux_x86_64::%s Error: %s",
1201                   __FUNCTION__, error.AsCString());
1202     }
1203   }
1204   return LLDB_INVALID_INDEX32;
1205 }
1206 
1207 lldb::addr_t
1208 NativeRegisterContextLinux_x86_64::GetWatchpointAddress(uint32_t wp_index) {
1209   if (wp_index >= NumSupportedHardwareWatchpoints())
1210     return LLDB_INVALID_ADDRESS;
1211   RegisterValue reg_value;
1212   if (ReadRegisterRaw(m_reg_info.first_dr + wp_index, reg_value).Fail())
1213     return LLDB_INVALID_ADDRESS;
1214   return reg_value.GetAsUInt64();
1215 }
1216 
1217 uint32_t NativeRegisterContextLinux_x86_64::NumSupportedHardwareWatchpoints() {
1218   // Available debug address registers: dr0, dr1, dr2, dr3
1219   return 4;
1220 }
1221 
1222 #endif // defined(__i386__) || defined(__x86_64__)
1223