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