Page History

Both thread safety and liveness are concerns when using condition variables. The thread-safety property requires that all objects maintain consistent states in a multithreaded environment [Lea 2000]. The liveness property requires that every operation or function invocation execute to completion without interruption; for example, there is no deadlock.

Condition variables must be used inside a while loop. (See CON36-C. Wrap functions that can spuriously wake up in a loop for more information.) To guarantee liveness, programs must test the while loop condition before invoking the cnd_wait() function. This early test checks whether another thread has already satisfied the condition predicate and has sent a notification. Invoking the cnd_wait() function after the notification has been sent results in indefinite blocking.

To guarantee thread safety, programs must test the while loop condition after returning from the cnd_wait() function. When a given thread invokes the cnd_wait() function, it will attempt to block until its condition variable is signaled by a call to cnd_broadcast() or to cnd_signal().

The cnd_signal() function unblocks one of the threads that are blocked on the specified condition variable at the time of the call. If multiple threads are waiting on the same condition variable, the scheduler can select any of those threads to be awakened (assuming that all threads have the same priority level). The cnd_broadcast() function unblocks all of the threads that are blocked on the specified condition variable at the time of the call. The order in which threads execute following a call to cnd_broadcast() is unspecified. Consequently, an unrelated thread could start executing, discover that its condition predicate is satisfied, and resume execution even though it was supposed to remain dormant. For these reasons, threads must check the condition predicate after the cnd_wait() function returns. A while loop is the best choice for checking the condition predicate both before and after invoking cnd_wait().

The use of cnd_signal() is safe if each thread uses a unique condition variable. If multiple threads share a condition variable, the use of cnd_signal() is safe only if the following conditions are met:

• All threads must perform the same set of operations after waking up, which means that any thread can be selected to wake up and resume for a single invocation of cnd_signal().
• Only one thread is required to wake upon receiving the signal.

The cnd_broadcast() function can be used to unblock all of the threads that are blocked on the specified condition variable if the use of cnd_signal() is unsafe.

Noncompliant Code Example (cnd_signal())

This noncompliant code example uses five threads that are intended to execute sequentially according to the step level assigned to each thread when it is created (serialized processing). The current_step variable holds the current step level and is incremented when the respective thread completes. Finally, another thread is signaled so that the next step can be executed. Each thread waits until its step level is ready, and the cnd_wait() function call is wrapped inside a while loop, in compliance with CON36-C. Wrap functions that can spuriously wake up in a loop.

#include <stdio.h>
#include <threads.h>

enum { NTHREADS = 5 };

mtx_t mutex;
cnd_t cond;

