src/HOL/Tools/ATP/atp_systems.ML
author blanchet
Wed Jul 28 23:01:27 2010 +0200 (2010-07-28)
changeset 38061 685d1f0f75b3
parent 38049 327705ac4759
child 38064 17fc92d33c24
permissions -rw-r--r--
handle Perl and "libwww-perl" failures more gracefully, giving the user some clues about what goes on
blanchet@38047
     1
(*  Title:      HOL/Tools/ATP/atp_systems.ML
wenzelm@28592
     2
    Author:     Fabian Immler, TU Muenchen
blanchet@36371
     3
    Author:     Jasmin Blanchette, TU Muenchen
wenzelm@28592
     4
blanchet@36376
     5
Setup for supported ATPs.
wenzelm@28592
     6
*)
wenzelm@28592
     7
blanchet@36376
     8
signature ATP_SYSTEMS =
wenzelm@28592
     9
sig
blanchet@38023
    10
  datatype failure =
blanchet@38023
    11
    Unprovable | IncompleteUnprovable | CantConnect | TimedOut |
blanchet@38061
    12
    OutOfResources | OldSpass | NoPerl | NoLibwwwPerl | MalformedInput |
blanchet@38061
    13
    MalformedOutput | UnknownError
blanchet@38023
    14
blanchet@38023
    15
  type prover_config =
blanchet@38032
    16
    {executable: string * string,
blanchet@38032
    17
     required_executables: (string * string) list,
blanchet@38023
    18
     arguments: bool -> Time.time -> string,
blanchet@38023
    19
     proof_delims: (string * string) list,
blanchet@38023
    20
     known_failures: (failure * string) list,
blanchet@38023
    21
     max_new_relevant_facts_per_iter: int,
blanchet@38023
    22
     prefers_theory_relevant: bool,
blanchet@38023
    23
     explicit_forall: bool}
blanchet@38023
    24
blanchet@38061
    25
  val string_for_failure : failure -> string
blanchet@38061
    26
  val known_failure_in_output :
blanchet@38061
    27
    string -> (failure * string) list -> failure option
blanchet@38023
    28
  val add_prover: string * prover_config -> theory -> theory
blanchet@38023
    29
  val get_prover: theory -> string -> prover_config
blanchet@38023
    30
  val available_atps: theory -> unit
blanchet@35867
    31
  val refresh_systems_on_tptp : unit -> unit
blanchet@36371
    32
  val default_atps_param_value : unit -> string
blanchet@35867
    33
  val setup : theory -> theory
wenzelm@28592
    34
end;
wenzelm@28592
    35
blanchet@36376
    36
structure ATP_Systems : ATP_SYSTEMS =
wenzelm@28592
    37
struct
wenzelm@28596
    38
blanchet@38023
    39
(* prover configuration *)
boehmes@32864
    40
blanchet@38023
    41
datatype failure =
blanchet@38061
    42
    Unprovable | IncompleteUnprovable | CantConnect | TimedOut |
blanchet@38061
    43
    OutOfResources | OldSpass | NoPerl | NoLibwwwPerl | MalformedInput |
blanchet@38061
    44
    MalformedOutput | UnknownError
boehmes@32864
    45
wenzelm@32941
    46
type prover_config =
blanchet@38032
    47
  {executable: string * string,
blanchet@38032
    48
   required_executables: (string * string) list,
blanchet@37514
    49
   arguments: bool -> Time.time -> string,
blanchet@36370
    50
   proof_delims: (string * string) list,
blanchet@36370
    51
   known_failures: (failure * string) list,
blanchet@38009
    52
   max_new_relevant_facts_per_iter: int,
blanchet@37994
    53
   prefers_theory_relevant: bool,
blanchet@37994
    54
   explicit_forall: bool}
wenzelm@28596
    55
blanchet@38061
    56
val missing_message_tail =
blanchet@38061
    57
  " appears to be missing. You will need to install it if you want to run \
blanchet@38061
    58
  \ATPs remotely."
blanchet@38061
    59
blanchet@38061
    60
fun string_for_failure Unprovable = "The ATP problem is unprovable."
blanchet@38061
    61
  | string_for_failure IncompleteUnprovable =
blanchet@38061
    62
    "The ATP cannot prove the problem."
blanchet@38061
    63
  | string_for_failure CantConnect = "Can't connect to remote ATP."
blanchet@38061
    64
  | string_for_failure TimedOut = "Timed out."
blanchet@38061
    65
  | string_for_failure OutOfResources = "The ATP ran out of resources."
blanchet@38061
    66
  | string_for_failure OldSpass =
