src/Pure/Tools/build.scala
author wenzelm
Thu, 31 Jan 2019 21:33:24 +0100
changeset 69777 1df241e340c8
parent 69744 bb0a354f6b46
child 69811 18f61ce86425
permissions -rw-r--r--
removed left-over test material (amending bb0a354f6b46);
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
50686
d703e3aafa8c moved files;
wenzelm
parents: 50566
diff changeset
     1
/*  Title:      Pure/Tools/build.scala
48276
4bd480886813 basic setup for Isabelle build tool;
wenzelm
parents:
diff changeset
     2
    Author:     Makarius
57923
cdae2467311d tuned comments;
wenzelm
parents: 56890
diff changeset
     3
    Options:    :folding=explicit:
48276
4bd480886813 basic setup for Isabelle build tool;
wenzelm
parents:
diff changeset
     4
4bd480886813 basic setup for Isabelle build tool;
wenzelm
parents:
diff changeset
     5
Build and manage Isabelle sessions.
4bd480886813 basic setup for Isabelle build tool;
wenzelm
parents:
diff changeset
     6
*/
4bd480886813 basic setup for Isabelle build tool;
wenzelm
parents:
diff changeset
     7
4bd480886813 basic setup for Isabelle build tool;
wenzelm
parents:
diff changeset
     8
package isabelle
4bd480886813 basic setup for Isabelle build tool;
wenzelm
parents:
diff changeset
     9
4bd480886813 basic setup for Isabelle build tool;
wenzelm
parents:
diff changeset
    10
48676
3ef82491cdd6 clarified Session_Tree (with proper integrity check) vs. Queue (with provision for alternative ordering);
wenzelm
parents: 48675
diff changeset
    11
import scala.collection.SortedSet
48340
6f4fc030882a allow explicit specification of additional session directories;
wenzelm
parents: 48339
diff changeset
    12
import scala.annotation.tailrec
48337
9c7f8e5805b4 cumulate semantic Session_Info, based on syntactic Session_Entry;
wenzelm
parents: 48336
diff changeset
    13
48335
2f923e994056 more informative errors;
wenzelm
parents: 48334
diff changeset
    14
48276
4bd480886813 basic setup for Isabelle build tool;
wenzelm
parents:
diff changeset
    15
