reraise interrupts outside command regular transactions -- relevant for memo_stable;
1 (* Title: Pure/PIDE/command.ML
4 Prover command execution: read -- eval -- print.
9 val read: (unit -> theory) -> Token.T list -> Toplevel.transition
11 val eval_eq: eval * eval -> bool
12 val eval_result_state: eval -> Toplevel.state
13 val eval_stable: eval -> bool
14 val eval: (unit -> theory) -> Token.T list -> eval -> eval
16 val print: bool -> string -> eval -> print list -> print list option
17 type print_fn = Toplevel.transition -> Toplevel.state -> unit
18 val print_function: {name: string, pri: int, persistent: bool} ->
19 ({command_name: string} -> print_fn option) -> unit
20 val no_print_function: string -> unit
21 type exec = eval * print list
23 val exec_ids: exec option -> Document_ID.exec list
24 val exec: Document_ID.execution -> exec -> unit
27 structure Command: COMMAND =
30 (** memo results -- including physical interrupts! **)
33 Expr of Document_ID.exec * (unit -> 'a) |
34 Result of 'a Exn.result;
36 abstype 'a memo = Memo of 'a expr Synchronized.var
39 fun memo exec_id e = Memo (Synchronized.var "Command.memo" (Expr (exec_id, e)));
40 fun memo_value a = Memo (Synchronized.var "Command.memo" (Result (Exn.Res a)));
42 fun memo_result (Memo v) =
43 (case Synchronized.value v of
44 Expr (exec_id, _) => error ("Unfinished execution result: " ^ Document_ID.print exec_id)
45 | Result res => Exn.release res);
47 fun memo_stable (Memo v) =
48 (case Synchronized.value v of
50 | Result res => not (Exn.is_interrupt_exn res));
52 fun memo_exec execution_id (Memo v) =
53 Synchronized.guarded_access v
56 Result res => SOME (res, expr)
57 | Expr (exec_id, e) =>
58 uninterruptible (fn restore_attributes => fn () =>
59 if Execution.running execution_id exec_id then
61 val res = Exn.capture (restore_attributes e) ();
62 val _ = Execution.finished exec_id;
63 in SOME (res, Result res) end
64 else SOME (Exn.interrupt_exn, expr)) ()))
65 |> Exn.release |> ignore;
67 fun memo_fork params execution_id (Memo v) =
68 (case Synchronized.value v of
70 | _ => ignore ((singleton o Future.forks) params (fn () => memo_exec execution_id (Memo v))));
76 (** main phases of execution **)
82 val outer_syntax = #2 (Outer_Syntax.get_syntax ());
83 val command_reports = Outer_Syntax.command_reports outer_syntax;
86 Position.set_range (Token.position_range_of (#1 (take_suffix Token.is_improper span)));
88 (case find_first Token.is_command span of
89 SOME tok => Token.position_of tok
90 | NONE => proper_range);
92 val (is_malformed, token_reports) = Thy_Syntax.reports_of_tokens span;
93 val _ = Position.reports_text (token_reports @ maps command_reports span);
95 if is_malformed then Toplevel.malformed pos "Malformed command syntax"
97 (case Outer_Syntax.read_spans outer_syntax span of
99 if Keyword.is_control (Toplevel.name_of tr) then
100 Toplevel.malformed pos "Illegal control command"
101 else Toplevel.modify_init init tr
102 | [] => Toplevel.ignored (Position.set_range (Token.position_range_of span))
103 | _ => Toplevel.malformed proper_range "Exactly one command expected")
104 handle ERROR msg => Toplevel.malformed proper_range msg
111 {failed: bool, malformed: bool, command: Toplevel.transition, state: Toplevel.state};
112 val init_eval_state =
113 {failed = false, malformed = false, command = Toplevel.empty, state = Toplevel.toplevel};
115 datatype eval = Eval of {exec_id: Document_ID.exec, eval_process: eval_state memo};
117 fun eval_eq (Eval {exec_id, ...}, Eval {exec_id = exec_id', ...}) = exec_id = exec_id';
119 fun eval_result (Eval {eval_process, ...}) = memo_result eval_process;
120 val eval_result_state = #state o eval_result;
122 fun eval_stable (Eval {exec_id, eval_process}) =
123 Goal.stable_futures exec_id andalso memo_stable eval_process;
128 if Goal.future_enabled () andalso Keyword.is_diag (Toplevel.name_of tr) then
129 (Goal.fork_params {name = "Toplevel.diag", pos = Toplevel.pos_of tr, pri = ~1}
130 (fn () => Toplevel.command_exception int tr st); ([], SOME st))
131 else Toplevel.command_errors int tr st;
133 fun check_cmts span tr st' =
134 Toplevel.setmp_thread_position tr
136 Outer_Syntax.side_comments span |> maps (fn cmt =>
137 (Thy_Output.check_text (Token.source_position_of cmt) st'; [])
139 if Exn.is_interrupt exn then reraise exn
140 else ML_Compiler.exn_messages_ids exn)) ();
142 fun proof_status tr st =
143 (case try Toplevel.proof_of st of
144 SOME prf => Toplevel.status tr (Proof.status_markup prf)
147 fun eval_state span tr ({malformed, state = st, ...}: eval_state) =
149 {failed = true, malformed = malformed, command = tr, state = Toplevel.toplevel}
152 val malformed' = Toplevel.is_malformed tr;
153 val is_init = Toplevel.is_init tr;
154 val is_proof = Keyword.is_proof (Toplevel.name_of tr);
156 val _ = Multithreading.interrupted ();
157 val _ = Toplevel.status tr Markup.running;
158 val (errs1, result) = run (is_init orelse is_proof) (Toplevel.set_print false tr) st;
159 val errs2 = (case result of NONE => [] | SOME st' => check_cmts span tr st');
160 val errs = errs1 @ errs2;
161 val _ = Toplevel.status tr Markup.finished;
162 val _ = List.app (Future.error_msg (Toplevel.pos_of tr)) errs;
167 val _ = if null errs then Exn.interrupt () else ();
168 val _ = Toplevel.status tr Markup.failed;
169 in {failed = true, malformed = malformed', command = tr, state = st} end
172 val _ = proof_status tr st';
173 in {failed = false, malformed = malformed', command = tr, state = st'} end)
178 fun eval init span eval0 =
180 val exec_id = Document_ID.make ();
184 Position.setmp_thread_data (Position.id_only (Document_ID.print exec_id))
185 (fn () => read init span |> Toplevel.exec_id exec_id) ();
186 in eval_state span tr (eval_result eval0) end;
187 in Eval {exec_id = exec_id, eval_process = memo exec_id process} end;
194 datatype print = Print of
195 {name: string, pri: int, persistent: bool,
196 exec_id: Document_ID.exec, print_process: unit memo};
198 type print_fn = Toplevel.transition -> Toplevel.state -> unit;
202 type print_function = string * (int * bool * ({command_name: string} -> print_fn option));
203 val print_functions = Synchronized.var "Command.print_functions" ([]: print_function list);
205 fun print_error tr e =
206 (Toplevel.setmp_thread_position tr o Runtime.controlled_execution) e ()
208 if Exn.is_interrupt exn then reraise exn
209 else List.app (Future.error_msg (Toplevel.pos_of tr)) (ML_Compiler.exn_messages_ids exn);
211 fun print_eq (Print {exec_id, ...}, Print {exec_id = exec_id', ...}) = exec_id = exec_id';
213 fun print_stable (Print {exec_id, print_process, ...}) =
214 Goal.stable_futures exec_id andalso memo_stable print_process;
216 fun print_persistent (Print {persistent, ...}) = persistent;
220 fun print command_visible command_name eval old_prints =
222 fun new_print (name, (pri, persistent, get_fn)) =
224 fun make_print strict print_fn =
226 val exec_id = Document_ID.make ();
229 val {failed, command, state = st', ...} = eval_result eval;
230 val tr = Toplevel.exec_id exec_id command;
232 if failed andalso not strict then ()
233 else print_error tr (fn () => print_fn tr st')
237 name = name, pri = pri, persistent = persistent,
238 exec_id = exec_id, print_process = memo exec_id process}
241 (case Exn.capture (Runtime.controlled_execution get_fn) {command_name = command_name} of
243 | Exn.Res (SOME print_fn) => SOME (make_print false print_fn)
244 | Exn.Exn exn => SOME (make_print true (fn _ => fn _ => reraise exn)))
248 if command_visible then
249 rev (Synchronized.value print_functions) |> map_filter (fn pr =>
250 (case find_first (fn Print {name, ...} => name = fst pr) old_prints of
251 SOME print => if print_stable print then SOME print else new_print pr
252 | NONE => new_print pr))
253 else filter (fn print => print_persistent print andalso print_stable print) old_prints;
255 if eq_list print_eq (old_prints, new_prints) then NONE else SOME new_prints
258 fun print_function {name, pri, persistent} f =
259 Synchronized.change print_functions (fn funs =>
260 (if not (AList.defined (op =) funs name) then ()
261 else warning ("Redefining command print function: " ^ quote name);
262 AList.update (op =) (name, (pri, persistent, f)) funs));
264 fun no_print_function name =
265 Synchronized.change print_functions (filter_out (equal name o #1));
270 print_function {name = "print_state", pri = 0, persistent = true}
271 (fn {command_name} => SOME (fn tr => fn st' =>
273 val is_init = Keyword.is_theory_begin command_name;
274 val is_proof = Keyword.is_proof command_name;
277 (Toplevel.print_of tr orelse (is_proof andalso Toplevel.is_proof st'));
278 in if do_print then Toplevel.print_state false st' else () end));
281 (* combined execution *)
283 type exec = eval * print list;
285 (Eval {exec_id = Document_ID.none, eval_process = memo_value init_eval_state}, []);
287 fun exec_ids NONE = []
288 | exec_ids (SOME (Eval {exec_id, ...}, prints)) =
289 exec_id :: map (fn Print {exec_id, ...} => exec_id) prints;
293 fun run_print execution_id (Print {name, pri, print_process, ...}) =
294 (if Multithreading.enabled () then
295 memo_fork {name = name, group = NONE, deps = [], pri = pri, interrupts = true}
296 else memo_exec) execution_id print_process;
300 fun exec execution_id (Eval {eval_process, ...}, prints) =
301 (memo_exec execution_id eval_process; List.app (run_print execution_id) prints);