src/HOL/Tools/res_atp.ML
author paulson
Mon May 29 17:38:30 2006 +0200 (2006-05-29 ago)
changeset 19746 9ac97dc14214
parent 19744 73aab222fecb
child 19768 9afd9b9c47d0
permissions -rw-r--r--
warnings to debug outputs
     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 signature RES_ATP =
     9 sig
    10   val prover: string ref
    11   val custom_spass: string list ref
    12   val destdir: string ref
    13   val helper_path: string -> string -> string
    14   val problem_name: string ref
    15   val time_limit: int ref
    16    
    17   datatype mode = Auto | Fol | Hol
    18   val linkup_logic_mode : mode ref
    19   val write_subgoal_file: bool -> mode -> Proof.context -> thm list -> thm list -> int -> string
    20   val vampire_time: int ref
    21   val eprover_time: int ref
    22   val spass_time: int ref
    23   val run_vampire: int -> unit
    24   val run_eprover: int -> unit
    25   val run_spass: int -> unit
    26   val vampireLimit: unit -> int
    27   val eproverLimit: unit -> int
    28   val spassLimit: unit -> int
    29   val atp_method: (ProofContext.context -> thm list -> int -> Tactical.tactic) ->
    30 		  Method.src -> ProofContext.context -> Method.method
    31   val cond_rm_tmp: string -> unit
    32   val keep_atp_input: bool ref
    33   val fol_keep_types: bool ref
    34   val hol_full_types: unit -> unit
    35   val hol_partial_types: unit -> unit
    36   val hol_const_types_only: unit -> unit
    37   val hol_no_types: unit -> unit
    38   val hol_typ_level: unit -> ResHolClause.type_level
    39   val run_relevance_filter: bool ref
    40   val invoke_atp_ml : ProofContext.context * thm -> unit
    41   val add_claset : unit -> unit
    42   val add_simpset : unit -> unit
    43   val add_clasimp : unit -> unit
    44   val add_atpset : unit -> unit
    45   val rm_claset : unit -> unit
    46   val rm_simpset : unit -> unit
    47   val rm_atpset : unit -> unit
    48   val rm_clasimp : unit -> unit
    49 end;
    50 
    51 structure ResAtp : RES_ATP =
    52 struct
    53 
    54 (********************************************************************)
    55 (* some settings for both background automatic ATP calling procedure*)
    56 (* and also explicit ATP invocation methods                         *)
    57 (********************************************************************)
    58 
    59 (*** background linkup ***)
    60 val call_atp = ref false; 
    61 val hook_count = ref 0;
    62 val time_limit = ref 30;
    63 val prover = ref "E";   (* use E as the default prover *)
    64 val custom_spass =   (*specialized options for SPASS*)
    65       ref ["-Auto=0","-FullRed=0","-IORe","-IOFc","-RTaut","-RFSub","-RBSub"];
    66 val destdir = ref "";   (*Empty means write files to /tmp*)
    67 val problem_name = ref "prob";
    68 
    69 (*Return the path to a "helper" like SPASS or tptp2X, first checking that
    70   it exists.  FIXME: modify to use Path primitives and move to some central place.*)  
    71 fun helper_path evar base =
    72   case getenv evar of
    73       "" => error  ("Isabelle environment variable " ^ evar ^ " not defined")
    74     | home => 
    75         let val path = home ^ "/" ^ base
    76         in  if File.exists (File.unpack_platform_path path) then path 
    77 	    else error ("Could not find the file " ^ path)
    78 	end;  
    79 
    80 fun probfile_nosuffix _ = 
    81   if !destdir = "" then File.platform_path (File.tmp_path (Path.basic (!problem_name)))
    82   else if File.exists (File.unpack_platform_path (!destdir))
    83   then !destdir ^ "/" ^ !problem_name
    84   else error ("No such directory: " ^ !destdir);
    85 
    86 fun prob_pathname n = probfile_nosuffix n ^ "_" ^ Int.toString n;
    87 
    88 
    89 (*** ATP methods ***)
    90 val vampire_time = ref 60;
    91 val eprover_time = ref 60;
    92 val spass_time = ref 60;
    93 
    94 fun run_vampire time =  
    95     if (time >0) then vampire_time:= time
    96     else vampire_time:=60;
    97 
    98 fun run_eprover time = 
    99     if (time > 0) then eprover_time:= time
   100     else eprover_time:=60;
   101 
   102 fun run_spass time = 
   103     if (time > 0) then spass_time:=time
   104     else spass_time:=60;
   105 
   106 
   107 fun vampireLimit () = !vampire_time;
   108 fun eproverLimit () = !eprover_time;
   109 fun spassLimit () = !spass_time;
   110 
   111 val keep_atp_input = ref false;
   112 val fol_keep_types = ResClause.keep_types;
   113 val hol_full_types = ResHolClause.full_types;
   114 val hol_partial_types = ResHolClause.partial_types;
   115 val hol_const_types_only = ResHolClause.const_types_only;
   116 val hol_no_types = ResHolClause.no_types;
   117 fun hol_typ_level () = ResHolClause.find_typ_level ();
   118 fun is_typed_hol () = 
   119     let val tp_level = hol_typ_level()
   120     in
   121 	not (tp_level = ResHolClause.T_NONE)
   122     end;
   123 val include_combS = ResHolClause.include_combS;
   124 val include_min_comb = ResHolClause.include_min_comb;
   125 
   126 fun atp_input_file () =
   127     let val file = !problem_name 
   128     in
   129 	if !destdir = "" then File.platform_path (File.tmp_path (Path.basic file))
   130 	else if File.exists (File.unpack_platform_path (!destdir))
   131 	then !destdir ^ "/" ^ file
   132 	else error ("No such directory: " ^ !destdir)
   133     end;
   134 
   135 val include_simpset = ref false;
   136 val include_claset = ref false; 
   137 val include_atpset = ref true;
   138 val add_simpset = (fn () => include_simpset:=true);
   139 val add_claset = (fn () => include_claset:=true);
   140 val add_clasimp = (fn () => (include_simpset:=true;include_claset:=true));
   141 val add_atpset = (fn () => include_atpset:=true);
   142 val rm_simpset = (fn () => include_simpset:=false);
   143 val rm_claset = (fn () => include_claset:=false);
   144 val rm_clasimp = (fn () => (include_simpset:=false;include_claset:=false));
   145 val rm_atpset = (fn () => include_atpset:=false);
   146 
   147 
   148 (**** relevance filter ****)
   149 val run_relevance_filter = ref true;
   150 
   151 (******************************************************************)
   152 (* detect whether a given problem (clauses) is FOL/HOL/HOLC/HOLCS *)
   153 (******************************************************************)
   154 
   155 datatype logic = FOL | HOL | HOLC | HOLCS;
   156 
   157 fun string_of_logic FOL = "FOL"
   158   | string_of_logic HOL = "HOL"
   159   | string_of_logic HOLC = "HOLC"
   160   | string_of_logic HOLCS = "HOLCS";
   161 
   162 
   163 fun is_fol_logic FOL = true
   164   | is_fol_logic  _ = false
   165 
   166 
   167 (*HOLCS will not occur here*)
   168 fun upgrade_lg HOLC _ = HOLC
   169   | upgrade_lg HOL HOLC = HOLC
   170   | upgrade_lg HOL _ = HOL
   171   | upgrade_lg FOL lg = lg; 
   172 
   173 (* check types *)
   174 fun has_bool_hfn (Type("bool",_)) = true
   175   | has_bool_hfn (Type("fun",_)) = true
   176   | has_bool_hfn (Type(_, Ts)) = exists has_bool_hfn Ts
   177   | has_bool_hfn _ = false;
   178 
   179 fun is_hol_fn tp =
   180     let val (targs,tr) = strip_type tp
   181     in
   182 	exists (has_bool_hfn) (tr::targs)
   183     end;
   184 
   185 fun is_hol_pred tp =
   186     let val (targs,tr) = strip_type tp
   187     in
   188 	exists (has_bool_hfn) targs
   189     end;
   190 
   191 exception FN_LG of term;
   192 
   193 fun fn_lg (t as Const(f,tp)) (lg,seen) = 
   194     if is_hol_fn tp then (upgrade_lg HOL lg, t ins seen) else (lg, t ins seen) 
   195   | fn_lg (t as Free(f,tp)) (lg,seen) = 
   196     if is_hol_fn tp then (upgrade_lg HOL lg, t ins seen) else (lg, t ins seen) 
   197   | fn_lg (t as Var(f,tp)) (lg,seen) =
   198     if is_hol_fn tp then (upgrade_lg HOL lg,t ins seen) else (lg,t ins seen)
   199   | fn_lg (t as Abs(_,_,_)) (lg,seen) = (upgrade_lg HOLC lg,t ins seen)
   200   | fn_lg f _ = raise FN_LG(f); 
   201 
   202 
   203 fun term_lg [] (lg,seen) = (lg,seen)
   204   | term_lg (tm::tms) (FOL,seen) =
   205     let val (f,args) = strip_comb tm
   206 	val (lg',seen') = if f mem seen then (FOL,seen) 
   207 			  else fn_lg f (FOL,seen)
   208 	val _ =
   209           if is_fol_logic lg' then ()
   210           else Output.debug ("Found a HOL term: " ^ Display.raw_string_of_term f)
   211 	 in
   212 	     term_lg (args@tms) (lg',seen')
   213     end
   214   | term_lg _ (lg,seen) = (lg,seen)
   215 
   216 exception PRED_LG of term;
   217 
   218 fun pred_lg (t as Const(P,tp)) (lg,seen)= 
   219     if is_hol_pred tp then (upgrade_lg HOL lg, t ins seen) else (lg,t ins seen) 
   220   | pred_lg (t as Free(P,tp)) (lg,seen) =
   221     if is_hol_pred tp then (upgrade_lg HOL lg, t ins seen) else (lg,t ins seen)
   222   | pred_lg (t as Var(_,_)) (lg,seen) = (upgrade_lg HOL lg, t ins seen)
   223   | pred_lg P _ = raise PRED_LG(P);
   224 
   225 
   226 fun lit_lg (Const("Not",_) $ P) (lg,seen) = lit_lg P (lg,seen)
   227   | lit_lg P (lg,seen) =
   228     let val (pred,args) = strip_comb P
   229 	val (lg',seen') = if pred mem seen then (lg,seen) 
   230 			  else pred_lg pred (lg,seen)
   231 	val _ =
   232           if is_fol_logic lg' then ()
   233           else Output.debug ("Found a HOL predicate: " ^ Display.raw_string_of_term pred)
   234     in
   235 	term_lg args (lg',seen')
   236     end;
   237 
   238 fun lits_lg [] (lg,seen) = (lg,seen)
   239   | lits_lg (lit::lits) (FOL,seen) =
   240     let val (lg,seen') = lit_lg lit (FOL,seen)
   241 	val _ =
   242           if is_fol_logic lg then ()
   243           else Output.debug ("Found a HOL literal: " ^ Display.raw_string_of_term lit)
   244     in
   245 	lits_lg lits (lg,seen')
   246     end
   247   | lits_lg lits (lg,seen) = (lg,seen);
   248 
   249 
   250 fun dest_disj_aux (Const ("op |", _) $ t $ t') disjs = 
   251     dest_disj_aux t (dest_disj_aux t' disjs)
   252   | dest_disj_aux t disjs = t::disjs;
   253 
   254 fun dest_disj t = dest_disj_aux t [];
   255 
   256 fun logic_of_clause tm (lg,seen) =
   257     let val tm' = HOLogic.dest_Trueprop tm
   258 	val disjs = dest_disj tm'
   259     in
   260 	lits_lg disjs (lg,seen)
   261     end;
   262 
   263 fun logic_of_clauses [] (lg,seen) = (lg,seen)
   264   | logic_of_clauses (cls::clss) (FOL,seen) =
   265     let val (lg,seen') = logic_of_clause cls (FOL,seen)
   266 	val _ =
   267           if is_fol_logic lg then ()
   268           else Output.debug ("Found a HOL clause: " ^ Display.raw_string_of_term cls)
   269     in
   270 	logic_of_clauses clss (lg,seen')
   271     end
   272   | logic_of_clauses (cls::clss) (lg,seen) = (lg,seen);
   273 
   274 fun problem_logic_goals_aux [] (lg,seen) = lg
   275   | problem_logic_goals_aux (subgoal::subgoals) (lg,seen) = 
   276     problem_logic_goals_aux subgoals (logic_of_clauses subgoal (lg,seen));
   277     
   278 fun problem_logic_goals subgoals = problem_logic_goals_aux subgoals (FOL,[]);
   279 
   280 
   281 (***************************************************************)
   282 (* ATP invocation methods setup                                *)
   283 (***************************************************************)
   284 
   285 
   286 (**** prover-specific format: TPTP ****)
   287 
   288 
   289 fun cnf_hyps_thms ctxt = 
   290     let val ths = ProofContext.prems_of ctxt
   291     in fold (fold (insert Thm.eq_thm) o ResAxioms.skolem_thm) ths [] end;
   292 
   293 
   294 (**** write to files ****)
   295 
   296 datatype mode = Auto | Fol | Hol;
   297 
   298 val linkup_logic_mode = ref Auto;
   299 
   300 fun tptp_writer logic goals filename (axioms,classrels,arities) =
   301     if is_fol_logic logic 
   302     then ResClause.tptp_write_file goals filename (axioms, classrels, arities)
   303     else ResHolClause.tptp_write_file goals filename (axioms, classrels, arities);
   304 
   305 fun dfg_writer logic goals filename (axioms,classrels,arities) =
   306     if is_fol_logic logic 
   307     then ResClause.dfg_write_file goals filename (axioms, classrels, arities)
   308     else ResHolClause.dfg_write_file goals filename (axioms, classrels, arities);
   309 
   310 
   311 fun write_subgoal_file dfg mode ctxt conjectures user_thms n =
   312     let val conj_cls = make_clauses conjectures 
   313 	val hyp_cls = cnf_hyps_thms ctxt
   314 	val goal_cls = conj_cls@hyp_cls
   315 	val user_rules = map ResAxioms.pairname user_thms
   316 	val axclauses_as_thms = ResClasimp.get_clasimp_atp_lemmas ctxt (map prop_of goal_cls) user_rules (!include_claset,!include_simpset,!include_atpset) (!run_relevance_filter)  
   317 	val thy = ProofContext.theory_of ctxt
   318 	val prob_logic = case mode of Auto => problem_logic_goals [map prop_of goal_cls]
   319 				    | Fol => FOL
   320 				    | Hol => HOL
   321 	val keep_types = if is_fol_logic prob_logic then !fol_keep_types else is_typed_hol ()
   322 	val classrel_clauses = if keep_types then ResClause.classrel_clauses_thy thy else []
   323 	val arity_clauses = if keep_types then ResClause.arity_clause_thy thy else []
   324         val writer = if dfg then dfg_writer else tptp_writer 
   325 	val file = atp_input_file()
   326     in
   327 	(writer prob_logic goal_cls file (axclauses_as_thms,classrel_clauses,arity_clauses);
   328 	 Output.debug ("Writing to " ^ file);
   329 	 file)
   330     end;
   331 
   332 
   333 (**** remove tmp files ****)
   334 fun cond_rm_tmp file = 
   335     if !keep_atp_input then Output.debug "ATP input kept..." 
   336     else if !destdir <> "" then Output.debug ("ATP input kept in directory " ^ (!destdir))
   337     else (Output.debug "deleting ATP inputs..."; OS.FileSys.remove file);
   338 
   339 
   340 (****** setup ATPs as Isabelle methods ******)
   341 fun atp_meth' tac ths ctxt = 
   342     Method.SIMPLE_METHOD' HEADGOAL
   343     (tac ctxt ths);
   344 
   345 fun atp_meth tac ths ctxt = 
   346     let val thy = ProofContext.theory_of ctxt
   347 	val _ = ResClause.init thy
   348 	val _ = ResHolClause.init thy
   349     in
   350 	atp_meth' tac ths ctxt
   351     end;
   352 
   353 fun atp_method tac = Method.thms_ctxt_args (atp_meth tac);
   354 
   355 (***************************************************************)
   356 (* automatic ATP invocation                                    *)
   357 (***************************************************************)
   358 
   359 (* call prover with settings and problem file for the current subgoal *)
   360 fun watcher_call_provers sign sg_terms (childin, childout, pid) =
   361   let
   362     fun make_atp_list [] n = []
   363       | make_atp_list (sg_term::xs) n =
   364           let
   365             val probfile = prob_pathname n
   366             val time = Int.toString (!time_limit)
   367           in
   368             Output.debug ("problem file in watcher_call_provers is " ^ probfile);
   369             (*options are separated by Watcher.setting_sep, currently #"%"*)
   370             if !prover = "spass"
   371             then
   372               let val spass = helper_path "SPASS_HOME" "SPASS"
   373                   val sopts =
   374    "-Auto%-SOS=1%-PGiven=0%-PProblem=0%-Splits=0%-FullRed=0%-DocProof%-TimeLimit=" ^ time
   375               in 
   376                   ("spass", spass, sopts, probfile) :: make_atp_list xs (n+1)
   377               end
   378             else if !prover = "vampire"
   379 	    then 
   380               let val vampire = helper_path "VAMPIRE_HOME" "vampire"
   381                   val casc = if !time_limit > 70 then "--mode casc%" else ""
   382                   val vopts = casc ^ "-m 100000%-t " ^ time
   383               in
   384                   ("vampire", vampire, vopts, probfile) :: make_atp_list xs (n+1)
   385               end
   386       	     else if !prover = "E"
   387       	     then
   388 	       let val Eprover = helper_path "E_HOME" "eproof"
   389 	       in
   390 		  ("E", Eprover, 
   391 		     "--tptp-in%-l5%-xAuto%-tAuto%--silent%--cpu-limit=" ^ time, probfile) ::
   392 		   make_atp_list xs (n+1)
   393 	       end
   394 	     else error ("Invalid prover name: " ^ !prover)
   395           end
   396 
   397     val atp_list = make_atp_list sg_terms 1
   398   in
   399     Watcher.callResProvers(childout,atp_list);
   400     Output.debug "Sent commands to watcher!"
   401   end
   402 
   403 (*We write out problem files for each subgoal. Argument pf generates filenames,
   404   and allows the suppression of the suffix "_1" in problem-generation mode.
   405   FIXME: does not cope with &&, and it isn't easy because one could have multiple
   406   subgoals, each involving &&.*)
   407 fun write_problem_files pf (ctxt,th)  =
   408   let val goals = Thm.prems_of th
   409       val _ = Output.debug ("number of subgoals = " ^ Int.toString (length goals))
   410       val axclauses = ResClasimp.get_clasimp_atp_lemmas ctxt goals [] (true,true,true) (!run_relevance_filter) (* no user supplied rules here, because no user invocation *)
   411       val _ = Output.debug ("claset, simprules and atprules total clauses = " ^ 
   412                      Int.toString (length axclauses))
   413       val thy = ProofContext.theory_of ctxt
   414       fun get_neg_subgoals n =
   415 	  if n=0 then []
   416 	  else
   417 	      let val st = Seq.hd (EVERY'
   418 				       [rtac ccontr, ObjectLogic.atomize_tac, skolemize_tac] n th)
   419 		  val negs = Option.valOf (metahyps_thms n st)
   420 		  val negs_clauses = make_clauses negs
   421 	      in
   422 		  negs_clauses::(get_neg_subgoals (n - 1))
   423 	      end
   424       val neg_subgoals = get_neg_subgoals (length goals) 
   425       val goals_logic = case !linkup_logic_mode of Auto => problem_logic_goals (map (map prop_of) neg_subgoals)
   426 						 | Fol => FOL
   427 						 | Hol => HOL
   428       val keep_types = if is_fol_logic goals_logic then !ResClause.keep_types else is_typed_hol ()
   429       val classrel_clauses = if keep_types then ResClause.classrel_clauses_thy thy else []
   430       val _ = Output.debug ("classrel clauses = " ^ Int.toString (length classrel_clauses))
   431       val arity_clauses = if keep_types then ResClause.arity_clause_thy thy else []
   432       val _ = Output.debug ("arity clauses = " ^ Int.toString (length arity_clauses))
   433       val writer = if !prover = "spass" then dfg_writer else tptp_writer 
   434       fun write_all [] _ = []
   435 	| write_all (subgoal::subgoals) k =
   436 	  (writer goals_logic subgoal (pf k) (axclauses,classrel_clauses,arity_clauses); pf k):: (write_all subgoals (k - 1))
   437       val thm_names = Array.fromList (map (#1 o #2) axclauses)
   438   in
   439       (write_all neg_subgoals (length goals), thm_names)
   440   end;
   441 
   442 val last_watcher_pid = ref (NONE : (TextIO.instream * TextIO.outstream * 
   443                                     Posix.Process.pid * string list) option);
   444 
   445 fun kill_last_watcher () =
   446     (case !last_watcher_pid of 
   447          NONE => ()
   448        | SOME (_, _, pid, files) => 
   449 	  (Output.debug ("Killing old watcher, pid = " ^ string_of_pid pid);
   450 	   Watcher.killWatcher pid;  
   451 	   ignore (map (try OS.FileSys.remove) files)))
   452      handle OS.SysErr _ => Output.debug "Attempt to kill watcher failed";
   453 
   454 (*writes out the current clasimpset to a tptp file;
   455   turns off xsymbol at start of function, restoring it at end    *)
   456 val isar_atp = setmp print_mode [] 
   457  (fn (ctxt, th) =>
   458   if Thm.no_prems th then ()
   459   else
   460     let
   461       val _ = kill_last_watcher()
   462       val (files,thm_names) = write_problem_files prob_pathname (ctxt,th)
   463       val (childin, childout, pid) = Watcher.createWatcher (th, thm_names)
   464     in
   465       last_watcher_pid := SOME (childin, childout, pid, files);
   466       Output.debug ("problem files: " ^ space_implode ", " files); 
   467       Output.debug ("pid: " ^ string_of_pid pid);
   468       watcher_call_provers (sign_of_thm th) (Thm.prems_of th) (childin, childout, pid)
   469     end);
   470 
   471 val isar_atp_writeonly = setmp print_mode [] 
   472       (fn (ctxt,th) =>
   473        if Thm.no_prems th then ()
   474        else 
   475          let val pf = if Thm.nprems_of th = 1 then probfile_nosuffix 
   476          	      else prob_pathname
   477          in ignore (write_problem_files pf (ctxt,th)) end);
   478 
   479 
   480 (** the Isar toplevel hook **)
   481 
   482 fun invoke_atp_ml (ctxt, goal) =
   483   let val thy = ProofContext.theory_of ctxt;
   484   in
   485     Output.debug ("subgoals in isar_atp:\n" ^ 
   486 		  Pretty.string_of (ProofContext.pretty_term ctxt
   487 		    (Logic.mk_conjunction_list (Thm.prems_of goal))));
   488     Output.debug ("current theory: " ^ Context.theory_name thy);
   489     hook_count := !hook_count +1;
   490     Output.debug ("in hook for time: " ^ Int.toString (!hook_count));
   491     ResClause.init thy;
   492     ResHolClause.init thy;
   493     if !destdir = "" andalso !time_limit > 0 then isar_atp (ctxt, goal)
   494     else isar_atp_writeonly (ctxt, goal)
   495   end;
   496 
   497 val invoke_atp = Toplevel.no_timing o Toplevel.unknown_proof o Toplevel.keep
   498  (fn state =>
   499   let val (ctxt, (_, goal)) = Proof.get_goal (Toplevel.proof_of state)
   500   in  invoke_atp_ml (ctxt, goal)  end);
   501 
   502 val call_atpP =
   503   OuterSyntax.command 
   504     "ProofGeneral.call_atp" 
   505     "call automatic theorem provers" 
   506     OuterKeyword.diag
   507     (Scan.succeed invoke_atp);
   508 
   509 val _ = OuterSyntax.add_parsers [call_atpP];
   510 
   511 end;