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_Filter
26 open Sledgehammer_Provers
27 open Sledgehammer_Minimize
30 val sledgehammerN = "sledgehammer"
31 val sledgehammer_paramsN = "sledgehammer_params"
35 val messagesN = "messages"
36 val supported_proversN = "supported_provers"
37 val running_proversN = "running_provers"
38 val kill_proversN = "kill_provers"
39 val refresh_tptpN = "refresh_tptp"
41 val auto = Unsynchronized.ref false
44 ProofGeneralPgip.add_preference Preferences.category_tracing
45 (Preferences.bool_pref auto "auto-sledgehammer"
46 "Run Sledgehammer automatically.")
48 (** Sledgehammer commands **)
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 fun unalias_raw_param (name, value) =
128 case AList.lookup (op =) alias_params name of
129 SOME name' => (name', value)
131 case AList.lookup (op =) negated_alias_params name of
132 SOME name' => (name', case value of
133 ["false"] => ["true"]
134 | ["true"] => ["false"]
137 | NONE => (name, value)
139 (* "provers =" and "type_enc =" can be left out. The latter is a secret
141 fun normalize_raw_param ctxt =
143 #> (fn (name, value) =>
144 if is_known_raw_param name then
146 else if is_prover_list ctxt name andalso null value then
148 else if can (type_enc_from_string Sound) name andalso null value then
151 error ("Unknown parameter: " ^ quote name ^ "."))
154 (* Ensure that type systems such as "mono_simple?" and "mono_guards!!" are
155 handled correctly. *)
156 fun implode_param [s, "?"] = s ^ "?"
157 | implode_param [s, "??"] = s ^ "??"
158 | implode_param [s, "!"] = s ^ "!"
159 | implode_param [s, "!!"] = s ^ "!!"
160 | implode_param ss = space_implode " " ss
162 structure Data = Theory_Data
164 type T = raw_param list
165 val empty = default_default_params |> map (apsnd single)
167 fun merge data : T = AList.merge (op =) (K true) data
170 fun remotify_prover_if_supported_and_not_already_remote ctxt name =
171 if String.isPrefix remote_prefix name then
174 let val remote_name = remote_prefix ^ name in
175 if is_prover_supported ctxt remote_name then SOME remote_name else NONE
178 fun remotify_prover_if_not_installed ctxt name =
179 if is_prover_supported ctxt name andalso is_prover_installed ctxt name then
182 remotify_prover_if_supported_and_not_already_remote ctxt name
184 fun avoid_too_many_threads _ _ [] = []
185 | avoid_too_many_threads _ (0, 0) _ = []
186 | avoid_too_many_threads ctxt (0, max_remote) provers =
188 |> map_filter (remotify_prover_if_supported_and_not_already_remote ctxt)
190 | avoid_too_many_threads _ (max_local, 0) provers =
192 |> filter_out (String.isPrefix remote_prefix)
194 | avoid_too_many_threads ctxt max_local_and_remote (prover :: provers) =
196 val max_local_and_remote =
198 |> (if String.isPrefix remote_prefix prover then apsnd else apfst)
200 in prover :: avoid_too_many_threads ctxt max_local_and_remote provers end
202 val max_default_remote_threads = 4
204 (* The first ATP of the list is used by Auto Sledgehammer. Because of the low
205 timeout, it makes sense to put SPASS first. *)
206 fun default_provers_param_value ctxt =
207 [spassN, eN, vampireN, SMT_Solver.solver_name_of ctxt, e_sineN, waldmeisterN]
208 |> map_filter (remotify_prover_if_not_installed ctxt)
209 |> avoid_too_many_threads ctxt (Multithreading.max_threads_value (),
210 max_default_remote_threads)
213 fun set_default_raw_param param thy =
214 let val ctxt = Proof_Context.init_global thy in
215 thy |> Data.map (AList.update (op =) (normalize_raw_param ctxt param))
217 fun default_raw_params ctxt =
218 let val thy = Proof_Context.theory_of ctxt in
220 |> fold (AList.default (op =))
221 [("provers", [case !provers of
222 "" => default_provers_param_value ctxt
224 ("timeout", let val timeout = !timeout in
225 [if timeout <= 0 then "none"
226 else string_of_int timeout]
230 val infinity_time_in_secs = 60 * 60 * 24 * 365
231 val the_timeout = the_default (Time.fromSeconds infinity_time_in_secs)
233 fun extract_params mode default_params override_params =
235 val raw_params = rev override_params @ rev default_params
236 val lookup = Option.map implode_param o AList.lookup (op =) raw_params
237 val lookup_string = the_default "" o lookup
238 fun general_lookup_bool option default_value name =
240 SOME s => parse_bool_option option name s
241 | NONE => default_value
242 val lookup_bool = the o general_lookup_bool false (SOME false)
243 fun lookup_time name =
245 SOME s => parse_time_option name s
247 fun lookup_int name =
250 | SOME s => case Int.fromString s of
252 | NONE => error ("Parameter " ^ quote name ^
253 " must be assigned an integer value.")
254 fun lookup_real_pair name =
257 | SOME s => case s |> space_explode " " |> map Real.fromString of
258 [SOME r1, SOME r2] => (r1, r2)
259 | _ => error ("Parameter " ^ quote name ^
260 "must be assigned a pair of floating-point \
261 \values (e.g., \"0.6 0.95\")")
262 fun lookup_option lookup' name =
265 | _ => SOME (lookup' name)
266 val debug = mode <> Auto_Try andalso lookup_bool "debug"
267 val verbose = debug orelse (mode <> Auto_Try andalso lookup_bool "verbose")
268 val overlord = lookup_bool "overlord"
270 Isabelle_Process.is_active () orelse mode <> Normal orelse debug orelse
271 lookup_bool "blocking"
272 val provers = lookup_string "provers" |> space_explode " "
273 |> mode = Auto_Try ? single o hd
275 if mode = Auto_Try then
277 else case lookup_string "type_enc" of
279 | s => (type_enc_from_string Sound s; SOME s)
280 val sound = mode = Auto_Try orelse lookup_bool "sound"
281 val relevance_thresholds = lookup_real_pair "relevance_thresholds"
282 val max_relevant = lookup_option lookup_int "max_relevant"
283 val max_mono_iters = lookup_int "max_mono_iters"
284 val max_new_mono_instances = lookup_int "max_new_mono_instances"
285 val isar_proof = lookup_bool "isar_proof"
286 val isar_shrink_factor = Int.max (1, lookup_int "isar_shrink_factor")
287 val slicing = mode <> Auto_Try andalso lookup_bool "slicing"
289 (if mode = Auto_Try then NONE else lookup_time "timeout") |> the_timeout
290 val preplay_timeout =
291 if mode = Auto_Try then Time.zeroTime
292 else lookup_time "preplay_timeout" |> the_timeout
293 val expect = lookup_string "expect"
295 {debug = debug, verbose = verbose, overlord = overlord, blocking = blocking,
296 provers = provers, relevance_thresholds = relevance_thresholds,
297 max_relevant = max_relevant, max_mono_iters = max_mono_iters,
298 max_new_mono_instances = max_new_mono_instances, type_enc = type_enc,
299 sound = sound, isar_proof = isar_proof,
300 isar_shrink_factor = isar_shrink_factor, slicing = slicing,
301 timeout = timeout, preplay_timeout = preplay_timeout, expect = expect}
304 fun get_params mode = extract_params mode o default_raw_params
305 fun default_params thy = get_params Normal thy o map (apsnd single)
307 (* Sledgehammer the given subgoal *)
309 val default_minimize_prover = Metis_Tactic.metisN
311 fun is_raw_param_relevant_for_minimize (name, _) =
312 member (op =) params_for_minimize name
313 fun string_for_raw_param (key, values) =
314 key ^ (case implode_param values of "" => "" | value => " = " ^ value)
316 fun minimize_command override_params i prover_name fact_names =
320 |> filter is_raw_param_relevant_for_minimize
321 |> map string_for_raw_param
322 |> (if prover_name = default_minimize_prover then I else cons prover_name)
323 |> space_implode ", "
325 sledgehammerN ^ " " ^ minN ^
326 (if params = "" then "" else enclose " [" "]" params) ^
327 " (" ^ space_implode " " fact_names ^ ")" ^
328 (if i = 1 then "" else " " ^ string_of_int i)
331 fun hammer_away override_params subcommand opt_i relevance_override state =
333 val ctxt = Proof.context_of state
334 val override_params = override_params |> map (normalize_raw_param ctxt)
336 if subcommand = runN then
337 let val i = the_default 1 opt_i in
338 run_sledgehammer (get_params Normal ctxt override_params) Normal i
339 relevance_override (minimize_command override_params i)
343 else if subcommand = minN then
344 run_minimize (get_params Minimize ctxt
345 (("provers", [default_minimize_prover]) ::
347 (the_default 1 opt_i) (#add relevance_override) state
348 else if subcommand = messagesN then
350 else if subcommand = supported_proversN then
351 supported_provers ctxt
352 else if subcommand = running_proversN then
354 else if subcommand = kill_proversN then
356 else if subcommand = refresh_tptpN then
357 refresh_systems_on_tptp ()
359 error ("Unknown subcommand: " ^ quote subcommand ^ ".")
362 fun sledgehammer_trans (((subcommand, params), relevance_override), opt_i) =
363 Toplevel.keep (hammer_away params subcommand opt_i relevance_override
366 fun string_for_raw_param (name, value) = name ^ " = " ^ implode_param value
368 fun sledgehammer_params_trans params =
370 (fold set_default_raw_param params
372 let val ctxt = Proof_Context.init_global thy in
373 writeln ("Default parameters for Sledgehammer:\n" ^
374 (case default_raw_params ctxt |> rev of
377 params |> map string_for_raw_param
378 |> sort_strings |> cat_lines))
381 val parse_query_bang = Parse.$$$ "?" || Parse.$$$ "!" || Parse.$$$ "!!"
383 Scan.repeat1 (Parse.typ_group || parse_query_bang) >> implode_param
385 Scan.repeat1 (Parse.xname || Parse.float_number || parse_query_bang)
386 val parse_param = parse_key -- Scan.optional (Parse.$$$ "=" |-- parse_value) []
387 val parse_params = Scan.optional (Args.bracks (Parse.list parse_param)) []
388 val parse_fact_refs =
389 Scan.repeat1 (Scan.unless (Parse.name -- Args.colon) Parse_Spec.xthm)
390 val parse_relevance_chunk =
391 (Args.add |-- Args.colon |-- parse_fact_refs >> add_relevance_override)
392 || (Args.del |-- Args.colon |-- parse_fact_refs >> del_relevance_override)
393 || (parse_fact_refs >> only_relevance_override)
394 val parse_relevance_override =
395 Scan.optional (Args.parens (Scan.repeat parse_relevance_chunk
396 >> merge_relevance_overrides))
397 no_relevance_override
398 val parse_sledgehammer_command =
399 (Scan.optional Parse.short_ident runN -- parse_params
400 -- parse_relevance_override -- Scan.option Parse.nat) #>> sledgehammer_trans
401 val parse_sledgehammer_params_command =
402 parse_params #>> sledgehammer_params_trans
405 Outer_Syntax.improper_command sledgehammerN
406 "search for first-order proof using automatic theorem provers" Keyword.diag
407 parse_sledgehammer_command
409 Outer_Syntax.command sledgehammer_paramsN
410 "set and display the default parameters for Sledgehammer" Keyword.thy_decl
411 parse_sledgehammer_params_command
413 fun try_sledgehammer auto state =
415 val ctxt = Proof.context_of state
416 val mode = if auto then Auto_Try else Try
419 run_sledgehammer (get_params mode ctxt []) mode i no_relevance_override
420 (minimize_command [] i) state
423 val setup = Try.register_tool (sledgehammerN, (40, auto, try_sledgehammer))