src/Pure/System/isabelle_process.ML
author wenzelm
Sat, 18 Mar 2017 12:46:52 +0100
changeset 65301 fca593a62785
parent 65300 c262653a3b88
child 65302 3f92d63dad12
permissions -rw-r--r--
restore output channels after shutdown, e.g. relevant for saved heap;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
30173
eabece26b89b moved isabelle_process.ML, isabelle_process.scala, isar.ML, session.ML to Pure/System/ (together with associated Isar commands);
wenzelm
parents: 29522
diff changeset
     1
(*  Title:      Pure/System/isabelle_process.ML
25528
e67230c2b952 Isabelle process wrapper -- interaction via external program.
wenzelm
parents:
diff changeset
     2
    Author:     Makarius
e67230c2b952 Isabelle process wrapper -- interaction via external program.
wenzelm
parents:
diff changeset
     3
57916
2c2c24dbf0a4 generic process wrapping in Prover;
wenzelm
parents: 57913
diff changeset
     4
Isabelle process wrapper.
25528
e67230c2b952 Isabelle process wrapper -- interaction via external program.
wenzelm
parents:
diff changeset
     5
*)
e67230c2b952 Isabelle process wrapper -- interaction via external program.
wenzelm
parents:
diff changeset
     6
e67230c2b952 Isabelle process wrapper -- interaction via external program.
wenzelm
parents:
diff changeset
     7
signature ISABELLE_PROCESS =
e67230c2b952 Isabelle process wrapper -- interaction via external program.
wenzelm
parents:
diff changeset
     8
sig
42897
6bc8a6dcb3e0 added Isabelle_Process.is_active;
wenzelm
parents: 40521
diff changeset
     9
  val is_active: unit -> bool
46119
0d7172a7672c tuned signature -- emphasize special nature of protocol commands;
wenzelm
parents: 45666
diff changeset
    10
  val protocol_command: string -> (string list -> unit) -> unit
52655
3b2b1ef13979 more careful termination of removed execs, leaving running execs undisturbed;
wenzelm
parents: 52584
diff changeset
    11
  val reset_tracing: Document_ID.exec -> unit
43684
85388f5570c4 prefer Synchronized.var;
wenzelm
parents: 43673
diff changeset
    12
  val crashes: exn list Synchronized.var
62564
40624a9e94c4 tuned signature;
wenzelm
parents: 62563
diff changeset
    13
  val init_protocol: string -> unit
62563
2e352f63d15f separate Isabelle_Process.init_options after Options.load_defaults, notably for "isabelle console";
wenzelm
parents: 62505
diff changeset
    14
  val init_options: unit -> unit
65300
c262653a3b88 clarified signature;
wenzelm
parents: 65212
diff changeset
    15
  val init_options_interactive: unit -> unit
25528
e67230c2b952 Isabelle process wrapper -- interaction via external program.
wenzelm
parents:
diff changeset
    16
end;
e67230c2b952 Isabelle process wrapper -- interaction via external program.
wenzelm
parents:
diff changeset
    17
31797
203d5e61e3bc renamed IsabelleProcess to Isabelle_Process;
wenzelm
parents: 31384
diff changeset
    18
structure Isabelle_Process: ISABELLE_PROCESS =
25528
e67230c2b952 Isabelle process wrapper -- interaction via external program.
wenzelm
parents:
diff changeset
    19
struct
e67230c2b952 Isabelle process wrapper -- interaction via external program.
wenzelm
parents:
diff changeset
    20
42897
6bc8a6dcb3e0 added Isabelle_Process.is_active;
wenzelm
parents: 40521
diff changeset
    21
(* print mode *)
25554
082d97057e23 added test_markup;
wenzelm
parents: 25528
diff changeset
    22
25748
55a458a31e37 added PROMPT message;
wenzelm
parents: 25631
diff changeset
    23
val isabelle_processN = "isabelle_process";
55a458a31e37 added PROMPT message;
wenzelm
parents: 25631
diff changeset
    24
42897
6bc8a6dcb3e0 added Isabelle_Process.is_active;
wenzelm
parents: 40521
diff changeset
    25
fun is_active () = Print_Mode.print_mode_active isabelle_processN;
6bc8a6dcb3e0 added Isabelle_Process.is_active;
wenzelm
parents: 40521
diff changeset
    26
26550
a8740ad422d2 removed yxmlN for now;
wenzelm
parents: 26543
diff changeset
    27
val _ = Output.add_mode isabelle_processN Output.default_output Output.default_escape;
28036
wenzelm
parents: 27986
diff changeset
    28
val _ = Markup.add_mode isabelle_processN YXML.output_markup;
25841
af7566faaa0f added symbol output mode, with XML escapes;
wenzelm
parents: 25820
diff changeset
    29
af7566faaa0f added symbol output mode, with XML escapes;
wenzelm
parents: 25820
diff changeset
    30
