summaryrefslogtreecommitdiff
path: root/lldb/docs
diff options
context:
space:
mode:
authorJason Molenda <jason@molenda.com>2023-05-04 13:13:30 -0700
committerJason Molenda <jason@molenda.com>2023-05-04 13:14:10 -0700
commit4fac08ff1dcd02c89c677365b10921399caf79df (patch)
tree47f38efb5a0b195a11be0ae61298971172b97cb7 /lldb/docs
parent09ceb4729f1ca8781718d41b7876b68820baadba (diff)
downloadllvm-4fac08ff1dcd02c89c677365b10921399caf79df.tar.gz
Recognize `addressing_bits` kv in stop reply packet
If a remote stub provides the addressing_bits kv pair in the stop reply packet, update the Process address masks with that value as it possibly changes during the process runtime. This is an unusual situation, most likely a JTAG remote stub and some very early startup code that is setting up the page tables. Nearly all debug sessions will have a single address mask that cannot change during the lifetime of a Process. Differential Revision: https://reviews.llvm.org/D149803 rdar://61900565
Diffstat (limited to 'lldb/docs')
-rw-r--r--lldb/docs/lldb-gdb-remote.txt18
1 files changed, 18 insertions, 0 deletions
diff --git a/lldb/docs/lldb-gdb-remote.txt b/lldb/docs/lldb-gdb-remote.txt
index 570e70f9e54a..b426978a9490 100644
--- a/lldb/docs/lldb-gdb-remote.txt
+++ b/lldb/docs/lldb-gdb-remote.txt
@@ -1636,6 +1636,24 @@ for this region.
// Example:
// thread-pcs:dec14,2cf872b0,2cf8681c,2d02d68c,2cf716a8;
//
+// "addressing_bits" unsigned optional Specifies how many bits in addresses
+// are significant for addressing, base
+// 10. If bits 38..0 in a 64-bit
+// pointer are significant for
+// addressing, then the value is 39.
+// This is needed on e.g. AArch64
+// v8.3 ABIs that use pointer
+// authentication in the high bits.
+// This value is normally sent in the
+// qHostInfo packet response, and if the
+// value cannot change during the process
+// lifetime, it does not need to be
+// duplicated here in the stop packet.
+// For a firmware environment with early
+// start code that may be changing the
+// page table setup, a dynamically set
+// value may be needed.
+//
// BEST PRACTICES:
// Since register values can be supplied with this packet, it is often useful
// to return the PC, SP, FP, LR (if any), and FLAGS registers so that separate