src/Pure/Tools/build_log.scala
author wenzelm
Fri Oct 07 17:46:36 2016 +0200 (2016-10-07)
changeset 64087 a77c57235bae
parent 64086 ac7ae5067783
child 64088 210aabe359ab
permissions -rw-r--r--
more uniform regexps;
wenzelm@64045
     1
/*  Title:      Pure/Tools/build_log.scala
wenzelm@64045
     2
    Author:     Makarius
wenzelm@64045
     3
wenzelm@64045
     4
Build log parsing for historic versions, back to "build_history_base".
wenzelm@64045
     5
*/
wenzelm@64045
     6
wenzelm@64045
     7
package isabelle
wenzelm@64045
     8
wenzelm@64045
     9
wenzelm@64061
    10
import java.time.ZonedDateTime
wenzelm@64061
    11
import java.time.format.{DateTimeFormatter, DateTimeParseException}
wenzelm@64061
    12
wenzelm@64054
    13
import scala.collection.mutable
wenzelm@64054
    14
import scala.util.matching.Regex
wenzelm@64054
    15
wenzelm@64054
    16
wenzelm@64045
    17
object Build_Log
wenzelm@64045
    18
{
wenzelm@64081
    19
  /** settings **/
wenzelm@64080
    20
wenzelm@64081
    21
  object Settings
wenzelm@64081
    22
  {
wenzelm@64081
    23
    val build_settings = List("ISABELLE_BUILD_OPTIONS")
wenzelm@64081
    24
    val ml_settings = List("ML_PLATFORM", "ML_HOME", "ML_SYSTEM", "ML_OPTIONS")
wenzelm@64081
    25
    val all_settings = build_settings ::: ml_settings
wenzelm@64081
    26
wenzelm@64081
    27
    type Entry = (String, String)
wenzelm@64081
    28
    type T = List[Entry]
wenzelm@64080
    29
wenzelm@64081
    30
    object Entry
wenzelm@64081
    31
    {
wenzelm@64081
    32
      def unapply(s: String): Option[Entry] =
wenzelm@64081
    33
        s.indexOf('=') match {
wenzelm@64081
    34
          case -1 => None
wenzelm@64081
    35
          case i =>
wenzelm@64081
    36
            val a = s.substring(0, i)
wenzelm@64081
    37
            val b = Library.perhaps_unquote(s.substring(i + 1))
wenzelm@64081
    38
            Some((a, b))
wenzelm@64081
    39
        }
wenzelm@64081
    40
      def apply(a: String, b: String): String = a + "=" + quote(b)
wenzelm@64081
    41
      def getenv(a: String): String = apply(a, Isabelle_System.getenv(a))
wenzelm@64081
    42
    }
wenzelm@64080
    43
wenzelm@64081
    44
    def show(): String =
wenzelm@64081
    45
      cat_lines(
wenzelm@64081
    46
        build_settings.map(Entry.getenv(_)) ::: List("") ::: ml_settings.map(Entry.getenv(_)))
wenzelm@64080
    47
  }
wenzelm@64080
    48
wenzelm@64080
    49
wenzelm@64062
    50
  /** log file **/
wenzelm@64045
    51
wenzelm@64062
    52
  object Log_File
wenzelm@64062
    53
  {
wenzelm@64083
    54
    def apply(path: Path): Log_File =
wenzelm@64083
    55
    {
wenzelm@64083
    56
      val (path_name, ext) = path.expand.split_ext
wenzelm@64083
    57
      val text =
wenzelm@64083
    58
        if (ext == "gz") File.read_gzip(path)
wenzelm@64083
    59
        else if (ext == "xz") File.read_xz(path)
wenzelm@64083
    60
        else File.read(path)
wenzelm@64083
    61
      apply(path_name.base.implode, text)
wenzelm@64083
    62
    }
wenzelm@64083
    63
wenzelm@64062
    64
    def apply(name: String, lines: List[String]): Log_File =
wenzelm@64062
    65
      new Log_File(name, lines)
wenzelm@64062
    66
wenzelm@64062
    67
    def apply(name: String, text: String): Log_File =
wenzelm@64063
    68
      Log_File(name, Library.trim_split_lines(text))
wenzelm@64062
    69
  }
wenzelm@64062
    70
wenzelm@64062
    71
  class Log_File private(val name: String, val lines: List[String])
wenzelm@64045
    72
  {
wenzelm@64062
    73
    log_file =>
wenzelm@64062
    74
wenzelm@64062
    75
    override def toString: String = name
wenzelm@64062
    76
wenzelm@64062
    77
    def text: String = cat_lines(lines)
wenzelm@64062
    78
wenzelm@64062
    79
    def err(msg: String): Nothing =
wenzelm@64062
    80
      error("Error in log file " + quote(name) + ": " + msg)
wenzelm@64062
    81
wenzelm@64062
    82
wenzelm@64062
    83
    /* inlined content */
wenzelm@64062
    84
wenzelm@64062
    85
    def find[A](f: String => Option[A]): Option[A] =
wenzelm@64062
    86
      lines.iterator.map(f).find(_.isDefined).map(_.get)
wenzelm@64062
    87
wenzelm@64062
    88
    def find_match(regex: Regex): Option[String] =
wenzelm@64062
    89
      lines.iterator.map(regex.unapplySeq(_)).find(res => res.isDefined && res.get.length == 1).
wenzelm@64062
    90
        map(res => res.get.head)
wenzelm@64062
    91
wenzelm@64062
    92
wenzelm@64062
    93
    /* settings */
wenzelm@64062
    94
wenzelm@64081
    95
    def get_setting(a: String): Settings.Entry =
wenzelm@64081
    96
      Settings.Entry.unapply(
wenzelm@64081
    97
        lines.find(_.startsWith(a + "=")) getOrElse err("missing " + a)).get
wenzelm@64045
    98
wenzelm@64081
    99
    def get_settings(as: List[String]): Settings.T = as.map(get_setting(_))
wenzelm@64062
   100
wenzelm@64062
   101
wenzelm@64062
   102
    /* properties (YXML) */
wenzelm@64062
   103
wenzelm@64062
   104
    val xml_cache = new XML.Cache()
wenzelm@64062
   105
wenzelm@64062
   106
    def parse_props(text: String): Properties.T =
wenzelm@64062
   107
      xml_cache.props(XML.Decode.properties(YXML.parse_body(text)))
wenzelm@64062
   108
wenzelm@64062
   109
    def filter_props(prefix: String): List[Properties.T] =
wenzelm@64062
   110
      for (line <- lines; s <- Library.try_unprefix(prefix, line)) yield parse_props(s)
wenzelm@64045
   111
wenzelm@64062
   112
    def find_line(prefix: String): Option[String] =
wenzelm@64062
   113
      find(Library.try_unprefix(prefix, _))
wenzelm@64062
   114
wenzelm@64062
   115
    def find_props(prefix: String): Option[Properties.T] =
wenzelm@64062
   116
      find_line(prefix).map(parse_props(_))
wenzelm@64062
   117
wenzelm@64062
   118
wenzelm@64062
   119
    /* parse various formats */
wenzelm@64062
   120
wenzelm@64082
   121
    def parse_session_info(
wenzelm@64085
   122
        default_name: String = "",
wenzelm@64082
   123
        command_timings: Boolean = false,
wenzelm@64082
   124
        ml_statistics: Boolean = false,
wenzelm@64082
   125
        task_statistics: Boolean = false): Session_Info =
wenzelm@64082
   126
      Build_Log.parse_session_info(
wenzelm@64085
   127
        log_file, default_name, command_timings, ml_statistics, task_statistics)
wenzelm@64062
   128
wenzelm@64085
   129
    def parse_header(): Header = Build_Log.parse_header(log_file)
wenzelm@64062
   130
wenzelm@64085
   131
    def parse_build_info(): Build_Info = Build_Log.parse_build_info(log_file)
wenzelm@64045
   132
  }
wenzelm@64045
   133
wenzelm@64045
   134
wenzelm@64045
   135
  /* session log: produced by "isabelle build" */
wenzelm@64045
   136
wenzelm@64045
   137
  sealed case class Session_Info(
wenzelm@64045
   138
    session_name: String,
wenzelm@64045
   139
    session_timing: Properties.T,
wenzelm@64045
   140
    command_timings: List[Properties.T],
wenzelm@64045
   141
    ml_statistics: List[Properties.T],
wenzelm@64045
   142
    task_statistics: List[Properties.T])
wenzelm@64045
   143
wenzelm@64082
   144
  private def parse_session_info(
wenzelm@64082
   145
    log_file: Log_File,
wenzelm@64082
   146
    default_name: String,
wenzelm@64082
   147
    command_timings: Boolean,
wenzelm@64082
   148
    ml_statistics: Boolean,
wenzelm@64082
   149
    task_statistics: Boolean): Session_Info =
wenzelm@64045
   150
  {
wenzelm@64045
   151
    val xml_cache = new XML.Cache()
wenzelm@64045
   152
wenzelm@64045
   153
    val session_name =
wenzelm@64062
   154
      log_file.find_line("\fSession.name = ") match {
wenzelm@64082
   155
        case None => default_name
wenzelm@64082
   156
        case Some(name) if default_name == "" || default_name == name => name
wenzelm@64062
   157
        case Some(name) => log_file.err("log from different session " + quote(name))
wenzelm@64045
   158
      }
wenzelm@64062
   159
    val session_timing = log_file.find_props("\fTiming = ") getOrElse Nil
wenzelm@64082
   160
    val command_timings_ =
wenzelm@64082
   161
      if (command_timings) log_file.filter_props("\fcommand_timing = ") else Nil
wenzelm@64082
   162
    val ml_statistics_ =
wenzelm@64082
   163
      if (ml_statistics) log_file.filter_props("\fML_statistics = ") else Nil
wenzelm@64082
   164
    val task_statistics_ =
wenzelm@64082
   165
      if (task_statistics) log_file.filter_props("\ftask_statistics = ") else Nil
wenzelm@64045
   166
wenzelm@64082
   167
    Session_Info(session_name, session_timing, command_timings_, ml_statistics_, task_statistics_)
wenzelm@64045
   168
  }
wenzelm@64054
   169
wenzelm@64054
   170
wenzelm@64062
   171
  /* header and meta data */
wenzelm@64061
   172
wenzelm@64061
   173
  object Header_Kind extends Enumeration
wenzelm@64061
   174
  {
wenzelm@64061
   175
    val ISATEST = Value("isatest")
wenzelm@64061
   176
    val AFP_TEST = Value("afp-test")
wenzelm@64061
   177
    val JENKINS = Value("jenkins")
wenzelm@64061
   178
  }
wenzelm@64061
   179
wenzelm@64081
   180
  sealed case class Header(
wenzelm@64081
   181
    kind: Header_Kind.Value, props: Properties.T, settings: List[(String, String)])
wenzelm@64061
   182
wenzelm@64061
   183
  object Field
wenzelm@64061
   184
  {
wenzelm@64061
   185
    val build_host = "build_host"
wenzelm@64061
   186
    val build_start = "build_start"
wenzelm@64061
   187
    val build_end = "build_end"
wenzelm@64061
   188
    val isabelle_version = "isabelle_version"
wenzelm@64061
   189
    val afp_version = "afp_version"
wenzelm@64061
   190
  }
wenzelm@64061
   191
wenzelm@64061
   192
  object AFP
wenzelm@64061
   193
  {
wenzelm@64061
   194
    val Date_Format =
wenzelm@64061
   195
      Date.Format.make_patterns(List("EEE MMM d HH:mm:ss VV yyyy", "EEE MMM d HH:mm:ss O yyyy"),
wenzelm@64061
   196
        // workaround for jdk-8u102
wenzelm@64061
   197
        s => Word.implode(Word.explode(s).map({ case "CEST" => "GMT+2" case a => a })))
wenzelm@64062
   198
wenzelm@64087
   199
    val Test_Start = new Regex("""^Start test for .+ at (.+), (\S+)$""")
wenzelm@64087
   200
    val Test_End = new Regex("""^End test on (.+), \S+, elapsed time:.*$""")
wenzelm@64087
   201
    val Isabelle_Version = new Regex("""^Isabelle version: .* -- hg id (\S+)$""")
wenzelm@64087
   202
    val AFP_Version = new Regex("""^AFP version: .* -- hg id (\S+)$""")
wenzelm@64061
   203
  }
wenzelm@64061
   204
wenzelm@64062
   205
  private def parse_header(log_file: Log_File): Header =
wenzelm@64061
   206
  {
wenzelm@64062
   207
    log_file.lines match {
wenzelm@64062
   208
      case AFP.Test_Start(start, hostname) :: _ =>
wenzelm@64062
   209
        (start, log_file.lines.last) match {
wenzelm@64062
   210
          case (AFP.Date_Format(start_date), AFP.Test_End(AFP.Date_Format(end_date))) =>
wenzelm@64062
   211
            val isabelle_version =
wenzelm@64062
   212
              log_file.find_match(AFP.Isabelle_Version) getOrElse
wenzelm@64062
   213
                log_file.err("missing Isabelle version")
wenzelm@64062
   214
            val afp_version =
wenzelm@64062
   215
              log_file.find_match(AFP.AFP_Version) getOrElse
wenzelm@64062
   216
                log_file.err("missing AFP version")
wenzelm@64061
   217
wenzelm@64062
   218
            Header(Header_Kind.AFP_TEST,
wenzelm@64061
   219
              List(
wenzelm@64061
   220
                Field.build_host -> hostname,
wenzelm@64061
   221
                Field.build_start -> start_date.toString,
wenzelm@64062
   222
                Field.build_end -> end_date.toString,
wenzelm@64062
   223
                Field.isabelle_version -> isabelle_version,
wenzelm@64062
   224
                Field.afp_version -> afp_version),
wenzelm@64081
   225
              log_file.get_settings(Settings.all_settings))
wenzelm@64062
   226
wenzelm@64062
   227
          case _ => log_file.err("cannot detect start/end date in afp-test log")
wenzelm@64061
   228
        }
wenzelm@64062
   229
      case _ => log_file.err("cannot detect log header format")
wenzelm@64061
   230
    }
wenzelm@64061
   231
  }
wenzelm@64061
   232
wenzelm@64085
   233
wenzelm@64085
   234
  /* build info: produced by isabelle build */
wenzelm@64085
   235
wenzelm@64061
   236
  object Session_Status extends Enumeration
wenzelm@64061
   237
  {
wenzelm@64085
   238
    val EXISTING = Value("existing")
wenzelm@64061
   239
    val FINISHED = Value("finished")
wenzelm@64061
   240
    val FAILED = Value("failed")
wenzelm@64061
   241
    val CANCELLED = Value("cancelled")
wenzelm@64061
   242
  }
wenzelm@64061
   243
wenzelm@64085
   244
  sealed case class Session_Entry(
wenzelm@64085
   245
    chapter: String,
wenzelm@64085
   246
    groups: List[String],
wenzelm@64085
   247
    threads: Option[Int],
wenzelm@64085
   248
    timing: Option[Timing],
wenzelm@64085
   249
    ml_timing: Option[Timing],
wenzelm@64085
   250
    status: Session_Status.Value)
wenzelm@64085
   251
  {
wenzelm@64085
   252
    def finished: Boolean = status == Session_Status.FINISHED
wenzelm@64085
   253
  }
wenzelm@64054
   254
wenzelm@64085
   255
  sealed case class Build_Info(sessions: Map[String, Session_Entry])
wenzelm@64054
   256
  {
wenzelm@64085
   257
    def session(name: String): Session_Entry = sessions(name)
wenzelm@64085
   258
    def get_session(name: String): Option[Session_Entry] = sessions.get(name)
wenzelm@64054
   259
wenzelm@64085
   260
    def finished(name: String): Boolean =
wenzelm@64085
   261
      get_session(name) match {
wenzelm@64085
   262
        case Some(entry) => entry.finished
wenzelm@64085
   263
        case None => false
wenzelm@64085
   264
      }
wenzelm@64085
   265
wenzelm@64085
   266
    def timing(name: String): Timing =
wenzelm@64085
   267
      (for (entry <- get_session(name); t <- entry.timing) yield t) getOrElse Timing.zero
wenzelm@64085
   268
wenzelm@64085
   269
    def ml_timing(name: String): Timing =
wenzelm@64085
   270
      (for (entry <- get_session(name); t <- entry.ml_timing) yield t) getOrElse Timing.zero
wenzelm@64054
   271
  }
wenzelm@64054
   272
wenzelm@64085
   273
  private def parse_build_info(log_file: Log_File): Build_Info =
wenzelm@64085
   274
  {
wenzelm@64085
   275
    object Chapter_Name
wenzelm@64085
   276
    {
wenzelm@64085
   277
      def unapply(s: String): Some[(String, String)] =
wenzelm@64085
   278
        space_explode('/', s) match {
wenzelm@64085
   279
          case List(chapter, name) => Some((chapter, name))
wenzelm@64085
   280
          case _ => Some(("", s))
wenzelm@64085
   281
        }
wenzelm@64085
   282
    }
wenzelm@64054
   283
wenzelm@64085
   284
    val Session_No_Groups = new Regex("""^Session (\S+)$""")
wenzelm@64085
   285
    val Session_Groups = new Regex("""^Session (\S+) \((.*)\)$""")
wenzelm@64085
   286
    val Session_Finished1 =
wenzelm@64085
   287
      new Regex("""^Finished (\S+) \((\d+):(\d+):(\d+) elapsed time, (\d+):(\d+):(\d+) cpu time.*$""")
wenzelm@64085
   288
    val Session_Finished2 =
wenzelm@64085
   289
      new Regex("""^Finished (\S+) \((\d+):(\d+):(\d+) elapsed time.*$""")
wenzelm@64085
   290
    val Session_Timing =
wenzelm@64085
   291
      new Regex("""^Timing (\S+) \((\d) threads, (\d+\.\d+)s elapsed time, (\d+\.\d+)s cpu time, (\d+\.\d+)s GC time.*$""")
wenzelm@64086
   292
    val Session_Started = new Regex("""^(?:Running|Building) (\S+) \.\.\.$""")
wenzelm@64085
   293
    val Session_Failed = new Regex("""^(\S+) FAILED""")
wenzelm@64085
   294
    val Session_Cancelled = new Regex("""^(\S+) CANCELLED""")
wenzelm@64085
   295
wenzelm@64085
   296
    var chapter = Map.empty[String, String]
wenzelm@64085
   297
    var groups = Map.empty[String, List[String]]
wenzelm@64085
   298
    var threads = Map.empty[String, Int]
wenzelm@64054
   299
    var timing = Map.empty[String, Timing]
wenzelm@64085
   300
    var ml_timing = Map.empty[String, Timing]
wenzelm@64086
   301
    var started = Set.empty[String]
wenzelm@64085
   302
    var failed = Set.empty[String]
wenzelm@64085
   303
    var cancelled = Set.empty[String]
wenzelm@64085
   304
    def all_sessions: Set[String] =
wenzelm@64085
   305
      chapter.keySet ++ groups.keySet ++ threads.keySet ++
wenzelm@64086
   306
      timing.keySet ++ ml_timing.keySet ++ failed ++ cancelled ++ started
wenzelm@64085
   307
wenzelm@64054
   308
wenzelm@64062
   309
    for (line <- log_file.lines) {
wenzelm@64054
   310
      line match {
wenzelm@64085
   311
        case Session_No_Groups(Chapter_Name(chapt, name)) =>
wenzelm@64085
   312
          chapter += (name -> chapt)
wenzelm@64085
   313
          groups += (name -> Nil)
wenzelm@64085
   314
        case Session_Groups(Chapter_Name(chapt, name), grps) =>
wenzelm@64085
   315
          chapter += (name -> chapt)
wenzelm@64085
   316
          groups += (name -> Word.explode(grps))
wenzelm@64086
   317
        case Session_Started(name) =>
wenzelm@64086
   318
          started += name
wenzelm@64054
   319
        case Session_Finished1(name,
wenzelm@64054
   320
            Value.Int(e1), Value.Int(e2), Value.Int(e3),
wenzelm@64054
   321
            Value.Int(c1), Value.Int(c2), Value.Int(c3)) =>
wenzelm@64054
   322
          val elapsed = Time.hms(e1, e2, e3)
wenzelm@64054
   323
          val cpu = Time.hms(c1, c2, c3)
wenzelm@64085
   324
          timing += (name -> Timing(elapsed, cpu, Time.zero))
wenzelm@64054
   325
        case Session_Finished2(name,
wenzelm@64054
   326
            Value.Int(e1), Value.Int(e2), Value.Int(e3)) =>
wenzelm@64054
   327
          val elapsed = Time.hms(e1, e2, e3)
wenzelm@64085
   328
          timing += (name -> Timing(elapsed, Time.zero, Time.zero))
wenzelm@64054
   329
        case Session_Timing(name,
wenzelm@64054
   330
            Value.Int(t), Value.Double(e), Value.Double(c), Value.Double(g)) =>
wenzelm@64054
   331
          val elapsed = Time.seconds(e)
wenzelm@64054
   332
          val cpu = Time.seconds(c)
wenzelm@64054
   333
          val gc = Time.seconds(g)
wenzelm@64085
   334
          ml_timing += (name -> Timing(elapsed, cpu, gc))
wenzelm@64054
   335
          threads += (name -> t)
wenzelm@64054
   336
        case _ =>
wenzelm@64054
   337
      }
wenzelm@64054
   338
    }
wenzelm@64054
   339
wenzelm@64085
   340
    val sessions =
wenzelm@64085
   341
      Map(
wenzelm@64085
   342
        (for (name <- all_sessions.toList) yield {
wenzelm@64085
   343
          val status =
wenzelm@64085
   344
            if (failed(name)) Session_Status.FAILED
wenzelm@64085
   345
            else if (cancelled(name)) Session_Status.CANCELLED
wenzelm@64086
   346
            else if (timing.isDefinedAt(name) || ml_timing.isDefinedAt(name))
wenzelm@64086
   347
              Session_Status.FINISHED
wenzelm@64086
   348
            else if (started(name)) Session_Status.FAILED
wenzelm@64085
   349
            else Session_Status.EXISTING
wenzelm@64085
   350
          val entry =
wenzelm@64085
   351
            Session_Entry(
wenzelm@64085
   352
              chapter.getOrElse(name, ""),
wenzelm@64085
   353
              groups.getOrElse(name, Nil),
wenzelm@64085
   354
              threads.get(name),
wenzelm@64085
   355
              timing.get(name),
wenzelm@64085
   356
              ml_timing.get(name),
wenzelm@64085
   357
              status)
wenzelm@64085
   358
          (name -> entry)
wenzelm@64085
   359
        }):_*)
wenzelm@64085
   360
    Build_Info(sessions)
wenzelm@64054
   361
  }
wenzelm@64045
   362
}