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