src/Pure/System/isabelle_process.ML
author wenzelm
Tue Sep 06 10:16:12 2011 +0200 (2011-09-06 ago)
changeset 44731 8f7b3a89fc15
parent 44389 a3b5fdfb04a3
child 44988 33aa6da101d8
permissions -rw-r--r--
flush after Output.raw_message (and init message) for reduced latency of important protocol events;
wenzelm@30173
     1
(*  Title:      Pure/System/isabelle_process.ML
wenzelm@25528
     2
    Author:     Makarius
wenzelm@25528
     3
wenzelm@38445
     4
Isabelle process wrapper, based on private fifos for maximum
wenzelm@38445
     5
robustness and performance.
wenzelm@39528
     6
wenzelm@39528
     7
Startup phases:
wenzelm@39528
     8
  . raw Posix process startup with uncontrolled output on stdout/stderr
wenzelm@39528
     9
  . stdout \002: ML running
wenzelm@39528
    10
  .. stdin/stdout/stderr freely available (raw ML loop)
wenzelm@39528
    11
  .. protocol thread initialization
wenzelm@39528
    12
  ... switch to in_fifo/out_fifo channels (rendezvous via open)
wenzelm@39528
    13
  ... out_fifo INIT(pid): channels ready
wenzelm@39528
    14
  ... out_fifo STATUS(keywords)
wenzelm@39528
    15
  ... out_fifo READY: main loop ready
wenzelm@25528
    16
*)
wenzelm@25528
    17
wenzelm@25528
    18
signature ISABELLE_PROCESS =
wenzelm@25528
    19
sig
wenzelm@42897
    20
  val is_active: unit -> bool
wenzelm@38270
    21
  val add_command: string -> (string list -> unit) -> unit
wenzelm@38270
    22
  val command: string -> string list -> unit
wenzelm@43684
    23
  val crashes: exn list Synchronized.var
wenzelm@38253
    24
  val init: string -> string -> unit
wenzelm@25528
    25
end;
wenzelm@25528
    26
wenzelm@31797
    27
structure Isabelle_Process: ISABELLE_PROCESS =
wenzelm@25528
    28
struct
wenzelm@25528
    29
wenzelm@42897
    30
(* print mode *)
wenzelm@25554
    31
wenzelm@25748
    32
val isabelle_processN = "isabelle_process";
wenzelm@25748
    33
wenzelm@42897
    34
fun is_active () = Print_Mode.print_mode_active isabelle_processN;
wenzelm@42897
    35
wenzelm@26550
    36
val _ = Output.add_mode isabelle_processN Output.default_output Output.default_escape;
wenzelm@28036
    37
val _ = Markup.add_mode isabelle_processN YXML.output_markup;
wenzelm@25841
    38
wenzelm@25841
    39
wenzelm@38270
    40
(* commands *)
wenzelm@38270
    41
wenzelm@38270
    42
local
wenzelm@38270
    43
wenzelm@43684
    44
val commands =
wenzelm@43684
    45
  Synchronized.var "Isabelle_Process.commands" (Symtab.empty: (string list -> unit) Symtab.table);
wenzelm@38270
    46
wenzelm@38270
    47
in
wenzelm@38270
    48
wenzelm@43684
    49
fun add_command name cmd =
wenzelm@43684
    50
  Synchronized.change commands (fn cmds =>
wenzelm@38270
    51
   (if not (Symtab.defined cmds name) then ()
wenzelm@38270
    52
    else warning ("Redefining Isabelle process command " ^ quote name);
wenzelm@43684
    53
    Symtab.update (name, cmd) cmds));
wenzelm@38270
    54
wenzelm@38270
    55
fun command name args =
wenzelm@43684
    56
  (case Symtab.lookup (Synchronized.value commands) name of
wenzelm@38270
    57
    NONE => error ("Undefined Isabelle process command " ^ quote name)
wenzelm@38270
    58
  | SOME cmd => cmd args);
wenzelm@38270
    59
wenzelm@38270
    60
end;
wenzelm@38270
    61
wenzelm@38270
    62
wenzelm@40134
    63
(* message channels *)
wenzelm@25841
    64
wenzelm@25841
    65
local
wenzelm@25810
    66
wenzelm@40134
    67
fun chunk s = [string_of_int (size s), "\n", s];
wenzelm@26574
    68
wenzelm@44731
    69
