src/Pure/PIDE/execution.ML
author wenzelm
Sun Jan 11 13:12:47 2015 +0100 (2015-01-11 ago)
changeset 59348 8a6788917b32
parent 56333 38f1422ef473
child 59467 58c4f3e1870f
permissions -rw-r--r--
do not crash into already running exec, instead join its lazy result in the subsequent step (amending 59f1591a11cb);
wenzelm@52605
     1
(*  Title:      Pure/PIDE/execution.ML
wenzelm@52596
     2
    Author:     Makarius
wenzelm@52596
     3
wenzelm@52606
     4
Global management of execution.  Unique running execution serves as
wenzelm@53192
     5
barrier for further exploration of forked command execs.
wenzelm@52596
     6
*)
wenzelm@52596
     7
wenzelm@52605
     8
signature EXECUTION =
wenzelm@52596
     9
sig
wenzelm@52606
    10
  val start: unit -> Document_ID.execution
wenzelm@52606
    11
  val discontinue: unit -> unit
wenzelm@52606
    12
  val is_running: Document_ID.execution -> bool
wenzelm@52784
    13
  val is_running_exec: Document_ID.exec -> bool
wenzelm@53375
    14
  val running: Document_ID.execution -> Document_ID.exec -> Future.group list -> bool
wenzelm@53192
    15
  val peek: Document_ID.exec -> Future.group list
wenzelm@52655
    16
  val cancel: Document_ID.exec -> unit
wenzelm@52655
    17
  val terminate: Document_ID.exec -> unit
wenzelm@56292
    18
  type params = {name: string, pos: Position.T, pri: int}
