[ownership] simple 2-step traces

Summary:
Show where the invalidation occurred in the trace.
Should make things easier to understand.

Reviewed By: jeremydubreil

Differential Revision: D7312182

fbshipit-source-id: 44ba9cc

infer/src/checkers/Ownership.ml

@@ -14,7 +14,9 @@ module VarSet = AbstractDomain.FiniteSet (Var)
 
 module CapabilityDomain = struct
   type astate =
-    | Invalid  (** neither owned nor borrowed; we can't do anything with this value *)
+    | InvalidatedAt of Location.t
+        (** neither owned nor borrowed; we can't safely do anything with this value. tagged with the
+        location where invalidation occurred. *)
     | BorrowedFrom of VarSet.astate
         (** not owned, but borrowed from existing reference(s). for now, permits both reads and writes *)
     | Owned
@@ -25,12 +27,16 @@ module CapabilityDomain = struct
     BorrowedFrom vars
 
 
-  (** Owned <= BorrowedFrom <= Invalid *)
+  (** Owned <= BorrowedFrom <= InvalidatedAt *)
   let ( <= ) ~lhs ~rhs =
+    if phys_equal lhs rhs then true
+    else
       match (lhs, rhs) with
-    | _, Invalid ->
+      | InvalidatedAt loc1, InvalidatedAt loc2 ->
+          Location.compare loc1 loc2 <= 0
+      | _, InvalidatedAt _ ->
           true
-    | Invalid, _ ->
+      | InvalidatedAt _, _ ->
           false
       | BorrowedFrom s1, BorrowedFrom s2 ->
           VarSet.( <= ) ~lhs:s1 ~rhs:s2
@@ -48,15 +54,18 @@ module CapabilityDomain = struct
           BorrowedFrom (VarSet.union s1 s2)
       | Owned, astate | astate, Owned ->
           astate
-      | Invalid, _ | _, Invalid ->
-          Invalid
+      | InvalidatedAt loc1, InvalidatedAt loc2 ->
+          (* pick the "higher" program point that occurs syntactically later *)
+          if Location.compare loc1 loc2 >= 0 then astate1 else astate2
+      | (InvalidatedAt _ as invalid), _ | _, (InvalidatedAt _ as invalid) ->
+          invalid
 
 
   let widen ~prev ~next ~num_iters:_ = join prev next
 
   let pp fmt = function
-    | Invalid ->
-        F.fprintf fmt "Invalid"
+    | InvalidatedAt loc ->
+        F.fprintf fmt "InvalidatedAt(%a)" Location.pp loc
     | BorrowedFrom vars ->
         F.fprintf fmt "BorrowedFrom(%a)" VarSet.pp vars
     | Owned ->
@@ -76,36 +85,39 @@ let rec is_function_typ = function
 module Domain = struct
   include AbstractDomain.Map (Var) (CapabilityDomain)
 
-  let report_use_after_lifetime var loc summary =
+  let report_use_after_lifetime var ~use_loc ~invalidated_loc summary =
     let message =
-      F.asprintf "Variable %a is used after its lifetime has ended at %a" Var.pp var Location.pp
-        loc
+      F.asprintf "Variable %a is used at line %a after its lifetime ended at %a" Var.pp var
+        Location.pp use_loc Location.pp invalidated_loc
+    in
+    let ltr =
+      [ Errlog.make_trace_element 0 invalidated_loc "End of variable lifetime" []
+      ; Errlog.make_trace_element 0 use_loc "Use of invalid variable" [] ]
     in
-    let ltr = [Errlog.make_trace_element 0 loc "Use of invalid variable" []] in
     let exn = Exceptions.Checkers (IssueType.use_after_lifetime, Localise.verbatim_desc message) in
-    Reporting.log_error summary ~loc ~ltr exn
+    Reporting.log_error summary ~loc:use_loc ~ltr exn
 
 
   (* complain if we do not have the right capability to access [var] *)
-  let check_var_lifetime var loc summary astate =
+  let check_var_lifetime var use_loc summary astate =
     let open CapabilityDomain in
     match find var astate with
-    | Invalid ->
-        report_use_after_lifetime var loc summary
+    | InvalidatedAt invalidated_loc ->
+        report_use_after_lifetime var ~use_loc ~invalidated_loc summary
     | BorrowedFrom borrowed_vars ->
         (* warn if any of the borrowed vars are Invalid *)
-        let is_invalid v =
+        let report_invalidated v =
           match find v astate with
-          | Invalid ->
-              true
+          | InvalidatedAt invalidated_loc ->
+              report_use_after_lifetime var ~use_loc ~invalidated_loc summary
           | BorrowedFrom _
           (* TODO: can do deeper checking here, but have to worry about borrow cycles *)
           | Owned ->
-              false
+              ()
           | exception Not_found ->
-              false
+              ()
         in
-        if VarSet.exists is_invalid borrowed_vars then report_use_after_lifetime var loc summary
+        VarSet.iter report_invalidated borrowed_vars
     | Owned ->
         ()
     | exception Not_found ->
@@ -282,7 +294,7 @@ module TransferFunctions (CFG : ProcCfg.S) = struct
     | Call (_, Direct callee_pname, [(AccessExpression Base ((lhs_var, _) as lhs_base))], _, loc)
       when transfers_ownership callee_pname ->
         Domain.base_add_read lhs_base loc summary astate
-        |> Domain.add lhs_var CapabilityDomain.Invalid
+        |> Domain.add lhs_var (CapabilityDomain.InvalidatedAt loc)
     | Call
         ( _
         , Direct Typ.Procname.ObjC_Cpp callee_pname

infer/tests/codetoanalyze/cpp/ownership/basics.cpp

@@ -23,3 +23,23 @@ void aggregate_reassign_ok() {
     arr[0] = s; // shouldn't be flagged as a use-after-lifetime
   }
 }
+
+int multiple_invalidations_branch_bad(int n, int* ptr) {
+  if (n == 7) {
+    delete ptr;
+  } else {
+    delete ptr;
+  }
+  return *ptr;
+}
+
+int multiple_invalidations_loop_bad(int n, int* ptr) {
+  for (int i = 0; i < n; i++) {
+    if (i == 7) {
+      delete ptr;
+    } else {
+      delete ptr;
+    }
+  }
+  return *ptr;
+}

infer/tests/codetoanalyze/cpp/ownership/issues.exp

@@ -1,13 +1,17 @@
-codetoanalyze/cpp/ownership/closures.cpp, implicit_ref_capture_destroy_invoke_bad, 6, USE_AFTER_LIFETIME, ERROR, [Use of invalid variable]
-codetoanalyze/cpp/ownership/closures.cpp, reassign_lambda_capture_destroy_invoke_bad, 7, USE_AFTER_LIFETIME, ERROR, [Use of invalid variable]
-codetoanalyze/cpp/ownership/closures.cpp, ref_capture_destroy_invoke_bad, 6, USE_AFTER_LIFETIME, ERROR, [Use of invalid variable]
-codetoanalyze/cpp/ownership/use_after_delete.cpp, delete_in_branch_bad, 5, USE_AFTER_LIFETIME, ERROR, [Use of invalid variable]
-codetoanalyze/cpp/ownership/use_after_delete.cpp, delete_in_loop_bad, 3, USE_AFTER_LIFETIME, ERROR, [Use of invalid variable]
-codetoanalyze/cpp/ownership/use_after_delete.cpp, deref_deleted_bad, 3, USE_AFTER_LIFETIME, ERROR, [Use of invalid variable]
-codetoanalyze/cpp/ownership/use_after_delete.cpp, double_delete_bad, 3, USE_AFTER_LIFETIME, ERROR, [Use of invalid variable]
-codetoanalyze/cpp/ownership/use_after_delete.cpp, reassign_field_of_deleted_bad, 3, USE_AFTER_LIFETIME, ERROR, [Use of invalid variable]
-codetoanalyze/cpp/ownership/use_after_delete.cpp, return_deleted_bad, 3, USE_AFTER_LIFETIME, ERROR, [Use of invalid variable]
-codetoanalyze/cpp/ownership/use_after_delete.cpp, use_in_branch_bad, 4, USE_AFTER_LIFETIME, ERROR, [Use of invalid variable]
-codetoanalyze/cpp/ownership/use_after_delete.cpp, use_in_loop_bad, 4, USE_AFTER_LIFETIME, ERROR, [Use of invalid variable]
-codetoanalyze/cpp/ownership/use_after_destructor.cpp, double_destructor_bad, 5, USE_AFTER_LIFETIME, ERROR, [Use of invalid variable]
-codetoanalyze/cpp/ownership/use_after_destructor.cpp, use_after_destructor_bad, 3, USE_AFTER_LIFETIME, ERROR, [Use of invalid variable]
+codetoanalyze/cpp/ownership/basics.cpp, multiple_invalidations_branch_bad, 6, USE_AFTER_LIFETIME, ERROR, [End of variable lifetime,Use of invalid variable]
+codetoanalyze/cpp/ownership/basics.cpp, multiple_invalidations_loop_bad, 3, USE_AFTER_LIFETIME, ERROR, [End of variable lifetime,Use of invalid variable]
+codetoanalyze/cpp/ownership/basics.cpp, multiple_invalidations_loop_bad, 5, USE_AFTER_LIFETIME, ERROR, [End of variable lifetime,Use of invalid variable]
+codetoanalyze/cpp/ownership/basics.cpp, multiple_invalidations_loop_bad, 8, USE_AFTER_LIFETIME, ERROR, [End of variable lifetime,Use of invalid variable]
+codetoanalyze/cpp/ownership/closures.cpp, implicit_ref_capture_destroy_invoke_bad, 6, USE_AFTER_LIFETIME, ERROR, [End of variable lifetime,Use of invalid variable]
+codetoanalyze/cpp/ownership/closures.cpp, reassign_lambda_capture_destroy_invoke_bad, 7, USE_AFTER_LIFETIME, ERROR, [End of variable lifetime,Use of invalid variable]
+codetoanalyze/cpp/ownership/closures.cpp, ref_capture_destroy_invoke_bad, 6, USE_AFTER_LIFETIME, ERROR, [End of variable lifetime,Use of invalid variable]
+codetoanalyze/cpp/ownership/use_after_delete.cpp, delete_in_branch_bad, 5, USE_AFTER_LIFETIME, ERROR, [End of variable lifetime,Use of invalid variable]
+codetoanalyze/cpp/ownership/use_after_delete.cpp, delete_in_loop_bad, 3, USE_AFTER_LIFETIME, ERROR, [End of variable lifetime,Use of invalid variable]
+codetoanalyze/cpp/ownership/use_after_delete.cpp, deref_deleted_bad, 3, USE_AFTER_LIFETIME, ERROR, [End of variable lifetime,Use of invalid variable]
+codetoanalyze/cpp/ownership/use_after_delete.cpp, double_delete_bad, 3, USE_AFTER_LIFETIME, ERROR, [End of variable lifetime,Use of invalid variable]
+codetoanalyze/cpp/ownership/use_after_delete.cpp, reassign_field_of_deleted_bad, 3, USE_AFTER_LIFETIME, ERROR, [End of variable lifetime,Use of invalid variable]
+codetoanalyze/cpp/ownership/use_after_delete.cpp, return_deleted_bad, 3, USE_AFTER_LIFETIME, ERROR, [End of variable lifetime,Use of invalid variable]
+codetoanalyze/cpp/ownership/use_after_delete.cpp, use_in_branch_bad, 4, USE_AFTER_LIFETIME, ERROR, [End of variable lifetime,Use of invalid variable]
+codetoanalyze/cpp/ownership/use_after_delete.cpp, use_in_loop_bad, 4, USE_AFTER_LIFETIME, ERROR, [End of variable lifetime,Use of invalid variable]
+codetoanalyze/cpp/ownership/use_after_destructor.cpp, double_destructor_bad, 5, USE_AFTER_LIFETIME, ERROR, [End of variable lifetime,Use of invalid variable]
+codetoanalyze/cpp/ownership/use_after_destructor.cpp, use_after_destructor_bad, 3, USE_AFTER_LIFETIME, ERROR, [End of variable lifetime,Use of invalid variable]