fun message do_flush mbox ch raw_props body =
wenzelm@43771
    70
  let
wenzelm@43772
    71
    val robust_props = map (pairself YXML.embed_controls) raw_props;
wenzelm@43771
    72
    val header = YXML.string_of (XML.Elem ((ch, robust_props), []));
wenzelm@44731
    73
  in Mailbox.send mbox (chunk header @ chunk body, do_flush) end;
wenzelm@25554
    74
wenzelm@44270
    75
fun standard_message mbox opt_serial ch body =
wenzelm@43771
    76
  if body = "" then ()
wenzelm@43771
    77
  else
wenzelm@44731
    78
    message false mbox ch
wenzelm@44270
    79
      ((case opt_serial of SOME i => cons (Markup.serialN, string_of_int i) | _ => I)
wenzelm@43771
    80
        (Position.properties_of (Position.thread_data ()))) body;
wenzelm@25554
    81
wenzelm@40134
    82
fun message_output mbox out_stream =
wenzelm@28188
    83
  let
wenzelm@44731
    84
    fun flush () = ignore (try TextIO.flushOut out_stream);
wenzelm@40134
    85
    fun loop receive =
wenzelm@40134
    86
      (case receive mbox of
wenzelm@44731
    87
        SOME (msg, do_flush) =>
wenzelm@40134
    88
         (List.app (fn s => TextIO.output (out_stream, s)) msg;
wenzelm@44731
    89
          if do_flush then flush () else ();
wenzelm@40301
    90
          loop (Mailbox.receive_timeout (seconds 0.02)))
wenzelm@44731
    91
      | NONE => (flush (); loop (SOME o Mailbox.receive)));
wenzelm@40134
    92
  in fn () => loop (SOME o Mailbox.receive) end;
wenzelm@28188
    93
wenzelm@28188
    94
in
wenzelm@28188
    95
wenzelm@38253
    96
fun setup_channels in_fifo out_fifo =
wenzelm@28189
    97
  let
wenzelm@39530
    98
    (*rendezvous*)
wenzelm@39530
    99
    val in_stream = TextIO.openIn in_fifo;
wenzelm@39530
   100
    val out_stream = TextIO.openOut out_fifo;
wenzelm@39530
   101
wenzelm@40134
   102
    val _ = TextIO.StreamIO.setBufferMode (TextIO.getOutstream TextIO.stdOut, IO.LINE_BUF);
wenzelm@40134
   103
    val _ = TextIO.StreamIO.setBufferMode (TextIO.getOutstream TextIO.stdErr, IO.LINE_BUF);
wenzelm@40134
   104
wenzelm@44731
   105
    val mbox = Mailbox.create () : (string list * bool) Mailbox.T;
wenzelm@40134
   106
    val _ = Simple_Thread.fork false (message_output mbox out_stream);
wenzelm@28044
   107
  in
wenzelm@44270
   108
    Output.Private_Hooks.status_fn := standard_message mbox NONE "B";
wenzelm@44270
   109
    Output.Private_Hooks.report_fn := standard_message mbox NONE "C";
wenzelm@44270
   110
    Output.Private_Hooks.writeln_fn := (fn s => standard_message mbox (SOME (serial ())) "D" s);
wenzelm@44270
   111
    Output.Private_Hooks.tracing_fn := (fn s => standard_message mbox (SOME (serial ())) "E" s);
wenzelm@44270
   112
    Output.Private_Hooks.warning_fn := (fn s => standard_message mbox (SOME (serial ())) "F" s);
wenzelm@44270
   113
    Output.Private_Hooks.error_fn := (fn (i, s) => standard_message mbox (SOME i) "G" s);
wenzelm@44731
   114
    Output.Private_Hooks.raw_message_fn := message true mbox "H";
wenzelm@40133
   115
    Output.Private_Hooks.urgent_message_fn := ! Output.Private_Hooks.writeln_fn;
wenzelm@40133
   116
    Output.Private_Hooks.prompt_fn := ignore;
wenzelm@44731
   117
    message true mbox "A" [] (Session.welcome ());
wenzelm@40134
   118
    in_stream
wenzelm@28044
   119
  end;
wenzelm@25841
   120
wenzelm@28188
   121
end;
wenzelm@28188
   122
wenzelm@25841
   123
wenzelm@39234
   124
(* protocol loop -- uninterruptible *)
wenzelm@38270
   125
