Boost-C++-应用开发秘籍第二版(三)

122 阅读54分钟

Boost C++ 应用开发秘籍第二版(三)

原文:annas-archive.org/md5/8a1821d22bcd421390c328e6f1d92500

译者:飞龙

协议:CC BY-NC-SA 4.0

多线程

在本章中,我们将涵盖:

  • 创建执行线程

  • 同步访问共享资源

  • 使用原子快速访问共享资源

  • 创建一个 work_queue 类

  • 多读单写锁

  • 创建每个线程唯一的变量

  • 中断线程

  • 操作一组线程

  • 安全初始化共享变量

  • 多个互斥锁

介绍

在本章中,我们将处理线程和与之相关的所有内容。鼓励具有多线程基础知识。

多线程意味着单个进程中存在多个执行线程。线程可以共享进程资源并拥有自己的资源。这些执行线程可以在不同的 CPU 上独立运行,从而实现更快速和更负责任的程序。Boost.Thread库提供了跨操作系统接口的统一工作线程。它不是一个仅头文件的库,因此本章中的所有示例都需要链接到libboost_threadlibboost_system库。

创建执行线程

在现代多核编译器上,为了实现最大性能(或者只是提供良好的用户体验),程序通常使用多个执行线程。以下是一个激励性的例子,我们需要在一个线程中创建和填充一个大文件,该线程绘制用户界面:

#include <cstddef> // for std::size_t

bool is_first_run(); 

// Function that executes for a long time.
void fill_file(char fill_char, std::size_t size, const char* filename);

// Called in thread that draws a user interface:
void example_without_threads() {
    if (is_first_run()) {
        // This will be executing for a long time during which
        // users interface freezes...
        fill_file(0, 8 * 1024 * 1024, "save_file.txt");
    }
}

准备工作

此配方需要了解boost::bindstd::bind

如何做...

启动执行线程从未如此简单:

#include <boost/thread.hpp> 

// Called in thread that draws a user interface:
void example_with_threads() {
    if (is_first_run()) {
        boost::thread(boost::bind(
            &fill_file,
            0,
            8 * 1024 * 1024,
            "save_file.txt"
        )).detach();
    }
}

它是如何工作的...

boost::thread变量接受一个可以无参数调用的函数对象(我们使用boost::bind提供了一个),并创建一个独立的执行线程。该函数对象被复制到构造的执行线程中并在那里运行。函数对象的返回值被忽略。

我们在所有配方中使用Boost.Thread的第 4 版(将BOOST_THREAD_VERSION定义为4)。Boost.Thread版本之间的重要区别已经突出显示。

之后,我们调用detach()函数,它会执行以下操作:

  • 执行线程从boost::thread变量中分离,但继续执行

  • boost::thread变量开始保持Not-A-Thread状态

如果没有调用detach()boost::thread的析构函数将注意到它仍然持有一个 OS 线程,并将调用std::terminate。它会在不调用析构函数、释放资源和进行其他清理的情况下终止我们的程序。

默认构造的线程也有一个Not-A-Thread状态,并且它们不会创建一个独立的执行线程。

还有更多...

如果我们想确保在执行其他工作之前文件已创建并写入,那么我们需要以以下方式加入线程:

void example_with_joining_threads() {
    if (is_first_run()) {
        boost::thread t(boost::bind(
            &fill_file,
            0,
            8 * 1024 * 1024,
            "save_file.txt"
        ));

        // Do some work.
        // ...

        // Waiting for thread to finish.
        t.join();
    }
} 

线程加入后,boost::thread变量保持Not-A-Thread状态,其析构函数不会调用std::terminate

请记住,在调用其析构函数之前,线程必须被加入或分离。否则,您的程序将终止!

使用定义了BOOST_THREAD_VERSION=2boost::thread的析构函数调用detach(),这不会导致std::terminate。但这样做会破坏与std::thread的兼容性,并且有一天,当您的项目转移到 C++标准库线程时,或者当BOOST_THREAD_VERSION=2不受支持时,这将给您带来很多惊喜。Boost.Thread的第 4 版更加明确和强大,这在 C++语言中通常更可取。

请注意,当任何不是boost::thread_interrupted类型的异常离开传递给boost::thread构造函数的功能对象时,将调用std::terminate()

有一个非常有用的包装器,它作为一个 RAII 包装器围绕线程工作,并允许您模拟BOOST_THREAD_VERSION=2的行为;它被称为boost::scoped_thread<T>,其中T可以是以下类之一:

  • boost::interrupt_and_join_if_joinable:在销毁时中断和加入线程

  • boost::join_if_joinable:在销毁时加入线程

  • boost::detach:在销毁时分离线程

这是一个简短的例子:

#include <boost/thread/scoped_thread.hpp> 

void some_func(); 

void example_with_raii() { 
    boost::scoped_thread<boost::join_if_joinable> t( 
        boost::thread(&some_func) 
    ); 

    // 't' will be joined at scope exit.
} 

boost::thread类被接受为 C++11 标准的一部分,并且您可以在std::命名空间的<thread>头文件中找到它。Boost 的版本 4 和 C++11 标准库版本的thread类之间没有太大的区别。但是,boost::thread在 C++03 编译器上可用,因此其使用更加灵活。

默认情况下调用std::terminate而不是加入有很好的理由!C 和 C++语言经常用于生命关键软件。这些软件由其他软件控制,称为看门狗。这些看门狗可以轻松检测到应用程序已终止,但并不总是能够检测到死锁,或者以更长的延迟检测到死锁。例如,对于除颤器软件,终止比等待几秒钟以等待看门狗反应更安全。在设计这类应用程序时请记住这一点。

另请参阅

  • 本章中的所有示例都使用了Boost.Thread。您可以继续阅读以获取有关该库的更多信息。

  • 官方文档中列出了boost::thread方法的完整列表,并对它们在 C++11 标准库中的可用性进行了说明。请访问boost.org/libs/thread获取官方文档。

  • 中断线程的示例将让您了解boost::interrupt_and_join_if_joinable类的作用。

同步访问共享资源

现在我们知道如何启动执行线程,我们希望从不同的线程访问一些共享资源:

#include <cassert> 
#include <cstddef> 
#include <iostream>

// In previous recipe we included 
// <boost/thread.hpp>, which includes all 
// the classes of Boost.Thread.
// Following header includes only boost::thread. 
#include <boost/thread/thread.hpp> 

int shared_i = 0;

void do_inc() {
    for (std::size_t i = 0; i < 30000; ++i) {
        const int i_snapshot = ++shared_i;
        // Do some work with i_snapshot.
        // ...
    }
}

void do_dec() {
    for (std::size_t i = 0; i < 30000; ++i) {
        const int i_snapshot = --shared_i;
        // Do some work with i_snapshot.
        // ...
    }
}

void run() {
    boost::thread t1(&do_inc);
    boost::thread t2(&do_dec);

    t1.join();
    t2.join();

    assert(global_i == 0); // Oops!
    std::cout << "shared_i == " << shared_i;
}

这里的Oops!不是无意写在那里的。对于一些人来说,这可能是一个惊喜,但shared_i不等于0的可能性很大:

    shared_i == 19567

现代编译器和处理器有大量不同的棘手优化,可能会破坏前面的代码。我们不会在这里讨论它们,但在文档的另请参阅部分有一个有用的链接,简要描述了它们。

当共享资源是一个非平凡的类时,情况变得更糟;分段错误和内存泄漏可能(并且将)发生。

我们需要更改代码,以便只有一个线程在单个时间点修改shared_i变量,并且所有影响多线程代码的处理器和编译器优化都被绕过。

准备工作

建议具备基本的线程知识。

如何做...

让我们看看如何修复之前的例子,并在运行结束时使shared_i相等:

  1. 首先,我们需要创建一个互斥锁
#include <boost/thread/mutex.hpp> 
#include <boost/thread/locks.hpp> 

int shared_i = 0; 
boost::mutex i_mutex; 
  1. 将修改或获取shared_i变量数据的所有操作放在以下位置:
      {   // Critical section begin 
          boost::lock_guard<boost::mutex> lock(i_mutex); 

以及以下内容:

      }   // Critical section end 

它应该是这样的:

void do_inc() {
    for (std::size_t i = 0; i < 30000; ++i) {
        int i_snapshot;
        { // Critical section begin.
            boost::lock_guard<boost::mutex> lock(i_mutex);
            i_snapshot = ++shared_i;
        } // Critical section end.

        // Do some work with i_snapshot.
        // ...
    }
}

void do_dec() {
    for (std::size_t i = 0; i < 30000; ++i) {
        int i_snapshot;
        { // Critical section begin.
            boost::lock_guard<boost::mutex> lock(i_mutex);
            i_snapshot = -- shared_i;
        } // Critical section end.

        // Do some work with i_snapshot.
        // ...
    }
} 

它是如何工作的...

boost::mutex类负责所有同步工作。当一个线程尝试通过boost::lock_guard<boost::mutex>变量锁定它,并且没有其他线程持有锁时,它成功地获得对代码部分的唯一访问,直到锁被解锁或销毁。如果其他线程已经持有锁,尝试获取锁的线程将等待直到另一个线程解锁锁。所有的锁定/解锁操作都包含特定的指令,以便在关键部分所做的更改对所有线程可见。此外,您不再需要:

  • 确保资源的修改值对所有核心可见

  • 确保值不仅仅在处理器的寄存器中被修改

  • 强制处理器不要重新排序指令

  • 强制编译器不要重新排序指令

  • 强制编译器不要删除对未读取的存储的写入

  • 一堆其他讨厌的编译器/架构特定的东西

如果您有一个变量被不同的线程使用,并且至少有一个线程修改该变量,通常情况下,使用它的所有代码必须被视为关键部分,并由互斥锁保护。

boost::lock_guard类是一个非常简单的 RAII 类,它存储互斥锁的引用,在单参数构造函数中锁定它,并在析构函数中解锁它。

在前面的示例中,大括号的使用中lock变量是在其中构造的,以便在到达//关键部分结束。的闭括号时,将调用lock变量的析构函数并解锁互斥锁。即使在关键部分发生异常,互斥锁也会被正确解锁。

如果初始化一个共享变量,然后构造只读取它的线程,那么不需要互斥锁或其他同步。

还有更多...

锁定互斥锁可能是一个非常慢的操作,可能会使您的代码停止很长时间,直到其他线程释放锁。尝试使关键部分尽可能小;尽量减少代码中的关键部分。

让我们看看一些操作系统如何处理多核 CPU 上的锁定。当运行在 CPU 1 上的线程#1尝试锁定已被另一个线程锁定的互斥锁时,线程#1被操作系统停止,直到锁被释放。停止的线程不会占用处理器资源,因此操作系统在 CPU 1 上执行其他线程。现在,我们有一些线程在 CPU 1 上运行;一些其他线程释放了锁,现在操作系统必须恢复线程#1的执行。因此,它在当前空闲的 CPU 上恢复其执行,例如 CPU2。

这导致 CPU 缓存未命中,因此在释放互斥锁后,代码运行速度略慢。通常情况下,情况并不那么糟糕,因为一个好的操作系统会尽力在相同的 CPU 上恢复线程。不幸的是,这样的操作系统特定优化并不总是可能的。减少关键部分的数量和大小以减少线程暂停和缓存未命中的机会。

不要尝试在同一线程中两次锁定boost::mutex变量;这将导致死锁。如果需要从单个线程多次锁定互斥锁,请改用<boost/thread/recursive_mutex.hpp>头文件中的boost::recursive_mutex。多次锁定它不会导致死锁。boost::recursive_mutex只有在每次lock()调用后调用一次unlock()后才释放锁。当不需要时避免使用boost::recursive_mutex,因为它比boost::mutex慢,通常表示糟糕的代码流设计。

boost::mutexboost::recursive_mutexboost::lock_guard类已被接受为 C++11 标准库,并且您可以在std::命名空间的<mutex>头文件中找到它们。Boost 版本和标准库版本之间没有太大的区别。Boost 版本可能具有一些扩展(在官方文档中标记为EXTENSION),并且提供更好的可移植性,因为它们甚至可以在 C++11 之前的编译器上使用。

