src/HOL/Tools/atp_manager.ML
author immler@in.tum.de
Wed Jan 21 15:22:51 2009 +0100 (2009-01-21)
changeset 29598 ba7e19085fc5
parent 29596 7b710756609c
child 29620 dc1257eaa4f2
permissions -rw-r--r--
2 provers
wenzelm@28477
     1
(*  Title:      HOL/Tools/atp_manager.ML
wenzelm@28477
     2
    Author:     Fabian Immler, TU Muenchen
wenzelm@28477
     3
wenzelm@28571
     4
ATP threads are registered here.
wenzelm@28571
     5
Threads with the same birth-time are seen as one group.
wenzelm@28571
     6
All threads of a group are killed when one thread of it has been successful,
wenzelm@28571
     7
or after a certain time,
wenzelm@28571
     8
or when the maximum number of threads exceeds; then the oldest thread is killed.
wenzelm@28477
     9
*)
wenzelm@28477
    10
wenzelm@28477
    11
signature ATP_MANAGER =
wenzelm@28477
    12
sig
wenzelm@28586
    13
  val get_atps: unit -> string
wenzelm@28477
    14
  val set_atps: string -> unit
wenzelm@28586
    15
  val get_max_atps: unit -> int
wenzelm@28586
    16
  val set_max_atps: int -> unit
wenzelm@28586
    17
  val get_timeout: unit -> int
wenzelm@28477
    18
  val set_timeout: int -> unit
wenzelm@28586
    19
  val kill: unit -> unit
wenzelm@28586
    20
  val info: unit -> unit
wenzelm@29112
    21
  val messages: int option -> unit
immler@29593
    22
  type prover = int -> int -> Proof.state -> bool * string
wenzelm@28595
    23
  val add_prover: string -> prover -> theory -> theory
wenzelm@28484
    24
  val print_provers: theory -> unit
wenzelm@28571
    25
  val sledgehammer: string list -> Proof.state -> unit
wenzelm@28477
    26
end;
wenzelm@28477
    27
wenzelm@28586
    28
structure AtpManager: ATP_MANAGER =
wenzelm@28477
    29
struct
wenzelm@28477
    30
wenzelm@28586
    31
(** preferences **)
wenzelm@28586
    32
wenzelm@29112
    33
val message_store_limit = 20;
wenzelm@29112
    34
val message_display_limit = 5;
wenzelm@29112
    35
wenzelm@28586
    36
local
wenzelm@28586
    37
immler@29598
    38
val atps = ref "e remote_vampire";
wenzelm@28586
    39
val max_atps = ref 5;   (* ~1 means infinite number of atps *)
immler@29590
    40
val timeout = ref 100;
wenzelm@28586
    41
wenzelm@28586
    42
in
wenzelm@28586
    43
wenzelm@28586
    44
fun get_atps () = CRITICAL (fn () => ! atps);
wenzelm@28586
    45
fun set_atps str = CRITICAL (fn () => atps := str);
wenzelm@28586
    46
wenzelm@28586
    47
fun get_max_atps () = CRITICAL (fn () => ! max_atps);
wenzelm@28586
    48
fun set_max_atps number = CRITICAL (fn () => max_atps := number);
wenzelm@28586
    49
wenzelm@28586
    50
fun get_timeout () = CRITICAL (fn () => ! timeout);
wenzelm@28586
    51
fun set_timeout time = CRITICAL (fn () => timeout := time);
wenzelm@28586
    52
wenzelm@28586
    53
val _ =
wenzelm@28586
    54
  ProofGeneralPgip.add_preference "Proof"
wenzelm@28586
    55
    (Preferences.string_pref atps
wenzelm@28589
    56
      "ATP: provers" "Default automatic provers (separated by whitespace)");
wenzelm@28586
    57
wenzelm@28586
    58
val _ = ProofGeneralPgip.add_preference "Proof"
wenzelm@28586
    59
    (Preferences.int_pref max_atps
wenzelm@28589
    60
      "ATP: maximum number" "How many provers may run in parallel");
