src/Pure/System/isabelle_process.ML
author wenzelm
Tue May 21 18:03:36 2013 +0200 (2013-05-21 ago)
changeset 52105 88b423034d4f
parent 52104 250cd2a9308d
child 52111 1fd184eaa310
permissions -rw-r--r--
proper options;
tuned;
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@48712
     5
robustness and performance, or local socket for maximum portability.
wenzelm@39528
     6
wenzelm@39528
     7
Startup phases:
wenzelm@48712
     8
  - raw Posix process startup with uncontrolled output on stdout/stderr
wenzelm@48712
     9
  - stderr \002: ML running
wenzelm@48712
    10
  - stdin/stdout/stderr freely available (raw ML loop)
wenzelm@48712
    11
  - protocol thread initialization
wenzelm@48712
    12
  - rendezvous on system channel
wenzelm@48712
    13
  - message INIT: channels ready
wenzelm@25528
    14
*)
wenzelm@25528
    15
wenzelm@25528
    16
signature ISABELLE_PROCESS =
wenzelm@25528
    17
sig
wenzelm@42897
    18
  val is_active: unit -> bool
wenzelm@46119
    19
  val protocol_command: string -> (string list -> unit) -> unit
wenzelm@50505
    20
  val reset_tracing: unit -> unit
wenzelm@43684
    21
  val crashes: exn list Synchronized.var
wenzelm@45029
    22
  val init_fifos: string -> string -> unit
wenzelm@45028
    23
  val init_socket: string -> unit
wenzelm@25528
    24
end;
wenzelm@25528
    25
wenzelm@31797
    26
structure Isabelle_Process: ISABELLE_PROCESS =
wenzelm@25528
    27
struct
wenzelm@25528
    28
wenzelm@42897
    29
(* print mode *)
wenzelm@25554
    30
wenzelm@25748
    31
val isabelle_processN = "isabelle_process";
wenzelm@25748
    32
wenzelm@42897
    33
fun is_active () = Print_Mode.print_mode_active isabelle_processN;
wenzelm@42897
    34
wenzelm@26550
    35
val _ = Output.add_mode isabelle_processN Output.default_output Output.default_escape;
wenzelm@28036
    36
val _ = Markup.add_mode isabelle_processN YXML.output_markup;
wenzelm@25841
    37
wenzelm@25841
    38
wenzelm@46119
    39
(* protocol commands *)
wenzelm@38270
    40
wenzelm@38270
    41
local
wenzelm@38270
    42
wenzelm@43684
    43
val commands =
wenzelm@43684
    44
  Synchronized.var "Isabelle_Process.commands" (Symtab.empty: (string list -> unit) Symtab.table);
wenzelm@38270
    45
wenzelm@38270
    46
in
wenzelm@38270
    47
wenzelm@46119
    48
fun protocol_command name cmd =
wenzelm@43684
    49
  Synchronized.change commands (fn cmds =>
wenzelm@38270
    50
   (if not (Symtab.defined cmds name) then ()
wenzelm@38270
    51
    else warning ("Redefining Isabelle process command " ^ quote name);
wenzelm@43684
    52
    Symtab.update (name, cmd) cmds));
wenzelm@38270
    53
wenzelm@46119
    54
fun run_command name args =
wenzelm@43684
    55
  (case Symtab.lookup (Synchronized.value commands) name of
wenzelm@38270
    56
    NONE => error ("Undefined Isabelle process command " ^ quote name)
wenzelm@46119
    57
  | SOME cmd =>
wenzelm@46119
    58
      (Runtime.debugging cmd args handle exn =>
wenzelm@48056
    59
        error ("Isabelle process protocol failure: " ^ quote name ^ "\n" ^
wenzelm@48056
    60
          ML_Compiler.exn_message exn)));
wenzelm@38270
    61
wenzelm@38270
    62
end;
wenzelm@38270
    63
wenzelm@38270
    64
wenzelm@50505
    65
(* restricted tracing messages *)
wenzelm@49647
    66
wenzelm@52105
    67
val tracing_messages =
wenzelm@52105
    68
  Synchronized.var "tracing_messages" (Inttab.empty: int Inttab.table);
