src/Pure/System/isabelle_process.ML
author wenzelm
Mon Jul 15 10:25:35 2013 +0200 (2013-07-15 ago)
changeset 52655 3b2b1ef13979
parent 52584 5cad4a5f5615
child 52710 52790e3961fe
permissions -rw-r--r--
more careful termination of removed execs, leaving running execs undisturbed;
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@52655
    20
  val reset_tracing: Document_ID.exec -> 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@52582
    51
    else warning ("Redefining Isabelle protocol 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@52582
    56
    NONE => error ("Undefined Isabelle protocol command " ^ quote name)
wenzelm@46119
    57
  | SOME cmd =>
wenzelm@46119
    58
      (Runtime.debugging cmd args handle exn =>
wenzelm@52582
    59
        error ("Isabelle protocol command 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@52655
    70
fun reset_tracing exec_id =
wenzelm@52655
    71
  Synchronized.change tracing_messages (Inttab.delete_safe exec_id);
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@52655
    76
  | SOME exec_id =>
wenzelm@50505
    77
      let
wenzelm@52560
    78
        val ok =
wenzelm@52105
    79
          Synchronized.change_result tracing_messages (fn tab =>
wenzelm@50505
    80
            let
wenzelm@52655
    81
              val n = the_default 0 (Inttab.lookup tab exec_id) + 1;
wenzelm@52105
    82
              val ok = n <= Options.default_int "editor_tracing_messages";
wenzelm@52655
    83
            in (ok, Inttab.update (exec_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@52655
    96
              (Inttab.map_default (exec_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@52584
   107
fun message do_flush msg_channel 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@52580
   111
    val msg = chunk header @ chunk body;
wenzelm@52584
   112
  in Message_Channel.send msg_channel msg do_flush end;
wenzelm@52583
   113
wenzelm@28188
   114
in
wenzelm@28188
   115
wenzelm@48712
   116
fun init_channels channel =
wenzelm@28189
   117
  let
wenzelm@40134
   118
    val _ = TextIO.StreamIO.setBufferMode (TextIO.getOutstream TextIO.stdOut, IO.LINE_BUF);
wenzelm@40134
   119
    val _ = TextIO.StreamIO.setBufferMode (TextIO.getOutstream TextIO.stdErr, IO.LINE_BUF);
wenzelm@40134
   120
wenzelm@52584
   121
    val msg_channel = Message_Channel.make channel;
wenzelm@52580
   122
wenzelm@52580
   123
    fun standard_message opt_serial name body =
wenzelm@52580
   124
      if body = "" then ()
wenzelm@52580
   125
      else
wenzelm@52584
   126
        message false msg_channel name
wenzelm@52580
   127
          ((case opt_serial of SOME i => cons (Markup.serialN, Markup.print_int i) | _ => I)
wenzelm@52580
   128
            (Position.properties_of (Position.thread_data ()))) body;
wenzelm@28044
   129
  in
wenzelm@52580
   130
    Output.Private_Hooks.status_fn := standard_message NONE Markup.statusN;
wenzelm@52580
   131
    Output.Private_Hooks.report_fn := standard_message NONE Markup.reportN;
wenzelm@52580
   132
    Output.Private_Hooks.result_fn := (fn (i, s) => standard_message (SOME i) Markup.resultN s);
wenzelm@49677
   133
    Output.Private_Hooks.writeln_fn :=
wenzelm@52580
   134
      (fn s => standard_message (SOME (serial ())) Markup.writelnN s);
wenzelm@49647
   135
    Output.Private_Hooks.tracing_fn :=
wenzelm@52580
   136
      (fn s => (update_tracing (); standard_message (SOME (serial ())) Markup.tracingN s));
wenzelm@49677
   137
    Output.Private_Hooks.warning_fn :=
wenzelm@52580
   138
      (fn s => standard_message (SOME (serial ())) Markup.warningN s);
wenzelm@49677
   139
    Output.Private_Hooks.error_fn :=
wenzelm@52580
   140
      (fn (i, s) => standard_message (SOME i) Markup.errorN s);
wenzelm@52584
   141
    Output.Private_Hooks.protocol_message_fn := message true msg_channel Markup.protocolN;
wenzelm@40133
   142
    Output.Private_Hooks.urgent_message_fn := ! Output.Private_Hooks.writeln_fn;
wenzelm@40133
   143
    Output.Private_Hooks.prompt_fn := ignore;
wenzelm@52584
   144
    message true msg_channel Markup.initN [] (Session.welcome ());
wenzelm@52584
   145
    msg_channel
wenzelm@28044
   146
  end;
wenzelm@25841
   147
wenzelm@28188
   148
end;
wenzelm@28188
   149
wenzelm@25841
   150
wenzelm@39234
   151
(* protocol loop -- uninterruptible *)
wenzelm@38270
   152
wenzelm@43684
   153
val crashes = Synchronized.var "Isabelle_Process.crashes" ([]: exn list);
wenzelm@38270
   154
wenzelm@38270
   155
local
wenzelm@38270
   156
wenzelm@38270
   157
fun recover crash =
wenzelm@43684
   158
  (Synchronized.change crashes (cons crash);
wenzelm@38270
   159
    warning "Recovering from Isabelle process crash -- see also Isabelle_Process.crashes");
wenzelm@38270
   160
wenzelm@45029
   161
fun read_chunk channel len =
wenzelm@38270
   162
  let
wenzelm@38270
   163
    val n =
wenzelm@38270
   164
      (case Int.fromString len of
wenzelm@38270
   165
        SOME n => n
wenzelm@38270
   166
      | NONE => error ("Isabelle process: malformed chunk header " ^ quote len));
wenzelm@45029
   167
    val chunk = System_Channel.inputN channel n;
wenzelm@38270
   168
    val m = size chunk;
wenzelm@38270
   169
  in
wenzelm@38270
   170
    if m = n then chunk
wenzelm@38270
   171
    else error ("Isabelle process: bad chunk (" ^ string_of_int m ^ " vs. " ^ string_of_int n ^ ")")
wenzelm@38270
   172
  end;
wenzelm@38270
   173
wenzelm@45029
   174
fun read_command channel =
wenzelm@45029
   175
  (case System_Channel.input_line channel of
wenzelm@38270
   176
    NONE => raise Runtime.TERMINATE
wenzelm@45029
   177
  | SOME line => map (read_chunk channel) (space_explode "," line));
wenzelm@38270
   178
wenzelm@52559
   179
fun worker_guest e =
wenzelm@52559
   180
  Future.worker_guest "Isabelle_Process.loop" (Future.new_group NONE) e ();
wenzelm@52559
   181
wenzelm@38270
   182
in
wenzelm@38270
   183
wenzelm@45029
   184
fun loop channel =
wenzelm@38270
   185
  let val continue =
wenzelm@45029
   186
    (case read_command channel of
wenzelm@38270
   187
      [] => (Output.error_msg "Isabelle process: no input"; true)
wenzelm@52559
   188
    | name :: args => (worker_guest (fn () => run_command name args); true))
wenzelm@38270
   189
    handle Runtime.TERMINATE => false
wenzelm@38270
   190
      | exn => (Output.error_msg (ML_Compiler.exn_message exn) handle crash => recover crash; true);
wenzelm@45029
   191
  in if continue then loop channel else () end;
wenzelm@38270
   192
wenzelm@38270
   193
end;
wenzelm@38270
   194
wenzelm@38270
   195
wenzelm@25554
   196
(* init *)
wenzelm@25554
   197
wenzelm@50715
   198
val default_modes1 =
wenzelm@50715
   199
  [Syntax_Trans.no_bracketsN, Syntax_Trans.no_type_bracketsN, Graph_Display.active_graphN];
wenzelm@50715
   200
val default_modes2 = [Symbol.xsymbolsN, isabelle_processN, Pretty.symbolicN];
wenzelm@49566
   201
wenzelm@52578
   202
val init = uninterruptible (fn _ => fn rendezvous =>
wenzelm@38253
   203
  let
wenzelm@46548
   204
    val _ = Output.physical_stderr Symbol.STX;
wenzelm@39528
   205
wenzelm@49661
   206
    val _ = Printer.show_markup_default := true;
wenzelm@39528
   207
    val _ = Context.set_thread_data NONE;
wenzelm@43671
   208
    val _ =
wenzelm@43671
   209
      Unsynchronized.change print_mode
wenzelm@49566
   210
        (fn mode => (mode @ default_modes1) |> fold (update op =) default_modes2);
wenzelm@39528
   211
wenzelm@45029
   212
    val channel = rendezvous ();
wenzelm@52584
   213
    val msg_channel = init_channels channel;
wenzelm@52111
   214
    val _ = Session.init_protocol_handlers ();
wenzelm@52583
   215
    val _ = loop channel;
wenzelm@52584
   216
  in Message_Channel.shutdown msg_channel end);
wenzelm@25528
   217
wenzelm@45029
   218
fun init_fifos fifo1 fifo2 = init (fn () => System_Channel.fifo_rendezvous fifo1 fifo2);
wenzelm@45029
   219
fun init_socket name = init (fn () => System_Channel.socket_rendezvous name);
wenzelm@45028
   220
wenzelm@50117
   221
wenzelm@50117
   222
(* options *)
wenzelm@50117
   223
wenzelm@50117
   224
val _ =
wenzelm@50117
   225
  protocol_command "Isabelle_Process.options"
wenzelm@50117
   226
    (fn [options_yxml] =>
wenzelm@50117
   227
      let val options = Options.decode (YXML.parse_body options_yxml) in
wenzelm@51941
   228
        Options.set_default options;
wenzelm@50698
   229
        Future.ML_statistics := true;
wenzelm@50117
   230
        Multithreading.trace := Options.int options "threads_trace";
wenzelm@50117
   231
        Multithreading.max_threads := Options.int options "threads";
wenzelm@51554
   232
        Goal.skip_proofs := Options.bool options "editor_skip_proofs";
wenzelm@52105
   233
        Goal.parallel_proofs := (if Options.int options "parallel_proofs" > 0 then 3 else 0)
wenzelm@50117
   234
      end);
wenzelm@50117
   235
wenzelm@25528
   236
end;
wenzelm@39528
   237