mirror of
https://github.com/enso-org/enso.git
synced 2024-11-22 11:52:59 +03:00
Unifying debugging information (#8370)
This commit is contained in:
Jaroslav Tulach
GitHub
parent
5244003be8
commit
9a9a6e65a7
@ -17,7 +17,5 @@ used by Enso, broken up as follows:
|
||||
Enso code using Chrome devtools.
|
||||
- [**Debug adapter protocol:**](./dap.md) A guide how to debug Enso code using
|
||||
VSCode.
|
||||
- [**Debugging Enso and Java code at once:**](./mixed-debugging.md) A
|
||||
step-by-step guide how to debug both Enso and Java code in a single debugger.
|
||||
- [**Debugging Engine (Runtime) only Java code:**](./runtime-debugging.md) A
|
||||
guide how to debug the internal Engine Java code.
|
||||
guide how to debug Enso code & the internal Java code.
|
||||
|
||||
@ -1,48 +1,3 @@
|
||||
# Debugging Enso and Java Code at Once
|
||||
|
||||
Enso libraries are written in a mixture of Enso code and Java libraries.
|
||||
Debugging both sides (the Java as well as Enso code) is possible with a decent
|
||||
IDE.
|
||||
|
||||
Get [NetBeans](http://netbeans.apache.org) version 13 or newer or
|
||||
[VS Code with Apache Language Server extension](https://cwiki.apache.org/confluence/display/NETBEANS/Apache+NetBeans+Extension+for+Visual+Studio+Code)
|
||||
and _start listening on port 5005_ with _Debug/Attach Debugger_ or by specifying
|
||||
following debug configuration in VSCode:
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "Listen to 5005",
|
||||
"type": "java+",
|
||||
"request": "attach",
|
||||
"listen": "true",
|
||||
"hostName": "localhost",
|
||||
"port": "5005"
|
||||
}
|
||||
```
|
||||
|
||||
Then it is just about executing following Sbt command which builds CLI version
|
||||
of the engine, launches it in debug mode and passes all other arguments to the
|
||||
started process:
|
||||
|
||||
```bash
|
||||
sbt:enso> runEngineDistribution --debug --run ./test/Tests/src/Data/Numbers_Spec.enso
|
||||
```
|
||||
|
||||
Alternatively you can pass in special JVM arguments when launching the
|
||||
`bin/enso` launcher:
|
||||
|
||||
```bash
|
||||
enso$ JAVA_OPTS=-agentlib:jdwp=transport=dt_socket,server=n,address=5005 ./built-distribution/enso-engine-*/enso-*/bin/enso --run ./test/Tests/src/Data/Numbers_Spec.enso
|
||||
```
|
||||
|
||||
As soon as the debuggee connects and the Enso language starts - choose the
|
||||
_Toggle Pause in GraalVM Script_ button in the toolbar:
|
||||
|
||||
|
||||
|
||||
and your execution shall stop on the next `.enso` line of code. This mode allows
|
||||
to debug both - the Enso code as well as Java code. The stack traces shows a
|
||||
mixture of Java and Enso stack frames by default. Right-clicking on the thread
|
||||
allows one to switch to plain Java view (with a way more stack frames) and back.
|
||||
Analyzing low level details as well as Enso developer point of view shall be
|
||||
simple with such tool.
|
||||
Desribed at [Runtime Debugging](runtime-debugging.md).
|
||||
|
||||
@ -1,37 +1,117 @@
|
||||
# Runtime (Engine) debugging
|
||||
# High & Low Runtime Debugging
|
||||
|
||||
This section explains how to debug various parts of the Engine. By Engine, we
|
||||
mean all the Java code located in the `runtime` SBT project, in `engine`
|
||||
directory.
|
||||
This document describes how to debug **everything** - e.g. how to debug the
|
||||
_Java code_ that powers the Enso _engine & interpreter_ as well as Enso standard
|
||||
_libraries Java code_ (used to interact with the operating system via Java
|
||||
APIs). At the same thetime the document describes how to _map that information_
|
||||
onto the execution of the actual _Enso source code_ being interpreted.
|
||||
|
||||
## Debugging source file evaluation
|
||||
## Debugging Single Source File
|
||||
|
||||
This subsection provides a guide how to debug a single Enso source file
|
||||
evaluation. To evaluate a single source file, we use the _Engine distribution_
|
||||
built with `buildEngineDistribution` command. Both of the following two options
|
||||
starts the JVM in a debug mode. After the JVM is started in a debug mode, simply
|
||||
attach the debugger to the JVM process at the specified port.
|
||||
To analyze what is happening in the interpreter, we often want to debug
|
||||
excecution of a _single Enso file_.
|
||||
|
||||
The first option is to invoke the engine distribution from SBT shell with:
|
||||
Get started by building the _Engine distribution_ built with
|
||||
`sbt buildEngineDistribution` command. Then configure your IDE to understand the
|
||||
_engine Java & Scala sources_ which are mostly located in the
|
||||
[engine subdirectory](https://github.com/enso-org/enso/tree/develop/engine). The
|
||||
sources are known to be understandable by:
|
||||
|
||||
- VSCode - with
|
||||
[Enso Extension described herein](../../tools/enso4igv/README.md)
|
||||
- IntelliJ
|
||||
- IGV - with [extension described herein](../../tools/enso4igv/IGV.md)
|
||||
- [NetBeans](http://netbeans.apache.org) - with the same
|
||||
[extension as IGV](../../tools/enso4igv/IGV.md) is using
|
||||
|
||||
There are two ways to start JVM in a debug mode. The first one is fully
|
||||
integrated into the `sbt` build system. It builds the engine (in case there were
|
||||
any changes) and then starts the JVM in debug mode trying to attach to port
|
||||
`5005`:
|
||||
|
||||
```sh
|
||||
sbt:enso> runEngineDistribution --debug --run ./test/Tests/src/Data/Numbers_Spec.enso
|
||||
```
|
||||
|
||||
The second options is to pass in special JVM arguments when launching the
|
||||
`bin/enso` from the engine distribution:
|
||||
The second options gives one a complete control as it launches everything from a
|
||||
command line. By specifying `JAVA_OPTS` environment variable one influences the
|
||||
special JVM arguments when launching the `bin/enso` from the engine
|
||||
distribution:
|
||||
|
||||
```bash
|
||||
enso$ JAVA_OPTS=-agentlib:jdwp=transport=dt_socket,server=n,address=5005 ./built-distribution/enso-engine-*/enso-*/bin/enso --run ./test/Tests/src/Data/Numbers_Spec.enso
|
||||
```
|
||||
|
||||
### Tips and tricks
|
||||
Both of the approaches launch the JVM in a _debug mode_. Once the JVM is
|
||||
started, simply attach the debugger to the JVM process at the specified port
|
||||
(usually `5005` is used).
|
||||
|
||||
There is no simple mapping of the Enso source code to the engine's Java code, so
|
||||
if you try to debug a specific expression, it might be a bit tricky. However,
|
||||
the following steps should help you to skip all the irrelevant code and get to
|
||||
the code you are interested in:
|
||||
### Attaching from VSCode
|
||||
|
||||
First of all make sure your VSCode contains the
|
||||
[Enso supporting extension](https://marketplace.visualstudio.com/items?itemName=Enso.enso4vscode).
|
||||
Follow the [instructions provided herein](../../tools/enso4igv/README.md) to
|
||||
install everything that's needed.
|
||||
|
||||
Once the
|
||||
[Enso extension](https://marketplace.visualstudio.com/items?itemName=Enso.enso4vscode)
|
||||
is installed, open the root of Enso repository as workspace and select _"Listen
|
||||
to 5005"_ debug configuration:
|
||||
|
||||
|
||||
|
||||
Once the connection with the Enso JVM is made, debug the Java code as usual.
|
||||
|
||||
### Mapping Java and Enso Code
|
||||
|
||||
The _Enso interpreter_ maintains a mapping between its Java code and appropriate
|
||||
_Enso Code_ internally. It shall be no problem to use that information in the
|
||||
debugger. All the mentioned IDEs (alas except IntelliJ) support such _mixed
|
||||
debugging_ of Java and Enso code.
|
||||
|
||||
Put a breakpoint into `.enso` file and after a while the breakpoint is hit and
|
||||
one can inspect variables, step over the _Enso statements_ and more...
|
||||
|
||||
|
||||
|
||||
...as one can seamlessly switch to debugging on the Enso interpreter itself! One
|
||||
can place breakpoint into Java class like `PanicException.java` and continue
|
||||
debugging with `F5`:
|
||||
|
||||
|
||||
|
||||
Should one ever want to jump back from Java to Enso one can use the _"Pause in
|
||||
GraalVM Script"_ action. Select it and continue with `F5` - as soon as the code
|
||||
reaches a statement in Enso, it stops:
|
||||
|
||||
|
||||
|
||||
Similar behavior to _VSCode_ is available in _IGV_ and _NetBeans_. Understanding
|
||||
both the _engine Java code_ as well as _Enso Code_ shall be pretty simple with
|
||||
these tools. For example _NetBeans_ offers _Toggle Pause in GraalVM Script_
|
||||
button in the toolbar:
|
||||
|
||||
|
||||
|
||||
and your execution shall stop on the next `.enso` line of code.
|
||||
|
||||
These advanced developer tools allow one to debug both - the _Enso code_ as well
|
||||
as _Java code_. The stack traces shows a _mixture of Java and Enso stack frames_
|
||||
by default. Right-clicking on the thread allows one to switch to plain Java view
|
||||
(with a way more stack frames) and back. Analyzing low level details as well as
|
||||
Enso developer point of view shall be simple with such tool.
|
||||
|
||||
### Tips and Tricks (for poor IntelliJ users)
|
||||
|
||||
Finding the mapping of the Enso source code to the engine's Java code in
|
||||
_IntelliJ_ isn't easy. Trying to find out how to debug a specific expression is
|
||||
way more tricky than in case of _VSCode_, _IGV_ or _NetBeans_. However, if you
|
||||
really want to stick with _IntelliJ_ as your only tool, following steps may help
|
||||
you to skip all the irrelevant code and get to the code you are interested in:
|
||||
|
||||
- To get the mapping to Enso source code, evaluate the following expression in
|
||||
the Java debugger: `this.getRootNode().getSourceSection()`. Note that this,
|
||||
obviously, works only when the debugger is stopped in some Truffle node code.
|
||||
- To debug a method called `foo`, put a breakpoint in
|
||||
`org.enso.interpreter.node.ClosureRootNode#execute` with a condition on
|
||||
`this.name.contains("foo")`
|
||||
|
||||
@ -72,6 +72,8 @@ reaches a statement in Enso, it stops:
|
||||
|
||||
|
||||
|
||||
Read more on [Enso & Java Debugging](../../docs/debugger/runtime-debugging.md)
|
||||
|
||||
## Building VSCode Extension
|
||||
|
||||
To build this VSCode extension and obtain _Enso_ syntax coloring as well as
|
||||
|
||||
Loading…
Reference in New Issue
Block a user