src/Pure/PIDE/execution.ML
author wenzelm
Wed Mar 26 12:15:42 2014 +0100 (2014-03-26 ago)
changeset 56291 e79f76a48449
parent 54678 87910da843d5
child 56292 1a91a0da65ab
permissions -rw-r--r--
added Execution.print: accumulate print operations for some command execution, which are applied later and print time;
misc tuning;
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@53192
    18
  val fork: {name: string, pos: Position.T, pri: int} -> (unit -> 'a) -> 'a future
wenzelm@56291
    19
  val print: (serial -> unit) -> unit
wenzelm@56291
    20
  val apply_prints: Document_ID.exec -> unit
wenzelm@53192
    21
  val purge: Document_ID.exec list -> unit
wenzelm@53192
    22
  val reset: unit -> Future.group list
wenzelm@53192
    23
  val shutdown: unit -> unit
wenzelm@52596
    24
end;
wenzelm@52596
    25
wenzelm@52605
    26
structure Execution: EXECUTION =
wenzelm@52596
    27
struct
wenzelm@52596
    28
wenzelm@52787
    29
(* global state *)
wenzelm@52787
    30
wenzelm@56291
    31
type exec_state = Future.group list * (unit -> unit) list;  (*active forks, prints*)
wenzelm@56291
    32
type state =
wenzelm@56291
    33
  Document_ID.execution * (*overall document execution*)
wenzelm@56291
    34
  exec_state Inttab.table;  (*running command execs*)
wenzelm@52787
    35
wenzelm@56291
    36
val init_state: state = (Document_ID.none, Inttab.make [(Document_ID.none, ([], []))]);
wenzelm@52787
    37
val state = Synchronized.var "Execution.state" init_state;
wenzelm@52602
    38
wenzelm@56291
    39
fun get_state () = Synchronized.value state;
wenzelm@56291
    40
fun change_state_result f = Synchronized.change_result state f;
wenzelm@56291
    41
fun change_state f = Synchronized.change state f;
wenzelm@56291
    42
wenzelm@56291
    43
fun unregistered exec_id = "Unregistered execution: " ^ Document_ID.print exec_id;
wenzelm@53192
    44
wenzelm@52604
    45
wenzelm@52606
    46
(* unique running execution *)
wenzelm@52604
    47
wenzelm@52606
    48
fun start () =
wenzelm@52602
    49
  let
wenzelm@52606
    50
    val execution_id = Document_ID.make ();
wenzelm@53192
    51
    val _ = change_state (apfst (K execution_id));
wenzelm@52606
    52
  in execution_id end;
wenzelm@52604
    53
wenzelm@53192
    54
fun discontinue () = change_state (apfst (K Document_ID.none));
wenzelm@52606
    55
wenzelm@56291
    56
fun is_running execution_id = execution_id = #1 (get_state ());
wenzelm@52604
    57
wenzelm@52604
    58
wenzelm@53192
    59
(* execs *)
wenzelm@52604
    60
wenzelm@52784
    61
fun is_running_exec exec_id =
wenzelm@56291
    62
  Inttab.defined (#2 (get_state ())) exec_id;
wenzelm@52784
    63
wenzelm@53375
    64
fun running execution_id exec_id groups =
wenzelm@56291
    65
  change_state_result (fn (execution_id', execs) =>
wenzelm@56291
    66
    let
wenzelm@56291
    67
      val continue = execution_id = execution_id';
wenzelm@56291
    68
      val execs' =
wenzelm@56291
    69
        if continue then
wenzelm@56291
    70
          Inttab.update_new (exec_id, (groups, [])) execs
wenzelm@56291
    71
            handle Inttab.DUP dup =>
wenzelm@56291
    72
              raise Fail ("Execution already registered: " ^ Document_ID.print dup)
wenzelm@56291
    73
        else execs;
wenzelm@56291
    74
    in (continue, (execution_id', execs')) end);
wenzelm@53192
    75
wenzelm@53192
    76
fun peek exec_id =
wenzelm@56291
    77
  (case Inttab.lookup (#2 (get_state ())) exec_id of
wenzelm@56291
    78
    SOME (groups, _) => groups
wenzelm@56291
    79
  | NONE => []);
wenzelm@53192
    80
wenzelm@53192
    81
fun cancel exec_id = List.app Future.cancel_group (peek exec_id);
wenzelm@53192
    82
fun terminate exec_id = List.app Future.terminate (peek exec_id);
wenzelm@53192
    83
wenzelm@53192
    84
wenzelm@53192
    85
(* fork *)
wenzelm@53192
    86
wenzelm@53192
    87
fun status task markups =
wenzelm@53192
    88
  let val props = Markup.properties [(Markup.taskN, Task_Queue.str_of_task task)]
wenzelm@53192
    89
  in Output.status (implode (map (Markup.markup_only o props) markups)) end;
wenzelm@53192
    90
wenzelm@53192
    91
fun fork {name, pos, pri} e =
wenzelm@53192
    92
  uninterruptible (fn _ => Position.setmp_thread_data pos (fn () =>
wenzelm@53192
    93
    let
wenzelm@53192
    94
      val exec_id = the_default 0 (Position.parse_id pos);
wenzelm@53192
    95
      val group = Future.worker_subgroup ();
wenzelm@53375
    96
      val _ = change_state (apsnd (fn execs =>
wenzelm@56291
    97
        (case Inttab.lookup execs exec_id of
wenzelm@56291
    98
          SOME (groups, prints) =>
wenzelm@56291
    99
            Inttab.update (exec_id, (group :: groups, prints)) execs
wenzelm@56291
   100
        | NONE => raise Fail (unregistered exec_id))));
wenzelm@52655
   101
wenzelm@53192
   102
      val future =
wenzelm@53192
   103
        (singleton o Future.forks)
wenzelm@53192
   104
          {name = name, group = SOME group, deps = [], pri = pri, interrupts = false}
wenzelm@53192
   105
          (fn () =>
wenzelm@53192
   106
            let
wenzelm@53192
   107
              val task = the (Future.worker_task ());
wenzelm@53192
   108
              val _ = status task [Markup.running];
wenzelm@53192
   109
              val result =
wenzelm@53192
   110
                Exn.capture (Future.interruptible_task e) ()
wenzelm@53192
   111
                |> Future.identify_result pos;
wenzelm@54646
   112
              val _ = status task [Markup.joined];
wenzelm@53192
   113
              val _ =
wenzelm@53192
   114
                (case result of
wenzelm@54678
   115
                  Exn.Exn exn =>
wenzelm@54646
   116
                   (status task [Markup.failed];
wenzelm@54678
   117
                    status task [Markup.finished];
wenzelm@54646
   118
                    Output.report (Markup.markup_only Markup.bad);
wenzelm@54646
   119
                    if exec_id = 0 then ()
wenzelm@54678
   120
                    else List.app (Future.error_msg pos) (ML_Compiler.exn_messages_ids exn))
wenzelm@54678
   121
                | Exn.Res _ =>
wenzelm@54678
   122
                    status task [Markup.finished])
wenzelm@53192
   123
            in Exn.release result end);
wenzelm@54646
   124
wenzelm@53192
   125
      val _ = status (Future.task_of future) [Markup.forked];
wenzelm@53192
   126
    in future end)) ();
wenzelm@52604
   127
wenzelm@53192
   128
wenzelm@56291
   129
(* print *)
wenzelm@56291
   130
wenzelm@56291
   131
fun print pr =
wenzelm@56291
   132
  change_state (apsnd (fn execs =>
wenzelm@56291
   133
    let
wenzelm@56291
   134
      val exec_id = the_default 0 (Position.parse_id (Position.thread_data ()));
wenzelm@56291
   135
      val i = serial ();
wenzelm@56291
   136
    in
wenzelm@56291
   137
      (case Inttab.lookup execs exec_id of
wenzelm@56291
   138
        SOME (groups, prints) =>
wenzelm@56291
   139
          Inttab.update (exec_id, (groups, (fn () => pr i) :: prints)) execs
wenzelm@56291
   140
      | NONE => raise Fail (unregistered exec_id))
wenzelm@56291
   141
    end));
wenzelm@56291
   142
wenzelm@56291
   143
fun apply_prints exec_id =
wenzelm@56291
   144
  (case Inttab.lookup (#2 (get_state ())) exec_id of
wenzelm@56291
   145
    SOME (_, prints) =>
wenzelm@56291
   146
      if null prints orelse null (tl prints) orelse not (Multithreading.enabled ())
wenzelm@56291
   147
      then List.app (fn e => e ()) (rev prints)
wenzelm@56291
   148
      else
wenzelm@56291
   149
        let
wenzelm@56291
   150
          val pos = Position.thread_data ();
wenzelm@56291
   151
          val pri =
wenzelm@56291
   152
            (case Future.worker_task () of
wenzelm@56291
   153
              SOME task => Task_Queue.pri_of_task task
wenzelm@56291
   154
            | NONE => 0);
wenzelm@56291
   155
          val futures = map (fork {name = "Execution.print", pos = pos, pri = pri}) (rev prints);
wenzelm@56291
   156
        in ignore (Future.joins futures) end
wenzelm@56291
   157
  | NONE => raise Fail (unregistered exec_id));
wenzelm@56291
   158
wenzelm@56291
   159
wenzelm@53192
   160
(* cleanup *)
wenzelm@53192
   161
wenzelm@53192
   162
fun purge exec_ids =
wenzelm@53192
   163
  (change_state o apsnd) (fn execs =>
wenzelm@53192
   164
    let
wenzelm@53192
   165
      val execs' = fold Inttab.delete_safe exec_ids execs;
wenzelm@53192
   166
      val () =
wenzelm@56291
   167
        (execs', ()) |-> Inttab.fold (fn (exec_id, (groups, _)) => fn () =>
wenzelm@53192
   168
          if Inttab.defined execs' exec_id then ()
wenzelm@53192
   169
          else groups |> List.app (fn group =>
wenzelm@53192
   170
            if Task_Queue.is_canceled group then ()
wenzelm@53375
   171
            else raise Fail ("Attempt to purge valid execution: " ^ Document_ID.print exec_id)));
wenzelm@53192
   172
    in execs' end);
wenzelm@53192
   173
wenzelm@53192
   174
fun reset () =
wenzelm@56291
   175
  change_state_result (fn (_, execs) =>
wenzelm@56291
   176
    let val groups = Inttab.fold (append o #1 o #2) execs []
wenzelm@53192
   177
    in (groups, init_state) end);
wenzelm@53192
   178
wenzelm@53192
   179
fun shutdown () =
wenzelm@53192
   180
  (Future.shutdown ();
wenzelm@53192
   181
    (case maps Task_Queue.group_status (reset ()) of
wenzelm@53192
   182
      [] => ()
wenzelm@53192
   183
    | exns => raise Par_Exn.make exns));
wenzelm@53192
   184
wenzelm@53192
   185
end;
wenzelm@53192
   186