src/HOL/Tools/ATP_Manager/atp_wrapper.ML
author blanchet
Wed Mar 24 14:49:32 2010 +0100 (2010-03-24)
changeset 35969 c9565298df9e
parent 35869 cac366550624
child 36001 992839c4be90
permissions -rw-r--r--
added support for Sledgehammer parameters;
this change goes hand in hand with f8c738abaed8
wenzelm@32327
     1
(*  Title:      HOL/Tools/ATP_Manager/atp_wrapper.ML
wenzelm@28592
     2
    Author:     Fabian Immler, TU Muenchen
wenzelm@28592
     3
wenzelm@28592
     4
Wrapper functions for external ATPs.
wenzelm@28592
     5
*)
wenzelm@28592
     6
wenzelm@28592
     7
signature ATP_WRAPPER =
wenzelm@28592
     8
sig
blanchet@35867
     9
  type prover = ATP_Manager.prover
boehmes@32864
    10
blanchet@35867
    11
  (* hooks for problem files *)
blanchet@35867
    12
  val destdir : string Config.T
blanchet@35867
    13
  val problem_prefix : string Config.T
blanchet@35867
    14
  val measure_runtime : bool Config.T
boehmes@32864
    15
blanchet@35867
    16
  val refresh_systems_on_tptp : unit -> unit
blanchet@35867
    17
  val setup : theory -> theory
wenzelm@28592
    18
end;
wenzelm@28592
    19
blanchet@35865
    20
structure ATP_Wrapper : ATP_WRAPPER =
wenzelm@28592
    21
struct
wenzelm@28596
    22
blanchet@35969
    23
open Sledgehammer_Fact_Preprocessor
blanchet@35865
    24
open Sledgehammer_HOL_Clause
blanchet@35865
    25
open Sledgehammer_Fact_Filter
blanchet@35865
    26
open Sledgehammer_Proof_Reconstruct
blanchet@35867
    27
open ATP_Manager
blanchet@35826
    28
wenzelm@28596
    29
(** generic ATP wrapper **)
wenzelm@28596
    30
wenzelm@32944
    31
(* external problem files *)
boehmes@32864
    32
boehmes@32864
    33
