src/Pure/System/isabelle_process.ML
author wenzelm
Fri Jun 01 13:02:09 2012 +0200 (2012-06-01 ago)
changeset 48056 396749e9daaf
parent 47410 33f2f968c0a1
child 48709 719f458cd89e
permissions -rw-r--r--
tuned message;
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@46548
     9
  . stderr \002: ML running
wenzelm@39528
    10
  .. stdin/stdout/stderr freely available (raw ML loop)
wenzelm@39528
    11
  .. protocol thread initialization
wenzelm@45029
    12
  ... rendezvous on system channel
wenzelm@45158
    13
  ... message INIT(pid): channels ready
wenzelm@46548
    14
  ... message RAW(keywords)
wenzelm@46548
    15
  ... message RAW(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@46119
    21
  val protocol_command: string -> (string list -> unit) -> unit
wenzelm@43684
    22
  val crashes: exn list Synchronized.var
wenzelm@45029
    23
  val init_fifos: string -> string -> unit
wenzelm@45028
    24
  val init_socket: 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@46119
    40
(* protocol 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@46119
    49
fun protocol_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@46119
    55
fun run_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@46119
    58
  | SOME cmd =>
wenzelm@46119
    59
      (Runtime.debugging cmd args handle exn =>
wenzelm@48056
    60
        error ("Isabelle process protocol failure: " ^ quote name ^ "\n" ^
wenzelm@48056
    61
          ML_Compiler.exn_message exn)));
wenzelm@38270
    62
wenzelm@38270
    63
end;
wenzelm@38270
    64
wenzelm@38270
    65
wenzelm@40134
    66
(* message channels *)
wenzelm@25841
    67
wenzelm@25841
    68
local
wenzelm@25810
    69
wenzelm@40134
    70
fun chunk s = [string_of_int (size s), "\n", s];
wenzelm@26574
    71
wenzelm@44731
    72
fun message do_flush mbox ch raw_props body =
wenzelm@43771
    73
  let
wenzelm@43772
    74
    val robust_props = map (pairself YXML.embed_controls) raw_props;
wenzelm@43771
    75
    val header = YXML.string_of (XML.Elem ((ch, robust_props), []));
wenzelm@44731
    76
  in Mailbox.send mbox (chunk header @ chunk body, do_flush) end;
wenzelm@25554
    77
wenzelm@44270
    78
fun standard_message mbox opt_serial ch body =
wenzelm@43771
    79
  if body = "" then ()
wenzelm@43771
    80
  else
wenzelm@44731
    81
    message false mbox ch
wenzelm@45666
    82
      ((case opt_serial of SOME i => cons (Isabelle_Markup.serialN, string_of_int i) | _ => I)
wenzelm@43771
    83
        (Position.properties_of (Position.thread_data ()))) body;
wenzelm@25554
    84
wenzelm@45029
    85
fun message_output mbox channel =
wenzelm@28188
    86
  let
wenzelm@45029
    87
    fun flush () = ignore (try System_Channel.flush channel);
wenzelm@40134
    88
    fun loop receive =
wenzelm@40134
    89
      (case receive mbox of
wenzelm@44731
    90
        SOME (msg, do_flush) =>
wenzelm@45029
    91
         (List.app (fn s => System_Channel.output channel s) msg;
wenzelm@44731
    92
          if do_flush then flush () else ();
wenzelm@40301
    93
          loop (Mailbox.receive_timeout (seconds 0.02)))
wenzelm@44731
    94
      | NONE => (flush (); loop (SOME o Mailbox.receive)));
wenzelm@40134
    95
  in fn () => loop (SOME o Mailbox.receive) end;
wenzelm@28188
    96
wenzelm@28188
    97
in
wenzelm@28188
    98
wenzelm@45029
    99
fun setup_channels channel =
wenzelm@28189
   100
  let
wenzelm@40134
   101
    val _ = TextIO.StreamIO.setBufferMode (TextIO.getOutstream TextIO.stdOut, IO.LINE_BUF);
wenzelm@40134
   102
    val _ = TextIO.StreamIO.setBufferMode (TextIO.getOutstream TextIO.stdErr, IO.LINE_BUF);
wenzelm@40134
   103
wenzelm@44731
   104
    val mbox = Mailbox.create () : (string list * bool) Mailbox.T;
wenzelm@45029
   105
    val _ = Simple_Thread.fork false (message_output mbox channel);
wenzelm@28044
   106
  in
wenzelm@44270
   107
    Output.Private_Hooks.status_fn := standard_message mbox NONE "B";
wenzelm@44270
   108
    Output.Private_Hooks.report_fn := standard_message mbox NONE "C";
wenzelm@44270
   109
    Output.Private_Hooks.writeln_fn := (fn s => standard_message mbox (SOME (serial ())) "D" s);
wenzelm@44270
   110
    Output.Private_Hooks.tracing_fn := (fn s => standard_message mbox (SOME (serial ())) "E" s);
wenzelm@44270
   111
    Output.Private_Hooks.warning_fn := (fn s => standard_message mbox (SOME (serial ())) "F" s);
wenzelm@44270
   112
    Output.Private_Hooks.error_fn := (fn (i, s) => standard_message mbox (SOME i) "G" s);
wenzelm@46774
   113
    Output.Private_Hooks.protocol_message_fn := message true mbox "H";
wenzelm@40133
   114
    Output.Private_Hooks.urgent_message_fn := ! Output.Private_Hooks.writeln_fn;
wenzelm@40133
   115
    Output.Private_Hooks.prompt_fn := ignore;
wenzelm@45028
   116
    message true mbox "A" [] (Session.welcome ())
wenzelm@28044
   117
  end;
wenzelm@25841
   118
wenzelm@28188
   119
end;
wenzelm@28188
   120
wenzelm@25841
   121
wenzelm@39234
   122
(* protocol loop -- uninterruptible *)
wenzelm@38270
   123
wenzelm@43684
   124
val crashes = Synchronized.var "Isabelle_Process.crashes" ([]: exn list);
wenzelm@38270
   125
wenzelm@38270
   126
local
wenzelm@38270
   127
wenzelm@38270
   128
fun recover crash =
wenzelm@43684
   129
  (Synchronized.change crashes (cons crash);
wenzelm@38270
   130
    warning "Recovering from Isabelle process crash -- see also Isabelle_Process.crashes");
wenzelm@38270
   131
wenzelm@45029
   132
fun read_chunk channel len =
wenzelm@38270
   133
  let
wenzelm@38270
   134
    val n =
wenzelm@38270
   135
      (case Int.fromString len of
wenzelm@38270
   136
        SOME n => n
wenzelm@38270
   137
      | NONE => error ("Isabelle process: malformed chunk header " ^ quote len));
wenzelm@45029
   138
    val chunk = System_Channel.inputN channel n;
wenzelm@38270
   139
    val m = size chunk;
wenzelm@38270
   140
  in
wenzelm@38270
   141
    if m = n then chunk
wenzelm@38270
   142
    else error ("Isabelle process: bad chunk (" ^ string_of_int m ^ " vs. " ^ string_of_int n ^ ")")
wenzelm@38270
   143
  end;
wenzelm@38270
   144
wenzelm@45029
   145
fun read_command channel =
wenzelm@45029
   146
  (case System_Channel.input_line channel of
wenzelm@38270
   147
    NONE => raise Runtime.TERMINATE
wenzelm@45029
   148
  | SOME line => map (read_chunk channel) (space_explode "," line));
wenzelm@38270
   149
wenzelm@38270
   150
in
wenzelm@38270
   151
wenzelm@45029
   152
fun loop channel =
wenzelm@38270
   153
  let val continue =
wenzelm@45029
   154
    (case read_command channel of
wenzelm@38270
   155
      [] => (Output.error_msg "Isabelle process: no input"; true)
wenzelm@38270
   156
    | name :: args => (run_command name args; true))
wenzelm@38270
   157
    handle Runtime.TERMINATE => false
wenzelm@38270
   158
      | exn => (Output.error_msg (ML_Compiler.exn_message exn) handle crash => recover crash; true);
wenzelm@45029
   159
  in if continue then loop channel else () end;
wenzelm@38270
   160
wenzelm@38270
   161
end;
wenzelm@38270
   162
wenzelm@38270
   163
wenzelm@25554
   164
(* init *)
wenzelm@25554
   165
wenzelm@45029
   166
fun init rendezvous = ignore (Simple_Thread.fork false (fn () =>
wenzelm@38253
   167
  let
wenzelm@40301
   168
    val _ = OS.Process.sleep (seconds 0.5);  (*yield to raw ML toplevel*)
wenzelm@46548
   169
    val _ = Output.physical_stderr Symbol.STX;
wenzelm@39528
   170
wenzelm@47396
   171
    val _ = quick_and_dirty := false;
wenzelm@47410
   172
    val _ = Goal.parallel_proofs := 0;
wenzelm@44988
   173
    val _ =
wenzelm@44988
   174
      if Multithreading.max_threads_value () < 2
wenzelm@44988
   175
      then Multithreading.max_threads := 2 else ();
wenzelm@39528
   176
    val _ = Context.set_thread_data NONE;
wenzelm@43671
   177
    val _ =
wenzelm@43671
   178
      Unsynchronized.change print_mode
wenzelm@45057
   179
        (fn mode =>
wenzelm@45057
   180
          (mode @ [Syntax_Trans.no_bracketsN, Syntax_Trans.no_type_bracketsN])
wenzelm@45057
   181
          |> fold (update op =)
wenzelm@45057
   182
            [Symbol.xsymbolsN, isabelle_processN, Keyword.keyword_statusN, Pretty.symbolicN]);
wenzelm@39528
   183
wenzelm@45029
   184
    val channel = rendezvous ();
wenzelm@45029
   185
    val _ = setup_channels channel;
wenzelm@45028
   186
wenzelm@38253
   187
    val _ = Keyword.status ();
wenzelm@43673
   188
    val _ = Thy_Info.status ();
wenzelm@46774
   189
    val _ = Output.protocol_message Isabelle_Markup.ready "";
wenzelm@45029
   190
  in loop channel end));
wenzelm@25528
   191
wenzelm@45029
   192
fun init_fifos fifo1 fifo2 = init (fn () => System_Channel.fifo_rendezvous fifo1 fifo2);
wenzelm@45029
   193
fun init_socket name = init (fn () => System_Channel.socket_rendezvous name);
wenzelm@45028
   194
wenzelm@25528
   195
end;
wenzelm@39528
   196