Page History

The usual way of initializing an object is to use a constructor. Sometimes it is required to limit the number of instances of the sub-object to just one (this is similar to a singleton, however, the sub-object may or may not be static). In addition, a technique called lazy initialization is used to defer the construction of the sub-object until it is actually required. double-checked locking idiom is a software design pattern used to reduce the overhead of acquiring a lock by first testing the locking criterion without actually acquiring the lock. Double-checked locking improves performance by limiting synchronization to the rare case of computing the field's value or constructing a new instance for the field to reference and by foregoing synchronization during the common case of retrieving an already-created instance or value.

Incorrect forms of the double-checked locking idiom include those that allow publication of an uninitialized or partially initialized object. Consequently, only those forms of the double-checked locking idiom that correctly establish a happens-before relationship both for the helper reference and for the complete construction of the Helper instance are permitted.

The double-checked locking idiom is frequently used to implement a singleton factory pattern that performs lazy initialization. Lazy initialization defers the construction of a member field or an object referred to by a member field until an instance is actually required rather than computing the field value or constructing the referenced object in the class's constructor. Lazy initialization helps to break harmful circularities in class and instance initialization. It also enables other optimizations [Bloch 2005].

Lazy initialization uses either a class or an instance method, depending on whether the member object is staticFor these purposes, instead of a constructor, a class or an instance method should be used for initialization, depending on whether the sub-object is static or not. The method checks whether the instance has already been created and, if not, creates it. If When the instance already exists, it the method simply returns it. This is shown belowthe instance:

// Correct single threaded version using lazy initialization
final class Foo { 
  private Helper helper = null;
  
  public Helper getHelper() {
    if (helper == null) {
      helper = new Helper();
    }
    return helper;
  }
  // ...
}

In a multi-threading scenario, the Lazy initialization must be synchronized so that two or more threads do not create multiple in multithreaded applications to prevent multiple threads from creating extraneous instances of the sub-object. The code shown below is correctly synchronized, albeit slower than the previous, single threaded code example. member object:

// Correct multithreaded version using synchronization
final class Foo { 
  private Helper helper = null;
  
  public synchronized Helper getHelper() {
    if (helper == null) {
      helper = new Helper();
    }
    return helper;
  }
  // Other functions and members...
}

...

Noncompliant Code Example

The double-checked locking pattern eliminates uses block synchronization rather than method synchronization and uses block synchronization. It strives to make the previous code example faster by installing a null installs an additional null reference check before attempting to synchronize. This makes expensive synchronization dispensable for the common case of retrieving the value. The noncompliant code example shows the originally proposed DCL pattern.