wenzelm@49647
    69
wenzelm@50505
    70
fun reset_tracing () =
wenzelm@52105
    71
  Synchronized.change tracing_messages (K Inttab.empty);
wenzelm@49647
    72
wenzelm@50505
    73
fun update_tracing () =
wenzelm@50911
    74
  (case Position.parse_id (Position.thread_data ()) of
wenzelm@49647
    75
    NONE => ()
wenzelm@49647
    76
  | SOME id =>
wenzelm@50505
    77
      let
wenzelm@50505
    78
        val (n, ok) =
wenzelm@52105
    79
          Synchronized.change_result tracing_messages (fn tab =>
wenzelm@50505
    80
            let
wenzelm@50911
    81
              val n = the_default 0 (Inttab.lookup tab id) + 1;
wenzelm@52105
    82
              val ok = n <= Options.default_int "editor_tracing_messages";
wenzelm@50911
    83
            in ((n, ok), Inttab.update (id, n) tab) end);
wenzelm@50505
    84
      in
wenzelm@50505
    85
        if ok then ()
wenzelm@50505
    86
        else
wenzelm@50505
    87
          let
wenzelm@50505
    88
            val (text, promise) = Active.dialog_text ();
wenzelm@50505
    89
            val _ =
wenzelm@50505
    90
              writeln ("Tracing paused.  " ^ text "Stop" ^ ", or continue with next " ^
wenzelm@51044
    91
                text "100" ^ ", " ^ text "1000" ^ ", " ^ text "10000" ^ " messages?")
wenzelm@50505
    92
            val m = Markup.parse_int (Future.join promise)
wenzelm@50505
    93
              handle Fail _ => error "Stopped";
wenzelm@50505
    94
          in
wenzelm@52105
    95
            Synchronized.change tracing_messages
wenzelm@50911
    96
              (Inttab.map_default (id, 0) (fn k => k - m))
wenzelm@50505
    97
          end
wenzelm@50505
    98
      end);
wenzelm@49647
    99
wenzelm@49647
   100
wenzelm@40134
   101
(* message channels *)
wenzelm@25841
   102
wenzelm@25841
   103
local
wenzelm@25810
   104
wenzelm@40134
   105
fun chunk s = [string_of_int (size s), "\n", s];
wenzelm@26574
   106
wenzelm@49677
   107
fun message do_flush mbox name raw_props body =
wenzelm@43771
   108
  let
wenzelm@43772
   109
    val robust_props = map (pairself YXML.embed_controls) raw_props;
wenzelm@49677
   110
    val header = YXML.string_of (XML.Elem ((name, robust_props), []));
wenzelm@44731
   111
  in Mailbox.send mbox (chunk header @ chunk body, do_flush) end;
wenzelm@25554
   112
wenzelm@49677
   113
fun standard_message mbox opt_serial name body =
wenzelm@43771
   114
  if body = "" then ()
wenzelm@43771
   115
  else
wenzelm@49677
   116
    message false mbox name
wenzelm@50254
   117
      ((case opt_serial of SOME i => cons (Markup.serialN, Markup.print_int i) | _ => I)
wenzelm@43771
   118
        (Position.properties_of (Position.thread_data ()))) body;
wenzelm@25554
   119
wenzelm@45029
   120
fun message_output mbox channel =
wenzelm@28188
   121
  let
wenzelm@45029
   122
    fun flush () = ignore (try System_Channel.flush channel);
wenzelm@40134
   123
    fun loop receive =
wenzelm@40134
   124
      (case receive mbox of
wenzelm@44731
   125
        SOME (msg, do_flush) =>
wenzelm@45029
   126
         (List.app (fn s => System_Channel.output channel s) msg;
wenzelm@44731
   127
          if do_flush then flush () else ();
wenzelm@40301
   128
          loop (Mailbox.receive_timeout (seconds 0.02)))
wenzelm@44731
   129
      | NONE => (flush (); loop (SOME o Mailbox.receive)));
wenzelm@40134
   130
  in fn () => loop (SOME o Mailbox.receive) end;
