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