46119
0d7172a7672c tuned signature -- emphasize special nature of protocol commands;
wenzelm
parents: 45666
diff changeset
    31
(* protocol commands *)
38270
71bb3c273dd1 native Isabelle_Process commands, based on efficient byte channel protocol for string lists;
wenzelm
parents: 38265
diff changeset
    32
71bb3c273dd1 native Isabelle_Process commands, based on efficient byte channel protocol for string lists;
wenzelm
parents: 38265
diff changeset
    33
local
71bb3c273dd1 native Isabelle_Process commands, based on efficient byte channel protocol for string lists;
wenzelm
parents: 38265
diff changeset
    34
43684
85388f5570c4 prefer Synchronized.var;
wenzelm
parents: 43673
diff changeset
    35
val commands =
52800
1baa5d19ac44 less aggressive flushing: cope with massive amounts of protocol messages, e.g. from threads_trace;
wenzelm
parents: 52799
diff changeset
    36
  Synchronized.var "Isabelle_Process.commands"
1baa5d19ac44 less aggressive flushing: cope with massive amounts of protocol messages, e.g. from threads_trace;
wenzelm
parents: 52799
diff changeset
    37
    (Symtab.empty: (string list -> unit) Symtab.table);
38270
71bb3c273dd1 native Isabelle_Process commands, based on efficient byte channel protocol for string lists;
wenzelm
parents: 38265
diff changeset
    38
71bb3c273dd1 native Isabelle_Process commands, based on efficient byte channel protocol for string lists;
wenzelm
parents: 38265
diff changeset
    39
in
71bb3c273dd1 native Isabelle_Process commands, based on efficient byte channel protocol for string lists;
wenzelm
parents: 38265
diff changeset
    40
46119
0d7172a7672c tuned signature -- emphasize special nature of protocol commands;
wenzelm
parents: 45666
diff changeset
    41
fun protocol_command name cmd =
43684
85388f5570c4 prefer Synchronized.var;
wenzelm
parents: 43673
diff changeset
    42
  Synchronized.change commands (fn cmds =>
38270
71bb3c273dd1 native Isabelle_Process commands, based on efficient byte channel protocol for string lists;
wenzelm
parents: 38265
diff changeset
    43
   (if not (Symtab.defined cmds name) then ()
52582
31467a4b1466 tuned signature;
wenzelm
parents: 52580
diff changeset
    44
    else warning ("Redefining Isabelle protocol command " ^ quote name);
43684
85388f5570c4 prefer Synchronized.var;
wenzelm
parents: 43673
diff changeset
    45
    Symtab.update (name, cmd) cmds));
38270
71bb3c273dd1 native Isabelle_Process commands, based on efficient byte channel protocol for string lists;
wenzelm
parents: 38265
diff changeset
    46
46119
0d7172a7672c tuned signature -- emphasize special nature of protocol commands;
wenzelm
parents: 45666
diff changeset
    47
fun run_command name args =
43684
85388f5570c4 prefer Synchronized.var;
wenzelm
parents: 43673
diff changeset
    48
  (case Symtab.lookup (Synchronized.value commands) name of
52582
31467a4b1466 tuned signature;
wenzelm
parents: 52580
diff changeset
    49
    NONE => error ("Undefined Isabelle protocol command " ^ quote name)
46119
0d7172a7672c tuned signature -- emphasize special nature of protocol commands;
wenzelm
parents: 45666
diff changeset
    50
  | SOME cmd =>
59056
cbe9563c03d1 even more exception traces for Document.update, which goes through additional execution wrappers;
wenzelm
parents: 59055
diff changeset
    51
      (Runtime.exn_trace_system (fn () => cmd args)
59055
5a7157b8e870 more informative failure of protocol commands, with exception trace;
wenzelm
parents: 58850
diff changeset
    52
        handle _ (*sic!*) => error ("Isabelle protocol command failure: " ^ quote name)));
38270
71bb3c273dd1 native Isabelle_Process commands, based on efficient byte channel protocol for string lists;
wenzelm
parents: 38265
diff changeset
    53
71bb3c273dd1 native Isabelle_Process commands, based on efficient byte channel protocol for string lists;
wenzelm
parents: 38265
diff changeset
    54
end;
71bb3c273dd1 native Isabelle_Process commands, based on efficient byte channel protocol for string lists;
wenzelm
parents: 38265
diff changeset
    55
71bb3c273dd1 native Isabelle_Process commands, based on efficient byte channel protocol for string lists;
wenzelm
parents: 38265
diff changeset
    56
50505
33c92722cc3d smarter handling of tracing messages: prover process pauses and enters user dialog;
wenzelm
parents: 50503
diff changeset
    57
(* restricted tracing messages *)
49647
21ae8500d261 smarter handling of tracing messages;
wenzelm
parents: 49566
diff changeset
    58
52105
88b423034d4f proper options;
wenzelm
parents: 52104
diff changeset
    59
