// Copyright (C) 2020-2026 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
#ifndef MULTI_THREADING_UTILS_H
#define MULTI_THREADING_UTILS_H
#include <util/multi_threading_mgr.h>
namespace isc {
namespace test {
/// @brief Check if mutex is locked.
///
/// @note This function uses a new thread to test if the mutex is locked
/// because calling try_lock by the same thread which already acquired the
/// lock is undefined behavior.
///
/// @param mutex The mutex to check.
/// @return Return true if mutex is not locked, false if mutex is locked.
bool inline checkTryLock(std::mutex& mutex) {
bool locked = true;
auto f = [&]() {
if (mutex.try_lock()) {
mutex.unlock();
locked = false;
}
};
std::thread th(f);
th.join();
return (!locked);
}
/// @brief A RAII class which disables the multi threading on exit of scope.
///
/// Usually the multi threading is disabled by the fixture destructor or
/// TearDown but of course this works only when a fixture class is used.
class MultiThreadingTest {
public:
/// @brief Constructor (set multi threading mode).
///
/// @param mode The mode to use in the body. Defaults to true / enabled.
MultiThreadingTest(bool mode = true) {<--- Class 'MultiThreadingTest' has a constructor with 1 argument that is not explicit. [+]Class 'MultiThreadingTest' has a constructor with 1 argument that is not explicit. Such, so called "Converting constructors", should in general be explicit for type safety reasons as that prevents unintended implicit conversions.
isc::util::MultiThreadingMgr::instance().setMode(mode);
}
/// @brief Destructor (disable multi threading).
~MultiThreadingTest() {
isc::util::MultiThreadingMgr::instance().setMode(false);
}
};
} // end of isc::test namespace
} // end of isc namespace
#endif // MULTI_THREADING_UTILS_H