src/Pure/PIDE/prover.scala
author wenzelm
Tue Nov 03 13:54:34 2015 +0100 (2015-11-03)
changeset 61556 0d4ee4168e41
parent 60215 5fb4990dfc73
child 61559 313eca3fa847
permissions -rw-r--r--
clarified modules;
wenzelm@56385
     1
/*  Title:      Pure/PIDE/prover.scala
wenzelm@56385
     2
    Author:     Makarius
wenzelm@57923
     3
    Options:    :folding=explicit:
wenzelm@56385
     4
wenzelm@57923
     5
Prover process wrapping.
wenzelm@56385
     6
*/
wenzelm@56385
     7
wenzelm@56385
     8
package isabelle
wenzelm@56385
     9
wenzelm@56385
    10
wenzelm@57916
    11
import java.io.{InputStream, OutputStream, BufferedReader, BufferedOutputStream, IOException}
wenzelm@57915
    12
wenzelm@57915
    13
wenzelm@56385
    14
object Prover
wenzelm@56385
    15
{
wenzelm@56393
    16
  /* syntax */
wenzelm@56393
    17
wenzelm@56393
    18
  trait Syntax
wenzelm@56393
    19
  {
wenzelm@59077
    20
    def ++ (other: Syntax): Syntax
wenzelm@56393
    21
    def add_keywords(keywords: Thy_Header.Keywords): Syntax
wenzelm@57906
    22
    def parse_spans(input: CharSequence): List[Command_Span.Span]
wenzelm@57901
    23
    def load_command(name: String): Option[List[String]]
wenzelm@56393
    24
    def load_commands_in(text: String): Boolean
wenzelm@56393
    25
  }
wenzelm@56393
    26
wenzelm@56393
    27
wenzelm@57915
    28
  /* underlying system process */
wenzelm@57915
    29
wenzelm@57915
    30
  trait System_Process
wenzelm@57915
    31
  {
wenzelm@57915
    32
    def stdout: BufferedReader
wenzelm@57915
    33
    def stderr: BufferedReader
wenzelm@57915
    34
    def terminate: Unit
wenzelm@57915
    35
    def join: Int
wenzelm@57915
    36
  }
wenzelm@57915
    37
wenzelm@57915
    38
wenzelm@56385
    39
  /* messages */
wenzelm@56385
    40
wenzelm@56385
    41
  sealed abstract class Message
wenzelm@56385
    42
wenzelm@56386
    43
  class Input(val name: String, val args: List[String]) extends Message
wenzelm@56385
    44
  {
wenzelm@56385
    45
    override def toString: String =
wenzelm@56385
    46
      XML.Elem(Markup(Markup.PROVER_COMMAND, List((Markup.NAME, name))),
wenzelm@56385
    47
        args.map(s =>
wenzelm@56385
    48
          List(XML.Text("\n"), XML.elem(Markup.PROVER_ARG, YXML.parse_body(s)))).flatten).toString
wenzelm@56385
    49
  }
wenzelm@56385
    50
wenzelm@56385
    51
  class Output(val message: XML.Elem) extends Message
wenzelm@56385
    52
  {
wenzelm@56385
    53
    def kind: String = message.markup.name
wenzelm@56385
    54
    def properties: Properties.T = message.markup.properties
wenzelm@56385
    55
    def body: XML.Body = message.body
wenzelm@56385
    56
wenzelm@56385
    57
    def is_init = kind == Markup.INIT
wenzelm@56385
    58
    def is_exit = kind == Markup.EXIT
wenzelm@56385
    59
    def is_stdout = kind == Markup.STDOUT
wenzelm@56385
    60
    def is_stderr = kind == Markup.STDERR
wenzelm@56385
    61
    def is_system = kind == Markup.SYSTEM
wenzelm@56385
    62
    def is_status = kind == Markup.STATUS
wenzelm@56385
    63
    def is_report = kind == Markup.REPORT
wenzelm@56385
    64
    def is_syslog = is_init || is_exit || is_system || is_stderr
wenzelm@56385
    65
wenzelm@56385
    66
    override def toString: String =
wenzelm@56385
    67
    {
wenzelm@56385
    68
      val res =
wenzelm@56385
    69
        if (is_status || is_report) message.body.map(_.toString).mkString
wenzelm@56385
    70
        else Pretty.string_of(message.body)
wenzelm@56385
    71
      if (properties.isEmpty)
wenzelm@56385
    72
        kind.toString + " [[" + res + "]]"
wenzelm@56385
    73
      else
wenzelm@56385
    74
        kind.toString + " " +
wenzelm@56385
    75
          (for ((x, y) <- properties) yield x + "=" + y).mkString("{", ",", "}") + " [[" + res + "]]"
wenzelm@56385
    76
    }
wenzelm@56385
    77
  }
wenzelm@56385
    78
wenzelm@56385
    79
  class Protocol_Output(props: Properties.T, val bytes: Bytes)
wenzelm@56385
    80
    extends Output(XML.Elem(Markup(Markup.PROTOCOL, props), Nil))
wenzelm@56385
    81
  {
wenzelm@56385
    82
    lazy val text: String = bytes.toString
wenzelm@56385
    83
  }
wenzelm@56385
    84
}
wenzelm@56385
    85
