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