llvm-project/lldb/source/Plugins/Process/NetBSD/NativeRegisterContextNetBSD_x86_64.cpp
Kamil Rytarowski f07a9995e8 Add support for tracing hello-world application on NetBSD
Summary:
This patch is a stripped down from features a NetBSD process
code (patch is kept under 2k LOC). This code has assumption that
there is only one thread within a debugged process. The only
debugger trap supported is software breakpoint (TRAP_BRKPT).
The generic platform code requires to add dummy function for
watchpoints etc. These functions are currently empty.
This code is not the final platform support as is and it's treated as
a base to extend, refactor and address issues afterwards.

Supported features:
 - handle software breakpoints,
 - correctly attach to a tracee,
 - support NetBSD specific ptrace(2),
 - monitor process termination,
 - monitor SIGTRAP events,
 - monitor SIGSTOP events,
 - monitor other signals events,
 - resume the whole process,
 - get memory region info perms,
 - read memory from tracee,
 - write memory to tracee,
 - read ELF AUXV,
 - x86_64 GPR read and write code

For the generic framework include:
 - halt,
 - detach,
 - signal,
 - kill,
 - allocatememory,
 - deallocatememory,
 - update threads,
 - getarchitecture,
 - getfileloadaddress,
 - and others.

This code has preliminary AddThread code.

Out of interest in this patch:
 - exec() traps,
 - hardware debug register traps,
 - single step trap,
 - thread creation/termination trap,
 - process fork(2), vfork(2) and vfork(2) done traps,
 - syscall entry and exit trap,
 - threads,
 - FPR registers,
 - retrieving tracee's thread name,
 - non x86_64 support.

This code can be used to start a hello world application and trace it.

This code can be used by other BSD systems as a starting point to get similar
capabilities.

Sponsored by <The NetBSD Foundation>

Reviewers: emaste, joerg, kettenis, labath

Subscribers: mgorny, #lldb

Tags: #lldb

Differential Revision: https://reviews.llvm.org/D31374

llvm-svn: 298953
2017-03-28 22:43:17 +00:00

478 lines
15 KiB
C++

