[pulse] Refining model for Java Collection interface

Summary:
Changing model for Java `Collection` interface. Every collection has now two internal fields, initially set to `null`. We also keep an extra field to compute emptiness. This model was implemented based on the [preexisting model for HashMap](https://github.com/facebook/infer/blob/master/infer/models/java/src/java/util/HashMap.java).

Existing models (`add`, `remove`, `set` and `is_empty`) have been updated accordingly and new models are provided: `init` and `clear`.

This model is not yet compatible with the `Map` interface but this change will happen very soon.

Reviewed By: ezgicicek

Differential Revision: D27126815

fbshipit-source-id: 79a5fe306

infer/src/pulse/PulseModels.ml

@@ -79,6 +79,18 @@ module Misc = struct
     PulseOperations.write_id ret_id ret_value astate
 
 
+  let return_zero_prune_positive ~desc (address, hist) : model =
+   fun _ ~callee_procname:_ location ~ret:(ret_id, _) astate ->
+    let event = ValueHistory.Call {f= Model desc; location; in_call= []} in
+    let fresh_elem = AbstractValue.mk_fresh () in
+    let<+> astate =
+      PulseArithmetic.prune_positive address astate
+      >>= PulseArithmetic.and_eq_int fresh_elem IntLit.zero
+      >>| PulseOperations.write_id ret_id (fresh_elem, event :: hist)
+    in
+    astate
+
+
   let return_unknown_size : model =
    fun _ ~callee_procname:_ _location ~ret:(ret_id, _) astate ->
     let ret_addr = AbstractValue.mk_fresh () in
@@ -933,6 +945,27 @@ module StdVector = struct
 end
 
 module Java = struct
+  let mk_java_field pkg clazz field =
+    Fieldname.make (Typ.JavaClass (JavaClassName.make ~package:(Some pkg) ~classname:clazz)) field
+
+
+  let load_field field location obj astate =
+    let* astate, field_addr =
+      PulseOperations.eval_access Read location obj (FieldAccess field) astate
+    in
+    let+ astate, field_val =
+      PulseOperations.eval_access Read location field_addr Dereference astate
+    in
+    (astate, field_addr, field_val)
+
+
+  let write_field field new_val location addr astate =
+    let* astate, field_addr =
+      PulseOperations.eval_access Write location addr (FieldAccess field) astate
+    in
+    PulseOperations.write_deref location ~ref:field_addr ~obj:new_val astate
+
+
   let instance_of (argv, hist) typeexpr : model =
    fun _ ~callee_procname:_ location ~ret:(ret_id, _) astate ->
     let event = ValueHistory.Call {f= Model "Java.instanceof"; location; in_call= []} in
@@ -951,69 +984,195 @@ module Java = struct
 end
 
 module JavaCollection = struct
-  (* modifies arr[index]-> old_elem to arr[index]-> new_elem and returns old_elem *)
+  let pkg_name = "java.util"
-  let set coll (index, _) (new_elem, new_elem_hist) : model =
+
-   fun _ ~callee_procname:_ location ~ret astate ->
+  let class_name = "Collection"
-    let event = ValueHistory.Call {f= Model "Collection.set"; location; in_call= []} in
+
-    let<*> astate, arr = GenericArrayBackedCollection.eval Read location coll astate in
+  let fst_field = Java.mk_java_field pkg_name class_name "__infer_model_backing_collection_fst"
-    let<*> astate, (old_addr, old_hist) =
+
-      GenericArrayBackedCollection.element location coll index astate
+  let snd_field = Java.mk_java_field pkg_name class_name "__infer_model_backing_collection_snd"
+
+  let is_empty_field =
+    Java.mk_java_field pkg_name class_name "__infer_model_backing_collection_empty"
+
+
+  let init this : model =
+   fun _ ~callee_procname:_ location ~ret:(_, _) astate ->
+    let event = ValueHistory.Call {f= Model "Collection.<init>"; location; in_call= []} in
+    let fresh_val = (AbstractValue.mk_fresh (), [event]) in
+    let is_empty_value = AbstractValue.mk_fresh () in
+    let init_value = AbstractValue.mk_fresh () in
+    (* The two internal fields are initially set to null *)
+    let<*> astate = Java.write_field fst_field (init_value, [event]) location fresh_val astate in
+    let<*> astate = Java.write_field snd_field (init_value, [event]) location fresh_val astate in
+    (* The empty field is initially set to true *)
+    let<*> astate =
+      Java.write_field is_empty_field (is_empty_value, [event]) location fresh_val astate
     in
-    let<+> astate =
+    let<*> astate =
-      PulseOperations.write_arr_index location ~ref:arr ~index
+      PulseOperations.write_deref location ~ref:this ~obj:fresh_val astate
-        ~obj:(new_elem, event :: new_elem_hist)
+      >>= PulseArithmetic.and_eq_int init_value IntLit.zero
-        astate
+      >>= PulseArithmetic.and_eq_int is_empty_value IntLit.one
     in
-    PulseOperations.write_id (fst ret) (old_addr, event :: old_hist) astate
+    astate |> ok_continue
 
 
-  (* writes to arr[index]-> new_elem   *)
+  let add coll new_elem : model =
-  let add_at coll (index, _) (new_elem, new_elem_hist) : model =
+   fun _ ~callee_procname:_ location ~ret:(ret_id, _) astate ->
-   fun _ ~callee_procname:_ location ~ret:_ astate ->
     let event = ValueHistory.Call {f= Model "Collection.add"; location; in_call= []} in
-    let<*> astate, arr = GenericArrayBackedCollection.eval Read location coll astate in
+    let ret_value = AbstractValue.mk_fresh () in
-    let<+> astate =
+    let<*> astate, coll_val = PulseOperations.eval_access Read location coll Dereference astate in
-      PulseOperations.write_arr_index location ~ref:arr ~index
+    (* reads snd_field from collection *)
-        ~obj:(new_elem, event :: new_elem_hist)
+    let<*> astate, snd_addr, snd_val = Java.load_field snd_field location coll_val astate in
-        astate
+    (* fst_field takes value stored in snd_field *)
+    let<*> astate = Java.write_field fst_field snd_val location coll_val astate in
+    (* snd_field takes new value given *)
+    let<*> astate = PulseOperations.write_deref location ~ref:snd_addr ~obj:new_elem astate in
+    (* Collection.add returns a boolean, in this case the return always has value one *)
+    let<*> astate =
+      PulseArithmetic.and_eq_int ret_value IntLit.one astate
+      >>| PulseOperations.write_id ret_id (ret_value, [event])
     in
-    astate
+    (* empty field set to false if the collection was empty *)
+    let<*> astate, _, (is_empty_val, hist) =
+      Java.load_field is_empty_field location coll_val astate
+    in
+    if PulseArithmetic.is_known_zero astate is_empty_val then astate |> ok_continue
+    else
+      let is_empty_new_val = AbstractValue.mk_fresh () in
+      let<*> astate =
+        Java.write_field is_empty_field (is_empty_new_val, event :: hist) location coll_val astate
+        >>= PulseArithmetic.and_eq_int is_empty_new_val IntLit.zero
+      in
+      astate |> ok_continue
 
 
-  (* writes to arr[index]-> new_elem where index is a fresh address *)
+  let add_at coll (_, _) new_elem : model = add coll new_elem
-  let add coll new_elem : model =
-    let index = AbstractValue.mk_fresh () in
-    add_at coll (index, []) new_elem
 
+  let update coll new_val new_val_hist event location ret_id astate =
+    (* case0: element not present in collection *)
+    let* astate, coll_val = PulseOperations.eval_access Read location coll Dereference astate in
+    let* astate, _, fst_val = Java.load_field fst_field location coll_val astate in
+    let* astate, _, snd_val = Java.load_field snd_field location coll_val astate in
+    let is_empty_val = AbstractValue.mk_fresh () in
+    let* astate' =
+      Java.write_field is_empty_field (is_empty_val, [event]) location coll_val astate
+    in
+    (* case1: fst_field is updated *)
+    let* astate1 =
+      Java.write_field fst_field (new_val, event :: new_val_hist) location coll astate'
+    in
+    let astate1 = PulseOperations.write_id ret_id fst_val astate1 in
+    (* case2: snd_field is updated *)
+    let+ astate2 =
+      Java.write_field snd_field (new_val, event :: new_val_hist) location coll astate'
+    in
+    let astate2 = PulseOperations.write_id ret_id snd_val astate2 in
+    [astate; astate1; astate2]
 
-  (* writes to arr[index]-> fresh_elem   *)
+
-  let remove_at coll (index, _) : model =
+  let set coll (_, _) (new_val, new_val_hist) : model =
-   fun _ ~callee_procname:_ location ~ret:_ astate ->
+   fun _ ~callee_procname:_ location ~ret:(ret_id, _) astate ->
-    let event = ValueHistory.Call {f= Model "Collection.add"; location; in_call= []} in
+    let event = ValueHistory.Call {f= Model "Collection.set"; location; in_call= []} in
-    let<*> astate, arr = GenericArrayBackedCollection.eval Read location coll astate in
+    let<*> astates = update coll new_val new_val_hist event location ret_id astate in
-    let fresh_elem = AbstractValue.mk_fresh () in
+    List.map ~f:(fun astate -> Ok (ContinueProgram astate)) astates
-    let<+> astate =
+
-      PulseOperations.write_arr_index location ~ref:arr ~index
+
-        ~obj:(fresh_elem, event :: snd arr)
+  let remove_at coll location ret_id astate =
-        astate
+    let event = ValueHistory.Call {f= Model "Collection.remove"; location; in_call= []} in
+    let new_val = AbstractValue.mk_fresh () in
+    PulseArithmetic.and_eq_int new_val IntLit.zero astate
+    >>= update coll new_val [] event location ret_id
+
+
+  (* Auxiliary function that updates the state by:
+     (1) assuming that value to be removed is equal to field value
+     (2) assigning field to null value
+     Collection.remove should return a boolean. In this case, the return val is one *)
+  let remove_elem_found coll_val elem field_addr field_val ret_id location event astate =
+    let null_val = AbstractValue.mk_fresh () in
+    let ret_val = AbstractValue.mk_fresh () in
+    let is_empty_val = AbstractValue.mk_fresh () in
+    let* astate =
+      Java.write_field is_empty_field (is_empty_val, [event]) location coll_val astate
     in
-    astate
+    let* astate =
+      PulseArithmetic.and_eq_int null_val IntLit.zero astate
+      >>= PulseArithmetic.and_eq_int ret_val IntLit.one
+    in
+    let* astate =
+      PulseArithmetic.prune_binop ~negated:false Binop.Eq (AbstractValueOperand elem)
+        (AbstractValueOperand field_val) astate
+    in
+    let* astate =
+      PulseOperations.write_deref location ~ref:field_addr ~obj:(null_val, [event]) astate
+    in
+    let astate = PulseOperations.write_id ret_id (ret_val, [event]) astate in
+    Ok astate
+
+
+  let remove_obj coll (elem, _) location ret_id astate =
+    let event = ValueHistory.Call {f= Model "Collection.remove"; location; in_call= []} in
+    let* astate, coll_val = PulseOperations.eval_access Read location coll Dereference astate in
+    (* case1: given element is equal to fst_field *)
+    let* astate, fst_addr, (fst_val, _) = Java.load_field fst_field location coll_val astate in
+    let* astate1 = remove_elem_found coll_val elem fst_addr fst_val ret_id location event astate in
+    (* case2: given element is equal to snd_field *)
+    let* astate, snd_addr, (snd_val, _) = Java.load_field snd_field location coll_val astate in
+    let* astate2 = remove_elem_found coll_val elem snd_addr snd_val ret_id location event astate in
+    (* case 3: given element is not equal to the fst AND not equal to the snd *)
+    let+ astate =
+      PulseArithmetic.prune_binop ~negated:true Binop.Eq (AbstractValueOperand elem)
+        (AbstractValueOperand fst_val) astate
+      >>= PulseArithmetic.prune_binop ~negated:true Binop.Eq (AbstractValueOperand elem)
+            (AbstractValueOperand snd_val)
+    in
+    [astate1; astate2; astate]
 
 
-  (* writes to arr[index]-> fresh_elem where index is fresh *)
+  let remove args : model =
-  let remove coll : model =
+   fun _ ~callee_procname:_ location ~ret:(ret_id, _) astate ->
-    let index = AbstractValue.mk_fresh () in
+    match args with
-    remove_at coll (index, [])
+    | [ {ProcnameDispatcher.Call.FuncArg.arg_payload= coll_arg}
+      ; {ProcnameDispatcher.Call.FuncArg.arg_payload= elem_arg; typ} ] ->
+        let<*> astates =
+          match typ.desc with
+          | Tint _ ->
+              (* Case of remove(int index) *)
+              remove_at coll_arg location ret_id astate
+          | _ ->
+              (* Case of remove(Object o) *)
+              remove_obj coll_arg elem_arg location ret_id astate
+        in
+        List.map ~f:(fun astate -> Ok (ContinueProgram astate)) astates
+    | _ ->
+        astate |> ok_continue
 
 
-  let is_empty (address, hist) : model =
+  let is_empty coll : model =
    fun _ ~callee_procname:_ location ~ret:(ret_id, _) astate ->
-    let event = ValueHistory.Call {f= Model "Collections.isEmpty"; location; in_call= []} in
+    let event = ValueHistory.Call {f= Model "Collection.isEmpty"; location; in_call= []} in
-    let fresh_elem = AbstractValue.mk_fresh () in
+    let<*> astate, coll_val = PulseOperations.eval_access Read location coll Dereference astate in
+    let<*> astate, (_, _), (is_empty_val, hist) =
+      Java.load_field is_empty_field location coll_val astate
+    in
+    PulseOperations.write_id ret_id (is_empty_val, event :: hist) astate |> ok_continue
+
+
+  let clear coll : model =
+   fun _ ~callee_procname:_ location ~ret:(_, _) astate ->
+    let event = ValueHistory.Call {f= Model "Collection.clear"; location; in_call= []} in
+    let null_val = AbstractValue.mk_fresh () in
+    let is_empty_val = AbstractValue.mk_fresh () in
+    let<*> astate, coll_val = PulseOperations.eval_access Read location coll Dereference astate in
+    let<*> astate = Java.write_field fst_field (null_val, [event]) location coll_val astate in
+    let<*> astate = Java.write_field snd_field (null_val, [event]) location coll_val astate in
+    let<*> astate =
+      Java.write_field is_empty_field (is_empty_val, [event]) location coll_val astate
+    in
     let<+> astate =
-      PulseArithmetic.prune_positive address astate
+      PulseArithmetic.and_eq_int null_val IntLit.zero astate
-      >>= PulseArithmetic.and_eq_int fresh_elem IntLit.zero
+      >>= PulseArithmetic.and_eq_int is_empty_val IntLit.one
-      >>| PulseOperations.write_id ret_id (fresh_elem, event :: hist)
     in
     astate
 end
@@ -1363,23 +1522,25 @@ module ProcNameDispatcher = struct
           $--> StdVector.invalidate_references ShrinkToFit
         ; -"std" &:: "vector" &:: "push_back" <>$ capt_arg_payload $+...$--> StdVector.push_back
         ; -"std" &:: "vector" &:: "empty" <>$ capt_arg_payload $+...$--> StdVector.empty
+        ; +map_context_tenv PatternMatch.Java.implements_collection
+          &:: "<init>" <>$ capt_arg_payload $--> JavaCollection.init
         ; +map_context_tenv PatternMatch.Java.implements_collection
           &:: "add" <>$ capt_arg_payload $+ capt_arg_payload $--> JavaCollection.add
         ; +map_context_tenv PatternMatch.Java.implements_list
           &:: "add" <>$ capt_arg_payload $+ capt_arg_payload $+ capt_arg_payload
           $--> JavaCollection.add_at
         ; +map_context_tenv PatternMatch.Java.implements_collection
-          &:: "remove" <>$ capt_arg_payload $+ any_arg $--> JavaCollection.remove
+          &:: "remove" &++> JavaCollection.remove
-        ; +map_context_tenv PatternMatch.Java.implements_list
-          &:: "remove" <>$ capt_arg_payload $+ capt_arg_payload $+ any_arg
-          $--> JavaCollection.remove_at
         ; +map_context_tenv PatternMatch.Java.implements_collection
           &:: "isEmpty" <>$ capt_arg_payload $--> JavaCollection.is_empty
-        ; +map_context_tenv PatternMatch.Java.implements_map
+        ; +map_context_tenv PatternMatch.Java.implements_collection
-          &:: "isEmpty" <>$ capt_arg_payload $--> JavaCollection.is_empty
+          &:: "clear" <>$ capt_arg_payload $--> JavaCollection.clear
         ; +map_context_tenv PatternMatch.Java.implements_collection
           &::+ (fun _ str -> StringSet.mem str pushback_modeled)
           <>$ capt_arg_payload $+...$--> StdVector.push_back
+        ; +map_context_tenv PatternMatch.Java.implements_map
+          &:: "isEmpty" <>$ capt_arg_payload
+          $--> Misc.return_zero_prune_positive ~desc:"Map.isEmpty()"
         ; +map_context_tenv PatternMatch.Java.implements_queue
           &::+ (fun _ str -> StringSet.mem str pushback_modeled)
           <>$ capt_arg_payload $+...$--> StdVector.push_back

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

@@ -15,22 +15,22 @@ codetoanalyze/java/impurity/Localities.java, Localities.makeAllZero_impure(java.
 codetoanalyze/java/impurity/Localities.java, Localities.modify_first_el_impure(java.util.ArrayList):void, 0, IMPURE_FUNCTION, no_bucket, ERROR, [Impure function void Localities.modify_first_el_impure(ArrayList),parameter `list.*backing_array[]x` modified here]
 codetoanalyze/java/impurity/Localities.java, Localities.modify_via_call_impure(java.util.ArrayList):void, 0, IMPURE_FUNCTION, no_bucket, ERROR, [Impure function void Localities.modify_via_call_impure(ArrayList),when calling `void Localities$Foo.inc_impure()` here,parameter `list.*backing_array[]x` modified here]
 codetoanalyze/java/impurity/Localities.java, Localities.newHashCode_impure():int, 0, IMPURE_FUNCTION, no_bucket, ERROR, [Impure function int Localities.newHashCode_impure(),call to skipped function int Object.hashCode() occurs here]
-codetoanalyze/java/impurity/PurityModeled.java, PurityModeled.add_impure(java.util.ArrayList):java.lang.String, 0, IMPURE_FUNCTION, no_bucket, ERROR, [Impure function String PurityModeled.add_impure(ArrayList),parameter `list.*backing_array` modified here]
+codetoanalyze/java/impurity/PurityModeled.java, PurityModeled.add_impure(java.util.ArrayList):java.lang.String, 0, IMPURE_FUNCTION, no_bucket, ERROR, [Impure function String PurityModeled.add_impure(ArrayList),parameter `list.**__infer_model_backing_collection_snd` modified here,parameter `list.**__infer_model_backing_collection_fst` modified here,parameter `list.**__infer_model_backing_collection_empty` modified here]
 codetoanalyze/java/impurity/PurityModeled.java, PurityModeled.append_impure(java.lang.StringBuilder):void, 0, IMPURE_FUNCTION, no_bucket, ERROR, [Impure function void PurityModeled.append_impure(StringBuilder),parameter `strBuilder.*` modified here]
-codetoanalyze/java/impurity/PurityModeled.java, PurityModeled.call_set_impure(java.util.ArrayList):void, 0, IMPURE_FUNCTION, no_bucket, ERROR, [Impure function void PurityModeled.call_set_impure(ArrayList),when calling `void PurityModeled.list_set_impure(ArrayList)` here,parameter `list.*backing_array` modified here]
+codetoanalyze/java/impurity/PurityModeled.java, PurityModeled.call_set_impure(java.util.ArrayList):void, 0, IMPURE_FUNCTION, no_bucket, ERROR, [Impure function void PurityModeled.call_set_impure(ArrayList),when calling `void PurityModeled.list_set_impure(ArrayList)` here,parameter `list.**__infer_model_backing_collection_empty` modified here,when calling `void PurityModeled.list_set_impure(ArrayList)` here,parameter `list.*__infer_model_backing_collection_snd` modified here,when calling `void PurityModeled.list_set_impure(ArrayList)` here,parameter `list.*__infer_model_backing_collection_fst` modified here]
 codetoanalyze/java/impurity/PurityModeled.java, PurityModeled.call_timing_symb_impure(int):void, 0, IMPURE_FUNCTION, no_bucket, ERROR, [Impure function void PurityModeled.call_timing_symb_impure(int),when calling `void PurityModeled.timing_call_in_loop_symb_impure(int)` here,call to skipped function long System.nanoTime() occurs here]
 codetoanalyze/java/impurity/PurityModeled.java, PurityModeled.call_timing_symb_unrelated_impure(int,int):void, 0, IMPURE_FUNCTION, no_bucket, ERROR, [Impure function void PurityModeled.call_timing_symb_unrelated_impure(int,int),when calling `void PurityModeled.timing_call_in_loop_symb_impure(int)` here,call to skipped function long System.nanoTime() occurs here]
 codetoanalyze/java/impurity/PurityModeled.java, PurityModeled.call_write_impure():void, 0, IMPURE_FUNCTION, no_bucket, ERROR, [Impure function void PurityModeled.call_write_impure(),when calling `void PurityModeled.write_impure()` here,call to skipped function void PrintStream.write(byte[],int,int) occurs here]
 codetoanalyze/java/impurity/PurityModeled.java, PurityModeled.constant_loop_pure_FP():void, 0, IMPURE_FUNCTION, no_bucket, ERROR, [Impure function void PurityModeled.constant_loop_pure_FP() with empty pulse summary]
-codetoanalyze/java/impurity/PurityModeled.java, PurityModeled.list_add_impure(java.util.ArrayList):void, 0, IMPURE_FUNCTION, no_bucket, ERROR, [Impure function void PurityModeled.list_add_impure(ArrayList),parameter `list.*backing_array` modified here]
+codetoanalyze/java/impurity/PurityModeled.java, PurityModeled.list_add_impure(java.util.ArrayList):void, 0, IMPURE_FUNCTION, no_bucket, ERROR, [Impure function void PurityModeled.list_add_impure(ArrayList),parameter `list.**__infer_model_backing_collection_snd` modified here,parameter `list.**__infer_model_backing_collection_fst` modified here,parameter `list.**__infer_model_backing_collection_empty` modified here]
 codetoanalyze/java/impurity/PurityModeled.java, PurityModeled.list_addall_impure(java.util.ArrayList,java.util.ArrayList):void, 0, IMPURE_FUNCTION, no_bucket, ERROR, [Impure function void PurityModeled.list_addall_impure(ArrayList,ArrayList),parameter `list1.*` modified here]
-codetoanalyze/java/impurity/PurityModeled.java, PurityModeled.list_set_impure(java.util.ArrayList):void, 0, IMPURE_FUNCTION, no_bucket, ERROR, [Impure function void PurityModeled.list_set_impure(ArrayList),parameter `list.*backing_array` modified here]
+codetoanalyze/java/impurity/PurityModeled.java, PurityModeled.list_set_impure(java.util.ArrayList):void, 0, IMPURE_FUNCTION, no_bucket, ERROR, [Impure function void PurityModeled.list_set_impure(ArrayList),parameter `list.**__infer_model_backing_collection_empty` modified here,parameter `list.*__infer_model_backing_collection_snd` modified here,parameter `list.*__infer_model_backing_collection_fst` modified here]
 codetoanalyze/java/impurity/PurityModeled.java, PurityModeled.math_random_impure():double, 0, IMPURE_FUNCTION, no_bucket, ERROR, [Impure function double PurityModeled.math_random_impure(),call to skipped function double Math.random() occurs here]
 codetoanalyze/java/impurity/PurityModeled.java, PurityModeled.math_random_in_loop_impure(int):int, 0, IMPURE_FUNCTION, no_bucket, ERROR, [Impure function int PurityModeled.math_random_in_loop_impure(int),when calling `void PurityModeled.call_write_impure()` here,when calling `void PurityModeled.write_impure()` here,call to skipped function void PrintStream.write(byte[],int,int) occurs here,call to skipped function double Math.random() occurs here]
 codetoanalyze/java/impurity/PurityModeled.java, PurityModeled.nested_remove_impure(java.util.ArrayList):void, 0, IMPURE_FUNCTION, no_bucket, ERROR, [Impure function void PurityModeled.nested_remove_impure(ArrayList),parameter `list.*backing_array[]backing_array` modified here]
 codetoanalyze/java/impurity/PurityModeled.java, PurityModeled.next_impure(java.util.Iterator):java.lang.Integer, 0, IMPURE_FUNCTION, no_bucket, ERROR, [Impure function Integer PurityModeled.next_impure(Iterator),parameter `it.*` modified here]
-codetoanalyze/java/impurity/PurityModeled.java, PurityModeled.process_queue_impure(java.util.ArrayList,java.util.Queue):void, 0, IMPURE_FUNCTION, no_bucket, ERROR, [Impure function void PurityModeled.process_queue_impure(ArrayList,Queue),parameter `queue.*backing_array` modified here]
+codetoanalyze/java/impurity/PurityModeled.java, PurityModeled.process_queue_impure(java.util.ArrayList,java.util.Queue):void, 0, IMPURE_FUNCTION, no_bucket, ERROR, [Impure function void PurityModeled.process_queue_impure(ArrayList,Queue),parameter `queue.**__infer_model_backing_collection_snd` modified here,parameter `queue.**__infer_model_backing_collection_fst` modified here,parameter `queue.**__infer_model_backing_collection_empty` modified here]
-codetoanalyze/java/impurity/PurityModeled.java, PurityModeled.remove_all_directly_impure(java.util.ArrayList):void, 0, IMPURE_FUNCTION, no_bucket, ERROR, [Impure function void PurityModeled.remove_all_directly_impure(ArrayList),parameter `list.*backing_array` modified here]
+codetoanalyze/java/impurity/PurityModeled.java, PurityModeled.remove_all_directly_impure(java.util.ArrayList):void, 0, IMPURE_FUNCTION, no_bucket, ERROR, [Impure function void PurityModeled.remove_all_directly_impure(ArrayList),parameter `list.**__infer_model_backing_collection_snd` modified here,parameter `list.**__infer_model_backing_collection_fst` modified here,parameter `list.**__infer_model_backing_collection_empty` modified here]
 codetoanalyze/java/impurity/PurityModeled.java, PurityModeled.remove_all_impure(java.util.ArrayList):void, 0, IMPURE_FUNCTION, no_bucket, ERROR, [Impure function void PurityModeled.remove_all_impure(ArrayList),parameter `list.*backing_array` modified here,call to skipped function void PrintStream.println(String) occurs here]
 codetoanalyze/java/impurity/PurityModeled.java, PurityModeled.remove_fresh_impure(java.util.ArrayList):java.lang.String, 0, IMPURE_FUNCTION, no_bucket, ERROR, [Impure function String PurityModeled.remove_fresh_impure(ArrayList),parameter `list.*backing_array` modified here]
 codetoanalyze/java/impurity/PurityModeled.java, PurityModeled.remove_impure(java.util.Iterator):void, 0, IMPURE_FUNCTION, no_bucket, ERROR, [Impure function void PurityModeled.remove_impure(Iterator),parameter `i.*` modified here]

infer/tests/codetoanalyze/java/pulse/Lists.java

@@ -19,7 +19,7 @@ class Lists {
     }
   }
 
-  void FN_removeInvalidatesNonEmptinessNPEBad(List l) {
+  void FN_latent_removeInvalidatesNonEmptinessNPEBad(List l) {
     l.removeAll(l);
     Object o = null;
     if (l.isEmpty()) {
@@ -27,7 +27,7 @@ class Lists {
     }
   }
 
-  void FN_clearCausesEmptinessNPEBad(List l) {
+  void clearCausesEmptinessNPEBad(List l) {
     l.clear();
     Object o = null;
     if (l.isEmpty()) {
@@ -51,7 +51,7 @@ class Lists {
     getElement(l).toString();
   }
 
-  void FN_getElementNPE() {
+  void getElementNPEBad() {
     List l = new ArrayList();
     if (!l.isEmpty()) {
       return;
@@ -59,7 +59,7 @@ class Lists {
     getElement(l).toString();
   }
 
-  void FP_getElementOk() {
+  void getElementOk() {
     List l = new ArrayList();
     if (!l.isEmpty()) {
       Object o = null;
@@ -74,4 +74,33 @@ class Lists {
       o.toString();
     }
   }
+
+  void addAndRemoveEmptinessNPEBad() {
+    List l = new ArrayList();
+    Integer i = new Integer(1);
+    l.add(i);
+    l.remove(i);
+    if (l.isEmpty()) {
+      getElement(l).toString();
+    }
+  }
+
+  void FP_removeOnEmptyListOk() {
+    List l = new LinkedList();
+    Object removed = l.remove(0);
+    if (removed != null) {
+      getElement(l).toString();
+    }
+  }
+
+  void removeElementBad() {
+    List l = new LinkedList();
+    Integer i = new Integer(4);
+    l.add(i);
+    boolean removed = l.remove(i);
+    if (removed) {
+      Object o = null;
+      o.toString();
+    }
+  }
 }

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

@@ -23,8 +23,13 @@ codetoanalyze/java/pulse/IntegerExample.java, codetoanalyze.java.infer.IntegerEx
 codetoanalyze/java/pulse/IntegerExample.java, codetoanalyze.java.infer.IntegerExample.testIntegerEqualsMethodMaxValueBad():void, 6, NULLPTR_DEREFERENCE, no_bucket, ERROR, [source of the null value part of the trace starts here,assigned,is the null pointer,null pointer dereference part of the trace starts here,assigned,invalid access occurs here]
 codetoanalyze/java/pulse/InvokeDynamic.java, codetoanalyze.java.infer.InvokeDynamic.invokeDynamicThenNpeBad(java.util.List):void, 7, NULLPTR_DEREFERENCE, no_bucket, ERROR, [source of the null value part of the trace starts here,assigned,is the null pointer,null pointer dereference part of the trace starts here,assigned,invalid access occurs here]
 codetoanalyze/java/pulse/InvokeDynamic.java, codetoanalyze.java.infer.InvokeDynamic.lambda$npeInLambdaBad$1(java.lang.String,java.lang.String):int, 1, NULLPTR_DEREFERENCE, no_bucket, ERROR, [source of the null value part of the trace starts here,assigned,is the null pointer,null pointer dereference part of the trace starts here,assigned,invalid access occurs here]
-codetoanalyze/java/pulse/Lists.java, codetoanalyze.java.infer.Lists.FP_getElementOk():void, 4, NULLPTR_DEREFERENCE, no_bucket, ERROR, [source of the null value part of the trace starts here,assigned,is the null pointer,null pointer dereference part of the trace starts here,assigned,invalid access occurs here]
+codetoanalyze/java/pulse/Lists.java, codetoanalyze.java.infer.Lists.FN_latent_removeInvalidatesNonEmptinessNPEBad(java.util.List):void, 4, NULLPTR_DEREFERENCE, no_bucket, ERROR, [*** LATENT ***,source of the null value part of the trace starts here,assigned,is the null pointer,null pointer dereference part of the trace starts here,assigned,invalid access occurs here]
-codetoanalyze/java/pulse/Lists.java, codetoanalyze.java.infer.Lists.addInvalidatesEmptinessNPEBad(java.util.List):void, 4, NULLPTR_DEREFERENCE, no_bucket, ERROR, [*** LATENT ***,source of the null value part of the trace starts here,assigned,is the null pointer,null pointer dereference part of the trace starts here,assigned,invalid access occurs here]
+codetoanalyze/java/pulse/Lists.java, codetoanalyze.java.infer.Lists.FP_removeOnEmptyListOk():void, 4, NULLPTR_DEREFERENCE, no_bucket, ERROR, [source of the null value part of the trace starts here,when calling `Object Lists.getElement(List)` here,assigned,is the null pointer,null pointer dereference part of the trace starts here,passed as argument to `Object Lists.getElement(List)`,return from call to `Object Lists.getElement(List)`,assigned,invalid access occurs here]
+codetoanalyze/java/pulse/Lists.java, codetoanalyze.java.infer.Lists.addAndRemoveEmptinessNPEBad():void, 6, NULLPTR_DEREFERENCE, no_bucket, ERROR, [source of the null value part of the trace starts here,when calling `Object Lists.getElement(List)` here,assigned,is the null pointer,null pointer dereference part of the trace starts here,passed as argument to `Object Lists.getElement(List)`,return from call to `Object Lists.getElement(List)`,assigned,invalid access occurs here]
+codetoanalyze/java/pulse/Lists.java, codetoanalyze.java.infer.Lists.addInvalidatesEmptinessNPEBad(java.util.List):void, 4, NULLPTR_DEREFERENCE, no_bucket, ERROR, [source of the null value part of the trace starts here,assigned,is the null pointer,null pointer dereference part of the trace starts here,assigned,invalid access occurs here]
+codetoanalyze/java/pulse/Lists.java, codetoanalyze.java.infer.Lists.clearCausesEmptinessNPEBad(java.util.List):void, 4, NULLPTR_DEREFERENCE, no_bucket, ERROR, [source of the null value part of the trace starts here,assigned,is the null pointer,null pointer dereference part of the trace starts here,assigned,invalid access occurs here]
+codetoanalyze/java/pulse/Lists.java, codetoanalyze.java.infer.Lists.getElementNPEBad():void, 5, NULLPTR_DEREFERENCE, no_bucket, ERROR, [source of the null value part of the trace starts here,when calling `Object Lists.getElement(List)` here,assigned,is the null pointer,null pointer dereference part of the trace starts here,passed as argument to `Object Lists.getElement(List)`,return from call to `Object Lists.getElement(List)`,assigned,invalid access occurs here]
+codetoanalyze/java/pulse/Lists.java, codetoanalyze.java.infer.Lists.removeElementBad():void, 7, NULLPTR_DEREFERENCE, no_bucket, ERROR, [source of the null value part of the trace starts here,assigned,is the null pointer,null pointer dereference part of the trace starts here,assigned,invalid access occurs here]
 codetoanalyze/java/pulse/NullPointerExceptions.java, codetoanalyze.java.infer.NullPointerExceptions$$$Class$Name$With$Dollars.npeWithDollars():void, 2, NULLPTR_DEREFERENCE, no_bucket, ERROR, [source of the null value part of the trace starts here,assigned,is the null pointer,null pointer dereference part of the trace starts here,assigned,invalid access occurs here]
 codetoanalyze/java/pulse/NullPointerExceptions.java, codetoanalyze.java.infer.NullPointerExceptions.FP_derefBoxedGetterAfterCheckShouldNotCauseNPE():void, 1, NULLPTR_DEREFERENCE, no_bucket, ERROR, [source of the null value part of the trace starts here,when calling `Boolean NullPointerExceptions.getBool()` here,assigned,is the null pointer,null pointer dereference part of the trace starts here,passed as argument to `Boolean NullPointerExceptions.getBool()`,return from call to `Boolean NullPointerExceptions.getBool()`,assigned,invalid access occurs here]
 codetoanalyze/java/pulse/NullPointerExceptions.java, codetoanalyze.java.infer.NullPointerExceptions.FP_derefGetterAfterCheckShouldNotCauseNPE():void, 2, NULLPTR_DEREFERENCE, no_bucket, ERROR, [source of the null value part of the trace starts here,when calling `Object NullPointerExceptions.getObj()` here,assigned,is the null pointer,null pointer dereference part of the trace starts here,passed as argument to `Object NullPointerExceptions.getObj()`,return from call to `Object NullPointerExceptions.getObj()`,assigned,invalid access occurs here]