condition_variable

condition_variable#

条件变量（condition_vatiable）主要用于线程间同步。

条件变量是同步原语，能用于阻塞一个线程，或同时阻塞多个线程吗，直到另一个线程修改共享变量（条件），并通知条件变量。

有意修改变量的线程必须：

获得 std::mutex（常通过 std::lock_guard）
在保有锁时进行修改
在 std::condition_variable 上执行 notify_one 或 notify_all（不需要为通知保有锁）

即使共享变量是原子的，也必须在互斥下修改它，以正确地发布修改到等待的线程。

任何有意在 std::condition_variable 上等待的线程必须：

获得用于保护共享变量的 std::unique_lock<std::mutex>
使用 wait、wait_for 及 wait_until 等待其他线程释放互斥锁

注意事项：

std::condition_variable 只可与 std::unique_lock<std::mutex> 一同使用；此限制在一些平台上允许最大效率。
std::condition_variable_any 提供可与任何基础可锁对象，例如 std::shared_lock 一同使用的条件变量。
condition_variable 允许 wait、wait_for、wait_until、notify_one 及 notify_all 被同时调用。

#include <chrono>
#include <condition_variable>
#include <iostream>
#include <mutex>
#include <string>
#include <thread>

std::mutex m;
std::condition_variable cv; // 条件变量
std::string data;           // 共享变量

bool ready = false;
bool processed = false;

// >>>> step 2
void worker_thread() // 这个函数什么时候才会被执行？
{
    // 等待直至 main() 发送数据
    std::cout << "Worker: before unique_lock\n";
    std::unique_lock<std::mutex> lk(m);
    cv.wait(lk, [] {
        return ready;
    }); // ready == true 后继续执行

    // 等待后，我们占有锁
    std::cout << "Worker thread is processing data\n";
    data += " after processing";

    // 发送数据回 main()
    processed = true;
    std::cout << "Worker thread signals data processing compeleted\n";

    // 通知前完成手动解锁，以避免等待线程才被唤醒就阻塞（细节见 notify_one）
    lk.unlock();

    // 发送通知
    cv.notify_one();
}

int main() {
    // 创建 worker 线程，该线程运行的代码为 worker_thread
    std::thread worker(worker_thread);

    // 睡眠可以保证子线程先运行，否则主线程将先执行
    std::chrono::milliseconds dura(500);
    std::this_thread::sleep_for(dura);

    // >>>> step 1
    data = "Example data";
    // 发送数据到 worker 线程
    {
        std::lock_guard<std::mutex> lk(m); // lock_guard 离开作用域后自动解锁
        ready = true;
        std::cout << "main() signals data ready for processing\n";
    }
    cv.notify_one();

    // >>>> step 3
    // 等候 worker
    {
        std::unique_lock<std::mutex> lk(m);
        cv.wait(lk, [] {
            return processed;
        });
    }
    std::cout << "Back in main(), data = " << data << '\n';

    worker.join(); // 等待子线程 worker 退出
}

// 运行： g++ wait_for.cpp --std=c++11 -lpthread

为什么条件变量要配合 mutex#

通常在程序里，我们使用条件变量来表示等待“某一条件”的发生。虽然名叫“条件变量”，但是它本身并不保存条件状态，本质上条件变量仅仅是一种通讯机制：当有一个线程在等待（pthread_cond_wait）某一条件变量的时候，会将当前的线程挂起，直到另外的线程发送信号（pthread_cond_signal）通知其解除阻塞状态。

由于要用额外的共享变量保存条件状态（这个变量可以是任何类型比如 bool），由于这个变量会同时被不同的线程访问，因此需要一个额外的 mutex 保护它。条件变量总是结合 mutex 使用，条件变量就共享变量的状态改变发出通知，mutex 就是用来保护这个共享变量的。

一个生产者-消费者模型的例子，会让你更深刻地理解这一点。

首先，我们使用条件变量的接口实现一个简单的生产者-消费者模型，avail 就是保存条件状态的共享变量，它对生产者线程、消费者线程均可见。不考虑错误处理，先看生产者实现：

pthread_mutex_lock(&mutex);
avail++;
pthread_mutex_unlock(&mutex);

pthread_cond_signal(&cond); /* Wake sleeping consumer */

因为 avail 对两个线程都可见，因此对其修改均应该在 mutex 的保护之下，再来看消费者线程实现：

for (;;) {
    pthread_mutex_lock(&mutex);
    while (avail == 0)
        pthread_cond_wait(&cond, &mutex);

    while (avail > 0) {
        /* Do something */
        avail--;
    }
    pthread_mutex_unlock(&mutex);
}

当 avail == 0 时，消费者线程会阻塞在 pthread_cond_wait() 函数上。如果 pthread_cond_wait() 仅需要一个 pthread_cond_t 参数的话，此时 mutex 已经被锁，要是不先将 mutex 变量解锁，那么其他线程（如生产者线程）永远无法访问 avail 变量，也就无法继续生产，消费者线程会一直阻塞下去。因此 pthread_cond_wait() 需要传递给它一个 pthread_mutex_t 类型的变量。

pthread_cond_wait() 函数的执行过程大致会分为 3 个部分：

解锁互斥量 mutex
阻塞调用线程，直到当前的条件变量收到通知
重新锁定互斥量 mutex

其中 1 和 2 是原子操作，也就是说在 pthread_cond_wait() 调用线程陷入阻塞之前其他的线程无法获取当前的 mutex，也就不能就该条件变量发出通知。

condition_variable

Contents

condition_variable#

为什么条件变量要配合 mutex#