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