src/Pure/Admin/build_status.scala
author wenzelm
Mon May 08 14:30:59 2017 +0200 (2017-05-08)
changeset 65773 120ef768c84c
parent 65769 490b7c517000
child 65782 4935bac8a850
permissions -rw-r--r--
clarified image 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   private val default_target_dir = Path.explode("build_status")
    13   private val default_history_length = 30
    14   private val default_image_size = (800, 600)
    15 
    16 
    17   /* data profiles */
    18 
    19   def clean_name(name: String): String =
    20     name.flatMap(c => if (c == ' ' || c == '/') "_" else if (c == ',') "" else c.toString)
    21 
    22   sealed case class Profile(description: String, sql: String)
    23   {
    24     def select(columns: List[SQL.Column], days: Int, only_sessions: Set[String]): SQL.Source =
    25     {
    26       val sql_sessions =
    27         if (only_sessions.isEmpty) ""
    28         else
    29           only_sessions.iterator.map(a => Build_Log.Data.session_name + " = " + SQL.string(a))
    30             .mkString("(", " OR ", ") AND ")
    31 
    32       Build_Log.Data.universal_table.select(columns, distinct = true,
    33         sql = "WHERE " +
    34           Build_Log.Data.pull_date + " > " + Build_Log.Data.recent_time(days) + " AND " +
    35           Build_Log.Data.status + " = " + SQL.string(Build_Log.Session_Status.finished.toString) +
    36           " AND " + sql_sessions + SQL.enclose(sql) +
    37           " ORDER BY " + Build_Log.Data.pull_date + " DESC")
    38     }
    39   }
    40 
    41   val standard_profiles: List[Profile] =
    42     Jenkins.build_status_profiles ::: Isabelle_Cronjob.build_status_profiles
    43 
    44 
    45   sealed case class Data(date: Date, entries: List[(String, List[Session])])
    46   sealed case class Session(name: String, threads: Int, entries: List[Entry])
    47   {
    48     def timing: Timing = if (entries.isEmpty) Timing.zero else entries.head.timing
    49     def ml_timing: Timing = if (entries.isEmpty) Timing.zero else entries.head.ml_timing
    50     def order: Long = - timing.elapsed.ms
    51 
    52     def check_timing: Boolean = entries.length >= 3
    53     def check_heap: Boolean = entries.forall(_.heap_size > 0)
    54   }
    55   sealed case class Entry(date: Date, timing: Timing, ml_timing: Timing, heap_size: Long)
    56 
    57 
    58   /* read data */
    59 
    60   def read_data(options: Options,
    61     profiles: List[Profile] = standard_profiles,
    62     progress: Progress = No_Progress,
    63     history_length: Int = default_history_length,
    64     only_sessions: Set[String] = Set.empty,
    65     verbose: Boolean = false): Data =
    66   {
    67     val date = Date.now()
    68     var data_entries = Map.empty[String, Map[String, Session]]
    69 
    70     val store = Build_Log.store(options)
    71     using(store.open_database())(db =>
    72     {
    73       for (profile <- profiles.sortBy(_.description)) {
    74         progress.echo("input " + quote(profile.description))
    75         val columns =
    76           List(
    77             Build_Log.Data.pull_date,
    78             Build_Log.Settings.ISABELLE_BUILD_OPTIONS,
    79             Build_Log.Settings.ML_PLATFORM,
    80             Build_Log.Data.session_name,
    81             Build_Log.Data.threads,
    82             Build_Log.Data.timing_elapsed,
    83             Build_Log.Data.timing_cpu,
    84             Build_Log.Data.timing_gc,
    85             Build_Log.Data.ml_timing_elapsed,
    86             Build_Log.Data.ml_timing_cpu,
    87             Build_Log.Data.ml_timing_gc,
    88             Build_Log.Data.heap_size)
    89 
    90         val Threads_Option = """threads\s*=\s*(\d+)""".r
    91 
    92         val sql = profile.select(columns, history_length, only_sessions)
    93         if (verbose) progress.echo(sql)
    94 
    95         db.using_statement(sql)(stmt =>
    96         {
    97           val res = stmt.execute_query()
    98           while (res.next()) {
    99             val session_name = res.string(Build_Log.Data.session_name)
   100             val threads =
   101             {
   102               val threads1 =
   103                 res.string(Build_Log.Settings.ISABELLE_BUILD_OPTIONS) match {
   104                   case Threads_Option(Value.Int(i)) if session_name == "Pure" => i
   105                   case _ => 1
   106                 }
   107               val threads2 = res.get_int(Build_Log.Data.threads).getOrElse(1)
   108               threads1 max threads2
   109             }
   110             val ml_platform = res.string(Build_Log.Settings.ML_PLATFORM)
   111             val data_name =
   112               profile.description +
   113                 (if (ml_platform.startsWith("x86_64")) ", 64bit" else "") +
   114                 (if (threads == 1) "" else ", " + threads + " threads")
   115 
   116             val entry =
   117               Entry(res.date(Build_Log.Data.pull_date),
   118                 res.timing(
   119                   Build_Log.Data.timing_elapsed,
   120                   Build_Log.Data.timing_cpu,
   121                   Build_Log.Data.timing_gc),
   122                 res.timing(
   123                   Build_Log.Data.ml_timing_elapsed,
   124                   Build_Log.Data.ml_timing_cpu,
   125                   Build_Log.Data.ml_timing_gc),
   126                 heap_size = res.long(Build_Log.Data.heap_size))
   127 
   128             val sessions = data_entries.getOrElse(data_name, Map.empty)
   129             val entries = sessions.get(session_name).map(_.entries) getOrElse Nil
   130             val session = Session(session_name, threads, entry :: entries)
   131             data_entries += (data_name -> (sessions + (session_name -> session)))
   132           }
   133         })
   134       }
   135     })
   136 
   137     Data(date,
   138       (for {
   139         (data_name, sessions) <- data_entries.toList
   140         sorted_sessions <-
   141           proper_list(sessions.toList.map(_._2).filter(_.check_timing).sortBy(_.order))
   142       } yield (data_name, sorted_sessions)).sortBy(_._1))
   143   }
   144 
   145 
   146   /* present data */
   147 
   148   def present_data(data: Data,
   149     progress: Progress = No_Progress,
   150     target_dir: Path = default_target_dir,
   151     image_size: (Int, Int) = default_image_size)
   152   {
   153     for ((data_name, sessions) <- data.entries) {
   154       val dir = target_dir + Path.basic(clean_name(data_name))
   155 
   156       progress.echo("output " + dir)
   157       Isabelle_System.mkdirs(dir)
   158 
   159       val session_plots =
   160         Par_List.map((session: Session) =>
   161           Isabelle_System.with_tmp_file(session.name, "data") { data_file =>
   162             Isabelle_System.with_tmp_file(session.name, "gnuplot") { gnuplot_file =>
   163 
   164               File.write(data_file,
   165                 cat_lines(
   166                   session.entries.map(entry =>
   167                     List(entry.date.unix_epoch.toString,
   168                       entry.timing.elapsed.minutes,
   169                       entry.timing.resources.minutes,
   170                       entry.ml_timing.elapsed.minutes,
   171                       entry.ml_timing.resources.minutes,
   172                       (entry.heap_size.toDouble / (1024 * 1024)).toString).mkString(" "))))
   173 
   174               val max_time =
   175                 ((0.0 /: session.entries){ case (m, entry) =>
   176                   m.max(entry.timing.elapsed.minutes).
   177                     max(entry.timing.resources.minutes).
   178                     max(entry.ml_timing.elapsed.minutes).
   179                     max(entry.ml_timing.resources.minutes) } max 0.1) * 1.1
   180               val timing_range = "[0:" + max_time + "]"
   181 
   182               def gnuplot(plots: List[String], kind: String, range: String): String =
   183               {
   184                 val plot_name = session.name + "_" + kind + ".png"
   185 
   186                 File.write(gnuplot_file, """
   187 set terminal png size """ + image_size._1 + "," + image_size._2 + """
   188 set output """ + quote(File.standard_path(dir + Path.basic(plot_name))) + """
   189 set xdata time
   190 set timefmt "%s"
   191 set format x "%d-%b"
   192 set xlabel """ + quote(session.name) + """ noenhanced
   193 set key left bottom
   194 plot [] """ + range + " " +
   195                 plots.map(s => quote(data_file.implode) + " " + s).mkString(", ") + "\n")
   196 
   197                 val result =
   198                   Isabelle_System.bash("\"$ISABELLE_GNUPLOT\" " + File.bash_path(gnuplot_file))
   199                 if (!result.ok)
   200                   result.error("Gnuplot failed for " + data_name + "/" + plot_name).check
   201 
   202                 plot_name
   203               }
   204 
   205               val timing_plots =
   206               {
   207                 val plots1 =
   208                   List(
   209                     """ using 1:2 smooth sbezier title "elapsed time (smooth)" """,
   210                     """ using 1:2 smooth csplines title "elapsed time" """)
   211                 val plots2 =
   212                   List(
   213                     """ using 1:3 smooth sbezier title "cpu time (smooth)" """,
   214                     """ using 1:3 smooth csplines title "cpu time" """)
   215                 if (session.threads == 1) plots1 else plots1 ::: plots2
   216               }
   217 
   218               val ml_timing_plots =
   219                 List(
   220                   """ using 1:4 smooth sbezier title "ML elapsed time (smooth)" """,
   221                   """ using 1:4 smooth csplines title "ML elapsed time" """,
   222                   """ using 1:5 smooth sbezier title "ML cpu time (smooth)" """,
   223                   """ using 1:5 smooth csplines title "ML cpu time" """)
   224 
   225               val heap_plots =
   226                 List(
   227                   """ using 1:6 smooth sbezier title "heap (smooth)" """,
   228                   """ using 1:6 smooth csplines title "heap" """)
   229 
   230               val plot_names =
   231                 List(
   232                   gnuplot(timing_plots, "timing", timing_range),
   233                   gnuplot(ml_timing_plots, "ml_timing", timing_range)) :::
   234                 (if (session.check_heap) List(gnuplot(heap_plots, "heap", "[0:]")) else Nil)
   235 
   236               session.name -> plot_names
   237             }
   238           }, sessions).toMap
   239 
   240       File.write(dir + Path.basic("index.html"),
   241         HTML.output_document(
   242           List(HTML.title("Isabelle build status for " + data_name)),
   243           HTML.chapter("Isabelle build status for " + data_name + " (" + data.date + ")") ::
   244           HTML.itemize(
   245             sessions.map(session =>
   246               HTML.link("#session_" + session.name, HTML.text(session.name)) ::
   247               HTML.text(" (" + session.timing.message_resources + ")"))) ::
   248           sessions.flatMap(session =>
   249             List(
   250               HTML.section(session.name) + HTML.id("session_" + session.name),
   251               HTML.par(
   252                 HTML.itemize(List(
   253                   HTML.bold(HTML.text("timing: ")) :: HTML.text(session.timing.message_resources),
   254                   HTML.bold(HTML.text("ML timing: ")) ::
   255                     HTML.text(session.ml_timing.message_resources))) ::
   256                 session_plots.getOrElse(session.name, Nil).map(plot_name =>
   257                   HTML.image(plot_name) +
   258                     HTML.width(image_size._1 / 2) +
   259                     HTML.height(image_size._2 / 2)))))))
   260     }
   261 
   262     File.write(target_dir + Path.basic("index.html"),
   263       HTML.output_document(
   264         List(HTML.title("Isabelle build status")),
   265         List(HTML.chapter("Isabelle build status (" + data.date + ")"),
   266           HTML.itemize(data.entries.map({ case (data_name, _) =>
   267             List(HTML.link(clean_name(data_name) + "/index.html", HTML.text(data_name))) })))))
   268   }
   269 
   270 
   271   /* Isabelle tool wrapper */
   272 
   273   val isabelle_tool =
   274     Isabelle_Tool("build_status", "present recent build status information from database", args =>
   275     {
   276       var target_dir = default_target_dir
   277       var only_sessions = Set.empty[String]
   278       var history_length = default_history_length
   279       var options = Options.init()
   280       var image_size = default_image_size
   281       var verbose = false
   282 
   283       val getopts = Getopts("""
   284 Usage: isabelle build_status [OPTIONS]
   285 
   286   Options are:
   287     -D DIR       target directory (default """ + default_target_dir + """)
   288     -S SESSIONS  only given SESSIONS (comma separated)
   289     -l LENGTH    length of history (default """ + default_history_length + """)
   290     -o OPTION    override Isabelle system OPTION (via NAME=VAL or NAME)
   291     -s WxH       size of PNG image (default """ + image_size._1 + "x" + image_size._2 + """)
   292     -v           verbose
   293 
   294   Present performance statistics from build log database, which is specified
   295   via system options build_log_database_host, build_log_database_user etc.
   296 """,
   297         "D:" -> (arg => target_dir = Path.explode(arg)),
   298         "S:" -> (arg => only_sessions = space_explode(',', arg).toSet),
   299         "l:" -> (arg => history_length = Value.Int.parse(arg)),
   300         "o:" -> (arg => options = options + arg),
   301         "s:" -> (arg =>
   302           space_explode('x', arg).map(Value.Int.parse(_)) match {
   303             case List(w, h) if w > 0 && h > 0 => image_size = (w, h)
   304             case _ => error("Error bad PNG image size: " + quote(arg))
   305           }),
   306         "v" -> (_ => verbose = true))
   307 
   308       val more_args = getopts(args)
   309       if (more_args.nonEmpty) getopts.usage()
   310 
   311       val progress = new Console_Progress
   312 
   313       val data =
   314         read_data(options, progress = progress, history_length = history_length,
   315           only_sessions = only_sessions, verbose = verbose)
   316 
   317       present_data(data, progress = progress, target_dir = target_dir, image_size = image_size)
   318 
   319   }, admin = true)
   320 }