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