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