According to the Java Memory Model (discussion reference) \[[Pugh 04|AA. Java References#Pugh 04]\]:

... writes that initialize the Helper object and the write to the helper field can be done or perceived out of order. As a result, a thread which invokes getHelper() could see a non-null reference to a helper object, but see the default values for fields of the helper object, rather than the values set in the constructor.

Even if the compiler does not reorder those writes, on a multiprocessor the processor or the memory system may reorder those writes, as perceived by a thread running on another processor.

This makes the originally proposed double-checked locking pattern insecure.

The rule CON26-J. Do not publish partially-constructed objects discusses further the possibility of a non-null reference to a helper object with default values for fields in the helper object.

Noncompliant Code Example

This noncompliant code example uses the an incorrect form of the double-checked locking idiom. :

// "Double-Checkedchecked Locking"locking idiom
final class Foo { 
  private Helper helper = null;
  public Helper getHelper() {
    if (helper == null) { 
      synchronized (this) {
        if (helper == null) {
          helper = new Helper();
        }
      }    
    }
    return helper;
  }

  // otherOther functionsmethods and members...
}

According to Pugh [Pugh 2004],

Writes that initialize the Helper object and the write to the helper field can be done or perceived out of order. As a result, a thread which invokes getHelper() could see a non-null reference to a helper object, but see the default values for fields of the helper object, rather than the values set in the constructor.

Even if the compiler does not reorder those writes, on a multiprocessor, the processor or the memory system may reorder those writes, as perceived by a thread running on another processor.

This code also violates TSM03-J. Do not publish partially initialized objects.

Compliant Solution (

...

Volatile)

This compliant solution declares the Helper object as volatile and consequently uses the correct form double-check locking idiom. helper field volatile:

// Works with acquire/release semantics for volatile
// Broken under JDK 1.4 and earlier
final class Foo {
  private volatile Helper helper = null;
  
  public Helper getHelper() { 
    if (helper == null) {
      synchronized (this) {
        if (helper == null) {
          helper = new Helper();
 // If the helper is null, create a}
 new instance
    }
    }
    return helper;
  }
}

When a thread initializes the Helper object, a happens-before relationship is established between this thread and any other thread that retrieves and returns the instance [Pugh 2004], [Manson 2004].

Compliant Solution (Static Initialization)

This compliant solution initializes the helper field in the declaration of the static variable [Manson 2006].

final class Foo  }{
  private static returnfinal Helper helper = new Helper(); // If helper is non-null, return its instance

  public static Helper getHelper() {
    return helper;
  }
}

JDK 5.0 allows a write of a {{volatile}} variable to be reordered with respect to a previous read or write. A read of a {{volatile}} variable cannot be reordered with respect to any following read or write. Because of this, the double checked locking idiom can work when {{helper}} is declared {{volatile}}. If a thread initializes the {{Helper}} object, a happens-before relationship is established between this thread and another that retrieves and returns the instance. \[[Pugh 04|AA. Java References#Pugh 04]\] and \[[Manson 04|AA. Java References#Manson 04]\] 

"Today, the double-check idiom is the technique of choice for lazily initializing an instance field. While you can apply the double-check idiom to {{static}} fields as well, there is no reason to do so: the lazy initialization holder class idiom is a better choice." \[[Bloch 08|AA. Java References#Bloch 08]\].  

Compliant Solution (immutable)

In this solution the Foo class is unchanged, but the Helper class is immutable. In this case, the Helper class is guaranteed to be fully constructed before becoming visible. The object must be truly immutable; it is not sufficient for the program to refrain from modifying the object.

Variables that are declared static and initialized at declaration or from a static initializer are guaranteed to be fully constructed before being made visible to other threads. However, this solution forgoes the benefits of lazy initialization.

Compliant Solution (Initialize-on-Demand, Holder Class Idiom)

This compliant solution uses the initialize-on-demand, holder class idiom that implicitly incorporates lazy initialization by declaring a static variable within a static Holder inner class:

final class Foo {
  // Lazy initialization
  private static class Holder {
    static Helper helper = new Helper();
  }

  public static Helper getInstance() {
    return Holder.helper;
  }
}

Initialization of the static helper field is deferred until the getInstance() method is called. The necessary happens-before relationships are created by the combination of the class loader's actions loading and initializing the Holder instance and the guarantees provided by the Java memory model (JMM). This idiom is a better choice than the double-checked locking idiom for lazily initializing static fields [Bloch 2008]. However, this idiom cannot be used to lazily initialize instance fields [Bloch 2001].

Compliant Solution (ThreadLocal Storage)

This compliant solution (originally suggested by Alexander Terekhov [Pugh 2004]) uses a ThreadLocal object to track whether each individual thread has participated in the synchronization that creates the needed happens-before relationships. Each thread stores a non-null value into its thread-local perThreadInstance only inside the synchronized createHelper() method; consequently, any thread that sees a null value must establish the necessary happens-before relationships by invoking createHelper().

final class Foo {
  private final ThreadLocal<Foo> perThreadInstance = 
      new ThreadLocal<Foo>();
  private Helper helper = null;

  public Helper getHelper() {
    if (perThreadInstance.get() == null) {
      createHelper();
    }
    return helper;
  }

  private synchronized void createHelper() {
    if (helper == null) {
      helper = new Helper();
    }
    // Any non-null value can be used as an argument to set()
    perThreadInstance.set(this);
  }
}

Noncompliant Code Example (Immutable)

In this noncompliant code example, the Helper class is made immutable by declaring its fields final. The JMM guarantees that immutable objects are fully constructed before they become visible to any other thread. The block synchronization in the getHelper() method guarantees that all threads that can see a non-null value of the helper field will also see the fully initialized Helper object.

public final

public class Helper {
  private final int n;
 
  public Helper(int n) {
    this.n = n;
  }
 
  // otherOther fields &and methods, all fields are final
}
 
final class Foo {
  private Helper helper = null;
  
  public Helper getHelper() { 
    if (helper == null) {            // First read of helper
      synchronized (this) {
        if (helper == null) {
        // Second read of helper
 = new Helper(); // If the helper is null, createhelper a= new instanceHelper(42);
        }
      }
    }
    return helper; // If helper is non-null, return its instance                   // Third read of helper
  }
}

Note that if Foo was mutable, the Helper field would need to be declared volatile as shown in CON00-J. Declare shared variables as volatile to ensure visibility and prevent reordering of statementsHowever, this code is not guaranteed to succeed on all Java Virtual Machine platforms because there is no happens-before relationship between the first read and third read of helper. Consequently, it is possible for the third read of helper to obtain a stale null value (perhaps because its value was cached or reordered by the compiler), causing the getHelper() method to return a null pointer.

Compliant Solution (

...

Immutable)

Wiki MarkupThis compliant solution initializes the {{helper}} in the declaration of the {{static}} variable \[[Manson 06|AA. Java References#Manson 06]\]. solution uses a local variable to reduce the number of unsynchronized reads of the helper field to 1. As a result, if the read of helper yields a non-null value, it is cached in a local variable that is inaccessible to other threads and is safely returned.

public final 
class FooHelper {
  private staticfinal finalint Helpern;
 helper
 = newpublic Helper(42);

  public static Helper getHelper() {return helper;}
}

Variables declared static are guaranteed to be initialized and made visible to other threads immediately. Static initializers also exhibit these properties. This approach should not be confused with eager initialization because in this case, the Java Language Specification guarantees lazy initialization of the class when it will be first used.

Compliant Solution (initialize-on-demand holder class idiom)

This compliant solution explicitly incorporates lazy initialization. It also uses a static variable as suggested in the previous compliant solution. The variable is declared within a static inner, Holder class.

int n) {
    this.n = n;
  }
 
  // Other fields and methods, all fields are final
}
 
final class Foo {
  staticprivate Helper helper = null;
 
  //public LazyHelper initializationgetHelper() {
  private static class Holder {
    static Helper helper = new Helper();
  }

  public static Helper getInstance(  Helper h = helper;       // Only unsynchronized read of helper
    if (h == null) {
      synchronized (this) {
    return Holder.    h = helper;
  }
}

...

...

...

...

...

...

...

...

...

// 

...

In 

...

synchronized 

...

block, so this is safe
        if (h == null) {
          h = new Helper(42);
          helper = h;
        }
      }
    }
    return h;
  }
}

Exceptions

LCK10-J-EX0: Use of the noncompliant form of the double-checked locking idiom is permitted for 32-bit primitive values (for example, int or float) [Pugh 2004], although this usage is discouraged. The noncompliant form establishes the necessary happens-before relationship between threads that see an initialized version of the primitive value. The second happens-before relationship (for the initialization of the fields of the referent) is of no practical value because unsynchronized reads and writes of primitive values up to 32-bits are guaranteed to be atomic. Consequently, the noncompliant form establishes the only needed happens-before relationship in this case. Note, however, that the noncompliant form fails for long and double because unsynchronized reads or writes of 64-bit primitives lack a guarantee of atomicity and consequently require a second happens-before relationship to guarantee that all threads see only fully assigned 64-bit values (see  VNA05-J. Ensure atomicity when reading and writing 64-bit values for more information).

Exceptions

EX1: Explicitly synchronized code (that uses method synchronization or proper block synchronization, that is, enclosing all initialization statements) does not require the use of double-checked locking.

Wiki Markup*EX2:* "Although the double-checked locking idiom cannot be used for references to objects, it can work for 32-bit primitive values (e.g., int's or float's). Note that it does not work for long's or double's, since unsynchronized reads/writes of 64-bit primitives are not guaranteed to be atomic." \[[Pugh 04|AA. Java References#Pugh 04]\]. See [CON25-J. Ensure atomicity when reading and writing 64-bit values] for more Information.

Risk Assessment

Using incorrect forms of the double-checked locking idiom can lead to synchronization issuesto synchronization problems and can expose partially initialized objects.

Automated Detection

TODO

Related Vulnerabilities

Search for vulnerabilities resulting from the violation of this rule on the CERT website.

References

\[[API 06|AA. Java References#API 06]\] 
\[[Pugh 04|AA. Java References#Pugh 04]\]
\[[Bloch 01|AA. Java References#Bloch 01]\] Item 48: "Synchronize access to shared mutable data"
\[[MITRE 09|AA. Java References#MITRE 09]\] [CWE ID 609|http://cwe.mitre.org/data/definitions/609.html] "Double-Checked Locking"

Related Guidelines

Bibliography

...

Image Added Image Added Image AddedCON21-J. Facilitate thread reuse by using Thread Pools      11. Concurrency (CON)      CON23-J. Address the shortcomings of the Singleton design pattern