src/Pure/Tools/profiling_report.scala
author wenzelm
Fri, 01 Apr 2022 17:06:10 +0200
changeset 75393 87ebf5a50283
parent 74755 510296c0d8d1
child 75394 42267c650205
permissions -rw-r--r--
clarified formatting, for the sake of scala3;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
64342
53fb4a19fb98 regular user tool;
wenzelm
parents: 64311
diff changeset
     1
/*  Title:      Pure/Tools/profiling_report.scala
64311
3d5e7719e878 proper isabelle tool in Scala;
wenzelm
parents:
diff changeset
     2
    Author:     Makarius
3d5e7719e878 proper isabelle tool in Scala;
wenzelm
parents:
diff changeset
     3
73835
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
     4
Report Poly/ML profiling information from session build database.
64311
3d5e7719e878 proper isabelle tool in Scala;
wenzelm
parents:
diff changeset
     5
*/
3d5e7719e878 proper isabelle tool in Scala;
wenzelm
parents:
diff changeset
     6
3d5e7719e878 proper isabelle tool in Scala;
wenzelm
parents:
diff changeset
     7
package isabelle
3d5e7719e878 proper isabelle tool in Scala;
wenzelm
parents:
diff changeset
     8
3d5e7719e878 proper isabelle tool in Scala;
wenzelm
parents:
diff changeset
     9
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74755
diff changeset
    10
object Profiling_Report {
73835
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    11
  def profiling_report(
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    12
    options: Options,
74712
bcca7e3bcd0d proper treatment of session build hierarchy;
wenzelm
parents: 73838
diff changeset
    13
    session: String,
73835
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    14
    theories: List[String] = Nil,
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    15
    clean_name: Boolean = false,
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74755
diff changeset
    16
    progress: Progress = new Progress
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74755
diff changeset
    17
  ): Unit = {
73835
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    18
    val store = Sessions.store(options)
64311
3d5e7719e878 proper isabelle tool in Scala;
wenzelm
parents:
diff changeset
    19
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74755
diff changeset
    20
    using(store.open_database_context())(db_context => {
73835
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    21
      val result =
74712
bcca7e3bcd0d proper treatment of session build hierarchy;
wenzelm
parents: 73838
diff changeset
    22
        db_context.input_database(session)((db, name) => Some(store.read_theories(db, name)))
73835
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    23
      result match {
74712
bcca7e3bcd0d proper treatment of session build hierarchy;
wenzelm
parents: 73838
diff changeset
    24
        case None => error("Missing build database for session " + quote(session))
73835
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    25
        case Some(used_theories) =>
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    26
          theories.filterNot(used_theories.toSet) match {
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    27
            case Nil =>
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    28
            case bad => error("Unknown theories " + commas_quote(bad))
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    29
          }
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    30
          val reports =
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    31
            (for {
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    32
              thy <- used_theories.iterator
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    33
              if theories.isEmpty || theories.contains(thy)
74755
510296c0d8d1 clarified signature: avoid potential misunderstanding of Resources.empty as proper Resources;
wenzelm
parents: 74712
diff changeset
    34
              command <- Build_Job.read_theory(db_context, List(session), thy).iterator
73835
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    35
              snapshot = Document.State.init.snippet(command)
73838
0e6a5a6cc767 prefer less intrusive tracing message;
wenzelm
parents: 73835
diff changeset
    36
              (Protocol.ML_Profiling(report), _) <- snapshot.messages.iterator
73835
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    37
            } yield if (clean_name) report.clean_name else report).toList
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    38
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    39
          for (report <- ML_Profiling.account(reports)) progress.echo(report.print)
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    40
      }
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    41
    })
64311
3d5e7719e878 proper isabelle tool in Scala;
wenzelm
parents:
diff changeset
    42
  }
3d5e7719e878 proper isabelle tool in Scala;
wenzelm
parents:
diff changeset
    43
3d5e7719e878 proper isabelle tool in Scala;
wenzelm
parents:
diff changeset
    44
3d5e7719e878 proper isabelle tool in Scala;
wenzelm
parents:
diff changeset
    45
  /* Isabelle tool wrapper */
3d5e7719e878 proper isabelle tool in Scala;
wenzelm
parents:
diff changeset
    46
3d5e7719e878 proper isabelle tool in Scala;
wenzelm
parents:
diff changeset
    47
  val isabelle_tool =
72763
3cc73d00553c added document antiquotation @{tool};
wenzelm
parents: 71686
diff changeset
    48
    Isabelle_Tool("profiling_report", "report Poly/ML profiling information from log files",
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74755
diff changeset
    49
      Scala_Project.here,
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74755
diff changeset
    50
      args => {
73835
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    51
      var theories: List[String] = Nil
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    52
      var clean_name = false
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    53
      var options = Options.init()
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    54
71686
eb44cf7ae926 tuned -- Command_Line.tool is already part of Isabelle_Tool;
wenzelm
parents: 71632
diff changeset
    55
      val getopts =
eb44cf7ae926 tuned -- Command_Line.tool is already part of Isabelle_Tool;
wenzelm
parents: 71632
diff changeset
    56
        Getopts("""
73835
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    57
Usage: isabelle profiling_report [OPTIONS] SESSION
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    58
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    59
  Options are:
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    60
    -T NAME      restrict to given theories (multiple options possible)
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    61
    -c           clean function names
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    62
    -o OPTION    override Isabelle system OPTION (via NAME=VAL or NAME)
64311
3d5e7719e878 proper isabelle tool in Scala;
wenzelm
parents:
diff changeset
    63
73835
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    64
  Report Poly/ML profiling from the build database of the given session
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    65
  (without up-to-date check of sources).
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    66
""",
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    67
          "T:" -> (arg => theories = theories ::: List(arg)),
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    68
          "c" -> (_ => clean_name = true),
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    69
          "o:" -> (arg => options = options + arg))
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    70
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    71
      val more_args = getopts(args)
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    72
      val session_name =
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    73
        more_args match {
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    74
          case List(session_name) => session_name
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    75
          case _ => getopts.usage()
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    76
        }
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    77
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    78
      val progress = new Console_Progress()
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    79
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    80
      profiling_report(options, session_name, theories = theories,
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    81
        clean_name = clean_name, progress = progress)
64311
3d5e7719e878 proper isabelle tool in Scala;
wenzelm
parents:
diff changeset
    82
    })
3d5e7719e878 proper isabelle tool in Scala;
wenzelm
parents:
diff changeset
    83
}