object Build
4bd480886813 basic setup for Isabelle build tool;
wenzelm
parents:
diff changeset
    16
{
62631
c39614ddb80b clarified modules;
wenzelm
parents: 62630
diff changeset
    17
  /** auxiliary **/
48424
wenzelm
parents: 48423
diff changeset
    18
65291
57c85c83c11b maintain persistent session info in SQLite database instead of log file;
wenzelm
parents: 65289
diff changeset
    19
  /* persistent build info */
57c85c83c11b maintain persistent session info in SQLite database instead of log file;
wenzelm
parents: 65289
diff changeset
    20
57c85c83c11b maintain persistent session info in SQLite database instead of log file;
wenzelm
parents: 65289
diff changeset
    21
  sealed case class Session_Info(
66749
0445cfaf6132 more compact (second-order) digest for 10^2..10^3 source files, with slightly increased risk of collisions;
wenzelm
parents: 66747
diff changeset
    22
    sources: String,
65291
57c85c83c11b maintain persistent session info in SQLite database instead of log file;
wenzelm
parents: 65289
diff changeset
    23
    input_heaps: List[String],
57c85c83c11b maintain persistent session info in SQLite database instead of log file;
wenzelm
parents: 65289
diff changeset
    24
    output_heap: Option[String],
57c85c83c11b maintain persistent session info in SQLite database instead of log file;
wenzelm
parents: 65289
diff changeset
    25
    return_code: Int)
66747
wenzelm
parents: 66746
diff changeset
    26
  {
wenzelm
parents: 66746
diff changeset
    27
    def ok: Boolean = return_code == 0
wenzelm
parents: 66746
diff changeset
    28
  }
65291
57c85c83c11b maintain persistent session info in SQLite database instead of log file;
wenzelm
parents: 65289
diff changeset
    29
57c85c83c11b maintain persistent session info in SQLite database instead of log file;
wenzelm
parents: 65289
diff changeset
    30
65289
86d93effc3df tuned signature;
wenzelm
parents: 65284
diff changeset
    31
  /* queue with scheduling information */
48676
3ef82491cdd6 clarified Session_Tree (with proper integrity check) vs. Queue (with provision for alternative ordering);
wenzelm
parents: 48675
diff changeset
    32
62631
c39614ddb80b clarified modules;
wenzelm
parents: 62630
diff changeset
    33
  private object Queue
48676
3ef82491cdd6 clarified Session_Tree (with proper integrity check) vs. Queue (with provision for alternative ordering);
wenzelm
parents: 48675
diff changeset
    34
  {
68086
9e1c670301b8 cleanup session output before starting build job;
wenzelm
parents: 67852
diff changeset
    35
    type Timings = (List[Properties.T], Double)
9e1c670301b8 cleanup session output before starting build job;
wenzelm
parents: 67852
diff changeset
    36
9e1c670301b8 cleanup session output before starting build job;
wenzelm
parents: 67852
diff changeset
    37
    def load_timings(progress: Progress, store: Sessions.Store, name: String): Timings =
65289
86d93effc3df tuned signature;
wenzelm
parents: 65284
diff changeset
    38
    {
68086
9e1c670301b8 cleanup session output before starting build job;
wenzelm
parents: 67852
diff changeset
    39
      val no_timings: Timings = (Nil, 0.0)
65289
86d93effc3df tuned signature;
wenzelm
parents: 65284
diff changeset
    40
68221
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
    41
      store.access_database(name) match {
65291
57c85c83c11b maintain persistent session info in SQLite database instead of log file;
wenzelm
parents: 65289
diff changeset
    42
        case None => no_timings
68214
b0e2a19df95b more abstract database access;
wenzelm
parents: 68213
diff changeset
    43
        case Some(db) =>
65291
57c85c83c11b maintain persistent session info in SQLite database instead of log file;
wenzelm
parents: 65289
diff changeset
    44
          def ignore_error(msg: String) =
57c85c83c11b maintain persistent session info in SQLite database instead of log file;
wenzelm
parents: 65289
diff changeset
    45
          {
68214
b0e2a19df95b more abstract database access;
wenzelm
parents: 68213
diff changeset
    46
            progress.echo_warning("Ignoring bad database " + db + (if (msg == "") "" else "\n" + msg))
65291
57c85c83c11b maintain persistent session info in SQLite database instead of log file;
wenzelm
parents: 65289
diff changeset
    47
            no_timings
57c85c83c11b maintain persistent session info in SQLite database instead of log file;
wenzelm
parents: 65289
diff changeset
    48
          }
57c85c83c11b maintain persistent session info in SQLite database instead of log file;
wenzelm
parents: 65289
diff changeset
    49
          try {
68214
b0e2a19df95b more abstract database access;
wenzelm
parents: 68213
diff changeset
    50
            val command_timings = store.read_command_timings(db, name)
b0e2a19df95b more abstract database access;
wenzelm
parents: 68213
diff changeset
    51
            val session_timing =
b0e2a19df95b more abstract database access;
wenzelm
parents: 68213
diff changeset
    52
              store.read_session_timing(db, name) match {
b0e2a19df95b more abstract database access;
wenzelm
parents: 68213
diff changeset
    53
                case Markup.Elapsed(t) => t
b0e2a19df95b more abstract database access;
wenzelm
parents: 68213
diff changeset
    54
                case _ => 0.0
b0e2a19df95b more abstract database access;
wenzelm
parents: 68213
diff changeset
    55
              }
b0e2a19df95b more abstract database access;
wenzelm
parents: 68213
diff changeset
    56
            (command_timings, session_timing)
65291
57c85c83c11b maintain persistent session info in SQLite database instead of log file;
wenzelm
parents: 65289
diff changeset
    57
          }
57c85c83c11b maintain persistent session info in SQLite database instead of log file;
wenzelm
parents: 65289
diff changeset
    58
          catch {
57c85c83c11b maintain persistent session info in SQLite database instead of log file;
wenzelm
parents: 65289
diff changeset
    59
            case ERROR(msg) => ignore_error(msg)
57c85c83c11b maintain persistent session info in SQLite database instead of log file;
wenzelm
parents: 65289
diff changeset
    60
            case exn: java.lang.Error => ignore_error(Exn.message(exn))
57c85c83c11b maintain persistent session info in SQLite database instead of log file;
wenzelm
parents: 65289
diff changeset
    61
            case _: XML.Error => ignore_error("")
57c85c83c11b maintain persistent session info in SQLite database instead of log file;
wenzelm
parents: 65289
diff changeset
    62
          }
68214
b0e2a19df95b more abstract database access;
wenzelm
parents: 68213
diff changeset
    63
          finally { db.close }
65289
86d93effc3df tuned signature;
wenzelm
parents: 65284
diff changeset
    64
      }
86d93effc3df tuned signature;
wenzelm
parents: 65284
diff changeset
    65
    }
86d93effc3df tuned signature;
wenzelm
parents: 65284
diff changeset
    66
68731
c2dcb7f7a3ef tuned signature;
wenzelm
parents: 68487
diff changeset
    67
    def make_session_timing(sessions_structure: Sessions.Structure, timing: Map[String, Double])
68486
6984a55f3cba clarified queue ordering: take session descendants into account, notably for "slow" AFP sessions;
wenzelm
parents: 68331
diff changeset
    68
      : Map[String, Double] =
6984a55f3cba clarified queue ordering: take session descendants into account, notably for "slow" AFP sessions;
wenzelm
parents: 68331
diff changeset
    69
    {
68731
c2dcb7f7a3ef tuned signature;
wenzelm
parents: 68487
diff changeset
    70
      val maximals = sessions_structure.build_graph.maximals.toSet
68486
6984a55f3cba clarified queue ordering: take session descendants into account, notably for "slow" AFP sessions;
wenzelm
parents: 68331
diff changeset
    71
      def desc_timing(name: String): Double =
6984a55f3cba clarified queue ordering: take session descendants into account, notably for "slow" AFP sessions;
wenzelm
parents: 68331
diff changeset
    72
      {
68487
wenzelm
parents: 68486
diff changeset
    73
        if (maximals.contains(name)) timing(name)
wenzelm
parents: 68486
diff changeset
    74
        else {
68731
c2dcb7f7a3ef tuned signature;
wenzelm
parents: 68487
diff changeset
    75
          val descendants = sessions_structure.build_descendants(List(name)).toSet
c2dcb7f7a3ef tuned signature;
wenzelm
parents: 68487
diff changeset
    76
          val g = sessions_structure.build_graph.restrict(descendants)
68487
wenzelm
parents: 68486
diff changeset
    77
          (0.0 :: g.maximals.flatMap(desc => {
wenzelm
parents: 68486
diff changeset
    78
            val ps = g.all_preds(List(desc))
wenzelm
parents: 68486
diff changeset
    79
            if (ps.exists(p => timing.get(p).isEmpty)) None
wenzelm
parents: 68486
diff changeset
    80
            else Some(ps.map(timing(_)).sum)
wenzelm
parents: 68486
diff changeset
    81
          })).max
wenzelm
parents: 68486
diff changeset
    82
        }
68486
6984a55f3cba clarified queue ordering: take session descendants into account, notably for "slow" AFP sessions;
wenzelm
parents: 68331
diff changeset
    83
      }
6984a55f3cba clarified queue ordering: take session descendants into account, notably for "slow" AFP sessions;
wenzelm
parents: 68331
diff changeset
    84
      timing.keySet.iterator.map(name => (name -> desc_timing(name))).toMap.withDefaultValue(0.0)
6984a55f3cba clarified queue ordering: take session descendants into account, notably for "slow" AFP sessions;
wenzelm
parents: 68331
diff changeset
    85
    }
6984a55f3cba clarified queue ordering: take session descendants into account, notably for "slow" AFP sessions;
wenzelm
parents: 68331
diff changeset
    86
68731
c2dcb7f7a3ef tuned signature;
wenzelm
parents: 68487
diff changeset
    87
    def apply(progress: Progress, sessions_structure: Sessions.Structure, store: Sessions.Store)
c2dcb7f7a3ef tuned signature;
wenzelm
parents: 68487
diff changeset
    88
      : Queue =
48676
3ef82491cdd6 clarified Session_Tree (with proper integrity check) vs. Queue (with provision for alternative ordering);
wenzelm
parents: 48675
diff changeset
    89
    {
68731
c2dcb7f7a3ef tuned signature;
wenzelm
parents: 68487
diff changeset
    90
      val graph = sessions_structure.build_graph
65415
8cd54b18b68b clarified signature: tree structure is not essential;
wenzelm
parents: 65406
diff changeset
    91
      val names = graph.keys
51220
e140c8fa485a recover timing information from old log files;
wenzelm
parents: 51218
diff changeset
    92
65831
3b197547c1d4 prefer explicit progress channel;
wenzelm
parents: 65828
diff changeset
    93
      val timings = names.map(name => (name, load_timings(progress, store, name)))
51220
e140c8fa485a recover timing information from old log files;
wenzelm
parents: 51218
diff changeset
    94
      val command_timings =
68486
6984a55f3cba clarified queue ordering: take session descendants into account, notably for "slow" AFP sessions;
wenzelm
parents: 68331
diff changeset
    95
        timings.map({ case (name, (ts, _)) => (name, ts) }).toMap.withDefaultValue(Nil)
51220
e140c8fa485a recover timing information from old log files;
wenzelm
parents: 51218
diff changeset
    96
      val session_timing =
68731
c2dcb7f7a3ef tuned signature;
wenzelm
parents: 68487
diff changeset
    97
        make_session_timing(sessions_structure,
c2dcb7f7a3ef tuned signature;
wenzelm
parents: 68487
diff changeset
    98
          timings.map({ case (name, (_, t)) => (name, t) }).toMap)
48678
ff27af15530c queue ordering by descending outdegree and timeout;
wenzelm
parents: 48676
diff changeset
    99
ff27af15530c queue ordering by descending outdegree and timeout;
wenzelm
parents: 48676
diff changeset
   100
      object Ordering extends scala.math.Ordering[String]
ff27af15530c queue ordering by descending outdegree and timeout;
wenzelm
parents: 48676
diff changeset
   101
      {
51227
88c96e836ed6 prefer comparison of session timing, if this is known already;
wenzelm
parents: 51223
diff changeset
   102
        def compare_timing(name1: String, name2: String): Int =
88c96e836ed6 prefer comparison of session timing, if this is known already;
wenzelm
parents: 51223
diff changeset
   103
        {
88c96e836ed6 prefer comparison of session timing, if this is known already;
wenzelm
parents: 51223
diff changeset
   104
          val t1 = session_timing(name1)
88c96e836ed6 prefer comparison of session timing, if this is known already;
wenzelm
parents: 51223
diff changeset
   105
          val t2 = session_timing(name2)
88c96e836ed6 prefer comparison of session timing, if this is known already;
wenzelm
parents: 51223
diff changeset
   106
          if (t1 == 0.0 || t2 == 0.0) 0
88c96e836ed6 prefer comparison of session timing, if this is known already;
wenzelm
parents: 51223
diff changeset
   107
          else t1 compare t2
88c96e836ed6 prefer comparison of session timing, if this is known already;
wenzelm
parents: 51223
diff changeset
   108
        }
88c96e836ed6 prefer comparison of session timing, if this is known already;
wenzelm
parents: 51223
diff changeset
   109
48678
ff27af15530c queue ordering by descending outdegree and timeout;
wenzelm
parents: 48676
diff changeset
   110
        def compare(name1: String, name2: String): Int =
68486
6984a55f3cba clarified queue ordering: take session descendants into account, notably for "slow" AFP sessions;
wenzelm
parents: 68331
diff changeset
   111
          compare_timing(name2, name1) match {
48678
ff27af15530c queue ordering by descending outdegree and timeout;
wenzelm
parents: 48676
diff changeset
   112
            case 0 =>
68731
c2dcb7f7a3ef tuned signature;
wenzelm
parents: 68487
diff changeset
   113
              sessions_structure(name2).timeout compare sessions_structure(name1).timeout match {
68486
6984a55f3cba clarified queue ordering: take session descendants into account, notably for "slow" AFP sessions;
wenzelm
parents: 68331
diff changeset
   114
                case 0 => name1 compare name2
48678
ff27af15530c queue ordering by descending outdegree and timeout;
wenzelm
parents: 48676
diff changeset
   115
                case ord => ord
ff27af15530c queue ordering by descending outdegree and timeout;
wenzelm
parents: 48676
diff changeset
   116
              }
ff27af15530c queue ordering by descending outdegree and timeout;
wenzelm
parents: 48676
diff changeset
   117
            case ord => ord
ff27af15530c queue ordering by descending outdegree and timeout;
wenzelm
parents: 48676
diff changeset
   118
          }
ff27af15530c queue ordering by descending outdegree and timeout;
wenzelm
parents: 48676
diff changeset
   119
      }
ff27af15530c queue ordering by descending outdegree and timeout;
wenzelm
parents: 48676
diff changeset
   120
65415
8cd54b18b68b clarified signature: tree structure is not essential;
wenzelm
parents: 65406
diff changeset
   121
      new Queue(graph, SortedSet(names: _*)(Ordering), command_timings)
48676
3ef82491cdd6 clarified Session_Tree (with proper integrity check) vs. Queue (with provision for alternative ordering);
wenzelm
parents: 48675
diff changeset
   122
    }
3ef82491cdd6 clarified Session_Tree (with proper integrity check) vs. Queue (with provision for alternative ordering);
wenzelm
parents: 48675
diff changeset
   123
  }
3ef82491cdd6 clarified Session_Tree (with proper integrity check) vs. Queue (with provision for alternative ordering);
wenzelm
parents: 48675
diff changeset
   124
65314
wenzelm
parents: 65313
diff changeset
   125
  private class Queue(
62631
c39614ddb80b clarified modules;
wenzelm
parents: 62630
diff changeset
   126
    graph: Graph[String, Sessions.Info],
51220
e140c8fa485a recover timing information from old log files;
wenzelm
parents: 51218
diff changeset
   127
    order: SortedSet[String],
e140c8fa485a recover timing information from old log files;
wenzelm
parents: 51218
diff changeset
   128
    val command_timings: String => List[Properties.T])
48676
3ef82491cdd6 clarified Session_Tree (with proper integrity check) vs. Queue (with provision for alternative ordering);
wenzelm
parents: 48675
diff changeset
   129
  {
3ef82491cdd6 clarified Session_Tree (with proper integrity check) vs. Queue (with provision for alternative ordering);
wenzelm
parents: 48675
diff changeset
   130
    def is_inner(name: String): Boolean = !graph.is_maximal(name)
3ef82491cdd6 clarified Session_Tree (with proper integrity check) vs. Queue (with provision for alternative ordering);
wenzelm
parents: 48675
diff changeset
   131
3ef82491cdd6 clarified Session_Tree (with proper integrity check) vs. Queue (with provision for alternative ordering);
wenzelm
parents: 48675
diff changeset
   132
    def is_empty: Boolean = graph.is_empty
3ef82491cdd6 clarified Session_Tree (with proper integrity check) vs. Queue (with provision for alternative ordering);
wenzelm
parents: 48675
diff changeset
   133
51227
88c96e836ed6 prefer comparison of session timing, if this is known already;
wenzelm
parents: 51223
diff changeset
   134
    def - (name: String): Queue =
88c96e836ed6 prefer comparison of session timing, if this is known already;
wenzelm
parents: 51223
diff changeset
   135
      new Queue(graph.del_node(name),
67011
bab3208d8d37 updated comments;
wenzelm
parents: 66972
diff changeset
   136
        order - name,  // FIXME scala-2.10.0 .. 2.12.4 TreeSet problem!?
51227
88c96e836ed6 prefer comparison of session timing, if this is known already;
wenzelm
parents: 51223
diff changeset
   137
        command_timings)
48676
3ef82491cdd6 clarified Session_Tree (with proper integrity check) vs. Queue (with provision for alternative ordering);
wenzelm
parents: 48675
diff changeset
   138
62631
c39614ddb80b clarified modules;
wenzelm
parents: 62630
diff changeset
   139
    def dequeue(skip: String => Boolean): Option[(String, Sessions.Info)] =
48676
3ef82491cdd6 clarified Session_Tree (with proper integrity check) vs. Queue (with provision for alternative ordering);
wenzelm
parents: 48675
diff changeset
   140
    {
51227
88c96e836ed6 prefer comparison of session timing, if this is known already;
wenzelm
parents: 51223
diff changeset
   141
      val it = order.iterator.dropWhile(name =>
88c96e836ed6 prefer comparison of session timing, if this is known already;
wenzelm
parents: 51223
diff changeset
   142
        skip(name)
67011
bab3208d8d37 updated comments;
wenzelm
parents: 66972
diff changeset
   143
          || !graph.defined(name)  // FIXME scala-2.10.0 .. 2.12.4 TreeSet problem!?
51227
88c96e836ed6 prefer comparison of session timing, if this is known already;
wenzelm
parents: 51223
diff changeset
   144
          || !graph.is_minimal(name))
48680
463daacae6c2 simplified Session_Tree;
wenzelm
parents: 48678
diff changeset
   145
      if (it.hasNext) { val name = it.next; Some((name, graph.get_node(name))) }
48676
3ef82491cdd6 clarified Session_Tree (with proper integrity check) vs. Queue (with provision for alternative ordering);
wenzelm
parents: 48675
diff changeset
   146
      else None
3ef82491cdd6 clarified Session_Tree (with proper integrity check) vs. Queue (with provision for alternative ordering);
wenzelm
parents: 48675
diff changeset
   147
    }
3ef82491cdd6 clarified Session_Tree (with proper integrity check) vs. Queue (with provision for alternative ordering);
wenzelm
parents: 48675
diff changeset
   148
  }
3ef82491cdd6 clarified Session_Tree (with proper integrity check) vs. Queue (with provision for alternative ordering);
wenzelm
parents: 48675
diff changeset
   149
3ef82491cdd6 clarified Session_Tree (with proper integrity check) vs. Queue (with provision for alternative ordering);
wenzelm
parents: 48675
diff changeset
   150
65313
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   151
  /* PIDE protocol handler */
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   152
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   153
  class Handler(progress: Progress, session: Session, session_name: String)
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   154
    extends Session.Protocol_Handler
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   155
  {
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   156
    val result_error: Promise[String] = Future.promise
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   157
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   158
    override def exit() { result_error.cancel }
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   159
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   160
    private def build_session_finished(msg: Prover.Protocol_Output): Boolean =
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   161
    {
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   162
      val error_message =
65344
b99283eed13c clarified YXML vs. symbol encoding: operate on whole message;
wenzelm
parents: 65320
diff changeset
   163
        try { Pretty.string_of(Symbol.decode_yxml(msg.text)) }
65313
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   164
        catch { case ERROR(msg) => msg }
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   165
      result_error.fulfill(error_message)
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   166
      session.send_stop()
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   167
      true
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   168
    }
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   169
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   170
    private def loading_theory(msg: Prover.Protocol_Output): Boolean =
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   171
      msg.properties match {
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   172
        case Markup.Loading_Theory(name) =>
68957
eef4e983fd9d clarified theory progress;
wenzelm
parents: 68953
diff changeset
   173
          progress.theory(Progress.Theory(name, session = session_name))
65313
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   174
          true
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   175
        case _ => false
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   176
      }
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   177
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   178
    val functions =
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   179
      List(
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   180
        Markup.BUILD_SESSION_FINISHED -> build_session_finished _,
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   181
        Markup.LOADING_THEORY -> loading_theory _)
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   182
  }
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   183
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   184
65308
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   185
  /* job: running prover process */
48341
752de4e10162 tuned source structure;
wenzelm
parents: 48340
diff changeset
   186
65308
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   187
  private class Job(progress: Progress,
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   188
    name: String,
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   189
    val info: Sessions.Info,
65313
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   190
    deps: Sessions.Deps,
65308
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   191
    store: Sessions.Store,
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   192
    do_output: Boolean,
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   193
    verbose: Boolean,
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   194
    pide: Boolean,
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   195
    val numa_node: Option[Int],
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   196
    command_timings: List[Properties.T])
48418
1a634f9614fb some actual build function on ML side;
wenzelm
parents: 48411
diff changeset
   197
  {
68953
89a12af9c330 tuned signature;
wenzelm
parents: 68928
diff changeset
   198
    val options = NUMA.policy_options(info.options, numa_node)
65312
34d56ca5b548 more uniform options;
wenzelm
parents: 65308
diff changeset
   199
59445
2c27c3d1fd3b provide session_graph.pdf via Isabelle/Scala;
wenzelm
parents: 59444
diff changeset
   200
    private val graph_file = Isabelle_System.tmp_file("session_graph", "pdf")
66822
4642cf4a7ebb tuned signature;
wenzelm
parents: 66782
diff changeset
   201
    isabelle.graphview.Graph_File.write(options, graph_file, deps(name).session_graph_display)
59445
2c27c3d1fd3b provide session_graph.pdf via Isabelle/Scala;
wenzelm
parents: 59444
diff changeset
   202
68198
6710167e17af avoid race condition wrt. ISABELLE_TMP, which is removed in Bash.cleanup() before Bash.result(progress_stdout);
wenzelm
parents: 68148
diff changeset
   203
    private val export_tmp_dir = Isabelle_System.tmp_dir("export")
68289
c29fc61fb1b1 clarified cache;
wenzelm
parents: 68221
diff changeset
   204
    private val export_consumer =
c29fc61fb1b1 clarified cache;
wenzelm
parents: 68221
diff changeset
   205
      Export.consumer(store.open_database(name, output = true), cache = store.xz_cache)
68092
888d35a19866 store exports in session database, with asynchronous / parallel compression;
wenzelm
parents: 68088
diff changeset
   206
62573
27f90319a499 isabelle.Build uses ML_Process directly;
wenzelm
parents: 62572
diff changeset
   207
    private val future_result: Future[Process_Result] =
61559
313eca3fa847 more direct task future implementation, with proper cancel operation;
wenzelm
parents: 61556
diff changeset
   208
      Future.thread("build") {
65308
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   209
        val parent = info.parent.getOrElse("")
65441
9425e4d8bdb6 more session_base information in ML;
wenzelm
parents: 65432
diff changeset
   210
        val base = deps(name)
65308
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   211
        val args_yxml =
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   212
          YXML.string_of_body(
62944
3ee643c5ed00 more standard session build process, including browser_info;
wenzelm
parents: 62902
diff changeset
   213
            {
3ee643c5ed00 more standard session build process, including browser_info;
wenzelm
parents: 62902
diff changeset
   214
              import XML.Encode._
3ee643c5ed00 more standard session build process, including browser_info;
wenzelm
parents: 62902
diff changeset
   215
              pair(list(pair(string, int)), pair(list(properties), pair(bool, pair(bool,
3ee643c5ed00 more standard session build process, including browser_info;
wenzelm
parents: 62902
diff changeset
   216
                pair(Path.encode, pair(list(pair(Path.encode, Path.encode)), pair(string,
65307
c1ba192b4f96 more explicit build_session args;
wenzelm
parents: 65296
diff changeset
   217
                pair(string, pair(string, pair(string, pair(Path.encode,
65517
1544e61e5314 more position information;
wenzelm
parents: 65506
diff changeset
   218
                pair(list(pair(Options.encode, list(pair(string, properties)))),
67493
c4e9e0c50487 treat sessions as entities with defining position;
wenzelm
parents: 67471
diff changeset
   219
                pair(list(pair(string, properties)), pair(list(string),
c4e9e0c50487 treat sessions as entities with defining position;
wenzelm
parents: 67471
diff changeset
   220
                pair(list(pair(string, string)),
67471
bddfa23a4ea9 formal treatment of documentation names;
wenzelm
parents: 67380
diff changeset
   221
                pair(list(string), pair(list(pair(string, string)), list(string))))))))))))))))))(
62944
3ee643c5ed00 more standard session build process, including browser_info;
wenzelm
parents: 62902
diff changeset
   222
              (Symbol.codes, (command_timings, (do_output, (verbose,
3ee643c5ed00 more standard session build process, including browser_info;
wenzelm
parents: 62902
diff changeset
   223
                (store.browser_info, (info.document_files, (File.standard_path(graph_file),
65307
c1ba192b4f96 more explicit build_session args;
wenzelm
parents: 65296
diff changeset
   224
                (parent, (info.chapter, (name, (Path.current,
67471
bddfa23a4ea9 formal treatment of documentation names;
wenzelm
parents: 67380
diff changeset
   225
                (info.theories, (base.known.sessions.toList, (base.doc_names,
bddfa23a4ea9 formal treatment of documentation names;
wenzelm
parents: 67380
diff changeset
   226
                (base.global_theories.toList, (base.loaded_theories.keys, (base.dest_known_theories,
bddfa23a4ea9 formal treatment of documentation names;
wenzelm
parents: 67380
diff changeset
   227
                info.bibtex_entries.map(_.info)))))))))))))))))))
65308
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   228
            })
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   229
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   230
        val env =
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   231
          Isabelle_System.settings() +
68198
6710167e17af avoid race condition wrt. ISABELLE_TMP, which is removed in Bash.cleanup() before Bash.result(progress_stdout);
wenzelm
parents: 68148
diff changeset
   232
            ("ISABELLE_EXPORT_TMP" -> File.standard_path(export_tmp_dir)) +
65312
34d56ca5b548 more uniform options;
wenzelm
parents: 65308
diff changeset
   233
            ("ISABELLE_ML_DEBUGGER" -> options.bool("ML_debugger").toString)
65308
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   234
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   235
        def save_heap: String =
69777
1df241e340c8 removed left-over test material (amending bb0a354f6b46);
wenzelm
parents: 69744
diff changeset
   236
          (if (info.theories.isEmpty) "" else "ML_Heap.share_common_data (); ") +
68217
3e90b88b0fc2 clarified handling of output heap;
wenzelm
parents: 68216
diff changeset
   237
            "ML_Heap.save_child " +
3e90b88b0fc2 clarified handling of output heap;
wenzelm
parents: 68216
diff changeset
   238
            ML_Syntax.print_string_bytes(File.platform_path(store.output_heap(name)))
62944
3ee643c5ed00 more standard session build process, including browser_info;
wenzelm
parents: 62902
diff changeset
   239
65360
wenzelm
parents: 65359
diff changeset
   240
        if (pide && !Sessions.is_pure(name)) {
65532
febfd9f78bd4 eliminated default_qualifier: just a constant;
wenzelm
parents: 65520
diff changeset
   241
          val resources = new Resources(deps(parent))
65313
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   242
          val session = new Session(options, resources)
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   243
          val handler = new Handler(progress, session, name)
65315
c7097ccbffb7 clarified signature;
wenzelm
parents: 65314
diff changeset
   244
          session.init_protocol_handler(handler)
65313
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   245
65317
b9f5cd845616 more informative session result;
wenzelm
parents: 65315
diff changeset
   246
          val session_result = Future.promise[Process_Result]
65313
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   247
68204
a554da2811f2 clarified signature;
wenzelm
parents: 68198
diff changeset
   248
          Isabelle_Process.start(session, options, logic = parent, cwd = info.dir.file, env = env,
68209
aeffd8f1f079 support Store with options;
wenzelm
parents: 68204
diff changeset
   249
            sessions_structure = Some(deps.sessions_structure), store = Some(store),
65313
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   250
            phase_changed =
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   251
            {
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   252
              case Session.Ready => session.protocol_command("build_session", args_yxml)
65317
b9f5cd845616 more informative session result;
wenzelm
parents: 65315
diff changeset
   253
              case Session.Terminated(result) => session_result.fulfill(result)
65313
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   254
              case _ =>
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   255
            })
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   256
65317
b9f5cd845616 more informative session result;
wenzelm
parents: 65315
diff changeset
   257
          val result = session_result.join
65313
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   258
          handler.result_error.join match {
65317
b9f5cd845616 more informative session result;
wenzelm
parents: 65315
diff changeset
   259
            case "" => result
b9f5cd845616 more informative session result;
wenzelm
parents: 65315
diff changeset
   260
            case msg =>
b9f5cd845616 more informative session result;
wenzelm
parents: 65315
diff changeset
   261
              result.copy(
b9f5cd845616 more informative session result;
wenzelm
parents: 65315
diff changeset
   262
                rc = result.rc max 1,
65828
02dd430d80c5 tuned signature;
wenzelm
parents: 65827
diff changeset
   263
                out_lines = result.out_lines ::: split_lines(Output.error_message_text(msg)))
65313
347ed6219dab more realistic PIDE build session;
wenzelm
parents: 65312
diff changeset
   264
          }
65308
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   265
        }
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   266
        else {
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   267
          val args_file = Isabelle_System.tmp_file("build")
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   268
          File.write(args_file, args_yxml)
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   269
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   270
          val eval =
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   271
            "Command_Line.tool0 (fn () => (" +
66782
193c31b79a33 clarified signature;
wenzelm
parents: 66749
diff changeset
   272
            "Build.build " + ML_Syntax.print_string_bytes(File.standard_path(args_file)) +
67380
8bef51521f21 clarified implicit Pure.thy;
wenzelm
parents: 67297
diff changeset
   273
            (if (Sessions.is_pure(name)) "; Theory.install_pure (Thy_Info.get_theory Context.PureN)"
8bef51521f21 clarified implicit Pure.thy;
wenzelm
parents: 67297
diff changeset
   274
             else "") + (if (do_output) "; " + save_heap else "") + "));"
64265
8eb6365f5916 isabelle build -N;
wenzelm
parents: 64173
diff changeset
   275
65308
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   276
          val process =
65360
wenzelm
parents: 65359
diff changeset
   277
            if (Sessions.is_pure(name)) {
65312
34d56ca5b548 more uniform options;
wenzelm
parents: 65308
diff changeset
   278
              ML_Process(options, raw_ml_system = true, cwd = info.dir.file,
65308
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   279
                args =
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   280
                  (for ((root, _) <- Thy_Header.ml_roots) yield List("--use", root)).flatten :::
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   281
                  List("--eval", eval),
68209
aeffd8f1f079 support Store with options;
wenzelm
parents: 68204
diff changeset
   282
                env = env, sessions_structure = Some(deps.sessions_structure), store = Some(store),
65415
8cd54b18b68b clarified signature: tree structure is not essential;
wenzelm
parents: 65406
diff changeset
   283
                cleanup = () => args_file.delete)
65308
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   284
            }
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   285
            else {
65312
34d56ca5b548 more uniform options;
wenzelm
parents: 65308
diff changeset
   286
              ML_Process(options, parent, List("--eval", eval), cwd = info.dir.file,
68209
aeffd8f1f079 support Store with options;
wenzelm
parents: 68204
diff changeset
   287
                env = env, sessions_structure = Some(deps.sessions_structure), store = Some(store),
65415
8cd54b18b68b clarified signature: tree structure is not essential;
wenzelm
parents: 65406
diff changeset
   288
                cleanup = () => args_file.delete)
65308
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   289
            }
64265
8eb6365f5916 isabelle build -N;
wenzelm
parents: 64173
diff changeset
   290
65308
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   291
          process.result(
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   292
            progress_stdout = (line: String) =>
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   293
              Library.try_unprefix("\floading_theory = ", line) match {
68957
eef4e983fd9d clarified theory progress;
wenzelm
parents: 68953
diff changeset
   294
                case Some(theory) =>
eef4e983fd9d clarified theory progress;
wenzelm
parents: 68953
diff changeset
   295
                  progress.theory(Progress.Theory(theory, session = name))
65308
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   296
                case None =>
68088
0763d4eb3ebc protocol message for export of theory resources;
wenzelm
parents: 68086
diff changeset
   297
                  for {
0763d4eb3ebc protocol message for export of theory resources;
wenzelm
parents: 68086
diff changeset
   298
                    text <- Library.try_unprefix("\fexport = ", line)
68148
fb661e4c4717 more scalable -- avoid huge lines within stdout;
wenzelm
parents: 68092
diff changeset
   299
                    (args, path) <-
68088
0763d4eb3ebc protocol message for export of theory resources;
wenzelm
parents: 68086
diff changeset
   300
                      Markup.Export.dest_inline(XML.Decode.properties(YXML.parse_body(text)))
68148
fb661e4c4717 more scalable -- avoid huge lines within stdout;
wenzelm
parents: 68092
diff changeset
   301
                  } {
fb661e4c4717 more scalable -- avoid huge lines within stdout;
wenzelm
parents: 68092
diff changeset
   302
                    val body = Bytes.read(path)
fb661e4c4717 more scalable -- avoid huge lines within stdout;
wenzelm
parents: 68092
diff changeset
   303
                    path.file.delete
fb661e4c4717 more scalable -- avoid huge lines within stdout;
wenzelm
parents: 68092
diff changeset
   304
                    export_consumer(name, args, body)
fb661e4c4717 more scalable -- avoid huge lines within stdout;
wenzelm
parents: 68092
diff changeset
   305
                  }
65308
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   306
              },
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   307
            progress_limit =
65312
34d56ca5b548 more uniform options;
wenzelm
parents: 65308
diff changeset
   308
              options.int("process_output_limit") match {
65308
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   309
                case 0 => None
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   310
                case m => Some(m * 1000000L)
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   311
              },
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   312
            strict = false)
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   313
        }
50845
477ca927676f immediate theory progress for build_dialog;
wenzelm
parents: 50777
diff changeset
   314
      }
48674
03e88e4619a2 simplified class Job;
wenzelm
parents: 48671
diff changeset
   315
62572
wenzelm
parents: 62569
diff changeset
   316
    def terminate: Unit = future_result.cancel
wenzelm
parents: 62569
diff changeset
   317
    def is_finished: Boolean = future_result.is_finished
48674
03e88e4619a2 simplified class Job;
wenzelm
parents: 48671
diff changeset
   318
56779
9823818588fb tuned -- prefer Isabelle/Scala operations;
wenzelm
parents: 56668
diff changeset
   319
    private val timeout_request: Option[Event_Timer.Request] =
9823818588fb tuned -- prefer Isabelle/Scala operations;
wenzelm
parents: 56668
diff changeset
   320
    {
62569
5db10482f4cf bash process with builtin timing;
wenzelm
parents: 62508
diff changeset
   321
      if (info.timeout > Time.zero)
66943
351aaaa9bacd clarified: adapted to ML version;
wenzelm
parents: 66873
diff changeset
   322
        Some(Event_Timer.request(Time.now() + info.timeout) { terminate })
48674
03e88e4619a2 simplified class Job;
wenzelm
parents: 48671
diff changeset
   323
      else None
56779
9823818588fb tuned -- prefer Isabelle/Scala operations;
wenzelm
parents: 56668
diff changeset
   324
    }
48674
03e88e4619a2 simplified class Job;
wenzelm
parents: 48671
diff changeset
   325
68217
3e90b88b0fc2 clarified handling of output heap;
wenzelm
parents: 68216
diff changeset
   326
    def join: (Process_Result, Option[String]) =
50845
477ca927676f immediate theory progress for build_dialog;
wenzelm
parents: 50777
diff changeset
   327
    {
68217
3e90b88b0fc2 clarified handling of output heap;
wenzelm
parents: 68216
diff changeset
   328
      val result0 = future_result.join
3e90b88b0fc2 clarified handling of output heap;
wenzelm
parents: 68216
diff changeset
   329
      val result1 =
68092
888d35a19866 store exports in session database, with asynchronous / parallel compression;
wenzelm
parents: 68088
diff changeset
   330
        export_consumer.shutdown(close = true).map(Output.error_message_text(_)) match {
68217
3e90b88b0fc2 clarified handling of output heap;
wenzelm
parents: 68216
diff changeset
   331
          case Nil => result0
68928
835e5d45359c clarified rc;
wenzelm
parents: 68734
diff changeset
   332
          case errs => result0.errors(errs).error_rc
68092
888d35a19866 store exports in session database, with asynchronous / parallel compression;
wenzelm
parents: 68088
diff changeset
   333
        }
50845
477ca927676f immediate theory progress for build_dialog;
wenzelm
parents: 50777
diff changeset
   334
68198
6710167e17af avoid race condition wrt. ISABELLE_TMP, which is removed in Bash.cleanup() before Bash.result(progress_stdout);
wenzelm
parents: 68148
diff changeset
   335
      Isabelle_System.rm_tree(export_tmp_dir)
6710167e17af avoid race condition wrt. ISABELLE_TMP, which is removed in Bash.cleanup() before Bash.result(progress_stdout);
wenzelm
parents: 68148
diff changeset
   336
68292
7ca0c23179e6 support 'export_files' in session ROOT;
wenzelm
parents: 68289
diff changeset
   337
      if (result1.ok) {
69671
2486792eaf61 support pruning of export names;
wenzelm
parents: 69540
diff changeset
   338
        for ((dir, prune, pats) <- info.export_files) {
68292
7ca0c23179e6 support 'export_files' in session ROOT;
wenzelm
parents: 68289
diff changeset
   339
          Export.export_files(store, name, info.dir + dir,
7ca0c23179e6 support 'export_files' in session ROOT;
wenzelm
parents: 68289
diff changeset
   340
            progress = if (verbose) progress else No_Progress,
69671
2486792eaf61 support pruning of export names;
wenzelm
parents: 69540
diff changeset
   341
            export_prune = prune,
68292
7ca0c23179e6 support 'export_files' in session ROOT;
wenzelm
parents: 68289
diff changeset
   342
            export_patterns = pats,
7ca0c23179e6 support 'export_files' in session ROOT;
wenzelm
parents: 68289
diff changeset
   343
            export_prefix = name + ": ")
7ca0c23179e6 support 'export_files' in session ROOT;
wenzelm
parents: 68289
diff changeset
   344
        }
62633
e57416b649d5 find heaps uniformly via Sessions.Store;
wenzelm
parents: 62632
diff changeset
   345
        Present.finish(progress, store.browser_info, graph_file, info, name)
68292
7ca0c23179e6 support 'export_files' in session ROOT;
wenzelm
parents: 68289
diff changeset
   346
      }
61372
cf40b6b1de54 more Present operations on Scala side;
wenzelm
parents: 61276
diff changeset
   347
59445
2c27c3d1fd3b provide session_graph.pdf via Isabelle/Scala;
wenzelm
parents: 59444
diff changeset
   348
      graph_file.delete
66943
351aaaa9bacd clarified: adapted to ML version;
wenzelm
parents: 66873
diff changeset
   349
351aaaa9bacd clarified: adapted to ML version;
wenzelm
parents: 66873
diff changeset
   350
      val was_timeout =
351aaaa9bacd clarified: adapted to ML version;
wenzelm
parents: 66873
diff changeset
   351
        timeout_request match {
351aaaa9bacd clarified: adapted to ML version;
wenzelm
parents: 66873
diff changeset
   352
          case None => false
351aaaa9bacd clarified: adapted to ML version;
wenzelm
parents: 66873
diff changeset
   353
          case Some(request) => !request.cancel
351aaaa9bacd clarified: adapted to ML version;
wenzelm
parents: 66873
diff changeset
   354
        }
48674
03e88e4619a2 simplified class Job;
wenzelm
parents: 48671
diff changeset
   355
68217
3e90b88b0fc2 clarified handling of output heap;
wenzelm
parents: 68216
diff changeset
   356
      val result2 =
3e90b88b0fc2 clarified handling of output heap;
wenzelm
parents: 68216
diff changeset
   357
        if (result1.interrupted) {
3e90b88b0fc2 clarified handling of output heap;
wenzelm
parents: 68216
diff changeset
   358
          if (was_timeout) result1.error(Output.error_message_text("Timeout")).was_timeout
3e90b88b0fc2 clarified handling of output heap;
wenzelm
parents: 68216
diff changeset
   359
          else result1.error(Output.error_message_text("Interrupt"))
3e90b88b0fc2 clarified handling of output heap;
wenzelm
parents: 68216
diff changeset
   360
        }
3e90b88b0fc2 clarified handling of output heap;
wenzelm
parents: 68216
diff changeset
   361
        else result1
3e90b88b0fc2 clarified handling of output heap;
wenzelm
parents: 68216
diff changeset
   362
3e90b88b0fc2 clarified handling of output heap;
wenzelm
parents: 68216
diff changeset
   363
      val heap_digest =
3e90b88b0fc2 clarified handling of output heap;
wenzelm
parents: 68216
diff changeset
   364
        if (result2.ok && do_output && store.output_heap(name).is_file)
3e90b88b0fc2 clarified handling of output heap;
wenzelm
parents: 68216
diff changeset
   365
          Some(Sessions.write_heap_digest(store.output_heap(name)))
3e90b88b0fc2 clarified handling of output heap;
wenzelm
parents: 68216
diff changeset
   366
        else None
3e90b88b0fc2 clarified handling of output heap;
wenzelm
parents: 68216
diff changeset
   367
3e90b88b0fc2 clarified handling of output heap;
wenzelm
parents: 68216
diff changeset
   368
      (result2, heap_digest)
48674
03e88e4619a2 simplified class Job;
wenzelm
parents: 48671
diff changeset
   369
    }
48364
9091b659d7b6 minimal build_job;
wenzelm
parents: 48363
diff changeset
   370
  }
9091b659d7b6 minimal build_job;
wenzelm
parents: 48363
diff changeset
   371
48424
wenzelm
parents: 48423
diff changeset
   372
62631
c39614ddb80b clarified modules;
wenzelm
parents: 62630
diff changeset
   373
62641
0b1b7465f2ef always build with full results;
wenzelm
parents: 62638
diff changeset
   374
  /** build with results **/
48424
wenzelm
parents: 48423
diff changeset
   375
63996
3f47fec9edfc tuned whitespace;
wenzelm
parents: 63865
diff changeset
   376
  class Results private[Build](results: Map[String, (Option[Process_Result], Sessions.Info)])
62403
1d7aba20a332 explicit class Build_Results;
wenzelm
parents: 62402
diff changeset
   377
  {
1d7aba20a332 explicit class Build_Results;
wenzelm
parents: 62402
diff changeset
   378
    def sessions: Set[String] = results.keySet
63082
6af03422535a expose Sessions.Info in Build.Results
Lars Hupel <lars.hupel@mytum.de>
parents: 62946
diff changeset
   379
    def cancelled(name: String): Boolean = results(name)._1.isEmpty
6af03422535a expose Sessions.Info in Build.Results
Lars Hupel <lars.hupel@mytum.de>
parents: 62946
diff changeset
   380
    def apply(name: String): Process_Result = results(name)._1.getOrElse(Process_Result(1))
6af03422535a expose Sessions.Info in Build.Results
Lars Hupel <lars.hupel@mytum.de>
parents: 62946
diff changeset
   381
    def info(name: String): Sessions.Info = results(name)._2
65253
85c0ac5c2589 tuned whitespace;
wenzelm
parents: 65251
diff changeset
   382
    val rc =
85c0ac5c2589 tuned whitespace;
wenzelm
parents: 65251
diff changeset
   383
      (0 /: results.iterator.map(
85c0ac5c2589 tuned whitespace;
wenzelm
parents: 65251
diff changeset
   384
        { case (_, (Some(r), _)) => r.rc case (_, (None, _)) => 1 }))(_ max _)
62641
0b1b7465f2ef always build with full results;
wenzelm
parents: 62638
diff changeset
   385
    def ok: Boolean = rc == 0
62406
b5b8fb87447a tuned signature;
wenzelm
parents: 62405
diff changeset
   386
b5b8fb87447a tuned signature;
wenzelm
parents: 62405
diff changeset
   387
    override def toString: String = rc.toString
62403
1d7aba20a332 explicit class Build_Results;
wenzelm
parents: 62402
diff changeset
   388
  }
1d7aba20a332 explicit class Build_Results;
wenzelm
parents: 62402
diff changeset
   389
62641
0b1b7465f2ef always build with full results;
wenzelm
parents: 62638
diff changeset
   390
  def build(
50404
898cac1dad5e avoid startup within GUI thread -- it is only required later for dialog;
wenzelm
parents: 50367
diff changeset
   391
    options: Options,
64909
8007f10195af tuned signature;
wenzelm
parents: 64856
diff changeset
   392
    progress: Progress = No_Progress,
65832
2fb85623c386 implicitly check for unknown files (not part of a Mercurial repository);
wenzelm
parents: 65831
diff changeset
   393
    check_unknown_files: Boolean = false,
48511
37999ee01156 remove old output heaps, to ensure that result is valid wrt. check_stamps;
wenzelm
parents: 48509
diff changeset
   394
    build_heap: Boolean = false,
48595
231e6fa96dbb added build option -c;
wenzelm
parents: 48594
diff changeset
   395
    clean_build: Boolean = false,
56890
7f120d227ca5 tuned signature;
wenzelm
parents: 56873
diff changeset
   396
    dirs: List[Path] = Nil,
7f120d227ca5 tuned signature;
wenzelm
parents: 56873
diff changeset
   397
    select_dirs: List[Path] = Nil,
66968
9991671c98aa allow to augment session context via explicit session infos;
wenzelm
parents: 66962
diff changeset
   398
    infos: List[Sessions.Info] = Nil,
64265
8eb6365f5916 isabelle build -N;
wenzelm
parents: 64173
diff changeset
   399
    numa_shuffling: Boolean = false,
48509
4854ced3e9d7 support session groups;
wenzelm
parents: 48508
diff changeset
   400
    max_jobs: Int = 1,
48903
1621b3f26095 added build option -l (list files);
wenzelm
parents: 48883
diff changeset
   401
    list_files: Boolean = false,
59891
9ce697050455 added isabelle build option -k, for fast off-line checking of theory sources;
wenzelm
parents: 59811
diff changeset
   402
    check_keywords: Set[String] = Set.empty,
66841
5c32a072ca8b added isablle build option -f;
wenzelm
parents: 66822
diff changeset
   403
    fresh_build: Boolean = false,
48509
4854ced3e9d7 support session groups;
wenzelm
parents: 48508
diff changeset
   404
    no_build: Boolean = false,
66745
e7ac579b883c option -S for "isabelle build";
wenzelm
parents: 66744
diff changeset
   405
    soft_build: Boolean = false,
48509
4854ced3e9d7 support session groups;
wenzelm
parents: 48508
diff changeset
   406
    system_mode: Boolean = false,
4854ced3e9d7 support session groups;
wenzelm
parents: 48508
diff changeset
   407
    verbose: Boolean = false,
65308
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   408
    pide: Boolean = false,
63224
78e93610a3c8 more flexible build_selection;
wenzelm
parents: 63082
diff changeset
   409
    requirements: Boolean = false,
78e93610a3c8 more flexible build_selection;
wenzelm
parents: 63082
diff changeset
   410
    all_sessions: Boolean = false,
66737
2edc0c42c883 option -B for "isabelle build" and "isabelle imports";
wenzelm
parents: 66736
diff changeset
   411
    base_sessions: List[String] = Nil,
63224
78e93610a3c8 more flexible build_selection;
wenzelm
parents: 63082
diff changeset
   412
    exclude_session_groups: List[String] = Nil,
59892
2a616319c171 added isabelle build option -x, to exclude sessions;
wenzelm
parents: 59891
diff changeset
   413
    exclude_sessions: List[String] = Nil,
63224
78e93610a3c8 more flexible build_selection;
wenzelm
parents: 63082
diff changeset
   414
    session_groups: List[String] = Nil,
65422
b606c98e6d10 tuned signature;
wenzelm
parents: 65420
diff changeset
   415
    sessions: List[String] = Nil,
b606c98e6d10 tuned signature;
wenzelm
parents: 65420
diff changeset
   416
    selection: Sessions.Selection = Sessions.Selection.empty): Results =
63224
78e93610a3c8 more flexible build_selection;
wenzelm
parents: 63082
diff changeset
   417
  {
66745
e7ac579b883c option -S for "isabelle build";
wenzelm
parents: 66744
diff changeset
   418
    val build_options = options.int.update("completion_limit", 0).bool.update("ML_statistics", true)
51220
e140c8fa485a recover timing information from old log files;
wenzelm
parents: 51218
diff changeset
   419
68209
aeffd8f1f079 support Store with options;
wenzelm
parents: 68204
diff changeset
   420
    val store = Sessions.store(build_options, system_mode)
66745
e7ac579b883c option -S for "isabelle build";
wenzelm
parents: 66744
diff changeset
   421
69369
6ecc85955e04 prefer "Isabelle DejaVu Sans", even for headless batch-build (session_graph.pdf);
wenzelm
parents: 68957
diff changeset
   422
    Isabelle_Fonts.init()
6ecc85955e04 prefer "Isabelle DejaVu Sans", even for headless batch-build (session_graph.pdf);
wenzelm
parents: 68957
diff changeset
   423
66745
e7ac579b883c option -S for "isabelle build";
wenzelm
parents: 66744
diff changeset
   424
e7ac579b883c option -S for "isabelle build";
wenzelm
parents: 66744
diff changeset
   425
    /* session selection and dependencies */
65422
b606c98e6d10 tuned signature;
wenzelm
parents: 65420
diff changeset
   426
66961
wenzelm
parents: 66944
diff changeset
   427
    val full_sessions =
67026
687c822ee5e3 tuned signature;
wenzelm
parents: 67025
diff changeset
   428
      Sessions.load_structure(build_options, dirs = dirs, select_dirs = select_dirs, infos = infos)
65422
b606c98e6d10 tuned signature;
wenzelm
parents: 65420
diff changeset
   429
66749
0445cfaf6132 more compact (second-order) digest for 10^2..10^3 source files, with slightly increased risk of collisions;
wenzelm
parents: 66747
diff changeset
   430
    def sources_stamp(deps: Sessions.Deps, name: String): String =
0445cfaf6132 more compact (second-order) digest for 10^2..10^3 source files, with slightly increased risk of collisions;
wenzelm
parents: 66747
diff changeset
   431
    {
0445cfaf6132 more compact (second-order) digest for 10^2..10^3 source files, with slightly increased risk of collisions;
wenzelm
parents: 66747
diff changeset
   432
      val digests =
0445cfaf6132 more compact (second-order) digest for 10^2..10^3 source files, with slightly increased risk of collisions;
wenzelm
parents: 66747
diff changeset
   433
        full_sessions(name).meta_digest :: deps.sources(name) ::: deps.imported_sources(name)
0445cfaf6132 more compact (second-order) digest for 10^2..10^3 source files, with slightly increased risk of collisions;
wenzelm
parents: 66747
diff changeset
   434
      SHA1.digest(cat_lines(digests.map(_.toString).sorted)).toString
0445cfaf6132 more compact (second-order) digest for 10^2..10^3 source files, with slightly increased risk of collisions;
wenzelm
parents: 66747
diff changeset
   435
    }
66745
e7ac579b883c option -S for "isabelle build";
wenzelm
parents: 66744
diff changeset
   436
67030
a9859e879f38 proper build_selection for clean_build (amending 961285f581e6): e.g. relevant for "isabelle build_doc";
wenzelm
parents: 67026
diff changeset
   437
    val selection1 =
a9859e879f38 proper build_selection for clean_build (amending 961285f581e6): e.g. relevant for "isabelle build_doc";
wenzelm
parents: 67026
diff changeset
   438
      Sessions.Selection(requirements, all_sessions, base_sessions, exclude_session_groups,
a9859e879f38 proper build_selection for clean_build (amending 961285f581e6): e.g. relevant for "isabelle build_doc";
wenzelm
parents: 67026
diff changeset
   439
        exclude_sessions, session_groups, sessions) ++ selection
a9859e879f38 proper build_selection for clean_build (amending 961285f581e6): e.g. relevant for "isabelle build_doc";
wenzelm
parents: 67026
diff changeset
   440
68204
a554da2811f2 clarified signature;
wenzelm
parents: 68198
diff changeset
   441
    val deps =
66745
e7ac579b883c option -S for "isabelle build";
wenzelm
parents: 66744
diff changeset
   442
    {
e7ac579b883c option -S for "isabelle build";
wenzelm
parents: 66744
diff changeset
   443
      val deps0 =
68204
a554da2811f2 clarified signature;
wenzelm
parents: 68198
diff changeset
   444
        Sessions.deps(full_sessions.selection(selection1), full_sessions.global_theories,
66962
e1bde71bace6 clarified signature: global_theories is always required;
wenzelm
parents: 66961
diff changeset
   445
          progress = progress, inlined_files = true, verbose = verbose,
e1bde71bace6 clarified signature: global_theories is always required;
wenzelm
parents: 66961
diff changeset
   446
          list_files = list_files, check_keywords = check_keywords).check_errors
66745
e7ac579b883c option -S for "isabelle build";
wenzelm
parents: 66744
diff changeset
   447
66841
5c32a072ca8b added isablle build option -f;
wenzelm
parents: 66822
diff changeset
   448
      if (soft_build && !fresh_build) {
66745
e7ac579b883c option -S for "isabelle build";
wenzelm
parents: 66744
diff changeset
   449
        val outdated =
68204
a554da2811f2 clarified signature;
wenzelm
parents: 68198
diff changeset
   450
          deps0.sessions_structure.build_topological_order.flatMap(name =>
68221
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
   451
            store.access_database(name) match {
68214
b0e2a19df95b more abstract database access;
wenzelm
parents: 68213
diff changeset
   452
              case Some(db) =>
68216
wenzelm
parents: 68214
diff changeset
   453
                using(db)(store.read_build(_, name)) match {
66745
e7ac579b883c option -S for "isabelle build";
wenzelm
parents: 66744
diff changeset
   454
                  case Some(build)
66747
wenzelm
parents: 66746
diff changeset
   455
                  if build.ok && build.sources == sources_stamp(deps0, name) => None
66745
e7ac579b883c option -S for "isabelle build";
wenzelm
parents: 66744
diff changeset
   456
                  case _ => Some(name)
e7ac579b883c option -S for "isabelle build";
wenzelm
parents: 66744
diff changeset
   457
                }
e7ac579b883c option -S for "isabelle build";
wenzelm
parents: 66744
diff changeset
   458
              case None => Some(name)
e7ac579b883c option -S for "isabelle build";
wenzelm
parents: 66744
diff changeset
   459
            })
68204
a554da2811f2 clarified signature;
wenzelm
parents: 68198
diff changeset
   460
a554da2811f2 clarified signature;
wenzelm
parents: 68198
diff changeset
   461
        Sessions.deps(full_sessions.selection(Sessions.Selection(sessions = outdated)),
a554da2811f2 clarified signature;
wenzelm
parents: 68198
diff changeset
   462
          full_sessions.global_theories, progress = progress, inlined_files = true).check_errors
66745
e7ac579b883c option -S for "isabelle build";
wenzelm
parents: 66744
diff changeset
   463
      }
68204
a554da2811f2 clarified signature;
wenzelm
parents: 68198
diff changeset
   464
      else deps0
66745
e7ac579b883c option -S for "isabelle build";
wenzelm
parents: 66744
diff changeset
   465
    }
e7ac579b883c option -S for "isabelle build";
wenzelm
parents: 66744
diff changeset
   466
e7ac579b883c option -S for "isabelle build";
wenzelm
parents: 66744
diff changeset
   467
e7ac579b883c option -S for "isabelle build";
wenzelm
parents: 66744
diff changeset
   468
    /* check unknown files */
48504
21dfd6c04482 actually check source vs. target stamps, based on information from log files;
wenzelm
parents: 48494
diff changeset
   469
65832
2fb85623c386 implicitly check for unknown files (not part of a Mercurial repository);
wenzelm
parents: 65831
diff changeset
   470
    if (check_unknown_files) {
2fb85623c386 implicitly check for unknown files (not part of a Mercurial repository);
wenzelm
parents: 65831
diff changeset
   471
      val source_files =
2fb85623c386 implicitly check for unknown files (not part of a Mercurial repository);
wenzelm
parents: 65831
diff changeset
   472
        (for {
2fb85623c386 implicitly check for unknown files (not part of a Mercurial repository);
wenzelm
parents: 65831
diff changeset
   473
          (_, base) <- deps.session_bases.iterator
2fb85623c386 implicitly check for unknown files (not part of a Mercurial repository);
wenzelm
parents: 65831
diff changeset
   474
          (path, _) <- base.sources.iterator
2fb85623c386 implicitly check for unknown files (not part of a Mercurial repository);
wenzelm
parents: 65831
diff changeset
   475
        } yield path).toList
67098
0f750a6dc754 suppress warning;
wenzelm
parents: 67052
diff changeset
   476
      val exclude_files = List(Path.explode("$POLYML_EXE")).map(_.canonical_file)
0f750a6dc754 suppress warning;
wenzelm
parents: 67052
diff changeset
   477
      val unknown_files =
67782
7e223a05e6d8 clarified notion of unknown files: ignore files outside of a Mercurial repository;
wenzelm
parents: 67493
diff changeset
   478
        Mercurial.check_files(source_files)._2.
67098
0f750a6dc754 suppress warning;
wenzelm
parents: 67052
diff changeset
   479
          filterNot(path => exclude_files.contains(path.canonical_file))
65832
2fb85623c386 implicitly check for unknown files (not part of a Mercurial repository);
wenzelm
parents: 65831
diff changeset
   480
      if (unknown_files.nonEmpty) {
67782
7e223a05e6d8 clarified notion of unknown files: ignore files outside of a Mercurial repository;
wenzelm
parents: 67493
diff changeset
   481
        progress.echo_warning("Unknown files (not part of the underlying Mercurial repository):" +
65832
2fb85623c386 implicitly check for unknown files (not part of a Mercurial repository);
wenzelm
parents: 65831
diff changeset
   482
          unknown_files.map(path => path.expand.implode).sorted.mkString("\n  ", "\n  ", ""))
2fb85623c386 implicitly check for unknown files (not part of a Mercurial repository);
wenzelm
parents: 65831
diff changeset
   483
      }
2fb85623c386 implicitly check for unknown files (not part of a Mercurial repository);
wenzelm
parents: 65831
diff changeset
   484
    }
2fb85623c386 implicitly check for unknown files (not part of a Mercurial repository);
wenzelm
parents: 65831
diff changeset
   485
51220
e140c8fa485a recover timing information from old log files;
wenzelm
parents: 51218
diff changeset
   486
e140c8fa485a recover timing information from old log files;
wenzelm
parents: 51218
diff changeset
   487
    /* main build process */
e140c8fa485a recover timing information from old log files;
wenzelm
parents: 51218
diff changeset
   488
68204
a554da2811f2 clarified signature;
wenzelm
parents: 68198
diff changeset
   489
    val queue = Queue(progress, deps.sessions_structure, store)
65289
86d93effc3df tuned signature;
wenzelm
parents: 65284
diff changeset
   490
68219
c0341c0080e2 clarified store directories;
wenzelm
parents: 68217
diff changeset
   491
    store.prepare_output_dir()
48373
527e2bad7cca further imitation of "usedir" shell script;
wenzelm
parents: 48370
diff changeset
   492
48595
231e6fa96dbb added build option -c;
wenzelm
parents: 48594
diff changeset
   493
    if (clean_build) {
68734
c14a2cc9b5ef isabelle build options -c -x -B refer to imports_graph;
wenzelm
parents: 68731
diff changeset
   494
      for (name <- full_sessions.imports_descendants(full_sessions.imports_selection(selection1))) {
68220
8fc4e3d1df86 clarified store.clean_output: cleanup user_output_dir even in system_mode;
wenzelm
parents: 68219
diff changeset
   495
        val (relevant, ok) = store.clean_output(name)
8fc4e3d1df86 clarified store.clean_output: cleanup user_output_dir even in system_mode;
wenzelm
parents: 68219
diff changeset
   496
        if (relevant) {
8fc4e3d1df86 clarified store.clean_output: cleanup user_output_dir even in system_mode;
wenzelm
parents: 68219
diff changeset
   497
          if (ok) progress.echo("Cleaned " + name)
8fc4e3d1df86 clarified store.clean_output: cleanup user_output_dir even in system_mode;
wenzelm
parents: 68219
diff changeset
   498
          else progress.echo(name + " FAILED to clean")
8fc4e3d1df86 clarified store.clean_output: cleanup user_output_dir even in system_mode;
wenzelm
parents: 68219
diff changeset
   499
        }
48595
231e6fa96dbb added build option -c;
wenzelm
parents: 48594
diff changeset
   500
      }
231e6fa96dbb added build option -c;
wenzelm
parents: 48594
diff changeset
   501
    }
231e6fa96dbb added build option -c;
wenzelm
parents: 48594
diff changeset
   502
48425
0d95980e9aae parallel scheduling of jobs;
wenzelm
parents: 48424
diff changeset
   503
    // scheduler loop
63082
6af03422535a expose Sessions.Info in Build.Results
Lars Hupel <lars.hupel@mytum.de>
parents: 62946
diff changeset
   504
    case class Result(
66594
c16ed3250de0 tuned whitespace;
wenzelm
parents: 66571
diff changeset
   505
      current: Boolean,
68213
wenzelm
parents: 68212
diff changeset
   506
      heap_digest: Option[String],
66594
c16ed3250de0 tuned whitespace;
wenzelm
parents: 66571
diff changeset
   507
      process: Option[Process_Result],
c16ed3250de0 tuned whitespace;
wenzelm
parents: 66571
diff changeset
   508
      info: Sessions.Info)
62402
bff56eae3ec5 more informative Build.build_results;
wenzelm
parents: 62401
diff changeset
   509
    {
bff56eae3ec5 more informative Build.build_results;
wenzelm
parents: 62401
diff changeset
   510
      def ok: Boolean =
bff56eae3ec5 more informative Build.build_results;
wenzelm
parents: 62401
diff changeset
   511
        process match {
bff56eae3ec5 more informative Build.build_results;
wenzelm
parents: 62401
diff changeset
   512
          case None => false
bff56eae3ec5 more informative Build.build_results;
wenzelm
parents: 62401
diff changeset
   513
          case Some(res) => res.rc == 0
bff56eae3ec5 more informative Build.build_results;
wenzelm
parents: 62401
diff changeset
   514
        }
bff56eae3ec5 more informative Build.build_results;
wenzelm
parents: 62401
diff changeset
   515
    }
48639
675988e64bf9 store parent heap stamp as well -- needs to be propagated through the build hierarchy;
wenzelm
parents: 48626
diff changeset
   516
56837
5a598f1eecfd more robust interrupt handling for Scala_Console, which uses JVM Thread.interrupt instead of POSIX SIGINT;
wenzelm
parents: 56831
diff changeset
   517
    def sleep()
5a598f1eecfd more robust interrupt handling for Scala_Console, which uses JVM Thread.interrupt instead of POSIX SIGINT;
wenzelm
parents: 56831
diff changeset
   518
    {
5a598f1eecfd more robust interrupt handling for Scala_Console, which uses JVM Thread.interrupt instead of POSIX SIGINT;
wenzelm
parents: 56831
diff changeset
   519
      try { Thread.sleep(500) }
56861
5f827142d89a tuned signature;
wenzelm
parents: 56860
diff changeset
   520
      catch { case Exn.Interrupt() => Exn.Interrupt.impose() }
56837
5a598f1eecfd more robust interrupt handling for Scala_Console, which uses JVM Thread.interrupt instead of POSIX SIGINT;
wenzelm
parents: 56831
diff changeset
   521
    }
50366
b1dd455593a9 more formal progress context;
wenzelm
parents: 50207
diff changeset
   522
64265
8eb6365f5916 isabelle build -N;
wenzelm
parents: 64173
diff changeset
   523
    val numa_nodes = new NUMA.Nodes(numa_shuffling)
8eb6365f5916 isabelle build -N;
wenzelm
parents: 64173
diff changeset
   524
48425
0d95980e9aae parallel scheduling of jobs;
wenzelm
parents: 48424
diff changeset
   525
    @tailrec def loop(
48676
3ef82491cdd6 clarified Session_Tree (with proper integrity check) vs. Queue (with provision for alternative ordering);
wenzelm
parents: 48675
diff changeset
   526
      pending: Queue,
62628
6031191a8d9c record stamps of cumulative input heaps;
wenzelm
parents: 62610
diff changeset
   527
      running: Map[String, (List[String], Job)],
48639
675988e64bf9 store parent heap stamp as well -- needs to be propagated through the build hierarchy;
wenzelm
parents: 48626
diff changeset
   528
      results: Map[String, Result]): Map[String, Result] =
48425
0d95980e9aae parallel scheduling of jobs;
wenzelm
parents: 48424
diff changeset
   529
    {
64265
8eb6365f5916 isabelle build -N;
wenzelm
parents: 64173
diff changeset
   530
      def used_node(i: Int): Boolean =
8eb6365f5916 isabelle build -N;
wenzelm
parents: 64173
diff changeset
   531
        running.iterator.exists(
8eb6365f5916 isabelle build -N;
wenzelm
parents: 64173
diff changeset
   532
          { case (_, (_, job)) => job.numa_node.isDefined && job.numa_node.get == i })
8eb6365f5916 isabelle build -N;
wenzelm
parents: 64173
diff changeset
   533
48425
0d95980e9aae parallel scheduling of jobs;
wenzelm
parents: 48424
diff changeset
   534
      if (pending.is_empty) results
51253
ab4c296a1e60 clarified Progress.stopped: rising edge only;
wenzelm
parents: 51252
diff changeset
   535
      else {
ab4c296a1e60 clarified Progress.stopped: rising edge only;
wenzelm
parents: 51252
diff changeset
   536
        if (progress.stopped)
ab4c296a1e60 clarified Progress.stopped: rising edge only;
wenzelm
parents: 51252
diff changeset
   537
          for ((_, (_, job)) <- running) job.terminate
ab4c296a1e60 clarified Progress.stopped: rising edge only;
wenzelm
parents: 51252
diff changeset
   538
48674
03e88e4619a2 simplified class Job;
wenzelm
parents: 48671
diff changeset
   539
        running.find({ case (_, (_, job)) => job.is_finished }) match {
62628
6031191a8d9c record stamps of cumulative input heaps;
wenzelm
parents: 62610
diff changeset
   540
          case Some((name, (input_heaps, job))) =>
50367
69efe72886e3 allow to terminate jobs via Progress;
wenzelm
parents: 50366
diff changeset
   541
            //{{{ finish job
48424
wenzelm
parents: 48423
diff changeset
   542
68217
3e90b88b0fc2 clarified handling of output heap;
wenzelm
parents: 68216
diff changeset
   543
            val (process_result, heap_digest) = job.join
48373
527e2bad7cca further imitation of "usedir" shell script;
wenzelm
parents: 48370
diff changeset
   544
65294
69100bf4ead4 suppress inlined properties from log output;
wenzelm
parents: 65291
diff changeset
   545
            val log_lines = process_result.out_lines.filterNot(_.startsWith("\f"))
62404
13a0f537e232 retain tail out_lines as printed, but not the whole log content;
wenzelm
parents: 62403
diff changeset
   546
            val process_result_tail =
13a0f537e232 retain tail out_lines as printed, but not the whole log content;
wenzelm
parents: 62403
diff changeset
   547
            {
62409
e391528eff3b proper option process_output_tail, more generous default;
wenzelm
parents: 62406
diff changeset
   548
              val tail = job.info.options.int("process_output_tail")
62632
cd991ba01ffd clarified modules;
wenzelm
parents: 62631
diff changeset
   549
              process_result.copy(
cd991ba01ffd clarified modules;
wenzelm
parents: 62631
diff changeset
   550
                out_lines =
68086
9e1c670301b8 cleanup session output before starting build job;
wenzelm
parents: 67852
diff changeset
   551
                  "(see also " + store.output_log(name).file.toString + ")" ::
65294
69100bf4ead4 suppress inlined properties from log output;
wenzelm
parents: 65291
diff changeset
   552
                  (if (tail == 0) log_lines else log_lines.drop(log_lines.length - tail max 0)))
62404
13a0f537e232 retain tail out_lines as printed, but not the whole log content;
wenzelm
parents: 62403
diff changeset
   553
            }
13a0f537e232 retain tail out_lines as printed, but not the whole log content;
wenzelm
parents: 62403
diff changeset
   554
66666
1a620647285c clarified messages: after writing all files (see also 27f90319a499 and 57c85c83c11b);
wenzelm
parents: 66595
diff changeset
   555
1a620647285c clarified messages: after writing all files (see also 27f90319a499 and 57c85c83c11b);
wenzelm
parents: 66595
diff changeset
   556
            // write log file
68217
3e90b88b0fc2 clarified handling of output heap;
wenzelm
parents: 68216
diff changeset
   557
            if (process_result.ok) {
3e90b88b0fc2 clarified handling of output heap;
wenzelm
parents: 68216
diff changeset
   558
              File.write_gzip(store.output_log_gz(name), terminate_lines(log_lines))
3e90b88b0fc2 clarified handling of output heap;
wenzelm
parents: 68216
diff changeset
   559
            }
3e90b88b0fc2 clarified handling of output heap;
wenzelm
parents: 68216
diff changeset
   560
            else File.write(store.output_log(name), terminate_lines(log_lines))
65291
57c85c83c11b maintain persistent session info in SQLite database instead of log file;
wenzelm
parents: 65289
diff changeset
   561
57c85c83c11b maintain persistent session info in SQLite database instead of log file;
wenzelm
parents: 65289
diff changeset
   562
            // write database
57c85c83c11b maintain persistent session info in SQLite database instead of log file;
wenzelm
parents: 65289
diff changeset
   563
            {
66944
05df740cb54b more informative timeout message, notably for build_status;
wenzelm
parents: 66943
diff changeset
   564
              val build_log =
05df740cb54b more informative timeout message, notably for build_status;
wenzelm
parents: 66943
diff changeset
   565
                Build_Log.Log_File(name, process_result.out_lines).
05df740cb54b more informative timeout message, notably for build_status;
wenzelm
parents: 66943
diff changeset
   566
                  parse_session_info(
05df740cb54b more informative timeout message, notably for build_status;
wenzelm
parents: 66943
diff changeset
   567
                    command_timings = true,
05df740cb54b more informative timeout message, notably for build_status;
wenzelm
parents: 66943
diff changeset
   568
                    theory_timings = true,
05df740cb54b more informative timeout message, notably for build_status;
wenzelm
parents: 66943
diff changeset
   569
                    ml_statistics = true,
05df740cb54b more informative timeout message, notably for build_status;
wenzelm
parents: 66943
diff changeset
   570
                    task_statistics = true)
05df740cb54b more informative timeout message, notably for build_status;
wenzelm
parents: 66943
diff changeset
   571
68221
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
   572
              using(store.open_database(name, output = true))(db =>
65318
342efc382558 eliminated somewhat redundant inlined name (despite a7aa17a1f721);
wenzelm
parents: 65317
diff changeset
   573
                store.write_session_info(db, name,
65291
57c85c83c11b maintain persistent session info in SQLite database instead of log file;
wenzelm
parents: 65289
diff changeset
   574
                  build_log =
66944
05df740cb54b more informative timeout message, notably for build_status;
wenzelm
parents: 66943
diff changeset
   575
                    if (process_result.timeout) build_log.error("Timeout") else build_log,
65291
57c85c83c11b maintain persistent session info in SQLite database instead of log file;
wenzelm
parents: 65289
diff changeset
   576
                  build =
68213
wenzelm
parents: 68212
diff changeset
   577
                    Session_Info(sources_stamp(deps, name), input_heaps, heap_digest,
66744
fec1504e5f03 persistent storage of imported_sources;
wenzelm
parents: 66737
diff changeset
   578
                      process_result.rc)))
65291
57c85c83c11b maintain persistent session info in SQLite database instead of log file;
wenzelm
parents: 65289
diff changeset
   579
            }
57c85c83c11b maintain persistent session info in SQLite database instead of log file;
wenzelm
parents: 65289
diff changeset
   580
66666
1a620647285c clarified messages: after writing all files (see also 27f90319a499 and 57c85c83c11b);
wenzelm
parents: 66595
diff changeset
   581
            // messages
1a620647285c clarified messages: after writing all files (see also 27f90319a499 and 57c85c83c11b);
wenzelm
parents: 66595
diff changeset
   582
            process_result.err_lines.foreach(progress.echo(_))
1a620647285c clarified messages: after writing all files (see also 27f90319a499 and 57c85c83c11b);
wenzelm
parents: 66595
diff changeset
   583
1a620647285c clarified messages: after writing all files (see also 27f90319a499 and 57c85c83c11b);
wenzelm
parents: 66595
diff changeset
   584
            if (process_result.ok)
1a620647285c clarified messages: after writing all files (see also 27f90319a499 and 57c85c83c11b);
wenzelm
parents: 66595
diff changeset
   585
              progress.echo("Finished " + name + " (" + process_result.timing.message_resources + ")")
1a620647285c clarified messages: after writing all files (see also 27f90319a499 and 57c85c83c11b);
wenzelm
parents: 66595
diff changeset
   586
            else {
1a620647285c clarified messages: after writing all files (see also 27f90319a499 and 57c85c83c11b);
wenzelm
parents: 66595
diff changeset
   587
              progress.echo(name + " FAILED")
1a620647285c clarified messages: after writing all files (see also 27f90319a499 and 57c85c83c11b);
wenzelm
parents: 66595
diff changeset
   588
              if (!process_result.interrupted) progress.echo(process_result_tail.out)
1a620647285c clarified messages: after writing all files (see also 27f90319a499 and 57c85c83c11b);
wenzelm
parents: 66595
diff changeset
   589
            }
1a620647285c clarified messages: after writing all files (see also 27f90319a499 and 57c85c83c11b);
wenzelm
parents: 66595
diff changeset
   590
50707
5b2bf7611662 maintain session index on Scala side, for more determistic results;
wenzelm
parents: 50686
diff changeset
   591
            loop(pending - name, running - name,
68213
wenzelm
parents: 68212
diff changeset
   592
              results + (name -> Result(false, heap_digest, Some(process_result_tail), job.info)))
50367
69efe72886e3 allow to terminate jobs via Progress;
wenzelm
parents: 50366
diff changeset
   593
            //}}}
60215
5fb4990dfc73 misc tuning, based on warnings by IntelliJ IDEA;
wenzelm
parents: 60106
diff changeset
   594
          case None if running.size < (max_jobs max 1) =>
50367
69efe72886e3 allow to terminate jobs via Progress;
wenzelm
parents: 50366
diff changeset
   595
            //{{{ check/start next job
48547
wenzelm
parents: 48546
diff changeset
   596
            pending.dequeue(running.isDefinedAt(_)) match {
wenzelm
parents: 48546
diff changeset
   597
              case Some((name, info)) =>
66848
982baed14542 clarified signature;
wenzelm
parents: 66841
diff changeset
   598
                val ancestor_results =
68204
a554da2811f2 clarified signature;
wenzelm
parents: 68198
diff changeset
   599
                  deps.sessions_structure.build_requirements(List(name)).filterNot(_ == name).
66848
982baed14542 clarified signature;
wenzelm
parents: 66841
diff changeset
   600
                    map(results(_))
68213
wenzelm
parents: 68212
diff changeset
   601
                val ancestor_heaps = ancestor_results.flatMap(_.heap_digest)
62628
6031191a8d9c record stamps of cumulative input heaps;
wenzelm
parents: 62610
diff changeset
   602
65360
wenzelm
parents: 65359
diff changeset
   603
                val do_output = build_heap || Sessions.is_pure(name) || queue.is_inner(name)
48547
wenzelm
parents: 48546
diff changeset
   604
68213
wenzelm
parents: 68212
diff changeset
   605
                val (current, heap_digest) =
48547
wenzelm
parents: 48546
diff changeset
   606
                {
68221
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
   607
                  store.access_database(name) match {
68212
5a59fded83c7 clarified heap vs. database operations: discontinued correlation of directory;
wenzelm
parents: 68209
diff changeset
   608
                    case Some(db) =>
68216
wenzelm
parents: 68214
diff changeset
   609
                      using(db)(store.read_build(_, name)) match {
wenzelm
parents: 68214
diff changeset
   610
                        case Some(build) =>
wenzelm
parents: 68214
diff changeset
   611
                          val heap_digest = store.find_heap_digest(name)
wenzelm
parents: 68214
diff changeset
   612
                          val current =
wenzelm
parents: 68214
diff changeset
   613
                            !fresh_build &&
wenzelm
parents: 68214
diff changeset
   614
                            build.ok &&
wenzelm
parents: 68214
diff changeset
   615
                            build.sources == sources_stamp(deps, name) &&
wenzelm
parents: 68214
diff changeset
   616
                            build.input_heaps == ancestor_heaps &&
wenzelm
parents: 68214
diff changeset
   617
                            build.output_heap == heap_digest &&
wenzelm
parents: 68214
diff changeset
   618
                            !(do_output && heap_digest.isEmpty)
wenzelm
parents: 68214
diff changeset
   619
                          (current, heap_digest)
wenzelm
parents: 68214
diff changeset
   620
                        case None => (false, None)
wenzelm
parents: 68214
diff changeset
   621
                      }
62636
e676ae9f1bf6 clarified signature;
wenzelm
parents: 62635
diff changeset
   622
                    case None => (false, None)
48504
21dfd6c04482 actually check source vs. target stamps, based on information from log files;
wenzelm
parents: 48494
diff changeset
   623
                  }
48547
wenzelm
parents: 48546
diff changeset
   624
                }
62628
6031191a8d9c record stamps of cumulative input heaps;
wenzelm
parents: 62610
diff changeset
   625
                val all_current = current && ancestor_results.forall(_.current)
48528
784c6f63d79c proper all_current, which regards parent status as well;
wenzelm
parents: 48511
diff changeset
   626
48547
wenzelm
parents: 48546
diff changeset
   627
                if (all_current)
62402
bff56eae3ec5 more informative Build.build_results;
wenzelm
parents: 62401
diff changeset
   628
                  loop(pending - name, running,
68213
wenzelm
parents: 68212
diff changeset
   629
                    results + (name -> Result(true, heap_digest, Some(Process_Result(0)), info)))
48678
ff27af15530c queue ordering by descending outdegree and timeout;
wenzelm
parents: 48676
diff changeset
   630
                else if (no_build) {
50366
b1dd455593a9 more formal progress context;
wenzelm
parents: 50207
diff changeset
   631
                  if (verbose) progress.echo("Skipping " + name + " ...")
62402
bff56eae3ec5 more informative Build.build_results;
wenzelm
parents: 62401
diff changeset
   632
                  loop(pending - name, running,
68213
wenzelm
parents: 68212
diff changeset
   633
                    results + (name -> Result(false, heap_digest, Some(Process_Result(1)), info)))
48678
ff27af15530c queue ordering by descending outdegree and timeout;
wenzelm
parents: 48676
diff changeset
   634
                }
62628
6031191a8d9c record stamps of cumulative input heaps;
wenzelm
parents: 62610
diff changeset
   635
                else if (ancestor_results.forall(_.ok) && !progress.stopped) {
68086
9e1c670301b8 cleanup session output before starting build job;
wenzelm
parents: 67852
diff changeset
   636
                  progress.echo((if (do_output) "Building " else "Running ") + name + " ...")
9e1c670301b8 cleanup session output before starting build job;
wenzelm
parents: 67852
diff changeset
   637
68220
8fc4e3d1df86 clarified store.clean_output: cleanup user_output_dir even in system_mode;
wenzelm
parents: 68219
diff changeset
   638
                  store.clean_output(name)
68221
dbef88c2b6c5 support for build_database_server (PostgreSQL);
wenzelm
parents: 68220
diff changeset
   639
                  using(store.open_database(name, output = true))(store.init_session_info(_, name))
68086
9e1c670301b8 cleanup session output before starting build job;
wenzelm
parents: 67852
diff changeset
   640
64265
8eb6365f5916 isabelle build -N;
wenzelm
parents: 64173
diff changeset
   641
                  val numa_node = numa_nodes.next(used_node(_))
51220
e140c8fa485a recover timing information from old log files;
wenzelm
parents: 51218
diff changeset
   642
                  val job =
68204
a554da2811f2 clarified signature;
wenzelm
parents: 68198
diff changeset
   643
                    new Job(progress, name, info, deps, store, do_output,
65415
8cd54b18b68b clarified signature: tree structure is not essential;
wenzelm
parents: 65406
diff changeset
   644
                      verbose, pide, numa_node, queue.command_timings(name))
62628
6031191a8d9c record stamps of cumulative input heaps;
wenzelm
parents: 62610
diff changeset
   645
                  loop(pending, running + (name -> (ancestor_heaps, job)), results)
48547
wenzelm
parents: 48546
diff changeset
   646
                }
wenzelm
parents: 48546
diff changeset
   647
                else {
50366
b1dd455593a9 more formal progress context;
wenzelm
parents: 50207
diff changeset
   648
                  progress.echo(name + " CANCELLED")
65253
85c0ac5c2589 tuned whitespace;
wenzelm
parents: 65251
diff changeset
   649
                  loop(pending - name, running,
68213
wenzelm
parents: 68212
diff changeset
   650
                    results + (name -> Result(false, heap_digest, None, info)))
48547
wenzelm
parents: 48546
diff changeset
   651
                }
wenzelm
parents: 48546
diff changeset
   652
              case None => sleep(); loop(pending, running, results)
48425
0d95980e9aae parallel scheduling of jobs;
wenzelm
parents: 48424
diff changeset
   653
            }
50367
69efe72886e3 allow to terminate jobs via Progress;
wenzelm
parents: 50366
diff changeset
   654
            ///}}}
48425
0d95980e9aae parallel scheduling of jobs;
wenzelm
parents: 48424
diff changeset
   655
          case None => sleep(); loop(pending, running, results)
48373
527e2bad7cca further imitation of "usedir" shell script;
wenzelm
parents: 48370
diff changeset
   656
        }
51253
ab4c296a1e60 clarified Progress.stopped: rising edge only;
wenzelm
parents: 51252
diff changeset
   657
      }
48425
0d95980e9aae parallel scheduling of jobs;
wenzelm
parents: 48424
diff changeset
   658
    }
0d95980e9aae parallel scheduling of jobs;
wenzelm
parents: 48424
diff changeset
   659
51220
e140c8fa485a recover timing information from old log files;
wenzelm
parents: 51218
diff changeset
   660
e140c8fa485a recover timing information from old log files;
wenzelm
parents: 51218
diff changeset
   661
    /* build results */
e140c8fa485a recover timing information from old log files;
wenzelm
parents: 51218
diff changeset
   662
62641
0b1b7465f2ef always build with full results;
wenzelm
parents: 62638
diff changeset
   663
    val results0 =
48583
ed975dbb16ca tuned messages;
wenzelm
parents: 48579
diff changeset
   664
      if (deps.is_empty) {
65827
wenzelm
parents: 65532
diff changeset
   665
        progress.echo_warning("Nothing to build")
50707
5b2bf7611662 maintain session index on Scala side, for more determistic results;
wenzelm
parents: 50686
diff changeset
   666
        Map.empty[String, Result]
48583
ed975dbb16ca tuned messages;
wenzelm
parents: 48579
diff changeset
   667
      }
ed975dbb16ca tuned messages;
wenzelm
parents: 48579
diff changeset
   668
      else loop(queue, Map.empty, Map.empty)
ed975dbb16ca tuned messages;
wenzelm
parents: 48579
diff changeset
   669
62641
0b1b7465f2ef always build with full results;
wenzelm
parents: 62638
diff changeset
   670
    val results =
64265
8eb6365f5916 isabelle build -N;
wenzelm
parents: 64173
diff changeset
   671
      new Results(
8eb6365f5916 isabelle build -N;
wenzelm
parents: 64173
diff changeset
   672
        (for ((name, result) <- results0.iterator)
8eb6365f5916 isabelle build -N;
wenzelm
parents: 64173
diff changeset
   673
          yield (name, (result.process, result.info))).toMap)
62641
0b1b7465f2ef always build with full results;
wenzelm
parents: 62638
diff changeset
   674
0b1b7465f2ef always build with full results;
wenzelm
parents: 62638
diff changeset
   675
    if (results.rc != 0 && (verbose || !no_build)) {
0b1b7465f2ef always build with full results;
wenzelm
parents: 62638
diff changeset
   676
      val unfinished =
0b1b7465f2ef always build with full results;
wenzelm
parents: 62638
diff changeset
   677
        (for {
0b1b7465f2ef always build with full results;
wenzelm
parents: 62638
diff changeset
   678
          name <- results.sessions.iterator
0b1b7465f2ef always build with full results;
wenzelm
parents: 62638
diff changeset
   679
          if !results(name).ok
0b1b7465f2ef always build with full results;
wenzelm
parents: 62638
diff changeset
   680
         } yield name).toList.sorted
0b1b7465f2ef always build with full results;
wenzelm
parents: 62638
diff changeset
   681
      progress.echo("Unfinished session(s): " + commas(unfinished))
0b1b7465f2ef always build with full results;
wenzelm
parents: 62638
diff changeset
   682
    }
0b1b7465f2ef always build with full results;
wenzelm
parents: 62638
diff changeset
   683
51418
7b8ce8403340 more accurate handling of global browser info at the very end (without races), subject to no_build and info.browser_info;
wenzelm
parents: 51402
diff changeset
   684
7b8ce8403340 more accurate handling of global browser info at the very end (without races), subject to no_build and info.browser_info;
wenzelm
parents: 51402
diff changeset
   685
    /* global browser info */
7b8ce8403340 more accurate handling of global browser info at the very end (without races), subject to no_build and info.browser_info;
wenzelm
parents: 51402
diff changeset
   686
7b8ce8403340 more accurate handling of global browser info at the very end (without races), subject to no_build and info.browser_info;
wenzelm
parents: 51402
diff changeset
   687
    if (!no_build) {
7b8ce8403340 more accurate handling of global browser info at the very end (without races), subject to no_build and info.browser_info;
wenzelm
parents: 51402
diff changeset
   688
      val browser_chapters =
7b8ce8403340 more accurate handling of global browser info at the very end (without races), subject to no_build and info.browser_info;
wenzelm
parents: 51402
diff changeset
   689
        (for {
62641
0b1b7465f2ef always build with full results;
wenzelm
parents: 62638
diff changeset
   690
          (name, result) <- results0.iterator
62944
3ee643c5ed00 more standard session build process, including browser_info;
wenzelm
parents: 62902
diff changeset
   691
          if result.ok
65415
8cd54b18b68b clarified signature: tree structure is not essential;
wenzelm
parents: 65406
diff changeset
   692
          info = full_sessions(name)
51418
7b8ce8403340 more accurate handling of global browser info at the very end (without races), subject to no_build and info.browser_info;
wenzelm
parents: 51402
diff changeset
   693
          if info.options.bool("browser_info")
7b8ce8403340 more accurate handling of global browser info at the very end (without races), subject to no_build and info.browser_info;
wenzelm
parents: 51402
diff changeset
   694
        } yield (info.chapter, (name, info.description))).toList.groupBy(_._1).
7b8ce8403340 more accurate handling of global browser info at the very end (without races), subject to no_build and info.browser_info;
wenzelm
parents: 51402
diff changeset
   695
            map({ case (chapter, es) => (chapter, es.map(_._2)) }).filterNot(_._2.isEmpty)
7b8ce8403340 more accurate handling of global browser info at the very end (without races), subject to no_build and info.browser_info;
wenzelm
parents: 51402
diff changeset
   696
7b8ce8403340 more accurate handling of global browser info at the very end (without races), subject to no_build and info.browser_info;
wenzelm
parents: 51402
diff changeset
   697
      for ((chapter, entries) <- browser_chapters)
62632
cd991ba01ffd clarified modules;
wenzelm
parents: 62631
diff changeset
   698
        Present.update_chapter_index(store.browser_info, chapter, entries)
51418
7b8ce8403340 more accurate handling of global browser info at the very end (without races), subject to no_build and info.browser_info;
wenzelm
parents: 51402
diff changeset
   699
62632
cd991ba01ffd clarified modules;
wenzelm
parents: 62631
diff changeset
   700
      if (browser_chapters.nonEmpty) Present.make_global_index(store.browser_info)
51418
7b8ce8403340 more accurate handling of global browser info at the very end (without races), subject to no_build and info.browser_info;
wenzelm
parents: 51402
diff changeset
   701
    }
7b8ce8403340 more accurate handling of global browser info at the very end (without races), subject to no_build and info.browser_info;
wenzelm
parents: 51402
diff changeset
   702
62641
0b1b7465f2ef always build with full results;
wenzelm
parents: 62638
diff changeset
   703
    results
48341
752de4e10162 tuned source structure;
wenzelm
parents: 48340
diff changeset
   704
  }
752de4e10162 tuned source structure;
wenzelm
parents: 48340
diff changeset
   705
752de4e10162 tuned source structure;
wenzelm
parents: 48340
diff changeset
   706
62833
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   707
  /* Isabelle tool wrapper */
48341
752de4e10162 tuned source structure;
wenzelm
parents: 48340
diff changeset
   708
62833
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   709
  val isabelle_tool = Isabelle_Tool("build", "build and manage Isabelle sessions", args =>
48341
752de4e10162 tuned source structure;
wenzelm
parents: 48340
diff changeset
   710
  {
62833
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   711
    val build_options = Word.explode(Isabelle_System.getenv("ISABELLE_BUILD_OPTIONS"))
62590
0c837beeb5e7 upgrade "isabelle build" to Isabelle/Scala;
wenzelm
parents: 62573
diff changeset
   712
66737
2edc0c42c883 option -B for "isabelle build" and "isabelle imports";
wenzelm
parents: 66736
diff changeset
   713
    var base_sessions: List[String] = Nil
62833
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   714
    var select_dirs: List[Path] = Nil
64265
8eb6365f5916 isabelle build -N;
wenzelm
parents: 64173
diff changeset
   715
    var numa_shuffling = false
65308
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   716
    var pide = false
62833
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   717
    var requirements = false
66745
e7ac579b883c option -S for "isabelle build";
wenzelm
parents: 66744
diff changeset
   718
    var soft_build = false
62833
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   719
    var exclude_session_groups: List[String] = Nil
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   720
    var all_sessions = false
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   721
    var build_heap = false
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   722
    var clean_build = false
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   723
    var dirs: List[Path] = Nil
66841
5c32a072ca8b added isablle build option -f;
wenzelm
parents: 66822
diff changeset
   724
    var fresh_build = false
62833
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   725
    var session_groups: List[String] = Nil
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   726
    var max_jobs = 1
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   727
    var check_keywords: Set[String] = Set.empty
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   728
    var list_files = false
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   729
    var no_build = false
67847
c61acb4855b6 tuned signature;
wenzelm
parents: 67846
diff changeset
   730
    var options = Options.init(opts = build_options)
62833
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   731
    var system_mode = false
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   732
    var verbose = false
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   733
    var exclude_sessions: List[String] = Nil
62590
0c837beeb5e7 upgrade "isabelle build" to Isabelle/Scala;
wenzelm
parents: 62573
diff changeset
   734
62833
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   735
    val getopts = Getopts("""
62590
0c837beeb5e7 upgrade "isabelle build" to Isabelle/Scala;
wenzelm
parents: 62573
diff changeset
   736
Usage: isabelle build [OPTIONS] [SESSIONS ...]
0c837beeb5e7 upgrade "isabelle build" to Isabelle/Scala;
wenzelm
parents: 62573
diff changeset
   737
0c837beeb5e7 upgrade "isabelle build" to Isabelle/Scala;
wenzelm
parents: 62573
diff changeset
   738
  Options are:
66737
2edc0c42c883 option -B for "isabelle build" and "isabelle imports";
wenzelm
parents: 66736
diff changeset
   739
    -B NAME      include session NAME and all descendants
62590
0c837beeb5e7 upgrade "isabelle build" to Isabelle/Scala;
wenzelm
parents: 62573
diff changeset
   740
    -D DIR       include session directory and select its sessions
64265
8eb6365f5916 isabelle build -N;
wenzelm
parents: 64173
diff changeset
   741
    -N           cyclic shuffling of NUMA CPU nodes (performance tuning)
65308
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   742
    -P           build via PIDE protocol
62590
0c837beeb5e7 upgrade "isabelle build" to Isabelle/Scala;
wenzelm
parents: 62573
diff changeset
   743
    -R           operate on requirements of selected sessions
66745
e7ac579b883c option -S for "isabelle build";
wenzelm
parents: 66744
diff changeset
   744
    -S           soft build: only observe changes of sources, not heap images
62590
0c837beeb5e7 upgrade "isabelle build" to Isabelle/Scala;
wenzelm
parents: 62573
diff changeset
   745
    -X NAME      exclude sessions from group NAME and all descendants
0c837beeb5e7 upgrade "isabelle build" to Isabelle/Scala;
wenzelm
parents: 62573
diff changeset
   746
    -a           select all sessions
0c837beeb5e7 upgrade "isabelle build" to Isabelle/Scala;
wenzelm
parents: 62573
diff changeset
   747
    -b           build heap images
0c837beeb5e7 upgrade "isabelle build" to Isabelle/Scala;
wenzelm
parents: 62573
diff changeset
   748
    -c           clean build
0c837beeb5e7 upgrade "isabelle build" to Isabelle/Scala;
wenzelm
parents: 62573
diff changeset
   749
    -d DIR       include session directory
66841
5c32a072ca8b added isablle build option -f;
wenzelm
parents: 66822
diff changeset
   750
    -f           fresh build
62590
0c837beeb5e7 upgrade "isabelle build" to Isabelle/Scala;
wenzelm
parents: 62573
diff changeset
   751
    -g NAME      select session group NAME
0c837beeb5e7 upgrade "isabelle build" to Isabelle/Scala;
wenzelm
parents: 62573
diff changeset
   752
    -j INT       maximum number of parallel jobs (default 1)
0c837beeb5e7 upgrade "isabelle build" to Isabelle/Scala;
wenzelm
parents: 62573
diff changeset
   753
    -k KEYWORD   check theory sources for conflicts with proposed keywords
0c837beeb5e7 upgrade "isabelle build" to Isabelle/Scala;
wenzelm
parents: 62573
diff changeset
   754
    -l           list session source files
0c837beeb5e7 upgrade "isabelle build" to Isabelle/Scala;
wenzelm
parents: 62573
diff changeset
   755
    -n           no build -- test dependencies only
0c837beeb5e7 upgrade "isabelle build" to Isabelle/Scala;
wenzelm
parents: 62573
diff changeset
   756
    -o OPTION    override Isabelle system OPTION (via NAME=VAL or NAME)
0c837beeb5e7 upgrade "isabelle build" to Isabelle/Scala;
wenzelm
parents: 62573
diff changeset
   757
    -s           system build mode: produce output in ISABELLE_HOME
0c837beeb5e7 upgrade "isabelle build" to Isabelle/Scala;
wenzelm
parents: 62573
diff changeset
   758
    -v           verbose
0c837beeb5e7 upgrade "isabelle build" to Isabelle/Scala;
wenzelm
parents: 62573
diff changeset
   759
    -x NAME      exclude session NAME and all descendants
0c837beeb5e7 upgrade "isabelle build" to Isabelle/Scala;
wenzelm
parents: 62573
diff changeset
   760
62596
cf79f8866bc3 tuned messages;
wenzelm
parents: 62595
diff changeset
   761
  Build and manage Isabelle sessions, depending on implicit settings:
cf79f8866bc3 tuned messages;
wenzelm
parents: 62595
diff changeset
   762
64455
2cb3e2c2ce8b extra newline as for other tools;
wenzelm
parents: 64265
diff changeset
   763
""" + Library.prefix_lines("  ", Build_Log.Settings.show()) + "\n",
66737
2edc0c42c883 option -B for "isabelle build" and "isabelle imports";
wenzelm
parents: 66736
diff changeset
   764
      "B:" -> (arg => base_sessions = base_sessions ::: List(arg)),
62833
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   765
      "D:" -> (arg => select_dirs = select_dirs ::: List(Path.explode(arg))),
64265
8eb6365f5916 isabelle build -N;
wenzelm
parents: 64173
diff changeset
   766
      "N" -> (_ => numa_shuffling = true),
65308
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   767
      "P" -> (_ => pide = true),
62833
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   768
      "R" -> (_ => requirements = true),
66745
e7ac579b883c option -S for "isabelle build";
wenzelm
parents: 66744
diff changeset
   769
      "S" -> (_ => soft_build = true),
62833
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   770
      "X:" -> (arg => exclude_session_groups = exclude_session_groups ::: List(arg)),
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   771
      "a" -> (_ => all_sessions = true),
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   772
      "b" -> (_ => build_heap = true),
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   773
      "c" -> (_ => clean_build = true),
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   774
      "d:" -> (arg => dirs = dirs ::: List(Path.explode(arg))),
66841
5c32a072ca8b added isablle build option -f;
wenzelm
parents: 66822
diff changeset
   775
      "f" -> (_ => fresh_build = true),
62833
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   776
      "g:" -> (arg => session_groups = session_groups ::: List(arg)),
63805
c272680df665 clarified modules;
wenzelm
parents: 63685
diff changeset
   777
      "j:" -> (arg => max_jobs = Value.Int.parse(arg)),
62833
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   778
      "k:" -> (arg => check_keywords = check_keywords + arg),
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   779
      "l" -> (_ => list_files = true),
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   780
      "n" -> (_ => no_build = true),
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   781
      "o:" -> (arg => options = options + arg),
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   782
      "s" -> (_ => system_mode = true),
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   783
      "v" -> (_ => verbose = true),
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   784
      "x:" -> (arg => exclude_sessions = exclude_sessions ::: List(arg)))
62590
0c837beeb5e7 upgrade "isabelle build" to Isabelle/Scala;
wenzelm
parents: 62573
diff changeset
   785
62833
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   786
    val sessions = getopts(args)
62590
0c837beeb5e7 upgrade "isabelle build" to Isabelle/Scala;
wenzelm
parents: 62573
diff changeset
   787
64115
wenzelm
parents: 64082
diff changeset
   788
    val progress = new Console_Progress(verbose = verbose)
62590
0c837beeb5e7 upgrade "isabelle build" to Isabelle/Scala;
wenzelm
parents: 62573
diff changeset
   789
64140
96d398871124 modernized date format;
wenzelm
parents: 64115
diff changeset
   790
    val start_date = Date.now()
96d398871124 modernized date format;
wenzelm
parents: 64115
diff changeset
   791
62833
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   792
    if (verbose) {
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   793
      progress.echo(
64155
646c4d6a6a02 tuned signature;
wenzelm
parents: 64140
diff changeset
   794
        "Started at " + Build_Log.print_date(start_date) +
64140
96d398871124 modernized date format;
wenzelm
parents: 64115
diff changeset
   795
          " (" + Isabelle_System.getenv("ML_IDENTIFIER") + " on " + Isabelle_System.hostname() +")")
64081
38bb09ed965b more uniform treatment of settings;
wenzelm
parents: 64080
diff changeset
   796
      progress.echo(Build_Log.Settings.show() + "\n")
62833
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   797
    }
62590
0c837beeb5e7 upgrade "isabelle build" to Isabelle/Scala;
wenzelm
parents: 62573
diff changeset
   798
62833
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   799
    val results =
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   800
      progress.interrupt_handler {
67846
wenzelm
parents: 67835
diff changeset
   801
        build(options,
wenzelm
parents: 67835
diff changeset
   802
          progress = progress,
65832
2fb85623c386 implicitly check for unknown files (not part of a Mercurial repository);
wenzelm
parents: 65831
diff changeset
   803
          check_unknown_files = Mercurial.is_repository(Path.explode("~~")),
63224
78e93610a3c8 more flexible build_selection;
wenzelm
parents: 63082
diff changeset
   804
          build_heap = build_heap,
78e93610a3c8 more flexible build_selection;
wenzelm
parents: 63082
diff changeset
   805
          clean_build = clean_build,
78e93610a3c8 more flexible build_selection;
wenzelm
parents: 63082
diff changeset
   806
          dirs = dirs,
78e93610a3c8 more flexible build_selection;
wenzelm
parents: 63082
diff changeset
   807
          select_dirs = select_dirs,
65831
3b197547c1d4 prefer explicit progress channel;
wenzelm
parents: 65828
diff changeset
   808
          numa_shuffling = NUMA.enabled_warning(progress, numa_shuffling),
63224
78e93610a3c8 more flexible build_selection;
wenzelm
parents: 63082
diff changeset
   809
          max_jobs = max_jobs,
78e93610a3c8 more flexible build_selection;
wenzelm
parents: 63082
diff changeset
   810
          list_files = list_files,
78e93610a3c8 more flexible build_selection;
wenzelm
parents: 63082
diff changeset
   811
          check_keywords = check_keywords,
66841
5c32a072ca8b added isablle build option -f;
wenzelm
parents: 66822
diff changeset
   812
          fresh_build = fresh_build,
63224
78e93610a3c8 more flexible build_selection;
wenzelm
parents: 63082
diff changeset
   813
          no_build = no_build,
66745
e7ac579b883c option -S for "isabelle build";
wenzelm
parents: 66744
diff changeset
   814
          soft_build = soft_build,
63224
78e93610a3c8 more flexible build_selection;
wenzelm
parents: 63082
diff changeset
   815
          system_mode = system_mode,
78e93610a3c8 more flexible build_selection;
wenzelm
parents: 63082
diff changeset
   816
          verbose = verbose,
65308
8f58102afa22 support PIDE option (inactive);
wenzelm
parents: 65307
diff changeset
   817
          pide = pide,
63224
78e93610a3c8 more flexible build_selection;
wenzelm
parents: 63082
diff changeset
   818
          requirements = requirements,
78e93610a3c8 more flexible build_selection;
wenzelm
parents: 63082
diff changeset
   819
          all_sessions = all_sessions,
66737
2edc0c42c883 option -B for "isabelle build" and "isabelle imports";
wenzelm
parents: 66736
diff changeset
   820
          base_sessions = base_sessions,
63224
78e93610a3c8 more flexible build_selection;
wenzelm
parents: 63082
diff changeset
   821
          exclude_session_groups = exclude_session_groups,
78e93610a3c8 more flexible build_selection;
wenzelm
parents: 63082
diff changeset
   822
          exclude_sessions = exclude_sessions,
78e93610a3c8 more flexible build_selection;
wenzelm
parents: 63082
diff changeset
   823
          session_groups = session_groups,
78e93610a3c8 more flexible build_selection;
wenzelm
parents: 63082
diff changeset
   824
          sessions = sessions)
62833
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   825
      }
64140
96d398871124 modernized date format;
wenzelm
parents: 64115
diff changeset
   826
    val end_date = Date.now()
96d398871124 modernized date format;
wenzelm
parents: 64115
diff changeset
   827
    val elapsed_time = end_date.time - start_date.time
62590
0c837beeb5e7 upgrade "isabelle build" to Isabelle/Scala;
wenzelm
parents: 62573
diff changeset
   828
62833
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   829
    if (verbose) {
64155
646c4d6a6a02 tuned signature;
wenzelm
parents: 64140
diff changeset
   830
      progress.echo("\nFinished at " + Build_Log.print_date(end_date))
62833
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   831
    }
62590
0c837beeb5e7 upgrade "isabelle build" to Isabelle/Scala;
wenzelm
parents: 62573
diff changeset
   832
62833
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   833
    val total_timing =
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   834
      (Timing.zero /: results.sessions.iterator.map(a => results(a).timing))(_ + _).
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   835
        copy(elapsed = elapsed_time)
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   836
    progress.echo(total_timing.message_resources)
62590
0c837beeb5e7 upgrade "isabelle build" to Isabelle/Scala;
wenzelm
parents: 62573
diff changeset
   837
62833
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   838
    sys.exit(results.rc)
29dfa2ed9343 prefer internal tool;
wenzelm
parents: 62825
diff changeset
   839
  })
68305
5321218147d3 clarified signature;
wenzelm
parents: 68292
diff changeset
   840
5321218147d3 clarified signature;
wenzelm
parents: 68292
diff changeset
   841
5321218147d3 clarified signature;
wenzelm
parents: 68292
diff changeset
   842
  /* build logic image */
5321218147d3 clarified signature;
wenzelm
parents: 68292
diff changeset
   843
5321218147d3 clarified signature;
wenzelm
parents: 68292
diff changeset
   844
  def build_logic(options: Options, logic: String,
5321218147d3 clarified signature;
wenzelm
parents: 68292
diff changeset
   845
    progress: Progress = No_Progress,
5321218147d3 clarified signature;
wenzelm
parents: 68292
diff changeset
   846
    build_heap: Boolean = false,
5321218147d3 clarified signature;
wenzelm
parents: 68292
diff changeset
   847
    dirs: List[Path] = Nil,
69540
a1e8bcda8cec tuned signature;
wenzelm
parents: 69369
diff changeset
   848
    system_mode: Boolean = false,
a1e8bcda8cec tuned signature;
wenzelm
parents: 69369
diff changeset
   849
    strict: Boolean = false): Int =
68305
5321218147d3 clarified signature;
wenzelm
parents: 68292
diff changeset
   850
  {
69540
a1e8bcda8cec tuned signature;
wenzelm
parents: 69369
diff changeset
   851
    val rc =
a1e8bcda8cec tuned signature;
wenzelm
parents: 69369
diff changeset
   852
      if (build(options, build_heap = build_heap, no_build = true, dirs = dirs,
a1e8bcda8cec tuned signature;
wenzelm
parents: 69369
diff changeset
   853
          system_mode = system_mode, sessions = List(logic)).ok) 0
a1e8bcda8cec tuned signature;
wenzelm
parents: 69369
diff changeset
   854
      else {
a1e8bcda8cec tuned signature;
wenzelm
parents: 69369
diff changeset
   855
        progress.echo("Build started for Isabelle/" + logic + " ...")
a1e8bcda8cec tuned signature;
wenzelm
parents: 69369
diff changeset
   856
        Build.build(options, progress = progress, build_heap = build_heap, dirs = dirs,
a1e8bcda8cec tuned signature;
wenzelm
parents: 69369
diff changeset
   857
          system_mode = system_mode, sessions = List(logic)).rc
a1e8bcda8cec tuned signature;
wenzelm
parents: 69369
diff changeset
   858
      }
a1e8bcda8cec tuned signature;
wenzelm
parents: 69369
diff changeset
   859
a1e8bcda8cec tuned signature;
wenzelm
parents: 69369
diff changeset
   860
    if (strict && rc != 0) error("Failed to build Isabelle/" + logic) else rc
68305
5321218147d3 clarified signature;
wenzelm
parents: 68292
diff changeset
   861
  }
48276
4bd480886813 basic setup for Isabelle build tool;
wenzelm
parents:
diff changeset
   862
}