Producer and Consumer using Wait Conditions | Qt Core | Qt 6.10.1
Description: The Producer and Consumer using Wait Conditions example shows how to use QWaitCondition and QMutex to control access to a circular buffer shared by a producer thread and a consumer thread.

- Qt 6.10
- Qt Core
- Producer and Consumer using Wait Conditions
- Qt 6.10.1 Reference Documentation

# Producer and Consumer using Wait Conditions

The Producer and Consumer using Wait Conditions example shows how to use QWaitCondition and QMutex to control access to a circular buffer shared by a producer thread and a consumer thread.

The producer writes data to the buffer until it reaches the end of the buffer, at which point it restarts from the beginning, overwriting existing data. The consumer thread reads the data as it is produced and writes it to standard error.

Wait conditions make it possible to have a higher level of concurrency than what is possible with mutexes alone. If accesses to the buffer were simply guarded by a QMutex, the consumer thread couldn't access the buffer at the same time as the producer thread. Yet, there is no harm in having both threads working on different parts of the buffer at the same time.

The example comprises two classes: `Producer` and `Consumer`. Both inherit from QThread. The circular buffer used for communicating between these two classes and the synchronization tools that protect it are global variables.

An alternative to using QWaitCondition and QMutex to solve the producer-consumer problem is to use QSemaphore. This is what the Producer and Consumer using Semaphores example does.

#### Global Variables

Let's start by reviewing the circular buffer and the associated synchronization tools:

     constexpr int DataSize = 100000;
     constexpr int BufferSize = 8192;

     QMutex mutex; // protects the buffer and the counter
     char buffer[BufferSize];
     int numUsedBytes;

     QWaitCondition bufferNotEmpty;
     QWaitCondition bufferNotFull;

`DataSize` is the amount of data that the producer will generate. To keep the example as simple as possible, we make it a constant. `BufferSize` is the size of the circular buffer. It is less than `DataSize`, meaning that at some point the producer will reach the end of the buffer and restart from the beginning.

To synchronize the producer and the consumer, we need two wait conditions and one mutex. The `bufferNotEmpty` condition is signalled when the producer has generated some data, telling the consumer that it can start reading it. The `bufferNotFull` condition is signalled when the consumer has read some data, telling the producer that it can generate more. The `numUsedBytes` is the number of bytes in the buffer that contain data.

Together, the wait conditions, the mutex, and the `numUsedBytes` counter ensure that the producer is never more than `BufferSize` bytes ahead of the consumer, and that the consumer never reads data that the producer hasn't generated yet.

#### Producer Class

Let's review the code for the `Producer` class:

     class Producer : public QThread
     {
     public:
         explicit Producer(QObject *parent = nullptr)
             : QThread(parent)
         {
         }

     private:
         void run() override
         {
             for (int i = 0; i < DataSize; ++i) {
                 {
                     const QMutexLocker locker(&mutex);
                     while (numUsedBytes == BufferSize)
                         bufferNotFull.wait(&mutex);
                 }

                 buffer[i % BufferSize] = "ACGT"[QRandomGenerator::global()->bounded(4)];

                 {
                     const QMutexLocker locker(&mutex);
                     ++numUsedBytes;
                     bufferNotEmpty.wakeAll();
                 }
             }
         }
     };

The producer generates `DataSize` bytes of data. Before it writes a byte to the circular buffer, it must first check whether the buffer is full (i.e., `numUsedBytes` equals `BufferSize`). If the buffer is full, the thread waits on the `bufferNotFull` condition.

At the end, the producer increments `numUsedBytes` and signalls that the condition `bufferNotEmpty` is true, since `numUsedBytes` is necessarily greater than 0.

We guard all accesses to the `numUsedBytes` variable with a mutex. In addition, the QWaitCondition::wait() function accepts a mutex as its argument. This mutex is unlocked before the thread is put to sleep and locked when the thread wakes up. Furthermore, the transition from the locked state to the wait state is atomic, to prevent race conditions from occurring.

#### Consumer Class

Let's turn to the `Consumer` class:

     class Consumer : public QThread
     {
     public:
         explicit Consumer(QObject *parent = nullptr)
             : QThread(parent)
         {
         }

     private:
         void run() override
         {
             for (int i = 0; i < DataSize; ++i) {
                 {
                     const QMutexLocker locker(&mutex);
                     while (numUsedBytes == 0)
                         bufferNotEmpty.wait(&mutex);
                 }

                 fprintf(stderr, "%c", buffer[i % BufferSize]);

                 {
                     const QMutexLocker locker(&mutex);
                     --numUsedBytes;
                     bufferNotFull.wakeAll();
                 }
             }
             fprintf(stderr, "\n");
         }
     };

The code is very similar to the producer. Before we read the byte, we check whether the buffer is empty (`numUsedBytes` is 0) instead of whether it's full and wait on the `bufferNotEmpty` condition if it's empty. After we've read the byte, we decrement `numUsedBytes` (instead of incrementing it), and we signal the `bufferNotFull` condition (instead of the `bufferNotEmpty` condition).

#### The main() Function

In `main()`, we create the two threads and call QThread::wait() to ensure that both threads get time to finish before we exit:

     int main(int argc, char *argv[])
     {
         QCoreApplication app(argc, argv);
         Producer producer;
         Consumer consumer;
         producer.start();
         consumer.start();
         producer.wait();
         consumer.wait();
         return 0;
     }

So what happens when we run the program? Initially, the producer thread is the only one that can do anything; the consumer is blocked waiting for the `bufferNotEmpty` condition to be signalled (`numUsedBytes` is 0). Once the producer has put one byte in the buffer, `numUsedBytes` is strictly greater than 0, and the `bufferNotEmpty` condition is signalled. At that point, two things can happen: Either the consumer thread takes over and reads that byte, or the producer gets to produce a second byte.

The producer-consumer model presented in this example makes it possible to write highly concurrent multithreaded applications. On a multiprocessor machine, the program is potentially up to twice as fast as the equivalent mutex-based program, since the two threads can be active at the same time on different parts of the buffer.

Be aware though that these benefits aren't always realized. Locking and unlocking a QMutex has a cost. In practice, it would probably be worthwhile to divide the buffer into chunks and to operate on chunks instead of individual bytes. The buffer size is also a parameter that must be selected carefully, based on experimentation.

Example project @ code.qt.io