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 =
26 open Sledgehammer_Util
27 open Sledgehammer_Filter
28 open Sledgehammer_Provers
29 open Sledgehammer_Minimize
32 val sledgehammerN = "sledgehammer"
33 val sledgehammer_paramsN = "sledgehammer_params"
37 val messagesN = "messages"
38 val supported_proversN = "supported_provers"
39 val running_proversN = "running_provers"
40 val kill_proversN = "kill_provers"
41 val refresh_tptpN = "refresh_tptp"
43 val auto = Unsynchronized.ref false
46 ProofGeneralPgip.add_preference Preferences.category_tracing
47 (Preferences.bool_pref auto "auto-sledgehammer"
48 "Run Sledgehammer automatically.")
50 (** Sledgehammer commands **)
52 fun add_relevance_override ns : relevance_override =
53 {add = ns, del = [], only = false}
54 fun del_relevance_override ns : relevance_override =
55 {add = [], del = ns, only = false}
56 fun only_relevance_override ns : relevance_override =
57 {add = ns, del = [], only = true}
58 fun merge_relevance_override_pairwise (r1 : relevance_override)
59 (r2 : relevance_override) =
60 {add = #add r1 @ #add r2, del = #del r1 @ #del r2,
61 only = #only r1 andalso #only r2}
62 fun merge_relevance_overrides rs =
63 fold merge_relevance_override_pairwise rs (only_relevance_override [])
67 val provers = Unsynchronized.ref ""
68 val timeout = Unsynchronized.ref 30
71 ProofGeneralPgip.add_preference Preferences.category_proof
72 (Preferences.string_pref provers
73 "Sledgehammer: Provers"
74 "Default automatic provers (separated by whitespace)")
77 ProofGeneralPgip.add_preference Preferences.category_proof
78 (Preferences.int_pref timeout
79 "Sledgehammer: Time Limit"
80 "ATPs will be interrupted after this time (in seconds)")
82 type raw_param = string * string list
84 val default_default_params =
87 ("overlord", "false"),
88 ("blocking", "false"),
89 ("type_enc", "smart"),
91 ("lam_trans", "smart"),
92 ("relevance_thresholds", "0.45 0.85"),
93 ("max_relevant", "smart"),
94 ("max_mono_iters", "3"),
95 ("max_new_mono_instances", "200"),
96 ("isar_proof", "false"),
97 ("isar_shrink_factor", "1"),
99 ("preplay_timeout", "4")]
102 [("prover", "provers")]
103 val negated_alias_params =
104 [("no_debug", "debug"),
105 ("quiet", "verbose"),
106 ("no_overlord", "overlord"),
107 ("non_blocking", "blocking"),
108 ("unsound", "sound"),
109 ("no_isar_proof", "isar_proof"),
110 ("dont_slice", "slice")]
112 val params_for_minimize =
113 ["debug", "verbose", "overlord", "type_enc", "sound", "lam_trans",
114 "max_mono_iters", "max_new_mono_instances", "isar_proof",
115 "isar_shrink_factor", "timeout", "preplay_timeout"]
117 val property_dependent_params = ["provers", "timeout"]
119 fun is_known_raw_param s =
120 AList.defined (op =) default_default_params s orelse
121 AList.defined (op =) alias_params s orelse
122 AList.defined (op =) negated_alias_params s orelse
123 member (op =) property_dependent_params s orelse s = "expect"
125 fun is_prover_list ctxt s =
126 case space_explode " " s of
127 ss as _ :: _ => forall (is_prover_supported ctxt) ss
130 fun unalias_raw_param (name, value) =
131 case AList.lookup (op =) alias_params name of
132 SOME name' => (name', value)
134 case AList.lookup (op =) negated_alias_params name of
135 SOME name' => (name', case value of
136 ["false"] => ["true"]
137 | ["true"] => ["false"]
140 | NONE => (name, value)
142 val any_type_enc = type_enc_from_string Sound "erased"
144 (* "provers =", "type_enc =", and "lam_trans" can be omitted. For the last two,
145 this is a secret feature. *)
146 fun normalize_raw_param ctxt =
148 #> (fn (name, value) =>
149 if is_known_raw_param name then
151 else if is_prover_list ctxt name andalso null value then
153 else if can (type_enc_from_string Sound) name andalso null value then
155 else if can (trans_lams_from_string ctxt any_type_enc) name andalso
157 ("lam_trans", [name])
159 error ("Unknown parameter: " ^ quote name ^ "."))
162 (* Ensures that type encodings such as "mono_simple?" and "poly_guards!!" are
164 val implode_param = strip_spaces_except_between_idents o space_implode " "
166 structure Data = Theory_Data
168 type T = raw_param list
169 val empty = default_default_params |> map (apsnd single)
171 fun merge data : T = AList.merge (op =) (K true) data
174 fun remotify_prover_if_supported_and_not_already_remote ctxt name =
175 if String.isPrefix remote_prefix name then
178 let val remote_name = remote_prefix ^ name in
179 if is_prover_supported ctxt remote_name then SOME remote_name else NONE
182 fun remotify_prover_if_not_installed ctxt name =
183 if is_prover_supported ctxt name andalso is_prover_installed ctxt name then
186 remotify_prover_if_supported_and_not_already_remote ctxt name
188 fun avoid_too_many_threads _ _ [] = []
189 | avoid_too_many_threads _ (0, 0) _ = []
190 | avoid_too_many_threads ctxt (0, max_remote) provers =
192 |> map_filter (remotify_prover_if_supported_and_not_already_remote ctxt)
194 | avoid_too_many_threads _ (max_local, 0) provers =
196 |> filter_out (String.isPrefix remote_prefix)
198 | avoid_too_many_threads ctxt max_local_and_remote (prover :: provers) =
200 val max_local_and_remote =
202 |> (if String.isPrefix remote_prefix prover then apsnd else apfst)
204 in prover :: avoid_too_many_threads ctxt max_local_and_remote provers end
206 val max_default_remote_threads = 4
208 (* The first ATP of the list is used by Auto Sledgehammer. Because of the low
209 timeout, it makes sense to put SPASS first. *)
210 fun default_provers_param_value ctxt =
211 [spassN, eN, vampireN, SMT_Solver.solver_name_of ctxt, e_sineN, waldmeisterN]
212 |> map_filter (remotify_prover_if_not_installed ctxt)
213 |> avoid_too_many_threads ctxt (Multithreading.max_threads_value (),
214 max_default_remote_threads)
217 fun set_default_raw_param param thy =
218 let val ctxt = Proof_Context.init_global thy in
219 thy |> Data.map (AList.update (op =) (normalize_raw_param ctxt param))
221 fun default_raw_params ctxt =
222 let val thy = Proof_Context.theory_of ctxt in
224 |> fold (AList.default (op =))
225 [("provers", [case !provers of
226 "" => default_provers_param_value ctxt
228 ("timeout", let val timeout = !timeout in
229 [if timeout <= 0 then "none"
230 else string_of_int timeout]
234 val infinity_time_in_secs = 60 * 60 * 24 * 365
235 val the_timeout = the_default (Time.fromSeconds infinity_time_in_secs)
237 fun extract_params mode default_params override_params =
239 val raw_params = rev override_params @ rev default_params
240 val lookup = Option.map implode_param o AList.lookup (op =) raw_params
241 val lookup_string = the_default "" o lookup
242 fun general_lookup_bool option default_value name =
244 SOME s => parse_bool_option option name s
245 | NONE => default_value
246 val lookup_bool = the o general_lookup_bool false (SOME false)
247 fun lookup_time name =
249 SOME s => parse_time_option name s
251 fun lookup_int name =
254 | SOME s => case Int.fromString s of
256 | NONE => error ("Parameter " ^ quote name ^
257 " must be assigned an integer value.")
258 fun lookup_real_pair name =
261 | SOME s => case s |> space_explode " " |> map Real.fromString of
262 [SOME r1, SOME r2] => (r1, r2)
263 | _ => error ("Parameter " ^ quote name ^
264 "must be assigned a pair of floating-point \
265 \values (e.g., \"0.6 0.95\")")
266 fun lookup_option lookup' name =
269 | _ => SOME (lookup' name)
270 val debug = mode <> Auto_Try andalso lookup_bool "debug"
271 val verbose = debug orelse (mode <> Auto_Try andalso lookup_bool "verbose")
272 val overlord = lookup_bool "overlord"
274 Isabelle_Process.is_active () orelse mode <> Normal orelse debug orelse
275 lookup_bool "blocking"
276 val provers = lookup_string "provers" |> space_explode " "
277 |> mode = Auto_Try ? single o hd
279 if mode = Auto_Try then
281 else case lookup_string "type_enc" of
283 | s => (type_enc_from_string Sound s; SOME s)
284 val sound = mode = Auto_Try orelse lookup_bool "sound"
285 val lam_trans = lookup_option lookup_string "lam_trans"
286 val relevance_thresholds = lookup_real_pair "relevance_thresholds"
287 val max_relevant = lookup_option lookup_int "max_relevant"
288 val max_mono_iters = lookup_int "max_mono_iters"
289 val max_new_mono_instances = lookup_int "max_new_mono_instances"
290 val isar_proof = lookup_bool "isar_proof"
291 val isar_shrink_factor = Int.max (1, lookup_int "isar_shrink_factor")
292 val slice = mode <> Auto_Try andalso lookup_bool "slice"
294 (if mode = Auto_Try then NONE else lookup_time "timeout") |> the_timeout
295 val preplay_timeout =
296 if mode = Auto_Try then Time.zeroTime
297 else lookup_time "preplay_timeout" |> the_timeout
298 val expect = lookup_string "expect"
300 {debug = debug, verbose = verbose, overlord = overlord, blocking = blocking,
301 provers = provers, type_enc = type_enc, sound = sound,
302 lam_trans = lam_trans, relevance_thresholds = relevance_thresholds,
303 max_relevant = max_relevant, max_mono_iters = max_mono_iters,
304 max_new_mono_instances = max_new_mono_instances, isar_proof = isar_proof,
305 isar_shrink_factor = isar_shrink_factor, slice = slice, timeout = timeout,
306 preplay_timeout = preplay_timeout, expect = expect}
309 fun get_params mode = extract_params mode o default_raw_params
310 fun default_params thy = get_params Normal thy o map (apsnd single)
312 (* Sledgehammer the given subgoal *)
314 val default_minimize_prover = metisN
316 fun is_raw_param_relevant_for_minimize (name, _) =
317 member (op =) params_for_minimize name
318 fun string_for_raw_param (key, values) =
319 key ^ (case implode_param values of "" => "" | value => " = " ^ value)
321 fun minimize_command override_params i more_override_params prover_name
326 |> filter_out (AList.defined (op =) more_override_params o fst)) @
328 |> filter is_raw_param_relevant_for_minimize
329 |> map string_for_raw_param
330 |> (if prover_name = default_minimize_prover then I else cons prover_name)
331 |> space_implode ", "
333 sledgehammerN ^ " " ^ minN ^
334 (if params = "" then "" else enclose " [" "]" params) ^
335 " (" ^ space_implode " " fact_names ^ ")" ^
336 (if i = 1 then "" else " " ^ string_of_int i)
339 fun hammer_away override_params subcommand opt_i relevance_override state =
341 val ctxt = Proof.context_of state
342 val override_params = override_params |> map (normalize_raw_param ctxt)
344 if subcommand = runN then
345 let val i = the_default 1 opt_i in
346 run_sledgehammer (get_params Normal ctxt override_params) Normal i
347 relevance_override (minimize_command override_params i)
351 else if subcommand = minN then
352 run_minimize (get_params Minimize ctxt
353 (("provers", [default_minimize_prover]) ::
355 (the_default 1 opt_i) (#add relevance_override) state
356 else if subcommand = messagesN then
358 else if subcommand = supported_proversN then
359 supported_provers ctxt
360 else if subcommand = running_proversN then
362 else if subcommand = kill_proversN then
364 else if subcommand = refresh_tptpN then
365 refresh_systems_on_tptp ()
367 error ("Unknown subcommand: " ^ quote subcommand ^ ".")
370 fun sledgehammer_trans (((subcommand, params), relevance_override), opt_i) =
371 Toplevel.keep (hammer_away params subcommand opt_i relevance_override
374 fun string_for_raw_param (name, value) = name ^ " = " ^ implode_param value
376 fun sledgehammer_params_trans params =
378 (fold set_default_raw_param params
380 let val ctxt = Proof_Context.init_global thy in
381 writeln ("Default parameters for Sledgehammer:\n" ^
382 (case default_raw_params ctxt |> rev of
385 params |> map string_for_raw_param
386 |> sort_strings |> cat_lines))
389 val parse_query_bang = Parse.$$$ "?" || Parse.$$$ "!" || Parse.$$$ "!!"
391 Scan.repeat1 (Parse.typ_group || parse_query_bang) >> implode_param
393 Scan.repeat1 (Parse.xname || Parse.float_number || parse_query_bang)
394 val parse_param = parse_key -- Scan.optional (Parse.$$$ "=" |-- parse_value) []
395 val parse_params = Scan.optional (Args.bracks (Parse.list parse_param)) []
396 val parse_fact_refs =
397 Scan.repeat1 (Scan.unless (Parse.name -- Args.colon) Parse_Spec.xthm)
398 val parse_relevance_chunk =
399 (Args.add |-- Args.colon |-- parse_fact_refs >> add_relevance_override)
400 || (Args.del |-- Args.colon |-- parse_fact_refs >> del_relevance_override)
401 || (parse_fact_refs >> only_relevance_override)
402 val parse_relevance_override =
403 Scan.optional (Args.parens (Scan.repeat parse_relevance_chunk
404 >> merge_relevance_overrides))
405 no_relevance_override
406 val parse_sledgehammer_command =
407 (Scan.optional Parse.short_ident runN -- parse_params
408 -- parse_relevance_override -- Scan.option Parse.nat) #>> sledgehammer_trans
409 val parse_sledgehammer_params_command =
410 parse_params #>> sledgehammer_params_trans
413 Outer_Syntax.improper_command sledgehammerN
414 "search for first-order proof using automatic theorem provers" Keyword.diag
415 parse_sledgehammer_command
417 Outer_Syntax.command sledgehammer_paramsN
418 "set and display the default parameters for Sledgehammer" Keyword.thy_decl
419 parse_sledgehammer_params_command
421 fun try_sledgehammer auto state =
423 val ctxt = Proof.context_of state
424 val mode = if auto then Auto_Try else Try
427 run_sledgehammer (get_params mode ctxt []) mode i no_relevance_override
428 (minimize_command [] i) state
431 val setup = Try.register_tool (sledgehammerN, (40, auto, try_sledgehammer))