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 =
  75     List.exists (needs_rebuild env loc name deps) patterns in
  76
  77   if rebuild then (
  78     (* Run the code (if any). *)
  79     (match code with
  80      | None -> ()
  81      | Some code ->
  82         let code = Ast.substitute env loc code in
  83         Printf.printf "running : %s\n" code
  84     );
  85
  86     (* Check all targets were updated (else it's an error). *)
  87     let pattern_still_needs_rebuild =
  88       try Some (List.find (needs_rebuild env loc name deps) patterns)
  89       with Not_found -> None in
  90     match pattern_still_needs_rebuild with
  91     | None -> ()
  92     | Some pattern ->
  93        failwithf "%a: goal ‘%s’ ran successfully but it did not rebuild %a"
  94          Ast.string_loc loc
  95          name
  96          Ast.string_pattern pattern
  97   )
  98
  99 (* Return whether the target (pattern) needs to be rebuilt. *)
 100 and needs_rebuild env loc name deps pattern =
 101   false (* XXX *)
 102
 103 (* Find the goal which matches the given tactic and run it.
 104  * cargs is a list of parameters (all constants).
 105  *)
 106 and run_tactic env loc tactic cargs =
 107   (* Find all goals in the environment.  Returns a list of (name, goal). *)
 108   let goals =
 109     let env = Ast.Env.bindings env in
 110     filter_map
 111       (function
 112        | name, Ast.EGoal (loc, goal) -> Some (name, goal)
 113        | _ -> None) env in
 114
 115   (* Find all patterns.  Returns a list of (pattern, name, goal). *)
 116   let patterns : (Ast.pattern * Ast.id * Ast.goal) list =
 117     List.flatten
 118       (List.map (fun (name, ((_, patterns, _, _) as goal)) ->
 119            List.map (fun pattern -> (pattern, name, goal)) patterns) goals) in
 120
 121   (* Find any patterns (ie. tactics) which match the one we
 122    * are searching for.  This returns a binding for the goal args,
 123    * so we end up with a list of (pattern, name, goal, args).
 124    *)
 125   let patterns : (Ast.pattern * Ast.id * Ast.goal * Ast.expr list) list =
 126     filter_map (
 127       fun (pattern, name, ((params, _, _, _) as goal)) ->
 128         match matching_pattern env loc tactic cargs pattern params with
 129         | None -> None
 130         | Some args -> Some (pattern, name, goal, args)
 131     ) patterns in
 132
 133   let _, name, goal, args =
 134     match patterns with
 135     | [p] -> p
 136     | [] ->
 137        let t = Ast.ETactic (loc, tactic,
 138                             List.map (fun c -> Ast.EConstant (loc, c))
 139                               cargs) in
 140        failwithf "%a: don't know how to build %a"
 141          Ast.string_loc loc Ast.string_expr t
 142     | _ ->
 143        (* If there are multiple matching goals, then assuming the goals
 144         * are different we must pick the one which was defined last in
 145         * the file.  However we don't do that right now. XXX
 146         *)
 147        assert false (* TODO! *) in
 148
 149   run_goal env loc name args goal
 150
 151 (* Test if pattern matches *tactic(cargs).  If it does
 152  * then we return Some args where args is the arguments that must
 153  * be passed to the matching goal.  The params parameter is
 154  * the names of the parameters of that goal.
 155  *)
 156 and matching_pattern env loc tactic cargs pattern params =
 157   match pattern with
 158   | Ast.PVar (loc, name) -> assert false (* TODO! *)
 159   | Ast.PTactic (loc, ttactic, targs)
 160        when tactic <> ttactic ||
 161             List.length cargs <> List.length targs ->
 162      None (* Can't possibly match if tactic name or #args is different. *)
 163   | Ast.PTactic (loc, ttactic, targs) ->
 164      (* Do the args match with a possible params binding? *)
 165      try Some (matching_params env loc params targs cargs)
 166      with Not_found -> None
 167
 168 (* Return a possible binding.  For example the goal is:
 169  *   goal compile (name) = "%name.o": "%name.c" {}
 170  * which means that params = ["name"] and targs = ["%name.o"].
 171  *
 172  * If we are called with cargs = ["file1.o"], we would
 173  * return ["file1"].
 174  *
 175  * On non-matching this raises Not_found.
 176  *)
 177 and matching_params env loc params targs cargs =
 178   (* This is going to record the resulting binding. *)
 179   let res = ref Ast.Env.empty in
 180   List.iter2 (matching_param env loc params res) targs cargs;
 181
 182   (* Rearrange the result into goal parameter order.  Also this
 183    * checks that every parameter got a binding.
 184    *)
 185   let res = !res in
 186   List.map (
 187     (* Allow the Not_found exception to escape if no binding for this param. *)
 188     fun param -> Ast.Env.find param res
 189   ) params
 190
 191 (* If targ = "%name.o" and carg = "file.o" then this would set
 192  * name => "file" in !res.  If they don't match, raises Not_found.
 193  *)
 194 and matching_param env loc params res targ carg =
 195   match carg with
 196   | Ast.CString carg ->
 197      (* Substitute any non parameters in targ from the environment. *)
 198      let targ =
 199        List.map (
 200          function
 201          | Ast.SString _ as s -> s
 202          | Ast.SVar name ->
 203             if not (List.mem name params) then (
 204               try
 205                 let expr = Ast.getvar env loc name in
 206                 match Ast.to_constant env expr with
 207                 | Ast.CString s -> Ast.SString s
 208               with Failure _ -> raise Not_found
 209             )
 210             else
 211               Ast.SVar name
 212        ) targ in
 213
 214      (* Do the actual pattern matching.  Any remaining SVar elements
 215       * must refer to goal parameters.
 216       *)
 217      let carg = ref carg in
 218      let rec loop = function
 219        | [] ->
 220           (* End of targ, we must have matched all of carg. *)
 221           if !carg <> "" then raise Not_found
 222        | Ast.SString s :: rest ->
 223           (* Does this match the first part of !carg? *)
 224           let clen = String.length !carg in
 225           let slen = String.length s in
 226           if slen > clen || s <> String.sub !carg 0 slen then
 227             raise Not_found;
 228           (* Yes, so continue after the matching prefix. *)
 229           carg := String.sub !carg slen (clen-slen);
 230           loop rest
 231        | Ast.SVar name :: Ast.SString s :: rest ->
 232           (* This is a goal parameter.  Find s later in !carg. *)
 233           let i = string_find !carg s in
 234           if i = -1 then raise Not_found;
 235           (* Set the binding in !res. *)
 236           let r = Ast.EConstant (Ast.noloc,
 237                                  Ast.CString (String.sub !carg 0 i)) in
 238           res := Ast.Env.add name r !res;
 239           (* Continue after the match. *)
 240           let skip = i + String.length s in
 241           carg := String.sub !carg skip (String.length !carg - skip);
 242           loop rest
 243        | Ast.SVar name :: [] ->
 244           (* Matches the whole remainder of the string. *)
 245           let r = Ast.EConstant (Ast.noloc, Ast.CString !carg) in
 246           res := Ast.Env.add name r !res
 247        | Ast.SVar x :: Ast.SVar y :: _ ->
 248           (* TODO! We cannot match a target like "%x%y". *)
 249           assert false
 250      in
 251      loop targ