int run_step(void *t) {
  static size_t current_step = 0;
  size_t my_step = *(size_t *)t;

  if (thrd_success != mtx_lock(&mutex)) {
    /* Handle error */
  }

  printf("Thread %zu

When a given thread waits (pthread_cond_wait() or pthread_cond_timedwait()) on a condition variable, it can be awakened as result of a signal operation (pthread_cond_signal()). However, if multiple threads are waiting on the same condition variable, any of those threads can be picked up by the scheduler to be awakened (assuming that all threads have the same priority level and also that they have only one mutex associated with the condition variable). See guideline CON37-C. Do not use more than one mutex for concurrent waiting operations on a condition variable.

This forces the user to create a predicate-testing-loop around the wait condition to guarantee that each thread only executes if its predicate test is true (recommendation on IEEE Std 1003.1 since 2001 release). As a consequence, if a given thread finds the predicate test to be false, it waits again, eventually resulting in a deadlock situation.

Therefore, the use of pthread_cond_signal() is safe only if the following conditions are met:

• The condition variable is the same for each waiting thread.
• All threads must perform the same set of operations after waking up. This means that any thread can be selected to wake up and resume for a single invocation of pthread_cond_signal().
• Only one thread is required to wake upon receiving the signal.

The use of pthread_cond_signal() can also be safe in the following situation:

• Each thread uses a unique condition variable.
• Each condition variable is associated with the same mutex (lock).

The use of pthread_cond_broadcast() solves the problem since it wakes up all the threads associated with the respective condition variable, and since all (must) re-evaluate the predicate condition, one should find its test to be true, avoiding the deadlock situation.

Noncompliant Code Example (pthread_cond_signal())

The following noncompliant code example consists on a given number of threads (5) that should execute one after another according to the step level that is assigned to them when created (serialized processing). The current_step variable holds the current step level and is incremented as soon as the respective thread finishes its processing. Finally, another thread is signaled so that the next step can be executed.

#include <stdio.h>
#include <stdlib.h>
#include <pthread.h>

#define NTHREADS  5

pthread_mutex_t mutex;
pthread_cond_t cond;


void *run_step(void *t) {
  static int current_step = 0;
  int my_step = (int)t;
  int result;

  if ((result = pthread_mutex_lock(&mutex)) != 0) {
    /* Handle error condition */
  }

  printf("Thread %d has the lock\n", my_step);

  while (current_step != my_step) {
    printf("Thread %d%zu is sleeping...\n", my_step);

    if ((resultthrd_success != pthread_condcnd_wait(&cond, &mutex)) != 0) {
      /* Handle error condition */
    }

    printf("Thread %d%zu woke up\n", my_step);
  }

  /* Do processing ... */
  printf("Thread %d%zu is processing...\n", my_step);

  current_step++;

  /* Signal aawaiting waiting task */
  if ((resultthrd_success != pthread_condcnd_signal(&cond)) != 0) {
    /* Handle error condition */
  }

  printf("Thread %d%zu is exiting...\n", my_step);

  if ((resultthrd_success != pthreadmtx_mutex_unlock(&mutex)) != 0) {
    /* Handle error condition */
  }

  pthread_exit(NULL)return 0;
}


int main(int argc, char** argv) {
  int i;
  int result;
  pthread_attr_t attr;
  pthreadvoid) {
  thrd_t threads[NTHREADS];
  intsize_t step[NTHREADS];

  if ((resultthrd_success != pthreadmtx_mutex_init(&mutex, NULL)) != 0mtx_plain)) {
    /* Handle error condition */
  }

  if ((resultthrd_success != pthread_condcnd_init(&cond, NULL)) != 0) {
    /* Handle error condition */
  }

  /* Create threads if ((result = pthread_attr_init(&attr)) != 0*/
  for (size_t i = 0; i < NTHREADS; ++i) {
    /* Handle error condition */step[i] = i;

  }
  if ((resultthrd_success != pthreadthrd_attr_setdetachstatecreate(&attrthreads[i], PTHREAD_CREATE_JOINABLE)) != 0) {
run_step,
        /* Handle error condition */
  }

  /* Create threads */
      for (i = 0; i < NTHREADS; i++) {
    &step[i])) {
 = i;
    if ((result = pthread_create(&threads[i], &attr, run_step, (void *)step[i])) != 0) {
      /* Handle error condition */
    }/* Handle error */
    }
  }

  /* Wait for all threads to complete */
  for (size_t i = NTHREADS-1; i >!= 0; i--i) {
    if ((resultthrd_success != pthreadthrd_join(threads[i-1], NULL)) != 0) {
      /* Handle error condition */
    }
  }

  if ((result = pthread_mutexmtx_destroy(&mutex)) != 0) {
    /* Handle error condition */
  }
  if ((result = pthread_cond;
  cnd_destroy(&cond)) !=;
  return 0) {
    /* Handle error condition */
  }
  if ((result = pthread_attr_destroy(&attr)) != 0) {
    /* Handle error condition */
  }

  pthread_exit(NULL);
}
;
} 

In this example, all threads share a condition variable. Each thread has its own distinct condition predicate because each thread requires current_step to have a different value before proceeding. When the condition variable is signaled, any of the waiting threads can wake up.

The following table illustrates a possible scenario in which the liveness property is violatedIn the above code, each thread has its own predicate because each requires current_step to have a different value before proceeding. Upon the signal operation (pthread_cond_signal()), any of the waiting threads can wake up. If, by chance, it the notified thread is not the thread with the next step value, that thread will wait again pthread_cond_wait(), thus resulting in a deadlock situation because no more signal operations will occur.. No additional notifications can occur, and eventually the pool of available threads will be exhausted.

