2 * Copyright (C) 2019 Richard W.M. Jones
3 * Copyright (C) 2019 Red Hat Inc.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 let rec goal_runner env loc name args
25 (params, patterns, deps, code) extra_deps debug_goal =
26 Cmdline.debug "%a: running goal %s" Ast.string_loc loc debug_goal;
28 (* Check if any target (ie. pattern) needs to be rebuilt.
29 * As with make, a goal with no targets is always run.
33 List.exists (needs_rebuild env loc deps extra_deps) patterns in
36 (* Run the code (if any). *)
38 | None -> () (* No { CODE } section. *)
41 (* Add some standard variables to the environment. *)
42 let expr_of_substs s = Ast.ESubsts (Ast.noloc, s) in
43 let expr_of_pattern = function
44 | Ast.PTactic (loc, tactic, targs) ->
45 Ast.ETacticCtor (loc, tactic, List.map expr_of_substs targs)
47 let pexprs = List.map expr_of_pattern patterns in
48 let env = Ast.Env.add "@" (Ast.EList (Ast.noloc, pexprs)) env in
49 let env = Ast.Env.add "<" (Ast.EList (Ast.noloc, deps)) env in
51 (* NB: extra_deps are not added to %^ *)
54 | d :: _ -> Ast.Env.add "^" d env in
55 let r = Eval.run_code env loc code in
57 failwithf "goal ‘%s’ failed with exit code %d" name r;
59 (* Check all targets were updated after the code was
60 * run (else it's an error).
62 let pattern_still_needs_rebuild =
66 (needs_rebuild ~final_check:true env loc deps extra_deps)
71 match pattern_still_needs_rebuild with
74 failwithf "%a: goal %s ran successfully but it did not rebuild %a"
75 Ast.string_loc loc debug_goal Ast.string_pattern pattern
79 (* Return whether the target (pattern) needs to be rebuilt. *)
80 and needs_rebuild ?(final_check = false) env loc deps extra_deps pattern =
81 Cmdline.debug "%a: testing if %a needs rebuild"
82 Ast.string_loc loc Ast.string_pattern pattern;
85 | Ast.PTactic (loc, tactic, targs) ->
86 (* Look up the tactic. *)
87 let params, code = Ast.gettactic env loc tactic in
89 (* Resolve the targs down to constants. Since needs_rebuild
90 * should be called with env containing the goal params, this
91 * should substitute any parameters in the tactic arguments.
93 let targs = List.map (Eval.substitute env loc) targs in
96 Ast.EConstant (Ast.noloc, Ast.CString targ)) targs in
98 (* Create a new environment binding parameter names
103 try List.combine params targs
104 with Invalid_argument _ ->
105 failwithf "%a: calling tactic ‘%s’ with wrong number of arguments"
106 Ast.string_loc loc tactic in
107 List.fold_left (fun env (k, v) -> Ast.Env.add k v env) env params in
109 (* Add some standard variables to the environment. *)
110 let env = Ast.Env.add "<" (Ast.EList (Ast.noloc, deps)) env in
112 (*let b = Ast.EConstant (Ast.noloc, Ast.CBool final_check) in*)
113 let b = Ast.EConstant (Ast.noloc,
114 Ast.CString (if final_check then "1" else "")) in
115 Ast.Env.add "goals_final_check" b env in
117 (* NB: extra_deps are not added to %^ *)
120 | d :: _ -> Ast.Env.add "^" d env in
121 let r = Eval.run_code env loc code in
122 if r = 99 (* means "needs rebuild" *) then true
123 else if r = 0 (* means "doesn't need rebuild" *) then false
125 failwithf "tactic ‘%s’ failed with exit code %d" tactic r
127 and exists_runner env loc p debug_tactic =
128 Cmdline.debug "%a: running implicit existence rule for tactic %s"
129 Ast.string_loc loc debug_tactic;
131 if needs_rebuild env loc [] [] p then
132 failwithf "%a: don't know how to build %s" Ast.string_loc loc debug_tactic