src/Pure/Admin/build_status.scala
author wenzelm
Wed May 17 22:32:48 2017 +0200 (2017-05-17)
changeset 65859 95ddb6dea0d5
parent 65857 5d29d93766ef
child 65860 ce6be2e40d47
permissions -rw-r--r--
plot average heap size;
     1 /*  Title:      Pure/Admin/build_status.scala
     2     Author:     Makarius
     3 
     4 Present recent build status information from database.
     5 */
     6 
     7 package isabelle
     8 
     9 
    10 object Build_Status
    11 {
    12   /* defaults */
    13 
    14   val default_target_dir = Path.explode("build_status")
    15   val default_image_size = (800, 600)
    16   val default_history = 30
    17 
    18   def default_profiles: List[Profile] =
    19     Jenkins.build_status_profiles ::: Isabelle_Cronjob.build_status_profiles
    20 
    21 
    22   /* data profiles */
    23 
    24   sealed case class Profile(description: String, history: Int, sql: String)
    25   {
    26     def days(options: Options): Int = options.int("build_log_history") max history
    27 
    28     def stretch(options: Options): Double =
    29       (days(options) max default_history min (default_history * 5)).toDouble / default_history
    30 
    31     def select(options: Options, columns: List[SQL.Column], only_sessions: Set[String]): SQL.Source =
    32     {
    33       Build_Log.Data.universal_table.select(columns, distinct = true,
    34         sql = "WHERE " +
    35           Build_Log.Data.pull_date + " > " + Build_Log.Data.recent_time(days(options)) + " AND " +
    36           Build_Log.Data.status + " = " + SQL.string(Build_Log.Session_Status.finished.toString) +
    37           (if (only_sessions.isEmpty) ""
    38            else " AND " + SQL.member(Build_Log.Data.session_name.ident, only_sessions)) +
    39           " AND " + SQL.enclose(sql) +
    40           " ORDER BY " + Build_Log.Data.pull_date)
    41     }
    42   }
    43 
    44 
    45   /* build status */
    46 
    47   def build_status(options: Options,
    48     progress: Progress = No_Progress,
    49     profiles: List[Profile] = default_profiles,
    50     only_sessions: Set[String] = Set.empty,
    51     verbose: Boolean = false,
    52     target_dir: Path = default_target_dir,
    53     ml_statistics: Boolean = false,
    54     image_size: (Int, Int) = default_image_size)
    55   {
    56     val data =
    57       read_data(options, progress = progress, profiles = profiles,
    58         only_sessions = only_sessions, ml_statistics = ml_statistics, verbose = verbose)
    59 
    60     present_data(data, progress = progress, target_dir = target_dir, image_size = image_size)
    61   }
    62 
    63 
    64   /* read data */
    65 
    66   sealed case class Data(date: Date, entries: List[Data_Entry])
    67   sealed case class Data_Entry(
    68     name: String, hosts: List[String], stretch: Double, sessions: List[Session])
    69   sealed case class Session(name: String, threads: Int, entries: List[Entry])
    70   {
    71     require(entries.nonEmpty)
    72 
    73     def pull_date: Date = entries.head.pull_date
    74     def isabelle_version: String = entries.head.isabelle_version
    75     def afp_version: String = entries.head.afp_version
    76 
    77     def timing: Timing = entries.head.timing
    78     def ml_timing: Timing = entries.head.ml_timing
    79     def order: Long = - timing.elapsed.ms
    80 
    81     def check_timing: Boolean = entries.length >= 3
    82     def check_heap: Boolean =
    83       entries.length >= 3 &&
    84       entries.forall(entry =>
    85         entry.maximum_heap > 0 ||
    86         entry.average_heap > 0 ||
    87         entry.final_heap > 0)
    88   }
    89   sealed case class Entry(
    90     pull_date: Date,
    91     isabelle_version: String,
    92     afp_version: String,
    93     timing: Timing,
    94     ml_timing: Timing,
    95     maximum_heap: Long,
    96     average_heap: Long,
    97     final_heap: Long,
    98     ml_statistics: ML_Statistics)
    99 
   100   def read_data(options: Options,
   101     progress: Progress = No_Progress,
   102     profiles: List[Profile] = default_profiles,
   103     only_sessions: Set[String] = Set.empty,
   104     ml_statistics: Boolean = false,
   105     verbose: Boolean = false): Data =
   106   {
   107     val date = Date.now()
   108     var data_hosts = Map.empty[String, Set[String]]
   109     var data_stretch = Map.empty[String, Double]
   110     var data_entries = Map.empty[String, Map[String, Session]]
   111 
   112     def get_hosts(data_name: String): Set[String] =
   113       data_hosts.getOrElse(data_name, Set.empty)
   114 
   115     val store = Build_Log.store(options)
   116     using(store.open_database())(db =>
   117     {
   118       for (profile <- profiles.sortBy(_.description)) {
   119         progress.echo("input " + quote(profile.description))
   120 
   121         val columns =
   122           List(
   123             Build_Log.Data.pull_date,
   124             Build_Log.Prop.build_host,
   125             Build_Log.Prop.isabelle_version,
   126             Build_Log.Prop.afp_version,
   127             Build_Log.Settings.ISABELLE_BUILD_OPTIONS,
   128             Build_Log.Settings.ML_PLATFORM,
   129             Build_Log.Data.session_name,
   130             Build_Log.Data.threads,
   131             Build_Log.Data.timing_elapsed,
   132             Build_Log.Data.timing_cpu,
   133             Build_Log.Data.timing_gc,
   134             Build_Log.Data.ml_timing_elapsed,
   135             Build_Log.Data.ml_timing_cpu,
   136             Build_Log.Data.ml_timing_gc,
   137             Build_Log.Data.heap_size) :::
   138           (if (ml_statistics) List(Build_Log.Data.ml_statistics) else Nil)
   139 
   140         val Threads_Option = """threads\s*=\s*(\d+)""".r
   141 
   142         val sql = profile.select(options, columns, only_sessions)
   143         if (verbose) progress.echo(sql)
   144 
   145         db.using_statement(sql)(stmt =>
   146         {
   147           val res = stmt.execute_query()
   148           while (res.next()) {
   149             val session_name = res.string(Build_Log.Data.session_name)
   150             val threads =
   151             {
   152               val threads1 =
   153                 res.string(Build_Log.Settings.ISABELLE_BUILD_OPTIONS) match {
   154                   case Threads_Option(Value.Int(i)) if session_name == "Pure" => i
   155                   case _ => 1
   156                 }
   157               val threads2 = res.get_int(Build_Log.Data.threads).getOrElse(1)
   158               threads1 max threads2
   159             }
   160             val ml_platform = res.string(Build_Log.Settings.ML_PLATFORM)
   161             val data_name =
   162               profile.description +
   163                 (if (ml_platform.startsWith("x86_64")) ", 64bit" else "") +
   164                 (if (threads == 1) "" else ", " + threads + " threads")
   165 
   166             res.get_string(Build_Log.Prop.build_host).foreach(host =>
   167               data_hosts += (data_name -> (get_hosts(data_name) + host)))
   168 
   169             data_stretch += (data_name -> profile.stretch(options))
   170 
   171             val isabelle_version = res.string(Build_Log.Prop.isabelle_version)
   172 
   173             val ml_stats =
   174               ML_Statistics(
   175                 if (ml_statistics)
   176                   Properties.uncompress(res.bytes(Build_Log.Data.ml_statistics))
   177                 else Nil, heading = session_name + " (Isabelle/ " + isabelle_version + ")")
   178 
   179             val entry =
   180               Entry(
   181                 pull_date = res.date(Build_Log.Data.pull_date),
   182                 isabelle_version = isabelle_version,
   183                 afp_version = res.string(Build_Log.Prop.afp_version),
   184                 timing =
   185                   res.timing(
   186                     Build_Log.Data.timing_elapsed,
   187                     Build_Log.Data.timing_cpu,
   188                     Build_Log.Data.timing_gc),
   189                 ml_timing =
   190                   res.timing(
   191                     Build_Log.Data.ml_timing_elapsed,
   192                     Build_Log.Data.ml_timing_cpu,
   193                     Build_Log.Data.ml_timing_gc),
   194                 maximum_heap = ml_stats.maximum_heap_size,
   195                 average_heap = ml_stats.average_heap_size,
   196                 final_heap = res.long(Build_Log.Data.heap_size),
   197                 ml_statistics = ml_stats)
   198 
   199             val sessions = data_entries.getOrElse(data_name, Map.empty)
   200             val entries = sessions.get(session_name).map(_.entries) getOrElse Nil
   201             val session = Session(session_name, threads, entry :: entries)
   202             data_entries += (data_name -> (sessions + (session_name -> session)))
   203           }
   204         })
   205       }
   206     })
   207 
   208     val sorted_entries =
   209       (for {
   210         (name, sessions) <- data_entries.toList
   211         sorted_sessions <- proper_list(sessions.toList.map(_._2).sortBy(_.order))
   212       }
   213       yield {
   214         val hosts = get_hosts(name).toList.sorted
   215         val stretch = data_stretch(name)
   216         Data_Entry(name, hosts, stretch, sorted_sessions)
   217       }).sortBy(_.name)
   218 
   219     Data(date, sorted_entries)
   220   }
   221 
   222 
   223   /* present data */
   224 
   225   def present_data(data: Data,
   226     progress: Progress = No_Progress,
   227     target_dir: Path = default_target_dir,
   228     image_size: (Int, Int) = default_image_size)
   229   {
   230     def clean_name(name: String): String =
   231       name.flatMap(c => if (c == ' ' || c == '/') "_" else if (c == ',') "" else c.toString)
   232 
   233     def heap_scale(x: Long): Double = x.toDouble / (1024 * 1024)
   234 
   235     HTML.write_document(target_dir, "index.html",
   236       List(HTML.title("Isabelle build status")),
   237       List(HTML.chapter("Isabelle build status"),
   238         HTML.par(
   239           List(HTML.description(
   240             List(HTML.text("status date:") -> HTML.text(data.date.toString))))),
   241         HTML.par(
   242           List(HTML.itemize(data.entries.map({ case data_entry =>
   243             List(HTML.link(clean_name(data_entry.name) + "/index.html",
   244               HTML.text(data_entry.name))) }))))))
   245 
   246     for (data_entry <- data.entries) {
   247       val data_name = data_entry.name
   248 
   249       val image_width = (image_size._1 * data_entry.stretch).toInt
   250       val image_height = image_size._2
   251 
   252       progress.echo("output " + quote(data_name))
   253 
   254       val dir = target_dir + Path.basic(clean_name(data_name))
   255       Isabelle_System.mkdirs(dir)
   256 
   257       val session_plots =
   258         Par_List.map((session: Session) =>
   259           Isabelle_System.with_tmp_file(session.name, "data") { data_file =>
   260             Isabelle_System.with_tmp_file(session.name, "gnuplot") { gnuplot_file =>
   261 
   262               File.write(data_file,
   263                 cat_lines(
   264                   session.entries.map(entry =>
   265                     List(entry.pull_date.unix_epoch,
   266                       entry.timing.elapsed.minutes,
   267                       entry.timing.resources.minutes,
   268                       entry.ml_timing.elapsed.minutes,
   269                       entry.ml_timing.resources.minutes,
   270                       heap_scale(entry.maximum_heap),
   271                       heap_scale(entry.average_heap),
   272                       heap_scale(entry.final_heap)).mkString(" "))))
   273 
   274               val max_time =
   275                 ((0.0 /: session.entries){ case (m, entry) =>
   276                   m.max(entry.timing.elapsed.minutes).
   277                     max(entry.timing.resources.minutes).
   278                     max(entry.ml_timing.elapsed.minutes).
   279                     max(entry.ml_timing.resources.minutes) } max 0.1) * 1.1
   280               val timing_range = "[0:" + max_time + "]"
   281 
   282               def gnuplot(plots: List[String], kind: String, range: String): String =
   283               {
   284                 val plot_name = session.name + "_" + kind + ".png"
   285 
   286                 File.write(gnuplot_file, """
   287 set terminal png size """ + image_width + "," + image_height + """
   288 set output """ + quote(File.standard_path(dir + Path.basic(plot_name))) + """
   289 set xdata time
   290 set timefmt "%s"
   291 set format x "%d-%b"
   292 set xlabel """ + quote(session.name) + """ noenhanced
   293 set key left bottom
   294 plot [] """ + range + " " +
   295                 plots.map(s => quote(data_file.implode) + " " + s).mkString(", ") + "\n")
   296 
   297                 val result =
   298                   Isabelle_System.bash("\"$ISABELLE_GNUPLOT\" " + File.bash_path(gnuplot_file))
   299                 if (!result.ok)
   300                   result.error("Gnuplot failed for " + data_name + "/" + plot_name).check
   301 
   302                 plot_name
   303               }
   304 
   305               val timing_plots =
   306               {
   307                 val plots1 =
   308                   List(
   309                     """ using 1:2 smooth sbezier title "elapsed time (smooth)" """,
   310                     """ using 1:2 smooth csplines title "elapsed time" """)
   311                 val plots2 =
   312                   List(
   313                     """ using 1:3 smooth sbezier title "cpu time (smooth)" """,
   314                     """ using 1:3 smooth csplines title "cpu time" """)
   315                 if (session.threads == 1) plots1 else plots1 ::: plots2
   316               }
   317 
   318               val ml_timing_plots =
   319                 List(
   320                   """ using 1:4 smooth sbezier title "ML elapsed time (smooth)" """,
   321                   """ using 1:4 smooth csplines title "ML elapsed time" """,
   322                   """ using 1:5 smooth sbezier title "ML cpu time (smooth)" """,
   323                   """ using 1:5 smooth csplines title "ML cpu time" """)
   324 
   325               val heap_plots =
   326                 List(
   327                   """ using 1:6 smooth sbezier title "maximum heap (smooth)" """,
   328                   """ using 1:6 smooth csplines title "maximum heap" """,
   329                   """ using 1:7 smooth sbezier title "average heap (smooth)" """,
   330                   """ using 1:7 smooth csplines title "average heap" """,
   331                   """ using 1:8 smooth sbezier title "final heap (smooth)" """,
   332                   """ using 1:8 smooth csplines title "final heap" """)
   333 
   334               val plot_names =
   335                 (if (session.check_timing)
   336                   List(
   337                     gnuplot(timing_plots, "timing", timing_range),
   338                     gnuplot(ml_timing_plots, "ml_timing", timing_range))
   339                  else Nil) :::
   340                 (if (session.check_heap) List(gnuplot(heap_plots, "heap", "[0:]")) else Nil)
   341 
   342               session.name -> plot_names
   343             }
   344           }, data_entry.sessions).toMap
   345 
   346       HTML.write_document(dir, "index.html",
   347         List(HTML.title("Isabelle build status for " + data_name)),
   348         HTML.chapter("Isabelle build status for " + data_name) ::
   349         HTML.par(
   350           List(HTML.description(
   351             List(
   352               HTML.text("status date:") -> HTML.text(data.date.toString),
   353               HTML.text("build host:") -> HTML.text(commas(data_entry.hosts)))))) ::
   354         HTML.par(
   355           List(HTML.itemize(
   356             data_entry.sessions.map(session =>
   357               HTML.link("#session_" + session.name, HTML.text(session.name)) ::
   358               HTML.text(" (" + session.timing.message_resources + ")"))))) ::
   359         data_entry.sessions.flatMap(session =>
   360           List(
   361             HTML.section(session.name) + HTML.id("session_" + session.name),
   362             HTML.par(
   363               HTML.description(
   364                 List(
   365                   HTML.text("timing:") -> HTML.text(session.timing.message_resources),
   366                   HTML.text("ML timing:") -> HTML.text(session.ml_timing.message_resources)) :::
   367                 proper_string(session.isabelle_version).map(s =>
   368                   HTML.text("Isabelle version:") -> HTML.text(s)).toList :::
   369                 proper_string(session.afp_version).map(s =>
   370                   HTML.text("AFP version:") -> HTML.text(s)).toList) ::
   371               session_plots.getOrElse(session.name, Nil).map(plot_name =>
   372                 HTML.image(plot_name) +
   373                   HTML.width(image_width / 2) +
   374                   HTML.height(image_height / 2))))))
   375     }
   376   }
   377 
   378 
   379   /* Isabelle tool wrapper */
   380 
   381   val isabelle_tool =
   382     Isabelle_Tool("build_status", "present recent build status information from database", args =>
   383     {
   384       var target_dir = default_target_dir
   385       var ml_statistics = false
   386       var only_sessions = Set.empty[String]
   387       var options = Options.init()
   388       var image_size = default_image_size
   389       var verbose = false
   390 
   391       val getopts = Getopts("""
   392 Usage: isabelle build_status [OPTIONS]
   393 
   394   Options are:
   395     -D DIR       target directory (default """ + default_target_dir + """)
   396     -M           include full ML statistics
   397     -S SESSIONS  only given SESSIONS (comma separated)
   398     -o OPTION    override Isabelle system OPTION (via NAME=VAL or NAME)
   399     -s WxH       size of PNG image (default """ + image_size._1 + "x" + image_size._2 + """)
   400     -v           verbose
   401 
   402   Present performance statistics from build log database, which is specified
   403   via system options build_log_database_host, build_log_database_user,
   404   build_log_history etc.
   405 """,
   406         "D:" -> (arg => target_dir = Path.explode(arg)),
   407         "M" -> (_ => ml_statistics = true),
   408         "S:" -> (arg => only_sessions = space_explode(',', arg).toSet),
   409         "o:" -> (arg => options = options + arg),
   410         "s:" -> (arg =>
   411           space_explode('x', arg).map(Value.Int.parse(_)) match {
   412             case List(w, h) if w > 0 && h > 0 => image_size = (w, h)
   413             case _ => error("Error bad PNG image size: " + quote(arg))
   414           }),
   415         "v" -> (_ => verbose = true))
   416 
   417       val more_args = getopts(args)
   418       if (more_args.nonEmpty) getopts.usage()
   419 
   420       val progress = new Console_Progress
   421 
   422       build_status(options, progress = progress, only_sessions = only_sessions, verbose = verbose,
   423         target_dir = target_dir, ml_statistics = ml_statistics, image_size = image_size)
   424 
   425   }, admin = true)
   426 }