val tracing_messages =
88b423034d4f proper options;
wenzelm
parents: 52104
diff changeset
    60
  Synchronized.var "tracing_messages" (Inttab.empty: int Inttab.table);
49647
21ae8500d261 smarter handling of tracing messages;
wenzelm
parents: 49566
diff changeset
    61
52655
3b2b1ef13979 more careful termination of removed execs, leaving running execs undisturbed;
wenzelm
parents: 52584
diff changeset
    62
fun reset_tracing exec_id =
3b2b1ef13979 more careful termination of removed execs, leaving running execs undisturbed;
wenzelm
parents: 52584
diff changeset
    63
  Synchronized.change tracing_messages (Inttab.delete_safe exec_id);
49647
21ae8500d261 smarter handling of tracing messages;
wenzelm
parents: 49566
diff changeset
    64
50505
33c92722cc3d smarter handling of tracing messages: prover process pauses and enters user dialog;
wenzelm
parents: 50503
diff changeset
    65
fun update_tracing () =
50911
ee7fe4230642 more explicit treatment of (optional) exception properties, notably for "serial" -- avoid conflict with startPosition = offset;
wenzelm
parents: 50715
diff changeset
    66
  (case Position.parse_id (Position.thread_data ()) of
49647
21ae8500d261 smarter handling of tracing messages;
wenzelm
parents: 49566
diff changeset
    67
    NONE => ()
52655
3b2b1ef13979 more careful termination of removed execs, leaving running execs undisturbed;
wenzelm
parents: 52584
diff changeset
    68
  | SOME exec_id =>
50505
33c92722cc3d smarter handling of tracing messages: prover process pauses and enters user dialog;
wenzelm
parents: 50503
diff changeset
    69
      let
52560
wenzelm
parents: 52559
diff changeset
    70
        val ok =
52105
88b423034d4f proper options;
wenzelm
parents: 52104
diff changeset
    71
          Synchronized.change_result tracing_messages (fn tab =>
50505
33c92722cc3d smarter handling of tracing messages: prover process pauses and enters user dialog;
wenzelm
parents: 50503
diff changeset
    72
            let
52655
3b2b1ef13979 more careful termination of removed execs, leaving running execs undisturbed;
wenzelm
parents: 52584
diff changeset
    73
              val n = the_default 0 (Inttab.lookup tab exec_id) + 1;
52105
88b423034d4f proper options;
wenzelm
parents: 52104
diff changeset
    74
              val ok = n <= Options.default_int "editor_tracing_messages";
52655
3b2b1ef13979 more careful termination of removed execs, leaving running execs undisturbed;
wenzelm
parents: 52584
diff changeset
    75
            in (ok, Inttab.update (exec_id, n) tab) end);
50505
33c92722cc3d smarter handling of tracing messages: prover process pauses and enters user dialog;
wenzelm
parents: 50503
diff changeset
    76
      in
33c92722cc3d smarter handling of tracing messages: prover process pauses and enters user dialog;
wenzelm
parents: 50503
diff changeset
    77
        if ok then ()
33c92722cc3d smarter handling of tracing messages: prover process pauses and enters user dialog;
wenzelm
parents: 50503
diff changeset
    78
        else
33c92722cc3d smarter handling of tracing messages: prover process pauses and enters user dialog;
wenzelm
parents: 50503
diff changeset
    79
          let
33c92722cc3d smarter handling of tracing messages: prover process pauses and enters user dialog;
wenzelm
parents: 50503
diff changeset
    80
            val (text, promise) = Active.dialog_text ();
33c92722cc3d smarter handling of tracing messages: prover process pauses and enters user dialog;
wenzelm
parents: 50503
diff changeset
    81
            val _ =
33c92722cc3d smarter handling of tracing messages: prover process pauses and enters user dialog;
wenzelm
parents: 50503
diff changeset
    82
              writeln ("Tracing paused.  " ^ text "Stop" ^ ", or continue with next " ^
51044
890f502f0e89 more generous tracing limit, which is relevant for applications where this occurs routinely (e.g. HO unification trace);
wenzelm
parents: 50911
diff changeset
    83
                text "100" ^ ", " ^ text "1000" ^ ", " ^ text "10000" ^ " messages?")
63806
c54a53ef1873 clarified modules;
wenzelm
parents: 62930
diff changeset
    84
            val m = Value.parse_int (Future.join promise)
50505
33c92722cc3d smarter handling of tracing messages: prover process pauses and enters user dialog;
wenzelm
parents: 50503
diff changeset
    85
              handle Fail _ => error "Stopped";
33c92722cc3d smarter handling of tracing messages: prover process pauses and enters user dialog;
wenzelm
parents: 50503
diff changeset
    86
          in
52105
88b423034d4f proper options;
wenzelm
parents: 52104
diff changeset
    87
            Synchronized.change tracing_messages
52655
3b2b1ef13979 more careful termination of removed execs, leaving running execs undisturbed;
wenzelm
parents: 52584
diff changeset
    88
              (Inttab.map_default (exec_id, 0) (fn k => k - m))
50505
33c92722cc3d smarter handling of tracing messages: prover process pauses and enters user dialog;
wenzelm
parents: 50503
diff changeset
    89
          end
33c92722cc3d smarter handling of tracing messages: prover process pauses and enters user dialog;
wenzelm
parents: 50503
diff changeset
    90
      end);
