Adding inferconfig support to skip the translation of generated source code

Summary: public
This allow to tell Infer to skip the translation of some files. This is especially useful to skip the translation of some generated files following the syntax:

  > cat .inferconfig
  {
    "skip_translation": [
      {
        "language": "Java",
        "source_contains": "_SHOULD_BE_SKIPPED_"
      }
    ]
  }

Reviewed By: cristianoc

Differential Revision: D2588095

fb-gh-sync-id: 3fda816

examples/android_hello/.inferconfig

@@ -0,0 +1 @@
+/Users/jrm/infer/.inferconfig

examples/android_hello/app/src/main/java/infer/inferandroidexample/Generated.java

@@ -0,0 +1,20 @@
+/*
+* Copyright (c) 2015 - present Facebook, Inc.
+* All rights reserved.
+*
+* This source code is licensed under the BSD style license found in the
+* LICENSE file in the root directory of this source tree. An additional grant
+* of patent rights can be found in the PATENTS file in the same directory.
+*/
+
+// _SHOULD_BE_SKIPPED_
+
+package infer.inferandroidexample;
+
+public class Generated {
+
+  static Object returnsNull() {
+    return null;
+  }
+
+}

examples/android_hello/app/src/main/java/infer/inferandroidexample/MainActivity.java

@@ -1,3 +1,12 @@
+/*
+* Copyright (c) 2015 - present Facebook, Inc.
+* All rights reserved.
+*
+* This source code is licensed under the BSD style license found in the
+* LICENSE file in the root directory of this source tree. An additional grant
+* of patent rights can be found in the PATENTS file in the same directory.
+*/
+
 package infer.inferandroidexample;
 
 import android.support.v7.app.ActionBarActivity;
@@ -60,4 +69,10 @@ public class MainActivity extends ActionBarActivity {
 
         return super.onOptionsItemSelected(item);
     }
+
+  private void inferShouldNotReport() {
+    Object o = Generated.returnsNull();
+    o.toString();
+  }
+
 }

examples/android_hello/gradle_report.json

@@ -1,13 +1,13 @@
 [
   {
     "file": "app/src/main/java/infer/inferandroidexample/MainActivity.java",
-    "line": "20",
+    "line": "29",
     "type": "NULL_DEREFERENCE",
     "procedure": "void MainActivity.onCreate(Bundle)"
   },
   {
     "file": "app/src/main/java/infer/inferandroidexample/MainActivity.java",
-    "line": "37",
+    "line": "46",
     "type": "RESOURCE_LEAK",
     "procedure": "void MainActivity.writeToFile()"
   }

infer/src/backend/inferconfig.ml

@@ -271,6 +271,7 @@ struct
 
 end (* of module FileOrProcMatcher *)
 
+
 module NeverReturnNull = FileOrProcMatcher(struct
     let json_key = "never_returning_null"
   end)
@@ -279,6 +280,11 @@ module ProcMatcher = FileOrProcMatcher(struct
     let json_key = "suppress_procedures"
   end)
 
+module SkipTranslationMatcher = FileOrProcMatcher(struct
+    let json_key = "skip_translation"
+  end)
+
+
 let inferconfig () = match !inferconfig_home with
   | Some dir -> Filename.concat dir inferconfig_file
   | None -> inferconfig_file
@@ -311,6 +317,7 @@ let make_proc_filter_from_local_config () =
     | None -> ProcMatcher.default_matcher in
   fun pname -> not (filter DB.source_file_empty pname)
 
+
 let filters_from_inferconfig inferconfig : filters =
   let path_filter =
     let whitelist_filter : path_filter =

infer/src/backend/inferconfig.mli

@@ -41,5 +41,10 @@ module NeverReturnNull : sig
   val load_matcher : string -> matcher
 end
 
+module SkipTranslationMatcher : sig
+  type matcher = DB.source_file -> Procname.t -> bool
+  val load_matcher : string -> matcher
+end
+
 (** Load the config file and list the files to report on *)
 val test: unit -> unit

infer/src/backend/procname.ml

@@ -63,6 +63,10 @@ type detail_level =
   | NON_VERBOSE
   | SIMPLE
 
+
+let empty = OBJC_BLOCK ""
+
+
 let is_verbose v =
   match v with
   | VERBOSE -> true

infer/src/backend/procname.mli

@@ -25,6 +25,8 @@ type objc_method_kind =
   | Instance_objc_method (* for instance methods in ObjC *)
   | Class_objc_method (* for class methods in ObjC *)
 
+val empty : t
+
 (** Mangled string for method types  *)
 val mangled_of_objc_method_kind : objc_method_kind -> string option
 

infer/src/java/jMain.ml

@@ -81,7 +81,6 @@ let do_source_file
     never_null_matcher linereader classes program tenv source_basename source_file proc_file_map =
   JUtils.log "\nfilename: %s (%s)@."
     (DB.source_file_to_string source_file) source_basename;
-  init_global_state source_file;
   let call_graph, cfg =
     JFrontend.compute_source_icfg
       never_null_matcher linereader classes program tenv source_basename source_file in
@@ -145,10 +144,19 @@ let do_all_files classpath sources classes =
   let program = JClasspath.load_program classpath classes sources in
   let tenv = load_tenv program in
   let linereader = Printer.LineReader.create () in
-  let never_null_matcher = Inferconfig.NeverReturnNull.load_matcher (Inferconfig.inferconfig ()) in
+  let skip_translation_matcher =
+    Inferconfig.SkipTranslationMatcher.load_matcher (Inferconfig.inferconfig ()) in
+  let never_null_matcher =
+    Inferconfig.NeverReturnNull.load_matcher (Inferconfig.inferconfig ()) in
   let proc_file_map =
+    let skip filename =
+      skip_translation_matcher filename Procname.empty in
     StringMap.fold
-      (do_source_file never_null_matcher linereader classes program tenv)
+      (fun basename source_file map ->
+         init_global_state source_file;
+         if skip source_file then map
+         else do_source_file
+             never_null_matcher linereader classes program tenv basename source_file map)
       sources
       Procname.Map.empty in
   if !JConfig.dependency_mode then

infer/tests/.inferconfig

@@ -0,0 +1 @@
+../../.inferconfig

infer/tests/codetoanalyze/java/.inferconfig

@@ -12,5 +12,11 @@
   ],
   "infer_blacklist_files_containing": [
     "@generated"
+  ],
+  "skip_translation": [
+    {
+      "language": "Java",
+      "source_contains": "_SHOULD_BE_SKIPPED_"
+    }
   ]
 }

infer/tests/codetoanalyze/java/infer/NullPointerExceptions.java

@@ -425,4 +425,9 @@ public class NullPointerExceptions {
     o.toString();
   }
 
+  void shouldNotReportOnSkippedSource() {
+    Object o = SkippedSourceFile.createdBySkippedFile();
+    o.toString();
+  }
+
 }

infer/tests/codetoanalyze/java/infer/SkippedSourceFile.java

@@ -0,0 +1,21 @@
+/*
+* Copyright (c) 2015 - present Facebook, Inc.
+* All rights reserved.
+*
+* This source code is licensed under the BSD style license found in the
+* LICENSE file in the root directory of this source tree. An additional grant
+* of patent rights can be found in the PATENTS file in the same directory.
+*/
+
+// _SHOULD_BE_SKIPPED_
+
+package codetoanalyze.java.infer;
+
+
+public class SkippedSourceFile {
+
+  static Object createdBySkippedFile() {
+    return null;
+  }
+
+}