Project

General

Profile

Installation Guide » History » Version 42

Andrei Tatarnikov, 03/21/2014 12:39 PM

1 1 Andrei Tatarnikov
h1. Installation Guide
2
3 22 Andrei Tatarnikov
_~By Andrei Tatarnikov~_
4
5 36 Alexander Kamkin
{{toc}}
6
7 17 Andrei Tatarnikov
h3. System Requirements
8 1 Andrei Tatarnikov
9 41 Alexander Kamkin
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.6 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 *_Microsoft Research Z3_* that can work under the corresponding operating system. 
10 1 Andrei Tatarnikov
11 17 Andrei Tatarnikov
h3. Installation Steps
12 1 Andrei Tatarnikov
13 33 Alexander Kamkin
# Download from http://forge.ispras.ru/projects/microtesk/files and unpack the MicroTESK installation package (the @.tar.gz@ file, latest release) to your computer.
14 40 Alexander Kamkin
# Download and install constraint solver tools to the @<installation dir>/tools@ directory (see the *Installing Constraint Solvers* section).
15
# Set the @<installation dir>/bin@ as the working directory (add the path to the @PATH@ environment variable).
16 33 Alexander Kamkin
# Now you can run the @compile.sh@ (or @.bat@) script to create a microprocessor model and the @generate.sh@ (or @.bat@) script to generate test for this model.
17 13 Andrei Tatarnikov
18 32 Alexander Kamkin
h3. Installing Constraint Solvers
19 15 Andrei Tatarnikov
20 40 Alexander Kamkin
To generate test data based on constraints, MicroTESK requires external constraint solver engines. The current version uses the Z3 constraint solver by Microsoft Research (http://z3.codeplex.com/). The Z3 executable should be downloaded and placed to the @<installation dir>/tools@ directory.
21 18 Andrei Tatarnikov
22 40 Alexander Kamkin
* Windows users should download Z3 (32 or 64-bit version) from the following page: http://z3.codeplex.com/releases, unpack the archive and place the @z3.exe@ file to the @<installation dir>/tools/z3/windows@ directory.
23 1 Andrei Tatarnikov
24 40 Alexander Kamkin
* UNIX and Linux users should use one of the links below and place the @z3@ executable file to the @<installation dir>/tools/z3/unix/z3@ directory.
25 34 Alexander Kamkin
| Debian  x64 | http://z3.codeplex.com/releases/view/101916 |
26
| Ubuntu  x86 | http://z3.codeplex.com/releases/view/101913 |
27
| Ubuntu  x64 | http://z3.codeplex.com/releases/view/101911 |
28
| FreeBSD x64 | http://z3.codeplex.com/releases/view/101907 |
29 21 Andrei Tatarnikov
30 40 Alexander Kamkin
* OS X users should download Z3 from http://z3.codeplex.com/releases/view/101918 and place the @z3@ executable file to the @<installation dir>/z3/osx/z3@ directory.
31 15 Andrei Tatarnikov
32 40 Alexander Kamkin
h3. Installation Directory Structure
33 13 Andrei Tatarnikov
34 40 Alexander Kamkin
The MicroTESK installation directory contains the following subdirectories:
35 13 Andrei Tatarnikov
36 33 Alexander Kamkin
| @arch@   | Examples of microprocessor specifications and test templates for the described designs |
37
| @bin@    | Scripts to run features of MicroTESK (modelling and test generation) |
38
| @doc@    | Documentation on MicroTESK and nML/Sim-nML |
39
| @libs@   | JAR files and Ruby scripts to perform modelling and test generation tasks |
40
| @output@ | Generated Java models of the specified microprocessor designs |
41 14 Andrei Tatarnikov
42
h3. Running MicroTESK
43 26 Andrei Tatarnikov
44 27 Andrei Tatarnikov
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 from a MIPS ISA specification:
45 26 Andrei Tatarnikov
46
<pre>
47 42 Andrei Tatarnikov
sh compile.sh ../arch/mips/model/mips.nml
48 27 Andrei Tatarnikov
</pre>
49
50 33 Alexander Kamkin
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: (1) _model name_ , (2) _test template file_ and (3) _target test program source code file_. For example, the following command runs the @mips_demo.rb@ test template for the MIPS model generated by the command from the previous example and saves the generated test program to the @test.asm@ file:
51 27 Andrei Tatarnikov
52
<pre>
53 42 Andrei Tatarnikov
sh generate.sh mips ../arch/mips/templates/mips_demo.rb test.asm
54 26 Andrei Tatarnikov
</pre>