49647
21ae8500d261 smarter handling of tracing messages;
wenzelm
parents: 49566
diff changeset
    91
21ae8500d261 smarter handling of tracing messages;
wenzelm
parents: 49566
diff changeset
    92
52800
1baa5d19ac44 less aggressive flushing: cope with massive amounts of protocol messages, e.g. from threads_trace;
wenzelm
parents: 52799
diff changeset
    93
(* output channels *)
28188
51ccf7fa6f18 auto_flush stdout, stderr as well;
wenzelm
parents: 28182
diff changeset
    94
52854
92932931bd82 more general Output.result: allow to update arbitrary properties;
wenzelm
parents: 52852
diff changeset
    95
val serial_props = Markup.serial_properties o serial;
92932931bd82 more general Output.result: allow to update arbitrary properties;
wenzelm
parents: 52852
diff changeset
    96
48712
6b7a9bcc0bae simplified process startup phases: INIT suffices for is_ready;
wenzelm
parents: 48710
diff changeset
    97
fun init_channels channel =
28189
fbad2eb5be9e auto_flush: uniform block buffering for all output streams;
wenzelm
parents: 28188
diff changeset
    98
  let
40134
8baded087d34 explicit message_output thread, with flushing after timeout, ensure atomic user-operations without the danger of IO Interrupt;
wenzelm
parents: 40133
diff changeset
    99
    val _ = TextIO.StreamIO.setBufferMode (TextIO.getOutstream TextIO.stdOut, IO.LINE_BUF);
8baded087d34 explicit message_output thread, with flushing after timeout, ensure atomic user-operations without the danger of IO Interrupt;
wenzelm
parents: 40133
diff changeset
   100
    val _ = TextIO.StreamIO.setBufferMode (TextIO.getOutstream TextIO.stdErr, IO.LINE_BUF);
8baded087d34 explicit message_output thread, with flushing after timeout, ensure atomic user-operations without the danger of IO Interrupt;
wenzelm
parents: 40133
diff changeset
   101
52584
5cad4a5f5615 more abstract message channel;
wenzelm
parents: 52583
diff changeset
   102
    val msg_channel = Message_Channel.make channel;
52580
36aa39694ab4 fall back on synchronous message output for single-threaded SML/NJ;
wenzelm
parents: 52578
diff changeset
   103
52800
1baa5d19ac44 less aggressive flushing: cope with massive amounts of protocol messages, e.g. from threads_trace;
wenzelm
parents: 52799
diff changeset
   104
    fun message name props body =
1baa5d19ac44 less aggressive flushing: cope with massive amounts of protocol messages, e.g. from threads_trace;
wenzelm
parents: 52799
diff changeset
   105
      Message_Channel.send msg_channel (Message_Channel.message name props body);
1baa5d19ac44 less aggressive flushing: cope with massive amounts of protocol messages, e.g. from threads_trace;
wenzelm
parents: 52799
diff changeset
   106
52854
92932931bd82 more general Output.result: allow to update arbitrary properties;
wenzelm
parents: 52852
diff changeset
   107
    fun standard_message props name body =
56333
38f1422ef473 support bulk messages consisting of small string segments, which are more healthy to the Poly/ML RTS and might prevent spurious GC crashes such as MTGCProcessMarkPointers::ScanAddressesInObject;
wenzelm
parents: 56303
diff changeset
   108
      if forall (fn s => s = "") body then ()
52580
36aa39694ab4 fall back on synchronous message output for single-threaded SML/NJ;
wenzelm
parents: 52578
diff changeset
   109
      else
57913
8544ef75d1d8 more frugal standard message properties;
wenzelm
parents: 56895
diff changeset
   110
        let
8544ef75d1d8 more frugal standard message properties;
wenzelm
parents: 56895
diff changeset
   111
          val props' =
8544ef75d1d8 more frugal standard message properties;
wenzelm
parents: 56895
diff changeset
   112
            (case (Properties.defined props Markup.idN, Position.get_id (Position.thread_data ())) of
8544ef75d1d8 more frugal standard message properties;
wenzelm
parents: 56895
diff changeset
   113
              (false, SOME id') => props @ [(Markup.idN, id')]
8544ef75d1d8 more frugal standard message properties;
wenzelm
parents: 56895
diff changeset
   114
            | _ => props);
8544ef75d1d8 more frugal standard message properties;
wenzelm
parents: 56895
diff changeset
   115
        in message name props' body end;
28044
e4b569b53e10 explicit output stream, typically a named pipe;
wenzelm
parents: 28036
diff changeset
   116
  in
