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