src/Pure/Tools/profiling_report.scala
author wenzelm
Tue, 02 Aug 2022 19:25:37 +0200
changeset 75738 9cc5ee625adb
parent 75737 288c4d4042cc
child 75778 d18c96b9b955
permissions -rw-r--r--
tuned signature;
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
75394
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
    20
    using(store.open_database_context()) { db_context =>
75738
9cc5ee625adb tuned signature;
wenzelm
parents: 75737
diff changeset
    21
      val result = db_context.database(session)(db => Some(store.read_theories(db, session)))
73835
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    22
      result match {
74712
bcca7e3bcd0d proper treatment of session build hierarchy;
wenzelm
parents: 73838
diff changeset
    23
        case None => error("Missing build database for session " + quote(session))
73835
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    24
        case Some(used_theories) =>
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    25
          theories.filterNot(used_theories.toSet) match {
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    26
            case Nil =>
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    27
            case bad => error("Unknown theories " + commas_quote(bad))
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    28
          }
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    29
          val reports =
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    30
            (for {
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    31
              thy <- used_theories.iterator
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    32
              if theories.isEmpty || theories.contains(thy)
74755
510296c0d8d1 clarified signature: avoid potential misunderstanding of Resources.empty as proper Resources;
wenzelm
parents: 74712
diff changeset
    33
              command <- Build_Job.read_theory(db_context, List(session), thy).iterator
73835
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    34
              snapshot = Document.State.init.snippet(command)
73838
0e6a5a6cc767 prefer less intrusive tracing message;
wenzelm
parents: 73835
diff changeset
    35
              (Protocol.ML_Profiling(report), _) <- snapshot.messages.iterator
73835
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    36
            } yield if (clean_name) report.clean_name else report).toList
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    37
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    38
          for (report <- ML_Profiling.account(reports)) progress.echo(report.print)
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    39
      }
75394
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
    40
    }
64311
3d5e7719e878 proper isabelle tool in Scala;
wenzelm
parents:
diff changeset
    41
  }
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
  /* Isabelle tool wrapper */
3d5e7719e878 proper isabelle tool in Scala;
wenzelm
parents:
diff changeset
    45
3d5e7719e878 proper isabelle tool in Scala;
wenzelm
parents:
diff changeset
    46
  val isabelle_tool =
72763
3cc73d00553c added document antiquotation @{tool};
wenzelm
parents: 71686
diff changeset
    47
    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
    48
      Scala_Project.here,
75394
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
    49
      { args =>
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
    50
        var theories: List[String] = Nil
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
    51
        var clean_name = false
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
    52
        var options = Options.init()
73835
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    53
75394
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
    54
        val getopts = Getopts("""
73835
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    55
Usage: isabelle profiling_report [OPTIONS] SESSION
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    56
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    57
  Options are:
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    58
    -T NAME      restrict to given theories (multiple options possible)
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    59
    -c           clean function names
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    60
    -o OPTION    override Isabelle system OPTION (via NAME=VAL or NAME)
64311
3d5e7719e878 proper isabelle tool in Scala;
wenzelm
parents:
diff changeset
    61
73835
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    62
  Report Poly/ML profiling from the build database of the given session
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    63
  (without up-to-date check of sources).
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    64
""",
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    65
          "T:" -> (arg => theories = theories ::: List(arg)),
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    66
          "c" -> (_ => clean_name = true),
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    67
          "o:" -> (arg => options = options + arg))
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    68
75394
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
    69
        val more_args = getopts(args)
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
    70
        val session_name =
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
    71
          more_args match {
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
    72
            case List(session_name) => session_name
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
    73
            case _ => getopts.usage()
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
    74
          }
73835
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    75
75394
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
    76
        val progress = new Console_Progress()
73835
5dae03d50db1 more formal ML profiling messages;
wenzelm
parents: 72763
diff changeset
    77
75394
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
    78
        profiling_report(options, session_name, theories = theories,
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
    79
          clean_name = clean_name, progress = progress)
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
    80
      })
64311
3d5e7719e878 proper isabelle tool in Scala;
wenzelm
parents:
diff changeset
    81
}