blanchet@38061
    67
    "Warning: Isabelle requires a more recent version of SPASS with \
blanchet@38061
    68
    \support for the TPTP syntax. To install it, download and untar the \
blanchet@38061
    69
    \package \"http://www.cl.cam.ac.uk/research/hvg/Isabelle/dist/contrib/\
blanchet@38061
    70
    \spass-3.7.tar.gz\" and add the \"spass-3.7\" directory's absolute path \
blanchet@38061
    71
    \to " ^
blanchet@38061
    72
    quote (Path.implode (Path.expand (Path.appends
blanchet@38061
    73
               (Path.variable "ISABELLE_HOME_USER" ::
blanchet@38061
    74
                map Path.basic ["etc", "components"])))) ^
blanchet@38061
    75
    " on a line of its own."
blanchet@38061
    76
  | string_for_failure NoPerl = "Perl" ^ missing_message_tail
blanchet@38061
    77
  | string_for_failure NoLibwwwPerl =
blanchet@38061
    78
    "The Perl module \"libwww-perl\"" ^ missing_message_tail
blanchet@38061
    79
  | string_for_failure MalformedInput =
blanchet@38061
    80
    "Internal Isabelle error: The ATP problem is malformed. Please report \
blanchet@38061
    81
    \this to the Isabelle developers."
blanchet@38061
    82
  | string_for_failure MalformedOutput = "Error: The ATP output is malformed."
blanchet@38061
    83
  | string_for_failure UnknownError = "Error: An unknown ATP error occurred."
blanchet@38061
    84
blanchet@38061
    85
fun known_failure_in_output output =
blanchet@38061
    86
  find_first (fn (_, pattern) => String.isSubstring pattern output)
blanchet@38061
    87
  #> Option.map fst
blanchet@38061
    88
blanchet@38061
    89
val known_perl_failures =
blanchet@38061
    90
  [(NoPerl, "env: perl"),
blanchet@38061
    91
   (NoLibwwwPerl, "HTTP")]
wenzelm@28596
    92
blanchet@38023
    93
(* named provers *)
blanchet@38001
    94
blanchet@38023
    95
structure Data = Theory_Data
blanchet@38023
    96
(
blanchet@38023
    97
  type T = (prover_config * stamp) Symtab.table
blanchet@38023
    98
  val empty = Symtab.empty
blanchet@38023
    99
  val extend = I
blanchet@38023
   100
  fun merge data : T = Symtab.merge (eq_snd op =) data
blanchet@38023
   101
    handle Symtab.DUP name => error ("Duplicate ATP: " ^ quote name ^ ".")
blanchet@38023
   102
)
blanchet@38017
   103
blanchet@38023
   104
fun add_prover (name, config) thy =
blanchet@38023
   105
  Data.map (Symtab.update_new (name, (config, stamp ()))) thy
blanchet@38023
   106
  handle Symtab.DUP name => error ("Duplicate ATP: " ^ quote name ^ ".")
blanchet@38017
   107
blanchet@38023
   108
fun get_prover thy name =
blanchet@38023
   109
  the (Symtab.lookup (Data.get thy) name) |> fst
blanchet@38023
   110
  handle Option.Option => error ("Unknown ATP: " ^ name ^ ".")
blanchet@37962
   111
blanchet@38023
   112
fun available_atps thy =
blanchet@38023
   113
  priority ("Available ATPs: " ^
blanchet@38023
   114
            commas (sort_strings (Symtab.keys (Data.get thy))) ^ ".")
boehmes@32864
   115
blanchet@38023
   116
fun available_atps thy =
blanchet@38023
   117
  priority ("Available ATPs: " ^
blanchet@38023
   118
            commas (sort_strings (Symtab.keys (Data.get thy))) ^ ".")
wenzelm@28596
   119
blanchet@36382
   120
fun to_generous_secs time = (Time.toMilliseconds time + 999) div 1000
blanchet@36142
   121
wenzelm@28596
   122
(* E prover *)
wenzelm@28596
   123
blanchet@36369
   124
val tstp_proof_delims =
blanchet@36369
   125
  ("# SZS output start CNFRefutation.", "# SZS output end CNFRefutation")
blanchet@36369
   126
blanchet@35969
   127