Deadlock: Out-of-Sequence Step ValueConsider the following example:

This noncompliant Therefore, this noncompliant code example violates the [BB. Definitions#liveness[ liveness property.

...

Compliant Solution (

...

cnd_broadcast())

This compliant solution uses the pthread_condcnd_broadcast() method function to signal all waiting threads instead of a single " random " onethread.
Only  Only the run_step() thread code from the noncompliant code example is modified, as follows:

void *#include <stdio.h>
#include <threads.h>

mtx_t mutex;
cnd_t cond;
int run_step(void *t) {
  static intsize_t current_step = 0;
  intsize_t my_step = *(intsize_t *)t;
  int result;

  if ((resultthrd_success != pthread_mutexmtx_lock(&mutex)) != 0) {
    /* Handle error condition */
  }

  printf("Thread %d%zu has the lock\n", my_step);

  while (current_step != my_step) {
    printf("Thread %d%zu is sleeping...\n", my_step);

    if ((resultthrd_success != pthreadcnd_cond_wait(&cond, &mutex)) != 0) {
      /* Handle error condition */
    }

    printf("Thread %d%zu woke up\n", my_step);
  }

  /* Do processing ... */
  printf("Thread %d%zu is processing...\n", my_step);

  current_step++;

  /* Signal ALL waiting tasks */
  if ((resultthrd_success != pthreadcnd_cond_broadcast(&cond)) != 0) {
    /* Handle error condition */
  }

  printf("Thread %d%zu is exiting...\n", my_step);

  if ((resultthrd_success != pthread_mutexmtx_unlock(&mutex)) != 0) {
    /* Handle error condition */
  }

   pthread_exit(NULL)return 0;
}

The fact that all tasks will be awake solves the problem because all tasks end up executing its predicate test; therefore, one will find it to be true and continue the execution until the endAwakening all threads guarantees the liveness property because each thread will execute its condition predicate test, and exactly one will succeed and continue execution.

Compliant Solution (Using

...

cnd_signal()

...

with a Unique Condition Variable

...

per Thread)

Another way to solve the signal issue compliant solution is to use a unique condition variable for each thread (maintaining a single mutex all associated with itthe same mutex). In this case, the signal operation (pthread_cond_cnd_signal()) will wake wakes up only the only thread that is waiting on it.
NOTE: The  This solution is more efficient than using cnd_broadcast() because only the desired thread is awakened.

The condition predicate of the signaled thread must be true; otherwise, a deadlock can will occur anyway.

#include <stdio.h>
#include <stdlib<threads.h>

#include <pthread.h>

#defineenum { NTHREADS = 5 };

pthreadmtx_mutex_t mutex;
pthread_condcnd_t cond[NTHREADS];


voidint *run_step(void *t) {
  static intsize_t current_step = 0;
  intsize_t my_step = *(int)t;
  int result;

size_t *)t;

  if ((resultthrd_success != pthread_mutexmtx_lock(&mutex)) != 0) {
    /* Handle error condition */
  }

  printf("Thread %d%zu has the lock\n", my_step);

  while (current_step != my_step) {
    printf("Thread %d%zu is sleeping...\n", my_step);

    if ((resultthrd_success != pthread_condcnd_wait(&cond[my_step], &mutex)) != 0) {
      /* Handle error condition */
    }

    printf("Thread %d%zu woke up\n", my_step);
  }

  /* Do processing ... */
  printf("Thread %d%zu is processing...\n", my_step);

  current_step++;

  /* Signal next step thread */
  if ((my_step + 1) < NTHREADS) {
    if ((resultthrd_success != pthread_condcnd_signal(&cond[my_step + 1])) != 0) {
      /* Handle error condition */
    }
  }

  printf("Thread %d%zu is exiting...\n", my_step);

  if ((resultthrd_success != pthread_mutexmtx_unlock(&mutex)) != 0) {
    /* Handle error condition */
  }

   pthread_exit(NULL)return 0;
}


