Overview

Version 18 (Stefan Blom, 12 Jul 2013 16:45)

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