Effective Modern C++ 条款37 在所有路径上,让std::thread对象变得不可连接(unjoinable)
让std::thread对象在所有路径都无法连接
每个std::thread对象的状态都是这两种中的一种:joinable(可连接的)或unjoinable(不可连接的)。一个可连接的std::thread对应一个底层异步执行线程,例如,一个std::thread对应的一个底层线程,它会被阻塞或等待被调度,那么这个std::thread就是可连接的。std::thread对象对应的底层线程可以将代码运行至结束,也可将其视为可连接的。
不可连接的std::thread的意思就如你想象那样:std::thread不是可连接的。不可连接的std::thread对象包括:
默认构造的std::thread。这种std::thread没有函数可以执行,因此没有对应的底层执行线程。 被移动过的std::thread。移动的结果是,一个std::thread对应的底层执行线程被对应到另一个std::thread。 被连接过(调用了join)的std::thread。在调用了join之后,std::thread对应的底层执行线程结束运行,就没有对应的底层线程了。 被分离(detach)的std::thread。detach把std::thread对象与它对应的底层执行线程分离开。std::thread的连接性是很重要的,其中一个原因是:如果一个可连接的线程对象执行了析构操作,那么程序会被终止。例如,假设我们有一个函数dowork,它的参数包含过滤器函数
filter、一个最大值
maxval。
dowork把0到
maxval之间值传给过滤器,然后满足特定条件就对满足过滤器的值进行计算。如果执行过滤器函数是费时的,而检查条件也是费时的,那么并发做这两件事是合理的。
我们其实会更偏向于使用基于任务的设计(看条款35),但是让我们假定我们想要设置执行过滤器线程的优先级。条款35解释过请求使用线程的本机句柄(native handle)时,只能通过std::thread的api;基于任务的api没有提供这个功能。因此我们的方法是基于线程,而不是基于任务。
我们可以提出这样的代码:
constexpr auto tenmillion = 10000000; // 关于constexpr,看条款15 bool dowork(std::function filter, // 返回是否会进行计算 int maxval = tenmillion) // 关于std::function,看条款2 { std::vector goodvals; // 满足过滤器的值 std::thread t([&filter, maxval, &goodvals]) { for (auto i = 0; i <= maxval; ++i) { if (filter(i) goodvals.push_back(i); } }); auto nh = t.native_handle(); // 获取t的本机句柄 ... // 使用t的本机句柄设置t的优先级 if (conditionsaresatisfied()) { t.join(); // 等待t结束 performcomputation(goodvals); return true; // 会进行计算 } return false; // 不会进行计算 }
在我解释这个代码为什么有问题之前,我想提一下
tenmillion的初始值在c++14可以变得更有可读性,利用c++14的能力,把单引号作为数字的分隔符:
constexpr auto tenmillion = 10'000'000; // c++14
我还想提一下在线程
t开始执行之后才去设置它的优先级,这有点像众所周知的马脱缰跑了后你才关上门。一个更好设计是以暂停状态启动线程
t(因此可以在执行之前修改它的优先级),但我不想那部分的代码使你分心。如果你已经严重分心了,那么请去看条款39,因为那里展示了如何启动暂停的线程。
回到
dowork,如果
conditionsaresatisfied()返回true,那么没问题,但如果返回false或者抛出异常,那么在
dowork的末尾,调用std::thread的析构函数时,它状态是可连接的,那会导致执行中的程序被终止。
你可能想知道std::thread的析构函数为什么会表现出这种行为,那是因为另外两种明显的选项会更糟。它们是:
隐式连接(join)。在这种情况下,std::thread的析构函数会等待底层异步执行线程完成工作。这听起来合情合理,但是这会导致难以追踪的性能异常。例如,如果conditionaresatisfied()已经返回false了,dowork函数还要等待过滤器函数的那个循环,这是违反直觉的。 隐式分离(detach)。在这种情况下,std::thread的析构函数会分离std::thread对象与底层执行线程之间的连接,而那个底层执行线程会继续执行。这听起来和join那个方法一样合理,但它导致更难调试的问题。例如,在dowork中,goodvals是个通过引用捕获的局部变量,它可以在lambda内被修改(通过push_back),然后,假如当lambda异步执行时,conditionsaresatisfied()返回false。那种情况下,dowork会直接返回,它的局部变量(包括goodvals)会被销毁,dowork的栈帧会被弹出,但是线程仍然执行。
在接着
dowork调用端之后的代码中,某个时刻,会调用其它函数,而至少一个函数可能会使用一部分或者全部
dowork栈帧占据过的内存,我们先把这个函数称为
f。当
f运行时,
dowork发起的lambda依然会异步执行。lambda在栈上对
goodvals调用push_back,不过如今是在
f的栈帧中。这样的调用会修改过去属于
goodvals的内存,而那意味着从
f的角度看,栈帧上的内存内容会自己改变!想想看你调试这个问题时会有多滑稽。
标准委员会任务销毁一个可连接的线程实在太恐怖了,所以从根源上禁止它(通过指定可连接的线程的析构函数会终止程序)。
这就把责任交给了你,如果你使用了一个std::thread对象,你要确保在它定义的作用域外的任何路径,使它变为不可连接。但是覆盖任何路径是很复杂的,它包括关闭流出范围然后借助return、continue、break、goto或异常来跳出,这有很多条路径。
任何时候你想要在每一条路径都执行一些动作,那么最常用的方法是在局部对象的析构函数中执行动作。这些对象被称为了raii对象,而产生它们的类被称为raii类(raii(resource acquisition is initialization)表示“资源获取就是初始化”,即使技术的关键是销毁,而不是初始化)。raii类在标准库很常见,例子包括stl容器(每个容器的析构函数都会销毁容器的内容并释放内存)、标准智能指针(条款18-20解释了std::unique_ptr析构函数会对它指向的对象调用删除器,而std::shared_ptr和std::weak_ptr的析构函数会减少引用计数)、std::fstream对象(它们的析构函数会关闭对应的文件),而且还有很多。然而,没有关于std::thread的标准raii类,可能是因为标准委员会拒绝把join或detach作为默认选项,这仅仅是不知道如何实现这样类。
幸运的是,你自己写一个不会很难。例如,下面这个类,允许调用者指定
threadraii对象(一个std::thread的raii对象)销毁时调用join或者detach:
class threadraii { public: enum class dtoraction { join, detach }; // 关于enum class,请看条款10 threadraii(std::thread&& t, dtoraction a) // 在析构函数,对t采取动作a : action(a), t(std::move(t)) {} ~threadraii() { if (t.joinable()) { // 关于连接性测试,看下面 if (action == dtoraction::join) { t.join(); } else { t.detach(); } } std::thread& get() { return t; } private: dtoraction action; std::thread t; };
我希望这份代码是一目了然的,但下面的几点可能对你有帮助:
构造函数只接受右值的std::thread,因为我们想要把传进来的std::thread对象移动到threadraii对象里。(std::thread是不能被拷贝的类型。) 对于调用者,构造函数的形参顺序的设计十分直观(指定std::thread作为第一个参数,而销毁动作作为第二个参数,比起反过来直观很多),但是,成员初始化列表被设计来匹配成员变量声明的顺序,成员变量的顺序是把std::thread放到最后。在这个类中,这顺序不会导致什么不同,不过一般来说,一个成员变量的初始化有可能依赖另一个成员变量,而因为std::thread对象初始化之后可能会马上运行函数,所以把它们声明在一个类的最后是一个很好的习惯。那保证了当std::thread构造的时候,所有在它之前的成员变量都已经被初始化,因此std::thread成员变量对应的底层异步执行线程可以安全地取得它们。 threadraii提供了一个get函数,它是一个取得内部std::thread对象的入口,这类似于标准智能指针提供了get函数(它提供了取得内部原生指针的入口)。提供get可以避免threadraii复制std::thread的所有接口,而这也意味着threadraii可以用于请求std::thread对象的上下文。 threadraii的析构函数在调用std::thread对象t的成员函数之前,它先检查确保t是可连接的。这是必需的,因为对一个不可连接的线程调用join或detach会产生未定义行为。某个用户构建了一个std::thread,然后用它创建threadraii对象,再使用get请求获得t,接着移动t或者对t调用join或detach,这是有可能发生的,而这样的行为会导致t变得不可连接。
如果你担心这代码,
if (t.joinable()) {
if (action == dtoraction::join) {
t.join();
} else {
t.detach();
}
}
存在竞争,因为在
t.joinable()和调用join或detach之间,另一个线程可能让
t变得不可连接。你的直觉是值得赞扬的,但是你的害怕是没有根据的。一个std::thread对象只能通过调用成员函数来从可连接状态转换为不可连接状态,例如,join、detach或移动操作。当
threadraii对象的析构函数被调用时,不应该有其他线程调用该对象的成员函数。如果这两个函数同时发生,那的确是竞争,但竞争没有发生在析构函数内,它是发生在试图同时调用两个成员函数(析构函数和其他)的用户代码内。一般来说,对于一个对象同时调用两个成员函数,也只有是const成员函数(看条款16)才能确保线程安全。
在我们
dowork的例子中使用
threadraii,代码是这样的:
bool dowork(std::function goodvals; // 如前 threadraii t( std::thread([&filter, maxval, &goodvals) // 使用raii对象 { for (auto i = 0; i <= maxval; ++i) { if (filter) goodvals.push_back(i); } }), threadraii::dtoraction::join // raii动作 ); auto nh = t.get().native_handle(); ... if (conditionsarestatisfied()) { t.get().join(); performconputation(goodvals); return true; } return false; }
在这个例子中,我们选择在
threadraii析构函数中,对异步执行线程调用join函数,因为我们之前看到,调用detach函数会导致一些恶梦般的调试。我们之前也看到过join会导致性能异常(实话说,那调试起来也很不爽),但在未定义行为(detach给的)、程序终止(使用原始std::thread会产生)、性能异常之前做出选择,性能异常就像是瘸子里面挑出的将军 。
额,条款39展示了使用
threadraii在std::thread销毁中进行join不会导致性能异常,而是导致挂起程序。这种问题的“合适的”解决方案是:和异步执行的lambda进行交流,当我们不需要它时候,它可以早早的返回;但c++11不支持这种可中断的线程。我们可以手动实现它们,但那个话题已经超越了这本书的范围了(在《c++并发实战》的章节9.2可以找到)。
条款17解释过,因为
threadraii声明了析构函数,所以不会有编译器生成的移动操作,但这里
threadraii对象没有理由不能移动。如果编译器生成的这些函数,这些函数的可以行为是正确的,所以显示请求创建它们是适合的:
class threadraii { public: enum class dtoraction { join, detach }; // 如前 threadraii(std::thread&& t, dtoraction a) // 如前 : action(a), t(std::move(t)) {} ~threadraii() { ... // 如前 } threadraii(threadraii&&) = default; // 支持移动 threadraa& operator=(threadraii&) = default; std::thread& get() { return t; } private: dtoraction action; std::thread t; };
总结
总结
需要记住的4点:
- 在所有路径上,让std::thread变得不可连接。
- 在销毁时用join会导致难以调试的性能异常。
- 在销毁时用detach会导致难以调试的未定义行为。
- 在成员变量列表最后声明std::thread。