wenzelm@28188
   131
wenzelm@28188
   132
in
wenzelm@28188
   133
wenzelm@48712
   134
fun init_channels channel =
wenzelm@28189
   135
  let
wenzelm@40134
   136
    val _ = TextIO.StreamIO.setBufferMode (TextIO.getOutstream TextIO.stdOut, IO.LINE_BUF);
wenzelm@40134
   137
    val _ = TextIO.StreamIO.setBufferMode (TextIO.getOutstream TextIO.stdErr, IO.LINE_BUF);
wenzelm@40134
   138
wenzelm@44731
   139
    val mbox = Mailbox.create () : (string list * bool) Mailbox.T;
wenzelm@45029
   140
    val _ = Simple_Thread.fork false (message_output mbox channel);
wenzelm@28044
   141
  in
wenzelm@50201
   142
    Output.Private_Hooks.status_fn := standard_message mbox NONE Markup.statusN;
wenzelm@50201
   143
    Output.Private_Hooks.report_fn := standard_message mbox NONE Markup.reportN;
wenzelm@50503
   144
    Output.Private_Hooks.result_fn :=
wenzelm@50503
   145
      (fn (i, s) => standard_message mbox (SOME i) Markup.resultN s);
wenzelm@49677
   146
    Output.Private_Hooks.writeln_fn :=
wenzelm@50201
   147
      (fn s => standard_message mbox (SOME (serial ())) Markup.writelnN s);
wenzelm@49647
   148
    Output.Private_Hooks.tracing_fn :=
wenzelm@50505
   149
      (fn s => (update_tracing (); standard_message mbox (SOME (serial ())) Markup.tracingN s));
wenzelm@49677
   150
    Output.Private_Hooks.warning_fn :=
wenzelm@50201
   151
      (fn s => standard_message mbox (SOME (serial ())) Markup.warningN s);
wenzelm@49677
   152
    Output.Private_Hooks.error_fn :=
wenzelm@50201
   153
      (fn (i, s) => standard_message mbox (SOME i) Markup.errorN s);
wenzelm@50201
   154
    Output.Private_Hooks.protocol_message_fn := message true mbox Markup.protocolN;
wenzelm@40133
   155
    Output.Private_Hooks.urgent_message_fn := ! Output.Private_Hooks.writeln_fn;
wenzelm@40133
   156
    Output.Private_Hooks.prompt_fn := ignore;
wenzelm@50201
   157
    message true mbox Markup.initN [] (Session.welcome ())
wenzelm@28044
   158
  end;
wenzelm@25841
   159
wenzelm@28188
   160
end;
wenzelm@28188
   161
wenzelm@25841
   162
wenzelm@39234
   163
(* protocol loop -- uninterruptible *)
wenzelm@38270
   164
wenzelm@43684
   165
val crashes = Synchronized.var "Isabelle_Process.crashes" ([]: exn list);
wenzelm@38270
   166
wenzelm@38270
   167
local
wenzelm@38270
   168
wenzelm@38270
   169
fun recover crash =
wenzelm@43684
   170
  (Synchronized.change crashes (cons crash);
wenzelm@38270
   171
    warning "Recovering from Isabelle process crash -- see also Isabelle_Process.crashes");
wenzelm@38270
   172
wenzelm@45029
   173
fun read_chunk channel len =
wenzelm@38270
   174
  let
wenzelm@38270
   175
    val n =
wenzelm@38270
   176
      (case Int.fromString len of
wenzelm@38270
   177
        SOME n => n
wenzelm@38270
   178
      | NONE => error ("Isabelle process: malformed chunk header " ^ quote len));
wenzelm@45029
   179
    val chunk = System_Channel.inputN channel n;
wenzelm@38270
   180
    val m = size chunk;
wenzelm@38270
   181
  in
wenzelm@38270
   182
    if m = n then chunk
wenzelm@38270
   183
    else error ("Isabelle process: bad chunk (" ^ string_of_int m ^ " vs. " ^ string_of_int n ^ ")")
wenzelm@38270
   184
  end;
wenzelm@38270
   185
wenzelm@45029
   186
