Release coccinelle-0.2.0rc1
[bpt/coccinelle.git] / parsing_cocci / parse_cocci.ml
index 2f552e4..f50d505 100644 (file)
@@ -1,25 +1,3 @@
-(*
-* 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.
-*)
-
-
 (* splits the entire file into minus and plus fragments, and parses each
 separately (thus duplicating work for the parsing of the context elements) *)
 
@@ -46,6 +24,7 @@ let line_type2c tok =
   match line_type tok with
     D.MINUS | D.OPTMINUS | D.UNIQUEMINUS -> ":-"
   | D.PLUS -> ":+"
+  | D.PLUSPLUS -> ":++"
   | D.CONTEXT | D.UNIQUE | D.OPT -> ""
 
 let token2c (tok,_) =
@@ -73,6 +52,7 @@ let token2c (tok,_) =
   | PC.TName -> "name"
   | PC.TRuleName str -> "rule_name-"^str
   | PC.TUsing -> "using"
+  | PC.TVirtual -> "virtual"
   | PC.TPathIsoFile str -> "path_iso_file-"^str
   | PC.TDisable -> "disable"
   | PC.TExtends -> "extends"
@@ -154,6 +134,8 @@ let token2c (tok,_) =
   | PC.TAnd (clt) -> "&"^(line_type2c clt)
   | PC.TEqEq(clt) -> "=="^(line_type2c clt)
   | PC.TNotEq(clt) -> "!="^(line_type2c clt)