wenzelm@43684
   126
val crashes = Synchronized.var "Isabelle_Process.crashes" ([]: exn list);
wenzelm@38270
   127
wenzelm@38270
   128
local
wenzelm@38270
   129
wenzelm@38270
   130
fun recover crash =
wenzelm@43684
   131
  (Synchronized.change crashes (cons crash);
wenzelm@38270
   132
    warning "Recovering from Isabelle process crash -- see also Isabelle_Process.crashes");
wenzelm@38270
   133
wenzelm@38270
   134
fun read_chunk stream len =
wenzelm@38270
   135
  let
wenzelm@38270
   136
    val n =
wenzelm@38270
   137
      (case Int.fromString len of
wenzelm@38270
   138
        SOME n => n
wenzelm@38270
   139
      | NONE => error ("Isabelle process: malformed chunk header " ^ quote len));
wenzelm@38270
   140
    val chunk = TextIO.inputN (stream, n);
wenzelm@38270
   141
    val m = size chunk;
wenzelm@38270
   142
  in
wenzelm@38270
   143
    if m = n then chunk
wenzelm@38270
   144
    else error ("Isabelle process: bad chunk (" ^ string_of_int m ^ " vs. " ^ string_of_int n ^ ")")
wenzelm@38270
   145
  end;
wenzelm@38270
   146
wenzelm@38270
   147
fun read_command stream =
wenzelm@38270
   148
  (case TextIO.inputLine stream of
wenzelm@38270
   149
    NONE => raise Runtime.TERMINATE
wenzelm@38270
   150
  | SOME line => map (read_chunk stream) (space_explode "," line));
wenzelm@38270
   151
wenzelm@38270
   152
fun run_command name args =
wenzelm@38270
   153
  Runtime.debugging (command name) args
wenzelm@38270
   154
    handle exn =>
wenzelm@38270
   155
      error ("Isabelle process command failure: " ^ name ^ "\n" ^ ML_Compiler.exn_message exn);
wenzelm@38270
   156
wenzelm@38270
   157
in
wenzelm@38270
   158
wenzelm@38270
   159
fun loop stream =
wenzelm@38270
   160
  let val continue =
wenzelm@38270
   161
    (case read_command stream of
wenzelm@38270
   162
      [] => (Output.error_msg "Isabelle process: no input"; true)
wenzelm@38270
   163
    | name :: args => (run_command name args; true))
wenzelm@38270
   164
    handle Runtime.TERMINATE => false
wenzelm@38270
   165
      | exn => (Output.error_msg (ML_Compiler.exn_message exn) handle crash => recover crash; true);
wenzelm@38270
   166
  in if continue then loop stream else () end;
wenzelm@38270
   167
wenzelm@38270
   168
end;
wenzelm@38270
   169
wenzelm@38270
   170
wenzelm@25554
   171
(* init *)
wenzelm@25554
   172
wenzelm@39528
   173
fun init in_fifo out_fifo = ignore (Simple_Thread.fork false (fn () =>
wenzelm@38253
   174
  let
wenzelm@40301
   175
    val _ = OS.Process.sleep (seconds 0.5);  (*yield to raw ML toplevel*)
wenzelm@44389
   176
    val _ = Output.physical_stdout Symbol.STX;
wenzelm@39528
   177
wenzelm@40521
   178
    val _ = quick_and_dirty := true;
wenzelm@40518
   179
    val _ = Goal.parallel_proofs := 0;
wenzelm@39528
   180
    val _ = Context.set_thread_data NONE;
wenzelm@43671
   181
    val _ =
wenzelm@43671
   182
      Unsynchronized.change print_mode
wenzelm@43671
   183
        (fold (update op =)
wenzelm@43671
   184
          [Symbol.xsymbolsN, isabelle_processN, Keyword.keyword_statusN, Pretty.symbolicN]);
wenzelm@39528
   185
wenzelm@40134
   186
    val in_stream = setup_channels in_fifo out_fifo;
wenzelm@38253
   187
    val _ = Keyword.status ();
wenzelm@43673
   188
    val _ = Thy_Info.status ();
wenzelm@39626
   189
    val _ = Output.status (Markup.markup Markup.ready "process ready");
wenzelm@39528
   190
  in loop in_stream end));
wenzelm@25528
   191
wenzelm@25528
   192
end;
wenzelm@39528
   193