[racerd] improve and complete container models

Summary: Models were partial and/or simply missing (`Map` writes!).  Now the modelled containers use inheritance for conciseness (`List` reads are only those not caught by the `Collection` matcher, etc). Also, add URLs to documentation sources.

Reviewed By: ezgicicek

Differential Revision: D21132069

fbshipit-source-id: fefb360f0

infer/src/concurrency/RacerDModels.ml

@@ -33,21 +33,34 @@ let is_java_container_write =
   let array_methods =
     ["append"; "clear"; "delete"; "put"; "remove"; "removeAt"; "removeAtRange"; "setValueAt"]
   in
+  (* https://developer.android.com/reference/androidx/core/util/Pools.SimplePool *)
   make_android_support_template "Pools$SimplePool" ["acquire"; "release"]
+  (* https://developer.android.com/reference/android/support/v4/util/SimpleArrayMap *)
   @ make_android_support_template "SimpleArrayMap"
       ["clear"; "ensureCapacity"; "put"; "putAll"; "remove"; "removeAt"; "setValueAt"]
+  (* https://developer.android.com/reference/android/support/v4/util/SparseArrayCompat *)
   @ make_android_support_template "SparseArrayCompat" array_methods
-  @ [ {default with classname= "android.util.SparseArray"; methods= array_methods}
+  @ (* https://developer.android.com/reference/android/util/SparseArray *)
-    ; { default with
+  [ {default with classname= "android.util.SparseArray"; methods= array_methods}
-        classname= "java.util.List"
+  ; (* https://docs.oracle.com/javase/8/docs/api/java/util/List.html
-      ; methods= ["add"; "addAll"; "clear"; "remove"; "set"] }
+       Only methods not in parent interface [Collection] are listed *)
-    ; {default with classname= "java.util.Map"; methods= ["clear"; "put"; "putAll"; "remove"]} ]
+    {default with classname= "java.util.List"; methods= ["replaceAll"; "retainAll"; "set"; "sort"]}
+  ; (* https://docs.oracle.com/javase/8/docs/api/java/util/Map.html *)
+    { default with
+      classname= "java.util.Map"
+    ; methods= ["clear"; "merge"; "put"; "putAll"; "putIfAbsent"; "remove"; "replace"; "replaceAll"]
+    }
+  ; (* https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html *)
+    { default with
+      classname= "java.util.Collection"
+    ; methods= ["add"; "addAll"; "clear"; "remove"; "removeAll"; "removeIf"] } ]
   |> of_records
 
 
 let is_java_container_read =
   let open MethodMatcher in
   let array_methods = ["clone"; "get"; "indexOfKey"; "indexOfValue"; "keyAt"; "size"; "valueAt"] in
+  (* https://developer.android.com/reference/android/support/v4/util/SimpleArrayMap *)
   make_android_support_template "SimpleArrayMap"
     [ "containsKey"
     ; "containsValue"
@@ -58,36 +71,50 @@ let is_java_container_read =
     ; "keyAt"
     ; "size"
     ; "valueAt" ]
+  (* https://developer.android.com/reference/android/support/v4/util/SparseArrayCompat *)
   @ make_android_support_template "SparseArrayCompat" array_methods
-  @ [ {default with classname= "android.util.SparseArray"; methods= array_methods}
+  @ (* https://developer.android.com/reference/android/util/SparseArray *)
-    ; { default with
+  [ {default with classname= "android.util.SparseArray"; methods= array_methods}
-        classname= "java.util.List"
+  ; (* https://docs.oracle.com/javase/8/docs/api/java/util/List.html
-      ; methods=
+       Only methods not in parent interface [Collection] are listed *)
-          [ "contains"
+    { default with
-          ; "containsAll"
+      classname= "java.util.List"
-          ; "equals"
+    ; methods= ["get"; "indexOf"; "isEmpty"; "lastIndexOf"; "listIterator"] }
-          ; "get"
+  ; (* https://docs.oracle.com/javase/8/docs/api/java/util/Map.html *)
-          ; "hashCode"
+    { default with
-          ; "indexOf"
+      classname= "java.util.Map"
-          ; "isEmpty"
+    ; methods=
-          ; "iterator"
+        [ "compute"
-          ; "lastIndexOf"
+        ; "computeIfAbsent"
-          ; "listIterator"
+        ; "computeIfPresent"
-          ; "size"
+        ; "containsKey"
-          ; "toArray" ] }
+        ; "containsValue"
-    ; { default with
+        ; "entrySet"
-        classname= "java.util.Map"
+        ; "equals"
-      ; methods=
+        ; "forEach"
-          [ "containsKey"
+        ; "get"
-          ; "containsValue"
+        ; "getOrDefault"
-          ; "entrySet"
+        ; "hashCode"
-          ; "equals"
+        ; "isEmpty"
-          ; "get"
+        ; "keySet"
-          ; "hashCode"
+        ; "size"
-          ; "isEmpty"
+        ; "values" ] }
-          ; "keySet"
+  ; (* https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html *)
-          ; "size"
+    { default with
-          ; "values" ] } ]
+      classname= "java.util.Collection"
+    ; methods=
+        [ "contains"
+        ; "containsAll"
+        ; "equals"
+        ; "get"
+        ; "hashCode"
+        ; "isEmpty"
+        ; "iterator"
+        ; "parallelStream"
+        ; "size"
+        ; "spliterator"
+        ; "stream"
+        ; "toArray" ] } ]
   |> of_records
 
 

infer/tests/codetoanalyze/java/racerd/Containers.java

@@ -314,4 +314,20 @@ class Containers {
   void dynamicallyTypedConcurrentMapPutOk(String key, String value) {
     mConcurrentMap.put(key, value);
   }
+
+  List<String> mSomeList = new ArrayList<String>();
+
+  void addToUnsynchronizedListBad(String value) {
+    mSomeList.add(value);
+  }
+
+  List<String> mSomeOtherList = new ArrayList<String>();
+
+  int getListSizeBad() {
+    return mSomeOtherList.size();
+  }
+
+  synchronized void raceWithSizeBad(String value) {
+    mSomeOtherList.remove(value);
+  }
 }

infer/tests/codetoanalyze/java/racerd/issues.exp

@@ -29,12 +29,15 @@ codetoanalyze/java/racerd/Constructors.java, Constructors.singleton2Bad():Constr
 codetoanalyze/java/racerd/Containers.java, codetoanalyze.java.checkers.Containers.addToSimpleArrayMapBad(android.support.v4.util.SimpleArrayMap):void, 279, THREAD_SAFETY_VIOLATION, no_bucket, WARNING, [Write to container `map` via call to `put`]
 codetoanalyze/java/racerd/Containers.java, codetoanalyze.java.checkers.Containers.addToSparseArrayBad(android.util.SparseArray):void, 269, THREAD_SAFETY_VIOLATION, no_bucket, WARNING, [Write to container `sparseArray` via call to `put`]
 codetoanalyze/java/racerd/Containers.java, codetoanalyze.java.checkers.Containers.addToSparseArrayCompatBad(android.support.v4.util.SparseArrayCompat):void, 260, THREAD_SAFETY_VIOLATION, no_bucket, WARNING, [Write to container `sparseArray` via call to `put`]
+codetoanalyze/java/racerd/Containers.java, codetoanalyze.java.checkers.Containers.addToUnsynchronizedListBad(java.lang.String):void, 321, THREAD_SAFETY_VIOLATION, no_bucket, WARNING, [Write to container `this.mSomeList` via call to `add`]
 codetoanalyze/java/racerd/Containers.java, codetoanalyze.java.checkers.Containers.containerWrapperUnownedWriteBad(java.lang.Object):void, 167, THREAD_SAFETY_VIOLATION, no_bucket, WARNING, [call to Object ContainerWrapper.write(Object),call to Object ContainerWrapper._write(Object),Write to container `this.mContainerWrapper.children` via call to `add`]
+codetoanalyze/java/racerd/Containers.java, codetoanalyze.java.checkers.Containers.getListSizeBad():int, 327, THREAD_SAFETY_VIOLATION, no_bucket, WARNING, [<Read trace>,Read of container `this.mSomeOtherList` via call to `size`,<Write trace>,Write to container `this.mSomeOtherList` via call to `remove`]
 codetoanalyze/java/racerd/Containers.java, codetoanalyze.java.checkers.Containers.listAddAllBad(java.util.Collection):void, 55, THREAD_SAFETY_VIOLATION, no_bucket, WARNING, [Write to container `this.mList` via call to `addAll`]
 codetoanalyze/java/racerd/Containers.java, codetoanalyze.java.checkers.Containers.listAddBad1(java.lang.String):void, 47, THREAD_SAFETY_VIOLATION, no_bucket, WARNING, [Write to container `this.mList` via call to `add`]
 codetoanalyze/java/racerd/Containers.java, codetoanalyze.java.checkers.Containers.listAddBad2(int,java.lang.String):void, 51, THREAD_SAFETY_VIOLATION, no_bucket, WARNING, [Write to container `this.mList` via call to `add`]
 codetoanalyze/java/racerd/Containers.java, codetoanalyze.java.checkers.Containers.listClearBad():void, 59, THREAD_SAFETY_VIOLATION, no_bucket, WARNING, [Write to container `this.mList` via call to `clear`]
 codetoanalyze/java/racerd/Containers.java, codetoanalyze.java.checkers.Containers.listReadBad(java.lang.String):boolean, 98, THREAD_SAFETY_VIOLATION, no_bucket, WARNING, [<Read trace>,Read of container `this.mListSyncWrites` via call to `contains`,<Write trace>,Write to container `this.mListSyncWrites` via call to `add`]
+codetoanalyze/java/racerd/Containers.java, codetoanalyze.java.checkers.Containers.listRemoveAllBad(java.util.Collection):void, 71, THREAD_SAFETY_VIOLATION, no_bucket, WARNING, [Write to container `this.mList` via call to `removeAll`]
 codetoanalyze/java/racerd/Containers.java, codetoanalyze.java.checkers.Containers.listRemoveBad1(int):void, 63, THREAD_SAFETY_VIOLATION, no_bucket, WARNING, [Write to container `this.mList` via call to `remove`]
 codetoanalyze/java/racerd/Containers.java, codetoanalyze.java.checkers.Containers.listRemoveBad2(java.lang.String):void, 67, THREAD_SAFETY_VIOLATION, no_bucket, WARNING, [Write to container `this.mList` via call to `remove`]
 codetoanalyze/java/racerd/Containers.java, codetoanalyze.java.checkers.Containers.listSetBad(int,java.lang.String):void, 75, THREAD_SAFETY_VIOLATION, no_bucket, WARNING, [Write to container `this.mList` via call to `set`]