Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The Java Language Specification (JLS) allows 64-bit long and double values to be treated as two 32-bit values. For example, a 64-bit write operation could be performed as two separate , 32-bit operations.unmigrated-wiki-markup

According to the _Java Language Specification_ \[[ JLS 2005|AA. Bibliography#JLS 05]\], Section 17, §17.7 , "Non-Atomic Treatment of {{double}} and {{long}}" [JLS 2015]:

... this behavior is implementation specific; Java virtual machines are free to perform writes to long and double values atomically or in two parts. For the purposes of the Java programming language memory model, a single write to a non-volatile long or double value is treated as two separate writes: one to each 32-bit half. This can result in a situation where a thread sees the first 32 bits of a 64-bit value from one write, and the second 32 bits from another write.

...

Some implementations may find it convenient to divide a single write action on a 64-bit long or double value into two write actions on adjacent 32-bit values. For efficiency's sake, this behavior is implementation-specific; an implementation of the Java Virtual Machine is free to perform writes to long and double values atomically or in two parts.

This behavior can result in indeterminate values being read in code that is required to be thread-safe. Consequently, multi-threaded multithreaded programs must ensure atomicity when reading or writing 64-bit values.

...

In this noncompliant code example, if one thread repeatedly calls the assignValue() method and another thread repeatedly calls the printLong() method, the printLong() method could occasionally print a value of i that is neither zero nor the value of the j argument.:

Code Block
bgColor#FFcccc

class LongContainer {
  private long i = 0;

  void assignValue(long j) {
    i = j;
  }

  void printLong() {
    System.out.println("i = " + i);
  }
}

A similar problem can occur when i is declared double.

Compliant Solution (Volatile)

This compliant solution declares i volatile. Writes and reads of long and double volatile values are always atomic.

Code Block
bgColor#ccccff

class LongContainer {
  private volatile long i = 0;

  void assignValue(long j) {
    i = j;
  }

  void printLong() {
    System.out.println("i = " + i);
  }
}

It is important to ensure that the argument to the assignValue() method is obtained from a volatile variable or obtained as a the result of explicitly passing an integer valueatomic read. Otherwise, a read of the variable argument can itself expose a vulnerability.

The semantics of volatile explicitly exclude any guarantee of the atomicity of compound operations that involve read-modify-write sequences such as incrementing a value . See rule (see VNA02-J. Ensure that compound operations on shared variables are atomic for more information).

Exceptions

VNA05-J-EX0: If all reads and writes of 64-bit long and double values occur within a synchronized region, the atomicity of the read/write is guaranteed. This requires both that the value is exposed only through synchronized methods in the class , and also that the value is inaccessible from other code (whether directly or indirectly). For more information, see rule VNA02-J. Ensure that compound operations on shared variables are atomic.)

VNA05-J-EX1: This rule can be ignored for platforms that guarantee that 64-bit , long and double values are read and written as atomic operations. Note, however, that such guarantees fail to be are not portable across different platforms.

...

Failure to ensure the atomicity of operations involving 64-bit values in multithreaded applications can result in reading and writing indeterminate values. Many JVMs However, many Java Virtual Machines read and write 64-bit values atomically , even though the specification does not require them to.

Rule

Severity

Likelihood

Remediation Cost

Priority

Level

VNA05-J

low Low

unlikely Unlikely

medium Medium

P2

L3

Automated Detection

...

Some static analysis tools are capable of detecting violations of this rule.

ToolVersionCheckerDescription
ThreadSafe
Include Page
ThreadSafe_V
ThreadSafe_V

CCE_SL_INCONSISTENT
CCE_CC_CALLBACK_ACCESS
CCE_SL_MIXED
CCE_SL_INCONSISTENT_COL
CCE_SL_MIXED_COL
CCE_CC_UNSAFE_CONTENT
CCE_FF_VOLATILE

Implemented

Related Guidelines

MITRE CWE

CWE-667, " Improper Locking"

Bibliography

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="916cf9c0-5f68-4ca1-9ee7-7c52d2ac2da5"><ac:plain-text-body><![CDATA[ [[Goetz 2006AA. Bibliography#Goetz 06]]

Section 3.1.2. , "Non-Atomic atomic 64-Bit Operations

]]></ac:plain-text-body></ac:structured-macro>

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="99c0829d-3519-4a8c-bbe3-fd96ef301a07"><ac:plain-text-body><![CDATA[

[[Goetz 2004cAA. Bibliography#Goetz 04c]]

 ]]></ac:plain-text-body></ac:structured-macro><ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="c48be955-4070-4811-9ddc-5cd945de0b94"><ac:plain-text-body><![CDATA

[

[[JLS 2005

AA. Bibliography#JLS 05]]

JLS 2015]

"Non-Atomic 17.7 Non-atomic Treatment of double and long

]]></ac:plain-text-body></ac:structured-macro>

" 

 

...

Image Added Image Added Image AddedImage Removed      07. Visibility and Atomicity (VNA)      08. Locking (LCK)