另请参阅

  • 下一个示例将为您提供有关如何使此示例更快(更短)的想法。

  • 阅读本章的第一个示例以获取有关boost::thread类的更多信息。官方文档boost.org/libs/thread也可能对您有所帮助。

  • 要获取有关为什么第一个示例失败以及多处理器如何使用共享资源的更多信息,请参阅www.rdrop.com/users/paulmck/scalability/paper/whymb.2010.07.23a.pdf上的Memory Barriers: a Hardware View for Software Hackers。请注意,这是一个难题。

使用原子操作快速访问共享资源

在前一个配方中,我们看到了如何安全地从不同线程访问一个共同的资源。但在那个配方中,我们只是做了两个系统调用(在锁定和解锁mutex中)来获取整数的值:

{   // Critical section begin.
    boost::lock_guard<boost::mutex> lock(i_mutex); 
    i_snapshot = ++ shared_i; 
}   // Critical section end.

这看起来很糟糕和慢!我们能让前一个配方中的代码更好吗?

准备工作

阅读第一个配方就足够开始这个配方了。一些关于多线程的基本知识将会很有帮助。

如何做...

让我们看看如何改进我们之前的例子:

  1. 现在,我们需要不同的头文件:
#include <cassert> 
#include <cstddef> 
#include <iostream>

#include <boost/thread/thread.hpp> 
#include <boost/atomic.hpp> 
  1. 需要改变shared_i的类型:
boost::atomic<int> shared_i(0); 
  1. 移除所有的boost::lock_guard变量:
void do_inc() {
    for (std::size_t i = 0; i < 30000; ++i) {
        const int i_snapshot = ++ shared_i;

        // Do some work with i_snapshot.
        // ...
    }
}

void do_dec() {
    for (std::size_t i = 0; i < 30000; ++i) {
        const int i_snapshot = -- shared_i;

        // Do some work with i_snapshot.
        // ...
    }
}
  1. 就是这样!现在它可以工作了:
int main() {
    boost::thread t1(&do_inc);
    boost::thread t2(&do_dec);

    t1.join();
    t2.join();

    assert(shared_i == 0);
    std::cout << "shared_i == " << shared_i << std::endl;

    assert(shared_i.is_lock_free());
}

它是如何工作的...

处理器提供特定的原子操作,不会受到其他处理器或处理器核心的干扰。这些操作对系统来说似乎是瞬间发生的。Boost.Atomic提供了包装系统特定原子操作的类,与编译器合作以禁用可能破坏变量的多线程工作的优化,并提供一个统一的可移植接口来处理原子操作。如果两个不同线程同时开始对同一内存位置的原子操作,其中一个操作会等待直到另一个操作完成,然后重用前一个操作的结果。

换句话说,可以安全地同时从不同线程使用boost::atomic<>变量。系统中对原子变量的每个操作都被视为单个事务。系统中对原子变量的一系列操作被视为一系列独立的事务:

--shared_i;    // Transaction #1 
// Some other may change value of `shared_i`!!
++shared_i;    // Transaction #2 

永远不要避免对多个线程修改的变量进行同步。即使变量是bool,你所做的只是读取或写入true/false!编译器有权利优化掉所有的存储和读取,以一百万种无法想象的方式破坏你的代码。猜猜一个好的雇主会惩罚谁?(编译器不是这个问题的正确答案!)

还有更多...

Boost.Atomic库只能处理 POD 类型;否则,行为是未定义的。一些平台/处理器不提供某些类型的原子操作,因此Boost.Atomic使用boost::mutex来模拟原子行为。如果类型特定的宏设置为2,原子类型就不使用boost::mutex

#include <boost/static_assert.hpp> 
BOOST_STATIC_ASSERT(BOOST_ATOMIC_INT_LOCK_FREE == 2); 

boost::atomic<T>::is_lock_free成员函数取决于运行时,因此不适合用于编译时检查,但在运行时检查足够时可能提供更可读的语法:

assert(shared_i.is_lock_free()); 

原子操作比互斥锁快得多,但仍然比非原子操作慢得多。如果我们比较使用互斥锁的配方的执行时间(0:00.08 秒)和本配方中前面示例的执行时间(0:00.02 秒),我们会看到差异(在 30,0000 次迭代中进行测试)。

所有已知的标准库实现都存在原子操作的问题。所有的都有!不要编写自己的原子操作。如果你认为你自己的原子操作实现会更好,而且你希望浪费一些时间--写下来,使用特殊工具进行检查,然后再考虑。直到你明白你错了。

符合 C++11 标准的编译器应该在std::命名空间的<atomic>头文件中具有所有原子类、typedefs和宏。如果编译器正确支持 C++11 内存模型并且专门训练以优化std::atomic变量,那么特定于编译器的std::atomic实现可能比 Boost 的版本更快。

另请参阅

boost.org/libs/atomic的官方文档可能会给你更多例子和一些关于这个主题的理论信息。

创建 work_queue 类

让我们称没有参数的函数对象为任务。

typedef boost::function<void()> task_t; 

现在,想象一种情况,我们有一些负责发布任务的线程和一些负责执行发布的任务的线程。我们需要设计一个可以安全地被这两种类型的线程使用的类。这个类必须具有以下函数:

  • 获取一个任务或等待任务直到被另一个线程发布

  • 检查并获取任务(如果有任务则返回一个空任务)

  • 发布任务

准备就绪

确保你对boost::threadstd::thread感到舒适,了解互斥锁的基础知识,并且了解boost::functionstd::function

如何做...

我们要实现的类与std::queue<task_t>的功能相似,但也具有线程同步。让我们开始:

  1. 我们需要以下的头文件和成员:
#include <deque>
#include <boost/function.hpp>
#include <boost/thread/mutex.hpp>
#include <boost/thread/locks.hpp>
#include <boost/thread/condition_variable.hpp>

class work_queue {
public:
    typedef boost::function<void()> task_type;type;

private:
    std::deque<task_type> tasks_;
    boost::mutex tasks_mutex_;
    boost::condition_variable cond_;
  1. 将任务放入队列的函数必须像这样:
public:
    void push_task(const task_type& task) {
        boost::unique_lock<boost::mutex> lock(tasks_mutex_);
        tasks_.push_back(task);
        lock.unlock();

        cond_.notify_one();
    }
  1. 一个非阻塞的函数,用于获取推送的任务或空任务(如果没有任务)
    task_type try_pop_task() {
        task_type ret;
        boost::lock_guard<boost::mutex> lock(tasks_mutex_);
        if (!tasks_.empty()) {
            ret = tasks_.front();
            tasks_.pop_front();
        }

        return ret;
    }
  1. 用于获取推送的任务或在任务被另一个线程推送时阻塞的阻塞函数:
    task_type pop_task() {
        boost::unique_lock<boost::mutex> lock(tasks_mutex_);
        while (tasks_.empty()) {
            cond_.wait(lock);
        }

        task_type ret = tasks_.front();
        tasks_.pop_front();

        return ret;
    }
}; 

下面是work_queue类的使用方法:

#include <boost/thread/thread.hpp>

work_queue g_queue;

void some_task();
const std::size_t tests_tasks_count = 3000 /*000*/;

void pusher() {
    for (std::size_t i = 0; i < tests_tasks_count; ++i) {
        g_queue.push_task(&some_task);
    }
}

void popper_sync() {
    for (std::size_t i = 0; i < tests_tasks_count; ++i) {
        work_queue::task_type t = g_queue.pop_task();
        t();         // Executing task.
    }
}

int main() {
    boost::thread pop_sync1(&popper_sync);
    boost::thread pop_sync2(&popper_sync);
    boost::thread pop_sync3(&popper_sync);

    boost::thread push1(&pusher);
    boost::thread push2(&pusher);
    boost::thread push3(&pusher);

    // Waiting for all the tasks to push.
    push1.join();
    push2.join();
    push3.join();
    g_queue.flush(); 

    // Waiting for all the tasks to pop.
    pop_sync1.join();
    pop_sync2.join();
    pop_sync3.join();

    // Asserting that no tasks remained,
    // and falling though without blocking.
    assert(!g_queue.try_pop_task());

    g_queue.push_task(&some_task);

    // Asserting that there is a task,
    // and falling though without blocking.
    assert(g_queue.try_pop_task());
}

它是如何工作的...

在这个例子中,我们看到了一个新的 RAII 类boost::unique_lock。它只是一个boost::lock_guard类,具有额外的功能来显式解锁和锁定互斥锁。

回到我们的work_queue类。让我们从pop_task()函数开始。一开始,我们会获取一个锁并检查是否有可用的任务。如果有任务,我们就返回它;否则,会调用cond_.wait(lock)。这个方法会原子性地解锁锁,并暂停执行线程,直到其他线程通知当前线程。

现在,让我们来看一下push_task方法。在这个方法中,我们也会获取一个锁,将任务推入tasks_.queue,解锁锁,并调用cond_.notify_one(),这会唤醒等待在cond_.wait(lock)中的线程(如果有的话)。因此,在这之后,如果有线程在pop_task()方法中等待条件变量,那么线程将继续执行,深入到cond_.wait(lock)中的lock.lock(),并在while中检查tasks_empty()。因为我们刚刚在tasks_中添加了一个任务,所以我们会从while循环中退出,解锁<mutex>lock变量超出了作用域),并返回一个任务。

你必须在循环中检查条件,而不仅仅是在if语句中!if语句会导致错误,因为操作系统有时可能会在没有用户的通知调用的情况下唤醒线程。

还有更多...

请注意,在调用notify_one()之前,我们明确解锁了互斥锁。然而,即使不解锁,我们的例子仍然可以工作。

但是,在这种情况下,唤醒的线程可能在尝试在cond_wait(lock)中的lock.lock()时再次被阻塞,这会导致更多的上下文切换和更差的性能。

tests_tasks_count设置为3000000,并且不进行显式解锁,这个例子运行了 7 秒:

 $time -f E ./work_queue
 0:07.38

进行显式解锁后,这个例子运行了 5 秒:

 $ time -f E ./work_queue 
 0:05.39

你还可以使用cond_.notify_all()来通知所有等待特定条件变量的线程。

