open Utils
-let rec run_targets env exprs =
- List.iter (run_target env) exprs
+(* Goals uses the goal (name + parameters) as the key to
+ * ensure you cannot have two jobs running at the same time
+ * which would interfere with each other by trying to build
+ * the same target.
+ *)
+module Jobs = Jobs.Make (
+ struct
+ type t = string * Ast.expr list
+ let compare = compare
+ let to_string (name, args) =
+ sprintf "%s (%s)" name
+ (String.concat ", " (List.map (Ast.string_expr ()) args))
+ end
+)
+
+let stop_all = Jobs.stop_all
+
+(* Starts the target expressions running and waits for them to complete. *)
+let rec run_targets_to_completion env exprs =
+ let group = Jobs.new_group () in
+ run_targets group env exprs;
+ Jobs.wait group
+
+(* This starts the targets, adding them to the jobs group, but does not
+ * wait for them to complete.
+ *)
+and run_targets group env exprs =
+ List.iter (run_target group env) exprs
-and run_target env = function
- | Ast.EGoalDefn _ | Ast.ETacticDefn _ -> assert false
+(* This starts a single target, adding the (usually single but can
+ * be multiple) jobs to the jobs group. It does not wait for the
+ * jobs to complete.
+ *)
+and run_target group env = function
+ | Ast.EGoalDefn _ | Ast.EFuncDefn _ | Ast.ETacticDefn _ -> assert false
- (* Call a goal. *)
- | Ast.ECallGoal (loc, name, args) ->
- let goal = Ast.getgoal env loc name in
- run_goal env loc name args goal []
+ (* Call a goal or function. *)
+ | Ast.ECall (loc, name, args) ->
+ let expr = Ast.getvar env loc name in
+ (match expr with
+ | Ast.EGoalDefn (_, goal) ->
+ let key = name, args in
+ Jobs.start group key (
+ fun () -> run_goal env loc name args goal []
+ )
+ | Ast.EFuncDefn (_, func) ->
+ let expr = Eval.call_function env loc name args func in
+ run_target group env expr
+ | _ ->
+ failwithf "%a: tried to call ‘%s’ which is not a goal or a function"
+ Ast.string_loc loc name
+ )
(* Call a tactic. *)
| Ast.ETacticCtor (loc, name, args) ->
* (strings, in future booleans, numbers, etc).
*)
let args = List.map (Eval.to_constant env) args in
- run_tactic env loc name args
+ run_tactic group env loc name args
(* If this is a goal then it's the same as calling goal(). If not
* then look up the variable and substitute it.
| Ast.EVar (loc, name) ->
let expr = Ast.getvar env loc name in
(match expr with
- | EGoalDefn (loc, ([], _, _, _)) ->
- run_target env (Ast.ECallGoal (loc, name, []))
+ | Ast.EGoalDefn (loc, ([], _, _, _)) ->
+ run_target group env (Ast.ECall (loc, name, []))
| EGoalDefn _ ->
failwithf "%a: cannot call %s() since this goal has parameters"
Ast.string_loc loc name
| _ ->
- run_target env expr
+ run_target group env expr
)
(* Lists are inlined when found as a target. *)
| Ast.EList (loc, exprs) ->
- run_targets env exprs
+ run_targets group env exprs
(* A string (with or without substitutions) implies *file(filename). *)
| Ast.ESubsts (loc, str) ->
let str = Eval.substitute env loc str in
- run_tactic env loc "*file" [Ast.CString str]
+ run_tactic group env loc "*file" [Ast.CString str]
| Ast.EConstant (loc, c) ->
- run_tactic env loc "*file" [c]
+ run_tactic group env loc "*file" [c]
(* Run a goal by name. *)
and run_goal env loc name args (params, patterns, deps, code) extra_deps =
- Cmdline.debug "%a: running goal %s %a"
- Ast.string_loc loc name Ast.string_expr (Ast.EList (Ast.noloc, args));
+ (* This is used to print the goal in debug and error messages only. *)
+ let debug_goal =
+ sprintf "%s (%s)" name
+ (String.concat ", " (List.map (Ast.string_expr ()) args)) in
+ Cmdline.debug "%a: running goal %s" Ast.string_loc loc debug_goal;
(* This is the point where we evaluate the goal arguments. We must
* do this before creating the new environment, because variables
let params =
try List.combine params args
with Invalid_argument _ ->
- failwithf "%a: calling goal ‘%s’ with wrong number of arguments"
- Ast.string_loc loc name in
+ failwithf "%a: calling goal %s with wrong number of arguments, expecting %d args but got %d args"
+ Ast.string_loc loc debug_goal
+ (List.length params) (List.length args) in
List.fold_left (fun env (k, v) -> Ast.Env.add k v env) env params in
- (* Check all dependencies have been updated. *)
- run_targets env (deps @ extra_deps);
+ (* Check all dependencies have been updated. We must wait
+ * for these to complete before we can continue.
+ *)
+ run_targets_to_completion env (deps @ extra_deps);
(* Check if any target (ie. pattern) needs to be rebuilt.
* As with make, a goal with no targets is always run.
match deps with
| [] -> env
| d :: _ -> Ast.Env.add "^" d env in
- let code = Eval.to_shell_script env loc code in
- let code = "set -e\nset -x\n\n" ^ code in
- let r = Sys.command code in
- if r <> 0 then (
- eprintf "*** goal ‘%s’ failed with exit code %d\n" name r;
- exit 1
- );
+ let r = Eval.run_code env loc code in
+ if r <> 0 then
+ failwithf "goal ‘%s’ failed with exit code %d" name r;
(* Check all targets were updated after the code was
* run (else it's an error).
match pattern_still_needs_rebuild with
| None -> ()
| Some pattern ->
- failwithf "%a: goal ‘%s’ ran successfully but it did not rebuild %a"
- Ast.string_loc loc
- name
- Ast.string_pattern pattern
+ failwithf "%a: goal %s ran successfully but it did not rebuild %a"
+ Ast.string_loc loc debug_goal Ast.string_pattern pattern
)
)
* should be called with env containing the goal params, this
* should substitute any parameters in the tactic arguments.
*)
- let targs = List.map (Ast.substitute env loc) targs in
+ let targs = List.map (Eval.substitute env loc) targs in
let targs =
List.map (fun targ ->
Ast.EConstant (Ast.noloc, Ast.CString targ)) targs in
match deps with
| [] -> env
| d :: _ -> Ast.Env.add "^" d env in
- let code = Eval.to_shell_script env loc code in
- let code = "set -e\n" (*^ "set -x\n" *) ^ "\n" ^ code in
- let r = Sys.command code in
+ let r = Eval.run_code env loc code in
if r = 99 (* means "needs rebuild" *) then true
else if r = 0 (* means "doesn't need rebuild" *) then false
- else (
- eprintf "*** tactic ‘%s’ failed with exit code %d\n" tactic r;
- exit 1
- )
+ else
+ failwithf "tactic ‘%s’ failed with exit code %d" tactic r
-(* Find the goal which matches the given tactic and run it.
+(* Find the goal which matches the given tactic and start it.
* cargs is a list of parameters (all constants).
*)
-and run_tactic env loc tactic cargs =
- Cmdline.debug "%a: running tactic %s" Ast.string_loc loc tactic;
+and run_tactic group env loc tactic cargs =
+ (* This is used to print the tactic in debug and error messages only. *)
+ let debug_tactic =
+ Ast.string_expr ()
+ (Ast.ETacticCtor (loc, tactic,
+ List.map (fun c -> Ast.EConstant (loc, c)) cargs)) in
+ Cmdline.debug "%a: running tactic %s" Ast.string_loc loc debug_tactic;
(* Find all goals in the environment. Returns a list of (name, goal). *)
let goals =
*)
let targs = List.map (function Ast.CString s -> [Ast.SString s]) cargs in
let p = Ast.PTactic (loc, tactic, targs) in
- if needs_rebuild env loc [] [] p then (
- let t = Ast.ETacticCtor (loc, tactic,
- List.map (fun c -> Ast.EConstant (loc, c))
- cargs) in
- failwithf "%a: don't know how to build %a"
- Ast.string_loc loc Ast.string_expr t
- )
+ if needs_rebuild env loc [] [] p then
+ failwithf "%a: don't know how to build %s"
+ Ast.string_loc loc debug_tactic
| [_, name, goal, args] ->
(* Single goal matches, run it. *)
- run_goal env loc name args goal []
+ let key = name, args in
+ Jobs.start group key (
+ fun () -> run_goal env loc name args goal []
+ )
| goals ->
(* Two or more goals match. Only one must have a CODE section,
(g, extra_deps)
| _ :: _ ->
- failwithf "%a: multiple goals with {code} sections match tactic %s"
- Ast.string_loc loc tactic in
+ failwithf "%a: multiple goals found which match tactic %s, but more than one of these goals have {code} sections which is not allowed"
+ Ast.string_loc loc debug_tactic in
- run_goal env loc name args goal extra_deps
+ let key = name, args in
+ Jobs.start group key (fun () ->
+ run_goal env loc name args goal extra_deps
+ )
(* Test if pattern matches *tactic(cargs). If it does
* then we return Some args where args is the arguments that must
git.annexia.org / goals.git / blobdiff