Page History

Reading a shared primitive variable in one thread may not yield the value of the most recent write to the variable from another thread. Consequently, the thread may observe a stale value of the shared variable. To ensure the visibility of the most recent update, either the variable must be declared volatile or the reads and writes must be synchronized.

Declaring a shared variable volatile guarantees visibility in a thread-safe manner only when both of the following conditions are met:

• A write to a variable is independent from its current value.
• A write to a variable is independent from the result of any nonatomic compound operations involving reads and writes of other variables (see VNA02-J. Ensure that compound operations on shared variables are atomic for more information).

The first condition can be relaxed when you can be sure that only one thread will ever update the value of the variable [Goetz 2006]. However, code that relies on a single-thread confinement is error prone and difficult to maintain. This design approach is permitted under this rule but is discouraged.

Synchronizing the code makes it easier to reason about its behavior and is frequently more secure than simply using the volatile keyword. However, synchronization has somewhat higher performance overhead and can result in thread contention and deadlocks when used excessively.

Declaring a variable volatile or correctly synchronizing the code guarantees that 64-bit primitive long and double variables are accessed atomically. For more information on sharing those variables among multiple threads, see VNA05-J. Ensure atomicity when reading and writing 64-bit values.

Noncompliant Code Example (Non-volatile Flag)

This noncompliant code example uses a shutdown() method to set the nonvolatile done flag that is checked in the run() method:

final class ControlledStop implements Runnable {
  private boolean done = false;
 
  @Override public void run() {
    while (!done) {
      try {
        // ...
        Thread.currentThread().sleep(1000); // Do something
      } catch(InterruptedException ie) { 
        Thread.currentThread().interrupt(); // Reset interrupted status
      } 
    } 	 
  }

  public void shutdown() {
    done = true;
  }
}

