src/HOL/Tools/Sledgehammer/sledgehammer_isar.ML
author blanchet
Fri, 22 Oct 2010 16:11:43 +0200
changeset 40253 27f2a45b0aab
parent 40250 6f7bf79b1506
child 40359 e5ed638e49b0
permissions -rw-r--r--
more robust handling of "remote_" vs. non-"remote_" provers
     1 (*  Title:      HOL/Tools/Sledgehammer/sledgehammer_isar.ML
     2     Author:     Jasmin Blanchette, TU Muenchen
     3 
     4 Adds "sledgehammer" and related commands to Isabelle/Isar's outer syntax.
     5 *)
     6 
     7 signature SLEDGEHAMMER_ISAR =
     8 sig
     9   type params = Sledgehammer.params
    10 
    11   val auto : bool Unsynchronized.ref
    12   val provers : string Unsynchronized.ref
    13   val timeout : int Unsynchronized.ref
    14   val full_types : bool Unsynchronized.ref
    15   val default_params : Proof.context -> (string * string) list -> params
    16   val setup : theory -> theory
    17 end;
    18 
    19 structure Sledgehammer_Isar : SLEDGEHAMMER_ISAR =
    20 struct
    21 
    22 open ATP_Systems
    23 open Sledgehammer_Util
    24 open Sledgehammer
    25 open Sledgehammer_Minimize
    26 
    27 val auto = Unsynchronized.ref false
    28 
    29 val _ =
    30   ProofGeneralPgip.add_preference Preferences.category_tracing
    31       (Preferences.bool_pref auto "auto-sledgehammer"
    32            "Run Sledgehammer automatically.")
    33 
    34 (** Sledgehammer commands **)
    35 
    36 val no_relevance_override = {add = [], del = [], only = false}
    37 fun add_relevance_override ns : relevance_override =
    38   {add = ns, del = [], only = false}
    39 fun del_relevance_override ns : relevance_override =
    40   {add = [], del = ns, only = false}
    41 fun only_relevance_override ns : relevance_override =
    42   {add = ns, del = [], only = true}
    43 fun merge_relevance_override_pairwise (r1 : relevance_override)
    44                                       (r2 : relevance_override) =
    45   {add = #add r1 @ #add r2, del = #del r1 @ #del r2,
    46    only = #only r1 andalso #only r2}
    47 fun merge_relevance_overrides rs =
    48   fold merge_relevance_override_pairwise rs (only_relevance_override [])
    49 
    50 (*** parameters ***)
    51 
    52 val provers = Unsynchronized.ref ""
    53 val timeout = Unsynchronized.ref 30
    54 val full_types = Unsynchronized.ref false
    55 
    56 val _ =
    57   ProofGeneralPgip.add_preference Preferences.category_proof
    58       (Preferences.string_pref provers
    59           "Sledgehammer: Provers"
    60           "Default automatic provers (separated by whitespace)")
    61 
    62 val _ =
    63   ProofGeneralPgip.add_preference Preferences.category_proof
    64       (Preferences.int_pref timeout
    65           "Sledgehammer: Time Limit"
    66           "ATPs will be interrupted after this time (in seconds)")
    67 
    68 val _ =
    69   ProofGeneralPgip.add_preference Preferences.category_proof
    70       (Preferences.bool_pref full_types
    71           "Sledgehammer: Full Types" "ATPs will use full type information")
    72 
    73 type raw_param = string * string list
    74 
    75 val default_default_params =
    76   [("blocking", "false"),
    77    ("debug", "false"),
    78    ("verbose", "false"),
    79    ("overlord", "false"),
    80    ("explicit_apply", "false"),
    81    ("relevance_thresholds", "45 85"),
    82    ("max_relevant", "smart"),
    83    ("isar_proof", "false"),
    84    ("isar_shrink_factor", "1")]
    85 
    86 val alias_params =
    87   [("prover", "provers"),
    88    ("atps", "provers"), (* FIXME: legacy *)
    89    ("atp", "provers")]  (* FIXME: legacy *)
    90 val negated_alias_params =
    91   [("non_blocking", "blocking"),
    92    ("no_debug", "debug"),
    93    ("quiet", "verbose"),
    94    ("no_overlord", "overlord"),
    95    ("partial_types", "full_types"),
    96    ("implicit_apply", "explicit_apply"),
    97    ("no_isar_proof", "isar_proof")]
    98 
    99 val params_for_minimize =
   100   ["debug", "verbose", "overlord", "full_types", "isar_proof",
   101    "isar_shrink_factor", "timeout"]
   102 
   103 val property_dependent_params = ["provers", "full_types", "timeout"]
   104 
   105 fun is_known_raw_param s =
   106   AList.defined (op =) default_default_params s orelse
   107   AList.defined (op =) alias_params s orelse
   108   AList.defined (op =) negated_alias_params s orelse
   109   member (op =) property_dependent_params s orelse s = "expect"
   110 
   111 fun check_raw_param (s, _) =
   112   if is_known_raw_param s then ()
   113   else error ("Unknown parameter: " ^ quote s ^ ".")
   114 
   115 fun unalias_raw_param (name, value) =
   116   case AList.lookup (op =) alias_params name of
   117     SOME name' => (name', value)
   118   | NONE =>
   119     case AList.lookup (op =) negated_alias_params name of
   120       SOME name' => (name', case value of
   121                               ["false"] => ["true"]
   122                             | ["true"] => ["false"]
   123                             | [] => ["false"]
   124                             | _ => value)
   125     | NONE => (name, value)
   126 
   127 structure Data = Theory_Data(
   128   type T = raw_param list
   129   val empty = default_default_params |> map (apsnd single)
   130   val extend = I
   131   fun merge p : T = AList.merge (op =) (K true) p)
   132 
   133 (* FIXME: dummy *)
   134 fun is_smt_solver_installed ctxt = true
   135 
   136 fun remotify_prover_if_available_and_not_already_remote thy name =
   137   if String.isPrefix remote_prefix name then
   138     SOME name
   139   else
   140     let val remote_name = remote_prefix ^ name in
   141       if is_prover_available thy remote_name then SOME remote_name else NONE
   142     end
   143 
   144 fun remotify_prover_if_not_installed ctxt name =
   145   let val thy = ProofContext.theory_of ctxt in
   146     if is_prover_available thy name andalso is_prover_installed ctxt name then
   147       SOME name
   148     else
   149       remotify_prover_if_available_and_not_already_remote thy name
   150   end
   151 
   152 fun avoid_too_many_local_threads _ _ [] = []
   153   | avoid_too_many_local_threads thy 0 provers =
   154     map_filter (remotify_prover_if_available_and_not_already_remote thy) provers
   155   | avoid_too_many_local_threads thy n (prover :: provers) =
   156     let val n = if String.isPrefix remote_prefix prover then n else n - 1 in
   157       prover :: avoid_too_many_local_threads thy n provers
   158     end
   159 
   160 (* The first ATP of the list is used by Auto Sledgehammer. Because of the low
   161    timeout, it makes sense to put SPASS first. *)
   162 fun default_provers_param_value ctxt =
   163   let val thy = ProofContext.theory_of ctxt in
   164     [spassN, eN, vampireN, sine_eN (* FIXME: , smtN *)]
   165     |> map_filter (remotify_prover_if_not_installed ctxt)
   166     |> avoid_too_many_local_threads thy (Thread.numProcessors ())
   167     |> space_implode " "
   168   end
   169 
   170 val set_default_raw_param = Data.map o AList.update (op =) o unalias_raw_param
   171 fun default_raw_params ctxt =
   172   let val thy = ProofContext.theory_of ctxt in
   173     Data.get thy
   174     |> fold (AList.default (op =))
   175             [("provers", [case !provers of
   176                             "" => default_provers_param_value ctxt
   177                           | s => s]),
   178              ("full_types", [if !full_types then "true" else "false"]),
   179              ("timeout", let val timeout = !timeout in
   180                            [if timeout <= 0 then "none"
   181                             else string_of_int timeout ^ " s"]
   182                          end)]
   183   end
   184 
   185 val infinity_time_in_secs = 60 * 60 * 24 * 365
   186 val the_timeout = the_default (Time.fromSeconds infinity_time_in_secs)
   187 
   188 fun extract_params auto default_params override_params =
   189   let
   190     val override_params = map unalias_raw_param override_params
   191     val raw_params = rev override_params @ rev default_params
   192     val lookup = Option.map (space_implode " ") o AList.lookup (op =) raw_params
   193     val lookup_string = the_default "" o lookup
   194     fun general_lookup_bool option default_value name =
   195       case lookup name of
   196         SOME s => parse_bool_option option name s
   197       | NONE => default_value
   198     val lookup_bool = the o general_lookup_bool false (SOME false)
   199     fun lookup_time name =
   200       case lookup name of
   201         SOME s => parse_time_option name s
   202       | NONE => NONE
   203     fun lookup_int name =
   204       case lookup name of
   205         NONE => 0
   206       | SOME s => case Int.fromString s of
   207                     SOME n => n
   208                   | NONE => error ("Parameter " ^ quote name ^
   209                                    " must be assigned an integer value.")
   210     fun lookup_int_pair name =
   211       case lookup name of
   212         NONE => (0, 0)
   213       | SOME s => case s |> space_explode " " |> map Int.fromString of
   214                     [SOME n1, SOME n2] => (n1, n2)
   215                   | _ => error ("Parameter " ^ quote name ^
   216                                 "must be assigned a pair of integer values \
   217                                 \(e.g., \"60 95\")")
   218     fun lookup_int_option name =
   219       case lookup name of
   220         SOME "smart" => NONE
   221       | _ => SOME (lookup_int name)
   222     val blocking = auto orelse lookup_bool "blocking"
   223     val debug = not auto andalso lookup_bool "debug"
   224     val verbose = debug orelse (not auto andalso lookup_bool "verbose")
   225     val overlord = lookup_bool "overlord"
   226     val provers = lookup_string "provers" |> space_explode " "
   227                   |> auto ? single o hd
   228     val full_types = lookup_bool "full_types"
   229     val explicit_apply = lookup_bool "explicit_apply"
   230     val relevance_thresholds =
   231       lookup_int_pair "relevance_thresholds"
   232       |> pairself (fn n => 0.01 * Real.fromInt n)
   233     val max_relevant = lookup_int_option "max_relevant"
   234     val isar_proof = lookup_bool "isar_proof"
   235     val isar_shrink_factor = Int.max (1, lookup_int "isar_shrink_factor")
   236     val timeout = (if auto then NONE else lookup_time "timeout") |> the_timeout
   237     val expect = lookup_string "expect"
   238   in
   239     {blocking = blocking, debug = debug, verbose = verbose, overlord = overlord,
   240      provers = provers, full_types = full_types,
   241      explicit_apply = explicit_apply,
   242      relevance_thresholds = relevance_thresholds, max_relevant = max_relevant,
   243      isar_proof = isar_proof, isar_shrink_factor = isar_shrink_factor,
   244      timeout = timeout, expect = expect}
   245   end
   246 
   247 fun get_params auto ctxt = extract_params auto (default_raw_params ctxt)
   248 fun default_params thy = get_params false thy o map (apsnd single)
   249 
   250 (* Sledgehammer the given subgoal *)
   251 
   252 val sledgehammerN = "sledgehammer"
   253 val sledgehammer_paramsN = "sledgehammer_params"
   254 
   255 val runN = "run"
   256 val minimizeN = "minimize"
   257 val messagesN = "messages"
   258 val available_proversN = "available_provers"
   259 val running_proversN = "running_provers"
   260 val kill_proversN = "kill_provers"
   261 val refresh_tptpN = "refresh_tptp"
   262 
   263 val is_raw_param_relevant_for_minimize =
   264   member (op =) params_for_minimize o fst o unalias_raw_param
   265 fun string_for_raw_param (key, values) =
   266   key ^ (case space_implode " " values of "" => "" | value => " = " ^ value)
   267 
   268 fun minimize_command override_params i prover_name fact_names =
   269   sledgehammerN ^ " " ^ minimizeN ^ " [prover = " ^ prover_name ^
   270   (override_params |> filter is_raw_param_relevant_for_minimize
   271                    |> implode o map (prefix ", " o string_for_raw_param)) ^
   272   "] (" ^ space_implode " " fact_names ^ ")" ^
   273   (if i = 1 then "" else " " ^ string_of_int i)
   274 
   275 fun hammer_away override_params subcommand opt_i relevance_override state =
   276   let
   277     val ctxt = Proof.context_of state
   278     val thy = Proof.theory_of state
   279     val _ = app check_raw_param override_params
   280   in
   281     if subcommand = runN then
   282       let val i = the_default 1 opt_i in
   283         run_sledgehammer (get_params false ctxt override_params) false i
   284                          relevance_override (minimize_command override_params i)
   285                          state
   286         |> K ()
   287       end
   288     else if subcommand = minimizeN then
   289       run_minimize (get_params false ctxt override_params) (the_default 1 opt_i)
   290                    (#add relevance_override) state
   291     else if subcommand = messagesN then
   292       messages opt_i
   293     else if subcommand = available_proversN then
   294       available_provers thy
   295     else if subcommand = running_proversN then
   296       running_provers ()
   297     else if subcommand = kill_proversN then
   298       kill_provers ()
   299     else if subcommand = refresh_tptpN then
   300       refresh_systems_on_tptp ()
   301     else
   302       error ("Unknown subcommand: " ^ quote subcommand ^ ".")
   303   end
   304 
   305 fun sledgehammer_trans (((subcommand, params), relevance_override), opt_i) =
   306   Toplevel.keep (hammer_away params subcommand opt_i relevance_override
   307                  o Toplevel.proof_of)
   308 
   309 fun string_for_raw_param (name, value) = name ^ " = " ^ space_implode " " value
   310 
   311 fun sledgehammer_params_trans params =
   312   Toplevel.theory
   313       (fold set_default_raw_param params
   314        #> tap (fn thy =>
   315                   let val ctxt = ProofContext.init_global thy in
   316                     writeln ("Default parameters for Sledgehammer:\n" ^
   317                              (case default_raw_params ctxt |> rev of
   318                                 [] => "none"
   319                               | params =>
   320                                 (map check_raw_param params;
   321                                  params |> map string_for_raw_param
   322                                         |> sort_strings |> cat_lines)))
   323                   end))
   324 
   325 val parse_key = Scan.repeat1 Parse.typ_group >> space_implode " "
   326 val parse_value = Scan.repeat1 Parse.xname
   327 val parse_param = parse_key -- Scan.optional (Parse.$$$ "=" |-- parse_value) []
   328 val parse_params = Scan.optional (Args.bracks (Parse.list parse_param)) []
   329 val parse_fact_refs =
   330   Scan.repeat1 (Scan.unless (Parse.name -- Args.colon) Parse_Spec.xthm)
   331 val parse_relevance_chunk =
   332   (Args.add |-- Args.colon |-- parse_fact_refs >> add_relevance_override)
   333   || (Args.del |-- Args.colon |-- parse_fact_refs >> del_relevance_override)
   334   || (parse_fact_refs >> only_relevance_override)
   335 val parse_relevance_override =
   336   Scan.optional (Args.parens (Scan.repeat parse_relevance_chunk
   337                               >> merge_relevance_overrides))
   338                 no_relevance_override
   339 val parse_sledgehammer_command =
   340   (Scan.optional Parse.short_ident runN -- parse_params
   341    -- parse_relevance_override -- Scan.option Parse.nat) #>> sledgehammer_trans
   342 val parse_sledgehammer_params_command =
   343   parse_params #>> sledgehammer_params_trans
   344 
   345 val _ =
   346   Outer_Syntax.improper_command sledgehammerN
   347       "search for first-order proof using automatic theorem provers" Keyword.diag
   348       parse_sledgehammer_command
   349 val _ =
   350   Outer_Syntax.command sledgehammer_paramsN
   351       "set and display the default parameters for Sledgehammer" Keyword.thy_decl
   352       parse_sledgehammer_params_command
   353 
   354 fun auto_sledgehammer state =
   355   if not (!auto) then
   356     (false, state)
   357   else
   358     let val ctxt = Proof.context_of state in
   359       run_sledgehammer (get_params true ctxt []) true 1 no_relevance_override
   360                        (minimize_command [] 1) state
   361     end
   362 
   363 val setup = Auto_Tools.register_tool ("sledgehammer", auto_sledgehammer)
   364 
   365 end;