fun read_command channel =
wenzelm@45029
   187
  (case System_Channel.input_line channel of
wenzelm@38270
   188
    NONE => raise Runtime.TERMINATE
wenzelm@45029
   189
  | SOME line => map (read_chunk channel) (space_explode "," line));
wenzelm@38270
   190
wenzelm@38270
   191
in
wenzelm@38270
   192
wenzelm@45029
   193
fun loop channel =
wenzelm@38270
   194
  let val continue =
wenzelm@45029
   195
    (case read_command channel of
wenzelm@38270
   196
      [] => (Output.error_msg "Isabelle process: no input"; true)
wenzelm@38270
   197
    | name :: args => (run_command name args; true))
wenzelm@38270
   198
    handle Runtime.TERMINATE => false
wenzelm@38270
   199
      | exn => (Output.error_msg (ML_Compiler.exn_message exn) handle crash => recover crash; true);
wenzelm@45029
   200
  in if continue then loop channel else () end;
wenzelm@38270
   201
wenzelm@38270
   202
end;
wenzelm@38270
   203
wenzelm@38270
   204
wenzelm@25554
   205
(* init *)
wenzelm@25554
   206
wenzelm@50715
   207
val default_modes1 =
wenzelm@50715
   208
  [Syntax_Trans.no_bracketsN, Syntax_Trans.no_type_bracketsN, Graph_Display.active_graphN];
wenzelm@50715
   209
val default_modes2 = [Symbol.xsymbolsN, isabelle_processN, Pretty.symbolicN];
wenzelm@49566
   210
wenzelm@45029
   211
fun init rendezvous = ignore (Simple_Thread.fork false (fn () =>
wenzelm@38253
   212
  let
wenzelm@40301
   213
    val _ = OS.Process.sleep (seconds 0.5);  (*yield to raw ML toplevel*)
wenzelm@46548
   214
    val _ = Output.physical_stderr Symbol.STX;
wenzelm@39528
   215
wenzelm@49661
   216
    val _ = Printer.show_markup_default := true;
wenzelm@39528
   217
    val _ = Context.set_thread_data NONE;
wenzelm@43671
   218
    val _ =
wenzelm@43671
   219
      Unsynchronized.change print_mode
wenzelm@49566
   220
        (fn mode => (mode @ default_modes1) |> fold (update op =) default_modes2);
wenzelm@39528
   221
wenzelm@45029
   222
    val channel = rendezvous ();
wenzelm@48712
   223
    val _ = init_channels channel;
wenzelm@45029
   224
  in loop channel end));
wenzelm@25528
   225
wenzelm@45029
   226
fun init_fifos fifo1 fifo2 = init (fn () => System_Channel.fifo_rendezvous fifo1 fifo2);
wenzelm@45029
   227
fun init_socket name = init (fn () => System_Channel.socket_rendezvous name);
wenzelm@45028
   228
wenzelm@50117
   229
wenzelm@50117
   230
(* options *)
wenzelm@50117
   231
wenzelm@50117
   232
val _ =
wenzelm@50117
   233
  protocol_command "Isabelle_Process.options"
wenzelm@50117
   234
    (fn [options_yxml] =>
wenzelm@50117
   235
      let val options = Options.decode (YXML.parse_body options_yxml) in
wenzelm@51941
   236
        Options.set_default options;
wenzelm@50698
   237
        Future.ML_statistics := true;
wenzelm@50117
   238
        Multithreading.trace := Options.int options "threads_trace";
wenzelm@50117
   239
        Multithreading.max_threads := Options.int options "threads";
wenzelm@50117
   240
        if Multithreading.max_threads_value () < 2
wenzelm@50117
   241
        then Multithreading.max_threads := 2 else ();
wenzelm@51554
   242
        Goal.skip_proofs := Options.bool options "editor_skip_proofs";
wenzelm@52105
   243
        Goal.parallel_proofs := (if Options.int options "parallel_proofs" > 0 then 3 else 0)
wenzelm@50117
   244
      end);
wenzelm@50117
   245
wenzelm@25528
   246
end;
wenzelm@39528
   247