README 8.98 KB
Newer Older
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
1
2
3
4
5
6
7
8
9
10
11
Overview
========

Spot is a model-checking library developed collaboratively by LRDE
and LIP6. It provides algorithms and data structures to implement
the automata-theoretic approach to LTL model checking.

It is mainly meant to be used as a C++ library, but it also comes with
a few handy command-line utilities, and some (limited) Python
bindings.

12
13
14
15
16
17
18
19
20
21
22
23
24
Keeping in touch
================

If you have questions regarding Spot, a bug reports, please send them
to <spot@lrde.epita.fr>.  This is a public mailing list which you may
subscribe to at https://www.lrde.epita.fr/mailman/listinfo/spot but you
should feel free to post without subscribing.

We also run an extremely low traffic list for announcements of
new releases of Spot.  You may subscribe to that list at
https://www.lrde.epita.fr/mailman/listinfo/spot-announce


25
26
27
28
29
30
31
Installation
============

Requirements
------------

Spot requires a complete installation of Python (version 2.0 or
32
33
34
later).  Especially, Python's headers files should be installed.  If
you don't have Python installed, you should run configure with
the --disable-python option (see below).
35

Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
The Boost libraries should also be installed.


Third-party dependencies
------------------------

Spot also uses a modified version of BuDDy (a binary decision diagram
library), that is already included in the buddy/ directory.  So you
do not need to install it yourself.

Spot used to distribute a modified version of LBTT (an LTL to Büchi
test bench), mostly fixing errors reported by recent compilers.
However Spot now distributes its own reimplementation of LBTT, called
ltlcross, so the use of LBTT is completely optional.  The last
modified version of LBTT we used to distribute can now be found at
  http://spot.lip6.fr/dl/lbtt-1.2.1a.tar.gz
If some lbtt binary is found on your system, it will be used in the
test suite in addition to ltlcross.
54
55
56
57
58
59
60
61
62


Building and installing
-----------------------

