LCK10-J. Do not use incorrect forms of the double-checked locking idiom

Instead of initializing a member object using a constructor, lazy initialization can be used to defer the construction of the member object until an instance is actually required. Lazy initialization also helps in breaking harmful circularities in class and instance initialization and in performing other optimizations [[Bloch 2005]].

A class or an instance method is used for lazy initialization, depending on whether the member object is static. The method checks whether the instance has already been created and, if not, creates it. If the instance already exists, it simply returns it:

// 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 multithreaded application, initialization must be synchronized so that multiple threads do not create extraneous instances of the 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;
  }
  // ...
}

The double-checked locking idiom improves performance by limiting synchronization to the rare case of new instance creation and foregoing synchronization during the common case of retrieving an already created instance.

Incorrect forms of the double-checked idiom include those that allow an uninitialized or partially initialized object to be published.

Noncompliant Code Example

The double-checked locking pattern uses block synchronization instead of method synchronization and installs an additional null check before attempting synchronization. This noncompliant code example uses the incorrect form of the double-checked locking idiom.

// "Double-Checked 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;
  }
  // Other methods 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.

Also see guideline TSM03-J. Do not publish partially initialized objects.

Compliant Solution (Volatile)

This compliant solution declares the 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; // If helper is non-null, return its instance
  }
}

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 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 final Helper helper = new Helper();

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

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.

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. 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 lazily create a Helper instance.

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);
  }
}

Compliant Solution (Immutable)

In this compliant solution, the Helper class is immutable and, consequently, guaranteed to be fully constructed before becoming visible. In this case, there are no further requirements to ensure that the double-checked locking idiom does not result in the publication of an uninitialized or partially initialized field.

public final class Helper {
  private final int n;

  public Helper(int n) {
    this.n = n;
  }

  // Other fields and methods, all fields are final
}

final class Foo {
  private Helper helper = null;

  public Helper getHelper() {
    if (helper == null) {
      synchronized (this) {
        if (helper == null) {
          helper = new Helper(42); // If the helper is null, create a new instance
        }
      }
    }
    return helper; // If helper is non-null, return its instance
  }
}

Exceptions

LCK10-EX1: The noncompliant form of the double-checked locking idiom can be used for 32-bit primitive values (for example, int or float) [[Pugh 2004]]. Note that it does not work for long or double because unsynchronized reads/writes of 64-bit primitives are not guaranteed to be atomic. (See guideline VNA05-J. Ensure atomicity when reading and writing 64-bit values.)

Risk Assessment

Using incorrect forms of the double-checked, locking idiom can lead to synchronization problems.

Automated Detection

TODO

Related Vulnerabilities

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

Related Guidelines

MITRE CWE: CWE-609 "Double-Checked Locking"

Bibliography

[[API 2006]]
[[JLS 2005]] Section 12.4, "Initialization of Classes and Interfaces"
[[Pugh 2004]]
[[Bloch 2001]] Item 48: "Synchronize access to shared mutable data"
[[Bloch 2008]] Item 71: "Use lazy initialization judiciously"

      08. Locking (LCK)