Overview

Version 15 (Stefan Blom, 12 Feb 2013 14:17)

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 12 Stefan Blom
You need mono, version 2.10 or better, to run Boogie.
24 1 Stefan Blom
25 1 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.
26 12 Stefan Blom
* For installing mono, you have many options. For example:
27 12 Stefan Blom
*# Get a binary distribution from http://www.mono-project.com/.
28 12 Stefan Blom
*# Get the sources from http://www.mono-project.com/ and install them.
29 12 Stefan Blom
*# Install using macports:
30 12 Stefan Blom
  <pre>
31 12 Stefan Blom
  sudo port install mono???
32 12 Stefan Blom
  </pre>
33 5 Stefan Blom
34 5 Stefan Blom
35 5 Stefan Blom
h2. Installation.
36 5 Stefan Blom
37 1 Stefan Blom
# Download the zip archive with the binary distribution. E.g. @vct-1.0.zip@.
38 5 Stefan Blom
# Extract the files from the zip archive.
39 1 Stefan Blom
# For easy command line access: add the bin subdirectory to your PATH variable.
40 1 Stefan Blom
41 1 Stefan Blom
h1. Source Distribution.
42 5 Stefan Blom
43 1 Stefan Blom
The source distribution has been structured to allow both command line building with ant and development with eclipse.
44 1 Stefan Blom
45 5 Stefan Blom
h2. Getting the sources.
46 5 Stefan Blom
47 5 Stefan Blom
There are two ways to get the sources:
48 5 Stefan Blom
49 1 Stefan Blom
# Download a zip archive.
50 5 Stefan Blom
# Clone one of the git repositories.
51 5 Stefan Blom
52 1 Stefan Blom
h3. Git repository.
53 10 Stefan Blom
54 7 Stefan Blom
See [[Installing git for windows]].
55 7 Stefan Blom
56 5 Stefan Blom
* SSH based git server.
57 10 Stefan Blom
>> access: create an SSH key pair and email the public key to Stefan.
58 12 Stefan Blom
>> URL: gitshare@sccblom.ewi.utwente.nl:vercors-toolset.git
59 10 Stefan Blom
60 12 Stefan Blom
Note that the git repository has submodules. That is, after cloning one of the git repositories
61 13 Stefan Blom
you must initialize submodules
62 13 Stefan Blom
<pre>
63 13 Stefan Blom
git submodule update --init
64 13 Stefan Blom
</pre>
65 12 Stefan Blom
and after every update, you must synchronize
66 12 Stefan Blom
the submodules:
67 5 Stefan Blom
<pre>
68 12 Stefan Blom
git submodule sync
69 12 Stefan Blom
git submodule update
70 10 Stefan Blom
</pre>
71 5 Stefan Blom
72 5 Stefan Blom
h2. Command line building.
73 5 Stefan Blom
74 9 Stefan Blom
Command line building uses Apache ant. To build the tool set go to the root directory and enter the command 
75 5 Stefan Blom
<pre>
76 5 Stefan Blom
ant
77 5 Stefan Blom
</pre>
78 5 Stefan Blom
To create a distribution enter
79 5 Stefan Blom
<pre>
80 5 Stefan Blom
ant dist
81 5 Stefan Blom
</pre>
82 5 Stefan Blom
83 1 Stefan Blom
h2. Overview of the Modules of the VerCors Tool set
84 8 Stefan Blom
85 11 Stefan Blom
The VerCors tool set is split into several modules plus scripts to make everything work together. The idea behind the modules is that you can choose between command line and eclipse development for each module independently. For detailed configuration instructions for eclipse see [[Eclipse Setup]].
86 8 Stefan Blom
87 9 Stefan Blom
Next, we will give an overview of the modules. The name of the subdirectory of the module is given between parenthesis.
88 5 Stefan Blom
89 5 Stefan Blom
h3. Hybrid Runtime Environment (hre)
90 5 Stefan Blom
91 5 Stefan Blom
depends on: - 
92 5 Stefan Blom
93 5 Stefan Blom
This module contains functionality that has uses outside of the VerCors toolset.
94 5 Stefan Blom
95 5 Stefan Blom
h3. Core Data Structures (core)
96 5 Stefan Blom
97 5 Stefan Blom
depends on: hre
98 5 Stefan Blom
99 5 Stefan Blom
This module contains the main data structures for the VerCors toolset:
100 5 Stefan Blom
* the Common Object Language (COL) Abstract Syntax Tree.
101 5 Stefan Blom
* Pretty printing framework.
102 5 Stefan Blom
* Visitor Patterns for AST.
103 5 Stefan Blom
104 5 Stefan Blom
h3. Main program (main)
105 1 Stefan Blom
106 14 Stefan Blom
depends on: hre, core, clang
107 5 Stefan Blom
108 5 Stefan Blom
The main program of the VerCors verifier Tool (vct).
109 5 Stefan Blom
110 5 Stefan Blom
h3. Java Parser plugin (java-parser)
111 5 Stefan Blom
112 5 Stefan Blom
depends on: hre, core
113 5 Stefan Blom
114 5 Stefan Blom
Parser for Java, written with the JavaCC 5.0 parser generator.
115 5 Stefan Blom
116 5 Stefan Blom
To compile this parser plugin, you may:
117 5 Stefan Blom
* Perform a command line build using ant.
118 5 Stefan Blom
* Perform an eclipse build using the eclipse ant builder.
119 5 Stefan Blom
* Install and use the JavaCC eclipse plugin.
120 5 Stefan Blom
121 5 Stefan Blom
h3. PVL Parser plugin (pvl-parser)
122 5 Stefan Blom
123 5 Stefan Blom
depends on: hre, core
124 5 Stefan Blom
125 1 Stefan Blom
Parser for PVL (toy language used in the program verification course), written with the ANTLR 3.4 parser generator.
126 1 Stefan Blom
127 1 Stefan Blom
To compile this parser plugin, you may:
128 1 Stefan Blom
* Perform a command line build using ant.
129 1 Stefan Blom
* Perform an eclipse build using the eclipse ant builder.
130 1 Stefan Blom
* Install and use the ANTLR v3 eclipse plugin.
131 15 Stefan Blom
132 15 Stefan Blom
h3. CLang Parser plugin (clang-parser)
133 15 Stefan Blom
134 15 Stefan Blom
depends on: hre, core
135 15 Stefan Blom
136 15 Stefan Blom
Parser for C, C++, etc. using the clang/llvm parser.
137 15 Stefan Blom
138 15 Stefan Blom
To compile this parser plugin, you will need to:
139 15 Stefan Blom
* Install clang+llvm version 3.2.
140 15 Stefan Blom
* Configure eclipse to compile this projects.