src/Pure/Admin/build_status.scala
author wenzelm
Sun May 07 23:18:23 2017 +0200 (2017-05-07)
changeset 65764 1af6d544c2a3
parent 65763 dbadcc3fbe33
child 65765 c67bb109cd7b
permissions -rw-r--r--
clarified description vs. file name;
     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, 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             data_entries += (data_name -> (sessions + (name -> Session(name, entry :: entries))))
   129           }
   130         })
   131       }
   132     })
   133 
   134     Data(date,
   135       (for {
   136         (data_name, sessions) <- data_entries.toList
   137         sorted_sessions <- proper_list(sessions.toList.map(_._2).filter(_.check).sortBy(_.order))
   138       } yield (data_name, sorted_sessions)).sortBy(_._1))
   139   }
   140 
   141 
   142   /* present data */
   143 
   144   def present_data(data: Data,
   145     progress: Progress = No_Progress,
   146     target_dir: Path = default_target_dir,
   147     image_size: (Int, Int) = default_image_size)
   148   {
   149     for ((data_name, sessions) <- data.entries) {
   150       val dir = target_dir + Path.basic(clean_name(data_name))
   151 
   152       progress.echo("output " + dir)
   153       Isabelle_System.mkdirs(dir)
   154 
   155       val session_plots =
   156         Par_List.map((session: Session) =>
   157           Isabelle_System.with_tmp_file(session.name, "data") { data_file =>
   158             Isabelle_System.with_tmp_file(session.name, "gnuplot") { gnuplot_file =>
   159 
   160               File.write(data_file,
   161                 cat_lines(
   162                   session.entries.map(entry =>
   163                     List(entry.date.unix_epoch.toString,
   164                       entry.timing.elapsed.minutes,
   165                       entry.timing.resources.minutes,
   166                       entry.ml_timing.elapsed.minutes,
   167                       entry.ml_timing.resources.minutes).mkString(" "))))
   168 
   169               val max_time =
   170                 ((0.0 /: session.entries){ case (m, entry) =>
   171                   m.max(entry.timing.elapsed.minutes).
   172                     max(entry.timing.resources.minutes).
   173                     max(entry.ml_timing.elapsed.minutes).
   174                     max(entry.ml_timing.resources.minutes) } max 0.1) * 1.1
   175 
   176               def gnuplot(plots: List[String], kind: String): String =
   177               {
   178                 val plot_name = session.name + "_" + kind + ".png"
   179 
   180                 File.write(gnuplot_file, """
   181 set terminal png size """ + image_size._1 + "," + image_size._2 + """
   182 set output """ + quote(File.standard_path(dir + Path.basic(plot_name))) + """
   183 set xdata time
   184 set timefmt "%s"
   185 set format x "%d-%b"
   186 set xlabel """ + quote(session.name) + """ noenhanced
   187 set key left bottom
   188 plot [] [0:""" + max_time + "] " +
   189                   plots.map(s => quote(data_file.implode) + " " + s).mkString(", ") + "\n")
   190 
   191                 val result =
   192                   Isabelle_System.bash("\"$ISABELLE_GNUPLOT\" " + File.bash_path(gnuplot_file))
   193                 if (!result.ok)
   194                   result.error("Gnuplot failed for " + data_name + "/" + plot_name).check
   195 
   196                 plot_name
   197               }
   198 
   199               val timing_plots =
   200                 List(
   201                   """ using 1:3 smooth sbezier title "cpu time (smooth)" """,
   202                   """ using 1:3 smooth csplines title "cpu time" """,
   203                   """ using 1:2 smooth sbezier title "elapsed time (smooth)" """,
   204                   """ using 1:2 smooth csplines title "elapsed time" """)
   205               val ml_timing_plots =
   206                 List(
   207                   """ using 1:5 smooth sbezier title "ML cpu time (smooth)" """,
   208                   """ using 1:5 smooth csplines title "ML cpu time" """,
   209                   """ using 1:4 smooth sbezier title "ML elapsed time (smooth)" """,
   210                   """ using 1:4 smooth csplines title "ML elapsed time" """)
   211 
   212               session.name ->
   213                 List(gnuplot(timing_plots, "timing"), gnuplot(ml_timing_plots, "ml_timing"))
   214             }
   215           }, sessions).toMap
   216 
   217       File.write(dir + Path.basic("index.html"),
   218         HTML.output_document(
   219           List(HTML.title("Isabelle build status for " + data_name)),
   220           HTML.chapter("Isabelle build status for " + data_name + " (" + data.date + ")") ::
   221           HTML.itemize(
   222             sessions.map(session =>
   223               HTML.link("#session_" + session.name, HTML.text(session.name)) ::
   224               HTML.text(" (" + session.timing.message_resources + ")"))) ::
   225           sessions.flatMap(session =>
   226             List(
   227               HTML.section(session.name) + HTML.id("session_" + session.name),
   228               HTML.par(
   229                 HTML.itemize(List(
   230                   HTML.bold(HTML.text("timing: ")) :: HTML.text(session.timing.message_resources),
   231                   HTML.bold(HTML.text("ML timing: ")) ::
   232                     HTML.text(session.ml_timing.message_resources))) ::
   233                 session_plots.getOrElse(session.name, Nil).map(HTML.image(_)))))))
   234     }
   235 
   236     File.write(target_dir + Path.basic("index.html"),
   237       HTML.output_document(
   238         List(HTML.title("Isabelle build status")),
   239         List(HTML.chapter("Isabelle build status (" + data.date + ")"),
   240           HTML.itemize(data.entries.map({ case (data_name, _) =>
   241             List(HTML.link(clean_name(data_name) + "/index.html", HTML.text(data_name))) })))))
   242   }
   243 
   244 
   245   /* Isabelle tool wrapper */
   246 
   247   val isabelle_tool =
   248     Isabelle_Tool("build_status", "present recent build status information from database", args =>
   249     {
   250       var target_dir = default_target_dir
   251       var only_sessions = Set.empty[String]
   252       var history_length = default_history_length
   253       var options = Options.init()
   254       var image_size = default_image_size
   255       var verbose = false
   256 
   257       val getopts = Getopts("""
   258 Usage: isabelle build_status [OPTIONS]
   259 
   260   Options are:
   261     -D DIR       target directory (default """ + default_target_dir + """)
   262     -S SESSIONS  only given SESSIONS (comma separated)
   263     -l LENGTH    length of history (default """ + default_history_length + """)
   264     -o OPTION    override Isabelle system OPTION (via NAME=VAL or NAME)
   265     -s WxH       size of PNG image (default """ + image_size._1 + "x" + image_size._2 + """)
   266     -v           verbose
   267 
   268   Present performance statistics from build log database, which is specified
   269   via system options build_log_database_host, build_log_database_user etc.
   270 """,
   271         "D:" -> (arg => target_dir = Path.explode(arg)),
   272         "S:" -> (arg => only_sessions = space_explode(',', arg).toSet),
   273         "l:" -> (arg => history_length = Value.Int.parse(arg)),
   274         "o:" -> (arg => options = options + arg),
   275         "s:" -> (arg =>
   276           space_explode('x', arg).map(Value.Int.parse(_)) match {
   277             case List(w, h) if w > 0 && h > 0 => image_size = (w, h)
   278             case _ => error("Error bad PNG image size: " + quote(arg))
   279           }),
   280         "v" -> (_ => verbose = true))
   281 
   282       val more_args = getopts(args)
   283       if (more_args.nonEmpty) getopts.usage()
   284 
   285       val progress = new Console_Progress
   286 
   287       val data =
   288         read_data(options, progress = progress, history_length = history_length,
   289           only_sessions = only_sessions, verbose = verbose)
   290 
   291       present_data(data, progress = progress, target_dir = target_dir, image_size = image_size)
   292 
   293   }, admin = true)
   294 }