TODO
You can get the sources using git as follows:
git clone git@gitlab.lip6.fr:lprosperi/compiler.gitDependencies are described in vardac.opam. For building the source
code documentation, one needs
odoc. For building the User Manual,
see docs/README.md.
Using Opam, a suitable OCaml environment can be setup as follows (automated script requirements.sh):
opam switch 4.12.0
./requirements.shTo compile vardac, just run the command make in the source directory.
This produces the _build/install/default/bin/vardac binary.
Use the --help option for more information. Other make targets are:
make # Build vardac
#make doc # Build the user documentation (avalaible on readthedocs)
make odoc # Build the developer documentation
make install # Install vardac
#make vscode # Install vscode extension
make testsNote: you can run vardac without installing it with dune exec -- vardac.
Note: the starting file of the source code html documentation is
_build/default/_doc/_html/vardac/index.html.
The following commands can be used to clean up the repository:
make clean # Removes files generated by OCaml.
make distclean # Same as clean, but also removes library checking files.- message-passing encoding
make run -- compile --places examples/0-ping-pong/places.yml --targets examples/0-ping-pong/targets.yml --filename examples/0-ping-pong/pingpong.varch --impl examples/0-ping-pong/pingpong.vimpl --provenance 0- message-passing with interception
make run -- compile --places examples/2-ping-pong-intercept/places.yml --targets examples/2-ping-pong-intercept/targets.yml --filename examples/2-ping-pong-intercept/pingpong.varch --impl examples/2-ping-pong-intercept/pingpong.vimpl --provenance 0- counter
make run -- compile --places examples/1-counter/places.yml --targets examples/1-counter/targets.yml --filename examples/1-counter/counter.varch --impl examples/1-counter/counter.vimpl --provenance 0make run -- info
Compile the akka source code generated by the Lg4DC compiler
cd compiler-build/akka && gradle jarMain
java -enableassertions -jar build/libs/main.jar
docker build .
Start a compiler with the compiled jar
docker-compose up -d
We provide two plugins for vim and vscode.
Manual installation of vim plugin for the current user
cd editors/vim && make installManual installation of vscode plugin for the current user
cd editors/vscode
# generate the package from sources
vsce package
code --install-extension aspeclg-0.0.1.vsixA little tweak/hack is currently needed for the console application to work from outside a docker context.
Add the following to /etc/hosts: 127.0.0.1 host.docker.internal kvs-server-seed
docker-compose build
start all services
docker-compose up -d
start a shell in a container that is on the same network as the kvs services
docker run -it --rm --network kvs_default kvs-server
- Static logic topology
after compilation (that generate the .dot file) run
make sltopology
------------------------------------------------------------
Gradle 7.1.1
------------------------------------------------------------
Build time: 2021-07-02 12:16:43 UTC
Revision: 774525a055494e0ece39f522ac7ad17498ce032c
Kotlin: 1.4.31
Groovy: 3.0.7
Ant: Apache Ant(TM) version 1.10.9 compiled on September 27 2020
JVM: 11.0.12 (Debian 11.0.12+7-post-Debian-2)
OS: Linux 5.10.0-6-amd64 amd64
make odoc
open _build/default/_doc/_html/index.html
add private lib
dune build @doc-private
make tests
To run a subset of tests e.g. 0:Parser
make && dune exec --profile release -- tests/main.exe -list-test
make && dune exec --profile release -- tests/main.exe -only-test 0:Parser
- Setup
sudo apt install afl++ opam switch create 4.12.0+afl --package=ocaml-variants.4.12.0+options,ocaml-option-afl opam switch 4.12.0+afl eval $(opam env) opam install --yes . --deps-only opam install crowbar bun
- Run tests
replay crashes
make fuzz or make ci-fuzz or make ci-fuzz-timeout (to find more than one bug at at time)make replay-fuzz /tmp/findings/XX/crashes/YYY
More about fuzzing
- https://blog.regehr.org/archives/1687
- https://somerandomidiot.com/blog/2017/04/26/crowbar-dhcp/
- https://tarides.com/blog/2019-09-04-an-introduction-to-fuzzing-ocaml-with-afl-crowbar-and-bun/
Update the CHANGES.md add new version X.Y.Z
dune-release tag vX.Y.Z
make opam-release
dune-release publish
#https://techoverflow.net/2021/01/12/how-to-install-gitlab-runner-using-docker-compose/
# executor: docker
# default image: alpine:3.14
# tags: empty version: '3'
services:
minio:
image: minio/minio:latest
expose:
- "9000"
# environment:
# MINIO_ROOT_USER: minioadmin
# MINIO_ROOT_PASSWORD: minioadmin
healthcheck:
test: ["CMD", "curl", "-f", "http://localhost:9000/minio/health/live"]
interval: 30s
timeout: 20s
retries: 3
volumes:
- ./minio:/root/.minio
- ./minio/export:/export
restart: unless-stopped
command: server --address 0.0.0.0:9000 /export
gitlab-runner:
image: 'gitlab/gitlab-runner:latest'
volumes:
- /var/run/docker.sock:/var/run/docker.sock
- ./config:/etc/gitlab-runner
restart: unless-stopped
depends_on:
- minio
healthcheck:
test: ["CMD", "curl", "-f", "http://minio:9000/minio/health/live"]
interval: 30s
timeout: 20s
retries: 3config.toml
concurrent = 5
limit = 5
check_interval = 0
[session_server]
session_timeout = 1800
[[runners]]
name = "PIMS"
url = "https://gitlab.lip6.fr/"
token = "<TOKEN>"
executor = "docker"
output_limit = "32768" #in KB-> 32MB
[runners.custom_build_dir]
[runners.cache]
Type = "s3"
Path = "mycustom-s3"
Shared = true
[runners.cache.s3]
ServerAddress = "minio:9005"
AccessKey = "minioadmin"
SecretKey = "minioadmin"
BucketName = "runner"
Insecure = true
[runners.docker]
tls_verify = false
image = "alpine:3.14"
privileged = false
disable_entrypoint_overwrite = false
oom_kill_disable = false
disable_cache = false
volumes = ["/cache"]
shm_size = 0Debugging locally
- Install gitlab-runner (could be done in vagrant)
curl -LJO "https://gitlab-runner-downloads.s3.amazonaws.com/latest/deb/gitlab-runner_amd64.deb"
dpkg -i gitlab-runner_amd64.deb
or
curl -L "https://packages.gitlab.com/install/repositories/runner/gitlab-runner/script.deb.sh" | sudo bash
sudo apt-get install gitlab-runner- Run locally the ci
$build$ job
cd git repo
gitlab-runner exec shell build
or
gitlab-runner exec docker buildTips to debug add sleep to have the time to debug the container using a docker exec -it CONTAINER bash