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