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