Memory that can be shared between threads is called _shared memory_ or _heap memory_. The term _variable_ is used in the context of this guideline, to refer to both fields and array elements \[[JLS 05|AA. Java References#JLS 05]\].

All instance fields, static fields, and array elements are stored in heap memory. Local variables, formal method parameters, or exception handler parameters are never shared between threads and are not affected by the memory model.

The Java Language Specification defines the Java Memory Model (JMM) which describes possible behaviors of a multi-threaded Java program. Concurrent executions are typically interleaved but the situation is complicated by statements that may be reordered by the compiler or runtime system. This results in execution orders that are not immediately obvious from an examination of the source-code.

There are two requirements for implementing synchronization correctly:

1. Happens-before consistency: If two accesses follow the happens-before relationship, data races cannot occur. However, this is necessary but not sufficient for acceptable program behavior. In addition, often the particular execution order of a program must be sequential consistent.

Consider the following example in which a and b are (shared) global variables or instance fields but r1 and r2 are local variables not accessible by other threads.

Initially, let a = 0 and b = 0.

Because, in Thread 1, the two assignments a = 10; and r1 = b; are not related, the compiler or runtime system is free to reorder them. Similarly in Thread 2, the statements may be freely reordered. Although it may seem counter-intuitive, the Java memory model allows a read to see a write that occurs later in the execution order.

Two possible execution orders and actual assignments are:

In this ordering, r1 and r2 read the original values of the variables a and b even though they are expected to see the updated values.

In this ordering, r1 and r2 read the values of a and b written from step 3 and 4, before the steps are executed.

"The fact that we allow a read to see a write that comes later in the execution order can sometimes thus result in unacceptable behaviors." \[[JLS 05|AA. Java References#JLS 05]\].

Program order is the execution order that is expected when a single thread is running the statements sequentially, as written in a method. Even if statements execute in the expected order (program order), caching can prevent the latest values from being reflected in the main memory.

2. Sequential consistency: This property provides a very strong guarantee that the compiler will not optimize away or reorder any statements. It guarantees that the program is free from data races. It also ensures that each access of a variable is atomic and immediately visible to other threads.

For example, consider some statements that are being executed by multiple threads:

If statements 1, 2 and 3 are always executed sequentially by all threads as given in this program order, they are sequentially consistent with respect to each other. The sequential consistency property also requires that a read operation in some thread does not see the value of a future write operation taking place in the same or another thread. Similarly, a read operation is guaranteed to see the value of the last write to the variable from any thread.

The use of sequential consistency as the sole memory model mechanism makes it easy for a programmer to reason with the program's logic in a multithreading scenario, however, introduces a performance penalty because the compiler is prohibited from reordering code for performing complex optimizations. Using volatile variables reduces this performance penalty at the cost of strong sequential consistency guarantees.

Consider two threads that are executing some statements:

Image Removed

Thread 1 and Thread 2 have a happens-before relationship such that Thread 2 does not start before Thread 1 finishes. This is established by the semantics of volatile accesses. Sequential consistency of volatile accesses provides certain visibility and reordering guarantees:

Visibility

A write to a volatile field happens-before every subsequent read of that field. Statements that occur before the write to the volatile field also happen-before the read of the volatile field.

In the previous example, Statement 3 writes to a volatile variable and statement 4 in the second thread, reads the same volatile variable. The read sees the most recent write (to the same variable v) from statement 3. This may not be true in the happens-before order because a future read can always see the default or previous value of v instead of the one set in the most recent write. This guarantee is provided by the sequential consistency property of volatile accesses.

Reordering

Volatile read and write operations cannot be reordered with respect to each other and in addition, as required by the JMM, volatile read and write operations are also not reordered with respect to operations on non-volatile variables. When reading the volatile variable, the other thread will also see statements occurring before the write to the volatile variable, to have already executed with prior occurrences of volatile and non-volatile fields assuming the assigned values.

In the previous example, statement 4 also sees the statements 1 and 2 to have executed and all their operands with the most-up to date values. However, this does not mean that statements 1 and 2 are sequentially consistent with respect to each other. They may be freely reordered by the compiler. In fact, if statement 1 constituted a read of some variable x, it could see the value of a future write to x in statement 2.

Because the guarantees of code present before the volatile write are weaker than sequentially consistent code, volatile as a synchronization primitive, performs better.

"Finally, note that the actual execution order of instructions and memory accesses can be in any order as long as the actions of the thread appear to that thread as if program order were followed, and provided all values read are allowed for by the memory model. This allows the programmer to fully understand the semantics of the programs they write, and it allows compiler writers and virtual machine implementors to perform complex optimizations that a simpler memory model would not permit." \[[JPL 06|AA. Java References#JPL 06]\]. 

Noncompliant Code Example

This noncompliant code example uses a shutdown() method to set a non-volatile done flag that is checked in the run() method. If one thread invokes the shutdown() method to set the flag, it is possible that another a second thread might not observe this that change. Consequently, the second thread may still might observe that done is still false and incorrectly invoke the sleep() method. Compilers and just-in-time compilers (JITs) are allowed to optimize the code when they determine that the value of done is never modified by the same thread, resulting in an infinite loop.

Compliant Solution (Volatile)

In this compliant solution, the done flag is declared volatile to ensure that writes are visible to other threads:

final class ControlledStop implements Runnable {
  private volatile boolean done = false;
 
  @Override public void run() {
    while (!done) {
      try {
        // ...
        Thread.currentThread().sleep(1000); // Do something
      } catch(InterruptedException ie) { 
        Thread.currentThread().interrupt(); // handleReset interrupted exceptionstatus
      } 
    } 	 
  }

  protectedpublic void shutdown() {
    done = true;
  }
}

Compliant Solution (AtomicBoolean)

This In this compliant solution qualifies , the done flag as volatile so that updates by one thread are immediately visible to another threadis declared to be of type java.util.concurrent.atomic.AtomicBoolean. Atomic types also guarantee that writes are visible to other threads.

final class ControlledStop implements Runnable {
  private volatilefinal booleanAtomicBoolean done = false;
  // ...
}

Noncompliant Code Example

This noncompliant code example declares a non-volatile int variable that is initialized in the constructor depending on a security check. In a multi-threading scenario, it is possible that the statements will be reordered so that the boolean flag initialized is set to true before the initialization has concluded. If it is possible to obtain a partially initialized instance of the class in a subclass using a finalizer attack (OBJ04-J. Do not allow partially initialized objects to be accessed), a race condition can be exploited by invoking the getBalance() method to obtain the balance even though initialization is still underway.

class BankOperation {
  private int balance = 0;
  private boolean initialized = false;
 
  public BankOperationnew AtomicBoolean(false);
 
  @Override public void run() {
    ifwhile (!performAccountVerificationdone.get()) {
      try {
 throw new SecurityException("Invalid Account"); 
   // }...
      balance = 1000 Thread.currentThread().sleep(1000); // Do something
    initialized = true; 
  }
 } catch(InterruptedException ie) { 
  private int getBalance() {
    if (initialized == true) {Thread.currentThread().interrupt(); // Reset interrupted status
      return} balance;
    }
 	 
  else {}

  public void   return -1;shutdown() {
    }done.set(true);
  }
}

Compliant Solution (synchronized)

This compliant solution declares the initialized flag as volatile uses the intrinsic lock of the Class object to ensure that the initialization statements are not reordered. updates are visible to other threads:

class BankOperationfinal class ControlledStop implements Runnable {
  private intboolean balancedone = 0false;
 
 private volatile@Override booleanpublic initializedvoid = false; // Declared volatile
  // ...
}

The use of the volatile keyword is inappropriate for composite operations on shared variables (CON01-J. Design APIs that ensure atomicity of composite operations and visibility of results).

Noncompliant Code Example

This noncompliant code example consists of two classes, an immutable ImmutablePoint class and a mutable Holder class. Holder is mutable because a new ImmutablePoint instance can be assigned to it using the setPoint() method. If one thread updates the value of the ipoint field, another thread may still see the reference of the old value.

class Holder {
  ImmutablePoint ipoint;
  
  Holder(ImmutablePoint ip)run() {
    while (!isDone()) {
      try {
   ipoint = ip;
  }
 // ...
  void getPoint() {
    return ipointThread.currentThread().sleep(1000);
 // }

  void setPoint(ImmutablePoint ip) {Do something
    this.ipoint = ip;
  }
}

public class ImmutablePoint catch(InterruptedException ie) { 
  final int x = 20;
  final int y = 10;
}

Compliant Solution

This compliant solution declares the ipoint field as volatile so that updates are immediately visible to other threads.

class Holder {
  volatile ImmutablePoint ipoint;
  
  Holder(ImmutablePoint ip) {
    ipoint = ip;
  }
  
  void getPointThread.currentThread().interrupt(); // Reset interrupted status
      } 
    } 	 
  }

  public synchronized boolean isDone() {
    return ipoint()done;
  }

  public synchronized void setPointshutdown(ImmutablePoint ip) {
    this.ipointdone = iptrue;
  }
}

Note that no synchronization is necessary for the setPoint() method because it operates atomically on immutable data, that is, on an instance of ImmutablePoint.

Declaring immutable fields as volatile enables their safe publication, in that, once published, it is impossible to change the state of the sub-object.

Noncompliant Code Example

Thread-safe objects (which may not be strictly immutable) must declare their nonfinal fields as volatile to ensure that no thread sees any field references before the sub-objects' initialization has concluded. This noncompliant code example does not declare the map field as volatile.

public class Container<K,V> {
  Map<K,V> map;

  public Container() {
    map = new HashMap<K,V>();	
    // Put values in HashMap
  }

  public V get(Object k) {
    return map.get(k);
  }
}

Compliant Solution

This compliant solution declares the map field as volatile to ensure other threads see an up-to-date HashMap reference and object state.

public class Container<K,V> {
  volatile Map<K,V> map;
  // ...
}

Risk Assessment

Although this compliant solution is acceptable, intrinsic locks cause threads to block and may introduce contention. On the other hand, volatile-qualified shared variables do not block. Excessive synchronization can also make the program prone to deadlock.

Synchronization is a more secure alternative in situations where the volatile keyword or a java.util.concurrent.atomic.Atomic* field is inappropriate, such as when a variable's new value depends on its current value (see VNA02-J. Ensure that compound operations on shared variables are atomic for more information).

Compliance with LCK00-J. Use private final lock objects to synchronize classes that may interact with untrusted code can reduce the likelihood of misuse by ensuring that untrusted callers cannot access the lock object.

Exceptions

VNA00-J-EX0: Class objects are created by the virtual machine; their initialization always precedes any subsequent use. Consequently, cross-thread visibility of Class objects is already assured by default.

Risk Assessment

Failing to ensure the visibility of a shared primitive variable may result in a thread observing a stale value of the variableFailing to use volatile to guarantee visibility of shared values across multiple thread and prevent reordering of statements can result in unpredictable control flow.

Automated Detection

TODO

Related Vulnerabilities

Search for vulnerabilities resulting from the violation Some static analysis tools are capable of detecting violations of this rule on the CERT website.

References

\[[JLS 05|AA. Java References#JLS 05]\] [Chapter 17, Threads and Locks|http://java.sun.com/docs/books/jls/third_edition/html/memory.html], section 17.4.5 Happens-before Order, section 17.4.3 Programs and Program Order, section 17.4.8 Executions and Causality Requirements
\[[Tutorials 08|AA. Java References#Tutorials 08]\] [Java Concurrency Tutorial|http://java.sun.com/docs/books/tutorial/essential/concurrency/index.html]
\[[Lea 00|AA. Java References#Lea 00]\] Sections, 2.2.7 The Java Memory Model, 2.2.5 Deadlock, 2.1.1.1 Objects and locks
\[[Bloch 08|AA. Java References#Bloch 08]\] Item 66: Synchronize access to shared mutable data
\[[Goetz 06|AA. Java References#Goetz 06]\] 3.4.2. "Example: Using Volatile to Publish Immutable Objects"
\[[JPL 06|AA. Java References#JPL 06]\] 14.10.3. "The Happens-Before Relationship"
\[[MITRE 09|AA. Java References#MITRE 09]\] [CWE ID 667|http://cwe.mitre.org/data/definitions/667.html] "Insufficient Locking", [CWE ID 413|http://cwe.mitre.org/data/definitions/413.html] "Insufficient Resource Locking", [CWE ID 366|http://cwe.mitre.org/data/definitions/366.html]  "Race Condition within a Thread", [CWE ID 567|http://cwe.mitre.org/data/definitions/567.html]  "Unsynchronized Access to Shared Data"

.

Related Guidelines

Bibliography

...

Image Added Image Added Image Added11. Concurrency (CON)      11. Concurrency (CON)      CON02-J. Always synchronize on the appropriate object