CON09-J. Synchronize access to shared references

A common error is to assume that shared references to immutable objects need not be synchronized. However, a correctly synchronized program must synchronize access to shared references.

The Java™ Programming Language, Fourth Edition [[JPL 06]], "Section 14.10.2. Final Fields and Security" states:

... you can use final fields to define immutable objects. There is a common misconception that shared access to immutable objects does not require any synchronization because the state of the object never changes. This is a misconception in general because it relies on the assumption that a thread will be guaranteed to see the initialized state of the immutable object, and that need not be the case. The problem is that, while the shared object is immutable, the reference used to access the shared object is itself shared and often mutable. Consequently, a correctly synchronized program must synchronize access to that shared reference, but often programs do not do this, because programmers do not recognize the need to do it. For example, suppose one thread creates a String object and stores a reference to it in a static field. A second thread then uses that reference to access the string. There is no guarantee, based on what we've discussed so far, that the values written by the first thread when constructing the string will be seen by the second thread when it accesses the string.

This rule is about safe publication of immutable objects. There are several additional hazards related to publishing mutable objects, for more info see CON26-J. Do not publish partially-constructed objects.

Noncompliant Code Example

This noncompliant code example consists of the immutable class Helper:

// Immutable Helper
public class Helper {
  private final int n;

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

and a mutable class Foo:

class Foo {
  private Helper helper;

  public Helper getHelper() {
    return helper;
  }

  public void setHelper(int num) {
    helper = new Helper(num);
  }
}

The Foo.getHelper() method publishes the mutable helper field.

Because the Helper class is immutable, it cannot be changed after it is setHelperd and is therefore thread-safe.

However, because the helper field of class Foo is not properly synchronized, it is possible that the Foo.getHelper() method will return a reference to a partially or incorrectly set helper object, if invoked from a separate thread.

Compliant Solution (synchronization)

This compliant solution synchronizes the methods of class Foo to ensure that no thread sees a partially setHelperd helper field.

class Foo {
  private Helper helper;

  public synchronized Helper getHelper() {
    return helper;
  }

  public synchronized void setHelper(int num) {
    helper = new Helper(num);
  }
}

The immutable Helper class is unchanged.

Compliant Solution (volatile)

Immutable members can be safely published by declaring them volatile as described in CON00-J. Know when to use volatile.

class Foo {
  private volatile Helper helper;

  public Helper getHelper() {
    return helper;
  }

  public void setHelper(int num) {
    helper = new Helper(num);
  }
}

The immutable Helper class is unchanged.

Risk Assessment

The assumption that classes containing immutable objects are immutable is misleading and can cause serious thread-safety issues.

Automated Detection

TODO

Related Vulnerabilities

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

References

[[API 06]]
[[JPL 06]], 14.10.2. Final Fields and Security:

FIO36-J. Do not create multiple buffered wrappers on an InputStream      09. Input Output (FIO)      09. Input Output (FIO)