1 (* Title: HOL/Tools/Sledgehammer/sledgehammer_isar.ML
2 Author: Jasmin Blanchette, TU Muenchen
4 Adds "sledgehammer" and related commands to Isabelle/Isar's outer syntax.
7 signature SLEDGEHAMMER_ISAR =
9 type params = Sledgehammer_Provers.params
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
19 structure Sledgehammer_Isar : SLEDGEHAMMER_ISAR =
24 open Sledgehammer_Util
25 open Sledgehammer_Provers
26 open Sledgehammer_Minimize
29 val sledgehammerN = "sledgehammer"
30 val sledgehammer_paramsN = "sledgehammer_params"
34 val messagesN = "messages"
35 val supported_proversN = "supported_provers"
36 val running_proversN = "running_provers"
37 val kill_proversN = "kill_provers"
38 val refresh_tptpN = "refresh_tptp"
40 val auto = Unsynchronized.ref false
43 ProofGeneralPgip.add_preference Preferences.category_tracing
44 (Preferences.bool_pref auto "auto-sledgehammer"
45 "Run Sledgehammer automatically.")
47 (** Sledgehammer commands **)
49 val no_relevance_override = {add = [], del = [], only = false}
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 [])
65 val provers = Unsynchronized.ref ""
66 val timeout = Unsynchronized.ref 30
69 ProofGeneralPgip.add_preference Preferences.category_proof
70 (Preferences.string_pref provers
71 "Sledgehammer: Provers"
72 "Default automatic provers (separated by whitespace)")
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)")
80 type raw_param = string * string list
82 val default_default_params =
85 ("overlord", "false"),
86 ("blocking", "false"),
87 ("type_enc", "smart"),
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"),
96 ("preplay_timeout", "4")]
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")]
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",
114 val property_dependent_params = ["provers", "timeout"]
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"
122 fun is_prover_list ctxt s =
123 case space_explode " " s of
124 ss as _ :: _ => forall (is_prover_supported ctxt) ss
127 (* "provers =" and "type_enc =" can be left out. The latter is a secret
129 fun check_and_repair_raw_param ctxt (name, value) =
130 if is_known_raw_param name then
132 else if is_prover_list ctxt name andalso null value then
134 else if can type_enc_from_string name andalso null value then
137 error ("Unknown parameter: " ^ quote name ^ ".")
139 fun unalias_raw_param (name, value) =
140 case AList.lookup (op =) alias_params name of
141 SOME name' => (name', value)
143 case AList.lookup (op =) negated_alias_params name of
144 SOME name' => (name', case value of
145 ["false"] => ["true"]
146 | ["true"] => ["false"]
149 | NONE => (name, value)
151 (* Ensure that type systems such as "simple!" and "mangled_guards?" are handled
153 fun implode_param [s, "?"] = s ^ "?"
154 | implode_param [s, "!"] = s ^ "!"
155 | implode_param ss = space_implode " " ss
157 structure Data = Theory_Data
159 type T = raw_param list
160 val empty = default_default_params |> map (apsnd single)
162 fun merge data : T = AList.merge (op =) (K true) data
165 fun remotify_prover_if_supported_and_not_already_remote ctxt name =
166 if String.isPrefix remote_prefix name then
169 let val remote_name = remote_prefix ^ name in
170 if is_prover_supported ctxt remote_name then SOME remote_name else NONE
173 fun remotify_prover_if_not_installed ctxt name =
174 if is_prover_supported ctxt name andalso is_prover_installed ctxt name then
177 remotify_prover_if_supported_and_not_already_remote ctxt name
179 fun avoid_too_many_threads _ _ [] = []
180 | avoid_too_many_threads _ (0, 0) _ = []
181 | avoid_too_many_threads ctxt (0, max_remote) provers =
183 |> map_filter (remotify_prover_if_supported_and_not_already_remote ctxt)
185 | avoid_too_many_threads _ (max_local, 0) provers =
187 |> filter_out (String.isPrefix remote_prefix)
189 | avoid_too_many_threads ctxt max_local_and_remote (prover :: provers) =
191 val max_local_and_remote =
193 |> (if String.isPrefix remote_prefix prover then apsnd else apfst)
195 in prover :: avoid_too_many_threads ctxt max_local_and_remote provers end
197 val max_default_remote_threads = 4
199 (* The first ATP of the list is used by Auto Sledgehammer. Because of the low
200 timeout, it makes sense to put SPASS first. *)
201 fun default_provers_param_value ctxt =
202 [spassN, eN, vampireN, SMT_Solver.solver_name_of ctxt, e_sineN, waldmeisterN]
203 |> map_filter (remotify_prover_if_not_installed ctxt)
204 |> avoid_too_many_threads ctxt (Multithreading.max_threads_value (),
205 max_default_remote_threads)
208 val set_default_raw_param = Data.map o AList.update (op =) o unalias_raw_param
209 fun default_raw_params ctxt =
210 let val thy = Proof_Context.theory_of ctxt in
212 |> fold (AList.default (op =))
213 [("provers", [case !provers of
214 "" => default_provers_param_value ctxt
216 ("timeout", let val timeout = !timeout in
217 [if timeout <= 0 then "none"
218 else string_of_int timeout]
222 val infinity_time_in_secs = 60 * 60 * 24 * 365
223 val the_timeout = the_default (Time.fromSeconds infinity_time_in_secs)
225 fun extract_params mode default_params override_params =
227 val override_params = map unalias_raw_param override_params
228 val raw_params = rev override_params @ rev default_params
229 val lookup = Option.map implode_param o AList.lookup (op =) raw_params
230 val lookup_string = the_default "" o lookup
231 fun general_lookup_bool option default_value name =
233 SOME s => parse_bool_option option name s
234 | NONE => default_value
235 val lookup_bool = the o general_lookup_bool false (SOME false)
236 fun lookup_time name =
238 SOME s => parse_time_option name s
240 fun lookup_int name =
243 | SOME s => case Int.fromString s of
245 | NONE => error ("Parameter " ^ quote name ^
246 " must be assigned an integer value.")
247 fun lookup_real_pair name =
250 | SOME s => case s |> space_explode " " |> map Real.fromString of
251 [SOME r1, SOME r2] => (r1, r2)
252 | _ => error ("Parameter " ^ quote name ^
253 "must be assigned a pair of floating-point \
254 \values (e.g., \"0.6 0.95\")")
255 fun lookup_option lookup' name =
258 | _ => SOME (lookup' name)
259 val debug = mode <> Auto_Try andalso lookup_bool "debug"
260 val verbose = debug orelse (mode <> Auto_Try andalso lookup_bool "verbose")
261 val overlord = lookup_bool "overlord"
263 Isabelle_Process.is_active () orelse mode <> Normal orelse debug orelse
264 lookup_bool "blocking"
265 val provers = lookup_string "provers" |> space_explode " "
266 |> mode = Auto_Try ? single o hd
268 if mode = Auto_Try then
270 else case lookup_string "type_enc" of
272 | s => SOME (type_enc_from_string s)
273 val sound = mode = Auto_Try orelse lookup_bool "sound"
274 val relevance_thresholds = lookup_real_pair "relevance_thresholds"
275 val max_relevant = lookup_option lookup_int "max_relevant"
276 val max_mono_iters = lookup_int "max_mono_iters"
277 val max_new_mono_instances = lookup_int "max_new_mono_instances"
278 val isar_proof = lookup_bool "isar_proof"
279 val isar_shrink_factor = Int.max (1, lookup_int "isar_shrink_factor")
280 val slicing = mode <> Auto_Try andalso lookup_bool "slicing"
282 (if mode = Auto_Try then NONE else lookup_time "timeout") |> the_timeout
283 val preplay_timeout =
284 if mode = Auto_Try then Time.zeroTime
285 else lookup_time "preplay_timeout" |> the_timeout
286 val expect = lookup_string "expect"
288 {debug = debug, verbose = verbose, overlord = overlord, blocking = blocking,
289 provers = provers, relevance_thresholds = relevance_thresholds,
290 max_relevant = max_relevant, max_mono_iters = max_mono_iters,
291 max_new_mono_instances = max_new_mono_instances, type_enc = type_enc,
292 sound = sound, isar_proof = isar_proof,
293 isar_shrink_factor = isar_shrink_factor, slicing = slicing,
294 timeout = timeout, preplay_timeout = preplay_timeout, expect = expect}
297 fun get_params mode ctxt = extract_params mode (default_raw_params ctxt)
298 fun default_params thy = get_params Normal thy o map (apsnd single)
300 (* Sledgehammer the given subgoal *)
302 val default_minimize_prover = Metis_Tactics.metisN
304 val is_raw_param_relevant_for_minimize =
305 member (op =) params_for_minimize o fst o unalias_raw_param
306 fun string_for_raw_param (key, values) =
307 key ^ (case implode_param values of "" => "" | value => " = " ^ value)
309 fun minimize_command override_params i prover_name fact_names =
313 |> filter is_raw_param_relevant_for_minimize
314 |> map string_for_raw_param
315 |> (if prover_name = default_minimize_prover then I else cons prover_name)
316 |> space_implode ", "
318 sledgehammerN ^ " " ^ minN ^
319 (if params = "" then "" else enclose " [" "]" params) ^
320 " (" ^ space_implode " " fact_names ^ ")" ^
321 (if i = 1 then "" else " " ^ string_of_int i)
324 fun hammer_away override_params subcommand opt_i relevance_override state =
326 val ctxt = Proof.context_of state
327 val override_params =
328 override_params |> map (check_and_repair_raw_param ctxt)
330 if subcommand = runN then
331 let val i = the_default 1 opt_i in
332 run_sledgehammer (get_params Normal ctxt override_params) Normal i
333 relevance_override (minimize_command override_params i)
337 else if subcommand = minN then
338 run_minimize (get_params Minimize ctxt
339 (("provers", [default_minimize_prover]) ::
341 (the_default 1 opt_i) (#add relevance_override) state
342 else if subcommand = messagesN then
344 else if subcommand = supported_proversN then
345 supported_provers ctxt
346 else if subcommand = running_proversN then
348 else if subcommand = kill_proversN then
350 else if subcommand = refresh_tptpN then
351 refresh_systems_on_tptp ()
353 error ("Unknown subcommand: " ^ quote subcommand ^ ".")
356 fun sledgehammer_trans (((subcommand, params), relevance_override), opt_i) =
357 Toplevel.keep (hammer_away params subcommand opt_i relevance_override
360 fun string_for_raw_param (name, value) = name ^ " = " ^ implode_param value
362 fun sledgehammer_params_trans params =
364 (fold set_default_raw_param params
366 let val ctxt = Proof_Context.init_global thy in
367 writeln ("Default parameters for Sledgehammer:\n" ^
368 (case default_raw_params ctxt |> rev of
371 params |> map (check_and_repair_raw_param ctxt)
372 |> map string_for_raw_param
373 |> sort_strings |> cat_lines))
377 Scan.repeat1 (Parse.typ_group || Parse.$$$ "?" || Parse.$$$ "!")
380 Scan.repeat1 (Parse.xname || Parse.float_number || Parse.$$$ "?"
382 val parse_param = parse_key -- Scan.optional (Parse.$$$ "=" |-- parse_value) []
383 val parse_params = Scan.optional (Args.bracks (Parse.list parse_param)) []
384 val parse_fact_refs =
385 Scan.repeat1 (Scan.unless (Parse.name -- Args.colon) Parse_Spec.xthm)
386 val parse_relevance_chunk =
387 (Args.add |-- Args.colon |-- parse_fact_refs >> add_relevance_override)
388 || (Args.del |-- Args.colon |-- parse_fact_refs >> del_relevance_override)
389 || (parse_fact_refs >> only_relevance_override)
390 val parse_relevance_override =
391 Scan.optional (Args.parens (Scan.repeat parse_relevance_chunk
392 >> merge_relevance_overrides))
393 no_relevance_override
394 val parse_sledgehammer_command =
395 (Scan.optional Parse.short_ident runN -- parse_params
396 -- parse_relevance_override -- Scan.option Parse.nat) #>> sledgehammer_trans
397 val parse_sledgehammer_params_command =
398 parse_params #>> sledgehammer_params_trans
401 Outer_Syntax.improper_command sledgehammerN
402 "search for first-order proof using automatic theorem provers" Keyword.diag
403 parse_sledgehammer_command
405 Outer_Syntax.command sledgehammer_paramsN
406 "set and display the default parameters for Sledgehammer" Keyword.thy_decl
407 parse_sledgehammer_params_command
409 fun try_sledgehammer auto state =
411 val ctxt = Proof.context_of state
412 val mode = if auto then Auto_Try else Try
415 run_sledgehammer (get_params mode ctxt []) mode i no_relevance_override
416 (minimize_command [] i) state
419 val setup = Try.register_tool (sledgehammerN, (40, auto, try_sledgehammer))