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