Skip to content

Latest commit

 

History

History
91 lines (54 loc) · 3.56 KB

IDE.md

File metadata and controls

91 lines (54 loc) · 3.56 KB

Fray Debugger Plugin

Fray Idea Plugin allows you to control concurrent programs in your Intellij IDE!

Installation

  • Using the IDE built-in plugin system:

    Settings/Preferences > Plugins > Marketplace > Search for "Fray Debugger" > Install

  • Using JetBrains Marketplace:

    Go to JetBrains Marketplace and install it by clicking the Install to ... button in case your IDE is running.

    You can also download the latest release from JetBrains Marketplace and install it manually using Settings/Preferences > Plugins > ⚙️ > Install plugin from disk...

Usage

Fray Debugger Plugin provides an interactive interface to control the execution of concurrent programs.

To launch Fray tests from IntelliJ, you'll need to add the Fray-instrumented JDK to IntelliJ's configuration. This can be done by first:

  • when using Maven, run mvn verify, followed by mvn dependency:copy-dependencies
  • when using Gradle, TODO

Then, in the Run/Debug Configurations, add the JDK in the Build and run section:

img.png

Click Select alternative JRE and navigate to the instrumented JDK: ${project_folder}/target/fray/fray-java. You will also need to add the following VM options:

-javaagent:$MODULE_DIR$/target/dependency/fray-instrumentation-agent-0.6.8.jar
-agentpath:$MODULE_DIR$/target/fray/fray-jvmti/libjvmti.so

Finally, you can then start the Fray Debugger, by selecting Debug (Fray) from the Run/Debug Configurations dropdown:

img.png

Once the test is launched, Fray Debugger Plugin will pause the program execution at each synchronization point. You can then control the execution of the program using the Fray Debugger Plugin interface:

img.png

The dropdown manu shows all threads in the program. You can select a thread to view its stack trace.

img.png

In the editor, Fray also shows the current line of execution and the thread name.

img.png

Once you have decided which thread to schedule, you can click the Schedule button to schedule the selected thread. Note that a thread may note be scheduled if it is blocked or if it is not ready to run. Such a thread will be marked as Paused.

img.png

Launch Fray Test Without Plugin (Normal concurrency tests)

You can launch Fray tests from the IDE and debug them as you would with any other JUnit test.

fray-idea.png

Select frayTest from the Gradle tool window to run all Fray tests in the project.

Warning

Fray debugger plugin only works with tests annotated with @ConcurrencyTest right now.

Disable evaluations in debug mode

If you use IntelliJ debugger, you may notice that the replay sometimes failed. This is because the Intellij debugger tries to evaluate the value of local variables when the program is paused. Evaluating these variables may trigger additional synchronization points leading to nondeterministic behavior in Fray. Thus, it is recommended to disable these features.

To disable Intellij evaluation, go to File -> Settings -> Build, Execution, Deployment -> Debugger -> Data Views -> Java and uncheck options that may lead to dynamic evaluation.

img.png