62930
51ac6bc389e8 shared output primitives of physical/virtual Pure;
wenzelm
parents: 62923
diff changeset
   117
    Private_Output.status_fn := standard_message [] Markup.statusN;
51ac6bc389e8 shared output primitives of physical/virtual Pure;
wenzelm
parents: 62923
diff changeset
   118
    Private_Output.report_fn := standard_message [] Markup.reportN;
51ac6bc389e8 shared output primitives of physical/virtual Pure;
wenzelm
parents: 62923
diff changeset
   119
    Private_Output.result_fn :=
52854
92932931bd82 more general Output.result: allow to update arbitrary properties;
wenzelm
parents: 52852
diff changeset
   120
      (fn props => fn s => standard_message (props @ serial_props ()) Markup.resultN s);
62930
51ac6bc389e8 shared output primitives of physical/virtual Pure;
wenzelm
parents: 62923
diff changeset
   121
    Private_Output.writeln_fn := (fn s => standard_message (serial_props ()) Markup.writelnN s);
51ac6bc389e8 shared output primitives of physical/virtual Pure;
wenzelm
parents: 62923
diff changeset
   122
    Private_Output.state_fn := (fn s => standard_message (serial_props ()) Markup.stateN s);
51ac6bc389e8 shared output primitives of physical/virtual Pure;
wenzelm
parents: 62923
diff changeset
   123
    Private_Output.information_fn :=
51ac6bc389e8 shared output primitives of physical/virtual Pure;
wenzelm
parents: 62923
diff changeset
   124
      (fn s => standard_message (serial_props ()) Markup.informationN s);
51ac6bc389e8 shared output primitives of physical/virtual Pure;
wenzelm
parents: 62923
diff changeset
   125
    Private_Output.tracing_fn :=
52854
92932931bd82 more general Output.result: allow to update arbitrary properties;
wenzelm
parents: 52852
diff changeset
   126
      (fn s => (update_tracing (); standard_message (serial_props ()) Markup.tracingN s));
62930
51ac6bc389e8 shared output primitives of physical/virtual Pure;
wenzelm
parents: 62923
diff changeset
   127
    Private_Output.warning_fn := (fn s => standard_message (serial_props ()) Markup.warningN s);
51ac6bc389e8 shared output primitives of physical/virtual Pure;
wenzelm
parents: 62923
diff changeset
   128
    Private_Output.legacy_fn := (fn s => standard_message (serial_props ()) Markup.legacyN s);
51ac6bc389e8 shared output primitives of physical/virtual Pure;
wenzelm
parents: 62923
diff changeset
   129
    Private_Output.error_message_fn :=
52854
92932931bd82 more general Output.result: allow to update arbitrary properties;
wenzelm
parents: 52852
diff changeset
   130
      (fn (i, s) => standard_message (Markup.serial_properties i) Markup.errorN s);
62930
51ac6bc389e8 shared output primitives of physical/virtual Pure;
wenzelm
parents: 62923
diff changeset
   131
    Private_Output.system_message_fn := message Markup.systemN [];
51ac6bc389e8 shared output primitives of physical/virtual Pure;
wenzelm
parents: 62923
diff changeset
   132
    Private_Output.protocol_message_fn := message Markup.protocolN;
65212
fd6bc719c98b more robust startup/init: let Session.stop wait for protocol handler initialization;
wenzelm
parents: 63806
diff changeset
   133
fd6bc719c98b more robust startup/init: let Session.stop wait for protocol handler initialization;
wenzelm
parents: 63806
diff changeset
   134
    Session.init_protocol_handlers ();
56333
38f1422ef473 support bulk messages consisting of small string segments, which are more healthy to the Poly/ML RTS and might prevent spurious GC crashes such as MTGCProcessMarkPointers::ScanAddressesInObject;
wenzelm
parents: 56303
diff changeset
   135
    message Markup.initN [] [Session.welcome ()];
52584
5cad4a5f5615 more abstract message channel;
wenzelm
parents: 52583
diff changeset
   136
    msg_channel
28044
e4b569b53e10 explicit output stream, typically a named pipe;
wenzelm
parents: 28036
diff changeset
   137
  end;
25841
af7566faaa0f added symbol output mode, with XML escapes;
wenzelm
parents: 25820
diff changeset
   138
af7566faaa0f added symbol output mode, with XML escapes;
wenzelm
parents: 25820
diff changeset
   139
39234
d76a2fd129b5 main command loops are supposed to be uninterruptible -- no special treatment here;
wenzelm
parents: 38871
diff changeset
   140
(* protocol loop -- uninterruptible *)
38270
71bb3c273dd1 native Isabelle_Process commands, based on efficient byte channel protocol for string lists;
wenzelm
parents: 38265
diff changeset
   141
43684
85388f5570c4 prefer Synchronized.var;
wenzelm
parents: 43673
diff changeset
   142
