src/Pure/Admin/isabelle_cronjob.scala
author wenzelm
Tue Oct 18 10:05:38 2016 +0200 (2016-10-18)
changeset 64294 303976a45afe
parent 64277 5ca4ac099e94
child 64295 6aefa7e66888
permissions -rw-r--r--
shared_home is default for classic isatest home setup;
distinct ISABELLE_IDENTIFIER for all tasks;
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@64194
    37
  /* identify Isabelle + AFP repository snapshots */
wenzelm@64192
    38
wenzelm@64194
    39
  private val isabelle_identify =
wenzelm@64192
    40
    Logger_Task("isabelle_identify", logger =>
wenzelm@64192
    41
      {
wenzelm@64232
    42
        val isabelle_id = Mercurial.repository(isabelle_repos).id()
wenzelm@64252
    43
        val afp_id = Mercurial.setup_repository(afp_source, afp_repos).id()
wenzelm@64192
    44
wenzelm@64195
    45
        File.write(logger.log_dir + Build_Log.log_filename("isabelle_identify", logger.start_date),
wenzelm@64192
    46
          terminate_lines(
wenzelm@64192
    47
            List("isabelle_identify: " + Build_Log.print_date(logger.start_date),
wenzelm@64192
    48
              "",
wenzelm@64192
    49
              "Isabelle version: " + isabelle_id,
wenzelm@64192
    50
              "AFP version: " + afp_id)))
wenzelm@64192
    51
      })
wenzelm@64192
    52
wenzelm@64192
    53
wenzelm@64194
    54
  /* integrity test of build_history vs. build_history_base */
wenzelm@64193
    55
wenzelm@64194
    56
  private val build_history_base =
wenzelm@64193
    57
    Logger_Task("build_history_base", logger =>
wenzelm@64193
    58
      {
wenzelm@64251
    59
        val hg =
wenzelm@64251
    60
          Mercurial.setup_repository(
wenzelm@64251
    61
            File.standard_path(isabelle_repos), isabelle_repos_test)
wenzelm@64194
    62
        for {
wenzelm@64194
    63
          (result, log_path) <-
wenzelm@64251
    64
            Build_History.build_history(
wenzelm@64251
    65
              hg, rev = "build_history_base", fresh = true, build_args = List("HOL"))
wenzelm@64194
    66
        } {
wenzelm@64194
    67
          result.check
wenzelm@64195
    68
          File.copy(log_path, logger.log_dir + log_path.base)
wenzelm@64194
    69
        }
wenzelm@64193
    70
      })
wenzelm@64193
    71
wenzelm@64193
    72
wenzelm@64215
    73
  /* build release from repository snapshot */
wenzelm@64215
    74
wenzelm@64215
    75
  private val build_release =
wenzelm@64215
    76
    Logger_Task("build_release", logger =>
wenzelm@64220
    77
      Isabelle_System.with_tmp_dir("isadist")(base_dir =>
wenzelm@64215
    78
        {
wenzelm@64215
    79
          val new_snapshot = release_snapshot.ext("new")
wenzelm@64215
    80
          val old_snapshot = release_snapshot.ext("old")
wenzelm@64215
    81
wenzelm@64215
    82
          Isabelle_System.rm_tree(new_snapshot)
wenzelm@64215
    83
          Isabelle_System.rm_tree(old_snapshot)
wenzelm@64215
    84
wenzelm@64215
    85
          Build_Release.build_release(base_dir, parallel_jobs = 4,
wenzelm@64215
    86
            remote_mac = "macbroy30", website = Some(new_snapshot))
wenzelm@64215
    87
wenzelm@64215
    88
          if (release_snapshot.is_dir) File.mv(release_snapshot, old_snapshot)
wenzelm@64215
    89
          File.mv(new_snapshot, release_snapshot)
wenzelm@64215
    90
          Isabelle_System.rm_tree(old_snapshot)
wenzelm@64215
    91
        }))
wenzelm@64215
    92
wenzelm@64215
    93
wenzelm@64231
    94
  /* remote build_history */
wenzelm@64231
    95
wenzelm@64231
    96
  private sealed case class Remote_Build(
wenzelm@64231
    97
    host: String,
wenzelm@64231
    98
    user: String = "",
wenzelm@64231
    99
    port: Int = SSH.default_port,
wenzelm@64294
   100
    shared_home: Boolean = true,
wenzelm@64231
   101
    options: String = "",
wenzelm@64235
   102
    args: String = "-o timeout=10800 -a")
