Nixyri/ghidra
1
0
Fork 0
mirror of https://github.com/NationalSecurityAgency/ghidra.git synced 2024-11-10 14:11:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

GP-4617: Moving most documentation from connectors to Help.

Browse Source
This commit is contained in:
Dan 2024-05-23 09:01:30 -04:00
parent 8734c48100
commit 90f3725246
16 changed files with 360 additions and 177 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Ghidra/Debug/Debugger-agent-dbgeng/data/debugger-launchers/local-dbgeng.bat
View File

@ -1,21 +1,20 @@
::@title dbgeng
::@desc <html><body width="300px">
::@desc <h3>Launch with <tt>dbgeng</tt> (in a Python interpreter)</h3>
::@desc <p>This will launch the target on the local machine using <tt>dbgeng.dll</tt>. Typically,
::@desc Windows systems have this library pre-installed, but it may have limitations, e.g., you
::@desc cannot use <tt>.server</tt>. For the full capabilities, you must install WinDbg.</p>
::@desc <p>Furthermore, you must have Python 3 installed on your system, and it must have the
::@desc <tt>pybag</tt> and <tt>protobuf</tt> packages installed.</p>
::@desc <p>
::@desc This will launch the target on the local machine using <tt>dbgeng.dll</tt>.
::@desc For setup instructions, press <b>F1</b>.
::@desc </p>
::@desc </body></html>
::@menu-group local
::@icon icon.debugger
::@help TraceRmiLauncherServicePlugin#dbgeng
::@env OPT_PYTHON_EXE:str="python" "Path to python" "The path to the Python 3 interpreter. Omit the full path to resolve using the system PATH."
::@env OPT_PYTHON_EXE:str="python" "Python command" "The path to the Python 3 interpreter. Omit the full path to resolve using the system PATH."
:: Use env instead of args, because "all args except first" is terrible to implement in batch
::@env OPT_TARGET_IMG:str="" "Image" "The target binary executable image"
::@env OPT_TARGET_ARGS:str="" "Arguments" "Command-line arguments to pass to the target"
::@env OPT_USE_DBGMODEL:bool=true "Use dbgmodel" "Load and use dbgmodel.dll if it is available."
::@env WINDBG_DIR:str="" "Path to dbgeng" "Path to dbgeng and associated DLLS (if not Windows Kits)."
::@env WINDBG_DIR:str="" "Path to dbgeng.dll directory" "Path containing dbgeng and associated DLLS (if not Windows Kits)."
@echo off

13
Ghidra/Debug/Debugger-agent-dbgeng/data/debugger-launchers/local-ttd.bat
View File

@ -1,21 +1,20 @@
::@title ttd
::@desc <html><body width="300px">
::@desc <h3>Launch with <tt>ttd</tt> (in a Python interpreter)</h3>
::@desc <p>This will launch the target on the local machine using <tt>dbgeng.dll</tt>. Typically,
::@desc Windows systems have this library pre-installed, but it may have limitations, e.g., you
::@desc cannot use <tt>.server</tt>. For the full capabilities, you must install WinDbg.</p>
::@desc <p>Furthermore, you must have Python 3 installed on your system, and it must have the
::@desc <tt>pybag</tt> and <tt>protobuf</tt> packages installed.</p>
::@desc <p>
::@desc This will launch the target on the local machine for time-travel debugging.
::@desc For setup instructions, press <b>F1</b>.
::@desc </p>
::@desc </body></html>
::@menu-group local
::@icon icon.debugger
::@help TraceRmiLauncherServicePlugin#dbgeng_ttd
::@env OPT_PYTHON_EXE:str="python" "Path to python" "The path to the Python 3 interpreter. Omit the full path to resolve using the system PATH."
::@env OPT_PYTHON_EXE:str="python" "Python command" "The path to the Python 3 interpreter. Omit the full path to resolve using the system PATH."
:: Use env instead of args, because "all args except first" is terrible to implement in batch
::@env OPT_TARGET_IMG:str="" "Trace (.run)" "A trace associated with the target binary executable"
::@env OPT_TARGET_ARGS:str="" "Arguments" "Command-line arguments to pass to the target"
::@env OPT_USE_DBGMODEL:bool=true "Use dbgmodel" "Load and use dbgmodel.dll if it is available."
::@env OPT_DBGMODEL_PATH:str="" "Path to dbgeng & \\ttd" "Path to dbgeng and associated DLLS (if not Windows Kits)."
::@env OPT_DBGMODEL_PATH:str="" "Path to dbgeng.dll & \\ttd" "Path containing dbgeng and associated DLLS (if not Windows Kits)."
@echo off

9
Ghidra/Debug/Debugger-agent-gdb/data/debugger-launchers/local-gdb.sh
View File

@ -17,9 +17,10 @@
#@title gdb
#@desc <html><body width="300px">
#@desc <h3>Launch with <tt>gdb</tt></h3>
#@desc <p>This will launch the target on the local machine using <tt>gdb</tt>. GDB must already
#@desc be installed on your system, and it must embed the Python 3 interpreter. You will also
#@desc need <tt>protobuf</tt> and <tt>psutil</tt> installed for Python 3.</p>
#@desc <p>
#@desc This will launch the target on the local machine using <tt>gdb</tt>.
#@desc For setup instructions, press <b>F1</b>.
#@desc </p>
#@desc </body></html>
#@menu-group local
#@icon icon.debugger
@ -27,7 +28,7 @@
#@enum StartCmd:str run start starti
#@arg :str "Image" "The target binary executable image"
#@args "Arguments" "Command-line arguments to pass to the target"
#@env OPT_GDB_PATH:str="gdb" "Path to gdb" "The path to gdb. Omit the full path to resolve using the system PATH."
#@env OPT_GDB_PATH:str="gdb" "gdb command" "The path to gdb. Omit the full path to resolve using the system PATH."
#@env OPT_START_CMD:StartCmd="starti" "Run command" "The gdb command to actually run the target."
#@env OPT_EXTRA_TTY:bool=false "Inferior TTY" "Provide a separate terminal emulator for the target."
#@tty TTY_TARGET if env:OPT_EXTRA_TTY

14
Ghidra/Debug/Debugger-agent-gdb/data/debugger-launchers/qemu-gdb.sh
View File

