Overview

Version 16 (Stefan Blom, 08 Apr 2013 13:51)

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