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.
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.
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.
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/>.
20 * The authors reserve the right to distribute this or future versions of
21 * Coccinelle under other licenses.
25 module Ast
= Ast_cocci
26 module V
= Visitor_ast
27 module TC
= Type_cocci
31 1. If a rule X depends on a rule Y (in a positive way), then we can ignore
34 2. If a rule X contains a metavariable that is not under a disjunction and
35 that is inherited from rule Y, then we can ignore the constants in X.
37 3. If a rule contains a constant x in + code then subsequent rules that
38 have it in - or context should not include it in their list of required
42 (* This doesn't do the . -> trick of get_constants for record fields, as
43 that does not fit well with the recursive structure. It was not clear
44 that that was completely safe either, although eg putting a newline
45 after the . or -> is probably unusual. *)
47 (* ----------------------------------------------------------------------- *)
48 (* This phase collects everything. One can then filter out what it not
51 (* True means nothing was found
52 False should never drift to the top, it is the neutral element of or
53 and an or is never empty *)
55 And
of combine list
| Or
of combine list
| Elem
of string | False
| True
57 (* glimpse often fails on large queries. We can safely remove arguments of
58 && as long as we don't remove all of them (note that there is no negation).
59 This tries just removing one of them and then orders the results by
60 increasing number of ors (ors are long, increasing the chance of failure,
61 and are less restrictive, possibly increasing the chance of irrelevant
63 let reduce_glimpse x
=
67 | And
[x
] -> loop x
(function changed_l
-> k
(And
[changed_l
])) q
70 (function changed_l
-> k
(And changed_l
))
77 rloop xs
(function changed_xs
-> k
(x
:: changed_xs
)) in
78 rloop l
(function changed_l
-> k
(And changed_l
)))
79 | Or l
-> kloop l
(function changed_l
-> k
(Or changed_l
)) q
80 | _
-> failwith
"not possible"
86 (function changed_x
-> k
(changed_x
::xs
))
89 (function changed_xs
-> k
(x
:: changed_xs
))
91 let rec count_ors = function
93 | And l
-> List.fold_left
(+) 0 (List.map
count_ors l
)
95 ((List.length l
) - 1) +
96 (List.fold_left
(+) 0 (List.map
count_ors l
))
97 | _
-> failwith
"not possible" in
98 let res = loop x
(function x
-> x
) (function _
-> []) in
99 let res = List.map
(function x
-> (count_ors x
,x
)) res in
100 let res = List.sort compare
res in
101 List.map
(function (_
,x
) -> x
) res
103 let interpret_glimpse strict x
=
104 let rec loop = function
108 | And l
-> Printf.sprintf
"{%s}" (String.concat
";" (List.map
loop l
))
109 | Or l
-> Printf.sprintf
"{%s}" (String.concat
"," (List.map
loop l
))
112 then failwith
"True should not be in the final result"
116 then failwith
"False should not be in the final result. Perhaps your rule doesn't contain any +/-/* code"
120 | False
when strict
->
121 failwith
"False should not be in the final result. Perhaps your rule doesn't contain any +/-/* code"
123 Some
(if strict
then List.map
loop (x
::reduce_glimpse x
) else [loop x
])
125 (* grep only does or *)
126 let interpret_grep strict x
=
127 let rec loop = function
129 | And l
-> List.concat
(List.map
loop l
)
130 | Or l
-> List.concat
(List.map
loop l
)
133 then failwith
"True should not be in the final result"
137 then failwith
"False should not be in the final result. Perhaps your rule doesn't contain any +/-/* code"
141 | False
when strict
->
142 failwith
"False should not be in the final result. Perhaps your rule doesn't contain any +/-/* code"
145 let interpret_google strict x
=
147 let rec dnf = function
149 | Or l
-> List.fold_left
Common.union_set
[] (List.map
dnf l
)
151 let l = List.map
dnf l in
155 List.fold_left
Common.union_set
[]
158 List.map
(function y
-> Printf.sprintf
"%s %s" x y
) prev
)
164 then failwith
"False should not be in the final result. Perhaps your rule doesn't contain any +/-/* code"
168 | False
when strict
->
169 failwith
"False should not be in the final result. Perhaps your rule doesn't contain any +/-/* code"
173 match interpret_glimpse false x
with
175 | Some x
-> String.concat
" || " x
178 And
l -> And
(List.sort compare
l)
179 | Or
l -> Or
(List.sort compare
l)
182 let rec merge l1 l2
=
187 (match compare x y
with
188 -1 -> x
::(merge xs l2
)
189 | 0 -> x
::(merge xs ys
)
190 | 1 -> y
::(merge l1 ys
)
191 | _
-> failwith
"not possible")
193 let intersect l1 l2
= List.filter
(function l1e
-> List.mem l1e l2
) l1
195 let minus_set l1 l2
= List.filter
(function l1e
-> not
(List.mem l1e l2
)) l1
197 let rec insert x
l = merge [x
] l
199 let rec build_and x y
=
204 (True
,x
) | (x
,True
) -> x
205 | (False
,x
) | (x
,False
) -> False
206 | (And l1
,And l2
) -> And
(merge l1 l2
)
207 | (x
,Or
l) when List.mem x
l -> x
208 | (Or
l,x
) when List.mem x
l -> x
209 | (Or l1
,Or l2
) when not
((intersect l1 l2
) = []) ->
212 (List.fold_left build_or False
(minus_set l1 l2
))
213 (List.fold_left build_or False
(minus_set l2 l1
)) in
214 List.fold_left build_or
inner (intersect l1 l2
)
215 | (x
,And
l) | (And
l,x
) ->
222 Or
l -> not
(List.mem x
l)
225 And
(insert x
others)
226 | (x
,y
) -> norm(And
[x
;y
])
233 (True
,x
) | (x
,True
) -> True
234 | (False
,x
) | (x
,False
) -> x
235 | (Or l1
,Or l2
) -> Or
(merge l1 l2
)
236 | (x
,And
l) when List.mem x
l -> x
237 | (And
l,x
) when List.mem x
l -> x
238 | (And l1
,And l2
) when not
((intersect l1 l2
) = []) ->
241 (List.fold_left
build_and True
(minus_set l1 l2
))
242 (List.fold_left
build_and True
(minus_set l2 l1
)) in
243 List.fold_left
build_and inner (intersect l1 l2
)
244 | (x
,Or
l) | (Or
l,x
) ->
251 And
l -> not
(List.mem x
l)
255 | (x
,y
) -> norm(Or
[x
;y
])
260 let do_get_constants constants keywords env neg_pos
=
261 let donothing r k e
= k e
in
262 let option_default = True
in
263 let bind = build_and in
264 let inherited ((nm1
,_
) as x
) =
265 (* ignore virtuals *)
266 if nm1
= "virtual" then option_default
267 (* perhaps inherited, but value not required, so no constraints *)
268 else if List.mem x neg_pos
then option_default
269 else (try List.assoc nm1 env
with Not_found
-> False
) in
270 let minherited name
= inherited (Ast.unwrap_mcode name
) in
272 match Ast.get_pos_var x
with
273 Ast.MetaPos
(name
,constraints
,_
,keep,inh
) -> minherited name
274 | _
-> option_default in
276 (* if one branch gives no information, then we have to take anything *)
277 let disj_union_all = List.fold_left build_or False
in
280 match Ast.unwrap i
with
283 (match Ast.unwrap_mcode name
with
284 "NULL" -> keywords
"NULL"
285 | nm
-> constants nm
)
286 | Ast.MetaId
(name
,_
,_
,_
) | Ast.MetaFunc
(name
,_
,_
,_
)
287 | Ast.MetaLocalFunc
(name
,_
,_
,_
) -> bind (k i
) (minherited name
)
290 let rec type_collect res = function
291 TC.ConstVol
(_
,ty
) | TC.Pointer
(ty
) | TC.FunctionPointer
(ty
)
292 | TC.Array
(ty
) -> type_collect res ty
293 | TC.MetaType
(tyname
,_
,_
) ->
295 | TC.TypeName
(s
) -> constants s
296 | TC.EnumName
(TC.Name s
) -> constants s
297 | TC.StructUnionName
(_
,TC.Name s
) -> constants s
300 (* no point to do anything special for records because glimpse is
302 let expression r k e
=
303 match Ast.unwrap e
with
304 Ast.Constant
(const
) ->
306 (match Ast.unwrap_mcode const
with
307 Ast.String s
-> constants s
308 | Ast.Char
"\\0" -> option_default (* glimpse doesn't like it *)
309 | Ast.Char s
-> option_default (* probably not chars either *)
310 (* the following were eg keywords "1", but not good for glimpse *)
311 | Ast.Int s
-> option_default (* glimpse doesn't index integers *)
312 | Ast.Float s
-> option_default (* probably not floats either *))
313 | Ast.MetaExpr
(name
,_
,_
,Some type_list
,_
,_
) ->
314 let types = List.fold_left
type_collect option_default type_list
in
315 bind (k e
) (bind (minherited name
) types)
316 | Ast.MetaErr
(name
,_
,_
,_
) | Ast.MetaExpr
(name
,_
,_
,_
,_
,_
) ->
317 bind (k e
) (minherited name
)
318 | Ast.MetaExprList
(name
,Ast.MetaListLen
(lenname
,_
,_
),_
,_
) ->
319 bind (k e
) (bind (minherited name
) (minherited lenname
))
320 | Ast.MetaExprList
(name
,_
,_
,_
) -> minherited name
321 | Ast.SizeOfExpr
(sizeof
,exp
) -> bind (keywords
"sizeof") (k e
)
322 | Ast.SizeOfType
(sizeof
,lp
,ty
,rp
) -> bind (keywords
"sizeof") (k e
)
323 | Ast.NestExpr
(starter
,expr_dots
,ender
,wc
,false) -> option_default
324 | Ast.NestExpr
(starter
,expr_dots
,ender
,wc
,true) ->
325 r
.V.combiner_expression_dots expr_dots
326 | Ast.DisjExpr
(exps
) ->
327 disj_union_all (List.map r
.V.combiner_expression exps
)
328 | Ast.OptExp
(exp
) -> option_default
329 | Ast.Edots
(_
,_
) | Ast.Ecircles
(_
,_
) | Ast.Estars
(_
,_
) -> option_default
332 let fullType r k ft
=
333 match Ast.unwrap ft
with
334 Ast.DisjType
(decls
) ->
335 disj_union_all (List.map r
.V.combiner_fullType decls
)
336 | Ast.OptType
(ty
) -> option_default
339 let baseType = function
340 Ast.VoidType
-> keywords
"void "
341 | Ast.CharType
-> keywords
"char "
342 | Ast.ShortType
-> keywords
"short "
343 | Ast.IntType
-> keywords
"int "
344 | Ast.DoubleType
-> keywords
"double "
345 | Ast.FloatType
-> keywords
"float "
346 | Ast.LongType
| Ast.LongLongType
-> keywords
"long " in
349 match Ast.unwrap ty
with
350 Ast.BaseType
(ty1
,strings
) -> bind (k ty
) (baseType ty1
)
351 | Ast.TypeName
(name
) -> bind (k ty
) (constants
(Ast.unwrap_mcode name
))
352 | Ast.MetaType
(name
,_
,_
) -> bind (minherited name
) (k ty
)
355 let declaration r k d
=
356 match Ast.unwrap d
with
357 Ast.MetaDecl
(name
,_
,_
) | Ast.MetaField
(name
,_
,_
) ->
358 bind (k d
) (minherited name
)
359 | Ast.DisjDecl
(decls
) ->
360 disj_union_all (List.map r
.V.combiner_declaration decls
)
361 | Ast.OptDecl
(decl
) -> option_default
362 | Ast.Ddots
(dots
,whencode
) -> option_default
365 let initialiser r k i
=
366 match Ast.unwrap i
with
367 Ast.OptIni
(ini
) -> option_default
370 let parameter r k p
=
371 match Ast.unwrap p
with
372 Ast.OptParam
(param
) -> option_default
373 | Ast.MetaParam
(name
,_
,_
) -> bind (k p
) (minherited name
)
374 | Ast.MetaParamList
(name
,Ast.MetaListLen
(lenname
,_
,_
),_
,_
) ->
375 bind (minherited name
) (bind (minherited lenname
) (k p
))
376 | Ast.MetaParamList
(name
,_
,_
,_
) -> bind (k p
) (minherited name
)
379 let rule_elem r k re
=
380 match Ast.unwrap re
with
381 Ast.MetaRuleElem
(name
,_
,_
) | Ast.MetaStmt
(name
,_
,_
,_
)
382 | Ast.MetaStmtList
(name
,_
,_
) -> bind (minherited name
) (k re
)
383 | Ast.WhileHeader
(whl
,lp
,exp
,rp
) ->
384 bind (keywords
"while") (k re
)
385 | Ast.WhileTail
(whl
,lp
,exp
,rp
,sem
) ->
386 bind (keywords
"do") (k re
)
387 | Ast.ForHeader
(fr
,lp
,e1
,sem1
,e2
,sem2
,e3
,rp
) ->
388 bind (keywords
"for") (k re
)
389 | Ast.SwitchHeader
(switch
,lp
,exp
,rp
) ->
390 bind (keywords
"switch") (k re
)
391 | Ast.Break
(br
,sem
) ->
392 bind (keywords
"break") (k re
)
393 | Ast.Continue
(cont
,sem
) ->
394 bind (keywords
"continue") (k re
)
396 bind (keywords
"goto") (k re
)
397 | Ast.Default
(def
,colon
) ->
398 bind (keywords
"default") (k re
)
399 | Ast.Include
(inc
,s
) ->
401 (match Ast.unwrap_mcode s
with
402 Ast.Local
l | Ast.NonLocal
l ->
407 (* just take the last thing, probably the most
408 specific. everything is necessary anyway. *)
409 Ast.IncPath s
-> [Elem s
]
410 | Ast.IncDots
-> prev
)
414 | x
::xs
-> List.fold_left
bind x xs
))
415 | Ast.DisjRuleElem
(res) ->
416 disj_union_all (List.map r
.V.combiner_rule_elem
res)
419 let statement r k s
=
420 match Ast.unwrap s
with
421 Ast.Disj
(stmt_dots
) ->
422 disj_union_all (List.map r
.V.combiner_statement_dots stmt_dots
)
423 | Ast.Nest
(starter
,stmt_dots
,ender
,whn
,false,_
,_
) -> option_default
424 | Ast.Nest
(starter
,stmt_dots
,ender
,whn
,true,_
,_
) ->
425 r
.V.combiner_statement_dots stmt_dots
426 | Ast.OptStm
(s
) -> option_default
427 | Ast.Dots
(d
,whn
,_
,_
) | Ast.Circles
(d
,whn
,_
,_
) | Ast.Stars
(d
,whn
,_
,_
) ->
431 V.combiner
bind option_default
432 mcode mcode mcode mcode mcode mcode mcode mcode mcode mcode mcode mcode
433 donothing donothing donothing donothing donothing
434 ident expression fullType typeC initialiser parameter declaration
435 rule_elem statement donothing donothing donothing
437 (* ------------------------------------------------------------------------ *)
439 let filter_combine combine to_drop
=
440 let rec and_loop = function
441 Elem x
when List.mem x to_drop
-> True
442 | Or
l -> List.fold_left build_or False
(List.map or_loop
l)
444 and or_loop
= function
445 Elem x
when List.mem x to_drop
-> False
446 | And
l -> List.fold_left
build_and True
(List.map
and_loop l)
450 (* ------------------------------------------------------------------------ *)
452 let get_all_constants minus_only
=
453 let donothing r k e
= k e
in
454 let bind = Common.union_set
in
455 let option_default = [] in
456 let mcode r
(x
,_
,mcodekind
,_
) =
458 Ast.MINUS
(_
,_
,_
,_
) -> [x
]
459 | _
when minus_only
-> []
461 let other r _
= [] in
463 V.combiner
bind option_default
464 other mcode other other other other other other other other other other
466 donothing donothing donothing donothing donothing
467 donothing donothing donothing donothing donothing donothing donothing
468 donothing donothing donothing donothing donothing
470 (* ------------------------------------------------------------------------ *)
472 let get_plus_constants =
473 let donothing r k e
= k e
in
474 let bind = Common.union_set
in
475 let option_default = [] in
482 bind ((get_all_constants false).V.combiner_anything cur
) prev
))
484 let process_mcodekind = function
485 Ast.MINUS
(_
,_
,_
,anythings
) -> recurse anythings
486 | Ast.CONTEXT
(_
,Ast.BEFORE
(a
,_
)) -> recurse a
487 | Ast.CONTEXT
(_
,Ast.AFTER
(a
,_
)) -> recurse a
488 | Ast.CONTEXT
(_
,Ast.BEFOREAFTER
(a1
,a2
,_
)) ->
489 Common.union_set
(recurse a1
) (recurse a2
)
492 let mcode r mc
= process_mcodekind (Ast.get_mcodekind mc
) in
493 let end_info (_
,_
,_
,mc
) = process_mcodekind mc
in
495 let rule_elem r k e
=
496 match Ast.unwrap e
with
497 Ast.FunHeader
(bef
,_
,_
,_
,_
,_
,_
)
498 | Ast.Decl
(bef
,_
,_
) -> bind (process_mcodekind bef
) (k e
)
501 let statement r k e
=
502 match Ast.unwrap e
with
503 Ast.IfThen
(_
,_
,ei
) | Ast.IfThenElse
(_
,_
,_
,_
,ei
)
504 | Ast.While
(_
,_
,ei
) | Ast.For
(_
,_
,ei
)
505 | Ast.Iterator
(_
,_
,ei
) -> bind (k e
) (end_info ei
)
508 V.combiner
bind option_default
509 mcode mcode mcode mcode mcode mcode mcode mcode mcode mcode mcode mcode
510 donothing donothing donothing donothing donothing
511 donothing donothing donothing donothing donothing donothing donothing
512 rule_elem statement donothing donothing donothing
514 (* ------------------------------------------------------------------------ *)
516 (* true means the rule should be analyzed, false means it should be ignored *)
517 let rec dependencies env
= function
518 Ast.Dep s
-> (try List.assoc s env
with Not_found
-> False
)
519 | Ast.AntiDep s
-> True
520 | Ast.EverDep s
-> (try List.assoc s env
with Not_found
-> False
)
521 | Ast.NeverDep s
-> True
522 | Ast.AndDep
(d1
,d2
) -> build_and (dependencies env d1
) (dependencies env d2
)
523 | Ast.OrDep
(d1
,d2
) -> build_or
(dependencies env d1
) (dependencies env d2
)
525 | Ast.FailDep
-> False
527 (* ------------------------------------------------------------------------ *)
530 let bind x y
= x
&& y
in
531 let option_default = true in
533 let donothing recursor k e
= k e
in
535 let process_mcodekind = function
536 Ast.CONTEXT
(_
,Ast.NOTHING
) -> true
539 let mcode r e
= process_mcodekind (Ast.get_mcodekind e
) in
541 let end_info (_
,_
,_
,mc
) = process_mcodekind mc
in
543 let initialiser r k e
=
544 match Ast.unwrap e
with
545 Ast.StrInitList
(all_minus
,_
,_
,_
,_
) ->
549 let rule_elem r k e
=
550 match Ast.unwrap e
with
551 Ast.FunHeader
(bef
,_
,_
,_
,_
,_
,_
)
552 | Ast.Decl
(bef
,_
,_
) -> bind (process_mcodekind bef
) (k e
)
555 let statement r k e
=
556 match Ast.unwrap e
with
557 Ast.IfThen
(_
,_
,ei
) | Ast.IfThenElse
(_
,_
,_
,_
,ei
)
558 | Ast.While
(_
,_
,ei
) | Ast.For
(_
,_
,ei
)
559 | Ast.Iterator
(_
,_
,ei
) -> bind (k e
) (end_info ei
)
562 V.combiner
bind option_default
563 mcode mcode mcode mcode mcode mcode mcode mcode mcode mcode mcode mcode
564 donothing donothing donothing donothing donothing
565 donothing donothing donothing donothing initialiser donothing
566 donothing rule_elem statement donothing donothing donothing
568 (* ------------------------------------------------------------------------ *)
570 let rule_fn tls in_plus env neg_pos
=
572 (function (rest_info
,in_plus
) ->
573 function (cur
,neg_pos
) ->
575 let getter = do_get_constants keep drop env neg_pos
in
576 getter.V.combiner_top_level cur
in
579 then [] (* nothing removed for sgrep *)
580 else (get_all_constants true).V.combiner_top_level cur
in
581 let plusses = get_plus_constants.V.combiner_top_level cur
in
582 (* the following is for eg -foo(2) +foo(x) then in another rule
583 -foo(10); don't want to consider that foo is guaranteed to be
584 created by the rule. not sure this works completely: what if foo is
585 in both - and +, but in an or, so the cases aren't related?
586 not sure this whole thing is a good idea. how do we know that
587 something that is only in plus is really freshly created? *)
588 let plusses = Common.minus_set plusses all_minuses in
589 let was_bot = minuses = True
in
590 let new_minuses = filter_combine minuses in_plus
in
591 let new_plusses = Common.union_set
plusses in_plus
in
592 (* perhaps it should be build_and here? we don't realy have multiple
593 minirules anymore anyway. *)
594 match new_minuses with
596 let getter = do_get_constants drop keep env neg_pos
in
597 let retry = getter.V.combiner_top_level cur
in
599 True
when not
was_bot -> (rest_info
, new_plusses)
600 | x
-> (build_or x rest_info
, new_plusses))
601 | x
-> (build_or x rest_info
, new_plusses))
602 (False
,in_plus
) (List.combine tls neg_pos
)
604 let run rules neg_pos_vars
=
607 (function (rest_info
,in_plus
,env
,locals
(*dom of env*)) ->
609 (Ast.ScriptRule
(nm
,_
,deps
,mv
,_
,_
),_
) ->
613 function (_
,(rule
,_
),_
) ->
616 else Ast.AndDep
(Ast.Dep rule
,prev
))
618 (match dependencies env
extra_deps with
619 False
-> (rest_info
, in_plus
, (nm
,True
)::env
, nm
::locals
)
621 (build_or
dependencies rest_info
, in_plus
, env
, locals
))
622 | (Ast.InitialScriptRule
(_
,_
,deps
,_
),_
)
623 | (Ast.FinalScriptRule
(_
,_
,deps
,_
),_
) ->
624 (* initialize and finalize dependencies are irrelevant to
626 (rest_info
, in_plus
, env
, locals
)
627 | (Ast.CocciRule
(nm
,(dep
,_
,_
),cur
,_
,_
),neg_pos_vars
) ->
628 let (cur_info
,cur_plus
) =
629 rule_fn cur in_plus
((nm
,True
)::env
)
631 (match dependencies env dep
with
632 False
-> (rest_info
,cur_plus
,env
,locals
)
634 if List.for_all
all_context.V.combiner_top_level cur
635 then (rest_info
,cur_plus
,(nm
,cur_info
)::env
,nm
::locals
)
637 (* no constants if dependent on another rule; then we need to
638 find the constants of that rule *)
639 (build_or
(build_and dependencies cur_info
) rest_info
,
640 cur_plus
,env
,locals
)))
642 (List.combine
(rules
: Ast.rule list
) neg_pos_vars
) in
645 let get_constants rules neg_pos_vars
=
646 match !Flag.scanner
with
647 Flag.NoScanner
-> (None
,None
)
649 let res = run rules neg_pos_vars
in
650 (interpret_grep true res,None
)
652 let res = run rules neg_pos_vars
in
653 (interpret_grep true res,interpret_glimpse true res)
655 let res = run rules neg_pos_vars
in
656 (interpret_grep true res,interpret_google true res)