@ -17,21 +17,21 @@
#@title qemu + gdb
#@desc <html><body width="300px">
#@desc <h3>Launch with <tt>qemu</tt> and connect with <tt>gdb</tt></h3>
#@desc <p>This will launch the target on the local machine using <tt>qemu</tt>. Then in a second
#@desc terminal, it will connect <tt>gdb</tt> to QEMU's GDBstub.
#@desc GDB must already be installed on your system, it must support your target architecture
#@desc (you may install <tt>gdb-multiarch</tt>), and it must embed the Python 3 interpreter. You
#@desc will also need <tt>protobuf</tt> installed for Python 3.
#@desc <p>
#@desc This will launch the target on the local machine using <tt>qemu</tt>.
#@desc Then in a second terminal, it will connect <tt>gdb</tt> to QEMU's GDBstub.
#@desc For setup instructions, press <b>F1</b>.
#@desc </p>
#@desc </body></html>
#@menu-group cross
#@icon icon.debugger
#@help TraceRmiLauncherServicePlugin#gdb_qemu
#@arg :str "Image" "The target binary executable image"
#@args "Arguments" "Command-line arguments to pass to the target"
#@env GHIDRA_LANG_EXTTOOL_qemu:str="" "Path to qemu" "The path to qemu for the target architecture."
#@env GHIDRA_LANG_EXTTOOL_qemu:str="" "QEMU command" "The path to qemu for the target architecture."
#@env QEMU_GDB:int=12345 "QEMU Port" "Port for gdb connection to qemu"
#@env OPT_EXTRA_QEMU_ARGS:str="" "Extra qemu arguments" "Extra arguments to pass to qemu. Use with care."
#@env OPT_GDB_PATH:str="gdb-multiarch" "Path to gdb" "The path to gdb. Omit the full path to resolve using the system PATH."
#@env OPT_GDB_PATH:str="gdb-multiarch" "gdb command" "The path to gdb. Omit the full path to resolve using the system PATH."
#@env OPT_EXTRA_TTY:bool=false "QEMU TTY" "Provide a separate terminal emulator for the target."
#@tty TTY_TARGET if env:OPT_EXTRA_TTY

12
Ghidra/Debug/Debugger-agent-gdb/data/debugger-launchers/raw-gdb.sh
View File

@ -18,16 +18,16 @@
#@no-image
#@desc <html><body width="300px">
#@desc <h3>Start <tt>gdb</tt></h3>
#@desc <p>This will start <tt>gdb</tt> and connect to it. It will not launch
#@desc a target, so you can (must) set up your target manually.
#@desc GDB must already
#@desc be installed on your system, and it must embed the Python 3 interpreter. You will also
#@desc need <tt>protobuf</tt> and <tt>psutil</tt> installed for Python 3.</p>
#@desc <p>
#@desc This will start <tt>gdb</tt> and connect to it.
#@desc It will not launch a target, so you can (must) set up your target manually.
#@desc For setup instructions, press <b>F1</b>.
#@desc </p>
#@desc </body></html>
#@menu-group raw
#@icon icon.debugger
#@help TraceRmiLauncherServicePlugin#gdb_raw
#@env OPT_GDB_PATH:str="gdb" "Path to gdb" "The path to gdb. Omit the full path to resolve using the system PATH."
#@env OPT_GDB_PATH:str="gdb" "gdb command" "The path to gdb. Omit the full path to resolve using the system PATH."
#@env OPT_ARCH:str="i386:x86-64" "Architecture" "Target architecture"
if [ -d ${GHIDRA_HOME}/ghidra/.git ]

17
Ghidra/Debug/Debugger-agent-gdb/data/debugger-launchers/remote-gdb.sh
View File

@ -18,25 +18,20 @@
#@no-image
#@desc <html><body width="300px">
#@desc <h3>Launch with local <tt>gdb</tt> and connect to a stub (e.g., <tt>gdbserver</tt>)</h3>
#@desc <p>This will start <tt>gdb</tt> on the local system and then use it to connect to the remote system.
#@desc The actual command used is, e.g:</p>
#@desc <pre>target remote host:port</pre>
#@desc <p>It may be worth testing this manually to ensure everything is configured correctly.
#@desc GDB must be installed on your local system, it must be compatible with the remote system,
#@desc and it must embed the Python 3 interpreter. You will also need <tt>protobuf</tt> installed
#@desc for Python 3 on the local system. There are no Python requirements for the remote system.
#@desc Please ensure that Ghidra's current program and the target's image match. Otherwise, the
#@desc modules may not map.</p>
#@desc <p>
#@desc This will start <tt>gdb</tt> on the local system and then use it to connect to the remote system.
#@desc For setup instructions, press <b>F1</b>.
#@desc </p>
#@desc </body></html>
#@menu-group remote
#@icon icon.debugger
#@help TraceRmiLauncherServicePlugin#gdb
#@help TraceRmiLauncherServicePlugin#gdb_remote
#@enum TargetType:str remote extended-remote
#@env OPT_TARGET_TYPE:TargetType="remote" "Target" "The type of remote target"
#@env OPT_HOST:str="localhost" "Host" "The hostname of the target"
#@env OPT_PORT:str="9999" "Port" "The host's listening port"
#@env OPT_ARCH:str="" "Architecture (optional)" "Target architecture override"
#@env OPT_GDB_PATH:str="gdb" "Path to gdb" "The path to gdb on the local system. Omit the full path to resolve using the system PATH."
#@env OPT_GDB_PATH:str="gdb" "gdb command" "The path to gdb on the local system. Omit the full path to resolve using the system PATH."
if [ -d ${GHIDRA_HOME}/ghidra/.git ]
then

19
Ghidra/Debug/Debugger-agent-gdb/data/debugger-launchers/ssh-gdb.sh
View File

@ -18,19 +18,10 @@
#@title gdb via ssh
#@desc <html><body width="300px">
#@desc <h3>Launch with <tt>gdb</tt> via <tt>ssh</tt></h3>
#@desc <p>This will launch the target on a remote machine using <tt>gdb</tt> via <tt>ssh</tt>.
#@desc GDB and an SSH server must already be installed and operational on the remote system, and
#@desc GDB must embed the Python 3 interpreter. The remote SSH server must be configured to allow
#@desc remote port forwarding. You will also need to install the following for GDB's embedded
#@desc version of Python:</p>
#@desc <ul>
#@desc <li><tt>ghidragdb</tt> - Ghidra plugin for GDB, available from the Debugger-agent-gdb
#@desc directory in Ghidra</li>
#@desc <li><tt>ghidratrace</tt> - Ghidra Trace RMI client for Python, available from the
#@desc Debugger-rmi-trace directory in Ghidra</li>
#@desc <li><tt>protobuf</tt> - available from PyPI</li>
#@desc <li><tt>psutil</tt> - available from PyPI</li>
#@desc </ul>
#@desc <p>
#@desc This will launch the target on a remote machine using <tt>gdb</tt> via <tt>ssh</tt>.
#@desc For setup instructions, press <b>F1</b>.
#@desc </p>
#@desc </body></html>
#@menu-group remote
#@icon icon.debugger
@ -41,7 +32,7 @@
#@env OPT_HOST:str="localhost" "[User@]Host" "The hostname or user@host"
#@env OPT_REMOTE_PORT:int=12345 "Remote Trace RMI Port" "A free port on the remote end to receive and forward the Trace RMI connection."
#@env OPT_EXTRA_SSH_ARGS:str="" "Extra ssh arguments" "Extra arguments to pass to ssh. Use with care."
#@env OPT_GDB_PATH:str="gdb" "Path to gdb" "The path to gdb on the remote system. Omit the full path to resolve using the system PATH."
#@env OPT_GDB_PATH:str="gdb" "gdb command" "The path to gdb on the remote system. Omit the full path to resolve using the system PATH."
#@env OPT_START_CMD:StartCmd="start" "Run command" "The gdb command to actually run the target."
target_image="$1"

