Coccinelle release 0.2.5-rc5
[bpt/coccinelle.git] / parsing_cocci / unitary_ast0.ml
CommitLineData
c491d8ee
C
1(*
2 * Copyright 2010, INRIA, University of Copenhagen
3 * Julia Lawall, Rene Rydhof Hansen, Gilles Muller, Nicolas Palix
4 * Copyright 2005-2009, Ecole des Mines de Nantes, University of Copenhagen
5 * Yoann Padioleau, Julia Lawall, Rene Rydhof Hansen, Henrik Stuart, Gilles Muller, Nicolas Palix
6 * This file is part of Coccinelle.
7 *
8 * Coccinelle is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation, according to version 2 of the License.
11 *
12 * Coccinelle is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with Coccinelle. If not, see <http://www.gnu.org/licenses/>.
19 *
20 * The authors reserve the right to distribute this or future versions of
21 * Coccinelle under other licenses.
22 *)
23
24
34e49164
C
25(* find unitary metavariables *)
26module Ast0 = Ast0_cocci
27module Ast = Ast_cocci
28module V0 = Visitor_ast0
b1b2de81 29module VT0 = Visitor_ast0_types
34e49164
C
30
31let set_minus s minus = List.filter (function n -> not (List.mem n minus)) s
32
33let rec nub = function
34 [] -> []
35 | (x::xs) when (List.mem x xs) -> nub xs
36 | (x::xs) -> x::(nub xs)
37
38(* ----------------------------------------------------------------------- *)
39(* Find the variables that occur free and occur free in a unitary way *)
40
41(* take everything *)
42let minus_checker name = let id = Ast0.unwrap_mcode name in [id]
43
44(* take only what is in the plus code *)
708f4980 45let plus_checker (nm,_,_,mc,_,_) =
951c7801 46 match mc with Ast0.PLUS _ -> [nm] | _ -> []
faf9a90c 47
34e49164
C
48let get_free checker t =
49 let bind x y = x @ y in
50 let option_default = [] in
faf9a90c 51
34e49164
C
52 (* considers a single list *)
53 let collect_unitary_nonunitary free_usage =
54 let free_usage = List.sort compare free_usage in
55 let rec loop1 todrop = function
56 [] -> []
57 | (x::xs) as all -> if x = todrop then loop1 todrop xs else all in
58 let rec loop2 = function
59 [] -> ([],[])
60 | [x] -> ([x],[])
61 | x::y::xs ->
62 if x = y
63 then
64 let (unitary,non_unitary) = loop2(loop1 x xs) in
65 (unitary,x::non_unitary)
66 else
67 let (unitary,non_unitary) = loop2 (y::xs) in
68 (x::unitary,non_unitary) in
69 loop2 free_usage in
faf9a90c 70
34e49164
C
71 (* considers a list of lists *)
72 let detect_unitary_frees l =
73 let (unitary,nonunitary) =
74 List.split (List.map collect_unitary_nonunitary l) in
75 let unitary = nub (List.concat unitary) in
76 let nonunitary = nub (List.concat nonunitary) in
77 let unitary =
78 List.filter (function x -> not (List.mem x nonunitary)) unitary in
79 unitary@nonunitary@nonunitary in
80
1be43e12 81 let whencode afn bfn expression = function
34e49164
C
82 Ast0.WhenNot(a) -> afn a
83 | Ast0.WhenAlways(b) -> bfn b
1be43e12
C
84 | Ast0.WhenModifier(_) -> option_default
85 | Ast0.WhenNotTrue(a) -> expression a
86 | Ast0.WhenNotFalse(a) -> expression a in
faf9a90c 87
34e49164
C
88 let ident r k i =
89 match Ast0.unwrap i with
90 Ast0.MetaId(name,_,_) | Ast0.MetaFunc(name,_,_)
91 | Ast0.MetaLocalFunc(name,_,_) -> checker name
d3f655c6
C
92 | Ast0.DisjId(starter,id_list,mids,ender) ->
93 detect_unitary_frees(List.map r.VT0.combiner_rec_ident id_list)
34e49164 94 | _ -> k i in
faf9a90c 95
34e49164
C
96 let expression r k e =
97 match Ast0.unwrap e with
98 Ast0.MetaErr(name,_,_) | Ast0.MetaExpr(name,_,_,_,_)
99 | Ast0.MetaExprList(name,_,_) -> checker name
100 | Ast0.DisjExpr(starter,expr_list,mids,ender) ->
b1b2de81 101 detect_unitary_frees(List.map r.VT0.combiner_rec_expression expr_list)
34e49164 102 | _ -> k e in
faf9a90c 103
34e49164
C
104 let typeC r k t =
105 match Ast0.unwrap t with
106 Ast0.MetaType(name,_) -> checker name
107 | Ast0.DisjType(starter,types,mids,ender) ->
b1b2de81 108 detect_unitary_frees(List.map r.VT0.combiner_rec_typeC types)
34e49164 109 | _ -> k t in
faf9a90c 110
34e49164
C
111 let parameter r k p =
112 match Ast0.unwrap p with
113 Ast0.MetaParam(name,_) | Ast0.MetaParamList(name,_,_) -> checker name
114 | _ -> k p in
faf9a90c 115
34e49164
C
116 let declaration r k d =
117 match Ast0.unwrap d with
413ffc02
C
118 Ast0.MetaDecl(name,_) | Ast0.MetaField(name,_) -> checker name
119 | Ast0.DisjDecl(starter,decls,mids,ender) ->
b1b2de81 120 detect_unitary_frees(List.map r.VT0.combiner_rec_declaration decls)
34e49164
C
121 | _ -> k d in
122
fc1ad971
C
123 let case_line r k c =
124 match Ast0.unwrap c with
125 Ast0.DisjCase(starter,case_lines,mids,ender) ->
126 detect_unitary_frees(List.map r.VT0.combiner_rec_case_line case_lines)
127 | _ -> k c in
128
34e49164
C
129 let statement r k s =
130 match Ast0.unwrap s with
131 Ast0.MetaStmt(name,_) | Ast0.MetaStmtList(name,_) -> checker name
132 | Ast0.Disj(starter,stmt_list,mids,ender) ->
b1b2de81
C
133 detect_unitary_frees
134 (List.map r.VT0.combiner_rec_statement_dots stmt_list)
34e49164 135 | Ast0.Nest(starter,stmt_dots,ender,whn,multi) ->
b1b2de81 136 bind (r.VT0.combiner_rec_statement_dots stmt_dots)
faf9a90c 137 (detect_unitary_frees
34e49164 138 (List.map
b1b2de81 139 (whencode
ae4735db 140 r.VT0.combiner_rec_statement_dots
b1b2de81
C
141 r.VT0.combiner_rec_statement
142 r.VT0.combiner_rec_expression)
34e49164
C
143 whn))
144 | Ast0.Dots(d,whn) | Ast0.Circles(d,whn) | Ast0.Stars(d,whn) ->
145 detect_unitary_frees
146 (List.map
b1b2de81
C
147 (whencode
148 r.VT0.combiner_rec_statement_dots r.VT0.combiner_rec_statement
149 r.VT0.combiner_rec_expression)
34e49164
C
150 whn)
151 | _ -> k s in
faf9a90c
C
152
153 let res = V0.combiner bind option_default
b1b2de81
C
154 {V0.combiner_functions with
155 VT0.combiner_identfn = ident;
156 VT0.combiner_exprfn = expression;
157 VT0.combiner_tyfn = typeC;
158 VT0.combiner_paramfn = parameter;
159 VT0.combiner_declfn = declaration;
fc1ad971
C
160 VT0.combiner_stmtfn = statement;
161 VT0.combiner_casefn = case_line} in
faf9a90c 162
34e49164 163 collect_unitary_nonunitary
b1b2de81 164 (List.concat (List.map res.VT0.combiner_rec_top_level t))
faf9a90c 165
34e49164
C
166(* ----------------------------------------------------------------------- *)
167(* update the variables that are unitary *)
faf9a90c 168
34e49164 169let update_unitary unitary =
34e49164
C
170 let is_unitary name =
171 match (List.mem (Ast0.unwrap_mcode name) unitary,
485bce71
C
172 !Flag.sgrep_mode2, Ast0.get_mcode_mcodekind name) with
173 (true,true,_) | (true,_,Ast0.CONTEXT(_)) -> Ast0.PureContext
174 | (true,_,_) -> Ast0.Pure
175 | (false,true,_) | (false,_,Ast0.CONTEXT(_)) -> Ast0.Context
176 | (false,_,_) -> Ast0.Impure in
34e49164
C
177
178 let ident r k i =
179 match Ast0.unwrap i with
180 Ast0.MetaId(name,constraints,_) ->
181 Ast0.rewrap i (Ast0.MetaId(name,constraints,is_unitary name))
182 | Ast0.MetaFunc(name,constraints,_) ->
183 Ast0.rewrap i (Ast0.MetaFunc(name,constraints,is_unitary name))
184 | Ast0.MetaLocalFunc(name,constraints,_) ->
185 Ast0.rewrap i (Ast0.MetaLocalFunc(name,constraints,is_unitary name))
186 | _ -> k i in
187
188 let expression r k e =
189 match Ast0.unwrap e with
190 Ast0.MetaErr(name,constraints,_) ->
191 Ast0.rewrap e (Ast0.MetaErr(name,constraints,is_unitary name))
192 | Ast0.MetaExpr(name,constraints,ty,form,_) ->
193 Ast0.rewrap e (Ast0.MetaExpr(name,constraints,ty,form,is_unitary name))
194 | Ast0.MetaExprList(name,lenname,_) ->
195 Ast0.rewrap e (Ast0.MetaExprList(name,lenname,is_unitary name))
196 | _ -> k e in
faf9a90c 197
34e49164
C
198 let typeC r k t =
199 match Ast0.unwrap t with
200 Ast0.MetaType(name,_) ->
201 Ast0.rewrap t (Ast0.MetaType(name,is_unitary name))
202 | _ -> k t in
faf9a90c 203
34e49164
C
204 let parameter r k p =
205 match Ast0.unwrap p with
206 Ast0.MetaParam(name,_) ->
207 Ast0.rewrap p (Ast0.MetaParam(name,is_unitary name))
208 | Ast0.MetaParamList(name,lenname,_) ->
209 Ast0.rewrap p (Ast0.MetaParamList(name,lenname,is_unitary name))
210 | _ -> k p in
faf9a90c 211
34e49164
C
212 let statement r k s =
213 match Ast0.unwrap s with
214 Ast0.MetaStmt(name,_) ->
215 Ast0.rewrap s (Ast0.MetaStmt(name,is_unitary name))
216 | Ast0.MetaStmtList(name,_) ->
217 Ast0.rewrap s (Ast0.MetaStmtList(name,is_unitary name))
218 | _ -> k s in
faf9a90c 219
34e49164 220 let res = V0.rebuilder
b1b2de81
C
221 {V0.rebuilder_functions with
222 VT0.rebuilder_identfn = ident;
223 VT0.rebuilder_exprfn = expression;
224 VT0.rebuilder_tyfn = typeC;
225 VT0.rebuilder_paramfn = parameter;
226 VT0.rebuilder_stmtfn = statement} in
34e49164 227
b1b2de81 228 List.map res.VT0.rebuilder_rec_top_level
34e49164
C
229
230(* ----------------------------------------------------------------------- *)
231
232let rec split3 = function
233 [] -> ([],[],[])
234 | (a,b,c)::xs -> let (l1,l2,l3) = split3 xs in (a::l1,b::l2,c::l3)
235
236let rec combine3 = function
237 ([],[],[]) -> []
238 | (a::l1,b::l2,c::l3) -> (a,b,c) :: combine3 (l1,l2,l3)
239 | _ -> failwith "not possible"
240
241(* ----------------------------------------------------------------------- *)
242(* process all rules *)
243
244let do_unitary rules =
245 let rec loop = function
246 [] -> ([],[])
247 | (r::rules) ->
248 match r with
413ffc02 249 Ast0.ScriptRule (_,_,_,_,_,_)
174d1640 250 | Ast0.InitialScriptRule (_,_,_,_) | Ast0.FinalScriptRule (_,_,_,_) ->
34e49164
C
251 let (x,rules) = loop rules in
252 (x, r::rules)
faf9a90c 253 | Ast0.CocciRule ((minus,metavars,chosen_isos),((plus,_) as plusz),rt) ->
34e49164
C
254 let mm1 = List.map Ast.get_meta_name metavars in
255 let (used_after, rest) = loop rules in
256 let (m_unitary, m_nonunitary) = get_free minus_checker minus in
257 let (p_unitary, p_nonunitary) = get_free plus_checker plus in
faf9a90c 258 let p_free =
34e49164
C
259 if !Flag.sgrep_mode2 then []
260 else p_unitary @ p_nonunitary in
261 let (in_p, m_unitary) =
262 List.partition (function x -> List.mem x p_free) m_unitary in
263 let m_nonunitary = in_p @ m_nonunitary in
264 let (m_unitary, not_local) =
265 List.partition (function x -> List.mem x mm1) m_unitary in
266 let m_unitary =
267 List.filter (function x -> not (List.mem x used_after))
268 m_unitary in
269 let rebuilt = update_unitary m_unitary minus in
270 (set_minus (m_nonunitary @ used_after) mm1,
271 (Ast0.CocciRule
faf9a90c 272 ((rebuilt, metavars, chosen_isos),plusz,rt))::rest) in
34e49164
C
273 let (_,rules) = loop rules in
274 rules
275
276(*
277let do_unitary minus plus =
278 let (minus,metavars,chosen_isos) = split3 minus in
279 let (plus,_) = List.split plus in
280 let rec loop = function
281 ([],[],[]) -> ([],[])
282 | (mm1::metavars,m1::minus,p1::plus) ->
283 let mm1 = List.map Ast.get_meta_name mm1 in
284 let (used_after,rest) = loop (metavars,minus,plus) in
285 let (m_unitary,m_nonunitary) = get_free minus_checker m1 in
286 let (p_unitary,p_nonunitary) = get_free plus_checker p1 in
287 let p_free =
288 if !Flag.sgrep_mode2
289 then []
290 else p_unitary @ p_nonunitary in
291 let (in_p,m_unitary) =
292 List.partition (function x -> List.mem x p_free) m_unitary in
293 let m_nonunitary = in_p@m_nonunitary in
294 let (m_unitary,not_local) =
295 List.partition (function x -> List.mem x mm1) m_unitary in
296 let m_unitary =
297 List.filter (function x -> not(List.mem x used_after)) m_unitary in
298 let rebuilt = update_unitary m_unitary m1 in
299 (set_minus (m_nonunitary @ used_after) mm1,
300 rebuilt::rest)
301 | _ -> failwith "not possible" in
302 let (_,rules) = loop (metavars,minus,plus) in
303 combine3 (rules,metavars,chosen_isos)
304*)