1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
|
{
description = "Aeneas";
inputs = {
# Remark: when adding inputs here, don't forget to also add them in the
# arguments to `outputs` below!
charon.url = "github:aeneasverif/charon";
flake-utils.follows = "charon/flake-utils";
nixpkgs.follows = "charon/nixpkgs";
hacl-nix.url = "github:hacl-star/hacl-nix";
flake-compat.url = "github:nix-community/flake-compat";
};
# Remark: keep the list of outputs in sync with the list of inputs above
# (see above remark)
outputs = { self, charon, flake-utils, nixpkgs, hacl-nix, flake-compat }:
flake-utils.lib.eachDefaultSystem (system:
let
pkgs = import nixpkgs { inherit system; };
ocamlPackages = pkgs.ocamlPackages;
coqPackages = pkgs.coqPackages;
easy_logging = ocamlPackages.buildDunePackage rec {
pname = "easy_logging";
version = "0.8.2";
src = pkgs.fetchFromGitHub {
owner = "sapristi";
repo = "easy_logging";
rev = "v${version}";
sha256 = "sha256-Xy6Rfef7r2K8DTok7AYa/9m3ZEV07LlUeMQSRayLBco=";
};
buildInputs = [ ocamlPackages.calendar ];
};
aeneas-check-tidiness = pkgs.stdenv.mkDerivation {
name = "aeneas-check-tidiness";
src = ./compiler;
buildInputs = [
ocamlPackages.dune_3
ocamlPackages.ocaml
ocamlPackages.ocamlformat
];
buildPhase = ''
if ! dune build @fmt; then
echo 'ERROR: Code is not formatted. Run `make format` to format the project files.'
exit 1
fi
'';
installPhase = "touch $out";
};
aeneas = ocamlPackages.buildDunePackage {
pname = "aeneas";
version = "0.1.0";
duneVersion = "3";
src = ./compiler;
OCAMLPARAM = "_,warn-error=+A"; # Turn all warnings into errors.
propagatedBuildInputs = [
easy_logging
charon.packages.${system}.charon-ml
] ++ (with ocamlPackages; [
calendar
core_unix
ppx_deriving
visitors
yojson
zarith
ocamlgraph
unionFind
]);
afterBuild = ''
echo charon.packages.${system}.tests
'';
};
test_runner = ocamlPackages.buildDunePackage {
pname = "aeneas_test_runner";
version = "0.1.0";
duneVersion = "3";
src = ./tests/test_runner;
OCAMLPARAM = "_,warn-error=+A"; # Turn all warnings into errors.
propagatedBuildInputs = (with ocamlPackages; [
core_unix
]);
};
# This test is a full crate with dependencies. We generate the
# corresponding llbc file here; this function takes care of cargo
# dependencies for us.
betree-llbc = charon.extractCrateWithCharon.${system} {
name = "betree";
src = ./tests/src/betree;
charonFlags = "--polonius --opaque=betree_utils --crate betree_main";
craneExtraArgs.checkPhaseCargoCommand = ''
cargo rustc -- --test -Zpolonius
./target/debug/betree
'';
};
# Run the translation on various files.
# Make sure we don't need to recompile the package whenever we make
# unnecessary changes - we list the exact files and folders the package
# depends upon.
aeneas-tests = pkgs.stdenv.mkDerivation {
name = "aeneas_tests";
src = pkgs.lib.cleanSourceWith {
src = ./.;
filter = path: type:
path == toString ./Makefile
|| pkgs.lib.hasPrefix (toString ./compiler) path
|| pkgs.lib.hasPrefix (toString ./backends) path
|| (pkgs.lib.hasPrefix (toString ./tests) path
&& !pkgs.lib.hasSuffix ".llbc" path);
};
buildInputs = [ charon.packages.${system}.rustToolchain ];
buildPhase = ''
export AENEAS_EXE=${aeneas}/bin/aeneas
export CHARON_EXE=${charon.packages.${system}.charon}/bin/charon
export TEST_RUNNER_EXE=${test_runner}/bin/test_runner
mkdir llbc
export LLBC_DIR=llbc
# Copy over the llbc file we can't generate ourselves.
cp ${betree-llbc}/llbc/betree_main.llbc $LLBC_DIR
# Copy the tests
cp -r tests tests-copy
make clean-generated-aeneas
# Run the tests with extra sanity checks enabled
IN_CI=1 make test-all -j $NIX_BUILD_CORES
# Check that there are no differences between the generated tests
# and the original tests
if diff -rq tests tests-copy; then
echo "Ok: the regenerated test files are the same as the checked out files"
else
echo "Error: the regenerated test files differ from the checked out files"
diff -ru tests tests-copy
exit 1
fi
'';
# Tests don't generate anything new as the generated files are
# versionned, but the installation phase still needs to produce
# something, otherwise Nix will consider the build has failed.
installPhase = "touch $out";
};
# Replay the F* proofs.
aeneas-verify-fstar = pkgs.stdenv.mkDerivation {
name = "aeneas_verify_fstar";
src = ./tests/fstar;
FSTAR_EXE = "${hacl-nix.packages.${system}.fstar}/bin/fstar.exe";
buildPhase = ''
make prepare-projects
make verify -j $NIX_BUILD_CORES
'';
# The tests don't generate anything - TODO: actually they do
installPhase = "touch $out";
};
# Replay the Coq proofs.
aeneas-verify-coq = pkgs.stdenv.mkDerivation {
name = "aeneas_verify_coq";
src = ./tests/coq;
buildInputs = [ pkgs.coq ];
buildPhase = ''
make prepare-projects
make verify -j $NIX_BUILD_CORES
'';
# The tests don't generate anything - TODO: actually they do
installPhase = "touch $out";
};
# Replay the HOL4 proofs
#
# Remark: we tried to have two targets, one for ./backends/hol4 and
# one for ./tests/hol4 but we didn't manage to make ./tests/hol4
# reuse the build of ./backends/hol4.
aeneas-verify-hol4 = pkgs.stdenv.mkDerivation {
name = "aeneas_verify_hol4";
# Remark: we tried to filter the sources to only include ./backends/hol4
# and ./tests/hol4 (see comment below), but it didn't work
src = ./.;
# src = pkgs.lib.cleanSourceWith {
# src = ./.;
# filter = path: type:
# pkgs.lib.hasPrefix (toString ./backends/hol4) path
# || pkgs.lib.hasPrefix (toString ./tests/hol4) path;
# };
buildInputs = [ pkgs.hol ];
buildPhase = ''
cd ./tests/hol4
make prepare-projects
make verify -j $NIX_BUILD_CORES
'';
# The build doesn't generate anything
installPhase = "touch $out";
};
check-charon-pin = pkgs.runCommand "aeneas-check-charon-pin"
{
buildInputs = [ pkgs.jq ];
} ''
CHARON_REV_FROM_FLAKE="$(jq -r .nodes.charon.locked.rev ${./flake.lock})"
CHARON_REV_FROM_PIN="$(tail -1 ${./charon-pin})"
if [[ "$CHARON_REV_FROM_FLAKE" != "$CHARON_REV_FROM_PIN" ]]; then
echo 'ERROR: The charon version in `flacke.lock` differs from the one in `charon-pin`.'
echo ' In `flake.lock`: '"$CHARON_REV_FROM_FLAKE"
echo ' In `charon-pin`: '"$CHARON_REV_FROM_PIN"
echo 'Use `make charon-pin` to update the `./charon-pin` file.'
exit 1
fi
touch $out
'';
in
{
packages = {
inherit aeneas;
default = aeneas;
};
devShells.default = pkgs.mkShell {
packages = [
pkgs.elan
pkgs.ocamlPackages.ocaml
pkgs.ocamlPackages.ocamlformat
pkgs.ocamlPackages.menhir
pkgs.ocamlPackages.odoc
];
inputsFrom = [
self.packages.${system}.aeneas
];
};
checks = {
inherit aeneas aeneas-tests
aeneas-verify-fstar
aeneas-verify-coq
aeneas-verify-hol4
aeneas-check-tidiness
check-charon-pin;
};
});
}
|
