main.ml

   1 (*
   2  * Copyright 2010, INRIA, University of Copenhagen
   3  * Julia Lawall, Rene Rydhof Hansen, Gilles Muller, Nicolas Palix
   4  * Copyright 2005-2009, Ecole des Mines de Nantes, University of Copenhagen
   5  * Yoann Padioleau, Julia Lawall, Rene Rydhof Hansen, Henrik Stuart, Gilles Muller, Nicolas Palix
   6  * This file is part of Coccinelle.
   7  *
   8  * Coccinelle is free software: you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation, according to version 2 of the License.
  11  *
  12  * Coccinelle is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Coccinelle.  If not, see <http://www.gnu.org/licenses/>.
  19  *
  20  * The authors reserve the right to distribute this or future versions of
  21  * Coccinelle under other licenses.
  22  *)
  23
  24
  25 open Common
  26 module FC = Flag_cocci
  27
  28 (*****************************************************************************)
  29 (* Flags *)
  30 (*****************************************************************************)
  31
  32 (* In addition to flags that can be tweaked via -xxx options (cf the
  33  * full list of options in "the spatch options" section below), the
  34  * spatch program also depends on external files, described in
  35  * globals/config.ml, mainly a standard.h and standard.iso file *)
  36
  37 let cocci_file = ref ""
  38
  39 let output_file = ref ""
  40 let inplace_modif = ref false  (* but keeps nothing *)
  41 let backup_suffix =
  42   ref (None : string option) (* suffix for backup if one is desired *)
  43 let outplace_modif = ref false (* generates a .cocci_res  *)
  44 let preprocess = ref false     (* run the C preprocessor before cocci *)
  45 let compat_mode = ref false
  46 let ignore_unknown_opt = ref false
  47
  48 (* somehow obsolete now *)
  49 let dir = ref false
  50
  51 let include_headers = ref false
  52 let kbuild_info = ref ""
  53
  54 let macro_file = ref ""
  55
  56 (* test mode *)
  57 let test_mode = ref false
  58 let test_all = ref false
  59 let test_okfailed = ref false
  60 let test_regression_okfailed = ref false
  61 let expected_score_file = ref ""
  62
  63
  64 (* action mode *)
  65 let action = ref ""
  66
  67 (* works with -test but also in "normal" spatch mode *)
  68 let compare_with_expected = ref false
  69
  70 let distrib_index = ref (None : int option)
  71 let distrib_max   = ref (None : int option)
  72 let mod_distrib   = ref false
  73
  74
  75 (*****************************************************************************)
  76 (* Profiles *)
  77 (*****************************************************************************)
  78
  79 (* pair of  (list of flags to set true, list of flags to set false *)
  80 let very_quiet_profile = (
  81   [
  82   ],
  83   [
  84     (* FC.show_diff;   just leave this as it is *)
  85
  86     Common.print_to_stderr;
  87     Flag.show_misc;
  88     Flag.show_trying;
  89     Flag.show_transinfo;
  90
  91     FC.show_c;
  92     FC.show_cocci;
  93     FC.show_flow;
  94     FC.show_before_fixed_flow;
  95     FC.show_ctl_tex;
  96     FC.show_ctl_text;
  97     FC.show_binding_in_out;
  98
  99     FC.verbose_cocci;
 100
 101     Flag_parsing_c.show_parsing_error;
 102
 103     Flag_parsing_c.verbose_lexing;
 104     Flag_parsing_c.verbose_parsing;
 105     Flag_parsing_c.verbose_type;
 106     Flag_parsing_c.verbose_cfg;
 107     Flag_parsing_c.verbose_unparsing;
 108     Flag_parsing_c.verbose_visit;
 109     Flag_parsing_c.verbose_cpp_ast;
 110
 111     Flag_matcher.verbose_matcher;
 112     Flag_matcher.debug_engine;
 113
 114     Flag_parsing_c.debug_unparsing;
 115
 116     Flag_parsing_cocci.show_SP;
 117     Flag_parsing_cocci.show_iso_failures;
 118
 119     Flag_ctl.verbose_ctl_engine;
 120     Flag_ctl.verbose_match;
 121
 122
 123   ])
 124
 125 let quiet_profile = (
 126   [
 127     Common.print_to_stderr
 128   ],
 129   [
 130     (* FC.show_diff;   just leave this as it is *)
 131
 132     Flag.show_misc;
 133     Flag.show_trying;
 134     Flag.show_transinfo;
 135
 136     FC.show_c;
 137     FC.show_cocci;
 138     FC.show_flow;
 139     FC.show_before_fixed_flow;
 140     FC.show_ctl_tex;
 141     FC.show_ctl_text;
 142     FC.show_binding_in_out;
 143
 144     FC.verbose_cocci;
 145
 146     Flag_parsing_c.show_parsing_error;
 147
 148     Flag_parsing_c.verbose_lexing;
 149     Flag_parsing_c.verbose_parsing;
 150     Flag_parsing_c.verbose_type;
 151     Flag_parsing_c.verbose_cfg;
 152     Flag_parsing_c.verbose_unparsing;
 153     Flag_parsing_c.verbose_visit;
 154     Flag_parsing_c.verbose_cpp_ast;
 155
 156     Flag_matcher.verbose_matcher;
 157     Flag_matcher.debug_engine;
 158
 159     Flag_parsing_c.debug_unparsing;
 160
 161     Flag_parsing_cocci.show_SP;
 162     Flag_parsing_cocci.show_iso_failures;
 163
 164     Flag_ctl.verbose_ctl_engine;
 165     Flag_ctl.verbose_match;
 166
 167
 168   ])
 169
 170 (* some information that is useful in seeing why a semantic patch doesn't
 171 work properly *)
 172 let debug_profile = (
 173   [
 174     Common.print_to_stderr;
 175     Flag.show_misc;
 176     Flag.show_transinfo;
 177
 178     FC.show_diff;
 179     FC.show_cocci;
 180     FC.show_binding_in_out;
 181     FC.show_dependencies;
 182
 183     Flag_parsing_cocci.show_iso_failures;
 184
 185     FC.verbose_cocci;
 186
 187     Flag_parsing_c.verbose_cfg;
 188     Flag_parsing_c.verbose_unparsing;
 189     Flag_parsing_c.verbose_visit;
 190
 191     Flag_matcher.verbose_matcher;
 192
 193     Flag_parsing_c.show_parsing_error;
 194   ],
 195   [
 196
 197     Flag.show_misc;
 198
 199     FC.show_c;
 200     FC.show_flow;
 201     FC.show_before_fixed_flow;
 202     FC.show_ctl_tex;
 203     FC.show_ctl_text;
 204
 205     Flag_parsing_cocci.show_SP;
 206     Flag_ctl.verbose_ctl_engine;
 207     Flag_ctl.verbose_match;
 208     Flag_matcher.debug_engine;
 209     Flag_parsing_c.debug_unparsing;
 210     Flag_parsing_c.verbose_type;
 211     Flag_parsing_c.verbose_parsing;
 212   ])
 213
 214 let pad_profile = (
 215   [
 216     FC.show_diff;
 217     Common.print_to_stderr;
 218   ],
 219   [
 220
 221     Flag.show_misc;
 222     Flag.show_transinfo;
 223
 224     FC.show_c;
 225     FC.show_cocci;
 226     FC.show_flow;
 227     FC.show_before_fixed_flow;
 228     FC.show_ctl_tex;
 229     FC.show_ctl_text;
 230     FC.show_binding_in_out;
 231
 232     Flag_parsing_cocci.show_SP;
 233     Flag_parsing_cocci.show_iso_failures;
 234     Flag_ctl.verbose_ctl_engine;
 235     Flag_ctl.verbose_match;
 236     Flag_matcher.debug_engine;
 237     Flag_parsing_c.debug_unparsing;
 238     Flag_parsing_c.verbose_type;
 239     Flag_parsing_c.verbose_parsing;
 240   ])
 241
 242 let run_profile p =
 243   let (set_to_true, set_to_false) = p in
 244   List.iter (fun x -> x := false) set_to_false;
 245   List.iter (fun x -> x := true) set_to_true
 246
 247 (*****************************************************************************)
 248 (* The spatch options *)
 249 (*****************************************************************************)
 250
 251 let usage_msg =
 252   "Usage: " ^ basename Sys.argv.(0) ^
 253     " -sp_file <SP> <infile> [-o <outfile>] [-iso_file <iso>] [options]" ^
 254     "\n" ^ "Options are:"
 255
 256 (* forward reference trick *)
 257 let short_usage_func = ref (fun () -> ())
 258 let long_usage_func  = ref (fun () -> ())
 259
 260
 261 (* The short_options are user-oriented. The other options are for
 262  * the developers of coccinelle or advanced-users that know
 263  * quite well the underlying semantics of coccinelle.
 264  *)
 265
 266
 267 (* will be printed when use only ./spatch. For the rest you have to
 268  * use -longhelp to see them.
 269  *)
 270 let short_options = [
 271   "-sp_file",  Arg.Set_string cocci_file,
 272   " <file> the semantic patch file";
 273
 274   "-o", Arg.Set_string output_file,
 275   "   <file> the output file";
 276   "-in_place", Arg.Set inplace_modif,
 277   "   do the modification on the file directly";
 278   "-backup_suffix", Arg.String (function s -> backup_suffix := Some s),
 279   "   suffix to use when making a backup for inplace";
 280   "-out_place", Arg.Set outplace_modif,
 281   "   store modifications in a .cocci_res file";
 282
 283   "-U", Arg.Int (fun n -> Flag_parsing_c.diff_lines := Some (i_to_s n)),
 284   "  set number of diff context lines";
 285   "-partial_match",        Arg.Set Flag_ctl.partial_match,
 286   "    report partial matches of the SP on the C file";
 287
 288   "-iso_file", Arg.Set_string Config.std_iso,
 289   " <file> (default=" ^ !Config.std_iso ^")";
 290   "-macro_file", Arg.Set_string macro_file,
 291   " <file>";
 292   "-macro_file_builtins", Arg.Set_string Config.std_h,
 293   " <file> (default=" ^ !Config.std_h ^ ")";
 294
 295   "-recursive_includes",
 296   Arg.Unit (function _ -> FC.include_options := FC.I_REALLY_ALL_INCLUDES),
 297   "  causes all available include files, both those included in the C file(s) and those included in header files, to be used";
 298   "-all_includes",
 299   Arg.Unit (function _ -> FC.include_options := FC.I_ALL_INCLUDES),
 300   "  causes all available include files included in the C file(s) to be used";
 301   "-no_includes",
 302   Arg.Unit (function _ -> FC.include_options := FC.I_NO_INCLUDES),
 303   "  causes not even local include files to be used";
 304   "-local_includes",
 305   Arg.Unit (function _ -> FC.include_options := FC.I_NORMAL_INCLUDES),
 306   "  causes local include files to be used";
 307   "-ignore_unknown_options", Arg.Set ignore_unknown_opt,
 308   "    For integration in a toolchain (must be set before the first unknown option)";
 309   "-include_headers", Arg.Set include_headers,
 310   "    process header files independently";
 311   "-I",   Arg.String (fun x ->
 312                         FC.include_path:= x::!FC.include_path
 313                      ),
 314   "  <dir> containing the header files (optional)";
 315
 316   "-preprocess", Arg.Set preprocess,
 317   " run the C preprocessor before applying the semantic match";
 318
 319   "-c", Arg.Set compat_mode, " gcc/cpp compatibility mode";
 320
 321   "-dir", Arg.Set dir,
 322   "    <dir> process all files in directory recursively";
 323
 324   "-use_glimpse", Arg.Unit (function _ -> Flag.scanner := Flag.Glimpse),
 325   "    works with -dir, use info generated by glimpseindex";
 326   "-use_google", Arg.String (function s -> Flag.scanner := Flag.Google s),
 327   "    find relevant files using google code search";
 328   "-use_idutils", Arg.Unit (function s -> Flag.scanner := Flag.IdUtils),
 329   "    find relevant files using id-utils";
 330   "-patch",
 331     Arg.String (function s -> Flag.patch := Some (Cocci.normalize_path s)),
 332   ("    <dir> path name with respect to which a patch should be created\n"^
 333    "    \"\" for a file in the current directory");
 334   "-kbuild_info", Arg.Set_string kbuild_info,
 335   "    <file> improve -dir by grouping related c files";
 336   "-pyoutput", Arg.Set_string Flag.pyoutput,
 337   "    Sets output routine: Standard values: <coccilib.output.Gtk|coccilib.output.Console>";
 338
 339
 340   "-version",   Arg.Unit (fun () ->
 341     let withpython = if Pycocci.python_support then "with" else "without" in
 342     pr2 (spf "spatch version %s %s Python support" Config.version withpython);
 343     exit 0;
 344   ),
 345     "  guess what";
 346
 347   "-date",   Arg.Unit (fun () ->
 348     pr2 "version: $Date: 2010/11/13 21:06:27 $";
 349     raise (Common.UnixExit 0)
 350     ),
 351   "   guess what";
 352
 353   "-shorthelp", Arg.Unit (fun () ->
 354     !short_usage_func();
 355     raise (Common.UnixExit 0)
 356   ),
 357   "    see short list of options";
 358   "-longhelp", Arg.Unit (fun () ->
 359     !long_usage_func();
 360     raise (Common.UnixExit 0)
 361     ),
 362   "    see all the available options in different categories";
 363   "-help", Arg.Unit (fun () ->
 364     !long_usage_func();
 365     raise (Common.UnixExit 0)
 366   ),
 367   " ";
 368   "--help", Arg.Unit (fun () ->
 369     !long_usage_func();
 370     raise (Common.UnixExit 0)
 371   ),
 372   " ";
 373 ]
 374
 375 (* the format is a list of triples:
 376  *  (title of section * (optional) explanation of sections * option list)
 377  *)
 378 let other_options = [
 379   "aliases and obsolete options",
 380   "",
 381   [
 382     "-sp", Arg.Set_string cocci_file,     " short option of -sp_file";
 383     "-iso", Arg.Set_string Config.std_iso,   " short option of -iso_file";
 384
 385     "-cocci_file", Arg.Set_string cocci_file,
 386     "   <file> the semantic patch file";
 387 (*     "-c", Arg.Set_string cocci_file,     " short option of -sp_file"; *)
 388   ];
 389
 390   "most useful show options",
 391   "",
 392   [
 393     "-show_diff"           , Arg.Set FC.show_diff, " ";
 394     "-no_show_diff"           , Arg.Clear FC.show_diff, " ";
 395     "-show_flow"              , Arg.Set FC.show_flow,        " ";
 396     (* works in conjunction with -show_ctl_text *)
 397     "-ctl_inline_let",
 398     Arg.Unit
 399     (function _ -> FC.show_ctl_text := true; FC.inline_let_ctl := true), " ";
 400     "-ctl_show_mcodekind",
 401     Arg.Unit
 402     (function _ -> FC.show_ctl_text := true; FC.show_mcodekind_in_ctl := true),
 403     " ";
 404     "-show_bindings",        Arg.Set FC.show_binding_in_out, " ";
 405     "-show_transinfo",    Arg.Set Flag.show_transinfo, " ";
 406     "-show_misc",         Arg.Set Flag.show_misc, " ";
 407     "-show_trying",          Arg.Set Flag.show_trying,
 408     " show the name of each function being processed";
 409     "-show_dependencies",
 410     Arg.Unit (function _ -> FC.show_dependencies := true;
 411       FC.show_binding_in_out := true),
 412     " show the dependencies related to each rule";
 413   ];
 414
 415   "verbose subsystems options",
 416   "",
 417   [
 418     "-verbose_ctl_engine",
 419     Arg.Unit (function _ ->
 420       Flag_ctl.verbose_ctl_engine := true; FC.show_ctl_text := true) , " ";
 421     "-verbose_match",        Arg.Set Flag_ctl.verbose_match, " ";
 422     "-verbose_engine",       Arg.Set Flag_matcher.debug_engine,    " ";
 423     "-graphical_trace",      Arg.Set Flag_ctl.graphical_trace, "  generate a pdf file representing the matching process";
 424     "-gt_without_label",
 425      Arg.Unit (function _ ->
 426        Flag_ctl.graphical_trace := true; Flag_ctl.gt_without_label := true),
 427        "  remove graph label (requires option -graphical_trace)";
 428
 429     "-parse_error_msg", Arg.Set Flag_parsing_c.show_parsing_error, " ";
 430     "-verbose_parsing",
 431        Arg.Unit (fun _ -> Flag_parsing_c.verbose_parsing := true;
 432          Flag_parsing_c.show_parsing_error := true), " ";
 433     "-type_error_msg",  Arg.Set Flag_parsing_c.verbose_type, " ";
 434     (* could also use Flag_parsing_c.options_verbose *)
 435   ];
 436
 437   "other show options",
 438   "",
 439   [
 440     "-show_c"                 , Arg.Set FC.show_c,           " ";
 441     "-show_cocci"             , Arg.Set FC.show_cocci,       " ";
 442     "-show_before_fixed_flow" , Arg.Set FC.show_before_fixed_flow,  " ";
 443     "-show_ctl_tex"           , Arg.Set FC.show_ctl_tex,     " ";
 444     "-show_ctl_text"          , Arg.Set FC.show_ctl_text,     " ";
 445     "-show_SP"             ,    Arg.Set Flag_parsing_cocci.show_SP,  " ";
 446   ];
 447
 448
 449   "debug C parsing/unparsing",
 450   "",
 451   [
 452     "-debug_cpp",          Arg.Set  Flag_parsing_c.debug_cpp, " ";
 453     "-debug_lexer",        Arg.Set  Flag_parsing_c.debug_lexer , " ";
 454     "-debug_etdt",         Arg.Set  Flag_parsing_c.debug_etdt , "  ";
 455     "-debug_typedef",      Arg.Set  Flag_parsing_c.debug_typedef, "  ";
 456
 457     "-filter_msg",         Arg.Set  Flag_parsing_c.filter_msg ,
 458     "  filter some cpp message when the macro is a \"known\" cpp construct";
 459     "-filter_define_error",     Arg.Set Flag_parsing_c.filter_define_error,"  ";
 460     "-filter_msg_define_error", Arg.Set Flag_parsing_c.filter_msg_define_error,
 461     "  filter the error msg";
 462     "-filter_passed_level",     Arg.Set_int Flag_parsing_c.filter_passed_level,"  ";
 463 (*  debug cfg doesn't seem to have any effect, so drop it as an option *)
 464 (*  "-debug_cfg",          Arg.Set Flag_parsing_c.debug_cfg , "  "; *)
 465     "-debug_unparsing",         Arg.Set  Flag_parsing_c.debug_unparsing, "  ";
 466
 467   ];
 468   (* could use Flag_parsing_c.options_debug_with_title instead *)
 469
 470
 471   "shortcut for enabling/disabling a set of debugging options at once",
 472   "",
 473   [
 474     (* todo: other profile ? *)
 475     "-quiet",   Arg.Unit (fun () -> run_profile quiet_profile), " ";
 476     "-very_quiet",   Arg.Unit (fun () -> run_profile very_quiet_profile), " ";
 477     "-debug",   Arg.Unit (fun () -> run_profile debug_profile), " ";
 478     "-pad",     Arg.Unit (fun () -> run_profile pad_profile),   " ";
 479
 480   ];
 481
 482   "bench options",
 483   "",
 484   [
 485     "-profile", Arg.Unit (function () -> Common.profile := Common.PALL) ,
 486     "   gather timing information about the main coccinelle functions";
 487     "-bench", Arg.Int (function x -> Flag_ctl.bench := x),
 488     "   <level> for profiling the CTL engine";
 489     "-timeout", Arg.Int (fun x -> FC.timeout := Some x),
 490     "   <sec> timeout in seconds";
 491     "-steps", Arg.Int (fun x -> Flag_ctl.steps := Some x),
 492     "   max number of model checking steps per code unit";
 493     "-iso_limit", Arg.Int (fun x -> Flag_parsing_cocci.iso_limit := Some x),
 494     "   max depth of iso application";
 495     "-no_iso_limit", Arg.Unit (fun _ -> Flag_parsing_cocci.iso_limit := None),
 496     "   disable limit on max depth of iso application";
 497     "-track_iso", Arg.Set Flag.track_iso_usage,
 498     "   gather information about isomorphism usage";
 499     "-disable_iso",
 500     Arg.String
 501     (fun s -> Flag_parsing_cocci.disabled_isos :=
 502       s :: !Flag_parsing_cocci.disabled_isos),
 503     "   disable a specific isomorphism";
 504     "-profile_iso",
 505     Arg.Unit
 506     (function () ->
 507       Common.profile :=
 508         (*post_engine not included, because it doesn't use isos*)
 509         PSOME ["parse cocci";"mysat";"asttoctl2";"pre_engine";"full_engine"]),
 510     "   gather information about the cost of isomorphism usage"
 511   ];
 512
 513
 514
 515   "change of algorithm options",
 516   "",
 517   [
 518     "-popl", Arg.Set FC.popl,
 519     "    simplified SmPL, for the popl paper";
 520
 521     "-popl_mark_all",
 522     Arg.Unit
 523     (function _ -> FC.popl := true; Flag_popl.mark_all := true),
 524     "    simplified SmPL, for the popl paper";
 525
 526     "-popl_keep_all_wits",
 527     Arg.Unit
 528     (function _ -> FC.popl := true; Flag_popl.keep_all_wits := true),
 529     "    simplified SmPL, for the popl paper";
 530
 531     "-hrule", Arg.String
 532     (function s ->
 533       Flag.make_hrule := Some s; FC.include_options := FC.I_NO_INCLUDES),
 534     "    semantic patch generation";
 535
 536     "-keep_comments", Arg.Set Flag_parsing_c.keep_comments,
 537     "   keep comments around removed code";
 538
 539     "-loop",              Arg.Set Flag_ctl.loop_in_src_code,    " ";
 540     "-no_loops",          Arg.Set Flag_parsing_c.no_loops,
 541     "   drop all back edges derived from looping constructs - unsafe";
 542     "-no_gotos",          Arg.Set Flag_parsing_c.no_gotos,
 543     "   drop all jumps derived from gotos - unsafe";
 544
 545     "-l1",                Arg.Clear Flag_parsing_c.label_strategy_2, " ";
 546     "-ifdef_to_if",       Arg.Set FC.ifdef_to_if,
 547     "   convert ifdef to if (experimental)";
 548     "-no_ifdef_to_if",              Arg.Clear FC.ifdef_to_if,
 549     "   convert ifdef to if (experimental)";
 550
 551     "-disable_multi_pass", Arg.Set Flag_parsing_c.disable_multi_pass, " ";
 552
 553     "-noif0_passing",      Arg.Clear Flag_parsing_c.if0_passing,
 554     " ";
 555     "-noadd_typedef_root", Arg.Clear Flag_parsing_c.add_typedef_root, " ";
 556     (* could use Flag_parsing_c.options_algo instead *)
 557
 558
 559     "-disallow_nested_exps", Arg.Set Flag_matcher.disallow_nested_exps,
 560        " disallow an expresion pattern from matching a term and its subterm";
 561     "-disable_worth_trying_opt", Arg.Clear FC.worth_trying_opt,
 562     "  ";
 563     "-only_return_is_error_exit",
 564     Arg.Set Flag_matcher.only_return_is_error_exit,
 565     "if this flag is not set, then break and continue are also error exits";
 566     (* the following is a hack to make it easier to add code in sgrep-like
 567        code, essentially to compensate for the fact that we don't have
 568        any way of printing things out *)
 569     "-allow_inconsistent_paths",
 570     Arg.Set Flag_matcher.allow_inconsistent_paths,
 571     "   if this flag is set don't check for inconsistent paths; dangerous";
 572     "-no_safe_expressions",
 573     Arg.Set Flag_matcher.no_safe_expressions,
 574     "  make an expression disjunction not prioritise the topmost disjunct";
 575     "-int_bits", Arg.Int Flag_parsing_c.set_int_bits,
 576     "  the number of bits in an unsigned int";
 577     "-long_bits", Arg.Int Flag_parsing_c.set_long_bits,
 578     "  the number of bits in an unsigned long";
 579     "-linux_spacing", Arg.Unit Flag_parsing_c.set_linux_spacing,
 580     "  spacing of + code follows the conventions of Linux";
 581     "-smpl_spacing", Arg.Unit Flag_parsing_c.set_smpl_spacing,
 582     "  spacing of + code follows the semantic patch";
 583     "-D", Arg.String Flag.set_defined_virtual_rules,
 584     "  indicate that a virtual rule should be considered to be matched";
 585   ];
 586
 587   "misc options",
 588   "",
 589   [
 590     "-debugger",           Arg.Set Common.debugger,
 591     "   option to set if launch spatch in ocamldebug";
 592     "-disable_once",       Arg.Set Common.disable_pr2_once,
 593     "   to print more messages";
 594     "-show_trace_profile", Arg.Set Common.show_trace_profile,
 595     "   show trace";
 596     "-save_tmp_files",     Arg.Set Common.save_tmp_files,   " ";
 597   ];
 598
 599   "concurrency",
 600   "",
 601   [
 602     "-index",       Arg.Int (function x -> distrib_index := Some x) ,
 603     "   the processor to use for this run of spatch";
 604     "-max",         Arg.Int (function x -> distrib_max := Some x) ,
 605     "   the number of processors available";
 606     "-mod_distrib", Arg.Set mod_distrib,
 607     "   use mod to distribute files among the processors";
 608   ];
 609
 610   "pad options",
 611   "",
 612   [
 613     "-use_cache", Arg.Set Flag_parsing_c.use_cache,
 614     "   use .ast_raw pre-parsed cached C file";
 615     (* could use Flag_parsing_c.options_pad instead *)
 616   ];
 617
 618
 619
 620   "test mode and test options (works with tests/ or .ok files)",
 621   "The test options don't work with the -sp_file and so on.",
 622   [
 623     "-test",    Arg.Set test_mode,
 624     "   <file> launch spatch on tests/file.[c,cocci]";
 625     "-testall", Arg.Set test_all,
 626     "   launch spatch on all files in tests/ having a .res";
 627     "-test_okfailed", Arg.Set test_okfailed,
 628     "    generates .{ok,failed,spatch_ok} files using .res files";
 629     "-test_regression_okfailed", Arg.Set test_regression_okfailed,
 630     "    process the .{ok,failed,spatch_ok} files in current dir";
 631
 632     "-compare_with_expected", Arg.Set compare_with_expected,
 633     "   use also file.res";
 634     "-expected_score_file", Arg.Set_string expected_score_file,
 635     "   which score file to compare with in -testall";
 636     "-relax_include_path", Arg.Set FC.relax_include_path,
 637     " ";
 638   ];
 639
 640   "action mode",
 641   ("The action options don't work with the -sp_file and so on." ^ "\n" ^
 642    "It's for the other (internal) uses of the spatch program."
 643   ),
 644
 645     (* -token_c, -parse_c, etc  *)
 646   ((Common.options_of_actions action (Test_parsing_c.actions())) ++
 647     [
 648     (let s = "-parse_cocci"  in s, Arg.Unit (fun () -> action := s),
 649     "   <file>");
 650     (let s = "-compare_c"  in s, Arg.Unit (fun () -> action := s),
 651     "   <file1> <file2>");
 652     ]);
 653 ]
 654
 655
 656 let all_options =
 657   short_options ++ List.concat (List.map Common.thd3 other_options)
 658
 659 (* I don't want the -help and --help that are appended by Arg.align *)
 660 let arg_align2 xs =
 661   Arg.align xs +> List.rev +> Common.drop 2 +> List.rev
 662
 663 (*
 664   Ignore unknown option
 665
 666   This simplifies the integration of Coccinelle in toolchain.  For
 667   instance, spatch can then be used as a checker in the Linux build
 668   system.
 669
 670 *)
 671 let check_include_path () =
 672   let opt = Array.get Sys.argv !Arg.current in
 673   let is_include_re = Str.regexp "-I\\(.*\\)" in
 674   if Str.string_match is_include_re opt 0 then
 675     let path = Str.matched_group 1 opt in
 676         FC.include_path:= path::!FC.include_path
 677   else ()
 678
 679 let rec arg_parse_no_fail l f msg =
 680   try
 681     check_include_path ();
 682     Arg.parse_argv Sys.argv l f msg;
 683   with
 684     | Arg.Bad emsg ->
 685         arg_parse_no_fail l f msg
 686     | Arg.Help msg -> (* printf "%s" msg; exit 0; *)
 687         raise Impossible  (* -help is specified in speclist *)
 688
 689 (* copy paste of Arg.parse. Don't want the default -help msg *)
 690 let arg_parse2 l f msg =
 691   (try
 692     Arg.parse_argv Sys.argv l f msg;
 693   with
 694   | Arg.Bad emsg -> (* eprintf "%s" msg; exit 2; *)
 695       if not !ignore_unknown_opt then
 696         begin
 697           let xs = Common.lines emsg in
 698             (* take only head, it's where the error msg is *)
 699             pr2 (List.hd xs);
 700             !short_usage_func();
 701             raise (Common.UnixExit (2))
 702         end
 703       else
 704         arg_parse_no_fail l f msg;
 705   | Arg.Help msg -> (* printf "%s" msg; exit 0; *)
 706       raise Impossible  (* -help is specified in speclist *)
 707   )
 708
 709
 710 let short_usage () =
 711  begin
 712   Common.short_usage usage_msg short_options;
 713   pr2 "";
 714   pr2 "Example of use:";
 715   pr2 "  ./spatch -sp_file foo.cocci foo.c -o /tmp/newfoo.c";
 716   pr2 "";
 717  end
 718
 719
 720 let long_usage () =
 721   Common.long_usage usage_msg short_options other_options
 722
 723 let _ = short_usage_func := short_usage
 724 let _ = long_usage_func := long_usage
 725
 726 (*****************************************************************************)
 727 (* Helpers *)
 728 (*****************************************************************************)
 729
 730 let adjust_stdin cfile k =
 731   if !dir
 732   then k()
 733   else
 734     let newin =
 735       try
 736         let (dir, base, ext) = Common.dbe_of_filename cfile in
 737         let varfile = Common.filename_of_dbe (dir, base, "var") in
 738         if ext =$= "c" && Common.lfile_exists varfile
 739         then Some varfile
 740         else None
 741       with Invalid_argument("Filename.chop_extension") -> None
 742     in
 743     Common.redirect_stdin_opt newin k
 744
 745 let glimpse_filter (coccifile, isofile) dir =
 746   let (_metavars,astcocci,_free_var_lists,_negated_positions,
 747        _used_after_lists,_positions_lists,(_,query,_)) =
 748     Cocci.sp_of_file coccifile (Some isofile) in
 749   match query with
 750     None -> pr2 "no inferred glimpse keywords"; None
 751   | Some queries ->
 752       let suffixes = if !include_headers then ["c";"h"] else ["c"] in
 753       let rec loop = function
 754           [] -> None (* error, eg due to pattern too big *)
 755         | query::queries ->
 756             Printf.fprintf stderr "%s\n" ("glimpse request = " ^ query);
 757             let command = spf "glimpse -y -H %s -N -W -w '%s'" dir query in
 758             let (glimpse_res,stat) = Common.cmd_to_list_and_status command in
 759             match stat with
 760               Unix.WEXITED(0) | Unix.WEXITED(1) ->
 761       Printf.fprintf stderr "got files\n"; flush stderr;
 762                 Some
 763                   (glimpse_res +>
 764                    List.filter
 765                      (fun file -> List.mem (Common.filesuffix file) suffixes))
 766             |   _ -> loop queries (* error, eg due to pattern too big *) in
 767       loop queries
 768
 769 let idutils_filter (coccifile, isofile) dir =
 770   let (_metavars,astcocci,_free_var_lists,_negated_positions,
 771        _used_after_lists,_positions_lists,(_,_,query)) =
 772     Cocci.sp_of_file coccifile (Some isofile) in
 773   match query with
 774     None -> pr2 "no inferred idutils keywords"; None
 775   | Some query ->
 776       let suffixes = if !include_headers then ["c";"h"] else ["c"] in
 777       let files = Id_utils.interpret dir query in
 778       Printf.fprintf stderr "got files\n"; flush stderr;
 779       Some
 780         (files +>
 781          List.filter (fun file -> List.mem (Common.filesuffix file) suffixes))
 782
 783 (*****************************************************************************)
 784 (* Main action *)
 785 (*****************************************************************************)
 786
 787 let main_action xs =
 788   match xs with
 789   | x::xs ->
 790
 791       (* a more general solution would be to use
 792        * Common.files_of_dir_or_files (x::xs)
 793        * as some elements in xs may also be directories, or individual
 794        * files.
 795        *)
 796       if Common.is_directory x
 797       then dir := true;
 798
 799       adjust_stdin x (fun () ->
 800         if !cocci_file =$= ""
 801         then failwith "I need a cocci file,  use -sp_file <file>";
 802
 803         if !dir && !Flag.patch =*= None
 804         then
 805           (match xs with
 806           | [] -> Flag.patch := Some (Cocci.normalize_path x)
 807           | _ ->
 808               pr2
 809                 ("warning: patch output can only be created when only one\n"^
 810                     "directory is specified or when the -patch flag is used")
 811           );
 812         Flag.dir := x;
 813
 814         let infiles =
 815           Common.profile_code "Main.infiles computation" (fun () ->
 816             match !dir, !kbuild_info, !Flag.scanner with
 817             (* glimpse *)
 818             | false, _, (Flag.Glimpse|Flag.IdUtils) ->
 819                 failwith "-use_glimpse or -id_utils works only with -dir"
 820             | true, s, (Flag.Glimpse|Flag.IdUtils) when s <> "" ->
 821                 failwith "-use_glimpse or -id_utils does not work with -kbuild"
 822             | true, "", Flag.Glimpse ->
 823                 (if not (null xs)
 824                 then failwith "-use_glimpse can accept only one dir");
 825
 826                 let files =
 827                   match glimpse_filter (!cocci_file, !Config.std_iso) x with
 828                   None ->
 829                     Common.cmd_to_list (* same as "true, "", _" case *)
 830                       (if !include_headers
 831                           (* FIXME : Could we remove xs ?
 832                              -use_glimpse requires a singleton.
 833                              This is checked some lines before.
 834                              then ("find "^(join " " (x::xs))^" -name \"*.[ch]\"")
 835                              else ("find "^(join " " (x::xs))^" -name \"*.c\""))
 836                           *)
 837                       then ("find "^ x ^" -name \"*.[ch]\"")
 838                         else ("find "^ x ^" -name \"*.c\""))
 839                   | Some files -> files in
 840                 files +> List.map (fun x -> [x])
 841             | true, "", Flag.IdUtils ->
 842                 (if not (null xs)
 843                 then failwith "-id_utils can accept only one dir");
 844
 845                 let files =
 846                   match idutils_filter (!cocci_file, !Config.std_iso) x with
 847                   None ->
 848                     Common.cmd_to_list (* same as "true, "", _" case *)
 849                       (if !include_headers
 850                           (* FIXME : Could we remove xs ?
 851                              -use_glimpse requires a singleton.
 852                              This is checked some lines before.
 853                              then ("find "^(join " " (x::xs))^" -name \"*.[ch]\"")
 854                              else ("find "^(join " " (x::xs))^" -name \"*.c\""))
 855                           *)
 856                       then ("find "^ x ^" -name \"*.[ch]\"")
 857                         else ("find "^ x ^" -name \"*.c\""))
 858                   | Some files -> files in
 859                 files +> List.map (fun x -> [x])
 860                   (* normal *)
 861             | false, _, _ -> [x::xs]
 862             | true, "", _ ->
 863                 Common.cmd_to_list
 864                   (if !include_headers
 865                   then ("find "^(join " " (x::xs))^" -name \"*.[ch]\"")
 866                     else ("find "^(join " " (x::xs))^" -name \"*.c\""))
 867                 +> List.map (fun x -> [x])
 868
 869             (* kbuild *)
 870             | true, kbuild_info_file,_ ->
 871                 let dirs =
 872                   Common.cmd_to_list ("find "^(join " " (x::xs))^" -type d")
 873                 in
 874                 let info = Kbuild.parse_kbuild_info kbuild_info_file in
 875                 let groups = Kbuild.files_in_dirs dirs info in
 876
 877                 groups +> List.map (function Kbuild.Group xs -> xs)
 878           )
 879         in
 880
 881         let infiles =
 882           match (!distrib_index,!distrib_max) with
 883           (None,None) -> infiles
 884           | (Some index,Some max) ->
 885               (if index >= max
 886               then
 887                 failwith "index starts at 0, and so must be less than max");
 888               if !mod_distrib
 889               then
 890                 let rec loop ct = function
 891                   [] -> []
 892                   | x::xs ->
 893                       if (ct mod max) =|= index
 894                       then x::(loop (ct+1) xs)
 895                       else loop (ct+1) xs in
 896                 loop 0 infiles
 897               else
 898                 begin
 899                   let all_files = List.length infiles in
 900                   let regions = (all_files + (max - 1)) / max in
 901                   let this_min = index * regions in
 902                   let this_max = (index+1) * regions in
 903                   let rec loop ct = function
 904                     [] -> []
 905                     | x::xs ->
 906                         if this_min <= ct && ct < this_max
 907                         then x::(loop (ct+1) xs)
 908                         else loop (ct+1) xs in
 909                   loop 0 infiles
 910                 end
 911           | _ -> failwith "inconsistent distribution information" in
 912
 913         let outfiles =
 914           Common.profile_code "Main.outfiles computation" (fun () ->
 915             let cocci_infos =
 916               Cocci.pre_engine (!cocci_file, !Config.std_iso) in
 917             let res =
 918               infiles +> List.map (fun cfiles ->
 919                 pr2 ("HANDLING: " ^ (join " " cfiles));
 920                 Common.timeout_function_opt !FC.timeout (fun () ->
 921                   Common.report_if_take_time 10 (join " " cfiles) (fun () ->
 922                     (*let s = profile_diagnostic() in*)
 923                     (* Unix.sleep 1; *)
 924                     try
 925                       let optfile =
 926                         if !output_file <> "" && !compat_mode then
 927                           Some !output_file
 928                         else
 929                           None
 930                       in
 931                         Common.redirect_stdout_opt optfile (fun () ->
 932                           (* this is the main call *)
 933                           Cocci.full_engine cocci_infos cfiles
 934                                                            )
 935                     with
 936                       | Common.UnixExit x -> raise (Common.UnixExit x)
 937                       | Pycocci.Pycocciexception ->
 938                           raise Pycocci.Pycocciexception
 939                       | e ->
 940                           (*pr2 "previous";
 941                           pr2 s;
 942                           pr2 "new";
 943                           pr2(profile_diagnostic());*)
 944                           if !dir
 945                           then begin
 946                             pr2 ("EXN:" ^ Printexc.to_string e);
 947                             [] (* *)
 948                           end
 949                           else raise e))) in
 950               Cocci.post_engine cocci_infos;
 951               res
 952           ) +> List.concat
 953         in
 954
 955         Common.profile_code "Main.result analysis" (fun () ->
 956           Ctlcocci_integration.print_bench();
 957           let outfiles = Cocci.check_duplicate_modif outfiles in
 958           outfiles +> List.iter (fun (infile, outopt) ->
 959             outopt +> Common.do_option (fun outfile ->
 960               if !inplace_modif
 961               then begin
 962                 (match !backup_suffix with
 963                   Some backup_suffix ->
 964                     Common.command2 ("cp "^infile^" "^infile^backup_suffix)
 965                 | None -> ());
 966                 Common.command2 ("cp "^outfile^" "^infile);
 967               end;
 968
 969               if !outplace_modif
 970               then Common.command2 ("cp "^outfile^" "^infile^".cocci_res");
 971
 972               (* potential source of security pb if the /tmp/ file is
 973                * a symlink, so simpler to not produce any regular file
 974                * (files created by Common.new_temp_file are still ok)
 975                * anymore in /tmp.
 976                *)
 977               (*
 978                 if !output_file =$= ""
 979                 then begin
 980                   let tmpfile = "/tmp/"^Common.basename infile in
 981                   pr2 (spf "One file modified. Result is here: %s" tmpfile);
 982                   Common.command2 ("cp "^outfile^" "^tmpfile);
 983                  end
 984               *)
 985             ));
 986           if !output_file <> "" && not !compat_mode then
 987             (match outfiles with
 988             | [infile, Some outfile] when infile =$= x && null xs ->
 989                 Common.command2 ("cp " ^outfile^ " " ^ !output_file);
 990             | [infile, None] when infile =$= x && null xs ->
 991                 Common.command2 ("cp " ^infile^ " " ^ !output_file);
 992             | _ ->
 993                 failwith
 994                   ("-o can not be applied because there is multiple " ^
 995                       "modified files");
 996             );
 997           if !compare_with_expected
 998           then Testing.compare_with_expected outfiles))
 999
1000   | [] -> raise Impossible
1001
1002
1003 (*****************************************************************************)
1004 (* The coccinelle main entry point *)
1005 (*****************************************************************************)
1006 let main () =
1007   begin
1008     let arglist = Array.to_list Sys.argv in
1009
1010     if not (null (Common.inter_set arglist
1011                      ["-cocci_file";"-sp_file";"-sp";"-test";"-testall";
1012                       "-test_okfailed";"-test_regression_okfailed"]))
1013     then run_profile quiet_profile;
1014
1015     let args = ref [] in
1016
1017     (* Gc.set {(Gc.get ()) with Gc.stack_limit = 1024 * 1024};*)
1018
1019     (* this call can set up many global flag variables via the cmd line *)
1020     arg_parse2 (Arg.align all_options) (fun x -> args := x::!args) usage_msg;
1021
1022     (* julia hack so that one can override directories specified on
1023      * the command line. *)
1024     (if !dir
1025     then
1026       let chosen_dir =
1027          if List.length !args > 1
1028          then
1029            begin
1030              let chosen = List.hd !args in
1031                Flag.dir := chosen;
1032                pr2 ("ignoring all but the last specified directory: "^chosen);
1033                args := [chosen];
1034                chosen
1035            end
1036          else List.hd !args in
1037       if !FC.include_path =*= []
1038       then FC.include_path := [Filename.concat chosen_dir "include"]);
1039
1040     args := List.rev !args;
1041
1042     if !cocci_file <> "" && (not (!cocci_file =~ ".*\\.\\(sgrep\\|spatch\\)$"))
1043     then cocci_file := Common.adjust_ext_if_needed !cocci_file ".cocci";
1044
1045     if !Config.std_iso <> ""
1046     then Config.std_iso := Common.adjust_ext_if_needed !Config.std_iso ".iso";
1047     if !Config.std_h <> ""
1048     then Config.std_h := Common.adjust_ext_if_needed !Config.std_h ".h";
1049
1050     if !Config.std_h <> ""
1051     then Parse_c.init_defs_builtins !Config.std_h;
1052
1053     if !macro_file <> ""
1054     then Parse_c.init_defs_macros !macro_file;
1055
1056
1057     (* must be done after Arg.parse, because Common.profile is set by it *)
1058     Common.profile_code "Main total" (fun () ->
1059
1060
1061     let all_actions = Test_parsing_c.actions() in
1062
1063     (match (!args) with
1064
1065     (* --------------------------------------------------------- *)
1066     (* The test framework. Works with tests/ or .ok and .failed  *)
1067     (* --------------------------------------------------------- *)
1068     | [x] when !test_mode    ->
1069         begin
1070           let prefix = "tests/" in
1071           let testfile = x ^ ".cocci" in
1072             if Sys.file_exists (prefix ^ testfile) then
1073               begin
1074                 FC.include_path := [prefix^"include"];
1075                 Testing.testone prefix x !compare_with_expected
1076               end
1077             else
1078               if Sys.file_exists testfile then
1079                 begin
1080                   FC.include_path := ["include"];
1081                   Testing.testone "" x !compare_with_expected
1082                 end
1083               else
1084                 pr2 (spf "ERROR: File %s does not exist" testfile)
1085         end
1086
1087     | []  when !test_all ->
1088         FC.include_path := ["tests/include"];
1089         if !expected_score_file <> ""
1090         then Testing.testall ~expected_score_file:!expected_score_file ()
1091         else Testing.testall ()
1092
1093     | [] when !test_regression_okfailed ->
1094         Testing.test_regression_okfailed ()
1095
1096     | x::xs when !test_okfailed ->
1097         (* do its own timeout on FC.timeout internally *)
1098         FC.relax_include_path := true;
1099         adjust_stdin x (fun () ->
1100           Testing.test_okfailed !cocci_file (x::xs)
1101         )
1102
1103     (* --------------------------------------------------------- *)
1104     (* Actions, useful to debug subpart of coccinelle *)
1105     (* --------------------------------------------------------- *)
1106
1107     | xs when List.mem !action (Common.action_list all_actions) ->
1108         Common.do_action !action xs all_actions
1109
1110     | [file] when !action =$= "-parse_cocci" ->
1111         Testing.test_parse_cocci file
1112
1113      (* I think this is used by some scripts in some Makefile for our
1114       * big-tests. So dont remove.
1115       *)
1116     | [file1;file2] when !action =$= "-compare_c" ->
1117        Test_parsing_c.test_compare_c file1 file2 (* result = unix code *)
1118
1119     (* could add the Test_parsing_c.test_actions such as -parse_c & co *)
1120
1121
1122     (* --------------------------------------------------------- *)
1123     (* This is the main entry *)
1124     (* --------------------------------------------------------- *)
1125     | x::xs -> main_action (x::xs)
1126
1127     (* --------------------------------------------------------- *)
1128     (* empty entry *)
1129     (* --------------------------------------------------------- *)
1130     | [] -> short_usage()
1131   ));
1132     if !Pycocci.initialised && (Pycocci.py_isinitialized ()) != 0 then begin
1133       ignore(Pycocci.pyrun_simplestring "cocci.finalise()");
1134       if !Flag.show_misc
1135       then Common.pr2 "Finalizing python\n";
1136       Pycocci.py_finalize ();
1137     end
1138   end
1139
1140
1141 let main_with_better_error_report () =
1142   if !Common.debugger then main ()
1143   else
1144     try
1145       main ()
1146     with
1147     | Unix.Unix_error (e, "stat", filename) ->
1148         pr2
1149           (spf "ERROR: File %s does not exist: %s"
1150              filename (Unix.error_message e));
1151         raise (UnixExit (-1))
1152     | Parse_cocci.Bad_virt s ->
1153         Common.pr2 (Printf.sprintf "virtual rule %s not supported" s);
1154         raise (UnixExit (-1))
1155
1156 (*****************************************************************************)
1157 let start =
1158   Common.main_boilerplate (fun () ->
1159     main_with_better_error_report ();
1160     Ctlcocci_integration.print_bench();
1161   )