[Lldb-commits] [lldb] [lldb] Improved formatting of 'register read' command. (PR #188049)
via lldb-commits
lldb-commits at lists.llvm.org
Tue Mar 31 05:50:16 PDT 2026
https://github.com/Rifet-c updated https://github.com/llvm/llvm-project/pull/188049
>From 084a35eae5114f631b1850269d8f769f4205987c Mon Sep 17 00:00:00 2001
From: Aleksandr Levin <aleksandr.levin at codasip.com>
Date: Mon, 23 Mar 2026 16:10:26 +0100
Subject: [PATCH 1/5] [lldb] Improved formatting of 'register read' command of
lldb. Now it is dynamic in register name lengths and left-aligned.
---
.../source/Commands/CommandObjectRegister.cpp | 37 +++++++++++++++++--
lldb/source/Core/DumpRegisterValue.cpp | 6 +--
2 files changed, 37 insertions(+), 6 deletions(-)
diff --git a/lldb/source/Commands/CommandObjectRegister.cpp b/lldb/source/Commands/CommandObjectRegister.cpp
index fbb92e5c63877..404c800047d49 100644
--- a/lldb/source/Commands/CommandObjectRegister.cpp
+++ b/lldb/source/Commands/CommandObjectRegister.cpp
@@ -75,7 +75,7 @@ class CommandObjectRegisterRead : public CommandObjectParsed {
bool DumpRegister(const ExecutionContext &exe_ctx, Stream &strm,
RegisterContext ®_ctx, const RegisterInfo ®_info,
- bool print_flags) {
+ bool print_flags, uint32_t reg_name_align_at = 0) {
RegisterValue reg_value;
if (!reg_ctx.ReadRegister(®_info, reg_value))
return false;
@@ -85,7 +85,7 @@ class CommandObjectRegisterRead : public CommandObjectParsed {
bool prefix_with_altname = (bool)m_command_options.alternate_name;
bool prefix_with_name = !prefix_with_altname;
DumpRegisterValue(reg_value, strm, reg_info, prefix_with_name,
- prefix_with_altname, m_format_options.GetFormat(), 8,
+ prefix_with_altname, m_format_options.GetFormat(), reg_name_align_at,
exe_ctx.GetBestExecutionContextScope(), print_flags,
exe_ctx.GetTargetSP());
if ((reg_info.encoding == eEncodingUint) ||
@@ -123,6 +123,7 @@ class CommandObjectRegisterRead : public CommandObjectParsed {
strm.Printf("%s:\n", (reg_set->name ? reg_set->name : "unknown"));
strm.IndentMore();
const size_t num_registers = reg_set->num_registers;
+ uint32_t reg_name_align_at = ComputeMatchingAlignment(reg_ctx, reg_set, primitive_only);
for (size_t reg_idx = 0; reg_idx < num_registers; ++reg_idx) {
const uint32_t reg = reg_set->registers[reg_idx];
const RegisterInfo *reg_info = reg_ctx->GetRegisterInfoAtIndex(reg);
@@ -131,7 +132,7 @@ class CommandObjectRegisterRead : public CommandObjectParsed {
continue;
if (reg_info && DumpRegister(exe_ctx, strm, *reg_ctx, *reg_info,
- /*print_flags=*/false))
+ /*print_flags=*/false, reg_name_align_at))
++available_count;
else
++unavailable_count;
@@ -147,6 +148,36 @@ class CommandObjectRegisterRead : public CommandObjectParsed {
}
protected:
+ uint32_t ComputeMatchingAlignment(RegisterContext *reg_ctx, const RegisterSet *const reg_set, bool primitive_only) {
+ bool use_primary_name = !static_cast<bool>(m_command_options.alternate_name);
+ const size_t num_registers = reg_set->num_registers;
+ uint32_t reg_name_align_at = 0;
+
+ auto getNameSize = [&](auto reg_info){
+ auto raw = use_primary_name ? reg_info->name : reg_info->alt_name;
+ auto str = raw ? std::string(raw) : std::string();
+ return static_cast<uint32_t>(str.size());
+ };
+
+ // Loop through all the registers to find the longest register name for the
+ // matching alignment
+ for (size_t reg_idx = 0; reg_idx < num_registers; ++reg_idx) {
+ const uint32_t reg = reg_set->registers[reg_idx];
+ const RegisterInfo *reg_info = reg_ctx->GetRegisterInfoAtIndex(reg);
+
+ // Derived registers are skipped if primitive_only is true.
+ if (primitive_only && reg_info && reg_info->value_regs)
+ continue;
+
+ if (!reg_info)
+ continue;
+
+ reg_name_align_at = std::max(reg_name_align_at, getNameSize(reg_info));
+ }
+
+ return reg_name_align_at;
+ }
+
void DoExecute(Args &command, CommandReturnObject &result) override {
Stream &strm = result.GetOutputStream();
RegisterContext *reg_ctx = m_exe_ctx.GetRegisterContext();
diff --git a/lldb/source/Core/DumpRegisterValue.cpp b/lldb/source/Core/DumpRegisterValue.cpp
index aff4d2c621d7e..29b95ba41b085 100644
--- a/lldb/source/Core/DumpRegisterValue.cpp
+++ b/lldb/source/Core/DumpRegisterValue.cpp
@@ -62,7 +62,7 @@ void lldb_private::DumpRegisterValue(const RegisterValue ®_val, Stream &s,
const RegisterInfo ®_info,
bool prefix_with_name,
bool prefix_with_alt_name, Format format,
- uint32_t reg_name_right_align_at,
+ uint32_t reg_name_left_align_at,
ExecutionContextScope *exe_scope,
bool print_flags, TargetSP target_sp) {
DataExtractor data;
@@ -76,8 +76,8 @@ void lldb_private::DumpRegisterValue(const RegisterValue ®_val, Stream &s,
// prefix_with_name^prefix_with_alt_name is true
//
StreamString format_string;
- if (reg_name_right_align_at && (prefix_with_name ^ prefix_with_alt_name))
- format_string.Printf("%%%us", reg_name_right_align_at);
+ if (reg_name_left_align_at && (prefix_with_name ^ prefix_with_alt_name))
+ format_string.Printf("%%-%us", reg_name_left_align_at);
else
format_string.Printf("%%s");
std::string fmt = std::string(format_string.GetString());
>From 4386afc2d36f6be9d136aceb76fef156a7623a17 Mon Sep 17 00:00:00 2001
From: Aleksandr Levin <aleksandr.levin at codasip.com>
Date: Mon, 23 Mar 2026 16:33:09 +0100
Subject: [PATCH 2/5] Fixed formatting
---
.../source/Commands/CommandObjectRegister.cpp | 20 +++++++++++--------
1 file changed, 12 insertions(+), 8 deletions(-)
diff --git a/lldb/source/Commands/CommandObjectRegister.cpp b/lldb/source/Commands/CommandObjectRegister.cpp
index 404c800047d49..7f1f473795617 100644
--- a/lldb/source/Commands/CommandObjectRegister.cpp
+++ b/lldb/source/Commands/CommandObjectRegister.cpp
@@ -85,9 +85,9 @@ class CommandObjectRegisterRead : public CommandObjectParsed {
bool prefix_with_altname = (bool)m_command_options.alternate_name;
bool prefix_with_name = !prefix_with_altname;
DumpRegisterValue(reg_value, strm, reg_info, prefix_with_name,
- prefix_with_altname, m_format_options.GetFormat(), reg_name_align_at,
- exe_ctx.GetBestExecutionContextScope(), print_flags,
- exe_ctx.GetTargetSP());
+ prefix_with_altname, m_format_options.GetFormat(),
+ reg_name_align_at, exe_ctx.GetBestExecutionContextScope(),
+ print_flags, exe_ctx.GetTargetSP());
if ((reg_info.encoding == eEncodingUint) ||
(reg_info.encoding == eEncodingSint)) {
Process *process = exe_ctx.GetProcessPtr();
@@ -123,7 +123,8 @@ class CommandObjectRegisterRead : public CommandObjectParsed {
strm.Printf("%s:\n", (reg_set->name ? reg_set->name : "unknown"));
strm.IndentMore();
const size_t num_registers = reg_set->num_registers;
- uint32_t reg_name_align_at = ComputeMatchingAlignment(reg_ctx, reg_set, primitive_only);
+ uint32_t reg_name_align_at =
+ ComputeMatchingAlignment(reg_ctx, reg_set, primitive_only);
for (size_t reg_idx = 0; reg_idx < num_registers; ++reg_idx) {
const uint32_t reg = reg_set->registers[reg_idx];
const RegisterInfo *reg_info = reg_ctx->GetRegisterInfoAtIndex(reg);
@@ -148,18 +149,21 @@ class CommandObjectRegisterRead : public CommandObjectParsed {
}
protected:
- uint32_t ComputeMatchingAlignment(RegisterContext *reg_ctx, const RegisterSet *const reg_set, bool primitive_only) {
- bool use_primary_name = !static_cast<bool>(m_command_options.alternate_name);
+ uint32_t ComputeMatchingAlignment(RegisterContext *reg_ctx,
+ const RegisterSet *const reg_set,
+ bool primitive_only) {
+ bool use_primary_name =
+ !static_cast<bool>(m_command_options.alternate_name);
const size_t num_registers = reg_set->num_registers;
uint32_t reg_name_align_at = 0;
- auto getNameSize = [&](auto reg_info){
+ auto getNameSize = [&](auto reg_info) {
auto raw = use_primary_name ? reg_info->name : reg_info->alt_name;
auto str = raw ? std::string(raw) : std::string();
return static_cast<uint32_t>(str.size());
};
- // Loop through all the registers to find the longest register name for the
+ // Loop through all the registers to find the longest register name for the
// matching alignment
for (size_t reg_idx = 0; reg_idx < num_registers; ++reg_idx) {
const uint32_t reg = reg_set->registers[reg_idx];
>From ba74a7960ac4d9749981045eb74578c46c14cb79 Mon Sep 17 00:00:00 2001
From: Aleksandr Levin <aleksandr.levin at codasip.com>
Date: Tue, 24 Mar 2026 10:40:44 +0100
Subject: [PATCH 3/5] Returned right alignment
---
lldb/source/Core/DumpRegisterValue.cpp | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/lldb/source/Core/DumpRegisterValue.cpp b/lldb/source/Core/DumpRegisterValue.cpp
index 29b95ba41b085..f5650f44d3fb3 100644
--- a/lldb/source/Core/DumpRegisterValue.cpp
+++ b/lldb/source/Core/DumpRegisterValue.cpp
@@ -77,7 +77,7 @@ void lldb_private::DumpRegisterValue(const RegisterValue ®_val, Stream &s,
//
StreamString format_string;
if (reg_name_left_align_at && (prefix_with_name ^ prefix_with_alt_name))
- format_string.Printf("%%-%us", reg_name_left_align_at);
+ format_string.Printf("%%%us", reg_name_left_align_at);
else
format_string.Printf("%%s");
std::string fmt = std::string(format_string.GetString());
>From d89ae1e5e45bc76e014c3cba2bc07810281469f7 Mon Sep 17 00:00:00 2001
From: Aleksandr Levin <aleksandr.levin at codasip.com>
Date: Tue, 24 Mar 2026 13:58:01 +0100
Subject: [PATCH 4/5] Reversed renaming
---
lldb/source/Core/DumpRegisterValue.cpp | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/lldb/source/Core/DumpRegisterValue.cpp b/lldb/source/Core/DumpRegisterValue.cpp
index f5650f44d3fb3..aff4d2c621d7e 100644
--- a/lldb/source/Core/DumpRegisterValue.cpp
+++ b/lldb/source/Core/DumpRegisterValue.cpp
@@ -62,7 +62,7 @@ void lldb_private::DumpRegisterValue(const RegisterValue ®_val, Stream &s,
const RegisterInfo ®_info,
bool prefix_with_name,
bool prefix_with_alt_name, Format format,
- uint32_t reg_name_left_align_at,
+ uint32_t reg_name_right_align_at,
ExecutionContextScope *exe_scope,
bool print_flags, TargetSP target_sp) {
DataExtractor data;
@@ -76,8 +76,8 @@ void lldb_private::DumpRegisterValue(const RegisterValue ®_val, Stream &s,
// prefix_with_name^prefix_with_alt_name is true
//
StreamString format_string;
- if (reg_name_left_align_at && (prefix_with_name ^ prefix_with_alt_name))
- format_string.Printf("%%%us", reg_name_left_align_at);
+ if (reg_name_right_align_at && (prefix_with_name ^ prefix_with_alt_name))
+ format_string.Printf("%%%us", reg_name_right_align_at);
else
format_string.Printf("%%s");
std::string fmt = std::string(format_string.GetString());
>From e7404cd60488c2a6e2a8e51eea10bc9f5992a86c Mon Sep 17 00:00:00 2001
From: Aleksandr Levin <aleksandr.levin at codasip.com>
Date: Tue, 31 Mar 2026 14:48:35 +0200
Subject: [PATCH 5/5] Separate registers printing is now well-aligned as well
---
.../source/Commands/CommandObjectRegister.cpp | 52 ++++++++++++++-----
1 file changed, 38 insertions(+), 14 deletions(-)
diff --git a/lldb/source/Commands/CommandObjectRegister.cpp b/lldb/source/Commands/CommandObjectRegister.cpp
index 7f1f473795617..fb03d738bde84 100644
--- a/lldb/source/Commands/CommandObjectRegister.cpp
+++ b/lldb/source/Commands/CommandObjectRegister.cpp
@@ -149,6 +149,12 @@ class CommandObjectRegisterRead : public CommandObjectParsed {
}
protected:
+ uint32_t GetNameSize(const RegisterInfo * reg_info, bool use_primary_name) {
+ const char *raw = use_primary_name ? reg_info->name : reg_info->alt_name;
+ std::string str = raw ? std::string(raw) : std::string();
+ return static_cast<uint32_t>(str.size());
+ }
+
uint32_t ComputeMatchingAlignment(RegisterContext *reg_ctx,
const RegisterSet *const reg_set,
bool primitive_only) {
@@ -157,26 +163,43 @@ class CommandObjectRegisterRead : public CommandObjectParsed {
const size_t num_registers = reg_set->num_registers;
uint32_t reg_name_align_at = 0;
- auto getNameSize = [&](auto reg_info) {
- auto raw = use_primary_name ? reg_info->name : reg_info->alt_name;
- auto str = raw ? std::string(raw) : std::string();
- return static_cast<uint32_t>(str.size());
- };
-
// Loop through all the registers to find the longest register name for the
// matching alignment
for (size_t reg_idx = 0; reg_idx < num_registers; ++reg_idx) {
const uint32_t reg = reg_set->registers[reg_idx];
- const RegisterInfo *reg_info = reg_ctx->GetRegisterInfoAtIndex(reg);
+ if (const RegisterInfo *reg_info =
+ reg_ctx->GetRegisterInfoAtIndex(reg)) {
+ // Derived registers are skipped if primitive_only is true.
+ if (primitive_only && reg_info->value_regs)
+ continue;
+
+ reg_name_align_at = std::max(reg_name_align_at, GetNameSize(reg_info, use_primary_name));
+ }
+ }
- // Derived registers are skipped if primitive_only is true.
- if (primitive_only && reg_info && reg_info->value_regs)
- continue;
+ return reg_name_align_at;
+ }
- if (!reg_info)
- continue;
+ // Here, command is basically a list of registers to be printed by DumpRegister() method
+ uint32_t ComputeMatchingAlignment(Args &command, RegisterContext *reg_ctx, bool primitive_only) {
+ bool use_primary_name =
+ !static_cast<bool>(m_command_options.alternate_name);
+ uint32_t reg_name_align_at = 0;
- reg_name_align_at = std::max(reg_name_align_at, getNameSize(reg_info));
+ // Loop through all the arguments to find the longest register name for the
+ // matching alignment
+ for (auto &entry : command) {
+ auto arg_str = entry.ref();
+ arg_str.consume_front("$");
+
+ if (const RegisterInfo *reg_info =
+ reg_ctx->GetRegisterInfoByName(arg_str)) {
+ // Derived registers are skipped if primitive_only is true.
+ if (primitive_only && reg_info->value_regs)
+ continue;
+
+ reg_name_align_at = std::max(reg_name_align_at, GetNameSize(reg_info, use_primary_name));
+ }
}
return reg_name_align_at;
@@ -230,6 +253,7 @@ class CommandObjectRegisterRead : public CommandObjectParsed {
result.AppendError("the --set <set> option can't be used when "
"registers names are supplied as arguments\n");
} else {
+ int alignment = ComputeMatchingAlignment(command, reg_ctx, !m_command_options.dump_all_sets.GetCurrentValue());
for (auto &entry : command) {
// in most LLDB commands we accept $rbx as the name for register RBX
// - and here we would reject it and non-existant. we should be more
@@ -246,7 +270,7 @@ class CommandObjectRegisterRead : public CommandObjectParsed {
bool print_flags =
!m_format_options.GetFormatValue().OptionWasSet();
if (!DumpRegister(m_exe_ctx, strm, *reg_ctx, *reg_info,
- print_flags))
+ print_flags, alignment))
strm.Printf("%-12s = error: unavailable\n", reg_info->name);
} else {
result.AppendErrorWithFormat("Invalid register name '%s'.\n",
More information about the lldb-commits
mailing list