1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
|
The GuardedBy analysis checks that fields or methods annotated with
`@GuardedBy(lock)` are only accessed when the specified lock is held.
Example:
```java
import com.google.errorprone.annotations.concurrent.GuardedBy;
class Account {
@GuardedBy("this")
private int balance;
public synchronized int getBalance() {
return balance; // OK: implicit 'this' lock is held.
}
public synchronized void withdraw(int amount) {
setBalance(balance - amount); // OK: implicit 'this' lock is held.
}
public void deposit(int amount) {
setBalance(balance + amount); // ERROR: access to 'balance' not guarded by 'this'.
}
@GuardedBy("this")
private void setBalance(int newBalance) {
checkState(newBalance >= 0, "Balance cannot be negative.");
balance = newBalance; // OK: 'this' must be held by caller of 'setBalance'.
}
}
```
This above example uses implicit locks (via the 'synchronized' modifier). The
analysis also supports synchronized statements and java.util.concurrent locks.
## Basic Concepts
The analysis provides a way of associating members with locks. A member is a
field or a method. A lock can be the implicit lock of an object, or a
java.util.concurrent Lock.
An implicit lock is acquired using the built in synchronization features of the
language. Adding the 'synchronized' modifier to an instance method causes the
implicit lock of the enclosing instance to be acquired for the duration of the
method. Adding the 'synchronized' modifier to a static method is similar, except
the implicit lock of the Class object is acquired instead.
The Locks defined in java.util.concurrent are acquired with explicit
lock()/unlock() methods. The use of these methods in Java should always
correspond to a try/finally block, to ensure that the locks are released on all
execution paths.
## Reference
### Lock expression syntax
The following syntax can be used to describe a lock:
<table><tr><td><code>
this
</code></td><td>
The implicit object lock of the enclosing class.
</td></tr><tr><td><code>
ClassName.this
</code></td><td>
The implicit object lock of the enclosing class specified by ClassName.
(For inner classes, the ClassName.this designation allows you to specify which
'this' reference is intended.)
</td></tr><tr><td><code>
fieldName <br>
this.fieldName <br>
ClassName.this.fieldName
</code></td><td>
The final instance field specified by fieldName.
</td></tr><tr><td><code>
methodName() <br>
this.methodName() <br>
ClassName.this.methodName()
</code></td><td>
The instance method specified by methodName(). Methods called to return
locks should be deterministic.
</td></tr><tr><td><code>
ClassName.class
</code></td><td>
The implicit lock of specified Class object.
</td></tr><tr><td><code>
ClassName.fieldName
</code></td><td>
The static final field specified by fieldName.
</td></tr><tr><td><code>
ClassName.methodName()
</code></td><td>
The static method specified by methodName(). Methods called to return locks
should be deterministic.
</td></tr><tr><td><code>
itself
</code></td><td>
The annotated field.
</td></tr></table>
### Annotations
#### @GuardedBy
com.google.errorprone.annotations.concurrent.GuardedBy
The @GuardedBy annotation is used to document that a member (a field or a
method) can only be accessed when the specified lock is held.
@GuardedBy can be used with both implicit locks and java.util.concurrent Locks.
```java
final Lock lock = new ReentrantLock();
@GuardedBy("lock")
int x;
void m() {
x++; // error: access of 'x' not guarded by 'lock'
lock.lock();
try {
x++; // OK: guarded by 'lock'
} finally {
lock.unlock();
}
}
```
Note: there are a couple more annotations called `@GuardedBy`, including
`javax.annotation.concurrent.GuardedBy` and
`org.checkerframework.checker.lock.qual.GuardedBy`. The check recognizes those
versions of the annotation, but we recommend using
`com.google.errorprone.annotations.concurrent.GuardedBy`.
#### Limitations
Anonymous classes and lambdas need to re-acquire locks that may be held by an
enclosing block. For example, consider:
```java
class Transaction {
@GuardedBy("this")
int x;
public synchronized void handle() {
doSomething(() -> {
x++; // Error: access of 'x' not guarded by 'Transaction.this'
});
}
}
```
The analysis is intra-procedural, meaning it doesn't consider the implementation
of `doSomething`.
In general, the checker doesn't know if `doSomething` immediately calls the
provided lambda while the lock is still held by the enclosing method `handle`,
for example:
```java
private void doSomething(Runnable r) {
r.run();
}
```
... or whether the lambda could be called later after `handle` has released the
lock, for example:
```java
private void doSomething(Runnable r) {
// runs `r` at some point in the future
someExecutor.execute(r);
}
```
However, the check does special-case some method calls which are known to
immediately call the provided lambda or method reference.
#### False negatives with aliasing
```java
class Names {
@GuardedBy("this")
List<String> names = new ArrayList<>();
public void addName(String name) {
List<String> copyOfNames;
synchronized (this) {
copyOfNames = names; // OK: access of 'names' guarded by 'this'
}
copyOfNames.add(name); // should be an error: this access is not thread-safe!
}
}
```
The analysis does not track aliasing, so it's possible to circumvent the safety
it provides by copying references to guarded members.
In the example, the guarded field 'names' can be accessed via a copy even if the
required lock is not held.
|