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