This section gives a very quick overview of how to build and use Leon; refer to the following sections if you wish (or need) more detailed information.
To build it, you will need, the following:
- Java Runtime Environment, from Oracle, e.g. Version 7 Update 5 (to run sbt and scala)
- Scala, from Typesafe, e.g. version 2.11.5
- sbt, at least version 0.13.1 (to build Leon)
- a recent GLIBC3 or later, works with e.g. apt-get (for Z3)
- GNU Multiprecision library, e.g. gmp3, works with e.g. apt-get (for Z3)
The following can be obtained from the web, but for convenience they are contained in the repository and are actually automatically handled by the default build configuration:
- ScalaZ3 hosted on GitHub
- The libz3 library from microsoft
To build, type this:
$ sbt clean
$ sbt package # takes a while
$ sbt script
Then you can try e.g.
$ ./leon ./testcases/verification/sas2011-testcases/RedBlackTree.scala
and get something like this:
┌──────────────────────┐ ╔═╡ Verification Summary ╞═════════════════════════════════════════════════════════════════════╗ ║ └──────────────────────┘ ║ ║ add postcondition 83:22 valid Z3-f 0.057 ║ ║ add precondition 82:5 valid Z3-f 0.017 ║ ║ add precondition 82:15 valid Z3-f 0.003 ║ ║ balance match exhaustiveness 91:5 valid Z3-f 0.005 ║ ║ balance postcondition 102:22 valid Z3-f 0.055 ║ ║ blackBalanced match exhaustiveness 46:43 valid Z3-f 0.003 ║ ║ blackHeight match exhaustiveness 51:40 valid Z3-f 0.004 ║ ║ buggyAdd postcondition 88:22 invalid Z3-f 1.162 ║ ║ buggyAdd precondition 87:5 invalid Z3-f 0.027 ║ ║ buggyBalance match exhaustiveness 105:5 invalid Z3-f 0.007 ║ ║ buggyBalance postcondition 116:22 invalid Z3-f 0.017 ║ ║ content match exhaustiveness 18:37 valid Z3-f 0.034 ║ ║ ins match exhaustiveness 60:5 valid Z3-f 0.003 ║ ║ ins postcondition 67:22 valid Z3-f 1.753 ║ ║ ins precondition 63:37 valid Z3-f 0.011 ║ ║ ins precondition 65:40 valid Z3-f 0.012 ║ ║ makeBlack postcondition 78:21 valid Z3-f 0.012 ║ ║ redDescHaveBlackChildren match exhaustiveness 41:53 valid Z3-f 0.003 ║ ║ redNodesHaveBlackChildren match exhaustiveness 35:54 valid Z3-f 0.004 ║ ║ size match exhaustiveness 23:33 valid Z3-f 0.004 ║ ║ size postcondition 26:15 valid Z3-f 0.043 ║ ╟┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄╢ ║ total: 21 valid: 17 invalid: 4 unknown 0 3.236 ║ ╚══════════════════════════════════════════════════════════════════════════════════════════════╝
Leon requires quite a few dependencies, and you will need to make sure everything is correctly set up before being able to build it. Leon is probably much easier to build on Unix-like plattforms. Not to say it is impossible to build on Windows. But some scripts used to run and test the system are shell script and you will need to manually port them to Windows if you wish to use Windows.
First you need a Java Runtime Environment. The most recent version should work. Simply follow the standard installation process (e.g. apt-get) for your system.
Next, you need the Simple Build Tool (sbt) which seems to be (as of today) the standard way to build Scala program. Again you should follow the installation procedure. You can also find information about sbt here. Sbt is quite a complex tool, so I would suggest looking at the getting started guide on the wiki page. However, if you just want to quickly build Leon and never look back, then the information provided here should be sufficient.
(This section is outdated for linux, but can be useful to adapt on Windows/Mac) Now you will have to build the ScalaZ3 project. You should follow the instructions given in the ScalaZ3 project. The ScalaZ3 is a Scala wrapper on the Z3 native library from Microsoft. It is used in Leon to make native call to Z3. The generated .jar from ScalaZ3 will be dependent on your own z3 native library, which you can obtain from here. However, the ScalaZ3 repository comes with 32 and 64 bits version for Linux and you should probably use those ones to make sure the version is compatible. You can install the Z3 native library in some standard system library path such as /usr/lib. You need to install the scalaz3.jar file in the "unmanaged" directory. The build system is configured to use any jar file in the "unmanaged" directory. Finally be aware that the Z3 library will come with its own set of dependencies, in particular you will need to have GMP. You will probably have to fight with a few errors before everything can finally work together.
Finally you can build Leon. Start sbt from a terminal to get an interactive
sbt session. Then type:
> clean
This will make sure the build is clean, then:
> package
This will compile everything and create jar files. This could take a long time. Finally you need to generate a running script with the command:
> script
This will generate the leon script that can be used to run leon from command line
with correct arguments and classpath. This script you should not need to re-generate
another time, if you modify some code you just need to run compile again. If anything
goes wrong, you should carefully read the error message and try to fix it. You can
refer to the troubleshooting section of this manual.
Note that Leon is organised as a structure of two projects, with one main (or root) project and one sub-project. From a user point of view, this should most of the time be transparent and the build command should take care of everything. The subproject is in 'library' and contains required code to make Leon input programs valid Scala programs. The point of having this library sub-project, is that you can use the generated jar for the library sub-project on its own and you should be able to compile Leon testcases with the standard Scala compiler.
Now we can make sure that the build went fine. Leon comes with a test suite.
Use sbt test to run all the tests.
You first need to tell sbt to globally include the Eclipse plugin in its known plugins. To do so type
$ echo "addSbtPlugin(\"com.typesafe.sbteclipse\" % \"sbteclipse-plugin\" % \"2.4.0\")" >> ~/.sbt/0.13/plugins/plugins.sbt
In your Leon home folder, type: sbt clean compile eclipse
This should create all the necessary metadata to load Leon as a project in Eclipse.
You should now be able to import the project into your Eclipse workspace. Don't forget to also import dependencies (the bonsai and scalaSmtlib projects, found somewhere in your ~/.sbt directory).
For each run configuration in Eclipse, you have to set the ECLIPSE_HOME environment variable to point to the home directory of your Eclipse installation. To do so, go to Run -> Run Configuration and then, after picking the configuration you want to run, set the variable in the Environment tab.
If you want to use ScalaTest from within Eclipse, download the ScalaTest plugin. For instructions, see here. Do NOT declare your test packages as nested packages in separate lines, because ScalaTest will not see them for some reason. E.g. don't write
package leon package test package myTestPackage
but instead
package leon.test.myTestPackage
Released 17.02.2015
- Int is now treated as BitVector(32)
- Introduce BigInt for natural numbers
Released 10.02.2015
- Implement support for higher-order functions
Released 03.03.2014
- Accept multiple files with multiple modules/classes. Support class definitions with methods.
- Introduce the Leon library with common generic datastructures, List and Option for now.
- Add PortfolioSolver which tries a list of solvers (--solvers) in parallel.
- Add EnumerationSolver which uses Vanuatoo to guess models.
- Add documentation and sbt support for development under Eclipse,
Released 04.02.2014
- Generics for functions and ADTs
- Use instantiation-time mixing for timeout sovlers
- Improve unrolling solvers to use incremental solvers
Released 10.01.2014
- Reworked TreeOps API
- Tracing evaluators
- Support for range positions
- Support choose() in evaluators
- Flatten functions in results of synthesis
- Improved pretty printers with context information
- First release