18
Ghidra/Debug/Debugger-agent-gdb/data/debugger-launchers/ssh-gdbserver.sh
View File

@ -18,16 +18,10 @@
#@title gdb + gdbserver via ssh
#@desc <html><body width="300px">
#@desc <h3>Launch with local <tt>gdb</tt> and <tt>gdbserver</tt> via <tt>ssh</tt></h3>
#@desc <p>This will start <tt>gdb</tt> on the local system and then use it to connect and launch
#@desc the target in <tt>gdbserver</tt> on the remote system via <tt>ssh</tt>. The actual command
#@desc used is, e.g:</p>
#@desc <pre>target remote | ssh user@host gdbserver - /path/to/image</pre>
#@desc <p>It may be worth testing this manually to ensure everything is configured correctly. An
#@desc SSH server and <tt>gdbserver</tt> must already be installed and operational on the remote
#@desc system. GDB must be installed on your local system, it must be compatible with the
#@desc <tt>gdbserver</tt> on the remote system, and it must embed the Python 3 interpreter. You
#@desc will also need <tt>protobuf</tt> installed for Python 3 on the local system. There are no
#@desc Python requirements for the remote system.</p>
#@desc <p>
#@desc This will start <tt>gdb</tt> on the local system and then use it to connect and launch the target in <tt>gdbserver</tt> on the remote system via <tt>ssh</tt>.
#@desc For setup instructions, press <b>F1</b>.
#@desc </p>
#@desc </body></html>
#@menu-group remote
#@icon icon.debugger
@ -36,9 +30,9 @@
#@args "Arguments" "Command-line arguments to pass to the target"
#@env OPT_HOST:str="localhost" "[User@]Host" "The hostname or user@host"
#@env OPT_EXTRA_SSH_ARGS:str="" "Extra ssh arguments" "Extra arguments to pass to ssh. Use with care."
#@env OPT_GDBSERVER_PATH:str="gdbserver" "Path to gdbserver (remote)" "The path to gdbserver on the remote system. Omit the full path to resolve using the system PATH."
#@env OPT_GDBSERVER_PATH:str="gdbserver" "gdbserver command (remote)" "The path to gdbserver on the remote system. Omit the full path to resolve using the system PATH."
#@env OPT_EXTRA_GDBSERVER_ARGS:str="" "Extra gdbserver arguments" "Extra arguments to pass to gdbserver. Use with care."
#@env OPT_GDB_PATH:str="gdb" "Path to gdb" "The path to gdb on the local system. Omit the full path to resolve using the system PATH."
#@env OPT_GDB_PATH:str="gdb" "gdb command" "The path to gdb on the local system. Omit the full path to resolve using the system PATH."
if [ -d ${GHIDRA_HOME}/ghidra/.git ]
then

19
Ghidra/Debug/Debugger-agent-gdb/data/debugger-launchers/wine-gdb.sh
View File

@ -17,19 +17,10 @@
#@title wine + gdb
#@desc <html><body width="300px">
#@desc <h3>Launch with <tt>gdb</tt> and <tt>wine</tt></h3>
#@desc <p>This will launch the target on the local machine using <tt>gdb</tt> and <tt>wine</tt>.
#@desc GDB and Wine must already be installed on your system, and GDB must embed the Python 3
#@desc interpreter. You will also need <tt>protobuf</tt> and <tt>psutil</tt> installed for Python
#@desc 3.</p>
#@desc <p>This operates by starting GDB on the Wine executable and passing arguments to launch a
#@desc Windows target. This may prevent GDB from processing the object file, because it is a PE
#@desc file, and most copies of GDB for UNIX will support only ELF. Nevertheless, Ghidra should
#@desc recognize the target and map it, giving you symbols and debug info in the front end, even
#@desc if not in the GDB CLI.</p>
#@desc <p>You will need to locate the <tt>wine</tt> executable, not the script, on your system. To
#@desc find it, either dissect the <tt>wine</tt> script or consult online documentation for your
#@desc distribution of Wine. There are often two executables, one for 32-bit targets and one for
#@desc 64-bit targets. You must select the correct one.</p>
#@desc <p>
#@desc This will launch the target on the local machine using <tt>gdb</tt> and <tt>wine</tt>.
#@desc For setup instructions, press <b>F1</b>.
#@desc </p>
#@desc </body></html>
#@menu-group cross
#@icon icon.debugger
@ -37,7 +28,7 @@
#@arg :str "Image" "The target binary executable image"
#@args "Arguments" "Command-line arguments to pass to the target"
#@env OPT_WINE_PATH:str="/usr/lib/wine/wine64" "Path to wine binary" "The path to the wine executable for your target architecture."
#@env OPT_GDB_PATH:str="gdb" "Path to gdb" "The path to gdb. Omit the full path to resolve using the system PATH."
#@env OPT_GDB_PATH:str="gdb" "gdb command" "The path to gdb. Omit the full path to resolve using the system PATH."
#@env OPT_EXTRA_TTY:bool=false "Inferior TTY" "Provide a separate terminal emulator for the target."
#@tty TTY_TARGET if env:OPT_EXTRA_TTY

9
Ghidra/Debug/Debugger-agent-lldb/data/debugger-launchers/local-lldb.sh
View File

