Skip to content

Commit ed0bb94

Browse files
authored
[lldb] Update qRegisterInfo docs to recommend target.xml (#69853)
Before target.xml, lldb had its own method for querying the remote stub of the registers it supports, qRegisterInfo. The gdb standard method of using a target.xml file to describe the available registers has become commonplace, and the lldb method for doing this is no longer needed. Stubs should describe their registers to lldb, but it should be with the target.xml file.
1 parent 44d4f97 commit ed0bb94

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

lldb/docs/lldb-gdb-remote.txt

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -581,11 +581,15 @@ read packet: <binary data>/E<error code>;AAAAAAAAA
581581
// will get picked up automatically, and allows registers to change
582582
// depending on the actual CPU type that is used.
583583
//
584-
// NB: As of summer 2015, lldb can get register information from the
585-
// "qXfer:features:read:target.xml" FSF gdb standard register packet
586-
// where the stub provides register definitions in an XML file.
584+
// NB: qRegisterInfo is deprecated in favor of the standard gdb remote
585+
// serial protocol register description method,
586+
// "qXfer:features:read:target.xml".
587587
// If qXfer:features:read:target.xml is supported, qRegisterInfo does
588-
// not need to be implemented.
588+
// not need to be implemented. The target.xml format is used by most
589+
// gdb RSP stubs whereas qRegisterInfo was an lldb-only design.
590+
// qRegisterInfo requires one packet per register and can have undesirable
591+
// performance costs at the start of a debug session, whereas target.xml
592+
// may be able to describe all registers in a single packet.
589593
//----------------------------------------------------------------------
590594

591595
With LLDB, for register information, remote GDB servers can add

0 commit comments

Comments
 (0)