一些极端的操作系统在 Boost 1.64 版本之前(github.com/boostorg/th…

void flush() { boost::lock_guard<boost::mutex> lock(tasks_mutex_); cond_.notify_all(); }

当你完成了将任务推入队列的操作时,请调用flush()来强制唤醒所有线程。

C++11 标准在<condition_variable>头文件中声明了std::condition_variable,在<mutex>头文件中声明了std::unique_lock。如果你使用 C++03 编译器,可以使用 Boost 版本,或者使用 Boost 的一些扩展。

通过添加对右值引用的支持并调用std::move(tasks_.front())work_queue类可以得到显着改进。这将使关键部分的代码更快,减少线程、挂起和唤醒,减少缓存未命中,从而提高性能。

另请参阅

  • 本章的前三个配方提供了关于Boost.Thread的许多有用信息

  • 官方文档可能会给您更多的例子和一些关于这个主题的理论信息;它可以在boost.org/libs/thread找到

多读者单写者锁

想象一下,我们正在开发一些在线服务。我们有一个无序映射的注册用户,每个用户都有一些属性。这个集合被许多线程访问,但很少被修改。对以下集合的所有操作都是线程安全的:

#include <unordered_map> 
#include <boost/thread/mutex.hpp> 
#include <boost/thread/locks.hpp> 

struct user_info {
    std::string address;
    unsigned short age;

    // Other parameters
    // ...
};

class users_online {
    typedef boost::mutex mutex_t;

    mutable mutex_t                             users_mutex_;
    std::unordered_map<std::string, user_info>  users_;

public:
    bool is_online(const std::string& username) const {
        boost::lock_guard<mutex_t> lock(users_mutex_);
        return users_.find(username) != users_.end();
    }

    std::string get_address(const std::string& username) const {
        boost::lock_guard<mutex_t> lock(users_mutex_);
        return users_.at(username).address;
    }

    void set_online(const std::string& username, user_info&& data) {
        boost::lock_guard<mutex_t> lock(users_mutex_);
        users_.emplace(username, std::move(data));
    }

    // Other methods:
    // ...
};

不幸的是,我们的在线服务在某种程度上很慢,分析器显示问题出在users_online类中。任何操作都会在mutex_变量上获得独占锁,因此即使获取资源也会导致在锁定的互斥锁上等待。由于一些资源很难复制,关键部分消耗了大量时间,从而减慢了对users_online类的任何操作。

不幸的是,项目要求不允许我们重新设计类。我们能否在不更改接口的情况下加快速度?

准备就绪

确保您对boost::threadstd::thread感到满意,并了解互斥锁的基础知识。

如何做...

这可能会有所帮助:

boost::shared_mutex替换boost::mutex。对于不修改数据的方法,用boost::shared_lock替换boost::unique_locks

#include <boost/thread/shared_mutex.hpp> 

class users_online {
    typedef boost::shared_mutex mutex_t;

    mutable mutex_t                             users_mutex_;
    std::unordered_map<std::string, user_info>  users_;

public:
    bool is_online(const std::string& username) const {
        boost::shared_lock<mutex_t> lock(users_mutex_);
        return users_.find(username) != users_.end();
    }

    std::string get_address(const std::string& username) const {
        boost::shared_guard<mutex_t> lock(users_mutex_);
        return users_.at(username).address;
    }

    void set_online(const std::string& username, user_info&& data) {
        boost::lock_guard<mutex_t> lock(users_mutex_);
        users_.emplace(username, std::move(data));
    }

    // Other methods:
    // ...
};

工作原理...

如果这些线程不修改数据,我们可以允许多个线程同时从中获取数据。我们只需要独占拥有互斥锁,如果我们要修改由它保护的数据。在所有其他情况下,允许对数据进行同时访问。这就是boost::shared_mutex的设计目的。它允许共享锁定(读锁定),允许对资源进行多个同时访问。

当我们尝试对共享锁定的资源进行独占锁定时,操作将被阻塞,直到没有剩余的读锁,然后才能对该资源进行独占锁定,迫使新的共享锁等待直到独占锁被释放。boost::shared_lock用于读取和写入的锁定比通常的boost::mutex锁定要慢得多。除非您确定没有好的方法重新设计您的代码,并且确定boost::shared_lock会加快速度,否则不要使用boost::shared_lock

一些读者可能是第一次看到mutable关键字。这个关键字可以应用于非静态和非常量的类成员。mutable数据成员可以在常量成员函数中修改,通常用于互斥锁和其他与类逻辑无直接关系的辅助变量。

还有更多...

当您只需要独占锁时,不要使用boost::shared_mutex,因为它比通常的boost::mutex类更慢。

直到 C++14 之前,C++中还没有共享互斥锁。shared_timed_mutexshared_lockstd::命名空间的<shared_mutex>头文件中定义。它们的性能特征接近 Boost 版本,因此应用所有前面的性能注意事项。

C++17 有一个shared_mutex,可能比shared_timed_mutex稍快,因为它不提供定时锁定的手段。这可能会节省一些宝贵的纳秒。

另请参阅

创建每个线程唯一的变量

让我们来看看创建 work_queue 类的配方。那里的每个任务都可以在许多线程中的一个中执行,我们不知道在哪一个中执行。想象一下,我们想使用某个连接发送执行任务的结果:

#include <boost/noncopyable.hpp>

class connection: boost::noncopyable {
public:
    // Opening a connection is a slow operation
    void open();

    void send_result(int result);

    // Other methods
    // ...
};

我们有以下解决方案:

  • 在需要发送数据时打开新连接(这非常慢)

  • 每个线程只有一个连接,并在互斥体中包装它们(这也很慢)

  • 拥有一个连接池,在线程安全的方式下从中获取连接并使用它(需要大量编码,但这种解决方案很快)

  • 每个线程只有一个连接(快速且简单实现)

那么,我们如何实现最后的解决方案?

准备工作

需要基本的线程知识。

如何做...

是时候创建一个线程本地变量了。在connection类定义之后的头文件中声明一个函数:

connection& get_connection();

使您的源文件看起来像这样:

#include <boost/thread/tss.hpp>
boost::thread_specific_ptr<connection> connection_ptr;

connection& get_connection() {
    connection* p = connection_ptr.get();
    if (!p) {
        connection_ptr.reset(new connection);
        p = connection_ptr.get();
        p->open();
    }

    return *p;
}

完成。使用特定于线程的资源从未如此简单:

void task() {
    int result;
    // Some computations go there.
    // ...

    // Sending the result:
    get_connection().send_result(result);
}

工作原理...

boost::thread_specific_ptr变量为每个线程保存一个单独的指针。最初,此指针等于nullptr;这就是为什么我们检查!p并在其为nullptr时打开连接。

因此,当我们从已经初始化指针的线程进入get_connection()时,!p返回值为false,我们返回已经打开的连接。

在线程退出时调用存储在connection_ptr变量中的指针的delete,因此我们不需要担心内存泄漏。

还有更多...

您可以提供自己的清理函数,该函数将在线程退出时调用,而不是调用delete。清理函数必须具有void (*cleanup_function)(T*)签名,并且必须在boost::thread_specific_ptr构造期间传递。

C++11 有一个特殊的关键字thread_local,用于声明具有线程本地存储期的变量。C++11 没有thread_specific_ptr类,但您可以在支持thread_local的编译器上使用thread_local Tthread_local std::unique_ptr<T>来实现相同的行为。boost::thread_specific_ptr适用于 C++11 之前的编译器,而thread_local则不适用。

C++17 有inline变量,您可以在头文件中使用inlinethread_local声明线程本地变量。

另请参阅

中断线程

有时,我们需要终止消耗了太多资源或执行时间过长的线程。例如,某些解析器在一个线程中工作(并且积极使用Boost.Thread),但我们已经从中获取了所需数量的数据,因此可以停止解析。这是存根:

int main() {
    boost::thread parser_thread(&do_parse);

    // ...

    if (stop_parsing) {
        // No more parsing required.
        // TODO: Stop the parser!
    }

    // ...

    parser_thread.join();
}

我们如何做?

准备工作

这个配方几乎不需要任何东西。您只需要至少有基本的线程知识。

如何做...

我们可以通过中断来停止线程:

if (stop_parsing) { 
    // No more parsing required. 
    parser_thread.interrupt(); 
}

工作原理...

Boost.Thread在其中提供了一些预定义的中断点,线程通过interrupt()调用来检查是否被中断。如果线程被中断,将抛出异常boost::thread_interrupted。当异常通过do_parse()内部传播时,它会调用所有资源的析构函数,就像典型的异常一样。boost::thread_interrupted异常在Boost.Thread库中被特殊对待,对于该异常,允许离开线程函数(例如我们的示例中的do_parse())。当异常离开线程函数时,它被boost::thread内部捕获,并被视为取消线程的请求。

boost::thread_interrupted不是从std::exception派生的!如果通过类型或引用std::exception捕获异常,中断将有效。但是,如果通过catch (...)捕获异常并且不重新抛出它,中断将无效。

正如我们从本章的第一个示例中所知道的,如果传递给线程的函数没有捕获异常并且异常离开函数范围,应用程序将终止。boost::thread_interrupted是唯一的例外;它可以离开函数范围,并且不会std::terminate()应用程序。

还有更多...

Boost.Thread库的中断点在官方文档中列出。一般来说,一切阻塞都会检查中断。

我们也可以在任何地方手动添加中断点。我们只需要调用boost::this_thread::interruption_point()

void do_parse() {
    while (not_end_of_parsing) {
        // If current thread was interrupted, the following
        // line will throw an boost::thread_interrupted.
        boost::this_thread::interruption_point();

        // Some parsing goes here.
        // ...
    }
}

如果项目不需要中断,定义BOOST_THREAD_DONT_PROVIDE_INTERRUPTIONS会提供一点性能提升,并完全禁用线程中断。

C++11 没有线程中断,但可以使用原子操作部分模拟它们:

  • 创建一个原子bool变量

  • 在线程中检查原子变量,如果发生变化,则抛出异常

  • 不要忘记在传递给线程的函数中捕获异常(否则你的应用程序将终止)

但是,如果代码在条件变量或睡眠方法中等待,这将无济于事。

另请参阅

操作一组线程

那些试图自己重复所有示例或者试验线程的读者,可能已经厌倦了编写以下代码来启动和加入线程:

#include <boost/thread.hpp>

void some_function();

void sample() {
    boost::thread t1(&some_function);
    boost::thread t2(&some_function);
    boost::thread t3(&some_function);

    // ... 

    t1.join();
    t2.join();
    t3.join();
} 

也许有更好的方法来做这个?

准备工作

对线程的基本知识将足够应对这个问题。

如何做...

我们可以使用boost::thread_group类来操作一组线程。

  1. 构造一个boost::thread_group变量:
#include <boost/thread.hpp>

int main() {
    boost::thread_group threads;
  1. 在前面的变量中创建线程:
    // Launching 10 threads.
    for (unsigned i = 0; i < 10; ++i) {
        threads.create_thread(&some_function);
    }
  1. 现在,你可以在boost::thread_group中为所有线程调用函数:
    // Joining all threads.
    threads.join_all();

    // We can also interrupt all of them
    // by calling threads.interrupt_all();
}

它是如何工作的...

boost::thread_group变量只是保存了所有构造或移动到其中的线程,并可以向所有线程发送一些调用。

还有更多...

C++11 没有thread_group类;这是 Boost 特有的。

另请参阅

Boost.Thread的官方文档可能会给你带来很多其他有用的类,这些类在本章节中没有描述;请访问boost.org/libs/thread

安全地初始化共享变量

想象一下,我们正在设计一个安全关键的类,该类从多个线程中使用,从服务器接收答案,对其进行后处理,并输出响应:

struct postprocessor {
    typedef std::vector<std::string> answer_t;

    // Concurrent calls on the same variable are safe.
    answer_t act(const std::string& in) const {
        if (in.empty()) {
            // Extremely rare condition.
            return read_defaults();
        }

        // ...
    }
};

注意return read_defaults();这一行。可能会出现服务器由于网络问题或其他问题而无法响应的情况。在这种情况下,我们尝试从文件中读取默认值:

// Executes for a long time.
std::vector<std::string> read_defaults();

从前面的代码中,我们遇到了问题:服务器可能在一段显著的时间内无法访问,并且在所有这段时间内,我们将在每次act调用时重新读取文件。这显著影响了性能。

我们可以尝试通过在类内部存储default_来修复它:

struct postprocessor {
    typedef std::vector<std::string> answer_t;

private:
    answer_t default_;

public:
    postprocessor()
        : default_(read_defaults())
    {}

    // Concurrent calls on the same variable are safe.
    answer_t act(const std::string& in) const {
        if (in.empty()) {
            // Extremely rare condition.
            return default_;
        }

        // ...
    }
};

这也不是一个完美的解决方案:我们不知道用户构造了多少个postprocessor类的实例,并且我们在可能在运行过程中不需要的默认值上浪费了内存。

因此,我们必须在第一次远程服务器失败时并发安全地读取和存储数据,并且在下一次失败时不再读取。有许多方法可以做到这一点,但让我们看看最正确的方法。

做好准备

对于这个配方,基本的线程知识已经足够了。

如何做...

  1. 我们必须添加变量来存储默认值已经初始化的信息,以及一个变量来存储默认值:
#include <boost/thread/once.hpp>

struct postprocessor {
    typedef std::vector<std::string> answer_t;

private:
    mutable boost::once_flag default_flag_;
    mutable answer_t default_;

变量是mutable,因为我们将在const成员函数内部修改它们。

  1. 让我们初始化我们的变量:
public:
    postprocessor()
        : default_flag_(BOOST_ONCE_INIT)
        , default_()
    {}
  1. 最后,让我们改变act函数:
    // Concurrent calls on the same variable are safe.
    answer_t act(const std::string& in) const {
        answer_t ret;
        if (in.empty()) {
            // Extremely rare condition.
            boost::call_once(default_flag_, [this]() {
                this->default_ = read_defaults();
            });
            return default_;
        }

        // ...
        return ret;
    }
};

工作原理...

简而言之,boost::call_onceboost::once_flag确保第二个参数作为函数只执行一次。

boost::call_once函数同步调用作为第二个参数传递的函数Fboost::call_onceboost::once_flag确保在同一个once_flag上有两个或更多并发调用时,只有一个对函数F的调用会进行,确保只有一次对F的成功调用。

如果对函数F的调用没有抛出异常离开F的主体,那么boost::call_once假定调用成功,并将该信息存储在boost::once_flag内。对具有相同boost::once_flagboost::call_once的任何后续调用都不起作用。

不要忘记使用BOOST_ONCE_INIT宏初始化boost::once_flag

还有更多...

boost::call_once可以将参数传递给要调用的函数:

#include <iostream>

void once_printer(int i) {
    static boost::once_flag flag = BOOST_ONCE_INIT;
    boost::call_once(
        flag,
        [](int v) { std::cout << "Print once " << v << '\n'; },
        i // <=== Passed to lambda from above.
    );

    // ...
}

现在,如果我们在循环中调用once_printer函数:

int main() {
    for (unsigned i = 0; i < 10; ++i) {
        once_printer(i);
    }
}

只有一行将被输出:

Print once 0

C++11 在<mutex>头文件中有std::call_oncestd::once_flag。与 Boost 版本不同,标准库版本的once_flag不需要通过宏进行初始化,它有一个 constexpr 构造函数。通常情况下,如果必须支持旧编译器,则可以使用 Boost 版本。

2015 年之前的 Visual Studio 发行的std::call_once实现效率不佳,比 Boost 版本慢十多倍。如果不使用现代编译器,请使用boost::call_once

另请参阅

Boost.Thread文档提供了许多不同情况下的很好的例子。可以在boost.org/libs/thread找到。

锁定多个互斥体

在接下来的几段中,你将成为编写游戏的人之一。恭喜,你可以在工作中玩游戏!

您正在开发一个服务器,必须编写代码来在两个用户之间交换战利品:

class user {
    boost::mutex        loot_mutex_;
    std::vector<item_t> loot_;
public:
    // ...

    void exchange_loot(user& u);
};

每个用户操作都可能由服务器上的不同线程并发处理,因此您必须通过互斥体保护资源。初级开发人员试图解决问题,但他的解决方案不起作用:

void user::exchange_loot(user& u) {
    // Terribly wrong!!! ABBA deadlocks.
    boost::lock_guard<boost::mutex> l0(loot_mutex_);
    boost::lock_guard<boost::mutex> l1(u.loot_mutex_);
    loot_.swap(u.loot_);
}

上面代码中的问题是一个众所周知的ABBA 死锁问题。想象一下线程 1锁定互斥锁 A线程 2锁定互斥锁 B。现在线程 1尝试锁定已经被锁定的互斥锁 B,而线程 2尝试锁定已经被锁定的互斥锁 A。这导致两个线程相互无限期地锁定,因为它们需要另一个线程拥有的资源才能继续,而另一个线程则在等待当前线程拥有的资源。

现在,如果user1user2同时为对方调用exchange_loot,那么我们可能会出现这样的情况,即user1.exchange_loot(user2)调用锁定了user1.loot_mutex_,而user2.exchange_loot(user1)调用锁定了user2.loot_mutex_user1.exchange_loot(user2)会无限等待尝试锁定user2.loot_mutex_,而user2.exchange_loot(user1)会无限等待尝试锁定user1.loot_mutex_

准备工作

对线程和互斥锁的基本知识就足够了。

如何做...

对此问题有两个主要的开箱即用的解决方案:

  1. 需要编译器支持可变模板的短模板:
#include <boost/thread/lock_factories.hpp>

void user::exchange_loot(user& u) {
    typedef boost::unique_lock<boost::mutex> lock_t;

    std::tuple<lock_t, lock_t> l = boost::make_unique_locks(
        loot_mutex_, u.loot_mutex_
    );

    loot_.swap(u.loot_);
}

使用auto的相同代码:

#include <boost/thread/lock_factories.hpp>

void user::exchange_loot(user& u) {
    auto l = boost::make_unique_locks(
        loot_mutex_, u.loot_mutex_
    );

    loot_.swap(u.loot_);
}
  1. 可移植解决方案:
#include <boost/thread/locks.hpp>

void user::exchange_loot(user& u) {
    typedef boost::unique_lock<boost::mutex> lock_t;

    lock_t l0(loot_mutex_, boost::defer_lock);
    lock_t l1(u.loot_mutex_, boost::defer_lock);
    boost::lock(l0, l1);

    loot_.swap(u.loot_);
}

它是如何工作的...

核心思想是以某种方式对互斥锁进行排序,并始终按照特定顺序锁定它们。在这种情况下,不可能出现 ABBA 问题,因为所有线程在锁定互斥锁A之前始终会锁定互斥锁B。通常会使用其他死锁避免算法,但为了简单起见,我们假设了互斥锁的排序。

在第一个例子中,我们使用了boost::make_unique_locks,它总是以特定顺序锁定线程并返回一个持有锁的元组。

在第二个例子中,我们手动创建了锁,但由于传递了boost::defer_lock参数,没有锁定它们。实际的锁定发生在boost::lock(l0, l1)调用中,它以预定义的顺序锁定了互斥锁。

现在,如果user1user2同时为对方调用exchange_loot,那么user1.exchange_loot(user2)user2.exchange_loot(user1)的调用都会尝试首先锁定user1.loot_mutex_,或者两者都会尝试首先锁定user2.loot_mutex_。这取决于运行时。

还有更多...

boost::make_unique_locksboost::lock函数可能接受超过 2 个锁或互斥锁,因此您可以在需要同时锁定两个以上互斥锁的更高级情况下使用它们。

C++11 在头文件<mutex>中定义了一个std::lock函数,其行为与boost::lock函数完全相同。

C++17 有一个更美观的解决方案:

#include <mutex>

void user::exchange_loot(user& u) {
    std::scoped_lock l(loot_mutex_, u.loot_mutex_);
    loot_.swap(u.loot_);
}

在上面的代码中,std::scoped_lock是一个接受可变数量锁的类。它具有可变模板参数,这些参数可以从 C++17 的推导指南中自动推导出来。上面例子中std::scoped_lock的实际类型是:

std::scoped_lock<std::mutex, std::mutex>

std::scoped_lock在构造期间持有所有传递的互斥锁的锁,并避免了死锁。换句话说,它的工作原理类似于第一个例子,但看起来更好一些。

另请参阅

Boost.Thread的官方文档可能会给您带来很多其他有用的类,这些类在本章中没有描述;请访问boost.org/libs/thread.

操作任务

在这一章中,我们将涵盖:

  • 为任意数据类型处理注册任务

  • 创建定时器并将定时器事件作为任务处理

  • 将网络通信作为任务

  • 接受传入连接

  • 并行执行不同的任务

  • 管道任务处理

  • 创建非阻塞屏障

  • 存储异常并从中创建任务

  • 获取和处理系统信号作为任务

介绍

这一章都是关于任务的。我们将称函数对象为任务,因为这样更简洁,更能反映它将要做的事情。这一章的主要思想是,我们可以将所有的处理、计算和交互分解为函数对象(任务),并几乎独立地处理每一个任务。此外,我们可能不会在一些慢操作上阻塞,比如从套接字接收数据或等待超时,而是提供一个回调任务并继续处理其他任务。一旦操作系统完成慢操作,我们的回调就会被执行。

理解示例的最佳方法是通过修改、运行和扩展来玩耍。网站apolukhin.github.io/Boost-Cookbook/中有本章的所有示例,甚至可以在线玩耍一些示例。

开始之前

这一章至少需要对第一、第二和第五章有基本了解。还需要对 C++11 的右值引用和 lambda 有基本了解。

为任意数据类型处理注册任务

首先,让我们来处理保存所有任务并提供它们执行方法的类。在第五章的多线程,创建 work_queue 类的食谱中,我们已经在做类似的事情,但以下一些问题尚未解决:

  • work_queue类只存储和返回任务,但我们还需要执行现有任务。

  • 任务可能会抛出异常。如果它们离开任务边界,我们需要捕获和处理异常。

  • 任务可能不会注意到线程中断。下一个任务可能会收到中断。

  • 我们需要一种方法来停止任务的处理。

准备工作

此食谱需要链接boost_systemboost_thread库。还需要对Boost.Thread有基本了解。

如何做...

在这个食谱中,我们使用boost::asio::io_service代替了上一章的work_queue。这样做是有原因的,我们将在接下来的食谱中看到。

  1. 让我们从包装用户任务的结构开始:
#include <boost/thread/thread.hpp>
#include <iostream>

namespace detail {

template <class T>
struct task_wrapped {
private:
    T task_unwrapped_;

public:
    explicit task_wrapped(const T& f)
        : task_unwrapped_(f)
    {}

    void operator()() const {
        // Resetting interruption.
        try {
            boost::this_thread::interruption_point();
        } catch(const boost::thread_interrupted&){}

        try {
            // Executing task.
            task_unwrapped_();
        } catch (const std::exception& e) {
            std::cerr<< "Exception: " << e.what() << '\n';
        } catch (const boost::thread_interrupted&) {
            std::cerr<< "Thread interrupted\n";
        } catch (...) {
            std::cerr<< "Unknown exception\n";
        }
    }
};

} // namespace detail
  1. 为了方便使用,我们将创建一个函数,从用户的函数对象产生task_wrapped
namespace detail {

template <class T>
task_wrapped<T> make_task_wrapped(const T& task_unwrapped) {
    return task_wrapped<T>(task_unwrapped);
}

} // namespace detail
  1. 现在,我们准备编写tasks_processor类:
#include <boost/asio/io_service.hpp> 

class tasks_processor: private boost::noncopyable {
protected:
    static boost::asio::io_service& get_ios() {
        static boost::asio::io_service ios;
        static boost::asio::io_service::work work(ios);

        return ios;
    }
  1. 让我们添加push_task方法:
public:
    template <class T>
    static void push_task(const T& task_unwrapped) {
        get_ios().post(detail::make_task_wrapped(task_unwrapped));
    }
  1. 让我们通过添加启动和停止任务执行循环的成员函数来完成这个类:
    static void start() {
        get_ios().run();
    }

    static void stop() {
        get_ios().stop();
    }
}; // tasks_processor

完成!现在是时候测试我们的类了:

int func_test() {
    static int counter = 0;
    ++ counter;
    boost::this_thread::interruption_point();

    switch (counter) {
    case 3:
        throw std::logic_error("Just checking");

    case 10:
        // Emulation of thread interruption.
        // Caught inside task_wrapped and does not stop execution.
        throw boost::thread_interrupted();

    case 90:
        // Stopping the tasks_processor.
        tasks_processor::stop();
    }

    return counter;
}

main函数可能是这样的:

int main () {
    for (std::size_t i = 0; i < 100; ++i) {
        tasks_processor::push_task(&func_test);
    }

    // Processing was not started.
    assert(func_test() == 1);

    // We can also use lambda as a task.
    // Counting 2 + 2 asynchronously.
    int sum = 0;
    tasks_processor::push_task(
        [&sum]() { sum = 2 + 2; }
    );

    // Processing was not started.
    assert(sum == 0);

    // Does not throw, but blocks till
    // one of the tasks it is owning
    // calls tasks_processor::stop().
    tasks_processor::start();
    assert(func_test() == 91);
}

工作原理...

boost::asio::io_service变量可以存储和执行发布到它的任务。但我们可能不能直接将用户的任务发布到它,因为它们可能接收到针对其他任务的中断或抛出异常。这就是为什么我们将用户的任务包装在detail::task_wrapped结构中。它通过调用重置所有先前的中断:

try { 
    boost::this_thread::interruption_point(); 
} catch(const boost::thread_interrupted&){}

detail::task_wrappedtry{ } catch()块中执行任务,确保没有异常离开operator()边界。

看一下start()函数。boost::asio::io_service::run()开始处理发布到io_service变量的任务。如果没有调用boost::asio::io_service::run(),则不会执行发布的任务(可以在main()函数中看到)。可以通过调用boost::asio::io_service::stop()来停止任务处理。

如果boost::asio::io_service类从run()函数返回,表示没有剩余的任务,因此我们使用boost::asio::io_service::work的实例来强制它继续执行:

static boost::asio::io_service& get_ios() {
    static boost::asio::io_service ios;
    static boost::asio::io_service::work work(ios);

    return ios;
}

在预 C++11 编译器上,iostream类和变量(如std::cerrstd::cout)不是线程安全的,并且可能在 C++11 兼容的编译器上产生交错的字符。在实际项目中,必须使用额外的同步来获得可读的输出。为了简单起见,我们没有这样做。

还有更多...

C++17 标准库没有io_service。但是,Boost.Asio库的大部分内容被提议作为 Networking Technical Specification (TS)作为 C++的补充。

另请参阅

  • 本章中的以下示例将向您展示为什么我们选择boost::asio::io_service而不是使用我们在第五章**,多线程**中手写的代码

  • 您可以考虑阅读Boost.Asio的文档,获取一些示例、教程和类引用,网址为boost.org/libs/asio

  • 您还可以阅读Boost.Asio C++ Network Programming一书,该书对Boost.Asio进行了更顺畅的介绍,并涵盖了本书中未涵盖的一些细节

创建定时器并将定时器事件处理为任务

以指定的间隔检查某些内容是一个常见的任务。例如,我们需要每 5 秒检查一次某些会话的活动情况。对于这样的问题,有一些常见的解决方案:

  • 糟糕的解决方案创建一个线程进行检查,然后休眠 5 秒。这是一个糟糕的解决方案,会消耗大量系统资源,并且扩展性差。

  • 正确的解决方案使用特定于系统的 API 来异步操作定时器。这是一个更好的解决方案,需要一些工作,并且不具有可移植性,除非您使用Boost.Asio

准备工作

您必须知道如何使用 C++11 的右值引用和unique_ptr

这个示例是基于上一个示例的代码。请参阅本章的第一个示例,了解boost::asio::io_servicetask_queue类的信息。

将此示例与boost_systemboost_thread库链接。定义BOOST_ASIO_DISABLE_HANDLER_TYPE_REQUIREMENTS以绕过限制性库检查。

如何做...

我们只需通过添加新的方法来修改tasks_processor类,以在指定的时间运行任务。

  1. 让我们为我们的tasks_processor类添加一个延迟运行任务的方法:
class tasks_processor {
    // ...
public:
    template <class Time, class Func>
    static void run_delayed(Time duration_or_time, const Func& f) {
        std::unique_ptr<boost::asio::deadline_timer> timer(
            new boost::asio::deadline_timer(
                get_ios(), duration_or_time
            )
        );

        timer_ref.async_wait(
            detail::timer_task<Func>(
                std::move(timer),
                f
            )
        );
    }
};
  1. 最后一步,我们创建一个timer_task结构:
#include <boost/asio/io_service.hpp>
#include <boost/asio/deadline_timer.hpp>
#include <boost/system/error_code.hpp>
#include <memory>  // std::unique_ptr
#include <iostream>

namespace detail {

    template <class Functor>
    struct timer_task {
    private:
        std::unique_ptr<boost::asio::deadline_timer> timer_;
        task_wrapped<Functor> task_;

    public:
        explicit timer_task(
                std::unique_ptr<boost::asio::deadline_timer> timer,
                const Functor& task_unwrapped)
            : timer_(std::move(timer))
            , task_(task_unwrapped)
        {}

        void operator()(const boost::system::error_code& error) const {
            if (!error) {
                task_();
            } else {
                std::cerr << error << '\n';
            }
        }
    };

} // namespace detail

这就是我们如何使用新功能的方式:

int main () {
    const int seconds_to_wait = 3;
    int i = 0;

    tasks_processor::run_delayed(
        boost::posix_time::seconds(seconds_to_wait),
        test_functor(i)
    );

    tasks_processor::run_delayed(
        boost::posix_time::from_time_t(time(NULL) + 1),
        &test_func1
    );

    assert(i == 0);

    // Blocks till one of the tasks
    // calls tasks_processor::stop().
    tasks_processor::start();
}

其中test_functor是具有定义的operator()的结构,test_func1是一个函数:

struct test_functor {
    int& i_;

    explicit test_functor(int& i);

    void operator()() const {
        i_ = 1;
        tasks_processor::stop();
    }
};

void test_func1();

它是如何工作的...

简而言之,当经过指定的时间后,boost::asio::deadline_timer将任务推送到boost::asio::io_service类的实例中进行执行。

所有糟糕的东西都在run_delayed函数中:

    template <class Time, class Functor>
    static void run_delayed(Time duration_or_time, const Functor& f) {
        std::unique_ptr<boost::asio::deadline_timer> 
        timer( /* ... */ );

        boost::asio::deadline_timer& timer_ref = *timer;

        timer_ref.async_wait(
            detail::timer_task<Functor>(
                std::move(timer),
                f
            )
        );
    }

tasks_processor::run_delayed函数接受一个超时和一个在超时后调用的函数对象。在其中,创建了一个boost::asio::deadline_timer的唯一指针。boost::asio::deadline_timer保存了用于异步执行任务的特定于平台的内容。

Boost.Asio不会自动管理内存。库用户必须负责管理资源,通常是通过将资源保存在任务中。因此,如果我们需要一个定时器,并且希望在指定的超时后执行某个函数,我们必须将定时器的唯一指针移动到任务中,获取定时器的引用,并将任务传递给定时器。

我们在这一行中获取了deadline_timer的引用:

boost::asio::deadline_timer& timer_ref = *timer;

现在,我们创建一个detail::timer_task对象,该对象存储一个函数对象,并获取unique_ptr<boost::asio::deadline_timer>的所有权:

            detail::timer_task<Functor>(
                std::move(timer),
                f
            )

boost::asio::deadline_timer在触发之前不能被销毁,并且将其移动到timer_task函数对象中可以保证这一点。

最后,我们指示 boost::asio::deadline_timer 在请求的时间到达时将 timer_task 函数对象发布到 io_service 中。

timer_ref.async_wait( /* timer_task */ )

io_service 变量的引用被保留在 boost::asio::deadline_timer 变量中。这就是为什么它的构造函数需要一个 io_service 的引用来存储它,并在超时结束后将任务发布到它。

detail::timer_task::operator() 方法接受 boost::system::error_code,其中包含了等待时发生的错误描述。如果没有发生错误,我们调用用户的函数对象,该函数对象被包装以捕获异常(我们重用了第一个示例中的 detail::task_wrapped 结构)。

boost::asio::deadline_timer::async_wait 在等待超时时不会消耗 CPU 资源或执行线程。您可以简单地将一些任务推送到 io_service 中,它们将在超时被操作系统维护的同时开始执行:

作为一个经验法则:在 async_* 调用期间使用的所有资源必须存储在任务中。

还有更多...

一些古怪/古老的平台没有好的方式来实现定时器的 API,因此 Boost.Asio 库使用每个 io_service 的额外执行线程来模拟异步定时器的行为。没有其他方法可以做到这一点。

C++17 中没有类似于 Boost.Asio 的类;然而,Networking TS 中有 async_waittimer 类。

另请参阅

  • 阅读本章第一个示例将教会您如何使用 boost::asio::io_service 的基础知识。接下来的示例将为您提供更多关于 io_service 使用的示例,并向您展示如何使用 Boost.Asio 处理网络通信、信号和其他功能。

  • 您可以考虑查看 Boost.Asio 的文档,获取一些示例、教程和类引用,网址为 boost.org/libs/asio

网络通信作为一个任务

通过网络接收或发送数据是一个缓慢的操作。当机器接收数据包时,操作系统验证它们并将数据复制到用户指定的缓冲区中,可能会花费多秒钟。

我们可能会做很多工作,而不是等待!让我们修改我们的 tasks_processor 类,使其能够以异步方式发送和接收数据。非技术术语中,我们要求它至少从远程主机接收 N 字节,完成后调用我们的函数对象。顺便说一下,不要在此调用上阻塞。了解 libevlibevent 或 Node.js 的读者可能会在这个示例中找到很多熟悉的东西。

准备工作

这个示例基于前两个示例。请参阅本章的第一个示例,了解有关 boost::asio::io_servicetask_queue 类的信息。请参阅第二个示例,复习异步处理的基础知识。

将此示例与 boost_systemboost_thread 库链接起来。定义 BOOST_ASIO_DISABLE_HANDLER_TYPE_REQUIREMENTS 以绕过过于严格的库检查。

如何做...

让我们通过添加方法来创建连接来扩展前一个示例中的代码。

  1. 连接将由 connection_with_data 类表示。这个类保持了与远程主机的套接字和一个用于接收和发送数据的 std::string
#include <boost/asio/ip/tcp.hpp>
#include <boost/core/noncopyable.hpp>

struct connection_with_data: boost::noncopyable {
    boost::asio::ip::tcp::socket socket;
    std::string data;

    explicit connection_with_data(boost::asio::io_service& ios)
        : socket(ios) 
    {}

    void shutdown() {
        if (!socket.is_open()) {
            return;
        }

        boost::system::error_code ignore;
        socket.shutdown(
            boost::asio::ip::tcp::socket::shutdown_both,
            ignore
        );
        socket.close(ignore);
    }

    ~connection_with_data() {
        shutdown();
    }
};
  1. 与上一个示例一样,类将主要由唯一指针使用。让我们为简单起见添加一个 typedef
#include <memory> // std::unique_ptr

typedef std::unique_ptr<connection_with_data> connection_ptr;
  1. 前一个示例中的 tasks_processor 类拥有 boost::asio::io_service 对象。将其作为构建连接的工厂似乎是合理的:
class tasks_processor {
    // ...
public:
    static connection_ptr create_connection(
        const char* addr,
        unsigned short port_num)
    {
        connection_ptr c( new connection_with_data(get_ios()) );

        c->socket.connect(boost::asio::ip::tcp::endpoint(
            boost::asio::ip::address_v4::from_string(addr),
            port_num
        ));

        return c;
    }
};
  1. 以下是将数据异步写入远程主机的方法:
#include <boost/asio/write.hpp>

template <class T>
struct task_wrapped_with_connection;

template <class Functor>
void async_write_data(connection_ptr&& c, const Functor& f) {
    boost::asio::ip::tcp::socket& s = c->socket;
    std::string& d = c->data;

    boost::asio::async_write(
        s,
        boost::asio::buffer(d),
        task_wrapped_with_connection<Functor>(std::move(c), f)
    );
}
  1. 以下是从远程主机异步读取数据的方法:
#include <boost/asio/read.hpp>

template <class Functor>
void async_read_data(
    connection_ptr&& c,
    const Functor& f,
    std::size_t at_least_bytes)
{
    c->data.resize(at_least_bytes);
    c->data.resize(at_least_bytes);

    boost::asio::ip::tcp::socket& s = c->socket;
    std::string& d = c->data;
    char* p = (d.empty() ? 0 : &d[0]);

    boost::asio::async_read(
        s,
        boost::asio::buffer(p, d.size()),
        task_wrapped_with_connection<Functor>(std::move(c), f)
    );
}

template <class Functor>
void async_read_data_at_least(
    connection_ptr&& c,
    const Functor& f,
    std::size_t at_least_bytes,
    std::size_t at_most)
{
    std::string& d = c->data;
    d.resize(at_most);
    char* p = (at_most == 0 ? 0 : &d[0]);

    boost::asio::ip::tcp::socket& s = c->socket;

    boost::asio::async_read(
        s,
        boost::asio::buffer(p, at_most),
        boost::asio::transfer_at_least(at_least_bytes),
        task_wrapped_with_connection<Functor>(std::move(c), f)
    );
}
  1. 最后一部分是 task_wrapped_with_connection 类的定义:
template <class T>
struct task_wrapped_with_connection {
private:
    connection_ptr c_;
    T task_unwrapped_;

public:
    explicit task_wrapped_with_connection
    (connection_ptr&& c, const T& f)
        : c_(std::move(c))
        , task_unwrapped_(f)
    {}

    void operator()(
        const boost::system::error_code& error,
        std::size_t bytes_count)
    {
        c_->data.resize(bytes_count);
        task_unwrapped_(std::move(c_), error);
    }
};

完成!现在,库用户可以像这样使用前面的类来发送数据:

void send_auth() {
    connection_ptr soc = tasks_processor::create_connection(
        "127.0.0.1", g_port_num
    );
    soc->data = "auth_name";

    async_write_data(
        std::move(soc),
        &on_send
    );
}

用户也可以像这样使用它来接收数据:

void receive_auth_response(
    connection_ptr&& soc,
    const boost::system::error_code& err)
{
    if (err) {
        std::cerr << "Error on sending data: " 
        << err.message() << '\n';
        assert(false);
    }

    async_read_data(
        std::move(soc),
        &process_server_response,
        2
    );
}

这是库用户处理接收到的数据的方法:

void process_server_response(
        connection_ptr&& soc,
        const boost::system::error_code& err)
{
    if (err && err != boost::asio::error::eof) {
        std::cerr << "Client error on receive: "
        << err.message() << '\n';
        assert(false);
    }

    if (soc->data.size() != 2) {
        std::cerr << "Wrong bytes count\n";
        assert(false);
    }

    if (soc->data != "OK") {
        std::cerr << "Wrong response: " << soc->data << '\n';
        assert(false);
    }

    soc->shutdown();
    tasks_processor::stop();
}

工作原理...

Boost.Asio库不会直接管理资源和缓冲区。因此,如果我们想要一些简单的接口来读取和写入数据,最简单的解决方案就是将套接字和缓冲区绑定在一起以发送/接收数据。这就是connection_with_data类所做的事情。它包含一个boost::asio::ip::tcp::socket,这是Boost.Asio对本机套接字的包装,以及一个我们用作缓冲区的std::string变量。

boost::asio::ip::tcp::socket类的构造函数接受boost::asio::io_service,几乎所有Boost.Asio类都是如此。创建套接字后,它必须连接到某个远程端点:

        c->socket.connect(boost::asio::ip::tcp::endpoint(
            boost::asio::ip::address_v4::from_string(addr),
            port_num
        ));

看一下写函数。它接受一个指向connection_with_data类的唯一指针和函数对象f

#include <boost/asio/write.hpp>

template <class Functor>
void async_write_data(connection_ptr&& c, const Functor& f) {

在其中,我们获取了套接字和缓冲区的引用:

boost::asio::ip::tcp::socket& s = c->socket;
std::string& d = c->data;

然后,我们请求进行异步写入:

    boost::asio::async_write(
        s,
        boost::asio::buffer(d),
        task_wrapped_with_connection<Functor>(std::move(c), f)
    );
}

所有有趣的事情都发生在boost::asio::async_write函数中。就像定时器一样,异步调用立即返回而不执行函数。它只是告诉在某些操作完成后将回调任务发布到boost::asio::io_service中。boost::asio::io_service在调用io_service::run()方法的线程中执行我们的函数。以下图表说明了这一点:

现在,看一下task_wrapped_with_connection::operator()。它接受const boost::system::error_code& errorstd::size_t bytes_count,因为boost::asio::async_writeboost::asio::async_read函数在异步操作完成时传递这些参数。调用c_->data.resize(bytes_count);将缓冲区的大小调整为仅包含接收/写入的数据。最后,我们调用最初传递给async函数并存储为task_unwrapped_的回调。

这一切是关于什么?这一切都是为了简单地发送数据!现在,我们有一个async_write_data函数,它会将缓冲区中的数据异步写入套接字,并在操作完成时执行回调:

void on_send(connection_ptr&& soc, const boost::system::
error_code& err);

void connect_and_send() {
    connection_ptr s = tasks_processor::create_connection
    ("127.0.0.1", 80);

    s->data = "data_to_send";
    async_write_data(
        std::move(s),
        &on_send
    );
}

async_read_dataasync_write_data非常接近。它调整缓冲区的大小,创建一个task_wrapped_with_connection函数,并在异步操作完成时将其推送到is_service中。

注意async_read_data_at_least函数。在其中,对boost::asio::async_read有一个略有不同的调用:

boost::asio::async_read(
    s,
    boost::asio::buffer(p, at_most),
    boost::asio::transfer_at_least(at_least_bytes),
    task_wrapped_with_connection<Functor>(std::move(c), f)
);

它包含boost::asio::transfer_at_least(al_least_bytes)Boost.Asio有很多用于自定义读取和写入的函数对象。这个函数对象表示,在调用回调之前至少传输at_least_bytes字节。更多的字节是可以的,直到它们适合缓冲区

最后,让我们看一下其中一个回调函数:

void process_server_response(
        connection_ptr&& soc,
        const boost::system::error_code& err);

在这个例子中,回调函数必须接受connection_ptrboost::system::error_code变量。boost::system::error_code变量包含有关错误的信息。它有一个显式转换为bool运算符,所以检查错误的简单方法就是写if (err) { ... }。如果远程端结束传输并关闭套接字,err可能包含boost::asio::error::eof错误代码。这并不总是坏事。在我们的例子中,我们将其视为非错误行为:

    if (err && err != boost::asio::error::eof) {
        std::cerr << "Client error on receive: " 
        << err.message() << '\n';
        assert(false);
    }

因为我们已经将套接字和缓冲区绑定在一起,所以可以从soc->data中获取接收到的数据:

if (soc->data.size() != 2) {
    std::cerr << "Wrong bytes count\n";
    assert(false);
}

if (soc->data != "OK") {
    std::cerr << "Wrong response: " << soc->data << '\n';
    assert(false);
}

soc->shutdown()的调用是可选的,因为当soc超出范围时,会调用其析构函数。unique_ptr<connection_with_data>的析构函数调用~connection_with_data,其主体中包含shutdown()

还有更多...

我们的task_wrapped_with_connection::operator()还不够好!用户提供的task_unwrapped_回调可能会抛出异常,并且可能会被不属于特定任务的Boost.Thread中断。修复方法是将回调包装到第一个示例中的类中:

void operator()(
    const boost::system::error_code& error,
    std::size_t bytes_count)
{
    const auto lambda = [this, &error, bytes_count]() {
        this->c_->data.resize(bytes_count);
        this->task_unwrapped_(std::move(this->c_), error);
    };

    const auto task = detail::make_task_wrapped(lambda);
    task();
}

task_wrapped_with_connection::operator()中,我们创建了一个名为lambda的 lambda 函数。在执行时,lambdaconnection_with_data类内的数据调整为bytes_count,并调用最初传递的回调。最后,我们将lambda包装到我们的安全执行任务中,并执行它。

您可能会在互联网上看到很多Boost.Asio的示例。其中许多使用shared_ptr而不是unique_ptr来保留数据。使用shared_ptr的方法更容易实现;但是,它有两个很大的缺点:

  • 效率:shared_ptr内部有一个原子计数器,从不同线程修改它可能会显著降低性能。在接下来的一个示例中,您将看到如何在多个线程中处理任务,这是在高负载情况下可能会有所不同的地方。

  • 明确性:使用unique_ptr,您总是可以看到连接的所有权已转移到某个地方(在代码中看到std::move)。使用shared_ptr,您无法从接口中了解函数是否获取了所有权,还是仅使用了对象的引用。

然而,如果根据应用程序的逻辑,所有权必须在多个任务之间共享,您可能会被迫使用shared_ptr

Boost.Asio不是 C++17 的一部分,但它将很快作为 Networking TS 发布,并包含在即将到来的 C++标准中。

另请参阅

  • 请参阅Boost.Asio的官方文档,了解更多示例、教程、完整参考资料,以及如何使用 UDP 或 ICMP 协议的示例,网址为boost.org/libs/asio

  • 您还可以阅读《Boost.Asio C++网络编程》一书,该书更详细地描述了Boost.Asio

接受传入连接

与网络一起工作的服务器端通常看起来像一个序列,我们首先获取新连接,然后读取数据,然后处理数据,最后发送结果。想象一下,我们正在创建某种必须每秒处理大量请求的授权服务器。在这种情况下,我们需要异步接受、接收、发送,并在多个线程中处理任务。

在这个示例中,我们将看到如何扩展我们的tasks_processor类以接受和处理传入连接,在下一个示例中,我们将看到如何使其多线程化。

准备就绪

这个示例需要对boost::asio::io_service的基础知识有很好的了解,就像本章的第一个示例中描述的那样。对网络通信的一些了解将对您有所帮助。还需要对boost::function的了解,以及至少两个先前示例中的信息。将此示例与boost_systemboost_thread库链接。定义BOOST_ASIO_DISABLE_HANDLER_TYPE_REQUIREMENTS以绕过过于严格的库检查。

如何做...

就像在以前的示例中一样,我们向我们的tasks_processor类添加新的方法。

  1. 我们首先添加一些typedefstasks_processor
class tasks_processor {
    typedef boost::asio::ip::tcp::acceptor acceptor_t;

    typedef boost::function<
        void(connection_ptr, const boost::system::error_code&)
    > on_accpet_func_t;
  1. 让我们添加一个类,将新传入连接的套接字、用于监听的套接字以及用户提供的用于处理新连接的回调绑定在一起:
private:
    struct tcp_listener {
        acceptor_t              acceptor_;
        const on_accpet_func_t  func_;
        connection_ptr          new_c_;

        template <class Functor>
        tcp_listener(
                boost::asio::io_service& io_service,
                unsigned short port,
                const Functor& task_unwrapped)
            : acceptor_(io_service, boost::asio::ip::tcp::endpoint(
                boost::asio::ip::tcp::v4(), port
            ))
            , func_(task_unwrapped)
        {}
    };

    typedef std::unique_ptr<tcp_listener> listener_ptr;
  1. 我们需要添加一个函数,以在指定端口上开始监听:
public:  
   template <class Functor>
    static void add_listener(unsigned short port_num, const Functor& f) {
        std::unique_ptr<tcp_listener> listener(
            new tcp_listener(get_ios(), port_num, f)
        );

        start_accepting_connection(std::move(listener));
    }
  1. 开始接受传入连接的函数:
private:
   static void start_accepting_connection(listener_ptr&& listener) {
        if (!listener->acceptor_.is_open()) {
            return;
        }

        listener->new_c_.reset(new connection_with_data(
            listener->acceptor_.get_io_service()
        ));

        boost::asio::ip::tcp::socket& s = listener->new_c_->socket;
        acceptor_t& a = listener->acceptor_;
        a.async_accept(
            s,
            tasks_processor::handle_accept(std::move(listener))
        );
    }
  1. 我们还需要一个处理新连接的函数对象:
private:
    struct handle_accept {
        listener_ptr listener;

        explicit handle_accept(listener_ptr&& l)
            : listener(std::move(l))
        {}

        void operator()(const boost::system::error_code& error) {
            task_wrapped_with_connection<on_accpet_func_t> task(
                std::move(listener->new_c_), listener->func_
            );

            start_accepting_connection(std::move(listener));
            task(error, 0);
        }
    };

完成!现在,我们可以以以下方式接受连接:

class authorizer {
public:
    static void on_connection_accpet(
        connection_ptr&& connection,
        const boost::system::error_code& error)
    {
        assert(!error);
        // ...
    }
};

int main() {
    tasks_processor::add_listener(80, &authorizer::on_connection_accpet);
    tasks_processor::start();
}

它是如何工作的...

函数add_listener构造了新的tcp_listener,它保留了接受连接所需的所有内容。就像任何异步操作一样,我们需要在操作执行时保持资源活动。tcp_listener的唯一指针可以完成这项工作。

当我们构造boost::asio::ip::tcp::acceptor并指定端点(参见步骤 3)时,它会在指定地址打开一个套接字,并准备好接受连接。

步骤 4中,我们创建了一个新套接字,并为该新套接字调用async_accept。当新连接到来时,listener->acceptor_将此连接绑定到套接字,并将tasks_processor::handle_accept回调推送到boost::asio::io_service中。正如我们从上一个示例中了解到的,所有的async_*调用都会立即返回,async_accept也不是特例。

让我们更仔细地看看我们的handle_accept::operator()。在其中,我们从上一个示例中创建了一个task_wrapped_with_connection函数对象,并将一个新连接移动到其中。现在,我们的listener_ptrnew_c_中没有套接字,因为它是由函数对象拥有的。我们调用函数start_accepting_connection(std::move(listener)),它在listener->new_c_中创建一个新套接字并开始异步接受。异步接受操作不会阻塞,因此程序继续执行,从start_accepting_connection(std::move(listener))函数返回,并执行带有连接task(error, 0)的函数对象。

您已经按照示例中所示的一切做了,但服务器的性能还不够好。这是因为示例是简化的,许多优化被留在了现场。最重要的一个是在connection_with_data中保留一个单独的小缓冲区,并将其用于所有内部Boost.Asio回调相关的分配。有关此优化主题的更多信息,请参阅Boost.Asio库的官方文档中的Custom memory allocation example

当调用boost::asio::io_service的析构函数时,所有回调的析构函数都会被调用。这使得tcp_connection_ptr的析构函数被调用并释放资源。

还有更多...

我们没有使用boost::asio::ip::tcp::acceptor类的所有功能。如果我们提供一个特定的boost::asio::ip::tcp::endpoint,它可以绑定到特定的 IPv6 或 IPv4 地址。您还可以通过native_handle()方法获取本机套接字,并使用一些特定于操作系统的调用来调整行为。您可以通过调用set_optionacceptor_设置一些选项。例如,这是您可以强制acceptor_重用地址的方法:

boost::asio::socket_base::reuse_address option(true); 
acceptor_.set_option(option); 

重用地址可以在服务器在没有正确关闭的情况下快速重新启动。服务器终止后,套接字可能会打开一段时间,如果没有reuse_address选项,您将无法在相同的地址上启动服务器。

C++17 没有来自Boost.Asio的类,但具有大部分功能的 Networking TS 即将推出。

另请参阅

  • 从头开始阅读本章是获取关于Boost.Asio更多信息的好方法

  • 请参阅Boost.Asio的官方文档,了解更多示例、教程和完整参考资料,网址为boost.org/libs/asio

并行执行不同的任务

现在,是时候让我们的tasks_processor在多个线程中处理任务了。这有多难呢?

入门

您需要阅读本章的第一个示例。还需要一些关于多线程的知识,特别是阅读Manipulating a group of threads示例。

将此示例与boost_systemboost_thread库链接。定义BOOST_ASIO_DISABLE_HANDLER_TYPE_REQUIREMENTS以绕过限制性库检查。

如何做...

我们只需要将start_multiple方法添加到我们的tasks_processor类中:

#include <boost/thread/thread.hpp> 

class tasks_processor {
public:
    // Default value will attempt to guess optimal count of threads.
    static void start_multiple(std::size_t threads_count = 0) {
        if (!threads_count) {
            threads_count = (std::max)(static_cast<int>(
                boost::thread::hardware_concurrency()), 1
            );
        }

        // First thread is the current thread.
        -- threads_count;

        boost::asio::io_service& ios = get_ios();
        boost::thread_group tg;
        for (std::size_t i = 0; i < threads_count; ++i) {
            tg.create_thread([&ios]() { ios.run(); });
        }

        ios.run();
        tg.join_all();
    }
};

现在,我们可以做更多的工作,如下图所示:

它是如何工作的...

boost::asio::io_service::run方法是线程安全的。我们只需要从不同的线程运行boost::asio::io_service::run方法。

如果您正在执行修改共享资源的任务,则需要在该资源周围添加互斥锁,或者以一种方式组织您的应用程序,使得共享资源不会同时被不同的任务使用。可以安全地从不同的任务中使用资源而不会并发访问资源,因为boost::asio::io_service负责在任务之间进行额外的同步,并强制使一个任务的修改结果被另一个任务看到。

请参阅对boost::thread::hardware_concurrency()的调用。它返回可以在当前硬件上并发运行的线程数。但是,这只是一个提示,有时可能会返回0值,这就是为什么我们对其调用std::max函数。std::max确保threads_count至少存储值1

我们将std::max包装在括号中,因为一些流行的编译器定义了min()max()宏,所以我们需要额外的技巧来解决这个问题。

还有更多...

boost::thread::hardware_concurrency()函数是 C++11 的一部分;您可以在std::命名空间的<thread>头文件中找到它。

所有boost::asio类都不是 C++17 的一部分,但它们将很快作为网络 TS 提供。

另请参阅

  • 请参阅Boost.Asio文档,了解更多示例和有关不同类的信息,网址为boost.org/libs/asio

  • 来自第五章 多线程的配方(特别是最后一个名为操作一组线程的配方)将为您提供有关Boost.Thread用法的信息

  • 请参阅Boost.Thread文档,了解boost::thread_groupboost::threads的信息,网址为boost.org/libs/thread

管道任务处理

有时,有一个要求在指定的时间间隔内处理任务。与以前的配方相比,在那里我们试图按照它们在队列中出现的顺序处理任务,这是一个很大的不同。

考虑一个例子,我们正在编写一个连接两个子系统的程序,其中一个子系统产生数据包,另一个子系统将修改后的数据写入磁盘(类似于视频摄像机、声音记录仪和其他设备中可以看到的情况)。我们需要按指定顺序逐个处理数据包,平稳地处理,有小的抖动,并且在多个线程中进行。

天真的方法在这里不起作用:

#include <boost/thread/thread.hpp>

subsystem1 subs1;
subsystem2 subs2;

void process_data() {
    while (!subs1.is_stopped()) {
        data_packet data = subs1.get_data();
        decoded_data d_decoded = decode_data(data);
        compressed_data c_data = compress_data(d_decoded);
        subs2.send_data(c_data);
    }
}

void run_in_multiple_threads() {
    boost::thread t(&process_data);
    process_data();

    t.join();
}

在多线程环境中,我们可以在第一个线程中获取数据包#1,然后在第二个执行线程中获取数据包#2。由于不同的处理时间、操作系统上下文切换和调度,数据包#2可能会在数据包#1之前被处理。对于数据包,没有处理顺序的保证。让我们来解决这个问题!

准备工作

从第五章 多线程制作工作队列配方中,需要理解这个例子。代码必须链接到boost_threadboost_system库。

需要基本的 C++11 知识,特别是关于 lambda 函数。

如何做...

这个配方是基于第五章 多线程制作工作队列配方中的work_queue类的代码。我们将进行一些修改,并将使用该类的几个实例。

  1. 让我们首先为数据解码、数据压缩和数据发送创建单独的队列:
work_queue decoding_queue, compressing_queue, sending_queue;
  1. 现在,是时候重构process_data并将其拆分为多个函数了:
void start_data_accepting();
void do_decode(const data_packet& packet);
void do_compress(const decoded_data& packet);

void start_data_accepting() {
    while (!subs1.is_stopped()) {
        data_packet packet = subs1.get_data();

        decoding_queue.push_task(
            [packet]() {
                do_decode(packet);
            }
        );
    }
}

void do_decode(const data_packet& packet) {
    decoded_data d_decoded = decode_data(packet);

    compressing_queue.push_task(
        [d_decoded]() {
            do_compress(d_decoded);
        }
    );
}

void do_compress(const decoded_data& packet) {
    compressed_data c_data = compress_data(packet);

    sending_queue.push_task(
        [c_data]() {
            subs2.send_data(c_data);
        }
    );
}
  1. 我们的work_queue类从第五章 多线程中得到了一些接口更改,用于停止和运行任务:
#include <deque>
#include <boost/function.hpp>
#include <boost/thread/mutex.hpp>
#include <boost/thread/locks.hpp>
#include <boost/thread/condition_variable.hpp>

class work_queue {
public:
    typedef boost::function<void()> task_type;

private:
    std::deque<task_type>       tasks_;
    boost::mutex                mutex_;
    boost::condition_variable   cond_;
    bool                        is_stopped_;

public:
    work_queue()
        : is_stopped_(false)
    {}

    void run();
    void stop();

    // Same as in Chapter 5, but with
    // rvalue references support.
    void push_task(task_type&& task);
};
  1. work_queuestop()run()函数的实现必须如下所示:
void work_queue::stop() {
    boost::lock_guard<boost::mutex> lock(mutex_);
    is_stopped_ = true;
    cond_.notify_all();
}

void work_queue::run() {
    while (1) {
        boost::unique_lock<boost::mutex> lock(mutex_);
        while (tasks_.empty()) {
            if (is_stopped_) {
                return;
            }
            cond_.wait(lock);
        }

        task_type t = std::move(tasks_.front());
        tasks_.pop_front();
        lock.unlock();

        t();
    }
}
  1. 就是这样!现在,我们只需要启动管道:
#include <boost/thread/thread.hpp> 
int main() {
    boost::thread t_data_decoding(
        []() { decoding_queue.run(); }
    );
    boost::thread t_data_compressing(
        []() { compressing_queue.run(); }
    );
    boost::thread t_data_sending(
        []() { sending_queue.run(); }
    );

    start_data_accepting();
  1. 可以这样停止管道:
    decoding_queue.stop();
    t_data_decoding.join();

    compressing_queue.stop();
    t_data_compressing.join();

    sending_queue.stop();
    t_data_sending.join();

工作原理...

诀窍在于将单个数据包的处理分成一些同样小的子任务,并在不同的work_queues中逐个处理它们。在这个例子中,我们可以将数据处理分成数据解码、数据压缩和数据发送。

理想情况下,六个数据包的处理将如下所示:

时间接收解码压缩发送
Tick 1:数据包 #1
Tick 2:数据包 #2数据包 #1
Tick 3:数据包 #3数据包 #2数据包 #1
Tick 4:数据包 #4数据包 #3数据包 #2数据包 #1
Tick 5:数据包 #5数据包 #4数据包 #3数据包 #2
Tick 6:数据包 #6数据包 #5数据包 #4数据包 #3
Tick 7:-数据包 #6数据包 #5数据包 #4
Tick 8:--数据包 #6数据包 #5
Tick 9:---数据包 #6

然而,我们的世界并不理想,因此有些任务可能比其他任务更快完成。例如,接收可能比解码更快,在这种情况下,解码队列将保存一组要完成的任务。为了避免队列溢出,请努力使每个后续任务略微快于前一个任务。

在我们的例子中,我们没有使用boost::asio::io_service,因为它不能保证发布的任务按照它们的发布顺序执行。

还有更多...

在这个例子中用来创建管线的所有工具都可以在 C++11 中使用,因此没有什么能阻止您在兼容 C++11 的编译器上创建相同的东西而不使用 Boost。然而,Boost 使您的代码更具可移植性,并且可以在 C++11 之前的编译器上使用。

另请参阅

  • 这种技术是处理器开发人员熟知并使用的。请参阅en.wikipedia.org/wiki/Instruction_pipeline。在这里,您可以找到管线的所有特征的简要描述。

  • 来自第五章的制作工作队列多线程配方将为您提供有关本配方中使用的方法的更多信息。

制作非阻塞屏障

在多线程编程中,有一种称为屏障的抽象。它会阻止执行线程到达它,直到请求的线程数没有被阻塞在它上面。之后,所有线程都被释放,它们继续执行。考虑下面的例子,它可以使用在哪里。

我们希望在不同的线程中处理数据的不同部分,然后发送数据:

#include <boost/array.hpp>
#include <boost/thread/barrier.hpp>
#include <boost/thread/thread.hpp>

typedef boost::array<std::size_t, 10000> vector_type;
typedef boost::array<vector_type, 4> data_t;

void fill_data(vector_type& data);
void compute_send_data(data_t& data);

void runner(std::size_t thread_index, boost::barrier& barrier, data_t& data) {
    for (std::size_t i = 0; i < 1000; ++ i) {
        fill_data(data.at(thread_index));
        barrier.wait();

        if (!thread_index) {
            compute_send_data(data);
        }
        barrier.wait();
    }
}

int main() {
    // Initing barrier.
    boost::barrier barrier(data_t::static_size);

    // Initing data.
    data_t data;

    // Run on 4 threads.
    boost::thread_group tg;
    for (std::size_t i = 0; i < data_t::static_size; ++i) {
        tg.create_thread([i, &barrier, &data] () {
            runner(i, barrier, data);
        });
    }

    tg.join_all();
}

data_barrier.wait()方法会阻塞,直到所有线程填充数据。之后,所有线程都被释放。索引为0的线程使用compute_send_data(data)计算要发送的数据,而其他线程再次在屏障处等待,如下图所示:

看起来很糟糕,不是吗?

做好准备

这个配方需要对本章的第一个配方有所了解。还需要了解Boost.Thread。这个配方的代码需要链接boost_threadboost_system库。

如何做...

我们根本不需要阻塞!让我们仔细看看这个例子。我们所需要做的就是发布四个fill_data任务,并让最后完成的任务调用compute_send_data(data)

  1. 我们将需要第一篇配方中的tasks_processor类;不需要对其进行任何更改。

  2. 我们将使用原子变量而不是屏障:

#include <boost/atomic.hpp> 
typedef boost::atomic<unsigned int> atomic_count_t; 
  1. 我们的新运行函数将如下所示:
void clever_runner(
        std::size_t thread_index,
        std::size_t iteration,
        atomic_count_t& counter,
        data_t& data)
{
    fill_data(data.at(thread_index));

    if (++counter != data_t::static_size) {
        return;
    }

    compute_send_data(data);

    if (++iteration == 1000) {
        // Exiting, because 1000 iterations are done.
        tasks_processor::stop();
        return;
    }

    counter = 0;
    for (std::size_t i = 0; i < data_t::static_size; ++ i) {
        tasks_processor::push_task([i, iteration, &counter, &data]() {
            clever_runner( 
                i, 
                iteration,
                counter,
                data
            );
        });
    }
}
  1. main函数需要进行微小的更改:
    // Initing counter.
    atomic_count_t counter(0);

    // Initing data.
    data_t data;

    // Run 4 tasks.
    for (std::size_t i = 0; i < data_t::static_size; ++i) {
        tasks_processor::push_task([i, &counter, &data]() {
            clever_runner( 
                i, 
                0, // first iteration
                counter,
                data
            );
        });
    }

    tasks_processor::start();

它是如何工作的...

我们根本不会阻塞。我们不是阻塞,而是计算完成填充数据的任务。这是通过counter原子变量完成的。最后剩下的任务将具有等于data_t::static_sizecounter变量。只有该任务必须计算并发送数据。

之后,我们检查退出条件(完成 1000 次迭代),并通过将任务推送到队列来发布新数据。

还有更多...

这是更好的解决方案吗?首先,它的扩展性更好:

这种方法也可以更有效地处理程序执行大量不同工作的情况。因为没有线程在等待屏障,自由线程可以在一个线程计算和发送数据时执行其他任务。

这个配方可以在没有 Boost 库的情况下在 C++11 中实现。您只需要在tasks_processor中用第五章的work_queue替换io_service。但是像往常一样,Boost 提供了更好的可移植性,并且可以使这个示例在 C++11 之前的编译器上运行,使用 Boost 库只需要用boost::bindboost::ref替换 lambda 函数。

另请参阅

  • Boost.Asio的官方文档可能会给您更多关于io_service使用的信息,网址为boost.org/libs/asio

  • 查看第二章中与Boost.Function相关的所有配方,资源管理,以及官方文档boost.org/libs/function以了解任务的概述。

  • 查看第一章的相关内容,了解有关boost::bind的更多信息,或者查看官方文档boost.org/libs/bind

存储异常并从中创建任务

处理异常并不总是简单的,可能会消耗大量时间。考虑异常必须被序列化并通过网络发送的情况。这可能需要几毫秒和几千行代码。在捕获异常后,处理它的时间和地点并不总是最佳的。

我们能存储异常并延迟它们的处理吗?

准备工作

这个配方需要熟悉boost::asio::io_service,这在本章的第一个配方中有描述。

此配方需要链接boost_systemboost_thread库。

如何做...

我们所需要的就是能够存储异常并在线程之间传递它们,就像普通变量一样。

  1. 让我们从存储和处理异常的函数开始:
#include <boost/exception_ptr.hpp>

struct process_exception {
    boost::exception_ptr exc_;

    explicit process_exception(const boost::exception_ptr& exc)
        : exc_(exc)
    {}

    void operator()() const;
};
  1. 该函数对象的operator()只是将异常输出到控制台:
#include <boost/lexical_cast.hpp>
void func_test2(); // Forward declaration.

void process_exception::operator()() const  {
    try {
        boost::rethrow_exception(exc_);
    } catch (const boost::bad_lexical_cast& /*e*/) {
        std::cout << "Lexical cast exception detected\n" << std::endl;

        // Pushing another task to execute.
        tasks_processor::push_task(&func_test2);
    } catch (...) {
        std::cout << "Can not handle such exceptions:\n" 
            << boost::current_exception_diagnostic_information() 
            << std::endl;

        // Stopping.
        tasks_processor::stop();
    }
}
  1. 让我们编写一些函数来演示异常的工作方式:
#include <stdexcept>
void func_test1() {
    try {
        boost::lexical_cast<int>("oops!");
    } catch (...) {
        tasks_processor::push_task(
            process_exception(boost::current_exception())
        );
    }
}

void func_test2() {
    try {
        // ...
        BOOST_THROW_EXCEPTION(std::logic_error("Some fatal logic error"));
        // ...
    } catch (...) {
        tasks_processor::push_task(
            process_exception(boost::current_exception())
        );
    }
}

现在,如果我们像这样运行示例:

  tasks_processor::get().push_task(&func_test1); 
  tasks_processor::get().start(); 

我们将得到以下输出:

Lexical cast exception detected

Can not handle such exceptions:
main.cpp(48): Throw in function void func_test2()
Dynamic exception type: boost::exception_detail::clone_impl<boost::exception_detail::error_info_injector<std::logic_error> >
std::exception::what: Some fatal logic error  

它是如何工作的...

Boost.Exception库提供了存储和重新抛出异常的功能。boost::current_exception()方法只能在catch()块内部调用,并返回一个boost::exception_ptr类型的对象。

func_test1()的前面的示例中,抛出了boost::bad_lexical_cast异常。它由boost::current_exception()返回;从该异常创建了一个process_exception任务。

boost::exception_ptr中恢复异常类型的唯一方法是使用boost::rethrow_exception(exc)函数重新抛出它。这就是process_exception函数的作用。

抛出和捕获异常是一个繁重的操作。抛出可能会动态分配内存,触及冷内存,锁定互斥锁,计算一堆地址,以及做其他事情。在性能关键路径中不要没有非常好的理由就抛出异常!

func_test2中,我们使用BOOST_THROW_EXCEPTION宏抛出了一个std::logic_error异常。这个宏做了很多有用的工作;它检查我们的异常是否派生自std::exception,为我们的异常添加关于源文件名、函数名和抛出异常的代码行号的信息。当我们的std::logic_error异常在process_exception::operator()内部重新抛出时,它被catch(...)捕获。boost::current_exception_diagnostic_information()尽可能多地输出关于抛出异常的信息。

还有更多...

通常,exception_ptr用于在线程之间传递异常。例如:

void run_throw(boost::exception_ptr& ptr) {
    try {
        // A lot of code goes here.
    } catch (...) {
        ptr = boost::current_exception();
    }
}

int main () {
    boost::exception_ptr ptr;

    // Do some work in parallel.
    boost::thread t(
        &run_throw,
        boost::ref(ptr)
    );

    // Some code goes here.
    // ...

    t.join();

    // Checking for exception.
    if (ptr) {
        // Exception occurred in thread.
        boost::rethrow_exception(ptr);
    }
}

boost::exception_ptr类可能会通过堆多次分配内存,使用原子操作,并通过重新抛出和捕获异常来实现一些操作。除非真正需要,尽量不要使用它。

C++11 已经采用了boost::current_exceptionboost::rethrow_exceptionboost::exception_ptr。您可以在std::命名空间的<exception>中找到它们。BOOST_THROW_EXCEPTIONboost::current_exception_diagnostic_information()函数不在 C++17 中。

另请参阅

  • Boost.Exception的官方文档在boost.org/libs/exception中包含了关于实现和限制的大量有用信息。您还可以找到一些本配方中未涵盖的信息(例如,如何向已抛出的异常添加附加信息)。

  • 本章的第一个配方为您提供了关于tasks_processor类的信息。第三章的将字符串转换为数字配方描述了Boost.LexicalCast库,该库在本配方中使用。

获取和处理系统信号作为任务

在编写一些服务器应用程序(特别是针对 Linux 操作系统)时,捕获和处理信号是必需的。通常,在服务器启动时设置所有信号处理程序,并且在应用程序执行期间不会更改。

这个配方的目标是使我们的tasks_processor类能够处理信号。

准备工作

我们将需要本章的第一个配方中的代码。还需要对Boost.Function有扎实的了解。

这个配方需要链接boost_systemboost_thread库。

如何做...

这个配方类似于本章的第24个配方:我们有async信号等待函数,一些async信号处理程序和一些支持代码。

  1. 让我们从以下头文件开始包括:
#include <boost/asio/signal_set.hpp> 
#include <boost/function.hpp> 
  1. 现在,我们为tasks_processor类添加一个信号处理成员:
protected:
    static boost::asio::signal_set& signals() {
        static boost::asio::signal_set signals_(get_ios());
        return signals_;
    }

    static boost::function<void(int)>& signal_handler() {
        static boost::function<void(int)> users_signal_handler_;
        return users_signal_handler_;
    }
  1. 在信号捕获时将被调用的函数如下:
    static void handle_signals(
            const boost::system::error_code& error,
            int signal_number)
    {
        signals().async_wait(&tasks_processor::handle_signals);

        if (error) {
            std::cerr << "Error in signal handling: " << error << '\n';
        } else {
            boost::function<void(int)> h = signal_handler();
            h(signal_number);
        }

    }
  1. 现在我们需要一个函数来注册信号处理程序:
public:

    // This function is not thread safe!
    // Must be called before all the `start()` calls.
    // Function can be called only once.
    template <class Func>
    static void register_signals_handler(
            const Func& f,
            std::initializer_list<int> signals_to_wait)
    {
        // Making sure that this is the first call.
        assert(!signal_handler()); 

        signal_handler() = f;
        boost::asio::signal_set& sigs = signals();

        std::for_each(
            signals_to_wait.begin(),
            signals_to_wait.end(),
            &sigs { sigs.add(signal); }
        );

        sigs.async_wait(&tasks_processor::handle_signals);
    }

就这些了。现在,我们准备处理信号。以下是一个测试程序:

void accept_3_signals_and_stop(int signal) {
    static int signals_count = 0;
    assert(signal == SIGINT);

    ++ signals_count;
    std::cout << "Captured " << signals_count << " SIGINT\n"; 
    if (signals_count == 3) {
        tasks_processor::stop();
    }
}

int main () {
    tasks_processor::register_signals_handler(
        &accept_3_signals_and_stop,
        { SIGINT, SIGSEGV }
    );

    tasks_processor::start();
}

这将产生以下输出:

Captured 1 SIGINT
Captured 2 SIGINT
Captured 3 SIGINT
Press any key to continue . . .

它是如何工作的...

这里没有什么困难(与本章之前的一些配方相比)。register_signals_handler函数添加将被处理的信号编号。通过对signals_to_wait的每个元素调用boost::asio::signal_set::add函数来完成。

接下来,sigs.async_wait开始async等待信号,并在信号捕获时调用tasks_processor::handle_signals函数。tasks_processor::handle_signals函数立即开始异步等待下一个信号,检查错误,如果没有错误,则调用回调函数提供信号编号。

还有更多...

我们可以做得更好!我们可以将用户提供的回调包装到第一个配方中的类中,以正确处理异常并执行第一个配方中的其他好东西:

boost::function<void(int)> h = signal_handler();

detail::make_task_wrapped([h, signal_number]() {
    h(signal_number);
})(); // make and run task_wrapped

当需要线程安全的动态添加和删除信号时,我们可以修改此示例,使其类似于本章的制作定时器和处理定时器事件作为任务食谱中的detail::timer_task。当多个boost::asio::signal_set对象注册等待相同的信号时,每个signal_set的处理程序都会在单个信号上被调用。

C++长期以来一直能够使用<csignal>头文件中的signal函数处理信号。网络 TS 可能不会具有signal_set功能。

另请参阅

  • 来自第二章管理资源将任何功能对象存储在变量中食谱提供了有关boost::function的信息

  • 有关boost::asio::signal_set和此优秀库的其他功能的更多信息和示例,请参阅Boost.Asio的官方文档boost.org/libs/asio