val crashes = Synchronized.var "Isabelle_Process.crashes" ([]: exn list);
38270
71bb3c273dd1 native Isabelle_Process commands, based on efficient byte channel protocol for string lists;
wenzelm
parents: 38265
diff changeset
   143
71bb3c273dd1 native Isabelle_Process commands, based on efficient byte channel protocol for string lists;
wenzelm
parents: 38265
diff changeset
   144
local
71bb3c273dd1 native Isabelle_Process commands, based on efficient byte channel protocol for string lists;
wenzelm
parents: 38265
diff changeset
   145
71bb3c273dd1 native Isabelle_Process commands, based on efficient byte channel protocol for string lists;
wenzelm
parents: 38265
diff changeset
   146
fun recover crash =
43684
85388f5570c4 prefer Synchronized.var;
wenzelm
parents: 43673
diff changeset
   147
  (Synchronized.change crashes (cons crash);
57975
c657c68a60ab explicit system message for protocol failure -- show on Syslog panel instead of Raw Output;
wenzelm
parents: 56895
diff changeset
   148
    Output.physical_stderr
c657c68a60ab explicit system message for protocol failure -- show on Syslog panel instead of Raw Output;
wenzelm
parents: 56895
diff changeset
   149
      "Recovered from Isabelle process crash -- see also Isabelle_Process.crashes\n");
38270
71bb3c273dd1 native Isabelle_Process commands, based on efficient byte channel protocol for string lists;
wenzelm
parents: 38265
diff changeset
   150
45029
63144ea111f7 abstract System_Channel in ML (cf. Scala version);
wenzelm
parents: 45028
diff changeset
   151
fun read_chunk channel len =
38270
71bb3c273dd1 native Isabelle_Process commands, based on efficient byte channel protocol for string lists;
wenzelm
parents: 38265
diff changeset
   152
  let
71bb3c273dd1 native Isabelle_Process commands, based on efficient byte channel protocol for string lists;
wenzelm
parents: 38265
diff changeset
   153
    val n =
71bb3c273dd1 native Isabelle_Process commands, based on efficient byte channel protocol for string lists;
wenzelm
parents: 38265
diff changeset
   154
      (case Int.fromString len of
71bb3c273dd1 native Isabelle_Process commands, based on efficient byte channel protocol for string lists;
wenzelm
parents: 38265
diff changeset
   155
        SOME n => n
52799
6a4498b048b7 tuned -- more uniform ML vs. Scala;
wenzelm
parents: 52787
diff changeset
   156
      | NONE => error ("Isabelle process: malformed header " ^ quote len));
45029
63144ea111f7 abstract System_Channel in ML (cf. Scala version);
wenzelm
parents: 45028
diff changeset
   157
    val chunk = System_Channel.inputN channel n;
52799
6a4498b048b7 tuned -- more uniform ML vs. Scala;
wenzelm
parents: 52787
diff changeset
   158
    val i = size chunk;
38270
71bb3c273dd1 native Isabelle_Process commands, based on efficient byte channel protocol for string lists;
wenzelm
parents: 38265
diff changeset
   159
  in
52799
6a4498b048b7 tuned -- more uniform ML vs. Scala;
wenzelm
parents: 52787
diff changeset
   160
    if i <> n then
6a4498b048b7 tuned -- more uniform ML vs. Scala;
wenzelm
parents: 52787
diff changeset
   161
      error ("Isabelle process: bad chunk (unexpected EOF after " ^
6a4498b048b7 tuned -- more uniform ML vs. Scala;
wenzelm
parents: 52787
diff changeset
   162
        string_of_int i ^ " of " ^ string_of_int n ^ " bytes)")
6a4498b048b7 tuned -- more uniform ML vs. Scala;
wenzelm
parents: 52787
diff changeset
   163
    else chunk
38270
71bb3c273dd1 native Isabelle_Process commands, based on efficient byte channel protocol for string lists;
wenzelm
parents: 38265
diff changeset
   164
  end;
71bb3c273dd1 native Isabelle_Process commands, based on efficient byte channel protocol for string lists;
wenzelm
parents: 38265
diff changeset
   165
45029
63144ea111f7 abstract System_Channel in ML (cf. Scala version);
wenzelm
parents: 45028
diff changeset
   166
fun read_command channel =
59055
5a7157b8e870 more informative failure of protocol commands, with exception trace;
wenzelm
parents: 58850
diff changeset
   167
  System_Channel.input_line channel
5a7157b8e870 more informative failure of protocol commands, with exception trace;
wenzelm
parents: 58850
diff changeset
   168
  |> Option.map (fn line => map (read_chunk channel) (space_explode "," line));
38270
71bb3c273dd1 native Isabelle_Process commands, based on efficient byte channel protocol for string lists;
wenzelm
parents: 38265
diff changeset
   169
71bb3c273dd1 native Isabelle_Process commands, based on efficient byte channel protocol for string lists;
wenzelm
parents: 38265
diff changeset
   170