wenzelm@64231
   103
wenzelm@64231
   104
  private val remote_builds =
wenzelm@64231
   105
    List(
wenzelm@64294
   106
      Remote_Build("lxbroy10", options = "-m32 -M4 -N"),
wenzelm@64277
   107
      Remote_Build("macbroy2", options = "-m32 -M4"),
wenzelm@64277
   108
      Remote_Build("macbroy30", options = "-m32 -M2"),
wenzelm@64277
   109
      Remote_Build("macbroy31", options = "-m32 -M2"))
wenzelm@64231
   110
wenzelm@64231
   111
  private def remote_build_history(rev: String, r: Remote_Build): Logger_Task =
wenzelm@64294
   112
  {
wenzelm@64294
   113
    val task_name = "build_history-" + r.host
wenzelm@64294
   114
    Logger_Task(task_name, logger =>
wenzelm@64231
   115
      {
wenzelm@64231
   116
        using(logger.ssh_context.open_session(host = r.host, user = r.user, port = r.port))(
wenzelm@64259
   117
          ssh =>
wenzelm@64231
   118
            {
wenzelm@64231
   119
              val results =
wenzelm@64259
   120
                Build_History.remote_build_history(ssh,
wenzelm@64231
   121
                  isabelle_repos,
wenzelm@64231
   122
                  isabelle_repos.ext(r.host),
wenzelm@64236
   123
                  isabelle_repos_source = isabelle_dev_source,
wenzelm@64231
   124
                  self_update = !r.shared_home,
wenzelm@64294
   125
                  options =
wenzelm@64294
   126
                    r.options + " -f -r " + File.bash_string(rev) +
wenzelm@64294
   127
                      " -N " + File.bash_string(task_name),
wenzelm@64231
   128
                  args = r.args)
wenzelm@64231
   129
              for ((log, bytes) <- results)
wenzelm@64231
   130
                Bytes.write(logger.log_dir + Path.explode(log), bytes)
wenzelm@64231
   131
            })
wenzelm@64231
   132
      })
wenzelm@64294
   133
  }
wenzelm@64231
   134
wenzelm@64231
   135
wenzelm@64192
   136
wenzelm@64192
   137
  /** task logging **/
wenzelm@64171
   138
wenzelm@64193
   139
  sealed case class Logger_Task(name: String = "", body: Logger => Unit)
wenzelm@64154
   140
wenzelm@64257
   141
  class Log_Service private[Isabelle_Cronjob](progress: Progress, val ssh_context: SSH.Context)
wenzelm@64171
   142
  {
wenzelm@64219
   143
    current_log.file.delete
wenzelm@64219
   144
wenzelm@64171
   145
    private val thread: Consumer_Thread[String] =
wenzelm@64171
   146
      Consumer_Thread.fork("cronjob: logger", daemon = true)(
wenzelm@64171
   147
        consume = (text: String) =>
wenzelm@64219
   148
          { // critical
wenzelm@64219
   149
            File.append(current_log, text + "\n")
wenzelm@64219
   150
            File.append(cumulative_log, text + "\n")
wenzelm@64171
   151
            progress.echo(text)
wenzelm@64171
   152
            true
wenzelm@64171
   153
          })
wenzelm@64171
   154
wenzelm@64171
   155
    def shutdown() { thread.shutdown() }
wenzelm@64171
   156
wenzelm@64171
   157
    val hostname = Isabelle_System.hostname()
wenzelm@64171
   158
wenzelm@64171
   159
    def log(date: Date, task_name: String, msg: String): Unit =
wenzelm@64193
   160
      if (task_name != "")
wenzelm@64193
   161
        thread.send(
wenzelm@64193
   162
          "[" + Build_Log.print_date(date) + ", " + hostname + ", " + task_name + "]: " + msg)
wenzelm@64171
   163
wenzelm@64171
   164
    def start_logger(start_date: Date, task_name: String): Logger =
wenzelm@64171
   165
      new Logger(this, start_date, task_name)
wenzelm@64154
   166
wenzelm@64171
   167
    def run_task(start_date: Date, task: Logger_Task)
wenzelm@64171
   168
    {
wenzelm@64171
   169
      val logger = start_logger(start_date, task.name)
wenzelm@64171
   170
      val res = Exn.capture { task.body(logger) }
wenzelm@64171
   171
      val end_date = Date.now()
wenzelm@64171
   172
      val err =
wenzelm@64171
   173
        res match {
wenzelm@64171
   174
          case Exn.Res(_) => None
wenzelm@64171
   175
          case Exn.Exn(exn) => Some(Exn.message(exn))
wenzelm@64171
   176
        }
wenzelm@64171
   177
      logger.log_end(end_date, err)
wenzelm@64171
   178
    }
wenzelm@64171
   179
wenzelm@64171
   180
    def fork_task(start_date: Date, task: Logger_Task): Task =
wenzelm@64171
   181
      new Task(task.name, run_task(start_date, task))
wenzelm@64171
   182
  }
