2 * Copyright 2005-2009, Ecole des Mines de Nantes, University of Copenhagen
3 * Yoann Padioleau, Julia Lawall, Rene Rydhof Hansen, Henrik Stuart, Gilles Muller
4 * This file is part of Coccinelle.
6 * Coccinelle is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, according to version 2 of the License.
10 * Coccinelle 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.
15 * You should have received a copy of the GNU General Public License
16 * along with Coccinelle. If not, see <http://www.gnu.org/licenses/>.
18 * The authors reserve the right to distribute this or future versions of
19 * Coccinelle under other licenses.
23 module Flag_engine
= Flag_matcher
24 (*****************************************************************************)
25 (* The functor argument *)
26 (*****************************************************************************)
28 (* info passed recursively in monad in addition to binding *)
30 optional_storage_iso
: bool;
31 optional_qualifier_iso
: bool;
32 value_format_iso
: bool;
35 module XMATCH
= struct
37 (* ------------------------------------------------------------------------*)
38 (* Combinators history *)
39 (* ------------------------------------------------------------------------*)
42 * type ('a, 'b) matcher = 'a -> 'b -> bool
44 * version1: same but with a global variable holding the current binding
46 * - can have multiple possibilities
48 * - sometimes have to undo, cos if start match, then it binds,
49 * and if later it does not match, then must undo the first binds.
50 * ex: when match parameters, can try to match, but then we found far
51 * later that the last argument of a function does not match
52 * => have to uando the binding !!!
53 * (can handle that too with a global, by saving the
54 * global, ... but sux)
55 * => better not use global
58 * type ('a, 'b) matcher = binding -> 'a -> 'b -> binding list
60 * Empty list mean failure (let matchfailure = []).
61 * To be able to have pretty code, have to use partial application
62 * powa, and so the type is in fact
65 * type ('a, 'b) matcher = 'a -> 'b -> binding -> binding list
67 * Then by defining the correct combinators, can have quite pretty code (that
68 * looks like the clean code of version0).
70 * opti: return a lazy list of possible matchs ?
72 * version4: type tin = Lib_engine.metavars_binding
75 (* ------------------------------------------------------------------------*)
76 (* Standard type and operators *)
77 (* ------------------------------------------------------------------------*)
81 binding
: Lib_engine.metavars_binding
;
82 binding0
: Lib_engine.metavars_binding
; (* inherited bindings *)
84 (* 'x is a ('a * 'b) but in fact dont care about 'b, we just tag the SP *)
85 (* opti? use set instead of list *)
86 type 'x tout
= ('x
* Lib_engine.metavars_binding
) list
88 type ('a
, 'b
) matcher
= 'a
-> 'b
-> tin
-> ('a
* 'b
) tout
91 let (>>=) m1 m2
= fun tin
->
93 let xxs = xs +> List.map
(fun ((a
,b
), binding
) ->
94 m2 a b
{tin
with binding
= binding
}
98 (* Je compare les bindings retournés par les differentes branches.
99 * Si la deuxieme branche amene a des bindings qui sont deja presents
100 * dans la premiere branche, alors je ne les accepte pas.
102 * update: still useful now that julia better handle Exp directly via
103 * ctl tricks using positions ?
105 let (>|+|>) m1 m2
= fun tin
->
114 let list_bindings_already = List.map snd
res1 in
116 (res2 +> List.filter
(fun (x
, binding
) ->
118 (list_bindings_already +> List.exists
(fun already
->
119 Lib_engine.equal_binding binding already
))
125 let (>||>) m1 m2
= fun tin
->
132 (* opti? use set instead of list *)
136 let return res
= fun tin
->
139 let fail = fun tin
->
142 let (>&&>) f m
= fun tin
->
148 let mode = Cocci_vs_c.PatternMode
150 (* ------------------------------------------------------------------------*)
152 (* ------------------------------------------------------------------------*)
153 let cocciExp = fun expf expa node
-> fun tin
->
155 let globals = ref [] in
158 Visitor_c.default_visitor_c
with
159 Visitor_c.kexpr
= (fun (k
, bigf) expb
->
160 match expf expa expb tin
with
161 | [] -> (* failed *) k expb
163 globals := xs @ !globals;
164 if not
!Flag_engine.disallow_nested_exps
then k expb
(* CHOICE *)
167 * push2 expr globals; k expr
169 * !globals +> List.fold_left (fun acc e -> acc >||> match_e_e expr e)
175 Visitor_c.vk_node
bigf node
;
176 !globals +> List.map
(fun ((a
, _exp
), binding
) ->
180 (* same as cocciExp, but for expressions in an expression, not expressions
182 let cocciExpExp = fun expf expa expb
-> fun tin
->
184 let globals = ref [] in
187 Visitor_c.default_visitor_c
with
188 Visitor_c.kexpr
= (fun (k
, bigf) expb
->
189 match expf expa expb tin
with
190 | [] -> (* failed *) k expb
192 globals := xs @ !globals;
193 if not
!Flag_engine.disallow_nested_exps
then k expb
(* CHOICE *)
196 * push2 expr globals; k expr
198 * !globals +> List.fold_left (fun acc e -> acc >||> match_e_e expr e)
204 Visitor_c.vk_expr
bigf expb
;
205 !globals +> List.map
(fun ((a
, _exp
), binding
) ->
209 let cocciTy = fun expf expa node
-> fun tin
->
211 let globals = ref [] in
213 Visitor_c.default_visitor_c
with
214 Visitor_c.ktype
= (fun (k
, bigf) expb
->
215 match expf expa expb tin
with
216 | [] -> (* failed *) k expb
217 | xs -> globals := xs @ !globals);
221 Visitor_c.vk_node
bigf node
;
222 !globals +> List.map
(fun ((a
, _exp
), binding
) ->
226 let cocciInit = fun expf expa node
-> fun tin
->
228 let globals = ref [] in
230 Visitor_c.default_visitor_c
with
231 Visitor_c.kini
= (fun (k
, bigf) expb
->
232 match expf expa expb tin
with
233 | [] -> (* failed *) k expb
234 | xs -> globals := xs @ !globals);
238 Visitor_c.vk_node
bigf node
;
239 !globals +> List.map
(fun ((a
, _exp
), binding
) ->
244 (* ------------------------------------------------------------------------*)
245 (* Distribute mcode *)
246 (* ------------------------------------------------------------------------*)
247 let tag_mck_pos mck posmck
=
249 | Ast_cocci.PLUS
-> Ast_cocci.PLUS
250 | Ast_cocci.CONTEXT
(pos
, xs) ->
251 assert (pos
=*= Ast_cocci.NoPos
|| pos
=*= Ast_cocci.DontCarePos
);
252 Ast_cocci.CONTEXT
(posmck
, xs)
253 | Ast_cocci.MINUS
(pos
, xs) ->
254 assert (pos
=*= Ast_cocci.NoPos
|| pos
=*= Ast_cocci.DontCarePos
);
255 Ast_cocci.MINUS
(posmck
, xs)
258 let tag_mck_pos_mcode (x
,info
,mck
,pos
) posmck stuff
= fun tin
->
259 [((x
, info
, tag_mck_pos mck posmck
, pos
),stuff
), tin
.binding
]
262 let distrf (ii_of_x_f
) =
263 fun mcode x
-> fun tin
->
264 let (max
, min
) = Lib_parsing_c.max_min_by_pos
(ii_of_x_f x
)
266 let posmck = Ast_cocci.FixPos
(min
, max
) (* subtil: and not max, min !!*)
268 tag_mck_pos_mcode mcode
posmck x tin
270 let distrf_e = distrf (Lib_parsing_c.ii_of_expr
)
271 let distrf_args = distrf (Lib_parsing_c.ii_of_args
)
272 let distrf_type = distrf (Lib_parsing_c.ii_of_type
)
273 let distrf_param = distrf (Lib_parsing_c.ii_of_param
)
274 let distrf_params = distrf (Lib_parsing_c.ii_of_params
)
275 let distrf_ini = distrf (Lib_parsing_c.ii_of_ini
)
276 let distrf_node = distrf (Lib_parsing_c.ii_of_node
)
277 let distrf_struct_fields = distrf (Lib_parsing_c.ii_of_struct_fields
)
278 let distrf_cst = distrf (Lib_parsing_c.ii_of_cst
)
279 let distrf_define_params = distrf (Lib_parsing_c.ii_of_define_params
)
282 (* ------------------------------------------------------------------------*)
283 (* Constraints on metavariable values *)
284 (* ------------------------------------------------------------------------*)
285 let check_constraints matcher constraints exp
= fun f tin
->
286 let rec loop = function
287 [] -> f
() tin
(* success *)
289 match matcher c exp tin
with
290 [] (* failure *) -> loop cs
291 | _
(* success *) -> fail tin
in
294 let check_pos_constraints constraints pvalu f tin
=
297 let success = [[]] in
299 (* relies on the fact that constraints on pos variables must refer to
300 inherited variables *)
301 (match Common.optionise
(fun () -> tin
.binding0
+> List.assoc c
) with
303 if Cocci_vs_c.equal_metavarval exp valu'
304 then success else failure
306 (* if the variable is not there, it puts no constraints *)
307 (* not sure this is still useful *)
309 constraints pvalu f tin
311 (* ------------------------------------------------------------------------*)
313 (* ------------------------------------------------------------------------*)
314 (* pre: if have declared a new metavar that hide another one, then
315 * must be passed with a binding that deleted this metavar
317 * Here we dont use the keep argument of julia. cf f(X,X), J'ai
318 * besoin de garder le X en interne, meme si julia s'en fout elle du
319 * X et qu'elle a mis X a DontSaved.
321 let check_add_metavars_binding strip _keep inherited
= fun (k
, valu
) tin
->
324 match Common.optionise
(fun () -> tin
.binding0
+> List.assoc k
) with
326 if Cocci_vs_c.equal_metavarval valu valu'
327 then Some tin
.binding
331 match Common.optionise
(fun () -> tin
.binding
+> List.assoc k
) with
333 if Cocci_vs_c.equal_metavarval valu valu'
334 then Some tin
.binding
340 Ast_c.MetaIdVal a
-> Ast_c.MetaIdVal a
341 | Ast_c.MetaFuncVal a
-> Ast_c.MetaFuncVal a
342 | Ast_c.MetaLocalFuncVal a
-> Ast_c.MetaLocalFuncVal a
(*more?*)
343 | Ast_c.MetaExprVal a
->
346 then Lib_parsing_c.al_expr a
347 else Lib_parsing_c.semi_al_expr a
)
348 | Ast_c.MetaExprListVal a
->
349 Ast_c.MetaExprListVal
351 then Lib_parsing_c.al_arguments a
352 else Lib_parsing_c.semi_al_arguments a
)
354 | Ast_c.MetaStmtVal a
->
357 then Lib_parsing_c.al_statement a
358 else Lib_parsing_c.semi_al_statement a
)
359 | Ast_c.MetaTypeVal a
->
362 then Lib_parsing_c.al_type a
363 else Lib_parsing_c.semi_al_type a
)
365 | Ast_c.MetaInitVal a
->
368 then Lib_parsing_c.al_init a
369 else Lib_parsing_c.semi_al_init a
)
371 | Ast_c.MetaListlenVal a
-> Ast_c.MetaListlenVal a
373 | Ast_c.MetaParamVal a
-> failwith
"not handling MetaParamVal"
374 | Ast_c.MetaParamListVal a
->
375 Ast_c.MetaParamListVal
377 then Lib_parsing_c.al_params a
378 else Lib_parsing_c.semi_al_params a
)
380 | Ast_c.MetaPosVal
(pos1
,pos2
) -> Ast_c.MetaPosVal
(pos1
,pos2
)
381 | Ast_c.MetaPosValList l
-> Ast_c.MetaPosValList l
382 in Some
(tin
.binding
+> Common.insert_assoc
(k
, valu'
))
384 let envf keep inherited
= fun (k
, valu, get_max_min
) f tin
->
385 let x = Ast_cocci.unwrap_mcode k
in
386 match check_add_metavars_binding true keep inherited
(x, valu) tin
with
388 let new_tin = {tin
with binding
= binding
} in
389 (match Ast_cocci.get_pos_var k
with
390 Ast_cocci.MetaPos
(name
,constraints
,per
,keep
,inherited
) ->
392 let (file
,current_element
,min
,max
) = get_max_min
() in
393 Ast_c.MetaPosValList
[(file
,current_element
,min
,max
)] in
394 (* check constraints. success means that there is a match with
395 one of the constraints, which will ultimately result in
397 check_pos_constraints constraints
pvalu
399 (* constraints are satisfied, now see if we are compatible
400 with existing bindings *)
402 let x = Ast_cocci.unwrap_mcode name
in
404 check_add_metavars_binding false keep inherited
(x, pvalu)
407 f
() {new_tin with binding
= binding
}
410 | Ast_cocci.NoMetaPos
-> f
() new_tin)
413 (* ------------------------------------------------------------------------*)
414 (* Environment, allbounds *)
415 (* ------------------------------------------------------------------------*)
416 (* all referenced inherited variables have to be bound. This would
417 * be naturally checked for the minus or context ones in the
418 * matching process, but have to check the plus ones as well. The
419 * result of get_inherited contains all of these, but the potential
420 * redundant checking for the minus and context ones is probably not
421 * a big deal. If it's a problem, could fix free_vars to distinguish
422 * between + variables and the other ones. *)
424 let (all_bound
: Ast_cocci.meta_name list
-> tin
-> bool) = fun l tin
->
425 l
+> List.for_all
(fun inhvar
->
426 match Common.optionise
(fun () -> tin
.binding0
+> List.assoc inhvar
) with
431 let optional_storage_flag f
= fun tin
->
432 f
(tin
.extra
.optional_storage_iso
) tin
434 let optional_qualifier_flag f
= fun tin
->
435 f
(tin
.extra
.optional_qualifier_iso
) tin
437 let value_format_flag f
= fun tin
->
438 f
(tin
.extra
.value_format_iso
) tin
441 (* ------------------------------------------------------------------------*)
443 (* ------------------------------------------------------------------------*)
444 let tokenf ia ib
= fun tin
->
445 let pos = Ast_c.info_to_fixpos ib
in
446 let posmck = Ast_cocci.FixPos
(pos, pos) in
447 let finish tin
= tag_mck_pos_mcode ia
posmck ib tin
in
448 match Ast_cocci.get_pos_var ia
with
449 Ast_cocci.MetaPos
(name
,constraints
,per
,keep
,inherited
) ->
450 let mpos = Lib_parsing_c.lin_col_by_pos
[ib
] in
451 let pvalu = Ast_c.MetaPosValList
[mpos] in
452 check_pos_constraints constraints
pvalu
454 (* constraints are satisfied, now see if we are compatible
455 with existing bindings *)
457 let x = Ast_cocci.unwrap_mcode name
in
459 check_add_metavars_binding false keep inherited
(x, pvalu) tin
461 Some binding
-> finish {tin
with binding
= binding
}
466 let tokenf_mck mck ib
= fun tin
->
467 let pos = Ast_c.info_to_fixpos ib
in
468 let posmck = Ast_cocci.FixPos
(pos, pos) in
469 [(tag_mck_pos mck
posmck, ib
), tin
.binding
]
473 (*****************************************************************************)
475 (*****************************************************************************)
476 module MATCH
= Cocci_vs_c.COCCI_VS_C
(XMATCH
)
479 let match_re_node2 dropped_isos a b binding0
=
483 optional_storage_iso
= not
(List.mem
"optional_storage" dropped_isos
);
484 optional_qualifier_iso
= not
(List.mem
"optional_qualifier" dropped_isos
);
485 value_format_iso
= not
(List.mem
"value_format" dropped_isos
);
488 XMATCH.binding0
= binding0
;
491 MATCH.rule_elem_node a b
tin
492 (* take only the tagged-SP, the 'a' *)
493 +> List.map
(fun ((a
,_b
), binding
) -> a
, binding
)
496 let match_re_node a b c d
=
497 Common.profile_code
"Pattern3.match_re_node"
498 (fun () -> match_re_node2 a b c d
)