src/Pure/Admin/isabelle_cronjob.scala
author wenzelm
Sun Nov 06 22:51:40 2016 +0100 (2016-11-06)
changeset 64468 ed8940d6295c
parent 64452 b52141002646
child 64476 62c807eb009f
permissions -rw-r--r--
back to more elementary result (see 5f49765a25ec): avoid concurrent use of ssh channel;
wenzelm@64148
     1
/*  Title:      Pure/Admin/isabelle_cronjob.scala
wenzelm@64148
     2
    Author:     Makarius
wenzelm@64148
     3
wenzelm@64148
     4
Main entry point for administrative cronjob at TUM.
wenzelm@64148
     5
*/
wenzelm@64148
     6
wenzelm@64148
     7
package isabelle
wenzelm@64148
     8
wenzelm@64148
     9
wenzelm@64170
    10
import scala.annotation.tailrec
wenzelm@64170
    11
import scala.collection.mutable
wenzelm@64170
    12
wenzelm@64170
    13
wenzelm@64148
    14
object Isabelle_Cronjob
wenzelm@64148
    15
{
wenzelm@64194
    16
  /* file-system state: owned by main cronjob */
wenzelm@64153
    17
wenzelm@64153
    18
  val main_dir = Path.explode("~/cronjob")
wenzelm@64194
    19
  val main_state_file = main_dir + Path.explode("run/main.state")
wenzelm@64219
    20
  val current_log = main_dir + Path.explode("run/main.log")  // owned by log service
wenzelm@64219
    21
  val cumulative_log = main_dir + Path.explode("log/main.log")  // owned by log service
wenzelm@64153
    22
wenzelm@64231
    23
  val isabelle_repos = main_dir + Path.explode("isabelle")
wenzelm@64231
    24
  val isabelle_repos_test = main_dir + Path.explode("isabelle-test")
wenzelm@64231
    25
  val afp_repos = main_dir + Path.explode("AFP")
wenzelm@64153
    26
wenzelm@64236
    27
  val isabelle_dev_source = "http://isabelle.in.tum.de/repos/isabelle"
wenzelm@64236
    28
  val isabelle_release_source = "http://bitbucket.org/isabelle_project/isabelle-release"
wenzelm@64236
    29
  val afp_source = "https://bitbucket.org/isa-afp/afp-devel"
wenzelm@64236
    30
wenzelm@64218
    31
  val release_snapshot = Path.explode("~/html-data/release_snapshot")
wenzelm@64215
    32
wenzelm@64153
    33
wenzelm@64192
    34
wenzelm@64192
    35
  /** particular tasks **/
wenzelm@64192
    36
wenzelm@64405
    37
  /* identify Isabelle + AFP repository snapshots and build release */
wenzelm@64192
    38
wenzelm@64405
    39
  private val build_release =
wenzelm@64405
    40
    Logger_Task("build_release", logger =>
wenzelm@64405
    41
      Isabelle_System.with_tmp_dir("isadist")(base_dir =>
wenzelm@64405
    42
        {
wenzelm@64405
    43
          val rev = Mercurial.repository(isabelle_repos).id()
wenzelm@64405
    44
          val afp_rev = Mercurial.setup_repository(afp_source, afp_repos).id()
wenzelm@64192
    45
wenzelm@64405
    46
          File.write(logger.log_dir + Build_Log.log_filename("isabelle_identify", logger.start_date),
wenzelm@64405
    47
            terminate_lines(
wenzelm@64405
    48
              List("isabelle_identify: " + Build_Log.print_date(logger.start_date),
wenzelm@64405
    49
                "",
wenzelm@64405
    50
                "Isabelle version: " + rev,
wenzelm@64405
    51
                "AFP version: " + afp_rev)))
wenzelm@64405
    52
wenzelm@64405
    53
          val new_snapshot = release_snapshot.ext("new")
wenzelm@64405
    54
          val old_snapshot = release_snapshot.ext("old")
wenzelm@64405
    55
wenzelm@64405
    56
          Isabelle_System.rm_tree(new_snapshot)
wenzelm@64405
    57
          Isabelle_System.rm_tree(old_snapshot)
wenzelm@64405
    58
wenzelm@64405
    59
          Build_Release.build_release(base_dir, rev = rev, afp_rev = afp_rev,
wenzelm@64405
    60
            parallel_jobs = 4, remote_mac = "macbroy31", website = Some(new_snapshot))
wenzelm@64405
    61
wenzelm@64405
    62
          if (release_snapshot.is_dir) File.mv(release_snapshot, old_snapshot)
wenzelm@64405
    63
          File.mv(new_snapshot, release_snapshot)
wenzelm@64405
    64
          Isabelle_System.rm_tree(old_snapshot)
wenzelm@64405
    65
        }))
wenzelm@64192
    66
wenzelm@64192
    67
wenzelm@64194
    68
  /* integrity test of build_history vs. build_history_base */
wenzelm@64193
    69
wenzelm@64194
    70
  private val build_history_base =
wenzelm@64193
    71
    Logger_Task("build_history_base", logger =>
wenzelm@64193
    72
      {
wenzelm@64251
    73
        val hg =
wenzelm@64251
    74
          Mercurial.setup_repository(
wenzelm@64251
    75
            File.standard_path(isabelle_repos), isabelle_repos_test)
wenzelm@64194
    76
        for {
wenzelm@64194
    77
          (result, log_path) <-
wenzelm@64251
    78
            Build_History.build_history(
wenzelm@64251
    79
              hg, rev = "build_history_base", fresh = true, build_args = List("HOL"))
wenzelm@64194
    80
        } {
wenzelm@64194
    81
          result.check
wenzelm@64195
    82
          File.copy(log_path, logger.log_dir + log_path.base)
wenzelm@64194
    83
        }
wenzelm@64193
    84
      })
wenzelm@64193
    85
wenzelm@64193
    86
wenzelm@64231
    87
  /* remote build_history */
wenzelm@64231
    88
wenzelm@64409
    89
  sealed case class Remote_Build(
wenzelm@64231
    90
    host: String,
wenzelm@64231
    91
    user: String = "",
wenzelm@64231
    92
    port: Int = SSH.default_port,
wenzelm@64294
    93
    shared_home: Boolean = true,
wenzelm@64231
    94
    options: String = "",
wenzelm@64351
    95
    args: String = "")
wenzelm@64231
    96
wenzelm@64231
    97
  private val remote_builds =
wenzelm@64231
    98
    List(
wenzelm@64350
    99
      List(Remote_Build("lxbroy10", options = "-m32 -B -M1x4,2,4,6 -N", args = "-g timing")),
wenzelm@64351
   100
      List(
wenzelm@64351
   101
        Remote_Build("macbroy2", options = "-m32 -M8", args = "-a"),
wenzelm@64351
   102
        Remote_Build("macbroy2", options = "-m32 -M8 -t quick_and_dirty", args = "-a -o quick_and_dirty"),
wenzelm@64351
   103
        Remote_Build("macbroy2", options = "-m32 -M8 -t skip_proofs", args = "-a -o skip_proofs")),
wenzelm@64351
   104
      List(Remote_Build("macbroy30", options = "-m32 -M2", args = "-a")),
wenzelm@64351
   105
      List(Remote_Build("macbroy31", options = "-m32 -M2", args = "-a")),
wenzelm@64351
   106
      List(
wenzelm@64351
   107
        Remote_Build("vmnipkow9", shared_home = false, options = "-m32 -M4", args = "-a"),
wenzelm@64351
   108
        Remote_Build("vmnipkow9", shared_home = false, options = "-m64 -M4", args = "-a")))
wenzelm@64231
   109
wenzelm@64231
   110
  private def remote_build_history(rev: String, r: Remote_Build): Logger_Task =
wenzelm@64294
   111
  {
wenzelm@64294
   112
    val task_name = "build_history-" + r.host
wenzelm@64294
   113
    Logger_Task(task_name, logger =>
wenzelm@64231
   114
      {
wenzelm@64231
   115
        using(logger.ssh_context.open_session(host = r.host, user = r.user, port = r.port))(
wenzelm@64259
   116
          ssh =>
wenzelm@64231
   117
            {
wenzelm@64348
   118
              val self_update = !r.shared_home
wenzelm@64348
   119
              val push_isabelle_home = self_update && Mercurial.is_repository(Path.explode("~~"))
wenzelm@64348
   120
wenzelm@64468
   121
              val (results, _) =
wenzelm@64468
   122
                Build_History.remote_build_history(ssh,
wenzelm@64468
   123
                  isabelle_repos,
wenzelm@64468
   124
                  isabelle_repos.ext(r.host),
wenzelm@64468
   125
                  isabelle_repos_source = isabelle_release_source,
wenzelm@64468
   126
                  self_update = self_update,
wenzelm@64468
   127
                  push_isabelle_home = push_isabelle_home,
wenzelm@64468
   128
                  options =
wenzelm@64468
   129
                    r.options + " -f -r " + Bash.string(rev) + " -N " + Bash.string(task_name),
wenzelm@64468
   130
                  args = "-o timeout=10800 " + r.args)
wenzelm@64346
   131
wenzelm@64468
   132
              for ((log_name, bytes) <- results)
wenzelm@64468
   133
                Bytes.write(logger.log_dir + Path.explode(log_name), bytes)
wenzelm@64231
   134
            })
wenzelm@64231
   135
      })
wenzelm@64294
   136
  }
wenzelm@64231
   137
wenzelm@64231
   138
wenzelm@64192
   139
wenzelm@64192
   140
  /** task logging **/
wenzelm@64171
   141
wenzelm@64193
   142
  sealed case class Logger_Task(name: String = "", body: Logger => Unit)
wenzelm@64154
   143
wenzelm@64257
   144
  class Log_Service private[Isabelle_Cronjob](progress: Progress, val ssh_context: SSH.Context)
wenzelm@64171
   145
  {
wenzelm@64219
   146
    current_log.file.delete
wenzelm@64219
   147
wenzelm@64171
   148
    private val thread: Consumer_Thread[String] =
wenzelm@64171
   149
      Consumer_Thread.fork("cronjob: logger", daemon = true)(
wenzelm@64171
   150
        consume = (text: String) =>
wenzelm@64219
   151
          { // critical
wenzelm@64219
   152
            File.append(current_log, text + "\n")
wenzelm@64219
   153
            File.append(cumulative_log, text + "\n")
wenzelm@64171
   154
            progress.echo(text)
wenzelm@64171
   155
            true
wenzelm@64171
   156
          })
wenzelm@64171
   157
wenzelm@64171
   158
    def shutdown() { thread.shutdown() }
wenzelm@64171
   159
wenzelm@64171
   160
    val hostname = Isabelle_System.hostname()
wenzelm@64171
   161
wenzelm@64171
   162
    def log(date: Date, task_name: String, msg: String): Unit =
wenzelm@64193
   163
      if (task_name != "")
wenzelm@64193
   164
        thread.send(
wenzelm@64193
   165
          "[" + Build_Log.print_date(date) + ", " + hostname + ", " + task_name + "]: " + msg)
wenzelm@64171
   166
wenzelm@64171
   167
    def start_logger(start_date: Date, task_name: String): Logger =
wenzelm@64171
   168
      new Logger(this, start_date, task_name)
wenzelm@64154
   169
wenzelm@64171
   170
    def run_task(start_date: Date, task: Logger_Task)
wenzelm@64171
   171
    {
wenzelm@64171
   172
      val logger = start_logger(start_date, task.name)
wenzelm@64171
   173
      val res = Exn.capture { task.body(logger) }
wenzelm@64171
   174
      val end_date = Date.now()
wenzelm@64171
   175
      val err =
wenzelm@64171
   176
        res match {
wenzelm@64171
   177
          case Exn.Res(_) => None
wenzelm@64295
   178
          case Exn.Exn(exn) =>
wenzelm@64410
   179
            System.err.println("Exception trace for " + quote(task.name) + ":")
wenzelm@64397
   180
            exn.printStackTrace()
wenzelm@64295
   181
            val first_line = Library.split_lines(Exn.message(exn)).headOption getOrElse "exception"
wenzelm@64295
   182
            Some(first_line)
wenzelm@64171
   183
        }
wenzelm@64171
   184
      logger.log_end(end_date, err)
wenzelm@64171
   185
    }
wenzelm@64171
   186
wenzelm@64171
   187
    def fork_task(start_date: Date, task: Logger_Task): Task =
wenzelm@64171
   188
      new Task(task.name, run_task(start_date, task))
wenzelm@64171
   189
  }
wenzelm@64171
   190
wenzelm@64171
   191
  class Logger private[Isabelle_Cronjob](
wenzelm@64171
   192
    val log_service: Log_Service, val start_date: Date, val task_name: String)
wenzelm@64162
   193
  {
wenzelm@64257
   194
    def ssh_context: SSH.Context = log_service.ssh_context
wenzelm@64231
   195
wenzelm@64171
   196
    def log(date: Date, msg: String): Unit = log_service.log(date, task_name, msg)
wenzelm@64171
   197
wenzelm@64171
   198
    def log_end(end_date: Date, err: Option[String])
wenzelm@64171
   199
    {
wenzelm@64171
   200
      val elapsed_time = end_date.time - start_date.time
wenzelm@64171
   201
      val msg =
wenzelm@64171
   202
        (if (err.isEmpty) "finished" else "ERROR " + err.get) +
wenzelm@64197
   203
        (if (elapsed_time.seconds < 3.0) "" else " (" + elapsed_time.message_hms + " elapsed time)")
wenzelm@64171
   204
      log(end_date, msg)
wenzelm@64171
   205
    }
wenzelm@64171
   206
wenzelm@64195
   207
    val log_dir: Path = main_dir + Build_Log.log_subdir(start_date)
wenzelm@64195
   208
wenzelm@64195
   209
    Isabelle_System.mkdirs(log_dir)
wenzelm@64171
   210
    log(start_date, "started")
wenzelm@64171
   211
  }
wenzelm@64171
   212
wenzelm@64171
   213
  class Task private[Isabelle_Cronjob](name: String, body: => Unit)
wenzelm@64171
   214
  {
wenzelm@64171
   215
    private val future: Future[Unit] = Future.thread("cronjob: " + name) { body }
wenzelm@64171
   216
    def is_finished: Boolean = future.is_finished
wenzelm@64162
   217
  }
wenzelm@64153
   218
wenzelm@64170
   219
wenzelm@64170
   220
wenzelm@64153
   221
  /** cronjob **/
wenzelm@64153
   222
wenzelm@64187
   223
  def cronjob(progress: Progress, exclude_task: Set[String])
wenzelm@64153
   224
  {
wenzelm@64171
   225
    /* soft lock */
wenzelm@64153
   226
wenzelm@64153
   227
    val still_running =
wenzelm@64153
   228
      try { Some(File.read(main_state_file)) }
wenzelm@64153
   229
      catch { case ERROR(_) => None }
wenzelm@64153
   230
wenzelm@64153
   231
    still_running match {
wenzelm@64170
   232
      case None | Some("") =>
wenzelm@64153
   233
      case Some(running) =>
wenzelm@64153
   234
        error("Isabelle cronjob appears to be still running: " + running)
wenzelm@64153
   235
    }
wenzelm@64153
   236
wenzelm@64199
   237
wenzelm@64199
   238
    /* log service */
wenzelm@64199
   239
wenzelm@64257
   240
    val log_service = new Log_Service(progress, SSH.init_context(Options.init()))
wenzelm@64154
   241
wenzelm@64199
   242
    def run(start_date: Date, task: Logger_Task) { log_service.run_task(start_date, task) }
wenzelm@64199
   243
wenzelm@64199
   244
    def run_now(task: Logger_Task) { run(Date.now(), task) }
wenzelm@64154
   245
wenzelm@64154
   246
wenzelm@64199
   247
    /* structured tasks */
wenzelm@64184
   248
wenzelm@64350
   249
    def SEQ(tasks: List[Logger_Task]): Logger_Task = Logger_Task(body = _ =>
wenzelm@64193
   250
      for (task <- tasks.iterator if !exclude_task(task.name) || task.name == "")
wenzelm@64199
   251
        run_now(task))
wenzelm@64153
   252
wenzelm@64350
   253
    def PAR(tasks: List[Logger_Task]): Logger_Task = Logger_Task(body = _ =>
wenzelm@64170
   254
      {
wenzelm@64199
   255
        @tailrec def join(running: List[Task])
wenzelm@64199
   256
        {
wenzelm@64199
   257
          running.partition(_.is_finished) match {
wenzelm@64199
   258
            case (Nil, Nil) =>
wenzelm@64199
   259
            case (Nil, _ :: _) => Thread.sleep(500); join(running)
wenzelm@64199
   260
            case (_ :: _, remaining) => join(remaining)
wenzelm@64199
   261
          }
wenzelm@64170
   262
        }
wenzelm@64199
   263
        val start_date = Date.now()
wenzelm@64199
   264
        val running =
wenzelm@64350
   265
          for (task <- tasks if !exclude_task(task.name))
wenzelm@64199
   266
            yield log_service.fork_task(start_date, task)
wenzelm@64199
   267
        join(running)
wenzelm@64199
   268
      })
wenzelm@64193
   269
wenzelm@64170
   270
wenzelm@64170
   271
    /* main */
wenzelm@64170
   272
wenzelm@64199
   273
    val main_start_date = Date.now()
wenzelm@64199
   274
    File.write(main_state_file, main_start_date + " " + log_service.hostname)
wenzelm@64199
   275
wenzelm@64232
   276
    val rev = Mercurial.repository(isabelle_repos).id()
wenzelm@64231
   277
wenzelm@64193
   278
    run(main_start_date,
wenzelm@64193
   279
      Logger_Task("isabelle_cronjob", _ =>
wenzelm@64231
   280
        run_now(
wenzelm@64405
   281
          SEQ(List(build_release, build_history_base,
wenzelm@64350
   282
            PAR(remote_builds.map(seq => SEQ(seq.map(remote_build_history(rev, _))))))))))
wenzelm@64153
   283
wenzelm@64171
   284
    log_service.shutdown()
wenzelm@64170
   285
wenzelm@64153
   286
    main_state_file.file.delete
wenzelm@64153
   287
  }
wenzelm@64153
   288
wenzelm@64153
   289
wenzelm@64153
   290
wenzelm@64153
   291
  /** command line entry point **/
wenzelm@64153
   292
wenzelm@64148
   293
  def main(args: Array[String])
wenzelm@64148
   294
  {
wenzelm@64148
   295
    Command_Line.tool0 {
wenzelm@64148
   296
      var force = false
wenzelm@64148
   297
      var verbose = false
wenzelm@64187
   298
      var exclude_task = Set.empty[String]
wenzelm@64148
   299
wenzelm@64148
   300
      val getopts = Getopts("""
wenzelm@64148
   301
Usage: Admin/cronjob/main [OPTIONS]
wenzelm@64148
   302
wenzelm@64148
   303
  Options are:
wenzelm@64148
   304
    -f           apply force to do anything
wenzelm@64148
   305
    -v           verbose
wenzelm@64187
   306
    -x NAME      exclude tasks with this name
wenzelm@64148
   307
""",
wenzelm@64148
   308
        "f" -> (_ => force = true),
wenzelm@64187
   309
        "v" -> (_ => verbose = true),
wenzelm@64187
   310
        "x:" -> (arg => exclude_task += arg))
wenzelm@64148
   311
wenzelm@64148
   312
      val more_args = getopts(args)
wenzelm@64148
   313
      if (more_args.nonEmpty) getopts.usage()
wenzelm@64148
   314
wenzelm@64153
   315
      val progress = if (verbose) new Console_Progress() else Ignore_Progress
wenzelm@64148
   316
wenzelm@64187
   317
      if (force) cronjob(progress, exclude_task)
wenzelm@64153
   318
      else error("Need to apply force to do anything")
wenzelm@64148
   319
    }
wenzelm@64148
   320
  }
wenzelm@64148
   321
}