src/eval.ml

   1 (* Goalfile evaluation
   2  * Copyright (C) 2019 Richard W.M. Jones
   3  * Copyright (C) 2019 Red Hat Inc.
   4  *
   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.
   9  *
  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.
  14  *
  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.
  18  *)
  19
  20 open Utils
  21
  22 let rec evaluate_targets env exprs =
  23   List.iter (evaluate_target env) exprs
  24
  25 and evaluate_target env = function
  26   | Ast.EGoal _ -> assert false
  27
  28   (* Call a goal. *)
  29   | Ast.ECall (loc, name, args) ->
  30      let goal = Ast.getgoal env loc name in
  31      run_goal env loc name args goal
  32
  33   | Ast.ETactic (loc, name, args) ->
  34      (* All parameters of tactics must be simple constant expressions
  35       * (strings, in future booleans, numbers, etc).
  36       *)
  37      let args = List.map (Ast.to_constant env) args in
  38      run_tactic env loc name args
  39
  40   (* Look up the variable and substitute it. *)
  41   | Ast.EVar (loc, name) ->
  42      let expr = Ast.getvar env loc name in
  43      evaluate_target env expr
  44
  45   (* Lists are inlined when found as a target. *)
  46   | Ast.EList (loc, exprs) ->
  47      evaluate_targets env exprs
  48
  49   (* A string (with or without substitutions) implies *file(filename). *)
  50   | Ast.ESubsts (loc, str) ->
  51      let str = Ast.substitute env loc str in
  52      run_tactic env loc "file" [Ast.CString str]
  53
  54   | Ast.EConstant (loc, c) ->
  55      run_tactic env loc "file" [c]
  56
  57 (* Run a goal by name. *)
  58 and run_goal env loc name args (params, patterns, deps, code) =
  59   (* Create a new environment which maps the parameter names to
  60    * the args.
  61    *)
  62   let env =
  63     let params =
  64       try List.combine params args
  65       with Invalid_argument _ ->
  66         failwithf "%a: calling goal ‘%s’ with wrong number of arguments"
  67           Ast.string_loc loc name in
  68     List.fold_left (fun env (k, v) -> Ast.Env.add k v env) env params in
  69
  70   (* Check all dependencies have been updated. *)
  71   evaluate_targets env deps;
  72
  73   (* Check if any target (ie. pattern) needs to be rebuilt. *)
  74   let rebuild = List.exists (needs_rebuild env loc deps) patterns in
  75
  76   if rebuild then (
  77     (* Run the code (if any). *)
  78     (match code with
  79      | None -> ()
  80      | Some code ->
  81         (* Add some standard variables to the environment. *)
  82         let expr_of_substs s = Ast.ESubsts (Ast.noloc, s) in
  83         let expr_of_pattern = function
  84           | Ast.PTactic (loc, tactic, targs) ->
  85              Ast.ETactic (loc, tactic, List.map expr_of_substs targs)
  86           | Ast.PVar (loc, name) ->
  87              Ast.EVar (loc, name)
  88         in
  89         let pexprs = List.map expr_of_pattern patterns in
  90         let env = Ast.Env.add "@" (Ast.EList (Ast.noloc, pexprs)) env in
  91         let env = Ast.Env.add "<" (Ast.EList (Ast.noloc, deps)) env in
  92         let env =
  93           match deps with
  94           | [] -> env
  95           | d :: _ -> Ast.Env.add "^" d env in
  96         let code = Ast.to_shell_script env loc code in
  97         Printf.printf "running : %s\n" code
  98     );
  99
 100     (* Check all targets were updated (else it's an error). *)
 101     let pattern_still_needs_rebuild =
 102       try Some (List.find (needs_rebuild env loc deps) patterns)
 103       with Not_found -> None in
 104     match pattern_still_needs_rebuild with
 105     | None -> ()
 106     | Some pattern ->
 107        failwithf "%a: goal ‘%s’ ran successfully but it did not rebuild %a"
 108          Ast.string_loc loc
 109          name
 110          Ast.string_pattern pattern
 111   )
 112
 113 (* Return whether the target (pattern) needs to be rebuilt. *)
 114 and needs_rebuild env loc deps pattern =
 115   match pattern with
 116   | Ast.PTactic (loc, tactic, targs) ->
 117      (* Resolve the targs down to constants. *)
 118      let targs = List.map ((* XXX Ast.to_shell_script *)
 119                             Ast.substitute env loc) targs in
 120      (* XXX Look up the tactic.
 121       * We would do that, but for now hard code the *file tactic. XXX
 122       *)
 123      assert (tactic = "file");
 124      assert (List.length targs = 1);
 125      let targ = List.hd targs in
 126      not (Sys.file_exists targ)
 127   | Ast.PVar _ -> assert false (* XXX not implemented *)
 128
 129 (* Find the goal which matches the given tactic and run it.
 130  * cargs is a list of parameters (all constants).
 131  *)
 132 and run_tactic env loc tactic cargs =
 133   (* Find all goals in the environment.  Returns a list of (name, goal). *)
 134   let goals =
 135     let env = Ast.Env.bindings env in
 136     filter_map
 137       (function
 138        | name, Ast.EGoal (loc, goal) -> Some (name, goal)
 139        | _ -> None) env in
 140
 141   (* Find all patterns.  Returns a list of (pattern, name, goal). *)
 142   let patterns : (Ast.pattern * Ast.id * Ast.goal) list =
 143     List.flatten
 144       (List.map (fun (name, ((_, patterns, _, _) as goal)) ->
 145            List.map (fun pattern -> (pattern, name, goal)) patterns) goals) in
 146
 147   (* Find any patterns (ie. tactics) which match the one we
 148    * are searching for.  This returns a binding for the goal args,
 149    * so we end up with a list of (pattern, name, goal, args).
 150    *)
 151   let patterns : (Ast.pattern * Ast.id * Ast.goal * Ast.expr list) list =
 152     filter_map (
 153       fun (pattern, name, ((params, _, _, _) as goal)) ->
 154         match matching_pattern env loc tactic cargs pattern params with
 155         | None -> None
 156         | Some args -> Some (pattern, name, goal, args)
 157     ) patterns in
 158
 159   match patterns with
 160   | [_, name, goal, args] ->
 161      run_goal env loc name args goal
 162
 163   | [] ->
 164      (* There's no matching goal, but we don't need one if
 165       * the tactic doesn't need to be rebuilt.
 166       *)
 167      let targs = List.map (function Ast.CString s -> [Ast.SString s]) cargs in
 168      let p = Ast.PTactic (loc, tactic, targs) in
 169      if needs_rebuild env loc [] p then (
 170        let t = Ast.ETactic (loc, tactic,
 171                             List.map (fun c -> Ast.EConstant (loc, c))
 172                               cargs) in
 173        failwithf "%a: don't know how to build %a"
 174          Ast.string_loc loc Ast.string_expr t
 175      )
 176
 177   | _ ->
 178      (* If there are multiple matching goals, then assuming the goals
 179       * are different we must pick the one which was defined last in
 180       * the file.  However we don't do that right now. XXX
 181       *)
 182      assert false (* TODO! *)
 183
 184 (* Test if pattern matches *tactic(cargs).  If it does
 185  * then we return Some args where args is the arguments that must
 186  * be passed to the matching goal.  The params parameter is
 187  * the names of the parameters of that goal.
 188  *)
 189 and matching_pattern env loc tactic cargs pattern params =
 190   match pattern with
 191   | Ast.PVar (loc, name) -> assert false (* TODO! *)
 192   | Ast.PTactic (loc, ttactic, targs)
 193        when tactic <> ttactic ||
 194             List.length cargs <> List.length targs ->
 195      None (* Can't possibly match if tactic name or #args is different. *)
 196   | Ast.PTactic (loc, ttactic, targs) ->
 197      (* Do the args match with a possible params binding? *)
 198      try Some (matching_params env loc params targs cargs)
 199      with Not_found -> None
 200
 201 (* Return a possible binding.  For example the goal is:
 202  *   goal compile (name) = "%name.o": "%name.c" {}
 203  * which means that params = ["name"] and targs = ["%name.o"].
 204  *
 205  * If we are called with cargs = ["file1.o"], we would
 206  * return ["file1"].
 207  *
 208  * On non-matching this raises Not_found.
 209  *)
 210 and matching_params env loc params targs cargs =
 211   (* This is going to record the resulting binding. *)
 212   let res = ref Ast.Env.empty in
 213   List.iter2 (matching_param env loc params res) targs cargs;
 214
 215   (* Rearrange the result into goal parameter order.  Also this
 216    * checks that every parameter got a binding.
 217    *)
 218   let res = !res in
 219   List.map (
 220     (* Allow the Not_found exception to escape if no binding for this param. *)
 221     fun param -> Ast.Env.find param res
 222   ) params
 223
 224 (* If targ = "%name.o" and carg = "file.o" then this would set
 225  * name => "file" in !res.  If they don't match, raises Not_found.
 226  *)
 227 and matching_param env loc params res targ carg =
 228   match carg with
 229   | Ast.CString carg ->
 230      (* Substitute any non parameters in targ from the environment. *)
 231      let targ =
 232        List.map (
 233          function
 234          | Ast.SString _ as s -> s
 235          | Ast.SVar name ->
 236             if not (List.mem name params) then (
 237               try
 238                 let expr = Ast.getvar env loc name in
 239                 match Ast.to_constant env expr with
 240                 | Ast.CString s -> Ast.SString s
 241               with Failure _ -> raise Not_found
 242             )
 243             else
 244               Ast.SVar name
 245        ) targ in
 246
 247      (* Do the actual pattern matching.  Any remaining SVar elements
 248       * must refer to goal parameters.
 249       *)
 250      let carg = ref carg in
 251      let rec loop = function
 252        | [] ->
 253           (* End of targ, we must have matched all of carg. *)
 254           if !carg <> "" then raise Not_found
 255        | Ast.SString s :: rest ->
 256           (* Does this match the first part of !carg? *)
 257           let clen = String.length !carg in
 258           let slen = String.length s in
 259           if slen > clen || s <> String.sub !carg 0 slen then
 260             raise Not_found;
 261           (* Yes, so continue after the matching prefix. *)
 262           carg := String.sub !carg slen (clen-slen);
 263           loop rest
 264        | Ast.SVar name :: Ast.SString s :: rest ->
 265           (* This is a goal parameter.  Find s later in !carg. *)
 266           let i = string_find !carg s in
 267           if i = -1 then raise Not_found;
 268           (* Set the binding in !res. *)
 269           let r = Ast.EConstant (Ast.noloc,
 270                                  Ast.CString (String.sub !carg 0 i)) in
 271           res := Ast.Env.add name r !res;
 272           (* Continue after the match. *)
 273           let skip = i + String.length s in
 274           carg := String.sub !carg skip (String.length !carg - skip);
 275           loop rest
 276        | Ast.SVar name :: [] ->
 277           (* Matches the whole remainder of the string. *)
 278           let r = Ast.EConstant (Ast.noloc, Ast.CString !carg) in
 279           res := Ast.Env.add name r !res
 280        | Ast.SVar x :: Ast.SVar y :: _ ->
 281           (* TODO! We cannot match a target like "%x%y". *)
 282           assert false
 283      in
 284      loop targ