src/Pure/Tools/build.scala
author wenzelm
Sat May 05 13:56:51 2018 +0200 (12 months ago)
changeset 68086 9e1c670301b8
parent 67852 f701a1d5d852
child 68088 0763d4eb3ebc
permissions -rw-r--r--
cleanup session output before starting build job;
tuned signature;
wenzelm@50686
     1
/*  Title:      Pure/Tools/build.scala
wenzelm@48276
     2
    Author:     Makarius
wenzelm@57923
     3
    Options:    :folding=explicit:
wenzelm@48276
     4
wenzelm@48276
     5
Build and manage Isabelle sessions.
wenzelm@48276
     6
*/
wenzelm@48276
     7
wenzelm@48276
     8
package isabelle
wenzelm@48276
     9
wenzelm@48276
    10
wenzelm@48676
    11
import scala.collection.SortedSet
wenzelm@48340
    12
import scala.annotation.tailrec
wenzelm@48337
    13
wenzelm@48335
    14
wenzelm@48276
    15
object Build
wenzelm@48276
    16
{
wenzelm@62631
    17
  /** auxiliary **/
wenzelm@48424
    18
wenzelm@65291
    19
  /* persistent build info */
wenzelm@65291
    20
wenzelm@65291
    21
  sealed case class Session_Info(
wenzelm@66749
    22
    sources: String,
wenzelm@65291
    23
    input_heaps: List[String],
wenzelm@65291
    24
    output_heap: Option[String],
wenzelm@65291
    25
    return_code: Int)
wenzelm@66747
    26
  {
wenzelm@66747
    27
    def ok: Boolean = return_code == 0
wenzelm@66747
    28
  }
wenzelm@65291
    29
wenzelm@65291
    30
wenzelm@65289
    31
  /* queue with scheduling information */
wenzelm@48676
    32
wenzelm@62631
    33
  private object Queue
wenzelm@48676
    34
  {
wenzelm@68086
    35
    type Timings = (List[Properties.T], Double)
wenzelm@68086
    36
wenzelm@68086
    37
    def load_timings(progress: Progress, store: Sessions.Store, name: String): Timings =
wenzelm@65289
    38
    {
wenzelm@68086
    39
      val no_timings: Timings = (Nil, 0.0)
wenzelm@65289
    40
wenzelm@65291
    41
      store.find_database(name) match {
wenzelm@65291
    42
        case None => no_timings
wenzelm@65291
    43
        case Some(database) =>
wenzelm@65291
    44
          def ignore_error(msg: String) =
wenzelm@65291
    45
          {
wenzelm@65831
    46
            progress.echo_warning("Ignoring bad database: " +
wenzelm@65365
    47
              database.expand + (if (msg == "") "" else "\n" + msg))
wenzelm@65291
    48
            no_timings
wenzelm@65291
    49
          }
wenzelm@65291
    50
          try {
wenzelm@65291
    51
            using(SQLite.open_database(database))(db =>
wenzelm@65291
    52
            {
wenzelm@65935
    53
              val command_timings = store.read_command_timings(db, name)
wenzelm@65935
    54
              val session_timing =
wenzelm@65935
    55
                store.read_session_timing(db, name) match {
wenzelm@65935
    56
                  case Markup.Elapsed(t) => t
wenzelm@65935
    57
                  case _ => 0.0
wenzelm@65935
    58
                }
wenzelm@65935
    59
              (command_timings, session_timing)
wenzelm@65291
    60
            })
wenzelm@65291
    61
          }
wenzelm@65291
    62
          catch {
wenzelm@65291
    63
            case ERROR(msg) => ignore_error(msg)
wenzelm@65291
    64
            case exn: java.lang.Error => ignore_error(Exn.message(exn))
wenzelm@65291
    65
            case _: XML.Error => ignore_error("")
wenzelm@65291
    66
          }
wenzelm@65289
    67
      }
wenzelm@65289
    68
    }
wenzelm@65289
    69
wenzelm@67052
    70
    def apply(progress: Progress, sessions: Sessions.Structure, store: Sessions.Store): Queue =
wenzelm@48676
    71
    {
wenzelm@65420
    72
      val graph = sessions.build_graph
wenzelm@65415
    73
      val names = graph.keys
wenzelm@51220
    74
wenzelm@65831
    75
      val timings = names.map(name => (name, load_timings(progress, store, name)))
wenzelm@51220
    76
      val command_timings =
wenzelm@51220
    77
        Map(timings.map({ case (name, (ts, _)) => (name, ts) }): _*).withDefaultValue(Nil)
wenzelm@51220
    78
      val session_timing =
wenzelm@51220
    79
        Map(timings.map({ case (name, (_, t)) => (name, t) }): _*).withDefaultValue(0.0)
wenzelm@48678
    80
wenzelm@48678
    81
      def outdegree(name: String): Int = graph.imm_succs(name).size
wenzelm@48678
    82
wenzelm@48678
    83
      object Ordering extends scala.math.Ordering[String]
wenzelm@48678
    84
      {
wenzelm@51227
    85
        def compare_timing(name1: String, name2: String): Int =
wenzelm@51227
    86
        {
wenzelm@51227
    87
          val t1 = session_timing(name1)
wenzelm@51227
    88
          val t2 = session_timing(name2)
wenzelm@51227
    89
          if (t1 == 0.0 || t2 == 0.0) 0
wenzelm@51227
    90
          else t1 compare t2
wenzelm@51227
    91
        }
wenzelm@51227
    92
wenzelm@48678
    93
        def compare(name1: String, name2: String): Int =
wenzelm@51229
    94
          outdegree(name2) compare outdegree(name1) match {
wenzelm@48678
    95
            case 0 =>
wenzelm@51229
    96
              compare_timing(name2, name1) match {
wenzelm@51220
    97
                case 0 =>
wenzelm@65415
    98
                  sessions(name2).timeout compare sessions(name1).timeout match {
wenzelm@51220
    99
                    case 0 => name1 compare name2
wenzelm@51220
   100
                    case ord => ord
wenzelm@51220
   101
                  }
wenzelm@48678
   102
                case ord => ord
wenzelm@48678
   103
              }
wenzelm@48678
   104
            case ord => ord
wenzelm@48678
   105
          }
wenzelm@48678
   106
      }
wenzelm@48678
   107
wenzelm@65415
   108
      new Queue(graph, SortedSet(names: _*)(Ordering), command_timings)
wenzelm@48676
   109
    }
wenzelm@48676
   110
  }
wenzelm@48676
   111
wenzelm@65314
   112
  private class Queue(
wenzelm@62631
   113
    graph: Graph[String, Sessions.Info],
wenzelm@51220
   114
    order: SortedSet[String],
wenzelm@51220
   115
    val command_timings: String => List[Properties.T])
wenzelm@48676
   116
  {
wenzelm@48676
   117
    def is_inner(name: String): Boolean = !graph.is_maximal(name)
wenzelm@48676
   118
wenzelm@48676
   119
    def is_empty: Boolean = graph.is_empty
wenzelm@48676
   120
wenzelm@51227
   121
    def - (name: String): Queue =
wenzelm@51227
   122
      new Queue(graph.del_node(name),
wenzelm@67011
   123
        order - name,  // FIXME scala-2.10.0 .. 2.12.4 TreeSet problem!?
wenzelm@51227
   124
        command_timings)
wenzelm@48676
   125
wenzelm@62631
   126
    def dequeue(skip: String => Boolean): Option[(String, Sessions.Info)] =
wenzelm@48676
   127
    {
wenzelm@51227
   128
      val it = order.iterator.dropWhile(name =>
wenzelm@51227
   129
        skip(name)
wenzelm@67011
   130
          || !graph.defined(name)  // FIXME scala-2.10.0 .. 2.12.4 TreeSet problem!?
wenzelm@51227
   131
          || !graph.is_minimal(name))
wenzelm@48680
   132
      if (it.hasNext) { val name = it.next; Some((name, graph.get_node(name))) }
wenzelm@48676
   133
      else None
wenzelm@48676
   134
    }
wenzelm@48676
   135
  }
wenzelm@48676
   136
wenzelm@48676
   137
wenzelm@65313
   138
  /* PIDE protocol handler */
wenzelm@65313
   139
wenzelm@65313
   140
  class Handler(progress: Progress, session: Session, session_name: String)
wenzelm@65313
   141
    extends Session.Protocol_Handler
wenzelm@65313
   142
  {
wenzelm@65313
   143
    val result_error: Promise[String] = Future.promise
wenzelm@65313
   144
wenzelm@65313
   145
    override def exit() { result_error.cancel }
wenzelm@65313
   146
wenzelm@65313
   147
    private def build_session_finished(msg: Prover.Protocol_Output): Boolean =
wenzelm@65313
   148
    {
wenzelm@65313
   149
      val error_message =
wenzelm@65344
   150
        try { Pretty.string_of(Symbol.decode_yxml(msg.text)) }
wenzelm@65313
   151
        catch { case ERROR(msg) => msg }
wenzelm@65313
   152
      result_error.fulfill(error_message)
wenzelm@65313
   153
      session.send_stop()
wenzelm@65313
   154
      true
wenzelm@65313
   155
    }
wenzelm@65313
   156
wenzelm@65313
   157
    private def loading_theory(msg: Prover.Protocol_Output): Boolean =
wenzelm@65313
   158
      msg.properties match {
wenzelm@65313
   159
        case Markup.Loading_Theory(name) =>
wenzelm@65313
   160
          progress.theory(session_name, name)
wenzelm@65313
   161
          true
wenzelm@65313
   162
        case _ => false
wenzelm@65313
   163
      }
wenzelm@65313
   164
wenzelm@65313
   165
    val functions =
wenzelm@65313
   166
      List(
wenzelm@65313
   167
        Markup.BUILD_SESSION_FINISHED -> build_session_finished _,
wenzelm@65313
   168
        Markup.LOADING_THEORY -> loading_theory _)
wenzelm@65313
   169
  }
wenzelm@65313
   170
wenzelm@65313
   171
wenzelm@65308
   172
  /* job: running prover process */
wenzelm@48341
   173
wenzelm@65308
   174
  private class Job(progress: Progress,
wenzelm@65308
   175
    name: String,
wenzelm@65308
   176
    val info: Sessions.Info,
wenzelm@67052
   177
    sessions: Sessions.Structure,
wenzelm@65313
   178
    deps: Sessions.Deps,
wenzelm@65308
   179
    store: Sessions.Store,
wenzelm@65308
   180
    do_output: Boolean,
wenzelm@65308
   181
    verbose: Boolean,
wenzelm@65308
   182
    pide: Boolean,
wenzelm@65308
   183
    val numa_node: Option[Int],
wenzelm@65308
   184
    command_timings: List[Properties.T])
wenzelm@48418
   185
  {
wenzelm@62633
   186
    val output = store.output_dir + Path.basic(name)
wenzelm@48674
   187
    def output_path: Option[Path] = if (do_output) Some(output) else None
wenzelm@48674
   188
wenzelm@65312
   189
    val options =
wenzelm@65312
   190
      numa_node match {
wenzelm@65312
   191
        case None => info.options
wenzelm@65312
   192
        case Some(n) => info.options.string("ML_process_policy") = NUMA.policy(n)
wenzelm@65312
   193
      }
wenzelm@65312
   194
wenzelm@59445
   195
    private val graph_file = Isabelle_System.tmp_file("session_graph", "pdf")
wenzelm@66822
   196
    isabelle.graphview.Graph_File.write(options, graph_file, deps(name).session_graph_display)
wenzelm@59445
   197
wenzelm@62573
   198
    private val future_result: Future[Process_Result] =
wenzelm@61559
   199
      Future.thread("build") {
wenzelm@65308
   200
        val parent = info.parent.getOrElse("")
wenzelm@65441
   201
        val base = deps(name)
wenzelm@65308
   202
        val args_yxml =
wenzelm@65308
   203
          YXML.string_of_body(
wenzelm@62944
   204
            {
wenzelm@62944
   205
              import XML.Encode._
wenzelm@62944
   206
              pair(list(pair(string, int)), pair(list(properties), pair(bool, pair(bool,
wenzelm@62944
   207
                pair(Path.encode, pair(list(pair(Path.encode, Path.encode)), pair(string,
wenzelm@65307
   208
                pair(string, pair(string, pair(string, pair(Path.encode,
wenzelm@65517
   209
                pair(list(pair(Options.encode, list(pair(string, properties)))),
wenzelm@67493
   210
                pair(list(pair(string, properties)), pair(list(string),
wenzelm@67493
   211
                pair(list(pair(string, string)),
wenzelm@67471
   212
                pair(list(string), pair(list(pair(string, string)), list(string))))))))))))))))))(
wenzelm@62944
   213
              (Symbol.codes, (command_timings, (do_output, (verbose,
wenzelm@62944
   214
                (store.browser_info, (info.document_files, (File.standard_path(graph_file),
wenzelm@65307
   215
                (parent, (info.chapter, (name, (Path.current,
wenzelm@67471
   216
                (info.theories, (base.known.sessions.toList, (base.doc_names,
wenzelm@67471
   217
                (base.global_theories.toList, (base.loaded_theories.keys, (base.dest_known_theories,
wenzelm@67471
   218
                info.bibtex_entries.map(_.info)))))))))))))))))))
wenzelm@65308
   219
            })
wenzelm@65308
   220
wenzelm@65308
   221
        val env =
wenzelm@65308
   222
          Isabelle_System.settings() +
wenzelm@65312
   223
            ("ISABELLE_ML_DEBUGGER" -> options.bool("ML_debugger").toString)
wenzelm@65308
   224
wenzelm@65308
   225
        def save_heap: String =
wenzelm@66972
   226
          (if (info.theories.isEmpty) "" else "ML_Heap.share_common_data (); ") +
wenzelm@66972
   227
            "ML_Heap.save_child " + ML_Syntax.print_string_bytes(File.platform_path(output))
wenzelm@62944
   228
wenzelm@65360
   229
        if (pide && !Sessions.is_pure(name)) {
wenzelm@65532
   230
          val resources = new Resources(deps(parent))
wenzelm@65313
   231
          val session = new Session(options, resources)
wenzelm@65313
   232
          val handler = new Handler(progress, session, name)
wenzelm@65315
   233
          session.init_protocol_handler(handler)
wenzelm@65313
   234
wenzelm@65317
   235
          val session_result = Future.promise[Process_Result]
wenzelm@65313
   236
wenzelm@65313
   237
          Isabelle_Process.start(session, options, logic = parent,
wenzelm@65415
   238
            cwd = info.dir.file, env = env, sessions = Some(sessions), store = store,
wenzelm@65313
   239
            phase_changed =
wenzelm@65313
   240
            {
wenzelm@65313
   241
              case Session.Ready => session.protocol_command("build_session", args_yxml)
wenzelm@65317
   242
              case Session.Terminated(result) => session_result.fulfill(result)
wenzelm@65313
   243
              case _ =>
wenzelm@65313
   244
            })
wenzelm@65313
   245
wenzelm@65317
   246
          val result = session_result.join
wenzelm@65313
   247
          handler.result_error.join match {
wenzelm@65317
   248
            case "" => result
wenzelm@65317
   249
            case msg =>
wenzelm@65317
   250
              result.copy(
wenzelm@65317
   251
                rc = result.rc max 1,
wenzelm@65828
   252
                out_lines = result.out_lines ::: split_lines(Output.error_message_text(msg)))
wenzelm@65313
   253
          }
wenzelm@65308
   254
        }
wenzelm@65308
   255
        else {
wenzelm@65308
   256
          val args_file = Isabelle_System.tmp_file("build")
wenzelm@65308
   257
          File.write(args_file, args_yxml)
wenzelm@65308
   258
wenzelm@65308
   259
          val eval =
wenzelm@65308
   260
            "Command_Line.tool0 (fn () => (" +
wenzelm@66782
   261
            "Build.build " + ML_Syntax.print_string_bytes(File.standard_path(args_file)) +
wenzelm@67380
   262
            (if (Sessions.is_pure(name)) "; Theory.install_pure (Thy_Info.get_theory Context.PureN)"
wenzelm@67380
   263
             else "") + (if (do_output) "; " + save_heap else "") + "));"
wenzelm@64265
   264
wenzelm@65308
   265
          val process =
wenzelm@65360
   266
            if (Sessions.is_pure(name)) {
wenzelm@65312
   267
              ML_Process(options, raw_ml_system = true, cwd = info.dir.file,
wenzelm@65308
   268
                args =
wenzelm@65308
   269
                  (for ((root, _) <- Thy_Header.ml_roots) yield List("--use", root)).flatten :::
wenzelm@65308
   270
                  List("--eval", eval),
wenzelm@65415
   271
                env = env, sessions = Some(sessions), store = store,
wenzelm@65415
   272
                cleanup = () => args_file.delete)
wenzelm@65308
   273
            }
wenzelm@65308
   274
            else {
wenzelm@65312
   275
              ML_Process(options, parent, List("--eval", eval), cwd = info.dir.file,
wenzelm@65415
   276
                env = env, sessions = Some(sessions), store = store,
wenzelm@65415
   277
                cleanup = () => args_file.delete)
wenzelm@65308
   278
            }
wenzelm@64265
   279
wenzelm@65308
   280
          process.result(
wenzelm@65308
   281
            progress_stdout = (line: String) =>
wenzelm@65308
   282
              Library.try_unprefix("\floading_theory = ", line) match {
wenzelm@65308
   283
                case Some(theory) => progress.theory(name, theory)
wenzelm@65308
   284
                case None =>
wenzelm@65308
   285
              },
wenzelm@65308
   286
            progress_limit =
wenzelm@65312
   287
              options.int("process_output_limit") match {
wenzelm@65308
   288
                case 0 => None
wenzelm@65308
   289
                case m => Some(m * 1000000L)
wenzelm@65308
   290
              },
wenzelm@65308
   291
            strict = false)
wenzelm@65308
   292
        }
wenzelm@50845
   293
      }
wenzelm@48674
   294
wenzelm@62572
   295
    def terminate: Unit = future_result.cancel
wenzelm@62572
   296
    def is_finished: Boolean = future_result.is_finished
wenzelm@48674
   297
wenzelm@56779
   298
    private val timeout_request: Option[Event_Timer.Request] =
wenzelm@56779
   299
    {
wenzelm@62569
   300
      if (info.timeout > Time.zero)
wenzelm@66943
   301
        Some(Event_Timer.request(Time.now() + info.timeout) { terminate })
wenzelm@48674
   302
      else None
wenzelm@56779
   303
    }
wenzelm@48674
   304
wenzelm@62400
   305
    def join: Process_Result =
wenzelm@50845
   306
    {
wenzelm@62572
   307
      val result = future_result.join
wenzelm@50845
   308
wenzelm@62944
   309
      if (result.ok)
wenzelm@62633
   310
        Present.finish(progress, store.browser_info, graph_file, info, name)
wenzelm@61372
   311
wenzelm@59445
   312
      graph_file.delete
wenzelm@66943
   313
wenzelm@66943
   314
      val was_timeout =
wenzelm@66943
   315
        timeout_request match {
wenzelm@66943
   316
          case None => false
wenzelm@66943
   317
          case Some(request) => !request.cancel
wenzelm@66943
   318
        }
wenzelm@48674
   319
wenzelm@62572
   320
      if (result.interrupted) {
wenzelm@65828
   321
        if (was_timeout) result.error(Output.error_message_text("Timeout")).was_timeout
wenzelm@65828
   322
        else result.error(Output.error_message_text("Interrupt"))
wenzelm@52063
   323
      }
wenzelm@62572
   324
      else result
wenzelm@48674
   325
    }
wenzelm@48364
   326
  }
wenzelm@48364
   327
wenzelm@48424
   328
wenzelm@62631
   329
wenzelm@62641
   330
  /** build with results **/
wenzelm@48424
   331
wenzelm@63996
   332
  class Results private[Build](results: Map[String, (Option[Process_Result], Sessions.Info)])
wenzelm@62403
   333
  {
wenzelm@62403
   334
    def sessions: Set[String] = results.keySet
lars@63082
   335
    def cancelled(name: String): Boolean = results(name)._1.isEmpty
lars@63082
   336
    def apply(name: String): Process_Result = results(name)._1.getOrElse(Process_Result(1))
lars@63082
   337
    def info(name: String): Sessions.Info = results(name)._2
wenzelm@65253
   338
    val rc =
wenzelm@65253
   339
      (0 /: results.iterator.map(
wenzelm@65253
   340
        { case (_, (Some(r), _)) => r.rc case (_, (None, _)) => 1 }))(_ max _)
wenzelm@62641
   341
    def ok: Boolean = rc == 0
wenzelm@62406
   342
wenzelm@62406
   343
    override def toString: String = rc.toString
wenzelm@62403
   344
  }
wenzelm@62403
   345
wenzelm@62641
   346
  def build(
wenzelm@50404
   347
    options: Options,
wenzelm@64909
   348
    progress: Progress = No_Progress,
wenzelm@65832
   349
    check_unknown_files: Boolean = false,
wenzelm@48511
   350
    build_heap: Boolean = false,
wenzelm@48595
   351
    clean_build: Boolean = false,
wenzelm@56890
   352
    dirs: List[Path] = Nil,
wenzelm@56890
   353
    select_dirs: List[Path] = Nil,
wenzelm@66968
   354
    infos: List[Sessions.Info] = Nil,
wenzelm@64265
   355
    numa_shuffling: Boolean = false,
wenzelm@48509
   356
    max_jobs: Int = 1,
wenzelm@48903
   357
    list_files: Boolean = false,
wenzelm@59891
   358
    check_keywords: Set[String] = Set.empty,
wenzelm@66841
   359
    fresh_build: Boolean = false,
wenzelm@48509
   360
    no_build: Boolean = false,
wenzelm@66745
   361
    soft_build: Boolean = false,
wenzelm@48509
   362
    system_mode: Boolean = false,
wenzelm@48509
   363
    verbose: Boolean = false,
wenzelm@65308
   364
    pide: Boolean = false,
wenzelm@63224
   365
    requirements: Boolean = false,
wenzelm@63224
   366
    all_sessions: Boolean = false,
wenzelm@66737
   367
    base_sessions: List[String] = Nil,
wenzelm@63224
   368
    exclude_session_groups: List[String] = Nil,
wenzelm@59892
   369
    exclude_sessions: List[String] = Nil,
wenzelm@63224
   370
    session_groups: List[String] = Nil,
wenzelm@65422
   371
    sessions: List[String] = Nil,
wenzelm@65422
   372
    selection: Sessions.Selection = Sessions.Selection.empty): Results =
wenzelm@63224
   373
  {
wenzelm@66745
   374
    val build_options = options.int.update("completion_limit", 0).bool.update("ML_statistics", true)
wenzelm@51220
   375
wenzelm@66745
   376
    val store = Sessions.store(system_mode)
wenzelm@66745
   377
wenzelm@66745
   378
wenzelm@66745
   379
    /* session selection and dependencies */
wenzelm@65422
   380
wenzelm@66961
   381
    val full_sessions =
wenzelm@67026
   382
      Sessions.load_structure(build_options, dirs = dirs, select_dirs = select_dirs, infos = infos)
wenzelm@65422
   383
wenzelm@66749
   384
    def sources_stamp(deps: Sessions.Deps, name: String): String =
wenzelm@66749
   385
    {
wenzelm@66749
   386
      val digests =
wenzelm@66749
   387
        full_sessions(name).meta_digest :: deps.sources(name) ::: deps.imported_sources(name)
wenzelm@66749
   388
      SHA1.digest(cat_lines(digests.map(_.toString).sorted)).toString
wenzelm@66749
   389
    }
wenzelm@66745
   390
wenzelm@67030
   391
    val selection1 =
wenzelm@67030
   392
      Sessions.Selection(requirements, all_sessions, base_sessions, exclude_session_groups,
wenzelm@67030
   393
        exclude_sessions, session_groups, sessions) ++ selection
wenzelm@67030
   394
wenzelm@67025
   395
    val (selected_sessions, deps) =
wenzelm@66745
   396
    {
wenzelm@67030
   397
      val selected_sessions0 = full_sessions.selection(selection1)
wenzelm@66745
   398
      val deps0 =
wenzelm@66962
   399
        Sessions.deps(selected_sessions0, full_sessions.global_theories,
wenzelm@66962
   400
          progress = progress, inlined_files = true, verbose = verbose,
wenzelm@66962
   401
          list_files = list_files, check_keywords = check_keywords).check_errors
wenzelm@66745
   402
wenzelm@66841
   403
      if (soft_build && !fresh_build) {
wenzelm@66745
   404
        val outdated =
wenzelm@67025
   405
          selected_sessions0.build_topological_order.flatMap(name =>
wenzelm@66745
   406
            store.find_database(name) match {
wenzelm@66745
   407
              case Some(database) =>
wenzelm@66745
   408
                using(SQLite.open_database(database))(store.read_build(_, name)) match {
wenzelm@66745
   409
                  case Some(build)
wenzelm@66747
   410
                  if build.ok && build.sources == sources_stamp(deps0, name) => None
wenzelm@66745
   411
                  case _ => Some(name)
wenzelm@66745
   412
                }
wenzelm@66745
   413
              case None => Some(name)
wenzelm@66745
   414
            })
wenzelm@67025
   415
        val selected_sessions =
wenzelm@66745
   416
          full_sessions.selection(Sessions.Selection(sessions = outdated))
wenzelm@66745
   417
        val deps =
wenzelm@67852
   418
          Sessions.deps(selected_sessions, full_sessions.global_theories,
wenzelm@67852
   419
            progress = progress, inlined_files = true).check_errors
wenzelm@67025
   420
        (selected_sessions, deps)
wenzelm@66745
   421
      }
wenzelm@67025
   422
      else (selected_sessions0, deps0)
wenzelm@66745
   423
    }
wenzelm@66745
   424
wenzelm@66745
   425
wenzelm@66745
   426
    /* check unknown files */
wenzelm@48504
   427
wenzelm@65832
   428
    if (check_unknown_files) {
wenzelm@65832
   429
      val source_files =
wenzelm@65832
   430
        (for {
wenzelm@65832
   431
          (_, base) <- deps.session_bases.iterator
wenzelm@65832
   432
          (path, _) <- base.sources.iterator
wenzelm@65832
   433
        } yield path).toList
wenzelm@67098
   434
      val exclude_files = List(Path.explode("$POLYML_EXE")).map(_.canonical_file)
wenzelm@67098
   435
      val unknown_files =
wenzelm@67782
   436
        Mercurial.check_files(source_files)._2.
wenzelm@67098
   437
          filterNot(path => exclude_files.contains(path.canonical_file))
wenzelm@65832
   438
      if (unknown_files.nonEmpty) {
wenzelm@67782
   439
        progress.echo_warning("Unknown files (not part of the underlying Mercurial repository):" +
wenzelm@65832
   440
          unknown_files.map(path => path.expand.implode).sorted.mkString("\n  ", "\n  ", ""))
wenzelm@65832
   441
      }
wenzelm@65832
   442
    }
wenzelm@65832
   443
wenzelm@51220
   444
wenzelm@51220
   445
    /* main build process */
wenzelm@51220
   446
wenzelm@65831
   447
    val queue = Queue(progress, selected_sessions, store)
wenzelm@65289
   448
wenzelm@62632
   449
    store.prepare_output()
wenzelm@48373
   450
wenzelm@68086
   451
    // cleanup
wenzelm@68086
   452
    def cleanup(name: String, echo: Boolean = false)
wenzelm@68086
   453
    {
wenzelm@68086
   454
      val files =
wenzelm@68086
   455
        List(Path.basic(name), store.database(name), store.log(name), store.log_gz(name)).
wenzelm@68086
   456
          map(store.output_dir + _).filter(_.is_file)
wenzelm@68086
   457
      if (files.nonEmpty) progress.echo_if(echo, "Cleaning " + name + " ...")
wenzelm@68086
   458
      val res = files.map(p => p.file.delete)
wenzelm@68086
   459
      if (!res.forall(ok => ok)) progress.echo_if(echo, name + " FAILED to delete")
wenzelm@68086
   460
    }
wenzelm@48595
   461
    if (clean_build) {
wenzelm@67030
   462
      for (name <- full_sessions.build_descendants(full_sessions.build_selection(selection1))) {
wenzelm@68086
   463
        cleanup(name, echo = true)
wenzelm@48595
   464
      }
wenzelm@48595
   465
    }
wenzelm@48595
   466
wenzelm@48425
   467
    // scheduler loop
lars@63082
   468
    case class Result(
wenzelm@66594
   469
      current: Boolean,
wenzelm@66594
   470
      heap_stamp: Option[String],
wenzelm@66594
   471
      process: Option[Process_Result],
wenzelm@66594
   472
      info: Sessions.Info)
wenzelm@62402
   473
    {
wenzelm@62402
   474
      def ok: Boolean =
wenzelm@62402
   475
        process match {
wenzelm@62402
   476
          case None => false
wenzelm@62402
   477
          case Some(res) => res.rc == 0
wenzelm@62402
   478
        }
wenzelm@62402
   479
    }
wenzelm@48639
   480
wenzelm@56837
   481
    def sleep()
wenzelm@56837
   482
    {
wenzelm@56837
   483
      try { Thread.sleep(500) }
wenzelm@56861
   484
      catch { case Exn.Interrupt() => Exn.Interrupt.impose() }
wenzelm@56837
   485
    }
wenzelm@50366
   486
wenzelm@64265
   487
    val numa_nodes = new NUMA.Nodes(numa_shuffling)
wenzelm@64265
   488
wenzelm@48425
   489
    @tailrec def loop(
wenzelm@48676
   490
      pending: Queue,
wenzelm@62628
   491
      running: Map[String, (List[String], Job)],
wenzelm@48639
   492
      results: Map[String, Result]): Map[String, Result] =
wenzelm@48425
   493
    {
wenzelm@64265
   494
      def used_node(i: Int): Boolean =
wenzelm@64265
   495
        running.iterator.exists(
wenzelm@64265
   496
          { case (_, (_, job)) => job.numa_node.isDefined && job.numa_node.get == i })
wenzelm@64265
   497
wenzelm@48425
   498
      if (pending.is_empty) results
wenzelm@51253
   499
      else {
wenzelm@51253
   500
        if (progress.stopped)
wenzelm@51253
   501
          for ((_, (_, job)) <- running) job.terminate
wenzelm@51253
   502
wenzelm@48674
   503
        running.find({ case (_, (_, job)) => job.is_finished }) match {
wenzelm@62628
   504
          case Some((name, (input_heaps, job))) =>
wenzelm@50367
   505
            //{{{ finish job
wenzelm@48424
   506
wenzelm@62401
   507
            val process_result = job.join
wenzelm@48373
   508
wenzelm@65294
   509
            val log_lines = process_result.out_lines.filterNot(_.startsWith("\f"))
wenzelm@62404
   510
            val process_result_tail =
wenzelm@62404
   511
            {
wenzelm@62409
   512
              val tail = job.info.options.int("process_output_tail")
wenzelm@62632
   513
              process_result.copy(
wenzelm@62632
   514
                out_lines =
wenzelm@68086
   515
                  "(see also " + store.output_log(name).file.toString + ")" ::
wenzelm@65294
   516
                  (if (tail == 0) log_lines else log_lines.drop(log_lines.length - tail max 0)))
wenzelm@62404
   517
            }
wenzelm@62404
   518
wenzelm@66666
   519
wenzelm@66666
   520
            // write log file
wenzelm@62636
   521
            val heap_stamp =
wenzelm@62401
   522
              if (process_result.ok) {
wenzelm@62636
   523
                val heap_stamp =
wenzelm@62704
   524
                  for (path <- job.output_path if path.is_file)
wenzelm@62704
   525
                    yield Sessions.write_heap_digest(path)
wenzelm@48639
   526
wenzelm@68086
   527
                File.write_gzip(store.output_log_gz(name), terminate_lines(log_lines))
wenzelm@48639
   528
wenzelm@62636
   529
                heap_stamp
wenzelm@48639
   530
              }
wenzelm@48639
   531
              else {
wenzelm@68086
   532
                File.write(store.output_log(name), terminate_lines(log_lines))
wenzelm@48639
   533
wenzelm@62636
   534
                None
wenzelm@48639
   535
              }
wenzelm@65291
   536
wenzelm@65291
   537
            // write database
wenzelm@65291
   538
            {
wenzelm@66944
   539
              val build_log =
wenzelm@66944
   540
                Build_Log.Log_File(name, process_result.out_lines).
wenzelm@66944
   541
                  parse_session_info(
wenzelm@66944
   542
                    command_timings = true,
wenzelm@66944
   543
                    theory_timings = true,
wenzelm@66944
   544
                    ml_statistics = true,
wenzelm@66944
   545
                    task_statistics = true)
wenzelm@66944
   546
wenzelm@68086
   547
              using(SQLite.open_database(store.output_database(name)))(db =>
wenzelm@65318
   548
                store.write_session_info(db, name,
wenzelm@65291
   549
                  build_log =
wenzelm@66944
   550
                    if (process_result.timeout) build_log.error("Timeout") else build_log,
wenzelm@65291
   551
                  build =
wenzelm@66746
   552
                    Session_Info(sources_stamp(deps, name), input_heaps, heap_stamp,
wenzelm@66744
   553
                      process_result.rc)))
wenzelm@65291
   554
            }
wenzelm@65291
   555
wenzelm@66666
   556
            // messages
wenzelm@66666
   557
            process_result.err_lines.foreach(progress.echo(_))
wenzelm@66666
   558
wenzelm@66666
   559
            if (process_result.ok)
wenzelm@66666
   560
              progress.echo("Finished " + name + " (" + process_result.timing.message_resources + ")")
wenzelm@66666
   561
            else {
wenzelm@66666
   562
              progress.echo(name + " FAILED")
wenzelm@66666
   563
              if (!process_result.interrupted) progress.echo(process_result_tail.out)
wenzelm@66666
   564
            }
wenzelm@66666
   565
wenzelm@50707
   566
            loop(pending - name, running - name,
lars@63082
   567
              results + (name -> Result(false, heap_stamp, Some(process_result_tail), job.info)))
wenzelm@50367
   568
            //}}}
wenzelm@60215
   569
          case None if running.size < (max_jobs max 1) =>
wenzelm@50367
   570
            //{{{ check/start next job
wenzelm@48547
   571
            pending.dequeue(running.isDefinedAt(_)) match {
wenzelm@48547
   572
              case Some((name, info)) =>
wenzelm@66848
   573
                val ancestor_results =
wenzelm@66848
   574
                  selected_sessions.build_requirements(List(name)).filterNot(_ == name).
wenzelm@66848
   575
                    map(results(_))
wenzelm@62636
   576
                val ancestor_heaps = ancestor_results.flatMap(_.heap_stamp)
wenzelm@62628
   577
wenzelm@65360
   578
                val do_output = build_heap || Sessions.is_pure(name) || queue.is_inner(name)
wenzelm@48547
   579
wenzelm@62636
   580
                val (current, heap_stamp) =
wenzelm@48547
   581
                {
wenzelm@65291
   582
                  store.find_database_heap(name) match {
wenzelm@65291
   583
                    case Some((database, heap_stamp)) =>
wenzelm@65320
   584
                      using(SQLite.open_database(database))(store.read_build(_, name)) match {
wenzelm@65291
   585
                        case Some(build) =>
wenzelm@62628
   586
                          val current =
wenzelm@66841
   587
                            !fresh_build &&
wenzelm@66747
   588
                            build.ok &&
wenzelm@66745
   589
                            build.sources == sources_stamp(deps, name) &&
wenzelm@65291
   590
                            build.input_heaps == ancestor_heaps &&
wenzelm@65291
   591
                            build.output_heap == heap_stamp &&
wenzelm@66595
   592
                            !(do_output && heap_stamp.isEmpty)
wenzelm@62636
   593
                          (current, heap_stamp)
wenzelm@62636
   594
                        case None => (false, None)
wenzelm@48547
   595
                      }
wenzelm@62636
   596
                    case None => (false, None)
wenzelm@48504
   597
                  }
wenzelm@48547
   598
                }
wenzelm@62628
   599
                val all_current = current && ancestor_results.forall(_.current)
wenzelm@48528
   600
wenzelm@48547
   601
                if (all_current)
wenzelm@62402
   602
                  loop(pending - name, running,
lars@63082
   603
                    results + (name -> Result(true, heap_stamp, Some(Process_Result(0)), info)))
wenzelm@48678
   604
                else if (no_build) {
wenzelm@50366
   605
                  if (verbose) progress.echo("Skipping " + name + " ...")
wenzelm@62402
   606
                  loop(pending - name, running,
lars@63082
   607
                    results + (name -> Result(false, heap_stamp, Some(Process_Result(1)), info)))
wenzelm@48678
   608
                }
wenzelm@62628
   609
                else if (ancestor_results.forall(_.ok) && !progress.stopped) {
wenzelm@68086
   610
                  progress.echo((if (do_output) "Building " else "Running ") + name + " ...")
wenzelm@68086
   611
wenzelm@68086
   612
                  cleanup(name)
wenzelm@68086
   613
                  using(SQLite.open_database(store.output_database(name)))(db =>
wenzelm@68086
   614
                    store.init_session_info(db, name))
wenzelm@68086
   615
wenzelm@64265
   616
                  val numa_node = numa_nodes.next(used_node(_))
wenzelm@51220
   617
                  val job =
wenzelm@65415
   618
                    new Job(progress, name, info, selected_sessions, deps, store, do_output,
wenzelm@65415
   619
                      verbose, pide, numa_node, queue.command_timings(name))
wenzelm@62628
   620
                  loop(pending, running + (name -> (ancestor_heaps, job)), results)
wenzelm@48547
   621
                }
wenzelm@48547
   622
                else {
wenzelm@50366
   623
                  progress.echo(name + " CANCELLED")
wenzelm@65253
   624
                  loop(pending - name, running,
wenzelm@65253
   625
                    results + (name -> Result(false, heap_stamp, None, info)))
wenzelm@48547
   626
                }
wenzelm@48547
   627
              case None => sleep(); loop(pending, running, results)
wenzelm@48425
   628
            }
wenzelm@50367
   629
            ///}}}
wenzelm@48425
   630
          case None => sleep(); loop(pending, running, results)
wenzelm@48373
   631
        }
wenzelm@51253
   632
      }
wenzelm@48425
   633
    }
wenzelm@48425
   634
wenzelm@51220
   635
wenzelm@51220
   636
    /* build results */
wenzelm@51220
   637
wenzelm@62641
   638
    val results0 =
wenzelm@48583
   639
      if (deps.is_empty) {
wenzelm@65827
   640
        progress.echo_warning("Nothing to build")
wenzelm@50707
   641
        Map.empty[String, Result]
wenzelm@48583
   642
      }
wenzelm@48583
   643
      else loop(queue, Map.empty, Map.empty)
wenzelm@48583
   644
wenzelm@62641
   645
    val results =
wenzelm@64265
   646
      new Results(
wenzelm@64265
   647
        (for ((name, result) <- results0.iterator)
wenzelm@64265
   648
          yield (name, (result.process, result.info))).toMap)
wenzelm@62641
   649
wenzelm@62641
   650
    if (results.rc != 0 && (verbose || !no_build)) {
wenzelm@62641
   651
      val unfinished =
wenzelm@62641
   652
        (for {
wenzelm@62641
   653
          name <- results.sessions.iterator
wenzelm@62641
   654
          if !results(name).ok
wenzelm@62641
   655
         } yield name).toList.sorted
wenzelm@62641
   656
      progress.echo("Unfinished session(s): " + commas(unfinished))
wenzelm@62641
   657
    }
wenzelm@62641
   658
wenzelm@51418
   659
wenzelm@51418
   660
    /* global browser info */
wenzelm@51418
   661
wenzelm@51418
   662
    if (!no_build) {
wenzelm@51418
   663
      val browser_chapters =
wenzelm@51418
   664
        (for {
wenzelm@62641
   665
          (name, result) <- results0.iterator
wenzelm@62944
   666
          if result.ok
wenzelm@65415
   667
          info = full_sessions(name)
wenzelm@51418
   668
          if info.options.bool("browser_info")
wenzelm@51418
   669
        } yield (info.chapter, (name, info.description))).toList.groupBy(_._1).
wenzelm@51418
   670
            map({ case (chapter, es) => (chapter, es.map(_._2)) }).filterNot(_._2.isEmpty)
wenzelm@51418
   671
wenzelm@51418
   672
      for ((chapter, entries) <- browser_chapters)
wenzelm@62632
   673
        Present.update_chapter_index(store.browser_info, chapter, entries)
wenzelm@51418
   674
wenzelm@62632
   675
      if (browser_chapters.nonEmpty) Present.make_global_index(store.browser_info)
wenzelm@51418
   676
    }
wenzelm@51418
   677
wenzelm@62641
   678
    results
wenzelm@48341
   679
  }
wenzelm@48341
   680
wenzelm@48341
   681
wenzelm@62833
   682
  /* Isabelle tool wrapper */
wenzelm@48341
   683
wenzelm@62833
   684
  val isabelle_tool = Isabelle_Tool("build", "build and manage Isabelle sessions", args =>
wenzelm@48341
   685
  {
wenzelm@62833
   686
    val build_options = Word.explode(Isabelle_System.getenv("ISABELLE_BUILD_OPTIONS"))
wenzelm@62590
   687
wenzelm@66737
   688
    var base_sessions: List[String] = Nil
wenzelm@62833
   689
    var select_dirs: List[Path] = Nil
wenzelm@64265
   690
    var numa_shuffling = false
wenzelm@65308
   691
    var pide = false
wenzelm@62833
   692
    var requirements = false
wenzelm@66745
   693
    var soft_build = false
wenzelm@62833
   694
    var exclude_session_groups: List[String] = Nil
wenzelm@62833
   695
    var all_sessions = false
wenzelm@62833
   696
    var build_heap = false
wenzelm@62833
   697
    var clean_build = false
wenzelm@62833
   698
    var dirs: List[Path] = Nil
wenzelm@66841
   699
    var fresh_build = false
wenzelm@62833
   700
    var session_groups: List[String] = Nil
wenzelm@62833
   701
    var max_jobs = 1
wenzelm@62833
   702
    var check_keywords: Set[String] = Set.empty
wenzelm@62833
   703
    var list_files = false
wenzelm@62833
   704
    var no_build = false
wenzelm@67847
   705
    var options = Options.init(opts = build_options)
wenzelm@62833
   706
    var system_mode = false
wenzelm@62833
   707
    var verbose = false
wenzelm@62833
   708
    var exclude_sessions: List[String] = Nil
wenzelm@62590
   709
wenzelm@62833
   710
    val getopts = Getopts("""
wenzelm@62590
   711
Usage: isabelle build [OPTIONS] [SESSIONS ...]
wenzelm@62590
   712
wenzelm@62590
   713
  Options are:
wenzelm@66737
   714
    -B NAME      include session NAME and all descendants
wenzelm@62590
   715
    -D DIR       include session directory and select its sessions
wenzelm@64265
   716
    -N           cyclic shuffling of NUMA CPU nodes (performance tuning)
wenzelm@65308
   717
    -P           build via PIDE protocol
wenzelm@62590
   718
    -R           operate on requirements of selected sessions
wenzelm@66745
   719
    -S           soft build: only observe changes of sources, not heap images
wenzelm@62590
   720
    -X NAME      exclude sessions from group NAME and all descendants
wenzelm@62590
   721
    -a           select all sessions
wenzelm@62590
   722
    -b           build heap images
wenzelm@62590
   723
    -c           clean build
wenzelm@62590
   724
    -d DIR       include session directory
wenzelm@66841
   725
    -f           fresh build
wenzelm@62590
   726
    -g NAME      select session group NAME
wenzelm@62590
   727
    -j INT       maximum number of parallel jobs (default 1)
wenzelm@62590
   728
    -k KEYWORD   check theory sources for conflicts with proposed keywords
wenzelm@62590
   729
    -l           list session source files
wenzelm@62590
   730
    -n           no build -- test dependencies only
wenzelm@62590
   731
    -o OPTION    override Isabelle system OPTION (via NAME=VAL or NAME)
wenzelm@62590
   732
    -s           system build mode: produce output in ISABELLE_HOME
wenzelm@62590
   733
    -v           verbose
wenzelm@62590
   734
    -x NAME      exclude session NAME and all descendants
wenzelm@62590
   735
wenzelm@62596
   736
  Build and manage Isabelle sessions, depending on implicit settings:
wenzelm@62596
   737
wenzelm@64455
   738
""" + Library.prefix_lines("  ", Build_Log.Settings.show()) + "\n",
wenzelm@66737
   739
      "B:" -> (arg => base_sessions = base_sessions ::: List(arg)),
wenzelm@62833
   740
      "D:" -> (arg => select_dirs = select_dirs ::: List(Path.explode(arg))),
wenzelm@64265
   741
      "N" -> (_ => numa_shuffling = true),
wenzelm@65308
   742
      "P" -> (_ => pide = true),
wenzelm@62833
   743
      "R" -> (_ => requirements = true),
wenzelm@66745
   744
      "S" -> (_ => soft_build = true),
wenzelm@62833
   745
      "X:" -> (arg => exclude_session_groups = exclude_session_groups ::: List(arg)),
wenzelm@62833
   746
      "a" -> (_ => all_sessions = true),
wenzelm@62833
   747
      "b" -> (_ => build_heap = true),
wenzelm@62833
   748
      "c" -> (_ => clean_build = true),
wenzelm@62833
   749
      "d:" -> (arg => dirs = dirs ::: List(Path.explode(arg))),
wenzelm@66841
   750
      "f" -> (_ => fresh_build = true),
wenzelm@62833
   751
      "g:" -> (arg => session_groups = session_groups ::: List(arg)),
wenzelm@63805
   752
      "j:" -> (arg => max_jobs = Value.Int.parse(arg)),
wenzelm@62833
   753
      "k:" -> (arg => check_keywords = check_keywords + arg),
wenzelm@62833
   754
      "l" -> (_ => list_files = true),
wenzelm@62833
   755
      "n" -> (_ => no_build = true),
wenzelm@62833
   756
      "o:" -> (arg => options = options + arg),
wenzelm@62833
   757
      "s" -> (_ => system_mode = true),
wenzelm@62833
   758
      "v" -> (_ => verbose = true),
wenzelm@62833
   759
      "x:" -> (arg => exclude_sessions = exclude_sessions ::: List(arg)))
wenzelm@62590
   760
wenzelm@62833
   761
    val sessions = getopts(args)
wenzelm@62590
   762
wenzelm@64115
   763
    val progress = new Console_Progress(verbose = verbose)
wenzelm@62590
   764
wenzelm@64140
   765
    val start_date = Date.now()
wenzelm@64140
   766
wenzelm@62833
   767
    if (verbose) {
wenzelm@62833
   768
      progress.echo(
wenzelm@64155
   769
        "Started at " + Build_Log.print_date(start_date) +
wenzelm@64140
   770
          " (" + Isabelle_System.getenv("ML_IDENTIFIER") + " on " + Isabelle_System.hostname() +")")
wenzelm@64081
   771
      progress.echo(Build_Log.Settings.show() + "\n")
wenzelm@62833
   772
    }
wenzelm@62590
   773
wenzelm@62833
   774
    val results =
wenzelm@62833
   775
      progress.interrupt_handler {
wenzelm@67846
   776
        build(options,
wenzelm@67846
   777
          progress = progress,
wenzelm@65832
   778
          check_unknown_files = Mercurial.is_repository(Path.explode("~~")),
wenzelm@63224
   779
          build_heap = build_heap,
wenzelm@63224
   780
          clean_build = clean_build,
wenzelm@63224
   781
          dirs = dirs,
wenzelm@63224
   782
          select_dirs = select_dirs,
wenzelm@65831
   783
          numa_shuffling = NUMA.enabled_warning(progress, numa_shuffling),
wenzelm@63224
   784
          max_jobs = max_jobs,
wenzelm@63224
   785
          list_files = list_files,
wenzelm@63224
   786
          check_keywords = check_keywords,
wenzelm@66841
   787
          fresh_build = fresh_build,
wenzelm@63224
   788
          no_build = no_build,
wenzelm@66745
   789
          soft_build = soft_build,
wenzelm@63224
   790
          system_mode = system_mode,
wenzelm@63224
   791
          verbose = verbose,
wenzelm@65308
   792
          pide = pide,
wenzelm@63224
   793
          requirements = requirements,
wenzelm@63224
   794
          all_sessions = all_sessions,
wenzelm@66737
   795
          base_sessions = base_sessions,
wenzelm@63224
   796
          exclude_session_groups = exclude_session_groups,
wenzelm@63224
   797
          exclude_sessions = exclude_sessions,
wenzelm@63224
   798
          session_groups = session_groups,
wenzelm@63224
   799
          sessions = sessions)
wenzelm@62833
   800
      }
wenzelm@64140
   801
    val end_date = Date.now()
wenzelm@64140
   802
    val elapsed_time = end_date.time - start_date.time
wenzelm@62590
   803
wenzelm@62833
   804
    if (verbose) {
wenzelm@64155
   805
      progress.echo("\nFinished at " + Build_Log.print_date(end_date))
wenzelm@62833
   806
    }
wenzelm@62590
   807
wenzelm@62833
   808
    val total_timing =
wenzelm@62833
   809
      (Timing.zero /: results.sessions.iterator.map(a => results(a).timing))(_ + _).
wenzelm@62833
   810
        copy(elapsed = elapsed_time)
wenzelm@62833
   811
    progress.echo(total_timing.message_resources)
wenzelm@62590
   812
wenzelm@62833
   813
    sys.exit(results.rc)
wenzelm@62833
   814
  })
wenzelm@48276
   815
}