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