src/HOL/Tools/res_atp.ML
author paulson
Thu Dec 07 16:47:36 2006 +0100 (2006-12-07)
changeset 21690 552d20ff9a95
parent 21588 cd0dc678a205
child 21790 9d2761d09d91
permissions -rw-r--r--
Removal of theorem tagging, which the ATP linkup no longer requires.
Suffixes no longer blacklisted.
     1 (*  Author: Jia Meng, Cambridge University Computer Laboratory, NICTA
     2     ID: $Id$
     3     Copyright 2004 University of Cambridge
     4 
     5 ATPs with TPTP format input.
     6 *)
     7 
     8 (*Currently unused, during debugging*)
     9 signature RES_ATP =
    10 sig
    11   val prover: string ref
    12   val custom_spass: string list ref
    13   val destdir: string ref
    14   val helper_path: string -> string -> string
    15   val problem_name: string ref
    16   val time_limit: int ref
    17   val set_prover: string -> unit
    18 
    19   datatype mode = Auto | Fol | Hol
    20   val linkup_logic_mode : mode ref
    21   val write_subgoal_file: bool -> mode -> Proof.context -> thm list -> thm list -> int -> string
    22   val vampire_time: int ref
    23   val eprover_time: int ref
    24   val spass_time: int ref
    25   val run_vampire: int -> unit
    26   val run_eprover: int -> unit
    27   val run_spass: int -> unit
    28   val vampireLimit: unit -> int
    29   val eproverLimit: unit -> int
    30   val spassLimit: unit -> int
    31   val atp_method: (Proof.context -> thm list -> int -> tactic) ->
    32     Method.src -> Proof.context -> Proof.method
    33   val cond_rm_tmp: string -> unit
    34   val fol_keep_types: bool ref
    35   val hol_full_types: unit -> unit
    36   val hol_partial_types: unit -> unit
    37   val hol_const_types_only: unit -> unit
    38   val hol_no_types: unit -> unit
    39   val hol_typ_level: unit -> ResHolClause.type_level
    40   val include_all: bool ref
    41   val run_relevance_filter: bool ref
    42   val run_blacklist_filter: bool ref
    43   val blacklist: string list ref
    44   val add_all : unit -> unit
    45   val add_claset : unit -> unit
    46   val add_simpset : unit -> unit
    47   val add_clasimp : unit -> unit
    48   val add_atpset : unit -> unit
    49   val rm_all : unit -> unit
    50   val rm_claset : unit -> unit
    51   val rm_simpset : unit -> unit
    52   val rm_atpset : unit -> unit
    53   val rm_clasimp : unit -> unit
    54   val is_fol_thms : thm list -> bool
    55 end;
    56 
    57 structure ResAtp =
    58 struct
    59 
    60 fun timestamp s = Output.debug ("At " ^ Time.toString (Time.now()) ^ ": " ^ s);
    61 
    62 (********************************************************************)
    63 (* some settings for both background automatic ATP calling procedure*)
    64 (* and also explicit ATP invocation methods                         *)
    65 (********************************************************************)
    66 
    67 (*** background linkup ***)
    68 val call_atp = ref false;
    69 val hook_count = ref 0;
    70 val time_limit = ref 60;
    71 val prover = ref "";
    72 
    73 fun set_prover atp =
    74   case String.map Char.toLower atp of
    75       "e" =>
    76           (ReduceAxiomsN.max_new := 100;
    77            ReduceAxiomsN.theory_const := false;
    78            prover := "E")
    79     | "spass" =>
    80           (ReduceAxiomsN.max_new := 40;
    81            ReduceAxiomsN.theory_const := true;
    82            prover := "spass")
    83     | "vampire" =>
    84           (ReduceAxiomsN.max_new := 60;
    85            ReduceAxiomsN.theory_const := false;
    86            prover := "vampire")
    87     | _ => error ("No such prover: " ^ atp);
    88 
    89 val _ = set_prover "E"; (* use E as the default prover *)
    90 
    91 val custom_spass =   (*specialized options for SPASS*)
    92       ref ["-Auto=0","-FullRed=0","-IORe","-IOFc","-RTaut","-RFSub","-RBSub"];
    93 val destdir = ref "";   (*Empty means write files to /tmp*)
    94 val problem_name = ref "prob";
    95 
    96 (*Return the path to a "helper" like SPASS or tptp2X, first checking that
    97   it exists.  FIXME: modify to use Path primitives and move to some central place.*)
    98 fun helper_path evar base =
    99   case getenv evar of
   100       "" => error  ("Isabelle environment variable " ^ evar ^ " not defined")
   101     | home =>
   102         let val path = home ^ "/" ^ base
   103         in  if File.exists (File.unpack_platform_path path) then path
   104             else error ("Could not find the file " ^ path)
   105         end;
   106 
   107 fun probfile_nosuffix _ =
   108   if !destdir = "" then File.platform_path (File.tmp_path (Path.basic (!problem_name)))
   109   else if File.exists (File.unpack_platform_path (!destdir))
   110   then !destdir ^ "/" ^ !problem_name
   111   else error ("No such directory: " ^ !destdir);
   112 
   113 fun prob_pathname n = probfile_nosuffix n ^ "_" ^ Int.toString n;
   114 
   115 
   116 (*** ATP methods ***)
   117 val vampire_time = ref 60;
   118 val eprover_time = ref 60;
   119 val spass_time = ref 60;
   120 
   121 fun run_vampire time =
   122     if (time >0) then vampire_time:= time
   123     else vampire_time:=60;
   124 
   125 fun run_eprover time =
   126     if (time > 0) then eprover_time:= time
   127     else eprover_time:=60;
   128 
   129 fun run_spass time =
   130     if (time > 0) then spass_time:=time
   131     else spass_time:=60;
   132 
   133 
   134 fun vampireLimit () = !vampire_time;
   135 fun eproverLimit () = !eprover_time;
   136 fun spassLimit () = !spass_time;
   137 
   138 val fol_keep_types = ResClause.keep_types;
   139 val hol_full_types = ResHolClause.full_types;
   140 val hol_partial_types = ResHolClause.partial_types;
   141 val hol_const_types_only = ResHolClause.const_types_only;
   142 val hol_no_types = ResHolClause.no_types;
   143 fun hol_typ_level () = ResHolClause.find_typ_level ();
   144 fun is_typed_hol () =
   145     let val tp_level = hol_typ_level()
   146     in
   147         not (tp_level = ResHolClause.T_NONE)
   148     end;
   149 
   150 fun atp_input_file () =
   151     let val file = !problem_name
   152     in
   153         if !destdir = "" then File.platform_path (File.tmp_path (Path.basic file))
   154         else if File.exists (File.unpack_platform_path (!destdir))
   155         then !destdir ^ "/" ^ file
   156         else error ("No such directory: " ^ !destdir)
   157     end;
   158 
   159 val include_all = ref true;
   160 val include_simpset = ref false;
   161 val include_claset = ref false;
   162 val include_atpset = ref true;
   163 
   164 (*Tests show that follow_defs gives VERY poor results with "include_all"*)
   165 fun add_all() = (include_all:=true; ReduceAxiomsN.follow_defs := false);
   166 fun rm_all() = include_all:=false;
   167 
   168 fun add_simpset() = include_simpset:=true;
   169 fun rm_simpset() = include_simpset:=false;
   170 
   171 fun add_claset() = include_claset:=true;
   172 fun rm_claset() = include_claset:=false;
   173 
   174 fun add_clasimp() = (include_simpset:=true;include_claset:=true);
   175 fun rm_clasimp() = (include_simpset:=false;include_claset:=false);
   176 
   177 fun add_atpset() = include_atpset:=true;
   178 fun rm_atpset() = include_atpset:=false;
   179 
   180 
   181 (**** relevance filter ****)
   182 val run_relevance_filter = ReduceAxiomsN.run_relevance_filter;
   183 val run_blacklist_filter = ref true;
   184 
   185 (******************************************************************)
   186 (* detect whether a given problem (clauses) is FOL/HOL/HOLC/HOLCS *)
   187 (******************************************************************)
   188 
   189 datatype logic = FOL | HOL | HOLC | HOLCS;
   190 
   191 fun string_of_logic FOL = "FOL"
   192   | string_of_logic HOL = "HOL"
   193   | string_of_logic HOLC = "HOLC"
   194   | string_of_logic HOLCS = "HOLCS";
   195 
   196 fun is_fol_logic FOL = true
   197   | is_fol_logic  _ = false
   198 
   199 (*HOLCS will not occur here*)
   200 fun upgrade_lg HOLC _ = HOLC
   201   | upgrade_lg HOL HOLC = HOLC
   202   | upgrade_lg HOL _ = HOL
   203   | upgrade_lg FOL lg = lg;
   204 
   205 (* check types *)
   206 fun has_bool_hfn (Type("bool",_)) = true
   207   | has_bool_hfn (Type("fun",_)) = true
   208   | has_bool_hfn (Type(_, Ts)) = exists has_bool_hfn Ts
   209   | has_bool_hfn _ = false;
   210 
   211 fun is_hol_fn tp =
   212     let val (targs,tr) = strip_type tp
   213     in
   214         exists (has_bool_hfn) (tr::targs)
   215     end;
   216 
   217 fun is_hol_pred tp =
   218     let val (targs,tr) = strip_type tp
   219     in
   220         exists (has_bool_hfn) targs
   221     end;
   222 
   223 exception FN_LG of term;
   224 
   225 fun fn_lg (t as Const(f,tp)) (lg,seen) =
   226     if is_hol_fn tp then (upgrade_lg HOL lg, insert (op =) t seen) else (lg, insert (op =) t seen)
   227   | fn_lg (t as Free(f,tp)) (lg,seen) =
   228     if is_hol_fn tp then (upgrade_lg HOL lg, insert (op =) t seen) else (lg, insert (op =) t seen)
   229   | fn_lg (t as Var(f,tp)) (lg,seen) =
   230     if is_hol_fn tp then (upgrade_lg HOL lg,insert (op =) t seen) else (lg,insert (op =) t seen)
   231   | fn_lg (t as Abs(_,_,_)) (lg,seen) = (upgrade_lg HOLC lg,insert (op =) t seen)
   232   | fn_lg f _ = raise FN_LG(f);
   233 
   234 
   235 fun term_lg [] (lg,seen) = (lg,seen)
   236   | term_lg (tm::tms) (FOL,seen) =
   237       let val (f,args) = strip_comb tm
   238           val (lg',seen') = if f mem seen then (FOL,seen)
   239                             else fn_lg f (FOL,seen)
   240       in
   241         if is_fol_logic lg' then ()
   242         else Output.debug ("Found a HOL term: " ^ Display.raw_string_of_term f);
   243         term_lg (args@tms) (lg',seen')
   244       end
   245   | term_lg _ (lg,seen) = (lg,seen)
   246 
   247 exception PRED_LG of term;
   248 
   249 fun pred_lg (t as Const(P,tp)) (lg,seen)=
   250       if is_hol_pred tp then (upgrade_lg HOL lg, insert (op =) t seen)
   251       else (lg,insert (op =) t seen)
   252   | pred_lg (t as Free(P,tp)) (lg,seen) =
   253       if is_hol_pred tp then (upgrade_lg HOL lg, insert (op =) t seen)
   254       else (lg,insert (op =) t seen)
   255   | pred_lg (t as Var(_,_)) (lg,seen) = (upgrade_lg HOL lg, insert (op =) t seen)
   256   | pred_lg P _ = raise PRED_LG(P);
   257 
   258 
   259 fun lit_lg (Const("Not",_) $ P) (lg,seen) = lit_lg P (lg,seen)
   260   | lit_lg P (lg,seen) =
   261       let val (pred,args) = strip_comb P
   262           val (lg',seen') = if pred mem seen then (lg,seen)
   263                             else pred_lg pred (lg,seen)
   264       in
   265         if is_fol_logic lg' then ()
   266         else Output.debug ("Found a HOL predicate: " ^ Display.raw_string_of_term pred);
   267         term_lg args (lg',seen')
   268       end;
   269 
   270 fun lits_lg [] (lg,seen) = (lg,seen)
   271   | lits_lg (lit::lits) (FOL,seen) =
   272       let val (lg,seen') = lit_lg lit (FOL,seen)
   273       in
   274         if is_fol_logic lg then ()
   275         else Output.debug ("Found a HOL literal: " ^ Display.raw_string_of_term lit);
   276         lits_lg lits (lg,seen')
   277       end
   278   | lits_lg lits (lg,seen) = (lg,seen);
   279 
   280 fun dest_disj_aux (Const("Trueprop",_) $ t) disjs = dest_disj_aux t disjs
   281   | dest_disj_aux (Const ("op |", _) $ t $ t') disjs = dest_disj_aux t (dest_disj_aux t' disjs)
   282   | dest_disj_aux t disjs = t::disjs;
   283 
   284 fun dest_disj t = dest_disj_aux t [];
   285 
   286 fun logic_of_clause tm = lits_lg (dest_disj tm);
   287 
   288 fun logic_of_clauses [] (lg,seen) = (lg,seen)
   289   | logic_of_clauses (cls::clss) (FOL,seen) =
   290     let val (lg,seen') = logic_of_clause cls (FOL,seen)
   291         val _ =
   292           if is_fol_logic lg then ()
   293           else Output.debug ("Found a HOL clause: " ^ Display.raw_string_of_term cls)
   294     in
   295         logic_of_clauses clss (lg,seen')
   296     end
   297   | logic_of_clauses (cls::clss) (lg,seen) = (lg,seen);
   298 
   299 fun problem_logic_goals_aux [] (lg,seen) = lg
   300   | problem_logic_goals_aux (subgoal::subgoals) (lg,seen) =
   301     problem_logic_goals_aux subgoals (logic_of_clauses subgoal (lg,seen));
   302 
   303 fun problem_logic_goals subgoals = problem_logic_goals_aux subgoals (FOL,[]);
   304 
   305 fun is_fol_thms ths = ((fst(logic_of_clauses (map prop_of ths) (FOL,[]))) = FOL);
   306 
   307 (***************************************************************)
   308 (* Retrieving and filtering lemmas                             *)
   309 (***************************************************************)
   310 
   311 (*** white list and black list of lemmas ***)
   312 
   313 (*The rule subsetI is frequently omitted by the relevance filter.*)
   314 val whitelist = ref [subsetI];
   315 
   316 (*Names of theorems (not theorem lists! See multi_blacklist below) to be banned.
   317 
   318   These theorems typically produce clauses that are prolific (match too many equality or
   319   membership literals) and relate to seldom-used facts. Some duplicate other rules.
   320   FIXME: this blacklist needs to be maintained using theory data and added to using
   321   an attribute.*)
   322 val blacklist = ref
   323   ["Datatype.prod.size",
   324    "Divides.dvd_0_left_iff",
   325    "Finite_Set.card_0_eq",
   326    "Finite_Set.card_infinite",
   327    "Finite_Set.Max_ge",
   328    "Finite_Set.Max_in",
   329    "Finite_Set.Max_le_iff",
   330    "Finite_Set.Max_less_iff",
   331    "Finite_Set.max.f_below_strict_below.below_f_conv", (*duplicates in Orderings.*)
   332    "Finite_Set.max.f_below_strict_below.strict_below_f_conv", (*duplicates in Orderings.*)
   333    "Finite_Set.Min_ge_iff",
   334    "Finite_Set.Min_gr_iff",
   335    "Finite_Set.Min_in",
   336    "Finite_Set.Min_le",
   337    "Finite_Set.min.f_below_strict_below.below_f_conv",        (*duplicates in Orderings.*)
   338    "Finite_Set.min.f_below_strict_below.strict_below_f_conv", (*duplicates in Orderings.*)
   339    "Fun.vimage_image_eq",   (*involves an existential quantifier*)
   340    "HOL.split_if_asm",     (*splitting theorem*)
   341    "HOL.split_if",         (*splitting theorem*)
   342    "IntDef.abs_split",
   343    "IntDef.Integ.Abs_Integ_inject",
   344    "IntDef.Integ.Abs_Integ_inverse",
   345    "IntDiv.zdvd_0_left",
   346    "List.append_eq_append_conv",
   347    "List.hd_Cons_tl",   (*Says everything is [] or Cons. Probably prolific.*)
   348    "List.in_listsD",
   349    "List.in_listsI",
   350    "List.lists.Cons",
   351    "List.listsE",
   352    "Nat.less_one", (*not directional? obscure*)
   353    "Nat.not_gr0",
   354    "Nat.one_eq_mult_iff", (*duplicate by symmetry*)
   355    "Nat.of_nat_0_eq_iff",
   356    "Nat.of_nat_eq_0_iff",
   357    "Nat.of_nat_le_0_iff",
   358    "NatSimprocs.divide_le_0_iff_number_of",  (*too many clauses*)
   359    "NatSimprocs.divide_less_0_iff_number_of",
   360    "NatSimprocs.equation_minus_iff_1",  (*not directional*)
   361    "NatSimprocs.equation_minus_iff_number_of", (*not directional*)
   362    "NatSimprocs.le_minus_iff_1", (*not directional*)
   363    "NatSimprocs.le_minus_iff_number_of",  (*not directional*)
   364    "NatSimprocs.less_minus_iff_1", (*not directional*)
   365    "NatSimprocs.less_minus_iff_number_of", (*not directional*)
   366    "NatSimprocs.minus_equation_iff_number_of", (*not directional*)
   367    "NatSimprocs.minus_le_iff_1", (*not directional*)
   368    "NatSimprocs.minus_le_iff_number_of", (*not directional*)
   369    "NatSimprocs.minus_less_iff_1", (*not directional*)
   370    "NatSimprocs.mult_le_cancel_left_number_of", (*excessive case analysis*)
   371    "NatSimprocs.mult_le_cancel_right_number_of", (*excessive case analysis*)
   372    "NatSimprocs.mult_less_cancel_left_number_of", (*excessive case analysis*)
   373    "NatSimprocs.mult_less_cancel_right_number_of", (*excessive case analysis*)
   374    "NatSimprocs.zero_le_divide_iff_number_of", (*excessive case analysis*)
   375    "NatSimprocs.zero_less_divide_iff_number_of",
   376    "OrderedGroup.abs_0_eq", (*duplicate by symmetry*)
   377    "OrderedGroup.diff_eq_0_iff_eq", (*prolific?*)
   378    "OrderedGroup.join_0_eq_0",
   379    "OrderedGroup.meet_0_eq_0",
   380    "OrderedGroup.pprt_eq_0",   (*obscure*)
   381    "OrderedGroup.pprt_eq_id",   (*obscure*)
   382    "OrderedGroup.pprt_mono",   (*obscure*)
   383    "Orderings.split_max",      (*splitting theorem*)
   384    "Orderings.split_min",      (*splitting theorem*)
   385    "Power.zero_less_power_abs_iff",
   386    "Product_Type.split_eta_SetCompr",   (*involves an existential quantifier*)
   387    "Product_Type.split_paired_Ball_Sigma",     (*splitting theorem*)
   388    "Product_Type.split_paired_Bex_Sigma",      (*splitting theorem*)
   389    "Product_Type.split_split_asm",             (*splitting theorem*)
   390    "Product_Type.split_split",                 (*splitting theorem*)
   391    "Product_Type.unit_abs_eta_conv",
   392    "Product_Type.unit_induct",
   393    "Relation.diagI",
   394    "Relation.Domain_def",   (*involves an existential quantifier*)
   395    "Relation.Image_def",   (*involves an existential quantifier*)
   396    "Relation.ImageI",
   397    "Ring_and_Field.divide_cancel_left", (*fields are seldom used & often prolific*)
   398    "Ring_and_Field.divide_cancel_right",
   399    "Ring_and_Field.divide_divide_eq_left",
   400    "Ring_and_Field.divide_divide_eq_right",
   401    "Ring_and_Field.divide_eq_0_iff",
   402    "Ring_and_Field.divide_eq_1_iff",
   403    "Ring_and_Field.divide_eq_eq_1",
   404    "Ring_and_Field.divide_le_0_1_iff",
   405    "Ring_and_Field.divide_le_eq_1_neg",  (*obscure and prolific*)
   406    "Ring_and_Field.divide_le_eq_1_pos",  (*obscure and prolific*)
   407    "Ring_and_Field.divide_less_0_1_iff",
   408    "Ring_and_Field.divide_less_eq_1_neg",  (*obscure and prolific*)
   409    "Ring_and_Field.divide_less_eq_1_pos",  (*obscure and prolific*)
   410    "Ring_and_Field.eq_divide_eq_1", (*duplicate by symmetry*)
   411    "Ring_and_Field.field_mult_cancel_left",
   412    "Ring_and_Field.field_mult_cancel_right",
   413    "Ring_and_Field.inverse_le_iff_le_neg",
   414    "Ring_and_Field.inverse_le_iff_le",
   415    "Ring_and_Field.inverse_less_iff_less_neg",
   416    "Ring_and_Field.inverse_less_iff_less",
   417    "Ring_and_Field.le_divide_eq_1_neg", (*obscure and prolific*)
   418    "Ring_and_Field.le_divide_eq_1_pos", (*obscure and prolific*)
   419    "Ring_and_Field.less_divide_eq_1_neg", (*obscure and prolific*)
   420    "Ring_and_Field.less_divide_eq_1_pos", (*obscure and prolific*)
   421    "Ring_and_Field.one_eq_divide_iff",  (*duplicate by symmetry*)
   422    "Set.Collect_bex_eq",   (*involves an existential quantifier*)
   423    "Set.Collect_ex_eq",   (*involves an existential quantifier*)
   424    "Set.Diff_eq_empty_iff", (*redundant with paramodulation*)
   425    "Set.Diff_insert0",
   426    "Set.empty_Union_conv",   (*redundant with paramodulation*)
   427    "Set.full_SetCompr_eq",   (*involves an existential quantifier*)
   428    "Set.image_Collect",      (*involves an existential quantifier*)
   429    "Set.image_def",          (*involves an existential quantifier*)
   430    "Set.Int_UNIV",  (*redundant with paramodulation*)
   431    "Set.Inter_iff", (*We already have InterI, InterE*)
   432    "Set.psubsetE",    (*too prolific and obscure*)
   433    "Set.psubsetI",
   434    "Set.singleton_insert_inj_eq'",
   435    "Set.singleton_insert_inj_eq",
   436    "Set.singletonD",  (*these two duplicate some "insert" lemmas*)
   437    "Set.singletonI",
   438    "Set.Un_empty", (*redundant with paramodulation*)
   439    "Set.UNION_def",   (*involves an existential quantifier*)
   440    "Set.Union_empty_conv", (*redundant with paramodulation*)
   441    "Set.Union_iff",              (*We already have UnionI, UnionE*)
   442    "SetInterval.atLeastAtMost_iff", (*obscure and prolific*)
   443    "SetInterval.atLeastLessThan_iff", (*obscure and prolific*)
   444    "SetInterval.greaterThanAtMost_iff", (*obscure and prolific*)
   445    "SetInterval.greaterThanLessThan_iff", (*obscure and prolific*)
   446    "SetInterval.ivl_subset"];  (*excessive case analysis*)
   447 
   448 
   449 (*These might be prolific but are probably OK, and min and max are basic.
   450    "Orderings.max_less_iff_conj",
   451    "Orderings.min_less_iff_conj",
   452    "Orderings.min_max.below_inf.below_inf_conv",
   453    "Orderings.min_max.below_sup.above_sup_conv",
   454 Very prolific and somewhat obscure:
   455    "Set.InterD",
   456    "Set.UnionI",
   457 *)
   458 
   459 (*** retrieve lemmas from clasimpset and atpset, may filter them ***)
   460 
   461 (*Hashing to detect duplicate and variant clauses, e.g. from the [iff] attribute*)
   462 
   463 exception HASH_CLAUSE and HASH_STRING;
   464 
   465 (*Reject theorems with names like "List.filter.filter_list_def" or
   466   "Accessible_Part.acc.defs", as these are definitions arising from packages.*)
   467 fun is_package_def a =
   468   let val names = NameSpace.unpack a
   469   in
   470      length names > 2 andalso
   471      not (hd names = "local") andalso
   472      String.isSuffix "_def" a  orelse  String.isSuffix "_defs" a
   473   end;
   474 
   475 fun make_banned_test xs =
   476   let val ht = Polyhash.mkTable (Polyhash.hash_string, op =)
   477                                 (6000, HASH_STRING)
   478       fun banned s =
   479             isSome (Polyhash.peek ht s) orelse is_package_def s
   480   in  app (fn x => Polyhash.insert ht (x,())) (!blacklist);
   481       banned
   482   end;
   483 
   484 (** a hash function from Term.term to int, and also a hash table **)
   485 val xor_words = List.foldl Word.xorb 0w0;
   486 
   487 fun hashw_term ((Const(c,_)), w) = Polyhash.hashw_string (c,w)
   488   | hashw_term ((Free(a,_)), w) = Polyhash.hashw_string (a,w)
   489   | hashw_term ((Var(_,_)), w) = w
   490   | hashw_term ((Bound i), w) = Polyhash.hashw_int(i,w)
   491   | hashw_term ((Abs(_,_,t)), w) = hashw_term (t, w)
   492   | hashw_term ((P$Q), w) = hashw_term (Q, (hashw_term (P, w)));
   493 
   494 fun hash_literal (Const("Not",_)$P) = Word.notb(hashw_term(P,0w0))
   495   | hash_literal P = hashw_term(P,0w0);
   496 
   497 fun hash_term t = Word.toIntX (xor_words (map hash_literal (dest_disj t)));
   498 
   499 fun equal_thm (thm1,thm2) = Term.aconv(prop_of thm1, prop_of thm2);
   500 
   501 (*Create a hash table for clauses, of the given size*)
   502 fun mk_clause_table n =
   503       Polyhash.mkTable (hash_term o prop_of, equal_thm)
   504                        (n, HASH_CLAUSE);
   505 
   506 (*Use a hash table to eliminate duplicates from xs. Argument is a list of
   507   (thm * (string * int)) tuples. The theorems are hashed into the table. *)
   508 fun make_unique xs =
   509   let val ht = mk_clause_table 7000
   510   in
   511       Output.debug("make_unique gets " ^ Int.toString (length xs) ^ " clauses");
   512       app (ignore o Polyhash.peekInsert ht) xs;
   513       Polyhash.listItems ht
   514   end;
   515 
   516 (*Remove existing axiom clauses from the conjecture clauses, as this can dramatically
   517   boost an ATP's performance (for some reason)*)
   518 fun subtract_cls c_clauses ax_clauses =
   519   let val ht = mk_clause_table 2200
   520       fun known x = isSome (Polyhash.peek ht x)
   521   in
   522       app (ignore o Polyhash.peekInsert ht) ax_clauses;
   523       filter (not o known) c_clauses
   524   end;
   525 
   526 (*Filter axiom clauses, but keep supplied clauses and clauses in whitelist.
   527   Duplicates are removed later.*)
   528 fun get_relevant_clauses thy cls_thms white_cls goals =
   529   white_cls @ (ReduceAxiomsN.relevance_filter thy cls_thms goals);
   530 
   531 fun display_thms [] = ()
   532   | display_thms ((name,thm)::nthms) =
   533       let val nthm = name ^ ": " ^ (string_of_thm thm)
   534       in Output.debug nthm; display_thms nthms  end;
   535 
   536 fun all_valid_thms ctxt =
   537   PureThy.thms_containing (ProofContext.theory_of ctxt) ([], []) @
   538   filter (ProofContext.valid_thms ctxt)
   539     (FactIndex.find (ProofContext.fact_index_of ctxt) ([], []));
   540 
   541 fun multi_name a (th, (n,pairs)) =
   542   (n+1, (a ^ "(" ^ Int.toString n ^ ")", th) :: pairs)
   543 
   544 fun add_multi_names_aux ((a, []), pairs) = pairs
   545   | add_multi_names_aux ((a, [th]), pairs) = (a,th)::pairs
   546   | add_multi_names_aux ((a, ths), pairs) = #2 (foldl (multi_name a) (1,pairs) ths);
   547 
   548 val multi_blacklist =
   549   ["Set.ball_simps", "Set.bex_simps",  (*quantifier rewriting: useless*)
   550    "Set.disjoint_insert", "Set.insert_disjoint", "Set.Inter_UNIV_conv"];
   551 
   552 val multi_base_blacklist =
   553   ["defs","select_defs","update_defs","induct","inducts","split","splits","split_asm"];
   554 
   555 (*Ignore blacklisted theorem lists*)
   556 fun add_multi_names ((a, ths), pairs) =
   557   if a mem_string multi_blacklist orelse (Sign.base_name a) mem_string multi_base_blacklist
   558   then pairs
   559   else add_multi_names_aux ((a, ths), pairs);
   560 
   561 fun is_multi (a, ths) = length ths > 1 orelse String.isSuffix ".axioms" a;
   562 
   563 (*The single theorems go BEFORE the multiple ones*)
   564 fun name_thm_pairs ctxt =
   565   let val (mults,singles) = List.partition is_multi (all_valid_thms ctxt)
   566   in  foldl add_multi_names (foldl add_multi_names [] mults) singles  end;
   567 
   568 fun check_named ("",th) = (warning ("No name for theorem " ^ string_of_thm th); false)
   569   | check_named (_,th) = true;
   570 
   571 (* get lemmas from claset, simpset, atpset and extra supplied rules *)
   572 fun get_clasimp_atp_lemmas ctxt user_thms =
   573   let val included_thms =
   574         if !include_all
   575         then (tap (fn ths => Output.debug
   576                      ("Including all " ^ Int.toString (length ths) ^ " theorems"))
   577                   (name_thm_pairs ctxt))
   578         else
   579         let val claset_thms =
   580                 if !include_claset then ResAxioms.claset_rules_of ctxt
   581                 else []
   582             val simpset_thms =
   583                 if !include_simpset then ResAxioms.simpset_rules_of ctxt
   584                 else []
   585             val atpset_thms =
   586                 if !include_atpset then ResAxioms.atpset_rules_of ctxt
   587                 else []
   588             val _ = if !Output.show_debug_msgs
   589                     then (Output.debug "ATP theorems: "; display_thms atpset_thms)
   590                     else ()
   591         in  claset_thms @ simpset_thms @ atpset_thms  end
   592       val user_rules = filter check_named
   593                          (map (ResAxioms.pairname)
   594                            (if null user_thms then !whitelist else user_thms))
   595   in
   596       (filter check_named included_thms, user_rules)
   597   end;
   598 
   599 (*Remove lemmas that are banned from the backlist. Also remove duplicates. *)
   600 fun blacklist_filter ths =
   601   if !run_blacklist_filter then
   602       let val banned = make_banned_test (map #1 ths)
   603           fun ok (a,_) = not (banned a)
   604           val (good,bad) = List.partition ok ths
   605       in  if !Output.show_debug_msgs then
   606              (Output.debug("blacklist filter gets " ^ Int.toString (length ths) ^ " theorems");
   607               Output.debug("filtered: " ^ space_implode ", " (map #1 bad));
   608               Output.debug("...and returns " ^ Int.toString (length good)))
   609           else ();
   610           good 
   611       end
   612   else ths;
   613 
   614 (***************************************************************)
   615 (* Type Classes Present in the Axiom or Conjecture Clauses     *)
   616 (***************************************************************)
   617 
   618 fun setinsert (x,s) = Symtab.update (x,()) s;
   619 
   620 fun add_classes (sorts, cset) = foldl setinsert cset (List.concat sorts);
   621 
   622 (*Remove this trivial type class*)
   623 fun delete_type cset = Symtab.delete_safe "HOL.type" cset;
   624 
   625 fun tvar_classes_of_terms ts =
   626   let val sorts_list = map (map #2 o term_tvars) ts
   627   in  Symtab.keys (delete_type (foldl add_classes Symtab.empty sorts_list))  end;
   628 
   629 fun tfree_classes_of_terms ts =
   630   let val sorts_list = map (map #2 o term_tfrees) ts
   631   in  Symtab.keys (delete_type (foldl add_classes Symtab.empty sorts_list))  end;
   632 
   633 (*fold type constructors*)
   634 fun fold_type_consts f (Type (a, Ts)) x = fold (fold_type_consts f) Ts (f (a,x))
   635   | fold_type_consts f T x = x;
   636 
   637 val add_type_consts_in_type = fold_type_consts setinsert;
   638 
   639 (*Type constructors used to instantiate overloaded constants are the only ones needed.*)
   640 fun add_type_consts_in_term thy =
   641   let val const_typargs = Sign.const_typargs thy
   642       fun add_tcs (Const cT) x = fold add_type_consts_in_type (const_typargs cT) x
   643         | add_tcs (Abs (_, T, u)) x = add_tcs u x
   644         | add_tcs (t $ u) x = add_tcs t (add_tcs u x)
   645         | add_tcs _ x = x
   646   in  add_tcs  end
   647 
   648 fun type_consts_of_terms thy ts =
   649   Symtab.keys (fold (add_type_consts_in_term thy) ts Symtab.empty);
   650 
   651 
   652 (***************************************************************)
   653 (* ATP invocation methods setup                                *)
   654 (***************************************************************)
   655 
   656 fun cnf_hyps_thms ctxt =
   657     let val ths = Assumption.prems_of ctxt
   658     in fold (fold (insert Thm.eq_thm) o ResAxioms.skolem_thm) ths [] end;
   659 
   660 (*Translation mode can be auto-detected, or forced to be first-order or higher-order*)
   661 datatype mode = Auto | Fol | Hol;
   662 
   663 val linkup_logic_mode = ref Auto;
   664 
   665 (*Ensures that no higher-order theorems "leak out"*)
   666 fun restrict_to_logic logic cls =
   667   if is_fol_logic logic then filter (Meson.is_fol_term o prop_of o fst) cls
   668                         else cls;
   669 
   670 (**** Predicates to detect unwanted clauses (prolific or likely to cause unsoundness) ****)
   671 
   672 (** Too general means, positive equality literal with a variable X as one operand,
   673   when X does not occur properly in the other operand. This rules out clearly
   674   inconsistent clauses such as V=a|V=b, though it by no means guarantees soundness. **)
   675 
   676 fun occurs ix =
   677     let fun occ(Var (jx,_)) = (ix=jx)
   678           | occ(t1$t2)      = occ t1 orelse occ t2
   679           | occ(Abs(_,_,t)) = occ t
   680           | occ _           = false
   681     in occ end;
   682 
   683 fun is_recordtype T = not (null (RecordPackage.dest_recTs T));
   684 
   685 (*Unwanted equalities include
   686   (1) those between a variable that does not properly occur in the second operand,
   687   (2) those between a variable and a record, since these seem to be prolific "cases" thms
   688 *)
   689 fun too_general_eqterms (Var (ix,T), t) = not (occurs ix t) orelse is_recordtype T
   690   | too_general_eqterms _ = false;
   691 
   692 fun too_general_equality (Const ("op =", _) $ x $ y) =
   693       too_general_eqterms (x,y) orelse too_general_eqterms(y,x)
   694   | too_general_equality _ = false;
   695 
   696 (* tautologous? *)
   697 fun is_taut (Const ("Trueprop", _) $ Const ("True", _)) = true
   698   | is_taut _ = false;
   699 
   700 (*True if the term contains a variable whose (atomic) type is in the given list.*)
   701 fun has_typed_var tycons =
   702   let fun var_tycon (Var (_, Type(a,_))) = a mem_string tycons
   703         | var_tycon _ = false
   704   in  exists var_tycon o term_vars  end;
   705 
   706 fun unwanted t =
   707     is_taut t orelse has_typed_var ["Product_Type.unit","bool"] t orelse
   708     forall too_general_equality (dest_disj t);
   709 
   710 (*Clauses containing variables of type "unit" or "bool" are unlikely to be useful and
   711   likely to lead to unsound proofs.*)
   712 fun remove_unwanted_clauses cls =
   713   filter (not o unwanted o prop_of o fst) cls;
   714 
   715 fun tptp_writer logic goals filename (axioms,classrels,arities) user_lemmas =
   716     if is_fol_logic logic
   717     then ResClause.tptp_write_file goals filename (axioms, classrels, arities)
   718     else ResHolClause.tptp_write_file goals filename (axioms, classrels, arities) user_lemmas;
   719 
   720 fun dfg_writer logic goals filename (axioms,classrels,arities) user_lemmas =
   721     if is_fol_logic logic
   722     then ResClause.dfg_write_file goals filename (axioms, classrels, arities)
   723     else ResHolClause.dfg_write_file goals filename (axioms, classrels, arities) user_lemmas;
   724 
   725 (*Called by the oracle-based methods declared in res_atp_methods.ML*)
   726 fun write_subgoal_file dfg mode ctxt conjectures user_thms n =
   727     let val conj_cls = make_clauses conjectures
   728                          |> ResAxioms.assume_abstract_list |> Meson.finish_cnf
   729         val hyp_cls = cnf_hyps_thms ctxt
   730         val goal_cls = conj_cls@hyp_cls
   731         val goal_tms = map prop_of goal_cls
   732         val logic = case mode of
   733                             Auto => problem_logic_goals [goal_tms]
   734                           | Fol => FOL
   735                           | Hol => HOL
   736         val (included_thms,user_rules) = get_clasimp_atp_lemmas ctxt user_thms
   737         val cla_simp_atp_clauses = included_thms |> blacklist_filter
   738                                      |> ResAxioms.cnf_rules_pairs |> make_unique
   739                                      |> restrict_to_logic logic
   740                                      |> remove_unwanted_clauses
   741         val user_cls = ResAxioms.cnf_rules_pairs user_rules
   742         val thy = ProofContext.theory_of ctxt
   743         val axclauses = make_unique (get_relevant_clauses thy cla_simp_atp_clauses user_cls goal_tms)
   744         val keep_types = if is_fol_logic logic then !fol_keep_types else is_typed_hol ()
   745         val subs = tfree_classes_of_terms goal_tms
   746         and axtms = map (prop_of o #1) axclauses
   747         val supers = tvar_classes_of_terms axtms
   748         and tycons = type_consts_of_terms thy (goal_tms@axtms)
   749         (*TFrees in conjecture clauses; TVars in axiom clauses*)
   750         val classrel_clauses =
   751               if keep_types then ResClause.make_classrel_clauses thy subs supers
   752               else []
   753         val arity_clauses = if keep_types then ResClause.arity_clause_thy thy tycons supers else []
   754         val writer = if dfg then dfg_writer else tptp_writer
   755         and file = atp_input_file()
   756         and user_lemmas_names = map #1 user_rules
   757     in
   758         writer logic goal_cls file (axclauses,classrel_clauses,arity_clauses) user_lemmas_names;
   759         Output.debug ("Writing to " ^ file);
   760         file
   761     end;
   762 
   763 
   764 (**** remove tmp files ****)
   765 fun cond_rm_tmp file =
   766     if !Output.show_debug_msgs orelse !destdir <> "" then Output.debug "ATP input kept..."
   767     else OS.FileSys.remove file;
   768 
   769 
   770 (****** setup ATPs as Isabelle methods ******)
   771 
   772 fun atp_meth tac ths ctxt =
   773     let val thy = ProofContext.theory_of ctxt
   774         val _ = ResClause.init thy
   775         val _ = ResHolClause.init thy
   776     in Method.SIMPLE_METHOD' (tac ctxt ths) end;
   777 
   778 fun atp_method tac = Method.thms_ctxt_args (atp_meth tac);
   779 
   780 (***************************************************************)
   781 (* automatic ATP invocation                                    *)
   782 (***************************************************************)
   783 
   784 (* call prover with settings and problem file for the current subgoal *)
   785 fun watcher_call_provers sign sg_terms (childin, childout, pid) =
   786   let
   787     fun make_atp_list [] n = []
   788       | make_atp_list (sg_term::xs) n =
   789           let
   790             val probfile = prob_pathname n
   791             val time = Int.toString (!time_limit)
   792           in
   793             Output.debug ("problem file in watcher_call_provers is " ^ probfile);
   794             (*options are separated by Watcher.setting_sep, currently #"%"*)
   795             if !prover = "spass"
   796             then
   797               let val spass = helper_path "SPASS_HOME" "SPASS"
   798                   val sopts =
   799    "-Auto%-SOS=1%-PGiven=0%-PProblem=0%-Splits=0%-FullRed=0%-DocProof%-TimeLimit=" ^ time
   800               in
   801                   ("spass", spass, sopts, probfile) :: make_atp_list xs (n+1)
   802               end
   803             else if !prover = "vampire"
   804             then
   805               let val vampire = helper_path "VAMPIRE_HOME" "vampire"
   806                   val vopts = "--mode casc%-t " ^ time  (*what about -m 100000?*)
   807               in
   808                   ("vampire", vampire, vopts, probfile) :: make_atp_list xs (n+1)
   809               end
   810              else if !prover = "E"
   811              then
   812                let val Eprover = helper_path "E_HOME" "eproof"
   813                in
   814                   ("E", Eprover,
   815                      "--tstp-in%-l5%-xAutoDev%-tAutoDev%--silent%--cpu-limit=" ^ time, probfile) ::
   816                    make_atp_list xs (n+1)
   817                end
   818              else error ("Invalid prover name: " ^ !prover)
   819           end
   820 
   821     val atp_list = make_atp_list sg_terms 1
   822   in
   823     Watcher.callResProvers(childout,atp_list);
   824     Output.debug "Sent commands to watcher!"
   825   end
   826 
   827 fun trace_array fname =
   828   let val path = File.unpack_platform_path fname
   829   in  Array.app (File.append path o (fn s => s ^ "\n"))  end;
   830 
   831 (*Converting a subgoal into negated conjecture clauses*)
   832 fun neg_clauses th n =
   833   let val tacs = [rtac ccontr, ObjectLogic.atomize_tac, skolemize_tac]
   834       val st = Seq.hd (EVERY' tacs n th)
   835       val negs = Option.valOf (metahyps_thms n st)
   836   in make_clauses negs |> ResAxioms.assume_abstract_list |> Meson.finish_cnf end;
   837 
   838 (*We write out problem files for each subgoal. Argument probfile generates filenames,
   839   and allows the suppression of the suffix "_1" in problem-generation mode.
   840   FIXME: does not cope with &&, and it isn't easy because one could have multiple
   841   subgoals, each involving &&.*)
   842 fun write_problem_files probfile (ctxt,th)  =
   843   let val goals = Thm.prems_of th
   844       val _ = Output.debug ("number of subgoals = " ^ Int.toString (length goals))
   845       val thy = ProofContext.theory_of ctxt
   846       fun get_neg_subgoals [] _ = []
   847         | get_neg_subgoals (gl::gls) n = neg_clauses th n :: get_neg_subgoals gls (n+1)
   848       val goal_cls = get_neg_subgoals goals 1
   849       val logic = case !linkup_logic_mode of
   850                 Auto => problem_logic_goals (map ((map prop_of)) goal_cls)
   851               | Fol => FOL
   852               | Hol => HOL
   853       val (included_thms,white_thms) = get_clasimp_atp_lemmas ctxt []
   854       val included_cls = included_thms |> blacklist_filter
   855                                        |> ResAxioms.cnf_rules_pairs |> make_unique
   856                                        |> restrict_to_logic logic
   857                                        |> remove_unwanted_clauses
   858       val _ = Output.debug ("included clauses = " ^ Int.toString(length included_cls))
   859       val white_cls = ResAxioms.cnf_rules_pairs white_thms
   860       (*clauses relevant to goal gl*)
   861       val axcls_list = map (fn ngcls => get_relevant_clauses thy included_cls white_cls (map prop_of ngcls)) goal_cls
   862       val _ = app (fn axcls => Output.debug ("filtered clauses = " ^ Int.toString(length axcls)))
   863                   axcls_list
   864       val keep_types = if is_fol_logic logic then !ResClause.keep_types
   865                        else is_typed_hol ()
   866       val writer = if !prover = "spass" then dfg_writer else tptp_writer
   867       fun write_all [] [] _ = []
   868         | write_all (ccls::ccls_list) (axcls::axcls_list) k =
   869             let val fname = probfile k
   870                 val axcls = make_unique axcls
   871                 val ccls = subtract_cls ccls axcls
   872                 val ccltms = map prop_of ccls
   873                 and axtms = map (prop_of o #1) axcls
   874                 val subs = tfree_classes_of_terms ccltms
   875                 and supers = tvar_classes_of_terms axtms
   876                 and tycons = type_consts_of_terms thy (ccltms@axtms)
   877                 (*TFrees in conjecture clauses; TVars in axiom clauses*)
   878                 val classrel_clauses =
   879                       if keep_types then ResClause.make_classrel_clauses thy subs supers
   880                       else []
   881                 val _ = Output.debug ("classrel clauses = " ^ Int.toString (length classrel_clauses))
   882                 val arity_clauses = if keep_types then ResClause.arity_clause_thy thy tycons supers
   883                                     else []
   884                 val _ = Output.debug ("arity clauses = " ^ Int.toString (length arity_clauses))
   885                 val clnames = writer logic ccls fname (axcls,classrel_clauses,arity_clauses) []
   886                 val thm_names = Array.fromList clnames
   887                 val _ = if !Output.show_debug_msgs
   888                         then trace_array (fname ^ "_thm_names") thm_names else ()
   889             in  (thm_names,fname) :: write_all ccls_list axcls_list (k+1)  end
   890       val (thm_names_list, filenames) = ListPair.unzip (write_all goal_cls axcls_list 1)
   891   in
   892       (filenames, thm_names_list)
   893   end;
   894 
   895 val last_watcher_pid = ref (NONE : (TextIO.instream * TextIO.outstream *
   896                                     Posix.Process.pid * string list) option);
   897 
   898 fun kill_last_watcher () =
   899     (case !last_watcher_pid of
   900          NONE => ()
   901        | SOME (_, _, pid, files) =>
   902           (Output.debug ("Killing old watcher, pid = " ^ string_of_pid pid);
   903            Watcher.killWatcher pid;
   904            ignore (map (try cond_rm_tmp) files)))
   905      handle OS.SysErr _ => Output.debug "Attempt to kill watcher failed";
   906 
   907 (*writes out the current clasimpset to a tptp file;
   908   turns off xsymbol at start of function, restoring it at end    *)
   909 fun isar_atp_body (ctxt, th) =
   910   if Thm.no_prems th then ()
   911   else
   912     let
   913       val _ = kill_last_watcher()
   914       val (files,thm_names_list) = write_problem_files prob_pathname (ctxt,th)
   915       val (childin, childout, pid) = Watcher.createWatcher (th, thm_names_list)
   916     in
   917       last_watcher_pid := SOME (childin, childout, pid, files);
   918       Output.debug ("problem files: " ^ space_implode ", " files);
   919       Output.debug ("pid: " ^ string_of_pid pid);
   920       watcher_call_provers (sign_of_thm th) (Thm.prems_of th) (childin, childout, pid)
   921     end;
   922 
   923 val isar_atp = setmp print_mode [] isar_atp_body;
   924 
   925 (*For ML scripts, and primarily, for debugging*)
   926 fun callatp () =
   927   let val th = topthm()
   928       val ctxt = ProofContext.init (theory_of_thm th)
   929   in  isar_atp_body (ctxt, th)  end;
   930 
   931 val isar_atp_writeonly = setmp print_mode []
   932       (fn (ctxt,th) =>
   933        if Thm.no_prems th then ()
   934        else
   935          let val probfile = if Thm.nprems_of th = 1 then probfile_nosuffix
   936                             else prob_pathname
   937          in ignore (write_problem_files probfile (ctxt,th)) end);
   938 
   939 
   940 (** the Isar toplevel hook **)
   941 
   942 fun invoke_atp_ml (ctxt, goal) =
   943   let val thy = ProofContext.theory_of ctxt;
   944   in
   945     Output.debug ("subgoals in isar_atp:\n" ^
   946                   Pretty.string_of (ProofContext.pretty_term ctxt
   947                     (Logic.mk_conjunction_list (Thm.prems_of goal))));
   948     Output.debug ("current theory: " ^ Context.theory_name thy);
   949     inc hook_count;
   950     Output.debug ("in hook for time: " ^ Int.toString (!hook_count));
   951     ResClause.init thy;
   952     ResHolClause.init thy;
   953     if !time_limit > 0 then isar_atp (ctxt, goal)
   954     else (warning "Writing problem file only"; isar_atp_writeonly (ctxt, goal))
   955   end;
   956 
   957 val invoke_atp = Toplevel.no_timing o Toplevel.unknown_proof o Toplevel.keep
   958  (fn state =>
   959   let val (ctxt, (_, goal)) = Proof.get_goal (Toplevel.proof_of state)
   960   in  invoke_atp_ml (ctxt, goal)  end);
   961 
   962 val call_atpP =
   963   OuterSyntax.command
   964     "ProofGeneral.call_atp"
   965     "call automatic theorem provers"
   966     OuterKeyword.diag
   967     (Scan.succeed invoke_atp);
   968 
   969 val _ = OuterSyntax.add_parsers [call_atpP];
   970 
   971 end;