wenzelm@64171
   183
wenzelm@64171
   184
  class Logger private[Isabelle_Cronjob](
wenzelm@64171
   185
    val log_service: Log_Service, val start_date: Date, val task_name: String)
wenzelm@64162
   186
  {
wenzelm@64257
   187
    def ssh_context: SSH.Context = log_service.ssh_context
wenzelm@64231
   188
wenzelm@64171
   189
    def log(date: Date, msg: String): Unit = log_service.log(date, task_name, msg)
wenzelm@64171
   190
wenzelm@64171
   191
    def log_end(end_date: Date, err: Option[String])
wenzelm@64171
   192
    {
wenzelm@64171
   193
      val elapsed_time = end_date.time - start_date.time
wenzelm@64171
   194
      val msg =
wenzelm@64171
   195
        (if (err.isEmpty) "finished" else "ERROR " + err.get) +
wenzelm@64197
   196
        (if (elapsed_time.seconds < 3.0) "" else " (" + elapsed_time.message_hms + " elapsed time)")
wenzelm@64171
   197
      log(end_date, msg)
wenzelm@64171
   198
    }
wenzelm@64171
   199
wenzelm@64195
   200
    val log_dir: Path = main_dir + Build_Log.log_subdir(start_date)
wenzelm@64195
   201
wenzelm@64195
   202
    Isabelle_System.mkdirs(log_dir)
wenzelm@64171
   203
    log(start_date, "started")
wenzelm@64171
   204
  }
wenzelm@64171
   205
wenzelm@64171
   206
  class Task private[Isabelle_Cronjob](name: String, body: => Unit)
wenzelm@64171
   207
  {
wenzelm@64171
   208
    private val future: Future[Unit] = Future.thread("cronjob: " + name) { body }
wenzelm@64171
   209
    def is_finished: Boolean = future.is_finished
wenzelm@64162
   210
  }
wenzelm@64153
   211
wenzelm@64170
   212
wenzelm@64170
   213
wenzelm@64153
   214
  /** cronjob **/
wenzelm@64153
   215
wenzelm@64187
   216
  def cronjob(progress: Progress, exclude_task: Set[String])
