src/Pure/PIDE/command.ML
author wenzelm
Sun Aug 25 20:32:26 2013 +0200 (2013-08-25 ago)
changeset 53192 04df1d236e1c
parent 53189 ee8b8dafef0e
child 53375 78693e46a237
permissions -rw-r--r--
maintain goal forks as part of global execution;
tuned;
     1 (*  Title:      Pure/PIDE/command.ML
     2     Author:     Makarius
     3 
     4 Prover command execution: read -- eval -- print.
     5 *)
     6 
     7 signature COMMAND =
     8 sig
     9   val read: (unit -> theory) -> Token.T list -> Toplevel.transition
    10   type eval
    11   val eval_eq: eval * eval -> bool
    12   val eval_running: eval -> bool
    13   val eval_finished: eval -> bool
    14   val eval_result_state: eval -> Toplevel.state
    15   val eval: (unit -> theory) -> Token.T list -> eval -> eval
    16   type print
    17   val print: bool -> (string * string list) list -> string ->
    18     eval -> print list -> print list option
    19   type print_fn = Toplevel.transition -> Toplevel.state -> unit
    20   type print_function =
    21     {command_name: string, args: string list} ->
    22       {delay: Time.time option, pri: int, persistent: bool, strict: bool, print_fn: print_fn} option
    23   val print_function: string -> print_function -> unit
    24   val no_print_function: string -> unit
    25   type exec = eval * print list
    26   val no_exec: exec
    27   val exec_ids: exec option -> Document_ID.exec list
    28   val exec: Document_ID.execution -> exec -> unit
    29 end;
    30 
    31 structure Command: COMMAND =
    32 struct
    33 
    34 (** memo results **)
    35 
    36 datatype 'a expr =
    37   Expr of Document_ID.exec * (unit -> 'a) |
    38   Result of 'a Exn.result;
    39 
    40 abstype 'a memo = Memo of 'a expr Synchronized.var
    41 with
    42 
    43 fun memo exec_id e = Memo (Synchronized.var "Command.memo" (Expr (exec_id, e)));
    44 fun memo_value a = Memo (Synchronized.var "Command.memo" (Result (Exn.Res a)));
    45 
    46 fun memo_result (Memo v) =
    47   (case Synchronized.value v of
    48     Expr (exec_id, _) => error ("Unfinished execution result: " ^ Document_ID.print exec_id)
    49   | Result res => Exn.release res);
    50 
    51 fun memo_finished (Memo v) =
    52   (case Synchronized.value v of Expr _ => false | Result _ => true);
    53 
    54 fun memo_exec execution_id (Memo v) =
    55   Synchronized.timed_access v (K (SOME Time.zeroTime))
    56     (fn expr =>
    57       (case expr of
    58         Expr (exec_id, body) =>
    59           uninterruptible (fn restore_attributes => fn () =>
    60             if Execution.running execution_id exec_id then
    61               let
    62                 val res =
    63                   (body
    64                     |> restore_attributes
    65                     |> Future.worker_nest "Command.memo_exec"
    66                     |> Exn.interruptible_capture) ();
    67               in SOME ((), Result res) end
    68             else SOME ((), expr)) ()
    69       | Result _ => SOME ((), expr)))
    70   |> (fn NONE => error "Conflicting command execution" | _ => ());
    71 
    72 fun memo_fork params execution_id (Memo v) =
    73   (case Synchronized.value v of
    74     Result _ => ()
    75   | _ => ignore ((singleton o Future.forks) params (fn () => memo_exec execution_id (Memo v))));
    76 
    77 end;
    78 
    79 
    80 
    81 (** main phases of execution **)
    82 
    83 (* read *)
    84 
    85 fun read init span =
    86   let
    87     val outer_syntax = #2 (Outer_Syntax.get_syntax ());
    88     val command_reports = Outer_Syntax.command_reports outer_syntax;
    89 
    90     val proper_range =
    91       Position.set_range (Token.position_range_of (#1 (take_suffix Token.is_improper span)));
    92     val pos =
    93       (case find_first Token.is_command span of
    94         SOME tok => Token.position_of tok
    95       | NONE => proper_range);
    96 
    97     val (is_malformed, token_reports) = Thy_Syntax.reports_of_tokens span;
    98     val _ = Position.reports_text (token_reports @ maps command_reports span);
    99   in
   100     if is_malformed then Toplevel.malformed pos "Malformed command syntax"
   101     else
   102       (case Outer_Syntax.read_spans outer_syntax span of
   103         [tr] =>
   104           if Keyword.is_control (Toplevel.name_of tr) then
   105             Toplevel.malformed pos "Illegal control command"
   106           else Toplevel.modify_init init tr
   107       | [] => Toplevel.ignored (Position.set_range (Token.position_range_of span))
   108       | _ => Toplevel.malformed proper_range "Exactly one command expected")
   109       handle ERROR msg => Toplevel.malformed proper_range msg
   110   end;
   111 
   112 
   113 (* eval *)
   114 
   115 type eval_state =
   116   {failed: bool, malformed: bool, command: Toplevel.transition, state: Toplevel.state};
   117 val init_eval_state =
   118   {failed = false, malformed = false, command = Toplevel.empty, state = Toplevel.toplevel};
   119 
   120 datatype eval = Eval of {exec_id: Document_ID.exec, eval_process: eval_state memo};
   121 
   122 fun eval_eq (Eval {exec_id, ...}, Eval {exec_id = exec_id', ...}) = exec_id = exec_id';
   123 
   124 fun eval_running (Eval {exec_id, ...}) = Execution.is_running_exec exec_id;
   125 fun eval_finished (Eval {eval_process, ...}) = memo_finished eval_process;
   126 
   127 fun eval_result (Eval {eval_process, ...}) = memo_result eval_process;
   128 val eval_result_state = #state o eval_result;
   129 
   130 local
   131 
   132 fun run int tr st =
   133   if Goal.future_enabled 1 andalso Keyword.is_diag (Toplevel.name_of tr) then
   134     (Execution.fork {name = "Toplevel.diag", pos = Toplevel.pos_of tr, pri = ~1}
   135       (fn () => Toplevel.command_exception int tr st); ([], SOME st))
   136   else Toplevel.command_errors int tr st;
   137 
   138 fun check_cmts span tr st' =
   139   Toplevel.setmp_thread_position tr
   140     (fn () =>
   141       Outer_Syntax.side_comments span |> maps (fn cmt =>
   142         (Thy_Output.check_text (Token.source_position_of cmt) st'; [])
   143           handle exn =>
   144             if Exn.is_interrupt exn then reraise exn
   145             else ML_Compiler.exn_messages_ids exn)) ();
   146 
   147 fun proof_status tr st =
   148   (case try Toplevel.proof_of st of
   149     SOME prf => Toplevel.status tr (Proof.status_markup prf)
   150   | NONE => ());
   151 
   152 fun eval_state span tr ({malformed, state = st, ...}: eval_state) =
   153   if malformed then
   154     {failed = true, malformed = malformed, command = tr, state = Toplevel.toplevel}
   155   else
   156     let
   157       val malformed' = Toplevel.is_malformed tr;
   158       val is_init = Toplevel.is_init tr;
   159       val is_proof = Keyword.is_proof (Toplevel.name_of tr);
   160 
   161       val _ = Multithreading.interrupted ();
   162       val _ = Toplevel.status tr Markup.running;
   163       val (errs1, result) = run (is_init orelse is_proof) (Toplevel.set_print false tr) st;
   164       val errs2 = (case result of NONE => [] | SOME st' => check_cmts span tr st');
   165       val errs = errs1 @ errs2;
   166       val _ = Toplevel.status tr Markup.finished;
   167       val _ = List.app (Future.error_msg (Toplevel.pos_of tr)) errs;
   168     in
   169       (case result of
   170         NONE =>
   171           let
   172             val _ = if null errs then Exn.interrupt () else ();
   173             val _ = Toplevel.status tr Markup.failed;
   174           in {failed = true, malformed = malformed', command = tr, state = st} end
   175       | SOME st' =>
   176           let
   177             val _ = proof_status tr st';
   178           in {failed = false, malformed = malformed', command = tr, state = st'} end)
   179     end;
   180 
   181 in
   182 
   183 fun eval init span eval0 =
   184   let
   185     val exec_id = Document_ID.make ();
   186     fun process () =
   187       let
   188         val tr =
   189           Position.setmp_thread_data (Position.id_only (Document_ID.print exec_id))
   190             (fn () => read init span |> Toplevel.exec_id exec_id) ();
   191       in eval_state span tr (eval_result eval0) end;
   192   in Eval {exec_id = exec_id, eval_process = memo exec_id process} end;
   193 
   194 end;
   195 
   196 
   197 (* print *)
   198 
   199 datatype print = Print of
   200  {name: string, args: string list, delay: Time.time option, pri: int, persistent: bool,
   201   exec_id: Document_ID.exec, print_process: unit memo};
   202 
   203 type print_fn = Toplevel.transition -> Toplevel.state -> unit;
   204 
   205 type print_function =
   206   {command_name: string, args: string list} ->
   207     {delay: Time.time option, pri: int, persistent: bool, strict: bool, print_fn: print_fn} option;
   208 
   209 local
   210 
   211 val print_functions =
   212   Synchronized.var "Command.print_functions" ([]: (string * print_function) list);
   213 
   214 fun print_error tr e =
   215   (Toplevel.setmp_thread_position tr o Runtime.controlled_execution) e ()
   216     handle exn =>
   217       if Exn.is_interrupt exn then reraise exn
   218       else List.app (Future.error_msg (Toplevel.pos_of tr)) (ML_Compiler.exn_messages_ids exn);
   219 
   220 fun print_eq (Print {exec_id, ...}, Print {exec_id = exec_id', ...}) = exec_id = exec_id';
   221 
   222 fun print_finished (Print {print_process, ...}) = memo_finished print_process;
   223 
   224 fun print_persistent (Print {persistent, ...}) = persistent;
   225 
   226 val overlay_ord = prod_ord string_ord (list_ord string_ord);
   227 
   228 in
   229 
   230 fun print command_visible command_overlays command_name eval old_prints =
   231   let
   232     val print_functions = Synchronized.value print_functions;
   233 
   234     fun make_print name args {delay, pri, persistent, strict, print_fn} =
   235       let
   236         val exec_id = Document_ID.make ();
   237         fun process () =
   238           let
   239             val {failed, command, state = st', ...} = eval_result eval;
   240             val tr = Toplevel.exec_id exec_id command;
   241           in
   242             if failed andalso strict then ()
   243             else print_error tr (fn () => print_fn tr st')
   244           end;
   245       in
   246         Print {
   247           name = name, args = args, delay = delay, pri = pri, persistent = persistent,
   248           exec_id = exec_id, print_process = memo exec_id process}
   249       end;
   250 
   251     fun bad_print name args exn =
   252       make_print name args {delay = NONE, pri = 0, persistent = false,
   253         strict = false, print_fn = fn _ => fn _ => reraise exn};
   254 
   255     fun new_print name args get_pr =
   256       let
   257         val params = {command_name = command_name, args = args};
   258       in
   259         (case Exn.capture (Runtime.controlled_execution get_pr) params of
   260           Exn.Res NONE => NONE
   261         | Exn.Res (SOME pr) => SOME (make_print name args pr)
   262         | Exn.Exn exn => SOME (bad_print name args exn))
   263       end;
   264 
   265     fun get_print (a, b) =
   266       (case find_first (fn Print {name, args, ...} => name = a andalso args = b) old_prints of
   267         NONE =>
   268           (case AList.lookup (op =) print_functions a of
   269             NONE => SOME (bad_print a b (ERROR ("Missing print function " ^ quote a)))
   270           | SOME get_pr => new_print a b get_pr)
   271       | some => some);
   272 
   273     val new_prints =
   274       if command_visible then
   275         fold (fn (a, _) => cons (a, [])) print_functions command_overlays
   276         |> sort_distinct overlay_ord
   277         |> map_filter get_print
   278       else filter (fn print => print_finished print andalso print_persistent print) old_prints;
   279   in
   280     if eq_list print_eq (old_prints, new_prints) then NONE else SOME new_prints
   281   end;
   282 
   283 fun print_function name f =
   284   Synchronized.change print_functions (fn funs =>
   285    (if not (AList.defined (op =) funs name) then ()
   286     else warning ("Redefining command print function: " ^ quote name);
   287     AList.update (op =) (name, f) funs));
   288 
   289 fun no_print_function name =
   290   Synchronized.change print_functions (filter_out (equal name o #1));
   291 
   292 end;
   293 
   294 val _ =
   295   print_function "print_state"
   296     (fn {command_name, ...} =>
   297       SOME {delay = NONE, pri = 1, persistent = true, strict = true,
   298         print_fn = fn tr => fn st' =>
   299           let
   300             val is_init = Keyword.is_theory_begin command_name;
   301             val is_proof = Keyword.is_proof command_name;
   302             val do_print =
   303               not is_init andalso
   304                 (Toplevel.print_of tr orelse (is_proof andalso Toplevel.is_proof st'));
   305           in if do_print then Toplevel.print_state false st' else () end});
   306 
   307 
   308 (* combined execution *)
   309 
   310 type exec = eval * print list;
   311 val no_exec: exec =
   312   (Eval {exec_id = Document_ID.none, eval_process = memo_value init_eval_state}, []);
   313 
   314 fun exec_ids NONE = []
   315   | exec_ids (SOME (Eval {exec_id, ...}, prints)) =
   316       exec_id :: map (fn Print {exec_id, ...} => exec_id) prints;
   317 
   318 local
   319 
   320 fun run_print execution_id (Print {name, delay, pri, print_process, ...}) =
   321   if Multithreading.enabled () then
   322     let
   323       val group = Future.worker_subgroup ();
   324       fun fork () =
   325         memo_fork {name = name, group = SOME group, deps = [], pri = pri, interrupts = true}
   326           execution_id print_process;
   327     in
   328       (case delay of
   329         NONE => fork ()
   330       | SOME d => ignore (Event_Timer.request (Time.+ (Time.now (), d)) fork))
   331     end
   332   else memo_exec execution_id print_process;
   333 
   334 in
   335 
   336 fun exec execution_id (Eval {eval_process, ...}, prints) =
   337   (memo_exec execution_id eval_process; List.app (run_print execution_id) prints);
   338 
   339 end;
   340 
   341 end;
   342