Merge remote-tracking branch 'origin/Ghidra_12.0'

sys.modules each time a script is run (Closes #8529)

CONTRIBUTING.md

@@ -29,98 +29,106 @@ Patches should be submitted in the form of Pull Requests to the Ghidra
 [repository] on GitHub. But first, consider the following tips to ensure a
 smooth process when submitting a patch:
 
-- Ensure that the patch compiles and does not break any build-time tests.
-- Be understanding, patient, and friendly; developers may need time to review
-  your submissions before they can take action or respond. This does not mean
-  your contribution is not valued. If your contribution has not received a
-  response in a reasonable time, consider commenting with a polite inquiry for
-  an update.
-- Limit your patches to the smallest reasonable change to achieve your intended
-  goal. For example, do not make unnecessary indentation changes; but don't go
-  out of your way to make the patch so minimal that it isn't easy to read,
-  either. Consider the reviewer's perspective.
-- Unless previously authorized by the Ghidra team, repackaging, renaming, and 
-  other refactoring should not be part of any pull request. These types of 
-  changes are difficult to review, pollute the git history making it harder 
-  to do git forensics on regressions, and will likely conflict with other 
-  changes that the Ghidra team is making internally.
-- Avoid "find and replace" changes in your pull request.  While it may be 
-  tempting to globally replace calls to deprecated methods or change the style
-  of the code to fit your personal preference, these types of seemingly trivial
-  changes have likely not already been performed by the Ghidra team for good 
-  reason.
-- Focus your patches on bug fixes that were discovered through real-world
-  usage and testing, and on improvements that clearly satisfy a need in 
-  Ghidra's functionality.  Before you begin implementing, consider first
-  opening a dialogue with the Ghidra team to ensure that your efforts will 
-  align with the goals of the project.  This will significantly improve the odds
-  that your patch gets accepted.
-- Unless it addresses a critical security update, avoid pull requests that update 
-  jars or other 3rd party libraries.  It is preferred that these changes are made
-  internally by the team.  If you have a need for an updated library, please
-  submit an issue with your request instead of a pull request.
-- Before submission, please squash your commits to using a message that starts
-  with the issue number and a description of the changes.
-- Isolate multiple patches from each other. If you wish to make several
-  independent patches, do so in separate, smaller pull requests that can be
-  reviewed more easily.
-- Be prepared to answer questions from reviewers. They may have further
-  questions before accepting your patch, and may even propose changes. Please
-  accept this feedback constructively, and not as a rejection of your proposed
-  change.
+- Ensure that the patch compiles and runs in at least our development environment, and ideally our
+  full build too. Even the most trivial change done in the GitHub editor has a chance to cause
+  problems in the full development environment for unexpected reasons.
+- If using "AI" to assist in development, please apply extra scrutity to its suggestions, in terms
+  of both correctness and adherence to our [legal](#legal) requirements.
+- Be understanding, patient, and friendly; developers may need time to review your submissions 
+  before they can take action or respond. This does not mean your contribution is not valued. If 
+  your contribution has not received a response in a reasonable time, consider commenting with a 
+  polite inquiry for an update.
+- Limit your patches to the smallest reasonable change to achieve your intended goal. For example, 
+  do not make unnecessary indentation changes; but don't go out of your way to make the patch so 
+  minimal that it isn't easy to read, either. Consider the reviewer's perspective.
+- Unless previously authorized by the Ghidra team, repackaging, renaming, and other refactoring 
+  should not be part of any pull request. These types of changes are difficult to review, pollute 
+  the git history making it harder to do git forensics on regressions, and will likely conflict with
+  other changes that the Ghidra team is making internally.
+- Avoid "find and replace" changes in your pull request. While it may be  tempting to globally 
+  replace calls to deprecated methods or change the style of the code to fit your personal 
+  preference, these types of seemingly trivial changes have likely not already been performed by the
+  Ghidra team for good reason.
+- Focus your patches on bug fixes that were discovered through real-world usage and testing, and on
+  improvements that clearly satisfy a need in Ghidra's functionality. Before you begin 
+  implementing, consider first opening a dialogue with the Ghidra team to ensure that your efforts
+  will align with the goals of the project. This will significantly improve the odds that your 
+  patch gets accepted.
+- Unless it addresses a critical security update, avoid pull requests that update jars or other 3rd
+  party libraries. It is preferred that these changes are made internally by the team. If you have
+  a need for an updated library, please submit an issue with your request instead of a pull request.
+- Before submission, please squash your commits to using a message that starts with the issue number
+  and a description of the changes.
+- Isolate multiple patches from each other. If you wish to make several independent patches, do so 
+  in separate, smaller pull requests that can be reviewed more easily.
+- Avoid submitting self-generated binary files as part of your pull request. Despite your best 
+  intentions, our policy forbids accepting them because we cannot effectively review and validate 
+  their content.
+- Be prepared to answer questions from reviewers. They may have further questions before accepting
+  your patch, and may even propose changes. Please accept this feedback constructively, and not as a
+  rejection of your proposed change.
 
 ## Review
 
-- We welcome code reviews from anyone. A committer is required to formally
-  accept and merge the changes.
-- Reviewers will be looking for things like threading issues, performance
-  implications, API design, duplication of existing functionality, readability
-  and code style, avoidance of bloat (scope-creep), etc.
+- We welcome code reviews from anyone. A committer is required to formally accept and merge the 
+  changes.
+- Reviewers will be looking for things like threading issues, performance implications, API design,
+  duplication of existing functionality, readability and code style, avoidance of bloat 
+  (scope-creep), etc.
 - Reviewers will likely ask questions to better understand your change.
 - Reviewers will make comments about changes to your patch:
     - MUST means that the change is required
-    - SHOULD means that the change is suggested, further discussion on the
-      subject may be required
+    - SHOULD means that the change is suggested, further discussion on the subject may be required
     - COULD means that the change is optional
 
 ## Getting Started
 
-Once available, please see the [developer's guide][devguide] for instructions to set up a suitable development environment.
+Once available, please see the [developer's guide][devguide] for instructions to set up a suitable 
+development environment.
 
 ## Timeline and Managing Expectations
 
-As we continue to engage contributors and learn best practices for running a successful open source project, our processes 
-and guidance will likely evolve. We will try to communicate expectations as we are able and to always be responsive. We 
-hope that the community will share their suggestions for improving this engagement.  Based on the level of initial interest 
-we receive and the availability of resources to evaluate contributions, we anticipate the following:
+As we continue to engage contributors and learn best practices for running a successful open source 
+project, our processes and guidance will likely evolve. We will try to communicate expectations as 
+we are able to and be responsive. We hope that the community will share their suggestions for
+improving this engagement. Based on the level of initial interest we receive and the availability 
+of resources to evaluate contributions, we anticipate the following:
 
-- We will initially prioritize pull requests that include small bug fixes and code that addresses potential vulnerabilities   
-  as well as pull requests that include improvements for processor language specifications because these require a 
-  reasonable amount of effort to evaluate and will help us exercise and revise our process for accepting contributions.  In 
-  other words, we are going to start small in order to work out the kinks first.
-- We are committed to maintaining the integrity and security of our code base.  In addition to the careful review the 
-  maintainers will give to code contributions to make sure they do not introduce new bugs or vulnerabilities, we will be 
-  trying to identify best practices to incorporate with our open source project so that contributors can have more control 
-  over whether their contributions are accepted. These might include things like style guides and requirements for tests and 
-  documentation to accompany some code contributions.  As a result, it may take a long time for some contributions to be 
-  accepted.  This does not mean we are ignoring them.
-- We are committed to integrating this GitHub project with our team's regular development work flow so that the open source 
-  project remains dynamic and relevant.  This may  affect our responsiveness and ability to accept pull requests 
-  quickly.  This does not mean we are ignoring them.
-- Not all innovative ideas need to be accepted as pull requests into this GitHub project to be valuable to the community.        
-  There may be times when we recommend that you just share your code for some enhancement to Ghidra from your own 
-  repository. As we identify and recognize extensions that are of general interest to the reverse engineering community, we 
-  may seek to incorporate them with our baseline.
+- We will initially prioritize pull requests that include small bug fixes and code that addresses 
+  potential vulnerabilities as well as pull requests that include improvements for processor 
+  language specifications because these require a reasonable amount of effort to evaluate and will
+  help us exercise and revise our process for accepting contributions. In other words, we are going
+  to start small in order to work out the kinks first.
+- We are committed to maintaining the integrity and security of our code base. In addition to the
+  careful review the maintainers will give to code contributions to make sure they do not introduce
+  new bugs or vulnerabilities, we will be trying to identify best practices to incorporate with our
+  open source project so that contributors can have more control over whether their contributions 
+  are accepted. These might include things like style guides and requirements for tests and 
+  documentation to accompany some code contributions. As a result, it may take a long time for some
+  contributions to be accepted. This does not mean we are ignoring them.
+- We are committed to integrating this GitHub project with our team's regular development work flow
+  so that the open source project remains dynamic and relevant. This may  affect our responsiveness
+  and ability to accept pull requests quickly. This does not mean we are ignoring them.
+- Not all innovative ideas need to be accepted as pull requests into this GitHub project to be 
+  valuable to the community. There may be times when we recommend that you just share your code for
+  some enhancement to Ghidra from your own repository. As we identify and recognize extensions that
+  are of general interest to the reverse engineering community, we may seek to incorporate them with
+  our baseline.
 
 ## Legal
 
-Consistent with Section D.6. of the GitHub Terms of Service as of 2019, and Section 5. of the Apache License, Version 2.0, the project maintainer for this project accepts contributions using the inbound=outbound model.
-When you submit a pull request to this repository (inbound), you are agreeing to license your contribution under the same terms as specified in [LICENSE] (outbound).
+Consistent with Section D.6. of the GitHub Terms of Service as of 2019, and Section 5. of the Apache
+License, Version 2.0, the project maintainer for this project accepts contributions using the 
+inbound=outbound model. When you submit a pull request to this repository (inbound), you are 
+agreeing to license your contribution under the same terms as specified in [LICENSE] (outbound).
 
-This is an open source project.
-Contributions you make to this public U.S. Government ("USG") repository are completely voluntary.
-When you submit an issue, bug report, question, enhancement, pull request, etc., you are offering your contribution without expectation of payment, you expressly waive any future pay claims against the USG related to your contribution, and you acknowledge that this does not create an obligation on the part of the USG of any kind.
-Furthermore, your contributing to this project does not create an employer-employee relationship between the United States ("U.S.") Government and the contributor.
+This is an open source project. Contributions you make to this public U.S. Government ("USG") 
+repository are completely voluntary. When you submit an issue, bug report, question, enhancement, 
+pull request, etc., you are offering your contribution without expectation of payment, you expressly
+waive any future pay claims against the USG related to your contribution, and you acknowledge that
+this does not create an obligation on the part of the USG of any kind. Furthermore, your 
+contributing to this project does not create an employer-employee relationship between the United 
+States ("U.S.") Government and the contributor.
 
 [issues]: https://github.com/NationalSecurityAgency/ghidra/issues
 [repository]: https://github.com/NationalSecurityAgency/ghidra/

DevGuide.md

@@ -2,7 +2,7 @@
 
 ## Environment
 * Primary Language: [Java][java]
-* Secondary Languages: [C++][cpp], [Sleigh][sleigh], [Jython][jython]
+* Secondary Languages: [C++][cpp], [Sleigh][sleigh], [Python 3][python] [Jython 2.7][jython]
 * Integrated Development Environment: [Eclipse][eclipse]
 * Build System: [Gradle][gradle]
 * Source Control: [Git][git]
@@ -41,6 +41,12 @@ will be stored at `$HOME/.gradle/`.
 gradle prepdev
 ```
 
+Clean up repository build files.  In rare circumstances this may be necessary after a `git pull` to
+fix unexplainable compilation errors.
+```
+gradle clean
+```
+
 Generate nested Eclipse project files which can then be imported into Eclipse as "existing 
 projects".
 ```
@@ -62,7 +68,7 @@ Build Javadoc:
 gradle createJavadocs
 ```
 
-Build Python3 packages for the Debugger:
+Build Python3 packages for PyGhidra and the Debugger:
 ```
 gradle buildPyPackage
 ```
@@ -87,10 +93,47 @@ prevent specific tasks from running:
 gradle buildGhidra -x ip
 ```
 
-## Known Issues
-* There is a known issue in Gradle that can prevent it from discovering native toolchains on Linux 
-  if a non-English system locale is being used. As a workaround, set the following environment 
-  variable prior to running your Gradle task: `LC_MESSAGES=en_US.UTF-8`
+## PyGhidra Development
+The supported way to develop and debug PyGhidra is with the _[PyDev][pydev]_ plugin for Eclipse.
+When PyDev is installed and configured, several new Eclipse run configurations will appear that
+enable running and debugging PyGhidra from both _GUI_ and _Interpreter_ modes.
+
+To prepare PyGhidra for development and/or debugging, first execute the following gradle task:
+```
+gradle prepPyGhidra
+```
+This sets up a Python virtual environment at `build/venv/`, and installs an editable PyGhidra
+module (and its dependencies) into it. PyDev should be pointed at this virtual environment so it has
+access to the editable PyGhidra module, as well as the typing/stub information. From Eclipse 
+(with PyDev installed):
+
+1. _Settings -> PyDev -> Interpreters -> Python Interpreter_
+2. Click _New..._
+3. Click _Browse for python/pypy exe_
+4. Choose `build/venv/bin/python3`
+5. Enter a value for _Interpreter Name_
+6. Check _Select All_ and press _OK_
+7. Click the _Prefined_ tab, and then _New..._
+8. Choose `build/typestubs/pypredef`
+9. Click _Apply and Close_
+
+## GhidraDev Eclipse Plugin Development
+Developing the GhidraDev Eclipse plugin requires the 
+_Eclipse PDE (Plug-in Development Environment)_, which can be installed via the Eclipse marketplace.
+It is also included in the _Eclipse IDE for RCP and RAP Developers_. To generate the GhidraDev 
+Eclipse projects and prepare the necessary dependencies, execute:
+
+```
+gradle prepGhidraDev eclipse -PeclipsePDE
+```
+
+Import the newly generated GhidraDev projects into an Eclipse that supports this type of project. 
+
+__Note:__ If you are getting compilation errors related to PyDev and CDT, go into Eclipse's 
+preferences, and under _Target Platform_, activate _/Eclipse GhidraDevPlugin/GhidraDev.target_.
+
+See [Building GhidraDev](GhidraBuild/EclipsePlugins/GhidraDev/GhidraDevPlugin/README.md#building)
+for instructions on how to build the GhidraDev plugin.
 
 ## Offline Development Environment
 Sometimes you may want to move the Ghidra repository to an offline network and do development there.
@@ -107,24 +150,6 @@ directory in the user’s home directory.  Overriding it to be inside the Ghidra
 ensure that all maven central dependencies that were fetched during the `prepdev` task will be moved
 along with the rest of the repo.
 
-## Developing GhidraDev Eclipse Plugin
-Developing the GhidraDev Eclipse plugin requires the 
-_Eclipse PDE (Plug-in Development Environment)_, which can be installed via the Eclipse marketplace.
-It is also included in the _Eclipse IDE for RCP and RAP Developers_. To generate the GhidraDev 
-Eclipse projects, execute:
-
-```
-gradle eclipse -PeclipsePDE
-```
-
-Import the newly generated GhidraDev projects into an Eclipse that supports this type of project. 
-
-__Note:__ If you are getting compilation errors related to PyDev and CDT, go into Eclipse's 
-preferences, and under _Target Platform_, activate _/Eclipse GhidraDevPlugin/GhidraDev.target_.
-
-See [GhidraDevPlugin/build_README.txt](GhidraBuild/EclipsePlugins/GhidraDev/GhidraDevPlugin/build_README.txt)
-for instructions on how to build the GhidraDev plugin.
-
 ## Running tests
 To run unit tests, do:
 ```
@@ -188,7 +213,7 @@ If you'd like some details of our fine tuning, take a look at [building_fid.txt]
 ## Debugger Development
 
 We have recently changed the Debugger's back-end architecture.
-We no longer user JNA to access native Debugger APIs.
+We no longer use JNA to access native Debugger APIs.
 We only use it for pseudo-terminal access.
 Instead, we use Python3 and a protobuf-based TCP connection for back-end integration.
 
@@ -215,19 +240,13 @@ description and status.
  time.
  * Framework-AsyncComm - a collection of utilities for asynchronous communication (packet formats
  and completable-future conveniences).
- * Framework-Debugging - specifies interfaces for debugger models and provides implementation
- conveniences. This is mostly deprecated.
- * Debugger - the collection of Ghidra plugins and services comprising the Debugger UI.
+ * Debugger-api - the interfaces for interacting with the Debugger UI.
+ * Debugger - the collection of Ghidra plugins and services comprising the Debugger UI implementation.
+ * Debugger-isf - A service providing access to Ghidra's DataTypes via ISF.
  * Debugger-rmi-trace - the wire protocol, client, services, and UI components for Trace RMI, the new back-end architecture.
- * Debugger-agent-dbgeng - the connector for WinDbg (via dbgeng.dll) on Windows x64.
- * Debugger-agent-dbgmodel - an experimental connector for WinDbg Preview (with TTD, via 
- dbgmodel.dll) on Windows x64. This is deprecated, as most of these features are implemented in Debugger-agent-dbgeng for the new architecture.
- * Debugger-agent-dbgmodel-traceloader - an experimental "importer" for WinDbg trace files. This is deprecated.
- * Debugger-agent-gdb - the connector for GDB (13 or later recommended) on UNIX.
- * Debugger-swig-lldb - the Java language bindings for LLDB's SBDebugger, also proposed upstream. This is deprecated. We now use the Python3 language bindings for LLDB.
+ * Debugger-agent-dbgeng - the connector for WinDbg (via dbgeng.dll and dbgmodel.dll) on Windows x64.
+ * Debugger-agent-gdb - the connector for GDB (13 or later recommended) on UNIX and Windows.
  * Debugger-agent-lldb - the connector for LLDB (10 or later recommended) on macOS, UNIX, and Windows.
- * Debugger-gadp - the connector for our custom wire protocol the Ghidra Asynchronous Debugging 
- Protocol. This is deprecated. It's replaced by Debugger-rmi-trace.
  * Debugger-jpda - an in-development connector for Java and Dalvik debugging via JDI (i.e., JDWP). This is deprecated and not yet replaced.
 
 The Trace Modeling schema records machine state and markup over time.
@@ -236,7 +255,7 @@ Trace "recording" is a de facto requirement for displaying information in Ghidra
 The back-end connector has full discretion over what is recorded by using Trace RMI.
 Typically, only the machine state actually observed by the user (or perhaps a script) is recorded.
 For most use cases, the Trace is small and ephemeral, serving only to mediate between the UI components and the target's model.
-It supports many of the same markup (e.g., disassembly, data types) as Programs, in addition to tracking active threads, loaded modues, breakpoints, etc.
+It supports many of the same markup (e.g., disassembly, data types) as Programs, in addition to tracking active threads, loaded modules, breakpoints, etc.
 
 Every back end (or "adapter" or "connector" or "agent") employs the Trace RMI client to populate a trace database.
 As a general rule in Ghidra, no component is allowed to access a native API and reside in the same JVM as the Ghidra UI.
@@ -246,13 +265,12 @@ This also allows us to better bridge the language gap between Java and Python, w
 This protocol is loosely coupled to Framework-TraceModeling, essentially exposing its methods via RMI, as well as some methods for controlling the UI.
 The protocol is built using Google's Protobuf library, providing a potential path for back-end implementations in alternative languages.
 We provide the Trace RMI server as a Ghidra component implemented in Java and the Trace RMI client as a Python3 package.
+The client is also available in Java, but it depends heavily on Ghidra's code base.
 A back-end implementation may be a stand-alone executable or script that accesses the native debugger's API, or a script or plugin for the native debugger.
 It then connects to Ghidra via Trace RMI to populate the trace database with information gleaned from that API.
 It should provide a set of diagnostic commands to control and monitor that connection.
 It should also use the native API to detect session and target changes so that Ghidra's UI consistently reflects the debugging session.
-
-The old system relied on a "recorder" to discover targets and map them to traces in the proper Ghidra language.
-That responsibility is now delegated to the back end.
+It is the back-end's responsibility to discover targets in the session and map them to traces in the proper Ghidra language.
 Typically, it examines the target's architecture and immediately creates a trace upon connection.
 
 ### Developing a new connector
@@ -272,18 +290,19 @@ When things go wrong, it could be because of, without limitation:
 We are still (yes, still) in the process of writing up this documentation.
 In the meantime, we recommend using the GDB and dbgeng agents as examples.
 Be sure to look at the Python code `src/main/py`!
-The deprecated Java code `src/main/java` is still included as we transition.
+This is not so readily presented by Eclipse.
 
 You'll also need to provide launcher(s) so that Ghidra knows how to configure and start your connector.
 These are just shell scripts.
 We use bash scripts on Linux and macOS, and we use batch files on Windows.
+The ideal goal for a launcher is (after one-time configuration) the user can launch and begin debugging with a single click.
 Try to include as many common use cases as makes sense for the debugger.
 This provides the most flexibility to users and examples to power users who might create derivative launchers.
 Look at the existing launchers for examples.
 
 For testing, please follow the examples for GDB.
 We no longer provide abstract classes that prescribe requirements.
-Instead, we just provide GDB as an example.
+Instead, we just provide GDB as an example or template.
 Usually, we split our tests into three categories:
 
  * Commands
@@ -296,10 +315,10 @@ In general, do the minimum connection setup, execute the command, and check that
 The Methods tests check that the remote methods, conventionally implemented in `methods.py`, work correctly.
 Many methods are just wrappers around CLI commands, some provided by the native debugger and some provided by `commands.py`.
 These work similarly to the commands test, except that they invoke methods instead of executing commands.
-Again, check the return value (rarely applicable) and that it causes the expected effects.
+Check the return value (rarely applicable) and that it causes the expected effects.
 
 The Hooks tests check that the back end is able to listen for session and target changes, e.g., knowing when the target stops.
-*The test should not "cheat" by executing commands or invoking methods that should instead be triggered by the listener.*
+*The test should not "cheat" by executing commands or invoking methods that should instead be triggered by the hook.*
 It should execute the minimal commands to setup the test, then trigger an event.
 It should then check that the event in turn triggered the expected effects, e.g., updating PC upon the target stopping.
 
@@ -341,12 +360,68 @@ We also provide out-of-the-box QEMU integration via GDB.
 
 When submitting help tickets and pull requests, please tag those related to the debugger with "Debugger" so that we can triage them more quickly.
 
+## Troubleshooting and Help
+
+### Eclipse Issues
+After pulling or syncing with the latest Ghidra source repository, you might run into the following
+issues in Eclipse:
+
+* __Problem:__ _There are Eclipse compilation errors that I don't know how to deal with...I give up!_
+  * __Solution:__
+    * From Eclipse, collapse all projects in the _Package Explorer_ or _Project Explorer_ by
+      clicking the `⊟` icon in that frame
+    * Locate any projects in the _Package Explorer_ or _Project Explorer_ that have little `?` icons
+      on them (these projects should no longer be in source control)
+    * Right-click on __only them__, and then click _Delete_.
+    * __CHECK__ the _"Delete project contents on disk"_ checkbox.
+    * Click _OK_ (confirm git does not contain any new unstaged files for delete)
+    * Select all projects in the _Package Explorer_ or _Project Explorer_
+    * Right-click on them, and then click _Delete_ (this may not work if projects are not collapsed)
+    * Leave _"Delete project contents on disk"_ checkbox __UNCHECKED__
+    * Click _OK_.  You should now have an empty _Package Explorer_ or _Project Explorer_.
+    * `gradle -I gradle/support/fetchDependencies.gradle`
+    * `gradle prepdev cleanEclipse eclipse buildNatives`
+    * From Eclipse, _File -> Import..._
+    * _General | Existing Projects into Workspace_
+    * Select root directory to be your downloaded or cloned ghidra source repository
+    * Check _"Search for nested projects"_
+    * Click _Finish_
+    
+    This should get Eclipse back to a fresh state. There should never be a need to re-clone the
+    repository.
+
+* __Problem:__ _The Ghidra run configurations (launchers) are missing_.
+  * __Solution:__
+    The Ghidra run configurations are kept under source control in various modules' `.launch/` 
+    directories (i.e., `Ghidra/Features/Base/.launch/`). As long as the corresponding module 
+    project is imported into Eclipse (i.e., `Features Base`), the run configurations should be
+    available in Eclipse under _Run -> Run Configurations_.  If they aren't there and the 
+    projects are imported, try closing and reopening Eclipse. 
+    
+    __NOTE:__ Sometimes you have to launch Ghidra via the _Run -> Run Configurations..._ window one
+    time for the run configuration to show up under the favorites menu in the main Eclipse button 
+    bar.
+    
+    __NOTE:__ Never address missing run configurations by manually importing them via _File -> 
+    Import... -> Run/Debug -> Launch Configurations._ This avoids the real issue and will 
+    inevitably result in duplicate run configurations showing up one day, which can cause
+    additional confusion.
+
+## Known Issues
+* There is a known issue in Gradle that can prevent it from discovering native toolchains on Linux 
+  if a non-English system locale is being used. As a workaround, set the following environment 
+  variable prior to running your Gradle task: `LC_MESSAGES=en_US.UTF-8`
+* If the Ghidra build is only finding versions of Python that do not have access to `pip`, it may
+  be necessary to perform the build from a Python [virtual environment][venv].
 
 [java]: https://dev.java
 [cpp]: https://isocpp.org
-[sleigh]: https://htmlpreview.github.io/?https://github.com/NationalSecurityAgency/ghidra/blob/master/GhidraDocs/languages/index.html
+[sleigh]: https://htmlpreview.github.io/?https://github.com/NationalSecurityAgency/ghidra/blob/stable/GhidraDocs/languages/index.html
+[python]: https://www.python.org
+[venv]: https://docs.python.org/3/tutorial/venv.html
 [jython]: https://www.jython.org
 [eclipse]: https://www.eclipse.org/downloads/
+[pydev]: https://www.pydev.org
 [gradle]: https://gradle.org
 [git]: https://git-scm.com
 [apache]: https://www.apache.org/licenses/LICENSE-2.0

GPL/DMG/README.md

@@ -0,0 +1 @@
+# DMG

GPL/DMG/certification.manifest

@@ -3,6 +3,7 @@
 ##MODULE IP: LGPL 2.1
 ##MODULE IP: Public Domain
 Module.manifest||Public Domain||||END|
+README.md||GHIDRA||||END|
 data/lib/csframework.jar||LGPL 2.1||||END|
 data/lib/hfsexplorer-0_21-src.zip||GPL 3||||END|
 data/lib/hfsx.jar||GPL 3||||END|

GPL/DMG/src/dmg/java/mobiledevices/dmg/ghidra/GDataConverterBE.java

@@ -13,9 +13,6 @@ package mobiledevices.dmg.ghidra;
 public class GDataConverterBE implements GDataConverter {
 	public static final GDataConverterBE INSTANCE = new GDataConverterBE();
 
-	/**
-	 * 
-	 */
 	private static final long serialVersionUID = 1L;
 
 	/**
@@ -27,6 +24,7 @@ public class GDataConverterBE implements GDataConverter {
 	/**
 	 * @see GDataConverter#getShort(byte[])
 	 */
+	@Override
 	public final short getShort(byte[] b) {
 		return getShort(b, 0);
 	}
@@ -34,6 +32,7 @@ public class GDataConverterBE implements GDataConverter {
 	/**
 	 * @see GDataConverter#getShort(byte[], int)
 	 */
+	@Override
 	public short getShort(byte[] b, int offset) {
 		return (short) (((b[offset] & 0xff) << 8) | (b[offset + 1] & 0xff));
 	}
@@ -41,6 +40,7 @@ public class GDataConverterBE implements GDataConverter {
 	/**
 	 * @see GDataConverter#getInt(byte[])
 	 */
+	@Override
 	public final int getInt(byte[] b) {
 		return getInt(b, 0);
 	}
@@ -48,6 +48,7 @@ public class GDataConverterBE implements GDataConverter {
 	/**
 	 * @see GDataConverter#getInt(byte[], int)
 	 */
+	@Override
 	public int getInt(byte[] b, int offset) {
 		int v = b[offset];
 		for (int i = 1; i < 4; i++) {
@@ -59,6 +60,7 @@ public class GDataConverterBE implements GDataConverter {
 	/**
 	 * @see GDataConverter#getLong(byte[])
 	 */
+	@Override
 	public final long getLong(byte[] b) {
 		return getLong(b, 0);
 	}
@@ -66,6 +68,7 @@ public class GDataConverterBE implements GDataConverter {
 	/**
 	 * @see GDataConverter#getLong(byte[], int)
 	 */
+	@Override
 	public long getLong(byte[] b, int offset) {
 		long v = b[offset];
 		for (int i = 1; i < 8; i++) {
@@ -77,6 +80,7 @@ public class GDataConverterBE implements GDataConverter {
 	/**
 	 * @see GDataConverter.util.DataConverter#getValue(byte[], int)
 	 */
+	@Override
 	public long getValue(byte[] b, int size) {
 		return getValue(b, 0, size);
 	}
@@ -84,6 +88,7 @@ public class GDataConverterBE implements GDataConverter {
 	/**
 	 * @see GDataConverter.util.DataConverter#getValue(byte[], int, int)
 	 */
+	@Override
 	public long getValue(byte[] b, int offset, int size) {
 		if (size > 8) {
 			throw new IndexOutOfBoundsException("size exceeds sizeof long: " + size);
@@ -98,6 +103,7 @@ public class GDataConverterBE implements GDataConverter {
 	/**
 	 * @see GDataConverter#getBytes(short, byte[])
 	 */
+	@Override
 	public final void getBytes(short value, byte[] b) {
 		getBytes(value, b, 0);
 	}
@@ -105,6 +111,7 @@ public class GDataConverterBE implements GDataConverter {
 	/**
 	 * @see GDataConverter#getBytes(short, byte[], int)
 	 */
+	@Override
 	public void getBytes(short value, byte[] b, int offset) {
 		b[offset] = (byte) (value >> 8);
 		b[offset + 1] = (byte) (value & 0xff);
@@ -113,6 +120,7 @@ public class GDataConverterBE implements GDataConverter {
 	/**
 	 * @see GDataConverter#getBytes(int, byte[])
 	 */
+	@Override
 	public final void getBytes(int value, byte[] b) {
 		getBytes(value, b, 0);
 	}
@@ -120,6 +128,7 @@ public class GDataConverterBE implements GDataConverter {
 	/**
 	 * @see GDataConverter#getBytes(int, byte[], int)
 	 */
+	@Override
 	public void getBytes(int value, byte[] b, int offset) {
 		b[offset + 3] = (byte) (value);
 		for (int i = 2; i >= 0; i--) {
@@ -131,6 +140,7 @@ public class GDataConverterBE implements GDataConverter {
 	/**
 	 * @see GDataConverter#getBytes(long, byte[])
 	 */
+	@Override
 	public final void getBytes(long value, byte[] b) {
 		getBytes(value, 8, b, 0);
 	}
@@ -138,6 +148,7 @@ public class GDataConverterBE implements GDataConverter {
 	/**
 	 * @see GDataConverter#getBytes(long, byte[], int)
 	 */
+	@Override
 	public void getBytes(long value, byte[] b, int offset) {
 		getBytes(value, 8, b, offset);
 	}
@@ -145,6 +156,7 @@ public class GDataConverterBE implements GDataConverter {
 	/**
 	 * @see GDataConverter.util.DataConverter#getBytes(long, int, byte[], int)
 	 */
+	@Override
 	public void getBytes(long value, int size, byte[] b, int offset) {
 		for (int i = size - 1; i >= 0; i--) {
 			b[offset + i] = (byte) value;
@@ -155,6 +167,7 @@ public class GDataConverterBE implements GDataConverter {
 	/**
 	 * @see GDataConverter.util.DataConverter#putInt(byte[], int, int)
 	 */
+	@Override
 	public final void putInt(byte[] b, int offset, int value) {
 		getBytes(value, b, offset);
 	}
@@ -162,6 +175,7 @@ public class GDataConverterBE implements GDataConverter {
 	/**
 	 * @see GDataConverter.util.DataConverter#putInt(byte[], int)
 	 */
+	@Override
 	public final void putInt(byte[] b, int value) {
 		getBytes(value, b);
 	}
@@ -169,6 +183,7 @@ public class GDataConverterBE implements GDataConverter {
 	/**
 	 * @see GDataConverter.util.DataConverter#putLong(byte[], int, long)
 	 */
+	@Override
 	public final void putLong(byte[] b, int offset, long value) {
 		getBytes(value, b, offset);
 	}
@@ -176,6 +191,7 @@ public class GDataConverterBE implements GDataConverter {
 	/**
 	 * @see GDataConverter.util.DataConverter#putLong(byte[], long)
 	 */
+	@Override
 	public final void putLong(byte[] b, long value) {
 		getBytes(value, b);
 	}
@@ -183,6 +199,7 @@ public class GDataConverterBE implements GDataConverter {
 	/**
 	 * @see GDataConverter.util.DataConverter#putShort(byte[], int, short)
 	 */
+	@Override
 	public final void putShort(byte[] b, int offset, short value) {
 		getBytes(value, b, offset);
 	}
@@ -190,6 +207,7 @@ public class GDataConverterBE implements GDataConverter {
 	/**
 	 * @see GDataConverter.util.DataConverter#putShort(byte[], short)
 	 */
+	@Override
 	public final void putShort(byte[] b, short value) {
 		getBytes(value, b);
 	}
@@ -197,6 +215,7 @@ public class GDataConverterBE implements GDataConverter {
 	/**
 	 * @see GDataConverter.util.DataConverter#getBytes(int)
 	 */
+	@Override
 	public byte[] getBytes(int value) {
 		byte[] bytes = new byte[4];
 		getBytes(value, bytes);
@@ -206,6 +225,7 @@ public class GDataConverterBE implements GDataConverter {
 	/**
 	 * @see GDataConverter.util.DataConverter#getBytes(long)
 	 */
+	@Override
 	public byte[] getBytes(long value) {
 		byte[] bytes = new byte[8];
 		getBytes(value, bytes);
@@ -215,6 +235,7 @@ public class GDataConverterBE implements GDataConverter {
 	/**
 	 * @see GDataConverter.util.DataConverter#getBytes(short)
 	 */
+	@Override
 	public byte[] getBytes(short value) {
 		byte[] bytes = new byte[2];
 		getBytes(value, bytes);

GPL/DMG/src/dmg/java/mobiledevices/dmg/ghidra/GDataConverterLE.java

@@ -11,9 +11,7 @@ package mobiledevices.dmg.ghidra;
 
 public class GDataConverterLE implements GDataConverter {
 	public static GDataConverterLE INSTANCE = new GDataConverterLE();
-	/**
-	 * 
-	 */
+
 	private static final long serialVersionUID = 1L;
 
 	/**
@@ -25,6 +23,7 @@ public class GDataConverterLE implements GDataConverter {
 	/**
 	 * @see GDataConverter#getShort(byte[])
 	 */
+	@Override
 	public final short getShort(byte[] b) {
 		return getShort(b, 0);
 	}
@@ -32,6 +31,7 @@ public class GDataConverterLE implements GDataConverter {
 	/**
 	 * @see GDataConverter#getShort(byte[], int)
 	 */
+	@Override
 	public short getShort(byte[] b, int offset) {
 		return (short) (((b[offset + 1] & 0xff) << 8) | (b[offset] & 0xff));
 	}
@@ -39,6 +39,7 @@ public class GDataConverterLE implements GDataConverter {
 	/**
 	 * @see GDataConverter#getInt(byte[])
 	 */
+	@Override
 	public final int getInt(byte[] b) {
 		return getInt(b, 0);
 	}
@@ -46,6 +47,7 @@ public class GDataConverterLE implements GDataConverter {
 	/**
 	 * @see GDataConverter#getInt(byte[], int)
 	 */
+	@Override
 	public int getInt(byte[] b, int offset) {
 		int v = b[offset + 3];
 		for (int i = 2; i >= 0; i--) {
@@ -57,6 +59,7 @@ public class GDataConverterLE implements GDataConverter {
 	/**
 	 * @see GDataConverter#getLong(byte[])
 	 */
+	@Override
 	public final long getLong(byte[] b) {
 		return getLong(b, 0);
 	}
@@ -64,6 +67,7 @@ public class GDataConverterLE implements GDataConverter {
 	/**
 	 * @see GDataConverter#getLong(byte[], int)
 	 */
+	@Override
 	public long getLong(byte[] b, int offset) {
 		long v = b[offset + 7];
 		for (int i = 6; i >= 0; i--) {
@@ -75,6 +79,7 @@ public class GDataConverterLE implements GDataConverter {
 	/**
 	 * @see ghidra.util.GDataConverter#getValue(byte[], int)
 	 */
+	@Override
 	public long getValue(byte[] b, int size) {
 		return getValue(b, 0, size);
 	}
@@ -82,6 +87,7 @@ public class GDataConverterLE implements GDataConverter {
 	/**
 	 * @see ghidra.util.GDataConverter#getValue(byte[], int, int)
 	 */
+	@Override
 	public long getValue(byte[] b, int offset, int size) {
 		if (size > 8) {
 			throw new IndexOutOfBoundsException("size exceeds sizeof long: " + size);
@@ -96,6 +102,7 @@ public class GDataConverterLE implements GDataConverter {
 	/**
 	 * @see GDataConverter#getBytes(short, byte[])
 	 */
+	@Override
 	public final void getBytes(short value, byte[] b) {
 		getBytes(value, b, 0);
 	}
@@ -103,6 +110,7 @@ public class GDataConverterLE implements GDataConverter {
 	/**
 	 * @see GDataConverter#getBytes(short, byte[], int)
 	 */
+	@Override
 	public void getBytes(short value, byte[] b, int offset) {
 		b[offset + 1] = (byte) (value >> 8);
 		b[offset] = (byte) (value & 0xff);
@@ -111,6 +119,7 @@ public class GDataConverterLE implements GDataConverter {
 	/**
 	 * @see GDataConverter#getBytes(int, byte[])
 	 */
+	@Override
 	public final void getBytes(int value, byte[] b) {
 		getBytes(value, b, 0);
 	}
@@ -118,6 +127,7 @@ public class GDataConverterLE implements GDataConverter {
 	/**
 	 * @see GDataConverter#getBytes(int, byte[], int)
 	 */
+	@Override
 	public void getBytes(int value, byte[] b, int offset) {
 		b[offset] = (byte) (value);
 		for (int i = 1; i < 4; i++) {
@@ -129,6 +139,7 @@ public class GDataConverterLE implements GDataConverter {
 	/**
 	 * @see GDataConverter#getBytes(long, byte[])
 	 */
+	@Override
 	public final void getBytes(long value, byte[] b) {
 		getBytes(value, 8, b, 0);
 	}
@@ -136,6 +147,7 @@ public class GDataConverterLE implements GDataConverter {
 	/**
 	 * @see GDataConverter#getBytes(long, byte[], int)
 	 */
+	@Override
 	public void getBytes(long value, byte[] b, int offset) {
 		getBytes(value, 8, b, offset);
 	}
@@ -143,6 +155,7 @@ public class GDataConverterLE implements GDataConverter {
 	/**
 	 * @see ghidra.util.GDataConverter#getBytes(long, int, byte[], int)
 	 */
+	@Override
 	public void getBytes(long value, int size, byte[] b, int offset) {
 		for (int i = 0; i < size; i++) {
 			b[offset + i] = (byte) value;
@@ -153,6 +166,7 @@ public class GDataConverterLE implements GDataConverter {
 	/**
 	 * @see ghidra.util.GDataConverter#putInt(byte[], int, int)
 	 */
+	@Override
 	public final void putInt(byte[] b, int offset, int value) {
 		getBytes(value, b, offset);
 	}
@@ -160,6 +174,7 @@ public class GDataConverterLE implements GDataConverter {
 	/**
 	 * @see ghidra.util.GDataConverter#putInt(byte[], int)
 	 */
+	@Override
 	public final void putInt(byte[] b, int value) {
 		getBytes(value, b);
 	}
@@ -167,6 +182,7 @@ public class GDataConverterLE implements GDataConverter {
 	/**
 	 * @see ghidra.util.GDataConverter#putLong(byte[], int, long)
 	 */
+	@Override
 	public final void putLong(byte[] b, int offset, long value) {
 		getBytes(value, b, offset);
 	}
@@ -174,6 +190,7 @@ public class GDataConverterLE implements GDataConverter {
 	/**
 	 * @see ghidra.util.GDataConverter#putLong(byte[], long)
 	 */
+	@Override
 	public final void putLong(byte[] b, long value) {
 		getBytes(value, b);
 	}
@@ -181,6 +198,7 @@ public class GDataConverterLE implements GDataConverter {
 	/**
 	 * @see ghidra.util.GDataConverter#putShort(byte[], int, short)
 	 */
+	@Override
 	public final void putShort(byte[] b, int offset, short value) {
 		getBytes(value, b, offset);
 	}
@@ -188,6 +206,7 @@ public class GDataConverterLE implements GDataConverter {
 	/**
 	 * @see ghidra.util.GDataConverter#putShort(byte[], short)
 	 */
+	@Override
 	public final void putShort(byte[] b, short value) {
 		getBytes(value, b);
 	}
@@ -195,6 +214,7 @@ public class GDataConverterLE implements GDataConverter {
 	/**
 	 * @see ghidra.util.GDataConverter#getBytes(int)
 	 */
+	@Override
 	public byte[] getBytes(int value) {
 		byte[] bytes = new byte[4];
 		getBytes(value, bytes);
@@ -204,6 +224,7 @@ public class GDataConverterLE implements GDataConverter {
 	/**
 	 * @see ghidra.util.GDataConverter#getBytes(long)
 	 */
+	@Override
 	public byte[] getBytes(long value) {
 		byte[] bytes = new byte[8];
 		getBytes(value, bytes);
@@ -213,6 +234,7 @@ public class GDataConverterLE implements GDataConverter {
 	/**
 	 * @see ghidra.util.GDataConverter#getBytes(short)
 	 */
+	@Override
 	public byte[] getBytes(short value) {
 		byte[] bytes = new byte[2];
 		getBytes(value, bytes);

GPL/DemanglerGnu/README.md

@@ -0,0 +1 @@
+# DemanglerGnu

GPL/DemanglerGnu/build.gradle

@@ -35,8 +35,8 @@ def srcVersion24 = "src/demangler_gnu_v2_24"
  */
 task zipBuildableSource(type:Zip) {
 
-	group 'private'
-	description "Collects the source files needed to build this module."
+	group = 'private'
+	description = "Collects the source files needed to build this module."
 	archiveBaseName = project.name + "-src-for-build"
 	archiveExtension = 'zip'
 		

GPL/DemanglerGnu/certification.manifest

@@ -5,5 +5,5 @@
 ##MODULE IP: LGPL 3.0
 ##MODULE IP: Public Domain
 Module.manifest||Public Domain||||END|
+README.md||GHIDRA||||END|
 src/demangler_gnu_v2_24/README.txt||Public Domain||||END|
-src/demangler_gnu_v2_33_1/README.txt||Public Domain||||END|

GPL/DemanglerGnu/src/demangler_gnu_v2_24/c/cplus-dem.c

@@ -903,7 +903,7 @@ ada_demangle (const char *mangled, int option ATTRIBUTE_UNUSED)
     goto unknown;
 
   /* Most of the demangling will trivially remove chars.  Operator names
-     may add one char but because they are always preceeded by '__' which is
+     may add one char but because they are always preceded by '__' which is
      replaced by '.', they eventually never expand the size.
      A few special names such as '___elabs' add a few chars (at most 7), but
      they occur only once.  */

GPL/DemanglerGnu/src/demangler_gnu_v2_41/c/cplus-dem.c

@@ -219,7 +219,7 @@ ada_demangle (const char *mangled, int option ATTRIBUTE_UNUSED)
     goto unknown;
 
   /* Most of the demangling will trivially remove chars.  Operator names
-     may add one char but because they are always preceeded by '__' which is
+     may add one char but because they are always preceded by '__' which is
      replaced by '.', they eventually never expand the size.
      A few special names such as '___elabs' add a few chars (at most 7), but
      they occur only once.  */

GPL/GnuDisassembler/README.md

@@ -0,0 +1,27 @@
+# GnuDisassembler
+
+The GnuDisassembler extension module must be built using gradle prior to its use within Ghidra.
+
+This module provides the ability to leverage the binutils disassembler capabilities
+for various processors as a means of verifying Sleigh disassembler output syntax.
+
+To build this extension for Linux or macOS:
+
+1. If building for an installation of Ghidra, copy the appropriate source distribution of binutils 
+   into this module's root directory. If building within a git clone of the full Ghidra source, copy
+   binutils source distribution file into the `ghidra.bin/GPL/GnuDisassembler` directory.
+	   
+   The supported version and archive format is identified within the build.gradle file. If a 
+   different binutils distribution is used the build.gradle and/or buildGdis.gradle	may require 
+   modification.
+	   
+   The build requires the following packages to be installed:
+   * flex
+   * bison
+   * texinfo
+   * zlib1g-dev
+	   
+2. Run gradle from the module's root directory (see top of `build.gradle` file for specific 
+instructions). 
+
+This resulting gdis executable will be located in `build/os/<platform>`.

GPL/GnuDisassembler/README.txt

@@ -1,26 +0,0 @@
-The GnuDisassembler extension module must be built using gradle prior to its' use within Ghidra.
-
-This module provides the ability to leverage the binutils disassembler capabilities
-for various processors as a means of verifying Sleigh disassembler output syntax.
-
-To build this extension for Linux or Mac OS X:
-
-	1. If building for an installation of Ghidra, copy the appropriate source distribution of 
-	   binutils into this module's root directory.  If building within a git clone of the full
-	   Ghidra source, copy binutils source distribution file into the ghidra.bin/GPL/GnuDisassembler 
-	   directory.
-	   
-	   The supported version and archive format is identified within the build.gradle file.
-	   If a different binutils distribution is used the build.gradle and/or buildGdis.gradle
-	   may require modification.
-	   
-	   The build requires the following packages to be installed:
-	     * flex
-	     * bison
-	     * texinfo
-	     * zlib1g-dev
-	   
-	2. Run gradle from the module's root directory (see top of build.gradle file for
-	   specific instructions). 
-
-This resulting gdis executable will be located in build/os/<platform>.

GPL/GnuDisassembler/buildGdis.gradle

@@ -76,8 +76,8 @@ gradle.taskGraph.whenReady {
  * Task to unpack the standard binutils zip file
  *******************************************************************************************/
 task binutilsUnpack {
-	description "Unpack binutils (for building gdis)"
-	group "Native Build Dependencies"
+	description = "Unpack binutils (for building gdis)"
+	group = "Native Build Dependencies"
 	outputs.file { binutilsUnpackDir }
 	onlyIf { !binutilsUnpackDir.exists() }
 	
@@ -104,8 +104,8 @@ supportedPlatforms.each { platform ->
 	def artifactsDir = file("build/binutils/${platform}")
 		
 	task(buildName) {
-		description "Configure and make binutils for $platform (for building gdis)"
-		group "Native Prebuild Dependencies"
+		description ="Configure and make binutils for $platform (for building gdis)"
+		group = "Native Prebuild Dependencies"
 		
 		onlyIf { !configDir.exists() }
 		
@@ -122,21 +122,21 @@ supportedPlatforms.each { platform ->
 			println "Configuring binutils - config directory: $configDir"
 			println "${binutilsDir}/configure --prefix=\"${configDir}\" --enable-targets=all --with-zlib=no --disable-nls --disable-werror"
 			configDir.mkdirs();
-			exec {
+			providers.exec {
 				workingDir configDir
 				commandLine "${binutilsDir}/configure", "--prefix=${configDir}", "--enable-targets=all", "--with-zlib=no", "--disable-nls",  "--disable-werror"
-			}
+			}.result.get()
 			
 			println "Building binutils - config directory: $configDir"
-			exec {
+			providers.exec {
 				commandLine "make", "-C", "${configDir}", "all"
-			}
+			}.result.get()
 		}	
 	}
 	
 	task(postBuildName, type: Copy) {
-		description "Copy binutil artifcacts for $platform (for building gdis)"
-		group "Native Prebuild Dependencies"
+		description = "Copy binutil artifcacts for $platform (for building gdis)"
+		group = "Native Prebuild Dependencies"
 		
 		dependsOn buildName
 		

GPL/GnuDisassembler/certification.manifest

@@ -3,7 +3,7 @@
 ##MODULE IP: Public Domain
 .gitignore||Public Domain||||END|
 Module.manifest||Public Domain||||END|
-README.txt||Public Domain||||END|
+README.md||GHIDRA||||END|
 data/arm_test1.s||Public Domain||||END|
 data/big.elf||Public Domain||||END|
 data/little.elf||Public Domain||||END|

GPL/nativeBuildProperties.gradle

@@ -34,39 +34,25 @@ model {
 		}
 	}	
 
-	// The toolChains block is needed because Gradle doesn't find gcc/clang on ARM-based Linux
-	// and macOS platforms without explicitly declaring their targets.  Might be a bug in the 
-	// native Gradle plugin. 
+	// The toolChains block is needed because Gradle doesn't find the native toolchain in various
+	// scenarios. These checks, can be removed when Gradle fixes them, and we advertise a
+	// minimum Gradle version that includes the fix.
 	toolChains {
-		if (isCurrentLinux()) {
-			gcc(Gcc) {
-				if (isCurrentArm_64()) {
-					target("linux_arm_64")
+		def current = getCurrentPlatformName()
+		if (isLinux(current)) {
+			// https://github.com/gradle/gradle/issues/17660 (fixed in Gradle 8.11)
+			gcc(Gcc).target(current)
+			clang(Clang).target(current)
 		}
+		if (isFreeBSD(current)) {
+			// https://github.com/gradle/gradle/issues/32895
+			gcc(Gcc).target(current)
+			clang(Clang).target(current)
 		}
-		}
-		if (isCurrentMac()) {
-			clang(Clang) {
-				if (isCurrentArm_64()) {
-					target("mac_arm_64")
-				}
-			}
-		}
-		if (isCurrentFreeBSD()) {
-			gcc(Gcc) {
-				if (isCurrentArm_64()) {
-					target("freebsd_arm_64")
-				} 
-				else {
-					target("freebsd_x86_64")
-				}
-			}
-		}
-		if (isCurrentWindows() && VISUAL_STUDIO_INSTALL_DIR) {
-			// specify installDir because Gradle doesn't find VS Build Tools.
-			// See https://github.com/gradle/gradle-native/issues/617#issuecomment-575735288
+		if (isWindows(current) && VISUAL_STUDIO_INSTALL_DIR) {
+			// https://github.com/gradle/gradle-native/issues/617#issuecomment-575735288
 			visualCpp(VisualCpp) {
-				installDir VISUAL_STUDIO_INSTALL_DIR
+				installDir = VISUAL_STUDIO_INSTALL_DIR
 			}
 		}
 	}
@@ -121,6 +107,9 @@ def isNativeBinaryMakeTask(Task task, String platform) {
  *
  ******************************************************************************************/
 def shouldSkipNative(task) {
+	if (rootProject.hasProperty("skipAllNatives")) {
+		return true;
+	}
 	return task.ext.has("skipNative") && task.ext.get("skipNative")
 }
 

GPL/vsconfig.gradle

@@ -34,7 +34,7 @@ def configureVisualStudio() {
 			println "  -> To manually specify the location of vswhere.exe, add \"-PvswherePath=<vswhere path>\" to the Gradle command line arguments"
 			return
 		}
-		def vswhereProcess = "\"${vswherePath}\" -products * -latest -requires Microsoft.VisualStudio.Component.VC.Tools.x86.x64 -format json -utf8".execute()
+		def vswhereProcess = "\"${vswherePath}\" -products * -sort -prerelease -requires Microsoft.VisualStudio.Component.VC.Tools.x86.x64 -format json -utf8".execute()
 		def vswhereOutput = vswhereProcess.text.trim()
 		def vswhereExit = vswhereProcess.exitValue()
 		if (vswhereExit != 0) {
@@ -45,15 +45,31 @@ def configureVisualStudio() {
 				println "  -> Visual Studio vswhere.exe returned an error code (${vswhereExit})!"
 			}
 			println "  -> Please confirm ${vswherePath} is version 2.5 or later."
-			println "  -> Please check README.md or InstallationGuide.html to verify you are using a supported version of Visual Studio." 
+			println "  -> Please check README.md or GettingStarted.md to verify you are using a supported version of Visual Studio." 
 			return
 		}
 		def vswhereJson = new groovy.json.JsonSlurper().parseText(vswhereOutput);
-		if (vswhereJson.isEmpty()) {
+		def usePrerelease = project.hasProperty("vswherePrerelease")
+		def i = -1
+		println "  -> Searching for Visual Studio installations..."
+		vswhereJson.eachWithIndex { item, index ->
+			def isPrerelease = item.get("isPrerelease")
+			def name = item.get("displayName") + (isPrerelease ? " Prerelease" : "")
+			if (i == -1) {
+				if (usePrerelease || !isPrerelease) {
+					i = index
+				}
+			}
+			println "     ${index + 1}: ${name}" + 
+				(i == index ? " (selected)" : "") +
+				(isPrerelease && !usePrerelease ? " (enable with -PvswherePrerelease)" : "")
+		}
+		if (i == -1) {
 			println "  -> Visual Studio not found!"
 			return
 		}
-		def vsInstallDir = vswhereJson[0].installationPath
+		
+		def vsInstallDir = vswhereJson[i].installationPath
 		println "  -> Installation Directory: ${vsInstallDir}"
 
 		// Use vcvarsall.bat to determine the latest Visual Studio's default SDK and tool versions

Ghidra/Configurations/Public_Release/README.md

@@ -0,0 +1 @@
+# Public_Release

Ghidra/Configurations/Public_Release/build.gradle

@@ -17,5 +17,12 @@ apply from: "$rootProject.projectDir/gradle/distributableGhidraModule.gradle"
 apply from: "$rootProject.projectDir/gradle/javaProject.gradle"
 apply from: "$rootProject.projectDir/gradle/jacocoProject.gradle"
 apply from: "$rootProject.projectDir/gradle/javaTestProject.gradle"
+apply from: "$rootProject.projectDir/gradle/helpProject.gradle"
 apply plugin: 'eclipse'
 eclipse.project.name = 'Z Public Release'
+
+rootProject.assembleDistribution {
+	from ("${this.projectDir}/src/main/resources/UserAgreement.html") {
+		into "docs"
+	}
+}

Ghidra/Configurations/Public_Release/certification.manifest

@@ -1,9 +1,9 @@
 ##VERSION: 2.0
 Module.manifest||GHIDRA||||END|
+README.md||GHIDRA||||END|
 data/PDB_SYMBOL_SERVER_URLS.pdburl||GHIDRA||||END|
-src/global/docs/ChangeHistory.html||GHIDRA||||END|
-src/global/docs/UserAgreement.html||GHIDRA||||END|
-src/global/docs/WhatsNew.html||GHIDRA||||END|
+src/global/docs/ChangeHistory.md||GHIDRA||||END|
+src/global/docs/WhatsNew.md||GHIDRA||||END|
 src/main/resources/UserAgreement.html||GHIDRA||||END|
 src/main/resources/defaultTools/CodeBrowser.tool||GHIDRA||||END|
 src/main/resources/splash.txt||GHIDRA||||END|

Ghidra/Configurations/Public_Release/src/global/docs/UserAgreement.html

@@ -1,20 +0,0 @@
-<HTML>
-
-<FONT SIZE="5">
-
-Licensed under the Apache License, Version 2.0 (the "License"); Unless required by applicable law or
-agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, 
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the 
-specific language governing permissions and limitations under the License.
-<BR>
-<BR>
-<B>As a software reverse engineering (SRE) framework, Ghidra is designed solely to facilitate 
-lawful SRE activities.  You should always ensure that any SRE activities in which you engage are 
-permissible as computer software may be protected under governing law (e.g., copyright) or under an 
-applicable licensing agreement.  In making Ghidra available for public use, the National Security 
-Agency does not condone or encourage any improper usage of Ghidra.  Consistent with the Apache 2.0 
-license under which Ghidra has been made available, you are solely responsible for determining the 
-appropriateness of using or redistributing Ghidra.</B>
-
-</FONT>
-</HTML>

Ghidra/Configurations/Public_Release/src/global/docs/WhatsNew.html

@@ -1,167 +0,0 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-
-<HTML>
-  <HEAD>
-    <TITLE> Ghidra What's New</TITLE>
-	<STYLE type="text/css" name="text/css">
-		body { margin-bottom: 50px; margin-left: 10px; margin-right: 10px; margin-top: 10px; } /* some padding to improve readability */ 
-		li { font-family:times new roman; font-size:14pt; margin-bottom: 8px; }
-		h1 { color:#000080; font-family:times new roman; font-size:36pt; font-style:italic; font-weight:bold; text-align:center; }
-		h2 { margin: 10px; margin-top: 20px; color:#984c4c; font-family:times new roman; font-size:18pt; font-weight:bold; }
-		h3 { margin-left: 10px; margin-top: 20px; color:#0000ff; font-family:times new roman; `font-size:14pt; font-weight:bold;  }
-		h4 { margin-left: 10px; margin-top: 20px; font-family:times new roman; font-size:14pt; font-style:italic; }
-		p { margin-left: 40px; font-family:times new roman; font-size:14pt; }
-		blockquote p { margin-left: 10px; }
-		table { margin-left: 20px; margin-top: 10px; width: 80%;}
-		td { font-family:times new roman; font-size:14pt; vertical-align: top; }
-		th { font-family:times new roman; font-size:14pt; font-weight:bold; background-color: #EDF3FE; }
-		code { color:black; font-family:courier new; font-size: 12pt; }
-		span.code { font-family:courier new font-size: 14pt; color:#000000; }
-		.gcode { font-family: courier new; font-weight: bold; font-size: 85%; }
-		.gtitle { font-style: italic; font-weight: bold; font-size: 95%; }
-	 </STYLE>
-  </HEAD>
-
-  <BODY>
-
-<H1>Ghidra: NSA Reverse Engineering Software</H2>
-
-    <P>
-    Ghidra is a software reverse engineering (SRE) framework developed by NSA's Research Directorate.
-    This framework includes a suite of full-featured, high-end software analysis tools that enable
-    users to analyze compiled code on a variety of platforms including Windows, MacOS, and Linux.
-    Capabilities include disassembly, assembly, decompilation, debugging, emulation, graphing, and scripting, along with
-    hundreds of other features.  Ghidra supports a wide variety of processor instruction sets and 
-    executable formats and can be run in both user-interactive and automated modes.  Users may also
-    develop their own Ghidra plug-in components and/or scripts using the exposed API.  In addition there are
-    numerous ways to extend Ghidra such as new processors, loaders/exporters, automated analyzers,
-    and new visualizations.
-    </P>
-    
-    <P>
-    In support of NSA's Cybersecurity mission, Ghidra was built to solve scaling and teaming problems
-    on complex SRE efforts and to provide a customizable and extensible SRE research platform.  NSA
-    has applied Ghidra SRE capabilities to a variety of problems that involve analyzing malicious
-    code and generating deep insights for NSA analysts who seek a better understanding of potential
-    vulnerabilities in networks and systems.
-    </P>
-    <hr>   
-        
-    <H1>What's New in Ghidra 11.2</H1>
-
-    <P>This release includes new features, enhancements, performance improvements, quite a few bug fixes, and many pull-request
-	contributions. Thanks to all those who have contributed their time, thoughts, and code. The Ghidra user community thanks you too!</P>
-	
-	<H2>The not-so-fine print: Please Read!</H2>
-
-	<P>Ghidra 11.2 is fully backward compatible with project data from previous releases.
-	However, programs and data type archives which are created or modified in 11.2 will not be usable by an earlier Ghidra version.</P>
-
-	<P><span class="gtitle">IMPORTANT:</span> Ghidra 11.2 requires at minimum JDK 21 to run.</P>
-
-	<P><span class="gtitle">IMPORTANT:</span> To use the Debugger or do a full source distribution build, you will need Python3 (3.9 to 3.12 supported) installed on your system.</P>
-
-	<P><span class="gtitle">NOTE:</span> There have been reports of certain features causing the XWindows server to crash.  A fix for
-	CVE-2024-31083 in X.org software in April 2024 introduced a regression, which has been fixed in xwayland 23.2.6 and xorg-server 21.1.13.  If you experience
-	any crashing of Ghidra, most likely causing a full logout, check if your xorg-server has been updated to at least the noted version.</P>
-
-	<P><span class="gtitle">NOTE:</span> Each build distribution will include native components (e.g., decompiler) for at least one platform (e.g., Windows x86-64).
-	If you have another platform that is not included in the build distribution, you can build
-	native components for your platform directly from the distribution.
-	See the <a href="InstallationGuide.html">Ghidra Installation Guide</a> for additional information.
-	Users running with older shared libraries and operating systems (e.g., CentOS 7.x) may also run into 
-	compatibility errors when launching native executables such as the Decompiler and GNU Demangler which 
-	may necessitate a rebuild of native components.</P>
-
-	<P><span class="gtitle">NOTE:</span> Ghidra Server: The Ghidra 11.x server is compatible with Ghidra 9.2 and later Ghidra clients.  Ghidra 11.x
-	clients are compatible with all 10.x and 9.x servers.  Although, due to potential Java version differences, it is recommended
-	that Ghidra Server installations older than 10.2 be upgraded.  Those using 10.2 and newer should not need a server upgrade.</P>
-	
-	<P><span class="gtitle">NOTE:</span> Any programs imported with a Ghidra beta version or code built directly from source code outside of a release tag may not be compatible,
-	and may have flaws that won't be corrected by using this new release.  Any programs analyzed from a beta or other local master source build should be considered
-	experimental and re-imported and analyzed with a release version.</P>
-	
-	<P>Programs imported with previous release versions should upgrade correctly through various
-	automatic upgrade mechanisms.  However, there may be improvements or bug fixes in the import and analysis process that will provide better results than prior
-	Ghidra versions.  You might consider comparing a fresh import of any program you will continue to reverse engineer to see if the latest Ghidra
-	provides better results.</P>
-
-    <H2>Memory Search</H2>
-
-	<P>The <span class="gtitle">Search Memory</span> feature in Ghidra has been updated substantially to provide two new features:</P>
-	<BLOCKQUOTE>
-	<UL>
-		<LI>The ability to perform set operations on successive searches</LI>
-	        <LI>The ability to (re)scan memory for changes in value</LI>
-	</UL>
-	</BLOCKQUOTE>
-
-	<P>Set operations, accessible from the pull-down menu under <span class="gtitle">Search</span>, allow you to augment
-	results by performing boolean operations on an existing search. For example, you might search for the hex pattern "DE AD" using <span class="gtitle">Search</span>,
-	add "BE EF" to the pattern field, and then select "A-B" to retrieve a list of byte sequences that begin with "DE AD" but do not include "DE AD BE EF".
-	Scanning for changes is	most useful in a dynamic environment, such as the Debugger. Given an existing search, you can look for values that have changed,
-	increased, decreased, or remained the same. Simple examples might include looking for counters while a process is running, checking for areas of decompressed
-	memory, or identifying active areas of the heap.</P>
-	
-    <H2>PDB</H2>
-	
-	<P>The PDB Symbol Server Search Config dialog has been changed, allowing the user to mark symbol servers as trusted or untrusted.
-	This is an improvement over the previous mechanism that based trust on the symbol server's connection type.</P>
-	
-    <H2>Debugger</H2>
-	
-	<P><span class="gtitle">ATTENTION:</span> Please either delete and re-import the default Emulator tool, or
-		manually remove the TraceRmiPlugin from your EmulatorTool!</P>
-
-	<P>There are new launchers/features for the traceRMI version of dbgeng, including extended launch options, kernel debugging, and
-	remote process server connections.</P>
-	
-    <H2>Decompiler</H2>
-	
-	<P>The Decompiler can now automatically recover strings built on the stack and initial support for optimized heap strings has been added.
-	Stack strings are typically found in optimized code and obfuscated malware.</P>
-	
-	<P>A new Search All action has been added which displays a table containing the results found within the current function.</P>
-
-    <H2>Programming Languages</H2>
-    
-	<P>Golang support for versions 1.15 and 1.16 have been added.  This brings the supported Golang versions to 1.15 thru 1.22.</P>
-
-    <H2>Processors</H2>
-
-	<P>There have been quite a few improvements to the Sparc processor specification, including additional instructions, 64-bit relocation support, and better
-	handling of call/return detection through tracking of the o7 link register.  In addition, the calling convention for both sparc 32 and 64 bit binaries
-	have had an overhaul to support hidden structure return and much improved parameter allocation of floating point and general data types.</P>
-    
-	<P>The Intel M16C/60/80 sleigh processor specifications have been added.  In addition, there have been numerous fixes to the
-	ARM, RX, M68000, PIC16, PPC, and x86 processor specifications.</P>
-
-    <H2>Other Improvements</H2>
-	
-	<P>Actions have been added to compare functions directly from the Listing, Decompiler, or Functions Table via popup menu items. If there
-	is already a Function Comparison window showing, there are two actions: one to add the selected function(s) to the existing comparison, and
-	one to create a new Function Comparison Window. This allows a workflow where users can build up a set of functions to compare as they browse
-	around instead of having to select them all at once.</P>
-	
-	<P>For Ghidra script and plugin developers who would prefer to use Visual Studio Code, a new script VSCodeProjectScript will create a new
-	Visual Studio Code project that is setup to do Ghidra scripting and module development.  The capabilities are similar to the Eclipse
-	GhidraDev plugin.</P>
-	
-	<P>There have been major speed improvements when creating or modifying large structures within the structure editor.  In general large structure manipulation
-	should perform fluidly no matter the size of the structure.  If the structure contains a large number of defined data, there could still be some degradation in
-	speed.  Some fixed performance issues include: resizing a structure smaller or larger, clicking on an item to select a row, and defining a data type either with keyboard actions or dragging
-	and dropping from the data type manager.  In addition, the behavior of automatically growing the size of a structure has been made consistent.  Defining data on the last element of a structure
-	is allowed to automatically grow the structure to fit the data type.  Defining data anywhere other than the last element isn't allowed if the data type does not fit because
-	of defined data that would need to be cleared, or there are not enough undefined bytes.</P>
-
-    <H2>Additional Bug Fixes and Enhancements</H2>
-
-	<P> Numerous other new features, improvements, and bug fixes are fully listed in the <a href="ChangeHistory.html">ChangeHistory</a> file.</P>
-    		
-    <div align="center">
-    	<B><a href="https://www.nsa.gov/ghidra"> https://www.nsa.gov/ghidra</a></B>
-    	<BR><BR>
-    </div>   
-
-  </BODY>
-</HTML>

Ghidra/Configurations/Public_Release/src/global/docs/WhatsNew.md

@@ -0,0 +1,148 @@
+# Ghidra: NSA Reverse Engineering Software
+Ghidra is a software reverse engineering (SRE) framework developed by NSA's Research Directorate.
+This framework includes a suite of full-featured, high-end software analysis tools that enable users
+to analyze compiled code on a variety of platforms including Windows, MacOS, and Linux. Capabilities
+include disassembly, assembly, decompilation, debugging, emulation, graphing, and scripting, along
+with hundreds of other features.  Ghidra supports a wide variety of processor instruction sets and
+executable formats and can be run in both user-interactive and automated modes.  Users may also
+develop their own Ghidra plug-in components and/or scripts using the exposed API.  In addition, there
+are numerous ways to extend Ghidra such as new processors, loaders/exporters, automated analyzers,
+and new visualizations.
+
+In support of NSA's Cybersecurity mission, Ghidra was built to solve scaling and teaming problems on
+complex SRE efforts and to provide a customizable and extensible SRE research platform.  NSA has
+applied Ghidra SRE capabilities to a variety of problems that involve analyzing malicious code and
+generating deep insights for NSA analysts who seek a better understanding of potential
+vulnerabilities in networks and systems.
+
+# What's New in Ghidra 12.0
+This release includes new features, enhancements, performance improvements, quite a few bug fixes,
+and many pull-request contributions. Thanks to all those who have contributed their time, thoughts,
+and code. The Ghidra user community thanks you too!
+	
+### The not-so-fine print: Please Read!
+Ghidra 12.0 is fully backward compatible with project data from previous releases. However, programs
+and data type archives which are created or modified in 12.0 will not be usable by an earlier Ghidra
+version.
+
+**IMPORTANT:** Ghidra 12.0 requires, at minimum, JDK 21 to run.
+
+**IMPORTANT:** To use the Debugger or do a full source distribution build, you will need Python3
+(3.9 to 3.13 supported) installed on your system.
+
+**NOTE:** There have been reports of certain features causing the XWindows server to crash. A fix
+for `CVE-2024-31083` in X.org software in April 2024 introduced a regression, which has been fixed
+in xwayland 23.2.6 and xorg-server 21.1.13.  If you experience any crashing of Ghidra, most likely
+causing a full logout, check if your xorg-server has been updated to at least the noted version.
+
+**NOTE:** Each build distribution will include native components (e.g., Decompiler) for at least one
+platform (e.g., Windows x86-64). If you have another platform that is not included in the build
+distribution, you can build native components for your platform directly from the distribution.
+See the *Getting Started* document for additional information. Users running with older shared 
+libraries and operating systems (e.g., CentOS 7.x) may also run into compatibility errors when 
+launching native executables such as the Decompiler and GNU Demangler which may necessitate a 
+rebuild of native components.
+
+**NOTE:** Ghidra Server: The Ghidra 12.0 server is compatible with Ghidra 9.2 and later Ghidra
+clients, although the presence of any newer link-files within a repository may not be handled properly
+by client versions prior to 12.0 which lack support for the new storage format.  Ghidra 12.0 clients
+that introduce new link-files into a project will not be able to add such files into version 
+control if connected to older Ghidra Server versions.  
+
+**NOTE:** Ghidra Server: Due to potential Java version differences, it is 
+recommended that Ghidra Server installations older than 10.2 be upgraded. Those using 10.2 and newer
+should not need a server upgrade unless they need to work with link-files within a shared repository.
+	
+**NOTE:** Programs imported with a Ghidra beta version or code built directly from source code
+outside of a release tag may not be compatible, and may have flaws that won't be corrected by using
+this new release.  Any programs analyzed from a beta or other local master source build should be
+considered experimental and re-imported and analyzed with a release version.
+	
+Programs imported with previous release versions should upgrade correctly through various automatic
+upgrade mechanisms.  However, there may be improvements or bug fixes in the import and analysis 
+process that will provide better results than prior Ghidra versions.  You might consider comparing a
+fresh import of any program you will continue to reverse engineer to see if the latest Ghidra 
+provides better results.
+
+## Project Link Files
+Support for link-files within a Ghidra Project has been significantly expanded with this release and
+with it a new file storage type has been introduced which can create some incompatibilities if
+projects and repositories containing such files are used by older version of Ghidra or the Ghidra 
+Server.
+
+Previously only external folder and file links were supported through the use of a Ghidra URL. With
+12.0 the ability to establish internal folder and file links has been introduced.  The new storage 
+format avoids the use of a database and relies only on a light-weight property file. Internal 
+project links also allow for either absolute or relative links.  Due to the fact that Ghidra allows 
+a folder or file to have the same pathname, some ambiguities can result.  It is highly recommended 
+that the use of conflicting folder and file pathnames be avoided.
+
+The use of internally linked folders and files allows batch import processing to more accurately
+reflect the native file-system and its use of symbolic links which allow for the same content to
+be referenced by multiple paths.  Allowing this within a Ghidra project can avoid the potential for
+importing content multiple times with the different paths and simply import once with additional 
+link-files which reference it.  How best to leverage links very much depends on the end-user's 
+needs and project file management preferences.  Special care must be taken when defining or 
+traversing link-files to avoid external and circular references.
+
+Additional Ghidra API methods have been provided or refined on the following classes to leverage 
+link-files: `DomainFolder`, `DomainFile`, `LinkFile`, `LinkHandler`, `DomainFileFilter`, 
+`DomainFileIterator`, etc.
+
+...TO BE CONTINUED...
+
+## Filesystem Mirroring
+An option has been added to mirror the local filesystem when importing programs and their libraries.
+Programs and libraries that exist on the local filesystem as symbolic links will have both their 
+corresponding link file and resolved program file mirrored in the project. Filesystem mirroring
+can also be used in headless mode with the new `-mirror` command line option.
+
+## PyGhidra
+PyGhidra 3.0.0 (compatible with Ghidra 12.0 and later) introduces many new Python-specific API 
+methods with the goal of making the most common Ghidra tasks quick and easy, such as opening a 
+project, getting a program, and running a GhidraScript. Legacy API functions such as 
+`pyghidra.open_program()` and `pyghidra_run_script()` have been deprecated in favor of the new 
+methods, which are outlined at https://pypi.org/project/pyghidra.
+
+The default Python scripting engine has been changed in Ghidra 12.0 from Jython to PyGhidra.
+Existing Jython scripts will need to include the `# @runtime Jython` script header in order to
+continue running within the Jython environment.
+
+## Z3 Concolic Emulation and Symbolic Summary
+We've added an experimental Z3-based symbolic emulator, which runs as an "auxiliary" domain to the 
+concrete emulator, effectively constructing what is commonly called a "concolic" emulator. The 
+symbolic emulator creates Z3 expressions and branching constraints, but it only follows the path 
+determined by concrete emulation. This is most easily accessed by installing the "SymbolicSummaryZ3"
+extension (**File** -> **Install Extensions**) and then enabling the `Z3SummaryPlugin` in the 
+Debugger or Emulator tool, which includes a GUI for viewing and sorting through the results. The Z3
+emulator requires z3-4.13.0, available from https://github.com/Z3Prover/z3. Other versions may work,
+but our current test configuration uses 4.13.0. Depending on the release and your platform, the
+required libraries may be missing or incompatible. If this is the case, you will need to download
+Z3, or build it from source with Java bindings, and install the libraries into 
+`Ghidra/Extensions/SymbolicSummaryZ3/os/<platform>/`.
+
+## Emulation API
+The `PcodeEmulator` and related API has undergone substantial changes in preparation for integrating
+our JIT-accelerated emulator into the GUI. Please see the **Notable API Changes** section of our 
+[Change History](ChangeHistory.md). The goal is to facilitate integration by composition; whereas, 
+it had previously required inheritance, which is now considered poor design. Essentially, we've 
+introduced a set of callbacks that integrators can use to detect when certain things have happened
+in emulation, as well as offer some control of machine-state behavior; e.g., to facilitate lazily 
+loading from a snapshot.
+
+Extensions that currently integrate via inheritance can continue to do so, but will still need to
+apply some minimal changes to satisfy interface and constructor changes. The developers of such
+extensions ought to consider porting their integrations to the compositional/callback-based
+mechanism. A careful assessment may be required depending on the nature of the extension. Extensions
+that merely integrate with emulation should consider the compositional/callback-based mechanism. 
+Extensions that incorporate new domains (e.g. Z3) or novel behaviors (e.g. JIT) should continue 
+using inheritance.
+
+## Other Improvements
+ + Added the ability to toggle the displaying of function variables (parameters and locals) that are 
+   normally displayed just below the function signature. The variables display can be turned on/off 
+   globally or individually per function.
+
+## Additional Bug Fixes and Enhancements
+Numerous other new features, improvements, and bug fixes are fully listed in the 
+[Change History](ChangeHistory.md) file.

Ghidra/Configurations/Public_Release/src/main/resources/UserAgreement.html

@@ -1,4 +1,7 @@
 <HTML>
+<HEAD>
+  <TITLE>Ghidra User Agreement</TITLE>
+</HEAD>
 
 <FONT SIZE="5">
 

Ghidra/Configurations/Public_Release/src/main/resources/defaultTools/CodeBrowser.tool

@@ -9,6 +9,7 @@
             <INCLUDE CLASS="ghidra.app.plugin.core.interpreter.InterpreterPanelPlugin" />
             <INCLUDE CLASS="ghidra.app.plugin.core.editor.TextEditorManagerPlugin" />
         </PACKAGE>
+	<PACKAGE NAME="BSim" />
         <ROOT_NODE X_POS="409" Y_POS="179" WIDTH="1637" HEIGHT="931" EX_STATE="0" FOCUSED_OWNER="CodeBrowserPlugin" FOCUSED_NAME="Listing" FOCUSED_TITLE="Listing: ">
             <SPLIT_NODE WIDTH="1621" HEIGHT="816" DIVIDER_LOCATION="148" ORIENTATION="VERTICAL">
                 <COMPONENT_NODE TOP_INFO="0">

Ghidra/Debug/AnnotationValidator/README.md

@@ -0,0 +1 @@
+# AnnotationValidator

Ghidra/Debug/AnnotationValidator/certification.manifest

@@ -1,3 +1,4 @@
 ##VERSION: 2.0
 Module.manifest||GHIDRA||||END|
+README.md||GHIDRA||||END|
 src/main/resources/META-INF/services/javax.annotation.processing.Processor||GHIDRA||||END|

Ghidra/Debug/Debugger-agent-dbgeng/README.md

@@ -0,0 +1 @@
+# Debugger-agent-dbgeng

Ghidra/Debug/Debugger-agent-dbgeng/build.gradle

@@ -13,42 +13,46 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-apply from: "$rootProject.projectDir/gradle/javaProject.gradle"
-apply from: "$rootProject.projectDir/gradle/jacocoProject.gradle"
-apply from: "$rootProject.projectDir/gradle/javaTestProject.gradle"
-apply from: "$rootProject.projectDir/gradle/nativeProject.gradle"
+// Not technically a Java project, but required to be a Help project
+apply from: "${rootProject.projectDir}/gradle/javaProject.gradle"
+apply from: "${rootProject.projectDir}/gradle/helpProject.gradle"
 apply from: "$rootProject.projectDir/gradle/distributableGhidraModule.gradle"
+apply from: "$rootProject.projectDir/gradle/nativeProject.gradle"
 apply from: "$rootProject.projectDir/gradle/hasPythonPackage.gradle"
-apply from: "$rootProject.projectDir/gradle/debugger/hasNodepJar.gradle"
 
 apply plugin: 'eclipse'
 eclipse.project.name = 'Debug Debugger-agent-dbgeng'
 
 dependencies {
-	api project(":Framework-AsyncComm")
-	api project(":Framework-Debugging")
-	api project(":Debugger-gadp")
-
-	//testImplementation project(":Base")
-	testImplementation project(path: ':Framework-AsyncComm', configuration: 'testArtifacts')
-	testImplementation project(path: ':Framework-Debugging', configuration: 'testArtifacts')
-	testImplementation project(path: ":Debugger-gadp", configuration: 'testArtifacts')
+	// Only for Help :/
+	api project(':Debugger-rmi-trace')
 }
 
-ext.tlb = file("build/os/win_x86_64/dbgmodel.tlb")
+def tlb = file("build/os/win_x86_64/dbgmodel.tlb")
+def depsFile = file("${DEPS_DIR}/Debugger-agent-dbgeng/dbgmodel.tlb")
+def binRepoFile = file("${BIN_REPO}/${getGhidraRelativePath(project)}/os/win_x86_64/dbgmodel.tlb")
 
-if ("win_x86_64".equals(getCurrentPlatformName())) {
+tasks.assemblePyPackage {
+	def prebuiltTlb = depsFile.exists() ? depsFile : (binRepoFile.exists() ? binRepoFile : null)
+	assert prebuiltTlb != null : "Failed to locate prebuilt TLB file"
+
+	from(prebuiltTlb) {
+		into("src/ghidradbg/dbgmodel/tlb")
+	}
+}
+
+task buildTlb(type: Exec) {
+
+	def tmpBatch = file("build/buildTlb.bat")
+	def idl = file("src/main/py/src/ghidradbg/dbgmodel/DbgModel.idl")
 	
-	String makeName = "win_x86_64DbgmodelTlbMake"
-	task(type: Exec, makeName) {
-		ext.tmpBatch = file("build/buildTlb.bat")
-		ext.idl = file("src/main/py/src/ghidradbg/dbgmodel/DbgModel.idl")
 	inputs.file(idl)
 	outputs.file(tlb)
 
 	doFirst {
+		assert isCurrentX86_64() && isCurrentWindows() : "Can only build TLB on Windows x86"
 		file(tlb).parentFile.mkdirs()
-			def midlCmd = "midl /tlb ${tlb} ${idl}"
+		def midlCmd = "midl /tlb \"${tlb}\" \"${idl}\""
 		println "Executing: " + midlCmd
 
 		tmpBatch.withWriter { out ->
@@ -56,6 +60,7 @@ if ("win_x86_64".equals(getCurrentPlatformName())) {
 			out.println midlCmd
 		}
 	}
+
 	doLast {
 		assert file(tlb).exists() : "Failed to build dbgmodel.tlb"
 	}
@@ -63,33 +68,16 @@ if ("win_x86_64".equals(getCurrentPlatformName())) {
 	commandLine "cmd", "/c", tmpBatch
 }
 
-	tasks.assemblePyPackage {
-		from(tasks."$makeName") {
-			into("src/ghidradbg/dbgmodel/tlb")
-		}
-	}	
-}
-else if (file(tlb).exists()) {
-	// required for multi-platform build
-	tasks.assemblePyPackage {
-		from(tlb) {
-			println "Copying existing tlb build artifact: " + tlb
-			into("src/ghidradbg/dbgmodel/tlb")
-		}
-	}
-}
-else {
-	def prebuiltTlb = new File(rootProject.BIN_REPO + '/' + getGhidraRelativePath(project) + "/os/win_x86_64/dbgmodel.tlb")
-	if (prebuiltTlb.exists()) {
-		println "Copying prebuilt dbgmodel.tlb"
-		tasks.assemblePyPackage {
-			from(rootProject.BIN_REPO + '/' + getGhidraRelativePath(project) + "/os/win_x86_64/dbgmodel.tlb") {
-				into("src/ghidradbg/dbgmodel/tlb")
-			}
-		}
-	}
-	else {
-		println "WARNING: dbgmodel.tlb omitted from ghidradbg python package"
+task prebuildTlb(type: Copy) {
+
+	dependsOn buildTlb
+
+	from tlb
+	into binRepoFile.parentFile
+
+	doFirst {
+		assert file(BIN_REPO).exists() : "Bin repo doesn't exist"
+		file(binRepoFile).parentFile.mkdirs()
 	}
 }
 
@@ -98,15 +86,3 @@ distributePyDep("capstone-5.0.1-py3-none-win_amd64.whl")
 distributePyDep("comtypes-1.4.1-py3-none-any.whl")
 distributePyDep("pywin32-306-cp312-cp312-win_amd64.whl")
 
-tasks.nodepJar {
-	manifest {
-		attributes['Main-Class'] = 'agent.dbgeng.gadp.DbgEngGadpServer'
-	}
-}
-
-test {
-	jvmArgs('-Xrs') // TODO: Is this needed, or left over from trial-and-error
-	if ("win_x86_64".equals(getCurrentPlatformName())) {
-		dependsOn(":Framework-Debugging:testSpecimenWin_x86_64")
-	}
-}

Ghidra/Debug/Debugger-agent-dbgeng/certification.manifest

@@ -2,16 +2,14 @@
 ##MODULE IP: Apache License 2.0
 ##MODULE IP: MIT
 Module.manifest||GHIDRA||||END|
-data/debugger-launchers/kernel-dbgeng.bat||GHIDRA||||END|
-data/debugger-launchers/local-dbgeng-attach.bat||GHIDRA||||END|
-data/debugger-launchers/local-dbgeng-ext.bat||GHIDRA||||END|
-data/debugger-launchers/local-dbgeng.bat||GHIDRA||||END|
-data/debugger-launchers/local-ttd.bat||GHIDRA||||END|
-data/debugger-launchers/remote-dbgeng.bat||GHIDRA||||END|
+README.md||GHIDRA||||END|
+src/main/help/help/TOC_Source.xml||GHIDRA||||END|
+src/main/help/help/topics/dbgeng/dbgeng.html||GHIDRA||||END|
 src/main/py/LICENSE||GHIDRA||||END|
 src/main/py/MANIFEST.in||GHIDRA||||END|
 src/main/py/README.md||GHIDRA||||END|
 src/main/py/pyproject.toml||GHIDRA||||END|
 src/main/py/src/ghidradbg/dbgmodel/DbgModel.idl||GHIDRA||||END|
+src/main/py/src/ghidradbg/py.typed||GHIDRA||||END|
 src/main/py/src/ghidradbg/schema.xml||GHIDRA||||END|
-src/main/py/src/ghidrattd/schema.xml||GHIDRA||||END|
+src/main/py/src/ghidradbg/schema_exdi.xml||GHIDRA||||END|

Ghidra/Debug/Debugger-agent-dbgeng/data/debugger-launchers/kernel-dbgeng.bat

@@ -1,4 +1,19 @@
-::@title dbgeng-kernel
+:: ###
+:: IP: GHIDRA
+::
+:: Licensed under the Apache License, Version 2.0 (the "License");
+:: you may not use this file except in compliance with the License.
+:: You may obtain a copy of the License at
+::
+::      http://www.apache.org/licenses/LICENSE-2.0
+::
+:: Unless required by applicable law or agreed to in writing, software
+:: distributed under the License is distributed on an "AS IS" BASIS,
+:: WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+:: See the License for the specific language governing permissions and
+:: limitations under the License.
+:: ##
+::@title dbgeng kernel
 ::@desc <html><body width="300px">
 ::@desc   <h3>Kernel debugging using <tt>dbgeng</tt> (in a Python interpreter)</h3>
 ::@desc   <p>
@@ -6,12 +21,15 @@
 ::@desc     For setup instructions, press <b>F1</b>.
 ::@desc   </p>
 ::@desc </body></html>
-::@menu-group local
+::@menu-group dbgeng
 ::@icon icon.debugger
-::@help TraceRmiLauncherServicePlugin#dbgeng_kernel
-::@env OPT_PYTHON_EXE:file="python" "Python command" "The path to the Python 3 interpreter. Omit the full path to resolve using the system PATH."
+::@help dbgeng#win_kernel
+::@depends Debugger-rmi-trace
+::@enum Connection:str Remote Local EXDI
+::@env OPT_PYTHON_EXE:file!="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_ARGS:str="" "Arguments" "Connection-string arguments (a la .server)"
+::@env OPT_KCONNECT_STRING:str="" "Arguments" "Connection-string arguments (a la .server)"
+::@env OPT_TARGET_FLAGS:Connection="Remote" "Type" "Type/flags for connection (Remote/Local/EXDI)."
 ::@env OPT_USE_DBGMODEL:bool=true "Use dbgmodel" "Load and use dbgmodel.dll if it is available."
 ::@env WINDBG_DIR:dir="" "Path to dbgeng.dll directory" "Path containing dbgeng and associated DLLS (if not Windows Kits)."
 

Ghidra/Debug/Debugger-agent-dbgeng/data/debugger-launchers/local-dbgeng-attach.bat

@@ -1,4 +1,19 @@
-::@title dbgeng-attach
+:: ###
+:: IP: GHIDRA
+::
+:: Licensed under the Apache License, Version 2.0 (the "License");
+:: you may not use this file except in compliance with the License.
+:: You may obtain a copy of the License at
+::
+::      http://www.apache.org/licenses/LICENSE-2.0
+::
+:: Unless required by applicable law or agreed to in writing, software
+:: distributed under the License is distributed on an "AS IS" BASIS,
+:: WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+:: See the License for the specific language governing permissions and
+:: limitations under the License.
+:: ##
+::@title dbgeng attach
 ::@desc <html><body width="300px">
 ::@desc   <h3>Attach with <tt>dbgeng</tt> (in a Python interpreter)</h3>
 ::@desc   <p>
@@ -6,12 +21,13 @@
 ::@desc     For setup instructions, press <b>F1</b>.
 ::@desc   </p>
 ::@desc </body></html>
-::@menu-group local
+::@menu-group dbgeng
 ::@icon icon.debugger
-::@help TraceRmiLauncherServicePlugin#dbgeng_attach
-::@env OPT_PYTHON_EXE:file="python" "Python command" "The path to the Python 3 interpreter. Omit the full path to resolve using the system PATH."
-::@env OPT_TARGET_PID:str="" "Process id" "The target process id"
-::@env OPT_ATTACH_FLAGS:str="0" "Attach flags" "Attach flags"
+::@help dbgeng#attach
+::@depends Debugger-rmi-trace
+::@env OPT_PYTHON_EXE:file!="python" "Python command" "The path to the Python 3 interpreter. Omit the full path to resolve using the system PATH."
+::@env OPT_TARGET_PID:int=0 "Process id" "The target process id"
+::@env OPT_ATTACH_FLAGS:int=0 "Attach flags" "Attach flags"
 ::@env OPT_USE_DBGMODEL:bool=true "Use dbgmodel" "Load and use dbgmodel.dll if it is available."
 ::@env WINDBG_DIR:dir="" "Path to dbgeng.dll directory" "Path containing dbgeng and associated DLLS (if not Windows Kits)."
 

Ghidra/Debug/Debugger-agent-dbgeng/data/debugger-launchers/local-dbgeng-ext.bat

@@ -1,4 +1,20 @@
-::@title dbgeng-ext
+:: ###
+:: IP: GHIDRA
+::
+:: Licensed under the Apache License, Version 2.0 (the "License");
+:: you may not use this file except in compliance with the License.
+:: You may obtain a copy of the License at
+::
+::      http://www.apache.org/licenses/LICENSE-2.0
+::
+:: Unless required by applicable law or agreed to in writing, software
+:: distributed under the License is distributed on an "AS IS" BASIS,
+:: WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+:: See the License for the specific language governing permissions and
+:: limitations under the License.
+:: ##
+::@title dbgeng extra options
+::@image-opt env:OPT_TARGET_IMG
 ::@desc <html><body width="300px">
 ::@desc   <h3>Launch with <tt>dbgeng</tt> (in a Python interpreter)</h3>
 ::@desc   <p>
@@ -6,10 +22,11 @@
 ::@desc     For setup instructions, press <b>F1</b>.
 ::@desc   </p>
 ::@desc </body></html>
-::@menu-group local
+::@menu-group dbgeng
 ::@icon icon.debugger
-::@help TraceRmiLauncherServicePlugin#dbgeng_ext
-::@env OPT_PYTHON_EXE:file="python" "Python command" "The path to the Python 3 interpreter. Omit the full path to resolve using the system PATH."
+::@help dbgeng#ext
+::@depends Debugger-rmi-trace
+::@env OPT_PYTHON_EXE:file!="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:file="" "Image" "The target binary executable image"
 ::@env OPT_TARGET_ARGS:str="" "Arguments" "Command-line arguments to pass to the target"
@@ -17,9 +34,10 @@
 ::@env WINDBG_DIR:dir="" "Path to dbgeng.dll directory" "Path containing dbgeng and associated DLLS (if not Windows Kits)."
 ::@env OPT_TARGET_DIR:str="" "Dir" "Initial directory"
 ::@env OPT_TARGET_ENV:str="" "Env" "Environment variables (sep=/0)"
-::@env OPT_CREATE_FLAGS:str="1" "Create flags" "Creation flags"
-::@env OPT_CREATE_ENGFLAGS:str="0" "Create flags (Engine)" "Engine-specific creation flags"
-::@env OPT_VERIFIER_FLAGS:str="0" "Verifier flags" "Verifier flags"
+::@env OPT_CREATE_FLAGS:int="1" "Create flags" "Creation flags"
+::@env OPT_CREATE_ENGFLAGS:int="0" "Create flags (Engine)" "Engine-specific creation flags"
+::@env OPT_VERIFIER_FLAGS:int="0" "Verifier flags" "Verifier flags"
+::@env OPT_ENG_OPTIONS:int="0x20" "Engine options" "Options for AddEngineOptions (e.g. INITIAL_BREAK=0x20)"
 
 @echo off
 

Ghidra/Debug/Debugger-agent-dbgeng/data/debugger-launchers/local-dbgeng-trace.bat

@@ -0,0 +1,37 @@
+:: ###
+:: IP: GHIDRA
+::
+:: Licensed under the Apache License, Version 2.0 (the "License");
+:: you may not use this file except in compliance with the License.
+:: You may obtain a copy of the License at
+::
+::      http://www.apache.org/licenses/LICENSE-2.0
+::
+:: Unless required by applicable law or agreed to in writing, software
+:: distributed under the License is distributed on an "AS IS" BASIS,
+:: WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+:: See the License for the specific language governing permissions and
+:: limitations under the License.
+:: ##
+::@title dbgeng TTD
+::@desc <html><body width="300px">
+::@desc   <h3>Open trace with <tt>dbgeng</tt> (in a Python interpreter)</h3>
+::@desc   <p>
+::@desc     This will open a WinDbg TTD trace of 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 dbgeng
+::@icon icon.debugger
+::@help dbgeng#ttd
+::@depends Debugger-rmi-trace
+::@env OPT_PYTHON_EXE:file!="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_TRACE:file="" "Trace (.run)" "The target trace image"
+::@env OPT_USE_DBGMODEL:bool=true "Use dbgmodel" "Load and use dbgmodel.dll if it is available."
+::@env WINDBG_DIR:dir="" "Path to dbgeng.dll directory" "Path containing dbgeng and associated DLLS (if not Windows Kits)."
+
+@echo off
+
+set USE_TTD=true
+"%OPT_PYTHON_EXE%" -i ..\support\local-dbgeng-trace.py

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

@@ -1,4 +1,20 @@
+:: ###
+:: IP: GHIDRA
+::
+:: Licensed under the Apache License, Version 2.0 (the "License");
+:: you may not use this file except in compliance with the License.
+:: You may obtain a copy of the License at
+::
+::      http://www.apache.org/licenses/LICENSE-2.0
+::
+:: Unless required by applicable law or agreed to in writing, software
+:: distributed under the License is distributed on an "AS IS" BASIS,
+:: WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+:: See the License for the specific language governing permissions and
+:: limitations under the License.
+:: ##
 ::@title dbgeng
+::@image-opt env:OPT_TARGET_IMG
 ::@desc <html><body width="300px">
 ::@desc   <h3>Launch with <tt>dbgeng</tt> (in a Python interpreter)</h3>
 ::@desc   <p>
@@ -6,10 +22,11 @@
 ::@desc     For setup instructions, press <b>F1</b>.
 ::@desc   </p>
 ::@desc </body></html>
-::@menu-group local
+::@menu-group dbgeng
 ::@icon icon.debugger
-::@help TraceRmiLauncherServicePlugin#dbgeng
-::@env OPT_PYTHON_EXE:file="python" "Python command" "The path to the Python 3 interpreter. Omit the full path to resolve using the system PATH."
+::@help dbgeng#local
+::@depends Debugger-rmi-trace
+::@env OPT_PYTHON_EXE:file!="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:file="" "Image" "The target binary executable image"
 ::@env OPT_TARGET_ARGS:str="" "Arguments" "Command-line arguments to pass to the target"

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

@@ -1,21 +0,0 @@
-::@title ttd
-::@desc <html><body width="300px">
-::@desc   <h3>Launch with <tt>ttd</tt> (in a Python interpreter)</h3>
-::@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:file="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:file="" "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:dir="" "Path to dbgeng.dll & \\ttd" "Path containing dbgeng and associated DLLS (if not Windows Kits)."
-
-@echo off
-
-"%OPT_PYTHON_EXE%" -i ..\support\local-ttd.py

Ghidra/Debug/Debugger-agent-dbgeng/data/debugger-launchers/remote-dbgeng.bat

@@ -1,20 +1,32 @@
-::@title dbgeng-remote
+:: ###
+:: IP: GHIDRA
+::
+:: Licensed under the Apache License, Version 2.0 (the "License");
+:: you may not use this file except in compliance with the License.
+:: You may obtain a copy of the License at
+::
+::      http://www.apache.org/licenses/LICENSE-2.0
+::
+:: Unless required by applicable law or agreed to in writing, software
+:: distributed under the License is distributed on an "AS IS" BASIS,
+:: WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+:: See the License for the specific language governing permissions and
+:: limitations under the License.
+:: ##
+::@title dbgeng remote
 ::@desc <html><body width="300px">
-::@desc   <h3>Launch with <tt>dbgeng</tt> remotely (in a Python interpreter)</h3>
+::@desc   <h3>Connect to a remote debugger (via the .server interface)</h3>
 ::@desc   <p>
-::@desc     This will launch the target on a remote machine using <tt>dbgeng.dll</tt>.
+::@desc     This will connect to a remote machine using the .server interface.
 ::@desc     For setup instructions, press <b>F1</b>.
 ::@desc   </p>
 ::@desc </body></html>
-::@menu-group local
+::@menu-group dbgeng
 ::@icon icon.debugger
-::@help TraceRmiLauncherServicePlugin#dbgeng_remote
-::@env OPT_PYTHON_EXE:file="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:file="" "Image" "The target binary executable image"
-::@env OPT_TARGET_ARGS:str="" "Arguments" "Command-line arguments to pass to the target"
-::@env OPT_CONNECT_STRING:str="" "Connection" "Connection-string arguments (a la dbgsrv args)"
-::@env OPT_USE_DBGMODEL:bool=true "Use dbgmodel" "Load and use dbgmodel.dll if it is available."
+::@help dbgeng#remote
+::@depends Debugger-rmi-trace
+::@env OPT_PYTHON_EXE:file!="python" "Python command" "The path to the Python 3 interpreter. Omit the full path to resolve using the system PATH."
+::@env OPT_CONNECT_STRING:str="" "Connection" "Connection-string arguments (a la .server)"
 ::@env WINDBG_DIR:dir="" "Path to dbgeng.dll directory" "Path containing dbgeng and associated DLLS (if not Windows Kits)."
 
 @echo off

Ghidra/Debug/Debugger-agent-dbgeng/data/debugger-launchers/svrcx-dbgeng.bat

@@ -0,0 +1,39 @@
+:: ###
+:: IP: GHIDRA
+::
+:: Licensed under the Apache License, Version 2.0 (the "License");
+:: you may not use this file except in compliance with the License.
+:: You may obtain a copy of the License at
+::
+::      http://www.apache.org/licenses/LICENSE-2.0
+::
+:: Unless required by applicable law or agreed to in writing, software
+:: distributed under the License is distributed on an "AS IS" BASIS,
+:: WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+:: See the License for the specific language governing permissions and
+:: limitations under the License.
+:: ##
+::@title dbgeng svrcx
+::@image-opt env:OPT_TARGET_IMG
+::@desc <html><body width="300px">
+::@desc   <h3>Connect to a remote <tt>dbgeng</tt> connection server and launch the target (in a Python interpreter)</h3>
+::@desc   <p>
+::@desc     This will launch the target via a connection server on a remote machine.
+::@desc     For setup instructions, press <b>F1</b>.
+::@desc   </p>
+::@desc </body></html>
+::@menu-group dbgeng
+::@icon icon.debugger
+::@help dbgeng#svrcx
+::@depends Debugger-rmi-trace
+::@env OPT_PYTHON_EXE:file!="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_CONNECT_STRING:str="" "Connection" "Connection-string arguments (a la dbgsrv args)"
+::@env OPT_USE_DBGMODEL:bool=true "Use dbgmodel" "Load and use dbgmodel.dll if it is available."
+::@env WINDBG_DIR:dir="" "Path to dbgeng.dll directory" "Path containing dbgeng and associated DLLS (if not Windows Kits)."
+
+@echo off
+
+"%OPT_PYTHON_EXE%" -i ..\support\svrcx-dbgeng.py

Ghidra/Debug/Debugger-agent-dbgeng/data/support/kernel-dbgeng.py

@@ -17,27 +17,20 @@
 import os
 import sys
 
-home = os.getenv('GHIDRA_HOME')
 
-if os.path.isdir(f'{home}\\ghidra\\.git'):
+def append_paths():
     sys.path.append(
-        f'{home}\\ghidra\\Ghidra\\Debug\\Debugger-agent-dbgeng\\build\\pypkg\\src')
-    sys.path.append(
-        f'{home}\\ghidra\\Ghidra\\Debug\\Debugger-rmi-trace\\build\\pypkg\\src')
-elif os.path.isdir(f'{home}\\.git'):
-    sys.path.append(
-        f'{home}\\Ghidra\\Debug\\Debugger-agent-dbgeng\\build\\pypkg\\src')
-    sys.path.append(
-        f'{home}\\Ghidra\\Debug\\Debugger-rmi-trace\\build\\pypkg\\src')
-else:
-    sys.path.append(
-        f'{home}\\Ghidra\\Debug\\Debugger-agent-dbgeng\\pypkg\\src')
-    sys.path.append(f'{home}\\Ghidra\\Debug\\Debugger-rmi-trace\\pypkg\\src')
+        f"{os.getenv('MODULE_Debugger_rmi_trace_HOME')}/data/support")
+    from gmodutils import ghidra_module_pypath
+    sys.path.append(ghidra_module_pypath("Debugger-rmi-trace"))
+    sys.path.append(ghidra_module_pypath())
 
 
 def main():
+    append_paths()
     # Delay these imports until sys.path is patched
     from ghidradbg import commands as cmd
+    from ghidradbg import util
     from pybag.dbgeng import core as DbgEng
     from ghidradbg.hooks import on_state_changed
     from ghidradbg.util import dbg
@@ -47,8 +40,17 @@ def main():
     repl = cmd.repl
 
     cmd.ghidra_trace_connect(os.getenv('GHIDRA_TRACE_RMI_ADDR'))
-    args = os.getenv('OPT_TARGET_ARGS')
-    cmd.ghidra_trace_attach_kernel(args, start_trace=False)
+    type = os.getenv('OPT_TARGET_FLAGS')
+    flags = 0
+    if type == "Local":
+        flags = 1
+    if type == "EXDI":
+        print(f"ConfigFile: {os.getenv('EXDI_GDBSRV_XML_CONFIG_FILE')}")
+        print(f"RegMapFile: {os.getenv('EXDI_SYSTEM_REGISTERS_MAP_XML_FILE')}")
+        util.set_convenience_variable('output-radix', 16)
+        flags = 2
+    args = os.getenv('OPT_KCONNECT_STRING')
+    cmd.ghidra_trace_attach_kernel(args, flags, start_trace=False)
 
     # TODO: HACK
     try:
@@ -56,12 +58,18 @@ def main():
     except KeyboardInterrupt as ki:
         dbg.interrupt()
 
-    cmd.ghidra_trace_start(os.getenv('OPT_TARGET_IMG'))
+    # cmd.ghidra_trace_start(os.getenv('OPT_TARGET_IMG'))
+    cmd.ghidra_trace_start("System")
     cmd.ghidra_trace_sync_enable()
 
-    on_state_changed(DbgEng.DEBUG_CES_EXECUTION_STATUS, DbgEng.DEBUG_STATUS_BREAK)
+    on_state_changed(DbgEng.DEBUG_CES_EXECUTION_STATUS,
+                     DbgEng.DEBUG_STATUS_BREAK)
     cmd.repl()
 
 
 if __name__ == '__main__':
+    try:
         main()
+    except SystemExit as x:
+        if x.code != 0:
+            print(f"Exited with code {x.code}")

Ghidra/Debug/Debugger-agent-dbgeng/data/support/local-dbgeng-attach.py

@@ -18,25 +18,16 @@ import os
 import sys
 
 
-home = os.getenv('GHIDRA_HOME')
-
-if os.path.isdir(f'{home}\\ghidra\\.git'):
+def append_paths():
     sys.path.append(
-        f'{home}\\ghidra\\Ghidra\\Debug\\Debugger-agent-dbgeng\\build\\pypkg\\src')
-    sys.path.append(
-        f'{home}\\ghidra\\Ghidra\\Debug\\Debugger-rmi-trace\\build\\pypkg\\src')
-elif os.path.isdir(f'{home}\\.git'):
-    sys.path.append(
-        f'{home}\\Ghidra\\Debug\\Debugger-agent-dbgeng\\build\\pypkg\\src')
-    sys.path.append(
-        f'{home}\\Ghidra\\Debug\\Debugger-rmi-trace\\build\\pypkg\\src')
-else:
-    sys.path.append(
-        f'{home}\\Ghidra\\Debug\\Debugger-agent-dbgeng\\pypkg\\src')
-    sys.path.append(f'{home}\\Ghidra\\Debug\\Debugger-rmi-trace\\pypkg\\src')
+        f"{os.getenv('MODULE_Debugger_rmi_trace_HOME')}/data/support")
+    from gmodutils import ghidra_module_pypath
+    sys.path.append(ghidra_module_pypath("Debugger-rmi-trace"))
+    sys.path.append(ghidra_module_pypath())
 
 
 def main():
+    append_paths()
     # Delay these imports until sys.path is patched
     from ghidradbg import commands as cmd
     from pybag.dbgeng import core as DbgEng
@@ -61,9 +52,14 @@ def main():
     cmd.ghidra_trace_start(os.getenv('OPT_TARGET_IMG'))
     cmd.ghidra_trace_sync_enable()
 
-    on_state_changed(DbgEng.DEBUG_CES_EXECUTION_STATUS, DbgEng.DEBUG_STATUS_BREAK)
+    on_state_changed(DbgEng.DEBUG_CES_EXECUTION_STATUS,
+                     DbgEng.DEBUG_STATUS_BREAK)
     cmd.repl()
 
 
 if __name__ == '__main__':
+    try:
         main()
+    except SystemExit as x:
+        if x.code != 0:
+            print(f"Exited with code {x.code}")

Ghidra/Debug/Debugger-agent-dbgeng/data/support/local-dbgeng-ext.py

@@ -18,25 +18,16 @@ import os
 import sys
 
 
-home = os.getenv('GHIDRA_HOME')
-
-if os.path.isdir(f'{home}\\ghidra\\.git'):
+def append_paths():
     sys.path.append(
-        f'{home}\\ghidra\\Ghidra\\Debug\\Debugger-agent-dbgeng\\build\\pypkg\\src')
-    sys.path.append(
-        f'{home}\\ghidra\\Ghidra\\Debug\\Debugger-rmi-trace\\build\\pypkg\\src')
-elif os.path.isdir(f'{home}\\.git'):
-    sys.path.append(
-        f'{home}\\Ghidra\\Debug\\Debugger-agent-dbgeng\\build\\pypkg\\src')
-    sys.path.append(
-        f'{home}\\Ghidra\\Debug\\Debugger-rmi-trace\\build\\pypkg\\src')
-else:
-    sys.path.append(
-        f'{home}\\Ghidra\\Debug\\Debugger-agent-dbgeng\\pypkg\\src')
-    sys.path.append(f'{home}\\Ghidra\\Debug\\Debugger-rmi-trace\\pypkg\\src')
+        f"{os.getenv('MODULE_Debugger_rmi_trace_HOME')}/data/support")
+    from gmodutils import ghidra_module_pypath
+    sys.path.append(ghidra_module_pypath("Debugger-rmi-trace"))
+    sys.path.append(ghidra_module_pypath())
 
 
 def main():
+    append_paths()
     # Delay these imports until sys.path is patched
     from ghidradbg import commands as cmd
     from pybag.dbgeng import core as DbgEng
@@ -51,13 +42,20 @@ def main():
     args = os.getenv('OPT_TARGET_ARGS')
     if args:
         args = ' ' + args
+    target = os.getenv('OPT_TARGET_IMG')
+    if target is None or target == "":
+        print("dbgeng requires a target image - please try again.")
+        cmd.ghidra_trace_disconnect()
+        return
+
     cmd.ghidra_trace_create_ext(
-        os.getenv('OPT_TARGET_IMG') + args, 
+        target + args,
         os.getenv('OPT_TARGET_DIR'),
         os.getenv('OPT_TARGET_ENV'),
         os.getenv('OPT_CREATE_FLAGS'),
         os.getenv('OPT_CREATE_ENGFLAGS'),
         os.getenv('OPT_VERIFIER_FLAGS'),
+        os.getenv('OPT_ENG_OPTIONS'),
         start_trace=False)
 
     # TODO: HACK
@@ -66,12 +64,17 @@ def main():
     except KeyboardInterrupt as ki:
         dbg.interrupt()
 
-    cmd.ghidra_trace_start(os.getenv('OPT_TARGET_IMG'))
+    cmd.ghidra_trace_start(target)
     cmd.ghidra_trace_sync_enable()
 
-    on_state_changed(DbgEng.DEBUG_CES_EXECUTION_STATUS, DbgEng.DEBUG_STATUS_BREAK)
+    on_state_changed(DbgEng.DEBUG_CES_EXECUTION_STATUS,
+                     DbgEng.DEBUG_STATUS_BREAK)
     cmd.repl()
 
 
 if __name__ == '__main__':
+    try:
         main()
+    except SystemExit as x:
+        if x.code != 0:
+            print(f"Exited with code {x.code}")

Ghidra/Debug/Debugger-agent-dbgeng/data/support/local-dbgeng-trace.py

@@ -0,0 +1,71 @@
+## ###
+# IP: GHIDRA
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+##
+
+import os
+import sys
+
+
+def append_paths():
+    sys.path.append(
+        f"{os.getenv('MODULE_Debugger_rmi_trace_HOME')}/data/support")
+    from gmodutils import ghidra_module_pypath
+    sys.path.append(ghidra_module_pypath("Debugger-rmi-trace"))
+    sys.path.append(ghidra_module_pypath())
+
+
+def main():
+    append_paths()
+    # Delay these imports until sys.path is patched
+    from ghidradbg import commands as cmd
+    from pybag.dbgeng import core as DbgEng
+    from ghidradbg.hooks import on_state_changed
+    from ghidradbg.util import dbg
+
+    # So that the user can re-enter by typing repl()
+    global repl
+    repl = cmd.repl
+
+    cmd.ghidra_trace_connect(os.getenv('GHIDRA_TRACE_RMI_ADDR'))
+    target = os.getenv('OPT_TARGET_TRACE')
+    if target is None or target == "":
+        print("dbgeng requires a target trace - please try again.")
+        cmd.ghidra_trace_disconnect()
+        return
+
+    cmd.ghidra_trace_open(target, start_trace=False)
+
+    # TODO: HACK
+    # Also, the wait() must precede sync_enable() or else PROC_STATE will
+    # contain the wrong PID, and later events will get snuffed
+    try:
+        dbg.wait()
+    except KeyboardInterrupt as ki:
+        dbg.interrupt()
+
+    cmd.ghidra_trace_start(target)
+    cmd.ghidra_trace_sync_enable()
+
+    on_state_changed(DbgEng.DEBUG_CES_EXECUTION_STATUS,
+                     DbgEng.DEBUG_STATUS_BREAK)
+    cmd.repl()
+
+
+if __name__ == '__main__':
+    try:
+        main()
+    except SystemExit as x:
+        if x.code != 0:
+            print(f"Exited with code {x.code}")

Ghidra/Debug/Debugger-agent-dbgeng/data/support/local-dbgeng.py

@@ -18,25 +18,16 @@ import os
 import sys
 
 
-home = os.getenv('GHIDRA_HOME')
-
-if os.path.isdir(f'{home}\\ghidra\\.git'):
+def append_paths():
     sys.path.append(
-        f'{home}\\ghidra\\Ghidra\\Debug\\Debugger-agent-dbgeng\\build\\pypkg\\src')
-    sys.path.append(
-        f'{home}\\ghidra\\Ghidra\\Debug\\Debugger-rmi-trace\\build\\pypkg\\src')
-elif os.path.isdir(f'{home}\\.git'):
-    sys.path.append(
-        f'{home}\\Ghidra\\Debug\\Debugger-agent-dbgeng\\build\\pypkg\\src')
-    sys.path.append(
-        f'{home}\\Ghidra\\Debug\\Debugger-rmi-trace\\build\\pypkg\\src')
-else:
-    sys.path.append(
-        f'{home}\\Ghidra\\Debug\\Debugger-agent-dbgeng\\pypkg\\src')
-    sys.path.append(f'{home}\\Ghidra\\Debug\\Debugger-rmi-trace\\pypkg\\src')
+        f"{os.getenv('MODULE_Debugger_rmi_trace_HOME')}/data/support")
+    from gmodutils import ghidra_module_pypath
+    sys.path.append(ghidra_module_pypath("Debugger-rmi-trace"))
+    sys.path.append(ghidra_module_pypath())
 
 
 def main():
+    append_paths()
     # Delay these imports until sys.path is patched
     from ghidradbg import commands as cmd
     from pybag.dbgeng import core as DbgEng
@@ -51,8 +42,13 @@ def main():
     args = os.getenv('OPT_TARGET_ARGS')
     if args:
         args = ' ' + args
-    cmd.ghidra_trace_create(
-        os.getenv('OPT_TARGET_IMG') + args, start_trace=False)
+    target = os.getenv('OPT_TARGET_IMG')
+    if target is None or target == "":
+        print("dbgeng requires a target image - please try again.")
+        cmd.ghidra_trace_disconnect()
+        return
+
+    cmd.ghidra_trace_create(target + args, start_trace=False)
 
     # TODO: HACK
     try:
@@ -60,12 +56,17 @@ def main():
     except KeyboardInterrupt as ki:
         dbg.interrupt()
 
-    cmd.ghidra_trace_start(os.getenv('OPT_TARGET_IMG'))
+    cmd.ghidra_trace_start(target)
     cmd.ghidra_trace_sync_enable()
 
-    on_state_changed(DbgEng.DEBUG_CES_EXECUTION_STATUS, DbgEng.DEBUG_STATUS_BREAK)
+    on_state_changed(DbgEng.DEBUG_CES_EXECUTION_STATUS,
+                     DbgEng.DEBUG_STATUS_BREAK)
     cmd.repl()
 
 
 if __name__ == '__main__':
+    try:
         main()
+    except SystemExit as x:
+        if x.code != 0:
+            print(f"Exited with code {x.code}")

Ghidra/Debug/Debugger-agent-dbgeng/data/support/local-ttd.py

@@ -1,58 +0,0 @@
-## ###
-#  IP: GHIDRA
-# 
-#  Licensed under the Apache License, Version 2.0 (the "License");
-#  you may not use this file except in compliance with the License.
-#  You may obtain a copy of the License at
-#  
-#       http://www.apache.org/licenses/LICENSE-2.0
-#  
-#  Unless required by applicable law or agreed to in writing, software
-#  distributed under the License is distributed on an "AS IS" BASIS,
-#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#  See the License for the specific language governing permissions and
-#  limitations under the License.
-##
-
-import os
-import sys
-
-
-home = os.getenv('GHIDRA_HOME')
-
-if os.path.isdir(f'{home}\\ghidra\\.git'):
-    sys.path.append(
-        f'{home}\\ghidra\\Ghidra\\Debug\\Debugger-agent-dbgeng\\build\\pypkg\\src')
-    sys.path.append(
-        f'{home}\\ghidra\\Ghidra\\Debug\\Debugger-rmi-trace\\build\\pypkg\\src')
-elif os.path.isdir(f'{home}\\.git'):
-    sys.path.append(
-        f'{home}\\Ghidra\\Debug\\Debugger-agent-dbgeng\\build\\pypkg\\src')
-    sys.path.append(
-        f'{home}\\Ghidra\\Debug\\Debugger-rmi-trace\\build\\pypkg\\src')
-else:
-    sys.path.append(
-        f'{home}\\Ghidra\\Debug\\Debugger-agent-dbgeng\\pypkg\\src')
-    sys.path.append(f'{home}\\Ghidra\\Debug\\Debugger-rmi-trace\\pypkg\\src')
-
-
-def main():
-    # Delay these imports until sys.path is patched
-    from ghidrattd import commands as cmd
-    from ghidrattd import hooks
-    ###from ghidrattd.util import dbg
-
-    cmd.ghidra_trace_connect(os.getenv('GHIDRA_TRACE_RMI_ADDR'))
-    args = os.getenv('OPT_TARGET_ARGS')
-    if args:
-        args = ' ' + args
-    cmd.ghidra_trace_create(
-        os.getenv('OPT_TARGET_IMG') + args, start_trace=True)
-    cmd.ghidra_trace_sync_enable()
-    hooks.on_stop()
-
-    cmd.repl()
-
-
-if __name__ == '__main__':
-    main()

Ghidra/Debug/Debugger-agent-dbgeng/data/support/remote-dbgeng.py

@@ -18,25 +18,16 @@ import os
 import sys
 
 
-home = os.getenv('GHIDRA_HOME')
-
-if os.path.isdir(f'{home}\\ghidra\\.git'):
+def append_paths():
     sys.path.append(
-        f'{home}\\ghidra\\Ghidra\\Debug\\Debugger-agent-dbgeng\\build\\pypkg\\src')
-    sys.path.append(
-        f'{home}\\ghidra\\Ghidra\\Debug\\Debugger-rmi-trace\\build\\pypkg\\src')
-elif os.path.isdir(f'{home}\\.git'):
-    sys.path.append(
-        f'{home}\\Ghidra\\Debug\\Debugger-agent-dbgeng\\build\\pypkg\\src')
-    sys.path.append(
-        f'{home}\\Ghidra\\Debug\\Debugger-rmi-trace\\build\\pypkg\\src')
-else:
-    sys.path.append(
-        f'{home}\\Ghidra\\Debug\\Debugger-agent-dbgeng\\pypkg\\src')
-    sys.path.append(f'{home}\\Ghidra\\Debug\\Debugger-rmi-trace\\pypkg\\src')
+        f"{os.getenv('MODULE_Debugger_rmi_trace_HOME')}/data/support")
+    from gmodutils import ghidra_module_pypath
+    sys.path.append(ghidra_module_pypath("Debugger-rmi-trace"))
+    sys.path.append(ghidra_module_pypath())
 
 
 def main():
+    append_paths()
     # Delay these imports until sys.path is patched
     from ghidradbg import commands as cmd
     from pybag.dbgeng import core as DbgEng
@@ -48,26 +39,20 @@ def main():
     repl = cmd.repl
 
     cmd.ghidra_trace_connect(os.getenv('GHIDRA_TRACE_RMI_ADDR'))
-    args = os.getenv('OPT_TARGET_ARGS')
-    if args:
-        args = ' ' + args
-    cmd.ghidra_trace_connect_server(os.getenv('OPT_CONNECT_STRING'))
-    img = os.getenv('OPT_TARGET_IMG')
-    if img is not None and img != "":
-        cmd.ghidra_trace_create(img + args, start_trace=False)
 
-    # TODO: HACK
-    try:
-        dbg.wait()
-    except KeyboardInterrupt as ki:
+    os.environ['OPT_USE_DBGMODEL'] = "false"
+    cmd.ghidra_trace_start("Remote")
+    cmd.ghidra_trace_sync_enable()
     dbg.interrupt()
 
-    cmd.ghidra_trace_start(os.getenv('OPT_TARGET_IMG'))
-    cmd.ghidra_trace_sync_enable()
-    
-    on_state_changed(DbgEng.DEBUG_CES_EXECUTION_STATUS, DbgEng.DEBUG_STATUS_BREAK)
+    on_state_changed(DbgEng.DEBUG_CES_EXECUTION_STATUS,
+                     DbgEng.DEBUG_STATUS_BREAK)
     cmd.repl()
 
 
 if __name__ == '__main__':
+    try:
         main()
+    except SystemExit as x:
+        if x.code != 0:
+            print(f"Exited with code {x.code}")

Ghidra/Debug/Debugger-agent-dbgeng/data/support/standalone_listener.py

@@ -0,0 +1,76 @@
+## ###
+# IP: GHIDRA
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+##
+
+# TO LAUNCH:  py -i standalone_listener.py  "path_to_target.exe"
+
+import os
+import sys
+
+
+def append_paths():
+    sys.path.append(
+        f"{os.getenv('MODULE_Debugger_rmi_trace_HOME')}/data/support")
+    from gmodutils import ghidra_module_pypath
+    sys.path.append(ghidra_module_pypath("Debugger-rmi-trace"))
+    sys.path.append(ghidra_module_pypath())
+
+
+def main():
+    append_paths()
+    # Delay these imports until sys.path is patched
+    from ghidradbg import commands as cmd
+    from pybag.dbgeng import core as DbgEng
+    from ghidradbg.hooks import on_state_changed
+    from ghidradbg.util import dbg
+
+    # So that the user can re-enter by typing repl()
+    global repl
+    repl = cmd.repl
+
+    cmd.ghidra_trace_listen()
+    args = os.getenv('OPT_TARGET_ARGS')
+    if args:
+        args = ' ' + args
+    else:
+        args = ''
+    target = sys.argv[1]
+    if target is None or target == "":
+        print("dbgeng requires a target image - please try again.")
+        cmd.ghidra_trace_disconnect()
+        return
+
+    cmd.ghidra_trace_create(target + args, start_trace=False)
+
+    # TODO: HACK
+    try:
+        dbg.wait()
+    except KeyboardInterrupt as ki:
+        dbg.interrupt()
+
+    cmd.ghidra_trace_start(target)
+    cmd.ghidra_trace_sync_enable()
+
+    on_state_changed(DbgEng.DEBUG_CES_EXECUTION_STATUS,
+                     DbgEng.DEBUG_STATUS_BREAK)
+    cmd.repl()
+
+
+if __name__ == '__main__':
+    try:
+        main()
+    except SystemExit as x:
+        if x.code != 0:
+            print(f"Exited with code {x.code}")

Ghidra/Debug/Debugger-agent-dbgeng/data/support/svrcx-dbgeng.py

@@ -0,0 +1,69 @@
+## ###
+# IP: GHIDRA
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+##
+
+import os
+import sys
+
+
+def append_paths():
+    sys.path.append(
+        f"{os.getenv('MODULE_Debugger_rmi_trace_HOME')}/data/support")
+    from gmodutils import ghidra_module_pypath
+    sys.path.append(ghidra_module_pypath("Debugger-rmi-trace"))
+    sys.path.append(ghidra_module_pypath())
+
+
+def main():
+    append_paths()
+    # Delay these imports until sys.path is patched
+    from ghidradbg import commands as cmd
+    from pybag.dbgeng import core as DbgEng
+    from ghidradbg.hooks import on_state_changed
+    from ghidradbg.util import dbg
+
+    # So that the user can re-enter by typing repl()
+    global repl
+    repl = cmd.repl
+
+    cmd.ghidra_trace_connect(os.getenv('GHIDRA_TRACE_RMI_ADDR'))
+    args = os.getenv('OPT_TARGET_ARGS')
+    if args:
+        args = ' ' + args
+    cmd.ghidra_trace_connect_server(os.getenv('OPT_CONNECT_STRING'))
+    img = os.getenv('OPT_TARGET_IMG')
+    if img is not None and img != "":
+        cmd.ghidra_trace_create(img + args, start_trace=False)
+
+    # TODO: HACK
+    try:
+        dbg.wait()
+    except KeyboardInterrupt as ki:
+        dbg.interrupt()
+
+    cmd.ghidra_trace_start(os.getenv('OPT_TARGET_IMG'))
+    cmd.ghidra_trace_sync_enable()
+
+    on_state_changed(DbgEng.DEBUG_CES_EXECUTION_STATUS,
+                     DbgEng.DEBUG_STATUS_BREAK)
+    cmd.repl()
+
+
+if __name__ == '__main__':
+    try:
+        main()
+    except SystemExit as x:
+        if x.code != 0:
+            print(f"Exited with code {x.code}")

Ghidra/Debug/Debugger-agent-dbgeng/src/main/help/help/TOC_Source.xml

@@ -0,0 +1,31 @@
+<?xml version='1.0' encoding='ISO-8859-1'?>
+<!-- See Base's TOC_Source.xml for help -->
+<tocroot>
+	<tocref id="TraceRmiLauncherServicePlugin">
+		<tocdef id="dbgeng" text="WinDbg (dbgeng.dll) Integration"
+			target="help/topics/dbgeng/dbgeng.html">
+
+			<tocdef id="dbgeng_local" text="Local"
+				target="help/topics/dbgeng/dbgeng.html#local" />
+
+			<tocdef id="dbgeng_ext" text="Extended Local"
+				target="help/topics/dbgeng/dbgeng.html#ext" />
+
+			<tocdef id="dbgeng_attach" text="Attach"
+				target="help/topics/dbgeng/dbgeng.html#attach" />
+
+			<tocdef id="dbgeng_remote" text="Remote"
+				target="help/topics/dbgeng/dbgeng.html#remote" />
+
+			<tocdef id="dbgeng_svrcx" text="Process Server"
+				target="help/topics/dbgeng/dbgeng.html#svrcx" />
+
+			<tocdef id="dbgeng_win_kenel" text="Windows Kernel"
+				target="help/topics/dbgeng/dbgeng.html#win_kernel" />
+
+			<tocdef id="dbgeng_ttd" text="TTD (Time-Travel Debugging)"
+				target="help/topics/dbgeng/dbgeng.html#ttd" />
+
+		</tocdef>
+	</tocref>
+</tocroot>

Ghidra/Debug/Debugger-agent-dbgeng/src/main/help/help/topics/dbgeng/dbgeng.html

@@ -0,0 +1,297 @@
+<!DOCTYPE doctype PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN">
+
+<HTML>
+  <HEAD>
+    <META name="generator" content=
+    "HTML Tidy for Java (vers. 2009-12-01), see jtidy.sourceforge.net">
+
+    <TITLE>Debugger Launchers: Windows Debugger (WinDbg, dbgeng.dll)</TITLE>
+    <META http-equiv="Content-Type" content="text/html; charset=windows-1252">
+    <LINK rel="stylesheet" type="text/css" href="help/shared/DefaultStyle.css">
+  </HEAD>
+
+  <BODY lang="EN-US">
+    <H1>Debugger Launchers: Windows Debugger (WinDbg, dbgeng.dll)</H1>
+
+    <P>Integration with WinDbg is achieved by implementing a console debugger in Python 3 based on
+    <TT>dbgeng.dll</TT> (via pybag). This DLL represents the Microsoft Windows Debugger engine, and
+    so is best suited for debugging Windows user-space targets. 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
+    probably crash with a message in the Terminal.</P>
+
+    <P>The following launchers based on Microsoft's <TT>dbgeng.dll</TT> are included out of the
+    box:</P>
+
+    <H2><A name="local"></A>Local</H2>
+
+    <P>The plain "<TT>dbgeng</TT>" defaults to launching the current program as a user-mode process
+    on the local system. If there is no current program, this launcher cannot be used. Clearing the
+    <B>Image</B> option will cause this launcher to fail.</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>
+
+    <H3><A name="setup"></A>Setup</H3>
+
+    <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 C:\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>
+
+    <H3>Options</H3>
+
+    <UL>
+      <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
+      fill this in based on information gathered when the current program was imported. If the file
+      exists and is executable on the local machine, it will be filled in automatically. Otherwise,
+      it is up to you to locate it. <B>NOTE:</B> If you have patched the current program database,
+      these changes are <EM>not</EM> applied to the target. You can either 1) apply the same
+      patches to the target once it is running, or 2) export a patched copy of your image and
+      direct this launcher to run it.</LI>
+
+      <LI><B>Arguments</B>: These are the command-line arguments to pass into the target process.
+      These are passed as is into WinDbg's "<TT>CreateProcess</TT>" function.</LI>
+
+      <LI><B>Use <TT>dbgmodel</TT></B>: If <TT>dbgmodel.dll</TT> is available on the system, this
+      launcher will use it to populate the trace's object model. Without that DLL, the launcher
+      will invent its own model, roughly approximating the same, using just the information
+      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.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>
+
+    <H2><A name="ext"></A>Extended Local</H2>
+
+    <P>The "<TT>dbgeng-ext</TT>" launcher extends the base <TT>dbgeng</TT> launcher adding extra
+    options (a la <TT>IDebugClient</TT>'s <TT>CreateProcess2</TT>).</P>
+
+    <H3>Options</H3>
+
+    <UL>
+      <LI><B>Dir</B>: This is the starting directory for the process.</LI>
+
+      <LI><B>Env</B>: This is a composite string containg Environment Variable entries delineated
+      by '/0' separators. For example, you could redefine USERNAME and USERPROFILE with the entry
+      'USERNAME=SomeUser/0USERPROFILE=C:\Users\SomeUser'.</LI>
+
+      <LI><B>CreateFlags</B>: Flags used when creating the process, typically either
+      DEBUG_PROCESS(1) or DEBUG_ONLY_THIS_PROCESS(2) if you do not wish to follow spawned
+      processes. Other possible values are defined by processes.h's
+      CreateProcessCreationFlags.</LI>
+
+      <LI><B>CreateFlags (Engine)</B>: Engine-specific flags used when creating the process
+      (defined in dbgeng.h). Typically, these are set to 0.</LI>
+
+      <LI><B>VerifierFlags (Engine)</B>: Flags used by the Application Verifier. Typically unused,
+      but, if desired, CreateEngineFlags must include
+      DEBUG_ECREATE_PROCESS_USE_VERIFIER_FLAGS(2).</LI>
+    </UL>
+
+    <H2><A name="attach"></A>Attach</H2>
+
+    <P>This launcher allows the user to attach to a local running process. Options are the same as
+    those for the base dbgeng, except for ProcessId and AttachFlags</P>
+
+    <H3>Options</H3>
+
+    <UL>
+      <LI><B>ProcessId</B>: The pid of the process you wish to attach to.</LI>
+
+      <LI><B>AttachFlags</B>: Flags used when attaching to the target process, typically
+      DEBUG_ATTACH_PROCESS(0). Other possible values are defined in dbgeng.h and determine whether
+      the attach should be invasive or not and the status of the process after attaching.</LI>
+    </UL>
+
+    <H2><A name="remote"></A>Remote</H2>
+
+    <P>This launcher connects to a remote debugger that has opened a port for remote control.</P>
+
+    <H3>Options</H3>
+
+    <UL>
+      <LI>
+        <B>Connection</B>: This is the connection string specifying the transport options for
+        communicating with the remote debugger. A typical example might be
+        'tcp:port=12345,server=192.168.0.2' for a debugger that has issued the command 
+<PRE>
+.server tcp:port=12345
+</PRE>
+      </LI>
+    </UL>
+
+    <H2><A name="svrcx"></A>Process Server</H2>
+
+    <P>The "<TT>dbgeng-svrcx</TT>" launcher extends the base dbgeng launcher adding an option for
+    connecting through a remote process server.</P>
+
+    <H3>Options</H3>
+
+    <UL>
+      <LI>
+        <B>Connection</B>: This is the connection string specifying the transport options for
+        communicating with the remote server. A typical example might be
+        'tcp:port=12345,server=192.168.0.2' for a process server launched on the machine at
+        192.168.0.2 using: 
+<PRE>
+        dbgsrv -t tcp:port=12345
+       
+</PRE>
+      </LI>
+    </UL>
+
+    <H2><A name="win_kernel"></A>Windows Kernel</H2>
+
+    <P>This version of the dbgeng should be used for kernel-debugging of a remote machine. Options
+    are the same as the base dbgeng, except for the connection-string arguments. For remote
+    debugging, the target machine should be booted with the appropriate options, set using BCDEDIT
+    or the equivalent, such as:</P>
+
+    <UL style='list-style-type: none'>
+      <LI>
+<PRE>
+bcdedit /debug ON
+bdcedit /dbgsettings NET HOSTIP:IP PORT:54321 KEY:1.1.1.1
+</PRE>
+      </LI>
+    </UL>
+
+    <P>where IP= the address of the machine runing Ghidra.</P>
+
+    <H3>Options</H3>
+
+    <UL>
+      <LI><B>Arguments</B>: This is the connection string specifying the transport options for
+      communicating with the remote target. A typical example might be
+      'net:port=54321,key=1.1.1.1'.'</LI>
+    </UL>
+
+    <UL>
+      <LI><B>Type</B>: The type of kernel connection, either "Remote", "Local", or "EXDI".
+      "Remote", the most common type, indicates two-machine debugging over various possible
+      connection media, e.g. Ethernet, serial, USB, etc. "Local" is used for limited introspection
+      into the target on which the debugger is running. "EXDI" is arguably the most exotic type -
+      it essentially simulates the normal "Remote" connection using the gdb Remote Serial Protocol.
+      It can be used when connecting to gdbstubs in platforms, such as QEMU, VMWare, Trace32,
+      etc.</LI>
+    </UL>
+
+    <H3>EXDI</H3>
+
+    <P>Setup for EXDI connections is fairly complicated and difficult to get correct. The argument
+    string typically should be something like:</P>
+
+    <UL style='list-style-type: none'>
+      <LI>
+<PRE>
+exdi:CLSID={29f9906e-9dbe-4d4b-b0fb-6acf7fb6d014},Kd=Guess,DataBreaks=Exdi
+</PRE>
+      </LI>
+    </UL>
+
+    <P>The CLSID here should match the CLSID in the <B>exdiConfigData.xml</B> file in the debugger
+    architectural directory. If windbg has been run using EXDI at some point, there will also be an
+    entry in the System Registry for this CLSID. The InprocServer32 subentry for this CLSID in the
+    Registry should point to a copy of ExdiGdbSrv.dll, typically the one in the same directory.
+    This DLL must reside somewhere that the debugger has permission to load from, i.e. not in the
+    WindowsApps directory tree. The <B>exdiConfigData</B> file should be configured for the target
+    you're using. We heavily recommend using <B>displayCommPackets==yes</B>, as many of the tasks
+    take considerable time, and this is the only indicator of progress.</P>
+
+    <P>The <B>Kd=Guess</B> parameter causes the underlying engine to scan memory for the kernel's
+    base address, which will probably not be provided by the gdbstub. (<B>Kd=NtBaseAddr</B> is also
+    a valid option, as is eliminating the parameter, but, currently, we have no idea how to point
+    the configuration at a correct value. Using this option will cause the load to spin
+    pointlessly.) If you can, we highly recommend breaking the target near the base address, as the
+    search proceeds down through memory starting at the current program counter. If the difference
+    between the PC and the base address is large, the loading process will punt before useful
+    values are detected. If anyone understand how to extend this search (or knows how to set the
+    base address to sidestep the scan), we would really love some guidance.</P>
+
+    <H2><A name="ttd"></A>TTD (Time-Travel Debugging)</H2>
+
+    <P>This is an extension to our launcher for the Windows Debugger to support TTD. WinDbg TTD
+    uses <CODE>event:ticks</CODE> to denote its times. This corresponds well to Ghidra's
+    <CODE>snapshot:steps</CODE> syntax, when we let snapshot be an event and ticks count the number
+    of instruction steps. Upon expanding the "Events" node in the Model tree, we create a snapshot
+    for every TTD event, including thread create/terminate, module load/unload, syscall, and other
+    asynchronous changes. Then, when Ghidra navigates to a schedule of the form
+    <CODE>snapshot:steps</CODE>, we command WinDbg to navigate to the corresponding
+    <CODE>event:ticks</CODE> instead of using Ghidra's emulator. Conversely, time navigation from
+    the WinDbg CLI will correspondingly navigate Ghidra. Thus, the two are synchronized in time. We
+    also add <EM>reverse</EM> variants of the <B>Go</B> and <B>Step</B> control commands.</P>
+
+    <H3>Options</H3>
+
+    <P>This launcher has basically the same options as the WinDbg launcher, except that arguments
+    are not included and the DLL path must contain <TT>TTDReplay.dll</TT> and the scripts that
+    implement TTD. These are most easily obtained by installing WinDbg Preview or later.</P>
+
+    <H3>Setup</H3>
+
+    <P>Depending on how you acquire WinDbg TTD, you may need to copy the installation to a
+    directory Ghidra is allowed to access. It's best not to try cherry-picking files. Just
+    copy/unpack the entire WinDbg installation. Point the launch dialog to the directory containing
+    <TT>dbgeng.dll</TT> as usual.</P>
+
+    <P><B>NOTE:</B> It's possible, especially if you have anti-virus software installed, that
+    <TT>dbghelp.dll</TT> is forcefully loaded into the Python process before our connector package
+    tries to load <TT>dbgeng.dll</TT>. This can cause <TT>dbghelp.dll</TT> to be loaded from
+    <TT>System32</TT>, but <TT>dbgeng.dll</TT> to be loaded from the WinDbg installation, often
+    leading to DLL compatibility problems. This usually manifests in module load and/or Python
+    import errors. The only real way to be sure is to use a system utility and inspect the DLLs
+    loaded by the <TT>python.exe</TT> process. You may be able to work around the issue by copying
+    <TT>dbghelp.dll</TT> (and any other affected WinDbg DLLs) from the WinDbg installation into
+    your Python installation, e.g., <TT>C:\Python313\dbghelp.dll</TT>.</P>
+  </BODY>
+</HTML>

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/DbgEngInJvmDebuggerModelFactory.java

@@ -1,95 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng;
-
-import java.util.ArrayList;
-import java.util.List;
-import java.util.concurrent.CompletableFuture;
-
-import agent.dbgeng.model.impl.DbgModelImpl;
-import ghidra.dbg.DebuggerModelFactory;
-import ghidra.dbg.DebuggerObjectModel;
-import ghidra.dbg.util.ConfigurableFactory.FactoryDescription;
-import ghidra.program.model.listing.Program;
-
-@FactoryDescription(
-	brief = "MS dbgeng.dll (WinDbg)",
-	htmlDetails = """
-			Connect to the Microsoft Debug Engine.
-			This is the same engine that powers WinDbg.
-			This is best for most Windows userspace and kernel targets.
-			Kernel debugging is still experimental.
-			This will access the native API, which may put Ghidra's JVM at risk.""")
-public class DbgEngInJvmDebuggerModelFactory implements DebuggerModelFactory {
-
-	protected String remote = "none"; // Require user to start server
-	@FactoryOption("DebugConnect options (.server)")
-	public final Property<String> agentRemoteOption =
-		Property.fromAccessors(String.class, this::getAgentRemote, this::setAgentRemote);
-
-	protected String transport = "none"; // Require user to start server
-	@FactoryOption("Remote process server options (untested)")
-	public final Property<String> agentTransportOption =
-		Property.fromAccessors(String.class, this::getAgentTransport, this::setAgentTransport);
-
-	@Override
-	public CompletableFuture<? extends DebuggerObjectModel> build() {
-		DbgModelImpl model = new DbgModelImpl();
-		List<String> cmds = new ArrayList<>();
-		completeCommandLine(cmds);
-		return model.startDbgEng(cmds.toArray(new String[cmds.size()])).thenApply(__ -> model);
-	}
-
-	@Override
-	public int getPriority(Program program) {
-		// TODO: Might instead look for the DLL
-		if (!System.getProperty("os.name").toLowerCase().contains("windows")) {
-			return -1;
-		}
-		if (program != null) {
-			String exe = program.getExecutablePath();
-			if (exe == null || exe.isBlank()) {
-				return -1;
-			}
-		}
-		return 80;
-	}
-
-	public String getAgentTransport() {
-		return transport;
-	}
-
-	public void setAgentTransport(String transport) {
-		this.transport = transport;
-	}
-
-	public String getAgentRemote() {
-		return remote;
-	}
-
-	public void setAgentRemote(String remote) {
-		this.remote = remote;
-	}
-
-	protected void completeCommandLine(List<String> cmd) {
-		if (!remote.equals("none") && !remote.equals("")) {
-			cmd.addAll(List.of(remote));
-		}
-		if (!transport.equals("none") && !transport.equals("")) {
-			cmd.addAll(List.of(transport));
-		}
-	}
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/COMUtilsExtra.java

@@ -1,72 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng;
-
-import com.sun.jna.platform.win32.WinNT.HRESULT;
-import com.sun.jna.platform.win32.COM.COMException;
-import com.sun.jna.platform.win32.COM.COMUtils;
-
-/**
- * Utilities for interacting with Microsoft COM objects beyond those provided by {@link COMUtils}.
- * 
- * See the MSDN for details on the meanings of the return codes for the function or method of
- * interest.
- */
-public interface COMUtilsExtra {
-
-	public static HRESULT E_UNEXPECTED = new HRESULT(0x8000FFFF);
-	public static HRESULT E_BOUNDS = new HRESULT(0x8000000B);
-	public static HRESULT E_NOTIMPLEMENTED = new HRESULT(0x80004001);
-	public static HRESULT E_NOINTERFACE = new HRESULT(0x80004002);
-	public static HRESULT E_COM_EXC = new HRESULT(0x80004003);
-	public static HRESULT E_FAIL = new HRESULT(0x80004005);
-	public static HRESULT E_CANTCALLOUT_INASYNCCALL = new HRESULT(0x80010004);
-	public static HRESULT E_INTERNALEXCEPTION = new HRESULT(0x80040205);
-	public static HRESULT E_ACCESS_DENIED = new HRESULT(0x80070005);
-	public static HRESULT E_CANNOT_READ = new HRESULT(0x8007001E);
-	public static HRESULT E_INVALID_PARAM = new HRESULT(0x80070057);
-	public static HRESULT E_SCOPE_NOT_FOUND = new HRESULT(0x8007013E);
-
-	/**
-	 * Check if the given exception represents an {@code E_NOINTERFACE} result
-	 * 
-	 * @param e the exception
-	 * @return true if {@code E_NOINTERFACE}
-	 */
-	static boolean isE_NOINTERFACE(COMException e) {
-		return E_NOINTERFACE.equals(e.getHresult());
-	}
-
-	/**
-	 * Check if the given exception represents an {@code E_UNEXPECTED} result
-	 * 
-	 * @param e the exception
-	 * @return true if {@code E_UNEXPECTED}
-	 */
-	static boolean isE_UNEXPECTED(COMException e) {
-		return E_UNEXPECTED.equals(e.getHresult());
-	}
-
-	/**
-	 * Check if the given exception represents an {@code E_INTERNALEXCEPTION} result
-	 * 
-	 * @param e the exception
-	 * @return true if {@code E_INTERNALEXCEPTION}
-	 */
-	static boolean isE_INTERNALEXCEPTION(COMException e) {
-		return E_INTERNALEXCEPTION.equals(e.getHresult());
-	}
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/DbgEng.java

@@ -1,163 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng;
-
-import java.lang.ref.Cleaner;
-
-import com.sun.jna.WString;
-import com.sun.jna.platform.win32.Kernel32Util;
-import com.sun.jna.platform.win32.WinDef.DWORD;
-import com.sun.jna.platform.win32.WinNT.HANDLE;
-import com.sun.jna.platform.win32.COM.IUnknown;
-
-import agent.dbgeng.impl.dbgeng.client.DebugClientInternal;
-import agent.dbgeng.jna.dbgeng.DbgEngNative;
-import ghidra.comm.util.BitmaskSet;
-import ghidra.util.Msg;
-
-/**
- * A wrapper for Microsoft's {@code dbgeng.dll} that presents a Java-friendly interface.
- * 
- * This is the "root interface" from which all other interfaces to {@code dbgeng.dll} are generated.
- * Not every method listed in the documentation, nor every method present in the header, is
- * implemented. Only those that were necessary to implement the SCTL adapter. However, the class and
- * interface hierarchy was designed so that adding the remaining methods should be fairly
- * straightforward. This wrapper attempts to obtain the most capable COM interfaces for the debug
- * client that it knows. Again, newer interfaces should be fairly straightforward to add.
- * 
- * Methods that are "obviously" wrappers for a COM method are left undocumented, unless there is
- * some nuance to how it has been wrapped. In many cases, a parameter which is an integer in the COM
- * method may be presented as an {@code enum} or {@link BitmaskSet} by the wrapper. Consult the MSDN
- * for the meaning of the various values and bit flags.
- * 
- * Each wrapper interface is implemented by several COM interface wrappers: one for each known COM
- * interface version. The wrapper is optimistic, in that it declares wrapper methods even for COM
- * methods that are only available in later versions. The implementations limited to earlier COM
- * interfaces should either emulate the operation, or throw an
- * {@link UnsupportedOperationException}. Where a newer method is provided by a newer interface, a
- * wrapper implementation should prefer the latest. For example, one series of interfaces introduces
- * {@code *Wide} variants of existing methods. Since Java also uses a UTF-16-like string encoding
- * internally, JNA permits wide strings to be passed by reference. Thus, the wide variant is always
- * preferred.
- * 
- * Pay careful attention to the threading requirements imposed by {@code dbgeng.dll} these can be
- * found in the MSDN. As a general rule of thumb, if the method is reentrant (i.e., it can be called
- * from any thread), it is declared in the {@code *Reentrant} variant of the wrapper interface.
- * There are few of these. Unless the documentation explicitly lists the method as reentrant, do not
- * declare it there. Many methods appear to execute successfully from the wrong thread, but cause
- * latent issues. A practice to prevent accidental use of non-reentrant methods outside of the
- * client's owning thread is to ensure that only the owning thread can see the full interface. All
- * other threads should only have access to the reentrant interface.
- * 
- * If you implement methods that introduce a new callback class, use the existing callback type
- * hierarchies as a model. There are many classes to implement. Furthermore, be sure to keep a
- * reference to any active callback instances within the wrapper that uses them. The JNA has no way
- * of knowing whether or not the instance is still being used by the external C/C++ library. If you
- * do not store a reference, the JVM will think it's garbage and free it, even though COM is still
- * using it. Drop the reference only when you are certain nothing external has a reference to it.
- */
-public class DbgEng {
-	private static final Cleaner CLEANER = Cleaner.create();
-
-	private static class ReleaseCOMObject implements Runnable {
-		private final IUnknown obj;
-
-		ReleaseCOMObject(IUnknown obj) {
-			this.obj = obj;
-		}
-
-		@Override
-		public void run() {
-			Msg.debug(this, "Releasing COM object: " + obj);
-			obj.Release();
-		}
-	}
-
-	private static class ReleaseHANDLE implements Runnable {
-		private final HANDLE handle;
-
-		public ReleaseHANDLE(HANDLE handle) {
-			this.handle = handle;
-		}
-
-		@Override
-		public void run() {
-			Kernel32Util.closeHandle(handle);
-		}
-	}
-
-	public static class OpaqueCleanable {
-		@SuppressWarnings("unused") // A reference to control GC
-		private final Object state;
-		@SuppressWarnings("unused") // A reference to control GC
-		private final Cleaner.Cleanable cleanable;
-
-		public OpaqueCleanable(Object state, Cleaner.Cleanable cleanable) {
-			this.state = state;
-			this.cleanable = cleanable;
-		}
-	}
-
-	public static OpaqueCleanable releaseWhenPhantom(Object owner, IUnknown obj) {
-		ReleaseCOMObject state = new ReleaseCOMObject(obj);
-		return new OpaqueCleanable(state, CLEANER.register(owner, state));
-	}
-
-	public static OpaqueCleanable releaseWhenPhantom(Object owner, HANDLE handle) {
-		ReleaseHANDLE state = new ReleaseHANDLE(handle);
-		return new OpaqueCleanable(state, CLEANER.register(owner, state));
-	}
-
-	/**
-	 * Connect to a debug session.
-	 * 
-	 * See {@code DebugConnect} or {@code DebugConnectWide} on the MSDN.
-	 * 
-	 * @param remoteOptions the options, like those given to {@code -remote}
-	 * @return a new client connected as specified
-	 */
-	public static DebugClient debugConnect(String remoteOptions) {
-		WString options = new WString(remoteOptions);
-		return DebugClientInternal.tryPreferredInterfaces((refiid,
-				ppClient) -> DbgEngNative.INSTANCE.DebugConnectWide(options, refiid, ppClient));
-	}
-
-	/**
-	 * Create a debug client.
-	 * 
-	 * Typically, this client is connected to the "local server". See {@code DebugCreate} on the
-	 * MSDN.
-	 * 
-	 * @return a new client
-	 */
-	public static DebugClient debugCreate() {
-		return DebugClientInternal.tryPreferredInterfaces(DbgEngNative.INSTANCE::DebugCreate);
-	}
-
-	/**
-	 * Create a debug client with the given options.
-	 * 
-	 * See {@code DebugCreateEx} on the MSDN.
-	 * 
-	 * @param options the options
-	 * @return a new client
-	 */
-	public static DebugClient debugCreate(int options) {
-		DWORD dwOpts = new DWORD(options);
-		return DebugClientInternal.tryPreferredInterfaces(
-			(refiid, ppClient) -> DbgEngNative.INSTANCE.DebugCreateEx(refiid, dwOpts, ppClient));
-	}
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/DebugAdvanced.java

@@ -1,83 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng;
-
-/**
- * A wrapper for {@code IDebugAdvanced} and its newer variants.
- */
-public interface DebugAdvanced {
-	public static class DebugThreadBasicInformation {
-		public final Integer exitStatus;
-		public final Integer priorityClass;
-		public final Integer priority;
-		public final Long createTime;
-		public final Long exitTime;
-		public final Long kernelTime;
-		public final Long userTime;
-		public final Long startOffset;
-		public final Long affinity;
-
-		public DebugThreadBasicInformation(Integer exitStatus, Integer priorityClass,
-				Integer priority, Long createTime, Long exitTime, Long kernelTime, Long userTime,
-				Long startOffset, Long affinity) {
-			this.exitStatus = exitStatus;
-			this.priorityClass = priorityClass;
-			this.priority = priority;
-			this.createTime = createTime;
-			this.exitTime = exitTime;
-			this.kernelTime = kernelTime;
-			this.userTime = userTime;
-			this.startOffset = startOffset;
-			this.affinity = affinity;
-		}
-
-		@Override
-		public String toString() {
-			StringBuilder sb = new StringBuilder("<DebugThreadBasicInformation:\n");
-			if (exitStatus != null) {
-				sb.append("    exitStatus: " + exitStatus + "\n");
-			}
-			if (priorityClass != null) {
-				sb.append("    priorityClass: " + priorityClass + "\n");
-			}
-			if (priority != null) {
-				sb.append("    priority: " + priority + "\n");
-			}
-			if (createTime != null) {
-				sb.append("    createTime: " + createTime + "\n");
-			}
-			if (exitTime != null) {
-				sb.append("    exitTime: " + exitTime + "\n");
-			}
-			if (kernelTime != null) {
-				sb.append("    kernelTime: " + kernelTime + "\n");
-			}
-			if (userTime != null) {
-				sb.append("    userTime: " + userTime + "\n");
-			}
-			if (startOffset != null) {
-				sb.append("    startOffset: " + startOffset + "\n");
-			}
-			if (affinity != null) {
-				sb.append("    affinity: " + affinity + "\n");
-			}
-			sb.append(">");
-			return sb.toString();
-		}
-	}
-
-	DebugThreadBasicInformation getThreadBasicInformation(DebugThreadId tid);
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/DebugBreakpoint.java

@@ -1,137 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng;
-
-import agent.dbgeng.jna.dbgeng.WinNTExtra.Machine;
-import ghidra.comm.util.BitmaskSet;
-import ghidra.comm.util.BitmaskUniverse;
-
-/**
- * A wrapper for {@code IDebugBreakpoint} and its newer variants.
- */
-public interface DebugBreakpoint {
-	public static enum BreakType {
-		CODE, DATA, TIME, INLINE;
-	}
-
-	public static class BreakFullType {
-		public final BreakType breakType;
-		public final Machine procType; // TODO: Guessing the values are from WinNT
-
-		public BreakFullType(BreakType breakType, Machine procType) {
-			this.breakType = breakType;
-			this.procType = procType;
-		}
-	}
-
-	public static enum BreakFlags implements BitmaskUniverse {
-		GO_ONLY(1 << 0), //
-		DEFERRED(1 << 1), //
-		ENABLED(1 << 2), //
-		ADDER_ONLY(1 << 3), //
-		ONE_SHOT(1 << 4), //
-		;
-
-		private BreakFlags(int mask) {
-			this.mask = mask;
-		}
-
-		private final int mask;
-
-		@Override
-		public long getMask() {
-			return mask;
-		}
-	}
-
-	public static enum BreakAccess implements BitmaskUniverse {
-		READ(1 << 0), //
-		WRITE(1 << 1), //
-		EXECUTE(1 << 2), //
-		IO(1 << 3), //
-		;
-
-		private BreakAccess(int mask) {
-			this.mask = mask;
-		}
-
-		private final int mask;
-
-		@Override
-		public long getMask() {
-			return mask;
-		}
-	}
-
-	public static class BreakDataParameters {
-		public int size;
-		public BitmaskSet<BreakAccess> access;
-
-		public BreakDataParameters(int size, BitmaskSet<BreakAccess> access) {
-			this.size = size;
-			this.access = access;
-		}
-	}
-
-	void remove();
-
-	int getId();
-
-	BreakFullType getType();
-
-	DebugClient getAdder();
-
-	BitmaskSet<BreakFlags> getFlags();
-
-	void addFlags(BitmaskSet<BreakFlags> flags);
-
-	void addFlags(BreakFlags... flags);
-
-	void removeFlags(BitmaskSet<BreakFlags> flags);
-
-	void removeFlags(BreakFlags... flags);
-
-	void setFlags(BitmaskSet<BreakFlags> flags);
-
-	void setFlags(BreakFlags... flags);
-
-	/**
-	 * Get the location on target that triggers the breakpoint
-	 * 
-	 * <p>
-	 * If the breakpoint is deferred, this will return {@code null}. In that case, use
-	 * {@link #getOffsetExpression()}.
-	 * 
-	 * @return the offset, or {@code null}
-	 */
-	Long getOffset();
-
-	void setOffset(long offset);
-
-	String getOffsetExpression();
-
-	void setOffsetExpression(String expression);
-
-	BreakDataParameters getDataParameters();
-
-	void setDataParameters(BreakDataParameters params);
-
-	void setDataParameters(int size, BitmaskSet<BreakAccess> access);
-
-	void setDataParameters(int size, BreakAccess... access);
-
-	void dispose();
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/DebugClient.java

@@ -1,434 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng;
-
-import java.util.List;
-
-import com.sun.jna.platform.win32.WinBase;
-
-import agent.dbgeng.dbgeng.DebugRunningProcess.Description;
-import agent.dbgeng.dbgeng.DebugRunningProcess.Description.ProcessDescriptionFlags;
-import ghidra.comm.util.BitmaskSet;
-import ghidra.comm.util.BitmaskUniverse;
-
-/**
- * A wrapper for {@code IDebugClient} and its newer variants.
- */
-public interface DebugClient extends DebugClientReentrant {
-	public static enum ExecutionState {
-		RUNNING, STOPPED;
-	}
-
-	public static enum DebugStatus {
-		NO_CHANGE(false, null, 13), //
-		GO(true, ExecutionState.RUNNING, 10), //
-		GO_HANDLED(true, ExecutionState.RUNNING, 9), //
-		GO_NOT_HANDLED(true, ExecutionState.RUNNING, 8), //
-		STEP_OVER(true, ExecutionState.RUNNING, 7), //
-		STEP_INTO(true, ExecutionState.RUNNING, 5), //
-		BREAK(false, ExecutionState.STOPPED, 0), //
-		NO_DEBUGGEE(true, null, 1), // shouldWait is true to handle process creation
-		STEP_BRANCH(true, ExecutionState.RUNNING, 6), //
-		IGNORE_EVENT(false, null, 11), //
-		RESTART_REQUESTED(true, null, 12), //
-		REVERSE_GO(true, null, 0xff), //
-		REVERSE_STEP_BRANCH(true, null, 0xff), //
-		REVERSE_STEP_OVER(true, null, 0xff), //
-		REVERSE_STEP_INTO(true, null, 0xff), //
-		OUT_OF_SYNC(false, null, 2), //
-		WAIT_INPUT(false, null, 3), //
-		TIMEOUT(false, null, 4), //
-		;
-
-		public static final long MASK = 0xaf;
-		public static final long INSIDE_WAIT = 0x100000000L;
-		public static final long WAIT_TIMEOUT = 0x200000000L;
-
-		DebugStatus(boolean shouldWait, ExecutionState threadState, int precedence) {
-			this.shouldWait = shouldWait;
-			this.threadState = threadState;
-			this.precedence = precedence;
-		}
-
-		public final boolean shouldWait;
-		public final ExecutionState threadState;
-		public final int precedence; // 0 is highest
-
-		public static DebugStatus fromArgument(long argument) {
-			return values()[(int) (argument & MASK)];
-		}
-
-		public static boolean isInsideWait(long argument) {
-			return (argument & INSIDE_WAIT) != 0;
-		}
-
-		public static boolean isWaitTimeout(long argument) {
-			return (argument & WAIT_TIMEOUT) != 0;
-		}
-	}
-
-	public static enum SessionStatus {
-		ACTIVE, //
-		END_SESSION_ACTIVE_TERMINATE,//
-		END_SESSION_ACTIVE_DETACH, //
-		END_SESSION_PASSIVE, //
-		END, //
-		REBOOT, //
-		HIBERNATE, //
-		FAILURE, //
-		;
-	}
-
-	public static enum ChangeDebuggeeState implements BitmaskUniverse {
-		ALL(0xffffffff), //
-		REGISTERS(1 << 0), //
-		DATA(1 << 1), //
-		REFRESH(1 << 2), //
-		;
-
-		private ChangeDebuggeeState(int mask) {
-			this.mask = mask;
-		}
-
-		private final int mask;
-
-		@Override
-		public long getMask() {
-			return mask;
-		}
-	}
-
-	public static enum ChangeEngineState implements BitmaskUniverse {
-		ALL(0xffffffff), //
-		CURRENT_THREAD(1 << 0), //
-		EFFECTIVE_PROCESSOR(1 << 1), //
-		BREAKPOINTS(1 << 2), //
-		CODE_LEVEL(1 << 3), //
-		EXECUTION_STATUS(1 << 4), //
-		ENGINE_OPTIONS(1 << 5), //
-		LOG_FILE(1 << 6), //
-		RADIX(1 << 7), //
-		EVENT_FILTERS(1 << 8), //
-		PROCESS_OPTIONS(1 << 9), //
-		EXTENSIONS(1 << 10), //
-		SYSTEMS(1 << 11), //
-		ASSEMBLY_OPTIONS(1 << 12), //
-		EXPRESSION_SYNTAX(1 << 13), //
-		TEXT_REPLACEMENTS(1 << 14), //
-		;
-
-		private ChangeEngineState(int mask) {
-			this.mask = mask;
-		}
-
-		private final int mask;
-
-		@Override
-		public long getMask() {
-			return mask;
-		}
-	}
-
-	public static enum ChangeSymbolState implements BitmaskUniverse {
-		ALL(0xffffffff), //
-		LOADS(1 << 0), //
-		UNLOADS(1 << 1), //
-		SCOPE(1 << 2), //
-		PATHS(1 << 3), //
-		SYMBOL_OPTIONS(1 << 4), //
-		TYPE_OPTIONS(1 << 5), //
-		;
-
-		private ChangeSymbolState(int mask) {
-			this.mask = mask;
-		}
-
-		private final int mask;
-
-		@Override
-		public long getMask() {
-			return mask;
-		}
-	}
-
-	public static enum DebugAttachFlags implements BitmaskUniverse {
-		DEFAULT(0), //
-		NONINVASIVE(1 << 0), //
-		EXISTING(1 << 1), //
-		NONINVASIVE_NO_SUSPEND(1 << 2), //
-		INVASIVE_NO_INITIAL_BREAK(1 << 3), //
-		INVASIVE_RESUME_PROCESS(1 << 4), //
-		NONINVASIVE_ALLOW_PARTIAL(1 << 5), //
-		;
-
-		DebugAttachFlags(int mask) {
-			this.mask = mask;
-		}
-
-		private final int mask;
-
-		@Override
-		public long getMask() {
-			return mask;
-		}
-	}
-
-	public static enum DebugCreateFlags implements BitmaskUniverse {
-		DEBUG_PROCESS(WinBase.DEBUG_PROCESS), //
-		DEBUG_ONLY_THIS_PROCESS(WinBase.DEBUG_ONLY_THIS_PROCESS), //
-		CREATE_SUSPENDED(WinBase.CREATE_SUSPENDED), //
-		DETACHED_PROCESS(WinBase.DETACHED_PROCESS), //
-
-		CREATE_NEW_CONSOLE(WinBase.CREATE_NEW_CONSOLE), //
-		//NORMAL_PRIORITY_CLASS(WinBase.NORMAL_PRIORITY_CLASS), //
-		//IDLE_PRIORITY_CLASS(WinBase.IDLE_PRIORITY_CLASS), //
-		//HIGH_PRIORITY_CLASS(WinBase.HIGH_PRIORITY_CLASS), //
-
-		//REALTIME_PRIORITY_CLASS(WinBase.REALTIME_PRIORITY_CLASS), //
-		CREATE_NEW_PROCESS_GROUP(WinBase.CREATE_NEW_PROCESS_GROUP), //
-		CREATE_UNICODE_ENVIRONMENT(WinBase.CREATE_UNICODE_ENVIRONMENT), //
-		CREATE_SEPARATE_WOW_VDM(WinBase.CREATE_SEPARATE_WOW_VDM), //
-
-		CREATE_SHARED_WOW_VDM(WinBase.CREATE_SHARED_WOW_VDM), //
-		CREATE_FORCEDOS(WinBase.CREATE_FORCEDOS), //
-		//BELOW_NORMAL_PRIORITY_CLASS(WinBase.BELOW_NORMAL_PRIORITY_CLASS), //
-		//ABOVE_NORMAL_PRIORITY_CLASS(WinBase.ABOVE_NORMAL_PRIORITY_CLASS), //
-
-		INHERIT_PARENT_AFFINITY(WinBase.INHERIT_PARENT_AFFINITY), //
-		//INHERIT_CALLER_PRIORITY(WinBase.INHERIT_CALLER_PRIORITY), //
-		CREATE_PROTECTED_PROCESS(WinBase.CREATE_PROTECTED_PROCESS), //
-		EXTENDED_STARTUPINFO_PRESENT(WinBase.EXTENDED_STARTUPINFO_PRESENT), //
-
-		//PROCESS_MODE_BACKGROUND_BEGIN(WinBase.PROCESS_MODE_BACKGROUND_BEGIN), //
-		//PROCESS_MODE_BACKGROUND_END(WinBase.PROCESS_MODE_BACKGROUND_END), //
-
-		CREATE_BREAKAWAY_FROM_JOB(WinBase.CREATE_BREAKAWAY_FROM_JOB), //
-		CREATE_PRESERVE_CODE_AUTHZ_LEVEL(WinBase.CREATE_PRESERVE_CODE_AUTHZ_LEVEL), //
-		CREATE_DEFAULT_ERROR_MODE(WinBase.CREATE_DEFAULT_ERROR_MODE), //
-		CREATE_NO_WINDOW(WinBase.CREATE_NO_WINDOW), //
-
-		//PROFILE_USER(WinBase.PROFILE_USER), //
-		//PROFILE_KERNEL(WinBase.PROFILE_KERNEL), //     
-		//PROFILE_SERVER(WinBase.PROFILE_SERVER), //
-		//CREATE_IGNORE_SYSTEM_DEFAULT(WinBase.CREATE_IGNORE_SYSTEM_DEFAULT), //
-		DEBUG_CREATE_NO_DEBUG_HEAP(0x00000400), //
-		DEBUG_CREATE_THROUGH_RTL(0x00010000), //
-		;
-
-		DebugCreateFlags(int mask) {
-			this.mask = mask;
-		}
-
-		private final int mask;
-
-		@Override
-		public long getMask() {
-			return mask;
-		}
-	}
-
-	public enum DebugEngCreateFlags implements BitmaskUniverse {
-		DEBUG_ECREATE_PROCESS_DEFAULT(0x00000000),
-		DEBUG_ECREATE_INHERIT_HANDLES(0x00000001),
-		DEBUG_ECREATE_USE_VERIFIER_FLAGS(0x00000002),
-		DEBUG_ECREATE_USE_IMPLICIT_COMMAND_LINE(0x00000004);
-
-		DebugEngCreateFlags(int mask) {
-			this.mask = mask;
-		}
-
-		private final int mask;
-
-		@Override
-		public long getMask() {
-			return mask;
-		}
-	}
-
-	public enum DebugVerifierFlags implements BitmaskUniverse {
-		DEBUG_VERIFIER_DEFAULT(0x00000000);
-
-		DebugVerifierFlags(int mask) {
-			this.mask = mask;
-		}
-
-		private final int mask;
-
-		@Override
-		public long getMask() {
-			return mask;
-		}
-	}
-
-	public enum DebugEndSessionFlags {
-		DEBUG_END_PASSIVE(0x00000000),
-		DEBUG_END_ACTIVE_TERMINATE(0x00000001),
-		DEBUG_END_ACTIVE_DETACH(0x00000002),
-		DEBUG_END_REENTRANT(0x00000003),
-		DEBUG_END_DISCONNECT(0x00000004);
-
-		DebugEndSessionFlags(int value) {
-			this.value = value;
-		}
-
-		private final int value;
-
-		public long getValue() {
-			return value;
-		}
-	}
-
-	public enum DebugOutputFlags {
-		DEBUG_OUTPUT_NORMAL(0x1), //
-		DEBUG_OUTPUT_ERROR(0x2), //
-		DEBUG_OUTPUT_WARNING(0x4), //
-		DEBUG_OUTPUT_VERBOSE(0x8), //
-		DEBUG_OUTPUT_PROMPT(0x10), //
-		DEBUG_OUTPUT_PROMPT_REGISTERS(0x20), //
-		DEBUG_OUTPUT_EXTENSION_WARNING(0x40), //
-		DEBUG_OUTPUT_DEBUGGEE(0x80), //
-		DEBUG_OUTPUT_DEBUGGEE_PROMPT(0x100), //
-		DEBUG_OUTPUT_SYMBOLS(0x200);
-
-		DebugOutputFlags(int value) {
-			this.value = value;
-		}
-
-		private final int value;
-
-		public long getValue() {
-			return value;
-		}
-	}
-
-	/**
-	 * Obtain the advanced interface to this client.
-	 * 
-	 * @return the advanced interface
-	 */
-	DebugAdvanced getAdvanced();
-
-	/**
-	 * Obtain the control interface to this client
-	 * 
-	 * @return the control interface
-	 */
-	@Override
-	DebugControl getControl();
-
-	/**
-	 * Obtain the data spaces interface to this client
-	 * 
-	 * @return the data spaces interface
-	 */
-	DebugDataSpaces getDataSpaces();
-
-	/**
-	 * Obtain the registers interface to this client
-	 * 
-	 * @return the registers interface
-	 */
-	DebugRegisters getRegisters();
-
-	/**
-	 * Obtain the symbols interface to this client
-	 * 
-	 * @return the symbols interface
-	 */
-	DebugSymbols getSymbols();
-
-	/**
-	 * Obtain the system objects interface to this client
-	 * 
-	 * @return the system objects interface
-	 */
-	DebugSystemObjects getSystemObjects();
-
-	/**
-	 * The the ID for the local server
-	 * 
-	 * @return the ID
-	 */
-	DebugServerId getLocalServer();
-
-	void attachKernel(long flags, String options);
-
-	void startProcessServer(String options);
-
-	DebugServerId connectProcessServer(String options);
-
-	boolean dispatchCallbacks(int timeout);
-
-	void flushCallbacks();
-
-	default void dispatchCallbacks() {
-		this.dispatchCallbacks(-1);
-	}
-
-	void exitDispatch(DebugClient client);
-
-	default void exitDispatch() {
-		exitDispatch(this);
-	}
-
-	void setInputCallbacks(DebugInputCallbacks cb);
-
-	void setOutputCallbacks(DebugOutputCallbacks cb);
-
-	void setEventCallbacks(DebugEventCallbacks cb);
-
-	List<DebugRunningProcess> getRunningProcesses(DebugServerId server);
-
-	Description getProcessDescription(DebugServerId si, int systemId,
-			BitmaskSet<ProcessDescriptionFlags> flags);
-
-	void attachProcess(DebugServerId si, long processId, BitmaskSet<DebugAttachFlags> attachFlags);
-
-	void createProcess(DebugServerId si, String commandLine,
-			String initialDirectory, String environment,
-			BitmaskSet<DebugCreateFlags> createFlags,
-			BitmaskSet<DebugEngCreateFlags> engCreateFlags,
-			BitmaskSet<DebugVerifierFlags> verifierFlags);
-
-	void createProcessAndAttach(DebugServerId si, String commandLine,
-			BitmaskSet<DebugCreateFlags> createFlags, int processId,
-			BitmaskSet<DebugAttachFlags> attachFlags);
-
-	void startServer(String options);
-
-	// Only in IDebugClient2
-
-	void waitForProcessServerEnd(int timeout);
-
-	default void waitForProcessServerEnd() {
-		waitForProcessServerEnd(-1);
-	}
-
-	void terminateCurrentProcess();
-
-	void detachCurrentProcess();
-
-	void abandonCurrentProcess();
-
-	void connectSession(int flags);
-
-	void endSession(DebugEndSessionFlags flags);
-
-	// Only in IDebugClient4+
-
-	void openDumpFileWide(String fileName);
-
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/DebugClientReentrant.java

@@ -1,46 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng;
-
-/**
- * An interface containing the subset of {@link DebugClient} methods which are reentrant.
- * 
- * All other methods should be called only by the thread which created the client.
- */
-public interface DebugClientReentrant {
-	/**
-	 * Create a new client for the calling thread, connected to the same session as this client.
-	 * 
-	 * @return the new client
-	 */
-	DebugClient createClient();
-
-	/**
-	 * Get the reentrant control interface to the client
-	 * 
-	 * @return the control interface
-	 */
-	DebugControlReentrant getControl();
-
-	/**
-	 * End a session without acquiring locks
-	 * 
-	 * Note. This method calls {@code IDebugClient::EndSession(DEBUG_END_REENTRANT)}. Per the MSDN,
-	 * this may leave the engine in an indeterminate state. The engine should no longer be used by
-	 * this process. It's really only appropriate to use this method when terminating the debugger.
-	 */
-	void endSessionReentrant();
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/DebugControl.java

@@ -1,447 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng;
-
-import java.util.ArrayList;
-import java.util.List;
-
-import com.sun.jna.platform.win32.WinBase;
-import com.sun.jna.platform.win32.COM.COMException;
-
-import agent.dbgeng.dbgeng.DebugBreakpoint.BreakType;
-import agent.dbgeng.dbgeng.DebugClient.DebugStatus;
-import ghidra.comm.util.BitmaskSet;
-import ghidra.comm.util.BitmaskUniverse;
-import ghidra.util.Msg;
-
-/**
- * A wrapper for {@code IDebugControl} and its newer variants.
- */
-public interface DebugControl extends DebugControlReentrant {
-	public static final BitmaskSet<DebugOutputControl> SET_ALL_CLIENTS =
-		BitmaskSet.of(DebugOutputControl.ALL_CLIENTS);
-	public static final BitmaskSet<DebugExecute> SET_DEFAULT = BitmaskSet.of(DebugExecute.DEFAULT);
-
-	public static enum DebugOutputLevel implements BitmaskUniverse {
-		NORMAL(1 << 0), //
-		ERROR(1 << 1), //
-		WARNING(1 << 2), //
-		VERBOSE(1 << 3), //
-		PROMPT(1 << 4), //
-		PROMPT_REGISTERS(1 << 5), //
-		EXTENSION_WARNING(1 << 6), //
-		OUTPUT_DEBUGEE(1 << 7), //
-		OUTPUT_DEBUGEE_PROMPT(1 << 8), //
-		OUTPUT_SYMBOLS(1 << 9), //
-		OUTPUT_STATUS(1 << 10), //
-		;
-
-		private final int mask;
-
-		DebugOutputLevel(int mask) {
-			this.mask = mask;
-		}
-
-		@Override
-		public long getMask() {
-			return mask;
-		}
-	}
-
-	public static enum DebugOutputControl implements BitmaskUniverse {
-		THIS_CLIENT(0), //
-		ALL_CLIENTS(1), //
-		ALL_OTHER_CLIENTS(2), //
-		IGNORE(3), //
-		LOG_ONLY(4), //
-		SEND_MASK(7), //
-		NOT_LOGGED(1 << 3), //
-		OVERRIDE_MASK(1 << 4), //
-		DML(1 << 5), //
-		AMBIENT_DML(0xfffffffe), //
-		AMBIENT_TEXT(0xffffffff), //
-		AMBIENT(0xffffffff), //
-		;
-
-		private final int mask;
-
-		DebugOutputControl(int mask) {
-			this.mask = mask;
-		}
-
-		@Override
-		public long getMask() {
-			return mask;
-		}
-	}
-
-	public static enum DebugExecute implements BitmaskUniverse {
-		DEFAULT(0), //
-		ECHO(1 << 0), //
-		NOT_LOGGED(1 << 1), //
-		NO_REPEAT(1 << 2), //
-		;
-
-		private final int mask;
-
-		DebugExecute(int mask) {
-			this.mask = mask;
-		}
-
-		@Override
-		public long getMask() {
-			return mask;
-		}
-	}
-
-	public static enum DebugInterrupt {
-		ACTIVE, //
-		PASSIVE, //
-		EXIT, //
-		;
-	}
-
-	public static enum DebugFilterOrdinals {
-		DEBUG_FILTER_CREATE_THREAD, //
-		DEBUG_FILTER_EXIT_THREAD, //
-		DEBUG_FILTER_CREATE_PROCESS, //
-		DEBUG_FILTER_EXIT_PROCESS, //
-		DEBUG_FILTER_LOAD_MODULE, //
-		DEBUG_FILTER_UNLOAD_MODULE, //
-		DEBUG_FILTER_SYSTEM_ERROR, //
-		DEBUG_FILTER_INITIAL_BREAKPOINT, //
-		DEBUG_FILTER_INITIAL_MODULE_LOAD, //
-		DEBUG_FILTER_DEBUGGEE_OUTPUT, //
-		;
-	}
-
-	public static enum DebugFilterExecutionOption {
-		DEBUG_FILTER_BREAK(0, "Break"), //
-		DEBUG_FILTER_SECOND_CHANCE_BREAK(1, "Second-chance Break"), //
-		DEBUG_FILTER_OUTPUT(2, "Output-only"), //
-		DEBUG_FILTER_IGNORE(3, "Ignore"), //
-		DEBUG_FILTER_REMOVE(4, "Remove"), //
-		;
-
-		public static DebugFilterExecutionOption getByNumber(int val) {
-			for (DebugFilterExecutionOption m : DebugFilterExecutionOption.values()) {
-				if (m.val == val) {
-					return m;
-				}
-			}
-			return null;
-		}
-
-		DebugFilterExecutionOption(int val, String description) {
-			this.val = val;
-			this.description = description;
-		}
-
-		public final int val;
-		public final String description;
-	}
-
-	public static enum DebugFilterContinuationOption {
-		DEBUG_FILTER_GO_HANDLED(0, "Handled"), //
-		DEBUG_FILTER_GO_NOT_HANDLED(1, "Not Handled"), //
-		;
-
-		public static DebugFilterContinuationOption getByNumber(int val) {
-			for (DebugFilterContinuationOption m : DebugFilterContinuationOption.values()) {
-				if (m.val == val) {
-					return m;
-				}
-			}
-			return null;
-		}
-
-		DebugFilterContinuationOption(int val, String description) {
-			this.val = val;
-			this.description = description;
-		}
-
-		public final int val;
-		public final String description;
-	}
-
-	boolean getInterrupt();
-
-	int getInterruptTimeout();
-
-	void setInterruptTimeout(int seconds);
-
-	void print(BitmaskSet<DebugOutputLevel> levels, String message);
-
-	/**
-	 * A shortcut for {@link #print(BitmaskSet, String)} that includes a newline.
-	 * 
-	 * @param levels the log levels for the message
-	 * @param message the message
-	 */
-	void println(BitmaskSet<DebugOutputLevel> levels, String message);
-
-	/**
-	 * A shortcut for {@link #print(BitmaskSet, String)} that applies to a single level.
-	 * 
-	 * @param level the log level for the message
-	 * @param message the message
-	 */
-	default void print(DebugOutputLevel level, String message) {
-		print(BitmaskSet.of(level), message);
-	}
-
-	/**
-	 * A shortcut for {@link #print(BitmaskSet, String)} that includes a newline and applies to a
-	 * single level.
-	 * 
-	 * @param level the log level for the message
-	 * @param message the message
-	 */
-	default void println(DebugOutputLevel level, String message) {
-		println(BitmaskSet.of(level), message);
-	}
-
-	/**
-	 * A shortcut for {@link #print(BitmaskSet, String)} at normal level.
-	 * 
-	 * @param message the message
-	 */
-	default void out(String message) {
-		print(DebugOutputLevel.NORMAL, message);
-	}
-
-	/**
-	 * A shortcut for {@link #println(BitmaskSet, String)} at normal level.
-	 * 
-	 * @param message the message
-	 */
-	default void outln(String message) {
-		println(DebugOutputLevel.NORMAL, message);
-	}
-
-	/**
-	 * A shortcut for {@link #print(BitmaskSet, String)} at warning level.
-	 * 
-	 * @param message the message
-	 */
-	default void warn(String message) {
-		print(DebugOutputLevel.WARNING, message);
-	}
-
-	/**
-	 * A shortcut for {@link #println(BitmaskSet, String)} at warning level.
-	 * 
-	 * @param message the message
-	 */
-	default void warnln(String message) {
-		println(DebugOutputLevel.WARNING, message);
-	}
-
-	/**
-	 * A shortcut for {@link #print(BitmaskSet, String)} at error level.
-	 * 
-	 * @param message the message
-	 */
-	default void err(String message) {
-		print(DebugOutputLevel.ERROR, message);
-	}
-
-	/**
-	 * A shortcut for {@link #println(BitmaskSet, String)} at error level.
-	 * 
-	 * @param message the message
-	 */
-	default void errln(String message) {
-		println(DebugOutputLevel.ERROR, message);
-	}
-
-	/**
-	 * A shortcut for {@link #print(BitmaskSet, String)} at verbose level.
-	 * 
-	 * @param message the message
-	 */
-	default void verb(String message) {
-		print(DebugOutputLevel.VERBOSE, message);
-	}
-
-	/**
-	 * A shortcut for {@link #println(BitmaskSet, String)} at verbose level.
-	 * 
-	 * @param message the message
-	 */
-	default void verbln(String message) {
-		println(DebugOutputLevel.VERBOSE, message);
-	}
-
-	<T extends DebugValue> T evaluate(Class<T> desiredType, String expression);
-
-	void execute(BitmaskSet<DebugOutputControl> ctl, String str, BitmaskSet<DebugExecute> flags);
-
-	/**
-	 * A shortcut for {@link #execute(BitmaskSet, String, BitmaskSet)} outputting to all clients
-	 * with the default execution flag.
-	 * 
-	 * @param str the command string
-	 */
-	default void execute(String str) {
-		execute(SET_ALL_CLIENTS, str, SET_DEFAULT);
-	}
-
-	void prompt(BitmaskSet<DebugOutputControl> ctl, String message);
-
-	String getPromptText();
-
-	void returnInput(String input);
-
-	DebugStatus getExecutionStatus();
-
-	void setExecutionStatus(DebugStatus status);
-
-	int getNumberBreakpoints();
-
-	DebugBreakpoint getBreakpointByIndex(int index);
-
-	/**
-	 * Shortcut to retrieve all breakpoints for the current process.
-	 * 
-	 * <p>
-	 * Uses {@link #getNumberBreakpoints()} and {@link #getBreakpointByIndex(int)} to enumerate all
-	 * breakpoints for the current process.
-	 * 
-	 * @return the list of retrieved breakpoints.
-	 */
-	default List<DebugBreakpoint> getBreakpoints() {
-		int count = getNumberBreakpoints();
-		List<DebugBreakpoint> result = new ArrayList<>(count);
-		for (int i = 0; i < count; i++) {
-			try {
-				result.add(getBreakpointByIndex(i));
-			}
-			catch (COMException e) {
-				if (!COMUtilsExtra.isE_NOINTERFACE(e)) {
-					throw e;
-				}
-				Msg.trace(this, "Discarding private breakpoint at index " + i);
-			}
-		}
-		return result;
-	}
-
-	/**
-	 * Get a breakpoint by ID
-	 * 
-	 * According to the MSDN, though the IDs may be global, this method should only succeed for
-	 * breakpoints belonging to the current process.
-	 * 
-	 * @param id
-	 * @return
-	 */
-	DebugBreakpoint getBreakpointById(int id);
-
-	/**
-	 * Add a (resolved) breakpoint with the given type and desired id
-	 * 
-	 * <p>
-	 * This is equivalent, in part, to the {@code bp} command.
-	 * 
-	 * @param type the type
-	 * @param desiredId the desired id
-	 * @return the breakpoint, disabled at offset 0
-	 */
-	DebugBreakpoint addBreakpoint(BreakType type, int desiredId);
-
-	/**
-	 * Add a (resolved) breakpoint with the given type and any id
-	 * 
-	 * <p>
-	 * This is equivalent, in part, to the {@code bp} command.
-	 * 
-	 * @param type the type
-	 * @return the breakpoint, disable at offset 0
-	 */
-	DebugBreakpoint addBreakpoint(BreakType type);
-
-	/**
-	 * Add an unresolved breakpoint with the given type and desired id
-	 * 
-	 * <p>
-	 * This is equivalent, in part, to the {@code bu} command. See the MSDN for a comparison of
-	 * {@code bu} and {@code bp}.
-	 * 
-	 * @param type the type
-	 * @param desiredId the desired id
-	 * @return the breakpoint, disabled at offset 0
-	 */
-	DebugBreakpoint addBreakpoint2(BreakType type, int desiredId);
-
-	/**
-	 * Add an unresolved breakpoint with the given type and any id
-	 * 
-	 * <p>
-	 * This is equivalent, in part, to the {@code bu} command. See the MSDN for a comparison of
-	 * {@code bu} and {@code bp}.
-	 * 
-	 * @param desiredId the desired id
-	 * @return the breakpoint, disabled at offset 0
-	 */
-	DebugBreakpoint addBreakpoint2(BreakType type);
-
-	void waitForEvent(int timeout);
-
-	DebugEventInformation getLastEventInformation();
-
-	DebugStackInformation getStackTrace(long frameOffset, long stackOffset, long instructionOffset);
-
-	/**
-	 * Shortcut for {@link #waitForEvent(int)} with infinite timeout.
-	 */
-	default void waitForEvent() {
-		waitForEvent(WinBase.INFINITE);
-	}
-
-	int getActualProcessorType();
-
-	int getEffectiveProcessorType();
-
-	int getExecutingProcessorType();
-
-	int getDebuggeeType();
-
-	DebugFilterInformation getNumberEventFilters();
-
-	String getEventFilterText(int index, int size);
-
-	String getEventFilterCommand(int index, int size);
-
-	void setEventFilterCommand(int index, String text);
-
-	DebugSpecificFilterInformation getSpecificFilterParameters(int start, int count);
-
-	void setSpecificFilterParameters(int start, int count, DebugSpecificFilterInformation info);
-
-	String getSpecificFilterArgument(int index, int size);
-
-	void setSpecificFilterArgument(int index, String arg);
-
-	DebugExceptionFilterInformation getExceptionFilterParameters(int start, int[] codes, int count);
-
-	void setExceptionFilterParameters(int count, DebugExceptionFilterInformation info);
-
-	String getExceptionFilterSecondCommand(int index, int size);
-
-	void setExceptionFilterSecondCommand(int index, String cmd);
-
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/DebugControlReentrant.java

@@ -1,27 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng;
-
-import agent.dbgeng.dbgeng.DebugControl.DebugInterrupt;
-
-/**
- * An interface containing the subset of {@link DebugControl} methods which are reentrant.
- * 
- * All other methods should be called only by the thread which created the client.
- */
-public interface DebugControlReentrant {
-	void setInterrupt(DebugInterrupt interrupt);
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/DebugDataSpaces.java

@@ -1,290 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng;
-
-import java.nio.ByteBuffer;
-import java.util.*;
-
-import com.sun.jna.platform.win32.COM.COMException;
-
-import ghidra.comm.util.BitmaskSet;
-import ghidra.comm.util.BitmaskUniverse;
-import ghidra.util.Msg;
-
-/**
- * A wrapper for {@code IDebugDataSpaces} and its newer variants.
- */
-public interface DebugDataSpaces {
-	public enum PageState {
-		COMMIT(0x1000), FREE(0x10000), RESERVE(0x2000);
-
-		private final int val;
-
-		private PageState(int val) {
-			this.val = val;
-		}
-
-		public static PageState byValue(int val) {
-			for (PageState state : values()) {
-				if (state.val == val) {
-					return state;
-				}
-			}
-			Msg.warn(PageState.class, "No such value: 0x" + Integer.toHexString(val));
-			return null;
-		}
-	}
-
-	public enum PageProtection implements BitmaskUniverse {
-		NOACCESS(1 << 0, false, false, false), //
-		READONLY(1 << 1, true, false, false), //
-		READWRITE(1 << 2, true, true, false), //
-		WRITE_COPY(1 << 3, true, true, false), // Becomes READWRITE after copy
-		EXECUTE(1 << 4, false, false, true), //
-		EXECUTE_READ(1 << 5, true, false, true), //
-		EXECUTE_READWRITE(1 << 6, true, true, true), //
-		EXECUTE_WRITECOPY(1 << 7, true, true, true), //
-		//
-		GUARD(1 << 8, false, false, false), //
-		NOCACHE(1 << 9, false, false, false), //
-		WRITECOMBINE(1 << 10, false, false, false), //
-		;
-
-		private PageProtection(int mask, boolean isRead, boolean isWrite, boolean isExecute) {
-			this.mask = mask;
-			this.isRead = isRead;
-			this.isWrite = isWrite;
-			this.isExecute = isExecute;
-		}
-
-		final int mask;
-		final boolean isRead;
-		final boolean isWrite;
-		final boolean isExecute;
-
-		@Override
-		public long getMask() {
-			return mask;
-		}
-
-		public boolean isRead() {
-			return isRead;
-		}
-
-		public boolean isWrite() {
-			return isWrite;
-		}
-
-		public boolean isExecute() {
-			return isExecute;
-		}
-	}
-
-	public enum PageType {
-		NONE(0), //
-		IMAGE(0x1000000), //
-		MAPPED(0x40000), //
-		PRIVATE(0x20000), //
-		;
-
-		private final int val;
-
-		private PageType(int val) {
-			this.val = val;
-		}
-
-		public static PageType byValue(int val) {
-			for (PageType type : values()) {
-				if (type.val == val) {
-					return type;
-				}
-			}
-			Msg.warn(PageType.class, "No such value: 0x" + Integer.toHexString(val));
-			return null;
-		}
-	}
-
-	public static class DebugMemoryBasicInformation {
-		public final long baseAddress;
-		public final long allocationBase;
-		public final Set<PageProtection> allocationProtect;
-		public final long regionSize;
-		public final PageState state;
-		public final Set<PageProtection> protect;
-		public final PageType type;
-
-		public DebugMemoryBasicInformation(long baseAddress, long allocationBase,
-				BitmaskSet<PageProtection> allocationProtect, long regionSize, PageState state,
-				BitmaskSet<PageProtection> protect, PageType type) {
-			this.baseAddress = baseAddress;
-			this.allocationBase = allocationBase;
-			this.allocationProtect = Collections.unmodifiableSet(allocationProtect);
-			this.regionSize = regionSize;
-			this.state = state;
-			this.protect = Collections.unmodifiableSet(protect);
-			this.type = type;
-		}
-
-		@Override
-		public String toString() {
-			return "<DebugMemoryBasicInformation:\n" + //
-				"    baseAddress=" + Long.toHexString(baseAddress) + "h,\n" + //
-				"    allocationBase=" + Long.toHexString(allocationBase) + "h,\n" + //
-				"    allocationProtect=" + allocationProtect + ",\n" + //
-				"    regionSize=" + Long.toHexString(regionSize) + "h,\n" + //
-				"    state=" + state + ",\n" + //
-				"    protect=" + protect + ",\n" + //
-				"    type=" + type + "\n" + //
-				">";
-		}
-
-		@Override
-		public int hashCode() {
-			return Objects.hash(baseAddress, allocationBase, allocationProtect, regionSize, state,
-				protect, type);
-		}
-
-		@Override
-		public boolean equals(Object obj) {
-			if (!(obj instanceof DebugMemoryBasicInformation)) {
-				return false;
-			}
-			DebugMemoryBasicInformation that = (DebugMemoryBasicInformation) obj;
-			if (this.baseAddress != that.baseAddress) {
-				return false;
-			}
-			if (this.allocationBase != that.allocationBase) {
-				return false;
-			}
-			if (!this.allocationProtect.equals(that.allocationProtect)) {
-				return false;
-			}
-			if (this.regionSize != that.regionSize) {
-				return false;
-			}
-			if (this.state != that.state) {
-				return false;
-			}
-			if (!this.protect.equals(that.protect)) {
-				return false;
-			}
-			if (this.type != that.type) {
-				return false;
-			}
-			return true;
-		}
-	}
-
-	int readVirtual(long offset, ByteBuffer into, int len);
-
-	int writeVirtual(long offset, ByteBuffer from, int len);
-
-	int readVirtualUncached(long offset, ByteBuffer into, int len);
-
-	int writeVirtualUncached(long offset, ByteBuffer from, int len);
-
-	int readPhysical(long offset, ByteBuffer into, int len);
-
-	int writePhysical(long offset, ByteBuffer from, int len);
-
-	int readControl(int processor, long offset, ByteBuffer into, int len);
-
-	int writeControl(int processor, long offset, ByteBuffer from, int len);
-
-	int readBusData(int busDataType, int busNumber, int slotNumber, long offset, ByteBuffer into,
-			int len);
-
-	int writeBusData(int busDataType, int busNumber, int slotNumber, long offset, ByteBuffer from,
-			int len);
-
-	int readIo(int interfaceType, int busNumber, int addressSpace, long offset, ByteBuffer into,
-			int len);
-
-	int writeIo(int interfaceType, int busNumber, int addressSpace, long offset, ByteBuffer from,
-			int len);
-
-	long readMsr(int msr);
-
-	void writeMsr(int msr, long value);
-
-	int readDebuggerData(int offset, ByteBuffer into, int len);
-
-	DebugMemoryBasicInformation queryVirtual(long offset);
-
-	long virtualToPhysical(long offset);
-
-	/**
-	 * A shortcut for iterating over virtual memory regions.
-	 * 
-	 * This operates by calling {@link #queryVirtual(long)} to get each next entry, starting at an
-	 * offset of -start-, adding the size of the returned region to determine the offset for the
-	 * next call.
-	 * 
-	 * @param start the starting offset
-	 * @return an iterator over virtual memory regions after the given start
-	 */
-	default Iterable<DebugMemoryBasicInformation> iterateVirtual(long start) {
-		return new Iterable<DebugMemoryBasicInformation>() {
-			@Override
-			public Iterator<DebugMemoryBasicInformation> iterator() {
-				return new Iterator<DebugMemoryBasicInformation>() {
-					private long last = start;
-					private long offset = start;
-					private DebugMemoryBasicInformation next = doGetNext();
-
-					private DebugMemoryBasicInformation getNext() {
-						if (Long.compareUnsigned(last, offset) < 0) {
-							return doGetNext();
-						}
-						return null;
-					}
-
-					private DebugMemoryBasicInformation doGetNext() {
-						try {
-							DebugMemoryBasicInformation info = queryVirtual(offset);
-							last = offset;
-							if (info != null) {
-								offset += info.regionSize;
-							}
-							return info;
-						}
-						catch (COMException e) {
-							if (!COMUtilsExtra.isE_NOINTERFACE(e)) {
-								throw e;
-							}
-							return null;
-						}
-					}
-
-					@Override
-					public boolean hasNext() {
-						return next != null;
-					}
-
-					@Override
-					public DebugMemoryBasicInformation next() {
-						DebugMemoryBasicInformation ret = next;
-						next = getNext();
-						if (ret.equals(next)) {
-							next = null;
-						}
-						return ret;
-					}
-				};
-			}
-		};
-	}
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/DebugEventCallbacks.java

@@ -1,116 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng;
-
-import java.lang.annotation.*;
-
-import agent.dbgeng.dbgeng.DebugClient.*;
-import ghidra.comm.util.BitmaskSet;
-import ghidra.comm.util.BitmaskUniverse;
-
-/**
- * The interface for receiving event callbacks via {@code IDebugEventCallbacks} or a newer variant.
- * 
- * Note: The wrapper implementation will select the appropriate native interface version.
- * 
- * Note: Even though {@link #changeDebuggeeState(BitmaskSet, long)},
- * {@link #changeEngineState(BitmaskSet, long)} and {@link #changeSymbolState(BitmaskSet, long)}
- * purport to return a {@link DebugStatus}, the returned value is ignored by {@code dbgeng.dll}.
- */
-public interface DebugEventCallbacks {
-	public static enum DebugEvent implements BitmaskUniverse {
-		BREAKPOINT(1 << 0), //
-		EXCEPTION(1 << 1), //
-		CREATE_THREAD(1 << 2), //
-		EXIT_THREAD(1 << 3), //
-		CREATE_PROCESS(1 << 4), //
-		EXIT_PROCESS(1 << 5), //
-		LOAD_MODULE(1 << 6), //
-		UNLOAD_MODULE(1 << 7), //
-		SYSTEM_ERROR(1 << 8), //
-		SESSION_STATUS(1 << 9), //
-		CHANGE_DEBUGEE_STATE(1 << 10), //
-		CHANGE_ENGINE_STATE(1 << 11), //
-		CHANGE_SYMBOL_STATE(1 << 12), //
-		;
-
-		private DebugEvent(int mask) {
-			this.mask = mask;
-		}
-
-		private final int mask;
-
-		@Override
-		public long getMask() {
-			return mask;
-		}
-	}
-
-	/**
-	 * An annotation for marking each callback with its interest flag.
-	 */
-	@Target(ElementType.METHOD)
-	@Retention(RetentionPolicy.RUNTIME)
-	static @interface ForInterest {
-		/**
-		 * The flag corresponding to the annotated callback method
-		 * 
-		 * @return the flag
-		 */
-		DebugEvent value();
-	}
-
-	BitmaskSet<DebugEvent> getInterestMask();
-
-	@ForInterest(DebugEvent.BREAKPOINT)
-	DebugStatus breakpoint(DebugBreakpoint bp);
-
-	@ForInterest(DebugEvent.EXCEPTION)
-	DebugStatus exception(DebugExceptionRecord64 exception, boolean firstChance);
-
-	@ForInterest(DebugEvent.CREATE_THREAD)
-	DebugStatus createThread(DebugThreadInfo debugThreadInfo);
-
-	@ForInterest(DebugEvent.EXIT_THREAD)
-	DebugStatus exitThread(int exitCode);
-
-	@ForInterest(DebugEvent.CREATE_PROCESS)
-	DebugStatus createProcess(DebugProcessInfo debugProcessInfo);
-
-	@ForInterest(DebugEvent.EXIT_PROCESS)
-	DebugStatus exitProcess(int exitCode);
-
-	@ForInterest(DebugEvent.LOAD_MODULE)
-	DebugStatus loadModule(DebugModuleInfo debugModuleInfo);
-
-	@ForInterest(DebugEvent.UNLOAD_MODULE)
-	DebugStatus unloadModule(String imageBaseName, long baseOffset);
-
-	@ForInterest(DebugEvent.SYSTEM_ERROR)
-	DebugStatus systemError(int error, int level);
-
-	@ForInterest(DebugEvent.SESSION_STATUS)
-	DebugStatus sessionStatus(SessionStatus status);
-
-	@ForInterest(DebugEvent.CHANGE_DEBUGEE_STATE)
-	DebugStatus changeDebuggeeState(BitmaskSet<ChangeDebuggeeState> flags, long argument);
-
-	@ForInterest(DebugEvent.CHANGE_ENGINE_STATE)
-	DebugStatus changeEngineState(BitmaskSet<ChangeEngineState> flags, long argument);
-
-	@ForInterest(DebugEvent.CHANGE_SYMBOL_STATE)
-	DebugStatus changeSymbolState(BitmaskSet<ChangeSymbolState> flags, long argument);
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/DebugEventInformation.java

@@ -1,70 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng;
-
-import agent.dbgeng.jna.dbgeng.WinNTExtra;
-
-public class DebugEventInformation {
-
-	private int type;
-	private DebugProcessId pid;
-	private DebugThreadId tid;
-	private DebugSessionId sid;
-	private int executingProcessorType = WinNTExtra.Machine.IMAGE_FILE_MACHINE_AMD64.val;
-
-	public DebugEventInformation(int type, int pid, int tid) {
-		this.type = type;
-		this.pid = new DebugProcessRecord(pid);
-		this.tid = new DebugThreadRecord(tid);
-	}
-
-	public int getType() {
-		return type;
-	}
-
-	public DebugSessionId getSessionId() {
-		return sid;
-	}
-
-	public DebugProcessId getProcessId() {
-		return pid;
-	}
-
-	public DebugThreadId getThreadId() {
-		return tid;
-	}
-
-	public void setThread(DebugThreadId tid) {
-		this.tid = tid;
-	}
-
-	public void setProcess(DebugProcessId pid) {
-		this.pid = pid;
-	}
-
-	public void setSession(DebugSessionId sid) {
-		this.sid = sid;
-	}
-
-	public int getExecutingProcessorType() {
-		return executingProcessorType;
-	}
-
-	public void setExecutingProcessorType(int execType) {
-		this.executingProcessorType = execType;
-	}
-
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/DebugExceptionFilterInformation.java

@@ -1,42 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng;
-
-import agent.dbgeng.jna.dbgeng.DbgEngNative.DEBUG_EXCEPTION_FILTER_PARAMETERS;
-
-public class DebugExceptionFilterInformation {
-
-	private int nParams;
-	private DEBUG_EXCEPTION_FILTER_PARAMETERS[] parameters;
-
-	public DebugExceptionFilterInformation(int nParams,
-			DEBUG_EXCEPTION_FILTER_PARAMETERS[] parameters) {
-		this.nParams = nParams;
-		this.parameters = parameters;
-	}
-
-	public int getNumberOfParameters() {
-		return nParams;
-	}
-
-	public DEBUG_EXCEPTION_FILTER_PARAMETERS getParameter(int paramNumber) {
-		return parameters[paramNumber];
-	}
-
-	public DEBUG_EXCEPTION_FILTER_PARAMETERS[] getParameters() {
-		return parameters;
-	}
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/DebugExceptionRecord64.java

@@ -1,41 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng;
-
-import java.util.Collections;
-import java.util.List;
-
-/**
- * Data copied from a {@code EXCEPTION_RECORD64} as defined in {@code winnt.h}.
- * 
- * TODO: Some enums, flags, etc., to help interpret some of the fields.
- */
-public class DebugExceptionRecord64 {
-	public final int code; // TODO: How to interpret
-	public final int flags; // TODO: How to interpret
-	public final long record; // TODO: How to interpret
-	public final long address;
-	public final List<Long> information;
-
-	public DebugExceptionRecord64(int code, int flags, long record, long address,
-			List<Long> information) {
-		this.code = code;
-		this.flags = flags;
-		this.record = record;
-		this.address = address;
-		this.information = Collections.unmodifiableList(information);
-	}
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/DebugFilterInformation.java

@@ -1,42 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng;
-
-public class DebugFilterInformation {
-
-	private int nEvents;
-	private int nSpecificExceptions;
-	private int nArbitraryExceptions;
-
-	public DebugFilterInformation(int nEvents, int nSpecificExceptions, int nArbitraryExceptions) {
-		this.nEvents = nEvents;
-		this.nSpecificExceptions = nSpecificExceptions;
-		this.nArbitraryExceptions = nArbitraryExceptions;
-	}
-
-	public int getNumberEvents() {
-		return nEvents;
-	}
-
-	public int getNumberSpecificExceptions() {
-		return nSpecificExceptions;
-	}
-
-	public int getNumberArbitraryExceptions() {
-		return nArbitraryExceptions;
-	}
-
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/DebugInputCallbacks.java

@@ -1,31 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng;
-
-/**
- * The interface for receiving input callbacks via {@code IDebugInputCallbacks} or a newer variant.
- * 
- * Note: The wrapper implementation will select the appropriate native interface version.
- */
-@FunctionalInterface
-public interface DebugInputCallbacks {
-
-	public void startInput(long bufferSize);
-
-	default void endInput() {
-		// Optional implementation
-	}
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/DebugModule.java

@@ -1,47 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng;
-
-/**
- * Handle to a module (program or library image).
- */
-public interface DebugModule {
-	public enum DebugModuleName {
-		IMAGE, MODULE, LOADED_IMAGE, SYMBOL_FILE, MAPPED_IMAGE;
-	}
-
-	/**
-	 * Get a name for the module.
-	 * 
-	 * @param which identifies which name
-	 * @return the requested name, if available
-	 */
-	String getName(DebugModuleName which);
-
-	/**
-	 * Get the index assigned to this module.
-	 * 
-	 * @return the index
-	 */
-	int getIndex();
-
-	/**
-	 * Get the base address where this module is loaded, if applicable.
-	 * 
-	 * @return the base address
-	 */
-	long getBase();
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/DebugModuleInfo.java

@@ -1,64 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng;
-
-/**
- * Information about a module (program or library image).
- * 
- * The fields correspond to the parameters taken by {@code LoadModule} of
- * {@code IDebugEventCallbacks}. They also appear as a subset of parameters taken by
- * {@code CreateProcess} of {@code IDebugEventCallbacks}.
- */
-public class DebugModuleInfo {
-	public final long imageFileHandle;
-	public final long baseOffset;
-	public final int moduleSize;
-	public final int checkSum;
-	public final int timeDateStamp;
-	private String moduleName;
-	private String imageName;
-
-	public DebugModuleInfo(long imageFileHandle, long baseOffset, int moduleSize, String moduleName,
-			String imageName, int checkSum, int timeDateStamp) {
-		this.imageFileHandle = imageFileHandle;
-		this.baseOffset = baseOffset;
-		this.moduleSize = moduleSize;
-		this.setModuleName(moduleName);
-		this.setImageName(imageName);
-		this.checkSum = checkSum;
-		this.timeDateStamp = timeDateStamp; // TODO: Convert to DateTime?
-	}
-
-	public String toString() {
-		return Long.toHexString(baseOffset);
-	}
-
-	public String getModuleName() {
-		return moduleName;
-	}
-
-	public void setModuleName(String moduleName) {
-		this.moduleName = moduleName;
-	}
-
-	public String getImageName() {
-		return imageName;
-	}
-
-	public void setImageName(String imageName) {
-		this.imageName = imageName;
-	}
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/DebugOutputCallbacks.java

@@ -1,32 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng;
-
-import agent.dbgeng.dbgeng.DebugControl.DebugOutputLevel;
-
-/**
- * The interface for receiving output callbacks via {@code IDebugOutputCallbacks} or a newer
- * variant.
- * 
- * Note: The wrapper implementation will select the apprirate native interface version.
- * 
- * TODO: Change {@link #output(int, String)} {@code mask} parameter to use {@link DebugOutputLevel}
- * flags.
- */
-@FunctionalInterface
-public interface DebugOutputCallbacks {
-	void output(int mask, String text);
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/DebugProcessId.java

@@ -1,38 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng;
-
-/**
- * The <em>engine</em> ID assigned to a debugged process.
- * 
- * Note: This is not the same as the "PID." {@code dbgeng.dll} calls that the <em>system</em> ID of
- * the process.
- * 
- * This is essentially just a boxed integer, but having an explicit data type prevents confusion
- * with other integral values. In particular, this prevents confusion of engine PIDs with system
- * PIDs.
- */
-public interface DebugProcessId extends Comparable<DebugProcessId> {
-
-	public String id();
-	public long value();
-	public boolean isSystem();
-	
-	@Override
-	public default int compareTo(DebugProcessId that) {
-		return this.id().compareTo(that.id());
-	}
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/DebugProcessInfo.java

@@ -1,36 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng;
-
-/**
- * Information about a process.
- * 
- * The fields correspond to parameters taken by {@code CreateProcess} of
- * {@code IDebugEventCallbacks}. Note that parameters common to other callbacks have been factored
- * into types aggregated here.
- */
-public class DebugProcessInfo {
-	public final long handle;
-	public final DebugModuleInfo moduleInfo;
-	public final DebugThreadInfo initialThreadInfo;
-
-	public DebugProcessInfo(long handle, DebugModuleInfo moduleInfo,
-			DebugThreadInfo initialThreadInfo) {
-		this.handle = handle;
-		this.moduleInfo = moduleInfo;
-		this.initialThreadInfo = initialThreadInfo;
-	}
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/DebugProcessRecord.java

@@ -1,34 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng;
-
-public record DebugProcessRecord(long value) implements DebugProcessId {
-
-	@Override
-	public boolean isSystem() {
-		return false;
-	}
-
-	@Override
-	public String id() {
-		return Long.toHexString(value);
-	}
-
-	@Override
-	public String toString() {
-		return "<dbgeng.dll Engine PID " + Long.toHexString(value) + ">";
-	}
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/DebugRegisters.java

@@ -1,158 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng;
-
-import java.util.*;
-
-import agent.dbgeng.dbgeng.DebugValue.DebugValueType;
-import ghidra.comm.util.BitmaskSet;
-import ghidra.comm.util.BitmaskUniverse;
-
-/**
- * A wrapper for {@code IDebugRegisters} and its newer variants.
- */
-public interface DebugRegisters {
-	public static enum DebugRegisterSource {
-		DEBUG_REGSRC_DEBUGGEE, //
-		DEBUG_REGSRC_EXPLICIT, //
-		DEBUG_REGSRC_FRAME, //
-		;
-	}
-
-	public static enum DebugRegisterFlags implements BitmaskUniverse {
-		SUB_REGISTER(1 << 0), //
-		;
-
-		private DebugRegisterFlags(int mask) {
-			this.mask = mask;
-		}
-
-		private final int mask;
-
-		@Override
-		public long getMask() {
-			return mask;
-		}
-	}
-
-	public static class DebugRegisterDescription {
-		public final String name;
-		public final int index;
-		public final DebugValueType type;
-		public final Set<DebugRegisterFlags> flags;
-		public final int subregMaster;
-		public final int subregLengthBits;
-		public final long subregMask;
-		public final int subregShift;
-
-		public DebugRegisterDescription(String name, int index, DebugValueType type,
-				BitmaskSet<DebugRegisterFlags> flags, int subregMaster, int subregLengthBits,
-				long subregMask, int subregShift) {
-			this.name = name;
-			this.index = index;
-			this.type = type;
-			this.flags = Collections.unmodifiableSet(flags);
-			this.subregMaster = subregMaster;
-			this.subregLengthBits = subregLengthBits;
-			this.subregMask = subregMask;
-			this.subregShift = subregShift;
-		}
-
-		@Override
-		public String toString() {
-			return String.format(
-				"<%s: name='%s' index=%d type=%s flags=%s subregMaster=%d subregLengthBits=%d" +
-					" subregMask=%x subregShift=%d>",
-				getClass().getSimpleName(), name, index, type, flags, subregMaster,
-				subregLengthBits, subregMask, subregShift);
-		}
-	}
-
-	int getNumberRegisters();
-
-	DebugRegisterDescription getDescription(int registerNumber);
-
-	/**
-	 * A shortcut to get all register descriptions for the current process.
-	 * 
-	 * Uses {@link #getNumberRegisters()} and {@link #getDescription(int)} to retrieve all
-	 * descriptions for the current process.
-	 * 
-	 * @return the list of register descriptions
-	 */
-	default Set<DebugRegisterDescription> getAllDescriptions() {
-		Set<DebugRegisterDescription> result = new LinkedHashSet<>();
-		int count = getNumberRegisters();
-		for (int i = 0; i < count; i++) {
-			result.add(getDescription(i));
-		}
-		return result;
-	}
-
-	int getIndexByName(String name);
-
-	/**
-	 * A shortcut to get many register indices in one call.
-	 * 
-	 * Uses {@link #getIndexByName(String)}.
-	 * 
-	 * @param names the names whose indices to get
-	 * @return the indices in respective order to the given names
-	 */
-	default int[] getIndicesByNames(String... names) {
-		int[] indices = new int[names.length];
-		for (int i = 0; i < names.length; i++) {
-			indices[i] = getIndexByName(names[i]);
-		}
-		return indices;
-	}
-
-	DebugValue getValue(int index);
-
-	Map<Integer, DebugValue> getValues(DebugRegisterSource source, Collection<Integer> indices);
-
-	/**
-	 * A shortcut to get a register value by name.
-	 * 
-	 * Uses {@link #getIndexByName(String)} followed by {@link #getValue(int)}.
-	 * 
-	 * @param name the name of the register
-	 * @return the value
-	 */
-	default DebugValue getValueByName(String name) {
-		int indexByName = getIndexByName(name);
-		if (indexByName >= 0) {
-			return getValue(indexByName);
-		}
-		return null;
-	}
-
-	void setValue(int index, DebugValue value);
-
-	void setValues(DebugRegisterSource source, Map<Integer, DebugValue> values);
-
-	/**
-	 * A shortcut to set a register value by name.
-	 * 
-	 * Uses {@link #getIndexByName(String)} followed by {@link #setValue(int, DebugValue)}.
-	 * 
-	 * @param name the name of the register
-	 * @param value the desired value
-	 */
-	default void setValueByName(String name, DebugValue value) {
-		setValue(getIndexByName(name), value);
-	}
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/DebugRunningProcess.java

@@ -1,123 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng;
-
-import agent.dbgeng.dbgeng.DebugRunningProcess.Description.ProcessDescriptionFlags;
-import ghidra.comm.util.BitmaskUniverse;
-
-/**
- * Information about a running process, not necessarily a debugged process.
- */
-public interface DebugRunningProcess {
-	/**
-	 * Description of a running process
-	 */
-	public static class Description {
-		public static enum ProcessDescriptionFlags implements BitmaskUniverse {
-			NO_PATHS(1 << 0), //
-			NO_SERVICES(1 << 1), //
-			NO_MTS_PACKAGES(1 << 2), //
-			NO_COMMAND_LINE(1 << 3), //
-			NO_SESSION_ID(1 << 4), //
-			NO_USER_NAME(1 << 5), //
-			;
-
-			ProcessDescriptionFlags(int mask) {
-				this.mask = mask;
-			}
-
-			private final int mask;
-
-			@Override
-			public long getMask() {
-				return mask;
-			}
-		}
-
-		public Description(int systemId, String exeName, String description) {
-			this.systemId = systemId;
-			this.exeName = exeName;
-			this.description = description;
-		}
-
-		private final int systemId;
-		private final String exeName;
-		private final String description;
-
-		/**
-		 * The system ID (PID) for the process.
-		 * 
-		 * @return the PID
-		 */
-		public int getSystemId() {
-			return systemId;
-		}
-
-		/**
-		 * The name of the executable defining the process
-		 * 
-		 * @return the name
-		 */
-		public String getExecutableName() {
-			return exeName;
-		}
-
-		/**
-		 * A textual description of the process.
-		 * 
-		 * @return the description
-		 */
-		public String getDescription() {
-			return description;
-		}
-
-		@Override
-		public String toString() {
-			return String.format("PID:%d, EXE:%s, Description:%s", systemId, exeName, description);
-		}
-	}
-
-	/**
-	 * The system ID (PID) for the process.
-	 * 
-	 * @return the PID
-	 */
-	int getSystemId();
-
-	/**
-	 * Get the "full" description of the process.
-	 * 
-	 * @param flags indicate which information to include in the description
-	 * @return the description
-	 */
-	Description getFullDescription(ProcessDescriptionFlags... flags);
-
-	/**
-	 * The name of the executable defining the process.
-	 * 
-	 * @param flags indicate which information to include in the description
-	 * @return the name
-	 */
-	String getExecutableName(ProcessDescriptionFlags... flags);
-
-	/**
-	 * A textual description of the process.
-	 * 
-	 * @param flags indicate which information to include in the description
-	 * @return the description
-	 */
-	String getDescription(ProcessDescriptionFlags... flags);
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/DebugServerId.java

@@ -1,58 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng;
-
-/**
- * The ID of a debug server.
- * 
- * Each server to which a client is connected is assigned a server ID. The local server, to which
- * every client is connected by default, has the ID 0. This is essentially just a boxed integer, but
- * having an explicit data type prevents confusion with other integral values.
- */
-public class DebugServerId implements Comparable<DebugServerId> {
-	public final long id;
-
-	public DebugServerId(long id) {
-		this.id = id;
-	}
-
-	@Override
-	public int hashCode() {
-		return Long.hashCode(id);
-	}
-
-	@Override
-	public boolean equals(Object obj) {
-		if (!(obj instanceof DebugServerId)) {
-			return false;
-		}
-		DebugServerId that = (DebugServerId) obj;
-		if (this.id != that.id) {
-			return false;
-		}
-		return true;
-	}
-
-	@Override
-	public int compareTo(DebugServerId that) {
-		return Long.compare(this.id, that.id);
-	}
-
-	@Override
-	public String toString() {
-		return "<dbgeng.dll Server ID " + id + ">";
-	}
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/DebugSessionId.java

@@ -1,38 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng;
-
-/**
- * The <em>engine</em> ID assigned to a debugged process.
- * 
- * Note: This is not the same as the "PID." {@code dbgeng.dll} calls that the <em>system</em> ID of
- * the process.
- * 
- * This is essentially just a boxed integer, but having an explicit data type prevents confusion
- * with other integral values. In particular, this prevents confusion of engine PIDs with system
- * PIDs.
- */
-public interface DebugSessionId extends Comparable<DebugSessionId> {
-
-	public String id();
-	public long value();
-	public boolean isSystem();
-	
-	@Override
-	public default int compareTo(DebugSessionId that) {
-		return this.id().compareTo(that.id());
-	}
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/DebugSessionRecord.java

@@ -1,34 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng;
-
-public record DebugSessionRecord(long value) implements DebugSessionId {
-
-	@Override
-	public boolean isSystem() {
-		return false;
-	}
-
-	@Override
-	public String id() {
-		return Long.toHexString(value);
-	}
-
-	@Override
-	public String toString() {
-		return "<dbgeng.dll Engine SYSID " + Long.toHexString(value) + ">";
-	}
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/DebugSpecificFilterInformation.java

@@ -1,42 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng;
-
-import agent.dbgeng.jna.dbgeng.DbgEngNative.DEBUG_SPECIFIC_FILTER_PARAMETERS;
-
-public class DebugSpecificFilterInformation {
-
-	private int nParams;
-	private DEBUG_SPECIFIC_FILTER_PARAMETERS[] parameters;
-
-	public DebugSpecificFilterInformation(int nParams,
-			DEBUG_SPECIFIC_FILTER_PARAMETERS[] parameters) {
-		this.nParams = nParams;
-		this.parameters = parameters;
-	}
-
-	public int getNumberOfParameters() {
-		return nParams;
-	}
-
-	public DEBUG_SPECIFIC_FILTER_PARAMETERS getParameter(int paramNumber) {
-		return parameters[paramNumber];
-	}
-
-	public DEBUG_SPECIFIC_FILTER_PARAMETERS[] getParameters() {
-		return parameters;
-	}
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/DebugStackInformation.java

@@ -1,37 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng;
-
-import agent.dbgeng.jna.dbgeng.DbgEngNative.DEBUG_STACK_FRAME;
-
-public class DebugStackInformation {
-
-	private int nFrames;
-	private DEBUG_STACK_FRAME[] stackFrames;
-
-	public DebugStackInformation(int nFrames, DEBUG_STACK_FRAME[] stackFrames) {
-		this.nFrames = nFrames;
-		this.stackFrames = stackFrames;
-	}
-
-	public int getNumberOfFrames() {
-		return nFrames;
-	}
-
-	public DEBUG_STACK_FRAME getFrame(int frameNumber) {
-		return stackFrames[frameNumber];
-	}
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/DebugSymbolEntry.java

@@ -1,56 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng;
-
-/**
- * Data copied from a {@code DEBUG_SYMBOL_ENTRY} as defined in {@code dbgeng.h}.
- * 
- * TODO: Some enums, flags, etc., to help interpret some of the fields.
- */
-public class DebugSymbolEntry {
-	public final long moduleBase;
-	public final long offset;
-	public final long symbolId;
-	public final long size;
-	public final int flags;
-	public final int typeId;
-	public final String name;
-	public final int tag;
-
-	public DebugSymbolEntry(long moduleBase, long offset, long symbolId, long size, int flags,
-			int typeId, String name, int tag) {
-		this.moduleBase = moduleBase;
-		this.offset = offset;
-		this.symbolId = symbolId;
-		this.size = size;
-		this.flags = flags;
-		this.typeId = typeId;
-		this.name = name;
-		this.tag = tag;
-	}
-
-	@Override
-	public String toString() {
-		return String.format("<DebugSymbolEntry %016x:%016x\n" + //
-			"  offset=%016xh,\n" + //
-			"  size=%xh,\n" + //		
-			"  flags=%xh,\n" + //
-			"  typeId=%xh,\n" + //
-			"  name='%s',\n" + //
-			"  tag=%xh>", //
-			moduleBase, symbolId, offset, size, flags, typeId, name, tag);
-	}
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/DebugSymbolId.java

@@ -1,34 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng;
-
-/**
- * Symbol identifier, consisting of module ID and symbol index.
- */
-public class DebugSymbolId {
-	public final long moduleBase;
-	public final long symbolIndex;
-
-	public DebugSymbolId(long moduleBase, long symbolIndex) {
-		this.moduleBase = moduleBase;
-		this.symbolIndex = symbolIndex;
-	}
-
-	@Override
-	public String toString() {
-		return String.format("<DebugSymbolId %016x:%016x>", moduleBase, symbolIndex);
-	}
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/DebugSymbolName.java

@@ -1,34 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng;
-
-/**
- * Symbol name, consisting of textual name and offset.
- */
-public class DebugSymbolName {
-	public final String name;
-	public final long offset;
-
-	public DebugSymbolName(String name, long offset) {
-		this.name = name;
-		this.offset = offset;
-	}
-
-	@Override
-	public String toString() {
-		return String.format("<%016x: %s>", offset, name);
-	}
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/DebugSymbols.java

@@ -1,85 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng;
-
-import java.util.Iterator;
-import java.util.List;
-
-/**
- * A wrapper for {@code IDebugSymbols} and its newer variants.
- */
-public interface DebugSymbols {
-	int getNumberLoadedModules();
-
-	int getNumberUnloadedModules();
-
-	DebugModule getModuleByIndex(int index);
-
-	DebugModule getModuleByModuleName(String name, int startIndex);
-
-	DebugModule getModuleByOffset(long offset, int startIndex);
-
-	DebugModuleInfo getModuleParameters(int count, int startIndex);
-
-	/**
-	 * A shortcut for iterating over all loaded modules, lazily.
-	 * 
-	 * @param startIndex the module index to start at
-	 * @return an iterator over modules starting at the given index
-	 */
-	default Iterable<DebugModule> iterateModules(int startIndex) {
-		int count = getNumberLoadedModules(); // TODO: What about unloaded?
-		return new Iterable<DebugModule>() {
-			@Override
-			public Iterator<DebugModule> iterator() {
-				return new Iterator<DebugModule>() {
-					int cur = startIndex;
-
-					@Override
-					public boolean hasNext() {
-						return cur < count;
-					}
-
-					@Override
-					public DebugModule next() {
-						DebugModule ret = getModuleByIndex(cur);
-						cur++;
-						return ret;
-					}
-				};
-			}
-		};
-	}
-
-	Iterable<DebugSymbolName> iterateSymbolMatches(String pattern);
-
-	List<DebugSymbolId> getSymbolIdsByName(String pattern);
-
-	DebugSymbolEntry getSymbolEntry(DebugSymbolId id);
-
-	String getSymbolPath();
-
-	void setSymbolPath(String path);
-
-	int getSymbolOptions();
-
-	void setSymbolOptions(int options);
-
-	public int getCurrentScopeFrameIndex();
-
-	public void setCurrentScopeFrameIndex(int index);
-
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/DebugSystemObjects.java

@@ -1,116 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng;
-
-import java.util.ArrayList;
-import java.util.List;
-
-/**
- * A wrapper for {@code IDebugSystemObjects} and its newer variants.
- */
-public interface DebugSystemObjects {
-
-	DebugThreadId getEventThread();
-
-	DebugProcessId getEventProcess();
-
-	DebugSessionId getEventSystem();
-
-	DebugThreadId getCurrentThreadId();
-
-	void setCurrentThreadId(DebugThreadId id);
-
-	DebugProcessId getCurrentProcessId();
-
-	void setCurrentProcessId(DebugProcessId id);
-
-	DebugSessionId getCurrentSystemId();
-
-	void setCurrentSystemId(DebugSessionId id);
-
-	int getNumberThreads();
-
-	int getTotalNumberThreads(); // TODO: LargestProcess?
-
-	/**
-	 * Get the threads IDs by index from the current process
-	 * 
-	 * @param start the starting index
-	 * @param count the number of threads
-	 * @return the list of thread IDs
-	 */
-	List<DebugThreadId> getThreads(int start, int count);
-
-	/**
-	 * Get all thread IDs in the current process
-	 * 
-	 * @return the list of thread IDs
-	 */
-	default List<DebugThreadId> getThreads() {
-		return getThreads(0, getNumberThreads());
-	}
-
-	DebugThreadId getThreadIdByHandle(long handle);
-
-	DebugProcessId getProcessIdByHandle(long handle);
-
-	int getNumberSystems();
-
-	List<DebugSessionId> getSystems(int start, int count);
-
-	default List<DebugSessionId> getSessions() {
-		int numberSystems = getNumberSystems();
-		if (numberSystems < 0) {
-			return new ArrayList<DebugSessionId>();
-		}
-		return getSystems(0, numberSystems);
-	}
-
-	int getNumberProcesses();
-
-	List<DebugProcessId> getProcesses(int start, int count);
-
-	default List<DebugProcessId> getProcesses() {
-		int numberProcesses = getNumberProcesses();
-		if (numberProcesses < 0) {
-			return new ArrayList<DebugProcessId>();
-		}
-		return getProcesses(0, numberProcesses);
-	}
-
-	int getCurrentThreadSystemId();
-
-	int getCurrentProcessSystemId();
-
-	DebugThreadId getThreadIdBySystemId(int systemId);
-
-	DebugProcessId getProcessIdBySystemId(int systemId);
-
-	long getCurrentThreadDataOffset();
-
-	long getCurrentProcessDataOffset();
-
-	long getImplicitThreadDataOffset();
-
-	long getImplicitProcessDataOffset();
-
-	void setImplicitThreadDataOffset(long systemOffset);
-
-	void setImplicitProcessDataOffset(long systemOffset);
-	
-	String getCurrentProcessExecutableName();
-
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/DebugSystemProcessRecord.java

@@ -1,34 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng;
-
-public record DebugSystemProcessRecord(long value) implements DebugProcessId {
-
-	@Override
-	public boolean isSystem() {
-		return true;
-	}
-
-	@Override
-	public String id() {
-		return "SYS"+Long.toHexString(value);
-	}
-
-	@Override
-	public String toString() {
-		return "<dbgeng.dll System PID " + Long.toHexString(value) + ">";
-	}
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/DebugSystemSessionRecord.java

@@ -1,34 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng;
-
-public record DebugSystemSessionRecord(long value) implements DebugSessionId {
-
-	@Override
-	public boolean isSystem() {
-		return true;
-	}
-
-	@Override
-	public String id() {
-		return "SYS"+Long.toHexString(value);
-	}
-
-	@Override
-	public String toString() {
-		return "<dbgeng.dll System SYSID " + Long.toHexString(value) + ">";
-	}
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/DebugSystemThreadRecord.java

@@ -1,34 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng;
-
-public record DebugSystemThreadRecord(long value) implements DebugThreadId {
-
-	@Override
-	public boolean isSystem() {
-		return true;
-	}
-
-	@Override
-	public String id() {
-		return "PCR"+Long.toHexString(value);
-	}
-
-	@Override
-	public String toString() {
-		return "<dbgeng.dll System TID " + Long.toHexString(value) + ">";
-	}
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/DebugThreadId.java

@@ -1,39 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng;
-
-/**
- * The <em>engine</em> ID assigned to a debugged thread.
- * 
- * Note: This is not the same as the "TID." {@code dbgeng.dll} calls that the <em>system</em> ID of
- * the thread.
- * 
- * This is essentially just a boxed integer, but having an explicit data type prevents confusion
- * with other integral values. In particular, this prevents confusion of engine TIDs with system
- * TIDs.
- */
-public interface DebugThreadId extends Comparable<DebugThreadId> {
-
-	public String id();
-	public long value();
-	public boolean isSystem();
-	
-	@Override
-	public default int compareTo(DebugThreadId that) {
-		return this.id().compareTo(that.id());
-	}
-
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/DebugThreadInfo.java

@@ -1,43 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng;
-
-/**
- * Information about a thread.
- * 
- * <p>
- * The fields correspond to parameters taken by {@code CreateThread} of
- * {@code IDebugEventCallbacks}. They also appear as a subset of parameters taken by
- * {@code CreateProcess} of {@code IDebugEventCallbacks}.
- */
-public class DebugThreadInfo {
-	public final long handle;
-	public final long dataOffset;
-	public final long startOffset;
-
-	public DebugThreadInfo(long handle, long dataOffset, long startOffset) {
-		this.handle = handle;
-		this.dataOffset = dataOffset;
-		this.startOffset = startOffset;
-	}
-
-	@Override
-	public String toString() {
-		return String.format("<%s@%08x handle=0x%04x,dataOffset=0x%08x,startOffset=0x%08x>",
-			getClass().getSimpleName(), System.identityHashCode(this),
-			handle, dataOffset, startOffset);
-	}
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/DebugThreadRecord.java

@@ -1,34 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng;
-
-public record DebugThreadRecord(long value) implements DebugThreadId {
-
-	@Override
-	public boolean isSystem() {
-		return false;
-	}
-
-	@Override
-	public String id() {
-		return Long.toHexString(value);
-	}
-
-	@Override
-	public String toString() {
-		return "<dbgeng.dll Engine TID " + Long.toHexString(value) + ">";
-	}
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/DebugValue.java

@@ -1,457 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng;
-
-import java.lang.annotation.*;
-import java.lang.reflect.InvocationTargetException;
-import java.nio.ByteBuffer;
-import java.nio.ByteOrder;
-import java.util.Arrays;
-
-import agent.dbgeng.dbgeng.DebugValue.DebugValueType;
-import agent.dbgeng.dbgeng.DebugValue.ForDebugValueType;
-import ghidra.util.NumericUtilities;
-
-/**
- * Data copied from a {@code DEBUG_VALUE} as defined in {dbgeng.h}.
- */
-@ForDebugValueType(DebugValueType.INVALID)
-public interface DebugValue {
-	@Retention(RetentionPolicy.RUNTIME)
-	@Target(ElementType.TYPE)
-	public static @interface ForDebugValueType {
-		DebugValueType value();
-	}
-
-	public static enum DebugValueType {
-		INVALID(0), //
-		INT8(Byte.SIZE), //
-		INT16(Short.SIZE), //
-		INT32(Integer.SIZE), //
-		INT64(Long.SIZE), //
-		FLOAT32(Float.SIZE), //
-		FLOAT64(Double.SIZE), //
-		FLOAT80(80), //
-		FLOAT82(82), //
-		FLOAT128(128), //
-		VECTOR64(64), //
-		VECTOR128(128), //
-		;
-
-		private static final Class<? extends DebugValue>[] CLASSES;
-
-		static {
-			@SuppressWarnings("unchecked")
-			Class<? extends DebugValue>[] supressed = new Class[DebugValueType.values().length];
-			CLASSES = supressed;
-			for (Class<?> cls : DebugValue.class.getDeclaredClasses()) {
-				if (!DebugValue.class.isAssignableFrom(cls)) {
-					continue;
-				}
-				Class<? extends DebugValue> dvCls = cls.asSubclass(DebugValue.class);
-				DebugValueType type = getDebugValueTypeForClass(dvCls);
-				CLASSES[type.ordinal()] = dvCls;
-			}
-		}
-
-		public static DebugValueType getDebugValueTypeForClass(Class<? extends DebugValue> cls) {
-			ForDebugValueType annot = cls.getAnnotation(ForDebugValueType.class);
-			if (annot == null) {
-				throw new AssertionError(
-					"INTERNAL: Missing ForDebugValueType annotation on " + cls);
-			}
-			return annot.value();
-		}
-
-		public final int bitLength;
-		public final int byteLength;
-
-		private DebugValueType(int bitLength) {
-			this.bitLength = bitLength;
-			this.byteLength = (bitLength + 7) / 8;
-		}
-
-		public Class<? extends DebugValue> getDebugValueClass() {
-			return CLASSES[ordinal()];
-		}
-
-		public DebugValue decodeBytes(byte[] bytes) throws IllegalArgumentException {
-			try {
-				return CLASSES[ordinal()].getConstructor(byte[].class).newInstance(bytes);
-			}
-			catch (InstantiationException | IllegalAccessException | IllegalArgumentException
-					| NoSuchMethodException | SecurityException e) {
-				throw new AssertionError(e);
-			}
-			catch (InvocationTargetException e) {
-				if (e.getCause() instanceof IllegalArgumentException) {
-					throw (IllegalArgumentException) e.getCause();
-				}
-				throw new AssertionError(e);
-			}
-		}
-	}
-
-	@ForDebugValueType(DebugValueType.INT8)
-	public static class DebugInt8Value implements DebugValue {
-		private final byte value;
-
-		public DebugInt8Value(byte value) {
-			this.value = value;
-		}
-
-		public DebugInt8Value(byte[] bytes) {
-			if (bytes.length != 1) {
-				throw new IllegalArgumentException("Must have exactly 1 byte");
-			}
-			this.value = bytes[0];
-		}
-
-		public byte byteValue() {
-			return value;
-		}
-
-		@Override
-		public byte[] encodeAsBytes() {
-			return new byte[] { value };
-		}
-
-		@Override
-		public String toString() {
-			return "byte " + Integer.toHexString(value) + "h";
-		}
-	}
-
-	@ForDebugValueType(DebugValueType.INT16)
-	public static class DebugInt16Value implements DebugValue {
-		private final short value;
-
-		public DebugInt16Value(short value) {
-			this.value = value;
-		}
-
-		public DebugInt16Value(byte[] bytes) {
-			if (bytes.length != Short.BYTES) {
-				throw new IllegalArgumentException("Must have exactly " + Short.BYTES + " bytes");
-			}
-			ByteBuffer buf = ByteBuffer.wrap(bytes).order(ByteOrder.BIG_ENDIAN);
-			this.value = buf.getShort();
-		}
-
-		public short shortValue() {
-			return value;
-		}
-
-		@Override
-		public byte[] encodeAsBytes() {
-			ByteBuffer buf = ByteBuffer.allocate(Short.BYTES).order(ByteOrder.BIG_ENDIAN);
-			buf.putShort(value);
-			return buf.array();
-		}
-
-		@Override
-		public String toString() {
-			return "word " + Integer.toHexString(value) + "h";
-		}
-	}
-
-	@ForDebugValueType(DebugValueType.INT32)
-	public static class DebugInt32Value implements DebugValue {
-		private final int value;
-
-		public DebugInt32Value(int value) {
-			this.value = value;
-		}
-
-		public DebugInt32Value(byte[] bytes) {
-			if (bytes.length != Integer.BYTES) {
-				throw new IllegalArgumentException("Must have exactly " + Integer.BYTES + " bytes");
-			}
-			ByteBuffer buf = ByteBuffer.wrap(bytes).order(ByteOrder.BIG_ENDIAN);
-			this.value = buf.getInt();
-		}
-
-		public int intValue() {
-			return value;
-		}
-
-		@Override
-		public byte[] encodeAsBytes() {
-			ByteBuffer buf = ByteBuffer.allocate(Integer.BYTES).order(ByteOrder.BIG_ENDIAN);
-			buf.putInt(value);
-			return buf.array();
-		}
-
-		@Override
-		public String toString() {
-			return "dword " + Integer.toHexString(value) + "h";
-		}
-	}
-
-	@ForDebugValueType(DebugValueType.INT64)
-	public static class DebugInt64Value implements DebugValue {
-		private final long value;
-
-		public DebugInt64Value(long value) {
-			this.value = value;
-		}
-
-		public DebugInt64Value(byte[] bytes) {
-			if (bytes.length != Long.BYTES) {
-				throw new IllegalArgumentException("Must have exactly " + Long.BYTES + " bytes");
-			}
-			ByteBuffer buf = ByteBuffer.wrap(bytes).order(ByteOrder.BIG_ENDIAN);
-			this.value = buf.getLong();
-		}
-
-		public long longValue() {
-			return value;
-		}
-
-		@Override
-		public byte[] encodeAsBytes() {
-			ByteBuffer buf = ByteBuffer.allocate(Long.BYTES).order(ByteOrder.BIG_ENDIAN);
-			buf.putLong(value);
-			return buf.array();
-		}
-
-		@Override
-		public String toString() {
-			return "qword " + Long.toHexString(value) + "h";
-		}
-	}
-
-	@ForDebugValueType(DebugValueType.FLOAT32)
-	public static class DebugFloat32Value implements DebugValue {
-		private final float value;
-
-		public DebugFloat32Value(float value) {
-			this.value = value;
-		}
-
-		public DebugFloat32Value(byte[] bytes) {
-			if (bytes.length != Float.BYTES) {
-				throw new IllegalArgumentException("Must have exactly " + Float.BYTES + " bytes");
-			}
-			ByteBuffer buf = ByteBuffer.wrap(bytes).order(ByteOrder.BIG_ENDIAN);
-			this.value = buf.getFloat();
-		}
-
-		public float floatValue() {
-			return value;
-		}
-
-		@Override
-		public byte[] encodeAsBytes() {
-			ByteBuffer buf = ByteBuffer.allocate(Float.BYTES).order(ByteOrder.BIG_ENDIAN);
-			buf.putFloat(value);
-			return buf.array();
-		}
-
-		@Override
-		public String toString() {
-			return "f32 " + value;
-		}
-	}
-
-	@ForDebugValueType(DebugValueType.FLOAT64)
-	public static class DebugFloat64Value implements DebugValue {
-		private final double value;
-
-		public DebugFloat64Value(double value) {
-			this.value = value;
-		}
-
-		public DebugFloat64Value(byte[] bytes) {
-			if (bytes.length != Double.BYTES) {
-				throw new IllegalArgumentException("Must have exactly " + Double.BYTES + " bytes");
-			}
-			ByteBuffer buf = ByteBuffer.wrap(bytes).order(ByteOrder.BIG_ENDIAN);
-			this.value = buf.getDouble();
-		}
-
-		public double doubleValue() {
-			return value;
-		}
-
-		@Override
-		public byte[] encodeAsBytes() {
-			ByteBuffer buf = ByteBuffer.allocate(Double.BYTES).order(ByteOrder.BIG_ENDIAN);
-			buf.putDouble(value);
-			return buf.array();
-		}
-
-		@Override
-		public String toString() {
-			return "f64 " + value;
-		}
-	}
-
-	/**
-	 * Extended-precision float
-	 */
-	@ForDebugValueType(DebugValueType.FLOAT80)
-	public static class DebugFloat80Value implements DebugValue {
-		private final byte[] bytes;
-
-		public DebugFloat80Value(byte[] bytes) {
-			if (bytes.length != 10) {
-				throw new IllegalArgumentException("Must have exactly 10 bytes");
-			}
-			this.bytes = Arrays.copyOf(bytes, 10);
-		}
-
-		public byte[] bytes() {
-			return bytes;
-		}
-
-		@Override
-		public byte[] encodeAsBytes() {
-			return bytes;
-		}
-
-		@Override
-		public String toString() {
-			return "f80 " + NumericUtilities.convertBytesToString(bytes);
-		}
-	}
-
-	/**
-	 * Specific to IA-64 (Itanium) floating-point registers
-	 * 
-	 * 17-bit exponent, 64-bit fraction. Not sure how it's aligned in memory, though.
-	 */
-	@ForDebugValueType(DebugValueType.FLOAT82)
-	public static class DebugFloat82Value implements DebugValue {
-		private final byte[] bytes;
-
-		public DebugFloat82Value(byte[] bytes) {
-			if (bytes.length != 11) {
-				throw new IllegalArgumentException("Must have exactly 11 bytes");
-			}
-			this.bytes = Arrays.copyOf(bytes, 11);
-		}
-
-		public byte[] bytes() {
-			return bytes;
-		}
-
-		@Override
-		public byte[] encodeAsBytes() {
-			return bytes;
-		}
-
-		@Override
-		public String toString() {
-			return "f82 " + NumericUtilities.convertBytesToString(bytes);
-		}
-	}
-
-	/**
-	 * Quadruple-precision float
-	 */
-	@ForDebugValueType(DebugValueType.FLOAT128)
-	public static class DebugFloat128Value implements DebugValue {
-		private final byte[] bytes;
-
-		public DebugFloat128Value(byte[] bytes) {
-			if (bytes.length != 16) {
-				throw new IllegalArgumentException("Must have exactly 16 bytes");
-			}
-			this.bytes = Arrays.copyOf(bytes, 16);
-		}
-
-		public byte[] bytes() {
-			return bytes;
-		}
-
-		@Override
-		public byte[] encodeAsBytes() {
-			return bytes;
-		}
-
-		@Override
-		public String toString() {
-			return "f128 " + NumericUtilities.convertBytesToString(bytes);
-		}
-	}
-
-	@ForDebugValueType(DebugValueType.VECTOR64)
-	public static class DebugVector64Value implements DebugValue {
-		private final byte[] bytes;
-
-		public DebugVector64Value(byte[] bytes) {
-			if (bytes.length != 8) {
-				throw new IllegalArgumentException("Must have exactly 8 bytes");
-			}
-			this.bytes = Arrays.copyOf(bytes, 8);
-		}
-
-		public byte[] vi4() {
-			return bytes;
-		}
-
-		@Override
-		public byte[] encodeAsBytes() {
-			return bytes;
-		}
-
-		@Override
-		public String toString() {
-			return "vec64 " + NumericUtilities.convertBytesToString(bytes);
-		}
-	}
-
-	@ForDebugValueType(DebugValueType.VECTOR128)
-	public static class DebugVector128Value implements DebugValue {
-		private final byte[] bytes;
-
-		public DebugVector128Value(byte[] bytes) {
-			if (bytes.length != 16) {
-				throw new IllegalArgumentException(
-					"Must have exactly 16 bytes. got " + bytes.length);
-			}
-			this.bytes = Arrays.copyOf(bytes, 16);
-		}
-
-		public byte[] vi8() {
-			return bytes;
-		}
-
-		@Override
-		public byte[] encodeAsBytes() {
-			return bytes;
-		}
-
-		@Override
-		public String toString() {
-			return "vec128 " + NumericUtilities.convertBytesToString(bytes);
-		}
-	}
-
-	default DebugValueType getValueType() {
-		return DebugValueType.getDebugValueTypeForClass(getClass());
-	}
-
-	/**
-	 * TODO: Document me
-	 * 
-	 * Encodes the value as an array of bytes in big-endian order
-	 * 
-	 * @return the encoded value
-	 */
-	public byte[] encodeAsBytes();
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/err/DbgEngException.java

@@ -1,29 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng.err;
-
-/**
- * The base exception for checked {@code dbgeng.dll} wrapper-related errors.
- */
-public class DbgEngException extends Exception {
-	public DbgEngException() {
-		super();
-	}
-
-	public DbgEngException(String message) {
-		super(message);
-	}
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/err/DbgEngRuntimeException.java

@@ -1,29 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng.err;
-
-/**
- * The base exception for unchecked {@code dbgeng.dll} wrapper-related errors.
- */
-public class DbgEngRuntimeException extends RuntimeException {
-	public DbgEngRuntimeException() {
-		super();
-	}
-
-	public DbgEngRuntimeException(String message) {
-		super(message);
-	}
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/ext/JavaProvider.java

@@ -1,49 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng.ext;
-
-import com.sun.jna.platform.win32.COM.COMUtils;
-import com.sun.jna.ptr.PointerByReference;
-
-import agent.dbgeng.dbgeng.DebugClient;
-import agent.dbgeng.impl.dbgeng.client.DebugClientInternal;
-import agent.dbgeng.jna.dbgeng.client.WrapIDebugClient;
-import agent.dbgeng.jna.javaprovider.JavaProviderNative;
-
-/**
- * Wrapper for "javaprovider" plugin library
- * 
- * @deprecated In one (abandoned) use case, the SCTL server can be loaded as a
- *             "{@code engext.cpp}-style" plugin, presumably into any {@code dbgeng.dll}-powered
- *             debugger. This is accomplished by embedding the JVM into the plugin, and then calling
- *             an alternative entry point. This plugin also provides a utility function for invoking
- *             {@code CreateClient} on the client provided to the plugin by the host debugger.
- */
-@Deprecated
-public class JavaProvider {
-	public static DebugClient createClient() {
-		PointerByReference pClient = new PointerByReference();
-		COMUtils.checkRC(JavaProviderNative.INSTANCE.createClient(pClient.getPointer()));
-		WrapIDebugClient wrap = new WrapIDebugClient(pClient.getValue());
-
-		try {
-			return DebugClientInternal.tryPreferredInterfaces(wrap::QueryInterface);
-		}
-		finally {
-			wrap.Release();
-		}
-	}
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/dbgeng/util/DebugEventCallbacksAdapter.java

@@ -1,125 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.dbgeng.util;
-
-import java.lang.reflect.Method;
-
-import agent.dbgeng.dbgeng.*;
-import agent.dbgeng.dbgeng.DebugClient.*;
-import ghidra.comm.util.BitmaskSet;
-
-/**
- * A convenient abstract implementation of {@link DebugEventCallbacks}
- * 
- * This implementation automatically computes the value for {@link #getInterestMask()} based on the
- * overridden methods. The default implementations all return {@link DebugStatus#NO_CHANGE}, should
- * they happen to be called.
- */
-public class DebugEventCallbacksAdapter implements DebugEventCallbacks {
-
-	private BitmaskSet<DebugEvent> interests = new BitmaskSet<>(DebugEvent.class);
-
-	public DebugEventCallbacksAdapter() {
-		try {
-			// Compute the interest mask based on methods that are overridden
-			for (Method im : DebugEventCallbacks.class.getDeclaredMethods()) {
-				Method m = this.getClass().getMethod(im.getName(), im.getParameterTypes());
-				if (m.getDeclaringClass() == DebugEventCallbacksAdapter.class) {
-					continue;
-				}
-				// The interface method is overridden, grab the annotation from the interface
-				ForInterest fi = im.getAnnotation(ForInterest.class);
-				if (fi == null) {
-					throw new AssertionError("No ForInterest annotation present on " + m);
-				}
-				interests.add(fi.value());
-			}
-		}
-		catch (NoSuchMethodException e) {
-			throw new AssertionError(e);
-		}
-	}
-
-	@Override
-	public BitmaskSet<DebugEvent> getInterestMask() {
-		return interests;
-	}
-
-	@Override
-	public DebugStatus breakpoint(DebugBreakpoint bp) {
-		return DebugStatus.NO_CHANGE;
-	}
-
-	@Override
-	public DebugStatus exception(DebugExceptionRecord64 exception, boolean firstChance) {
-		return DebugStatus.NO_CHANGE;
-	}
-
-	@Override
-	public DebugStatus createThread(DebugThreadInfo debugThreadInfo) {
-		return DebugStatus.NO_CHANGE;
-	}
-
-	@Override
-	public DebugStatus exitThread(int exitCode) {
-		return DebugStatus.NO_CHANGE;
-	}
-
-	@Override
-	public DebugStatus createProcess(DebugProcessInfo debugProcessInfo) {
-		return DebugStatus.NO_CHANGE;
-	}
-
-	@Override
-	public DebugStatus exitProcess(int exitCode) {
-		return DebugStatus.NO_CHANGE;
-	}
-
-	@Override
-	public DebugStatus loadModule(DebugModuleInfo debugModuleInfo) {
-		return DebugStatus.NO_CHANGE;
-	}
-
-	@Override
-	public DebugStatus unloadModule(String imageBaseName, long baseOffset) {
-		return DebugStatus.NO_CHANGE;
-	}
-
-	@Override
-	public DebugStatus systemError(int error, int level) {
-		return DebugStatus.NO_CHANGE;
-	}
-
-	@Override
-	public DebugStatus sessionStatus(SessionStatus status) {
-		return DebugStatus.NO_CHANGE;
-	}
-
-	@Override
-	public DebugStatus changeDebuggeeState(BitmaskSet<ChangeDebuggeeState> flags, long argument) {
-		return DebugStatus.NO_CHANGE;
-	}
-
-	@Override
-	public DebugStatus changeEngineState(BitmaskSet<ChangeEngineState> flags, long argument) {
-		return DebugStatus.NO_CHANGE;
-	}
-
-	@Override
-	public DebugStatus changeSymbolState(BitmaskSet<ChangeSymbolState> flags, long argument) {
-		return DebugStatus.NO_CHANGE;
-	}
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/gadp/DbgEngGadpDebuggerModelFactory.java

@@ -1,97 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.gadp;
-
-import java.util.List;
-
-import ghidra.dbg.gadp.server.AbstractGadpLocalDebuggerModelFactory;
-import ghidra.dbg.util.ConfigurableFactory.FactoryDescription;
-import ghidra.program.model.listing.Program;
-
-@FactoryDescription(
-	brief = "MS dbgeng.dll (WinDbg) via GADP",
-	htmlDetails = """
-			Connect to the Microsoft Debug Engine.
-			This is the same engine that powers WinDbg.
-			This is best for most Windows userspace and kernel targets.
-			Kernel debugging is still experimental.
-			This will protect Ghidra's JVM by using a subprocess to access the native API.""")
-public class DbgEngGadpDebuggerModelFactory extends AbstractGadpLocalDebuggerModelFactory {
-
-	protected String remote = "none"; // Require user to start server
-	@FactoryOption("DebugConnect options (.server)")
-	public final Property<String> agentRemoteOption =
-		Property.fromAccessors(String.class, this::getAgentRemote, this::setAgentRemote);
-
-	protected String transport = "none"; // Require user to start server
-	@FactoryOption("Remote process server options (untested)")
-	public final Property<String> agentTransportOption =
-		Property.fromAccessors(String.class, this::getAgentTransport, this::setAgentTransport);
-
-	@Override
-	public int getPriority(Program program) {
-		// TODO: Might instead look for the DLL
-		if (!System.getProperty("os.name").toLowerCase().contains("windows")) {
-			return -1;
-		}
-		if (program != null) {
-			String exe = program.getExecutablePath();
-			if (exe == null || exe.isBlank()) {
-				return -1;
-			}
-		}
-		return 60;
-	}
-
-	public String getAgentTransport() {
-		return transport;
-	}
-
-	public void setAgentTransport(String transport) {
-		this.transport = transport;
-	}
-
-	public String getAgentRemote() {
-		return remote;
-	}
-
-	public void setAgentRemote(String remote) {
-		this.remote = remote;
-	}
-
-	@Override
-	protected String getThreadName() {
-		return "Local dbgeng.dll Agent stdout";
-	}
-
-	protected Class<?> getServerClass() {
-		return DbgEngGadpServer.class;
-	}
-
-	@Override
-	protected void completeCommandLine(List<String> cmd) {
-		cmd.add(getServerClass().getCanonicalName());
-		cmd.addAll(List.of("-H", host));
-		cmd.addAll(List.of("-p", Integer.toString(port)));
-		//cmd.addAll(List.of("-t", transport));
-		if (!remote.equals("none") && !remote.equals("")) {
-			cmd.addAll(List.of("-r", remote));
-		}
-		if (!transport.equals("none") && !transport.equals("")) {
-			cmd.addAll(List.of("-t", transport));
-		}
-	}
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/gadp/DbgEngGadpServer.java

@@ -1,236 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *      http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.gadp;
-
-import java.io.IOException;
-import java.net.InetSocketAddress;
-import java.net.SocketAddress;
-import java.util.*;
-import java.util.concurrent.CompletableFuture;
-import java.util.concurrent.ExecutionException;
-
-import org.apache.commons.lang3.exception.ExceptionUtils;
-
-import agent.dbgeng.gadp.impl.DbgEngGadpServerImpl;
-import ghidra.async.AsyncUtils;
-import ghidra.dbg.agent.AgentWindow;
-import ghidra.util.Msg;
-
-public interface DbgEngGadpServer extends AutoCloseable {
-	public static final String USAGE =
-		"""
-				This is the GADP server for Windows dbgeng.dll.  Usage:
-
-				    gadp-agent-gdbeng [-H HOST/ADDR] [-p PORT] [-i ID] [-t TRANSPORT]
-				                      [-r REMOTE]
-
-				Options:
-
-				  --host/-H          The address of the interface on which to listen.
-				  --port/-p          The TCP port on which to listen for GADP. Default is 12345
-				  --transport/-t     The transport specification for the Process Server. Default
-				                     is tcp:port=11200
-				  --remote/-r        The transport specification for a remote server.
-				
-				Starts a dbgeng.dll-based GADP server "agent". Once the server has started, it
-				will print the interface IP and port.
-				""";
-	public static final String DEFAULT_DBGSRV_TRANSPORT = "tcp:port=11200";
-
-	/**
-	 * The entry point for the GADP-DBGENG server in stand-alone mode
-	 * 
-	 * Run it to see help.
-	 * 
-	 * @param args the command-line arguments
-	 * @throws IOException if an I/O error occurs
-	 * @throws ExecutionException
-	 * @throws InterruptedException
-	 */
-	public static void main(String[] args) throws Exception {
-		try {
-			new DbgEngRunner().run(args);
-		}
-		catch (Throwable t) {
-			System.err.println(ExceptionUtils.getMessage(t));
-			System.exit(1);
-		}
-	}
-
-	/**
-	 * Create a new instance of the server
-	 * 
-	 * @param addr the address to bind the GADP server to
-	 * @param busId the client ID the server should use on the bus for synthesized commands
-	 * @param dbgSrvTransport the transport specification for the {@code dbgeng.dll} server
-	 * @return the server instance
-	 * @throws IOException
-	 */
-	public static DbgEngGadpServer newInstance(SocketAddress addr) throws IOException {
-		return new DbgEngGadpServerImpl(addr);
-	}
-
-	/**
-	 * Runs the server from the command line
-	 */
-	public class DbgEngRunner {
-		protected InetSocketAddress bindTo;
-		protected List<String> dbgengArgs = new ArrayList<>();
-		protected String dbgSrvTransport = DEFAULT_DBGSRV_TRANSPORT;
-		protected String remote = null;
-
-		public DbgEngRunner() {
-		}
-
-		public void run(String args[])
-				throws IOException, InterruptedException, ExecutionException {
-			parseArguments(args);
-
-			try (DbgEngGadpServer server = newInstance(bindTo)) {
-				//TODO: fix/test the debugConnect case when args are passed
-				server.startDbgEng(dbgengArgs.toArray(new String[] {})).exceptionally(e -> {
-					e = AsyncUtils.unwrapThrowable(e);
-					Msg.error(this, "Error starting dbgeng/GADP: " + e);
-					System.exit(-1);
-					return null;
-				});
-				new AgentWindow("dbgeng.dll Agent for Ghidra", server.getLocalAddress());
-				while (server.isRunning()) {
-					// TODO: Put consoleLoop back?
-					Thread.sleep(1000);
-				}
-				System.exit(0);
-			}
-		}
-
-		protected void parseArguments(String[] args) {
-			String iface = "localhost";
-			int port = 12345;
-			// NOTE: Maybe commons-cli or Argparse4j?
-			Iterator<String> ait = Arrays.asList(args).iterator();
-			while (ait.hasNext()) {
-				String a = ait.next();
-				if ("-h".equals(a) || "--help".equals(a)) {
-					printUsage();
-					System.exit(0);
-				}
-				else if ("-p".equals(a) || "--port".equals(a)) {
-					if (!ait.hasNext()) {
-						System.err.println("Expected PORT");
-						printUsage();
-						System.exit(-1);
-					}
-					String portStr = ait.next();
-					try {
-						port = Integer.parseInt(portStr);
-					}
-					catch (NumberFormatException e) {
-						System.err.println("Integer required. Got " + portStr);
-						printUsage();
-						System.exit(-1);
-					}
-				}
-				else if ("-H".equals(a) || "--host".equals(a)) {
-					if (!ait.hasNext()) {
-						System.err.println("Expected HOST/ADDR");
-						printUsage();
-						System.exit(-1);
-					}
-					iface = ait.next();
-				}
-				else if ("-t".equals(a) || "--transport".equals(a)) {
-					if (!ait.hasNext()) {
-						System.err.println("Expected TRANSPORT");
-						System.err.println("See the MSDN 'Activating a Process Server'");
-						printUsage();
-						System.exit(-1);
-					}
-					dbgSrvTransport = ait.next();
-					dbgengArgs.add(dbgSrvTransport);
-				}
-				else if ("-r".equals(a) || "--remote".equals(a)) {
-					if (!ait.hasNext()) {
-						System.err.println("Expected TRANSPORT:HOST,PORT");
-						printUsage();
-						System.exit(-1);
-					}
-					remote = ait.next();
-					dbgengArgs.add(remote);
-				}
-				else {
-					System.err.println("Unknown option: " + a);
-					printUsage();
-					System.exit(-1);
-				}
-			}
-
-			bindTo = new InetSocketAddress(iface, port);
-		}
-
-		protected void printUsage() {
-			System.out.println(USAGE);
-		}
-	}
-
-	/**
-	 * Start the debugging server
-	 * 
-	 * @return a future that completes when the server is ready
-	 */
-	CompletableFuture<Void> startDbgEng(String[] args);
-
-	/**
-	 * Get the local address to which the GADP server is bound.
-	 * 
-	 * @return the local socket address
-	 */
-	SocketAddress getLocalAddress();
-
-	/**
-	 * Starts the dbgeng manager's console loop
-	 * 
-	 * @throws IOException if an I/O error occurs
-	 */
-	//public void consoleLoop() throws IOException;
-
-	/**
-	 * Close all connections and ports, GADP and Process Server, and terminate the server
-	 * 
-	 * @throws IOException if an I/O error occurs
-	 */
-	public void terminate() throws IOException;
-
-	/**
-	 * Check if the server is running
-	 * 
-	 * This will return false: 1) Before the server has been started, 2) After a call to
-	 * {@link #terminate()}, or 3) When an error occurs causing the server to terminate
-	 * unexpectedly. Otherwise, it returns true.
-	 * 
-	 * @return true if the server is currently running.
-	 */
-	public boolean isRunning();
-
-	/**
-	 * Calls {@link #terminate()}
-	 * 
-	 * @throws IOException if an I/O error occurs
-	 */
-	@Override
-	default void close() throws IOException {
-		terminate();
-	}
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/gadp/DbgEngGadpServerLaunchShim.java

@@ -1,37 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.gadp;
-
-import org.apache.commons.lang3.exception.ExceptionUtils;
-
-import agent.dbgeng.gadp.DbgEngGadpServer.DbgEngRunner;
-import ghidra.GhidraApplicationLayout;
-import ghidra.GhidraLaunchable;
-
-public class DbgEngGadpServerLaunchShim implements GhidraLaunchable {
-
-	@Override
-	public void launch(GhidraApplicationLayout layout, String[] args) throws Exception {
-		try {
-			new DbgEngRunner().run(args);
-		}
-		catch (Throwable t) {
-			System.err.println(ExceptionUtils.getMessage(t));
-			System.exit(1);
-		}
-	}
-
-}

Ghidra/Debug/Debugger-agent-dbgeng/src/main/java/agent/dbgeng/gadp/impl/AbstractClientThreadExecutor.java

@@ -1,244 +0,0 @@
-/* ###
- * IP: GHIDRA
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- * 
- *      http://www.apache.org/licenses/LICENSE-2.0
- * 
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package agent.dbgeng.gadp.impl;
-
-import java.util.*;
-import java.util.concurrent.*;
-import java.util.concurrent.atomic.AtomicBoolean;
-import java.util.function.Consumer;
-
-import com.sun.jna.platform.win32.COM.COMException;
-
-import agent.dbgeng.dbgeng.DebugClient;
-import agent.dbgeng.dbgeng.DebugClient.DebugStatus;
-import agent.dbgeng.dbgeng.DebugControl;
-import agent.dbgeng.manager.DbgManager;
-import ghidra.util.Msg;
-
-/**
- * A single-threaded executor which creates and exclusively accesses the {@code dbgeng.dll} client.
- * 
- * <p>
- * The executor also has a priority mechanism, so that callbacks may register follow-on handlers
- * which take precedence over other tasks in the queue (which could trigger additional callbacks).
- * This is required since certain operation are not allowed during normal callback processing. For
- * example, changing the current process is typically not allowed, but it is necessary to retrieve a
- * thread's context.
- */
-public abstract class AbstractClientThreadExecutor extends AbstractExecutorService {
-	private static final int DEFAULT_PRIORITY = 10;
-
-	protected DebugClient client;
-	protected boolean shuttingDown = false;
-	protected final Queue<Entry> queue = new PriorityQueue<>();
-	protected Thread thread = new Thread(this::run, "DebugClient");
-	protected final AtomicBoolean waitRegistered = new AtomicBoolean();
-
-	protected abstract void init();
-
-	public static class Entry implements Comparable<Entry> {
-		final int priority;
-		public final Runnable command;
-
-		public Entry(int priority, Runnable command) {
-			this.priority = priority;
-			this.command = command;
-		}
-
-		@Override
-		public int compareTo(Entry that) {
-			return Integer.compare(this.priority, that.priority);
-		}
-	}
-
-	/**
-	 * Obtain a reference to the client, only if the calling thread is this executor's thread.
-	 * 
-	 * @return the client
-	 */
-	public DebugClient getClient() {
-		if (thread != Thread.currentThread()) {
-			//TODO: throw new AssertionError("Cannot get client outside owning thread");
-		}
-		return client;
-	}
-
-	/**
-	 * Instruct the executor to call {@link DebugClient#dispatchCallbacks()} when it next idles.
-	 */
-	public void cancelWait() {
-		waitRegistered.set(false);
-	}
-
-	/**
-	 * Instruct the executor to call {@link DebugControl#waitForEvent()} when it next idles.
-	 */
-	public void registerWait() {
-		waitRegistered.set(true);
-	}
-
-	private Entry pollQueue() {
-		synchronized (queue) {
-			return queue.poll();
-		}
-	}
-
-	private void run() {
-		/**
-		 * The general idea is to run indefinitely, taking every precaution to protect this thread's
-		 * life, since only it can access the client. Granted, if it turns out to be too difficult,
-		 * we can always create a new thread and client, using the existing client's reentrant
-		 * methods.
-		 * 
-		 * <p>
-		 * As stated in the MSDN, this thread repeatedly calls {@code DispatchEvents} in order to
-		 * receive callbacks regarding events caused by other clients. If, however, an wait is
-		 * registered, or the current engine state indicates that a wait is proper, the thread calls
-		 * {@code WaitForEvent} instead. The thread is occupied until the wait completes, which is
-		 * fine since the engine is inaccessible (except to certain callbacks) until it completes,
-		 * anyway.
-		 */
-		try {
-			init();
-			while (!shuttingDown) {
-				Entry next;
-				while (null != (next = pollQueue())) {
-					if (shuttingDown) {
-						return;
-					}
-					try {
-						//System.out.println("Executing: " + next);
-						next.command.run();
-						//System.out.println("Done");
-					}
-					catch (Throwable t) {
-						Msg.error(this, "Task in executor threw: " + t);
-					}
-				}
-				DebugStatus status = client.getControl().getExecutionStatus();
-				if (status.shouldWait && status != DebugStatus.NO_DEBUGGEE ||
-					waitRegistered.get()) {
-					waitRegistered.set(false);
-					try {
-						getManager().waitForEventEx();
-						//client.getControl().waitForEvent();
-					}
-					catch (COMException e) {
-						Msg.error(this, "Error during WaitForEvents: " + e);
-					}
-				}
-				else {
-					try {
-						client.dispatchCallbacks(100); // TODO: Better synchronization
-					}
-					catch (COMException e) {
-						Msg.error(this, "Error during DispatchCallbacks: " + e);
-					}
-				}
-			}
-		}
-		catch (Throwable t) {
-			Msg.error(this, "Non-respawnable executor terminated unexpectedly", t);
-			shuttingDown = true;
-		}
-	}
-
-	@Override
-	public void shutdown() {
-		shuttingDown = true;
-	}
-
-	@Override
-	public List<Runnable> shutdownNow() {
-		shuttingDown = true;
-		client.exitDispatch();
-		thread.interrupt();
-		List<Runnable> left = new ArrayList<>(queue.size());
-		for (Entry ent : queue) {
-			left.add(ent.command);
-		}
-		return left;
-	}
-
-	@Override
-	public boolean isShutdown() {
-		return shuttingDown;
-	}
-
-	@Override
-	public boolean isTerminated() {
-		return !thread.isAlive();
-	}
-
-	@Override
-	public boolean awaitTermination(long timeout, TimeUnit unit) throws InterruptedException {
-		long millis = TimeUnit.MILLISECONDS.convert(timeout, unit);
-		thread.join(millis);
-		return !thread.isAlive();
-	}
-
-	@Override
-	public void execute(Runnable command) {
-		execute(DEFAULT_PRIORITY, command);
-	}
-
-	/**
-	 * Schedule a task with a given priority.
-	 * 
-	 * <p>
-	 * Smaller priority values indicate earlier execution. The default priority is
-	 * {@link #DEFAULT_PRIORITY}.
-	 * 
-	 * @param priority the priority
-	 * @param command the task
-	 */
-	public void execute(int priority, Runnable command) {
-		if (shuttingDown) {
-			// TODO: Is this the correct exception?
-			throw new RejectedExecutionException("Executor is shutting down");
-		}
-		if (!thread.isAlive()) {
-			throw new RejectedExecutionException("Executor has terminated");
-		}
-		synchronized (queue) {
-			queue.add(new Entry(priority, command));
-			// TODO: Putting this in causes sync/output flushing problems
-			//client.exitDispatch();
-		}
-	}
-
-	public boolean isCurrentThread() {
-		return thread.equals(Thread.currentThread());
-	}
-
-	/**
-	 * Schedule a task with the given priority, taking a reference to the client.
-	 * 
-	 * <p>
-	 * This is a convenience which spares a call to {@link #getClient()}. See
-	 * {@link #execute(int, Runnable)} about priority.
-	 * 
-	 * @param priority the priority
-	 * @param command the task
-	 */
-	public void execute(int priority, Consumer<DebugClient> command) {
-		execute(priority, () -> command.accept(client));
-	}
-
-	public abstract DbgManager getManager();
-
-	public abstract void setManager(DbgManager manager);
-}