wenzelm@56292
    19
  val fork: params -> (unit -> 'a) -> 'a future
wenzelm@56305
    20
  val print: params -> (unit -> unit) -> unit
wenzelm@56292
    21
  val fork_prints: Document_ID.exec -> unit
wenzelm@53192
    22
  val purge: Document_ID.exec list -> unit
wenzelm@53192
    23
  val reset: unit -> Future.group list
wenzelm@53192
    24
  val shutdown: unit -> unit
wenzelm@52596
    25
end;
wenzelm@52596
    26
wenzelm@52605
    27
structure Execution: EXECUTION =
wenzelm@52596
    28
struct
wenzelm@52596
    29
wenzelm@52787
    30
(* global state *)
wenzelm@52787
    31
wenzelm@56292
    32
type print = {name: string, pri: int, body: unit -> unit};
wenzelm@56292
    33
type exec_state = Future.group list * print list;  (*active forks, prints*)
wenzelm@56291
    34
type state =
wenzelm@56291
    35
  Document_ID.execution * (*overall document execution*)
wenzelm@56291
    36
  exec_state Inttab.table;  (*running command execs*)
wenzelm@52787
    37
wenzelm@56291
    38
val init_state: state = (Document_ID.none, Inttab.make [(Document_ID.none, ([], []))]);
wenzelm@52787
    39
val state = Synchronized.var "Execution.state" init_state;
wenzelm@52602
    40
wenzelm@56291
    41
fun get_state () = Synchronized.value state;
wenzelm@56291
    42
fun change_state_result f = Synchronized.change_result state f;
wenzelm@56291
    43
fun change_state f = Synchronized.change state f;
wenzelm@56291
    44
wenzelm@56291
    45
fun unregistered exec_id = "Unregistered execution: " ^ Document_ID.print exec_id;
wenzelm@53192
    46
wenzelm@52604
    47
wenzelm@52606
    48
(* unique running execution *)
wenzelm@52604
    49
wenzelm@52606
    50
fun start () =
wenzelm@52602
    51
  let
wenzelm@52606
    52
    val execution_id = Document_ID.make ();
wenzelm@53192
    53
    val _ = change_state (apfst (K execution_id));
wenzelm@52606
    54
  in execution_id end;
wenzelm@52604
    55
wenzelm@53192
    56
fun discontinue () = change_state (apfst (K Document_ID.none));
wenzelm@52606
    57
wenzelm@56291
    58
fun is_running execution_id = execution_id = #1 (get_state ());
wenzelm@52604
    59
wenzelm@52604
    60
wenzelm@53192
    61
(* execs *)
wenzelm@52604
    62
wenzelm@52784
    63
fun is_running_exec exec_id =
wenzelm@56291
    64
  Inttab.defined (#2 (get_state ())) exec_id;
wenzelm@52784
    65
wenzelm@53375
    66
fun running execution_id exec_id groups =
wenzelm@56291
    67
  change_state_result (fn (execution_id', execs) =>
wenzelm@56291
    68
    let
wenzelm@59348
    69
      val ok = execution_id = execution_id' andalso not (Inttab.defined execs exec_id);
wenzelm@59348
    70
      val execs' = execs |> ok ? Inttab.update (exec_id, (groups, []));
wenzelm@59348
    71
    in (ok, (execution_id', execs')) end);
wenzelm@53192
    72
wenzelm@53192
    73
fun peek exec_id =
wenzelm@56291
    74
  (case Inttab.lookup (#2 (get_state ())) exec_id of
wenzelm@56291
    75
    SOME (groups, _) => groups
wenzelm@56291
    76
  | NONE => []);
wenzelm@53192
    77
wenzelm@53192
    78
fun cancel exec_id = List.app Future.cancel_group (peek exec_id);
wenzelm@53192
    79
fun terminate exec_id = List.app Future.terminate (peek exec_id);
wenzelm@53192
    80
wenzelm@53192
    81
wenzelm@53192
    82
(* fork *)
wenzelm@53192
    83
wenzelm@53192
    84
fun status task markups =
wenzelm@56296
    85
  let
wenzelm@56296
    86
    val props =
wenzelm@56296
    87
      if ! Multithreading.trace >= 2
wenzelm@56296
    88
      then [(Markup.taskN, Task_Queue.str_of_task task)] else [];
wenzelm@56296
    89
  in Output.status (implode (map (Markup.markup_only o Markup.properties props) markups)) end;
wenzelm@53192
    90
wenzelm@56292
    91
type params = {name: string, pos: Position.T, pri: int};
wenzelm@56292
    92
wenzelm@56292
    93
fun fork ({name, pos, pri}: params) e =
wenzelm@53192
    94
  uninterruptible (fn _ => Position.setmp_thread_data pos (fn () =>
wenzelm@53192
    95
    let
wenzelm@53192
    96
      val exec_id = the_default 0 (Position.parse_id pos);
wenzelm@53192
    97
      val group = Future.worker_subgroup ();
wenzelm@53375
    98
      val _ = change_state (apsnd (fn execs =>
wenzelm@56291
    99
        (case Inttab.lookup execs exec_id of
wenzelm@56291
   100
          SOME (groups, prints) =>
wenzelm@56291
   101
            Inttab.update (exec_id, (group :: groups, prints)) execs
wenzelm@56291
   102
        | NONE => raise Fail (unregistered exec_id))));
wenzelm@52655
   103
wenzelm@53192
   104
      val future =
wenzelm@53192
   105
        (singleton o Future.forks)
wenzelm@53192
   106
          {name = name, group = SOME group, deps = [], pri = pri, interrupts = false}
wenzelm@53192
   107
          (fn () =>
wenzelm@53192
   108
            let
wenzelm@53192
   109
              val task = the (Future.worker_task ());
wenzelm@53192
   110
              val _ = status task [Markup.running];
wenzelm@53192
   111
              val result =
wenzelm@53192
   112
                Exn.capture (Future.interruptible_task e) ()
wenzelm@53192
   113
                |> Future.identify_result pos;
wenzelm@54646
   114
              val _ = status task [Markup.joined];
wenzelm@53192
   115
              val _ =
wenzelm@53192
   116
                (case result of
wenzelm@54678
   117
                  Exn.Exn exn =>
wenzelm@54646
   118
                   (status task [Markup.failed];
wenzelm@54678
   119
                    status task [Markup.finished];
wenzelm@56333
   120
                    Output.report [Markup.markup_only Markup.bad];
wenzelm@54646
   121
                    if exec_id = 0 then ()
wenzelm@56333
   122
                    else List.app (Future.error_message pos) (Runtime.exn_messages_ids exn))
wenzelm@54678
   123
                | Exn.Res _ =>
wenzelm@54678
   124
                    status task [Markup.finished])
wenzelm@53192
   125
            in Exn.release result end);
wenzelm@54646
   126
wenzelm@53192
   127
      val _ = status (Future.task_of future) [Markup.forked];
wenzelm@53192
   128
    in future end)) ();
wenzelm@52604
   129
wenzelm@53192
   130
wenzelm@56291
   131
(* print *)
wenzelm@56291
   132
wenzelm@56305
   133
fun print ({name, pos, pri}: params) e =
wenzelm@56291
   134
  change_state (apsnd (fn execs =>
wenzelm@56291
   135
    let
wenzelm@56292
   136
      val exec_id = the_default 0 (Position.parse_id pos);
wenzelm@56305
   137
      val print = {name = name, pri = pri, body = e};
wenzelm@56291
   138
    in
wenzelm@56291
   139
      (case Inttab.lookup execs exec_id of
wenzelm@56292
   140
        SOME (groups, prints) => Inttab.update (exec_id, (groups, print :: prints)) execs
wenzelm@56291
   141
      | NONE => raise Fail (unregistered exec_id))
wenzelm@56291
   142
    end));
wenzelm@56291
   143
wenzelm@56292
   144
fun fork_prints exec_id =
wenzelm@56291
   145
  (case Inttab.lookup (#2 (get_state ())) exec_id of
wenzelm@56291
   146
    SOME (_, prints) =>
wenzelm@56291
   147
      if null prints orelse null (tl prints) orelse not (Multithreading.enabled ())
wenzelm@56292
   148
      then List.app (fn {body, ...} => body ()) (rev prints)
wenzelm@56291
   149
      else
wenzelm@56296
   150
        let val pos = Position.thread_data () in
wenzelm@56292
   151
          List.app (fn {name, pri, body} =>
wenzelm@56292
   152
            ignore (fork {name = name, pos = pos, pri = pri} body)) (rev prints)
wenzelm@56292
   153
        end
wenzelm@56291
   154
  | NONE => raise Fail (unregistered exec_id));
wenzelm@56291
   155
wenzelm@56291
   156
wenzelm@53192
   157
(* cleanup *)
wenzelm@53192
   158
wenzelm@53192
   159
fun purge exec_ids =
wenzelm@53192
   160
  (change_state o apsnd) (fn execs =>
wenzelm@53192
   161
    let
wenzelm@53192
   162
      val execs' = fold Inttab.delete_safe exec_ids execs;
wenzelm@53192
   163
      val () =
wenzelm@56291
   164
        (execs', ()) |-> Inttab.fold (fn (exec_id, (groups, _)) => fn () =>
wenzelm@53192
   165
          if Inttab.defined execs' exec_id then ()
wenzelm@53192
   166
          else groups |> List.app (fn group =>
wenzelm@53192
   167
            if Task_Queue.is_canceled group then ()
wenzelm@53375
   168
            else raise Fail ("Attempt to purge valid execution: " ^ Document_ID.print exec_id)));
wenzelm@53192
   169
    in execs' end);
wenzelm@53192
   170
wenzelm@53192
   171
fun reset () =
wenzelm@56291
   172
  change_state_result (fn (_, execs) =>
wenzelm@56291
   173
    let val groups = Inttab.fold (append o #1 o #2) execs []
wenzelm@53192
   174
    in (groups, init_state) end);
wenzelm@53192
   175
wenzelm@53192
   176
fun shutdown () =
wenzelm@53192
   177
  (Future.shutdown ();
wenzelm@53192
   178
    (case maps Task_Queue.group_status (reset ()) of
wenzelm@53192
   179
      [] => ()
wenzelm@53192
   180
    | exns => raise Par_Exn.make exns));
wenzelm@53192
   181
wenzelm@53192
   182
end;
wenzelm@53192
   183