@ -17,9 +17,10 @@
#@title lldb
#@desc <html><body width="300px">
#@desc <h3>Launch with <tt>lldb</tt></h3>
#@desc <p>This will launch the target on the local machine using <tt>lldb</tt>. LLDB must already
#@desc be installed on your system, and it must embed the Python 3 interpreter. You will also
#@desc need <tt>protobuf</tt> and <tt>psutil</tt> installed for Python 3.</p>
#@desc <p>
#@desc This will launch the target on the local machine using <tt>lldb</tt>.
#@desc For setup instructions, press <b>F1</b>.
#@desc </p>
#@desc </body></html>
#@menu-group local
#@icon icon.debugger
@ -27,7 +28,7 @@
#@enum StartCmd:str "process launch" "process launch --stop-at-entry"
#@arg :str "Image" "The target binary executable image"
#@args "Arguments" "Command-line arguments to pass to the target"
#@env OPT_LLDB_PATH:str="lldb" "Path to lldb" "The path to lldb. Omit the full path to resolve using the system PATH."
#@env OPT_LLDB_PATH:str="lldb" "lldb command" "The path to lldb. Omit the full path to resolve using the system PATH."
#@env OPT_START_CMD:StartCmd="process launch" "Run command" "The lldb command to actually run the target."
#@env OPT_EXTRA_TTY:bool=false "Target TTY" "Provide a separate terminal emulator for the target."
#@tty TTY_TARGET if env:OPT_EXTRA_TTY

15
Ghidra/Debug/Debugger-agent-lldb/data/debugger-launchers/remote-lldb.sh
View File

@ -18,15 +18,10 @@
#@no-image
#@desc <html><body width="300px">
#@desc <h3>Launch with local <tt>lldb</tt> and connect to a stub (e.g., <tt>gdbserver</tt>)</h3>
#@desc <p>This will start <tt>lldb</tt> on the local system and then use it to connect to the remote system.
#@desc The actual command used is, e.g:</p>
#@desc <pre>gdb-remote host:port</pre>
#@desc <p>It may be worth testing this manually to ensure everything is configured correctly.
#@desc LLDB must be installed on your local system, it must be compatible with the remote system,
#@desc and it must embed the Python 3 interpreter. You will also need <tt>protobuf</tt> installed
#@desc for Python 3 on the local system. There are no Python requirements for the remote system.
#@desc Please ensure that Ghidra's current program and the target's image match. Otherwise, the
#@desc modules may not map.</p>
#@desc <p>
#@desc This will start <tt>lldb</tt> on the local system and then use it to connect to the remote system.
#@desc For setup instructions, press <b>F1</b>.
#@desc </p>
#@desc </body></html>
#@menu-group remote
#@icon icon.debugger
@ -34,7 +29,7 @@
#@env OPT_HOST:str="localhost" "Host" "The hostname of the target"
#@env OPT_PORT:str="9999" "Port" "The host's listening port"
#@env OPT_ARCH:str="" "Architecture" "Target architecture override"
#@env OPT_LLDB_PATH:str="lldb" "Path to lldb" "The path to lldb on the local system. Omit the full path to resolve using the system PATH."
#@env OPT_LLDB_PATH:str="lldb" "lldb command" "The path to lldb on the local system. Omit the full path to resolve using the system PATH."
if [ -d ${GHIDRA_HOME}/ghidra/.git ]
then

9
Ghidra/Debug/Debugger-rmi-trace/data/debugger-launchers/raw-python3.sh
View File

@ -19,14 +19,15 @@
#@no-image
#@desc <html><body width="300px">
#@desc <h3>Start <tt>gdb</tt></h3>
#@desc <p>This will start <tt>python</tt>, import <tt>ghidratrace</tt> and connect to it.
#@desc This connector is made for those wanting to explore the TraceRMI API and possibly develop
#@desc a new connector. You will need <tt>protobuf</tt> installed for Python 3.</p>
#@desc <p>
#@desc This will start <tt>python</tt>, import <tt>ghidratrace</tt> and connect to it for development purposes.
#@desc For setup instructions, press <b>F1</b>.
#@desc </p>
#@desc </body></html>
#@menu-group raw
#@icon icon.debugger
#@help TraceRmiLauncherServicePlugin#python_raw
#@env OPT_PYTHON_EXE:str="python" "Path to python" "The path to the Python 3 interpreter. Omit the full path to resolve using the system PATH."
#@env OPT_PYTHON_EXE:str="python" "python command" "The path to the Python 3 interpreter. Omit the full path to resolve using the system PATH."
#@env OPT_LANG:str="DATA:LE:64:default" "Ghidra Language" "The Ghidra LanguageID for the trace"
#@env OPT_COMP:str="pointer64" "Ghidra Compiler" "The Ghidra CompilerSpecID for the trace"

359
Ghidra/Debug/Debugger-rmi-trace/src/main/help/help/topics/TraceRmiLauncherServicePlugin/TraceRmiLauncherServicePlugin.html
View File

