forked from coccinelle/coccinelle
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathenter.ml
1875 lines (1676 loc) · 63.3 KB
/
enter.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
(*
* This file is part of Coccinelle, licensed under the terms of the GPL v2.
* See copyright.txt in the Coccinelle source code for more information.
* The Coccinelle source code can be obtained at http://coccinelle.lip6.fr
*)
open Common
module FC = Flag_cocci
module Inc = Includes
(*****************************************************************************)
(* Flags *)
(*****************************************************************************)
(* In addition to flags that can be tweaked via -xxx options (cf the
* full list of options in "the spatch options" section below), the
* spatch program also depends on external files, described in
* globals/config.ml, mainly a standard.h and standard.iso file *)
let cocci_file = ref ""
let opt_c_files = ref []
let output_file = ref "" (* resulting code *)
let tmp_dir = ref "" (* temporary files for parallelism *)
let aux_file_suffix =
ref (None : string option) (* suffix for backup if one is desired *)
let outplace_modif = ref false (* generates a .cocci_res *)
let preprocess = ref false (* run the C preprocessor before cocci *)
let compat_mode = ref false
let ignore_unknown_opt = ref false
let profile_per_file = ref false
let dir = ref false
let ignore = ref []
let file_groups = ref false
let kbuild_info = ref ""
let macro_file = ref ""
(* test mode *)
let test_mode = ref false
let test_all = ref false
let test_spacing = ref false
let test_okfailed = ref false
let test_regression_okfailed = ref false
let expected_score_file = ref ""
let expected_spacing_score_file = ref ""
let allow_update_score_file = ref true
(* action mode *)
let action = ref ""
(* works with -test but also in "normal" spatch mode *)
let compare_with_expected = ref (None : string option)
let distrib_index = ref (None : int option)
let distrib_max = ref (None : int option)
let mod_distrib = ref false
let previous_merges = ref (([], []) : Cocci.merge_vars)
(*****************************************************************************)
(* Profiles *)
(*****************************************************************************)
(* pair of (list of flags to set true, list of flags to set false *)
let very_quiet_profile = (
[
],
[
(* FC.show_diff; just leave this as it is *)
Common.print_to_stderr;
Flag.show_misc;
Flag.show_trying;
Flag.show_transinfo;
FC.show_c;
FC.show_cocci;
FC.show_flow;
FC.show_before_fixed_flow;
FC.show_ctl_tex;
FC.show_ctl_text;
FC.show_binding_in_out;
FC.verbose_cocci;
Flag_parsing_c.show_parsing_error;
Flag_parsing_c.verbose_lexing;
Flag_parsing_c.verbose_parsing;
Flag_parsing_c.verbose_type;
Flag_parsing_c.verbose_cfg;
Flag_parsing_c.verbose_unparsing;
Flag_parsing_c.verbose_visit;
Flag_parsing_c.verbose_cpp_ast;
Flag_parsing_c.verbose_includes;
Flag_matcher.verbose_matcher;
Flag_matcher.debug_engine;
Flag_parsing_c.debug_unparsing;
Flag_parsing_cocci.show_SP;
Flag_parsing_cocci.show_iso_failures;
Flag_ctl.verbose_ctl_engine;
Flag_ctl.verbose_match;
])
let quiet_profile = (
[
Common.print_to_stderr
],
[
(* FC.show_diff; just leave this as it is *)
Flag.show_misc;
Flag.show_trying;
Flag.show_transinfo;
FC.show_c;
FC.show_cocci;
FC.show_flow;
FC.show_before_fixed_flow;
FC.show_ctl_tex;
FC.show_ctl_text;
FC.show_binding_in_out;
FC.verbose_cocci;
Flag_parsing_c.show_parsing_error;
Flag_parsing_c.verbose_lexing;
Flag_parsing_c.verbose_parsing;
Flag_parsing_c.verbose_type;
Flag_parsing_c.verbose_cfg;
Flag_parsing_c.verbose_unparsing;
Flag_parsing_c.verbose_visit;
Flag_parsing_c.verbose_cpp_ast;
Flag_parsing_c.verbose_includes;
Flag_matcher.verbose_matcher;
Flag_matcher.debug_engine;
Flag_parsing_c.debug_unparsing;
Flag_parsing_cocci.show_SP;
Flag_parsing_cocci.show_iso_failures;
Flag_ctl.verbose_ctl_engine;
Flag_ctl.verbose_match;
])
let testing_profile = (
[
Common.print_to_stderr;
FC.show_diff;
],
[
Flag.show_misc;
Flag.show_trying;
Flag.show_transinfo;
FC.show_c;
FC.show_cocci;
FC.show_flow;
FC.show_before_fixed_flow;
FC.show_ctl_tex;
FC.show_ctl_text;
FC.show_binding_in_out;
FC.verbose_cocci;
Flag_parsing_c.show_parsing_error;
Flag_parsing_c.verbose_lexing;
Flag_parsing_c.verbose_parsing;
Flag_parsing_c.verbose_type;
Flag_parsing_c.verbose_cfg;
Flag_parsing_c.verbose_unparsing;
Flag_parsing_c.verbose_visit;
Flag_parsing_c.verbose_cpp_ast;
Flag_parsing_c.verbose_includes;
Flag_matcher.verbose_matcher;
Flag_matcher.debug_engine;
Flag_parsing_c.debug_unparsing;
Flag_parsing_cocci.show_SP;
Flag_parsing_cocci.show_iso_failures;
Flag_ctl.verbose_ctl_engine;
Flag_ctl.verbose_match;
])
(* some information that is useful in seeing why a semantic patch doesn't
work properly *)
let debug_profile = (
[
Common.print_to_stderr;
Flag.show_misc;
Flag.show_transinfo;
FC.show_diff;
FC.show_cocci;
FC.show_binding_in_out;
FC.show_dependencies;
Flag_parsing_cocci.keep_ml_script;
Flag_parsing_cocci.show_iso_failures;
FC.verbose_cocci;
Flag_parsing_c.verbose_cfg;
Flag_parsing_c.verbose_unparsing;
Flag_parsing_c.verbose_visit;
Flag_matcher.verbose_matcher;
Flag_parsing_c.show_parsing_error;
],
[
Flag.show_misc;
FC.show_c;
FC.show_flow;
FC.show_before_fixed_flow;
FC.show_ctl_tex;
FC.show_ctl_text;
Flag_parsing_cocci.show_SP;
Flag_ctl.verbose_ctl_engine;
Flag_ctl.verbose_match;
Flag_matcher.debug_engine;
Flag_parsing_c.debug_unparsing;
Flag_parsing_c.verbose_type;
Flag_parsing_c.verbose_parsing;
Flag_parsing_c.verbose_includes;
])
let pad_profile = (
[
FC.show_diff;
Common.print_to_stderr;
],
[
Flag.show_misc;
Flag.show_transinfo;
FC.show_c;
FC.show_cocci;
FC.show_flow;
FC.show_before_fixed_flow;
FC.show_ctl_tex;
FC.show_ctl_text;
FC.show_binding_in_out;
Flag_parsing_cocci.show_SP;
Flag_parsing_cocci.show_iso_failures;
Flag_ctl.verbose_ctl_engine;
Flag_ctl.verbose_match;
Flag_matcher.debug_engine;
Flag_parsing_c.debug_unparsing;
Flag_parsing_c.verbose_type;
Flag_parsing_c.verbose_parsing;
Flag_parsing_c.verbose_includes;
])
let run_profile p =
let (set_to_true, set_to_false) = p in
List.iter (fun x -> x := false) set_to_false;
List.iter (fun x -> x := true) set_to_true
(*****************************************************************************)
(* The spatch options *)
(*****************************************************************************)
let usage_msg =
"Usage: " ^ Filename.basename Sys.argv.(0) ^
" --sp-file <SP> <infile> [-o <outfile>] [--iso-file <iso>] [options]" ^
"\n" ^ "Options are:"
(* forward reference trick *)
let short_usage_func = ref (fun () -> ())
let long_usage_func = ref (fun () -> ())
(* The short_options are user-oriented. The other options are for
* the developers of coccinelle or advanced-users that know
* quite well the underlying semantics of coccinelle.
*)
(* will be printed when use only ./spatch. For the rest you have to
* use -longhelp to see them.
*)
let print_version () =
let yes_or_no_of_bool b = if b then "yes" else "no" in
let withocaml = yes_or_no_of_bool Prepare_ocamlcocci.ocaml_support in
let withpython = yes_or_no_of_bool Pycocci.python_support in
let whichregexp =
if !Regexp.pcre_support then "PCRE"
else "Str" in
let flags =
if Config.configure_flags<>"" then Config.configure_flags
else "[none]" in
(* let mode = if Dynlink.is_native then "native" else "byte-code" in *)
Printf.printf "spatch version %s compiled with OCaml version %s\n"
(* mode *) Config.version Config.ocaml_version;
Printf.printf "Flags passed to the configure script: %s\n" flags;
Printf.printf "OCaml scripting support: %s\n" withocaml;
Printf.printf "Python scripting support: %s\n" withpython;
Printf.printf "Syntax of regular expressions: %s\n" whichregexp;
exit 0
let short_options = [
"--sp-file", Arg.Set_string cocci_file,
" <file> the semantic patch file";
"--opt-c",
Arg.String (fun filename ->
if Sys.file_exists filename
then
if Sys.is_directory filename
then
failwith (filename ^ " is a directory but a c source file was expected")
else
opt_c_files := filename::!opt_c_files),
" <file> a c file to process if it exists";
"-o", Arg.Set_string output_file,
" <file> the output file";
"--in-place", Arg.Set Flag_cocci.inplace_modif,
" do the modification on the file directly (backup file name specified with --suffix)";
"--suffix", Arg.String (function s -> aux_file_suffix := Some s),
" suffix to use when making a backup for inplace or for result of --out-place";
"--out-place", Arg.Set outplace_modif,
" store modifications in a .cocci_res file (renamable via --suffix)";
"--reverse", Arg.Set Flag_parsing_cocci.interpret_inverted,
" invert the semantic patch before applying it";
"-U", Arg.Int (fun n -> Flag_parsing_c.diff_lines := Some (string_of_int n)),
" set number of diff context lines";
"--partial-match", Arg.Set Flag_ctl.partial_match,
" report partial matches of the SP on the C file";
"--iso-file", Arg.Set_string Config.std_iso,
" <file> (default=" ^ !Config.std_iso ^")";
"--macro-file", Arg.Set_string macro_file,
" <file>";
"--macro-file-builtins", Arg.Set_string Config.std_h,
" <file> (default=" ^ !Config.std_h ^ ")";
"--recursive-includes",
Arg.Unit (function _ -> Inc.set_parsing_style Inc.Parse_really_all_includes),
(" causes all available include files, both those included in the"^
" C file(s) and those included in header files, to be used");
"--all-includes",
Arg.Unit (function _ -> Inc.set_parsing_style Inc.Parse_all_includes),
" causes all available include files included in the C file(s) to be used";
"--no-includes",
Arg.Unit (function _ -> Inc.set_parsing_style Inc.Parse_no_includes),
" causes not even local include files to be used";
"--local-includes",
Arg.Unit (function _ -> Inc.set_parsing_style Inc.Parse_local_includes),
" causes local include files to be used";
"--include-headers-for-types", Arg.Set Inc.include_headers_for_types,
" use only type information from header files";
"--no-include-cache", Arg.Set Flag.no_include_cache,
" don't cache parsed include files";
"--ignore-unknown-options", Arg.Set ignore_unknown_opt,
(" For integration in a toolchain (must be set before the first unknown"^
" option)");
"--include-headers", Arg.Set Flag.include_headers,
" process header files independently";
"-I", Arg.String (fun x -> Inc.include_path:= x::!Inc.include_path),
" <dir> containing the header files";
"--include", Arg.String (fun x -> Inc.extra_includes:=x::!Inc.extra_includes),
" file to consider as being included";
"--preprocess", Arg.Set preprocess,
" run the C preprocessor before applying the semantic match";
"-c", Arg.Set compat_mode, " gcc/cpp compatibility mode";
"--dir", Arg.Set dir,
" <dir> process all files in directory recursively";
"--ignore", Arg.String (fun s -> ignore := s :: !ignore),
" <string> specify a file name prefix to ignore";
"--file-groups", Arg.Set file_groups,
" <file> process the file groups listed in the file";
"--no-scanner", Arg.Unit (function _ -> Flag.scanner := Flag.NoScanner),
" no indexing";
"--use-gitgrep", Arg.Unit (function _ -> Flag.scanner := Flag.GitGrep),
" works with -dir, works on git tree subdirectories";
"--use-glimpse", Arg.Unit (function _ -> Flag.scanner := Flag.Glimpse),
" works with -dir, use info generated by glimpseindex";
"--use-idutils",
Arg.String (function s -> Flag_parsing_cocci.id_utils_index := s;
Flag.scanner := Flag.IdUtils),
" find relevant files using id-utils";
"--use-coccigrep",
Arg.Unit (function _ -> Flag.scanner := Flag.CocciGrep),
" find relevant files using cocci grep";
"--use-diff",
Arg.Unit (function _ -> Flag.scanner := Flag.PatchDiff),
" process files in the diff for a directory";
"--use-patch-diff",
Arg.String
(function s ->
let (startid,endid) = Patch_diff.split s in
Flag.scanner := Flag.PatchDiffRange(startid,endid)),
" process files in the diff for a directory";
"--patch",
Arg.String (function s -> Flag.patch := Some (Cocci.normalize_path s)),
(" <dir> path name with respect to which a patch should be created\n"^
" \"\" for a file in the current directory");
"--kbuild-info", Arg.Set_string kbuild_info,
" <file> improve -dir by grouping related c files";
"--python", Arg.Set_string Config.python_interpreter,
" Sets the path to the python interpreter";
"--pyoutput", Arg.Set_string Flag.pyoutput,
" Sets output routine: Default value: coccilib.output.Console";
"--parse-handler",
Arg.String (fun f ->
let f' = Prepare_ocamlcocci.prepare_simple f in
Prepare_ocamlcocci.load_file f'),
" <file> Loads the file containing the OCaml code in charge of parse errors reporting";
"--print-options-only", Arg.Unit (fun () -> ()),
" print selected options and exit";
"--version", Arg.Unit print_version, " print version and build info";
"--date", Arg.Unit (fun () ->
Printf.printf "version: $Date$";
raise (Common.UnixExit 0)
),
" guess what";
"--shorthelp", Arg.Unit (fun () ->
!short_usage_func();
raise (Common.UnixExit 0)
),
" see short list of options";
"--longhelp", Arg.Unit (fun () ->
!long_usage_func();
raise (Common.UnixExit 0)
),
" see all the available options in different categories";
"-help", Arg.Unit (fun () ->
!long_usage_func();
raise (Common.UnixExit 0)
),
" ";
"--help", Arg.Unit (fun () ->
!long_usage_func();
raise (Common.UnixExit 0)
),
" ";
]
(* the format is a list of triples:
* (title of section * (optional) explanation of sections * option list)
*)
let other_options = [
"aliases and obsolete options",
"",
[
"--sp", Arg.Unit (function _ -> failwith "impossible"),
" command line semantic patch";
"--iso", Arg.Set_string Config.std_iso, " short option of --iso-file";
"--cocci-file", Arg.Set_string cocci_file,
" <file> the semantic patch file";
(* "-c", Arg.Set_string cocci_file, " short option of -sp_file"; *)
];
"most useful show options",
"",
[
"--show-diff" , Arg.Set FC.show_diff, " ";
"--no-show-diff" , Arg.Clear FC.show_diff, " ";
"--force-diff" , Arg.Set FC.force_diff,
" show diff even if only spacing changes";
"--show-flow" , Arg.Set FC.show_flow, " ";
(* works in conjunction with -show_ctl_text *)
"--ctl-inline-let",
Arg.Unit
(function _ -> FC.show_ctl_text := true; FC.inline_let_ctl := true), " ";
"--ctl-show-mcodekind",
Arg.Unit
(function _ -> FC.show_ctl_text := true; FC.show_mcodekind_in_ctl := true),
" ";
"--show-bindings", Arg.Set FC.show_binding_in_out, " ";
"--show-transinfo", Arg.Set Flag.show_transinfo, " ";
"--show-misc", Arg.Set Flag.show_misc, " ";
"--show-trying", Arg.Set Flag.show_trying,
" show the name of each function being processed";
"--show-dependencies",
Arg.Unit (function _ -> FC.show_dependencies := true;
FC.show_binding_in_out := true),
" show the dependencies related to each rule";
];
"verbose subsystems options",
"",
[
"--verbose-ctl-engine",
Arg.Unit (function _ ->
Flag_ctl.verbose_ctl_engine := true; FC.show_ctl_text := true) , " ";
"--verbose-match", Arg.Set Flag_ctl.verbose_match, " ";
"--verbose-engine", Arg.Set Flag_matcher.debug_engine, " ";
"--graphical-trace", Arg.Set Flag_ctl.graphical_trace, " generate a pdf file representing the matching process";
"--gt-without-label",
Arg.Unit (function _ ->
Flag_ctl.graphical_trace := true; Flag_ctl.gt_without_label := true),
" remove graph label (requires option -graphical-trace)";
"--parse-error-msg", Arg.Set Flag_parsing_c.show_parsing_error, " ";
"--verbose-parsing",
Arg.Unit (fun _ -> Flag_parsing_c.verbose_parsing := true;
Flag_parsing_c.show_parsing_error := true), " ";
"--verbose-includes", Arg.Set Flag_parsing_c.verbose_includes,
" show on stderr which files are chosen for inclusion";
"--type-error-msg", Arg.Set Flag_parsing_c.verbose_type, " ";
(* could also use Flag_parsing_c.options_verbose *)
];
"other show options",
"",
[
"--show-c" , Arg.Set FC.show_c, " ";
"--show-cocci" , Arg.Set FC.show_cocci, " ";
"--show-before-fixed-flow" , Arg.Set FC.show_before_fixed_flow, " ";
"--show-ctl-tex" , Arg.Set FC.show_ctl_tex, " ";
"--show-ctl-text" , Arg.Set FC.show_ctl_text, " ";
"--show-SP" , Arg.Set Flag_parsing_cocci.show_SP, " ";
];
"debug C parsing/unparsing",
"",
[
"--debug-cpp", Arg.Set Flag_parsing_c.debug_cpp, " ";
"--debug-lexer", Arg.Set Flag_parsing_c.debug_lexer , " ";
"--debug-etdt", Arg.Set Flag_parsing_c.debug_etdt , " ";
"--debug-typedef", Arg.Set Flag_parsing_c.debug_typedef, " ";
"--filter-msg", Arg.Set Flag_parsing_c.filter_msg ,
" filter some cpp message when the macro is a \"known\" cpp construct";
"--filter-define-error", Arg.Set Flag_parsing_c.filter_define_error," ";
"--filter-msg-define-error", Arg.Set Flag_parsing_c.filter_msg_define_error,
" filter the error msg";
"--filter-passed-level", Arg.Set_int Flag_parsing_c.filter_passed_level," ";
(* debug cfg doesn't seem to have any effect, so drop it as an option *)
(* "--debug_cfg", Arg.Set Flag_parsing_c.debug_cfg , " "; *)
"--debug-unparsing", Arg.Set Flag_parsing_c.debug_unparsing, " ";
"--debug-parse-cocci", Arg.Set Flag_parsing_cocci.debug_parse_cocci, " ";
];
(* could use Flag_parsing_c.options_debug_with_title instead *)
"shortcut for enabling/disabling a set of debugging options at once",
"",
[
(* todo: other profile ? *)
"--quiet", Arg.Unit (fun () -> run_profile quiet_profile), " ";
"--very-quiet", Arg.Unit (fun () -> run_profile very_quiet_profile), " ";
"--debug", Arg.Unit (fun () -> run_profile debug_profile), " ";
"--pad", Arg.Unit (fun () -> run_profile pad_profile), " ";
];
"bench options",
"",
[
"--profile", Arg.Unit (function () -> Common.profile := Common.PALL) ,
" gather timing information about the main coccinelle functions";
"--profile-per-file",
Arg.Unit
(function () -> profile_per_file :=true; Common.profile := Common.PALL),
" gather timing information for each file (implies --profile)";
"--bench", Arg.Int (function x -> Flag_ctl.bench := x),
" <level> for profiling the CTL engine";
"--timeout",
Arg.Int (fun x -> FC.timeout := (if x = 0 then None else Some x)),
" <sec> timeout in seconds, 0 for no timeout";
"--steps", Arg.Int (fun x -> Flag_ctl.steps := Some x),
" max number of model checking steps per code unit";
"--iso-limit", Arg.Int (fun x -> Flag_parsing_cocci.iso_limit := Some x),
" max depth of iso application";
"--no-iso-limit", Arg.Unit (fun _ -> Flag_parsing_cocci.iso_limit := None),
" disable limit on max depth of iso application";
"--track-iso", Arg.Set Flag.track_iso_usage,
" gather information about isomorphism usage";
"--disable-iso",
Arg.String
(fun s -> Flag_parsing_cocci.disabled_isos :=
s :: !Flag_parsing_cocci.disabled_isos),
" disable a specific isomorphism";
"--profile-iso",
Arg.Unit
(function () ->
Common.profile :=
(*post_engine not included, because it doesn't use isos*)
PSOME ["parse cocci";"mysat";"asttoctl2";"pre_engine";"full_engine"]),
" gather information about the cost of isomorphism usage"
];
"change of algorithm options",
"",
[
(* "--popl", Arg.Set FC.popl,
" simplified SmPL, for the popl paper";
"--popl_mark_all",
Arg.Unit
(function _ -> FC.popl := true; Flag_popl.mark_all := true),
" simplified SmPL, for the popl paper";
"--popl_keep_all_wits",
Arg.Unit
(function _ -> FC.popl := true; Flag_popl.keep_all_wits := true),
" simplified SmPL, for the popl paper";
"--hrule", Arg.String
(function s ->
Flag.make_hrule := Some s; Inc.include_options := Inc.Parse_no_includes),
" semantic patch generation";
*)
"--keep-comments", Arg.Set Flag_parsing_c.keep_comments,
" keep comments around removed code";
"--loop", Arg.Set Flag_ctl.loop_in_src_code, " ";
"--no-loops", Arg.Set Flag_parsing_c.no_loops,
" drop all back edges derived from looping constructs - unsafe";
"--no-gotos", Arg.Set Flag_parsing_c.no_gotos,
" drop all jumps derived from gotos - unsafe";
"--no-saved-typedefs", Arg.Clear Flag_cocci.use_saved_typedefs,
" drop all inferred typedefs from one parse of some code to the next";
"--ocaml-regexps", Arg.Clear Regexp.pcre_support,
" use OCaml Str regular expressions for constraints";
"--l1", Arg.Clear Flag_parsing_c.label_strategy_2, " ";
"--ifdef-to-if", Arg.Set Flag_parsing_c.ifdef_to_if,
" convert ifdef to if (experimental)";
"--no-ifdef-to-if", Arg.Clear Flag_parsing_c.ifdef_to_if,
" convert ifdef to if (experimental)";
"--disable-multi-pass", Arg.Set Flag_parsing_c.disable_multi_pass, " ";
"--noif0-passing", Arg.Clear Flag_parsing_c.if0_passing, " ";
"--itu", Arg.Set Flag_parsing_c.exts_ITU,
" Experimental extensions for handling #ifdef developed at ITU.dk";
"--defined", Arg.String (Flag_parsing_c.add Flag_parsing_c.defined),
" <symbol> treat cpp symbol as defined in #ifdef";
"--undefined", Arg.String
(Flag_parsing_c.add Flag_parsing_c.undefined),
" <symbol> treat cpp symbol as undefined in #ifdef";
"--noadd-typedef-root", Arg.Clear Flag_parsing_c.add_typedef_root, " ";
(* could use Flag_parsing_c.options_algo instead *)
"--disallow-nested-exps", Arg.Set Flag_matcher.disallow_nested_exps,
" disallow an expression pattern from matching a term and its subterm";
"--disable-worth-trying-opt", Arg.Clear Flag.worth_trying_opt,
" run the semantic patch even if the C file contains no relevant tokens";
"--selected-only", Arg.Set FC.selected_only, " only show selected files";
"--only-return-is-error-exit",
Arg.Set Flag_matcher.only_return_is_error_exit,
" if this flag is not set, then break and continue are also error exits";
(* the following is a hack to make it easier to add code in sgrep-like
code, essentially to compensate for the fact that we don't have
any way of printing things out *)
"--allow-inconsistent-paths",
Arg.Set Flag_matcher.allow_inconsistent_paths,
" if this flag is set don't check for inconsistent paths; dangerous";
"--no-safe-expressions",
Arg.Set Flag_matcher.no_safe_expressions,
" make an expression disjunction not prioritise the topmost disjunct";
"--int-bits", Arg.Int Flag_parsing_c.set_int_bits,
" the number of bits in an unsigned int";
"--long-bits", Arg.Int Flag_parsing_c.set_long_bits,
" the number of bits in an unsigned long";
"--linux-spacing", Arg.Unit Flag_parsing_c.set_linux_spacing,
" spacing of + code follows the conventions of Linux";
"--smpl-spacing", Arg.Unit Flag_parsing_c.set_smpl_spacing,
" spacing of + code follows the semantic patch";
"--indent", Arg.Set_int Flag_parsing_c.indent,
" default indent, in spaces (no tabs)";
"--max-width", Arg.Set_int Flag_parsing_c.max_width,
" column limit for generated code";
"-D", Arg.String Flag.set_defined_virtual_rules,
" indicate that a virtual rule should be considered to be matched";
"--c++", Arg.Unit (fun () -> Flag.set_c_plus_plus None),
" make a small attempt to parse C++ files";
(* Special case, for when a user gives a specific C++ version *)
"--c++=",
Arg.Symbol (["98"; "03"; "0x"; "11"; "1y"; "14"; "1z"; "17"; "2a"; "20"],
(fun i -> Flag.set_c_plus_plus (Some i))),
" <int> same as --c++ but allows to specify a version (e.g. --c++=11)";
"--ibm", Arg.Set Flag.ibm,
" make a small attempt to parse IBM C files";
"--force-kr", Arg.Set Flag_parsing_c.force_kr,
" despite the presence of non-K&R code, keep looking for K&R code";
"--prevent-kr", Arg.Set Flag_parsing_c.prevent_kr,
" never make an identifier parameter alone into a K&R parameter";
];
"misc options",
"",
[
"--debugger", Arg.Set Common.debugger,
" option to set if launch spatch in ocamldebug";
"--disable-once", Arg.Set Common.disable_pr2_once,
" to print more messages";
"--show-trace-profile", Arg.Set Common.show_trace_profile,
" show trace";
"--save-tmp-files", Arg.Set Common.save_tmp_files, " ";
"--external-analysis-file", Arg.String
(Externalanalysis.load_external_results),
" import results from an external analysis";
];
"concurrency",
"",
[
"--index", Arg.Int (function x -> distrib_index := Some x) ,
" the processor to use for this run of spatch";
"--max", Arg.Int (function x -> distrib_max := Some x) ,
" the number of processors available";
"--mod-distrib", Arg.Set mod_distrib,
" use mod to distribute files among the processors";
"--jobs", Arg.Int (function x -> Flag.parmap_cores := Some x),
" the number of processes to be used";
"-j", Arg.Int (function x -> Flag.parmap_cores := Some x),
" the number of processes to be used";
"--chunksize", Arg.Int (function x -> Flag.parmap_chunk_size := Some x),
" the size of work chunks for parallelism";
"--tmp-dir", Arg.Set_string tmp_dir,
" prefix of temporary directories for parallelism";
"--temp-files", Arg.Set_string Common.temp_files,
" prefix of temporary directory for cocci files";
];
"pad options",
"",
[
"--use-cache", Arg.Set Flag_parsing_c.use_cache,
" use .ast_raw pre-parsed cached C file";
"--cache-prefix",
Arg.String (function s ->
Flag_parsing_c.cache_prefix := Some s;
Flag_parsing_c.use_cache := true),
" directory of cached ASTs, sets --use-cache";
(* could use Flag_parsing_c.options_pad instead *)
"--cache-limit",
Arg.Int (function n ->
Flag_parsing_c.cache_limit := Some n;
Flag_parsing_c.use_cache := true),
" maximum number of cached ASTs, sets --use-cache";
];
"test mode and test options (works with tests/ or .ok files)",
"The test options don't work with the --sp-file and so on.",
[
"--test", Arg.Set test_mode,
" <file> launch spatch on tests/file.[c,cocci]";
"--testall", Arg.Set test_all,
" launch spatch on all files in tests/ having a .res";
"--test-spacing", Arg.Set test_spacing,
" check that the result matches the .res file exactly";
"--test-okfailed", Arg.Set test_okfailed,
" generates .{ok,failed,spatch_ok} files using .res files";
"--test-regression-okfailed", Arg.Set test_regression_okfailed,
" process the .{ok,failed,spatch_ok} files in current dir";
"--compare-with-expected",
Arg.Unit (fun _ -> compare_with_expected := Some ".res"),
" use also file.res";
"--expected-extension",
Arg.String (fun x -> compare_with_expected := Some x),
" extension for --compare-with-expected; implicitly sets --compare-with-expected";
"--expected-score-file", Arg.Set_string expected_score_file,
" which score file to compare with in --testall";
"--expected-spacing-score-file",
Arg.Set_string expected_spacing_score_file,
" which score file to compare with in --test-spacing";
"--no-update-score-file", Arg.Clear allow_update_score_file,
" do not update the score file when -testall succeeds";
"--relax-include-path", Arg.Set Inc.relax_include_path,
" ";
"--batch_mode", Arg.Set _batch_mode,
" no interactivity"
];
"action mode",
("The action options don't work with the --sp-file and so on." ^ "\n" ^
"It's for the other (internal) uses of the spatch program."
),
(* -token_c, -parse_c, etc *)
((Common.options_of_actions action (Test_parsing_c.actions())) @
[
(let s = "--parse-cocci" in s, Arg.Unit (fun () -> action := s),
" <file>");
(let s = "--rule-dependencies" in s, Arg.Unit (fun () -> action := s),
" <file>");
(let s = "--compare-c" in s, Arg.Unit (fun () -> action := s),
" <file1> <file2>");
]);
]
let all_options =
short_options @ List.concat (List.map Common.thd3 other_options)
let all_string_option_names =
List.fold_left
(function prev ->
function
(_,Arg.Unit _,_) -> prev
| (nm,_,_) -> nm :: prev)
[] all_options
(* I don't want the -help and --help that are appended by Arg.align *)
let arg_align2 xs =
Arg.align xs +> List.rev +> Common.drop 2 +> List.rev
(*
Ignore unknown option
This simplifies the integration of Coccinelle in toolchain. For
instance, spatch can then be used as a checker in the Linux build
system.
*)
let check_include_path () =
let opt = Array.get Sys.argv !Arg.current in
let is_include_re = Str.regexp "-I\\(.*\\)" in
if Str.string_match is_include_re opt 0
then
let path = Str.matched_group 1 opt in
Inc.include_path:= path::!Inc.include_path
let rec arg_parse_no_fail ~current l f msg argv =
try
check_include_path ();
Arg.parse_argv ~current argv l f msg;
with
| Arg.Bad emsg ->
arg_parse_no_fail ~current l f msg argv
| Arg.Help msg -> (* printf "%s" msg; exit 0; *)
raise (Impossible 165) (* -help is specified in speclist *)
(* copy paste of Arg.parse. Don't want the default -help msg *)
let arg_parse2 ~current l f msg argv argv_location =
(try
Arg.parse_argv ~current argv l f msg;
with
| Arg.Bad emsg -> (* eprintf "%s" msg; exit 2; *)
if not !ignore_unknown_opt then
begin
let xs = Common.lines emsg in
(* take only head, it's where the error msg is *)
(* was pr2, but that doesn't always get generated *)
Printf.eprintf "%s (found %s)\n%!" (List.hd xs) argv_location;
!short_usage_func();
raise (Common.UnixExit (2))
end
else
arg_parse_no_fail ~current l f msg argv;
| Arg.Help msg -> (* printf "%s" msg; exit 0; *)
raise (Impossible 166) (* -help is specified in speclist *)
)
let short_usage () =
begin
Common.short_usage usage_msg ~short_opt:short_options;
pr "";
pr "Example of use:";
pr " ./spatch --sp-file foo.cocci foo.c -o /tmp/newfoo.c";
pr "";
end
let long_usage () =
Common.long_usage usage_msg ~short_opt:short_options ~long_opt:other_options
let _ = short_usage_func := short_usage
let _ = long_usage_func := long_usage
(*****************************************************************************)
(* Helpers *)
(*****************************************************************************)
(* for fresh identifier information *)
let adjust_stdin cfiles k =
match cfiles with
[] -> failwith "no files: not possible"
| cfile::_ ->
let newin =
try
let (dir, base, ext) = Common.dbe_of_filename (fst cfile) in
let varfile = Common.filename_of_dbe (dir, base, "var") in
if ext = "c" && Common.lfile_exists varfile
then Some varfile
else None
with Invalid_argument _ -> None in
Common.redirect_stdin_opt newin k
let glimpse_filter2 (_,query,_,_) dir =
match query with
None -> pr2 "no inferred glimpse keywords"; None
| Some queries ->
let suffixes = if !Flag.include_headers then ["c";"h"] else ["c"] in
let rec loop = function
[] -> None (* error, eg due to pattern too big *)
| query::queries ->
Printf.eprintf "%s\n" ("glimpse request = " ^ query);
let command = spf "glimpse -y -H %s -N -W -w '%s'" dir query in
let (glimpse_res,stat) = Common.cmd_to_list_and_status command in
match stat with
Unix.WEXITED(0) | Unix.WEXITED(1) ->
Some
(let filelist = glimpse_res +>
List.filter
(fun file ->
List.mem (Common.filesuffix file) suffixes) in
if filelist <> [] then
begin
let firstfile = List.hd filelist in
if Filename.is_relative firstfile ||
Filename.is_implicit firstfile
then
List.map (fun file -> dir ^ Filename.dir_sep ^ file)
filelist
else filelist
end
else []
)
| _ -> loop queries (* error, eg due to pattern too big *) in
loop queries
let glimpse_filter a b =
Common.profile_code "glimpse_filter" (fun () -> glimpse_filter2 a b)
let coccigrep_filter (_,_,query,_) dir =
match query with
None -> pr2 "no inferred keywords"; None
| Some (q1,q2,_) ->
let res =
Test_parsing_c.get_files dir +>
List.filter (Cocci_grep.interpret (q1,q2)) in
Printf.eprintf "%d files match\n" (List.length res);
Some res
let gitgrep_filter ((_,_,query,_) as x) dir =
match query with
None -> pr2 "no inferred keywords"; None
| Some (_,_,query) ->
let suffixes = if !Flag.include_headers then "'*.[ch]'" else "'*.c'" in
match Git_grep.interpret dir query suffixes with
Some res ->
Printf.eprintf "%d files match\n" (List.length res);
Some res
| None -> coccigrep_filter x dir
let idutils_filter (_,_,_,query) dir =
match Id_utils.interpret dir query with
None -> None
| Some files ->
let suffixes = if !Flag.include_headers then ["c";"h"] else ["c"] in
Printf.eprintf "%d files match\n" (List.length files);
Some
(files +>
List.filter
(fun file -> List.mem (Common.filesuffix file) suffixes))
let diff_filter _ dir =
let struc = Patch_diff.getdiff dir in
Some (List.map (function x -> x.Patch_diff.file_name) struc)