in
71bb3c273dd1 native Isabelle_Process commands, based on efficient byte channel protocol for string lists;
wenzelm
parents: 38265
diff changeset
   171
45029
63144ea111f7 abstract System_Channel in ML (cf. Scala version);
wenzelm
parents: 45028
diff changeset
   172
fun loop channel =
59055
5a7157b8e870 more informative failure of protocol commands, with exception trace;
wenzelm
parents: 58850
diff changeset
   173
  let
5a7157b8e870 more informative failure of protocol commands, with exception trace;
wenzelm
parents: 58850
diff changeset
   174
    val continue =
5a7157b8e870 more informative failure of protocol commands, with exception trace;
wenzelm
parents: 58850
diff changeset
   175
      (case read_command channel of
5a7157b8e870 more informative failure of protocol commands, with exception trace;
wenzelm
parents: 58850
diff changeset
   176
        NONE => false
5a7157b8e870 more informative failure of protocol commands, with exception trace;
wenzelm
parents: 58850
diff changeset
   177
      | SOME [] => (Output.system_message "Isabelle process: no input"; true)
59370
b13ff987c559 refrain from default task_context for all protocol commands, e.g. relevant for "build_theories" to admit Session.shutdown;
wenzelm
parents: 59350
diff changeset
   178
      | SOME (name :: args) => (run_command name args; true))
59055
5a7157b8e870 more informative failure of protocol commands, with exception trace;
wenzelm
parents: 58850
diff changeset
   179
      handle exn => (Runtime.exn_system_message exn handle crash => recover crash; true);
52770
8c7cf864e270 pro-forma Goal.reset_futures, despite lack of final join/commit;
wenzelm
parents: 52712
diff changeset
   180
  in
8c7cf864e270 pro-forma Goal.reset_futures, despite lack of final join/commit;
wenzelm
parents: 52712
diff changeset
   181
    if continue then loop channel
53192
04df1d236e1c maintain goal forks as part of global execution;
wenzelm
parents: 52854
diff changeset
   182
    else (Future.shutdown (); Execution.reset (); ())
52770
8c7cf864e270 pro-forma Goal.reset_futures, despite lack of final join/commit;
wenzelm
parents: 52712
diff changeset
   183
  end;
38270
71bb3c273dd1 native Isabelle_Process commands, based on efficient byte channel protocol for string lists;
wenzelm
parents: 38265
diff changeset
   184
71bb3c273dd1 native Isabelle_Process commands, based on efficient byte channel protocol for string lists;
wenzelm
parents: 38265
diff changeset
   185
end;
71bb3c273dd1 native Isabelle_Process commands, based on efficient byte channel protocol for string lists;
wenzelm
parents: 38265
diff changeset
   186
71bb3c273dd1 native Isabelle_Process commands, based on efficient byte channel protocol for string lists;
wenzelm
parents: 38265
diff changeset
   187
62564
40624a9e94c4 tuned signature;
wenzelm
parents: 62563
diff changeset
   188
(* init protocol *)
25554
082d97057e23 added test_markup;
wenzelm
parents: 25528
diff changeset
   189
59211
7b74e8408711 eliminated TTY/PG legacy;
wenzelm
parents: 59203
diff changeset
   190
val default_modes1 = [Syntax_Trans.no_bracketsN, Syntax_Trans.no_type_bracketsN];
50715
8cfd585b9162 prefer old graph browser in Isabelle/jEdit, which still produces better layout;
wenzelm
parents: 50698
diff changeset
   191
val default_modes2 = [Symbol.xsymbolsN, isabelle_processN, Pretty.symbolicN];
49566
66cbf8bb4693 basic integration of graphview into document model;
wenzelm
parents: 49108
diff changeset
   192
62923
3a122e1e352a clarified bootstrap;
wenzelm
parents: 62891
diff changeset
   193