val (destdir, destdir_setup) = Attrib.config_string "atp_destdir" "";
boehmes@32864
    34
  (*Empty string means create files in Isabelle's temporary files directory.*)
boehmes@32864
    35
boehmes@32864
    36
val (problem_prefix, problem_prefix_setup) =
boehmes@32864
    37
  Attrib.config_string "atp_problem_prefix" "prob";
boehmes@32864
    38
boehmes@33247
    39
val (measure_runtime, measure_runtime_setup) =
boehmes@33247
    40
  Attrib.config_bool "atp_measure_runtime" false;
boehmes@33247
    41
boehmes@32864
    42
blanchet@35867
    43
(* prover configuration *)
boehmes@32864
    44
wenzelm@32941
    45
type prover_config =
wenzelm@32941
    46
 {command: Path.T,
blanchet@35969
    47
  arguments: Time.time -> string,
blanchet@35865
    48
  failure_strs: string list,
boehmes@32864
    49
  max_new_clauses: int,
blanchet@35969
    50
  add_theory_const: bool,
blanchet@35969
    51
  supports_isar_proofs: bool};
wenzelm@28596
    52
wenzelm@28596
    53
wenzelm@28596
    54
(* basic template *)
wenzelm@28596
    55
boehmes@32458
    56
fun with_path cleanup after f path =
boehmes@32458
    57
  Exn.capture f path
boehmes@32458
    58
  |> tap (fn _ => cleanup path)
boehmes@32458
    59
  |> Exn.release
wenzelm@32941
    60
  |> tap (after path);
boehmes@32458
    61
blanchet@35865
    62
fun find_failure strs proof =
blanchet@35865
    63
  case filter (fn s => String.isSubstring s proof) strs of
blanchet@35865
    64
    [] => if is_proof_well_formed proof then NONE
blanchet@35865
    65
          else SOME "Ill-formed ATP output"
blanchet@35865
    66
  | (failure :: _) => SOME failure
blanchet@35865
    67
blanchet@35969
    68
fun generic_prover get_facts prepare write cmd args failure_strs produce_answer
blanchet@35969
    69
        name ({full_types, ...} : params)
blanchet@35969
    70
        ({subgoal, goal, relevance_override, axiom_clauses, filtered_clauses}
blanchet@35969
    71
         : problem) =
wenzelm@28596
    72
  let
immler@31750
    73
    (* get clauses and prepare them for writing *)
wenzelm@32942
    74
    val (ctxt, (chain_ths, th)) = goal;
wenzelm@32942
    75
    val thy = ProofContext.theory_of ctxt;
blanchet@35865
    76
    val chain_ths = map (Thm.put_name_hint chained_hint) chain_ths;
blanchet@35969
    77
    val goal_cls = #1 (neg_conjecture_clauses ctxt th subgoal);
immler@31752
    78
    val the_filtered_clauses =
wenzelm@32942
    79
      (case filtered_clauses of
blanchet@35969
    80
        NONE => get_facts relevance_override goal goal_cls
wenzelm@32942
    81
      | SOME fcls => fcls);
immler@31409
    82
    val the_axiom_clauses =
wenzelm@32942
    83
      (case axiom_clauses of
wenzelm@32942
    84
        NONE => the_filtered_clauses
wenzelm@32942
    85
      | SOME axcls => axcls);
blanchet@35969
    86
    val (internal_thm_names, clauses) =
wenzelm@32942
    87
      prepare goal_cls chain_ths the_axiom_clauses the_filtered_clauses thy;
immler@31750
    88
boehmes@32864
    89
    (* path to unique problem file *)
wenzelm@32942
    90
    val destdir' = Config.get ctxt destdir;
wenzelm@32942
    91
    val problem_prefix' = Config.get ctxt problem_prefix;
boehmes@32864
    92
    fun prob_pathname nr =
wenzelm@32942
    93
      let val probfile =
wenzelm@32942
    94
        Path.basic (problem_prefix' ^ serial_string () ^ "_" ^ string_of_int nr)
wenzelm@32942
    95
      in
wenzelm@32942
    96
        if destdir' = "" then File.tmp_path probfile
wenzelm@35570
    97
        else if File.exists (Path.explode destdir')
wenzelm@35570
    98
        then Path.append  (Path.explode destdir') probfile
boehmes@32864
    99
        else error ("No such directory: " ^ destdir')
wenzelm@32942
   100
      end;
boehmes@32864
   101
immler@31750
   102
    (* write out problem file and call prover *)
boehmes@33247
   103
    fun cmd_line probfile =
boehmes@33247
   104
      if Config.get ctxt measure_runtime
boehmes@33247
   105
      then (* Warning: suppresses error messages of ATPs *)
boehmes@33247
   106
        "TIMEFORMAT='%3U'; { time " ^ space_implode " " [File.shell_path cmd,
boehmes@33247
   107
        args, File.shell_path probfile] ^ " 2> /dev/null" ^ " ; } 2>&1"
boehmes@33247
   108
      else
boehmes@33247
   109
        space_implode " " ["exec", File.shell_path cmd, args,
boehmes@33247
   110
        File.shell_path probfile];
boehmes@32510
   111
    fun split_time s =
boehmes@32510
   112
      let
wenzelm@32942
   113
        val split = String.tokens (fn c => str c = "\n");
wenzelm@32942
   114
        val (proof, t) = s |> split |> split_last |> apfst cat_lines;
wenzelm@32942
   115
        fun as_num f = f >> (fst o read_int);
wenzelm@32942
   116
        val num = as_num (Scan.many1 Symbol.is_ascii_digit);
wenzelm@32942
   117
        val digit = Scan.one Symbol.is_ascii_digit;
wenzelm@32942
   118
        val num3 = as_num (digit ::: digit ::: (digit >> single));
wenzelm@32942
   119
        val time = num --| Scan.$$ "." -- num3 >> (fn (a, b) => a * 1000 + b);
wenzelm@32942
   120
        val as_time = the_default 0 o Scan.read Symbol.stopper time o explode;
wenzelm@32942
   121
      in (proof, as_time t) end;
boehmes@33247
   122
    fun split_time' s =
boehmes@33247
   123
      if Config.get ctxt measure_runtime then split_time s else (s, 0)
boehmes@32458
   124
    fun run_on probfile =
wenzelm@32942
   125
      if File.exists cmd then
blanchet@35969
   126
        write full_types probfile clauses
wenzelm@35010
   127
        |> pair (apfst split_time' (bash_output (cmd_line probfile)))
wenzelm@32942
   128
      else error ("Bad executable: " ^ Path.implode cmd);
wenzelm@28592
   129
immler@31751
   130
    (* if problemfile has not been exported, delete problemfile; otherwise export proof, too *)
wenzelm@32942
   131
    fun cleanup probfile = if destdir' = "" then try File.rm probfile else NONE;
wenzelm@32942
   132
    fun export probfile (((proof, _), _), _) =
wenzelm@32942
   133
      if destdir' = "" then ()
wenzelm@32942
   134
      else File.write (Path.explode (Path.implode probfile ^ "_proof")) proof;
wenzelm@32257
   135
blanchet@35969
   136
    val (((proof, atp_run_time_in_msecs), rc), conj_pos) =
wenzelm@35570
   137
      with_path cleanup export run_on (prob_pathname subgoal);
boehmes@32458
   138
immler@29590
   139
    (* check for success and print out some information on failure *)
blanchet@35865
   140
    val failure = find_failure failure_strs proof;
wenzelm@32942
   141
    val success = rc = 0 andalso is_none failure;
blanchet@35969
   142
    val (message, relevant_thm_names) =
boehmes@32451
   143
      if is_some failure then ("External prover failed.", [])
boehmes@32451
   144
      else if rc <> 0 then ("External prover failed: " ^ proof, [])
blanchet@35969
   145
      else
blanchet@35969
   146
        (produce_answer name (proof, internal_thm_names, conj_pos, ctxt, th,
blanchet@35969
   147
                              subgoal));
boehmes@32864
   148
  in
wenzelm@32941
   149
    {success = success, message = message,
blanchet@35969
   150
     relevant_thm_names = relevant_thm_names,
blanchet@35969
   151
     atp_run_time_in_msecs = atp_run_time_in_msecs, proof = proof,
blanchet@35969
   152
     internal_thm_names = internal_thm_names,
blanchet@35969
   153
     filtered_clauses = the_filtered_clauses}
wenzelm@32942
   154
  end;
wenzelm@28592
   155
wenzelm@28596
   156
wenzelm@28596
   157
(* generic TPTP-based provers *)
wenzelm@28596
   158
blanchet@35865
   159
fun generic_tptp_prover
blanchet@35865
   160
        (name, {command, arguments, failure_strs, max_new_clauses,
blanchet@35969
   161
                add_theory_const, supports_isar_proofs})
blanchet@35969
   162
        (params as {relevance_threshold, higher_order, follow_defs, isar_proof,
blanchet@35969
   163
                    ...}) timeout =
blanchet@35969
   164
  generic_prover
blanchet@35969
   165
      (get_relevant_facts relevance_threshold higher_order follow_defs
blanchet@35969
   166
                          max_new_clauses add_theory_const)
blanchet@35969
   167
      (prepare_clauses higher_order false) write_tptp_file command
blanchet@35969
   168
      (arguments timeout) failure_strs
blanchet@35969
   169
      (if supports_isar_proofs andalso isar_proof then structured_isar_proof
blanchet@35969
   170
       else metis_lemma_list false) name params;
wenzelm@28596
   171
blanchet@35969
   172
fun tptp_prover name p = (name, generic_tptp_prover (name, p));
wenzelm@28596
   173
wenzelm@32941
   174
boehmes@32864
   175
(** common provers **)
wenzelm@28592
   176
wenzelm@28596
   177
(* Vampire *)
wenzelm@28596
   178
blanchet@35969
   179
(* NB: Vampire does not work without explicit time limit. *)
wenzelm@28596
   180
blanchet@35969
   181
val vampire_config : prover_config =
blanchet@35969
   182
  {command = Path.explode "$VAMPIRE_HOME/vampire",
blanchet@35969
   183
   arguments = (fn timeout => "--output_syntax tptp --mode casc -t " ^
blanchet@35969
   184
                              string_of_int (Time.toSeconds timeout)),
blanchet@35969
   185
   failure_strs =
blanchet@35969
   186
     ["Satisfiability detected", "Refutation not found", "CANNOT PROVE"],
blanchet@35969
   187
   max_new_clauses = 60,
blanchet@35969
   188
   add_theory_const = false,
blanchet@35969
   189
   supports_isar_proofs = true}
blanchet@35969
   190
val vampire = tptp_prover "vampire" vampire_config
wenzelm@28596
   191
wenzelm@28592
   192
wenzelm@28596
   193
(* E prover *)
wenzelm@28596
   194
blanchet@35969
   195
val e_config : prover_config =
blanchet@35969
   196
  {command = Path.explode "$E_HOME/eproof",
blanchet@35969
   197
   arguments = (fn timeout => "--tstp-in --tstp-out -l5 -xAutoDev \
blanchet@35969
   198
                              \-tAutoDev --silent --cpu-limit=" ^
blanchet@35969
   199
                              string_of_int (Time.toSeconds timeout)),
blanchet@35969
   200
   failure_strs =
blanchet@35969
   201
       ["SZS status: Satisfiable", "SZS status Satisfiable",
blanchet@35969
   202
        "SZS status: ResourceOut", "SZS status ResourceOut",
blanchet@35969
   203
        "# Cannot determine problem status"],
blanchet@35969
   204
   max_new_clauses = 100,
blanchet@35969
   205
   add_theory_const = false,
blanchet@35969
   206
   supports_isar_proofs = true}
blanchet@35969
   207
val e = tptp_prover "e" e_config
wenzelm@28596
   208
wenzelm@28596
   209
wenzelm@28596
   210
(* SPASS *)
wenzelm@28592
   211
blanchet@35865
   212
fun generic_dfg_prover
blanchet@35865
   213
        (name, ({command, arguments, failure_strs, max_new_clauses,
blanchet@35969
   214
                 add_theory_const, ...} : prover_config))
blanchet@35969
   215
        (params as {relevance_threshold, higher_order, follow_defs, ...})
blanchet@35969
   216
        timeout =
blanchet@35969
   217
  generic_prover
blanchet@35969
   218
      (get_relevant_facts relevance_threshold higher_order follow_defs
blanchet@35969
   219
                          max_new_clauses add_theory_const)
blanchet@35969
   220
      (prepare_clauses higher_order true) write_dfg_file command
blanchet@35969
   221
      (arguments timeout) failure_strs (metis_lemma_list true) name params;
boehmes@32869
   222
blanchet@35865
   223
fun dfg_prover (name, p) = (name, generic_dfg_prover (name, p));
boehmes@32869
   224
blanchet@35969
   225
fun spass_config_for add_theory_const : prover_config =
blanchet@35969
   226
 {command = Path.explode "$SPASS_HOME/SPASS",
blanchet@35969
   227
  arguments = (fn timeout => "-Auto -SOS=1 -PGiven=0 -PProblem=0 -Splits=0" ^
blanchet@35969
   228
    " -FullRed=0 -DocProof -TimeLimit=" ^
blanchet@35969
   229
    string_of_int (Time.toSeconds timeout)),
blanchet@35969
   230
  failure_strs =
blanchet@35969
   231
    ["SPASS beiseite: Completion found.", "SPASS beiseite: Ran out of time.",
blanchet@35969
   232
     "SPASS beiseite: Maximal number of loops exceeded."],
blanchet@35969
   233
  max_new_clauses = 40,
blanchet@35969
   234
  add_theory_const = add_theory_const,
blanchet@35969
   235
  supports_isar_proofs = false};
blanchet@35969
   236
blanchet@35969
   237
val spass_config = spass_config_for true
blanchet@35969
   238
val spass = dfg_prover ("spass", spass_config)
blanchet@35969
   239
blanchet@35969
   240
val spass_no_tc_config = spass_config_for false
blanchet@35969
   241
val spass_no_tc = dfg_prover ("spass_no_tc", spass_no_tc_config)
wenzelm@28592
   242
wenzelm@28596
   243
wenzelm@28596
   244
(* remote prover invocation via SystemOnTPTP *)
wenzelm@28596
   245
wenzelm@32942
   246
val systems = Synchronized.var "atp_wrapper_systems" ([]: string list);
immler@31835
   247
immler@31835
   248
fun get_systems () =
immler@31835
   249
  let
blanchet@35969
   250
    val (answer, rc) = bash_output "\"$ISABELLE_ATP_MANAGER/SystemOnTPTP\" -w"
immler@31835
   251
  in
blanchet@35969
   252
    if rc <> 0 then
blanchet@35969
   253
      error ("Failed to get available systems at SystemOnTPTP:\n" ^ answer)
blanchet@35969
   254
    else
blanchet@35969
   255
      split_lines answer
immler@31835
   256
  end;
immler@31835
   257
blanchet@35867
   258
fun refresh_systems_on_tptp () =
blanchet@35867
   259
  Synchronized.change systems (fn _ => get_systems ());
immler@31835
   260
immler@31835
   261
fun get_system prefix = Synchronized.change_result systems (fn systems =>
boehmes@32864
   262
  (if null systems then get_systems () else systems)
wenzelm@32942
   263
  |> `(find_first (String.isPrefix prefix)));
boehmes@32864
   264
wenzelm@32948
   265
fun the_system prefix =
boehmes@32864
   266
  (case get_system prefix of
blanchet@35826
   267
    NONE => error ("System " ^ quote prefix ^ " not available at SystemOnTPTP")
wenzelm@32942
   268
  | SOME sys => sys);
immler@31835
   269
blanchet@35865
   270
val remote_failure_strs = ["Remote-script could not extract proof"];
blanchet@35865
   271
blanchet@35969
   272
fun remote_prover_config prover_prefix args max_new_clauses add_theory_const
blanchet@35969
   273
                         : prover_config =
blanchet@35969
   274
  {command = Path.explode "$ISABELLE_ATP_MANAGER/SystemOnTPTP",
blanchet@35969
   275
   arguments = (fn timeout =>
blanchet@35969
   276
     args ^ " -t " ^ string_of_int (Time.toSeconds timeout) ^ " -s " ^
blanchet@35969
   277
     the_system prover_prefix),
blanchet@35969
   278
   failure_strs = remote_failure_strs,
blanchet@35969
   279
   max_new_clauses = max_new_clauses,
blanchet@35969
   280
   add_theory_const = add_theory_const,
blanchet@35969
   281
   supports_isar_proofs = false}
wenzelm@28596
   282
blanchet@35969
   283
val remote_vampire =
blanchet@35969
   284
  tptp_prover "remote_vampire"
blanchet@35969
   285
      (remote_prover_config "Vampire---9" ""
blanchet@35969
   286
           (#max_new_clauses vampire_config) (#add_theory_const vampire_config))
boehmes@32864
   287
blanchet@35969
   288
val remote_e =
blanchet@35969
   289
  tptp_prover "remote_e"
blanchet@35969
   290
      (remote_prover_config "EP---" ""
blanchet@35969
   291
           (#max_new_clauses e_config) (#add_theory_const e_config))
boehmes@32864
   292
blanchet@35969
   293
val remote_spass =
blanchet@35969
   294
  tptp_prover "remote_spass"
blanchet@35969
   295
      (remote_prover_config "SPASS---" "-x"
blanchet@35969
   296
           (#max_new_clauses spass_config) (#add_theory_const spass_config))
wenzelm@28592
   297
blanchet@35867
   298
val provers =
blanchet@35969
   299
  [spass, vampire, e, spass_no_tc, remote_vampire, remote_spass, remote_e]
blanchet@35867
   300
val prover_setup = fold add_prover provers
blanchet@35867
   301
blanchet@35867
   302
val setup =
blanchet@35867
   303
  destdir_setup
blanchet@35867
   304
  #> problem_prefix_setup
blanchet@35867
   305
  #> measure_runtime_setup
blanchet@35867
   306
  #> prover_setup;
blanchet@35867
   307
wenzelm@28592
   308
end;