val e_config : prover_config =
blanchet@38032
   128
  {executable = ("E_HOME", "eproof"),
blanchet@38032
   129
   required_executables = [],
blanchet@37514
   130
   arguments = fn _ => fn timeout =>
blanchet@36382
   131
     "--tstp-in --tstp-out -l5 -xAutoDev -tAutoDev --silent --cpu-limit=" ^
blanchet@36382
   132
     string_of_int (to_generous_secs timeout),
blanchet@36369
   133
   proof_delims = [tstp_proof_delims],
blanchet@36265
   134
   known_failures =
blanchet@37995
   135
     [(Unprovable, "SZS status: CounterSatisfiable"),
blanchet@37995
   136
      (Unprovable, "SZS status CounterSatisfiable"),
blanchet@36370
   137
      (TimedOut, "Failure: Resource limit exceeded (time)"),
blanchet@36370
   138
      (TimedOut, "time limit exceeded"),
blanchet@36370
   139
      (OutOfResources,
blanchet@36370
   140
       "# Cannot determine problem status within resource limit"),
blanchet@36370
   141
      (OutOfResources, "SZS status: ResourceOut"),
blanchet@36370
   142
      (OutOfResources, "SZS status ResourceOut")],
blanchet@38009
   143
   max_new_relevant_facts_per_iter = 80 (* FIXME *),
blanchet@37994
   144
   prefers_theory_relevant = false,
blanchet@37994
   145
   explicit_forall = false}
blanchet@38023
   146
val e = ("e", e_config)
wenzelm@28596
   147
wenzelm@28596
   148
blanchet@36219
   149
(* The "-VarWeight=3" option helps the higher-order problems, probably by
blanchet@36219
   150
   counteracting the presence of "hAPP". *)
blanchet@37498
   151
val spass_config : prover_config =
blanchet@38049
   152
  {executable = ("ISABELLE_ATP", "scripts/spass"),
blanchet@38032
   153
   required_executables = [("SPASS_HOME", "SPASS")],
blanchet@37550
   154
   (* "div 2" accounts for the fact that SPASS is often run twice. *)
blanchet@37514
   155
   arguments = fn complete => fn timeout =>
blanchet@37962
   156
     ("-Auto -PGiven=0 -PProblem=0 -Splits=0 -FullRed=0 -DocProof \
blanchet@37550
   157
      \-VarWeight=3 -TimeLimit=" ^
blanchet@37550
   158
      string_of_int (to_generous_secs timeout div 2))
blanchet@37514
   159
     |> not complete ? prefix "-SOS=1 ",
blanchet@36369
   160
   proof_delims = [("Here is a proof", "Formulae used in the proof")],
blanchet@36289
   161
   known_failures =
blanchet@38061
   162
     known_perl_failures @
blanchet@37413
   163
     [(IncompleteUnprovable, "SPASS beiseite: Completion found"),
blanchet@36370
   164
      (TimedOut, "SPASS beiseite: Ran out of time"),
blanchet@36965
   165
      (OutOfResources, "SPASS beiseite: Maximal number of loops exceeded"),
blanchet@37413
   166
      (MalformedInput, "Undefined symbol"),
blanchet@37414
   167
      (MalformedInput, "Free Variable"),
blanchet@37962
   168
      (OldSpass, "tptp2dfg")],
blanchet@38009
   169
   max_new_relevant_facts_per_iter = 26 (* FIXME *),
blanchet@37994
   170
   prefers_theory_relevant = true,
blanchet@37994
   171
   explicit_forall = true}
blanchet@38023
   172
val spass = ("spass", spass_config)
wenzelm@28596
   173
blanchet@37509
   174
(* Vampire *)
blanchet@37509
   175
blanchet@37509
   176
val vampire_config : prover_config =
blanchet@38032
   177
  {executable = ("VAMPIRE_HOME", "vampire"),
blanchet@38032
   178
   required_executables = [],
blanchet@37514
   179
   arguments = fn _ => fn timeout =>
blanchet@38033
   180
     "--mode casc -t " ^ string_of_int (to_generous_secs timeout) ^
blanchet@38033
   181
     " --input_file ",
blanchet@37509
   182
   proof_delims =
blanchet@37509
   183
     [("=========== Refutation ==========",
blanchet@37509
   184
       "======= End of refutation ======="),
blanchet@38033
   185
      ("% SZS output start Refutation", "% SZS output end Refutation"),
blanchet@38033
   186
      ("% SZS output start Proof", "% SZS output end Proof")],
blanchet@37509
   187
   known_failures =
blanchet@37509
   188
     [(Unprovable, "UNPROVABLE"),
blanchet@37509
   189
      (IncompleteUnprovable, "CANNOT PROVE"),
blanchet@37509
   190
      (Unprovable, "Satisfiability detected"),
blanchet@37509
   191
      (OutOfResources, "Refutation not found")],
blanchet@38009
   192
   max_new_relevant_facts_per_iter = 40 (* FIXME *),
blanchet@37994
   193
   prefers_theory_relevant = false,
blanchet@37994
   194
   explicit_forall = false}