wenzelm@28586
    61
wenzelm@28586
    62
val _ = ProofGeneralPgip.add_preference "Proof"
wenzelm@28586
    63
    (Preferences.int_pref timeout
wenzelm@28589
    64
      "ATP: timeout" "ATPs will be interrupted after this time (in seconds)");
wenzelm@28586
    65
wenzelm@28586
    66
end;
wenzelm@28586
    67
wenzelm@28586
    68
wenzelm@28586
    69
wenzelm@28586
    70
(** thread management **)
wenzelm@28586
    71
wenzelm@28582
    72
(* data structures over threads *)
wenzelm@28582
    73
wenzelm@28582
    74
structure ThreadHeap = HeapFun
wenzelm@28582
    75
(
wenzelm@28582
    76
  type elem = Time.time * Thread.thread;
wenzelm@28582
    77
  fun ord ((a, _), (b, _)) = Time.compare (a, b);
wenzelm@28595
    78
);
wenzelm@28582
    79
wenzelm@28582
    80
val lookup_thread = AList.lookup Thread.equal;
wenzelm@28582
    81
val delete_thread = AList.delete Thread.equal;
wenzelm@28582
    82
val update_thread = AList.update Thread.equal;
wenzelm@28582
    83
wenzelm@28582
    84
wenzelm@28582
    85
(* state of thread manager *)
wenzelm@28477
    86
wenzelm@28582
    87
datatype T = State of
wenzelm@28582
    88
 {timeout_heap: ThreadHeap.T,
wenzelm@28582
    89
  oldest_heap: ThreadHeap.T,
wenzelm@28582
    90
  active: (Thread.thread * (Time.time * Time.time * string)) list,
wenzelm@29112
    91
  cancelling: (Thread.thread * (Time.time * Time.time * string)) list,
wenzelm@29112
    92
  messages: string list};
wenzelm@28582
    93
wenzelm@29112
    94
fun make_state timeout_heap oldest_heap active cancelling messages =
wenzelm@28582
    95
  State {timeout_heap = timeout_heap, oldest_heap = oldest_heap,
wenzelm@29112
    96
    active = active, cancelling = cancelling, messages = messages};
wenzelm@28582
    97
wenzelm@29112
    98
val state = Synchronized.var "atp_manager" (make_state ThreadHeap.empty ThreadHeap.empty [] [] []);
wenzelm@28477
    99
wenzelm@28582
   100
wenzelm@28586
   101
(* the managing thread *)
wenzelm@28582
   102
wenzelm@28582
   103
(*watches over running threads and interrupts them if required*)
wenzelm@28582
   104
val managing_thread = ref (NONE: Thread.thread option);
wenzelm@28477
   105
wenzelm@28582
   106
wenzelm@29150
   107
(* unregister thread *)
wenzelm@28582
   108
wenzelm@28595
   109
