[lldb] Update qRegisterInfo docs to recommend target.xml #69853
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
|
@llvm/pr-subscribers-lldb Author: Jason Molenda (jasonmolenda) ChangesBefore 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. Full diff: https://github.com/llvm/llvm-project/pull/69853.diff 1 Files Affected:
diff --git a/lldb/docs/lldb-gdb-remote.txt b/lldb/docs/lldb-gdb-remote.txt
index 6eed70eab043fed..58269e4c2b688ba 100644
--- a/lldb/docs/lldb-gdb-remote.txt
+++ b/lldb/docs/lldb-gdb-remote.txt
@@ -581,11 +581,15 @@ read packet: <binary data>/E<error code>;AAAAAAAAA
// will get picked up automatically, and allows registers to change
// depending on the actual CPU type that is used.
//
-// NB: As of summer 2015, lldb can get register information from the
-// "qXfer:features:read:target.xml" FSF gdb standard register packet
-// where the stub provides register definitions in an XML file.
+// NB: qRegisterInfo is deprecated in favor of the standard gdb remote
+// serial protocol register description method,
+// "qXfer:features:read:target.xml".
// If qXfer:features:read:target.xml is supported, qRegisterInfo does
-// not need to be implemented.
+// not need to be implemented. The target.xml format is used by most
+// gdb RSP stubs whereas qRegisterInfo was an lldb-only design.
+// qRegisterInfo requires one packet per register and can have undesirable
+// performance costs at the start of a debug session, whereas target.xml
+// may be able to describe all registers in a single packet.
//----------------------------------------------------------------------
With LLDB, for register information, remote GDB servers can add
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.