@ -105,21 +105,57 @@
properly-configured build of GDB for your target. If you are working with an embedded system,
it is probably safest to install the "multiarch" build of GDB from your package manager.</P>
<P>Once running, you are presented with GDB's command-line interface in Ghidra's Terminal. This
is the <EM>bona fide</EM> GDB command-line interface, so it has all the functionality you would
expect. If you command GDB from this shell, the plugin will keep Ghidra in sync. The terminal
can also be used to interact with the target application when it is running. The plugin
provides an additional set of commands for managing the connection to Ghidra, as well as
controlling trace synchronization. These are all in the "<TT>ghidra</TT>" command prefix. You
can use tab completion to enumerate the available commands and GDB's "<TT>help</TT>" command to
examine their documentation.</P>
<H4><A name="gdb_setup"></A>Setup</H4>
<P>You must have GDB installed on the local system, and it must embed the Python 3 interpreter.
If you have access to PyPI, setting up your Python 3 environment is done using Pip. Please note
the version specifier for Protobuf.</P>
<UL style="list-style-type: none">
<LI>
<PRE>
python3 -m pip install psutil protobuf==3.20.3
</PRE>
</LI>
</UL>
<P>If you are offline, or would like to use our provided packages, we still use Pip, but with a
more complicated invocation:</P>
<UL style="list-style-type: none">
<LI>
<PRE>
cd /path/to/ghidra_<EM>
version</EM>/Ghidra/Debug
python3 -m pip install --no-index -f Debugger-rmi-trace/pypkg/dist -f Debugger-agent-gdb/pypkg/dist psutil protobuf
</PRE>
</LI>
</UL>
<P>Beware that GDB may embed a different Python interpreter than your system's default. If you
are still getting import errors, check the version that GDB embeds:</P>
<UL style="list-style-type: none">
<LI>
<PRE>
(bash)$ gdb
(gdb) python-interactive
&gt;&gt;&gt; import sys
&gt;&gt;&gt; sys.version
</PRE>
</LI>
</UL>
<P>Note the version and ensure that you are invoking Pip with that version. Supposing
<TT>sys.version</TT> indicates 3.10, you should invoke Pip using <TT>python3.10 -m
pip</TT>.</P>
<H4>Options</H4>
<DIV class="image">
<IMG alt="" src="images/GdbLauncher.png">
</DIV>
<H4>Options</H4>
<UL>
<LI><B>Image</B>: This is the path to the target binary image (ELF). Ghidra will try to fill
this in based on information gathered when the current program was imported. If the file
@ -132,7 +168,7 @@
<LI><B>Arguments</B>: These are the command-line arguments to pass into the target process.
These are passed as is to GDB's "<TT>set args ...</TT>" command.</LI>
<LI><B>Path to <TT>gdb</TT></B>: This is the command or path to GDB. We recommend version 13
<LI><B><TT>gdb</TT> command</B>: This is the command or path to GDB. We recommend version 13
or later. We require version 8 or later.</LI>
<LI><B>Run command</B>: This is the GDB command to actually launch the target. In most cases
@ -145,6 +181,15 @@
window.</LI>
</UL>
<P>Once running, you are presented with GDB's command-line interface in Ghidra's Terminal. This
is the <EM>bona fide</EM> GDB command-line interface, so it has all the functionality you would
expect. If you command GDB from this shell, the plugin will keep Ghidra in sync. The terminal
can also be used to interact with the target application when it is running. The plugin
provides an additional set of commands for managing the connection to Ghidra, as well as
controlling trace synchronization. These are all in the "<TT>ghidra</TT>" command prefix. You
can use tab completion to enumerate the available commands and GDB's "<TT>help</TT>" command to
examine their documentation.</P>
<H3><A name="gdb_ssh"></A>GDB via SSH</H3>
<P>This works the same as the GDB launcher, but runs <TT>gdb</TT> on a remote system via
@ -152,10 +197,30 @@
launcher uses the <TT>ssh</TT> command on the local system. Thus, it should have broader
compatibility with remote systems, and it should use the same configuration files as you are
accustomed to. That said, we developed it using OpenSSH, so your experience will be best if
your copy understands the same command-line arguments. It will need to be capable of port
forwarding. The remote server must permit remote port forwarding (-R option) and terminal
allocation (<TT>-t</TT> option). You will also need to manually install the required Python
packages on the target host, comprising our plugin for GDB and its dependencies.</P>
your copy understands the same command-line arguments.</P>
<H4>Setup</H4>
<P>You must install GDB and an SSH server onto the target host. Your local SSH client must
support remote port forwarding (-R option) and terminal allocation (<TT>-t</TT> option), and
the remote server must be configured to permit them.</P>
<P>You will need to manually install the required Python packages on the <EM>target</EM> host,
comprising our plugin for GDB and its dependencies. Copy all of the Python packages from
<TT>Ghidra/Debug/Debugger-rmi-trace/pypkg/dist/</TT> and
<TT>Ghidra/Debug/Debugger-agent-gdb/pypkg/dist/</TT> to the remote system. It is easiest to put
them all in one directory, e.g., <TT>~/ghidra-pypgk/</TT>. Then install them:</P>
<UL style="list-style-type: none">
<LI>
<PRE>
python3 -m pip install --no-index -f ~/ghidra-pypkg/ ghidragdb
</PRE>
</LI>
</UL>
<P>Please see <A href="#gdb_setup">GDB Setup</A> for notes about embedded Python interpreter
versions.</P>
<H4>Options</H4>
@ -184,7 +249,7 @@
that syntax errors may cause strange behavior, and that not all features may be compatible
with this launcher.</LI>
<LI><B>Path to <TT>gdb</TT></B>: This works the same as in GDB, but with respect to the
<LI><B><TT>gdb</TT> command</B>: This works the same as in GDB, but with respect to the
<EM>remote</EM> file system.</LI>
<LI><B>Run command</B>: This works the same as in GDB.</LI>
@ -195,8 +260,9 @@
<H3><A name="gdb_gdbserver_ssh"></A>GDB + <TT>gdbserver</TT> via SSH</H3>
<P>This works similarly to the GDB via SSH launcher, but instead of tunneling the Trace RMI
connection, tunnels the RSP (gdbserver) connection. There is actually a fairly elegant method
of doing this straight from within <TT>gdb</TT>, which is exactly what this launcher does:</P>
connection, tunnels the RSP (<TT>gdbserver</TT>) connection. There is actually a fairly elegant
method of doing this straight from within <TT>gdb</TT>, which is exactly what this launcher
does:</P>
<UL style="list-style-type: none">
<LI>
@ -227,6 +293,15 @@ target remote | ssh user@host gdbserver - /path/to/image
address space, if the map is of interest to your analysis, it may not be available.</LI>
</OL>
<H4>Setup</H4>
<P>You must have GDB installed on the local system and a compatible version of
<TT>gdbserver</TT> installed on the target system. You must have an SSH server installed on the
target system. It may be worth testing your setup manually (outside of Ghidra) to ensure
everything is configured correctly. On the local system, follow the steps given in <A href=
"#gdb_setup">GDB Setup</A>. There are no additional Python requirements on the target
system.</P>
<H4>Options</H4>
<UL>
@ -241,7 +316,7 @@ target remote | ssh user@host gdbserver - /path/to/image
<LI><B>Extra <TT>ssh</TT> arguments</B>: This works the same as in GDB via SSH.</LI>
<LI><B>Path to <TT>gdbserver</TT></B>: This is the command or path to <TT>gdbserver</TT> with
<LI><B><TT>gdbserver</TT> command</B>: This is the command or path to <TT>gdbserver</TT> with
respect to the <EM>remote</EM> file system.</LI>
<LI><B>Extra <TT>gdbserver</TT> arguments</B>: These are extra arguments to pass to
@ -249,7 +324,7 @@ target remote | ssh user@host gdbserver - /path/to/image
dash. Beware that syntax errors may cause strange behavior, and that not all features may be
compatible with this launcher.</LI>
<LI><B>Path to <TT>gdb</TT></B>: This works the same as in GDB, with respect to the
<LI><B><TT>gdb</TT> command</B>: This works the same as in GDB, with respect to the
<EM>local</EM> file system.</LI>
<LI>Note there is no option to create a second Terminal (TTY) for the target.</LI>
@ -258,11 +333,14 @@ target remote | ssh user@host gdbserver - /path/to/image
<H3><A name="gdb_qemu"></A>QEMU + GDB</H3>
<P>This launcher orchestrates a QEMU user-mode target and connects to it using our Python
plugin for GDB. You will almost certainly need the "multiarch" build of GDB, and by default,
the launcher will try to use <TT>gdb-multiarch</TT>. You must also install the appropriate
build of QEMU for your target architecture. Ghidra will inspect the current program and attempt
to map its language to the appropriate QEMU command, but this may fail, or be subtly
incorrect.</P>
plugin for GDB. Ghidra will inspect the current program and attempt to map its language to the
appropriate QEMU command, but this may fail, or be subtly incorrect.</P>
<H4>Setup</H4>
<P>You must acquire a version of QEMU and GDB that support the target architecture. On many
distributions of Linux, you can install <TT>gdb-multiarch</TT>. Follow the steps given in <A
href="#gdb_setup">GDB Setup</A>.</P>
<H4>Options</H4>
@ -274,7 +352,7 @@ target remote | ssh user@host gdbserver - /path/to/image
<LI><B>Arguments</B>: These are the command-line arguments to pass into the target process.
These are passed as is on QEMU's command line.</LI>
<LI><B>Path to <TT>qemu</TT></B>: The command or path to QEMU.</LI>
<LI><B>QEMU command</B>: The command or path to QEMU.</LI>
<LI><B>QEMU Port</B>: An available TCP port for QEMU to listen on for GDB.</LI>
@ -283,7 +361,7 @@ target remote | ssh user@host gdbserver - /path/to/image
arguments. Beware that syntax errors may cause strange behavior, and that not all features
may be compatible with this launcher.</LI>
<LI><B>Path to <TT>gdb</TT></B>: This works the same as in GDB, but defaults to
<LI><B><TT>gdb</TT> command</B>: This works the same as in GDB, but defaults to
"gdb-multiarch."</LI>
<LI><B>QEMU TTY</B>: This works similarly as in GDB, but just runs QEMU in the second
@ -294,10 +372,18 @@ target remote | ssh user@host gdbserver - /path/to/image
<P>This launchers runs <TT>wine</TT> in a <TT>gdb</TT> session on Linux and directs it to a
target Windows executable. There are other ways to rig a Windows target in GDB on Linux, but
this is the method we have chosen: You will need to install Wine on your system and locate the
actual <TT>wine</TT> executable. These are often in some library directory and named
"<TT>wine32</TT>" or "<TT>wine64</TT>." To find them, either examine the file list of the
installed package, or dissect the wrapper <TT>wine</TT> script, usually on your path:</P>
this is the method we have chosen. This may prevent GDB from processing the object file,
because it is a PE file, and most copies of GDB for UNIX will support only ELF. Nevertheless,
Ghidra should recognize the target and map it, giving you symbols and debug info in the front
end, even if not in the GDB CLI.</P>
<H4>Setup</H4>
<P>In addition to the steps given in <A href="#gdb_setup">GDB Setup</A>, you must install Wine
on your system. Prepare for configuration by locating the actual <TT>wine</TT> executable.
These are often in some library directory and named "<TT>wine32</TT>" or "<TT>wine64</TT>." To
find them, either examine the file list of the installed package, or dissect the wrapper
<TT>wine</TT> script, usually on your path:</P>
<UL style="list-style-type: none">
<LI>
@ -337,7 +423,7 @@ less $(which wine)
<LI><B>Path to <TT>wine</TT> binary</B>: The path to wine for your target architecture. <FONT
color="red">See note above!</FONT></LI>
<LI><B>Path to <TT>gdb</TT></B>: This works the same as in GDB.</LI>
<LI><B><TT>gdb</TT> command</B>: This works the same as in GDB.</LI>
<LI><B>Inferior TTY</B>: This works the same as in GDB.</LI>
</UL>
@ -359,6 +445,15 @@ target remote [host]:[port]
compatible before using this launcher. This launcher does not require an image, nor does it
create your target. Thus, it can be used without a current program.</P>
<H4>Setup</H4>
<P>On your local system, follow the steps given in <A href="#gdb_setup">GDB Setup</A>. Your
version of GDB must be compatible with the stub (e.g., <TT>gdbserver</TT>) on the target
system. There are no additional requirements on the target system.</P>
<P><B>NOTE:</B> The target program image must match that imported in Ghidra, or else things may
not map or synchronize correctly.</P>
<H4>Options</H4>
<UL>
@ -375,7 +470,7 @@ target remote [host]:[port]
session outside of Ghidra to see the list of available options in your configuration. You may
want to use <TT>gdb-multiarch</TT>.</LI>
<LI><B>Path to <TT>gdb</TT></B>: This works the same as in GDB, though you may want to use
<LI><B><TT>gdb</TT> command</B>: This works the same as in GDB, though you may want to use
<TT>gdb-multiarch</TT>.</LI>
</UL>
@ -388,17 +483,19 @@ target remote [host]:[port]
to ensure your target maps to the current program, if you happen to have one. You may have to
do it manually.</P>
<H4>Setup</H4>
<P>Follow the steps given in <A href="#gdb_setup">GDB Setup</A>.</P>
<H4>Options</H4>
<UL>
<LI><B>Path to <TT>gdb</TT></B>: This works the same as in GDB.</LI>
<LI><B><TT>gdb</TT> command</B>: This works the same as in GDB.</LI>
<LI><B>Architecture</B>: Because the trace is created before the target, you must specify the
target's architecture.</LI>
<LI style="list-style: none">This is passed as is to "<TT>set arch ...</TT>" immediately
before the "<TT>target ...</TT>" command. Enter "<TT>set arch</TT>" into a GDB session
outside of Ghidra to see the list of available options in your configuration.</LI>
target's architecture. This is passed as is to "<TT>set arch ...</TT>" immediately before the
"<TT>target ...</TT>" command. Enter "<TT>set arch</TT>" into a GDB session outside of Ghidra
to see the list of available options in your configuration.</LI>
</UL>
<H2>Stock LLDB Launchers</H2>
@ -409,17 +506,53 @@ target remote [host]:[port]
<P>This launcher is a Python plugin for LLDB, and so is well suited for debugging user-space
targets on a variety of platforms. It is the <EM>de facto</EM> debugger for macOS. It can be
obtained by installing XCode from the App Store. Though it may require a bit more careful
obtained by installing Xcode from the App Store. Though it may require a bit more careful
configuration, it can also be obtained from other repositories like <TT>brew</TT>.</P>
<P>Once running, you are presented with LLDB's command-line interface in Ghidra's Terminal.
This is the <EM>bona fide</EM> LLDB command-line interface, so it has all the functionality you
would expect. If you command LLDB from this shell, the plugin will keep Ghidra in sync. The
terminal can be used to interact with the target application when it is running. The plugin
provides an additional set of commands for managing the connection to Ghidra, as well as
controlling trace synchronization. These are all in the "<TT>ghidra</TT>" category. You can use
tab completion to enumerate the available commands and LLDB's "<TT>help</TT>" command to
examine their documentation.</P>
<H4><A name="lldb_setup"></A>Setup</H4>
<P>You must have LLDB installed on the local system, and it must embed the Python 3
interpreter. If you have access to PyPI, setting up your Python 3 environment is done using
Pip. Please note the version specifier for Protobuf.</P>
<UL style="list-style-type: none">
<LI>
<PRE>
python3 -m pip install psutil protobuf==3.20.3
</PRE>
</LI>
</UL>
<P>If you are offline, or would like to use our provided packages, we still use Pip, but with a
more complicated invocation:</P>
<UL style="list-style-type: none">
<LI>
<PRE>
cd /path/to/ghidra_<EM>
version</EM>/Ghidra/Debug
python3 -m pip install --no-index -f Debugger-rmi-trace/pypkg/dist -f Debugger-agent-lldb/pypkg/dist psutil protobuf
</PRE>
</LI>
</UL>
<P>Beware that LLDB may embed a different Python interpreter than your system's default. If you
are still getting import errors, check the version that LLDB embeds:</P>
<UL style="list-style-type: none">
<LI>
<PRE>
(bash)$ lldb
(lldb) script
&gt;&gt;&gt; import sys
&gt;&gt;&gt; sys.version
</PRE>
</LI>
</UL>
<P>Note the version and ensure that you are invoking Pip with that version. Supposing
<TT>sys.version</TT> indicates 3.10, you should invoke Pip using <TT>python3.10 -m
pip</TT>.</P>
<H4>Options</H4>
@ -435,7 +568,7 @@ target remote [host]:[port]
<LI><B>Arguments</B>: These are the command-line arguments to pass into the target. These are
passed as is to LLDB's "<TT>settings set target.run-args ...</TT>" command.</LI>
<LI><B>Path to <TT>lldb</TT></B>: This is the command or path to LLDB. We recommend version
<LI><B><TT>lldb</TT> command</B>: This is the command or path to LLDB. We recommend version
15 or later.</LI>
<LI><B>Run command</B>: This is the LLDB command to actually launch the target. In most cases
@ -448,6 +581,15 @@ target remote [host]:[port]
direct the target's I/O to a second Terminal window.</LI>
</UL>
<P>Once running, you are presented with LLDB's command-line interface in Ghidra's Terminal.
This is the <EM>bona fide</EM> LLDB command-line interface, so it has all the functionality you
would expect. If you command LLDB from this shell, the plugin will keep Ghidra in sync. The
terminal can be used to interact with the target application when it is running. The plugin
provides an additional set of commands for managing the connection to Ghidra, as well as
controlling trace synchronization. These are all in the "<TT>ghidra</TT>" category. You can use
tab completion to enumerate the available commands and LLDB's "<TT>help</TT>" command to
examine their documentation.</P>
<H3><A name="lldb_remote"></A>Remote LLDB</H3>
<P>This launcher can target any TCP-based GDB stub that is compatible with a local copy of
@ -465,6 +607,15 @@ gdb-remote [host]:[port]
compatible before using this launcher. This launcher does not require an image, nor does it
create your target. Thus, it can be used without a current program.</P>
<H4>Setup</H4>
<P>On your local system, follow the steps given in <A href="#lldb_setup">LLDB Setup</A>. Your
version of LLDB must be compatible with the stub (e.g., <TT>gdbserver</TT>) on the target
system. There are no additional requirements on the target system.</P>
<P><B>NOTE:</B> The target program image must match that imported in Ghidra, or else things may
not map or synchronize correctly.</P>
<H4>Options</H4>
<UL>
@ -476,7 +627,7 @@ gdb-remote [host]:[port]
you must set it before connecting. This is passed as is to "<TT>setting set
target.default-arch ...</TT>" immediately before the "<TT>gdb-remote ...</TT>" command.</LI>
<LI><B>Path to <TT>llddb</TT></B>: This works the same as in LLDB.</LI>
<LI><B><TT>lldb</TT> command</B>: This works the same as in LLDB.</LI>
</UL>
<H2>Stock Windows Debugger (WinDbg) Launchers</H2>
@ -491,26 +642,53 @@ gdb-remote [host]:[port]
suited for debugging Windows user-space targets. Windows kernel targets are not yet supported.
This DLL also backs WinDbg and several other debuggers on Windows. By default, the launcher
will search for this DLL in an installation of the Windows Debugging Kits version 10. If it
does not find it there, it will fall back to the one provided with Windows, which is
substantially less capable. Installing WinDbg is highly recommended. Please note on some system
configurations, one of the debugger's dependencies <TT>dbghelp.dll</TT> may get loaded from the
system directory instead of from the WinDbg installation, usually because a security product
has pre-loaded it into the Python process. You might work around this by copying the affected
DLLs from your WinDbg installation into your Python installation.</P>
does not find it there, it will probably crash with a message in the Terminal.</P>
<P>Once running, you are presented with a command-line interface in Ghidra's Terminal. This CLI
accepts your usual WinDbg (kd) commands. You can escape from this CLI and enter a Python 3 REPL
by entering "<TT>.exit</TT>". This is not an actual kd command, but our implementation
understands this to mean exit the kd REPL. From the Python 3 REPL, you can access the
underlying Python-based API <TT>pybag</TT>. This is an uncommon need, but may be useful for
diagnostics and/or workarounds. To re-enter the kd REPL, enter "<TT>repl()</TT>".
Alternatively, if you are trying to quit, but typed "<TT>.exit</TT>", just type
"<TT>quit()</TT>" to terminate the session.</P>
<P>Please note on some system configurations, one of the debugger's dependencies
<TT>dbghelp.dll</TT> may get loaded from the system directory instead of from the WinDbg
installation, usually because a security product has pre-loaded it into the Python process. You
might work around this by copying the affected DLLs from your WinDbg installation into your
Python installation.</P>
<H4><A name="dbg_setup"></A>Setup</H4>
<P>Installing WinDbg is highly recommended. If you wish to forego installing WinDbg, you can
use the DLL provided with Windows, which is substantially less capable, by manually pointing
this connector to <TT>C:\Windows\system32</TT>. If you do this, some commands, e.g.
<TT>.server</TT>, will not be available.</P>
<P>If you have access to PyPI, setting up your Python 3 environment is done using Pip. Please
note the version specifier for Protobuf.</P>
<UL style="list-style-type: none">
<LI>
<PRE>
python3 -m pip install pybag protobuf==3.20.3
</PRE>
</LI>
</UL>
<P>If you are offline, or would like to use our provided packages, we still use Pip, but with a
more complicated invocation:</P>
<UL style="list-style-type: none">
<LI>
<PRE>
cd /path/to/ghidra_<EM>
version</EM>/Ghidra/Debug
python3 -m pip install --no-index -f Debugger-rmi-trace/pypkg/dist -f Debugger-agent-dbgeng/pypkg/dist pybag protobuf
</PRE>
</LI>
</UL>
<P>If you get an import error regarding <TT>distutils</TT>, it is due to a transitive
dependency on a buggy version of <TT>capstone</TT>. Work around it by installing
<TT>setuptools</TT>.</P>
<H4>Options</H4>
<UL>
<LI><B>Path to <TT>python</TT></B>: This is the command or path to the Python interpreter. It
<LI><B><TT>python</TT> command</B>: This is the command or path to the Python interpreter. It
must be version 3. Python 2 is not supported.</LI>
<LI><B>Image</B>: This is the path to the target binary image (EXE file). Ghidra will try to
@ -530,15 +708,24 @@ gdb-remote [host]:[port]
available from <TT>dbgeng.dll</TT>. Disabling this option will prevent the launcher from
using <TT>dbgmodel.dll</TT>, even when it is available.</LI>
<LI><B>Path to <TT>dbgeng</TT></B>: By default, the launcher allows the underlying
<TT>pybag</TT> package to locate the Windows Debugger DLLs. This is typically found by
examining the registry for a Windows Kits 10 installation. Otherwise, it may check its
typical installation directory before falling back to those in the Windows system directory.
This option allows you to override this search. For example, if you have installed WinDbg
Preview or later from the Microsoft Store and wish to use its DLLs, you will need to fill in
this option.</LI>
<LI><B>Path to <TT>dbgeng.dll</TT> directory</B>: By default, the launcher allows the
underlying <TT>pybag</TT> package to locate the Windows Debugger DLLs. This is typically
found by examining the registry for a Windows Kits 10 installation. Otherwise, it may check
its typical installation directory. This will <EM>not</EM> search the Windows system
directory, but you can configure it manually here. This option allows you to override this
search. For example, if you have installed WinDbg Preview or later from the Microsoft Store
and wish to use its DLLs, you will need to fill in this option.</LI>
</UL>
<P>Once running, you are presented with a command-line interface in Ghidra's Terminal. This CLI
accepts your usual WinDbg (kd) commands. You can escape from this CLI and enter a Python 3 REPL
by entering "<TT>.exit</TT>". This is not an actual kd command, but our implementation
understands this to mean exit the kd REPL. From the Python 3 REPL, you can access the
underlying Python-based API <TT>pybag</TT>. This is an uncommon need, but may be useful for
diagnostics and/or workarounds. To re-enter the kd REPL, enter "<TT>repl()</TT>".
Alternatively, if you are trying to quit, but typed "<TT>.exit</TT>", just type
"<TT>quit()</TT>" to terminate the session.</P>
<H3><A name="dbgeng_ttd"></A>TTD (Time-Travel Debugging)</H3>
<P>This is a nascent extension to our launcher for the Windows Debugger. The launcher itself
@ -584,10 +771,36 @@ gdb-remote [host]:[port]
namespace. Thus, a developer can explore the API, invoke methods, and observer how Ghidra
reacts.</P>
<H4><A name="raw_setup"></A>Setup</H4>
<P>If you have access to PyPI, setting up your Python 3 environment is done using Pip. Please
note the version specifier for Protobuf.</P>
<UL style="list-style-type: none">
<LI>
<PRE>
python3 -m pip install protobuf==3.20.3
</PRE>
</LI>
</UL>
<P>If you are offline, or would like to use our provided packages, we still use Pip, but with a
more complicated invocation:</P>
<UL style="list-style-type: none">
<LI>
<PRE>
cd /path/to/ghidra_<EM>
version</EM>/Ghidra/Debug
python3 -m pip install --no-index -f Debugger-rmi-trace/pypkg/dist protobuf
</PRE>
</LI>
</UL>
<H4>Options</H4>
<UL>
<LI><B>Path to <TT>python</TT></B>: This is the command or path to <TT>python</TT> version 3.
<LI><B><TT>python</TT> command</B>: This is the command or path to <TT>python</TT> version 3.
Python 2 is not supported.</LI>
<LI><B>Ghidra Language</B>: The LanguageID for the blank trace.</LI>

