Overview

Version 10 (Stefan Blom, 03 Oct 2012 14:50)

1 1 Stefan Blom
h1. Overview
2 1 Stefan Blom
3 3 Stefan Blom
The "VerCors project":http://fmt.ewi.utwente.nl/research/projects/VerCors/ is about Verification of Concurrent Data Structures.
4 1 Stefan Blom
5 1 Stefan Blom
The VerCors toolset currently consists of two tools:
6 2 Stefan Blom
* "Histogram":http://fmt.ewi.utwente.nl/tools/histogram: a tool for creating Histograms of class/method occurrences.
7 2 Stefan Blom
* [[Verifier Overview|The VerCors verifier]]: an annotated code compiler/verifier.
8 4 Stefan Blom
9 5 Stefan Blom
h1. Binary Distribution
10 1 Stefan Blom
11 5 Stefan Blom
This chapter is about installing the binary version.
12 5 Stefan Blom
13 1 Stefan Blom
h2. Prerequisites
14 1 Stefan Blom
15 10 Stefan Blom
To run the binary version, you will need a Java Runtime Environment. Note that the toolset has been tested with the Oracle Java 1.6 SE and 1.7 SE SDKs. Compatibility with other JVMs is untested.
16 5 Stefan Blom
17 5 Stefan Blom
h3. Windows
18 5 Stefan Blom
19 5 Stefan Blom
The binary distribution requires no non-standard components.
20 5 Stefan Blom
21 5 Stefan Blom
h3. Linux and MacOSX
22 5 Stefan Blom
23 5 Stefan Blom
The following two packages are needed:
24 5 Stefan Blom
25 5 Stefan Blom
* wine (no known version requirements)
26 5 Stefan Blom
* mono (2.10 or better)
27 1 Stefan Blom
28 1 Stefan Blom
*Linux notes*
29 1 Stefan Blom
30 10 Stefan Blom
* All common Linux distributions include a package for wine, so it may be installed using the package manager of your distribution.
31 10 Stefan Blom
* Not all common Linux distributions include a sufficiently up-to-date version of mono. Thus you may need to download sources from http://www.mono-project.com/ and follow instructions on how to compile them.
32 5 Stefan Blom
33 5 Stefan Blom
*MacOSX notes*
34 5 Stefan Blom
35 10 Stefan Blom
Unfortunately, we do not know of any binary distribution of wine on MacOSX. Thus, we recommend installing macports (http://www.macports.org/) and then installing wine:
36 5 Stefan Blom
<pre>
37 5 Stefan Blom
sudo port install wine
38 5 Stefan Blom
</pre>
39 5 Stefan Blom
40 5 Stefan Blom
For installing mono, you have two options:
41 5 Stefan Blom
# Get a binary distribution from http://www.mono-project.com/
42 5 Stefan Blom
# Install using macports:
43 5 Stefan Blom
<pre>
44 5 Stefan Blom
sudo port install mono???
45 5 Stefan Blom
</pre>
46 5 Stefan Blom
47 5 Stefan Blom
48 5 Stefan Blom
h2. Installation.
49 5 Stefan Blom
50 5 Stefan Blom
# Download the zip archive with the binary distribution. E.g. @vct-1.0.zip@.
51 5 Stefan Blom
# Extract the files from the zip archive.
52 5 Stefan Blom
# For easy command line access: add the bin subdirectory to your PATH variable.
53 5 Stefan Blom
54 5 Stefan Blom
h1. Source Distribution.
55 5 Stefan Blom
56 5 Stefan Blom
The source distribution has been structured to allow both command line building with ant and development with eclipse.
57 1 Stefan Blom
58 5 Stefan Blom
h2. Getting the sources.
59 5 Stefan Blom
60 5 Stefan Blom
There are two ways to get the sources:
61 5 Stefan Blom
62 1 Stefan Blom
# Download a zip archive.
63 5 Stefan Blom
# Clone one of the git repositories.
64 1 Stefan Blom
65 10 Stefan Blom
h3. Git repository.
66 7 Stefan Blom
67 7 Stefan Blom
See [[Installing git for windows]].
68 5 Stefan Blom
69 10 Stefan Blom
* SSH based git server.
70 5 Stefan Blom
>> URL: gitshare@sccblom.ewi.utwente.nl:vercors-toolset.git
71 10 Stefan Blom
>> access: create an SSH key pair and email the public key to Stefan.
72 5 Stefan Blom
73 10 Stefan Blom
Note that the git repository has submodules. That is, after cloning one of the git repositories, you must initialize the sub modules:
74 5 Stefan Blom
<pre>
75 5 Stefan Blom
git submodule update --init
76 5 Stefan Blom
</pre>
77 10 Stefan Blom
Note that git does not automatically update submodules if you pull or check out a new version.
78 10 Stefan Blom
So further updates are likely to be needed.
79 5 Stefan Blom
80 5 Stefan Blom
h2. Command line building.
81 5 Stefan Blom
82 9 Stefan Blom
Command line building uses Apache ant. To build the tool set go to the root directory and enter the command 
83 5 Stefan Blom
<pre>
84 5 Stefan Blom
ant
85 5 Stefan Blom
</pre>
86 5 Stefan Blom
To create a distribution enter
87 5 Stefan Blom
<pre>
88 5 Stefan Blom
ant dist
89 5 Stefan Blom
</pre>
90 5 Stefan Blom
91 1 Stefan Blom
h2. Overview of the Modules of the VerCors Tool set
92 8 Stefan Blom
93 9 Stefan Blom
The VerCors tool set is split into several modules plus scripts to make everything work together. You cannot use eclipse to manage the VerCors tool set. You can use eclipse to work on each module. For detailed configuration instructions for eclipse see [[Eclipse Setup]].
94 8 Stefan Blom
95 9 Stefan Blom
Next, we will give an overview of the modules. The name of the subdirectory of the module is given between parenthesis.
96 5 Stefan Blom
97 5 Stefan Blom
h3. Hybrid Runtime Environment (hre)
98 5 Stefan Blom
99 5 Stefan Blom
depends on: - 
100 5 Stefan Blom
101 5 Stefan Blom
This module contains functionality that has uses outside of the VerCors toolset.
102 5 Stefan Blom
103 5 Stefan Blom
h3. Core Data Structures (core)
104 5 Stefan Blom
105 5 Stefan Blom
depends on: hre
106 5 Stefan Blom
107 5 Stefan Blom
This module contains the main data structures for the VerCors toolset:
108 5 Stefan Blom
* the Common Object Language (COL) Abstract Syntax Tree.
109 5 Stefan Blom
* Pretty printing framework.
110 5 Stefan Blom
* Visitor Patterns for AST.
111 5 Stefan Blom
112 5 Stefan Blom
h3. Main program (main)
113 5 Stefan Blom
114 5 Stefan Blom
depends on: hre, core
115 5 Stefan Blom
116 5 Stefan Blom
The main program of the VerCors verifier Tool (vct).
117 5 Stefan Blom
118 5 Stefan Blom
h3. Java Parser plugin (java-parser)
119 5 Stefan Blom
120 5 Stefan Blom
depends on: hre, core
121 5 Stefan Blom
122 5 Stefan Blom
Parser for Java, written with the JavaCC 5.0 parser generator.
123 5 Stefan Blom
124 5 Stefan Blom
To compile this parser plugin, you may:
125 5 Stefan Blom
* Perform a command line build using ant.
126 5 Stefan Blom
* Perform an eclipse build using the eclipse ant builder.
127 5 Stefan Blom
* Install and use the JavaCC eclipse plugin.
128 5 Stefan Blom
129 5 Stefan Blom
h3. PVL Parser plugin (pvl-parser)
130 5 Stefan Blom
131 5 Stefan Blom
depends on: hre, core
132 5 Stefan Blom
133 5 Stefan Blom
Parser for PVL (toy language used in the program verification course), written with the ANTLR 3.4 parser generator.
134 5 Stefan Blom
135 5 Stefan Blom
To compile this parser plugin, you may:
136 5 Stefan Blom
* Perform a command line build using ant.
137 5 Stefan Blom
* Perform an eclipse build using the eclipse ant builder.
138 5 Stefan Blom
* Install and use the ANTLR v3 eclipse plugin.