Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 4.0

...

The notification mechanism notifies the waiting thread and allows it to check its condition predicate. The invocation of notify() or notifyAll() in another thread cannot precisely determine which waiting thread will be resumed. Condition predicate statements allow notified threads to determine whether they should resume upon receiving the notification. Condition predicates are also useful when a thread is required to block until a condition becomes true, for example, when waiting for data to arrive on an input stream before reading the data.

Wiki MarkupBoth safety and liveness are concerns when using the wait/notify mechanism. The safety property requires that all objects maintain consistent states in a multithreaded environment \ [[Lea 2000|AA. References#Lea 00]\]. The liveness property requires that every operation or method invocation execute to completion without interruption.

To guarantee liveness, programs must test the while loop condition before invoking the wait() method. This early test checks whether another thread has already satisfied the condition predicate and sent a notification. Invoking the wait() method after the notification has been sent results in indefinite blocking.unmigrated-wiki-markup

To guarantee safety, programs must test the {{while}} loop condition after returning from the {{wait()}} method. Although {{wait()}} is intended to block indefinitely until a notification is received, it must still be encased within a loop to prevent the following vulnerabilities \ [[Bloch 2001|AA. References#Bloch 01]\]:

  • Thread in the middle — A third thread can acquire the lock on the shared object during the interval between a notification being sent and the receiving thread resuming execution. This third thread can change the state of the object, leaving it inconsistent. This is a TOCTOU race condition.
  • Malicious notification — A random or malicious notification can be received when the condition predicate is false. Such a notification would cancel the wait().
  • Misdelivered notification — The order in which threads execute after receipt of a notifyAll() signal is unspecified. Consequently, an unrelated thread could start executing and discover that its condition predicate is satisfied. Consequently, it could resume execution, although it was required to remain dormant.
  • Wiki MarkupSpurious wakeups --- Certain JVM implementations are vulnerable to spurious wakeups that result in waiting threads waking up even without a notification \ [[API 2006|AA. References#API 06]\].

For these reasons, programs must check the condition predicate after the wait() method returns. A while loop is the best choice for checking the condition predicate both before and after invoking wait().

Wiki MarkupSimilarly, the {{await()}} method of the {{Condition}} interface must also be invoked inside a loop. According to the Java API \[ [API 2006|AA. References#API 06]\], Interface {{Condition}}

When waiting upon a Condition, a "spurious wakeup" is permitted to occur, in general, as a concession to the underlying platform semantics. This has little practical impact on most application programs as a Condition should always be waited upon in a loop, testing the state predicate that is being waited for. An implementation is free to remove the possibility of spurious wakeups but it is recommended that applications programmers always assume that they can occur and so always wait in a loop.

...

Rule

Severity

Likelihood

Remediation Cost

Priority

Level

THI03-J

low

unlikely

medium

P2

L3

Bibliography

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="9bc54906-0103-4d38-9f9d-5f23ef15830d"><ac:plain-text-body><![CDATA [ [[API 2006AA. References#API 06] ]

[Class Objecthttp://java.sun.com/javase/6/docs/api/java/lang/ Object.html]

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

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="2c2f0445-16c8-4c16-a385-dea8889de57e"><ac:plain-text-body><![CDATA[

[[Bloch 2001AA. References#Bloch 01] ]

Item 50. Never invoke wait outside a loop

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

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="7f8c3e19-8656-4c0a-bf30-a858f38a329b"><ac:plain-text-body><![CDATA[

[[Lea 2000AA. References#Lea 00]]

3.2.2, Monitor Mechanics; 1.3.2, Liveness

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

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="bb2bbb92-6024-41e8-946f-7acefaa2fcad"><ac:plain-text-body><![CDATA[

[[Goetz 2006AA. References#Goetz 06]]

Section 14.2, Using Condition Queues ]]></ac:plain-text-body></ac:structured-macro>

...

THI02-J. Notify all waiting threads rather than a single thread      09. Thread APIs (THI)