val init_protocol = Thread_Attributes.uninterruptible (fn _ => fn socket =>
38253
3d4e521014f7 Isabelle_Process: separate input fifo for commands (still using the old tty protocol);
wenzelm
parents: 38236
diff changeset
   194
  let
62666
00aff1da05ae clarified modules;
wenzelm
parents: 62599
diff changeset
   195
    val _ = SHA1.test_samples ()
62505
9e2a65912111 clarified modules;
wenzelm
parents: 59370
diff changeset
   196
      handle exn as Fail msg => (Output.physical_stderr (msg ^ "\n"); Exn.reraise exn);
46548
c54a4a22501c clarified initial process startup errors: recover image load failure message (cf. 2cb7e34f6096) and suppress accidental output from raw ML toplevel;
wenzelm
parents: 46121
diff changeset
   197
    val _ = Output.physical_stderr Symbol.STX;
39528
c01d89d18ff0 refined Isabelle_Process startup: emit \002 before rendezvous on fifos, more robust treatment of startup failure with timeout, do not quit() after main loop;
wenzelm
parents: 39513
diff changeset
   198
49661
ac48def96b69 enable show_markup by default (approx. double output size);
wenzelm
parents: 49647
diff changeset
   199
    val _ = Printer.show_markup_default := true;
62889
99c7f31615c2 clarified modules;
wenzelm
parents: 62878
diff changeset
   200
    val _ = Context.put_generic_context NONE;
43671
a250b092ac66 hard-wired print mode "xsymbols" increases chance that "iff" in HOL will print symbolic arrow;
wenzelm
parents: 42897
diff changeset
   201
    val _ =
a250b092ac66 hard-wired print mode "xsymbols" increases chance that "iff" in HOL will print symbolic arrow;
wenzelm
parents: 42897
diff changeset
   202
      Unsynchronized.change print_mode
49566
66cbf8bb4693 basic integration of graphview into document model;
wenzelm
parents: 49108
diff changeset
   203
        (fn mode => (mode @ default_modes1) |> fold (update op =) default_modes2);
39528
c01d89d18ff0 refined Isabelle_Process startup: emit \002 before rendezvous on fifos, more robust treatment of startup failure with timeout, do not quit() after main loop;
wenzelm
parents: 39513
diff changeset
   204
59350
acba5d6fdb2f discontinued fifo channel, always use portable socket;
wenzelm
parents: 59211
diff changeset
   205
    val channel = System_Channel.rendezvous socket;
52584
5cad4a5f5615 more abstract message channel;
wenzelm
parents: 52583
diff changeset
   206
    val msg_channel = init_channels channel;
58848
fd0c85d7da38 eliminated odd flags and hook;
wenzelm
parents: 58843
diff changeset
   207
    val _ = loop channel;
65301
fca593a62785 restore output channels after shutdown, e.g. relevant for saved heap;
wenzelm
parents: 65300
diff changeset
   208
    val _ = Message_Channel.shutdown msg_channel;
fca593a62785 restore output channels after shutdown, e.g. relevant for saved heap;
wenzelm
parents: 65300
diff changeset
   209
    val _ = Private_Output.init_channels ();
fca593a62785 restore output channels after shutdown, e.g. relevant for saved heap;
wenzelm
parents: 65300
diff changeset
   210
  in () end);
25528
e67230c2b952 Isabelle process wrapper -- interaction via external program.
wenzelm
parents:
diff changeset
   211
62563
2e352f63d15f separate Isabelle_Process.init_options after Options.load_defaults, notably for "isabelle console";
wenzelm
parents: 62505
diff changeset
   212
2e352f63d15f separate Isabelle_Process.init_options after Options.load_defaults, notably for "isabelle console";
wenzelm
parents: 62505
diff changeset
   213
(* init options *)
2e352f63d15f separate Isabelle_Process.init_options after Options.load_defaults, notably for "isabelle console";
wenzelm
parents: 62505
diff changeset
   214
2e352f63d15f separate Isabelle_Process.init_options after Options.load_defaults, notably for "isabelle console";
wenzelm
parents: 62505
diff changeset
   215
fun init_options () =
62878
1cec457e0a03 clarified modules -- simplified bootstrap;
wenzelm
parents: 62713
diff changeset
   216
 (ML_Print_Depth.set_print_depth (Options.default_int "ML_print_depth");
62712
22a17cec2efe clarified use of options;
wenzelm
parents: 62666
diff changeset
   217
  Future.ML_statistics := Options.default_bool "ML_statistics";
62563
2e352f63d15f separate Isabelle_Process.init_options after Options.load_defaults, notably for "isabelle console";
wenzelm
parents: 62505
diff changeset
   218
  Multithreading.trace := Options.default_int "threads_trace";
2e352f63d15f separate Isabelle_Process.init_options after Options.load_defaults, notably for "isabelle console";
wenzelm
parents: 62505
diff changeset
   219
  Multithreading.max_threads_update (Options.default_int "threads");
2e352f63d15f separate Isabelle_Process.init_options after Options.load_defaults, notably for "isabelle console";
wenzelm
parents: 62505
diff changeset
   220
  Goal.parallel_proofs := Options.default_int "parallel_proofs");
2e352f63d15f separate Isabelle_Process.init_options after Options.load_defaults, notably for "isabelle console";
wenzelm
parents: 62505
diff changeset
   221
65300
c262653a3b88 clarified signature;
wenzelm
parents: 65212
diff changeset
   222
fun init_options_interactive () =
c262653a3b88 clarified signature;
wenzelm
parents: 65212
diff changeset
   223
 (init_options ();
c262653a3b88 clarified signature;
wenzelm
parents: 65212
diff changeset
   224
  Goal.parallel_proofs := (if Options.default_int "parallel_proofs" > 0 then 3 else 0));
62599
f35858c831e5 clarified session build options: already provided by ML_Process;
wenzelm
parents: 62564
diff changeset
   225
25528
e67230c2b952 Isabelle process wrapper -- interaction via external program.
wenzelm
parents:
diff changeset
   226
end;