src/HOL/Tools/Quickcheck/narrowing_generators.ML
author bulwahn
Tue Jun 14 08:30:19 2011 +0200 (2011-06-14)
changeset 43379 8c4b383e5143
parent 43329 84472e198515
child 43585 ea959ab7bbe3
permissions -rw-r--r--
quickcheck_narrowing returns some timing information
     1 (*  Title:      HOL/Tools/Quickcheck/narrowing_generators.ML
     2     Author:     Lukas Bulwahn, TU Muenchen
     3 
     4 Narrowing-based counterexample generation.
     5 *)
     6 
     7 signature NARROWING_GENERATORS =
     8 sig
     9   val allow_existentials : bool Config.T
    10   val finite_functions : bool Config.T
    11   val overlord : bool Config.T
    12   val test_term: Proof.context -> bool * bool -> term * term list -> Quickcheck.result
    13   datatype counterexample = Universal_Counterexample of (term * counterexample)
    14     | Existential_Counterexample of (term * counterexample) list
    15     | Empty_Assignment
    16   val put_counterexample: (unit -> term list option) -> Proof.context -> Proof.context
    17   val put_existential_counterexample : (unit -> counterexample option) -> Proof.context -> Proof.context
    18   val setup: theory -> theory
    19 end;
    20 
    21 structure Narrowing_Generators : NARROWING_GENERATORS =
    22 struct
    23 
    24 (* configurations *)
    25 
    26 val allow_existentials = Attrib.setup_config_bool @{binding quickcheck_allow_existentials} (K true)
    27 val finite_functions = Attrib.setup_config_bool @{binding quickcheck_finite_functions} (K true)
    28 val overlord = Attrib.setup_config_bool @{binding quickcheck_narrowing_overlord} (K false)
    29 
    30 (* partial_term_of instances *)
    31 
    32 fun mk_partial_term_of (x, T) =
    33   Const (@{const_name Quickcheck_Narrowing.partial_term_of_class.partial_term_of},
    34     Term.itselfT T --> @{typ narrowing_term} --> @{typ Code_Evaluation.term})
    35       $ Const ("TYPE", Term.itselfT T) $ x
    36 
    37 (** formal definition **)
    38 
    39 fun add_partial_term_of tyco raw_vs thy =
    40   let
    41     val vs = map (fn (v, _) => (v, @{sort typerep})) raw_vs;
    42     val ty = Type (tyco, map TFree vs);
    43     val lhs = Const (@{const_name partial_term_of},
    44         Term.itselfT ty --> @{typ narrowing_term} --> @{typ Code_Evaluation.term})
    45       $ Free ("x", Term.itselfT ty) $ Free ("t", @{typ narrowing_term});
    46     val rhs = @{term "undefined :: Code_Evaluation.term"};
    47     val eq = HOLogic.mk_Trueprop (HOLogic.mk_eq (lhs, rhs));
    48     fun triv_name_of t = (fst o dest_Free o fst o strip_comb o fst
    49       o HOLogic.dest_eq o HOLogic.dest_Trueprop) t ^ "_triv";
    50   in
    51     thy
    52     |> Class.instantiation ([tyco], vs, @{sort partial_term_of})
    53     |> `(fn lthy => Syntax.check_term lthy eq)
    54     |-> (fn eq => Specification.definition (NONE, ((Binding.name (triv_name_of eq), []), eq)))
    55     |> snd
    56     |> Class.prove_instantiation_exit (K (Class.intro_classes_tac []))
    57   end;
    58 
    59 fun ensure_partial_term_of (tyco, (raw_vs, _)) thy =
    60   let
    61     val need_inst = not (can (Sorts.mg_domain (Sign.classes_of thy) tyco) @{sort partial_term_of})
    62       andalso can (Sorts.mg_domain (Sign.classes_of thy) tyco) @{sort typerep};
    63   in if need_inst then add_partial_term_of tyco raw_vs thy else thy end;
    64 
    65 
    66 (** code equations for datatypes **)
    67 
    68 fun mk_partial_term_of_eq thy ty (i, (c, (_, tys))) =
    69   let
    70     val frees = map Free (Name.invent_names Name.context "a" (map (K @{typ narrowing_term}) tys))
    71     val narrowing_term = @{term "Quickcheck_Narrowing.Ctr"} $ HOLogic.mk_number @{typ code_int} i
    72       $ (HOLogic.mk_list @{typ narrowing_term} (rev frees))
    73     val rhs = fold (fn u => fn t => @{term "Code_Evaluation.App"} $ t $ u)
    74         (map mk_partial_term_of (frees ~~ tys))
    75         (@{term "Code_Evaluation.Const"} $ HOLogic.mk_literal c $ HOLogic.mk_typerep (tys ---> ty))
    76     val insts =
    77       map (SOME o Thm.cterm_of thy o map_types Logic.unvarifyT_global o Logic.varify_global)
    78         [Free ("ty", Term.itselfT ty), narrowing_term, rhs]
    79     val cty = Thm.ctyp_of thy ty;
    80   in
    81     @{thm partial_term_of_anything}
    82     |> Drule.instantiate' [SOME cty] insts
    83     |> Thm.varifyT_global
    84   end
    85 
    86 fun add_partial_term_of_code tyco raw_vs raw_cs thy =
    87   let
    88     val algebra = Sign.classes_of thy;
    89     val vs = map (fn (v, sort) =>
    90       (v, curry (Sorts.inter_sort algebra) @{sort typerep} sort)) raw_vs;
    91     val ty = Type (tyco, map TFree vs);
    92     val cs = (map o apsnd o apsnd o map o map_atyps)
    93       (fn TFree (v, _) => TFree (v, (the o AList.lookup (op =) vs) v)) raw_cs;
    94     val const = AxClass.param_of_inst thy (@{const_name partial_term_of}, tyco);
    95     val var_insts = map (SOME o Thm.cterm_of thy o map_types Logic.unvarifyT_global o Logic.varify_global)
    96         [Free ("ty", Term.itselfT ty), @{term "Quickcheck_Narrowing.Var p tt"},
    97           @{term "Code_Evaluation.Free (STR ''_'')"} $ HOLogic.mk_typerep ty]
    98     val var_eq =
    99       @{thm partial_term_of_anything}
   100       |> Drule.instantiate' [SOME (Thm.ctyp_of thy ty)] var_insts
   101       |> Thm.varifyT_global
   102     val eqs = var_eq :: map_index (mk_partial_term_of_eq thy ty) cs;
   103  in
   104     thy
   105     |> Code.del_eqns const
   106     |> fold Code.add_eqn eqs
   107   end;
   108 
   109 fun ensure_partial_term_of_code (tyco, (raw_vs, cs)) thy =
   110   let
   111     val has_inst = can (Sorts.mg_domain (Sign.classes_of thy) tyco) @{sort partial_term_of};
   112   in if has_inst then add_partial_term_of_code tyco raw_vs cs thy else thy end;
   113 
   114 
   115 (* narrowing generators *)
   116 
   117 (** narrowing specific names and types **)
   118 
   119 exception FUNCTION_TYPE;
   120 
   121 val narrowingN = "narrowing";
   122 
   123 fun narrowingT T =
   124   @{typ Quickcheck_Narrowing.code_int} --> Type (@{type_name Quickcheck_Narrowing.cons}, [T])
   125 
   126 fun mk_empty T = Const (@{const_name Quickcheck_Narrowing.empty}, narrowingT T)
   127 
   128 fun mk_cons c T = Const (@{const_name Quickcheck_Narrowing.cons}, T --> narrowingT T) $ Const (c, T)
   129 
   130 fun mk_apply (T, t) (U, u) =
   131   let
   132     val (_, U') = dest_funT U
   133   in
   134     (U', Const (@{const_name Quickcheck_Narrowing.apply},
   135       narrowingT U --> narrowingT T --> narrowingT U') $ u $ t)
   136   end
   137   
   138 fun mk_sum (t, u) =
   139   let
   140     val T = fastype_of t
   141   in
   142     Const (@{const_name Quickcheck_Narrowing.sum}, T --> T --> T) $ t $ u
   143   end
   144 
   145 (** deriving narrowing instances **)
   146 
   147 fun mk_equations descr vs tycos narrowings (Ts, Us) =
   148   let
   149     fun mk_call T =
   150       (T, Const (@{const_name "Quickcheck_Narrowing.narrowing_class.narrowing"}, narrowingT T))
   151     fun mk_aux_call fTs (k, _) (tyco, Ts) =
   152       let
   153         val T = Type (tyco, Ts)
   154         val _ = if not (null fTs) then raise FUNCTION_TYPE else ()
   155       in
   156         (T, nth narrowings k)
   157       end
   158     fun mk_consexpr simpleT (c, xs) =
   159       let
   160         val Ts = map fst xs
   161       in snd (fold mk_apply xs (Ts ---> simpleT, mk_cons c (Ts ---> simpleT))) end
   162     fun mk_rhs exprs = foldr1 mk_sum exprs
   163     val rhss =
   164       Datatype_Aux.interpret_construction descr vs
   165         { atyp = mk_call, dtyp = mk_aux_call }
   166       |> (map o apfst) Type
   167       |> map (fn (T, cs) => map (mk_consexpr T) cs)
   168       |> map mk_rhs
   169     val lhss = narrowings
   170     val eqs = map (HOLogic.mk_Trueprop o HOLogic.mk_eq) (lhss ~~ rhss)
   171   in
   172     eqs
   173   end
   174     
   175 fun contains_recursive_type_under_function_types xs =
   176   exists (fn (_, (_, _, cs)) => cs |> exists (snd #> exists (fn dT =>
   177     (case Datatype_Aux.strip_dtyp dT of (_ :: _, Datatype.DtRec _) => true | _ => false)))) xs
   178 
   179 fun instantiate_narrowing_datatype config descr vs tycos prfx (names, auxnames) (Ts, Us) thy =
   180   let
   181     val _ = Datatype_Aux.message config "Creating narrowing generators ...";
   182     val narrowingsN = map (prefix (narrowingN ^ "_")) (names @ auxnames);
   183   in
   184     if not (contains_recursive_type_under_function_types descr) then
   185       thy
   186       |> Class.instantiation (tycos, vs, @{sort narrowing})
   187       |> Quickcheck_Common.define_functions
   188         (fn narrowings => mk_equations descr vs tycos narrowings (Ts, Us), NONE)
   189         prfx [] narrowingsN (map narrowingT (Ts @ Us))
   190       |> Class.prove_instantiation_exit (K (Class.intro_classes_tac []))
   191     else
   192       thy
   193   end;
   194 
   195 (* testing framework *)
   196 
   197 val target = "Haskell_Quickcheck"
   198 
   199 (** invocation of Haskell interpreter **)
   200 
   201 val narrowing_engine = File.read (Path.explode "~~/src/HOL/Tools/Quickcheck/Narrowing_Engine.hs")
   202 val pnf_narrowing_engine = File.read (Path.explode "~~/src/HOL/Tools/Quickcheck/PNF_Narrowing_Engine.hs")
   203 
   204 fun exec verbose code =
   205   ML_Context.exec (fn () => Secure.use_text ML_Env.local_context (0, "generated code") verbose code)
   206 
   207 fun with_overlord_dir name f =
   208   let
   209     val path = Path.append (Path.explode "~/.isabelle") (Path.basic (name ^ serial_string ()))
   210     val _ = Isabelle_System.mkdirs path;
   211   in Exn.release (Exn.capture f path) end;
   212 
   213 fun elapsed_time description e =
   214   let val ({elapsed, ...}, result) = Timing.timing e ()
   215   in (result, (description, Time.toMilliseconds elapsed)) end
   216   
   217 fun value (contains_existentials, (quiet, size)) ctxt (get, put, put_ml) (code, value_name) =
   218   let
   219     fun message s = if quiet then () else Output.urgent_message s
   220     val tmp_prefix = "Quickcheck_Narrowing"
   221     val with_tmp_dir =
   222       if Config.get ctxt overlord then with_overlord_dir else Isabelle_System.with_tmp_dir 
   223     fun run in_path = 
   224       let
   225         val code_file = Path.append in_path (Path.basic "Code.hs")
   226         val narrowing_engine_file = Path.append in_path (Path.basic "Narrowing_Engine.hs")
   227         val main_file = Path.append in_path (Path.basic "Main.hs")
   228         val main = "module Main where {\n\n" ^
   229           "import System;\n" ^
   230           "import Narrowing_Engine;\n" ^
   231           "import Code;\n\n" ^
   232           "main = getArgs >>= \\[size] -> Narrowing_Engine.depthCheck (read size) (Code.value ())\n\n" ^
   233           "}\n"
   234         val code' = prefix "module Code where {\n\ndata Typerep = Typerep String [Typerep];\n"
   235           (unprefix "module Code where {" code)
   236         val _ = File.write code_file code'
   237         val _ = File.write narrowing_engine_file
   238           (if contains_existentials then pnf_narrowing_engine else narrowing_engine)
   239         val _ = File.write main_file main
   240         val executable = File.shell_path (Path.append in_path (Path.basic "isabelle_quickcheck_narrowing"))
   241         val cmd = "exec \"$ISABELLE_GHC\" -fglasgow-exts " ^
   242           (space_implode " " (map File.shell_path [code_file, narrowing_engine_file, main_file])) ^
   243           " -o " ^ executable ^ ";"
   244         val (result, compilation_time) = elapsed_time "Haskell compilation" (fn () => bash cmd) 
   245         val _ = if bash cmd <> 0 then error "Compilation with GHC failed" else ()
   246         fun with_size k exec_times =
   247           if k > size then
   248             (NONE, exec_times)
   249           else
   250             let
   251               val _ = message ("Test data size: " ^ string_of_int k)
   252               val ((response, _), exec_time) = elapsed_time ("execution of size " ^ string_of_int k)
   253                 (fn () => bash_output (executable ^ " " ^ string_of_int k))
   254             in
   255               if response = "NONE\n" then with_size (k + 1) (exec_time :: exec_times)
   256                 else (SOME response, exec_time :: exec_times)
   257             end
   258       in case with_size 0 [compilation_time] of
   259            (NONE, exec_times) => (NONE, exec_times)
   260          | (SOME response, exec_times) =>
   261            let
   262              val output_value = the_default "NONE"
   263                (try (snd o split_last o filter_out (fn s => s = "") o split_lines) response)
   264                |> translate_string (fn s => if s = "\\" then "\\\\" else s)
   265              val ml_code = "\nval _ = Context.set_thread_data (SOME (Context.map_proof (" ^ put_ml
   266                ^ " (fn () => " ^ output_value ^ ")) (ML_Context.the_generic_context ())))";
   267              val ctxt' = ctxt
   268                |> put (fn () => error ("Bad evaluation for " ^ quote put_ml))
   269                |> Context.proof_map (exec false ml_code);
   270            in (get ctxt' (), exec_times) end     
   271       end
   272   in with_tmp_dir tmp_prefix run end;
   273 
   274 fun dynamic_value_strict opts cookie thy postproc t =
   275   let
   276     val ctxt = Proof_Context.init_global thy
   277     fun evaluator naming program ((_, vs_ty), t) deps = Exn.interruptible_capture (value opts ctxt cookie)
   278       (Code_Target.evaluator thy target naming program deps (vs_ty, t));    
   279   in Exn.release (Code_Thingol.dynamic_value thy (Exn.map_result o postproc) evaluator t) end;
   280 
   281 (** counterexample generator **)
   282   
   283 structure Counterexample = Proof_Data
   284 (
   285   type T = unit -> term list option
   286   fun init _ () = error "Counterexample"
   287 )
   288 
   289 datatype counterexample = Universal_Counterexample of (term * counterexample)
   290   | Existential_Counterexample of (term * counterexample) list
   291   | Empty_Assignment
   292   
   293 fun map_counterexample f Empty_Assignment = Empty_Assignment
   294   | map_counterexample f (Universal_Counterexample (t, c)) =
   295       Universal_Counterexample (f t, map_counterexample f c)
   296   | map_counterexample f (Existential_Counterexample cs) =
   297       Existential_Counterexample (map (fn (t, c) => (f t, map_counterexample f c)) cs)
   298 
   299 structure Existential_Counterexample = Proof_Data
   300 (
   301   type T = unit -> counterexample option
   302   fun init _ () = error "Counterexample"
   303 )
   304 
   305 val put_existential_counterexample = Existential_Counterexample.put
   306 
   307 val put_counterexample = Counterexample.put
   308 
   309 fun finitize_functions (xTs, t) =
   310   let
   311     val (names, boundTs) = split_list xTs
   312     fun mk_eval_ffun dT rT =
   313       Const (@{const_name "Quickcheck_Narrowing.eval_ffun"}, 
   314         Type (@{type_name "Quickcheck_Narrowing.ffun"}, [dT, rT]) --> dT --> rT)
   315     fun mk_eval_cfun dT rT =
   316       Const (@{const_name "Quickcheck_Narrowing.eval_cfun"}, 
   317         Type (@{type_name "Quickcheck_Narrowing.cfun"}, [rT]) --> dT --> rT)
   318     fun eval_function (T as Type (@{type_name fun}, [dT, rT])) =
   319       let
   320         val (rt', rT') = eval_function rT
   321       in
   322         case dT of
   323           Type (@{type_name fun}, _) =>
   324             (fn t => absdummy (dT, rt' (mk_eval_cfun dT rT' $ incr_boundvars 1 t $ Bound 0)),
   325             Type (@{type_name "Quickcheck_Narrowing.cfun"}, [rT']))
   326         | _ => (fn t => absdummy (dT, rt' (mk_eval_ffun dT rT' $ incr_boundvars 1 t $ Bound 0)),
   327             Type (@{type_name "Quickcheck_Narrowing.ffun"}, [dT, rT']))
   328       end
   329       | eval_function T = (I, T)
   330     val (tt, boundTs') = split_list (map eval_function boundTs)
   331     val t' = subst_bounds (map2 (fn f => fn x => f x) (rev tt) (map_index (Bound o fst) boundTs), t)
   332   in
   333     (names ~~ boundTs', t')
   334   end
   335 
   336 (** tester **)
   337 
   338 val rewrs =
   339     map (swap o HOLogic.dest_eq o HOLogic.dest_Trueprop o Thm.prop_of)
   340       (@{thms all_simps} @ @{thms ex_simps})
   341     @ map (HOLogic.dest_eq o HOLogic.dest_Trueprop o Thm.prop_of)
   342         [@{thm iff_conv_conj_imp}, @{thm not_ex}, @{thm not_all}]
   343 
   344 fun make_pnf_term thy t = Pattern.rewrite_term thy rewrs [] t
   345 
   346 fun strip_quantifiers (Const (@{const_name Ex}, _) $ Abs (x, T, t)) =
   347     apfst (cons (@{const_name Ex}, (x, T))) (strip_quantifiers t)
   348   | strip_quantifiers (Const (@{const_name All}, _) $ Abs (x, T, t)) =
   349     apfst (cons (@{const_name All}, (x, T))) (strip_quantifiers t)
   350   | strip_quantifiers t = ([], t)
   351 
   352 fun contains_existentials t = exists (fn (Q, _) => Q = @{const_name Ex}) (fst (strip_quantifiers t))
   353 
   354 fun mk_property qs t =
   355   let
   356     fun enclose (@{const_name Ex}, (x, T)) t =
   357         Const (@{const_name Quickcheck_Narrowing.exists}, (T --> @{typ property}) --> @{typ property})
   358           $ Abs (x, T, t)
   359       | enclose (@{const_name All}, (x, T)) t =
   360         Const (@{const_name Quickcheck_Narrowing.all}, (T --> @{typ property}) --> @{typ property})
   361           $ Abs (x, T, t)
   362   in
   363     fold_rev enclose qs (@{term Quickcheck_Narrowing.Property} $
   364       (list_comb (t , map Bound (((length qs) - 1) downto 0))))
   365   end
   366 
   367 fun mk_case_term ctxt p ((@{const_name Ex}, (x, T)) :: qs') (Existential_Counterexample cs) =
   368     Datatype.make_case ctxt Datatype_Case.Quiet [] (Free (x, T)) (map (fn (t, c) =>
   369       (t, mk_case_term ctxt (p - 1) qs' c)) cs)
   370   | mk_case_term ctxt p ((@{const_name All}, (x, T)) :: qs') (Universal_Counterexample (t, c)) =
   371     if p = 0 then t else mk_case_term ctxt (p - 1) qs' c
   372 
   373 fun mk_terms ctxt qs result =
   374   let
   375     val
   376       ps = filter (fn (_, (@{const_name All}, _)) => true | _ => false) (map_index I qs)
   377     in
   378       map (fn (p, (_, (x, T))) => (x, mk_case_term ctxt p qs result)) ps
   379     end
   380   
   381 fun test_term ctxt (limit_time, is_interactive) (t, eval_terms) =
   382   let
   383     val opts = (Config.get ctxt Quickcheck.quiet, Config.get ctxt Quickcheck.size)
   384     val thy = Proof_Context.theory_of ctxt
   385     val t' = fold_rev (fn (x, T) => fn t => HOLogic.mk_all (x, T, t)) (Term.add_frees t []) t
   386     val pnf_t = make_pnf_term thy t'
   387   in
   388     if Config.get ctxt allow_existentials andalso contains_existentials pnf_t then
   389       let
   390         fun wrap f (qs, t) =
   391           let val (qs1, qs2) = split_list qs in
   392           apfst (map2 pair qs1) (f (qs2, t)) end
   393         val finitize = if Config.get ctxt finite_functions then wrap finitize_functions else I
   394         val (qs, prop_t) = finitize (strip_quantifiers pnf_t)
   395         val prop_term = fold_rev (fn (_, (x, T)) => fn t => Abs (x, T, t)) qs prop_t
   396         val ((prop_def, _), ctxt') = Local_Theory.define ((Binding.conceal (Binding.name "test_property"), NoSyn),
   397           ((Binding.conceal Binding.empty, [Code.add_default_eqn_attrib]), prop_term)) ctxt
   398         val (prop_def', thy') = Local_Theory.exit_result_global Morphism.term (prop_def, ctxt') 
   399         val (result, timings) = dynamic_value_strict (true, opts)
   400           (Existential_Counterexample.get, Existential_Counterexample.put,
   401             "Narrowing_Generators.put_existential_counterexample")
   402           thy' (apfst o Option.map o map_counterexample) (mk_property qs prop_def')
   403         val result' = Option.map (mk_terms ctxt' (fst (strip_quantifiers pnf_t))) result
   404       in
   405         Quickcheck.Result {counterexample = result', evaluation_terms = Option.map (K []) result,
   406           timings = timings, reports = []}
   407       end
   408     else
   409       let
   410         val t' = Term.list_abs_free (Term.add_frees t [], t)
   411         fun wrap f t = list_abs (f (strip_abs t))
   412         val finitize = if Config.get ctxt finite_functions then wrap finitize_functions else I
   413         fun ensure_testable t =
   414           Const (@{const_name Quickcheck_Narrowing.ensure_testable}, fastype_of t --> fastype_of t) $ t
   415         val (result, timings) = dynamic_value_strict (false, opts)
   416           (Counterexample.get, Counterexample.put, "Narrowing_Generators.put_counterexample")
   417           thy (apfst o Option.map o map) (ensure_testable (finitize t'))
   418       in
   419         Quickcheck.Result {counterexample = Option.map ((curry (op ~~)) (Term.add_free_names t [])) result,
   420           evaluation_terms = Option.map (K []) result, timings = timings, reports = []}
   421       end
   422   end;
   423 
   424 fun test_goals ctxt (limit_time, is_interactive) insts goals =
   425   if (not (getenv "ISABELLE_GHC" = "")) then
   426     let
   427       val correct_inst_goals = Quickcheck.instantiate_goals ctxt insts goals
   428     in
   429       Quickcheck.collect_results (test_term ctxt (limit_time, is_interactive)) (maps (map snd) correct_inst_goals) []
   430     end
   431   else
   432     (if Config.get ctxt Quickcheck.quiet then () else Output.urgent_message
   433       ("Environment variable ISABELLE_GHC is not set. To use narrowing-based quickcheck, please set "
   434         ^ "this variable to your GHC Haskell compiler in your settings file."); [Quickcheck.empty_result])
   435 
   436 (* setup *)
   437 
   438 val setup =
   439   Code.datatype_interpretation ensure_partial_term_of
   440   #> Code.datatype_interpretation ensure_partial_term_of_code
   441   #> Datatype.interpretation (Quickcheck_Common.ensure_sort_datatype
   442     (((@{sort typerep}, @{sort term_of}), @{sort narrowing}), instantiate_narrowing_datatype))
   443   #> Context.theory_map (Quickcheck.add_tester ("narrowing", test_goals))
   444     
   445 end;