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