fun unregister (success, message) thread = Synchronized.change_result state
wenzelm@29150
   110
  (fn state as State {timeout_heap, oldest_heap, active, cancelling, messages} =>
wenzelm@29150
   111
    (case lookup_thread active thread of
wenzelm@29150
   112
      SOME (birthtime, _, description) =>
wenzelm@29150
   113
        let
wenzelm@29150
   114
          val (group, active') =
wenzelm@29150
   115
            if success then List.partition (fn (_, (tb, _, _)) => tb = birthtime) active
wenzelm@29150
   116
            else List.partition (fn (th, _) => Thread.equal (th, thread)) active
immler@29596
   117
          (* do not interrupt successful thread, as it needs to print out its message
immler@29596
   118
          (and terminates afterwards - see start_prover )*)
immler@29596
   119
          val group' = if success then delete_thread thread group else group
wenzelm@28582
   120
wenzelm@29150
   121
          val now = Time.now ()
wenzelm@29150
   122
          val cancelling' =
immler@29596
   123
            fold (fn (th, (tb, _, desc)) => update_thread (th, (tb, now, desc))) group' cancelling
wenzelm@28582
   124
wenzelm@29150
   125
          val msg = description ^ "\n" ^ message
wenzelm@29150
   126
          val message' = "Sledgehammer: " ^ msg ^
immler@29596
   127
            (if length group <= 1 then ""
immler@29596
   128
             else "\nInterrupted " ^ string_of_int (length group - 1) ^ " other group members")
wenzelm@29150
   129
          val messages' = msg ::
wenzelm@29150
   130
            (if length messages <= message_store_limit then messages
wenzelm@29150
   131
             else #1 (chop message_store_limit messages))
wenzelm@29150
   132
        in (message', make_state timeout_heap oldest_heap active' cancelling' messages') end
wenzelm@29150
   133
    | NONE => ("", state)));
wenzelm@28582
   134
wenzelm@28582
   135
wenzelm@28595
   136
(* kill excessive atp threads *)
wenzelm@28595
   137
wenzelm@28595
   138
fun excessive_atps active =
wenzelm@28595
   139
  let val max = get_max_atps ()
wenzelm@28595
   140
  in length active > max andalso max > ~1 end;
wenzelm@28595
   141
wenzelm@28595
   142
local
wenzelm@28595
   143
wenzelm@28595
   144
fun kill_oldest () =
wenzelm@28595
   145
  let exception Unchanged in
wenzelm@29112
   146
    Synchronized.change_result state
wenzelm@29112
   147
      (fn State {timeout_heap, oldest_heap, active, cancelling, messages} =>
wenzelm@28595
   148
        if ThreadHeap.is_empty oldest_heap orelse not (excessive_atps active)
wenzelm@28595
   149
        then raise Unchanged
wenzelm@28595
   150
        else
wenzelm@28595
   151
          let val ((_, oldest_thread), oldest_heap') = ThreadHeap.min_elem oldest_heap
wenzelm@29112
   152
          in (oldest_thread, make_state timeout_heap oldest_heap' active cancelling messages) end)
wenzelm@28595
   153
      |> (priority o unregister (false, "Interrupted (maximum number of ATPs exceeded)"))
wenzelm@28595
   154
    handle Unchanged => ()
wenzelm@28595
   155
  end;
wenzelm@28595
   156
wenzelm@28595
   157
in
wenzelm@28595
   158
wenzelm@28595
   159
fun kill_excessive () =
wenzelm@28595
   160
  let val State {active, ...} = Synchronized.value state
wenzelm@28595
   161
  in if excessive_atps active then (kill_oldest (); kill_excessive ()) else () end;
wenzelm@28595
   162
wenzelm@28595
   163
end;
wenzelm@28595
   164
wenzelm@28595
   165
wenzelm@28582
   166
(* start a watching thread which runs forever -- only one may exist *)
wenzelm@28582
   167
wenzelm@28586
   168
fun check_thread_manager () = CRITICAL (fn () =>
wenzelm@28582
   169
  if (case ! managing_thread of SOME thread => Thread.isActive thread | NONE => false)
wenzelm@28582
   170
  then () else managing_thread := SOME (SimpleThread.fork false (fn () =>
wenzelm@28571
   171
    let
wenzelm@28582
   172
      val min_wait_time = Time.fromMilliseconds 300
wenzelm@28582
   173
      val max_wait_time = Time.fromSeconds 10
wenzelm@28582
   174
wenzelm@28582
   175
      (* wait for next thread to cancel, or maximum*)
wenzelm@28582
   176
      fun time_limit (State {timeout_heap, ...}) =
wenzelm@28582
   177
        (case try ThreadHeap.min timeout_heap of
wenzelm@28582
   178
          NONE => SOME (Time.+ (Time.now (), max_wait_time))
wenzelm@28582
   179
        | SOME (time, _) => SOME time)
wenzelm@28582
   180
wenzelm@28582
   181
      (* action: cancel find threads whose timeout is reached, and interrupt cancelling threads *)
wenzelm@29112
   182
      fun action (State {timeout_heap, oldest_heap, active, cancelling, messages}) =
wenzelm@28582
   183
        let val (timeout_threads, timeout_heap') =
wenzelm@28582
   184
          ThreadHeap.upto (Time.now (), Thread.self ()) timeout_heap
wenzelm@28582
   185
        in
wenzelm@28595
   186
          if null timeout_threads andalso null cancelling andalso not (excessive_atps active)
wenzelm@28595
   187
          then NONE
wenzelm@28582
   188
          else
wenzelm@28582
   189
            let
wenzelm@28582
   190
              val _ = List.app (SimpleThread.interrupt o #1) cancelling
wenzelm@28582
   191
              val cancelling' = filter (Thread.isActive o #1) cancelling
wenzelm@29112
   192
              val state' = make_state timeout_heap' oldest_heap active cancelling' messages
wenzelm@28582
   193
            in SOME (map #2 timeout_threads, state') end
wenzelm@28582
   194
        end
wenzelm@28582
   195
    in
wenzelm@28582
   196
      while true do
wenzelm@28595
   197
       (Synchronized.timed_access state time_limit action
wenzelm@28582
   198
        |> these
wenzelm@28595
   199
        |> List.app (priority o unregister (false, "Interrupted (reached timeout)"));
wenzelm@28595
   200
        kill_excessive ();
wenzelm@28595
   201
        (*give threads time to respond to interrupt*)
wenzelm@28571
   202
        OS.Process.sleep min_wait_time)
wenzelm@28586
   203
    end)));
wenzelm@28582
   204
wenzelm@28582
   205
wenzelm@28582
   206
(* thread is registered here by sledgehammer *)
wenzelm@28477
   207
wenzelm@28582
   208
fun register birthtime deadtime (thread, desc) =
wenzelm@28582
   209
 (check_thread_manager ();
wenzelm@29112
   210
  Synchronized.change state
wenzelm@29112
   211
    (fn State {timeout_heap, oldest_heap, active, cancelling, messages} =>
wenzelm@29112
   212
      let
wenzelm@29112
   213
        val timeout_heap' = ThreadHeap.insert (deadtime, thread) timeout_heap
wenzelm@29112
   214
        val oldest_heap' = ThreadHeap.insert (birthtime, thread) oldest_heap
wenzelm@29112
   215
        val active' = update_thread (thread, (birthtime, deadtime, desc)) active
wenzelm@29112
   216
      in make_state timeout_heap' oldest_heap' active' cancelling messages end));
wenzelm@28477
   217
wenzelm@28477
   218
wenzelm@28586
   219
wenzelm@28586
   220
(** user commands **)
wenzelm@28582
   221
wenzelm@28586
   222
(* kill: move all threads to cancelling *)
wenzelm@28586
   223
wenzelm@28586
   224
fun kill () = Synchronized.change state
wenzelm@29112
   225
  (fn State {timeout_heap, oldest_heap, active, cancelling, messages} =>
wenzelm@28582
   226
    let val formerly_active = map (fn (th, (tb, _, desc)) => (th, (tb, Time.now (), desc))) active
wenzelm@29112
   227
    in make_state timeout_heap oldest_heap [] (formerly_active @ cancelling) messages end);
wenzelm@28582
   228
wenzelm@28582
   229
wenzelm@29112
   230
(* ATP info *)
wenzelm@28582
   231
wenzelm@28582
   232
fun info () =
wenzelm@28582
   233
  let
wenzelm@29112
   234
    val State {active, cancelling, ...} = Synchronized.value state
wenzelm@29112
   235
wenzelm@28571
   236
    fun running_info (_, (birth_time, dead_time, desc)) = "Running: "
wenzelm@28589
   237
        ^ (string_of_int o Time.toSeconds) (Time.- (Time.now (), birth_time))
wenzelm@28477
   238
        ^ " s  --  "
wenzelm@28589
   239
        ^ (string_of_int o Time.toSeconds) (Time.- (dead_time, Time.now ()))
wenzelm@28571
   240
        ^ " s to live:\n" ^ desc
wenzelm@28571
   241
    fun cancelling_info (_, (_, dead_time, desc)) = "Trying to interrupt thread since "
wenzelm@28586
   242
        ^ (string_of_int o Time.toSeconds) (Time.- (Time.now (), dead_time))
wenzelm@28571
   243
        ^ " s:\n" ^ desc
wenzelm@29112
   244
wenzelm@28589
   245
    val running =
wenzelm@28589
   246
      if null active then "No ATPs running."
wenzelm@28589
   247
      else space_implode "\n\n" ("Running ATPs:" :: map running_info active)
wenzelm@28589
   248
    val interrupting =
wenzelm@28589
   249
      if null cancelling then ""
wenzelm@28589
   250
      else space_implode "\n\n"
wenzelm@28589
   251
        ("Trying to interrupt the following ATPs:" :: map cancelling_info cancelling)
wenzelm@29112
   252
wenzelm@28582
   253
  in writeln (running ^ "\n" ^ interrupting) end;
wenzelm@28582
   254
wenzelm@29112
   255
fun messages opt_limit =
wenzelm@29112
   256
  let
wenzelm@29112
   257
    val limit = the_default message_display_limit opt_limit;
wenzelm@29112
   258
    val State {messages = msgs, ...} = Synchronized.value state
wenzelm@29112
   259
    val header = "Recent ATP messages" ^
wenzelm@29112
   260
      (if length msgs <= limit then ":" else " (" ^ string_of_int limit ^ " displayed):");
wenzelm@29116
   261
  in writeln (space_implode "\n\n" (header :: #1 (chop limit msgs))) end;
wenzelm@29112
   262
wenzelm@28582
   263
wenzelm@28477
   264
wenzelm@28586
   265
(** The Sledgehammer **)
wenzelm@28477
   266
wenzelm@28582
   267
(* named provers *)
wenzelm@28484
   268
immler@29593
   269
type prover = int -> int -> Proof.state -> bool * string;
wenzelm@28595
   270
wenzelm@28582
   271
fun err_dup_prover name = error ("Duplicate prover: " ^ quote name);
wenzelm@28477
   272
wenzelm@28582
   273
structure Provers = TheoryDataFun
wenzelm@28582
   274
(
wenzelm@28595
   275
  type T = (prover * stamp) Symtab.table
wenzelm@28582
   276
  val empty = Symtab.empty
wenzelm@28582
   277
  val copy = I
wenzelm@28582
   278
  val extend = I
wenzelm@28582
   279
  fun merge _ tabs : T = Symtab.merge (eq_snd op =) tabs
wenzelm@28589
   280
    handle Symtab.DUP dup => err_dup_prover dup
wenzelm@28582
   281
);
wenzelm@28484
   282
wenzelm@28595
   283
fun add_prover name prover thy =
wenzelm@28595
   284
  Provers.map (Symtab.update_new (name, (prover, stamp ()))) thy
wenzelm@28582
   285
    handle Symtab.DUP dup => err_dup_prover dup;
wenzelm@28582
   286
wenzelm@28582
   287
fun print_provers thy = Pretty.writeln
wenzelm@28582
   288
  (Pretty.strs ("external provers:" :: sort_strings (Symtab.keys (Provers.get thy))));
wenzelm@28571
   289
wenzelm@28586
   290
wenzelm@28595
   291
(* start prover thread *)
wenzelm@28484
   292
wenzelm@28595
   293
fun start_prover name birthtime deadtime i proof_state =
wenzelm@28595
   294
  (case Symtab.lookup (Provers.get (Proof.theory_of proof_state)) name of
wenzelm@28595
   295
    NONE => warning ("Unknown external prover: " ^ quote name)
wenzelm@28595
   296
  | SOME (prover, _) =>
wenzelm@28595
   297
      let
wenzelm@28595
   298
        val (ctxt, (_, goal)) = Proof.get_goal proof_state
wenzelm@28595
   299
        val desc =
wenzelm@28595
   300
          "external prover " ^ quote name ^ " for subgoal " ^ string_of_int i ^ ":\n" ^
wenzelm@28595
   301
            Syntax.string_of_term ctxt (Thm.term_of (Thm.cprem_of goal i))
wenzelm@28595
   302
        val _ = SimpleThread.fork true (fn () =>
wenzelm@28595
   303
          let
wenzelm@28595
   304
            val _ = register birthtime deadtime (Thread.self (), desc)
immler@29593
   305
            val result = prover (get_timeout ()) i proof_state
wenzelm@28835
   306
              handle ResHolClause.TOO_TRIVIAL
wenzelm@28835
   307
                => (true, "Empty clause: Try this command: " ^ Markup.markup Markup.sendback "apply metis")
wenzelm@28835
   308
              | ERROR msg
wenzelm@28835
   309
                => (false, "Error: " ^ msg)
wenzelm@28595
   310
            val _ = priority (unregister result (Thread.self ()))
wenzelm@28595
   311
          in () end handle Interrupt => ())
wenzelm@28595
   312
      in () end);
wenzelm@28582
   313
wenzelm@28582
   314
wenzelm@28582
   315
(* sledghammer for first subgoal *)
wenzelm@28582
   316
wenzelm@28582
   317
fun sledgehammer names proof_state =
wenzelm@28582
   318
  let
wenzelm@28595
   319
    val provers =
wenzelm@28586
   320
      if null names then String.tokens (Symbol.is_ascii_blank o String.str) (get_atps ())
wenzelm@28582
   321
      else names
wenzelm@28582
   322
    val birthtime = Time.now ()
wenzelm@28595
   323
    val deadtime = Time.+ (birthtime, Time.fromSeconds (get_timeout ()))
wenzelm@28595
   324
  in List.app (fn name => start_prover name birthtime deadtime 1 proof_state) provers end;
wenzelm@28582
   325
wenzelm@28582
   326
wenzelm@28586
   327
wenzelm@28586
   328
(** Isar command syntax **)
wenzelm@28582
   329
wenzelm@28582
   330
local structure K = OuterKeyword and P = OuterParse in
wenzelm@28582
   331
wenzelm@28582
   332
val _ =
wenzelm@28582
   333
  OuterSyntax.improper_command "atp_kill" "kill all managed provers" K.diag
wenzelm@28586
   334
    (Scan.succeed (Toplevel.no_timing o Toplevel.imperative kill));
wenzelm@28582
   335
wenzelm@28582
   336
val _ =
wenzelm@28582
   337
  OuterSyntax.improper_command "atp_info" "print information about managed provers" K.diag
wenzelm@28582
   338
    (Scan.succeed (Toplevel.no_timing o Toplevel.imperative info));
wenzelm@28582
   339
wenzelm@28582
   340
val _ =
wenzelm@29112
   341
  OuterSyntax.improper_command "atp_messages" "print recent messages issued by managed provers" K.diag
wenzelm@29112
   342
    (Scan.option (P.$$$ "(" |-- P.nat --| P.$$$ ")") >>
wenzelm@29112
   343
      (fn limit => Toplevel.no_timing o Toplevel.imperative (fn () => messages limit)));
wenzelm@29112
   344
wenzelm@29112
   345
val _ =
wenzelm@28582
   346
  OuterSyntax.improper_command "print_atps" "print external provers" K.diag
wenzelm@28582
   347
    (Scan.succeed (Toplevel.no_timing o Toplevel.unknown_theory o
wenzelm@28582
   348
      Toplevel.keep (print_provers o Toplevel.theory_of)));
wenzelm@28582
   349
wenzelm@28582
   350
val _ =
wenzelm@28582
   351
  OuterSyntax.command "sledgehammer" "call all automatic theorem provers" K.diag
wenzelm@28582
   352
    (Scan.repeat P.xname >> (fn names => Toplevel.no_timing o Toplevel.unknown_proof o
wenzelm@29112
   353
      Toplevel.keep ((sledgehammer names) o Toplevel.proof_of)));
wenzelm@28582
   354
wenzelm@28582
   355
end;
wenzelm@28582
   356
wenzelm@28582
   357
end;