The Java language annotation facility is useful for documenting design intent. Source code annotation is a mechanism for associating metadata with a program element and making it available to the compiler, analyzers, debuggers, or the JVM for examination. Several annotations are available for documenting thread-safety or the lack thereof.
h2. Obtaining Concurrency Annotations
Two sets of concurrency annotations are freely available and licensed for use in any code. The first set consists of four annotations described in _Java Concurrency in Practice_ (JCIP) \[java:[Goetz 2006|AA. Bibliography#Goetz 06]\], which can be downloaded from [jcip.net|http://www.jcip.net] ([jar|http://jcip.net/jcip-annotations.jar], [javadoc|http://jcip.net/annotations/doc/index.html], [source|http://jcip.net/jcip-annotations-src.jar]). The JCIP annotations are released under the [Creative Commons Attribution License|http://creativecommons.org/licenses/by/2.5].
The second, larger set of concurrency annotations is available from and supported by [SureLogic|http://www.surelogic.com]. These annotations are released under [The Apache Software License, Version 2.0|http://www.apache.org/licenses/LICENSE-2.0] and can be downloaded at [surelogic.com|http://surelogic.com/promises/index.html] ([jar|http://surelogic.com/promises/jars/], [javadoc|http://surelogic.com/promises/apidocs/index.html], [source|http://surelogic.com/promises/source-repository.html]). They can be verified by the [SureLogic|http://www.surelogic.com] [JSure|http://www.surelogic.com/concurrency-tools.html] tool and remain useful for documenting code, even when the tool is unavailable. These annotations include the JCIP annotations because they are supported by the JSure tool. (JSure also supports use of the JCIP JAR file.)
To use the annotations, download and add one or both of the aforementioned JAR files to the code's build path. The use of these annotations to document thread-safety is described in the following sections.
h2. Documenting Intended Thread-safety
JCIP provides three class-level annotations to describe the programmer's design intent with respect to thread-safety.
The [@ThreadSafe|http://surelogic.com/promises/apidocs/com/surelogic/ThreadSafe.html] annotation is applied to a class to indicate that it is [thread-safe|java:BB. Definitions#threadGlossary#thread-safe]. This means that no sequences of accesses (reads and writes to public fields, calls to public methods) can leave the object in an inconsistent state, regardless of the interleaving of these accesses by the runtime or any external synchronization or coordination on the part of the caller.
For example, the {{Aircraft}} class shown below specifies that it is thread-safe as part of its locking policy documentation. This class protects the {{x}} and {{y}} fields using a reentrant lock.
{code:bgColor=#ccccff}
@ThreadSafe
@Region("private AircraftState")
@RegionLock("StateLock is stateLock protects AircraftState")
public final class Aircraft {
private final Lock stateLock = new ReentrantLock();
// ...
@InRegion("AircraftState")
private long x, y;
// ...
public void setPosition(long x, long y) {
stateLock.lock();
try {
this.x = x;
this.y = y;
} finally {
stateLock.unlock();
}
}
// ...
}
{code}
The [@Region|http://surelogic.com/promises/apidocs/com/surelogic/Region.html] and [@RegionLock|http://surelogic.com/promises/apidocs/com/surelogic/RegionLock.html] annotations document the locking policy that the promise of thread-safety is predicated upon.
Even when one or more [@RegionLock|http://surelogic.com/promises/apidocs/com/surelogic/RegionLock.html] or [@GuardedBy|http://jcip.net/annotations/doc/net/jcip/annotations/GuardedBy.html] annotations have been used to document the locking policy of a class, the [@ThreadSafe|http://surelogic.com/promises/apidocs/com/surelogic/ThreadSafe.html] annotation provides an intuitive way for reviewers to learn that the class is thread-safe.
The [@Immutable|http://surelogic.com/promises/apidocs/com/surelogic/Immutable.html] annotation is applied to [immutable|java:BB. Definitions#immutableGlossary#immutable] classes. Immutable objects are inherently thread-safe; after they are fully constructed, they may be published via a volatile reference and shared safely among multiple threads.
The following example shows an immutable {{Point}} class:
{code:bgColor=#ccccff}
@Immutable
public final class Point {
private final int f_x;
private final int f_y;
public Point(int x, int y) {
f_x = x;
f_y = y;
}
public int getX() {
return f_x;
}
public int getY() {
return f_y;
}
}
{code}
According to Bloch \[java:[Bloch 2008|AA. Bibliography#Bloch 08]\]
{quote}
It is not necessary to document the immutability of {{enum}} types. Unless it is obvious from the return type, static factories must document the thread safety of the returned object, as demonstrated by {{Collections.synchronizedMap}}.
{quote}
The [@NotThreadSafe|http://surelogic.com/promises/apidocs/com/surelogic/NotThreadSafe.html] annotation is applied to classes that are not thread-safe. Many classes fail to document whether they are safe for multithreaded use or not. Consequently, a programmer has no easy way to determine whether the class is thread-safe. This annotation provides clear indication of the class's lack of thread-safety.
For example, most of the collection implementations provided in {{java.util}} are not thread-safe. The class {{java.util.ArrayList}} could document this as follows:
{code:bgColor=#ccccff}
package java.util.ArrayList;
@NotThreadSafe
public class ArrayList<E> extends ... {
// ...
}
{code}
h2. Documenting Locking Policies
It is important to document all the locks that are being used to protect shared state. According to Goetz and colleagues \[java:[Goetz 2006, pg 28|AA. Bibliography#Goetz 06]\]
{quote}
For each mutable state variable that may be accessed by more than one thread, _all_ accesses to that variable must be performed with the _same_ lock held. In this case, we say that the variable is _guarded by_ that lock.
{quote}
JCIP provides the [@GuardedBy|http://jcip.net/annotations/doc/net/jcip/annotations/GuardedBy.html] annotation for this purpose, while SureLogic provides the [@RegionLock|http://surelogic.com/promises/apidocs/com/surelogic/RegionLock.html] annotation. The field or method to which the [@GuardedBy|http://jcip.net/annotations/doc/net/jcip/annotations/GuardedBy.html] annotation is applied can only be accessed when holding a particular lock. This may be an intrinsic lock or a dynamic lock such as {{java.util.concurrent.Lock}}.
For example, the following {{MovablePoint}} class implements a movable point that has the capability of remembering its past locations using the {{memo}} array list.
{code:bgColor=#ccccff}
@ThreadSafe
public final class MovablePoint {
@GuardedBy("this")
double xPos = 1.0;
@GuardedBy("this")
double yPos = 1.0;
@GuardedBy("itself")
static final List<MovablePoint> memo = new ArrayList<MovablePoint>();
public void move(double slope, double distance) {
synchronized (this) {
rememberPoint(this);
xPos += (1 / slope) * distance;
yPos += slope * distance;
}
}
public static void rememberPoint(MovablePoint value) {
synchronized (memo) {
memo.add(value);
}
}
}
{code}
The [@GuardedBy|http://jcip.net/annotations/doc/net/jcip/annotations/GuardedBy.html] annotations on the {{xPos}} and {{yPos}} fields indicate that access to these fields is protected by holding a lock on {{this}} (also done in the {{move()}} method, which modifies these fields). The [@GuardedBy|http://jcip.net/annotations/doc/net/jcip/annotations/GuardedBy.html] annotation on the {{memo}} list indicates that a lock on the {{ArrayList}} object protects its contents (also done in the {{rememberPoint()}} method).
One issue with the [@GuardedBy|http://jcip.net/annotations/doc/net/jcip/annotations/GuardedBy.html] annotation is that it fails to indicate that there is a relationship between the fields of a class. This limitation can be overcome by using the SureLogic [@RegionLock|http://surelogic.com/promises/apidocs/com/surelogic/RegionLock.html] annotation, which declares a new region lock for the class to which this annotation is applied. This declaration creates a new named lock that associates a particular lock object with a region of the class. The region may be accessed only when the lock is held.
For example, the {{SimpleLock}} locking policy indicates that synchronizing on the instance protects all of its state:
{code:bgColor=#ccccff}
@RegionLock("SimpleLock is this protects Instance")
class Simple { ... }
{code}
Unlike [@GuardedBy|http://jcip.net/annotations/doc/net/jcip/annotations/GuardedBy.html], the [@RegionLock|http://surelogic.com/promises/apidocs/com/surelogic/RegionLock.html] annotation allows the programmer to give an explicit, and hopefully meaningful, name to the locking policy.
In addition to naming the locking policy, the [@Region|http://surelogic.com/promises/apidocs/com/surelogic/Region.html] annotation allows a name to be given to the region of the state that is being protected. That name makes it clear that the state and locking policy belong together, as demonstrated in the following example:
{code:bgColor=#ccccff}
@Region("private AircraftPosition")
@RegionLock("StateLock is stateLock protects AircraftPosition")
public final class Aircraft {
private final Lock stateLock = new ReentrantLock();
@InRegion("AircraftPosition")
private long x, y;
@InRegion("AircraftPosition")
private long altitude;
// ...
public void setPosition(long x, long y) {
stateLock.lock();
try {
this.x = x;
this.y = y;
} finally {
stateLock.unlock();
}
}
// ...
}
{code}
In this example, a locking policy named {{StateLock}} is used to indicate that locking on {{stateLock}} protects the named {{AircraftPosition}} region, which includes the mutable state used to represent the position of the aircraft.
h4. Construction of Mutable Objects
Typically, object construction is considered an exception to the locking policy because objects are thread-confined when they are created. An object is confined to the thread that uses the {{new}} operator to create its instance. After creation, the object can be published to other threads safely. However, the object is not shared until the thread that created the instance allows it to be shared. Safe publication approaches discussed in rule [java:TSM01-J. Do not let the this reference escape during object construction] can be expressed succinctly with the [@Unique("return")|http://surelogic.com/promises/apidocs/com/surelogic/Unique.html] annotation.
For example, in the code shown below, the [@Unique("return")|http://surelogic.com/promises/apidocs/com/surelogic/Unique.html] annotation documents that the object returned from the constructor is a unique reference. {mc} This looks suspicious...constructor returning objects? {mc}
{code:bgColor=#ccccff}
@RegionLock("Lock is this protects Instance")
public final class Example {
private int x = 1;
private int y;
@Unique("return")
public Example(int y) {
this.y = y;
}
// ...
}
{code}
h2. Documenting Thread-Confinement Policies
Sutherland and Scherlis propose annotations that can document thread-confinement policies. Their approach allows verification of the annotations against as-written code \[java:[Sutherland 2010|AA. Bibliography#Sutherland 10]\] .
For example, the following annotations express the design intent that a program has, at most, one AWT event dispatch thread and several Compute threads, and that the Compute threads are forbidden to handle AWT data structures or events:
{code:bgColor=#ccccff}
@ThreadRole AWT, Compute
@IncompatibleThreadRoles AWT, Compute
@MaxRoleCount AWT 1
{code}
h2. Documenting Wait-Notify Protocols
According to Goetz and colleagues \[java:[Goetz 2006, pg 395|AA. Bibliography#Goetz 06]\]
{quote}
A state-dependent class should either fully expose (and document) its waiting and notification protocols to subclasses, or prevent subclasses from participating in them at all. (This is an extension of "design and document for inheritance, or else prohibit it" \[java:EJ Item 15\].) At the very least, designing a state-dependent class for inheritance requires exposing the condition queues and locks and documenting the condition predicates and synchronization policy; it may also require exposing the underlying state variables. (The worst thing a state-dependent class can do is expose its state to subclasses but not document its protocols for waiting and notification; this is like a class exposing its state variables but not documenting its invariants.).
{quote}
Wait-notify protocols should be documented adequately. Currently, we are not aware of any annotations for this purpose.
h2. Risk Assessment
Annotating concurrent code documents design intent and can be used to automate the detection and prevention of race conditions and data races.
|| Rule || Severity || Likelihood || Remediation Cost || Priority || Level ||
| TSM04-J | low | probable | medium | {color:green}{*}P4{*}{color} | {color:green}{*}L3{*}{color} |
h3. Related Vulnerabilities
Search for vulnerabilities resulting from the violation of this rule on the [CERT website|https://www.kb.cert.org/vulnotes/bymetric?searchview&query=FIELD+KEYWORDS+contains+CON33-J].
h2. Bibliography
| \[java:[Bloch 2008|AA. Bibliography#Bloch 08]\] | Item 70: "Document thread safety" |
| \[java:[Goetz 2006|AA. Bibliography#Goetz 06]\] | |
| \[java:[Sutherland 2010|AA. Bibliography#Sutherland 10]\] | |
----
[!The CERT Oracle Secure Coding Standard for Java^button_arrow_left.png!|java:TSM03-J. Do not publish partially initialized objects] [!The CERT Oracle Secure Coding Standard for Java^button_arrow_up.png!|java:11. Thread-Safety Miscellaneous (TSM)] [!The CERT Oracle Secure Coding Standard for Java^button_arrow_right.png!|java:12. Input Output (FIO)]
|