wenzelm@56393
    86
wenzelm@57916
    87
abstract class Prover(
wenzelm@57916
    88
  receiver: Prover.Message => Unit,
wenzelm@57917
    89
  system_channel: System_Channel,
wenzelm@57916
    90
  system_process: Prover.System_Process) extends Protocol
wenzelm@56387
    91
{
wenzelm@57923
    92
  /** receiver output **/
wenzelm@57916
    93
wenzelm@57916
    94
  val xml_cache: XML.Cache = new XML.Cache()
wenzelm@57916
    95
wenzelm@57916
    96
  private def system_output(text: String)
wenzelm@57916
    97
  {
wenzelm@57916
    98
    receiver(new Prover.Output(XML.Elem(Markup(Markup.SYSTEM, Nil), List(XML.Text(text)))))
wenzelm@57916
    99
  }
wenzelm@57916
   100
wenzelm@57916
   101
  private def protocol_output(props: Properties.T, bytes: Bytes)
wenzelm@57916
   102
  {
wenzelm@57916
   103
    receiver(new Prover.Protocol_Output(props, bytes))
wenzelm@57916
   104
  }
wenzelm@57916
   105
wenzelm@57916
   106
  private def output(kind: String, props: Properties.T, body: XML.Body)
wenzelm@57916
   107
  {
wenzelm@57917
   108
    if (kind == Markup.INIT) system_channel.accepted()
wenzelm@56387
   109
wenzelm@59713
   110
    val main = XML.Elem(Markup(kind, props), Protocol_Message.clean_reports(body))
wenzelm@59713
   111
    val reports = Protocol_Message.reports(props, body)
wenzelm@57916
   112
    for (msg <- main :: reports) receiver(new Prover.Output(xml_cache.elem(msg)))
wenzelm@57916
   113
  }
wenzelm@57916
   114
wenzelm@57916
   115
  private def exit_message(rc: Int)
wenzelm@57916
   116
  {
wenzelm@57916
   117
    output(Markup.EXIT, Markup.Return_Code(rc), List(XML.Text("Return code: " + rc.toString)))
wenzelm@57916
   118
  }
wenzelm@57916
   119
wenzelm@57916
   120
wenzelm@56387
   121
wenzelm@57916
   122
  /** process manager **/
wenzelm@57916
   123
wenzelm@57916
   124
  private val (_, process_result) =
wenzelm@61556
   125
    Standard_Thread.future("process_result") { system_process.join }
wenzelm@57916
   126
wenzelm@57916
   127
  private def terminate_process()
wenzelm@56387
   128
  {
wenzelm@57916
   129
    try { system_process.terminate }
wenzelm@57916
   130
    catch {
wenzelm@57916
   131
      case exn @ ERROR(_) => system_output("Failed to terminate prover process: " + exn.getMessage)
wenzelm@57916
   132
    }
wenzelm@56387
   133
  }
wenzelm@56387
   134
wenzelm@61556
   135
  private val process_manager = Standard_Thread.fork("process_manager")
wenzelm@57916
   136
  {
wenzelm@57916
   137
    val (startup_failed, startup_errors) =
wenzelm@57916
   138
    {
wenzelm@57916
   139
      var finished: Option[Boolean] = None
wenzelm@57916
   140
      val result = new StringBuilder(100)
wenzelm@57916
   141
      while (finished.isEmpty && (system_process.stderr.ready || !process_result.is_finished)) {
wenzelm@57916
   142
        while (finished.isEmpty && system_process.stderr.ready) {
wenzelm@57916
   143
          try {
wenzelm@57916
   144
            val c = system_process.stderr.read
wenzelm@57916
   145
            if (c == 2) finished = Some(true)
wenzelm@57916
   146
            else result += c.toChar
wenzelm@57916
   147
          }
wenzelm@57916
   148
          catch { case _: IOException => finished = Some(false) }
wenzelm@57916
   149
        }
wenzelm@57916
   150
        Thread.sleep(10)
wenzelm@57916
   151
      }
wenzelm@57916
   152
      (finished.isEmpty || !finished.get, result.toString.trim)
wenzelm@57916
   153
    }
wenzelm@57916
   154
    if (startup_errors != "") system_output(startup_errors)
wenzelm@57916
   155
wenzelm@57916
   156
    if (startup_failed) {
wenzelm@57916
   157
      terminate_process()
wenzelm@57916
   158
      process_result.join
wenzelm@57916
   159
      exit_message(127)
wenzelm@57916
   160
    }
wenzelm@57916
   161
    else {
wenzelm@57917
   162
      val (command_stream, message_stream) = system_channel.rendezvous()
wenzelm@57916
   163
wenzelm@57916
   164
      command_input_init(command_stream)
wenzelm@57916
   165
      val stdout = physical_output(false)
wenzelm@57916
   166
      val stderr = physical_output(true)
wenzelm@57916
   167
      val message = message_output(message_stream)
wenzelm@57916
   168
wenzelm@57916
   169
      val rc = process_result.join
wenzelm@57916
   170
      system_output("process terminated")
wenzelm@57916
   171
      command_input_close()
wenzelm@57916
   172
      for (thread <- List(stdout, stderr, message)) thread.join
wenzelm@57916
   173
      system_output("process_manager terminated")
wenzelm@57916
   174
      exit_message(rc)
wenzelm@57916
   175
    }
wenzelm@57917
   176
    system_channel.accepted()
wenzelm@57916
   177
  }
wenzelm@57916
   178
wenzelm@57916
   179
wenzelm@57916
   180
  /* management methods */
wenzelm@57916
   181
wenzelm@57916
   182
  def join() { process_manager.join() }
wenzelm@57916
   183
wenzelm@57916
   184
  def terminate()
wenzelm@57916
   185
  {
wenzelm@57916
   186
    command_input_close()
wenzelm@57916
   187
    system_output("Terminating prover process")
wenzelm@57916
   188
    terminate_process()
wenzelm@57916
   189
  }
wenzelm@57916
   190
wenzelm@57916
   191
wenzelm@57916
   192
wenzelm@57916
   193
  /** process streams **/
wenzelm@57916
   194
wenzelm@57916
   195
  /* command input */
wenzelm@57916
   196
wenzelm@57916
   197
  private var command_input: Option[Consumer_Thread[List[Bytes]]] = None
wenzelm@57916
   198
wenzelm@57916
   199
  private def command_input_close(): Unit = command_input.foreach(_.shutdown)
wenzelm@57916
   200
wenzelm@57916
   201
  private def command_input_init(raw_stream: OutputStream)
wenzelm@57916
   202
  {
wenzelm@57916
   203
    val name = "command_input"
wenzelm@57916
   204
    val stream = new BufferedOutputStream(raw_stream)
wenzelm@57916
   205
    command_input =
wenzelm@57916
   206
      Some(
wenzelm@57916
   207
        Consumer_Thread.fork(name)(
wenzelm@57916
   208
          consume =
wenzelm@57916
   209
            {
wenzelm@57916
   210
              case chunks =>
wenzelm@57916
   211
                try {
wenzelm@57916
   212
                  Bytes(chunks.map(_.length).mkString("", ",", "\n")).write(stream)
wenzelm@57916
   213
                  chunks.foreach(_.write(stream))
wenzelm@57916
   214
                  stream.flush
wenzelm@57916
   215
                  true
wenzelm@57916
   216
                }
wenzelm@57916
   217
                catch { case e: IOException => system_output(name + ": " + e.getMessage); false }
wenzelm@57916
   218
            },
wenzelm@57916
   219
          finish = { case () => stream.close; system_output(name + " terminated") }
wenzelm@57916
   220
        )
wenzelm@57916
   221
      )
wenzelm@57916
   222
  }
wenzelm@56387
   223
wenzelm@56387
   224
wenzelm@57916
   225
  /* physical output */
wenzelm@57916
   226
wenzelm@57916
   227
  private def physical_output(err: Boolean): Thread =
wenzelm@57916
   228
  {
wenzelm@57916
   229
    val (name, reader, markup) =
wenzelm@57916
   230
      if (err) ("standard_error", system_process.stderr, Markup.STDERR)
wenzelm@57916
   231
      else ("standard_output", system_process.stdout, Markup.STDOUT)
wenzelm@56387
   232
wenzelm@61556
   233
    Standard_Thread.fork(name) {
wenzelm@57916
   234
      try {
wenzelm@57916
   235
        var result = new StringBuilder(100)
wenzelm@57916
   236
        var finished = false
wenzelm@57916
   237
        while (!finished) {
wenzelm@57916
   238
          //{{{
wenzelm@57916
   239
          var c = -1
wenzelm@57916
   240
          var done = false
wenzelm@57916
   241
          while (!done && (result.length == 0 || reader.ready)) {
wenzelm@57916
   242
            c = reader.read
wenzelm@57916
   243
            if (c >= 0) result.append(c.asInstanceOf[Char])
wenzelm@57916
   244
            else done = true
wenzelm@57916
   245
          }
wenzelm@57916
   246
          if (result.length > 0) {
wenzelm@57916
   247
            output(markup, Nil, List(XML.Text(decode(result.toString))))
wenzelm@57916
   248
            result.length = 0
wenzelm@57916
   249
          }
wenzelm@57916
   250
          else {
wenzelm@57916
   251
            reader.close
wenzelm@57916
   252
            finished = true
wenzelm@57916
   253
          }
wenzelm@57916
   254
          //}}}
wenzelm@57916
   255
        }
wenzelm@57916
   256
      }
wenzelm@57916
   257
      catch { case e: IOException => system_output(name + ": " + e.getMessage) }
wenzelm@57916
   258
      system_output(name + " terminated")
wenzelm@57916
   259
    }
wenzelm@57916
   260
  }
wenzelm@56387
   261
wenzelm@56387
   262
wenzelm@57916
   263
  /* message output */
wenzelm@57916
   264
wenzelm@57916
   265
  private def message_output(stream: InputStream): Thread =
wenzelm@57916
   266
  {
wenzelm@57916
   267
    class EOF extends Exception
wenzelm@57916
   268
    class Protocol_Error(msg: String) extends Exception(msg)
wenzelm@57916
   269
wenzelm@57916
   270
    val name = "message_output"
wenzelm@61556
   271
    Standard_Thread.fork(name) {
wenzelm@57916
   272
      val default_buffer = new Array[Byte](65536)
wenzelm@57916
   273
      var c = -1
wenzelm@56387
   274
wenzelm@57916
   275
      def read_int(): Int =
wenzelm@57916
   276
      //{{{
wenzelm@57916
   277
      {
wenzelm@57916
   278
        var n = 0
wenzelm@57916
   279
        c = stream.read
wenzelm@57916
   280
        if (c == -1) throw new EOF
wenzelm@57916
   281
        while (48 <= c && c <= 57) {
wenzelm@57916
   282
          n = 10 * n + (c - 48)
wenzelm@57916
   283
          c = stream.read
wenzelm@57916
   284
        }
wenzelm@57916
   285
        if (c != 10)
wenzelm@57916
   286
          throw new Protocol_Error("malformed header: expected integer followed by newline")
wenzelm@57916
   287
        else n
wenzelm@57916
   288
      }
wenzelm@57916
   289
      //}}}
wenzelm@56387
   290
wenzelm@57916
   291
      def read_chunk_bytes(): (Array[Byte], Int) =
wenzelm@57916
   292
      //{{{
wenzelm@57916
   293
      {
wenzelm@57916
   294
        val n = read_int()
wenzelm@57916
   295
        val buf =
wenzelm@60215
   296
          if (n <= default_buffer.length) default_buffer
wenzelm@57916
   297
          else new Array[Byte](n)
wenzelm@57916
   298
wenzelm@57916
   299
        var i = 0
wenzelm@57916
   300
        var m = 0
wenzelm@57916
   301
        do {
wenzelm@57916
   302
          m = stream.read(buf, i, n - i)
wenzelm@57916
   303
          if (m != -1) i += m
wenzelm@57916
   304
        }
wenzelm@57916
   305
        while (m != -1 && n > i)
wenzelm@57916
   306
wenzelm@57916
   307
        if (i != n)
wenzelm@57916
   308
          throw new Protocol_Error("bad chunk (unexpected EOF after " + i + " of " + n + " bytes)")
wenzelm@57916
   309
wenzelm@57916
   310
        (buf, n)
wenzelm@57916
   311
      }
wenzelm@57916
   312
      //}}}
wenzelm@56387
   313
wenzelm@57916
   314
      def read_chunk(): XML.Body =
wenzelm@57916
   315
      {
wenzelm@57916
   316
        val (buf, n) = read_chunk_bytes()
wenzelm@57916
   317
        YXML.parse_body_failsafe(UTF8.decode_chars(decode, buf, 0, n))
wenzelm@57916
   318
      }
wenzelm@56387
   319
wenzelm@57916
   320
      try {
wenzelm@57916
   321
        do {
wenzelm@57916
   322
          try {
wenzelm@57916
   323
            val header = read_chunk()
wenzelm@57916
   324
            header match {
wenzelm@57916
   325
              case List(XML.Elem(Markup(name, props), Nil)) =>
wenzelm@57916
   326
                val kind = name.intern
wenzelm@57916
   327
                if (kind == Markup.PROTOCOL) {
wenzelm@57916
   328
                  val (buf, n) = read_chunk_bytes()
wenzelm@57916
   329
                  protocol_output(props, Bytes(buf, 0, n))
wenzelm@57916
   330
                }
wenzelm@57916
   331
                else {
wenzelm@57916
   332
                  val body = read_chunk()
wenzelm@57916
   333
                  output(kind, props, body)
wenzelm@57916
   334
                }
wenzelm@57916
   335
              case _ =>
wenzelm@57916
   336
                read_chunk()
wenzelm@57916
   337
                throw new Protocol_Error("bad header: " + header.toString)
wenzelm@57916
   338
            }
wenzelm@57916
   339
          }
wenzelm@57916
   340
          catch { case _: EOF => }
wenzelm@57916
   341
        }
wenzelm@57916
   342
        while (c != -1)
wenzelm@57916
   343
      }
wenzelm@57916
   344
      catch {
wenzelm@57916
   345
        case e: IOException => system_output("Cannot read message:\n" + e.getMessage)
wenzelm@57916
   346
        case e: Protocol_Error => system_output("Malformed message:\n" + e.getMessage)
wenzelm@57916
   347
      }
wenzelm@57916
   348
      stream.close
wenzelm@56387
   349
wenzelm@57916
   350
      system_output(name + " terminated")
wenzelm@57916
   351
    }
wenzelm@57916
   352
  }
wenzelm@57916
   353
wenzelm@57916
   354
wenzelm@57916
   355
wenzelm@57916
   356
  /** protocol commands **/
wenzelm@57916
   357
wenzelm@57916
   358
  def protocol_command_bytes(name: String, args: Bytes*): Unit =
wenzelm@57916
   359
    command_input match {
wenzelm@57916
   360
      case Some(thread) => thread.send(Bytes(name) :: args.toList)
wenzelm@57916
   361
      case None => error("Uninitialized command input thread")
wenzelm@57916
   362
    }
wenzelm@57916
   363
wenzelm@57916
   364
  def protocol_command(name: String, args: String*)
wenzelm@57916
   365
  {
wenzelm@57916
   366
    receiver(new Prover.Input(name, args.toList))
wenzelm@57916
   367
    protocol_command_bytes(name, args.map(Bytes(_)): _*)
wenzelm@57916
   368
  }
wenzelm@56387
   369
}