1 (* Title: Pure/System/isabelle_process.ML
4 Isabelle process wrapper, based on private fifos for maximum
5 robustness and performance, or local socket for maximum portability.
8 - raw Posix process startup with uncontrolled output on stdout/stderr
9 - stderr \002: ML running
10 - stdin/stdout/stderr freely available (raw ML loop)
11 - protocol thread initialization
12 - rendezvous on system channel
13 - message INIT: channels ready
16 signature ISABELLE_PROCESS =
18 val is_active: unit -> bool
19 val protocol_command: string -> (string list -> unit) -> unit
20 val reset_tracing: Document_ID.exec -> unit
21 val crashes: exn list Synchronized.var
22 val init_fifos: string -> string -> unit
23 val init_socket: string -> unit
26 structure Isabelle_Process: ISABELLE_PROCESS =
31 val isabelle_processN = "isabelle_process";
33 fun is_active () = Print_Mode.print_mode_active isabelle_processN;
35 val _ = Output.add_mode isabelle_processN Output.default_output Output.default_escape;
36 val _ = Markup.add_mode isabelle_processN YXML.output_markup;
39 (* protocol commands *)
44 Synchronized.var "Isabelle_Process.commands" (Symtab.empty: (string list -> unit) Symtab.table);
48 fun protocol_command name cmd =
49 Synchronized.change commands (fn cmds =>
50 (if not (Symtab.defined cmds name) then ()
51 else warning ("Redefining Isabelle protocol command " ^ quote name);
52 Symtab.update (name, cmd) cmds));
54 fun run_command name args =
55 (case Symtab.lookup (Synchronized.value commands) name of
56 NONE => error ("Undefined Isabelle protocol command " ^ quote name)
58 (Runtime.debugging cmd args handle exn =>
59 error ("Isabelle protocol command failure: " ^ quote name ^ "\n" ^
60 ML_Compiler.exn_message exn)));
65 (* restricted tracing messages *)
67 val tracing_messages =
68 Synchronized.var "tracing_messages" (Inttab.empty: int Inttab.table);
70 fun reset_tracing exec_id =
71 Synchronized.change tracing_messages (Inttab.delete_safe exec_id);
73 fun update_tracing () =
74 (case Position.parse_id (Position.thread_data ()) of
79 Synchronized.change_result tracing_messages (fn tab =>
81 val n = the_default 0 (Inttab.lookup tab exec_id) + 1;
82 val ok = n <= Options.default_int "editor_tracing_messages";
83 in (ok, Inttab.update (exec_id, n) tab) end);
88 val (text, promise) = Active.dialog_text ();
90 writeln ("Tracing paused. " ^ text "Stop" ^ ", or continue with next " ^
91 text "100" ^ ", " ^ text "1000" ^ ", " ^ text "10000" ^ " messages?")
92 val m = Markup.parse_int (Future.join promise)
93 handle Fail _ => error "Stopped";
95 Synchronized.change tracing_messages
96 (Inttab.map_default (exec_id, 0) (fn k => k - m))
101 (* message channels *)
105 fun chunk s = [string_of_int (size s), "\n", s];
107 fun message do_flush msg_channel name raw_props body =
109 val robust_props = map (pairself YXML.embed_controls) raw_props;
110 val header = YXML.string_of (XML.Elem ((name, robust_props), []));
111 val msg = chunk header @ chunk body;
112 in Message_Channel.send msg_channel msg do_flush end;
116 fun init_channels channel =
118 val _ = TextIO.StreamIO.setBufferMode (TextIO.getOutstream TextIO.stdOut, IO.LINE_BUF);
119 val _ = TextIO.StreamIO.setBufferMode (TextIO.getOutstream TextIO.stdErr, IO.LINE_BUF);
121 val msg_channel = Message_Channel.make channel;
123 fun standard_message opt_serial name body =
126 message false msg_channel name
127 ((case opt_serial of SOME i => cons (Markup.serialN, Markup.print_int i) | _ => I)
128 (Position.properties_of (Position.thread_data ()))) body;
130 Output.Private_Hooks.status_fn := standard_message NONE Markup.statusN;
131 Output.Private_Hooks.report_fn := standard_message NONE Markup.reportN;
132 Output.Private_Hooks.result_fn := (fn (i, s) => standard_message (SOME i) Markup.resultN s);
133 Output.Private_Hooks.writeln_fn :=
134 (fn s => standard_message (SOME (serial ())) Markup.writelnN s);
135 Output.Private_Hooks.tracing_fn :=
136 (fn s => (update_tracing (); standard_message (SOME (serial ())) Markup.tracingN s));
137 Output.Private_Hooks.warning_fn :=
138 (fn s => standard_message (SOME (serial ())) Markup.warningN s);
139 Output.Private_Hooks.error_fn :=
140 (fn (i, s) => standard_message (SOME i) Markup.errorN s);
141 Output.Private_Hooks.protocol_message_fn := message true msg_channel Markup.protocolN;
142 Output.Private_Hooks.urgent_message_fn := ! Output.Private_Hooks.writeln_fn;
143 Output.Private_Hooks.prompt_fn := ignore;
144 message true msg_channel Markup.initN [] (Session.welcome ());
151 (* protocol loop -- uninterruptible *)
153 val crashes = Synchronized.var "Isabelle_Process.crashes" ([]: exn list);
158 (Synchronized.change crashes (cons crash);
159 warning "Recovering from Isabelle process crash -- see also Isabelle_Process.crashes");
161 fun read_chunk channel len =
164 (case Int.fromString len of
166 | NONE => error ("Isabelle process: malformed chunk header " ^ quote len));
167 val chunk = System_Channel.inputN channel n;
171 else error ("Isabelle process: bad chunk (" ^ string_of_int m ^ " vs. " ^ string_of_int n ^ ")")
174 fun read_command channel =
175 (case System_Channel.input_line channel of
176 NONE => raise Runtime.TERMINATE
177 | SOME line => map (read_chunk channel) (space_explode "," line));
180 Future.worker_guest "Isabelle_Process.loop" (Future.new_group NONE) e ();
186 (case read_command channel of
187 [] => (Output.error_msg "Isabelle process: no input"; true)
188 | name :: args => (worker_guest (fn () => run_command name args); true))
189 handle Runtime.TERMINATE => false
190 | exn => (Output.error_msg (ML_Compiler.exn_message exn) handle crash => recover crash; true);
192 if continue then loop channel
193 else (Future.shutdown (); Goal.reset_futures (); ())
202 [Syntax_Trans.no_bracketsN, Syntax_Trans.no_type_bracketsN, Graph_Display.active_graphN];
203 val default_modes2 = [Symbol.xsymbolsN, isabelle_processN, Pretty.symbolicN];
205 val init = uninterruptible (fn _ => fn rendezvous =>
207 val _ = Output.physical_stderr Symbol.STX;
209 val _ = Printer.show_markup_default := true;
210 val _ = Context.set_thread_data NONE;
212 Unsynchronized.change print_mode
213 (fn mode => (mode @ default_modes1) |> fold (update op =) default_modes2);
215 val channel = rendezvous ();
216 val msg_channel = init_channels channel;
217 val _ = Session.init_protocol_handlers ();
218 val _ = loop channel;
219 in Message_Channel.shutdown msg_channel end);
221 fun init_fifos fifo1 fifo2 = init (fn () => System_Channel.fifo_rendezvous fifo1 fifo2);
222 fun init_socket name = init (fn () => System_Channel.socket_rendezvous name);
228 protocol_command "Isabelle_Process.options"
229 (fn [options_yxml] =>
230 let val options = Options.decode (YXML.parse_body options_yxml) in
231 Options.set_default options;
232 Future.ML_statistics := true;
233 Multithreading.trace := Options.int options "threads_trace";
234 Multithreading.max_threads := Options.int options "threads";
235 Goal.parallel_proofs := (if Options.int options "parallel_proofs" > 0 then 3 else 0)