//===-- NativeRegisterContextNetBSD_x86_64.cpp ---------------*- C++ -*-===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
#if defined(__x86_64__)
#include "NativeRegisterContextNetBSD_x86_64.h"
#include "lldb/Core/RegisterValue.h"
#include "lldb/Host/HostInfo.h"
#include "lldb/Utility/DataBufferHeap.h"
#include "lldb/Utility/Error.h"
#include "lldb/Utility/Log.h"
#include "Plugins/Process/Utility/RegisterContextNetBSD_x86_64.h"
#include <elf.h>
using namespace lldb_private;
using namespace lldb_private::process_netbsd;
// ----------------------------------------------------------------------------
// Private namespace.
// ----------------------------------------------------------------------------
namespace {
// x86 64-bit general purpose registers.
static const uint32_t g_gpr_regnums_x86_64[] = {
lldb_rax_x86_64, lldb_rbx_x86_64, lldb_rcx_x86_64, lldb_rdx_x86_64,
lldb_rdi_x86_64, lldb_rsi_x86_64, lldb_rbp_x86_64, lldb_rsp_x86_64,
lldb_r8_x86_64, lldb_r9_x86_64, lldb_r10_x86_64, lldb_r11_x86_64,
lldb_r12_x86_64, lldb_r13_x86_64, lldb_r14_x86_64, lldb_r15_x86_64,
lldb_rip_x86_64, lldb_rflags_x86_64, lldb_cs_x86_64, lldb_fs_x86_64,
lldb_gs_x86_64, lldb_ss_x86_64, lldb_ds_x86_64, lldb_es_x86_64,
lldb_eax_x86_64, lldb_ebx_x86_64, lldb_ecx_x86_64, lldb_edx_x86_64,
lldb_edi_x86_64, lldb_esi_x86_64, lldb_ebp_x86_64, lldb_esp_x86_64,
lldb_r8d_x86_64, // Low 32 bits or r8
lldb_r9d_x86_64, // Low 32 bits or r9
lldb_r10d_x86_64, // Low 32 bits or r10
lldb_r11d_x86_64, // Low 32 bits or r11
lldb_r12d_x86_64, // Low 32 bits or r12
lldb_r13d_x86_64, // Low 32 bits or r13
lldb_r14d_x86_64, // Low 32 bits or r14
lldb_r15d_x86_64, // Low 32 bits or r15
lldb_ax_x86_64, lldb_bx_x86_64, lldb_cx_x86_64, lldb_dx_x86_64,
lldb_di_x86_64, lldb_si_x86_64, lldb_bp_x86_64, lldb_sp_x86_64,
lldb_r8w_x86_64, // Low 16 bits or r8
lldb_r9w_x86_64, // Low 16 bits or r9
lldb_r10w_x86_64, // Low 16 bits or r10
lldb_r11w_x86_64, // Low 16 bits or r11
lldb_r12w_x86_64, // Low 16 bits or r12
lldb_r13w_x86_64, // Low 16 bits or r13
lldb_r14w_x86_64, // Low 16 bits or r14
lldb_r15w_x86_64, // Low 16 bits or r15
lldb_ah_x86_64, lldb_bh_x86_64, lldb_ch_x86_64, lldb_dh_x86_64,
lldb_al_x86_64, lldb_bl_x86_64, lldb_cl_x86_64, lldb_dl_x86_64,
lldb_dil_x86_64, lldb_sil_x86_64, lldb_bpl_x86_64, lldb_spl_x86_64,
lldb_r8l_x86_64, // Low 8 bits or r8
lldb_r9l_x86_64, // Low 8 bits or r9
lldb_r10l_x86_64, // Low 8 bits or r10
lldb_r11l_x86_64, // Low 8 bits or r11
lldb_r12l_x86_64, // Low 8 bits or r12
lldb_r13l_x86_64, // Low 8 bits or r13
lldb_r14l_x86_64, // Low 8 bits or r14
lldb_r15l_x86_64, // Low 8 bits or r15
LLDB_INVALID_REGNUM // register sets need to end with this flag
};
static_assert((sizeof(g_gpr_regnums_x86_64) / sizeof(g_gpr_regnums_x86_64[0])) -
1 ==
k_num_gpr_registers_x86_64,
"g_gpr_regnums_x86_64 has wrong number of register infos");
// Number of register sets provided by this context.
enum { k_num_extended_register_sets = 2, k_num_register_sets = 4 };
// Register sets for x86 64-bit.
static const RegisterSet g_reg_sets_x86_64[k_num_register_sets] = {
{"General Purpose Registers", "gpr", k_num_gpr_registers_x86_64,
g_gpr_regnums_x86_64},
};
#define REG_CONTEXT_SIZE (GetRegisterInfoInterface().GetGPRSize())
} // namespace
NativeRegisterContextNetBSD *
NativeRegisterContextNetBSD::CreateHostNativeRegisterContextNetBSD(
const ArchSpec &target_arch, NativeThreadProtocol &native_thread,
uint32_t concrete_frame_idx) {
return new NativeRegisterContextNetBSD_x86_64(target_arch, native_thread,
concrete_frame_idx);
}
// ----------------------------------------------------------------------------
// NativeRegisterContextNetBSD_x86_64 members.
// ----------------------------------------------------------------------------
static RegisterInfoInterface *
CreateRegisterInfoInterface(const ArchSpec &target_arch) {
assert((HostInfo::GetArchitecture().GetAddressByteSize() == 8) &&
"Register setting path assumes this is a 64-bit host");
// X86_64 hosts know how to work with 64-bit and 32-bit EXEs using the
// x86_64 register context.
return new RegisterContextNetBSD_x86_64(target_arch);
}
NativeRegisterContextNetBSD_x86_64::NativeRegisterContextNetBSD_x86_64(
const ArchSpec &target_arch, NativeThreadProtocol &native_thread,
uint32_t concrete_frame_idx)
: NativeRegisterContextNetBSD(native_thread, concrete_frame_idx,
CreateRegisterInfoInterface(target_arch)),
m_gpr_x86_64() {}
// CONSIDER after local and llgs debugging are merged, register set support can
// be moved into a base x86-64 class with IsRegisterSetAvailable made virtual.
uint32_t NativeRegisterContextNetBSD_x86_64::GetRegisterSetCount() const {
uint32_t sets = 0;
for (uint32_t set_index = 0; set_index < k_num_register_sets; ++set_index) {
if (GetSetForNativeRegNum(set_index) != -1)
++sets;
}
return sets;
}
const RegisterSet *
NativeRegisterContextNetBSD_x86_64::GetRegisterSet(uint32_t set_index) const {
switch (GetRegisterInfoInterface().GetTargetArchitecture().GetMachine()) {
case llvm::Triple::x86_64:
return &g_reg_sets_x86_64[set_index];
default:
assert(false && "Unhandled target architecture.");
return nullptr;
}
return nullptr;
}
int NativeRegisterContextNetBSD_x86_64::GetSetForNativeRegNum(
int reg_num) const {
if (reg_num < lldb_fctrl_x86_64)
return GPRegSet;
else
return -1;
}
int NativeRegisterContextNetBSD_x86_64::ReadRegisterSet(uint32_t set) {
switch (set) {
case GPRegSet:
ReadGPR();
return 0;
default:
break;
}
return -1;
}
int NativeRegisterContextNetBSD_x86_64::WriteRegisterSet(uint32_t set) {
switch (set) {
case GPRegSet:
WriteGPR();
return 0;
default:
break;
}
return -1;
}
Error NativeRegisterContextNetBSD_x86_64::ReadRegister(
const RegisterInfo *reg_info, RegisterValue &reg_value) {
Error error;
if (!reg_info) {
error.SetErrorString("reg_info NULL");
return error;
}
const uint32_t reg = reg_info->kinds[lldb::eRegisterKindLLDB];
if (reg == LLDB_INVALID_REGNUM) {
// This is likely an internal register for lldb use only and should not be
// directly queried.
error.SetErrorStringWithFormat("register \"%s\" is an internal-only lldb "
"register, cannot read directly",
reg_info->name);
return error;
}
int set = GetSetForNativeRegNum(reg);
if (set == -1) {
// This is likely an internal register for lldb use only and should not be
// directly queried.
error.SetErrorStringWithFormat("register \"%s\" is in unrecognized set",
reg_info->name);
return error;
}
if (ReadRegisterSet(set) != 0) {
// This is likely an internal register for lldb use only and should not be
// directly queried.
error.SetErrorStringWithFormat(
"reading register set for register \"%s\" failed", reg_info->name);
return error;
}
switch (reg) {
case lldb_rax_x86_64:
reg_value = (uint64_t)m_gpr_x86_64.regs[_REG_RAX];
break;
case lldb_rbx_x86_64:
reg_value = (uint64_t)m_gpr_x86_64.regs[_REG_RBX];
break;
case lldb_rcx_x86_64:
reg_value = (uint64_t)m_gpr_x86_64.regs[_REG_RCX];
break;
case lldb_rdx_x86_64:
reg_value = (uint64_t)m_gpr_x86_64.regs[_REG_RDX];
break;
case lldb_rdi_x86_64:
reg_value = (uint64_t)m_gpr_x86_64.regs[_REG_RDI];
break;
case lldb_rsi_x86_64:
reg_value = (uint64_t)m_gpr_x86_64.regs[_REG_RSI];
break;
case lldb_rbp_x86_64:
reg_value = (uint64_t)m_gpr_x86_64.regs[_REG_RBP];
break;
case lldb_rsp_x86_64:
reg_value = (uint64_t)m_gpr_x86_64.regs[_REG_RSP];
break;
case lldb_r8_x86_64:
reg_value = (uint64_t)m_gpr_x86_64.regs[_REG_R8];
break;
case lldb_r9_x86_64:
reg_value = (uint64_t)m_gpr_x86_64.regs[_REG_R9];
break;
case lldb_r10_x86_64:
reg_value = (uint64_t)m_gpr_x86_64.regs[_REG_R10];
break;
case lldb_r11_x86_64:
reg_value = (uint64_t)m_gpr_x86_64.regs[_REG_R11];
break;
case lldb_r12_x86_64:
reg_value = (uint64_t)m_gpr_x86_64.regs[_REG_R12];
break;
case lldb_r13_x86_64:
reg_value = (uint64_t)m_gpr_x86_64.regs[_REG_R13];
break;
case lldb_r14_x86_64:
reg_value = (uint64_t)m_gpr_x86_64.regs[_REG_R14];
break;
case lldb_r15_x86_64:
reg_value = (uint64_t)m_gpr_x86_64.regs[_REG_R15];
break;
case lldb_rip_x86_64:
reg_value = (uint64_t)m_gpr_x86_64.regs[_REG_RIP];
break;
case lldb_rflags_x86_64:
reg_value = (uint64_t)m_gpr_x86_64.regs[_REG_RFLAGS];
break;
case lldb_cs_x86_64:
reg_value = (uint64_t)m_gpr_x86_64.regs[_REG_CS];
break;
case lldb_fs_x86_64:
reg_value = (uint64_t)m_gpr_x86_64.regs[_REG_FS];
break;
case lldb_gs_x86_64:
reg_value = (uint64_t)m_gpr_x86_64.regs[_REG_GS];
break;
case lldb_ss_x86_64:
reg_value = (uint64_t)m_gpr_x86_64.regs[_REG_SS];
break;
case lldb_ds_x86_64:
reg_value = (uint64_t)m_gpr_x86_64.regs[_REG_DS];
break;
case lldb_es_x86_64:
reg_value = (uint64_t)m_gpr_x86_64.regs[_REG_ES];
break;
}
return error;
}
Error NativeRegisterContextNetBSD_x86_64::WriteRegister(
const RegisterInfo *reg_info, const RegisterValue &reg_value) {
Error error;
if (!reg_info) {
error.SetErrorString("reg_info NULL");
return error;
}
const uint32_t reg = reg_info->kinds[lldb::eRegisterKindLLDB];
if (reg == LLDB_INVALID_REGNUM) {
// This is likely an internal register for lldb use only and should not be
// directly queried.
error.SetErrorStringWithFormat("register \"%s\" is an internal-only lldb "
"register, cannot read directly",
reg_info->name);
return error;
}
int set = GetSetForNativeRegNum(reg);
if (set == -1) {
// This is likely an internal register for lldb use only and should not be
// directly queried.
error.SetErrorStringWithFormat("register \"%s\" is in unrecognized set",
reg_info->name);
return error;
}
if (ReadRegisterSet(set) != 0) {
// This is likely an internal register for lldb use only and should not be
// directly queried.
error.SetErrorStringWithFormat(
"reading register set for register \"%s\" failed", reg_info->name);
return error;
}
switch (reg) {
case lldb_rax_x86_64:
m_gpr_x86_64.regs[_REG_RAX] = reg_value.GetAsUInt64();
break;
case lldb_rbx_x86_64:
m_gpr_x86_64.regs[_REG_RBX] = reg_value.GetAsUInt64();
break;
case lldb_rcx_x86_64:
m_gpr_x86_64.regs[_REG_RCX] = reg_value.GetAsUInt64();
break;
case lldb_rdx_x86_64:
m_gpr_x86_64.regs[_REG_RDX] = reg_value.GetAsUInt64();
break;
case lldb_rdi_x86_64:
m_gpr_x86_64.regs[_REG_RDI] = reg_value.GetAsUInt64();
break;
case lldb_rsi_x86_64:
m_gpr_x86_64.regs[_REG_RSI] = reg_value.GetAsUInt64();
break;
case lldb_rbp_x86_64:
m_gpr_x86_64.regs[_REG_RBP] = reg_value.GetAsUInt64();
break;
case lldb_rsp_x86_64:
m_gpr_x86_64.regs[_REG_RSP] = reg_value.GetAsUInt64();
break;
case lldb_r8_x86_64:
m_gpr_x86_64.regs[_REG_R8] = reg_value.GetAsUInt64();
break;
case lldb_r9_x86_64:
m_gpr_x86_64.regs[_REG_R9] = reg_value.GetAsUInt64();
break;
case lldb_r10_x86_64:
m_gpr_x86_64.regs[_REG_R10] = reg_value.GetAsUInt64();
break;
case lldb_r11_x86_64:
m_gpr_x86_64.regs[_REG_R11] = reg_value.GetAsUInt64();
break;
case lldb_r12_x86_64:
m_gpr_x86_64.regs[_REG_R12] = reg_value.GetAsUInt64();
break;
case lldb_r13_x86_64:
m_gpr_x86_64.regs[_REG_R13] = reg_value.GetAsUInt64();
break;
case lldb_r14_x86_64:
m_gpr_x86_64.regs[_REG_R14] = reg_value.GetAsUInt64();
break;
case lldb_r15_x86_64:
m_gpr_x86_64.regs[_REG_R15] = reg_value.GetAsUInt64();
break;
case lldb_rip_x86_64:
m_gpr_x86_64.regs[_REG_RIP] = reg_value.GetAsUInt64();
break;
case lldb_rflags_x86_64:
m_gpr_x86_64.regs[_REG_RFLAGS] = reg_value.GetAsUInt64();
break;
case lldb_cs_x86_64:
m_gpr_x86_64.regs[_REG_CS] = reg_value.GetAsUInt64();
break;
case lldb_fs_x86_64:
m_gpr_x86_64.regs[_REG_FS] = reg_value.GetAsUInt64();
break;
case lldb_gs_x86_64:
m_gpr_x86_64.regs[_REG_GS] = reg_value.GetAsUInt64();
break;
case lldb_ss_x86_64:
m_gpr_x86_64.regs[_REG_SS] = reg_value.GetAsUInt64();
break;
case lldb_ds_x86_64:
m_gpr_x86_64.regs[_REG_DS] = reg_value.GetAsUInt64();
break;
case lldb_es_x86_64:
m_gpr_x86_64.regs[_REG_ES] = reg_value.GetAsUInt64();
break;
}
if (WriteRegisterSet(set) != 0)
error.SetErrorStringWithFormat("failed to write register set");
return error;
}
Error NativeRegisterContextNetBSD_x86_64::ReadAllRegisterValues(
lldb::DataBufferSP &data_sp) {
Error error;
data_sp.reset(new DataBufferHeap(REG_CONTEXT_SIZE, 0));
if (!data_sp) {
error.SetErrorStringWithFormat(
"failed to allocate DataBufferHeap instance of size %" PRIu64,
REG_CONTEXT_SIZE);
return error;
}
error = ReadGPR();
if (error.Fail())
return error;
uint8_t *dst = data_sp->GetBytes();
if (dst == nullptr) {
error.SetErrorStringWithFormat("DataBufferHeap instance of size %" PRIu64
" returned a null pointer",
REG_CONTEXT_SIZE);
return error;
}
::memcpy(dst, &m_gpr_x86_64, GetRegisterInfoInterface().GetGPRSize());
dst += GetRegisterInfoInterface().GetGPRSize();
RegisterValue value((uint64_t)-1);
const RegisterInfo *reg_info =
GetRegisterInfoInterface().GetDynamicRegisterInfo("orig_eax");
if (reg_info == nullptr)
reg_info = GetRegisterInfoInterface().GetDynamicRegisterInfo("orig_rax");
return error;
}
Error NativeRegisterContextNetBSD_x86_64::WriteAllRegisterValues(
const lldb::DataBufferSP &data_sp) {
Error error;
if (!data_sp) {
error.SetErrorStringWithFormat(
"NativeRegisterContextNetBSD_x86_64::%s invalid data_sp provided",
__FUNCTION__);
return error;
}
if (data_sp->GetByteSize() != REG_CONTEXT_SIZE) {
error.SetErrorStringWithFormat(
"NativeRegisterContextNetBSD_x86_64::%s data_sp contained mismatched "
"data size, expected %" PRIu64 ", actual %" PRIu64,
__FUNCTION__, REG_CONTEXT_SIZE, data_sp->GetByteSize());
return error;
}
uint8_t *src = data_sp->GetBytes();
if (src == nullptr) {
error.SetErrorStringWithFormat("NativeRegisterContextNetBSD_x86_64::%s "
"DataBuffer::GetBytes() returned a null "
"pointer",
__FUNCTION__);
return error;
}
::memcpy(&m_gpr_x86_64, src, GetRegisterInfoInterface().GetGPRSize());
error = WriteGPR();
if (error.Fail())
return error;
src += GetRegisterInfoInterface().GetGPRSize();
return error;
}
#endif // defined(__x86_64__)