Skip to content

Latest commit

 

History

History
83 lines (69 loc) · 5.74 KB

README.md

File metadata and controls

83 lines (69 loc) · 5.74 KB
Raw

Test Status License: MPL 2.0

Gobra is a prototype verifier for Go programs, based on the Viper verification infrastructure.

We call annotated Go programs Gobra programs and use the file extension .gobra for them. A tutorial can be found in docs/tutorial.md. More examples can be found in src/test/resources.

Compile and Run Gobra

Preliminaries

  • Java 64-Bit (tested with version 11 and 15)
  • SBT (tested with version 1.4.4)
  • Git

Installation

  1. Install Z3 and Boogie. Steps (iii) and (iv) are specific to Boogie and only necessary when using Carbon as verification backend. Gobra uses the Silicon verification backend by default.
    1. Get a Z3 executable. A precompiled executable can be downloaded here. We tested version 4.8.7 64-Bit.
    2. Set the environment variable Z3_EXE to the path of your Z3 executable.
    3. Get a Boogie executable. Instructions for compilation are given here. Mono is required on Linux and macOS to run Boogie. Alternatively, extract a compiled version from the Viper release tools (Windows, Linux, macOS).
    4. Set the environment variable BOOGIE_EXE to the path of your Boogie executable.
  2. Clone gobra (this repository) in your computer.
  3. Change directory to the gobra directory created in the previous step.
  4. Run git submodule update --init --recursive to fetch viperserver and its transitive dependencies (carbon, silicon and silver).
  5. Run sbt compile to compile Gobra.

The command sbt assembly can also be used to produce a fat jar file, which is located by default in target/scala.

Running Gobra

Gobra can be run either from sbt or from a compiled jar:

  • running from sbt:
    1. change directory to the gobra directory obtained from cloning this repository.
    2. run sbt.
    3. inside the sbt shell, run run - i path/to/file (e.g., run -i src/test/resources/regressions/examples/swap.gobra)
  • running from a compiled jar:
    1. run java -jar -Xss128m path/to/gobra.jar -i path/to/file.

More information about the available options in Gobra can be found by running run --help in an sbt shell or java -jar path/to/gobra.jar --help if you assembled Gobra.

Running the Tests

In the gobra directory, run the command sbt test.

Debugging

By default, Gobra runs in sbt on a forked JVM. This means that simply attaching a debugger to sbt will not work. There are two workarounds:

  • Run Gobra in a non-forked JVM by first running set fork := false in sbt. This will allow you to attach a debugger to sbt normally. However, for unknown reasons, this causes issues with class resolution in the Viper backend, so actually only the parsing can really be debugged.
  • Attach the debugger to the forked JVM.
    • Create a debug configuration in IntelliJ and specify to Attach to remote JVM, set localhost as host, and a port (e.g. 5005).
    • Run set javaOptions += "-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005" in sbt (use any port you like, just make sure to use the same one in the debugger). Now, the forked JVM can be debugged instead of the sbt JVM. This requires starting the debugger again every time a new VM is created, e.g. for every run.
  • Let the debugger listen to the forked JVM.
    • Create a debug configuration in IntelliJ and specify to Listen to remote JVM, enable auto restart, set localhost as host, and a port (e.g. 5005).
    • Run set javaOptions += "-agentlib:jdwp=transport=dt_socket,server=n,address=localhost:5005,suspend=y" in sbt. Thanks to auto restart, the debugger keeps listening even when the JVM is restarted, e.g. for every run. Note however that the debugger must be running/listening as otherwise the JVM will emit a connection refused error.

Projects verified with Gobra

Licensing

Most Gobra sources are licensed under the Mozilla Public License Version 2.0. The LICENSE lists the exceptions to this rule. Note that source files (whenever possible) should list their license in a short header. Continuous integration checks these file headers. The same checks can be performed locally by running npx github:viperproject/check-license-header#v1 check --config .github/license-check/config.json --strict in this repository's root directory.

Get in touch

Do you still have questions? Open an issue or contact us on Zulip.