wenzelm@64153
   217
  {
wenzelm@64171
   218
    /* soft lock */
wenzelm@64153
   219
wenzelm@64153
   220
    val still_running =
wenzelm@64153
   221
      try { Some(File.read(main_state_file)) }
wenzelm@64153
   222
      catch { case ERROR(_) => None }
wenzelm@64153
   223
wenzelm@64153
   224
    still_running match {
wenzelm@64170
   225
      case None | Some("") =>
wenzelm@64153
   226
      case Some(running) =>
wenzelm@64153
   227
        error("Isabelle cronjob appears to be still running: " + running)
wenzelm@64153
   228
    }
wenzelm@64153
   229
wenzelm@64199
   230
wenzelm@64199
   231
    /* log service */
wenzelm@64199
   232
wenzelm@64257
   233
    val log_service = new Log_Service(progress, SSH.init_context(Options.init()))
wenzelm@64154
   234
wenzelm@64199
   235
    def run(start_date: Date, task: Logger_Task) { log_service.run_task(start_date, task) }
wenzelm@64199
   236
wenzelm@64199
   237
    def run_now(task: Logger_Task) { run(Date.now(), task) }
wenzelm@64154
   238
wenzelm@64154
   239
wenzelm@64199
   240
    /* structured tasks */
wenzelm@64184
   241
wenzelm@64199
   242
    def SEQ(tasks: Logger_Task*): Logger_Task = Logger_Task(body = _ =>
wenzelm@64193
   243
      for (task <- tasks.iterator if !exclude_task(task.name) || task.name == "")
wenzelm@64199
   244
        run_now(task))
wenzelm@64153
   245
wenzelm@64199
   246
    def PAR(tasks: Logger_Task*): Logger_Task = Logger_Task(body = _ =>
wenzelm@64170
   247
      {
wenzelm@64199
   248
        @tailrec def join(running: List[Task])
wenzelm@64199
   249
        {
wenzelm@64199
   250
          running.partition(_.is_finished) match {
wenzelm@64199
   251
            case (Nil, Nil) =>
wenzelm@64199
   252
            case (Nil, _ :: _) => Thread.sleep(500); join(running)
wenzelm@64199
   253
            case (_ :: _, remaining) => join(remaining)
wenzelm@64199
   254
          }
wenzelm@64170
   255
        }
wenzelm@64199
   256
        val start_date = Date.now()
wenzelm@64199
   257
        val running =
wenzelm@64199
   258
          for (task <- tasks.toList if !exclude_task(task.name))
wenzelm@64199
   259
            yield log_service.fork_task(start_date, task)
wenzelm@64199
   260
        join(running)
wenzelm@64199
   261
      })
wenzelm@64193
   262
wenzelm@64170
   263
wenzelm@64170
   264
    /* main */
wenzelm@64170
   265
wenzelm@64199
   266
    val main_start_date = Date.now()
wenzelm@64199
   267
    File.write(main_state_file, main_start_date + " " + log_service.hostname)
wenzelm@64199
   268
wenzelm@64232
   269
    val rev = Mercurial.repository(isabelle_repos).id()
wenzelm@64231
   270
wenzelm@64193
   271
    run(main_start_date,
wenzelm@64193
   272
      Logger_Task("isabelle_cronjob", _ =>
wenzelm@64231
   273
        run_now(
wenzelm@64231
   274
          SEQ(isabelle_identify, build_history_base, build_release,
wenzelm@64231
   275
            PAR(remote_builds.map(remote_build_history(rev, _)):_*)))))
wenzelm@64153
   276
wenzelm@64171
   277
    log_service.shutdown()
wenzelm@64170
   278
wenzelm@64153
   279
    main_state_file.file.delete
wenzelm@64153
   280
  }
wenzelm@64153
   281
wenzelm@64153
   282
wenzelm@64153
   283
wenzelm@64153
   284
  /** command line entry point **/
wenzelm@64153
   285
wenzelm@64148
   286
  def main(args: Array[String])
wenzelm@64148
   287
  {
wenzelm@64148
   288
    Command_Line.tool0 {
wenzelm@64148
   289
      var force = false
wenzelm@64148
   290
      var verbose = false
wenzelm@64187
   291
      var exclude_task = Set.empty[String]
wenzelm@64148
   292
wenzelm@64148
   293
      val getopts = Getopts("""
wenzelm@64148
   294
Usage: Admin/cronjob/main [OPTIONS]
wenzelm@64148
   295
wenzelm@64148
   296
  Options are:
wenzelm@64148
   297
    -f           apply force to do anything
wenzelm@64148
   298
    -v           verbose
wenzelm@64187
   299
    -x NAME      exclude tasks with this name
wenzelm@64148
   300
""",
wenzelm@64148
   301
        "f" -> (_ => force = true),
wenzelm@64187
   302
        "v" -> (_ => verbose = true),
wenzelm@64187
   303
        "x:" -> (arg => exclude_task += arg))
wenzelm@64148
   304
wenzelm@64148
   305
      val more_args = getopts(args)
wenzelm@64148
   306
      if (more_args.nonEmpty) getopts.usage()
wenzelm@64148
   307
wenzelm@64153
   308
      val progress = if (verbose) new Console_Progress() else Ignore_Progress
wenzelm@64148
   309
wenzelm@64187
   310
      if (force) cronjob(progress, exclude_task)
wenzelm@64153
   311
      else error("Need to apply force to do anything")
wenzelm@64148
   312
    }
wenzelm@64148
   313
  }
wenzelm@64148
   314
}