int main(int argc, char** argvvoid) {
  int ithrd_t threads[NTHREADS];
  int result;
  pthread_attr_t attr;
  pthread_t threads[NTHREADS];
  int stepsize_t step[NTHREADS];

  if ((resultthrd_success != pthreadmtx_mutex_init(&mutex, NULL)) != 0mtx_plain)) {
    /* Handle error condition */
  }

  for (size_t i = 0; i< NTHREADS; i++i) {
    if ((resultthrd_success != pthreadcnd_cond_init(&cond[i], NULL)) != 0) {
      /* Handle error condition */
    }
  }

   if ((result = pthread_attr_init(&attr)) != 0/* Create threads */
  for (size_t i = 0; i < NTHREADS; ++i) {
    /* Handle error condition */step[i] = i;
  }
  if ((resultthrd_success != pthreadthrd_attr_setdetachstatecreate(&attrthreads[i], PTHREAD_CREATE_JOINABLE)) != 0) {
run_step,
       /* Handle error condition */
  }

  /* Create threads */
  for (i = 0; i < NTHREADS; i++) {
    step[i] = i;
    if ((result = pthread_create(&threads[i], &attr, run_step, (void *)step[i])) != 0) {
      /* Handle error condition */
    }
  }

  /* Wait for all threads to complete */
  for (size_t i = NTHREADS-1; i >!= 0; i--i) {
    if ((resultthrd_success != pthreadthrd_join(threads[i-1], NULL)) != 0) {
      /* Handle error condition */
    }
  }

  if ((result = pthread_mutexmtx_destroy(&mutex)) !;

  for (size_t i = 0; i < NTHREADS; ++i) {
    /* Handle error condition */cnd_destroy(&cond[i]);
  }

  for (i =return 0; i < NTHREADS; i++) {
    if ((result = pthread_cond_destroy(&cond[i])) != 0) {
      /* Handle error condition */
    }
  }

  if ((result = pthread_attr_destroy(&attr)) != 0) {
    /* Handle error condition */
  }

  pthread_exit(NULL);
}

In the above code, each thread has associated a unique condition variable which is signaled when that particular thread needs to be awakened. This solution turns out to be more efficient because only the desired thread will be awakened.

Risk Assessment

Signaling a single thread instead of all waiting threads can pose a threat to the liveness property of the system.

Related Guidelines

}

Compliant Solution (Windows, Condition Variables)

This compliant solution uses  a CONDITION_VARIABLE object, available on Microsoft Windows (Vista and later):

#include <Windows.h>
#include <stdio.h>
 
CRITICAL_SECTION lock;
CONDITION_VARIABLE cond;
 
DWORD WINAPI run_step(LPVOID t) {
  static size_t current_step = 0;
  size_t my_step = (size_t)t;

  EnterCriticalSection(&lock);  
  printf("Thread %zu has the lock\n", my_step);

  while (current_step != my_step) {
    printf("Thread %zu is sleeping...\n", my_step);
 
    if (!SleepConditionVariableCS(&cond, &lock, INFINITE)) {
      /* Handle error */
    }

    printf("Thread %zu woke up\n", my_step);
  }

  /* Do processing ... */
  printf("Thread %zu is processing...\n", my_step);

  current_step++;
 
  LeaveCriticalSection(&lock);
 
  /* Signal ALL waiting tasks */
  WakeAllConditionVariable(&cond);
 
  printf("Thread %zu is exiting...\n", my_step);
  return 0;
}
 
enum { NTHREADS = 5 };
 
int main(void) {
  HANDLE threads[NTHREADS];
  
  InitializeCriticalSection(&lock);
  InitializeConditionVariable(&cond);
 
  /* Create threads */
  for (size_t i = 0; i < NTHREADS; ++i) {
    threads[i] = CreateThread(NULL, 0, run_step, (LPVOID)i, 0, NULL);
  }
 
  /* Wait for all threads to complete */
  WaitForMultipleObjects(NTHREADS, threads, TRUE, INFINITE);
 
  DeleteCriticalSection(&lock);
 
  return 0;
}

Risk Assessment

Failing to preserve the thread safety and liveness of a program when using condition variables can lead to indefinite blocking and denial of service (DoS).

Automated Detection

Related Vulnerabilities

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

Related Guidelines

Key here (explains table format and definitions)

...

Bibliography

...

...

...

...

Image Modified Image Modified Image Modified