Release coccinelle-0.2.3rc1
[bpt/coccinelle.git] / parsing_cocci / get_constants2.ml
index 93e9ea6..c3406e6 100644 (file)
@@ -1,23 +1,45 @@
 (*
-* Copyright 2005-2009, Ecole des Mines de Nantes, University of Copenhagen
-* Yoann Padioleau, Julia Lawall, Rene Rydhof Hansen, Henrik Stuart, Gilles Muller
-* This file is part of Coccinelle.
-* 
-* Coccinelle is free software: you can redistribute it and/or modify
-* it under the terms of the GNU General Public License as published by
-* the Free Software Foundation, according to version 2 of the License.
-* 
-* Coccinelle is distributed in the hope that it will be useful,
-* but WITHOUT ANY WARRANTY; without even the implied warranty of
-* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-* GNU General Public License for more details.
-* 
-* You should have received a copy of the GNU General Public License
-* along with Coccinelle.  If not, see <http://www.gnu.org/licenses/>.
-* 
-* The authors reserve the right to distribute this or future versions of
-* Coccinelle under other licenses.
-*)
+ * Copyright 2005-2010, Ecole des Mines de Nantes, University of Copenhagen
+ * Yoann Padioleau, Julia Lawall, Rene Rydhof Hansen, Henrik Stuart, Gilles Muller, Nicolas Palix
+ * This file is part of Coccinelle.
+ *
+ * Coccinelle is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, according to version 2 of the License.
+ *
+ * Coccinelle is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Coccinelle.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * The authors reserve the right to distribute this or future versions of
+ * Coccinelle under other licenses.
+ *)
+
+
+(*
+ * Copyright 2005-2010, Ecole des Mines de Nantes, University of Copenhagen
+ * Yoann Padioleau, Julia Lawall, Rene Rydhof Hansen, Henrik Stuart, Gilles Muller, Nicolas Palix
+ * This file is part of Coccinelle.
+ *
+ * Coccinelle is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, according to version 2 of the License.
+ *
+ * Coccinelle is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Coccinelle.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * The authors reserve the right to distribute this or future versions of
+ * Coccinelle under other licenses.
+ *)
 
 
 module Ast = Ast_cocci
@@ -47,7 +69,7 @@ wanted *)
 type combine =
     And of combine list | Or of combine list | Elem of string | False | True
 
-let interpret strict x =
+let interpret_glimpse strict x =
   let rec loop = function
       Elem x -> x
     | And [x] -> loop x
@@ -63,12 +85,45 @@ let interpret strict x =
     True -> None
   | False when strict ->
       failwith "False should not be in the final result.  Perhaps your rule doesn't contain any +/-/* code"
-  | _ -> Some (loop x)
+  | _ -> Some [(loop x)]
+
+let interpret_google strict x =
+  (* convert to dnf *)
+  let rec dnf = function
+      Elem x -> [x]
+    | Or l -> List.fold_left Common.union_set [] (List.map dnf l)
+    | And l ->
+       let l = List.map dnf l in
+       List.fold_left
+         (function prev ->
+           function cur ->
+             List.fold_left Common.union_set []
+               (List.map
+                  (function x ->
+                    List.map (function y -> Printf.sprintf "%s %s" x y) prev)
+                  cur))
+         [] l
+    | True -> ["True"]
+    | False ->
+       if strict
+       then failwith "False should not be in the final result.  Perhaps your rule doesn't contain any +/-/* code"
+       else ["False"] in
+  match x with
+    True -> None
+  | False when strict ->
+      failwith "False should not be in the final result.  Perhaps your rule doesn't contain any +/-/* code"
+  | _ -> Some (dnf x)
+
+let interpret strict x =
+  match !Flag.scanner with
+    Flag.Glimpse -> interpret_glimpse strict x
+  | Flag.Google _ -> interpret_google strict x
+  | _ -> failwith "not possible"
 
 let combine2c x =
   match interpret false x with
     None -> "None"
-  | Some x -> x
+  | Some x -> String.concat " || " x
 
 let norm = function
     And l -> And (List.sort compare l)
@@ -158,9 +213,11 @@ let do_get_constants constants keywords env neg_pos =
   let option_default = True in
   let bind = build_and in
   let inherited ((nm1,_) as x) =
+    (* ignore virtuals *)
+    if nm1 = "virtual" then option_default
     (* perhaps inherited, but value not required, so no constraints *)
-    if List.mem x neg_pos then option_default
-    else try List.assoc nm1 env with Not_found -> False in
+    else if List.mem x neg_pos then option_default
+    else (try List.assoc nm1 env with Not_found -> False) in
   let minherited name = inherited (Ast.unwrap_mcode name) in
   let mcode _ x =
     match Ast.get_pos_var x with
