mirror of
https://github.com/facebook/rocksdb.git
synced 2024-11-29 18:33:58 +00:00
303cb23a0f
Summary: The patch adds a resource management/RAII class called `ThreadGuard`, which can be used to ensure that the managed thread is joined when the `ThreadGuard` is destroyed, regardless of whether it is due to the object going out of scope, an early return, an exception etc. This is important because if an `std::thread` object is destroyed without having been joined (or detached) first, the process is aborted (via `std::terminate`). For now, `ThreadGuard` is only used in the test case `ExternalSSTFileTest.PickedLevelBug`; however, it could come in handy elsewhere in the codebase as well (both in test code and "real" code). Case in point: in the `PickedLevelBug` test case, with the earlier code we could end up in the above situation when the following assertion (which is before the threads are joined) is triggered: ``` ASSERT_FALSE(bg_compact_started.load()); ``` Pull Request resolved: https://github.com/facebook/rocksdb/pull/8112 Test Plan: ``` make check gtest-parallel --repeat=10000 ./external_sst_file_test --gtest_filter="*PickedLevelBug" ``` Reviewed By: riversand963 Differential Revision: D27343185 Pulled By: ltamasi fbshipit-source-id: 2a8c3aa68bc78cc03ec0dbae909fb25c2cd15c69
42 lines
1.2 KiB
C++
42 lines
1.2 KiB
C++
// Copyright (c) 2011-present, Facebook, Inc. All rights reserved.
|
|
// This source code is licensed under both the GPLv2 (found in the
|
|
// COPYING file in the root directory) and Apache 2.0 License
|
|
// (found in the LICENSE.Apache file in the root directory).
|
|
|
|
#pragma once
|
|
|
|
#include "port/port.h"
|
|
#include "rocksdb/rocksdb_namespace.h"
|
|
|
|
namespace ROCKSDB_NAMESPACE {
|
|
|
|
// Resource management object for threads that joins the thread upon
|
|
// destruction. Has unique ownership of the thread object, so copying it is not
|
|
// allowed, while moving it transfers ownership.
|
|
class ThreadGuard {
|
|
public:
|
|
ThreadGuard() = default;
|
|
|
|
explicit ThreadGuard(port::Thread&& thread) : thread_(std::move(thread)) {}
|
|
|
|
ThreadGuard(const ThreadGuard&) = delete;
|
|
ThreadGuard& operator=(const ThreadGuard&) = delete;
|
|
|
|
ThreadGuard(ThreadGuard&&) noexcept = default;
|
|
ThreadGuard& operator=(ThreadGuard&&) noexcept = default;
|
|
|
|
~ThreadGuard() {
|
|
if (thread_.joinable()) {
|
|
thread_.join();
|
|
}
|
|
}
|
|
|
|
const port::Thread& GetThread() const { return thread_; }
|
|
port::Thread& GetThread() { return thread_; }
|
|
|
|
private:
|
|
port::Thread thread_;
|
|
};
|
|
|
|
} // namespace ROCKSDB_NAMESPACE
|