forked from coccinelle/coccinelle
-
Notifications
You must be signed in to change notification settings - Fork 1
/
cocci.ml
1470 lines (1267 loc) · 46.1 KB
/
cocci.ml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
(*
* Copyright 2005-2008, 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.
*)
open Common
module CCI = Ctlcocci_integration
module TAC = Type_annoter_c
(*****************************************************************************)
(* This file is a kind of driver. It gathers all the important functions
* from coccinelle in one place. The different entities in coccinelle are:
* - files
* - astc
* - astcocci
* - flow (contain nodes)
* - ctl (contain rule_elems)
* This file contains functions to transform one in another.
*)
(*****************************************************************************)
(* --------------------------------------------------------------------- *)
(* C related *)
(* --------------------------------------------------------------------- *)
let cprogram_of_file file =
let (program2, _stat) = Parse_c.parse_print_error_heuristic file in
program2
let cprogram_of_file_cached file =
let (program2, _stat) = Parse_c.parse_cache file in
if !Flag_cocci.ifdef_to_if
then
program2 +> Parse_c.with_program2 (fun asts ->
Cpp_ast_c.cpp_ifdef_statementize asts
)
else program2
let cfile_of_program program2_with_ppmethod outf =
Unparse_c.pp_program program2_with_ppmethod outf
(* for memoization, contains only one entry, the one for the SP *)
let _hparse = Hashtbl.create 101
let _hctl = Hashtbl.create 101
(* --------------------------------------------------------------------- *)
(* Cocci related *)
(* --------------------------------------------------------------------- *)
let sp_of_file2 file iso =
Common.memoized _hparse (file, iso) (fun () ->
Parse_cocci.process file iso false)
let sp_of_file file iso =
Common.profile_code "parse cocci" (fun () -> sp_of_file2 file iso)
(* --------------------------------------------------------------------- *)
(* Flow related *)
(* --------------------------------------------------------------------- *)
let print_flow flow =
Ograph_extended.print_ograph_mutable flow "/tmp/test.dot" true
let ast_to_flow_with_error_messages2 x =
let flowopt =
try Ast_to_flow.ast_to_control_flow x
with Ast_to_flow.Error x ->
Ast_to_flow.report_error x;
None
in
flowopt +> do_option (fun flow ->
(* This time even if there is a deadcode, we still have a
* flow graph, so I can try the transformation and hope the
* deadcode will not bother us.
*)
try Ast_to_flow.deadcode_detection flow
with Ast_to_flow.Error (Ast_to_flow.DeadCode x) ->
Ast_to_flow.report_error (Ast_to_flow.DeadCode x);
);
flowopt
let ast_to_flow_with_error_messages a =
Common.profile_code "flow" (fun () -> ast_to_flow_with_error_messages2 a)
(* --------------------------------------------------------------------- *)
(* Ctl related *)
(* --------------------------------------------------------------------- *)
let ctls_of_ast2 ast ua pos =
List.map2
(function ast -> function (ua,pos) ->
List.combine
(if !Flag_cocci.popl
then Popl.popl ast
else Asttoctl2.asttoctl ast ua pos)
(Asttomember.asttomember ast ua))
ast (List.combine ua pos)
let ctls_of_ast ast ua =
Common.profile_code "asttoctl2" (fun () -> ctls_of_ast2 ast ua)
(*****************************************************************************)
(* Some debugging functions *)
(*****************************************************************************)
(* the inputs *)
let show_or_not_cfile2 cfile =
if !Flag_cocci.show_c then begin
Common.pr2_xxxxxxxxxxxxxxxxx ();
pr2 ("processing C file: " ^ cfile);
Common.pr2_xxxxxxxxxxxxxxxxx ();
Common.command2 ("cat " ^ cfile);
end
let show_or_not_cfile a =
Common.profile_code "show_xxx" (fun () -> show_or_not_cfile2 a)
let show_or_not_cfiles cfiles = List.iter show_or_not_cfile cfiles
let show_or_not_cocci2 coccifile isofile =
if !Flag_cocci.show_cocci then begin
Common.pr2_xxxxxxxxxxxxxxxxx ();
pr2 ("processing semantic patch file: " ^ coccifile);
isofile +> (fun s -> pr2 ("with isos from: " ^ s));
Common.pr2_xxxxxxxxxxxxxxxxx ();
Common.command2 ("cat " ^ coccifile);
pr2 "";
end
let show_or_not_cocci a b =
Common.profile_code "show_xxx" (fun () -> show_or_not_cocci2 a b)
(* the output *)
let show_or_not_diff2 cfile outfile show_only_minus =
if !Flag_cocci.show_diff then begin
match Common.fst(Compare_c.compare_default cfile outfile) with
Compare_c.Correct -> () (* diff only in spacing, etc *)
| _ ->
(* may need --strip-trailing-cr under windows *)
pr2 "diff = ";
let line =
match !Flag_parsing_c.diff_lines with
| None -> "diff -u -p " ^ cfile ^ " " ^ outfile
| Some n -> "diff -U "^n^" -p "^cfile^" "^outfile in
let xs =
let res = Common.cmd_to_list line in
match (!Flag.patch,res) with
(* create something that looks like the output of patch *)
(Some prefix,minus_file::plus_file::rest) ->
let drop_prefix file =
if prefix = ""
then "/"^file
else
(match Str.split (Str.regexp prefix) file with
[base_file] -> base_file
| _ -> failwith "prefix not found in the old file name") in
let diff_line =
match List.rev(Str.split (Str.regexp " ") line) with
new_file::old_file::cmdrev ->
if !Flag.sgrep_mode2
then
String.concat " "
(List.rev ("/tmp/nothing" :: old_file :: cmdrev))
else
let old_base_file = drop_prefix old_file in
String.concat " "
(List.rev
(("b"^old_base_file)::("a"^old_base_file)::cmdrev))
| _ -> failwith "bad command" in
let (minus_line,plus_line) =
if !Flag.sgrep_mode2
then (minus_file,plus_file)
else
match (Str.split (Str.regexp "[ \t]") minus_file,
Str.split (Str.regexp "[ \t]") plus_file) with
("---"::old_file::old_rest,"+++"::new_file::new_rest) ->
let old_base_file = drop_prefix old_file in
(String.concat " "
("---"::("a"^old_base_file)::old_rest),
String.concat " "
("+++"::("b"^old_base_file)::new_rest))
| (l1,l2) ->
failwith
(Printf.sprintf "bad diff header lines: %s %s"
(String.concat ":" l1) (String.concat ":" l2)) in
diff_line::minus_line::plus_line::rest
| _ -> res in
xs +> List.iter (fun s ->
if s =~ "^\\+" && show_only_minus
then ()
else pr s)
end
let show_or_not_diff a b c =
Common.profile_code "show_xxx" (fun () -> show_or_not_diff2 a b c)
(* the derived input *)
let show_or_not_ctl_tex2 astcocci ctls =
if !Flag_cocci.show_ctl_tex then begin
Ctltotex.totex ("/tmp/__cocci_ctl.tex") astcocci ctls;
Common.command2 ("cd /tmp; latex __cocci_ctl.tex; " ^
"dvips __cocci_ctl.dvi -o __cocci_ctl.ps;" ^
"gv __cocci_ctl.ps &");
end
let show_or_not_ctl_tex a b =
Common.profile_code "show_xxx" (fun () -> show_or_not_ctl_tex2 a b)
let show_or_not_rule_name ast rulenb =
if !Flag_cocci.show_ctl_text or !Flag.show_trying or
!Flag_cocci.show_transinfo or !Flag_cocci.show_binding_in_out
then
begin
let name =
match ast with
Ast_cocci.CocciRule (nm, (deps, drops, exists), x, _) -> nm
| _ -> i_to_s rulenb in
Common.pr_xxxxxxxxxxxxxxxxx ();
pr (name ^ " = ");
Common.pr_xxxxxxxxxxxxxxxxx ()
end
let show_or_not_scr_rule_name rulenb =
if !Flag_cocci.show_ctl_text or !Flag.show_trying or
!Flag_cocci.show_transinfo or !Flag_cocci.show_binding_in_out
then
begin
let name = i_to_s rulenb in
Common.pr_xxxxxxxxxxxxxxxxx ();
pr ("script rule " ^ name ^ " = ");
Common.pr_xxxxxxxxxxxxxxxxx ()
end
let show_or_not_ctl_text2 ctl ast rulenb =
if !Flag_cocci.show_ctl_text then begin
adjust_pp_with_indent (fun () ->
Format.force_newline();
Pretty_print_cocci.print_plus_flag := true;
Pretty_print_cocci.print_minus_flag := true;
Pretty_print_cocci.unparse ast;
);
pr "CTL = ";
let (ctl,_) = ctl in
adjust_pp_with_indent (fun () ->
Format.force_newline();
Pretty_print_engine.pp_ctlcocci
!Flag_cocci.show_mcodekind_in_ctl !Flag_cocci.inline_let_ctl ctl;
);
pr "";
end
let show_or_not_ctl_text a b c =
Common.profile_code "show_xxx" (fun () -> show_or_not_ctl_text2 a b c)
(* running information *)
let get_celem celem : string =
match celem with
Ast_c.Definition ({Ast_c.f_name = funcs;},_) -> funcs
| Ast_c.Declaration
(Ast_c.DeclList ([{Ast_c.v_namei = Some ((s, _),_);}, _], _)) -> s
| _ -> ""
let show_or_not_celem2 prelude celem =
let (tag,trying) =
(match celem with
| Ast_c.Definition ({Ast_c.f_name = funcs;},_) ->
Flag.current_element := funcs;
(" function: ",funcs)
| Ast_c.Declaration
(Ast_c.DeclList ([{Ast_c.v_namei = Some ((s, _),_);}, _], _)) ->
Flag.current_element := s;
(" variable ",s);
| _ ->
Flag.current_element := "something_else";
(" ","something else");
) in
if !Flag.show_trying then pr2 (prelude ^ tag ^ trying)
let show_or_not_celem a b =
Common.profile_code "show_xxx" (fun () -> show_or_not_celem2 a b)
let show_or_not_trans_info2 trans_info =
if !Flag_cocci.show_transinfo then begin
if null trans_info then pr2 "transformation info is empty"
else begin
pr2 "transformation info returned:";
let trans_info =
List.sort (function (i1,_,_) -> function (i2,_,_) -> compare i1 i2)
trans_info
in
indent_do (fun () ->
trans_info +> List.iter (fun (i, subst, re) ->
pr2 ("transform state: " ^ (Common.i_to_s i));
indent_do (fun () ->
adjust_pp_with_indent_and_header "with rule_elem: " (fun () ->
Pretty_print_cocci.print_plus_flag := true;
Pretty_print_cocci.print_minus_flag := true;
Pretty_print_cocci.rule_elem "" re;
);
adjust_pp_with_indent_and_header "with binding: " (fun () ->
Pretty_print_engine.pp_binding subst;
);
)
);
)
end
end
let show_or_not_trans_info a =
Common.profile_code "show_xxx" (fun () -> show_or_not_trans_info2 a)
let show_or_not_binding2 s binding =
if !Flag_cocci.show_binding_in_out then begin
adjust_pp_with_indent_and_header ("binding " ^ s ^ " = ") (fun () ->
Pretty_print_engine.pp_binding binding
)
end
let show_or_not_binding a b =
Common.profile_code "show_xxx" (fun () -> show_or_not_binding2 a b)
(*****************************************************************************)
(* Some helper functions *)
(*****************************************************************************)
let worth_trying cfiles tokens =
(* drop the following line for a list of list by rules. since we don't
allow multiple minirules, all the tokens within a rule should be in
a single CFG entity *)
let tokens = Common.union_all tokens in
if not !Flag_cocci.windows && not (null tokens)
then
(* could also modify the code in get_constants.ml *)
let tokens = tokens +> List.map (fun s ->
match () with
| _ when s =~ "^[A-Za-z_][A-Za-z_0-9]*$" ->
"\\b" ^ s ^ "\\b"
| _ when s =~ "^[A-Za-z_]" ->
"\\b" ^ s
| _ when s =~ ".*[A-Za-z_]$" ->
s ^ "\\b"
| _ -> s
) in
let com = sprintf "egrep -q '(%s)' %s" (join "|" tokens) (join " " cfiles)
in
(match Sys.command com with
| 0 (* success *) -> true
| _ (* failure *) ->
(if !Flag.show_misc
then Printf.printf "grep failed: %s\n" com);
false (* no match, so not worth trying *)
)
else true
let check_macro_in_sp_and_adjust tokens =
let tokens = Common.union_all tokens in
tokens +> List.iter (fun s ->
if Hashtbl.mem !Parsing_hacks._defs s
then begin
pr2 "warning: macro in semantic patch was in macro definitions";
pr2 ("disabling macro expansion for " ^ s);
Hashtbl.remove !Parsing_hacks._defs s
end
)
let contain_loop gopt =
match gopt with
| Some g ->
g#nodes#tolist +> List.exists (fun (xi, node) ->
Control_flow_c.extract_is_loop node
)
| None -> true (* means nothing, if no g then will not model check *)
let sp_contain_typed_metavar_z toplevel_list_list =
let bind x y = x or y in
let option_default = false in
let mcode _ _ = option_default in
let donothing r k e = k e in
let expression r k e =
match Ast_cocci.unwrap e with
| Ast_cocci.MetaExpr (_,_,_,Some t,_,_) -> true
| Ast_cocci.MetaExpr (_,_,_,_,Ast_cocci.LocalID,_) -> true
| _ -> k e
in
let combiner =
Visitor_ast.combiner bind option_default
mcode mcode mcode mcode mcode mcode mcode mcode mcode mcode mcode mcode
mcode
donothing donothing donothing donothing
donothing expression donothing donothing donothing donothing donothing
donothing donothing donothing donothing donothing
in
toplevel_list_list +>
List.exists
(function (nm,_,rule) ->
(List.exists combiner.Visitor_ast.combiner_top_level rule))
let sp_contain_typed_metavar rules =
sp_contain_typed_metavar_z
(List.map
(function x ->
match x with
Ast_cocci.CocciRule (a,b,c,d) -> (a,b,c)
| _ -> failwith "error in filter")
(List.filter
(function x ->
match x with Ast_cocci.CocciRule _ -> true | _ -> false)
rules))
(* finding among the #include the one that we need to parse
* because they may contain useful type definition or because
* we may have to modify them
*
* For the moment we base in part our heuristic on the name of the file, e.g.
* serio.c is related we think to #include <linux/serio.h>
*)
let (includes_to_parse: (Common.filename * Parse_c.program2) list -> 'a) = fun xs ->
if !Flag_cocci.no_includes
then []
else
xs +> List.map (fun (file, cs) ->
let dir = Common.dirname file in
cs +> Common.map_filter (fun (c,_info_item) ->
match c with
| Ast_c.CppTop (Ast_c.Include {Ast_c.i_include = ((x,ii));
i_rel_pos = info_h_pos;}) ->
(match x with
| Ast_c.Local xs ->
let f = Filename.concat dir (Common.join "/" xs) in
(* for our tests, all the files are flat in the current dir *)
if not (Sys.file_exists f) && !Flag_cocci.relax_include_path
then
let attempt2 = Filename.concat dir (Common.last xs) in
if not (Sys.file_exists f) && !Flag_cocci.all_includes
then Some (Filename.concat !Flag_cocci.include_path
(Common.join "/" xs))
else Some attempt2
else Some f
| Ast_c.NonLocal xs ->
if !Flag_cocci.all_includes ||
Common.fileprefix (Common.last xs) = Common.fileprefix file
then
Some (Filename.concat !Flag_cocci.include_path
(Common.join "/" xs))
else None
| Ast_c.Wierd _ -> None
)
| _ -> None
)
)
+> List.concat
+> Common.uniq
let rec interpret_dependencies local global = function
Ast_cocci.Dep s -> List.mem s local
| Ast_cocci.AntiDep s ->
(if !Flag_ctl.steps != None
then failwith "steps and ! dependency incompatible");
not (List.mem s local)
| Ast_cocci.EverDep s -> List.mem s global
| Ast_cocci.NeverDep s ->
(if !Flag_ctl.steps != None
then failwith "steps and ! dependency incompatible");
not (List.mem s global)
| Ast_cocci.AndDep(s1,s2) ->
(interpret_dependencies local global s1) &&
(interpret_dependencies local global s2)
| Ast_cocci.OrDep(s1,s2) ->
(interpret_dependencies local global s1) or
(interpret_dependencies local global s2)
| Ast_cocci.NoDep -> true
let rec print_dependencies str local global dep =
if !Flag_cocci.show_dependencies
then
begin
pr2 str;
let seen = ref [] in
let rec loop = function
Ast_cocci.Dep s | Ast_cocci.AntiDep s ->
if not (List.mem s !seen)
then
begin
if List.mem s local
then pr2 (s^" satisfied")
else pr2 (s^" not satisfied");
seen := s :: !seen
end
| Ast_cocci.EverDep s | Ast_cocci.NeverDep s ->
if not (List.mem s !seen)
then
begin
if List.mem s global
then pr2 (s^" satisfied")
else pr2 (s^" not satisfied");
seen := s :: !seen
end
| Ast_cocci.AndDep(s1,s2) ->
loop s1;
loop s2
| Ast_cocci.OrDep(s1,s2) ->
loop s1;
loop s2
| Ast_cocci.NoDep -> () in
loop dep
end
(* --------------------------------------------------------------------- *)
(* #include relative position in the file *)
(* --------------------------------------------------------------------- *)
(* compute the set of new prefixes
* on
* "a/b/x"; (* in fact it is now a list of string so ["a";"b";"x"] *)
* "a/b/c/x";
* "a/x";
* "b/x";
* it would give for the first element
* ""; "a"; "a/b"; "a/b/x"
* for the second
* "a/b/c/x"
*
* update: if the include is inside a ifdef a put nothing. cf -test incl.
* this is because we dont want code added inside ifdef.
*)
let compute_new_prefixes xs =
xs +> Common.map_withenv (fun already xs ->
let subdirs_prefixes = Common.inits xs in
let new_first = subdirs_prefixes +> List.filter (fun x ->
not (List.mem x already)
)
in
new_first,
new_first @ already
) []
+> fst
(* does via side effect on the ref in the Include in Ast_c *)
let rec update_include_rel_pos cs =
let only_include = cs +> Common.map_filter (fun c ->
match c with
| Ast_c.CppTop (Ast_c.Include {Ast_c.i_include = ((x,_));
i_rel_pos = aref;
i_is_in_ifdef = inifdef}) ->
(match x with
| Ast_c.Wierd _ -> None
| _ ->
if inifdef
then None
else Some (x, aref)
)
| _ -> None
)
in
let (locals, nonlocals) =
only_include +> Common.partition_either (fun (c, aref) ->
match c with
| Ast_c.Local x -> Left (x, aref)
| Ast_c.NonLocal x -> Right (x, aref)
| Ast_c.Wierd x -> raise Impossible
) in
update_rel_pos_bis locals;
update_rel_pos_bis nonlocals;
cs
and update_rel_pos_bis xs =
let xs' = List.map fst xs in
let the_first = compute_new_prefixes xs' in
let the_last = List.rev (compute_new_prefixes (List.rev xs')) in
let merged = Common.zip xs (Common.zip the_first the_last) in
merged +> List.iter (fun ((x, aref), (the_first, the_last)) ->
aref := Some
{
Ast_c.first_of = the_first;
Ast_c.last_of = the_last;
}
)
(*****************************************************************************)
(* All the information needed around the C elements and Cocci rules *)
(*****************************************************************************)
type toplevel_c_info = {
ast_c: Ast_c.toplevel; (* contain refs so can be modified *)
tokens_c: Parser_c.token list;
fullstring: string;
flow: Control_flow_c.cflow option; (* it's the "fixed" flow *)
contain_loop: bool;
env_typing_before: TAC.environment;
env_typing_after: TAC.environment;
was_modified: bool ref;
(* id: int *)
}
type toplevel_cocci_info_script_rule = {
scr_ast_rule: string * (string * (string * string)) list * string;
language: string;
scr_dependencies: Ast_cocci.dependency;
scr_ruleid: int;
script_code: string;
}
type toplevel_cocci_info_cocci_rule = {
ctl: Lib_engine.ctlcocci * (CCI.pred list list);
ast_rule: Ast_cocci.rule;
isexp: bool; (* true if + code is an exp, only for Flag.make_hrule *)
rulename: string;
dependencies: Ast_cocci.dependency;
(* There are also some hardcoded rule names in parse_cocci.ml:
* let reserved_names = ["all";"optional_storage";"optional_qualifier"]
*)
dropped_isos: string list;
free_vars: Ast_cocci.meta_name list;
negated_pos_vars: Ast_cocci.meta_name list;
used_after: Ast_cocci.meta_name list;
positions: Ast_cocci.meta_name list;
ruleid: int;
was_matched: bool ref;
}
type toplevel_cocci_info =
ScriptRuleCocciInfo of toplevel_cocci_info_script_rule
| CocciRuleCocciInfo of toplevel_cocci_info_cocci_rule
type kind_file = Header | Source
type file_info = {
fname : string;
full_fname : string;
was_modified_once: bool ref;
asts: toplevel_c_info list;
fpath : string;
fkind : kind_file;
}
let g_contain_typedmetavar = ref false
let last_env_toplevel_c_info xs =
(Common.last xs).env_typing_after
let concat_headers_and_c (ccs: file_info list)
: (toplevel_c_info * string) list =
(List.concat (ccs +> List.map (fun x ->
x.asts +> List.map (fun x' ->
(x', x.fname)))))
let for_unparser xs =
xs +> List.map (fun x ->
(x.ast_c, (x.fullstring, x.tokens_c)), Unparse_c.PPviastr
)
let gen_pdf_graph () =
(Ctl_engine.get_graph_files ()) +> List.iter (fun outfile ->
Printf.printf "Generation of %s%!" outfile;
let filename_stack = Ctl_engine.get_graph_comp_files outfile in
List.iter (fun filename ->
ignore (Unix.system ("dot " ^ filename ^ " -Tpdf -o " ^ filename ^ ".pdf;"))
) filename_stack;
let (head,tail) = (List.hd filename_stack, List.tl filename_stack) in
ignore(Unix.system ("cp " ^ head ^ ".pdf " ^ outfile ^ ".pdf;"));
tail +> List.iter (fun filename ->
ignore(Unix.system ("mv " ^ outfile ^ ".pdf /tmp/tmp.pdf;"));
ignore(Unix.system ("pdftk " ^ filename ^ ".pdf /tmp/tmp.pdf cat output " ^ outfile ^ ".pdf"));
);
ignore(Unix.system ("rm /tmp/tmp.pdf;"));
List.iter (fun filename ->
ignore (Unix.system ("rm " ^ filename ^ " " ^ filename ^ ".pdf;"))
) filename_stack;
Printf.printf " - Done\n")
(* --------------------------------------------------------------------- *)
let prepare_cocci ctls free_var_lists negated_pos_lists
used_after_lists positions_list astcocci =
let gathered = Common.index_list_1
(zip (zip (zip (zip (zip ctls astcocci) free_var_lists)
negated_pos_lists) used_after_lists) positions_list)
in
gathered +> List.map
(fun ((((((ctl_toplevel_list,ast),free_var_list),negated_pos_list),
used_after_list),
positions_list),rulenb) ->
let is_script_rule r =
match r with Ast_cocci.ScriptRule _ -> true | _ -> false in
if not (List.length ctl_toplevel_list = 1) && not (is_script_rule ast)
then failwith "not handling multiple minirules";
match ast with
Ast_cocci.ScriptRule (lang,deps,mv,code) ->
let r =
{
scr_ast_rule = (lang, mv, code);
language = lang;
scr_dependencies = deps;
scr_ruleid = rulenb;
script_code = code;
}
in ScriptRuleCocciInfo r
| Ast_cocci.CocciRule
(rulename,(dependencies,dropped_isos,z),restast,isexp) ->
CocciRuleCocciInfo (
{
ctl = List.hd ctl_toplevel_list;
ast_rule = ast;
isexp = List.hd isexp;
rulename = rulename;
dependencies = dependencies;
dropped_isos = dropped_isos;
free_vars = List.hd free_var_list;
negated_pos_vars = List.hd negated_pos_list;
used_after = List.hd used_after_list;
positions = List.hd positions_list;
ruleid = rulenb;
was_matched = ref false;
})
)
(* --------------------------------------------------------------------- *)
let build_info_program cprogram env =
let (cs, parseinfos) = Common.unzip cprogram in
let (cs, envs) =
Common.unzip (TAC.annotate_program env !g_contain_typedmetavar cs) in
zip (zip cs parseinfos) envs +> List.map (fun ((c, parseinfo), (enva,envb))->
let (fullstr, tokens) = parseinfo in
let flow =
ast_to_flow_with_error_messages c +> Common.map_option (fun flow ->
let flow = Ast_to_flow.annotate_loop_nodes flow in
(* remove the fake nodes for julia *)
let fixed_flow = CCI.fix_flow_ctl flow in
if !Flag_cocci.show_flow then print_flow fixed_flow;
if !Flag_cocci.show_before_fixed_flow then print_flow flow;
fixed_flow
)
in
{
ast_c = c; (* contain refs so can be modified *)
tokens_c = tokens;
fullstring = fullstr;
flow = flow;
contain_loop = contain_loop flow;
env_typing_before = enva;
env_typing_after = envb;
was_modified = ref false;
}
)
(* Optimisation. Try not unparse/reparse the whole file when have modifs *)
let rebuild_info_program cs file isexp =
cs +> List.map (fun c ->
if !(c.was_modified)
then
(match !Flag.make_hrule with
Some dir ->
Unparse_hrule.pp_program (c.ast_c, (c.fullstring, c.tokens_c))
dir file isexp;
[]
| None ->
let file = Common.new_temp_file "cocci_small_output" ".c" in
cfile_of_program
[(c.ast_c, (c.fullstring, c.tokens_c)), Unparse_c.PPnormal]
file;
(* Common.command2 ("cat " ^ file); *)
let cprogram = cprogram_of_file file in
let xs = build_info_program cprogram c.env_typing_before in
(* TODO: assert env has not changed,
* if yes then must also reparse what follows even if not modified.
* Do that only if contain_typedmetavar of course, so good opti.
*)
(* Common.list_init xs *) (* get rid of the FinalDef *)
xs)
else [c]
) +> List.concat
let rebuild_info_c_and_headers ccs isexp =
ccs +> List.iter (fun c_or_h ->
if c_or_h.asts +> List.exists (fun c -> !(c.was_modified))
then c_or_h.was_modified_once := true;
);
ccs +> List.map (fun c_or_h ->
{ c_or_h with
asts = rebuild_info_program c_or_h.asts c_or_h.full_fname isexp }
)
let prepare_c files : file_info list =
let cprograms = List.map cprogram_of_file_cached files in
let includes = includes_to_parse (zip files cprograms) in
(* todo?: may not be good to first have all the headers and then all the c *)
let all =
(includes +> List.map (fun hpath -> Right hpath))
++
((zip files cprograms) +> List.map (fun (file, asts) -> Left (file, asts)))
in
let env = ref TAC.initial_env in
let ccs = all +> Common.map_filter (fun x ->
match x with
| Right hpath ->
if not (Common.lfile_exists hpath)
then begin
pr2 ("TYPE: header " ^ hpath ^ " not found");
None
end
else
let h_cs = cprogram_of_file_cached hpath in
let info_h_cs = build_info_program h_cs !env in
env :=
if null info_h_cs
then !env
else last_env_toplevel_c_info info_h_cs
;
Some {
fname = Common.basename hpath;
full_fname = hpath;
asts = info_h_cs;
was_modified_once = ref false;
fpath = hpath;
fkind = Header;
}
| Left (file, cprogram) ->
(* todo?: don't update env ? *)
let cs = build_info_program cprogram !env in
(* we do that only for the c, not for the h *)
ignore(update_include_rel_pos (cs +> List.map (fun x -> x.ast_c)));
Some {
fname = Common.basename file;
full_fname = file;
asts = cs;
was_modified_once = ref false;
fpath = file;
fkind = Source;
}
)
in
ccs
(*****************************************************************************)
(* Processing the ctls and toplevel C elements *)
(*****************************************************************************)
(* The main algorithm =~
* The algorithm is roughly:
* for_all ctl rules in SP
* for_all minirule in rule (no more)
* for_all binding (computed during previous phase)
* for_all C elements
* match control flow of function vs minirule
* with the binding and update the set of possible
* bindings, and returned the possibly modified function.
* pretty print modified C elements and reparse it.
*
*
* On ne prends que les newbinding ou returned_any_state est vrai.
* Si ca ne donne rien, on prends ce qu'il y avait au depart.
* Mais au nouveau depart de quoi ?
* - si ca donne rien apres avoir traité toutes les fonctions avec ce binding ?
* - ou alors si ca donne rien, apres avoir traité toutes les fonctions
* avec tous les bindings du round d'avant ?
*
* Julia pense qu'il faut prendre la premiere solution.
* Example: on a deux environnements candidats, E1 et E2 apres avoir traité
* la regle ctl 1. On arrive sur la regle ctl 2.
* E1 ne donne rien pour la regle 2, on garde quand meme E1 pour la regle 3.
* E2 donne un match a un endroit et rend E2' alors on utilise ca pour
* la regle 3.
*
* I have not to look at used_after_list to decide to restart from
* scratch. I just need to look if the binding list is empty.
* Indeed, let's suppose that a SP have 3 regions/rules. If we
* don't find a match for the first region, then if this first
* region does not bind metavariable used after, that is if
* used_after_list is empty, then mysat(), even if does not find a
* match, will return a Left, with an empty transformation_info,
* and so current_binding will grow. On the contrary if the first
* region must bind some metavariables used after, and that we
* dont find any such region, then mysat() will returns lots of
* Right, and current_binding will not grow, and so we will have
* an empty list of binding, and we will catch such a case.
*
* opti: julia says that because the binding is
* determined by the used_after_list, the items in the list
* are kind of sorted, so could optimise the insert_set operations.
*)
(* r(ule), c(element in C code), e(nvironment) *)
let rec apply_python_rule r cache newes e rules_that_have_matched
rules_that_have_ever_matched =
show_or_not_scr_rule_name r.scr_ruleid;
if not(interpret_dependencies rules_that_have_matched
!rules_that_have_ever_matched r.scr_dependencies)
then
begin
print_dependencies "dependencies for script not satisfied:"
rules_that_have_matched
!rules_that_have_ever_matched r.scr_dependencies;
show_or_not_binding "in environment" e;
(cache, (e, rules_that_have_matched)::newes)
end
else
begin
let (_, mv, _) = r.scr_ast_rule in
if List.for_all (Pycocci.contains_binding e) mv
then
begin
let relevant_bindings =
List.filter
(function ((re,rm),_) ->
List.exists (function (_,(r,m)) -> r = re && m = rm) mv)
e in
let new_cache =
if List.mem relevant_bindings cache
then cache
else
begin