src/Tools/Code/code_runtime.ML
author haftmann
Tue Dec 21 09:19:37 2010 +0100 (2010-12-21)
changeset 41348 692c3fbde3c9
parent 41347 064133cb4ef6
child 41349 0e2a3f22f018
permissions -rw-r--r--
tuned naming
     1 (*  Title:      Tools/Code/code_runtime.ML
     2     Author:     Florian Haftmann, TU Muenchen
     3 
     4 Runtime services building on code generation into implementation language SML.
     5 *)
     6 
     7 signature CODE_RUNTIME =
     8 sig
     9   val target: string
    10   val value: Proof.context ->
    11     (Proof.context -> unit -> 'a) * ((unit -> 'a) -> Proof.context -> Proof.context) * string ->
    12     string * string -> 'a
    13   type 'a cookie = (Proof.context -> unit -> 'a) * ((unit -> 'a) -> Proof.context -> Proof.context) * string
    14   val dynamic_value: 'a cookie -> theory -> string option
    15     -> ((term -> term) -> 'a -> 'a) -> term -> string list -> 'a option
    16   val dynamic_value_strict: 'a cookie -> theory -> string option
    17     -> ((term -> term) -> 'a -> 'a) -> term -> string list -> 'a
    18   val dynamic_value_exn: 'a cookie -> theory -> string option
    19     -> ((term -> term) -> 'a -> 'a) -> term -> string list -> 'a Exn.result
    20   val static_value: 'a cookie -> theory -> string option
    21     -> ((term -> term) -> 'a -> 'a) -> string list -> term -> 'a option
    22   val static_value_strict: 'a cookie -> theory -> string option
    23     -> ((term -> term) -> 'a -> 'a) -> string list -> term -> 'a
    24   val static_value_exn: 'a cookie -> theory -> string option
    25     -> ((term -> term) -> 'a -> 'a) -> string list -> term -> 'a Exn.result
    26   val dynamic_holds_conv: theory -> conv
    27   val static_holds_conv: theory -> string list -> conv
    28   val code_reflect: (string * string list option) list -> string list -> string
    29     -> string option -> theory -> theory
    30   datatype truth = Holds
    31   val put_truth: (unit -> truth) -> Proof.context -> Proof.context
    32   val trace: bool Unsynchronized.ref
    33   val polyml_as_definition: (binding * typ) list -> Path.T list -> theory -> theory
    34 end;
    35 
    36 structure Code_Runtime : CODE_RUNTIME =
    37 struct
    38 
    39 open Basic_Code_Thingol;
    40 
    41 (** evaluation **)
    42 
    43 (* technical prerequisites *)
    44 
    45 val this = "Code_Runtime";
    46 val s_truth = Long_Name.append this "truth";
    47 val s_Holds = Long_Name.append this "Holds";
    48 
    49 val target = "Eval";
    50 
    51 datatype truth = Holds;
    52 
    53 val _ = Context.>> (Context.map_theory
    54   (Code_Target.extend_target (target, (Code_ML.target_SML, K I))
    55   #> Code_Target.add_tyco_syntax target @{type_name prop}
    56        (SOME (0, (K o K o K) (Code_Printer.str s_truth)))
    57   #> Code_Target.add_const_syntax target @{const_name Code_Generator.holds}
    58        (SOME (Code_Printer.plain_const_syntax s_Holds))
    59   #> Code_Target.add_reserved target this
    60   #> fold (Code_Target.add_reserved target) ["oo", "ooo", "oooo", "upto", "downto", "orf", "andf"]));
    61        (*avoid further pervasive infix names*)
    62 
    63 val trace = Unsynchronized.ref false;
    64 
    65 fun exec verbose code =
    66   (if ! trace then tracing code else ();
    67   ML_Context.exec (fn () => Secure.use_text ML_Env.local_context (0, "generated code") verbose code));
    68 
    69 fun value ctxt (get, put, put_ml) (prelude, value) =
    70   let
    71     val code = (prelude
    72       ^ "\nval _ = Context.set_thread_data (SOME (Context.map_proof (" ^ put_ml
    73       ^ " (fn () => " ^ value ^ ")) (ML_Context.the_generic_context ())))");
    74     val ctxt' = ctxt
    75       |> put (fn () => error ("Bad evaluation for " ^ quote put_ml))
    76       |> Context.proof_map (exec false code);
    77   in get ctxt' () end;
    78 
    79 
    80 (* evaluation into target language values *)
    81 
    82 type 'a cookie = (Proof.context -> unit -> 'a) * ((unit -> 'a) -> Proof.context -> Proof.context) * string;
    83 
    84 fun reject_vars thy t =
    85   let
    86     val ctxt = ProofContext.init_global thy;
    87   in ((Sign.no_frees ctxt o Sign.no_vars ctxt o map_types (K dummyT)) t; t) end;
    88 
    89 fun obtain_evaluator thy some_target naming program deps =
    90   Code_Target.evaluator thy (the_default target some_target) naming program deps;
    91 
    92 fun evaluation cookie thy evaluator vs_t args =
    93   let
    94     val ctxt = ProofContext.init_global thy;
    95     val (program_code, value_name) = evaluator vs_t;
    96     val value_code = space_implode " "
    97       (value_name :: "()" :: map (enclose "(" ")") args);
    98   in Exn.interruptible_capture (value ctxt cookie) (program_code, value_code) end;
    99 
   100 fun partiality_as_none e = SOME (Exn.release e)
   101   handle General.Match => NONE
   102     | General.Bind => NONE
   103     | General.Fail _ => NONE;
   104 
   105 fun dynamic_value_exn cookie thy some_target postproc t args =
   106   let
   107     val _ = reject_vars thy t;
   108     val _ = if ! trace
   109       then tracing ("Evaluation of term " ^ quote (Syntax.string_of_term_global thy t))
   110       else ()
   111     fun evaluator naming program ((_, vs_ty), t) deps =
   112       evaluation cookie thy (obtain_evaluator thy some_target naming program deps) (vs_ty, t) args;
   113   in Code_Thingol.dynamic_value thy (Exn.map_result o postproc) evaluator t end;
   114 
   115 fun dynamic_value_strict cookie thy some_target postproc t args =
   116   Exn.release (dynamic_value_exn cookie thy some_target postproc t args);
   117 
   118 fun dynamic_value cookie thy some_target postproc t args =
   119   partiality_as_none (dynamic_value_exn cookie thy some_target postproc t args);
   120 
   121 fun static_evaluator cookie thy some_target naming program consts' =
   122   let
   123     val evaluator = obtain_evaluator thy some_target naming program consts'
   124   in fn ((_, vs_ty), t) => fn _ => evaluation cookie thy evaluator (vs_ty, t) [] end;
   125 
   126 fun static_value_exn cookie thy some_target postproc consts =
   127   Code_Thingol.static_value thy (Exn.map_result o postproc) consts
   128     (static_evaluator cookie thy some_target) o reject_vars thy;
   129 
   130 fun static_value_strict cookie thy some_target postproc consts =
   131   Exn.release o static_value_exn cookie thy some_target postproc consts;
   132 
   133 fun static_value cookie thy some_target postproc consts =
   134   partiality_as_none o static_value_exn cookie thy some_target postproc consts;
   135 
   136 
   137 (* evaluation for truth or nothing *)
   138 
   139 structure Truth_Result = Proof_Data
   140 (
   141   type T = unit -> truth
   142   fun init _ () = error "Truth_Result"
   143 );
   144 val put_truth = Truth_Result.put;
   145 val truth_cookie = (Truth_Result.get, put_truth, Long_Name.append this "put_truth");
   146 
   147 val reject_vars = fn thy => tap (reject_vars thy o Thm.term_of);
   148 
   149 fun check_holds some_target naming thy program vs_t deps ct =
   150   let
   151     val t = Thm.term_of ct;
   152     val _ = if fastype_of t <> propT
   153       then error ("Not a proposition: " ^ Syntax.string_of_term_global thy t)
   154       else ();
   155     val iff = Thm.cterm_of thy (Term.Const ("==", propT --> propT --> propT));
   156     val result = case partiality_as_none
   157       (evaluation truth_cookie thy (obtain_evaluator thy some_target naming program deps) vs_t [])
   158      of SOME Holds => true
   159       | _ => false;
   160   in
   161     Thm.mk_binop iff ct (if result then @{cprop "PROP Code_Generator.holds"} else ct)
   162   end;
   163 
   164 val (_, raw_check_holds_oracle) = Context.>>> (Context.map_theory_result
   165   (Thm.add_oracle (Binding.name "holds_by_evaluation",
   166   fn (some_target, naming, thy, program, vs_t, deps, ct) => check_holds some_target naming thy program vs_t deps ct)));
   167 
   168 fun check_holds_oracle some_target naming thy program ((_, vs_ty), t) deps ct =
   169   raw_check_holds_oracle (some_target, naming, thy, program, (vs_ty, t), deps, ct);
   170 
   171 fun dynamic_holds_conv thy = Code_Thingol.dynamic_conv thy
   172     (fn naming => check_holds_oracle NONE naming thy)
   173   o reject_vars thy;
   174 
   175 fun static_holds_conv thy consts =
   176   Code_Thingol.static_conv thy consts
   177     (fn naming => fn program => fn consts' => check_holds_oracle NONE naming thy program)
   178     o reject_vars thy;
   179 
   180 
   181 (** instrumentalization **)
   182 
   183 fun evaluation_code thy module_name tycos consts =
   184   let
   185     val (consts', (naming, program)) = Code_Thingol.consts_program thy false consts;
   186     val tycos' = map (the o Code_Thingol.lookup_tyco naming) tycos;
   187     val (ml_code, target_names) = Code_Target.produce_code_for thy
   188       target NONE module_name [] naming program (consts' @ tycos');
   189     val (consts'', tycos'') = chop (length consts') target_names;
   190     val consts_map = map2 (fn const => fn NONE =>
   191         error ("Constant " ^ (quote o Code.string_of_const thy) const
   192           ^ "\nhas a user-defined serialization")
   193       | SOME const'' => (const, const'')) consts consts''
   194     val tycos_map = map2 (fn tyco => fn NONE =>
   195         error ("Type " ^ (quote o Sign.extern_type thy) tyco
   196           ^ "\nhas a user-defined serialization")
   197       | SOME tyco'' => (tyco, tyco'')) tycos tycos'';
   198   in (ml_code, (tycos_map, consts_map)) end;
   199 
   200 
   201 (* by antiquotation *)
   202 
   203 local
   204 
   205 structure Code_Antiq_Data = Proof_Data
   206 (
   207   type T = (string list * string list) * (bool
   208     * (string * (string * string) list) lazy);
   209   fun init _ = (([], []), (true, (Lazy.value ("", []))));
   210 );
   211 
   212 val is_first_occ = fst o snd o Code_Antiq_Data.get;
   213 
   214 fun register_code new_tycos new_consts ctxt =
   215   let
   216     val ((tycos, consts), _) = Code_Antiq_Data.get ctxt;
   217     val tycos' = fold (insert (op =)) new_tycos tycos;
   218     val consts' = fold (insert (op =)) new_consts consts;
   219     val acc_code = Lazy.lazy (fn () =>
   220       evaluation_code (ProofContext.theory_of ctxt) "Code" tycos' consts'
   221       |> apsnd snd);
   222   in Code_Antiq_Data.put ((tycos', consts'), (false, acc_code)) ctxt end;
   223 
   224 fun register_const const = register_code [] [const];
   225 
   226 fun print_const const all_struct_name consts_map =
   227   (Long_Name.append all_struct_name o the o AList.lookup (op =) consts_map) const;
   228 
   229 fun print_code is_first const ctxt =
   230   let
   231     val (_, (_, acc_code)) = Code_Antiq_Data.get ctxt;
   232     val (ml_code, consts_map) = Lazy.force acc_code;
   233     val ml_code = if is_first then ml_code else "";
   234     val all_struct_name = "Isabelle";
   235   in (ml_code, print_const const all_struct_name consts_map) end;
   236 
   237 in
   238 
   239 fun ml_code_antiq raw_const background =
   240   let
   241     val const = Code.check_const (ProofContext.theory_of background) raw_const;
   242     val is_first = is_first_occ background;
   243     val background' = register_const const background;
   244   in (print_code is_first const, background') end;
   245 
   246 end; (*local*)
   247 
   248 
   249 (* reflection support *)
   250 
   251 fun check_datatype thy tyco some_consts =
   252   let
   253     val constrs = (map fst o snd o fst o Code.get_type thy) tyco;
   254     val _ = case some_consts
   255      of SOME consts =>
   256           let
   257             val missing_constrs = subtract (op =) consts constrs;
   258             val _ = if null missing_constrs then []
   259               else error ("Missing constructor(s) " ^ commas (map quote missing_constrs)
   260                 ^ " for datatype " ^ quote tyco);
   261             val false_constrs = subtract (op =) constrs consts;
   262             val _ = if null false_constrs then []
   263               else error ("Non-constructor(s) " ^ commas (map quote false_constrs)
   264                 ^ " for datatype " ^ quote tyco)
   265           in () end
   266       | NONE => ();
   267   in (tyco, constrs) end;
   268 
   269 fun add_eval_tyco (tyco, tyco') thy =
   270   let
   271     val k = Sign.arity_number thy tyco;
   272     fun pr pr' _ [] = tyco'
   273       | pr pr' _ [ty] =
   274           Code_Printer.concat [pr' Code_Printer.BR ty, tyco']
   275       | pr pr' _ tys =
   276           Code_Printer.concat [Code_Printer.enum "," "(" ")" (map (pr' Code_Printer.BR) tys), tyco']
   277   in
   278     thy
   279     |> Code_Target.add_tyco_syntax target tyco (SOME (k, pr))
   280   end;
   281 
   282 fun add_eval_constr (const, const') thy =
   283   let
   284     val k = Code.args_number thy const;
   285     fun pr pr' fxy ts = Code_Printer.brackify fxy
   286       (const' :: the_list (Code_Printer.tuplify pr' Code_Printer.BR (map fst ts)));
   287   in
   288     thy
   289     |> Code_Target.add_const_syntax target const (SOME (Code_Printer.simple_const_syntax (k, pr)))
   290   end;
   291 
   292 fun add_eval_const (const, const') = Code_Target.add_const_syntax target
   293   const (SOME (Code_Printer.simple_const_syntax (0, (K o K o K) const')));
   294 
   295 fun process_reflection (code, (tyco_map, (constr_map, const_map))) module_name NONE thy =
   296       thy
   297       |> Code_Target.add_reserved target module_name
   298       |> Context.theory_map (exec true code)
   299       |> fold (add_eval_tyco o apsnd Code_Printer.str) tyco_map
   300       |> fold (add_eval_constr o apsnd Code_Printer.str) constr_map
   301       |> fold (add_eval_const o apsnd Code_Printer.str) const_map
   302   | process_reflection (code, _) _ (SOME file_name) thy =
   303       let
   304         val preamble =
   305           "(* Generated from " ^ Path.implode (Thy_Header.thy_path (Context.theory_name thy))
   306           ^ "; DO NOT EDIT! *)";
   307         val _ = File.write (Path.explode file_name) (preamble ^ "\n\n" ^ code);
   308       in
   309         thy
   310       end;
   311 
   312 fun gen_code_reflect prep_type prep_const raw_datatypes raw_functions module_name some_file thy  =
   313   let
   314     val datatypes = map (fn (raw_tyco, raw_cos) =>
   315       (prep_type thy raw_tyco, (Option.map o map) (prep_const thy) raw_cos)) raw_datatypes;
   316     val (tycos, constrs) = map_split (uncurry (check_datatype thy)) datatypes
   317       |> apsnd flat;
   318     val functions = map (prep_const thy) raw_functions;
   319     val result = evaluation_code thy module_name tycos (constrs @ functions)
   320       |> (apsnd o apsnd) (chop (length constrs));
   321   in
   322     thy
   323     |> process_reflection result module_name some_file
   324   end;
   325 
   326 val code_reflect = gen_code_reflect Code_Target.cert_tyco (K I);
   327 val code_reflect_cmd = gen_code_reflect Code_Target.read_tyco Code.read_const;
   328 
   329 
   330 (** Isar setup **)
   331 
   332 val _ = ML_Context.add_antiq "code" (fn _ => Args.term >> ml_code_antiq);
   333 
   334 local
   335 
   336 val datatypesK = "datatypes";
   337 val functionsK = "functions";
   338 val fileK = "file";
   339 val andK = "and"
   340 
   341 val _ = List.app Keyword.keyword [datatypesK, functionsK];
   342 
   343 val parse_datatype =
   344   Parse.name --| Parse.$$$ "=" --
   345     (((Parse.sym_ident || Parse.string) >> (fn "_" => NONE | _ => Scan.fail ()))
   346     || ((Parse.term ::: (Scan.repeat (Parse.$$$ "|" |-- Parse.term))) >> SOME));
   347 
   348 in
   349 
   350 val _ =
   351   Outer_Syntax.command "code_reflect" "enrich runtime environment with generated code"
   352     Keyword.thy_decl (Parse.name -- Scan.optional (Parse.$$$ datatypesK |-- (parse_datatype
   353       ::: Scan.repeat (Parse.$$$ andK |-- parse_datatype))) []
   354     -- Scan.optional (Parse.$$$ functionsK |-- Scan.repeat1 Parse.name) []
   355     -- Scan.option (Parse.$$$ fileK |-- Parse.name)
   356   >> (fn (((module_name, raw_datatypes), raw_functions), some_file) => Toplevel.theory
   357     (code_reflect_cmd raw_datatypes raw_functions module_name some_file)));
   358 
   359 end; (*local*)
   360 
   361 
   362 (** using external SML files as substitute for proper definitions -- only for polyml!  **)
   363 
   364 local
   365 
   366 structure Loaded_Values = Theory_Data
   367 (
   368   type T = string list
   369   val empty = []
   370   fun merge data : T = Library.merge (op =) data
   371   val extend = I
   372 );
   373 
   374 fun notify_val (string, value) = 
   375   let
   376     val _ = #enterVal ML_Env.name_space (string, value);
   377     val _ = Context.>> ((Context.map_theory o Loaded_Values.map) (insert (op =) string));
   378   in () end;
   379 
   380 fun abort _ = error "Only value bindings allowed.";
   381 
   382 val notifying_context : use_context =
   383  {tune_source = #tune_source ML_Env.local_context,
   384   name_space =
   385    {lookupVal    = #lookupVal ML_Env.name_space,
   386     lookupType   = #lookupType ML_Env.name_space,
   387     lookupFix    = #lookupFix ML_Env.name_space,
   388     lookupStruct = #lookupStruct ML_Env.name_space,
   389     lookupSig    = #lookupSig ML_Env.name_space,
   390     lookupFunct  = #lookupFunct ML_Env.name_space,
   391     enterVal     = notify_val,
   392     enterType    = abort,
   393     enterFix     = abort,
   394     enterStruct  = abort,
   395     enterSig     = abort,
   396     enterFunct   = abort,
   397     allVal       = #allVal ML_Env.name_space,
   398     allType      = #allType ML_Env.name_space,
   399     allFix       = #allFix ML_Env.name_space,
   400     allStruct    = #allStruct ML_Env.name_space,
   401     allSig       = #allSig ML_Env.name_space,
   402     allFunct     = #allFunct ML_Env.name_space},
   403   str_of_pos = #str_of_pos ML_Env.local_context,
   404   print = #print ML_Env.local_context,
   405   error = #error ML_Env.local_context};
   406 
   407 in
   408 
   409 fun use_file filepath thy =
   410   let
   411     val thy' = Loaded_Values.put [] thy;
   412     val _ = Context.set_thread_data ((SOME o Context.Theory) thy');
   413     val _ = Secure.use_text notifying_context
   414       (0, Path.implode filepath) false (File.read filepath);
   415     val thy'' = (Context.the_theory o the) (Context.thread_data ());
   416     val names = Loaded_Values.get thy'';
   417   in (names, thy'') end;
   418 
   419 end;
   420 
   421 fun add_definiendum (ml_name, (b, T)) thy =
   422   thy
   423   |> Code_Target.add_reserved target ml_name
   424   |> Specification.axiomatization [(b, SOME T, NoSyn)] []
   425   |-> (fn ([Const (const, _)], _) =>
   426      Code_Target.add_const_syntax target const
   427        (SOME (Code_Printer.simple_const_syntax (0, (K o K o K o Code_Printer.str) ml_name)))
   428   #> tap (fn thy => Code_Target.produce_code thy [const] target NONE "Code" []));
   429 
   430 fun process_file filepath (definienda, thy) =
   431   let
   432     val (ml_names, thy') = use_file filepath thy;
   433     val superfluous = subtract (fn ((name1, _), name2) => name1 = name2) definienda ml_names;
   434     val _ = if null superfluous then ()
   435       else error ("Value binding(s) " ^ commas_quote superfluous
   436         ^ " found in external file " ^ quote (Path.implode filepath)
   437         ^ " not present among the given contants binding(s).");
   438     val these_definienda = AList.make (the o AList.lookup (op =) definienda) ml_names;
   439     val thy'' = fold add_definiendum these_definienda thy';
   440     val definienda' = fold (AList.delete (op =)) ml_names definienda;
   441   in (definienda', thy'') end;
   442 
   443 fun polyml_as_definition bTs filepaths thy =
   444   let
   445     val definienda = map (fn bT => ((Binding.name_of o fst) bT, bT)) bTs;
   446     val (remaining, thy') = fold process_file filepaths (definienda, thy);
   447     val _ = if null remaining then ()
   448       else error ("Constant binding(s) " ^ commas_quote (map fst remaining)
   449         ^ " not present in external file(s).");
   450   in thy' end;
   451 
   452 end; (*struct*)