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