BIN
Ghidra/Debug/Debugger-rmi-trace/src/main/help/help/topics/TraceRmiLauncherServicePlugin/images/GdbLauncher.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 17 KiB

After

Width:  |  Height:  |  Size: 14 KiB

3
Ghidra/Debug/Debugger-rmi-trace/src/main/java/ghidra/app/plugin/core/debug/gui/tracermi/launcher/AbstractTraceRmiLaunchOffer.java
View File

@ -321,6 +321,7 @@ public abstract class AbstractTraceRmiLaunchOffer implements TraceRmiLaunchOffer
DebuggerMethodInvocationDialog dialog =
new DebuggerMethodInvocationDialog(tool, getTitle(), "Launch", getIcon());
dialog.setDescription(getDescription());
dialog.setHelpLocation(getHelpLocation());
// NB. Do not invoke read/writeConfigState
Map<String, ?> args;
boolean reset = false;
@ -681,6 +682,6 @@ public abstract class AbstractTraceRmiLaunchOffer implements TraceRmiLaunchOffer
}
protected ErrPromptResponse promptError(LaunchResult result) {
return LaunchFailureDialog.show(result);
return LaunchFailureDialog.show(result, getHelpLocation());
}
}

8
Ghidra/Debug/Debugger-rmi-trace/src/main/java/ghidra/app/plugin/core/debug/gui/tracermi/launcher/LaunchFailureDialog.java
View File

