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
|
(**************************************************************************)
(* Sail *)
(* *)
(* Copyright (c) 2013-2017 *)
(* Kathyrn Gray *)
(* Shaked Flur *)
(* Stephen Kell *)
(* Gabriel Kerneis *)
(* Robert Norton-Wright *)
(* Christopher Pulte *)
(* Peter Sewell *)
(* *)
(* All rights reserved. *)
(* *)
(* This software was developed by the University of Cambridge Computer *)
(* Laboratory as part of the Rigorous Engineering of Mainstream Systems *)
(* (REMS) project, funded by EPSRC grant EP/K008528/1. *)
(* *)
(* Redistribution and use in source and binary forms, with or without *)
(* modification, are permitted provided that the following conditions *)
(* are met: *)
(* 1. Redistributions of source code must retain the above copyright *)
(* notice, this list of conditions and the following disclaimer. *)
(* 2. Redistributions in binary form must reproduce the above copyright *)
(* notice, this list of conditions and the following disclaimer in *)
(* the documentation and/or other materials provided with the *)
(* distribution. *)
(* *)
(* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' *)
(* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *)
(* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *)
(* PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR *)
(* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, *)
(* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT *)
(* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF *)
(* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND *)
(* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, *)
(* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT *)
(* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF *)
(* SUCH DAMAGE. *)
(**************************************************************************)
open Type_internal
type out_type =
| Lem_ast_out
| Lem_out of string option
| Ocaml_out of string option
let get_lexbuf fn =
let lexbuf = Lexing.from_channel (open_in fn) in
lexbuf.Lexing.lex_curr_p <- { Lexing.pos_fname = fn;
Lexing.pos_lnum = 1;
Lexing.pos_bol = 0;
Lexing.pos_cnum = 0; };
lexbuf
let parse_file (f : string) : Parse_ast.defs =
let scanbuf = get_lexbuf f in
let type_names =
try
Pre_parser.file Pre_lexer.token scanbuf
with
| Parsing.Parse_error ->
let pos = Lexing.lexeme_start_p scanbuf in
raise (Reporting_basic.Fatal_error (Reporting_basic.Err_syntax (pos, "pre")))
| Parse_ast.Parse_error_locn(l,m) ->
raise (Reporting_basic.Fatal_error (Reporting_basic.Err_syntax_locn (l, m)))
| Lexer.LexError(s,p) ->
raise (Reporting_basic.Fatal_error (Reporting_basic.Err_lex (p, s))) in
let () = Lexer.custom_type_names := !Lexer.custom_type_names @ type_names in
let lexbuf = get_lexbuf f in
try
Parser.file Lexer.token lexbuf
with
| Parsing.Parse_error ->
let pos = Lexing.lexeme_start_p lexbuf in
raise (Reporting_basic.Fatal_error (Reporting_basic.Err_syntax (pos, "main")))
| Parse_ast.Parse_error_locn(l,m) ->
raise (Reporting_basic.Fatal_error (Reporting_basic.Err_syntax_locn (l, m)))
| Lexer.LexError(s,p) ->
raise (Reporting_basic.Fatal_error (Reporting_basic.Err_lex (p, s)))
(*Should add a flag to say whether we want to consider Oinc or Odec the default order *)
let convert_ast (defs : Parse_ast.defs) : (Type_internal.tannot Ast.defs * kind Envmap.t * Ast.order)=
Initial_check.to_ast Nameset.empty Type_internal.initial_kind_env (Ast.Ord_aux(Ast.Ord_inc,Parse_ast.Unknown)) defs
let initi_check_ast (defs : Type_internal.tannot Ast.defs) : (Type_internal.tannot Ast.defs * kind Envmap.t * Ast.order)=
Initial_check_full_ast.to_checked_ast Nameset.empty Type_internal.initial_kind_env (Ast.Ord_aux(Ast.Ord_inc,Parse_ast.Unknown)) defs
let opt_new_typecheck = ref false
let opt_just_check = ref false
let opt_ddump_tc_ast = ref false
let opt_dno_cast = ref false
let check_ast (defs : Type_internal.tannot Ast.defs) (k : kind Envmap.t) (o:Ast.order) : Type_internal.tannot Ast.defs * Type_check.envs =
let d_env = { Type_internal.k_env = k; Type_internal.abbrevs = Type_internal.initial_abbrev_env;
Type_internal.nabbrevs = Envmap.empty;
Type_internal.namesch = Envmap.empty; Type_internal.enum_env = Envmap.empty;
Type_internal.rec_env = []; Type_internal.alias_env = Envmap.empty;
Type_internal.default_o =
{Type_internal.order = (match o with | (Ast.Ord_aux(Ast.Ord_inc,_)) -> Type_internal.Oinc
| (Ast.Ord_aux(Ast.Ord_dec,_)) -> Type_internal.Odec
| _ -> Type_internal.Oinc)};} in
if !opt_new_typecheck
then
let ienv = if !opt_dno_cast then Type_check_new.Env.no_casts Type_check_new.initial_env else Type_check_new.initial_env in
let ast, _ = Type_check_new.check ienv defs in
if !opt_ddump_tc_ast then Pretty_print.pp_defs stdout ast else ()
else ();
if !opt_just_check
then exit 0
else ();
Type_check.check (Type_check.Env (d_env, Type_internal.initial_typ_env,Type_internal.nob,Envmap.empty)) defs
let rewrite_ast (defs: Type_internal.tannot Ast.defs) = Rewriter.rewrite_defs defs
let rewrite_ast_lem (defs: Type_internal.tannot Ast.defs) = Rewriter.rewrite_defs_lem defs
let rewrite_ast_ocaml (defs: Type_internal.tannot Ast.defs) = Rewriter.rewrite_defs_ocaml defs
let open_output_with_check file_name =
let (temp_file_name, o) = Filename.open_temp_file "ll_temp" "" in
let o' = Format.formatter_of_out_channel o in
(o', (o, temp_file_name, file_name))
let open_output_with_check_unformatted file_name =
let (temp_file_name, o) = Filename.open_temp_file "ll_temp" "" in
(o, temp_file_name, file_name)
let always_replace_files = ref true
let close_output_with_check (o, temp_file_name, file_name) =
let _ = close_out o in
let do_replace = !always_replace_files || (not (Util.same_content_files temp_file_name file_name)) in
let _ = if (not do_replace) then Sys.remove temp_file_name
else Util.move_file temp_file_name file_name in
()
let generated_line f =
Printf.sprintf "Generated by Sail from %s." f
let output1 libpath out_arg filename defs =
let f' = Filename.basename (Filename.chop_extension filename) in
match out_arg with
| Lem_ast_out ->
begin
let (o, ext_o) = open_output_with_check (f' ^ ".lem") in
Format.fprintf o "(* %s *)@\n" (generated_line filename);
Format.fprintf o "open import Interp_ast@\n";
Format.fprintf o "open import Pervasives@\n";
Format.fprintf o "(*Supply common numeric constants at the right type to alleviate repeated calls to typeclass macro*)\n";
Format.fprintf o "let zero : integer = integerFromNat 0\n";
Format.fprintf o "let one : integer = integerFromNat 1\n";
Format.fprintf o "let two : integer = integerFromNat 2\n";
Format.fprintf o "let three : integer = integerFromNat 3\n";
Format.fprintf o "let four : integer = integerFromNat 4\n";
Format.fprintf o "let five : integer = integerFromNat 5\n";
Format.fprintf o "let six : integer = integerFromNat 6\n";
Format.fprintf o "let seven : integer = integerFromNat 7\n";
Format.fprintf o "let eight : integer = integerFromNat 8\n";
Format.fprintf o "let fifteen : integer = integerFromNat 15\n";
Format.fprintf o "let sixteen : integer = integerFromNat 16\n";
Format.fprintf o "let twenty : integer = integerFromNat 20\n";
Format.fprintf o "let twentythree : integer = integerFromNat 23\n";
Format.fprintf o "let twentyfour : integer = integerFromNat 24\n";
Format.fprintf o "let thirty : integer = integerFromNat 30\n";
Format.fprintf o "let thirtyone : integer = integerFromNat 31\n";
Format.fprintf o "let thirtytwo : integer = integerFromNat 32\n";
Format.fprintf o "let thirtyfive : integer = integerFromNat 35\n";
Format.fprintf o "let thirtynine : integer = integerFromNat 39\n";
Format.fprintf o "let forty : integer = integerFromNat 40\n";
Format.fprintf o "let fortyseven : integer = integerFromNat 47\n";
Format.fprintf o "let fortyeight : integer = integerFromNat 48\n";
Format.fprintf o "let fiftyfive : integer = integerFromNat 55\n";
Format.fprintf o "let fiftysix : integer = integerFromNat 56\n";
Format.fprintf o "let fiftyseven : integer = integerFromNat 57\n";
Format.fprintf o "let sixtyone : integer = integerFromNat 61\n";
Format.fprintf o "let sixtythree : integer = integerFromNat 63\n";
Format.fprintf o "let sixtyfour : integer = integerFromNat 64\n";
Format.fprintf o "let onetwentyseven : integer = integerFromNat 127\n";
Format.fprintf o "let onetwentyeight : integer = integerFromNat 128\n";
Format.fprintf o "let defs = ";
Pretty_print.pp_lem_defs o defs;
close_output_with_check ext_o
end
| Lem_out None ->
let generated_line = generated_line filename in
let types_module = (f' ^ "_embed_types") in
let ((o,_, _) as ext_o) =
open_output_with_check_unformatted (f' ^ "_embed_types.lem") in
let ((o',_, _) as ext_o') =
open_output_with_check_unformatted (f' ^ "_embed.lem") in
let ((o'',_, _) as ext_o'') =
open_output_with_check_unformatted (f' ^ "_embed_sequential.lem") in
(Pretty_print.pp_defs_lem
(o,["Pervasives_extra";"Sail_impl_base";"Sail_values"])
(o',["Pervasives_extra";"Sail_impl_base";"Prompt";"Sail_values";
String.capitalize types_module])
(o'',["Pervasives_extra";"Sail_impl_base";"State";"Sail_values";
String.capitalize types_module])
defs generated_line);
close_output_with_check ext_o;
close_output_with_check ext_o';
close_output_with_check ext_o'';
| Lem_out (Some lib) ->
let generated_line = generated_line filename in
let types_module = (f' ^ "_embed_types") in
let ((o,_, _) as ext_o) =
open_output_with_check_unformatted (f' ^ "_embed_types.lem") in
let ((o',_, _) as ext_o') =
open_output_with_check_unformatted (f' ^ "_embed.lem") in
let ((o'',_, _) as ext_o'') =
open_output_with_check_unformatted (f' ^ "_embed_sequential.lem") in
(Pretty_print.pp_defs_lem
(o,["Pervasives_extra";"Sail_impl_base";"Sail_values"])
(o',["Pervasives_extra";"Sail_impl_base";"Prompt";
"Sail_values";String.capitalize types_module;lib])
(o'',["Pervasives_extra";"Sail_impl_base";"State";
"Sail_values";String.capitalize types_module;lib ^ "_sequential"])
defs generated_line);
close_output_with_check ext_o;
close_output_with_check ext_o';
close_output_with_check ext_o''
| Ocaml_out None ->
let ((o,temp_file_name, _) as ext_o) = open_output_with_check_unformatted (f' ^ ".ml") in
begin Pretty_print.pp_defs_ocaml o defs (generated_line filename) ["Big_int_Z";"Sail_values"];
close_output_with_check ext_o
end
| Ocaml_out (Some lib) ->
let ((o,temp_file_name, _) as ext_o) = open_output_with_check_unformatted (f' ^ ".ml") in
Pretty_print.pp_defs_ocaml o defs (generated_line filename) ["Big_int_Z"; "Sail_values"; lib];
close_output_with_check ext_o
let output libpath out_arg files =
List.iter
(fun (f, defs) ->
output1 libpath out_arg f defs)
files
|
