309 changes: 132 additions & 177 deletions lldb/source/Plugins/Process/gdb-remote/ProcessGDBRemote.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -454,7 +454,7 @@ void ProcessGDBRemote::BuildDynamicRegisterInfo(bool force) {
return;

char packet[128];
uint32_t reg_offset = LLDB_INVALID_INDEX32;
std::vector<RemoteRegisterInfo> registers;
uint32_t reg_num = 0;
for (StringExtractorGDBRemote::ResponseType response_type =
StringExtractorGDBRemote::eResponse;
Expand All @@ -470,53 +470,25 @@ void ProcessGDBRemote::BuildDynamicRegisterInfo(bool force) {
if (response_type == StringExtractorGDBRemote::eResponse) {
llvm::StringRef name;
llvm::StringRef value;
ConstString reg_name;
ConstString alt_name;
ConstString set_name;
std::vector<uint32_t> value_regs;
std::vector<uint32_t> invalidate_regs;
std::vector<uint8_t> dwarf_opcode_bytes;
RegisterInfo reg_info = {
nullptr, // Name
nullptr, // Alt name
0, // byte size
reg_offset, // offset
eEncodingUint, // encoding
eFormatHex, // format
{
LLDB_INVALID_REGNUM, // eh_frame reg num
LLDB_INVALID_REGNUM, // DWARF reg num
LLDB_INVALID_REGNUM, // generic reg num
reg_num, // process plugin reg num
reg_num // native register number
},
nullptr,
nullptr,
nullptr, // Dwarf expression opcode bytes pointer
0 // Dwarf expression opcode bytes length
};
RemoteRegisterInfo reg_info;

while (response.GetNameColonValue(name, value)) {
if (name.equals("name")) {
reg_name.SetString(value);
reg_info.name.SetString(value);
} else if (name.equals("alt-name")) {
alt_name.SetString(value);
reg_info.alt_name.SetString(value);
} else if (name.equals("bitsize")) {
value.getAsInteger(0, reg_info.byte_size);
reg_info.byte_size /= CHAR_BIT;
if (!value.getAsInteger(0, reg_info.byte_size))
reg_info.byte_size /= CHAR_BIT;
} else if (name.equals("offset")) {
if (value.getAsInteger(0, reg_offset))
reg_offset = UINT32_MAX;
value.getAsInteger(0, reg_info.byte_offset);
} else if (name.equals("encoding")) {
const Encoding encoding = Args::StringToEncoding(value);
if (encoding != eEncodingInvalid)
reg_info.encoding = encoding;
} else if (name.equals("format")) {
Format format = eFormatInvalid;
if (OptionArgParser::ToFormat(value.str().c_str(), format, nullptr)
if (!OptionArgParser::ToFormat(value.str().c_str(), reg_info.format, nullptr)
.Success())
reg_info.format = format;
else {
reg_info.format =
llvm::StringSwitch<Format>(value)
.Case("binary", eFormatBinary)
Expand All @@ -533,59 +505,34 @@ void ProcessGDBRemote::BuildDynamicRegisterInfo(bool force) {
.Case("vector-uint64", eFormatVectorOfUInt64)
.Case("vector-uint128", eFormatVectorOfUInt128)
.Default(eFormatInvalid);
}
} else if (name.equals("set")) {
set_name.SetString(value);
reg_info.set_name.SetString(value);
} else if (name.equals("gcc") || name.equals("ehframe")) {
if (value.getAsInteger(0, reg_info.kinds[eRegisterKindEHFrame]))
reg_info.kinds[eRegisterKindEHFrame] = LLDB_INVALID_REGNUM;
value.getAsInteger(0, reg_info.regnum_ehframe);
} else if (name.equals("dwarf")) {
if (value.getAsInteger(0, reg_info.kinds[eRegisterKindDWARF]))
reg_info.kinds[eRegisterKindDWARF] = LLDB_INVALID_REGNUM;
value.getAsInteger(0, reg_info.regnum_dwarf);
} else if (name.equals("generic")) {
reg_info.kinds[eRegisterKindGeneric] =
Args::StringToGenericRegister(value);
value.getAsInteger(0, reg_info.regnum_generic);
} else if (name.equals("container-regs")) {
SplitCommaSeparatedRegisterNumberString(value, value_regs, 16);
SplitCommaSeparatedRegisterNumberString(value, reg_info.value_regs, 16);
} else if (name.equals("invalidate-regs")) {
SplitCommaSeparatedRegisterNumberString(value, invalidate_regs, 16);
SplitCommaSeparatedRegisterNumberString(value, reg_info.invalidate_regs, 16);
} else if (name.equals("dynamic_size_dwarf_expr_bytes")) {
size_t dwarf_opcode_len = value.size() / 2;
assert(dwarf_opcode_len > 0);

dwarf_opcode_bytes.resize(dwarf_opcode_len);
reg_info.dynamic_size_dwarf_len = dwarf_opcode_len;
reg_info.dwarf_opcode_bytes.resize(dwarf_opcode_len);

StringExtractor opcode_extractor(value);
uint32_t ret_val =
opcode_extractor.GetHexBytesAvail(dwarf_opcode_bytes);
opcode_extractor.GetHexBytesAvail(reg_info.dwarf_opcode_bytes);
assert(dwarf_opcode_len == ret_val);
UNUSED_IF_ASSERT_DISABLED(ret_val);
reg_info.dynamic_size_dwarf_expr_bytes = dwarf_opcode_bytes.data();
}
}

reg_info.byte_offset = reg_offset;
assert(reg_info.byte_size != 0);
reg_offset = LLDB_INVALID_INDEX32;
if (!value_regs.empty()) {
value_regs.push_back(LLDB_INVALID_REGNUM);
reg_info.value_regs = value_regs.data();
}
if (!invalidate_regs.empty()) {
invalidate_regs.push_back(LLDB_INVALID_REGNUM);
reg_info.invalidate_regs = invalidate_regs.data();
}

reg_info.name = reg_name.AsCString();
reg_info.alt_name = alt_name.AsCString();
// We have to make a temporary ABI here, and not use the GetABI because
// this code gets called in DidAttach, when the target architecture
// (and consequently the ABI we'll get from the process) may be wrong.
if (ABISP abi_sp = ABI::FindPlugin(shared_from_this(), arch_to_use))
abi_sp->AugmentRegisterInfo(reg_info);

m_register_info_sp->AddRegister(reg_info, set_name);
registers.push_back(reg_info);
} else {
break; // ensure exit before reg_num is incremented
}
Expand All @@ -594,8 +541,8 @@ void ProcessGDBRemote::BuildDynamicRegisterInfo(bool force) {
}
}

if (m_register_info_sp->GetNumRegisters() > 0) {
m_register_info_sp->Finalize(GetTarget().GetArchitecture());
if (!registers.empty()) {
AddRemoteRegisters(registers, arch_to_use);
return;
}

Expand Down Expand Up @@ -4384,53 +4331,24 @@ struct GdbServerTargetInfo {
};

bool ParseRegisters(XMLNode feature_node, GdbServerTargetInfo &target_info,
GDBRemoteDynamicRegisterInfo &dyn_reg_info, ABISP abi_sp,
uint32_t &reg_num_remote, uint32_t &reg_num_local) {
std::vector<RemoteRegisterInfo> &registers) {
if (!feature_node)
return false;

uint32_t reg_offset = LLDB_INVALID_INDEX32;
feature_node.ForEachChildElementWithName(
"reg", [&target_info, &dyn_reg_info, &reg_num_remote, &reg_num_local,
&reg_offset, &abi_sp](const XMLNode &reg_node) -> bool {
"reg", [&target_info, &registers](const XMLNode &reg_node) -> bool {
std::string gdb_group;
std::string gdb_type;
ConstString reg_name;
ConstString alt_name;
ConstString set_name;
std::vector<uint32_t> value_regs;
std::vector<uint32_t> invalidate_regs;
std::vector<uint8_t> dwarf_opcode_bytes;
RemoteRegisterInfo reg_info;
bool encoding_set = false;
bool format_set = false;
RegisterInfo reg_info = {
nullptr, // Name
nullptr, // Alt name
0, // byte size
reg_offset, // offset
eEncodingUint, // encoding
eFormatHex, // format
{
LLDB_INVALID_REGNUM, // eh_frame reg num
LLDB_INVALID_REGNUM, // DWARF reg num
LLDB_INVALID_REGNUM, // generic reg num
reg_num_remote, // process plugin reg num
reg_num_local // native register number
},
nullptr,
nullptr,
nullptr, // Dwarf Expression opcode bytes pointer
0 // Dwarf Expression opcode bytes length
};

reg_node.ForEachAttribute([&target_info, &gdb_group, &gdb_type,
&reg_name, &alt_name, &set_name, &value_regs,
&invalidate_regs, &encoding_set, &format_set,
&reg_info, &reg_offset, &dwarf_opcode_bytes](
&encoding_set, &format_set, &reg_info](
const llvm::StringRef &name,
const llvm::StringRef &value) -> bool {
if (name == "name") {
reg_name.SetString(value);
reg_info.name.SetString(value);
} else if (name == "bitsize") {
reg_info.byte_size =
StringConvert::ToUInt32(value.data(), 0, 0) / CHAR_BIT;
Expand All @@ -4442,72 +4360,65 @@ bool ParseRegisters(XMLNode feature_node, GdbServerTargetInfo &target_info,
const uint32_t regnum =
StringConvert::ToUInt32(value.data(), LLDB_INVALID_REGNUM, 0);
if (regnum != LLDB_INVALID_REGNUM) {
reg_info.kinds[eRegisterKindProcessPlugin] = regnum;
reg_info.regnum_remote = regnum;
}
} else if (name == "offset") {
reg_offset = StringConvert::ToUInt32(value.data(), UINT32_MAX, 0);
reg_info.byte_offset =
StringConvert::ToUInt32(value.data(), LLDB_INVALID_INDEX32, 0);
} else if (name == "altname") {
alt_name.SetString(value);
reg_info.alt_name.SetString(value);
} else if (name == "encoding") {
encoding_set = true;
reg_info.encoding = Args::StringToEncoding(value, eEncodingUint);
} else if (name == "format") {
format_set = true;
Format format = eFormatInvalid;
if (OptionArgParser::ToFormat(value.data(), format, nullptr)
.Success())
reg_info.format = format;
else if (value == "vector-sint8")
reg_info.format = eFormatVectorOfSInt8;
else if (value == "vector-uint8")
reg_info.format = eFormatVectorOfUInt8;
else if (value == "vector-sint16")
reg_info.format = eFormatVectorOfSInt16;
else if (value == "vector-uint16")
reg_info.format = eFormatVectorOfUInt16;
else if (value == "vector-sint32")
reg_info.format = eFormatVectorOfSInt32;
else if (value == "vector-uint32")
reg_info.format = eFormatVectorOfUInt32;
else if (value == "vector-float32")
reg_info.format = eFormatVectorOfFloat32;
else if (value == "vector-uint64")
reg_info.format = eFormatVectorOfUInt64;
else if (value == "vector-uint128")
reg_info.format = eFormatVectorOfUInt128;
if (!OptionArgParser::ToFormat(value.data(), reg_info.format,
nullptr)
.Success())
reg_info.format =
llvm::StringSwitch<lldb::Format>(value)
.Case("vector-sint8", eFormatVectorOfSInt8)
.Case("vector-uint8", eFormatVectorOfUInt8)
.Case("vector-sint16", eFormatVectorOfSInt16)
.Case("vector-uint16", eFormatVectorOfUInt16)
.Case("vector-sint32", eFormatVectorOfSInt32)
.Case("vector-uint32", eFormatVectorOfUInt32)
.Case("vector-float32", eFormatVectorOfFloat32)
.Case("vector-uint64", eFormatVectorOfUInt64)
.Case("vector-uint128", eFormatVectorOfUInt128)
.Default(eFormatInvalid);
} else if (name == "group_id") {
const uint32_t set_id =
StringConvert::ToUInt32(value.data(), UINT32_MAX, 0);
RegisterSetMap::const_iterator pos =
target_info.reg_set_map.find(set_id);
if (pos != target_info.reg_set_map.end())
set_name = pos->second.name;
reg_info.set_name = pos->second.name;
} else if (name == "gcc_regnum" || name == "ehframe_regnum") {
reg_info.kinds[eRegisterKindEHFrame] =
reg_info.regnum_ehframe =
StringConvert::ToUInt32(value.data(), LLDB_INVALID_REGNUM, 0);
} else if (name == "dwarf_regnum") {
reg_info.kinds[eRegisterKindDWARF] =
reg_info.regnum_dwarf =
StringConvert::ToUInt32(value.data(), LLDB_INVALID_REGNUM, 0);
} else if (name == "generic") {
reg_info.kinds[eRegisterKindGeneric] =
Args::StringToGenericRegister(value);
reg_info.regnum_generic = Args::StringToGenericRegister(value);
} else if (name == "value_regnums") {
SplitCommaSeparatedRegisterNumberString(value, value_regs, 0);
SplitCommaSeparatedRegisterNumberString(value, reg_info.value_regs,
0);
} else if (name == "invalidate_regnums") {
SplitCommaSeparatedRegisterNumberString(value, invalidate_regs, 0);
SplitCommaSeparatedRegisterNumberString(
value, reg_info.invalidate_regs, 0);
} else if (name == "dynamic_size_dwarf_expr_bytes") {
std::string opcode_string = value.str();
size_t dwarf_opcode_len = opcode_string.length() / 2;
assert(dwarf_opcode_len > 0);

dwarf_opcode_bytes.resize(dwarf_opcode_len);
reg_info.dynamic_size_dwarf_len = dwarf_opcode_len;
reg_info.dwarf_opcode_bytes.resize(dwarf_opcode_len);
StringExtractor opcode_extractor(opcode_string);
uint32_t ret_val =
opcode_extractor.GetHexBytesAvail(dwarf_opcode_bytes);
opcode_extractor.GetHexBytesAvail(reg_info.dwarf_opcode_bytes);
assert(dwarf_opcode_len == ret_val);
UNUSED_IF_ASSERT_DISABLED(ret_val);
reg_info.dynamic_size_dwarf_expr_bytes = dwarf_opcode_bytes.data();
} else {
printf("unhandled attribute %s = %s\n", name.data(), value.data());
}
Expand All @@ -4533,36 +4444,18 @@ bool ParseRegisters(XMLNode feature_node, GdbServerTargetInfo &target_info,
// Only update the register set name if we didn't get a "reg_set"
// attribute. "set_name" will be empty if we didn't have a "reg_set"
// attribute.
if (!set_name) {
if (!reg_info.set_name) {
if (!gdb_group.empty()) {
set_name.SetCString(gdb_group.c_str());
reg_info.set_name.SetCString(gdb_group.c_str());
} else {
// If no register group name provided anywhere,
// we'll create a 'general' register set
set_name.SetCString("general");
reg_info.set_name.SetCString("general");
}
}

reg_info.byte_offset = reg_offset;
assert(reg_info.byte_size != 0);
reg_offset = LLDB_INVALID_INDEX32;
if (!value_regs.empty()) {
value_regs.push_back(LLDB_INVALID_REGNUM);
reg_info.value_regs = value_regs.data();
}
if (!invalidate_regs.empty()) {
invalidate_regs.push_back(LLDB_INVALID_REGNUM);
reg_info.invalidate_regs = invalidate_regs.data();
}

reg_num_remote = reg_info.kinds[eRegisterKindProcessPlugin] + 1;
++reg_num_local;
reg_info.name = reg_name.AsCString();
reg_info.alt_name = alt_name.AsCString();
if (abi_sp)
abi_sp->AugmentRegisterInfo(reg_info);
dyn_reg_info.AddRegister(reg_info, set_name);

registers.push_back(reg_info);
return true; // Keep iterating through all "reg" elements
});
return true;
Expand All @@ -4576,8 +4469,7 @@ bool ParseRegisters(XMLNode feature_node, GdbServerTargetInfo &target_info,
// for nested register definition files. It returns true if it was able
// to fetch and parse an xml file.
bool ProcessGDBRemote::GetGDBServerRegisterInfoXMLAndProcess(
ArchSpec &arch_to_use, std::string xml_filename, uint32_t &reg_num_remote,
uint32_t &reg_num_local) {
ArchSpec &arch_to_use, std::string xml_filename, std::vector<RemoteRegisterInfo> &registers) {
// request the target xml file
std::string raw;
lldb_private::Status lldberr;
Expand Down Expand Up @@ -4673,18 +4565,14 @@ bool ProcessGDBRemote::GetGDBServerRegisterInfoXMLAndProcess(
}

if (arch_to_use.IsValid()) {
// Don't use Process::GetABI, this code gets called from DidAttach, and
// in that context we haven't set the Target's architecture yet, so the
// ABI is also potentially incorrect.
ABISP abi_to_use_sp = ABI::FindPlugin(shared_from_this(), arch_to_use);
for (auto &feature_node : feature_nodes) {
ParseRegisters(feature_node, target_info, *this->m_register_info_sp,
abi_to_use_sp, reg_num_remote, reg_num_local);
ParseRegisters(feature_node, target_info,
registers);
}

for (const auto &include : target_info.includes) {
GetGDBServerRegisterInfoXMLAndProcess(arch_to_use, include,
reg_num_remote, reg_num_local);
registers);
}
}
} else {
Expand All @@ -4693,6 +4581,74 @@ bool ProcessGDBRemote::GetGDBServerRegisterInfoXMLAndProcess(
return true;
}

void ProcessGDBRemote::AddRemoteRegisters(
std::vector<RemoteRegisterInfo> &registers, const ArchSpec &arch_to_use) {
// Don't use Process::GetABI, this code gets called from DidAttach, and
// in that context we haven't set the Target's architecture yet, so the
// ABI is also potentially incorrect.
ABISP abi_sp = ABI::FindPlugin(shared_from_this(), arch_to_use);

std::map<uint32_t, uint32_t> remote_to_local_map;
uint32_t remote_regnum = 0;
for (auto it : llvm::enumerate(registers)) {
RemoteRegisterInfo &remote_reg_info = it.value();

// Assign successive remote regnums if missing.
if (remote_reg_info.regnum_remote == LLDB_INVALID_REGNUM)
remote_reg_info.regnum_remote = remote_regnum;

// Create a mapping from remote to local regnos.
remote_to_local_map[remote_reg_info.regnum_remote] = it.index();

remote_regnum = remote_reg_info.regnum_remote + 1;
}

for (auto it : llvm::enumerate(registers)) {
uint32_t local_regnum = it.index();
RemoteRegisterInfo &remote_reg_info = it.value();

auto proc_to_lldb = [&remote_to_local_map](uint32_t process_regnum) {
auto lldb_regit = remote_to_local_map.find(process_regnum);
return lldb_regit != remote_to_local_map.end() ? lldb_regit->second
: LLDB_INVALID_REGNUM;
};

llvm::transform(remote_reg_info.value_regs,
remote_reg_info.value_regs.begin(), proc_to_lldb);
llvm::transform(remote_reg_info.invalidate_regs,
remote_reg_info.invalidate_regs.begin(), proc_to_lldb);

auto regs_with_sentinel = [](std::vector<uint32_t> &vec) -> uint32_t * {
if (!vec.empty()) {
vec.push_back(LLDB_INVALID_REGNUM);
return vec.data();
}
return nullptr;
};

struct RegisterInfo reg_info {
remote_reg_info.name.AsCString(), remote_reg_info.alt_name.AsCString(),
remote_reg_info.byte_size, remote_reg_info.byte_offset,
remote_reg_info.encoding, remote_reg_info.format,
{remote_reg_info.regnum_ehframe, remote_reg_info.regnum_dwarf,
remote_reg_info.regnum_generic, remote_reg_info.regnum_remote,
local_regnum},
regs_with_sentinel(remote_reg_info.value_regs),
regs_with_sentinel(remote_reg_info.invalidate_regs),
!remote_reg_info.dwarf_opcode_bytes.empty()
? remote_reg_info.dwarf_opcode_bytes.data()
: nullptr,
remote_reg_info.dwarf_opcode_bytes.size(),
};

if (abi_sp)
abi_sp->AugmentRegisterInfo(reg_info);
m_register_info_sp->AddRegister(reg_info, remote_reg_info.set_name);
};

m_register_info_sp->Finalize(arch_to_use);
}

// query the target of gdb-remote for extended target information returns
// true on success (got register definitions), false on failure (did not).
bool ProcessGDBRemote::GetGDBServerRegisterInfo(ArchSpec &arch_to_use) {
Expand All @@ -4704,11 +4660,10 @@ bool ProcessGDBRemote::GetGDBServerRegisterInfo(ArchSpec &arch_to_use) {
if (!m_gdb_comm.GetQXferFeaturesReadSupported())
return false;

uint32_t reg_num_remote = 0;
uint32_t reg_num_local = 0;
std::vector<RemoteRegisterInfo> registers;
if (GetGDBServerRegisterInfoXMLAndProcess(arch_to_use, "target.xml",
reg_num_remote, reg_num_local))
this->m_register_info_sp->Finalize(arch_to_use);
registers))
AddRemoteRegisters(registers, arch_to_use);

return m_register_info_sp->GetNumRegisters() > 0;
}
Expand Down
28 changes: 24 additions & 4 deletions lldb/source/Plugins/Process/gdb-remote/ProcessGDBRemote.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,23 @@ class Loader;
}
namespace process_gdb_remote {

struct RemoteRegisterInfo {
ConstString name;
ConstString alt_name;
ConstString set_name;
uint32_t byte_size = LLDB_INVALID_INDEX32;
uint32_t byte_offset = LLDB_INVALID_INDEX32;
lldb::Encoding encoding = lldb::eEncodingUint;
lldb::Format format = lldb::eFormatHex;
uint32_t regnum_dwarf = LLDB_INVALID_REGNUM;
uint32_t regnum_ehframe = LLDB_INVALID_REGNUM;
uint32_t regnum_generic = LLDB_INVALID_REGNUM;
uint32_t regnum_remote = LLDB_INVALID_REGNUM;
std::vector<uint32_t> value_regs;
std::vector<uint32_t> invalidate_regs;
std::vector<uint8_t> dwarf_opcode_bytes;
};

class ThreadGDBRemote;

class ProcessGDBRemote : public Process,
Expand Down Expand Up @@ -394,11 +411,14 @@ class ProcessGDBRemote : public Process,

DynamicLoader *GetDynamicLoader() override;

bool GetGDBServerRegisterInfoXMLAndProcess(ArchSpec &arch_to_use,
std::string xml_filename,
uint32_t &cur_reg_remote,
uint32_t &cur_reg_local);
bool GetGDBServerRegisterInfoXMLAndProcess(
ArchSpec &arch_to_use, std::string xml_filename,
std::vector<RemoteRegisterInfo> &registers);

// Convert RemoteRegisterInfos into RegisterInfos and add to the dynamic
// register list.
void AddRemoteRegisters(std::vector<RemoteRegisterInfo> &registers,
const ArchSpec &arch_to_use);
// Query remote GDBServer for register information
bool GetGDBServerRegisterInfo(ArchSpec &arch);

Expand Down