Spot follows the traditional `./configure && make && make check &&
make install' process.  People unfamiliar with the GNU Build System
should read the file INSTALL for generic instructions.

63
In addition to its usual options, ./configure will accept some
64
65
66
67
68
69
70
71
72
73
74
75
76
flags specific to Spot:

  --with-gspn=DIR
    Turns on GreatSPN support.  DIR should designate the root of
    GreatSPN source tree.  (./configure will then run
    DIR/SOURCES/contrib/version.sh to find the GreatSPN build tree.)

    GreatSPN had to be modified in order to be used as a library
    (thanks Soheib Baarir and Yann Thierry-Mieg for this work), and
    presently these modifications are only available on the GreatSPN
    CVS repository hosted by the Università di Torino.

  --with-included-buddy
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
77
78
79
80
81
82
83
    After you have installed Spot the first time, a modified version
    of BuDDy will be installed.  The next time you reconfigure Spot,
    configure will detect that this version is already installed, and
    will attempt to use it directly (this is in case you had to modify
    one of these yourself for another purpose).  This option will
    *force* the use, build, and installation of the included version
    of BuDDy, even when a compatible version is already installed.
84

85
86
87
88
89
90
91
  --disable-python
    Turn off the compilation of Python bindings.  These bindings are
    currently used to run a couple of tests, and to build the CGI
    script that translates LTL formulae on-line.  You may safely
    disable these, especially if you do not have a working Python
    installation or if you are attempting some cross-compilation.

92
93
  --enable-devel
    Enable debugging symbols, turn off aggressive optimizations, and
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
94
    turn on assertions.  This option is effective by default in
95
    development versions (version numbers ending with a letter).
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
    It is equivalent to
      --enable-debug
      --enable-warnings
      --enable-assert
      --enable-optimizations=-O
  --disable-devel
    Disable development options.  This is the case by default in
    releases (version numbers NOT ending with a letter).
    It is equivalent to
      --disable-debug
      --disable-warnings
      --disable-assert
      --enable-optimizations

Here are the meaning of the fine-tuning options, in case
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
111
--enable/disable-devel is not enough.
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131

  --disable-assert
  --enable-assert
    Control assertion checking.

  --disable-warnings
  --enable-warnings
    Whether warnings should be output.  Note that during development
    we consider warnings to be errors.

  --disable-debug
  --enable-debug
    Whether to compile extra debugging code.

  --enable-optimizations
  --enable-optimizations=FLAGS
  --disable-optimizations
    Whether the compilation should be optimized.  When FLAGS are
    given, use these as optimization flags.  Otherwise, pick working
    flags from a built-in list.
132
133


Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
Documentation
=============

Some documentation can be found in the doc/ directory.

- doc/spot.html/ contains documentation for the C++ library.

- doc/tl/tl.pdf contains documentation about the various temporal
  logic operators supported by Spot

"make install" will install man pages for command-line tools.  (These
man pages can also be found in the src/bin/man/ subdirectory of the
source tree.)  Additional documentation about these tools can be
found on-line at http://spot.lip6.fr/userdoc/tools.html



151
152
153
154
155
156
Layout of the source tree
=========================

Core directories
----------------

157
src/              Sources for libspot.
158
159
   bin/           User tools built using the Spot library.
      man/        Man pages for the above tools.
160
   dstarparse/    Parser for the output of ltl2dstar.
161
162
   eltlparse/     Parser for ELTL formulae.
   eltltest/      Tests for ELTL nodes in ltlast/ and eltlparse/.
163
   kripke/        Kripke Structure interface.
164
165
   kripkeparse/   Parser for explicit Kripke.
   kripketest/    Tests for kripke explicit.
166
167
168
169
170
171
   ltlast/        LTL abstract syntax tree (including nodes for ELTL).
   ltlenv/        LTL environments.
   ltlparse/      Parser for LTL formulae.
   ltlvisit/      Visitors of LTL formulae.
   ltltest/       Tests for ltlast/, ltlenv/, ltlparse/, and ltlvisit/.
   misc/          Miscellaneous support files.
172
173
   neverparse/    Parser for SPIN never claims.
   priv/          Private algorithms, used internally but not exported.
174
175
176
177
   tgba/          TGBA objects and cousins.
   tgbaalgos/     Algorithms on TGBA.
      gtec/       Couvreur's Emptiness-Check.
   tgbaparse/     Parser for explicit TGBA.
178
179
180
   ta/            TA objects and cousins (TGTA).
   taalgos/       Algorithms on TA/TGTA.
   tgbatest/      Tests for tgba/, tgbaalgos/, tgbaparse/, ta/ and taalgos/.
181
182
183
184
185
   saba/          SABA (State-labeled Alternating Büchi Automata) objects.
   sabaalgos/     Algorithms on SABA.
   sabatest/      Tests for saba/, sabaalgos/.
   sanity/        Sanity tests for the whole project.
doc/              Documentation for libspot.
186
   org/           Source of userdoc/ as org-mode files.
187
   tl/            Documentation of the Temporal Logic operators.
188
   userdoc/       HTML documentation about the command-line tools.
189
   spot.html/     HTML reference manual for the library.
190
191
192
193
bench/            Benchmarks for ...
   emptchk/       ... emptiness-check algorithms,
   ltl2tgba/      ... LTL-to-Büchi translation algorithms,
   ltlcounter/    ... translation of a class of LTL formulae,
194
   ltlclasses/    ... translation of more classes of LTL formulae,
195
   scc-stats/     ... SCC statistics after translation of LTL formulae,
196
   split-product/ ... parallelizing gain after splitting LTL automata,
197
   spin13/        ... compositional suspension and other improvements,
198
   wdba/          ... WDBA minimization (for obligation properties).
199
200
201
wrap/             Wrappers for other languages.
   python/        Python bindings for Spot and BuDDy
      tests/      Tests for these bindings
202
      ajax/       LTL-to-TGBA translator with web interface, using Ajax.
203
iface/            Interfaces to other libraries.
204
   dve2/          Interface with DiVinE2.
205
206
   gspn/          GreatSPN interface.
      examples/   Supporting models used by the test cases.
207
208
209

Third party software
--------------------
210

Guillaume Sadegh's avatar
Guillaume Sadegh committed
211
buddy/            A patched version of BuDDy 2.3 (a BDD library).
212
ltdl/             Libtool's portable dlopen() wrapper library.
213
lib/              Gnulib's portability modules.
214

215
216
Build-system stuff
------------------
217
218
219

m4/      M4 macros used by configure.ac.
tools/   Helper scripts used during the build.
Alexandre Duret-Lutz's avatar
Alexandre Duret-Lutz committed
220
221
222
223
224
225
226
227
228

-------------------------------------------------------------------------------
Local Variables:
mode: text
End:

 LocalWords:  Python's BuDDy LBTT LTL Büchi lbtt gspn DIR GreatSPN Soheib Yann
 LocalWords:  Baarir Thierry Mieg CVS Università di Torino devel src libspot ac
 LocalWords:  ltlast ltlenv ltlparse ltlvisit ltltest misc tgba TGBA tgbaalgos
229
 LocalWords:  gtec Tarjan tgbaparse tgbatest doc html PDF spotref pdf cgi ELTL
230
 LocalWords:  CGI ltl iface BDD Couvreur's emptchk kripke Kripke saba vm
231
 LocalWords:  eltlparse eltltest SABA sabaalgos sabatest ssp ltlcouter scc SCC
232
233
234
LocalWords:  formulae optimizations kripkeparse kripketest Automata
LocalWords:  neverparse ltlcounter ltlclasses parallelizing automata
LocalWords:  wdba WDBA ajax dve DiVinE ltdl Libtool's dlopen