+  | PC.TTildeEq(clt) -> "~="^(line_type2c clt)
+  | PC.TTildeExclEq(clt) -> "~!="^(line_type2c clt)
   | PC.TLogOp(op,clt) ->
       (match op with
        Ast.Inf -> "<"
@@ -300,7 +282,7 @@ let plus_attachable only_plus (tok,_) =
   | PC.TString(_,clt) | PC.TChar(_,clt) | PC.TFloat(_,clt) | PC.TInt(_,clt)
 
   | PC.TOrLog(clt) | PC.TAndLog(clt) | PC.TOr(clt) | PC.TXor(clt)
-  | PC.TAnd (clt) | PC.TEqEq(clt) | PC.TNotEq(clt) | PC.TLogOp(_,clt)
+  | PC.TAnd (clt) | PC.TEqEq(clt) | PC.TNotEq(clt) | PC.TTildeEq(clt) | PC.TLogOp(_,clt)
   | PC.TShOp(_,clt) | PC.TPlus(clt) | PC.TMinus(clt) | PC.TMul(clt)
   | PC.TDmOp(_,clt) | PC.TTilde (clt)
 
@@ -328,7 +310,7 @@ let plus_attachable only_plus (tok,_) =
 
   | PC.TEq(clt) | PC.TAssign(_,clt) | PC.TDot(clt) | PC.TComma(clt)
   | PC.TPtVirg(clt) ->
-      if line_type clt = D.PLUS
+      if List.mem (line_type clt) [D.PLUS;D.PLUSPLUS]
       then PLUS
       else if only_plus then NOTPLUS
       else if line_type clt = D.CONTEXT then PLUS else NOTPLUS
@@ -365,7 +347,7 @@ let get_clt (tok,_) =
   | PC.TString(_,clt) | PC.TChar(_,clt) | PC.TFloat(_,clt) | PC.TInt(_,clt)
 
   | PC.TOrLog(clt) | PC.TAndLog(clt) | PC.TOr(clt) | PC.TXor(clt)
-  | PC.TAnd (clt) | PC.TEqEq(clt) | PC.TNotEq(clt) | PC.TLogOp(_,clt)
+  | PC.TAnd (clt) | PC.TEqEq(clt) | PC.TNotEq(clt) | PC.TTildeEq(clt) | PC.TLogOp(_,clt)
   | PC.TShOp(_,clt) | PC.TPlus(clt) | PC.TMinus(clt) | PC.TMul(clt)
   | PC.TDmOp(_,clt) | PC.TTilde (clt)
 
@@ -466,6 +448,7 @@ let update_clt (tok,x) clt =
   | PC.TAnd (_) -> (PC.TAnd (clt),x)
   | PC.TEqEq(_) -> (PC.TEqEq(clt),x)
   | PC.TNotEq(_) -> (PC.TNotEq(clt),x)
+  | PC.TTildeEq(_) -> (PC.TTildeEq(clt),x)
   | PC.TLogOp(op,_) -> (PC.TLogOp(op,clt),x)
   | PC.TShOp(op,_) -> (PC.TShOp(op,clt),x)
   | PC.TPlus(_) -> (PC.TPlus(clt),x)
@@ -588,7 +571,7 @@ let split t clt =
   let (d,_,_,_,_,_,_,_) = clt in
   match d with
     D.MINUS | D.OPTMINUS | D.UNIQUEMINUS -> ([t],[])
-  | D.PLUS -> ([],[t])
+  | D.PLUS | D.PLUSPLUS -> ([],[t])
   | D.CONTEXT | D.UNIQUE | D.OPT -> ([t],[t])
 
 let split_token ((tok,_) as t) =
@@ -598,8 +581,8 @@ let split_token ((tok,_) as t) =
   | PC.TFunction | PC.TTypedef | PC.TDeclarer | PC.TIterator | PC.TName
   | PC.TType | PC.TParameter | PC.TLocal | PC.Tlist | PC.TFresh
   | PC.TCppConcatOp | PC.TPure
-  | PC.TContext | PC.TRuleName(_) | PC.TUsing | PC.TDisable | PC.TExtends
-  | PC.TPathIsoFile(_)
+  | PC.TContext | PC.TRuleName(_) | PC.TUsing | PC.TVirtual | PC.TDisable
+  | PC.TExtends | PC.TPathIsoFile(_)
   | PC.TDepends | PC.TOn | PC.TEver | PC.TNever | PC.TExists | PC.TForall
   | PC.TError | PC.TWords | PC.TGenerated | PC.TNothing -> ([t],[t])
 
@@ -658,7 +641,7 @@ let split_token ((tok,_) as t) =
       split t clt
 
   | PC.TOrLog(clt) | PC.TAndLog(clt) | PC.TOr(clt) | PC.TXor(clt)
-  | PC.TAnd (clt) | PC.TEqEq(clt) | PC.TNotEq(clt) | PC.TLogOp(_,clt)
+  | PC.TAnd (clt) | PC.TEqEq(clt) | PC.TNotEq(clt) | PC.TTildeEq(clt) | PC.TTildeExclEq(clt) | PC.TLogOp(_,clt)
   | PC.TShOp(_,clt) | PC.TPlus(clt) | PC.TMinus(clt) | PC.TMul(clt)
   | PC.TDmOp(_,clt) | PC.TTilde (clt) -> split t clt
 
@@ -1101,7 +1084,7 @@ let minus_to_nothing l =
       let (d,_,_,_,_,_,_,_) = get_clt tok in
       (match d with
        D.MINUS | D.OPTMINUS | D.UNIQUEMINUS -> true
-      | D.PLUS -> false
+      | D.PLUS | D.PLUSPLUS -> false
       | D.CONTEXT | D.UNIQUE | D.OPT -> false)
     with _ -> false in
   let rec minus_loop = function
@@ -1250,7 +1233,7 @@ let rec consume_minus_positions = function
 let any_modif rule =
   let mcode x =
     match Ast0.get_mcode_mcodekind x with
-      Ast0.MINUS _ | Ast0.PLUS -> true
+      Ast0.MINUS _ | Ast0.PLUS -> true
     | _ -> false in
   let donothing r k e = k e in
   let bind x y = x or y in
@@ -1263,6 +1246,15 @@ let any_modif rule =
       donothing donothing in
   List.exists fn.VT0.combiner_rec_top_level rule
 
+let eval_virt virt =
+  List.iter
+    (function x ->
+      if not (List.mem x virt)
+      then
+        failwith
+          (Printf.sprintf "unknown virtual rule %s\n" x))
+    !Flag_parsing_cocci.defined_virtual_rules
+
 let drop_last extra l = List.rev(extra@(List.tl(List.rev l)))
 
 let partition_either l =
@@ -1407,7 +1399,42 @@ let parse_iso_files existing_isos iso_files extra_path =
   Data.in_iso := false;
   existing_isos@(List.concat (List.rev res))
 
+(* None = dependency not satisfied
+   Some dep = dependency satisfied or unknown and dep has virts optimized
+   away *)
+let eval_depend dep virt =
+  let rec loop dep =
+    match dep with
+      Ast.Dep req | Ast.EverDep req ->
+       if List.mem req virt
+       then
+         if List.mem req !Flag_parsing_cocci.defined_virtual_rules
+         then Some Ast.NoDep
+         else None
+       else Some dep
+    | Ast.AntiDep antireq | Ast.NeverDep antireq ->
+       if List.mem antireq virt
+       then
+         if not(List.mem antireq !Flag_parsing_cocci.defined_virtual_rules)
+         then Some Ast.NoDep
+         else None
+       else Some dep
+    | Ast.AndDep(d1,d2) ->
+       (match (loop d1, loop d2) with
+         (None,_) | (_,None) -> None
+       | (Some Ast.NoDep,x) | (x,Some Ast.NoDep) -> x
+       | (Some x,Some y) -> Some (Ast.AndDep(x,y)))
+    | Ast.OrDep(d1,d2) ->
+       (match (loop d1, loop d2) with
+         (None,None) -> None
+       | (Some Ast.NoDep,x) | (x,Some Ast.NoDep) | (None,x) | (x,None) -> x
+       | (Some x,Some y) -> Some (Ast.OrDep(x,y)))
+    | Ast.NoDep | Ast.FailDep -> Some dep
+    in
+  loop dep
+
 let rec parse file =
+  Lexer_cocci.init();
   let table = Common.full_charpos_to_pos file in
   Common.with_open_infile file (fun channel ->
   let lexbuf = Lexing.from_channel channel in
@@ -1423,16 +1450,25 @@ let rec parse file =
          let include_and_iso_files =
            parse_one "include and iso file names" PC.include_main file data in
 
-         let (include_files,iso_files) =
+         let (include_files,iso_files,virt) =
            List.fold_left
-             (function (include_files,iso_files) ->
+             (function (include_files,iso_files,virt) ->
                function
-                   Data.Include s -> (s::include_files,iso_files)
-                 | Data.Iso s -> (include_files,s::iso_files))
-             ([],[]) include_and_iso_files in
-
-         let (extra_iso_files, extra_rules) =
-           List.split (List.map parse include_files) in
+                   Data.Include s -> (s::include_files,iso_files,virt)
+                 | Data.Iso s -> (include_files,s::iso_files,virt)
+                 | Data.Virt l -> (include_files,iso_files,l@virt))
+             ([],[],[]) include_and_iso_files in
+
+         List.iter (function x -> Hashtbl.add Lexer_cocci.rule_names x ())
+           virt;
+
+         let (extra_iso_files, extra_rules, extra_virt) =
+           let rec loop = function
+               [] -> ([],[],[])
+             | (a,b,c)::rest ->
+                 let (x,y,z) = loop rest in
+                 (a::x,b::y,c::z) in
+           loop (List.map parse include_files) in
 
           let parse_cocci_rule ruletype old_metas
              (rule_name, dependencies, iso, dropiso, exists, is_expression) =
@@ -1456,6 +1492,11 @@ let rec parse file =
             let (_, plus_tokens) =
              split_token_stream (minus_to_nothing tokens) in
 
+           (*
+              print_tokens "minus tokens" minus_tokens;
+              print_tokens "plus tokens" plus_tokens;
+           *)
+
            let minus_tokens = consume_minus_positions minus_tokens in
            let minus_tokens = prepare_tokens minus_tokens in
            let plus_tokens = prepare_tokens plus_tokens in
@@ -1506,6 +1547,16 @@ let rec parse file =
               (iso, dropiso, dependencies, rule_name, exists)),
               (plus_res, metavars), ruletype), metavars, tokens) in
 
