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