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