From 2d424b7779d62a6f2de37dee626a0e39f5210c4b Mon Sep 17 00:00:00 2001
From: Peter O'Hearn <peteroh@fb.com>
Date: Tue, 1 Nov 2016 10:55:12 -0700
Subject: [PATCH] skipping ReadWrite Locks

Summary: We want to skip readwrite locks for now, maybe report on their misuses later.

Reviewed By: sblackshear

Differential Revision: D4110998

fbshipit-source-id: 986f77e
---
 infer/src/backend/rearrange.ml                | 33 +++++++--------
 .../java/infer/GuardedByExample.java          | 41 +++++++++++++++++++
 2 files changed, 58 insertions(+), 16 deletions(-)

diff --git a/infer/src/backend/rearrange.ml b/infer/src/backend/rearrange.ml
index 6c5d1ea69..21c765566 100644
--- a/infer/src/backend/rearrange.ml
+++ b/infer/src/backend/rearrange.ml
@@ -659,16 +659,16 @@ let add_guarded_by_constraints tenv prop lexp pdesc =
     IList.find_map_opt annot_extract_guarded_by_str item_annot in
   let extract_suppress_warnings_str item_annot =
     let annot_suppress_warnings_str ((annot: Annot.t), _) =
-        if Annotations.annot_ends_with annot Annotations.suppress_lint
-        then
-          match annot.parameters with
-          | [suppr_str] ->
-              Some suppr_str
-          | _ ->
-              None
-        else
-          None in
-      IList.find_map_opt annot_suppress_warnings_str item_annot in
+      if Annotations.annot_ends_with annot Annotations.suppress_lint
+      then
+        match annot.parameters with
+        | [suppr_str] ->
+            Some suppr_str
+        | _ ->
+            None
+      else
+        None in
+    IList.find_map_opt annot_suppress_warnings_str item_annot in
   (* if [fld] is annotated with @GuardedBy("mLock"), return mLock *)
   let get_guarded_by_fld_str fld typ =
     match StructTyp.get_field_type_and_annotation ~lookup fld typ with
@@ -746,7 +746,8 @@ let add_guarded_by_constraints tenv prop lexp pdesc =
       let exn = Exceptions.Unsafe_guarded_by_access (err_desc, __POS__) in
       Reporting.log_error pname exn in
     let rec is_read_write_lock typ =
-      let str_is_read_write_lock str = string_is_suffix "ReadWriteUpdateLock" str in
+      let str_is_read_write_lock str = string_is_suffix "ReadWriteUpdateLock" str ||
+                                       string_is_suffix "ReadWriteLock" str  in
       match typ with
       | Typ.Tstruct name -> str_is_read_write_lock (Typename.name name)
       | Typ.Tptr (typ, _) -> is_read_write_lock typ
@@ -770,10 +771,10 @@ let add_guarded_by_constraints tenv prop lexp pdesc =
       let proc_signature =
         Annotations.get_annotated_signature (Cfg.Procdesc.get_attributes pdesc) in
       let proc_annot, _ = proc_signature.Annotations.ret in
-        match extract_suppress_warnings_str proc_annot with
-          | Some suppression_str->
-            suppression_str = "InvalidAccessToGuardedField"
-          | None -> false in
+      match extract_suppress_warnings_str proc_annot with
+      | Some suppression_str->
+          suppression_str = "InvalidAccessToGuardedField"
+      | None -> false in
     let should_warn pdesc =
       (* adding this check implements "by reference" semantics for guarded-by rather than "by value"
          semantics. if this access is through a local L or field V.f
@@ -800,7 +801,7 @@ let add_guarded_by_constraints tenv prop lexp pdesc =
       not (is_accessible_through_local_ref lexp) &&
       not guardedby_is_self_referential &&
       not (proc_has_suppress_guarded_by_annot pdesc)
-      in
+    in
     match find_guarded_by_exp guarded_by_str prop.Prop.sigma with
     | Some (Sil.Eexp (guarded_by_exp, _), typ) ->
         if is_read_write_lock typ
diff --git a/infer/tests/codetoanalyze/java/infer/GuardedByExample.java b/infer/tests/codetoanalyze/java/infer/GuardedByExample.java
index 8fbbf9d1c..a1b2e2c08 100644
--- a/infer/tests/codetoanalyze/java/infer/GuardedByExample.java
+++ b/infer/tests/codetoanalyze/java/infer/GuardedByExample.java
@@ -16,6 +16,8 @@ import java.lang.annotation.Target;
 import com.google.common.annotations.VisibleForTesting;
 import android.annotation.SuppressLint;
 import javax.annotation.concurrent.GuardedBy;
+import java.util.concurrent.locks.ReadWriteLock;
+import java.util.concurrent.locks.ReentrantReadWriteLock;
 
 import java.io.Closeable;
 
@@ -432,4 +434,43 @@ public class GuardedByExample {
   }
   */
 
+
+  ReadWriteLock mRWL;
+
+  @GuardedBy("mRWL")
+  Integer guardedbymRWL;
+
+  Integer someOtherInt;
+
+  void readLockOK() {
+    mRWL.readLock().lock();
+    someOtherInt = guardedbymRWL;
+    mRWL.readLock().unlock();
+  }
+
+  void writeLockOK() {
+    mRWL.writeLock().lock();
+    guardedbymRWL = 55;
+    mRWL.writeLock().unlock();
+  }
+
+  ReentrantReadWriteLock mRRWL;
+
+  @GuardedBy("mRRWL")
+  Integer guardedbymRRWL;
+
+  void reentrantReadLockOK() {
+    mRRWL.readLock().lock();
+    someOtherInt = guardedbymRRWL;
+    mRRWL.readLock().unlock();
+  }
+
+  void reentrantWriteLockOK() {
+    mRRWL.writeLock().lock();
+    guardedbymRRWL = 55;
+    mRRWL.writeLock().unlock();
+  }
+
+  // TODO: warn on misuse of read/write locks.
+
 }