src/HOL/Tools/Sledgehammer/sledgehammer_isar.ML
author blanchet
Mon, 27 Jun 2011 13:52:47 +0200
changeset 44431 b342cd125533
parent 44219 6c008d3efb0a
child 44434 ae612a423dad
permissions -rw-r--r--
removed "full_types" option from Sledgehammer, now that virtually sound encodings are used as the default anyway
     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_Provers.params
    10 
    11   val sledgehammerN : string
    12   val auto : bool Unsynchronized.ref
    13   val provers : string Unsynchronized.ref
    14   val timeout : int 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 ATP_Translate
    24 open Sledgehammer_Util
    25 open Sledgehammer_Provers
    26 open Sledgehammer_Minimize
    27 open Sledgehammer_Run
    28 
    29 val sledgehammerN = "sledgehammer"
    30 val sledgehammer_paramsN = "sledgehammer_params"
    31 
    32 val runN = "run"
    33 val minN = "min"
    34 val messagesN = "messages"
    35 val supported_proversN = "supported_provers"
    36 val running_proversN = "running_provers"
    37 val kill_proversN = "kill_provers"
    38 val refresh_tptpN = "refresh_tptp"
    39 
    40 val auto = Unsynchronized.ref false
    41 
    42 val _ =
    43   ProofGeneralPgip.add_preference Preferences.category_tracing
    44       (Preferences.bool_pref auto "auto-sledgehammer"
    45            "Run Sledgehammer automatically.")
    46 
    47 (** Sledgehammer commands **)
    48 
    49 val no_relevance_override = {add = [], del = [], only = false}
    50 fun add_relevance_override ns : relevance_override =
    51   {add = ns, del = [], only = false}
    52 fun del_relevance_override ns : relevance_override =
    53   {add = [], del = ns, only = false}
    54 fun only_relevance_override ns : relevance_override =
    55   {add = ns, del = [], only = true}
    56 fun merge_relevance_override_pairwise (r1 : relevance_override)
    57                                       (r2 : relevance_override) =
    58   {add = #add r1 @ #add r2, del = #del r1 @ #del r2,
    59    only = #only r1 andalso #only r2}
    60 fun merge_relevance_overrides rs =
    61   fold merge_relevance_override_pairwise rs (only_relevance_override [])
    62 
    63 (*** parameters ***)
    64 
    65 val provers = Unsynchronized.ref ""
    66 val timeout = Unsynchronized.ref 30
    67 
    68 val _ =
    69   ProofGeneralPgip.add_preference Preferences.category_proof
    70       (Preferences.string_pref provers
    71           "Sledgehammer: Provers"
    72           "Default automatic provers (separated by whitespace)")
    73 
    74 val _ =
    75   ProofGeneralPgip.add_preference Preferences.category_proof
    76       (Preferences.int_pref timeout
    77           "Sledgehammer: Time Limit"
    78           "ATPs will be interrupted after this time (in seconds)")
    79 
    80 type raw_param = string * string list
    81 
    82 val default_default_params =
    83   [("debug", "false"),
    84    ("verbose", "false"),
    85    ("overlord", "false"),
    86    ("blocking", "false"),
    87    ("type_sys", "smart"),
    88    ("relevance_thresholds", "0.45 0.85"),
    89    ("max_relevant", "smart"),
    90    ("max_mono_iters", "3"),
    91    ("max_new_mono_instances", "200"),
    92    ("isar_proof", "false"),
    93    ("isar_shrink_factor", "1"),
    94    ("slicing", "true"),
    95    ("preplay_timeout", "4")]
    96 
    97 val alias_params =
    98   [("prover", "provers")]
    99 val negated_alias_params =
   100   [("no_debug", "debug"),
   101    ("quiet", "verbose"),
   102    ("no_overlord", "overlord"),
   103    ("non_blocking", "blocking"),
   104    ("no_isar_proof", "isar_proof"),
   105    ("no_slicing", "slicing")]
   106 
   107 val params_for_minimize =
   108   ["debug", "verbose", "overlord", "type_sys", "max_mono_iters",
   109    "max_new_mono_instances", "isar_proof", "isar_shrink_factor", "timeout",
   110    "preplay_timeout"]
   111 
   112 val property_dependent_params = ["provers", "timeout"]
   113 
   114 fun is_known_raw_param s =
   115   AList.defined (op =) default_default_params s orelse
   116   AList.defined (op =) alias_params s orelse
   117   AList.defined (op =) negated_alias_params s orelse
   118   member (op =) property_dependent_params s orelse s = "expect"
   119 
   120 fun is_prover_list ctxt s =
   121   case space_explode " " s of
   122     ss as _ :: _ => forall (is_prover_supported ctxt) ss
   123   | _ => false
   124 
   125 (* Secret feature: "provers =" and "type_sys =" can be left out. *)
   126 fun check_and_repair_raw_param ctxt (name, value) =
   127   if is_known_raw_param name then
   128     (name, value)
   129   else if is_prover_list ctxt name andalso null value then
   130     ("provers", [name])
   131   else if can type_sys_from_string name andalso null value then
   132     ("type_sys", [name])
   133   else
   134     error ("Unknown parameter: " ^ quote name ^ ".")
   135 
   136 fun unalias_raw_param (name, value) =
   137   case AList.lookup (op =) alias_params name of
   138     SOME name' => (name', value)
   139   | NONE =>
   140     case AList.lookup (op =) negated_alias_params name of
   141       SOME name' => (name', case value of
   142                               ["false"] => ["true"]
   143                             | ["true"] => ["false"]
   144                             | [] => ["false"]
   145                             | _ => value)
   146     | NONE => (name, value)
   147 
   148 (* Ensure that type systems such as "simple!" and "mangled_preds?" are handled
   149    correctly. *)
   150 fun implode_param [s, "?"] = s ^ "?"
   151   | implode_param [s, "!"] = s ^ "!"
   152   | implode_param ss = space_implode " " ss
   153 
   154 structure Data = Theory_Data
   155 (
   156   type T = raw_param list
   157   val empty = default_default_params |> map (apsnd single)
   158   val extend = I
   159   fun merge data : T = AList.merge (op =) (K true) data
   160 )
   161 
   162 fun remotify_prover_if_supported_and_not_already_remote ctxt name =
   163   if String.isPrefix remote_prefix name then
   164     SOME name
   165   else
   166     let val remote_name = remote_prefix ^ name in
   167       if is_prover_supported ctxt remote_name then SOME remote_name else NONE
   168     end
   169 
   170 fun remotify_prover_if_not_installed ctxt name =
   171   if is_prover_supported ctxt name andalso is_prover_installed ctxt name then
   172     SOME name
   173   else
   174     remotify_prover_if_supported_and_not_already_remote ctxt name
   175 
   176 fun avoid_too_many_threads _ _ [] = []
   177   | avoid_too_many_threads _ (0, 0) _ = []
   178   | avoid_too_many_threads ctxt (0, max_remote) provers =
   179     provers
   180     |> map_filter (remotify_prover_if_supported_and_not_already_remote ctxt)
   181     |> take max_remote
   182   | avoid_too_many_threads _ (max_local, 0) provers =
   183     provers
   184     |> filter_out (String.isPrefix remote_prefix)
   185     |> take max_local
   186   | avoid_too_many_threads ctxt max_local_and_remote (prover :: provers) =
   187     let
   188       val max_local_and_remote =
   189         max_local_and_remote
   190         |> (if String.isPrefix remote_prefix prover then apsnd else apfst)
   191               (Integer.add ~1)
   192     in prover :: avoid_too_many_threads ctxt max_local_and_remote provers end
   193 
   194 val max_default_remote_threads = 4
   195 
   196 (* The first ATP of the list is used by Auto Sledgehammer. Because of the low
   197    timeout, it makes sense to put SPASS first. *)
   198 fun default_provers_param_value ctxt =
   199   [spassN, eN, vampireN, SMT_Solver.solver_name_of ctxt, sine_eN, waldmeisterN]
   200   |> map_filter (remotify_prover_if_not_installed ctxt)
   201   |> avoid_too_many_threads ctxt (Multithreading.max_threads_value (),
   202                                   max_default_remote_threads)
   203   |> implode_param
   204 
   205 val set_default_raw_param = Data.map o AList.update (op =) o unalias_raw_param
   206 fun default_raw_params ctxt =
   207   let val thy = Proof_Context.theory_of ctxt in
   208     Data.get thy
   209     |> fold (AList.default (op =))
   210             [("provers", [case !provers of
   211                             "" => default_provers_param_value ctxt
   212                           | s => s]),
   213              ("timeout", let val timeout = !timeout in
   214                            [if timeout <= 0 then "none"
   215                             else string_of_int timeout]
   216                          end)]
   217   end
   218 
   219 val infinity_time_in_secs = 60 * 60 * 24 * 365
   220 val the_timeout = the_default (Time.fromSeconds infinity_time_in_secs)
   221 
   222 fun extract_params mode default_params override_params =
   223   let
   224     val override_params = map unalias_raw_param override_params
   225     val raw_params = rev override_params @ rev default_params
   226     val lookup = Option.map implode_param o AList.lookup (op =) raw_params
   227     val lookup_string = the_default "" o lookup
   228     fun general_lookup_bool option default_value name =
   229       case lookup name of
   230         SOME s => parse_bool_option option name s
   231       | NONE => default_value
   232     val lookup_bool = the o general_lookup_bool false (SOME false)
   233     fun lookup_time name =
   234       case lookup name of
   235         SOME s => parse_time_option name s
   236       | NONE => NONE
   237     fun lookup_int name =
   238       case lookup name of
   239         NONE => 0
   240       | SOME s => case Int.fromString s of
   241                     SOME n => n
   242                   | NONE => error ("Parameter " ^ quote name ^
   243                                    " must be assigned an integer value.")
   244     fun lookup_real_pair name =
   245       case lookup name of
   246         NONE => (0.0, 0.0)
   247       | SOME s => case s |> space_explode " " |> map Real.fromString of
   248                     [SOME r1, SOME r2] => (r1, r2)
   249                   | _ => error ("Parameter " ^ quote name ^
   250                                 "must be assigned a pair of floating-point \
   251                                 \values (e.g., \"0.6 0.95\")")
   252     fun lookup_option lookup' name =
   253       case lookup name of
   254         SOME "smart" => NONE
   255       | _ => SOME (lookup' name)
   256     val debug = mode <> Auto_Try andalso lookup_bool "debug"
   257     val verbose = debug orelse (mode <> Auto_Try andalso lookup_bool "verbose")
   258     val overlord = lookup_bool "overlord"
   259     val blocking =
   260       Isabelle_Process.is_active () orelse mode <> Normal orelse debug orelse
   261       lookup_bool "blocking"
   262     val provers = lookup_string "provers" |> space_explode " "
   263                   |> mode = Auto_Try ? single o hd
   264     val type_sys =
   265       if mode = Auto_Try then
   266         NONE
   267       else case lookup_string "type_sys" of
   268         "smart" => NONE
   269       | s => SOME (type_sys_from_string s)
   270     val relevance_thresholds = lookup_real_pair "relevance_thresholds"
   271     val max_relevant = lookup_option lookup_int "max_relevant"
   272     val max_mono_iters = lookup_int "max_mono_iters"
   273     val max_new_mono_instances = lookup_int "max_new_mono_instances"
   274     val isar_proof = lookup_bool "isar_proof"
   275     val isar_shrink_factor = Int.max (1, lookup_int "isar_shrink_factor")
   276     val slicing = mode <> Auto_Try andalso lookup_bool "slicing"
   277     val timeout =
   278       (if mode = Auto_Try then NONE else lookup_time "timeout") |> the_timeout
   279     val preplay_timeout =
   280       if mode = Auto_Try then Time.zeroTime
   281       else lookup_time "preplay_timeout" |> the_timeout
   282     val expect = lookup_string "expect"
   283   in
   284     {debug = debug, verbose = verbose, overlord = overlord, blocking = blocking,
   285      provers = provers, relevance_thresholds = relevance_thresholds,
   286      max_relevant = max_relevant, max_mono_iters = max_mono_iters,
   287      max_new_mono_instances = max_new_mono_instances, type_sys = type_sys,
   288      isar_proof = isar_proof, isar_shrink_factor = isar_shrink_factor,
   289      slicing = slicing, timeout = timeout, preplay_timeout = preplay_timeout,
   290      expect = expect}
   291   end
   292 
   293 fun get_params mode ctxt = extract_params mode (default_raw_params ctxt)
   294 fun default_params thy = get_params Normal thy o map (apsnd single)
   295 
   296 (* Sledgehammer the given subgoal *)
   297 
   298 val default_minimize_prover = Metis_Tactics.metisN
   299 
   300 val is_raw_param_relevant_for_minimize =
   301   member (op =) params_for_minimize o fst o unalias_raw_param
   302 fun string_for_raw_param (key, values) =
   303   key ^ (case implode_param values of "" => "" | value => " = " ^ value)
   304 
   305 fun minimize_command override_params i prover_name fact_names =
   306   let
   307     val params =
   308       override_params
   309       |> filter is_raw_param_relevant_for_minimize
   310       |> map string_for_raw_param
   311       |> (if prover_name = default_minimize_prover then I else cons prover_name)
   312       |> space_implode ", "
   313   in
   314     sledgehammerN ^ " " ^ minN ^
   315     (if params = "" then "" else enclose " [" "]" params) ^
   316     " (" ^ space_implode " " fact_names ^ ")" ^
   317     (if i = 1 then "" else " " ^ string_of_int i)
   318   end
   319 
   320 fun hammer_away override_params subcommand opt_i relevance_override state =
   321   let
   322     val ctxt = Proof.context_of state
   323     val override_params =
   324       override_params |> map (check_and_repair_raw_param ctxt)
   325   in
   326     if subcommand = runN then
   327       let val i = the_default 1 opt_i in
   328         run_sledgehammer (get_params Normal ctxt override_params) Normal i
   329                          relevance_override (minimize_command override_params i)
   330                          state
   331         |> K ()
   332       end
   333     else if subcommand = minN then
   334       run_minimize (get_params Minimize ctxt
   335                                (("provers", [default_minimize_prover]) ::
   336                                 override_params))
   337                    (the_default 1 opt_i) (#add relevance_override) state
   338     else if subcommand = messagesN then
   339       messages opt_i
   340     else if subcommand = supported_proversN then
   341       supported_provers ctxt
   342     else if subcommand = running_proversN then
   343       running_provers ()
   344     else if subcommand = kill_proversN then
   345       kill_provers ()
   346     else if subcommand = refresh_tptpN then
   347       refresh_systems_on_tptp ()
   348     else
   349       error ("Unknown subcommand: " ^ quote subcommand ^ ".")
   350   end
   351 
   352 fun sledgehammer_trans (((subcommand, params), relevance_override), opt_i) =
   353   Toplevel.keep (hammer_away params subcommand opt_i relevance_override
   354                  o Toplevel.proof_of)
   355 
   356 fun string_for_raw_param (name, value) = name ^ " = " ^ implode_param value
   357 
   358 fun sledgehammer_params_trans params =
   359   Toplevel.theory
   360       (fold set_default_raw_param params
   361        #> tap (fn thy =>
   362                   let val ctxt = Proof_Context.init_global thy in
   363                     writeln ("Default parameters for Sledgehammer:\n" ^
   364                              (case default_raw_params ctxt |> rev of
   365                                 [] => "none"
   366                               | params =>
   367                                 params |> map (check_and_repair_raw_param ctxt)
   368                                        |> map string_for_raw_param
   369                                        |> sort_strings |> cat_lines))
   370                   end))
   371 
   372 val parse_key =
   373   Scan.repeat1 (Parse.typ_group || Parse.$$$ "?" || Parse.$$$ "!")
   374   >> implode_param
   375 val parse_value =
   376   Scan.repeat1 (Parse.xname || Parse.float_number || Parse.$$$ "?"
   377                 || Parse.$$$ "!")
   378 val parse_param = parse_key -- Scan.optional (Parse.$$$ "=" |-- parse_value) []
   379 val parse_params = Scan.optional (Args.bracks (Parse.list parse_param)) []
   380 val parse_fact_refs =
   381   Scan.repeat1 (Scan.unless (Parse.name -- Args.colon) Parse_Spec.xthm)
   382 val parse_relevance_chunk =
   383   (Args.add |-- Args.colon |-- parse_fact_refs >> add_relevance_override)
   384   || (Args.del |-- Args.colon |-- parse_fact_refs >> del_relevance_override)
   385   || (parse_fact_refs >> only_relevance_override)
   386 val parse_relevance_override =
   387   Scan.optional (Args.parens (Scan.repeat parse_relevance_chunk
   388                               >> merge_relevance_overrides))
   389                 no_relevance_override
   390 val parse_sledgehammer_command =
   391   (Scan.optional Parse.short_ident runN -- parse_params
   392    -- parse_relevance_override -- Scan.option Parse.nat) #>> sledgehammer_trans
   393 val parse_sledgehammer_params_command =
   394   parse_params #>> sledgehammer_params_trans
   395 
   396 val _ =
   397   Outer_Syntax.improper_command sledgehammerN
   398       "search for first-order proof using automatic theorem provers" Keyword.diag
   399       parse_sledgehammer_command
   400 val _ =
   401   Outer_Syntax.command sledgehammer_paramsN
   402       "set and display the default parameters for Sledgehammer" Keyword.thy_decl
   403       parse_sledgehammer_params_command
   404 
   405 fun try_sledgehammer auto state =
   406   let
   407     val ctxt = Proof.context_of state
   408     val mode = if auto then Auto_Try else Try
   409     val i = 1
   410   in
   411     run_sledgehammer (get_params mode ctxt []) mode i no_relevance_override
   412                      (minimize_command [] i) state
   413   end
   414 
   415 val setup = Try.register_tool (sledgehammerN, (40, auto, try_sledgehammer))
   416 
   417 end;