+         let rec collect_script_tokens = function
+             [(PC.EOF,_)] | [(PC.TArobArob,_)] | [(PC.TArob,_)] -> ""
+           | (PC.TScriptData(s),_)::xs -> s^(collect_script_tokens xs)
+           | toks ->
+               List.iter
+                 (function x ->
+                   Printf.printf "%s\n" (token2c x))
+                 toks;
+               failwith "Malformed script rule" in
+
           let parse_script_rule language old_metas deps =
             let get_tokens = tokens_script_all table file false lexbuf in
 
@@ -1533,11 +1584,7 @@ let rec parse file =
 
               (* script code *)
             let (more, tokens) = get_tokens [PC.TArobArob; PC.TArob] in
-            let data =
-              match List.hd tokens with
-                (PC.TScriptData(s),_) -> s
-              | (PC.TArobArob,_) | (PC.TArob,_) -> ""
-              | _ -> failwith "Malformed script rule" in
+            let data = collect_script_tokens tokens in
             (more,Ast0.ScriptRule(language, deps, metavars, data),[],tokens) in
 
           let parse_if_script_rule k language =
@@ -1545,11 +1592,7 @@ let rec parse file =
 
               (* script code *)
             let (more, tokens) = get_tokens [PC.TArobArob; PC.TArob] in
-            let data =
-              match List.hd tokens with
-                (PC.TScriptData(s),_) -> s
-              | (PC.TArobArob,_) | (PC.TArob,_) -> ""
-              | _ -> failwith "Malformed script rule" in
+            let data = collect_script_tokens tokens in
             (more,k (language, data),[],tokens) in
 
          let parse_iscript_rule =
@@ -1567,19 +1610,41 @@ let rec parse file =
              get_rule_name PC.rule_name starts_with_name get_tokens file
                "rule" in
             match rulename with