@ -21,6 +21,7 @@ import docking.widgets.OptionDialog;
import ghidra.debug.api.tracermi.TerminalSession;
import ghidra.debug.api.tracermi.TraceRmiLaunchOffer.LaunchResult;
import ghidra.util.HTMLUtilities;
import ghidra.util.HelpLocation;
public class LaunchFailureDialog extends OptionDialog {
private static final String MSGPAT_PART_TOP = """
@ -116,8 +117,8 @@ public class LaunchFailureDialog extends OptionDialog {
return sb.toString();
}
public static ErrPromptResponse show(LaunchResult result) {
return switch (new LaunchFailureDialog(result).show()) {
public static ErrPromptResponse show(LaunchResult result, HelpLocation helpLocation) {
return switch (new LaunchFailureDialog(result, helpLocation).show()) {
case OptionDialog.YES_OPTION -> ErrPromptResponse.KEEP;
case OptionDialog.NO_OPTION -> ErrPromptResponse.RETRY;
case OptionDialog.CANCEL_OPTION -> ErrPromptResponse.TERMINATE;
@ -125,8 +126,9 @@ public class LaunchFailureDialog extends OptionDialog {
};
}
protected LaunchFailureDialog(LaunchResult result) {
protected LaunchFailureDialog(LaunchResult result, HelpLocation helpLocation) {
super("Launch Failed", formatMessage(result), hasResources(result) ? "&Keep" : null,
"&Retry", OptionDialog.ERROR_MESSAGE, null, true, "Retry");
setHelpLocation(helpLocation);
}
}