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