@@ -184,7 +241,8 @@ let do_get_constants constants keywords env neg_pos =
   let rec type_collect res = function
       TC.ConstVol(_,ty) | TC.Pointer(ty) | TC.FunctionPointer(ty)
     | TC.Array(ty) -> type_collect res ty
-    | TC.MetaType(tyname,_,_) -> inherited tyname
+    | TC.MetaType(tyname,_,_) ->
+       inherited tyname
     | TC.TypeName(s) -> constants s
     | TC.EnumName(false,s) -> constants s
     | TC.StructUnionName(_,false,s) -> constants s
@@ -199,12 +257,10 @@ let do_get_constants constants keywords env neg_pos =
          (match Ast.unwrap_mcode const with
            Ast.String s -> constants s
          | Ast.Char "\\0" -> option_default (* glimpse doesn't like it *)
-         | Ast.Char s -> constants s
+         | Ast.Char s -> option_default (* probably not chars either *)
          (* the following were eg keywords "1", but not good for glimpse *)
-         | Ast.Int "0" -> option_default (* glimpse doesn't like it *)
-         | Ast.Int "1" -> option_default (* glimpse doesn't like it *)
-         | Ast.Int s -> constants s
-         | Ast.Float s -> constants s)
+         | Ast.Int s -> option_default (* glimpse doesn't index integers *)
+         | Ast.Float s -> option_default (* probably not floats either *))
     | Ast.MetaExpr(name,_,_,Some type_list,_,_) ->
        let types = List.fold_left type_collect option_default type_list in
        bind (k e) (bind (minherited name) types)
@@ -215,8 +271,8 @@ let do_get_constants constants keywords env neg_pos =
        bind (k e) (bind (minherited name) (minherited lenname))
     | Ast.SizeOfExpr(sizeof,exp) -> bind (keywords "sizeof") (k e)
     | Ast.SizeOfType(sizeof,lp,ty,rp) -> bind (keywords "sizeof") (k e)
-    | Ast.NestExpr(expr_dots,wc,false) -> option_default
-    | Ast.NestExpr(expr_dots,wc,true) ->
+    | Ast.NestExpr(starter,expr_dots,ender,wc,false) -> option_default
+    | Ast.NestExpr(starter,expr_dots,ender,wc,true) ->
        r.V.combiner_expression_dots expr_dots
     | Ast.DisjExpr(exps) ->
        disj_union_all (List.map r.V.combiner_expression exps)
@@ -313,8 +369,8 @@ let do_get_constants constants keywords env neg_pos =
     match Ast.unwrap s with
       Ast.Disj(stmt_dots) ->
        disj_union_all (List.map r.V.combiner_statement_dots stmt_dots)
-    | Ast.Nest(stmt_dots,whn,false,_,_) -> option_default
-    | Ast.Nest(stmt_dots,whn,true,_,_) ->
+    | Ast.Nest(starter,stmt_dots,ender,whn,false,_,_) -> option_default
+    | Ast.Nest(starter,stmt_dots,ender,whn,true,_,_) ->
        r.V.combiner_statement_dots stmt_dots
     | Ast.OptStm(s) -> option_default
     | Ast.Dots(d,whn,_,_) | Ast.Circles(d,whn,_,_) | Ast.Stars(d,whn,_,_) ->
@@ -377,9 +433,9 @@ let get_plus_constants =
        [] l in
     match mcodekind with
       Ast.MINUS(_,_,_,anythings) -> recurse anythings
-    | Ast.CONTEXT(_,Ast.BEFORE(a)) -> recurse a
-    | Ast.CONTEXT(_,Ast.AFTER(a)) -> recurse a
-    | Ast.CONTEXT(_,Ast.BEFOREAFTER(a1,a2)) ->
+    | Ast.CONTEXT(_,Ast.BEFORE(a,_)) -> recurse a
+    | Ast.CONTEXT(_,Ast.AFTER(a,_)) -> recurse a
+    | Ast.CONTEXT(_,Ast.BEFOREAFTER(a1,a2,_)) ->
        Common.union_set (recurse a1) (recurse a2)
     | _ -> [] in
 
@@ -400,6 +456,7 @@ let rec dependencies env = function
   | Ast.AndDep (d1,d2) -> build_and (dependencies env d1) (dependencies env d2)
   | Ast.OrDep (d1,d2) -> build_or (dependencies env d1) (dependencies env d2)
   | Ast.NoDep -> True
+  | Ast.FailDep -> False
 
 (* ------------------------------------------------------------------------ *)
 
@@ -427,7 +484,8 @@ let rule_fn tls in_plus env neg_pos =
     (function (rest_info,in_plus) ->
       function (cur,neg_pos) ->
        let minuses =
-         (do_get_constants keep drop env neg_pos).V.combiner_top_level cur in
+         let getter = do_get_constants keep drop env neg_pos in
+         getter.V.combiner_top_level cur in
        let all_minuses =
          if !Flag.sgrep_mode2
          then [] (* nothing removed for sgrep *)
@@ -447,9 +505,8 @@ let rule_fn tls in_plus env neg_pos =
           minirules anymore anyway. *)
        match new_minuses with
          True ->
-           let retry =
-             (do_get_constants drop keep env neg_pos).V.combiner_top_level
-               cur in
+           let getter = do_get_constants drop keep env neg_pos in
+           let retry = getter.V.combiner_top_level cur in
            (match retry with
              True when not was_bot -> (rest_info, new_plusses)
            | x -> (build_or x rest_info, new_plusses))
@@ -457,37 +514,45 @@ let rule_fn tls in_plus env neg_pos =
     (False,in_plus) (List.combine tls neg_pos)
 
 let get_constants rules neg_pos_vars =
-  if not !Flag.use_glimpse
-  then None
-  else
-    let (info,_,_,_) =
-      List.fold_left
-       (function (rest_info,in_plus,env,locals(*dom of env*)) ->
-          function
-              (Ast.ScriptRule (_,deps,mv,_),_) ->
-               let extra_deps =
-                 List.fold_left
-                   (function prev ->
-                     function (_,(rule,_)) -> Ast.AndDep (Ast.Dep rule,prev))
-                   deps mv in
-               (match dependencies env extra_deps with
-                 False -> (rest_info, in_plus, env, locals)
-               | dependencies ->
-                   (build_or dependencies rest_info, in_plus, env, locals))
-            | (Ast.InitialScriptRule (_,_),_)
-           | (Ast.FinalScriptRule (_,_),_) -> (rest_info,in_plus,env,locals)
-            | (Ast.CocciRule (nm,(dep,_,_),cur,_,_),neg_pos_vars) ->
-               let (cur_info,cur_plus) =
-                 rule_fn cur in_plus ((nm,True)::env) neg_pos_vars in
-               if List.for_all all_context.V.combiner_top_level cur
-               then (rest_info,cur_plus,(nm,cur_info)::env,nm::locals)
-               else
-              (* no constants if dependent on another rule; then we need to
-                 find the constants of that rule *)
-                 match dependencies env dep with
+  match !Flag.scanner with
+    Flag.NoScanner -> None
+  | Flag.Glimpse | Flag.Google _ ->
+      let (info,_,_,_) =
+       List.fold_left
+         (function (rest_info,in_plus,env,locals(*dom of env*)) ->
+            function
+               (Ast.ScriptRule (_,deps,mv,_),_) ->
+                 let extra_deps =
+                   List.fold_left
+                     (function prev ->
+                       function (_,(rule,_)) ->
+                         if rule = "virtual"
+                         then prev
+                         else Ast.AndDep (Ast.Dep rule,prev))
+                     deps mv in
+                 (match dependencies env extra_deps with
+                   False -> (rest_info, in_plus, env, locals)
+                 | dependencies ->
+                     (build_or dependencies rest_info, in_plus, env, locals))
+              | (Ast.InitialScriptRule (_,deps,_),_)
+             | (Ast.FinalScriptRule (_,deps,_),_) ->
+                 (* initialize and finalize dependencies are irrelevant to
+                    get_constants *)
+                 (rest_info, in_plus, env, locals)
+              | (Ast.CocciRule (nm,(dep,_,_),cur,_,_),neg_pos_vars) ->
+                 let (cur_info,cur_plus) =
+                   rule_fn cur in_plus ((nm,True)::env)
+                     neg_pos_vars in
+                 (match dependencies env dep with
                    False -> (rest_info,cur_plus,env,locals)
                  | dependencies ->
-                     (build_or (build_and dependencies cur_info) rest_info,
-                      cur_plus,env,locals))
-       (False,[],[],[]) (List.combine (rules : Ast.rule list) neg_pos_vars) in
-    interpret true info
+                     if List.for_all all_context.V.combiner_top_level cur
+                     then (rest_info,cur_plus,(nm,cur_info)::env,nm::locals)
+                     else
+              (* no constants if dependent on another rule; then we need to
+                 find the constants of that rule *)
+                       (build_or (build_and dependencies cur_info) rest_info,
+                        cur_plus,env,locals)))
+         (False,[],[],[])
+         (List.combine (rules : Ast.rule list) neg_pos_vars) in
+      interpret true info