blanchet@38023
   195
val vampire = ("vampire", vampire_config)
blanchet@37509
   196
blanchet@37509
   197
(* Remote prover invocation via SystemOnTPTP *)
wenzelm@28596
   198
blanchet@38061
   199
val systems = Synchronized.var "atp_systems" ([] : string list)
immler@31835
   200
immler@31835
   201
fun get_systems () =
blanchet@38061
   202
  case bash_output "\"$ISABELLE_ATP/scripts/remote_atp\" -w 2>&1" of
blanchet@36370
   203
    (answer, 0) => split_lines answer
blanchet@36370
   204
  | (answer, _) =>
blanchet@37627
   205
    error ("Failed to get available systems at SystemOnTPTP:\n" ^
blanchet@38061
   206
           (case known_failure_in_output answer known_perl_failures of
blanchet@38061
   207
              SOME failure => string_for_failure failure
blanchet@38061
   208
            | NONE => perhaps (try (unsuffix "\n")) answer))
immler@31835
   209
blanchet@35867
   210
fun refresh_systems_on_tptp () =
blanchet@37509
   211
  Synchronized.change systems (fn _ => get_systems ())
immler@31835
   212
immler@31835
   213
fun get_system prefix = Synchronized.change_result systems (fn systems =>
boehmes@32864
   214
  (if null systems then get_systems () else systems)
wenzelm@32942
   215
  |> `(find_first (String.isPrefix prefix)));
boehmes@32864
   216
wenzelm@32948
   217
fun the_system prefix =
boehmes@32864
   218
  (case get_system prefix of
blanchet@37509
   219
    NONE => error ("System " ^ quote prefix ^ " not available at SystemOnTPTP.")
wenzelm@32942
   220
  | SOME sys => sys);
immler@31835
   221
blanchet@38041
   222
fun remote_config atp_prefix
blanchet@38009
   223
        ({proof_delims, known_failures, max_new_relevant_facts_per_iter,
blanchet@37994
   224
          prefers_theory_relevant, explicit_forall, ...} : prover_config)
blanchet@37994
   225
        : prover_config =
blanchet@38049
   226
  {executable = ("ISABELLE_ATP", "scripts/remote_atp"),
blanchet@38032
   227
   required_executables = [],
blanchet@37514
   228
   arguments = fn _ => fn timeout =>
blanchet@38041
   229
     " -t " ^ string_of_int (to_generous_secs timeout) ^ " -s " ^
blanchet@36382
   230
     the_system atp_prefix,
blanchet@36369
   231
   proof_delims = insert (op =) tstp_proof_delims proof_delims,
blanchet@38061
   232
   known_failures =
blanchet@38061
   233
     known_failures @ known_perl_failures @
blanchet@38061
   234
     [(CantConnect, "HTTP-Error"),
blanchet@38061
   235
      (TimedOut, "says Timeout")],
blanchet@38009
   236
   max_new_relevant_facts_per_iter = max_new_relevant_facts_per_iter,
blanchet@37994
   237
   prefers_theory_relevant = prefers_theory_relevant,
blanchet@37994
   238
   explicit_forall = explicit_forall}
wenzelm@28596
   239
blanchet@38023
   240
val remote_name = prefix "remote_"
boehmes@32864
   241
blanchet@38041
   242
fun remote_prover (name, config) atp_prefix =
blanchet@38041
   243
  (remote_name name, remote_config atp_prefix config)
blanchet@38023
   244
blanchet@38041
   245
val remote_e = remote_prover e "EP---"
blanchet@38041
   246
val remote_vampire = remote_prover vampire "Vampire---9"
wenzelm@28592
   247
blanchet@38041
   248
fun is_installed ({executable, required_executables, ...} : prover_config) =
blanchet@38041
   249
  forall (curry (op <>) "" o getenv o fst) (executable :: required_executables)
blanchet@38041
   250
fun maybe_remote (name, config) =
blanchet@38041
   251
  name |> not (is_installed config) ? remote_name
blanchet@36371
   252
blanchet@36371
   253
fun default_atps_param_value () =
blanchet@38041
   254
  space_implode " " ([maybe_remote e] @
blanchet@38041
   255
                     (if is_installed (snd spass) then [fst spass] else []) @
blanchet@38041
   256
                     [remote_name (fst vampire)])
blanchet@36371
   257
blanchet@38041
   258
val provers = [e, spass, vampire, remote_e, remote_vampire]
blanchet@38023
   259
val setup = fold add_prover provers
blanchet@35867
   260
wenzelm@28592
   261
end;