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 auto : bool Unsynchronized.ref
12 val provers : string Unsynchronized.ref
13 val timeout : int Unsynchronized.ref
14 val default_params : Proof.context -> (string * string) list -> params
15 val setup : theory -> theory
18 structure Sledgehammer_Isar : SLEDGEHAMMER_ISAR =
23 open ATP_Problem_Generate
24 open ATP_Proof_Reconstruct
25 open Sledgehammer_Util
26 open Sledgehammer_Filter
27 open Sledgehammer_Provers
28 open Sledgehammer_Minimize
33 val messagesN = "messages"
34 val supported_proversN = "supported_provers"
35 val running_proversN = "running_provers"
36 val kill_proversN = "kill_provers"
37 val refresh_tptpN = "refresh_tptp"
39 val auto = Unsynchronized.ref false
42 ProofGeneralPgip.add_preference Preferences.category_tracing
43 (Preferences.bool_pref auto "auto-sledgehammer"
44 "Run Sledgehammer automatically.")
46 (** Sledgehammer commands **)
48 fun add_relevance_override ns : relevance_override =
49 {add = ns, del = [], only = false}
50 fun del_relevance_override ns : relevance_override =
51 {add = [], del = ns, only = false}
52 fun only_relevance_override ns : relevance_override =
53 {add = ns, del = [], only = true}
54 fun merge_relevance_override_pairwise (r1 : relevance_override)
55 (r2 : relevance_override) =
56 {add = #add r1 @ #add r2, del = #del r1 @ #del r2,
57 only = #only r1 andalso #only r2}
58 fun merge_relevance_overrides rs =
59 fold merge_relevance_override_pairwise rs (only_relevance_override [])
63 val provers = Unsynchronized.ref ""
64 val timeout = Unsynchronized.ref 30
67 ProofGeneralPgip.add_preference Preferences.category_proof
68 (Preferences.string_pref provers
69 "Sledgehammer: Provers"
70 "Default automatic provers (separated by whitespace)")
73 ProofGeneralPgip.add_preference Preferences.category_proof
74 (Preferences.int_pref timeout
75 "Sledgehammer: Time Limit"
76 "ATPs will be interrupted after this time (in seconds)")
78 type raw_param = string * string list
80 val default_default_params =
83 ("overlord", "false"),
84 ("blocking", "false"),
85 ("type_enc", "smart"),
87 ("lam_trans", "smart"),
88 ("uncurried_aliases", "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 ("minimize", "smart"),
97 ("preplay_timeout", "3")]
100 [("prover", ("provers", [])),
101 ("dont_preplay", ("preplay_timeout", ["0"]))]
102 val negated_alias_params =
103 [("no_debug", "debug"),
104 ("quiet", "verbose"),
105 ("no_overlord", "overlord"),
106 ("non_blocking", "blocking"),
107 ("non_strict", "strict"),
108 ("no_uncurried_aliases", "uncurried_aliases"),
109 ("no_isar_proof", "isar_proof"),
110 ("dont_slice", "slice"),
111 ("dont_minimize", "minimize")]
113 val params_for_minimize =
114 ["debug", "verbose", "overlord", "type_enc", "strict", "lam_trans",
115 "uncurried_aliases", "max_mono_iters", "max_new_mono_instances",
116 "isar_proof", "isar_shrink_factor", "timeout", "preplay_timeout"]
118 val property_dependent_params = ["provers", "timeout"]
120 fun is_known_raw_param s =
121 AList.defined (op =) default_default_params s orelse
122 AList.defined (op =) alias_params s orelse
123 AList.defined (op =) negated_alias_params s orelse
124 member (op =) property_dependent_params s orelse s = "expect"
126 fun is_prover_list ctxt s =
127 case space_explode " " s of
128 ss as _ :: _ => forall (is_prover_supported ctxt) ss
131 fun unalias_raw_param (name, value) =
132 case AList.lookup (op =) alias_params name of
133 SOME (name', []) => (name', value)
134 | SOME (param' as (name', _)) =>
135 if value <> ["false"] then
138 error ("Parameter " ^ quote name ^ " cannot be set to \"false\" \
139 \(cf. " ^ quote name' ^ ").")
141 case AList.lookup (op =) negated_alias_params name of
142 SOME name' => (name', case value of
143 ["false"] => ["true"]
144 | ["true"] => ["false"]
147 | NONE => (name, value)
149 val any_type_enc = type_enc_from_string Strict "erased"
151 (* "provers =", "type_enc =", and "lam_trans" can be omitted. For the last two,
152 this is a secret feature. *)
153 fun normalize_raw_param ctxt =
155 #> (fn (name, value) =>
156 if is_known_raw_param name then
158 else if is_prover_list ctxt name andalso null value then
160 else if can (type_enc_from_string Strict) name andalso null value then
162 else if can (trans_lams_from_string ctxt any_type_enc) name andalso
164 ("lam_trans", [name])
166 error ("Unknown parameter: " ^ quote name ^ "."))
169 (* Ensures that type encodings such as "mono_native?" and "poly_guards!!" are
171 val implode_param = strip_spaces_except_between_idents o space_implode " "
173 structure Data = Theory_Data
175 type T = raw_param list
176 val empty = default_default_params |> map (apsnd single)
178 fun merge data : T = AList.merge (op =) (K true) data
181 fun remotify_prover_if_supported_and_not_already_remote ctxt name =
182 if String.isPrefix remote_prefix name then
185 let val remote_name = remote_prefix ^ name in
186 if is_prover_supported ctxt remote_name then SOME remote_name else NONE
189 fun remotify_prover_if_not_installed ctxt name =
190 if is_prover_supported ctxt name andalso is_prover_installed ctxt name then
193 remotify_prover_if_supported_and_not_already_remote ctxt name
195 fun avoid_too_many_threads _ _ [] = []
196 | avoid_too_many_threads _ (0, 0) _ = []
197 | avoid_too_many_threads ctxt (0, max_remote) provers =
199 |> map_filter (remotify_prover_if_supported_and_not_already_remote ctxt)
201 | avoid_too_many_threads _ (max_local, 0) provers =
203 |> filter_out (String.isPrefix remote_prefix)
205 | avoid_too_many_threads ctxt max_local_and_remote (prover :: provers) =
207 val max_local_and_remote =
209 |> (if String.isPrefix remote_prefix prover then apsnd else apfst)
211 in prover :: avoid_too_many_threads ctxt max_local_and_remote provers end
213 val max_default_remote_threads = 4
215 (* The first ATP of the list is used by Auto Sledgehammer. Because of the low
216 timeout, it makes sense to put SPASS first. *)
217 fun default_provers_param_value ctxt =
218 [spassN, spass_newN, eN, vampireN, SMT_Solver.solver_name_of ctxt, e_sineN,
220 |> map_filter (remotify_prover_if_not_installed ctxt)
221 |> avoid_too_many_threads ctxt (Multithreading.max_threads_value (),
222 max_default_remote_threads)
225 fun set_default_raw_param param thy =
226 let val ctxt = Proof_Context.init_global thy in
227 thy |> Data.map (AList.update (op =) (normalize_raw_param ctxt param))
229 fun default_raw_params ctxt =
230 let val thy = Proof_Context.theory_of ctxt in
232 |> fold (AList.default (op =))
233 [("provers", [case !provers of
234 "" => default_provers_param_value ctxt
236 ("timeout", let val timeout = !timeout in
237 [if timeout <= 0 then "none"
238 else string_of_int timeout]
242 val infinity_time_in_secs = 60 * 60 * 24 * 365
243 val the_timeout = the_default (Time.fromSeconds infinity_time_in_secs)
245 fun extract_params mode default_params override_params =
247 val raw_params = rev override_params @ rev default_params
248 val lookup = Option.map implode_param o AList.lookup (op =) raw_params
249 val lookup_string = the_default "" o lookup
250 fun general_lookup_bool option default_value name =
252 SOME s => parse_bool_option option name s
253 | NONE => default_value
254 val lookup_bool = the o general_lookup_bool false (SOME false)
255 fun lookup_time name =
257 SOME s => parse_time_option name s
259 fun lookup_int name =
262 | SOME s => case Int.fromString s of
264 | NONE => error ("Parameter " ^ quote name ^
265 " must be assigned an integer value.")
266 fun lookup_real_pair name =
269 | SOME s => case s |> space_explode " " |> map Real.fromString of
270 [SOME r1, SOME r2] => (r1, r2)
271 | _ => error ("Parameter " ^ quote name ^
272 "must be assigned a pair of floating-point \
273 \values (e.g., \"0.6 0.95\")")
274 fun lookup_option lookup' name =
277 | _ => SOME (lookup' name)
278 val debug = mode <> Auto_Try andalso lookup_bool "debug"
279 val verbose = debug orelse (mode <> Auto_Try andalso lookup_bool "verbose")
280 val overlord = lookup_bool "overlord"
282 Isabelle_Process.is_active () orelse mode <> Normal orelse debug orelse
283 lookup_bool "blocking"
284 val provers = lookup_string "provers" |> space_explode " "
285 |> mode = Auto_Try ? single o hd
287 if mode = Auto_Try then
289 else case lookup_string "type_enc" of
291 | s => (type_enc_from_string Strict s; SOME s)
292 val strict = mode = Auto_Try orelse lookup_bool "strict"
293 val lam_trans = lookup_option lookup_string "lam_trans"
294 val uncurried_aliases = lookup_option lookup_bool "uncurried_aliases"
295 val relevance_thresholds = lookup_real_pair "relevance_thresholds"
296 val max_relevant = lookup_option lookup_int "max_relevant"
297 val max_mono_iters = lookup_int "max_mono_iters"
298 val max_new_mono_instances = lookup_int "max_new_mono_instances"
299 val isar_proof = lookup_bool "isar_proof"
300 val isar_shrink_factor = Int.max (1, lookup_int "isar_shrink_factor")
301 val slice = mode <> Auto_Try andalso lookup_bool "slice"
303 if mode = Auto_Try then NONE else lookup_option lookup_bool "minimize"
305 (if mode = Auto_Try then NONE else lookup_time "timeout") |> the_timeout
306 val preplay_timeout =
307 if mode = Auto_Try then Time.zeroTime
308 else lookup_time "preplay_timeout" |> the_timeout
309 val expect = lookup_string "expect"
311 {debug = debug, verbose = verbose, overlord = overlord, blocking = blocking,
312 provers = provers, type_enc = type_enc, strict = strict,
313 lam_trans = lam_trans, uncurried_aliases = uncurried_aliases,
314 relevance_thresholds = relevance_thresholds, max_relevant = max_relevant,
315 max_mono_iters = max_mono_iters,
316 max_new_mono_instances = max_new_mono_instances, isar_proof = isar_proof,
317 isar_shrink_factor = isar_shrink_factor, slice = slice,
318 minimize = minimize, timeout = timeout, preplay_timeout = preplay_timeout,
322 fun get_params mode = extract_params mode o default_raw_params
323 fun default_params thy = get_params Normal thy o map (apsnd single)
325 (* Sledgehammer the given subgoal *)
327 val default_minimize_prover = metisN
329 fun is_raw_param_relevant_for_minimize (name, _) =
330 member (op =) params_for_minimize name
331 fun string_for_raw_param (key, values) =
332 key ^ (case implode_param values of "" => "" | value => " = " ^ value)
334 fun minimize_command override_params i more_override_params prover_name
339 |> filter_out (AList.defined (op =) more_override_params o fst)) @
341 |> filter is_raw_param_relevant_for_minimize
342 |> map string_for_raw_param
343 |> (if prover_name = default_minimize_prover then I else cons prover_name)
344 |> space_implode ", "
346 "sledgehammer" ^ " " ^ minN ^
347 (if params = "" then "" else enclose " [" "]" params) ^
348 " (" ^ space_implode " " fact_names ^ ")" ^
349 (if i = 1 then "" else " " ^ string_of_int i)
352 fun hammer_away override_params subcommand opt_i relevance_override state =
354 val ctxt = Proof.context_of state
355 val override_params = override_params |> map (normalize_raw_param ctxt)
357 if subcommand = runN then
358 let val i = the_default 1 opt_i in
359 run_sledgehammer (get_params Normal ctxt override_params) Normal i
360 relevance_override (minimize_command override_params i)
364 else if subcommand = minN then
365 run_minimize (get_params Minimize ctxt
366 (("provers", [default_minimize_prover]) ::
368 (the_default 1 opt_i) (#add relevance_override) state
369 else if subcommand = messagesN then
371 else if subcommand = supported_proversN then
372 supported_provers ctxt
373 else if subcommand = running_proversN then
375 else if subcommand = kill_proversN then
377 else if subcommand = refresh_tptpN then
378 refresh_systems_on_tptp ()
380 error ("Unknown subcommand: " ^ quote subcommand ^ ".")
383 fun sledgehammer_trans (((subcommand, params), relevance_override), opt_i) =
384 Toplevel.keep (hammer_away params subcommand opt_i relevance_override
387 fun string_for_raw_param (name, value) = name ^ " = " ^ implode_param value
389 fun sledgehammer_params_trans params =
391 (fold set_default_raw_param params
393 let val ctxt = Proof_Context.init_global thy in
394 writeln ("Default parameters for Sledgehammer:\n" ^
395 (case default_raw_params ctxt |> rev of
398 params |> map string_for_raw_param
399 |> sort_strings |> cat_lines))
402 val parse_query_bang = @{keyword "?"} || @{keyword "!"} || @{keyword "!!"}
404 Scan.repeat1 (Parse.typ_group || parse_query_bang) >> implode_param
406 Scan.repeat1 (Parse.xname || Parse.float_number || parse_query_bang)
407 val parse_param = parse_key -- Scan.optional (@{keyword "="} |-- parse_value) []
408 val parse_params = Scan.optional (Args.bracks (Parse.list parse_param)) []
409 val parse_fact_refs =
410 Scan.repeat1 (Scan.unless (Parse.name -- Args.colon) Parse_Spec.xthm)
411 val parse_relevance_chunk =
412 (Args.add |-- Args.colon |-- parse_fact_refs >> add_relevance_override)
413 || (Args.del |-- Args.colon |-- parse_fact_refs >> del_relevance_override)
414 || (parse_fact_refs >> only_relevance_override)
415 val parse_relevance_override =
416 Scan.optional (Args.parens (Scan.repeat parse_relevance_chunk
417 >> merge_relevance_overrides))
418 no_relevance_override
421 Outer_Syntax.improper_command @{command_spec "sledgehammer"}
422 "search for first-order proof using automatic theorem provers"
423 ((Scan.optional Parse.short_ident runN -- parse_params
424 -- parse_relevance_override -- Scan.option Parse.nat) #>> sledgehammer_trans)
426 Outer_Syntax.command @{command_spec "sledgehammer_params"}
427 "set and display the default parameters for Sledgehammer"
428 (parse_params #>> sledgehammer_params_trans)
430 fun try_sledgehammer auto state =
432 val ctxt = Proof.context_of state
433 val mode = if auto then Auto_Try else Try
436 run_sledgehammer (get_params mode ctxt []) mode i no_relevance_override
437 (minimize_command [] i) state
440 val setup = Try.register_tool ("sledgehammer", (40, auto, try_sledgehammer))