c++ folly::baton

Baton

folly::Baton 是 Facebook 开源的一个同步原语，它提供了一种简单而灵活的方式来进行线程间的同步。它属于 Folly 库，是 C++ 编程语言的一个组件。

Baton 通常用作线程间同步、等待、通知的标识符号，常用姿势是，一些线程调用 wait() 方法等待另一些线程完成某项工作，其完成以后调用 post() 方法进行通知。 其跟一般PV信号量的区别是，Baton更轻量化、通知策略更简单(没有FILO/FIFO等策略)、仅能够通知一次，在简单场景中更高效。

• 所在头文件

#include <folly/synchronization/Baton.h>

Baton 用于同步线程间的PV (block/wakeup)，但是不像 semaphores信号量那样可以多次pv，baton 仅支持单次pv操作，folly::Future 中的block/wakeup 就是使用 Baton<> 来实现的。

folly::Baton 的主要特点：

1. 阻塞和唤醒：使用 folly::Baton，一个线程可以在一个特定的条件下阻塞，直到其他的线程通过唤醒操作通知它可以继续执行。这种阻塞和唤醒的机制可以帮助线程之间进行同步，保证线程按照预期的顺序执行。

2. 轻量级：folly::Baton 是一种轻量级的同步原语，它的实现是基于一些底层的同步机制，如条件变量和互斥锁。它不会引入额外的线程开销或内存开销，因此非常适合在性能要求较高的场景中使用。

3. 灵活性：folly::Baton 提供了多种等待和唤醒的方式，可以根据具体的需求选择最适合的方式。例如，可以使用 folly::Baton::wait() 函数进行阻塞等待，或者使用 folly::Baton::try_wait() 函数进行非阻塞的尝试等待。

4. 适用范围：folly::Baton 可以用于广泛的场景，例如实现生产者-消费者模型、控制多个线程的执行顺序、等待异步操作完成等。

folly::Baton 可以在 C++ 程序中实现线程间的协调与同步操作。

基本方法

bool Baton<>::ready(); // 测试是否已经被标记置位
void Baton<>::post();  // 置位
bool Baton<>::try_wait(); // 等同 ready
// 等待直到被置位，可以传入一个 wait_options 来控制 spin 的最大时间，默认2us
void Baton<>::wait(const WaitOptions& opt = wait_options());

示例

#include <folly/synchronization/Baton.h>
#include <folly/concurrency/DynamicBoundedQueue.h>
#include <iostream>
#include <thread>
#include <glog/logging.h>

int main(){
    folly::Baton<true> finish;
    LOG(INFO) << finish.ready();
    folly::DSPSCQueue<int, true> array_cache(25);
    int times = 0;

    std::thread t1([&]{
        LOG(INFO) << "Run thread t1";
        while(!finish.ready()){
            times ++;
            array_cache.enqueue(times);
            LOG(INFO) << array_cache.size() << " enqueue";
        }
        LOG(INFO) << "end thread " << finish.ready();
    });


    LOG(INFO) << "proc finish";
    finish.post();
    LOG(INFO) << finish.ready();
    LOG(INFO) << "finish post";

    LOG(INFO) << "--------------";

    t1.join();
    return 0;
}