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 full_types : bool Unsynchronized.ref
15 val default_params : Proof.context -> (string * string) list -> params
16 val setup : theory -> theory
19 structure Sledgehammer_Isar : SLEDGEHAMMER_ISAR =
23 open Sledgehammer_Util
24 open Sledgehammer_ATP_Translate
25 open Sledgehammer_Provers
26 open Sledgehammer_Minimize
29 val auto = Unsynchronized.ref false
32 ProofGeneralPgip.add_preference Preferences.category_tracing
33 (Preferences.bool_pref auto "auto-sledgehammer"
34 "Run Sledgehammer automatically.")
36 (** Sledgehammer commands **)
38 val no_relevance_override = {add = [], del = [], only = false}
39 fun add_relevance_override ns : relevance_override =
40 {add = ns, del = [], only = false}
41 fun del_relevance_override ns : relevance_override =
42 {add = [], del = ns, only = false}
43 fun only_relevance_override ns : relevance_override =
44 {add = ns, del = [], only = true}
45 fun merge_relevance_override_pairwise (r1 : relevance_override)
46 (r2 : relevance_override) =
47 {add = #add r1 @ #add r2, del = #del r1 @ #del r2,
48 only = #only r1 andalso #only r2}
49 fun merge_relevance_overrides rs =
50 fold merge_relevance_override_pairwise rs (only_relevance_override [])
54 val provers = Unsynchronized.ref ""
55 val timeout = Unsynchronized.ref 30
56 val full_types = Unsynchronized.ref false
59 ProofGeneralPgip.add_preference Preferences.category_proof
60 (Preferences.string_pref provers
61 "Sledgehammer: Provers"
62 "Default automatic provers (separated by whitespace)")
65 ProofGeneralPgip.add_preference Preferences.category_proof
66 (Preferences.int_pref timeout
67 "Sledgehammer: Time Limit"
68 "ATPs will be interrupted after this time (in seconds)")
71 ProofGeneralPgip.add_preference Preferences.category_proof
72 (Preferences.bool_pref full_types
73 "Sledgehammer: Full Types" "ATPs will use full type information")
75 type raw_param = string * string list
77 val default_default_params =
80 ("overlord", "false"),
81 ("blocking", "false"),
82 ("relevance_thresholds", "0.45 0.85"),
83 ("max_relevant", "smart"),
84 ("monomorphize", "false"),
85 ("monomorphize_limit", "4"),
86 ("type_sys", "smart"),
87 ("explicit_apply", "false"),
88 ("isar_proof", "false"),
89 ("isar_shrink_factor", "1"),
93 [("prover", "provers"),
94 ("atps", "provers"), (* FIXME: legacy *)
95 ("atp", "provers")] (* FIXME: legacy *)
96 val negated_alias_params =
97 [("no_debug", "debug"),
99 ("no_overlord", "overlord"),
100 ("non_blocking", "blocking"),
101 ("dont_monomorphize", "monomorphize"),
102 ("partial_types", "full_types"),
103 ("implicit_apply", "explicit_apply"),
104 ("no_isar_proof", "isar_proof"),
105 ("no_slicing", "slicing")]
107 val params_for_minimize =
108 ["debug", "verbose", "overlord", "type_sys", "full_types", "isar_proof",
109 "isar_shrink_factor", "timeout"]
111 val property_dependent_params = ["provers", "full_types", "timeout"]
113 fun is_known_raw_param s =
114 AList.defined (op =) default_default_params s orelse
115 AList.defined (op =) alias_params s orelse
116 AList.defined (op =) negated_alias_params s orelse
117 member (op =) property_dependent_params s orelse s = "expect"
119 fun is_prover_list ctxt s =
120 case space_explode " " s of
121 ss as _ :: _ => forall (is_prover_supported ctxt) ss
124 fun check_and_repair_raw_param ctxt (name, value) =
125 if is_known_raw_param name then (name, value)
126 else if is_prover_list ctxt name andalso null value then ("provers", [name])
127 else error ("Unknown parameter: " ^ quote name ^ ".")
129 fun unalias_raw_param (name, value) =
130 case AList.lookup (op =) alias_params name of
131 SOME name' => (name', value)
133 case AList.lookup (op =) negated_alias_params name of
134 SOME name' => (name', case value of
135 ["false"] => ["true"]
136 | ["true"] => ["false"]
139 | NONE => (name, value)
141 structure Data = Theory_Data
143 type T = raw_param list
144 val empty = default_default_params |> map (apsnd single)
146 fun merge data : T = AList.merge (op =) (K true) data
149 fun remotify_prover_if_supported_and_not_already_remote ctxt name =
150 if String.isPrefix remote_prefix name then
153 let val remote_name = remote_prefix ^ name in
154 if is_prover_supported ctxt remote_name then SOME remote_name else NONE
157 fun remotify_prover_if_not_installed ctxt name =
158 if is_prover_supported ctxt name andalso is_prover_installed ctxt name then
161 remotify_prover_if_supported_and_not_already_remote ctxt name
163 fun avoid_too_many_local_threads _ _ [] = []
164 | avoid_too_many_local_threads ctxt 0 provers =
165 map_filter (remotify_prover_if_supported_and_not_already_remote ctxt)
167 | avoid_too_many_local_threads ctxt n (prover :: provers) =
168 let val n = if String.isPrefix remote_prefix prover then n else n - 1 in
169 prover :: avoid_too_many_local_threads ctxt n provers
172 (* The first ATP of the list is used by Auto Sledgehammer. Because of the low
173 timeout, it makes sense to put SPASS first. *)
174 fun default_provers_param_value ctxt =
175 [spassN, eN, vampireN, sine_eN, SMT_Solver.solver_name_of ctxt]
176 |> map_filter (remotify_prover_if_not_installed ctxt)
177 |> avoid_too_many_local_threads ctxt (Multithreading.max_threads_value ())
180 val set_default_raw_param = Data.map o AList.update (op =) o unalias_raw_param
181 fun default_raw_params ctxt =
182 let val thy = Proof_Context.theory_of ctxt in
184 |> fold (AList.default (op =))
185 [("provers", [case !provers of
186 "" => default_provers_param_value ctxt
188 ("full_types", [if !full_types then "true" else "false"]),
189 ("timeout", let val timeout = !timeout in
190 [if timeout <= 0 then "none"
191 else string_of_int timeout]
195 val infinity_time_in_secs = 60 * 60 * 24 * 365
196 val the_timeout = the_default (Time.fromSeconds infinity_time_in_secs)
198 fun extract_params auto default_params override_params =
200 val override_params = map unalias_raw_param override_params
201 val raw_params = rev override_params @ rev default_params
202 val lookup = Option.map (space_implode " ") o AList.lookup (op =) raw_params
203 val lookup_string = the_default "" o lookup
204 fun general_lookup_bool option default_value name =
206 SOME s => parse_bool_option option name s
207 | NONE => default_value
208 val lookup_bool = the o general_lookup_bool false (SOME false)
209 fun lookup_time name =
211 SOME s => parse_time_option name s
213 fun lookup_int name =
216 | SOME s => case Int.fromString s of
218 | NONE => error ("Parameter " ^ quote name ^
219 " must be assigned an integer value.")
220 fun lookup_real_pair name =
223 | SOME s => case s |> space_explode " " |> map Real.fromString of
224 [SOME r1, SOME r2] => (r1, r2)
225 | _ => error ("Parameter " ^ quote name ^
226 "must be assigned a pair of floating-point \
227 \values (e.g., \"0.6 0.95\")")
228 fun lookup_int_option name =
231 | _ => SOME (lookup_int name)
232 val debug = not auto andalso lookup_bool "debug"
233 val verbose = debug orelse (not auto andalso lookup_bool "verbose")
234 val overlord = lookup_bool "overlord"
235 val blocking = auto orelse debug orelse lookup_bool "blocking"
236 val provers = lookup_string "provers" |> space_explode " "
237 |> auto ? single o hd
238 val relevance_thresholds = lookup_real_pair "relevance_thresholds"
239 val max_relevant = lookup_int_option "max_relevant"
240 val monomorphize = lookup_bool "monomorphize"
241 val monomorphize_limit = lookup_int "monomorphize_limit"
243 case (lookup_string "type_sys", lookup_bool "full_types") of
244 ("tags", full_types) => Tags full_types
245 | ("args", false) => Args
246 | ("mangled", false) => if monomorphize then Mangled else Args
247 | ("none", false) => No_Types
248 | (type_sys, full_types) =>
249 if member (op =) ["args", "mangled", "none", "smart"]
251 if full_types then Tags true else Args
253 error ("Unknown type system: " ^ quote type_sys ^ ".")
254 val explicit_apply = lookup_bool "explicit_apply"
255 val isar_proof = lookup_bool "isar_proof"
256 val isar_shrink_factor = Int.max (1, lookup_int "isar_shrink_factor")
257 val slicing = lookup_bool "slicing"
258 val timeout = (if auto then NONE else lookup_time "timeout") |> the_timeout
259 val expect = lookup_string "expect"
261 {debug = debug, verbose = verbose, overlord = overlord, blocking = blocking,
262 provers = provers, relevance_thresholds = relevance_thresholds,
263 max_relevant = max_relevant, monomorphize = monomorphize,
264 monomorphize_limit = monomorphize_limit, type_sys = type_sys,
265 explicit_apply = explicit_apply, isar_proof = isar_proof,
266 isar_shrink_factor = isar_shrink_factor, slicing = slicing,
267 timeout = timeout, expect = expect}
270 fun get_params auto ctxt = extract_params auto (default_raw_params ctxt)
271 fun default_params thy = get_params false thy o map (apsnd single)
273 (* Sledgehammer the given subgoal *)
275 val sledgehammerN = "sledgehammer"
276 val sledgehammer_paramsN = "sledgehammer_params"
279 val minimizeN = "minimize"
280 val messagesN = "messages"
281 val supported_proversN = "supported_provers"
282 val running_proversN = "running_provers"
283 val kill_proversN = "kill_provers"
284 val refresh_tptpN = "refresh_tptp"
286 val is_raw_param_relevant_for_minimize =
287 member (op =) params_for_minimize o fst o unalias_raw_param
288 fun string_for_raw_param (key, values) =
289 key ^ (case space_implode " " values of "" => "" | value => " = " ^ value)
291 fun minimize_command override_params i prover_name fact_names =
292 sledgehammerN ^ " " ^ minimizeN ^ " [prover = " ^ prover_name ^
293 (override_params |> filter is_raw_param_relevant_for_minimize
294 |> implode o map (prefix ", " o string_for_raw_param)) ^
295 "] (" ^ space_implode " " fact_names ^ ")" ^
296 (if i = 1 then "" else " " ^ string_of_int i)
298 fun hammer_away override_params subcommand opt_i relevance_override state =
300 val ctxt = Proof.context_of state
301 val override_params =
302 override_params |> map (check_and_repair_raw_param ctxt)
304 if subcommand = runN then
305 let val i = the_default 1 opt_i in
306 run_sledgehammer (get_params false ctxt override_params) false true i
307 relevance_override (minimize_command override_params i)
311 else if subcommand = minimizeN then
312 run_minimize (get_params false ctxt override_params) (the_default 1 opt_i)
313 (#add relevance_override) state
314 else if subcommand = messagesN then
316 else if subcommand = supported_proversN then
317 supported_provers ctxt
318 else if subcommand = running_proversN then
320 else if subcommand = kill_proversN then
322 else if subcommand = refresh_tptpN then
323 refresh_systems_on_tptp ()
325 error ("Unknown subcommand: " ^ quote subcommand ^ ".")
328 fun sledgehammer_trans (((subcommand, params), relevance_override), opt_i) =
329 Toplevel.keep (hammer_away params subcommand opt_i relevance_override
332 fun string_for_raw_param (name, value) = name ^ " = " ^ space_implode " " value
334 fun sledgehammer_params_trans params =
336 (fold set_default_raw_param params
338 let val ctxt = Proof_Context.init_global thy in
339 writeln ("Default parameters for Sledgehammer:\n" ^
340 (case default_raw_params ctxt |> rev of
343 params |> map (check_and_repair_raw_param ctxt)
344 |> map string_for_raw_param
345 |> sort_strings |> cat_lines))
348 val parse_key = Scan.repeat1 Parse.typ_group >> space_implode " "
349 val parse_value = Scan.repeat1 (Parse.xname || Parse.float_number)
350 val parse_param = parse_key -- Scan.optional (Parse.$$$ "=" |-- parse_value) []
351 val parse_params = Scan.optional (Args.bracks (Parse.list parse_param)) []
352 val parse_fact_refs =
353 Scan.repeat1 (Scan.unless (Parse.name -- Args.colon) Parse_Spec.xthm)
354 val parse_relevance_chunk =
355 (Args.add |-- Args.colon |-- parse_fact_refs >> add_relevance_override)
356 || (Args.del |-- Args.colon |-- parse_fact_refs >> del_relevance_override)
357 || (parse_fact_refs >> only_relevance_override)
358 val parse_relevance_override =
359 Scan.optional (Args.parens (Scan.repeat parse_relevance_chunk
360 >> merge_relevance_overrides))
361 no_relevance_override
362 val parse_sledgehammer_command =
363 (Scan.optional Parse.short_ident runN -- parse_params
364 -- parse_relevance_override -- Scan.option Parse.nat) #>> sledgehammer_trans
365 val parse_sledgehammer_params_command =
366 parse_params #>> sledgehammer_params_trans
369 Outer_Syntax.improper_command sledgehammerN
370 "search for first-order proof using automatic theorem provers" Keyword.diag
371 parse_sledgehammer_command
373 Outer_Syntax.command sledgehammer_paramsN
374 "set and display the default parameters for Sledgehammer" Keyword.thy_decl
375 parse_sledgehammer_params_command
377 fun auto_sledgehammer state =
378 let val ctxt = Proof.context_of state in
379 run_sledgehammer (get_params true ctxt []) true false 1
380 no_relevance_override (minimize_command [] 1) state
383 val setup = Auto_Tools.register_tool (auto, auto_sledgehammer)