- Installation Guide
MicroTESK is a set of Java-based utilities that are run from the command line. It can be used on Windows, Linux and OS X machines that have JDK 1.7 or later installed. To build MicroTESK from source code or to build generated Java models, Apache Ant version 1.8 or later is required. To generate test data based on constraints, MicroTESK needs Z3 or CVC4 that can work under the corresponding operating system.
- Download from http://forge.ispras.ru/projects/microtesk/files and unpack the MicroTESK installation package (the
.tar.gzfile, latest release) to your computer. The folder to which it was unpacked will be further referred to as the installation directory (
- Download and install constraint solver tools to the
<installation dir>/toolsdirectory (see the Installing Constraint Solvers section).
- Declare the MICROTESK_HOME environment variable and set its value to the path to the installation directory (see the Setting Environment Variables section).
- Set the
<installation dir>/binas the working directory (add the path to the
PATHenvironment variable) to be able to run MicroTESK utilities from any path.
- Now you can run the
.bat) script to create a microprocessor model and the
.bat) script to generate test for this model.
Setting Environment Variables¶
- Open the
- Switch to the
- Click on Environment Variables.
- In the
New System Variabledialog specify variable name as
MICROTESK_HOMEand variable value as
OKon all open windows.
- Reopen the command prompt window.
Linux and OS X¶
Add the command below to the
~.bash_profile file (Linux) or the
~/.profile file (OS X):
export MICROTESK_HOME=<installation dir>To start editing the file, type
vi ~/.profile). Changes will be applied after restarting the command-line terminal or reboot. You can also execute the command in your command-line terminal to make temporary changes.
Installing Constraint Solvers¶
To generate test data based on constraints, MicroTESK requires external constraint solvers. The current version supports the Z3 and CVC4 constraint solvers. Constraint solver executables should be downloaded and placed to the
<installation dir>/tools directory.
- Windows users should download Z3 (32 or 64-bit version) from the following page: http://z3.codeplex.com/releases and unpack the archive to the
<installation dir>/tools/z3/windowsdirectory. Note: the executable file path is
- UNIX and Linux users should use one of the links below and and unpack the archive to the
<installation dir>/tools/z3/unixdirectory. Note: the executable file path is
Debian x64 http://z3.codeplex.com/releases/view/101916 Ubuntu x86 http://z3.codeplex.com/releases/view/101913 Ubuntu x64 http://z3.codeplex.com/releases/view/101911 FreeBSD x64 http://z3.codeplex.com/releases/view/101907
- OS X users should download Z3 from http://z3.codeplex.com/releases/view/101918 and unpack the archive to the
<installation dir>/z3/osxdirectory. Note: the executable file path is
- Windows users should download the latest version of CVC4 binary from http://cvc4.cs.nyu.edu/builds/win32-opt/ and save it to the
<installation dir>/tools/cvc4/windowsdirectory as
- Linux users download the latest version of CVC4 binary from http://cvc4.cs.nyu.edu/builds/i386-linux-opt/unstable/ (32-bit version) or http://cvc4.cs.nyu.edu/builds/x86_64-linux-opt/unstable/ (64-bit version) and save it to the
<installation dir>/tools/cvc4/unixdirectory as
- OS X users should download the latest version of CVC4 distribution package from http://cvc4.cs.nyu.edu/builds/macos/ and install it.
The CVC4 binary should be copied to
cvc4or linked to this file name via a symbolic link.
Installation Directory Structure¶
The MicroTESK installation directory contains the following subdirectories:
||Examples of microprocessor specifications and test templates for the described designs|
||Scripts to run features of MicroTESK (modelling and test generation)|
||Documentation on MicroTESK|
||MicroTESK configuration files|
||Generated Java models of the specified microprocessor designs|
||JAR files and Ruby scripts to perform modelling and test generation tasks|
||Source code of MicroTESK|
To generate a Java model of a microprocessor from its nML specification, a user needs to run the
compile.sh script (Unix, Linux, OS X) or the
compile.bat script (Windows). For example, the following command generates a model for the miniMIPS specification:
sh bin/compile.sh arch/demo/minimips/model/minimips.nml
NOTE: Models for all demo specifications are already built and included in the MicroTESK distribution package. So a user can start working with MicroTESK from generating test programs for these models.
To generate a test program, a user needs to use the
generate.sh script (Unix, Linux, OS X) or the
generate.bat script (Windows). The scripts require the following parameters:
- model name;
- test template file.
For example, the command below runs the
euclid.rb test template for the miniMIPS model generated by the command from the previous example and saves the generated test program to an assembler file. The file name is based on values of the
sh bin/generate.sh minimips arch/demo/minimips/templates/euclid.rb
To specify whether Z3 or CVC4 should be used to solve constraints, a user needs to specify the
--solver command-line option as
cvc4 respectively. By default, Z3 will be used. Here is an example:
sh bin/generate.sh -s cvc4 minimips arch/demo/minimips/templates/constraint.rb
More information on command-line options can be found on the Command-Line Options page.