CON20-J. Do not perform operations that may block while holding a lock

Holding locks while performing time consuming or blocking operations can severely degrade system performance and result in starvation. Furthermore, deadlock can result if interdependent threads block indefinitely. Blocking operations include network, file, and console I/O (for example, Console.readLine()), and object serialization. Deferring a thread indefinitely also constitutes a blocking operation.

If the Java Virtual Machine (JVM) interacts with a file system that operates over an unreliable network, file I/O might incur a large performance penalty. In such cases, avoid file I/O over the network when holding a lock. File operations (such as logging) that may block waiting for the output stream lock or for I/O to complete may be performed in a dedicated thread to speed up task processing. Logging requests can be added to a queue given that the queue's put() operation incurs little overhead as compared to file I/O [[Goetz 06]].

Noncompliant Code Example (Deferring a Thread)

This noncompliant code example defines a utility method that accepts a time argument.

public synchronized void doSomething(long time)
  throws InterruptedException {
  // ...
  Thread.sleep(time);
}

Because the method is synchronized, if the thread is suspended, other threads are unable to use the synchronized methods of the class. The current object's monitor is not released because the Thread.sleep() method does not have any synchronization semantics, as detailed in CON16-J. Do not assume that the sleep(), yield() or getState() methods provide synchronization semantics.

Compliant Solution (intrinsic lock)

This compliant solution defines the doSomething() method with a timeout parameter instead of the time value. Using Object.wait() instead of Thread.sleep() allows setting a time out period during which a notification may awaken the thread.

public synchronized void doSomething(long timeout)
  throws InterruptedException {
 
  while (<condition does not hold>) {
    wait(timeout); // Immediately leaves current monitor
  }
}

The current object's monitor is immediately released upon entering the wait state. After the time out period has elapsed, the thread resumes execution after reacquiring the current object's monitor.

According to the Java API class Object documentation [[API 06]]:

Note that the wait method, as it places the current thread into the wait set for this object, unlocks only this object; any other objects on which the current thread may be synchronized remain locked while the thread waits. This method should only be called by a thread that is the owner of this object's monitor.

Ensure that a thread that holds locks on other objects releases them appropriately, before entering the wait state. Additional guidance on waiting and notification in available in CON18-J. Always invoke wait() and await() methods inside a loop and CON19-J. Notify all waiting threads instead of a single thread.

Noncompliant Code Example

This noncompliant code example shows the method sendPage() that sends a Page object from a server to a client. The method is synchronized so that the array pageBuff is accessed safely when multiple threads request concurrent access.

// Class Page is defined separately. It stores and returns the Page name via getName()
Page[] pageBuff = new Page[MAX_PAGE_SIZE];

public synchronized boolean sendPage(Socket socket, String pageName) throws IOException {
  // Get the output stream to write the Page to
  ObjectOutputStream out = new ObjectOutputStream(socket.getOutputStream());

  // Find the Page requested by the client (this operation requires synchronization)
  Page targetPage = null;
  for (Page p : pageBuff) {
    if (p.getName().compareTo(pageName) == 0) {
      targetPage = p;
    }
  }

  // Requested Page does not exist
  if (targetPage == null) {
    return false;
  } 

  // Send the Page to the client (does not require any synchronization)
  out.writeObject(targetPage);

  out.flush();
  out.close();
  return true;
}

Calling writeObject() within the synchronized sendPage() method can result in delays and deadlock-like conditions in high latency networks or when network connections are inherently lossy.

Compliant Solution

This compliant solution separates the process into a sequence of steps:

• Perform actions on data structures requiring synchronization
• Create copies of the objects to be sent
• Perform network calls in a separate method that does not require any synchronization

In this compliant solution, the synchronized method getPage() is called from an unsynchronized method sendPage(), to retrieve the requested Page in the pageBuff array. After the Page is retrieved, sendPage() calls the unsynchronized method deliverPage() to deliver the Page to the client.

public boolean sendPage(Socket socket, String pageName) { // No synchronization
  Page targetPage = getPage(pageName); 

  if (targetPage == null)
    return false;

  return deliverPage(socket, targetPage);
}

private synchronized Page getPage(String pageName) { // Requires synchronization
  Page targetPage = null;

  for (Page p : pageBuff) {
    if (p.getName().equals(pageName)) {
      targetPage = p;
    }
  }
  return targetPage;
}

// Return false if an error occurs, true if successful
public boolean deliverPage(Socket socket, Page page) {
  ObjectOutputStream out = null;
  boolean result = true;
  try {
    // Get the output stream to write the Page to
    out = new ObjectOutputStream(socket.getOutputStream());

    // Send the Page to the client
    out.writeObject(page);
  } catch (IOException io) {
    result = false;
  } finally {
    if (out != null) {
      try {
        out.flush();
        out.close();
      } catch (IOException e) {
        result = false;
      }
    }  
  }
  return result;
}

Exceptions

EX1: Classes that provide an appropriate termination mechanism to callers are allowed to violate this guideline (see CON24-J. Ensure that threads and tasks performing blocking operations can be terminated).

EX2: A method that requires multiple locks may hold several locks while waiting for the remaining locks to become available. This constitutes a valid exception, though care must be taken to avoid deadlock. See CON12-J. Avoid deadlock by requesting and releasing locks in the same order for more information.

Risk Assessment

Blocking or lengthy operations performed within synchronized regions may result in a deadlocked or unresponsive system.

Related Vulnerabilities

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

References

[[API 06]] Class Object
[[Grosso 01]] Chapter 10: Serialization
[[JLS 05]] Chapter 17, Threads and Locks
[[Rotem 08]] Falacies of Distributed Computing Explained

CON19-J. Notify all waiting threads instead of a single thread      11. Concurrency (CON)      CON21-J. Use thread pools to enable graceful degradation of service during traffic bursts