[all-commits] [llvm/llvm-project] a3fe92: Remove hardware index from watchpoints and breakpo...

[Jason Molenda via All-commits]

  Branch: refs/heads/main
  Home:   https://github.com/llvm/llvm-project
  Commit: a3fe9221ab1541a88e784507433cfe7fd13688fd
      https://github.com/llvm/llvm-project/commit/a3fe9221ab1541a88e784507433cfe7fd13688fd
  Author: Jason Molenda <jmolenda at apple.com>
  Date:   2023-11-15 (Wed, 15 Nov 2023)

  Changed paths:
    M lldb/bindings/interface/SBTargetDocstrings.i
    M lldb/bindings/interface/SBWatchpointDocstrings.i
    M lldb/docs/use/tutorial.rst
    M lldb/include/lldb/API/SBWatchpoint.h
    M lldb/include/lldb/Breakpoint/StoppointSite.h
    M lldb/source/API/SBWatchpoint.cpp
    M lldb/source/Breakpoint/BreakpointLocation.cpp
    M lldb/source/Breakpoint/BreakpointSite.cpp
    M lldb/source/Breakpoint/StoppointSite.cpp
    M lldb/source/Breakpoint/Watchpoint.cpp
    M lldb/source/Plugins/Process/Utility/StopInfoMachException.cpp
    M lldb/source/Plugins/Process/Windows/Common/ProcessWindows.cpp
    M lldb/source/Plugins/Process/gdb-remote/ProcessGDBRemote.cpp
    M lldb/source/Target/StopInfo.cpp
    M lldb/test/API/python_api/default-constructor/sb_watchpoint.py
    M lldb/test/API/python_api/watchpoint/TestWatchpointIter.py
    M llvm/docs/ReleaseNotes.rst

  Log Message:
  -----------
  Remove hardware index from watchpoints and breakpoints (#72012)

The Watchpoint and Breakpoint objects try to track the hardware index
that was used for them, if they are hardware wp/bp's. The majority of
our debugging goes over the gdb remote serial protocol, and when we set
the watchpoint/breakpoint, there is no (standard) way for the remote
stub to communicate to lldb which hardware index was used. We have an
lldb-extension packet to query the total number of watchpoint registers.

When a watchpoint is hit, there is an lldb extension to the stop reply
packet (documented in lldb-gdb-remote.txt) to describe the watchpoint
including its actual hardware index,

<addr within wp range> <wp hw index> <actual accessed address>

(the third field is specifically needed for MIPS). At this point, if the
stub reported these three fields (the stub is only required to provide
the first), we can know the actual hardware index for this watchpoint.

Breakpoints are worse; there's never any way for us to be notified about
which hardware index was used. Breakpoints got this as a side effect of
inherting from StoppointSite with Watchpoints.

We expose the watchpoint hardware index through "watchpoint list -v" and
through SBWatchpoint::GetHardwareIndex.

With my large watchpoint support, there is no *single* hardware index
that may be used for a watchpoint, it may need multiple resources. Also
I don't see what a user is supposed to do with this information, or an
IDE. Knowing the total number of watchpoint registers on the target, and
knowing how many Watchpoint Resources are currently in use, is helpful.
Knowing how many Watchpoint Resources
a single user-specified watchpoint needed to be implemented is useful.
But knowing which registers were used is an implementation detail and
not available until we hit the watchpoint when using gdb remote serial
protocol.

So given all that, I'm removing watchpoint hardware index numbers. I'm
changing the SB API to always return -1.