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