-              Ast.CocciRulename (Some s, a, b, c, d, e) ->
-                parse_cocci_rule Ast.Normal old_metas (s, a, b, c, d, e)
-            | Ast.GeneratedRulename (Some s, a, b, c, d, e) ->
-               Data.in_generating := true;
-                let res =
-                 parse_cocci_rule Ast.Generated old_metas (s,a,b,c,d,e) in
-               Data.in_generating := false;
-               res
-            | Ast.ScriptRulename(l,deps) -> parse_script_rule l old_metas deps
+              Ast.CocciRulename (Some s, dep, b, c, d, e) ->
+               (match eval_depend dep virt with
+                 Some (dep) ->
+                   parse_cocci_rule Ast.Normal old_metas (s,dep,b,c,d,e)
+               | None ->
+                   D.ignore_patch_or_match := true;
+                    let res =
+                     parse_cocci_rule Ast.Normal old_metas
+                       (s, Ast.FailDep, b, c, d, e) in
+                   D.ignore_patch_or_match := false;
+                   res)
+            | Ast.GeneratedRulename (Some s, dep, b, c, d, e) ->
+               (match eval_depend dep virt with
+                 Some (dep) ->
+                   Data.in_generating := true;
+                   let res =
+                     parse_cocci_rule Ast.Normal old_metas (s,dep,b,c,d,e) in
+                   Data.in_generating := false;
+                   res
+               | None ->
+                   D.ignore_patch_or_match := true;
+                   Data.in_generating := true;
+                    let res =
+                     parse_cocci_rule Ast.Normal old_metas
+                       (s, Ast.FailDep, b, c, d, e) in
+                   D.ignore_patch_or_match := false;
+                   Data.in_generating := false;
+                   res)
+            | Ast.ScriptRulename(l,deps) ->
+               (match eval_depend deps virt with
+                 Some deps -> parse_script_rule l old_metas deps
+               | None ->  parse_script_rule l old_metas Ast.FailDep)
             | Ast.InitialScriptRulename(l) -> parse_iscript_rule l
-            | Ast.FinalScriptRulename(l) -> parse_fscript_rule l
-            | _ -> failwith "Malformed rule name"
-            in
+            | Ast.FinalScriptRulename(l)   -> parse_fscript_rule l
+            | _ -> failwith "Malformed rule name" in
 
          let rec loop old_metas starts_with_name =
            (!Data.init_rule)();
@@ -1602,20 +1667,21 @@ let rec parse file =
          (List.fold_left
             (function prev -> function cur -> Common.union_set cur prev)
             iso_files extra_iso_files,
-          List.fold_left
-            (function prev -> function cur -> cur @ prev)
-            (loop [] (x = PC.TArob)) extra_rules)
+          (* included rules first *)
+          List.fold_left (function prev -> function cur -> cur@prev)
+            (loop [] (x = PC.TArob)) (List.rev extra_rules),
+          List.fold_left (@) virt extra_virt (*no dups allowed*))
       |        _ -> failwith "unexpected code before the first rule\n")
   | (false,[(PC.TArobArob,_)]) | (false,[(PC.TArob,_)]) ->
-      ([],([] : Ast0.parsed_rule list))
+      ([],([] : Ast0.parsed_rule list),[] (*virtual rules*))
   | _ -> failwith "unexpected code before the first rule\n" in
   res)
 
 (* parse to ast0 and then convert to ast *)
 let process file isofile verbose =
   let extra_path = Filename.dirname file in
-  Lexer_cocci.init();
-  let (iso_files, rules) = parse file in
+  let (iso_files, rules, virt) = parse file in
+  eval_virt virt;
   let std_isos =
     match isofile with
       None -> []
@@ -1713,6 +1779,7 @@ let process file isofile verbose =
               let minus_ast =
                 Ast0toast.ast0toast rule_name dependencies dropped_isos
                   exists minus is_exp ruletype in
+              
               match function_prototypes with
                 None -> [(extra_meta @ metavars, minus_ast)]
               | Some mv_fp -> [(extra_meta @ metavars, minus_ast); mv_fp])
@@ -1729,6 +1796,7 @@ let process file isofile verbose =
     Common.profile_code "get_constants"
       (fun () -> Get_constants.get_constants code) in (* for grep *)
   let glimpse_tokens2 =
-    Common.profile_code "get_glimpse_constants"
-      (fun () -> Get_constants2.get_constants code neg_pos) in(* for glimpse *)
+    Common.profile_code "get_glimpse_constants" (* for glimpse *)
+      (fun () -> Get_constants2.get_constants code neg_pos) in
+
   (metavars,code,fvs,neg_pos,ua,pos,grep_tokens,glimpse_tokens2)