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