diff --git a/.gitignore b/.gitignore
index 6dc8502ab01c6bcd9dd1ec36a31219a7a0ef92ba..645b2f60263e1bdaa7ef466ffac5a1bee3eaf21a 100644
--- a/.gitignore
+++ b/.gitignore
@@ -23,4 +23,36 @@ sasa-*.dot
tools/test/compare_bfs_dfs/DotsTank
tools/test/compare_bfs_dfs/*log
luretteSession.ml
-test/debug_sasa/
\ No newline at end of file
+test/debug_sasa/
+*.untracked
+*.hide
+*.bak
+*.dot
+_esy/
+essais/
+esy.lock/
+expe-save/
+expe/
+guides/Makefile
+guides/contributors/flymd.md
+guides/users/_html/
+guides/users/my-rdbg-tuning.ml
+guides/users/sasabatch.eps
+guides/users/sasabatch.jpg
+guides/users/sh/
+guides/users/test
+log
+node_modules/.cache/
+test/async-unison/grid.doth
+test/async-unison/grid4.fig
+test/async-unison/grid4.jpg
+test/async-unison/grid4.ml
+test/async-unison/ring.ml
+test/async-unison/test_rdbg.ml
+test/bfs-spanning-tree/META
+test/bfs-spanning-tree/dot2.ml
+test/bfs-spanning-tree/luretteSession1/
+test/dfs-list/log
+test/dfs/x.ml
+test/old/
+
diff --git a/guides/users/README.md b/guides/users/README.md
index 2bc7c3ed34db5dee083301f7c099c48a6cc90795..2438d94710c533e4cbc810171a6bbfeb393f6da0 100644
--- a/guides/users/README.md
+++ b/guides/users/README.md
@@ -1,34 +1,34 @@
-- [TL;DR](#orgc2cabd3)
-- [Topology](#org4b585e5)
-- [Algorithms](#org64c16fc)
-- [Examples](#orgd093f23)
-- [Batch mode](#org341c3c0)
- - [Running batch simulations with Built-in daemons](#orgd196033)
- - [Running batch simulations with manual daemons](#orgad24fb9)
- - [Running batch simulations with `lurette`](#org063119a)
- - [Viewing Results](#org17ee087)
- - [The `sasa` CLI](#orgd22c6eb)
-- [Interactive mode](#org7e42662)
- - [Example: use `rdbg` from the `test/alea-coloring/` directory](#org77d4010)
- - [The exemples of test directory](#org2c0dc88)
- - [Running interactive sessions with `rdbg`](#org88109e3)
- - [Getting `rdbg` on-line help](#orgc9897b0)
- - [Useful Modules](#orgcfdcf07)
-- [Install](#orgdc4beab)
- - [Via opam 2 (prefered method for linux users)](#orge971f77)
- - [Via docker (prefered method for mac users)](#orgcc52ef1)
- - [From source](#org5fed492)
-- [More](#orgd027067)
-- [FAQ](#orgff3477e)
- - [Is there a FAQ?](#org7d94f98)
-
-
-
-<a id="orgc2cabd3"></a>
+- [TL;DR](#org9367125)
+- [Topology](#org2d41527)
+- [Algorithms](#orge6f8b80)
+- [Examples](#org2a8752d)
+- [Batch mode](#org73f33fd)
+ - [Running batch simulations with Built-in daemons](#org35b0e86)
+ - [Running batch simulations with manual daemons](#orgf509ccb)
+ - [Running batch simulations with `lurette`](#org3e61460)
+ - [Viewing Results](#org9914b1d)
+ - [The `sasa` CLI](#orgf221803)
+- [Interactive mode](#orgf399d3c)
+ - [Example: use `rdbg` from the `test/alea-coloring/` directory](#orgaf0442a)
+ - [The exemples of test directory](#orgb5c182d)
+ - [Running interactive sessions with `rdbg`](#org75dd273)
+ - [Getting `rdbg` on-line help](#org4d4554d)
+ - [Useful Modules](#orgb9afd45)
+- [Install](#org0d70849)
+ - [Via opam (version >= 2.\*)](#orgde130b4)
+ - [Via docker](#org6a5861b)
+ - [From source](#org6b02600)
+- [More](#org2328b38)
+- [FAQ](#org0c9f6ca)
+ - [Is there a FAQ?](#org8c880d7)
+
+
+
+<a id="org9367125"></a>
# TL;DR
-<a id="org357fa28"></a> SASA is a **Self-stabilizing Algorithms SimulAtor**, based on the so-called **Atomic State model** (ASM) introduced by <span class="underline">Dijkstra</span> in its seminal article on [Self-stabilizing distributed algorithms](http://www.cs.utexas.edu/~EWD/ewd04xx/EWD426.PDF).
+<a id="org4b56b57"></a> SASA is a **Self-stabilizing Algorithms SimulAtor**, based on the so-called **Atomic State model** (ASM) introduced by <span class="underline">Dijkstra</span> in its seminal article on [Self-stabilizing distributed algorithms](http://www.cs.utexas.edu/~EWD/ewd04xx/EWD426.PDF).
Basically, one needs to provide:
@@ -45,12 +45,14 @@ make ring.cmxs
sasa ring.dot
```
-The source code is available at <https://gricad-gitlab.univ-grenoble-alpes.fr/verimag/synchrone/sasa>
+SASA source code: <https://gricad-gitlab.univ-grenoble-alpes.fr/verimag/synchrone/sasa>
+
+Some Tutorials: <https://verimag.gricad-pages.univ-grenoble-alpes.fr/vtt/tags/sasa/>
[](http://www-verimag.imag.fr/DIST-TOOLS/SYNCHRONE/sasa/poster.pdf)
-<a id="org4b585e5"></a>
+<a id="org2d41527"></a>
# Topology
@@ -113,11 +115,11 @@ Such parameters can be retreived in Algorithms using the `Algo.get_graph_attribu
nb: a `Algo.diameter: unit -> int` function is provided, but it can be expensive to use.
-<a id="org64c16fc"></a>
+<a id="orge6f8b80"></a>
# Algorithms
-<a id="org6d64c78"></a>
+<a id="orgad9829e"></a>
The following has been generated from [algo.mli](https://gricad-gitlab.univ-grenoble-alpes.fr/verimag/synchrone/sasa/blob/master/lib/algo/algo.mli)
@@ -127,7 +129,7 @@ The following has been generated from [algo.mli](https://gricad-gitlab.univ-gren
</div>
-<a id="orgd093f23"></a>
+<a id="org2a8752d"></a>
# Examples
@@ -155,14 +157,14 @@ The `test` directory also contains sub-directories which gathers programs shared
- `test/*/my-rdbg-tuning.ml`: includes `test/my-rdbg-tuning.ml` and defines commands specific to the example of the directory. Indeed, `rdbg`, once launched, first tries to read the content of the file name `my-rdbg-tuning.ml` (it it exists).
-<a id="org341c3c0"></a>
+<a id="org73f33fd"></a>
# Batch mode
-<a id="orgd196033"></a>
+<a id="org35b0e86"></a>
## Running batch simulations with Built-in daemons
@@ -187,7 +189,7 @@ sasa -h | grep "\-daemon"
--custom-daemon, -custd
-<a id="orgad24fb9"></a>
+<a id="orgf509ccb"></a>
## Running batch simulations with manual daemons
@@ -214,7 +216,7 @@ It can also by simulated by [`lutin`](http://www-verimag.imag.fr/DIST-TOOLS/SYNC
Built-in daemons can of course be programmed in Lutin. One can generate such daemons using the `--gen-lutin-daemon` option: `sasa --gen-lutin-daemon a_graph.dot`. It can be handy at least to get the daemons variables names in the good order if one to write its own daemon.
-<a id="org063119a"></a>
+<a id="org3e61460"></a>
## Running batch simulations with `lurette`
@@ -237,14 +239,14 @@ lurette \
```
-<a id="org17ee087"></a>
+<a id="org9914b1d"></a>
## Viewing Results
`sasa -rif` and `lurette` generates `.rif` files that can be viewed with `gnuplot-rif` or `sim2chro`; cf <http://www-verimag.imag.fr/DIST-TOOLS/SYNCHRONE/reactive-toolbox/>
-<a id="orgd22c6eb"></a>
+<a id="orgf221803"></a>
## The `sasa` CLI
@@ -307,14 +309,14 @@ sasa --more
Display the version ocaml version sasa was compiled with and exit.
-<a id="org7e42662"></a>
+<a id="orgf399d3c"></a>
# Interactive mode
-<a id="org707dffe"></a> If you want to perform interactive session, you can launch `sasa` under the control of [rdbg](http://www-verimag.imag.fr/DIST-TOOLS/SYNCHRONE/rdbg/). Before reading this section, please read at least the [Basic usage Section if the rdbg documentation](http://www-verimag.imag.fr/DIST-TOOLS/SYNCHRONE/rdbg/README.html#Level0).
+<a id="org0b12538"></a> If you want to perform interactive session, you can launch `sasa` under the control of [rdbg](http://www-verimag.imag.fr/DIST-TOOLS/SYNCHRONE/rdbg/). Before reading this section, please read at least the [Basic usage Section if the rdbg documentation](http://www-verimag.imag.fr/DIST-TOOLS/SYNCHRONE/rdbg/README.html#Level0).
-<a id="org77d4010"></a>
+<a id="orgaf0442a"></a>
## Example: use `rdbg` from the `test/alea-coloring/` directory
@@ -367,7 +369,7 @@ $ rdbg
Typing `[Enter]` will therefore also load the `rdbg_session.ml` file we have just been using.
-<a id="org2c0dc88"></a>
+<a id="orgb5c182d"></a>
## The exemples of test directory
@@ -378,7 +380,7 @@ The [test](https://gricad-gitlab.univ-grenoble-alpes.fr/verimag/synchrone/sasa/t
- `test/*/my-rdbg-tuning.ml`: includes `test/my-rdbg-tuning.ml` and defines commands specific to the example of the directory. Indeed, `rdbg`, once launched, first tries to read the content of the file name `my-rdbg-tuning.ml` (it it exists).
-<a id="org88109e3"></a>
+<a id="org75dd273"></a>
## Running interactive sessions with `rdbg`
@@ -395,7 +397,7 @@ The [test](https://gricad-gitlab.univ-grenoble-alpes.fr/verimag/synchrone/sasa/t
All those commands are defined in (the common) [test/my-rdbg-tuning.ml](https://gricad-gitlab.univ-grenoble-alpes.fr/verimag/synchrone/sasa/tree/master/test/my-rdbg-tuning.ml) that is included in (locals) `test/*/my-rdbg-tuning.ml` that are included in (generated) `test/*/rdbg-session.ml` files. `my-rdbg-tuning.ml` contains straigthforward `ocaml` code that defines various `rdbg` shortcuts to ease the simulation of `sasa` systems. Feel free to tailor those command to yours needs by modyfying the local `my-rdbg-tuning.ml`!
-<a id="orgc9897b0"></a>
+<a id="org4d4554d"></a>
## Getting `rdbg` on-line help
@@ -408,10 +410,10 @@ Here are 2 useful entry-points to rdbg on-line help:
(rdbg) l
```
- 9bf78f64b677001b1010261a371e4e6f
+ c9cd78a2ac92a288a510d00507f8d785
-<a id="orgcfdcf07"></a>
+<a id="orgb9afd45"></a>
## Useful Modules
@@ -438,25 +440,38 @@ Some modules, used by the sasa core engine, can be useful from `rdbg`.
</div>
-<a id="orgdc4beab"></a>
+<a id="org0d70849"></a>
# Install
+In any case, you need to install the [graphviz](https://en.wikipedia.org/wiki/DOT_(graph_description_language)) tools suite and a pdf viewer that is able to auto-refresh (for instance `zathura`).
+
-<a id="orge971f77"></a>
+<a id="orgde130b4"></a>
-## Via opam 2 (prefered method for linux users)
+## Via opam (version >= 2.\*)
-One way to install `sasa` is via [opam](http://opam.ocaml.org/doc/Install.html), a package manager for ocaml programs. opam works out of the box with most Linux distributions and OSX (mac). opam ougth to work on windows too [(follow this link for instructions)](http://protz.github.io/ocaml-installer/).
+One way to install `sasa` is via [opam](http://opam.ocaml.org/doc/Install.html), a package manager for `ocaml` programs. `opam` works out of the box with most Linux distributions and OSX (mac). `opam` ougth to work [on windows too](http://protz.github.io/ocaml-installer/).
-Once opam is installed and configured:
+Once opam (version >= 2.\*!) is installed and configured:
```sh
-opam repo add verimag-sync-repo "http://www-verimag.imag.fr/DIST-TOOLS/SYNCHRONE/opam-repository"
+opam switch create 4.09.0
+eval $(opam env)
+opam repo add -a verimag-sync-repo "http://www-verimag.imag.fr/DIST-TOOLS/SYNCHRONE/opam-repository"
opam update -y
opam install -y sasa
```
+nb: the `opam switch create 4.09.0`, which installs an `4.09.0` version of `ocaml`, should not be necessary in theory. If you don't do that, `opam` uses the `ocaml` of your system distribution. But in practice, `opam` tends to work better when working with one on its own switches.
+
+If you want to be able to defined daemons in Lutin, or test oracles in Lustre, you can also install the following packages.
+
+```sh
+opam depext -y lutin lustre-v6
+opam install -y lutin lustre-v6
+```
+
Once this is done, upgrading to the last version of the tools is as simple as:
```yaml
@@ -464,24 +479,17 @@ opam update
opam upgrade
```
-In order to install the tools mentionned in this documentation that can be used with `sasa` (namely, `gnuplot-rif`, `lutin`, `lurette`, `rdbg`, `lv6`)):
-
-```sh
-opam depext -y rdbg lutin lustre-v6
-opam install -y rdbg lutin lustre-v6
-```
-
-In order to be able to use `luciole` and `sim2chro`, you need to install the Lustre V4 distribution: <http://www-verimag.imag.fr/DIST-TOOLS/SYNCHRONE/lustre-v4/distrib/index.html>
+In order to be able to use `luciole` and `sim2chro`, you also need to install the Lustre V4 distribution: <http://www-verimag.imag.fr/DIST-TOOLS/SYNCHRONE/lustre-v4/distrib/index.html>
-<a id="orgcc52ef1"></a>
+<a id="org6a5861b"></a>
-## Via docker (prefered method for mac users)
+## Via docker
cf the Docker Install section of the [Synchrone Reactive Tool Box](http://www-verimag.imag.fr/DIST-TOOLS/SYNCHRONE/lustre-v6/#docker).
-<a id="org5fed492"></a>
+<a id="org6b02600"></a>
## From source
@@ -501,7 +509,7 @@ opam install dune ocamlgraph rdbg lutin
One can mimick the content of the `test` job in the project [.gitlab-ci.yml Gitlab CI script](https://gricad-gitlab.univ-grenoble-alpes.fr/verimag/synchrone/sasa/tree/master/.gitlab-ci.yml).
-<a id="orgd027067"></a>
+<a id="org2328b38"></a>
# More
@@ -510,15 +518,15 @@ One can mimick the content of the `test` job in the project [.gitlab-ci.yml Gitl
- Tutorials: <https://verimag.gricad-pages.univ-grenoble-alpes.fr/vtt//categories/sasa/>
-<a id="orgff3477e"></a>
+<a id="org0c9f6ca"></a>
# FAQ
-<a id="org7d94f98"></a>
+<a id="org8c880d7"></a>
## Is there a FAQ?
yes
-Some Tutorials are also available here: <https://verimag.gricad-pages.univ-grenoble-alpes.fr/vtt//categories/sasa/>
+Some Tutorials are also available here: <https://verimag.gricad-pages.univ-grenoble-alpes.fr/vtt/tags/sasa/>
diff --git a/guides/users/README.org b/guides/users/README.org
index 56c9a36c3891d7d649f419e2c6ded98f2df9efc4..92961437c91966e4e7b5f3e3c708735c8ab6d61b 100644
--- a/guides/users/README.org
+++ b/guides/users/README.org
@@ -36,8 +36,10 @@ make ring.cmxs
sasa ring.dot
#+END_SRC
-The source code is available at
-https://gricad-gitlab.univ-grenoble-alpes.fr/verimag/synchrone/sasa
+SASA source code: https://gricad-gitlab.univ-grenoble-alpes.fr/verimag/synchrone/sasa
+
+
+Some Tutorials: https://verimag.gricad-pages.univ-grenoble-alpes.fr/vtt/tags/sasa/
#+attr_html: :width 300px
[[http://www-verimag.imag.fr/DIST-TOOLS/SYNCHRONE/sasa/poster.pdf][file:poster.png]]
@@ -463,21 +465,41 @@ Some modules, used by the sasa core engine, can be useful from =rdbg=.
* Install
-** Via opam 2 (prefered method for linux users)
+In any case, you need to install the [[https://en.wikipedia.org/wiki/DOT_(graph_description_language)][graphviz]] tools suite and a pdf
+viewer that is able to auto-refresh (for instance =zathura=).
+
-One way to install =sasa= is via [[http://opam.ocaml.org/doc/Install.html][opam]], a package manager
-for ocaml programs. opam works out of the box with most Linux
-distributions and OSX (mac). opam ougth to work on windows too [[http://protz.github.io/ocaml-installer/][(follow
-this link for instructions)]].
+** Via opam (version >= 2.*)
-Once opam is installed and configured:
+One way to install =sasa= is via [[http://opam.ocaml.org/doc/Install.html][opam]], a package manager for =ocaml=
+programs. =opam= works out of the box with most Linux distributions
+and OSX (mac). =opam= ougth to work [[http://protz.github.io/ocaml-installer/][on windows too]].
+
+
+Once opam (version >= 2.*!) is installed and configured:
#+BEGIN_SRC sh :tangle sh/install-opam.sh :noweb yes :tangle-mode (identity #o444)
-opam repo add verimag-sync-repo "http://www-verimag.imag.fr/DIST-TOOLS/SYNCHRONE/opam-repository"
+opam switch create 4.09.0
+eval $(opam env)
+opam repo add -a verimag-sync-repo "http://www-verimag.imag.fr/DIST-TOOLS/SYNCHRONE/opam-repository"
opam update -y
opam install -y sasa
#+END_SRC
+nb: the =opam switch create 4.09.0=, which installs an =4.09.0=
+version of =ocaml=, should not be necessary in theory. If you don't
+do that, =opam= uses the =ocaml= of your system distribution. But in
+practice, =opam= tends to work better when working with one on its own
+switches.
+
+If you want to be able to defined daemons in Lutin, or test oracles in
+Lustre, you can also install the following packages.
+#+BEGIN_SRC sh :tangle sh/install-opam.sh :noweb yes :tangle-mode (identity #o444)
+opam depext -y lutin lustre-v6
+opam install -y lutin lustre-v6
+#+END_SRC
+
+
Once this is done, upgrading to the last version of the tools is as
simple as:
@@ -486,20 +508,12 @@ opam update
opam upgrade
#+END_SRC
-In order to install the tools mentionned in this documentation that
-can be used with =sasa= (namely, =gnuplot-rif=, =lutin=, =lurette=,
-=rdbg=, =lv6=)):
-#+BEGIN_SRC sh :tangle sh/install-opam.sh :noweb yes :tangle-mode (identity #o444)
-opam depext -y rdbg lutin lustre-v6
-opam install -y rdbg lutin lustre-v6
-#+END_SRC
-
-In order to be able to use =luciole= and =sim2chro=, you need to
+In order to be able to use =luciole= and =sim2chro=, you also need to
install the Lustre V4 distribution:
http://www-verimag.imag.fr/DIST-TOOLS/SYNCHRONE/lustre-v4/distrib/index.html
-** Via docker (prefered method for mac users)
+** Via docker
cf the Docker Install section of the [[http://www-verimag.imag.fr/DIST-TOOLS/SYNCHRONE/lustre-v6/#docker][Synchrone Reactive Tool Box]].
@@ -533,4 +547,5 @@ One can mimick the content of the =test= job in the project
** Is there a FAQ?
yes
-Some Tutorials are also available here: https://verimag.gricad-pages.univ-grenoble-alpes.fr/vtt//categories/sasa/
+Some Tutorials are also available here:
+ https://verimag.gricad-pages.univ-grenoble-alpes.fr/vtt/tags/sasa/
diff --git a/lib/sasacore/main.ml b/lib/sasacore/main.ml
index 1cf1faad85f4301401abac9d8ad9b2a69d3c0454..6f91cd8b6cc665657457b0189028d90e695fd5bc 100644
--- a/lib/sasacore/main.ml
+++ b/lib/sasacore/main.ml
@@ -1,4 +1,4 @@
-(* Time-stamp: <modified the 22/01/2020 (at 10:01) by Erwan Jahier> *)
+(* Time-stamp: <modified the 28/01/2020 (at 21:53) by Erwan Jahier> *)
open Register
@@ -193,7 +193,7 @@ let (make : bool -> string array -> 'v t) =
Printf.printf "%s\n%!" (String.concat " " fl);
exit 0
);
- let cmxs = (Filename.chop_extension dot_file) ^ ".cma" in
+ let cmxs = (Filename.chop_extension dot_file) ^ ".cmxs" in
if args.gen_register then (
let base = Filename.chop_extension dot_file in
let base = Str.global_replace (Str.regexp "\\.") "" base in
diff --git a/sasa.opam b/sasa.opam
index 869d32221038e65a7eac84f56a89d38e86e05c02..f90580d070e2cfe5c306bb3029e0f3dfd5774b3c 100644
--- a/sasa.opam
+++ b/sasa.opam
@@ -22,7 +22,7 @@ depends: [
"ocamlfind"
"dune" { build }
"ocamlgraph"
- "rdbg" { test & >= "1.184" }
+ "rdbg" { >= "1.184" }
]
available: [ ocaml-version >= "4.02" ]
post-messages: ["The last version can be obtained via (opam repo add) http://www-verimag.imag.fr/DIST-TOOLS/SYNCHRONE/opam-repository/ "]